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