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))
338 GT_("Subject: Fetchmail oversized-messages warning"), nl_langinfo(CODESET)));
339 stuff_warning(ctl, "");
341 GT_("The following oversized messages remain on the mail server %s:"),
342 ctl->server.pollname);
344 stuff_warning(ctl, "");
346 if (run.poll_interval == 0)
347 max_warning_poll_count = 0;
349 max_warning_poll_count = ctl->warnings/run.poll_interval;
351 /* parse list of skipped msg, adding items to the mail */
352 for (current = head; current; current = current->next)
354 if (current->val.status.num == 0 && current->val.status.mark)
356 nbr = current->val.status.mark;
357 size = atoi(current->id);
359 GT_(" %d msg %d octets long skipped by fetchmail."),
362 current->val.status.num++;
363 current->val.status.mark = 0;
365 if (current->val.status.num >= max_warning_poll_count)
366 current->val.status.num = 0;
369 stuff_warning(ctl, "");
371 close_warning_by_mail(ctl, (struct msgblk *)NULL);
374 static void mark_oversized(struct query *ctl, int num, int size)
375 /* mark a message oversized */
377 struct idlist *current=NULL, *tmp=NULL;
381 /* convert size to string */
383 snprintf(sizestr, sizeof(sizestr),
386 #endif /* HAVE_SNPRINTF */
389 /* build a list of skipped messages
390 * val.id = size of msg (string cnvt)
391 * val.status.num = warning_poll_count
392 * val.status.mask = nbr of msg this size
395 current = ctl->skipped;
397 /* initialise warning_poll_count to the
398 * current value so that all new msg will
399 * be included in the next mail
401 cnt = current ? current->val.status.num : 0;
403 /* if entry exists, increment the count */
404 if (current && str_in_list(¤t, sizestr, FALSE))
406 for ( ; current; current = current->next)
408 if (strcmp(current->id, sizestr) == 0)
410 current->val.status.mark++;
415 /* otherwise, create a new entry */
416 /* initialise with current poll count */
419 tmp = save_str(&ctl->skipped, sizestr, 1);
420 tmp->val.status.num = cnt;
424 static int fetch_messages(int mailserver_socket, struct query *ctl,
425 int count, int *msgsizes, int maxfetch,
426 int *fetches, int *dispatches, int *deletions)
427 /* fetch messages in lockstep mode */
429 flag force_retrieval;
430 int num, firstnum = 1, lastnum = 0, err, len;
431 int fetchsizelimit = ctl->fetchsizelimit;
434 if (ctl->server.base_protocol->getpartialsizes && NUM_NONZERO(fetchsizelimit))
436 /* for POP3, we can get the size of one mail only! Unfortunately, this
437 * protocol specific test cannot be done elsewhere as the protocol
438 * could be "auto". */
439 switch (ctl->server.protocol)
441 case P_POP3: case P_APOP: case P_RPOP:
445 /* Time to allocate memory to store the sizes */
446 xalloca(msgsizes, int *, 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);
537 msgsize = msgsizes ? msgsizes[num-firstnum] : 0;
539 /* check if the message is oversized */
540 if (NUM_NONZERO(ctl->limit) && (msgsize > ctl->limit))
541 msgcode = MSGLEN_TOOLARGE;
542 /* else if (msgsize == 512)
543 msgcode = MSGLEN_OLD; (hmh) sample code to skip message */
547 if ((msgcode == MSGLEN_TOOLARGE) && !check_only)
549 mark_oversized(ctl, num, msgsize);
550 suppress_delete = TRUE;
552 if (outlevel > O_SILENT)
554 /* old messages are already handled above */
556 GT_("skipping message %s@%s:%d (%d octets)"),
557 ctl->remotename, ctl->server.truename, num,
563 * Invalid lengths are produced by Post Office/NT's
564 * annoying habit of randomly prepending bogus
565 * LIST items of length -1. Patrick Audley
566 * <paudley@pobox.com> tells us: LIST shows a
567 * size of -1, RETR and TOP return "-ERR
568 * System error - couldn't open message", and
569 * DELE succeeds but doesn't actually delete
572 report_build(stdout, GT_(" (length -1)"));
574 case MSGLEN_TOOLARGE:
575 report_build(stdout, GT_(" (oversized)"));
582 flag wholesize = !ctl->server.base_protocol->fetch_body;
583 flag separatefetchbody = (ctl->server.base_protocol->fetch_body) ? TRUE : FALSE;
585 /* request a message */
586 err = (ctl->server.base_protocol->fetch_headers)(mailserver_socket,ctl,num, &len);
587 if (err == PS_TRANSIENT) /* server is probably Exchange */
590 GT_("couldn't fetch headers, message %s@%s:%d (%d octets)\n"),
591 ctl->remotename, ctl->server.truename, num,
598 /* -1 means we didn't see a size in the response */
605 if (outlevel > O_SILENT)
607 report_build(stdout, GT_("reading message %s@%s:%d of %d"),
608 ctl->remotename, ctl->server.truename,
611 /* XXX FIXME: the gettext stuff needs to list "octets" or
612 * "header octets" as a unit, and also provide for
613 * proper plural form */
615 report_build(stdout, GT_(" (%d %soctets)"),
616 len, wholesize ? "" : GT_("header "));
617 if (outlevel >= O_VERBOSE)
618 report_complete(stdout, "\n");
620 report_complete(stdout, " ");
624 * Read the message headers and ship them to the
627 err = readheaders(mailserver_socket, len, msgsize,
629 /* pass the suppress_readbody flag only if the underlying
630 * protocol does not fetch the body separately */
631 separatefetchbody ? 0 : &suppress_readbody);
632 if (err == PS_RETAINED)
633 suppress_forward = suppress_delete = retained = TRUE;
634 else if (err == PS_TRANSIENT)
635 suppress_delete = suppress_forward = TRUE;
636 else if (err == PS_REFUSED)
637 suppress_forward = TRUE;
638 else if (err == PS_TRUNCATED)
639 suppress_readbody = TRUE;
643 /* tell server we got it OK and resynchronize */
644 if (separatefetchbody && ctl->server.base_protocol->trail)
646 if (outlevel >= O_VERBOSE && !isafile(1))
652 if ((err = (ctl->server.base_protocol->trail)(mailserver_socket, ctl, num)))
656 /* do not read the body which is not being forwarded only if
657 * the underlying protocol allows the body to be fetched
659 if (separatefetchbody && suppress_forward)
660 suppress_readbody = TRUE;
663 * If we're using IMAP4 or something else that
664 * can fetch headers separately from bodies,
665 * it's time to request the body now. This
666 * fetch may be skipped if we got an anti-spam
667 * or other PS_REFUSED error response during
670 if (!suppress_readbody)
672 if (separatefetchbody)
675 if ((err=(ctl->server.base_protocol->fetch_body)(mailserver_socket,ctl,num,&len)))
678 * Work around a bug in Novell's
679 * broken GroupWise IMAP server;
680 * its body FETCH response is missing
681 * the required length for the data
682 * string. This violates RFC2060.
685 len = msgsize - msgblk.msglen;
686 if (outlevel > O_SILENT && !wholesize)
687 report_complete(stdout,
688 GT_(" (%d body octets) "), len);
691 /* process the body now */
692 err = readbody(mailserver_socket,
696 if (err == PS_TRANSIENT)
697 suppress_delete = suppress_forward = TRUE;
701 /* tell server we got it OK and resynchronize */
702 if (ctl->server.base_protocol->trail)
704 if (outlevel >= O_VERBOSE && !isafile(1))
710 err = (ctl->server.base_protocol->trail)(mailserver_socket, ctl, num);
716 /* count # messages forwarded on this pass */
717 if (!suppress_forward)
721 * Check to see if the numbers matched?
723 * Yes, some servers foo this up horribly.
724 * All IMAP servers seem to get it right, and
725 * so does Eudora QPOP at least in 2.xx
728 * Microsoft Exchange gets it completely
729 * wrong, reporting compressed rather than
730 * actual sizes (so the actual length of
731 * message is longer than the reported size).
732 * Another fine example of Microsoft brain death!
734 * Some older POP servers, like the old UCB
735 * POP server and the pre-QPOP QUALCOMM
736 * versions, report a longer size in the LIST
737 * response than actually gets shipped up.
738 * It's unclear what is going on here, as the
739 * QUALCOMM server (at least) seems to be
740 * reporting the on-disk size correctly.
742 if (msgblk.msglen != msgsize)
744 if (outlevel >= O_DEBUG)
746 GT_("message %s@%s:%d was not the expected length (%d actual != %d expected)\n"),
747 ctl->remotename, ctl->server.truename, num,
748 msgblk.msglen, msgsize);
751 /* end-of-message processing starts here */
752 if (!close_sink(ctl, &msgblk, !suppress_forward))
755 suppress_delete = TRUE;
763 * At this point in flow of control, either
764 * we've bombed on a protocol error or had
765 * delivery refused by the SMTP server
766 * (unlikely -- I've never seen it) or we've
767 * seen `accepted for delivery' and the
768 * message is shipped. It's safe to mark the
769 * message seen and delete it on the server
773 /* maybe we delete this message now? */
776 if (outlevel > O_SILENT)
777 report(stdout, GT_(" retained\n"));
779 else if (ctl->server.base_protocol->delete
781 && ((msgcode >= 0 && !ctl->keep)
782 || (msgcode == MSGLEN_OLD && ctl->flush)))
785 if (outlevel > O_SILENT)
786 report_complete(stdout, GT_(" flushed\n"));
787 err = (ctl->server.base_protocol->delete)(mailserver_socket, ctl, num);
793 if ( (outlevel >= O_VERBOSE) ||
794 /* To avoid flooding the syslog when using --keep,
795 * report "Skipped message" only when:
796 * 1) --verbose is on, or
797 * 2) fetchmail does not use syslog, or
798 * 3) the message was skipped for some other
799 * reason than just being old.
801 (outlevel > O_SILENT && (!run.use_syslog || msgcode != MSGLEN_OLD))
803 report_complete(stdout, GT_(" not flushed\n"));
805 /* maybe we mark this message as seen now? */
806 if (ctl->server.base_protocol->mark_seen
808 && (msgcode >= 0 && ctl->keep))
810 err = (ctl->server.base_protocol->mark_seen)(mailserver_socket, ctl, num);
816 /* perhaps this as many as we're ready to handle */
817 if (maxfetch && maxfetch <= *fetches && num < count)
819 report(stdout, GT_("fetchlimit %d reached; %d messages left on server %s account %s\n"),
820 maxfetch, count - *fetches, ctl->server.truename, ctl->remotename);
828 /* retrieve messages from server using given protocol method table */
829 static int do_session(
830 /* parsed options with merged-in defaults */
832 /* protocol method table */
833 const struct method *proto,
834 /* maximum number of messages to fetch */
837 static int *msgsizes;
838 volatile int err, mailserver_socket = -1; /* pacifies -Wall */
839 int deletions = 0, js;
841 SIGHANDLERTYPE pipesave;
842 SIGHANDLERTYPE alrmsave;
844 ctl->server.base_protocol = proto;
849 init_transact(proto);
851 /* set up the server-nonresponse timeout */
852 alrmsave = set_signal_handler(SIGALRM, timeout_handler);
853 mytimeout = ctl->server.timeout;
855 /* set up the broken-pipe timeout */
856 pipesave = set_signal_handler(SIGPIPE, sigpipe_handler);
858 if ((js = setjmp(restart)))
860 #ifdef HAVE_SIGPROCMASK
862 * Don't rely on setjmp() to restore the blocked-signal mask.
863 * It does this under BSD but is required not to under POSIX.
865 * If your Unix doesn't have sigprocmask, better hope it has
866 * BSD-like behavior. Otherwise you may see fetchmail get
867 * permanently wedged after a second timeout on a bad read,
868 * because alarm signals were blocked after the first.
872 sigfillset(&allsigs);
873 sigprocmask(SIG_UNBLOCK, &allsigs, NULL);
874 #endif /* HAVE_SIGPROCMASK */
876 if (js == THROW_SIGPIPE)
878 set_signal_handler(SIGPIPE, SIG_IGN);
880 GT_("SIGPIPE thrown from an MDA or a stream socket error\n"));
883 else if (js == THROW_TIMEOUT)
885 if (phase == OPEN_WAIT)
887 GT_("timeout after %d seconds waiting to connect to server %s.\n"),
888 ctl->server.timeout, ctl->server.pollname);
889 else if (phase == SERVER_WAIT)
891 GT_("timeout after %d seconds waiting for server %s.\n"),
892 ctl->server.timeout, ctl->server.pollname);
893 else if (phase == FORWARDING_WAIT)
895 GT_("timeout after %d seconds waiting for %s.\n"),
897 ctl->mda ? "MDA" : "SMTP");
898 else if (phase == LISTENER_WAIT)
900 GT_("timeout after %d seconds waiting for listener to respond.\n"), ctl->server.timeout);
903 GT_("timeout after %d seconds.\n"), ctl->server.timeout);
906 * If we've exceeded our threshold for consecutive timeouts,
907 * try to notify the user, then mark the connection wedged.
908 * Don't do this if the connection can idle, though; idle
909 * timeouts just mean the frequency of mail is low.
911 if (timeoutcount > MAX_TIMEOUTS
912 && !open_warning_by_mail(ctl, (struct msgblk *)NULL))
915 rfc2047e(GT_("Subject: fetchmail sees repeated timeouts"),nl_langinfo(CODESET)));
916 stuff_warning(ctl, "");
918 GT_("Fetchmail saw more than %d timeouts while attempting to get mail from %s@%s.\n"),
921 ctl->server.truename);
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 char buf[MSGBUFSIZE+1], *realhost;
939 int count, new, bytes;
941 int fetches, dispatches, oldphase;
942 #else /* INET6_ENABLE */
943 int port, fetches, dispatches, oldphase;
944 #endif /* INET6_ENABLE */
947 /* execute pre-initialization command, if any */
948 if (ctl->preconnect && (err = system(ctl->preconnect)))
951 GT_("pre-connection command failed with status %d\n"), err);
956 /* open a socket to the mail server */
959 set_timeout(mytimeout);
962 port = ctl->server.port ? ctl->server.port : ( ctl->use_ssl ? ctl->server.base_protocol->sslport : ctl->server.base_protocol->port );
964 port = ctl->server.port ? ctl->server.port : ctl->server.base_protocol->port;
966 #endif /* !INET6_ENABLE */
968 #ifdef HAVE_PKG_hesiod
969 /* If either the pollname or vianame are "hesiod" we want to
970 lookup the user's hesiod pobox host */
971 if (!strcasecmp(ctl->server.queryname, "hesiod")) {
972 struct hes_postoffice *hes_p;
973 hes_p = hes_getmailhost(ctl->remotename);
974 if (hes_p != NULL && strcmp(hes_p->po_type, "POP") == 0) {
975 free(ctl->server.queryname);
976 ctl->server.queryname = xstrdup(hes_p->po_host);
978 free(ctl->server.via);
979 ctl->server.via = xstrdup(hes_p->po_host);
982 GT_("couldn't find HESIOD pobox for %s\n"),
988 #ifdef HAVE_GETHOSTBYNAME
990 * Canonicalize the server truename for later use. This also
991 * functions as a probe for whether the mailserver is accessible.
992 * We try it on each poll cycle until we get a result. This way,
993 * fetchmail won't fail if started up when the network is inaccessible.
995 if (ctl->server.dns && !ctl->server.trueaddr)
997 if (ctl->server.lead_server)
999 char *leadname = ctl->server.lead_server->truename;
1001 /* prevent core dump from ill-formed or duplicate entry */
1004 report(stderr, GT_("Lead server has no name.\n"));
1011 ctl->server.truename = xstrdup(leadname);
1015 struct hostent *namerec;
1018 * Get the host's IP, so we can report it like this:
1020 * Received: from hostname [10.0.0.1]
1023 namerec = gethostbyname(ctl->server.queryname);
1024 if (namerec == (struct hostent *)NULL)
1027 GT_("couldn't find canonical DNS name of %s (%s)\n"),
1028 ctl->server.pollname, ctl->server.queryname);
1036 ctl->server.truename=xstrdup((char *)namerec->h_name);
1037 ctl->server.trueaddr=xmalloc(namerec->h_length);
1038 memcpy(ctl->server.trueaddr,
1039 namerec->h_addr_list[0],
1044 #endif /* HAVE_GETHOSTBYNAME */
1046 realhost = ctl->server.via ? ctl->server.via : ctl->server.pollname;
1048 /* allow time for the port to be set up if we have a plugin */
1049 if (ctl->server.plugin)
1052 if ((mailserver_socket = SockOpen(realhost,
1053 ctl->server.service ? ctl->server.service : ( ctl->use_ssl ? ctl->server.base_protocol->sslservice : ctl->server.base_protocol->service ),
1054 ctl->server.netsec, ctl->server.plugin)) == -1)
1055 #else /* INET6_ENABLE */
1056 if ((mailserver_socket = SockOpen(realhost, port, NULL, ctl->server.plugin)) == -1)
1057 #endif /* INET6_ENABLE */
1059 char errbuf[BUFSIZ];
1060 #ifndef INET6_ENABLE
1062 #ifdef HAVE_RES_SEARCH
1063 if (err_no != 0 && h_errno != 0)
1064 report(stderr, GT_("internal inconsistency\n"));
1067 * Avoid generating a bogus error every poll cycle when we're
1068 * in daemon mode but the connection to the outside world
1071 if (!((err_no == EHOSTUNREACH || err_no == ENETUNREACH)
1072 && run.poll_interval))
1074 report_build(stderr, GT_("%s connection to %s failed"),
1075 ctl->server.base_protocol->name, ctl->server.pollname);
1076 #ifdef HAVE_RES_SEARCH
1079 if (h_errno == HOST_NOT_FOUND)
1080 strcpy(errbuf, GT_("host is unknown."));
1082 else if (h_errno == NO_ADDRESS)
1083 strcpy(errbuf, GT_("name is valid but has no IP address."));
1085 else if (h_errno == NO_RECOVERY)
1086 strcpy(errbuf, GT_("unrecoverable name server error."));
1087 else if (h_errno == TRY_AGAIN)
1088 strcpy(errbuf, GT_("temporary name server error."));
1090 #ifdef HAVE_SNPRINTF
1091 snprintf(errbuf, sizeof(errbuf),
1094 #endif /* HAVE_SNPRINTF */
1095 GT_("unknown DNS error %d."), h_errno);
1098 #endif /* HAVE_RES_SEARCH */
1099 strcpy(errbuf, strerror(err_no));
1100 report_complete(stderr, ": %s\n", errbuf);
1104 * Don't use this. It was an attempt to address Debian bug
1105 * #47143 (Notify user by mail when pop server nonexistent).
1106 * Trouble is, that doesn't work; you trip over the case
1107 * where your SLIP or PPP link is down...
1109 /* warn the system administrator */
1110 if (open_warning_by_mail(ctl, (struct msgblk *)NULL) == 0)
1113 rfc2047e(GT_("Subject: Fetchmail unreachable-server warning."), nl_langinfo(CODESET)));
1114 stuff_warning(ctl, "");
1115 stuff_warning(ctl, GT_("Fetchmail could not reach the mail server %s:"),
1116 ctl->server.pollname);
1117 stuff_warning(ctl, errbuf, ctl->server.pollname);
1118 close_warning_by_mail(ctl, (struct msgblk *)NULL);
1122 #endif /* INET6_ENABLE */
1130 /* Save the socket opened. Useful if Fetchmail hangs on SSLOpen
1131 * because the socket can be closed.
1133 mailserver_socket_temp = mailserver_socket;
1134 set_timeout(mytimeout);
1136 /* perform initial SSL handshake on open connection */
1137 /* Note: We pass the realhost name over for certificate
1138 verification. We may want to make this configurable */
1139 if (ctl->use_ssl && SSLOpen(mailserver_socket,ctl->sslcert,ctl->sslkey,ctl->sslproto,ctl->sslcertck,
1140 ctl->sslcertpath,ctl->sslfingerprint,realhost,ctl->server.pollname) == -1)
1142 report(stderr, GT_("SSL connection failed.\n"));
1147 /* Fetchmail didn't hang on SSLOpen,
1148 * then no need to set mailserver_socket_temp
1150 mailserver_socket_temp = -1;
1153 /* A timeout is still defined before SSLOpen,
1154 * then Fetchmail hanging on SSLOpen is handled.
1159 if (ctl->server.authenticate == A_KERBEROS_V4 && (strcasecmp(proto->name,"IMAP") != 0))
1161 set_timeout(mytimeout);
1162 err = kerberos_auth(mailserver_socket, ctl->server.truename,
1163 ctl->server.principal);
1168 #endif /* KERBEROS_V4 */
1171 if (ctl->server.authenticate == A_KERBEROS_V5)
1173 set_timeout(mytimeout);
1174 err = kerberos5_auth(mailserver_socket, ctl->server.truename);
1179 #endif /* KERBEROS_V5 */
1181 /* accept greeting message from mail server */
1182 err = (ctl->server.base_protocol->parse_response)(mailserver_socket, buf);
1186 /* try to get authorized to fetch mail */
1187 stage = STAGE_GETAUTH;
1188 if (ctl->server.base_protocol->getauth)
1190 err = (ctl->server.base_protocol->getauth)(mailserver_socket, ctl, buf);
1194 if (err == PS_LOCKBUSY)
1195 report(stderr, GT_("Lock-busy error on %s@%s\n"),
1197 ctl->server.truename);
1198 else if (err == PS_SERVBUSY)
1199 report(stderr, GT_("Server busy error on %s@%s\n"),
1201 ctl->server.truename);
1202 else if (err == PS_AUTHFAIL)
1204 report(stderr, GT_("Authorization failure on %s@%s%s\n"),
1206 ctl->server.truename,
1207 (ctl->wehaveauthed ? GT_(" (previously authorized)") : "")
1211 * If we're running in background, try to mail the
1212 * calling user a heads-up about the authentication
1213 * failure once it looks like this isn't a fluke
1214 * due to the server being temporarily inaccessible.
1215 * When we get third succesive failure, we notify the user
1216 * but only if we haven't already managed to get
1217 * authorization. After that, once we get authorization
1218 * we let the user know service is restored.
1220 if (run.poll_interval
1221 && !ctl->wehavesentauthnote
1222 && ((ctl->wehaveauthed && ++ctl->authfailcount >= 10)
1223 || (!ctl->wehaveauthed && ++ctl->authfailcount >= 3))
1224 && !open_warning_by_mail(ctl, (struct msgblk *)NULL))
1226 ctl->wehavesentauthnote = 1;
1228 rfc2047e(GT_("Subject: fetchmail authentication failed on %s@%s"), nl_langinfo(CODESET)),
1229 ctl->remotename, ctl->server.truename);
1230 stuff_warning(ctl, "");
1232 GT_("Fetchmail could not get mail from %s@%s.\n"),
1234 ctl->server.truename);
1235 if (ctl->wehaveauthed)
1236 stuff_warning(ctl, GT_("\
1237 The attempt to get authorization failed.\n\
1238 Since we have already succeeded in getting authorization for this\n\
1239 connection, this is probably another failure mode (such as busy server)\n\
1240 that fetchmail cannot distinguish because the server didn't send a useful\n\
1243 However, if you HAVE changed your account details since starting the\n\
1244 fetchmail daemon, you need to stop the daemon, change your configuration\n\
1245 of fetchmail, and then restart the daemon.\n\
1247 The fetchmail daemon will continue running and attempt to connect\n\
1248 at each cycle. No future notifications will be sent until service\n\
1251 stuff_warning(ctl, GT_("\
1252 The attempt to get authorization failed.\n\
1253 This probably means your password is invalid, but some servers have\n\
1254 other failure modes that fetchmail cannot distinguish from this\n\
1255 because they don't send useful error messages on login failure.\n\
1257 The fetchmail daemon will continue running and attempt to connect\n\
1258 at each cycle. No future notifications will be sent until service\n\
1260 close_warning_by_mail(ctl, (struct msgblk *)NULL);
1263 else if (err == PS_REPOLL)
1265 if (outlevel >= O_VERBOSE)
1266 report(stderr, GT_("Repoll immediately on %s@%s\n"),
1268 ctl->server.truename);
1271 report(stderr, GT_("Unknown login or authentication error on %s@%s\n"),
1273 ctl->server.truename);
1280 * This connection has given us authorization at least once.
1282 * There are dodgy server (clubinternet.fr for example) that
1283 * give spurious authorization failures on patently good
1284 * account/password details, then 5 minutes later let you in!
1286 * This is meant to build in some tolerance of such nasty bits
1289 ctl->wehaveauthed = 1;
1290 /*if (ctl->authfailcount >= 3)*/
1291 if (ctl->wehavesentauthnote)
1293 ctl->wehavesentauthnote = 0;
1295 GT_("Authorization OK on %s@%s\n"),
1297 ctl->server.truename);
1298 if (!open_warning_by_mail(ctl, (struct msgblk *)NULL))
1301 rfc2047e(GT_("Subject: fetchmail authentication OK on %s@%s"), nl_langinfo(CODESET)),
1302 ctl->remotename, ctl->server.truename);
1303 stuff_warning(ctl, "");
1305 GT_("Fetchmail was able to log into %s@%s.\n"),
1307 ctl->server.truename);
1309 GT_("Service has been restored.\n"));
1310 close_warning_by_mail(ctl, (struct msgblk *)NULL);
1315 * Reporting only after the first three
1316 * consecutive failures, or ten consecutive
1317 * failures after we have managed to get
1320 ctl->authfailcount = 0;
1324 ctl->errcount = fetches = 0;
1326 /* now iterate over each folder selected */
1327 for (idp = ctl->mailboxes; idp; idp = idp->next)
1334 /* reset timeout, in case we did an IDLE */
1335 mytimeout = ctl->server.timeout;
1337 if (outlevel >= O_DEBUG)
1340 report(stdout, GT_("selecting or re-polling folder %s\n"), idp->id);
1342 report(stdout, GT_("selecting or re-polling default folder\n"));
1345 /* compute # of messages and number of new messages waiting */
1346 stage = STAGE_GETRANGE;
1347 err = (ctl->server.base_protocol->getrange)(mailserver_socket, ctl, idp->id, &count, &new, &bytes);
1351 /* show user how many messages we downloaded */
1353 #ifdef HAVE_SNPRINTF
1354 (void) snprintf(buf, sizeof(buf),
1357 #endif /* HAVE_SNPRINTF */
1358 GT_("%s at %s (folder %s)"),
1359 ctl->remotename, ctl->server.pollname, idp->id);
1361 #ifdef HAVE_SNPRINTF
1362 (void) snprintf(buf, sizeof(buf),
1365 #endif /* HAVE_SNPRINTF */
1367 ctl->remotename, ctl->server.pollname);
1368 if (outlevel > O_SILENT)
1370 if (count == -1) /* only used for ETRN */
1371 report(stdout, GT_("Polling %s\n"), ctl->server.truename);
1372 else if (count != 0)
1374 if (new != -1 && (count - new) > 0)
1375 report_build(stdout, ngettext("%d message (%d %s) for %s", "%d messages (%d %s) for %s", (unsigned long)count),
1378 ngettext("seen", "seen", (unsigned long)count-new),
1381 report_build(stdout, ngettext("%d message for %s",
1382 "%d messages for %s",
1386 report_complete(stdout, ".\n");
1388 report_complete(stdout, GT_(" (%d octets).\n"), bytes);
1392 /* these are pointless in normal daemon mode */
1393 if (pass == 1 && (run.poll_interval == 0 || outlevel >= O_VERBOSE))
1394 report(stdout, GT_("No mail for %s\n"), buf);
1398 /* very important, this is where we leave the do loop */
1404 if (new == -1 || ctl->fetchall)
1406 fetches = new; /* set error status correctly */
1408 * There used to be a `goto noerror' here, but this
1409 * prevented checking of multiple folders. This
1410 * comment is a reminder in case I introduced some
1411 * subtle bug by removing it...
1419 * Don't trust the message count passed by the server.
1420 * Without this check, it might be possible to do a
1421 * DNS-spoofing attack that would pass back a ridiculous
1422 * count, and allocate a malloc area that would overlap
1423 * a portion of the stack.
1425 if (count > INT_MAX/sizeof(int))
1427 report(stderr, GT_("bogus message count!"));
1428 return(PS_PROTOCOL);
1432 * We need the size of each message before it's
1433 * loaded in order to pass it to the ESMTP SIZE
1434 * option. If the protocol has a getsizes method,
1435 * we presume this means it doesn't get reliable
1436 * sizes from message fetch responses.
1438 * If the protocol supports getting sizes of subset of
1439 * messages, we skip this step now.
1441 if (proto->getsizes &&
1442 !(proto->getpartialsizes && NUM_NONZERO(ctl->fetchsizelimit)))
1444 xalloca(msgsizes, int *, sizeof(int) * count);
1445 for (i = 0; i < count; i++)
1448 stage = STAGE_GETSIZES;
1449 err = (proto->getsizes)(mailserver_socket, count, msgsizes);
1456 for (i = 0; i < count; i++)
1457 bytes += msgsizes[i];
1461 /* read, forward, and delete messages */
1462 stage = STAGE_FETCH;
1464 /* fetch in lockstep mode */
1465 err = fetch_messages(mailserver_socket, ctl,
1468 &fetches, &dispatches, &deletions);
1472 if (!check_only && ctl->skipped
1473 && run.poll_interval > 0 && !nodetach)
1475 clean_skipped_list(&ctl->skipped);
1476 send_size_warnings(ctl);
1481 * Only re-poll if we either had some actual forwards and
1482 * either allowed deletions and had no errors.
1483 * Otherwise it is far too easy to get into infinite loops.
1485 (dispatches && ctl->server.base_protocol->retry && !ctl->keep && !ctl->errcount);
1489 /* ordinary termination with no errors -- officially log out */
1490 err = (ctl->server.base_protocol->logout_cmd)(mailserver_socket, ctl);
1492 * Hmmmm...arguably this would be incorrect if we had fetches but
1493 * no dispatches (due to oversized messages, etc.)
1496 err = (fetches > 0) ? PS_SUCCESS : PS_NOMAIL;
1497 cleanupSockClose(mailserver_socket);
1501 /* we only get here on error */
1502 if (err != 0 && err != PS_SOCKET && err != PS_REPOLL)
1504 stage = STAGE_LOGOUT;
1505 (ctl->server.base_protocol->logout_cmd)(mailserver_socket, ctl);
1508 /* try to clean up all streams */
1511 if (mailserver_socket != -1) {
1512 cleanupSockClose(mailserver_socket);
1513 mailserver_socket = -1;
1515 /* If there was a connect timeout, the socket should be closed.
1516 * mailserver_socket_temp contains the socket to close.
1518 if (mailserver_socket_temp != -1) {
1519 cleanupSockClose(mailserver_socket_temp);
1520 mailserver_socket_temp = -1;
1524 msg = (const char *)NULL; /* sacrifice to -Wall */
1528 msg = GT_("socket");
1531 msg = GT_("missing or bad RFC822 header");
1537 msg = GT_("client/server synchronization");
1540 msg = GT_("client/server protocol");
1543 msg = GT_("lock busy on server");
1546 msg = GT_("SMTP transaction");
1549 msg = GT_("DNS lookup");
1552 report(stderr, GT_("undefined error\n"));
1555 /* no report on PS_MAXFETCH or PS_UNDEFINED or PS_AUTHFAIL */
1556 if (err==PS_SOCKET || err==PS_SYNTAX
1557 || err==PS_IOERR || err==PS_ERROR || err==PS_PROTOCOL
1558 || err==PS_LOCKBUSY || err==PS_SMTP || err==PS_DNS)
1562 if (phase == FORWARDING_WAIT || phase == LISTENER_WAIT)
1563 stem = GT_("%s error while delivering to SMTP host %s\n");
1565 stem = GT_("%s error while fetching from %s\n");
1566 report(stderr, stem, msg, ctl->server.pollname);
1570 /* execute wrapup command, if any */
1571 if (ctl->postconnect && (err = system(ctl->postconnect)))
1573 report(stderr, GT_("post-connection command failed with status %d\n"), err);
1574 if (err == PS_SUCCESS)
1578 set_timeout(0); /* cancel any pending alarm */
1579 set_signal_handler(SIGALRM, alrmsave);
1580 set_signal_handler(SIGPIPE, pipesave);
1584 int do_protocol(ctl, proto)
1585 /* retrieve messages from server using given protocol method table */
1586 struct query *ctl; /* parsed options with merged-in defaults */
1587 const struct method *proto; /* protocol method table */
1592 if (ctl->server.authenticate == A_KERBEROS_V4)
1594 report(stderr, GT_("Kerberos V4 support not linked.\n"));
1597 #endif /* KERBEROS_V4 */
1600 if (ctl->server.authenticate == A_KERBEROS_V5)
1602 report(stderr, GT_("Kerberos V5 support not linked.\n"));
1605 #endif /* KERBEROS_V5 */
1607 /* lacking methods, there are some options that may fail */
1610 /* check for unsupported options */
1613 GT_("Option --flush is not supported with %s\n"),
1617 else if (ctl->fetchall) {
1619 GT_("Option --all is not supported with %s\n"),
1624 if (!proto->getsizes && NUM_SPECIFIED(ctl->limit))
1627 GT_("Option --limit is not supported with %s\n"),
1633 * If no expunge limit or we do expunges within the driver,
1634 * then just do one session, passing in any fetchlimit.
1636 if ((ctl->keep && !ctl->flush) ||
1637 proto->retry || !NUM_SPECIFIED(ctl->expunge))
1638 return(do_session(ctl, proto, NUM_VALUE_OUT(ctl->fetchlimit)));
1640 * There's an expunge limit, and it isn't handled in the driver itself.
1641 * OK; do multiple sessions, each fetching a limited # of messages.
1642 * Stop if the total count of retrieved messages exceeds ctl->fetchlimit
1643 * (if it was nonzero).
1649 int expunge = NUM_VALUE_OUT(ctl->expunge);
1650 int fetchlimit = NUM_VALUE_OUT(ctl->fetchlimit);
1653 if (fetchlimit > 0 && (expunge == 0 || expunge > fetchlimit - totalcount))
1654 expunge = fetchlimit - totalcount;
1655 err = do_session(ctl, proto, expunge);
1656 totalcount += expunge;
1657 if (NUM_SPECIFIED(ctl->fetchlimit) && totalcount >= fetchlimit)
1659 if (err != PS_LOCKBUSY)
1661 else if (lockouts >= MAX_LOCKOUTS)
1663 else /* err == PS_LOCKBUSY */
1666 * Allow time for the server lock to release. if we
1667 * don't do this, we'll often hit a locked-mailbox
1668 * condition and fail.
1674 (err == PS_MAXFETCH || err == PS_LOCKBUSY);
1681 /* driver.c ends here */