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
72 #define LA_WARNINGS 44
74 /* options still left: CgGhHjJoORwWxXYz */
75 static const char *shortoptions =
76 "?Vcsvd:NqL:f:i:p:UP:A:t:E:Q:u:akKFnl:r:S:Z:b:B:e:m:T:I:M:yw:";
78 static const struct option longoptions[] = {
79 /* this can be const because all flag fields are 0 and will never get set */
80 {"help", no_argument, (int *) 0, LA_HELP },
81 {"version", no_argument, (int *) 0, LA_VERSION },
82 {"check", no_argument, (int *) 0, LA_CHECK },
83 {"silent", no_argument, (int *) 0, LA_SILENT },
84 {"verbose", no_argument, (int *) 0, LA_VERBOSE },
85 {"daemon", required_argument, (int *) 0, LA_DAEMON },
86 {"nodetach", no_argument, (int *) 0, LA_NODETACH },
87 {"quit", no_argument, (int *) 0, LA_QUIT },
88 {"logfile", required_argument, (int *) 0, LA_LOGFILE },
89 {"invisible", no_argument, (int *) 0, LA_INVISIBLE },
90 {"syslog", no_argument, (int *) 0, LA_SYSLOG },
91 {"nosyslog", no_argument, (int *) 0, LA_NOSYSLOG },
92 {"fetchmailrc",required_argument,(int *) 0, LA_RCFILE },
93 {"idfile", required_argument, (int *) 0, LA_IDFILE },
94 {"postmaster",required_argument, (int *) 0, LA_POSTMASTER },
96 {"protocol", required_argument, (int *) 0, LA_PROTOCOL },
97 {"proto", required_argument, (int *) 0, LA_PROTOCOL },
98 {"uidl", no_argument, (int *) 0, LA_UIDL },
99 {"port", required_argument, (int *) 0, LA_PORT },
100 {"auth", required_argument, (int *) 0, LA_AUTHENTICATE},
101 {"timeout", required_argument, (int *) 0, LA_TIMEOUT },
102 {"envelope", required_argument, (int *) 0, LA_ENVELOPE },
103 {"qvirtual", required_argument, (int *) 0, LA_QVIRTUAL },
105 {"user", required_argument, (int *) 0, LA_USERNAME },
106 {"username", required_argument, (int *) 0, LA_USERNAME },
108 {"all", no_argument, (int *) 0, LA_ALL },
109 {"nokeep", no_argument, (int *) 0, LA_NOKEEP },
110 {"keep", no_argument, (int *) 0, LA_KEEP },
111 {"flush", no_argument, (int *) 0, LA_FLUSH },
112 {"norewrite", no_argument, (int *) 0, LA_NOREWRITE },
113 {"limit", required_argument, (int *) 0, LA_LIMIT },
115 {"folder", required_argument, (int *) 0, LA_FOLDER },
116 {"smtphost", required_argument, (int *) 0, LA_SMTPHOST },
117 {"smtpaddress", required_argument, (int *) 0, LA_SMTPADDR },
118 {"antispam", required_argument, (int *) 0, LA_ANTISPAM },
120 {"batchlimit",required_argument, (int *) 0, LA_BATCHLIMIT },
121 {"fetchlimit",required_argument, (int *) 0, LA_FETCHLIMIT },
122 {"expunge", required_argument, (int *) 0, LA_EXPUNGE },
123 {"mda", required_argument, (int *) 0, LA_MDA },
126 {"netsec", required_argument, (int *) 0, LA_NETSEC },
129 #if defined(linux) && !INET6
130 {"interface", required_argument, (int *) 0, LA_INTERFACE },
131 {"monitor", required_argument, (int *) 0, LA_MONITOR },
132 #endif /* defined(linux) && !INET6 */
134 {"configdump",no_argument, (int *) 0, LA_CONFIGDUMP },
136 {"yydebug", no_argument, (int *) 0, LA_YYDEBUG },
138 {"warnings", required_argument, (int *) 0, LA_WARNINGS },
140 {(char *) 0, no_argument, (int *) 0, 0 }
143 static int xatoi(char *s, int *errflagptr)
144 /* do safe conversion from string to number */
146 #if defined (STDC_HEADERS) && defined (LONG_MAX) && defined (INT_MAX)
147 /* parse and convert numbers, but also check for invalid characters in
156 value = strtol(s, &endptr, 0);
158 /* any invalid chars in string? */
159 if ( (endptr == s) || (*endptr != '\0') ) {
160 (void) fprintf(stderr, "String '%s' is not a valid number string.\n", s);
165 /* is the range valid? */
166 if ( (((value == LONG_MAX) || (value == LONG_MIN)) && (errno == ERANGE)) ||
167 (value > INT_MAX) || (value < INT_MIN)) {
169 (void) fprintf(stderr, "Value of string '%s' is %s than %d.\n", s,
170 (value < 0) ? "smaller": "larger",
171 (value < 0) ? INT_MIN : INT_MAX);
176 return (int) value; /* shut up, I know what I'm doing */
180 # if defined (STDC_HEADERS)
186 /* We do only base 10 conversions here (atoi)! */
189 /* check for leading white spaces */
190 for (i = 0; (i < len) && isspace(s[i]); i++)
196 if (i < len && (s[i] == '+' || s[i] == '-')) i++;
198 /* skip over digits */
199 for ( /* no init */ ; (i < len) && isdigit(s[i]); i++)
202 /* check for trailing garbage */
204 (void) fprintf(stderr, "String '%s' is not a valid number string.\n", s);
209 /* atoi should be safe by now, except for number range over/underflow */
214 int parsecmdline (argc, argv, rctl, ctl)
215 /* parse and validate the command line options */
216 int argc; /* argument count */
217 char **argv; /* argument strings */
218 struct runctl *rctl; /* global run controls to modify */
219 struct query *ctl; /* option record to be initialized */
222 * return value: if positive, argv index of last parsed option + 1
223 * (presumes one or more server names follows). if zero, the
224 * command line switches are such that no server names are
225 * required (e.g. --version). if negative, the command line is
226 * has one or more syntax errors.
230 int ocount = 0; /* count of destinations specified */
231 int errflag = 0; /* TRUE when a syntax error is detected */
235 rctl->poll_interval = -1;
237 memset(ctl, '\0', sizeof(struct query)); /* start clean */
238 ctl->smtp_socket = -1;
241 (c = getopt_long(argc,argv,shortoptions,
242 longoptions,&option_index)) != -1) {
259 outlevel = O_VERBOSE;
263 rctl->poll_interval = xatoi(optarg, &errflag);
275 rctl->logfile = optarg;
278 rctl->invisible = TRUE;
282 rcfile = (char *) xmalloc(strlen(optarg)+1);
283 strcpy(rcfile,optarg);
287 rctl->idfile = (char *) xmalloc(strlen(optarg)+1);
288 strcpy(rctl->idfile,optarg);
291 rctl->postmaster = (char *) xmalloc(strlen(optarg)+1);
295 /* XXX -- should probably use a table lookup here */
296 if (strcasecmp(optarg,"pop2") == 0)
297 ctl->server.protocol = P_POP2;
299 else if (strcasecmp(optarg,"sdps") == 0)
301 ctl->server.protocol = P_POP3;
302 ctl->server.sdps = TRUE;
304 #endif /* SDPS_ENABLE */
305 else if (strcasecmp(optarg,"pop3") == 0)
306 ctl->server.protocol = P_POP3;
307 else if (strcasecmp(optarg,"apop") == 0)
308 ctl->server.protocol = P_APOP;
309 else if (strcasecmp(optarg,"rpop") == 0)
310 ctl->server.protocol = P_RPOP;
311 else if (strcasecmp(optarg,"kpop") == 0)
313 ctl->server.protocol = P_POP3;
315 ctl->server.service = KPOP_PORT;
317 ctl->server.port = KPOP_PORT;
320 ctl->server.preauthenticate = A_KERBEROS_V5;
322 ctl->server.preauthenticate = A_KERBEROS_V4;
323 #endif /* KERBEROS_V5 */
325 else if (strcasecmp(optarg,"imap") == 0)
326 ctl->server.protocol = P_IMAP;
328 else if (strcasecmp(optarg,"imap-k4") == 0)
329 ctl->server.protocol = P_IMAP_K4;
330 #endif /* KERBEROS_V4 */
332 else if (strcasecmp(optarg, "imap-gss") == 0)
333 ctl->server.protocol = P_IMAP_GSS;
335 else if (strcasecmp(optarg,"etrn") == 0)
336 ctl->server.protocol = P_ETRN;
338 fprintf(stderr,"Invalid protocol `%s' specified.\n", optarg);
344 ctl->server.uidl = FLAG_TRUE;
349 ctl->server.service = optarg;
351 ctl->server.port = xatoi(optarg, &errflag);
355 case LA_AUTHENTICATE:
356 if (strcmp(optarg, "password") == 0)
357 ctl->server.preauthenticate = A_PASSWORD;
358 else if (strcmp(optarg, "kerberos") == 0)
360 ctl->server.preauthenticate = A_KERBEROS_V5;
361 else if (strcmp(optarg, "kerberos_v5") == 0)
362 ctl->server.preauthenticate = A_KERBEROS_V5;
364 ctl->server.preauthenticate = A_KERBEROS_V4;
365 else if (strcmp(optarg, "kerberos_v4") == 0)
366 ctl->server.preauthenticate = A_KERBEROS_V4;
367 #endif /* KERBEROS_V5 */
369 fprintf(stderr,"Invalid preauthentication `%s' specified.\n", optarg);
375 ctl->server.timeout = xatoi(optarg, &errflag);
376 if (ctl->server.timeout == 0)
377 ctl->server.timeout = -1;
381 ctl->server.envelope = xstrdup(optarg);
385 ctl->server.qvirtual = xstrdup(optarg);
390 ctl->remotename = xstrdup(optarg);
394 ctl->fetchall = FLAG_TRUE;
398 ctl->keep = FLAG_FALSE;
402 ctl->keep = FLAG_TRUE;
406 ctl->flush = FLAG_TRUE;
410 ctl->rewrite = FLAG_FALSE;
414 c = xatoi(optarg, &errflag);
415 ctl->limit = NUM_VALUE(c);
419 buf = alloca(strlen(optarg));
421 cp = strtok(buf, ",");
423 save_str(&ctl->mailboxes, cp, 0);
425 ((cp = strtok((char *)NULL, ",")));
429 buf = alloca(strlen(optarg));
431 cp = strtok(buf, ",");
433 save_str(&ctl->smtphunt, cp, TRUE);
435 ((cp = strtok((char *)NULL, ",")));
440 ctl->smtpaddress = xstrdup(optarg);
444 buf = alloca(strlen(optarg));
446 cp = strtok(buf, ",");
448 struct idlist *idp = save_str(&ctl->antispam, NULL, 0);;
450 idp->val.status.num = atoi(cp);
452 ((cp = strtok((char *)NULL, ",")));
456 c = xatoi(optarg, &errflag);
457 ctl->batchlimit = NUM_VALUE(c);
461 c = xatoi(optarg, &errflag);
462 ctl->fetchlimit = NUM_VALUE(c);
466 c = xatoi(optarg, &errflag);
467 ctl->expunge = NUM_VALUE(c);
471 ctl->mda = xstrdup(optarg);
478 ctl->server.netsec = (void *)optarg;
480 fprintf(stderr, "fetchmail: network security support is disabled\n");
482 #endif /* NET_SECURITY */
485 #if defined(linux) && !INET6
488 interface_parse(optarg, &ctl->server);
492 ctl->server.monitor = xstrdup(optarg);
494 #endif /* defined(linux) && !INET6 */
503 c = xatoi(optarg, &errflag);
504 ctl->warnings = NUM_VALUE(c);
512 rctl->use_syslog = FLAG_TRUE;
516 rctl->use_syslog = FLAG_FALSE;
526 if (errflag || ocount > 1) {
527 /* squawk if syntax errors were detected */
528 fputs("usage: fetchmail [options] [server ...]\n", stderr);
529 fputs(" Options are as follows:\n",stderr);
530 fputs(" -?, --help display this option help\n", stderr);
531 fputs(" -V, --version display version info\n", stderr);
533 fputs(" -c, --check check for messages without fetching\n", stderr);
534 fputs(" -s, --silent work silently\n", stderr);
535 fputs(" -v, --verbose work noisily (diagnostic output)\n", stderr);
536 fputs(" -d, --daemon run as a daemon once per n seconds\n", stderr);
537 fputs(" -N, --nodetach don't detach daemon process\n", stderr);
538 fputs(" -q, --quit kill daemon process\n", stderr);
539 fputs(" -L, --logfile specify logfile name\n", stderr);
540 fputs(" --syslog use syslog(3) for most messages when running as a daemon\n", stderr);
541 fputs(" --invisible suppress Received line & enable host spoofing\n", stderr);
542 fputs(" -f, --fetchmailrc specify alternate run control file\n", stderr);
543 fputs(" -i, --idfile specify alternate UIDs file\n", stderr);
544 fputs(" --postmaster specify recipient of last resort\n",stderr);
545 #if defined(linux) && !INET6
546 fputs(" -I, --interface interface required specification\n",stderr);
547 fputs(" -M, --monitor monitor interface for activity\n",stderr);
551 fputs(" -p, --protocol specify pop2, pop3, imap, apop, rpop, kpop, etrn, imap-k4\n", stderr);
553 fputs(" -p, --protocol specify pop2, pop3, imap, apop, rpop, kpop, etrn\n", stderr);
554 #endif /* KERBEROS_V4 */
555 fputs(" -U, --uidl force the use of UIDLs (pop3 only)\n", stderr);
556 fputs(" -P, --port TCP/IP service port to connect to\n",stderr);
557 fputs(" -A, --auth authentication type (password or kerberos)\n",stderr);
558 fputs(" -t, --timeout server nonresponse timeout\n",stderr);
559 fputs(" -E, --envelope envelope address header\n",stderr);
560 fputs(" -Q, --qvirtual prefix to remove from local user id\n",stderr);
562 fputs(" -u, --username specify users's login on server\n", stderr);
563 fputs(" -a, --all retrieve old and new messages\n", stderr);
564 fputs(" -K, --nokeep delete new messages after retrieval\n", stderr);
565 fputs(" -k, --keep save new messages after retrieval\n", stderr);
566 fputs(" -F, --flush delete old messages from server\n", stderr);
567 fputs(" -n, --norewrite don't rewrite header addresses\n", stderr);
568 fputs(" -l, --limit don't fetch messages over given size\n", stderr);
569 fputs(" -w, --warnings interval between warning mail notification\n", stderr);
572 fputs(" -T, --netsec set IP security request\n", stderr);
573 #endif /* NET_SECURITY */
574 fputs(" -S, --smtphost set SMTP forwarding host\n", stderr);
575 fputs(" -D, --smtpaddress set SMTP delivery domain to use\n", stderr);
576 fputs(" -Z, --antispam, set antispam response values\n", stderr);
577 fputs(" -b, --batchlimit set batch limit for SMTP connections\n", stderr);
578 fputs(" -B, --fetchlimit set fetch limit for server connections\n", stderr);
579 fputs(" -e, --expunge set max deletions between expunges\n", stderr);
580 fputs(" -r, --folder specify remote folder name\n", stderr);
587 /* options.c ends here */