usr.bin/find/function.c

/*-
 * Copyright (c) 1990 The Regents of the University of California.
 * All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Cimarron D. Taylor of the University of California, Berkeley.
 *
 * %sccs.include.redist.c%
 */

#ifndef lint
static char sccsid[] = "@(#)function.c	5.18 (Berkeley) 07/19/91";
#endif /* not lint */

#include <sys/param.h>
#include <sys/stat.h>
#include <sys/wait.h>
#include <sys/mount.h>
#include <errno.h>
#include <grp.h>
#include <pwd.h>
#include <fts.h>
#include <unistd.h>
#include <tzfile.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "find.h"

#define	COMPARE(a, b) { \
	switch(plan->flags) { \
	case F_EQUAL: \
		return(a == b); \
	case F_LESSTHAN: \
		return(a < b); \
	case F_GREATER: \
		return(a > b); \
	} \
	return(0); \
}

static PLAN *palloc __P((enum ntype, int (*)()));

/*
 * find_parsenum --
 *	Parse a string of the form [+-]# and return the value.
 */
long
find_parsenum(plan, option, str, endch)
	PLAN *plan;
	char *option, *str, *endch;
{
	long value;
	char *endchar;		/* pointer to character ending conversion */

	/* determine comparison from leading + or - */
	switch(*str) {
	case '+':
		++str;
		plan->flags = F_GREATER;
		break;
	case '-':
		++str;
		plan->flags = F_LESSTHAN;
		break;
	default:
		plan->flags = F_EQUAL;
		break;
	}

	/*
	 * convert the string with strtol().  Note, if strtol() returns zero
	 * and endchar points to the beginning of the string we know we have
	 * a syntax error.
	 */
	value = strtol(str, &endchar, 10);
	if (!value && endchar == str ||
	    endchar[0] && (!endch || endchar[0] != *endch))
		err("%s: %s", option, "illegal numeric value");
	if (endch)
		*endch = endchar[0];
	return(value);
}

/*
 * -atime n functions --
 *
 *	True if the difference between the file access time and the
 *	current time is n 24 hour periods.
 *
 */
f_atime(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	extern time_t now;

	COMPARE((now - entry->fts_statb.st_atime +
	    SECSPERDAY - 1) / SECSPERDAY, plan->t_data);
}

PLAN *
c_atime(arg)
	char *arg;
{
	PLAN *new;

	ftsoptions &= ~FTS_NOSTAT;

	new = palloc(N_ATIME, f_atime);
	new->t_data = find_parsenum(new, "-atime", arg, NULL);
	return(new);
}
/*
 * -ctime n functions --
 *
 *	True if the difference between the last change of file
 *	status information and the current time is n 24 hour periods.
 */
f_ctime(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	extern time_t now;

	COMPARE((now - entry->fts_statb.st_ctime +
	    SECSPERDAY - 1) / SECSPERDAY, plan->t_data);
}

PLAN *
c_ctime(arg)
	char *arg;
{
	PLAN *new;

	ftsoptions &= ~FTS_NOSTAT;

	new = palloc(N_CTIME, f_ctime);
	new->t_data = find_parsenum(new, "-ctime", arg, (char *)NULL);
	return(new);
}

/*
 * -depth functions --
 *
 *	Always true, causes descent of the directory hierarchy to be done
 *	so that all entries in a directory are acted on before the directory
 *	itself.
 */
/* ARGSUSED */
f_always_true(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	return(1);
}

PLAN *
c_depth()
{
	isdepth = 1;

	return(palloc(N_DEPTH, f_always_true));
}

/*
 * [-exec | -ok] utility [arg ... ] ; functions --
 *
 *	True if the executed utility returns a zero value as exit status.
 *	The end of the primary expression is delimited by a semicolon.  If
 *	"{}" occurs anywhere, it gets replaced by the current pathname.
 *	The current directory for the execution of utility is the same as
 *	the current directory when the find utility was started.
 *
 *	The primary -ok is different in that it requests affirmation of the
 *	user before executing the utility.
 */
