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

   1 ;; Utility functions used both by rmail and rnews
   2 ;; Copyright (C) 1985 Free Software Foundation, Inc.
   3
   4 ;; This file is part of GNU Emacs.
   5
   6 ;; GNU Emacs is free software; you can redistribute it and/or modify
   7 ;; it under the terms of the GNU General Public License as published by
   8 ;; the Free Software Foundation; either version 1, or (at your option)
   9 ;; any later version.
  10
  11 ;; GNU Emacs is distributed in the hope that it will be useful,
  12 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 ;; GNU General Public License for more details.
  15
  16 ;; You should have received a copy of the GNU General Public License
  17 ;; along with GNU Emacs; see the file COPYING.  If not, write to
  18 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  19
  20
  21 ;;; We require lisp-mode to make sure that lisp-mode-syntax-table has
  22 ;;; been initialized.
  23 (require 'lisp-mode)
  24
  25 ;;;###autoload
  26 (defvar mail-use-rfc822 nil "\
  27 *If non-nil, use a full, hairy RFC822 parser on mail addresses.
  28 Otherwise, (the default) use a smaller, somewhat faster, and
  29 often correct parser.")
  30
  31 (defun mail-string-delete (string start end)
  32   "Returns a string containing all of STRING except the part
  33 from START (inclusive) to END (exclusive)."
  34   (if (null end) (substring string 0 start)
  35     (concat (substring string 0 start)
  36             (substring string end nil))))
  37
  38 (defun mail-strip-quoted-names (address)
  39   "Delete comments and quoted strings in an address list ADDRESS.
  40 Also delete leading/trailing whitespace and replace FOO <BAR> with just BAR.
  41 Return a modified address list."
  42   (if (null address)
  43       nil
  44     (if mail-use-rfc822
  45         (progn (require 'rfc822)
  46                (mapconcat 'identity (rfc822-addresses address) ", "))
  47       (let (pos)
  48        (string-match "\\`[ \t\n]*" address)
  49        ;; strip surrounding whitespace
  50        (setq address (substring address
  51                                 (match-end 0)
  52                                 (string-match "[ \t\n]*\\'" address
  53                                               (match-end 0))))
  54
  55        ;; Detect nested comments.
  56        (if (string-match "[ \t]*(\\([^)\"\\]\\|\\\\.\\|\\\\\n\\)*(" address)
  57            ;; Strip nested comments.
  58            (save-excursion
  59              (set-buffer (get-buffer-create " *temp*"))
  60              (erase-buffer)
  61              (insert address)
  62              (set-syntax-table lisp-mode-syntax-table)
  63              (goto-char 1)
  64              (while (search-forward "(" nil t)
  65                (forward-char -1)
  66                (skip-chars-backward " \t")
  67                (delete-region (point)
  68                               (save-excursion (forward-sexp 1) (point))))
  69              (setq address (buffer-string))
  70              (erase-buffer))
  71          ;; Strip non-nested comments an easier way.
  72          (while (setq pos (string-match
  73                             ;; This doesn't hack rfc822 nested comments
  74                             ;;  `(xyzzy (foo) whinge)' properly.  Big deal.
  75                             "[ \t]*(\\([^)\"\\]\\|\\\\.\\|\\\\\n\\)*)"
  76                             address))
  77            (setq address
  78                  (mail-string-delete address
  79                                      pos (match-end 0)))))
  80
  81        ;; strip `quoted' names (This is supposed to hack `"Foo Bar" <bar@host>')
  82        (setq pos 0)
  83        (while (setq pos (string-match
  84                           "[ \t]*\"\\([^\"\\]\\|\\\\.\\|\\\\\n\\)*\"[ \t\n]*"
  85                           address pos))
  86          ;; If the next thing is "@", we have "foo bar"@host.  Leave it.
  87          (if (and (> (length address) (match-end 0))
  88                   (= (aref address (match-end 0)) ?@))
  89              (setq pos (match-end 0))
  90            (setq address
  91                  (mail-string-delete address
  92                                      pos (match-end 0)))))
  93        ;; Retain only part of address in <> delims, if there is such a thing.
  94        (while (setq pos (string-match "\\(,\\|\\`\\)[^,]*<\\([^>,]*>\\)"
  95                                       address))
  96          (let ((junk-beg (match-end 1))
  97                (junk-end (match-beginning 2))
  98                (close (match-end 0)))
  99            (setq address (mail-string-delete address (1- close) close))
 100            (setq address (mail-string-delete address junk-beg junk-end))))
 101        address))))
 102
 103 (or (and (boundp 'rmail-default-dont-reply-to-names)
 104          (not (null rmail-default-dont-reply-to-names)))
 105     (setq rmail-default-dont-reply-to-names "info-"))
 106
 107 ; rmail-dont-reply-to-names is defined in loaddefs
 108 (defun rmail-dont-reply-to (userids)
 109   "Returns string of mail addresses USERIDS sans any recipients
 110 that start with matches for `rmail-dont-reply-to-names'.
 111 Usenet paths ending in an element that matches are removed also."
 112   (if (null rmail-dont-reply-to-names)
 113       (setq rmail-dont-reply-to-names
 114             (concat (if rmail-default-dont-reply-to-names
 115                         (concat rmail-default-dont-reply-to-names "\\|")
 116                         "")
 117                     (concat (regexp-quote (user-original-login-name))
 118                             "\\>"))))
 119   (let ((match (concat "\\(^\\|,\\)[ \t\n]*\\([^,\n]*!\\|\\)\\("
 120                        rmail-dont-reply-to-names
 121                        "\\)"))
 122         (case-fold-search t)
 123         pos epos)
 124     (while (setq pos (string-match match userids))
 125       (if (> pos 0) (setq pos (1+ pos)))
 126       (setq epos
 127             (if (string-match "[ \t\n,]+" userids (match-end 0))
 128                 (match-end 0)
 129               (length userids)))
 130       (setq userids
 131             (mail-string-delete
 132               userids pos epos)))
 133     ;; get rid of any trailing commas
 134     (if (setq pos (string-match "[ ,\t\n]*\\'" userids))
 135         (setq userids (substring userids 0 pos)))
 136     ;; remove leading spaces. they bother me.
 137     (if (string-match "\\s *" userids)
 138         (substring userids (match-end 0))
 139       userids)))
 140 \f
 141 (defun mail-fetch-field (field-name &optional last all)
 142   "Return the value of the header field FIELD-NAME.
 143 The buffer is expected to be narrowed to just the headers of the message.
 144 If second arg LAST is non-nil, use the last such field if there are several.
 145 If third arg ALL is non-nil, concatenate all such fields with commas between."
 146   (save-excursion
 147     (goto-char (point-min))
 148     (let ((case-fold-search t)
 149           (name (concat "^" (regexp-quote field-name) "[ \t]*:[ \t]*")))
 150       (goto-char (point-min))
 151       (if all
 152           (let ((value ""))
 153             (while (re-search-forward name nil t)
 154               (let ((opoint (point)))
 155                 (while (progn (forward-line 1)
 156                               (looking-at "[ \t]")))
 157                 (setq value (concat value
 158                                     (if (string= value "") "" ", ")
 159                                     (buffer-substring opoint (1- (point)))))))
 160             (and (not (string= value "")) value))
 161         (if (re-search-forward name nil t)
 162             (progn
 163               (if last (while (re-search-forward name nil t)))
 164               (let ((opoint (point)))
 165                 (while (progn (forward-line 1)
 166                               (looking-at "[ \t]")))
 167                 (buffer-substring opoint (1- (point))))))))))
 168 \f
 169 ;; Parse a list of tokens separated by commas.
 170 ;; It runs from point to the end of the visible part of the buffer.
 171 ;; Whitespace before or after tokens is ignored,
 172 ;; but whitespace within tokens is kept.
 173 (defun mail-parse-comma-list ()
 174   (let (accumulated
 175         beg)
 176     (skip-chars-forward " ")
 177     (while (not (eobp))
 178       (setq beg (point))
 179       (skip-chars-forward "^,")
 180       (skip-chars-backward " ")
 181       (setq accumulated
 182             (cons (buffer-substring beg (point))
 183                   accumulated))
 184       (skip-chars-forward "^,")
 185       (skip-chars-forward ", "))
 186     accumulated))
 187
 188 (defun mail-comma-list-regexp (labels)
 189   (let (pos)
 190     (setq pos (or (string-match "[^ \t]" labels) 0))
 191     ;; Remove leading and trailing whitespace.
 192     (setq labels (substring labels pos (string-match "[ \t]*$" labels pos)))
 193     ;; Change each comma to \|, and flush surrounding whitespace.
 194     (while (setq pos (string-match "[ \t]*,[ \t]*" labels))
 195       (setq labels
 196             (concat (substring labels 0 pos)
 197                     "\\|"
 198                     (substring labels (match-end 0))))))
 199   labels)
 200
 201 (provide 'mail-utils)
 202