]> Pileus Git - ~andy/fetchmail/blobdiff - uid.c
Instrument the UID code.
[~andy/fetchmail] / uid.c
diff --git a/uid.c b/uid.c
index 15a06ba37009d2771ab25372832f34bec6881090..106068e16ef0ef1238bc9e91031def3b5b8bca52 100644 (file)
--- a/uid.c
+++ b/uid.c
@@ -4,15 +4,14 @@
  * For license terms, see the file COPYING in this directory.
  */
 
-#include <config.h>
+#include "config.h"
 
 #include <stdio.h>
-
+#include <limits.h>
 #if defined(STDC_HEADERS)
 #include <stdlib.h>
 #include <string.h>
 #endif
-
 #if defined(HAVE_UNISTD_H)
 #include <unistd.h>
 #endif
  * Machinery for handling UID lists live here.  This is mainly to support
  * RFC1725-conformant POP3 servers without a LAST command, but may also be
  * useful for making the IMAP4 querying logic UID-oriented, if a future
- * revision of IMAP forces me to.  (This would be bad.  Server-side 
- * seen bits are better than UIDs, because they track messages seen by
- * *all* clients.)
+ * revision of IMAP forces me to.
+ *
+ * These functions are also used by the rest of the code to maintain
+ * string lists.
  *
  * Here's the theory:
  *
@@ -33,7 +33,7 @@
  * considered seen in `oldsaved'.  These are messages that were left in
  * the mailbox and *not deleted* on previous queries (we don't need to
  * remember the UIDs of deleted messages because ... well, they're gone!)
- * This list is initially set up by initialized_saved_list() from the
+ * This list is initially set up by initialize_saved_list() from the
  * .fetchids file.
  *
  * Early in the query, during the execution of the protocol-specific 
  * not respond to the request for a UID listing.
  *
  * Each time a message is fetched, we can check its UID against the
- * `oldsaved' list to see if it is old.  If not, it should be downloaded
- * (and possibly deleted).  It should be downloaded anyway if --all
- * is on.  It should not be deleted if --keep is on.
+ * `oldsaved' list to see if it is old.
+ *
+ * Each time a message-id is seen, we mark it with MARK_SEEN.
  *
- * Each time a message is deleted, we remove its id from the `newsaved'
- * member.
+ * Each time a message is deleted, we mark its id UID_DELETED in the
+ * `newsaved' member.  When we want to assert that an expunge has been
+ * done on the server, we call expunge_uid() to register that all
+ * deleted messages are gone by marking them UID_EXPUNGED.
  *
- * At the end of the query, whatever remains in the `newsaved' member
- * (because it was not deleted) becomes the `oldsaved' list.  The old
- * `oldsaved' list is freed.
+ * At the end of the query, the `newsaved' member becomes the
+ * `oldsaved' list.  The old `oldsaved' list is freed.
  *
- * At the end of the fetchmail run, all current `oldsaved' lists are
- * flushed out to the .fetchids file to be picked up by the next run.
- * If there are no such messages, the file is deleted.
+ * At the end of the fetchmail run, seen and non-EXPUNGED members of all
+ * current `oldsaved' lists are flushed out to the .fetchids file to
+ * be picked up by the next run.  If there are no un-expunged
+ * messages, the file is deleted.
+ *
+ * Note: some comparisons (those used for DNS address lists) are caseblind!  
  */
 
 /* UIDs associated with un-queried hosts */
 static struct idlist *scratchlist;
 