f_exec(plan, entry)
	register PLAN *plan;
	FTSENT *entry;
{
	extern int dotfd;
	register int cnt;
	pid_t pid;
	int status;

	for (cnt = 0; plan->e_argv[cnt]; ++cnt)
		if (plan->e_len[cnt])
			brace_subst(plan->e_orig[cnt], &plan->e_argv[cnt],
			    entry->fts_path, plan->e_len[cnt]);

	if (plan->flags == F_NEEDOK && !queryuser(plan->e_argv))
		return(0);

	switch(pid = vfork()) {
	case -1:
		err("fork: %s", strerror(errno));
		/* NOTREACHED */
	case 0:
		if (fchdir(dotfd)) {
			(void)fprintf(stderr,
			    "find: chdir: %s\n", strerror(errno));
			_exit(1);
		}
		execvp(plan->e_argv[0], plan->e_argv);
		(void)fprintf(stderr,
		    "find: %s: %s\n", plan->e_argv[0], strerror(errno));
		_exit(1);
	}
	pid = waitpid(pid, &status, 0);
	return(pid != -1 && WIFEXITED(status) && !WEXITSTATUS(status));
}

/*
 * c_exec --
 *	build three parallel arrays, one with pointers to the strings passed
 *	on the command line, one with (possibly duplicated) pointers to the
 *	argv array, and one with integer values that are lengths of the
 *	strings, but also flags meaning that the string has to be massaged.
 */
PLAN *
c_exec(argvp, isok)
	char ***argvp;
	int isok;
{
	PLAN *new;			/* node returned */
	register int cnt;
	register char **argv, **ap, *p;

	isoutput = 1;

	new = palloc(N_EXEC, f_exec);
	if (isok)
		new->flags = F_NEEDOK;

	for (ap = argv = *argvp;; ++ap) {
		if (!*ap)
			err("%s: %s",
			    isok ? "-ok" : "-exec", "no terminating \";\"");
		if (**ap == ';')
			break;
	}

	cnt = ap - *argvp + 1;
	new->e_argv = (char **)emalloc((u_int)cnt * sizeof(char *));
	new->e_orig = (char **)emalloc((u_int)cnt * sizeof(char *));
	new->e_len = (int *)emalloc((u_int)cnt * sizeof(int));

	for (argv = *argvp, cnt = 0; argv < ap; ++argv, ++cnt) {
		new->e_orig[cnt] = *argv;
		for (p = *argv; *p; ++p)
			if (p[0] == '{' && p[1] == '}') {
				new->e_argv[cnt] = emalloc((u_int)MAXPATHLEN);
				new->e_len[cnt] = MAXPATHLEN;
				break;
			}
		if (!*p) {
			new->e_argv[cnt] = *argv;
			new->e_len[cnt] = 0;
		}
	}
	new->e_argv[cnt] = new->e_orig[cnt] = NULL;

	*argvp = argv + 1;
	return(new);
}

/*
 * -follow functions --
 *
 *	Always true, causes symbolic links to be followed on a global
 *	basis.
 */
PLAN *
c_follow()
{
	ftsoptions &= ~FTS_PHYSICAL;
	ftsoptions |= FTS_LOGICAL;

	return(palloc(N_FOLLOW, f_always_true));
}

/*
 * -fstype functions --
 *
 *	True if the file is of a certain type.
 */
f_fstype(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	static dev_t curdev;	/* need a guaranteed illegal dev value */
	static int first = 1;
	struct statfs sb;
	static short val;
	char *p, save[2];

	/* Only check when we cross mount point. */
	if (first || curdev != entry->fts_statb.st_dev) {
		curdev = entry->fts_statb.st_dev;

		/*
		 * Statfs follows symlinks; find wants the link's file system,
		 * not where it points.
		 */
		if (entry->fts_info == FTS_SL ||
		    entry->fts_info == FTS_SLNONE) {
			if (p = rindex(entry->fts_accpath, '/'))
				++p;
			else
				p = entry->fts_accpath;
			save[0] = p[0];
			p[0] = '.';
			save[1] = p[1];
			p[1] = '\0';

		} else
			p = NULL;

		if (statfs(entry->fts_accpath, &sb))
			err("%s: %s", entry->fts_accpath, strerror(errno));

		if (p) {
			p[0] = save[0];
			p[1] = save[1];
		}

		first = 0;
		switch(plan->flags) {
		case F_MTFLAG:
			val = sb.f_flags;
			break;
		case F_MTTYPE:
			val = sb.f_type;
			break;
		}
	}
	switch(plan->flags) {
	case F_MTFLAG:
		return(val & plan->mt_data);
	case F_MTTYPE:
		return(val == plan->mt_data);
	}
}

