=================================================================== RCS file: /cvs/mandoc/cgi.c,v retrieving revision 1.2 retrieving revision 1.10 diff -u -p -r1.2 -r1.10 --- mandoc/cgi.c 2011/11/09 22:05:56 1.2 +++ mandoc/cgi.c 2011/12/07 00:23:04 1.10 @@ -1,99 +1,164 @@ -/* $Id: cgi.c,v 1.2 2011/11/09 22:05:56 kristaps Exp $ */ +/* $Id: cgi.c,v 1.10 2011/12/07 00:23:04 kristaps Exp $ */ +/* + * Copyright (c) 2011 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 + * copyright notice and this permission notice appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * 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 +#include + #include +#include +#include #include +#include #include #include #include +#include #include #include +#include -#include "apropos.h" +#include "apropos_db.h" #include "mandoc.h" +#include "mdoc.h" +#include "man.h" +#include "main.h" +#include "manpath.h" -/* - * The page a request is trying to make. - */ +#ifdef __linux__ +# include +#else +# include +#endif + enum page { PAGE_INDEX, PAGE_SEARCH, + PAGE_SHOW, PAGE__MAX }; -/* - * Key-value pair. - * Both key and val are on the heap. - */ struct kval { char *key; char *val; }; -/* - * The media type, determined by suffix, of the requesting or responding - * context. - */ -enum media { - MEDIA_HTML, - MEDIA__MAX -}; - -/* - * An HTTP request. - */ struct req { - struct kval *fields; /* query fields */ + struct kval *fields; size_t fieldsz; - enum media media; enum page page; }; -#if 0 -static void html_printtext(const char *); -#endif +static int atou(const char *, unsigned *); +static void catman(const char *); +static void format(const char *); +static void html_print(const char *); +static void html_putchar(char); static int kval_decode(char *); static void kval_parse(struct kval **, size_t *, char *); static void kval_free(struct kval *, size_t); -static void pg_index(const struct req *, char *); -static void pg_search(const struct req *, char *); -#if 0 -static void pg_searchres(struct rec *, size_t, void *); -#endif +static void pg_index(const struct manpaths *, + const struct req *, char *); +static void pg_search(const struct manpaths *, + const struct req *, char *); +static void pg_show(const struct manpaths *, + const struct req *, char *); +static void resp_bad(void); +static void resp_baddb(void); +static void resp_error400(void); +static void resp_error404(const char *); +static void resp_begin_html(int, const char *); +static void resp_begin_http(int, const char *); +static void resp_end_html(void); +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 * const pages[PAGE__MAX] = { "index", /* PAGE_INDEX */ "search", /* PAGE_SEARCH */ + "show", /* PAGE_SHOW */ }; -static const char * const medias[MEDIA__MAX] = { - "html", /* MEDIA_HTML */ -}; +/* + * This is just OpenBSD's strtol(3) suggestion. + * I use it instead of strtonum(3) for portability's sake. + */ +static int +atou(const char *buf, unsigned *v) +{ + char *ep; + long lval; -#if 0 + errno = 0; + lval = strtol(buf, &ep, 10); + if (buf[0] == '\0' || *ep != '\0') + return(0); + if ((errno == ERANGE && (lval == LONG_MAX || + lval == LONG_MIN)) || + (lval > UINT_MAX || lval < 0)) + return(0); + + *v = (unsigned int)lval; + return(1); +} + static void -html_printtext(const char *p) +html_putchar(char c) { - char c; + switch (c) { + case ('"'): + printf(""e;"); + break; + case ('&'): + printf("&"); + break; + case ('>'): + printf(">"); + break; + case ('<'): + printf("<"); + break; + default: + putchar((unsigned char)c); + break; + } +} + +/* + * Print a word, escaping HTML along the way. + * This will pass non-ASCII straight to output: be warned! + */ +static void +html_print(const char *p) +{ + + if (NULL == p) + return; while ('\0' != *p) - switch ((c = *p++)) { - case ('"'): - printf(""e;"); - break; - case ('&'): - printf("&"); - break; - case ('>'): - printf(">"); - break; - case ('<'): - printf("<"); - break; - default: - putchar((unsigned char)c); - break; - } + html_putchar(*p++); } -#endif static void kval_free(struct kval *p, size_t sz) @@ -109,7 +174,8 @@ kval_free(struct kval *p, size_t sz) /* * Parse out key-value pairs from an HTTP request variable. - * This can be either a cookie or a POST/GET string. + * This can be either a cookie or a POST/GET string, although man.cgi + * uses only GET for simplicity. */ static void kval_parse(struct kval **kv, size_t *kvsz, char *p) @@ -170,9 +236,9 @@ kval_parse(struct kval **kv, size_t *kvsz, char *p) } /* - * In-place 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 over the allocated string. + * 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 + * over the allocated string. */ static int kval_decode(char *p) @@ -203,51 +269,510 @@ kval_decode(char *p) return(1); } +static void +resp_begin_http(int code, const char *msg) +{ -/* ARGSUSED */ + if (200 != code) + printf("Status: %d %s\n", code, msg); + + puts("Content-Type: text/html; charset=utf-8" "\n" + "Cache-Control: no-cache" "\n" + "Pragma: no-cache" "\n" + ""); + + fflush(stdout); +} + static void -pg_index(const struct req *req, char *path) +resp_begin_html(int code, const char *msg) { + resp_begin_http(code, msg); + + puts("" "\n" + "" "\n" + " " "\n" + " " "\n" + " System Manpage Reference" "\n" + " " "\n" + " " "\n" + ""); } -#if 0 static void -pg_searchres(struct rec *recs, size_t sz, void *arg) +resp_end_html(void) { + + puts(" \n"); +} + +static void +resp_searchform(const struct req *req) +{ + int i; + const char *expr, *sec, *arch; + + expr = sec = arch = ""; + + for (i = 0; i < (int)req->fieldsz; i++) + if (0 == strcmp(req->fields[i].key, "expr")) + expr = req->fields[i].val; + else if (0 == strcmp(req->fields[i].key, "sec")) + sec = req->fields[i].val; + else if (0 == strcmp(req->fields[i].key, "arch")) + arch = req->fields[i].val; + + puts(""); + printf("
\n"); + puts("
\n" + " "); + printf(" Terms: "); + printf(" Section: "); + printf(" Arch: "); + puts("
\n
\n"); +} + +static void +resp_index(const struct req *req) +{ + + resp_begin_html(200, NULL); + resp_searchform(req); + resp_end_html(); +} + +static void +resp_error400(void) +{ + + resp_begin_html(400, "Query Malformed"); + puts("

