git.chise.org Git - elisp/gnus.git-/blob - lisp/base64.el

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