===================================================================
RCS file: /cvs/mandoc/mansearch.c,v
retrieving revision 1.1
retrieving revision 1.15
diff -u -p -r1.1 -r1.15
--- mandoc/mansearch.c	2012/06/08 10:36:23	1.1
+++ mandoc/mansearch.c	2014/01/05 03:06:43	1.15
@@ -1,6 +1,7 @@
-/*	$Id: mansearch.c,v 1.1 2012/06/08 10:36:23 kristaps Exp $ */
+/*	$Id: mansearch.c,v 1.15 2014/01/05 03:06:43 schwarze Exp $ */
 /*
  * Copyright (c) 2012 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -18,11 +19,11 @@
 #include "config.h"
 #endif
 
-#include <sys/param.h>
-
 #include <assert.h>
 #include <fcntl.h>
 #include <getopt.h>
+#include <limits.h>
+#include <regex.h>
 #include <stdio.h>
 #include <stdint.h>
 #include <stddef.h>
@@ -30,19 +31,41 @@
 #include <string.h>
 #include <unistd.h>
 
+#ifdef HAVE_OHASH
 #include <ohash.h>
+#else
+#include "compat_ohash.h"
+#endif
 #include <sqlite3.h>
 
 #include "mandoc.h"
 #include "manpath.h"
-#include "mandocdb.h"
 #include "mansearch.h"
 
+#define	SQL_BIND_TEXT(_db, _s, _i, _v) \
+	do { if (SQLITE_OK != sqlite3_bind_text \
+		((_s), (_i)++, (_v), -1, SQLITE_STATIC)) \
+		fprintf(stderr, "%s\n", sqlite3_errmsg((_db))); \
+	} while (0)
+#define	SQL_BIND_INT64(_db, _s, _i, _v) \
+	do { if (SQLITE_OK != sqlite3_bind_int64 \
+		((_s), (_i)++, (_v))) \
+		fprintf(stderr, "%s\n", sqlite3_errmsg((_db))); \
+	} while (0)
+#define	SQL_BIND_BLOB(_db, _s, _i, _v) \
+	do { if (SQLITE_OK != sqlite3_bind_blob \
+		((_s), (_i)++, (&_v), sizeof(_v), SQLITE_STATIC)) \
+		fprintf(stderr, "%s\n", sqlite3_errmsg((_db))); \
+	} while (0)
+
 struct	expr {
-	int		 glob; /* is glob? */
-	uint64_t 	 bits; /* type-mask */
-	const char	*v; /* search value */
-	struct expr	*next; /* next in sequence */
+	uint64_t 	 bits;    /* type-mask */
+	const char	*substr;  /* to search for, if applicable */
+	regex_t		 regexp;  /* compiled regexp, if applicable */
+	int		 open;    /* opening parentheses before */
+	int		 and;	  /* logical AND before */
+	int		 close;   /* closing parentheses after */
+	struct expr	*next;    /* next in sequence */
 };
 
 struct	match {
@@ -97,32 +120,48 @@ static	const struct type types[] = {
 	{ TYPE_Va,  "Va" },
 	{ TYPE_Va,  "Vt" },
 	{ TYPE_Xr,  "Xr" },
+	{ TYPE_sec, "sec" },
+	{ TYPE_arch,"arch" },
 	{ ~0ULL,    "any" },
 	{ 0ULL, NULL }
 };
 
+static	char		*buildnames(sqlite3 *, sqlite3_stmt *, uint64_t);
+static	char		*buildoutput(sqlite3 *, sqlite3_stmt *,
+				 uint64_t, uint64_t);
 static	void		*hash_alloc(size_t, void *);
 static	void		 hash_free(void *, size_t, void *);
 static	void		*hash_halloc(size_t, void *);
-static	struct expr	*exprcomp(int, char *[]);
+static	struct expr	*exprcomp(const struct mansearch *, 
+				int, char *[]);
 static	void		 exprfree(struct expr *);
-static	struct expr	*exprterm(char *);
-static	char		*sql_statement(const struct expr *,
-				const char *, const char *);
+static	struct expr	*exprspec(struct expr *, uint64_t,
+				 const char *, const char *);
+static	struct expr	*exprterm(const struct mansearch *, char *, int);
+static	void		 sql_append(char **sql, size_t *sz,
+				const char *newstr, int count);
+static	void		 sql_match(sqlite3_context *context,
+				int argc, sqlite3_value **argv);
+static	void		 sql_regexp(sqlite3_context *context,
+				int argc, sqlite3_value **argv);
+static	char		*sql_statement(const struct expr *);
 
 int
-mansearch(const struct manpaths *paths, 
-		const char *arch, const char *sec,
-		int argc, char *argv[], 
+mansearch(const struct mansearch *search,
+		const struct manpaths *paths,
+		int argc, char *argv[],
+		const char *outkey,
 		struct manpage **res, size_t *sz)
 {
-	int		 fd, rc;
+	int		 fd, rc, c, ibit;
 	int64_t		 id;
-	char		 buf[MAXPATHLEN];
+	uint64_t	 outbit;
+	char		 buf[PATH_MAX];
 	char		*sql;
+	struct manpage	*mpage;
 	struct expr	*e, *ep;
 	sqlite3		*db;
-	sqlite3_stmt	*s;
+	sqlite3_stmt	*s, *s2;
 	struct match	*mp;
 	struct ohash_info info;
 	struct ohash	 htab;
@@ -136,18 +175,28 @@ mansearch(const struct manpaths *paths, 
 	info.hfree = hash_free;
 	info.key_offset = offsetof(struct match, id);
 
-	*sz = 0;
+	*sz = cur = maxres = 0;
 	sql = NULL;
 	*res = NULL;
 	fd = -1;
 	e = NULL;
-	cur = maxres = 0;
+	rc = 0;
 
 	if (0 == argc)
 		goto out;
-	if (NULL == (e = exprcomp(argc, argv)))
+	if (NULL == (e = exprcomp(search, argc, argv)))
 		goto out;
 
+	outbit = 0;
+	if (NULL != outkey) {
+		for (ibit = 0; types[ibit].bits; ibit++) {
+			if (0 == strcasecmp(types[ibit].name, outkey)) {
+				outbit = types[ibit].bits;
+				break;
+			}
+		}
+	}
+
 	/*
 	 * Save a descriptor to the current working directory.
 	 * Since pathnames in the "paths" variable might be relative,
@@ -155,7 +204,7 @@ mansearch(const struct manpaths *paths, 
 	 * on our current directory from which to start the chdir().
 	 */
 
-	if (NULL == getcwd(buf, MAXPATHLEN)) {
+	if (NULL == getcwd(buf, PATH_MAX)) {
 		perror(NULL);
 		goto out;
 	} else if (-1 == (fd = open(buf, O_RDONLY, 0))) {
@@ -163,7 +212,7 @@ mansearch(const struct manpaths *paths, 
 		goto out;
 	}
 
-	sql = sql_statement(e, arch, sec);
+	sql = sql_statement(e);
 
 	/*
 	 * Loop over the directories (containing databases) for us to
@@ -175,7 +224,6 @@ mansearch(const struct manpaths *paths, 
 
 	for (i = 0; i < paths->sz; i++) {
 		if (-1 == fchdir(fd)) {
-			/* FIXME: will return success */
 			perror(buf);
 			free(*res);
 			break;
@@ -184,30 +232,39 @@ mansearch(const struct manpaths *paths, 
 			continue;
 		} 
 
-		rc =  sqlite3_open_v2
-			(MANDOC_DB, &db, SQLITE_OPEN_READONLY, NULL);
+		c =  sqlite3_open_v2
+			(MANDOC_DB, &db, 
+			 SQLITE_OPEN_READONLY, NULL);
 
-		if (SQLITE_OK != rc) {
+		if (SQLITE_OK != c) {
 			perror(MANDOC_DB);
 			sqlite3_close(db);
 			continue;
 		}
 
-		j = 1;
-		sqlite3_prepare_v2(db, sql, -1, &s, NULL);
+		/*
+		 * Define the SQL functions for substring
+		 * and regular expression matching.
+		 */
 
-		if (NULL != arch)
-			sqlite3_bind_text
-				(s, j++, arch, -1, SQLITE_STATIC);
-		if (NULL != sec)
-			sqlite3_bind_text
-				(s, j++, sec, -1, SQLITE_STATIC);
+		c = sqlite3_create_function(db, "match", 2,
+		    SQLITE_ANY, NULL, sql_match, NULL, NULL);
+		assert(SQLITE_OK == c);
+		c = sqlite3_create_function(db, "regexp", 2,
+		    SQLITE_ANY, NULL, sql_regexp, NULL, NULL);
+		assert(SQLITE_OK == c);
 
+		j = 1;
+		c = sqlite3_prepare_v2(db, sql, -1, &s, NULL);
+		if (SQLITE_OK != c)
+			fprintf(stderr, "%s\n", sqlite3_errmsg(db));
+
 		for (ep = e; NULL != ep; ep = ep->next) {
-			sqlite3_bind_text
-				(s, j++, ep->v, -1, SQLITE_STATIC);
-			sqlite3_bind_int64
-				(s, j++, ep->bits);
+			if (NULL == ep->substr) {
+				SQL_BIND_BLOB(db, s, j, ep->regexp);
+			} else
+				SQL_BIND_TEXT(db, s, j, ep->substr);
+			SQL_BIND_INT64(db, s, j, ep->bits);
 		}
 
 		memset(&htab, 0, sizeof(struct ohash));
@@ -221,8 +278,8 @@ mansearch(const struct manpaths *paths, 
 		 * This gives good performance and preserves the
 		 * distribution of buckets in the table.
 		 */
-		while (SQLITE_ROW == sqlite3_step(s)) {
-			id = sqlite3_column_int64(s, 0);
+		while (SQLITE_ROW == (c = sqlite3_step(s))) {
+			id = sqlite3_column_int64(s, 5);
 			idx = ohash_lookup_memory
 				(&htab, (char *)&id, 
 				 sizeof(uint64_t), (uint32_t)id);
@@ -233,16 +290,30 @@ mansearch(const struct manpaths *paths, 
 			mp = mandoc_calloc(1, sizeof(struct match));
 			mp->id = id;
 			mp->file = mandoc_strdup
-				((char *)sqlite3_column_text(s, 3));
+				((char *)sqlite3_column_text(s, 0));
 			mp->desc = mandoc_strdup
-				((char *)sqlite3_column_text(s, 4));
-			mp->form = sqlite3_column_int(s, 5);
+				((char *)sqlite3_column_text(s, 3));
+			mp->form = sqlite3_column_int(s, 4);
 			ohash_insert(&htab, idx, mp);
 		}
 
+		if (SQLITE_DONE != c)
+			fprintf(stderr, "%s\n", sqlite3_errmsg(db));
+
 		sqlite3_finalize(s);
-		sqlite3_close(db);
 
+		c = sqlite3_prepare_v2(db, 
+		    "SELECT * FROM mlinks WHERE pageid=?",
+		    -1, &s, NULL);
+		if (SQLITE_OK != c)
+			fprintf(stderr, "%s\n", sqlite3_errmsg(db));
+
+		c = sqlite3_prepare_v2(db,
+		    "SELECT * FROM keys WHERE pageid=? AND bits & ?",
+		    -1, &s2, NULL);
+		if (SQLITE_OK != c)
+			fprintf(stderr, "%s\n", sqlite3_errmsg(db));
+
 		for (mp = ohash_first(&htab, &idx);
 				NULL != mp;
 				mp = ohash_next(&htab, &idx)) {
@@ -251,74 +322,186 @@ mansearch(const struct manpaths *paths, 
 				*res = mandoc_realloc
 					(*res, maxres * sizeof(struct manpage));
 			}
-			strlcpy((*res)[cur].file, 
-				paths->paths[i], MAXPATHLEN);
-			strlcat((*res)[cur].file, "/", MAXPATHLEN);
-			strlcat((*res)[cur].file, mp->file, MAXPATHLEN);
-			(*res)[cur].desc = mp->desc;
-			(*res)[cur].form = mp->form;
+			mpage = *res + cur;
+			if (-1 == asprintf(&mpage->file, "%s/%s",
+			    paths->paths[i], mp->file)) {
+				perror(0);
+				exit((int)MANDOCLEVEL_SYSERR);
+			}
+			mpage->desc = mp->desc;
+			mpage->form = mp->form;
+			mpage->names = buildnames(db, s, mp->id);
+			mpage->output = outbit ?
+			    buildoutput(db, s2, mp->id, outbit) : NULL;
+
 			free(mp->file);
 			free(mp);
 			cur++;
 		}
+
+		sqlite3_finalize(s);
+		sqlite3_finalize(s2);
+		sqlite3_close(db);
 		ohash_delete(&htab);
 	}
+	rc = 1;
 out:
 	exprfree(e);
 	if (-1 != fd)
 		close(fd);
 	free(sql);
 	*sz = cur;
-	return(1);
+	return(rc);
 }
 
+static char *
+buildnames(sqlite3 *db, sqlite3_stmt *s, uint64_t id)
+{
+	char		*names, *newnames;
+	const char	*oldnames, *sep1, *name, *sec, *sep2, *arch;
+	size_t		 i;
+	int		 c;
+
+	names = NULL;
+	i = 1;
+	SQL_BIND_INT64(db, s, i, id);
+	while (SQLITE_ROW == (c = sqlite3_step(s))) {
+		if (NULL == names) {
+			oldnames = "";
+			sep1 = "";
+		} else {
+			oldnames = names;
+			sep1 = ", ";
+		}
+		sec = sqlite3_column_text(s, 1);
+		arch = sqlite3_column_text(s, 2);
+		name = sqlite3_column_text(s, 3);
+		sep2 = '\0' == *arch ? "" : "/";
+		if (-1 == asprintf(&newnames, "%s%s%s(%s%s%s)",
+		    oldnames, sep1, name, sec, sep2, arch)) {
+			perror(0);
+			exit((int)MANDOCLEVEL_SYSERR);
+		}
+		free(names);
+		names = newnames;
+	}
+	if (SQLITE_DONE != c)
+		fprintf(stderr, "%s\n", sqlite3_errmsg(db));
+	sqlite3_reset(s);
+	return(names);
+}
+
+static char *
+buildoutput(sqlite3 *db, sqlite3_stmt *s, uint64_t id, uint64_t outbit)
+{
+	char		*output, *newoutput;
+	const char	*oldoutput, *sep1, *data;
+	size_t		 i;
+	int		 c;
+
+	output = NULL;
+	i = 1;
+	SQL_BIND_INT64(db, s, i, id);
+	SQL_BIND_INT64(db, s, i, outbit);
+	while (SQLITE_ROW == (c = sqlite3_step(s))) {
+		if (NULL == output) {
+			oldoutput = "";
+			sep1 = "";
+		} else {
+			oldoutput = output;
+			sep1 = " # ";
+		}
+		data = sqlite3_column_text(s, 1);
+		if (-1 == asprintf(&newoutput, "%s%s%s",
+		    oldoutput, sep1, data)) {
+			perror(0);
+			exit((int)MANDOCLEVEL_SYSERR);
+		}
+		free(output);
+		output = newoutput;
+	}
+	if (SQLITE_DONE != c)
+		fprintf(stderr, "%s\n", sqlite3_errmsg(db));
+	sqlite3_reset(s);
+	return(output);
+}
+
 /*
+ * Implement substring match as an application-defined SQL function.
+ * Using the SQL LIKE or GLOB operators instead would be a bad idea
+ * because that would require escaping metacharacters in the string
+ * being searched for.
+ */
+static void
+sql_match(sqlite3_context *context, int argc, sqlite3_value **argv)
+{
+
+	assert(2 == argc);
+	sqlite3_result_int(context, NULL != strcasestr(
+	    (const char *)sqlite3_value_text(argv[1]),
+	    (const char *)sqlite3_value_text(argv[0])));
+}
+
+/*
+ * Implement regular expression match
+ * as an application-defined SQL function.
+ */
+static void
+sql_regexp(sqlite3_context *context, int argc, sqlite3_value **argv)
+{
+
+	assert(2 == argc);
+	sqlite3_result_int(context, !regexec(
+	    (regex_t *)sqlite3_value_blob(argv[0]),
+	    (const char *)sqlite3_value_text(argv[1]),
+	    0, NULL, 0));
+}
+
+static void
+sql_append(char **sql, size_t *sz, const char *newstr, int count)
+{
+	size_t		 newsz;
+
+	newsz = 1 < count ? (size_t)count : strlen(newstr);
+	*sql = mandoc_realloc(*sql, *sz + newsz + 1);
+	if (1 < count)
+		memset(*sql + *sz, *newstr, (size_t)count);
+	else
+		memcpy(*sql + *sz, newstr, newsz);
+	*sz += newsz;
+	(*sql)[*sz] = '\0';
+}
+
+/*
  * Prepare the search SQL statement.
- * We search for any of the words specified in our match expression.
- * We filter the per-doc AND expressions when collecting results.
  */
 static char *
-sql_statement(const struct expr *e, const char *arch, const char *sec)
+sql_statement(const struct expr *e)
 {
 	char		*sql;
-	const char	*glob = "(key GLOB ? AND bits & ?)";
-	const char	*eq = "(key = ? AND bits & ?)";
-	const char	*andarch = "arch = ? AND ";
-	const char	*andsec = "sec = ? AND ";
-	const size_t	 globsz = 27;
-	const size_t	 eqsz = 22;
 	size_t		 sz;
+	int		 needop;
 
-	sql = mandoc_strdup
-		("SELECT docid,bits,key,file,desc,form,sec,arch "
-		 "FROM keys "
-		 "INNER JOIN docs ON docs.id=keys.docid "
-		 "WHERE ");
+	sql = mandoc_strdup("SELECT * FROM mpages WHERE ");
 	sz = strlen(sql);
 
-	if (NULL != arch) {
-		sz += strlen(andarch) + 1;
-		sql = mandoc_realloc(sql, sz);
-		strlcat(sql, andarch, sz);
+	for (needop = 0; NULL != e; e = e->next) {
+		if (e->and)
+			sql_append(&sql, &sz, " AND ", 1);
+		else if (needop)
+			sql_append(&sql, &sz, " OR ", 1);
+		if (e->open)
+			sql_append(&sql, &sz, "(", e->open);
+		sql_append(&sql, &sz, NULL == e->substr ?
+		    "id IN (SELECT pageid FROM keys "
+		    "WHERE key REGEXP ? AND bits & ?)" :
+		    "id IN (SELECT pageid FROM keys "
+		    "WHERE key MATCH ? AND bits & ?)", 1);
+		if (e->close)
+			sql_append(&sql, &sz, ")", e->close);
+		needop = 1;
 	}
-	if (NULL != sec) {
-		sz += strlen(andsec) + 1;
-		sql = mandoc_realloc(sql, sz);
-		strlcat(sql, andsec, sz);
-	}
 
-	sz += 2;
-	sql = mandoc_realloc(sql, sz);
-	strlcat(sql, "(", sz);
-
-	for ( ; NULL != e; e = e->next) {
-		sz += (e->glob ? globsz : eqsz) + 
-			(NULL == e->next ? 3 : 5);
-		sql = mandoc_realloc(sql, sz);
-		strlcat(sql, e->glob ? glob : eq, sz);
-		strlcat(sql, NULL == e->next ? ");" : " OR ", sz);
-	}
-
 	return(sql);
 }
 
@@ -328,41 +511,123 @@ sql_statement(const struct expr *e, const char *arch, 
  * "(", "foo=bar", etc.).
  */
 static struct expr *
-exprcomp(int argc, char *argv[])
+exprcomp(const struct mansearch *search, int argc, char *argv[])
 {
-	int		 i;
+	int		 i, toopen, logic, igncase, toclose;
 	struct expr	*first, *next, *cur;
 
 	first = cur = NULL;
+	logic = igncase = toclose = 0;
+	toopen = 1;
 
 	for (i = 0; i < argc; i++) {
-		next = exprterm(argv[i]);
-		if (NULL == next) {
-			exprfree(first);
-			return(NULL);
+		if (0 == strcmp("(", argv[i])) {
+			if (igncase)
+				goto fail;
+			toopen++;
+			toclose++;
+			continue;
+		} else if (0 == strcmp(")", argv[i])) {
+			if (toopen || logic || igncase || NULL == cur)
+				goto fail;
+			cur->close++;
+			if (0 > --toclose)
+				goto fail;
+			continue;
+		} else if (0 == strcmp("-a", argv[i])) {
+			if (toopen || logic || igncase || NULL == cur)
+				goto fail;
+			logic = 1;
+			continue;
+		} else if (0 == strcmp("-o", argv[i])) {
+			if (toopen || logic || igncase || NULL == cur)
+				goto fail;
+			logic = 2;
+			continue;
+		} else if (0 == strcmp("-i", argv[i])) {
+			if (igncase)
+				goto fail;
+			igncase = 1;
+			continue;
 		}
+		next = exprterm(search, argv[i], !igncase);
+		if (NULL == next)
+			goto fail;
+		next->open = toopen;
+		next->and = (1 == logic);
 		if (NULL != first) {
 			cur->next = next;
 			cur = next;
 		} else
 			cur = first = next;
+		toopen = logic = igncase = 0;
 	}
+	if (toopen || logic || igncase || toclose)
+		goto fail;
 
+	cur->close++;
+	cur = exprspec(cur, TYPE_arch, search->arch, "^(%s|any)$");
+	exprspec(cur, TYPE_sec, search->sec, "^%s$");
+
 	return(first);
+
+fail:
+	if (NULL != first)
+		exprfree(first);
+	return(NULL);
 }
 
 static struct expr *
-exprterm(char *buf)
+exprspec(struct expr *cur, uint64_t key, const char *value,
+		const char *format)
 {
+	char	 errbuf[BUFSIZ];
+	char	*cp;
+	int	 irc;
+
+	if (NULL == value)
+		return(cur);
+
+	if (-1 == asprintf(&cp, format, value)) {
+		perror(0);
+		exit((int)MANDOCLEVEL_SYSERR);
+	}
+	cur->next = mandoc_calloc(1, sizeof(struct expr));
+	cur = cur->next;
+	cur->and = 1;
+	cur->bits = key;
+	if (0 != (irc = regcomp(&cur->regexp, cp,
+	    REG_EXTENDED | REG_NOSUB | REG_ICASE))) {
+		regerror(irc, &cur->regexp, errbuf, sizeof(errbuf));
+		fprintf(stderr, "regcomp: %s\n", errbuf);
+		cur->substr = value;
+	}
+	free(cp);
+	return(cur);
+}
+
+static struct expr *
+exprterm(const struct mansearch *search, char *buf, int cs)
+{
+	char		 errbuf[BUFSIZ];
 	struct expr	*e;
 	char		*key, *v;
 	size_t		 i;
+	int		 irc;
 
 	if ('\0' == *buf)
 		return(NULL);
 
 	e = mandoc_calloc(1, sizeof(struct expr));
 
+	/*"whatis" mode uses an opaque string and default fields. */
+
+	if (MANSEARCH_WHATIS & search->flags) {
+		e->substr = buf;
+		e->bits = search->deftype;
+		return(e);
+	}
+
 	/*
 	 * If no =~ is specified, search with equality over names and
 	 * descriptions.
@@ -370,15 +635,23 @@ exprterm(char *buf)
 	 */
 
 	if (NULL == (v = strpbrk(buf, "=~"))) {
-		e->v = buf;
-		e->bits = TYPE_Nm | TYPE_Nd;
+		e->substr = buf;
+		e->bits = search->deftype;
 		return(e);
 	} else if (v == buf)
-		e->bits = TYPE_Nm | TYPE_Nd;
+		e->bits = search->deftype;
 
-	e->glob = '~' == *v;
-	*v++ = '\0';
-	e->v = v;
+	if ('~' == *v++) {
+		if (0 != (irc = regcomp(&e->regexp, v,
+		    REG_EXTENDED | REG_NOSUB | (cs ? 0 : REG_ICASE)))) {
+			regerror(irc, &e->regexp, errbuf, sizeof(errbuf));
+			fprintf(stderr, "regcomp: %s\n", errbuf);
+			free(e);
+			return(NULL);
+		}
+	} else
+		e->substr = v;
+	v[-1] = '\0';
 
 	/*
 	 * Parse out all possible fields.