/* spool.c -- Routines for spooling/parsing messages from a prot stream
*
* Copyright (c) 1994-2008 Carnegie Mellon University. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The name "Carnegie Mellon University" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For permission or any legal
* details, please contact
* Carnegie Mellon University
* Center for Technology Transfer and Enterprise Creation
* 4615 Forbes Avenue
* Suite 302
* Pittsburgh, PA 15213
* (412) 268-7393, fax: (412) 268-7395
* innovation@andrew.cmu.edu
*
* 4. Redistributions of any form whatsoever must retain the following
* acknowledgment:
* "This product includes software developed by Computing Services
* at Carnegie Mellon University (http://www.cmu.edu/computing/)."
*
* CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
* THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
* FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
* AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
* OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*
* $Id: spool.c,v 1.16 2010/01/06 17:01:40 murch Exp $
*/
#include <config.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#include <stdio.h>
#include <string.h>
#include <ctype.h>
#include "assert.h"
#include "spool.h"
#include "prot.h"
#include "util.h"
#include "xmalloc.h"
#include "exitcodes.h"
#include "imap_err.h"
#include "nntp_err.h"
#include "global.h"
#define HEADERCACHESIZE 4009
typedef struct Header header_t;
/* data per message */
struct Header {
char *name;
int ncontents;
char *contents[1];
};
hdrcache_t spool_new_hdrcache()
{
int i;
hdrcache_t cache;
cache = (hdrcache_t) xmalloc(HEADERCACHESIZE * sizeof(header_t*));
if (!cache) return NULL;
for (i = 0; i < HEADERCACHESIZE; i++)
cache[i] = NULL;
return cache;
}
/* hash function used for header cache in struct msg */
static int hashheader(char *header)
{
int x = 0;
/* any CHAR except ' ', :, or a ctrl char */
for (; !Uiscntrl(*header) && (*header != ' ') && (*header != ':');
header++) {
x *= 256;
x += *header;
x %= HEADERCACHESIZE;
}
return x;
}
/* take a list of headers, pull the first one out and return it in
name and contents.
copies fin to fout, massaging
returns 0 on success, negative on failure */
typedef enum {
NAME_START,
NAME,
COLON,
BODY_START,
BODY
} state;
enum {
NAMEINC = 128,
BODYINC = 1024
};
/* we don't have to worry about dotstuffing here, since it's illegal
for a header to begin with a dot!
returns 0 on success, filling in 'headname' and 'contents' with a static
pointer (blech).
on end of headers, returns 0 with NULL 'headname' and NULL 'contents'
on error, returns < 0
*/
static int parseheader(struct protstream *fin, FILE *fout,
char **headname, char **contents,
const char **skipheaders)
{
int c;
static char *name = NULL, *body = NULL;
static int namelen = 0, bodylen = 0;
int off = 0;
state s = NAME_START;
int r = 0;
int reject8bit = config_getswitch(IMAPOPT_REJECT8BIT);
int munge8bit = config_getswitch(IMAPOPT_MUNGE8BIT);
const char **skip = NULL;
if (namelen == 0) {
namelen += NAMEINC;
name = (char *) xrealloc(name, namelen * sizeof(char));
}
if (bodylen == 0) {
bodylen += BODYINC;
body = (char *) xrealloc(body, bodylen * sizeof(char));
}
/* there are two ways out of this loop, both via gotos:
either we successfully read a header (got_header)
or we hit an error (ph_error) */
while ((c = prot_getc(fin)) != EOF) { /* examine each character */
/* reject \0 */
if (!c) {
r = IMAP_MESSAGE_CONTAINSNULL;
goto ph_error;
}
switch (s) {
case NAME_START:
if (c == '.') {
int peek;
peek = prot_getc(fin);
prot_ungetc(peek, fin);
if (peek == '\r' || peek == '\n') {
/* just reached the end of message */
r = 0;
goto ph_error;
}
}
if (c == '\r' || c == '\n') {
/* just reached the end of headers */
r = 0;
goto ph_error;
}
/* field-name = 1*ftext
ftext = %d33-57 / %d59-126
; Any character except
; controls, SP, and
; ":". */
if (!((c >= 33 && c <= 57) || (c >= 59 && c <= 126))) {
/* invalid header name */
r = IMAP_MESSAGE_BADHEADER;
goto ph_error;
}
name[0] = c;
off = 1;
s = NAME;
break;
case NAME:
if (c == ' ' || c == '\t' || c == ':') {
name[off] = '\0';
/* see if this header is in our skip list */
for (skip = skipheaders;
skip && *skip && strcasecmp(name, *skip); skip++);
if (!skip || !*skip) {
/* write the header name to the output */
if (fout) fputs(name, fout);
skip = NULL;
}
s = (c == ':' ? BODY_START : COLON);
break;
}
if (!((c >= 33 && c <= 57) || (c >= 59 && c <= 126))) {
r = IMAP_MESSAGE_BADHEADER;
goto ph_error;
}
name[off++] = c;
if (off >= namelen - 3) {
namelen += NAMEINC;
name = (char *) xrealloc(name, namelen);
}
break;
case COLON:
if (c == ':') {
s = BODY_START;
} else if (c != ' ' && c != '\t') {
/* i want to avoid confusing dot-stuffing later */
while (c == '.') {
if (fout && !skip) fputc(c, fout);
c = prot_getc(fin);
}
r = IMAP_MESSAGE_BADHEADER;
goto ph_error;
}
break;
case BODY_START:
if (c == ' ' || c == '\t') /* eat the whitespace */
break;
off = 0;
s = BODY;
/* falls through! */
case BODY:
/* now we want to convert all newlines into \r\n */
if (c == '\r' || c == '\n') {
int peek;
peek = prot_getc(fin);
if (fout && !skip) {
fputc('\r', fout);
fputc('\n', fout);
}
/* we should peek ahead to see if it's folded whitespace */
if (c == '\r' && peek == '\n') {
c = prot_getc(fin);
} else {
c = peek; /* single newline seperator */
}
if (c != ' ' && c != '\t') {
/* this is the end of the header */
body[off] = '\0';
prot_ungetc(c, fin);
goto got_header;
}
}
if (c >= 0x80) {
if (reject8bit) {
/* We have been configured to reject all mail of this
form. */
r = IMAP_MESSAGE_CONTAINS8BIT;
goto ph_error;
} else if (munge8bit) {
/* We have been configured to munge all mail of this
form. */
c = 'X';
}
}
/* just an ordinary character */
body[off++] = c;
if (off >= bodylen - 3) {
bodylen += BODYINC;
body = (char *) xrealloc(body, bodylen);
}
}
/* copy this to the output */
if (fout && s != NAME && !skip) fputc(c, fout);
}
/* if we fall off the end of the loop, we hit some sort of error
condition */
ph_error:
/* put the last character back; we'll copy it later */
if (c != EOF) prot_ungetc(c, fin);
/* and we didn't get a header */
if (headname != NULL) *headname = NULL;
if (contents != NULL) *contents = NULL;
return r;
got_header:
if (headname != NULL) *headname = xstrdup(name);
if (contents != NULL) *contents = xstrdup(body);
return 0;
}
void spool_cache_header(char *name, char *body, hdrcache_t cache)
{
int cl, clinit;
lcase(name);
clinit = cl = hashheader(name);
while (cache[cl] != NULL && strcmp(name, cache[cl]->name)) {
cl++; /* resolve collisions linearly */
cl %= HEADERCACHESIZE;
if (cl == clinit) break; /* gone all the way around, so bail */
}
/* found where to put it, so insert it into a list */
if (cache[cl]) {
/* add this body on */
cache[cl]->contents[cache[cl]->ncontents++] = body;
/* whoops, won't have room for the null at the end! */
if (!(cache[cl]->ncontents % 8)) {
/* increase the size */
cache[cl] = (header_t *)
xrealloc(cache[cl],sizeof(header_t) +
((8 + cache[cl]->ncontents) * sizeof(char *)));
}
/* have no need of this */
free(name);
} else {
/* create a new entry in the hash table */
cache[cl] = (header_t *) xmalloc(sizeof(header_t) + 8 * sizeof(char*));
cache[cl]->name = name;
cache[cl]->contents[0] = body;
cache[cl]->ncontents = 1;
}
/* we always want a NULL at the end */
cache[cl]->contents[cache[cl]->ncontents] = NULL;
}
int spool_fill_hdrcache(struct protstream *fin, FILE *fout, hdrcache_t cache,
const char **skipheaders)
{
int r = 0;
/* let's fill that header cache */
for (;;) {
char *name = NULL, *body = NULL;
if ((r = parseheader(fin, fout, &name, &body, skipheaders)) < 0) {
break;
}
if (!name) {
/* reached the end of headers */
free(body);
break;
}
/* put it in the hash table */
spool_cache_header(name, body, cache);
}
return r;
}
const char **spool_getheader(hdrcache_t cache, const char *phead)
{
char *head;
const char **ret = NULL;
int clinit, cl;
assert(cache && phead);
head = xstrdup(phead);
lcase(head);
/* check the cache */
clinit = cl = hashheader(head);
while (cache[cl] != NULL) {
if (!strcmp(head, cache[cl]->name)) {
ret = (const char **) cache[cl]->contents;
break;
}
cl++; /* try next hash bin */
cl %= HEADERCACHESIZE;
if (cl == clinit) break; /* gone all the way around */
}
free(head);
return ret;
}
void spool_free_hdrcache(hdrcache_t cache)
{
int i, j;
if (!cache) return;
for (i = 0; i < HEADERCACHESIZE; i++) {
if (cache[i]) {
free(cache[i]->name);
for (j = 0; j < cache[i]->ncontents; j++) {
free(cache[i]->contents[j]);
}
free(cache[i]);
}
}
free(cache);
}
void spool_enum_hdrcache(hdrcache_t cache,
void (*proc)(const char *, const char *, void *),
void *rock)
{
int i, j;
if (!cache) return;
for (i = 0; i < HEADERCACHESIZE; i++) {
if (cache[i]) {
for (j = 0; j < cache[i]->ncontents; j++) {
(*proc)(cache[i]->name, cache[i]->contents[j], rock);
}
}
}
}
/* copies the message from fin to fout, massaging accordingly:
. newlines are fiddled to \r\n
. "." terminates
. embedded NULs are rejected
. bare \r are removed
*/
int spool_copy_msg(struct protstream *fin, FILE *fout)
{
char buf[8192], *p;
int r = 0;
/* -2: Might need room to add a \r\n\0 set */
while (prot_fgets(buf, sizeof(buf)-2, fin)) {
p = buf + strlen(buf) - 1;
if (p < buf) {
/* buffer start with a \0 */
r = IMAP_MESSAGE_CONTAINSNULL;
continue; /* need to eat the rest of the message */
}
else if (buf[0] == '\r' && buf[1] == '\0') {
/* The message contained \r\0, and fgets is confusing us. */
r = IMAP_MESSAGE_CONTAINSNULL;
continue; /* need to eat the rest of the message */
}
else if (p[0] == '\r') {
/*
* We were unlucky enough to get a CR just before we ran
* out of buffer--put it back.
*/
prot_ungetc('\r', fin);
*p = '\0';
}
else if (p[0] == '\n' && (p == buf || p[-1] != '\r')) {
/* found an \n without a \r */
p[0] = '\r';
p[1] = '\n';
p[2] = '\0';
}
else if (p[0] != '\n' && (strlen(buf) < sizeof(buf)-3)) {
/* line contained a \0 not at the end */
r = IMAP_MESSAGE_CONTAINSNULL;
continue;
}
/* Remove any lone CR characters */
while ((p = strchr(buf, '\r')) && p[1] != '\n') {
/* Src/Target overlap, use memmove */
/* strlen(p) will result in copying the NUL byte as well */
memmove(p, p+1, strlen(p));
}
if (buf[0] == '.') {
if (buf[1] == '\r' && buf[2] == '\n') {
/* End of message */
goto dot;
}
/* Remove the dot-stuffing */
if (fout) fputs(buf+1, fout);
} else {
if (fout) fputs(buf, fout);
}
}
/* wow, serious error---got a premature EOF. */
return IMAP_IOERROR;
dot:
return r;
}