(risky-local-variable-p): VAL=nil has special meaning.

[emacs.git] / lisp / gnus / rfc2047.el

;;; rfc2047.el --- functions for encoding and decoding rfc2047 messages
;; Copyright (C) 1998, 1999, 2000, 2002 Free Software Foundation, Inc.

;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
;;      MORIOKA Tomohiko <morioka@jaist.ac.jp>
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

;;; Commentary:

;; RFC 2047 is "MIME (Multipurpose Internet Mail Extensions) Part
;; Three:  Message Header Extensions for Non-ASCII Text".

;;; Code:

(eval-when-compile
  (require 'cl)
  (defvar message-posting-charset))

(require 'qp)
(require 'mm-util)
;; Fixme: Avoid this (used for mail-parse-charset) mm dependence on gnus.
(require 'mail-prsvr)
(require 'base64)
(autoload 'mm-body-7-or-8 "mm-bodies")

(defvar rfc2047-header-encoding-alist
  '(("Newsgroups" . nil)
    ("Message-ID" . nil)
    ("\\(Resent-\\)?\\(From\\|Cc\\|To\\|Bcc\\|Reply-To\\|Sender\\)" .
     address-mime)
    (t . mime))
  "*Header/encoding method alist.
The list is traversed sequentially.  The keys can either be
header regexps or t.

The values can be:

1) nil, in which case no encoding is done;
2) `mime', in which case the header will be encoded according to RFC2047;
3) `address-mime', like `mime', but takes account of the rules for address
   fields (where quoted strings and comments must be treated separately);
4) a charset, in which case it will be encoded as that charset;
5) `default', in which case the field will be encoded as the rest
   of the article.")

(defvar rfc2047-charset-encoding-alist
  '((us-ascii . nil)
    (iso-8859-1 . Q)
    (iso-8859-2 . Q)
    (iso-8859-3 . Q)
    (iso-8859-4 . Q)
    (iso-8859-5 . B)
    (koi8-r . B)
    (iso-8859-7 . B)
    (iso-8859-8 . B)
    (iso-8859-9 . Q)
    (iso-8859-14 . Q)
    (iso-8859-15 . Q)
    (iso-2022-jp . B)
    (iso-2022-kr . B)
    (gb2312 . B)
    (big5 . B)
    (cn-big5 . B)
    (cn-gb . B)
    (cn-gb-2312 . B)
    (euc-kr . B)
    (iso-2022-jp-2 . B)
    (iso-2022-int-1 . B))
  "Alist of MIME charsets to RFC2047 encodings.
Valid encodings are nil, `Q' and `B'.  These indicate binary (no) encoding,
quoted-printable and base64 respectively.")

(defvar rfc2047-encoding-function-alist
  '((Q . rfc2047-q-encode-region)
    (B . rfc2047-b-encode-region)
    (nil . ignore))
  "Alist of RFC2047 encodings to encoding functions.")

(defvar rfc2047-q-encoding-alist
  '(("\\(Resent-\\)?\\(From\\|Cc\\|To\\|Bcc\\|Reply-To\\|Sender\\):"
     . "-A-Za-z0-9!*+/" )
    ;; = (\075), _ (\137), ? (\077) are used in the encoded word.
    ;; Avoid using 8bit characters.
    ;; Equivalent to "^\000-\007\011\013\015-\037\200-\377=_?"
    ("." . "\010\012\014\040-\074\076\100-\136\140-\177"))
  "Alist of header regexps and valid Q characters.")

;;;
;;; Functions for encoding RFC2047 messages
;;;

(defun rfc2047-narrow-to-field ()
  "Narrow the buffer to the header on the current line."
  (beginning-of-line)
  (narrow-to-region
   (point)
   (progn
     (forward-line 1)
     (if (re-search-forward "^[^ \n\t]" nil t)
         (progn
           (beginning-of-line)
           (point))
       (point-max))))
  (goto-char (point-min)))

