-/* $Id: cgi.c,v 1.65 2014/07/12 16:14:35 schwarze Exp $ */
+/* $Id: cgi.c,v 1.72 2014/07/13 12:55:45 schwarze Exp $ */
/*
* Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
* Copyright (c) 2014 Ingo Schwarze <schwarze@usta.de>
#include "main.h"
#include "manpath.h"
#include "mansearch.h"
-
-enum page {
- PAGE_INDEX,
- PAGE_SEARCH,
- PAGE_SHOW,
- PAGE__MAX
-};
+#include "cgi.h"
/*
* A query as passed to the search function.
struct query q;
char **p; /* array of available manpaths */
size_t psz; /* number of available manpaths */
- enum page page;
};
static void catman(const struct req *, 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 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(const struct req *, const char *);
static void resp_begin_html(int, const char *);
static void resp_begin_http(int, const char *);
static void resp_end_html(void);
-static void resp_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_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 void resp_show(const struct req *, const char *);
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 */
- "search", /* PAGE_SEARCH */
- "show", /* PAGE_SHOW */
+static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
+static const char *const sec_numbers[] = {
+ "0", "1", "2", "3", "3p", "4", "5", "6", "7", "8", "9"
+};
+static const char *const sec_names[] = {
+ "All Sections",
+ "1 - General Commands",
+ "2 - System Calls",
+ "3 - Subroutines",
+ "3p - Perl Subroutines",
+ "4 - Special Files",
+ "5 - File Formats",
+ "6 - Games",
+ "7 - Macros and Conventions",
+ "8 - Maintenance Commands",
+ "9 - Kernel Interface"
+};
+static const int sec_MAX = sizeof(sec_names) / sizeof(char *);
+
+static const char *const arch_names[] = {
+ "amd64", "alpha", "armish", "armv7",
+ "aviion", "hppa", "hppa64", "i386",
+ "ia64", "landisk", "loongson", "luna88k",
+ "macppc", "mips64", "octeon", "sgi",
+ "socppc", "solbourne", "sparc", "sparc64",
+ "vax", "zaurus",
+ "amiga", "arc", "arm32", "atari",
+ "beagle", "cats", "hp300", "mac68k",
+ "mvme68k", "mvme88k", "mvmeppc", "palm",
+ "pc532", "pegasos", "pmax", "powerpc",
+ "sun3", "wgrisc", "x68k"
};
+static const int arch_MAX = sizeof(arch_names) / sizeof(char *);
/*
* Print a character, escaping HTML along the way.
" 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"
+ "<TITLE>%s</TITLE>\n"
"</HEAD>\n"
"<BODY>\n"
"<!-- Begin page content. //-->\n",
- cssdir, cssdir);
+ CSS_DIR, CSS_DIR, CUSTOMIZE_TITLE);
}
static void
{
int i;
+ puts(CUSTOMIZE_BEGIN);
puts("<!-- Begin search form. //-->");
printf("<DIV ID=\"mancgi\">\n"
- "<FORM ACTION=\"%s/search\" METHOD=\"get\">\n"
+ "<FORM ACTION=\"%s\" METHOD=\"get\">\n"
"<FIELDSET>\n"
- "<LEGEND>Search Parameters</LEGEND>\n"
- "<INPUT TYPE=\"submit\" VALUE=\"Search\"> "
- "for manuals \n",
+ "<LEGEND>Manual Page Search Parameters</LEGEND>\n",
scriptname);
- printf("<SELECT NAME=\"apropos\">\n"
- "<OPTION VALUE=\"0\"");
+
+ /* 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=\"submit\" VALUE=\"Submit\">\n"
+ "<INPUT TYPE=\"reset\" VALUE=\"Reset\">\n");
+
+ /* Write show radio button */
+
+ printf( "</TD><TD>\n"
+ "<INPUT TYPE=\"radio\" ");
if (req->q.equal)
- printf(" SELECTED=\"selected\"");
- printf(">named</OPTION>\n"
- "<OPTION VALUE=\"1\"");
- if (0 == req->q.equal)
- printf(" SELECTED=\"selected\"");
- printf(">matching</OPTION>\n"
- "</SELECT>\n"
- "<INPUT TYPE=\"text\" NAME=\"query\" VALUE=\"");
- 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("CHECKED ");
+ printf( "NAME=\"apropos\" ID=\"show\" VALUE=\"0\">\n"
+ "<LABEL FOR=\"show\">Show named manual page</LABEL>\n");
+
+ /* Write section selector. */
+
+ printf( "</TD></TR><TR><TD>\n"
+ "<SELECT NAME=\"sec\">");
+ for (i = 0; i < sec_MAX; i++) {
+ printf("<OPTION VALUE=\"%s\"", sec_numbers[i]);
+ if (NULL != req->q.sec &&
+ 0 == strcmp(sec_numbers[i], req->q.sec))
+ printf(" SELECTED");
+ printf(">%s</OPTION>\n", sec_names[i]);
+ }
+ puts("</SELECT>");
+
+ /* Write architecture selector. */
+
+ puts("<SELECT NAME=\"arch\">");
+ 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");
+ printf(">%s</OPTION>\n", arch_names[i]);
+ }
+ puts("</SELECT>");
+
+ /* Write manpath selector. */
+
if (req->psz > 1) {
- puts(", in <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=\"selected\" ");
+ printf("SELECTED ");
printf("VALUE=\"");
html_print(req->p[i]);
printf("\">");
}
puts("</SELECT>");
}
- puts("—\n"
- "<INPUT TYPE=\"reset\" VALUE=\"Reset\">\n"
+
+ /* Write search radio button */
+
+ 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");
+
+ puts("</TD></TR></TABLE>\n"
"</FIELDSET>\n"
"</FORM>\n"
"</DIV>");
}
static void
-resp_index(const struct req *req)
+pg_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);
printf("<P>\n"
"This web interface is documented in the "
- "<A HREF=\"%s/search?expr=Nm~^man\\.cgi$&sec=8\">"
- "man.cgi</A> manual, and the "
- "<A HREF=\"%s/search?expr=Nm~^apropos$&sec=1\">"
- "apropos</A> manual explains the query syntax.\n"
+ "<A HREF=\"%s/mandoc/man8/man.cgi.8\">man.cgi</A> "
+ "manual, and the "
+ "<A HREF=\"%s/mandoc/man1/apropos.1\">apropos</A> "
+ "manual explains the query syntax.\n"
"</P>\n",
scriptname, scriptname);
resp_end_html();
}
static void
-resp_noresult(const struct req *req, const char *msg)
+pg_noresult(const struct req *req, const char *msg)
{
resp_begin_html(200, NULL);
resp_searchform(req);
}
static void
-resp_error_badrequest(const char *msg)
+pg_error_badrequest(const char *msg)
{
resp_begin_html(400, "Bad Request");
}
static void
-resp_error_notfound(const char *page)
-{
-
- 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\">main page</A>.\n"
- "</P>", scriptname);
- resp_end_html();
-}
-
-static void
-resp_error_internal(void)
+pg_error_internal(void)
{
resp_begin_html(500, "Internal Server Error");
puts("<P>Internal Server Error</P>");
}
static void
-resp_search(const struct req *req, struct manpage *r, size_t sz)
+pg_searchres(const struct req *req, struct manpage *r, size_t sz)
{
- size_t i;
+ size_t i, iuse, isec;
+ int prio, priouse;
+ char sec;
if (1 == sz) {
/*
* without any delay.
*/
printf("Status: 303 See Other\r\n");
- printf("Location: http://%s%s/show/%s/%s?",
+ printf("Location: http://%s%s/%s/%s?",
httphost, scriptname, req->q.manpath, r[0].file);
http_printquery(req);
printf("\r\n"
for (i = 0; i < sz; i++) {
printf("<TR>\n"
"<TD CLASS=\"title\">\n"
- "<A HREF=\"%s/show/%s/%s?",
+ "<A HREF=\"%s/%s/%s?",
scriptname, req->q.manpath, r[i].file);
html_printquery(req);
printf("\">");
puts("</TABLE>\n"
"</DIV>");
- resp_end_html();
-}
-/* ARGSUSED */
-static void
-pg_index(const struct req *req, char *path)
-{
+ /*
+ * In man(1) mode, show one of the pages
+ * even if more than one is found.
+ */
+
+ if (req->q.equal) {
+ puts("<HR>");
+ iuse = 0;
+ priouse = 10;
+ for (i = 0; i < sz; i++) {
+ isec = strcspn(r[i].file, "123456789");
+ sec = r[i].file[isec];
+ if ('\0' == sec)
+ continue;
+ prio = sec_prios[sec - '1'];
+ if (prio >= priouse)
+ continue;
+ priouse = prio;
+ iuse = i;
+ }
+ resp_show(req, r[iuse].file);
+ }
- resp_index(req);
+ resp_end_html();
}
static void
int italic, bold;
if (NULL == (f = fopen(file, "r"))) {
- resp_error_badrequest(
- "You specified an invalid manual file.");
+ puts("<P>You specified an invalid manual file.</P>");
return;
}
- resp_begin_html(200, NULL);
- resp_searchform(req);
puts("<DIV CLASS=\"catman\">\n"
"<PRE>");
}
puts("</PRE>\n"
- "</DIV>\n"
- "</BODY>\n"
- "</HTML>");
+ "</DIV>");
fclose(f);
}
char opts[PATH_MAX + 128];
if (-1 == (fd = open(file, O_RDONLY, 0))) {
- resp_error_badrequest(
- "You specified an invalid manual file.");
+ puts("<P>You specified an invalid manual file.</P>");
return;
}
if (rc >= MANDOCLEVEL_FATAL) {
fprintf(stderr, "fatal mandoc error: %s/%s\n",
req->q.manpath, file);
- resp_error_internal();
+ pg_error_internal();
return;
}
snprintf(opts, sizeof(opts),
- "fragment,man=%s/search?sec=%%S&expr=Nm~^%%N$",
+ "fragment,man=%s?query=%%N&sec=%%S",
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();
+ pg_error_internal();
mparse_free(mp);
return;
}
- resp_begin_html(200, NULL);
- resp_searchform(req);
-
vp = html_alloc(opts);
if (NULL != mdoc)
else
html_man(vp, man);
- puts("</BODY>\n"
- "</HTML>");
-
html_free(vp);
mparse_free(mp);
}
static void
-pg_show(const struct req *req, char *path)
+resp_show(const struct req *req, const char *file)
+{
+ if ('.' == file[0] || '/' == file[1])
+ file += 2;
+
+ if ('c' == *file)
+ catman(req, file);
+ else
+ format(req, file);
+}
+
+static void
+pg_show(const struct req *req, const char *path)
{
char *sub;
if (NULL == path || NULL == (sub = strchr(path, '/'))) {
- resp_error_badrequest(
+ pg_error_badrequest(
"You did not specify a page to show.");
return;
}
*/
if (-1 == chdir(path)) {
- resp_error_badrequest(
+ pg_error_badrequest(
"You specified an invalid manpath.");
return;
}
- if ('c' == *sub)
- catman(req, sub);
- else
- format(req, sub);
+ resp_begin_html(200, NULL);
+ resp_searchform(req);
+ resp_show(req, sub);
+ resp_end_html();
}
static void
-pg_search(const struct req *req, char *path)
+pg_search(const struct req *req)
{
struct mansearch search;
struct manpaths paths;
*/
if (-1 == (chdir(req->q.manpath))) {
- resp_error_badrequest(
+ pg_error_badrequest(
"You specified an invalid manpath.");
return;
}
}
if (0 == mansearch(&search, &paths, sz, cp, "Nd", &res, &ressz))
- resp_noresult(req, "You entered an invalid query.");
+ pg_noresult(req, "You entered an invalid query.");
else if (0 == ressz)
- resp_noresult(req, "No results found.");
+ pg_noresult(req, "No results found.");
else
- resp_search(req, res, ressz);
+ pg_searchres(req, res, ressz);
for (i = 0; i < sz; i++)
free(cp[i]);
int
main(void)
{
- int i;
struct req req;
- char *querystring, *path, *subpath;
+ const char *path;
+ char *querystring;
+ int i;
/* Scan our run-time environment. */
- if (NULL == (mandir = getenv("MAN_DIR")))
- mandir = "/man";
-
if (NULL == (scriptname = getenv("SCRIPT_NAME")))
scriptname = "";
- if (NULL == (cssdir = getenv("CSS_DIR")))
- cssdir = "";
-
if (NULL == (httphost = getenv("HTTP_HOST")))
httphost = "localhost";
/*
- * First we change directory into the mandir 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(mandir)) {
+ if (-1 == chdir(MAN_DIR)) {
fprintf(stderr, "MAN_DIR: %s: %s\n",
- mandir, strerror(errno));
- resp_error_internal();
+ MAN_DIR, strerror(errno));
+ pg_error_internal();
return(EXIT_FAILURE);
}
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 = getenv("PATH_INFO")) || '\0' == *path)
- req.page = PAGE_INDEX;
-
- if (NULL != path && '/' == *path && '\0' == *++path)
- req.page = PAGE_INDEX;
-
- /* Resolve subpath component. */
-
- if (NULL != path && NULL != (subpath = strchr(path, '/')))
- *subpath++ = '\0';
+ /* Dispatch to the three different pages. */
- /* Map path into one we recognise. */
+ path = getenv("PATH_INFO");
+ if (NULL == path)
+ path = "";
+ else if ('/' == *path)
+ path++;
- 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_error_notfound(path);
- break;
- }
+ if ('\0' != *path)
+ pg_show(&req, path);
+ else if (NULL != req.q.expr)
+ pg_search(&req);
+ else
+ pg_index(&req);
for (i = 0; i < (int)req.psz; i++)
free(req.p[i]);
git.ckatri.com / mandoc.git / blobdiff