code.delx.au - gnu-emacs/blob - lisp/mail/mail-utils.el

   1 ;;; mail-utils.el --- utility functions used both by rmail and rnews
   2
   3 ;; Copyright (C) 1985 Free Software Foundation, Inc.
   4
   5 ;; Maintainer: FSF
   6 ;; Keywords: mail, news
   7
   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 ;; Utility functions for mail and netnews handling.  These handle fine
  28 ;; points of header parsing.
  29
  30 ;;; Code:
  31
  32 ;;; We require lisp-mode to make sure that lisp-mode-syntax-table has
  33 ;;; been initialized.
  34 (require 'lisp-mode)
  35
  36 ;;;###autoload
  37 (defvar mail-use-rfc822 nil "\
  38 *If non-nil, use a full, hairy RFC822 parser on mail addresses.
  39 Otherwise, (the default) use a smaller, somewhat faster, and
  40 often correct parser.")
  41
  42 ;; Returns t if file FILE is an Rmail file.
  43 ;;;###autoload
  44 (defun mail-file-babyl-p (file)
  45   (let ((buf (generate-new-buffer " *rmail-file-p*")))
  46     (unwind-protect
  47         (save-excursion
  48           (set-buffer buf)
  49           (insert-file-contents file nil 0 100)
  50           (looking-at "BABYL OPTIONS:"))
  51       (kill-buffer buf))))
  52
  53 (defun mail-string-delete (string start end)
  54   "Returns a string containing all of STRING except the part
  55 from START (inclusive) to END (exclusive)."
  56   (if (null end) (substring string 0 start)
  57     (concat (substring string 0 start)
  58             (substring string end nil))))
  59
  60 (defun mail-quote-printable (string &optional wrapper)
  61   "Convert a string to the \"quoted printable\" Q encoding.
  62 If the optional argument WRAPPER is non-nil,
  63 we add the wrapper characters =?ISO-8859-1?Q?....?=."
  64   (let ((i 0) (result ""))
  65     (save-match-data
  66       (while (string-match "[?=\"\200-\377]" string i)
  67         (setq result
  68               (concat result (substring string i (match-beginning 0))
  69                       (upcase (format "=%02x"
  70                                       (aref string (match-beginning 0))))))
  71         (setq i (match-end 0)))
  72       (if wrapper
  73           (concat "=?ISO-8859-1?Q?"
  74                   result (substring string i)
  75                   "?=")
  76         (concat result (substring string i))))))
  77
  78 (defun mail-unquote-printable-hexdigit (char)
  79   (if (>= char ?A)
  80       (+ (- char ?A) 10)
  81     (- char ?0)))
  82
  83 (defun mail-unquote-printable (string &optional wrapper)
  84   "Undo the \"quoted printable\" encoding.
  85 If the optional argument WRAPPER is non-nil,
  86 we expect to find and remove the wrapper characters =?ISO-8859-1?Q?....?=."
  87   (save-match-data
  88     (and wrapper
  89          (string-match "\\`=\\?ISO-8859-1\\?Q\\?\\([^?]*\\)\\?" string)
  90          (setq string (match-string 1 string)))
  91     (let ((i 0) (result ""))
  92       (while (string-match "=\\(..\\)" string i)
  93         (setq result
  94               (concat result (substring string i (match-beginning 0))
  95                       (make-string 1
  96                                    (+ (* 16 (mail-unquote-printable-hexdigit
  97                                              (aref string (match-beginning 1))))
  98                                       (mail-unquote-printable-hexdigit
  99                                        (aref string (1+ (match-beginning 1))))))))
 100         (setq i (match-end 0)))
 101       (concat result (substring string i)))))
 102
 103 (defun mail-strip-quoted-names (address)
 104   "Delete comments and quoted strings in an address list ADDRESS.
 105 Also delete leading/trailing whitespace and replace FOO <BAR> with just BAR.
 106 Return a modified address list."
 107   (if (null address)
 108       nil
 109     (if mail-use-rfc822
 110         (progn (require 'rfc822)
 111                (mapconcat 'identity (rfc822-addresses address) ", "))
 112       (let (pos)
 113        (string-match "\\`[ \t\n]*" address)
 114        ;; strip surrounding whitespace
 115        (setq address (substring address
 116                                 (match-end 0)
 117                                 (string-match "[ \t\n]*\\'" address
 118                                               (match-end 0))))
 119
 120        ;; Detect nested comments.
 121        (if (string-match "[ \t]*(\\([^)\\]\\|\\\\.\\|\\\\\n\\)*(" address)
 122            ;; Strip nested comments.
 123            (save-excursion
 124              (set-buffer (get-buffer-create " *temp*"))
 125              (erase-buffer)
 126              (insert address)
 127              (set-syntax-table lisp-mode-syntax-table)
 128              (goto-char 1)
 129              (while (search-forward "(" nil t)
 130                (forward-char -1)
 131                (skip-chars-backward " \t")
 132                (delete-region (point)
 133                               (save-excursion
 134                                 (condition-case ()
 135                                     (forward-sexp 1)
 136                                   (error (goto-char (point-max))))
 137                                   (point))))
 138              (setq address (buffer-string))
 139              (erase-buffer))
 140          ;; Strip non-nested comments an easier way.
 141          (while (setq pos (string-match
 142                             ;; This doesn't hack rfc822 nested comments
 143                             ;;  `(xyzzy (foo) whinge)' properly.  Big deal.
 144                             "[ \t]*(\\([^)\\]\\|\\\\.\\|\\\\\n\\)*)"
 145                             address))
 146            (setq address
 147                  (mail-string-delete address
 148                                      pos (match-end 0)))))
 149
 150        ;; strip `quoted' names (This is supposed to hack `"Foo Bar" <bar@host>')
 151        (setq pos 0)
 152        (while (setq pos (string-match
 153                           "[ \t]*\"\\([^\"\\]\\|\\\\.\\|\\\\\n\\)*\"[ \t\n]*"
 154                           address pos))
 155          ;; If the next thing is "@", we have "foo bar"@host.  Leave it.
 156          (if (and (> (length address) (match-end 0))
 157                   (= (aref address (match-end 0)) ?@))
 158              (setq pos (match-end 0))
 159            (setq address
 160                  (mail-string-delete address
 161                                      pos (match-end 0)))))
 162        ;; Retain only part of address in <> delims, if there is such a thing.
 163        (while (setq pos (string-match "\\(,\\s-*\\|\\`\\)[^,]*<\\([^>,:]*>\\)"
 164                                       address))
 165          (let ((junk-beg (match-end 1))
 166                (junk-end (match-beginning 2))
 167                (close (match-end 0)))
 168            (setq address (mail-string-delete address (1- close) close))
 169            (setq address (mail-string-delete address junk-beg junk-end))))
 170        address))))
 171
 172 (or (and (boundp 'rmail-default-dont-reply-to-names)
 173          (not (null rmail-default-dont-reply-to-names)))
 174     (setq rmail-default-dont-reply-to-names "info-"))
 175
 176 ; rmail-dont-reply-to-names is defined in loaddefs
 177 (defun rmail-dont-reply-to (userids)
 178   "Returns string of mail addresses USERIDS sans any recipients
 179 that start with matches for `rmail-dont-reply-to-names'.
 180 Usenet paths ending in an element that matches are removed also."
 181   (if (null rmail-dont-reply-to-names)
 182       (setq rmail-dont-reply-to-names
 183             (concat (if rmail-default-dont-reply-to-names
 184                         (concat rmail-default-dont-reply-to-names "\\|")
 185                         "")
 186                     (concat (regexp-quote (user-login-name))
 187                             "\\>"))))
 188   (let ((match (concat "\\(^\\|,\\)[ \t\n]*\\([^,\n]*[!<]\\|\\)\\("
 189                        rmail-dont-reply-to-names
 190                        "\\|[^\,.<]*<\\(" rmail-dont-reply-to-names "\\)"
 191                        "\\)"))
 192         (case-fold-search t)
 193         pos epos)
 194     (while (setq pos (string-match match userids))
 195       (if (> pos 0) (setq pos (match-beginning 2)))
 196       (setq epos
 197             ;; Delete thru the next comma, plus whitespace after.
 198             (if (string-match ",[ \t\n]*" userids (match-end 0))
 199                 (match-end 0)
 200               (length userids)))
 201       (setq userids
 202             (mail-string-delete
 203               userids pos epos)))
 204     ;; get rid of any trailing commas
 205     (if (setq pos (string-match "[ ,\t\n]*\\'" userids))
 206         (setq userids (substring userids 0 pos)))
 207     ;; remove leading spaces. they bother me.
 208     (if (string-match "\\s *" userids)
 209         (substring userids (match-end 0))
 210       userids)))
 211 \f
 212 ;;;###autoload
 213 (defun mail-fetch-field (field-name &optional last all list)
 214   "Return the value of the header field FIELD-NAME.
 215 The buffer is expected to be narrowed to just the headers of the message.
 216 If second arg LAST is non-nil, use the last such field if there are several.
 217 If third arg ALL is non-nil, concatenate all such fields with commas between.
 218 If 4th arg LIST is non-nil, return a list of all such fields."
 219   (save-excursion
 220     (goto-char (point-min))
 221     (let ((case-fold-search t)
 222           (name (concat "^" (regexp-quote field-name) "[ \t]*:[ \t]*")))
 223       (if (or all list)
 224           (let ((value (if all "")))
 225             (while (re-search-forward name nil t)
 226               (let ((opoint (point)))
 227                 (while (progn (forward-line 1)
 228                               (looking-at "[ \t]")))
 229                 ;; Back up over newline, then trailing spaces or tabs
 230                 (forward-char -1)
 231                 (skip-chars-backward " \t" opoint)
 232                 (if list
 233                     (setq value (cons (buffer-substring-no-properties
 234                                        opoint (point))
 235                                       value))
 236                   (setq value (concat value
 237                                       (if (string= value "") "" ", ")
 238                                       (buffer-substring-no-properties
 239                                        opoint (point)))))))
 240             (if list
 241                 value
 242               (and (not (string= value "")) value)))
 243         (if (re-search-forward name nil t)
 244             (progn
 245               (if last (while (re-search-forward name nil t)))
 246               (let ((opoint (point)))
 247                 (while (progn (forward-line 1)
 248                               (looking-at "[ \t]")))
 249                 ;; Back up over newline, then trailing spaces or tabs
 250                 (forward-char -1)
 251                 (skip-chars-backward " \t" opoint)
 252                 (buffer-substring-no-properties opoint (point)))))))))
 253 \f
 254 ;; Parse a list of tokens separated by commas.
 255 ;; It runs from point to the end of the visible part of the buffer.
 256 ;; Whitespace before or after tokens is ignored,
 257 ;; but whitespace within tokens is kept.
 258 (defun mail-parse-comma-list ()
 259   (let (accumulated
 260         beg)
 261     (skip-chars-forward " ")
 262     (while (not (eobp))
 263       (setq beg (point))
 264       (skip-chars-forward "^,")
 265       (skip-chars-backward " ")
 266       (setq accumulated
 267             (cons (buffer-substring-no-properties beg (point))
 268                   accumulated))
 269       (skip-chars-forward "^,")
 270       (skip-chars-forward ", "))
 271     accumulated))
 272
 273 (defun mail-comma-list-regexp (labels)
 274   (let (pos)
 275     (setq pos (or (string-match "[^ \t]" labels) 0))
 276     ;; Remove leading and trailing whitespace.
 277     (setq labels (substring labels pos (string-match "[ \t]*$" labels pos)))
 278     ;; Change each comma to \|, and flush surrounding whitespace.
 279     (while (setq pos (string-match "[ \t]*,[ \t]*" labels))
 280       (setq labels
 281             (concat (substring labels 0 pos)
 282                     "\\|"
 283                     (substring labels (match-end 0))))))
 284   labels)
 285 \f
 286 (defun mail-rfc822-time-zone (time)
 287   (let* ((sec (or (car (current-time-zone time)) 0))
 288          (absmin (/ (abs sec) 60)))
 289     (format "%c%02d%02d" (if (< sec 0) ?- ?+) (/ absmin 60) (% absmin 60))))
 290
 291 (defun mail-rfc822-date ()
 292   (let* ((time (current-time))
 293          (s (current-time-string time)))
 294     (string-match "[^ ]+ +\\([^ ]+\\) +\\([^ ]+\\) \\([^ ]+\\) \\([^ ]+\\)" s)
 295     (concat (substring s (match-beginning 2) (match-end 2)) " "
 296             (substring s (match-beginning 1) (match-end 1)) " "
 297             (substring s (match-beginning 4) (match-end 4)) " "
 298             (substring s (match-beginning 3) (match-end 3)) " "
 299             (mail-rfc822-time-zone time))))
 300
 301 (provide 'mail-utils)
 302
 303 ;;; mail-utils.el ends here