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_NET_SOCKET_H
32 #include <net/socket.h>
34 #ifdef HAVE_PKG_hesiod
40 #if defined(HAVE_RES_SEARCH) || defined(HAVE_GETHOSTBYNAME)
43 #endif /* defined(HAVE_RES_SEARCH) || defined(HAVE_GETHOSTBYNAME) */
47 #include <netinet/in.h>
48 #endif /* KERBEROS_V4 */
53 #include "fetchmail.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 isidletimeout(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 */
108 if(stage != STAGE_IDLE) {
110 longjmp(restart, THROW_TIMEOUT);
115 static RETSIGTYPE sigpipe_handler (int signal)
116 /* handle SIGPIPE signal indicating a broken stream socket */
118 longjmp(restart, THROW_SIGPIPE);
121 #define CLEANUP_TIMEOUT 60 /* maximum timeout during cleanup */
123 static int cleanupSockClose (int fd)
124 /* close sockets in maximum CLEANUP_TIMEOUT seconds during cleanup */
127 SIGHANDLERTYPE alrmsave;
128 alrmsave = set_signal_handler(SIGALRM, null_signal_handler);
129 set_timeout(CLEANUP_TIMEOUT);
130 scerror = SockClose(fd);
132 set_signal_handler(SIGALRM, alrmsave);
137 static int kerberos_auth(socket, canonical, principal)
138 /* authenticate to the server host using Kerberos V4 */
139 int socket; /* socket to server host */
140 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 xalloca(ticket, KTEXT, 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),
192 report(stderr, GT_("kerberos error %s\n"), (krb_get_err_text (rem)));
193 return (PS_AUTHFAIL);
197 #endif /* KERBEROS_V4 */
200 static int kerberos5_auth(socket, canonical)
201 /* authenticate to the server host using Kerberos V5 */
202 int socket; /* socket to server host */
203 const char *canonical; /* server name */
205 krb5_error_code retval;
206 krb5_context context;
208 krb5_principal client = NULL, server = NULL;
209 krb5_error *err_ret = NULL;
211 krb5_auth_context auth_context = NULL;
213 krb5_init_context(&context);
214 krb5_init_ets(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 report(stderr, GT_("krb5_sendauth: %s [server says '%*s'] \n"),
252 error_message(retval),
255 if (err_ret && err_ret->text.length) {
256 report(stderr, GT_("krb5_sendauth: %s [server says '%*s'] \n"),
257 error_message(retval),
258 err_ret->text.length,
261 krb5_free_error(context, err_ret);
263 report(stderr, "krb5_sendauth: %s\n", error_message(retval));
269 #endif /* KERBEROS_V5 */
271 static void clean_skipped_list(struct idlist **skipped_list)
272 /* struct "idlist" contains no "prev" ptr; we must remove unused items first */
274 struct idlist *current=NULL, *prev=NULL, *tmp=NULL, *head=NULL;
275 prev = current = head = *skipped_list;
281 /* if item has no reference, remove it */
282 if (current && current->val.status.mark == 0)
284 if (current == head) /* remove first item (head) */
286 head = current->next;
287 if (current->id) free(current->id);
289 prev = current = head;
291 else /* remove middle/last item */
295 if (current->id) free(current->id);
300 else /* skip this item */
303 current = current->next;
307 *skipped_list = head;
310 static void send_size_warnings(struct query *ctl)
311 /* send warning mail with skipped msg; reset msg count when user notified */
314 int msg_to_send = FALSE;
315 struct idlist *head=NULL, *current=NULL;
316 int max_warning_poll_count;
322 /* don't start a notification message unless we need to */
323 for (current = head; current; current = current->next)
324 if (current->val.status.num == 0 && current->val.status.mark)
330 * There's no good way to recover if we can't send notification mail,
331 * but it's not a disaster, either, since the skipped mail will not
334 if (open_warning_by_mail(ctl, (struct msgblk *)NULL))
336 stuff_warning(iana_charset, ctl,
337 GT_("Subject: Fetchmail oversized-messages warning"));
338 stuff_warning(NULL, ctl, "");
339 stuff_warning(NULL, ctl,
340 GT_("The following oversized messages remain on the mail server %s:"),
341 ctl->server.pollname);
343 stuff_warning(NULL, ctl, "");
345 if (run.poll_interval == 0)
346 max_warning_poll_count = 0;
348 max_warning_poll_count = ctl->warnings/run.poll_interval;
350 /* parse list of skipped msg, adding items to the mail */
351 for (current = head; current; current = current->next)
353 if (current->val.status.num == 0 && current->val.status.mark)
355 nbr = current->val.status.mark;
356 size = atoi(current->id);
357 stuff_warning(NULL, ctl,
358 GT_(" %d msg %d octets long skipped by fetchmail."),
361 current->val.status.num++;
362 current->val.status.mark = 0;
364 if (current->val.status.num >= max_warning_poll_count)
365 current->val.status.num = 0;
368 stuff_warning(NULL, ctl, "");
370 close_warning_by_mail(ctl, (struct msgblk *)NULL);
373 static void mark_oversized(struct query *ctl, int num, int size)
374 /* mark a message oversized */
376 struct idlist *current=NULL, *tmp=NULL;
380 /* convert size to string */
381 snprintf(sizestr, sizeof(sizestr), "%d", size);
383 /* build a list of skipped messages
384 * val.id = size of msg (string cnvt)
385 * val.status.num = warning_poll_count
386 * val.status.mask = nbr of msg this size
389 current = ctl->skipped;
391 /* initialise warning_poll_count to the
392 * current value so that all new msg will
393 * be included in the next mail
395 cnt = current ? current->val.status.num : 0;
397 /* if entry exists, increment the count */
398 if (current && str_in_list(¤t, sizestr, FALSE))
400 for ( ; current; current = current->next)
402 if (strcmp(current->id, sizestr) == 0)
404 current->val.status.mark++;
409 /* otherwise, create a new entry */
410 /* initialise with current poll count */
413 tmp = save_str(&ctl->skipped, sizestr, 1);
414 tmp->val.status.num = cnt;
418 static int fetch_messages(int mailserver_socket, struct query *ctl,
419 int count, int *msgsizes, int maxfetch,
420 int *fetches, int *dispatches, int *deletions)
421 /* fetch messages in lockstep mode */
423 flag force_retrieval;
424 int num, firstnum = 1, lastnum = 0, err, len;
425 int fetchsizelimit = ctl->fetchsizelimit;
428 if (ctl->server.base_protocol->getpartialsizes && NUM_NONZERO(fetchsizelimit))
430 /* for POP3, we can get the size of one mail only! Unfortunately, this
431 * protocol specific test cannot be done elsewhere as the protocol
432 * could be "auto". */
433 switch (ctl->server.protocol)
435 case P_POP3: case P_APOP: case P_RPOP:
439 /* Time to allocate memory to store the sizes */
440 xalloca(msgsizes, int *, sizeof(int) * fetchsizelimit);
444 * What forces this code is that in POP2 and
445 * IMAP2bis you can't fetch a message without
446 * having it marked `seen'. In POP3 and IMAP4, on the
447 * other hand, you can (peek_capable is set by
448 * each driver module to convey this; it's not a
449 * method constant because of the difference between
450 * IMAP2bis and IMAP4, and because POP3 doesn't peek
451 * if fetchall is on).
453 * The result of being unable to peek is that if there's
454 * any kind of transient error (DNS lookup failure, or
455 * sendmail refusing delivery due to process-table limits)
456 * the message will be marked "seen" on the server without
457 * having been delivered. This is not a big problem if
458 * fetchmail is running in foreground, because the user
459 * will see a "skipped" message when it next runs and get
462 * But in daemon mode this leads to the message
463 * being silently ignored forever. This is not
466 * We compensate for this by checking the error
467 * count from the previous pass and forcing all
468 * messages to be considered new if it's nonzero.
470 force_retrieval = !peek_capable && (ctl->errcount > 0);
472 for (num = 1; num <= count; num++)
474 flag suppress_delete = FALSE;
475 flag suppress_forward = FALSE;
476 flag suppress_readbody = FALSE;
477 flag retained = FALSE;
478 int msgcode = MSGLEN_UNKNOWN;
480 /* check if the message is old
481 * Note: the size of the message may not be known here */
482 if (ctl->fetchall || force_retrieval)
484 else if (ctl->server.base_protocol->is_old && (ctl->server.base_protocol->is_old)(mailserver_socket,ctl,num))
485 msgcode = MSGLEN_OLD;
486 if (msgcode == MSGLEN_OLD)
488 /* To avoid flooding the syslog when using --keep,
489 * report "Skipped message" only when:
490 * 1) --verbose is on, or
491 * 2) fetchmail does not use syslog
493 if ( (outlevel >= O_VERBOSE) ||
494 (outlevel > O_SILENT && !run.use_syslog)
498 GT_("skipping message %s@%s:%d"),
499 ctl->remotename, ctl->server.truename, num);
505 if (ctl->server.base_protocol->getpartialsizes && NUM_NONZERO(fetchsizelimit) &&
508 /* Instead of getting the sizes of all mails at the start, we get
509 * the sizes in blocks of fetchsizelimit. This leads to better
510 * performance when there are too many mails (say, 10000) in
511 * the mailbox and either we are not getting all the mails at
512 * one go (--fetchlimit 100) or there is a frequent socket
513 * error while just getting the sizes of all mails! */
516 int oldstage = stage;
518 lastnum = num + fetchsizelimit - 1;
521 for (i = 0; i < fetchsizelimit; i++)
524 stage = STAGE_GETSIZES;
525 err = (ctl->server.base_protocol->getpartialsizes)(mailserver_socket, num, lastnum, msgsizes);
531 msgsize = msgsizes ? msgsizes[num-firstnum] : 0;
533 /* check if the message is oversized */
534 if (NUM_NONZERO(ctl->limit) && (msgsize > ctl->limit))
535 msgcode = MSGLEN_TOOLARGE;
536 /* else if (msgsize == 512)
537 msgcode = MSGLEN_OLD; (hmh) sample code to skip message */
541 if ((msgcode == MSGLEN_TOOLARGE) && !check_only)
543 mark_oversized(ctl, num, msgsize);
544 suppress_delete = TRUE;
546 if (outlevel > O_SILENT)
548 /* old messages are already handled above */
550 GT_("skipping message %s@%s:%d (%d octets)"),
551 ctl->remotename, ctl->server.truename, num,
557 * Invalid lengths are produced by Post Office/NT's
558 * annoying habit of randomly prepending bogus
559 * LIST items of length -1. Patrick Audley
560 * <paudley@pobox.com> tells us: LIST shows a
561 * size of -1, RETR and TOP return "-ERR
562 * System error - couldn't open message", and
563 * DELE succeeds but doesn't actually delete
566 report_build(stdout, GT_(" (length -1)"));
568 case MSGLEN_TOOLARGE:
569 report_build(stdout, GT_(" (oversized)"));
576 flag wholesize = !ctl->server.base_protocol->fetch_body;
577 flag separatefetchbody = (ctl->server.base_protocol->fetch_body) ? TRUE : FALSE;
579 /* request a message */
580 err = (ctl->server.base_protocol->fetch_headers)(mailserver_socket,ctl,num, &len);
581 if (err == PS_TRANSIENT) /* server is probably Exchange */
584 GT_("couldn't fetch headers, message %s@%s:%d (%d octets)\n"),
585 ctl->remotename, ctl->server.truename, num,
592 /* -1 means we didn't see a size in the response */
599 if (outlevel > O_SILENT)
601 report_build(stdout, GT_("reading message %s@%s:%d of %d"),
602 ctl->remotename, ctl->server.truename,
605 /* XXX FIXME: the gettext stuff needs to list "octets" or
606 * "header octets" as a unit, and also provide for
607 * proper plural form */
609 report_build(stdout, GT_(" (%d %soctets)"),
610 len, wholesize ? "" : GT_("header "));
611 if (outlevel >= O_VERBOSE)
612 report_complete(stdout, "\n");
614 report_complete(stdout, " ");
618 * Read the message headers and ship them to the
621 err = readheaders(mailserver_socket, len, msgsize,
623 /* pass the suppress_readbody flag only if the underlying
624 * protocol does not fetch the body separately */
625 separatefetchbody ? 0 : &suppress_readbody);
626 if (err == PS_RETAINED)
627 suppress_forward = suppress_delete = retained = TRUE;
628 else if (err == PS_TRANSIENT)
629 suppress_delete = suppress_forward = TRUE;
630 else if (err == PS_REFUSED)
631 suppress_forward = TRUE;
632 else if (err == PS_TRUNCATED)
633 suppress_readbody = TRUE;
637 /* tell server we got it OK and resynchronize */
638 if (separatefetchbody && ctl->server.base_protocol->trail)
640 if (outlevel >= O_VERBOSE && !isafile(1))
646 if ((err = (ctl->server.base_protocol->trail)(mailserver_socket, ctl, num)))
650 /* do not read the body which is not being forwarded only if
651 * the underlying protocol allows the body to be fetched
653 if (separatefetchbody && suppress_forward)
654 suppress_readbody = TRUE;
657 * If we're using IMAP4 or something else that
658 * can fetch headers separately from bodies,
659 * it's time to request the body now. This
660 * fetch may be skipped if we got an anti-spam
661 * or other PS_REFUSED error response during
664 if (!suppress_readbody)
666 if (separatefetchbody)
669 if ((err=(ctl->server.base_protocol->fetch_body)(mailserver_socket,ctl,num,&len)))
672 * Work around a bug in Novell's
673 * broken GroupWise IMAP server;
674 * its body FETCH response is missing
675 * the required length for the data
676 * string. This violates RFC2060.
679 len = msgsize - msgblk.msglen;
680 if (outlevel > O_SILENT && !wholesize)
681 report_complete(stdout,
682 GT_(" (%d body octets) "), len);
685 /* process the body now */
686 err = readbody(mailserver_socket,
690 if (err == PS_TRANSIENT)
691 suppress_delete = suppress_forward = TRUE;
695 /* tell server we got it OK and resynchronize */
696 if (ctl->server.base_protocol->trail)
698 if (outlevel >= O_VERBOSE && !isafile(1))
704 err = (ctl->server.base_protocol->trail)(mailserver_socket, ctl, num);
710 /* count # messages forwarded on this pass */
711 if (!suppress_forward)
715 * Check to see if the numbers matched?
717 * Yes, some servers foo this up horribly.
718 * All IMAP servers seem to get it right, and
719 * so does Eudora QPOP at least in 2.xx
722 * Microsoft Exchange gets it completely
723 * wrong, reporting compressed rather than
724 * actual sizes (so the actual length of
725 * message is longer than the reported size).
726 * Another fine example of Microsoft brain death!
728 * Some older POP servers, like the old UCB
729 * POP server and the pre-QPOP QUALCOMM
730 * versions, report a longer size in the LIST
731 * response than actually gets shipped up.
732 * It's unclear what is going on here, as the
733 * QUALCOMM server (at least) seems to be
734 * reporting the on-disk size correctly.
736 if (msgblk.msglen != msgsize)
738 if (outlevel >= O_DEBUG)
740 GT_("message %s@%s:%d was not the expected length (%d actual != %d expected)\n"),
741 ctl->remotename, ctl->server.truename, num,
742 msgblk.msglen, msgsize);
745 /* end-of-message processing starts here */
746 if (!close_sink(ctl, &msgblk, !suppress_forward))
749 suppress_delete = TRUE;
757 * At this point in flow of control, either
758 * we've bombed on a protocol error or had
759 * delivery refused by the SMTP server
760 * (unlikely -- I've never seen it) or we've
761 * seen `accepted for delivery' and the
762 * message is shipped. It's safe to mark the
763 * message seen and delete it on the server
767 /* maybe we delete this message now? */
770 if (outlevel > O_SILENT)
771 report(stdout, GT_(" retained\n"));
773 else if (ctl->server.base_protocol->delete
775 && ((msgcode >= 0 && !ctl->keep)
776 || (msgcode == MSGLEN_OLD && ctl->flush)))
779 if (outlevel > O_SILENT)
780 report_complete(stdout, GT_(" flushed\n"));
781 err = (ctl->server.base_protocol->delete)(mailserver_socket, ctl, num);
787 if ( (outlevel >= O_VERBOSE) ||
788 /* To avoid flooding the syslog when using --keep,
789 * report "Skipped message" only when:
790 * 1) --verbose is on, or
791 * 2) fetchmail does not use syslog, or
792 * 3) the message was skipped for some other
793 * reason than just being old.
795 (outlevel > O_SILENT && (!run.use_syslog || msgcode != MSGLEN_OLD))
797 report_complete(stdout, GT_(" not flushed\n"));
799 /* maybe we mark this message as seen now? */
800 if (ctl->server.base_protocol->mark_seen
802 && (msgcode >= 0 && ctl->keep))
804 err = (ctl->server.base_protocol->mark_seen)(mailserver_socket, ctl, num);
810 /* perhaps this as many as we're ready to handle */
811 if (maxfetch && maxfetch <= *fetches && num < count)
813 report(stdout, GT_("fetchlimit %d reached; %d messages left on server %s account %s\n"),
814 maxfetch, count - *fetches, ctl->server.truename, ctl->remotename);
822 /* retrieve messages from server using given protocol method table */
823 static int do_session(
824 /* parsed options with merged-in defaults */
826 /* protocol method table */
827 const struct method *proto,
828 /* maximum number of messages to fetch */
831 static int *msgsizes;
832 volatile int err, mailserver_socket = -1; /* pacifies -Wall */
833 int deletions = 0, js;
835 SIGHANDLERTYPE pipesave;
836 SIGHANDLERTYPE alrmsave;
838 ctl->server.base_protocol = proto;
843 init_transact(proto);
845 /* set up the server-nonresponse timeout */
846 alrmsave = set_signal_handler(SIGALRM, timeout_handler);
847 mytimeout = ctl->server.timeout;
849 /* set up the broken-pipe timeout */
850 pipesave = set_signal_handler(SIGPIPE, sigpipe_handler);
852 if ((js = setjmp(restart)))
854 /* exception caught */
855 #ifdef HAVE_SIGPROCMASK
857 * Don't rely on setjmp() to restore the blocked-signal mask.
858 * It does this under BSD but is required not to under POSIX.
860 * If your Unix doesn't have sigprocmask, better hope it has
861 * BSD-like behavior. Otherwise you may see fetchmail get
862 * permanently wedged after a second timeout on a bad read,
863 * because alarm signals were blocked after the first.
867 sigfillset(&allsigs);
868 sigprocmask(SIG_UNBLOCK, &allsigs, NULL);
869 #endif /* HAVE_SIGPROCMASK */
871 if (js == THROW_SIGPIPE)
873 set_signal_handler(SIGPIPE, SIG_IGN);
875 GT_("SIGPIPE thrown from an MDA or a stream socket error\n"));
878 else if (js == THROW_TIMEOUT)
880 if (phase == OPEN_WAIT)
882 GT_("timeout after %d seconds waiting to connect to server %s.\n"),
883 ctl->server.timeout, ctl->server.pollname);
884 else if (phase == SERVER_WAIT)
886 GT_("timeout after %d seconds waiting for server %s.\n"),
887 ctl->server.timeout, ctl->server.pollname);
888 else if (phase == FORWARDING_WAIT)
890 GT_("timeout after %d seconds waiting for %s.\n"),
892 ctl->mda ? "MDA" : "SMTP");
893 else if (phase == LISTENER_WAIT)
895 GT_("timeout after %d seconds waiting for listener to respond.\n"), ctl->server.timeout);
898 GT_("timeout after %d seconds.\n"), ctl->server.timeout);
901 * If we've exceeded our threshold for consecutive timeouts,
902 * try to notify the user, then mark the connection wedged.
903 * Don't do this if the connection can idle, though; idle
904 * timeouts just mean the frequency of mail is low.
906 if (timeoutcount > MAX_TIMEOUTS
907 && !open_warning_by_mail(ctl, (struct msgblk *)NULL))
909 stuff_warning(iana_charset, ctl,
910 GT_("Subject: fetchmail sees repeated timeouts"));
911 stuff_warning(NULL, ctl, "");
912 stuff_warning(NULL, ctl,
913 GT_("Fetchmail saw more than %d timeouts while attempting to get mail from %s@%s.\n"),
915 ctl->remotename, ctl->server.truename);
916 stuff_warning(NULL, ctl,
917 GT_("This could mean that your mailserver is stuck, or that your SMTP\n" \
918 "server is wedged, or that your mailbox file on the server has been\n" \
919 "corrupted by a server error. You can run `fetchmail -v -v' to\n" \
920 "diagnose the problem.\n\n" \
921 "Fetchmail won't poll this mailbox again until you restart it.\n"));
922 close_warning_by_mail(ctl, (struct msgblk *)NULL);
932 /* setjmp returned zero -> normal operation */
933 char buf[MSGBUFSIZE+1], *realhost;
934 int count, new, bytes;
936 int fetches, dispatches, oldphase;
937 #else /* INET6_ENABLE */
938 int port, fetches, dispatches, oldphase;
939 #endif /* INET6_ENABLE */
942 /* execute pre-initialization command, if any */
943 if (ctl->preconnect && (err = system(ctl->preconnect)))
946 GT_("pre-connection command failed with status %d\n"), err);
951 /* open a socket to the mail server */
954 set_timeout(mytimeout);
957 port = ctl->server.port ? ctl->server.port : ( ctl->use_ssl ? ctl->server.base_protocol->sslport : ctl->server.base_protocol->port );
959 port = ctl->server.port ? ctl->server.port : ctl->server.base_protocol->port;
961 #endif /* !INET6_ENABLE */
963 #ifdef HAVE_PKG_hesiod
964 /* If either the pollname or vianame are "hesiod" we want to
965 lookup the user's hesiod pobox host */
966 if (!strcasecmp(ctl->server.queryname, "hesiod")) {
967 struct hes_postoffice *hes_p;
968 hes_p = hes_getmailhost(ctl->remotename);
969 if (hes_p != NULL && strcmp(hes_p->po_type, "POP") == 0) {
970 free(ctl->server.queryname);
971 ctl->server.queryname = xstrdup(hes_p->po_host);
973 free(ctl->server.via);
974 ctl->server.via = xstrdup(hes_p->po_host);
977 GT_("couldn't find HESIOD pobox for %s\n"),
983 #ifdef HAVE_GETHOSTBYNAME
985 * Canonicalize the server truename for later use. This also
986 * functions as a probe for whether the mailserver is accessible.
987 * We try it on each poll cycle until we get a result. This way,
988 * fetchmail won't fail if started up when the network is inaccessible.
990 if (ctl->server.dns && !ctl->server.trueaddr)
992 if (ctl->server.lead_server)
994 char *leadname = ctl->server.lead_server->truename;
996 /* prevent core dump from ill-formed or duplicate entry */
999 report(stderr, GT_("Lead server has no name.\n"));
1006 ctl->server.truename = xstrdup(leadname);
1010 struct hostent *namerec;
1013 * Get the host's IP, so we can report it like this:
1015 * Received: from hostname [10.0.0.1]
1018 namerec = gethostbyname(ctl->server.queryname);
1019 if (namerec == (struct hostent *)NULL)
1022 GT_("couldn't find canonical DNS name of %s (%s)\n"),
1023 ctl->server.pollname, ctl->server.queryname);
1031 ctl->server.truename=xstrdup((char *)namerec->h_name);
1032 ctl->server.trueaddr=xmalloc(namerec->h_length);
1033 memcpy(ctl->server.trueaddr,
1034 namerec->h_addr_list[0],
1039 #endif /* HAVE_GETHOSTBYNAME */
1041 realhost = ctl->server.via ? ctl->server.via : ctl->server.pollname;
1043 /* allow time for the port to be set up if we have a plugin */
1044 if (ctl->server.plugin)
1047 if ((mailserver_socket = SockOpen(realhost,
1048 ctl->server.service ? ctl->server.service : ( ctl->use_ssl ? ctl->server.base_protocol->sslservice : ctl->server.base_protocol->service ),
1049 ctl->server.netsec, ctl->server.plugin)) == -1)
1050 #else /* INET6_ENABLE */
1051 if ((mailserver_socket = SockOpen(realhost, port, NULL, ctl->server.plugin)) == -1)
1052 #endif /* INET6_ENABLE */
1054 char errbuf[BUFSIZ];
1055 #ifndef INET6_ENABLE
1057 #ifdef HAVE_RES_SEARCH
1058 if (err_no != 0 && h_errno != 0)
1059 report(stderr, GT_("internal inconsistency\n"));
1062 * Avoid generating a bogus error every poll cycle when we're
1063 * in daemon mode but the connection to the outside world
1066 if (!((err_no == EHOSTUNREACH || err_no == ENETUNREACH)
1067 && run.poll_interval))
1069 report_build(stderr, GT_("%s connection to %s failed"),
1070 ctl->server.base_protocol->name, ctl->server.pollname);
1071 #ifdef HAVE_RES_SEARCH
1074 if (h_errno == HOST_NOT_FOUND)
1075 strcpy(errbuf, GT_("host is unknown."));
1077 else if (h_errno == NO_ADDRESS)
1078 strcpy(errbuf, GT_("name is valid but has no IP address."));
1080 else if (h_errno == NO_RECOVERY)
1081 strcpy(errbuf, GT_("unrecoverable name server error."));
1082 else if (h_errno == TRY_AGAIN)
1083 strcpy(errbuf, GT_("temporary name server error."));
1085 snprintf (errbuf, sizeof(errbuf),
1086 GT_("unknown DNS error %d."), h_errno);
1089 #endif /* HAVE_RES_SEARCH */
1090 strcpy(errbuf, strerror(err_no));
1091 report_complete(stderr, ": %s\n", errbuf);
1095 * Don't use this. It was an attempt to address Debian bug
1096 * #47143 (Notify user by mail when pop server nonexistent).
1097 * Trouble is, that doesn't work; you trip over the case
1098 * where your SLIP or PPP link is down...
1100 /* warn the system administrator */
1101 if (open_warning_by_mail(ctl, (struct msgblk *)NULL) == 0)
1103 stuff_warning(iana_charset, ctl,
1104 GT_("Subject: Fetchmail unreachable-server warning."));
1105 stuff_warning(NULL, ctl, "");
1106 stuff_warning(NULL, ctl, GT_("Fetchmail could not reach the mail server %s:"),
1107 ctl->server.pollname);
1108 stuff_warning(NULL, ctl, errbuf, ctl->server.pollname);
1109 close_warning_by_mail(ctl, (struct msgblk *)NULL);
1113 #endif /* INET6_ENABLE */
1121 /* Save the socket opened. Useful if Fetchmail hangs on SSLOpen
1122 * because the socket can be closed.
1124 mailserver_socket_temp = mailserver_socket;
1125 set_timeout(mytimeout);
1127 /* perform initial SSL handshake on open connection */
1128 /* Note: We pass the realhost name over for certificate
1129 verification. We may want to make this configurable */
1130 if (ctl->use_ssl && SSLOpen(mailserver_socket,ctl->sslcert,ctl->sslkey,ctl->sslproto,ctl->sslcertck,
1131 ctl->sslcertpath,ctl->sslfingerprint,realhost,ctl->server.pollname) == -1)
1133 report(stderr, GT_("SSL connection failed.\n"));
1138 /* Fetchmail didn't hang on SSLOpen,
1139 * then no need to set mailserver_socket_temp
1141 mailserver_socket_temp = -1;
1144 /* A timeout is still defined before SSLOpen,
1145 * then Fetchmail hanging on SSLOpen is handled.
1150 if (ctl->server.authenticate == A_KERBEROS_V4 && (strcasecmp(proto->name,"IMAP") != 0))
1152 set_timeout(mytimeout);
1153 err = kerberos_auth(mailserver_socket, ctl->server.truename,
1154 ctl->server.principal);
1159 #endif /* KERBEROS_V4 */
1162 if (ctl->server.authenticate == A_KERBEROS_V5)
1164 set_timeout(mytimeout);
1165 err = kerberos5_auth(mailserver_socket, ctl->server.truename);
1170 #endif /* KERBEROS_V5 */
1172 /* accept greeting message from mail server */
1173 err = (ctl->server.base_protocol->parse_response)(mailserver_socket, buf);
1177 /* try to get authorized to fetch mail */
1178 stage = STAGE_GETAUTH;
1179 if (ctl->server.base_protocol->getauth)
1181 err = (ctl->server.base_protocol->getauth)(mailserver_socket, ctl, buf);
1185 if (err == PS_LOCKBUSY)
1186 report(stderr, GT_("Lock-busy error on %s@%s\n"),
1188 ctl->server.truename);
1189 else if (err == PS_SERVBUSY)
1190 report(stderr, GT_("Server busy error on %s@%s\n"),
1192 ctl->server.truename);
1193 else if (err == PS_AUTHFAIL)
1195 report(stderr, GT_("Authorization failure on %s@%s%s\n"),
1197 ctl->server.truename,
1198 (ctl->wehaveauthed ? GT_(" (previously authorized)") : "")
1202 * If we're running in background, try to mail the
1203 * calling user a heads-up about the authentication
1204 * failure once it looks like this isn't a fluke
1205 * due to the server being temporarily inaccessible.
1206 * When we get third succesive failure, we notify the user
1207 * but only if we haven't already managed to get
1208 * authorization. After that, once we get authorization
1209 * we let the user know service is restored.
1211 if (run.poll_interval
1212 && !ctl->wehavesentauthnote
1213 && ((ctl->wehaveauthed && ++ctl->authfailcount >= 10)
1214 || (!ctl->wehaveauthed && ++ctl->authfailcount >= 3))
1215 && !open_warning_by_mail(ctl, (struct msgblk *)NULL))
1217 ctl->wehavesentauthnote = 1;
1218 stuff_warning(iana_charset, ctl,
1219 GT_("Subject: fetchmail authentication failed on %s@%s"),
1220 ctl->remotename, ctl->server.truename);
1221 stuff_warning(NULL, ctl, "");
1222 stuff_warning(NULL, ctl,
1223 GT_("Fetchmail could not get mail from %s@%s.\n"),
1225 ctl->server.truename);
1226 if (ctl->wehaveauthed)
1227 stuff_warning(NULL, ctl, GT_("\
1228 The attempt to get authorization failed.\n\
1229 Since we have already succeeded in getting authorization for this\n\
1230 connection, this is probably another failure mode (such as busy server)\n\
1231 that fetchmail cannot distinguish because the server didn't send a useful\n\
1234 However, if you HAVE changed your account details since starting the\n\
1235 fetchmail daemon, you need to stop the daemon, change your configuration\n\
1236 of fetchmail, and then restart the daemon.\n\
1238 The fetchmail daemon will continue running and attempt to connect\n\
1239 at each cycle. No future notifications will be sent until service\n\
1242 stuff_warning(NULL, ctl, GT_("\
1243 The attempt to get authorization failed.\n\
1244 This probably means your password is invalid, but some servers have\n\
1245 other failure modes that fetchmail cannot distinguish from this\n\
1246 because they don't send useful error messages on login failure.\n\
1248 The fetchmail daemon will continue running and attempt to connect\n\
1249 at each cycle. No future notifications will be sent until service\n\
1251 close_warning_by_mail(ctl, (struct msgblk *)NULL);
1254 else if (err == PS_REPOLL)
1256 if (outlevel >= O_VERBOSE)
1257 report(stderr, GT_("Repoll immediately on %s@%s\n"),
1259 ctl->server.truename);
1262 report(stderr, GT_("Unknown login or authentication error on %s@%s\n"),
1264 ctl->server.truename);
1271 * This connection has given us authorization at least once.
1273 * There are dodgy server (clubinternet.fr for example) that
1274 * give spurious authorization failures on patently good
1275 * account/password details, then 5 minutes later let you in!
1277 * This is meant to build in some tolerance of such nasty bits
1280 ctl->wehaveauthed = 1;
1281 /*if (ctl->authfailcount >= 3)*/
1282 if (ctl->wehavesentauthnote)
1284 ctl->wehavesentauthnote = 0;
1286 GT_("Authorization OK on %s@%s\n"),
1288 ctl->server.truename);
1289 if (!open_warning_by_mail(ctl, (struct msgblk *)NULL))
1291 stuff_warning(iana_charset, ctl,
1292 GT_("Subject: fetchmail authentication OK on %s@%s"),
1293 ctl->remotename, ctl->server.truename);
1294 stuff_warning(NULL, ctl, "");
1295 stuff_warning(NULL, ctl,
1296 GT_("Fetchmail was able to log into %s@%s.\n"),
1298 ctl->server.truename);
1299 stuff_warning(NULL, ctl,
1300 GT_("Service has been restored.\n"));
1301 close_warning_by_mail(ctl, (struct msgblk *)NULL);
1306 * Reporting only after the first three
1307 * consecutive failures, or ten consecutive
1308 * failures after we have managed to get
1311 ctl->authfailcount = 0;
1315 ctl->errcount = fetches = 0;
1317 /* now iterate over each folder selected */
1318 for (idp = ctl->mailboxes; idp; idp = idp->next)
1325 /* reset timeout, in case we did an IDLE */
1326 mytimeout = ctl->server.timeout;
1328 if (outlevel >= O_DEBUG)
1331 report(stdout, GT_("selecting or re-polling folder %s\n"), idp->id);
1333 report(stdout, GT_("selecting or re-polling default folder\n"));
1336 /* compute # of messages and number of new messages waiting */
1337 stage = STAGE_GETRANGE;
1338 err = (ctl->server.base_protocol->getrange)(mailserver_socket, ctl, idp->id, &count, &new, &bytes);
1342 /* show user how many messages we downloaded */
1344 (void) snprintf(buf, sizeof(buf),
1345 GT_("%s at %s (folder %s)"),
1346 ctl->remotename, ctl->server.pollname, idp->id);
1348 (void) snprintf(buf, sizeof(buf), GT_("%s at %s"),
1349 ctl->remotename, ctl->server.pollname);
1350 if (outlevel > O_SILENT)
1352 if (count == -1) /* only used for ETRN */
1353 report(stdout, GT_("Polling %s\n"), ctl->server.truename);
1354 else if (count != 0)
1356 if (new != -1 && (count - new) > 0)
1357 report_build(stdout, ngettext("%d message (%d %s) for %s", "%d messages (%d %s) for %s", (unsigned long)count),
1360 ngettext("seen", "seen", (unsigned long)count-new),
1363 report_build(stdout, ngettext("%d message for %s",
1364 "%d messages for %s",
1368 report_complete(stdout, ".\n");
1370 report_complete(stdout, GT_(" (%d octets).\n"), bytes);
1374 /* these are pointless in normal daemon mode */
1375 if (pass == 1 && (run.poll_interval == 0 || outlevel >= O_VERBOSE))
1376 report(stdout, GT_("No mail for %s\n"), buf);
1380 /* very important, this is where we leave the do loop */
1386 if (new == -1 || ctl->fetchall)
1388 fetches = new; /* set error status correctly */
1390 * There used to be a `goto noerror' here, but this
1391 * prevented checking of multiple folders. This
1392 * comment is a reminder in case I introduced some
1393 * subtle bug by removing it...
1401 * Don't trust the message count passed by the server.
1402 * Without this check, it might be possible to do a
1403 * DNS-spoofing attack that would pass back a ridiculous
1404 * count, and allocate a malloc area that would overlap
1405 * a portion of the stack.
1407 if (count > INT_MAX/sizeof(int))
1409 report(stderr, GT_("bogus message count!"));
1410 return(PS_PROTOCOL);
1414 * We need the size of each message before it's
1415 * loaded in order to pass it to the ESMTP SIZE
1416 * option. If the protocol has a getsizes method,
1417 * we presume this means it doesn't get reliable
1418 * sizes from message fetch responses.
1420 * If the protocol supports getting sizes of subset of
1421 * messages, we skip this step now.
1423 if (proto->getsizes &&
1424 !(proto->getpartialsizes && NUM_NONZERO(ctl->fetchsizelimit)))
1426 xalloca(msgsizes, int *, sizeof(int) * count);
1427 for (i = 0; i < count; i++)
1430 stage = STAGE_GETSIZES;
1431 err = (proto->getsizes)(mailserver_socket, count, msgsizes);
1438 for (i = 0; i < count; i++)
1439 bytes += msgsizes[i];
1443 /* read, forward, and delete messages */
1444 stage = STAGE_FETCH;
1446 /* fetch in lockstep mode */
1447 err = fetch_messages(mailserver_socket, ctl,
1450 &fetches, &dispatches, &deletions);
1454 if (!check_only && ctl->skipped
1455 && run.poll_interval > 0 && !nodetach)
1457 clean_skipped_list(&ctl->skipped);
1458 send_size_warnings(ctl);
1463 * Only re-poll if we either had some actual forwards and
1464 * either allowed deletions and had no errors.
1465 * Otherwise it is far too easy to get into infinite loops.
1467 (dispatches && ctl->server.base_protocol->retry && !ctl->keep && !ctl->errcount);
1471 /* ordinary termination with no errors -- officially log out */
1472 err = (ctl->server.base_protocol->logout_cmd)(mailserver_socket, ctl);
1474 * Hmmmm...arguably this would be incorrect if we had fetches but
1475 * no dispatches (due to oversized messages, etc.)
1478 err = (fetches > 0) ? PS_SUCCESS : PS_NOMAIL;
1479 cleanupSockClose(mailserver_socket);
1483 /* we only get here on error */
1484 if (err != 0 && err != PS_SOCKET && err != PS_REPOLL)
1486 stage = STAGE_LOGOUT;
1487 (ctl->server.base_protocol->logout_cmd)(mailserver_socket, ctl);
1490 /* try to clean up all streams */
1493 if (mailserver_socket != -1) {
1494 cleanupSockClose(mailserver_socket);
1495 mailserver_socket = -1;
1497 /* If there was a connect timeout, the socket should be closed.
1498 * mailserver_socket_temp contains the socket to close.
1500 if (mailserver_socket_temp != -1) {
1501 cleanupSockClose(mailserver_socket_temp);
1502 mailserver_socket_temp = -1;
1506 msg = (const char *)NULL; /* sacrifice to -Wall */
1510 msg = GT_("socket");
1513 msg = GT_("missing or bad RFC822 header");
1519 msg = GT_("client/server synchronization");
1522 msg = GT_("client/server protocol");
1525 msg = GT_("lock busy on server");
1528 msg = GT_("SMTP transaction");
1531 msg = GT_("DNS lookup");
1534 report(stderr, GT_("undefined error\n"));
1537 /* no report on PS_MAXFETCH or PS_UNDEFINED or PS_AUTHFAIL */
1538 if (err==PS_SOCKET || err==PS_SYNTAX
1539 || err==PS_IOERR || err==PS_ERROR || err==PS_PROTOCOL
1540 || err==PS_LOCKBUSY || err==PS_SMTP || err==PS_DNS)
1544 if (phase == FORWARDING_WAIT || phase == LISTENER_WAIT)
1545 stem = GT_("%s error while delivering to SMTP host %s\n");
1547 stem = GT_("%s error while fetching from %s\n");
1548 report(stderr, stem, msg, ctl->server.pollname);
1552 /* execute wrapup command, if any */
1553 if (ctl->postconnect && (err = system(ctl->postconnect)))
1555 report(stderr, GT_("post-connection command failed with status %d\n"), err);
1556 if (err == PS_SUCCESS)
1560 set_timeout(0); /* cancel any pending alarm */
1561 set_signal_handler(SIGALRM, alrmsave);
1562 set_signal_handler(SIGPIPE, pipesave);
1566 int do_protocol(ctl, proto)
1567 /* retrieve messages from server using given protocol method table */
1568 struct query *ctl; /* parsed options with merged-in defaults */
1569 const struct method *proto; /* protocol method table */
1574 if (ctl->server.authenticate == A_KERBEROS_V4)
1576 report(stderr, GT_("Kerberos V4 support not linked.\n"));
1579 #endif /* KERBEROS_V4 */
1582 if (ctl->server.authenticate == A_KERBEROS_V5)
1584 report(stderr, GT_("Kerberos V5 support not linked.\n"));
1587 #endif /* KERBEROS_V5 */
1589 /* lacking methods, there are some options that may fail */
1592 /* check for unsupported options */
1595 GT_("Option --flush is not supported with %s\n"),
1599 else if (ctl->fetchall) {
1601 GT_("Option --all is not supported with %s\n"),
1606 if (!proto->getsizes && NUM_SPECIFIED(ctl->limit))
1609 GT_("Option --limit is not supported with %s\n"),
1615 * If no expunge limit or we do expunges within the driver,
1616 * then just do one session, passing in any fetchlimit.
1618 if ((ctl->keep && !ctl->flush) ||
1619 proto->retry || !NUM_SPECIFIED(ctl->expunge))
1620 return(do_session(ctl, proto, NUM_VALUE_OUT(ctl->fetchlimit)));
1622 * There's an expunge limit, and it isn't handled in the driver itself.
1623 * OK; do multiple sessions, each fetching a limited # of messages.
1624 * Stop if the total count of retrieved messages exceeds ctl->fetchlimit
1625 * (if it was nonzero).
1631 int expunge = NUM_VALUE_OUT(ctl->expunge);
1632 int fetchlimit = NUM_VALUE_OUT(ctl->fetchlimit);
1635 if (fetchlimit > 0 && (expunge == 0 || expunge > fetchlimit - totalcount))
1636 expunge = fetchlimit - totalcount;
1637 err = do_session(ctl, proto, expunge);
1638 totalcount += expunge;
1639 if (NUM_SPECIFIED(ctl->fetchlimit) && totalcount >= fetchlimit)
1641 if (err != PS_LOCKBUSY)
1643 else if (lockouts >= MAX_LOCKOUTS)
1645 else /* err == PS_LOCKBUSY */
1648 * Allow time for the server lock to release. if we
1649 * don't do this, we'll often hit a locked-mailbox
1650 * condition and fail.
1656 (err == PS_MAXFETCH || err == PS_LOCKBUSY);
1663 /* driver.c ends here */