PLAN *
c_fstype(arg)
	char *arg;
{
	register PLAN *new;

	ftsoptions &= ~FTS_NOSTAT;

	new = palloc(N_FSTYPE, f_fstype);
	switch(*arg) {
	case 'l':
		if (!strcmp(arg, "local")) {
			new->flags = F_MTFLAG;
			new->mt_data = MNT_LOCAL;
			return(new);
		}
		break;
	case 'm':
		if (!strcmp(arg, "mfs")) {
			new->flags = F_MTTYPE;
			new->mt_data = MOUNT_MFS;
			return(new);
		}
		break;
	case 'n':
		if (!strcmp(arg, "nfs")) {
			new->flags = F_MTTYPE;
			new->mt_data = MOUNT_NFS;
			return(new);
		}
		break;
	case 'p':
		if (!strcmp(arg, "pc")) {
			new->flags = F_MTTYPE;
			new->mt_data = MOUNT_PC;
			return(new);
		}
		break;
	case 'r':
		if (!strcmp(arg, "rdonly")) {
			new->flags = F_MTFLAG;
			new->mt_data = MNT_RDONLY;
			return(new);
		}
		break;
	case 'u':
		if (!strcmp(arg, "ufs")) {
			new->flags = F_MTTYPE;
			new->mt_data = MOUNT_UFS;
			return(new);
		}
		break;
	}
	err("unknown file type %s", arg);
	/* NOTREACHED */
}

/*
 * -group gname functions --
 *
 *	True if the file belongs to the group gname.  If gname is numeric and
 *	an equivalent of the getgrnam() function does not return a valid group
 *	name, gname is taken as a group ID.
 */
f_group(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	return(entry->fts_statb.st_gid == plan->g_data);
}

PLAN *
c_group(gname)
	char *gname;
{
	PLAN *new;
	struct group *g;
	gid_t gid;

	ftsoptions &= ~FTS_NOSTAT;

	g = getgrnam(gname);
	if (g == NULL) {
		gid = atoi(gname);
		if (gid == 0 && gname[0] != '0')
			err("%s: %s", "-group", "no such group");
	} else
		gid = g->gr_gid;

	new = palloc(N_GROUP, f_group);
	new->g_data = gid;
	return(new);
}

/*
 * -inum n functions --
 *
 *	True if the file has inode # n.
 */
f_inum(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	COMPARE(entry->fts_statb.st_ino, plan->i_data);
}

PLAN *
c_inum(arg)
	char *arg;
{
	PLAN *new;

	ftsoptions &= ~FTS_NOSTAT;

	new = palloc(N_INUM, f_inum);
	new->i_data = find_parsenum(new, "-inum", arg, (char *)NULL);
	return(new);
}

/*
 * -links n functions --
 *
 *	True if the file has n links.
 */
f_links(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	COMPARE(entry->fts_statb.st_nlink, plan->l_data);
}

PLAN *
c_links(arg)
	char *arg;
{
	PLAN *new;

	ftsoptions &= ~FTS_NOSTAT;

	new = palloc(N_LINKS, f_links);
	new->l_data = (nlink_t)find_parsenum(new, "-links", arg, (char *)NULL);
	return(new);
}

/*
 * -ls functions --
 *
 *	Always true - prints the current entry to stdout in "ls" format.
 */
/* ARGSUSED */
f_ls(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	printlong(entry->fts_path, entry->fts_accpath, &entry->fts_statb);
	return(1);
}

PLAN *
c_ls()
{
	ftsoptions &= ~FTS_NOSTAT;
	isoutput = 1;

	return(palloc(N_LS, f_ls));
}

/*
 * -mtime n functions --
 *
 *	True if the difference between the file modification time and the
 *	current time is n 24 hour periods.
 */
f_mtime(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	extern time_t now;

	COMPARE((now - entry->fts_statb.st_mtime + SECSPERDAY - 1) /
	    SECSPERDAY, plan->t_data);
}

PLAN *
c_mtime(arg)
	char *arg;
{
	PLAN *new;

	ftsoptions &= ~FTS_NOSTAT;

	new = palloc(N_MTIME, f_mtime);
	new->t_data = find_parsenum(new, "-mtime", arg, (char *)NULL);
	return(new);
}

/*
 * -name functions --
 *
 *	True if the basename of the filename being examined
 *	matches pattern using Pattern Matching Notation S3.14
 */
f_name(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	return(fnmatch(plan->c_data, entry->fts_name, FNM_QUOTE));
}

PLAN *
c_name(pattern)
	char *pattern;
{
	PLAN *new;

	new = palloc(N_NAME, f_name);
	new->c_data = pattern;
	return(new);
}

