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 */
133 (void)SockTimeout(fd, CLEANUP_TIMEOUT); /* ignore errors */
134 return SockClose(fd);
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)
509 * To avoid flooding the logs when using --keep, report
510 * skipping for old messages only when --flush is on.
512 if (outlevel > O_SILENT && ctl->flush)
515 GT_("skipping message %s@%s:%d"),
516 ctl->remotename, ctl->server.truename, num);
522 if (ctl->server.base_protocol->getpartialsizes && NUM_NONZERO(fetchsizelimit) &&
525 /* Instead of getting the sizes of all mails at the start, we get
526 * the sizes in blocks of fetchsizelimit. This leads to better
527 * performance when there are too many mails (say, 10000) in
528 * the mailbox and either we are not getting all the mails at
529 * one go (--fetchlimit 100) or there is a frequent socket
530 * error while just getting the sizes of all mails! */
533 int oldstage = stage;
535 lastnum = num + fetchsizelimit - 1;
538 for (i = 0; i < fetchsizelimit; i++)
541 stage = STAGE_GETSIZES;
542 err = (ctl->server.base_protocol->getpartialsizes)(mailserver_socket, num, lastnum, *msgsizes);
549 msgsize = *msgsizes ? (*msgsizes)[num-firstnum] : 0;
551 /* check if the message is oversized */
552 if (NUM_NONZERO(ctl->limit) && (msgsize > ctl->limit))
553 msgcode = MSGLEN_TOOLARGE;
554 /* else if (msgsize == 512)
555 msgcode = MSGLEN_OLD; (hmh) sample code to skip message */
559 if (msgcode == MSGLEN_TOOLARGE)
561 mark_oversized(ctl, msgsize);
562 if (!ctl->limitflush)
563 suppress_delete = TRUE;
565 if (outlevel > O_SILENT)
567 /* old messages are already handled above */
569 GT_("skipping message %s@%s:%d (%d octets)"),
570 ctl->remotename, ctl->server.truename, num,
576 * Invalid lengths are produced by Post Office/NT's
577 * annoying habit of randomly prepending bogus
578 * LIST items of length -1. Patrick Audley
579 * <paudley@pobox.com> tells us: LIST shows a
580 * size of -1, RETR and TOP return "-ERR
581 * System error - couldn't open message", and
582 * DELE succeeds but doesn't actually delete
585 report_build(stdout, GT_(" (length -1)"));
587 case MSGLEN_TOOLARGE:
588 report_build(stdout, GT_(" (oversized)"));
595 /* XXX FIXME: make this one variable, wholesize and
596 separatefetchbody query the same variable just with
598 flag wholesize = !ctl->server.base_protocol->fetch_body;
599 flag separatefetchbody = (ctl->server.base_protocol->fetch_body) ? TRUE : FALSE;
601 /* request a message */
602 err = (ctl->server.base_protocol->fetch_headers)(mailserver_socket,ctl,num, &len);
603 if (err == PS_TRANSIENT) /* server is probably Exchange */
606 GT_("couldn't fetch headers, message %s@%s:%d (%d octets)\n"),
607 ctl->remotename, ctl->server.truename, num,
614 /* -1 means we didn't see a size in the response */
621 if (outlevel > O_SILENT)
623 report_build(stdout, GT_("reading message %s@%s:%d of %d"),
624 ctl->remotename, ctl->server.truename,
628 report_build(stdout, wholesize ? GT_(" (%d octets)")
629 : GT_(" (%d header octets)"), len);
630 if (want_progress()) {
631 /* flush and add a blank to append ticker dots */
632 report_flush(stdout);
638 * Read the message headers and ship them to the
641 err = readheaders(mailserver_socket, len, msgsize,
643 /* pass the suppress_readbody flag only if the underlying
644 * protocol does not fetch the body separately */
645 separatefetchbody ? 0 : &suppress_readbody);
647 if (err == PS_RETAINED)
648 suppress_forward = suppress_delete = retained = TRUE;
649 else if (err == PS_TRANSIENT)
650 suppress_delete = suppress_forward = TRUE;
651 else if (err == PS_REFUSED)
652 suppress_forward = TRUE;
656 /* tell server we got it OK and resynchronize */
657 if (separatefetchbody && ctl->server.base_protocol->trail)
659 err = eat_trailer(mailserver_socket, ctl);
660 if (err) return(err);
663 /* do not read the body which is not being forwarded only if
664 * the underlying protocol allows the body to be fetched
666 if (separatefetchbody && suppress_forward)
667 suppress_readbody = TRUE;
670 * If we're using IMAP4 or something else that
671 * can fetch headers separately from bodies,
672 * it's time to request the body now. This
673 * fetch may be skipped if we got an anti-spam
674 * or other PS_REFUSED error response during
677 if (!suppress_readbody)
679 if (separatefetchbody)
682 if ((err=(ctl->server.base_protocol->fetch_body)(mailserver_socket,ctl,num,&len)))
685 * Work around a bug in Novell's
686 * broken GroupWise IMAP server;
687 * its body FETCH response is missing
688 * the required length for the data
689 * string. This violates RFC2060.
692 len = msgsize - msgblk.msglen;
694 if (outlevel > O_SILENT)
696 GT_(" (%d body octets)"), len);
697 if (want_progress()) {
698 report_flush(stdout);
704 /* process the body now */
705 err = readbody(mailserver_socket,
710 if (err == PS_TRANSIENT)
711 suppress_delete = suppress_forward = TRUE;
715 /* tell server we got it OK and resynchronize */
716 if (ctl->server.base_protocol->trail) {
717 err = eat_trailer(mailserver_socket, ctl);
718 if (err) return(err);
722 /* count # messages forwarded on this pass */
723 if (!suppress_forward)
727 * Check to see if the numbers matched?
729 * Yes, some servers foo this up horribly.
730 * All IMAP servers seem to get it right, and
731 * so does Eudora QPOP at least in 2.xx
734 * Microsoft Exchange gets it completely
735 * wrong, reporting compressed rather than
736 * actual sizes (so the actual length of
737 * message is longer than the reported size).
738 * Another fine example of Microsoft brain death!
740 * Some older POP servers, like the old UCB
741 * POP server and the pre-QPOP QUALCOMM
742 * versions, report a longer size in the LIST
743 * response than actually gets shipped up.
744 * It's unclear what is going on here, as the
745 * QUALCOMM server (at least) seems to be
746 * reporting the on-disk size correctly.
748 * qmail-pop3d also goofs up message sizes and does not
749 * count the line end characters properly.
751 if (msgblk.msglen != msgsize)
753 if (outlevel >= O_DEBUG)
755 GT_("message %s@%s:%d was not the expected length (%d actual != %d expected)\n"),
756 ctl->remotename, ctl->server.truename, num,
757 msgblk.msglen, msgsize);
760 /* end-of-message processing starts here */
761 if (!close_sink(ctl, &msgblk, !suppress_forward))
764 suppress_delete = TRUE;
772 * At this point in flow of control,
773 * either we've bombed on a protocol error
774 * or had delivery refused by the SMTP server
775 * or we've seen `accepted for delivery' and the message is shipped.
776 * It's safe to mark the message seen and delete it on the server now.
779 /* in softbounce mode, suppress deletion and marking as seen */
780 if (suppress_forward)
781 suppress_delete = suppress_delete || run.softbounce;
783 /* maybe we delete this message now? */
786 if (outlevel > O_SILENT)
787 report_complete(stdout, GT_(" retained\n"));
789 else if (ctl->server.base_protocol->delete_msg
791 && ((msgcode >= 0 && !ctl->keep)
792 || (msgcode == MSGLEN_OLD && ctl->flush)
793 || (msgcode == MSGLEN_TOOLARGE && ctl->limitflush)))
796 if (outlevel > O_SILENT)
797 report_complete(stdout, GT_(" flushed\n"));
798 err = (ctl->server.base_protocol->delete_msg)(mailserver_socket, ctl, num);
805 * To avoid flooding the logs when using --keep, report
806 * skipping of new messages only.
808 if (outlevel > O_SILENT && msgcode != MSGLEN_OLD)
809 report_complete(stdout, GT_(" not flushed\n"));
811 /* maybe we mark this message as seen now? */
812 if (ctl->server.base_protocol->mark_seen
814 && (msgcode >= 0 && ctl->keep))
816 err = (ctl->server.base_protocol->mark_seen)(mailserver_socket, ctl, num);
822 /* perhaps this as many as we're ready to handle */
823 if (maxfetch && maxfetch <= *fetches && num < count)
825 int remcount = count - (*fetches - initialfetches);
827 ngettext("fetchlimit %d reached; %d message left on server %s account %s\n",
828 "fetchlimit %d reached; %d messages left on server %s account %s\n", remcount),
829 maxfetch, remcount, ctl->server.truename, ctl->remotename);
832 } /* for (num = 1; num <= count; num++) */
837 /* retrieve messages from server using given protocol method table */
838 static int do_session(
839 /* parsed options with merged-in defaults */
841 /* protocol method table */
842 const struct method *proto,
843 /* maximum number of messages to fetch */
846 static int *msgsizes;
847 volatile int err, mailserver_socket = -1; /* pacifies -Wall */
849 int deletions = 0, js;
851 SIGHANDLERTYPE alrmsave;
853 ctl->server.base_protocol = proto;
858 init_transact(proto);
860 /* set up the server-nonresponse timeout */
861 alrmsave = set_signal_handler(SIGALRM, timeout_handler);
862 mytimeout = ctl->server.timeout;
864 if ((js = sigsetjmp(restart,1)))
866 /* exception caught */
869 sigfillset(&allsigs);
870 sigprocmask(SIG_UNBLOCK, &allsigs, NULL);
873 fm_freeaddrinfo(ai0); ai0 = NULL;
877 fm_freeaddrinfo(ai1); ai1 = NULL;
880 if (js == THROW_TIMEOUT)
882 if (phase == OPEN_WAIT)
884 GT_("timeout after %d seconds waiting to connect to server %s.\n"),
885 ctl->server.timeout, ctl->server.pollname);
886 else if (phase == SERVER_WAIT)
888 GT_("timeout after %d seconds waiting for server %s.\n"),
889 ctl->server.timeout, ctl->server.pollname);
890 else if (phase == FORWARDING_WAIT)
892 GT_("timeout after %d seconds waiting for %s.\n"),
894 ctl->mda ? "MDA" : "SMTP");
895 else if (phase == LISTENER_WAIT)
897 GT_("timeout after %d seconds waiting for listener to respond.\n"), ctl->server.timeout);
900 GT_("timeout after %d seconds.\n"), ctl->server.timeout);
903 * If we've exceeded our threshold for consecutive timeouts,
904 * try to notify the user, then mark the connection wedged.
905 * Don't do this if the connection can idle, though; idle
906 * timeouts just mean the frequency of mail is low.
908 if (timeoutcount > MAX_TIMEOUTS
909 && !open_warning_by_mail(ctl))
911 stuff_warning(iana_charset, ctl,
912 GT_("Subject: fetchmail sees repeated timeouts"));
913 stuff_warning(NULL, ctl, "%s", "");
914 stuff_warning(NULL, ctl,
915 GT_("Fetchmail saw more than %d timeouts while attempting to get mail from %s@%s.\n"),
917 ctl->remotename, ctl->server.truename);
918 stuff_warning(NULL, ctl,
919 GT_("This could mean that your mailserver is stuck, or that your SMTP\n" \
920 "server is wedged, or that your mailbox file on the server has been\n" \
921 "corrupted by a server error. You can run `fetchmail -v -v' to\n" \
922 "diagnose the problem.\n\n" \
923 "Fetchmail won't poll this mailbox again until you restart it.\n"));
924 close_warning_by_mail(ctl, (struct msgblk *)NULL);
934 /* sigsetjmp returned zero -> normal operation */
935 char buf[MSGBUFSIZE+1], *realhost;
936 int count, newm, bytes;
937 int fetches, dispatches, oldphase;
940 /* execute pre-initialization command, if any */
941 if (ctl->preconnect && (err = system(ctl->preconnect)))
943 if (WIFSIGNALED(err))
945 GT_("pre-connection command terminated with signal %d\n"), WTERMSIG(err));
948 GT_("pre-connection command failed with status %d\n"), WEXITSTATUS(err));
953 /* open a socket to the mail server */
956 set_timeout(mytimeout);
958 #ifdef HAVE_PKG_hesiod
959 /* If either the pollname or vianame are "hesiod" we want to
960 lookup the user's hesiod pobox host */
961 if (!strcasecmp(ctl->server.queryname, "hesiod")) {
962 struct hes_postoffice *hes_p;
963 hes_p = hes_getmailhost(ctl->remotename);
964 if (hes_p != NULL && strcmp(hes_p->po_type, "POP") == 0) {
965 free(ctl->server.queryname);
966 ctl->server.queryname = xstrdup(hes_p->po_host);
968 free(ctl->server.via);
969 ctl->server.via = xstrdup(hes_p->po_host);
972 GT_("couldn't find HESIOD pobox for %s\n"),
979 * Canonicalize the server truename for later use. This also
980 * functions as a probe for whether the mailserver is accessible.
981 * We try it on each poll cycle until we get a result. This way,
982 * fetchmail won't fail if started up when the network is inaccessible.
984 if (ctl->server.dns && !ctl->server.trueaddr)
986 if (ctl->server.lead_server)
988 char *leadname = ctl->server.lead_server->truename;
990 /* prevent core dump from ill-formed or duplicate entry */
993 report(stderr, GT_("Lead server has no name.\n"));
1000 xfree(ctl->server.truename);
1001 ctl->server.truename = xstrdup(leadname);
1005 struct addrinfo hints, *res;
1008 memset(&hints, 0, sizeof(hints));
1009 hints.ai_socktype = SOCK_STREAM;
1010 hints.ai_family = AF_UNSPEC;
1011 hints.ai_flags = AI_CANONNAME;
1012 #ifdef AI_ADDRCONFIG
1013 hints.ai_flags |= AI_ADDRCONFIG;
1016 error = fm_getaddrinfo(ctl->server.queryname, NULL, &hints, &res);
1020 GT_("couldn't find canonical DNS name of %s (%s): %s\n"),
1021 ctl->server.pollname, ctl->server.queryname,
1022 gai_strerror(error));
1030 xfree(ctl->server.truename);
1031 /* Older FreeBSD versions return NULL in ai_canonname
1032 * if they cannot canonicalize, rather than copying
1033 * the queryname here, as IEEE Std 1003.1-2001
1034 * requires. Work around NULL. */
1035 if (res->ai_canonname != NULL) {
1036 ctl->server.truename = xstrdup(res->ai_canonname);
1038 ctl->server.truename = xstrdup(ctl->server.queryname);
1040 ctl->server.trueaddr = (struct sockaddr *)xmalloc(res->ai_addrlen);
1041 ctl->server.trueaddr_len = res->ai_addrlen;
1042 memcpy(ctl->server.trueaddr, res->ai_addr, res->ai_addrlen);
1043 fm_freeaddrinfo(res);
1048 realhost = ctl->server.via ? ctl->server.via : ctl->server.pollname;
1050 /* allow time for the port to be set up if we have a plugin */
1051 if (ctl->server.plugin)
1053 if ((mailserver_socket = SockOpen(realhost,
1054 ctl->server.service ? ctl->server.service : ( ctl->use_ssl ? ctl->server.base_protocol->sslservice : ctl->server.base_protocol->service ),
1055 ctl->server.plugin, &ai0)) == -1)
1057 char errbuf[BUFSIZ];
1060 * Avoid generating a bogus error every poll cycle when we're
1061 * in daemon mode but the connection to the outside world
1064 if (!((err_no == EHOSTUNREACH || err_no == ENETUNREACH)
1065 && run.poll_interval))
1067 report_build(stderr, GT_("%s connection to %s failed"),
1068 ctl->server.base_protocol->name, ctl->server.pollname);
1069 strlcpy(errbuf, strerror(err_no), sizeof(errbuf));
1070 report_complete(stderr, ": %s\n", errbuf);
1080 /* Save the socket opened. Useful if Fetchmail hangs on SSLOpen
1081 * because the socket can be closed.
1083 mailserver_socket_temp = mailserver_socket;
1084 set_timeout(mytimeout);
1086 /* perform initial SSL handshake on open connection */
1088 SSLOpen(mailserver_socket, ctl->sslcert, ctl->sslkey,
1089 ctl->sslproto, ctl->sslcertck,
1090 ctl->sslcertfile, ctl->sslcertpath,
1091 ctl->sslfingerprint, ctl->sslcommonname ?
1092 ctl->sslcommonname : realhost, ctl->server.pollname,
1093 &ctl->remotename) == -1)
1095 report(stderr, GT_("SSL connection failed.\n"));
1100 /* Fetchmail didn't hang on SSLOpen,
1101 * then no need to set mailserver_socket_temp
1103 mailserver_socket_temp = -1;
1106 /* A timeout is still defined before SSLOpen,
1107 * then Fetchmail hanging on SSLOpen is handled.
1112 if (ctl->server.authenticate == A_KERBEROS_V4 && (strcasecmp(proto->name,"IMAP") != 0))
1114 set_timeout(mytimeout);
1115 err = kerberos_auth(mailserver_socket, ctl->server.truename,
1116 ctl->server.principal);
1121 #endif /* KERBEROS_V4 */
1124 if (ctl->server.authenticate == A_KERBEROS_V5)
1126 set_timeout(mytimeout);
1127 err = kerberos5_auth(mailserver_socket, ctl->server.truename);
1132 #endif /* KERBEROS_V5 */
1134 /* accept greeting message from mail server */
1135 err = (ctl->server.base_protocol->parse_response)(mailserver_socket, buf);
1139 /* try to get authorized to fetch mail */
1140 stage = STAGE_GETAUTH;
1141 if (ctl->server.base_protocol->getauth)
1143 set_timeout(mytimeout);
1144 err = (ctl->server.base_protocol->getauth)(mailserver_socket, ctl, buf);
1149 if (err == PS_LOCKBUSY)
1150 report(stderr, GT_("Lock-busy error on %s@%s\n"),
1152 ctl->server.truename);
1153 else if (err == PS_SERVBUSY)
1154 report(stderr, GT_("Server busy error on %s@%s\n"),
1156 ctl->server.truename);
1157 else if (err == PS_AUTHFAIL)
1159 report(stderr, GT_("Authorization failure on %s@%s%s\n"),
1161 ctl->server.truename,
1162 (ctl->wehaveauthed ? GT_(" (previously authorized)") : "")
1164 if (ctl->server.authenticate == A_ANY && !ctl->wehaveauthed) {
1165 report(stderr, GT_("For help, see http://www.fetchmail.info/fetchmail-FAQ.html#R15\n"));
1169 * If we're running in background, try to mail the
1170 * calling user a heads-up about the authentication
1171 * failure once it looks like this isn't a fluke
1172 * due to the server being temporarily inaccessible.
1173 * When we get third succesive failure, we notify the user
1174 * but only if we haven't already managed to get
1175 * authorization. After that, once we get authorization
1176 * we let the user know service is restored.
1178 if (run.poll_interval
1179 && !ctl->wehavesentauthnote
1180 && ((ctl->wehaveauthed && ++ctl->authfailcount >= 10)
1181 || (!ctl->wehaveauthed && ++ctl->authfailcount >= 3))
1182 && !open_warning_by_mail(ctl))
1184 ctl->wehavesentauthnote = 1;
1185 stuff_warning(iana_charset, ctl,
1186 GT_("Subject: fetchmail authentication failed on %s@%s"),
1187 ctl->remotename, ctl->server.truename);
1188 stuff_warning(NULL, ctl, "%s", "");
1189 stuff_warning(NULL, ctl,
1190 GT_("Fetchmail could not get mail from %s@%s.\n"),
1192 ctl->server.truename);
1193 if (ctl->wehaveauthed) {
1194 stuff_warning(NULL, ctl, GT_("\
1195 The attempt to get authorization failed.\n\
1196 Since we have already succeeded in getting authorization for this\n\
1197 connection, this is probably another failure mode (such as busy server)\n\
1198 that fetchmail cannot distinguish because the server didn't send a useful\n\
1200 stuff_warning(NULL, ctl, GT_("\
1202 However, if you HAVE changed your account details since starting the\n\
1203 fetchmail daemon, you need to stop the daemon, change your configuration\n\
1204 of fetchmail, and then restart the daemon.\n\
1206 The fetchmail daemon will continue running and attempt to connect\n\
1207 at each cycle. No future notifications will be sent until service\n\
1210 stuff_warning(NULL, ctl, GT_("\
1211 The attempt to get authorization failed.\n\
1212 This probably means your password is invalid, but some servers have\n\
1213 other failure modes that fetchmail cannot distinguish from this\n\
1214 because they don't send useful error messages on login failure.\n\
1216 The fetchmail daemon will continue running and attempt to connect\n\
1217 at each cycle. No future notifications will be sent until service\n\
1220 close_warning_by_mail(ctl, (struct msgblk *)NULL);
1223 else if (err == PS_REPOLL)
1225 if (outlevel >= O_VERBOSE)
1226 report(stderr, GT_("Repoll immediately on %s@%s\n"),
1228 ctl->server.truename);
1231 report(stderr, GT_("Unknown login or authentication error on %s@%s\n"),
1233 ctl->server.truename);
1240 * This connection has given us authorization at least once.
1242 * There are dodgy server (clubinternet.fr for example) that
1243 * give spurious authorization failures on patently good
1244 * account/password details, then 5 minutes later let you in!
1246 * This is meant to build in some tolerance of such nasty bits
1249 ctl->wehaveauthed = 1;
1250 /*if (ctl->authfailcount >= 3)*/
1251 if (ctl->wehavesentauthnote)
1253 ctl->wehavesentauthnote = 0;
1255 GT_("Authorization OK on %s@%s\n"),
1257 ctl->server.truename);
1258 if (!open_warning_by_mail(ctl))
1260 stuff_warning(iana_charset, ctl,
1261 GT_("Subject: fetchmail authentication OK on %s@%s"),
1262 ctl->remotename, ctl->server.truename);
1263 stuff_warning(NULL, ctl, "%s", "");
1264 stuff_warning(NULL, ctl,
1265 GT_("Fetchmail was able to log into %s@%s.\n"),
1267 ctl->server.truename);
1268 stuff_warning(NULL, ctl,
1269 GT_("Service has been restored.\n"));
1270 close_warning_by_mail(ctl, (struct msgblk *)NULL);
1275 * Reporting only after the first three
1276 * consecutive failures, or ten consecutive
1277 * failures after we have managed to get
1280 ctl->authfailcount = 0;
1284 ctl->errcount = fetches = 0;
1286 /* now iterate over each folder selected */
1287 for (idp = ctl->mailboxes; idp; idp = idp->next)
1289 ctl->folder = idp->id;
1295 /* reset timeout, in case we did an IDLE */
1296 mytimeout = ctl->server.timeout;
1298 if (outlevel >= O_DEBUG)
1301 report(stdout, GT_("selecting or re-polling folder %s\n"), idp->id);
1303 report(stdout, GT_("selecting or re-polling default folder\n"));
1306 /* compute # of messages and number of new messages waiting */
1307 stage = STAGE_GETRANGE;
1308 err = (ctl->server.base_protocol->getrange)(mailserver_socket, ctl, idp->id, &count, &newm, &bytes);
1312 /* show user how many messages we downloaded */
1314 (void) snprintf(buf, sizeof(buf),
1315 GT_("%s at %s (folder %s)"),
1316 ctl->remotename, ctl->server.pollname, idp->id);
1318 (void) snprintf(buf, sizeof(buf), GT_("%s at %s"),
1319 ctl->remotename, ctl->server.pollname);
1320 if (outlevel > O_SILENT)
1322 if (count == -1) /* only used for ETRN */
1323 report(stdout, GT_("Polling %s\n"), ctl->server.truename);
1324 else if (count != 0)
1326 if (newm != -1 && (count - newm) > 0)
1327 report_build(stdout, ngettext("%d message (%d %s) for %s", "%d messages (%d %s) for %s", (unsigned long)count),
1330 ngettext("seen", "seen", (unsigned long)count-newm),
1333 report_build(stdout, ngettext("%d message for %s",
1334 "%d messages for %s",
1338 report_complete(stdout, ".\n");
1340 report_complete(stdout, GT_(" (%d octets).\n"), bytes);
1344 /* these are pointless in normal daemon mode */
1345 if (pass == 1 && (run.poll_interval == 0 || outlevel >= O_VERBOSE))
1346 report(stdout, GT_("No mail for %s\n"), buf);
1350 /* very important, this is where we leave the do loop */
1356 if (newm == -1 || ctl->fetchall)
1358 fetches = newm; /* set error status correctly */
1360 * There used to be a `goto noerror' here, but this
1361 * prevented checking of multiple folders. This
1362 * comment is a reminder in case I introduced some
1363 * subtle bug by removing it...
1371 * Don't trust the message count passed by the server.
1372 * Without this check, it might be possible to do a
1373 * DNS-spoofing attack that would pass back a ridiculous
1374 * count, and allocate a malloc area that would overlap
1375 * a portion of the stack.
1377 if ((unsigned)count > INT_MAX/sizeof(int))
1379 report(stderr, GT_("bogus message count!"));
1385 * We need the size of each message before it's
1386 * loaded in order to pass it to the ESMTP SIZE
1387 * option. If the protocol has a getsizes method,
1388 * we presume this means it doesn't get reliable
1389 * sizes from message fetch responses.
1391 * If the protocol supports getting sizes of subset of
1392 * messages, we skip this step now.
1394 if (proto->getsizes &&
1395 !(proto->getpartialsizes && NUM_NONZERO(ctl->fetchsizelimit)))
1398 msgsizes = (int *)xmalloc(sizeof(int) * count);
1399 for (i = 0; i < count; i++)
1402 stage = STAGE_GETSIZES;
1403 err = (proto->getsizes)(mailserver_socket, count, msgsizes);
1410 for (i = 0; i < count; i++)
1411 bytes += msgsizes[i];
1415 /* read, forward, and delete messages */
1416 stage = STAGE_FETCH;
1418 /* fetch in lockstep mode */
1419 err = fetch_messages(mailserver_socket, ctl,
1422 &fetches, &dispatches, &deletions);
1423 if (err != PS_SUCCESS && err != PS_MAXFETCH)
1426 if (!check_only && ctl->skipped
1427 && run.poll_interval > 0 && !nodetach)
1429 clean_skipped_list(&ctl->skipped);
1430 send_size_warnings(ctl);
1434 /* end-of-mailbox processing before we repoll or switch to another one */
1435 if (ctl->server.base_protocol->end_mailbox_poll)
1437 tmperr = (ctl->server.base_protocol->end_mailbox_poll)(mailserver_socket, ctl);
1443 /* Return now if we have reached the fetchlimit */
1444 if (maxfetch && maxfetch <= fetches)
1448 * Only repoll if we either had some actual forwards
1449 * or are idling for new mails and had no errors.
1450 * Otherwise it is far too easy to get into infinite loops.
1452 (ctl->server.base_protocol->retry && (dispatches || ctl->idle) && !ctl->errcount);
1455 /* XXX: From this point onwards, preserve err unless a new error has occurred */
1458 /* PS_SUCCESS, PS_MAXFETCH: ordinary termination with no errors -- officially log out */
1459 stage = STAGE_LOGOUT;
1460 tmperr = (ctl->server.base_protocol->logout_cmd)(mailserver_socket, ctl);
1461 if (tmperr != PS_SUCCESS)
1464 * Hmmmm...arguably this would be incorrect if we had fetches but
1465 * no dispatches (due to oversized messages, etc.)
1467 else if (err == PS_SUCCESS && fetches == 0)
1470 * Close all SMTP delivery sockets. For optimum performance
1471 * we'd like to hold them open til end of run, but (1) this
1472 * loses if our poll interval is longer than the MTA's
1473 * inactivity timeout, and (2) some MTAs (like smail) don't
1474 * deliver after each message, but rather queue up mail and
1475 * wait to actually deliver it until the input socket is
1478 * don't send QUIT for ODMR case because we're acting as a
1479 * proxy between the SMTP server and client.
1481 smtp_close(ctl, ctl->server.protocol != P_ODMR);
1482 cleanupSockClose(mailserver_socket);
1486 /* we only get here on error */
1487 if (err != 0 && err != PS_SOCKET && err != PS_REPOLL)
1489 stage = STAGE_LOGOUT;
1490 (ctl->server.base_protocol->logout_cmd)(mailserver_socket, ctl);
1493 /* try to clean up all streams */
1496 * Sending SMTP QUIT on signal is theoretically nice, but led
1497 * to a subtle bug. If fetchmail was terminated by signal
1498 * while it was shipping message text, it would hang forever
1499 * waiting for a command acknowledge. In theory we could
1500 * enable the QUIT only outside of the message send. In
1501 * practice, we don't care. All mailservers hang up on a
1502 * dropped TCP/IP connection anyway.
1505 if (mailserver_socket != -1) {
1506 cleanupSockClose(mailserver_socket);
1508 /* If there was a connect timeout, the socket should be closed.
1509 * mailserver_socket_temp contains the socket to close.
1511 if (mailserver_socket_temp != -1) {
1512 cleanupSockClose(mailserver_socket_temp);
1513 mailserver_socket_temp = -1;
1517 /* no report on PS_AUTHFAIL */
1522 msg = GT_("socket");
1525 msg = GT_("missing or bad RFC822 header");
1531 msg = GT_("client/server synchronization");
1534 msg = GT_("client/server protocol");
1537 msg = GT_("lock busy on server");
1540 msg = GT_("SMTP transaction");
1543 msg = GT_("DNS lookup");
1546 msg = GT_("undefined");
1550 if (phase == FORWARDING_WAIT || phase == LISTENER_WAIT
1552 report(stderr, GT_("%s error while fetching from %s@%s and delivering to SMTP host %s\n"),
1553 msg, ctl->remotename, ctl->server.pollname,
1554 ctl->smtphost ? ctl->smtphost : GT_("unknown"));
1556 report(stderr, GT_("%s error while fetching from %s@%s\n"),
1557 msg, ctl->remotename, ctl->server.pollname);
1564 /* execute wrapup command, if any */
1565 if (ctl->postconnect && (tmperr = system(ctl->postconnect)))
1567 if (WIFSIGNALED(tmperr))
1568 report(stderr, GT_("post-connection command terminated with signal %d\n"), WTERMSIG(tmperr));
1570 report(stderr, GT_("post-connection command failed with status %d\n"), WEXITSTATUS(tmperr));
1571 if (err == PS_SUCCESS)
1575 set_timeout(0); /* cancel any pending alarm */
1576 set_signal_handler(SIGALRM, alrmsave);
1580 /** retrieve messages from server using given protocol method table */
1581 int do_protocol(struct query *ctl /** parsed options with merged-in defaults */,
1582 const struct method *proto /** protocol method table */)
1587 if (ctl->server.authenticate == A_KERBEROS_V4)
1589 report(stderr, GT_("Kerberos V4 support not linked.\n"));
1592 #endif /* KERBEROS_V4 */
1595 if (ctl->server.authenticate == A_KERBEROS_V5)
1597 report(stderr, GT_("Kerberos V5 support not linked.\n"));
1600 #endif /* KERBEROS_V5 */
1602 /* lacking methods, there are some options that may fail */
1605 /* check for unsupported options */
1608 GT_("Option --flush is not supported with %s\n"),
1612 else if (ctl->fetchall) {
1614 GT_("Option --all is not supported with %s\n"),
1619 if (!(proto->getsizes || proto->getpartialsizes)
1620 && NUM_SPECIFIED(ctl->limit))
1623 GT_("Option --limit is not supported with %s\n"),
1629 * If no expunge limit or we do expunges within the driver,
1630 * then just do one session, passing in any fetchlimit.
1632 if ((ctl->keep && !ctl->flush) ||
1633 proto->retry || !NUM_SPECIFIED(ctl->expunge))
1634 return(do_session(ctl, proto, NUM_VALUE_OUT(ctl->fetchlimit)));
1636 * There's an expunge limit, and it isn't handled in the driver itself.
1637 * OK; do multiple sessions, each fetching a limited # of messages.
1638 * Stop if the total count of retrieved messages exceeds ctl->fetchlimit
1639 * (if it was nonzero).
1645 int expunge = NUM_VALUE_OUT(ctl->expunge);
1646 int fetchlimit = NUM_VALUE_OUT(ctl->fetchlimit);
1649 if (fetchlimit > 0 && (expunge == 0 || expunge > fetchlimit - totalcount))
1650 expunge = fetchlimit - totalcount;
1651 err = do_session(ctl, proto, expunge);
1652 totalcount += expunge;
1653 if (NUM_SPECIFIED(ctl->fetchlimit) && totalcount >= fetchlimit)
1655 if (err != PS_LOCKBUSY)
1657 else if (lockouts >= MAX_LOCKOUTS)
1659 else /* err == PS_LOCKBUSY */
1662 * Allow time for the server lock to release. if we
1663 * don't do this, we'll often hit a locked-mailbox
1664 * condition and fail.
1670 (err == PS_MAXFETCH || err == PS_LOCKBUSY);
1677 /* driver.c ends here */