cgit.sxemacs.org Git - gnus/blob - lisp/mm-bodies.el

   1 ;;; mm-bodies.el --- Functions for decoding MIME things
   2
   3 ;; Copyright (C) 1998, 1999, 2000, 2001
   4 ;;        Free Software Foundation, Inc.
   5
   6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   7 ;;      MORIOKA Tomohiko <morioka@jaist.ac.jp>
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24
  25 ;;; Commentary:
  26
  27 ;;; Code:
  28
  29 (eval-and-compile
  30   (or (fboundp  'base64-decode-region)
  31       (require 'base64)))
  32
  33 (eval-when-compile
  34   (defvar mm-uu-decode-function)
  35   (defvar mm-uu-binhex-decode-function))
  36
  37 (require 'mm-util)
  38 (require 'rfc2047)
  39 (require 'mm-encode)
  40
  41 ;; 8bit treatment gets any char except: 0x32 - 0x7f, CR, LF, TAB, BEL,
  42 ;; BS, vertical TAB, form feed, and ^_
  43 (defvar mm-7bit-chars "\x20-\x7f\r\n\t\x7\x8\xb\xc\x1f")
  44
  45 (defcustom mm-body-charset-encoding-alist
  46   '((iso-2022-jp . 7bit)
  47     (iso-2022-jp-2 . 7bit))
  48   "Alist of MIME charsets to encodings.
  49 Valid encodings are `7bit', `8bit', `quoted-printable' and `base64'."
  50   :type '(repeat (cons (symbol :tag "charset")
  51                        (choice :tag "encoding"
  52                                (const 7bit)
  53                                (const 8bit)
  54                                (const quoted-printable)
  55                                (const base64))))
  56   :group 'mime)
  57
  58 (defun mm-encode-body (&optional charset)
  59   "Encode a body.
  60 Should be called narrowed to the body that is to be encoded.
  61 If there is more than one non-ASCII MULE charset, then list of found
  62 MULE charsets are returned.
  63 If CHARSET is non-nil, it is used.
  64 If successful, the MIME charset is returned.
  65 If no encoding was done, nil is returned."
  66   (if (not (mm-multibyte-p))
  67       ;; In the non-Mule case, we search for non-ASCII chars and
  68       ;; return the value of `mail-parse-charset' if any are found.
  69       (or charset
  70           (save-excursion
  71             (goto-char (point-min))
  72             (if (re-search-forward "[^\x0-\x7f]" nil t)
  73                 (or mail-parse-charset
  74                     (message-options-get 'mm-encody-body-charset)
  75                     (message-options-set
  76                      'mm-encody-body-charset
  77                      (mm-read-charset "Charset used in the article: ")))
  78               ;; The logic in `mml-generate-mime-1' confirms that it's OK
  79               ;; to return nil here.
  80               nil)))
  81     (save-excursion
  82       (if charset
  83           (progn
  84             (mm-encode-coding-region (point-min) (point-max) charset)
  85             charset)
  86         (goto-char (point-min))
  87         (let ((charsets (mm-find-mime-charset-region (point-min) (point-max)
  88                                                      mm-hack-charsets))
  89               start)
  90           (cond
  91            ;; No encoding.
  92            ((null charsets)
  93             nil)
  94            ;; Too many charsets.
  95            ((> (length charsets) 1)
  96             charsets)
  97            ;; We encode.
  98            (t
  99             (setq charset (car charsets))
 100             (while (not (eobp))
 101               (if (eq (mm-charset-after) 'ascii)
 102                   (when start
 103                     (save-restriction
 104                       (narrow-to-region start (point))
 105                       (mm-encode-coding-region
 106                        start (point) (mm-charset-to-coding-system charset))
 107                       (goto-char (point-max)))
 108                     (setq start nil))
 109                 (unless start
 110                   (setq start (point))))
 111               (forward-char 1))
 112             (when start
 113               (mm-encode-coding-region start (point)
 114                                        (mm-charset-to-coding-system charset))
 115               (setq start nil))
 116             charset)))))))
 117
 118 (defun mm-long-lines-p (length)
 119   "Say whether any of the lines in the buffer is longer than LINES."
 120   (save-excursion
 121     (goto-char (point-min))
 122     (end-of-line)
 123     (while (and (not (eobp))
 124                 (not (> (current-column) length)))
 125       (forward-line 1)
 126       (end-of-line))
 127     (and (> (current-column) length)
 128          (current-column))))
 129
 130 (defvar message-posting-charset)
 131
 132 (defun mm-body-encoding (charset &optional encoding)
 133   "Do Content-Transfer-Encoding and return the encoding of the current buffer."
 134   (when (stringp encoding)
 135     (setq encoding (intern (downcase encoding))))
 136   (let ((bits (mm-body-7-or-8))
 137         (longp (mm-long-lines-p 1000)))
 138     (require 'message)
 139     (cond
 140      ((and (not mm-use-ultra-safe-encoding)
 141            (not longp)
 142            (eq bits '7bit))
 143       bits)
 144      ((and (not mm-use-ultra-safe-encoding)
 145            (not longp)
 146            (or (eq t (cdr message-posting-charset))
 147                (memq charset (cdr message-posting-charset))
 148                (eq charset mail-parse-charset)))
 149       bits)
 150      (t
 151       (let ((encoding (or encoding
 152                           (cdr (assq charset mm-body-charset-encoding-alist))
 153                           (mm-qp-or-base64))))
 154         (when mm-use-ultra-safe-encoding
 155           (setq encoding (mm-safer-encoding encoding)))
 156         (mm-encode-content-transfer-encoding encoding "text/plain")
 157         encoding)))))
 158
 159 (defun mm-body-7-or-8 ()
 160   "Say whether the body is 7bit or 8bit."
 161   (cond
 162    ((not (featurep 'mule))
 163     (if (save-excursion
 164           (goto-char (point-min))
 165           (skip-chars-forward mm-7bit-chars)
 166           (eobp))
 167         '7bit
 168       '8bit))
 169    (t
 170     ;; Mule version
 171     (if (and (null (delq 'ascii
 172                          (mm-find-charset-region (point-min) (point-max))))
 173              ;;!!!The following is necessary because the function
 174              ;;!!!above seems to return the wrong result under
 175              ;;!!!Emacs 20.3.  Sometimes.
 176              (save-excursion
 177                (goto-char (point-min))
 178                (skip-chars-forward mm-7bit-chars)
 179                (eobp)))
 180         '7bit
 181       '8bit))))
 182
 183 ;;;
 184 ;;; Functions for decoding
 185 ;;;
 186
 187 (defun mm-decode-content-transfer-encoding (encoding &optional type)
 188   "Decodes buffer encoded with ENCODING, returning success status.
 189 If TYPE is `text/plain' CRLF->LF translation may occur."
 190   (prog1
 191       (condition-case error
 192           (cond
 193            ((eq encoding 'quoted-printable)
 194             (quoted-printable-decode-region (point-min) (point-max))
 195             t)
 196            ((eq encoding 'base64)
 197             (base64-decode-region
 198              (point-min)
 199              ;; Some mailers insert whitespace
 200              ;; junk at the end which
 201              ;; base64-decode-region dislikes.
 202              ;; Also remove possible junk which could
 203              ;; have been added by mailing list software.
 204              (save-excursion
 205                (goto-char (point-min))
 206                (while (re-search-forward "^[\t ]*\r?\n" nil t)
 207                  (delete-region (match-beginning 0) (match-end 0)))
 208                (goto-char (point-max))
 209                (when (re-search-backward "^[A-Za-z0-9+/]+=*[\t ]*$" nil t)
 210                  (forward-line))
 211                (point))))
 212            ((memq encoding '(7bit 8bit binary))
 213             ;; Do nothing.
 214             t)
 215            ((null encoding)
 216             ;; Do nothing.
 217             t)
 218            ((memq encoding '(x-uuencode x-uue))
 219             (require 'mm-uu)
 220             (funcall mm-uu-decode-function (point-min) (point-max))
 221             t)
 222            ((eq encoding 'x-binhex)
 223             (require 'mm-uu)
 224             (funcall mm-uu-binhex-decode-function (point-min) (point-max))
 225             t)
 226            ((eq encoding 'x-yenc)
 227             (require 'mm-uu)
 228             (funcall mm-uu-yenc-decode-function (point-min) (point-max))
 229             )
 230            ((functionp encoding)
 231             (funcall encoding (point-min) (point-max))
 232             t)
 233            (t
 234             (message "Unknown encoding %s; defaulting to 8bit" encoding)))
 235         (error
 236          (message "Error while decoding: %s" error)
 237          nil))
 238     (when (and
 239            (memq encoding '(base64 x-uuencode x-uue x-binhex x-yenc))
 240            (equal type "text/plain"))
 241       (goto-char (point-min))
 242       (while (search-forward "\r\n" nil t)
 243         (replace-match "\n" t t)))))
 244
 245 (defun mm-decode-body (charset &optional encoding type)
 246   "Decode the current article that has been encoded with ENCODING.
 247 The characters in CHARSET should then be decoded."
 248   (if (stringp charset)
 249       (setq charset (intern (downcase charset))))
 250   (if (or (not charset)
 251           (eq 'gnus-all mail-parse-ignored-charsets)
 252           (memq 'gnus-all mail-parse-ignored-charsets)
 253           (memq charset mail-parse-ignored-charsets))
 254       (setq charset mail-parse-charset))
 255   (save-excursion
 256     (when encoding
 257       (mm-decode-content-transfer-encoding encoding type))
 258     (when (featurep 'mule)
 259       (let ((coding-system (mm-charset-to-coding-system charset)))
 260         (if (and (not coding-system)
 261                  (listp mail-parse-ignored-charsets)
 262                  (memq 'gnus-unknown mail-parse-ignored-charsets))
 263             (setq coding-system
 264                   (mm-charset-to-coding-system mail-parse-charset)))
 265         (when (and charset coding-system
 266                    ;; buffer-file-coding-system
 267                    ;;Article buffer is nil coding system
 268                    ;;in XEmacs
 269                    (mm-multibyte-p)
 270                    (or (not (eq coding-system 'ascii))
 271                        (setq coding-system mail-parse-charset))
 272                    (not (eq coding-system 'gnus-decoded)))
 273           (mm-decode-coding-region (point-min) (point-max) coding-system))))))
 274
 275 (defun mm-decode-string (string charset)
 276   "Decode STRING with CHARSET."
 277   (when (stringp charset)
 278     (setq charset (intern (downcase charset))))
 279   (when (or (not charset)
 280             (eq 'gnus-all mail-parse-ignored-charsets)
 281             (memq 'gnus-all mail-parse-ignored-charsets)
 282             (memq charset mail-parse-ignored-charsets))
 283     (setq charset mail-parse-charset))
 284   (or
 285    (when (featurep 'mule)
 286      (let ((coding-system (mm-charset-to-coding-system charset)))
 287        (if (and (not coding-system)
 288                 (listp mail-parse-ignored-charsets)
 289                 (memq 'gnus-unknown mail-parse-ignored-charsets))
 290            (setq coding-system
 291                  (mm-charset-to-coding-system mail-parse-charset)))
 292        (when (and charset coding-system
 293                   (mm-multibyte-p)
 294                   (or (not (eq coding-system 'ascii))
 295                       (setq coding-system mail-parse-charset)))
 296          (mm-decode-coding-string string coding-system))))
 297    string))
 298
 299 (provide 'mm-bodies)
 300
 301 ;;; mm-bodies.el ends here