=================================================================== RCS file: /cvs/mandoc/mansearch.c,v retrieving revision 1.5 retrieving revision 1.12 diff -u -p -r1.5 -r1.12 --- mandoc/mansearch.c 2012/06/09 14:11:16 1.5 +++ mandoc/mansearch.c 2013/12/31 03:41:14 1.12 @@ -1,6 +1,7 @@ -/* $Id: mansearch.c,v 1.5 2012/06/09 14:11:16 kristaps Exp $ */ +/* $Id: mansearch.c,v 1.12 2013/12/31 03:41:14 schwarze Exp $ */ /* * Copyright (c) 2012 Kristaps Dzonsons + * Copyright (c) 2013 Ingo Schwarze * * 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 - #include #include #include +#include +#include #include #include #include @@ -42,19 +43,26 @@ #include "mansearch.h" #define SQL_BIND_TEXT(_db, _s, _i, _v) \ - if (SQLITE_OK != sqlite3_bind_text \ + do { if (SQLITE_OK != sqlite3_bind_text \ ((_s), (_i)++, (_v), -1, SQLITE_STATIC)) \ - fprintf(stderr, "%s\n", sqlite3_errmsg((_db))) + fprintf(stderr, "%s\n", sqlite3_errmsg((_db))); \ + } while (0) #define SQL_BIND_INT64(_db, _s, _i, _v) \ - if (SQLITE_OK != sqlite3_bind_int64 \ + do { if (SQLITE_OK != sqlite3_bind_int64 \ ((_s), (_i)++, (_v))) \ - fprintf(stderr, "%s\n", sqlite3_errmsg((_db))) + 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 */ + struct expr *next; /* next in sequence */ }; struct match { @@ -113,29 +121,39 @@ static const struct type types[] = { { 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(const struct mansearch *, int, char *[]); static void exprfree(struct expr *); -static struct expr *exprterm(const struct mansearch *, char *); +static struct expr *exprterm(const struct mansearch *, char *, int); +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 *, const char *, const char *); int mansearch(const struct mansearch *search, - const struct manpaths *paths, - int argc, char *argv[], + const struct manpaths *paths, + int argc, char *argv[], + const char *outkey, struct manpage **res, size_t *sz) { - int fd, rc, c; + 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; @@ -161,6 +179,16 @@ mansearch(const struct mansearch *search, 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, @@ -168,7 +196,7 @@ mansearch(const struct mansearch *search, * 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))) { @@ -206,6 +234,18 @@ mansearch(const struct mansearch *search, continue; } + /* + * Define the SQL functions for substring + * and regular expression matching. + */ + + 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) @@ -217,7 +257,10 @@ mansearch(const struct mansearch *search, SQL_BIND_TEXT(db, s, j, search->sec); for (ep = e; NULL != ep; ep = ep->next) { - SQL_BIND_TEXT(db, s, j, ep->v); + 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); } @@ -255,8 +298,19 @@ mansearch(const struct mansearch *search, 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)) { @@ -265,16 +319,26 @@ mansearch(const struct mansearch *search, *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; @@ -287,7 +351,110 @@ out: 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)); +} + +/* * 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. @@ -296,22 +463,22 @@ static char * sql_statement(const struct expr *e, const char *arch, const char *sec) { char *sql; - const char *glob = "(key GLOB ? AND bits & ?)"; - const char *eq = "(key = ? AND bits & ?)"; + const char *substr = "(key MATCH ? AND bits & ?)"; + const char *regexp = "(key REGEXP ? AND bits & ?)"; const char *andarch = "arch = ? AND "; const char *andsec = "sec = ? AND "; - size_t globsz; - size_t eqsz; + size_t substrsz; + size_t regexpsz; size_t sz; sql = mandoc_strdup - ("SELECT docid,bits,key,file,desc,form,sec,arch " + ("SELECT pageid,bits,key,file,desc,form,sec,arch " "FROM keys " - "INNER JOIN docs ON docs.id=keys.docid " + "INNER JOIN mpages ON mpages.id=keys.pageid " "WHERE "); sz = strlen(sql); - globsz = strlen(glob); - eqsz = strlen(eq); + substrsz = strlen(substr); + regexpsz = strlen(regexp); if (NULL != arch) { sz += strlen(andarch) + 1; @@ -330,10 +497,10 @@ sql_statement(const struct expr *e, const char *arch, strlcat(sql, "(", sz); for ( ; NULL != e; e = e->next) { - sz += (e->glob ? globsz : eqsz) + + sz += (NULL == e->substr ? regexpsz : substrsz) + (NULL == e->next ? 3 : 5); sql = mandoc_realloc(sql, sz); - strlcat(sql, e->glob ? glob : eq, sz); + strlcat(sql, NULL == e->substr ? regexp : substr, sz); strlcat(sql, NULL == e->next ? ");" : " OR ", sz); } @@ -348,13 +515,19 @@ sql_statement(const struct expr *e, const char *arch, static struct expr * exprcomp(const struct mansearch *search, int argc, char *argv[]) { - int i; + int i, cs; struct expr *first, *next, *cur; first = cur = NULL; for (i = 0; i < argc; i++) { - next = exprterm(search, argv[i]); + if (0 == strcmp("-i", argv[i])) { + if (++i >= argc) + return(NULL); + cs = 0; + } else + cs = 1; + next = exprterm(search, argv[i], cs); if (NULL == next) { exprfree(first); return(NULL); @@ -370,7 +543,7 @@ exprcomp(const struct mansearch *search, int argc, cha } static struct expr * -exprterm(const struct mansearch *search, char *buf) +exprterm(const struct mansearch *search, char *buf, int cs) { struct expr *e; char *key, *v; @@ -384,7 +557,7 @@ exprterm(const struct mansearch *search, char *buf) /*"whatis" mode uses an opaque string and default fields. */ if (MANSEARCH_WHATIS & search->flags) { - e->v = buf; + e->substr = buf; e->bits = search->deftype; return(e); } @@ -396,15 +569,21 @@ exprterm(const struct mansearch *search, char *buf) */ if (NULL == (v = strpbrk(buf, "=~"))) { - e->v = buf; + e->substr = buf; e->bits = search->deftype; return(e); } else if (v == buf) e->bits = search->deftype; - e->glob = '~' == *v; - *v++ = '\0'; - e->v = v; + if ('~' == *v++) { + if (regcomp(&e->regexp, v, + REG_EXTENDED | REG_NOSUB | (cs ? 0 : REG_ICASE))) { + free(e); + return(NULL); + } + } else + e->substr = v; + v[-1] = '\0'; /* * Parse out all possible fields.