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"
56 /* throw types for runtime errors */
57 #define THROW_TIMEOUT 1 /* server timed out */
59 /* magic values for the message length array */
60 #define MSGLEN_UNKNOWN 0 /* length unknown (0 is impossible) */
61 #define MSGLEN_INVALID -1 /* length passed back is invalid */
62 #define MSGLEN_TOOLARGE -2 /* message is too large */
63 #define MSGLEN_OLD -3 /* message is old */
65 int pass; /* how many times have we re-polled? */
66 int stage; /* where are we? */
67 int phase; /* where are we, for error-logging purposes? */
68 int batchcount; /* count of messages sent in current batch */
69 flag peek_capable; /* can we peek for better error recovery? */
70 int mailserver_socket_temp = -1; /* socket to free if connect timeout */
72 struct addrinfo *ai0, *ai1; /* clean these up after signal */
74 static volatile int timeoutcount = 0; /* count consecutive timeouts */
75 static volatile int idletimeout = 0; /* timeout occured in idle stage? */
77 static sigjmp_buf restart;
79 int is_idletimeout(void)
80 /* last timeout occured in idle stage? */
85 void resetidletimeout(void)
90 void set_timeout(int timeleft)
91 /* reset the nonresponse-timeout */
93 #if !defined(__EMX__) && !defined(__BEOS__)
94 struct itimerval ntimeout;
99 ntimeout.it_interval.tv_sec = ntimeout.it_interval.tv_usec = 0;
100 ntimeout.it_value.tv_sec = timeleft;
101 ntimeout.it_value.tv_usec = 0;
102 setitimer(ITIMER_REAL, &ntimeout, (struct itimerval *)NULL);
106 static RETSIGTYPE timeout_handler (int signal)
107 /* handle SIGALRM signal indicating a server timeout */
110 if(stage != STAGE_IDLE) {
112 /* XXX FIXME: this siglongjmp must die - it's not safe to be
113 * called from a function handler and breaks, for instance,
115 siglongjmp(restart, THROW_TIMEOUT);
120 #define CLEANUP_TIMEOUT 60 /* maximum timeout during cleanup */
122 static int cleanupSockClose (int fd)
123 /* close sockets in maximum CLEANUP_TIMEOUT seconds during cleanup */
126 SIGHANDLERTYPE alrmsave;
127 alrmsave = set_signal_handler(SIGALRM, null_signal_handler);
128 set_timeout(CLEANUP_TIMEOUT);
129 scerror = SockClose(fd);
131 set_signal_handler(SIGALRM, alrmsave);
136 static int kerberos_auth(socket, canonical, principal)
137 /* authenticate to the server host using Kerberos V4 */
138 int socket; /* socket to server host */
139 char *canonical; /* server name */
145 Key_schedule schedule;
147 char * prin_copy = (char *) NULL;
148 char * prin = (char *) NULL;
149 char * inst = (char *) NULL;
150 char * realm = (char *) NULL;
152 if (principal != (char *)NULL && *principal)
155 prin = prin_copy = xstrdup(principal);
156 for (cp = prin_copy; *cp && *cp != '.'; ++cp)
162 while (*cp && *cp != '@')
172 ticket = xmalloc(sizeof (KTEXT_ST));
173 rem = (krb_sendauth (0L, socket, ticket,
175 inst ? inst : canonical,
176 realm ? realm : ((char *) (krb_realmofhost (canonical))),
181 ((struct sockaddr_in *) 0),
182 ((struct sockaddr_in *) 0),
191 report(stderr, GT_("kerberos error %s\n"), (krb_get_err_text (rem)));
192 return (PS_AUTHFAIL);
196 #endif /* KERBEROS_V4 */
199 static int kerberos5_auth(socket, canonical)
200 /* authenticate to the server host using Kerberos V5 */
201 int socket; /* socket to server host */
202 const char *canonical; /* server name */
204 krb5_error_code retval;
205 krb5_context context;
207 krb5_principal client = NULL, server = NULL;
208 krb5_error *err_ret = NULL;
210 krb5_auth_context auth_context = NULL;
212 krb5_init_context(&context);
213 krb5_auth_con_init(context, &auth_context);
215 if ((retval = krb5_cc_default(context, &ccdef))) {
216 report(stderr, "krb5_cc_default: %s\n", error_message(retval));
220 if ((retval = krb5_cc_get_principal(context, ccdef, &client))) {
221 report(stderr, "krb5_cc_get_principal: %s\n", error_message(retval));
225 if ((retval = krb5_sname_to_principal(context, canonical, "pop",
228 report(stderr, "krb5_sname_to_principal: %s\n", error_message(retval));
232 retval = krb5_sendauth(context, &auth_context, (krb5_pointer) &socket,
233 "KPOPV1.0", client, server,
234 AP_OPTS_MUTUAL_REQUIRED,
235 NULL, /* no data to checksum */
236 0, /* no creds, use ccache instead */
240 NULL); /* don't need reply */
242 krb5_free_principal(context, server);
243 krb5_free_principal(context, client);
244 krb5_auth_con_free(context, auth_context);
248 if (err_ret && err_ret->e_text) {
249 report(stderr, GT_("krb5_sendauth: %s [server says '%s']\n"),
250 error_message(retval),
253 if (err_ret && err_ret->text.length) {
254 report(stderr, GT_("krb5_sendauth: %s [server says '%*s']\n"),
255 error_message(retval),
256 err_ret->text.length,
259 krb5_free_error(context, err_ret);
261 report(stderr, "krb5_sendauth: %s\n", error_message(retval));
267 #endif /* KERBEROS_V5 */
269 static void clean_skipped_list(struct idlist **skipped_list)
270 /* struct "idlist" contains no "prev" ptr; we must remove unused items first */
272 struct idlist *current=NULL, *prev=NULL, *tmp=NULL, *head=NULL;
273 prev = current = head = *skipped_list;
279 /* if item has no reference, remove it */
280 if (current && current->val.status.mark == 0)
282 if (current == head) /* remove first item (head) */
284 head = current->next;
285 if (current->id) free(current->id);
287 prev = current = head;
289 else /* remove middle/last item */
293 if (current->id) free(current->id);
298 else /* skip this item */
301 current = current->next;
305 *skipped_list = head;
308 static void send_size_warnings(struct query *ctl)
309 /* send warning mail with skipped msg; reset msg count when user notified */
312 int msg_to_send = FALSE;
313 struct idlist *head=NULL, *current=NULL;
314 int max_warning_poll_count;
320 /* don't start a notification message unless we need to */
321 for (current = head; current; current = current->next)
322 if (current->val.status.num == 0 && current->val.status.mark)
328 * There's no good way to recover if we can't send notification mail,
329 * but it's not a disaster, either, since the skipped mail will not
332 if (open_warning_by_mail(ctl))
334 stuff_warning(iana_charset, ctl,
335 GT_("Subject: Fetchmail oversized-messages warning"));
336 stuff_warning(NULL, ctl, "%s", "");
338 stuff_warning(NULL, ctl,
339 GT_("The following oversized messages were deleted on server %s account %s:"),
340 ctl->server.pollname, ctl->remotename);
342 stuff_warning(NULL, ctl,
343 GT_("The following oversized messages remain on server %s account %s:"),
344 ctl->server.pollname, ctl->remotename);
346 stuff_warning(NULL, ctl, "%s", "");
348 if (run.poll_interval == 0)
349 max_warning_poll_count = 0;
351 max_warning_poll_count = ctl->warnings/run.poll_interval;
353 /* parse list of skipped msg, adding items to the mail */
354 for (current = head; current; current = current->next)
356 if (current->val.status.num == 0 && current->val.status.mark)
358 nbr = current->val.status.mark;
359 size = atoi(current->id);
361 stuff_warning(NULL, ctl,
362 ngettext(" %d message %d octets long deleted by fetchmail.",
363 " %d messages %d octets long deleted by fetchmail.", nbr),
366 stuff_warning(NULL, ctl,
367 ngettext(" %d message %d octets long skipped by fetchmail.",
368 " %d messages %d octets long skipped by fetchmail.", nbr),
371 current->val.status.num++;
372 current->val.status.mark = 0;
374 if (current->val.status.num >= max_warning_poll_count)
375 current->val.status.num = 0;
378 stuff_warning(NULL, ctl, "%s", "");
380 close_warning_by_mail(ctl, (struct msgblk *)NULL);
383 static void mark_oversized(struct query *ctl, int size)
384 /* mark a message oversized */
386 struct idlist *current=NULL, *tmp=NULL;
390 /* convert size to string */
391 snprintf(sizestr, sizeof(sizestr), "%d", size);
393 /* build a list of skipped messages
394 * val.id = size of msg (string cnvt)
395 * val.status.num = warning_poll_count
396 * val.status.mask = nbr of msg this size
399 current = ctl->skipped;
401 /* initialise warning_poll_count to the
402 * current value so that all new msg will
403 * be included in the next mail
405 cnt = current ? current->val.status.num : 0;
407 /* if entry exists, increment the count */
408 if (current && (tmp = str_in_list(¤t, sizestr, FALSE)))
410 tmp->val.status.mark++;
412 /* otherwise, create a new entry */
413 /* initialise with current poll count */
416 tmp = save_str(&ctl->skipped, sizestr, 1);
417 tmp->val.status.num = cnt;
421 static int eat_trailer(int sock, struct query *ctl)
423 /* we only need this LF if we're printing ticker dots
424 * AND we are dumping protocol traces. */
425 if (outlevel >= O_VERBOSE && want_progress()) fputc('\n', stdout);
426 return (ctl->server.base_protocol->trail)(sock, ctl, tag);
429 static int fetch_messages(int mailserver_socket, struct query *ctl,
430 int count, int **msgsizes, int maxfetch,
431 int *fetches, int *dispatches, int *deletions)
432 /* fetch messages in lockstep mode */
434 flag force_retrieval;
435 int num, firstnum = 1, lastnum = 0, err, len;
436 int fetchsizelimit = ctl->fetchsizelimit;
438 int initialfetches = *fetches;
440 if (ctl->server.base_protocol->getpartialsizes && NUM_NONZERO(fetchsizelimit))
442 /* for POP3, we can get the size of one mail only! Unfortunately, this
443 * protocol specific test cannot be done elsewhere as the protocol
444 * could be "auto". */
445 switch (ctl->server.protocol)
447 case P_POP3: case P_APOP: case P_RPOP:
451 /* Time to allocate memory to store the sizes */
453 *msgsizes = (int *)xmalloc(sizeof(int) * fetchsizelimit);
457 * What forces this code is that in POP2 and
458 * IMAP2bis you can't fetch a message without
459 * having it marked `seen'. In POP3 and IMAP4, on the
460 * other hand, you can (peek_capable is set by
461 * each driver module to convey this; it's not a
462 * method constant because of the difference between
463 * IMAP2bis and IMAP4, and because POP3 doesn't peek
464 * if fetchall is on).
466 * The result of being unable to peek is that if there's
467 * any kind of transient error (DNS lookup failure, or
468 * sendmail refusing delivery due to process-table limits)
469 * the message will be marked "seen" on the server without
470 * having been delivered. This is not a big problem if
471 * fetchmail is running in foreground, because the user
472 * will see a "skipped" message when it next runs and get
475 * But in daemon mode this leads to the message
476 * being silently ignored forever. This is not
479 * We compensate for this by checking the error
480 * count from the previous pass and forcing all
481 * messages to be considered new if it's nonzero.
483 force_retrieval = !peek_capable && (ctl->errcount > 0);
485 for (num = 1; num <= count; num++)
487 flag suppress_delete = FALSE;
488 flag suppress_forward = FALSE;
489 flag suppress_readbody = FALSE;
490 flag retained = FALSE;
491 int msgcode = MSGLEN_UNKNOWN;
493 /* check if the message is old
494 * Note: the size of the message may not be known here */
495 if (ctl->fetchall || force_retrieval) {
498 if (ctl->server.base_protocol->is_old && (ctl->server.base_protocol->is_old)(mailserver_socket,ctl,num)) {
499 msgcode = MSGLEN_OLD;
502 if (msgcode == MSGLEN_OLD)
504 /* To avoid flooding the syslog when using --keep,
505 * report "Skipped message" only when:
506 * 1) --verbose is on, or
507 * 2) fetchmail does not use syslog
509 if ( (outlevel >= O_VERBOSE) ||
510 (outlevel > O_SILENT && !run.use_syslog)
514 GT_("skipping message %s@%s:%d"),
515 ctl->remotename, ctl->server.truename, num);
521 if (ctl->server.base_protocol->getpartialsizes && NUM_NONZERO(fetchsizelimit) &&
524 /* Instead of getting the sizes of all mails at the start, we get
525 * the sizes in blocks of fetchsizelimit. This leads to better
526 * performance when there are too many mails (say, 10000) in
527 * the mailbox and either we are not getting all the mails at
528 * one go (--fetchlimit 100) or there is a frequent socket
529 * error while just getting the sizes of all mails! */
532 int oldstage = stage;
534 lastnum = num + fetchsizelimit - 1;
537 for (i = 0; i < fetchsizelimit; i++)
540 stage = STAGE_GETSIZES;
541 err = (ctl->server.base_protocol->getpartialsizes)(mailserver_socket, num, lastnum, *msgsizes);
548 msgsize = *msgsizes ? (*msgsizes)[num-firstnum] : 0;
550 /* check if the message is oversized */
551 if (NUM_NONZERO(ctl->limit) && (msgsize > ctl->limit))
552 msgcode = MSGLEN_TOOLARGE;
553 /* else if (msgsize == 512)
554 msgcode = MSGLEN_OLD; (hmh) sample code to skip message */
558 if (msgcode == MSGLEN_TOOLARGE)
560 mark_oversized(ctl, msgsize);
561 if (!ctl->limitflush)
562 suppress_delete = TRUE;
564 if (outlevel > O_SILENT)
566 /* old messages are already handled above */
568 GT_("skipping message %s@%s:%d (%d octets)"),
569 ctl->remotename, ctl->server.truename, num,
575 * Invalid lengths are produced by Post Office/NT's
576 * annoying habit of randomly prepending bogus
577 * LIST items of length -1. Patrick Audley
578 * <paudley@pobox.com> tells us: LIST shows a
579 * size of -1, RETR and TOP return "-ERR
580 * System error - couldn't open message", and
581 * DELE succeeds but doesn't actually delete
584 report_build(stdout, GT_(" (length -1)"));
586 case MSGLEN_TOOLARGE:
587 report_build(stdout, GT_(" (oversized)"));
594 /* XXX FIXME: make this one variable, wholesize and
595 separatefetchbody query the same variable just with
597 flag wholesize = !ctl->server.base_protocol->fetch_body;
598 flag separatefetchbody = (ctl->server.base_protocol->fetch_body) ? TRUE : FALSE;
600 /* request a message */
601 err = (ctl->server.base_protocol->fetch_headers)(mailserver_socket,ctl,num, &len);
602 if (err == PS_TRANSIENT) /* server is probably Exchange */
605 GT_("couldn't fetch headers, message %s@%s:%d (%d octets)\n"),
606 ctl->remotename, ctl->server.truename, num,
613 /* -1 means we didn't see a size in the response */
620 if (outlevel > O_SILENT)
622 report_build(stdout, GT_("reading message %s@%s:%d of %d"),
623 ctl->remotename, ctl->server.truename,
627 report_build(stdout, wholesize ? GT_(" (%d octets)")
628 : GT_(" (%d header octets)"), len);
629 if (want_progress()) {
630 /* flush and add a blank to append ticker dots */
631 report_flush(stdout);
637 * Read the message headers and ship them to the
640 err = readheaders(mailserver_socket, len, msgsize,
642 /* pass the suppress_readbody flag only if the underlying
643 * protocol does not fetch the body separately */
644 separatefetchbody ? 0 : &suppress_readbody);
646 if (err == PS_RETAINED)
647 suppress_forward = suppress_delete = retained = TRUE;
648 else if (err == PS_TRANSIENT)
649 suppress_delete = suppress_forward = TRUE;
650 else if (err == PS_REFUSED)
651 suppress_forward = TRUE;
655 /* tell server we got it OK and resynchronize */
656 if (separatefetchbody && ctl->server.base_protocol->trail)
658 err = eat_trailer(mailserver_socket, ctl);
659 if (err) return(err);
662 /* do not read the body which is not being forwarded only if
663 * the underlying protocol allows the body to be fetched
665 if (separatefetchbody && suppress_forward)
666 suppress_readbody = TRUE;
669 * If we're using IMAP4 or something else that
670 * can fetch headers separately from bodies,
671 * it's time to request the body now. This
672 * fetch may be skipped if we got an anti-spam
673 * or other PS_REFUSED error response during
676 if (!suppress_readbody)
678 if (separatefetchbody)
681 if ((err=(ctl->server.base_protocol->fetch_body)(mailserver_socket,ctl,num,&len)))
684 * Work around a bug in Novell's
685 * broken GroupWise IMAP server;
686 * its body FETCH response is missing
687 * the required length for the data
688 * string. This violates RFC2060.
691 len = msgsize - msgblk.msglen;
693 if (outlevel > O_SILENT)
695 GT_(" (%d body octets)"), len);
696 if (want_progress()) {
697 report_flush(stdout);
703 /* process the body now */
704 err = readbody(mailserver_socket,
709 if (err == PS_TRANSIENT)
710 suppress_delete = suppress_forward = TRUE;
714 /* tell server we got it OK and resynchronize */
715 if (ctl->server.base_protocol->trail) {
716 err = eat_trailer(mailserver_socket, ctl);
717 if (err) return(err);
721 /* count # messages forwarded on this pass */
722 if (!suppress_forward)
726 * Check to see if the numbers matched?
728 * Yes, some servers foo this up horribly.
729 * All IMAP servers seem to get it right, and
730 * so does Eudora QPOP at least in 2.xx
733 * Microsoft Exchange gets it completely
734 * wrong, reporting compressed rather than
735 * actual sizes (so the actual length of
736 * message is longer than the reported size).
737 * Another fine example of Microsoft brain death!
739 * Some older POP servers, like the old UCB
740 * POP server and the pre-QPOP QUALCOMM
741 * versions, report a longer size in the LIST
742 * response than actually gets shipped up.
743 * It's unclear what is going on here, as the
744 * QUALCOMM server (at least) seems to be
745 * reporting the on-disk size correctly.
747 * qmail-pop3d also goofs up message sizes and does not
748 * count the line end characters properly.
750 if (msgblk.msglen != msgsize)
752 if (outlevel >= O_DEBUG)
754 GT_("message %s@%s:%d was not the expected length (%d actual != %d expected)\n"),
755 ctl->remotename, ctl->server.truename, num,
756 msgblk.msglen, msgsize);
759 /* end-of-message processing starts here */
760 if (!close_sink(ctl, &msgblk, !suppress_forward))
763 suppress_delete = TRUE;
771 * At this point in flow of control,
772 * either we've bombed on a protocol error
773 * or had delivery refused by the SMTP server
774 * or we've seen `accepted for delivery' and the message is shipped.
775 * It's safe to mark the message seen and delete it on the server now.
778 /* in softbounce mode, suppress deletion and marking as seen */
779 if (suppress_forward)
780 suppress_delete = suppress_delete || run.softbounce;
782 /* maybe we delete this message now? */
785 if (outlevel > O_SILENT)
786 report_complete(stdout, GT_(" retained\n"));
788 else if (ctl->server.base_protocol->delete_msg
790 && ((msgcode >= 0 && !ctl->keep)
791 || (msgcode == MSGLEN_OLD && ctl->flush)
792 || (msgcode == MSGLEN_TOOLARGE && ctl->limitflush)))
795 if (outlevel > O_SILENT)
796 report_complete(stdout, GT_(" flushed\n"));
797 err = (ctl->server.base_protocol->delete_msg)(mailserver_socket, ctl, num);
803 if ( (outlevel >= O_VERBOSE) ||
804 /* To avoid flooding the syslog when using --keep,
805 * report "Skipped message" only when:
806 * 1) --verbose is on, or
807 * 2) fetchmail does not use syslog, or
808 * 3) the message was skipped for some other
809 * reason than just being old.
811 (outlevel > O_SILENT && (!run.use_syslog || msgcode != MSGLEN_OLD))
813 report_complete(stdout, GT_(" not flushed\n"));
815 /* maybe we mark this message as seen now? */
816 if (ctl->server.base_protocol->mark_seen
818 && (msgcode >= 0 && ctl->keep))
820 err = (ctl->server.base_protocol->mark_seen)(mailserver_socket, ctl, num);
826 /* perhaps this as many as we're ready to handle */
827 if (maxfetch && maxfetch <= *fetches && num < count)
829 int remcount = count - (*fetches - initialfetches);
831 ngettext("fetchlimit %d reached; %d message left on server %s account %s\n",
832 "fetchlimit %d reached; %d messages left on server %s account %s\n", remcount),
833 maxfetch, remcount, ctl->server.truename, ctl->remotename);
836 } /* for (num = 1; num <= count; num++) */
841 /* retrieve messages from server using given protocol method table */
842 static int do_session(
843 /* parsed options with merged-in defaults */
845 /* protocol method table */
846 const struct method *proto,
847 /* maximum number of messages to fetch */
850 static int *msgsizes;
851 volatile int err, mailserver_socket = -1; /* pacifies -Wall */
853 int deletions = 0, js;
855 SIGHANDLERTYPE alrmsave;
857 ctl->server.base_protocol = proto;
862 init_transact(proto);
864 /* set up the server-nonresponse timeout */
865 alrmsave = set_signal_handler(SIGALRM, timeout_handler);
866 mytimeout = ctl->server.timeout;
868 if ((js = sigsetjmp(restart,1)))
870 /* exception caught */
873 sigfillset(&allsigs);
874 sigprocmask(SIG_UNBLOCK, &allsigs, NULL);
877 fm_freeaddrinfo(ai0); ai0 = NULL;
881 fm_freeaddrinfo(ai1); ai1 = NULL;
884 if (js == THROW_TIMEOUT)
886 if (phase == OPEN_WAIT)
888 GT_("timeout after %d seconds waiting to connect to server %s.\n"),
889 ctl->server.timeout, ctl->server.pollname);
890 else if (phase == SERVER_WAIT)
892 GT_("timeout after %d seconds waiting for server %s.\n"),
893 ctl->server.timeout, ctl->server.pollname);
894 else if (phase == FORWARDING_WAIT)
896 GT_("timeout after %d seconds waiting for %s.\n"),
898 ctl->mda ? "MDA" : "SMTP");
899 else if (phase == LISTENER_WAIT)
901 GT_("timeout after %d seconds waiting for listener to respond.\n"), ctl->server.timeout);
904 GT_("timeout after %d seconds.\n"), ctl->server.timeout);
907 * If we've exceeded our threshold for consecutive timeouts,
908 * try to notify the user, then mark the connection wedged.
909 * Don't do this if the connection can idle, though; idle
910 * timeouts just mean the frequency of mail is low.
912 if (timeoutcount > MAX_TIMEOUTS
913 && !open_warning_by_mail(ctl))
915 stuff_warning(iana_charset, ctl,
916 GT_("Subject: fetchmail sees repeated timeouts"));
917 stuff_warning(NULL, ctl, "%s", "");
918 stuff_warning(NULL, ctl,
919 GT_("Fetchmail saw more than %d timeouts while attempting to get mail from %s@%s.\n"),
921 ctl->remotename, ctl->server.truename);
922 stuff_warning(NULL, ctl,
923 GT_("This could mean that your mailserver is stuck, or that your SMTP\n" \
924 "server is wedged, or that your mailbox file on the server has been\n" \
925 "corrupted by a server error. You can run `fetchmail -v -v' to\n" \
926 "diagnose the problem.\n\n" \
927 "Fetchmail won't poll this mailbox again until you restart it.\n"));
928 close_warning_by_mail(ctl, (struct msgblk *)NULL);
938 /* sigsetjmp returned zero -> normal operation */
939 char buf[MSGBUFSIZE+1], *realhost;
940 int count, newm, bytes;
941 int fetches, dispatches, oldphase;
944 /* execute pre-initialization command, if any */
945 if (ctl->preconnect && (err = system(ctl->preconnect)))
947 if (WIFSIGNALED(err))
949 GT_("pre-connection command terminated with signal %d\n"), WTERMSIG(err));
952 GT_("pre-connection command failed with status %d\n"), WEXITSTATUS(err));
957 /* open a socket to the mail server */
960 set_timeout(mytimeout);
962 #ifdef HAVE_PKG_hesiod
963 /* If either the pollname or vianame are "hesiod" we want to
964 lookup the user's hesiod pobox host */
965 if (!strcasecmp(ctl->server.queryname, "hesiod")) {
966 struct hes_postoffice *hes_p;
967 hes_p = hes_getmailhost(ctl->remotename);
968 if (hes_p != NULL && strcmp(hes_p->po_type, "POP") == 0) {
969 free(ctl->server.queryname);
970 ctl->server.queryname = xstrdup(hes_p->po_host);
972 free(ctl->server.via);
973 ctl->server.via = xstrdup(hes_p->po_host);
976 GT_("couldn't find HESIOD pobox for %s\n"),
983 * Canonicalize the server truename for later use. This also
984 * functions as a probe for whether the mailserver is accessible.
985 * We try it on each poll cycle until we get a result. This way,
986 * fetchmail won't fail if started up when the network is inaccessible.
988 if (ctl->server.dns && !ctl->server.trueaddr)
990 if (ctl->server.lead_server)
992 char *leadname = ctl->server.lead_server->truename;
994 /* prevent core dump from ill-formed or duplicate entry */
997 report(stderr, GT_("Lead server has no name.\n"));
1004 xfree(ctl->server.truename);
1005 ctl->server.truename = xstrdup(leadname);
1009 struct addrinfo hints, *res;
1012 memset(&hints, 0, sizeof(hints));
1013 hints.ai_socktype = SOCK_STREAM;
1014 hints.ai_family = AF_UNSPEC;
1015 hints.ai_flags = AI_CANONNAME;
1016 #ifdef AI_ADDRCONFIG
1017 hints.ai_flags |= AI_ADDRCONFIG;
1020 error = fm_getaddrinfo(ctl->server.queryname, NULL, &hints, &res);
1024 GT_("couldn't find canonical DNS name of %s (%s): %s\n"),
1025 ctl->server.pollname, ctl->server.queryname,
1026 gai_strerror(error));
1034 xfree(ctl->server.truename);
1035 /* Older FreeBSD versions return NULL in ai_canonname
1036 * if they cannot canonicalize, rather than copying
1037 * the queryname here, as IEEE Std 1003.1-2001
1038 * requires. Work around NULL. */
1039 if (res->ai_canonname != NULL) {
1040 ctl->server.truename = xstrdup(res->ai_canonname);
1042 ctl->server.truename = xstrdup(ctl->server.queryname);
1044 ctl->server.trueaddr = (struct sockaddr *)xmalloc(res->ai_addrlen);
1045 ctl->server.trueaddr_len = res->ai_addrlen;
1046 memcpy(ctl->server.trueaddr, res->ai_addr, res->ai_addrlen);
1047 fm_freeaddrinfo(res);
1052 realhost = ctl->server.via ? ctl->server.via : ctl->server.pollname;
1054 /* allow time for the port to be set up if we have a plugin */
1055 if (ctl->server.plugin)
1057 if ((mailserver_socket = SockOpen(realhost,
1058 ctl->server.service ? ctl->server.service : ( ctl->use_ssl ? ctl->server.base_protocol->sslservice : ctl->server.base_protocol->service ),
1059 ctl->server.plugin, &ai0)) == -1)
1061 char errbuf[BUFSIZ];
1064 * Avoid generating a bogus error every poll cycle when we're
1065 * in daemon mode but the connection to the outside world
1068 if (!((err_no == EHOSTUNREACH || err_no == ENETUNREACH)
1069 && run.poll_interval))
1071 report_build(stderr, GT_("%s connection to %s failed"),
1072 ctl->server.base_protocol->name, ctl->server.pollname);
1073 strlcpy(errbuf, strerror(err_no), sizeof(errbuf));
1074 report_complete(stderr, ": %s\n", errbuf);
1078 * Don't use this. It was an attempt to address Debian bug
1079 * #47143 (Notify user by mail when pop server nonexistent).
1080 * Trouble is, that doesn't work; you trip over the case
1081 * where your SLIP or PPP link is down...
1083 /* warn the system administrator */
1084 if (open_warning_by_mail(ctl) == 0)
1086 stuff_warning(iana_charset, ctl,
1087 GT_("Subject: Fetchmail unreachable-server warning."));
1088 stuff_warning(NULL, ctl, "");
1089 stuff_warning(NULL, ctl, GT_("Fetchmail could not reach the mail server %s:"),
1090 ctl->server.pollname);
1091 stuff_warning(NULL, ctl, errbuf, ctl->server.pollname);
1092 close_warning_by_mail(ctl, (struct msgblk *)NULL);
1103 /* Save the socket opened. Useful if Fetchmail hangs on SSLOpen
1104 * because the socket can be closed.
1106 mailserver_socket_temp = mailserver_socket;
1107 set_timeout(mytimeout);
1109 /* perform initial SSL handshake on open connection */
1111 SSLOpen(mailserver_socket, ctl->sslcert, ctl->sslkey,
1112 ctl->sslproto, ctl->sslcertck, ctl->sslcertpath,
1113 ctl->sslfingerprint, ctl->sslcommonname ?
1114 ctl->sslcommonname : realhost, ctl->server.pollname,
1115 &ctl->remotename) == -1)
1117 report(stderr, GT_("SSL connection failed.\n"));
1122 /* Fetchmail didn't hang on SSLOpen,
1123 * then no need to set mailserver_socket_temp
1125 mailserver_socket_temp = -1;
1128 /* A timeout is still defined before SSLOpen,
1129 * then Fetchmail hanging on SSLOpen is handled.
1134 if (ctl->server.authenticate == A_KERBEROS_V4 && (strcasecmp(proto->name,"IMAP") != 0))
1136 set_timeout(mytimeout);
1137 err = kerberos_auth(mailserver_socket, ctl->server.truename,
1138 ctl->server.principal);
1143 #endif /* KERBEROS_V4 */
1146 if (ctl->server.authenticate == A_KERBEROS_V5)
1148 set_timeout(mytimeout);
1149 err = kerberos5_auth(mailserver_socket, ctl->server.truename);
1154 #endif /* KERBEROS_V5 */
1156 /* accept greeting message from mail server */
1157 err = (ctl->server.base_protocol->parse_response)(mailserver_socket, buf);
1161 /* try to get authorized to fetch mail */
1162 stage = STAGE_GETAUTH;
1163 if (ctl->server.base_protocol->getauth)
1165 err = (ctl->server.base_protocol->getauth)(mailserver_socket, ctl, buf);
1169 if (err == PS_LOCKBUSY)
1170 report(stderr, GT_("Lock-busy error on %s@%s\n"),
1172 ctl->server.truename);
1173 else if (err == PS_SERVBUSY)
1174 report(stderr, GT_("Server busy error on %s@%s\n"),
1176 ctl->server.truename);
1177 else if (err == PS_AUTHFAIL)
1179 report(stderr, GT_("Authorization failure on %s@%s%s\n"),
1181 ctl->server.truename,
1182 (ctl->wehaveauthed ? GT_(" (previously authorized)") : "")
1186 * If we're running in background, try to mail the
1187 * calling user a heads-up about the authentication
1188 * failure once it looks like this isn't a fluke
1189 * due to the server being temporarily inaccessible.
1190 * When we get third succesive failure, we notify the user
1191 * but only if we haven't already managed to get
1192 * authorization. After that, once we get authorization
1193 * we let the user know service is restored.
1195 if (run.poll_interval
1196 && !ctl->wehavesentauthnote
1197 && ((ctl->wehaveauthed && ++ctl->authfailcount >= 10)
1198 || (!ctl->wehaveauthed && ++ctl->authfailcount >= 3))
1199 && !open_warning_by_mail(ctl))
1201 ctl->wehavesentauthnote = 1;
1202 stuff_warning(iana_charset, ctl,
1203 GT_("Subject: fetchmail authentication failed on %s@%s"),
1204 ctl->remotename, ctl->server.truename);
1205 stuff_warning(NULL, ctl, "%s", "");
1206 stuff_warning(NULL, ctl,
1207 GT_("Fetchmail could not get mail from %s@%s.\n"),
1209 ctl->server.truename);
1210 if (ctl->wehaveauthed) {
1211 stuff_warning(NULL, ctl, GT_("\
1212 The attempt to get authorization failed.\n\
1213 Since we have already succeeded in getting authorization for this\n\
1214 connection, this is probably another failure mode (such as busy server)\n\
1215 that fetchmail cannot distinguish because the server didn't send a useful\n\
1217 stuff_warning(NULL, ctl, GT_("\
1219 However, if you HAVE changed your account details since starting the\n\
1220 fetchmail daemon, you need to stop the daemon, change your configuration\n\
1221 of fetchmail, and then restart the daemon.\n\
1223 The fetchmail daemon will continue running and attempt to connect\n\
1224 at each cycle. No future notifications will be sent until service\n\
1227 stuff_warning(NULL, ctl, GT_("\
1228 The attempt to get authorization failed.\n\
1229 This probably means your password is invalid, but some servers have\n\
1230 other failure modes that fetchmail cannot distinguish from this\n\
1231 because they don't send useful error messages on login failure.\n\
1233 The fetchmail daemon will continue running and attempt to connect\n\
1234 at each cycle. No future notifications will be sent until service\n\
1237 close_warning_by_mail(ctl, (struct msgblk *)NULL);
1240 else if (err == PS_REPOLL)
1242 if (outlevel >= O_VERBOSE)
1243 report(stderr, GT_("Repoll immediately on %s@%s\n"),
1245 ctl->server.truename);
1248 report(stderr, GT_("Unknown login or authentication error on %s@%s\n"),
1250 ctl->server.truename);
1257 * This connection has given us authorization at least once.
1259 * There are dodgy server (clubinternet.fr for example) that
1260 * give spurious authorization failures on patently good
1261 * account/password details, then 5 minutes later let you in!
1263 * This is meant to build in some tolerance of such nasty bits
1266 ctl->wehaveauthed = 1;
1267 /*if (ctl->authfailcount >= 3)*/
1268 if (ctl->wehavesentauthnote)
1270 ctl->wehavesentauthnote = 0;
1272 GT_("Authorization OK on %s@%s\n"),
1274 ctl->server.truename);
1275 if (!open_warning_by_mail(ctl))
1277 stuff_warning(iana_charset, ctl,
1278 GT_("Subject: fetchmail authentication OK on %s@%s"),
1279 ctl->remotename, ctl->server.truename);
1280 stuff_warning(NULL, ctl, "%s", "");
1281 stuff_warning(NULL, ctl,
1282 GT_("Fetchmail was able to log into %s@%s.\n"),
1284 ctl->server.truename);
1285 stuff_warning(NULL, ctl,
1286 GT_("Service has been restored.\n"));
1287 close_warning_by_mail(ctl, (struct msgblk *)NULL);
1292 * Reporting only after the first three
1293 * consecutive failures, or ten consecutive
1294 * failures after we have managed to get
1297 ctl->authfailcount = 0;
1301 ctl->errcount = fetches = 0;
1303 /* now iterate over each folder selected */
1304 for (idp = ctl->mailboxes; idp; idp = idp->next)
1306 ctl->folder = idp->id;
1312 /* reset timeout, in case we did an IDLE */
1313 mytimeout = ctl->server.timeout;
1315 if (outlevel >= O_DEBUG)
1318 report(stdout, GT_("selecting or re-polling folder %s\n"), idp->id);
1320 report(stdout, GT_("selecting or re-polling default folder\n"));
1323 /* compute # of messages and number of new messages waiting */
1324 stage = STAGE_GETRANGE;
1325 err = (ctl->server.base_protocol->getrange)(mailserver_socket, ctl, idp->id, &count, &newm, &bytes);
1329 /* show user how many messages we downloaded */
1331 (void) snprintf(buf, sizeof(buf),
1332 GT_("%s at %s (folder %s)"),
1333 ctl->remotename, ctl->server.pollname, idp->id);
1335 (void) snprintf(buf, sizeof(buf), GT_("%s at %s"),
1336 ctl->remotename, ctl->server.pollname);
1337 if (outlevel > O_SILENT)
1339 if (count == -1) /* only used for ETRN */
1340 report(stdout, GT_("Polling %s\n"), ctl->server.truename);
1341 else if (count != 0)
1343 if (newm != -1 && (count - newm) > 0)
1344 report_build(stdout, ngettext("%d message (%d %s) for %s", "%d messages (%d %s) for %s", (unsigned long)count),
1347 ngettext("seen", "seen", (unsigned long)count-newm),
1350 report_build(stdout, ngettext("%d message for %s",
1351 "%d messages for %s",
1355 report_complete(stdout, ".\n");
1357 report_complete(stdout, GT_(" (%d octets).\n"), bytes);
1361 /* these are pointless in normal daemon mode */
1362 if (pass == 1 && (run.poll_interval == 0 || outlevel >= O_VERBOSE))
1363 report(stdout, GT_("No mail for %s\n"), buf);
1367 /* very important, this is where we leave the do loop */
1373 if (newm == -1 || ctl->fetchall)
1375 fetches = newm; /* set error status correctly */
1377 * There used to be a `goto noerror' here, but this
1378 * prevented checking of multiple folders. This
1379 * comment is a reminder in case I introduced some
1380 * subtle bug by removing it...
1388 * Don't trust the message count passed by the server.
1389 * Without this check, it might be possible to do a
1390 * DNS-spoofing attack that would pass back a ridiculous
1391 * count, and allocate a malloc area that would overlap
1392 * a portion of the stack.
1394 if ((unsigned)count > INT_MAX/sizeof(int))
1396 report(stderr, GT_("bogus message count!"));
1402 * We need the size of each message before it's
1403 * loaded in order to pass it to the ESMTP SIZE
1404 * option. If the protocol has a getsizes method,
1405 * we presume this means it doesn't get reliable
1406 * sizes from message fetch responses.
1408 * If the protocol supports getting sizes of subset of
1409 * messages, we skip this step now.
1411 if (proto->getsizes &&
1412 !(proto->getpartialsizes && NUM_NONZERO(ctl->fetchsizelimit)))
1415 msgsizes = (int *)xmalloc(sizeof(int) * count);
1416 for (i = 0; i < count; i++)
1419 stage = STAGE_GETSIZES;
1420 err = (proto->getsizes)(mailserver_socket, count, msgsizes);
1427 for (i = 0; i < count; i++)
1428 bytes += msgsizes[i];
1432 /* read, forward, and delete messages */
1433 stage = STAGE_FETCH;
1435 /* fetch in lockstep mode */
1436 err = fetch_messages(mailserver_socket, ctl,
1439 &fetches, &dispatches, &deletions);
1440 if (err != PS_SUCCESS && err != PS_MAXFETCH)
1443 if (!check_only && ctl->skipped
1444 && run.poll_interval > 0 && !nodetach)
1446 clean_skipped_list(&ctl->skipped);
1447 send_size_warnings(ctl);
1451 /* end-of-mailbox processing before we repoll or switch to another one */
1452 if (ctl->server.base_protocol->end_mailbox_poll)
1454 tmperr = (ctl->server.base_protocol->end_mailbox_poll)(mailserver_socket, ctl);
1460 /* Return now if we have reached the fetchlimit */
1461 if (maxfetch && maxfetch <= fetches)
1465 * Only repoll if we either had some actual forwards
1466 * or are idling for new mails and had no errors.
1467 * Otherwise it is far too easy to get into infinite loops.
1469 (ctl->server.base_protocol->retry && (dispatches || ctl->idle) && !ctl->errcount);
1472 /* XXX: From this point onwards, preserve err unless a new error has occurred */
1475 /* PS_SUCCESS, PS_MAXFETCH: ordinary termination with no errors -- officially log out */
1476 stage = STAGE_LOGOUT;
1477 tmperr = (ctl->server.base_protocol->logout_cmd)(mailserver_socket, ctl);
1478 if (tmperr != PS_SUCCESS)
1481 * Hmmmm...arguably this would be incorrect if we had fetches but
1482 * no dispatches (due to oversized messages, etc.)
1484 else if (err == PS_SUCCESS && fetches == 0)
1487 * Close all SMTP delivery sockets. For optimum performance
1488 * we'd like to hold them open til end of run, but (1) this
1489 * loses if our poll interval is longer than the MTA's
1490 * inactivity timeout, and (2) some MTAs (like smail) don't
1491 * deliver after each message, but rather queue up mail and
1492 * wait to actually deliver it until the input socket is
1495 * don't send QUIT for ODMR case because we're acting as a
1496 * proxy between the SMTP server and client.
1498 smtp_close(ctl, ctl->server.protocol != P_ODMR);
1499 cleanupSockClose(mailserver_socket);
1503 /* we only get here on error */
1504 if (err != 0 && err != PS_SOCKET && err != PS_REPOLL)
1506 stage = STAGE_LOGOUT;
1507 (ctl->server.base_protocol->logout_cmd)(mailserver_socket, ctl);
1510 /* try to clean up all streams */
1513 * Sending SMTP QUIT on signal is theoretically nice, but led
1514 * to a subtle bug. If fetchmail was terminated by signal
1515 * while it was shipping message text, it would hang forever
1516 * waiting for a command acknowledge. In theory we could
1517 * enable the QUIT only outside of the message send. In
1518 * practice, we don't care. All mailservers hang up on a
1519 * dropped TCP/IP connection anyway.
1522 if (mailserver_socket != -1) {
1523 cleanupSockClose(mailserver_socket);
1525 /* If there was a connect timeout, the socket should be closed.
1526 * mailserver_socket_temp contains the socket to close.
1528 if (mailserver_socket_temp != -1) {
1529 cleanupSockClose(mailserver_socket_temp);
1530 mailserver_socket_temp = -1;
1534 /* no report on PS_AUTHFAIL */
1539 msg = GT_("socket");
1542 msg = GT_("missing or bad RFC822 header");
1548 msg = GT_("client/server synchronization");
1551 msg = GT_("client/server protocol");
1554 msg = GT_("lock busy on server");
1557 msg = GT_("SMTP transaction");
1560 msg = GT_("DNS lookup");
1563 msg = GT_("undefined");
1567 if (phase == FORWARDING_WAIT || phase == LISTENER_WAIT
1569 report(stderr, GT_("%s error while fetching from %s@%s and delivering to SMTP host %s\n"),
1570 msg, ctl->remotename, ctl->server.pollname,
1571 ctl->smtphost ? ctl->smtphost : GT_("unknown"));
1573 report(stderr, GT_("%s error while fetching from %s@%s\n"),
1574 msg, ctl->remotename, ctl->server.pollname);
1581 /* execute wrapup command, if any */
1582 if (ctl->postconnect && (tmperr = system(ctl->postconnect)))
1584 if (WIFSIGNALED(tmperr))
1585 report(stderr, GT_("post-connection command terminated with signal %d\n"), WTERMSIG(tmperr));
1587 report(stderr, GT_("post-connection command failed with status %d\n"), WEXITSTATUS(tmperr));
1588 if (err == PS_SUCCESS)
1592 set_timeout(0); /* cancel any pending alarm */
1593 set_signal_handler(SIGALRM, alrmsave);
1597 /** retrieve messages from server using given protocol method table */
1598 int do_protocol(struct query *ctl /** parsed options with merged-in defaults */,
1599 const struct method *proto /** protocol method table */)
1604 if (ctl->server.authenticate == A_KERBEROS_V4)
1606 report(stderr, GT_("Kerberos V4 support not linked.\n"));
1609 #endif /* KERBEROS_V4 */
1612 if (ctl->server.authenticate == A_KERBEROS_V5)
1614 report(stderr, GT_("Kerberos V5 support not linked.\n"));
1617 #endif /* KERBEROS_V5 */
1619 /* lacking methods, there are some options that may fail */
1622 /* check for unsupported options */
1625 GT_("Option --flush is not supported with %s\n"),
1629 else if (ctl->fetchall) {
1631 GT_("Option --all is not supported with %s\n"),
1636 if (!(proto->getsizes || proto->getpartialsizes)
1637 && NUM_SPECIFIED(ctl->limit))
1640 GT_("Option --limit is not supported with %s\n"),
1646 * If no expunge limit or we do expunges within the driver,
1647 * then just do one session, passing in any fetchlimit.
1649 if ((ctl->keep && !ctl->flush) ||
1650 proto->retry || !NUM_SPECIFIED(ctl->expunge))
1651 return(do_session(ctl, proto, NUM_VALUE_OUT(ctl->fetchlimit)));
1653 * There's an expunge limit, and it isn't handled in the driver itself.
1654 * OK; do multiple sessions, each fetching a limited # of messages.
1655 * Stop if the total count of retrieved messages exceeds ctl->fetchlimit
1656 * (if it was nonzero).
1662 int expunge = NUM_VALUE_OUT(ctl->expunge);
1663 int fetchlimit = NUM_VALUE_OUT(ctl->fetchlimit);
1666 if (fetchlimit > 0 && (expunge == 0 || expunge > fetchlimit - totalcount))
1667 expunge = fetchlimit - totalcount;
1668 err = do_session(ctl, proto, expunge);
1669 totalcount += expunge;
1670 if (NUM_SPECIFIED(ctl->fetchlimit) && totalcount >= fetchlimit)
1672 if (err != PS_LOCKBUSY)
1674 else if (lockouts >= MAX_LOCKOUTS)
1676 else /* err == PS_LOCKBUSY */
1679 * Allow time for the server lock to release. if we
1680 * don't do this, we'll often hit a locked-mailbox
1681 * condition and fail.
1687 (err == PS_MAXFETCH || err == PS_LOCKBUSY);
1694 /* driver.c ends here */