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 */
58 #define THROW_SIGPIPE 2 /* SIGPIPE on stream socket */
60 /* magic values for the message length array */
61 #define MSGLEN_UNKNOWN 0 /* length unknown (0 is impossible) */
62 #define MSGLEN_INVALID -1 /* length passed back is invalid */
63 #define MSGLEN_TOOLARGE -2 /* message is too large */
64 #define MSGLEN_OLD -3 /* message is old */
66 int pass; /* how many times have we re-polled? */
67 int stage; /* where are we? */
68 int phase; /* where are we, for error-logging purposes? */
69 int batchcount; /* count of messages sent in current batch */
70 flag peek_capable; /* can we peek for better error recovery? */
71 int mailserver_socket_temp = -1; /* socket to free if connect timeout */
73 static volatile int timeoutcount = 0; /* count consecutive timeouts */
74 static volatile int idletimeout = 0; /* timeout occured in idle stage? */
76 static jmp_buf restart;
78 int is_idletimeout(void)
79 /* last timeout occured in idle stage? */
84 void resetidletimeout(void)
89 void set_timeout(int timeleft)
90 /* reset the nonresponse-timeout */
92 #if !defined(__EMX__) && !defined(__BEOS__)
93 struct itimerval ntimeout;
98 ntimeout.it_interval.tv_sec = ntimeout.it_interval.tv_usec = 0;
99 ntimeout.it_value.tv_sec = timeleft;
100 ntimeout.it_value.tv_usec = 0;
101 setitimer(ITIMER_REAL, &ntimeout, (struct itimerval *)NULL);
105 static RETSIGTYPE timeout_handler (int signal)
106 /* handle SIGALRM signal indicating a server timeout */
109 if(stage != STAGE_IDLE) {
111 longjmp(restart, THROW_TIMEOUT);
116 static RETSIGTYPE sigpipe_handler (int signal)
117 /* handle SIGPIPE signal indicating a broken stream socket */
120 longjmp(restart, THROW_SIGPIPE);
123 #define CLEANUP_TIMEOUT 60 /* maximum timeout during cleanup */
125 static int cleanupSockClose (int fd)
126 /* close sockets in maximum CLEANUP_TIMEOUT seconds during cleanup */
129 SIGHANDLERTYPE alrmsave;
130 alrmsave = set_signal_handler(SIGALRM, null_signal_handler);
131 set_timeout(CLEANUP_TIMEOUT);
132 scerror = SockClose(fd);
134 set_signal_handler(SIGALRM, alrmsave);
139 static int kerberos_auth(socket, canonical, principal)
140 /* authenticate to the server host using Kerberos V4 */
141 int socket; /* socket to server host */
142 char *canonical; /* server name */
148 Key_schedule schedule;
150 char * prin_copy = (char *) NULL;
151 char * prin = (char *) NULL;
152 char * inst = (char *) NULL;
153 char * realm = (char *) NULL;
155 if (principal != (char *)NULL && *principal)
158 prin = prin_copy = xstrdup(principal);
159 for (cp = prin_copy; *cp && *cp != '.'; ++cp)
165 while (*cp && *cp != '@')
175 ticket = xmalloc(sizeof (KTEXT_ST));
176 rem = (krb_sendauth (0L, socket, ticket,
178 inst ? inst : canonical,
179 realm ? realm : ((char *) (krb_realmofhost (canonical))),
184 ((struct sockaddr_in *) 0),
185 ((struct sockaddr_in *) 0),
194 report(stderr, GT_("kerberos error %s\n"), (krb_get_err_text (rem)));
195 return (PS_AUTHFAIL);
199 #endif /* KERBEROS_V4 */
202 static int kerberos5_auth(socket, canonical)
203 /* authenticate to the server host using Kerberos V5 */
204 int socket; /* socket to server host */
205 const char *canonical; /* server name */
207 krb5_error_code retval;
208 krb5_context context;
210 krb5_principal client = NULL, server = NULL;
211 krb5_error *err_ret = NULL;
213 krb5_auth_context auth_context = NULL;
215 krb5_init_context(&context);
216 krb5_auth_con_init(context, &auth_context);
218 if ((retval = krb5_cc_default(context, &ccdef))) {
219 report(stderr, "krb5_cc_default: %s\n", error_message(retval));
223 if ((retval = krb5_cc_get_principal(context, ccdef, &client))) {
224 report(stderr, "krb5_cc_get_principal: %s\n", error_message(retval));
228 if ((retval = krb5_sname_to_principal(context, canonical, "pop",
231 report(stderr, "krb5_sname_to_principal: %s\n", error_message(retval));
235 retval = krb5_sendauth(context, &auth_context, (krb5_pointer) &socket,
236 "KPOPV1.0", client, server,
237 AP_OPTS_MUTUAL_REQUIRED,
238 NULL, /* no data to checksum */
239 0, /* no creds, use ccache instead */
243 NULL); /* don't need reply */
245 krb5_free_principal(context, server);
246 krb5_free_principal(context, client);
247 krb5_auth_con_free(context, auth_context);
251 if (err_ret && err_ret->e_text) {
252 report(stderr, GT_("krb5_sendauth: %s [server says '%*s'] \n"),
253 error_message(retval),
256 if (err_ret && err_ret->text.length) {
257 report(stderr, GT_("krb5_sendauth: %s [server says '%*s'] \n"),
258 error_message(retval),
259 err_ret->text.length,
262 krb5_free_error(context, err_ret);
264 report(stderr, "krb5_sendauth: %s\n", error_message(retval));
270 #endif /* KERBEROS_V5 */
272 static void clean_skipped_list(struct idlist **skipped_list)
273 /* struct "idlist" contains no "prev" ptr; we must remove unused items first */
275 struct idlist *current=NULL, *prev=NULL, *tmp=NULL, *head=NULL;
276 prev = current = head = *skipped_list;
282 /* if item has no reference, remove it */
283 if (current && current->val.status.mark == 0)
285 if (current == head) /* remove first item (head) */
287 head = current->next;
288 if (current->id) free(current->id);
290 prev = current = head;
292 else /* remove middle/last item */
296 if (current->id) free(current->id);
301 else /* skip this item */
304 current = current->next;
308 *skipped_list = head;
311 static void send_size_warnings(struct query *ctl)
312 /* send warning mail with skipped msg; reset msg count when user notified */
315 int msg_to_send = FALSE;
316 struct idlist *head=NULL, *current=NULL;
317 int max_warning_poll_count;
323 /* don't start a notification message unless we need to */
324 for (current = head; current; current = current->next)
325 if (current->val.status.num == 0 && current->val.status.mark)
331 * There's no good way to recover if we can't send notification mail,
332 * but it's not a disaster, either, since the skipped mail will not
335 if (open_warning_by_mail(ctl))
337 stuff_warning(iana_charset, ctl,
338 GT_("Subject: Fetchmail oversized-messages warning"));
339 stuff_warning(NULL, ctl, "%s", "");
341 stuff_warning(NULL, ctl,
342 GT_("The following oversized messages were deleted on server %s account %s:"),
343 ctl->server.pollname, ctl->remotename);
345 stuff_warning(NULL, ctl,
346 GT_("The following oversized messages remain on server %s account %s:"),
347 ctl->server.pollname, ctl->remotename);
349 stuff_warning(NULL, ctl, "%s", "");
351 if (run.poll_interval == 0)
352 max_warning_poll_count = 0;
354 max_warning_poll_count = ctl->warnings/run.poll_interval;
356 /* parse list of skipped msg, adding items to the mail */
357 for (current = head; current; current = current->next)
359 if (current->val.status.num == 0 && current->val.status.mark)
361 nbr = current->val.status.mark;
362 size = atoi(current->id);
364 stuff_warning(NULL, ctl,
365 GT_(" %d msg %d octets long deleted by fetchmail."),
368 stuff_warning(NULL, ctl,
369 GT_(" %d msg %d octets long skipped by fetchmail."),
372 current->val.status.num++;
373 current->val.status.mark = 0;
375 if (current->val.status.num >= max_warning_poll_count)
376 current->val.status.num = 0;
379 stuff_warning(NULL, ctl, "%s", "");
381 close_warning_by_mail(ctl, (struct msgblk *)NULL);
384 static void mark_oversized(struct query *ctl, int size)
385 /* mark a message oversized */
387 struct idlist *current=NULL, *tmp=NULL;
391 /* convert size to string */
392 snprintf(sizestr, sizeof(sizestr), "%d", size);
394 /* build a list of skipped messages
395 * val.id = size of msg (string cnvt)
396 * val.status.num = warning_poll_count
397 * val.status.mask = nbr of msg this size
400 current = ctl->skipped;
402 /* initialise warning_poll_count to the
403 * current value so that all new msg will
404 * be included in the next mail
406 cnt = current ? current->val.status.num : 0;
408 /* if entry exists, increment the count */
409 if (current && (tmp = str_in_list(¤t, sizestr, FALSE)))
411 tmp->val.status.mark++;
413 /* otherwise, create a new entry */
414 /* initialise with current poll count */
417 tmp = save_str(&ctl->skipped, sizestr, 1);
418 tmp->val.status.num = cnt;
422 static int fetch_messages(int mailserver_socket, struct query *ctl,
423 int count, int **msgsizes, int maxfetch,
424 int *fetches, int *dispatches, int *deletions)
425 /* fetch messages in lockstep mode */
427 flag force_retrieval;
428 int num, firstnum = 1, lastnum = 0, err, len;
429 int fetchsizelimit = ctl->fetchsizelimit;
431 int initialfetches = *fetches;
433 if (ctl->server.base_protocol->getpartialsizes && NUM_NONZERO(fetchsizelimit))
435 /* for POP3, we can get the size of one mail only! Unfortunately, this
436 * protocol specific test cannot be done elsewhere as the protocol
437 * could be "auto". */
438 switch (ctl->server.protocol)
440 case P_POP3: case P_APOP: case P_RPOP:
444 /* Time to allocate memory to store the sizes */
446 *msgsizes = (int *)xmalloc(sizeof(int) * fetchsizelimit);
450 * What forces this code is that in POP2 and
451 * IMAP2bis you can't fetch a message without
452 * having it marked `seen'. In POP3 and IMAP4, on the
453 * other hand, you can (peek_capable is set by
454 * each driver module to convey this; it's not a
455 * method constant because of the difference between
456 * IMAP2bis and IMAP4, and because POP3 doesn't peek
457 * if fetchall is on).
459 * The result of being unable to peek is that if there's
460 * any kind of transient error (DNS lookup failure, or
461 * sendmail refusing delivery due to process-table limits)
462 * the message will be marked "seen" on the server without
463 * having been delivered. This is not a big problem if
464 * fetchmail is running in foreground, because the user
465 * will see a "skipped" message when it next runs and get
468 * But in daemon mode this leads to the message
469 * being silently ignored forever. This is not
472 * We compensate for this by checking the error
473 * count from the previous pass and forcing all
474 * messages to be considered new if it's nonzero.
476 force_retrieval = !peek_capable && (ctl->errcount > 0);
478 for (num = 1; num <= count; num++)
480 flag suppress_delete = FALSE;
481 flag suppress_forward = FALSE;
482 flag suppress_readbody = FALSE;
483 flag retained = FALSE;
484 int msgcode = MSGLEN_UNKNOWN;
486 /* check if the message is old
487 * Note: the size of the message may not be known here */
488 if (ctl->fetchall || force_retrieval)
490 else if (ctl->server.base_protocol->is_old && (ctl->server.base_protocol->is_old)(mailserver_socket,ctl,num))
491 msgcode = MSGLEN_OLD;
492 if (msgcode == MSGLEN_OLD)
494 /* To avoid flooding the syslog when using --keep,
495 * report "Skipped message" only when:
496 * 1) --verbose is on, or
497 * 2) fetchmail does not use syslog
499 if ( (outlevel >= O_VERBOSE) ||
500 (outlevel > O_SILENT && !run.use_syslog)
504 GT_("skipping message %s@%s:%d"),
505 ctl->remotename, ctl->server.truename, num);
511 if (ctl->server.base_protocol->getpartialsizes && NUM_NONZERO(fetchsizelimit) &&
514 /* Instead of getting the sizes of all mails at the start, we get
515 * the sizes in blocks of fetchsizelimit. This leads to better
516 * performance when there are too many mails (say, 10000) in
517 * the mailbox and either we are not getting all the mails at
518 * one go (--fetchlimit 100) or there is a frequent socket
519 * error while just getting the sizes of all mails! */
522 int oldstage = stage;
524 lastnum = num + fetchsizelimit - 1;
527 for (i = 0; i < fetchsizelimit; i++)
530 stage = STAGE_GETSIZES;
531 err = (ctl->server.base_protocol->getpartialsizes)(mailserver_socket, num, lastnum, *msgsizes);
538 msgsize = *msgsizes ? (*msgsizes)[num-firstnum] : 0;
540 /* check if the message is oversized */
541 if (NUM_NONZERO(ctl->limit) && (msgsize > ctl->limit))
542 msgcode = MSGLEN_TOOLARGE;
543 /* else if (msgsize == 512)
544 msgcode = MSGLEN_OLD; (hmh) sample code to skip message */
548 if (msgcode == MSGLEN_TOOLARGE)
550 mark_oversized(ctl, msgsize);
551 if (!ctl->limitflush)
552 suppress_delete = TRUE;
554 if (outlevel > O_SILENT)
556 /* old messages are already handled above */
558 GT_("skipping message %s@%s:%d (%d octets)"),
559 ctl->remotename, ctl->server.truename, num,
565 * Invalid lengths are produced by Post Office/NT's
566 * annoying habit of randomly prepending bogus
567 * LIST items of length -1. Patrick Audley
568 * <paudley@pobox.com> tells us: LIST shows a
569 * size of -1, RETR and TOP return "-ERR
570 * System error - couldn't open message", and
571 * DELE succeeds but doesn't actually delete
574 report_build(stdout, GT_(" (length -1)"));
576 case MSGLEN_TOOLARGE:
577 report_build(stdout, GT_(" (oversized)"));
584 flag wholesize = !ctl->server.base_protocol->fetch_body;
585 flag separatefetchbody = (ctl->server.base_protocol->fetch_body) ? TRUE : FALSE;
587 /* request a message */
588 err = (ctl->server.base_protocol->fetch_headers)(mailserver_socket,ctl,num, &len);
589 if (err == PS_TRANSIENT) /* server is probably Exchange */
592 GT_("couldn't fetch headers, message %s@%s:%d (%d octets)\n"),
593 ctl->remotename, ctl->server.truename, num,
600 /* -1 means we didn't see a size in the response */
607 if (outlevel > O_SILENT)
609 report_build(stdout, GT_("reading message %s@%s:%d of %d"),
610 ctl->remotename, ctl->server.truename,
614 report_build(stdout, wholesize ? GT_(" (%d octets)")
615 : GT_(" (%d header octets)"), len);
616 if (outlevel >= O_VERBOSE)
617 report_complete(stdout, "\n");
619 report_complete(stdout, " ");
623 * Read the message headers and ship them to the
626 err = readheaders(mailserver_socket, len, msgsize,
628 /* pass the suppress_readbody flag only if the underlying
629 * protocol does not fetch the body separately */
630 separatefetchbody ? 0 : &suppress_readbody);
631 if (err == PS_RETAINED)
632 suppress_forward = suppress_delete = retained = TRUE;
633 else if (err == PS_TRANSIENT)
634 suppress_delete = suppress_forward = TRUE;
635 else if (err == PS_REFUSED)
636 suppress_forward = TRUE;
637 else if (err == PS_TRUNCATED)
638 suppress_readbody = TRUE;
642 /* tell server we got it OK and resynchronize */
643 if (separatefetchbody && ctl->server.base_protocol->trail)
645 if (outlevel >= O_VERBOSE && !is_a_file(1) && !run.use_syslog)
651 if ((err = (ctl->server.base_protocol->trail)(mailserver_socket, ctl, tag)))
655 /* do not read the body which is not being forwarded only if
656 * the underlying protocol allows the body to be fetched
658 if (separatefetchbody && suppress_forward)
659 suppress_readbody = TRUE;
662 * If we're using IMAP4 or something else that
663 * can fetch headers separately from bodies,
664 * it's time to request the body now. This
665 * fetch may be skipped if we got an anti-spam
666 * or other PS_REFUSED error response during
669 if (!suppress_readbody)
671 if (separatefetchbody)
674 if ((err=(ctl->server.base_protocol->fetch_body)(mailserver_socket,ctl,num,&len)))
677 * Work around a bug in Novell's
678 * broken GroupWise IMAP server;
679 * its body FETCH response is missing
680 * the required length for the data
681 * string. This violates RFC2060.
684 len = msgsize - msgblk.msglen;
685 if (outlevel > O_SILENT && !wholesize)
686 report_complete(stdout,
687 GT_(" (%d body octets) "), len);
690 /* process the body now */
691 err = readbody(mailserver_socket,
695 if (err == PS_TRANSIENT)
696 suppress_delete = suppress_forward = TRUE;
700 /* tell server we got it OK and resynchronize */
701 if (ctl->server.base_protocol->trail)
703 if (outlevel >= O_VERBOSE && !is_a_file(1) && !run.use_syslog)
709 err = (ctl->server.base_protocol->trail)(mailserver_socket, ctl, tag);
715 /* count # messages forwarded on this pass */
716 if (!suppress_forward)
720 * Check to see if the numbers matched?
722 * Yes, some servers foo this up horribly.
723 * All IMAP servers seem to get it right, and
724 * so does Eudora QPOP at least in 2.xx
727 * Microsoft Exchange gets it completely
728 * wrong, reporting compressed rather than
729 * actual sizes (so the actual length of
730 * message is longer than the reported size).
731 * Another fine example of Microsoft brain death!
733 * Some older POP servers, like the old UCB
734 * POP server and the pre-QPOP QUALCOMM
735 * versions, report a longer size in the LIST
736 * response than actually gets shipped up.
737 * It's unclear what is going on here, as the
738 * QUALCOMM server (at least) seems to be
739 * reporting the on-disk size correctly.
741 * qmail-pop3d also goofs up message sizes and does not
742 * count the line end characters properly.
744 if (msgblk.msglen != msgsize)
746 if (outlevel >= O_DEBUG)
748 GT_("message %s@%s:%d was not the expected length (%d actual != %d expected)\n"),
749 ctl->remotename, ctl->server.truename, num,
750 msgblk.msglen, msgsize);
753 /* end-of-message processing starts here */
754 if (!close_sink(ctl, &msgblk, !suppress_forward))
757 suppress_delete = TRUE;
765 * At this point in flow of control, either
766 * we've bombed on a protocol error or had
767 * delivery refused by the SMTP server
768 * (unlikely -- I've never seen it) or we've
769 * seen `accepted for delivery' and the
770 * message is shipped. It's safe to mark the
771 * message seen and delete it on the server
775 /* maybe we delete this message now? */
778 if (outlevel > O_SILENT)
779 report(stdout, GT_(" retained\n"));
781 else if (ctl->server.base_protocol->delete_msg
783 && ((msgcode >= 0 && !ctl->keep)
784 || (msgcode == MSGLEN_OLD && ctl->flush)
785 || (msgcode == MSGLEN_TOOLARGE && ctl->limitflush)))
788 if (outlevel > O_SILENT)
789 report_complete(stdout, GT_(" flushed\n"));
790 err = (ctl->server.base_protocol->delete_msg)(mailserver_socket, ctl, num);
796 if ( (outlevel >= O_VERBOSE) ||
797 /* To avoid flooding the syslog when using --keep,
798 * report "Skipped message" only when:
799 * 1) --verbose is on, or
800 * 2) fetchmail does not use syslog, or
801 * 3) the message was skipped for some other
802 * reason than just being old.
804 (outlevel > O_SILENT && (!run.use_syslog || msgcode != MSGLEN_OLD))
806 report_complete(stdout, GT_(" not flushed\n"));
808 /* maybe we mark this message as seen now? */
809 if (ctl->server.base_protocol->mark_seen
811 && (msgcode >= 0 && ctl->keep))
813 err = (ctl->server.base_protocol->mark_seen)(mailserver_socket, ctl, num);
819 /* perhaps this as many as we're ready to handle */
820 if (maxfetch && maxfetch <= *fetches && num < count)
822 int remcount = count - (*fetches - initialfetches);
824 ngettext("fetchlimit %d reached; %d message left on server %s account %s\n",
825 "fetchlimit %d reached; %d messages left on server %s account %s\n", remcount),
826 maxfetch, remcount, ctl->server.truename, ctl->remotename);
829 } /* for (num = 1; num <= count; num++) */
834 /* retrieve messages from server using given protocol method table */
835 static int do_session(
836 /* parsed options with merged-in defaults */
838 /* protocol method table */
839 const struct method *proto,
840 /* maximum number of messages to fetch */
843 static int *msgsizes;
844 volatile int err, mailserver_socket = -1; /* pacifies -Wall */
846 int deletions = 0, js;
848 SIGHANDLERTYPE pipesave;
849 SIGHANDLERTYPE alrmsave;
851 ctl->server.base_protocol = proto;
856 init_transact(proto);
858 /* set up the server-nonresponse timeout */
859 alrmsave = set_signal_handler(SIGALRM, timeout_handler);
860 mytimeout = ctl->server.timeout;
862 /* set up the broken-pipe timeout */
863 pipesave = set_signal_handler(SIGPIPE, sigpipe_handler);
865 if ((js = setjmp(restart)))
867 /* exception caught */
868 #ifdef HAVE_SIGPROCMASK
870 * Don't rely on setjmp() to restore the blocked-signal mask.
871 * It does this under BSD but is required not to under POSIX.
873 * If your Unix doesn't have sigprocmask, better hope it has
874 * BSD-like behavior. Otherwise you may see fetchmail get
875 * permanently wedged after a second timeout on a bad read,
876 * because alarm signals were blocked after the first.
880 sigfillset(&allsigs);
881 sigprocmask(SIG_UNBLOCK, &allsigs, NULL);
882 #endif /* HAVE_SIGPROCMASK */
884 if (js == THROW_SIGPIPE)
886 set_signal_handler(SIGPIPE, SIG_IGN);
888 GT_("SIGPIPE thrown from an MDA or a stream socket error\n"));
891 else if (js == THROW_TIMEOUT)
893 if (phase == OPEN_WAIT)
895 GT_("timeout after %d seconds waiting to connect to server %s.\n"),
896 ctl->server.timeout, ctl->server.pollname);
897 else if (phase == SERVER_WAIT)
899 GT_("timeout after %d seconds waiting for server %s.\n"),
900 ctl->server.timeout, ctl->server.pollname);
901 else if (phase == FORWARDING_WAIT)
903 GT_("timeout after %d seconds waiting for %s.\n"),
905 ctl->mda ? "MDA" : "SMTP");
906 else if (phase == LISTENER_WAIT)
908 GT_("timeout after %d seconds waiting for listener to respond.\n"), ctl->server.timeout);
911 GT_("timeout after %d seconds.\n"), ctl->server.timeout);
914 * If we've exceeded our threshold for consecutive timeouts,
915 * try to notify the user, then mark the connection wedged.
916 * Don't do this if the connection can idle, though; idle
917 * timeouts just mean the frequency of mail is low.
919 if (timeoutcount > MAX_TIMEOUTS
920 && !open_warning_by_mail(ctl))
922 stuff_warning(iana_charset, ctl,
923 GT_("Subject: fetchmail sees repeated timeouts"));
924 stuff_warning(NULL, ctl, "%s", "");
925 stuff_warning(NULL, ctl,
926 GT_("Fetchmail saw more than %d timeouts while attempting to get mail from %s@%s.\n"),
928 ctl->remotename, ctl->server.truename);
929 stuff_warning(NULL, ctl,
930 GT_("This could mean that your mailserver is stuck, or that your SMTP\n" \
931 "server is wedged, or that your mailbox file on the server has been\n" \
932 "corrupted by a server error. You can run `fetchmail -v -v' to\n" \
933 "diagnose the problem.\n\n" \
934 "Fetchmail won't poll this mailbox again until you restart it.\n"));
935 close_warning_by_mail(ctl, (struct msgblk *)NULL);
945 /* setjmp returned zero -> normal operation */
946 char buf[MSGBUFSIZE+1], *realhost;
947 int count, newm, bytes;
948 int fetches, dispatches, oldphase;
951 /* execute pre-initialization command, if any */
952 if (ctl->preconnect && (err = system(ctl->preconnect)))
955 GT_("pre-connection command failed with status %d\n"), err);
960 /* open a socket to the mail server */
963 set_timeout(mytimeout);
965 #ifdef HAVE_PKG_hesiod
966 /* If either the pollname or vianame are "hesiod" we want to
967 lookup the user's hesiod pobox host */
968 if (!strcasecmp(ctl->server.queryname, "hesiod")) {
969 struct hes_postoffice *hes_p;
970 hes_p = hes_getmailhost(ctl->remotename);
971 if (hes_p != NULL && strcmp(hes_p->po_type, "POP") == 0) {
972 free(ctl->server.queryname);
973 ctl->server.queryname = xstrdup(hes_p->po_host);
975 free(ctl->server.via);
976 ctl->server.via = xstrdup(hes_p->po_host);
979 GT_("couldn't find HESIOD pobox for %s\n"),
986 * Canonicalize the server truename for later use. This also
987 * functions as a probe for whether the mailserver is accessible.
988 * We try it on each poll cycle until we get a result. This way,
989 * fetchmail won't fail if started up when the network is inaccessible.
991 if (ctl->server.dns && !ctl->server.trueaddr)
993 if (ctl->server.lead_server)
995 char *leadname = ctl->server.lead_server->truename;
997 /* prevent core dump from ill-formed or duplicate entry */
1000 report(stderr, GT_("Lead server has no name.\n"));
1007 xfree(ctl->server.truename);
1008 ctl->server.truename = xstrdup(leadname);
1012 struct addrinfo hints, *res;
1015 memset(&hints, 0, sizeof(hints));
1016 hints.ai_socktype = SOCK_STREAM;
1017 hints.ai_family = AF_UNSPEC;
1018 hints.ai_flags = AI_CANONNAME;
1020 error = getaddrinfo(ctl->server.queryname, NULL, &hints, &res);
1024 GT_("couldn't find canonical DNS name of %s (%s)\n"),
1025 ctl->server.pollname, ctl->server.queryname);
1033 xfree(ctl->server.truename);
1034 /* Older FreeBSD versions return NULL in ai_canonname
1035 * if they cannot canonicalize, rather than copying
1036 * the queryname here, as IEEE Std 1003.1-2001
1037 * requires. Work around NULL. */
1038 if (res->ai_canonname != NULL) {
1039 ctl->server.truename = xstrdup(res->ai_canonname);
1041 ctl->server.truename = xstrdup(ctl->server.queryname);
1043 ctl->server.trueaddr = (struct sockaddr *)xmalloc(res->ai_addrlen);
1044 ctl->server.trueaddr_len = res->ai_addrlen;
1045 memcpy(ctl->server.trueaddr, res->ai_addr, res->ai_addrlen);
1051 realhost = ctl->server.via ? ctl->server.via : ctl->server.pollname;
1053 /* allow time for the port to be set up if we have a plugin */
1054 if (ctl->server.plugin)
1056 if ((mailserver_socket = SockOpen(realhost,
1057 ctl->server.service ? ctl->server.service : ( ctl->use_ssl ? ctl->server.base_protocol->sslservice : ctl->server.base_protocol->service ),
1058 ctl->server.plugin)) == -1)
1060 char errbuf[BUFSIZ];
1063 * Avoid generating a bogus error every poll cycle when we're
1064 * in daemon mode but the connection to the outside world
1067 if (!((err_no == EHOSTUNREACH || err_no == ENETUNREACH)
1068 && run.poll_interval))
1070 report_build(stderr, GT_("%s connection to %s failed"),
1071 ctl->server.base_protocol->name, ctl->server.pollname);
1072 strlcpy(errbuf, strerror(err_no), sizeof(errbuf));
1073 report_complete(stderr, ": %s\n", errbuf);
1077 * Don't use this. It was an attempt to address Debian bug
1078 * #47143 (Notify user by mail when pop server nonexistent).
1079 * Trouble is, that doesn't work; you trip over the case
1080 * where your SLIP or PPP link is down...
1082 /* warn the system administrator */
1083 if (open_warning_by_mail(ctl) == 0)
1085 stuff_warning(iana_charset, ctl,
1086 GT_("Subject: Fetchmail unreachable-server warning."));
1087 stuff_warning(NULL, ctl, "");
1088 stuff_warning(NULL, ctl, GT_("Fetchmail could not reach the mail server %s:"),
1089 ctl->server.pollname);
1090 stuff_warning(NULL, ctl, errbuf, ctl->server.pollname);
1091 close_warning_by_mail(ctl, (struct msgblk *)NULL);
1102 /* Save the socket opened. Useful if Fetchmail hangs on SSLOpen
1103 * because the socket can be closed.
1105 mailserver_socket_temp = mailserver_socket;
1106 set_timeout(mytimeout);
1108 /* perform initial SSL handshake on open connection */
1109 /* Note: We pass the realhost name over for certificate
1110 verification. We may want to make this configurable */
1111 if (ctl->use_ssl && SSLOpen(mailserver_socket,ctl->sslcert,ctl->sslkey,ctl->sslproto,ctl->sslcertck,
1112 ctl->sslcertpath,ctl->sslfingerprint,realhost,ctl->server.pollname) == -1)
1114 report(stderr, GT_("SSL connection failed.\n"));
1119 /* Fetchmail didn't hang on SSLOpen,
1120 * then no need to set mailserver_socket_temp
1122 mailserver_socket_temp = -1;
1125 /* A timeout is still defined before SSLOpen,
1126 * then Fetchmail hanging on SSLOpen is handled.
1131 if (ctl->server.authenticate == A_KERBEROS_V4 && (strcasecmp(proto->name,"IMAP") != 0))
1133 set_timeout(mytimeout);
1134 err = kerberos_auth(mailserver_socket, ctl->server.truename,
1135 ctl->server.principal);
1140 #endif /* KERBEROS_V4 */
1143 if (ctl->server.authenticate == A_KERBEROS_V5)
1145 set_timeout(mytimeout);
1146 err = kerberos5_auth(mailserver_socket, ctl->server.truename);
1151 #endif /* KERBEROS_V5 */
1153 /* accept greeting message from mail server */
1154 err = (ctl->server.base_protocol->parse_response)(mailserver_socket, buf);
1158 /* try to get authorized to fetch mail */
1159 stage = STAGE_GETAUTH;
1160 if (ctl->server.base_protocol->getauth)
1162 err = (ctl->server.base_protocol->getauth)(mailserver_socket, ctl, buf);
1166 if (err == PS_LOCKBUSY)
1167 report(stderr, GT_("Lock-busy error on %s@%s\n"),
1169 ctl->server.truename);
1170 else if (err == PS_SERVBUSY)
1171 report(stderr, GT_("Server busy error on %s@%s\n"),
1173 ctl->server.truename);
1174 else if (err == PS_AUTHFAIL)
1176 report(stderr, GT_("Authorization failure on %s@%s%s\n"),
1178 ctl->server.truename,
1179 (ctl->wehaveauthed ? GT_(" (previously authorized)") : "")
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 err = (ctl->server.base_protocol->end_mailbox_poll)(mailserver_socket, ctl);
1455 /* Return now if we have reached the fetchlimit */
1456 if (maxfetch && maxfetch <= fetches)
1460 * Only repoll if we either had some actual forwards
1461 * or are idling for new mails and had no errors.
1462 * Otherwise it is far too easy to get into infinite loops.
1464 (ctl->server.base_protocol->retry && (dispatches || ctl->idle) && !ctl->errcount);
1467 /* XXX: From this point onwards, preserve err unless a new error has occurred */
1470 /* PS_SUCCESS, PS_MAXFETCH: ordinary termination with no errors -- officially log out */
1471 stage = STAGE_LOGOUT;
1472 tmperr = (ctl->server.base_protocol->logout_cmd)(mailserver_socket, ctl);
1473 if (tmperr != PS_SUCCESS)
1476 * Hmmmm...arguably this would be incorrect if we had fetches but
1477 * no dispatches (due to oversized messages, etc.)
1479 else if (err == PS_SUCCESS && fetches == 0)
1482 * Close all SMTP delivery sockets. For optimum performance
1483 * we'd like to hold them open til end of run, but (1) this
1484 * loses if our poll interval is longer than the MTA's
1485 * inactivity timeout, and (2) some MTAs (like smail) don't
1486 * deliver after each message, but rather queue up mail and
1487 * wait to actually deliver it until the input socket is
1490 * don't send QUIT for ODMR case because we're acting as a
1491 * proxy between the SMTP server and client.
1493 smtp_close(ctl, ctl->server.protocol != P_ODMR);
1494 cleanupSockClose(mailserver_socket);
1498 /* we only get here on error */
1499 if (err != 0 && err != PS_SOCKET && err != PS_REPOLL)
1501 stage = STAGE_LOGOUT;
1502 (ctl->server.base_protocol->logout_cmd)(mailserver_socket, ctl);
1505 /* try to clean up all streams */
1508 * Sending SMTP QUIT on signal is theoretically nice, but led
1509 * to a subtle bug. If fetchmail was terminated by signal
1510 * while it was shipping message text, it would hang forever
1511 * waiting for a command acknowledge. In theory we could
1512 * enable the QUIT only outside of the message send. In
1513 * practice, we don't care. All mailservers hang up on a
1514 * dropped TCP/IP connection anyway.
1517 if (mailserver_socket != -1) {
1518 cleanupSockClose(mailserver_socket);
1519 mailserver_socket = -1;
1521 /* If there was a connect timeout, the socket should be closed.
1522 * mailserver_socket_temp contains the socket to close.
1524 if (mailserver_socket_temp != -1) {
1525 cleanupSockClose(mailserver_socket_temp);
1526 mailserver_socket_temp = -1;
1530 /* no report on PS_AUTHFAIL */
1535 msg = GT_("socket");
1538 msg = GT_("missing or bad RFC822 header");
1544 msg = GT_("client/server synchronization");
1547 msg = GT_("client/server protocol");
1550 msg = GT_("lock busy on server");
1553 msg = GT_("SMTP transaction");
1556 msg = GT_("DNS lookup");
1559 msg = GT_("undefined");
1563 if (phase == FORWARDING_WAIT || phase == LISTENER_WAIT
1565 report(stderr, GT_("%s error while fetching from %s@%s and delivering to SMTP host %s\n"),
1566 msg, ctl->remotename, ctl->server.pollname,
1567 ctl->smtphost ? ctl->smtphost : GT_("unknown"));
1569 report(stderr, GT_("%s error while fetching from %s@%s\n"),
1570 msg, ctl->remotename, ctl->server.pollname);
1577 /* execute wrapup command, if any */
1578 if (ctl->postconnect && (tmperr = system(ctl->postconnect)))
1580 report(stderr, GT_("post-connection command failed with status %d\n"), tmperr);
1581 if (err == PS_SUCCESS)
1585 set_timeout(0); /* cancel any pending alarm */
1586 set_signal_handler(SIGALRM, alrmsave);
1587 set_signal_handler(SIGPIPE, pipesave);
1591 /** retrieve messages from server using given protocol method table */
1592 int do_protocol(struct query *ctl /** parsed options with merged-in defaults */,
1593 const struct method *proto /** protocol method table */)
1598 if (ctl->server.authenticate == A_KERBEROS_V4)
1600 report(stderr, GT_("Kerberos V4 support not linked.\n"));
1603 #endif /* KERBEROS_V4 */
1606 if (ctl->server.authenticate == A_KERBEROS_V5)
1608 report(stderr, GT_("Kerberos V5 support not linked.\n"));
1611 #endif /* KERBEROS_V5 */
1613 /* lacking methods, there are some options that may fail */
1616 /* check for unsupported options */
1619 GT_("Option --flush is not supported with %s\n"),
1623 else if (ctl->fetchall) {
1625 GT_("Option --all is not supported with %s\n"),
1630 if (!(proto->getsizes || proto->getpartialsizes)
1631 && NUM_SPECIFIED(ctl->limit))
1634 GT_("Option --limit is not supported with %s\n"),
1640 * If no expunge limit or we do expunges within the driver,
1641 * then just do one session, passing in any fetchlimit.
1643 if ((ctl->keep && !ctl->flush) ||
1644 proto->retry || !NUM_SPECIFIED(ctl->expunge))
1645 return(do_session(ctl, proto, NUM_VALUE_OUT(ctl->fetchlimit)));
1647 * There's an expunge limit, and it isn't handled in the driver itself.
1648 * OK; do multiple sessions, each fetching a limited # of messages.
1649 * Stop if the total count of retrieved messages exceeds ctl->fetchlimit
1650 * (if it was nonzero).
1656 int expunge = NUM_VALUE_OUT(ctl->expunge);
1657 int fetchlimit = NUM_VALUE_OUT(ctl->fetchlimit);
1660 if (fetchlimit > 0 && (expunge == 0 || expunge > fetchlimit - totalcount))
1661 expunge = fetchlimit - totalcount;
1662 err = do_session(ctl, proto, expunge);
1663 totalcount += expunge;
1664 if (NUM_SPECIFIED(ctl->fetchlimit) && totalcount >= fetchlimit)
1666 if (err != PS_LOCKBUSY)
1668 else if (lockouts >= MAX_LOCKOUTS)
1670 else /* err == PS_LOCKBUSY */
1673 * Allow time for the server lock to release. if we
1674 * don't do this, we'll often hit a locked-mailbox
1675 * condition and fail.
1681 (err == PS_MAXFETCH || err == PS_LOCKBUSY);
1688 /* driver.c ends here */