Pileus Git - ~andy/fetchmail/blob - pop3.c

   1 /*
   2  * pop3.c -- POP3 protocol methods
   3  *
   4  * Copyright 1998 by Eric S. Raymond.
   5  * For license terms, see the file COPYING in this directory.
   6  */
   7
   8 #include  "config.h"
   9 #ifdef POP3_ENABLE
  10 #include  <stdio.h>
  11 #include  <string.h>
  12 #include  <ctype.h>
  13 #if defined(HAVE_UNISTD_H)
  14 #include <unistd.h>
  15 #endif
  16 #if defined(STDC_HEADERS)
  17 #include  <stdlib.h>
  18 #endif
  19
  20 #include  "fetchmail.h"
  21 #include  "socket.h"
  22 #include  "i18n.h"
  23
  24 #if OPIE_ENABLE
  25 #include <opie.h>
  26 #endif /* OPIE_ENABLE */
  27
  28 #ifndef strstr          /* glibc-2.1 declares this as a macro */
  29 extern char *strstr();  /* needed on sysV68 R3V7.1. */
  30 #endif /* strstr */
  31
  32 static int last;
  33 #ifdef SDPS_ENABLE
  34 char *sdps_envfrom;
  35 char *sdps_envto;
  36 #endif /* SDPS_ENABLE */
  37
  38 #if OPIE_ENABLE
  39 static char lastok[POPBUFSIZE+1];
  40 #endif /* OPIE_ENABLE */
  41
  42 #define DOTLINE(s)      (s[0] == '.' && (s[1]=='\r'||s[1]=='\n'||s[1]=='\0'))
  43
  44 static int pop3_ok (int sock, char *argbuf)
  45 /* parse command response */
  46 {
  47     int ok;
  48     char buf [POPBUFSIZE+1];
  49     char *bufp;
  50
  51     if ((ok = gen_recv(sock, buf, sizeof(buf))) == 0)
  52     {   bufp = buf;
  53         if (*bufp == '+' || *bufp == '-')
  54             bufp++;
  55         else
  56             return(PS_PROTOCOL);
  57
  58         while (isalpha(*bufp))
  59             bufp++;
  60
  61         if (*bufp)
  62           *(bufp++) = '\0';
  63
  64         if (strcmp(buf,"+OK") == 0)
  65         {
  66 #if OPIE_ENABLE
  67             strcpy(lastok, bufp);
  68 #endif /* OPIE_ENABLE */
  69             ok = 0;
  70         }
  71         else if (strncmp(buf,"-ERR", 4) == 0)
  72         {
  73             if (stage == STAGE_FETCH)
  74                 ok = PS_TRANSIENT;
  75             else if (stage > STAGE_GETAUTH)
  76                 ok = PS_PROTOCOL;
  77             /*
  78              * We're checking for "lock busy", "unable to lock",
  79              * "already locked", "wait a few minutes" etc. here.
  80              * This indicates that we have to wait for the server to
  81              * unwedge itself before we can poll again.
  82              *
  83              * PS_LOCKBUSY check empirically verified with two recent
  84              * versions of the Berkeley popper; QPOP (version 2.2)  and
  85              * QUALCOMM Pop server derived from UCB (version 2.1.4-R3)
  86              * These are caught by the case-indifferent "lock" check.
  87              * The "wait" catches "mail storage services unavailable,
  88              * wait a few minutes and try again" on the InterMail server.
  89              *
  90              * If these aren't picked up on correctly, fetchmail will
  91              * think there is an authentication failure and wedge the
  92              * connection in order to prevent futile polls.
  93              *
  94              * Gad, what a kluge.
  95              */
  96             else if (strstr(bufp,"lock")
  97                      || strstr(bufp,"Lock")
  98                      || strstr(bufp,"LOCK")
  99                      || strstr(bufp,"wait")
 100                      /* these are blessed by RFC 2449 */
 101                      || strstr(bufp,"[IN-USE]")||strstr(bufp,"[LOGIN-DELAY]"))
 102                 ok = PS_LOCKBUSY;
 103             else if ((strstr(bufp,"Service")
 104                      || strstr(bufp,"service"))
 105                          && (strstr(bufp,"unavailable")))
 106                 ok = PS_SERVBUSY;
 107             else
 108                 ok = PS_AUTHFAIL;
 109             /*
 110              * We always want to pass the user lock-busy messages, because
 111              * they're red flags.  Other stuff (like AUTH failures on non-
 112              * RFC1734 servers) only if we're debugging.
 113              */
 114             if (*bufp && (ok == PS_LOCKBUSY || outlevel >= O_MONITOR))
 115               report(stderr, "%s\n", bufp);
 116         }
 117         else
 118             ok = PS_PROTOCOL;
 119
 120         if (argbuf != NULL)
 121             strcpy(argbuf,bufp);
 122     }
 123
 124     return(ok);
 125 }
 126
 127 static int pop3_getauth(int sock, struct query *ctl, char *greeting)
 128 /* apply for connection authorization */
 129 {
 130     int ok;
 131     char *start,*end;
 132     char *msg;
 133 #if OPIE_ENABLE
 134     char *challenge;
 135 #endif /* OPIE_ENABLE */
 136 #if defined(GSSAPI)
 137     flag has_gssapi = FALSE;
 138 #endif /* defined(GSSAPI) */
 139 #if defined(KERBEROS_V4) || defined(KERBEROS_V5)
 140     flag has_kerberos = FALSE;
 141 #endif /* defined(KERBEROS_V4) || defined(KERBEROS_V5) */
 142     flag has_cram = FALSE;
 143 #ifdef OPIE_ENABLE
 144     flag has_otp = FALSE;
 145 #endif /* OPIE_ENABLE */
 146 #ifdef SSL_ENABLE
 147     flag has_ssl = FALSE;
 148 #endif /* SSL_ENABLE */
 149
 150 #ifdef SDPS_ENABLE
 151     /*
 152      * This needs to catch both demon.co.uk and demon.net.
 153      * If we see either, and we're in multidrop mode, try to use
 154      * the SDPS *ENV extension.
 155      */
 156     if (!(ctl->server.sdps) && MULTIDROP(ctl) && strstr(greeting, "demon."))
 157         ctl->server.sdps = TRUE;
 158 #endif /* SDPS_ENABLE */
 159
 160     switch (ctl->server.protocol) {
 161     case P_POP3:
 162 #ifdef RPA_ENABLE
 163         /* CompuServe POP3 Servers as of 990730 want AUTH first for RPA */
 164         if (strstr(ctl->remotename, "@compuserve.com"))
 165         {
 166             /* AUTH command should return a list of available mechanisms */
 167             if (gen_transact(sock, "AUTH") == 0)
 168             {
 169                 char buffer[10];
 170                 flag has_rpa = FALSE;
 171
 172                 while ((ok = gen_recv(sock, buffer, sizeof(buffer))) == 0)
 173                 {
 174                     if (DOTLINE(buffer))
 175                         break;
 176                     if (strncasecmp(buffer, "rpa", 3) == 0)
 177                         has_rpa = TRUE;
 178                 }
 179                 if (has_rpa && !POP3_auth_rpa(ctl->remotename,
 180                                               ctl->password, sock))
 181                     return(PS_SUCCESS);
 182             }
 183
 184             return(PS_AUTHFAIL);
 185         }
 186 #endif /* RPA_ENABLE */
 187
 188         /*
 189          * CAPA command may return a list including available
 190          * authentication mechanisms.  if it doesn't, no harm done, we
 191          * just fall back to a plain login.  Note that this code
 192          * latches the server's authentication type, so that in daemon mode
 193          * the CAPA check only needs to be done once at start of run.
 194          *
 195          * If CAPA fails, then force the authentication method to PASSORD
 196          * and repoll immediately.
 197          *
 198          * These authentication methods are blessed by RFC1734,
 199          * describing the POP3 AUTHentication command.
 200          */
 201         if (ctl->server.authenticate == A_ANY)
 202         {
 203             ok = gen_transact(sock, "CAPA");
 204             if (ok == PS_SUCCESS)
 205             {
 206                 char buffer[64];
 207
 208                 /* determine what authentication methods we have available */
 209                 while ((ok = gen_recv(sock, buffer, sizeof(buffer))) == 0)
 210                 {
 211                     if (DOTLINE(buffer))
 212                         break;
 213 #ifdef SSL_ENABLE
 214                     if (strstr(buffer, "STLS"))
 215                         has_ssl = TRUE;
 216 #endif /* SSL_ENABLE */
 217 #if defined(GSSAPI)
 218                     if (strstr(buffer, "GSSAPI"))
 219                         has_gssapi = TRUE;
 220 #endif /* defined(GSSAPI) */
 221 #if defined(KERBEROS_V4)
 222                     if (strstr(buffer, "KERBEROS_V4"))
 223                         has_kerberos = TRUE;
 224 #endif /* defined(KERBEROS_V4)  */
 225 #ifdef OPIE_ENABLE
 226                     if (strstr(buffer, "X-OTP"))
 227                         has_otp = TRUE;
 228 #endif /* OPIE_ENABLE */
 229                     if (strstr(buffer, "CRAM-MD5"))
 230                         has_cram = TRUE;
 231                 }
 232             }
 233             /* we are in STAGE_GETAUTH! */
 234             else if (ok == PS_AUTHFAIL ||
 235                 /* Some servers directly close the socket. However, if we
 236                  * have already authenticated before, then a previous CAPA
 237                  * must have succeeded. In that case, treat this as a
 238                  * genuine socket error and do not change the auth method.
 239                  */
 240                 (ok == PS_SOCKET && !ctl->wehaveauthed))
 241             {
 242                 ctl->server.authenticate = A_PASSWORD;
 243                 /* repoll immediately */
 244                 ok = PS_REPOLL;
 245                 break;
 246             }
 247         }
 248
 249 #ifdef SSL_ENABLE
 250         if (has_ssl
 251             && !ctl->use_ssl
 252             && (ctl->server.authenticate == A_ANY))
 253         {
 254             char *realhost;
 255
 256            realhost = ctl->server.via ? ctl->server.via : ctl->server.pollname;
 257            gen_transact(sock, "STLS");
 258            if (SSLOpen(sock,ctl->sslcert,ctl->sslkey,ctl->sslproto,ctl->sslcertck, ctl->sslcertpath,ctl->sslfingerprint,realhost,ctl->server.pollname) == -1)
 259            {
 260                report(stderr,
 261                        GT_("SSL connection failed.\n"));
 262                 return(PS_AUTHFAIL);
 263             }
 264         }
 265 #endif /* SSL_ENABLE */
 266
 267         /*
 268          * OK, we have an authentication type now.
 269          */
 270 #if defined(KERBEROS_V4)
 271         /*
 272          * Servers doing KPOP have to go through a dummy login sequence
 273          * rather than doing SASL.
 274          */
 275         if (has_kerberos &&
 276 #if INET6_ENABLE
 277             ctl->server.service && (strcmp(ctl->server.service, KPOP_PORT)!=0)
 278 #else /* INET6_ENABLE */
 279             ctl->server.port != KPOP_PORT
 280 #endif /* INET6_ENABLE */
 281             && (ctl->server.authenticate == A_KERBEROS_V4
 282              || ctl->server.authenticate == A_KERBEROS_V5
 283              || ctl->server.authenticate == A_ANY))
 284         {
 285             ok = do_rfc1731(sock, "AUTH", ctl->server.truename);
 286             if (ok == PS_SUCCESS || ctl->server.authenticate != A_ANY)
 287                 break;
 288         }
 289 #endif /* defined(KERBEROS_V4) || defined(KERBEROS_V5) */
 290
 291 #if defined(GSSAPI)
 292         if (has_gssapi &&
 293             (ctl->server.authenticate == A_GSSAPI ||
 294              ctl->server.authenticate == A_ANY))
 295         {
 296             ok = do_gssauth(sock,"AUTH",ctl->server.truename,ctl->remotename);
 297             if (ok == PS_SUCCESS || ctl->server.authenticate != A_ANY)
 298                 break;
 299         }
 300 #endif /* defined(GSSAPI) */
 301
 302 #ifdef OPIE_ENABLE
 303         if (has_otp &&
 304             (ctl->server.authenticate == A_OTP ||
 305              ctl->server.authenticate == A_ANY))
 306         {
 307             ok = do_otp(sock, "AUTH", ctl);
 308             if (ok == PS_SUCCESS || ctl->server.authenticate != A_ANY)
 309                 break;
 310         }
 311 #endif /* OPIE_ENABLE */
 312
 313         if (has_cram &&
 314             (ctl->server.authenticate == A_CRAM_MD5 ||
 315              ctl->server.authenticate == A_ANY))
 316         {
 317             ok = do_cram_md5(sock, "AUTH", ctl, NULL);
 318             if (ok == PS_SUCCESS || ctl->server.authenticate != A_ANY)
 319                 break;
 320         }
 321
 322         /* ordinary validation, no one-time password or RPA */
 323         gen_transact(sock, "USER %s", ctl->remotename);
 324
 325 #if OPIE_ENABLE
 326         /* see RFC1938: A One-Time Password System */
 327         if (challenge = strstr(lastok, "otp-")) {
 328           char response[OPIE_RESPONSE_MAX+1];
 329           int i;
 330
 331           i = opiegenerator(challenge, !strcmp(ctl->password, "opie") ? "" : ctl->password, response);
 332           if ((i == -2) && !run.poll_interval) {
 333             char secret[OPIE_SECRET_MAX+1];
 334             fprintf(stderr, GT_("Secret pass phrase: "));
 335             if (opiereadpass(secret, sizeof(secret), 0))
 336               i = opiegenerator(challenge,  secret, response);
 337             memset(secret, 0, sizeof(secret));
 338           };
 339
 340           if (i) {
 341             ok = PS_ERROR;
 342             break;
 343           };
 344
 345           ok = gen_transact(sock, "PASS %s", response);
 346           break;
 347         }
 348 #endif /* OPIE_ENABLE */
 349
 350         strcpy(shroud, ctl->password);
 351         ok = gen_transact(sock, "PASS %s", ctl->password);
 352         shroud[0] = '\0';
 353         break;
 354
 355     case P_APOP:
 356         /* build MD5 digest from greeting timestamp + password */
 357         /* find start of timestamp */
 358         for (start = greeting;  *start != 0 && *start != '<';  start++)
 359             continue;
 360         if (*start == 0) {
 361             report(stderr,
 362                    GT_("Required APOP timestamp not found in greeting\n"));
 363             return(PS_AUTHFAIL);
 364         }
 365
 366         /* find end of timestamp */
 367         for (end = start;  *end != 0  && *end != '>';  end++)
 368             continue;
 369         if (*end == 0 || end == start + 1) {
 370             report(stderr,
 371                    GT_("Timestamp syntax error in greeting\n"));
 372             return(PS_AUTHFAIL);
 373         }
 374         else
 375             *++end = '\0';
 376
 377         /* copy timestamp and password into digestion buffer */
 378         xalloca(msg, char *, (end-start+1) + strlen(ctl->password) + 1);
 379         strcpy(msg,start);
 380         strcat(msg,ctl->password);
 381
 382         strcpy(ctl->digest, MD5Digest((unsigned char *)msg));
 383
 384         ok = gen_transact(sock, "APOP %s %s", ctl->remotename, ctl->digest);
 385         break;
 386
 387     case P_RPOP:
 388         if ((ok = gen_transact(sock,"USER %s", ctl->remotename)) == 0)
 389             ok = gen_transact(sock, "RPOP %s", ctl->password);
 390         break;
 391
 392     default:
 393         report(stderr, GT_("Undefined protocol request in POP3_auth\n"));
 394         ok = PS_ERROR;
 395     }
 396
 397     if (ok != 0)
 398     {
 399         /* maybe we detected a lock-busy condition? */
 400         if (ok == PS_LOCKBUSY)
 401             report(stderr, GT_("lock busy!  Is another session active?\n"));
 402
 403         return(ok);
 404     }
 405
 406     /*
 407      * Empirical experience shows some server/OS combinations
 408      * may need a brief pause even after any lockfiles on the
 409      * server are released, to give the server time to finish
 410      * copying back very large mailfolders from the temp-file...
 411      * this is only ever an issue with extremely large mailboxes.
 412      */
 413     sleep(3); /* to be _really_ safe, probably need sleep(5)! */
 414
 415     /* we're peek-capable if use of TOP is enabled */
 416     peek_capable = !(ctl->fetchall || ctl->keep);
 417
 418     /* we're approved */
 419     return(PS_SUCCESS);
 420 }
 421
 422 static int pop3_gettopid( int sock, int num , char *id)
 423 {
 424     int ok;
 425     int got_it;
 426     char buf [POPBUFSIZE+1];
 427     sprintf( buf, "TOP %d 1", num );
 428     if ((ok = gen_transact(sock, buf )) != 0)
 429        return ok;
 430     got_it = 0;
 431     while ((ok = gen_recv(sock, buf, sizeof(buf))) == 0)
 432     {
 433         if (DOTLINE(buf))
 434             break;
 435         if ( ! got_it && ! strncasecmp("Message-Id:", buf, 11 )) {
 436             got_it = 1;
 437             /* prevent stack overflows */
 438             buf[IDLEN+12] = 0;
 439             sscanf( buf+12, "%s", id);
 440         }
 441     }
 442     return 0;
 443 }
 444
 445 static int pop3_slowuidl( int sock,  struct query *ctl, int *countp, int *newp)
 446 {
 447     /* This approach tries to get the message headers from the
 448      * remote hosts and compares the message-id to the already known
 449      * ones:
 450      *  + if the first message containes a new id, all messages on
 451      *    the server will be new
 452      *  + if the first is known, try to estimate the last known message
 453      *    on the server and check. If this works you know the total number
 454      *    of messages to get.
 455      *  + Otherwise run a binary search to determine the last known message
 456      */
 457     int ok, nolinear = 0;
 458     int first_nr, list_len, try_id, try_nr, add_id;
 459     int num;
 460     char id [IDLEN+1];
 461
 462     if( (ok = pop3_gettopid( sock, 1, id )) != 0 )
 463         return ok;
 464
 465     if( ( first_nr = str_nr_in_list(&ctl->oldsaved, id) ) == -1 ) {
 466         /* the first message is unknown -> all messages are new */
 467         *newp = *countp;
 468         return 0;
 469     }
 470
 471     /* check where we expect the latest known message */
 472     list_len = count_list( &ctl->oldsaved );
 473     try_id = list_len  - first_nr; /* -1 + 1 */
 474     if( try_id > 1 ) {
 475         if( try_id <= *countp ) {
 476             if( (ok = pop3_gettopid( sock, try_id, id )) != 0 )
 477                 return ok;
 478
 479             try_nr = str_nr_last_in_list(&ctl->oldsaved, id);
 480         } else {
 481             try_id = *countp+1;
 482             try_nr = -1;
 483         }
 484         if( try_nr != list_len -1 ) {
 485             /* some messages inbetween have been deleted... */
 486             if( try_nr == -1 ) {
 487                 nolinear = 1;
 488
 489                 for( add_id = 1<<30; add_id > try_id-1; add_id >>= 1 )
 490                     ;
 491                 for( ; add_id; add_id >>= 1 ) {
 492                     if( try_nr == -1 ) {
 493                         if( try_id - add_id <= 1 ) {
 494                             continue;
 495                         }
 496                         try_id -= add_id;
 497                     } else
 498                         try_id += add_id;
 499
 500                     if( (ok = pop3_gettopid( sock, try_id, id )) != 0 )
 501                         return ok;
 502                     try_nr = str_nr_in_list(&ctl->oldsaved, id);
 503                 }
 504                 if( try_nr == -1 ) {
 505                     try_id--;
 506                 }
 507             } else {
 508                 report(stderr,
 509                        GT_("Messages inserted into list on server. Cannot handle this.\n"));
 510                 return -1;
 511             }
 512         }
 513     }
 514     /* the first try_id messages are known -> copy them to the newsaved list */
 515     for( num = first_nr; num < list_len; num++ )
 516     {
 517         struct idlist   *new = save_str(&ctl->newsaved,
 518                                 str_from_nr_list(&ctl->oldsaved, num),
 519                                 UID_UNSEEN);
 520         new->val.status.num = num - first_nr + 1;
 521     }
 522
 523     if( nolinear ) {
 524         free_str_list(&ctl->oldsaved);
 525         ctl->oldsaved = 0;
 526         last = try_id;
 527     }
 528
 529     *newp = *countp - try_id;
 530     return 0;
 531 }
 532
 533 static int pop3_getrange(int sock,
 534                          struct query *ctl,
 535                          const char *folder,
 536                          int *countp, int *newp, int *bytes)
 537 /* get range of messages to be fetched */
 538 {
 539     int ok;
 540     char buf [POPBUFSIZE+1];
 541
 542     /* Ensure that the new list is properly empty */
 543     ctl->newsaved = (struct idlist *)NULL;
 544
 545 #ifdef MBOX
 546     /* Alain Knaff suggests this, but it's not RFC standard */
 547     if (folder)
 548         if ((ok = gen_transact(sock, "MBOX %s", folder)))
 549             return ok;
 550 #endif /* MBOX */
 551
 552     /* get the total message count */
 553     gen_send(sock, "STAT");
 554     ok = pop3_ok(sock, buf);
 555     if (ok == 0)
 556         sscanf(buf,"%d %d", countp, bytes);
 557     else
 558         return(ok);
 559
 560     /*
 561      * Newer, RFC-1725-conformant POP servers may not have the LAST command.
 562      * We work as hard as possible to hide this ugliness, but it makes
 563      * counting new messages intrinsically quadratic in the worst case.
 564      */
 565     last = 0;
 566     *newp = -1;
 567     if (*countp > 0 && !ctl->fetchall)
 568     {
 569         char id [IDLEN+1];
 570
 571         if (!ctl->server.uidl) {
 572             gen_send(sock, "LAST");
 573             ok = pop3_ok(sock, buf);
 574         } else
 575             ok = 1;
 576         if (ok == 0)
 577         {
 578             if (sscanf(buf, "%d", &last) == 0)
 579             {
 580                 report(stderr, GT_("protocol error\n"));
 581                 return(PS_ERROR);
 582             }
 583             *newp = (*countp - last);
 584         }
 585         else
 586         {
 587             /* grab the mailbox's UID list */
 588             if ((ok = gen_transact(sock, "UIDL")) != 0)
 589             {
 590                 /* don't worry, yet! do it the slow way */
 591                 if((ok = pop3_slowuidl( sock, ctl, countp, newp))!=0)
 592                 {
 593                     report(stderr, GT_("protocol error while fetching UIDLs\n"));
 594                     return(PS_ERROR);
 595                 }
 596             }
 597             else
 598             {
 599                 int     num;
 600
 601                 *newp = 0;
 602                 while ((ok = gen_recv(sock, buf, sizeof(buf))) == 0)
 603                 {
 604                     if (DOTLINE(buf))
 605                         break;
 606                     else if (sscanf(buf, "%d %s", &num, id) == 2)
 607                     {
 608                         struct idlist   *new;
 609
 610                         new = save_str(&ctl->newsaved, id, UID_UNSEEN);
 611                         new->val.status.num = num;
 612
 613                         if (str_in_list(&ctl->oldsaved, id, FALSE)) {
 614                             new->val.status.mark = UID_SEEN;
 615                             str_set_mark(&ctl->oldsaved, id, UID_SEEN);
 616                         }
 617                         else
 618                             (*newp)++;
 619                     }
 620                 }
 621             }
 622         }
 623     }
 624
 625     return(PS_SUCCESS);
 626 }
 627
 628 static int pop3_getsizes(int sock, int count, int *sizes)
 629 /* capture the sizes of all messages */
 630 {
 631     int ok;
 632
 633     if ((ok = gen_transact(sock, "LIST")) != 0)
 634         return(ok);
 635     else
 636     {
 637         char buf [POPBUFSIZE+1];
 638
 639         while ((ok = gen_recv(sock, buf, sizeof(buf))) == 0)
 640         {
 641             unsigned int num, size;
 642
 643             if (DOTLINE(buf))
 644                 break;
 645             else if (sscanf(buf, "%u %u", &num, &size) == 2) {
 646                 if (num > 0 && num <= count)
 647                     sizes[num - 1] = size;
 648                 else
 649                     /* warn about possible attempt to induce buffer overrun */
 650                     report(stderr, "Warning: ignoring bogus data for message sizes returned by server.\n");
 651             }
 652         }
 653
 654         return(ok);
 655     }
 656 }
 657
 658 static int pop3_is_old(int sock, struct query *ctl, int num)
 659 /* is the given message old? */
 660 {
 661     if (!ctl->oldsaved)
 662         return (num <= last);
 663     else
 664         return (str_in_list(&ctl->oldsaved,
 665                             str_find(&ctl->newsaved, num), FALSE));
 666 }
 667
 668 #ifdef UNUSED
 669 /*
 670  * We could use this to fetch headers only as we do for IMAP.  The trouble
 671  * is that there's no way to fetch the body only.  So the following RETR
 672  * would have to re-fetch the header.  Enough messages have longer headers
 673  * than bodies to make this a net loss.
 674  */
 675 static int pop_fetch_headers(int sock, struct query *ctl,int number,int *lenp)
 676 /* request headers of nth message */
 677 {
 678     int ok;
 679     char buf[POPBUFSIZE+1];
 680
 681     gen_send(sock, "TOP %d 0", number);
 682     if ((ok = pop3_ok(sock, buf)) != 0)
 683         return(ok);
 684
 685     *lenp = -1;         /* we got sizes from the LIST response */
 686
 687     return(PS_SUCCESS);
 688 }
 689 #endif /* UNUSED */
 690
 691 static int pop3_fetch(int sock, struct query *ctl, int number, int *lenp)
 692 /* request nth message */
 693 {
 694     int ok;
 695     char buf[POPBUFSIZE+1];
 696
 697 #ifdef SDPS_ENABLE
 698     /*
 699      * See http://www.demon.net/services/mail/sdps-tech.html
 700      * for a description of what we're parsing here.
 701      */
 702     if (ctl->server.sdps)
 703     {
 704         int     linecount = 0;
 705
 706         sdps_envfrom = (char *)NULL;
 707         sdps_envto = (char *)NULL;
 708         gen_send(sock, "*ENV %d", number);
 709         do {
 710             if (gen_recv(sock, buf, sizeof(buf)))
 711             {
 712                 break;
 713             }
 714             linecount++;
 715             switch (linecount) {
 716             case 4:
 717                 /* No need to wrap envelope from address */
 718                 sdps_envfrom = xmalloc(strlen(buf)+1);
 719                 strcpy(sdps_envfrom,buf);
 720                 break;
 721             case 5:
 722                 /* Wrap address with To: <> so nxtaddr() likes it */
 723                 sdps_envto = xmalloc(strlen(buf)+7);
 724                 sprintf(sdps_envto,"To: <%s>",buf);
 725                 break;
 726             }
 727         } while
 728             (!(buf[0] == '.' && (buf[1] == '\r' || buf[1] == '\n' || buf[1] == '\0')));
 729     }
 730 #endif /* SDPS_ENABLE */
 731
 732     /*
 733      * Though the POP RFCs don't document this fact, on almost every
 734      * POP3 server I know of messages are marked "seen" only at the
 735      * time the OK response to a RETR is issued.
 736      *
 737      * This means we can use TOP to fetch the message without setting its
 738      * seen flag.  This is good!  It means that if the protocol exchange
 739      * craps out during the message, it will still be marked `unseen' on
 740      * the server.  (Exception: in early 1999 SpryNet's POP3 servers were
 741      * reported to mark messages seen on a TOP fetch.)
 742      *
 743      * However...*don't* do this if we're using keep to suppress deletion!
 744      * In that case, marking the seen flag is the only way to prevent the
 745      * message from being re-fetched on subsequent runs.
 746      *
 747      * Also use RETR if fetchall is on.  This gives us a workaround
 748      * for servers like usa.net's that bungle TOP.  It's pretty
 749      * harmless because fetchall guarantees that any message dropped
 750      * by an interrupted RETR will be picked up on the next poll of the
 751      * site.
 752      *
 753      * We take advantage here of the fact that, according to all the
 754      * POP RFCs, "if the number of lines requested by the POP3 client
 755      * is greater than than the number of lines in the body, then the
 756      * POP3 server sends the entire message.").
 757      *
 758      * The line count passed (99999999) is the maximum value CompuServe will
 759      * accept; it's much lower than the natural value 2147483646 (the maximum
 760      * twos-complement signed 32-bit integer minus 1) */
 761     if (ctl->keep || ctl->fetchall)
 762         gen_send(sock, "RETR %d", number);
 763     else
 764         gen_send(sock, "TOP %d 99999999", number);
 765     if ((ok = pop3_ok(sock, buf)) != 0)
 766         return(ok);
 767
 768     *lenp = -1;         /* we got sizes from the LIST response */
 769
 770     return(PS_SUCCESS);
 771 }
 772
 773 static int pop3_delete(int sock, struct query *ctl, int number)
 774 /* delete a given message */
 775 {
 776     /* actually, mark for deletion -- doesn't happen until QUIT time */
 777     return(gen_transact(sock, "DELE %d", number));
 778 }
 779
 780 static int pop3_logout(int sock, struct query *ctl)
 781 /* send logout command */
 782 {
 783     int ok;
 784
 785 #ifdef __UNUSED__
 786     /*
 787      * We used to do this in case the server marks messages deleted when seen.
 788      * (Yes, this has been reported, in the MercuryP/NLM server.
 789      * It's even legal under RFC 1939 (section 8) as a site policy.)
 790      * It interacted badly with UIDL, though.  Thomas Zajic wrote:
 791      * "Running 'fetchmail -F -v' and checking the logs, I found out
 792      * that fetchmail did in fact flush my mailbox properly, but sent
 793      * a RSET just before sending QUIT to log off.  This caused the
 794      * POP3 server to undo/forget about the previous DELEs, resetting
 795      * my mailbox to its original (ie.  unflushed) state. The
 796      * ~/.fetchids file did get flushed though, so the next time
 797      * fetchmail was run it saw all the old messages as new ones ..."
 798      */
 799      if (ctl->keep)
 800         gen_transact(sock, "RSET");
 801 #endif /* __UNUSED__ */
 802
 803     ok = gen_transact(sock, "QUIT");
 804     if (!ok)
 805         expunge_uids(ctl);
 806
 807     if (ctl->lastid)
 808     {
 809         free(ctl->lastid);
 810         ctl->lastid = NULL;
 811     }
 812
 813     return(ok);
 814 }
 815
 816 const static struct method pop3 =
 817 {
 818     "POP3",             /* Post Office Protocol v3 */
 819 #if INET6_ENABLE
 820     "pop3",             /* standard POP3 port */
 821     "pop3s",            /* ssl POP3 port */
 822 #else /* INET6_ENABLE */
 823     110,                /* standard POP3 port */
 824     995,                /* ssl POP3 port */
 825 #endif /* INET6_ENABLE */
 826     FALSE,              /* this is not a tagged protocol */
 827     TRUE,               /* this uses a message delimiter */
 828     pop3_ok,            /* parse command response */
 829     pop3_getauth,       /* get authorization */
 830     pop3_getrange,      /* query range of messages */
 831     pop3_getsizes,      /* we can get a list of sizes */
 832     pop3_is_old,        /* how do we tell a message is old? */
 833     pop3_fetch,         /* request given message */
 834     NULL,               /* no way to fetch body alone */
 835     NULL,               /* no message trailer */
 836     pop3_delete,        /* how to delete a message */
 837     pop3_logout,        /* log out, we're done */
 838     FALSE,              /* no, we can't re-poll */
 839 };
 840
 841 int doPOP3 (struct query *ctl)
 842 /* retrieve messages using POP3 */
 843 {
 844 #ifndef MBOX
 845     if (ctl->mailboxes->id) {
 846         fprintf(stderr,GT_("Option --remote is not supported with POP3\n"));
 847         return(PS_SYNTAX);
 848     }
 849 #endif /* MBOX */
 850     peek_capable = !ctl->fetchall;
 851     return(do_protocol(ctl, &pop3));
 852 }
 853 #endif /* POP3_ENABLE */
 854
 855 /* pop3.c ends here */