Pileus Git - ~andy/fetchmail/blob - uid.c

   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
   7 #include <config.h>
   8
   9 #include <stdio.h>
  10
  11 #if defined(STDC_HEADERS)
  12 #include <stdlib.h>
  13 #include <string.h>
  14 #endif
  15
  16 #if defined(HAVE_UNISTD_H)
  17 #include <unistd.h>
  18 #endif
  19
  20 #include "fetchmail.h"
  21
  22 /*
  23  * Machinery for handling UID lists live here.  This is mainly to support
  24  * RFC1725-conformant POP3 servers without a LAST command, but may also be
  25  * useful for making the IMAP4 querying logic UID-oriented, if a future
  26  * revision of IMAP forces me to.  (This would be bad.  Server-side
  27  * seen bits are better than UIDs, because they track messages seen by
  28  * *all* clients.)
  29  *
  30  * Here's the theory:
  31  *
  32  * At start of a query, we have a (possibly empty) list of UIDs to be
  33  * considered seen in `oldsaved'.  These are messages that were left in
  34  * the mailbox and *not deleted* on previous queries (we don't need to
  35  * remember the UIDs of deleted messages because ... well, they're gone!)
  36  * This list is initially set up by initialized_saved_list() from the
  37  * .fetchids file.
  38  *
  39  * Early in the query, during the execution of the protocol-specific
  40  * getrange code, the driver expects that the host's `newsaved' member
  41  * will be filled with a list of UIDs and message numbers representing
  42  * the mailbox state.  If this list is empty, the server did
  43  * not respond to the request for a UID listing.
  44  *
  45  * Each time a message is fetched, we can check its UID against the
  46  * `oldsaved' list to see if it is old.  If not, it should be downloaded
  47  * (and possibly deleted).  It should be downloaded anyway if --all
  48  * is on.  It should not be deleted if --keep is on.
  49  *
  50  * Each time a message is deleted, we remove its id from the `newsaved'
  51  * member.
  52  *
  53  * At the end of the query, whatever remains in the `newsaved' member
  54  * (because it was not deleted) becomes the `oldsaved' list.  The old
  55  * `oldsaved' list is freed.
  56  *
  57  * At the end of the fetchmail run, all current `oldsaved' lists are
  58  * flushed out to the .fetchids file to be picked up by the next run.
  59  * If there are no such messages, the file is deleted.
  60  */
  61
  62 /* UIDs associated with un-queried hosts */
  63 static struct idlist *scratchlist;
  64
  65 void initialize_saved_lists(struct query *hostlist, char *idfile)
  66 /* read file of saved IDs and attach to each host */
  67 {
  68     int st;
  69     FILE        *tmpfp;
  70     struct query *hostp;
  71
  72     /* make sure lists are initially empty */
  73     for (hostp = hostlist; hostp; hostp = hostp->next)
  74         hostp->oldsaved = hostp->newsaved = (struct idlist *)NULL;
  75
  76     /* let's get stored message UIDs from previous queries */
  77     if ((tmpfp = fopen(idfile, "r")) != (FILE *)NULL) {
  78         char buf[POPBUFSIZE+1], host[HOSTLEN+1], id[IDLEN+1];
  79
  80         while (fgets(buf, POPBUFSIZE, tmpfp) != (char *)NULL)
  81         {
  82             if ((st = sscanf(buf, "%s %s\n", host, id)) == 2)
  83             {
  84                 for (hostp = hostlist; hostp; hostp = hostp->next)
  85                 {
  86                     if (strcmp(host, hostp->servername) == 0)
  87                     {
  88                         save_uid(&hostp->oldsaved, -1, id);
  89                         break;
  90                     }
  91                 }
  92
  93                 /* if it's not in a host we're querying, save it anyway */
  94                 if (hostp == (struct query *)NULL)
  95                     save_uid(&scratchlist, -1, buf);
  96             }
  97         }
  98         fclose(tmpfp);
  99     }
 100 }
 101
 102 void save_uid(struct idlist **idl, int num, char *str)
 103 /* save a number/UID pair on the given UID list */
 104 {
 105     struct idlist *new;
 106
 107     new = (struct idlist *)xmalloc(sizeof(struct idlist));
 108     new->val.num = num;
 109     new->id = xstrdup(str);
 110     new->next = *idl;
 111     *idl = new;
 112 }
 113
 114 void free_uid_list(struct idlist **idl)
 115 /* free the given UID list */
 116 {
 117     if (*idl == (struct idlist *)NULL)
 118         return;
 119
 120     free_uid_list(&(*idl)->next);
 121     free ((*idl)->id);
 122     free(*idl);
 123     *idl = (struct idlist *)NULL;
 124 }
 125
 126 void save_id_pair(struct idlist **idl, char *str1, char *str2)
 127 /* save an ID pair on the given list */
 128 {
 129     struct idlist *new;
 130
 131     new = (struct idlist *)xmalloc(sizeof(struct idlist));
 132     new->id = xstrdup(str1);
 133     if (str2)
 134         new->val.id2 = xstrdup(str2);
 135     else
 136         new->val.id2 = (char *)NULL;
 137     new->next = *idl;
 138     *idl = new;
 139 }
 140
 141 #ifdef __UNUSED__
 142 void free_idpair_list(struct idlist **idl)
 143 /* free the given ID pair list */
 144 {
 145     if (*idl == (struct idlist *)NULL)
 146         return;
 147
 148     free_idpair_list(&(*idl)->next);
 149     free ((*idl)->id);
 150     free ((*idl)->val.id2);
 151     free(*idl);
 152     *idl = (struct idlist *)NULL;
 153 }
 154 #endif
 155
 156 int uid_in_list(struct idlist **idl, char *str)
 157 /* is a given ID in the given list? */
 158 {
 159     if (*idl == (struct idlist *)NULL || str == (char *) NULL)
 160         return(0);
 161     else if (strcmp(str, (*idl)->id) == 0)
 162         return(1);
 163     else
 164         return(uid_in_list(&(*idl)->next, str));
 165 }
 166
 167 char *uid_find(struct idlist **idl, int number)
 168 /* return the id of the given number in the given list. */
 169 {
 170     if (*idl == (struct idlist *) 0)
 171         return((char *) 0);
 172     else if (number == (*idl)->val.num)
 173         return((*idl)->id);
 174     else
 175         return(uid_find(&(*idl)->next, number));
 176 }
 177
 178 char *idpair_find(struct idlist **idl, char *id)
 179 /* return the id of the given number in the given list. */
 180 {
 181     if (*idl == (struct idlist *) 0)
 182         return((char *) 0);
 183     else if (strcmp(id, (*idl)->id) == 0)
 184         return((*idl)->val.id2 ? (*idl)->val.id2 : (*idl)->id);
 185     else
 186         return(idpair_find(&(*idl)->next, id));
 187 }
 188
 189 int delete_uid(struct idlist **idl, int num)
 190 /* delete given message from given list */
 191 {
 192     if (*idl == (struct idlist *)NULL)
 193         return(0);
 194     else if ((*idl)->val.num == num)
 195     {
 196         struct idlist   *next = (*idl)->next;
 197
 198         free ((*idl)->id);
 199         free(*idl);
 200         *idl = next;
 201         return(1);
 202     }
 203     else
 204         return(delete_uid(&(*idl)->next, num));
 205     return(0);
 206 }
 207
 208 void append_uid_list(struct idlist **idl, struct idlist **nidl)
 209 /* append nidl to idl (does not copy *) */
 210 {
 211     if ((*idl) == (struct idlist *)NULL)
 212         *idl = *nidl;
 213     else if ((*idl)->next == (struct idlist *)NULL)
 214         (*idl)->next = *nidl;
 215     else
 216         append_uid_list(&(*idl)->next, nidl);
 217 }
 218
 219 void update_uid_lists(struct query *hostp)
 220 /* perform end-of-query actions on UID lists */
 221 {
 222     free_uid_list(&hostp->oldsaved);
 223     hostp->oldsaved = hostp->newsaved;
 224     hostp->newsaved = (struct idlist *) NULL;
 225 }
 226
 227 void write_saved_lists(struct query *hostlist, char *idfile)
 228 /* perform end-of-run write of seen-messages list */
 229 {
 230     int         idcount;
 231     FILE        *tmpfp;
 232     struct query *hostp;
 233     struct idlist *idp;
 234
 235     /* if all lists are empty, nuke the file */
 236     idcount = 0;
 237     for (hostp = hostlist; hostp; hostp = hostp->next) {
 238         if (hostp->oldsaved)
 239             idcount++;
 240     }
 241
 242     /* either nuke the file or write updated last-seen IDs */
 243     if (!idcount)
 244         unlink(idfile);
 245     else
 246         if ((tmpfp = fopen(idfile, "w")) != (FILE *)NULL) {
 247             for (hostp = hostlist; hostp; hostp = hostp->next) {
 248                 for (idp = hostp->oldsaved; idp; idp = idp->next)
 249                     fprintf(tmpfp, "%s %s\n", hostp->servername, idp->id);
 250             }
 251             for (idp = scratchlist; idp; idp = idp->next)
 252                 fputs(idp->id, tmpfp);
 253             fclose(tmpfp);
 254         }
 255 }
 256
 257 /* uid.c ends here */