]>
git.cameronkatri.com Git - mandoc.git/blob - mansearch.c
1 /* $Id: mansearch.c,v 1.47 2014/09/01 22:45:53 schwarze Exp $ */
3 * Copyright (c) 2012 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 #include <sys/types.h>
38 #include "compat_ohash.h"
41 #ifndef SQLITE_DETERMINISTIC
42 #define SQLITE_DETERMINISTIC 0
46 #include "mandoc_aux.h"
48 #include "mansearch.h"
50 extern int mansearch_keymax
;
51 extern const char *const mansearch_keynames
[];
53 #define SQL_BIND_TEXT(_db, _s, _i, _v) \
54 do { if (SQLITE_OK != sqlite3_bind_text \
55 ((_s), (_i)++, (_v), -1, SQLITE_STATIC)) \
56 fprintf(stderr, "%s\n", sqlite3_errmsg((_db))); \
58 #define SQL_BIND_INT64(_db, _s, _i, _v) \
59 do { if (SQLITE_OK != sqlite3_bind_int64 \
60 ((_s), (_i)++, (_v))) \
61 fprintf(stderr, "%s\n", sqlite3_errmsg((_db))); \
63 #define SQL_BIND_BLOB(_db, _s, _i, _v) \
64 do { if (SQLITE_OK != sqlite3_bind_blob \
65 ((_s), (_i)++, (&_v), sizeof(_v), SQLITE_STATIC)) \
66 fprintf(stderr, "%s\n", sqlite3_errmsg((_db))); \
70 regex_t regexp
; /* compiled regexp, if applicable */
71 const char *substr
; /* to search for, if applicable */
72 struct expr
*next
; /* next in sequence */
73 uint64_t bits
; /* type-mask */
74 int equal
; /* equality, not subsring match */
75 int open
; /* opening parentheses before */
76 int and; /* logical AND before */
77 int close
; /* closing parentheses after */
81 uint64_t pageid
; /* identifier in database */
82 char *desc
; /* manual page description */
83 int form
; /* 0 == catpage */
86 static void buildnames(struct manpage
*, sqlite3
*,
87 sqlite3_stmt
*, uint64_t,
88 const char *, int form
);
89 static char *buildoutput(sqlite3
*, sqlite3_stmt
*,
91 static void *hash_alloc(size_t, void *);
92 static void hash_free(void *, void *);
93 static void *hash_calloc(size_t, size_t, void *);
94 static struct expr
*exprcomp(const struct mansearch
*,
96 static void exprfree(struct expr
*);
97 static struct expr
*exprspec(struct expr
*, uint64_t,
98 const char *, const char *);
99 static struct expr
*exprterm(const struct mansearch
*, char *, int);
100 static int manpage_compare(const void *, const void *);
101 static void sql_append(char **sql
, size_t *sz
,
102 const char *newstr
, int count
);
103 static void sql_match(sqlite3_context
*context
,
104 int argc
, sqlite3_value
**argv
);
105 static void sql_regexp(sqlite3_context
*context
,
106 int argc
, sqlite3_value
**argv
);
107 static char *sql_statement(const struct expr
*);
111 mansearch_setup(int start
)
113 static void *pagecache
;
116 #define PC_PAGESIZE 1280
117 #define PC_NUMPAGES 256
120 if (NULL
!= pagecache
) {
121 fprintf(stderr
, "pagecache already enabled\n");
122 return((int)MANDOCLEVEL_BADARG
);
125 pagecache
= mmap(NULL
, PC_PAGESIZE
* PC_NUMPAGES
,
126 PROT_READ
| PROT_WRITE
,
127 MAP_SHARED
| MAP_ANON
, -1, 0);
129 if (MAP_FAILED
== pagecache
) {
132 return((int)MANDOCLEVEL_SYSERR
);
135 c
= sqlite3_config(SQLITE_CONFIG_PAGECACHE
,
136 pagecache
, PC_PAGESIZE
, PC_NUMPAGES
);
139 return((int)MANDOCLEVEL_OK
);
141 fprintf(stderr
, "pagecache: %s\n", sqlite3_errstr(c
));
143 } else if (NULL
== pagecache
) {
144 fprintf(stderr
, "pagecache missing\n");
145 return((int)MANDOCLEVEL_BADARG
);
148 if (-1 == munmap(pagecache
, PC_PAGESIZE
* PC_NUMPAGES
)) {
151 return((int)MANDOCLEVEL_SYSERR
);
155 return((int)MANDOCLEVEL_OK
);
159 mansearch(const struct mansearch
*search
,
160 const struct manpaths
*paths
,
161 int argc
, char *argv
[],
162 struct manpage
**res
, size_t *sz
)
164 int fd
, rc
, c
, indexbit
;
166 uint64_t outbit
, iterbit
;
169 struct manpage
*mpage
;
172 sqlite3_stmt
*s
, *s2
;
174 struct ohash_info info
;
177 size_t i
, j
, cur
, maxres
;
179 info
.calloc
= hash_calloc
;
180 info
.alloc
= hash_alloc
;
181 info
.free
= hash_free
;
182 info
.key_offset
= offsetof(struct match
, pageid
);
184 *sz
= cur
= maxres
= 0;
193 if (NULL
== (e
= exprcomp(search
, argc
, argv
)))
197 if (NULL
!= search
->outkey
) {
198 for (indexbit
= 0, iterbit
= 1;
199 indexbit
< mansearch_keymax
;
200 indexbit
++, iterbit
<<= 1) {
201 if (0 == strcasecmp(search
->outkey
,
202 mansearch_keynames
[indexbit
])) {
210 * Save a descriptor to the current working directory.
211 * Since pathnames in the "paths" variable might be relative,
212 * and we'll be chdir()ing into them, we need to keep a handle
213 * on our current directory from which to start the chdir().
216 if (NULL
== getcwd(buf
, PATH_MAX
)) {
219 } else if (-1 == (fd
= open(buf
, O_RDONLY
, 0))) {
224 sql
= sql_statement(e
);
227 * Loop over the directories (containing databases) for us to
229 * Don't let missing/bad databases/directories phase us.
230 * In each, try to open the resident database and, if it opens,
231 * scan it for our match expression.
234 for (i
= 0; i
< paths
->sz
; i
++) {
235 if (-1 == fchdir(fd
)) {
239 } else if (-1 == chdir(paths
->paths
[i
])) {
240 perror(paths
->paths
[i
]);
244 c
= sqlite3_open_v2(MANDOC_DB
, &db
,
245 SQLITE_OPEN_READONLY
, NULL
);
247 if (SQLITE_OK
!= c
) {
254 * Define the SQL functions for substring
255 * and regular expression matching.
258 c
= sqlite3_create_function(db
, "match", 2,
259 SQLITE_UTF8
| SQLITE_DETERMINISTIC
,
260 NULL
, sql_match
, NULL
, NULL
);
261 assert(SQLITE_OK
== c
);
262 c
= sqlite3_create_function(db
, "regexp", 2,
263 SQLITE_UTF8
| SQLITE_DETERMINISTIC
,
264 NULL
, sql_regexp
, NULL
, NULL
);
265 assert(SQLITE_OK
== c
);
268 c
= sqlite3_prepare_v2(db
, sql
, -1, &s
, NULL
);
270 fprintf(stderr
, "%s\n", sqlite3_errmsg(db
));
272 for (ep
= e
; NULL
!= ep
; ep
= ep
->next
) {
273 if (NULL
== ep
->substr
) {
274 SQL_BIND_BLOB(db
, s
, j
, ep
->regexp
);
276 SQL_BIND_TEXT(db
, s
, j
, ep
->substr
);
277 if (0 == ((TYPE_Nd
| TYPE_Nm
) & ep
->bits
))
278 SQL_BIND_INT64(db
, s
, j
, ep
->bits
);
281 memset(&htab
, 0, sizeof(struct ohash
));
282 ohash_init(&htab
, 4, &info
);
285 * Hash each entry on its [unique] document identifier.
286 * This is a uint64_t.
287 * Instead of using a hash function, simply convert the
288 * uint64_t to a uint32_t, the hash value's type.
289 * This gives good performance and preserves the
290 * distribution of buckets in the table.
292 while (SQLITE_ROW
== (c
= sqlite3_step(s
))) {
293 pageid
= sqlite3_column_int64(s
, 2);
294 idx
= ohash_lookup_memory(&htab
,
295 (char *)&pageid
, sizeof(uint64_t),
298 if (NULL
!= ohash_find(&htab
, idx
))
301 mp
= mandoc_calloc(1, sizeof(struct match
));
303 mp
->form
= sqlite3_column_int(s
, 1);
304 if (TYPE_Nd
== outbit
)
305 mp
->desc
= mandoc_strdup((const char *)
306 sqlite3_column_text(s
, 0));
307 ohash_insert(&htab
, idx
, mp
);
310 if (SQLITE_DONE
!= c
)
311 fprintf(stderr
, "%s\n", sqlite3_errmsg(db
));
315 c
= sqlite3_prepare_v2(db
,
316 "SELECT sec, arch, name, pageid FROM mlinks "
317 "WHERE pageid=? ORDER BY sec, arch, name",
320 fprintf(stderr
, "%s\n", sqlite3_errmsg(db
));
322 c
= sqlite3_prepare_v2(db
,
323 "SELECT bits, key, pageid FROM keys "
324 "WHERE pageid=? AND bits & ?",
327 fprintf(stderr
, "%s\n", sqlite3_errmsg(db
));
329 for (mp
= ohash_first(&htab
, &idx
);
331 mp
= ohash_next(&htab
, &idx
)) {
332 if (cur
+ 1 > maxres
) {
334 *res
= mandoc_reallocarray(*res
,
335 maxres
, sizeof(struct manpage
));
340 mpage
->form
= mp
->form
;
341 buildnames(mpage
, db
, s
, mp
->pageid
,
342 paths
->paths
[i
], mp
->form
);
343 mpage
->output
= TYPE_Nd
& outbit
?
345 buildoutput(db
, s2
, mp
->pageid
, outbit
) : NULL
;
352 sqlite3_finalize(s2
);
356 qsort(*res
, cur
, sizeof(struct manpage
), manpage_compare
);
360 if (-1 == fchdir(fd
))
371 mansearch_free(struct manpage
*res
, size_t sz
)
375 for (i
= 0; i
< sz
; i
++) {
384 manpage_compare(const void *vp1
, const void *vp2
)
386 const struct manpage
*mp1
, *mp2
;
391 diff
= mp1
->sec
- mp2
->sec
;
392 return(diff
? diff
: strcasecmp(mp1
->names
, mp2
->names
));
396 buildnames(struct manpage
*mpage
, sqlite3
*db
, sqlite3_stmt
*s
,
397 uint64_t pageid
, const char *path
, int form
)
399 char *newnames
, *prevsec
, *prevarch
;
400 const char *oldnames
, *sep1
, *name
, *sec
, *sep2
, *arch
, *fsec
;
406 prevsec
= prevarch
= NULL
;
408 SQL_BIND_INT64(db
, s
, i
, pageid
);
409 while (SQLITE_ROW
== (c
= sqlite3_step(s
))) {
411 /* Decide whether we already have some names. */
413 if (NULL
== mpage
->names
) {
417 oldnames
= mpage
->names
;
421 /* Fetch the next name. */
423 sec
= (const char *)sqlite3_column_text(s
, 0);
424 arch
= (const char *)sqlite3_column_text(s
, 1);
425 name
= (const char *)sqlite3_column_text(s
, 2);
427 /* Remember the first section found. */
429 if (9 < mpage
->sec
&& '1' <= *sec
&& '9' >= *sec
)
430 mpage
->sec
= (*sec
- '1') + 1;
432 /* If the section changed, append the old one. */
434 if (NULL
!= prevsec
&&
435 (strcmp(sec
, prevsec
) ||
436 strcmp(arch
, prevarch
))) {
437 sep2
= '\0' == *prevarch
? "" : "/";
438 mandoc_asprintf(&newnames
, "%s(%s%s%s)",
439 oldnames
, prevsec
, sep2
, prevarch
);
441 oldnames
= mpage
->names
= newnames
;
444 prevsec
= prevarch
= NULL
;
447 /* Save the new section, to append it later. */
449 if (NULL
== prevsec
) {
450 prevsec
= mandoc_strdup(sec
);
451 prevarch
= mandoc_strdup(arch
);
454 /* Append the new name. */
456 mandoc_asprintf(&newnames
, "%s%s%s",
457 oldnames
, sep1
, name
);
459 mpage
->names
= newnames
;
461 /* Also save the first file name encountered. */
463 if (NULL
!= mpage
->file
)
473 sep2
= '\0' == *arch
? "" : "/";
474 mandoc_asprintf(&mpage
->file
, "%s/%s%s%s%s/%s.%s",
475 path
, sep1
, sec
, sep2
, arch
, name
, fsec
);
477 if (SQLITE_DONE
!= c
)
478 fprintf(stderr
, "%s\n", sqlite3_errmsg(db
));
481 /* Append one final section to the names. */
483 if (NULL
!= prevsec
) {
484 sep2
= '\0' == *prevarch
? "" : "/";
485 mandoc_asprintf(&newnames
, "%s(%s%s%s)",
486 mpage
->names
, prevsec
, sep2
, prevarch
);
488 mpage
->names
= newnames
;
495 buildoutput(sqlite3
*db
, sqlite3_stmt
*s
, uint64_t pageid
, uint64_t outbit
)
497 char *output
, *newoutput
;
498 const char *oldoutput
, *sep1
, *data
;
504 SQL_BIND_INT64(db
, s
, i
, pageid
);
505 SQL_BIND_INT64(db
, s
, i
, outbit
);
506 while (SQLITE_ROW
== (c
= sqlite3_step(s
))) {
507 if (NULL
== output
) {
514 data
= (const char *)sqlite3_column_text(s
, 1);
515 mandoc_asprintf(&newoutput
, "%s%s%s",
516 oldoutput
, sep1
, data
);
520 if (SQLITE_DONE
!= c
)
521 fprintf(stderr
, "%s\n", sqlite3_errmsg(db
));
527 * Implement substring match as an application-defined SQL function.
528 * Using the SQL LIKE or GLOB operators instead would be a bad idea
529 * because that would require escaping metacharacters in the string
530 * being searched for.
533 sql_match(sqlite3_context
*context
, int argc
, sqlite3_value
**argv
)
537 sqlite3_result_int(context
, NULL
!= strcasestr(
538 (const char *)sqlite3_value_text(argv
[1]),
539 (const char *)sqlite3_value_text(argv
[0])));
543 * Implement regular expression match
544 * as an application-defined SQL function.
547 sql_regexp(sqlite3_context
*context
, int argc
, sqlite3_value
**argv
)
551 sqlite3_result_int(context
, !regexec(
552 (regex_t
*)sqlite3_value_blob(argv
[0]),
553 (const char *)sqlite3_value_text(argv
[1]),
558 sql_append(char **sql
, size_t *sz
, const char *newstr
, int count
)
562 newsz
= 1 < count
? (size_t)count
: strlen(newstr
);
563 *sql
= mandoc_realloc(*sql
, *sz
+ newsz
+ 1);
565 memset(*sql
+ *sz
, *newstr
, (size_t)count
);
567 memcpy(*sql
+ *sz
, newstr
, newsz
);
573 * Prepare the search SQL statement.
576 sql_statement(const struct expr
*e
)
583 "SELECT desc, form, pageid FROM mpages WHERE ");
586 for (needop
= 0; NULL
!= e
; e
= e
->next
) {
588 sql_append(&sql
, &sz
, " AND ", 1);
590 sql_append(&sql
, &sz
, " OR ", 1);
592 sql_append(&sql
, &sz
, "(", e
->open
);
593 sql_append(&sql
, &sz
,
600 ? "pageid IN (SELECT pageid FROM names "
601 "WHERE name REGEXP ?)"
603 ? "pageid IN (SELECT pageid FROM names "
605 : "pageid IN (SELECT pageid FROM names "
606 "WHERE name MATCH ?)")
608 ? "pageid IN (SELECT pageid FROM keys "
609 "WHERE key REGEXP ? AND bits & ?)"
610 : "pageid IN (SELECT pageid FROM keys "
611 "WHERE key MATCH ? AND bits & ?)"), 1);
613 sql_append(&sql
, &sz
, ")", e
->close
);
621 * Compile a set of string tokens into an expression.
622 * Tokens in "argv" are assumed to be individual expression atoms (e.g.,
623 * "(", "foo=bar", etc.).
626 exprcomp(const struct mansearch
*search
, int argc
, char *argv
[])
629 int i
, toopen
, logic
, igncase
, toclose
;
630 struct expr
*first
, *prev
, *cur
, *next
;
633 logic
= igncase
= toclose
= 0;
634 toopen
= NULL
!= search
->sec
|| NULL
!= search
->arch
;
636 for (i
= 0; i
< argc
; i
++) {
637 if (0 == strcmp("(", argv
[i
])) {
643 } else if (0 == strcmp(")", argv
[i
])) {
644 if (toopen
|| logic
|| igncase
|| NULL
== cur
)
650 } else if (0 == strcmp("-a", argv
[i
])) {
651 if (toopen
|| logic
|| igncase
|| NULL
== cur
)
655 } else if (0 == strcmp("-o", argv
[i
])) {
656 if (toopen
|| logic
|| igncase
|| NULL
== cur
)
660 } else if (0 == strcmp("-i", argv
[i
])) {
666 next
= exprterm(search
, argv
[i
], !igncase
);
676 * Searching for descriptions must be split out
677 * because they are stored in the mpages table,
678 * not in the keys table.
681 for (mask
= TYPE_Nm
; mask
<= TYPE_Nd
; mask
<<= 1) {
682 if (mask
& cur
->bits
&& ~mask
& cur
->bits
) {
683 next
= mandoc_calloc(1,
684 sizeof(struct expr
));
685 memcpy(next
, cur
, sizeof(struct expr
));
693 prev
->and = (1 == logic
);
694 prev
->open
+= toopen
;
698 toopen
= logic
= igncase
= 0;
700 if (toopen
|| logic
|| igncase
|| toclose
)
703 if (NULL
!= search
->sec
|| NULL
!= search
->arch
)
705 if (NULL
!= search
->arch
)
706 cur
= exprspec(cur
, TYPE_arch
, search
->arch
, "^(%s|any)$");
707 if (NULL
!= search
->sec
)
708 exprspec(cur
, TYPE_sec
, search
->sec
, "^%s$");
719 exprspec(struct expr
*cur
, uint64_t key
, const char *value
,
726 mandoc_asprintf(&cp
, format
, value
);
727 cur
->next
= mandoc_calloc(1, sizeof(struct expr
));
731 if (0 != (irc
= regcomp(&cur
->regexp
, cp
,
732 REG_EXTENDED
| REG_NOSUB
| REG_ICASE
))) {
733 regerror(irc
, &cur
->regexp
, errbuf
, sizeof(errbuf
));
734 fprintf(stderr
, "regcomp: %s\n", errbuf
);
742 exprterm(const struct mansearch
*search
, char *buf
, int cs
)
753 e
= mandoc_calloc(1, sizeof(struct expr
));
755 if (search
->argmode
== ARG_NAME
) {
763 * Separate macro keys from search string.
764 * If needed, request regular expression handling
765 * by setting e->substr to NULL.
768 if (search
->argmode
== ARG_WORD
) {
771 mandoc_asprintf(&val
, "[[:<:]]%s[[:>:]]", buf
);
773 } else if ((val
= strpbrk(buf
, "=~")) == NULL
) {
774 e
->bits
= TYPE_Nm
| TYPE_Nd
;
778 e
->bits
= TYPE_Nm
| TYPE_Nd
;
782 if (NULL
!= strstr(buf
, "arch"))
786 /* Compile regular expressions. */
788 if (NULL
== e
->substr
) {
789 irc
= regcomp(&e
->regexp
, val
,
790 REG_EXTENDED
| REG_NOSUB
| (cs
? 0 : REG_ICASE
));
791 if (search
->argmode
== ARG_WORD
)
794 regerror(irc
, &e
->regexp
, errbuf
, sizeof(errbuf
));
795 fprintf(stderr
, "regcomp: %s\n", errbuf
);
805 * Parse out all possible fields.
806 * If the field doesn't resolve, bail.
809 while (NULL
!= (key
= strsep(&buf
, ","))) {
812 for (i
= 0, iterbit
= 1;
813 i
< mansearch_keymax
;
814 i
++, iterbit
<<= 1) {
815 if (0 == strcasecmp(key
,
816 mansearch_keynames
[i
])) {
821 if (i
== mansearch_keymax
) {
822 if (strcasecmp(key
, "any")) {
834 exprfree(struct expr
*p
)
846 hash_calloc(size_t nmemb
, size_t sz
, void *arg
)
849 return(mandoc_calloc(nmemb
, sz
));
853 hash_alloc(size_t sz
, void *arg
)
856 return(mandoc_malloc(sz
));
860 hash_free(void *p
, void *arg
)