From ecea007ac9d1438582e3b8c69ecdb7b7bef77003 Mon Sep 17 00:00:00 2001 From: Ingo Schwarze Date: Tue, 5 Aug 2014 00:42:53 +0000 Subject: Remove the old man.cgi. Running that would not be a responsible thing to do, nowadays. --- Makefile | 51 +-- catman.c | 509 ------------------------- cgi.c | 1202 ----------------------------------------------------------- man-cgi.css | 13 - 4 files changed, 4 insertions(+), 1771 deletions(-) delete mode 100644 catman.c delete mode 100644 cgi.c delete mode 100644 man-cgi.css diff --git a/Makefile b/Makefile index 70ca2da6..fa525808 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -# $Id: Makefile,v 1.395.2.19 2014/08/04 23:45:37 schwarze Exp $ +# $Id: Makefile,v 1.395.2.20 2014/08/05 00:42:53 schwarze Exp $ # # Copyright (c) 2010, 2011, 2012 Kristaps Dzonsons # Copyright (c) 2011, 2013, 2014 Ingo Schwarze @@ -34,22 +34,15 @@ CFLAGS += -DUSE_WCHAR # If your system has manpath(1), uncomment this. This is most any # system that's not OpenBSD or NetBSD. If uncommented, apropos(1), -# mandocdb(8), and man.cgi will popen(3) manpath(1) to get the MANPATH +# and mandocdb(8) will popen(3) manpath(1) to get the MANPATH # variable. #CFLAGS += -DUSE_MANPATH -# If your system does not support static binaries, comment this, -# for example on Mac OS X. -STATIC = -static -# Linux requires -pthread to statically link with libdb. -#STATIC += -pthread - CFLAGS += -g -DHAVE_CONFIG_H CFLAGS += -W -Wall -Wstrict-prototypes -Wno-unused-parameter -Wwrite-strings PREFIX = /usr/local WWWPREFIX = /var/www HTDOCDIR = $(WWWPREFIX)/htdocs -CGIBINDIR = $(WWWPREFIX)/cgi-bin BINDIR = $(PREFIX)/bin INCLUDEDIR = $(PREFIX)/include/mandoc LIBDIR = $(PREFIX)/lib/mandoc @@ -68,7 +61,7 @@ INSTALL_MAN = $(INSTALL_DATA) # comment out apropos and mandocdb. # #DBLIB = -ldb -DBBIN = apropos mandocdb man.cgi catman whatis +DBBIN = apropos mandocdb whatis # === END OF USER SETTINGS ============================================= @@ -97,9 +90,6 @@ SRCS = LICENSE \ arch.in \ att.c \ att.in \ - catman.8 \ - catman.c \ - cgi.c \ chars.c \ chars.in \ compat_fgetln.c \ @@ -132,8 +122,6 @@ SRCS = LICENSE \ main.h \ man.7 \ man.c \ - man.cgi.7 \ - man-cgi.css \ man.h \ man_hash.c \ man_html.c \ @@ -287,25 +275,10 @@ APROPOS_OBJS = apropos.o apropos_db.o manpath.o $(APROPOS_OBJS): config.h mandoc.h mandoc_aux.h manpath.h \ apropos_db.h mandocdb.h -CGI_OBJS = $(MANDOC_HTML_OBJS) \ - $(MANDOC_MAN_OBJS) \ - $(MANDOC_TERM_OBJS) \ - cgi.o \ - apropos_db.o \ - manpath.o \ - out.o \ - tree.o -$(CGI_OBJS): main.h mdoc.h man.h out.h config.h mandoc.h mandoc_aux.h \ - apropos_db.h manpath.h mandocdb.h - -CATMAN_OBJS = catman.o manpath.o -$(CATMAN_OBJS): config.h mandoc_aux.h manpath.h mandocdb.h - DEMANDOC_OBJS = demandoc.o $(DEMANDOC_OBJS): config.h mandoc.h man.h mdoc.h WWW_MANS = apropos.1.html \ - catman.8.html \ demandoc.1.html \ mandoc.1.html \ preconv.1.html \ @@ -314,7 +287,6 @@ WWW_MANS = apropos.1.html \ tbl.3.html \ eqn.7.html \ man.7.html \ - man.cgi.7.html \ mandoc_char.7.html \ mdoc.7.html \ roff.7.html \ @@ -338,8 +310,6 @@ clean: rm -f apropos whatis $(APROPOS_OBJS) rm -f mandocdb $(MANDOCDB_OBJS) rm -f preconv $(PRECONV_OBJS) - rm -f man.cgi $(CGI_OBJS) - rm -f catman $(CATMAN_OBJS) rm -f demandoc $(DEMANDOC_OBJS) rm -f mandoc $(MANDOC_OBJS) rm -f config.h config.log $(COMPAT_OBJS) @@ -363,13 +333,6 @@ install: all $(DESTDIR)$(MANDIR)/man7 $(INSTALL_DATA) example.style.css $(DESTDIR)$(EXAMPLEDIR) -installcgi: all - mkdir -p $(DESTDIR)$(CGIBINDIR) - mkdir -p $(DESTDIR)$(HTDOCDIR) - $(INSTALL_PROGRAM) man.cgi $(DESTDIR)$(CGIBINDIR) - $(INSTALL_DATA) example.style.css $(DESTDIR)$(HTDOCDIR)/man.css - $(INSTALL_DATA) man-cgi.css $(DESTDIR)$(HTDOCDIR) - installwww: www mkdir -p $(DESTDIR)$(HTDOCDIR)/snapshots $(INSTALL_DATA) $(WWW_MANS) style.css $(DESTDIR)$(HTDOCDIR) @@ -397,12 +360,6 @@ whatis: apropos apropos: $(APROPOS_OBJS) libmandoc.a $(CC) $(LDFLAGS) -o $@ $(APROPOS_OBJS) libmandoc.a $(DBLIB) -catman: $(CATMAN_OBJS) libmandoc.a - $(CC) $(LDFLAGS) -o $@ $(CATMAN_OBJS) libmandoc.a $(DBLIB) - -man.cgi: $(CGI_OBJS) libmandoc.a - $(CC) $(LDFLAGS) $(STATIC) -o $@ $(CGI_OBJS) libmandoc.a $(DBLIB) - demandoc: $(DEMANDOC_OBJS) libmandoc.a $(CC) $(LDFLAGS) -o $@ $(DEMANDOC_OBJS) libmandoc.a @@ -420,7 +377,7 @@ config.h: configure config.h.pre config.h.post $(TESTSRCS) rm -f config.log CC="$(CC)" CFLAGS="$(CFLAGS)" VERSION="$(VERSION)" ./configure -.PHONY: clean install installcgi installwww +.PHONY: clean install installwww .SUFFIXES: .1 .3 .5 .7 .8 .h .SUFFIXES: .1.html .3.html .5.html .7.html .8.html .h.html diff --git a/catman.c b/catman.c deleted file mode 100644 index 8767e5e3..00000000 --- a/catman.c +++ /dev/null @@ -1,509 +0,0 @@ -/* $Id: catman.c,v 1.11.2.2 2013/10/11 00:06:48 schwarze Exp $ */ -/* - * Copyright (c) 2011 Kristaps Dzonsons - * - * 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 - * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR 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 -#include -#include - -#include -#include -#include -#include -#include -#include -#include -#include - -#if defined(__linux__) || defined(__sun) -# include -#else -# include -#endif - -#include "manpath.h" -#include "mandocdb.h" - -#define xstrlcpy(_dst, _src, _sz) \ - do if (strlcpy((_dst), (_src), (_sz)) >= (_sz)) { \ - fprintf(stderr, "%s: Path too long", (_dst)); \ - exit(EXIT_FAILURE); \ - } while (/* CONSTCOND */0) - -#define xstrlcat(_dst, _src, _sz) \ - do if (strlcat((_dst), (_src), (_sz)) >= (_sz)) { \ - fprintf(stderr, "%s: Path too long", (_dst)); \ - exit(EXIT_FAILURE); \ - } while (/* CONSTCOND */0) - -static int indexhtml(char *, size_t, char *, size_t); -static int manup(const struct manpaths *, char *); -static int mkpath(char *, mode_t, mode_t); -static int treecpy(char *, char *); -static int update(char *, char *); -static void usage(void); - -static const char *progname; -static int verbose; -static int force; - -int -main(int argc, char *argv[]) -{ - int ch; - char *aux, *base, *conf_file; - struct manpaths dirs; - char buf[MAXPATHLEN]; - extern char *optarg; - extern int optind; - - progname = strrchr(argv[0], '/'); - if (progname == NULL) - progname = argv[0]; - else - ++progname; - - aux = base = conf_file = NULL; - xstrlcpy(buf, "/var/www/cache/man.cgi", MAXPATHLEN); - - while (-1 != (ch = getopt(argc, argv, "C:fm:M:o:v"))) - switch (ch) { - case ('C'): - conf_file = optarg; - break; - case ('f'): - force = 1; - break; - case ('m'): - aux = optarg; - break; - case ('M'): - base = optarg; - break; - case ('o'): - xstrlcpy(buf, optarg, MAXPATHLEN); - break; - case ('v'): - verbose++; - break; - default: - usage(); - return(EXIT_FAILURE); - } - - argc -= optind; - argv += optind; - - if (argc > 0) { - usage(); - return(EXIT_FAILURE); - } - - memset(&dirs, 0, sizeof(struct manpaths)); - manpath_parse(&dirs, conf_file, base, aux); - ch = manup(&dirs, buf); - manpath_free(&dirs); - return(ch ? EXIT_SUCCESS : EXIT_FAILURE); -} - -static void -usage(void) -{ - - fprintf(stderr, "usage: %s " - "[-fv] " - "[-C file] " - "[-o path] " - "[-m manpath] " - "[-M manpath]\n", - progname); -} - -/* - * If "src" file doesn't exist (errors out), return -1. Otherwise, - * return 1 if "src" is newer (which also happens "dst" doesn't exist) - * and 0 otherwise. - */ -static int -isnewer(const char *dst, const char *src) -{ - struct stat s1, s2; - - if (-1 == stat(src, &s1)) - return(-1); - if (force) - return(1); - - return(-1 == stat(dst, &s2) ? 1 : s1.st_mtime > s2.st_mtime); -} - -/* - * Copy the contents of one file into another. - * Returns 0 on failure, 1 on success. - */ -static int -filecpy(const char *dst, const char *src) -{ - char buf[BUFSIZ]; - int sfd, dfd, rc; - ssize_t rsz, wsz; - - sfd = dfd = -1; - rc = 0; - - if (-1 == (dfd = open(dst, O_CREAT|O_TRUNC|O_WRONLY, 0644))) { - perror(dst); - goto out; - } else if (-1 == (sfd = open(src, O_RDONLY, 0))) { - perror(src); - goto out; - } - - while ((rsz = read(sfd, buf, BUFSIZ)) > 0) - if (-1 == (wsz = write(dfd, buf, (size_t)rsz))) { - perror(dst); - goto out; - } else if (wsz < rsz) { - fprintf(stderr, "%s: Short write\n", dst); - goto out; - } - - if (rsz < 0) - perror(src); - else - rc = 1; -out: - if (-1 != sfd) - close(sfd); - if (-1 != dfd) - close(dfd); - - return(rc); -} - -/* - * Pass over the recno database and re-create HTML pages if they're - * found to be out of date. - * Returns -1 on fatal error, 1 on success. - */ -static int -indexhtml(char *src, size_t ssz, char *dst, size_t dsz) -{ - DB *idx; - DBT key, val; - int c, rc; - unsigned int fl; - const char *f; - char *d; - char fname[MAXPATHLEN]; - - xstrlcpy(fname, dst, MAXPATHLEN); - xstrlcat(fname, "/", MAXPATHLEN); - xstrlcat(fname, MANDOC_IDX, MAXPATHLEN); - - idx = dbopen(fname, O_RDONLY, 0, DB_RECNO, NULL); - if (NULL == idx) { - perror(fname); - return(-1); - } - - fl = R_FIRST; - while (0 == (c = (*idx->seq)(idx, &key, &val, fl))) { - fl = R_NEXT; - /* - * If the record is zero-length, then it's unassigned. - * Skip past these. - */ - if (0 == val.size) - continue; - - f = (const char *)val.data + 1; - if (NULL == memchr(f, '\0', val.size - 1)) - break; - - src[(int)ssz] = dst[(int)dsz] = '\0'; - - xstrlcat(dst, "/", MAXPATHLEN); - xstrlcat(dst, f, MAXPATHLEN); - - xstrlcat(src, "/", MAXPATHLEN); - xstrlcat(src, f, MAXPATHLEN); - - if (-1 == (rc = isnewer(dst, src))) { - fprintf(stderr, "%s: File missing\n", f); - break; - } else if (0 == rc) - continue; - - d = strrchr(dst, '/'); - assert(NULL != d); - *d = '\0'; - - if (-1 == mkpath(dst, 0755, 0755)) { - perror(dst); - break; - } - - *d = '/'; - - if ( ! filecpy(dst, src)) - break; - if (verbose) - printf("%s\n", dst); - } - - (*idx->close)(idx); - - if (c < 0) - perror(fname); - else if (0 == c) - fprintf(stderr, "%s: Corrupt index\n", fname); - - return(1 == c ? 1 : -1); -} - -/* - * Copy both recno and btree databases into the destination. - * Call in to begin recreating HTML files. - * Return -1 on fatal error and 1 if the update went well. - */ -static int -update(char *dst, char *src) -{ - size_t dsz, ssz; - - dsz = strlen(dst); - ssz = strlen(src); - - xstrlcat(src, "/", MAXPATHLEN); - xstrlcat(dst, "/", MAXPATHLEN); - - xstrlcat(src, MANDOC_DB, MAXPATHLEN); - xstrlcat(dst, MANDOC_DB, MAXPATHLEN); - - if ( ! filecpy(dst, src)) - return(-1); - if (verbose) - printf("%s\n", dst); - - dst[(int)dsz] = src[(int)ssz] = '\0'; - - xstrlcat(src, "/", MAXPATHLEN); - xstrlcat(dst, "/", MAXPATHLEN); - - xstrlcat(src, MANDOC_IDX, MAXPATHLEN); - xstrlcat(dst, MANDOC_IDX, MAXPATHLEN); - - if ( ! filecpy(dst, src)) - return(-1); - if (verbose) - printf("%s\n", dst); - - dst[(int)dsz] = src[(int)ssz] = '\0'; - - return(indexhtml(src, ssz, dst, dsz)); -} - -/* - * See if btree or recno databases in the destination are out of date - * with respect to a single manpath component. - * Return -1 on fatal error, 0 if the source is no longer valid (and - * shouldn't be listed), and 1 if the update went well. - */ -static int -treecpy(char *dst, char *src) -{ - size_t dsz, ssz; - int rc; - - dsz = strlen(dst); - ssz = strlen(src); - - xstrlcat(src, "/", MAXPATHLEN); - xstrlcat(dst, "/", MAXPATHLEN); - - xstrlcat(src, MANDOC_IDX, MAXPATHLEN); - xstrlcat(dst, MANDOC_IDX, MAXPATHLEN); - - if (-1 == (rc = isnewer(dst, src))) - return(0); - - dst[(int)dsz] = src[(int)ssz] = '\0'; - - if (1 == rc) - return(update(dst, src)); - - xstrlcat(src, "/", MAXPATHLEN); - xstrlcat(dst, "/", MAXPATHLEN); - - xstrlcat(src, MANDOC_DB, MAXPATHLEN); - xstrlcat(dst, MANDOC_DB, MAXPATHLEN); - - if (-1 == (rc = isnewer(dst, src))) - return(0); - else if (rc == 0) - return(1); - - dst[(int)dsz] = src[(int)ssz] = '\0'; - - return(update(dst, src)); -} - -/* - * Update the destination's file-tree with respect to changes in the - * source manpath components. - * "Change" is defined by an updated index or btree database. - * Returns 1 on success, 0 on failure. - */ -static int -manup(const struct manpaths *dirs, char *base) -{ - char dst[MAXPATHLEN], - src[MAXPATHLEN]; - const char *path; - size_t i; - int c; - size_t sz; - FILE *f; - - /* Create the path and file for the catman.conf file. */ - - sz = strlen(base); - xstrlcpy(dst, base, MAXPATHLEN); - xstrlcat(dst, "/etc", MAXPATHLEN); - if (-1 == mkpath(dst, 0755, 0755)) { - perror(dst); - return(0); - } - - xstrlcat(dst, "/catman.conf", MAXPATHLEN); - if (NULL == (f = fopen(dst, "w"))) { - perror(dst); - return(0); - } else if (verbose) - printf("%s\n", dst); - - for (i = 0; i < dirs->sz; i++) { - path = dirs->paths[i]; - dst[(int)sz] = '\0'; - xstrlcat(dst, path, MAXPATHLEN); - if (-1 == mkpath(dst, 0755, 0755)) { - perror(dst); - break; - } - - xstrlcpy(src, path, MAXPATHLEN); - if (-1 == (c = treecpy(dst, src))) - break; - else if (0 == c) - continue; - - /* - * We want to use a relative path here because manpath.h - * will realpath() when invoked with man.cgi, and we'll - * make sure to chdir() into the cache directory before. - * - * This allows the cache directory to be in an arbitrary - * place, working in both chroot() and non-chroot() - * "safe" modes. - */ - assert('/' == path[0]); - fprintf(f, "_whatdb %s/whatis.db\n", path + 1); - } - - fclose(f); - return(i == dirs->sz); -} - -/* - * Copyright (c) 1983, 1992, 1993 - * The Regents of the University of California. All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * 3. Neither the name of the University nor the names of its contributors - * may be used to endorse or promote products derived from this software - * without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND - * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE - * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL - * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS - * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) - * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT - * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY - * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF - * SUCH DAMAGE. - */ -static int -mkpath(char *path, mode_t mode, mode_t dir_mode) -{ - struct stat sb; - char *slash; - int done, exists; - - slash = path; - - for (;;) { - /* LINTED */ - slash += strspn(slash, "/"); - /* LINTED */ - slash += strcspn(slash, "/"); - - done = (*slash == '\0'); - *slash = '\0'; - - /* skip existing path components */ - exists = !stat(path, &sb); - if (!done && exists && S_ISDIR(sb.st_mode)) { - *slash = '/'; - continue; - } - - if (mkdir(path, done ? mode : dir_mode) == 0) { - if (mode > 0777 && chmod(path, mode) < 0) - return (-1); - } else { - if (!exists) { - /* Not there */ - return (-1); - } - if (!S_ISDIR(sb.st_mode)) { - /* Is there, but isn't a directory */ - errno = ENOTDIR; - return (-1); - } - } - - if (done) - break; - - *slash = '/'; - } - - return (0); -} diff --git a/cgi.c b/cgi.c deleted file mode 100644 index 6d40fcde..00000000 --- a/cgi.c +++ /dev/null @@ -1,1202 +0,0 @@ -/* $Id: cgi.c,v 1.45 2013/06/05 02:00:26 schwarze Exp $ */ -/* - * Copyright (c) 2011, 2012 Kristaps Dzonsons - * - * 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 - * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR 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 - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include "apropos_db.h" -#include "mandoc.h" -#include "mdoc.h" -#include "man.h" -#include "main.h" -#include "manpath.h" -#include "mandocdb.h" - -#ifdef __linux__ -# include -#else -# include -#endif - -enum page { - PAGE_INDEX, - PAGE_SEARCH, - PAGE_SHOW, - PAGE__MAX -}; - -struct paths { - char *name; - char *path; -}; - -/* - * 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 legacy; /* whether legacy mode */ -}; - -struct req { - struct query q; - struct paths *p; - size_t psz; - enum page page; -}; - -static int atou(const char *, unsigned *); -static void catman(const struct req *, const char *); -static int cmp(const void *, const void *); -static void format(const struct req *, const char *); -static void html_print(const char *); -static void html_printquery(const struct req *); -static void html_putchar(char); -static int http_decode(char *); -static void http_parse(struct req *, char *); -static void http_print(const char *); -static void http_putchar(char); -static void http_printquery(const struct req *); -static 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 void resp_begin_html(int, const char *); -static void resp_begin_http(int, 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 */ -}; - -/* - * 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 > INT_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 -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; - } -} -static void -http_printquery(const struct req *req) -{ - - printf("&expr="); - http_print(req->q.expr ? req->q.expr : ""); - printf("&sec="); - http_print(req->q.sec ? req->q.sec : ""); - printf("&arch="); - http_print(req->q.arch ? req->q.arch : ""); -} - - -static void -html_printquery(const struct req *req) -{ - - printf("&expr="); - 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 : ""); -} - -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. - */ -static void -html_print(const char *p) -{ - - if (NULL == p) - return; - while ('\0' != *p) - html_putchar(*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 -http_parse(struct req *req, char *p) -{ - char *key, *val, *manroot; - int i, legacy; - - memset(&req->q, 0, sizeof(struct query)); - - legacy = -1; - manroot = NULL; - - while ('\0' != *p) { - key = p; - val = NULL; - - p += (int)strcspn(p, ";&"); - if ('\0' != *p) - *p++ = '\0'; - if (NULL != (val = strchr(key, '='))) - *val++ = '\0'; - - if ('\0' == *key || NULL == val || '\0' == *val) - continue; - - /* Just abort handling. */ - - 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")) - manroot = val; - else if (0 == strcmp(key, "apropos")) - legacy = 0 == strcmp(val, "0"); - } - - /* Test for old man.cgi compatibility mode. */ - - req->q.legacy = legacy > 0; - - /* - * 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; - - /* Default to first manroot. */ - - 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; - } -} - -static void -http_putchar(char c) -{ - - if (isalnum((unsigned char)c)) { - putchar((unsigned char)c); - return; - } else if (' ' == c) { - putchar('+'); - return; - } - printf("%%%.2x", c); -} - -/* - * HTTP-decode a string. The standard explanation is that this turns - * "%4e+foo" into "n foo" in the regular way. This is done in-place - * over the allocated string. - */ -static int -http_decode(char *p) -{ - char hex[3]; - int c; - - hex[2] = '\0'; - - for ( ; '\0' != *p; p++) { - if ('%' == *p) { - if ('\0' == (hex[0] = *(p + 1))) - return(0); - if ('\0' == (hex[1] = *(p + 2))) - return(0); - if (1 != sscanf(hex, "%x", &c)) - return(0); - if ('\0' == c) - return(0); - - *p = (char)c; - memmove(p + 1, p + 3, strlen(p + 3) + 1); - } else - *p = '+' == *p ? ' ' : *p; - } - - *p = '\0'; - return(1); -} - -static void -resp_begin_http(int code, const char *msg) -{ - - if (200 != code) - printf("Status: %d %s\n", code, msg); - - puts("Content-Type: text/html; charset=utf-8\n" - "Cache-Control: no-cache\n" - "Pragma: no-cache\n" - ""); - - fflush(stdout); -} - -static void -resp_begin_html(int code, const char *msg) -{ - - resp_begin_http(code, msg); - - printf("\n" - "\n" - "\n" - "\n" - "\n" - "\n" - "System Manpage Reference\n" - "\n" - "\n" - "\n", css, css); -} - -static void -resp_end_html(void) -{ - - puts("\n" - ""); -} - -static void -resp_searchform(const struct req *req) -{ - int i; - - puts(""); - printf("
\n" - "
\n" - "
\n" - "Search Parameters\n" - " for manuals satisfying \n" - "q.expr ? req->q.expr : ""); - printf("\">, section " - "q.sec ? req->q.sec : ""); - printf("\">, arch " - "q.arch ? req->q.arch : ""); - printf("\">"); - if (req->psz > 1) { - puts(", "); - } - puts(".\n" - "\n" - "
\n" - "
\n" - "
"); - puts(""); -} - -static void -resp_index(const struct req *req) -{ - - resp_begin_html(200, NULL); - resp_searchform(req); - resp_end_html(); -} - -static void -resp_error400(void) -{ - - resp_begin_html(400, "Query Malformed"); - printf("

Malformed Query

\n" - "

\n" - "The query your entered was malformed.\n" - "Try again from the\n" - "main page.\n" - "

", progname); - resp_end_html(); -} - -static void -resp_error404(const char *page) -{ - - resp_begin_html(404, "Not Found"); - puts("

Page Not Found

\n" - "

\n" - "The page you're looking for, "); - printf(""); - html_print(page); - printf(",\n" - "could not be found.\n" - "Try searching from the\n" - "main page.\n" - "

", progname); - resp_end_html(); -} - -static void -resp_bad(void) -{ - resp_begin_html(500, "Internal Server Error"); - puts("

Generic badness happened.

"); - resp_end_html(); -} - -static void -resp_baddb(void) -{ - - resp_begin_html(500, "Internal Server Error"); - puts("

Your database is broken.

"); - resp_end_html(); -} - -static void -resp_search(struct res *r, size_t sz, void *arg) -{ - size_t i, matched; - const struct req *req; - - req = (const struct req *)arg; - - if (sz > 0) - assert(req->q.manroot >= 0); - - for (matched = i = 0; i < sz; i++) - if (r[i].matched) - matched++; - - if (1 == matched) { - for (i = 0; i < sz; i++) - if (r[i].matched) - break; - /* - * 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?", - host, progname, req->q.manroot, - r[i].volume, r[i].rec); - http_printquery(req); - puts("\n" - "Content-Type: text/html; charset=utf-8\n"); - return; - } - - resp_begin_html(200, NULL); - resp_searchform(req); - - puts("
"); - - if (0 == matched) { - puts("

\n" - "No results found.\n" - "

\n" - "
"); - resp_end_html(); - return; - } - - qsort(r, sz, sizeof(struct res), cmp); - - puts(""); - - for (i = 0; i < sz; i++) { - if ( ! r[i].matched) - continue; - printf("\n" - "\n" - "\n" - ""); - } - - puts("
\n" - "q.manroot, - r[i].volume, r[i].rec); - html_printquery(req); - printf("\">"); - 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(")\n" - ""); - html_print(r[i].desc); - puts("
\n" - ""); - resp_end_html(); -} - -/* ARGSUSED */ -static void -pg_index(const struct req *req, char *path) -{ - - resp_index(req); -} - -static void -catman(const struct req *req, const char *file) -{ - FILE *f; - size_t len; - int i; - char *p; - int italic, bold; - - if (NULL == (f = fopen(file, "r"))) { - resp_baddb(); - return; - } - - resp_begin_html(200, NULL); - resp_searchform(req); - puts("
\n" - "
");
-
-	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("");
-				if (bold)
-					printf("");
-				italic = bold = 0;
-				html_putchar(p[i]);
-				continue;
-			} else if (i + 2 >= (int)len)
-				continue;
-
-			/* Italic mode. */
-
-			if ('_' == p[i]) {
-				if (bold)
-					printf("");
-				if ( ! italic)
-					printf("");
-				bold = 0;
-				italic = 1;
-				i += 2;
-				html_putchar(p[i]);
-				continue;
-			}
-
-			/* 
-			 * 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("");
-				if (bold)
-					printf("");
-				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("");
-				if (bold)
-					printf("");
-				italic = bold = 0;
-				putchar('+');
-				i += 2;
-				continue;
-			}
-
-			/* Bold mode. */
-			
-			if (italic)
-				printf("");
-			if ( ! bold)
-				printf("");
-			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. 
-		 */
-
-		if (italic)
-			printf("");
-		if (bold)
-			printf("");
-
-		if (i == (int)len - 1 && '\n' != p[i])
-			html_putchar(p[i]);
-
-		putchar('\n');
-	}
-
-	puts("
\n" - "
\n" - "\n" - ""); - - fclose(f); -} - -static void -format(const struct req *req, const char *file) -{ - struct mparse *mp; - int fd; - struct mdoc *mdoc; - struct man *man; - void *vp; - enum mandoclevel rc; - char opts[PATH_MAX + 128]; - - if (-1 == (fd = open(file, O_RDONLY, 0))) { - resp_baddb(); - return; - } - - mp = mparse_alloc(MPARSE_AUTO, MANDOCLEVEL_FATAL, NULL, NULL, NULL); - rc = mparse_readfd(mp, fd, file); - close(fd); - - if (rc >= MANDOCLEVEL_FATAL) { - resp_baddb(); - return; - } - - snprintf(opts, sizeof(opts), "fragment," - "man=%s/search.html?sec=%%S&expr=Nm~^%%N$," - /*"includes=/cgi-bin/man.cgi/usr/include/%%I"*/, - progname); - - mparse_result(mp, &mdoc, &man); - if (NULL == man && NULL == mdoc) { - resp_baddb(); - mparse_free(mp); - return; - } - - resp_begin_html(200, NULL); - resp_searchform(req); - - vp = html_alloc(opts); - - if (NULL != mdoc) - html_mdoc(vp, mdoc); - else - html_man(vp, man); - - puts("\n" - ""); - - html_free(vp); - mparse_free(mp); -} - -static void -pg_show(const struct req *req, char *path) -{ - struct manpaths ps; - size_t sz; - char *sub; - char file[PATH_MAX]; - const char *cp; - int rc, catm; - unsigned int vol, rec, mr; - DB *idx; - DBT key, val; - - idx = NULL; - - /* Parse out mroot, volume, and record from the path. */ - - 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(); - return; - } - *sub++ = '\0'; - if ( ! atou(path, &vol) || ! atou(sub, &rec)) { - resp_error400(); - return; - } else if (mr >= (unsigned int)req->psz) { - resp_error400(); - return; - } - - /* - * Begin by chdir()ing into the manroot. - * 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(); - return; - } - - memset(&ps, 0, sizeof(struct manpaths)); - manpath_manconf(&ps, "etc/catman.conf"); - - if (vol >= (unsigned int)ps.sz) { - resp_error400(); - goto out; - } - - sz = strlcpy(file, ps.paths[vol], PATH_MAX); - assert(sz < PATH_MAX); - strlcat(file, "/", PATH_MAX); - strlcat(file, MANDOC_IDX, PATH_MAX); - - /* Open the index recno(3) database. */ - - idx = dbopen(file, O_RDONLY, 0, DB_RECNO, NULL); - if (NULL == idx) { - perror(file); - resp_baddb(); - goto out; - } - - key.data = &rec; - key.size = 4; - - if (0 != (rc = (*idx->get)(idx, &key, &val, 0))) { - rc < 0 ? resp_baddb() : resp_error400(); - goto out; - } else if (0 == val.size) { - resp_baddb(); - goto out; - } - - cp = (char *)val.data; - catm = 'c' == *cp++; - - if (NULL == memchr(cp, '\0', val.size - 1)) - resp_baddb(); - else { - file[(int)sz] = '\0'; - strlcat(file, "/", PATH_MAX); - strlcat(file, cp, PATH_MAX); - if (catm) - catman(req, file); - else - format(req, file); - } -out: - if (idx) - (*idx->close)(idx); - manpath_free(&ps); -} - -static void -pg_search(const struct req *req, char *path) -{ - size_t tt, ressz; - struct manpaths ps; - int i, sz, rc; - const char *ep, *start; - struct res *res; - 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; - ressz = 0; - res = NULL; - - /* - * 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. - */ - - 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); - return; - } - - memset(&ps, 0, sizeof(struct manpaths)); - manpath_manconf(&ps, "etc/catman.conf"); - - /* - * 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++; - } - - /* - * Pump down into apropos backend. - * The resp_search() function is called with the results. - */ - - expr = req->q.legacy ? - termcomp(sz, cp, &tt) : exprcomp(sz, cp, &tt); - - if (NULL != expr) - rc = apropos_search - (ps.sz, ps.paths, &opt, expr, tt, - (void *)req, &ressz, &res, resp_search); - - /* ...unless errors occured. */ - - if (0 == rc) - resp_baddb(); - else if (-1 == rc) - resp_search(NULL, 0, NULL); - - for (i = 0; i < sz; i++) - free(cp[i]); - - free(cp); - resfree(res, ressz); - exprfree(expr); - manpath_free(&ps); -} - -int -main(void) -{ - int i; - char buf[PATH_MAX]; - DIR *cwd; - struct req req; - char *p, *path, *subpath; - - /* Scan our run-time environment. */ - - if (NULL == (cache = getenv("CACHE_DIR"))) - cache = "/cache/man.cgi"; - - if (NULL == (progname = getenv("SCRIPT_NAME"))) - progname = ""; - - if (NULL == (css = getenv("CSS_DIR"))) - css = ""; - - if (NULL == (host = getenv("HTTP_HOST"))) - host = "localhost"; - - /* - * First we change directory into the cache directory 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); - } - - memset(&req, 0, sizeof(struct req)); - - strlcpy(buf, ".", PATH_MAX); - 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; - } - - for (i = 0; i < (int)req.psz; i++) { - free(req.p[i].path); - free(req.p[i].name); - } - - 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)); -} - -/* - * 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. - */ -static int -pathstop(DIR *dir) -{ - struct dirent *d; - - while (NULL != (d = readdir(dir))) - if (DT_REG == d->d_type) - if (0 == strcmp(d->d_name, "catman.conf")) - return(1); - - return(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) -{ - struct dirent *d; - char *cp; - DIR *cd; - int rc; - size_t sz, ssz; - - sz = strlcat(path, "/", PATH_MAX); - if (sz >= PATH_MAX) { - 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, PATH_MAX); - - if (ssz >= PATH_MAX) { - fprintf(stderr, "%s: Path too long", path); - return; - } else if (NULL == (cd = opendir(path))) { - perror(path); - return; - } - - rc = pathstop(cd); - closedir(cd); - } - - 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, PATH_MAX); - - if (ssz >= PATH_MAX) { - fprintf(stderr, "%s: Path too long", path); - return; - } else if (NULL == (cd = opendir(path))) { - perror(path); - return; - } - - pathgen(cd, path, req); - closedir(cd); - } -} diff --git a/man-cgi.css b/man-cgi.css deleted file mode 100644 index 5300267c..00000000 --- a/man-cgi.css +++ /dev/null @@ -1,13 +0,0 @@ -body { font-family: Helvetica, Arial, sans-serif; } -body > div { padding-left: 2em; - padding-top: 1em; } -body > div#mancgi { padding-left: 0em; - padding-top: 0em; } -body > div.results { font-size: smaller; } -#mancgi fieldset { text-align: center; - border: thin solid silver; - border-radius: 1em; - font-size: small; } -#mancgi input[name=expr] { width: 25%; } -.results td.title { vertical-align: top; - padding-right: 1em; } -- cgit v1.2.3-56-ge451