1 ;;; base64.el,v --- Base64 encoding functions
2 ;; Author: Kyle E. Jones
3 ;; Created: 1997/03/12 14:37:09
5 ;; Keywords: extensions
7 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
8 ;;; Copyright (C) 1997 Kyle E. Jones
10 ;;; This file is not part of GNU Emacs, but the same permissions apply.
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
14 ;;; the Free Software Foundation; either version 2, or (at your option)
15 ;;; any later version.
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.
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 the
24 ;;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;;; Boston, MA 02111-1307, USA.
26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
29 (if (not (fboundp 'char-int))
30 (fset 'char-int 'identity))
32 (defvar base64-alphabet
33 "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/")
35 (defvar base64-decoder-program nil
36 "*Non-nil value should be a string that names a MIME base64 decoder.
37 The program should expect to read base64 data on its standard
38 input and write the converted data to its standard output.")
40 (defvar base64-decoder-switches nil
41 "*List of command line flags passed to the command named by
42 base64-decoder-program.")
44 (defvar base64-encoder-program nil
45 "*Non-nil value should be a string that names a MIME base64 encoder.
46 The program should expect arbitrary data on its standard
47 input and write base64 data to its standard output.")
49 (defvar base64-encoder-switches nil
50 "*List of command line flags passed to the command named by
51 base64-encoder-program.")
53 (defconst base64-alphabet-decoding-alist
55 ( ?A . 00) ( ?B . 01) ( ?C . 02) ( ?D . 03) ( ?E . 04) ( ?F . 05)
56 ( ?G . 06) ( ?H . 07) ( ?I . 08) ( ?J . 09) ( ?K . 10) ( ?L . 11)
57 ( ?M . 12) ( ?N . 13) ( ?O . 14) ( ?P . 15) ( ?Q . 16) ( ?R . 17)
58 ( ?S . 18) ( ?T . 19) ( ?U . 20) ( ?V . 21) ( ?W . 22) ( ?X . 23)
59 ( ?Y . 24) ( ?Z . 25) ( ?a . 26) ( ?b . 27) ( ?c . 28) ( ?d . 29)
60 ( ?e . 30) ( ?f . 31) ( ?g . 32) ( ?h . 33) ( ?i . 34) ( ?j . 35)
61 ( ?k . 36) ( ?l . 37) ( ?m . 38) ( ?n . 39) ( ?o . 40) ( ?p . 41)
62 ( ?q . 42) ( ?r . 43) ( ?s . 44) ( ?t . 45) ( ?u . 46) ( ?v . 47)
63 ( ?w . 48) ( ?x . 49) ( ?y . 50) ( ?z . 51) ( ?0 . 52) ( ?1 . 53)
64 ( ?2 . 54) ( ?3 . 55) ( ?4 . 56) ( ?5 . 57) ( ?6 . 58) ( ?7 . 59)
65 ( ?8 . 60) ( ?9 . 61) ( ?+ . 62) ( ?/ . 63)
68 (defvar base64-alphabet-decoding-vector
69 (let ((v (make-vector 123 nil))
70 (p base64-alphabet-decoding-alist))
72 (aset v (car (car p)) (cdr (car p)))
76 (defvar base64-binary-coding-system 'binary)
78 (defun base64-run-command-on-region (start end output-buffer command
80 (let ((tempfile nil) status errstring default-process-coding-system
81 (coding-system-for-write base64-binary-coding-system)
82 (coding-system-for-read base64-binary-coding-system))
85 (setq tempfile (make-temp-name "base64"))
87 (apply 'call-process-region
89 (list output-buffer tempfile)
91 (cond ((equal status 0) t)
92 ((zerop (save-excursion
93 (set-buffer (find-file-noselect tempfile))
97 (set-buffer (find-file-noselect tempfile))
98 (setq errstring (buffer-string))
100 (cons status errstring)))))
102 (delete-file tempfile)))))
104 (if (string-match "XEmacs" emacs-version)
105 (defalias 'base64-insert-char 'insert-char)
106 (defun base64-insert-char (char &optional count ignored buffer)
107 (if (or (null buffer) (eq buffer (current-buffer)))
108 (insert-char char count)
109 (with-current-buffer buffer
110 (insert-char char count))))
111 (setq base64-binary-coding-system 'no-conversion))
113 (defun base64-decode-region (start end)
115 ;;(message "Decoding base64...")
116 (let ((work-buffer nil)
121 (non-data-chars (concat "^=" base64-alphabet)))
124 (setq work-buffer (generate-new-buffer " *base64-work*"))
125 (buffer-disable-undo work-buffer)
126 (if base64-decoder-program
127 (let* ((binary-process-output t) ; any text already has CRLFs
128 (status (apply 'base64-run-command-on-region
129 start end work-buffer
130 base64-decoder-program
131 base64-decoder-switches)))
132 (if (not (eq status t))
133 (error "%s" (cdr status))))
135 (skip-chars-forward non-data-chars end)
137 (setq inputpos (point))
139 ((> (skip-chars-forward base64-alphabet end) 0)
141 (while (< inputpos lim)
143 (aref base64-alphabet-decoding-vector
144 (char-int (char-after inputpos)))))
145 (setq counter (1+ counter)
146 inputpos (1+ inputpos))
148 (base64-insert-char (lsh bits -16) 1 nil work-buffer)
149 (base64-insert-char (logand (lsh bits -8) 255) 1 nil
151 (base64-insert-char (logand bits 255) 1 nil
153 (setq bits 0 counter 0))
154 (t (setq bits (lsh bits 6)))))))
157 (if (not (zerop counter))
158 (error "at least %d bits missing at end of base64 encoding"
159 (* (- 4 counter) 6)))
161 ((eq (char-after (point)) ?=)
164 (error "at least 2 bits missing at end of base64 encoding"))
166 (base64-insert-char (lsh bits -10) 1 nil work-buffer))
168 (base64-insert-char (lsh bits -16) 1 nil work-buffer)
169 (base64-insert-char (logand (lsh bits -8) 255)
172 (t (skip-chars-forward non-data-chars end)))))
173 (or (markerp end) (setq end (set-marker (make-marker) end)))
175 (insert-buffer-substring work-buffer)
176 (delete-region (point) end))
177 (and work-buffer (kill-buffer work-buffer))))
178 ;;(message "Decoding base64... done")
181 (defun base64-encode-region (start end &optional no-line-break)
183 (message "Encoding base64...")
184 (let ((work-buffer nil)
188 (alphabet base64-alphabet)
192 (setq work-buffer (generate-new-buffer " *base64-work*"))
193 (buffer-disable-undo work-buffer)
194 (if base64-encoder-program
195 (let ((status (apply 'base64-run-command-on-region
196 start end work-buffer
197 base64-encoder-program
198 base64-encoder-switches)))
199 (if (not (eq status t))
200 (error "%s" (cdr status))))
201 (setq inputpos start)
202 (while (< inputpos end)
203 (setq bits (+ bits (char-int (char-after inputpos))))
204 (setq counter (1+ counter))
206 (base64-insert-char (aref alphabet (lsh bits -18)) 1 nil
209 (aref alphabet (logand (lsh bits -12) 63))
212 (aref alphabet (logand (lsh bits -6) 63))
215 (aref alphabet (logand bits 63))
217 (setq cols (+ cols 4))
218 (cond ((and (= cols 72)
220 (base64-insert-char ?\n 1 nil work-buffer)
222 (setq bits 0 counter 0))
223 (t (setq bits (lsh bits 8))))
224 (setq inputpos (1+ inputpos)))
225 ;; write out any remaining bits with appropriate padding
228 (setq bits (lsh bits (- 16 (* 8 counter))))
229 (base64-insert-char (aref alphabet (lsh bits -18)) 1 nil
231 (base64-insert-char (aref alphabet (logand (lsh bits -12) 63))
234 (base64-insert-char ?= 2 nil work-buffer)
235 (base64-insert-char (aref alphabet (logand (lsh bits -6) 63))
237 (base64-insert-char ?= 1 nil work-buffer)))
240 (base64-insert-char ?\n 1 nil work-buffer)))
241 (or (markerp end) (setq end (set-marker (make-marker) end)))
243 (insert-buffer-substring work-buffer)
244 (delete-region (point) end))
245 (and work-buffer (kill-buffer work-buffer))))
246 (message "Encoding base64... done"))
248 (defun base64-encode (string)
250 (set-buffer (get-buffer-create " *base64-encode*"))
253 (base64-encode-region (point-min) (point-max))
254 (skip-chars-backward " \t\r\n")
255 (delete-region (point-max) (point))
258 (kill-buffer (current-buffer)))))
260 (defun base64-decode (string)
262 (set-buffer (get-buffer-create " *base64-decode*"))
265 (base64-decode-region (point-min) (point-max))
266 (goto-char (point-max))
267 (skip-chars-backward " \t\r\n")
268 (delete-region (point-max) (point))
271 (kill-buffer (current-buffer)))))
273 (fset 'base64-decode-string 'base64-decode)