=================================================================== RCS file: /cvs/mandoc/mandocdb.c,v retrieving revision 1.140 retrieving revision 1.150 diff -u -p -r1.140 -r1.150 --- mandoc/mandocdb.c 2014/04/19 02:56:54 1.140 +++ mandoc/mandocdb.c 2014/06/19 00:45:37 1.150 @@ -1,4 +1,4 @@ -/* $Id: mandocdb.c,v 1.140 2014/04/19 02:56:54 schwarze Exp $ */ +/* $Id: mandocdb.c,v 1.150 2014/06/19 00:45:37 schwarze Exp $ */ /* * Copyright (c) 2011, 2012 Kristaps Dzonsons * Copyright (c) 2011, 2012, 2013, 2014 Ingo Schwarze @@ -180,12 +180,12 @@ static char tempfilename[32]; static char *progname; static int nodb; /* no database changes */ static int mparse_options; /* abort the parse early */ -static int use_all; /* use all found files */ -static int debug; /* print what we're doing */ -static int warnings; /* warn about crap */ +static int use_all; /* use all found files */ +static int debug; /* print what we're doing */ +static int warnings; /* warn about crap */ static int write_utf8; /* write UTF-8 output; else ASCII */ static int exitcode; /* to be returned by main */ -static enum op op; /* operational mode */ +static enum op op; /* operational mode */ static char basedir[PATH_MAX]; /* current base directory */ static struct ohash mpages; /* table of distinct manual pages */ static struct ohash mlinks; /* table of directory entries */ @@ -320,6 +320,7 @@ static const struct mdoc_handler mdocs[MDOC_MAX] = { { NULL, 0 }, /* Ta */ }; + int main(int argc, char *argv[]) { @@ -348,7 +349,7 @@ main(int argc, char *argv[]) ++progname; /* - * We accept a few different invocations. + * We accept a few different invocations. * The CHECKOP macro makes sure that invocation styles don't * clobber each other. */ @@ -363,32 +364,32 @@ main(int argc, char *argv[]) while (-1 != (ch = getopt(argc, argv, "aC:Dd:npQT:tu:v"))) switch (ch) { - case ('a'): + case 'a': use_all = 1; break; - case ('C'): + case 'C': CHECKOP(op, ch); path_arg = optarg; op = OP_CONFFILE; break; - case ('D'): + case 'D': debug++; break; - case ('d'): + case 'd': CHECKOP(op, ch); path_arg = optarg; op = OP_UPDATE; break; - case ('n'): + case 'n': nodb = 1; break; - case ('p'): + case 'p': warnings = 1; break; - case ('Q'): + case 'Q': mparse_options |= MPARSE_QUICK; break; - case ('T'): + case 'T': if (strcmp(optarg, "utf8")) { fprintf(stderr, "-T%s: Unsupported " "output format\n", optarg); @@ -396,18 +397,18 @@ main(int argc, char *argv[]) } write_utf8 = 1; break; - case ('t'): + case 't': CHECKOP(op, ch); dup2(STDOUT_FILENO, STDERR_FILENO); op = OP_TEST; nodb = warnings = 1; break; - case ('u'): + case 'u': CHECKOP(op, ch); path_arg = optarg; op = OP_DELETE; break; - case ('v'): + case 'v': /* Compatibility with espie@'s makewhatis. */ break; default: @@ -432,10 +433,10 @@ main(int argc, char *argv[]) if (OP_UPDATE == op || OP_DELETE == op || OP_TEST == op) { /* - * All of these deal with a specific directory. + * Most of these deal with a specific directory. * Jump into that directory first. */ - if (0 == set_basedir(path_arg)) + if (OP_TEST != op && 0 == set_basedir(path_arg)) goto out; if (dbopen(1)) { @@ -470,8 +471,8 @@ main(int argc, char *argv[]) * manpath_parse() wants to do it. */ if (argc > 0) { - dirs.paths = mandoc_calloc - (argc, sizeof(char *)); + dirs.paths = mandoc_reallocarray(NULL, + argc, sizeof(char *)); dirs.sz = (size_t)argc; for (i = 0; i < argc; i++) dirs.paths[i] = mandoc_strdup(argv[i]); @@ -511,7 +512,7 @@ main(int argc, char *argv[]) goto out; mpages_merge(mc, mp); - if (warnings && + if (warnings && !nodb && ! (MPARSE_QUICK & mparse_options)) names_check(); dbclose(0); @@ -524,7 +525,6 @@ main(int argc, char *argv[]) } } out: - set_basedir(NULL); manpath_free(&dirs); mchars_free(mc); mparse_free(mp); @@ -538,7 +538,7 @@ usage: " %s [-DnpQ] [-Tutf8] -d dir [file ...]\n" " %s [-Dnp] -u dir [file ...]\n" " %s [-Q] -t file ...\n", - progname, progname, progname, + progname, progname, progname, progname, progname); return((int)MANDOCLEVEL_BADARG); @@ -552,7 +552,7 @@ usage: * If use_all has been specified, grok all files. * If not, sanitise paths to the following: * - * [./]man*[/]/.
+ * [./]man*[/]/.
* or * [./]cat
[/]/.0 * @@ -592,7 +592,7 @@ treescan(void) * Symbolic links require various sanity checks, * then get handled just like regular files. */ - case (FTS_SL): + case FTS_SL: if (NULL == realpath(path, buf)) { if (warnings) say(path, "&realpath"); @@ -615,7 +615,7 @@ treescan(void) * If we're a regular file, add an mlink by using the * stored directory data and handling the filename. */ - case (FTS_F): + case FTS_F: if (0 == strcmp(path, MANDOC_DB)) continue; if ( ! use_all && ff->fts_level < 2) { @@ -662,7 +662,13 @@ treescan(void) fsec[-1] = '\0'; mlink = mandoc_calloc(1, sizeof(struct mlink)); - strlcpy(mlink->file, path, sizeof(mlink->file)); + if (strlcpy(mlink->file, path, + sizeof(mlink->file)) >= + sizeof(mlink->file)) { + say(path, "Filename too long"); + free(mlink); + continue; + } mlink->dform = dform; mlink->dsec = dsec; mlink->arch = arch; @@ -672,9 +678,9 @@ treescan(void) mlink_add(mlink, ff->fts_statp); continue; - case (FTS_D): + case FTS_D: /* FALLTHROUGH */ - case (FTS_DP): + case FTS_DP: break; default: @@ -684,10 +690,10 @@ treescan(void) } switch (ff->fts_level) { - case (0): + case 0: /* Ignore the root directory. */ break; - case (1): + case 1: /* * This might contain manX/ or catX/. * Try to infer this from the name. @@ -708,14 +714,14 @@ treescan(void) dsec = NULL; } - if (NULL != dsec || use_all) + if (NULL != dsec || use_all) break; if (warnings) say(path, "Unknown directory part"); fts_set(f, ff, FTS_SKIP); break; - case (2): + case 2: /* * Possibly our architecture. * If we're descending, keep tabs on it. @@ -747,7 +753,7 @@ treescan(void) * Try to infer the manual section, architecture, and page name from the * path, assuming it looks like * - * [./]man*[/]/.
+ * [./]man*[/]/.
* or * [./]cat
[/]/.0 * @@ -793,10 +799,10 @@ filescan(const char *file) return; } - if (strstr(buf, basedir) == buf) - start = buf + strlen(basedir) + 1; - else if (OP_TEST == op) + if (OP_TEST == op) start = buf; + else if (strstr(buf, basedir) == buf) + start = buf + strlen(basedir); else { exitcode = (int)MANDOCLEVEL_BADARG; say("", "%s: outside base directory", buf); @@ -818,13 +824,21 @@ filescan(const char *file) say(file, "&stat"); return; } - strlcpy(buf, file, sizeof(buf)); - start = strstr(buf, basedir) == buf ? - buf + strlen(basedir) + 1 : buf; + if (strlcpy(buf, file, sizeof(buf)) >= sizeof(buf)) { + say(file, "Filename too long"); + return; + } + start = buf; + if (OP_TEST != op && strstr(buf, basedir) == buf) + start += strlen(basedir); } mlink = mandoc_calloc(1, sizeof(struct mlink)); - strlcpy(mlink->file, start, sizeof(mlink->file)); + if (strlcpy(mlink->file, start, sizeof(mlink->file)) >= + sizeof(mlink->file)) { + say(start, "Filename too long"); + return; + } /* * First try to guess our directory structure. @@ -972,19 +986,15 @@ mlinks_undupe(struct mpage *mpage) mpage->form = FORM_NONE; goto nextlink; } - if (strlcpy(buf, mlink->file, PATH_MAX) >= PATH_MAX) { - if (warnings) - say(mlink->file, "Filename too long"); - goto nextlink; - } + (void)strlcpy(buf, mlink->file, sizeof(buf)); bufp = strstr(buf, "cat"); assert(NULL != bufp); memcpy(bufp, "man", 3); if (NULL != (bufp = strrchr(buf, '.'))) *++bufp = '\0'; - strlcat(buf, mlink->dsec, PATH_MAX); + (void)strlcat(buf, mlink->dsec, sizeof(buf)); if (NULL == ohash_find(&mlinks, - ohash_qlookup(&mlinks, buf))) + ohash_qlookup(&mlinks, buf))) goto nextlink; if (warnings) say(mlink->file, "Man source exists: %s", buf); @@ -1113,14 +1123,14 @@ mpages_merge(struct mchars *mc, struct mparse *mp) goto nextpage; } switch (child_pid = fork()) { - case (-1): + case -1: exitcode = (int)MANDOCLEVEL_SYSERR; say(mpage->mlinks->file, "&fork gunzip"); child_pid = 0; close(fd[1]); close(fd[0]); goto nextpage; - case (0): + case 0: close(fd[0]); if (-1 == dup2(fd[1], STDOUT_FILENO)) { say(mpage->mlinks->file, @@ -1286,7 +1296,8 @@ names_check(void) "AND mlinks.name == names.name" ")" ") JOIN (" - "SELECT * FROM mlinks GROUP BY pageid" + "SELECT sec, arch, name, pageid FROM mlinks " + "GROUP BY pageid" ") USING (pageid);", -1, &stmt, NULL); @@ -1335,7 +1346,7 @@ parse_cat(struct mpage *mpage, int fd) while (NULL != (line = fgetln(stream, &len))) if ('\n' != *line && ' ' != *line) break; - + /* * Read up until the next section into a buffer. * Strip the leading and trailing newline from each read line, @@ -1405,7 +1416,7 @@ parse_cat(struct mpage *mpage, int fd) if (0 == len) { memmove(line, line + 1, plen--); continue; - } + } memmove(line - 1, line + 1, plen - len); plen -= 2; } @@ -1469,11 +1480,11 @@ parse_man(struct mpage *mpage, const struct man_node * body = n; assert(body->parent); if (NULL != (head = body->parent->head) && - 1 == head->nchild && - NULL != (head = (head->child)) && - MAN_TEXT == head->type && - 0 == strcmp(head->string, "NAME") && - NULL != body->child) { + 1 == head->nchild && + NULL != (head = (head->child)) && + MAN_TEXT == head->type && + 0 == strcmp(head->string, "NAME") && + NULL != body->child) { /* * Suck the entire NAME section into memory. @@ -1487,7 +1498,7 @@ parse_man(struct mpage *mpage, const struct man_node * if (NULL == title) return; - /* + /* * Go through a special heuristic dance here. * Conventionally, one or more manual names are * comma-specified prior to a whitespace, then a @@ -1569,15 +1580,15 @@ parse_mdoc(struct mpage *mpage, const struct mdoc_node assert(NULL != n); for (n = n->child; NULL != n; n = n->next) { switch (n->type) { - case (MDOC_ELEM): + case MDOC_ELEM: /* FALLTHROUGH */ - case (MDOC_BLOCK): + case MDOC_BLOCK: /* FALLTHROUGH */ - case (MDOC_HEAD): + case MDOC_HEAD: /* FALLTHROUGH */ - case (MDOC_BODY): + case MDOC_BODY: /* FALLTHROUGH */ - case (MDOC_TAIL): + case MDOC_TAIL: if (NULL != mdocs[n->tok].fp) if (0 == (*mdocs[n->tok].fp)(mpage, n)) break; @@ -1601,8 +1612,8 @@ parse_mdoc_Fd(struct mpage *mpage, const struct mdoc_n size_t sz; if (SEC_SYNOPSIS != n->sec || - NULL == (n = n->child) || - MDOC_TEXT != n->type) + NULL == (n = n->child) || + MDOC_TEXT != n->type) return(0); /* @@ -1645,11 +1656,11 @@ parse_mdoc_Fn(struct mpage *mpage, const struct mdoc_n if (NULL == (n = n->child) || MDOC_TEXT != n->type) return(0); - /* + /* * Parse: .Fn "struct type *name" "char *arg". - * First strip away pointer symbol. + * First strip away pointer symbol. * Then store the function name, then type. - * Finally, store the arguments. + * Finally, store the arguments. */ if (NULL == (cp = strrchr(n->string, ' '))) @@ -1773,7 +1784,7 @@ putkeys(const struct mpage *mpage, s->mask |= v; return; } else if (NULL == s) { - s = mandoc_calloc(sizeof(struct str) + sz + 1, 1); + s = mandoc_calloc(1, sizeof(struct str) + sz + 1); memcpy(s->key, cp, sz); ohash_insert(htab, slot, s); } @@ -1866,7 +1877,7 @@ render_key(struct mchars *mc, struct str *key) if (strcspn(val, res) == bsz) { key->rendered = key->key; return; - } + } /* Pre-allocate by the length of the input */ @@ -1886,17 +1897,17 @@ render_key(struct mchars *mc, struct str *key) } switch (*val) { - case (ASCII_HYPH): + case ASCII_HYPH: buf[pos++] = '-'; val++; continue; - case ('\t'): + case '\t': /* FALLTHROUGH */ - case (ASCII_NBRSP): + case ASCII_NBRSP: buf[pos++] = ' '; val++; /* FALLTHROUGH */ - case (ASCII_BREAK): + case ASCII_BREAK: continue; default: break; @@ -1913,8 +1924,8 @@ render_key(struct mchars *mc, struct str *key) * predefined character or special character. */ - esc = mandoc_escape - ((const char **)&val, &seq, &len); + esc = mandoc_escape((const char **)&val, + &seq, &len); if (ESCAPE_ERROR == esc) break; if (ESCAPE_SPECIAL != esc) @@ -1985,6 +1996,20 @@ dbadd(struct mpage *mpage, struct mchars *mc) mlink = mpage->mlinks; if (nodb) { + for (key = ohash_first(&names, &slot); NULL != key; + key = ohash_next(&names, &slot)) { + if (key->rendered != key->key) + free(key->rendered); + free(key); + } + for (key = ohash_first(&strings, &slot); NULL != key; + key = ohash_next(&strings, &slot)) { + if (key->rendered != key->key) + free(key->rendered); + free(key); + } + if (0 == debug) + return; while (NULL != mlink) { fputs(mlink->name, stdout); if (NULL == mlink->next || @@ -2011,13 +2036,22 @@ dbadd(struct mpage *mpage, struct mchars *mc) if (debug) say(mlink->file, "Adding to database"); + i = strlen(mpage->desc) + 1; + key = mandoc_calloc(1, sizeof(struct str) + i); + memcpy(key->key, mpage->desc, i); + render_key(mc, key); + i = 1; - SQL_BIND_TEXT(stmts[STMT_INSERT_PAGE], i, mpage->desc); + SQL_BIND_TEXT(stmts[STMT_INSERT_PAGE], i, key->rendered); SQL_BIND_INT(stmts[STMT_INSERT_PAGE], i, FORM_SRC == mpage->form); SQL_STEP(stmts[STMT_INSERT_PAGE]); mpage->pageid = sqlite3_last_insert_rowid(db); sqlite3_reset(stmts[STMT_INSERT_PAGE]); + if (key->rendered != key->key) + free(key->rendered); + free(key); + while (NULL != mlink) { dbadd_mlink(mlink); mlink = mlink->next; @@ -2125,11 +2159,11 @@ dbclose(int real) } switch (child = fork()) { - case (-1): + case -1: exitcode = (int)MANDOCLEVEL_SYSERR; say("", "&fork cmp"); return; - case (0): + case 0: execlp("cmp", "cmp", "-s", tempfilename, MANDOC_DB, NULL); say("", "&exec cmp"); @@ -2151,11 +2185,11 @@ dbclose(int real) *strrchr(tempfilename, '/') = '\0'; switch (child = fork()) { - case (-1): + case -1: exitcode = (int)MANDOCLEVEL_SYSERR; say("", "&fork rm"); return; - case (0): + case 0: execlp("rm", "rm", "-rf", tempfilename, NULL); say("", "&exec rm"); exit((int)MANDOCLEVEL_SYSERR); @@ -2186,7 +2220,7 @@ dbopen(int real) const char *sql; int rc, ofl; - if (nodb) + if (nodb) return(1); *tempfilename = '\0'; @@ -2196,7 +2230,8 @@ dbopen(int real) rc = sqlite3_open_v2(MANDOC_DB, &db, ofl, NULL); if (SQLITE_OK != rc) { exitcode = (int)MANDOCLEVEL_SYSERR; - say(MANDOC_DB, "%s", sqlite3_errmsg(db)); + if (SQLITE_CANTOPEN != rc) + say(MANDOC_DB, "%s", sqlite3_errstr(rc)); return(0); } goto prepare_statements; @@ -2206,36 +2241,27 @@ dbopen(int real) remove(MANDOC_DB "~"); rc = sqlite3_open_v2(MANDOC_DB "~", &db, ofl, NULL); - if (SQLITE_OK == rc) + if (SQLITE_OK == rc) goto create_tables; if (MPARSE_QUICK & mparse_options) { exitcode = (int)MANDOCLEVEL_SYSERR; - say(MANDOC_DB "~", "%s", sqlite3_errmsg(db)); + say(MANDOC_DB "~", "%s", sqlite3_errstr(rc)); return(0); } - if (strlcpy(tempfilename, "/tmp/mandocdb.XXXXXX", - sizeof(tempfilename)) >= sizeof(tempfilename)) { - exitcode = (int)MANDOCLEVEL_SYSERR; - say("", "/tmp/mandocdb.XXXXXX: Filename too long"); - return(0); - } + (void)strlcpy(tempfilename, "/tmp/mandocdb.XXXXXX", + sizeof(tempfilename)); if (NULL == mkdtemp(tempfilename)) { exitcode = (int)MANDOCLEVEL_SYSERR; say("", "&%s", tempfilename); return(0); } - if (strlcat(tempfilename, "/" MANDOC_DB, - sizeof(tempfilename)) >= sizeof(tempfilename)) { - exitcode = (int)MANDOCLEVEL_SYSERR; - say("", "%s/" MANDOC_DB ": Filename too long", - tempfilename); - return(0); - } + (void)strlcat(tempfilename, "/" MANDOC_DB, + sizeof(tempfilename)); rc = sqlite3_open_v2(tempfilename, &db, ofl, NULL); if (SQLITE_OK != rc) { exitcode = (int)MANDOCLEVEL_SYSERR; - say("", "%s: %s", tempfilename, sqlite3_errmsg(db)); + say("", "%s: %s", tempfilename, sqlite3_errstr(rc)); return(0); } @@ -2273,11 +2299,20 @@ create_tables: if (SQLITE_OK != sqlite3_exec(db, sql, NULL, NULL, NULL)) { exitcode = (int)MANDOCLEVEL_SYSERR; say(MANDOC_DB, "%s", sqlite3_errmsg(db)); + sqlite3_close(db); return(0); } prepare_statements: - SQL_EXEC("PRAGMA foreign_keys = ON"); + if (SQLITE_OK != sqlite3_exec(db, + "PRAGMA foreign_keys = ON", NULL, NULL, NULL)) { + exitcode = (int)MANDOCLEVEL_SYSERR; + say(MANDOC_DB, "PRAGMA foreign_keys: %s", + sqlite3_errmsg(db)); + sqlite3_close(db); + return(0); + } + sql = "DELETE FROM mpages WHERE pageid IN " "(SELECT pageid FROM mlinks WHERE " "sec=? AND arch=? AND name=?)"; @@ -2301,8 +2336,14 @@ prepare_statements: * synchronous mode for much better performance. */ - if (real) - SQL_EXEC("PRAGMA synchronous = OFF"); + if (real && SQLITE_OK != sqlite3_exec(db, + "PRAGMA synchronous = OFF", NULL, NULL, NULL)) { + exitcode = (int)MANDOCLEVEL_SYSERR; + say(MANDOC_DB, "PRAGMA synchronous: %s", + sqlite3_errmsg(db)); + sqlite3_close(db); + return(0); + } #endif return(1); @@ -2312,7 +2353,7 @@ static void * hash_halloc(size_t sz, void *arg) { - return(mandoc_calloc(sz, 1)); + return(mandoc_calloc(1, sz)); } static void * @@ -2334,6 +2375,7 @@ set_basedir(const char *targetdir) { static char startdir[PATH_MAX]; static int fd; + char *cp; /* * Remember where we started by keeping a fd open to the origin @@ -2344,8 +2386,7 @@ set_basedir(const char *targetdir) if ('\0' == *startdir) { if (NULL == getcwd(startdir, PATH_MAX)) { exitcode = (int)MANDOCLEVEL_SYSERR; - if (NULL != targetdir) - say("", "&getcwd"); + say("", "&getcwd"); return(0); } if (-1 == (fd = open(startdir, O_RDONLY, 0))) { @@ -2353,8 +2394,6 @@ set_basedir(const char *targetdir) say("", "&open %s", startdir); return(0); } - if (NULL == targetdir) - targetdir = startdir; } else { if (-1 == fd) return(0); @@ -2365,10 +2404,6 @@ set_basedir(const char *targetdir) say("", "&chdir %s", startdir); return(0); } - if (NULL == targetdir) { - close(fd); - return(1); - } } if (NULL == realpath(targetdir, basedir)) { basedir[0] = '\0'; @@ -2380,6 +2415,16 @@ set_basedir(const char *targetdir) say("", "&chdir"); return(0); } + cp = strchr(basedir, '\0'); + if ('/' != cp[-1]) { + if (cp - basedir >= PATH_MAX - 1) { + exitcode = (int)MANDOCLEVEL_SYSERR; + say("", "Filename too long"); + return(0); + } + *cp++ = '/'; + *cp = '\0'; + } return(1); } @@ -2399,10 +2444,10 @@ say(const char *file, const char *format, ...) use_errno = 1; if (NULL != format) { switch (*format) { - case ('&'): + case '&': format++; break; - case ('\0'): + case '\0': format = NULL; break; default: