=================================================================== RCS file: /cvs/mandoc/cgi.c,v retrieving revision 1.25 retrieving revision 1.47 diff -u -p -r1.25 -r1.47 --- mandoc/cgi.c 2011/12/10 22:20:59 1.25 +++ mandoc/cgi.c 2014/01/05 20:41:04 1.47 @@ -1,6 +1,6 @@ -/* $Id: cgi.c,v 1.25 2011/12/10 22:20:59 kristaps Exp $ */ +/* $Id: cgi.c,v 1.47 2014/01/05 20:41:04 schwarze Exp $ */ /* - * Copyright (c) 2011 Kristaps Dzonsons + * Copyright (c) 2011, 2012 Kristaps Dzonsons * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -18,7 +18,6 @@ #include "config.h" #endif -#include #include #include @@ -35,14 +34,22 @@ #include #include +#if defined(__sun) +/* for stat() */ +#include +#include +#include +#endif + #include "apropos_db.h" #include "mandoc.h" #include "mdoc.h" #include "man.h" #include "main.h" #include "manpath.h" +#include "mandocdb.h" -#ifdef __linux__ +#if defined(__linux__) || defined(__sun) # include #else # include @@ -67,7 +74,7 @@ struct query { const char *arch; /* architecture */ const char *sec; /* manual section */ const char *expr; /* unparsed expression string */ - int whatis; /* whether whatis mode */ + int manroot; /* manroot index (or -1)*/ int legacy; /* whether legacy mode */ }; @@ -79,13 +86,17 @@ struct req { }; static int atou(const char *, unsigned *); -static void catman(const char *); +static void catman(const struct req *, const char *); static int cmp(const void *, const void *); -static void format(const char *); +static void format(const struct req *, const char *); static void html_print(const char *); +static void html_printquery(const struct req *); static void html_putchar(char); static int http_decode(char *); -static void http_parse(struct query *, char *); +static void http_parse(struct req *, char *); +static void http_print(const char *); +static void http_putchar(char); +static void http_printquery(const struct req *); static int pathstop(DIR *); static void pathgen(DIR *, char *, struct req *); static void pg_index(const struct req *, char *); @@ -102,9 +113,10 @@ static void resp_index(const struct req *); static void resp_search(struct res *, size_t, void *); static void resp_searchform(const struct req *); -static const char *progname; -static const char *cache; -static const char *host; +static const char *progname; /* cgi script name */ +static const char *cache; /* cache directory */ +static const char *css; /* css directory */ +static const char *host; /* hostname */ static const char * const pages[PAGE__MAX] = { "index", /* PAGE_INDEX */ @@ -128,7 +140,7 @@ atou(const char *buf, unsigned *v) return(0); if ((errno == ERANGE && (lval == LONG_MAX || lval == LONG_MIN)) || - (lval > UINT_MAX || lval < 0)) + (lval > INT_MAX || lval < 0)) return(0); *v = (unsigned int)lval; @@ -161,7 +173,41 @@ html_putchar(char c) break; } } +static void +http_printquery(const struct req *req) +{ + printf("&expr="); + http_print(req->q.expr ? req->q.expr : ""); + printf("&sec="); + http_print(req->q.sec ? req->q.sec : ""); + printf("&arch="); + http_print(req->q.arch ? req->q.arch : ""); +} + + +static void +html_printquery(const struct req *req) +{ + + printf("&expr="); + html_print(req->q.expr ? req->q.expr : ""); + printf("&sec="); + html_print(req->q.sec ? req->q.sec : ""); + printf("&arch="); + html_print(req->q.arch ? req->q.arch : ""); +} + +static void +http_print(const char *p) +{ + + if (NULL == p) + return; + while ('\0' != *p) + http_putchar(*p++); +} + /* * Call through to html_putchar(). * Accepts NULL strings. @@ -182,94 +228,92 @@ html_print(const char *p) * uses only GET for simplicity. */ static void -http_parse(struct query *q, char *p) +http_parse(struct req *req, char *p) { - char *key, *val; - size_t sz; - int legacy; + char *key, *val, *manroot; + int i, legacy; - memset(q, 0, sizeof(struct query)); + memset(&req->q, 0, sizeof(struct query)); - q->whatis = 1; legacy = -1; + manroot = NULL; - while (p && '\0' != *p) { - while (' ' == *p) - p++; - + while ('\0' != *p) { key = p; val = NULL; - if (NULL != (p = strchr(p, '='))) { + p += (int)strcspn(p, ";&"); + if ('\0' != *p) *p++ = '\0'; - val = p; + if (NULL != (val = strchr(key, '='))) + *val++ = '\0'; - sz = strcspn(p, ";&"); - /* LINTED */ - p += sz; - - if ('\0' != *p) - *p++ = '\0'; - } else { - p = key; - sz = strcspn(p, ";&"); - /* LINTED */ - p += sz; - - if ('\0' != *p) - p++; + if ('\0' == *key || NULL == val || '\0' == *val) continue; - } - if ('\0' == *key || '\0' == *val) - continue; - /* Just abort handling. */ if ( ! http_decode(key)) break; - if ( ! http_decode(val)) + if (NULL != val && ! http_decode(val)) break; if (0 == strcmp(key, "expr")) - q->expr = val; + req->q.expr = val; else if (0 == strcmp(key, "query")) - q->expr = val; + req->q.expr = val; else if (0 == strcmp(key, "sec")) - q->sec = val; + req->q.sec = val; else if (0 == strcmp(key, "sektion")) - q->sec = val; + req->q.sec = val; else if (0 == strcmp(key, "arch")) - q->arch = val; + req->q.arch = val; + else if (0 == strcmp(key, "manpath")) + manroot = val; else if (0 == strcmp(key, "apropos")) legacy = 0 == strcmp(val, "0"); - else if (0 == strcmp(key, "op")) - q->whatis = 0 == strcasecmp(val, "whatis"); } /* Test for old man.cgi compatibility mode. */ - if (legacy == 0) { - q->whatis = 0; - q->legacy = 1; - } else if (legacy > 0) { - q->legacy = 1; - q->whatis = 1; - } + req->q.legacy = legacy > 0; /* * Section "0" means no section when in legacy mode. * For some man.cgi scripts, "default" arch is none. */ - if (q->legacy && NULL != q->sec) - if (0 == strcmp(q->sec, "0")) - q->sec = NULL; - if (q->legacy && NULL != q->arch) - if (0 == strcmp(q->arch, "default")) - q->arch = NULL; + if (req->q.legacy && NULL != req->q.sec) + if (0 == strcmp(req->q.sec, "0")) + req->q.sec = NULL; + if (req->q.legacy && NULL != req->q.arch) + if (0 == strcmp(req->q.arch, "default")) + req->q.arch = NULL; + + /* Default to first manroot. */ + + if (NULL != manroot) { + for (i = 0; i < (int)req->psz; i++) + if (0 == strcmp(req->p[i].name, manroot)) + break; + req->q.manroot = i < (int)req->psz ? i : -1; + } } +static void +http_putchar(char c) +{ + + if (isalnum((unsigned char)c)) { + putchar((unsigned char)c); + return; + } else if (' ' == c) { + putchar('+'); + return; + } + printf("%%%.2x", c); +} + /* * HTTP-decode a string. The standard explanation is that this turns * "%4e+foo" into "n foo" in the regular way. This is done in-place @@ -325,19 +369,21 @@ resp_begin_html(int code, const char *msg) resp_begin_http(code, msg); - puts("\n" - "\n" - "\n" - "\n" - "\n" - "System Manpage Reference\n" - "\n" - "\n" - ""); + printf("\n" + "\n" + "\n" + "\n" + "\n" + "\n" + "System Manpage Reference\n" + "\n" + "\n" + "\n", css, css); } static void @@ -351,18 +397,17 @@ resp_end_html(void) static void resp_searchform(const struct req *req) { + int i; puts(""); - printf("
\n"); - printf("
\n" + printf("
\n" + "\n" + "
\n" "Search Parameters\n" - " or \n" - " for manuals satisfying \n" - " for manuals satisfying \n" + "q.expr ? req->q.expr : ""); printf("\">, section " "q.arch ? req->q.arch : ""); - puts("\">.\n" + printf("\">"); + if (req->psz > 1) { + puts(", "); + } + puts(".\n" "\n" "
\n" - ""); + "\n" + "
"); puts(""); } @@ -440,58 +501,64 @@ resp_baddb(void) static void resp_search(struct res *r, size_t sz, void *arg) { - int i; + size_t i, matched; const struct req *req; - if (1 == sz) { + req = (const struct req *)arg; + + if (sz > 0) + assert(req->q.manroot >= 0); + + for (matched = i = 0; i < sz; i++) + if (r[i].matched) + matched++; + + if (1 == matched) { + for (i = 0; i < sz; i++) + if (r[i].matched) + break; /* * If we have just one result, then jump there now * without any delay. */ puts("Status: 303 See Other"); - printf("Location: http://%s%s/show/%u/%u.html\n", - host, progname, - r[0].volume, r[0].rec); - puts("Content-Type: text/html; charset=utf-8\n"); + printf("Location: http://%s%s/show/%d/%u/%u.html?", + host, progname, req->q.manroot, + r[i].volume, r[i].rec); + http_printquery(req); + puts("\n" + "Content-Type: text/html; charset=utf-8\n"); return; } - qsort(r, sz, sizeof(struct res), cmp); - resp_begin_html(200, NULL); - - req = (const struct req *)arg; resp_searchform(req); - if (0 == sz) { - printf("

\n" - "No %s results found.\n", - req->q.whatis ? "whatis" : "apropos"); - if (req->q.whatis) { - printf("(Try q.expr ? req->q.expr : ""); - printf("&sec="); - html_print(req->q.sec ? req->q.sec : ""); - printf("&arch="); - html_print(req->q.arch ? req->q.arch : ""); - puts("\">apropos?)"); - } - puts("

"); + puts("
"); + + if (0 == matched) { + puts("

\n" + "No results found.\n" + "

\n" + "
"); resp_end_html(); return; } - puts("

\n" - ""); + qsort(r, sz, sizeof(struct res), cmp); - for (i = 0; i < (int)sz; i++) { + puts("
"); + + for (i = 0; i < sz; i++) { + if ( ! r[i].matched) + continue; printf("\n" ""); } - puts("
\n" - "", r[i].volume, r[i].rec); + "q.manroot, + r[i].volume, r[i].rec); + html_printquery(req); + printf("\">"); html_print(r[i].title); putchar('('); html_print(r[i].cat); @@ -507,7 +574,8 @@ resp_search(struct res *r, size_t sz, void *arg) "
"); + puts("\n" + ""); resp_end_html(); } @@ -520,7 +588,7 @@ pg_index(const struct req *req, char *path) } static void -catman(const char *file) +catman(const struct req *req, const char *file) { FILE *f; size_t len; @@ -533,20 +601,9 @@ catman(const char *file) return; } - resp_begin_http(200, NULL); - puts("\n" - "\n" - "\n" - "\n" - "\n" - "System Manpage Reference\n" - "\n" - "\n" - "\n" + resp_begin_html(200, NULL); + resp_searchform(req); + puts("
\n" "
");
 
 	while (NULL != (p = fgetln(f, &len))) {
@@ -659,6 +716,7 @@ catman(const char *file)
 	}
 
 	puts("
\n" + "
\n" "\n" ""); @@ -666,7 +724,7 @@ catman(const char *file) } static void -format(const char *file) +format(const struct req *req, const char *file) { struct mparse *mp; int fd; @@ -674,14 +732,14 @@ format(const char *file) struct man *man; void *vp; enum mandoclevel rc; - char opts[MAXPATHLEN + 128]; + char opts[PATH_MAX + 128]; if (-1 == (fd = open(file, O_RDONLY, 0))) { resp_baddb(); return; } - mp = mparse_alloc(MPARSE_AUTO, MANDOCLEVEL_FATAL, NULL, NULL); + mp = mparse_alloc(MPARSE_AUTO, MANDOCLEVEL_FATAL, NULL, NULL, 0); rc = mparse_readfd(mp, fd, file); close(fd); @@ -690,23 +748,31 @@ format(const char *file) return; } - snprintf(opts, sizeof(opts), "style=/man.css," - "man=%s/search.html?sec=%%S&expr=%%N," + snprintf(opts, sizeof(opts), "fragment," + "man=%s/search.html?sec=%%S&expr=Nm~^%%N$," /*"includes=/cgi-bin/man.cgi/usr/include/%%I"*/, progname); mparse_result(mp, &mdoc, &man); + if (NULL == man && NULL == mdoc) { + resp_baddb(); + mparse_free(mp); + return; + } + + resp_begin_html(200, NULL); + resp_searchform(req); + vp = html_alloc(opts); - if (NULL != mdoc) { - resp_begin_http(200, NULL); + if (NULL != mdoc) html_mdoc(vp, mdoc); - } else if (NULL != man) { - resp_begin_http(200, NULL); + else html_man(vp, man); - } else - resp_baddb(); + puts("\n" + ""); + html_free(vp); mparse_free(mp); } @@ -715,10 +781,11 @@ static void pg_show(const struct req *req, char *path) { struct manpaths ps; + size_t sz; char *sub; - char file[MAXPATHLEN]; - const char *fn, *cp; - int rc; + char file[PATH_MAX]; + const char *cp; + int rc, catm; unsigned int vol, rec, mr; DB *idx; DBT key, val; @@ -751,7 +818,7 @@ pg_show(const struct req *req, char *path) } /* - * Begin by chdir()ing into the root of the manpath. + * Begin by chdir()ing into the manroot. * This way we can pick up the database files, which are * relative to the manpath root. */ @@ -763,15 +830,17 @@ pg_show(const struct req *req, char *path) } memset(&ps, 0, sizeof(struct manpaths)); - manpath_manconf("etc/catman.conf", &ps); + manpath_manconf(&ps, "etc/catman.conf"); if (vol >= (unsigned int)ps.sz) { resp_error400(); goto out; } - strlcpy(file, ps.paths[vol], MAXPATHLEN); - strlcat(file, "/mandoc.index", MAXPATHLEN); + sz = strlcpy(file, ps.paths[vol], PATH_MAX); + assert(sz < PATH_MAX); + strlcat(file, "/", PATH_MAX); + strlcat(file, MANDOC_IDX, PATH_MAX); /* Open the index recno(3) database. */ @@ -788,21 +857,24 @@ pg_show(const struct req *req, char *path) if (0 != (rc = (*idx->get)(idx, &key, &val, 0))) { rc < 0 ? resp_baddb() : resp_error400(); goto out; - } + } else if (0 == val.size) { + resp_baddb(); + goto out; + } cp = (char *)val.data; + catm = 'c' == *cp++; - if (NULL == (fn = memchr(cp, '\0', val.size))) + if (NULL == memchr(cp, '\0', val.size - 1)) resp_baddb(); - else if (++fn - cp >= (int)val.size) - resp_baddb(); - else if (NULL == memchr(fn, '\0', val.size - (fn - cp))) - resp_baddb(); else { - if (0 == strcmp(cp, "cat")) - catman(fn + 1); + file[(int)sz] = '\0'; + strlcat(file, "/", PATH_MAX); + strlcat(file, cp, PATH_MAX); + if (catm) + catman(req, file); else - format(fn + 1); + format(req, file); } out: if (idx) @@ -813,15 +885,16 @@ out: static void pg_search(const struct req *req, char *path) { - size_t tt; + size_t tt, ressz; struct manpaths ps; int i, sz, rc; const char *ep, *start; + struct res *res; char **cp; struct opts opt; struct expr *expr; - if (0 == req->psz) { + if (req->q.manroot < 0 || 0 == req->psz) { resp_search(NULL, 0, (void *)req); return; } @@ -834,6 +907,8 @@ pg_search(const struct req *req, char *path) rc = -1; sz = 0; cp = NULL; + ressz = 0; + res = NULL; /* * Begin by chdir()ing into the root of the manpath. @@ -841,14 +916,15 @@ pg_search(const struct req *req, char *path) * relative to the manpath root. */ - if (-1 == (chdir(req->p[0].path))) { - perror(req->p[0].path); + assert(req->q.manroot < (int)req->psz); + if (-1 == (chdir(req->p[req->q.manroot].path))) { + perror(req->p[req->q.manroot].path); resp_search(NULL, 0, (void *)req); return; } memset(&ps, 0, sizeof(struct manpaths)); - manpath_manconf("etc/catman.conf", &ps); + manpath_manconf(&ps, "etc/catman.conf"); /* * Poor man's tokenisation: just break apart by spaces. @@ -875,25 +951,26 @@ pg_search(const struct req *req, char *path) * The resp_search() function is called with the results. */ - expr = req->q.whatis ? + expr = req->q.legacy ? termcomp(sz, cp, &tt) : exprcomp(sz, cp, &tt); if (NULL != expr) rc = apropos_search - (ps.sz, ps.paths, &opt, - expr, tt, (void *)req, resp_search); + (ps.sz, ps.paths, &opt, expr, tt, + (void *)req, &ressz, &res, resp_search); /* ...unless errors occured. */ if (0 == rc) resp_baddb(); else if (-1 == rc) - resp_search(NULL, 0, (void *)req); + resp_search(NULL, 0, NULL); for (i = 0; i < sz; i++) free(cp[i]); free(cp); + resfree(res, ressz); exprfree(expr); manpath_free(&ps); } @@ -902,23 +979,23 @@ int main(void) { int i; - char buf[MAXPATHLEN]; + char buf[PATH_MAX]; DIR *cwd; struct req req; char *p, *path, *subpath; /* Scan our run-time environment. */ - progname = getenv("SCRIPT_NAME"); - if (NULL == progname) + if (NULL == (cache = getenv("CACHE_DIR"))) + cache = "/cache/man.cgi"; + + if (NULL == (progname = getenv("SCRIPT_NAME"))) progname = ""; - cache = getenv("CACHE_DIR"); - if (NULL == cache) - cache = "/cache/man.cgi"; + if (NULL == (css = getenv("CSS_DIR"))) + css = ""; - host = getenv("HTTP_HOST"); - if (NULL == host) + if (NULL == (host = getenv("HTTP_HOST"))) host = "localhost"; /* @@ -939,14 +1016,14 @@ main(void) memset(&req, 0, sizeof(struct req)); - strlcpy(buf, ".", MAXPATHLEN); + strlcpy(buf, ".", PATH_MAX); pathgen(cwd, buf, &req); closedir(cwd); /* Next parse out the query string. */ if (NULL != (p = getenv("QUERY_STRING"))) - http_parse(&req.q, p); + http_parse(&req, p); /* * Now juggle paths to extract information. @@ -1027,11 +1104,20 @@ static int pathstop(DIR *dir) { struct dirent *d; +#if defined(__sun) + struct stat sb; +#endif - while (NULL != (d = readdir(dir))) + while (NULL != (d = readdir(dir))) { +#if defined(__sun) + stat(d->d_name, &sb); + if (S_IFREG & sb.st_mode) +#else if (DT_REG == d->d_type) +#endif if (0 == strcmp(d->d_name, "catman.conf")) return(1); + } return(0); } @@ -1048,9 +1134,12 @@ pathgen(DIR *dir, char *path, struct req *req) DIR *cd; int rc; size_t sz, ssz; +#if defined(__sun) + struct stat sb; +#endif - sz = strlcat(path, "/", MAXPATHLEN); - if (sz >= MAXPATHLEN) { + sz = strlcat(path, "/", PATH_MAX); + if (sz >= PATH_MAX) { fprintf(stderr, "%s: Path too long", path); return; } @@ -1063,13 +1152,19 @@ pathgen(DIR *dir, char *path, struct req *req) rc = 0; while (0 == rc && NULL != (d = readdir(dir))) { - if (DT_DIR != d->d_type || strcmp(d->d_name, "etc")) +#if defined(__sun) + stat(d->d_name, &sb); + if (!(S_IFDIR & sb.st_mode) +#else + if (DT_DIR != d->d_type +#endif + || strcmp(d->d_name, "etc")) continue; path[(int)sz] = '\0'; - ssz = strlcat(path, d->d_name, MAXPATHLEN); + ssz = strlcat(path, d->d_name, PATH_MAX); - if (ssz >= MAXPATHLEN) { + if (ssz >= PATH_MAX) { fprintf(stderr, "%s: Path too long", path); return; } else if (NULL == (cd = opendir(path))) { @@ -1083,14 +1178,17 @@ pathgen(DIR *dir, char *path, struct req *req) if (rc > 0) { /* This also strips the trailing slash. */ - path[(int)sz - 1] = '\0'; + path[(int)--sz] = '\0'; req->p = mandoc_realloc (req->p, (req->psz + 1) * sizeof(struct paths)); + /* + * Strip out the leading "./" unless we're just a ".", + * in which case use an empty string as our name. + */ req->p[(int)req->psz].path = mandoc_strdup(path); - /* And this strips out the leading "./". */ req->p[(int)req->psz].name = - cp = mandoc_strdup(path + 2); + cp = mandoc_strdup(path + (1 == sz ? 1 : 2)); req->psz++; /* * The name is just the path with all the slashes taken @@ -1109,13 +1207,19 @@ pathgen(DIR *dir, char *path, struct req *req) rewinddir(dir); while (NULL != (d = readdir(dir))) { - if (DT_DIR != d->d_type || '.' == d->d_name[0]) +#if defined(__sun) + stat(d->d_name, &sb); + if (!(S_IFDIR & sb.st_mode) +#else + if (DT_DIR != d->d_type +#endif + || '.' == d->d_name[0]) continue; path[(int)sz] = '\0'; - ssz = strlcat(path, d->d_name, MAXPATHLEN); + ssz = strlcat(path, d->d_name, PATH_MAX); - if (ssz >= MAXPATHLEN) { + if (ssz >= PATH_MAX) { fprintf(stderr, "%s: Path too long", path); return; } else if (NULL == (cd = opendir(path))) {