1 ;;; jka-compr.el --- reading/writing/loading compressed files
3 ;; Copyright (C) 1993, 1994, 1995, 1997 Free Software Foundation, Inc.
5 ;; Author: jka@ece.cmu.edu (Jay K. Adams)
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
28 ;; This package implements low-level support for reading, writing,
29 ;; and loading compressed files. It hooks into the low-level file
30 ;; I/O functions (including write-region and insert-file-contents) so
31 ;; that they automatically compress or uncompress a file if the file
32 ;; appears to need it (based on the extension of the file name).
33 ;; Packages like Rmail, VM, GNUS, and Info should be able to work
34 ;; with compressed files without modification.
39 ;; To use jka-compr, simply load this package, and edit as usual.
40 ;; Its operation should be transparent to the user (except for
41 ;; messages appearing when a file is being compressed or
44 ;; The variable, jka-compr-compression-info-list can be used to
45 ;; customize jka-compr to work with other compression programs.
46 ;; The default value of this variable allows jka-compr to work with
47 ;; Unix compress and gzip.
49 ;; If you are concerned about the stderr output of gzip and other
50 ;; compression/decompression programs showing up in your buffers, you
51 ;; should set the discard-error flag in the compression-info-list.
52 ;; This will cause the stderr of all programs to be discarded.
53 ;; However, it also causes emacs to call compression/uncompression
54 ;; programs through a shell (which is specified by jka-compr-shell).
55 ;; This may be a drag if, on your system, starting up a shell is
58 ;; If you don't want messages about compressing and decompressing
59 ;; to show up in the echo area, you can set the compress-name and
60 ;; decompress-name fields of the jka-compr-compression-info-list to
67 ;; jka-compr can coexist with crpyt++ if you take all the decompression
68 ;; entries out of the crypt-encoding-list. Clearly problems will arise if
69 ;; you have two programs trying to compress/decompress files. jka-compr
70 ;; will not "work with" crypt++ in the following sense: you won't be able to
71 ;; decode encrypted compressed files--that is, files that have been
72 ;; compressed then encrypted (in that order). Theoretically, crypt++ and
73 ;; jka-compr could properly handle a file that has been encrypted then
74 ;; compressed, but there is little point in trying to compress an encrypted
81 ;; jka-compr is a V19 adaptation of jka-compr for V18 of Emacs. Many people
82 ;; have made helpful suggestions, reported bugs, and even fixed bugs in
83 ;; jka-compr. I recall the following people as being particularly helpful.
92 ;; Andy Norman's ange-ftp was the inspiration for the original jka-compr for
93 ;; Version 18 of Emacs.
95 ;; After I had made progress on the original jka-compr for V18, I learned of a
96 ;; package written by Kazushi Jam Marukawa, called jam-zcat, that did exactly
97 ;; what I was trying to do. I looked over the jam-zcat source code and
98 ;; probably got some ideas from it.
103 (defgroup compression nil
104 "Data compression utilities"
107 (defgroup jka-compr nil
108 "jka-compr customization"
112 (defcustom jka-compr-shell
"sh"
113 "*Shell to be used for calling compression programs.
114 The value of this variable only matters if you want to discard the
115 stderr of a compression/decompression program (see the documentation
116 for `jka-compr-compression-info-list')."
120 (defvar jka-compr-use-shell t
)
123 ;;; I have this defined so that .Z files are assumed to be in unix
124 ;;; compress format; and .gz files, in gzip format.
125 (defcustom jka-compr-compression-info-list
127 ;; compr-message compr-prog compr-args
128 ;; uncomp-message uncomp-prog uncomp-args
129 ;; can-append auto-mode-flag]
130 '(["\\.Z\\(~\\|\\.~[0-9]+~\\)?\\'"
131 "compressing" "compress" ("-c")
132 "uncompressing" "uncompress" ("-c")
135 "zipping" "gzip" ("-c" "-q")
136 "unzipping" "gzip" ("-c" "-q" "-d")
138 ["\\.gz\\(~\\|\\.~[0-9]+~\\)?\\'"
139 "zipping" "gzip" ("-c" "-q")
140 "unzipping" "gzip" ("-c" "-q" "-d")
143 "List of vectors that describe available compression techniques.
144 Each element, which describes a compression technique, is a vector of
145 the form [REGEXP COMPRESS-MSG COMPRESS-PROGRAM COMPRESS-ARGS
146 UNCOMPRESS-MSG UNCOMPRESS-PROGRAM UNCOMPRESS-ARGS
147 APPEND-FLAG EXTENSION], where:
149 regexp is a regexp that matches filenames that are
150 compressed with this format
152 compress-msg is the message to issue to the user when doing this
153 type of compression (nil means no message)
155 compress-program is a program that performs this compression
157 compress-args is a list of args to pass to the compress program
159 uncompress-msg is the message to issue to the user when doing this
160 type of uncompression (nil means no message)
162 uncompress-program is a program that performs this compression
164 uncompress-args is a list of args to pass to the uncompress program
166 append-flag is non-nil if this compression technique can be
169 auto-mode flag non-nil means strip the regexp from file names
170 before attempting to set the mode.
172 Because of the way `call-process' is defined, discarding the stderr output of
173 a program adds the overhead of starting a shell each time the program is
175 :type
'(repeat (vector regexp
176 (choice :tag
"Compress Message"
177 (string :format
"%v")
178 (const :tag
"No Message" nil
))
179 (string :tag
"Compress Program")
180 (repeat :tag
"Compress Arguments" string
)
181 (choice :tag
"Uncompress Message"
182 (string :format
"%v")
183 (const :tag
"No Message" nil
))
184 (string :tag
"Uncompress Program")
185 (repeat :tag
"Uncompress Arguments" string
)
186 (boolean :tag
"Append")
187 (boolean :tag
"Auto Mode")))
190 (defvar jka-compr-mode-alist-additions
191 (list (cons "\\.tgz\\'" 'tar-mode
))
192 "A list of pairs to add to auto-mode-alist when jka-compr is installed.")
194 (defvar jka-compr-file-name-handler-entry
196 "The entry in `file-name-handler-alist' used by the jka-compr I/O functions.")
198 ;;; Functions for accessing the return value of jka-compr-get-compression-info
199 (defun jka-compr-info-regexp (info) (aref info
0))
200 (defun jka-compr-info-compress-message (info) (aref info
1))
201 (defun jka-compr-info-compress-program (info) (aref info
2))
202 (defun jka-compr-info-compress-args (info) (aref info
3))
203 (defun jka-compr-info-uncompress-message (info) (aref info
4))
204 (defun jka-compr-info-uncompress-program (info) (aref info
5))
205 (defun jka-compr-info-uncompress-args (info) (aref info
6))
206 (defun jka-compr-info-can-append (info) (aref info
7))
207 (defun jka-compr-info-strip-extension (info) (aref info
8))
210 (defun jka-compr-get-compression-info (filename)
211 "Return information about the compression scheme of FILENAME.
212 The determination as to which compression scheme, if any, to use is
213 based on the filename itself and `jka-compr-compression-info-list'."
214 (catch 'compression-info
215 (let ((case-fold-search nil
))
217 (function (lambda (x)
218 (and (string-match (jka-compr-info-regexp x
) filename
)
219 (throw 'compression-info x
))))
220 jka-compr-compression-info-list
)
224 (put 'compression-error
'error-conditions
'(compression-error file-error error
))
227 (defvar jka-compr-acceptable-retval-list
'(0 2 141))
230 (defun jka-compr-error (prog args infile message
&optional errfile
)
232 (let ((errbuf (get-buffer-create " *jka-compr-error*"))
233 (curbuf (current-buffer)))
234 (with-current-buffer errbuf
235 (widen) (erase-buffer)
236 (insert (format "Error while executing \"%s %s < %s\"\n\n"
238 (mapconcat 'identity args
" ")
242 (insert-file-contents errfile
)))
243 (display-buffer errbuf
))
245 (signal 'compression-error
246 (list "Opening input file" (format "error %s" message
) infile
)))
249 (defvar jka-compr-dd-program
253 (defvar jka-compr-dd-blocksize
256)
256 (defun jka-compr-partial-uncompress (prog message args infile beg len
)
257 "Call program PROG with ARGS args taking input from INFILE.
258 Fourth and fifth args, BEG and LEN, specify which part of the output
259 to keep: LEN chars starting BEG chars from the beginning."
260 (let* ((skip (/ beg jka-compr-dd-blocksize
))
261 (prefix (- beg
(* skip jka-compr-dd-blocksize
)))
262 (count (and len
(1+ (/ (+ len prefix
) jka-compr-dd-blocksize
))))
264 (err-file (jka-compr-make-temp-name))
265 (run-string (format "%s %s 2> %s | %s bs=%d skip=%d %s 2> /dev/null"
267 (mapconcat 'identity args
" ")
270 jka-compr-dd-blocksize
272 ;; dd seems to be unreliable about
273 ;; providing the last block. So, always
274 ;; read one more than you think you need.
275 (if count
(concat "count=" (1+ count
)) ""))))
278 (or (memq (call-process jka-compr-shell
281 jka-compr-acceptable-retval-list
)
283 (jka-compr-error prog args infile message err-file
))
285 (jka-compr-delete-temp-file err-file
))
287 ;; Delete the stuff after what we want, if there is any.
290 (< (+ start prefix len
) (point))
291 (delete-region (+ start prefix len
) (point)))
293 ;; Delete the stuff before what we want.
294 (delete-region start
(+ start prefix
))))
297 (defun jka-compr-call-process (prog message infile output temp args
)
298 (if jka-compr-use-shell
300 (let ((err-file (jka-compr-make-temp-name)))
305 (call-process jka-compr-shell infile
306 (if (stringp output
) nil output
)
309 (format "%s %s 2> %s %s"
311 (mapconcat 'identity args
" ")
316 jka-compr-acceptable-retval-list
)
318 (jka-compr-error prog args infile message err-file
))
320 (jka-compr-delete-temp-file err-file
)))
326 (if (stringp output
) temp output
)
329 (jka-compr-error prog args infile message
))
331 (and (stringp output
)
332 (with-current-buffer temp
333 (write-region (point-min) (point-max) output
)
337 ;;; Support for temp files. Much of this was inspired if not lifted
340 (defcustom jka-compr-temp-name-template
341 (expand-file-name "jka-com"
342 (or (getenv "TMPDIR") "/tmp/"))
343 "Prefix added to all temp files created by jka-compr.
344 There should be no more than seven characters after the final `/'."
348 (defvar jka-compr-temp-name-table
(make-vector 31 nil
))
350 (defun jka-compr-make-temp-name (&optional local-copy
)
351 "This routine will return the name of a new file."
354 (template (concat jka-compr-temp-name-template
"aa"))
355 (lastpos (1- (length template
)))
361 (aset template lastpos lastchar
)
362 (setq file
(concat (make-temp-name template
) "#"))
363 (setq entry
(intern file jka-compr-temp-name-table
))
364 (if (or (get entry
'active
)
365 (file-exists-p file
))
368 (setq lastchar
(1+ lastchar
))
371 (setq prevchar
(1+ prevchar
))
374 (error "Can't allocate temp file.")
375 (aset template
(1- lastpos
) prevchar
)))))
377 (put entry
'active
(not local-copy
))
378 (setq not-done nil
)))
383 (defun jka-compr-delete-temp-file (temp)
385 (put (intern temp jka-compr-temp-name-table
)
393 (defun jka-compr-write-region (start end file
&optional append visit
)
394 (let* ((filename (expand-file-name file
))
395 (visit-file (if (stringp visit
) (expand-file-name visit
) filename
))
396 (info (jka-compr-get-compression-info visit-file
)))
400 (let ((can-append (jka-compr-info-can-append info
))
401 (compress-program (jka-compr-info-compress-program info
))
402 (compress-message (jka-compr-info-compress-message info
))
403 (uncompress-program (jka-compr-info-uncompress-program info
))
404 (uncompress-message (jka-compr-info-uncompress-message info
))
405 (compress-args (jka-compr-info-compress-args info
))
406 (uncompress-args (jka-compr-info-uncompress-args info
))
407 (base-name (file-name-nondirectory visit-file
))
408 temp-file temp-buffer
)
410 (setq temp-buffer
(get-buffer-create " *jka-compr-wr-temp*"))
411 (with-current-buffer temp-buffer
412 (widen) (erase-buffer))
416 (file-exists-p filename
))
418 (let* ((local-copy (file-local-copy filename
))
419 (local-file (or local-copy filename
)))
421 (setq temp-file local-file
))
423 (setq temp-file
(jka-compr-make-temp-name)))
427 (message "%s %s..." compress-message base-name
))
429 (jka-compr-run-real-handler 'write-region
430 (list start end temp-file t
'dont
))
432 (jka-compr-call-process compress-program
433 (concat compress-message
440 (with-current-buffer temp-buffer
441 (jka-compr-run-real-handler 'write-region
442 (list (point-min) (point-max)
444 (and append can-append
) 'dont
))
447 (jka-compr-delete-temp-file temp-file
)
451 (message "%s %s...done" compress-message base-name
))
455 (setq buffer-file-name filename
)
456 (set-visited-file-modtime))
458 (setq buffer-file-name visit
)
459 (let ((buffer-file-name filename
))
460 (set-visited-file-modtime))))
462 (and (or (eq visit t
)
465 (message "Wrote %s" visit-file
))
469 (jka-compr-run-real-handler 'write-region
470 (list start end filename append visit
)))))
473 (defun jka-compr-insert-file-contents (file &optional visit beg end replace
)
474 (barf-if-buffer-read-only)
478 (error "Attempt to visit less than an entire file"))
480 (let* ((filename (expand-file-name file
))
481 (info (jka-compr-get-compression-info filename
)))
485 (let ((uncompress-message (jka-compr-info-uncompress-message info
))
486 (uncompress-program (jka-compr-info-uncompress-program info
))
487 (uncompress-args (jka-compr-info-uncompress-args info
))
488 (base-name (file-name-nondirectory filename
))
491 (jka-compr-run-real-handler 'file-local-copy
(list filename
)))
495 (setq local-file
(or local-copy filename
))
499 (setq buffer-file-name filename
))
501 (unwind-protect ; to make sure local-copy gets deleted
507 (message "%s %s..." uncompress-message base-name
))
509 (condition-case error-code
513 (goto-char (point-min)))
516 (jka-compr-partial-uncompress uncompress-program
517 (concat uncompress-message
525 ;; If visiting, bind off buffer-file-name so that
526 ;; file-locking will not ask whether we should
527 ;; really edit the buffer.
528 (let ((buffer-file-name
529 (if visit nil buffer-file-name
)))
530 (jka-compr-call-process uncompress-program
531 (concat uncompress-message
537 (setq size
(- (point) start
))
539 (let* ((del-beg (point))
540 (del-end (+ del-beg size
)))
541 (delete-region del-beg
542 (min del-end
(point-max)))))
545 (if (and (eq (car error-code
) 'file-error
)
546 (eq (nth 3 error-code
) local-file
))
548 (setq notfound error-code
)
550 (cons "Opening input file"
551 (nthcdr 2 error-code
))))
552 (signal (car error-code
) (cdr error-code
))))))
556 (file-exists-p local-copy
)
557 (delete-file local-copy
)))
563 (setq buffer-file-name filename
)
564 (set-visited-file-modtime)))
568 (message "%s %s...done" uncompress-message base-name
))
574 (cons "Opening input file" (nth 2 notfound
))))
576 ;; Run the functions that insert-file-contents would.
577 (let ((p after-insert-file-functions
)
580 (setq insval
(funcall (car p
) size
))
583 (or (integerp insval
)
584 (signal 'wrong-type-argument
585 (list 'integerp insval
)))
589 (list filename size
))
591 (jka-compr-run-real-handler 'insert-file-contents
592 (list file visit beg end replace
)))))
595 (defun jka-compr-file-local-copy (file)
596 (let* ((filename (expand-file-name file
))
597 (info (jka-compr-get-compression-info filename
)))
601 (let ((uncompress-message (jka-compr-info-uncompress-message info
))
602 (uncompress-program (jka-compr-info-uncompress-program info
))
603 (uncompress-args (jka-compr-info-uncompress-args info
))
604 (base-name (file-name-nondirectory filename
))
606 (jka-compr-run-real-handler 'file-local-copy
(list filename
)))
607 (temp-file (jka-compr-make-temp-name t
))
608 (temp-buffer (get-buffer-create " *jka-compr-flc-temp*"))
612 (setq local-file
(or local-copy filename
))
616 (with-current-buffer temp-buffer
620 (message "%s %s..." uncompress-message base-name
))
622 (jka-compr-call-process uncompress-program
623 (concat uncompress-message
632 (message "%s %s...done" uncompress-message base-name
))
635 (point-min) (point-max) temp-file nil
'dont
))
639 (file-exists-p local-copy
)
640 (delete-file local-copy
))
642 (kill-buffer temp-buffer
))
646 (jka-compr-run-real-handler 'file-local-copy
(list filename
)))))
649 ;;; Support for loading compressed files.
650 (defun jka-compr-load (file &optional noerror nomessage nosuffix
)
651 "Documented as original."
653 (let* ((local-copy (jka-compr-file-local-copy file
))
654 (load-file (or local-copy file
)))
658 (let (inhibit-file-name-operation
659 inhibit-file-name-handlers
)
661 (message "Loading %s..." file
))
663 (let ((load-force-doc-strings t
))
664 (load load-file noerror t t
))
667 (message "Loading %s...done." file
)))
669 (jka-compr-delete-temp-file local-copy
))
673 (defun jka-compr-byte-compiler-base-file-name (file)
674 (let ((info (jka-compr-get-compression-info file
)))
675 (if (and info
(jka-compr-info-strip-extension info
))
677 (substring file
0 (string-match (jka-compr-info-regexp info
) file
)))
680 (put 'write-region
'jka-compr
'jka-compr-write-region
)
681 (put 'insert-file-contents
'jka-compr
'jka-compr-insert-file-contents
)
682 (put 'file-local-copy
'jka-compr
'jka-compr-file-local-copy
)
683 (put 'load
'jka-compr
'jka-compr-load
)
684 (put 'byte-compiler-base-file-name
'jka-compr
685 'jka-compr-byte-compiler-base-file-name
)
687 (defun jka-compr-handler (operation &rest args
)
689 (let ((jka-op (get operation
'jka-compr
)))
692 (jka-compr-run-real-handler operation args
)))))
694 ;; If we are given an operation that we don't handle,
695 ;; call the Emacs primitive for that operation,
696 ;; and manipulate the inhibit variables
697 ;; to prevent the primitive from calling our handler again.
698 (defun jka-compr-run-real-handler (operation args
)
699 (let ((inhibit-file-name-handlers
700 (cons 'jka-compr-handler
701 (and (eq inhibit-file-name-operation operation
)
702 inhibit-file-name-handlers
)))
703 (inhibit-file-name-operation operation
))
704 (apply operation args
)))
706 ;;;###autoload(defun auto-compression-mode (&optional arg)
708 ;;;###autoloadToggle automatic file compression and uncompression.
709 ;;;###autoloadWith prefix argument ARG, turn auto compression on if positive, else off.
710 ;;;###autoloadReturns the new status of auto compression (non-nil means on)."
711 ;;;###autoload (interactive "P")
712 ;;;###autoload (if (not (fboundp 'jka-compr-installed-p))
713 ;;;###autoload (progn
714 ;;;###autoload (require 'jka-compr)
715 ;;;###autoload ;; That turned the mode on, so make it initially off.
716 ;;;###autoload (toggle-auto-compression)))
717 ;;;###autoload (toggle-auto-compression arg t))
719 (defun toggle-auto-compression (&optional arg message
)
720 "Toggle automatic file compression and uncompression.
721 With prefix argument ARG, turn auto compression on if positive, else off.
722 Returns the new status of auto compression (non-nil means on).
723 If the argument MESSAGE is non-nil, it means to print a message
724 saying whether the mode is now on or off."
726 (let* ((installed (jka-compr-installed-p))
729 (or (eq arg t
) (listp arg
) (and (integerp arg
) (> arg
0))))))
732 ((and flag installed
) t
) ; already installed
734 ((and (not flag
) (not installed
)) nil
) ; already not installed
740 (jka-compr-uninstall)))
745 (message "Automatic file (de)compression is now ON.")
746 (message "Automatic file (de)compression is now OFF.")))
750 (defun jka-compr-build-file-regexp ()
754 'jka-compr-info-regexp
755 jka-compr-compression-info-list
760 (defun jka-compr-install ()
762 This adds entries to `file-name-handler-alist' and `auto-mode-alist'
763 and `inhibit-first-line-modes-suffixes'."
765 (setq jka-compr-file-name-handler-entry
766 (cons (jka-compr-build-file-regexp) 'jka-compr-handler
))
768 (setq file-name-handler-alist
(cons jka-compr-file-name-handler-entry
769 file-name-handler-alist
))
772 (function (lambda (x)
773 (and (jka-compr-info-strip-extension x
)
774 ;; Make entries in auto-mode-alist so that modes
775 ;; are chosen right according to the file names
777 (setq auto-mode-alist
778 (cons (list (jka-compr-info-regexp x
)
781 ;; Also add these regexps to
782 ;; inhibit-first-line-modes-suffixes, so that a
783 ;; -*- line in the first file of a compressed tar
784 ;; file doesn't override tar-mode.
785 (setq inhibit-first-line-modes-suffixes
786 (cons (jka-compr-info-regexp x
)
787 inhibit-first-line-modes-suffixes
)))))
788 jka-compr-compression-info-list
)
789 (setq auto-mode-alist
790 (append auto-mode-alist jka-compr-mode-alist-additions
)))
793 (defun jka-compr-uninstall ()
794 "Uninstall jka-compr.
795 This removes the entries in `file-name-handler-alist' and `auto-mode-alist'
796 and `inhibit-first-line-modes-suffixes' that were added
797 by `jka-compr-installed'."
798 ;; Delete from inhibit-first-line-modes-suffixes
799 ;; what jka-compr-install added.
801 (function (lambda (x)
802 (and (jka-compr-info-strip-extension x
)
803 (setq inhibit-first-line-modes-suffixes
804 (delete (jka-compr-info-regexp x
)
805 inhibit-first-line-modes-suffixes
)))))
806 jka-compr-compression-info-list
)
808 (let* ((fnha (cons nil file-name-handler-alist
))
812 (if (eq (cdr (car (cdr last
))) 'jka-compr-handler
)
813 (setcdr last
(cdr (cdr last
)))
814 (setq last
(cdr last
))))
816 (setq file-name-handler-alist
(cdr fnha
)))
818 (let* ((ama (cons nil auto-mode-alist
))
823 (setq entry
(car (cdr last
)))
824 (if (or (member entry jka-compr-mode-alist-additions
)
825 (and (consp (cdr entry
))
826 (eq (nth 2 entry
) 'jka-compr
)))
827 (setcdr last
(cdr (cdr last
)))
828 (setq last
(cdr last
))))
830 (setq auto-mode-alist
(cdr ama
))))
833 (defun jka-compr-installed-p ()
834 "Return non-nil if jka-compr is installed.
835 The return value is the entry in `file-name-handler-alist' for jka-compr."
837 (let ((fnha file-name-handler-alist
)
840 (while (and fnha
(not installed
))
841 (and (eq (cdr (car fnha
)) 'jka-compr-handler
)
842 (setq installed
(car fnha
)))
843 (setq fnha
(cdr fnha
)))
848 ;;; Add the file I/O hook if it does not already exist.
849 ;;; Make sure that jka-compr-file-name-handler-entry is eq to the
850 ;;; entry for jka-compr in file-name-handler-alist.
851 (and (jka-compr-installed-p)
852 (jka-compr-uninstall))
859 ;; jka-compr.el ends here.