-/* $Id: cgi.c,v 1.7 2011/11/24 12:27:18 kristaps Exp $ */
+/* $Id: cgi.c,v 1.19 2011/12/08 22:47:09 kristaps Exp $ */
/*
* Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
*
#include "apropos_db.h"
#include "mandoc.h"
+#include "mdoc.h"
+#include "man.h"
+#include "main.h"
#include "manpath.h"
#ifdef __linux__
};
static int atou(const char *, unsigned *);
-static void format_insecure(const char *);
-static void format_secure(const char *);
+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 kval_decode(char *);
static void kval_parse(struct kval **, size_t *, char *);
static void kval_free(struct kval *, size_t);
const struct req *, char *);
static void resp_bad(void);
static void resp_baddb(void);
-static void resp_badexpr(const struct req *);
-static void resp_badmanual(void);
+static void resp_error400(void);
+static void resp_error404(const char *);
static void resp_begin_html(int, const char *);
static void resp_begin_http(int, const char *);
static void resp_end_html(void);
static void resp_search(struct res *, size_t, void *);
static void resp_searchform(const struct req *);
-static int insecure = 1;
static const char *progname;
static const char *cache;
static const char *host;
return(1);
}
+static void
+html_putchar(char c)
+{
+
+ switch (c) {
+ case ('"'):
+ printf(""e;");
+ break;
+ case ('&'):
+ printf("&");
+ break;
+ case ('>'):
+ printf(">");
+ break;
+ case ('<'):
+ printf("<");
+ break;
+ default:
+ putchar((unsigned char)c);
+ break;
+ }
+}
+
/*
* Print a word, escaping HTML along the way.
* This will pass non-ASCII straight to output: be warned!
static void
html_print(const char *p)
{
- char c;
if (NULL == p)
return;
-
while ('\0' != *p)
- switch ((c = *p++)) {
- case ('"'):
- printf(""e;");
- break;
- case ('&'):
- printf("&");
- break;
- case ('>'):
- printf(">");
- break;
- case ('<'):
- printf("<");
- break;
- default:
- putchar((unsigned char)c);
- break;
- }
+ html_putchar(*p++);
}
static void
" \"http://www.w3.org/TR/html4/strict.dtd\">" "\n"
"<HTML>" "\n"
" <HEAD>" "\n"
+ " <META HTTP-EQUIV=\"Content-Type\" " "\n"
+ " CONTENT=\"text/html; charset=utf-8\">" "\n"
+ " <LINK REL=\"stylesheet\" HREF=\"/man.cgi.css\"" "\n"
+ " TYPE=\"text/css\" media=\"all\">" "\n"
" <TITLE>System Manpage Reference</TITLE>" "\n"
" </HEAD>" "\n"
" <BODY>" "\n"
for (i = 0; i < (int)req->fieldsz; i++)
if (0 == strcmp(req->fields[i].key, "expr"))
expr = req->fields[i].val;
+ else if (0 == strcmp(req->fields[i].key, "query"))
+ expr = req->fields[i].val;
else if (0 == strcmp(req->fields[i].key, "sec"))
sec = req->fields[i].val;
+ else if (0 == strcmp(req->fields[i].key, "sektion"))
+ sec = req->fields[i].val;
else if (0 == strcmp(req->fields[i].key, "arch"))
arch = req->fields[i].val;
+ if (NULL != sec && 0 == strcmp(sec, "0"))
+ sec = NULL;
+
puts("<!-- Begin search form. //-->");
printf("<FORM ACTION=\"");
html_print(progname);
- printf("/search\" METHOD=\"get\">\n");
- puts(" <FIELDSET>" "\n"
- " <INPUT TYPE=\"submit\" VALUE=\"Search:\">");
- printf(" Terms: <INPUT TYPE=\"text\" "
- "SIZE=\"60\" NAME=\"expr\" VALUE=\"");
+ 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(expr);
- puts("\">");
- printf(" Section: <INPUT TYPE=\"text\" "
- "SIZE=\"4\" NAME=\"sec\" VALUE=\"");
+ printf("\">, section "
+ "<INPUT TYPE=\"text\" "
+ "SIZE=\"4\" NAME=\"sec\" VALUE=\"");
html_print(sec);
- puts("\">");
- printf(" Arch: <INPUT TYPE=\"text\" "
- "SIZE=\"8\" NAME=\"arch\" VALUE=\"");
+ printf("\">, arch "
+ "<INPUT TYPE=\"text\" "
+ "SIZE=\"8\" NAME=\"arch\" VALUE=\"");
html_print(arch);
- puts("\">");
- puts(" </FIELDSET>\n</FORM>\n<!-- End search form. //-->");
+ puts("\">.\n"
+ "<INPUT TYPE=\"reset\" VALUE=\"Reset\">\n"
+ "</FIELDSET>\n"
+ "</FORM>\n"
+ "<!-- End search form. //-->");
}
static void
}
static void
-resp_badmanual(void)
+resp_error400(void)
{
- resp_begin_html(404, "Not Found");
- puts("<P>Requested manual not found.</P>");
+ 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();
}
static void
-resp_badexpr(const struct req *req)
+resp_error404(const char *page)
{
- resp_begin_html(200, NULL);
- resp_searchform(req);
- puts("<P>Your search didn't work.</P>");
+ 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_end_html();
}
static void
resp_search(struct res *r, size_t sz, void *arg)
{
- int i;
+ int i, whatis;
+ const char *ep, *sec, *arch;
+ const struct req *req;
+
+ whatis = 1;
+ ep = sec = arch = NULL;
if (1 == sz) {
/*
return;
}
+ req = (const struct req *)arg;
+
+ for (i = 0; i < (int)req->fieldsz; i++)
+ if (0 == strcmp(req->fields[i].key, "expr"))
+ ep = req->fields[i].val;
+ else if (0 == strcmp(req->fields[i].key, "query"))
+ ep = req->fields[i].val;
+ else if (0 == strcmp(req->fields[i].key, "sec"))
+ sec = req->fields[i].val;
+ else if (0 == strcmp(req->fields[i].key, "sektion"))
+ sec = req->fields[i].val;
+ else if (0 == strcmp(req->fields[i].key, "arch"))
+ arch = req->fields[i].val;
+ else if (0 == strcmp(req->fields[i].key, "apropos"))
+ whatis = 0 == strcmp
+ (req->fields[i].val, "0");
+ else if (0 == strcmp(req->fields[i].key, "op"))
+ whatis = 0 == strcasecmp
+ (req->fields[i].val, "whatis");
+
+ qsort(r, sz, sizeof(struct res), cmp);
+
resp_begin_html(200, NULL);
- resp_searchform((const struct req *)arg);
+ resp_searchform(req);
- if (0 == sz)
- puts("<P>No results found.</P>");
+ if (0 == sz) {
+ puts("<P>\n"
+ "No results found.");
+ if (whatis) {
+ printf("(Try <A HREF=\"");
+ html_print(progname);
+ printf("/search.html?op=apropos&expr=");
+ html_print(ep ? ep : "");
+ printf("&sec=");
+ html_print(sec ? sec : "");
+ printf("&arch=");
+ html_print(arch ? arch : "");
+ puts("\">apropos</A>?)");
+ }
+ puts("</P>");
+ resp_end_html();
+ return;
+ }
+
+ puts("<P></P>\n"
+ "<TABLE>");
for (i = 0; i < (int)sz; i++) {
- printf("<P><A HREF=\"");
+ printf("<TR><TD CLASS=\"title\"><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].arch);
}
- printf(")</A> ");
+ printf(")</A></TD><TD CLASS=\"desc\">");
html_print(r[i].desc);
- puts("</P>");
+ puts("</TD></TR>");
}
+ puts("</TABLE>");
+
resp_end_html();
}
}
static void
-format_insecure(const char *file)
+catman(const char *file)
{
- pid_t pid;
- char cmd[MAXPATHLEN];
+ FILE *f;
+ size_t len;
+ int i;
+ char *p;
+ int italic, bold;
- strlcpy(cmd, "man=", MAXPATHLEN);
- strlcat(cmd, progname, MAXPATHLEN);
- strlcat(cmd, "/search?expr=%N&sec=%S", MAXPATHLEN);
+ if (NULL == (f = fopen(file, "r"))) {
+ resp_baddb();
+ return;
+ }
- /* Get ready to call the child mandoc(1) process. */
+ resp_begin_http(200, NULL);
+ puts("<!DOCTYPE HTML PUBLIC " "\n"
+ " \"-//W3C//DTD HTML 4.01//EN\"" "\n"
+ " \"http://www.w3.org/TR/html4/strict.dtd\">" "\n"
+ "<HTML>" "\n"
+ " <HEAD>" "\n"
+ " <META HTTP-EQUIV=\"Content-Type\" " "\n"
+ " CONTENT=\"text/html; charset=utf-8\">" "\n"
+ " <LINK REL=\"stylesheet\" HREF=\"/catman.css\"" "\n"
+ " TYPE=\"text/css\" media=\"all\">" "\n"
+ " <TITLE>System Manpage Reference</TITLE>" "\n"
+ " </HEAD>" "\n"
+ " <BODY>" "\n"
+ "<!-- Begin page content. //-->");
- if (-1 == (pid = fork()))
- exit(EXIT_FAILURE);
+ puts("<PRE>");
+ while (NULL != (p = fgetln(f, &len))) {
+ bold = italic = 0;
+ for (i = 0; i < (int)len - 1; i++) {
+ /*
+ * This means that the catpage is out of state.
+ * Ignore it and keep going (although the
+ * catpage is bogus).
+ */
+
+ if ('\b' == p[i] || '\n' == p[i])
+ continue;
+
+ /*
+ * Print a regular character.
+ * Close out any bold/italic scopes.
+ * If we're in back-space mode, make sure we'll
+ * have something to enter when we backspace.
+ */
+
+ if ('\b' != p[i + 1]) {
+ if (italic)
+ printf("</I>");
+ if (bold)
+ printf("</B>");
+ italic = bold = 0;
+ html_putchar(p[i]);
+ continue;
+ } else if (i + 2 >= (int)len)
+ continue;
+
+ /* Italic mode. */
+
+ if ('_' == p[i]) {
+ if (bold)
+ printf("</B>");
+ if ( ! italic)
+ printf("<I>");
+ bold = 0;
+ italic = 1;
+ i += 2;
+ html_putchar(p[i]);
+ continue;
+ }
- if (pid > 0) {
- waitpid(pid, NULL, 0);
- return;
- }
+ /*
+ * Handle funny behaviour troff-isms.
+ * These grok'd from the original man2html.c.
+ */
+
+ if (('+' == p[i] && 'o' == p[i + 2]) ||
+ ('o' == p[i] && '+' == p[i + 2]) ||
+ ('|' == p[i] && '=' == p[i + 2]) ||
+ ('=' == p[i] && '|' == p[i + 2]) ||
+ ('*' == p[i] && '=' == p[i + 2]) ||
+ ('=' == p[i] && '*' == p[i + 2]) ||
+ ('*' == p[i] && '|' == p[i + 2]) ||
+ ('|' == p[i] && '*' == p[i + 2])) {
+ if (italic)
+ printf("</I>");
+ if (bold)
+ printf("</B>");
+ italic = bold = 0;
+ putchar('*');
+ i += 2;
+ continue;
+ } else if (('|' == p[i] && '-' == p[i + 2]) ||
+ ('-' == p[i] && '|' == p[i + 1]) ||
+ ('+' == p[i] && '-' == p[i + 1]) ||
+ ('-' == p[i] && '+' == p[i + 1]) ||
+ ('+' == p[i] && '|' == p[i + 1]) ||
+ ('|' == p[i] && '+' == p[i + 1])) {
+ if (italic)
+ printf("</I>");
+ if (bold)
+ printf("</B>");
+ italic = bold = 0;
+ putchar('+');
+ i += 2;
+ continue;
+ }
- dup2(STDOUT_FILENO, STDERR_FILENO);
+ /* Bold mode. */
+
+ if (italic)
+ printf("</I>");
+ if ( ! bold)
+ printf("<B>");
+ bold = 1;
+ italic = 0;
+ i += 2;
+ html_putchar(p[i]);
+ }
- puts("Content-Type: text/html; charset=utf-8\n");
+ /*
+ * Clean up the last character.
+ * We can get to a newline; don't print that.
+ */
- fflush(stdout);
+ if (italic)
+ printf("</I>");
+ if (bold)
+ printf("</B>");
+
+ if (i == (int)len - 1 && '\n' != p[i])
+ html_putchar(p[i]);
+
+ putchar('\n');
+ }
+
+ puts("</PRE>\n"
+ "</BODY>\n"
+ "</HTML>");
- execlp("mandoc", "mandoc", "-T",
- "html", "-O", cmd, file, (char *)NULL);
+ fclose(f);
}
static void
-format_secure(const char *file)
+format(const char *file)
{
- char buf[BUFSIZ];
+ struct mparse *mp;
int fd;
- ssize_t ssz;
+ struct mdoc *mdoc;
+ struct man *man;
+ void *vp;
+ enum mandoclevel rc;
+ char opts[MAXPATHLEN + 128];
if (-1 == (fd = open(file, O_RDONLY, 0))) {
resp_baddb();
return;
}
- resp_begin_http(200, NULL);
+ mp = mparse_alloc(MPARSE_AUTO, MANDOCLEVEL_FATAL, NULL, NULL);
+ rc = mparse_readfd(mp, fd, file);
+ close(fd);
+
+ if (rc >= MANDOCLEVEL_FATAL) {
+ resp_baddb();
+ return;
+ }
- do {
- ssz = read(fd, buf, BUFSIZ);
- if (ssz > 0)
- write(STDOUT_FILENO, buf, ssz);
- } while (ssz > 0);
+ snprintf(opts, sizeof(opts), "style=/man.css,"
+ "man=%s/search.html?sec=%%S&expr=%%N,"
+ /*"includes=/cgi-bin/man.cgi/usr/include/%%I"*/,
+ progname);
- close(fd);
+ mparse_result(mp, &mdoc, &man);
+ vp = html_alloc(opts);
+
+ if (NULL != mdoc) {
+ resp_begin_http(200, NULL);
+ html_mdoc(vp, mdoc);
+ } else if (NULL != man) {
+ resp_begin_http(200, NULL);
+ html_man(vp, man);
+ } else
+ resp_baddb();
+
+ html_free(vp);
+ mparse_free(mp);
}
static void
{
char *sub;
char file[MAXPATHLEN];
+ const char *fn, *cp;
int rc;
unsigned int vol, rec;
- DB *db;
+ DB *idx;
DBT key, val;
if (NULL == path) {
- resp_badmanual();
+ resp_error400();
return;
} else if (NULL == (sub = strrchr(path, '/'))) {
- resp_badmanual();
+ resp_error400();
return;
} else
*sub++ = '\0';
if ( ! (atou(path, &vol) && atou(sub, &rec))) {
- resp_badmanual();
+ resp_error400();
return;
} else if (vol >= (unsigned int)ps->sz) {
- resp_badmanual();
+ resp_error400();
return;
}
/* Open the index recno(3) database. */
- db = dbopen(file, O_RDONLY, 0, DB_RECNO, NULL);
- if (NULL == db) {
+ idx = dbopen(file, O_RDONLY, 0, DB_RECNO, NULL);
+ if (NULL == idx) {
resp_baddb();
return;
}
key.data = &rec;
key.size = 4;
- if (0 != (rc = (*db->get)(db, &key, &val, 0))) {
- rc < 0 ? resp_baddb() : resp_badmanual();
- (*db->close)(db);
- return;
+ if (0 != (rc = (*idx->get)(idx, &key, &val, 0))) {
+ rc < 0 ? resp_baddb() : resp_error400();
+ goto out;
}
- /* Extra filename: the first nil-terminated entry. */
-
- (*db->close)(db);
+ cp = (char *)val.data;
- strlcpy(file, ps->paths[vol], MAXPATHLEN);
- strlcat(file, "/", MAXPATHLEN);
- strlcat(file, (char *)val.data, MAXPATHLEN);
-
- if ( ! insecure) {
- strlcat(file, ".html", MAXPATHLEN);
- format_secure(file);
- } else
- format_insecure(file);
+ 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);
}
static void
pg_search(const struct manpaths *ps, const struct req *req, char *path)
{
size_t tt;
- int i, sz, rc;
+ int i, sz, rc, whatis;
const char *ep, *start;
char **cp;
struct opts opt;
cp = NULL;
ep = NULL;
sz = 0;
+ whatis = 1;
memset(&opt, 0, sizeof(struct opts));
for (sz = i = 0; i < (int)req->fieldsz; i++)
if (0 == strcmp(req->fields[i].key, "expr"))
ep = req->fields[i].val;
+ else if (0 == strcmp(req->fields[i].key, "query"))
+ ep = req->fields[i].val;
else if (0 == strcmp(req->fields[i].key, "sec"))
opt.cat = req->fields[i].val;
+ else if (0 == strcmp(req->fields[i].key, "sektion"))
+ opt.cat = req->fields[i].val;
else if (0 == strcmp(req->fields[i].key, "arch"))
opt.arch = req->fields[i].val;
+ else if (0 == strcmp(req->fields[i].key, "apropos"))
+ whatis = 0 == strcmp
+ (req->fields[i].val, "0");
+ else if (0 == strcmp(req->fields[i].key, "op"))
+ whatis = 0 == strcasecmp
+ (req->fields[i].val, "whatis");
+
+ if (NULL != opt.cat && 0 == strcmp(opt.cat, "0"))
+ opt.cat = NULL;
/*
* Poor man's tokenisation.
* The resp_search() function is called with the results.
*/
- if (NULL != (expr = exprcomp(sz, cp, &tt)))
+ expr = whatis ? termcomp(sz, cp, &tt) :
+ exprcomp(sz, cp, &tt);
+
+ if (NULL != expr)
rc = apropos_search
(ps->sz, ps->paths, &opt,
expr, tt, (void *)req, resp_search);
if (0 == rc)
resp_baddb();
else if (-1 == rc)
- resp_badexpr(req);
+ resp_search(NULL, 0, (void *)req);
for (i = 0; i < sz; i++)
free(cp[i]);
if (NULL == cache)
cache = "/cache/man.cgi";
- if (NULL == getenv("INSECURE")) {
- insecure = 0;
- if (-1 == chdir(cache)) {
- resp_bad();
- return(EXIT_FAILURE);
- }
+ if (-1 == chdir(cache)) {
+ resp_bad();
+ return(EXIT_FAILURE);
}
host = getenv("HTTP_HOST");
/* Initialise MANPATH. */
memset(&paths, 0, sizeof(struct manpaths));
- if ( ! insecure)
- manpath_manconf("etc/man.conf", &paths);
- else
- manpath_parse(&paths, NULL, NULL);
+ manpath_manconf("etc/catman.conf", &paths);
/* Route pages. */
pg_show(&paths, &req, subpath);
break;
default:
+ resp_error404(path);
break;
}
return(EXIT_SUCCESS);
}
+
+static int
+cmp(const void *p1, const void *p2)
+{
+
+ return(strcasecmp(((const struct res *)p1)->title,
+ ((const struct res *)p2)->title));
+}
+