(defvar rfc2047-encoding-type 'address-mime
  "The type of encoding done by `rfc2047-encode-region'.
This should be dynamically bound around calls to
`rfc2047-encode-region' to either `mime' or `address-mime'.  See
`rfc2047-header-encoding-alist', for definitions.")

(defun rfc2047-encode-message-header ()
  "Encode the message header according to `rfc2047-header-encoding-alist'.
Should be called narrowed to the head of the message."
  (interactive "*")
  (save-excursion
    (goto-char (point-min))
    (let (alist elem method)
      (while (not (eobp))
        (save-restriction
          (rfc2047-narrow-to-field)
          (if (not (rfc2047-encodable-p))
              (if (and (eq (mm-body-7-or-8) '8bit)
                       (mm-multibyte-p)
                       (mm-coding-system-p
                        (car message-posting-charset)))
                       ;; 8 bit must be decoded.
                       ;; Is message-posting-charset a coding system?
                       (mm-encode-coding-region
                        (point-min) (point-max)
                        (car message-posting-charset)))
            ;; We found something that may perhaps be encoded.
            (setq method nil
                  alist rfc2047-header-encoding-alist)
            (while (setq elem (pop alist))
              (when (or (and (stringp (car elem))
                             (looking-at (car elem)))
                        (eq (car elem) t))
                (setq alist nil
                      method (cdr elem))))
            (goto-char (point-min))
            (re-search-forward "^[^:]+: *" nil t)
            (cond
             ((eq method 'address-mime)
              (rfc2047-encode-region (point) (point-max)))
             ((eq method 'mime)
              (let (rfc2047-encoding-type)
                (rfc2047-encode-region (point) (point-max))))
             ((eq method 'default)
              (if (and (featurep 'mule)
                       (if (boundp 'default-enable-multibyte-characters)
                           default-enable-multibyte-characters)
                       mail-parse-charset)
                  (mm-encode-coding-region (point) (point-max)
                                           mail-parse-charset)))
             ((mm-coding-system-p method)
              (if (and (featurep 'mule)
                       (if (boundp 'default-enable-multibyte-characters)
                           default-enable-multibyte-characters))
                  (mm-encode-coding-region (point) (point-max) method)))
             ;; Hm.
             (t)))
          (goto-char (point-max)))))))

;; Fixme: This, and the require below may not be the Right Thing, but
;; should be safe just before release.  -- fx 2001-02-08
(eval-when-compile (defvar message-posting-charset))

(defun rfc2047-encodable-p ()
  "Return non-nil if any characters in current buffer need encoding in headers.
The buffer may be narrowed."
  (require 'message)                    ; for message-posting-charset
  (let ((charsets
         (mm-find-mime-charset-region (point-min) (point-max))))
    (and charsets (not (equal charsets (list message-posting-charset))))))

;; Use this syntax table when parsing into regions that may need
;; encoding.  Double quotes are string delimiters, backslash is
;; character quoting, and all other RFC 2822 special characters are
;; treated as punctuation so we can use forward-sexp/forward-word to
;; skip to the end of regions appropriately.  Nb. ietf-drums does
;; things differently.
(defconst rfc2047-syntax-table
  (let ((table (make-char-table 'syntax-table '(2))))
    (modify-syntax-entry ?\\ "\\" table)
    (modify-syntax-entry ?\" "\"" table)
    (modify-syntax-entry ?\( "." table)
    (modify-syntax-entry ?\) "." table)
    (modify-syntax-entry ?\< "." table)
    (modify-syntax-entry ?\> "." table)
    (modify-syntax-entry ?\[ "." table)
    (modify-syntax-entry ?\] "." table)
    (modify-syntax-entry ?: "." table)
    (modify-syntax-entry ?\; "." table)
    (modify-syntax-entry ?, "." table)
    (modify-syntax-entry ?@ "." table)
    table))

(defun rfc2047-encode-region (b e)
  "Encode words in region B to E that need encoding.
By default, the region is treated as containing RFC2822 addresses.
Dynamically bind `rfc2047-encoding-type' to change that."
  (save-restriction
    (narrow-to-region b e)
    (if (eq 'mime rfc2047-encoding-type)
        ;; Simple case -- treat as single word.
        (progn
          (goto-char (point-min))
          ;; Does it need encoding?
          (skip-chars-forward "\000-\177" e)
          (unless (eobp)
            (rfc2047-encode b e)))
      ;; `address-mime' case -- take care of quoted words, comments.
      (with-syntax-table rfc2047-syntax-table
        (let ((start (point))           ; start of current token
              end                       ; end of current token
              ;; Whether there's an encoded word before the current
              ;; tpken, either immediately or separated by space.
              last-encoded)
          (goto-char (point-min))
          (condition-case nil         ; in case of unbalanced quotes
              ;; Look for rfc2822-style: sequences of atoms, quoted
              ;; strings, specials, whitespace.  (Specials mustn't be
              ;; encoded.)
              (while (not (eobp))
                (setq start (point))
                ;; Skip whitespace.
                (unless (= 0 (skip-chars-forward " \t"))
                  (setq start (point)))
                (cond
                 ((not (char-after)))   ; eob
                 ;; else token start
                 ((eq ?\" (char-syntax (char-after)))
                  ;; Quoted word.
                  (forward-sexp)
                  (setq end (point))
                  ;; Does it need encoding?
                  (goto-char start)
                  (skip-chars-forward "\000-\177" end)
                  (if (= end (point))
                      (setq last-encoded  nil)
                    ;; It needs encoding.  Strip the quotes first,
                    ;; since encoded words can't occur in quotes.
                    (goto-char end)
                    (delete-backward-char 1)
                    (goto-char start)
                    (delete-char 1)
                    (when last-encoded
                      ;; There was a preceding quoted word.  We need
                      ;; to include any separating whitespace in this
                      ;; word to avoid it getting lost.
                      (skip-chars-backward " \t")
                      ;; A space is needed between the encoded words.
                      (insert ? )
                      (setq start (point)
                            end (1+ end)))
                    ;; Adjust the end position for the deleted quotes.
                    (rfc2047-encode start (- end 2))
                    (setq last-encoded t))) ; record that it was encoded
                 ((eq ?. (char-syntax (char-after)))
                  ;; Skip other delimiters, but record that they've
                  ;; potentially separated quoted words.
                  (forward-char)
                  (setq last-encoded nil))
                 (t                 ; normal token/whitespace sequence
                  ;; Find the end.
                  (forward-word 1)
                  (skip-chars-backward " \t")
                  (setq end (point))
                  ;; Deal with encoding and leading space as for
                  ;; quoted words.
                  (goto-char start)
                  (skip-chars-forward "\000-\177" end)
                  (if (= end (point))
                      (setq last-encoded  nil)
                    (when last-encoded
                      (goto-char start)
                      (skip-chars-backward " \t")
                      (insert ? )
                      (setq start (point)
                            end (1+ end)))
                    (rfc2047-encode start end)
                    (setq last-encoded t)))))
            (error (error "Invalid data for rfc2047 encoding: %s"
                          (buffer-substring b e)))))))
    (rfc2047-fold-region b (point))))

(defun rfc2047-encode-string (string)
  "Encode words in STRING.
By default, the string is treated as containing addresses (see
`rfc2047-special-chars')."
  (with-temp-buffer
    (insert string)
    (rfc2047-encode-region (point-min) (point-max))
    (buffer-string)))

(defun rfc2047-encode (b e)
  "Encode the word(s) in the region B to E.
By default, the region is treated as containing addresses (see
`rfc2047-special-chars')."
  (let* ((mime-charset (mm-find-mime-charset-region b e))
         (cs (if (> (length mime-charset) 1)
                 ;; Fixme: Instead of this, try to break region into
                 ;; parts that can be encoded separately.
                 (error "Can't rfc2047-encode `%s'"
                        (buffer-substring b e))
               (setq mime-charset (car mime-charset))
               (mm-charset-to-coding-system mime-charset)))
         ;; Fixme: Better, calculate the number of non-ASCII
         ;; characters, at least for 8-bit charsets.
         (encoding (if (assq mime-charset
                             rfc2047-charset-encoding-alist)
                       (cdr (assq mime-charset
                                  rfc2047-charset-encoding-alist))
                     'B))
         (start (concat
                 "=?" (downcase (symbol-name mime-charset)) "?"
                 (downcase (symbol-name encoding)) "?"))
         (first t))
    (if mime-charset
        (save-restriction
          (narrow-to-region b e)
          (when (eq encoding 'B)
            ;; break into lines before encoding
            (goto-char (point-min))
            (while (not (eobp))
              (goto-char (min (point-max) (+ 15 (point))))
              (unless (eobp)
                (insert ?\n))))
          (if (and (mm-multibyte-p)
                   (mm-coding-system-p cs))
              (mm-encode-coding-region (point-min) (point-max) cs))
          (funcall (cdr (assq encoding rfc2047-encoding-function-alist))
                   (point-min) (point-max))
          (goto-char (point-min))
          (while (not (eobp))
            (unless first
              (insert ? ))
            (setq first nil)
            (insert start)
            (end-of-line)
            (insert "?=")
            (forward-line 1))))))

(defun rfc2047-fold-region (b e)
  "Fold long lines in region B to E."
  (save-restriction
    (narrow-to-region b e)
    (goto-char (point-min))
    (let ((break nil)
          (qword-break nil)
          (bol (save-restriction
                 (widen)
                 (mm-point-at-bol))))
      (while (not (eobp))
        (when (and (or break qword-break) (> (- (point) bol) 76))
          (goto-char (or break qword-break))
          (setq break nil
                qword-break nil)
          (if (looking-at " \t")
              (insert ?\n)
            (insert "\n "))
          (setq bol (1- (point)))
          ;; Don't break before the first non-LWSP characters.
          (skip-chars-forward " \t")
          (unless (eobp) (forward-char 1)))
        (cond
         ((eq (char-after) ?\n)
          (forward-char 1)
          (setq bol (point)
                break nil
                qword-break nil)
          (skip-chars-forward " \t")
          (unless (or (eobp) (eq (char-after) ?\n))
            (forward-char 1)))
         ((eq (char-after) ?\r)
          (forward-char 1))
         ((memq (char-after) '(?  ?\t))
          (skip-chars-forward " \t")
          (setq break (1- (point))))
         ((not break)
          (if (not (looking-at "=\\?[^=]"))
              (if (eq (char-after) ?=)
                  (forward-char 1)
                (skip-chars-forward "^ \t\n\r="))
            (setq qword-break (point))
            (skip-chars-forward "^ \t\n\r")))
         (t
          (skip-chars-forward "^ \t\n\r"))))
      (when (and (or break qword-break) (> (- (point) bol) 76))
        (goto-char (or break qword-break))
        (setq break nil
              qword-break nil)
          (if (looking-at " \t")
              (insert ?\n)
            (insert "\n "))
        (setq bol (1- (point)))
        ;; Don't break before the first non-LWSP characters.
        (skip-chars-forward " \t")
        (unless (eobp) (forward-char 1))))))

(defun rfc2047-unfold-region (b e)
  "Unfold lines in region B to E."
  (save-restriction
    (narrow-to-region b e)
    (goto-char (point-min))
    (let ((bol (save-restriction
                 (widen)
                 (mm-point-at-bol)))
          (eol (mm-point-at-eol))
          leading)
      (forward-line 1)
      (while (not (eobp))
        (looking-at "[ \t]*")
        (setq leading (- (match-end 0) (match-beginning 0)))
        (if (< (- (mm-point-at-eol) bol leading) 76)
            (progn
              (goto-char eol)
              (delete-region eol (progn
                                   (skip-chars-forward "[ \t\n\r]+")
                                   (1- (point)))))
          (setq bol (mm-point-at-bol)))
        (setq eol (mm-point-at-eol))
        (forward-line 1)))))

(defun rfc2047-b-encode-region (b e)
  "Base64-encode the header contained in region B to E."
  (save-restriction
    (narrow-to-region (goto-char b) e)
    (while (not (eobp))
      (base64-encode-region (point) (progn (end-of-line) (point)) t)
      (if (and (bolp) (eolp))
          (delete-backward-char 1))
      (forward-line))))

(defun rfc2047-q-encode-region (b e)
  "Quoted-printable-encode the header in region B to E."
  (save-excursion
    (save-restriction
      (narrow-to-region (goto-char b) e)
      (let ((alist rfc2047-q-encoding-alist)
            (bol (save-restriction
                   (widen)
                   (mm-point-at-bol))))
        (while alist
          (when (looking-at (caar alist))
            (quoted-printable-encode-region b e nil (cdar alist))
            (subst-char-in-region (point-min) (point-max) ?  ?_)
            (setq alist nil))
          (pop alist))
        ;; The size of QP encapsulation is about 20, so set limit to
        ;; 56=76-20.
        (unless (< (- (point-max) (point-min)) 56)
          ;; Don't break if it could fit in one line.
          ;; Let rfc2047-encode-region break it later.
          (goto-char (1+ (point-min)))
          (while (and (not (bobp)) (not (eobp)))
            (goto-char (min (point-max) (+ 56 bol)))
            (search-backward "=" (- (point) 2) t)
            (unless (or (bobp) (eobp))
              (insert "\n")
              (setq bol (point)))))))))

;;;
;;; Functions for decoding RFC2047 messages
;;;

(defvar rfc2047-encoded-word-regexp
  "=\\?\\([^][\000-\040()<>@,\;:\\\"/?.=]+\\)\\?\\(B\\|Q\\)\\?\\([!->@-~ +]+\\)\\?=")

(defun rfc2047-decode-region (start end)
  "Decode MIME-encoded words in region between START and END."
  (interactive "r")
  (let ((case-fold-search t)
        b e)
    (save-excursion
      (save-restriction
        (narrow-to-region start end)
        (goto-char (point-min))
        ;; Remove whitespace between encoded words.
        (while (re-search-forward
                (concat "\\(" rfc2047-encoded-word-regexp "\\)"
                        "\\(\n?[ \t]\\)+"
                        "\\(" rfc2047-encoded-word-regexp "\\)")
                nil t)
          (delete-region (goto-char (match-end 1)) (match-beginning 6)))
        ;; Decode the encoded words.
        (setq b (goto-char (point-min)))
        (while (re-search-forward rfc2047-encoded-word-regexp nil t)
          (setq e (match-beginning 0))
          (insert (rfc2047-parse-and-decode
                   (prog1
                       (match-string 0)
                     (delete-region (match-beginning 0) (match-end 0)))))
          (when (and (mm-multibyte-p)
                     mail-parse-charset
                     (not (eq mail-parse-charset 'gnus-decoded)))
            (mm-decode-coding-region b e mail-parse-charset))
          (setq b (point)))
        (when (and (mm-multibyte-p)
                   mail-parse-charset
                   (not (eq mail-parse-charset 'us-ascii))
                   (not (eq mail-parse-charset 'gnus-decoded)))
          (mm-decode-coding-region b (point-max) mail-parse-charset))
        (rfc2047-unfold-region (point-min) (point-max))))))

(defun rfc2047-decode-string (string)
  "Decode the quoted-printable-encoded STRING and return the results."
  (let ((m (mm-multibyte-p)))
    (with-temp-buffer
      (when m
        (mm-enable-multibyte))
      (insert string)
      (inline
        (rfc2047-decode-region (point-min) (point-max)))
      (buffer-string))))

(defun rfc2047-parse-and-decode (word)
  "Decode WORD and return it if it is an encoded word.
Return WORD if not."
  (if (not (string-match rfc2047-encoded-word-regexp word))
      word
    (or
     (condition-case nil
         (rfc2047-decode
          (match-string 1 word)
          (upcase (match-string 2 word))
          (match-string 3 word))
       (error word))
     word)))

(defun rfc2047-decode (charset encoding string)
  "Decode STRING from the given MIME CHARSET in the given ENCODING.
Valid ENCODINGs are \"B\" and \"Q\".
If your Emacs implementation can't decode CHARSET, return nil."
  (if (stringp charset)
      (setq charset (intern (downcase charset))))
  (if (or (not charset)
          (eq 'gnus-all mail-parse-ignored-charsets)
          (memq 'gnus-all mail-parse-ignored-charsets)
          (memq charset mail-parse-ignored-charsets))
      (setq charset mail-parse-charset))
  (let ((cs (mm-charset-to-coding-system charset)))
    (if (and (not cs) charset
             (listp mail-parse-ignored-charsets)
             (memq 'gnus-unknown mail-parse-ignored-charsets))
        (setq cs (mm-charset-to-coding-system mail-parse-charset)))
    (when cs
      (when (and (eq cs 'ascii)
                 mail-parse-charset)
        (setq cs mail-parse-charset))
      ;; Ensure unibyte result in Emacs 20.
      (let (default-enable-multibyte-characters)
        (with-temp-buffer
          (mm-decode-coding-string
           (cond
            ((equal "B" encoding)
             (base64-decode-string string))
            ((equal "Q" encoding)
             (quoted-printable-decode-string
              (mm-replace-chars-in-string string ?_ ? )))
            (t (error "Invalid encoding: %s" encoding)))
           cs))))))

(provide 'rfc2047)

;;; rfc2047.el ends here