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-2010 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
25 /* #define PATTERN_MATCHING */
27 #if defined (HAVE_CONFIG_H)
33 #include "bashtypes.h"
35 #if !defined (HAVE_LIMITS_H) && defined (HAVE_SYS_PARAM_H)
36 # include <sys/param.h>
39 #if defined (HAVE_UNISTD_H)
48 #if !defined (_POSIX_VERSION) && defined (HAVE_SYS_FILE_H)
49 # include <sys/file.h>
50 #endif /* !_POSIX_VERSION */
51 #include "posixstat.h"
53 #include "stat-time.h"
60 #include "builtins/common.h"
62 #include <glob/strmatch.h>
65 # define STRLEN(s) ((s)[0] ? ((s)[1] ? ((s)[2] ? strlen(s) : 2) : 1) : 0)
69 # define STREQ(a, b) ((a)[0] == (b)[0] && strcmp ((a), (b)) == 0)
71 #define STRCOLLEQ(a, b) ((a)[0] == (b)[0] && strcoll ((a), (b)) == 0)
91 /* The following few defines control the truth and false output of each stage.
92 TRUE and FALSE are what we use to compute the final output value.
93 SHELL_BOOLEAN is the form which returns truth or falseness in shell terms.
94 Default is TRUE = 1, FALSE = 0, SHELL_BOOLEAN = (!value). */
97 #define SHELL_BOOLEAN(value) (!(value))
99 #define TEST_ERREXIT_STATUS 2
101 static procenv_t test_exit_buf;
102 static int test_error_return;
103 #define test_exit(val) \
104 do { test_error_return = val; longjmp (test_exit_buf, 1); } while (0)
106 extern int sh_stat __P((const char *, struct stat *));
108 static int pos; /* The offset of the current argument in ARGV. */
109 static int argc; /* The number of arguments present in ARGV. */
110 static char **argv; /* The argument list. */
113 static void test_syntax_error __P((char *, char *)) __attribute__((__noreturn__));
114 static void beyond __P((void)) __attribute__((__noreturn__));
115 static void integer_expected_error __P((char *)) __attribute__((__noreturn__));
117 static int unary_operator __P((void));
118 static int binary_operator __P((void));
119 static int two_arguments __P((void));
120 static int three_arguments __P((void));
121 static int posixtest __P((void));
123 static int expr __P((void));
124 static int term __P((void));
125 static int and __P((void));
126 static int or __P((void));
128 static int filecomp __P((char *, char *, int));
129 static int arithcomp __P((char *, char *, int, int));
130 static int patcomp __P((char *, char *, int));
133 test_syntax_error (format, arg)
136 builtin_error (format, arg);
137 test_exit (TEST_ERREXIT_STATUS);
141 * beyond - call when we're beyond the end of the argument list (an
147 test_syntax_error (_("argument expected"), (char *)NULL);
150 /* Syntax error for when an integer argument was expected, but
151 something else was found. */
153 integer_expected_error (pch)
156 test_syntax_error (_("%s: integer expression expected"), pch);
159 /* Increment our position in the argument list. Check that we're not
160 past the end of the argument list. This check is suppressed if the
161 argument is FALSE. Made a macro for efficiency. */
162 #define advance(f) do { ++pos; if (f && pos >= argc) beyond (); } while (0)
163 #define unary_advance() do { advance (1); ++pos; } while (0)
175 return (FALSE ^ or ()); /* Same with this. */
189 if (pos < argc && argv[pos][0] == '-' && argv[pos][1] == 'o' && !argv[pos][2])
193 return (value || v2);
210 if (pos < argc && argv[pos][0] == '-' && argv[pos][1] == 'a' && !argv[pos][2])
214 return (value && v2);
220 * term - parse a term and return 1 or 0 depending on whether the term
221 * evaluates to true or false, respectively.
224 * '-'('a'|'b'|'c'|'d'|'e'|'f'|'g'|'h'|'k'|'p'|'r'|'s'|'u'|'w'|'x') filename
225 * '-'('G'|'L'|'O'|'S'|'N') filename
227 * '-'('z'|'n') string
230 * string ('!='|'='|'==') string
231 * <int> '-'(eq|ne|le|lt|ge|gt) <int>
232 * file '-'(nt|ot|ef) file
235 * positive and negative integers
245 /* Deal with leading `not's. */
246 if (argv[pos][0] == '!' && argv[pos][1] == '\0')
249 while (pos < argc && argv[pos][0] == '!' && argv[pos][1] == '\0')
255 return (value ? !term() : term());
258 /* A paren-bracketed argument. */
259 if (argv[pos][0] == '(' && argv[pos][1] == '\0') /* ) */
263 if (argv[pos] == 0) /* ( */
264 test_syntax_error (_("`)' expected"), (char *)NULL);
265 else if (argv[pos][0] != ')' || argv[pos][1]) /* ( */
266 test_syntax_error (_("`)' expected, found %s"), argv[pos]);
271 /* are there enough arguments left that this could be dyadic? */
272 if ((pos + 3 <= argc) && test_binop (argv[pos + 1]))
273 value = binary_operator ();
275 /* Might be a switch type argument */
276 else if (argv[pos][0] == '-' && argv[pos][2] == '\0')
278 if (test_unop (argv[pos]))
279 value = unary_operator ();
281 test_syntax_error (_("%s: unary operator expected"), argv[pos]);
285 value = argv[pos][0] != '\0';
293 stat_mtime (fn, st, ts)
300 r = sh_stat (fn, st);
303 *ts = get_stat_mtime (st);
312 struct stat st1, st2;
313 struct timespec ts1, ts2;
316 if ((r1 = stat_mtime (s, &st1, &ts1)) < 0)
321 if ((r2 = stat_mtime (t, &st2, &ts2)) < 0)
329 case OT: return (r1 < r2 || (r2 == 0 && timespec_cmp (ts1, ts2) < 0));
330 case NT: return (r1 > r2 || (r1 == 0 && timespec_cmp (ts1, ts2) > 0));
331 case EF: return (same_file (s, t, &st1, &st2));
337 arithcomp (s, t, op, flags)
344 if (flags & TEST_ARITHEXP)
346 l = evalexp (s, &expok);
348 return (FALSE); /* should probably longjmp here */
349 r = evalexp (t, &expok);
351 return (FALSE); /* ditto */
355 if (legal_number (s, &l) == 0)
356 integer_expected_error (s);
357 if (legal_number (t, &r) == 0)
358 integer_expected_error (t);
363 case EQ: return (l == r);
364 case NE: return (l != r);
365 case LT: return (l < r);
366 case GT: return (l > r);
367 case LE: return (l <= r);
368 case GE: return (l >= r);
375 patcomp (string, pat, op)
381 m = strmatch (pat, string, FNMATCH_EXTFLAG|FNMATCH_IGNCASE);
382 return ((op == EQ) ? (m == 0) : (m != 0));
386 binary_test (op, arg1, arg2, flags)
387 char *op, *arg1, *arg2;
392 patmatch = (flags & TEST_PATMATCH);
394 if (op[0] == '=' && (op[1] == '\0' || (op[1] == '=' && op[2] == '\0')))
395 return (patmatch ? patcomp (arg1, arg2, EQ) : STREQ (arg1, arg2));
396 else if ((op[0] == '>' || op[0] == '<') && op[1] == '\0')
398 #if defined (HAVE_STRCOLL)
399 if (shell_compatibility_level > 40 && flags & TEST_LOCALE)
400 return ((op[0] == '>') ? (strcoll (arg1, arg2) > 0) : (strcoll (arg1, arg2) < 0));
403 return ((op[0] == '>') ? (strcmp (arg1, arg2) > 0) : (strcmp (arg1, arg2) < 0));
405 else if (op[0] == '!' && op[1] == '=' && op[2] == '\0')
406 return (patmatch ? patcomp (arg1, arg2, NE) : (STREQ (arg1, arg2) == 0));
409 else if (op[2] == 't')
413 case 'n': return (filecomp (arg1, arg2, NT)); /* -nt */
414 case 'o': return (filecomp (arg1, arg2, OT)); /* -ot */
415 case 'l': return (arithcomp (arg1, arg2, LT, flags)); /* -lt */
416 case 'g': return (arithcomp (arg1, arg2, GT, flags)); /* -gt */
419 else if (op[1] == 'e')
423 case 'f': return (filecomp (arg1, arg2, EF)); /* -ef */
424 case 'q': return (arithcomp (arg1, arg2, EQ, flags)); /* -eq */
427 else if (op[2] == 'e')
431 case 'n': return (arithcomp (arg1, arg2, NE, flags)); /* -ne */
432 case 'g': return (arithcomp (arg1, arg2, GE, flags)); /* -ge */
433 case 'l': return (arithcomp (arg1, arg2, LE, flags)); /* -le */
437 return (FALSE); /* should never get here */
448 if ((w[0] == '=' && (w[1] == '\0' || (w[1] == '=' && w[2] == '\0'))) || /* =, == */
449 ((w[0] == '>' || w[0] == '<') && w[1] == '\0') || /* <, > */
450 (w[0] == '!' && w[1] == '=' && w[2] == '\0')) /* != */
452 value = binary_test (w, argv[pos], argv[pos + 2], 0);
457 #if defined (PATTERN_MATCHING)
458 if ((w[0] == '=' || w[0] == '!') && w[1] == '~' && w[2] == '\0')
460 value = patcomp (argv[pos], argv[pos + 2], w[0] == '=' ? EQ : NE);
466 if ((w[0] != '-' || w[3] != '\0') || test_binop (w) == 0)
468 test_syntax_error (_("%s: binary operator expected"), w);
473 value = binary_test (w, argv[pos], argv[pos + 2], 0);
485 if (test_unop (op) == 0)
488 /* the only tricky case is `-t', which may or may not take an argument. */
494 if (legal_number (argv[pos], &r))
497 return (unary_test (op, argv[pos - 1]));
503 return (unary_test (op, "1"));
506 /* All of the unary operators take an argument, so we first call
507 unary_advance (), which checks to make sure that there is an
508 argument, and then advances pos right past it. This means that
509 pos - 1 is the location of the argument. */
511 return (unary_test (op, argv[pos - 1]));
519 struct stat stat_buf;
524 case 'a': /* file exists in the file system? */
526 return (sh_stat (arg, &stat_buf) == 0);
528 case 'r': /* file is readable? */
529 return (sh_eaccess (arg, R_OK) == 0);
531 case 'w': /* File is writeable? */
532 return (sh_eaccess (arg, W_OK) == 0);
534 case 'x': /* File is executable? */
535 return (sh_eaccess (arg, X_OK) == 0);
537 case 'O': /* File is owned by you? */
538 return (sh_stat (arg, &stat_buf) == 0 &&
539 (uid_t) current_user.euid == (uid_t) stat_buf.st_uid);
541 case 'G': /* File is owned by your group? */
542 return (sh_stat (arg, &stat_buf) == 0 &&
543 (gid_t) current_user.egid == (gid_t) stat_buf.st_gid);
546 return (sh_stat (arg, &stat_buf) == 0 &&
547 stat_buf.st_atime <= stat_buf.st_mtime);
549 case 'f': /* File is a file? */
550 if (sh_stat (arg, &stat_buf) < 0)
553 /* -f is true if the given file exists and is a regular file. */
555 return (S_ISREG (stat_buf.st_mode) || (stat_buf.st_mode & S_IFMT) == 0);
557 return (S_ISREG (stat_buf.st_mode));
560 case 'd': /* File is a directory? */
561 return (sh_stat (arg, &stat_buf) == 0 && (S_ISDIR (stat_buf.st_mode)));
563 case 's': /* File has something in it? */
564 return (sh_stat (arg, &stat_buf) == 0 && stat_buf.st_size > (off_t) 0);
566 case 'S': /* File is a socket? */
567 #if !defined (S_ISSOCK)
570 return (sh_stat (arg, &stat_buf) == 0 && S_ISSOCK (stat_buf.st_mode));
571 #endif /* S_ISSOCK */
573 case 'c': /* File is character special? */
574 return (sh_stat (arg, &stat_buf) == 0 && S_ISCHR (stat_buf.st_mode));
576 case 'b': /* File is block special? */
577 return (sh_stat (arg, &stat_buf) == 0 && S_ISBLK (stat_buf.st_mode));
579 case 'p': /* File is a named pipe? */
583 return (sh_stat (arg, &stat_buf) == 0 && S_ISFIFO (stat_buf.st_mode));
584 #endif /* S_ISFIFO */
586 case 'L': /* Same as -h */
587 case 'h': /* File is a symbolic link? */
588 #if !defined (S_ISLNK) || !defined (HAVE_LSTAT)
591 return ((arg[0] != '\0') &&
592 (lstat (arg, &stat_buf) == 0) && S_ISLNK (stat_buf.st_mode));
593 #endif /* S_IFLNK && HAVE_LSTAT */
595 case 'u': /* File is setuid? */
596 return (sh_stat (arg, &stat_buf) == 0 && (stat_buf.st_mode & S_ISUID) != 0);
598 case 'g': /* File is setgid? */
599 return (sh_stat (arg, &stat_buf) == 0 && (stat_buf.st_mode & S_ISGID) != 0);
601 case 'k': /* File has sticky bit set? */
602 #if !defined (S_ISVTX)
603 /* This is not Posix, and is not defined on some Posix systems. */
606 return (sh_stat (arg, &stat_buf) == 0 && (stat_buf.st_mode & S_ISVTX) != 0);
609 case 't': /* File fd is a terminal? */
610 if (legal_number (arg, &r) == 0)
612 return ((r == (int)r) && isatty ((int)r));
614 case 'n': /* True if arg has some length. */
615 return (arg[0] != '\0');
617 case 'z': /* True if arg has no length. */
618 return (arg[0] == '\0');
620 case 'o': /* True if option `arg' is set. */
621 return (minus_o_option_value (arg) == 1);
624 v = find_variable (arg);
625 #if defined (ARRAY_VARS)
626 if (v == 0 && valid_array_reference (arg))
629 t = array_value (arg, 0, 0, (int *)0, (arrayind_t *)0);
630 return (t ? TRUE : FALSE);
632 else if (v && invisible_p (v) == 0 && array_p (v))
635 /* [[ -v foo ]] == [[ -v foo[0] ]] */
636 t = array_reference (array_cell (v), 0);
637 return (t ? TRUE : FALSE);
639 else if (v && invisible_p (v) == 0 && assoc_p (v))
642 t = assoc_reference (assoc_cell (v), "0");
643 return (t ? TRUE : FALSE);
646 return (v && invisible_p (v) == 0 && var_isset (v) ? TRUE : FALSE);
649 v = find_variable_noref (arg);
650 return ((v && invisible_p (v) == 0 && var_isset (v) && nameref_p (v)) ? TRUE : FALSE);
653 /* We can't actually get here, but this shuts up gcc. */
657 /* Return TRUE if OP is one of the test command's binary operators. */
662 if (op[0] == '=' && op[1] == '\0')
663 return (1); /* '=' */
664 else if ((op[0] == '<' || op[0] == '>') && op[1] == '\0') /* string <, > */
666 else if ((op[0] == '=' || op[0] == '!') && op[1] == '=' && op[2] == '\0')
667 return (1); /* `==' and `!=' */
668 #if defined (PATTERN_MATCHING)
669 else if (op[2] == '\0' && op[1] == '~' && (op[0] == '=' || op[0] == '!'))
672 else if (op[0] != '-' || op[2] == '\0' || op[3] != '\0')
687 else if (op[1] == 'e')
696 else if (op[2] == 'e')
711 /* Return non-zero if OP is one of the test command's unary operators. */
716 if (op[0] != '-' || op[2] != 0)
721 case 'a': case 'b': case 'c': case 'd': case 'e':
722 case 'f': case 'g': case 'h': case 'k': case 'n':
723 case 'o': case 'p': case 'r': case 's': case 't':
724 case 'u': case 'v': case 'w': case 'x': case 'z':
725 case 'G': case 'L': case 'O': case 'S': case 'N':
736 if (argv[pos][0] == '!' && argv[pos][1] == '\0')
737 return (argv[pos + 1][0] == '\0');
738 else if (argv[pos][0] == '-' && argv[pos][2] == '\0')
740 if (test_unop (argv[pos]))
741 return (unary_operator ());
743 test_syntax_error (_("%s: unary operator expected"), argv[pos]);
746 test_syntax_error (_("%s: unary operator expected"), argv[pos]);
751 #define ANDOR(s) (s[0] == '-' && !s[2] && (s[1] == 'a' || s[1] == 'o'))
753 /* This could be augmented to handle `-t' as equivalent to `-t 1', but
754 POSIX requires that `-t' be given an argument. */
755 #define ONE_ARG_TEST(s) ((s)[0] != '\0')
762 if (test_binop (argv[pos+1]))
764 value = binary_operator ();
767 else if (ANDOR (argv[pos+1]))
769 if (argv[pos+1][1] == 'a')
770 value = ONE_ARG_TEST(argv[pos]) && ONE_ARG_TEST(argv[pos+2]);
772 value = ONE_ARG_TEST(argv[pos]) || ONE_ARG_TEST(argv[pos+2]);
775 else if (argv[pos][0] == '!' && argv[pos][1] == '\0')
778 value = !two_arguments ();
780 else if (argv[pos][0] == '(' && argv[pos+2][0] == ')')
782 value = ONE_ARG_TEST(argv[pos+1]);
786 test_syntax_error (_("%s: binary operator expected"), argv[pos+1]);
791 /* This is an implementation of a Posix.2 proposal by David Korn. */
797 switch (argc - 1) /* one extra passed in */
805 value = ONE_ARG_TEST(argv[1]);
810 value = two_arguments ();
815 value = three_arguments ();
819 if (argv[pos][0] == '!' && argv[pos][1] == '\0')
822 value = !three_arguments ();
840 test_command (margc, margv)
849 code = setjmp_nosigs (test_exit_buf);
852 return (test_error_return);
856 if (margv[0] && margv[0][0] == '[' && margv[0][1] == '\0')
860 if (margv[margc] && (margv[margc][0] != ']' || margv[margc][1]))
861 test_syntax_error (_("missing `]'"), (char *)NULL);
864 test_exit (SHELL_BOOLEAN (FALSE));
871 test_exit (SHELL_BOOLEAN (FALSE));
874 value = posixtest ();
877 test_syntax_error (_("too many arguments"), (char *)NULL);
879 test_exit (SHELL_BOOLEAN (value));