1 ;;; tar-mode.el --- simple editing of tar files from GNU emacs
3 ;; Copyright (C) 1990,91,93,94,95,96,97,98,99,2000,01,2004
4 ;; Free Software Foundation, Inc.
6 ;; Author: Jamie Zawinski <jwz@lucid.com>
8 ;; Created: 04 Apr 1990
11 ;; This file is part of GNU Emacs.
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)
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.
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.
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.
41 ;; This code now understands the extra fields that GNU tar adds to tar files.
43 ;; This interacts correctly with "uncompress.el" in the Emacs library,
46 ;; (autoload 'uncompress-while-visiting "uncompress")
47 ;; (setq auto-mode-alist (cons '("\\.Z$" . uncompress-while-visiting)
50 ;; Do not attempt to use tar-mode.el with crypt.el, you will lose.
52 ;; *************** TO DO ***************
54 ;; o chmod should understand "a+x,og-w".
56 ;; o It's not possible to add a NEW file to a tar archive; not that
57 ;; important, but still...
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.
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.)
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.
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
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.
84 ;; Why does tar-mode edit the file itself instead of using tar?
86 ;; That means that you can edit tar files which you don't have room for
87 ;; on your local disk.
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.
99 "Simple editing of tar files."
103 (defcustom tar-anal-blocksize 20
104 "*The blocksize of tar files written by Emacs, or nil, meaning don't care.
105 The blocksize of a tar file is not really the size of the blocks; rather, it is
106 the number of blocks written with one system call. When tarring to a tape,
107 this is the size of the *tape* blocks, but when writing to a file, it doesn't
108 matter much. The only noticeable difference is that if a tar file does not
109 have a blocksize of 20, tar will tell you that; all this really controls is
110 how many null padding bytes go on the end of the tar file."
111 :type '(choice integer (const nil))
114 (defcustom tar-update-datestamp nil
115 "*Non-nil means Tar mode should play fast and loose with sub-file datestamps.
116 If this is true, then editing and saving a tar file entry back into its
117 tar file will update its datestamp. If false, the datestamp is unchanged.
118 You may or may not want this - it is good in that you can tell when a file
119 in a tar archive has been changed, but it is bad for the same reason that
120 editing a file in the tar archive at all is bad - the changed version of
121 the file never exists on disk."
125 (defcustom tar-mode-show-date nil
126 "*Non-nil means Tar mode should show the date/time of each subfile.
127 This information is useful, but it takes screen space away from file names."
131 (defvar tar-parse-info nil)
132 (defvar tar-header-offset nil)
133 (defvar tar-superior-buffer nil)
134 (defvar tar-superior-descriptor nil)
135 (defvar tar-subfile-mode nil)
136 (defvar tar-file-name-coding-system nil)
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)
142 (put 'tar-file-name-coding-system 'permanent-local t)
144 (defmacro tar-setf (form val)
145 "A mind-numbingly simple implementation of setf."
146 (let ((mform (macroexpand form (and (boundp 'byte-compile-macro-environment)
147 byte-compile-macro-environment))))
148 (cond ((symbolp mform) (list 'setq mform val))
149 ((not (consp mform)) (error "can't setf %s" form))
150 ((eq (car mform) 'aref)
151 (list 'aset (nth 1 mform) (nth 2 mform) val))
152 ((eq (car mform) 'car)
153 (list 'setcar (nth 1 mform) val))
154 ((eq (car mform) 'cdr)
155 (list 'setcdr (nth 1 mform) val))
156 (t (error "don't know how to setf %s" form)))))
158 ;;; down to business.
160 (defmacro make-tar-header (name mode uid git size date ck lt ln
161 magic uname gname devmaj devmin)
162 (list 'vector name mode uid git size date ck lt ln
163 magic uname gname devmaj devmin))
165 (defmacro tar-header-name (x) (list 'aref x 0))
166 (defmacro tar-header-mode (x) (list 'aref x 1))
167 (defmacro tar-header-uid (x) (list 'aref x 2))
168 (defmacro tar-header-gid (x) (list 'aref x 3))
169 (defmacro tar-header-size (x) (list 'aref x 4))
170 (defmacro tar-header-date (x) (list 'aref x 5))
171 (defmacro tar-header-checksum (x) (list 'aref x 6))
172 (defmacro tar-header-link-type (x) (list 'aref x 7))
173 (defmacro tar-header-link-name (x) (list 'aref x 8))
174 (defmacro tar-header-magic (x) (list 'aref x 9))
175 (defmacro tar-header-uname (x) (list 'aref x 10))
176 (defmacro tar-header-gname (x) (list 'aref x 11))
177 (defmacro tar-header-dmaj (x) (list 'aref x 12))
178 (defmacro tar-header-dmin (x) (list 'aref x 13))
180 (defmacro make-tar-desc (data-start tokens)
181 (list 'cons data-start tokens))
183 (defmacro tar-desc-data-start (x) (list 'car x))
184 (defmacro tar-desc-tokens (x) (list 'cdr x))
186 (defconst tar-name-offset 0)
187 (defconst tar-mode-offset (+ tar-name-offset 100))
188 (defconst tar-uid-offset (+ tar-mode-offset 8))
189 (defconst tar-gid-offset (+ tar-uid-offset 8))
190 (defconst tar-size-offset (+ tar-gid-offset 8))
191 (defconst tar-time-offset (+ tar-size-offset 12))
192 (defconst tar-chk-offset (+ tar-time-offset 12))
193 (defconst tar-linkp-offset (+ tar-chk-offset 8))
194 (defconst tar-link-offset (+ tar-linkp-offset 1))
195 ;;; GNU-tar specific slots.
196 (defconst tar-magic-offset (+ tar-link-offset 100))
197 (defconst tar-uname-offset (+ tar-magic-offset 8))
198 (defconst tar-gname-offset (+ tar-uname-offset 32))
199 (defconst tar-dmaj-offset (+ tar-gname-offset 32))
200 (defconst tar-dmin-offset (+ tar-dmaj-offset 8))
201 (defconst tar-end-offset (+ tar-dmin-offset 8))
203 (defun tar-header-block-tokenize (string)
204 "Return a `tar-header' structure.
205 This is a list of name, mode, uid, gid, size,
206 write-date, checksum, link-type, and link-name."
207 (setq string (string-as-unibyte string))
208 (cond ((< (length string) 512) nil)
209 (;(some 'plusp string) ; <-- oops, massive cycle hog!
210 (or (not (= 0 (aref string 0))) ; This will do.
211 (not (= 0 (aref string 101))))
212 (let* ((name-end (1- tar-mode-offset))
213 (link-end (1- tar-magic-offset))
214 (uname-end (1- tar-gname-offset))
215 (gname-end (1- tar-dmaj-offset))
216 (link-p (aref string tar-linkp-offset))
217 (magic-str (substring string tar-magic-offset (1- tar-uname-offset)))
218 (uname-valid-p (or (string= "ustar " magic-str) (string= "GNUtar " magic-str)))
220 (nulsexp "[^\000]*\000"))
221 (when (string-match nulsexp string tar-name-offset)
222 (setq name-end (min name-end (1- (match-end 0)))))
223 (when (string-match nulsexp string tar-link-offset)
224 (setq link-end (min link-end (1- (match-end 0)))))
225 (when (string-match nulsexp string tar-uname-offset)
226 (setq uname-end (min uname-end (1- (match-end 0)))))
227 (when (string-match nulsexp string tar-gname-offset)
228 (setq gname-end (min gname-end (1- (match-end 0)))))
229 (setq name (substring string tar-name-offset name-end)
230 link-p (if (or (= link-p 0) (= link-p ?0))
233 (setq linkname (substring string tar-link-offset link-end))
234 (if default-enable-multibyte-characters
236 (decode-coding-string name tar-file-name-coding-system)
238 (decode-coding-string linkname
239 tar-file-name-coding-system)))
240 (if (and (null link-p) (string-match "/$" name)) (setq link-p 5)) ; directory
243 (tar-parse-octal-integer string tar-mode-offset tar-uid-offset)
244 (tar-parse-octal-integer string tar-uid-offset tar-gid-offset)
245 (tar-parse-octal-integer string tar-gid-offset tar-size-offset)
246 (tar-parse-octal-integer string tar-size-offset tar-time-offset)
247 (tar-parse-octal-long-integer string tar-time-offset tar-chk-offset)
248 (tar-parse-octal-integer string tar-chk-offset tar-linkp-offset)
252 (and uname-valid-p (substring string tar-uname-offset uname-end))
253 (and uname-valid-p (substring string tar-gname-offset gname-end))
254 (tar-parse-octal-integer string tar-dmaj-offset tar-dmin-offset)
255 (tar-parse-octal-integer string tar-dmin-offset tar-end-offset)
257 (t 'empty-tar-block)))
260 (defun tar-parse-octal-integer (string &optional start end)
261 (if (null start) (setq start 0))
262 (if (null end) (setq end (length string)))
263 (if (= (aref string start) 0)
267 (setq n (if (< (aref string start) ?0) n
268 (+ (* n 8) (- (aref string start) ?0)))
272 (defun tar-parse-octal-long-integer (string &optional start end)
273 (if (null start) (setq start 0))
274 (if (null end) (setq end (length string)))
275 (if (= (aref string start) 0)
280 (if (>= (aref string start) ?0)
281 (setq lo (+ (* lo 8) (- (aref string start) ?0))
282 hi (+ (* hi 8) (ash lo -16))
283 lo (logand lo 65535)))
284 (setq start (1+ start)))
287 (defun tar-parse-octal-integer-safe (string)
288 (let ((L (length string)))
289 (if (= L 0) (error "empty string"))
291 (if (or (< (aref string i) ?0)
292 (> (aref string i) ?7))
293 (error "`%c' is not an octal digit" (aref string i)))))
294 (tar-parse-octal-integer string))
297 (defun tar-header-block-checksum (string)
298 "Compute and return a tar-acceptable checksum for this block."
299 (setq string (string-as-unibyte string))
300 (let* ((chk-field-start tar-chk-offset)
301 (chk-field-end (+ chk-field-start 8))
304 ;; Add up all of the characters except the ones in the checksum field.
305 ;; Add that field as if it were filled with spaces.
306 (while (< i chk-field-start)
307 (setq sum (+ sum (aref string i))
309 (setq i chk-field-end)
311 (setq sum (+ sum (aref string i))
315 (defun tar-header-block-check-checksum (hblock desired-checksum file-name)
316 "Beep and print a warning if the checksum doesn't match."
317 (if (not (= desired-checksum (tar-header-block-checksum hblock)))
318 (progn (beep) (message "Invalid checksum for file %s!" file-name))))
320 (defun tar-clip-time-string (time)
321 (let ((str (current-time-string time)))
322 (concat " " (substring str 4 16) (substring str 19 24))))
324 (defun tar-grind-file-mode (mode)
325 "Construct a `-rw--r--r--' string indicating MODE.
326 MODE should be an integer which is a file mode value."
328 (if (zerop (logand 256 mode)) ?- ?r)
329 (if (zerop (logand 128 mode)) ?- ?w)
330 (if (zerop (logand 1024 mode)) (if (zerop (logand 64 mode)) ?- ?x) ?s)
331 (if (zerop (logand 32 mode)) ?- ?r)
332 (if (zerop (logand 16 mode)) ?- ?w)
333 (if (zerop (logand 2048 mode)) (if (zerop (logand 8 mode)) ?- ?x) ?s)
334 (if (zerop (logand 4 mode)) ?- ?r)
335 (if (zerop (logand 2 mode)) ?- ?w)
336 (if (zerop (logand 1 mode)) ?- ?x)))
338 (defun tar-header-block-summarize (tar-hblock &optional mod-p)
339 "Return a line similar to the output of `tar -vtf'."
340 (let ((name (tar-header-name tar-hblock))
341 (mode (tar-header-mode tar-hblock))
342 (uid (tar-header-uid tar-hblock))
343 (gid (tar-header-gid tar-hblock))
344 (uname (tar-header-uname tar-hblock))
345 (gname (tar-header-gname tar-hblock))
346 (size (tar-header-size tar-hblock))
347 (time (tar-header-date tar-hblock))
348 (ck (tar-header-checksum tar-hblock))
349 (type (tar-header-link-type tar-hblock))
350 (link-name (tar-header-link-name tar-hblock)))
351 (format "%c%c%s%8s/%-8s%7s%s %s%s"
353 (cond ((or (eq type nil) (eq type 0)) ?-)
354 ((eq type 1) ?h) ; link
355 ((eq type 2) ?l) ; symlink
356 ((eq type 3) ?c) ; char special
357 ((eq type 4) ?b) ; block special
358 ((eq type 5) ?d) ; directory
359 ((eq type 6) ?p) ; FIFO/pipe
360 ((eq type 20) ?*) ; directory listing
361 ((eq type 28) ?L) ; next has longname
362 ((eq type 29) ?M) ; multivolume continuation
363 ((eq type 35) ?S) ; sparse
364 ((eq type 38) ?V) ; volume header
367 (tar-grind-file-mode mode)
368 (if (= 0 (length uname)) uid uname)
369 (if (= 0 (length gname)) gid gname)
371 (if tar-mode-show-date (tar-clip-time-string time) "")
373 'mouse-face 'highlight
374 'help-echo "mouse-2: extract this file into a buffer")
375 (if (or (eq type 1) (eq type 2))
376 (concat (if (= type 1) " ==> " " --> ") link-name)
379 (defun tar-untar-buffer ()
380 "Extract all archive members in the tar-file into the current directory."
382 (let ((multibyte enable-multibyte-characters))
386 (set-buffer-multibyte nil)
387 (dolist (descriptor tar-parse-info)
388 (let* ((tokens (tar-desc-tokens descriptor))
389 (name (tar-header-name tokens))
390 (dir (file-name-directory name))
391 (start (+ (tar-desc-data-start descriptor)
392 (- tar-header-offset (point-min))))
393 (end (+ start (tar-header-size tokens))))
394 (unless (file-directory-p name)
395 (message "Extracting %s" name)
396 (if (and dir (not (file-exists-p dir)))
397 (make-directory dir t))
398 (unless (file-directory-p name)
399 (write-region start end name))
400 (set-file-modes name (tar-header-mode tokens))))))
401 (set-buffer-multibyte multibyte))))
403 (defun tar-summarize-buffer ()
404 "Parse the contents of the tar file in the current buffer.
405 Place a dired-like listing on the front;
406 then narrow to it, so that only that listing
407 is visible (and the real data of the buffer is hidden)."
408 (set-buffer-multibyte nil)
412 (make-progress-reporter "Parsing tar file..."
413 (point-min) (max 1 (- (buffer-size) 1024))))
415 (while (and (<= (+ pos 512) (point-max))
416 (not (eq 'empty-tar-block
418 (tar-header-block-tokenize
419 (buffer-substring pos (+ pos 512)))))))
420 (setq pos (+ pos 512))
421 (progress-reporter-update progress-reporter pos)
422 (if (eq (tar-header-link-type tokens) 20)
423 ;; Foo. There's an extra empty block after these.
424 (setq pos (+ pos 512)))
425 (let ((size (tar-header-size tokens)))
427 (error "%s has size %s - corrupted"
428 (tar-header-name tokens) size))
430 ; This is just too slow. Don't really need it anyway....
431 ;(tar-header-block-check-checksum
432 ; hblock (tar-header-block-checksum hblock)
433 ; (tar-header-name tokens))
435 (setq result (cons (make-tar-desc pos tokens) result))
437 (and (null (tar-header-link-type tokens))
440 (+ pos 512 (ash (ash (1- size) -9) 9)) ; this works
441 ;(+ pos (+ size (- 512 (rem (1- size) 512)))) ; this doesn't
443 (make-local-variable 'tar-parse-info)
444 (setq tar-parse-info (nreverse result))
445 ;; A tar file should end with a block or two of nulls,
446 ;; but let's not get a fatal error if it doesn't.
447 (if (eq tokens 'empty-tar-block)
448 (progress-reporter-done progress-reporter)
449 (message "Warning: premature EOF parsing tar file")))
451 (goto-char (point-min))
452 (let ((buffer-read-only nil)
454 ;; Collect summary lines and insert them all at once since tar files
455 ;; can be pretty big.
456 (dolist (tar-desc (reverse tar-parse-info))
458 (cons (tar-header-block-summarize (tar-desc-tokens tar-desc))
461 (let ((total-summaries (apply 'concat summaries)))
462 (insert total-summaries))
463 (make-local-variable 'tar-header-offset)
464 (setq tar-header-offset (point))
465 (narrow-to-region (point-min) tar-header-offset)
466 (set-buffer-modified-p nil))))
468 (defvar tar-mode-map nil "*Local keymap for Tar mode listings.")
472 (setq tar-mode-map (make-keymap))
473 (suppress-keymap tar-mode-map)
474 (define-key tar-mode-map " " 'tar-next-line)
475 (define-key tar-mode-map "C" 'tar-copy)
476 (define-key tar-mode-map "d" 'tar-flag-deleted)
477 (define-key tar-mode-map "\^D" 'tar-flag-deleted)
478 (define-key tar-mode-map "e" 'tar-extract)
479 (define-key tar-mode-map "f" 'tar-extract)
480 (define-key tar-mode-map "\C-m" 'tar-extract)
481 (define-key tar-mode-map [mouse-2] 'tar-mouse-extract)
482 (define-key tar-mode-map "g" 'revert-buffer)
483 (define-key tar-mode-map "h" 'describe-mode)
484 (define-key tar-mode-map "n" 'tar-next-line)
485 (define-key tar-mode-map "\^N" 'tar-next-line)
486 (define-key tar-mode-map [down] 'tar-next-line)
487 (define-key tar-mode-map "o" 'tar-extract-other-window)
488 (define-key tar-mode-map "p" 'tar-previous-line)
489 (define-key tar-mode-map "q" 'quit-window)
490 (define-key tar-mode-map "\^P" 'tar-previous-line)
491 (define-key tar-mode-map [up] 'tar-previous-line)
492 (define-key tar-mode-map "R" 'tar-rename-entry)
493 (define-key tar-mode-map "u" 'tar-unflag)
494 (define-key tar-mode-map "v" 'tar-view)
495 (define-key tar-mode-map "x" 'tar-expunge)
496 (define-key tar-mode-map "\177" 'tar-unflag-backwards)
497 (define-key tar-mode-map "E" 'tar-extract-other-window)
498 (define-key tar-mode-map "M" 'tar-chmod-entry)
499 (define-key tar-mode-map "G" 'tar-chgrp-entry)
500 (define-key tar-mode-map "O" 'tar-chown-entry)
503 ;; Make menu bar items.
505 ;; Get rid of the Edit menu bar item to save space.
506 (define-key tar-mode-map [menu-bar edit] 'undefined)
508 (define-key tar-mode-map [menu-bar immediate]
509 (cons "Immediate" (make-sparse-keymap "Immediate")))
511 (define-key tar-mode-map [menu-bar immediate view]
512 '("View This File" . tar-view))
513 (define-key tar-mode-map [menu-bar immediate display]
514 '("Display in Other Window" . tar-display-other-window))
515 (define-key tar-mode-map [menu-bar immediate find-file-other-window]
516 '("Find in Other Window" . tar-extract-other-window))
517 (define-key tar-mode-map [menu-bar immediate find-file]
518 '("Find This File" . tar-extract))
520 (define-key tar-mode-map [menu-bar mark]
521 (cons "Mark" (make-sparse-keymap "Mark")))
523 (define-key tar-mode-map [menu-bar mark unmark-all]
524 '("Unmark All" . tar-clear-modification-flags))
525 (define-key tar-mode-map [menu-bar mark deletion]
526 '("Flag" . tar-flag-deleted))
527 (define-key tar-mode-map [menu-bar mark unmark]
528 '("Unflag" . tar-unflag))
530 (define-key tar-mode-map [menu-bar operate]
531 (cons "Operate" (make-sparse-keymap "Operate")))
533 (define-key tar-mode-map [menu-bar operate chown]
534 '("Change Owner..." . tar-chown-entry))
535 (define-key tar-mode-map [menu-bar operate chgrp]
536 '("Change Group..." . tar-chgrp-entry))
537 (define-key tar-mode-map [menu-bar operate chmod]
538 '("Change Mode..." . tar-chmod-entry))
539 (define-key tar-mode-map [menu-bar operate rename]
540 '("Rename to..." . tar-rename-entry))
541 (define-key tar-mode-map [menu-bar operate copy]
542 '("Copy to..." . tar-copy))
543 (define-key tar-mode-map [menu-bar operate expunge]
544 '("Expunge Marked Files" . tar-expunge))
546 ;; tar mode is suitable only for specially formatted data.
547 (put 'tar-mode 'mode-class 'special)
548 (put 'tar-subfile-mode 'mode-class 'special)
551 (define-derived-mode tar-mode nil "Tar"
552 "Major mode for viewing a tar file as a dired-like listing of its contents.
553 You can move around using the usual cursor motion commands.
554 Letters no longer insert themselves.
555 Type `e' to pull a file out of the tar file and into its own buffer;
556 or click mouse-2 on the file's line in the Tar mode buffer.
557 Type `c' to copy an entry from the tar file into another file on disk.
559 If you edit a sub-file of this archive (as with the `e' command) and
560 save it with Control-x Control-s, the contents of that buffer will be
561 saved back into the tar-file buffer; in this way you can edit a file
562 inside of a tar archive without extracting it and re-archiving it.
564 See also: variables `tar-update-datestamp' and `tar-anal-blocksize'.
566 ;; this is not interactive because you shouldn't be turning this
567 ;; mode on and off. You can corrupt things that way.
568 ;; rms: with permanent locals, it should now be possible to make this work
569 ;; interactively in some reasonable fashion.
570 (make-local-variable 'tar-header-offset)
571 (make-local-variable 'tar-parse-info)
572 (set (make-local-variable 'require-final-newline) nil) ; binary data, dude...
573 (set (make-local-variable 'revert-buffer-function) 'tar-mode-revert)
574 (set (make-local-variable 'local-enable-local-variables) nil)
575 (set (make-local-variable 'next-line-add-newlines) nil)
576 (set (make-local-variable 'tar-file-name-coding-system)
577 (or file-name-coding-system
578 default-file-name-coding-system
579 locale-coding-system))
580 ;; Prevent loss of data when saving the file.
581 (set (make-local-variable 'file-precious-flag) t)
583 (set (make-local-variable 'write-contents-functions) '(tar-mode-write-file))
584 (buffer-disable-undo)
586 (if (and (boundp 'tar-header-offset) tar-header-offset)
587 (narrow-to-region (point-min) tar-header-offset)
588 (tar-summarize-buffer)
592 (defun tar-subfile-mode (p)
593 "Minor mode for editing an element of a tar-file.
594 This mode arranges for \"saving\" this buffer to write the data
595 into the tar-file buffer that it came from. The changes will actually
596 appear on disk when you save the tar-file's buffer."
598 (or (and (boundp 'tar-superior-buffer) tar-superior-buffer)
599 (error "This buffer is not an element of a tar file"))
600 ;; Don't do this, because it is redundant and wastes mode line space.
601 ;; (or (assq 'tar-subfile-mode minor-mode-alist)
602 ;; (setq minor-mode-alist (append minor-mode-alist
603 ;; (list '(tar-subfile-mode " TarFile")))))
604 (make-local-variable 'tar-subfile-mode)
605 (setq tar-subfile-mode
607 (not tar-subfile-mode)
608 (> (prefix-numeric-value p) 0)))
609 (cond (tar-subfile-mode
610 (add-hook 'write-file-functions 'tar-subfile-save-buffer nil t)
611 ;; turn off auto-save.
613 (setq buffer-auto-save-file-name nil)
614 (run-hooks 'tar-subfile-mode-hook))
616 (remove-hook 'write-file-functions 'tar-subfile-save-buffer t))))
619 ;; Revert the buffer and recompute the dired-like listing.
620 (defun tar-mode-revert (&optional no-auto-save no-confirm)
621 (let ((revert-buffer-function nil)
622 (old-offset tar-header-offset)
624 (setq tar-header-offset nil)
626 (and (revert-buffer t no-confirm)
630 ;; If the revert was canceled,
631 ;; put back the old value of tar-header-offset.
633 (setq tar-header-offset old-offset)))))
636 (defun tar-next-line (arg)
637 "Move cursor vertically down ARG lines and to the start of the filename."
640 (if (eobp) nil (forward-char (if tar-mode-show-date 54 36))))
642 (defun tar-previous-line (arg)
643 "Move cursor vertically up ARG lines and to the start of the filename."
645 (tar-next-line (- arg)))
647 (defun tar-current-descriptor (&optional noerror)
648 "Return the tar-descriptor of the current line, or signals an error."
649 ;; I wish lines had plists, like in ZMACS...
650 (or (nth (count-lines (point-min)
651 (save-excursion (beginning-of-line) (point)))
655 (error "This line does not describe a tar-file entry"))))
657 (defun tar-get-descriptor ()
658 (let* ((descriptor (tar-current-descriptor))
659 (tokens (tar-desc-tokens descriptor))
660 (size (tar-header-size tokens))
661 (link-p (tar-header-link-type tokens)))
663 (error "This is a %s, not a real file"
664 (cond ((eq link-p 5) "directory")
665 ((eq link-p 20) "tar directory header")
666 ((eq link-p 28) "next has longname")
667 ((eq link-p 29) "multivolume-continuation")
668 ((eq link-p 35) "sparse entry")
669 ((eq link-p 38) "volume header")
671 (if (zerop size) (error "This is a zero-length file"))
674 (defun tar-mouse-extract (event)
675 "Extract a file whose tar directory line you click on."
678 (set-buffer (window-buffer (posn-window (event-end event))))
680 (goto-char (posn-point (event-end event)))
681 ;; Just make sure this doesn't get an error.
682 (tar-get-descriptor)))
683 (select-window (posn-window (event-end event)))
684 (goto-char (posn-point (event-end event)))
687 (defun tar-extract (&optional other-window-p)
688 "In Tar mode, extract this entry of the tar file into its own buffer."
690 (let* ((view-p (eq other-window-p 'view))
691 (descriptor (tar-get-descriptor))
692 (tokens (tar-desc-tokens descriptor))
693 (name (tar-header-name tokens))
694 (size (tar-header-size tokens))
695 (start (+ (tar-desc-data-start descriptor)
696 (- tar-header-offset (point-min))))
697 (end (+ start size)))
698 (let* ((tar-buffer (current-buffer))
699 (tarname (buffer-name))
700 (bufname (concat (file-name-nondirectory name)
704 (read-only-p (or buffer-read-only view-p))
705 (new-buffer-file-name (expand-file-name
706 ;; `:' is not allowed on Windows
707 (concat tarname "!" name)))
708 (buffer (get-file-buffer new-buffer-file-name))
713 (setq buffer (generate-new-buffer bufname))
716 (setq undo-list buffer-undo-list
718 (setq bufname (buffer-name buffer))
719 (setq just-created t)
722 (narrow-to-region start end)
724 (setq coding (or coding-system-for-read
725 (and set-auto-coding-function
726 (funcall set-auto-coding-function
727 name (- end start)))))
729 (eq (coding-system-type coding) 'undecided))
730 (setq coding (detect-coding-region start end t)))
731 (if (and default-enable-multibyte-characters
732 (coding-system-get coding :for-unibyte))
735 (set-buffer-multibyte nil)))
737 (decode-coding-region start end coding buffer)
740 (goto-char (point-min))
741 (setq buffer-file-name new-buffer-file-name)
742 (setq buffer-file-truename
743 (abbreviate-file-name buffer-file-name))
744 (set-buffer-file-coding-system coding)
745 ;; Set the default-directory to the dir of the
747 (setq default-directory
749 (set-buffer tar-buffer)
751 (normal-mode) ; pick a mode.
752 (rename-buffer bufname)
753 (make-local-variable 'tar-superior-buffer)
754 (make-local-variable 'tar-superior-descriptor)
755 (setq tar-superior-buffer tar-buffer)
756 (setq tar-superior-descriptor descriptor)
757 (setq buffer-read-only read-only-p)
758 (set-buffer-modified-p nil)
759 (setq buffer-undo-list undo-list)
760 (tar-subfile-mode 1))
761 (set-buffer tar-buffer))
762 (narrow-to-region (point-min) tar-header-offset)
765 (view-buffer buffer (and just-created 'kill-buffer))
766 (if (eq other-window-p 'display)
767 (display-buffer buffer)
769 (switch-to-buffer-other-window buffer)
770 (switch-to-buffer buffer)))))))
773 (defun tar-extract-other-window ()
774 "*In Tar mode, find this entry of the tar file in another window."
778 (defun tar-display-other-window ()
779 "*In Tar mode, display this entry of the tar file in another window."
781 (tar-extract 'display))
784 "*In Tar mode, view the tar file entry on this line."
789 (defun tar-read-file-name (&optional prompt)
790 "Read a file name with this line's entry as the default."
791 (or prompt (setq prompt "Copy to: "))
792 (let* ((default-file (expand-file-name
793 (tar-header-name (tar-desc-tokens
794 (tar-current-descriptor)))))
795 (target (expand-file-name
796 (read-file-name prompt
797 (file-name-directory default-file)
799 (if (or (string= "" (file-name-nondirectory target))
800 (file-directory-p target))
801 (setq target (concat (if (string-match "/$" target)
802 (substring target 0 (1- (match-end 0)))
805 (file-name-nondirectory default-file))))
809 (defun tar-copy (&optional to-file)
810 "*In Tar mode, extract this entry of the tar file into a file on disk.
811 If TO-FILE is not supplied, it is prompted for, defaulting to the name of
812 the current tar-entry."
813 (interactive (list (tar-read-file-name)))
814 (let* ((descriptor (tar-get-descriptor))
815 (tokens (tar-desc-tokens descriptor))
816 (name (tar-header-name tokens))
817 (size (tar-header-size tokens))
818 (start (+ (tar-desc-data-start descriptor)
819 (- tar-header-offset (point-min))))
821 (inhibit-file-name-handlers inhibit-file-name-handlers)
822 (inhibit-file-name-operation inhibit-file-name-operation))
825 ;; Inhibit compressing a subfile again if *both* name and
826 ;; to-file are handled by jka-compr
827 (if (and (eq (find-file-name-handler name 'write-region) 'jka-compr-handler)
828 (eq (find-file-name-handler to-file 'write-region) 'jka-compr-handler))
829 (setq inhibit-file-name-handlers
830 (cons 'jka-compr-handler
831 (and (eq inhibit-file-name-operation 'write-region)
832 inhibit-file-name-handlers))
833 inhibit-file-name-operation 'write-region))
834 (let ((coding-system-for-write 'no-conversion))
835 (write-region start end to-file nil nil nil t)))
836 (message "Copied tar entry %s to %s" name to-file)))
838 (defun tar-flag-deleted (p &optional unflag)
839 "*In Tar mode, mark this sub-file to be deleted from the tar file.
840 With a prefix argument, mark that many files."
843 (dotimes (i (if (< p 0) (- p) p))
844 (if (tar-current-descriptor unflag) ; barf if we're not on an entry-line.
847 (insert (if unflag " " "D"))))
848 (forward-line (if (< p 0) -1 1)))
849 (if (eobp) nil (forward-char 36)))
851 (defun tar-unflag (p)
852 "*In Tar mode, un-mark this sub-file if it is marked to be deleted.
853 With a prefix argument, un-mark that many files forward."
855 (tar-flag-deleted p t))
857 (defun tar-unflag-backwards (p)
858 "*In Tar mode, un-mark this sub-file if it is marked to be deleted.
859 With a prefix argument, un-mark that many files backward."
861 (tar-flag-deleted (- p) t))
864 (defun tar-expunge-internal ()
865 "Expunge the tar-entry specified by the current line."
866 (let* ((descriptor (tar-current-descriptor))
867 (tokens (tar-desc-tokens descriptor))
868 (line (tar-desc-data-start descriptor))
869 (name (tar-header-name tokens))
870 (size (tar-header-size tokens))
871 (link-p (tar-header-link-type tokens))
872 (start (tar-desc-data-start descriptor))
873 (following-descs (cdr (memq descriptor tar-parse-info))))
874 (if link-p (setq size 0)) ; size lies for hard-links.
876 ;; delete the current line...
878 (let ((line-start (point)))
879 (end-of-line) (forward-char)
880 (let ((line-len (- (point) line-start)))
881 (delete-region line-start (point))
883 ;; decrement the header-pointer to be in sync...
884 (setq tar-header-offset (- tar-header-offset line-len))))
886 ;; delete the data pointer...
887 (setq tar-parse-info (delq descriptor tar-parse-info))
889 ;; delete the data from inside the file...
891 (let* ((data-start (+ start tar-header-offset -513))
892 (data-end (+ data-start 512 (ash (ash (+ size 511) -9) 9))))
893 (delete-region data-start data-end)
895 ;; and finally, decrement the start-pointers of all following
896 ;; entries in the archive. This is a pig when deleting a bunch
897 ;; of files at once - we could optimize this to only do the
898 ;; iteration over the files that remain, or only iterate up to
899 ;; the next file to be deleted.
900 (let ((data-length (- data-end data-start)))
901 (dolist (desc following-descs)
902 (tar-setf (tar-desc-data-start desc)
903 (- (tar-desc-data-start desc) data-length))))
905 (narrow-to-region (point-min) tar-header-offset))
908 (defun tar-expunge (&optional noconfirm)
909 "*In Tar mode, delete all the archived files flagged for deletion.
910 This does not modify the disk image; you must save the tar file itself
911 for this to be permanent."
914 (y-or-n-p "Expunge files marked for deletion? "))
917 (goto-char (point-min))
920 (progn (tar-expunge-internal)
923 ;; after doing the deletions, add any padding that may be necessary.
924 (tar-pad-to-blocksize)
925 (narrow-to-region (point-min) tar-header-offset))
927 (message "Nothing to expunge.")
928 (message "%s files expunged. Be sure to save this buffer." n)))))
931 (defun tar-clear-modification-flags ()
932 "Remove the stars at the beginning of each line."
935 (goto-char (point-min))
936 (while (< (point) tar-header-offset)
937 (if (not (eq (following-char) ?\ ))
938 (progn (delete-char 1) (insert " ")))
942 (defun tar-chown-entry (new-uid)
943 "*Change the user-id associated with this entry in the tar file.
944 If this tar file was written by GNU tar, then you will be able to edit
945 the user id as a string; otherwise, you must edit it as a number.
946 You can force editing as a number by calling this with a prefix arg.
947 This does not modify the disk image; you must save the tar file itself
948 for this to be permanent."
950 (let ((tokens (tar-desc-tokens (tar-current-descriptor))))
951 (if (or current-prefix-arg
952 (not (tar-header-magic tokens)))
954 (while (not (numberp (setq n (read-minibuffer
956 (format "%s" (tar-header-uid tokens)))))))
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)))
962 (tar-alter-one-field tar-uname-offset (concat new-uid "\000")))
964 (tar-setf (tar-header-uid (tar-desc-tokens (tar-current-descriptor)))
966 (tar-alter-one-field tar-uid-offset
967 (concat (substring (format "%6o" new-uid) 0 6) "\000 ")))))
970 (defun tar-chgrp-entry (new-gid)
971 "*Change the group-id associated with this entry in the tar file.
972 If this tar file was written by GNU tar, then you will be able to edit
973 the group id as a string; otherwise, you must edit it as a number.
974 You can force editing as a number by calling this with a prefix arg.
975 This does not modify the disk image; you must save the tar file itself
976 for this to be permanent."
978 (let ((tokens (tar-desc-tokens (tar-current-descriptor))))
979 (if (or current-prefix-arg
980 (not (tar-header-magic tokens)))
982 (while (not (numberp (setq n (read-minibuffer
984 (format "%s" (tar-header-gid tokens)))))))
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)))
990 (tar-alter-one-field tar-gname-offset
991 (concat new-gid "\000")))
993 (tar-setf (tar-header-gid (tar-desc-tokens (tar-current-descriptor)))
995 (tar-alter-one-field tar-gid-offset
996 (concat (substring (format "%6o" new-gid) 0 6) "\000 ")))))
998 (defun tar-rename-entry (new-name)
999 "*Change the name associated with this entry in the tar file.
1000 This does not modify the disk image; you must save the tar file itself
1001 for this to be permanent."
1003 (list (read-string "New name: "
1004 (tar-header-name (tar-desc-tokens (tar-current-descriptor))))))
1005 (if (string= "" new-name) (error "zero length name"))
1006 (let ((encoded-new-name (encode-coding-string new-name
1007 tar-file-name-coding-system)))
1008 (if (> (length encoded-new-name) 98) (error "name too long"))
1009 (tar-setf (tar-header-name (tar-desc-tokens (tar-current-descriptor)))
1011 (tar-alter-one-field 0
1012 (substring (concat encoded-new-name (make-string 99 0)) 0 99))))
1015 (defun tar-chmod-entry (new-mode)
1016 "*Change the protection bits associated with this entry in the tar file.
1017 This does not modify the disk image; you must save the tar file itself
1018 for this to be permanent."
1019 (interactive (list (tar-parse-octal-integer-safe
1020 (read-string "New protection (octal): "))))
1021 (tar-setf (tar-header-mode (tar-desc-tokens (tar-current-descriptor)))
1023 (tar-alter-one-field tar-mode-offset
1024 (concat (substring (format "%6o" new-mode) 0 6) "\000 ")))
1027 (defun tar-alter-one-field (data-position new-data-string)
1028 (let* ((descriptor (tar-current-descriptor))
1029 (tokens (tar-desc-tokens descriptor)))
1033 ;; update the header-line.
1037 (delete-region p (point))
1038 (insert (tar-header-block-summarize tokens) "\n")
1039 (setq tar-header-offset (point-max)))
1042 (let* ((start (+ (tar-desc-data-start descriptor) tar-header-offset -513)))
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))) ; <--
1048 ;; As new-data-string is unibyte, just inserting it will
1049 ;; make eight-bit chars to the corresponding multibyte
1050 ;; chars. This avoid that conversion, i.e., eight-bit
1051 ;; chars are converted to multibyte form of eight-bit
1053 (insert (string-to-multibyte new-data-string))
1055 ;; compute a new checksum and insert it.
1056 (let ((chk (tar-header-block-checksum
1057 (buffer-substring start (+ start 512)))))
1058 (goto-char (+ start tar-chk-offset))
1059 (delete-region (point) (+ (point) 8))
1060 (insert (format "%6o" chk))
1063 (tar-setf (tar-header-checksum tokens) chk)
1065 ;; ok, make sure we didn't botch it.
1066 (tar-header-block-check-checksum
1067 (buffer-substring start (+ start 512))
1068 chk (tar-header-name tokens))
1070 (narrow-to-region (point-min) tar-header-offset)
1071 (tar-next-line 0))))
1074 (defun tar-octal-time (timeval)
1075 ;; Format a timestamp as 11 octal digits. Ghod, I hope this works...
1076 (let ((hibits (car timeval)) (lobits (car (cdr timeval))))
1077 (format "%05o%01o%05o"
1079 (logior (lsh (logand 3 hibits) 1)
1080 (if (> (logand lobits 32768) 0) 1 0))
1081 (logand 32767 lobits)
1084 (defun tar-subfile-save-buffer ()
1085 "In tar subfile mode, save this buffer into its parent tar-file buffer.
1086 This doesn't write anything to disk; you must save the parent tar-file buffer
1087 to make your changes permanent."
1089 (if (not (and (boundp 'tar-superior-buffer) tar-superior-buffer))
1090 (error "This buffer has no superior tar file buffer"))
1091 (if (not (and (boundp 'tar-superior-descriptor) tar-superior-descriptor))
1092 (error "This buffer doesn't have an index into its superior tar file!"))
1094 (let ((subfile (current-buffer))
1095 (coding buffer-file-coding-system)
1096 (descriptor tar-superior-descriptor)
1098 (set-buffer tar-superior-buffer)
1099 (let* ((tokens (tar-desc-tokens descriptor))
1100 (start (tar-desc-data-start descriptor))
1101 (name (tar-header-name tokens))
1102 (size (tar-header-size tokens))
1103 (size-pad (ash (ash (+ size 511) -9) 9))
1104 (head (memq descriptor tar-parse-info))
1105 (following-descs (cdr head)))
1107 (error "Can't find this tar file entry in its parent tar file!"))
1110 ;; delete the old data...
1111 (let* ((data-start (+ start (- tar-header-offset (point-min))))
1112 (data-end (+ data-start (ash (ash (+ size 511) -9) 9))))
1113 (narrow-to-region data-start data-end)
1114 (delete-region (point-min) (point-max))
1115 ;; insert the new data...
1116 (goto-char data-start)
1118 (set-buffer subfile)
1121 (encode-coding-region 1 (point-max) coding tar-superior-buffer)))
1122 (setq subfile-size (- (point-max) (point-min)))
1124 ;; pad the new data out to a multiple of 512...
1125 (let ((subfile-size-pad (ash (ash (+ subfile-size 511) -9) 9)))
1126 (goto-char (point-max))
1127 (insert (make-string (- subfile-size-pad subfile-size) 0))
1129 ;; update the data pointer of this and all following files...
1130 (tar-setf (tar-header-size tokens) subfile-size)
1131 (let ((difference (- subfile-size-pad size-pad)))
1132 (dolist (desc following-descs)
1133 (tar-setf (tar-desc-data-start desc)
1134 (+ (tar-desc-data-start desc) difference))))
1136 ;; Update the size field in the header block.
1138 (let ((header-start (- data-start 512)))
1139 (goto-char (+ header-start tar-size-offset))
1140 (delete-region (point) (+ (point) 12))
1141 (insert (format "%11o" subfile-size))
1144 ;; Maybe update the datestamp.
1145 (if (not tar-update-datestamp)
1147 (goto-char (+ header-start tar-time-offset))
1148 (delete-region (point) (+ (point) 12))
1149 (insert (tar-octal-time (current-time)))
1152 ;; compute a new checksum and insert it.
1153 (let ((chk (tar-header-block-checksum
1154 (buffer-substring header-start data-start))))
1155 (goto-char (+ header-start tar-chk-offset))
1156 (delete-region (point) (+ (point) 8))
1157 (insert (format "%6o" chk))
1160 (tar-setf (tar-header-checksum tokens) chk)))
1162 ;; alter the descriptor-line...
1164 (let ((position (- (length tar-parse-info) (length head))))
1165 (goto-char (point-min))
1166 (next-line position)
1170 (m (set-marker (make-marker) tar-header-offset)))
1172 (setq after (point))
1173 ;; Insert the new text after the old, before deleting,
1174 ;; to preserve the window start.
1175 (let ((line (tar-header-block-summarize tokens t)))
1176 (insert-before-markers line "\n"))
1177 (delete-region p after)
1178 (setq tar-header-offset (marker-position m)))
1180 ;; after doing the insertion, add any final padding that may be necessary.
1181 (tar-pad-to-blocksize))
1182 (narrow-to-region (point-min) tar-header-offset)))
1183 (set-buffer-modified-p t) ; mark the tar file as modified
1185 (set-buffer subfile)
1186 (set-buffer-modified-p nil) ; mark the tar subfile as unmodified
1187 (message "Saved into tar-buffer `%s'. Be sure to save that buffer!"
1188 (buffer-name tar-superior-buffer))
1189 ;; Prevent basic-save-buffer from changing our coding-system.
1190 (setq last-coding-system-used buffer-file-coding-system)
1191 ;; Prevent ordinary saving from happening.
1195 ;; When this function is called, it is sure that the buffer is unibyte.
1196 (defun tar-pad-to-blocksize ()
1197 "If we are being anal about tar file blocksizes, fix up the current buffer.
1198 Leaves the region wide."
1199 (if (null tar-anal-blocksize)
1202 (let* ((last-desc (nth (1- (length tar-parse-info)) tar-parse-info))
1203 (start (tar-desc-data-start last-desc))
1204 (tokens (tar-desc-tokens last-desc))
1205 (link-p (tar-header-link-type tokens))
1206 (size (if link-p 0 (tar-header-size tokens)))
1207 (data-end (+ start size))
1208 (bbytes (ash tar-anal-blocksize 9))
1209 (pad-to (+ bbytes (* bbytes (/ (1- data-end) bbytes))))
1210 (inhibit-read-only t) ; ##
1212 ;; If the padding after the last data is too long, delete some;
1213 ;; else insert some until we are padded out to the right number of blocks.
1215 (goto-char (+ (or tar-header-offset 0) data-end))
1216 (if (> (1+ (buffer-size)) (+ (or tar-header-offset 0) pad-to))
1217 (delete-region (+ (or tar-header-offset 0) pad-to) (1+ (buffer-size)))
1218 (insert (make-string (- (+ (or tar-header-offset 0) pad-to)
1224 ;; Used in write-file-hook to write tar-files out correctly.
1225 (defun tar-mode-write-file ()
1229 ;; Doing this here confuses things - the region gets left too wide!
1230 ;; I suppose this is run in a context where changing the buffer is bad.
1231 ;; (tar-pad-to-blocksize)
1232 ;; tar-header-offset turns out to be null for files fetched with W3,
1234 (let ((coding-system-for-write 'no-conversion))
1235 (write-region (or tar-header-offset
1238 buffer-file-name nil t))
1239 (tar-clear-modification-flags)
1240 (set-buffer-modified-p nil))
1241 (narrow-to-region (point-min) tar-header-offset))
1242 ;; Return t because we've written the file.
1247 ;;; arch-tag: 8a585a4a-340e-42c2-89e7-d3b1013a4b78
1248 ;;; tar-mode.el ends here