+#ifdef POP3_ENABLE
 void initialize_saved_lists(struct query *hostlist, const char *idfile)
 /* read file of saved IDs and attach to each host */
 {
@@ -71,7 +76,7 @@ void initialize_saved_lists(struct query *hostlist, const char *idfile)
 
     /* make sure lists are initially empty */
     for (ctl = hostlist; ctl; ctl = ctl->next)
-       ctl->oldsaved = ctl->newsaved = (struct idlist *)NULL;
+       ctl->skipped = ctl->oldsaved = ctl->newsaved = (struct idlist *)NULL;
 
     /* let's get stored message UIDs from previous queries */
     if ((tmpfp = fopen(idfile, "r")) != (FILE *)NULL) {
@@ -80,28 +85,52 @@ void initialize_saved_lists(struct query *hostlist, const char *idfile)
        while (fgets(buf, POPBUFSIZE, tmpfp) != (char *)NULL)
        {
            /* possible lossage here with very old versions of sscanf(3)... */
-           if ((st = sscanf(buf, "%[^@]@%s %s\n", host, user, id)) == 3)
+           if ((st = sscanf(buf, "%[^@]@%s %s\n", user, host, id)) == 3)
            {
                for (ctl = hostlist; ctl; ctl = ctl->next)
                {
-                   if (strcmp(host, ctl->servernames->id) == 0
-                               && strcmp(user, ctl->remotename) == 0)
+                   if (ctl->server.truename &&
+                       strcasecmp(host, ctl->server.truename) == 0
+                               && strcasecmp(user, ctl->remotename) == 0)
                    {
-                       save_uid(&ctl->oldsaved, -1, id);
+                       save_str(&ctl->oldsaved, id, UID_SEEN);
                        break;
                    }
                }
 
                /* if it's not in a host we're querying, save it anyway */
                if (ctl == (struct query *)NULL)
-                   save_uid(&scratchlist, -1, buf);
+                   save_str(&scratchlist, buf, UID_SEEN);
            }
        }
        fclose(tmpfp);
     }
+
+    if (outlevel >= O_DEBUG)
+    {
+       struct idlist   *idp;
+
+       for (ctl = hostlist; ctl; ctl = ctl->next)
+       {
+           report(stdout, "Old UID list from %s:", ctl->server.truename);
+           for (idp = ctl->oldsaved; idp; idp = idp->next)
+               report(stdout, " %s", idp->id);
+           if (!idp)
+               report(stdout, "<empty>");
+           report(stdout, "\n");
+       }
+
+       report(stdout, "Scratch list of UIDs:");
+       for (idp = scratchlist; idp; idp = idp->next)
+           report(stdout, " %s", idp->id);
+       if (!idp)
+           report(stdout, "<empty>");
+       report(stdout, "\n");
+    }
 }
+#endif /* POP3_ENABLE */
 
-struct idlist *save_uid(struct idlist **idl, int num, const char *str)
+struct idlist *save_str(struct idlist **idl, const char *str, flag status)
 /* save a number/UID pair on the given UID list */
 {
     struct idlist **end;
@@ -111,42 +140,45 @@ struct idlist *save_uid(struct idlist **idl, int num, const char *str)
        continue;
 
     *end = (struct idlist *)xmalloc(sizeof(struct idlist));
-    (*end)->val.num = num;
-    (*end)->id = xstrdup(str);
+    (*end)->val.status.mark = status;
+    (*end)->id = str ? xstrdup(str) : (char *)NULL;
     (*end)->next = NULL;
 
     return(*end);
 }
 
-void free_uid_list(struct idlist **idl)
+void free_str_list(struct idlist **idl)
 /* free the given UID list */
 {
     if (*idl == (struct idlist *)NULL)
        return;
 
-    free_uid_list(&(*idl)->next);
+    free_str_list(&(*idl)->next);
     free ((*idl)->id);
     free(*idl);
     *idl = (struct idlist *)NULL;
 }
 
-void save_id_pair(struct idlist **idl, const char *str1, const char *str2)
+void save_str_pair(struct idlist **idl, const char *str1, const char *str2)
 /* save an ID pair on the given list */
 {
-    struct idlist *new;
+    struct idlist **end;
 
-    new = (struct idlist *)xmalloc(sizeof(struct idlist));
-    new->id = xstrdup(str1);
+    /* do it nonrecursively so the list is in the right order */
+    for (end = idl; *end; end = &(*end)->next)
+       continue;
+
+    *end = (struct idlist *)xmalloc(sizeof(struct idlist));
+    (*end)->id = str1 ? xstrdup(str1) : (char *)NULL;
     if (str2)
-       new->val.id2 = xstrdup(str2);
+       (*end)->val.id2 = xstrdup(str2);
     else
-       new->val.id2 = (char *)NULL;
-    new->next = *idl;
-    *idl = new;
+       (*end)->val.id2 = (char *)NULL;
+    (*end)->next = (struct idlist *)NULL;
 }
 
 #ifdef __UNUSED__
