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