Alias `rfc822/analyze-spaces', `rfc822/analyze-special',
[elisp/mu-cite.git] / tl-822.el
1 ;;; tl-822.el --- RFC 822 parser for GNU Emacs
2
3 ;; Copyright (C) 1995,1996 Free Software Foundation, Inc.
4
5 ;; Author:   MORIOKA Tomohiko <morioka@jaist.ac.jp>
6 ;; Keywords: mail, news, RFC 822
7
8 ;; This file is part of tl (Tiny Library).
9
10 ;; This program is free software; you can redistribute it and/or
11 ;; modify it under the terms of the GNU General Public License as
12 ;; published by the Free Software Foundation; either version 2, or (at
13 ;; your option) any later version.
14
15 ;; This program is distributed in the hope that it will be useful, but
16 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18 ;; General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with This program; see the file COPYING.  If not, write to
22 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Code:
26
27 (require 'tl-seq)
28 (require 'tl-str)
29 (require 'std11)
30
31
32 (defconst rfc822/RCS-ID
33   "$Id: tl-822.el,v 7.55 1996-08-28 18:15:17 morioka Exp $")
34 (defconst rfc822/version (get-version-string rfc822/RCS-ID))
35
36
37 ;;; @ header
38 ;;;
39
40 (defalias 'rfc822/narrow-to-header      'std11-narrow-to-header)
41 (defalias 'rfc822/get-header-string     'std11-header-string)
42 (defalias 'rfc822/get-header-string-except 'std11-header-string-except)
43 (defalias 'rfc822/get-field-names       'std11-collect-field-names)
44
45
46 ;;; @ field
47 ;;;
48
49 (defalias `rfc822/field-end             'std11-field-end)
50 (defalias 'rfc822/get-field-body        'std11-find-field-body)
51 (defalias 'rfc822/get-field-bodies      'std11-find-field-bodies)
52
53
54 ;;; @ quoting
55 ;;;
56
57 (defconst rfc822/linear-white-space-regexp "\\(\n?[ \t]\\)+")
58 (defconst rfc822/quoted-pair-regexp "\\\\.")
59 (defconst rfc822/non-qtext-char-list '(?\" ?\\ ?\r ?\n))
60 (defconst rfc822/qtext-regexp
61   (concat "[^" (char-list-to-string rfc822/non-qtext-char-list) "]"))
62 (defconst rfc822/quoted-string-regexp
63   (concat "\""
64           (regexp-*
65            (regexp-or rfc822/qtext-regexp rfc822/quoted-pair-regexp)
66            )
67           "\""))
68
69 (defun rfc822/wrap-as-quoted-string (str)
70   "Wrap string STR as RFC 822 quoted-string. [tl-822.el]"
71   (concat "\""
72           (mapconcat (function
73                       (lambda (chr)
74                         (if (memq chr rfc822/non-qtext-char-list)
75                             (concat "\\" (char-to-string chr))
76                           (char-to-string chr)
77                           )
78                         )) str "")
79           "\""))
80
81 (defun rfc822/strip-quoted-pair (str)
82   (let ((dest "")
83         (i 0)
84         (len (length str))
85         chr flag)
86     (while (< i len)
87       (setq chr (elt str i))
88       (if (or flag (not (eq chr ?\\)))
89           (progn
90             (setq dest (concat dest (char-to-string chr)))
91             (setq flag nil)
92             )
93         (setq flag t)
94         )
95       (setq i (+ i 1))
96       )
97     dest))
98
99 (defun rfc822/strip-quoted-string (str)
100   (rfc822/strip-quoted-pair
101    (let ((max (- (length str) 1))
102          )
103      (if (and (eq (elt str 0) ?\")
104               (eq (elt str max) ?\")
105               )
106          (substring str 1 max)
107        str)
108      )))
109
110
111 ;;; @ unfolding
112 ;;;
113
114 (defalias 'rfc822/unfolding-string 'std11-unfold-string)
115
116
117 ;;; @ lexical analyze
118 ;;;
119
120 (defalias 'rfc822/lexical-analyze       'std11-lexical-analyze)
121
122
123 ;;; @ parser
124 ;;;
125
126 (defun rfc822/ignored-token-p (token)
127   (let ((type (car token)))
128     (or (eq type 'spaces)(eq type 'comment))
129     ))
130
131 (defun rfc822/parse-token (lal)
132   (let (token itl)
133     (while (and lal
134                 (progn
135                   (setq token (car lal))
136                   (rfc822/ignored-token-p token)
137                   ))
138       (setq lal (cdr lal))
139       (setq itl (cons token itl))
140       )
141     (cons (nreverse (cons token itl))
142           (cdr lal))
143     ))
144
145 (defun rfc822/parse-ascii-token (lal)
146   (let (token itl parsed token-value)
147     (while (and lal
148                 (setq token (car lal))
149                 (if (and (setq token-value (cdr token))
150                          (find-charset-string token-value)
151                          )
152                     (setq token nil)
153                   (rfc822/ignored-token-p token)
154                   ))
155       (setq lal (cdr lal))
156       (setq itl (cons token itl))
157       )
158     (if (and token
159              (setq parsed (nreverse (cons token itl)))
160              )
161         (cons parsed (cdr lal))
162       )))
163
164 (defun rfc822/parse-token-or-comment (lal)
165   (let (token itl)
166     (while (and lal
167                 (progn
168                   (setq token (car lal))
169                   (eq (car token) 'spaces)
170                   ))
171       (setq lal (cdr lal))
172       (setq itl (cons token itl))
173       )
174     (cons (nreverse (cons token itl))
175           (cdr lal))
176     ))
177
178 (defun rfc822/parse-word (lal)
179   (let ((ret (rfc822/parse-ascii-token lal)))
180     (if ret
181         (let ((elt (car ret))
182               (rest (cdr ret))
183               )
184           (if (or (assq 'atom elt)
185                   (assq 'quoted-string elt))
186               (cons (cons 'word elt) rest)
187             )))))
188
189 (defun rfc822/parse-word-or-comment (lal)
190   (let ((ret (rfc822/parse-token-or-comment lal)))
191     (if ret
192         (let ((elt (car ret))
193               (rest (cdr ret))
194               )
195           (cond ((or (assq 'atom elt)
196                      (assq 'quoted-string elt))
197                  (cons (cons 'word elt) rest)
198                  )
199                 ((assq 'comment elt)
200                  (cons (cons 'comment-word elt) rest)
201                  ))
202           ))))
203
204 (defun rfc822/parse-phrase (lal)
205   (let (ret phrase)
206     (while (setq ret (rfc822/parse-word-or-comment lal))
207       (setq phrase (append phrase (cdr (car ret))))
208       (setq lal (cdr ret))
209       )
210     (if phrase
211         (cons (cons 'phrase phrase) lal)
212       )))
213
214 (defun rfc822/parse-local-part (lal)
215   (let ((ret (rfc822/parse-word lal)))
216     (if ret
217         (let ((local-part (cdr (car ret))) dot)
218           (setq lal (cdr ret))
219           (while (and (setq ret (rfc822/parse-ascii-token lal))
220                       (setq dot (car ret))
221                       (string-equal (cdr (assq 'specials dot)) ".")
222                       (setq ret (rfc822/parse-word (cdr ret)))
223                       (setq local-part
224                             (append local-part dot (cdr (car ret)))
225                             )
226                       (setq lal (cdr ret))
227                       ))
228           (cons (cons 'local-part local-part) lal)
229           ))))
230
231 (defun rfc822/parse-sub-domain (lal)
232   (let ((ret (rfc822/parse-ascii-token lal)))
233     (if ret
234         (let ((sub-domain (car ret)))
235           (if (or (assq 'atom sub-domain)
236                   (assq 'domain-literal sub-domain)
237                   )
238               (cons (cons 'sub-domain sub-domain)
239                     (cdr ret)
240                     )
241             )))))
242
243 (defun rfc822/parse-domain (lal)
244   (let ((ret (rfc822/parse-sub-domain lal)))
245     (if ret
246         (let ((domain (cdr (car ret))) dot)
247           (setq lal (cdr ret))
248           (while (and (setq ret (rfc822/parse-ascii-token lal))
249                       (setq dot (car ret))
250                       (string-equal (cdr (assq 'specials dot)) ".")
251                       (setq ret (rfc822/parse-sub-domain (cdr ret)))
252                       (setq domain
253                             (append domain dot (cdr (car ret)))
254                             )
255                       (setq lal (cdr ret))
256                       ))
257           (cons (cons 'domain domain) lal)
258           ))))
259
260 (defun rfc822/parse-at-domain (lal)
261   (let ((ret (rfc822/parse-ascii-token lal)) at-sign)
262     (if (and ret
263              (setq at-sign (car ret))
264              (string-equal (cdr (assq 'specials at-sign)) "@")
265              (setq ret (rfc822/parse-domain (cdr ret)))
266              )
267         (cons (cons 'at-domain (append at-sign (cdr (car ret))))
268               (cdr ret))
269       )))
270
271 (defun rfc822/parse-addr-spec (lal)
272   (let ((ret (rfc822/parse-local-part lal))
273         addr)
274     (if (and ret
275              (prog1
276                  (setq addr (cdr (car ret)))
277                (setq lal (cdr ret))
278                (and (setq ret (rfc822/parse-at-domain lal))
279                     (setq addr (append addr (cdr (car ret))))
280                     (setq lal (cdr ret))
281                     )))
282         (cons (cons 'addr-spec addr) lal)
283       )))
284
285 (defun rfc822/parse-route (lal)
286   (let ((ret (rfc822/parse-at-domain lal))
287         route comma colon)
288     (if (and ret
289              (progn
290                (setq route (cdr (car ret)))
291                (setq lal (cdr ret))
292                (while (and (setq ret (rfc822/parse-ascii-token lal))
293                            (setq comma (car ret))
294                            (string-equal (cdr (assq 'specials comma)) ",")
295                            (setq ret (rfc822/parse-at-domain (cdr ret)))
296                            )
297                  (setq route (append route comma (cdr (car ret))))
298                  (setq lal (cdr ret))
299                  )
300                (and (setq ret (rfc822/parse-ascii-token lal))
301                     (setq colon (car ret))
302                     (string-equal (cdr (assq 'specials colon)) ":")
303                     (setq route (append route colon))
304                     )
305                ))
306         (cons (cons 'route route)
307               (cdr ret)
308               )
309       )))
310
311 (defun rfc822/parse-route-addr (lal)
312   (let ((ret (rfc822/parse-ascii-token lal))
313         < route addr-spec >)
314     (if (and ret
315              (setq < (car ret))
316              (string-equal (cdr (assq 'specials <)) "<")
317              (setq lal (cdr ret))
318              (progn (and (setq ret (rfc822/parse-route lal))
319                          (setq route (cdr (car ret)))
320                          (setq lal (cdr ret))
321                          )
322                     (setq ret (rfc822/parse-addr-spec lal))
323                     )
324              (setq addr-spec (cdr (car ret)))
325              (setq lal (cdr ret))
326              (setq ret (rfc822/parse-ascii-token lal))
327              (setq > (car ret))
328              (string-equal (cdr (assq 'specials >)) ">")
329              )
330         (cons (cons 'route-addr (append route addr-spec))
331               (cdr ret)
332               )
333       )))
334
335 (defun rfc822/parse-phrase-route-addr (lal)
336   (let ((ret (rfc822/parse-phrase lal)) phrase)
337     (if ret
338         (progn
339           (setq phrase (cdr (car ret)))
340           (setq lal (cdr ret))
341           ))
342     (if (setq ret (rfc822/parse-route-addr lal))
343         (cons (list 'phrase-route-addr
344                     phrase
345                     (cdr (car ret)))
346               (cdr ret))
347       )))
348
349 (defun rfc822/parse-mailbox (lal)
350   (let ((ret (or (rfc822/parse-phrase-route-addr lal)
351                  (rfc822/parse-addr-spec lal)))
352         mbox comment)
353     (if (and ret
354              (prog1
355                  (setq mbox (car ret))
356                (setq lal (cdr ret))
357                (if (and (setq ret (rfc822/parse-token-or-comment lal))
358                         (setq comment (cdr (assq 'comment (car ret))))
359                         )
360                    (setq lal (cdr ret))
361                  )))
362         (cons (list 'mailbox mbox comment)
363               lal)
364       )))
365
366 (defun rfc822/parse-group (lal)
367   (let ((ret (rfc822/parse-phrase lal))
368         phrase colon comma mbox semicolon)
369     (if (and ret
370              (setq phrase (cdr (car ret)))
371              (setq lal (cdr ret))
372              (setq ret (rfc822/parse-ascii-token lal))
373              (setq colon (car ret))
374              (string-equal (cdr (assq 'specials colon)) ":")
375              (setq lal (cdr ret))
376              (progn
377                (and (setq ret (rfc822/parse-mailbox lal))
378                     (setq mbox (list (car ret)))
379                     (setq lal (cdr ret))
380                     (progn
381                       (while (and (setq ret (rfc822/parse-ascii-token lal))
382                                   (setq comma (car ret))
383                                   (string-equal
384                                    (cdr (assq 'specials comma)) ",")
385                                   (setq lal (cdr ret))
386                                   (setq ret (rfc822/parse-mailbox lal))
387                                   (setq mbox (cons (car ret) mbox))
388                                   (setq lal (cdr ret))
389                                   )
390                         )))
391                (and (setq ret (rfc822/parse-ascii-token lal))
392                     (setq semicolon (car ret))
393                     (string-equal (cdr (assq 'specials semicolon)) ";")
394                     )))
395         (cons (list 'group phrase (nreverse mbox))
396               (cdr ret)
397               )
398       )))
399
400 (defun rfc822/parse-address (lal)
401   (or (rfc822/parse-group lal)
402       (rfc822/parse-mailbox lal)
403       ))
404
405 (defun rfc822/parse-addresses (lal)
406   (let ((ret (rfc822/parse-address lal)))
407     (if ret
408         (let ((dest (list (car ret))))
409           (setq lal (cdr ret))
410           (while (and (setq ret (rfc822/parse-ascii-token lal))
411                       (string-equal (cdr (assq 'specials (car ret))) ",")
412                       (setq ret (rfc822/parse-address (cdr ret)))
413                       )
414             (setq dest (cons (car ret) dest))
415             (setq lal (cdr ret))
416             )
417           (nreverse dest)
418           ))))
419
420 (defun rfc822/addr-to-string (seq)
421   (mapconcat (function
422               (lambda (token)
423                 (if (eq (car token) 'spaces)
424                     ""
425                   (cdr token)
426                   )))
427              seq "")
428   )
429
430 (defun rfc822/address-string (address)
431   (cond ((eq (car address) 'group)
432          (mapconcat (function rfc822/address-string)
433                     (nth 2 address)
434                     ", ")
435          )
436         ((eq (car address) 'mailbox)
437          (let ((addr (nth 1 address)))
438            (rfc822/addr-to-string
439             (if (eq (car addr) 'phrase-route-addr)
440                 (nth 2 addr)
441               (cdr addr)
442               )
443             )))))
444
445 (defun rfc822/full-name-string (address)
446   (cond ((eq (car address) 'group)
447          (mapconcat (function
448                      (lambda (token)
449                        (cdr token)
450                        ))
451                     (nth 1 address) "")
452          )
453         ((eq (car address) 'mailbox)
454          (let ((addr (nth 1 address))
455                (comment (nth 2 address))
456                phrase)
457            (if (eq (car addr) 'phrase-route-addr)
458                (setq phrase (mapconcat (function
459                                         (lambda (token)
460                                           (cdr token)
461                                           ))
462                                        (nth 1 addr) ""))
463              )
464            (or phrase comment)
465            ))))
466
467 (defun rfc822/extract-address-components (str)
468   "Extract full name and canonical address from STR.
469 Returns a list of the form (FULL-NAME CANONICAL-ADDRESS).
470 If no name can be extracted, FULL-NAME will be nil. [tl-822.el]"
471   (let* ((structure (car
472                      (rfc822/parse-address
473                       (rfc822/lexical-analyze str)
474                       )))
475          (phrase  (rfc822/full-name-string structure))
476          (address (rfc822/address-string structure))
477          )
478     (list phrase address)
479     ))
480
481
482 ;;; @ end
483 ;;;
484
485 (provide 'tl-822)
486
487 ;;; tl-822.el ends here