Edit File: news.c
/* ======================================================================== * Copyright 1988-2007 University of Washington * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * * ======================================================================== */ /* * Program: News routines * * Author: Mark Crispin * Networks and Distributed Computing * Computing & Communications * University of Washington * Administration Building, AG-44 * Seattle, WA 98195 * Internet: MRC@CAC.Washington.EDU * * Date: 4 September 1991 * Last Edited: 30 January 2007 */ #include <stdio.h> #include <ctype.h> #include <errno.h> extern int errno; /* just in case */ #include "mail.h" #include "osdep.h" #include <sys/stat.h> #include <sys/time.h> #include "misc.h" #include "newsrc.h" #include "fdstring.h" /* news_load_message() flags */ #define NLM_HEADER 0x1 /* load message text */ #define NLM_TEXT 0x2 /* load message text */ /* NEWS I/O stream local data */ typedef struct news_local { unsigned int dirty : 1; /* disk copy of .newsrc needs updating */ char *dir; /* spool directory name */ char *name; /* local mailbox name */ unsigned char buf[CHUNKSIZE]; /* scratch buffer */ unsigned long cachedtexts; /* total size of all cached texts */ } NEWSLOCAL; /* Convenient access to local data */ #define LOCAL ((NEWSLOCAL *) stream->local) /* Function prototypes */ DRIVER *news_valid (char *name); DRIVER *news_isvalid (char *name,char *mbx); void *news_parameters (long function,void *value); void news_scan (MAILSTREAM *stream,char *ref,char *pat,char *contents); void news_list (MAILSTREAM *stream,char *ref,char *pat); void news_lsub (MAILSTREAM *stream,char *ref,char *pat); long news_canonicalize (char *ref,char *pat,char *pattern); long news_subscribe (MAILSTREAM *stream,char *mailbox); long news_unsubscribe (MAILSTREAM *stream,char *mailbox); long news_create (MAILSTREAM *stream,char *mailbox); long news_delete (MAILSTREAM *stream,char *mailbox); long news_rename (MAILSTREAM *stream,char *old,char *newname); MAILSTREAM *news_open (MAILSTREAM *stream); int news_select (struct direct *name); int news_numsort (const void *d1,const void *d2); void news_close (MAILSTREAM *stream,long options); void news_fast (MAILSTREAM *stream,char *sequence,long flags); void news_flags (MAILSTREAM *stream,char *sequence,long flags); void news_load_message (MAILSTREAM *stream,unsigned long msgno,long flags); char *news_header (MAILSTREAM *stream,unsigned long msgno, unsigned long *length,long flags); long news_text (MAILSTREAM *stream,unsigned long msgno,STRING *bs,long flags); void news_flagmsg (MAILSTREAM *stream,MESSAGECACHE *elt); long news_ping (MAILSTREAM *stream); void news_check (MAILSTREAM *stream); long news_expunge (MAILSTREAM *stream,char *sequence,long options); long news_copy (MAILSTREAM *stream,char *sequence,char *mailbox,long options); long news_append (MAILSTREAM *stream,char *mailbox,append_t af,void *data); /* News routines */ /* Driver dispatch used by MAIL */ DRIVER newsdriver = { "news", /* driver name */ /* driver flags */ DR_NEWS|DR_READONLY|DR_NOFAST|DR_NAMESPACE|DR_NONEWMAIL|DR_DIRFMT, (DRIVER *) NIL, /* next driver */ news_valid, /* mailbox is valid for us */ news_parameters, /* manipulate parameters */ news_scan, /* scan mailboxes */ news_list, /* find mailboxes */ news_lsub, /* find subscribed mailboxes */ news_subscribe, /* subscribe to mailbox */ news_unsubscribe, /* unsubscribe from mailbox */ news_create, /* create mailbox */ news_delete, /* delete mailbox */ news_rename, /* rename mailbox */ mail_status_default, /* status of mailbox */ news_open, /* open mailbox */ news_close, /* close mailbox */ news_fast, /* fetch message "fast" attributes */ news_flags, /* fetch message flags */ NIL, /* fetch overview */ NIL, /* fetch message envelopes */ news_header, /* fetch message header */ news_text, /* fetch message body */ NIL, /* fetch partial message text */ NIL, /* unique identifier */ NIL, /* message number */ NIL, /* modify flags */ news_flagmsg, /* per-message modify flags */ NIL, /* search for message based on criteria */ NIL, /* sort messages */ NIL, /* thread messages */ news_ping, /* ping mailbox to see if still alive */ news_check, /* check for new messages */ news_expunge, /* expunge deleted messages */ news_copy, /* copy messages to another mailbox */ news_append, /* append string message to mailbox */ NIL /* garbage collect stream */ }; /* prototype stream */ MAILSTREAM newsproto = {&newsdriver}; /* News validate mailbox * Accepts: mailbox name * Returns: our driver if name is valid, NIL otherwise */ DRIVER *news_valid (char *name) { int fd; char *s,*t,*u; struct stat sbuf; if ((name[0] == '#') && (name[1] == 'n') && (name[2] == 'e') && (name[3] == 'w') && (name[4] == 's') && (name[5] == '.') && !strchr (name,'/') && !stat ((char *) mail_parameters (NIL,GET_NEWSSPOOL,NIL),&sbuf) && ((fd = open ((char *) mail_parameters (NIL,GET_NEWSACTIVE,NIL),O_RDONLY, NIL)) >= 0)) { fstat (fd,&sbuf); /* get size of active file */ /* slurp in active file */ read (fd,t = s = (char *) fs_get (sbuf.st_size+1),sbuf.st_size); s[sbuf.st_size] = '\0'; /* tie off file */ close (fd); /* flush file */ while (*t && (u = strchr (t,' '))) { *u++ = '\0'; /* tie off at end of name */ if (!strcmp (name+6,t)) { fs_give ((void **) &s); /* flush data */ return &newsdriver; } t = 1 + strchr (u,'\n'); /* next line */ } fs_give ((void **) &s); /* flush data */ } return NIL; /* return status */ } /* News manipulate driver parameters * Accepts: function code * function-dependent value * Returns: function-dependent return value */ void *news_parameters (long function,void *value) { return (function == GET_NEWSRC) ? env_parameters (function,value) : NIL; } /* News scan mailboxes * Accepts: mail stream * reference * pattern to search * string to scan */ void news_scan (MAILSTREAM *stream,char *ref,char *pat,char *contents) { char tmp[MAILTMPLEN]; if (news_canonicalize (ref,pat,tmp)) mm_log ("Scan not valid for news mailboxes",ERROR); } /* News find list of newsgroups * Accepts: mail stream * reference * pattern to search */ void news_list (MAILSTREAM *stream,char *ref,char *pat) { int fd; int i; char *s,*t,*u,*r,pattern[MAILTMPLEN],name[MAILTMPLEN]; struct stat sbuf; if (!pat || !*pat) { /* empty pattern? */ if (news_canonicalize (ref,"*",pattern)) { /* tie off name at root */ if (s = strchr (pattern,'.')) *++s = '\0'; else pattern[0] = '\0'; mm_list (stream,'.',pattern,LATT_NOSELECT); } } else if (news_canonicalize (ref,pat,pattern) && !stat ((char *) mail_parameters (NIL,GET_NEWSSPOOL,NIL),&sbuf) && ((fd = open ((char *) mail_parameters (NIL,GET_NEWSACTIVE,NIL), O_RDONLY,NIL)) >= 0)) { fstat (fd,&sbuf); /* get file size and read data */ read (fd,s = (char *) fs_get (sbuf.st_size + 1),sbuf.st_size); close (fd); /* close file */ s[sbuf.st_size] = '\0'; /* tie off string */ strcpy (name,"#news."); /* write initial prefix */ i = strlen (pattern); /* length of pattern */ if (pattern[--i] != '%') i = 0; if (t = strtok_r (s,"\n",&r)) do if (u = strchr (t,' ')) { *u = '\0'; /* tie off at end of name */ strcpy (name + 6,t); /* make full form of name */ if (pmatch_full (name,pattern,'.')) mm_list (stream,'.',name,NIL); else if (i && (u = strchr (name + i,'.'))) { *u = '\0'; /* tie off at delimiter, see if matches */ if (pmatch_full (name,pattern,'.')) mm_list (stream,'.',name,LATT_NOSELECT); } } while (t = strtok_r (NIL,"\n",&r)); fs_give ((void **) &s); } } /* News find list of subscribed newsgroups * Accepts: mail stream * reference * pattern to search */ void news_lsub (MAILSTREAM *stream,char *ref,char *pat) { char pattern[MAILTMPLEN]; /* return data from newsrc */ if (news_canonicalize (ref,pat,pattern)) newsrc_lsub (stream,pattern); } /* News canonicalize newsgroup name * Accepts: reference * pattern * returned single pattern * Returns: T on success, NIL on failure */ long news_canonicalize (char *ref,char *pat,char *pattern) { unsigned long i; char *s; if (ref && *ref) { /* have a reference */ strcpy (pattern,ref); /* copy reference to pattern */ /* # overrides mailbox field in reference */ if (*pat == '#') strcpy (pattern,pat); /* pattern starts, reference ends, with . */ else if ((*pat == '.') && (pattern[strlen (pattern) - 1] == '.')) strcat (pattern,pat + 1); /* append, omitting one of the period */ else strcat (pattern,pat); /* anything else is just appended */ } else strcpy (pattern,pat); /* just have basic name */ if ((pattern[0] == '#') && (pattern[1] == 'n') && (pattern[2] == 'e') && (pattern[3] == 'w') && (pattern[4] == 's') && (pattern[5] == '.') && !strchr (pattern,'/')) { /* count wildcards */ for (i = 0, s = pattern; *s; *s++) if ((*s == '*') || (*s == '%')) ++i; /* success if not too many */ if (i <= MAXWILDCARDS) return LONGT; MM_LOG ("Excessive wildcards in LIST/LSUB",ERROR); } return NIL; } /* News subscribe to mailbox * Accepts: mail stream * mailbox to add to subscription list * Returns: T on success, NIL on failure */ long news_subscribe (MAILSTREAM *stream,char *mailbox) { return news_valid (mailbox) ? newsrc_update (stream,mailbox+6,':') : NIL; } /* NEWS unsubscribe to mailbox * Accepts: mail stream * mailbox to delete from subscription list * Returns: T on success, NIL on failure */ long news_unsubscribe (MAILSTREAM *stream,char *mailbox) { return news_valid (mailbox) ? newsrc_update (stream,mailbox+6,'!') : NIL; } /* News create mailbox * Accepts: mail stream * mailbox name to create * Returns: T on success, NIL on failure */ long news_create (MAILSTREAM *stream,char *mailbox) { return NIL; /* never valid for News */ } /* News delete mailbox * mailbox name to delete * Returns: T on success, NIL on failure */ long news_delete (MAILSTREAM *stream,char *mailbox) { return NIL; /* never valid for News */ } /* News rename mailbox * Accepts: mail stream * old mailbox name * new mailbox name * Returns: T on success, NIL on failure */ long news_rename (MAILSTREAM *stream,char *old,char *newname) { return NIL; /* never valid for News */ } /* News open * Accepts: stream to open * Returns: stream on success, NIL on failure */ MAILSTREAM *news_open (MAILSTREAM *stream) { long i,nmsgs; char *s,tmp[MAILTMPLEN]; struct direct **names = NIL; /* return prototype for OP_PROTOTYPE call */ if (!stream) return &newsproto; if (stream->local) fatal ("news recycle stream"); /* build directory name */ sprintf (s = tmp,"%s/%s",(char *) mail_parameters (NIL,GET_NEWSSPOOL,NIL), stream->mailbox + 6); while (s = strchr (s,'.')) *s = '/'; /* scan directory */ if ((nmsgs = scandir (tmp,&names,news_select,news_numsort)) >= 0) { mail_exists (stream,nmsgs); /* notify upper level that messages exist */ stream->local = fs_get (sizeof (NEWSLOCAL)); LOCAL->dirty = NIL; /* no update to .newsrc needed yet */ LOCAL->dir = cpystr (tmp); /* copy directory name for later */ LOCAL->name = cpystr (stream->mailbox + 6); for (i = 0; i < nmsgs; ++i) { stream->uid_last = mail_elt (stream,i+1)->private.uid = atoi (names[i]->d_name); fs_give ((void **) &names[i]); } s = (void *) names; /* stupid language */ fs_give ((void **) &s); /* free directory */ LOCAL->cachedtexts = 0; /* no cached texts */ stream->sequence++; /* bump sequence number */ stream->rdonly = stream->perm_deleted = T; /* UIDs are always valid */ stream->uid_validity = 0xbeefface; /* read .newsrc entries */ mail_recent (stream,newsrc_read (LOCAL->name,stream)); /* notify if empty newsgroup */ if (!(stream->nmsgs || stream->silent)) { sprintf (tmp,"Newsgroup %s is empty",LOCAL->name); mm_log (tmp,WARN); } } else mm_log ("Unable to scan newsgroup spool directory",ERROR); return LOCAL ? stream : NIL; /* if stream is alive, return to caller */ } /* News file name selection test * Accepts: candidate directory entry * Returns: T to use file name, NIL to skip it */ int news_select (struct direct *name) { char c; char *s = name->d_name; while (c = *s++) if (!isdigit (c)) return NIL; return T; } /* News file name comparision * Accepts: first candidate directory entry * second candidate directory entry * Returns: negative if d1 < d2, 0 if d1 == d2, postive if d1 > d2 */ int news_numsort (const void *d1,const void *d2) { return atoi ((*(struct direct **) d1)->d_name) - atoi ((*(struct direct **) d2)->d_name); } /* News close * Accepts: MAIL stream * option flags */ void news_close (MAILSTREAM *stream,long options) { if (LOCAL) { /* only if a file is open */ news_check (stream); /* dump final checkpoint */ if (LOCAL->dir) fs_give ((void **) &LOCAL->dir); if (LOCAL->name) fs_give ((void **) &LOCAL->name); /* nuke the local data */ fs_give ((void **) &stream->local); stream->dtb = NIL; /* log out the DTB */ } } /* News fetch fast information * Accepts: MAIL stream * sequence * option flags */ void news_fast (MAILSTREAM *stream,char *sequence,long flags) { MESSAGECACHE *elt; unsigned long i; /* set up metadata for all messages */ if (stream && LOCAL && ((flags & FT_UID) ? mail_uid_sequence (stream,sequence) : mail_sequence (stream,sequence))) for (i = 1; i <= stream->nmsgs; i++) if ((elt = mail_elt (stream,i))->sequence && !(elt->day && elt->rfc822_size)) news_load_message (stream,i,NIL); } /* News fetch flags * Accepts: MAIL stream * sequence * option flags */ void news_flags (MAILSTREAM *stream,char *sequence,long flags) { unsigned long i; if ((flags & FT_UID) ? /* validate all elts */ mail_uid_sequence (stream,sequence) : mail_sequence (stream,sequence)) for (i = 1; i <= stream->nmsgs; i++) mail_elt (stream,i)->valid = T; } /* News load message into cache * Accepts: MAIL stream * message # * option flags */ void news_load_message (MAILSTREAM *stream,unsigned long msgno,long flags) { unsigned long i,j,nlseen; int fd; unsigned char c,*t; struct stat sbuf; MESSAGECACHE *elt; FDDATA d; STRING bs; elt = mail_elt (stream,msgno);/* get elt */ /* build message file name */ sprintf (LOCAL->buf,"%s/%lu",LOCAL->dir,elt->private.uid); /* anything we need not currently cached? */ if ((!elt->day || !elt->rfc822_size || ((flags & NLM_HEADER) && !elt->private.msg.header.text.data) || ((flags & NLM_TEXT) && !elt->private.msg.text.text.data)) && ((fd = open (LOCAL->buf,O_RDONLY,NIL)) >= 0)) { fstat (fd,&sbuf); /* get file metadata */ d.fd = fd; /* set up file descriptor */ d.pos = 0; /* start of file */ d.chunk = LOCAL->buf; d.chunksize = CHUNKSIZE; INIT (&bs,fd_string,&d,sbuf.st_size); if (!elt->day) { /* set internaldate to file date */ struct tm *tm = gmtime (&sbuf.st_mtime); elt->day = tm->tm_mday; elt->month = tm->tm_mon + 1; elt->year = tm->tm_year + 1900 - BASEYEAR; elt->hours = tm->tm_hour; elt->minutes = tm->tm_min; elt->seconds = tm->tm_sec; elt->zhours = 0; elt->zminutes = 0; } if (!elt->rfc822_size) { /* know message size yet? */ for (i = 0, j = SIZE (&bs), nlseen = 0; j--; ) switch (SNX (&bs)) { case '\015': /* unlikely carriage return */ if (!j || (CHR (&bs) != '\012')) { i++; /* ugh, raw CR */ nlseen = NIL; break; } SNX (&bs); /* eat the line feed, drop in */ case '\012': /* line feed? */ i += 2; /* count a CRLF */ /* header size known yet? */ if (!elt->private.msg.header.text.size && nlseen) { /* note position in file */ elt->private.special.text.size = GETPOS (&bs); /* and CRLF-adjusted size */ elt->private.msg.header.text.size = i; } nlseen = T; /* note newline seen */ break; default: /* ordinary chararacter */ i++; nlseen = NIL; break; } SETPOS (&bs,0); /* restore old position */ elt->rfc822_size = i; /* note that we have size now */ /* header is entire message if no delimiter */ if (!elt->private.msg.header.text.size) elt->private.msg.header.text.size = elt->rfc822_size; /* text is remainder of message */ elt->private.msg.text.text.size = elt->rfc822_size - elt->private.msg.header.text.size; } /* need to load cache with message data? */ if (((flags & NLM_HEADER) && !elt->private.msg.header.text.data) || ((flags & NLM_TEXT) && !elt->private.msg.text.text.data)) { /* purge cache if too big */ if (LOCAL->cachedtexts > max (stream->nmsgs * 4096,2097152)) { /* just can't keep that much */ mail_gc (stream,GC_TEXTS); LOCAL->cachedtexts = 0; } if ((flags & NLM_HEADER) && !elt->private.msg.header.text.data) { t = elt->private.msg.header.text.data = (unsigned char *) fs_get (elt->private.msg.header.text.size + 1); LOCAL->cachedtexts += elt->private.msg.header.text.size; /* read in message header */ for (i = 0; i <= elt->private.msg.header.text.size; i++) switch (c = SNX (&bs)) { case '\015': /* unlikely carriage return */ *t++ = c; if ((CHR (&bs) == '\012')) *t++ = SNX (&bs); break; case '\012': /* line feed? */ *t++ = '\015'; default: *t++ = c; break; } *t = '\0'; /* tie off string */ } if ((flags & NLM_TEXT) && !elt->private.msg.text.text.data) { t = elt->private.msg.text.text.data = (unsigned char *) fs_get (elt->private.msg.text.text.size + 1); SETPOS (&bs,elt->private.msg.header.text.size); LOCAL->cachedtexts += elt->private.msg.text.text.size; /* read in message text */ for (i = 0; i <= elt->private.msg.text.text.size; i++) switch (c = SNX (&bs)) { case '\015': /* unlikely carriage return */ *t++ = c; if ((CHR (&bs) == '\012')) *t++ = SNX (&bs); break; case '\012': /* line feed? */ *t++ = '\015'; default: *t++ = c; break; } *t = '\0'; /* tie off string */ } } close (fd); /* flush message file */ } } /* News fetch message header * Accepts: MAIL stream * message # to fetch * pointer to returned header text length * option flags * Returns: message header in RFC822 format */ char *news_header (MAILSTREAM *stream,unsigned long msgno, unsigned long *length,long flags) { MESSAGECACHE *elt; *length = 0; /* default to empty */ if (flags & FT_UID) return "";/* UID call "impossible" */ elt = mail_elt (stream,msgno);/* get elt */ if (!elt->private.msg.header.text.data) news_load_message (stream,msgno,NLM_HEADER); *length = elt->private.msg.header.text.size; return (char *) elt->private.msg.header.text.data; } /* News fetch message text (body only) * Accepts: MAIL stream * message # to fetch * pointer to returned stringstruct * option flags * Returns: T on success, NIL on failure */ long news_text (MAILSTREAM *stream,unsigned long msgno,STRING *bs,long flags) { MESSAGECACHE *elt; /* UID call "impossible" */ if (flags & FT_UID) return NIL; elt = mail_elt (stream,msgno);/* get elt */ /* snarf message if don't have it yet */ if (!elt->private.msg.text.text.data) { news_load_message (stream,msgno,NLM_TEXT); if (!elt->private.msg.text.text.data) return NIL; } if (!(flags & FT_PEEK)) { /* mark as seen */ mail_elt (stream,msgno)->seen = T; mm_flags (stream,msgno); } INIT (bs,mail_string,elt->private.msg.text.text.data, elt->private.msg.text.text.size); return T; } /* News per-message modify flag * Accepts: MAIL stream * message cache element */ void news_flagmsg (MAILSTREAM *stream,MESSAGECACHE *elt) { if (!LOCAL->dirty) { /* only bother checking if not dirty yet */ if (elt->valid) { /* if done, see if deleted changed */ if (elt->sequence != elt->deleted) LOCAL->dirty = T; elt->sequence = T; /* leave the sequence set */ } /* note current setting of deleted flag */ else elt->sequence = elt->deleted; } } /* News ping mailbox * Accepts: MAIL stream * Returns: T if stream alive, else NIL */ long news_ping (MAILSTREAM *stream) { return T; /* always alive */ } /* News check mailbox * Accepts: MAIL stream */ void news_check (MAILSTREAM *stream) { /* never do if no updates */ if (LOCAL->dirty) newsrc_write (LOCAL->name,stream); LOCAL->dirty = NIL; } /* News expunge mailbox * Accepts: MAIL stream * sequence to expunge if non-NIL * expunge options * Returns: T if success, NIL if failure */ long news_expunge (MAILSTREAM *stream,char *sequence,long options) { if (!stream->silent) mm_log ("Expunge ignored on readonly mailbox",NIL); return LONGT; } /* News copy message(s) * Accepts: MAIL stream * sequence * destination mailbox * option flags * Returns: T if copy successful, else NIL */ long news_copy (MAILSTREAM *stream,char *sequence,char *mailbox,long options) { mailproxycopy_t pc = (mailproxycopy_t) mail_parameters (stream,GET_MAILPROXYCOPY,NIL); if (pc) return (*pc) (stream,sequence,mailbox,options); mm_log ("Copy not valid for News",ERROR); return NIL; } /* News append message from stringstruct * Accepts: MAIL stream * destination mailbox * append callback function * data for callback * Returns: T if append successful, else NIL */ long news_append (MAILSTREAM *stream,char *mailbox,append_t af,void *data) { mm_log ("Append not valid for news",ERROR); return NIL; }