/*
 * -newer file functions --
 *
 *	True if the current file has been modified more recently
 *	then the modification time of the file named by the pathname
 *	file.
 */
f_newer(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	return(entry->fts_statb.st_mtime > plan->t_data);
}

PLAN *
c_newer(filename)
	char *filename;
{
	PLAN *new;
	struct stat sb;

	ftsoptions &= ~FTS_NOSTAT;

	if (stat(filename, &sb))
		err("%s: %s", filename, strerror(errno));
	new = palloc(N_NEWER, f_newer);
	new->t_data = sb.st_mtime;
	return(new);
}

/*
 * -nogroup functions --
 *
 *	True if file belongs to a user ID for which the equivalent
 *	of the getgrnam() 9.2.1 [POSIX.1] function returns NULL.
 */
/* ARGSUSED */
f_nogroup(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	char *group_from_gid();

	return(group_from_gid(entry->fts_statb.st_gid, 1) ? 1 : 0);
}

PLAN *
c_nogroup()
{
	ftsoptions &= ~FTS_NOSTAT;

	return(palloc(N_NOGROUP, f_nogroup));
}

/*
 * -nouser functions --
 *
 *	True if file belongs to a user ID for which the equivalent
 *	of the getpwuid() 9.2.2 [POSIX.1] function returns NULL.
 */
/* ARGSUSED */
f_nouser(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	char *user_from_uid();

	return(user_from_uid(entry->fts_statb.st_uid, 1) ? 1 : 0);
}

PLAN *
c_nouser()
{
	ftsoptions &= ~FTS_NOSTAT;

	return(palloc(N_NOUSER, f_nouser));
}

/*
 * -path functions --
 *
 *	True if the path of the filename being examined
 *	matches pattern using Pattern Matching Notation S3.14
 */
f_path(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	return(fnmatch(plan->c_data, entry->fts_path, FNM_QUOTE));
}

PLAN *
c_path(pattern)
	char *pattern;
{
	PLAN *new;

	new = palloc(N_NAME, f_path);
	new->c_data = pattern;
	return(new);
}

/*
 * -perm functions --
 *
 *	The mode argument is used to represent file mode bits.  If it starts
 *	with a leading digit, it's treated as an octal mode, otherwise as a
 *	symbolic mode.
 */
f_perm(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	mode_t mode;

	mode = entry->fts_statb.st_mode &
	    (S_ISUID|S_ISGID|S_ISTXT|S_IRWXU|S_IRWXG|S_IRWXO);
	if (plan->flags == F_ATLEAST)
		return((plan->m_data | mode) == mode);
	else
		return(mode == plan->m_data);
	/* NOTREACHED */
}

PLAN *
c_perm(perm)
	char *perm;
{
	PLAN *new;
	mode_t *set;

	ftsoptions &= ~FTS_NOSTAT;

	new = palloc(N_PERM, f_perm);

	if (*perm == '-') {
		new->flags = F_ATLEAST;
		++perm;
	}

	if ((set = setmode(perm)) == NULL)
		err("%s: %s", "-perm", "illegal mode string");

	new->m_data = getmode(set, 0);
	return(new);
}

/*
 * -print functions --
 *
 *	Always true, causes the current pathame to be written to
 *	standard output.
 */
/* ARGSUSED */
f_print(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	(void)printf("%s\n", entry->fts_path);
	return(1);
}

PLAN *
c_print()
{
	isoutput = 1;

	return(palloc(N_PRINT, f_print));
}

/*
 * -prune functions --
 *
 *	Prune a portion of the hierarchy.
 */
/* ARGSUSED */
f_prune(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	extern FTS *tree;

	if (fts_set(tree, entry, FTS_SKIP))
		err("%s: %s", entry->fts_path, strerror(errno));
	return(1);
}

PLAN *
c_prune()
{
	return(palloc(N_PRUNE, f_prune));
}

/*
 * -size n[c] functions --
 *
 *	True if the file size in bytes, divided by an implementation defined
 *	value and rounded up to the next integer, is n.  If n is followed by
 *	a c, the size is in bytes.
 */
#define	FIND_SIZE	512
static int divsize = 1;

f_size(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	off_t size;

	size = divsize ? (entry->fts_statb.st_size + FIND_SIZE - 1) /
	    FIND_SIZE : entry->fts_statb.st_size;
	COMPARE(size, plan->o_data);
}

PLAN *
c_size(arg)
	char *arg;
{
	PLAN *new;
	char endch;

	ftsoptions &= ~FTS_NOSTAT;

	new = palloc(N_SIZE, f_size);
	new->o_data = find_parsenum(new, "-size", arg, &endch);
	if (endch == 'c')
		divsize = 0;
	return(new);
}