-void free_idpair_list(struct idlist **idl)
+void free_str_pair_list(struct idlist **idl)
 /* free the given ID pair list */
 {
     if (*idl == (struct idlist *)NULL)
@@ -160,75 +192,154 @@ void free_idpair_list(struct idlist **idl)
 }
 #endif
 
-int uid_in_list(struct idlist **idl, const char *str)
-/* is a given ID in the given list? */
+int str_in_list(struct idlist **idl, const char *str, const flag caseblind)
+/* is a given ID in the given list? (comparison may be caseblind) */
 {
     if (*idl == (struct idlist *)NULL || str == (char *) NULL)
        return(0);
-    else if (strcmp(str, (*idl)->id) == 0)
+    else if (!caseblind && strcmp(str, (*idl)->id) == 0)
+       return(1);
+    else if (caseblind && strcasecmp(str, (*idl)->id) == 0)
        return(1);
     else
-       return(uid_in_list(&(*idl)->next, str));
+       return(str_in_list(&(*idl)->next, str, caseblind));
+}
+
+int str_nr_in_list( struct idlist **idl, const char *str )
+  /* return the position of str in idl */
+{
+    int nr;
+    struct idlist *walk;
+    if ( !str )
+        return -1;
+    for( walk = *idl, nr = 0; walk; nr ++, walk = walk->next )
+        if( strcmp( str, walk->id) == 0 )
+           return nr;
+    return -1;
+}
+
+int str_nr_last_in_list( struct idlist **idl, const char *str)
+/* return the last position of str in idl */
+{
+    int nr, ret = -1;
+    struct idlist *walk;
+    if ( !str )
+        return -1;
+    for( walk = *idl, nr = 0; walk; nr ++, walk = walk->next )
+        if( strcmp( str, walk->id) == 0 )
+           ret = nr;
+    return ret;
+}
+
+void str_set_mark( struct idlist **idl, const char *str, const flag val)
+/* update the mark on an of an id to given value */
+{
+    int nr;
+    struct idlist *walk;
+    if (!str)
+        return;
+    for(walk = *idl, nr = 0; walk; nr ++, walk = walk->next)
+        if (strcmp(str, walk->id) == 0)
+           walk->val.status.mark = val;
+}
+
+int count_list( struct idlist **idl)
+/* count the number of elements in the list */
+{
+  if( !*idl )
+    return 0;
+  return 1 + count_list( &(*idl)->next );
+}
+
+char *str_from_nr_list(struct idlist **idl, int number)
+/* return the number'th string in idl */
+{
+    if( !*idl  || number < 0)
+        return 0;
+    if( number == 0 )
+        return (*idl)->id;
+    return str_from_nr_list(&(*idl)->next, number-1);
 }
 
-char *uid_find(struct idlist **idl, int number)
+    
+char *str_find(struct idlist **idl, int number)
 /* return the id of the given number in the given list. */
 {
     if (*idl == (struct idlist *) 0)
        return((char *) 0);
-    else if (number == (*idl)->val.num)
+    else if (number == (*idl)->val.status.num)
        return((*idl)->id);
     else
-       return(uid_find(&(*idl)->next, number));
+       return(str_find(&(*idl)->next, number));
 }
 
 char *idpair_find(struct idlist **idl, const char *id)
-/* return the id of the given number in the given list. */
+/* return the id of the given id in the given list (caseblind comparison) */
 {
     if (*idl == (struct idlist *) 0)
        return((char *) 0);
-    else if (strcmp(id, (*idl)->id) == 0)
+    else if (strcasecmp(id, (*idl)->id) == 0)
        return((*idl)->val.id2 ? (*idl)->val.id2 : (*idl)->id);
     else
        return(idpair_find(&(*idl)->next, id));
 }
 
