2 * options.c -- command-line option processing
4 * For license terms, see the file COPYING in this directory.
10 #if defined(HAVE_ALLOCA_H)
20 #if defined(STDC_HEADERS)
28 #include "fetchmail.h"
39 #define LA_INVISIBLE 10
41 #define LA_NOSYSLOG 12
44 #define LA_POSTMASTER 15
45 #define LA_PROTOCOL 16
48 #define LA_AUTHENTICATE 19
50 #define LA_ENVELOPE 21
51 #define LA_QVIRTUAL 22
52 #define LA_USERNAME 23
57 #define LA_NOREWRITE 28
60 #define LA_SMTPHOST 31
61 #define LA_SMTPADDR 32
62 #define LA_ANTISPAM 33
63 #define LA_BATCHLIMIT 34
64 #define LA_FETCHLIMIT 35
68 #define LA_INTERFACE 39
70 #define LA_CONFIGDUMP 42
73 /* options still left: CgGhHjJoORwWxXYz */
74 static const char *shortoptions =
75 "?Vcsvd:NqL:f:i:p:UP:A:t:E:Q:u:akKFnl:r:S:Z:b:B:e:m:T:I:M:y";
77 static const struct option longoptions[] = {
78 /* this can be const because all flag fields are 0 and will never get set */
79 {"help", no_argument, (int *) 0, LA_HELP },
80 {"version", no_argument, (int *) 0, LA_VERSION },
81 {"check", no_argument, (int *) 0, LA_CHECK },
82 {"silent", no_argument, (int *) 0, LA_SILENT },
83 {"verbose", no_argument, (int *) 0, LA_VERBOSE },
84 {"daemon", required_argument, (int *) 0, LA_DAEMON },
85 {"nodetach", no_argument, (int *) 0, LA_NODETACH },
86 {"quit", no_argument, (int *) 0, LA_QUIT },
87 {"logfile", required_argument, (int *) 0, LA_LOGFILE },
88 {"invisible", no_argument, (int *) 0, LA_INVISIBLE },
89 {"syslog", no_argument, (int *) 0, LA_SYSLOG },
90 {"nosyslog", no_argument, (int *) 0, LA_NOSYSLOG },
91 {"fetchmailrc",required_argument,(int *) 0, LA_RCFILE },
92 {"idfile", required_argument, (int *) 0, LA_IDFILE },
93 {"postmaster",required_argument, (int *) 0, LA_POSTMASTER },
95 {"protocol", required_argument, (int *) 0, LA_PROTOCOL },
96 {"proto", required_argument, (int *) 0, LA_PROTOCOL },
97 {"uidl", no_argument, (int *) 0, LA_UIDL },
98 {"port", required_argument, (int *) 0, LA_PORT },
99 {"auth", required_argument, (int *) 0, LA_AUTHENTICATE},
100 {"timeout", required_argument, (int *) 0, LA_TIMEOUT },
101 {"envelope", required_argument, (int *) 0, LA_ENVELOPE },
102 {"qvirtual", required_argument, (int *) 0, LA_QVIRTUAL },
104 {"user", required_argument, (int *) 0, LA_USERNAME },
105 {"username", required_argument, (int *) 0, LA_USERNAME },
107 {"all", no_argument, (int *) 0, LA_ALL },
108 {"nokeep", no_argument, (int *) 0, LA_NOKEEP },
109 {"keep", no_argument, (int *) 0, LA_KEEP },
110 {"flush", no_argument, (int *) 0, LA_FLUSH },
111 {"norewrite", no_argument, (int *) 0, LA_NOREWRITE },
112 {"limit", required_argument, (int *) 0, LA_LIMIT },
114 {"folder", required_argument, (int *) 0, LA_FOLDER },
115 {"smtphost", required_argument, (int *) 0, LA_SMTPHOST },
116 {"smtpaddress", required_argument, (int *) 0, LA_SMTPADDR },
117 {"antispam", required_argument, (int *) 0, LA_ANTISPAM },
119 {"batchlimit",required_argument, (int *) 0, LA_BATCHLIMIT },
120 {"fetchlimit",required_argument, (int *) 0, LA_FETCHLIMIT },
121 {"expunge", required_argument, (int *) 0, LA_EXPUNGE },
122 {"mda", required_argument, (int *) 0, LA_MDA },
125 {"netsec", required_argument, (int *) 0, LA_NETSEC },
128 #if defined(linux) && !INET6
129 {"interface", required_argument, (int *) 0, LA_INTERFACE },
130 {"monitor", required_argument, (int *) 0, LA_MONITOR },
131 #endif /* defined(linux) && !INET6 */
133 {"configdump",no_argument, (int *) 0, LA_CONFIGDUMP },
135 {"yydebug", no_argument, (int *) 0, LA_YYDEBUG },
137 {(char *) 0, no_argument, (int *) 0, 0 }
140 static int xatoi(char *s, int *errflagptr)
141 /* do safe conversion from string to number */
143 #if defined (STDC_HEADERS) && defined (LONG_MAX) && defined (INT_MAX)
144 /* parse and convert numbers, but also check for invalid characters in
153 value = strtol(s, &endptr, 0);
155 /* any invalid chars in string? */
156 if ( (endptr == s) || (*endptr != '\0') ) {
157 (void) fprintf(stderr, "String '%s' is not a valid number string.\n", s);
162 /* is the range valid? */
163 if ( (((value == LONG_MAX) || (value == LONG_MIN)) && (errno == ERANGE)) ||
164 (value > INT_MAX) || (value < INT_MIN)) {
166 (void) fprintf(stderr, "Value of string '%s' is %s than %d.\n", s,
167 (value < 0) ? "smaller": "larger",
168 (value < 0) ? INT_MIN : INT_MAX);
173 return (int) value; /* shut up, I know what I'm doing */
177 # if defined (STDC_HEADERS)
183 /* We do only base 10 conversions here (atoi)! */
186 /* check for leading white spaces */
187 for (i = 0; (i < len) && isspace(s[i]); i++)
193 if (i < len && (s[i] == '+' || s[i] == '-')) i++;
195 /* skip over digits */
196 for ( /* no init */ ; (i < len) && isdigit(s[i]); i++)
199 /* check for trailing garbage */
201 (void) fprintf(stderr, "String '%s' is not a valid number string.\n", s);
206 /* atoi should be safe by now, except for number range over/underflow */
211 int parsecmdline (argc, argv, rctl, ctl)
212 /* parse and validate the command line options */
213 int argc; /* argument count */
214 char **argv; /* argument strings */
215 struct runctl *rctl; /* global run controls to modify */
216 struct query *ctl; /* option record to be initialized */
219 * return value: if positive, argv index of last parsed option + 1
220 * (presumes one or more server names follows). if zero, the
221 * command line switches are such that no server names are
222 * required (e.g. --version). if negative, the command line is
223 * has one or more syntax errors.
227 int ocount = 0; /* count of destinations specified */
228 int errflag = 0; /* TRUE when a syntax error is detected */
232 rctl->poll_interval = -1;
234 memset(ctl, '\0', sizeof(struct query)); /* start clean */
235 ctl->smtp_socket = -1;
238 (c = getopt_long(argc,argv,shortoptions,
239 longoptions,&option_index)) != -1) {
256 outlevel = O_VERBOSE;
260 rctl->poll_interval = xatoi(optarg, &errflag);
272 rctl->logfile = optarg;
275 rctl->invisible = TRUE;
279 rcfile = (char *) xmalloc(strlen(optarg)+1);
280 strcpy(rcfile,optarg);
284 rctl->idfile = (char *) xmalloc(strlen(optarg)+1);
285 strcpy(rctl->idfile,optarg);
288 rctl->postmaster = (char *) xmalloc(strlen(optarg)+1);
292 /* XXX -- should probably use a table lookup here */
293 if (strcasecmp(optarg,"pop2") == 0)
294 ctl->server.protocol = P_POP2;
296 else if (strcasecmp(optarg,"sdps") == 0)
298 ctl->server.protocol = P_POP3;
299 ctl->server.sdps = TRUE;
301 #endif /* SDPS_ENABLE */
302 else if (strcasecmp(optarg,"pop3") == 0)
303 ctl->server.protocol = P_POP3;
304 else if (strcasecmp(optarg,"apop") == 0)
305 ctl->server.protocol = P_APOP;
306 else if (strcasecmp(optarg,"rpop") == 0)
307 ctl->server.protocol = P_RPOP;
308 else if (strcasecmp(optarg,"kpop") == 0)
310 ctl->server.protocol = P_POP3;
312 ctl->server.service = KPOP_PORT;
314 ctl->server.port = KPOP_PORT;
317 ctl->server.preauthenticate = A_KERBEROS_V5;
319 ctl->server.preauthenticate = A_KERBEROS_V4;
320 #endif /* KERBEROS_V5 */
322 else if (strcasecmp(optarg,"imap") == 0)
323 ctl->server.protocol = P_IMAP;
325 else if (strcasecmp(optarg,"imap-k4") == 0)
326 ctl->server.protocol = P_IMAP_K4;
327 #endif /* KERBEROS_V4 */
329 else if (strcasecmp(optarg, "imap-gss") == 0)
330 ctl->server.protocol = P_IMAP_GSS;
332 else if (strcasecmp(optarg,"etrn") == 0)
333 ctl->server.protocol = P_ETRN;
335 fprintf(stderr,"Invalid protocol `%s' specified.\n", optarg);
341 ctl->server.uidl = FLAG_TRUE;
346 ctl->server.service = optarg;
348 ctl->server.port = xatoi(optarg, &errflag);
352 case LA_AUTHENTICATE:
353 if (strcmp(optarg, "password") == 0)
354 ctl->server.preauthenticate = A_PASSWORD;
355 else if (strcmp(optarg, "kerberos") == 0)
357 ctl->server.preauthenticate = A_KERBEROS_V5;
358 else if (strcmp(optarg, "kerberos_v5") == 0)
359 ctl->server.preauthenticate = A_KERBEROS_V5;
361 ctl->server.preauthenticate = A_KERBEROS_V4;
362 else if (strcmp(optarg, "kerberos_v4") == 0)
363 ctl->server.preauthenticate = A_KERBEROS_V4;
364 #endif /* KERBEROS_V5 */
366 fprintf(stderr,"Invalid preauthentication `%s' specified.\n", optarg);
372 ctl->server.timeout = xatoi(optarg, &errflag);
373 if (ctl->server.timeout == 0)
374 ctl->server.timeout = -1;
378 ctl->server.envelope = xstrdup(optarg);
382 ctl->server.qvirtual = xstrdup(optarg);
387 ctl->remotename = xstrdup(optarg);
391 ctl->fetchall = FLAG_TRUE;
395 ctl->keep = FLAG_FALSE;
399 ctl->keep = FLAG_TRUE;
403 ctl->flush = FLAG_TRUE;
407 ctl->rewrite = FLAG_FALSE;
411 c = xatoi(optarg, &errflag);
412 ctl->limit = NUM_VALUE(c);
416 buf = alloca(strlen(optarg));
418 cp = strtok(buf, ",");
420 save_str(&ctl->mailboxes, cp, 0);
422 ((cp = strtok((char *)NULL, ",")));
426 buf = alloca(strlen(optarg));
428 cp = strtok(buf, ",");
430 save_str(&ctl->smtphunt, cp, TRUE);
432 ((cp = strtok((char *)NULL, ",")));
437 ctl->smtpaddress = xstrdup(optarg);
441 buf = alloca(strlen(optarg));
443 cp = strtok(buf, ",");
445 struct idlist *idp = save_str(&ctl->antispam, NULL, 0);;
447 idp->val.status.num = atoi(cp);
449 ((cp = strtok((char *)NULL, ",")));
453 c = xatoi(optarg, &errflag);
454 ctl->batchlimit = NUM_VALUE(c);
458 c = xatoi(optarg, &errflag);
459 ctl->fetchlimit = NUM_VALUE(c);
463 c = xatoi(optarg, &errflag);
464 ctl->expunge = NUM_VALUE(c);
468 ctl->mda = xstrdup(optarg);
475 ctl->server.netsec = (void *)optarg;
477 fprintf(stderr, "fetchmail: network security support is disabled\n");
479 #endif /* NET_SECURITY */
482 #if defined(linux) && !INET6
485 interface_parse(optarg, &ctl->server);
489 ctl->server.monitor = xstrdup(optarg);
491 #endif /* defined(linux) && !INET6 */
503 rctl->use_syslog = FLAG_TRUE;
507 rctl->use_syslog = FLAG_FALSE;
517 if (errflag || ocount > 1) {
518 /* squawk if syntax errors were detected */
519 fputs("usage: fetchmail [options] [server ...]\n", stderr);
520 fputs(" Options are as follows:\n",stderr);
521 fputs(" -?, --help display this option help\n", stderr);
522 fputs(" -V, --version display version info\n", stderr);
524 fputs(" -c, --check check for messages without fetching\n", stderr);
525 fputs(" -s, --silent work silently\n", stderr);
526 fputs(" -v, --verbose work noisily (diagnostic output)\n", stderr);
527 fputs(" -d, --daemon run as a daemon once per n seconds\n", stderr);
528 fputs(" -N, --nodetach don't detach daemon process\n", stderr);
529 fputs(" -q, --quit kill daemon process\n", stderr);
530 fputs(" -L, --logfile specify logfile name\n", stderr);
531 fputs(" --syslog use syslog(3) for most messages when running as a daemon\n", stderr);
532 fputs(" --invisible suppress Received line & enable host spoofing\n", stderr);
533 fputs(" -f, --fetchmailrc specify alternate run control file\n", stderr);
534 fputs(" -i, --idfile specify alternate UIDs file\n", stderr);
535 fputs(" --postmaster specify recipient of last resort\n",stderr);
536 #if defined(linux) && !INET6
537 fputs(" -I, --interface interface required specification\n",stderr);
538 fputs(" -M, --monitor monitor interface for activity\n",stderr);
542 fputs(" -p, --protocol specify pop2, pop3, imap, apop, rpop, kpop, etrn, imap-k4\n", stderr);
544 fputs(" -p, --protocol specify pop2, pop3, imap, apop, rpop, kpop, etrn\n", stderr);
545 #endif /* KERBEROS_V4 */
546 fputs(" -U, --uidl force the use of UIDLs (pop3 only)\n", stderr);
547 fputs(" -P, --port TCP/IP service port to connect to\n",stderr);
548 fputs(" -A, --auth authentication type (password or kerberos)\n",stderr);
549 fputs(" -t, --timeout server nonresponse timeout\n",stderr);
550 fputs(" -E, --envelope envelope address header\n",stderr);
551 fputs(" -Q, --qvirtual prefix to remove from local user id\n",stderr);
553 fputs(" -u, --username specify users's login on server\n", stderr);
554 fputs(" -a, --all retrieve old and new messages\n", stderr);
555 fputs(" -K, --nokeep delete new messages after retrieval\n", stderr);
556 fputs(" -k, --keep save new messages after retrieval\n", stderr);
557 fputs(" -F, --flush delete old messages from server\n", stderr);
558 fputs(" -n, --norewrite don't rewrite header addresses\n", stderr);
559 fputs(" -l, --limit don't fetch messages over given size\n", stderr);
562 fputs(" -T, --netsec set IP security request\n", stderr);
563 #endif /* NET_SECURITY */
564 fputs(" -S, --smtphost set SMTP forwarding host\n", stderr);
565 fputs(" -D, --smtpaddress set SMTP delivery domain to use\n", stderr);
566 fputs(" -Z, --antispam, set antispam response values\n", stderr);
567 fputs(" -b, --batchlimit set batch limit for SMTP connections\n", stderr);
568 fputs(" -B, --fetchlimit set fetch limit for server connections\n", stderr);
569 fputs(" -e, --expunge set max deletions between expunges\n", stderr);
570 fputs(" -r, --folder specify remote folder name\n", stderr);
577 /* options.c ends here */