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