-int delete_uid(struct idlist **idl, int num)
+int delete_str(struct idlist **idl, int num)
 /* delete given message from given list */
 {
-    if (*idl == (struct idlist *)NULL)
-       return(0);
-    else if ((*idl)->val.num == num)
-    {
-       struct idlist   *next = (*idl)->next;
+    struct idlist      *idp;
 
-       free ((*idl)->id);
-       free(*idl);
-       *idl = next;
-       return(1);
-    }
-    else
-       return(delete_uid(&(*idl)->next, num));
+    for (idp = *idl; idp; idp = idp->next)
+       if (idp->val.status.num == num)
+       {
+           idp->val.status.mark = UID_DELETED;
+           return(1);
+       }
     return(0);
 }
 
-void append_uid_list(struct idlist **idl, struct idlist **nidl)
+void append_str_list(struct idlist **idl, struct idlist **nidl)
 /* append nidl to idl (does not copy *) */
 {
-    if ((*idl) == (struct idlist *)NULL)
+    if ((*nidl) == (struct idlist *)NULL || *nidl == *idl)
+       return;
+    else if ((*idl) == (struct idlist *)NULL)
        *idl = *nidl;
     else if ((*idl)->next == (struct idlist *)NULL)
        (*idl)->next = *nidl;
-    else
-       append_uid_list(&(*idl)->next, nidl);
+    else if ((*idl)->next != *nidl)
+       append_str_list(&(*idl)->next, nidl);
 }
 
-void update_uid_lists(struct query *ctl)
+#ifdef POP3_ENABLE
+void expunge_uids(struct query *ctl)
+/* assert that all UIDs marked deleted have actually been expunged */
+{
+    struct idlist *idl;
+
+    for (idl = ctl->newsaved; idl; idl = idl->next)
+       if (idl->val.status.mark == UID_DELETED)
+           idl->val.status.mark = UID_EXPUNGED;
+}
+
+void update_str_lists(struct query *ctl)
 /* perform end-of-query actions on UID lists */
 {
-    free_uid_list(&ctl->oldsaved);
+    free_str_list(&ctl->oldsaved);
     ctl->oldsaved = ctl->newsaved;
     ctl->newsaved = (struct idlist *) NULL;
+
+    if (outlevel >= O_DEBUG)
+    {
+       struct idlist *idp;
+
+       report(stdout, "New UID list from %s:", ctl->server.truename);
+       for (idp = ctl->oldsaved; idp; idp = idp->next)
+           report(stdout, " %s = %d", idp->id, idp->val.status.mark);
+       if (!idp)
+           report(stdout, "<empty>");
+       report(stdout, "\n");
+    }
 }
 
 void write_saved_lists(struct query *hostlist, const char *idfile)
@@ -248,18 +359,25 @@ void write_saved_lists(struct query *hostlist, const char *idfile)
 
     /* either nuke the file or write updated last-seen IDs */
     if (!idcount)
+    {
+       if (outlevel >= O_DEBUG)
+           report(stdout, "Deleting fetchids file.");
        unlink(idfile);
+    }
     else
        if ((tmpfp = fopen(idfile, "w")) != (FILE *)NULL) {
            for (ctl = hostlist; ctl; ctl = ctl->next) {
                for (idp = ctl->oldsaved; idp; idp = idp->next)
-                   fprintf(tmpfp, "%s@%s %s\n", 
-                           ctl->remotename, ctl->servernames->id, idp->id);
+                   if (idp->val.status.mark == UID_SEEN
+                               || idp->val.status.mark == UID_DELETED)
+                       fprintf(tmpfp, "%s@%s %s\n", 
+                           ctl->remotename, ctl->server.truename, idp->id);
            }
            for (idp = scratchlist; idp; idp = idp->next)
                fputs(idp->id, tmpfp);
            fclose(tmpfp);
        }
 }
+#endif /* POP3_ENABLE */
 
 /* uid.c ends here */