Patch-ID: bash41-008
[bash.git] / test.c
blob180940c9ca9b4eff08d8256e7b72d31cd409111b
1 /* test.c - GNU test program (ksb and mjb) */
3 /* Modified to run with the GNU shell Apr 25, 1988 by bfox. */
5 /* Copyright (C) 1987-2009 Free Software Foundation, Inc.
7 This file is part of GNU Bash, the Bourne Again SHell.
9 Bash is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 Bash is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with Bash. If not, see <http://www.gnu.org/licenses/>.
23 /* Define PATTERN_MATCHING to get the csh-like =~ and !~ pattern-matching
24 binary operators. */
25 /* #define PATTERN_MATCHING */
27 #if defined (HAVE_CONFIG_H)
28 # include <config.h>
29 #endif
31 #include <stdio.h>
33 #include "bashtypes.h"
35 #if !defined (HAVE_LIMITS_H)
36 # include <sys/param.h>
37 #endif
39 #if defined (HAVE_UNISTD_H)
40 # include <unistd.h>
41 #endif
43 #include <errno.h>
44 #if !defined (errno)
45 extern int errno;
46 #endif /* !errno */
48 #if !defined (_POSIX_VERSION) && defined (HAVE_SYS_FILE_H)
49 # include <sys/file.h>
50 #endif /* !_POSIX_VERSION */
51 #include "posixstat.h"
52 #include "filecntl.h"
54 #include "bashintl.h"
56 #include "shell.h"
57 #include "pathexp.h"
58 #include "test.h"
59 #include "builtins/common.h"
61 #include <glob/strmatch.h>
63 #if !defined (STRLEN)
64 # define STRLEN(s) ((s)[0] ? ((s)[1] ? ((s)[2] ? strlen(s) : 2) : 1) : 0)
65 #endif
67 #if !defined (STREQ)
68 # define STREQ(a, b) ((a)[0] == (b)[0] && strcmp ((a), (b)) == 0)
69 #endif /* !STREQ */
70 #define STRCOLLEQ(a, b) ((a)[0] == (b)[0] && strcoll ((a), (b)) == 0)
72 #if !defined (R_OK)
73 #define R_OK 4
74 #define W_OK 2
75 #define X_OK 1
76 #define F_OK 0
77 #endif /* R_OK */
79 #define EQ 0
80 #define NE 1
81 #define LT 2
82 #define GT 3
83 #define LE 4
84 #define GE 5
86 #define NT 0
87 #define OT 1
88 #define EF 2
90 /* The following few defines control the truth and false output of each stage.
91 TRUE and FALSE are what we use to compute the final output value.
92 SHELL_BOOLEAN is the form which returns truth or falseness in shell terms.
93 Default is TRUE = 1, FALSE = 0, SHELL_BOOLEAN = (!value). */
94 #define TRUE 1
95 #define FALSE 0
96 #define SHELL_BOOLEAN(value) (!(value))
98 #define TEST_ERREXIT_STATUS 2
100 static procenv_t test_exit_buf;
101 static int test_error_return;
102 #define test_exit(val) \
103 do { test_error_return = val; longjmp (test_exit_buf, 1); } while (0)
105 extern int sh_stat __P((const char *, struct stat *));
107 static int pos; /* The offset of the current argument in ARGV. */
108 static int argc; /* The number of arguments present in ARGV. */
109 static char **argv; /* The argument list. */
110 static int noeval;
112 static void test_syntax_error __P((char *, char *)) __attribute__((__noreturn__));
113 static void beyond __P((void)) __attribute__((__noreturn__));
114 static void integer_expected_error __P((char *)) __attribute__((__noreturn__));
116 static int unary_operator __P((void));
117 static int binary_operator __P((void));
118 static int two_arguments __P((void));
119 static int three_arguments __P((void));
120 static int posixtest __P((void));
122 static int expr __P((void));
123 static int term __P((void));
124 static int and __P((void));
125 static int or __P((void));
127 static int filecomp __P((char *, char *, int));
128 static int arithcomp __P((char *, char *, int, int));
129 static int patcomp __P((char *, char *, int));
131 static void
132 test_syntax_error (format, arg)
133 char *format, *arg;
135 builtin_error (format, arg);
136 test_exit (TEST_ERREXIT_STATUS);
140 * beyond - call when we're beyond the end of the argument list (an
141 * error condition)
143 static void
144 beyond ()
146 test_syntax_error (_("argument expected"), (char *)NULL);
149 /* Syntax error for when an integer argument was expected, but
150 something else was found. */
151 static void
152 integer_expected_error (pch)
153 char *pch;
155 test_syntax_error (_("%s: integer expression expected"), pch);
158 /* Increment our position in the argument list. Check that we're not
159 past the end of the argument list. This check is supressed if the
160 argument is FALSE. Made a macro for efficiency. */
161 #define advance(f) do { ++pos; if (f && pos >= argc) beyond (); } while (0)
162 #define unary_advance() do { advance (1); ++pos; } while (0)
165 * expr:
166 * or
168 static int
169 expr ()
171 if (pos >= argc)
172 beyond ();
174 return (FALSE ^ or ()); /* Same with this. */
178 * or:
179 * and
180 * and '-o' or
182 static int
183 or ()
185 int value, v2;
187 value = and ();
188 if (pos < argc && argv[pos][0] == '-' && argv[pos][1] == 'o' && !argv[pos][2])
190 advance (0);
191 v2 = or ();
192 return (value || v2);
195 return (value);
199 * and:
200 * term
201 * term '-a' and
203 static int
204 and ()
206 int value, v2;
208 value = term ();
209 if (pos < argc && argv[pos][0] == '-' && argv[pos][1] == 'a' && !argv[pos][2])
211 advance (0);
212 v2 = and ();
213 return (value && v2);
215 return (value);
219 * term - parse a term and return 1 or 0 depending on whether the term
220 * evaluates to true or false, respectively.
222 * term ::=
223 * '-'('a'|'b'|'c'|'d'|'e'|'f'|'g'|'h'|'k'|'p'|'r'|'s'|'u'|'w'|'x') filename
224 * '-'('G'|'L'|'O'|'S'|'N') filename
225 * '-t' [int]
226 * '-'('z'|'n') string
227 * '-o' option
228 * string
229 * string ('!='|'='|'==') string
230 * <int> '-'(eq|ne|le|lt|ge|gt) <int>
231 * file '-'(nt|ot|ef) file
232 * '(' <expr> ')'
233 * int ::=
234 * positive and negative integers
236 static int
237 term ()
239 int value;
241 if (pos >= argc)
242 beyond ();
244 /* Deal with leading `not's. */
245 if (argv[pos][0] == '!' && argv[pos][1] == '\0')
247 value = 0;
248 while (pos < argc && argv[pos][0] == '!' && argv[pos][1] == '\0')
250 advance (1);
251 value = 1 - value;
254 return (value ? !term() : term());
257 /* A paren-bracketed argument. */
258 if (argv[pos][0] == '(' && argv[pos][1] == '\0') /* ) */
260 advance (1);
261 value = expr ();
262 if (argv[pos] == 0) /* ( */
263 test_syntax_error (_("`)' expected"), (char *)NULL);
264 else if (argv[pos][0] != ')' || argv[pos][1]) /* ( */
265 test_syntax_error (_("`)' expected, found %s"), argv[pos]);
266 advance (0);
267 return (value);
270 /* are there enough arguments left that this could be dyadic? */
271 if ((pos + 3 <= argc) && test_binop (argv[pos + 1]))
272 value = binary_operator ();
274 /* Might be a switch type argument */
275 else if (argv[pos][0] == '-' && argv[pos][2] == '\0')
277 if (test_unop (argv[pos]))
278 value = unary_operator ();
279 else
280 test_syntax_error (_("%s: unary operator expected"), argv[pos]);
282 else
284 value = argv[pos][0] != '\0';
285 advance (0);
288 return (value);
291 static int
292 filecomp (s, t, op)
293 char *s, *t;
294 int op;
296 struct stat st1, st2;
297 int r1, r2;
299 if ((r1 = sh_stat (s, &st1)) < 0)
301 if (op == EF)
302 return (FALSE);
304 if ((r2 = sh_stat (t, &st2)) < 0)
306 if (op == EF)
307 return (FALSE);
310 switch (op)
312 case OT: return (r1 < r2 || (r2 == 0 && st1.st_mtime < st2.st_mtime));
313 case NT: return (r1 > r2 || (r1 == 0 && st1.st_mtime > st2.st_mtime));
314 case EF: return (same_file (s, t, &st1, &st2));
316 return (FALSE);
319 static int
320 arithcomp (s, t, op, flags)
321 char *s, *t;
322 int op, flags;
324 intmax_t l, r;
325 int expok;
327 if (flags & TEST_ARITHEXP)
329 l = evalexp (s, &expok);
330 if (expok == 0)
331 return (FALSE); /* should probably longjmp here */
332 r = evalexp (t, &expok);
333 if (expok == 0)
334 return (FALSE); /* ditto */
336 else
338 if (legal_number (s, &l) == 0)
339 integer_expected_error (s);
340 if (legal_number (t, &r) == 0)
341 integer_expected_error (t);
344 switch (op)
346 case EQ: return (l == r);
347 case NE: return (l != r);
348 case LT: return (l < r);
349 case GT: return (l > r);
350 case LE: return (l <= r);
351 case GE: return (l >= r);
354 return (FALSE);
357 static int
358 patcomp (string, pat, op)
359 char *string, *pat;
360 int op;
362 int m;
364 m = strmatch (pat, string, FNMATCH_EXTFLAG|FNMATCH_IGNCASE);
365 return ((op == EQ) ? (m == 0) : (m != 0));
369 binary_test (op, arg1, arg2, flags)
370 char *op, *arg1, *arg2;
371 int flags;
373 int patmatch;
375 patmatch = (flags & TEST_PATMATCH);
377 if (op[0] == '=' && (op[1] == '\0' || (op[1] == '=' && op[2] == '\0')))
378 return (patmatch ? patcomp (arg1, arg2, EQ) : STREQ (arg1, arg2));
379 else if ((op[0] == '>' || op[0] == '<') && op[1] == '\0')
381 if (shell_compatibility_level > 40 && flags & TEST_LOCALE)
382 return ((op[0] == '>') ? (strcoll (arg1, arg2) > 0) : (strcoll (arg1, arg2) < 0));
383 else
384 return ((op[0] == '>') ? (strcmp (arg1, arg2) > 0) : (strcmp (arg1, arg2) < 0));
386 else if (op[0] == '!' && op[1] == '=' && op[2] == '\0')
387 return (patmatch ? patcomp (arg1, arg2, NE) : (STREQ (arg1, arg2) == 0));
390 else if (op[2] == 't')
392 switch (op[1])
394 case 'n': return (filecomp (arg1, arg2, NT)); /* -nt */
395 case 'o': return (filecomp (arg1, arg2, OT)); /* -ot */
396 case 'l': return (arithcomp (arg1, arg2, LT, flags)); /* -lt */
397 case 'g': return (arithcomp (arg1, arg2, GT, flags)); /* -gt */
400 else if (op[1] == 'e')
402 switch (op[2])
404 case 'f': return (filecomp (arg1, arg2, EF)); /* -ef */
405 case 'q': return (arithcomp (arg1, arg2, EQ, flags)); /* -eq */
408 else if (op[2] == 'e')
410 switch (op[1])
412 case 'n': return (arithcomp (arg1, arg2, NE, flags)); /* -ne */
413 case 'g': return (arithcomp (arg1, arg2, GE, flags)); /* -ge */
414 case 'l': return (arithcomp (arg1, arg2, LE, flags)); /* -le */
418 return (FALSE); /* should never get here */
422 static int
423 binary_operator ()
425 int value;
426 char *w;
428 w = argv[pos + 1];
429 if ((w[0] == '=' && (w[1] == '\0' || (w[1] == '=' && w[2] == '\0'))) || /* =, == */
430 ((w[0] == '>' || w[0] == '<') && w[1] == '\0') || /* <, > */
431 (w[0] == '!' && w[1] == '=' && w[2] == '\0')) /* != */
433 value = binary_test (w, argv[pos], argv[pos + 2], 0);
434 pos += 3;
435 return (value);
438 #if defined (PATTERN_MATCHING)
439 if ((w[0] == '=' || w[0] == '!') && w[1] == '~' && w[2] == '\0')
441 value = patcomp (argv[pos], argv[pos + 2], w[0] == '=' ? EQ : NE);
442 pos += 3;
443 return (value);
445 #endif
447 if ((w[0] != '-' || w[3] != '\0') || test_binop (w) == 0)
449 test_syntax_error (_("%s: binary operator expected"), w);
450 /* NOTREACHED */
451 return (FALSE);
454 value = binary_test (w, argv[pos], argv[pos + 2], 0);
455 pos += 3;
456 return value;
459 static int
460 unary_operator ()
462 char *op;
463 intmax_t r;
465 op = argv[pos];
466 if (test_unop (op) == 0)
467 return (FALSE);
469 /* the only tricky case is `-t', which may or may not take an argument. */
470 if (op[1] == 't')
472 advance (0);
473 if (pos < argc)
475 if (legal_number (argv[pos], &r))
477 advance (0);
478 return (unary_test (op, argv[pos - 1]));
480 else
481 return (FALSE);
483 else
484 return (unary_test (op, "1"));
487 /* All of the unary operators take an argument, so we first call
488 unary_advance (), which checks to make sure that there is an
489 argument, and then advances pos right past it. This means that
490 pos - 1 is the location of the argument. */
491 unary_advance ();
492 return (unary_test (op, argv[pos - 1]));
496 unary_test (op, arg)
497 char *op, *arg;
499 intmax_t r;
500 struct stat stat_buf;
502 switch (op[1])
504 case 'a': /* file exists in the file system? */
505 case 'e':
506 return (sh_stat (arg, &stat_buf) == 0);
508 case 'r': /* file is readable? */
509 return (sh_eaccess (arg, R_OK) == 0);
511 case 'w': /* File is writeable? */
512 return (sh_eaccess (arg, W_OK) == 0);
514 case 'x': /* File is executable? */
515 return (sh_eaccess (arg, X_OK) == 0);
517 case 'O': /* File is owned by you? */
518 return (sh_stat (arg, &stat_buf) == 0 &&
519 (uid_t) current_user.euid == (uid_t) stat_buf.st_uid);
521 case 'G': /* File is owned by your group? */
522 return (sh_stat (arg, &stat_buf) == 0 &&
523 (gid_t) current_user.egid == (gid_t) stat_buf.st_gid);
525 case 'N':
526 return (sh_stat (arg, &stat_buf) == 0 &&
527 stat_buf.st_atime <= stat_buf.st_mtime);
529 case 'f': /* File is a file? */
530 if (sh_stat (arg, &stat_buf) < 0)
531 return (FALSE);
533 /* -f is true if the given file exists and is a regular file. */
534 #if defined (S_IFMT)
535 return (S_ISREG (stat_buf.st_mode) || (stat_buf.st_mode & S_IFMT) == 0);
536 #else
537 return (S_ISREG (stat_buf.st_mode));
538 #endif /* !S_IFMT */
540 case 'd': /* File is a directory? */
541 return (sh_stat (arg, &stat_buf) == 0 && (S_ISDIR (stat_buf.st_mode)));
543 case 's': /* File has something in it? */
544 return (sh_stat (arg, &stat_buf) == 0 && stat_buf.st_size > (off_t) 0);
546 case 'S': /* File is a socket? */
547 #if !defined (S_ISSOCK)
548 return (FALSE);
549 #else
550 return (sh_stat (arg, &stat_buf) == 0 && S_ISSOCK (stat_buf.st_mode));
551 #endif /* S_ISSOCK */
553 case 'c': /* File is character special? */
554 return (sh_stat (arg, &stat_buf) == 0 && S_ISCHR (stat_buf.st_mode));
556 case 'b': /* File is block special? */
557 return (sh_stat (arg, &stat_buf) == 0 && S_ISBLK (stat_buf.st_mode));
559 case 'p': /* File is a named pipe? */
560 #ifndef S_ISFIFO
561 return (FALSE);
562 #else
563 return (sh_stat (arg, &stat_buf) == 0 && S_ISFIFO (stat_buf.st_mode));
564 #endif /* S_ISFIFO */
566 case 'L': /* Same as -h */
567 case 'h': /* File is a symbolic link? */
568 #if !defined (S_ISLNK) || !defined (HAVE_LSTAT)
569 return (FALSE);
570 #else
571 return ((arg[0] != '\0') &&
572 (lstat (arg, &stat_buf) == 0) && S_ISLNK (stat_buf.st_mode));
573 #endif /* S_IFLNK && HAVE_LSTAT */
575 case 'u': /* File is setuid? */
576 return (sh_stat (arg, &stat_buf) == 0 && (stat_buf.st_mode & S_ISUID) != 0);
578 case 'g': /* File is setgid? */
579 return (sh_stat (arg, &stat_buf) == 0 && (stat_buf.st_mode & S_ISGID) != 0);
581 case 'k': /* File has sticky bit set? */
582 #if !defined (S_ISVTX)
583 /* This is not Posix, and is not defined on some Posix systems. */
584 return (FALSE);
585 #else
586 return (sh_stat (arg, &stat_buf) == 0 && (stat_buf.st_mode & S_ISVTX) != 0);
587 #endif
589 case 't': /* File fd is a terminal? */
590 if (legal_number (arg, &r) == 0)
591 return (FALSE);
592 return ((r == (int)r) && isatty ((int)r));
594 case 'n': /* True if arg has some length. */
595 return (arg[0] != '\0');
597 case 'z': /* True if arg has no length. */
598 return (arg[0] == '\0');
600 case 'o': /* True if option `arg' is set. */
601 return (minus_o_option_value (arg) == 1);
604 /* We can't actually get here, but this shuts up gcc. */
605 return (FALSE);
608 /* Return TRUE if OP is one of the test command's binary operators. */
610 test_binop (op)
611 char *op;
613 if (op[0] == '=' && op[1] == '\0')
614 return (1); /* '=' */
615 else if ((op[0] == '<' || op[0] == '>') && op[1] == '\0') /* string <, > */
616 return (1);
617 else if ((op[0] == '=' || op[0] == '!') && op[1] == '=' && op[2] == '\0')
618 return (1); /* `==' and `!=' */
619 #if defined (PATTERN_MATCHING)
620 else if (op[2] == '\0' && op[1] == '~' && (op[0] == '=' || op[0] == '!'))
621 return (1);
622 #endif
623 else if (op[0] != '-' || op[2] == '\0' || op[3] != '\0')
624 return (0);
625 else
627 if (op[2] == 't')
628 switch (op[1])
630 case 'n': /* -nt */
631 case 'o': /* -ot */
632 case 'l': /* -lt */
633 case 'g': /* -gt */
634 return (1);
635 default:
636 return (0);
638 else if (op[1] == 'e')
639 switch (op[2])
641 case 'q': /* -eq */
642 case 'f': /* -ef */
643 return (1);
644 default:
645 return (0);
647 else if (op[2] == 'e')
648 switch (op[1])
650 case 'n': /* -ne */
651 case 'g': /* -ge */
652 case 'l': /* -le */
653 return (1);
654 default:
655 return (0);
657 else
658 return (0);
662 /* Return non-zero if OP is one of the test command's unary operators. */
664 test_unop (op)
665 char *op;
667 if (op[0] != '-' || op[2] != 0)
668 return (0);
670 switch (op[1])
672 case 'a': case 'b': case 'c': case 'd': case 'e':
673 case 'f': case 'g': case 'h': case 'k': case 'n':
674 case 'o': case 'p': case 'r': case 's': case 't':
675 case 'u': case 'w': case 'x': case 'z':
676 case 'G': case 'L': case 'O': case 'S': case 'N':
677 return (1);
680 return (0);
683 static int
684 two_arguments ()
686 if (argv[pos][0] == '!' && argv[pos][1] == '\0')
687 return (argv[pos + 1][0] == '\0');
688 else if (argv[pos][0] == '-' && argv[pos][2] == '\0')
690 if (test_unop (argv[pos]))
691 return (unary_operator ());
692 else
693 test_syntax_error (_("%s: unary operator expected"), argv[pos]);
695 else
696 test_syntax_error (_("%s: unary operator expected"), argv[pos]);
698 return (0);
701 #define ANDOR(s) (s[0] == '-' && !s[2] && (s[1] == 'a' || s[1] == 'o'))
703 /* This could be augmented to handle `-t' as equivalent to `-t 1', but
704 POSIX requires that `-t' be given an argument. */
705 #define ONE_ARG_TEST(s) ((s)[0] != '\0')
707 static int
708 three_arguments ()
710 int value;
712 if (test_binop (argv[pos+1]))
714 value = binary_operator ();
715 pos = argc;
717 else if (ANDOR (argv[pos+1]))
719 if (argv[pos+1][1] == 'a')
720 value = ONE_ARG_TEST(argv[pos]) && ONE_ARG_TEST(argv[pos+2]);
721 else
722 value = ONE_ARG_TEST(argv[pos]) || ONE_ARG_TEST(argv[pos+2]);
723 pos = argc;
725 else if (argv[pos][0] == '!' && argv[pos][1] == '\0')
727 advance (1);
728 value = !two_arguments ();
730 else if (argv[pos][0] == '(' && argv[pos+2][0] == ')')
732 value = ONE_ARG_TEST(argv[pos+1]);
733 pos = argc;
735 else
736 test_syntax_error (_("%s: binary operator expected"), argv[pos+1]);
738 return (value);
741 /* This is an implementation of a Posix.2 proposal by David Korn. */
742 static int
743 posixtest ()
745 int value;
747 switch (argc - 1) /* one extra passed in */
749 case 0:
750 value = FALSE;
751 pos = argc;
752 break;
754 case 1:
755 value = ONE_ARG_TEST(argv[1]);
756 pos = argc;
757 break;
759 case 2:
760 value = two_arguments ();
761 pos = argc;
762 break;
764 case 3:
765 value = three_arguments ();
766 break;
768 case 4:
769 if (argv[pos][0] == '!' && argv[pos][1] == '\0')
771 advance (1);
772 value = !three_arguments ();
773 break;
775 /* FALLTHROUGH */
776 default:
777 value = expr ();
780 return (value);
784 * [:
785 * '[' expr ']'
786 * test:
787 * test expr
790 test_command (margc, margv)
791 int margc;
792 char **margv;
794 int value;
795 int code;
797 USE_VAR(margc);
799 code = setjmp (test_exit_buf);
801 if (code)
802 return (test_error_return);
804 argv = margv;
806 if (margv[0] && margv[0][0] == '[' && margv[0][1] == '\0')
808 --margc;
810 if (margv[margc] && (margv[margc][0] != ']' || margv[margc][1]))
811 test_syntax_error (_("missing `]'"), (char *)NULL);
813 if (margc < 2)
814 test_exit (SHELL_BOOLEAN (FALSE));
817 argc = margc;
818 pos = 1;
820 if (pos >= argc)
821 test_exit (SHELL_BOOLEAN (FALSE));
823 noeval = 0;
824 value = posixtest ();
826 if (pos != argc)
827 test_syntax_error (_("too many arguments"), (char *)NULL);
829 test_exit (SHELL_BOOLEAN (value));