61377e7e6dfa3be2f0744cc89e82f5ce60cc8169
[gnupg.git] / tools / rfc822parse.c
1 /* rfc822parse.c - Simple mail and MIME parser
2  *      Copyright (C) 1999, 2000 Werner Koch, Duesseldorf
3  *      Copyright (C) 2003, 2004 g10 Code GmbH
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public License
7  * as published by the Free Software Foundation; either version 2.1 of
8  * the License, or (at your option) any later version.
9  * 
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU Lesser General Public License for more details.
14  * 
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18  * 02110-1301, USA.
19  */
20
21
22 /* According to RFC822 binary zeroes are allowed at many places. We do
23  * not handle this correct especially in the field parsing code.  It
24  * should be easy to fix and the API provides a interfaces which
25  * returns the length but in addition makes sure that returned strings
26  * are always ended by a \0.
27  *
28  * Furthermore, the case of field names is changed and thus it is not
29  * always a good idea to use these modified header
30  * lines (e.g. signatures may break).
31  */
32
33 #ifdef HAVE_CONFIG_H
34 #include <config.h>
35 #endif
36
37 #include <stdlib.h>
38 #include <stdio.h>
39 #include <string.h>
40 #include <errno.h>
41 #include <stdarg.h>
42 #include <assert.h>
43
44 #include "rfc822parse.h"
45
46 enum token_type
47   {
48     tSPACE,
49     tATOM,
50     tQUOTED,
51     tDOMAINLIT,
52     tSPECIAL
53   };
54
55 /* For now we directly use our TOKEN as the parse context */
56 typedef struct rfc822parse_field_context *TOKEN;
57 struct rfc822parse_field_context
58 {
59   TOKEN next;
60   enum token_type type;
61   struct {
62     unsigned int cont:1;
63     unsigned int lowered:1;
64   } flags;
65   /*TOKEN owner_pantry; */
66   char data[1];
67 };
68
69 struct hdr_line
70 {
71   struct hdr_line *next;
72   int cont;     /* This is a continuation of the previous line. */
73   unsigned char line[1];
74 };
75
76 typedef struct hdr_line *HDR_LINE;
77
78
79 struct part
80 {
81   struct part *right;     /* The next part. */
82   struct part *down;      /* A contained part. */
83   HDR_LINE hdr_lines;       /* Header lines os that part. */
84   HDR_LINE *hdr_lines_tail; /* Helper for adding lines. */
85   char *boundary;           /* Only used in the first part. */
86 };
87 typedef struct part *part_t;
88
89 struct rfc822parse_context
90 {
91   rfc822parse_cb_t callback;
92   void *callback_value;
93   int callback_error;
94   int in_body;
95   int in_preamble;      /* Wether we are before the first boundary. */
96   part_t parts;         /* The tree of parts. */
97   part_t current_part;  /* Whom we are processing (points into parts). */
98   const char *boundary; /* Current boundary. */
99 };
100
101 static HDR_LINE find_header (rfc822parse_t msg, const char *name,
102                              int which, HDR_LINE * rprev);
103
104
105 static size_t
106 length_sans_trailing_ws (const unsigned char *line, size_t len)
107 {
108   const unsigned char *p, *mark;
109   size_t n;
110   
111   for (mark=NULL, p=line, n=0; n < len; n++, p++)
112     {
113       if (strchr (" \t\r\n", *p ))
114         {
115           if( !mark )
116             mark = p;
117         }
118       else
119         mark = NULL;
120     }
121   
122   if (mark) 
123     return mark - line;
124   return len;
125 }
126
127
128 static void
129 lowercase_string (unsigned char *string)
130 {
131   for (; *string; string++)
132     if (*string >= 'A' && *string <= 'Z')
133       *string = *string - 'A' + 'a';
134 }
135
136 /* Transform a header name into a standard capitalized format; i.e
137    "Content-Type".  Conversion stops at the colon.  As usual we don't
138    use the localized versions of ctype.h.
139  */
140 static void
141 capitalize_header_name (unsigned char *name)
142 {
143   int first = 1;
144
145   for (; *name && *name != ':'; name++)
146     if (*name == '-')
147       first = 1;
148     else if (first)
149       {
150         if (*name >= 'a' && *name <= 'z')
151           *name = *name - 'a' + 'A';
152         first = 0;
153       }
154     else if (*name >= 'A' && *name <= 'Z')
155       *name = *name - 'A' + 'a';
156 }
157
158
159 static char *
160 stpcpy (char *a,const char *b)
161 {
162   while (*b)
163     *a++ = *b++;
164   *a = 0;
165   
166   return (char*)a;
167 }
168
169
170 /* If a callback has been registerd, call it for the event of type
171    EVENT. */
172 static int
173 do_callback (rfc822parse_t msg, rfc822parse_event_t event)
174 {
175   int rc;
176
177   if (!msg->callback || msg->callback_error)
178     return 0;
179   rc = msg->callback (msg->callback_value, event, msg);
180   if (rc)
181     msg->callback_error = rc;
182   return rc;
183 }
184
185 static part_t
186 new_part (void)
187 {
188   part_t part;
189
190   part = calloc (1, sizeof *part);
191   if (part)
192     {
193       part->hdr_lines_tail = &part->hdr_lines;
194     }
195   return part;
196 }
197
198
199 static void
200 release_part (part_t part)
201 {
202   part_t tmp;
203   HDR_LINE hdr, hdr2;
204
205   for (; part; part = tmp)
206     {
207       tmp = part->right;
208       if (part->down)
209         release_part (part->down);
210       for (hdr = part->hdr_lines; hdr; hdr = hdr2)
211         {
212           hdr2 = hdr->next;
213           free (hdr);
214         }
215       free (part->boundary);
216       free (part);
217     }
218 }
219
220
221 static void
222 release_handle_data (rfc822parse_t msg)
223 {
224   release_part (msg->parts);
225   msg->parts = NULL;
226   msg->current_part = NULL;
227   msg->boundary = NULL;
228 }
229
230
231 /* Create a new parsing context for an entire rfc822 message and
232    return it.  CB and CB_VALUE may be given to callback for certain
233    events.  NULL is returned on error with errno set appropriately. */
234 rfc822parse_t
235 rfc822parse_open (rfc822parse_cb_t cb, void *cb_value)
236 {
237   rfc822parse_t msg = calloc (1, sizeof *msg);
238   if (msg)
239     {
240       msg->parts = msg->current_part = new_part ();
241       if (!msg->parts)
242         {
243           free (msg);
244           msg = NULL;
245         }
246       else
247         {
248           msg->callback = cb;
249           msg->callback_value = cb_value;
250           if (do_callback (msg, RFC822PARSE_OPEN))
251             {
252               release_handle_data (msg);
253               free (msg);
254               msg = NULL;
255             }
256         }
257     }
258   return msg;
259 }
260
261
262 void
263 rfc822parse_cancel (rfc822parse_t msg)
264 {
265   if (msg)
266     {
267       do_callback (msg, RFC822PARSE_CANCEL);
268       release_handle_data (msg);
269       free (msg);
270     }
271 }
272
273
274 void
275 rfc822parse_close (rfc822parse_t msg)
276 {
277   if (msg)
278     {
279       do_callback (msg, RFC822PARSE_CLOSE);
280       release_handle_data (msg);
281       free (msg);
282     }
283 }
284
285 static part_t
286 find_parent (part_t tree, part_t target)
287 {
288   part_t part;
289
290   for (part = tree->down; part; part = part->right)
291     {
292       if (part == target)
293         return tree; /* Found. */
294       if (part->down)
295         {
296           part_t tmp = find_parent (part, target);
297           if (tmp)
298             return tmp;
299         }
300     }
301   return NULL;
302 }
303
304 static void
305 set_current_part_to_parent (rfc822parse_t msg)
306 {
307   part_t parent;
308
309   assert (msg->current_part);
310   parent = find_parent (msg->parts, msg->current_part);
311   if (!parent)
312     return; /* Already at the top. */
313
314 #ifndef NDEBUG
315   {
316     part_t part;
317     for (part = parent->down; part; part = part->right)
318       if (part == msg->current_part)
319         break;
320     assert (part);
321   }
322 #endif
323   msg->current_part = parent;
324
325   parent = find_parent (msg->parts, parent);
326   msg->boundary = parent? parent->boundary: NULL;
327 }
328
329
330
331 /****************
332  * We have read in all header lines and are about to receive the body
333  * part.  The delimiter line has already been processed.
334  *
335  * FIXME: we's better return an error in case of memory failures.
336  */
337 static int
338 transition_to_body (rfc822parse_t msg)
339 {
340   rfc822parse_field_t ctx;
341   int rc;
342
343   rc = do_callback (msg, RFC822PARSE_T2BODY);
344   if (!rc)
345     {
346       /* Store the boundary if we have multipart type. */
347       ctx = rfc822parse_parse_field (msg, "Content-Type", -1);
348       if (ctx)
349         {
350           const char *s;
351
352           s = rfc822parse_query_media_type (ctx, NULL);
353           if (s && !strcmp (s,"multipart"))
354             {
355               s = rfc822parse_query_parameter (ctx, "boundary", 0);
356               if (s)
357                 {
358                   assert (!msg->current_part->boundary);
359                   msg->current_part->boundary = malloc (strlen (s) + 1);
360                   if (msg->current_part->boundary) 
361                     {
362                       part_t part;
363                   
364                       strcpy (msg->current_part->boundary, s);
365                       msg->boundary = msg->current_part->boundary;
366                       part = new_part ();
367                       if (!part)
368                         {
369                           int save_errno = errno;
370                           rfc822parse_release_field (ctx);
371                           errno = save_errno;
372                           return -1;
373                         }
374                       rc = do_callback (msg, RFC822PARSE_LEVEL_DOWN);
375                       assert (!msg->current_part->down);
376                       msg->current_part->down = part;
377                       msg->current_part = part;
378                       msg->in_preamble = 1;
379                     }
380                 }
381             }
382           rfc822parse_release_field (ctx);
383         }
384     }
385
386   return rc;
387 }
388
389 /* We have just passed a MIME boundary and need to prepare for new part.
390    headers. */
391 static int
392 transition_to_header (rfc822parse_t msg)
393 {
394   part_t part;
395
396   assert (msg->current_part);
397   assert (!msg->current_part->right);
398
399   part = new_part ();
400   if (!part)
401     return -1;
402
403   msg->current_part->right = part;
404   msg->current_part = part;
405   return 0;
406 }
407
408
409 static int
410 insert_header (rfc822parse_t msg, const unsigned char *line, size_t length)
411 {
412   HDR_LINE hdr;
413
414   assert (msg->current_part);
415   if (!length)
416     {
417       msg->in_body = 1;
418       return transition_to_body (msg);
419     }
420
421   if (!msg->current_part->hdr_lines)
422     do_callback (msg, RFC822PARSE_BEGIN_HEADER);
423
424   length = length_sans_trailing_ws (line, length);
425   hdr = malloc (sizeof (*hdr) + length);
426   if (!hdr)
427     return -1;
428   hdr->next = NULL;
429   hdr->cont = (*line == ' ' || *line == '\t');
430   memcpy (hdr->line, line, length);
431   hdr->line[length] = 0; /* Make it a string. */
432   
433   /* Transform a field name into canonical format. */
434   if (!hdr->cont && strchr (line, ':'))
435      capitalize_header_name (hdr->line);
436
437   *msg->current_part->hdr_lines_tail = hdr;
438   msg->current_part->hdr_lines_tail = &hdr->next;
439
440   /* Lets help the caller to prevent mail loops and issue an event for
441    * every Received header. */
442   if (length >= 9 && !memcmp (line, "Received:", 9))
443      do_callback (msg, RFC822PARSE_RCVD_SEEN);
444   return 0;
445 }
446
447
448 /****************
449  * Note: We handle the body transparent to allow binary zeroes in it.
450  */
451 static int
452 insert_body (rfc822parse_t msg, const unsigned char *line, size_t length)
453 {
454   int rc = 0;
455
456   if (length > 2 && *line == '-' && line[1] == '-' && msg->boundary)
457     {
458       size_t blen = strlen (msg->boundary);
459
460       if (length == blen + 2
461           && !memcmp (line+2, msg->boundary, blen))
462         {
463           rc = do_callback (msg, RFC822PARSE_BOUNDARY);
464           msg->in_body = 0;
465           if (!rc && !msg->in_preamble)
466             rc = transition_to_header (msg);
467           msg->in_preamble = 0;
468         }
469       else if (length == blen + 4
470           && line[length-2] =='-' && line[length-1] == '-'
471           && !memcmp (line+2, msg->boundary, blen))
472         {
473           rc = do_callback (msg, RFC822PARSE_LAST_BOUNDARY);
474           msg->boundary = NULL; /* No current boundary anymore. */
475           set_current_part_to_parent (msg);
476
477           /* Fixme: The next should acctually be sent right before the
478              next boundary, so that we can mark the epilogue. */
479           if (!rc)
480             rc = do_callback (msg, RFC822PARSE_LEVEL_UP);
481         }
482     }
483   if (msg->in_preamble && !rc)
484     rc = do_callback (msg, RFC822PARSE_PREAMBLE);
485
486   return rc;
487 }
488
489 /* Insert the next line into the parser. Return 0 on success or true
490    on error with errno set appropriately. */
491 int
492 rfc822parse_insert (rfc822parse_t msg, const unsigned char *line, size_t length)
493 {
494   return (msg->in_body 
495           ? insert_body (msg, line, length)
496           : insert_header (msg, line, length));
497 }
498
499
500 /* Tell the parser that we have finished the message. */
501 int
502 rfc822parse_finish (rfc822parse_t msg)
503 {
504   return do_callback (msg, RFC822PARSE_FINISH);
505 }
506
507
508
509 /****************
510  * Get a copy of a header line. The line is returned as one long
511  * string with LF to separate the continuation line. Caller must free
512  * the return buffer.  WHICH may be used to enumerate over all lines.
513  * Wildcards are allowed.  This function works on the current headers;
514  * i.e. the regular mail headers or the MIME headers of the current
515  * part.
516  *
517  * WHICH gives the mode:
518  *  -1 := Take the last occurence
519  *   n := Take the n-th  one.
520  * 
521  * Returns a newly allocated buffer or NULL on error.  errno is set in
522  * case of a memory failure or set to 0 if the requested field is not
523  * available.
524  * 
525  * If VALUEOFF is not NULL it will receive the offset of the first non
526  * space character in th value of the line.
527  */
528 char *
529 rfc822parse_get_field (rfc822parse_t msg, const char *name, int which,
530                        size_t *valueoff)
531 {
532   HDR_LINE h, h2;
533   char *buf, *p;
534   size_t n;
535
536   h = find_header (msg, name, which, NULL);
537   if (!h)
538     {
539       errno = 0;
540       return NULL; /* no such field */
541     }
542
543   n = strlen (h->line) + 1;
544   for (h2 = h->next; h2 && h2->cont; h2 = h2->next)
545     n += strlen (h2->line) + 1;
546
547   buf = p = malloc (n);
548   if (buf)
549     {
550       p = stpcpy (p, h->line);
551       *p++ = '\n';
552       for (h2 = h->next; h2 && h2->cont; h2 = h2->next)
553         {
554           p = stpcpy (p, h2->line);
555           *p++ = '\n';
556         }
557       p[-1] = 0;
558     }
559
560   if (valueoff)
561     {
562       p = strchr (buf, ':');
563       if (!p)
564         *valueoff = 0; /* Oops: should never happen. */
565       else
566         {
567           p++;
568           while (*p == ' ' || *p == '\t' || *p == '\r' || *p == '\n')
569             p++;
570           *valueoff = p - buf;
571         }
572     }
573
574   return buf;
575 }
576
577
578 /****************
579  * Enumerate all header.  Caller has to provide the address of a pointer
580  * which has to be initialzed to NULL, the caller should then never change this
581  * pointer until he has closed the enumeration by passing again the address
582  * of the pointer but with msg set to NULL.
583  * The function returns pointers to all the header lines or NULL when
584  * all lines have been enumerated or no headers are available.
585  */
586 const char *
587 rfc822parse_enum_header_lines (rfc822parse_t msg, void **context)
588 {
589   HDR_LINE l;
590
591   if (!msg) /* Close. */
592     return NULL;        
593
594   if (*context == msg || !msg->current_part)
595     return NULL;
596
597   l = *context ? (HDR_LINE) *context : msg->current_part->hdr_lines;
598
599   if (l)
600     {
601       *context = l->next ? (void *) (l->next) : (void *) msg;
602       return l->line;
603     }
604   *context = msg; /* Mark end of list. */
605   return NULL;
606 }
607
608
609
610 /****************
611  * Find a header field.  If the Name does end in an asterisk this is meant
612  * to be a wildcard.
613  *
614  *  which  -1 : Retrieve the last field
615  *         >0 : Retrieve the n-th field
616
617  * RPREV may be used to return the predecessor of the returned field;
618  * which may be NULL for the very first one. It has to be initialzed
619  * to either NULL in which case the search start at the first header line,
620  * or it may point to a headerline, where the search should start
621  */
622 static HDR_LINE
623 find_header (rfc822parse_t msg, const char *name, int which, HDR_LINE *rprev)
624 {
625   HDR_LINE hdr, prev = NULL, mark = NULL;
626   unsigned char *p;
627   size_t namelen, n;
628   int found = 0;
629   int glob = 0;
630
631   if (!msg->current_part)
632     return NULL;
633
634   namelen = strlen (name);
635   if (namelen && name[namelen - 1] == '*')
636     {
637       namelen--;
638       glob = 1;
639     }
640
641   hdr = msg->current_part->hdr_lines;
642   if (rprev && *rprev)
643     {
644       /* spool forward to the requested starting place.
645        * we cannot simply set this as we have to return
646        * the previous list element too */
647       for (; hdr && hdr != *rprev; prev = hdr, hdr = hdr->next)
648         ;
649     }
650
651   for (; hdr; prev = hdr, hdr = hdr->next)
652     {
653       if (hdr->cont)
654         continue;
655       if (!(p = strchr (hdr->line, ':')))
656         continue;               /* invalid header, just skip it. */
657       n = p - hdr->line;
658       if (!n)
659         continue;               /* invalid name */
660       if ((glob ? (namelen <= n) : (namelen == n))
661           && !memcmp (hdr->line, name, namelen))
662         {
663           found++;
664           if (which == -1)
665             mark = hdr;
666           else if (found == which)
667             {
668               if (rprev)
669                 *rprev = prev;
670               return hdr;
671             }
672         }
673     }
674   if (mark && rprev)
675     *rprev = prev;
676   return mark;
677 }
678
679
680
681 static const char *
682 skip_ws (const char *s)
683 {
684   while (*s == ' ' || *s == '\t' || *s == '\r' || *s == '\n')
685     s++;
686   return s;
687 }
688
689
690 static void
691 release_token_list (TOKEN t)
692 {
693   while (t)
694     {
695       TOKEN t2 = t->next;
696       /* fixme: If we have owner_pantry, put the token back to
697        * this pantry so that it can be reused later */
698       free (t);
699       t = t2;
700     }
701 }
702
703
704 static TOKEN
705 new_token (enum token_type type, const char *buf, size_t length)
706 {
707   TOKEN t;
708
709   /* fixme: look through our pantries to find a suitable
710    * token for reuse */
711   t = malloc (sizeof *t + length);
712   if (t)
713     {
714       t->next = NULL;
715       t->type = type;
716       memset (&t->flags, 0, sizeof (t->flags));
717       t->data[0] = 0;
718       if (buf)
719         {
720           memcpy (t->data, buf, length);
721           t->data[length] = 0;  /* Make sure it is a C string. */
722         }
723       else
724         t->data[0] = 0;
725     }
726   return t;
727 }
728
729 static TOKEN
730 append_to_token (TOKEN old, const char *buf, size_t length)
731 {
732   size_t n = strlen (old->data);
733   TOKEN t;
734
735   t = malloc (sizeof *t + n + length);
736   if (t)
737     {
738       t->next = old->next;
739       t->type = old->type;
740       t->flags = old->flags;
741       memcpy (t->data, old->data, n);
742       memcpy (t->data + n, buf, length);
743       t->data[n + length] = 0;
744       old->next = NULL;
745       release_token_list (old);
746     }
747   return t;
748 }
749
750
751
752 /*
753    Parse a field into tokens as defined by rfc822.
754  */
755 static TOKEN
756 parse_field (HDR_LINE hdr)
757 {
758   static const char specials[] = "<>@.,;:\\[]\"()";
759   static const char specials2[] = "<>@.,;:";
760   static const char tspecials[] = "/?=<>@,;:\\[]\"()";
761   static const char tspecials2[] = "/?=<>@.,;:";
762   static struct 
763   {
764     const unsigned char *name;
765     size_t namelen;
766   } tspecial_header[] = {
767     { "Content-Type", 12},
768     { "Content-Transfer-Encoding", 25},
769     { NULL, 0}
770   };
771   const char *delimiters;
772   const char *delimiters2;
773   const unsigned char *line, *s, *s2;
774   size_t n;
775   int i, invalid = 0;
776   TOKEN t, tok, *tok_tail;
777
778   errno = 0;
779   if (!hdr)
780     return NULL;
781
782   tok = NULL;
783   tok_tail = &tok;
784
785   line = hdr->line;
786   if (!(s = strchr (line, ':')))
787     return NULL; /* oops */
788
789   n = s - line;
790   if (!n)
791     return NULL; /* oops: invalid name */
792
793   delimiters = specials;
794   delimiters2 = specials2;
795   for (i = 0; tspecial_header[i].name; i++)
796     {
797       if (n == tspecial_header[i].namelen
798           && !memcmp (line, tspecial_header[i].name, n))
799         {
800           delimiters = tspecials;
801           delimiters2 = tspecials2;
802           break;
803         }
804     }
805
806   s++; /* Move over the colon. */
807   for (;;)
808     {
809       if (!*s)
810         {
811           if (!hdr->next || !hdr->next->cont)
812             break;
813           hdr = hdr->next;
814           s = hdr->line;
815         }
816
817       if (*s == '(')
818         {
819           int level = 1;
820           int in_quote = 0;
821
822           invalid = 0;
823           for (s++;; s++)
824             {
825               if (!*s)
826                 {
827                   if (!hdr->next || !hdr->next->cont)
828                     break;
829                   hdr = hdr->next;
830                   s = hdr->line;
831                 }
832
833               if (in_quote)
834                 {
835                   if (*s == '\"')
836                     in_quote = 0;
837                   else if (*s == '\\' && s[1])  /* what about continuation? */
838                     s++;
839                 }
840               else if (*s == ')')
841                 {
842                   if (!--level)
843                     break;
844                 }
845               else if (*s == '(')
846                 level++;
847               else if (*s == '\"')
848                 in_quote = 1;
849             }
850           if (!*s)
851             ; /* Actually this is an error, but we don't care about it. */
852           else
853             s++;
854         }
855       else if (*s == '\"' || *s == '[')
856         {
857           /* We do not check for non-allowed nesting of domainliterals */
858           int term = *s == '\"' ? '\"' : ']';
859           invalid = 0;
860           s++;
861           t = NULL;
862
863           for (;;)
864             {
865               for (s2 = s; *s2; s2++)
866                 {
867                   if (*s2 == term)
868                     break;
869                   else if (*s2 == '\\' && s2[1]) /* what about continuation? */
870                     s2++;
871                 }
872               
873               t = (t
874                    ? append_to_token (t, s, s2 - s)
875                    : new_token (term == '\"'? tQUOTED : tDOMAINLIT, s, s2 - s));
876               if (!t)
877                 goto failure;
878                    
879               if (*s2 || !hdr->next || !hdr->next->cont)
880                 break;
881               hdr = hdr->next;
882               s = hdr->line;
883             }
884           *tok_tail = t;
885           tok_tail = &t->next;
886           s = s2;
887           if (*s)
888             s++; /* skip the delimiter */
889         }
890       else if ((s2 = strchr (delimiters2, *s)))
891         { /* Special characters which are not handled above. */
892           invalid = 0;
893           t = new_token (tSPECIAL, s, 1);
894           if (!t)
895             goto failure;
896           *tok_tail = t;
897           tok_tail = &t->next;
898           s++;
899         }
900       else if (*s == ' ' || *s == '\t' || *s == '\r' || *s == '\n')
901         {
902           invalid = 0;
903           s = skip_ws (s + 1);
904         }
905       else if (*s > 0x20 && !(*s & 128))
906         { /* Atom. */
907           invalid = 0;
908           for (s2 = s + 1; *s2 > 0x20
909                && !(*s2 & 128) && !strchr (delimiters, *s2); s2++)
910             ;
911           t = new_token (tATOM, s, s2 - s);
912           if (!t)
913             goto failure;
914           *tok_tail = t;
915           tok_tail = &t->next;
916           s = s2;
917         }
918       else
919         { /* Invalid character. */
920           if (!invalid)
921             { /* For parsing we assume only one space. */
922               t = new_token (tSPACE, NULL, 0);
923               if (!t)
924                 goto failure;
925               *tok_tail = t;
926               tok_tail = &t->next;
927               invalid = 1;
928             }
929           s++;
930         }
931     }
932
933   return tok;
934
935  failure:
936   {
937     int save = errno;
938     release_token_list (tok);
939     errno = save;
940   }
941   return NULL;
942 }
943
944
945
946
947 /****************
948  * Find and parse a header field.
949  * WHICH indicates what to do if there are multiple instance of the same
950  * field (like "Received"); the following value are defined:
951  *  -1 := Take the last occurence
952  *   0 := Reserved
953  *   n := Take the n-th one.
954  * Returns a handle for further operations on the parse context of the field
955  * or NULL if the field was not found.
956  */
957 rfc822parse_field_t
958 rfc822parse_parse_field (rfc822parse_t msg, const char *name, int which)
959 {
960   HDR_LINE hdr;
961
962   if (!which)
963     return NULL;
964
965   hdr = find_header (msg, name, which, NULL);
966   if (!hdr)
967     return NULL;
968   return parse_field (hdr);
969 }
970
971 void
972 rfc822parse_release_field (rfc822parse_field_t ctx)
973 {
974   if (ctx)
975     release_token_list (ctx);
976 }
977
978
979
980 /****************
981  * Check whether T points to a parameter.
982  * A parameter starts with a semicolon and it is assumed that t
983  * points to exactly this one.
984  */
985 static int
986 is_parameter (TOKEN t)
987 {
988   t = t->next;
989   if (!t || t->type != tATOM)
990     return 0;
991   t = t->next;
992   if (!t || !(t->type == tSPECIAL && t->data[0] == '='))
993     return 0;
994   t = t->next;
995   if (!t)
996     return 1; /* We assume that an non existing value is an empty one. */
997   return t->type == tQUOTED || t->type == tATOM;
998 }
999
1000 /*
1001    Some header (Content-type) have a special syntax where attribute=value
1002    pairs are used after a leading semicolon.  The parse_field code
1003    knows about these fields and changes the parsing to the one defined
1004    in RFC2045.
1005    Returns a pointer to the value which is valid as long as the
1006    parse context is valid; NULL is returned in case that attr is not
1007    defined in the header, a missing value is reppresented by an empty string.
1008  
1009    With LOWER_VALUE set to true, a matching field valuebe be
1010    lowercased.
1011  
1012    Note, that ATTR should be lowercase.
1013  */
1014 const char *
1015 rfc822parse_query_parameter (rfc822parse_field_t ctx, const char *attr,
1016                              int lower_value)
1017 {
1018   TOKEN t, a;
1019
1020   for (t = ctx; t; t = t->next)
1021     {
1022       /* skip to the next semicolon */
1023       for (; t && !(t->type == tSPECIAL && t->data[0] == ';'); t = t->next)
1024         ;
1025       if (!t)
1026         return NULL;
1027       if (is_parameter (t))
1028         { /* Look closer. */
1029           a = t->next; /* We know that this is an atom */
1030           if ( !a->flags.lowered )
1031             {
1032               lowercase_string (a->data);
1033               a->flags.lowered = 1;
1034             }
1035           if (!strcmp (a->data, attr))
1036             { /* found */
1037               t = a->next->next;
1038               /* Either T is now an atom, a quoted string or NULL in
1039                * which case we return an empty string. */
1040
1041               if ( lower_value && t && !t->flags.lowered )
1042                 {
1043                   lowercase_string (t->data);
1044                   t->flags.lowered = 1;
1045                 }
1046               return t ? t->data : "";
1047             }
1048         }
1049     }
1050   return NULL;
1051 }
1052
1053 /****************
1054  * This function may be used for the Content-Type header to figure out
1055  * the media type and subtype.  Note, that the returned strings are
1056  * guaranteed to be lowercase as required by MIME.
1057  *
1058  * Returns: a pointer to the media type and if subtype is not NULL,
1059  *          a pointer to the subtype.
1060  */
1061 const char *
1062 rfc822parse_query_media_type (rfc822parse_field_t ctx, const char **subtype)
1063 {
1064   TOKEN t = ctx;
1065   const char *type;
1066
1067   if (t->type != tATOM)
1068     return NULL;
1069   if (!t->flags.lowered)
1070     {
1071       lowercase_string (t->data);
1072       t->flags.lowered = 1;
1073     }
1074   type = t->data;
1075   t = t->next;
1076   if (!t || t->type != tSPECIAL || t->data[0] != '/')
1077     return NULL;
1078   t = t->next;
1079   if (!t || t->type != tATOM)
1080     return NULL;
1081
1082   if (subtype)
1083     {
1084       if (!t->flags.lowered)
1085         {
1086           lowercase_string (t->data);
1087           t->flags.lowered = 1;
1088         }
1089       *subtype = t->data;
1090     }
1091   return type;
1092 }
1093
1094
1095
1096
1097
1098 #ifdef TESTING
1099
1100 /* Internal debug function to print the structure of the message. */
1101 static void
1102 dump_structure (rfc822parse_t msg, part_t part, int indent)
1103 {
1104   if (!part)
1105     {
1106       printf ("*** Structure of this message:\n");
1107       part = msg->parts;
1108     }
1109
1110   for (; part; part = part->right)
1111     {
1112       rfc822parse_field_t ctx;
1113       part_t save_part; /* ugly hack - we should have a function to
1114                            get part inforation. */
1115       const char *s;
1116       
1117       save_part = msg->current_part;
1118       msg->current_part = part;
1119       ctx = rfc822parse_parse_field (msg, "Content-Type", -1);
1120       msg->current_part = save_part;
1121       if (ctx)
1122         {
1123           const char *s1, *s2;
1124           s1 = rfc822parse_query_media_type (ctx, &s2);
1125           if (s1)
1126             printf ("***   %*s %s/%s", indent*2, "", s1, s2);
1127           else
1128             printf ("***   %*s [not found]", indent*2, "");
1129
1130           s = rfc822parse_query_parameter (ctx, "boundary", 0);
1131           if (s)
1132             printf (" (boundary=\"%s\")", s);
1133           rfc822parse_release_field (ctx);
1134         }
1135       else
1136         printf ("***   %*s text/plain [assumed]", indent*2, "");
1137       putchar('\n');
1138
1139       if (part->down)
1140         dump_structure (msg, part->down, indent + 1);
1141     }
1142   
1143 }
1144
1145
1146
1147 static void
1148 show_param (rfc822parse_field_t ctx, const char *name)
1149 {
1150   const char *s;
1151
1152   if (!ctx)
1153     return;
1154   s = rfc822parse_query_parameter (ctx, name, 0);
1155   if (s)
1156     printf ("***   %s: `%s'\n", name, s);
1157 }
1158
1159
1160
1161 static void
1162 show_event (rfc822parse_event_t event)
1163 {
1164   const char *s;
1165
1166   switch (event)
1167     {
1168     case RFC822PARSE_OPEN: s= "Open"; break;
1169     case RFC822PARSE_CLOSE: s= "Close"; break;
1170     case RFC822PARSE_CANCEL: s= "Cancel"; break;
1171     case RFC822PARSE_T2BODY: s= "T2Body"; break;
1172     case RFC822PARSE_FINISH: s= "Finish"; break;
1173     case RFC822PARSE_RCVD_SEEN: s= "Rcvd_Seen"; break;
1174     case RFC822PARSE_BOUNDARY: s= "Boundary"; break;
1175     case RFC822PARSE_LAST_BOUNDARY: s= "Last_Boundary"; break;
1176     default: s= "***invalid event***"; break;
1177     }
1178   printf ("*** got RFC822 event %s\n", s);
1179 }
1180
1181 static int
1182 msg_cb (void *dummy_arg, rfc822parse_event_t event, rfc822parse_t msg)
1183 {
1184   show_event (event);
1185   if (event == RFC822PARSE_T2BODY)
1186     {
1187       rfc822parse_field_t ctx;
1188       void *ectx;
1189       const char *line;
1190
1191       for (ectx=NULL; (line = rfc822parse_enum_header_lines (msg, &ectx)); )
1192         {
1193           printf ("*** HDR: %s\n", line);
1194         }
1195       rfc822parse_enum_header_lines (NULL, &ectx); /* Close enumerator. */
1196
1197       ctx = rfc822parse_parse_field (msg, "Content-Type", -1);
1198       if (ctx)
1199         {
1200           const char *s1, *s2;
1201           s1 = rfc822parse_query_media_type (ctx, &s2);
1202           if (s1)
1203             printf ("***   media: `%s/%s'\n", s1, s2);
1204           else
1205             printf ("***   media: [not found]\n");
1206           show_param (ctx, "boundary");
1207           show_param (ctx, "protocol");
1208           rfc822parse_release_field (ctx);
1209         }
1210       else
1211         printf ("***   media: text/plain [assumed]\n");
1212       
1213     }
1214
1215
1216   return 0;
1217 }
1218
1219
1220
1221 int
1222 main (int argc, char **argv)
1223 {
1224   char line[5000];
1225   size_t length;
1226   rfc822parse_t msg;
1227
1228   msg = rfc822parse_open (msg_cb, NULL);
1229   if (!msg)
1230     abort ();
1231
1232   while (fgets (line, sizeof (line), stdin))
1233     {
1234       length = strlen (line);
1235       if (length && line[length - 1] == '\n')
1236         line[--length] = 0;
1237       if (length && line[length - 1] == '\r')
1238         line[--length] = 0;
1239       if (rfc822parse_insert (msg, line, length))
1240         abort ();
1241     }
1242
1243   dump_structure (msg, NULL, 0);
1244
1245   rfc822parse_close (msg);
1246   return 0;
1247 }
1248 #endif
1249
1250 /*
1251 Local Variables:
1252 compile-command: "gcc -Wall -g -DTESTING -o rfc822parse rfc822parse.c"
1253 End:
1254 */