]> code.delx.au - gnu-emacs/blob - lisp/tar-mode.el
CEDET (development tools) package merged.
[gnu-emacs] / lisp / tar-mode.el
1 ;;; tar-mode.el --- simple editing of tar files from GNU emacs
2
3 ;; Copyright (C) 1990, 1991, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
5 ;; Free Software Foundation, Inc.
6
7 ;; Author: Jamie Zawinski <jwz@lucid.com>
8 ;; Maintainer: FSF
9 ;; Created: 04 Apr 1990
10 ;; Keywords: unix
11
12 ;; This file is part of GNU Emacs.
13
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
18
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
23
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26
27 ;;; Commentary:
28
29 ;; This package attempts to make dealing with Unix 'tar' archives easier.
30 ;; When this code is loaded, visiting a file whose name ends in '.tar' will
31 ;; cause the contents of that archive file to be displayed in a Dired-like
32 ;; listing. It is then possible to use the customary Dired keybindings to
33 ;; extract sub-files from that archive, either by reading them into their own
34 ;; editor buffers, or by copying them directly to arbitrary files on disk.
35 ;; It is also possible to delete sub-files from within the tar file and write
36 ;; the modified archive back to disk, or to edit sub-files within the archive
37 ;; and re-insert the modified files into the archive. See the documentation
38 ;; string of tar-mode for more info.
39
40 ;; This code now understands the extra fields that GNU tar adds to tar files.
41
42 ;; This interacts correctly with "uncompress.el" in the Emacs library,
43 ;; which you get with
44 ;;
45 ;; (autoload 'uncompress-while-visiting "uncompress")
46 ;; (setq auto-mode-alist (cons '("\\.Z$" . uncompress-while-visiting)
47 ;; auto-mode-alist))
48 ;;
49 ;; Do not attempt to use tar-mode.el with crypt.el, you will lose.
50
51 ;; *************** TO DO ***************
52 ;;
53 ;; o chmod should understand "a+x,og-w".
54 ;;
55 ;; o It's not possible to add a NEW file to a tar archive; not that
56 ;; important, but still...
57 ;;
58 ;; o The code is less efficient that it could be - in a lot of places, I
59 ;; pull a 512-character string out of the buffer and parse it, when I could
60 ;; be parsing it in place, not garbaging a string. Should redo that.
61 ;;
62 ;; o I'd like a command that searches for a string/regexp in every subfile
63 ;; of an archive, where <esc> would leave you in a subfile-edit buffer.
64 ;; (Like the Meta-R command of the Zmacs mail reader.)
65 ;;
66 ;; o Sometimes (but not always) reverting the tar-file buffer does not
67 ;; re-grind the listing, and you are staring at the binary tar data.
68 ;; Typing 'g' again immediately after that will always revert and re-grind
69 ;; it, though. I have no idea why this happens.
70 ;;
71 ;; o Tar-mode interacts poorly with crypt.el and zcat.el because the tar
72 ;; write-file-hook actually writes the file. Instead it should remove the
73 ;; header (and conspire to put it back afterwards) so that other write-file
74 ;; hooks which frob the buffer have a chance to do their dirty work. There
75 ;; might be a problem if the tar write-file-hook does not come *first* on
76 ;; the list.
77 ;;
78 ;; o Block files, sparse files, continuation files, and the various header
79 ;; types aren't editable. Actually I don't know that they work at all.
80
81 ;; Rationale:
82
83 ;; Why does tar-mode edit the file itself instead of using tar?
84
85 ;; That means that you can edit tar files which you don't have room for
86 ;; on your local disk.
87
88 ;; I don't know about recent features in gnu tar, but old versions of tar
89 ;; can't replace a file in the middle of a tar file with a new version.
90 ;; Tar-mode can. I don't think tar can do things like chmod the subfiles.
91 ;; An implementation which involved unpacking and repacking the file into
92 ;; some scratch directory would be very wasteful, and wouldn't be able to
93 ;; preserve the file owners.
94
95 ;;; Bugs:
96
97 ;; - Rename on ././@LongLink files
98 ;; - Revert confirmation displays the raw data temporarily.
99
100 ;;; Code:
101
102 (eval-when-compile (require 'cl))
103
104 (defgroup tar nil
105 "Simple editing of tar files."
106 :prefix "tar-"
107 :group 'data)
108
109 (defcustom tar-anal-blocksize 20
110 "The blocksize of tar files written by Emacs, or nil, meaning don't care.
111 The blocksize of a tar file is not really the size of the blocks; rather, it is
112 the number of blocks written with one system call. When tarring to a tape,
113 this is the size of the *tape* blocks, but when writing to a file, it doesn't
114 matter much. The only noticeable difference is that if a tar file does not
115 have a blocksize of 20, tar will tell you that; all this really controls is
116 how many null padding bytes go on the end of the tar file."
117 :type '(choice integer (const nil))
118 :group 'tar)
119
120 (defcustom tar-update-datestamp nil
121 "Non-nil means Tar mode should play fast and loose with sub-file datestamps.
122 If this is true, then editing and saving a tar file entry back into its
123 tar file will update its datestamp. If false, the datestamp is unchanged.
124 You may or may not want this - it is good in that you can tell when a file
125 in a tar archive has been changed, but it is bad for the same reason that
126 editing a file in the tar archive at all is bad - the changed version of
127 the file never exists on disk."
128 :type 'boolean
129 :group 'tar)
130
131 (defcustom tar-mode-show-date nil
132 "Non-nil means Tar mode should show the date/time of each subfile.
133 This information is useful, but it takes screen space away from file names."
134 :type 'boolean
135 :group 'tar)
136
137 (defvar tar-parse-info nil)
138 (defvar tar-superior-buffer nil)
139 (defvar tar-superior-descriptor nil)
140 (defvar tar-subfile-mode nil)
141 (defvar tar-file-name-coding-system nil)
142
143 (put 'tar-superior-buffer 'permanent-local t)
144 (put 'tar-superior-descriptor 'permanent-local t)
145
146 ;; The Tar data is made up of bytes and better manipulated as bytes
147 ;; and can be very large, so insert/delete can be costly. The summary we
148 ;; want to display may contain non-ascci chars, of course, so we'd like it
149 ;; to be multibyte. We used to keep both in the same buffer and switch
150 ;; from/to uni/multibyte. But this had several downsides:
151 ;; - set-buffer-multibyte has an O(N^2) worst case that tends to be triggered
152 ;; here, so it gets atrociously slow on large Tar files.
153 ;; - need to widen/narrow the buffer to show/hide the raw data, and need to
154 ;; maintain a tar-header-offset that keeps track of the boundary between
155 ;; the two.
156 ;; - can't use markers because they're not preserved by set-buffer-multibyte.
157 ;; So instead, we now keep the two pieces of data in separate buffers, and
158 ;; use the new buffer-swap-text primitive when we need to change which data
159 ;; is associated with "the" buffer.
160 (defvar tar-data-buffer nil "Buffer that holds the actual raw tar bytes.")
161 (make-variable-buffer-local 'tar-data-buffer)
162
163 (defvar tar-data-swapped nil
164 "If non-nil, `tar-data-buffer' indeed holds raw tar bytes.")
165 (make-variable-buffer-local 'tar-data-swapped)
166
167 (defun tar-data-swapped-p ()
168 "Return non-nil if the tar-data is in `tar-data-buffer'."
169 (and (buffer-live-p tar-data-buffer)
170 ;; Sanity check to try and make sure tar-data-swapped tracks the swap
171 ;; state correctly: the raw data is expected to be always larger than
172 ;; the summary.
173 (progn
174 (assert (eq tar-data-swapped
175 (> (buffer-size tar-data-buffer) (buffer-size))))
176 tar-data-swapped)))
177
178 (defun tar-swap-data ()
179 "Swap buffer contents between current buffer and `tar-data-buffer'.
180 Preserve the modified states of the buffers and set `buffer-swapped-with'."
181 (let ((data-buffer-modified-p (buffer-modified-p tar-data-buffer))
182 (current-buffer-modified-p (buffer-modified-p)))
183 (buffer-swap-text tar-data-buffer)
184 (setq tar-data-swapped (not tar-data-swapped))
185 (restore-buffer-modified-p data-buffer-modified-p)
186 (with-current-buffer tar-data-buffer
187 (restore-buffer-modified-p current-buffer-modified-p))))
188 \f
189 ;;; down to business.
190
191 (defstruct (tar-header
192 (:constructor nil)
193 (:type vector)
194 :named
195 (:constructor
196 make-tar-header (data-start name mode uid gid size date checksum
197 link-type link-name magic uname gname dmaj dmin)))
198 data-start name mode uid gid size date checksum link-type link-name
199 magic uname gname dmaj dmin
200 ;; Start of the header can be nil (meaning it's 512 bytes before data-start)
201 ;; or a marker (in case the header uses LongLink thingies).
202 header-start)
203
204 (defconst tar-name-offset 0)
205 (defconst tar-mode-offset (+ tar-name-offset 100))
206 (defconst tar-uid-offset (+ tar-mode-offset 8))
207 (defconst tar-gid-offset (+ tar-uid-offset 8))
208 (defconst tar-size-offset (+ tar-gid-offset 8))
209 (defconst tar-time-offset (+ tar-size-offset 12))
210 (defconst tar-chk-offset (+ tar-time-offset 12))
211 (defconst tar-linkp-offset (+ tar-chk-offset 8))
212 (defconst tar-link-offset (+ tar-linkp-offset 1))
213 ;;; GNU-tar specific slots.
214 (defconst tar-magic-offset (+ tar-link-offset 100))
215 (defconst tar-uname-offset (+ tar-magic-offset 8))
216 (defconst tar-gname-offset (+ tar-uname-offset 32))
217 (defconst tar-dmaj-offset (+ tar-gname-offset 32))
218 (defconst tar-dmin-offset (+ tar-dmaj-offset 8))
219 (defconst tar-prefix-offset (+ tar-dmin-offset 8))
220 (defconst tar-end-offset (+ tar-prefix-offset 155))
221
222 (defun tar-roundup-512 (s)
223 "Round S up to the next multiple of 512."
224 (ash (ash (+ s 511) -9) 9))
225
226 (defun tar-header-block-tokenize (pos coding)
227 "Return a `tar-header' structure.
228 This is a list of name, mode, uid, gid, size,
229 write-date, checksum, link-type, and link-name."
230 (if (> (+ pos 512) (point-max)) (error "Malformed Tar header"))
231 (assert (zerop (mod (- pos (point-min)) 512)))
232 (assert (not enable-multibyte-characters))
233 (let ((string (buffer-substring pos (setq pos (+ pos 512)))))
234 (when ;(some 'plusp string) ; <-- oops, massive cycle hog!
235 (or (not (= 0 (aref string 0))) ; This will do.
236 (not (= 0 (aref string 101))))
237 (let* ((name-end tar-mode-offset)
238 (link-end (1- tar-magic-offset))
239 (uname-end (1- tar-gname-offset))
240 (gname-end (1- tar-dmaj-offset))
241 (link-p (aref string tar-linkp-offset))
242 (magic-str (substring string tar-magic-offset
243 ;; The magic string is actually 6bytes
244 ;; of magic string plus 2bytes of version
245 ;; which we here ignore.
246 (- tar-uname-offset 2)))
247 ;; The magic string is "ustar\0" for POSIX format, and
248 ;; "ustar " for GNU Tar's format.
249 (uname-valid-p (car (member magic-str '("ustar " "ustar\0"))))
250 name linkname
251 (nulsexp "[^\000]*\000"))
252 (when (string-match nulsexp string tar-name-offset)
253 (setq name-end (min name-end (1- (match-end 0)))))
254 (when (string-match nulsexp string tar-link-offset)
255 (setq link-end (min link-end (1- (match-end 0)))))
256 (when (string-match nulsexp string tar-uname-offset)
257 (setq uname-end (min uname-end (1- (match-end 0)))))
258 (when (string-match nulsexp string tar-gname-offset)
259 (setq gname-end (min gname-end (1- (match-end 0)))))
260 (setq name (substring string tar-name-offset name-end)
261 link-p (if (or (= link-p 0) (= link-p ?0))
262 nil
263 (- link-p ?0)))
264 (setq linkname (substring string tar-link-offset link-end))
265 (when (and (equal uname-valid-p "ustar\0")
266 (string-match nulsexp string tar-prefix-offset)
267 (> (match-end 0) (1+ tar-prefix-offset)))
268 (setq name (concat (substring string tar-prefix-offset
269 (1- (match-end 0)))
270 "/" name)))
271 (if (default-value 'enable-multibyte-characters)
272 (setq name
273 (decode-coding-string name coding)
274 linkname
275 (decode-coding-string linkname coding)))
276 (if (and (null link-p) (string-match "/\\'" name))
277 (setq link-p 5)) ; directory
278
279 (if (and (equal name "././@LongLink")
280 ;; Supposedly @LongLink is only used for GNUTAR
281 ;; format (i.e. "ustar ") but some POSIX Tar files
282 ;; (with "ustar\0") have been seen using it as well.
283 (member magic-str '("ustar " "ustar\0")))
284 ;; This is a GNU Tar long-file-name header.
285 (let* ((size (tar-parse-octal-integer
286 string tar-size-offset tar-time-offset))
287 ;; -1 so as to strip the terminating 0 byte.
288 (name (buffer-substring pos (+ pos size -1)))
289 (descriptor (tar-header-block-tokenize
290 (+ pos (tar-roundup-512 size))
291 coding)))
292 (cond
293 ((eq link-p (- ?L ?0)) ;GNUTYPE_LONGNAME.
294 (setf (tar-header-name descriptor) name))
295 ((eq link-p (- ?K ?0)) ;GNUTYPE_LONGLINK.
296 (setf (tar-header-link-name descriptor) name))
297 (t
298 (message "Unrecognized GNU Tar @LongLink format")))
299 (setf (tar-header-header-start descriptor)
300 (copy-marker (- pos 512) t))
301 descriptor)
302
303 (make-tar-header
304 (copy-marker pos nil)
305 name
306 (tar-parse-octal-integer string tar-mode-offset tar-uid-offset)
307 (tar-parse-octal-integer string tar-uid-offset tar-gid-offset)
308 (tar-parse-octal-integer string tar-gid-offset tar-size-offset)
309 (tar-parse-octal-integer string tar-size-offset tar-time-offset)
310 (tar-parse-octal-long-integer string tar-time-offset tar-chk-offset)
311 (tar-parse-octal-integer string tar-chk-offset tar-linkp-offset)
312 link-p
313 linkname
314 uname-valid-p
315 (and uname-valid-p (substring string tar-uname-offset uname-end))
316 (and uname-valid-p (substring string tar-gname-offset gname-end))
317 (tar-parse-octal-integer string tar-dmaj-offset tar-dmin-offset)
318 (tar-parse-octal-integer string tar-dmin-offset tar-prefix-offset)
319 ))))))
320
321 ;; Pseudo-field.
322 (defun tar-header-data-end (descriptor)
323 (let* ((data-start (tar-header-data-start descriptor))
324 (link-type (tar-header-link-type descriptor))
325 (size (tar-header-size descriptor))
326 (fudge (cond
327 ;; Foo. There's an extra empty block after these.
328 ((memq link-type '(20 55)) 512)
329 (t 0))))
330 (+ data-start fudge
331 (if (and (null link-type) (> size 0))
332 (tar-roundup-512 size)
333 0))))
334
335 (defun tar-parse-octal-integer (string &optional start end)
336 (if (null start) (setq start 0))
337 (if (null end) (setq end (length string)))
338 (if (= (aref string start) 0)
339 0
340 (let ((n 0))
341 (while (< start end)
342 (setq n (if (< (aref string start) ?0) n
343 (+ (* n 8) (- (aref string start) ?0)))
344 start (1+ start)))
345 n)))
346
347 (defun tar-parse-octal-long-integer (string &optional start end)
348 (if (null start) (setq start 0))
349 (if (null end) (setq end (length string)))
350 (if (= (aref string start) 0)
351 (list 0 0)
352 (let ((lo 0)
353 (hi 0))
354 (while (< start end)
355 (if (>= (aref string start) ?0)
356 (setq lo (+ (* lo 8) (- (aref string start) ?0))
357 hi (+ (* hi 8) (ash lo -16))
358 lo (logand lo 65535)))
359 (setq start (1+ start)))
360 (list hi lo))))
361
362 (defun tar-parse-octal-integer-safe (string)
363 (if (zerop (length string)) (error "empty string"))
364 (mapc (lambda (c)
365 (if (or (< c ?0) (> c ?7))
366 (error "`%c' is not an octal digit" c)))
367 string)
368 (tar-parse-octal-integer string))
369
370
371 (defun tar-header-block-checksum (string)
372 "Compute and return a tar-acceptable checksum for this block."
373 (assert (not (multibyte-string-p string)))
374 (let* ((chk-field-start tar-chk-offset)
375 (chk-field-end (+ chk-field-start 8))
376 (sum 0)
377 (i 0))
378 ;; Add up all of the characters except the ones in the checksum field.
379 ;; Add that field as if it were filled with spaces.
380 (while (< i chk-field-start)
381 (setq sum (+ sum (aref string i))
382 i (1+ i)))
383 (setq i chk-field-end)
384 (while (< i 512)
385 (setq sum (+ sum (aref string i))
386 i (1+ i)))
387 (+ sum (* 32 8))))
388
389 (defun tar-header-block-check-checksum (hblock desired-checksum file-name)
390 "Beep and print a warning if the checksum doesn't match."
391 (if (not (= desired-checksum (tar-header-block-checksum hblock)))
392 (progn (beep) (message "Invalid checksum for file %s!" file-name))))
393
394 (defun tar-clip-time-string (time)
395 (let ((str (current-time-string time)))
396 (concat " " (substring str 4 16) (substring str 19 24))))
397
398 (defun tar-grind-file-mode (mode)
399 "Construct a `-rw--r--r--' string indicating MODE.
400 MODE should be an integer which is a file mode value."
401 (string
402 (if (zerop (logand 256 mode)) ?- ?r)
403 (if (zerop (logand 128 mode)) ?- ?w)
404 (if (zerop (logand 1024 mode)) (if (zerop (logand 64 mode)) ?- ?x) ?s)
405 (if (zerop (logand 32 mode)) ?- ?r)
406 (if (zerop (logand 16 mode)) ?- ?w)
407 (if (zerop (logand 2048 mode)) (if (zerop (logand 8 mode)) ?- ?x) ?s)
408 (if (zerop (logand 4 mode)) ?- ?r)
409 (if (zerop (logand 2 mode)) ?- ?w)
410 (if (zerop (logand 1 mode)) ?- ?x)))
411
412 (defun tar-header-block-summarize (tar-hblock &optional mod-p)
413 "Return a line similar to the output of `tar -vtf'."
414 (let ((name (tar-header-name tar-hblock))
415 (mode (tar-header-mode tar-hblock))
416 (uid (tar-header-uid tar-hblock))
417 (gid (tar-header-gid tar-hblock))
418 (uname (tar-header-uname tar-hblock))
419 (gname (tar-header-gname tar-hblock))
420 (size (tar-header-size tar-hblock))
421 (time (tar-header-date tar-hblock))
422 ;; (ck (tar-header-checksum tar-hblock))
423 (type (tar-header-link-type tar-hblock))
424 (link-name (tar-header-link-name tar-hblock)))
425 (format "%c%c%s %7s/%-7s %7s%s %s%s"
426 (if mod-p ?* ? )
427 (cond ((or (eq type nil) (eq type 0)) ?-)
428 ((eq type 1) ?h) ; link
429 ((eq type 2) ?l) ; symlink
430 ((eq type 3) ?c) ; char special
431 ((eq type 4) ?b) ; block special
432 ((eq type 5) ?d) ; directory
433 ((eq type 6) ?p) ; FIFO/pipe
434 ((eq type 20) ?*) ; directory listing
435 ((eq type 28) ?L) ; next has longname
436 ((eq type 29) ?M) ; multivolume continuation
437 ((eq type 35) ?S) ; sparse
438 ((eq type 38) ?V) ; volume header
439 ((eq type 55) ?H) ; extended pax header
440 (t ?\s)
441 )
442 (tar-grind-file-mode mode)
443 (if (= 0 (length uname)) uid uname)
444 (if (= 0 (length gname)) gid gname)
445 size
446 (if tar-mode-show-date (tar-clip-time-string time) "")
447 (propertize name
448 'mouse-face 'highlight
449 'help-echo "mouse-2: extract this file into a buffer")
450 (if (or (eq type 1) (eq type 2))
451 (concat (if (= type 1) " ==> " " --> ") link-name)
452 ""))))
453
454 (defun tar-untar-buffer ()
455 "Extract all archive members in the tar-file into the current directory."
456 (interactive)
457 ;; FIXME: make it work even if we're not in tar-mode.
458 (let ((descriptors tar-parse-info)) ;Read the var in its buffer.
459 (with-current-buffer
460 (if (tar-data-swapped-p) tar-data-buffer (current-buffer))
461 (set-buffer-multibyte nil) ;Hopefully, a no-op.
462 (dolist (descriptor descriptors)
463 (let* ((name (tar-header-name descriptor))
464 (dir (if (eq (tar-header-link-type descriptor) 5)
465 name
466 (file-name-directory name)))
467 (start (tar-header-data-start descriptor))
468 (end (+ start (tar-header-size descriptor))))
469 (unless (file-directory-p name)
470 (message "Extracting %s" name)
471 (if (and dir (not (file-exists-p dir)))
472 (make-directory dir t))
473 (unless (file-directory-p name)
474 (write-region start end name))
475 (set-file-modes name (tar-header-mode descriptor))))))))
476
477 (defun tar-summarize-buffer ()
478 "Parse the contents of the tar file in the current buffer."
479 (assert (tar-data-swapped-p))
480 (let* ((modified (buffer-modified-p))
481 (result '())
482 (pos (point-min))
483 (coding tar-file-name-coding-system)
484 (progress-reporter
485 (with-current-buffer tar-data-buffer
486 (make-progress-reporter "Parsing tar file..."
487 (point-min) (point-max))))
488 descriptor)
489 (with-current-buffer tar-data-buffer
490 (while (and (< pos (point-max))
491 (setq descriptor (tar-header-block-tokenize pos coding)))
492 (let ((size (tar-header-size descriptor)))
493 (if (< size 0)
494 (error "%s has size %s - corrupted"
495 (tar-header-name descriptor) size)))
496 ;;
497 ;; This is just too slow. Don't really need it anyway....
498 ;;(tar-header-block-check-checksum
499 ;; hblock (tar-header-block-checksum hblock)
500 ;; (tar-header-name descriptor))
501
502 (push descriptor result)
503 (setq pos (tar-header-data-end descriptor))
504 (progress-reporter-update progress-reporter pos)))
505
506 (set (make-local-variable 'tar-parse-info) (nreverse result))
507 ;; A tar file should end with a block or two of nulls,
508 ;; but let's not get a fatal error if it doesn't.
509 (if (null descriptor)
510 (progress-reporter-done progress-reporter)
511 (message "Warning: premature EOF parsing tar file"))
512 (goto-char (point-min))
513 (let ((inhibit-read-only t)
514 (total-summaries
515 (mapconcat 'tar-header-block-summarize tar-parse-info "\n")))
516 (insert total-summaries "\n"))
517 (goto-char (point-min))
518 (restore-buffer-modified-p modified)))
519 \f
520 (defvar tar-mode-map
521 (let ((map (make-keymap)))
522 (suppress-keymap map)
523 (define-key map " " 'tar-next-line)
524 (define-key map "C" 'tar-copy)
525 (define-key map "d" 'tar-flag-deleted)
526 (define-key map "\^D" 'tar-flag-deleted)
527 (define-key map "e" 'tar-extract)
528 (define-key map "f" 'tar-extract)
529 (define-key map "\C-m" 'tar-extract)
530 (define-key map [mouse-2] 'tar-mouse-extract)
531 (define-key map "g" 'revert-buffer)
532 (define-key map "h" 'describe-mode)
533 (define-key map "n" 'tar-next-line)
534 (define-key map "\^N" 'tar-next-line)
535 (define-key map [down] 'tar-next-line)
536 (define-key map "o" 'tar-extract-other-window)
537 (define-key map "p" 'tar-previous-line)
538 (define-key map "q" 'quit-window)
539 (define-key map "\^P" 'tar-previous-line)
540 (define-key map [up] 'tar-previous-line)
541 (define-key map "R" 'tar-rename-entry)
542 (define-key map "u" 'tar-unflag)
543 (define-key map "v" 'tar-view)
544 (define-key map "x" 'tar-expunge)
545 (define-key map "\177" 'tar-unflag-backwards)
546 (define-key map "E" 'tar-extract-other-window)
547 (define-key map "M" 'tar-chmod-entry)
548 (define-key map "G" 'tar-chgrp-entry)
549 (define-key map "O" 'tar-chown-entry)
550 ;; Let mouse-1 follow the link.
551 (define-key map [follow-link] 'mouse-face)
552
553 ;; Make menu bar items.
554
555 ;; Get rid of the Edit menu bar item to save space.
556 (define-key map [menu-bar edit] 'undefined)
557
558 (define-key map [menu-bar immediate]
559 (cons "Immediate" (make-sparse-keymap "Immediate")))
560
561 (define-key map [menu-bar immediate view]
562 '("View This File" . tar-view))
563 (define-key map [menu-bar immediate display]
564 '("Display in Other Window" . tar-display-other-window))
565 (define-key map [menu-bar immediate find-file-other-window]
566 '("Find in Other Window" . tar-extract-other-window))
567 (define-key map [menu-bar immediate find-file]
568 '("Find This File" . tar-extract))
569
570 (define-key map [menu-bar mark]
571 (cons "Mark" (make-sparse-keymap "Mark")))
572
573 (define-key map [menu-bar mark unmark-all]
574 '("Unmark All" . tar-clear-modification-flags))
575 (define-key map [menu-bar mark deletion]
576 '("Flag" . tar-flag-deleted))
577 (define-key map [menu-bar mark unmark]
578 '("Unflag" . tar-unflag))
579
580 (define-key map [menu-bar operate]
581 (cons "Operate" (make-sparse-keymap "Operate")))
582
583 (define-key map [menu-bar operate chown]
584 '("Change Owner..." . tar-chown-entry))
585 (define-key map [menu-bar operate chgrp]
586 '("Change Group..." . tar-chgrp-entry))
587 (define-key map [menu-bar operate chmod]
588 '("Change Mode..." . tar-chmod-entry))
589 (define-key map [menu-bar operate rename]
590 '("Rename to..." . tar-rename-entry))
591 (define-key map [menu-bar operate copy]
592 '("Copy to..." . tar-copy))
593 (define-key map [menu-bar operate expunge]
594 '("Expunge Marked Files" . tar-expunge))
595 \f
596 map)
597 "Local keymap for Tar mode listings.")
598
599 \f
600 ;; tar mode is suitable only for specially formatted data.
601 (put 'tar-mode 'mode-class 'special)
602 (put 'tar-subfile-mode 'mode-class 'special)
603
604 (defun tar-change-major-mode-hook ()
605 ;; Bring the actual Tar data back into the main buffer.
606 (when (tar-data-swapped-p) (tar-swap-data))
607 ;; Throw away the summary.
608 (when (buffer-live-p tar-data-buffer) (kill-buffer tar-data-buffer)))
609
610 (defun tar-mode-kill-buffer-hook ()
611 (if (buffer-live-p tar-data-buffer) (kill-buffer tar-data-buffer)))
612
613 ;;;###autoload
614 (define-derived-mode tar-mode nil "Tar"
615 "Major mode for viewing a tar file as a dired-like listing of its contents.
616 You can move around using the usual cursor motion commands.
617 Letters no longer insert themselves.
618 Type `e' to pull a file out of the tar file and into its own buffer;
619 or click mouse-2 on the file's line in the Tar mode buffer.
620 Type `c' to copy an entry from the tar file into another file on disk.
621
622 If you edit a sub-file of this archive (as with the `e' command) and
623 save it with \\[save-buffer], the contents of that buffer will be
624 saved back into the tar-file buffer; in this way you can edit a file
625 inside of a tar archive without extracting it and re-archiving it.
626
627 See also: variables `tar-update-datestamp' and `tar-anal-blocksize'.
628 \\{tar-mode-map}"
629 (make-local-variable 'tar-parse-info)
630 (set (make-local-variable 'require-final-newline) nil) ; binary data, dude...
631 (set (make-local-variable 'local-enable-local-variables) nil)
632 (set (make-local-variable 'next-line-add-newlines) nil)
633 (set (make-local-variable 'tar-file-name-coding-system)
634 (or file-name-coding-system
635 default-file-name-coding-system
636 locale-coding-system))
637 ;; Prevent loss of data when saving the file.
638 (set (make-local-variable 'file-precious-flag) t)
639 (buffer-disable-undo)
640 (widen)
641 ;; Now move the Tar data into an auxiliary buffer, so we can use the main
642 ;; buffer for the summary.
643 (assert (not (tar-data-swapped-p)))
644 (set (make-local-variable 'revert-buffer-function) 'tar-mode-revert)
645 ;; We started using write-contents-functions, but this hook is not
646 ;; used during auto-save, so we now use
647 ;; write-region-annotate-functions which hooks at a lower-level.
648 (add-hook 'write-region-annotate-functions 'tar-write-region-annotate nil t)
649 (add-hook 'kill-buffer-hook 'tar-mode-kill-buffer-hook nil t)
650 (add-hook 'change-major-mode-hook 'tar-change-major-mode-hook nil t)
651 ;; Tar data is made of bytes, not chars.
652 (set-buffer-multibyte nil) ;Hopefully a no-op.
653 (set (make-local-variable 'tar-data-buffer)
654 (generate-new-buffer (format " *tar-data %s*"
655 (file-name-nondirectory
656 (or buffer-file-name (buffer-name))))))
657 (condition-case err
658 (progn
659 (tar-swap-data)
660 (tar-summarize-buffer)
661 (tar-next-line 0))
662 (error
663 ;; If summarizing caused an error, then maybe the buffer doesn't contain
664 ;; tar data. Rather than show a mysterious empty buffer, let's
665 ;; revert to fundamental-mode.
666 (fundamental-mode)
667 (signal (car err) (cdr err)))))
668
669
670 (defun tar-subfile-mode (p)
671 "Minor mode for editing an element of a tar-file.
672 This mode arranges for \"saving\" this buffer to write the data
673 into the tar-file buffer that it came from. The changes will actually
674 appear on disk when you save the tar-file's buffer."
675 (interactive "P")
676 (or (and (boundp 'tar-superior-buffer) tar-superior-buffer)
677 (error "This buffer is not an element of a tar file"))
678 ;; Don't do this, because it is redundant and wastes mode line space.
679 ;; (or (assq 'tar-subfile-mode minor-mode-alist)
680 ;; (setq minor-mode-alist (append minor-mode-alist
681 ;; (list '(tar-subfile-mode " TarFile")))))
682 (make-local-variable 'tar-subfile-mode)
683 (setq tar-subfile-mode
684 (if (null p)
685 (not tar-subfile-mode)
686 (> (prefix-numeric-value p) 0)))
687 (cond (tar-subfile-mode
688 (add-hook 'write-file-functions 'tar-subfile-save-buffer nil t)
689 ;; turn off auto-save.
690 (auto-save-mode -1)
691 (setq buffer-auto-save-file-name nil)
692 (run-hooks 'tar-subfile-mode-hook))
693 (t
694 (remove-hook 'write-file-functions 'tar-subfile-save-buffer t))))
695
696
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))))
709
710
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))))
716
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)))
721
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
728 nil
729 (error "This line does not describe a tar-file entry"))))
730
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))
747
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))
759
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))))
765
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 (if view-p
851 (view-buffer
852 buffer (and just-created 'kill-buffer-if-not-modified))
853 (if (eq other-window-p 'display)
854 (display-buffer buffer)
855 (if other-window-p
856 (switch-to-buffer-other-window buffer)
857 (switch-to-buffer buffer)))))))
858
859
860 (defun tar-extract-other-window ()
861 "In Tar mode, find this entry of the tar file in another window."
862 (interactive)
863 (tar-extract t))
864
865 (defun tar-display-other-window ()
866 "In Tar mode, display this entry of the tar file in another window."
867 (interactive)
868 (tar-extract 'display))
869
870 (defun tar-view ()
871 "In Tar mode, view the tar file entry on this line."
872 (interactive)
873 (tar-extract 'view))
874
875
876 (defun tar-read-file-name (&optional prompt)
877 "Read a file name with this line's entry as the default."
878 (or prompt (setq prompt "Copy to: "))
879 (let* ((default-file (expand-file-name
880 (tar-header-name (tar-current-descriptor))))
881 (target (expand-file-name
882 (read-file-name prompt
883 (file-name-directory default-file)
884 default-file nil))))
885 (if (or (string= "" (file-name-nondirectory target))
886 (file-directory-p target))
887 (setq target (concat (if (string-match "/$" target)
888 (substring target 0 (1- (match-end 0)))
889 target)
890 "/"
891 (file-name-nondirectory default-file))))
892 target))
893
894
895 (defun tar-copy (&optional to-file)
896 "In Tar mode, extract this entry of the tar file into a file on disk.
897 If TO-FILE is not supplied, it is prompted for, defaulting to the name of
898 the current tar-entry."
899 (interactive (list (tar-read-file-name)))
900 (let* ((descriptor (tar-get-descriptor))
901 (name (tar-header-name descriptor))
902 (size (tar-header-size descriptor))
903 (start (tar-header-data-start descriptor))
904 (end (+ start size))
905 (inhibit-file-name-handlers inhibit-file-name-handlers)
906 (inhibit-file-name-operation inhibit-file-name-operation))
907 (save-restriction
908 (widen)
909 ;; Inhibit compressing a subfile again if *both* name and
910 ;; to-file are handled by jka-compr
911 (if (and (eq (find-file-name-handler name 'write-region) 'jka-compr-handler)
912 (eq (find-file-name-handler to-file 'write-region) '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)))
921
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)))
934
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))
940
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))
946
947
948 (defun tar-expunge-internal ()
949 "Expunge the tar-entry specified by the current line."
950 (let ((descriptor (tar-current-descriptor)))
951 ;;
952 ;; delete the current line...
953 (delete-region (line-beginning-position) (line-beginning-position 2))
954 ;;
955 ;; delete the data pointer...
956 (setq tar-parse-info (delq descriptor tar-parse-info))
957 ;;
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)))))
963
964
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)))))
985
986
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))))
996
997
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 (concat new-uid "\000")))
1017 (t
1018 (setf (tar-header-uid (tar-current-descriptor)) new-uid)
1019 (tar-alter-one-field tar-uid-offset
1020 (concat (substring (format "%6o" new-uid) 0 6) "\000 ")))))
1021
1022
1023 (defun tar-chgrp-entry (new-gid)
1024 "Change the group-id associated with this entry in the tar file.
1025 If this tar file was written by GNU tar, then you will be able to edit
1026 the group id as a string; otherwise, you must edit it as a number.
1027 You can force editing as a number by calling this with a prefix arg.
1028 This does not modify the disk image; you must save the tar file itself
1029 for this to be permanent."
1030 (interactive
1031 (list
1032 (let ((descriptor (tar-current-descriptor)))
1033 (if (or current-prefix-arg
1034 (not (tar-header-magic descriptor)))
1035 (read-number
1036 "New GID number: "
1037 (format "%s" (tar-header-gid descriptor)))
1038 (read-string "New GID string: " (tar-header-gname descriptor))))))
1039 (cond ((stringp new-gid)
1040 (setf (tar-header-gname (tar-current-descriptor)) new-gid)
1041 (tar-alter-one-field tar-gname-offset
1042 (concat new-gid "\000")))
1043 (t
1044 (setf (tar-header-gid (tar-current-descriptor)) new-gid)
1045 (tar-alter-one-field tar-gid-offset
1046 (concat (substring (format "%6o" new-gid) 0 6) "\000 ")))))
1047
1048 (defun tar-rename-entry (new-name)
1049 "Change the name associated with this entry in the tar file.
1050 This does not modify the disk image; you must save the tar file itself
1051 for this to be permanent."
1052 (interactive
1053 (list (read-string "New name: "
1054 (tar-header-name (tar-current-descriptor)))))
1055 (if (string= "" new-name) (error "zero length name"))
1056 (let ((encoded-new-name (encode-coding-string new-name
1057 tar-file-name-coding-system))
1058 (descriptor (tar-current-descriptor))
1059 (prefix nil))
1060 (when (tar-header-header-start descriptor)
1061 ;; FIXME: Make it work for ././@LongLink.
1062 (error "Rename with @LongLink format is not implemented"))
1063
1064 (when (and (> (length encoded-new-name) 98)
1065 (string-match "/" encoded-new-name
1066 (- (length encoded-new-name) 99))
1067 (< (match-beginning 0) 155))
1068 (unless (equal (tar-header-magic descriptor) "ustar\0")
1069 (tar-alter-one-field tar-magic-offset (concat "ustar\0" "00")))
1070 (setq prefix (substring encoded-new-name 0 (match-beginning 0)))
1071 (setq encoded-new-name (substring encoded-new-name (match-end 0))))
1072
1073 (if (> (length encoded-new-name) 98) (error "name too long"))
1074 (setf (tar-header-name descriptor) new-name)
1075 (tar-alter-one-field 0
1076 (substring (concat encoded-new-name (make-string 99 0)) 0 99))
1077 (if prefix
1078 (tar-alter-one-field tar-prefix-offset
1079 (substring (concat prefix (make-string 155 0)) 0 155)))))
1080
1081
1082 (defun tar-chmod-entry (new-mode)
1083 "Change the protection bits associated with this entry in the tar file.
1084 This does not modify the disk image; you must save the tar file itself
1085 for this to be permanent."
1086 (interactive (list (tar-parse-octal-integer-safe
1087 (read-string "New protection (octal): "))))
1088 (setf (tar-header-mode (tar-current-descriptor)) new-mode)
1089 (tar-alter-one-field tar-mode-offset
1090 (concat (substring (format "%6o" new-mode) 0 6) "\000 ")))
1091
1092
1093 (defun tar-alter-one-field (data-position new-data-string &optional descriptor)
1094 (unless descriptor (setq descriptor (tar-current-descriptor)))
1095 ;;
1096 ;; update the header-line.
1097 (let ((col (current-column)))
1098 (delete-region (line-beginning-position)
1099 (prog2 (forward-line 1)
1100 (point)
1101 ;; Insert the new text after the old, before deleting,
1102 ;; to preserve markers such as the window start.
1103 (insert (tar-header-block-summarize descriptor) "\n")))
1104 (forward-line -1) (move-to-column col))
1105
1106 (assert (tar-data-swapped-p))
1107 (with-current-buffer tar-data-buffer
1108 (let* ((start (- (tar-header-data-start descriptor) 512)))
1109 ;;
1110 ;; delete the old field and insert a new one.
1111 (goto-char (+ start data-position))
1112 (delete-region (point) (+ (point) (length new-data-string))) ; <--
1113 (assert (not (or enable-multibyte-characters
1114 (multibyte-string-p new-data-string))))
1115 (insert new-data-string)
1116 ;;
1117 ;; compute a new checksum and insert it.
1118 (let ((chk (tar-header-block-checksum
1119 (buffer-substring start (+ start 512)))))
1120 (goto-char (+ start tar-chk-offset))
1121 (delete-region (point) (+ (point) 8))
1122 (insert (format "%6o\0 " chk))
1123 (setf (tar-header-checksum descriptor) chk)
1124 ;;
1125 ;; ok, make sure we didn't botch it.
1126 (tar-header-block-check-checksum
1127 (buffer-substring start (+ start 512))
1128 chk (tar-header-name descriptor))
1129 ))))
1130
1131
1132 (defun tar-octal-time (timeval)
1133 ;; Format a timestamp as 11 octal digits. Ghod, I hope this works...
1134 (let ((hibits (car timeval)) (lobits (car (cdr timeval))))
1135 (format "%05o%01o%05o"
1136 (lsh hibits -2)
1137 (logior (lsh (logand 3 hibits) 1)
1138 (if (> (logand lobits 32768) 0) 1 0))
1139 (logand 32767 lobits)
1140 )))
1141
1142 (defun tar-subfile-save-buffer ()
1143 "In tar subfile mode, save this buffer into its parent tar-file buffer.
1144 This doesn't write anything to disk; you must save the parent tar-file buffer
1145 to make your changes permanent."
1146 (interactive)
1147 (if (not (and (boundp 'tar-superior-buffer) tar-superior-buffer))
1148 (error "This buffer has no superior tar file buffer"))
1149 (if (not (and (boundp 'tar-superior-descriptor) tar-superior-descriptor))
1150 (error "This buffer doesn't have an index into its superior tar file!"))
1151 (let ((subfile (current-buffer))
1152 (coding buffer-file-coding-system)
1153 (descriptor tar-superior-descriptor)
1154 subfile-size)
1155 (with-current-buffer tar-superior-buffer
1156 (let* ((start (tar-header-data-start descriptor))
1157 (name (tar-header-name descriptor))
1158 (size (tar-header-size descriptor))
1159 (head (memq descriptor tar-parse-info)))
1160 (if (not head)
1161 (error "Can't find this tar file entry in its parent tar file!"))
1162 (with-current-buffer tar-data-buffer
1163 ;; delete the old data...
1164 (let* ((data-start start)
1165 (data-end (+ data-start (tar-roundup-512 size))))
1166 (narrow-to-region data-start data-end)
1167 (delete-region (point-min) (point-max))
1168 ;; insert the new data...
1169 (goto-char data-start)
1170 (let ((dest (current-buffer)))
1171 (with-current-buffer subfile
1172 (save-restriction
1173 (widen)
1174 (encode-coding-region (point-min) (point-max) coding dest))))
1175 (setq subfile-size (- (point-max) (point-min)))
1176 ;;
1177 ;; pad the new data out to a multiple of 512...
1178 (let ((subfile-size-pad (tar-roundup-512 subfile-size)))
1179 (goto-char (point-max))
1180 (insert (make-string (- subfile-size-pad subfile-size) 0))
1181 ;;
1182 ;; update the data of this files...
1183 (setf (tar-header-size descriptor) subfile-size)
1184 ;;
1185 ;; Update the size field in the header block.
1186 (widen))))
1187 ;;
1188 ;; alter the descriptor-line and header
1189 ;;
1190 (let ((position (- (length tar-parse-info) (length head))))
1191 (goto-char (point-min))
1192 (forward-line position)
1193 (tar-alter-one-field tar-size-offset (format "%11o " subfile-size))
1194 ;;
1195 ;; Maybe update the datestamp.
1196 (when tar-update-datestamp
1197 (tar-alter-one-field tar-time-offset
1198 (concat (tar-octal-time (current-time)) " "))))
1199 ;; After doing the insertion, add any necessary final padding.
1200 (tar-pad-to-blocksize))
1201 (set-buffer-modified-p t) ; mark the tar file as modified
1202 (tar-next-line 0))
1203 (set-buffer-modified-p nil) ; mark the tar subfile as unmodified
1204 (message "Saved into tar-buffer `%s'. Be sure to save that buffer!"
1205 (buffer-name tar-superior-buffer))
1206 ;; Prevent basic-save-buffer from changing our coding-system.
1207 (setq last-coding-system-used buffer-file-coding-system)
1208 ;; Prevent ordinary saving from happening.
1209 t))
1210
1211
1212 ;; When this function is called, it is sure that the buffer is unibyte.
1213 (defun tar-pad-to-blocksize ()
1214 "If we are being anal about tar file blocksizes, fix up the current buffer.
1215 Leaves the region wide."
1216 (if (null tar-anal-blocksize)
1217 nil
1218 (let* ((last-desc (nth (1- (length tar-parse-info)) tar-parse-info))
1219 (start (tar-header-data-start last-desc))
1220 (link-p (tar-header-link-type last-desc))
1221 (size (if link-p 0 (tar-header-size last-desc)))
1222 (data-end (+ start size))
1223 (bbytes (ash tar-anal-blocksize 9))
1224 (pad-to (+ bbytes (* bbytes (/ (- data-end (point-min)) bbytes)))))
1225 ;; If the padding after the last data is too long, delete some;
1226 ;; else insert some until we are padded out to the right number of blocks.
1227 ;;
1228 (with-current-buffer tar-data-buffer
1229 (let ((goal-end (+ (point-min) pad-to)))
1230 (if (> (point-max) goal-end)
1231 (delete-region goal-end (point-max))
1232 (goto-char (point-max))
1233 (insert (make-string (- goal-end (point-max)) ?\0))))))))
1234
1235
1236 ;; Used in write-region-annotate-functions to write tar-files out correctly.
1237 (defun tar-write-region-annotate (start end)
1238 ;; When called from write-file (and auto-save), `start' is nil.
1239 ;; When called from M-x write-region, we assume the user wants to save
1240 ;; (part of) the summary, not the tar data.
1241 (unless (or start (not (tar-data-swapped-p)))
1242 (tar-clear-modification-flags)
1243 (set-buffer tar-data-buffer)
1244 nil))
1245
1246 (provide 'tar-mode)
1247
1248 ;; arch-tag: 8a585a4a-340e-42c2-89e7-d3b1013a4b78
1249 ;;; tar-mode.el ends here