/**
- * \file uid.c -- UIDL handling for POP3 servers without LAST
+ * \file uid.c
+ * UID list handling (currently, only for POP3)
*
* For license terms, see the file COPYING in this directory.
- */
-
-#include "config.h"
-
-#include <sys/stat.h>
-#include <errno.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
-
-#include "fetchmail.h"
-#include "i18n.h"
-#include "sdump.h"
-
-/*
- * Machinery for handling UID lists live here. This is mainly to support
- * RFC1725/RFC1939-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.
+ *
+ * Machinery for handling UID lists live here. This is currently used
+ * by POP3, but may also be useful for making the IMAP4 querying logic
+ * UID-oriented.
*
* These functions are also used by the rest of the code to maintain
* string lists.
* Note: some comparisons (those used for DNS address lists) are caseblind!
*/
+#include "config.h"
+
+#include <sys/stat.h>
+#include <errno.h>
+#include <stdio.h>
+#include <limits.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+
+#include "fetchmail.h"
+#include "gettext.h"
+#include "sdump.h"
+
int dofastuidl = 0;
#ifdef POP3_ENABLE
/** UIDs associated with un-queried hosts */
static struct idlist *scratchlist;
+static int dump_saved_uid(struct uid_db_record *rec, void *unused)
+{
+ char *t;
+
+ (void)unused;
+
+ t = sdump(rec->id, rec->id_len);
+ report_build(stdout, " %s", t);
+ free(t);
+
+ return 0;
+}
+
/** Read saved IDs from \a idfile and attach to each host in \a hostlist. */
void initialize_saved_lists(struct query *hostlist, const char *idfile)
{
/* make sure lists are initially empty */
for (ctl = hostlist; ctl; ctl = ctl->next) {
ctl->skipped = (struct idlist *)NULL;
- ctl->oldsaved = (struct idlist *)NULL;
- ctl->newsaved = (struct idlist *)NULL;
- ctl->oldsavedend = &ctl->oldsaved;
+
+ init_uid_db(&ctl->oldsaved);
+ init_uid_db(&ctl->newsaved);
}
errno = 0;
while (fgets(buf, POPBUFSIZE, tmpfp) != (char *)NULL)
{
/*
- * At this point, we assume the bug has two fields -- a user@host
+ * At this point, we assume the bug has two fields -- a user@host
* part, and an ID part. Either field may contain spurious @ signs.
- * The previous version of this code presumed one could split at
- * the rightmost '@'. This is not correct, as InterMail puts an
+ * The previous version of this code presumed one could split at
+ * the rightmost '@'. This is not correct, as InterMail puts an
* '@' in the UIDL.
*/
* instead of a Message-ID, as GMX's (www.gmx.net) POP3
* StreamProxy V1.0 does.
*
- * this is one other trick. The userhost part
+ * this is one other trick. The userhost part
* may contain ' ' in the user part, at least in
* the lotus notes case.
* So we start looking for the '@' after which the
if ((*delimp1 != ' ') && (*delimp1 != '\t'))
break;
- /*
+ /*
* It should be safe to assume that id starts after
* the " " - after all, we're writing the " "
* ourselves in write_saved_lists() :-)
*atsign = '\0';
host = atsign + 1;
- /* find proper list and save it */
+ /* find uidl db and save it */
for (ctl = hostlist; ctl; ctl = ctl->next) {
if (strcasecmp(host, ctl->server.queryname) == 0
&& strcasecmp(user, ctl->remotename) == 0) {
- save_str(&ctl->oldsaved, id, UID_SEEN);
+ uid_db_insert(&ctl->oldsaved, id, UID_SEEN);
break;
}
}
- /*
+ /*
* If it's not in a host we're querying,
* save it anyway. Otherwise we'd lose UIDL
* information any time we queried an explicit
for (ctl = hostlist; ctl; ctl = ctl->next)
{
- report_build(stdout, GT_("Old UID list from %s:"),
+ report_build(stdout, GT_("Old UID list from %s:"),
ctl->server.pollname);
- idp = ctl->oldsaved;
- if (!idp)
+
+ if (!uid_db_n_records(&ctl->oldsaved))
report_build(stdout, GT_(" <empty>"));
- else for (idp = ctl->oldsaved; idp; idp = idp->next) {
- char *t = sdump(idp->id, strlen(idp->id));
- report_build(stdout, " %s", t);
- free(t);
- }
+ else
+ traverse_uid_db(&ctl->oldsaved, dump_saved_uid, NULL);
+
report_complete(stdout, "\n");
}
if (!scratchlist)
report_build(stdout, GT_(" <empty>"));
else for (idp = scratchlist; idp; idp = idp->next) {
- char *t = sdump(idp->id, strlen(idp->id));
- report_build(stdout, " %s", t);
+ char *t = sdump(idp->id, strlen(idp->id)-1);
+ report_build(stdout, " %s\n", t);
free(t);
}
report_complete(stdout, "\n");
}
}
+static int mark_as_expunged_if(struct uid_db_record *rec, void *unused)
+{
+ (void)unused;
+
+ if (rec->status == UID_DELETED) rec->status = UID_EXPUNGED;
+ return 0;
+}
+
/** Assert that all UIDs marked deleted in query \a ctl have actually been
expunged. */
void expunge_uids(struct query *ctl)
{
- struct idlist *idl;
-
- for (idl = dofastuidl ? ctl->oldsaved : ctl->newsaved; idl; idl = idl->next)
- if (idl->val.status.mark == UID_DELETED)
- idl->val.status.mark = UID_EXPUNGED;
+ traverse_uid_db(dofastuidl ? &ctl->oldsaved : &ctl->newsaved,
+ mark_as_expunged_if, NULL);
}
static const char *str_uidmark(int mark)
}
}
-static void dump_list(const struct idlist *idp)
+static int dump_uid_db_record(struct uid_db_record *rec, void *arg)
{
- if (!idp) {
+ unsigned *n_recs;
+ char *t;
+
+ n_recs = (unsigned int *)arg;
+ --*n_recs;
+
+ t = sdump(rec->id, rec->id_len);
+ report_build(stdout, " %s = %s%s", t, str_uidmark(rec->status), *n_recs ? "," : "");
+ free(t);
+
+ return 0;
+}
+
+static void dump_uid_db(struct uid_db *db)
+{
+ unsigned n_recs;
+
+ n_recs = uid_db_n_records(db);
+ if (!n_recs) {
report_build(stdout, GT_(" <empty>"));
- } else while (idp) {
- char *t = sdump(idp->id, strlen(idp->id));
- report_build(stdout, " %s = %s%s", t, str_uidmark(idp->val.status.mark), idp->next ? "," : "");
- free(t);
- idp = idp->next;
+ return;
}
+
+ traverse_uid_db(db, dump_uid_db_record, &n_recs);
}
-/* finish a query */
-void uid_swap_lists(struct query *ctl)
+/** Finish a successful query */
+void uid_swap_lists(struct query *ctl)
{
/* debugging code */
if (outlevel >= O_DEBUG)
{
if (dofastuidl) {
report_build(stdout, GT_("Merged UID list from %s:"), ctl->server.pollname);
- dump_list(ctl->oldsaved);
+ dump_uid_db(&ctl->oldsaved);
} else {
report_build(stdout, GT_("New UID list from %s:"), ctl->server.pollname);
- dump_list(ctl->newsaved);
+ dump_uid_db(&ctl->newsaved);
}
report_complete(stdout, "\n");
}
* with UIDLs from that account in .fetchids, there is no way for
* them to ever get garbage-collected.
*/
- if (ctl->newsaved)
+ if (uid_db_n_records(&ctl->newsaved))
{
- /* old state of mailbox may now be irrelevant */
- struct idlist *temp = ctl->oldsaved;
- if (outlevel >= O_DEBUG)
- report(stdout, GT_("swapping UID lists\n"));
- ctl->oldsaved = ctl->newsaved;
- ctl->newsaved = (struct idlist *) NULL;
- free_str_list(&temp);
+ swap_uid_db_data(&ctl->newsaved, &ctl->oldsaved);
+ clear_uid_db(&ctl->newsaved);
}
/* in fast uidl, there is no need to swap lists: the old state of
* mailbox cannot be discarded! */
report(stdout, GT_("not swapping UID lists, no UIDs seen this query\n"));
}
-/* finish a query which had errors */
+/** Finish a query which had errors */
void uid_discard_new_list(struct query *ctl)
{
/* debugging code */
/* this is now a merged list! the mails which were seen in this
* poll are marked here. */
report_build(stdout, GT_("Merged UID list from %s:"), ctl->server.pollname);
- dump_list(ctl->oldsaved);
+ dump_uid_db(&ctl->oldsaved);
report_complete(stdout, "\n");
}
- if (ctl->newsaved)
+ if (uid_db_n_records(&ctl->newsaved))
{
/* new state of mailbox is not reliable */
if (outlevel >= O_DEBUG)
report(stdout, GT_("discarding new UID list\n"));
- free_str_list(&ctl->newsaved);
- ctl->newsaved = (struct idlist *) NULL;
+ clear_uid_db(&ctl->newsaved);
}
}
/** Reset the number associated with each id */
void uid_reset_num(struct query *ctl)
{
- struct idlist *idp;
- for (idp = ctl->oldsaved; idp; idp = idp->next)
- idp->val.status.num = 0;
+ reset_uid_db_nums(&ctl->oldsaved);
}
/** Write list of seen messages, at end of run. */
+static int count_seen_deleted(struct uid_db_record *rec, void *arg)
+{
+ if (rec->status == UID_SEEN || rec->status == UID_DELETED)
+ ++*(long *)arg;
+ return 0;
+}
+
+struct write_saved_info {
+ struct query *ctl;
+ FILE *fp;
+};
+
+static int write_uid_db_record(struct uid_db_record *rec, void *arg)
+{
+ struct write_saved_info *info;
+ int rc;
+
+ if (!(rec->status == UID_SEEN || rec->status == UID_DELETED))
+ return 0;
+
+ info = (struct write_saved_info *)arg;
+ rc = fprintf(info->fp, "%s@%s %s\n",
+ info->ctl->remotename, info->ctl->server.queryname,
+ rec->id);
+ return rc < 0 ? -1 : 0;
+}
+
+/** Write new list of UIDs (state) to \a idfile. */
void write_saved_lists(struct query *hostlist, const char *idfile)
{
long idcount;
/* if all lists are empty, nuke the file */
idcount = 0;
- for (ctl = hostlist; ctl; ctl = ctl->next) {
- for (idp = ctl->oldsaved; idp; idp = idp->next)
- if (idp->val.status.mark == UID_SEEN
- || idp->val.status.mark == UID_DELETED)
- idcount++;
- }
+ for (ctl = hostlist; ctl; ctl = ctl->next)
+ traverse_uid_db(&ctl->oldsaved, count_seen_deleted, &idcount);
/* either nuke the file or write updated last-seen IDs */
if (!idcount && !scratchlist)
report(stdout, GT_("Writing fetchids file.\n"));
(void)unlink(newnam); /* remove file/link first */
if ((tmpfp = fopen(newnam, "w")) != (FILE *)NULL) {
+ struct write_saved_info info;
int errflg = 0;
+
+ info.fp = tmpfp;
+
for (ctl = hostlist; ctl; ctl = ctl->next) {
- for (idp = ctl->oldsaved; idp; idp = idp->next)
- if (idp->val.status.mark == UID_SEEN
- || idp->val.status.mark == UID_DELETED)
- if (fprintf(tmpfp, "%s@%s %s\n",
- ctl->remotename, ctl->server.queryname, idp->id) < 0) {
- int e = errno;
- report(stderr, GT_("Write error on fetchids file %s: %s\n"), newnam, strerror(e));
- errflg = 1;
- goto bailout;
- }
+ info.ctl = ctl;
+
+ if (traverse_uid_db(&ctl->oldsaved, write_uid_db_record, &info) < 0) {
+ int e = errno;
+ report(stderr, GT_("Write error on fetchids file %s: %s\n"), newnam, strerror(e));
+ errflg = 1;
+ goto bailout;
+ }
}
+
for (idp = scratchlist; idp; idp = idp->next)
if (EOF == fputs(idp->id, tmpfp)) {
int e = errno;
bailout:
(void)fflush(tmpfp); /* return code ignored, we check ferror instead */
errflg |= ferror(tmpfp);
- fclose(tmpfp);
+ errflg |= fclose(tmpfp);
/* if we could write successfully, move into place;
* otherwise, drop */
if (errflg) {
projects / ~andy / fetchmail / blobdiff