Malformed Query

\n" + "

\n" + " The query your entered was malformed.\n" + " Try again from the\n" + " main page\n" + "

"); + resp_end_html(); +} + +static void +resp_error404(const char *page) +{ + + resp_begin_html(404, "Not Found"); + puts("

Page Not Found

\n" + "

\n" + " The page you're looking for, "); + printf(" "); + html_print(page); + puts(",\n" + " could not be found.\n" + " Try searching from the\n" + " main page\n" + "

"); + resp_end_html(); +} + +static void +resp_bad(void) +{ + resp_begin_html(500, "Internal Server Error"); + puts("

Generic badness happened.

"); + resp_end_html(); +} + +static void +resp_baddb(void) +{ + + resp_begin_html(500, "Internal Server Error"); + puts("

Your database is broken.

"); + resp_end_html(); +} + +static void +resp_search(struct res *r, size_t sz, void *arg) +{ int i; - const char *pg; - if (NULL == (pg = getenv("SCRIPT_NAME"))) - pg = ""; + if (1 == sz) { + /* + * 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"); + return; + } + resp_begin_html(200, NULL); + resp_searchform((const struct req *)arg); + + if (0 == sz) + puts("

No results found.

"); + for (i = 0; i < (int)sz; i++) { - printf("", - pg, recs[i].rec); - html_printtext(recs[i].title); + printf("

", r[i].volume, r[i].rec); + html_print(r[i].title); putchar('('); - html_printtext(recs[i].cat); - puts(")"); + html_print(r[i].cat); + if (r[i].arch && '\0' != *r[i].arch) { + putchar('/'); + html_print(r[i].arch); + } + printf(") "); + html_print(r[i].desc); + puts("

