version 1.9, 2011/11/20 12:39:08 |
version 1.12, 2011/11/26 11:23:56 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
|
* Copyright (c) 2011 Ingo Schwarze <schwarze@openbsd.org> |
* |
* |
* Permission to use, copy, modify, and distribute this software for any |
* Permission to use, copy, modify, and distribute this software for any |
* purpose with or without fee is hereby granted, provided that the above |
* purpose with or without fee is hereby granted, provided that the above |
|
|
#include "mdoc.h" |
#include "mdoc.h" |
#include "mandoc.h" |
#include "mandoc.h" |
#include "mandocdb.h" |
#include "mandocdb.h" |
|
#include "manpath.h" |
|
|
#define MANDOC_BUFSZ BUFSIZ |
#define MANDOC_BUFSZ BUFSIZ |
#define MANDOC_SLOP 1024 |
#define MANDOC_SLOP 1024 |
|
|
|
|
struct of { |
struct of { |
char *fname; /* heap-allocated */ |
char *fname; /* heap-allocated */ |
|
char *sec; |
|
char *arch; |
|
char *title; |
struct of *next; /* NULL for last one */ |
struct of *next; /* NULL for last one */ |
struct of *first; /* first in list */ |
struct of *first; /* first in list */ |
}; |
}; |
Line 88 static void hash_reset(DB **); |
|
Line 93 static void hash_reset(DB **); |
|
static void index_merge(const struct of *, struct mparse *, |
static void index_merge(const struct of *, struct mparse *, |
struct buf *, struct buf *, |
struct buf *, struct buf *, |
DB *, DB *, const char *, |
DB *, DB *, const char *, |
DB *, const char *, int, |
DB *, const char *, int, int, |
recno_t, const recno_t *, size_t); |
recno_t, const recno_t *, size_t); |
static void index_prune(const struct of *, DB *, |
static void index_prune(const struct of *, DB *, |
const char *, DB *, const char *, |
const char *, DB *, const char *, |
int, recno_t *, recno_t **, size_t *); |
int, recno_t *, recno_t **, size_t *); |
static void ofile_argbuild(char *[], int, int, struct of **); |
static void ofile_argbuild(char *[], int, int, int, |
static int ofile_dirbuild(const char *, int, struct of **); |
struct of **); |
|
static int ofile_dirbuild(const char *, const char *, |
|
const char *, int, int, struct of **); |
static void ofile_free(struct of *); |
static void ofile_free(struct of *); |
static int pman_node(MAN_ARGS); |
static int pman_node(MAN_ARGS); |
static void pmdoc_node(MDOC_ARGS); |
static void pmdoc_node(MDOC_ARGS); |
|
|
main(int argc, char *argv[]) |
main(int argc, char *argv[]) |
{ |
{ |
struct mparse *mp; /* parse sequence */ |
struct mparse *mp; /* parse sequence */ |
|
struct manpaths dirs; |
enum op op; /* current operation */ |
enum op op; /* current operation */ |
const char *dir; |
const char *dir; |
char ibuf[MAXPATHLEN], /* index fname */ |
char ibuf[MAXPATHLEN], /* index fname */ |
fbuf[MAXPATHLEN]; /* btree fname */ |
fbuf[MAXPATHLEN]; /* btree fname */ |
int verb, /* output verbosity */ |
int verb, /* output verbosity */ |
|
use_all, /* use all directories and files */ |
ch, i, flags; |
ch, i, flags; |
DB *idx, /* index database */ |
DB *idx, /* index database */ |
*db, /* keyword database */ |
*db, /* keyword database */ |
*hash; /* temporary keyword hashtable */ |
*hash; /* temporary keyword hashtable */ |
BTREEINFO info; /* btree configuration */ |
BTREEINFO info; /* btree configuration */ |
recno_t maxrec; /* supremum of all records */ |
recno_t maxrec; /* last record number in the index */ |
recno_t *recs; /* buffer of empty records */ |
recno_t *recs; /* the numbers of all empty records */ |
size_t sz1, sz2, |
size_t sz1, sz2, |
recsz, /* buffer size of recs */ |
recsz, /* number of allocated slots in recs */ |
reccur; /* valid number of recs */ |
reccur; /* current number of empty records */ |
struct buf buf, /* keyword buffer */ |
struct buf buf, /* keyword buffer */ |
dbuf; /* description buffer */ |
dbuf; /* description buffer */ |
struct of *of; /* list of files for processing */ |
struct of *of; /* list of files for processing */ |
Line 274 main(int argc, char *argv[]) |
|
Line 283 main(int argc, char *argv[]) |
|
else |
else |
++progname; |
++progname; |
|
|
|
memset(&dirs, 0, sizeof(struct manpaths)); |
|
|
verb = 0; |
verb = 0; |
|
use_all = 0; |
of = NULL; |
of = NULL; |
db = idx = NULL; |
db = idx = NULL; |
mp = NULL; |
mp = NULL; |
Line 285 main(int argc, char *argv[]) |
|
Line 297 main(int argc, char *argv[]) |
|
op = OP_NEW; |
op = OP_NEW; |
dir = NULL; |
dir = NULL; |
|
|
while (-1 != (ch = getopt(argc, argv, "d:u:v"))) |
while (-1 != (ch = getopt(argc, argv, "ad:u:v"))) |
switch (ch) { |
switch (ch) { |
|
case ('a'): |
|
use_all = 1; |
|
break; |
case ('d'): |
case ('d'): |
dir = optarg; |
dir = optarg; |
op = OP_UPDATE; |
op = OP_UPDATE; |
Line 343 main(int argc, char *argv[]) |
|
Line 358 main(int argc, char *argv[]) |
|
if (NULL == db) { |
if (NULL == db) { |
perror(fbuf); |
perror(fbuf); |
exit((int)MANDOCLEVEL_SYSERR); |
exit((int)MANDOCLEVEL_SYSERR); |
} else if (NULL == db) { |
} else if (NULL == idx) { |
perror(ibuf); |
perror(ibuf); |
exit((int)MANDOCLEVEL_SYSERR); |
exit((int)MANDOCLEVEL_SYSERR); |
} |
} |
Line 353 main(int argc, char *argv[]) |
|
Line 368 main(int argc, char *argv[]) |
|
printf("%s: Opened\n", ibuf); |
printf("%s: Opened\n", ibuf); |
} |
} |
|
|
ofile_argbuild(argv, argc, verb, &of); |
ofile_argbuild(argv, argc, use_all, verb, &of); |
if (NULL == of) |
if (NULL == of) |
goto out; |
goto out; |
|
|
Line 364 main(int argc, char *argv[]) |
|
Line 379 main(int argc, char *argv[]) |
|
|
|
if (OP_UPDATE == op) |
if (OP_UPDATE == op) |
index_merge(of, mp, &dbuf, &buf, hash, |
index_merge(of, mp, &dbuf, &buf, hash, |
db, fbuf, idx, ibuf, verb, |
db, fbuf, idx, ibuf, use_all, |
maxrec, recs, reccur); |
verb, maxrec, recs, reccur); |
|
|
goto out; |
goto out; |
} |
} |
|
|
for (i = 0; i < argc; i++) { |
/* |
|
* Configure the directories we're going to scan. |
|
* If we have command-line arguments, use them. |
|
* If not, we use man(1)'s method (see mandocdb.8). |
|
*/ |
|
|
|
if (argc > 0) { |
|
dirs.paths = mandoc_malloc(argc * sizeof(char *)); |
|
dirs.sz = argc; |
|
for (i = 0; i < argc; i++) |
|
dirs.paths[i] = mandoc_strdup(argv[i]); |
|
} else |
|
manpath_parse(&dirs, NULL, NULL); |
|
|
|
for (i = 0; i < dirs.sz; i++) { |
ibuf[0] = fbuf[0] = '\0'; |
ibuf[0] = fbuf[0] = '\0'; |
|
|
strlcat(fbuf, argv[i], MAXPATHLEN); |
strlcat(fbuf, dirs.paths[i], MAXPATHLEN); |
strlcat(fbuf, "/", MAXPATHLEN); |
strlcat(fbuf, "/", MAXPATHLEN); |
sz1 = strlcat(fbuf, MANDOC_DB, MAXPATHLEN); |
sz1 = strlcat(fbuf, MANDOC_DB, MAXPATHLEN); |
|
|
strlcat(ibuf, argv[i], MAXPATHLEN); |
strlcat(ibuf, dirs.paths[i], MAXPATHLEN); |
strlcat(ibuf, "/", MAXPATHLEN); |
strlcat(ibuf, "/", MAXPATHLEN); |
sz2 = strlcat(ibuf, MANDOC_IDX, MAXPATHLEN); |
sz2 = strlcat(ibuf, MANDOC_IDX, MAXPATHLEN); |
|
|
if (sz1 >= MAXPATHLEN || sz2 >= MAXPATHLEN) { |
if (sz1 >= MAXPATHLEN || sz2 >= MAXPATHLEN) { |
fprintf(stderr, "%s: Path too long\n", argv[i]); |
fprintf(stderr, "%s: Path too long\n", |
|
dirs.paths[i]); |
exit((int)MANDOCLEVEL_BADARG); |
exit((int)MANDOCLEVEL_BADARG); |
} |
} |
|
|
Line 392 main(int argc, char *argv[]) |
|
Line 422 main(int argc, char *argv[]) |
|
if (NULL == db) { |
if (NULL == db) { |
perror(fbuf); |
perror(fbuf); |
exit((int)MANDOCLEVEL_SYSERR); |
exit((int)MANDOCLEVEL_SYSERR); |
} else if (NULL == db) { |
} else if (NULL == idx) { |
perror(ibuf); |
perror(ibuf); |
exit((int)MANDOCLEVEL_SYSERR); |
exit((int)MANDOCLEVEL_SYSERR); |
} |
} |
Line 405 main(int argc, char *argv[]) |
|
Line 435 main(int argc, char *argv[]) |
|
ofile_free(of); |
ofile_free(of); |
of = NULL; |
of = NULL; |
|
|
if ( ! ofile_dirbuild(argv[i], verb, &of)) |
if ( ! ofile_dirbuild(dirs.paths[i], NULL, NULL, |
|
use_all, verb, &of)) |
exit((int)MANDOCLEVEL_SYSERR); |
exit((int)MANDOCLEVEL_SYSERR); |
|
|
if (NULL == of) |
if (NULL == of) |
Line 414 main(int argc, char *argv[]) |
|
Line 445 main(int argc, char *argv[]) |
|
of = of->first; |
of = of->first; |
|
|
index_merge(of, mp, &dbuf, &buf, hash, db, fbuf, |
index_merge(of, mp, &dbuf, &buf, hash, db, fbuf, |
idx, ibuf, verb, maxrec, recs, reccur); |
idx, ibuf, use_all, verb, |
|
maxrec, recs, reccur); |
} |
} |
|
|
out: |
out: |
|
|
if (mp) |
if (mp) |
mparse_free(mp); |
mparse_free(mp); |
|
|
|
manpath_free(&dirs); |
ofile_free(of); |
ofile_free(of); |
free(buf.cp); |
free(buf.cp); |
free(dbuf.cp); |
free(dbuf.cp); |
|
|
index_merge(const struct of *of, struct mparse *mp, |
index_merge(const struct of *of, struct mparse *mp, |
struct buf *dbuf, struct buf *buf, |
struct buf *dbuf, struct buf *buf, |
DB *hash, DB *db, const char *dbf, |
DB *hash, DB *db, const char *dbf, |
DB *idx, const char *idxf, int verb, |
DB *idx, const char *idxf, int use_all, int verb, |
recno_t maxrec, const recno_t *recs, size_t reccur) |
recno_t maxrec, const recno_t *recs, size_t reccur) |
{ |
{ |
recno_t rec; |
recno_t rec; |
Line 475 index_merge(const struct of *of, struct mparse *mp, |
|
Line 508 index_merge(const struct of *of, struct mparse *mp, |
|
if (NULL == mdoc && NULL == man) |
if (NULL == mdoc && NULL == man) |
continue; |
continue; |
|
|
|
/* |
|
* By default, skip a file if the manual section |
|
* and architecture given in the file disagree |
|
* with the directory where the file is located. |
|
*/ |
|
|
msec = NULL != mdoc ? |
msec = NULL != mdoc ? |
mdoc_meta(mdoc)->msec : man_meta(man)->msec; |
mdoc_meta(mdoc)->msec : man_meta(man)->msec; |
mtitle = NULL != mdoc ? |
|
mdoc_meta(mdoc)->title : man_meta(man)->title; |
|
arch = NULL != mdoc ? |
arch = NULL != mdoc ? |
mdoc_meta(mdoc)->arch : NULL; |
mdoc_meta(mdoc)->arch : NULL; |
|
|
|
if (0 == use_all) { |
|
assert(of->sec); |
|
assert(msec); |
|
if (strcmp(msec, of->sec)) |
|
continue; |
|
|
|
if (NULL == arch) { |
|
if (NULL != of->arch) |
|
continue; |
|
} else if (NULL == of->arch || |
|
strcmp(arch, of->arch)) |
|
continue; |
|
} |
|
|
if (NULL == arch) |
if (NULL == arch) |
arch = ""; |
arch = ""; |
|
|
/* |
/* |
|
* By default, skip a file if the title given |
|
* in the file disagrees with the file name. |
|
* If both agree, use the file name as the title, |
|
* because the one in the file usually is all caps. |
|
*/ |
|
|
|
mtitle = NULL != mdoc ? |
|
mdoc_meta(mdoc)->title : man_meta(man)->title; |
|
|
|
assert(of->title); |
|
assert(mtitle); |
|
|
|
if (0 == strcasecmp(mtitle, of->title)) |
|
mtitle = of->title; |
|
else if (0 == use_all) |
|
continue; |
|
|
|
/* |
* The index record value consists of a nil-terminated |
* The index record value consists of a nil-terminated |
* filename, a nil-terminated manual section, and a |
* filename, a nil-terminated manual section, and a |
* nil-terminated description. Since the description |
* nil-terminated description. Since the description |
Line 1159 pman_node(MAN_ARGS) |
|
Line 1228 pman_node(MAN_ARGS) |
|
} |
} |
|
|
static void |
static void |
ofile_argbuild(char *argv[], int argc, int verb, struct of **of) |
ofile_argbuild(char *argv[], int argc, int use_all, int verb, |
|
struct of **of) |
{ |
{ |
|
char buf[MAXPATHLEN]; |
|
char *sec, *arch, *title, *p; |
int i; |
int i; |
struct of *nof; |
struct of *nof; |
|
|
for (i = 0; i < argc; i++) { |
for (i = 0; i < argc; i++) { |
|
|
|
/* |
|
* Try to infer the manual section, architecture and |
|
* page title from the path, assuming it looks like |
|
* man*[/<arch>]/<title>.<section> |
|
*/ |
|
|
|
if (strlcpy(buf, argv[i], sizeof(buf)) >= sizeof(buf)) { |
|
fprintf(stderr, "%s: Path too long\n", argv[i]); |
|
continue; |
|
} |
|
sec = arch = title = NULL; |
|
p = strrchr(buf, '\0'); |
|
while (p-- > buf) { |
|
if (NULL == sec && '.' == *p) { |
|
sec = p + 1; |
|
*p = '\0'; |
|
continue; |
|
} |
|
if ('/' != *p) |
|
continue; |
|
if (NULL == title) { |
|
title = p + 1; |
|
*p = '\0'; |
|
continue; |
|
} |
|
if (strncmp("man", p + 1, 3)) |
|
arch = p + 1; |
|
break; |
|
} |
|
if (NULL == title) |
|
title = buf; |
|
|
|
/* |
|
* Build the file structure. |
|
*/ |
|
|
nof = mandoc_calloc(1, sizeof(struct of)); |
nof = mandoc_calloc(1, sizeof(struct of)); |
nof->fname = strdup(argv[i]); |
nof->fname = mandoc_strdup(argv[i]); |
|
if (NULL != sec) |
|
nof->sec = mandoc_strdup(sec); |
|
if (NULL != arch) |
|
nof->arch = mandoc_strdup(arch); |
|
nof->title = mandoc_strdup(title); |
|
|
|
/* |
|
* Add the structure to the list. |
|
*/ |
|
|
if (verb > 2) |
if (verb > 2) |
printf("%s: Scheduling\n", argv[i]); |
printf("%s: Scheduling\n", argv[i]); |
if (NULL == *of) { |
if (NULL == *of) { |
Line 1189 ofile_argbuild(char *argv[], int argc, int verb, struc |
|
Line 1308 ofile_argbuild(char *argv[], int argc, int verb, struc |
|
* Pass in a pointer to a NULL structure for the first invocation. |
* Pass in a pointer to a NULL structure for the first invocation. |
*/ |
*/ |
static int |
static int |
ofile_dirbuild(const char *dir, int verb, struct of **of) |
ofile_dirbuild(const char *dir, const char* psec, const char *parch, |
|
int use_all, int verb, struct of **of) |
{ |
{ |
char buf[MAXPATHLEN]; |
char buf[MAXPATHLEN]; |
size_t sz; |
size_t sz; |
DIR *d; |
DIR *d; |
const char *fn; |
const char *fn, *sec, *arch; |
|
char *suffix; |
struct of *nof; |
struct of *nof; |
struct dirent *dp; |
struct dirent *dp; |
|
|
Line 1205 ofile_dirbuild(const char *dir, int verb, struct of ** |
|
Line 1326 ofile_dirbuild(const char *dir, int verb, struct of ** |
|
|
|
while (NULL != (dp = readdir(d))) { |
while (NULL != (dp = readdir(d))) { |
fn = dp->d_name; |
fn = dp->d_name; |
|
|
|
if ('.' == *fn) |
|
continue; |
|
|
if (DT_DIR == dp->d_type) { |
if (DT_DIR == dp->d_type) { |
if (0 == strcmp(".", fn)) |
sec = psec; |
|
arch = parch; |
|
|
|
/* |
|
* By default, only use directories called: |
|
* man<section>/[<arch>/] |
|
*/ |
|
|
|
if (NULL == sec) { |
|
if(0 == strncmp("man", fn, 3)) |
|
sec = fn + 3; |
|
else if (use_all) |
|
sec = fn; |
|
else |
|
continue; |
|
} else if (NULL == arch && (use_all || |
|
NULL == strchr(fn, '.'))) |
|
arch = fn; |
|
else if (0 == use_all) |
continue; |
continue; |
if (0 == strcmp("..", fn)) |
|
continue; |
|
|
|
buf[0] = '\0'; |
buf[0] = '\0'; |
strlcat(buf, dir, MAXPATHLEN); |
strlcat(buf, dir, MAXPATHLEN); |
strlcat(buf, "/", MAXPATHLEN); |
strlcat(buf, "/", MAXPATHLEN); |
sz = strlcat(buf, fn, MAXPATHLEN); |
sz = strlcat(buf, fn, MAXPATHLEN); |
|
|
if (sz < MAXPATHLEN) { |
if (MAXPATHLEN <= sz) { |
if ( ! ofile_dirbuild(buf, verb, of)) |
fprintf(stderr, "%s: Path too long\n", dir); |
return(0); |
return(0); |
continue; |
} |
} else if (sz < MAXPATHLEN) |
|
continue; |
if (verb > 2) |
|
printf("%s: Scanning\n", buf); |
|
|
fprintf(stderr, "%s: Path too long\n", dir); |
if ( ! ofile_dirbuild(buf, sec, arch, |
return(0); |
use_all, verb, of)) |
|
return(0); |
} |
} |
if (DT_REG != dp->d_type) |
if (DT_REG != dp->d_type || |
|
(NULL == psec && !use_all) || |
|
!strcmp(MANDOC_DB, fn) || |
|
!strcmp(MANDOC_IDX, fn)) |
continue; |
continue; |
|
|
if (0 == strcmp(MANDOC_DB, fn) || |
/* |
0 == strcmp(MANDOC_IDX, fn)) |
* By default, skip files where the file name suffix |
continue; |
* does not agree with the section directory |
|
* they are located in. |
|
*/ |
|
|
|
suffix = strrchr(fn, '.'); |
|
if (0 == use_all) { |
|
if (NULL == suffix) |
|
continue; |
|
if (strcmp(suffix + 1, psec)) |
|
continue; |
|
} |
|
|
buf[0] = '\0'; |
buf[0] = '\0'; |
strlcat(buf, dir, MAXPATHLEN); |
strlcat(buf, dir, MAXPATHLEN); |
strlcat(buf, "/", MAXPATHLEN); |
strlcat(buf, "/", MAXPATHLEN); |
Line 1244 ofile_dirbuild(const char *dir, int verb, struct of ** |
|
Line 1400 ofile_dirbuild(const char *dir, int verb, struct of ** |
|
|
|
nof = mandoc_calloc(1, sizeof(struct of)); |
nof = mandoc_calloc(1, sizeof(struct of)); |
nof->fname = mandoc_strdup(buf); |
nof->fname = mandoc_strdup(buf); |
|
if (NULL != psec) |
|
nof->sec = mandoc_strdup(psec); |
|
if (NULL != parch) |
|
nof->arch = mandoc_strdup(parch); |
|
|
|
/* |
|
* Remember the file name without the extension, |
|
* to be used as the page title in the database. |
|
*/ |
|
|
|
if (NULL != suffix) |
|
*suffix = '\0'; |
|
nof->title = mandoc_strdup(fn); |
|
|
if (verb > 2) |
if (verb > 2) |
printf("%s: Scheduling\n", buf); |
printf("%s: Scheduling\n", buf); |
|
|
Line 1270 ofile_free(struct of *of) |
|
Line 1439 ofile_free(struct of *of) |
|
while (of) { |
while (of) { |
nof = of->next; |
nof = of->next; |
free(of->fname); |
free(of->fname); |
|
free(of->sec); |
|
free(of->arch); |
|
free(of->title); |
free(of); |
free(of); |
of = nof; |
of = nof; |
} |
} |