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       (ignore-errors
 100         (delete-file tempfile)))))
 101
 102 (if (string-match "XEmacs" emacs-version)
 103     (defalias 'base64-insert-char 'insert-char)
 104   (defun base64-insert-char (char &optional count ignored buffer)
 105     (if (or (null buffer) (eq buffer (current-buffer)))
 106         (insert-char char count)
 107       (with-current-buffer buffer
 108         (insert-char char count)))))
 109
 110 (defun-maybe base64-decode-region (start end)
 111   (interactive "r")
 112   ;;(message "Decoding base64...")
 113   (let ((work-buffer nil)
 114         (done nil)
 115         (counter 0)
 116         (bits 0)
 117         (lim 0) inputpos
 118         (non-data-chars (concat "^=" base64-alphabet)))
 119     (unwind-protect
 120         (save-excursion
 121           (setq work-buffer (generate-new-buffer " *base64-work*"))
 122           (buffer-disable-undo work-buffer)
 123           (if base64-decoder-program
 124               (let* ((binary-process-output t) ; any text already has CRLFs
 125                      (status (apply 'base64-run-command-on-region
 126                                    start end work-buffer
 127                                    base64-decoder-program
 128                                    base64-decoder-switches)))
 129                 (if (not (eq status t))
 130                     (error "%s" (cdr status))))
 131             (goto-char start)
 132             (skip-chars-forward non-data-chars end)
 133             (while (not done)
 134               (setq inputpos (point))
 135               (cond
 136                ((> (skip-chars-forward base64-alphabet end) 0)
 137                 (setq lim (point))
 138                 (while (< inputpos lim)
 139                   (setq bits (+ bits
 140                                 (aref base64-alphabet-decoding-vector
 141                                       (char-int (char-after inputpos)))))
 142                   (setq counter (1+ counter)
 143                         inputpos (1+ inputpos))
 144                   (cond ((= counter 4)
 145                          (base64-insert-char (lsh bits -16) 1 nil work-buffer)
 146                          (base64-insert-char (logand (lsh bits -8) 255) 1 nil
 147                                          work-buffer)
 148                          (base64-insert-char (logand bits 255) 1 nil
 149                                              work-buffer)
 150                          (setq bits 0 counter 0))
 151                         (t (setq bits (lsh bits 6)))))))
 152               (cond
 153                ((= (point) end)
 154                 (if (not (zerop counter))
 155                     (error "at least %d bits missing at end of base64 encoding"
 156                            (* (- 4 counter) 6)))
 157                 (setq done t))
 158                ((eq (char-after (point)) ?=)
 159                 (setq done t)
 160                 (cond ((= counter 1)
 161                        (error "at least 2 bits missing at end of base64 encoding"))
 162                       ((= counter 2)
 163                        (base64-insert-char (lsh bits -10) 1 nil work-buffer))
 164                       ((= counter 3)
 165                        (base64-insert-char (lsh bits -16) 1 nil work-buffer)
 166                        (base64-insert-char (logand (lsh bits -8) 255)
 167                                            1 nil work-buffer))
 168                       ((= counter 0) t)))
 169                (t (skip-chars-forward non-data-chars end)))))
 170           (or (markerp end) (setq end (set-marker (make-marker) end)))
 171           (goto-char start)
 172           (insert-buffer-substring work-buffer)
 173           (delete-region (point) end))
 174       (and work-buffer (kill-buffer work-buffer))))
 175   ;;(message "Decoding base64... done")
 176   )
 177
 178 (defun-maybe base64-encode-region (start end &optional no-line-break)
 179   (interactive "r")
 180   (message "Encoding base64...")
 181   (let ((work-buffer nil)
 182         (counter 0)
 183         (cols 0)
 184         (bits 0)
 185         (alphabet base64-alphabet)
 186         inputpos)
 187     (unwind-protect
 188         (save-excursion
 189           (setq work-buffer (generate-new-buffer " *base64-work*"))
 190           (buffer-disable-undo work-buffer)
 191           (if base64-encoder-program
 192               (let ((status (apply 'base64-run-command-on-region
 193                                    start end work-buffer
 194                                    base64-encoder-program
 195                                    base64-encoder-switches)))
 196                 (if (not (eq status t))
 197                     (error "%s" (cdr status))))
 198             (setq inputpos start)
 199             (while (< inputpos end)
 200               (setq bits (+ bits (char-int (char-after inputpos))))
 201               (setq counter (1+ counter))
 202               (cond ((= counter 3)
 203                      (base64-insert-char (aref alphabet (lsh bits -18)) 1 nil
 204                                          work-buffer)
 205                      (base64-insert-char
 206                       (aref alphabet (logand (lsh bits -12) 63))
 207                       1 nil work-buffer)
 208                      (base64-insert-char
 209                       (aref alphabet (logand (lsh bits -6) 63))
 210                       1 nil work-buffer)
 211                      (base64-insert-char
 212                       (aref alphabet (logand bits 63))
 213                       1 nil work-buffer)
 214                      (setq cols (+ cols 4))
 215                      (cond ((and (= cols 72)
 216                                  (not no-line-break))
 217                             (base64-insert-char ?\n 1 nil work-buffer)
 218                             (setq cols 0)))
 219                      (setq bits 0 counter 0))
 220                     (t (setq bits (lsh bits 8))))
 221               (setq inputpos (1+ inputpos)))
 222             ;; write out any remaining bits with appropriate padding
 223             (if (= counter 0)
 224                 nil
 225               (setq bits (lsh bits (- 16 (* 8 counter))))
 226               (base64-insert-char (aref alphabet (lsh bits -18)) 1 nil
 227                                   work-buffer)
 228               (base64-insert-char (aref alphabet (logand (lsh bits -12) 63))
 229                                   1 nil work-buffer)
 230               (if (= counter 1)
 231                   (base64-insert-char ?= 2 nil work-buffer)
 232                 (base64-insert-char (aref alphabet (logand (lsh bits -6) 63))
 233                                     1 nil work-buffer)
 234                 (base64-insert-char ?= 1 nil work-buffer)))
 235             (if (and (> cols 0)
 236                      (not no-line-break))
 237                 (base64-insert-char ?\n 1 nil work-buffer)))
 238           (or (markerp end) (setq end (set-marker (make-marker) end)))
 239           (goto-char start)
 240           (insert-buffer-substring work-buffer)
 241           (delete-region (point) end))
 242       (and work-buffer (kill-buffer work-buffer))))
 243   (message "Encoding base64... done"))
 244
 245 (defun base64-encode (string)
 246   (save-excursion
 247     (set-buffer (get-buffer-create " *base64-encode*"))
 248     (erase-buffer)
 249     (insert string)
 250     (base64-encode-region (point-min) (point-max))
 251     (skip-chars-backward " \t\r\n")
 252     (delete-region (point-max) (point))
 253     (prog1
 254         (buffer-string)
 255       (kill-buffer (current-buffer)))))
 256
 257 (defun base64-decode (string)
 258   (save-excursion
 259     (set-buffer (get-buffer-create " *base64-decode*"))
 260     (erase-buffer)
 261     (insert string)
 262     (base64-decode-region (point-min) (point-max))
 263     (goto-char (point-max))
 264     (skip-chars-backward " \t\r\n")
 265     (delete-region (point-max) (point))
 266     (prog1
 267         (buffer-string)
 268       (kill-buffer (current-buffer)))))
 269
 270 (fset 'base64-decode-string 'base64-decode)
 271
 272 (provide 'base64)