Commit | Line | Data |
---|---|---|
c88ab9ce | 1 | ;;; tar-mode.el --- simple editing of tar files from GNU emacs |
aa73f29c | 2 | |
d733c5ec | 3 | ;;; Copyright (C) 1990, 1991, 1993, 1994 Free Software Foundation, Inc. |
eea8d4ef | 4 | |
22a89ee8 | 5 | ;; Author: Jamie Zawinski <jwz@lucid.com> |
e5167999 | 6 | ;; Created: 04 Apr 1990 |
0f8becaa | 7 | ;; Version: 1.21bis (some cleanup by ESR) |
d7b4d18f | 8 | ;; Keywords: unix |
aa73f29c | 9 | |
aa73f29c RS |
10 | ;;; This file is part of GNU Emacs. |
11 | ;;; | |
12 | ;;; GNU Emacs is free software; you can redistribute it and/or modify | |
13 | ;;; it under the terms of the GNU General Public License as published by | |
e5167999 | 14 | ;;; the Free Software Foundation; either version 2, or (at your option) |
aa73f29c RS |
15 | ;;; any later version. |
16 | ;;; | |
17 | ;;; GNU Emacs is distributed in the hope that it will be useful, | |
18 | ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;;; GNU General Public License for more details. | |
21 | ;;; | |
22 | ;;; You should have received a copy of the GNU General Public License | |
23 | ;;; along with GNU Emacs; see the file COPYING. If not, write to | |
24 | ;;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
25 | ||
22a89ee8 ER |
26 | ;;; Commentary: |
27 | ||
aa73f29c RS |
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 | ||
aa73f29c RS |
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, | |
42 | ;;; which you get with | |
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 | ||
50 | ;;; *************** TO DO *************** | |
51 | ;;; | |
52 | ;;; o chmod should understand "a+x,og-w". | |
53 | ;;; | |
54 | ;;; o It's not possible to add a NEW file to a tar archive; not that | |
55 | ;;; important, but still... | |
56 | ;;; | |
aa73f29c RS |
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 | ;;; | |
65 | ;;; o Sometimes (but not always) reverting the tar-file buffer does not | |
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 | ;;; | |
77 | ;;; o Block files, sparse files, continuation files, and the various header | |
78 | ;;; types aren't editable. Actually I don't know that they work at all. | |
79 | ||
ce210066 RS |
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. | |
93 | ||
22a89ee8 ER |
94 | ;;; Code: |
95 | ||
aa73f29c RS |
96 | (defvar tar-anal-blocksize 20 |
97 | "*The blocksize of tar files written by Emacs, or nil, meaning don't care. | |
98 | The blocksize of a tar file is not really the size of the blocks; rather, it is | |
99 | the number of blocks written with one system call. When tarring to a tape, | |
100 | this is the size of the *tape* blocks, but when writing to a file, it doesn't | |
101 | matter much. The only noticeable difference is that if a tar file does not | |
102 | have a blocksize of 20, tar will tell you that; all this really controls is | |
103 | how many null padding bytes go on the end of the tar file.") | |
104 | ||
105 | (defvar tar-update-datestamp nil | |
30712209 RS |
106 | "*Non-nil means tar-mode should play fast and loose with sub-file datestamps. |
107 | If this is true, then editing and saving a tar file entry back into its | |
aa73f29c RS |
108 | tar file will update its datestamp. If false, the datestamp is unchanged. |
109 | You may or may not want this - it is good in that you can tell when a file | |
110 | in a tar archive has been changed, but it is bad for the same reason that | |
111 | editing a file in the tar archive at all is bad - the changed version of | |
49116ac0 | 112 | the file never exists on disk.") |
aa73f29c | 113 | |
30712209 RS |
114 | (defvar tar-mode-show-date nil |
115 | "*Non-nil means Tar mode should show the date/time of each subfile. | |
116 | This information is useful, but it takes screen space away from file names.") | |
117 | ||
0f8becaa ER |
118 | (defvar tar-parse-info nil) |
119 | (defvar tar-header-offset nil) | |
120 | (defvar tar-superior-buffer nil) | |
121 | (defvar tar-superior-descriptor nil) | |
122 | (defvar tar-subfile-mode nil) | |
1c0b3743 RS |
123 | |
124 | (put 'tar-parse-info 'permanent-local t) | |
125 | (put 'tar-header-offset 'permanent-local t) | |
126 | (put 'tar-superior-buffer 'permanent-local t) | |
127 | (put 'tar-superior-descriptor 'permanent-local t) | |
aa73f29c RS |
128 | \f |
129 | ;;; First, duplicate some Common Lisp functions; I used to just (require 'cl) | |
130 | ;;; but "cl.el" was messing some people up (also it's really big). | |
131 | ||
132 | (defmacro tar-setf (form val) | |
133 | "A mind-numbingly simple implementation of setf." | |
134 | (let ((mform (macroexpand form (and (boundp 'byte-compile-macro-environment) | |
135 | byte-compile-macro-environment)))) | |
136 | (cond ((symbolp mform) (list 'setq mform val)) | |
137 | ((not (consp mform)) (error "can't setf %s" form)) | |
138 | ((eq (car mform) 'aref) | |
139 | (list 'aset (nth 1 mform) (nth 2 mform) val)) | |
140 | ((eq (car mform) 'car) | |
141 | (list 'setcar (nth 1 mform) val)) | |
142 | ((eq (car mform) 'cdr) | |
143 | (list 'setcdr (nth 1 mform) val)) | |
144 | (t (error "don't know how to setf %s" form))))) | |
145 | ||
146 | (defmacro tar-dolist (control &rest body) | |
147 | "syntax: (dolist (var-name list-expr &optional return-value) &body body)" | |
148 | (let ((var (car control)) | |
149 | (init (car (cdr control))) | |
150 | (val (car (cdr (cdr control))))) | |
151 | (list 'let (list (list '_dolist_iterator_ init)) | |
152 | (list 'while '_dolist_iterator_ | |
153 | (cons 'let | |
154 | (cons (list (list var '(car _dolist_iterator_))) | |
155 | (append body | |
156 | (list (list 'setq '_dolist_iterator_ | |
157 | (list 'cdr '_dolist_iterator_))))))) | |
158 | val))) | |
159 | ||
160 | (defmacro tar-dotimes (control &rest body) | |
161 | "syntax: (dolist (var-name count-expr &optional return-value) &body body)" | |
162 | (let ((var (car control)) | |
163 | (n (car (cdr control))) | |
164 | (val (car (cdr (cdr control))))) | |
165 | (list 'let (list (list '_dotimes_end_ n) | |
166 | (list var 0)) | |
167 | (cons 'while | |
168 | (cons (list '< var '_dotimes_end_) | |
169 | (append body | |
170 | (list (list 'setq var (list '1+ var)))))) | |
171 | val))) | |
172 | ||
173 | \f | |
174 | ;;; down to business. | |
175 | ||
176 | (defmacro make-tar-header (name mode uid git size date ck lt ln | |
177 | magic uname gname devmaj devmin) | |
178 | (list 'vector name mode uid git size date ck lt ln | |
179 | magic uname gname devmaj devmin)) | |
180 | ||
181 | (defmacro tar-header-name (x) (list 'aref x 0)) | |
182 | (defmacro tar-header-mode (x) (list 'aref x 1)) | |
183 | (defmacro tar-header-uid (x) (list 'aref x 2)) | |
184 | (defmacro tar-header-gid (x) (list 'aref x 3)) | |
185 | (defmacro tar-header-size (x) (list 'aref x 4)) | |
186 | (defmacro tar-header-date (x) (list 'aref x 5)) | |
187 | (defmacro tar-header-checksum (x) (list 'aref x 6)) | |
188 | (defmacro tar-header-link-type (x) (list 'aref x 7)) | |
189 | (defmacro tar-header-link-name (x) (list 'aref x 8)) | |
190 | (defmacro tar-header-magic (x) (list 'aref x 9)) | |
191 | (defmacro tar-header-uname (x) (list 'aref x 10)) | |
192 | (defmacro tar-header-gname (x) (list 'aref x 11)) | |
193 | (defmacro tar-header-dmaj (x) (list 'aref x 12)) | |
194 | (defmacro tar-header-dmin (x) (list 'aref x 13)) | |
195 | ||
196 | (defmacro make-tar-desc (data-start tokens) | |
197 | (list 'cons data-start tokens)) | |
198 | ||
199 | (defmacro tar-desc-data-start (x) (list 'car x)) | |
200 | (defmacro tar-desc-tokens (x) (list 'cdr x)) | |
201 | ||
202 | (defconst tar-name-offset 0) | |
203 | (defconst tar-mode-offset (+ tar-name-offset 100)) | |
204 | (defconst tar-uid-offset (+ tar-mode-offset 8)) | |
205 | (defconst tar-gid-offset (+ tar-uid-offset 8)) | |
206 | (defconst tar-size-offset (+ tar-gid-offset 8)) | |
207 | (defconst tar-time-offset (+ tar-size-offset 12)) | |
208 | (defconst tar-chk-offset (+ tar-time-offset 12)) | |
209 | (defconst tar-linkp-offset (+ tar-chk-offset 8)) | |
210 | (defconst tar-link-offset (+ tar-linkp-offset 1)) | |
211 | ;;; GNU-tar specific slots. | |
212 | (defconst tar-magic-offset (+ tar-link-offset 100)) | |
213 | (defconst tar-uname-offset (+ tar-magic-offset 8)) | |
214 | (defconst tar-gname-offset (+ tar-uname-offset 32)) | |
215 | (defconst tar-dmaj-offset (+ tar-gname-offset 32)) | |
216 | (defconst tar-dmin-offset (+ tar-dmaj-offset 8)) | |
217 | (defconst tar-end-offset (+ tar-dmin-offset 8)) | |
218 | ||
1bc28099 | 219 | (defun tar-header-block-tokenize (string) |
e865c5ce RS |
220 | "Return a `tar-header' structure. |
221 | This is a list of name, mode, uid, gid, size, | |
222 | write-date, checksum, link-type, and link-name." | |
aa73f29c RS |
223 | (cond ((< (length string) 512) nil) |
224 | (;(some 'plusp string) ; <-- oops, massive cycle hog! | |
225 | (or (not (= 0 (aref string 0))) ; This will do. | |
226 | (not (= 0 (aref string 101)))) | |
227 | (let* ((name-end (1- tar-mode-offset)) | |
228 | (link-end (1- tar-magic-offset)) | |
229 | (uname-end (1- tar-gname-offset)) | |
230 | (gname-end (1- tar-dmaj-offset)) | |
231 | (link-p (aref string tar-linkp-offset)) | |
232 | (magic-str (substring string tar-magic-offset (1- tar-uname-offset))) | |
233 | (uname-valid-p (or (string= "ustar " magic-str) (string= "GNUtar " magic-str))) | |
234 | name | |
235 | (nulsexp "[^\000]*\000")) | |
236 | (and (string-match nulsexp string tar-name-offset) (setq name-end (min name-end (1- (match-end 0))))) | |
237 | (and (string-match nulsexp string tar-link-offset) (setq link-end (min link-end (1- (match-end 0))))) | |
238 | (and (string-match nulsexp string tar-uname-offset) (setq uname-end (min uname-end (1- (match-end 0))))) | |
239 | (and (string-match nulsexp string tar-gname-offset) (setq gname-end (min gname-end (1- (match-end 0))))) | |
240 | (setq name (substring string tar-name-offset name-end) | |
241 | link-p (if (or (= link-p 0) (= link-p ?0)) | |
242 | nil | |
243 | (- link-p ?0))) | |
244 | (if (and (null link-p) (string-match "/$" name)) (setq link-p 5)) ; directory | |
245 | (make-tar-header | |
246 | name | |
247 | (tar-parse-octal-integer string tar-mode-offset (1- tar-uid-offset)) | |
248 | (tar-parse-octal-integer string tar-uid-offset (1- tar-gid-offset)) | |
249 | (tar-parse-octal-integer string tar-gid-offset (1- tar-size-offset)) | |
250 | (tar-parse-octal-integer string tar-size-offset (1- tar-time-offset)) | |
30712209 | 251 | (tar-parse-octal-long-integer string tar-time-offset (1- tar-chk-offset)) |
aa73f29c RS |
252 | (tar-parse-octal-integer string tar-chk-offset (1- tar-linkp-offset)) |
253 | link-p | |
254 | (substring string tar-link-offset link-end) | |
255 | uname-valid-p | |
256 | (and uname-valid-p (substring string tar-uname-offset uname-end)) | |
257 | (and uname-valid-p (substring string tar-gname-offset gname-end)) | |
258 | (tar-parse-octal-integer string tar-dmaj-offset (1- tar-dmin-offset)) | |
259 | (tar-parse-octal-integer string tar-dmin-offset (1- tar-end-offset)) | |
260 | ))) | |
261 | (t 'empty-tar-block))) | |
262 | ||
263 | ||
264 | (defun tar-parse-octal-integer (string &optional start end) | |
aa73f29c RS |
265 | (if (null start) (setq start 0)) |
266 | (if (null end) (setq end (length string))) | |
267 | (if (= (aref string start) 0) | |
268 | 0 | |
269 | (let ((n 0)) | |
270 | (while (< start end) | |
271 | (setq n (if (< (aref string start) ?0) n | |
30712209 | 272 | (+ (* n 8) (- (aref string start) ?0))) |
aa73f29c RS |
273 | start (1+ start))) |
274 | n))) | |
275 | ||
30712209 RS |
276 | (defun tar-parse-octal-long-integer (string &optional start end) |
277 | (if (null start) (setq start 0)) | |
278 | (if (null end) (setq end (length string))) | |
279 | (if (= (aref string start) 0) | |
280 | [0 0] | |
281 | (let ((lo 0) | |
282 | (hi 0)) | |
283 | (while (< start end) | |
284 | (if (>= (aref string start) ?0) | |
285 | (setq lo (+ (* lo 8) (- (aref string start) ?0)) | |
286 | hi (+ (* hi 8) (ash lo -16)) | |
287 | lo (logand lo 65535))) | |
288 | (setq start (1+ start))) | |
289 | (list hi lo)))) | |
290 | ||
aa73f29c RS |
291 | (defun tar-parse-octal-integer-safe (string) |
292 | (let ((L (length string))) | |
293 | (if (= L 0) (error "empty string")) | |
294 | (tar-dotimes (i L) | |
295 | (if (or (< (aref string i) ?0) | |
296 | (> (aref string i) ?7)) | |
439fa06f | 297 | (error "'%c' is not an octal digit")))) |
aa73f29c RS |
298 | (tar-parse-octal-integer string)) |
299 | ||
300 | ||
1bc28099 | 301 | (defun tar-header-block-checksum (string) |
e865c5ce | 302 | "Compute and return a tar-acceptable checksum for this block." |
aa73f29c RS |
303 | (let* ((chk-field-start tar-chk-offset) |
304 | (chk-field-end (+ chk-field-start 8)) | |
305 | (sum 0) | |
306 | (i 0)) | |
307 | ;; Add up all of the characters except the ones in the checksum field. | |
308 | ;; Add that field as if it were filled with spaces. | |
309 | (while (< i chk-field-start) | |
310 | (setq sum (+ sum (aref string i)) | |
311 | i (1+ i))) | |
312 | (setq i chk-field-end) | |
313 | (while (< i 512) | |
314 | (setq sum (+ sum (aref string i)) | |
315 | i (1+ i))) | |
316 | (+ sum (* 32 8)))) | |
317 | ||
1bc28099 | 318 | (defun tar-header-block-check-checksum (hblock desired-checksum file-name) |
aa73f29c | 319 | "Beep and print a warning if the checksum doesn't match." |
1bc28099 | 320 | (if (not (= desired-checksum (tar-header-block-checksum hblock))) |
aa73f29c RS |
321 | (progn (beep) (message "Invalid checksum for file %s!" file-name)))) |
322 | ||
1bc28099 | 323 | (defun tar-header-block-recompute-checksum (hblock) |
aa73f29c | 324 | "Modifies the given string to have a valid checksum field." |
1bc28099 | 325 | (let* ((chk (tar-header-block-checksum hblock)) |
aa73f29c RS |
326 | (chk-string (format "%6o" chk)) |
327 | (l (length chk-string))) | |
328 | (aset hblock 154 0) | |
329 | (aset hblock 155 32) | |
330 | (tar-dotimes (i l) (aset hblock (- 153 i) (aref chk-string (- l i 1))))) | |
331 | hblock) | |
332 | ||
30712209 RS |
333 | (defun tar-clip-time-string (time) |
334 | (let ((str (current-time-string time))) | |
335 | (concat (substring str 4 16) (substring str 19 24)))) | |
aa73f29c RS |
336 | |
337 | (defun tar-grind-file-mode (mode string start) | |
6a06ace6 RS |
338 | "Store `-rw--r--r--' indicating MODE into STRING beginning at START. |
339 | MODE should be an integer which is a file mode value." | |
aa73f29c RS |
340 | (aset string start (if (zerop (logand 256 mode)) ?- ?r)) |
341 | (aset string (+ start 1) (if (zerop (logand 128 mode)) ?- ?w)) | |
342 | (aset string (+ start 2) (if (zerop (logand 64 mode)) ?- ?x)) | |
343 | (aset string (+ start 3) (if (zerop (logand 32 mode)) ?- ?r)) | |
344 | (aset string (+ start 4) (if (zerop (logand 16 mode)) ?- ?w)) | |
345 | (aset string (+ start 5) (if (zerop (logand 8 mode)) ?- ?x)) | |
346 | (aset string (+ start 6) (if (zerop (logand 4 mode)) ?- ?r)) | |
347 | (aset string (+ start 7) (if (zerop (logand 2 mode)) ?- ?w)) | |
348 | (aset string (+ start 8) (if (zerop (logand 1 mode)) ?- ?x)) | |
349 | (if (zerop (logand 1024 mode)) nil (aset string (+ start 2) ?s)) | |
350 | (if (zerop (logand 2048 mode)) nil (aset string (+ start 5) ?s)) | |
351 | string) | |
352 | ||
1bc28099 | 353 | (defun tar-header-block-summarize (tar-hblock &optional mod-p) |
e865c5ce | 354 | "Returns a line similar to the output of `tar -vtf'." |
aa73f29c RS |
355 | (let ((name (tar-header-name tar-hblock)) |
356 | (mode (tar-header-mode tar-hblock)) | |
357 | (uid (tar-header-uid tar-hblock)) | |
358 | (gid (tar-header-gid tar-hblock)) | |
359 | (uname (tar-header-uname tar-hblock)) | |
360 | (gname (tar-header-gname tar-hblock)) | |
361 | (size (tar-header-size tar-hblock)) | |
362 | (time (tar-header-date tar-hblock)) | |
363 | (ck (tar-header-checksum tar-hblock)) | |
364 | (link-p (tar-header-link-type tar-hblock)) | |
365 | (link-name (tar-header-link-name tar-hblock)) | |
366 | ) | |
367 | (let* ((left 11) | |
368 | (namew 8) | |
369 | (groupw 8) | |
370 | (sizew 8) | |
30712209 | 371 | (datew (if tar-mode-show-date 18 0)) |
aa73f29c RS |
372 | (slash (1- (+ left namew))) |
373 | (lastdigit (+ slash groupw sizew)) | |
30712209 RS |
374 | (datestart (+ lastdigit 2)) |
375 | (namestart (+ datestart datew)) | |
aa73f29c RS |
376 | (string (make-string (+ namestart (length name) (if link-p (+ 5 (length link-name)) 0)) 32)) |
377 | (type (tar-header-link-type tar-hblock))) | |
378 | (aset string 0 (if mod-p ?* ? )) | |
379 | (aset string 1 | |
380 | (cond ((or (eq type nil) (eq type 0)) ?-) | |
381 | ((eq type 1) ?l) ; link | |
382 | ((eq type 2) ?s) ; symlink | |
383 | ((eq type 3) ?c) ; char special | |
384 | ((eq type 4) ?b) ; block special | |
385 | ((eq type 5) ?d) ; directory | |
386 | ((eq type 6) ?p) ; FIFO/pipe | |
387 | ((eq type 20) ?*) ; directory listing | |
388 | ((eq type 29) ?M) ; multivolume continuation | |
389 | ((eq type 35) ?S) ; sparse | |
390 | ((eq type 38) ?V) ; volume header | |
391 | )) | |
392 | (tar-grind-file-mode mode string 2) | |
393 | (setq uid (if (= 0 (length uname)) (int-to-string uid) uname)) | |
394 | (setq gid (if (= 0 (length gname)) (int-to-string gid) gname)) | |
395 | (setq size (int-to-string size)) | |
30712209 | 396 | (setq time (tar-clip-time-string time)) |
aa73f29c RS |
397 | (tar-dotimes (i (min (1- namew) (length uid))) (aset string (- slash i) (aref uid (- (length uid) i 1)))) |
398 | (aset string (1+ slash) ?/) | |
399 | (tar-dotimes (i (min (1- groupw) (length gid))) (aset string (+ (+ slash 2) i) (aref gid i))) | |
400 | (tar-dotimes (i (min sizew (length size))) (aset string (- lastdigit i) (aref size (- (length size) i 1)))) | |
30712209 RS |
401 | (if tar-mode-show-date |
402 | (tar-dotimes (i (length time)) (aset string (+ datestart i) (aref time i)))) | |
aa73f29c RS |
403 | (tar-dotimes (i (length name)) (aset string (+ namestart i) (aref name i))) |
404 | (if (or (eq link-p 1) (eq link-p 2)) | |
405 | (progn | |
406 | (tar-dotimes (i 3) (aset string (+ namestart 1 (length name) i) (aref (if (= link-p 1) "==>" "-->") i))) | |
407 | (tar-dotimes (i (length link-name)) (aset string (+ namestart 5 (length name) i) (aref link-name i))))) | |
84258c5d KH |
408 | (put-text-property namestart (length string) |
409 | 'mouse-face 'highlight string) | |
aa73f29c RS |
410 | string))) |
411 | ||
412 | ||
413 | (defun tar-summarize-buffer () | |
e865c5ce RS |
414 | "Parse the contents of the tar file in the current buffer. |
415 | Place a dired-like listing on the front; | |
416 | then narrow to it, so that only that listing | |
aa73f29c RS |
417 | is visible (and the real data of the buffer is hidden)." |
418 | (message "parsing tar file...") | |
419 | (let* ((result '()) | |
420 | (pos 1) | |
421 | (bs (max 1 (- (buffer-size) 1024))) ; always 2+ empty blocks at end. | |
422 | (bs100 (max 1 (/ bs 100))) | |
7bfcceab KH |
423 | tokens) |
424 | (while (and (<= (+ pos 512) (point-max)) | |
425 | (not (eq 'empty-tar-block | |
426 | (setq tokens | |
427 | (tar-header-block-tokenize | |
428 | (buffer-substring pos (+ pos 512))))))) | |
1b15043e | 429 | (setq pos (+ pos 512)) |
7bfcceab | 430 | (message "Parsing tar file...%d%%" |
1b15043e KH |
431 | ;(/ (* pos 100) bs) ; this gets round-off lossage |
432 | (/ pos bs100) ; this doesn't | |
433 | ) | |
7bfcceab KH |
434 | (if (eq (tar-header-link-type tokens) 20) |
435 | ;; Foo. There's an extra empty block after these. | |
436 | (setq pos (+ pos 512))) | |
437 | (let ((size (tar-header-size tokens))) | |
438 | (if (< size 0) | |
439 | (error "%s has size %s - corrupted" | |
440 | (tar-header-name tokens) size)) | |
441 | ; | |
442 | ; This is just too slow. Don't really need it anyway.... | |
443 | ;(tar-header-block-check-checksum | |
444 | ; hblock (tar-header-block-checksum hblock) | |
445 | ; (tar-header-name tokens)) | |
446 | ||
447 | (setq result (cons (make-tar-desc pos tokens) result)) | |
448 | ||
449 | (and (null (tar-header-link-type tokens)) | |
450 | (> size 0) | |
451 | (setq pos | |
452 | (+ pos 512 (ash (ash (1- size) -9) 9)) ; this works | |
453 | ;(+ pos (+ size (- 512 (rem (1- size) 512)))) ; this doesn't | |
454 | )))) | |
aa73f29c | 455 | (make-local-variable 'tar-parse-info) |
7bfcceab KH |
456 | (setq tar-parse-info (nreverse result)) |
457 | ;; A tar file should end with a block or two of nulls, | |
458 | ;; but let's not get a fatal error if it doesn't. | |
459 | (if (eq tokens 'empty-tar-block) | |
460 | (message "Parsing tar file...done.") | |
461 | (message "Warning: premature EOF parsing tar file"))) | |
aa73f29c RS |
462 | (save-excursion |
463 | (goto-char (point-min)) | |
464 | (let ((buffer-read-only nil)) | |
465 | (tar-dolist (tar-desc tar-parse-info) | |
466 | (insert-string | |
1bc28099 | 467 | (tar-header-block-summarize (tar-desc-tokens tar-desc))) |
aa73f29c RS |
468 | (insert-string "\n")) |
469 | (make-local-variable 'tar-header-offset) | |
470 | (setq tar-header-offset (point)) | |
471 | (narrow-to-region 1 tar-header-offset) | |
7bfcceab | 472 | (set-buffer-modified-p nil)))) |
e865c5ce | 473 | \f |
439fa06f | 474 | (defvar tar-mode-map nil "*Local keymap for Tar mode listings.") |
aa73f29c RS |
475 | |
476 | (if tar-mode-map | |
477 | nil | |
478 | (setq tar-mode-map (make-keymap)) | |
479 | (suppress-keymap tar-mode-map) | |
480 | (define-key tar-mode-map " " 'tar-next-line) | |
481 | (define-key tar-mode-map "c" 'tar-copy) | |
482 | (define-key tar-mode-map "d" 'tar-flag-deleted) | |
483 | (define-key tar-mode-map "\^D" 'tar-flag-deleted) | |
484 | (define-key tar-mode-map "e" 'tar-extract) | |
485 | (define-key tar-mode-map "f" 'tar-extract) | |
42269da5 | 486 | (define-key tar-mode-map "\C-m" 'tar-extract) |
439fa06f | 487 | (define-key tar-mode-map [mouse-2] 'tar-mouse-extract) |
aa73f29c RS |
488 | (define-key tar-mode-map "g" 'revert-buffer) |
489 | (define-key tar-mode-map "h" 'describe-mode) | |
490 | (define-key tar-mode-map "n" 'tar-next-line) | |
491 | (define-key tar-mode-map "\^N" 'tar-next-line) | |
492 | (define-key tar-mode-map "o" 'tar-extract-other-window) | |
aa73f29c RS |
493 | (define-key tar-mode-map "p" 'tar-previous-line) |
494 | (define-key tar-mode-map "\^P" 'tar-previous-line) | |
495 | (define-key tar-mode-map "r" 'tar-rename-entry) | |
496 | (define-key tar-mode-map "u" 'tar-unflag) | |
497 | (define-key tar-mode-map "v" 'tar-view) | |
498 | (define-key tar-mode-map "x" 'tar-expunge) | |
499 | (define-key tar-mode-map "\177" 'tar-unflag-backwards) | |
500 | (define-key tar-mode-map "E" 'tar-extract-other-window) | |
501 | (define-key tar-mode-map "M" 'tar-chmod-entry) | |
502 | (define-key tar-mode-map "G" 'tar-chgrp-entry) | |
503 | (define-key tar-mode-map "O" 'tar-chown-entry) | |
504 | ) | |
e865c5ce RS |
505 | \f |
506 | ;; Make menu bar items. | |
507 | ||
508 | ;; Get rid of the Edit menu bar item to save space. | |
509 | (define-key tar-mode-map [menu-bar edit] 'undefined) | |
510 | ||
511 | (define-key tar-mode-map [menu-bar immediate] | |
512 | (cons "Immediate" (make-sparse-keymap "Immediate"))) | |
513 | ||
514 | (define-key tar-mode-map [menu-bar immediate view] | |
515 | '("View This File" . tar-view)) | |
516 | (define-key tar-mode-map [menu-bar immediate display] | |
517 | '("Display in Other Window" . tar-display-file)) | |
518 | (define-key tar-mode-map [menu-bar immediate find-file-other-window] | |
519 | '("Find in Other Window" . tar-extract-other-window)) | |
520 | (define-key tar-mode-map [menu-bar immediate find-file] | |
521 | '("Find This File" . tar-extract)) | |
522 | ||
523 | (define-key tar-mode-map [menu-bar mark] | |
524 | (cons "Mark" (make-sparse-keymap "Mark"))) | |
525 | ||
526 | (define-key tar-mode-map [menu-bar mark unmark-all] | |
527 | '("Unmark All" . tar-clear-modification-flags)) | |
528 | (define-key tar-mode-map [menu-bar mark deletion] | |
529 | '("Flag" . tar-flag-deleted)) | |
530 | (define-key tar-mode-map [menu-bar mark unmark] | |
531 | '("Unflag" . tar-unflag)) | |
532 | ||
533 | (define-key tar-mode-map [menu-bar operate] | |
534 | (cons "Operate" (make-sparse-keymap "Operate"))) | |
535 | ||
536 | (define-key tar-mode-map [menu-bar operate chown] | |
537 | '("Change Owner..." . tar-chown-entry)) | |
538 | (define-key tar-mode-map [menu-bar operate chgrp] | |
539 | '("Change Group..." . tar-chgrp-entry)) | |
540 | (define-key tar-mode-map [menu-bar operate chmod] | |
541 | '("Change Mode..." . tar-chmod-entry)) | |
542 | (define-key tar-mode-map [menu-bar operate rename] | |
543 | '("Rename to..." . tar-rename-entry)) | |
544 | (define-key tar-mode-map [menu-bar operate copy] | |
545 | '("Copy to..." . tar-copy)) | |
546 | (define-key tar-mode-map [menu-bar operate expunge] | |
547 | '("Expunge marked files" . tar-expunge)) | |
548 | \f | |
aa73f29c RS |
549 | ;; tar mode is suitable only for specially formatted data. |
550 | (put 'tar-mode 'mode-class 'special) | |
551 | (put 'tar-subfile-mode 'mode-class 'special) | |
552 | ||
bdd53bbc | 553 | ;;;###autoload |
aa73f29c RS |
554 | (defun tar-mode () |
555 | "Major mode for viewing a tar file as a dired-like listing of its contents. | |
556 | You can move around using the usual cursor motion commands. | |
557 | Letters no longer insert themselves. | |
439fa06f RS |
558 | Type `e' to pull a file out of the tar file and into its own buffer; |
559 | or click mouse-2 on the file's line in the Tar mode buffer. | |
e865c5ce | 560 | Type `c' to copy an entry from the tar file into another file on disk. |
aa73f29c | 561 | |
e865c5ce RS |
562 | If you edit a sub-file of this archive (as with the `e' command) and |
563 | save it with Control-x Control-s, the contents of that buffer will be | |
aa73f29c RS |
564 | saved back into the tar-file buffer; in this way you can edit a file |
565 | inside of a tar archive without extracting it and re-archiving it. | |
566 | ||
e865c5ce | 567 | See also: variables `tar-update-datestamp' and `tar-anal-blocksize'. |
aa73f29c RS |
568 | \\{tar-mode-map}" |
569 | ;; this is not interactive because you shouldn't be turning this | |
570 | ;; mode on and off. You can corrupt things that way. | |
1c0b3743 RS |
571 | ;; rms: with permanent locals, it should now be possible to make this work |
572 | ;; interactively in some reasonable fashion. | |
573 | (kill-all-local-variables) | |
aa73f29c RS |
574 | (make-local-variable 'tar-header-offset) |
575 | (make-local-variable 'tar-parse-info) | |
576 | (make-local-variable 'require-final-newline) | |
577 | (setq require-final-newline nil) ; binary data, dude... | |
578 | (make-local-variable 'revert-buffer-function) | |
579 | (setq revert-buffer-function 'tar-mode-revert) | |
1c0b3743 RS |
580 | (make-local-variable 'enable-local-variables) |
581 | (setq enable-local-variables nil) | |
aa73f29c RS |
582 | (setq major-mode 'tar-mode) |
583 | (setq mode-name "Tar") | |
584 | (use-local-map tar-mode-map) | |
585 | (auto-save-mode 0) | |
586 | (widen) | |
587 | (if (and (boundp 'tar-header-offset) tar-header-offset) | |
588 | (narrow-to-region 1 tar-header-offset) | |
589 | (tar-summarize-buffer)) | |
590 | (run-hooks 'tar-mode-hook) | |
591 | ) | |
592 | ||
593 | ||
1c0b3743 RS |
594 | ;; This should be converted to use a minor mode keymap. |
595 | ||
aa73f29c RS |
596 | (defun tar-subfile-mode (p) |
597 | "Minor mode for editing an element of a tar-file. | |
1c0b3743 | 598 | This mode redefines C-x C-s to save the current buffer back into its |
aa73f29c RS |
599 | associated tar-file buffer. You must save that buffer to actually |
600 | save your changes to disk." | |
601 | (interactive "P") | |
0f8becaa | 602 | (or (and (boundp 'tar-superior-buffer) tar-superior-buffer) |
e865c5ce | 603 | (error "This buffer is not an element of a tar file")) |
c09655bc RS |
604 | ;;; Don't do this, because it is redundant and wastes mode line space. |
605 | ;;; (or (assq 'tar-subfile-mode minor-mode-alist) | |
606 | ;;; (setq minor-mode-alist (append minor-mode-alist | |
607 | ;;; (list '(tar-subfile-mode " TarFile"))))) | |
aa73f29c RS |
608 | (make-local-variable 'tar-subfile-mode) |
609 | (setq tar-subfile-mode | |
610 | (if (null p) | |
611 | (not tar-subfile-mode) | |
612 | (> (prefix-numeric-value p) 0))) | |
613 | (cond (tar-subfile-mode | |
e865c5ce RS |
614 | (make-local-variable 'local-write-file-hooks) |
615 | (setq local-write-file-hooks '(tar-subfile-save-buffer)) | |
aa73f29c RS |
616 | ;; turn off auto-save. |
617 | (auto-save-mode nil) | |
618 | (setq buffer-auto-save-file-name nil) | |
619 | (run-hooks 'tar-subfile-mode-hook)) | |
e865c5ce RS |
620 | (t |
621 | (kill-local-variable 'local-write-file-hooks)))) | |
aa73f29c RS |
622 | |
623 | ||
e865c5ce | 624 | ;; Revert the buffer and recompute the dired-like listing. |
aa73f29c | 625 | (defun tar-mode-revert (&optional no-autosave no-confirm) |
aa73f29c RS |
626 | (setq tar-header-offset nil) |
627 | (let ((revert-buffer-function nil)) | |
628 | (revert-buffer t no-confirm) | |
629 | (widen)) | |
630 | (tar-mode)) | |
631 | ||
632 | ||
633 | (defun tar-next-line (p) | |
634 | (interactive "p") | |
635 | (forward-line p) | |
30712209 | 636 | (if (eobp) nil (forward-char (if tar-mode-show-date 54 36)))) |
aa73f29c RS |
637 | |
638 | (defun tar-previous-line (p) | |
639 | (interactive "p") | |
640 | (tar-next-line (- p))) | |
641 | ||
642 | (defun tar-current-descriptor (&optional noerror) | |
e865c5ce | 643 | "Return the tar-descriptor of the current line, or signals an error." |
aa73f29c RS |
644 | ;; I wish lines had plists, like in ZMACS... |
645 | (or (nth (count-lines (point-min) | |
646 | (save-excursion (beginning-of-line) (point))) | |
647 | tar-parse-info) | |
648 | (if noerror | |
649 | nil | |
439fa06f | 650 | (error "This line does not describe a tar-file entry")))) |
aa73f29c | 651 | |
439fa06f RS |
652 | (defun tar-get-descriptor () |
653 | (let* ((descriptor (tar-current-descriptor)) | |
654 | (tokens (tar-desc-tokens descriptor)) | |
655 | (size (tar-header-size tokens)) | |
656 | (link-p (tar-header-link-type tokens))) | |
657 | (if link-p | |
658 | (error "This is a %s, not a real file" | |
659 | (cond ((eq link-p 5) "directory") | |
660 | ((eq link-p 20) "tar directory header") | |
661 | ((eq link-p 29) "multivolume-continuation") | |
662 | ((eq link-p 35) "sparse entry") | |
663 | ((eq link-p 38) "volume header") | |
664 | (t "link")))) | |
665 | (if (zerop size) (error "This is a zero-length file")) | |
666 | descriptor)) | |
667 | ||
668 | (defun tar-mouse-extract (event) | |
669 | "Extract a file whose tar directory line you click on." | |
670 | (interactive "e") | |
671 | (save-excursion | |
672 | (set-buffer (window-buffer (posn-window (event-end event)))) | |
673 | (save-excursion | |
674 | (goto-char (posn-point (event-end event))) | |
675 | ;; Just make sure this doesn't get an error. | |
676 | (tar-get-descriptor))) | |
677 | (select-window (posn-window (event-end event))) | |
678 | (goto-char (posn-point (event-end event))) | |
679 | (tar-extract)) | |
aa73f29c RS |
680 | |
681 | (defun tar-extract (&optional other-window-p) | |
628d6cef | 682 | "In Tar mode, extract this entry of the tar file into its own buffer." |
aa73f29c RS |
683 | (interactive) |
684 | (let* ((view-p (eq other-window-p 'view)) | |
439fa06f | 685 | (descriptor (tar-get-descriptor)) |
aa73f29c RS |
686 | (tokens (tar-desc-tokens descriptor)) |
687 | (name (tar-header-name tokens)) | |
688 | (size (tar-header-size tokens)) | |
aa73f29c RS |
689 | (start (+ (tar-desc-data-start descriptor) tar-header-offset -1)) |
690 | (end (+ start size))) | |
aa73f29c | 691 | (let* ((tar-buffer (current-buffer)) |
c09655bc | 692 | (tarname (file-name-nondirectory (buffer-file-name))) |
aa73f29c | 693 | (bufname (concat (file-name-nondirectory name) |
c09655bc RS |
694 | " (" |
695 | tarname | |
aa73f29c RS |
696 | ")")) |
697 | (read-only-p (or buffer-read-only view-p)) | |
698 | (buffer (get-buffer bufname)) | |
699 | (just-created nil)) | |
700 | (if buffer | |
701 | nil | |
702 | (setq buffer (get-buffer-create bufname)) | |
703 | (setq just-created t) | |
704 | (unwind-protect | |
705 | (progn | |
706 | (widen) | |
707 | (save-excursion | |
708 | (set-buffer buffer) | |
709 | (insert-buffer-substring tar-buffer start end) | |
710 | (goto-char 0) | |
1bc28099 RS |
711 | (setq buffer-file-name |
712 | (expand-file-name (concat tarname ":" name))) | |
fef5a0be RS |
713 | (setq buffer-file-truename |
714 | (abbreviate-file-name buffer-file-name)) | |
715 | ;; Set the default-directory to the dir of the | |
716 | ;; superior buffer. | |
717 | (setq default-directory | |
718 | (save-excursion | |
719 | (set-buffer tar-buffer) | |
720 | default-directory)) | |
aa73f29c | 721 | (normal-mode) ; pick a mode. |
aa73f29c | 722 | (rename-buffer bufname) |
0f8becaa ER |
723 | (make-local-variable 'tar-superior-buffer) |
724 | (make-local-variable 'tar-superior-descriptor) | |
725 | (setq tar-superior-buffer tar-buffer) | |
726 | (setq tar-superior-descriptor descriptor) | |
fef5a0be | 727 | (tar-subfile-mode 1) |
aa73f29c RS |
728 | (setq buffer-read-only read-only-p) |
729 | (set-buffer-modified-p nil)) | |
730 | (set-buffer tar-buffer)) | |
731 | (narrow-to-region 1 tar-header-offset))) | |
732 | (if view-p | |
733 | (progn | |
734 | (view-buffer buffer) | |
b5ae9ca5 RS |
735 | (and just-created |
736 | (setq view-exit-action 'kill-buffer))) | |
e865c5ce RS |
737 | (if (eq other-window-p 'display) |
738 | (display-buffer buffer) | |
739 | (if other-window-p | |
740 | (switch-to-buffer-other-window buffer) | |
741 | (switch-to-buffer buffer))))))) | |
aa73f29c RS |
742 | |
743 | ||
744 | (defun tar-extract-other-window () | |
e865c5ce | 745 | "*In Tar mode, find this entry of the tar file in another window." |
aa73f29c RS |
746 | (interactive) |
747 | (tar-extract t)) | |
748 | ||
e865c5ce RS |
749 | (defun tar-display-other-window () |
750 | "*In Tar mode, display this entry of the tar file in another window." | |
751 | (interactive) | |
752 | (tar-extract 'display)) | |
753 | ||
aa73f29c | 754 | (defun tar-view () |
e865c5ce | 755 | "*In Tar mode, view the tar file entry on this line." |
aa73f29c RS |
756 | (interactive) |
757 | (tar-extract 'view)) | |
758 | ||
759 | ||
760 | (defun tar-read-file-name (&optional prompt) | |
e865c5ce | 761 | "Read a file name with this line's entry as the default." |
aa73f29c RS |
762 | (or prompt (setq prompt "Copy to: ")) |
763 | (let* ((default-file (expand-file-name | |
764 | (tar-header-name (tar-desc-tokens | |
765 | (tar-current-descriptor))))) | |
766 | (target (expand-file-name | |
767 | (read-file-name prompt | |
768 | (file-name-directory default-file) | |
769 | default-file nil)))) | |
770 | (if (or (string= "" (file-name-nondirectory target)) | |
771 | (file-directory-p target)) | |
772 | (setq target (concat (if (string-match "/$" target) | |
773 | (substring target 0 (1- (match-end 0))) | |
774 | target) | |
775 | "/" | |
776 | (file-name-nondirectory default-file)))) | |
777 | target)) | |
778 | ||
779 | ||
780 | (defun tar-copy (&optional to-file) | |
e865c5ce | 781 | "*In Tar mode, extract this entry of the tar file into a file on disk. |
aa73f29c RS |
782 | If TO-FILE is not supplied, it is prompted for, defaulting to the name of |
783 | the current tar-entry." | |
784 | (interactive (list (tar-read-file-name))) | |
439fa06f | 785 | (let* ((descriptor (tar-get-descriptor)) |
aa73f29c RS |
786 | (tokens (tar-desc-tokens descriptor)) |
787 | (name (tar-header-name tokens)) | |
788 | (size (tar-header-size tokens)) | |
aa73f29c RS |
789 | (start (+ (tar-desc-data-start descriptor) tar-header-offset -1)) |
790 | (end (+ start size))) | |
6a608e8e KH |
791 | (save-restriction |
792 | (widen) | |
793 | (write-region start end to-file)) | |
794 | (message "Copied tar entry %s to %s" name to-file))) | |
aa73f29c RS |
795 | |
796 | (defun tar-flag-deleted (p &optional unflag) | |
e865c5ce | 797 | "*In Tar mode, mark this sub-file to be deleted from the tar file. |
aa73f29c RS |
798 | With a prefix argument, mark that many files." |
799 | (interactive "p") | |
800 | (beginning-of-line) | |
801 | (tar-dotimes (i (if (< p 0) (- p) p)) | |
802 | (if (tar-current-descriptor unflag) ; barf if we're not on an entry-line. | |
803 | (progn | |
804 | (delete-char 1) | |
805 | (insert (if unflag " " "D")))) | |
806 | (forward-line (if (< p 0) -1 1))) | |
807 | (if (eobp) nil (forward-char 36))) | |
808 | ||
809 | (defun tar-unflag (p) | |
e865c5ce | 810 | "*In Tar mode, un-mark this sub-file if it is marked to be deleted. |
aa73f29c RS |
811 | With a prefix argument, un-mark that many files forward." |
812 | (interactive "p") | |
813 | (tar-flag-deleted p t)) | |
814 | ||
815 | (defun tar-unflag-backwards (p) | |
e865c5ce | 816 | "*In Tar mode, un-mark this sub-file if it is marked to be deleted. |
aa73f29c RS |
817 | With a prefix argument, un-mark that many files backward." |
818 | (interactive "p") | |
819 | (tar-flag-deleted (- p) t)) | |
820 | ||
821 | ||
822 | (defun tar-expunge-internal () | |
823 | "Expunge the tar-entry specified by the current line." | |
824 | (let* ((descriptor (tar-current-descriptor)) | |
825 | (tokens (tar-desc-tokens descriptor)) | |
826 | (line (tar-desc-data-start descriptor)) | |
827 | (name (tar-header-name tokens)) | |
828 | (size (tar-header-size tokens)) | |
829 | (link-p (tar-header-link-type tokens)) | |
830 | (start (tar-desc-data-start descriptor)) | |
831 | (following-descs (cdr (memq descriptor tar-parse-info)))) | |
832 | (if link-p (setq size 0)) ; size lies for hard-links. | |
833 | ;; | |
834 | ;; delete the current line... | |
835 | (beginning-of-line) | |
836 | (let ((line-start (point))) | |
837 | (end-of-line) (forward-char) | |
838 | (let ((line-len (- (point) line-start))) | |
839 | (delete-region line-start (point)) | |
840 | ;; | |
841 | ;; decrement the header-pointer to be in synch... | |
842 | (setq tar-header-offset (- tar-header-offset line-len)))) | |
843 | ;; | |
844 | ;; delete the data pointer... | |
845 | (setq tar-parse-info (delq descriptor tar-parse-info)) | |
846 | ;; | |
847 | ;; delete the data from inside the file... | |
848 | (widen) | |
849 | (let* ((data-start (+ start tar-header-offset -513)) | |
850 | (data-end (+ data-start 512 (ash (ash (+ size 511) -9) 9)))) | |
851 | (delete-region data-start data-end) | |
852 | ;; | |
853 | ;; and finally, decrement the start-pointers of all following | |
854 | ;; entries in the archive. This is a pig when deleting a bunch | |
855 | ;; of files at once - we could optimize this to only do the | |
856 | ;; iteration over the files that remain, or only iterate up to | |
857 | ;; the next file to be deleted. | |
858 | (let ((data-length (- data-end data-start))) | |
859 | (tar-dolist (desc following-descs) | |
860 | (tar-setf (tar-desc-data-start desc) | |
861 | (- (tar-desc-data-start desc) data-length)))) | |
862 | )) | |
863 | (narrow-to-region 1 tar-header-offset)) | |
864 | ||
865 | ||
866 | (defun tar-expunge (&optional noconfirm) | |
e865c5ce | 867 | "*In Tar mode, delete all the archived files flagged for deletion. |
aa73f29c RS |
868 | This does not modify the disk image; you must save the tar file itself |
869 | for this to be permanent." | |
870 | (interactive) | |
871 | (if (or noconfirm | |
872 | (y-or-n-p "expunge files marked for deletion? ")) | |
873 | (let ((n 0)) | |
874 | (save-excursion | |
875 | (goto-char 0) | |
876 | (while (not (eobp)) | |
877 | (if (looking-at "D") | |
878 | (progn (tar-expunge-internal) | |
879 | (setq n (1+ n))) | |
880 | (forward-line 1))) | |
881 | ;; after doing the deletions, add any padding that may be necessary. | |
882 | (tar-pad-to-blocksize) | |
883 | (narrow-to-region 1 tar-header-offset) | |
884 | ) | |
885 | (if (zerop n) | |
886 | (message "nothing to expunge.") | |
887 | (message "%s expunged. Be sure to save this buffer." n))))) | |
888 | ||
889 | ||
890 | (defun tar-clear-modification-flags () | |
e865c5ce | 891 | "Remove the stars at the beginning of each line." |
aa73f29c RS |
892 | (save-excursion |
893 | (goto-char 0) | |
894 | (while (< (point) tar-header-offset) | |
895 | (if (looking-at "*") | |
896 | (progn (delete-char 1) (insert " "))) | |
897 | (forward-line 1)))) | |
898 | ||
899 | ||
900 | (defun tar-chown-entry (new-uid) | |
901 | "*Change the user-id associated with this entry in the tar file. | |
902 | If this tar file was written by GNU tar, then you will be able to edit | |
903 | the user id as a string; otherwise, you must edit it as a number. | |
904 | You can force editing as a number by calling this with a prefix arg. | |
905 | This does not modify the disk image; you must save the tar file itself | |
906 | for this to be permanent." | |
907 | (interactive (list | |
908 | (let ((tokens (tar-desc-tokens (tar-current-descriptor)))) | |
909 | (if (or current-prefix-arg | |
910 | (not (tar-header-magic tokens))) | |
911 | (let (n) | |
912 | (while (not (numberp (setq n (read-minibuffer | |
913 | "New UID number: " | |
914 | (format "%s" (tar-header-uid tokens))))))) | |
915 | n) | |
916 | (read-string "New UID string: " (tar-header-uname tokens)))))) | |
917 | (cond ((stringp new-uid) | |
918 | (tar-setf (tar-header-uname (tar-desc-tokens (tar-current-descriptor))) | |
919 | new-uid) | |
920 | (tar-alter-one-field tar-uname-offset (concat new-uid "\000"))) | |
921 | (t | |
922 | (tar-setf (tar-header-uid (tar-desc-tokens (tar-current-descriptor))) | |
923 | new-uid) | |
924 | (tar-alter-one-field tar-uid-offset | |
925 | (concat (substring (format "%6o" new-uid) 0 6) "\000 "))))) | |
926 | ||
927 | ||
928 | (defun tar-chgrp-entry (new-gid) | |
929 | "*Change the group-id associated with this entry in the tar file. | |
930 | If this tar file was written by GNU tar, then you will be able to edit | |
931 | the group id as a string; otherwise, you must edit it as a number. | |
932 | You can force editing as a number by calling this with a prefix arg. | |
933 | This does not modify the disk image; you must save the tar file itself | |
934 | for this to be permanent." | |
935 | (interactive (list | |
936 | (let ((tokens (tar-desc-tokens (tar-current-descriptor)))) | |
937 | (if (or current-prefix-arg | |
938 | (not (tar-header-magic tokens))) | |
939 | (let (n) | |
940 | (while (not (numberp (setq n (read-minibuffer | |
941 | "New GID number: " | |
942 | (format "%s" (tar-header-gid tokens))))))) | |
943 | n) | |
944 | (read-string "New GID string: " (tar-header-gname tokens)))))) | |
945 | (cond ((stringp new-gid) | |
946 | (tar-setf (tar-header-gname (tar-desc-tokens (tar-current-descriptor))) | |
947 | new-gid) | |
948 | (tar-alter-one-field tar-gname-offset | |
949 | (concat new-gid "\000"))) | |
950 | (t | |
951 | (tar-setf (tar-header-gid (tar-desc-tokens (tar-current-descriptor))) | |
952 | new-gid) | |
953 | (tar-alter-one-field tar-gid-offset | |
954 | (concat (substring (format "%6o" new-gid) 0 6) "\000 "))))) | |
955 | ||
956 | (defun tar-rename-entry (new-name) | |
957 | "*Change the name associated with this entry in the tar file. | |
958 | This does not modify the disk image; you must save the tar file itself | |
959 | for this to be permanent." | |
960 | (interactive | |
961 | (list (read-string "New name: " | |
962 | (tar-header-name (tar-desc-tokens (tar-current-descriptor)))))) | |
439fa06f RS |
963 | (if (string= "" new-name) (error "zero length name")) |
964 | (if (> (length new-name) 98) (error "name too long")) | |
aa73f29c RS |
965 | (tar-setf (tar-header-name (tar-desc-tokens (tar-current-descriptor))) |
966 | new-name) | |
967 | (tar-alter-one-field 0 | |
968 | (substring (concat new-name (make-string 99 0)) 0 99))) | |
969 | ||
970 | ||
971 | (defun tar-chmod-entry (new-mode) | |
972 | "*Change the protection bits associated with this entry in the tar file. | |
973 | This does not modify the disk image; you must save the tar file itself | |
974 | for this to be permanent." | |
975 | (interactive (list (tar-parse-octal-integer-safe | |
976 | (read-string "New protection (octal): ")))) | |
977 | (tar-setf (tar-header-mode (tar-desc-tokens (tar-current-descriptor))) | |
978 | new-mode) | |
979 | (tar-alter-one-field tar-mode-offset | |
980 | (concat (substring (format "%6o" new-mode) 0 6) "\000 "))) | |
981 | ||
982 | ||
983 | (defun tar-alter-one-field (data-position new-data-string) | |
984 | (let* ((descriptor (tar-current-descriptor)) | |
985 | (tokens (tar-desc-tokens descriptor))) | |
986 | (unwind-protect | |
987 | (save-excursion | |
988 | ;; | |
989 | ;; update the header-line. | |
990 | (beginning-of-line) | |
991 | (let ((p (point))) | |
992 | (forward-line 1) | |
993 | (delete-region p (point)) | |
1bc28099 | 994 | (insert (tar-header-block-summarize tokens) "\n") |
aa73f29c RS |
995 | (setq tar-header-offset (point-max))) |
996 | ||
997 | (widen) | |
998 | (let* ((start (+ (tar-desc-data-start descriptor) tar-header-offset -513))) | |
999 | ;; | |
1000 | ;; delete the old field and insert a new one. | |
1001 | (goto-char (+ start data-position)) | |
1002 | (delete-region (point) (+ (point) (length new-data-string))) ; <-- | |
1003 | (insert new-data-string) ; <-- | |
1004 | ;; | |
1005 | ;; compute a new checksum and insert it. | |
1bc28099 | 1006 | (let ((chk (tar-header-block-checksum |
aa73f29c RS |
1007 | (buffer-substring start (+ start 512))))) |
1008 | (goto-char (+ start tar-chk-offset)) | |
1009 | (delete-region (point) (+ (point) 8)) | |
1010 | (insert (format "%6o" chk)) | |
1011 | (insert 0) | |
1012 | (insert ? ) | |
1013 | (tar-setf (tar-header-checksum tokens) chk) | |
1014 | ;; | |
1015 | ;; ok, make sure we didn't botch it. | |
d246db94 | 1016 | (tar-header-block-check-checksum |
aa73f29c RS |
1017 | (buffer-substring start (+ start 512)) |
1018 | chk (tar-header-name tokens)) | |
1019 | ))) | |
1020 | (narrow-to-region 1 tar-header-offset)))) | |
1021 | ||
1022 | ||
3d7fc2fb ER |
1023 | (defun tar-octal-time (timeval) |
1024 | ;; Format a timestamp as 11 octal digits. Ghod, I hope this works... | |
1025 | (let ((hibits (car timeval)) (lobits (car (cdr timeval)))) | |
1026 | (insert (format "%05o%01o%05o" | |
1027 | (lsh hibits -2) | |
1028 | (logior (lsh (logand 3 hibits) 1) (> (logand lobits 32768) 0)) | |
1029 | (logand 32767 lobits) | |
1030 | )))) | |
1031 | ||
aa73f29c | 1032 | (defun tar-subfile-save-buffer () |
e865c5ce RS |
1033 | "In tar subfile mode, save this buffer into its parent tar-file buffer. |
1034 | This doesn't write anything to disk; you must save the parent tar-file buffer | |
aa73f29c RS |
1035 | to make your changes permanent." |
1036 | (interactive) | |
0f8becaa | 1037 | (if (not (and (boundp 'tar-superior-buffer) tar-superior-buffer)) |
439fa06f | 1038 | (error "This buffer has no superior tar file buffer")) |
0f8becaa | 1039 | (if (not (and (boundp 'tar-superior-descriptor) tar-superior-descriptor)) |
439fa06f | 1040 | (error "This buffer doesn't have an index into its superior tar file!")) |
aa73f29c RS |
1041 | (save-excursion |
1042 | (let ((subfile (current-buffer)) | |
1043 | (subfile-size (buffer-size)) | |
0f8becaa ER |
1044 | (descriptor tar-superior-descriptor)) |
1045 | (set-buffer tar-superior-buffer) | |
aa73f29c RS |
1046 | (let* ((tokens (tar-desc-tokens descriptor)) |
1047 | (start (tar-desc-data-start descriptor)) | |
1048 | (name (tar-header-name tokens)) | |
1049 | (size (tar-header-size tokens)) | |
1050 | (size-pad (ash (ash (+ size 511) -9) 9)) | |
1051 | (head (memq descriptor tar-parse-info)) | |
1052 | (following-descs (cdr head))) | |
1053 | (if (not head) | |
1054 | (error "Can't find this tar file entry in its parent tar file!")) | |
1055 | (unwind-protect | |
1056 | (save-excursion | |
1057 | (widen) | |
1058 | ;; delete the old data... | |
1059 | (let* ((data-start (+ start tar-header-offset -1)) | |
1060 | (data-end (+ data-start (ash (ash (+ size 511) -9) 9)))) | |
1061 | (delete-region data-start data-end) | |
1062 | ;; insert the new data... | |
1063 | (goto-char data-start) | |
1064 | (insert-buffer subfile) | |
1065 | ;; | |
1066 | ;; pad the new data out to a multiple of 512... | |
1067 | (let ((subfile-size-pad (ash (ash (+ subfile-size 511) -9) 9))) | |
1068 | (goto-char (+ data-start subfile-size)) | |
1069 | (insert (make-string (- subfile-size-pad subfile-size) 0)) | |
1070 | ;; | |
1071 | ;; update the data pointer of this and all following files... | |
1072 | (tar-setf (tar-header-size tokens) subfile-size) | |
1073 | (let ((difference (- subfile-size-pad size-pad))) | |
1074 | (tar-dolist (desc following-descs) | |
1075 | (tar-setf (tar-desc-data-start desc) | |
1076 | (+ (tar-desc-data-start desc) difference)))) | |
1077 | ;; | |
1078 | ;; Update the size field in the header block. | |
1079 | (let ((header-start (- data-start 512))) | |
1080 | (goto-char (+ header-start tar-size-offset)) | |
1081 | (delete-region (point) (+ (point) 12)) | |
1082 | (insert (format "%11o" subfile-size)) | |
1083 | (insert ? ) | |
1084 | ;; | |
1085 | ;; Maybe update the datestamp. | |
1086 | (if (not tar-update-datestamp) | |
1087 | nil | |
1088 | (goto-char (+ header-start tar-time-offset)) | |
1089 | (delete-region (point) (+ (point) 12)) | |
3d7fc2fb | 1090 | (insert (tar-octal-time (current-time))) |
aa73f29c RS |
1091 | (insert ? )) |
1092 | ;; | |
1093 | ;; compute a new checksum and insert it. | |
1bc28099 | 1094 | (let ((chk (tar-header-block-checksum |
aa73f29c RS |
1095 | (buffer-substring header-start data-start)))) |
1096 | (goto-char (+ header-start tar-chk-offset)) | |
1097 | (delete-region (point) (+ (point) 8)) | |
1098 | (insert (format "%6o" chk)) | |
1099 | (insert 0) | |
1100 | (insert ? ) | |
1101 | (tar-setf (tar-header-checksum tokens) chk))) | |
1102 | ;; | |
1103 | ;; alter the descriptor-line... | |
1104 | ;; | |
1105 | (let ((position (- (length tar-parse-info) (length head)))) | |
1106 | (goto-char 1) | |
1107 | (next-line position) | |
1108 | (beginning-of-line) | |
1109 | (let ((p (point)) | |
97590737 | 1110 | after |
aa73f29c RS |
1111 | (m (set-marker (make-marker) tar-header-offset))) |
1112 | (forward-line 1) | |
97590737 RS |
1113 | (setq after (point)) |
1114 | ;; Insert the new text after the old, before deleting, | |
1115 | ;; to preserve the window start. | |
1bc28099 | 1116 | (insert-before-markers (tar-header-block-summarize tokens t) "\n") |
97590737 | 1117 | (delete-region p after) |
aa73f29c RS |
1118 | (setq tar-header-offset (marker-position m))) |
1119 | ))) | |
1120 | ;; after doing the insertion, add any final padding that may be necessary. | |
1121 | (tar-pad-to-blocksize)) | |
1122 | (narrow-to-region 1 tar-header-offset))) | |
1123 | (set-buffer-modified-p t) ; mark the tar file as modified | |
1124 | (set-buffer subfile) | |
1125 | (set-buffer-modified-p nil) ; mark the tar subfile as unmodified | |
97590737 | 1126 | (message "saved into tar-buffer `%s' -- remember to save that buffer!" |
0f8becaa | 1127 | (buffer-name tar-superior-buffer)) |
e865c5ce RS |
1128 | ;; Prevent ordinary saving from happening. |
1129 | t))) | |
aa73f29c RS |
1130 | |
1131 | ||
1132 | (defun tar-pad-to-blocksize () | |
1133 | "If we are being anal about tar file blocksizes, fix up the current buffer. | |
1134 | Leaves the region wide." | |
1135 | (if (null tar-anal-blocksize) | |
1136 | nil | |
1137 | (widen) | |
1138 | (let* ((last-desc (nth (1- (length tar-parse-info)) tar-parse-info)) | |
1139 | (start (tar-desc-data-start last-desc)) | |
1140 | (tokens (tar-desc-tokens last-desc)) | |
1141 | (link-p (tar-header-link-type tokens)) | |
1142 | (size (if link-p 0 (tar-header-size tokens))) | |
1143 | (data-end (+ start size)) | |
1144 | (bbytes (ash tar-anal-blocksize 9)) | |
1145 | (pad-to (+ bbytes (* bbytes (/ (1- data-end) bbytes)))) | |
628d6cef | 1146 | (inhibit-read-only t) ; ## |
aa73f29c RS |
1147 | ) |
1148 | ;; If the padding after the last data is too long, delete some; | |
1149 | ;; else insert some until we are padded out to the right number of blocks. | |
1150 | ;; | |
1151 | (goto-char (+ (or tar-header-offset 0) data-end)) | |
1152 | (if (> (1+ (buffer-size)) (+ (or tar-header-offset 0) pad-to)) | |
1153 | (delete-region (+ (or tar-header-offset 0) pad-to) (1+ (buffer-size))) | |
1154 | (insert (make-string (- (+ (or tar-header-offset 0) pad-to) | |
1155 | (1+ (buffer-size))) | |
1156 | 0))) | |
1157 | ))) | |
1158 | ||
1159 | ||
439fa06f RS |
1160 | ;; Used in write-file-hook to write tar-files out correctly. |
1161 | (defun tar-mode-maybe-write-tar-file () | |
aa73f29c | 1162 | ;; |
e865c5ce | 1163 | ;; If the current buffer is in Tar mode and has its header-offset set, |
aa73f29c RS |
1164 | ;; only write out the part of the file after the header-offset. |
1165 | ;; | |
1166 | (if (and (eq major-mode 'tar-mode) | |
1167 | (and (boundp 'tar-header-offset) tar-header-offset)) | |
1168 | (unwind-protect | |
1169 | (save-excursion | |
1170 | (tar-clear-modification-flags) | |
1171 | (widen) | |
1172 | ;; Doing this here confuses things - the region gets left too wide! | |
1173 | ;; I suppose this is run in a context where changing the buffer is bad. | |
1174 | ;; (tar-pad-to-blocksize) | |
1175 | (write-region tar-header-offset (1+ (buffer-size)) buffer-file-name nil t) | |
1176 | ;; return T because we've written the file. | |
1177 | t) | |
1178 | (narrow-to-region 1 tar-header-offset) | |
1179 | t) | |
1180 | ;; return NIL because we haven't. | |
1181 | nil)) | |
1182 | ||
1183 | \f | |
1184 | ;;; Patch it in. | |
1185 | ||
439fa06f | 1186 | (or (memq 'tar-mode-maybe-write-tar-file write-file-hooks) |
aa73f29c | 1187 | (setq write-file-hooks |
439fa06f | 1188 | (cons 'tar-mode-maybe-write-tar-file write-file-hooks))) |
aa73f29c | 1189 | |
aa73f29c RS |
1190 | (provide 'tar-mode) |
1191 | ||
c88ab9ce | 1192 | ;;; tar-mode.el ends here |