-/* $Id: cgi.c,v 1.23 2011/12/10 10:59:21 kristaps Exp $ */
+/* $Id: cgi.c,v 1.99 2014/10/07 18:20:06 schwarze Exp $ */
/*
- * Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2014 Ingo Schwarze <schwarze@usta.de>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* 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/param.h>
-#include <sys/wait.h>
+#include <sys/types.h>
+#include <sys/time.h>
-#include <assert.h>
#include <ctype.h>
#include <errno.h>
#include <fcntl.h>
#include <limits.h>
-#include <regex.h>
-#include <stdio.h>
-#include <stdarg.h>
#include <stdint.h>
+#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
-#include "apropos_db.h"
#include "mandoc.h"
-#include "mdoc.h"
-#include "man.h"
+#include "mandoc_aux.h"
#include "main.h"
#include "manpath.h"
-
-#ifdef __linux__
-# include <db_185.h>
-#else
-# include <db.h>
-#endif
-
-enum page {
- PAGE_INDEX,
- PAGE_SEARCH,
- PAGE_SHOW,
- PAGE__MAX
-};
+#include "mansearch.h"
+#include "cgi.h"
/*
* A query as passed to the search function.
- * See kval_query() on how this is parsed.
*/
struct query {
- const char *arch; /* architecture */
- const char *sec; /* manual section */
- const char *expr; /* unparsed expression string */
- int whatis; /* whether whatis mode */
- int legacy; /* whether legacy mode */
-};
-
-struct kval {
- char *key;
- char *val;
+ 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 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_putchar(char);
-static int kval_decode(char *);
-static void kval_free(struct kval *, size_t);
-static void kval_parse(struct kval **, size_t *, char *);
-static void kval_query(struct query *,
- const 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 *, const char *);
+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"
};
-
-/*
- * Initialise and parse a query structure from input.
- * This accomodates for mdocml's man.cgi and also for legacy man.cgi
- * input keys ("sektion" and "apropos").
- * Note that legacy mode has some quirks: if apropos legacy mode is
- * detected, we unset the section and architecture string.
- */
-static void
-kval_query(struct query *q, const struct kval *fields, size_t sz)
-{
- int i, legacy;
-
- memset(q, 0, sizeof(struct query));
- q->whatis = 1;
- legacy = -1;
-
- for (i = 0; i < (int)sz; i++)
- if (0 == strcmp(fields[i].key, "expr"))
- q->expr = fields[i].val;
- else if (0 == strcmp(fields[i].key, "query"))
- q->expr = fields[i].val;
- else if (0 == strcmp(fields[i].key, "sec"))
- q->sec = fields[i].val;
- else if (0 == strcmp(fields[i].key, "sektion"))
- q->sec = fields[i].val;
- else if (0 == strcmp(fields[i].key, "arch"))
- q->arch = fields[i].val;
- else if (0 == strcmp(fields[i].key, "apropos"))
- legacy = 0 == strcmp
- (fields[i].val, "0");
- else if (0 == strcmp(fields[i].key, "op"))
- q->whatis = 0 == strcasecmp
- (fields[i].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;
- }
-
- /*
- * 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;
-}
-
-/*
- * 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;
-
- 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 const char *const sec_names[] = {
+ "All Sections",
+ "1 - General Commands",
+ "2 - System Calls",
+ "3 - Library Functions",
+ "3p - Perl Library",
+ "4 - Device Drivers",
+ "5 - File Formats",
+ "6 - Games",
+ "7 - Miscellaneous Information",
+ "8 - System Manager\'s Manual",
+ "9 - Kernel Developer\'s Manual"
+};
+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 *);
/*
* Print a character, escaping HTML along the way.
}
}
+static void
+http_printquery(const struct req *req, const char *sep)
+{
+
+ if (NULL != req->q.query) {
+ printf("query=");
+ http_print(req->q.query);
+ }
+ if (0 == req->q.equal)
+ printf("%sapropos=1", sep);
+ if (NULL != req->q.sec) {
+ printf("%ssec=", sep);
+ http_print(req->q.sec);
+ }
+ if (NULL != req->q.arch) {
+ printf("%sarch=", sep);
+ http_print(req->q.arch);
+ }
+ if (NULL != req->q.manpath &&
+ strcmp(req->q.manpath, req->p[0])) {
+ printf("%smanpath=", sep);
+ http_print(req->q.manpath);
+ }
+}
+
+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.
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);
}
/*
* 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);
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);
}
{
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);
}
resp_begin_http(code, msg);
- puts("<!DOCTYPE HTML PUBLIC "
- " \"-//W3C//DTD HTML 4.01//EN\""
- " \"http://www.w3.org/TR/html4/strict.dtd\">\n"
- "<HTML>\n"
- "<HEAD>\n"
- "<META HTTP-EQUIV=\"Content-Type\""
- " CONTENT=\"text/html; charset=utf-8\">\n"
- "<LINK REL=\"stylesheet\" HREF=\"/man.cgi.css\""
- " TYPE=\"text/css\" media=\"all\">\n"
- "<TITLE>System Manpage Reference</TITLE>\n"
- "</HEAD>\n"
- "<BODY>\n"
- "<!-- Begin page content. //-->");
+ printf("<!DOCTYPE html>\n"
+ "<HTML>\n"
+ "<HEAD>\n"
+ "<META CHARSET=\"UTF-8\" />\n"
+ "<LINK REL=\"stylesheet\" HREF=\"%s/man-cgi.css\""
+ " TYPE=\"text/css\" media=\"all\">\n"
+ "<LINK REL=\"stylesheet\" HREF=\"%s/man.css\""
+ " TYPE=\"text/css\" media=\"all\">\n"
+ "<TITLE>%s</TITLE>\n"
+ "</HEAD>\n"
+ "<BODY>\n"
+ "<!-- Begin page content. //-->\n",
+ CSS_DIR, CSS_DIR, CUSTOMIZE_TITLE);
}
static void
static void
resp_searchform(const struct req *req)
{
- struct query q;
-
- kval_query(&q, req->fields, req->fieldsz);
+ int i;
+ puts(CUSTOMIZE_BEGIN);
puts("<!-- Begin search form. //-->");
- printf("<FORM ACTION=\"");
- html_print(progname);
- printf("/search.html\" METHOD=\"get\">\n");
- printf("<FIELDSET>\n"
- "<LEGEND>Search Parameters</LEGEND>\n"
- "<INPUT TYPE=\"submit\" NAME=\"op\""
- " VALUE=\"Whatis\"> or \n"
- "<INPUT TYPE=\"submit\" NAME=\"op\""
- " VALUE=\"apropos\"> for manuals satisfying \n"
- "<INPUT TYPE=\"text\" NAME=\"expr\" VALUE=\"");
- html_print(q.expr ? q.expr : "");
- printf("\">, section "
- "<INPUT TYPE=\"text\""
- " SIZE=\"4\" NAME=\"sec\" VALUE=\"");
- html_print(q.sec ? q.sec : "");
- printf("\">, arch "
- "<INPUT TYPE=\"text\""
- " SIZE=\"8\" NAME=\"arch\" VALUE=\"");
- html_print(q.arch ? q.arch : "");
- puts("\">.\n"
- "<INPUT TYPE=\"reset\" VALUE=\"Reset\">\n"
+ printf("<DIV ID=\"mancgi\">\n"
+ "<FORM ACTION=\"%s\" METHOD=\"get\">\n"
+ "<FIELDSET>\n"
+ "<LEGEND>Manual Page Search Parameters</LEGEND>\n",
+ scriptname);
+
+ /* Write query input box. */
+
+ printf( "<TABLE><TR><TD>\n"
+ "<INPUT TYPE=\"text\" NAME=\"query\" VALUE=\"");
+ if (NULL != req->q.query)
+ html_print(req->q.query);
+ puts("\" SIZE=\"40\">");
+
+ /* Write submission and reset buttons. */
+
+ printf( "<INPUT TYPE=\"submit\" VALUE=\"Submit\">\n"
+ "<INPUT TYPE=\"reset\" VALUE=\"Reset\">\n");
+
+ /* Write show radio button */
+
+ printf( "</TD><TD>\n"
+ "<INPUT TYPE=\"radio\" ");
+ if (req->q.equal)
+ printf("CHECKED=\"checked\" ");
+ printf( "NAME=\"apropos\" ID=\"show\" VALUE=\"0\">\n"
+ "<LABEL FOR=\"show\">Show named manual page</LABEL>\n");
+
+ /* Write section selector. */
+
+ puts( "</TD></TR><TR><TD>\n"
+ "<SELECT NAME=\"sec\">");
+ for (i = 0; i < sec_MAX; i++) {
+ printf("<OPTION VALUE=\"%s\"", sec_numbers[i]);
+ if (NULL != req->q.sec &&
+ 0 == strcmp(sec_numbers[i], req->q.sec))
+ printf(" SELECTED=\"selected\"");
+ printf(">%s</OPTION>\n", sec_names[i]);
+ }
+ puts("</SELECT>");
+
+ /* Write architecture selector. */
+
+ printf( "<SELECT NAME=\"arch\">\n"
+ "<OPTION VALUE=\"default\"");
+ if (NULL == req->q.arch)
+ printf(" SELECTED=\"selected\"");
+ puts(">All Architectures</OPTION>");
+ for (i = 0; i < arch_MAX; i++) {
+ printf("<OPTION VALUE=\"%s\"", arch_names[i]);
+ if (NULL != req->q.arch &&
+ 0 == strcmp(arch_names[i], req->q.arch))
+ printf(" SELECTED=\"selected\"");
+ printf(">%s</OPTION>\n", arch_names[i]);
+ }
+ puts("</SELECT>");
+
+ /* Write manpath selector. */
+
+ if (req->psz > 1) {
+ puts("<SELECT NAME=\"manpath\">");
+ for (i = 0; i < (int)req->psz; i++) {
+ printf("<OPTION ");
+ if (NULL == req->q.manpath ? 0 == i :
+ 0 == strcmp(req->q.manpath, req->p[i]))
+ printf("SELECTED=\"selected\" ");
+ printf("VALUE=\"");
+ html_print(req->p[i]);
+ printf("\">");
+ html_print(req->p[i]);
+ puts("</OPTION>");
+ }
+ puts("</SELECT>");
+ }
+
+ /* Write search radio button */
+
+ printf( "</TD><TD>\n"
+ "<INPUT TYPE=\"radio\" ");
+ if (0 == req->q.equal)
+ printf("CHECKED=\"checked\" ");
+ printf( "NAME=\"apropos\" ID=\"search\" VALUE=\"1\">\n"
+ "<LABEL FOR=\"search\">Search with apropos query</LABEL>\n");
+
+ puts("</TD></TR></TABLE>\n"
"</FIELDSET>\n"
- "</FORM>");
+ "</FORM>\n"
+ "</DIV>");
puts("<!-- End search form. //-->");
}
-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("<H1>Malformed Query</H1>\n"
- "<P>\n"
- "The query your entered was malformed.\n"
- "Try again from the\n"
- "<A HREF=\"%s/index.html\">main page</A>.\n"
- "</P>", 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("<H1>Page Not Found</H1>\n"
- "<P>\n"
- "The page you're looking for, ");
- printf("<B>");
- html_print(page);
- printf("</B>,\n"
- "could not be found.\n"
- "Try searching from the\n"
- "<A HREF=\"%s/index.html\">main page</A>.\n"
- "</P>", progname);
+ resp_begin_html(200, NULL);
+ resp_searchform(req);
+ printf("<P>\n"
+ "This web interface is documented in the\n"
+ "<A HREF=\"%s/mandoc/man8/man.cgi.8\">man.cgi</A>\n"
+ "manual, and the\n"
+ "<A HREF=\"%s/mandoc/man1/apropos.1\">apropos</A>\n"
+ "manual explains the query syntax.\n"
+ "</P>\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("<P>Generic badness happened.</P>");
+ resp_begin_html(200, NULL);
+ resp_searchform(req);
+ puts("<P>");
+ puts(msg);
+ puts("</P>");
resp_end_html();
}
static void
-resp_baddb(void)
+pg_error_badrequest(const char *msg)
{
+ resp_begin_html(400, "Bad Request");
+ puts("<H1>Bad Request</H1>\n"
+ "<P>\n");
+ puts(msg);
+ printf("Try again from the\n"
+ "<A HREF=\"%s\">main page</A>.\n"
+ "</P>", scriptname);
+ resp_end_html();
+}
+
+static void
+pg_error_internal(void)
+{
resp_begin_html(500, "Internal Server Error");
- puts("<P>Your database is broken.</P>");
+ puts("<P>Internal Server Error</P>");
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;
- struct query q;
- const struct req *req;
+ 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);
-
- req = (const struct req *)arg;
resp_searchform(req);
- kval_query(&q, req->fields, req->fieldsz);
-
- if (0 == sz) {
- printf("<P>\n"
- "No %s results found.",
- q.whatis ? "whatis" : "apropos");
- if (q.whatis) {
- printf("(Try <A HREF=\"");
- html_print(progname);
- printf("/search.html?op=apropos&expr=");
- html_print(q.expr ? q.expr : "");
- printf("&sec=");
- html_print(q.sec ? q.sec : "");
- printf("&arch=");
- html_print(q.arch ? q.arch : "");
- puts("\">apropos</A>?)");
- }
- puts("</P>");
- resp_end_html();
- return;
- }
+ puts("<DIV CLASS=\"results\">");
+ puts("<TABLE>");
- puts("<P></P>\n"
- "<TABLE>");
-
- for (i = 0; i < (int)sz; i++) {
+ for (i = 0; i < sz; i++) {
printf("<TR>\n"
"<TD CLASS=\"title\">\n"
- "<A HREF=\"");
- html_print(progname);
- printf("/show/%u/%u.html\">", 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);
- }
- printf(")</A>\n"
+ "<A HREF=\"%s/%s/%s?",
+ scriptname, req->q.manpath, r[i].file);
+ http_printquery(req, "&");
+ printf("\">");
+ html_print(r[i].names);
+ printf("</A>\n"
"</TD>\n"
"<TD CLASS=\"desc\">");
- html_print(r[i].desc);
+ html_print(r[i].output);
puts("</TD>\n"
"</TR>");
}
- puts("</TABLE>");
- resp_end_html();
-}
+ puts("</TABLE>\n"
+ "</DIV>");
-/* ARGSUSED */
-static void
-pg_index(const struct manpaths *ps, const struct req *req, char *path)
-{
+ /*
+ * In man(1) mode, show one of the pages
+ * even if more than one is found.
+ */
+
+ if (req->q.equal) {
+ puts("<HR>");
+ 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;
+ }
+ resp_show(req, r[iuse].file);
+ }
- resp_index(req);
+ resp_end_html();
}
static void
-catman(const char *file)
+catman(const struct req *req, const char *file)
{
FILE *f;
size_t len;
int italic, bold;
if (NULL == (f = fopen(file, "r"))) {
- resp_baddb();
+ puts("<P>You specified an invalid manual file.</P>");
return;
}
- resp_begin_http(200, NULL);
- puts("<!DOCTYPE HTML PUBLIC "
- " \"-//W3C//DTD HTML 4.01//EN\""
- " \"http://www.w3.org/TR/html4/strict.dtd\">\n"
- "<HTML>\n"
- "<HEAD>\n"
- "<META HTTP-EQUIV=\"Content-Type\""
- " CONTENT=\"text/html; charset=utf-8\">\n"
- "<LINK REL=\"stylesheet\" HREF=\"/catman.css\""
- " TYPE=\"text/css\" media=\"all\">\n"
- "<TITLE>System Manpage Reference</TITLE>\n"
- "</HEAD>\n"
- "<BODY>\n"
- "<!-- Begin page content. //-->\n"
+ puts("<DIV CLASS=\"catman\">\n"
"<PRE>");
while (NULL != (p = fgetln(f, &len))) {
}
puts("</PRE>\n"
- "</BODY>\n"
- "</HTML>");
+ "</DIV>");
fclose(f);
}
static void
-format(const char *file)
+format(const struct req *req, const char *file)
{
struct mparse *mp;
- int fd;
struct mdoc *mdoc;
struct man *man;
void *vp;
+ char *opts;
enum mandoclevel rc;
- char opts[MAXPATHLEN + 128];
+ int fd;
+ int usepath;
if (-1 == (fd = open(file, O_RDONLY, 0))) {
- resp_baddb();
+ puts("<P>You specified an invalid manual file.</P>");
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);
+ usepath = strcmp(req->q.manpath, req->p[0]);
+ mandoc_asprintf(&opts,
+ "fragment,man=%s?query=%%N&sec=%%S%s%s%s%s",
+ scriptname,
+ req->q.arch ? "&arch=" : "",
+ req->q.arch ? req->q.arch : "",
+ usepath ? "&manpath=" : "",
+ usepath ? req->q.manpath : "");
+
+ 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;
+ }
- mparse_result(mp, &mdoc, &man);
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);
+ free(opts);
}
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();
- return;
- } else if (NULL == (sub = strrchr(path, '/'))) {
- resp_error400();
- return;
- } else
- *sub++ = '\0';
- if ( ! (atou(path, &vol) && atou(sub, &rec))) {
- 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 (vol >= (unsigned int)ps->sz) {
- resp_error400();
+ }
+ manpath = mandoc_strndup(fullpath, file - fullpath);
+ file++;
+
+ if ( ! validate_manpath(req, manpath)) {
+ pg_error_badrequest(
+ "You specified an invalid manpath.");
+ free(manpath);
return;
}
- strlcpy(file, ps->paths[vol], MAXPATHLEN);
- strlcat(file, "/mandoc.index", MAXPATHLEN);
-
- /* Open the index recno(3) database. */
+ /*
+ * Begin by chdir()ing into the manpath.
+ * This way we can pick up the database files, which are
+ * relative to the manpath root.
+ */
- 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;
- }
+ if ( ! validate_filename(file)) {
+ pg_error_badrequest(
+ "You specified an invalid manual file.");
+ return;
+ }
- 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);
- strlcat(file, "/", MAXPATHLEN);
- strlcat(file, fn, MAXPATHLEN);
- if (0 == strcmp(cp, "cat"))
- catman(file);
- else
- format(file);
- }
-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;
- const char *ep, *start;
- char **cp;
- struct opts opt;
- struct expr *expr;
- struct query q;
-
- kval_query(&q, req->fields, req->fieldsz);
- memset(&opt, 0, sizeof(struct opts));
-
- ep = q.expr;
- opt.arch = q.arch;
- opt.cat = q.sec;
- rc = -1;
- sz = 0;
- cp = NULL;
+ struct mansearch search;
+ struct manpaths paths;
+ struct manpage *res;
+ char **argv;
+ char *query, *rp, *wp;
+ size_t ressz;
+ int argc;
/*
- * Poor man's tokenisation.
- * Just break apart by spaces.
- * Yes, this is half-ass. But it works for now.
+ * 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.
*/
- 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++;
+ if (-1 == (chdir(req->q.manpath))) {
+ fprintf(stderr, "chdir %s: %s\n",
+ req->q.manpath, strerror(errno));
+ pg_error_internal();
+ return;
}
- /*
- * Pump down into apropos backend.
- * The resp_search() function is called with the results.
- */
-
- expr = q.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);
+ search.arch = req->q.arch;
+ search.sec = req->q.sec;
+ search.outkey = "Nd";
+ search.argmode = req->q.equal ? ARG_NAME : ARG_EXPR;
- /* ...unless errors occured. */
+ paths.sz = 1;
+ paths.paths = mandoc_malloc(sizeof(char *));
+ paths.paths[0] = mandoc_strdup(".");
- if (0 == rc)
- resp_baddb();
- else if (-1 == rc)
- resp_search(NULL, 0, (void *)req);
+ /*
+ * Break apart at spaces with backslash-escaping.
+ */
- for (i = 0; i < sz; i++)
- free(cp[i]);
+ argc = 0;
+ argv = NULL;
+ rp = query = mandoc_strdup(req->q.query);
+ for (;;) {
+ while (isspace((unsigned char)*rp))
+ rp++;
+ if (*rp == '\0')
+ break;
+ argv = mandoc_reallocarray(argv, argc + 1, sizeof(char *));
+ argv[argc++] = wp = rp;
+ for (;;) {
+ if (isspace((unsigned char)*rp)) {
+ *wp = '\0';
+ rp++;
+ break;
+ }
+ if (rp[0] == '\\' && rp[1] != '\0')
+ rp++;
+ if (wp != rp)
+ *wp = *rp;
+ if (*rp == '\0')
+ break;
+ wp++;
+ rp++;
+ }
+ }
- free(cp);
- exprfree(expr);
+ if (0 == mansearch(&search, &paths, argc, argv, &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);
+
+ free(query);
+ mansearch_free(res, ressz);
+ free(paths.paths[0]);
+ free(paths.paths);
}
int
main(void)
{
- int i;
struct req req;
- char *p, *path, *subpath;
- struct manpaths paths;
-
- /* HTTP init: read and parse the query string. */
-
- progname = getenv("SCRIPT_NAME");
- if (NULL == progname)
- progname = "";
+ struct itimerval itimer;
+ const char *path;
+ const char *querystring;
+ int i;
- cache = getenv("CACHE_DIR");
- if (NULL == cache)
- cache = "/cache/man.cgi";
+ /* Poor man's ReDoS mitigation. */
- if (-1 == chdir(cache)) {
- resp_bad();
+ itimer.it_value.tv_sec = 2;
+ itimer.it_value.tv_usec = 0;
+ itimer.it_interval.tv_sec = 2;
+ itimer.it_interval.tv_usec = 0;
+ if (setitimer(ITIMER_VIRTUAL, &itimer, NULL) == -1) {
+ fprintf(stderr, "setitimer: %s\n", strerror(errno));
+ pg_error_internal();
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);
+ /* Scan our run-time environment. */
- /* Resolve leading subpath component. */
+ if (NULL == (scriptname = getenv("SCRIPT_NAME")))
+ scriptname = "";
- 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;
-
- /* 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';
+ if ( ! validate_urifrag(scriptname)) {
+ fprintf(stderr, "unsafe SCRIPT_NAME \"%s\"\n",
+ scriptname);
+ pg_error_internal();
+ return(EXIT_FAILURE);
+ }
- /* Map path into one we recognise. */
+ /*
+ * First we change directory into the MAN_DIR so that
+ * subsequent scanning for manpath directories is rooted
+ * relative to the same position.
+ */
- 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;
- }
+ if (-1 == chdir(MAN_DIR)) {
+ fprintf(stderr, "MAN_DIR: %s: %s\n",
+ MAN_DIR, strerror(errno));
+ pg_error_internal();
+ return(EXIT_FAILURE);
+ }
- /* Initialise MANPATH. */
+ memset(&req, 0, sizeof(struct req));
+ pathgen(&req);
- memset(&paths, 0, sizeof(struct manpaths));
- manpath_manconf("etc/catman.conf", &paths);
+ /* Next parse out the query string. */
- /* Route pages. */
+ if (NULL != (querystring = getenv("QUERY_STRING")))
+ http_parse(&req, querystring);
- 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;
+ if ( ! (NULL == req.q.manpath ||
+ validate_manpath(&req, req.q.manpath))) {
+ pg_error_badrequest(
+ "You specified an invalid manpath.");
+ return(EXIT_FAILURE);
}
- manpath_free(&paths);
- kval_free(req.fields, req.fieldsz);
+ if ( ! (NULL == req.q.arch || validate_urifrag(req.q.arch))) {
+ pg_error_badrequest(
+ "You specified an invalid architecture.");
+ return(EXIT_FAILURE);
+ }
+ /* Dispatch to the three different pages. */
+
+ path = getenv("PATH_INFO");
+ if (NULL == path)
+ path = "";
+ else if ('/' == *path)
+ path++;
+
+ if ('\0' != *path)
+ pg_show(&req, path);
+ else if (NULL != req.q.query)
+ pg_search(&req);
+ else
+ pg_index(&req);
+
+ 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;
+
+ if (NULL == (fp = fopen("manpath.conf", "r"))) {
+ fprintf(stderr, "%s/manpath.conf: %s\n",
+ MAN_DIR, strerror(errno));
+ pg_error_internal();
+ exit(EXIT_FAILURE);
+ }
- return(strcasecmp(((const struct res *)p1)->title,
- ((const struct res *)p2)->title));
-}
+ 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);
+ }
+}
git.ckatri.com / mandoc.git / blobdiff