2 * driver.c -- generic driver for mail fetch method protocols
4 * Copyright 1997 by Eric S. Raymond
5 * For license terms, see the file COPYING in this directory.
15 #endif /* HAVE_MEMORY_H */
16 #if defined(STDC_HEADERS)
20 #if defined(HAVE_UNISTD_H)
23 #if defined(HAVE_SYS_ITIMER_H)
24 #include <sys/itimer.h>
27 #ifdef HAVE_SYS_WAIT_H
31 #ifdef HAVE_SYS_SOCKET_H
32 #include <sys/socket.h>
34 #ifdef HAVE_NET_SOCKET_H
35 #include <net/socket.h>
38 #ifdef HAVE_PKG_hesiod
46 #include <netinet/in.h>
47 #endif /* KERBEROS_V4 */
52 #include "fetchmail.h"
53 #include "getaddrinfo.h"
58 /* throw types for runtime errors */
59 #define THROW_TIMEOUT 1 /* server timed out */
61 /* magic values for the message length array */
62 #define MSGLEN_UNKNOWN 0 /* length unknown (0 is impossible) */
63 #define MSGLEN_INVALID -1 /* length passed back is invalid */
64 #define MSGLEN_TOOLARGE -2 /* message is too large */
65 #define MSGLEN_OLD -3 /* message is old */
67 int pass; /* how many times have we re-polled? */
68 int stage; /* where are we? */
69 int phase; /* where are we, for error-logging purposes? */
70 int batchcount; /* count of messages sent in current batch */
71 flag peek_capable; /* can we peek for better error recovery? */
72 int mailserver_socket_temp = -1; /* socket to free if connect timeout */
74 struct addrinfo *ai0, *ai1; /* clean these up after signal */
76 static volatile int timeoutcount = 0; /* count consecutive timeouts */
77 static volatile int idletimeout = 0; /* timeout occured in idle stage? */
79 static sigjmp_buf restart;
81 int is_idletimeout(void)
82 /* last timeout occured in idle stage? */
87 void resetidletimeout(void)
92 void set_timeout(int timeleft)
93 /* reset the nonresponse-timeout */
95 #if !defined(__EMX__) && !defined(__BEOS__)
96 struct itimerval ntimeout;
101 ntimeout.it_interval.tv_sec = ntimeout.it_interval.tv_usec = 0;
102 ntimeout.it_value.tv_sec = timeleft;
103 ntimeout.it_value.tv_usec = 0;
104 setitimer(ITIMER_REAL, &ntimeout, (struct itimerval *)NULL);
108 static RETSIGTYPE timeout_handler (int signal)
109 /* handle SIGALRM signal indicating a server timeout */
112 if(stage != STAGE_IDLE) {
114 /* XXX FIXME: this siglongjmp must die - it's not safe to be
115 * called from a function handler and breaks, for instance,
117 siglongjmp(restart, THROW_TIMEOUT);
122 #define CLEANUP_TIMEOUT 60 /* maximum timeout during cleanup */
124 static int cleanupSockClose (int fd)
125 /* close sockets in maximum CLEANUP_TIMEOUT seconds during cleanup */
128 SIGHANDLERTYPE alrmsave;
129 alrmsave = set_signal_handler(SIGALRM, null_signal_handler);
130 set_timeout(CLEANUP_TIMEOUT);
131 scerror = SockClose(fd);
133 set_signal_handler(SIGALRM, alrmsave);
138 static int kerberos_auth(socket, canonical, principal)
139 /* authenticate to the server host using Kerberos V4 */
140 int socket; /* socket to server host */
141 char *canonical; /* server name */
147 Key_schedule schedule;
149 char * prin_copy = (char *) NULL;
150 char * prin = (char *) NULL;
151 char * inst = (char *) NULL;
152 char * realm = (char *) NULL;
154 if (principal != (char *)NULL && *principal)
157 prin = prin_copy = xstrdup(principal);
158 for (cp = prin_copy; *cp && *cp != '.'; ++cp)
164 while (*cp && *cp != '@')
174 ticket = xmalloc(sizeof (KTEXT_ST));
175 rem = (krb_sendauth (0L, socket, ticket,
177 inst ? inst : canonical,
178 realm ? realm : ((char *) (krb_realmofhost (canonical))),
183 ((struct sockaddr_in *) 0),
184 ((struct sockaddr_in *) 0),
193 report(stderr, GT_("kerberos error %s\n"), (krb_get_err_text (rem)));
194 return (PS_AUTHFAIL);
198 #endif /* KERBEROS_V4 */
201 static int kerberos5_auth(socket, canonical)
202 /* authenticate to the server host using Kerberos V5 */
203 int socket; /* socket to server host */
204 const char *canonical; /* server name */
206 krb5_error_code retval;
207 krb5_context context;
209 krb5_principal client = NULL, server = NULL;
210 krb5_error *err_ret = NULL;
212 krb5_auth_context auth_context = NULL;
214 krb5_init_context(&context);
215 krb5_auth_con_init(context, &auth_context);
217 if ((retval = krb5_cc_default(context, &ccdef))) {
218 report(stderr, "krb5_cc_default: %s\n", error_message(retval));
222 if ((retval = krb5_cc_get_principal(context, ccdef, &client))) {
223 report(stderr, "krb5_cc_get_principal: %s\n", error_message(retval));
227 if ((retval = krb5_sname_to_principal(context, canonical, "pop",
230 report(stderr, "krb5_sname_to_principal: %s\n", error_message(retval));
234 retval = krb5_sendauth(context, &auth_context, (krb5_pointer) &socket,
235 "KPOPV1.0", client, server,
236 AP_OPTS_MUTUAL_REQUIRED,
237 NULL, /* no data to checksum */
238 0, /* no creds, use ccache instead */
242 NULL); /* don't need reply */
244 krb5_free_principal(context, server);
245 krb5_free_principal(context, client);
246 krb5_auth_con_free(context, auth_context);
250 if (err_ret && err_ret->e_text) {
251 char *t = err_ret->e_text;
252 char *tt = sdump(t, strlen(t));
253 report(stderr, GT_("krb5_sendauth: %s [server says '%s']\n"),
254 error_message(retval), tt);
257 if (err_ret && err_ret->text.length) {
258 char *tt = sdump(err_ret->text.data, err_ret->text.length);
259 report(stderr, GT_("krb5_sendauth: %s [server says '%s']\n"),
260 error_message(retval), tt);
263 krb5_free_error(context, err_ret);
265 report(stderr, "krb5_sendauth: %s\n", error_message(retval));
271 #endif /* KERBEROS_V5 */
273 static void clean_skipped_list(struct idlist **skipped_list)
274 /* struct "idlist" contains no "prev" ptr; we must remove unused items first */
276 struct idlist *current=NULL, *prev=NULL, *tmp=NULL, *head=NULL;
277 prev = current = head = *skipped_list;
283 /* if item has no reference, remove it */
284 if (current && current->val.status.mark == 0)
286 if (current == head) /* remove first item (head) */
288 head = current->next;
289 if (current->id) free(current->id);
291 prev = current = head;
293 else /* remove middle/last item */
297 if (current->id) free(current->id);
302 else /* skip this item */
305 current = current->next;
309 *skipped_list = head;
312 static void send_size_warnings(struct query *ctl)
313 /* send warning mail with skipped msg; reset msg count when user notified */
316 int msg_to_send = FALSE;
317 struct idlist *head=NULL, *current=NULL;
318 int max_warning_poll_count;
324 /* don't start a notification message unless we need to */
325 for (current = head; current; current = current->next)
326 if (current->val.status.num == 0 && current->val.status.mark)
332 * There's no good way to recover if we can't send notification mail,
333 * but it's not a disaster, either, since the skipped mail will not
336 if (open_warning_by_mail(ctl))
338 stuff_warning(iana_charset, ctl,
339 GT_("Subject: Fetchmail oversized-messages warning"));
340 stuff_warning(NULL, ctl, "%s", "");
342 stuff_warning(NULL, ctl,
343 GT_("The following oversized messages were deleted on server %s account %s:"),
344 ctl->server.pollname, ctl->remotename);
346 stuff_warning(NULL, ctl,
347 GT_("The following oversized messages remain on server %s account %s:"),
348 ctl->server.pollname, ctl->remotename);
350 stuff_warning(NULL, ctl, "%s", "");
352 if (run.poll_interval == 0)
353 max_warning_poll_count = 0;
355 max_warning_poll_count = ctl->warnings/run.poll_interval;
357 /* parse list of skipped msg, adding items to the mail */
358 for (current = head; current; current = current->next)
360 if (current->val.status.num == 0 && current->val.status.mark)
362 nbr = current->val.status.mark;
363 size = atoi(current->id);
365 stuff_warning(NULL, ctl,
366 ngettext(" %d message %d octets long deleted by fetchmail.",
367 " %d messages %d octets long deleted by fetchmail.", nbr),
370 stuff_warning(NULL, ctl,
371 ngettext(" %d message %d octets long skipped by fetchmail.",
372 " %d messages %d octets long skipped by fetchmail.", nbr),
375 current->val.status.num++;
376 current->val.status.mark = 0;
378 if (current->val.status.num >= max_warning_poll_count)
379 current->val.status.num = 0;
382 stuff_warning(NULL, ctl, "%s", "");
384 close_warning_by_mail(ctl, (struct msgblk *)NULL);
387 static void mark_oversized(struct query *ctl, int size)
388 /* mark a message oversized */
390 struct idlist *current=NULL, *tmp=NULL;
394 /* convert size to string */
395 snprintf(sizestr, sizeof(sizestr), "%d", size);
397 /* build a list of skipped messages
398 * val.id = size of msg (string cnvt)
399 * val.status.num = warning_poll_count
400 * val.status.mask = nbr of msg this size
403 current = ctl->skipped;
405 /* initialise warning_poll_count to the
406 * current value so that all new msg will
407 * be included in the next mail
409 cnt = current ? current->val.status.num : 0;
411 /* if entry exists, increment the count */
412 if (current && (tmp = str_in_list(¤t, sizestr, FALSE)))
414 tmp->val.status.mark++;
416 /* otherwise, create a new entry */
417 /* initialise with current poll count */
420 tmp = save_str(&ctl->skipped, sizestr, 1);
421 tmp->val.status.num = cnt;
425 static int eat_trailer(int sock, struct query *ctl)
427 /* we only need this LF if we're printing ticker dots
428 * AND we are dumping protocol traces. */
429 if (outlevel >= O_VERBOSE && want_progress()) fputc('\n', stdout);
430 return (ctl->server.base_protocol->trail)(sock, ctl, tag);
433 static int fetch_messages(int mailserver_socket, struct query *ctl,
434 int count, int **msgsizes, int maxfetch,
435 int *fetches, int *dispatches, int *deletions)
436 /* fetch messages in lockstep mode */
438 flag force_retrieval;
439 int num, firstnum = 1, lastnum = 0, err, len;
440 int fetchsizelimit = ctl->fetchsizelimit;
442 int initialfetches = *fetches;
444 if (ctl->server.base_protocol->getpartialsizes && NUM_NONZERO(fetchsizelimit))
446 /* for POP3, we can get the size of one mail only! Unfortunately, this
447 * protocol specific test cannot be done elsewhere as the protocol
448 * could be "auto". */
449 switch (ctl->server.protocol)
451 case P_POP3: case P_APOP: case P_RPOP:
455 /* Time to allocate memory to store the sizes */
457 *msgsizes = (int *)xmalloc(sizeof(int) * fetchsizelimit);
461 * What forces this code is that in POP2 and
462 * IMAP2bis you can't fetch a message without
463 * having it marked `seen'. In POP3 and IMAP4, on the
464 * other hand, you can (peek_capable is set by
465 * each driver module to convey this; it's not a
466 * method constant because of the difference between
467 * IMAP2bis and IMAP4, and because POP3 doesn't peek
468 * if fetchall is on).
470 * The result of being unable to peek is that if there's
471 * any kind of transient error (DNS lookup failure, or
472 * sendmail refusing delivery due to process-table limits)
473 * the message will be marked "seen" on the server without
474 * having been delivered. This is not a big problem if
475 * fetchmail is running in foreground, because the user
476 * will see a "skipped" message when it next runs and get
479 * But in daemon mode this leads to the message
480 * being silently ignored forever. This is not
483 * We compensate for this by checking the error
484 * count from the previous pass and forcing all
485 * messages to be considered new if it's nonzero.
487 force_retrieval = !peek_capable && (ctl->errcount > 0);
489 for (num = 1; num <= count; num++)
491 flag suppress_delete = FALSE;
492 flag suppress_forward = FALSE;
493 flag suppress_readbody = FALSE;
494 flag retained = FALSE;
495 int msgcode = MSGLEN_UNKNOWN;
497 /* check if the message is old
498 * Note: the size of the message may not be known here */
499 if (ctl->fetchall || force_retrieval) {
502 if (ctl->server.base_protocol->is_old && (ctl->server.base_protocol->is_old)(mailserver_socket,ctl,num)) {
503 msgcode = MSGLEN_OLD;
506 if (msgcode == MSGLEN_OLD)
508 /* To avoid flooding the syslog when using --keep,
509 * report "Skipped message" only when:
510 * 1) --verbose is on, or
511 * 2) fetchmail does not use syslog
513 if ( (outlevel >= O_VERBOSE) ||
514 (outlevel > O_SILENT && !run.use_syslog)
518 GT_("skipping message %s@%s:%d"),
519 ctl->remotename, ctl->server.truename, num);
525 if (ctl->server.base_protocol->getpartialsizes && NUM_NONZERO(fetchsizelimit) &&
528 /* Instead of getting the sizes of all mails at the start, we get
529 * the sizes in blocks of fetchsizelimit. This leads to better
530 * performance when there are too many mails (say, 10000) in
531 * the mailbox and either we are not getting all the mails at
532 * one go (--fetchlimit 100) or there is a frequent socket
533 * error while just getting the sizes of all mails! */
536 int oldstage = stage;
538 lastnum = num + fetchsizelimit - 1;
541 for (i = 0; i < fetchsizelimit; i++)
544 stage = STAGE_GETSIZES;
545 err = (ctl->server.base_protocol->getpartialsizes)(mailserver_socket, num, lastnum, *msgsizes);
552 msgsize = *msgsizes ? (*msgsizes)[num-firstnum] : 0;
554 /* check if the message is oversized */
555 if (NUM_NONZERO(ctl->limit) && (msgsize > ctl->limit))
556 msgcode = MSGLEN_TOOLARGE;
557 /* else if (msgsize == 512)
558 msgcode = MSGLEN_OLD; (hmh) sample code to skip message */
562 if (msgcode == MSGLEN_TOOLARGE)
564 mark_oversized(ctl, msgsize);
565 if (!ctl->limitflush)
566 suppress_delete = TRUE;
568 if (outlevel > O_SILENT)
570 /* old messages are already handled above */
572 GT_("skipping message %s@%s:%d (%d octets)"),
573 ctl->remotename, ctl->server.truename, num,
579 * Invalid lengths are produced by Post Office/NT's
580 * annoying habit of randomly prepending bogus
581 * LIST items of length -1. Patrick Audley
582 * <paudley@pobox.com> tells us: LIST shows a
583 * size of -1, RETR and TOP return "-ERR
584 * System error - couldn't open message", and
585 * DELE succeeds but doesn't actually delete
588 report_build(stdout, GT_(" (length -1)"));
590 case MSGLEN_TOOLARGE:
591 report_build(stdout, GT_(" (oversized)"));
598 /* XXX FIXME: make this one variable, wholesize and
599 separatefetchbody query the same variable just with
601 flag wholesize = !ctl->server.base_protocol->fetch_body;
602 flag separatefetchbody = (ctl->server.base_protocol->fetch_body) ? TRUE : FALSE;
604 /* request a message */
605 err = (ctl->server.base_protocol->fetch_headers)(mailserver_socket,ctl,num, &len);
606 if (err == PS_TRANSIENT) /* server is probably Exchange */
609 GT_("couldn't fetch headers, message %s@%s:%d (%d octets)\n"),
610 ctl->remotename, ctl->server.truename, num,
617 /* -1 means we didn't see a size in the response */
624 if (outlevel > O_SILENT)
626 report_build(stdout, GT_("reading message %s@%s:%d of %d"),
627 ctl->remotename, ctl->server.truename,
631 report_build(stdout, wholesize ? GT_(" (%d octets)")
632 : GT_(" (%d header octets)"), len);
633 if (want_progress()) {
634 /* flush and add a blank to append ticker dots */
635 report_flush(stdout);
641 * Read the message headers and ship them to the
644 err = readheaders(mailserver_socket, len, msgsize,
646 /* pass the suppress_readbody flag only if the underlying
647 * protocol does not fetch the body separately */
648 separatefetchbody ? 0 : &suppress_readbody);
650 if (err == PS_RETAINED)
651 suppress_forward = suppress_delete = retained = TRUE;
652 else if (err == PS_TRANSIENT)
653 suppress_delete = suppress_forward = TRUE;
654 else if (err == PS_REFUSED)
655 suppress_forward = TRUE;
659 /* tell server we got it OK and resynchronize */
660 if (separatefetchbody && ctl->server.base_protocol->trail)
662 err = eat_trailer(mailserver_socket, ctl);
663 if (err) return(err);
666 /* do not read the body which is not being forwarded only if
667 * the underlying protocol allows the body to be fetched
669 if (separatefetchbody && suppress_forward)
670 suppress_readbody = TRUE;
673 * If we're using IMAP4 or something else that
674 * can fetch headers separately from bodies,
675 * it's time to request the body now. This
676 * fetch may be skipped if we got an anti-spam
677 * or other PS_REFUSED error response during
680 if (!suppress_readbody)
682 if (separatefetchbody)
685 if ((err=(ctl->server.base_protocol->fetch_body)(mailserver_socket,ctl,num,&len)))
688 * Work around a bug in Novell's
689 * broken GroupWise IMAP server;
690 * its body FETCH response is missing
691 * the required length for the data
692 * string. This violates RFC2060.
695 len = msgsize - msgblk.msglen;
697 if (outlevel > O_SILENT)
699 GT_(" (%d body octets)"), len);
700 if (want_progress()) {
701 report_flush(stdout);
707 /* process the body now */
708 err = readbody(mailserver_socket,
713 if (err == PS_TRANSIENT)
714 suppress_delete = suppress_forward = TRUE;
718 /* tell server we got it OK and resynchronize */
719 if (ctl->server.base_protocol->trail) {
720 err = eat_trailer(mailserver_socket, ctl);
721 if (err) return(err);
725 /* count # messages forwarded on this pass */
726 if (!suppress_forward)
730 * Check to see if the numbers matched?
732 * Yes, some servers foo this up horribly.
733 * All IMAP servers seem to get it right, and
734 * so does Eudora QPOP at least in 2.xx
737 * Microsoft Exchange gets it completely
738 * wrong, reporting compressed rather than
739 * actual sizes (so the actual length of
740 * message is longer than the reported size).
741 * Another fine example of Microsoft brain death!
743 * Some older POP servers, like the old UCB
744 * POP server and the pre-QPOP QUALCOMM
745 * versions, report a longer size in the LIST
746 * response than actually gets shipped up.
747 * It's unclear what is going on here, as the
748 * QUALCOMM server (at least) seems to be
749 * reporting the on-disk size correctly.
751 * qmail-pop3d also goofs up message sizes and does not
752 * count the line end characters properly.
754 if (msgblk.msglen != msgsize)
756 if (outlevel >= O_DEBUG)
758 GT_("message %s@%s:%d was not the expected length (%d actual != %d expected)\n"),
759 ctl->remotename, ctl->server.truename, num,
760 msgblk.msglen, msgsize);
763 /* end-of-message processing starts here */
764 if (!close_sink(ctl, &msgblk, !suppress_forward))
767 suppress_delete = TRUE;
775 * At this point in flow of control,
776 * either we've bombed on a protocol error
777 * or had delivery refused by the SMTP server
778 * or we've seen `accepted for delivery' and the message is shipped.
779 * It's safe to mark the message seen and delete it on the server now.
782 /* in softbounce mode, suppress deletion and marking as seen */
783 if (suppress_forward)
784 suppress_delete = suppress_delete || run.softbounce;
786 /* maybe we delete this message now? */
789 if (outlevel > O_SILENT)
790 report_complete(stdout, GT_(" retained\n"));
792 else if (ctl->server.base_protocol->delete_msg
794 && ((msgcode >= 0 && !ctl->keep)
795 || (msgcode == MSGLEN_OLD && ctl->flush)
796 || (msgcode == MSGLEN_TOOLARGE && ctl->limitflush)))
799 if (outlevel > O_SILENT)
800 report_complete(stdout, GT_(" flushed\n"));
801 err = (ctl->server.base_protocol->delete_msg)(mailserver_socket, ctl, num);
807 if ( (outlevel >= O_VERBOSE) ||
808 /* To avoid flooding the syslog when using --keep,
809 * report "Skipped message" only when:
810 * 1) --verbose is on, or
811 * 2) fetchmail does not use syslog, or
812 * 3) the message was skipped for some other
813 * reason than just being old.
815 (outlevel > O_SILENT && (!run.use_syslog || msgcode != MSGLEN_OLD))
817 report_complete(stdout, GT_(" not flushed\n"));
819 /* maybe we mark this message as seen now? */
820 if (ctl->server.base_protocol->mark_seen
822 && (msgcode >= 0 && ctl->keep))
824 err = (ctl->server.base_protocol->mark_seen)(mailserver_socket, ctl, num);
830 /* perhaps this as many as we're ready to handle */
831 if (maxfetch && maxfetch <= *fetches && num < count)
833 int remcount = count - (*fetches - initialfetches);
835 ngettext("fetchlimit %d reached; %d message left on server %s account %s\n",
836 "fetchlimit %d reached; %d messages left on server %s account %s\n", remcount),
837 maxfetch, remcount, ctl->server.truename, ctl->remotename);
840 } /* for (num = 1; num <= count; num++) */
845 /* retrieve messages from server using given protocol method table */
846 static int do_session(
847 /* parsed options with merged-in defaults */
849 /* protocol method table */
850 const struct method *proto,
851 /* maximum number of messages to fetch */
854 static int *msgsizes;
855 volatile int err, mailserver_socket = -1; /* pacifies -Wall */
857 int deletions = 0, js;
859 SIGHANDLERTYPE alrmsave;
861 ctl->server.base_protocol = proto;
866 init_transact(proto);
868 /* set up the server-nonresponse timeout */
869 alrmsave = set_signal_handler(SIGALRM, timeout_handler);
870 mytimeout = ctl->server.timeout;
872 if ((js = sigsetjmp(restart,1)))
874 /* exception caught */
877 sigfillset(&allsigs);
878 sigprocmask(SIG_UNBLOCK, &allsigs, NULL);
881 fm_freeaddrinfo(ai0); ai0 = NULL;
885 fm_freeaddrinfo(ai1); ai1 = NULL;
888 if (js == THROW_TIMEOUT)
890 if (phase == OPEN_WAIT)
892 GT_("timeout after %d seconds waiting to connect to server %s.\n"),
893 ctl->server.timeout, ctl->server.pollname);
894 else if (phase == SERVER_WAIT)
896 GT_("timeout after %d seconds waiting for server %s.\n"),
897 ctl->server.timeout, ctl->server.pollname);
898 else if (phase == FORWARDING_WAIT)
900 GT_("timeout after %d seconds waiting for %s.\n"),
902 ctl->mda ? "MDA" : "SMTP");
903 else if (phase == LISTENER_WAIT)
905 GT_("timeout after %d seconds waiting for listener to respond.\n"), ctl->server.timeout);
908 GT_("timeout after %d seconds.\n"), ctl->server.timeout);
911 * If we've exceeded our threshold for consecutive timeouts,
912 * try to notify the user, then mark the connection wedged.
913 * Don't do this if the connection can idle, though; idle
914 * timeouts just mean the frequency of mail is low.
916 if (timeoutcount > MAX_TIMEOUTS
917 && !open_warning_by_mail(ctl))
919 stuff_warning(iana_charset, ctl,
920 GT_("Subject: fetchmail sees repeated timeouts"));
921 stuff_warning(NULL, ctl, "%s", "");
922 stuff_warning(NULL, ctl,
923 GT_("Fetchmail saw more than %d timeouts while attempting to get mail from %s@%s.\n"),
925 ctl->remotename, ctl->server.truename);
926 stuff_warning(NULL, ctl,
927 GT_("This could mean that your mailserver is stuck, or that your SMTP\n" \
928 "server is wedged, or that your mailbox file on the server has been\n" \
929 "corrupted by a server error. You can run `fetchmail -v -v' to\n" \
930 "diagnose the problem.\n\n" \
931 "Fetchmail won't poll this mailbox again until you restart it.\n"));
932 close_warning_by_mail(ctl, (struct msgblk *)NULL);
942 /* sigsetjmp returned zero -> normal operation */
943 char buf[MSGBUFSIZE+1], *realhost;
944 int count, newm, bytes;
945 int fetches, dispatches, oldphase;
948 /* execute pre-initialization command, if any */
949 if (ctl->preconnect && (err = system(ctl->preconnect)))
951 if (WIFSIGNALED(err))
953 GT_("pre-connection command terminated with signal %d\n"), WTERMSIG(err));
956 GT_("pre-connection command failed with status %d\n"), WEXITSTATUS(err));
961 /* open a socket to the mail server */
964 set_timeout(mytimeout);
966 #ifdef HAVE_PKG_hesiod
967 /* If either the pollname or vianame are "hesiod" we want to
968 lookup the user's hesiod pobox host */
969 if (!strcasecmp(ctl->server.queryname, "hesiod")) {
970 struct hes_postoffice *hes_p;
971 hes_p = hes_getmailhost(ctl->remotename);
972 if (hes_p != NULL && strcmp(hes_p->po_type, "POP") == 0) {
973 free(ctl->server.queryname);
974 ctl->server.queryname = xstrdup(hes_p->po_host);
976 free(ctl->server.via);
977 ctl->server.via = xstrdup(hes_p->po_host);
980 GT_("couldn't find HESIOD pobox for %s\n"),
987 * Canonicalize the server truename for later use. This also
988 * functions as a probe for whether the mailserver is accessible.
989 * We try it on each poll cycle until we get a result. This way,
990 * fetchmail won't fail if started up when the network is inaccessible.
992 if (ctl->server.dns && !ctl->server.trueaddr)
994 if (ctl->server.lead_server)
996 char *leadname = ctl->server.lead_server->truename;
998 /* prevent core dump from ill-formed or duplicate entry */
1001 report(stderr, GT_("Lead server has no name.\n"));
1008 xfree(ctl->server.truename);
1009 ctl->server.truename = xstrdup(leadname);
1013 struct addrinfo hints, *res;
1016 memset(&hints, 0, sizeof(hints));
1017 hints.ai_socktype = SOCK_STREAM;
1018 hints.ai_family = AF_UNSPEC;
1019 hints.ai_flags = AI_CANONNAME;
1020 #ifdef AI_ADDRCONFIG
1021 hints.ai_flags |= AI_ADDRCONFIG;
1024 error = fm_getaddrinfo(ctl->server.queryname, NULL, &hints, &res);
1028 GT_("couldn't find canonical DNS name of %s (%s): %s\n"),
1029 ctl->server.pollname, ctl->server.queryname,
1030 gai_strerror(error));
1038 xfree(ctl->server.truename);
1039 /* Older FreeBSD versions return NULL in ai_canonname
1040 * if they cannot canonicalize, rather than copying
1041 * the queryname here, as IEEE Std 1003.1-2001
1042 * requires. Work around NULL. */
1043 if (res->ai_canonname != NULL) {
1044 ctl->server.truename = xstrdup(res->ai_canonname);
1046 ctl->server.truename = xstrdup(ctl->server.queryname);
1048 ctl->server.trueaddr = (struct sockaddr *)xmalloc(res->ai_addrlen);
1049 ctl->server.trueaddr_len = res->ai_addrlen;
1050 memcpy(ctl->server.trueaddr, res->ai_addr, res->ai_addrlen);
1051 fm_freeaddrinfo(res);
1056 realhost = ctl->server.via ? ctl->server.via : ctl->server.pollname;
1058 /* allow time for the port to be set up if we have a plugin */
1059 if (ctl->server.plugin)
1061 if ((mailserver_socket = SockOpen(realhost,
1062 ctl->server.service ? ctl->server.service : ( ctl->use_ssl ? ctl->server.base_protocol->sslservice : ctl->server.base_protocol->service ),
1063 ctl->server.plugin, &ai0)) == -1)
1065 char errbuf[BUFSIZ];
1068 * Avoid generating a bogus error every poll cycle when we're
1069 * in daemon mode but the connection to the outside world
1072 if (!((err_no == EHOSTUNREACH || err_no == ENETUNREACH)
1073 && run.poll_interval))
1075 report_build(stderr, GT_("%s connection to %s failed"),
1076 ctl->server.base_protocol->name, ctl->server.pollname);
1077 strlcpy(errbuf, strerror(err_no), sizeof(errbuf));
1078 report_complete(stderr, ": %s\n", errbuf);
1082 * Don't use this. It was an attempt to address Debian bug
1083 * #47143 (Notify user by mail when pop server nonexistent).
1084 * Trouble is, that doesn't work; you trip over the case
1085 * where your SLIP or PPP link is down...
1087 /* warn the system administrator */
1088 if (open_warning_by_mail(ctl) == 0)
1090 stuff_warning(iana_charset, ctl,
1091 GT_("Subject: Fetchmail unreachable-server warning."));
1092 stuff_warning(NULL, ctl, "");
1093 stuff_warning(NULL, ctl, GT_("Fetchmail could not reach the mail server %s:"),
1094 ctl->server.pollname);
1095 stuff_warning(NULL, ctl, errbuf, ctl->server.pollname);
1096 close_warning_by_mail(ctl, (struct msgblk *)NULL);
1107 /* Save the socket opened. Useful if Fetchmail hangs on SSLOpen
1108 * because the socket can be closed.
1110 mailserver_socket_temp = mailserver_socket;
1111 set_timeout(mytimeout);
1113 /* perform initial SSL handshake on open connection */
1115 SSLOpen(mailserver_socket, ctl->sslcert, ctl->sslkey,
1116 ctl->sslproto, ctl->sslcertck,
1117 ctl->sslcertfile, ctl->sslcertpath,
1118 ctl->sslfingerprint, ctl->sslcommonname ?
1119 ctl->sslcommonname : realhost, ctl->server.pollname,
1120 &ctl->remotename) == -1)
1122 report(stderr, GT_("SSL connection failed.\n"));
1127 /* Fetchmail didn't hang on SSLOpen,
1128 * then no need to set mailserver_socket_temp
1130 mailserver_socket_temp = -1;
1133 /* A timeout is still defined before SSLOpen,
1134 * then Fetchmail hanging on SSLOpen is handled.
1139 if (ctl->server.authenticate == A_KERBEROS_V4 && (strcasecmp(proto->name,"IMAP") != 0))
1141 set_timeout(mytimeout);
1142 err = kerberos_auth(mailserver_socket, ctl->server.truename,
1143 ctl->server.principal);
1148 #endif /* KERBEROS_V4 */
1151 if (ctl->server.authenticate == A_KERBEROS_V5)
1153 set_timeout(mytimeout);
1154 err = kerberos5_auth(mailserver_socket, ctl->server.truename);
1159 #endif /* KERBEROS_V5 */
1161 /* accept greeting message from mail server */
1162 err = (ctl->server.base_protocol->parse_response)(mailserver_socket, buf);
1166 /* try to get authorized to fetch mail */
1167 stage = STAGE_GETAUTH;
1168 if (ctl->server.base_protocol->getauth)
1170 set_timeout(mytimeout);
1171 err = (ctl->server.base_protocol->getauth)(mailserver_socket, ctl, buf);
1176 if (err == PS_LOCKBUSY)
1177 report(stderr, GT_("Lock-busy error on %s@%s\n"),
1179 ctl->server.truename);
1180 else if (err == PS_SERVBUSY)
1181 report(stderr, GT_("Server busy error on %s@%s\n"),
1183 ctl->server.truename);
1184 else if (err == PS_AUTHFAIL)
1186 report(stderr, GT_("Authorization failure on %s@%s%s\n"),
1188 ctl->server.truename,
1189 (ctl->wehaveauthed ? GT_(" (previously authorized)") : "")
1193 * If we're running in background, try to mail the
1194 * calling user a heads-up about the authentication
1195 * failure once it looks like this isn't a fluke
1196 * due to the server being temporarily inaccessible.
1197 * When we get third succesive failure, we notify the user
1198 * but only if we haven't already managed to get
1199 * authorization. After that, once we get authorization
1200 * we let the user know service is restored.
1202 if (run.poll_interval
1203 && !ctl->wehavesentauthnote
1204 && ((ctl->wehaveauthed && ++ctl->authfailcount >= 10)
1205 || (!ctl->wehaveauthed && ++ctl->authfailcount >= 3))
1206 && !open_warning_by_mail(ctl))
1208 ctl->wehavesentauthnote = 1;
1209 stuff_warning(iana_charset, ctl,
1210 GT_("Subject: fetchmail authentication failed on %s@%s"),
1211 ctl->remotename, ctl->server.truename);
1212 stuff_warning(NULL, ctl, "%s", "");
1213 stuff_warning(NULL, ctl,
1214 GT_("Fetchmail could not get mail from %s@%s.\n"),
1216 ctl->server.truename);
1217 if (ctl->wehaveauthed) {
1218 stuff_warning(NULL, ctl, GT_("\
1219 The attempt to get authorization failed.\n\
1220 Since we have already succeeded in getting authorization for this\n\
1221 connection, this is probably another failure mode (such as busy server)\n\
1222 that fetchmail cannot distinguish because the server didn't send a useful\n\
1224 stuff_warning(NULL, ctl, GT_("\
1226 However, if you HAVE changed your account details since starting the\n\
1227 fetchmail daemon, you need to stop the daemon, change your configuration\n\
1228 of fetchmail, and then restart the daemon.\n\
1230 The fetchmail daemon will continue running and attempt to connect\n\
1231 at each cycle. No future notifications will be sent until service\n\
1234 stuff_warning(NULL, ctl, GT_("\
1235 The attempt to get authorization failed.\n\
1236 This probably means your password is invalid, but some servers have\n\
1237 other failure modes that fetchmail cannot distinguish from this\n\
1238 because they don't send useful error messages on login failure.\n\
1240 The fetchmail daemon will continue running and attempt to connect\n\
1241 at each cycle. No future notifications will be sent until service\n\
1244 close_warning_by_mail(ctl, (struct msgblk *)NULL);
1247 else if (err == PS_REPOLL)
1249 if (outlevel >= O_VERBOSE)
1250 report(stderr, GT_("Repoll immediately on %s@%s\n"),
1252 ctl->server.truename);
1255 report(stderr, GT_("Unknown login or authentication error on %s@%s\n"),
1257 ctl->server.truename);
1264 * This connection has given us authorization at least once.
1266 * There are dodgy server (clubinternet.fr for example) that
1267 * give spurious authorization failures on patently good
1268 * account/password details, then 5 minutes later let you in!
1270 * This is meant to build in some tolerance of such nasty bits
1273 ctl->wehaveauthed = 1;
1274 /*if (ctl->authfailcount >= 3)*/
1275 if (ctl->wehavesentauthnote)
1277 ctl->wehavesentauthnote = 0;
1279 GT_("Authorization OK on %s@%s\n"),
1281 ctl->server.truename);
1282 if (!open_warning_by_mail(ctl))
1284 stuff_warning(iana_charset, ctl,
1285 GT_("Subject: fetchmail authentication OK on %s@%s"),
1286 ctl->remotename, ctl->server.truename);
1287 stuff_warning(NULL, ctl, "%s", "");
1288 stuff_warning(NULL, ctl,
1289 GT_("Fetchmail was able to log into %s@%s.\n"),
1291 ctl->server.truename);
1292 stuff_warning(NULL, ctl,
1293 GT_("Service has been restored.\n"));
1294 close_warning_by_mail(ctl, (struct msgblk *)NULL);
1299 * Reporting only after the first three
1300 * consecutive failures, or ten consecutive
1301 * failures after we have managed to get
1304 ctl->authfailcount = 0;
1308 ctl->errcount = fetches = 0;
1310 /* now iterate over each folder selected */
1311 for (idp = ctl->mailboxes; idp; idp = idp->next)
1313 ctl->folder = idp->id;
1319 /* reset timeout, in case we did an IDLE */
1320 mytimeout = ctl->server.timeout;
1322 if (outlevel >= O_DEBUG)
1325 report(stdout, GT_("selecting or re-polling folder %s\n"), idp->id);
1327 report(stdout, GT_("selecting or re-polling default folder\n"));
1330 /* compute # of messages and number of new messages waiting */
1331 stage = STAGE_GETRANGE;
1332 err = (ctl->server.base_protocol->getrange)(mailserver_socket, ctl, idp->id, &count, &newm, &bytes);
1336 /* show user how many messages we downloaded */
1338 (void) snprintf(buf, sizeof(buf),
1339 GT_("%s at %s (folder %s)"),
1340 ctl->remotename, ctl->server.pollname, idp->id);
1342 (void) snprintf(buf, sizeof(buf), GT_("%s at %s"),
1343 ctl->remotename, ctl->server.pollname);
1344 if (outlevel > O_SILENT)
1346 if (count == -1) /* only used for ETRN */
1347 report(stdout, GT_("Polling %s\n"), ctl->server.truename);
1348 else if (count != 0)
1350 if (newm != -1 && (count - newm) > 0)
1351 report_build(stdout, ngettext("%d message (%d %s) for %s", "%d messages (%d %s) for %s", (unsigned long)count),
1354 ngettext("seen", "seen", (unsigned long)count-newm),
1357 report_build(stdout, ngettext("%d message for %s",
1358 "%d messages for %s",
1362 report_complete(stdout, ".\n");
1364 report_complete(stdout, GT_(" (%d octets).\n"), bytes);
1368 /* these are pointless in normal daemon mode */
1369 if (pass == 1 && (run.poll_interval == 0 || outlevel >= O_VERBOSE))
1370 report(stdout, GT_("No mail for %s\n"), buf);
1374 /* very important, this is where we leave the do loop */
1380 if (newm == -1 || ctl->fetchall)
1382 fetches = newm; /* set error status correctly */
1384 * There used to be a `goto noerror' here, but this
1385 * prevented checking of multiple folders. This
1386 * comment is a reminder in case I introduced some
1387 * subtle bug by removing it...
1395 * Don't trust the message count passed by the server.
1396 * Without this check, it might be possible to do a
1397 * DNS-spoofing attack that would pass back a ridiculous
1398 * count, and allocate a malloc area that would overlap
1399 * a portion of the stack.
1401 if ((unsigned)count > INT_MAX/sizeof(int))
1403 report(stderr, GT_("bogus message count!"));
1409 * We need the size of each message before it's
1410 * loaded in order to pass it to the ESMTP SIZE
1411 * option. If the protocol has a getsizes method,
1412 * we presume this means it doesn't get reliable
1413 * sizes from message fetch responses.
1415 * If the protocol supports getting sizes of subset of
1416 * messages, we skip this step now.
1418 if (proto->getsizes &&
1419 !(proto->getpartialsizes && NUM_NONZERO(ctl->fetchsizelimit)))
1422 msgsizes = (int *)xmalloc(sizeof(int) * count);
1423 for (i = 0; i < count; i++)
1426 stage = STAGE_GETSIZES;
1427 err = (proto->getsizes)(mailserver_socket, count, msgsizes);
1434 for (i = 0; i < count; i++)
1435 bytes += msgsizes[i];
1439 /* read, forward, and delete messages */
1440 stage = STAGE_FETCH;
1442 /* fetch in lockstep mode */
1443 err = fetch_messages(mailserver_socket, ctl,
1446 &fetches, &dispatches, &deletions);
1447 if (err != PS_SUCCESS && err != PS_MAXFETCH)
1450 if (!check_only && ctl->skipped
1451 && run.poll_interval > 0 && !nodetach)
1453 clean_skipped_list(&ctl->skipped);
1454 send_size_warnings(ctl);
1458 /* end-of-mailbox processing before we repoll or switch to another one */
1459 if (ctl->server.base_protocol->end_mailbox_poll)
1461 tmperr = (ctl->server.base_protocol->end_mailbox_poll)(mailserver_socket, ctl);
1467 /* Return now if we have reached the fetchlimit */
1468 if (maxfetch && maxfetch <= fetches)
1472 * Only repoll if we either had some actual forwards
1473 * or are idling for new mails and had no errors.
1474 * Otherwise it is far too easy to get into infinite loops.
1476 (ctl->server.base_protocol->retry && (dispatches || ctl->idle) && !ctl->errcount);
1479 /* XXX: From this point onwards, preserve err unless a new error has occurred */
1482 /* PS_SUCCESS, PS_MAXFETCH: ordinary termination with no errors -- officially log out */
1483 stage = STAGE_LOGOUT;
1484 tmperr = (ctl->server.base_protocol->logout_cmd)(mailserver_socket, ctl);
1485 if (tmperr != PS_SUCCESS)
1488 * Hmmmm...arguably this would be incorrect if we had fetches but
1489 * no dispatches (due to oversized messages, etc.)
1491 else if (err == PS_SUCCESS && fetches == 0)
1494 * Close all SMTP delivery sockets. For optimum performance
1495 * we'd like to hold them open til end of run, but (1) this
1496 * loses if our poll interval is longer than the MTA's
1497 * inactivity timeout, and (2) some MTAs (like smail) don't
1498 * deliver after each message, but rather queue up mail and
1499 * wait to actually deliver it until the input socket is
1502 * don't send QUIT for ODMR case because we're acting as a
1503 * proxy between the SMTP server and client.
1505 smtp_close(ctl, ctl->server.protocol != P_ODMR);
1506 cleanupSockClose(mailserver_socket);
1510 /* we only get here on error */
1511 if (err != 0 && err != PS_SOCKET && err != PS_REPOLL)
1513 stage = STAGE_LOGOUT;
1514 (ctl->server.base_protocol->logout_cmd)(mailserver_socket, ctl);
1517 /* try to clean up all streams */
1520 * Sending SMTP QUIT on signal is theoretically nice, but led
1521 * to a subtle bug. If fetchmail was terminated by signal
1522 * while it was shipping message text, it would hang forever
1523 * waiting for a command acknowledge. In theory we could
1524 * enable the QUIT only outside of the message send. In
1525 * practice, we don't care. All mailservers hang up on a
1526 * dropped TCP/IP connection anyway.
1529 if (mailserver_socket != -1) {
1530 cleanupSockClose(mailserver_socket);
1532 /* If there was a connect timeout, the socket should be closed.
1533 * mailserver_socket_temp contains the socket to close.
1535 if (mailserver_socket_temp != -1) {
1536 cleanupSockClose(mailserver_socket_temp);
1537 mailserver_socket_temp = -1;
1541 /* no report on PS_AUTHFAIL */
1546 msg = GT_("socket");
1549 msg = GT_("missing or bad RFC822 header");
1555 msg = GT_("client/server synchronization");
1558 msg = GT_("client/server protocol");
1561 msg = GT_("lock busy on server");
1564 msg = GT_("SMTP transaction");
1567 msg = GT_("DNS lookup");
1570 msg = GT_("undefined");
1574 if (phase == FORWARDING_WAIT || phase == LISTENER_WAIT
1576 report(stderr, GT_("%s error while fetching from %s@%s and delivering to SMTP host %s\n"),
1577 msg, ctl->remotename, ctl->server.pollname,
1578 ctl->smtphost ? ctl->smtphost : GT_("unknown"));
1580 report(stderr, GT_("%s error while fetching from %s@%s\n"),
1581 msg, ctl->remotename, ctl->server.pollname);
1588 /* execute wrapup command, if any */
1589 if (ctl->postconnect && (tmperr = system(ctl->postconnect)))
1591 if (WIFSIGNALED(tmperr))
1592 report(stderr, GT_("post-connection command terminated with signal %d\n"), WTERMSIG(tmperr));
1594 report(stderr, GT_("post-connection command failed with status %d\n"), WEXITSTATUS(tmperr));
1595 if (err == PS_SUCCESS)
1599 set_timeout(0); /* cancel any pending alarm */
1600 set_signal_handler(SIGALRM, alrmsave);
1604 /** retrieve messages from server using given protocol method table */
1605 int do_protocol(struct query *ctl /** parsed options with merged-in defaults */,
1606 const struct method *proto /** protocol method table */)
1611 if (ctl->server.authenticate == A_KERBEROS_V4)
1613 report(stderr, GT_("Kerberos V4 support not linked.\n"));
1616 #endif /* KERBEROS_V4 */
1619 if (ctl->server.authenticate == A_KERBEROS_V5)
1621 report(stderr, GT_("Kerberos V5 support not linked.\n"));
1624 #endif /* KERBEROS_V5 */
1626 /* lacking methods, there are some options that may fail */
1629 /* check for unsupported options */
1632 GT_("Option --flush is not supported with %s\n"),
1636 else if (ctl->fetchall) {
1638 GT_("Option --all is not supported with %s\n"),
1643 if (!(proto->getsizes || proto->getpartialsizes)
1644 && NUM_SPECIFIED(ctl->limit))
1647 GT_("Option --limit is not supported with %s\n"),
1653 * If no expunge limit or we do expunges within the driver,
1654 * then just do one session, passing in any fetchlimit.
1656 if ((ctl->keep && !ctl->flush) ||
1657 proto->retry || !NUM_SPECIFIED(ctl->expunge))
1658 return(do_session(ctl, proto, NUM_VALUE_OUT(ctl->fetchlimit)));
1660 * There's an expunge limit, and it isn't handled in the driver itself.
1661 * OK; do multiple sessions, each fetching a limited # of messages.
1662 * Stop if the total count of retrieved messages exceeds ctl->fetchlimit
1663 * (if it was nonzero).
1669 int expunge = NUM_VALUE_OUT(ctl->expunge);
1670 int fetchlimit = NUM_VALUE_OUT(ctl->fetchlimit);
1673 if (fetchlimit > 0 && (expunge == 0 || expunge > fetchlimit - totalcount))
1674 expunge = fetchlimit - totalcount;
1675 err = do_session(ctl, proto, expunge);
1676 totalcount += expunge;
1677 if (NUM_SPECIFIED(ctl->fetchlimit) && totalcount >= fetchlimit)
1679 if (err != PS_LOCKBUSY)
1681 else if (lockouts >= MAX_LOCKOUTS)
1683 else /* err == PS_LOCKBUSY */
1686 * Allow time for the server lock to release. if we
1687 * don't do this, we'll often hit a locked-mailbox
1688 * condition and fail.
1694 (err == PS_MAXFETCH || err == PS_LOCKBUSY);
1701 /* driver.c ends here */