mandoc/mandocdb.c - diff

Return to mandocdb.c CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandocdb.c between version 1.144 and 1.161

version 1.144, 2014/04/23 21:06:41

version 1.161, 2014/09/03 18:09:14

Line 1

/* $Id$ */

/* $OpenBSD$ */

Line 15

* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF

* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

#ifdef HAVE_CONFIG_H

#include "config.h"

#endif

#include <sys/stat.h>

#include <sys/types.h>

#include <sys/wait.h>

#include <assert.h>

#include <ctype.h>

#include <errno.h>

#include <fcntl.h>

#if HAVE_FTS

#include <fts.h>

#else

#include "compat_fts.h"

#endif

#include <getopt.h>

#include <limits.h>

#include <stddef.h>

Line 36

Line 39

#include <string.h>

#include <unistd.h>

#ifdef HAVE_OHASH

#if HAVE_OHASH

#include <ohash.h>

#else

#include "compat_ohash.h"

Line 80 enum op {

Line 83 enum op {

OP_TEST /* change no databases, report potential problems */

};

enum form {

FORM_NONE, /* format is unknown */

FORM_SRC, /* format is -man or -mdoc */

FORM_CAT /* format is cat */

};

struct str {

char *rendered; /* key in UTF-8 or ASCII form */

const struct mpage *mpage; /* if set, the owning parse */

Line 101 struct inodev {

Line 98 struct inodev {

struct mpage {

struct inodev inodev; /* used for hashing routine */

int64_t pageid; /* pageid in mpages SQL table */

enum form form; /* format from file content */

char *sec; /* section from file content */

char *arch; /* architecture from file content */

char *title; /* title from file content */

char *desc; /* description from file content */

struct mlink *mlinks; /* singly linked list */

int form; /* format from file content */

};

struct mlink {

char file[PATH_MAX]; /* filename rel. to manpath */

enum form dform; /* format from directory */

enum form fform; /* format from file name suffix */

char *dsec; /* section from directory */

char *arch; /* architecture from directory */

char *name; /* name from file name (not empty) */

char *fsec; /* section from file name suffix */

struct mlink *next; /* singly linked list */

struct mpage *mpage; /* parent */

int dform; /* format from directory */

int fform; /* format from file name suffix */

int gzip; /* filename has a .gz suffix */

};

Line 145 static int dbopen(int);

Line 142 static int dbopen(int);

static void dbprune(void);

static void filescan(const char *);

static void *hash_alloc(size_t, void *);

static void hash_free(void *, size_t, void *);

static void hash_free(void *, void *);

static void *hash_halloc(size_t, void *);

static void *hash_calloc(size_t, size_t, void *);

static void mlink_add(struct mlink *, const struct stat *);

static void mlink_check(struct mpage *, struct mlink *);

static void mlink_free(struct mlink *);

Line 336 main(int argc, char *argv[])

Line 333 main(int argc, char *argv[])

memset(&dirs, 0, sizeof(struct manpaths));

mpages_info.alloc = mlinks_info.alloc = hash_alloc;

mpages_info.halloc = mlinks_info.halloc = hash_halloc;

mpages_info.calloc = mlinks_info.calloc = hash_calloc;

mpages_info.hfree = mlinks_info.hfree = hash_free;

mpages_info.free = mlinks_info.free = hash_free;

mpages_info.key_offset = offsetof(struct mpage, inodev);

mlinks_info.key_offset = offsetof(struct mlink, file);

Line 355 main(int argc, char *argv[])

Line 352 main(int argc, char *argv[])

#define CHECKOP(_op, _ch) do \

if (OP_DEFAULT != (_op)) { \

fprintf(stderr, "-%c: Conflicting option\n", (_ch)); \

fprintf(stderr, "%s: -%c: Conflicting option\n", \

progname, (_ch)); \

goto usage; \

} while (/*CONSTCOND*/0)

Line 391 main(int argc, char *argv[])

Line 389 main(int argc, char *argv[])

break;

case 'T':

if (strcmp(optarg, "utf8")) {

fprintf(stderr, "-T%s: Unsupported "

fprintf(stderr, "%s: -T%s: "

"output format\n", optarg);

"Unsupported output format\n",

progname, optarg);

goto usage;

}

write_utf8 = 1;

Line 419 main(int argc, char *argv[])

Line 418 main(int argc, char *argv[])

argv += optind;

if (OP_CONFFILE == op && argc > 0) {

fprintf(stderr, "-C: Too many arguments\n");

fprintf(stderr, "%s: -C: Too many arguments\n",

progname);

goto usage;

}

Line 433 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)) {

Line 506 main(int argc, char *argv[])

goto out;

if (0 == treescan())

goto out;

if (0 == set_basedir(dirs.paths[j]))

goto out;

if (0 == dbopen(0))

goto out;

mpages_merge(mc, mp);

if (warnings &&

if (warnings && !nodb &&

! (MPARSE_QUICK & mparse_options))

names_check();

dbclose(0);

Line 525 main(int argc, char *argv[])

Line 523 main(int argc, char *argv[])

}

out:

set_basedir(NULL);

manpath_free(&dirs);

mchars_free(mc);

mparse_free(mp);

Line 800 filescan(const char *file)

Line 797 filescan(const char *file)

return;

}

if (strstr(buf, basedir) == buf)

if (OP_TEST == op)

start = buf + strlen(basedir) + 1;

else 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);

Line 829 filescan(const char *file)

Line 826 filescan(const char *file)

say(file, "Filename too long");

return;

}

