=================================================================== RCS file: /cvs/mandoc/cgi.c,v retrieving revision 1.17 retrieving revision 1.85 diff -u -p -r1.17 -r1.85 --- mandoc/cgi.c 2011/12/08 00:48:28 1.17 +++ mandoc/cgi.c 2014/07/25 16:56:06 1.85 @@ -1,6 +1,7 @@ -/* $Id: cgi.c,v 1.17 2011/12/08 00:48:28 kristaps Exp $ */ +/* $Id: cgi.c,v 1.85 2014/07/25 16:56:06 schwarze Exp $ */ /* - * Copyright (c) 2011 Kristaps Dzonsons + * Copyright (c) 2011, 2012 Kristaps Dzonsons + * Copyright (c) 2014 Ingo Schwarze * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -18,112 +19,108 @@ #include "config.h" #endif -#include -#include - -#include #include #include #include #include -#include #include -#include -#include #include #include #include -#include "apropos_db.h" #include "mandoc.h" -#include "mdoc.h" -#include "man.h" +#include "mandoc_aux.h" #include "main.h" #include "manpath.h" +#include "mansearch.h" +#include "cgi.h" -#ifdef __linux__ -# include -#else -# include -#endif - -enum page { - PAGE_INDEX, - PAGE_SEARCH, - PAGE_SHOW, - PAGE__MAX +/* + * A query as passed to the search function. + */ +struct query { + char *manpath; /* desired manual directory */ + char *arch; /* architecture */ + char *sec; /* manual section */ + char *query; /* unparsed query expression */ + int equal; /* match whole names, not substrings */ }; -struct kval { - char *key; - char *val; -}; - struct req { - struct kval *fields; - size_t fieldsz; - enum page page; + struct query q; + char **p; /* array of available manpaths */ + size_t psz; /* number of available manpaths */ }; -static int atou(const char *, unsigned *); -static void catman(const char *); -static int cmp(const void *, const void *); -static void format(const char *); +static void catman(const struct req *, 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 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 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 int http_decode(char *); +static void http_parse(struct req *, const char *); +static void http_print(const char *); +static void http_putchar(char); +static void http_printquery(const struct req *); +static void pathgen(struct req *); +static void pg_error_badrequest(const char *); +static void pg_error_internal(void); +static void pg_index(const struct req *); +static void pg_noresult(const struct req *, const char *); +static void pg_search(const struct req *); +static void pg_searchres(const struct req *, + struct manpage *, size_t); +static void pg_show(struct req *, 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 void resp_show(const struct req *, const char *); +static void set_query_attr(char **, char **); +static int validate_filename(const char *); +static int validate_manpath(const struct req *, const char *); +static int validate_urifrag(const char *); -static const char *progname; -static const char *cache; -static const char *host; +static const char *scriptname; /* CGI script name */ -static const char * const pages[PAGE__MAX] = { - "index", /* PAGE_INDEX */ - "search", /* PAGE_SEARCH */ - "show", /* PAGE_SHOW */ +static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9}; +static const char *const sec_numbers[] = { + "0", "1", "2", "3", "3p", "4", "5", "6", "7", "8", "9" }; +static const char *const sec_names[] = { + "All Sections", + "1 - General Commands", + "2 - System Calls", + "3 - Subroutines", + "3p - Perl Subroutines", + "4 - Special Files", + "5 - File Formats", + "6 - Games", + "7 - Macros and Conventions", + "8 - Maintenance Commands", + "9 - Kernel Interface" +}; +static const int sec_MAX = sizeof(sec_names) / sizeof(char *); +static const char *const arch_names[] = { + "amd64", "alpha", "armish", "armv7", + "aviion", "hppa", "hppa64", "i386", + "ia64", "landisk", "loongson", "luna88k", + "macppc", "mips64", "octeon", "sgi", + "socppc", "solbourne", "sparc", "sparc64", + "vax", "zaurus", + "amiga", "arc", "arm32", "atari", + "beagle", "cats", "hp300", "mac68k", + "mvme68k", "mvme88k", "mvmeppc", "palm", + "pc532", "pegasos", "pmax", "powerpc", + "sun3", "wgrisc", "x68k" +}; +static const int arch_MAX = sizeof(arch_names) / sizeof(char *); + /* - * This is just OpenBSD's strtol(3) suggestion. - * I use it instead of strtonum(3) for portability's sake. + * Print a character, escaping HTML along the way. + * This will pass non-ASCII straight to output: be warned! */ -static int -atou(const char *buf, unsigned *v) -{ - char *ep; - long lval; - - 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_putchar(char c) { @@ -147,9 +144,67 @@ html_putchar(char c) } } +static void +http_printquery(const struct req *req) +{ + + if (NULL != req->q.manpath) { + printf("&manpath="); + http_print(req->q.manpath); + } + if (NULL != req->q.sec) { + printf("&sec="); + http_print(req->q.sec); + } + if (NULL != req->q.arch) { + printf("&arch="); + http_print(req->q.arch); + } + if (NULL != req->q.query) { + printf("&query="); + http_print(req->q.query); + } + if (0 == req->q.equal) + printf("&apropos=1"); +} + +static void +html_printquery(const struct req *req) +{ + + if (NULL != req->q.manpath) { + printf("&manpath="); + html_print(req->q.manpath); + } + if (NULL != req->q.sec) { + printf("&sec="); + html_print(req->q.sec); + } + if (NULL != req->q.arch) { + printf("&arch="); + html_print(req->q.arch); + } + if (NULL != req->q.query) { + printf("&query="); + html_print(req->q.query); + } + if (0 == req->q.equal) + printf("&apropos=1"); +} + +static void +http_print(const char *p) +{ + + if (NULL == p) + return; + while ('\0' != *p) + http_putchar(*p++); +} + /* - * Print a word, escaping HTML along the way. - * This will pass non-ASCII straight to output: be warned! + * Call through to html_putchar(). + * Accepts NULL strings. */ static void html_print(const char *p) @@ -161,95 +216,147 @@ html_print(const char *p) html_putchar(*p++); } +/* + * Transfer the responsibility for the allocated string *val + * to the query structure. + */ static void -kval_free(struct kval *p, size_t sz) +set_query_attr(char **attr, char **val) { - int i; - for (i = 0; i < (int)sz; i++) { - free(p[i].key); - free(p[i].val); - } - free(p); + free(*attr); + if (**val == '\0') { + *attr = NULL; + free(*val); + } else + *attr = *val; + *val = NULL; } /* - * Parse out key-value pairs from an HTTP request variable. - * This can be either a cookie or a POST/GET string, although man.cgi - * uses only GET for simplicity. + * Parse the QUERY_STRING for key-value pairs + * and store the values into the query structure. */ static void -kval_parse(struct kval **kv, size_t *kvsz, char *p) +http_parse(struct req *req, const char *qs) { - char *key, *val; - size_t sz, cur; + char *key, *val; + size_t keysz, valsz; - cur = 0; + req->q.manpath = NULL; + req->q.arch = NULL; + req->q.sec = NULL; + req->q.query = NULL; + req->q.equal = 1; - while (p && '\0' != *p) { - while (' ' == *p) - p++; + key = val = NULL; + while (*qs != '\0') { - key = p; - val = NULL; + /* Parse one key. */ - if (NULL != (p = strchr(p, '='))) { - *p++ = '\0'; - val = p; + keysz = strcspn(qs, "=;&"); + key = mandoc_strndup(qs, keysz); + qs += keysz; + if (*qs != '=') + goto next; - sz = strcspn(p, ";&"); - /* LINTED */ - p += sz; + /* Parse one value. */ - if ('\0' != *p) - *p++ = '\0'; - } else { - p = key; - sz = strcspn(p, ";&"); - /* LINTED */ - p += sz; + valsz = strcspn(++qs, ";&"); + val = mandoc_strndup(qs, valsz); + qs += valsz; - if ('\0' != *p) - p++; - continue; - } + /* Decode and catch encoding errors. */ - if ('\0' == *key || '\0' == *val) - continue; + if ( ! (http_decode(key) && http_decode(val))) + goto next; - /* Just abort handling. */ + /* Handle key-value pairs. */ - if ( ! kval_decode(key)) - return; - if ( ! kval_decode(val)) - return; + if ( ! strcmp(key, "query")) + set_query_attr(&req->q.query, &val); - if (*kvsz + 1 >= cur) { - cur++; - *kv = mandoc_realloc - (*kv, cur * sizeof(struct kval)); + else if ( ! strcmp(key, "apropos")) + req->q.equal = !strcmp(val, "0"); + + else if ( ! strcmp(key, "manpath")) { +#ifdef COMPAT_OLDURI + if ( ! strncmp(val, "OpenBSD ", 8)) { + val[7] = '-'; + if ('C' == val[8]) + val[8] = 'c'; + } +#endif + set_query_attr(&req->q.manpath, &val); } - (*kv)[(int)*kvsz].key = mandoc_strdup(key); - (*kv)[(int)*kvsz].val = mandoc_strdup(val); - (*kvsz)++; + else if ( ! (strcmp(key, "sec") +#ifdef COMPAT_OLDURI + && strcmp(key, "sektion") +#endif + )) { + if ( ! strcmp(val, "0")) + *val = '\0'; + set_query_attr(&req->q.sec, &val); + } + + else if ( ! strcmp(key, "arch")) { + if ( ! strcmp(val, "default")) + *val = '\0'; + set_query_attr(&req->q.arch, &val); + } + + /* + * The key must be freed in any case. + * The val may have been handed over to the query + * structure, in which case it is now NULL. + */ +next: + free(key); + key = NULL; + free(val); + val = NULL; + + if (*qs != '\0') + qs++; } + + /* Fall back to the default manpath. */ + + if (req->q.manpath == NULL) + req->q.manpath = mandoc_strdup(req->p[0]); } +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 * over the allocated string. */ static int -kval_decode(char *p) +http_decode(char *p) { char hex[3]; + char *q; int c; hex[2] = '\0'; - for ( ; '\0' != *p; p++) { + q = p; + for ( ; '\0' != *p; p++, q++) { if ('%' == *p) { if ('\0' == (hex[0] = *(p + 1))) return(0); @@ -260,13 +367,13 @@ kval_decode(char *p) if ('\0' == c) return(0); - *p = (char)c; - memmove(p + 1, p + 3, strlen(p + 3) + 1); + *q = (char)c; + p += 2; } else - *p = '+' == *p ? ' ' : *p; + *q = '+' == *p ? ' ' : *p; } - *p = '\0'; + *q = '\0'; return(1); } @@ -275,12 +382,12 @@ resp_begin_http(int code, const char *msg) { if (200 != code) - printf("Status: %d %s\n", code, msg); + printf("Status: %d %s\r\n", code, msg); - puts("Content-Type: text/html; charset=utf-8" "\n" - "Cache-Control: no-cache" "\n" - "Pragma: no-cache" "\n" - ""); + printf("Content-Type: text/html; charset=utf-8\r\n" + "Cache-Control: no-cache\r\n" + "Pragma: no-cache\r\n" + "\r\n"); fflush(stdout); } @@ -291,200 +398,324 @@ 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" + "%s\n" + "\n" + "\n" + "\n", + CSS_DIR, CSS_DIR, CUSTOMIZE_TITLE); } static void resp_end_html(void) { - puts(" \n"); + puts("\n" + ""); } static void resp_searchform(const struct req *req) { - int i; - const char *expr, *sec, *arch; + int i; - expr = sec = arch = ""; + puts(CUSTOMIZE_BEGIN); + puts(""); + printf("
\n" + "
\n" + "
\n" + "Manual Page Search Parameters\n", + scriptname); - 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, "query")) - 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, "sektion")) - sec = req->fields[i].val; - else if (0 == strcmp(req->fields[i].key, "arch")) - arch = req->fields[i].val; + /* Write query input box. */ - if (NULL != sec && 0 == strcmp(sec, "0")) - sec = NULL; + printf( "
\n" + "q.query) + html_print(req->q.query); + puts("\" SIZE=\"40\">"); - puts(""); - printf("\n"); - printf("
\n" - "Search Parameters\n" - " or \n" - " for manuals satisfying \n" - ", section " - ", arch " - ".\n" - "\n" + /* Write submission and reset buttons. */ + + printf( "\n" + "\n"); + + /* Write show radio button */ + + printf( "
\n" + "q.equal) + printf("CHECKED "); + printf( "NAME=\"apropos\" ID=\"show\" VALUE=\"0\">\n" + "\n"); + + /* Write section selector. */ + + printf( "
\n" + ""); + + /* Write architecture selector. */ + + printf( ""); + + /* Write manpath selector. */ + + if (req->psz > 1) { + puts(""); + } + + /* Write search radio button */ + + printf( "\n" + "q.equal) + printf("CHECKED "); + printf( "NAME=\"apropos\" ID=\"search\" VALUE=\"1\">\n" + "\n"); + + puts("
\n" "
\n" "
\n" - ""); + "
"); + puts(""); } -static void -resp_index(const struct req *req) +static int +validate_urifrag(const char *frag) { - resp_begin_html(200, NULL); - resp_searchform(req); - resp_end_html(); + while ('\0' != *frag) { + if ( ! (isalnum((unsigned char)*frag) || + '-' == *frag || '.' == *frag || + '/' == *frag || '_' == *frag)) + return(0); + frag++; + } + return(1); } -static void -resp_error400(void) +static int +validate_manpath(const struct req *req, const char* manpath) { + size_t i; - resp_begin_html(400, "Query Malformed"); - printf("

Malformed Query

\n" - "

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

", progname); - resp_end_html(); + if ( ! strcmp(manpath, "mandoc")) + return(1); + + for (i = 0; i < req->psz; i++) + if ( ! strcmp(manpath, req->p[i])) + return(1); + + return(0); } +static int +validate_filename(const char *file) +{ + + if ('.' == file[0] && '/' == file[1]) + file += 2; + + return ( ! (strstr(file, "../") || strstr(file, "/..") || + (strncmp(file, "man", 3) && strncmp(file, "cat", 3)))); +} + static void -resp_error404(const char *page) +pg_index(const struct req *req) { - resp_begin_html(404, "Not Found"); - puts("

Page Not Found

\n" - "

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

", progname); + resp_begin_html(200, NULL); + resp_searchform(req); + printf("

\n" + "This web interface is documented in the " + "man.cgi " + "manual, and the " + "apropos " + "manual explains the query syntax.\n" + "

\n", + scriptname, scriptname); resp_end_html(); } static void -resp_bad(void) +pg_noresult(const struct req *req, const char *msg) { - resp_begin_html(500, "Internal Server Error"); - puts("

Generic badness happened.

"); + resp_begin_html(200, NULL); + resp_searchform(req); + puts("

"); + puts(msg); + puts("

"); resp_end_html(); } static void -resp_baddb(void) +pg_error_badrequest(const char *msg) { + resp_begin_html(400, "Bad Request"); + puts("

Bad Request

\n" + "

\n"); + puts(msg); + printf("Try again from the\n" + "main page.\n" + "

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

Your database is broken.

"); + puts("

Internal Server Error

"); resp_end_html(); } static void -resp_search(struct res *r, size_t sz, void *arg) +pg_searchres(const struct req *req, struct manpage *r, size_t sz) { - int i; + char *arch, *archend; + size_t i, iuse, isec; + int archprio, archpriouse; + int prio, priouse; + char sec; + for (i = 0; i < sz; i++) { + if (validate_filename(r[i].file)) + continue; + fprintf(stderr, "invalid filename %s in %s database\n", + r[i].file, req->q.manpath); + pg_error_internal(); + return; + } + 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"); + printf("Status: 303 See Other\r\n"); + printf("Location: http://%s%s/%s/%s?", + HTTP_HOST, scriptname, req->q.manpath, r[0].file); + http_printquery(req); + printf("\r\n" + "Content-Type: text/html; charset=utf-8\r\n" + "\r\n"); return; } - qsort(r, sz, sizeof(struct res), cmp); - resp_begin_html(200, NULL); - resp_searchform((const struct req *)arg); + resp_searchform(req); + puts("
"); + puts(""); - if (0 == sz) { - puts("

No results found.

"); - resp_end_html(); - return; + for (i = 0; i < sz; i++) { + printf("\n" + "\n" + "\n" + ""); } - puts("

\n" - "
\n" + "q.manpath, r[i].file); + html_printquery(req); + printf("\">"); + html_print(r[i].names); + printf("\n" + ""); + html_print(r[i].output); + puts("
"); + puts("
\n" + "
"); - for (i = 0; i < (int)sz; i++) { - printf("", r[i].volume, r[i].rec); - html_print(r[i].title); - putchar('('); - html_print(r[i].cat); - if (r[i].arch && '\0' != *r[i].arch) { - putchar('/'); - html_print(r[i].arch); + /* + * In man(1) mode, show one of the pages + * even if more than one is found. + */ + + if (req->q.equal) { + puts("
"); + iuse = 0; + priouse = 10; + archpriouse = 3; + for (i = 0; i < sz; i++) { + isec = strcspn(r[i].file, "123456789"); + sec = r[i].file[isec]; + if ('\0' == sec) + continue; + prio = sec_prios[sec - '1']; + if (NULL == req->q.arch) { + archprio = + (NULL == (arch = strchr( + r[i].file + isec, '/'))) ? 3 : + (NULL == (archend = strchr( + arch + 1, '/'))) ? 0 : + strncmp(arch, "amd64/", + archend - arch) ? 2 : 1; + if (archprio < archpriouse) { + archpriouse = archprio; + priouse = prio; + iuse = i; + continue; + } + if (archprio > archpriouse) + continue; + } + if (prio >= priouse) + continue; + priouse = prio; + iuse = i; } - printf(")"); - html_print(r[i].desc); - puts(""); + resp_show(req, r[iuse].file); } - puts(""); - resp_end_html(); } -/* ARGSUSED */ static void -pg_index(const struct manpaths *ps, const struct req *req, char *path) +catman(const struct req *req, const char *file) { - - resp_index(req); -} - -static void -catman(const char *file) -{ FILE *f; size_t len; int i; @@ -492,26 +723,13 @@ catman(const char *file) int italic, bold; if (NULL == (f = fopen(file, "r"))) { - resp_baddb(); + puts("

You specified an invalid manual file.

"); return; } - resp_begin_http(200, NULL); - puts("" "\n" - "" "\n" - " " "\n" - " " "\n" - " " "\n" - " System Manpage Reference" "\n" - " " "\n" - " " "\n" - ""); + puts("
\n" + "
");
 
-	puts("
");
 	while (NULL != (p = fgetln(f, &len))) {
 		bold = italic = 0;
 		for (i = 0; i < (int)len - 1; i++) {
@@ -622,14 +840,13 @@ catman(const char *file)
 	}
 
 	puts("
\n"
-	     "\n"
-	     "");
+	     "
"); fclose(f); } static void -format(const char *file) +format(const struct req *req, const char *file) { struct mparse *mp; int fd; @@ -637,161 +854,162 @@ 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(); + puts("

You specified an invalid manual file.

"); return; } - mp = mparse_alloc(MPARSE_AUTO, MANDOCLEVEL_FATAL, NULL, NULL); + mp = mparse_alloc(MPARSE_SO, MANDOCLEVEL_FATAL, NULL, + req->q.manpath); rc = mparse_readfd(mp, fd, file); close(fd); if (rc >= MANDOCLEVEL_FATAL) { - resp_baddb(); + fprintf(stderr, "fatal mandoc error: %s/%s\n", + req->q.manpath, file); + pg_error_internal(); return; } - snprintf(opts, sizeof(opts), "style=/man.css," - "man=%s/search.html?sec=%%S&expr=%%N," - /*"includes=/cgi-bin/man.cgi/usr/include/%%I"*/, - progname); + snprintf(opts, sizeof(opts), "fragment,man=%s?" + "manpath=%s&query=%%N&sec=%%S&arch=%s", + scriptname, req->q.manpath, + req->q.arch ? req->q.arch : ""); - mparse_result(mp, &mdoc, &man); + mparse_result(mp, &mdoc, &man, NULL); + if (NULL == man && NULL == mdoc) { + fprintf(stderr, "fatal mandoc error: %s/%s\n", + req->q.manpath, file); + pg_error_internal(); + mparse_free(mp); + return; + } + 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(); html_free(vp); mparse_free(mp); } static void -pg_show(const struct manpaths *ps, const struct req *req, char *path) +resp_show(const struct req *req, const char *file) { - 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(); + if ('.' == file[0] && '/' == file[1]) + file += 2; + + if ('c' == *file) + catman(req, file); + else + format(req, file); +} + +static void +pg_show(struct req *req, const char *fullpath) +{ + char *manpath; + const char *file; + + if ((file = strchr(fullpath, '/')) == NULL) { + pg_error_badrequest( + "You did not specify a page to show."); return; - } else if (NULL == (sub = strrchr(path, '/'))) { - resp_error400(); - return; - } else - *sub++ = '\0'; + } + manpath = mandoc_strndup(fullpath, file - fullpath); + file++; - if ( ! (atou(path, &vol) && atou(sub, &rec))) { - resp_error400(); + if ( ! validate_manpath(req, manpath)) { + pg_error_badrequest( + "You specified an invalid manpath."); + free(manpath); return; - } else if (vol >= (unsigned int)ps->sz) { - resp_error400(); - return; } - strlcpy(file, ps->paths[vol], MAXPATHLEN); - strlcat(file, "/mandoc.index", MAXPATHLEN); + /* + * Begin by chdir()ing into the manpath. + * This way we can pick up the database files, which are + * relative to the manpath root. + */ - /* Open the index recno(3) database. */ - - idx = dbopen(file, O_RDONLY, 0, DB_RECNO, NULL); - if (NULL == idx) { - resp_baddb(); + if (chdir(manpath) == -1) { + fprintf(stderr, "chdir %s: %s\n", + manpath, strerror(errno)); + pg_error_internal(); + free(manpath); return; } - key.data = &rec; - key.size = 4; + if (strcmp(manpath, "mandoc")) { + free(req->q.manpath); + req->q.manpath = manpath; + } else + free(manpath); - 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, cache, MAXPATHLEN); - strlcpy(file, "/", MAXPATHLEN); - strlcat(file, fn, MAXPATHLEN); - if (0 == strcmp(cp, "cat")) - catman(file); - else - format(file); + if ( ! validate_filename(file)) { + pg_error_badrequest( + "You specified an invalid manual file."); + return; } -out: - (*idx->close)(idx); + + resp_begin_html(200, NULL); + resp_searchform(req); + resp_show(req, file); + resp_end_html(); } static void -pg_search(const struct manpaths *ps, const struct req *req, char *path) +pg_search(const struct req *req) { - size_t tt; - int i, sz, rc, whatis; - const char *ep, *start; - char **cp; - struct opts opt; - struct expr *expr; + struct mansearch search; + struct manpaths paths; + struct manpage *res; + char **cp; + const char *ep, *start; + size_t ressz; + int i, sz; - expr = NULL; - cp = NULL; - ep = NULL; - sz = 0; - whatis = 1; + /* + * Begin by chdir()ing into the root of the manpath. + * This way we can pick up the database files, which are + * relative to the manpath root. + */ - memset(&opt, 0, sizeof(struct opts)); + if (-1 == (chdir(req->q.manpath))) { + fprintf(stderr, "chdir %s: %s\n", + req->q.manpath, strerror(errno)); + pg_error_internal(); + return; + } - 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, "query")) - 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, "sektion")) - opt.cat = req->fields[i].val; - else if (0 == strcmp(req->fields[i].key, "arch")) - opt.arch = req->fields[i].val; - else if (0 == strcmp(req->fields[i].key, "apropos")) - whatis = 0 == strcmp - (req->fields[i].val, "0"); - else if (0 == strcmp(req->fields[i].key, "op")) - whatis = 0 == strcasecmp - (req->fields[i].val, "whatis"); + search.arch = req->q.arch; + search.sec = req->q.sec; + search.deftype = req->q.equal ? TYPE_Nm : (TYPE_Nm | TYPE_Nd); + search.flags = req->q.equal ? MANSEARCH_MAN : 0; - if (NULL != opt.cat && 0 == strcmp(opt.cat, "0")) - opt.cat = NULL; + paths.sz = 1; + paths.paths = mandoc_malloc(sizeof(char *)); + paths.paths[0] = mandoc_strdup("."); /* - * Poor man's tokenisation. - * Just break apart by spaces. + * Poor man's tokenisation: just break apart by spaces. * Yes, this is half-ass. But it works for now. */ + ep = req->q.query; while (ep && isspace((unsigned char)*ep)) ep++; + sz = 0; + cp = NULL; while (ep && '\0' != *ep) { - cp = mandoc_realloc(cp, (sz + 1) * sizeof(char *)); + cp = mandoc_reallocarray(cp, sz + 1, sizeof(char *)); start = ep; while ('\0' != *ep && ! isspace((unsigned char)*ep)) ep++; @@ -802,131 +1020,147 @@ pg_search(const struct manpaths *ps, const struct req ep++; } - rc = -1; + if (0 == mansearch(&search, &paths, sz, cp, "Nd", &res, &ressz)) + pg_noresult(req, "You entered an invalid query."); + else if (0 == ressz) + pg_noresult(req, "No results found."); + else + pg_searchres(req, res, ressz); - /* - * Pump down into apropos backend. - * The resp_search() function is called with the results. - */ - - expr = whatis ? 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); - - /* ...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); + + for (i = 0; i < (int)ressz; i++) { + free(res[i].file); + free(res[i].names); + free(res[i].output); + } + free(res); + + free(paths.paths[0]); + free(paths.paths); } int main(void) { - int i; struct req req; - char *p, *path, *subpath; - struct manpaths paths; + const char *path; + const char *querystring; + int i; - /* HTTP init: read and parse the query string. */ + /* Scan our run-time environment. */ - progname = getenv("SCRIPT_NAME"); - if (NULL == progname) - progname = ""; + if (NULL == (scriptname = getenv("SCRIPT_NAME"))) + scriptname = ""; - cache = getenv("CACHE_DIR"); - if (NULL == cache) - cache = "/cache/man.cgi"; - - if (-1 == chdir(cache)) { - resp_bad(); + if ( ! validate_urifrag(scriptname)) { + fprintf(stderr, "unsafe SCRIPT_NAME \"%s\"\n", + scriptname); + pg_error_internal(); return(EXIT_FAILURE); } - host = getenv("HTTP_HOST"); - if (NULL == host) - host = "localhost"; + /* + * First we change directory into the MAN_DIR so that + * subsequent scanning for manpath directories is rooted + * relative to the same position. + */ + if (-1 == chdir(MAN_DIR)) { + fprintf(stderr, "MAN_DIR: %s: %s\n", + MAN_DIR, strerror(errno)); + pg_error_internal(); + return(EXIT_FAILURE); + } + memset(&req, 0, sizeof(struct req)); + pathgen(&req); - if (NULL != (p = getenv("QUERY_STRING"))) - kval_parse(&req.fields, &req.fieldsz, p); + /* Next parse out the query string. */ - /* Resolve leading subpath component. */ + if (NULL != (querystring = getenv("QUERY_STRING"))) + http_parse(&req, querystring); - subpath = path = NULL; - req.page = PAGE__MAX; + if ( ! validate_manpath(&req, req.q.manpath)) { + pg_error_badrequest( + "You specified an invalid manpath."); + return(EXIT_FAILURE); + } - if (NULL == (path = getenv("PATH_INFO")) || '\0' == *path) - req.page = PAGE_INDEX; + if ( ! (NULL == req.q.arch || validate_urifrag(req.q.arch))) { + pg_error_badrequest( + "You specified an invalid architecture."); + return(EXIT_FAILURE); + } - if (NULL != path && '/' == *path && '\0' == *++path) - req.page = PAGE_INDEX; + /* Dispatch to the three different pages. */ - /* Strip file suffix. */ + path = getenv("PATH_INFO"); + if (NULL == path) + path = ""; + else if ('/' == *path) + path++; - if (NULL != path && NULL != (p = strrchr(path, '.'))) - if (NULL != p && NULL == strchr(p, '/')) - *p++ = '\0'; + if ('\0' != *path) + pg_show(&req, path); + else if (NULL != req.q.query) + pg_search(&req); + else + pg_index(&req); - /* Resolve subpath component. */ - - if (NULL != path && NULL != (subpath = strchr(path, '/'))) - *subpath++ = '\0'; - - /* Map path into one we recognise. */ - - if (NULL != path && '\0' != *path) - for (i = 0; i < (int)PAGE__MAX; i++) - if (0 == strcmp(pages[i], path)) { - req.page = (enum page)i; - 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(&paths, &req, subpath); - break; - case (PAGE_SEARCH): - pg_search(&paths, &req, subpath); - break; - case (PAGE_SHOW): - pg_show(&paths, &req, subpath); - break; - default: - resp_error404(path); - break; - } - - manpath_free(&paths); - kval_free(req.fields, req.fieldsz); - + free(req.q.manpath); + free(req.q.arch); + free(req.q.sec); + free(req.q.query); + for (i = 0; i < (int)req.psz; i++) + free(req.p[i]); + free(req.p); return(EXIT_SUCCESS); } -static int -cmp(const void *p1, const void *p2) +/* + * Scan for indexable paths. + */ +static void +pathgen(struct req *req) { + FILE *fp; + char *dp; + size_t dpsz; - return(strcasecmp(((const struct res *)p1)->title, - ((const struct res *)p2)->title)); -} + if (NULL == (fp = fopen("manpath.conf", "r"))) { + fprintf(stderr, "%s/manpath.conf: %s\n", + MAN_DIR, strerror(errno)); + pg_error_internal(); + exit(EXIT_FAILURE); + } + while (NULL != (dp = fgetln(fp, &dpsz))) { + if ('\n' == dp[dpsz - 1]) + dpsz--; + req->p = mandoc_realloc(req->p, + (req->psz + 1) * sizeof(char *)); + dp = mandoc_strndup(dp, dpsz); + if ( ! validate_urifrag(dp)) { + fprintf(stderr, "%s/manpath.conf contains " + "unsafe path \"%s\"\n", MAN_DIR, dp); + pg_error_internal(); + exit(EXIT_FAILURE); + } + if (NULL != strchr(dp, '/')) { + fprintf(stderr, "%s/manpath.conf contains " + "path with slash \"%s\"\n", MAN_DIR, dp); + pg_error_internal(); + exit(EXIT_FAILURE); + } + req->p[req->psz++] = dp; + } + + if ( req->p == NULL ) { + fprintf(stderr, "%s/manpath.conf is empty\n", MAN_DIR); + pg_error_internal(); + exit(EXIT_FAILURE); + } +}