-/* $Id: cgi.c,v 1.30 2011/12/12 02:00:49 schwarze Exp $ */
+/* $Id: cgi.c,v 1.148 2017/02/22 16:20:01 schwarze Exp $ */
/*
- * Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2014, 2015, 2016, 2017 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/param.h>
-#include <sys/wait.h>
+#include <sys/types.h>
+#include <sys/time.h>
-#include <assert.h>
#include <ctype.h>
+#if HAVE_ERR
+#include <err.h>
+#endif
#include <errno.h>
-#include <dirent.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_aux.h"
#include "mandoc.h"
+#include "roff.h"
#include "mdoc.h"
#include "man.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
-};
-
-struct paths {
- char *name;
- char *path;
-};
+#include "manconf.h"
+#include "mansearch.h"
+#include "cgi.h"
/*
* A query as passed to the search function.
*/
struct query {
- const char *arch; /* architecture */
- const char *sec; /* manual section */
- const char *expr; /* unparsed expression string */
- int manroot; /* manroot index (or -1)*/
- int whatis; /* whether whatis mode */
- int legacy; /* whether legacy mode */
+ 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 query q;
- struct paths *p;
- size_t psz;
- enum page page;
+ 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 int atou(const char *, unsigned *);
-static void catman(const char *);
-static int cmp(const void *, const void *);
-static void format(const char *);
static void html_print(const char *);
static void html_putchar(char);
-static int http_decode(char *);
-static void http_parse(struct req *, char *);
-static int pathstop(DIR *);
-static void pathgen(DIR *, char *, struct req *);
-static void pg_index(const struct req *, char *);
-static void pg_search(const struct req *, char *);
-static void pg_show(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 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_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_catman(const struct req *, const char *);
+static void resp_copy(const char *);
static void resp_end_html(void);
-static void resp_index(const struct req *);
-static void resp_search(struct res *, size_t, void *);
-static void resp_searchform(const struct req *);
-
-static const char *progname; /* cgi script name */
-static const char *cache; /* cache directory */
-static const char *css; /* css directory */
-static const char *host; /* hostname */
-
-static const char * const pages[PAGE__MAX] = {
- "index", /* PAGE_INDEX */
- "search", /* PAGE_SEARCH */
- "show", /* PAGE_SHOW */
+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 = SCRIPT_NAME;
+
+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"
};
-
-/*
- * 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", "armv7", "arm64",
+ "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 *);
/*
* Print a character, escaping HTML along the way.
switch (c) {
case ('"'):
- printf(""e;");
+ printf(""");
break;
case ('&'):
printf("&");
static void
html_print(const char *p)
{
-
+
if (NULL == p)
return;
while ('\0' != *p)
}
/*
- * 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.
+ * Transfer the responsibility for the allocated string *val
+ * to the query structure.
*/
static void
-http_parse(struct req *req, char *p)
+set_query_attr(char **attr, char **val)
{
- char *key, *val, *manroot;
- size_t sz;
- int i, legacy;
- memset(&req->q, 0, sizeof(struct query));
+ free(*attr);
+ if (**val == '\0') {
+ *attr = NULL;
+ free(*val);
+ } else
+ *attr = *val;
+ *val = NULL;
+}
- req->q.whatis = 1;
- legacy = -1;
- manroot = NULL;
+/*
+ * Parse the QUERY_STRING for key-value pairs
+ * and store the values into the query structure.
+ */
+static void
+parse_query_string(struct req *req, const char *qs)
+{
+ char *key, *val;
+ size_t keysz, valsz;
- while (p && '\0' != *p) {
- while (' ' == *p)
- p++;
+ req->isquery = 1;
+ req->q.manpath = NULL;
+ req->q.arch = NULL;
+ req->q.sec = NULL;
+ req->q.query = NULL;
+ req->q.equal = 1;
- key = p;
- val = NULL;
+ key = val = NULL;
+ while (*qs != '\0') {
- if (NULL != (p = strchr(p, '='))) {
- *p++ = '\0';
- val = p;
+ /* Parse one key. */
- sz = strcspn(p, ";&");
- /* LINTED */
- p += sz;
+ keysz = strcspn(qs, "=;&");
+ key = mandoc_strndup(qs, keysz);
+ qs += keysz;
+ if (*qs != '=')
+ goto next;
- if ('\0' != *p)
- *p++ = '\0';
- } else {
- p = key;
- sz = strcspn(p, ";&");
- /* LINTED */
- p += sz;
+ /* Parse one value. */
- if ('\0' != *p)
- p++;
- continue;
- }
+ valsz = strcspn(++qs, ";&");
+ val = mandoc_strndup(qs, valsz);
+ qs += valsz;
- if ('\0' == *key || '\0' == *val)
- continue;
+ /* Decode and catch encoding errors. */
- /* Just abort handling. */
+ if ( ! (http_decode(key) && http_decode(val)))
+ goto next;
- if ( ! http_decode(key))
- break;
- if ( ! http_decode(val))
- break;
+ /* Handle key-value pairs. */
- if (0 == strcmp(key, "expr"))
- req->q.expr = val;
- else if (0 == strcmp(key, "query"))
- req->q.expr = val;
- else if (0 == strcmp(key, "sec"))
- req->q.sec = val;
- else if (0 == strcmp(key, "sektion"))
- req->q.sec = val;
- else if (0 == strcmp(key, "arch"))
- req->q.arch = val;
- else if (0 == strcmp(key, "manpath"))
- manroot = val;
- else if (0 == strcmp(key, "apropos"))
- legacy = 0 == strcmp(val, "0");
- else if (0 == strcmp(key, "op"))
- req->q.whatis = 0 == strcasecmp(val, "whatis");
- }
+ if ( ! strcmp(key, "query"))
+ set_query_attr(&req->q.query, &val);
- /* Test for old man.cgi compatibility mode. */
+ else if ( ! strcmp(key, "apropos"))
+ req->q.equal = !strcmp(val, "0");
- if (legacy == 0) {
- req->q.whatis = 0;
- req->q.legacy = 1;
- } else if (legacy > 0) {
- req->q.legacy = 1;
- req->q.whatis = 1;
- }
+ 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);
+ }
- /*
- * Section "0" means no section when in legacy mode.
- * For some man.cgi scripts, "default" arch is none.
- */
+ 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);
+ }
- if (req->q.legacy && NULL != req->q.sec)
- if (0 == strcmp(req->q.sec, "0"))
- req->q.sec = NULL;
- if (req->q.legacy && NULL != req->q.arch)
- if (0 == strcmp(req->q.arch, "default"))
- req->q.arch = NULL;
+ else if ( ! strcmp(key, "arch")) {
+ if ( ! strcmp(val, "default"))
+ *val = '\0';
+ set_query_attr(&req->q.arch, &val);
+ }
- /* Default to first manroot. */
+ /*
+ * 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 (NULL != manroot) {
- for (i = 0; i < (int)req->psz; i++)
- if (0 == strcmp(req->p[i].name, manroot))
- break;
- req->q.manroot = i < (int)req->psz ? i : -1;
+ if (*qs != '\0')
+ qs++;
}
}
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);
+ 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;
- *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';
- return(1);
+ *q = '\0';
+ return 1;
}
static void
{
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);
}
+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"
- "<TITLE>System Manpage Reference</TITLE>\n"
- "</HEAD>\n"
- "<BODY>\n"
- "<!-- Begin page content. //-->\n", css);
+ 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",
+ 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("<!-- Begin search form. //-->");
- printf("<FORM ACTION=\"%s/search.html\" METHOD=\"get\">\n"
- "<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=\"",
- progname);
- html_print(req->q.expr ? req->q.expr : "");
- printf("\">, section "
- "<INPUT TYPE=\"text\""
- " SIZE=\"4\" NAME=\"sec\" VALUE=\"");
- html_print(req->q.sec ? req->q.sec : "");
- printf("\">, arch "
- "<INPUT TYPE=\"text\""
- " SIZE=\"8\" NAME=\"arch\" VALUE=\"");
- html_print(req->q.arch ? req->q.arch : "");
- printf("\">");
+ printf("<form action=\"/%s\" method=\"get\">\n"
+ " <fieldset>\n"
+ " <legend>Manual Page Search Parameters</legend>\n",
+ scriptname);
+
+ /* Write query input box. */
+
+ 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(">");
+
+ /* Write submission buttons. */
+
+ 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. */
+
+ puts(" <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\">");
+ puts(" <select name=\"manpath\">");
for (i = 0; i < (int)req->psz; i++) {
- printf("<OPTION %s VALUE=\"",
- (i == req->q.manroot) ||
- (0 == i && -1 == req->q.manroot) ?
- "SELECTED=\"selected\"" : "");
- html_print(req->p[i].name);
+ 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].name);
- puts("</OPTION>");
+ html_print(req->p[i]);
+ puts("</option>");
}
- puts("</SELECT>");
+ puts(" </select>");
}
- puts(".\n"
- "<INPUT TYPE=\"reset\" VALUE=\"Reset\">\n"
- "</FIELDSET>\n"
- "</FORM>");
- puts("<!-- End search form. //-->");
+
+ puts(" </fieldset>\n"
+ "</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();
+ 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, FOCUS_QUERY);
+ printf("<p>\n"
+ "This web interface is documented in the\n"
+ "<a class=\"Xr\" href=\"/%s%sman.cgi.8\">man.cgi(8)</a>\n"
+ "manual, and the\n"
+ "<a class=\"Xr\" href=\"/%s%sapropos.1\">apropos(1)</a>\n"
+ "manual explains the query syntax.\n"
+ "</p>\n",
+ scriptname, *scriptname == '\0' ? "" : "/",
+ scriptname, *scriptname == '\0' ? "" : "/");
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, FOCUS_QUERY);
+ puts("<p>");
+ puts(msg);
+ puts("</p>");
resp_end_html();
}
static void
-resp_baddb(void)
+pg_error_badrequest(const char *msg)
{
- resp_begin_html(500, "Internal Server Error");
- puts("<P>Your database is broken.</P>");
+ 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
-resp_search(struct res *r, size_t sz, void *arg)
+pg_error_internal(void)
{
- int i;
- const struct req *req;
+ resp_begin_html(500, "Internal Server Error");
+ puts("<p>Internal Server Error</p>");
+ resp_end_html();
+}
- req = (const struct req *)arg;
- assert(req->q.manroot >= 0);
+static void
+pg_searchres(const struct req *req, struct manpage *r, size_t sz)
+{
+ char *arch, *archend;
+ const char *sec;
+ size_t i, iuse;
+ int archprio, archpriouse;
+ int prio, priouse;
+
+ for (i = 0; i < sz; i++) {
+ if (validate_filename(r[i].file))
+ continue;
+ 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.
*/
- puts("Status: 303 See Other");
- printf("Location: http://%s%s/show/%d/%u/%u.html\n",
- host, progname, req->q.manroot,
- 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/%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 res), cmp);
-
resp_begin_html(200, NULL);
- resp_searchform(req);
-
- if (0 == sz) {
- printf("<P>\n"
- "No %s results found.\n",
- req->q.whatis ? "whatis" : "apropos");
- if (req->q.whatis) {
- printf("(Try <A HREF=\"%s/search.html?"
- "op=apropos&expr=", progname);
- html_print(req->q.expr ? req->q.expr : "");
- printf("&sec=");
- html_print(req->q.sec ? req->q.sec : "");
- printf("&arch=");
- html_print(req->q.arch ? req->q.arch : "");
- puts("\">apropos</A>?)");
+ resp_searchform(req,
+ req->q.equal || sz == 1 ? FOCUS_NONE : FOCUS_QUERY);
+
+ if (sz > 1) {
+ puts("<table class=\"results\">");
+ for (i = 0; i < sz; i++) {
+ printf(" <tr>\n"
+ " <td>"
+ "<a class=\"Xr\" href=\"/%s%s%s/%s\">",
+ scriptname, *scriptname == '\0' ? "" : "/",
+ req->q.manpath, r[i].file);
+ html_print(r[i].names);
+ printf("</a></td>\n"
+ " <td><span class=\"Nd\">");
+ html_print(r[i].output);
+ puts("</span></td>\n"
+ " </tr>");
}
- puts("</P>");
- resp_end_html();
- return;
+ puts("</table>");
}
- puts("<P></P>\n"
- "<TABLE>");
-
- for (i = 0; i < (int)sz; i++) {
- printf("<TR>\n"
- "<TD CLASS=\"title\">\n"
- "<A HREF=\"%s/show/%d/%u/%u.html\">",
- progname, req->q.manroot,
- 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 || sz == 1) {
+ puts("<hr>");
+ iuse = 0;
+ priouse = 20;
+ archpriouse = 3;
+ for (i = 0; i < sz; i++) {
+ sec = r[i].file;
+ sec += strcspn(sec, "123456789");
+ if (sec[0] == '\0')
+ continue;
+ 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;
+ iuse = i;
}
- printf(")</A>\n"
- "</TD>\n"
- "<TD CLASS=\"desc\">");
- html_print(r[i].desc);
- puts("</TD>\n"
- "</TR>");
+ resp_show(req, r[iuse].file);
}
- puts("</TABLE>");
resp_end_html();
}
-/* ARGSUSED */
-static void
-pg_index(const struct req *req, char *path)
-{
-
- resp_index(req);
-}
-
static void
-catman(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"))) {
- resp_baddb();
+ if ((f = fopen(file, "r")) == NULL) {
+ puts("<p>You specified an invalid manual file.</p>");
return;
}
- resp_begin_http(200, NULL);
- 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/catman.css\""
- " TYPE=\"text/css\" media=\"all\">\n"
- "<TITLE>System Manpage Reference</TITLE>\n"
- "</HEAD>\n"
- "<BODY>\n"
- "<!-- Begin page content. //-->\n"
- "<PRE>\n", css);
-
- while (NULL != (p = fgetln(f, &len))) {
+ puts("<div class=\"catman\">\n"
+ "<pre>");
+
+ 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"
- "</BODY>\n"
- "</HTML>");
+ puts("</pre>\n"
+ "</div>");
fclose(f);
}
static void
-format(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[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);
- 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) {
- resp_baddb();
+ memset(&conf, 0, sizeof(conf));
+ conf.fragment = 1;
+ conf.style = mandoc_strdup(CSS_DIR "/mandoc.css");
+ usepath = strcmp(req->q.manpath, req->p[0]);
+ mandoc_asprintf(&conf.man, "/%s%s%%N.%%S",
+ usepath ? req->q.manpath : "", usepath ? "/" : "");
+
+ 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;
}
- snprintf(opts, sizeof(opts), "style=%s/man.css,"
- "man=%s/search.html?sec=%%S&expr=%%N,"
- /*"includes=/cgi-bin/man.cgi/usr/include/%%I"*/,
- css, progname);
-
- mparse_result(mp, &mdoc, &man);
- vp = html_alloc(opts);
+ vp = html_alloc(&conf);
- if (NULL != mdoc) {
- resp_begin_http(200, NULL);
- html_mdoc(vp, mdoc);
- } else if (NULL != man) {
- resp_begin_http(200, NULL);
+ if (man->macroset == MACROSET_MDOC) {
+ mdoc_validate(man);
+ html_mdoc(vp, man);
+ } else {
+ man_validate(man);
html_man(vp, man);
- } else
- resp_baddb();
+ }
html_free(vp);
mparse_free(mp);
+ mchars_free();
+ free(conf.man);
+ free(conf.style);
}
static void
-pg_show(const struct req *req, char *path)
+resp_show(const struct req *req, const char *file)
{
- struct manpaths ps;
- char *sub;
- char file[MAXPATHLEN];
- const char *fn, *cp;
- int rc;
- unsigned int vol, rec, mr;
- DB *idx;
- DBT key, val;
- idx = NULL;
+ if ('.' == file[0] && '/' == file[1])
+ file += 2;
- /* Parse out mroot, volume, and record from the path. */
+ if ('c' == *file)
+ resp_catman(req, file);
+ else
+ resp_format(req, file);
+}
- if (NULL == path || NULL == (sub = strchr(path, '/'))) {
- resp_error400();
- return;
- }
- *sub++ = '\0';
- if ( ! atou(path, &mr)) {
- resp_error400();
- return;
- }
- path = sub;
- if (NULL == (sub = strchr(path, '/'))) {
- resp_error400();
+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;
}
- *sub++ = '\0';
- if ( ! atou(path, &vol) || ! atou(sub, &rec)) {
- resp_error400();
- return;
- } else if (mr >= (unsigned int)req->psz) {
- 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;
}
/*
- * Begin by chdir()ing into the manroot.
+ * Begin by chdir()ing into the manpath.
* This way we can pick up the database files, which are
* relative to the manpath root.
*/
- if (-1 == chdir(req->p[(int)mr].path)) {
- perror(req->p[(int)mr].path);
- resp_baddb();
+ if (chdir(manpath) == -1) {
+ warn("chdir %s", manpath);
+ pg_error_internal();
+ free(manpath);
return;
}
+ free(manpath);
- memset(&ps, 0, sizeof(struct manpaths));
- manpath_manconf(&ps, "etc/catman.conf");
-
- if (vol >= (unsigned int)ps.sz) {
- resp_error400();
- goto out;
- }
-
- strlcpy(file, ps.paths[vol], MAXPATHLEN);
- strlcat(file, "/mandoc.index", MAXPATHLEN);
-
- /* Open the index recno(3) database. */
-
- idx = dbopen(file, O_RDONLY, 0, DB_RECNO, NULL);
- if (NULL == idx) {
- perror(file);
- resp_baddb();
- goto out;
+ if ( ! validate_filename(file)) {
+ pg_error_badrequest(
+ "You specified an invalid manual file.");
+ return;
}
- key.data = &rec;
- key.size = 4;
-
- if (0 != (rc = (*idx->get)(idx, &key, &val, 0))) {
- rc < 0 ? resp_baddb() : resp_error400();
- goto out;
- }
-
- cp = (char *)val.data;
-
- if (NULL == (fn = memchr(cp, '\0', val.size)))
- resp_baddb();
- else if (++fn - cp >= (int)val.size)
- resp_baddb();
- else if (NULL == memchr(fn, '\0', val.size - (fn - cp)))
- resp_baddb();
- else {
- if (0 == strcmp(cp, "cat"))
- catman(fn + 1);
- else
- format(fn + 1);
- }
-out:
- if (idx)
- (*idx->close)(idx);
- manpath_free(&ps);
+ resp_begin_html(200, NULL);
+ resp_searchform(req, FOCUS_NONE);
+ resp_show(req, file);
+ resp_end_html();
}
static void
-pg_search(const struct req *req, char *path)
+pg_search(const struct req *req)
{
- size_t tt;
- struct manpaths ps;
- int i, sz, rc;
- const char *ep, *start;
- char **cp;
- struct opts opt;
- struct expr *expr;
-
- if (req->q.manroot < 0 || 0 == req->psz) {
- resp_search(NULL, 0, (void *)req);
- return;
- }
-
- memset(&opt, 0, sizeof(struct opts));
-
- ep = req->q.expr;
- opt.arch = req->q.arch;
- opt.cat = req->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;
/*
* Begin by chdir()ing into the root of the manpath.
* relative to the manpath root.
*/
- assert(req->q.manroot < (int)req->psz);
- if (-1 == (chdir(req->p[req->q.manroot].path))) {
- perror(req->p[req->q.manroot].path);
- resp_search(NULL, 0, (void *)req);
+ if (chdir(req->q.manpath) == -1) {
+ warn("chdir %s", req->q.manpath);
+ pg_error_internal();
return;
}
- memset(&ps, 0, sizeof(struct manpaths));
- manpath_manconf(&ps, "etc/catman.conf");
+ search.arch = req->q.arch;
+ search.sec = req->q.sec;
+ search.outkey = "Nd";
+ search.argmode = req->q.equal ? ARG_NAME : ARG_EXPR;
+ search.firstmatch = 1;
- /*
- * Poor man's tokenisation: just break apart by spaces.
- * Yes, this is half-ass. But it works for now.
- */
-
- while (ep && isspace((unsigned char)*ep))
- ep++;
-
- while (ep && '\0' != *ep) {
- cp = mandoc_realloc(cp, (sz + 1) * sizeof(char *));
- start = ep;
- while ('\0' != *ep && ! isspace((unsigned char)*ep))
- ep++;
- cp[sz] = mandoc_malloc((ep - start) + 1);
- memcpy(cp[sz], start, ep - start);
- cp[sz++][ep - start] = '\0';
- while (isspace((unsigned char)*ep))
- ep++;
- }
+ paths.sz = 1;
+ paths.paths = mandoc_malloc(sizeof(char *));
+ paths.paths[0] = mandoc_strdup(".");
/*
- * Pump down into apropos backend.
- * The resp_search() function is called with the results.
+ * Break apart at spaces with backslash-escaping.
*/
- expr = req->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);
-
- /* ...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]);
+ 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);
- manpath_free(&ps);
+ 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;
- char buf[MAXPATHLEN];
- DIR *cwd;
struct req req;
- char *p, *path, *subpath;
-
- /* Scan our run-time environment. */
+ struct itimerval itimer;
+ const char *path;
+ const char *querystring;
+ int i;
- if (NULL == (cache = getenv("CACHE_DIR")))
- cache = "/cache/man.cgi";
+#if HAVE_PLEDGE
+ /*
+ * The "rpath" pledge could be revoked after mparse_readfd()
+ * if the file desciptor to "/footer.html" would be opened
+ * up front, but it's probably not worth the complication
+ * of the code it would cause: it would require scattering
+ * pledge() calls in multiple low-level resp_*() functions.
+ */
- if (NULL == (progname = getenv("SCRIPT_NAME")))
- progname = "";
+ if (pledge("stdio rpath", NULL) == -1) {
+ warn("pledge");
+ pg_error_internal();
+ return EXIT_FAILURE;
+ }
+#endif
- if (NULL == (css = getenv("CSS_DIR")))
- css = "/";
+ /* Poor man's ReDoS mitigation. */
- if (NULL == (host = getenv("HTTP_HOST")))
- host = "localhost";
+ 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 cache directory so that
+ * 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(cache)) {
- perror(cache);
- resp_bad();
- return(EXIT_FAILURE);
- } else if (NULL == (cwd = opendir(cache))) {
- perror(cache);
- resp_bad();
- return(EXIT_FAILURE);
- }
+ if (chdir(MAN_DIR) == -1) {
+ warn("MAN_DIR: %s", MAN_DIR);
+ pg_error_internal();
+ return EXIT_FAILURE;
+ }
memset(&req, 0, sizeof(struct req));
-
- strlcpy(buf, ".", MAXPATHLEN);
- pathgen(cwd, buf, &req);
- closedir(cwd);
-
- /* Next parse out the query string. */
-
- if (NULL != (p = getenv("QUERY_STRING")))
- http_parse(&req, p);
-
- /*
- * Now juggle paths to extract information.
- * We want to extract our filetype (the file suffix), the
- * initial path component, then the trailing component(s).
- * Start with leading subpath component.
- */
-
- 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';
-
- /* 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;
- }
-
- /* Route pages. */
-
- switch (req.page) {
- case (PAGE_INDEX):
- pg_index(&req, subpath);
- break;
- case (PAGE_SEARCH):
- pg_search(&req, subpath);
- break;
- case (PAGE_SHOW):
- pg_show(&req, subpath);
- break;
- default:
- resp_error404(path);
- break;
+ req.q.equal = 1;
+ parse_manpath_conf(&req);
+
+ /* Parse the path info and 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);
+
+ /* Validate parsed data and add defaults. */
+
+ 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;
}
- for (i = 0; i < (int)req.psz; i++) {
- free(req.p[i].path);
- free(req.p[i].name);
+ 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. */
+
+ 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)
-{
-
- return(strcasecmp(((const struct res *)p1)->title,
- ((const struct res *)p2)->title));
+ return EXIT_SUCCESS;
}
/*
- * Check to see if an "etc" path consists of a catman.conf file. If it
- * does, that means that the path contains a tree created by catman(8)
- * and should be used for indexing.
+ * If PATH_INFO is not a file name, translate it to a query.
*/
-static int
-pathstop(DIR *dir)
+static void
+parse_path_info(struct req *req, const char *path)
{
- struct dirent *d;
+ 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';
+ }
+
+ /* Optional manpath. */
+ if ((i = validate_manpath(req, req->q.manpath)) == 0)
+ req->q.manpath = NULL;
+ else if (dir[1] == NULL)
+ return;
- while (NULL != (d = readdir(dir)))
- if (DT_REG == d->d_type)
- if (0 == strcmp(d->d_name, "catman.conf"))
- return(1);
+ /* 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);
+ }
- return(0);
+ /* 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.
- * This adds all paths with "etc/catman.conf" to the buffer.
*/
static void
-pathgen(DIR *dir, char *path, struct req *req)
+parse_manpath_conf(struct req *req)
{
- struct dirent *d;
- char *cp;
- DIR *cd;
- int rc;
- size_t sz, ssz;
-
- sz = strlcat(path, "/", MAXPATHLEN);
- if (sz >= MAXPATHLEN) {
- fprintf(stderr, "%s: Path too long", path);
- return;
- }
-
- /*
- * First, scan for the "etc" directory.
- * If it's found, then see if it should cause us to stop. This
- * happens when a catman.conf is found in the directory.
- */
-
- rc = 0;
- while (0 == rc && NULL != (d = readdir(dir))) {
- if (DT_DIR != d->d_type || strcmp(d->d_name, "etc"))
- continue;
-
- path[(int)sz] = '\0';
- ssz = strlcat(path, d->d_name, MAXPATHLEN);
-
- if (ssz >= MAXPATHLEN) {
- fprintf(stderr, "%s: Path too long", path);
- return;
- } else if (NULL == (cd = opendir(path))) {
- perror(path);
- return;
- }
-
- rc = pathstop(cd);
- closedir(cd);
+ FILE *fp;
+ char *dp;
+ size_t dpsz;
+ ssize_t len;
+
+ if ((fp = fopen("manpath.conf", "r")) == NULL) {
+ warn("%s/manpath.conf", MAN_DIR);
+ pg_error_internal();
+ exit(EXIT_FAILURE);
}
- if (rc > 0) {
- /* This also strips the trailing slash. */
- path[(int)--sz] = '\0';
- req->p = mandoc_realloc
- (req->p,
- (req->psz + 1) * sizeof(struct paths));
- /*
- * Strip out the leading "./" unless we're just a ".",
- * in which case use an empty string as our name.
- */
- req->p[(int)req->psz].path = mandoc_strdup(path);
- req->p[(int)req->psz].name =
- cp = mandoc_strdup(path + (1 == sz ? 1 : 2));
- req->psz++;
- /*
- * The name is just the path with all the slashes taken
- * out of it. Simple but effective.
- */
- for ( ; '\0' != *cp; cp++)
- if ('/' == *cp)
- *cp = ' ';
- return;
- }
-
- /*
- * If no etc/catman.conf was found, recursively enter child
- * directory and continue scanning.
- */
-
- rewinddir(dir);
- while (NULL != (d = readdir(dir))) {
- if (DT_DIR != d->d_type || '.' == d->d_name[0])
- continue;
-
- path[(int)sz] = '\0';
- ssz = strlcat(path, d->d_name, MAXPATHLEN);
-
- if (ssz >= MAXPATHLEN) {
- fprintf(stderr, "%s: Path too long", path);
- return;
- } else if (NULL == (cd = opendir(path))) {
- perror(path);
- return;
+ 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 *));
+ 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);
- pathgen(cd, path, req);
- closedir(cd);
+ if (req->p == NULL) {
+ warnx("%s/manpath.conf is empty", MAN_DIR);
+ pg_error_internal();
+ exit(EXIT_FAILURE);
}
}
git.ckatri.com / mandoc.git / blobdiff