Add the pathchk utility, which checks pathnames for validity or

portability between POSIX systems.

Submitted by:	Chuck Rouillard (manpage, initial implementation)

3 files changed, 321 insertions, 0 deletions

diff --git a/usr.bin/pathchk/Makefile b/usr.bin/pathchk/Makefile
new file mode 100644
index 0000000..b5bea85
--- /dev/null
+++ b/usr.bin/pathchk/Makefile
@@ -0,0 +1,5 @@
+# $FreeBSD$
+
+PROG=	pathchk
+
+.include <bsd.prog.mk>
diff --git a/usr.bin/pathchk/pathchk.1 b/usr.bin/pathchk/pathchk.1
new file mode 100644
index 0000000..85ecbb1
--- /dev/null
+++ b/usr.bin/pathchk/pathchk.1
@@ -0,0 +1,124 @@
+.\" Copyright (c) 2001, 2002 Chuck Rouillard
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. The name of the author may not be used to endorse or promote
+.\"    products derived from this software without specific prior written
+.\"    permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
+.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
+.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd May 21, 2002
+.Dt PATHCHK 1
+.Os
+.Sh NAME
+.Nm pathchk
+.Nd check pathnames
+.Sh SYNOPSIS
+.Nm pathchk
+.Op Fl p
+.Bk -words
+.Ar pathname Ns
+\&...
+.Ek
+.Sh DESCRIPTION
+The
+.Nm pathchk
+utility checks whether each of the specified
+.Ar pathname
+arguments is valid or portable.
+.Pp
+A diagnostic message is written for each argument that:
+.Bl -bullet
+.It
+Is longer than
+.Dv PATH_MAX
+bytes.
+.It
+Contains any component longer than
+.Dv NAME_MAX
+bytes.
+The value of
+.Dv NAME_MAX
+depends on the underlying filesystem.
+.It
+Contains a directory component that is not searchable.
+.El
+.Pp
+It is not considered an error if a
+.Ar pathname
+argument contains a nonexistent component as long as a component by that
+name could be created.
+.Pp
+The options are as follows:
+.Bl -tag -width indent
+.It Fl p
+Perform portability checks on the specified
+.Ar pathname
+arguments.
+Diagnostic messages will be written for each argument that:
+.Bl -bullet
+.It
+Is longer than
+.Dv _POSIX_PATH_MAX
+.Pq 255
+bytes.
+.It
+Contains a component longer than
+.Dv _POSIX_NAME_MAX
+.Pq 14
+bytes.
+.It
+Contains any character not in the portable filename character set (that is,
+alphanumeric characters,
+.Ql \&. ,
+.Ql \&-
+and
+.Ql _ Ns
+).
+No component may start with the hyphen
+.Pq Ql \&-
+character.
+.El
+.El
+.Sh EXAMPLES
+Check whether the names of files in the current directory are portable to
+other
+.Tn POSIX
+systems:
+.Dl find \&. -print | xargs pathchk -p
+.Sh DIAGNOSTICS
+.Ex -std
+.Sh SEE ALSO
+.Xr getconf 1 ,
+.Xr pathconf 2 ,
+.Xr stat 2
+.Sh STANDARDS
+The
+.Nm pathchk
+utility conforms to
+.St -p1003.1-2001 .
+.Sh HISTORY
+A
+.Nm
+utility appeared in
+.Fx 5.0 .
diff --git a/usr.bin/pathchk/pathchk.c b/usr.bin/pathchk/pathchk.c
new file mode 100644
index 0000000..7f11e44
--- /dev/null
+++ b/usr.bin/pathchk/pathchk.c
@@ -0,0 +1,192 @@
+/*-
+ * Copyright (c) 2002 Tim J. Robbins.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+/*
+ * pathchk -- check pathnames
+ *
+ * Check whether files could be created with the names specified on the
+ * command line. If -p is specified, check whether the pathname is portable
+ * to all POSIX systems.
+ */
+
+#include <sys/cdefs.h>
+__FBSDID("$FreeBSD$");
+
+#include <sys/types.h>
+#include <sys/stat.h>
+
+#include <err.h>
+#include <errno.h>
+#include <limits.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+
+static int	 check(const char *);
+static int	 portable(const char *);
+static void	 usage(void);
+
+static int	 pflag;			/* Perform portability checks */
+
+int
+main(int argc, char *argv[])
+{
+	int ch, rval;
+	const char *arg;
+
+	while ((ch = getopt(argc, argv, "p")) > 0) {
+		switch (ch) {
+		case 'p':
+			pflag = 1;
+			break;
+		default:
+			usage();
+			/*NOTREACHED*/
+		}
+	}
+	argc -= optind;
+	argv += optind;
+
+	if (argc == 0)
+		usage();
+
+	rval = 0;
+	while ((arg = *argv++) != NULL)
+		rval |= check(arg);
+
+	exit(rval);
+}
+
+static void
+usage(void)
+{
+
+	fprintf(stderr, "usage: pathchk [-p] pathname...\n");
+	exit(1);
+}
+
+static int
+check(const char *path)
+{
+	struct stat sb;
+	long complen, namemax, pathmax, svnamemax;
+	int badch, last;
+	char *end, *p, *pathd;
+
+	if ((pathd = strdup(path)) == NULL)
+		err(1, "strdup");
+
+	p = pathd;
+
+	if (!pflag) {
+		errno = 0;
+		namemax = pathconf(*p == '/' ? "/" : ".", _PC_NAME_MAX);
+		if (namemax == -1 && errno != 0)
+			namemax = NAME_MAX;
+	} else
+		namemax = _POSIX_NAME_MAX;
+
+	for (;;) {
+		p += strspn(p, "/");
+		complen = (long)strcspn(p, "/");
+		end = p + complen;
+		last = *end == '\0';
+		*end = '\0';
+
+		if (namemax != -1 && complen > namemax) {
+			warnx("%s: %s: component too long (limit %ld)", path,
+			    p, namemax);
+			goto bad;
+		}
+
+		if (!pflag && stat(pathd, &sb) == -1 && errno != ENOENT) {
+			warn("%s", pathd);
+			goto bad;
+		}
+
+		if (pflag && (badch = portable(p)) >= 0) {
+			warnx("%s: %s: component contains non-portable "
+			    "character `%c'", path, p, badch);
+			goto bad;
+		}
+
+		if (last)
+			break;
+
+		if (!pflag) {
+			errno = 0;
+			svnamemax = namemax;
+			namemax = pathconf(pathd, _PC_NAME_MAX);
+			if (namemax == -1 && errno != 0)
+				namemax = svnamemax;
+		}
+
+		*end = '/';
+		p = end + 1;
+	}
+
+	if (!pflag) {
+		errno = 0;
+		pathmax = pathconf(path, _PC_PATH_MAX);
+		if (pathmax == -1 && errno != 0)
+			pathmax = PATH_MAX;
+	} else
+		pathmax = _POSIX_PATH_MAX;
+	if (pathmax != -1 && strlen(path) > (size_t)pathmax) {
+		warnx("%s: path too long (limit %ld)", path, pathmax);
+		goto bad;
+	}
+
+	free(pathd);
+	return (0);
+
+bad:	free(pathd);
+	return (1);
+}
+
+/*
+ * Check whether a path component contains only portable characters. Return
+ * the first non-portable character found.
+ */
+static int
+portable(const char *path)
+{
+	static const char charset[] =
+	    "abcdefghijklmnopqrstuvwxyz"
+	    "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+	    "0123456789._-";
+	long s;
+
+	if (*path == '-')
+		return (*path);
+
+	s = strspn(path, charset);
+	if (path[s] != '\0')
+		return (path[s]);
+
+	return (-1);
+}