2 * \file uid.c -- UIDL handling for POP3 servers without LAST
4 * For license terms, see the file COPYING in this directory.
23 * Machinery for handling UID lists live here. This is currently used
24 * by POP3, but may also be useful for making the IMAP4 querying logic
27 * These functions are also used by the rest of the code to maintain
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 initialize_saved_list() from the
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.
45 * Each time a message is fetched, we can check its UID against the
46 * `oldsaved' list to see if it is old.
48 * Each time a message-id is seen, we mark it with MARK_SEEN.
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.
55 * At the end of the query, the `newsaved' member becomes the
56 * `oldsaved' list. The old `oldsaved' list is freed.
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.
63 * One disadvantage of UIDL is that all the UIDs have to be downloaded
64 * before a search for new messages can be done. Typically, new messages
65 * are appended to mailboxes. Hence, downloading all UIDs just to download
66 * a few new mails is a waste of bandwidth. If new messages are always at
67 * the end of the mailbox, fast UIDL will decrease the time required to
70 * During fast UIDL, the UIDs of all messages are not downloaded! The first
71 * unseen message is searched for by using a binary search on UIDs. UIDs
72 * after the first unseen message are downloaded as and when needed.
74 * The advantages of fast UIDL are (this is noticeable only when the
75 * mailbox has too many mails):
77 * - There is no need to download the UIDs of all mails right at the start.
78 * - There is no need to save all the UIDs in memory separately in
80 * - There is no need to download the UIDs of seen mail (except for the
81 * first binary search).
82 * - The first new mail is downloaded considerably faster.
84 * The disadvantages are:
86 * - Since all UIDs are not downloaded, it is not possible to swap old and
87 * new list. The current state of the mailbox is essentially a merged state
88 * of old and new mails.
89 * - If an intermediate mail has been temporarily refused (say, due to 4xx
90 * code from the smtp server), this mail may not get downloaded.
91 * - If 'flush' is used, such intermediate mails will also get deleted.
93 * The first two disadvantages can be overcome by doing a linear search
94 * once in a while (say, every 10th poll). Also, with flush, fast UIDL
97 * Note: some comparisons (those used for DNS address lists) are caseblind!
103 /** UIDs associated with un-queried hosts */
104 static struct idlist *scratchlist;
106 /** Read saved IDs from \a idfile and attach to each host in \a hostlist. */
107 static int dump_saved_uid(struct uid_db_record *rec, void *unused)
113 t = sdump(rec->id, rec->id_len);
114 report_build(stdout, " %s\n", t);
120 /** Read saved IDs from \a idfile and attach to each host in \a hostlist.
121 * Returns 0 for success, or a non-zero error code. */
122 int initialize_saved_lists(struct query *hostlist, const char *idfile)
129 /* make sure lists are initially empty */
130 for (ctl = hostlist; ctl; ctl = ctl->next) {
131 ctl->skipped = (struct idlist *)NULL;
133 init_uid_db(&ctl->oldsaved);
134 init_uid_db(&ctl->newsaved);
140 * Croak if the uidl directory does not exist.
141 * This probably means an NFS mount failed and we can't
142 * see a uidl file that ought to be there.
143 * Question: is this a portable check? It's not clear
144 * that all implementations of lstat() will return ENOTDIR
145 * rather than plain ENOENT in this case...
147 if (lstat(idfile, &statbuf) < 0) {
148 if (errno == ENOTDIR)
150 report(stderr, "lstat: %s: %s\n", idfile, strerror(errno));
155 /* let's get stored message UIDs from previous queries */
156 if ((tmpfp = fopen(idfile, "r")) != (FILE *)NULL)
158 char buf[POPBUFSIZE+1];
159 char *host = NULL; /* pacify -Wall */
162 char *atsign; /* temp pointer used in parsing user and host */
166 char saveddelim2 = '\0'; /* pacify -Wall */
168 while (fgets(buf, POPBUFSIZE, tmpfp) != (char *)NULL)
171 * At this point, we assume the bug has two fields -- a user@host
172 * part, and an ID part. Either field may contain spurious @ signs.
173 * The previous version of this code presumed one could split at
174 * the rightmost '@'. This is not correct, as InterMail puts an
178 /* first, skip leading spaces */
179 user = buf + strspn(buf, " \t");
182 * First, we split the buf into a userhost part and an id
183 * part ... but id doesn't necessarily start with a '<',
184 * espescially if the POP server returns an X-UIDL header
185 * instead of a Message-ID, as GMX's (www.gmx.net) POP3
186 * StreamProxy V1.0 does.
188 * this is one other trick. The userhost part
189 * may contain ' ' in the user part, at least in
190 * the lotus notes case.
191 * So we start looking for the '@' after which the
192 * host will follow with the ' ' separator with the id.
194 * XXX FIXME: There is a case this code cannot handle:
195 * the user name cannot have blanks after a '@'.
197 if ((delimp1 = strchr(user, '@')) != NULL &&
198 (id = strchr(delimp1,' ')) != NULL)
200 for (delimp1 = id; delimp1 >= user; delimp1--)
201 if ((*delimp1 != ' ') && (*delimp1 != '\t'))
205 * It should be safe to assume that id starts after
206 * the " " - after all, we're writing the " "
207 * ourselves in write_saved_lists() :-)
209 id = id + strspn(id, " ");
211 delimp1++; /* but what if there is only white space ?!? */
212 /* we have at least one @, else we are not in this branch */
213 saveddelim1 = *delimp1; /* save char after token */
214 *delimp1 = '\0'; /* delimit token with \0 */
216 /* now remove trailing white space chars from id */
217 if ((delimp2 = strpbrk(id, " \t\n")) != NULL ) {
218 saveddelim2 = *delimp2;
222 atsign = strrchr(user, '@');
223 /* we have at least one @, else we are not in this branch */
227 /* find uidl db and save it */
228 for (ctl = hostlist; ctl; ctl = ctl->next) {
229 if (strcasecmp(host, ctl->server.queryname) == 0
230 && strcasecmp(user, ctl->remotename) == 0) {
231 uid_db_insert(&ctl->oldsaved, id, UID_SEEN);
236 * If it's not in a host we're querying,
237 * save it anyway. Otherwise we'd lose UIDL
238 * information any time we queried an explicit
241 if (ctl == (struct query *)NULL) {
243 *delimp1 = saveddelim1;
245 if (delimp2 != NULL) {
246 *delimp2 = saveddelim2;
248 save_str(&scratchlist, buf, UID_SEEN);
253 err |= fclose(tmpfp); /* not checking should be safe, mode was "r" */
254 /* bit-wise or, we only care about non-zero */
256 err = (errno != ENOENT);
259 report(stderr, GT_("Open or read error while reading idfile %s: %s\n"),
260 idfile, strerror(errno));
264 if (outlevel >= O_DEBUG)
268 for (ctl = hostlist; ctl; ctl = ctl->next)
270 report_build(stdout, GT_("Old UID list from %s:\n"),
271 ctl->server.pollname);
273 if (!uid_db_n_records(&ctl->oldsaved))
274 report_build(stdout, "%s\n", GT_(" <empty>"));
276 traverse_uid_db(&ctl->oldsaved, dump_saved_uid, NULL);
278 report_complete(stdout, "\n");
281 report_build(stdout, GT_("Scratch list of UIDs:\n"));
283 report_build(stdout, "%s\n", GT_(" <empty>"));
284 else for (idp = scratchlist; idp; idp = idp->next) {
285 char *t = sdump(idp->id, strlen(idp->id)-1);
286 report_build(stdout, " %s\n", t);
289 report_complete(stdout, "\n");
294 /** Assert that all UIDs marked deleted in query \a ctl have actually been
296 static int mark_as_expunged_if(struct uid_db_record *rec, void *unused)
300 if (rec->status == UID_DELETED) rec->status = UID_EXPUNGED;
304 void expunge_uids(struct query *ctl)
306 traverse_uid_db(dofastuidl ? &ctl->oldsaved : &ctl->newsaved,
307 mark_as_expunged_if, NULL);
310 static const char *str_uidmark(int mark)
324 if (snprintf(buf, sizeof(buf), "MARK=%d", mark) < 0)
331 static int dump_uid_db_record(struct uid_db_record *rec, void *arg)
336 n_recs = (unsigned int *)arg;
339 t = sdump(rec->id, rec->id_len);
340 report_build(stdout, " %s = %s\n", t, str_uidmark(rec->status));
346 static void dump_uid_db(struct uid_db *db)
350 n_recs = uid_db_n_records(db);
352 report_build(stdout, GT_(" <empty>"));
356 traverse_uid_db(db, dump_uid_db_record, &n_recs);
359 /** Finish a successful query */
360 void uid_swap_lists(struct query *ctl)
363 if (outlevel >= O_DEBUG)
366 report_build(stdout, GT_("Merged UID list from %s:\n"), ctl->server.pollname);
367 dump_uid_db(&ctl->oldsaved);
369 report_build(stdout, GT_("New UID list from %s:\n"), ctl->server.pollname);
370 dump_uid_db(&ctl->newsaved);
372 report_complete(stdout, "\n");
376 * Don't swap UID lists unless we've actually seen UIDLs.
377 * This is necessary in order to keep UIDL information
378 * from being heedlessly deleted later on.
380 * Older versions of fetchmail did
382 * free_str_list(&scratchlist);
384 * after swap. This was wrong; we need to preserve the UIDL information
385 * from unqueried hosts. Unfortunately, not doing this means that
386 * under some circumstances UIDLs can end up being stored forever --
387 * specifically, if a user description is removed from .fetchmailrc
388 * with UIDLs from that account in .fetchids, there is no way for
389 * them to ever get garbage-collected.
391 if (uid_db_n_records(&ctl->newsaved))
393 swap_uid_db_data(&ctl->newsaved, &ctl->oldsaved);
394 clear_uid_db(&ctl->newsaved);
396 /* in fast uidl, there is no need to swap lists: the old state of
397 * mailbox cannot be discarded! */
398 else if (outlevel >= O_DEBUG && !dofastuidl)
399 report(stdout, GT_("not swapping UID lists, no UIDs seen this query\n"));
402 /** Finish a query which had errors */
403 void uid_discard_new_list(struct query *ctl)
406 if (outlevel >= O_DEBUG)
408 /* this is now a merged list! the mails which were seen in this
409 * poll are marked here. */
410 report_build(stdout, GT_("Merged UID list from %s:\n"), ctl->server.pollname);
411 dump_uid_db(&ctl->oldsaved);
412 report_complete(stdout, "\n");
415 if (uid_db_n_records(&ctl->newsaved))
417 /* new state of mailbox is not reliable */
418 if (outlevel >= O_DEBUG)
419 report(stdout, GT_("discarding new UID list\n"));
420 clear_uid_db(&ctl->newsaved);
424 /** Reset the number associated with each id */
425 void uid_reset_num(struct query *ctl)
427 reset_uid_db_nums(&ctl->oldsaved);
430 /** Write list of seen messages, at end of run. */
431 static int count_seen_deleted(struct uid_db_record *rec, void *arg)
433 if (rec->status == UID_SEEN || rec->status == UID_DELETED)
438 struct write_saved_info {
443 static int write_uid_db_record(struct uid_db_record *rec, void *arg)
445 struct write_saved_info *info;
448 if (!(rec->status == UID_SEEN || rec->status == UID_DELETED))
451 info = (struct write_saved_info *)arg;
452 rc = fprintf(info->fp, "%s@%s %s\n",
453 info->ctl->remotename, info->ctl->server.queryname,
455 return rc < 0 ? -1 : 0;
458 /** Write new list of UIDs (state) to \a idfile. */
459 void write_saved_lists(struct query *hostlist, const char *idfile)
466 /* if all lists are empty, nuke the file */
468 for (ctl = hostlist; ctl; ctl = ctl->next)
469 traverse_uid_db(&ctl->oldsaved, count_seen_deleted, &idcount);
471 /* either nuke the file or write updated last-seen IDs */
472 if (!idcount && !scratchlist)
474 if (outlevel >= O_DEBUG) {
475 if (access(idfile, F_OK) == 0)
476 report(stdout, GT_("Deleting fetchids file.\n"));
478 if (unlink(idfile) && errno != ENOENT)
479 report(stderr, GT_("Error deleting %s: %s\n"), idfile, strerror(errno));
481 char *newnam = (char *)xmalloc(strlen(idfile) + 2);
483 strcpy(newnam, idfile);
485 if (outlevel >= O_DEBUG)
486 report(stdout, GT_("Writing fetchids file.\n"));
487 (void)unlink(newnam); /* remove file/link first */
488 old_umask = umask(S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH | S_IXOTH);
489 if ((tmpfp = fopen(newnam, "w")) != (FILE *)NULL) {
490 struct write_saved_info info;
495 for (ctl = hostlist; ctl; ctl = ctl->next) {
498 if (traverse_uid_db(&ctl->oldsaved, write_uid_db_record, &info) < 0) {
500 report(stderr, GT_("Write error on fetchids file %s: %s\n"), newnam, strerror(e));
506 for (idp = scratchlist; idp; idp = idp->next)
507 if (EOF == fputs(idp->id, tmpfp)) {
509 report(stderr, GT_("Write error on fetchids file %s: %s\n"), newnam, strerror(e));
515 (void)fflush(tmpfp); /* return code ignored, we check ferror instead */
516 errflg |= ferror(tmpfp);
517 errflg |= fclose(tmpfp);
518 /* if we could write successfully, move into place;
521 report(stderr, GT_("Error writing to fetchids file %s, old file left in place.\n"), newnam);
524 if (rename(newnam, idfile)) {
525 report(stderr, GT_("Cannot rename fetchids file %s to %s: %s\n"), newnam, idfile, strerror(errno));
529 report(stderr, GT_("Cannot open fetchids file %s for writing: %s\n"), newnam, strerror(errno));
532 (void)umask(old_umask);
535 #endif /* POP3_ENABLE */
537 /* uid.c ends here */