/*
* Program: File 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: 25 August 1993
* Last Edited: 4 January 1996
*
* Copyright 1996 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.
*
*/
#include <stdio.h>
#include <ctype.h>
#include <errno.h>
extern int errno; /* just in case */
#include <signal.h>
#include "mail.h"
#include "osdep.h"
#include <pwd.h>
#include <sys/stat.h>
#include <sys/time.h>
#include "phile.h"
#include "rfc822.h"
#include "misc.h"
#include "dummy.h"
/* File routines */
/* Driver dispatch used by MAIL */
DRIVER philedriver = {
"phile", /* driver name */
/* driver flags */
DR_LOCAL|DR_READONLY|DR_NAMESPACE,
(DRIVER *) NIL, /* next driver */
phile_valid, /* mailbox is valid for us */
phile_parameters, /* manipulate parameters */
phile_scan, /* scan mailboxes */
phile_list, /* list mailboxes */
phile_lsub, /* list subscribed mailboxes */
NIL, /* subscribe to mailbox */
NIL, /* unsubscribe from mailbox */
phile_create, /* create mailbox */
phile_delete, /* delete mailbox */
phile_rename, /* rename mailbox */
NIL, /* status of mailbox */
phile_open, /* open mailbox */
phile_close, /* close mailbox */
phile_fetchfast, /* fetch message "fast" attributes */
phile_fetchflags, /* fetch message flags */
phile_fetchstructure, /* fetch message envelopes */
phile_fetchheader, /* fetch message header only */
phile_fetchtext, /* fetch message body only */
phile_fetchbody, /* fetch message body section */
NIL, /* unique identifier */
phile_setflag, /* set message flag */
phile_clearflag, /* clear message flag */
NIL, /* search for message based on criteria */
phile_ping, /* ping mailbox to see if still alive */
phile_check, /* check for new messages */
phile_expunge, /* expunge deleted messages */
phile_copy, /* copy messages to another mailbox */
phile_append, /* append string message to mailbox */
phile_gc /* garbage collect stream */
};
/* prototype stream */
MAILSTREAM phileproto = {&philedriver};
/* File validate mailbox
* Accepts: mailbox name
* Returns: our driver if name is valid, NIL otherwise
*/
DRIVER *phile_valid (char *name)
{
char tmp[MAILTMPLEN];
return phile_isvalid (name,tmp) ? &philedriver : NIL;
}
/* File test for valid mailbox
* Accepts: mailbox name
* Returns: T if valid, NIL otherwise
*/
int phile_isvalid (char *name,char *tmp)
{
struct stat sbuf;
char *s;
/* INBOX never accepted, any other name is */
return ((*name != '{') && (s = mailboxfile (tmp,name)) && *s &&
!stat (s,&sbuf) && !(sbuf.st_mode & S_IFDIR) &&
/* only allow empty files if #ftp */
(sbuf.st_size || (*name == '#')));
}
/* File manipulate driver parameters
* Accepts: function code
* function-dependent value
* Returns: function-dependent return value
*/
void *phile_parameters (long function,void *value)
{
return NIL;
}
/* File mail scan mailboxes
* Accepts: mail stream
* reference
* pattern to search
* string to scan
*/
void phile_scan (MAILSTREAM *stream,char *ref,char *pat,char *contents)
{
if (stream) dummy_scan (NIL,ref,pat,contents);
}
/* File list mailboxes
* Accepts: mail stream
* reference
* pattern to search
*/
void phile_list (MAILSTREAM *stream,char *ref,char *pat)
{
if (stream || ((*pat == '#') || (ref && *ref == '#')))
dummy_list (NIL,ref,pat);
}
/* File list subscribed mailboxes
* Accepts: mail stream
* reference
* pattern to search
*/
void phile_lsub (MAILSTREAM *stream,char *ref,char *pat)
{
if (stream || ((*pat == '#') || (ref && *ref == '#')))
dummy_lsub (NIL,ref,pat);
}
/* File create mailbox
* Accepts: MAIL stream
* mailbox name to create
* Returns: T on success, NIL on failure
*/
long phile_create (MAILSTREAM *stream,char *mailbox)
{
return dummy_create (stream,mailbox);
}
/* File delete mailbox
* Accepts: MAIL stream
* mailbox name to delete
* Returns: T on success, NIL on failure
*/
long phile_delete (MAILSTREAM *stream,char *mailbox)
{
return dummy_delete (stream,mailbox);
}
/* File rename mailbox
* Accepts: MAIL stream
* old mailbox name
* new mailbox name (or NIL for delete)
* Returns: T on success, NIL on failure
*/
long phile_rename (MAILSTREAM *stream,char *old,char *newname)
{
return dummy_rename (stream,old,newname);
}
/* File open
* Accepts: Stream to open
* Returns: Stream on success, NIL on failure
*/
MAILSTREAM *phile_open (MAILSTREAM *stream)
{
int i,k,fd;
unsigned long j,m;
char *s,tmp[MAILTMPLEN];
struct passwd *pw;
struct stat sbuf;
struct tm *t;
MESSAGECACHE *elt;
/* return prototype for OP_PROTOTYPE call */
if (!stream) return &phileproto;
if (LOCAL) { /* close old file if stream being recycled */
phile_close (stream,NIL); /* dump and save the changes */
stream->dtb = &philedriver; /* reattach this driver */
mail_free_cache (stream); /* clean up cache */
}
/* canonicalize the stream mailbox name */
mailboxfile (tmp,stream->mailbox);
fs_give ((void **) &stream->mailbox);
stream->mailbox = cpystr (tmp);
/* open mailbox */
if (stat (tmp,&sbuf) || (fd = open (tmp,O_RDONLY,NIL)) < 0) {
sprintf (tmp,"Unable to open file %s",stream->mailbox);
mm_log (tmp,ERROR);
return NIL;
}
stream->local = fs_get (sizeof (PHILELOCAL));
/* initialize file information */
(elt = mail_elt (stream,1))->rfc822_size = sbuf.st_size;
elt->valid = elt->recent = T; /* mark valid flags */
stream->sequence++; /* bump sequence number */
stream->rdonly = T; /* make sure upper level knows readonly */
/* instantiate a new envelope and body */
LOCAL->env = mail_newenvelope ();
LOCAL->body = mail_newbody ();
t = gmtime (&sbuf.st_mtime); /* get UTC time and Julian day */
i = t->tm_hour * 60 + t->tm_min;
k = t->tm_yday;
t = localtime(&sbuf.st_mtime);/* get local time */
/* calulate time delta */
i = t->tm_hour * 60 + t->tm_min - i;
if (k = t->tm_yday - k) i += ((k < 0) == (abs (k) == 1)) ? -24*60 : 24*60;
k = abs (i); /* time from UTC either way */
elt->hours = t->tm_hour; elt->minutes = t->tm_min; elt->seconds = t->tm_sec;
elt->day = t->tm_mday; elt->month = t->tm_mon + 1;
elt->year = t->tm_year - (BASEYEAR - 1900);
elt->zoccident = (k == i) ? 0 : 1;
elt->zhours = k/60;
elt->zminutes = k % 60;
sprintf (tmp,"%s, %d %s %d %02d:%02d:%02d %c%02d%02d",
days[t->tm_wday],t->tm_mday,months[t->tm_mon],t->tm_year+1900,
t->tm_hour,t->tm_min,t->tm_sec,elt->zoccident ? '-' : '+',
elt->zhours,elt->zminutes);
/* set up Date field */
LOCAL->env->date = cpystr (tmp);
/* fill in From field from file owner */
LOCAL->env->from = mail_newaddr ();
if (pw = getpwuid (sbuf.st_uid)) strcpy (tmp,pw->pw_name);
else sprintf (tmp,"User-Number-%ld",(long) sbuf.st_uid);
LOCAL->env->from->mailbox = cpystr (tmp);
LOCAL->env->from->host = cpystr (mylocalhost ());
/* set subject to be mailbox name */
LOCAL->env->subject = cpystr (stream->mailbox);
/* slurp the data */
read (fd,LOCAL->buf = (char *) fs_get (elt->rfc822_size+1),elt->rfc822_size);
LOCAL->buf[elt->rfc822_size] = '\0';
close (fd); /* close the file */
/* analyze data type */
if (i = phile_type ((unsigned char *) LOCAL->buf,elt->rfc822_size,&j)) {
LOCAL->body->type = TYPETEXT;
LOCAL->body->subtype = cpystr ("PLAIN");
if (!(i & PTYPECRTEXT)) { /* change Internet newline format as needed */
STRING bs;
INIT (&bs,mail_string,(void *) (s = LOCAL->buf),elt->rfc822_size);
LOCAL->buf = (char *) fs_get ((m = strcrlflen (&bs) + 1));
strcrlfcpy (&LOCAL->buf,&m,s,elt->rfc822_size);
elt->rfc822_size = m; /* update size */
fs_give ((void **) &s); /* flush original UNIX-format string */
}
LOCAL->body->parameter = mail_newbody_parameter ();
LOCAL->body->parameter->attribute = cpystr ("charset");
LOCAL->body->parameter->value =
cpystr ((i & PTYPEISO2022JP) ? "ISO-2022-JP" :
(i & PTYPEISO2022KR) ? "ISO-2022-KR" :
(i & PTYPE8) ? "ISO-8859-1" : "US-ASCII");
LOCAL->body->encoding = (i & PTYPE8) ? ENC8BIT : ENC7BIT;
LOCAL->body->size.lines = j;
}
else { /* binary data */
LOCAL->body->type = TYPEAPPLICATION;
LOCAL->body->subtype = cpystr ("OCTET-STREAM");
LOCAL->body->parameter = mail_newbody_parameter ();
LOCAL->body->parameter->attribute = cpystr ("name");
LOCAL->body->parameter->value =
cpystr ((s = (strrchr (stream->mailbox,'/'))) ? s+1 : stream->mailbox);
LOCAL->body->encoding = ENCBASE64;
LOCAL->buf = (char *) rfc822_binary (s = LOCAL->buf,elt->rfc822_size,
&elt->rfc822_size);
fs_give ((void **) &s); /* flush originary binary contents */
}
LOCAL->body->size.bytes = elt->rfc822_size;
phile_fetchheader (stream,1,NIL,&j,NIL);
elt->rfc822_size += j;
/* only one message ever... */
stream->uid_last = elt->uid = 1;
mail_exists (stream,1); /* make sure upper level knows */
mail_recent (stream,1);
return stream; /* return stream alive to caller */
}
/* File determine data type
* Accepts: data to examine
* size of data
* pointer to line count return
* Returns: PTYPE mask of data type
*/
int phile_type (unsigned char *s,unsigned long i,unsigned long *j)
{
int ret = PTYPETEXT;
char *charvec = "bbbbbbbaaalaacaabbbbbbbbbbbebbbbaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaabAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA";
*j = 0; /* no lines */
/* check type of every character */
while (i--) switch (charvec[*s++]) {
case 'A':
ret |= PTYPE8; /* 8bit character */
break;
case 'a':
break; /* ASCII character */
case 'b':
return PTYPEBINARY; /* binary byte seen, stop immediately */
case 'c':
ret |= PTYPECRTEXT; /* CR indicates Internet text */
break;
case 'e': /* ESC */
if (*s == '$') { /* ISO-2022 sequence? */
if (s[1] == 'B' || s[1] == '@') ret |= PTYPEISO2022JP;
else if (s[1] == ')' && s[2] == 'C') ret |= PTYPEISO2022JP;
}
break;
case 'l': /* newline */
(*j)++;
break;
}
return ret; /* return type of data */
}
/* File close
* Accepts: MAIL stream
* close options
*/
void phile_close (MAILSTREAM *stream,long options)
{
if (LOCAL) { /* only if a file is open */
/* free local texts */
if (LOCAL->buf) fs_give ((void **) &LOCAL->buf);
/* nuke the local data */
fs_give ((void **) &stream->local);
stream->dtb = NIL; /* log out the DTB */
}
}
/* File fetch fast information
* Accepts: MAIL stream
* sequence
* option flags
*/
void phile_fetchfast (MAILSTREAM *stream,char *sequence,long flags)
{
return; /* no-op for local mail */
}
/* File fetch flags
* Accepts: MAIL stream
* sequence
* option flags
*/
void phile_fetchflags (MAILSTREAM *stream,char *sequence,long flags)
{
return; /* no-op for local mail */
}
/* File fetch structure
* Accepts: MAIL stream
* message # to fetch
* pointer to return body
* option flags
* Returns: envelope of this message, body returned in body value
*
* Fetches the "fast" information as well
*/
ENVELOPE *phile_fetchstructure (MAILSTREAM *stream,unsigned long msgno,
BODY **body,long flags)
{
if (body) *body = LOCAL->body;
return LOCAL->env; /* return the envelope */
}
/* File fetch message header
* Accepts: MAIL stream
* message # to fetch
* list of headers to fetch
* pointer to returned header text length
* option flags
* Returns: message header in RFC822 format
*/
char *phile_fetchheader (MAILSTREAM *stream,unsigned long msgno,
STRINGLIST *lines,unsigned long *len,long flags)
{
unsigned long i;
BODY *body;
ENVELOPE *env = phile_fetchstructure (stream,msgno,&body,NIL);
rfc822_header (LOCAL->tmp,env,body);
i = strlen (LOCAL->tmp); /* sigh */
if (lines) i = mail_filter (LOCAL->tmp,i,lines,flags);
if (len) *len = i;
return LOCAL->tmp;
}
/* File fetch message text (body only)
* Accepts: MAIL stream
* message # to fetch
* Returns: message text in RFC822 format
*/
char *phile_fetchtext (MAILSTREAM *stream,unsigned long msgno,
unsigned long *len,long flags)
{
/* mark message as seen */
if (!(flags &FT_PEEK)) mail_elt (stream,msgno)->seen = T;
if (len) *len = LOCAL->body->size.bytes;
return LOCAL->buf;
}
/* File fetch message body as a structure
* Accepts: Mail stream
* message # to fetch
* section specifier
* pointer to length
* Returns: pointer to section of message body
*/
char *phile_fetchbody (MAILSTREAM *stream,unsigned long msgno,char *sec,
unsigned long *len,long flags)
{
/* BODY[0] case? */
if (!strcmp (sec,"0")) return phile_fetchheader (stream,msgno,NIL,len,flags);
else if (strcmp (sec,"1")) return phile_fetchtext (stream,msgno,len,flags);
return NIL;
}
/* File set flag
* Accepts: MAIL stream
* sequence
* flag(s)
*/
void phile_setflag (MAILSTREAM *stream,char *sequence,char *flag,long flags)
{
MESSAGECACHE *elt;
unsigned long i;
long f = mail_parse_flags (stream,flag,&i);
if (!f) return; /* no-op if no flags to modify */
/* get sequence and loop on it */
if (mail_sequence (stream,sequence)) for (i = 1; i <= stream->nmsgs; i++)
if ((elt = mail_elt (stream,i))->sequence) {
/* set all requested flags */
if (f&fSEEN) elt->seen = T;
if (f&fDELETED) elt->deleted = T;
if (f&fFLAGGED) elt->flagged = T;
if (f&fANSWERED) elt->answered = T;
if (f&fDRAFT) elt->draft = T;
}
}
/* File clear flag
* Accepts: MAIL stream
* sequence
* flag(s)
*/
void phile_clearflag (MAILSTREAM *stream,char *sequence,char *flag,long flags)
{
MESSAGECACHE *elt;
unsigned long i;
long f = mail_parse_flags (stream,flag,&i);
if (!f) return; /* no-op if no flags to modify */
/* get sequence and loop on it */
if (mail_sequence (stream,sequence)) for (i = 1; i <= stream->nmsgs; i++)
if ((elt = mail_elt (stream,i))->sequence) {
/* clear all requested flags */
if (f&fSEEN) elt->seen = NIL;
if (f&fDELETED) elt->deleted = NIL;
if (f&fFLAGGED) elt->flagged = NIL;
if (f&fANSWERED) elt->answered = NIL;
if (f&fDRAFT) elt->draft = T;
}
}
/* File ping mailbox
* Accepts: MAIL stream
* Returns: T if stream alive, else NIL
* No-op for readonly files, since read/writer can expunge it from under us!
*/
long phile_ping (MAILSTREAM *stream)
{
return T;
}
/* File check mailbox
* Accepts: MAIL stream
* No-op for readonly files, since read/writer can expunge it from under us!
*/
void phile_check (MAILSTREAM *stream)
{
mm_log ("Check completed",NIL);
}
/* File expunge mailbox
* Accepts: MAIL stream
*/
void phile_expunge (MAILSTREAM *stream)
{
mm_log ("Expunge ignored on readonly mailbox",NIL);
}
/* File copy message(s)
* Accepts: MAIL stream
* sequence
* destination mailbox
* copy options
* Returns: T if copy successful, else NIL
*/
long phile_copy (MAILSTREAM *stream,char *sequence,char *mailbox,long options)
{
char tmp[MAILTMPLEN];
sprintf (tmp,"Can't copy - file \"%s\" is not in valid mailbox format",
stream->mailbox);
mm_log (tmp,ERROR);
return NIL;
}
/* File append message from stringstruct
* Accepts: MAIL stream
* destination mailbox
* stringstruct of messages to append
* Returns: T if append successful, else NIL
*/
long phile_append (MAILSTREAM *stream,char *mailbox,char *flags,char *date,
STRING *message)
{
char tmp[MAILTMPLEN],file[MAILTMPLEN];
sprintf (tmp,"Can't append - file \"%s\" is not in valid mailbox format",
mailboxfile (file,mailbox));
mm_log (tmp,ERROR);
return NIL;
}
/* File garbage collect stream
* Accepts: Mail stream
* garbage collection flags
*/
void phile_gc (MAILSTREAM *stream,long gcflags)
{
/* nothing here for now */
}
syntax highlighted by Code2HTML, v. 0.9.1