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
52 #include <netinet/in.h>
53 #endif /* KERBEROS_V4 */
58 #include "fetchmail.h"
59 #include "getaddrinfo.h"
64 /* throw types for runtime errors */
65 #define THROW_TIMEOUT 1 /* server timed out */
67 /* magic values for the message length array */
68 #define MSGLEN_UNKNOWN 0 /* length unknown (0 is impossible) */
69 #define MSGLEN_INVALID -1 /* length passed back is invalid */
70 #define MSGLEN_TOOLARGE -2 /* message is too large */
71 #define MSGLEN_OLD -3 /* message is old */
73 int pass; /* how many times have we re-polled? */
74 int stage; /* where are we? */
75 int phase; /* where are we, for error-logging purposes? */
76 int batchcount; /* count of messages sent in current batch */
77 flag peek_capable; /* can we peek for better error recovery? */
78 int mailserver_socket_temp = -1; /* socket to free if connect timeout */
80 struct addrinfo *ai0, *ai1; /* clean these up after signal */
82 static volatile int timeoutcount = 0; /* count consecutive timeouts */
83 static volatile int idletimeout = 0; /* timeout occured in idle stage? */
85 static sigjmp_buf restart;
87 int is_idletimeout(void)
88 /* last timeout occured in idle stage? */
93 void resetidletimeout(void)
98 void set_timeout(int timeleft)
99 /* reset the nonresponse-timeout */
101 #if !defined(__EMX__) && !defined(__BEOS__)
102 struct itimerval ntimeout;
107 ntimeout.it_interval.tv_sec = ntimeout.it_interval.tv_usec = 0;
108 ntimeout.it_value.tv_sec = timeleft;
109 ntimeout.it_value.tv_usec = 0;
110 setitimer(ITIMER_REAL, &ntimeout, (struct itimerval *)NULL);
114 static RETSIGTYPE timeout_handler (int signal)
115 /* handle SIGALRM signal indicating a server timeout */
118 if(stage != STAGE_IDLE) {
120 /* XXX FIXME: this siglongjmp must die - it's not safe to be
121 * called from a function handler and breaks, for instance,
123 siglongjmp(restart, THROW_TIMEOUT);
128 #define CLEANUP_TIMEOUT 60 /* maximum timeout during cleanup */
130 static int cleanupSockClose (int fd)
131 /* close sockets in maximum CLEANUP_TIMEOUT seconds during cleanup */
134 SIGHANDLERTYPE alrmsave;
135 alrmsave = set_signal_handler(SIGALRM, null_signal_handler);
136 set_timeout(CLEANUP_TIMEOUT);
137 scerror = SockClose(fd);
139 set_signal_handler(SIGALRM, alrmsave);
144 static int kerberos_auth(socket, canonical, principal)
145 /* authenticate to the server host using Kerberos V4 */
146 int socket; /* socket to server host */
147 char *canonical; /* server name */
153 Key_schedule schedule;
155 char * prin_copy = (char *) NULL;
156 char * prin = (char *) NULL;
157 char * inst = (char *) NULL;
158 char * realm = (char *) NULL;
160 if (principal != (char *)NULL && *principal)
163 prin = prin_copy = xstrdup(principal);
164 for (cp = prin_copy; *cp && *cp != '.'; ++cp)
170 while (*cp && *cp != '@')
180 ticket = xmalloc(sizeof (KTEXT_ST));
181 rem = (krb_sendauth (0L, socket, ticket,
183 inst ? inst : canonical,
184 realm ? realm : ((char *) (krb_realmofhost (canonical))),
189 ((struct sockaddr_in *) 0),
190 ((struct sockaddr_in *) 0),
199 report(stderr, GT_("kerberos error %s\n"), (krb_get_err_text (rem)));
200 return (PS_AUTHFAIL);
204 #endif /* KERBEROS_V4 */
207 static int kerberos5_auth(socket, canonical)
208 /* authenticate to the server host using Kerberos V5 */
209 int socket; /* socket to server host */
210 const char *canonical; /* server name */
212 krb5_error_code retval;
213 krb5_context context;
215 krb5_principal client = NULL, server = NULL;
216 krb5_error *err_ret = NULL;
218 krb5_auth_context auth_context = NULL;
220 krb5_init_context(&context);
221 krb5_auth_con_init(context, &auth_context);
223 if ((retval = krb5_cc_default(context, &ccdef))) {
224 report(stderr, "krb5_cc_default: %s\n", error_message(retval));
228 if ((retval = krb5_cc_get_principal(context, ccdef, &client))) {
229 report(stderr, "krb5_cc_get_principal: %s\n", error_message(retval));
233 if ((retval = krb5_sname_to_principal(context, canonical, "pop",
236 report(stderr, "krb5_sname_to_principal: %s\n", error_message(retval));
240 retval = krb5_sendauth(context, &auth_context, (krb5_pointer) &socket,
241 "KPOPV1.0", client, server,
242 AP_OPTS_MUTUAL_REQUIRED,
243 NULL, /* no data to checksum */
244 0, /* no creds, use ccache instead */
248 NULL); /* don't need reply */
250 krb5_free_principal(context, server);
251 krb5_free_principal(context, client);
252 krb5_auth_con_free(context, auth_context);
256 if (err_ret && err_ret->e_text) {
257 char *t = err_ret->e_text;
258 char *tt = sdump(t, strlen(t));
259 report(stderr, GT_("krb5_sendauth: %s [server says '%s']\n"),
260 error_message(retval), tt);
263 if (err_ret && err_ret->text.length) {
264 char *tt = sdump(err_ret->text.data, err_ret->text.length);
265 report(stderr, GT_("krb5_sendauth: %s [server says '%s']\n"),
266 error_message(retval), tt);
269 krb5_free_error(context, err_ret);
271 report(stderr, "krb5_sendauth: %s\n", error_message(retval));
277 #endif /* KERBEROS_V5 */
279 static void clean_skipped_list(struct idlist **skipped_list)
280 /* struct "idlist" contains no "prev" ptr; we must remove unused items first */
282 struct idlist *current=NULL, *prev=NULL, *tmp=NULL, *head=NULL;
283 prev = current = head = *skipped_list;
289 /* if item has no reference, remove it */
290 if (current && current->val.status.mark == 0)
292 if (current == head) /* remove first item (head) */
294 head = current->next;
295 if (current->id) free(current->id);
297 prev = current = head;
299 else /* remove middle/last item */
303 if (current->id) free(current->id);
308 else /* skip this item */
311 current = current->next;
315 *skipped_list = head;
318 static void send_size_warnings(struct query *ctl)
319 /* send warning mail with skipped msg; reset msg count when user notified */
322 int msg_to_send = FALSE;
323 struct idlist *head=NULL, *current=NULL;
324 int max_warning_poll_count;
330 /* don't start a notification message unless we need to */
331 for (current = head; current; current = current->next)
332 if (current->val.status.num == 0 && current->val.status.mark)
338 * There's no good way to recover if we can't send notification mail,
339 * but it's not a disaster, either, since the skipped mail will not
342 if (open_warning_by_mail(ctl))
344 stuff_warning(iana_charset, ctl,
345 GT_("Subject: Fetchmail oversized-messages warning"));
346 stuff_warning(NULL, ctl, "%s", "");
348 stuff_warning(NULL, ctl,
349 GT_("The following oversized messages were deleted on server %s account %s:"),
350 ctl->server.pollname, ctl->remotename);
352 stuff_warning(NULL, ctl,
353 GT_("The following oversized messages remain on server %s account %s:"),
354 ctl->server.pollname, ctl->remotename);
356 stuff_warning(NULL, ctl, "%s", "");
358 if (run.poll_interval == 0)
359 max_warning_poll_count = 0;
361 max_warning_poll_count = ctl->warnings/run.poll_interval;
363 /* parse list of skipped msg, adding items to the mail */
364 for (current = head; current; current = current->next)
366 if (current->val.status.num == 0 && current->val.status.mark)
368 nbr = current->val.status.mark;
369 size = atoi(current->id);
371 stuff_warning(NULL, ctl,
372 ngettext(" %d message %d octets long deleted by fetchmail.",
373 " %d messages %d octets long deleted by fetchmail.", nbr),
376 stuff_warning(NULL, ctl,
377 ngettext(" %d message %d octets long skipped by fetchmail.",
378 " %d messages %d octets long skipped by fetchmail.", nbr),
381 current->val.status.num++;
382 current->val.status.mark = 0;
384 if (current->val.status.num >= max_warning_poll_count)
385 current->val.status.num = 0;
388 stuff_warning(NULL, ctl, "%s", "");
390 close_warning_by_mail(ctl, (struct msgblk *)NULL);
393 static void mark_oversized(struct query *ctl, int size)
394 /* mark a message oversized */
396 struct idlist *current=NULL, *tmp=NULL;
400 /* convert size to string */
401 snprintf(sizestr, sizeof(sizestr), "%d", size);
403 /* build a list of skipped messages
404 * val.id = size of msg (string cnvt)
405 * val.status.num = warning_poll_count
406 * val.status.mask = nbr of msg this size
409 current = ctl->skipped;
411 /* initialise warning_poll_count to the
412 * current value so that all new msg will
413 * be included in the next mail
415 cnt = current ? current->val.status.num : 0;
417 /* if entry exists, increment the count */
418 if (current && (tmp = str_in_list(¤t, sizestr, FALSE)))
420 tmp->val.status.mark++;
422 /* otherwise, create a new entry */
423 /* initialise with current poll count */
426 tmp = save_str(&ctl->skipped, sizestr, 1);
427 tmp->val.status.num = cnt;
431 static int eat_trailer(int sock, struct query *ctl)
433 /* we only need this LF if we're printing ticker dots
434 * AND we are dumping protocol traces. */
435 if (outlevel >= O_VERBOSE && want_progress()) fputc('\n', stdout);
436 return (ctl->server.base_protocol->trail)(sock, ctl, tag);
439 static int fetch_messages(int mailserver_socket, struct query *ctl,
440 int count, int **msgsizes, int maxfetch,
441 int *fetches, int *dispatches, int *deletions)
442 /* fetch messages in lockstep mode */
444 flag force_retrieval;
445 int num, firstnum = 1, lastnum = 0, err, len;
446 int fetchsizelimit = ctl->fetchsizelimit;
448 int initialfetches = *fetches;
450 if (ctl->server.base_protocol->getpartialsizes && NUM_NONZERO(fetchsizelimit))
452 /* for POP3, we can get the size of one mail only! Unfortunately, this
453 * protocol specific test cannot be done elsewhere as the protocol
454 * could be "auto". */
455 switch (ctl->server.protocol)
457 case P_POP3: case P_APOP: case P_RPOP:
461 /* Time to allocate memory to store the sizes */
463 *msgsizes = (int *)xmalloc(sizeof(int) * fetchsizelimit);
467 * What forces this code is that in POP2 and
468 * IMAP2bis you can't fetch a message without
469 * having it marked `seen'. In POP3 and IMAP4, on the
470 * other hand, you can (peek_capable is set by
471 * each driver module to convey this; it's not a
472 * method constant because of the difference between
473 * IMAP2bis and IMAP4, and because POP3 doesn't peek
474 * if fetchall is on).
476 * The result of being unable to peek is that if there's
477 * any kind of transient error (DNS lookup failure, or
478 * sendmail refusing delivery due to process-table limits)
479 * the message will be marked "seen" on the server without
480 * having been delivered. This is not a big problem if
481 * fetchmail is running in foreground, because the user
482 * will see a "skipped" message when it next runs and get
485 * But in daemon mode this leads to the message
486 * being silently ignored forever. This is not
489 * We compensate for this by checking the error
490 * count from the previous pass and forcing all
491 * messages to be considered new if it's nonzero.
493 force_retrieval = !peek_capable && (ctl->errcount > 0);
495 for (num = 1; num <= count; num++)
497 flag suppress_delete = FALSE;
498 flag suppress_forward = FALSE;
499 flag suppress_readbody = FALSE;
500 flag retained = FALSE;
501 int msgcode = MSGLEN_UNKNOWN;
503 /* check if the message is old
504 * Note: the size of the message may not be known here */
505 if (ctl->fetchall || force_retrieval) {
508 if (ctl->server.base_protocol->is_old && (ctl->server.base_protocol->is_old)(mailserver_socket,ctl,num)) {
509 msgcode = MSGLEN_OLD;
512 if (msgcode == MSGLEN_OLD)
514 /* To avoid flooding the syslog when using --keep,
515 * report "Skipped message" only when:
516 * 1) --verbose is on, or
517 * 2) fetchmail does not use syslog
519 if ( (outlevel >= O_VERBOSE) ||
520 (outlevel > O_SILENT && !run.use_syslog)
524 GT_("skipping message %s@%s:%d"),
525 ctl->remotename, ctl->server.truename, num);
531 if (ctl->server.base_protocol->getpartialsizes && NUM_NONZERO(fetchsizelimit) &&
534 /* Instead of getting the sizes of all mails at the start, we get
535 * the sizes in blocks of fetchsizelimit. This leads to better
536 * performance when there are too many mails (say, 10000) in
537 * the mailbox and either we are not getting all the mails at
538 * one go (--fetchlimit 100) or there is a frequent socket
539 * error while just getting the sizes of all mails! */
542 int oldstage = stage;
544 lastnum = num + fetchsizelimit - 1;
547 for (i = 0; i < fetchsizelimit; i++)
550 stage = STAGE_GETSIZES;
551 err = (ctl->server.base_protocol->getpartialsizes)(mailserver_socket, num, lastnum, *msgsizes);
558 msgsize = *msgsizes ? (*msgsizes)[num-firstnum] : 0;
560 /* check if the message is oversized */
561 if (NUM_NONZERO(ctl->limit) && (msgsize > ctl->limit))
562 msgcode = MSGLEN_TOOLARGE;
563 /* else if (msgsize == 512)
564 msgcode = MSGLEN_OLD; (hmh) sample code to skip message */
568 if (msgcode == MSGLEN_TOOLARGE)
570 mark_oversized(ctl, msgsize);
571 if (!ctl->limitflush)
572 suppress_delete = TRUE;
574 if (outlevel > O_SILENT)
576 /* old messages are already handled above */
578 GT_("skipping message %s@%s:%d (%d octets)"),
579 ctl->remotename, ctl->server.truename, num,
585 * Invalid lengths are produced by Post Office/NT's
586 * annoying habit of randomly prepending bogus
587 * LIST items of length -1. Patrick Audley
588 * <paudley@pobox.com> tells us: LIST shows a
589 * size of -1, RETR and TOP return "-ERR
590 * System error - couldn't open message", and
591 * DELE succeeds but doesn't actually delete
594 report_build(stdout, GT_(" (length -1)"));
596 case MSGLEN_TOOLARGE:
597 report_build(stdout, GT_(" (oversized)"));
604 /* XXX FIXME: make this one variable, wholesize and
605 separatefetchbody query the same variable just with
607 flag wholesize = !ctl->server.base_protocol->fetch_body;
608 flag separatefetchbody = (ctl->server.base_protocol->fetch_body) ? TRUE : FALSE;
610 /* request a message */
611 err = (ctl->server.base_protocol->fetch_headers)(mailserver_socket,ctl,num, &len);
612 if (err == PS_TRANSIENT) /* server is probably Exchange */
615 GT_("couldn't fetch headers, message %s@%s:%d (%d octets)\n"),
616 ctl->remotename, ctl->server.truename, num,
623 /* -1 means we didn't see a size in the response */
630 if (outlevel > O_SILENT)
632 report_build(stdout, GT_("reading message %s@%s:%d of %d"),
633 ctl->remotename, ctl->server.truename,
637 report_build(stdout, wholesize ? GT_(" (%d octets)")
638 : GT_(" (%d header octets)"), len);
639 if (want_progress()) {
640 /* flush and add a blank to append ticker dots */
641 report_flush(stdout);
647 * Read the message headers and ship them to the
650 err = readheaders(mailserver_socket, len, msgsize,
652 /* pass the suppress_readbody flag only if the underlying
653 * protocol does not fetch the body separately */
654 separatefetchbody ? 0 : &suppress_readbody);
656 if (err == PS_RETAINED)
657 suppress_forward = suppress_delete = retained = TRUE;
658 else if (err == PS_TRANSIENT)
659 suppress_delete = suppress_forward = TRUE;
660 else if (err == PS_REFUSED)
661 suppress_forward = TRUE;
665 /* tell server we got it OK and resynchronize */
666 if (separatefetchbody && ctl->server.base_protocol->trail)
668 err = eat_trailer(mailserver_socket, ctl);
669 if (err) return(err);
672 /* do not read the body which is not being forwarded only if
673 * the underlying protocol allows the body to be fetched
675 if (separatefetchbody && suppress_forward)
676 suppress_readbody = TRUE;
679 * If we're using IMAP4 or something else that
680 * can fetch headers separately from bodies,
681 * it's time to request the body now. This
682 * fetch may be skipped if we got an anti-spam
683 * or other PS_REFUSED error response during
686 if (!suppress_readbody)
688 if (separatefetchbody)
691 if ((err=(ctl->server.base_protocol->fetch_body)(mailserver_socket,ctl,num,&len)))
694 * Work around a bug in Novell's
695 * broken GroupWise IMAP server;
696 * its body FETCH response is missing
697 * the required length for the data
698 * string. This violates RFC2060.
701 len = msgsize - msgblk.msglen;
703 if (outlevel > O_SILENT)
705 GT_(" (%d body octets)"), len);
706 if (want_progress()) {
707 report_flush(stdout);
713 /* process the body now */
714 err = readbody(mailserver_socket,
719 if (err == PS_TRANSIENT)
720 suppress_delete = suppress_forward = TRUE;
724 /* tell server we got it OK and resynchronize */
725 if (ctl->server.base_protocol->trail) {
726 err = eat_trailer(mailserver_socket, ctl);
727 if (err) return(err);
731 /* count # messages forwarded on this pass */
732 if (!suppress_forward)
736 * Check to see if the numbers matched?
738 * Yes, some servers foo this up horribly.
739 * All IMAP servers seem to get it right, and
740 * so does Eudora QPOP at least in 2.xx
743 * Microsoft Exchange gets it completely
744 * wrong, reporting compressed rather than
745 * actual sizes (so the actual length of
746 * message is longer than the reported size).
747 * Another fine example of Microsoft brain death!
749 * Some older POP servers, like the old UCB
750 * POP server and the pre-QPOP QUALCOMM
751 * versions, report a longer size in the LIST
752 * response than actually gets shipped up.
753 * It's unclear what is going on here, as the
754 * QUALCOMM server (at least) seems to be
755 * reporting the on-disk size correctly.
757 * qmail-pop3d also goofs up message sizes and does not
758 * count the line end characters properly.
760 if (msgblk.msglen != msgsize)
762 if (outlevel >= O_DEBUG)
764 GT_("message %s@%s:%d was not the expected length (%d actual != %d expected)\n"),
765 ctl->remotename, ctl->server.truename, num,
766 msgblk.msglen, msgsize);
769 /* end-of-message processing starts here */
770 if (!close_sink(ctl, &msgblk, !suppress_forward))
773 suppress_delete = TRUE;
781 * At this point in flow of control,
782 * either we've bombed on a protocol error
783 * or had delivery refused by the SMTP server
784 * or we've seen `accepted for delivery' and the message is shipped.
785 * It's safe to mark the message seen and delete it on the server now.
788 /* in softbounce mode, suppress deletion and marking as seen */
789 if (suppress_forward)
790 suppress_delete = suppress_delete || run.softbounce;
792 /* maybe we delete this message now? */
795 if (outlevel > O_SILENT)
796 report_complete(stdout, GT_(" retained\n"));
798 else if (ctl->server.base_protocol->delete_msg
800 && ((msgcode >= 0 && !ctl->keep)
801 || (msgcode == MSGLEN_OLD && ctl->flush)
802 || (msgcode == MSGLEN_TOOLARGE && ctl->limitflush)))
805 if (outlevel > O_SILENT)
806 report_complete(stdout, GT_(" flushed\n"));
807 err = (ctl->server.base_protocol->delete_msg)(mailserver_socket, ctl, num);
813 if ( (outlevel >= O_VERBOSE) ||
814 /* To avoid flooding the syslog when using --keep,
815 * report "Skipped message" only when:
816 * 1) --verbose is on, or
817 * 2) fetchmail does not use syslog, or
818 * 3) the message was skipped for some other
819 * reason than just being old.
821 (outlevel > O_SILENT && (!run.use_syslog || msgcode != MSGLEN_OLD))
823 report_complete(stdout, GT_(" not flushed\n"));
825 /* maybe we mark this message as seen now? */
826 if (ctl->server.base_protocol->mark_seen
828 && (msgcode >= 0 && ctl->keep))
830 err = (ctl->server.base_protocol->mark_seen)(mailserver_socket, ctl, num);
836 /* perhaps this as many as we're ready to handle */
837 if (maxfetch && maxfetch <= *fetches && num < count)
839 int remcount = count - (*fetches - initialfetches);
841 ngettext("fetchlimit %d reached; %d message left on server %s account %s\n",
842 "fetchlimit %d reached; %d messages left on server %s account %s\n", remcount),
843 maxfetch, remcount, ctl->server.truename, ctl->remotename);
846 } /* for (num = 1; num <= count; num++) */
851 /* retrieve messages from server using given protocol method table */
852 static int do_session(
853 /* parsed options with merged-in defaults */
855 /* protocol method table */
856 const struct method *proto,
857 /* maximum number of messages to fetch */
860 static int *msgsizes;
861 volatile int err, mailserver_socket = -1; /* pacifies -Wall */
863 int deletions = 0, js;
865 SIGHANDLERTYPE alrmsave;
867 ctl->server.base_protocol = proto;
872 init_transact(proto);
874 /* set up the server-nonresponse timeout */
875 alrmsave = set_signal_handler(SIGALRM, timeout_handler);
876 mytimeout = ctl->server.timeout;
878 if ((js = sigsetjmp(restart,1)))
880 /* exception caught */
883 sigfillset(&allsigs);
884 sigprocmask(SIG_UNBLOCK, &allsigs, NULL);
887 fm_freeaddrinfo(ai0); ai0 = NULL;
891 fm_freeaddrinfo(ai1); ai1 = NULL;
894 if (js == THROW_TIMEOUT)
896 if (phase == OPEN_WAIT)
898 GT_("timeout after %d seconds waiting to connect to server %s.\n"),
899 ctl->server.timeout, ctl->server.pollname);
900 else if (phase == SERVER_WAIT)
902 GT_("timeout after %d seconds waiting for server %s.\n"),
903 ctl->server.timeout, ctl->server.pollname);
904 else if (phase == FORWARDING_WAIT)
906 GT_("timeout after %d seconds waiting for %s.\n"),
908 ctl->mda ? "MDA" : "SMTP");
909 else if (phase == LISTENER_WAIT)
911 GT_("timeout after %d seconds waiting for listener to respond.\n"), ctl->server.timeout);
914 GT_("timeout after %d seconds.\n"), ctl->server.timeout);
917 * If we've exceeded our threshold for consecutive timeouts,
918 * try to notify the user, then mark the connection wedged.
919 * Don't do this if the connection can idle, though; idle
920 * timeouts just mean the frequency of mail is low.
922 if (timeoutcount > MAX_TIMEOUTS
923 && !open_warning_by_mail(ctl))
925 stuff_warning(iana_charset, ctl,
926 GT_("Subject: fetchmail sees repeated timeouts"));
927 stuff_warning(NULL, ctl, "%s", "");
928 stuff_warning(NULL, ctl,
929 GT_("Fetchmail saw more than %d timeouts while attempting to get mail from %s@%s.\n"),
931 ctl->remotename, ctl->server.truename);
932 stuff_warning(NULL, ctl,
933 GT_("This could mean that your mailserver is stuck, or that your SMTP\n" \
934 "server is wedged, or that your mailbox file on the server has been\n" \
935 "corrupted by a server error. You can run `fetchmail -v -v' to\n" \
936 "diagnose the problem.\n\n" \
937 "Fetchmail won't poll this mailbox again until you restart it.\n"));
938 close_warning_by_mail(ctl, (struct msgblk *)NULL);
948 /* sigsetjmp returned zero -> normal operation */
949 char buf[MSGBUFSIZE+1], *realhost;
950 int count, newm, bytes;
951 int fetches, dispatches, oldphase;
954 /* execute pre-initialization command, if any */
955 if (ctl->preconnect && (err = system(ctl->preconnect)))
957 if (WIFSIGNALED(err))
959 GT_("pre-connection command terminated with signal %d\n"), WTERMSIG(err));
962 GT_("pre-connection command failed with status %d\n"), WEXITSTATUS(err));
967 /* open a socket to the mail server */
970 set_timeout(mytimeout);
972 #ifdef HAVE_PKG_hesiod
973 /* If either the pollname or vianame are "hesiod" we want to
974 lookup the user's hesiod pobox host */
975 if (!strcasecmp(ctl->server.queryname, "hesiod")) {
976 struct hes_postoffice *hes_p;
977 hes_p = hes_getmailhost(ctl->remotename);
978 if (hes_p != NULL && strcmp(hes_p->po_type, "POP") == 0) {
979 free(ctl->server.queryname);
980 ctl->server.queryname = xstrdup(hes_p->po_host);
982 free(ctl->server.via);
983 ctl->server.via = xstrdup(hes_p->po_host);
986 GT_("couldn't find HESIOD pobox for %s\n"),
993 * Canonicalize the server truename for later use. This also
994 * functions as a probe for whether the mailserver is accessible.
995 * We try it on each poll cycle until we get a result. This way,
996 * fetchmail won't fail if started up when the network is inaccessible.
998 if (ctl->server.dns && !ctl->server.trueaddr)
1000 if (ctl->server.lead_server)
1002 char *leadname = ctl->server.lead_server->truename;
1004 /* prevent core dump from ill-formed or duplicate entry */
1007 report(stderr, GT_("Lead server has no name.\n"));
1014 xfree(ctl->server.truename);
1015 ctl->server.truename = xstrdup(leadname);
1019 struct addrinfo hints, *res;
1022 memset(&hints, 0, sizeof(hints));
1023 hints.ai_socktype = SOCK_STREAM;
1024 hints.ai_family = AF_UNSPEC;
1025 hints.ai_flags = AI_CANONNAME;
1026 #ifdef AI_ADDRCONFIG
1027 hints.ai_flags |= AI_ADDRCONFIG;
1030 error = fm_getaddrinfo(ctl->server.queryname, NULL, &hints, &res);
1034 GT_("couldn't find canonical DNS name of %s (%s): %s\n"),
1035 ctl->server.pollname, ctl->server.queryname,
1036 gai_strerror(error));
1044 xfree(ctl->server.truename);
1045 /* Older FreeBSD versions return NULL in ai_canonname
1046 * if they cannot canonicalize, rather than copying
1047 * the queryname here, as IEEE Std 1003.1-2001
1048 * requires. Work around NULL. */
1049 if (res->ai_canonname != NULL) {
1050 ctl->server.truename = xstrdup(res->ai_canonname);
1052 ctl->server.truename = xstrdup(ctl->server.queryname);
1054 ctl->server.trueaddr = (struct sockaddr *)xmalloc(res->ai_addrlen);
1055 ctl->server.trueaddr_len = res->ai_addrlen;
1056 memcpy(ctl->server.trueaddr, res->ai_addr, res->ai_addrlen);
1057 fm_freeaddrinfo(res);
1062 realhost = ctl->server.via ? ctl->server.via : ctl->server.pollname;
1064 /* allow time for the port to be set up if we have a plugin */
1065 if (ctl->server.plugin)
1067 if ((mailserver_socket = SockOpen(realhost,
1068 ctl->server.service ? ctl->server.service : ( ctl->use_ssl ? ctl->server.base_protocol->sslservice : ctl->server.base_protocol->service ),
1069 ctl->server.plugin, &ai0)) == -1)
1071 char errbuf[BUFSIZ];
1074 * Avoid generating a bogus error every poll cycle when we're
1075 * in daemon mode but the connection to the outside world
1078 if (!((err_no == EHOSTUNREACH || err_no == ENETUNREACH)
1079 && run.poll_interval))
1081 report_build(stderr, GT_("%s connection to %s failed"),
1082 ctl->server.base_protocol->name, ctl->server.pollname);
1083 strlcpy(errbuf, strerror(err_no), sizeof(errbuf));
1084 report_complete(stderr, ": %s\n", errbuf);
1094 /* Save the socket opened. Useful if Fetchmail hangs on SSLOpen
1095 * because the socket can be closed.
1097 mailserver_socket_temp = mailserver_socket;
1098 set_timeout(mytimeout);
1100 /* perform initial SSL handshake on open connection */
1102 SSLOpen(mailserver_socket, ctl->sslcert, ctl->sslkey,
1103 ctl->sslproto, ctl->sslcertck,
1104 ctl->sslcertfile, ctl->sslcertpath,
1105 ctl->sslfingerprint, ctl->sslcommonname ?
1106 ctl->sslcommonname : realhost, ctl->server.pollname,
1107 &ctl->remotename) == -1)
1109 report(stderr, GT_("SSL connection failed.\n"));
1114 /* Fetchmail didn't hang on SSLOpen,
1115 * then no need to set mailserver_socket_temp
1117 mailserver_socket_temp = -1;
1120 /* A timeout is still defined before SSLOpen,
1121 * then Fetchmail hanging on SSLOpen is handled.
1126 if (ctl->server.authenticate == A_KERBEROS_V4 && (strcasecmp(proto->name,"IMAP") != 0))
1128 set_timeout(mytimeout);
1129 err = kerberos_auth(mailserver_socket, ctl->server.truename,
1130 ctl->server.principal);
1135 #endif /* KERBEROS_V4 */
1138 if (ctl->server.authenticate == A_KERBEROS_V5)
1140 set_timeout(mytimeout);
1141 err = kerberos5_auth(mailserver_socket, ctl->server.truename);
1146 #endif /* KERBEROS_V5 */
1148 /* accept greeting message from mail server */
1149 err = (ctl->server.base_protocol->parse_response)(mailserver_socket, buf);
1153 /* try to get authorized to fetch mail */
1154 stage = STAGE_GETAUTH;
1155 if (ctl->server.base_protocol->getauth)
1157 set_timeout(mytimeout);
1158 err = (ctl->server.base_protocol->getauth)(mailserver_socket, ctl, buf);
1163 if (err == PS_LOCKBUSY)
1164 report(stderr, GT_("Lock-busy error on %s@%s\n"),
1166 ctl->server.truename);
1167 else if (err == PS_SERVBUSY)
1168 report(stderr, GT_("Server busy error on %s@%s\n"),
1170 ctl->server.truename);
1171 else if (err == PS_AUTHFAIL)
1173 report(stderr, GT_("Authorization failure on %s@%s%s\n"),
1175 ctl->server.truename,
1176 (ctl->wehaveauthed ? GT_(" (previously authorized)") : "")
1178 if (ctl->server.authenticate == A_ANY && !ctl->wehaveauthed) {
1179 report(stderr, GT_("For help, see http://www.fetchmail.info/fetchmail-FAQ.html#R15\n"));
1183 * If we're running in background, try to mail the
1184 * calling user a heads-up about the authentication
1185 * failure once it looks like this isn't a fluke
1186 * due to the server being temporarily inaccessible.
1187 * When we get third succesive failure, we notify the user
1188 * but only if we haven't already managed to get
1189 * authorization. After that, once we get authorization
1190 * we let the user know service is restored.
1192 if (run.poll_interval
1193 && !ctl->wehavesentauthnote
1194 && ((ctl->wehaveauthed && ++ctl->authfailcount >= 10)
1195 || (!ctl->wehaveauthed && ++ctl->authfailcount >= 3))
1196 && !open_warning_by_mail(ctl))
1198 ctl->wehavesentauthnote = 1;
1199 stuff_warning(iana_charset, ctl,
1200 GT_("Subject: fetchmail authentication failed on %s@%s"),
1201 ctl->remotename, ctl->server.truename);
1202 stuff_warning(NULL, ctl, "%s", "");
1203 stuff_warning(NULL, ctl,
1204 GT_("Fetchmail could not get mail from %s@%s.\n"),
1206 ctl->server.truename);
1207 if (ctl->wehaveauthed) {
1208 stuff_warning(NULL, ctl, GT_("\
1209 The attempt to get authorization failed.\n\
1210 Since we have already succeeded in getting authorization for this\n\
1211 connection, this is probably another failure mode (such as busy server)\n\
1212 that fetchmail cannot distinguish because the server didn't send a useful\n\
1214 stuff_warning(NULL, ctl, GT_("\
1216 However, if you HAVE changed your account details since starting the\n\
1217 fetchmail daemon, you need to stop the daemon, change your configuration\n\
1218 of fetchmail, and then restart the daemon.\n\
1220 The fetchmail daemon will continue running and attempt to connect\n\
1221 at each cycle. No future notifications will be sent until service\n\
1224 stuff_warning(NULL, ctl, GT_("\
1225 The attempt to get authorization failed.\n\
1226 This probably means your password is invalid, but some servers have\n\
1227 other failure modes that fetchmail cannot distinguish from this\n\
1228 because they don't send useful error messages on login failure.\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 close_warning_by_mail(ctl, (struct msgblk *)NULL);
1237 else if (err == PS_REPOLL)
1239 if (outlevel >= O_VERBOSE)
1240 report(stderr, GT_("Repoll immediately on %s@%s\n"),
1242 ctl->server.truename);
1245 report(stderr, GT_("Unknown login or authentication error on %s@%s\n"),
1247 ctl->server.truename);
1254 * This connection has given us authorization at least once.
1256 * There are dodgy server (clubinternet.fr for example) that
1257 * give spurious authorization failures on patently good
1258 * account/password details, then 5 minutes later let you in!
1260 * This is meant to build in some tolerance of such nasty bits
1263 ctl->wehaveauthed = 1;
1264 /*if (ctl->authfailcount >= 3)*/
1265 if (ctl->wehavesentauthnote)
1267 ctl->wehavesentauthnote = 0;
1269 GT_("Authorization OK on %s@%s\n"),
1271 ctl->server.truename);
1272 if (!open_warning_by_mail(ctl))
1274 stuff_warning(iana_charset, ctl,
1275 GT_("Subject: fetchmail authentication OK on %s@%s"),
1276 ctl->remotename, ctl->server.truename);
1277 stuff_warning(NULL, ctl, "%s", "");
1278 stuff_warning(NULL, ctl,
1279 GT_("Fetchmail was able to log into %s@%s.\n"),
1281 ctl->server.truename);
1282 stuff_warning(NULL, ctl,
1283 GT_("Service has been restored.\n"));
1284 close_warning_by_mail(ctl, (struct msgblk *)NULL);
1289 * Reporting only after the first three
1290 * consecutive failures, or ten consecutive
1291 * failures after we have managed to get
1294 ctl->authfailcount = 0;
1298 ctl->errcount = fetches = 0;
1300 /* now iterate over each folder selected */
1301 for (idp = ctl->mailboxes; idp; idp = idp->next)
1303 ctl->folder = idp->id;
1309 /* reset timeout, in case we did an IDLE */
1310 mytimeout = ctl->server.timeout;
1312 if (outlevel >= O_DEBUG)
1315 report(stdout, GT_("selecting or re-polling folder %s\n"), idp->id);
1317 report(stdout, GT_("selecting or re-polling default folder\n"));
1320 /* compute # of messages and number of new messages waiting */
1321 stage = STAGE_GETRANGE;
1322 err = (ctl->server.base_protocol->getrange)(mailserver_socket, ctl, idp->id, &count, &newm, &bytes);
1326 /* show user how many messages we downloaded */
1328 (void) snprintf(buf, sizeof(buf),
1329 GT_("%s at %s (folder %s)"),
1330 ctl->remotename, ctl->server.pollname, idp->id);
1332 (void) snprintf(buf, sizeof(buf), GT_("%s at %s"),
1333 ctl->remotename, ctl->server.pollname);
1334 if (outlevel > O_SILENT)
1336 if (count == -1) /* only used for ETRN */
1337 report(stdout, GT_("Polling %s\n"), ctl->server.truename);
1338 else if (count != 0)
1340 if (newm != -1 && (count - newm) > 0)
1341 report_build(stdout, ngettext("%d message (%d %s) for %s", "%d messages (%d %s) for %s", (unsigned long)count),
1344 ngettext("seen", "seen", (unsigned long)count-newm),
1347 report_build(stdout, ngettext("%d message for %s",
1348 "%d messages for %s",
1352 report_complete(stdout, ".\n");
1354 report_complete(stdout, GT_(" (%d octets).\n"), bytes);
1358 /* these are pointless in normal daemon mode */
1359 if (pass == 1 && (run.poll_interval == 0 || outlevel >= O_VERBOSE))
1360 report(stdout, GT_("No mail for %s\n"), buf);
1364 /* very important, this is where we leave the do loop */
1370 if (newm == -1 || ctl->fetchall)
1372 fetches = newm; /* set error status correctly */
1374 * There used to be a `goto noerror' here, but this
1375 * prevented checking of multiple folders. This
1376 * comment is a reminder in case I introduced some
1377 * subtle bug by removing it...
1385 * Don't trust the message count passed by the server.
1386 * Without this check, it might be possible to do a
1387 * DNS-spoofing attack that would pass back a ridiculous
1388 * count, and allocate a malloc area that would overlap
1389 * a portion of the stack.
1391 if ((unsigned)count > INT_MAX/sizeof(int))
1393 report(stderr, GT_("bogus message count!"));
1399 * We need the size of each message before it's
1400 * loaded in order to pass it to the ESMTP SIZE
1401 * option. If the protocol has a getsizes method,
1402 * we presume this means it doesn't get reliable
1403 * sizes from message fetch responses.
1405 * If the protocol supports getting sizes of subset of
1406 * messages, we skip this step now.
1408 if (proto->getsizes &&
1409 !(proto->getpartialsizes && NUM_NONZERO(ctl->fetchsizelimit)))
1412 msgsizes = (int *)xmalloc(sizeof(int) * count);
1413 for (i = 0; i < count; i++)
1416 stage = STAGE_GETSIZES;
1417 err = (proto->getsizes)(mailserver_socket, count, msgsizes);
1424 for (i = 0; i < count; i++)
1425 bytes += msgsizes[i];
1429 /* read, forward, and delete messages */
1430 stage = STAGE_FETCH;
1432 /* fetch in lockstep mode */
1433 err = fetch_messages(mailserver_socket, ctl,
1436 &fetches, &dispatches, &deletions);
1437 if (err != PS_SUCCESS && err != PS_MAXFETCH)
1440 if (!check_only && ctl->skipped
1441 && run.poll_interval > 0 && !nodetach)
1443 clean_skipped_list(&ctl->skipped);
1444 send_size_warnings(ctl);
1448 /* end-of-mailbox processing before we repoll or switch to another one */
1449 if (ctl->server.base_protocol->end_mailbox_poll)
1451 tmperr = (ctl->server.base_protocol->end_mailbox_poll)(mailserver_socket, ctl);
1457 /* Return now if we have reached the fetchlimit */
1458 if (maxfetch && maxfetch <= fetches)
1462 * Only repoll if we either had some actual forwards
1463 * or are idling for new mails and had no errors.
1464 * Otherwise it is far too easy to get into infinite loops.
1466 (ctl->server.base_protocol->retry && (dispatches || ctl->idle) && !ctl->errcount);
1469 /* XXX: From this point onwards, preserve err unless a new error has occurred */
1472 /* PS_SUCCESS, PS_MAXFETCH: ordinary termination with no errors -- officially log out */
1473 stage = STAGE_LOGOUT;
1474 tmperr = (ctl->server.base_protocol->logout_cmd)(mailserver_socket, ctl);
1475 if (tmperr != PS_SUCCESS)
1478 * Hmmmm...arguably this would be incorrect if we had fetches but
1479 * no dispatches (due to oversized messages, etc.)
1481 else if (err == PS_SUCCESS && fetches == 0)
1484 * Close all SMTP delivery sockets. For optimum performance
1485 * we'd like to hold them open til end of run, but (1) this
1486 * loses if our poll interval is longer than the MTA's
1487 * inactivity timeout, and (2) some MTAs (like smail) don't
1488 * deliver after each message, but rather queue up mail and
1489 * wait to actually deliver it until the input socket is
1492 * don't send QUIT for ODMR case because we're acting as a
1493 * proxy between the SMTP server and client.
1495 smtp_close(ctl, ctl->server.protocol != P_ODMR);
1496 cleanupSockClose(mailserver_socket);
1500 /* we only get here on error */
1501 if (err != 0 && err != PS_SOCKET && err != PS_REPOLL)
1503 stage = STAGE_LOGOUT;
1504 (ctl->server.base_protocol->logout_cmd)(mailserver_socket, ctl);
1507 /* try to clean up all streams */
1510 * Sending SMTP QUIT on signal is theoretically nice, but led
1511 * to a subtle bug. If fetchmail was terminated by signal
1512 * while it was shipping message text, it would hang forever
1513 * waiting for a command acknowledge. In theory we could
1514 * enable the QUIT only outside of the message send. In
1515 * practice, we don't care. All mailservers hang up on a
1516 * dropped TCP/IP connection anyway.
1519 if (mailserver_socket != -1) {
1520 cleanupSockClose(mailserver_socket);
1522 /* If there was a connect timeout, the socket should be closed.
1523 * mailserver_socket_temp contains the socket to close.
1525 if (mailserver_socket_temp != -1) {
1526 cleanupSockClose(mailserver_socket_temp);
1527 mailserver_socket_temp = -1;
1531 /* no report on PS_AUTHFAIL */
1536 msg = GT_("socket");
1539 msg = GT_("missing or bad RFC822 header");
1545 msg = GT_("client/server synchronization");
1548 msg = GT_("client/server protocol");
1551 msg = GT_("lock busy on server");
1554 msg = GT_("SMTP transaction");
1557 msg = GT_("DNS lookup");
1560 msg = GT_("undefined");
1564 if (phase == FORWARDING_WAIT || phase == LISTENER_WAIT
1566 report(stderr, GT_("%s error while fetching from %s@%s and delivering to SMTP host %s\n"),
1567 msg, ctl->remotename, ctl->server.pollname,
1568 ctl->smtphost ? ctl->smtphost : GT_("unknown"));
1570 report(stderr, GT_("%s error while fetching from %s@%s\n"),
1571 msg, ctl->remotename, ctl->server.pollname);
1578 /* execute wrapup command, if any */
1579 if (ctl->postconnect && (tmperr = system(ctl->postconnect)))
1581 if (WIFSIGNALED(tmperr))
1582 report(stderr, GT_("post-connection command terminated with signal %d\n"), WTERMSIG(tmperr));
1584 report(stderr, GT_("post-connection command failed with status %d\n"), WEXITSTATUS(tmperr));
1585 if (err == PS_SUCCESS)
1589 set_timeout(0); /* cancel any pending alarm */
1590 set_signal_handler(SIGALRM, alrmsave);
1594 /** retrieve messages from server using given protocol method table */
1595 int do_protocol(struct query *ctl /** parsed options with merged-in defaults */,
1596 const struct method *proto /** protocol method table */)
1601 if (ctl->server.authenticate == A_KERBEROS_V4)
1603 report(stderr, GT_("Kerberos V4 support not linked.\n"));
1606 #endif /* KERBEROS_V4 */
1609 if (ctl->server.authenticate == A_KERBEROS_V5)
1611 report(stderr, GT_("Kerberos V5 support not linked.\n"));
1614 #endif /* KERBEROS_V5 */
1616 /* lacking methods, there are some options that may fail */
1619 /* check for unsupported options */
1622 GT_("Option --flush is not supported with %s\n"),
1626 else if (ctl->fetchall) {
1628 GT_("Option --all is not supported with %s\n"),
1633 if (!(proto->getsizes || proto->getpartialsizes)
1634 && NUM_SPECIFIED(ctl->limit))
1637 GT_("Option --limit is not supported with %s\n"),
1643 * If no expunge limit or we do expunges within the driver,
1644 * then just do one session, passing in any fetchlimit.
1646 if ((ctl->keep && !ctl->flush) ||
1647 proto->retry || !NUM_SPECIFIED(ctl->expunge))
1648 return(do_session(ctl, proto, NUM_VALUE_OUT(ctl->fetchlimit)));
1650 * There's an expunge limit, and it isn't handled in the driver itself.
1651 * OK; do multiple sessions, each fetching a limited # of messages.
1652 * Stop if the total count of retrieved messages exceeds ctl->fetchlimit
1653 * (if it was nonzero).
1659 int expunge = NUM_VALUE_OUT(ctl->expunge);
1660 int fetchlimit = NUM_VALUE_OUT(ctl->fetchlimit);
1663 if (fetchlimit > 0 && (expunge == 0 || expunge > fetchlimit - totalcount))
1664 expunge = fetchlimit - totalcount;
1665 err = do_session(ctl, proto, expunge);
1666 totalcount += expunge;
1667 if (NUM_SPECIFIED(ctl->fetchlimit) && totalcount >= fetchlimit)
1669 if (err != PS_LOCKBUSY)
1671 else if (lockouts >= MAX_LOCKOUTS)
1673 else /* err == PS_LOCKBUSY */
1676 * Allow time for the server lock to release. if we
1677 * don't do this, we'll often hit a locked-mailbox
1678 * condition and fail.
1684 (err == PS_MAXFETCH || err == PS_LOCKBUSY);
1691 /* driver.c ends here */