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 #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
  19 #include "fetchmail.h"
  20
  21 /*
  22  * Machinery for handling UID lists live here.  This is mainly to support
  23  * RFC1725-conformant POP3 servers without a LAST command, but may also be
  24  * useful for making the IMAP4 querying logic UID-oriented, if a future
  25  * revision of IMAP forces me to.
  26  *
  27  * These functions are also used by the rest of the code to maintain
  28  * string lists.
  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.
  47  *
  48  * Each time a message-id is seen, we mark it with MARK_SEEN.
  49  *
  50  * Each time a message is deleted, we mark its id UID_DELETED in the
  51  * `newsaved' member.  When we want to assert that an expunge has been
  52  * done on the server, we call expunge_uid() to register that all
  53  * deleted messages are gone by marking them UID_EXPUNGED.
  54  *
  55  * At the end of the query, the `newsaved' member becomes the
  56  * `oldsaved' list.  The old `oldsaved' list is freed.
  57  *
  58  * At the end of the fetchmail run, seen and non-EXPUNGED members of all
  59  * current `oldsaved' lists are flushed out to the .fetchids file to
  60  * be picked up by the next run.  If there are no un-expunged
  61  * messages, the file is deleted.
  62  *
  63  * Note: all comparisons are caseblind!
  64  */
  65
  66 /* UIDs associated with un-queried hosts */
  67 static struct idlist *scratchlist;
  68
  69 #ifdef POP3_ENABLE
  70 void initialize_saved_lists(struct query *hostlist, const char *idfile)
  71 /* read file of saved IDs and attach to each host */
  72 {
  73     int st;
  74     FILE        *tmpfp;
  75     struct query *ctl;
  76
  77     /* make sure lists are initially empty */
  78     for (ctl = hostlist; ctl; ctl = ctl->next)
  79         ctl->oldsaved = ctl->newsaved = (struct idlist *)NULL;
  80
  81     /* let's get stored message UIDs from previous queries */
  82     if ((tmpfp = fopen(idfile, "r")) != (FILE *)NULL) {
  83         char buf[POPBUFSIZE+1],host[HOSTLEN+1],user[USERNAMELEN+1],id[IDLEN+1];
  84
  85         while (fgets(buf, POPBUFSIZE, tmpfp) != (char *)NULL)
  86         {
  87             /* possible lossage here with very old versions of sscanf(3)... */
  88             if ((st = sscanf(buf, "%[^@]@%s %s\n", user, host, id)) == 3)
  89             {
  90                 for (ctl = hostlist; ctl; ctl = ctl->next)
  91                 {
  92                     if (ctl->server.truename &&
  93                         strcasecmp(host, ctl->server.truename) == 0
  94                                 && strcasecmp(user, ctl->remotename) == 0)
  95                     {
  96                         save_str(&ctl->oldsaved, id, UID_SEEN);
  97                         break;
  98                     }
  99                 }
 100
 101                 /* if it's not in a host we're querying, save it anyway */
 102                 if (ctl == (struct query *)NULL)
 103                     save_str(&scratchlist, buf, UID_SEEN);
 104             }
 105         }
 106         fclose(tmpfp);
 107     }
 108 }
 109 #endif /* POP3_ENABLE */
 110
 111 struct idlist *save_str(struct idlist **idl, const char *str, flag status)
 112 /* save a number/UID pair on the given UID list */
 113 {
 114     struct idlist **end;
 115
 116     /* do it nonrecursively so the list is in the right order */
 117     for (end = idl; *end; end = &(*end)->next)
 118         continue;
 119
 120     *end = (struct idlist *)xmalloc(sizeof(struct idlist));
 121     (*end)->val.status.mark = status;
 122     (*end)->id = str ? xstrdup(str) : (char *)NULL;
 123     (*end)->next = NULL;
 124
 125     return(*end);
 126 }
 127
 128 void free_str_list(struct idlist **idl)
 129 /* free the given UID list */
 130 {
 131     if (*idl == (struct idlist *)NULL)
 132         return;
 133
 134     free_str_list(&(*idl)->next);
 135     free ((*idl)->id);
 136     free(*idl);
 137     *idl = (struct idlist *)NULL;
 138 }
 139
 140 void save_str_pair(struct idlist **idl, const char *str1, const char *str2)
 141 /* save an ID pair on the given list */
 142 {
 143     struct idlist **end;
 144
 145     /* do it nonrecursively so the list is in the right order */
 146     for (end = idl; *end; end = &(*end)->next)
 147         continue;
 148
 149     *end = (struct idlist *)xmalloc(sizeof(struct idlist));
 150     (*end)->id = str1 ? xstrdup(str1) : (char *)NULL;
 151     if (str2)
 152         (*end)->val.id2 = xstrdup(str2);
 153     else
 154         (*end)->val.id2 = (char *)NULL;
 155     (*end)->next = (struct idlist *)NULL;
 156 }
 157
 158 #ifdef __UNUSED__
 159 void free_str_pair_list(struct idlist **idl)
 160 /* free the given ID pair list */
 161 {
 162     if (*idl == (struct idlist *)NULL)
 163         return;
 164
 165     free_idpair_list(&(*idl)->next);
 166     free ((*idl)->id);
 167     free ((*idl)->val.id2);
 168     free(*idl);
 169     *idl = (struct idlist *)NULL;
 170 }
 171 #endif
 172
 173 int str_in_list(struct idlist **idl, const char *str)
 174 /* is a given ID in the given list? (comparison is caseblind) */
 175 {
 176     if (*idl == (struct idlist *)NULL || str == (char *) NULL)
 177         return(0);
 178     else if (strcasecmp(str, (*idl)->id) == 0)
 179         return(1);
 180     else
 181         return(str_in_list(&(*idl)->next, str));
 182 }
 183
 184 int str_nr_in_list( struct idlist **idl, const char *str )
 185   /* return the position of str in idl */
 186 {
 187     int nr;
 188     struct idlist *walk;
 189     if ( !str )
 190         return -1;
 191     for( walk = *idl, nr = 0; walk; nr ++, walk = walk->next )
 192         if( strcasecmp( str, walk->id) == 0 )
 193             return nr;
 194     return -1;
 195 }
 196
 197 int str_nr_last_in_list( struct idlist **idl, const char *str)
 198 /* return the last position of str in idl */
 199 {
 200     int nr, ret = -1;
 201     struct idlist *walk;
 202     if ( !str )
 203         return -1;
 204     for( walk = *idl, nr = 0; walk; nr ++, walk = walk->next )
 205         if( strcasecmp( str, walk->id) == 0 )
 206             ret = nr;
 207     return ret;
 208 }
 209
 210 int count_list( struct idlist **idl)
 211 /* count the number of elements in the list */
 212 {
 213   if( !*idl )
 214     return 0;
 215   return 1 + count_list( &(*idl)->next );
 216 }
 217
 218 char *str_from_nr_list(struct idlist **idl, int number)
 219 /* return the number'th string in idl */
 220 {
 221     if( !*idl  || number < 0)
 222         return 0;
 223     if( number == 0 )
 224         return (*idl)->id;
 225     return str_from_nr_list(&(*idl)->next, number-1);
 226 }
 227
 228
 229 char *str_find(struct idlist **idl, int number)
 230 /* return the id of the given number in the given list. */
 231 {
 232     if (*idl == (struct idlist *) 0)
 233         return((char *) 0);
 234     else if (number == (*idl)->val.status.num)
 235         return((*idl)->id);
 236     else
 237         return(str_find(&(*idl)->next, number));
 238 }
 239
 240 char *idpair_find(struct idlist **idl, const char *id)
 241 /* return the id of the given id in the given list (caseblind comparison) */
 242 {
 243     if (*idl == (struct idlist *) 0)
 244         return((char *) 0);
 245     else if (strcasecmp(id, (*idl)->id) == 0)
 246         return((*idl)->val.id2 ? (*idl)->val.id2 : (*idl)->id);
 247     else
 248         return(idpair_find(&(*idl)->next, id));
 249 }
 250
 251 int delete_str(struct idlist **idl, int num)
 252 /* delete given message from given list */
 253 {
 254     struct idlist       *idp;
 255
 256     for (idp = *idl; idp; idp = idp->next)
 257         if (idp->val.status.num == num)
 258         {
 259             idp->val.status.mark = UID_DELETED;
 260             return(1);
 261         }
 262     return(0);
 263 }
 264
 265 void append_str_list(struct idlist **idl, struct idlist **nidl)
 266 /* append nidl to idl (does not copy *) */
 267 {
 268     if ((*idl) == (struct idlist *)NULL)
 269         *idl = *nidl;
 270     else if ((*idl)->next == (struct idlist *)NULL)
 271         (*idl)->next = *nidl;
 272     else if ((*idl)->next != *nidl)
 273         append_str_list(&(*idl)->next, nidl);
 274 }
 275
 276 #ifdef POP3_ENABLE
 277 void expunge_uids(struct query *ctl)
 278 /* assert that all UIDs marked deleted have actually been expunged */
 279 {
 280     struct idlist *idl;
 281
 282     for (idl = ctl->newsaved; idl; idl = idl->next)
 283         if (idl->val.status.mark == UID_DELETED)
 284             idl->val.status.mark = UID_EXPUNGED;
 285 }
 286
 287 void update_str_lists(struct query *ctl)
 288 /* perform end-of-query actions on UID lists */
 289 {
 290     free_str_list(&ctl->oldsaved);
 291     ctl->oldsaved = ctl->newsaved;
 292     ctl->newsaved = (struct idlist *) NULL;
 293 }
 294
 295 void write_saved_lists(struct query *hostlist, const char *idfile)
 296 /* perform end-of-run write of seen-messages list */
 297 {
 298     int         idcount;
 299     FILE        *tmpfp;
 300     struct query *ctl;
 301     struct idlist *idp;
 302
 303     /* if all lists are empty, nuke the file */
 304     idcount = 0;
 305     for (ctl = hostlist; ctl; ctl = ctl->next) {
 306         if (ctl->oldsaved)
 307             idcount++;
 308     }
 309
 310     /* either nuke the file or write updated last-seen IDs */
 311     if (!idcount)
 312         unlink(idfile);
 313     else
 314         if ((tmpfp = fopen(idfile, "w")) != (FILE *)NULL) {
 315             for (ctl = hostlist; ctl; ctl = ctl->next) {
 316                 for (idp = ctl->oldsaved; idp; idp = idp->next)
 317                     if (idp->val.status.mark == UID_SEEN
 318                                 || idp->val.status.mark == UID_DELETED)
 319                         fprintf(tmpfp, "%s@%s %s\n",
 320                             ctl->remotename, ctl->server.truename, idp->id);
 321             }
 322             for (idp = scratchlist; idp; idp = idp->next)
 323                 fputs(idp->id, tmpfp);
 324             fclose(tmpfp);
 325         }
 326 }
 327 #endif /* POP3_ENABLE */
 328
 329 /* uid.c ends here */