xref: /freebsd/bin/sh/options.c (revision e28a4053)
1 /*-
2  * Copyright (c) 1991, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Kenneth Almquist.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 4. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 #ifndef lint
34 #if 0
35 static char sccsid[] = "@(#)options.c	8.2 (Berkeley) 5/4/95";
36 #endif
37 #endif /* not lint */
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
40 
41 #include <signal.h>
42 #include <unistd.h>
43 #include <stdlib.h>
44 
45 #include "shell.h"
46 #define DEFINE_OPTIONS
47 #include "options.h"
48 #undef DEFINE_OPTIONS
49 #include "nodes.h"	/* for other header files */
50 #include "eval.h"
51 #include "jobs.h"
52 #include "input.h"
53 #include "output.h"
54 #include "trap.h"
55 #include "var.h"
56 #include "memalloc.h"
57 #include "error.h"
58 #include "mystring.h"
59 #ifndef NO_HISTORY
60 #include "myhistedit.h"
61 #endif
62 
63 char *arg0;			/* value of $0 */
64 struct shparam shellparam;	/* current positional parameters */
65 char **argptr;			/* argument list for builtin commands */
66 char *shoptarg;			/* set by nextopt (like getopt) */
67 char *nextopt_optptr;		/* used by nextopt */
68 
69 char *minusc;			/* argument to -c option */
70 
71 
72 static void options(int);
73 static void minus_o(char *, int);
74 static void setoption(int, int);
75 static int getopts(char *, char *, char **, char ***, char **);
76 
77 
78 /*
79  * Process the shell command line arguments.
80  */
81 
82 void
83 procargs(int argc, char **argv)
84 {
85 	int i;
86 
87 	argptr = argv;
88 	if (argc > 0)
89 		argptr++;
90 	for (i = 0; i < NOPTS; i++)
91 		optlist[i].val = 2;
92 	privileged = (getuid() != geteuid() || getgid() != getegid());
93 	options(1);
94 	if (*argptr == NULL && minusc == NULL)
95 		sflag = 1;
96 	if (iflag != 0 && sflag == 1 && isatty(0) && isatty(1)) {
97 		iflag = 1;
98 		if (Eflag == 2)
99 			Eflag = 1;
100 	}
101 	if (mflag == 2)
102 		mflag = iflag;
103 	for (i = 0; i < NOPTS; i++)
104 		if (optlist[i].val == 2)
105 			optlist[i].val = 0;
106 	arg0 = argv[0];
107 	if (sflag == 0 && minusc == NULL) {
108 		commandname = arg0 = *argptr++;
109 		setinputfile(commandname, 0);
110 	}
111 	/* POSIX 1003.2: first arg after -c cmd is $0, remainder $1... */
112 	if (argptr && minusc && *argptr)
113 		arg0 = *argptr++;
114 
115 	shellparam.p = argptr;
116 	shellparam.reset = 1;
117 	/* assert(shellparam.malloc == 0 && shellparam.nparam == 0); */
118 	while (*argptr) {
119 		shellparam.nparam++;
120 		argptr++;
121 	}
122 	optschanged();
123 }
124 
125 
126 void
127 optschanged(void)
128 {
129 	setinteractive(iflag);
130 #ifndef NO_HISTORY
131 	histedit();
132 #endif
133 	setjobctl(mflag);
134 }
135 
136 /*
137  * Process shell options.  The global variable argptr contains a pointer
138  * to the argument list; we advance it past the options.
139  */
140 
141 static void
142 options(int cmdline)
143 {
144 	char *kp, *p;
145 	int val;
146 	int c;
147 
148 	if (cmdline)
149 		minusc = NULL;
150 	while ((p = *argptr) != NULL) {
151 		argptr++;
152 		if ((c = *p++) == '-') {
153 			val = 1;
154 			/* A "-" or  "--" terminates options */
155 			if (p[0] == '\0')
156 				goto end_options1;
157 			if (p[0] == '-' && p[1] == '\0')
158 				goto end_options2;
159 			/**
160 			 * For the benefit of `#!' lines in shell scripts,
161 			 * treat a string of '-- *#.*' the same as '--'.
162 			 * This is needed so that a script starting with:
163 			 *	#!/bin/sh -- # -*- perl -*-
164 			 * will continue to work after a change is made to
165 			 * kern/imgact_shell.c to NOT token-ize the options
166 			 * specified on a '#!' line.  A bit of a kludge,
167 			 * but that trick is recommended in documentation
168 			 * for some scripting languages, and we might as
169 			 * well continue to support it.
170 			 */
171 			if (p[0] == '-') {
172 				kp = p + 1;
173 				while (*kp == ' ' || *kp == '\t')
174 					kp++;
175 				if (*kp == '#' || *kp == '\0')
176 					goto end_options2;
177 			}
178 		} else if (c == '+') {
179 			val = 0;
180 		} else {
181 			argptr--;
182 			break;
183 		}
184 		while ((c = *p++) != '\0') {
185 			if (c == 'c' && cmdline) {
186 				char *q;
187 #ifdef NOHACK	/* removing this code allows sh -ce 'foo' for compat */
188 				if (*p == '\0')
189 #endif
190 					q = *argptr++;
191 				if (q == NULL || minusc != NULL)
192 					error("Bad -c option");
193 				minusc = q;
194 #ifdef NOHACK
195 				break;
196 #endif
197 			} else if (c == 'o') {
198 				minus_o(*argptr, val);
199 				if (*argptr)
200 					argptr++;
201 			} else {
202 				if (c == 'p' && !val && privileged) {
203 					(void) setuid(getuid());
204 					(void) setgid(getgid());
205 				}
206 				setoption(c, val);
207 			}
208 		}
209 	}
210 	return;
211 
212 	/* When processing `set', a single "-" means turn off -x and -v */
213 end_options1:
214 	if (!cmdline) {
215 		xflag = vflag = 0;
216 		return;
217 	}
218 
219 	/*
220 	 * When processing `set', a "--" means the remaining arguments
221 	 * replace the positional parameters in the active shell.  If
222 	 * there are no remaining options, then all the positional
223 	 * parameters are cleared (equivalent to doing ``shift $#'').
224 	 */
225 end_options2:
226 	if (!cmdline) {
227 		if (*argptr == NULL)
228 			setparam(argptr);
229 		return;
230 	}
231 
232 	/*
233 	 * At this point we are processing options given to 'sh' on a command
234 	 * line.  If an end-of-options marker ("-" or "--") is followed by an
235 	 * arg of "#", then skip over all remaining arguments.  Some scripting
236 	 * languages (e.g.: perl) document that /bin/sh will implement this
237 	 * behavior, and they recommend that users take advantage of it to
238 	 * solve certain issues that can come up when writing a perl script.
239 	 * Yes, this feature is in /bin/sh to help users write perl scripts.
240 	 */
241 	p = *argptr;
242 	if (p != NULL && p[0] == '#' && p[1] == '\0') {
243 		while (*argptr != NULL)
244 			argptr++;
245 		/* We need to keep the final argument */
246 		argptr--;
247 	}
248 }
249 
250 static void
251 minus_o(char *name, int val)
252 {
253 	int i;
254 
255 	if (name == NULL) {
256 		if (val) {
257 			/* "Pretty" output. */
258 			out1str("Current option settings\n");
259 			for (i = 0; i < NOPTS; i++)
260 				out1fmt("%-16s%s\n", optlist[i].name,
261 					optlist[i].val ? "on" : "off");
262 		} else {
263 			/* Output suitable for re-input to shell. */
264 			for (i = 0; i < NOPTS; i++) {
265 				if (i % 6 == 0)
266 					out1str(i == 0 ? "set" : "\nset");
267 				out1fmt(" %co %s", optlist[i].val ? '-' : '+',
268 					optlist[i].name);
269 			}
270 			out1c('\n');
271 		}
272 	} else {
273 		for (i = 0; i < NOPTS; i++)
274 			if (equal(name, optlist[i].name)) {
275 				if (!val && privileged && equal(name, "privileged")) {
276 					(void) setuid(getuid());
277 					(void) setgid(getgid());
278 				}
279 				setoption(optlist[i].letter, val);
280 				return;
281 			}
282 		error("Illegal option -o %s", name);
283 	}
284 }
285 
286 
287 static void
288 setoption(int flag, int val)
289 {
290 	int i;
291 
292 	for (i = 0; i < NOPTS; i++)
293 		if (optlist[i].letter == flag) {
294 			optlist[i].val = val;
295 			if (val) {
296 				/* #%$ hack for ksh semantics */
297 				if (flag == 'V')
298 					Eflag = 0;
299 				else if (flag == 'E')
300 					Vflag = 0;
301 			}
302 			return;
303 		}
304 	error("Illegal option -%c", flag);
305 }
306 
307 
308 
309 #ifdef mkinit
310 INCLUDE "options.h"
311 
312 SHELLPROC {
313 	int i;
314 
315 	for (i = 0; i < NOPTS; i++)
316 		optlist[i].val = 0;
317 	optschanged();
318 
319 }
320 #endif
321 
322 
323 /*
324  * Set the shell parameters.
325  */
326 
327 void
328 setparam(char **argv)
329 {
330 	char **newparam;
331 	char **ap;
332 	int nparam;
333 
334 	for (nparam = 0 ; argv[nparam] ; nparam++);
335 	ap = newparam = ckmalloc((nparam + 1) * sizeof *ap);
336 	while (*argv) {
337 		*ap++ = savestr(*argv++);
338 	}
339 	*ap = NULL;
340 	freeparam(&shellparam);
341 	shellparam.malloc = 1;
342 	shellparam.nparam = nparam;
343 	shellparam.p = newparam;
344 	shellparam.reset = 1;
345 	shellparam.optnext = NULL;
346 }
347 
348 
349 /*
350  * Free the list of positional parameters.
351  */
352 
353 void
354 freeparam(struct shparam *param)
355 {
356 	char **ap;
357 
358 	if (param->malloc) {
359 		for (ap = param->p ; *ap ; ap++)
360 			ckfree(*ap);
361 		ckfree(param->p);
362 	}
363 }
364 
365 
366 
367 /*
368  * The shift builtin command.
369  */
370 
371 int
372 shiftcmd(int argc, char **argv)
373 {
374 	int n;
375 	char **ap1, **ap2;
376 
377 	n = 1;
378 	if (argc > 1)
379 		n = number(argv[1]);
380 	if (n > shellparam.nparam)
381 		return 1;
382 	INTOFF;
383 	shellparam.nparam -= n;
384 	for (ap1 = shellparam.p ; --n >= 0 ; ap1++) {
385 		if (shellparam.malloc)
386 			ckfree(*ap1);
387 	}
388 	ap2 = shellparam.p;
389 	while ((*ap2++ = *ap1++) != NULL);
390 	shellparam.reset = 1;
391 	INTON;
392 	return 0;
393 }
394 
395 
396 
397 /*
398  * The set command builtin.
399  */
400 
401 int
402 setcmd(int argc, char **argv)
403 {
404 	if (argc == 1)
405 		return showvarscmd(argc, argv);
406 	INTOFF;
407 	options(0);
408 	optschanged();
409 	if (*argptr != NULL) {
410 		setparam(argptr);
411 	}
412 	INTON;
413 	return 0;
414 }
415 
416 
417 void
418 getoptsreset(const char *value)
419 {
420 	if (number(value) == 1) {
421 		shellparam.reset = 1;
422 	}
423 }
424 
425 /*
426  * The getopts builtin.  Shellparam.optnext points to the next argument
427  * to be processed.  Shellparam.optptr points to the next character to
428  * be processed in the current argument.  If shellparam.optnext is NULL,
429  * then it's the first time getopts has been called.
430  */
431 
432 int
433 getoptscmd(int argc, char **argv)
434 {
435 	char **optbase = NULL;
436 
437 	if (argc < 3)
438 		error("usage: getopts optstring var [arg]");
439 	else if (argc == 3)
440 		optbase = shellparam.p;
441 	else
442 		optbase = &argv[3];
443 
444 	if (shellparam.reset == 1) {
445 		shellparam.optnext = optbase;
446 		shellparam.optptr = NULL;
447 		shellparam.reset = 0;
448 	}
449 
450 	return getopts(argv[1], argv[2], optbase, &shellparam.optnext,
451 		       &shellparam.optptr);
452 }
453 
454 static int
455 getopts(char *optstr, char *optvar, char **optfirst, char ***optnext,
456     char **optptr)
457 {
458 	char *p, *q;
459 	char c = '?';
460 	int done = 0;
461 	int ind = 0;
462 	int err = 0;
463 	char s[10];
464 
465 	if ((p = *optptr) == NULL || *p == '\0') {
466 		/* Current word is done, advance */
467 		if (*optnext == NULL)
468 			return 1;
469 		p = **optnext;
470 		if (p == NULL || *p != '-' || *++p == '\0') {
471 atend:
472 			ind = *optnext - optfirst + 1;
473 			*optnext = NULL;
474 			p = NULL;
475 			done = 1;
476 			goto out;
477 		}
478 		(*optnext)++;
479 		if (p[0] == '-' && p[1] == '\0')	/* check for "--" */
480 			goto atend;
481 	}
482 
483 	c = *p++;
484 	for (q = optstr; *q != c; ) {
485 		if (*q == '\0') {
486 			if (optstr[0] == ':') {
487 				s[0] = c;
488 				s[1] = '\0';
489 				err |= setvarsafe("OPTARG", s, 0);
490 			}
491 			else {
492 				out1fmt("Illegal option -%c\n", c);
493 				(void) unsetvar("OPTARG");
494 			}
495 			c = '?';
496 			goto bad;
497 		}
498 		if (*++q == ':')
499 			q++;
500 	}
501 
502 	if (*++q == ':') {
503 		if (*p == '\0' && (p = **optnext) == NULL) {
504 			if (optstr[0] == ':') {
505 				s[0] = c;
506 				s[1] = '\0';
507 				err |= setvarsafe("OPTARG", s, 0);
508 				c = ':';
509 			}
510 			else {
511 				out1fmt("No arg for -%c option\n", c);
512 				(void) unsetvar("OPTARG");
513 				c = '?';
514 			}
515 			goto bad;
516 		}
517 
518 		if (p == **optnext)
519 			(*optnext)++;
520 		setvarsafe("OPTARG", p, 0);
521 		p = NULL;
522 	}
523 	else
524 		setvarsafe("OPTARG", "", 0);
525 	ind = *optnext - optfirst + 1;
526 	goto out;
527 
528 bad:
529 	ind = 1;
530 	*optnext = NULL;
531 	p = NULL;
532 out:
533 	*optptr = p;
534 	fmtstr(s, sizeof(s), "%d", ind);
535 	err |= setvarsafe("OPTIND", s, VNOFUNC);
536 	s[0] = c;
537 	s[1] = '\0';
538 	err |= setvarsafe(optvar, s, 0);
539 	if (err) {
540 		*optnext = NULL;
541 		*optptr = NULL;
542 		flushall();
543 		exraise(EXERROR);
544 	}
545 	return done;
546 }
547 
548 /*
549  * XXX - should get rid of.  have all builtins use getopt(3).  the
550  * library getopt must have the BSD extension static variable "optreset"
551  * otherwise it can't be used within the shell safely.
552  *
553  * Standard option processing (a la getopt) for builtin routines.  The
554  * only argument that is passed to nextopt is the option string; the
555  * other arguments are unnecessary.  It return the character, or '\0' on
556  * end of input.
557  */
558 
559 int
560 nextopt(const char *optstring)
561 {
562 	char *p;
563 	const char *q;
564 	char c;
565 
566 	if ((p = nextopt_optptr) == NULL || *p == '\0') {
567 		p = *argptr;
568 		if (p == NULL || *p != '-' || *++p == '\0')
569 			return '\0';
570 		argptr++;
571 		if (p[0] == '-' && p[1] == '\0')	/* check for "--" */
572 			return '\0';
573 	}
574 	c = *p++;
575 	for (q = optstring ; *q != c ; ) {
576 		if (*q == '\0')
577 			error("Illegal option -%c", c);
578 		if (*++q == ':')
579 			q++;
580 	}
581 	if (*++q == ':') {
582 		if (*p == '\0' && (p = *argptr++) == NULL)
583 			error("No arg for -%c option", c);
584 		shoptarg = p;
585 		p = NULL;
586 	}
587 	nextopt_optptr = p;
588 	return c;
589 }
590