mmdf.h
上传用户:ycwykj01
上传日期:2007-01-04
资源大小:1819k
文件大小:11k
源码类别:

网络编程

开发平台:

Unix_Linux

  1. /*
  2.  * Program: MMDF mail routines
  3.  *
  4.  * Author: Mark Crispin
  5.  * Networks and Distributed Computing
  6.  * Computing & Communications
  7.  * University of Washington
  8.  * Administration Building, AG-44
  9.  * Seattle, WA  98195
  10.  * Internet: MRC@CAC.Washington.EDU
  11.  *
  12.  * Date: 15 May 1993
  13.  * Last Edited: 14 May 1999
  14.  *
  15.  * Copyright 1999 by the University of Washington
  16.  *
  17.  *  Permission to use, copy, modify, and distribute this software and its
  18.  * documentation for any purpose and without fee is hereby granted, provided
  19.  * that the above copyright notice appears in all copies and that both the
  20.  * above copyright notice and this permission notice appear in supporting
  21.  * documentation, and that the name of the University of Washington not be
  22.  * used in advertising or publicity pertaining to distribution of the software
  23.  * without specific, written prior permission.  This software is made
  24.  * available "as is", and
  25.  * THE UNIVERSITY OF WASHINGTON DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED,
  26.  * WITH REGARD TO THIS SOFTWARE, INCLUDING WITHOUT LIMITATION ALL IMPLIED
  27.  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, AND IN
  28.  * NO EVENT SHALL THE UNIVERSITY OF WASHINGTON BE LIABLE FOR ANY SPECIAL,
  29.  * INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  30.  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, TORT
  31.  * (INCLUDING NEGLIGENCE) OR STRICT LIABILITY, ARISING OUT OF OR IN CONNECTION
  32.  * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  33.  *
  34.  */
  35. /* Supposedly, this page has everything the MMDF driver needs to know about
  36.  * the MMDF delimiter.  By changing these macros, the MMDF driver should
  37.  * change with it.  Note that if you change the length of MMDFHDRTXT you
  38.  * also need to change the ISMMDF and RETIFMMDFWRD macros to reflect the new
  39.  * size.
  40.  */
  41. /* Useful MMDF constants */
  42. #define MMDFCHR '1' /* MMDF character */
  43. #define MMDFCHRS 0x01010101 /* MMDF header character spread in a word */
  44. /* MMDF header text */
  45. #define MMDFHDRTXT "1111n"
  46. /* length of MMDF header text */
  47. #define MMDFHDRLEN (sizeof (MMDFHDRTXT) - 1)
  48. /* Validate MMDF header
  49.  * Accepts: pointer to candidate string to validate as an MMDF header
  50.  * Returns: T if valid; else NIL
  51.  */
  52. #define ISMMDF(s)
  53.   ((*(s) == MMDFCHR) && ((s)[1] == MMDFCHR) && ((s)[2] == MMDFCHR) &&
  54.    ((s)[3] == MMDFCHR) && ((s)[4] == 'n'))
  55. /* Return if a 32-bit word has the start of an MMDF header
  56.  * Accepts: pointer to word of four bytes to validate as an MMDF header
  57.  * Returns: pointer to MMDF header, else proceeds
  58.  */
  59. #define RETIFMMDFWRD(s) {
  60.   if (s[3] == MMDFCHR) {
  61.     if ((s[4] == MMDFCHR) && (s[5] == MMDFCHR) && (s[6] == MMDFCHR) &&
  62. (s[7] == 'n')) return s + 3;
  63.     else if (s[2] == MMDFCHR) {
  64.       if ((s[4] == MMDFCHR) && (s[5] == MMDFCHR) && (s[6] == 'n'))
  65. return s + 2;
  66.       else if (s[1] == MMDFCHR) {
  67. if ((s[4] == MMDFCHR) && (s[5] == 'n')) return s + 1;
  68. else if ((*s == MMDFCHR) && (s[4] == 'n')) return s;
  69.       }
  70.     }
  71.   }
  72. }
  73. /* Validate line
  74.  * Accepts: pointer to candidate string to validate as a From header
  75.  *     return pointer to end of date/time field
  76.  *     return pointer to offset from t of time (hours of ``mmm dd hh:mm'')
  77.  *     return pointer to offset from t of time zone (if non-zero)
  78.  * Returns: t,ti,zn set if valid From string, else ti is NIL
  79.  */
  80. #define VALID(s,x,ti,zn) {
  81.   ti = 0;
  82.   if ((*s == 'F') && (s[1] == 'r') && (s[2] == 'o') && (s[3] == 'm') &&
  83.       (s[4] == ' ')) {
  84.     for (x = s + 5; *x && *x != 'n'; x++);
  85.     if (*x) {
  86.       if (x - s >= 41) {
  87. for (zn = -1; x[zn] != ' '; zn--);
  88. if ((x[zn-1] == 'm') && (x[zn-2] == 'o') && (x[zn-3] == 'r') &&
  89.     (x[zn-4] == 'f') && (x[zn-5] == ' ') && (x[zn-6] == 'e') &&
  90.     (x[zn-7] == 't') && (x[zn-8] == 'o') && (x[zn-9] == 'm') &&
  91.     (x[zn-10] == 'e') && (x[zn-11] == 'r') && (x[zn-12] == ' '))
  92.   x += zn - 12;
  93.       }
  94.       if (x - s >= 27) {
  95. if (x[-5] == ' ') {
  96.   if (x[-8] == ':') zn = 0,ti = -5;
  97.   else if (x[-9] == ' ') ti = zn = -9;
  98.   else if ((x[-11] == ' ') && ((x[-10]=='+') || (x[-10]=='-')))
  99.     ti = zn = -11;
  100. }
  101. else if (x[-4] == ' ') {
  102.   if (x[-9] == ' ') zn = -4,ti = -9;
  103. }
  104. else if (x[-6] == ' ') {
  105.   if ((x[-11] == ' ') && ((x[-5] == '+') || (x[-5] == '-')))
  106.     zn = -6,ti = -11;
  107. }
  108. if (ti && !((x[ti - 3] == ':') &&
  109.     (x[ti -= ((x[ti - 6] == ':') ? 9 : 6)] == ' ') &&
  110.     (x[ti - 3] == ' ') && (x[ti - 7] == ' ') &&
  111.     (x[ti - 11] == ' '))) ti = 0;
  112.       }
  113.     }
  114.   }
  115. }
  116. /* You are not expected to understand this macro, but read the next page if
  117.  * you are not faint of heart.
  118.  *
  119.  * Known formats to the VALID macro are:
  120.  * From user Wed Dec  2 05:53 1992
  121.  * BSD From user Wed Dec  2 05:53:22 1992
  122.  * SysV From user Wed Dec  2 05:53 PST 1992
  123.  * rn From user Wed Dec  2 05:53:22 PST 1992
  124.  * From user Wed Dec  2 05:53 -0700 1992
  125.  * emacs From user Wed Dec  2 05:53:22 -0700 1992
  126.  * From user Wed Dec  2 05:53 1992 PST
  127.  * From user Wed Dec  2 05:53:22 1992 PST
  128.  * From user Wed Dec  2 05:53 1992 -0700
  129.  * Solaris From user Wed Dec  2 05:53:22 1992 -0700
  130.  *
  131.  * Plus all of the above with `` remote from xxx'' after it. Thank you very
  132.  * much, smail and Solaris, for making my life considerably more complicated.
  133.  */
  134. /*
  135.  * What?  You want to understand the VALID macro anyway?  Alright, since you
  136.  * insist.  Actually, it isn't really all that difficult, provided that you
  137.  * take it step by step.
  138.  *
  139.  * Line 1 Initializes the return ti value to failure (0);
  140.  * Lines 2-3 Validates that the 1st-5th characters are ``From ''.
  141.  * Lines 4-5 Validates that there is an end of line and points x at it.
  142.  * Lines 6-13 First checks to see if the line is at least 41 characters long.
  143.  * If so, it scans backwards to find the rightmost space.  From
  144.  * that point, it scans backwards to see if the string matches
  145.  * `` remote from''.  If so, it sets x to point to the space at
  146.  * the start of the string.
  147.  * Line 14 Makes sure that there are at least 27 characters in the line.
  148.  * Lines 15-20 Checks if the date/time ends with the year (there is a space
  149.  * five characters back).  If there is a colon three characters
  150.  * further back, there is no timezone field, so zn is set to 0
  151.  * and ti is set in front of the year.  Otherwise, there must
  152.  * either to be a space four characters back for a three-letter
  153.  * timezone, or a space six characters back followed by a + or -
  154.  * for a numeric timezone; in either case, zn and ti become the
  155.  * offset of the space immediately before it.
  156.  * Lines 21-23 Are the failure case for line 14.  If there is a space four
  157.  * characters back, it is a three-letter timezone; there must be a
  158.  * space for the year nine characters back.  zn is the zone
  159.  * offset; ti is the offset of the space.
  160.  * Lines 24-27 Are the failure case for line 20.  If there is a space six
  161.  * characters back, it is a numeric timezone; there must be a
  162.  * space eleven characters back and a + or - five characters back.
  163.  * zn is the zone offset; ti is the offset of the space.
  164.  * Line 28-31 If ti is valid, make sure that the string before ti is of the
  165.  * form www mmm dd hh:mm or www mmm dd hh:mm:ss, otherwise
  166.  * invalidate ti.  There must be a colon three characters back
  167.  * and a space six or nine characters back (depending upon
  168.  * whether or not the character six characters back is a colon).
  169.  * There must be a space three characters further back (in front
  170.  * of the day), one seven characters back (in front of the month),
  171.  * and one eleven characters back (in front of the day of week).
  172.  * ti is set to be the offset of the space before the time.
  173.  *
  174.  * Why a macro?  It gets invoked a *lot* in a tight loop.  On some of the
  175.  * newer pipelined machines it is faster being open-coded than it would be if
  176.  * subroutines are called.
  177.  *
  178.  * Why does it scan backwards from the end of the line, instead of doing the
  179.  * much easier forward scan?  There is no deterministic way to parse the
  180.  * ``user'' field, because it may contain unquoted spaces!  Yes, I tested it to
  181.  * see if unquoted spaces were possible.  They are, and I've encountered enough
  182.  * evil mail to be totally unwilling to trust that ``it will never happen''.
  183.  */
  184. /* Build parameters */
  185. #define KODRETRY 15 /* kiss-of-death retry in seconds */
  186. #define LOCKTIMEOUT 5 /* lock timeout in minutes */
  187. #define CHUNK 16384 /* read-in chunk size */
  188. /* MMDF I/O stream local data */
  189. typedef struct mmdf_local {
  190.   unsigned int dirty : 1; /* disk copy needs updating */
  191.   int fd; /* mailbox file descriptor */
  192.   int ld; /* lock file descriptor */
  193.   char *name; /* local file name for recycle case */
  194.   char *lname; /* lock file name */
  195.   off_t filesize; /* file size parsed */
  196.   time_t filetime; /* last file time */
  197.   char *buf; /* temporary buffer */
  198.   unsigned long buflen; /* current size of temporary buffer */
  199.   char *line; /* returned line */
  200. } MMDFLOCAL;
  201. /* Convenient access to local data */
  202. #define LOCAL ((MMDFLOCAL *) stream->local)
  203. /* Function prototypes */
  204. DRIVER *mmdf_valid (char *name);
  205. long mmdf_isvalid (char *name,char *tmp);
  206. long mmdf_isvalid_fd (int fd,char *tmp);
  207. void *mmdf_parameters (long function,void *value);
  208. void mmdf_scan (MAILSTREAM *stream,char *ref,char *pat,char *contents);
  209. void mmdf_list (MAILSTREAM *stream,char *ref,char *pat);
  210. void mmdf_lsub (MAILSTREAM *stream,char *ref,char *pat);
  211. long mmdf_create (MAILSTREAM *stream,char *mailbox);
  212. long mmdf_delete (MAILSTREAM *stream,char *mailbox);
  213. long mmdf_rename (MAILSTREAM *stream,char *old,char *newname);
  214. MAILSTREAM *mmdf_open (MAILSTREAM *stream);
  215. void mmdf_close (MAILSTREAM *stream,long options);
  216. char *mmdf_header (MAILSTREAM *stream,unsigned long msgno,
  217.    unsigned long *length,long flags);
  218. long mmdf_text (MAILSTREAM *stream,unsigned long msgno,STRING *bs,long flags);
  219. char *mmdf_text_work (MAILSTREAM *stream,MESSAGECACHE *elt,
  220.       unsigned long *length,long flags);
  221. void mmdf_flagmsg (MAILSTREAM *stream,MESSAGECACHE *elt);
  222. long mmdf_ping (MAILSTREAM *stream);
  223. void mmdf_check (MAILSTREAM *stream);
  224. void mmdf_check (MAILSTREAM *stream);
  225. void mmdf_expunge (MAILSTREAM *stream);
  226. long mmdf_copy (MAILSTREAM *stream,char *sequence,char *mailbox,long options);
  227. long mmdf_append (MAILSTREAM *stream,char *mailbox,char *flags,char *date,
  228.   STRING *message);
  229. void mmdf_abort (MAILSTREAM *stream);
  230. char *mmdf_file (char *dst,char *name);
  231. int mmdf_lock (char *file,int flags,int mode,DOTLOCK *lock,int op);
  232. void mmdf_unlock (int fd,MAILSTREAM *stream,DOTLOCK *lock);
  233. int mmdf_parse (MAILSTREAM *stream,DOTLOCK *lock,int op);
  234. char *mmdf_mbxline (MAILSTREAM *stream,STRING *bs,unsigned long *size);
  235. unsigned long mmdf_pseudo (MAILSTREAM *stream,char *hdr);
  236. unsigned long mmdf_xstatus (MAILSTREAM *stream,char *status,MESSAGECACHE *elt,
  237.     long flag);
  238. long mmdf_rewrite (MAILSTREAM *stream,unsigned long *nexp,DOTLOCK *lock);
  239. long mmdf_write_message (FILE *f,MAILSTREAM *stream,MESSAGECACHE *elt,
  240.  unsigned long *size);
  241. long mmdf_fwrite (FILE *f,char *s,unsigned long i,unsigned long *size);
  242. long mmdf_punt_scratch (FILE *f);