1 ;;; ietf-drums.el --- Functions for parsing RFC822bis headers
3 ;; Copyright (C) 1998-2015 Free Software Foundation, Inc.
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; This file is part of GNU Emacs.
8 ;; GNU Emacs is free software: you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;; DRUMS is an IETF Working Group that works (or worked) on the
24 ;; successor to RFC822, "Standard For The Format Of Arpa Internet Text
25 ;; Messages". This library is based on
26 ;; draft-ietf-drums-msg-fmt-05.txt, released on 1998-08-05.
28 ;; Pending a real regression self test suite, Simon Josefsson added
29 ;; various self test expressions snipped from bug reports, and their
30 ;; expected value, below. I you believe it could be useful, please
31 ;; add your own test cases, or write a real self test suite, or just
34 ;; <m3oekvfd50.fsf@whitebox.m5r.de>
35 ;; (ietf-drums-parse-address "'foo' <foo@example.com>")
36 ;; => ("foo@example.com" . "'foo'")
40 (eval-when-compile (require 'cl))
43 (defvar ietf-drums-no-ws-ctl-token "\001-\010\013\014\016-\037\177"
44 "US-ASCII control characters excluding CR, LF and white space.")
45 (defvar ietf-drums-text-token "\001-\011\013\014\016-\177"
46 "US-ASCII characters excluding CR and LF.")
47 (defvar ietf-drums-specials-token "()<>[]:;@\\,.\""
48 "Special characters.")
49 (defvar ietf-drums-quote-token "\\"
51 (defvar ietf-drums-wsp-token " \t"
53 (defvar ietf-drums-fws-regexp
54 (concat "[" ietf-drums-wsp-token "]*\n[" ietf-drums-wsp-token "]+")
55 "Folding white space.")
56 (defvar ietf-drums-atext-token "-^a-zA-Z0-9!#$%&'*+/=?_`{|}~"
58 (defvar ietf-drums-dot-atext-token "-^a-zA-Z0-9!#$%&'*+/=?_`{|}~."
59 "Textual token including full stop.")
60 (defvar ietf-drums-qtext-token
61 (concat ietf-drums-no-ws-ctl-token "\041\043-\133\135-\177")
62 "Non-white-space control characters, plus the rest of ASCII excluding
63 backslash and doublequote.")
64 (defvar ietf-drums-tspecials "][()<>@,;:\\\"/?="
67 (defvar ietf-drums-syntax-table
68 (let ((table (copy-syntax-table emacs-lisp-mode-syntax-table)))
69 (modify-syntax-entry ?\\ "/" table)
70 (modify-syntax-entry ?< "(" table)
71 (modify-syntax-entry ?> ")" table)
72 (modify-syntax-entry ?@ "w" table)
73 (modify-syntax-entry ?/ "w" table)
74 (modify-syntax-entry ?* "_" table)
75 (modify-syntax-entry ?\; "_" table)
76 (modify-syntax-entry ?\' "_" table)
77 (if (featurep 'xemacs)
80 (modify-syntax-entry i "w" table)
84 (defun ietf-drums-token-to-list (token)
85 "Translate TOKEN into a list of characters."
88 (while (< i (length token))
89 (setq c (mm-char-int (aref token i)))
92 ((eq c (mm-char-int ?-))
98 (push (make-char 'ascii b) out)
101 ((= i (length token))
102 (push (make-char 'ascii c) out))
105 (push (make-char 'ascii b) out))
109 (defsubst ietf-drums-init (string)
110 (set-syntax-table ietf-drums-syntax-table)
112 (ietf-drums-unfold-fws)
113 (goto-char (point-min)))
115 (defun ietf-drums-remove-comments (string)
116 "Remove comments from STRING."
119 (ietf-drums-init string)
121 (setq c (char-after))
126 (error (goto-char (point-max)))))
131 (with-syntax-table (copy-syntax-table ietf-drums-syntax-table)
132 (modify-syntax-entry ?\" "w")
135 (error (point-max)))))
140 (defun ietf-drums-remove-whitespace (string)
141 "Remove whitespace from STRING."
143 (ietf-drums-init string)
146 (setq c (char-after))
152 ((memq c '(?\ ?\t ?\n))
158 (defun ietf-drums-get-comment (string)
159 "Return the first comment in STRING."
161 (ietf-drums-init string)
164 (setq c (char-after))
172 (progn (forward-sexp 1) (1- (point))))))
177 (defun ietf-drums-strip (string)
178 "Remove comments and whitespace from STRING."
179 (ietf-drums-remove-whitespace (ietf-drums-remove-comments string)))
181 (defun ietf-drums-parse-address (string)
182 "Parse STRING and return a MAILBOX / DISPLAY-NAME pair."
184 (let (display-name mailbox c display-string)
185 (ietf-drums-init string)
187 (setq c (char-after))
195 (push (buffer-substring
196 (1+ (point)) (progn (forward-sexp 1) (1- (point))))
198 ((looking-at (concat "[" ietf-drums-atext-token "@" "]"))
199 (push (buffer-substring (point) (progn (forward-sexp 1) (point)))
203 (ietf-drums-remove-whitespace
204 (ietf-drums-remove-comments
207 (progn (forward-sexp 1) (1- (point))))))))
210 ;; If we found no display-name, then we look for comments.
213 (mapconcat 'identity (reverse display-name) " "))
214 (setq display-string (ietf-drums-get-comment string)))
216 (when (and display-string
217 (string-match "@" display-string))
219 (mapconcat 'identity (nreverse display-name) "")
220 (ietf-drums-get-comment string)))
221 (cons mailbox display-string)))))
223 (defun ietf-drums-parse-addresses (string &optional rawp)
224 "Parse STRING and return a list of MAILBOX / DISPLAY-NAME pairs.
225 If RAWP, don't actually parse the addresses, but instead return
226 a list of address strings."
230 (ietf-drums-init string)
234 (setq c (char-after))
236 ((memq c '(?\" ?< ?\())
240 (skip-chars-forward "^,"))))
244 (buffer-substring beg (point))
246 (ietf-drums-parse-address
247 (buffer-substring beg (point)))
249 (if address (push address pairs))
256 (buffer-substring beg (point))
258 (ietf-drums-parse-address
259 (buffer-substring beg (point)))
261 (if address (push address pairs))
264 (defun ietf-drums-unfold-fws ()
265 "Unfold folding white space in the current buffer."
266 (goto-char (point-min))
267 (while (re-search-forward ietf-drums-fws-regexp nil t)
268 (replace-match " " t t))
269 (goto-char (point-min)))
271 (defun ietf-drums-parse-date (string)
272 "Return an Emacs time spec from STRING."
273 (apply 'encode-time (parse-time-string string)))
275 (defun ietf-drums-narrow-to-header ()
276 "Narrow to the header section in the current buffer."
278 (goto-char (point-min))
279 (if (re-search-forward "^\r?$" nil 1)
282 (goto-char (point-min)))
284 (defun ietf-drums-quote-string (string)
285 "Quote string if it needs quoting to be displayed in a header."
286 (if (string-match (concat "[^" ietf-drums-atext-token "]") string)
287 (concat "\"" string "\"")
290 (defun ietf-drums-make-address (name address)
292 (concat (ietf-drums-quote-string name) " <" address ">")
295 (provide 'ietf-drums)
297 ;;; ietf-drums.el ends here