(rfc822/lexical-analyze): New alias for `std11-lexical-analyze'; moved
[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.54 1996-08-28 18:12:56 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/analyze-spaces        'std11-analyze-spaces)
121 (defalias 'rfc822/analyze-special       'std11-analyze-special)
122 (defalias 'rfc822/analyze-atom          'std11-analyze-atom)
123 (defalias 'rfc822/analyze-quoted-string 'std11-analyze-quoted-string)
124 (defalias 'rfc822/analyze-domain-literal 'std11-analyze-domain-literal)
125 (defalias 'rfc822/analyze-comment       'std11-analyze-comment)
126
127 (defalias 'rfc822/lexical-analyze       'std11-lexical-analyze)
128
129
130 ;;; @ parser
131 ;;;
132
133 (defun rfc822/ignored-token-p (token)
134   (let ((type (car token)))
135     (or (eq type 'spaces)(eq type 'comment))
136     ))
137
138 (defun rfc822/parse-token (lal)
139   (let (token itl)
140     (while (and lal
141                 (progn
142                   (setq token (car lal))
143                   (rfc822/ignored-token-p token)
144                   ))
145       (setq lal (cdr lal))
146       (setq itl (cons token itl))
147       )
148     (cons (nreverse (cons token itl))
149           (cdr lal))
150     ))
151
152 (defun rfc822/parse-ascii-token (lal)
153   (let (token itl parsed token-value)
154     (while (and lal
155                 (setq token (car lal))
156                 (if (and (setq token-value (cdr token))
157                          (find-charset-string token-value)
158                          )
159                     (setq token nil)
160                   (rfc822/ignored-token-p token)
161                   ))
162       (setq lal (cdr lal))
163       (setq itl (cons token itl))
164       )
165     (if (and token
166              (setq parsed (nreverse (cons token itl)))
167              )
168         (cons parsed (cdr lal))
169       )))
170
171 (defun rfc822/parse-token-or-comment (lal)
172   (let (token itl)
173     (while (and lal
174                 (progn
175                   (setq token (car lal))
176                   (eq (car token) 'spaces)
177                   ))
178       (setq lal (cdr lal))
179       (setq itl (cons token itl))
180       )
181     (cons (nreverse (cons token itl))
182           (cdr lal))
183     ))
184
185 (defun rfc822/parse-word (lal)
186   (let ((ret (rfc822/parse-ascii-token lal)))
187     (if ret
188         (let ((elt (car ret))
189               (rest (cdr ret))
190               )
191           (if (or (assq 'atom elt)
192                   (assq 'quoted-string elt))
193               (cons (cons 'word elt) rest)
194             )))))
195
196 (defun rfc822/parse-word-or-comment (lal)
197   (let ((ret (rfc822/parse-token-or-comment lal)))
198     (if ret
199         (let ((elt (car ret))
200               (rest (cdr ret))
201               )
202           (cond ((or (assq 'atom elt)
203                      (assq 'quoted-string elt))
204                  (cons (cons 'word elt) rest)
205                  )
206                 ((assq 'comment elt)
207                  (cons (cons 'comment-word elt) rest)
208                  ))
209           ))))
210
211 (defun rfc822/parse-phrase (lal)
212   (let (ret phrase)
213     (while (setq ret (rfc822/parse-word-or-comment lal))
214       (setq phrase (append phrase (cdr (car ret))))
215       (setq lal (cdr ret))
216       )
217     (if phrase
218         (cons (cons 'phrase phrase) lal)
219       )))
220
221 (defun rfc822/parse-local-part (lal)
222   (let ((ret (rfc822/parse-word lal)))
223     (if ret
224         (let ((local-part (cdr (car ret))) dot)
225           (setq lal (cdr ret))
226           (while (and (setq ret (rfc822/parse-ascii-token lal))
227                       (setq dot (car ret))
228                       (string-equal (cdr (assq 'specials dot)) ".")
229                       (setq ret (rfc822/parse-word (cdr ret)))
230                       (setq local-part
231                             (append local-part dot (cdr (car ret)))
232                             )
233                       (setq lal (cdr ret))
234                       ))
235           (cons (cons 'local-part local-part) lal)
236           ))))
237
238 (defun rfc822/parse-sub-domain (lal)
239   (let ((ret (rfc822/parse-ascii-token lal)))
240     (if ret
241         (let ((sub-domain (car ret)))
242           (if (or (assq 'atom sub-domain)
243                   (assq 'domain-literal sub-domain)
244                   )
245               (cons (cons 'sub-domain sub-domain)
246                     (cdr ret)
247                     )
248             )))))
249
250 (defun rfc822/parse-domain (lal)
251   (let ((ret (rfc822/parse-sub-domain lal)))
252     (if ret
253         (let ((domain (cdr (car ret))) dot)
254           (setq lal (cdr ret))
255           (while (and (setq ret (rfc822/parse-ascii-token lal))
256                       (setq dot (car ret))
257                       (string-equal (cdr (assq 'specials dot)) ".")
258                       (setq ret (rfc822/parse-sub-domain (cdr ret)))
259                       (setq domain
260                             (append domain dot (cdr (car ret)))
261                             )
262                       (setq lal (cdr ret))
263                       ))
264           (cons (cons 'domain domain) lal)
265           ))))
266
267 (defun rfc822/parse-at-domain (lal)
268   (let ((ret (rfc822/parse-ascii-token lal)) at-sign)
269     (if (and ret
270              (setq at-sign (car ret))
271              (string-equal (cdr (assq 'specials at-sign)) "@")
272              (setq ret (rfc822/parse-domain (cdr ret)))
273              )
274         (cons (cons 'at-domain (append at-sign (cdr (car ret))))
275               (cdr ret))
276       )))
277
278 (defun rfc822/parse-addr-spec (lal)
279   (let ((ret (rfc822/parse-local-part lal))
280         addr)
281     (if (and ret
282              (prog1
283                  (setq addr (cdr (car ret)))
284                (setq lal (cdr ret))
285                (and (setq ret (rfc822/parse-at-domain lal))
286                     (setq addr (append addr (cdr (car ret))))
287                     (setq lal (cdr ret))
288                     )))
289         (cons (cons 'addr-spec addr) lal)
290       )))
291
292 (defun rfc822/parse-route (lal)
293   (let ((ret (rfc822/parse-at-domain lal))
294         route comma colon)
295     (if (and ret
296              (progn
297                (setq route (cdr (car ret)))
298                (setq lal (cdr ret))
299                (while (and (setq ret (rfc822/parse-ascii-token lal))
300                            (setq comma (car ret))
301                            (string-equal (cdr (assq 'specials comma)) ",")
302                            (setq ret (rfc822/parse-at-domain (cdr ret)))
303                            )
304                  (setq route (append route comma (cdr (car ret))))
305                  (setq lal (cdr ret))
306                  )
307                (and (setq ret (rfc822/parse-ascii-token lal))
308                     (setq colon (car ret))
309                     (string-equal (cdr (assq 'specials colon)) ":")
310                     (setq route (append route colon))
311                     )
312                ))
313         (cons (cons 'route route)
314               (cdr ret)
315               )
316       )))
317
318 (defun rfc822/parse-route-addr (lal)
319   (let ((ret (rfc822/parse-ascii-token lal))
320         < route addr-spec >)
321     (if (and ret
322              (setq < (car ret))
323              (string-equal (cdr (assq 'specials <)) "<")
324              (setq lal (cdr ret))
325              (progn (and (setq ret (rfc822/parse-route lal))
326                          (setq route (cdr (car ret)))
327                          (setq lal (cdr ret))
328                          )
329                     (setq ret (rfc822/parse-addr-spec lal))
330                     )
331              (setq addr-spec (cdr (car ret)))
332              (setq lal (cdr ret))
333              (setq ret (rfc822/parse-ascii-token lal))
334              (setq > (car ret))
335              (string-equal (cdr (assq 'specials >)) ">")
336              )
337         (cons (cons 'route-addr (append route addr-spec))
338               (cdr ret)
339               )
340       )))
341
342 (defun rfc822/parse-phrase-route-addr (lal)
343   (let ((ret (rfc822/parse-phrase lal)) phrase)
344     (if ret
345         (progn
346           (setq phrase (cdr (car ret)))
347           (setq lal (cdr ret))
348           ))
349     (if (setq ret (rfc822/parse-route-addr lal))
350         (cons (list 'phrase-route-addr
351                     phrase
352                     (cdr (car ret)))
353               (cdr ret))
354       )))
355
356 (defun rfc822/parse-mailbox (lal)
357   (let ((ret (or (rfc822/parse-phrase-route-addr lal)
358                  (rfc822/parse-addr-spec lal)))
359         mbox comment)
360     (if (and ret
361              (prog1
362                  (setq mbox (car ret))
363                (setq lal (cdr ret))
364                (if (and (setq ret (rfc822/parse-token-or-comment lal))
365                         (setq comment (cdr (assq 'comment (car ret))))
366                         )
367                    (setq lal (cdr ret))
368                  )))
369         (cons (list 'mailbox mbox comment)
370               lal)
371       )))
372
373 (defun rfc822/parse-group (lal)
374   (let ((ret (rfc822/parse-phrase lal))
375         phrase colon comma mbox semicolon)
376     (if (and ret
377              (setq phrase (cdr (car ret)))
378              (setq lal (cdr ret))
379              (setq ret (rfc822/parse-ascii-token lal))
380              (setq colon (car ret))
381              (string-equal (cdr (assq 'specials colon)) ":")
382              (setq lal (cdr ret))
383              (progn
384                (and (setq ret (rfc822/parse-mailbox lal))
385                     (setq mbox (list (car ret)))
386                     (setq lal (cdr ret))
387                     (progn
388                       (while (and (setq ret (rfc822/parse-ascii-token lal))
389                                   (setq comma (car ret))
390                                   (string-equal
391                                    (cdr (assq 'specials comma)) ",")
392                                   (setq lal (cdr ret))
393                                   (setq ret (rfc822/parse-mailbox lal))
394                                   (setq mbox (cons (car ret) mbox))
395                                   (setq lal (cdr ret))
396                                   )
397                         )))
398                (and (setq ret (rfc822/parse-ascii-token lal))
399                     (setq semicolon (car ret))
400                     (string-equal (cdr (assq 'specials semicolon)) ";")
401                     )))
402         (cons (list 'group phrase (nreverse mbox))
403               (cdr ret)
404               )
405       )))
406
407 (defun rfc822/parse-address (lal)
408   (or (rfc822/parse-group lal)
409       (rfc822/parse-mailbox lal)
410       ))
411
412 (defun rfc822/parse-addresses (lal)
413   (let ((ret (rfc822/parse-address lal)))
414     (if ret
415         (let ((dest (list (car ret))))
416           (setq lal (cdr ret))
417           (while (and (setq ret (rfc822/parse-ascii-token lal))
418                       (string-equal (cdr (assq 'specials (car ret))) ",")
419                       (setq ret (rfc822/parse-address (cdr ret)))
420                       )
421             (setq dest (cons (car ret) dest))
422             (setq lal (cdr ret))
423             )
424           (nreverse dest)
425           ))))
426
427 (defun rfc822/addr-to-string (seq)
428   (mapconcat (function
429               (lambda (token)
430                 (if (eq (car token) 'spaces)
431                     ""
432                   (cdr token)
433                   )))
434              seq "")
435   )
436
437 (defun rfc822/address-string (address)
438   (cond ((eq (car address) 'group)
439          (mapconcat (function rfc822/address-string)
440                     (nth 2 address)
441                     ", ")
442          )
443         ((eq (car address) 'mailbox)
444          (let ((addr (nth 1 address)))
445            (rfc822/addr-to-string
446             (if (eq (car addr) 'phrase-route-addr)
447                 (nth 2 addr)
448               (cdr addr)
449               )
450             )))))
451
452 (defun rfc822/full-name-string (address)
453   (cond ((eq (car address) 'group)
454          (mapconcat (function
455                      (lambda (token)
456                        (cdr token)
457                        ))
458                     (nth 1 address) "")
459          )
460         ((eq (car address) 'mailbox)
461          (let ((addr (nth 1 address))
462                (comment (nth 2 address))
463                phrase)
464            (if (eq (car addr) 'phrase-route-addr)
465                (setq phrase (mapconcat (function
466                                         (lambda (token)
467                                           (cdr token)
468                                           ))
469                                        (nth 1 addr) ""))
470              )
471            (or phrase comment)
472            ))))
473
474 (defun rfc822/extract-address-components (str)
475   "Extract full name and canonical address from STR.
476 Returns a list of the form (FULL-NAME CANONICAL-ADDRESS).
477 If no name can be extracted, FULL-NAME will be nil. [tl-822.el]"
478   (let* ((structure (car
479                      (rfc822/parse-address
480                       (rfc822/lexical-analyze str)
481                       )))
482          (phrase  (rfc822/full-name-string structure))
483          (address (rfc822/address-string structure))
484          )
485     (list phrase address)
486     ))
487
488
489 ;;; @ end
490 ;;;
491
492 (provide 'tl-822)
493
494 ;;; tl-822.el ends here