Some minor bug fixes, new test utilities and started support for other
[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, 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 General Public License as
7  * published by the Free Software Foundation; either version 2 of the
8  * License, or (at your option) any later version.
9  *
10  * This program is 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 GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
18  */
19
20
21 /* According to RFC822 binary 0 are allowed at many places. We
22  * do not handle this correct especially in the field parsing code.  It
23  * should be easy to fix and the API provides a interfcaes which returns
24  * the length but in addition makes sure that returned strings are always
25  * ended by a \0.  
26  *
27  * Furthermore, the case of field names is changed and thus it is not
28  * always a good idea to use these modified header
29  * lines (e.g. signatures may break).
30  * 
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 char *
526 rfc822parse_get_field (rfc822parse_t msg, const char *name, int which)
527 {
528   HDR_LINE h, h2;
529   char *buf, *p;
530   size_t n;
531
532   h = find_header (msg, name, which, NULL);
533   if (!h)
534     {
535       errno = 0;
536       return NULL; /* no such field */
537     }
538
539   n = strlen (h->line) + 1;
540   for (h2 = h->next; h2 && h2->cont; h2 = h2->next)
541     n += strlen (h2->line) + 1;
542
543   buf = p = malloc (n);
544   if (buf)
545     {
546       p = stpcpy (p, h->line);
547       *p++ = '\n';
548       for (h2 = h->next; h2 && h2->cont; h2 = h2->next)
549         {
550           p = stpcpy (p, h2->line);
551           *p++ = '\n';
552         }
553       p[-1] = 0;
554     }
555   return buf;
556 }
557
558
559 /****************
560  * Enumerate all header.  Caller has to provide the address of a pointer
561  * which has to be initialzed to NULL, the caller should then never change this
562  * pointer until he has closed the enumeration by passing again the address
563  * of the pointer but with msg set to NULL.
564  * The function returns pointers to all the header lines or NULL when
565  * all lines have been enumerated or no headers are available.
566  */
567 const char *
568 rfc822parse_enum_header_lines (rfc822parse_t msg, void **context)
569 {
570   HDR_LINE l;
571
572   if (!msg) /* Close. */
573     return NULL;        
574
575   if (*context == msg || !msg->current_part)
576     return NULL;
577
578   l = *context ? (HDR_LINE) *context : msg->current_part->hdr_lines;
579
580   if (l)
581     {
582       *context = l->next ? (void *) (l->next) : (void *) msg;
583       return l->line;
584     }
585   *context = msg; /* Mark end of list. */
586   return NULL;
587 }
588
589
590
591 /****************
592  * Find a header field.  If the Name does end in an asterisk this is meant
593  * to be a wildcard.
594  *
595  *  which  -1 : Retrieve the last field
596  *         >0 : Retrieve the n-th field
597
598  * RPREV may be used to return the predecessor of the returned field;
599  * which may be NULL for the very first one. It has to be initialzed
600  * to either NULL in which case the search start at the first header line,
601  * or it may point to a headerline, where the search should start
602  */
603 static HDR_LINE
604 find_header (rfc822parse_t msg, const char *name, int which, HDR_LINE *rprev)
605 {
606   HDR_LINE hdr, prev = NULL, mark = NULL;
607   unsigned char *p;
608   size_t namelen, n;
609   int found = 0;
610   int glob = 0;
611
612   if (!msg->current_part)
613     return NULL;
614
615   namelen = strlen (name);
616   if (namelen && name[namelen - 1] == '*')
617     {
618       namelen--;
619       glob = 1;
620     }
621
622   hdr = msg->current_part->hdr_lines;
623   if (rprev && *rprev)
624     {
625       /* spool forward to the requested starting place.
626        * we cannot simply set this as we have to return
627        * the previous list element too */
628       for (; hdr && hdr != *rprev; prev = hdr, hdr = hdr->next)
629         ;
630     }
631
632   for (; hdr; prev = hdr, hdr = hdr->next)
633     {
634       if (hdr->cont)
635         continue;
636       if (!(p = strchr (hdr->line, ':')))
637         continue;               /* invalid header, just skip it. */
638       n = p - hdr->line;
639       if (!n)
640         continue;               /* invalid name */
641       if ((glob ? (namelen <= n) : (namelen == n))
642           && !memcmp (hdr->line, name, namelen))
643         {
644           found++;
645           if (which == -1)
646             mark = hdr;
647           else if (found == which)
648             {
649               if (rprev)
650                 *rprev = prev;
651               return hdr;
652             }
653         }
654     }
655   if (mark && rprev)
656     *rprev = prev;
657   return mark;
658 }
659
660
661
662 static const char *
663 skip_ws (const char *s)
664 {
665   while (*s == ' ' || *s == '\t' || *s == '\r' || *s == '\n')
666     s++;
667   return s;
668 }
669
670
671 static void
672 release_token_list (TOKEN t)
673 {
674   while (t)
675     {
676       TOKEN t2 = t->next;
677       /* fixme: If we have owner_pantry, put the token back to
678        * this pantry so that it can be reused later */
679       free (t);
680       t = t2;
681     }
682 }
683
684
685 static TOKEN
686 new_token (enum token_type type, const char *buf, size_t length)
687 {
688   TOKEN t;
689
690   /* fixme: look through our pantries to find a suitable
691    * token for reuse */
692   t = malloc (sizeof *t + length);
693   if (t)
694     {
695       t->next = NULL;
696       t->type = type;
697       memset (&t->flags, 0, sizeof (t->flags));
698       t->data[0] = 0;
699       if (buf)
700         {
701           memcpy (t->data, buf, length);
702           t->data[length] = 0;  /* Make sure it is a C string. */
703         }
704       else
705         t->data[0] = 0;
706     }
707   return t;
708 }
709
710 static TOKEN
711 append_to_token (TOKEN old, const char *buf, size_t length)
712 {
713   size_t n = strlen (old->data);
714   TOKEN t;
715
716   t = malloc (sizeof *t + n + length);
717   if (t)
718     {
719       t->next = old->next;
720       t->type = old->type;
721       t->flags = old->flags;
722       memcpy (t->data, old->data, n);
723       memcpy (t->data + n, buf, length);
724       t->data[n + length] = 0;
725       old->next = NULL;
726       release_token_list (old);
727     }
728   return t;
729 }
730
731
732
733 /*
734    Parse a field into tokens as defined by rfc822.
735  */
736 static TOKEN
737 parse_field (HDR_LINE hdr)
738 {
739   static const char specials[] = "<>@.,;:\\[]\"()";
740   static const char specials2[] = "<>@.,;:";
741   static const char tspecials[] = "/?=<>@,;:\\[]\"()";
742   static const char tspecials2[] = "/?=<>@.,;:";
743   static struct 
744   {
745     const unsigned char *name;
746     size_t namelen;
747   } tspecial_header[] = {
748     { "Content-Type", 12},
749     { "Content-Transfer-Encoding", 25},
750     { NULL, 0}
751   };
752   const char *delimiters;
753   const char *delimiters2;
754   const unsigned char *line, *s, *s2;
755   size_t n;
756   int i, invalid = 0;
757   TOKEN t, tok, *tok_tail;
758
759   errno = 0;
760   if (!hdr)
761     return NULL;
762
763   tok = NULL;
764   tok_tail = &tok;
765
766   line = hdr->line;
767   if (!(s = strchr (line, ':')))
768     return NULL; /* oops */
769
770   n = s - line;
771   if (!n)
772     return NULL; /* oops: invalid name */
773
774   delimiters = specials;
775   delimiters2 = specials2;
776   for (i = 0; tspecial_header[i].name; i++)
777     {
778       if (n == tspecial_header[i].namelen
779           && !memcmp (line, tspecial_header[i].name, n))
780         {
781           delimiters = tspecials;
782           delimiters2 = tspecials2;
783           break;
784         }
785     }
786
787   s++; /* Move over the colon. */
788   for (;;)
789     {
790       if (!*s)
791         {
792           if (!hdr->next || !hdr->next->cont)
793             break;
794           hdr = hdr->next;
795           s = hdr->line;
796         }
797
798       if (*s == '(')
799         {
800           int level = 1;
801           int in_quote = 0;
802
803           invalid = 0;
804           for (s++;; s++)
805             {
806               if (!*s)
807                 {
808                   if (!hdr->next || !hdr->next->cont)
809                     break;
810                   hdr = hdr->next;
811                   s = hdr->line;
812                 }
813
814               if (in_quote)
815                 {
816                   if (*s == '\"')
817                     in_quote = 0;
818                   else if (*s == '\\' && s[1])  /* what about continuation? */
819                     s++;
820                 }
821               else if (*s == ')')
822                 {
823                   if (!--level)
824                     break;
825                 }
826               else if (*s == '(')
827                 level++;
828               else if (*s == '\"')
829                 in_quote = 1;
830             }
831           if (!*s)
832             ; /* Actually this is an error, but we don't care about it. */
833           else
834             s++;
835         }
836       else if (*s == '\"' || *s == '[')
837         {
838           /* We do not check for non-allowed nesting of domainliterals */
839           int term = *s == '\"' ? '\"' : ']';
840           invalid = 0;
841           s++;
842           t = NULL;
843
844           for (;;)
845             {
846               for (s2 = s; *s2; s2++)
847                 {
848                   if (*s2 == term)
849                     break;
850                   else if (*s2 == '\\' && s2[1]) /* what about continuation? */
851                     s2++;
852                 }
853               
854               t = (t
855                    ? append_to_token (t, s, s2 - s)
856                    : new_token (term == '\"'? tQUOTED : tDOMAINLIT, s, s2 - s));
857               if (!t)
858                 goto failure;
859                    
860               if (*s2 || !hdr->next || !hdr->next->cont)
861                 break;
862               hdr = hdr->next;
863               s = hdr->line;
864             }
865           *tok_tail = t;
866           tok_tail = &t->next;
867           s = s2;
868           if (*s)
869             s++; /* skip the delimiter */
870         }
871       else if ((s2 = strchr (delimiters2, *s)))
872         { /* Special characters which are not handled above. */
873           invalid = 0;
874           t = new_token (tSPECIAL, s, 1);
875           if (!t)
876             goto failure;
877           *tok_tail = t;
878           tok_tail = &t->next;
879           s++;
880         }
881       else if (*s == ' ' || *s == '\t' || *s == '\r' || *s == '\n')
882         {
883           invalid = 0;
884           s = skip_ws (s + 1);
885         }
886       else if (*s > 0x20 && !(*s & 128))
887         { /* Atom. */
888           invalid = 0;
889           for (s2 = s + 1; *s2 > 0x20
890                && !(*s2 & 128) && !strchr (delimiters, *s2); s2++)
891             ;
892           t = new_token (tATOM, s, s2 - s);
893           if (!t)
894             goto failure;
895           *tok_tail = t;
896           tok_tail = &t->next;
897           s = s2;
898         }
899       else
900         { /* Invalid character. */
901           if (!invalid)
902             { /* For parsing we assume only one space. */
903               t = new_token (tSPACE, NULL, 0);
904               if (!t)
905                 goto failure;
906               *tok_tail = t;
907               tok_tail = &t->next;
908               invalid = 1;
909             }
910           s++;
911         }
912     }
913
914   return tok;
915
916  failure:
917   {
918     int save = errno;
919     release_token_list (tok);
920     errno = save;
921   }
922   return NULL;
923 }
924
925
926
927
928 /****************
929  * Find and parse a header field.
930  * WHICH indicates what to do if there are multiple instance of the same
931  * field (like "Received"); the following value are defined:
932  *  -1 := Take the last occurence
933  *   0 := Reserved
934  *   n := Take the n-th one.
935  * Returns a handle for further operations on the parse context of the field
936  * or NULL if the field was not found.
937  */
938 rfc822parse_field_t
939 rfc822parse_parse_field (rfc822parse_t msg, const char *name, int which)
940 {
941   HDR_LINE hdr;
942
943   if (!which)
944     return NULL;
945
946   hdr = find_header (msg, name, which, NULL);
947   if (!hdr)
948     return NULL;
949   return parse_field (hdr);
950 }
951
952 void
953 rfc822parse_release_field (rfc822parse_field_t ctx)
954 {
955   if (ctx)
956     release_token_list (ctx);
957 }
958
959
960
961 /****************
962  * Check whether T points to a parameter.
963  * A parameter starts with a semicolon and it is assumed that t
964  * points to exactly this one.
965  */
966 static int
967 is_parameter (TOKEN t)
968 {
969   t = t->next;
970   if (!t || t->type != tATOM)
971     return 0;
972   t = t->next;
973   if (!t || !(t->type == tSPECIAL && t->data[0] == '='))
974     return 0;
975   t = t->next;
976   if (!t)
977     return 1; /* We assume that an non existing value is an empty one. */
978   return t->type == tQUOTED || t->type == tATOM;
979 }
980
981 /*
982    Some header (Content-type) have a special syntax where attribute=value
983    pairs are used after a leading semicolon.  The parse_field code
984    knows about these fields and changes the parsing to the one defined
985    in RFC2045.
986    Returns a pointer to the value which is valid as long as the
987    parse context is valid; NULL is returned in case that attr is not
988    defined in the header, a missing value is reppresented by an empty string.
989  
990    With LOWER_VALUE set to true, a matching field valuebe be
991    lowercased.
992  
993    Note, that ATTR should be lowercase.
994  */
995 const char *
996 rfc822parse_query_parameter (rfc822parse_field_t ctx, const char *attr,
997                              int lower_value)
998 {
999   TOKEN t, a;
1000
1001   for (t = ctx; t; t = t->next)
1002     {
1003       /* skip to the next semicolon */
1004       for (; t && !(t->type == tSPECIAL && t->data[0] == ';'); t = t->next)
1005         ;
1006       if (!t)
1007         return NULL;
1008       if (is_parameter (t))
1009         { /* Look closer. */
1010           a = t->next; /* We know that this is an atom */
1011           if ( !a->flags.lowered )
1012             {
1013               lowercase_string (a->data);
1014               a->flags.lowered = 1;
1015             }
1016           if (!strcmp (a->data, attr))
1017             { /* found */
1018               t = a->next->next;
1019               /* Either T is now an atom, a quoted string or NULL in
1020                * which case we return an empty string. */
1021
1022               if ( lower_value && t && !t->flags.lowered )
1023                 {
1024                   lowercase_string (t->data);
1025                   t->flags.lowered = 1;
1026                 }
1027               return t ? t->data : "";
1028             }
1029         }
1030     }
1031   return NULL;
1032 }
1033
1034 /****************
1035  * This function may be used for the Content-Type header to figure out
1036  * the media type and subtype.  Note, that the returned strings are
1037  * guaranteed to be lowercase as required by MIME.
1038  *
1039  * Returns: a pointer to the media type and if subtype is not NULL,
1040  *          a pointer to the subtype.
1041  */
1042 const char *
1043 rfc822parse_query_media_type (rfc822parse_field_t ctx, const char **subtype)
1044 {
1045   TOKEN t = ctx;
1046   const char *type;
1047
1048   if (t->type != tATOM)
1049     return NULL;
1050   if (!t->flags.lowered)
1051     {
1052       lowercase_string (t->data);
1053       t->flags.lowered = 1;
1054     }
1055   type = t->data;
1056   t = t->next;
1057   if (!t || t->type != tSPECIAL || t->data[0] != '/')
1058     return NULL;
1059   t = t->next;
1060   if (!t || t->type != tATOM)
1061     return NULL;
1062
1063   if (subtype)
1064     {
1065       if (!t->flags.lowered)
1066         {
1067           lowercase_string (t->data);
1068           t->flags.lowered = 1;
1069         }
1070       *subtype = t->data;
1071     }
1072   return type;
1073 }
1074
1075
1076
1077
1078
1079 #ifdef TESTING
1080
1081 /* Internal debug function to print the structure of the message. */
1082 static void
1083 dump_structure (rfc822parse_t msg, part_t part, int indent)
1084 {
1085   if (!part)
1086     {
1087       printf ("*** Structure of this message:\n");
1088       part = msg->parts;
1089     }
1090
1091   for (; part; part = part->right)
1092     {
1093       rfc822parse_field_t ctx;
1094       part_t save_part; /* ugly hack - we should have a function to
1095                            get part inforation. */
1096       const char *s;
1097       
1098       save_part = msg->current_part;
1099       msg->current_part = part;
1100       ctx = rfc822parse_parse_field (msg, "Content-Type", -1);
1101       msg->current_part = save_part;
1102       if (ctx)
1103         {
1104           const char *s1, *s2;
1105           s1 = rfc822parse_query_media_type (ctx, &s2);
1106           if (s1)
1107             printf ("***   %*s %s/%s", indent*2, "", s1, s2);
1108           else
1109             printf ("***   %*s [not found]", indent*2, "");
1110
1111           s = rfc822parse_query_parameter (ctx, "boundary", 0);
1112           if (s)
1113             printf (" (boundary=\"%s\")", s);
1114           rfc822parse_release_field (ctx);
1115         }
1116       else
1117         printf ("***   %*s text/plain [assumed]", indent*2, "");
1118       putchar('\n');
1119
1120       if (part->down)
1121         dump_structure (msg, part->down, indent + 1);
1122     }
1123   
1124 }
1125
1126
1127
1128 static void
1129 show_param (rfc822parse_field_t ctx, const char *name)
1130 {
1131   const char *s;
1132
1133   if (!ctx)
1134     return;
1135   s = rfc822parse_query_parameter (ctx, name, 0);
1136   if (s)
1137     printf ("***   %s: `%s'\n", name, s);
1138 }
1139
1140
1141
1142 static void
1143 show_event (rfc822parse_event_t event)
1144 {
1145   const char *s;
1146
1147   switch (event)
1148     {
1149     case RFC822PARSE_OPEN: s= "Open"; break;
1150     case RFC822PARSE_CLOSE: s= "Close"; break;
1151     case RFC822PARSE_CANCEL: s= "Cancel"; break;
1152     case RFC822PARSE_T2BODY: s= "T2Body"; break;
1153     case RFC822PARSE_FINISH: s= "Finish"; break;
1154     case RFC822PARSE_RCVD_SEEN: s= "Rcvd_Seen"; break;
1155     case RFC822PARSE_BOUNDARY: s= "Boundary"; break;
1156     case RFC822PARSE_LAST_BOUNDARY: s= "Last_Boundary"; break;
1157     default: s= "***invalid event***"; break;
1158     }
1159   printf ("*** got RFC822 event %s\n", s);
1160 }
1161
1162 static int
1163 msg_cb (void *dummy_arg, rfc822parse_event_t event, rfc822parse_t msg)
1164 {
1165   show_event (event);
1166   if (event == RFC822PARSE_T2BODY)
1167     {
1168       rfc822parse_field_t ctx;
1169       void *ectx;
1170       const char *line;
1171
1172       for (ectx=NULL; (line = rfc822parse_enum_header_lines (msg, &ectx)); )
1173         {
1174           printf ("*** HDR: %s\n", line);
1175         }
1176       rfc822parse_enum_header_lines (NULL, &ectx); /* Close enumerator. */
1177
1178       ctx = rfc822parse_parse_field (msg, "Content-Type", -1);
1179       if (ctx)
1180         {
1181           const char *s1, *s2;
1182           s1 = rfc822parse_query_media_type (ctx, &s2);
1183           if (s1)
1184             printf ("***   media: `%s/%s'\n", s1, s2);
1185           else
1186             printf ("***   media: [not found]\n");
1187           show_param (ctx, "boundary");
1188           show_param (ctx, "protocol");
1189           rfc822parse_release_field (ctx);
1190         }
1191       else
1192         printf ("***   media: text/plain [assumed]\n");
1193       
1194     }
1195
1196
1197   return 0;
1198 }
1199
1200
1201
1202 int
1203 main (int argc, char **argv)
1204 {
1205   char line[5000];
1206   size_t length;
1207   rfc822parse_t msg;
1208
1209   msg = rfc822parse_open (msg_cb, NULL);
1210   if (!msg)
1211     abort ();
1212
1213   while (fgets (line, sizeof (line), stdin))
1214     {
1215       length = strlen (line);
1216       if (length && line[length - 1] == '\n')
1217         line[--length] = 0;
1218       if (length && line[length - 1] == '\r')
1219         line[--length] = 0;
1220       if (rfc822parse_insert (msg, line, length))
1221         abort ();
1222     }
1223
1224   dump_structure (msg, NULL, 0);
1225
1226   rfc822parse_close (msg);
1227   return 0;
1228 }
1229 #endif
1230
1231 /*
1232 Local Variables:
1233 compile-command: "gcc -Wall -g -DTESTING -o rfc822parse rfc822parse.c"
1234 End:
1235 */