2 ** m_getfld.c -- read/parse a message
4 ** This code is Copyright (c) 2002, by the authors of nmh. See the
5 ** COPYRIGHT file in the root directory of the nmh distribution for
6 ** complete copyright information.
15 ** This module has a long and checkered history.
17 ** [ Here had been some history of delimiter problems in MMDF maildrops ... ]
19 ** Unfortunately the speed issue finally caught up with us since this
20 ** routine is at the very heart of MH. To speed things up considerably, the
21 ** routine Eom() was made an auxilary function called by the macro eom().
22 ** Unless we are bursting a maildrop, the eom() macro returns FALSE saying
23 ** we aren't at the end of the message.
25 ** [ ... and here had been some more of it. ]
28 ** ------------------------
29 ** (Written by Van Jacobson for the mh6 m_getfld, January, 1986):
31 ** This routine was accounting for 60% of the cpu time used by most mh
32 ** programs. I spent a bit of time tuning and it now accounts for <10%
33 ** of the time used. Like any heavily tuned routine, it's a bit
34 ** complex and you want to be sure you understand everything that it's
35 ** doing before you start hacking on it. Let me try to emphasize
36 ** that: every line in this atrocity depends on every other line,
37 ** sometimes in subtle ways. You should understand it all, in detail,
38 ** before trying to change any part. If you do change it, test the
39 ** result thoroughly (I use a hand-constructed test file that exercises
40 ** all the ways a header name, header body, header continuation,
41 ** header-body separator, body line and body eom can align themselves
42 ** with respect to a buffer boundary). "Minor" bugs in this routine
43 ** result in garbaged or lost mail.
45 ** If you hack on this and slow it down, I, my children and my
46 ** children's children will curse you.
48 ** This routine gets used on two different types of files: normal,
49 ** single msg files and "packed" unix mailboxs (when used by inc).
50 ** The biggest impact of different file types is in "eom" testing. The
51 ** code has been carefully organized to test for eom at appropriate
52 ** times and at no other times (since the check is quite expensive).
53 ** I have tried to arrange things so that the eom check need only be
54 ** done on entry to this routine. Since an eom can only occur after a
55 ** newline, this is easy to manage for header fields. For the msg
56 ** body, we try to efficiently search the input buffer to see if
57 ** contains the eom delimiter. If it does, we take up to the
58 ** delimiter, otherwise we take everything in the buffer. (The change
59 ** to the body eom/copy processing produced the most noticeable
60 ** performance difference, particularly for "inc" and "show".)
62 ** There are three qualitatively different things this routine busts
63 ** out of a message: field names, field text and msg bodies. Field
64 ** names are typically short (~8 char) and the loop that extracts them
65 ** might terminate on a colon, newline or max width. I considered
66 ** using a Vax "scanc" to locate the end of the field followed by a
67 ** "bcopy" but the routine call overhead on a Vax is too large for this
68 ** to work on short names. If Berkeley ever makes "inline" part of the
69 ** C optimiser (so things like "scanc" turn into inline instructions) a
70 ** change here would be worthwhile.
72 ** Field text is typically 60 - 100 characters so there's (barely)
73 ** a win in doing a routine call to something that does a "locc"
74 ** followed by a "bmove". About 30% of the fields have continuations
75 ** (usually the 822 "received:" lines) and each continuation generates
76 ** another routine call. "Inline" would be a big win here, as well.
78 ** Messages, as of this writing, seem to come in two flavors: small
79 ** (~1K) and long (>2K). Most messages have 400 - 600 bytes of headers
80 ** so message bodies average at least a few hundred characters.
81 ** Assuming your system uses reasonably sized stdio buffers (1K or
82 ** more), this routine should be able to remove the body in large
83 ** (>500 byte) chunks. The makes the cost of a call to "bcopy"
84 ** small but there is a premium on checking for the eom in packed
85 ** maildrops. The eom pattern is always a simple string so we can
86 ** construct an efficient pattern matcher for it (e.g., a Vax "matchc"
87 ** instruction). Some thought went into recognizing the start of
88 ** an eom that has been split across two buffers.
90 ** This routine wants to deal with large chunks of data so, rather
91 ** than "getc" into a local buffer, it uses stdio's buffer. If
92 ** you try to use it on a non-buffered file, you'll get what you
93 ** deserve. This routine "knows" that struct FILEs have a _ptr
94 ** and a _cnt to describe the current state of the buffer and
95 ** it knows that _filbuf ignores the _ptr & _cnt and simply fills
96 ** the buffer. If stdio on your system doesn't work this way, you
97 ** may have to make small changes in this routine.
99 ** This routine also "knows" that an EOF indication on a stream is
100 ** "sticky" (i.e., you will keep getting EOF until you reposition the
101 ** stream). If your system doesn't work this way it is broken and you
102 ** should complain to the vendor. As a consequence of the sticky
103 ** EOF, this routine will never return any kind of EOF status when
104 ** there is data in "name" or "buf").
111 static int m_Eom(int, FILE *);
112 static unsigned char *matchc(int, char *, int, char *);
113 static unsigned char *locc(int, unsigned char *, unsigned char);
115 #define eom(c,iob) (ismbox && \
116 (((c) == *msg_delim && m_Eom(c,iob)) ||\
117 (eom_action && (*eom_action)(c))))
119 static unsigned char **pat_map;
122 ** This is a disgusting hack for "inc" so it can know how many
123 ** characters were stuffed in the buffer on the last call
124 ** (see comments in uip/scansbr.c).
131 ** The "full" delimiter string for a packed maildrop consists
132 ** of a newline followed by the actual delimiter. E.g., the
133 ** full string for a Unix maildrop would be: "\n\nFrom ".
134 ** "Fdelim" points to the start of the full string and is used
135 ** in the BODY case of the main routine to search the buffer for
136 ** a possible eom. Msg_delim points to the first character of
137 ** the actual delim. string (i.e., fdelim+1). Edelim
138 ** points to the 2nd character of actual delimiter string. It
139 ** is used in m_Eom because the first character of the string
140 ** has been read and matched before m_Eom is called.
142 static char *msg_delim = "";
144 static unsigned char *fdelim;
145 static unsigned char *delimend;
146 static int fdelimlen;
147 static unsigned char *edelim;
148 static int edelimlen;
150 static int (*eom_action)(int) = NULL;
153 # define _ptr _p /* Gag */
154 # define _cnt _r /* Retch */
155 # define _filbuf __srget /* Puke */
156 # define DEFINED__FILBUF_TO_SOMETHING_SPECIFIC
159 #ifndef DEFINED__FILBUF_TO_SOMETHING_SPECIFIC
160 extern int _filbuf(FILE*);
165 m_getfld(int state, unsigned char *name, unsigned char *buf,
166 int bufsz, FILE *iob)
168 unsigned char *bp, *cp, *ep, *sp;
171 if ((c = getc(iob)) < 0) {
178 /* flush null messages */
179 while ((c = getc(iob)) >= 0 && eom(c, iob))
191 if (c == '\n' || c == '-') {
192 /* we hit the header/body separator */
193 while (c != '\n' && (c = getc(iob)) >= 0)
196 if (c < 0 || (c = getc(iob)) < 0 || eom(c, iob)) {
198 /* flush null messages */
199 while ((c = getc(iob)) >= 0 && eom(c, iob))
212 ** get the name of this component. take characters up
213 ** to a ':', a newline or NAMESZ-1 characters,
214 ** whichever comes first.
220 bp = sp = (unsigned char *) iob->_IO_read_ptr - 1;
221 j = (cnt = ((long) iob->_IO_read_end -
222 (long) iob->_IO_read_ptr) + 1) < i ? cnt : i;
223 #elif defined(__DragonFly__)
224 bp = sp = (unsigned char *) ((struct __FILE_public *)iob)->_p - 1;
225 j = (cnt = ((struct __FILE_public *)iob)->_r+1) < i ? cnt : i;
227 bp = sp = (unsigned char *) iob->_ptr - 1;
228 j = (cnt = iob->_cnt+1) < i ? cnt : i;
230 while (--j >= 0 && (c = *bp++) != ':' && c != '\n')
234 if ((cnt -= j) <= 0) {
236 iob->_IO_read_ptr = iob->_IO_read_end;
237 if (__underflow(iob) == EOF) {
238 #elif defined(__DragonFly__)
239 if (__srget(iob) == EOF) {
241 if (_filbuf(iob) == EOF) {
244 advise(NULL, "eof encountered in field \"%s\"", name);
248 iob->_IO_read_ptr++; /* NOT automatic in __underflow()! */
252 iob->_IO_read_ptr = bp + 1;
253 #elif defined(__DragonFly__)
254 ((struct __FILE_public *)iob)->_p = bp + 1;
255 ((struct __FILE_public *)iob)->_r = cnt - 1;
265 ** something went wrong. possibilities are:
266 ** . hit a newline (error)
267 ** . got more than namesz chars. (error)
268 ** . hit the end of the buffer. (loop)
272 ** We hit the end of the line without
273 ** seeing ':' to terminate the field name.
274 ** This is usually (always?) spam. But,
275 ** blowing up is lame, especially when
276 ** scan(1)ing a folder with such messages.
277 ** Pretend such lines are the first of
278 ** the body (at least mutt also handles
283 ** See if buf can hold this line, since we
284 ** were assuming we had a buffer of NAMESZ,
287 /* + 1 for the newline */
290 ** No, it can't. Oh well,
291 ** guess we'll blow up.
294 advise(NULL, "eol encountered in field \"%s\"", name);
298 memcpy(buf, name, j - 1);
302 ** mhparse.c:get_content wants to find
303 ** the position of the body start, but
304 ** it thinks there's a blank line between
305 ** the header and the body (naturally!),
306 ** so seek back so that things line up
307 ** even though we don't have that blank
308 ** line in this case. Simpler parsers
309 ** (e.g. mhl) get extra newlines, but
310 ** that should be harmless enough, right?
311 ** This is a corrupt message anyway.
313 fseek(iob, ftell(iob) - 2, SEEK_SET);
318 advise(NULL, "field name \"%s\" exceeds %d bytes", name, NAMESZ - 2);
324 while (isspace(*--cp) && cp >= name)
331 ** get (more of) the text of a field. take
332 ** characters up to the end of this field (newline
333 ** followed by non-blank) or bufsz-1 characters.
335 cp = buf; i = bufsz-1;
338 cnt = (long) iob->_IO_read_end - (long) iob->_IO_read_ptr;
339 bp = (unsigned char *) --iob->_IO_read_ptr;
340 #elif defined(__DragonFly__)
341 cnt = ((struct __FILE_public *)iob)->_r++;
342 bp = (unsigned char *) --((struct __FILE_public *)iob)->_p;
345 bp = (unsigned char *) --iob->_ptr;
347 c = cnt < i ? cnt : i;
348 while ((ep = locc( c, bp, '\n' ))) {
350 ** if we hit the end of this field,
353 if ((j = *++ep) != ' ' && j != '\t') {
355 j = ep - (unsigned char *) iob->_IO_read_ptr;
356 memcpy(cp, iob->_IO_read_ptr, j);
357 iob->_IO_read_ptr = ep;
358 #elif defined(__DragonFly__)
359 j = ep - (unsigned char *) ((struct __FILE_public *)iob)->_p;
360 memcpy(cp, ((struct __FILE_public *)iob)->_p, j);
361 ((struct __FILE_public *)iob)->_p = ep;
362 ((struct __FILE_public *)iob)->_r -= j;
364 j = ep - (unsigned char *) iob->_ptr;
365 memcpy(cp, iob->_ptr, j);
377 ** end of input or dest buffer - copy what
381 c += bp - (unsigned char *) iob->_IO_read_ptr;
382 memcpy(cp, iob->_IO_read_ptr, c);
383 #elif defined(__DragonFly__)
384 c += bp - (unsigned char *) ((struct __FILE_public *)iob)->_p;
385 memcpy(cp, ((struct __FILE_public *)iob)->_p, c);
387 c += bp - (unsigned char *) iob->_ptr;
388 memcpy(cp, iob->_ptr, c);
393 /* the dest buffer is full */
395 iob->_IO_read_ptr += c;
396 #elif defined(__DragonFly__)
397 ((struct __FILE_public *)iob)->_r -= c;
398 ((struct __FILE_public *)iob)->_p += c;
407 ** There's one character left in the input
408 ** buffer. Copy it & fill the buffer.
409 ** If the last char was a newline and the
410 ** next char is not whitespace, this is
411 ** the end of the field. Otherwise loop.
415 *cp++ = j = *(iob->_IO_read_ptr + c);
416 iob->_IO_read_ptr = iob->_IO_read_end;
417 c = __underflow(iob);
418 iob->_IO_read_ptr++; /* NOT automatic! */
419 #elif defined(__DragonFly__)
420 *cp++ =j = *(((struct __FILE_public *)iob)->_p + c);
423 *cp++ = j = *(iob->_ptr + c);
426 if (c == EOF || ((j == '\0' || j == '\n')
427 && c != ' ' && c != '\t')) {
431 #elif defined(__DragonFly__)
432 --((struct __FILE_public *)iob)->_p;
433 ++((struct __FILE_public *)iob)->_r;
448 ** get the message body up to bufsz characters or
449 ** the end of the message. Sleazy hack: if bufsz
450 ** is negative we assume that we were called to
451 ** copy directly into the output buffer and we
454 i = (bufsz < 0) ? -bufsz : bufsz-1;
456 bp = (unsigned char *) --iob->_IO_read_ptr;
457 cnt = (long) iob->_IO_read_end - (long) iob->_IO_read_ptr;
458 #elif defined(__DragonFly__)
459 bp = (unsigned char *) --((struct __FILE_public *)iob)->_p;
460 cnt = ++((struct __FILE_public *)iob)->_r;
462 bp = (unsigned char *) --iob->_ptr;
465 c = (cnt < i ? cnt : i);
466 if (ismbox && c > 1) {
468 ** packed maildrop - only take up to the (possible)
469 ** start of the next message. This "matchc" should
470 ** probably be a Boyer-Moore matcher for non-vaxen,
471 ** particularly since we have the alignment table
472 ** all built for the end-of-buffer test (next).
473 ** But our vax timings indicate that the "matchc"
474 ** instruction is 50% faster than a carefully coded
475 ** B.M. matcher for most strings. (So much for
476 ** elegant algorithms vs. brute force.) Since I
477 ** (currently) run MH on a vax, we use the matchc
480 if ((ep = matchc( fdelimlen, fdelim, c, bp )))
484 ** There's no delim in the buffer but
485 ** there may be a partial one at the end.
486 ** If so, we want to leave it so the "eom"
487 ** check on the next call picks it up. Use a
488 ** modified Boyer-Moore matcher to make this
489 ** check relatively cheap. The first "if"
490 ** figures out what position in the pattern
491 ** matches the last character in the buffer.
492 ** The inner "while" matches the pattern
493 ** against the buffer, backwards starting
494 ** at that position. Note that unless the
495 ** buffer ends with one of the characters
496 ** in the pattern (excluding the first
497 ** and last), we do only one test.
500 if ((sp = pat_map[*ep])) {
503 ** This if() is true unless
504 ** (a) the buffer is too
505 ** small to contain this
507 ** or (b) it contains
508 ** exactly enough chars for
509 ** the delimiter prefix.
510 ** For case (a) obviously we
511 ** aren't going to match.
512 ** For case (b), if the
513 ** buffer really contained
514 ** exactly a delim prefix,
515 ** then the m_eom call
516 ** at entry should have
517 ** found it. Thus it's
518 ** not a delim and we know
519 ** we won't get a match.
521 if (((sp - fdelim) + 2) <= c) {
524 ** Unfortunately although fdelim has a preceding NUL
525 ** we can't use this as a sentinel in case the buffer
526 ** contains a NUL in exactly the wrong place (this
527 ** would cause us to run off the front of fdelim).
529 while (*--ep == *--cp)
533 /* we matched the entire delim prefix,
534 ** so only take the buffer up to there.
535 ** we know ep >= bp -- check above prevents underrun
541 /* try matching one less char of delim string */
543 } while (--sp > fdelim);
547 memcpy( buf, bp, c );
549 iob->_IO_read_ptr += c;
550 #elif defined(__DragonFly__)
551 ((struct __FILE_public *)iob)->_r -= c;
552 ((struct __FILE_public *)iob)->_p += c;
565 adios(EX_SOFTWARE, NULL, "m_getfld() called with bogus state of %d", state);
569 msg_count = cp - buf;
575 thisisanmbox(FILE *iob)
589 ** Figure out what the message delimitter string is for this
590 ** maildrop. (This used to be part of m_Eom but I didn't like
591 ** the idea of an "if" statement that could only succeed on the
592 ** first call to m_Eom getting executed on each call, i.e., at
593 ** every newline in the message).
595 ** If the first line of the maildrop is a Unix "From " line, we
596 ** say the style is MBOX and eat the rest of the line. Otherwise
600 if (fread(text, sizeof(*text), 5, iob) != 5) {
601 adios(EX_IOERR, NULL, "Read error");
603 if (strncmp(text, "From ", 5)!=0) {
604 adios(EX_USAGE, NULL, "No Unix style (mbox) maildrop.");
607 delimstr = "\nFrom ";
608 while ((c = getc(iob)) != '\n' && c >= 0) {
611 c = strlen(delimstr);
612 fdelim = (unsigned char *) mh_xmalloc((size_t) (c + 3));
615 msg_delim = (char *)fdelim+1;
616 edelim = (unsigned char *)msg_delim+1;
619 strcpy(msg_delim, delimstr);
620 delimend = (unsigned char *)msg_delim + edelimlen;
622 adios(EX_DATAERR, NULL, "maildrop delimiter must be at least 2 bytes");
624 ** build a Boyer-Moore end-position map for the matcher in m_getfld.
625 ** N.B. - we don't match just the first char (since it's the newline
626 ** separator) or the last char (since the matchc would have found it
627 ** if it was a real delim).
629 pat_map = (unsigned char **) mh_xcalloc(256, sizeof(unsigned char *));
631 for (cp = (char *) fdelim + 1; cp < (char *) delimend; cp++ )
632 pat_map[(unsigned char)*cp] = (unsigned char *) cp;
637 ** test for msg delimiter string
641 m_Eom(int c, FILE *iob)
648 if ((i = fread(text, sizeof *text, edelimlen, iob)) != edelimlen ||
649 (strncmp(text, (char *)edelim, edelimlen)!=0)) {
650 if (i == 0 && ismbox)
652 ** the final newline in the (brain damaged) unix-format
653 ** maildrop is part of the delimitter - delete it.
657 fseek(iob, (long)(pos-1), SEEK_SET);
658 getc(iob); /* should be OK */
663 while ((c = getc(iob)) != '\n' && c >= 0) {
672 static unsigned char *
673 matchc(int patln, char *pat, int strln, char *str)
675 char *es = str + strln - patln;
678 char *ep = pat + patln;
688 while (pp < ep && *sp++ == *pp)
691 return ((unsigned char *)--str);
697 ** Locate character "term" in the next "cnt" characters of "src".
698 ** If found, return its address, otherwise return 0.
701 static unsigned char *
702 locc(int cnt, unsigned char *src, unsigned char term)
704 while (*src++ != term && --cnt > 0)
707 return (cnt > 0 ? --src : (unsigned char *)0);