start = strstr(buf, basedir) == buf ?

start = buf;

buf + strlen(basedir) + 1 : buf;

if (OP_TEST != op && strstr(buf, basedir) == buf)

start += strlen(basedir);

}

mlink = mandoc_calloc(1, sizeof(struct mlink));

mlink->dform = FORM_NONE;

if (strlcpy(mlink->file, start, sizeof(mlink->file)) >=

sizeof(mlink->file)) {

say(start, "Filename too long");

Line 1090 mpages_merge(struct mchars *mc, struct mparse *mp)

Line 1089 mpages_merge(struct mchars *mc, struct mparse *mp)

enum mandoclevel lvl;

str_info.alloc = hash_alloc;

str_info.halloc = hash_halloc;

str_info.calloc = hash_calloc;

str_info.hfree = hash_free;

str_info.free = hash_free;

str_info.key_offset = offsetof(struct str, key);

if (0 == nodb)

Line 1197 mpages_merge(struct mchars *mc, struct mparse *mp)

Line 1196 mpages_merge(struct mchars *mc, struct mparse *mp)

goto nextpage;

} else if (NULL != mdoc) {

mpage->form = FORM_SRC;

mpage->sec =

mpage->sec = mdoc_meta(mdoc)->msec;

mandoc_strdup(mdoc_meta(mdoc)->msec);

mpage->sec = mandoc_strdup(

NULL == mpage->sec ? "" : mpage->sec);

mpage->arch = mdoc_meta(mdoc)->arch;

mpage->arch = mandoc_strdup(

NULL == mpage->arch ? "" : mpage->arch);

Line 1221 mpages_merge(struct mchars *mc, struct mparse *mp)

mpage->title =

mandoc_strdup(mpage->mlinks->name);

}

if (mpage->mlinks->gzip)

mpage->form |= FORM_GZ;

putkey(mpage, mpage->sec, TYPE_sec);

putkey(mpage, '\0' == *mpage->arch ?

any : mpage->arch, TYPE_arch);

Line 1305 names_check(void)

Line 1307 names_check(void)

say("", "%s", sqlite3_errmsg(db));

while (SQLITE_ROW == (irc = sqlite3_step(stmt))) {

name = sqlite3_column_text(stmt, 0);

name = (const char *)sqlite3_column_text(stmt, 0);

sec = sqlite3_column_text(stmt, 1);

sec = (const char *)sqlite3_column_text(stmt, 1);

arch = sqlite3_column_text(stmt, 2);

arch = (const char *)sqlite3_column_text(stmt, 2);

key = sqlite3_column_text(stmt, 3);

key = (const char *)sqlite3_column_text(stmt, 3);

say("", "%s(%s%s%s) lacks mlink \"%s\"", name, sec,

'\0' == *arch ? "" : "/",

'\0' == *arch ? "" : arch, key);

Line 1327 parse_cat(struct mpage *mpage, int fd)

Line 1329 parse_cat(struct mpage *mpage, int fd)

fopen(mpage->mlinks->file, "r") :

fdopen(fd, "r");

if (NULL == stream) {

if (-1 != fd)

close(fd);

if (warnings)

say(mpage->mlinks->file, "&fopen");

return;

Line 1977 dbadd_mlink(const struct mlink *mlink)

Line 1981 dbadd_mlink(const struct mlink *mlink)

SQL_BIND_INT64(stmts[STMT_INSERT_LINK], i, mlink->mpage->pageid);

SQL_STEP(stmts[STMT_INSERT_LINK]);

sqlite3_reset(stmts[STMT_INSERT_LINK]);

i = 1;

SQL_BIND_INT64(stmts[STMT_INSERT_NAME], i, NAME_FILE);

SQL_BIND_TEXT(stmts[STMT_INSERT_NAME], i, mlink->name);

SQL_BIND_INT64(stmts[STMT_INSERT_NAME], i, mlink->mpage->pageid);

SQL_STEP(stmts[STMT_INSERT_NAME]);

sqlite3_reset(stmts[STMT_INSERT_NAME]);

}

Line 1996 dbadd(struct mpage *mpage, struct mchars *mc)

Line 2007 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 ||

Line 2022 dbadd(struct mpage *mpage, struct mchars *mc)

Line 2047 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_BIND_INT(stmts[STMT_INSERT_PAGE], i, 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;

Line 2207 dbopen(int real)

Line 2241 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;

Line 2221 dbopen(int real)

Line 2256 dbopen(int real)

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);

}

