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

   1 /*
   2  * options.c -- command-line option processing
   3  *
   4  * For license terms, see the file COPYING in this directory.
   5  */
   6
   7 #include "config.h"
   8
   9 #include <stdio.h>
  10 #include <pwd.h>
  11 #include <string.h>
  12 #include <errno.h>
  13 #if defined(STDC_HEADERS)
  14 #include  <stdlib.h>
  15 #include  <limits.h>
  16 #else
  17 #include  <ctype.h>
  18 #endif
  19
  20 #include "getopt.h"
  21 #include "fetchmail.h"
  22
  23 #define LA_HELP         1
  24 #define LA_VERSION      2
  25 #define LA_CHECK        3
  26 #define LA_SILENT       4
  27 #define LA_VERBOSE      5
  28 #define LA_DAEMON       6
  29 #define LA_NODETACH     7
  30 #define LA_QUIT         8
  31 #define LA_LOGFILE      9
  32 #define LA_INVISIBLE    10
  33 #define LA_SYSLOG       11
  34 #define LA_NOSYSLOG     12
  35 #define LA_RCFILE       13
  36 #define LA_IDFILE       14
  37 #define LA_POSTMASTER   15
  38 #define LA_PROTOCOL     16
  39 #define LA_UIDL         17
  40 #define LA_PORT         18
  41 #define LA_AUTHENTICATE 19
  42 #define LA_TIMEOUT      20
  43 #define LA_ENVELOPE     21
  44 #define LA_QVIRTUAL     22
  45 #define LA_USERNAME     23
  46 #define LA_ALL          24
  47 #define LA_NOKEEP       25
  48 #define LA_KEEP         26
  49 #define LA_FLUSH        27
  50 #define LA_NOREWRITE    28
  51 #define LA_LIMIT        29
  52 #define LA_FOLDER       30
  53 #define LA_SMTPHOST     31
  54 #define LA_SMTPADDR     32
  55 #define LA_ANTISPAM     33
  56 #define LA_BATCHLIMIT   34
  57 #define LA_FETCHLIMIT   35
  58 #define LA_EXPUNGE      36
  59 #define LA_MDA          37
  60 #define LA_NETSEC       38
  61 #define LA_INTERFACE    39
  62 #define LA_MONITOR      41
  63 #define LA_CONFIGDUMP   42
  64 #define LA_YYDEBUG      43
  65
  66 /* options still left: CgGhHjJoORwWxXYz */
  67 static const char *shortoptions =
  68         "?Vcsvd:NqL:f:i:p:UP:A:t:E:Q:u:akKFnl:r:S:Z:b:B:e:m:T:I:M:y";
  69
  70 static const struct option longoptions[] = {
  71 /* this can be const because all flag fields are 0 and will never get set */
  72   {"help",      no_argument,       (int *) 0, LA_HELP        },
  73   {"version",   no_argument,       (int *) 0, LA_VERSION     },
  74   {"check",     no_argument,       (int *) 0, LA_CHECK       },
  75   {"silent",    no_argument,       (int *) 0, LA_SILENT      },
  76   {"verbose",   no_argument,       (int *) 0, LA_VERBOSE     },
  77   {"daemon",    required_argument, (int *) 0, LA_DAEMON      },
  78   {"nodetach",  no_argument,       (int *) 0, LA_NODETACH    },
  79   {"quit",      no_argument,       (int *) 0, LA_QUIT        },
  80   {"logfile",   required_argument, (int *) 0, LA_LOGFILE     },
  81   {"invisible", no_argument,       (int *) 0, LA_INVISIBLE   },
  82   {"syslog",    no_argument,       (int *) 0, LA_SYSLOG      },
  83   {"nosyslog",  no_argument,       (int *) 0, LA_NOSYSLOG    },
  84   {"fetchmailrc",required_argument,(int *) 0, LA_RCFILE      },
  85   {"idfile",    required_argument, (int *) 0, LA_IDFILE      },
  86   {"postmaster",required_argument, (int *) 0, LA_POSTMASTER  },
  87
  88   {"protocol",  required_argument, (int *) 0, LA_PROTOCOL    },
  89   {"proto",     required_argument, (int *) 0, LA_PROTOCOL    },
  90   {"uidl",      no_argument,       (int *) 0, LA_UIDL        },
  91   {"port",      required_argument, (int *) 0, LA_PORT        },
  92   {"auth",      required_argument, (int *) 0, LA_AUTHENTICATE},
  93   {"timeout",   required_argument, (int *) 0, LA_TIMEOUT     },
  94   {"envelope",  required_argument, (int *) 0, LA_ENVELOPE    },
  95   {"qvirtual",  required_argument, (int *) 0, LA_QVIRTUAL    },
  96
  97   {"user",      required_argument, (int *) 0, LA_USERNAME    },
  98   {"username",  required_argument, (int *) 0, LA_USERNAME    },
  99
 100   {"all",       no_argument,       (int *) 0, LA_ALL         },
 101   {"nokeep",    no_argument,       (int *) 0, LA_NOKEEP      },
 102   {"keep",      no_argument,       (int *) 0, LA_KEEP        },
 103   {"flush",     no_argument,       (int *) 0, LA_FLUSH       },
 104   {"norewrite", no_argument,       (int *) 0, LA_NOREWRITE   },
 105   {"limit",     required_argument, (int *) 0, LA_LIMIT       },
 106
 107   {"folder",    required_argument, (int *) 0, LA_FOLDER      },
 108   {"smtphost",  required_argument, (int *) 0, LA_SMTPHOST    },
 109   {"smtpaddress", required_argument, (int *) 0, LA_SMTPADDR  },
 110   {"antispam",  required_argument, (int *) 0, LA_ANTISPAM    },
 111
 112   {"batchlimit",required_argument, (int *) 0, LA_BATCHLIMIT  },
 113   {"fetchlimit",required_argument, (int *) 0, LA_FETCHLIMIT  },
 114   {"expunge",   required_argument, (int *) 0, LA_EXPUNGE     },
 115   {"mda",       required_argument, (int *) 0, LA_MDA         },
 116
 117 #ifdef INET6
 118   {"netsec",    required_argument, (int *) 0, LA_NETSEC    },
 119 #endif /* INET6 */
 120
 121 #if defined(linux) && !INET6
 122   {"interface", required_argument, (int *) 0, LA_INTERFACE   },
 123   {"monitor",   required_argument, (int *) 0, LA_MONITOR     },
 124 #endif /* defined(linux) && !INET6 */
 125
 126   {"configdump",no_argument,       (int *) 0, LA_CONFIGDUMP  },
 127
 128   {"yydebug",   no_argument,       (int *) 0, LA_YYDEBUG     },
 129
 130   {(char *) 0,  no_argument,       (int *) 0, 0              }
 131 };
 132
 133 static int xatoi(char *s, int *errflagptr)
 134 /* do safe conversion from string to number */
 135 {
 136 #if defined (STDC_HEADERS) && defined (LONG_MAX) && defined (INT_MAX)
 137     /* parse and convert numbers, but also check for invalid characters in
 138      * numbers
 139      */
 140
 141     char *endptr;
 142     long value;
 143
 144     errno = 0;
 145
 146     value = strtol(s, &endptr, 0);
 147
 148     /* any invalid chars in string? */
 149     if ( (endptr == s) || (*endptr != '\0') ) {
 150         (void) fprintf(stderr, "String '%s' is not a valid number string.\n", s);
 151         (*errflagptr)++;
 152         return 0;
 153     }
 154
 155     /* is the range valid? */
 156     if ( (((value == LONG_MAX) || (value == LONG_MIN)) && (errno == ERANGE)) ||
 157                                 (value > INT_MAX) || (value < INT_MIN)) {
 158
 159         (void) fprintf(stderr, "Value of string '%s' is %s than %d.\n", s,
 160                                         (value < 0) ? "smaller": "larger",
 161                                         (value < 0) ? INT_MIN : INT_MAX);
 162         (*errflagptr)++;
 163         return 0;
 164     }
 165
 166     return (int) value;  /* shut up, I know what I'm doing */
 167 #else
 168     int i;
 169     char *dp;
 170 # if defined (STDC_HEADERS)
 171     size_t      len;
 172 # else
 173     int         len;
 174 # endif
 175
 176     /* We do only base 10 conversions here (atoi)! */
 177
 178     len = strlen(s);
 179     /* check for leading white spaces */
 180     for (i = 0; (i < len) && isspace(s[i]); i++)
 181         ;
 182
 183     dp = &s[i];
 184
 185     /* check for +/- */
 186     if (i < len && (s[i] == '+' || s[i] == '-'))        i++;
 187
 188     /* skip over digits */
 189     for ( /* no init */ ; (i < len) && isdigit(s[i]); i++)
 190         ;
 191
 192     /* check for trailing garbage */
 193     if (i != len) {
 194         (void) fprintf(stderr, "String '%s' is not a valid number string.\n", s);
 195         (*errflagptr)++;
 196         return 0;
 197     }
 198
 199     /* atoi should be safe by now, except for number range over/underflow */
 200     return atoi(dp);
 201 #endif
 202 }
 203
 204 int parsecmdline (argc, argv, rctl, ctl)
 205 /* parse and validate the command line options */
 206 int argc;               /* argument count */
 207 char **argv;            /* argument strings */
 208 struct runctl *rctl;    /* global run controls to modify */
 209 struct query *ctl;      /* option record to be initialized */
 210 {
 211     /*
 212      * return value: if positive, argv index of last parsed option + 1
 213      * (presumes one or more server names follows).  if zero, the
 214      * command line switches are such that no server names are
 215      * required (e.g. --version).  if negative, the command line is
 216      * has one or more syntax errors.
 217      */
 218
 219     int c;
 220     int ocount = 0;     /* count of destinations specified */
 221     int errflag = 0;   /* TRUE when a syntax error is detected */
 222     int option_index;
 223     char *buf, *cp;
 224
 225     rctl->poll_interval = -1;
 226
 227     memset(ctl, '\0', sizeof(struct query));    /* start clean */
 228     ctl->smtp_socket = -1;
 229
 230     while (!errflag &&
 231            (c = getopt_long(argc,argv,shortoptions,
 232                             longoptions,&option_index)) != -1) {
 233
 234         switch (c) {
 235         case 'V':
 236         case LA_VERSION:
 237             versioninfo = TRUE;
 238             break;
 239         case 'c':
 240         case LA_CHECK:
 241             check_only = TRUE;
 242             break;
 243         case 's':
 244         case LA_SILENT:
 245             outlevel = O_SILENT;
 246             break;
 247         case 'v':
 248         case LA_VERBOSE:
 249             outlevel = O_VERBOSE;
 250             break;
 251         case 'd':
 252         case LA_DAEMON:
 253             rctl->poll_interval = xatoi(optarg, &errflag);
 254             break;
 255         case 'N':
 256         case LA_NODETACH:
 257             nodetach = TRUE;
 258             break;
 259         case 'q':
 260         case LA_QUIT:
 261             quitmode = TRUE;
 262             break;
 263         case 'L':
 264         case LA_LOGFILE:
 265             rctl->logfile = optarg;
 266             break;
 267         case LA_INVISIBLE:
 268             rctl->invisible = TRUE;
 269             break;
 270         case 'f':
 271         case LA_RCFILE:
 272             rcfile = (char *) xmalloc(strlen(optarg)+1);
 273             strcpy(rcfile,optarg);
 274             break;
 275         case 'i':
 276         case LA_IDFILE:
 277             rctl->idfile = (char *) xmalloc(strlen(optarg)+1);
 278             strcpy(rctl->idfile,optarg);
 279             break;
 280         case LA_POSTMASTER:
 281             rctl->postmaster = (char *) xmalloc(strlen(optarg)+1);
 282             break;
 283         case 'p':
 284         case LA_PROTOCOL:
 285             /* XXX -- should probably use a table lookup here */
 286             if (strcasecmp(optarg,"pop2") == 0)
 287                 ctl->server.protocol = P_POP2;
 288             else if (strcasecmp(optarg,"pop3") == 0)
 289                 ctl->server.protocol = P_POP3;
 290             else if (strcasecmp(optarg,"apop") == 0)
 291                 ctl->server.protocol = P_APOP;
 292             else if (strcasecmp(optarg,"rpop") == 0)
 293                 ctl->server.protocol = P_RPOP;
 294             else if (strcasecmp(optarg,"kpop") == 0)
 295             {
 296                 ctl->server.protocol = P_POP3;
 297 #if INET6
 298                 ctl->server.service = KPOP_PORT;
 299 #else /* INET6 */
 300                 ctl->server.port = KPOP_PORT;
 301 #endif /* INET6 */
 302 #ifdef KERBEROS_V5
 303                 ctl->server.preauthenticate =  A_KERBEROS_V5;
 304 #else
 305                 ctl->server.preauthenticate =  A_KERBEROS_V4;
 306 #endif /* KERBEROS_V5 */
 307             }
 308             else if (strcasecmp(optarg,"imap") == 0)
 309                 ctl->server.protocol = P_IMAP;
 310 #ifdef KERBEROS_V4
 311             else if (strcasecmp(optarg,"imap-k4") == 0)
 312                 ctl->server.protocol = P_IMAP_K4;
 313 #endif /* KERBEROS_V4 */
 314 #ifdef GSSAPI
 315             else if (strcasecmp(optarg, "imap-gss") == 0)
 316                 ctl->server.protocol = P_IMAP_GSS;
 317 #endif /* GSSAPI */
 318             else if (strcasecmp(optarg,"etrn") == 0)
 319                 ctl->server.protocol = P_ETRN;
 320             else {
 321                 fprintf(stderr,"Invalid protocol `%s' specified.\n", optarg);
 322                 errflag++;
 323             }
 324             break;
 325         case 'U':
 326         case LA_UIDL:
 327             ctl->server.uidl = FLAG_TRUE;
 328             break;
 329         case 'P':
 330         case LA_PORT:
 331 #if INET6
 332             ctl->server.service = optarg;
 333 #else /* INET6 */
 334             ctl->server.port = xatoi(optarg, &errflag);
 335 #endif /* INET6 */
 336             break;
 337         case 'A':
 338         case LA_AUTHENTICATE:
 339             if (strcmp(optarg, "password") == 0)
 340                 ctl->server.preauthenticate = A_PASSWORD;
 341             else if (strcmp(optarg, "kerberos") == 0)
 342 #ifdef KERBEROS_V5
 343                 ctl->server.preauthenticate = A_KERBEROS_V5;
 344             else if (strcmp(optarg, "kerberos_v5") == 0)
 345                 ctl->server.preauthenticate = A_KERBEROS_V5;
 346 #else
 347                 ctl->server.preauthenticate = A_KERBEROS_V4;
 348             else if (strcmp(optarg, "kerberos_v4") == 0)
 349                 ctl->server.preauthenticate = A_KERBEROS_V4;
 350 #endif /* KERBEROS_V5 */
 351             else {
 352                 fprintf(stderr,"Invalid preauthentication `%s' specified.\n", optarg);
 353                 errflag++;
 354             }
 355             break;
 356         case 't':
 357         case LA_TIMEOUT:
 358             ctl->server.timeout = xatoi(optarg, &errflag);
 359             if (ctl->server.timeout == 0)
 360                 ctl->server.timeout = -1;
 361             break;
 362         case 'E':
 363         case LA_ENVELOPE:
 364             ctl->server.envelope = xstrdup(optarg);
 365             break;
 366         case 'Q':
 367         case LA_QVIRTUAL:
 368             ctl->server.qvirtual = xstrdup(optarg);
 369             break;
 370
 371         case 'u':
 372         case LA_USERNAME:
 373             ctl->remotename = xstrdup(optarg);
 374             break;
 375         case 'a':
 376         case LA_ALL:
 377             ctl->fetchall = FLAG_TRUE;
 378             break;
 379         case 'K':
 380         case LA_NOKEEP:
 381             ctl->keep = FLAG_FALSE;
 382             break;
 383         case 'k':
 384         case LA_KEEP:
 385             ctl->keep = FLAG_TRUE;
 386             break;
 387         case 'F':
 388         case LA_FLUSH:
 389             ctl->flush = FLAG_TRUE;
 390             break;
 391         case 'n':
 392         case LA_NOREWRITE:
 393             ctl->rewrite = FLAG_FALSE;
 394             break;
 395         case 'l':
 396         case LA_LIMIT:
 397             c = xatoi(optarg, &errflag);
 398             ctl->limit = NUM_VALUE(c);
 399             break;
 400         case 'r':
 401         case LA_FOLDER:
 402             buf = xmalloc(strlen(optarg));
 403             strcpy(buf, optarg);
 404             cp = strtok(buf, ",");
 405             do {
 406                 save_str(&ctl->mailboxes, cp, 0);
 407             } while
 408                 ((cp = strtok((char *)NULL, ",")));
 409             free(buf);
 410             break;
 411         case 'S':
 412         case LA_SMTPHOST:
 413             buf = xmalloc(strlen(optarg));
 414             strcpy(buf, optarg);
 415             cp = strtok(buf, ",");
 416             do {
 417                 save_str(&ctl->smtphunt, cp, TRUE);
 418             } while
 419                 ((cp = strtok((char *)NULL, ",")));
 420             ocount++;
 421             free(buf);
 422             break;
 423         case 'D':
 424         case LA_SMTPADDR:
 425             ctl->smtpaddress = xstrdup(optarg);
 426             break;
 427         case 'Z':
 428         case LA_ANTISPAM:
 429             strcpy(buf, optarg);
 430             cp = strtok(buf, ",");
 431             do {
 432                 struct idlist   *idp = save_str(&ctl->antispam, NULL, 0);;
 433
 434                 idp->val.status.num = atoi(cp);
 435             } while
 436                 ((cp = strtok((char *)NULL, ",")));
 437             free(buf);
 438             break;
 439         case 'b':
 440         case LA_BATCHLIMIT:
 441             c = xatoi(optarg, &errflag);
 442             ctl->batchlimit = NUM_VALUE(c);
 443             break;
 444         case 'B':
 445         case LA_FETCHLIMIT:
 446             c = xatoi(optarg, &errflag);
 447             ctl->fetchlimit = NUM_VALUE(c);
 448             break;
 449         case 'e':
 450         case LA_EXPUNGE:
 451             c = xatoi(optarg, &errflag);
 452             ctl->expunge = NUM_VALUE(c);
 453             break;
 454         case 'm':
 455         case LA_MDA:
 456             ctl->mda = xstrdup(optarg);
 457             ocount++;
 458             break;
 459
 460         case 'T':
 461         case LA_NETSEC:
 462 #if NET_SECURITY
 463             ctl->server.netsec = (void *)optarg;
 464 #else
 465             fprintf(stderr, "fetchmail: network security support is disabled\n");
 466             errflag++;
 467 #endif /* NET_SECURITY */
 468             break;
 469
 470 #if defined(linux) && !INET6
 471         case 'I':
 472         case LA_INTERFACE:
 473             interface_parse(optarg, &ctl->server);
 474             break;
 475         case 'M':
 476         case LA_MONITOR:
 477             ctl->server.monitor = xstrdup(optarg);
 478             break;
 479 #endif /* defined(linux) && !INET6 */
 480
 481         case 'y':
 482         case LA_YYDEBUG:
 483             yydebug = TRUE;
 484             break;
 485
 486         case LA_CONFIGDUMP:
 487             configdump = TRUE;
 488             break;
 489
 490         case LA_SYSLOG:
 491             rctl->use_syslog = FLAG_TRUE;
 492             break;
 493
 494         case LA_NOSYSLOG:
 495             rctl->use_syslog = FLAG_FALSE;
 496             break;
 497
 498         case '?':
 499         case LA_HELP:
 500         default:
 501             errflag++;
 502         }
 503     }
 504
 505     if (errflag || ocount > 1) {
 506         /* squawk if syntax errors were detected */
 507         fputs("usage:  fetchmail [options] [server ...]\n", stderr);
 508         fputs("  Options are as follows:\n",stderr);
 509         fputs("  -?, --help        display this option help\n", stderr);
 510         fputs("  -V, --version     display version info\n", stderr);
 511
 512         fputs("  -c, --check       check for messages without fetching\n", stderr);
 513         fputs("  -s, --silent      work silently\n", stderr);
 514         fputs("  -v, --verbose     work noisily (diagnostic output)\n", stderr);
 515         fputs("  -d, --daemon      run as a daemon once per n seconds\n", stderr);
 516         fputs("  -N, --nodetach    don't detach daemon process\n", stderr);
 517         fputs("  -q, --quit        kill daemon process\n", stderr);
 518         fputs("  -L, --logfile     specify logfile name\n", stderr);
 519         fputs("      --syslog      use syslog(3) for most messages when running as a daemon\n", stderr);
 520         fputs("      --invisible   suppress Received line & enable host spoofing\n", stderr);
 521         fputs("  -f, --fetchmailrc specify alternate run control file\n", stderr);
 522         fputs("  -i, --idfile      specify alternate UIDs file\n", stderr);
 523         fputs("      --postmaster  specify recipient of last resort\n",stderr);
 524 #if defined(linux) && !INET6
 525         fputs("  -I, --interface   interface required specification\n",stderr);
 526         fputs("  -M, --monitor     monitor interface for activity\n",stderr);
 527 #endif
 528
 529 #ifdef KERBEROS_V4
 530         fputs("  -p, --protocol    specify pop2, pop3, imap, apop, rpop, kpop, etrn, imap-k4\n", stderr);
 531 #else
 532         fputs("  -p, --protocol    specify pop2, pop3, imap, apop, rpop, kpop, etrn\n", stderr);
 533 #endif /* KERBEROS_V4 */
 534         fputs("  -U, --uidl        force the use of UIDLs (pop3 only)\n", stderr);
 535         fputs("  -P, --port        TCP/IP service port to connect to\n",stderr);
 536         fputs("  -A, --auth        authentication type (password or kerberos)\n",stderr);
 537         fputs("  -t, --timeout     server nonresponse timeout\n",stderr);
 538         fputs("  -E, --envelope    envelope address header\n",stderr);
 539         fputs("  -Q, --qvirtual    prefix to remove from local user id\n",stderr);
 540
 541         fputs("  -u, --username    specify users's login on server\n", stderr);
 542         fputs("  -a, --all         retrieve old and new messages\n", stderr);
 543         fputs("  -K, --nokeep      delete new messages after retrieval\n", stderr);
 544         fputs("  -k, --keep        save new messages after retrieval\n", stderr);
 545         fputs("  -F, --flush       delete old messages from server\n", stderr);
 546         fputs("  -n, --norewrite   don't rewrite header addresses\n", stderr);
 547         fputs("  -l, --limit       don't fetch messages over given size\n", stderr);
 548
 549 #if NET_SECURITY
 550         fputs("  -T, --netsec      set IP security request\n", stderr);
 551 #endif /* NET_SECURITY */
 552         fputs("  -S, --smtphost    set SMTP forwarding host\n", stderr);
 553         fputs("  -D, --smtpaddress set SMTP delivery domain to use\n", stderr);
 554         fputs("  -Z, --antispam,   set antispam response values\n", stderr);
 555         fputs("  -b, --batchlimit  set batch limit for SMTP connections\n", stderr);
 556         fputs("  -B, --fetchlimit  set fetch limit for server connections\n", stderr);
 557         fputs("  -e, --expunge     set max deletions between expunges\n", stderr);
 558         fputs("  -r, --folder      specify remote folder name\n", stderr);
 559         return(-1);
 560     }
 561
 562     return(optind);
 563 }
 564
 565 /* options.c ends here */