"); } + + resp_end_html(); } -#endif +/* ARGSUSED */ static void -pg_search(const struct req *req, char *path) +pg_index(const struct manpaths *ps, const struct req *req, char *path) { + + resp_index(req); +} + +static void +catman(const char *file) +{ + FILE *f; + size_t len; int i; - struct opts opt; + char *p; + int italic, bold; - for (i = 0; i < (int)req->fieldsz; i++) - if (0 == strcmp(req->fields[i].key, "key")) - break; + if (NULL == (f = fopen(file, "r"))) { + resp_baddb(); + return; + } - if (i == (int)req->fieldsz) + resp_begin_html(200, NULL); + + puts("
");
+	while (NULL != (p = fgetln(f, &len))) {
+		bold = italic = 0;
+		for (i = 0; i < (int)len - 1; i++) {
+			/* 
+			 * This means that the catpage is out of state.
+			 * Ignore it and keep going (although the
+			 * catpage is bogus).
+			 */
+
+			if ('\b' == p[i] || '\n' == p[i])
+				continue;
+
+			/*
+			 * Print a regular character.
+			 * Close out any bold/italic scopes.
+			 * If we're in back-space mode, make sure we'll
+			 * have something to enter when we backspace.
+			 */
+
+			if ('\b' != p[i + 1]) {
+				if (italic)
+					printf("");
+				if (bold)
+					printf("");
+				italic = bold = 0;
+				html_putchar(p[i]);
+				continue;
+			} else if (i + 2 >= (int)len)
+				continue;
+
+			/* Italic mode. */
+
+			if ('_' == p[i]) {
+				if (bold)
+					printf("");
+				if ( ! italic)
+					printf("");
+				bold = 0;
+				italic = 1;
+				i += 2;
+				html_putchar(p[i]);
+				continue;
+			}
+
+			/* 
+			 * Handle funny behaviour troff-isms.
+			 * These grok'd from the original man2html.c.
+			 */
+
+			if (('+' == p[i] && 'o' == p[i + 2]) ||
+					('o' == p[i] && '+' == p[i + 2]) ||
+					('|' == p[i] && '=' == p[i + 2]) ||
+					('=' == p[i] && '|' == p[i + 2]) ||
+					('*' == p[i] && '=' == p[i + 2]) ||
+					('=' == p[i] && '*' == p[i + 2]) ||
+					('*' == p[i] && '|' == p[i + 2]) ||
+					('|' == p[i] && '*' == p[i + 2]))  {
+				if (italic)
+					printf("");
+				if (bold)
+					printf("");
+				italic = bold = 0;
+				putchar('*');
+				i += 2;
+				continue;
+			} else if (('|' == p[i] && '-' == p[i + 2]) ||
+					('-' == p[i] && '|' == p[i + 1]) ||
+					('+' == p[i] && '-' == p[i + 1]) ||
+					('-' == p[i] && '+' == p[i + 1]) ||
+					('+' == p[i] && '|' == p[i + 1]) ||
+					('|' == p[i] && '+' == p[i + 1]))  {
+				if (italic)
+					printf("");
+				if (bold)
+					printf("");
+				italic = bold = 0;
+				putchar('+');
+				i += 2;
+				continue;
+			}
+
+			/* Bold mode. */
+			
+			if (italic)
+				printf("");
+			if ( ! bold)
+				printf("");
+			bold = 1;
+			italic = 0;
+			i += 2;
+			html_putchar(p[i]);
+		}
+
+		/* 
+		 * Clean up the last character.
+		 * We can get to a newline; don't print that. 
+		 */
+
+		if (italic)
+			printf("");
+		if (bold)
+			printf("");
+
+		if (i == (int)len - 1 && '\n' != p[i])
+			html_putchar(p[i]);
+
+		putchar('\n');
+	}
+
+	puts("
\n" + "\n" + ""); + + fclose(f); +} + +static void +format(const char *file) +{ + struct mparse *mp; + int fd; + struct mdoc *mdoc; + struct man *man; + void *vp; + enum mandoclevel rc; + char opts[MAXPATHLEN + 128]; + + if (-1 == (fd = open(file, O_RDONLY, 0))) { + resp_baddb(); return; + } + mp = mparse_alloc(MPARSE_AUTO, MANDOCLEVEL_FATAL, NULL, NULL); + rc = mparse_readfd(mp, fd, file); + close(fd); + + if (rc >= MANDOCLEVEL_FATAL) { + resp_baddb(); + return; + } + + snprintf(opts, sizeof(opts), "style=/style.css," + "man=%s/search.html?sec=%%S&expr=%%N," + "includes=/cgi-bin/man.cgi/usr/include/%%I", + progname); + + mparse_result(mp, &mdoc, &man); + vp = html_alloc(opts); + + if (NULL != mdoc) { + resp_begin_http(200, NULL); + html_mdoc(vp, mdoc); + } else if (NULL != man) { + resp_begin_http(200, NULL); + html_man(vp, man); + } else + resp_baddb(); + + html_free(vp); + mparse_free(mp); +} + +static void +pg_show(const struct manpaths *ps, const struct req *req, char *path) +{ + char *sub; + char file[MAXPATHLEN]; + const char *fn, *cp; + int rc; + unsigned int vol, rec; + DB *idx; + DBT key, val; + + if (NULL == path) { + resp_error400(); + return; + } else if (NULL == (sub = strrchr(path, '/'))) { + resp_error400(); + return; + } else + *sub++ = '\0'; + + if ( ! (atou(path, &vol) && atou(sub, &rec))) { + resp_error400(); + return; + } else if (vol >= (unsigned int)ps->sz) { + resp_error400(); + return; + } + + strlcpy(file, ps->paths[vol], MAXPATHLEN); + strlcat(file, "/mandoc.index", MAXPATHLEN); + + /* Open the index recno(3) database. */ + + idx = dbopen(file, O_RDONLY, 0, DB_RECNO, NULL); + if (NULL == idx) { + resp_baddb(); + return; + } + + key.data = &rec; + key.size = 4; + + if (0 != (rc = (*idx->get)(idx, &key, &val, 0))) { + rc < 0 ? resp_baddb() : resp_error400(); + goto out; + } + + cp = (char *)val.data; + + if (NULL == (fn = memchr(cp, '\0', val.size))) + resp_baddb(); + else if (++fn - cp >= (int)val.size) + resp_baddb(); + else if (NULL == memchr(fn, '\0', val.size - (fn - cp))) + resp_baddb(); + else { + strlcpy(file, ps->paths[vol], MAXPATHLEN); + strlcat(file, "/", MAXPATHLEN); + strlcat(file, fn, MAXPATHLEN); + if (0 == strcmp(cp, "cat")) + catman(file); + else + format(file); + } +out: + (*idx->close)(idx); +} + +static void +pg_search(const struct manpaths *ps, const struct req *req, char *path) +{ + size_t tt; + int i, sz, rc; + const char *ep, *start; + char **cp; + struct opts opt; + struct expr *expr; + + expr = NULL; + cp = NULL; + ep = NULL; + sz = 0; + memset(&opt, 0, sizeof(struct opts)); - /*opt.types = TYPE_NAME | TYPE_DESC; - apropos_search(&opt, req->fields[i].val, NULL, pg_searchres);*/ + + for (sz = i = 0; i < (int)req->fieldsz; i++) + if (0 == strcmp(req->fields[i].key, "expr")) + ep = req->fields[i].val; + else if (0 == strcmp(req->fields[i].key, "sec")) + opt.cat = req->fields[i].val; + else if (0 == strcmp(req->fields[i].key, "arch")) + opt.arch = req->fields[i].val; + + /* + * Poor man's tokenisation. + * Just break apart by spaces. + * Yes, this is half-ass. But it works for now. + */ + + while (ep && isspace((unsigned char)*ep)) + ep++; + + while (ep && '\0' != *ep) { + cp = mandoc_realloc(cp, (sz + 1) * sizeof(char *)); + start = ep; + while ('\0' != *ep && ! isspace((unsigned char)*ep)) + ep++; + cp[sz] = mandoc_malloc((ep - start) + 1); + memcpy(cp[sz], start, ep - start); + cp[sz++][ep - start] = '\0'; + while (isspace((unsigned char)*ep)) + ep++; + } + + rc = -1; + + /* + * Pump down into apropos backend. + * The resp_search() function is called with the results. + */ + + if (NULL != (expr = exprcomp(sz, cp, &tt))) + rc = apropos_search + (ps->sz, ps->paths, &opt, + expr, tt, (void *)req, resp_search); + + /* ...unless errors occured. */ + + if (0 == rc) + resp_baddb(); + else if (-1 == rc) + resp_search(NULL, 0, (void *)req); + + for (i = 0; i < sz; i++) + free(cp[i]); + + free(cp); + exprfree(expr); } int @@ -255,37 +780,56 @@ main(void) { int i; struct req req; - char *p; - char *path, *subpath, *suffix; + char *p, *path, *subpath; + struct manpaths paths; + /* HTTP init: read and parse the query string. */ + + progname = getenv("SCRIPT_NAME"); + if (NULL == progname) + progname = ""; + + cache = getenv("CACHE_DIR"); + if (NULL == cache) + cache = "/cache/man.cgi"; + + if (-1 == chdir(cache)) { + resp_bad(); + return(EXIT_FAILURE); + } + + host = getenv("HTTP_HOST"); + if (NULL == host) + host = "localhost"; + memset(&req, 0, sizeof(struct req)); if (NULL != (p = getenv("QUERY_STRING"))) kval_parse(&req.fields, &req.fieldsz, p); - suffix = subpath = path = NULL; + /* Resolve leading subpath component. */ - req.media = MEDIA_HTML; + subpath = path = NULL; req.page = PAGE__MAX; if (NULL == (path = getenv("PATH_INFO")) || '\0' == *path) req.page = PAGE_INDEX; + if (NULL != path && '/' == *path && '\0' == *++path) req.page = PAGE_INDEX; - if (NULL != path && NULL != (suffix = strrchr(path, '.'))) - if (NULL != suffix && NULL == strchr(suffix, '/')) - *suffix++ = '\0'; + /* Strip file suffix. */ + if (NULL != path && NULL != (p = strrchr(path, '.'))) + if (NULL != p && NULL == strchr(p, '/')) + *p++ = '\0'; + + /* Resolve subpath component. */ + if (NULL != path && NULL != (subpath = strchr(path, '/'))) - *subpath++ = '\0'; + *subpath++ = '\0'; - if (NULL != suffix && '\0' != *suffix) - for (i = 0; i < (int)MEDIA__MAX; i++) - if (0 == strcmp(medias[i], suffix)) { - req.media = (enum media)i; - break; - } + /* Map path into one we recognise. */ if (NULL != path && '\0' != *path) for (i = 0; i < (int)PAGE__MAX; i++) @@ -294,18 +838,30 @@ main(void) break; } + /* Initialise MANPATH. */ + + memset(&paths, 0, sizeof(struct manpaths)); + manpath_manconf("etc/catman.conf", &paths); + + /* Route pages. */ + switch (req.page) { case (PAGE_INDEX): - pg_index(&req, subpath); + pg_index(&paths, &req, subpath); break; case (PAGE_SEARCH): - pg_search(&req, subpath); + pg_search(&paths, &req, subpath); break; + case (PAGE_SHOW): + pg_show(&paths, &req, subpath); + break; default: - /* Blah */ + resp_error404(path); break; } + manpath_free(&paths); kval_free(req.fields, req.fieldsz); + return(EXIT_SUCCESS); }