uid.c
上传用户:xxcykj
上传日期:2007-01-04
资源大小:727k
文件大小:13k
源码类别:

Email客户端

开发平台:

Unix_Linux

  1. /*
  2.  * uid.c -- UIDL handling for POP3 servers without LAST
  3.  *
  4.  * For license terms, see the file COPYING in this directory.
  5.  */
  6. #include "config.h"
  7. #include <sys/stat.h>
  8. #include <errno.h>
  9. #include <stdio.h>
  10. #include <limits.h>
  11. #if defined(STDC_HEADERS)
  12. #include <stdlib.h>
  13. #include <string.h>
  14. #endif
  15. #if defined(HAVE_UNISTD_H)
  16. #include <unistd.h>
  17. #endif
  18. #include "fetchmail.h"
  19. /*
  20.  * Machinery for handling UID lists live here.  This is mainly to support
  21.  * RFC1725-conformant POP3 servers without a LAST command, but may also be
  22.  * useful for making the IMAP4 querying logic UID-oriented, if a future
  23.  * revision of IMAP forces me to.
  24.  *
  25.  * These functions are also used by the rest of the code to maintain
  26.  * string lists.
  27.  *
  28.  * Here's the theory:
  29.  *
  30.  * At start of a query, we have a (possibly empty) list of UIDs to be
  31.  * considered seen in `oldsaved'.  These are messages that were left in
  32.  * the mailbox and *not deleted* on previous queries (we don't need to
  33.  * remember the UIDs of deleted messages because ... well, they're gone!)
  34.  * This list is initially set up by initialize_saved_list() from the
  35.  * .fetchids file.
  36.  *
  37.  * Early in the query, during the execution of the protocol-specific 
  38.  * getrange code, the driver expects that the host's `newsaved' member
  39.  * will be filled with a list of UIDs and message numbers representing
  40.  * the mailbox state.  If this list is empty, the server did
  41.  * not respond to the request for a UID listing.
  42.  *
  43.  * Each time a message is fetched, we can check its UID against the
  44.  * `oldsaved' list to see if it is old.
  45.  *
  46.  * Each time a message-id is seen, we mark it with MARK_SEEN.
  47.  *
  48.  * Each time a message is deleted, we mark its id UID_DELETED in the
  49.  * `newsaved' member.  When we want to assert that an expunge has been
  50.  * done on the server, we call expunge_uid() to register that all
  51.  * deleted messages are gone by marking them UID_EXPUNGED.
  52.  *
  53.  * At the end of the query, the `newsaved' member becomes the
  54.  * `oldsaved' list.  The old `oldsaved' list is freed.
  55.  *
  56.  * At the end of the fetchmail run, seen and non-EXPUNGED members of all
  57.  * current `oldsaved' lists are flushed out to the .fetchids file to
  58.  * be picked up by the next run.  If there are no un-expunged
  59.  * messages, the file is deleted.
  60.  *
  61.  * Note: some comparisons (those used for DNS address lists) are caseblind!  
  62.  */
  63. /* UIDs associated with un-queried hosts */
  64. static struct idlist *scratchlist;
  65. #ifdef POP3_ENABLE
  66. void initialize_saved_lists(struct query *hostlist, const char *idfile)
  67. /* read file of saved IDs and attach to each host */
  68. {
  69.     struct stat statbuf;
  70.     FILE *tmpfp;
  71.     struct query *ctl;
  72.     /* make sure lists are initially empty */
  73.     for (ctl = hostlist; ctl; ctl = ctl->next)
  74. ctl->skipped = ctl->oldsaved = ctl->newsaved = (struct idlist *)NULL;
  75.     errno = 0;
  76.     /*
  77.      * Croak if the uidl directory does not exist.
  78.      * This probably means an NFS mount failed and we can't
  79.      * see a uidl file that ought to be there.
  80.      * Question: is this a portable check? It's not clear
  81.      * that all implementations of lstat() will return ENOTDIR
  82.      * rather than plain ENOENT in this case...
  83.      */
  84.    if (lstat(idfile, &statbuf) < 0) {
  85.      if (errno == ENOTDIR) 
  86.     {
  87.       report(stderr, "lstat: %s: %sn", idfile, strerror(errno));
  88.       exit(PS_IOERR);
  89.     }
  90.    }
  91.     /* let's get stored message UIDs from previous queries */
  92.     if ((tmpfp = fopen(idfile, "r")) != (FILE *)NULL)
  93.     {
  94. char buf[POPBUFSIZE+1];
  95. char *host = NULL; /* pacify -Wall */
  96. char *user;
  97. char *id;
  98. char *atsign; /* temp pointer used in parsing user and host */
  99. char *delimp1;
  100. char saveddelim1;
  101. char *delimp2;
  102. char saveddelim2 = ''; /* pacify -Wall */
  103. while (fgets(buf, POPBUFSIZE, tmpfp) != (char *)NULL)
  104. {
  105.     /*
  106.      * At this point, we assume the bug has two fields -- a user@host 
  107.      * part, and an ID part. Either field may contain spurious @ signs.
  108.      * The previous version of this code presumed one could split at 
  109.      * the rightmost '@'.  This is not correct, as InterMail puts an 
  110.      * '@' in the UIDL.
  111.      */
  112.   
  113.     /* first, skip leading spaces */
  114.     user = buf + strspn(buf, " t");
  115.     /* First, we split the buf into a userhost part and an id part */
  116.     if ((id = strchr(user, '<')) != NULL )  /* set pointer to id */
  117.     {
  118.         for (delimp1 = id; delimp1 >= user; delimp1--)
  119.     if ((*delimp1 != ' ') && (*delimp1 != 't'))
  120. break;
  121. delimp1++; /* but what if there is only white space ?!? */
  122.    saveddelim1 = *delimp1; /* save char after token */
  123. *delimp1 = ''; /* delimit token with  */
  124. if (id != NULL) 
  125. {
  126.     /* now remove trailing white space chars from id */
  127.     if ((delimp2 = strpbrk(id, " tn")) != NULL ) {
  128. saveddelim2 = *delimp2;
  129. *delimp2 = '';
  130.     }
  131.     atsign = strrchr(user, '@');
  132.     if (atsign) {
  133. *atsign = '';
  134. host = atsign + 1;
  135.     }
  136.     for (ctl = hostlist; ctl; ctl = ctl->next) {
  137. if (ctl->server.truename &&
  138.     strcasecmp(host, ctl->server.truename) == 0
  139.     && strcasecmp(user, ctl->remotename) == 0) {
  140.     save_str(&ctl->oldsaved, id, UID_SEEN);
  141.     break;
  142. }
  143.     }
  144.     /* if it's not in a host we're querying,
  145.     ** save it anyway */
  146.     if (ctl == (struct query *)NULL) {
  147. /* restore string */
  148. *delimp1 = saveddelim1;
  149. *atsign = '@';
  150. if (delimp2 != NULL) {
  151.     *delimp2 = saveddelim2;
  152. }
  153. save_str(&scratchlist, buf, UID_SEEN);
  154.     }
  155. }
  156.     }
  157. }
  158. fclose(tmpfp); /* not checking should be safe, mode was "r" */
  159.     }
  160.     if (outlevel >= O_DEBUG)
  161.     {
  162. struct idlist *idp;
  163. int uidlcount = 0;
  164. for (ctl = hostlist; ctl; ctl = ctl->next)
  165.     if (ctl->server.uidl)
  166.     {
  167. report_build(stdout, "Old UID list from %s:",ctl->server.pollname);
  168. for (idp = ctl->oldsaved; idp; idp = idp->next)
  169.     report_build(stdout, " %s", idp->id);
  170. if (!idp)
  171.     report_build(stdout, " <empty>");
  172. report_complete(stdout, "n");
  173. uidlcount++;
  174.     }
  175. if (uidlcount)
  176. {
  177.     report_build(stdout, "Scratch list of UIDs:");
  178.     for (idp = scratchlist; idp; idp = idp->next)
  179. report_build(stdout, " %s", idp->id);
  180.     if (!idp)
  181. report_build(stdout, " <empty>");
  182.     report_complete(stdout, "n");
  183. }
  184.     }
  185. }
  186. #endif /* POP3_ENABLE */
  187. struct idlist *save_str(struct idlist **idl, const char *str, flag status)
  188. /* save a number/UID pair on the given UID list */
  189. {
  190.     struct idlist **end;
  191.     /* do it nonrecursively so the list is in the right order */
  192.     for (end = idl; *end; end = &(*end)->next)
  193. continue;
  194.     *end = (struct idlist *)xmalloc(sizeof(struct idlist));
  195.     (*end)->val.status.mark = status;
  196.     (*end)->id = str ? xstrdup(str) : (char *)NULL;
  197.     (*end)->next = NULL;
  198.     return(*end);
  199. }
  200. void free_str_list(struct idlist **idl)
  201. /* free the given UID list */
  202. {
  203.     if (*idl == (struct idlist *)NULL)
  204. return;
  205.     free_str_list(&(*idl)->next);
  206.     free ((*idl)->id);
  207.     free(*idl);
  208.     *idl = (struct idlist *)NULL;
  209. }
  210. void save_str_pair(struct idlist **idl, const char *str1, const char *str2)
  211. /* save an ID pair on the given list */
  212. {
  213.     struct idlist **end;
  214.     /* do it nonrecursively so the list is in the right order */
  215.     for (end = idl; *end; end = &(*end)->next)
  216. continue;
  217.     *end = (struct idlist *)xmalloc(sizeof(struct idlist));
  218.     (*end)->id = str1 ? xstrdup(str1) : (char *)NULL;
  219.     if (str2)
  220. (*end)->val.id2 = xstrdup(str2);
  221.     else
  222. (*end)->val.id2 = (char *)NULL;
  223.     (*end)->next = (struct idlist *)NULL;
  224. }
  225. #ifdef __UNUSED__
  226. void free_str_pair_list(struct idlist **idl)
  227. /* free the given ID pair list */
  228. {
  229.     if (*idl == (struct idlist *)NULL)
  230. return;
  231.     free_idpair_list(&(*idl)->next);
  232.     free ((*idl)->id);
  233.     free ((*idl)->val.id2);
  234.     free(*idl);
  235.     *idl = (struct idlist *)NULL;
  236. }
  237. #endif
  238. int str_in_list(struct idlist **idl, const char *str, const flag caseblind)
  239. /* is a given ID in the given list? (comparison may be caseblind) */
  240. {
  241.     if (*idl == (struct idlist *)NULL || str == (char *) NULL)
  242. return(0);
  243.     else if (!caseblind && strcmp(str, (*idl)->id) == 0)
  244. return(1);
  245.     else if (caseblind && strcasecmp(str, (*idl)->id) == 0)
  246. return(1);
  247.     else
  248. return(str_in_list(&(*idl)->next, str, caseblind));
  249. }
  250. int str_nr_in_list( struct idlist **idl, const char *str )
  251.   /* return the position of str in idl */
  252. {
  253.     int nr;
  254.     struct idlist *walk;
  255.     if ( !str )
  256.         return -1;
  257.     for( walk = *idl, nr = 0; walk; nr ++, walk = walk->next )
  258.         if( strcmp( str, walk->id) == 0 )
  259.     return nr;
  260.     return -1;
  261. }
  262. int str_nr_last_in_list( struct idlist **idl, const char *str)
  263. /* return the last position of str in idl */
  264. {
  265.     int nr, ret = -1;
  266.     struct idlist *walk;
  267.     if ( !str )
  268.         return -1;
  269.     for( walk = *idl, nr = 0; walk; nr ++, walk = walk->next )
  270.         if( strcmp( str, walk->id) == 0 )
  271.     ret = nr;
  272.     return ret;
  273. }
  274. void str_set_mark( struct idlist **idl, const char *str, const flag val)
  275. /* update the mark on an of an id to given value */
  276. {
  277.     int nr;
  278.     struct idlist *walk;
  279.     if (!str)
  280.         return;
  281.     for(walk = *idl, nr = 0; walk; nr ++, walk = walk->next)
  282.         if (strcmp(str, walk->id) == 0)
  283.     walk->val.status.mark = val;
  284. }
  285. int count_list( struct idlist **idl)
  286. /* count the number of elements in the list */
  287. {
  288.   if( !*idl )
  289.     return 0;
  290.   return 1 + count_list( &(*idl)->next );
  291. }
  292. char *str_from_nr_list(struct idlist **idl, int number)
  293. /* return the number'th string in idl */
  294. {
  295.     if( !*idl  || number < 0)
  296.         return 0;
  297.     if( number == 0 )
  298.         return (*idl)->id;
  299.     return str_from_nr_list(&(*idl)->next, number-1);
  300. }
  301.     
  302. char *str_find(struct idlist **idl, int number)
  303. /* return the id of the given number in the given list. */
  304. {
  305.     if (*idl == (struct idlist *) 0)
  306. return((char *) 0);
  307.     else if (number == (*idl)->val.status.num)
  308. return((*idl)->id);
  309.     else
  310. return(str_find(&(*idl)->next, number));
  311. }
  312. char *idpair_find(struct idlist **idl, const char *id)
  313. /* return the id of the given id in the given list (caseblind comparison) */
  314. {
  315.     if (*idl == (struct idlist *) 0)
  316. return((char *) 0);
  317.     else if (strcasecmp(id, (*idl)->id) == 0)
  318. return((*idl)->val.id2 ? (*idl)->val.id2 : (*idl)->id);
  319.     else
  320. return(idpair_find(&(*idl)->next, id));
  321. }
  322. int delete_str(struct idlist **idl, int num)
  323. /* delete given message from given list */
  324. {
  325.     struct idlist *idp;
  326.     for (idp = *idl; idp; idp = idp->next)
  327. if (idp->val.status.num == num)
  328. {
  329.     idp->val.status.mark = UID_DELETED;
  330.     return(1);
  331. }
  332.     return(0);
  333. }
  334. void append_str_list(struct idlist **idl, struct idlist **nidl)
  335. /* append nidl to idl (does not copy *) */
  336. {
  337.     if ((*nidl) == (struct idlist *)NULL || *nidl == *idl)
  338. return;
  339.     else if ((*idl) == (struct idlist *)NULL)
  340. *idl = *nidl;
  341.     else if ((*idl)->next == (struct idlist *)NULL)
  342. (*idl)->next = *nidl;
  343.     else if ((*idl)->next != *nidl)
  344. append_str_list(&(*idl)->next, nidl);
  345. }
  346. #ifdef POP3_ENABLE
  347. void expunge_uids(struct query *ctl)
  348. /* assert that all UIDs marked deleted have actually been expunged */
  349. {
  350.     struct idlist *idl;
  351.     for (idl = ctl->newsaved; idl; idl = idl->next)
  352. if (idl->val.status.mark == UID_DELETED)
  353.     idl->val.status.mark = UID_EXPUNGED;
  354. }
  355. void uid_end_query(struct query *ctl) 
  356. /* finish a query */
  357. {
  358.     /* old state of mailbox is now irrelevant */
  359.     free_str_list(&ctl->oldsaved);
  360.     free_str_list(&scratchlist);
  361.     ctl->oldsaved = ctl->newsaved;
  362.     ctl->newsaved = (struct idlist *) NULL;
  363.     /* debugging code */
  364.     if (ctl->server.uidl && outlevel >= O_DEBUG)
  365.     {
  366. struct idlist *idp;
  367. report_build(stdout, "New UID list from %s:", ctl->server.pollname);
  368. for (idp = ctl->oldsaved; idp; idp = idp->next)
  369.     report_build(stdout, " %s = %d", idp->id, idp->val.status.mark);
  370. if (!idp)
  371.     report_build(stdout, " <empty>");
  372. report_complete(stdout, "n");
  373.     }
  374. }
  375. void write_saved_lists(struct query *hostlist, const char *idfile)
  376. /* perform end-of-run write of seen-messages list */
  377. {
  378.     int idcount;
  379.     FILE *tmpfp;
  380.     struct query *ctl;
  381.     struct idlist *idp;
  382.     /* if all lists are empty, nuke the file */
  383.     idcount = 0;
  384.     for (ctl = hostlist; ctl; ctl = ctl->next) {
  385. if (ctl->oldsaved)
  386.     idcount++;
  387.     }
  388.     /* either nuke the file or write updated last-seen IDs */
  389.     if (!idcount && !scratchlist)
  390.     {
  391. if (outlevel >= O_DEBUG)
  392.     report(stdout, "Deleting fetchids file.n");
  393. unlink(idfile);
  394.     }
  395.     else
  396. if ((tmpfp = fopen(idfile, "w")) != (FILE *)NULL) {
  397.     for (ctl = hostlist; ctl; ctl = ctl->next) {
  398. for (idp = ctl->oldsaved; idp; idp = idp->next)
  399.     if (idp->val.status.mark == UID_SEEN
  400. || idp->val.status.mark == UID_DELETED)
  401. fprintf(tmpfp, "%s@%s %sn", 
  402.     ctl->remotename, ctl->server.truename, idp->id);
  403.     }
  404.     for (idp = scratchlist; idp; idp = idp->next)
  405. fputs(idp->id, tmpfp);
  406.     fclose(tmpfp);
  407. }
  408. }
  409. #endif /* POP3_ENABLE */
  410. /* uid.c ends here */