-/* $Id: cgi.c,v 1.79 2014/07/21 22:33:01 schwarze Exp $ */
+/* $Id: cgi.c,v 1.141 2016/09/12 00:06:20 schwarze Exp $ */
/*
* Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2014 Ingo Schwarze <schwarze@usta.de>
+ * Copyright (c) 2014, 2015, 2016 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
* copyright notice and this permission notice appear in all copies.
*
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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 <sys/types.h>
+#include <sys/time.h>
#include <ctype.h>
+#include <err.h>
#include <errno.h>
#include <fcntl.h>
#include <limits.h>
+#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
-#include "mandoc.h"
#include "mandoc_aux.h"
+#include "mandoc.h"
+#include "roff.h"
+#include "mdoc.h"
+#include "man.h"
#include "main.h"
-#include "manpath.h"
+#include "manconf.h"
#include "mansearch.h"
#include "cgi.h"
* A query as passed to the search function.
*/
struct query {
- const char *manpath; /* desired manual directory */
- const char *arch; /* architecture */
- const char *sec; /* manual section */
- const char *expr; /* unparsed expression string */
+ 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 query q;
char **p; /* array of available manpaths */
size_t psz; /* number of available manpaths */
+ int isquery; /* QUERY_STRING used, not PATH_INFO */
+};
+
+enum focus {
+ FOCUS_NONE = 0,
+ FOCUS_QUERY
};
-static void catman(const struct req *, const char *);
-static int cmp(const void *, const void *);
-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 req *, 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 int http_decode(char *);
+static void parse_manpath_conf(struct req *);
+static void parse_path_info(struct req *req, const char *path);
+static void parse_query_string(struct req *, const char *);
static void pg_error_badrequest(const char *);
static void pg_error_internal(void);
static void pg_index(const struct req *);
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_catman(const struct req *, const char *);
+static void resp_copy(const char *);
static void resp_end_html(void);
-static void resp_searchform(const struct req *);
+static void resp_format(const struct req *, const char *);
+static void resp_searchform(const struct req *, enum focus);
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 *scriptname; /* CGI script name */
+static const char *scriptname = SCRIPT_NAME;
static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
static const char *const sec_numbers[] = {
"All Sections",
"1 - General Commands",
"2 - System Calls",
- "3 - Subroutines",
- "3p - Perl Subroutines",
- "4 - Special Files",
+ "3 - Library Functions",
+ "3p - Perl Library",
+ "4 - Device Drivers",
"5 - File Formats",
"6 - Games",
- "7 - Macros and Conventions",
- "8 - Maintenance Commands",
- "9 - Kernel Interface"
+ "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"
+ "amd64", "alpha", "armv7",
+ "hppa", "i386", "landisk",
+ "loongson", "luna88k", "macppc", "mips64",
+ "octeon", "sgi", "socppc", "sparc64",
+ "amiga", "arc", "armish", "arm32",
+ "atari", "aviion", "beagle", "cats",
+ "hppa64", "hp300",
+ "ia64", "mac68k", "mvme68k", "mvme88k",
+ "mvmeppc", "palm", "pc532", "pegasos",
+ "pmax", "powerpc", "solbourne", "sparc",
+ "sun3", "vax", "wgrisc", "x68k",
+ "zaurus"
};
static const int arch_MAX = sizeof(arch_names) / sizeof(char *);
switch (c) {
case ('"'):
- printf(""e;");
+ printf(""");
break;
case ('&'):
printf("&");
}
}
+/*
+ * Call through to html_putchar().
+ * Accepts NULL strings.
+ */
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.expr) {
- printf("&query=");
- http_print(req->q.expr);
- }
- 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.expr) {
- printf("&query=");
- html_print(req->q.expr);
- }
- if (0 == req->q.equal)
- printf("&apropos=1");
-}
-
-static void
-http_print(const char *p)
+html_print(const char *p)
{
if (NULL == p)
return;
while ('\0' != *p)
- http_putchar(*p++);
+ html_putchar(*p++);
}
/*
- * Call through to html_putchar().
- * Accepts NULL strings.
+ * Transfer the responsibility for the allocated string *val
+ * to the query structure.
*/
static void
-html_print(const char *p)
+set_query_attr(char **attr, char **val)
{
-
- if (NULL == p)
- return;
- while ('\0' != *p)
- html_putchar(*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
-http_parse(struct req *req, char *p)
+parse_query_string(struct req *req, const char *qs)
{
- char *key, *val;
+ char *key, *val;
+ size_t keysz, valsz;
- memset(&req->q, 0, sizeof(struct query));
- req->q.manpath = req->p[0];
- req->q.equal = 1;
+ req->isquery = 1;
+ req->q.manpath = NULL;
+ req->q.arch = NULL;
+ req->q.sec = NULL;
+ req->q.query = NULL;
+ req->q.equal = 1;
- while ('\0' != *p) {
- key = p;
- val = NULL;
+ key = val = NULL;
+ while (*qs != '\0') {
- p += (int)strcspn(p, ";&");
- if ('\0' != *p)
- *p++ = '\0';
- if (NULL != (val = strchr(key, '=')))
- *val++ = '\0';
+ /* Parse one key. */
- if ('\0' == *key || NULL == val || '\0' == *val)
- continue;
+ keysz = strcspn(qs, "=;&");
+ key = mandoc_strndup(qs, keysz);
+ qs += keysz;
+ if (*qs != '=')
+ goto next;
- /* Just abort handling. */
+ /* Parse one value. */
- if ( ! http_decode(key))
- break;
- if (NULL != val && ! http_decode(val))
- break;
+ valsz = strcspn(++qs, ";&");
+ val = mandoc_strndup(qs, valsz);
+ qs += valsz;
- if (0 == strcmp(key, "query"))
- req->q.expr = val;
- else if (0 == strcmp(key, "manpath")) {
+ /* Decode and catch encoding errors. */
+
+ if ( ! (http_decode(key) && http_decode(val)))
+ goto next;
+
+ /* Handle key-value pairs. */
+
+ if ( ! strcmp(key, "query"))
+ set_query_attr(&req->q.query, &val);
+
+ else if ( ! strcmp(key, "apropos"))
+ req->q.equal = !strcmp(val, "0");
+
+ else if ( ! strcmp(key, "manpath")) {
#ifdef COMPAT_OLDURI
- if (0 == strncmp(val, "OpenBSD ", 8)) {
+ if ( ! strncmp(val, "OpenBSD ", 8)) {
val[7] = '-';
if ('C' == val[8])
val[8] = 'c';
}
#endif
- req->q.manpath = val;
- } else if (0 == strcmp(key, "apropos"))
- req->q.equal = !strcmp(val, "0");
- else if (0 == strcmp(key, "sec")) {
- if (strcmp(val, "0"))
- req->q.sec = val;
+ set_query_attr(&req->q.manpath, &val);
+ }
+
+ else if ( ! (strcmp(key, "sec")
#ifdef COMPAT_OLDURI
- } else if (0 == strcmp(key, "sektion")) {
- if (strcmp(val, "0"))
- req->q.sec = val;
+ && strcmp(key, "sektion")
#endif
- } else if (0 == strcmp(key, "arch")) {
- if (strcmp(val, "default"))
- req->q.arch = val;
+ )) {
+ if ( ! strcmp(val, "0"))
+ *val = '\0';
+ set_query_attr(&req->q.sec, &val);
}
- }
-}
-static void
-http_putchar(char c)
-{
+ else if ( ! strcmp(key, "arch")) {
+ if ( ! strcmp(val, "default"))
+ *val = '\0';
+ set_query_attr(&req->q.arch, &val);
+ }
- if (isalnum((unsigned char)c)) {
- putchar((unsigned char)c);
- return;
- } else if (' ' == c) {
- putchar('+');
- return;
+ /*
+ * 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++;
}
- printf("%%%.2x", c);
}
/*
for ( ; '\0' != *p; p++, q++) {
if ('%' == *p) {
if ('\0' == (hex[0] = *(p + 1)))
- return(0);
+ return 0;
if ('\0' == (hex[1] = *(p + 2)))
- return(0);
+ return 0;
if (1 != sscanf(hex, "%x", &c))
- return(0);
+ return 0;
if ('\0' == c)
- return(0);
+ return 0;
*q = (char)c;
p += 2;
}
*q = '\0';
- return(1);
+ return 1;
}
static void
fflush(stdout);
}
+static void
+resp_copy(const char *filename)
+{
+ char buf[4096];
+ ssize_t sz;
+ int fd;
+
+ if ((fd = open(filename, O_RDONLY)) != -1) {
+ fflush(stdout);
+ while ((sz = read(fd, buf, sizeof(buf))) > 0)
+ write(STDOUT_FILENO, buf, sz);
+ close(fd);
+ }
+}
+
static void
resp_begin_html(int code, const char *msg)
{
resp_begin_http(code, msg);
- printf("<!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=\"%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"
+ printf("<!DOCTYPE html>\n"
+ "<html>\n"
+ "<head>\n"
+ "<meta charset=\"UTF-8\"/>\n"
+ "<link rel=\"stylesheet\" href=\"%s/mandoc.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);
+ CSS_DIR, CUSTOMIZE_TITLE);
+
+ resp_copy(MAN_DIR "/header.html");
}
static void
resp_end_html(void)
{
- puts("</BODY>\n"
- "</HTML>");
+ resp_copy(MAN_DIR "/footer.html");
+
+ puts("</body>\n"
+ "</html>");
}
static void
-resp_searchform(const struct req *req)
+resp_searchform(const struct req *req, enum focus focus)
{
int i;
- puts(CUSTOMIZE_BEGIN);
puts("<!-- Begin search form. //-->");
- printf("<DIV ID=\"mancgi\">\n"
- "<FORM ACTION=\"%s\" METHOD=\"get\">\n"
- "<FIELDSET>\n"
- "<LEGEND>Manual Page Search Parameters</LEGEND>\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.expr)
- html_print(req->q.expr);
- puts("\" SIZE=\"40\">");
-
- /* Write submission and reset buttons. */
+ printf("<input type=\"text\" name=\"query\" value=\"");
+ if (req->q.query != NULL)
+ html_print(req->q.query);
+ printf( "\" size=\"40\"");
+ if (focus == FOCUS_QUERY)
+ printf(" autofocus");
+ puts(">");
- printf( "<INPUT TYPE=\"submit\" VALUE=\"Submit\">\n"
- "<INPUT TYPE=\"reset\" VALUE=\"Reset\">\n");
+ /* Write submission buttons. */
- /* Write show radio button */
-
- printf( "</TD><TD>\n"
- "<INPUT TYPE=\"radio\" ");
- if (req->q.equal)
- printf("CHECKED ");
- printf( "NAME=\"apropos\" ID=\"show\" VALUE=\"0\">\n"
- "<LABEL FOR=\"show\">Show named manual page</LABEL>\n");
+ printf( "<button type=\"submit\" name=\"apropos\" value=\"0\">"
+ "man</button>\n"
+ "<button type=\"submit\" name=\"apropos\" value=\"1\">"
+ "apropos</button>\n<br/>\n");
/* Write section selector. */
- printf( "</TD></TR><TR><TD>\n"
- "<SELECT NAME=\"sec\">");
+ puts("<select name=\"sec\">");
for (i = 0; i < sec_MAX; i++) {
- printf("<OPTION VALUE=\"%s\"", sec_numbers[i]);
+ printf("<option value=\"%s\"", sec_numbers[i]);
if (NULL != req->q.sec &&
0 == strcmp(sec_numbers[i], req->q.sec))
- printf(" SELECTED");
- printf(">%s</OPTION>\n", sec_names[i]);
+ printf(" selected=\"selected\"");
+ printf(">%s</option>\n", sec_names[i]);
}
- puts("</SELECT>");
+ puts("</select>");
/* Write architecture selector. */
- puts("<SELECT NAME=\"arch\">");
+ 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]);
+ printf("<option value=\"%s\"", arch_names[i]);
if (NULL != req->q.arch &&
0 == strcmp(arch_names[i], req->q.arch))
- printf(" SELECTED");
- printf(">%s</OPTION>\n", arch_names[i]);
+ printf(" selected=\"selected\"");
+ printf(">%s</option>\n", arch_names[i]);
}
- puts("</SELECT>");
+ puts("</select>");
/* Write manpath selector. */
if (req->psz > 1) {
- puts("<SELECT NAME=\"manpath\">");
+ 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 ");
- printf("VALUE=\"");
+ printf("<option ");
+ if (strcmp(req->q.manpath, req->p[i]) == 0)
+ printf("selected=\"selected\" ");
+ printf("value=\"");
html_print(req->p[i]);
printf("\">");
html_print(req->p[i]);
- puts("</OPTION>");
+ puts("</option>");
}
- puts("</SELECT>");
+ puts("</select>");
}
- /* Write search radio button */
+ puts("</fieldset>\n"
+ "</form>\n"
+ "</div>");
+ puts("<!-- End search form. //-->");
+}
- printf( "</TD><TD>\n"
- "<INPUT TYPE=\"radio\" ");
- if (0 == req->q.equal)
- printf("CHECKED ");
- printf( "NAME=\"apropos\" ID=\"search\" VALUE=\"1\">\n"
- "<LABEL FOR=\"search\">Search with apropos query</LABEL>\n");
+static int
+validate_urifrag(const char *frag)
+{
- puts("</TD></TR></TABLE>\n"
- "</FIELDSET>\n"
- "</FORM>\n"
- "</DIV>");
- puts("<!-- End search form. //-->");
+ while ('\0' != *frag) {
+ if ( ! (isalnum((unsigned char)*frag) ||
+ '-' == *frag || '.' == *frag ||
+ '/' == *frag || '_' == *frag))
+ return 0;
+ frag++;
+ }
+ return 1;
}
static int
{
size_t i;
- if ( ! strcmp(manpath, "mandoc"))
- return(1);
-
for (i = 0; i < req->psz; i++)
if ( ! strcmp(manpath, req->p[i]))
- return(1);
+ return 1;
- return(0);
+ return 0;
}
static int
if ('.' == file[0] && '/' == file[1])
file += 2;
- return ( ! (strstr(file, "../") || strstr(file, "/..") ||
- (strncmp(file, "man", 3) && strncmp(file, "cat", 3))));
+ return ! (strstr(file, "../") || strstr(file, "/..") ||
+ (strncmp(file, "man", 3) && strncmp(file, "cat", 3)));
}
static void
{
resp_begin_html(200, NULL);
- resp_searchform(req);
- printf("<P>\n"
- "This web interface is documented in the "
- "<A HREF=\"%s/mandoc/man8/man.cgi.8\">man.cgi</A> "
- "manual, and the "
- "<A HREF=\"%s/mandoc/man1/apropos.1\">apropos</A> "
+ resp_searchform(req, FOCUS_QUERY);
+ printf("<p>\n"
+ "This web interface is documented in the\n"
+ "<a href=\"/%s%sman.cgi.8\">man.cgi(8)</a>\n"
+ "manual, and the\n"
+ "<a href=\"/%s%sapropos.1\">apropos(1)</a>\n"
"manual explains the query syntax.\n"
- "</P>\n",
- scriptname, scriptname);
+ "</p>\n",
+ scriptname, *scriptname == '\0' ? "" : "/",
+ scriptname, *scriptname == '\0' ? "" : "/");
resp_end_html();
}
pg_noresult(const struct req *req, const char *msg)
{
resp_begin_html(200, NULL);
- resp_searchform(req);
- puts("<P>");
+ resp_searchform(req, FOCUS_QUERY);
+ puts("<p>");
puts(msg);
- puts("</P>");
+ puts("</p>");
resp_end_html();
}
{
resp_begin_html(400, "Bad Request");
- puts("<H1>Bad Request</H1>\n"
- "<P>\n");
+ 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);
+ "<a href=\"/%s\">main page</a>.\n"
+ "</p>", scriptname);
resp_end_html();
}
pg_error_internal(void)
{
resp_begin_html(500, "Internal Server Error");
- puts("<P>Internal Server Error</P>");
+ puts("<p>Internal Server Error</p>");
resp_end_html();
}
static void
pg_searchres(const struct req *req, struct manpage *r, size_t sz)
{
- size_t i, iuse, isec;
+ char *arch, *archend;
+ const char *sec;
+ size_t i, iuse;
+ 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",
+ warnx("invalid filename %s in %s database",
r[i].file, req->q.manpath);
pg_error_internal();
return;
}
- if (1 == sz) {
+ if (req->isquery && sz == 1) {
/*
* If we have just one result, then jump there now
* without any delay.
*/
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("Location: http://%s/%s%s%s/%s",
+ HTTP_HOST, scriptname,
+ *scriptname == '\0' ? "" : "/",
+ req->q.manpath, r[0].file);
printf("\r\n"
"Content-Type: text/html; charset=utf-8\r\n"
"\r\n");
return;
}
- qsort(r, sz, sizeof(struct manpage), cmp);
-
resp_begin_html(200, NULL);
- resp_searchform(req);
- puts("<DIV CLASS=\"results\">");
- puts("<TABLE>");
+ resp_searchform(req,
+ req->q.equal || sz == 1 ? FOCUS_NONE : FOCUS_QUERY);
- for (i = 0; i < sz; i++) {
- printf("<TR>\n"
- "<TD CLASS=\"title\">\n"
- "<A HREF=\"%s/%s/%s?",
- scriptname, req->q.manpath, r[i].file);
- html_printquery(req);
- printf("\">");
- html_print(r[i].names);
- printf("</A>\n"
- "</TD>\n"
- "<TD CLASS=\"desc\">");
- html_print(r[i].output);
- puts("</TD>\n"
- "</TR>");
- }
+ if (sz > 1) {
+ puts("<div class=\"results\">");
+ puts("<table>");
- puts("</TABLE>\n"
- "</DIV>");
+ for (i = 0; i < sz; i++) {
+ printf("<tr>\n"
+ "<td class=\"title\">\n"
+ "<a href=\"/%s%s%s/%s",
+ scriptname, *scriptname == '\0' ? "" : "/",
+ req->q.manpath, r[i].file);
+ printf("\">");
+ html_print(r[i].names);
+ printf("</a>\n"
+ "</td>\n"
+ "<td class=\"desc\">");
+ html_print(r[i].output);
+ puts("</td>\n"
+ "</tr>");
+ }
+
+ puts("</table>\n"
+ "</div>");
+ }
/*
* In man(1) mode, show one of the pages
* even if more than one is found.
*/
- if (req->q.equal) {
- puts("<HR>");
+ if (req->q.equal || sz == 1) {
+ puts("<hr>");
iuse = 0;
- priouse = 10;
+ priouse = 20;
+ archpriouse = 3;
for (i = 0; i < sz; i++) {
- isec = strcspn(r[i].file, "123456789");
- sec = r[i].file[isec];
- if ('\0' == sec)
+ sec = r[i].file;
+ sec += strcspn(sec, "123456789");
+ if (sec[0] == '\0')
continue;
- prio = sec_prios[sec - '1'];
+ prio = sec_prios[sec[0] - '1'];
+ if (sec[1] != '/')
+ prio += 10;
+ if (req->q.arch == NULL) {
+ archprio =
+ ((arch = strchr(sec + 1, '/'))
+ == NULL) ? 3 :
+ ((archend = strchr(arch + 1, '/'))
+ == NULL) ? 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;
}
static void
-catman(const struct req *req, const char *file)
+resp_catman(const struct req *req, const char *file)
{
FILE *f;
- size_t len;
- int i;
char *p;
+ size_t sz;
+ ssize_t len;
+ int i;
int italic, bold;
- if (NULL == (f = fopen(file, "r"))) {
- puts("<P>You specified an invalid manual file.</P>");
+ if ((f = fopen(file, "r")) == NULL) {
+ puts("<p>You specified an invalid manual file.</p>");
return;
}
- puts("<DIV CLASS=\"catman\">\n"
- "<PRE>");
+ puts("<div class=\"catman\">\n"
+ "<pre>");
- while (NULL != (p = fgetln(f, &len))) {
+ p = NULL;
+ sz = 0;
+
+ while ((len = getline(&p, &sz, f)) != -1) {
bold = italic = 0;
- for (i = 0; i < (int)len - 1; i++) {
- /*
+ for (i = 0; i < 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 + 1]) {
if (italic)
- printf("</I>");
+ printf("</i>");
if (bold)
- printf("</B>");
+ printf("</b>");
italic = bold = 0;
html_putchar(p[i]);
continue;
- } else if (i + 2 >= (int)len)
+ } else if (i + 2 >= len)
continue;
/* Italic mode. */
if ('_' == p[i]) {
if (bold)
- printf("</B>");
+ printf("</b>");
if ( ! italic)
- printf("<I>");
+ printf("<i>");
bold = 0;
italic = 1;
i += 2;
continue;
}
- /*
+ /*
* Handle funny behaviour troff-isms.
* These grok'd from the original man2html.c.
*/
('*' == p[i] && '|' == p[i + 2]) ||
('|' == p[i] && '*' == p[i + 2])) {
if (italic)
- printf("</I>");
+ printf("</i>");
if (bold)
- printf("</B>");
+ printf("</b>");
italic = bold = 0;
putchar('*');
i += 2;
('+' == p[i] && '|' == p[i + 1]) ||
('|' == p[i] && '+' == p[i + 1])) {
if (italic)
- printf("</I>");
+ printf("</i>");
if (bold)
- printf("</B>");
+ printf("</b>");
italic = bold = 0;
putchar('+');
i += 2;
}
/* Bold mode. */
-
+
if (italic)
- printf("</I>");
+ printf("</i>");
if ( ! bold)
- printf("<B>");
+ printf("<b>");
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.
+ * We can get to a newline; don't print that.
*/
if (italic)
- printf("</I>");
+ printf("</i>");
if (bold)
- printf("</B>");
+ printf("</b>");
- if (i == (int)len - 1 && '\n' != p[i])
+ if (i == len - 1 && p[i] != '\n')
html_putchar(p[i]);
putchar('\n');
}
+ free(p);
- puts("</PRE>\n"
- "</DIV>");
+ puts("</pre>\n"
+ "</div>");
fclose(f);
}
static void
-format(const struct req *req, const char *file)
+resp_format(const struct req *req, const char *file)
{
+ struct manoutput conf;
struct mparse *mp;
- int fd;
- struct mdoc *mdoc;
- struct man *man;
+ struct roff_man *man;
void *vp;
- enum mandoclevel rc;
- char opts[PATH_MAX + 128];
+ int fd;
+ int usepath;
if (-1 == (fd = open(file, O_RDONLY, 0))) {
- puts("<P>You specified an invalid manual file.</P>");
+ puts("<p>You specified an invalid manual file.</p>");
return;
}
- mp = mparse_alloc(MPARSE_SO, MANDOCLEVEL_FATAL, NULL,
- req->q.manpath);
- rc = mparse_readfd(mp, fd, file);
+ mchars_alloc();
+ mp = mparse_alloc(MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1,
+ MANDOCLEVEL_BADARG, NULL, req->q.manpath);
+ mparse_readfd(mp, fd, file);
close(fd);
- if (rc >= MANDOCLEVEL_FATAL) {
- fprintf(stderr, "fatal mandoc error: %s/%s\n",
- req->q.manpath, file);
- pg_error_internal();
- return;
- }
-
- 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 : "");
+ memset(&conf, 0, sizeof(conf));
+ conf.fragment = 1;
+ usepath = strcmp(req->q.manpath, req->p[0]);
+ mandoc_asprintf(&conf.man, "/%s%s%%N.%%S",
+ usepath ? req->q.manpath : "", usepath ? "/" : "");
- mparse_result(mp, &mdoc, &man, NULL);
- if (NULL == man && NULL == mdoc) {
- fprintf(stderr, "fatal mandoc error: %s/%s\n",
- req->q.manpath, file);
+ mparse_result(mp, &man, NULL);
+ if (man == NULL) {
+ warnx("fatal mandoc error: %s/%s", req->q.manpath, file);
pg_error_internal();
mparse_free(mp);
+ mchars_free();
return;
}
- vp = html_alloc(opts);
+ vp = html_alloc(&conf);
- if (NULL != mdoc)
- html_mdoc(vp, mdoc);
- else
+ if (man->macroset == MACROSET_MDOC) {
+ mdoc_validate(man);
+ html_mdoc(vp, man);
+ } else {
+ man_validate(man);
html_man(vp, man);
+ }
html_free(vp);
mparse_free(mp);
+ mchars_free();
+ free(conf.man);
}
static void
file += 2;
if ('c' == *file)
- catman(req, file);
+ resp_catman(req, file);
else
- format(req, file);
+ resp_format(req, file);
}
static void
-pg_show(struct req *req, const char *path)
+pg_show(struct req *req, const char *fullpath)
{
- char *sub;
+ char *manpath;
+ const char *file;
- if (NULL == path || NULL == (sub = strchr(path, '/'))) {
+ if ((file = strchr(fullpath, '/')) == NULL) {
pg_error_badrequest(
"You did not specify a page to show.");
return;
- }
- *sub++ = '\0';
+ }
+ manpath = mandoc_strndup(fullpath, file - fullpath);
+ file++;
- if ( ! validate_manpath(req, path)) {
+ if ( ! validate_manpath(req, manpath)) {
pg_error_badrequest(
"You specified an invalid manpath.");
+ free(manpath);
return;
}
* relative to the manpath root.
*/
- if (-1 == chdir(path)) {
- fprintf(stderr, "chdir %s: %s\n",
- path, strerror(errno));
+ if (chdir(manpath) == -1) {
+ warn("chdir %s", manpath);
pg_error_internal();
+ free(manpath);
return;
}
+ free(manpath);
- if ( ! validate_filename(sub)) {
+ if ( ! validate_filename(file)) {
pg_error_badrequest(
"You specified an invalid manual file.");
return;
}
- if (strcmp(path, "mandoc"))
- req->q.manpath = path;
-
resp_begin_html(200, NULL);
- resp_searchform(req);
- resp_show(req, sub);
+ resp_searchform(req, FOCUS_NONE);
+ resp_show(req, file);
resp_end_html();
}
struct mansearch search;
struct manpaths paths;
struct manpage *res;
- char **cp;
- const char *ep, *start;
+ char **argv;
+ char *query, *rp, *wp;
size_t ressz;
- int i, sz;
+ int argc;
/*
* Begin by chdir()ing into the root of the manpath.
* relative to the manpath root.
*/
- if (-1 == (chdir(req->q.manpath))) {
- fprintf(stderr, "chdir %s: %s\n",
- req->q.manpath, strerror(errno));
+ if (chdir(req->q.manpath) == -1) {
+ warn("chdir %s", req->q.manpath);
pg_error_internal();
return;
}
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;
+ search.outkey = "Nd";
+ search.argmode = req->q.equal ? ARG_NAME : ARG_EXPR;
+ search.firstmatch = 1;
paths.sz = 1;
paths.paths = mandoc_malloc(sizeof(char *));
paths.paths[0] = mandoc_strdup(".");
/*
- * Poor man's tokenisation: just break apart by spaces.
- * Yes, this is half-ass. But it works for now.
+ * Break apart at spaces with backslash-escaping.
*/
- ep = req->q.expr;
- while (ep && isspace((unsigned char)*ep))
- ep++;
-
- sz = 0;
- cp = NULL;
- while (ep && '\0' != *ep) {
- cp = mandoc_reallocarray(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++;
+ 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++;
+ }
}
- if (0 == mansearch(&search, &paths, sz, cp, "Nd", &res, &ressz))
+ 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);
- for (i = 0; i < sz; i++)
- free(cp[i]);
- free(cp);
-
- for (i = 0; i < (int)ressz; i++) {
- free(res[i].file);
- free(res[i].names);
- free(res[i].output);
- }
- free(res);
-
+ free(query);
+ mansearch_free(res, ressz);
free(paths.paths[0]);
free(paths.paths);
}
main(void)
{
struct req req;
+ struct itimerval itimer;
const char *path;
- char *querystring;
+ const char *querystring;
int i;
- /* Scan our run-time environment. */
+ /* Poor man's ReDoS mitigation. */
- if (NULL == (scriptname = getenv("SCRIPT_NAME")))
- scriptname = "";
+ 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) {
+ warn("setitimer");
+ pg_error_internal();
+ return EXIT_FAILURE;
+ }
/*
* First we change directory into the MAN_DIR so that
* relative to the same position.
*/
- if (-1 == chdir(MAN_DIR)) {
- fprintf(stderr, "MAN_DIR: %s: %s\n",
- MAN_DIR, strerror(errno));
+ if (chdir(MAN_DIR) == -1) {
+ warn("MAN_DIR: %s", MAN_DIR);
pg_error_internal();
- return(EXIT_FAILURE);
- }
+ return EXIT_FAILURE;
+ }
memset(&req, 0, sizeof(struct req));
- pathgen(&req);
+ req.q.equal = 1;
+ parse_manpath_conf(&req);
+
+ /* Parse the path info and the query string. */
- /* Next parse out the query string. */
+ if ((path = getenv("PATH_INFO")) == NULL)
+ path = "";
+ else if (*path == '/')
+ path++;
+
+ if (*path != '\0') {
+ parse_path_info(&req, path);
+ if (req.q.manpath == NULL || access(path, F_OK) == -1)
+ path = "";
+ } else if ((querystring = getenv("QUERY_STRING")) != NULL)
+ parse_query_string(&req, querystring);
- if (NULL != (querystring = getenv("QUERY_STRING")))
- http_parse(&req, querystring);
+ /* Validate parsed data and add defaults. */
- if ( ! validate_manpath(&req, req.q.manpath)) {
+ if (req.q.manpath == NULL)
+ req.q.manpath = mandoc_strdup(req.p[0]);
+ else if ( ! validate_manpath(&req, req.q.manpath)) {
pg_error_badrequest(
"You specified an invalid manpath.");
- return(EXIT_FAILURE);
+ return EXIT_FAILURE;
}
- /* Dispatch to the three different pages. */
+ if ( ! (NULL == req.q.arch || validate_urifrag(req.q.arch))) {
+ pg_error_badrequest(
+ "You specified an invalid architecture.");
+ return EXIT_FAILURE;
+ }
- path = getenv("PATH_INFO");
- if (NULL == path)
- path = "";
- else if ('/' == *path)
- path++;
+ /* Dispatch to the three different pages. */
if ('\0' != *path)
pg_show(&req, path);
- else if (NULL != req.q.expr)
+ 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);
+ return EXIT_SUCCESS;
}
-static int
-cmp(const void *p1, const void *p2)
+/*
+ * If PATH_INFO is not a file name, translate it to a query.
+ */
+static void
+parse_path_info(struct req *req, const char *path)
{
+ char *dir[4];
+ int i;
+
+ req->isquery = 0;
+ req->q.equal = 1;
+ req->q.manpath = mandoc_strdup(path);
+ req->q.arch = NULL;
+
+ /* Mandatory manual page name. */
+ if ((req->q.query = strrchr(req->q.manpath, '/')) == NULL) {
+ req->q.query = req->q.manpath;
+ req->q.manpath = NULL;
+ } else
+ *req->q.query++ = '\0';
+
+ /* Optional trailing section. */
+ if ((req->q.sec = strrchr(req->q.query, '.')) != NULL) {
+ if(isdigit((unsigned char)req->q.sec[1])) {
+ *req->q.sec++ = '\0';
+ req->q.sec = mandoc_strdup(req->q.sec);
+ } else
+ req->q.sec = NULL;
+ }
+
+ /* Handle the case of name[.section] only. */
+ if (req->q.manpath == NULL)
+ return;
+ req->q.query = mandoc_strdup(req->q.query);
+
+ /* Split directory components. */
+ dir[i = 0] = req->q.manpath;
+ while ((dir[i + 1] = strchr(dir[i], '/')) != NULL) {
+ if (++i == 3) {
+ pg_error_badrequest(
+ "You specified too many directory components.");
+ exit(EXIT_FAILURE);
+ }
+ *dir[i]++ = '\0';
+ }
- return(strcasecmp(((const struct manpage *)p1)->names,
- ((const struct manpage *)p2)->names));
+ /* Optional manpath. */
+ if ((i = validate_manpath(req, req->q.manpath)) == 0)
+ req->q.manpath = NULL;
+ else if (dir[1] == NULL)
+ return;
+
+ /* Optional section. */
+ if (strncmp(dir[i], "man", 3) == 0) {
+ free(req->q.sec);
+ req->q.sec = mandoc_strdup(dir[i++] + 3);
+ }
+ if (dir[i] == NULL) {
+ if (req->q.manpath == NULL)
+ free(dir[0]);
+ return;
+ }
+ if (dir[i + 1] != NULL) {
+ pg_error_badrequest(
+ "You specified an invalid directory component.");
+ exit(EXIT_FAILURE);
+ }
+
+ /* Optional architecture. */
+ if (i) {
+ req->q.arch = mandoc_strdup(dir[i]);
+ if (req->q.manpath == NULL)
+ free(dir[0]);
+ } else
+ req->q.arch = dir[0];
}
/*
* Scan for indexable paths.
*/
static void
-pathgen(struct req *req)
+parse_manpath_conf(struct req *req)
{
FILE *fp;
char *dp;
size_t dpsz;
+ ssize_t len;
- if (NULL == (fp = fopen("manpath.conf", "r"))) {
- fprintf(stderr, "%s/manpath.conf: %s\n",
- MAN_DIR, strerror(errno));
+ if ((fp = fopen("manpath.conf", "r")) == NULL) {
+ warn("%s/manpath.conf", MAN_DIR);
pg_error_internal();
exit(EXIT_FAILURE);
}
- while (NULL != (dp = fgetln(fp, &dpsz))) {
- if ('\n' == dp[dpsz - 1])
- dpsz--;
+ dp = NULL;
+ dpsz = 0;
+
+ while ((len = getline(&dp, &dpsz, fp)) != -1) {
+ if (dp[len - 1] == '\n')
+ dp[--len] = '\0';
req->p = mandoc_realloc(req->p,
(req->psz + 1) * sizeof(char *));
- req->p[req->psz++] = mandoc_strndup(dp, dpsz);
+ if ( ! validate_urifrag(dp)) {
+ warnx("%s/manpath.conf contains "
+ "unsafe path \"%s\"", MAN_DIR, dp);
+ pg_error_internal();
+ exit(EXIT_FAILURE);
+ }
+ if (strchr(dp, '/') != NULL) {
+ warnx("%s/manpath.conf contains "
+ "path with slash \"%s\"", MAN_DIR, dp);
+ pg_error_internal();
+ exit(EXIT_FAILURE);
+ }
+ req->p[req->psz++] = dp;
+ dp = NULL;
+ dpsz = 0;
}
+ free(dp);
- if ( req->p == NULL ) {
- fprintf(stderr, "%s/manpath.conf is empty\n", MAN_DIR);
+ if (req->p == NULL) {
+ warnx("%s/manpath.conf is empty", MAN_DIR);
pg_error_internal();
exit(EXIT_FAILURE);
}
git.ckatri.com / mandoc.git / blobdiff