-/* $Id: cgi.c,v 1.21 2011/12/09 23:18:51 kristaps Exp $ */
+/* $Id: cgi.c,v 1.61 2014/07/10 00:52:50 schwarze Exp $ */
/*
- * Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2014 Ingo Schwarze <schwarze@usta.de>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
#include "config.h"
#endif
-#include <sys/param.h>
-#include <sys/wait.h>
-
-#include <assert.h>
#include <ctype.h>
#include <errno.h>
#include <fcntl.h>
#include <limits.h>
-#include <regex.h>
#include <stdio.h>
-#include <stdarg.h>
-#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
-#include "apropos_db.h"
#include "mandoc.h"
-#include "mdoc.h"
-#include "man.h"
+#include "mandoc_aux.h"
#include "main.h"
#include "manpath.h"
-
-#ifdef __linux__
-# include <db_185.h>
-#else
-# include <db.h>
-#endif
+#include "mansearch.h"
enum page {
PAGE_INDEX,
/*
* A query as passed to the search function.
- * See kval_query() on how this is parsed.
*/
struct query {
+ const char *manpath; /* desired manual directory */
const char *arch; /* architecture */
const char *sec; /* manual section */
const char *expr; /* unparsed expression string */
- int whatis; /* whether whatis mode */
int legacy; /* whether legacy mode */
};
-struct kval {
- char *key;
- char *val;
-};
-
struct req {
- struct kval *fields;
- size_t fieldsz;
- enum page page;
+ struct query q;
+ char **p; /* array of available manpaths */
+ size_t psz; /* number of available manpaths */
+ enum page page;
};
-static int atou(const char *, unsigned *);
-static void catman(const char *);
+static void catman(const struct req *, const char *);
static int cmp(const void *, const void *);
-static void format(const char *);
+static void format(const struct req *, const char *);
static void html_print(const char *);
+static void html_printquery(const struct req *);
static void html_putchar(char);
-static int kval_decode(char *);
-static void kval_free(struct kval *, size_t);
-static void kval_parse(struct kval **, size_t *, char *);
-static void kval_query(struct query *,
- const struct kval *, size_t);
-static void pg_index(const struct manpaths *,
- const struct req *, char *);
-static void pg_search(const struct manpaths *,
- const struct req *, char *);
-static void pg_show(const struct manpaths *,
- const struct req *, char *);
-static void resp_bad(void);
-static void resp_baddb(void);
-static void resp_error400(void);
-static void resp_error404(const char *);
+static int http_decode(char *);
+static void http_parse(struct req *, char *);
+static void http_print(const char *);
+static void http_putchar(char);
+static void http_printquery(const struct req *);
+static void pathgen(struct req *);
+static void pg_index(const struct req *, char *);
+static void pg_search(const struct req *, char *);
+static void pg_show(const struct req *, 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_error_badrequest(const char *);
+static void resp_error_internal(void);
+static void resp_error_notfound(const char *);
static void resp_index(const struct req *);
-static void resp_search(struct res *, size_t, void *);
+static void resp_noresult(const struct req *,
+ const char *);
+static void resp_search(const struct req *,
+ struct manpage *, size_t);
static void resp_searchform(const struct req *);
-static const char *progname;
-static const char *cache;
-static const char *host;
+static const char *scriptname; /* CGI script name */
+static const char *mandir; /* contains all manpath directories */
+static const char *cssdir; /* css directory */
+static const char *httphost; /* hostname used in the URIs */
static const char * const pages[PAGE__MAX] = {
"index", /* PAGE_INDEX */
"show", /* PAGE_SHOW */
};
-/*
- * Initialise and parse a query structure from input.
- * This accomodates for mdocml's man.cgi and also for legacy man.cgi
- * input keys ("sektion" and "apropos").
- * Note that legacy mode has some quirks: if apropos legacy mode is
- * detected, we unset the section and architecture string.
- */
-static void
-kval_query(struct query *q, const struct kval *fields, size_t sz)
-{
- int i, legacy;
-
- memset(q, 0, sizeof(struct query));
- q->whatis = 1;
- legacy = -1;
-
- for (i = 0; i < (int)sz; i++)
- if (0 == strcmp(fields[i].key, "expr"))
- q->expr = fields[i].val;
- else if (0 == strcmp(fields[i].key, "query"))
- q->expr = fields[i].val;
- else if (0 == strcmp(fields[i].key, "sec"))
- q->sec = fields[i].val;
- else if (0 == strcmp(fields[i].key, "sektion"))
- q->sec = fields[i].val;
- else if (0 == strcmp(fields[i].key, "arch"))
- q->arch = fields[i].val;
- else if (0 == strcmp(fields[i].key, "apropos"))
- legacy = 0 == strcmp
- (fields[i].val, "0");
- else if (0 == strcmp(fields[i].key, "op"))
- q->whatis = 0 == strcasecmp
- (fields[i].val, "whatis");
-
- /* Test for old man.cgi compatibility mode. */
-
- if (legacy == 0) {
- q->whatis = 0;
- q->legacy = 1;
- } else if (legacy > 0) {
- q->legacy = 1;
- q->whatis = 1;
- }
-
- /* Section "0" means no section when in legacy mode. */
-
- if (q->legacy && NULL != q->sec && 0 == strcmp(q->sec, "0"))
- q->sec = NULL;
-}
-
-/*
- * This is just OpenBSD's strtol(3) suggestion.
- * I use it instead of strtonum(3) for portability's sake.
- */
-static int
-atou(const char *buf, unsigned *v)
-{
- char *ep;
- long lval;
-
- errno = 0;
- lval = strtol(buf, &ep, 10);
- if (buf[0] == '\0' || *ep != '\0')
- return(0);
- if ((errno == ERANGE && (lval == LONG_MAX ||
- lval == LONG_MIN)) ||
- (lval > UINT_MAX || lval < 0))
- return(0);
-
- *v = (unsigned int)lval;
- return(1);
-}
-
/*
* Print a character, escaping HTML along the way.
* This will pass non-ASCII straight to output: be warned!
}
}
+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("&expr=");
+ http_print(req->q.expr ? req->q.expr : "");
+ }
+}
+
+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("&expr=");
+ html_print(req->q.expr ? req->q.expr : "");
+ }
+}
+
+static void
+http_print(const char *p)
+{
+
+ if (NULL == p)
+ return;
+ while ('\0' != *p)
+ http_putchar(*p++);
+}
+
/*
* Call through to html_putchar().
* Accepts NULL strings.
html_putchar(*p++);
}
-static void
-kval_free(struct kval *p, size_t sz)
-{
- int i;
-
- for (i = 0; i < (int)sz; i++) {
- free(p[i].key);
- free(p[i].val);
- }
- free(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.
*/
static void
-kval_parse(struct kval **kv, size_t *kvsz, char *p)
+http_parse(struct req *req, char *p)
{
char *key, *val;
- size_t sz, cur;
-
- cur = 0;
+ int legacy;
- while (p && '\0' != *p) {
- while (' ' == *p)
- p++;
+ memset(&req->q, 0, sizeof(struct query));
+ req->q.manpath = req->p[0];
+ legacy = -1;
+ while ('\0' != *p) {
key = p;
val = NULL;
- if (NULL != (p = strchr(p, '='))) {
+ p += (int)strcspn(p, ";&");
+ if ('\0' != *p)
*p++ = '\0';
- val = p;
-
- sz = strcspn(p, ";&");
- /* LINTED */
- p += sz;
-
- if ('\0' != *p)
- *p++ = '\0';
- } else {
- p = key;
- sz = strcspn(p, ";&");
- /* LINTED */
- p += sz;
-
- if ('\0' != *p)
- p++;
- continue;
- }
+ if (NULL != (val = strchr(key, '=')))
+ *val++ = '\0';
- if ('\0' == *key || '\0' == *val)
+ if ('\0' == *key || NULL == val || '\0' == *val)
continue;
/* Just abort handling. */
- if ( ! kval_decode(key))
- return;
- if ( ! kval_decode(val))
- return;
+ if ( ! http_decode(key))
+ break;
+ if (NULL != val && ! http_decode(val))
+ break;
+
+ 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"))
+ req->q.manpath = val;
+ else if (0 == strcmp(key, "apropos"))
+ legacy = 0 == strcmp(val, "0");
+ }
- if (*kvsz + 1 >= cur) {
- cur++;
- *kv = mandoc_realloc
- (*kv, cur * sizeof(struct kval));
- }
+ /* Test for old man.cgi compatibility mode. */
+
+ req->q.legacy = legacy > 0;
- (*kv)[(int)*kvsz].key = mandoc_strdup(key);
- (*kv)[(int)*kvsz].val = mandoc_strdup(val);
- (*kvsz)++;
+ /*
+ * Section "0" means no section when in legacy mode.
+ * For some man.cgi scripts, "default" arch is none.
+ */
+
+ 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;
+}
+
+static void
+http_putchar(char c)
+{
+
+ if (isalnum((unsigned char)c)) {
+ putchar((unsigned char)c);
+ return;
+ } else if (' ' == c) {
+ putchar('+');
+ return;
}
+ printf("%%%.2x", c);
}
/*
* over the allocated string.
*/
static int
-kval_decode(char *p)
+http_decode(char *p)
{
char hex[3];
int c;
resp_begin_http(code, msg);
- puts("<!DOCTYPE HTML PUBLIC "
- " \"-//W3C//DTD HTML 4.01//EN\""
- " \"http://www.w3.org/TR/html4/strict.dtd\">\n"
- "<HTML>\n"
- "<HEAD>\n"
- "<META HTTP-EQUIV=\"Content-Type\""
- " CONTENT=\"text/html; charset=utf-8\">\n"
- "<LINK REL=\"stylesheet\" HREF=\"/man.cgi.css\""
- " TYPE=\"text/css\" media=\"all\">\n"
- "<TITLE>System Manpage Reference</TITLE>\n"
- "</HEAD>\n"
- "<BODY>\n"
- "<!-- Begin page content. //-->");
+ printf("<!DOCTYPE HTML 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>System Manpage Reference</TITLE>\n"
+ "</HEAD>\n"
+ "<BODY>\n"
+ "<!-- Begin page content. //-->\n",
+ cssdir, cssdir);
}
static void
static void
resp_searchform(const struct req *req)
{
- struct query q;
-
- kval_query(&q, req->fields, req->fieldsz);
+ int i;
puts("<!-- Begin search form. //-->");
- printf("<FORM ACTION=\"");
- html_print(progname);
- printf("/search.html\" METHOD=\"get\">\n");
- printf("<FIELDSET>\n"
+ printf("<DIV ID=\"mancgi\">\n"
+ "<FORM ACTION=\"%s/search\" 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=\"");
- html_print(q.expr ? q.expr : "");
+ "<INPUT TYPE=\"submit\" "
+ " VALUE=\"Search\"> for manuals matching \n"
+ "<INPUT TYPE=\"text\" NAME=\"expr\" VALUE=\"",
+ scriptname);
+ html_print(req->q.expr ? req->q.expr : "");
printf("\">, section "
"<INPUT TYPE=\"text\""
" SIZE=\"4\" NAME=\"sec\" VALUE=\"");
- html_print(q.sec ? q.sec : "");
+ html_print(req->q.sec ? req->q.sec : "");
printf("\">, arch "
"<INPUT TYPE=\"text\""
" SIZE=\"8\" NAME=\"arch\" VALUE=\"");
- html_print(q.arch ? q.arch : "");
- puts("\">.\n"
+ html_print(req->q.arch ? req->q.arch : "");
+ printf("\">");
+ if (req->psz > 1) {
+ puts(", in <SELECT NAME=\"manpath\">");
+ for (i = 0; i < (int)req->psz; i++) {
+ printf("<OPTION ");
+ if (NULL == req->q.manpath ? 0 == i :
+ 0 == strcmp(req->q.manpath, req->p[i]))
+ printf("SELECTED=\"selected\" ");
+ printf("VALUE=\"");
+ html_print(req->p[i]);
+ printf("\">");
+ html_print(req->p[i]);
+ puts("</OPTION>");
+ }
+ puts("</SELECT>");
+ }
+ puts("—\n"
"<INPUT TYPE=\"reset\" VALUE=\"Reset\">\n"
"</FIELDSET>\n"
- "</FORM>");
+ "</FORM>\n"
+ "</DIV>");
puts("<!-- End search form. //-->");
}
resp_index(const struct req *req)
{
+ resp_begin_html(200, NULL);
+ puts("<H1>\n"
+ "Online manuals with "
+ "<A HREF=\"http://mdocml.bsd.lv/\">mandoc</A>\n"
+ "</H1>");
+ resp_searchform(req);
+ puts("<P>\n"
+ "This web interface is documented in the "
+ "<A HREF=\"search?expr=Nm~^man\\.cgi$&sec=8\">"
+ "man.cgi</A> manual, and the "
+ "<A HREF=\"search?expr=Nm~^apropos$&sec=1\">"
+ "apropos</A> manual explains the query syntax.\n"
+ "</P>");
+ resp_end_html();
+}
+
+static void
+resp_noresult(const struct req *req, const char *msg)
+{
resp_begin_html(200, NULL);
resp_searchform(req);
+ puts("<P>");
+ puts(msg);
+ puts("</P>");
resp_end_html();
}
static void
-resp_error400(void)
+resp_error_badrequest(const char *msg)
{
- 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_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_error404(const char *page)
+resp_error_notfound(const char *page)
{
resp_begin_html(404, "Not Found");
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_bad(void)
-{
- resp_begin_html(500, "Internal Server Error");
- puts("<P>Generic badness happened.</P>");
+ "<A HREF=\"%s\">main page</A>.\n"
+ "</P>", scriptname);
resp_end_html();
}
static void
-resp_baddb(void)
+resp_error_internal(void)
{
-
resp_begin_html(500, "Internal Server Error");
- puts("<P>Your database is broken.</P>");
+ puts("<P>Internal Server Error</P>");
resp_end_html();
}
static void
-resp_search(struct res *r, size_t sz, void *arg)
+resp_search(const struct req *req, struct manpage *r, size_t sz)
{
- int i;
- struct query q;
- const struct req *req;
+ size_t i;
if (1 == sz) {
/*
* without any delay.
*/
puts("Status: 303 See Other");
- printf("Location: http://%s%s/show/%u/%u.html\n",
- host, progname,
- r[0].volume, r[0].rec);
- puts("Content-Type: text/html; charset=utf-8\n");
+ printf("Location: http://%s%s/show/%s/%s?",
+ httphost, scriptname, req->q.manpath, r[0].file);
+ http_printquery(req);
+ puts("\n"
+ "Content-Type: text/html; charset=utf-8\n");
return;
}
- qsort(r, sz, sizeof(struct res), cmp);
+ qsort(r, sz, sizeof(struct manpage), cmp);
resp_begin_html(200, NULL);
-
- req = (const struct req *)arg;
resp_searchform(req);
- kval_query(&q, req->fields, req->fieldsz);
-
- if (0 == sz) {
- printf("<P>\n"
- "No %s results found.",
- q.whatis ? "whatis" : "apropos");
- if (q.whatis) {
- printf("(Try <A HREF=\"");
- html_print(progname);
- printf("/search.html?op=apropos&expr=");
- html_print(q.expr ? q.expr : "");
- printf("&sec=");
- html_print(q.sec ? q.sec : "");
- printf("&arch=");
- html_print(q.arch ? q.arch : "");
- puts("\">apropos</A>?)");
- }
- puts("</P>");
- resp_end_html();
- return;
- }
+ puts("<DIV CLASS=\"results\">");
+ puts("<TABLE>");
- puts("<P></P>\n"
- "<TABLE>");
-
- for (i = 0; i < (int)sz; i++) {
+ for (i = 0; i < sz; i++) {
printf("<TR>\n"
"<TD CLASS=\"title\">\n"
- "<A HREF=\"");
- html_print(progname);
- printf("/show/%u/%u.html\">", r[i].volume, r[i].rec);
- html_print(r[i].title);
- putchar('(');
- html_print(r[i].cat);
- if (r[i].arch && '\0' != *r[i].arch) {
- putchar('/');
- html_print(r[i].arch);
- }
- printf(")</A>\n"
+ "<A HREF=\"%s/show/%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].desc);
+ html_print(r[i].output);
puts("</TD>\n"
"</TR>");
}
- puts("</TABLE>");
+ puts("</TABLE>\n"
+ "</DIV>");
resp_end_html();
}
/* ARGSUSED */
static void
-pg_index(const struct manpaths *ps, const struct req *req, char *path)
+pg_index(const struct req *req, char *path)
{
resp_index(req);
}
static void
-catman(const char *file)
+catman(const struct req *req, const char *file)
{
FILE *f;
size_t len;
int italic, bold;
if (NULL == (f = fopen(file, "r"))) {
- resp_baddb();
+ resp_error_badrequest(
+ "You specified an invalid manual file.");
return;
}
- resp_begin_http(200, NULL);
- puts("<!DOCTYPE HTML PUBLIC "
- " \"-//W3C//DTD HTML 4.01//EN\""
- " \"http://www.w3.org/TR/html4/strict.dtd\">\n"
- "<HTML>\n"
- "<HEAD>\n"
- "<META HTTP-EQUIV=\"Content-Type\""
- " CONTENT=\"text/html; charset=utf-8\">\n"
- "<LINK REL=\"stylesheet\" HREF=\"/catman.css\""
- " TYPE=\"text/css\" media=\"all\">\n"
- "<TITLE>System Manpage Reference</TITLE>\n"
- "</HEAD>\n"
- "<BODY>\n"
- "<!-- Begin page content. //-->\n"
+ resp_begin_html(200, NULL);
+ resp_searchform(req);
+ puts("<DIV CLASS=\"catman\">\n"
"<PRE>");
while (NULL != (p = fgetln(f, &len))) {
}
puts("</PRE>\n"
+ "</DIV>\n"
"</BODY>\n"
"</HTML>");
}
static void
-format(const char *file)
+format(const struct req *req, const char *file)
{
struct mparse *mp;
int fd;
struct man *man;
void *vp;
enum mandoclevel rc;
- char opts[MAXPATHLEN + 128];
+ char opts[PATH_MAX + 128];
if (-1 == (fd = open(file, O_RDONLY, 0))) {
- resp_baddb();
+ resp_error_badrequest(
+ "You specified an invalid manual file.");
return;
}
- mp = mparse_alloc(MPARSE_AUTO, MANDOCLEVEL_FATAL, NULL, NULL);
+ mp = mparse_alloc(MPARSE_SO, MANDOCLEVEL_FATAL, NULL,
+ req->q.manpath);
rc = mparse_readfd(mp, fd, file);
close(fd);
if (rc >= MANDOCLEVEL_FATAL) {
- resp_baddb();
+ fprintf(stderr, "fatal mandoc error: %s/%s\n",
+ req->q.manpath, file);
+ resp_error_internal();
return;
}
- snprintf(opts, sizeof(opts), "style=/man.css,"
- "man=%s/search.html?sec=%%S&expr=%%N,"
- /*"includes=/cgi-bin/man.cgi/usr/include/%%I"*/,
- progname);
+ snprintf(opts, sizeof(opts),
+ "fragment,man=%s/search?sec=%%S&expr=Nm~^%%N$",
+ scriptname);
+
+ mparse_result(mp, &mdoc, &man, NULL);
+ if (NULL == man && NULL == mdoc) {
+ fprintf(stderr, "fatal mandoc error: %s/%s\n",
+ req->q.manpath, file);
+ resp_error_internal();
+ mparse_free(mp);
+ return;
+ }
+
+ resp_begin_html(200, NULL);
+ resp_searchform(req);
- mparse_result(mp, &mdoc, &man);
vp = html_alloc(opts);
- if (NULL != mdoc) {
- resp_begin_http(200, NULL);
+ if (NULL != mdoc)
html_mdoc(vp, mdoc);
- } else if (NULL != man) {
- resp_begin_http(200, NULL);
+ else
html_man(vp, man);
- } else
- resp_baddb();
+
+ puts("</BODY>\n"
+ "</HTML>");
html_free(vp);
mparse_free(mp);
}
static void
-pg_show(const struct manpaths *ps, const struct req *req, char *path)
+pg_show(const struct req *req, char *path)
{
char *sub;
- char file[MAXPATHLEN];
- const char *fn, *cp;
- int rc;
- unsigned int vol, rec;
- DB *idx;
- DBT key, val;
-
- if (NULL == path) {
- resp_error400();
- return;
- } else if (NULL == (sub = strrchr(path, '/'))) {
- resp_error400();
- return;
- } else
- *sub++ = '\0';
- if ( ! (atou(path, &vol) && atou(sub, &rec))) {
- resp_error400();
- return;
- } else if (vol >= (unsigned int)ps->sz) {
- resp_error400();
+ if (NULL == path || NULL == (sub = strchr(path, '/'))) {
+ resp_error_badrequest(
+ "You did not specify a page to show.");
return;
- }
-
- strlcpy(file, ps->paths[vol], MAXPATHLEN);
- strlcat(file, "/mandoc.index", MAXPATHLEN);
+ }
+ *sub++ = '\0';
- /* Open the index recno(3) database. */
+ /*
+ * Begin by chdir()ing into the manpath.
+ * This way we can pick up the database files, which are
+ * relative to the manpath root.
+ */
- idx = dbopen(file, O_RDONLY, 0, DB_RECNO, NULL);
- if (NULL == idx) {
- resp_baddb();
+ if (-1 == chdir(path)) {
+ resp_error_badrequest(
+ "You specified an invalid manpath.");
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 {
- 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);
+ if ('c' == *sub)
+ catman(req, sub);
+ else
+ format(req, sub);
}
static void
-pg_search(const struct manpaths *ps, const struct req *req, char *path)
+pg_search(const struct req *req, char *path)
{
- size_t tt;
- int i, sz, rc;
- const char *ep, *start;
- char **cp;
- struct opts opt;
- struct expr *expr;
- struct query q;
+ struct mansearch search;
+ struct manpaths paths;
+ struct manpage *res;
+ char **cp;
+ const char *ep, *start;
+ size_t ressz;
+ int i, sz;
- kval_query(&q, req->fields, req->fieldsz);
- memset(&opt, 0, sizeof(struct opts));
+ /*
+ * Begin by chdir()ing into the root of the manpath.
+ * This way we can pick up the database files, which are
+ * relative to the manpath root.
+ */
+
+ if (-1 == (chdir(req->q.manpath))) {
+ resp_error_badrequest(
+ "You specified an invalid manpath.");
+ return;
+ }
+
+ search.arch = req->q.arch;
+ search.sec = req->q.sec;
+ search.deftype = TYPE_Nm | TYPE_Nd;
+ search.flags = 0;
- ep = q.expr;
- opt.arch = q.arch;
- opt.cat = q.sec;
- rc = -1;
- sz = 0;
- cp = NULL;
+ paths.sz = 1;
+ paths.paths = mandoc_malloc(sizeof(char *));
+ paths.paths[0] = mandoc_strdup(".");
/*
- * Poor man's tokenisation.
- * Just break apart by spaces.
+ * Poor man's tokenisation: just break apart by spaces.
* Yes, this is half-ass. But it works for now.
*/
+ ep = req->q.expr;
while (ep && isspace((unsigned char)*ep))
ep++;
+ sz = 0;
+ cp = NULL;
while (ep && '\0' != *ep) {
- cp = mandoc_realloc(cp, (sz + 1) * sizeof(char *));
+ cp = mandoc_reallocarray(cp, sz + 1, sizeof(char *));
start = ep;
while ('\0' != *ep && ! isspace((unsigned char)*ep))
ep++;
ep++;
}
- /*
- * Pump down into apropos backend.
- * The resp_search() function is called with the results.
- */
-
- expr = q.whatis ? termcomp(sz, cp, &tt) :
- exprcomp(sz, cp, &tt);
-
- if (NULL != expr)
- rc = apropos_search
- (ps->sz, ps->paths, &opt,
- expr, tt, (void *)req, resp_search);
-
- /* ...unless errors occured. */
-
- if (0 == rc)
- resp_baddb();
- else if (-1 == rc)
- resp_search(NULL, 0, (void *)req);
+ if (0 == mansearch(&search, &paths, sz, cp, "Nd", &res, &ressz))
+ resp_noresult(req, "You entered an invalid query.");
+ else if (0 == ressz)
+ resp_noresult(req, "No results found.");
+ else
+ resp_search(req, res, ressz);
for (i = 0; i < sz; i++)
free(cp[i]);
-
free(cp);
- exprfree(expr);
+
+ for (i = 0; i < (int)ressz; i++) {
+ free(res[i].file);
+ free(res[i].names);
+ free(res[i].output);
+ }
+ free(res);
+
+ free(paths.paths[0]);
+ free(paths.paths);
}
int
{
int i;
struct req req;
- char *p, *path, *subpath;
- struct manpaths paths;
+ char *querystring, *path, *subpath;
- /* HTTP init: read and parse the query string. */
+ /* Scan our run-time environment. */
- progname = getenv("SCRIPT_NAME");
- if (NULL == progname)
- progname = "";
+ if (NULL == (mandir = getenv("MAN_DIR")))
+ mandir = "/man";
- cache = getenv("CACHE_DIR");
- if (NULL == cache)
- cache = "/cache/man.cgi";
+ if (NULL == (scriptname = getenv("SCRIPT_NAME")))
+ scriptname = "";
- if (-1 == chdir(cache)) {
- resp_bad();
- return(EXIT_FAILURE);
- }
+ if (NULL == (cssdir = getenv("CSS_DIR")))
+ cssdir = "";
+
+ if (NULL == (httphost = getenv("HTTP_HOST")))
+ httphost = "localhost";
+
+ /*
+ * First we change directory into the mandir so that
+ * subsequent scanning for manpath directories is rooted
+ * relative to the same position.
+ */
- host = getenv("HTTP_HOST");
- if (NULL == host)
- host = "localhost";
+ if (-1 == chdir(mandir)) {
+ fprintf(stderr, "MAN_DIR: %s: %s\n",
+ mandir, strerror(errno));
+ resp_error_internal();
+ return(EXIT_FAILURE);
+ }
memset(&req, 0, sizeof(struct req));
+ pathgen(&req);
- if (NULL != (p = getenv("QUERY_STRING")))
- kval_parse(&req.fields, &req.fieldsz, p);
+ /* Next parse out the query string. */
- /* Resolve leading subpath component. */
+ if (NULL != (querystring = getenv("QUERY_STRING")))
+ http_parse(&req, querystring);
+
+ /*
+ * 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 && '/' == *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, '/')))
break;
}
- /* Initialise MANPATH. */
-
- memset(&paths, 0, sizeof(struct manpaths));
- manpath_manconf("etc/catman.conf", &paths);
-
/* Route pages. */
switch (req.page) {
case (PAGE_INDEX):
- pg_index(&paths, &req, subpath);
+ pg_index(&req, subpath);
break;
case (PAGE_SEARCH):
- pg_search(&paths, &req, subpath);
+ pg_search(&req, subpath);
break;
case (PAGE_SHOW):
- pg_show(&paths, &req, subpath);
+ pg_show(&req, subpath);
break;
default:
- resp_error404(path);
+ resp_error_notfound(path);
break;
}
- manpath_free(&paths);
- kval_free(req.fields, req.fieldsz);
-
+ for (i = 0; i < (int)req.psz; i++)
+ free(req.p[i]);
+ free(req.p);
return(EXIT_SUCCESS);
}
cmp(const void *p1, const void *p2)
{
- return(strcasecmp(((const struct res *)p1)->title,
- ((const struct res *)p2)->title));
+ return(strcasecmp(((const struct manpage *)p1)->names,
+ ((const struct manpage *)p2)->names));
}
+/*
+ * Scan for indexable paths.
+ */
+static void
+pathgen(struct req *req)
+{
+ FILE *fp;
+ char *dp;
+ size_t dpsz;
+
+ if (NULL == (fp = fopen("manpath.conf", "r")))
+ return;
+
+ while (NULL != (dp = fgetln(fp, &dpsz))) {
+ if ('\n' == dp[dpsz - 1])
+ dpsz--;
+ req->p = mandoc_realloc(req->p,
+ (req->psz + 1) * sizeof(char *));
+ req->p[req->psz++] = mandoc_strndup(dp, dpsz);
+ }
+}
git.ckatri.com / mandoc.git / blobdiff