unix.h
上传用户:ycwykj01
上传日期:2007-01-04
资源大小:1819k
文件大小:11k
- /*
- * Program: UNIX mail 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: 20 December 1989
- * Last Edited: 4 August 1999
- *
- * Copyright 1999 by the University of Washington
- *
- * Permission to use, copy, modify, and distribute this software and its
- * documentation for any purpose and without fee is hereby granted, provided
- * that the above copyright notice appears in all copies and that both the
- * above copyright notice and this permission notice appear in supporting
- * documentation, and that the name of the University of Washington not be
- * used in advertising or publicity pertaining to distribution of the software
- * without specific, written prior permission. This software is made
- * available "as is", and
- * THE UNIVERSITY OF WASHINGTON DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED,
- * WITH REGARD TO THIS SOFTWARE, INCLUDING WITHOUT LIMITATION ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, AND IN
- * NO EVENT SHALL THE UNIVERSITY OF WASHINGTON 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, TORT
- * (INCLUDING NEGLIGENCE) OR STRICT LIABILITY, ARISING OUT OF OR IN CONNECTION
- * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- *
- */
- /* DEDICATION
- *
- * This file is dedicated to my dog, Unix, also known as Yun-chan and
- * Unix J. Terwilliker Jehosophat Aloysius Monstrosity Animal Beast. Unix
- * passed away at the age of 11 1/2 on September 14, 1996, 12:18 PM PDT, after
- * a two-month bout with cirrhosis of the liver.
- *
- * He was a dear friend, and I miss him terribly.
- *
- * Lift a leg, Yunie. Luv ya forever!!!!
- */
- /* Validate line
- * Accepts: pointer to candidate string to validate as a From header
- * return pointer to end of date/time field
- * return pointer to offset from t of time (hours of ``mmm dd hh:mm'')
- * return pointer to offset from t of time zone (if non-zero)
- * Returns: t,ti,zn set if valid From string, else ti is NIL
- */
- #define VALID(s,x,ti,zn) {
- ti = 0;
- if ((*s == 'F') && (s[1] == 'r') && (s[2] == 'o') && (s[3] == 'm') &&
- (s[4] == ' ')) {
- for (x = s + 5; *x && *x != ' 12'; x++);
- if (*x) {
- if (x[-1] == ' 15') --x;
- if (x - s >= 41) {
- for (zn = -1; x[zn] != ' '; zn--);
- if ((x[zn-1] == 'm') && (x[zn-2] == 'o') && (x[zn-3] == 'r') &&
- (x[zn-4] == 'f') && (x[zn-5] == ' ') && (x[zn-6] == 'e') &&
- (x[zn-7] == 't') && (x[zn-8] == 'o') && (x[zn-9] == 'm') &&
- (x[zn-10] == 'e') && (x[zn-11] == 'r') && (x[zn-12] == ' '))
- x += zn - 12;
- }
- if (x - s >= 27) {
- if (x[-5] == ' ') {
- if (x[-8] == ':') zn = 0,ti = -5;
- else if (x[-9] == ' ') ti = zn = -9;
- else if ((x[-11] == ' ') && ((x[-10]=='+') || (x[-10]=='-')))
- ti = zn = -11;
- }
- else if (x[-4] == ' ') {
- if (x[-9] == ' ') zn = -4,ti = -9;
- }
- else if (x[-6] == ' ') {
- if ((x[-11] == ' ') && ((x[-5] == '+') || (x[-5] == '-')))
- zn = -6,ti = -11;
- }
- if (ti && !((x[ti - 3] == ':') &&
- (x[ti -= ((x[ti - 6] == ':') ? 9 : 6)] == ' ') &&
- (x[ti - 3] == ' ') && (x[ti - 7] == ' ') &&
- (x[ti - 11] == ' '))) ti = 0;
- }
- }
- }
- }
- /* You are not expected to understand this macro, but read the next page if
- * you are not faint of heart.
- *
- * Known formats to the VALID macro are:
- * From user Wed Dec 2 05:53 1992
- * BSD From user Wed Dec 2 05:53:22 1992
- * SysV From user Wed Dec 2 05:53 PST 1992
- * rn From user Wed Dec 2 05:53:22 PST 1992
- * From user Wed Dec 2 05:53 -0700 1992
- * emacs From user Wed Dec 2 05:53:22 -0700 1992
- * From user Wed Dec 2 05:53 1992 PST
- * From user Wed Dec 2 05:53:22 1992 PST
- * From user Wed Dec 2 05:53 1992 -0700
- * Solaris From user Wed Dec 2 05:53:22 1992 -0700
- *
- * Plus all of the above with `` remote from xxx'' after it. Thank you very
- * much, smail and Solaris, for making my life considerably more complicated.
- */
- /*
- * What? You want to understand the VALID macro anyway? Alright, since you
- * insist. Actually, it isn't really all that difficult, provided that you
- * take it step by step.
- *
- * Line 1 Initializes the return ti value to failure (0);
- * Lines 2-3 Validates that the 1st-5th characters are ``From ''.
- * Lines 4-6 Validates that there is an end of line and points x at it.
- * Lines 7-14 First checks to see if the line is at least 41 characters long.
- * If so, it scans backwards to find the rightmost space. From
- * that point, it scans backwards to see if the string matches
- * `` remote from''. If so, it sets x to point to the space at
- * the start of the string.
- * Line 15 Makes sure that there are at least 27 characters in the line.
- * Lines 16-21 Checks if the date/time ends with the year (there is a space
- * five characters back). If there is a colon three characters
- * further back, there is no timezone field, so zn is set to 0
- * and ti is set in front of the year. Otherwise, there must
- * either to be a space four characters back for a three-letter
- * timezone, or a space six characters back followed by a + or -
- * for a numeric timezone; in either case, zn and ti become the
- * offset of the space immediately before it.
- * Lines 22-24 Are the failure case for line 14. If there is a space four
- * characters back, it is a three-letter timezone; there must be a
- * space for the year nine characters back. zn is the zone
- * offset; ti is the offset of the space.
- * Lines 25-28 Are the failure case for line 20. If there is a space six
- * characters back, it is a numeric timezone; there must be a
- * space eleven characters back and a + or - five characters back.
- * zn is the zone offset; ti is the offset of the space.
- * Line 29-32 If ti is valid, make sure that the string before ti is of the
- * form www mmm dd hh:mm or www mmm dd hh:mm:ss, otherwise
- * invalidate ti. There must be a colon three characters back
- * and a space six or nine characters back (depending upon
- * whether or not the character six characters back is a colon).
- * There must be a space three characters further back (in front
- * of the day), one seven characters back (in front of the month),
- * and one eleven characters back (in front of the day of week).
- * ti is set to be the offset of the space before the time.
- *
- * Why a macro? It gets invoked a *lot* in a tight loop. On some of the
- * newer pipelined machines it is faster being open-coded than it would be if
- * subroutines are called.
- *
- * Why does it scan backwards from the end of the line, instead of doing the
- * much easier forward scan? There is no deterministic way to parse the
- * ``user'' field, because it may contain unquoted spaces! Yes, I tested it to
- * see if unquoted spaces were possible. They are, and I've encountered enough
- * evil mail to be totally unwilling to trust that ``it will never happen''.
- */
- /* Build parameters */
- #define KODRETRY 15 /* kiss-of-death retry in seconds */
- #define LOCKTIMEOUT 5 /* lock timeout in minutes */
- #define CHUNK 16384 /* read-in chunk size */
- /* UNIX I/O stream local data */
- typedef struct unix_local {
- unsigned int dirty : 1; /* disk copy needs updating */
- int fd; /* mailbox file descriptor */
- int ld; /* lock file descriptor */
- char *lname; /* lock file name */
- off_t filesize; /* file size parsed */
- time_t filetime; /* last file time */
- time_t lastsnarf; /* last snarf time (for mbox driver) */
- char *buf; /* temporary buffer */
- unsigned long buflen; /* current size of temporary buffer */
- char *line; /* returned line */
- } UNIXLOCAL;
- /* Convenient access to local data */
- #define LOCAL ((UNIXLOCAL *) stream->local)
- /* UNIX protected file structure */
- typedef struct unix_file {
- MAILSTREAM *stream; /* current stream */
- off_t curpos; /* current file position */
- off_t protect; /* protected position */
- off_t filepos; /* current last written file position */
- char *buf; /* overflow buffer */
- size_t buflen; /* current overflow buffer length */
- char *bufpos; /* current buffer position */
- } UNIXFILE;
- /* Function prototypes */
- DRIVER *unix_valid (char *name);
- long unix_isvalid_fd (int fd);
- void *unix_parameters (long function,void *value);
- void unix_scan (MAILSTREAM *stream,char *ref,char *pat,char *contents);
- void unix_list (MAILSTREAM *stream,char *ref,char *pat);
- void unix_lsub (MAILSTREAM *stream,char *ref,char *pat);
- long unix_create (MAILSTREAM *stream,char *mailbox);
- long unix_delete (MAILSTREAM *stream,char *mailbox);
- long unix_rename (MAILSTREAM *stream,char *old,char *newname);
- MAILSTREAM *unix_open (MAILSTREAM *stream);
- void unix_close (MAILSTREAM *stream,long options);
- char *unix_header (MAILSTREAM *stream,unsigned long msgno,
- unsigned long *length,long flags);
- long unix_text (MAILSTREAM *stream,unsigned long msgno,STRING *bs,long flags);
- char *unix_text_work (MAILSTREAM *stream,MESSAGECACHE *elt,
- unsigned long *length,long flags);
- void unix_flagmsg (MAILSTREAM *stream,MESSAGECACHE *elt);
- long unix_ping (MAILSTREAM *stream);
- void unix_check (MAILSTREAM *stream);
- void unix_check (MAILSTREAM *stream);
- void unix_expunge (MAILSTREAM *stream);
- long unix_copy (MAILSTREAM *stream,char *sequence,char *mailbox,long options);
- long unix_append (MAILSTREAM *stream,char *mailbox,char *flags,char *date,
- STRING *message);
- long unix_append_putc (int fd,char *s,long *i,char c);
- void unix_abort (MAILSTREAM *stream);
- char *unix_file (char *dst,char *name);
- int unix_lock (char *file,int flags,int mode,DOTLOCK *lock,int op);
- void unix_unlock (int fd,MAILSTREAM *stream,DOTLOCK *lock);
- int unix_parse (MAILSTREAM *stream,DOTLOCK *lock,int op);
- char *unix_mbxline (MAILSTREAM *stream,STRING *bs,unsigned long *size);
- unsigned long unix_pseudo (MAILSTREAM *stream,char *hdr);
- unsigned long unix_xstatus (MAILSTREAM *stream,char *status,MESSAGECACHE *elt,
- long flag);
- long unix_rewrite (MAILSTREAM *stream,unsigned long *nexp,DOTLOCK *lock);
- long unix_extend (MAILSTREAM *stream,unsigned long size);
- /* New algorithm */
- long unix_rewrite_new (MAILSTREAM *stream,unsigned long *nexp,
- unsigned long *size,unsigned long *recent);
- void unix_write (UNIXFILE *f,char *s,unsigned long i);
- void unix_phys_write (UNIXFILE *f,char *buf,size_t size);
- /* Old algorithm */
- long unix_rewrite_old (MAILSTREAM *stream,unsigned long *nexp,
- unsigned long *size,unsigned long *recent);
- long unix_write_message (FILE *f,MAILSTREAM *stream,MESSAGECACHE *elt,
- unsigned long *size);
- long unix_fwrite (FILE *f,char *s,unsigned long i,unsigned long *size);
- long unix_punt_scratch (FILE *f);