Line 2237 dbopen(int real)

Line 2272 dbopen(int real)

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);

}

Line 2275 create_tables:

Line 2310 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=?)";

Line 2303 prepare_statements:

Line 2347 prepare_statements:

* synchronous mode for much better performance.

if (real)

if (real && SQLITE_OK != sqlite3_exec(db,

SQL_EXEC("PRAGMA synchronous = OFF");

"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);

}

static void *

hash_halloc(size_t sz, void *arg)

hash_calloc(size_t n, size_t sz, void *arg)

{

return(mandoc_calloc(1, sz));

return(mandoc_calloc(n, sz));

}

static void *

Line 2325 hash_alloc(size_t sz, void *arg)

Line 2375 hash_alloc(size_t sz, void *arg)

}

static void

hash_free(void *p, size_t sz, void *arg)

hash_free(void *p, void *arg)

{

free(p);

Line 2335 static int

Line 2385 static int

set_basedir(const char *targetdir)

{

static char startdir[PATH_MAX];

static int fd;

static int getcwd_status; /* 1 = ok, 2 = failure */

static int chdir_status; /* 1 = changed directory */

char *cp;

* Remember where we started by keeping a fd open to the origin

* Remember the original working directory, if possible.

* path component: throughout this utility, we chdir() a lot to

* This will be needed if the second or a later directory

* handle relative paths, and by doing this, we can return to

* on the command line is given as a relative path.

* the starting point.

* Do not error out if the current directory is not

* searchable: Maybe it won't be needed after all.

if ('\0' == *startdir) {

if (0 == getcwd_status) {

if (NULL == getcwd(startdir, PATH_MAX)) {

if (NULL == getcwd(startdir, sizeof(startdir))) {

getcwd_status = 2;

(void)strlcpy(startdir, strerror(errno),

sizeof(startdir));

} else

getcwd_status = 1;

}

* We are leaving the old base directory.

* Do not use it any longer, not even for messages.

*basedir = '\0';

* If and only if the directory was changed earlier and

* the next directory to process is given as a relative path,

* first go back, or bail out if that is impossible.

if (chdir_status && '/' != *targetdir) {

if (2 == getcwd_status) {

exitcode = (int)MANDOCLEVEL_SYSERR;

if (NULL != targetdir)

say("", "getcwd: %s", startdir);

say("", "&getcwd");

return(0);

}

if (-1 == (fd = open(startdir, O_RDONLY, 0))) {

if (-1 == chdir(startdir)) {

exitcode = (int)MANDOCLEVEL_SYSERR;

say("", "&open %s", startdir);

return(0);

}

if (NULL == targetdir)

targetdir = startdir;

} else {

if (-1 == fd)

return(0);

if (-1 == fchdir(fd)) {

close(fd);

basedir[0] = '\0';

exitcode = (int)MANDOCLEVEL_SYSERR;

say("", "&chdir %s", startdir);

return(0);

}

if (NULL == targetdir) {

close(fd);

return(1);

}

* Always resolve basedir to the canonicalized absolute

* pathname and append a trailing slash, such that

* we can reliably check whether files are inside.

if (NULL == realpath(targetdir, basedir)) {

basedir[0] = '\0';

exitcode = (int)MANDOCLEVEL_BADARG;

say("", "&%s: realpath", targetdir);

return(0);

Line 2382 set_basedir(const char *targetdir)

Line 2443 set_basedir(const char *targetdir)

say("", "&chdir");

return(0);

}

chdir_status = 1;

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);

}

Line 2394 say(const char *file, const char *format, ...)

Line 2466 say(const char *file, const char *format, ...)

if ('\0' != *basedir)

fprintf(stderr, "%s", basedir);

if ('\0' != *basedir && '\0' != *file)

fputs("//", stderr);

fputc('/', stderr);

if ('\0' != *file)

fprintf(stderr, "%s", file);

CVSweb