]> Pileus Git - ~andy/fetchmail/blobdiff - uid.c
Deprecate the old popclient syntax and produce a warning.
[~andy/fetchmail] / uid.c
diff --git a/uid.c b/uid.c
index a8da788d714d1532b23d1994f5940387510eb310..d717997382946317c683a9bfd83b28bbfb5710a9 100644 (file)
--- a/uid.c
+++ b/uid.c
@@ -1,16 +1,9 @@
-/* Copyright 1993-95 by Carl Harris, Jr. Copyright 1996 by Eric S. Raymond
- * All rights reserved.
+/*
+ * uid.c -- UIDL handling for POP3 servers without LAST
+ *
  * For license terms, see the file COPYING in this directory.
  */
 
-/***********************************************************************
-  module:       uid.c
-  project:      fetchmail
-  programmer:   Eric S. Raymond
-  description: UID list handling
-
- ***********************************************************************/
-
 #include <config.h>
 
 #include <stdio.h>
  * Here's the theory:
  *
  * At start of a query, we have a (possibly empty) list of UIDs to be
- * considered `already seen'.  These are messages that were left in
+ * 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 set up by initialized_saved_list() from the .fetchids 
- * file and hangs off the host's `saved' member.
+ * remember the UIDs of deleted messages because ... well, they're gone!)
+ * This list is initially set up by initialized_saved_list() from the
+ * .fetchids file.
  *
  * Early in the query, during the execution of the protocol-specific 
- * getrange code, the driver expects that the host's `unseen' member
+ * getrange code, the driver expects that the host's `newsaved' member
  * will be filled with a list of UIDs and message numbers representing
- * the unseen mailbox state.  If this list is empty, the server did
+ * the mailbox state.  If this list is empty, the server did
  * not respond to the request for a UID listing.
  *
  * Each time a message is fetched, we can check its UID against the
- * `saved' list to see if it is old.  If not, it should be downloaded
+ * `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.
  *
- * Each time a message is read, we remove its id from the `unseen'
+ * Each time a message is deleted, we remove its id from the `newsaved'
  * member.
  *
- * At the end of the query, whatever remains in the `unseen' member
- * (because it was not deleted) becomes the `saved' list.  The old
- * `saved' list is freed.
+ * 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 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.
  */
 
 /* UIDs associated with un-queried hosts */
 static struct idlist *scratchlist;
 
-void initialize_saved_lists(hostlist, idfile)
+void initialize_saved_lists(struct query *hostlist, const char *idfile)
 /* read file of saved IDs and attach to each host */
-struct hostrec *hostlist;
-char *idfile;
 {
     int        st;
     FILE       *tmpfp;
-    struct hostrec *hostp;
+    struct query *ctl;
 
     /* make sure lists are initially empty */
-    for (hostp = hostlist; hostp; hostp = hostp->next)
-       hostp->saved = hostp->unseen = (struct idlist *)NULL;
+    for (ctl = hostlist; ctl; ctl = ctl->next)
+       ctl->oldsaved = ctl->newsaved = (struct idlist *)NULL;
 
     /* let's get stored message UIDs from previous queries */
     if ((tmpfp = fopen(idfile, "r")) != (FILE *)NULL) {
-       char buf[POPBUFSIZE+1], host[HOSTLEN+1], id[IDLEN+1];
+       char buf[POPBUFSIZE+1],host[HOSTLEN+1],user[USERNAMELEN+1],id[IDLEN+1];
 
        while (fgets(buf, POPBUFSIZE, tmpfp) != (char *)NULL)
        {
-           if ((st = sscanf(buf, "%s %s\n", host, id)) == 2)
+           /* possible lossage here with very old versions of sscanf(3)... */
+           if ((st = sscanf(buf, "%[^@]@%s %s\n", host, user, id)) == 3)
            {
-               for (hostp = hostlist; hostp; hostp = hostp->next)
+               for (ctl = hostlist; ctl; ctl = ctl->next)
                {
-                   if (strcmp(host, hostp->servername) == 0)
+                   if (strcmp(host, ctl->server.names->id) == 0
+                               && strcmp(user, ctl->remotename) == 0)
                    {
-                       save_uid(&hostp->saved, -1, id);
+                       save_str(&ctl->oldsaved, -1, id);
                        break;
                    }
                }
 
                /* if it's not in a host we're querying, save it anyway */
-               if (hostp == (struct hostrec *)NULL)
-                   save_uid(&scratchlist, -1, buf);
+               if (ctl == (struct query *)NULL)
+                   save_str(&scratchlist, -1, buf);
            }
        }
        fclose(tmpfp);
     }
 }
 
-void save_uid(idl, num, str)
+struct idlist *save_str(struct idlist **idl, int num, const char *str)
 /* save a number/UID pair on the given UID list */
-struct idlist **idl;
-int num;
-char *str;
 {
-    struct idlist *new;
+    struct idlist **end;
 
-    new = (struct idlist *)xmalloc(sizeof(struct idlist));
-    new->num = num;
-    new->id = strdup(str);
-    new->next = *idl;
-    *idl = new;
+    /* 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)->val.num = num;
+    (*end)->id = xstrdup(str);
+    (*end)->next = NULL;
+
+    return(*end);
 }
 
-void free_uid_list(idl)
+void free_str_list(struct idlist **idl)
 /* free the given UID list */
-struct idlist **idl;
 {
     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;
 }
 
-int uid_in_list(idl, str)
-/* is a given ID in the given list? */
-struct idlist **idl;
-char *str;
+void save_str_pair(struct idlist **idl, const char *str1, const char *str2)
+/* save an ID pair on the given list */
+{
+    struct idlist **end;
+
+    /* 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 = xstrdup(str1);
+    if (str2)
+       (*end)->val.id2 = xstrdup(str2);
+    else
+       (*end)->val.id2 = (char *)NULL;
+    (*end)->next = (struct idlist *)NULL;
+}
+
+#ifdef __UNUSED__
+void free_str_pair_list(struct idlist **idl)
+/* free the given ID pair list */
 {
     if (*idl == (struct idlist *)NULL)
+       return;
+
+    free_idpair_list(&(*idl)->next);
+    free ((*idl)->id);
+    free ((*idl)->val.id2);
+    free(*idl);
+    *idl = (struct idlist *)NULL;
+}
+#endif
+
+int str_in_list(struct idlist **idl, const char *str)
+/* is a given ID in the given list? (comparison is caseblind) */
+{
+    if (*idl == (struct idlist *)NULL || str == (char *) NULL)
        return(0);
-    else if (strcmp(str, (*idl)->id) == 0)
+    else if (strcasecmp(str, (*idl)->id) == 0)
        return(1);
     else
-       return(uid_in_list(&(*idl)->next, str));
+       return(str_in_list(&(*idl)->next, str));
 }
 
-int delete_uid(idl, num)
+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)
+       return((*idl)->id);
+    else
+       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. */
+{
+    if (*idl == (struct idlist *) 0)
+       return((char *) 0);
+    else if (strcmp(id, (*idl)->id) == 0)
+       return((*idl)->val.id2 ? (*idl)->val.id2 : (*idl)->id);
+    else
+       return(idpair_find(&(*idl)->next, id));
+}
+
+int delete_str(struct idlist **idl, int num)
 /* delete given message from given list */
-struct idlist **idl;
-int num;
 {
     if (*idl == (struct idlist *)NULL)
        return(0);
-    else if ((*idl)->num == num)
+    else if ((*idl)->val.num == num)
     {
        struct idlist   *next = (*idl)->next;
 
@@ -162,34 +211,41 @@ int num;
        return(1);
     }
     else
-       return(delete_uid(&(*idl)->next, num));
+       return(delete_str(&(*idl)->next, num));
     return(0);
 }
 
-void update_uid_lists(hostp)
+void append_str_list(struct idlist **idl, struct idlist **nidl)
+/* append nidl to idl (does not copy *) */
+{
+    if ((*idl) == (struct idlist *)NULL)
+       *idl = *nidl;
+    else if ((*idl)->next == (struct idlist *)NULL)
+       (*idl)->next = *nidl;
+    else
+       append_str_list(&(*idl)->next, nidl);
+}
+
+void update_str_lists(struct query *ctl)
 /* perform end-of-query actions on UID lists */
-struct hostrec *hostp;
 {
-    /*
-     * Replace `saved' list with `unseen' list as modified by deletions.
-     */
-    free_uid_list(&hostp->saved);
-    hostp->saved = hostp->unseen;
+    free_str_list(&ctl->oldsaved);
+    ctl->oldsaved = ctl->newsaved;
+    ctl->newsaved = (struct idlist *) NULL;
 }
 
-void write_saved_lists(hostlist, idfile)
-struct hostrec *hostlist;
-char *idfile;
+void write_saved_lists(struct query *hostlist, const char *idfile)
+/* perform end-of-run write of seen-messages list */
 {
-    int        st, idcount;
+    int                idcount;
     FILE       *tmpfp;
-    struct hostrec *hostp;
+    struct query *ctl;
     struct idlist *idp;
 
     /* if all lists are empty, nuke the file */
     idcount = 0;
-    for (hostp = hostlist; hostp; hostp = hostp->next) {
-       if (hostp->saved)
+    for (ctl = hostlist; ctl; ctl = ctl->next) {
+       if (ctl->oldsaved)
            idcount++;
     }
 
@@ -198,12 +254,15 @@ char *idfile;
        unlink(idfile);
     else
        if ((tmpfp = fopen(idfile, "w")) != (FILE *)NULL) {
-           for (hostp = hostlist; hostp; hostp = hostp->next) {
-               for (idp = hostp->saved; idp; idp = idp->next)
-                   fprintf(tmpfp, "%s %s\n", hostp->servername, idp->id);
+           for (ctl = hostlist; ctl; ctl = ctl->next) {
+               for (idp = ctl->oldsaved; idp; idp = idp->next)
+                   fprintf(tmpfp, "%s@%s %s\n", 
+                           ctl->remotename, ctl->server.names->id, idp->id);
            }
            for (idp = scratchlist; idp; idp = idp->next)
                fputs(idp->id, tmpfp);
            fclose(tmpfp);
        }
 }
+
+/* uid.c ends here */