header.c
18.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
/* GNU mailutils - a suite of utilities for electronic mail
Copyright (C) 1999, 2000, 2001 Free Software Foundation, Inc.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Library Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#include <errno.h>
#include <mailutils/stream.h>
#include <header0.h>
#define HEADER_MODIFIED 1
static int header_parse __P ((header_t, const char *, int));
static int header_read __P ((stream_t, char *, size_t, off_t, size_t *));
static int header_readline __P ((stream_t, char *, size_t, off_t, size_t *));
static int header_write __P ((stream_t, const char *, size_t, off_t,
size_t *));
static int fill_blurb __P ((header_t));
int
header_create (header_t *ph, const char *blurb, size_t len, void *owner)
{
header_t h;
int status = 0;
h = calloc (1, sizeof (*h));
if (h == NULL)
return ENOMEM;
h->owner = owner;
/* Ignore the return value. */
status = header_parse (h, blurb, len);
*ph = h;
return status;
}
void
header_destroy (header_t *ph, void *owner)
{
if (ph && *ph)
{
header_t h = *ph;
/* Can we destroy ?. */
if (h->owner == owner)
{
size_t i;
stream_destroy (&(h->stream), h);
if (h->hdr)
free (h->hdr);
if (h->blurb)
free (h->blurb);
for (i = 0; i < h->fhdr_count; i++)
{
if (h->fhdr[i].fn)
free (h->fhdr[i].fn);
if (h->fhdr[i].fv)
free (h->fhdr[i].fv);
}
if (h->fhdr)
free (h->fhdr);
free (h);
}
*ph = NULL;
}
}
void *
header_get_owner (header_t header)
{
return (header) ? header->owner : NULL;
}
int
header_is_modified (header_t header)
{
return (header) ? (header->flags & HEADER_MODIFIED) : 0;
}
/* Parsing is done in a rather simple fashion, meaning we just consider an
entry to be a field-name an a field-value. So they maybe duplicate of
field-name like "Received" they are just put in the array, see _get_value()
on how to handle the case. in the case of error .i.e a bad header construct
we do a full stop and return what we have so far. */
static int
header_parse (header_t header, const char *blurb, int len)
{
char *header_end;
char *header_start;
char *header_start2;
struct _hdr *hdr;
/* Nothing to parse. */
if (blurb == NULL || len == 0)
return 0;
header->blurb_len = len;
header->blurb = calloc (header->blurb_len + 1, sizeof(char));
if (header->blurb == NULL)
return ENOMEM;
memcpy (header->blurb, blurb, header->blurb_len);
if (header->hdr)
free (header->hdr);
header->hdr = NULL;
header->hdr_count = 0;
/* Get a header, a header is :
field-name ':' ' ' field-value '\r' '\n'
[ (' ' | '\t') field-value '\r' '\n' ]
*/
/* First loop goes throught the blurb */
for (header_start = header->blurb;; header_start = ++header_end)
{
char *fn, *fn_end, *fv, *fv_end;
if (header_start[0] == ' ' ||
header_start[0] == '\t' ||
header_start[0]== '\n')
break;
/* Second loop extract one header field. */
for (header_start2 = header_start;;header_start2 = ++header_end)
{
header_end = memchr (header_start2, '\n', len);
if (header_end == NULL)
break;
else
{
len -= (header_end - header_start2 + 1);
if (len < 0)
{
header_end = NULL;
break;
}
if (header_end[1] != ' '
&& header_end[1] != '\t')
break; /* New header break the inner for. */
}
/* *header_end = ' '; smash LF ? NO */
}
if (header_end == NULL)
break; /* Bail out. */
/* Now save the header in the data structure. */
/* Treats unix "From " specially. */
if ((header_end - header_start >= 5)
&& strncmp (header_start, "From ", 5) == 0)
{
fn = header_start;
fn_end = header_start + 5;
fv = header_start + 5;
fv_end = header_end;
}
else /* Break the header in key: value */
{
char *colon = memchr (header_start, ':', header_end - header_start);
/* Houston we have a problem. */
if (colon == NULL)
break; /* Disregard the rest and bailout. */
fn = header_start;
fn_end = colon;
/* Skip leading spaces. */
while (*(++colon) == ' ');
fv = colon;
fv_end = header_end;
}
/* Allocate a new slot for the field:value. */
hdr = realloc (header->hdr, (header->hdr_count + 1) * sizeof (*hdr));
if (hdr == NULL)
{
free (header->blurb);
free (header->hdr);
return ENOMEM;
}
hdr[header->hdr_count].fn = fn;
hdr[header->hdr_count].fn_end = fn_end;
hdr[header->hdr_count].fv = fv;
hdr[header->hdr_count].fv_end = fv_end;
header->hdr = hdr;
header->hdr_count++;
} /* for (header_start ...) */
return 0;
}
/* FIXME: grossly inneficient, to many copies and reallocating.
This all header business need a good rewrite. */
int
header_set_value (header_t header, const char *fn, const char *fv, int replace)
{
char *blurb;
size_t len;
if (header == NULL || fn == NULL || fv == NULL)
return EINVAL;
/* Overload. */
if (header->_set_value)
return header->_set_value (header, fn, fv, replace);
/* Try to fill out the buffer, if we know how. */
if (header->blurb == NULL)
{
int err = fill_blurb (header);
if (err != 0)
return err;
}
/* Easy approach: if replace, overwrite the field-{name,value} and readjust
the pointers by calling header_parse () this is wastefull, we're just
fragmenting the memory it can be done better. But that may imply a
rewite of the headers So for another day. */
if (replace)
{
size_t name_len;
size_t i;
size_t fn_len;
size_t fv_len;
len = header->blurb_len;
for (name_len = strlen (fn), i = 0; i < header->hdr_count; i++)
{
fn_len = header->hdr[i].fn_end - header->hdr[i].fn;
fv_len = header->hdr[i].fv_end - header->hdr[i].fv;
if (fn_len == name_len &&
strncasecmp (header->hdr[i].fn, fn, fn_len) == 0)
{
blurb = header->blurb;
if ((i + 1) < header->hdr_count)
{
memmove (header->hdr[i].fn, header->hdr[i + 1].fn,
header->hdr[header->hdr_count - 1].fv_end
- header->hdr[i + 1].fn + 3);
}
else
{
header->hdr[i].fn[0] = '\n';
header->hdr[i].fn[1] = '\0';
}
/* readjust the pointers if move */
len -= fn_len + fv_len + 3; /* :<sp>\n */
i--;
blurb = header->blurb;
header_parse (header, blurb, len);
free (blurb);
}
}
}
/* Replacing was taking care of above now just add to the end the new
header. Really not cute.
COLON SPACE NL = 3 ; */
len = strlen (fn) + strlen (fv) + 3;
/* Add one for the NULL and leak a bit by adding one more
it will be the separtor \n from the body if the first
blurb did not have it. */
blurb = calloc (header->blurb_len + len + 2, 1);
if (blurb == NULL)
return ENOMEM;
sprintf (blurb, "%s: %s", fn, fv);
/* Strip off trailing newlines. */
while (blurb[strlen (blurb) - 1] == '\n')
{
blurb[strlen (blurb) - 1] = '\0';
}
len = strlen (blurb);
blurb[len] = '\n';
len++;
/* Prepend the rest of the headers. */
if (header->blurb)
{
memcpy (blurb + len, header->blurb, header->blurb_len);
free (header->blurb);
}
else
blurb [len] = '\n';
/* before parsing the new blurb make sure it is properly terminated
by \n\n. The trailing NL separator. */
if (blurb[header->blurb_len + len - 1] != '\n'
|| blurb[header->blurb_len + len - 2] != '\n')
{
blurb[header->blurb_len + len] = '\n';
len++;
}
header_parse (header, blurb, len + header->blurb_len);
free (blurb);
header->flags |= HEADER_MODIFIED;
return 0;
}
static int
header_set_fvalue (header_t header, const char *name, char *buffer)
{
struct _hdr *thdr;
thdr = realloc (header->fhdr, (header->fhdr_count + 1) * sizeof(*thdr));
if (thdr)
{
size_t len = strlen (name);
char *field = malloc (len + 1);
if (field == NULL)
return ENOMEM;
memcpy (field, name, len);
field[len] = '\0';
thdr[header->fhdr_count].fn = field;
thdr[header->fhdr_count].fn_end = field + len;
len = strlen (buffer);
field = malloc (len + 1);
if (field == NULL)
return ENOMEM;
memcpy (field, buffer, len);
field[len] = '\0';
thdr[header->fhdr_count].fv = field;
thdr[header->fhdr_count].fv_end = field + len;
header->fhdr_count++;
header->fhdr = thdr;
return 0;
}
return ENOMEM;
}
static int
header_get_fvalue (header_t header, const char *name, char *buffer,
size_t buflen, size_t *pn)
{
size_t i, fn_len, fv_len = 0;
size_t name_len;
int err = ENOENT;
if (header->_get_fvalue)
return header->_get_fvalue (header, name, buffer, buflen, pn);
for (i = 0, name_len = strlen (name); i < header->fhdr_count; i++)
{
fn_len = header->fhdr[i].fn_end - header->fhdr[i].fn;
if (fn_len == name_len
&& strcasecmp (header->fhdr[i].fn, name) == 0)
{
fv_len = header->fhdr[i].fv_end - header->fhdr[i].fv;
if (buffer && buflen > 0)
{
buflen--;
fv_len = (fv_len < buflen) ? fv_len : buflen;
memcpy (buffer, header->fhdr[i].fv, fv_len);
buffer[fv_len] = '\0';
}
err = 0;
break;
}
}
if (pn)
*pn = fv_len;
return err;
}
int
header_get_value (header_t header, const char *name, char *buffer,
size_t buflen, size_t *pn)
{
size_t i = 0;
size_t name_len;
size_t total = 0, fn_len = 0, fv_len = 0;
int threshold;
int err = 0;
if (header == NULL || name == NULL)
return EINVAL;
/* First Try the Fast header for hits. */
err = header_get_fvalue (header, name, buffer, buflen, pn);
if (err == 0)
return 0;
if (header->_get_value)
{
char buf[1024]; /* should suffice for field-value. */
size_t len = 0;
err = header->_get_value (header, name, buf, sizeof (buf), &len);
if (err == 0)
{
/* Save in the fast header buffer. */
header_set_fvalue (header, name, buf);
if (buffer && buflen > 0)
{
buflen--;
buflen = (len < buflen) ? len : buflen;
memcpy (buffer, buf, buflen);
buffer[buflen] = '\0';
if (pn)
*pn = buflen;
}
}
return err;
}
/* Try to fill out the buffer, if we know how. */
if (header->blurb == NULL)
{
err = fill_blurb (header);
if (err != 0)
return err;
}
/* We set the threshold to be 1 less for the null. */
threshold = --buflen;
/* Caution: We may have more then one value for a field name, for example
a "Received" field-name is added by each passing MTA. The way that the
parsing (_parse()) is done it's not take to account. So we just stuff
in the buffer all the field-values to a corresponding field-name.
FIXME: Should we kosher the output ? meaning replace occurences of
" \t\r\n" for spaces ? for now we don't. */
for (name_len = strlen (name), i = 0; i < header->hdr_count; i++)
{
fn_len = header->hdr[i].fn_end - header->hdr[i].fn;
if (fn_len == name_len &&
strncasecmp (header->hdr[i].fn, name, fn_len) == 0)
{
fv_len = (header->hdr[i].fv_end - header->hdr[i].fv);
total += fv_len;
/* Can everything fit in the buffer. */
if (buffer && threshold > 0)
{
threshold -= fv_len;
if (threshold >= 0)
{
memcpy (buffer, header->hdr[i].fv, fv_len);
buffer += fv_len;
}
else if (threshold < 0)
{
threshold += fv_len;
memcpy (buffer, header->hdr[i].fv, threshold);
buffer += threshold;
threshold = 0;
}
}
}
}
if (buffer)
*buffer = '\0'; /* Null terminated. */
if (pn)
*pn = total;
return (total == 0) ? ENOENT : 0;
}
int
header_set_lines (header_t header, int (*_lines)
(header_t, size_t *), void *owner)
{
if (header == NULL)
return EINVAL;
if (header->owner != owner)
return EACCES;
header->_lines = _lines;
return 0;
}
int
header_lines (header_t header, size_t *plines)
{
int n;
size_t lines = 0;
if (header == NULL || plines == NULL)
return EINVAL;
/* Overload. */
if (header->_lines)
return header->_lines (header, plines);
/* Try to fill out the buffer, if we know how. */
if (header->blurb == NULL)
{
int err = fill_blurb (header);
if (err != 0)
return err;
}
for (n = header->blurb_len - 1; n >= 0; n--)
{
if (header->blurb[n] == '\n')
lines++;
}
if (plines)
*plines = lines;
return 0;
}
int
header_set_size (header_t header, int (*_size)
(header_t, size_t *), void *owner)
{
if (header == NULL)
return EINVAL;
if (header->owner != owner)
return EACCES;
header->_size = _size;
return 0;
}
int
header_size (header_t header, size_t *psize)
{
if (header == NULL)
return EINVAL;
/* Overload. */
if (header->_size)
return header->_size (header, psize);
/* Try to fill out the buffer, if we know how. */
if (header->blurb == NULL)
{
int err = fill_blurb (header);
if (err != 0)
return err;
}
if (psize)
*psize = header->blurb_len;
return 0;
}
int
header_set_get_fvalue (header_t header, int (*_get_fvalue)
__P ((header_t, const char *, char *, size_t, size_t *)),
void *owner)
{
if (header == NULL)
return EINVAL;
if (header->owner != owner)
return EACCES;
header->_get_fvalue = _get_fvalue;
return 0;
}
int
header_set_get_value (header_t header, int (*_get_value)
__P ((header_t, const char *, char *, size_t, size_t *)),
void *owner)
{
if (header == NULL)
return EINVAL;
if (header->owner != owner)
return EACCES;
header->_get_value = _get_value;
return 0;
}
int
header_set_set_value (header_t header, int (*_set_value)
(header_t , const char *, const char *, int),
void *owner)
{
if (header == NULL)
return EINVAL;
if (header->owner != owner)
return EACCES;
header->_set_value = _set_value;
return 0;
}
int
header_set_stream (header_t header, stream_t stream, void *owner)
{
if (header == NULL)
return EINVAL;
if (header->owner != owner)
return EACCES;
header->stream = stream;
return 0;
}
int
header_set_fill (header_t header, int
(*_fill) __P ((header_t, char *, size_t, off_t, size_t *)),
void *owner)
{
if (header == NULL)
return EINVAL;
if (header->owner != owner)
return EACCES;
header->_fill = _fill;
return 0;
}
static int
fill_blurb (header_t header)
{
int status;
char buf[1024];
char *tbuf;
size_t nread = 0;
size_t i;
if (header->_fill == NULL)
return 0;
/* Free any fast header, since we will load the entire headers. */
for (i = 0; i < header->fhdr_count; i++)
{
if (header->fhdr[i].fn)
free (header->fhdr[i].fn);
if (header->fhdr[i].fv)
free (header->fhdr[i].fv);
}
if (header->fhdr)
free (header->fhdr);
header->_get_fvalue = NULL;
do
{
status = header->_fill (header, buf, sizeof (buf),
header->temp_blurb_len, &nread) ;
if (status != 0)
{
if (status != EAGAIN && status != EINTR)
{
free (header->temp_blurb);
header->temp_blurb = NULL;
header->temp_blurb_len = 0;
}
return status;
}
if (nread > 0)
{
tbuf = realloc (header->temp_blurb, header->temp_blurb_len + nread);
if (tbuf == NULL)
{
free (header->temp_blurb);
header->temp_blurb = NULL;
header->temp_blurb_len = 0;
return ENOMEM;
}
header->temp_blurb = tbuf;
memcpy (header->temp_blurb + header->temp_blurb_len, buf, nread);
header->temp_blurb_len += nread;
}
}
while (nread > 0);
/* parse it. */
status = header_parse (header, header->temp_blurb, header->temp_blurb_len);
if (header->temp_blurb)
{
free (header->temp_blurb);
header->temp_blurb = NULL;
}
header->temp_blurb_len = 0;
return status;
}
static int
header_write (stream_t os, const char *buf, size_t buflen,
off_t off, size_t *pnwrite)
{
header_t header = stream_get_owner (os);
if (os == NULL || header == NULL)
return EINVAL;
(void)buf; (void)off;
if (buflen == 0)
return 0;
if (pnwrite)
*pnwrite = 0;
return ENOSYS;
}
static int
header_read (stream_t is, char *buf, size_t buflen, off_t off, size_t *pnread)
{
header_t header = stream_get_owner (is);
int len;
if (is == NULL || header == NULL)
return EINVAL;
/* Try to fill out the buffer, if we know how. */
if (header->blurb == NULL)
{
int err = fill_blurb (header);
if (err != 0)
return err;
}
len = header->blurb_len - off;
if (len > 0)
{
if (buf)
{
len = (buflen < (size_t)len) ? buflen : len;
memcpy (buf, header->blurb + off, len);
}
}
else
len = 0;
if (pnread)
*pnread = len;
return 0;
}
static int
header_readline (stream_t is, char *buf, size_t buflen, off_t off, size_t *pn)
{
header_t header = stream_get_owner (is);
int len;
if (is == NULL || header == NULL)
return EINVAL;
if (buf == NULL || buflen == 0)
{
if (pn)
*pn = 0;
return 0;
}
/* Try to fill out the buffer, if we know how. */
if (header->blurb == NULL)
{
int err = fill_blurb (header);
if (err != 0)
return err;
}
buflen--; /* Space for the null. */
len = header->blurb_len - off;
if (len > 0)
{
char *nl = memchr (header->blurb + off, '\n', len);
if (nl)
len = nl - (header->blurb + off) + 1;
len = (buflen < (size_t)len) ? buflen : len;
memcpy (buf, header->blurb + off, len);
buf[len] = '\0';
}
else
len = 0;
if (pn)
*pn = len;
return 0;
}
int
header_get_stream (header_t header, stream_t *pstream)
{
if (header == NULL || pstream == NULL)
return EINVAL;
if (header->stream == NULL)
{
int status = stream_create (&(header->stream), MU_STREAM_RDWR, header);
if (status != 0)
return status;
stream_set_read (header->stream, header_read, header);
stream_set_readline (header->stream, header_readline, header);
stream_set_write (header->stream, header_write, header);
}
*pstream = header->stream;
return 0;
}