Importing pgnus-0.57
[elisp/gnus.git-] / lisp / binhex.el
1 ;;; binhex.el -- elisp native binhex decode
2 ;; Copyright (c) 1998 by Shenghuo Zhu <zsh@cs.rochester.edu>
3
4 ;; Author: Shenghuo Zhu <zsh@cs.rochester.edu>
5 ;; Create Date: Oct 1, 1998
6 ;; $Revision: 1.1.1.4 $
7 ;; Time-stamp: <Tue Oct  6 23:48:38 EDT 1998 zsh>
8 ;; Keywords: binhex
9   
10 ;; This file is not part of GNU Emacs, but the same permissions
11 ;; apply.
12
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; any later version.
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
24 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
27
28 ;;; Commentary:
29
30 ;;; Code:
31
32 (if (not (fboundp 'char-int))
33     (fset 'char-int 'identity))
34
35 (defvar binhex-decoder-program "hexbin"
36   "*Non-nil value should be a string that names a uu decoder.
37 The program should expect to read binhex data on its standard
38 input and write the converted data to its standard output.")
39
40 (defvar binhex-decoder-switches '("-d")
41   "*List of command line flags passed to the command named by binhex-decoder-program.")
42
43 (defconst binhex-alphabet-decoding-alist
44   '(( ?\! . 0) ( ?\" . 1) ( ?\# . 2) ( ?\$ . 3) ( ?\% . 4) ( ?\& . 5)
45     ( ?\' . 6) ( ?\( . 7) ( ?\) . 8) ( ?\* . 9) ( ?\+ . 10) ( ?\, . 11)
46     ( ?\- . 12) ( ?0 . 13) ( ?1 . 14) ( ?2 . 15) ( ?3 . 16) ( ?4 . 17)
47     ( ?5 . 18) ( ?6 . 19) ( ?8 . 20) ( ?9 . 21) ( ?@ . 22) ( ?A . 23)
48     ( ?B . 24) ( ?C . 25) ( ?D . 26) ( ?E . 27) ( ?F . 28) ( ?G . 29)
49     ( ?H . 30) ( ?I . 31) ( ?J . 32) ( ?K . 33) ( ?L . 34) ( ?M . 35)
50     ( ?N . 36) ( ?P . 37) ( ?Q . 38) ( ?R . 39) ( ?S . 40) ( ?T . 41)
51     ( ?U . 42) ( ?V . 43) ( ?X . 44) ( ?Y . 45) ( ?Z . 46) ( ?\[ . 47)
52     ( ?\` . 48) ( ?a . 49) ( ?b . 50) ( ?c . 51) ( ?d . 52) ( ?e . 53)
53     ( ?f . 54) ( ?h . 55) ( ?i . 56) ( ?j . 57) ( ?k . 58) ( ?l . 59)
54     ( ?m . 60) ( ?p . 61) ( ?q . 62) ( ?r . 63)))
55
56 (defun binhex-char-map (char)
57   (cdr (assq char binhex-alphabet-decoding-alist)))
58
59 ;;;###autoload
60 (defconst binhex-begin-line
61   "^:...............................................................$")
62 (defconst binhex-body-line
63   "^[^:]...............................................................$")
64 (defconst binhex-end-line ":$")
65
66 (defvar binhex-temporary-file-directory "/tmp/")
67
68 (if (string-match "XEmacs" emacs-version)
69     (defalias 'binhex-insert-char 'insert-char)
70   (defun binhex-insert-char (char &optional count ignored buffer)
71     (if (or (null buffer) (eq buffer (current-buffer)))
72         (insert-char char count)
73       (with-current-buffer buffer
74         (insert-char char count)))))
75
76 (defvar binhex-crc-table
77   [0  4129  8258  12387  16516  20645  24774  28903 
78       33032  37161  41290  45419  49548  53677  57806  61935 
79       4657  528  12915  8786  21173  17044  29431  25302 
80       37689  33560  45947  41818  54205  50076  62463  58334 
81       9314  13379  1056  5121  25830  29895  17572  21637 
82       42346  46411  34088  38153  58862  62927  50604  54669 
83       13907  9842  5649  1584  30423  26358  22165  18100 
84       46939  42874  38681  34616  63455  59390  55197  51132 
85       18628  22757  26758  30887  2112  6241  10242  14371 
86       51660  55789  59790  63919  35144  39273  43274  47403 
87       23285  19156  31415  27286  6769  2640  14899  10770 
88       56317  52188  64447  60318  39801  35672  47931  43802 
89       27814  31879  19684  23749  11298  15363  3168  7233 
90       60846  64911  52716  56781  44330  48395  36200  40265 
91       32407  28342  24277  20212  15891  11826  7761  3696 
92       65439  61374  57309  53244  48923  44858  40793  36728 
93       37256  33193  45514  41451  53516  49453  61774  57711 
94       4224  161  12482  8419  20484  16421  28742  24679 
95       33721  37784  41979  46042  49981  54044  58239  62302 
96       689  4752  8947  13010  16949  21012  25207  29270 
97       46570  42443  38312  34185  62830  58703  54572  50445 
98       13538  9411  5280  1153  29798  25671  21540  17413 
99       42971  47098  34713  38840  59231  63358  50973  55100 
100       9939  14066  1681  5808  26199  30326  17941  22068 
101       55628  51565  63758  59695  39368  35305  47498  43435 
102       22596  18533  30726  26663  6336  2273  14466  10403 
103       52093  56156  60223  64286  35833  39896  43963  48026 
104       19061  23124  27191  31254  2801  6864  10931  14994 
105       64814  60687  56684  52557  48554  44427  40424  36297 
106       31782  27655  23652  19525  15522  11395  7392  3265 
107       61215  65342  53085  57212  44955  49082  36825  40952 
108       28183  32310  20053  24180  11923  16050  3793  7920])
109
110 (defun binhex-update-crc (crc char &optional count)
111   (if (null count) (setq count 1))
112   (while (> count 0)
113     (setq crc (logxor (logand (lsh crc 8) 65280) 
114                       (aref binhex-crc-table 
115                             (logxor (logand (lsh crc -8) 255)
116                                     char)))
117           count (1- count)))
118   crc)
119
120 (defun binhex-verify-crc (buffer start end)
121   (with-current-buffer buffer
122     (let ((pos start) (crc 0) (last (- end 2)))
123       (while (< pos last)
124         (setq crc (binhex-update-crc crc (char-after pos))
125               pos (1+ pos)))
126       (if (= crc (binhex-string-big-endian (buffer-substring last end)))
127           nil
128         (error "CRC error")))))
129
130 (defun binhex-string-big-endian (string)
131   (let ((ret 0) (i 0) (len (length string)))
132     (while (< i len)
133       (setq ret (+ (lsh ret 8) (char-int (aref string i)))
134             i (1+ i)))
135     ret))
136
137 (defun binhex-string-little-endian (string)
138   (let ((ret 0) (i 0) (shift 0) (len (length string)))
139     (while (< i len)
140       (setq ret (+ ret (lsh (char-int (aref string i)) shift))
141             i (1+ i)
142             shift (+ shift 8)))
143     ret))
144
145 (defun binhex-header (buffer)
146   (with-current-buffer buffer
147     (let ((pos (point-min)) len)
148       (vector 
149        (prog1
150            (setq len (char-int (char-after pos)))
151          (setq pos (1+ pos)))
152        (buffer-substring pos (setq pos (+ pos len)))
153        (prog1
154            (setq len (char-int (char-after pos)))
155          (setq pos (1+ pos)))
156        (buffer-substring pos (setq pos (+ pos 4)))
157        (buffer-substring pos (setq pos (+ pos 4)))
158        (binhex-string-big-endian 
159         (buffer-substring pos (setq pos (+ pos 2))))
160        (binhex-string-big-endian 
161         (buffer-substring pos (setq pos (+ pos 4))))
162        (binhex-string-big-endian 
163         (buffer-substring pos (setq pos (+ pos 4))))))))
164
165 (defvar binhex-last-char)
166 (defvar binhex-repeat)
167
168 (defun binhex-push-char (char &optional count ignored buffer)
169   (cond 
170    (binhex-repeat 
171     (if (eq char 0)
172         (binhex-insert-char (setq binhex-last-char 144) 1 
173                             ignored buffer)
174       (binhex-insert-char binhex-last-char (- char 1) 
175                           ignored buffer)
176       (setq binhex-last-char nil))
177     (setq binhex-repeat nil))
178    ((= char 144)
179     (setq binhex-repeat t))
180    (t
181     (binhex-insert-char (setq binhex-last-char char) 1 ignored buffer))))
182
183 (defun binhex-decode-region (start end &optional header-only)
184   "Binhex decode region between START and END.
185 If HEADER-ONLY is non-nil only decode header and return filename."
186   (interactive "r")
187   (let ((work-buffer nil)
188         (counter 0)
189         (bits 0) (tmp t)
190         (lim 0) inputpos 
191         (non-data-chars " \t\n\r:")
192         file-name-length data-fork-start
193         header
194         binhex-last-char binhex-repeat)
195     (unwind-protect
196         (save-excursion
197           (goto-char start)
198           (when (re-search-forward binhex-begin-line end t)
199             (if (boundp 'enable-multibyte-characters)
200                 (let ((multibyte 
201                        (default-value 'enable-multibyte-characters)))
202                   (setq-default enable-multibyte-characters nil)
203                   (setq work-buffer 
204                         (generate-new-buffer " *binhex-work*"))
205                   (setq-default enable-multibyte-characters multibyte))
206               (setq work-buffer (generate-new-buffer " *binhex-work*")))
207             (buffer-disable-undo work-buffer)
208             (beginning-of-line)
209             (setq bits 0 counter 0)
210             (while tmp
211               (skip-chars-forward non-data-chars end)
212               (setq inputpos (point))
213               (end-of-line)
214               (setq lim (point))
215               (while (and (< inputpos lim)
216                           (setq tmp (binhex-char-map (char-after inputpos))))
217                 (setq bits (+ bits tmp)
218                       counter (1+ counter)
219                       inputpos (1+ inputpos))
220                 (cond ((= counter 4)
221                        (binhex-push-char (lsh bits -16) 1 nil work-buffer)
222                        (binhex-push-char (logand (lsh bits -8) 255) 1 nil
223                                          work-buffer)
224                        (binhex-push-char (logand bits 255) 1 nil
225                                          work-buffer)
226                        (setq bits 0 counter 0))
227                       (t (setq bits (lsh bits 6)))))
228               (if (null file-name-length)
229                   (with-current-buffer work-buffer
230                     (setq file-name-length (char-after (point-min))
231                           data-fork-start (+ (point-min)
232                                              file-name-length 22))))
233               (if (and (null header) 
234                        (with-current-buffer work-buffer
235                          (>= (buffer-size) data-fork-start)))
236                   (progn
237                     (binhex-verify-crc work-buffer 
238                                        1 data-fork-start)
239                     (setq header (binhex-header work-buffer))
240                     (if header-only (setq tmp nil counter 0))))
241               (setq tmp (and tmp (not (eq inputpos end)))))
242             (cond
243              ((= counter 3)
244               (binhex-push-char (logand (lsh bits -16) 255) 1 nil 
245                                 work-buffer)
246               (binhex-push-char (logand (lsh bits -8) 255) 1 nil
247                                 work-buffer))
248              ((= counter 2)
249               (binhex-push-char (logand (lsh bits -10) 255) 1 nil 
250                                 work-buffer))))
251       (if header-only nil
252         (binhex-verify-crc work-buffer
253                            data-fork-start 
254                            (+ data-fork-start (aref header 6) 2))
255         (or (markerp end) (setq end (set-marker (make-marker) end)))
256         (goto-char start)
257         (insert-buffer-substring work-buffer 
258                                  data-fork-start (+ data-fork-start
259                                                     (aref header 6)))
260         (delete-region (point) end)))
261       (and work-buffer (kill-buffer work-buffer)))
262     (if header (aref header 1))))
263
264 (defun binhex-decode-region-external (start end)
265   "Binhex decode region between START and END using external decoder"
266   (interactive "r")
267   (let ((cbuf (current-buffer)) firstline work-buffer status
268         (file-name (concat binhex-temporary-file-directory 
269                            (binhex-decode-region start end t)
270                            ".data")))
271     (save-excursion
272       (goto-char start)
273       (when (re-search-forward binhex-begin-line nil t)
274         (let ((cdir default-directory) default-process-coding-system)
275           (unwind-protect
276               (progn
277                 (set-buffer (setq work-buffer 
278                                   (generate-new-buffer " *binhex-work*")))
279                 (buffer-disable-undo work-buffer)
280                 (insert-buffer-substring cbuf firstline end)
281                 (cd binhex-temporary-file-directory)
282                 (apply 'call-process-region
283                        (point-min)
284                        (point-max)
285                        binhex-decoder-program 
286                        nil
287                        nil
288                        nil
289                        binhex-decoder-switches))
290             (cd cdir) (set-buffer cbuf)))
291         (if (and file-name (file-exists-p file-name))
292             (progn
293               (goto-char start)
294               (delete-region start end)
295               (let (format-alist)
296                 (insert-file-contents-literally file-name)))
297           (error "Can not binhex")))
298       (and work-buffer (kill-buffer work-buffer))
299       (condition-case ()
300           (if file-name (delete-file file-name))
301         (error))
302       )))
303
304 (provide 'binhex)
305
306 ;;; binhex.el ends here
307
308