/*
 * -type c functions --
 *
 *	True if the type of the file is c, where c is b, c, d, p, or f for
 *	block special file, character special file, directory, FIFO, or
 *	regular file, respectively.
 */
f_type(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	return((entry->fts_statb.st_mode & S_IFMT) == plan->m_data);
}

PLAN *
c_type(typestring)
	char *typestring;
{
	PLAN *new;
	mode_t  mask;

	ftsoptions &= ~FTS_NOSTAT;

	switch (typestring[0]) {
	case 'b':
		mask = S_IFBLK;
		break;
	case 'c':
		mask = S_IFCHR;
		break;
	case 'd':
		mask = S_IFDIR;
		break;
	case 'f':
		mask = S_IFREG;
		break;
	case 'l':
		mask = S_IFLNK;
		break;
	case 'p':
		mask = S_IFIFO;
		break;
	case 's':
		mask = S_IFSOCK;
		break;
	default:
		err("%s: %s", "-type", "unknown type");
	}

	new = palloc(N_TYPE, f_type);
	new->m_data = mask;
	return(new);
}

/*
 * -user uname functions --
 *
 *	True if the file belongs to the user uname.  If uname is numeric and
 *	an equivalent of the getpwnam() S9.2.2 [POSIX.1] function does not
 *	return a valid user name, uname is taken as a user ID.
 */
f_user(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	return(entry->fts_statb.st_uid == plan->u_data);
}

PLAN *
c_user(username)
	char *username;
{
	PLAN *new;
	struct passwd *p;
	uid_t uid;

	ftsoptions &= ~FTS_NOSTAT;

	p = getpwnam(username);
	if (p == NULL) {
		uid = atoi(username);
		if (uid == 0 && username[0] != '0')
			err("%s: %s", "-user", "no such user");
	} else
		uid = p->pw_uid;

	new = palloc(N_USER, f_user);
	new->u_data = uid;
	return(new);
}

/*
 * -xdev functions --
 *
 *	Always true, causes find not to decend past directories that have a
 *	different device ID (st_dev, see stat() S5.6.2 [POSIX.1])
 */
PLAN *
c_xdev()
{
	ftsoptions |= FTS_XDEV;

	return(palloc(N_XDEV, f_always_true));
}

/*
 * ( expression ) functions --
 *
 *	True if expression is true.
 */
f_expr(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	register PLAN *p;
	register int state;

	for (p = plan->p_data[0];
	    p && (state = (p->eval)(p, entry)); p = p->next);
	return(state);
}

/*
 * N_OPENPAREN and N_CLOSEPAREN nodes are temporary place markers.  They are
 * eliminated during phase 2 of find_formplan() --- the '(' node is converted
 * to a N_EXPR node containing the expression and the ')' node is discarded.
 */
PLAN *
c_openparen()
{
	return(palloc(N_OPENPAREN, (int (*)())-1));
}

PLAN *
c_closeparen()
{
	return(palloc(N_CLOSEPAREN, (int (*)())-1));
}

/*
 * ! expression functions --
 *
 *	Negation of a primary; the unary NOT operator.
 */
f_not(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	register PLAN *p;
	register int state;

	for (p = plan->p_data[0];
	    p && (state = (p->eval)(p, entry)); p = p->next);
	return(!state);
}

PLAN *
c_not()
{
	return(palloc(N_NOT, f_not));
}

/*
 * expression -o expression functions --
 *
 *	Alternation of primaries; the OR operator.  The second expression is
 * not evaluated if the first expression is true.
 */
f_or(plan, entry)
	PLAN *plan;
	FTSENT *entry;
{
	register PLAN *p;
	register int state;

	for (p = plan->p_data[0];
	    p && (state = (p->eval)(p, entry)); p = p->next);

	if (state)
		return(1);

	for (p = plan->p_data[1];
	    p && (state = (p->eval)(p, entry)); p = p->next);
	return(state);
}

PLAN *
c_or()
{
	return(palloc(N_OR, f_or));
}

static PLAN *
palloc(t, f)
	enum ntype t;
	int (*f)();
{
	PLAN *new;

	if (new = malloc(sizeof(PLAN))) {
		new->type = t;
		new->eval = f;
		new->flags = 0;
		new->next = NULL;
		return(new);
	}
	err("%s", strerror(errno));
	/* NOTREACHED */
}