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