1 ;;; tar-mode.el --- simple editing of tar files from GNU emacs
3 ;;; Copyright (C) 1990, 1991, 1993, 1994 Free Software Foundation, Inc.
5 ;; Author: Jamie Zawinski <jwz@lucid.com>
6 ;; Created: 04 Apr 1990
7 ;; Version: 1.21bis (some cleanup by ESR)
10 ;;; This file is part of GNU Emacs.
12 ;;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;;; it under the terms of the GNU General Public License as published by
14 ;;; the Free Software Foundation; either version 2, or (at your option)
15 ;;; any later version.
17 ;;; GNU Emacs is distributed in the hope that it will be useful,
18 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;;; GNU General Public License for more details.
22 ;;; You should have received a copy of the GNU General Public License
23 ;;; along with GNU Emacs; see the file COPYING. If not, write to
24 ;;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
28 ;;; This package attempts to make dealing with Unix 'tar' archives easier.
29 ;;; When this code is loaded, visiting a file whose name ends in '.tar' will
30 ;;; cause the contents of that archive file to be displayed in a Dired-like
31 ;;; listing. It is then possible to use the customary Dired keybindings to
32 ;;; extract sub-files from that archive, either by reading them into their own
33 ;;; editor buffers, or by copying them directly to arbitrary files on disk.
34 ;;; It is also possible to delete sub-files from within the tar file and write
35 ;;; the modified archive back to disk, or to edit sub-files within the archive
36 ;;; and re-insert the modified files into the archive. See the documentation
37 ;;; string of tar-mode for more info.
39 ;;; This code now understands the extra fields that GNU tar adds to tar files.
41 ;;; This interacts correctly with "uncompress.el" in the Emacs library,
42 ;;; which you get with
44 ;;; (autoload 'uncompress-while-visiting "uncompress")
45 ;;; (setq auto-mode-alist (cons '("\\.Z$" . uncompress-while-visiting)
48 ;;; Do not attempt to use tar-mode.el with crypt.el, you will lose.
50 ;;; *************** TO DO ***************
52 ;;; o chmod should understand "a+x,og-w".
54 ;;; o It's not possible to add a NEW file to a tar archive; not that
55 ;;; important, but still...
57 ;;; o In the directory listing, we don't show creation times because I don't
58 ;;; know how to print an arbitrary date, and I don't really want to have to
59 ;;; implement decode-universal-time.
61 ;;; o The code is less efficient that it could be - in a lot of places, I
62 ;;; pull a 512-character string out of the buffer and parse it, when I could
63 ;;; be parsing it in place, not garbaging a string. Should redo that.
65 ;;; o I'd like a command that searches for a string/regexp in every subfile
66 ;;; of an archive, where <esc> would leave you in a subfile-edit buffer.
67 ;;; (Like the Meta-R command of the Zmacs mail reader.)
69 ;;; o Sometimes (but not always) reverting the tar-file buffer does not
70 ;;; re-grind the listing, and you are staring at the binary tar data.
71 ;;; Typing 'g' again immediately after that will always revert and re-grind
72 ;;; it, though. I have no idea why this happens.
74 ;;; o Tar-mode interacts poorly with crypt.el and zcat.el because the tar
75 ;;; write-file-hook actually writes the file. Instead it should remove the
76 ;;; header (and conspire to put it back afterwards) so that other write-file
77 ;;; hooks which frob the buffer have a chance to do their dirty work. There
78 ;;; might be a problem if the tar write-file-hook does not come *first* on
81 ;;; o Block files, sparse files, continuation files, and the various header
82 ;;; types aren't editable. Actually I don't know that they work at all.
86 ;;; Why does tar-mode edit the file itself instead of using tar?
88 ;;; That means that you can edit tar files which you don't have room for
89 ;;; on your local disk.
91 ;;; I don't know about recent features in gnu tar, but old versions of tar
92 ;;; can't replace a file in the middle of a tar file with a new version.
93 ;;; Tar-mode can. I don't think tar can do things like chmod the subfiles.
94 ;;; An implementation which involved unpacking and repacking the file into
95 ;;; some scratch directory would be very wasteful, and wouldn't be able to
96 ;;; preserve the file owners.
100 (defvar tar-anal-blocksize
20
101 "*The blocksize of tar files written by Emacs, or nil, meaning don't care.
102 The blocksize of a tar file is not really the size of the blocks; rather, it is
103 the number of blocks written with one system call. When tarring to a tape,
104 this is the size of the *tape* blocks, but when writing to a file, it doesn't
105 matter much. The only noticeable difference is that if a tar file does not
106 have a blocksize of 20, tar will tell you that; all this really controls is
107 how many null padding bytes go on the end of the tar file.")
109 (defvar tar-update-datestamp nil
110 "*Whether tar-mode should play fast and loose with sub-file datestamps;
111 if this is true, then editing and saving a tar file entry back into its
112 tar file will update its datestamp. If false, the datestamp is unchanged.
113 You may or may not want this - it is good in that you can tell when a file
114 in a tar archive has been changed, but it is bad for the same reason that
115 editing a file in the tar archive at all is bad - the changed version of
116 the file never exists on disk.")
118 (defvar tar-parse-info nil
)
119 (defvar tar-header-offset nil
)
120 (defvar tar-superior-buffer nil
)
121 (defvar tar-superior-descriptor nil
)
122 (defvar tar-subfile-mode nil
)
124 (put 'tar-parse-info
'permanent-local t
)
125 (put 'tar-header-offset
'permanent-local t
)
126 (put 'tar-superior-buffer
'permanent-local t
)
127 (put 'tar-superior-descriptor
'permanent-local t
)
129 ;;; First, duplicate some Common Lisp functions; I used to just (require 'cl)
130 ;;; but "cl.el" was messing some people up (also it's really big).
132 (defmacro tar-setf
(form val
)
133 "A mind-numbingly simple implementation of setf."
134 (let ((mform (macroexpand form
(and (boundp 'byte-compile-macro-environment
)
135 byte-compile-macro-environment
))))
136 (cond ((symbolp mform
) (list 'setq mform val
))
137 ((not (consp mform
)) (error "can't setf %s" form
))
138 ((eq (car mform
) 'aref
)
139 (list 'aset
(nth 1 mform
) (nth 2 mform
) val
))
140 ((eq (car mform
) 'car
)
141 (list 'setcar
(nth 1 mform
) val
))
142 ((eq (car mform
) 'cdr
)
143 (list 'setcdr
(nth 1 mform
) val
))
144 (t (error "don't know how to setf %s" form
)))))
146 (defmacro tar-dolist
(control &rest body
)
147 "syntax: (dolist (var-name list-expr &optional return-value) &body body)"
148 (let ((var (car control
))
149 (init (car (cdr control
)))
150 (val (car (cdr (cdr control
)))))
151 (list 'let
(list (list '_dolist_iterator_ init
))
152 (list 'while
'_dolist_iterator_
154 (cons (list (list var
'(car _dolist_iterator_
)))
156 (list (list 'setq
'_dolist_iterator_
157 (list 'cdr
'_dolist_iterator_
)))))))
160 (defmacro tar-dotimes
(control &rest body
)
161 "syntax: (dolist (var-name count-expr &optional return-value) &body body)"
162 (let ((var (car control
))
163 (n (car (cdr control
)))
164 (val (car (cdr (cdr control
)))))
165 (list 'let
(list (list '_dotimes_end_ n
)
168 (cons (list '< var
'_dotimes_end_
)
170 (list (list 'setq var
(list '1+ var
))))))
174 ;;; down to business.
176 (defmacro make-tar-header
(name mode uid git size date ck lt ln
177 magic uname gname devmaj devmin
)
178 (list 'vector name mode uid git size date ck lt ln
179 magic uname gname devmaj devmin
))
181 (defmacro tar-header-name
(x) (list 'aref x
0))
182 (defmacro tar-header-mode
(x) (list 'aref x
1))
183 (defmacro tar-header-uid
(x) (list 'aref x
2))
184 (defmacro tar-header-gid
(x) (list 'aref x
3))
185 (defmacro tar-header-size
(x) (list 'aref x
4))
186 (defmacro tar-header-date
(x) (list 'aref x
5))
187 (defmacro tar-header-checksum
(x) (list 'aref x
6))
188 (defmacro tar-header-link-type
(x) (list 'aref x
7))
189 (defmacro tar-header-link-name
(x) (list 'aref x
8))
190 (defmacro tar-header-magic
(x) (list 'aref x
9))
191 (defmacro tar-header-uname
(x) (list 'aref x
10))
192 (defmacro tar-header-gname
(x) (list 'aref x
11))
193 (defmacro tar-header-dmaj
(x) (list 'aref x
12))
194 (defmacro tar-header-dmin
(x) (list 'aref x
13))
196 (defmacro make-tar-desc
(data-start tokens
)
197 (list 'cons data-start tokens
))
199 (defmacro tar-desc-data-start
(x) (list 'car x
))
200 (defmacro tar-desc-tokens
(x) (list 'cdr x
))
202 (defconst tar-name-offset
0)
203 (defconst tar-mode-offset
(+ tar-name-offset
100))
204 (defconst tar-uid-offset
(+ tar-mode-offset
8))
205 (defconst tar-gid-offset
(+ tar-uid-offset
8))
206 (defconst tar-size-offset
(+ tar-gid-offset
8))
207 (defconst tar-time-offset
(+ tar-size-offset
12))
208 (defconst tar-chk-offset
(+ tar-time-offset
12))
209 (defconst tar-linkp-offset
(+ tar-chk-offset
8))
210 (defconst tar-link-offset
(+ tar-linkp-offset
1))
211 ;;; GNU-tar specific slots.
212 (defconst tar-magic-offset
(+ tar-link-offset
100))
213 (defconst tar-uname-offset
(+ tar-magic-offset
8))
214 (defconst tar-gname-offset
(+ tar-uname-offset
32))
215 (defconst tar-dmaj-offset
(+ tar-gname-offset
32))
216 (defconst tar-dmin-offset
(+ tar-dmaj-offset
8))
217 (defconst tar-end-offset
(+ tar-dmin-offset
8))
219 (defun tar-header-block-tokenize (string)
220 "Return a `tar-header' structure.
221 This is a list of name, mode, uid, gid, size,
222 write-date, checksum, link-type, and link-name."
223 (cond ((< (length string
) 512) nil
)
224 (;(some 'plusp string) ; <-- oops, massive cycle hog!
225 (or (not (= 0 (aref string
0))) ; This will do.
226 (not (= 0 (aref string
101))))
227 (let* ((name-end (1- tar-mode-offset
))
228 (link-end (1- tar-magic-offset
))
229 (uname-end (1- tar-gname-offset
))
230 (gname-end (1- tar-dmaj-offset
))
231 (link-p (aref string tar-linkp-offset
))
232 (magic-str (substring string tar-magic-offset
(1- tar-uname-offset
)))
233 (uname-valid-p (or (string= "ustar " magic-str
) (string= "GNUtar " magic-str
)))
235 (nulsexp "[^\000]*\000"))
236 (and (string-match nulsexp string tar-name-offset
) (setq name-end
(min name-end
(1- (match-end 0)))))
237 (and (string-match nulsexp string tar-link-offset
) (setq link-end
(min link-end
(1- (match-end 0)))))
238 (and (string-match nulsexp string tar-uname-offset
) (setq uname-end
(min uname-end
(1- (match-end 0)))))
239 (and (string-match nulsexp string tar-gname-offset
) (setq gname-end
(min gname-end
(1- (match-end 0)))))
240 (setq name
(substring string tar-name-offset name-end
)
241 link-p
(if (or (= link-p
0) (= link-p ?
0))
244 (if (and (null link-p
) (string-match "/$" name
)) (setq link-p
5)) ; directory
247 (tar-parse-octal-integer string tar-mode-offset
(1- tar-uid-offset
))
248 (tar-parse-octal-integer string tar-uid-offset
(1- tar-gid-offset
))
249 (tar-parse-octal-integer string tar-gid-offset
(1- tar-size-offset
))
250 (tar-parse-octal-integer string tar-size-offset
(1- tar-time-offset
))
251 (tar-parse-octal-integer string tar-time-offset
(1- tar-chk-offset
))
252 (tar-parse-octal-integer string tar-chk-offset
(1- tar-linkp-offset
))
254 (substring string tar-link-offset link-end
)
256 (and uname-valid-p
(substring string tar-uname-offset uname-end
))
257 (and uname-valid-p
(substring string tar-gname-offset gname-end
))
258 (tar-parse-octal-integer string tar-dmaj-offset
(1- tar-dmin-offset
))
259 (tar-parse-octal-integer string tar-dmin-offset
(1- tar-end-offset
))
261 (t 'empty-tar-block
)))
264 (defun tar-parse-octal-integer (string &optional start end
)
265 (if (null start
) (setq start
0))
266 (if (null end
) (setq end
(length string
)))
267 (if (= (aref string start
) 0)
271 (setq n
(if (< (aref string start
) ?
0) n
272 (+ (* n
8) (- (aref string start
) 48)))
276 (defun tar-parse-octal-integer-safe (string)
277 (let ((L (length string
)))
278 (if (= L
0) (error "empty string"))
280 (if (or (< (aref string i
) ?
0)
281 (> (aref string i
) ?
7))
282 (error "'%c' is not an octal digit"))))
283 (tar-parse-octal-integer string
))
286 (defun tar-header-block-checksum (string)
287 "Compute and return a tar-acceptable checksum for this block."
288 (let* ((chk-field-start tar-chk-offset
)
289 (chk-field-end (+ chk-field-start
8))
292 ;; Add up all of the characters except the ones in the checksum field.
293 ;; Add that field as if it were filled with spaces.
294 (while (< i chk-field-start
)
295 (setq sum
(+ sum
(aref string i
))
297 (setq i chk-field-end
)
299 (setq sum
(+ sum
(aref string i
))
303 (defun tar-header-block-check-checksum (hblock desired-checksum file-name
)
304 "Beep and print a warning if the checksum doesn't match."
305 (if (not (= desired-checksum
(tar-header-block-checksum hblock
)))
306 (progn (beep) (message "Invalid checksum for file %s!" file-name
))))
308 (defun tar-header-block-recompute-checksum (hblock)
309 "Modifies the given string to have a valid checksum field."
310 (let* ((chk (tar-header-block-checksum hblock
))
311 (chk-string (format "%6o" chk
))
312 (l (length chk-string
)))
315 (tar-dotimes (i l
) (aset hblock
(- 153 i
) (aref chk-string
(- l i
1)))))
319 (defun tar-grind-file-mode (mode string start
)
320 "Write a \"-rw--r--r-\" representing MODE into STRING beginning at START."
321 (aset string start
(if (zerop (logand 256 mode
)) ?- ?r
))
322 (aset string
(+ start
1) (if (zerop (logand 128 mode
)) ?- ?w
))
323 (aset string
(+ start
2) (if (zerop (logand 64 mode
)) ?- ?x
))
324 (aset string
(+ start
3) (if (zerop (logand 32 mode
)) ?- ?r
))
325 (aset string
(+ start
4) (if (zerop (logand 16 mode
)) ?- ?w
))
326 (aset string
(+ start
5) (if (zerop (logand 8 mode
)) ?- ?x
))
327 (aset string
(+ start
6) (if (zerop (logand 4 mode
)) ?- ?r
))
328 (aset string
(+ start
7) (if (zerop (logand 2 mode
)) ?- ?w
))
329 (aset string
(+ start
8) (if (zerop (logand 1 mode
)) ?- ?x
))
330 (if (zerop (logand 1024 mode
)) nil
(aset string
(+ start
2) ?s
))
331 (if (zerop (logand 2048 mode
)) nil
(aset string
(+ start
5) ?s
))
334 (defun tar-header-block-summarize (tar-hblock &optional mod-p
)
335 "Returns a line similar to the output of `tar -vtf'."
336 (let ((name (tar-header-name tar-hblock
))
337 (mode (tar-header-mode tar-hblock
))
338 (uid (tar-header-uid tar-hblock
))
339 (gid (tar-header-gid tar-hblock
))
340 (uname (tar-header-uname tar-hblock
))
341 (gname (tar-header-gname tar-hblock
))
342 (size (tar-header-size tar-hblock
))
343 (time (tar-header-date tar-hblock
))
344 (ck (tar-header-checksum tar-hblock
))
345 (link-p (tar-header-link-type tar-hblock
))
346 (link-name (tar-header-link-name tar-hblock
))
353 (slash (1- (+ left namew
)))
354 (lastdigit (+ slash groupw sizew
))
355 (namestart (+ lastdigit datew
))
356 (string (make-string (+ namestart
(length name
) (if link-p
(+ 5 (length link-name
)) 0)) 32))
357 (type (tar-header-link-type tar-hblock
)))
358 (aset string
0 (if mod-p ?
* ?
))
360 (cond ((or (eq type nil
) (eq type
0)) ?-
)
361 ((eq type
1) ?l
) ; link
362 ((eq type
2) ?s
) ; symlink
363 ((eq type
3) ?c
) ; char special
364 ((eq type
4) ?b
) ; block special
365 ((eq type
5) ?d
) ; directory
366 ((eq type
6) ?p
) ; FIFO/pipe
367 ((eq type
20) ?
*) ; directory listing
368 ((eq type
29) ?M
) ; multivolume continuation
369 ((eq type
35) ?S
) ; sparse
370 ((eq type
38) ?V
) ; volume header
372 (tar-grind-file-mode mode string
2)
373 (setq uid
(if (= 0 (length uname
)) (int-to-string uid
) uname
))
374 (setq gid
(if (= 0 (length gname
)) (int-to-string gid
) gname
))
375 (setq size
(int-to-string size
))
376 (tar-dotimes (i (min (1- namew
) (length uid
))) (aset string
(- slash i
) (aref uid
(- (length uid
) i
1))))
377 (aset string
(1+ slash
) ?
/)
378 (tar-dotimes (i (min (1- groupw
) (length gid
))) (aset string
(+ (+ slash
2) i
) (aref gid i
)))
379 (tar-dotimes (i (min sizew
(length size
))) (aset string
(- lastdigit i
) (aref size
(- (length size
) i
1))))
380 ;; ## bloody hell, how do I print an arbitrary date??
381 (tar-dotimes (i (length name
)) (aset string
(+ namestart i
) (aref name i
)))
382 (if (or (eq link-p
1) (eq link-p
2))
384 (tar-dotimes (i 3) (aset string
(+ namestart
1 (length name
) i
) (aref (if (= link-p
1) "==>" "-->") i
)))
385 (tar-dotimes (i (length link-name
)) (aset string
(+ namestart
5 (length name
) i
) (aref link-name i
)))))
386 (put-text-property namestart
(length string
)
387 'mouse-face
'highlight string
)
391 (defun tar-summarize-buffer ()
392 "Parse the contents of the tar file in the current buffer.
393 Place a dired-like listing on the front;
394 then narrow to it, so that only that listing
395 is visible (and the real data of the buffer is hidden)."
396 (message "parsing tar file...")
399 (bs (max 1 (- (buffer-size) 1024))) ; always 2+ empty blocks at end.
400 (bs100 (max 1 (/ bs
100)))
402 (while (and (<= (+ pos
512) (point-max))
403 (not (eq 'empty-tar-block
405 (tar-header-block-tokenize
406 (buffer-substring pos
(+ pos
512)))))))
407 (setq pos
(+ pos
512))
408 (message "Parsing tar file...%d%%"
409 ;(/ (* pos 100) bs) ; this gets round-off lossage
410 (/ pos bs100
) ; this doesn't
412 (if (eq (tar-header-link-type tokens
) 20)
413 ;; Foo. There's an extra empty block after these.
414 (setq pos
(+ pos
512)))
415 (let ((size (tar-header-size tokens
)))
417 (error "%s has size %s - corrupted"
418 (tar-header-name tokens
) size
))
420 ; This is just too slow. Don't really need it anyway....
421 ;(tar-header-block-check-checksum
422 ; hblock (tar-header-block-checksum hblock)
423 ; (tar-header-name tokens))
425 (setq result
(cons (make-tar-desc pos tokens
) result
))
427 (and (null (tar-header-link-type tokens
))
430 (+ pos
512 (ash (ash (1- size
) -
9) 9)) ; this works
431 ;(+ pos (+ size (- 512 (rem (1- size) 512)))) ; this doesn't
433 (make-local-variable 'tar-parse-info
)
434 (setq tar-parse-info
(nreverse result
))
435 ;; A tar file should end with a block or two of nulls,
436 ;; but let's not get a fatal error if it doesn't.
437 (if (eq tokens
'empty-tar-block
)
438 (message "Parsing tar file...done.")
439 (message "Warning: premature EOF parsing tar file")))
441 (goto-char (point-min))
442 (let ((buffer-read-only nil
))
443 (tar-dolist (tar-desc tar-parse-info
)
445 (tar-header-block-summarize (tar-desc-tokens tar-desc
)))
446 (insert-string "\n"))
447 (make-local-variable 'tar-header-offset
)
448 (setq tar-header-offset
(point))
449 (narrow-to-region 1 tar-header-offset
)
450 (set-buffer-modified-p nil
))))
452 (defvar tar-mode-map nil
"*Local keymap for Tar mode listings.")
456 (setq tar-mode-map
(make-keymap))
457 (suppress-keymap tar-mode-map
)
458 (define-key tar-mode-map
" " 'tar-next-line
)
459 (define-key tar-mode-map
"c" 'tar-copy
)
460 (define-key tar-mode-map
"d" 'tar-flag-deleted
)
461 (define-key tar-mode-map
"\^D" 'tar-flag-deleted
)
462 (define-key tar-mode-map
"e" 'tar-extract
)
463 (define-key tar-mode-map
"f" 'tar-extract
)
464 (define-key tar-mode-map
"\C-m" 'tar-extract
)
465 (define-key tar-mode-map
[mouse-2
] 'tar-mouse-extract
)
466 (define-key tar-mode-map
"g" 'revert-buffer
)
467 (define-key tar-mode-map
"h" 'describe-mode
)
468 (define-key tar-mode-map
"n" 'tar-next-line
)
469 (define-key tar-mode-map
"\^N" 'tar-next-line
)
470 (define-key tar-mode-map
"o" 'tar-extract-other-window
)
471 (define-key tar-mode-map
"p" 'tar-previous-line
)
472 (define-key tar-mode-map
"\^P" 'tar-previous-line
)
473 (define-key tar-mode-map
"r" 'tar-rename-entry
)
474 (define-key tar-mode-map
"u" 'tar-unflag
)
475 (define-key tar-mode-map
"v" 'tar-view
)
476 (define-key tar-mode-map
"x" 'tar-expunge
)
477 (define-key tar-mode-map
"\177" 'tar-unflag-backwards
)
478 (define-key tar-mode-map
"E" 'tar-extract-other-window
)
479 (define-key tar-mode-map
"M" 'tar-chmod-entry
)
480 (define-key tar-mode-map
"G" 'tar-chgrp-entry
)
481 (define-key tar-mode-map
"O" 'tar-chown-entry
)
484 ;; Make menu bar items.
486 ;; Get rid of the Edit menu bar item to save space.
487 (define-key tar-mode-map
[menu-bar edit
] 'undefined
)
489 (define-key tar-mode-map
[menu-bar immediate
]
490 (cons "Immediate" (make-sparse-keymap "Immediate")))
492 (define-key tar-mode-map
[menu-bar immediate view
]
493 '("View This File" . tar-view
))
494 (define-key tar-mode-map
[menu-bar immediate display
]
495 '("Display in Other Window" . tar-display-file
))
496 (define-key tar-mode-map
[menu-bar immediate find-file-other-window
]
497 '("Find in Other Window" . tar-extract-other-window
))
498 (define-key tar-mode-map
[menu-bar immediate find-file
]
499 '("Find This File" . tar-extract
))
501 (define-key tar-mode-map
[menu-bar mark
]
502 (cons "Mark" (make-sparse-keymap "Mark")))
504 (define-key tar-mode-map
[menu-bar mark unmark-all
]
505 '("Unmark All" . tar-clear-modification-flags
))
506 (define-key tar-mode-map
[menu-bar mark deletion
]
507 '("Flag" . tar-flag-deleted
))
508 (define-key tar-mode-map
[menu-bar mark unmark
]
509 '("Unflag" . tar-unflag
))
511 (define-key tar-mode-map
[menu-bar operate
]
512 (cons "Operate" (make-sparse-keymap "Operate")))
514 (define-key tar-mode-map
[menu-bar operate chown
]
515 '("Change Owner..." . tar-chown-entry
))
516 (define-key tar-mode-map
[menu-bar operate chgrp
]
517 '("Change Group..." . tar-chgrp-entry
))
518 (define-key tar-mode-map
[menu-bar operate chmod
]
519 '("Change Mode..." . tar-chmod-entry
))
520 (define-key tar-mode-map
[menu-bar operate rename
]
521 '("Rename to..." . tar-rename-entry
))
522 (define-key tar-mode-map
[menu-bar operate copy
]
523 '("Copy to..." . tar-copy
))
524 (define-key tar-mode-map
[menu-bar operate expunge
]
525 '("Expunge marked files" . tar-expunge
))
527 ;; tar mode is suitable only for specially formatted data.
528 (put 'tar-mode
'mode-class
'special
)
529 (put 'tar-subfile-mode
'mode-class
'special
)
533 "Major mode for viewing a tar file as a dired-like listing of its contents.
534 You can move around using the usual cursor motion commands.
535 Letters no longer insert themselves.
536 Type `e' to pull a file out of the tar file and into its own buffer;
537 or click mouse-2 on the file's line in the Tar mode buffer.
538 Type `c' to copy an entry from the tar file into another file on disk.
540 If you edit a sub-file of this archive (as with the `e' command) and
541 save it with Control-x Control-s, the contents of that buffer will be
542 saved back into the tar-file buffer; in this way you can edit a file
543 inside of a tar archive without extracting it and re-archiving it.
545 See also: variables `tar-update-datestamp' and `tar-anal-blocksize'.
547 ;; this is not interactive because you shouldn't be turning this
548 ;; mode on and off. You can corrupt things that way.
549 ;; rms: with permanent locals, it should now be possible to make this work
550 ;; interactively in some reasonable fashion.
551 (kill-all-local-variables)
552 (make-local-variable 'tar-header-offset
)
553 (make-local-variable 'tar-parse-info
)
554 (make-local-variable 'require-final-newline
)
555 (setq require-final-newline nil
) ; binary data, dude...
556 (make-local-variable 'revert-buffer-function
)
557 (setq revert-buffer-function
'tar-mode-revert
)
558 (make-local-variable 'enable-local-variables
)
559 (setq enable-local-variables nil
)
560 (setq major-mode
'tar-mode
)
561 (setq mode-name
"Tar")
562 (use-local-map tar-mode-map
)
565 (if (and (boundp 'tar-header-offset
) tar-header-offset
)
566 (narrow-to-region 1 tar-header-offset
)
567 (tar-summarize-buffer))
568 (run-hooks 'tar-mode-hook
)
572 ;; This should be converted to use a minor mode keymap.
574 (defun tar-subfile-mode (p)
575 "Minor mode for editing an element of a tar-file.
576 This mode redefines C-x C-s to save the current buffer back into its
577 associated tar-file buffer. You must save that buffer to actually
578 save your changes to disk."
580 (or (and (boundp 'tar-superior-buffer
) tar-superior-buffer
)
581 (error "This buffer is not an element of a tar file"))
582 ;;; Don't do this, because it is redundant and wastes mode line space.
583 ;;; (or (assq 'tar-subfile-mode minor-mode-alist)
584 ;;; (setq minor-mode-alist (append minor-mode-alist
585 ;;; (list '(tar-subfile-mode " TarFile")))))
586 (make-local-variable 'tar-subfile-mode
)
587 (setq tar-subfile-mode
589 (not tar-subfile-mode
)
590 (> (prefix-numeric-value p
) 0)))
591 (cond (tar-subfile-mode
592 (make-local-variable 'local-write-file-hooks
)
593 (setq local-write-file-hooks
'(tar-subfile-save-buffer))
594 ;; turn off auto-save.
596 (setq buffer-auto-save-file-name nil
)
597 (run-hooks 'tar-subfile-mode-hook
))
599 (kill-local-variable 'local-write-file-hooks
))))
602 ;; Revert the buffer and recompute the dired-like listing.
603 (defun tar-mode-revert (&optional no-autosave no-confirm
)
604 (setq tar-header-offset nil
)
605 (let ((revert-buffer-function nil
))
606 (revert-buffer t no-confirm
)
611 (defun tar-next-line (p)
614 (if (eobp) nil
(forward-char 36)))
616 (defun tar-previous-line (p)
618 (tar-next-line (- p
)))
620 (defun tar-current-descriptor (&optional noerror
)
621 "Return the tar-descriptor of the current line, or signals an error."
622 ;; I wish lines had plists, like in ZMACS...
623 (or (nth (count-lines (point-min)
624 (save-excursion (beginning-of-line) (point)))
628 (error "This line does not describe a tar-file entry"))))
630 (defun tar-get-descriptor ()
631 (let* ((descriptor (tar-current-descriptor))
632 (tokens (tar-desc-tokens descriptor
))
633 (size (tar-header-size tokens
))
634 (link-p (tar-header-link-type tokens
)))
636 (error "This is a %s, not a real file"
637 (cond ((eq link-p
5) "directory")
638 ((eq link-p
20) "tar directory header")
639 ((eq link-p
29) "multivolume-continuation")
640 ((eq link-p
35) "sparse entry")
641 ((eq link-p
38) "volume header")
643 (if (zerop size
) (error "This is a zero-length file"))
646 (defun tar-mouse-extract (event)
647 "Extract a file whose tar directory line you click on."
650 (set-buffer (window-buffer (posn-window (event-end event
))))
652 (goto-char (posn-point (event-end event
)))
653 ;; Just make sure this doesn't get an error.
654 (tar-get-descriptor)))
655 (select-window (posn-window (event-end event
)))
656 (goto-char (posn-point (event-end event
)))
659 (defun tar-extract (&optional other-window-p
)
660 "In Tar mode, extract this entry of the tar file into its own buffer."
662 (let* ((view-p (eq other-window-p
'view
))
663 (descriptor (tar-get-descriptor))
664 (tokens (tar-desc-tokens descriptor
))
665 (name (tar-header-name tokens
))
666 (size (tar-header-size tokens
))
667 (start (+ (tar-desc-data-start descriptor
) tar-header-offset -
1))
668 (end (+ start size
)))
669 (let* ((tar-buffer (current-buffer))
670 (tarname (file-name-nondirectory (buffer-file-name)))
671 (bufname (concat (file-name-nondirectory name
)
675 (read-only-p (or buffer-read-only view-p
))
676 (buffer (get-buffer bufname
))
680 (setq buffer
(get-buffer-create bufname
))
681 (setq just-created t
)
687 (insert-buffer-substring tar-buffer start end
)
689 (setq buffer-file-name
690 (expand-file-name (concat tarname
":" name
)))
691 (setq buffer-file-truename
692 (abbreviate-file-name buffer-file-name
))
693 ;; Set the default-directory to the dir of the
695 (setq default-directory
697 (set-buffer tar-buffer
)
699 (normal-mode) ; pick a mode.
700 (rename-buffer bufname
)
701 (make-local-variable 'tar-superior-buffer
)
702 (make-local-variable 'tar-superior-descriptor
)
703 (setq tar-superior-buffer tar-buffer
)
704 (setq tar-superior-descriptor descriptor
)
706 (setq buffer-read-only read-only-p
)
707 (set-buffer-modified-p nil
))
708 (set-buffer tar-buffer
))
709 (narrow-to-region 1 tar-header-offset
)))
714 (setq view-exit-action
'kill-buffer
)))
715 (if (eq other-window-p
'display
)
716 (display-buffer buffer
)
718 (switch-to-buffer-other-window buffer
)
719 (switch-to-buffer buffer
)))))))
722 (defun tar-extract-other-window ()
723 "*In Tar mode, find this entry of the tar file in another window."
727 (defun tar-display-other-window ()
728 "*In Tar mode, display this entry of the tar file in another window."
730 (tar-extract 'display
))
733 "*In Tar mode, view the tar file entry on this line."
738 (defun tar-read-file-name (&optional prompt
)
739 "Read a file name with this line's entry as the default."
740 (or prompt
(setq prompt
"Copy to: "))
741 (let* ((default-file (expand-file-name
742 (tar-header-name (tar-desc-tokens
743 (tar-current-descriptor)))))
744 (target (expand-file-name
745 (read-file-name prompt
746 (file-name-directory default-file
)
748 (if (or (string= "" (file-name-nondirectory target
))
749 (file-directory-p target
))
750 (setq target
(concat (if (string-match "/$" target
)
751 (substring target
0 (1- (match-end 0)))
754 (file-name-nondirectory default-file
))))
758 (defun tar-copy (&optional to-file
)
759 "*In Tar mode, extract this entry of the tar file into a file on disk.
760 If TO-FILE is not supplied, it is prompted for, defaulting to the name of
761 the current tar-entry."
762 (interactive (list (tar-read-file-name)))
763 (let* ((descriptor (tar-get-descriptor))
764 (tokens (tar-desc-tokens descriptor
))
765 (name (tar-header-name tokens
))
766 (size (tar-header-size tokens
))
767 (start (+ (tar-desc-data-start descriptor
) tar-header-offset -
1))
768 (end (+ start size
)))
771 (write-region start end to-file
))
772 (message "Copied tar entry %s to %s" name to-file
)))
774 (defun tar-flag-deleted (p &optional unflag
)
775 "*In Tar mode, mark this sub-file to be deleted from the tar file.
776 With a prefix argument, mark that many files."
779 (tar-dotimes (i (if (< p
0) (- p
) p
))
780 (if (tar-current-descriptor unflag
) ; barf if we're not on an entry-line.
783 (insert (if unflag
" " "D"))))
784 (forward-line (if (< p
0) -
1 1)))
785 (if (eobp) nil
(forward-char 36)))
787 (defun tar-unflag (p)
788 "*In Tar mode, un-mark this sub-file if it is marked to be deleted.
789 With a prefix argument, un-mark that many files forward."
791 (tar-flag-deleted p t
))
793 (defun tar-unflag-backwards (p)
794 "*In Tar mode, un-mark this sub-file if it is marked to be deleted.
795 With a prefix argument, un-mark that many files backward."
797 (tar-flag-deleted (- p
) t
))
800 (defun tar-expunge-internal ()
801 "Expunge the tar-entry specified by the current line."
802 (let* ((descriptor (tar-current-descriptor))
803 (tokens (tar-desc-tokens descriptor
))
804 (line (tar-desc-data-start descriptor
))
805 (name (tar-header-name tokens
))
806 (size (tar-header-size tokens
))
807 (link-p (tar-header-link-type tokens
))
808 (start (tar-desc-data-start descriptor
))
809 (following-descs (cdr (memq descriptor tar-parse-info
))))
810 (if link-p
(setq size
0)) ; size lies for hard-links.
812 ;; delete the current line...
814 (let ((line-start (point)))
815 (end-of-line) (forward-char)
816 (let ((line-len (- (point) line-start
)))
817 (delete-region line-start
(point))
819 ;; decrement the header-pointer to be in synch...
820 (setq tar-header-offset
(- tar-header-offset line-len
))))
822 ;; delete the data pointer...
823 (setq tar-parse-info
(delq descriptor tar-parse-info
))
825 ;; delete the data from inside the file...
827 (let* ((data-start (+ start tar-header-offset -
513))
828 (data-end (+ data-start
512 (ash (ash (+ size
511) -
9) 9))))
829 (delete-region data-start data-end
)
831 ;; and finally, decrement the start-pointers of all following
832 ;; entries in the archive. This is a pig when deleting a bunch
833 ;; of files at once - we could optimize this to only do the
834 ;; iteration over the files that remain, or only iterate up to
835 ;; the next file to be deleted.
836 (let ((data-length (- data-end data-start
)))
837 (tar-dolist (desc following-descs
)
838 (tar-setf (tar-desc-data-start desc
)
839 (- (tar-desc-data-start desc
) data-length
))))
841 (narrow-to-region 1 tar-header-offset
))
844 (defun tar-expunge (&optional noconfirm
)
845 "*In Tar mode, delete all the archived files flagged for deletion.
846 This does not modify the disk image; you must save the tar file itself
847 for this to be permanent."
850 (y-or-n-p "expunge files marked for deletion? "))
856 (progn (tar-expunge-internal)
859 ;; after doing the deletions, add any padding that may be necessary.
860 (tar-pad-to-blocksize)
861 (narrow-to-region 1 tar-header-offset
)
864 (message "nothing to expunge.")
865 (message "%s expunged. Be sure to save this buffer." n
)))))
868 (defun tar-clear-modification-flags ()
869 "Remove the stars at the beginning of each line."
872 (while (< (point) tar-header-offset
)
874 (progn (delete-char 1) (insert " ")))
878 (defun tar-chown-entry (new-uid)
879 "*Change the user-id associated with this entry in the tar file.
880 If this tar file was written by GNU tar, then you will be able to edit
881 the user id as a string; otherwise, you must edit it as a number.
882 You can force editing as a number by calling this with a prefix arg.
883 This does not modify the disk image; you must save the tar file itself
884 for this to be permanent."
886 (let ((tokens (tar-desc-tokens (tar-current-descriptor))))
887 (if (or current-prefix-arg
888 (not (tar-header-magic tokens
)))
890 (while (not (numberp (setq n
(read-minibuffer
892 (format "%s" (tar-header-uid tokens
)))))))
894 (read-string "New UID string: " (tar-header-uname tokens
))))))
895 (cond ((stringp new-uid
)
896 (tar-setf (tar-header-uname (tar-desc-tokens (tar-current-descriptor)))
898 (tar-alter-one-field tar-uname-offset
(concat new-uid
"\000")))
900 (tar-setf (tar-header-uid (tar-desc-tokens (tar-current-descriptor)))
902 (tar-alter-one-field tar-uid-offset
903 (concat (substring (format "%6o" new-uid
) 0 6) "\000 ")))))
906 (defun tar-chgrp-entry (new-gid)
907 "*Change the group-id associated with this entry in the tar file.
908 If this tar file was written by GNU tar, then you will be able to edit
909 the group id as a string; otherwise, you must edit it as a number.
910 You can force editing as a number by calling this with a prefix arg.
911 This does not modify the disk image; you must save the tar file itself
912 for this to be permanent."
914 (let ((tokens (tar-desc-tokens (tar-current-descriptor))))
915 (if (or current-prefix-arg
916 (not (tar-header-magic tokens
)))
918 (while (not (numberp (setq n
(read-minibuffer
920 (format "%s" (tar-header-gid tokens
)))))))
922 (read-string "New GID string: " (tar-header-gname tokens
))))))
923 (cond ((stringp new-gid
)
924 (tar-setf (tar-header-gname (tar-desc-tokens (tar-current-descriptor)))
926 (tar-alter-one-field tar-gname-offset
927 (concat new-gid
"\000")))
929 (tar-setf (tar-header-gid (tar-desc-tokens (tar-current-descriptor)))
931 (tar-alter-one-field tar-gid-offset
932 (concat (substring (format "%6o" new-gid
) 0 6) "\000 ")))))
934 (defun tar-rename-entry (new-name)
935 "*Change the name associated with this entry in the tar file.
936 This does not modify the disk image; you must save the tar file itself
937 for this to be permanent."
939 (list (read-string "New name: "
940 (tar-header-name (tar-desc-tokens (tar-current-descriptor))))))
941 (if (string= "" new-name
) (error "zero length name"))
942 (if (> (length new-name
) 98) (error "name too long"))
943 (tar-setf (tar-header-name (tar-desc-tokens (tar-current-descriptor)))
945 (tar-alter-one-field 0
946 (substring (concat new-name
(make-string 99 0)) 0 99)))
949 (defun tar-chmod-entry (new-mode)
950 "*Change the protection bits associated with this entry in the tar file.
951 This does not modify the disk image; you must save the tar file itself
952 for this to be permanent."
953 (interactive (list (tar-parse-octal-integer-safe
954 (read-string "New protection (octal): "))))
955 (tar-setf (tar-header-mode (tar-desc-tokens (tar-current-descriptor)))
957 (tar-alter-one-field tar-mode-offset
958 (concat (substring (format "%6o" new-mode
) 0 6) "\000 ")))
961 (defun tar-alter-one-field (data-position new-data-string
)
962 (let* ((descriptor (tar-current-descriptor))
963 (tokens (tar-desc-tokens descriptor
)))
967 ;; update the header-line.
971 (delete-region p
(point))
972 (insert (tar-header-block-summarize tokens
) "\n")
973 (setq tar-header-offset
(point-max)))
976 (let* ((start (+ (tar-desc-data-start descriptor
) tar-header-offset -
513)))
978 ;; delete the old field and insert a new one.
979 (goto-char (+ start data-position
))
980 (delete-region (point) (+ (point) (length new-data-string
))) ; <--
981 (insert new-data-string
) ; <--
983 ;; compute a new checksum and insert it.
984 (let ((chk (tar-header-block-checksum
985 (buffer-substring start
(+ start
512)))))
986 (goto-char (+ start tar-chk-offset
))
987 (delete-region (point) (+ (point) 8))
988 (insert (format "%6o" chk
))
991 (tar-setf (tar-header-checksum tokens
) chk
)
993 ;; ok, make sure we didn't botch it.
994 (tar-header-block-check-checksum
995 (buffer-substring start
(+ start
512))
996 chk
(tar-header-name tokens
))
998 (narrow-to-region 1 tar-header-offset
))))
1001 (defun tar-octal-time (timeval)
1002 ;; Format a timestamp as 11 octal digits. Ghod, I hope this works...
1003 (let ((hibits (car timeval
)) (lobits (car (cdr timeval
))))
1004 (insert (format "%05o%01o%05o"
1006 (logior (lsh (logand 3 hibits
) 1) (> (logand lobits
32768) 0))
1007 (logand 32767 lobits
)
1010 (defun tar-subfile-save-buffer ()
1011 "In tar subfile mode, save this buffer into its parent tar-file buffer.
1012 This doesn't write anything to disk; you must save the parent tar-file buffer
1013 to make your changes permanent."
1015 (if (not (and (boundp 'tar-superior-buffer
) tar-superior-buffer
))
1016 (error "This buffer has no superior tar file buffer"))
1017 (if (not (and (boundp 'tar-superior-descriptor
) tar-superior-descriptor
))
1018 (error "This buffer doesn't have an index into its superior tar file!"))
1020 (let ((subfile (current-buffer))
1021 (subfile-size (buffer-size))
1022 (descriptor tar-superior-descriptor
))
1023 (set-buffer tar-superior-buffer
)
1024 (let* ((tokens (tar-desc-tokens descriptor
))
1025 (start (tar-desc-data-start descriptor
))
1026 (name (tar-header-name tokens
))
1027 (size (tar-header-size tokens
))
1028 (size-pad (ash (ash (+ size
511) -
9) 9))
1029 (head (memq descriptor tar-parse-info
))
1030 (following-descs (cdr head
)))
1032 (error "Can't find this tar file entry in its parent tar file!"))
1036 ;; delete the old data...
1037 (let* ((data-start (+ start tar-header-offset -
1))
1038 (data-end (+ data-start
(ash (ash (+ size
511) -
9) 9))))
1039 (delete-region data-start data-end
)
1040 ;; insert the new data...
1041 (goto-char data-start
)
1042 (insert-buffer subfile
)
1044 ;; pad the new data out to a multiple of 512...
1045 (let ((subfile-size-pad (ash (ash (+ subfile-size
511) -
9) 9)))
1046 (goto-char (+ data-start subfile-size
))
1047 (insert (make-string (- subfile-size-pad subfile-size
) 0))
1049 ;; update the data pointer of this and all following files...
1050 (tar-setf (tar-header-size tokens
) subfile-size
)
1051 (let ((difference (- subfile-size-pad size-pad
)))
1052 (tar-dolist (desc following-descs
)
1053 (tar-setf (tar-desc-data-start desc
)
1054 (+ (tar-desc-data-start desc
) difference
))))
1056 ;; Update the size field in the header block.
1057 (let ((header-start (- data-start
512)))
1058 (goto-char (+ header-start tar-size-offset
))
1059 (delete-region (point) (+ (point) 12))
1060 (insert (format "%11o" subfile-size
))
1063 ;; Maybe update the datestamp.
1064 (if (not tar-update-datestamp
)
1066 (goto-char (+ header-start tar-time-offset
))
1067 (delete-region (point) (+ (point) 12))
1068 (insert (tar-octal-time (current-time)))
1071 ;; compute a new checksum and insert it.
1072 (let ((chk (tar-header-block-checksum
1073 (buffer-substring header-start data-start
))))
1074 (goto-char (+ header-start tar-chk-offset
))
1075 (delete-region (point) (+ (point) 8))
1076 (insert (format "%6o" chk
))
1079 (tar-setf (tar-header-checksum tokens
) chk
)))
1081 ;; alter the descriptor-line...
1083 (let ((position (- (length tar-parse-info
) (length head
))))
1085 (next-line position
)
1089 (m (set-marker (make-marker) tar-header-offset
)))
1091 (setq after
(point))
1092 ;; Insert the new text after the old, before deleting,
1093 ;; to preserve the window start.
1094 (insert-before-markers (tar-header-block-summarize tokens t
) "\n")
1095 (delete-region p after
)
1096 (setq tar-header-offset
(marker-position m
)))
1098 ;; after doing the insertion, add any final padding that may be necessary.
1099 (tar-pad-to-blocksize))
1100 (narrow-to-region 1 tar-header-offset
)))
1101 (set-buffer-modified-p t
) ; mark the tar file as modified
1102 (set-buffer subfile
)
1103 (set-buffer-modified-p nil
) ; mark the tar subfile as unmodified
1104 (message "saved into tar-buffer `%s' -- remember to save that buffer!"
1105 (buffer-name tar-superior-buffer
))
1106 ;; Prevent ordinary saving from happening.
1110 (defun tar-pad-to-blocksize ()
1111 "If we are being anal about tar file blocksizes, fix up the current buffer.
1112 Leaves the region wide."
1113 (if (null tar-anal-blocksize
)
1116 (let* ((last-desc (nth (1- (length tar-parse-info
)) tar-parse-info
))
1117 (start (tar-desc-data-start last-desc
))
1118 (tokens (tar-desc-tokens last-desc
))
1119 (link-p (tar-header-link-type tokens
))
1120 (size (if link-p
0 (tar-header-size tokens
)))
1121 (data-end (+ start size
))
1122 (bbytes (ash tar-anal-blocksize
9))
1123 (pad-to (+ bbytes
(* bbytes
(/ (1- data-end
) bbytes
))))
1124 (inhibit-read-only t
) ; ##
1126 ;; If the padding after the last data is too long, delete some;
1127 ;; else insert some until we are padded out to the right number of blocks.
1129 (goto-char (+ (or tar-header-offset
0) data-end
))
1130 (if (> (1+ (buffer-size)) (+ (or tar-header-offset
0) pad-to
))
1131 (delete-region (+ (or tar-header-offset
0) pad-to
) (1+ (buffer-size)))
1132 (insert (make-string (- (+ (or tar-header-offset
0) pad-to
)
1138 ;; Used in write-file-hook to write tar-files out correctly.
1139 (defun tar-mode-maybe-write-tar-file ()
1141 ;; If the current buffer is in Tar mode and has its header-offset set,
1142 ;; only write out the part of the file after the header-offset.
1144 (if (and (eq major-mode
'tar-mode
)
1145 (and (boundp 'tar-header-offset
) tar-header-offset
))
1148 (tar-clear-modification-flags)
1150 ;; Doing this here confuses things - the region gets left too wide!
1151 ;; I suppose this is run in a context where changing the buffer is bad.
1152 ;; (tar-pad-to-blocksize)
1153 (write-region tar-header-offset
(1+ (buffer-size)) buffer-file-name nil t
)
1154 ;; return T because we've written the file.
1156 (narrow-to-region 1 tar-header-offset
)
1158 ;; return NIL because we haven't.
1164 (or (memq 'tar-mode-maybe-write-tar-file write-file-hooks
)
1165 (setq write-file-hooks
1166 (cons 'tar-mode-maybe-write-tar-file write-file-hooks
)))
1170 ;;; tar-mode.el ends here