[BACK]Return to cgi.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/cgi.c between version 1.19 and 1.79

version 1.19, 2011/12/08 22:47:09 version 1.79, 2014/07/21 22:33:01
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * 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   * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above   * purpose with or without fee is hereby granted, provided that the above
Line 18 
Line 19 
 #include "config.h"  #include "config.h"
 #endif  #endif
   
 #include <sys/param.h>  
 #include <sys/wait.h>  
   
 #include <assert.h>  
 #include <ctype.h>  #include <ctype.h>
 #include <errno.h>  #include <errno.h>
 #include <fcntl.h>  #include <fcntl.h>
 #include <limits.h>  #include <limits.h>
 #include <regex.h>  
 #include <stdio.h>  #include <stdio.h>
 #include <stdarg.h>  
 #include <stdint.h>  
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
 #include <unistd.h>  #include <unistd.h>
   
 #include "apropos_db.h"  
 #include "mandoc.h"  #include "mandoc.h"
 #include "mdoc.h"  #include "mandoc_aux.h"
 #include "man.h"  
 #include "main.h"  #include "main.h"
 #include "manpath.h"  #include "manpath.h"
   #include "mansearch.h"
   #include "cgi.h"
   
 #ifdef __linux__  /*
 # include <db_185.h>   * A query as passed to the search function.
 #else   */
 # include <db.h>  struct  query {
 #endif          const char      *manpath; /* desired manual directory */
           const char      *arch; /* architecture */
 enum    page {          const char      *sec; /* manual section */
         PAGE_INDEX,          const char      *expr; /* unparsed expression string */
         PAGE_SEARCH,          int              equal; /* match whole names, not substrings */
         PAGE_SHOW,  
         PAGE__MAX  
 };  };
   
 struct  kval {  
         char            *key;  
         char            *val;  
 };  
   
 struct  req {  struct  req {
         struct kval     *fields;          struct query      q;
         size_t           fieldsz;          char            **p; /* array of available manpaths */
         enum page        page;          size_t            psz; /* number of available manpaths */
 };  };
   
 static  int              atou(const char *, unsigned *);  static  void             catman(const struct req *, const char *);
 static  void             catman(const char *);  
 static  int              cmp(const void *, const void *);  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_print(const char *);
   static  void             html_printquery(const struct req *);
 static  void             html_putchar(char);  static  void             html_putchar(char);
 static  int              kval_decode(char *);  static  int              http_decode(char *);
 static  void             kval_parse(struct kval **, size_t *, char *);  static  void             http_parse(struct req *, char *);
 static  void             kval_free(struct kval *, size_t);  static  void             http_print(const char *);
 static  void             pg_index(const struct manpaths *,  static  void             http_putchar(char);
                                 const struct req *, char *);  static  void             http_printquery(const struct req *);
 static  void             pg_search(const struct manpaths *,  static  void             pathgen(struct req *);
                                 const struct req *, char *);  static  void             pg_error_badrequest(const char *);
 static  void             pg_show(const struct manpaths *,  static  void             pg_error_internal(void);
                                 const struct req *, char *);  static  void             pg_index(const struct req *);
 static  void             resp_bad(void);  static  void             pg_noresult(const struct req *, const char *);
 static  void             resp_baddb(void);  static  void             pg_search(const struct req *);
 static  void             resp_error400(void);  static  void             pg_searchres(const struct req *,
 static  void             resp_error404(const char *);                                  struct manpage *, size_t);
   static  void             pg_show(struct req *, const char *);
 static  void             resp_begin_html(int, const char *);  static  void             resp_begin_html(int, const char *);
 static  void             resp_begin_http(int, const char *);  static  void             resp_begin_http(int, const char *);
 static  void             resp_end_html(void);  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  void             resp_searchform(const struct req *);
   static  void             resp_show(const struct req *, const char *);
   
 static  const char       *progname;  static  const char       *scriptname; /* CGI script name */
 static  const char       *cache;  
 static  const char       *host;  
   
 static  const char * const pages[PAGE__MAX] = {  static  const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
         "index", /* PAGE_INDEX */  static  const char *const sec_numbers[] = {
         "search", /* PAGE_SEARCH */      "0", "1", "2", "3", "3p", "4", "5", "6", "7", "8", "9"
         "show", /* PAGE_SHOW */  
 };  };
   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 *);
   
 /*  /*
  * This is just OpenBSD's strtol(3) suggestion.   * Print a character, escaping HTML along the way.
  * I use it instead of strtonum(3) for portability's sake.   * This will pass non-ASCII straight to output: be warned!
  */   */
 static int  
 atou(const char *buf, unsigned *v)  
 {  
         char            *ep;  
         long             lval;  
   
         errno = 0;  
         lval = strtol(buf, &ep, 10);  
         if (buf[0] == '\0' || *ep != '\0')  
                 return(0);  
         if ((errno == ERANGE && (lval == LONG_MAX ||  
                                         lval == LONG_MIN)) ||  
                         (lval > UINT_MAX || lval < 0))  
                 return(0);  
   
         *v = (unsigned int)lval;  
         return(1);  
 }  
   
 static void  static void
 html_putchar(char c)  html_putchar(char c)
 {  {
Line 147  html_putchar(char c)
Line 141  html_putchar(char c)
         }          }
 }  }
   
   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("&query=");
                   http_print(req->q.expr);
           }
           if (0 == req->q.equal)
                   printf("&apropos=1");
   }
   
   static void
   html_printquery(const struct req *req)
   {
   
           if (NULL != req->q.manpath) {
                   printf("&amp;manpath=");
                   html_print(req->q.manpath);
           }
           if (NULL != req->q.sec) {
                   printf("&amp;sec=");
                   html_print(req->q.sec);
           }
           if (NULL != req->q.arch) {
                   printf("&amp;arch=");
                   html_print(req->q.arch);
           }
           if (NULL != req->q.expr) {
                   printf("&amp;query=");
                   html_print(req->q.expr);
           }
           if (0 == req->q.equal)
                   printf("&amp;apropos=1");
   }
   
   static void
   http_print(const char *p)
   {
   
           if (NULL == p)
                   return;
           while ('\0' != *p)
                   http_putchar(*p++);
   }
   
 /*  /*
  * Print a word, escaping HTML along the way.   * Call through to html_putchar().
  * This will pass non-ASCII straight to output: be warned!   * Accepts NULL strings.
  */   */
 static void  static void
 html_print(const char *p)  html_print(const char *p)
Line 161  html_print(const char *p)
Line 213  html_print(const char *p)
                 html_putchar(*p++);                  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.   * Parse out key-value pairs from an HTTP request variable.
  * This can be either a cookie or a POST/GET string, although man.cgi   * This can be either a cookie or a POST/GET string, although man.cgi
  * uses only GET for simplicity.   * uses only GET for simplicity.
  */   */
 static void  static void
 kval_parse(struct kval **kv, size_t *kvsz, char *p)  http_parse(struct req *req, char *p)
 {  {
         char            *key, *val;          char            *key, *val;
         size_t           sz, cur;  
   
         cur = 0;          memset(&req->q, 0, sizeof(struct query));
           req->q.manpath = req->p[0];
           req->q.equal = 1;
   
         while (p && '\0' != *p) {          while ('\0' != *p) {
                 while (' ' == *p)  
                         p++;  
   
                 key = p;                  key = p;
                 val = NULL;                  val = NULL;
   
                 if (NULL != (p = strchr(p, '='))) {                  p += (int)strcspn(p, ";&");
                   if ('\0' != *p)
                         *p++ = '\0';                          *p++ = '\0';
                         val = p;                  if (NULL != (val = strchr(key, '=')))
                           *val++ = '\0';
   
                         sz = strcspn(p, ";&");                  if ('\0' == *key || NULL == val || '\0' == *val)
                         /* LINTED */  
                         p += sz;  
   
                         if ('\0' != *p)  
                                 *p++ = '\0';  
                 } else {  
                         p = key;  
                         sz = strcspn(p, ";&");  
                         /* LINTED */  
                         p += sz;  
   
                         if ('\0' != *p)  
                                 p++;  
                         continue;                          continue;
                 }  
   
                 if ('\0' == *key || '\0' == *val)  
                         continue;  
   
                 /* Just abort handling. */                  /* Just abort handling. */
   
                 if ( ! kval_decode(key))                  if ( ! http_decode(key))
                         return;                          break;
                 if ( ! kval_decode(val))                  if (NULL != val && ! http_decode(val))
                         return;                          break;
   
                 if (*kvsz + 1 >= cur) {                  if (0 == strcmp(key, "query"))
                         cur++;                          req->q.expr = val;
                         *kv = mandoc_realloc                  else if (0 == strcmp(key, "manpath")) {
                                 (*kv, cur * sizeof(struct kval));  #ifdef COMPAT_OLDURI
                           if (0 == strncmp(val, "OpenBSD ", 8)) {
                                   val[7] = '-';
                                   if ('C' == val[8])
                                           val[8] = 'c';
                           }
   #endif
                           req->q.manpath = val;
                   } else if (0 == strcmp(key, "apropos"))
                           req->q.equal = !strcmp(val, "0");
                   else if (0 == strcmp(key, "sec")) {
                           if (strcmp(val, "0"))
                                   req->q.sec = val;
   #ifdef COMPAT_OLDURI
                   } else if (0 == strcmp(key, "sektion")) {
                           if (strcmp(val, "0"))
                                   req->q.sec = val;
   #endif
                   } else if (0 == strcmp(key, "arch")) {
                           if (strcmp(val, "default"))
                                   req->q.arch = val;
                 }                  }
           }
   }
   
                 (*kv)[(int)*kvsz].key = mandoc_strdup(key);  static void
                 (*kv)[(int)*kvsz].val = mandoc_strdup(val);  http_putchar(char c)
                 (*kvsz)++;  {
   
           if (isalnum((unsigned char)c)) {
                   putchar((unsigned char)c);
                   return;
           } else if (' ' == c) {
                   putchar('+');
                   return;
         }          }
           printf("%%%.2x", c);
 }  }
   
 /*  /*
Line 242  kval_parse(struct kval **kv, size_t *kvsz, char *p)
Line 295  kval_parse(struct kval **kv, size_t *kvsz, char *p)
  * over the allocated string.   * over the allocated string.
  */   */
 static int  static int
 kval_decode(char *p)  http_decode(char *p)
 {  {
         char             hex[3];          char             hex[3];
           char            *q;
         int              c;          int              c;
   
         hex[2] = '\0';          hex[2] = '\0';
   
         for ( ; '\0' != *p; p++) {          q = p;
           for ( ; '\0' != *p; p++, q++) {
                 if ('%' == *p) {                  if ('%' == *p) {
                         if ('\0' == (hex[0] = *(p + 1)))                          if ('\0' == (hex[0] = *(p + 1)))
                                 return(0);                                  return(0);
Line 260  kval_decode(char *p)
Line 315  kval_decode(char *p)
                         if ('\0' == c)                          if ('\0' == c)
                                 return(0);                                  return(0);
   
                         *p = (char)c;                          *q = (char)c;
                         memmove(p + 1, p + 3, strlen(p + 3) + 1);                          p += 2;
                 } else                  } else
                         *p = '+' == *p ? ' ' : *p;                          *q = '+' == *p ? ' ' : *p;
         }          }
   
         *p = '\0';          *q = '\0';
         return(1);          return(1);
 }  }
   
Line 275  resp_begin_http(int code, const char *msg)
Line 330  resp_begin_http(int code, const char *msg)
 {  {
   
         if (200 != code)          if (200 != code)
                 printf("Status: %d %s\n", code, msg);                  printf("Status: %d %s\r\n", code, msg);
   
         puts("Content-Type: text/html; charset=utf-8"           "\n"          printf("Content-Type: text/html; charset=utf-8\r\n"
              "Cache-Control: no-cache"                          "\n"               "Cache-Control: no-cache\r\n"
              "Pragma: no-cache"                                 "\n"               "Pragma: no-cache\r\n"
              "");               "\r\n");
   
         fflush(stdout);          fflush(stdout);
 }  }
Line 291  resp_begin_html(int code, const char *msg)
Line 346  resp_begin_html(int code, const char *msg)
   
         resp_begin_http(code, msg);          resp_begin_http(code, msg);
   
         puts("<!DOCTYPE HTML PUBLIC "                           "\n"          printf("<!DOCTYPE HTML PUBLIC "
              " \"-//W3C//DTD HTML 4.01//EN\""                   "\n"                 " \"-//W3C//DTD HTML 4.01//EN\""
              " \"http://www.w3.org/TR/html4/strict.dtd\">"      "\n"                 " \"http://www.w3.org/TR/html4/strict.dtd\">\n"
              "<HTML>"                                           "\n"                 "<HTML>\n"
              " <HEAD>"                                          "\n"                 "<HEAD>\n"
              "  <META HTTP-EQUIV=\"Content-Type\" "             "\n"                 "<META HTTP-EQUIV=\"Content-Type\""
              "        CONTENT=\"text/html; charset=utf-8\">"    "\n"                 " CONTENT=\"text/html; charset=utf-8\">\n"
              "  <LINK REL=\"stylesheet\" HREF=\"/man.cgi.css\"" "\n"                 "<LINK REL=\"stylesheet\" HREF=\"%s/man-cgi.css\""
              "        TYPE=\"text/css\" media=\"all\">"         "\n"                 " TYPE=\"text/css\" media=\"all\">\n"
              "  <TITLE>System Manpage Reference</TITLE>"        "\n"                 "<LINK REL=\"stylesheet\" HREF=\"%s/man.css\""
              " </HEAD>"                                         "\n"                 " TYPE=\"text/css\" media=\"all\">\n"
              " <BODY>"                                          "\n"                 "<TITLE>%s</TITLE>\n"
              "<!-- Begin page content. //-->");                 "</HEAD>\n"
                  "<BODY>\n"
                  "<!-- Begin page content. //-->\n",
                  CSS_DIR, CSS_DIR, CUSTOMIZE_TITLE);
 }  }
   
 static void  static void
 resp_end_html(void)  resp_end_html(void)
 {  {
   
         puts(" </BODY>\n</HTML>");          puts("</BODY>\n"
                "</HTML>");
 }  }
   
 static void  static void
 resp_searchform(const struct req *req)  resp_searchform(const struct req *req)
 {  {
         int              i;          int              i;
         const char      *expr, *sec, *arch;  
   
         expr = sec = arch = "";          puts(CUSTOMIZE_BEGIN);
           puts("<!-- Begin search form. //-->");
           printf("<DIV ID=\"mancgi\">\n"
                  "<FORM ACTION=\"%s\" METHOD=\"get\">\n"
                  "<FIELDSET>\n"
                  "<LEGEND>Manual Page Search Parameters</LEGEND>\n",
                  scriptname);
   
         for (i = 0; i < (int)req->fieldsz; i++)          /* Write query input box. */
                 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"))          printf( "<TABLE><TR><TD>\n"
                 sec = NULL;                  "<INPUT TYPE=\"text\" NAME=\"query\" VALUE=\"");
           if (NULL != req->q.expr)
                   html_print(req->q.expr);
           puts("\" SIZE=\"40\">");
   
         puts("<!-- Begin search form. //-->");          /* Write submission and reset buttons. */
         printf("<FORM ACTION=\"");  
         html_print(progname);          printf( "<INPUT TYPE=\"submit\" VALUE=\"Submit\">\n"
         printf("/search.html\" METHOD=\"get\">\n");                  "<INPUT TYPE=\"reset\" VALUE=\"Reset\">\n");
         printf("<FIELDSET>\n"  
                "<LEGEND>Search Parameters</LEGEND>\n"          /* Write show radio button */
                "<INPUT TYPE=\"submit\" NAME=\"op\" "  
                 "VALUE=\"Whatis\"> or \n"          printf( "</TD><TD>\n"
                "<INPUT TYPE=\"submit\" NAME=\"op\" "                  "<INPUT TYPE=\"radio\" ");
                 "VALUE=\"apropos\"> for manuals satisfying \n"          if (req->q.equal)
                "<INPUT TYPE=\"text\" NAME=\"expr\" VALUE=\"");                  printf("CHECKED ");
         html_print(expr);          printf( "NAME=\"apropos\" ID=\"show\" VALUE=\"0\">\n"
         printf("\">, section "                  "<LABEL FOR=\"show\">Show named manual page</LABEL>\n");
                "<INPUT TYPE=\"text\" "  
                 "SIZE=\"4\" NAME=\"sec\" VALUE=\"");          /* Write section selector. */
         html_print(sec);  
         printf("\">, arch "          printf( "</TD></TR><TR><TD>\n"
                "<INPUT TYPE=\"text\" "                  "<SELECT NAME=\"sec\">");
                 "SIZE=\"8\" NAME=\"arch\" VALUE=\"");          for (i = 0; i < sec_MAX; i++) {
         html_print(arch);                  printf("<OPTION VALUE=\"%s\"", sec_numbers[i]);
         puts("\">.\n"                  if (NULL != req->q.sec &&
              "<INPUT TYPE=\"reset\" VALUE=\"Reset\">\n"                      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("<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 ");
                           printf("VALUE=\"");
                           html_print(req->p[i]);
                           printf("\">");
                           html_print(req->p[i]);
                           puts("</OPTION>");
                   }
                   puts("</SELECT>");
           }
   
           /* 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"               "</FIELDSET>\n"
              "</FORM>\n"               "</FORM>\n"
              "<!-- End search form. //-->");               "</DIV>");
           puts("<!-- End search form. //-->");
 }  }
   
 static void  static int
 resp_index(const struct req *req)  validate_manpath(const struct req *req, const char* manpath)
 {  {
           size_t   i;
   
         resp_begin_html(200, NULL);          if ( ! strcmp(manpath, "mandoc"))
         resp_searchform(req);                  return(1);
         resp_end_html();  
           for (i = 0; i < req->psz; i++)
                   if ( ! strcmp(manpath, req->p[i]))
                           return(1);
   
           return(0);
 }  }
   
 static void  static int
 resp_error400(void)  validate_filename(const char *file)
 {  {
   
         resp_begin_html(400, "Query Malformed");          if ('.' == file[0] && '/' == file[1])
         printf("<H1>Malformed Query</H1>\n"                  file += 2;
                "<P>\n"  
                "  The query your entered was malformed.\n"          return ( ! (strstr(file, "../") || strstr(file, "/..") ||
                "  Try again from the\n"              (strncmp(file, "man", 3) && strncmp(file, "cat", 3))));
                "  <A HREF=\"%s/index.html\">main page</A>\n"  
                "</P>", progname);  
         resp_end_html();  
 }  }
   
 static void  static void
 resp_error404(const char *page)  pg_index(const struct req *req)
 {  {
   
         resp_begin_html(404, "Not Found");          resp_begin_html(200, NULL);
         puts("<H1>Page Not Found</H1>\n"          resp_searchform(req);
              "<P>\n"          printf("<P>\n"
              "  The page you're looking for, ");                 "This web interface is documented in the "
         printf("  <B>");                 "<A HREF=\"%s/mandoc/man8/man.cgi.8\">man.cgi</A> "
         html_print(page);                 "manual, and the "
         printf("</B>,\n"                 "<A HREF=\"%s/mandoc/man1/apropos.1\">apropos</A> "
                "  could not be found.\n"                 "manual explains the query syntax.\n"
                "  Try searching from the\n"                 "</P>\n",
                "  <A HREF=\"%s/index.html\">main page</A>\n"                 scriptname, scriptname);
                "</P>", progname);  
         resp_end_html();          resp_end_html();
 }  }
   
 static void  static void
 resp_bad(void)  pg_noresult(const struct req *req, const char *msg)
 {  {
         resp_begin_html(500, "Internal Server Error");          resp_begin_html(200, NULL);
         puts("<P>Generic badness happened.</P>");          resp_searchform(req);
           puts("<P>");
           puts(msg);
           puts("</P>");
         resp_end_html();          resp_end_html();
 }  }
   
 static void  static void
 resp_baddb(void)  pg_error_badrequest(const char *msg)
 {  {
   
           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
   pg_error_internal(void)
   {
         resp_begin_html(500, "Internal Server Error");          resp_begin_html(500, "Internal Server Error");
         puts("<P>Your database is broken.</P>");          puts("<P>Internal Server Error</P>");
         resp_end_html();          resp_end_html();
 }  }
   
 static void  static void
 resp_search(struct res *r, size_t sz, void *arg)  pg_searchres(const struct req *req, struct manpage *r, size_t sz)
 {  {
         int              i, whatis;          size_t           i, iuse, isec;
         const char      *ep, *sec, *arch;          int              prio, priouse;
         const struct req *req;          char             sec;
   
         whatis = 1;          for (i = 0; i < sz; i++) {
         ep = sec = arch = NULL;                  if (validate_filename(r[i].file))
                           continue;
                   fprintf(stderr, "invalid filename %s in %s database\n",
                       r[i].file, req->q.manpath);
                   pg_error_internal();
                   return;
           }
   
         if (1 == sz) {          if (1 == sz) {
                 /*                  /*
                  * If we have just one result, then jump there now                   * If we have just one result, then jump there now
                  * without any delay.                   * without any delay.
                  */                   */
                 puts("Status: 303 See Other");                  printf("Status: 303 See Other\r\n");
                 printf("Location: http://%s%s/show/%u/%u.html\n",                  printf("Location: http://%s%s/%s/%s?",
                                 host, progname,                      HTTP_HOST, scriptname, req->q.manpath, r[0].file);
                                 r[0].volume, r[0].rec);                  http_printquery(req);
                 puts("Content-Type: text/html; charset=utf-8\n");                  printf("\r\n"
                        "Content-Type: text/html; charset=utf-8\r\n"
                        "\r\n");
                 return;                  return;
         }          }
   
         req = (const struct req *)arg;          qsort(r, sz, sizeof(struct manpage), cmp);
   
         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_begin_html(200, NULL);
         resp_searchform(req);          resp_searchform(req);
           puts("<DIV CLASS=\"results\">");
           puts("<TABLE>");
   
         if (0 == sz) {          for (i = 0; i < sz; i++) {
                 puts("<P>\n"                  printf("<TR>\n"
                      "No results found.");                         "<TD CLASS=\"title\">\n"
                 if (whatis) {                         "<A HREF=\"%s/%s/%s?",
                         printf("(Try <A HREF=\"");                      scriptname, req->q.manpath, r[i].file);
                         html_print(progname);                  html_printquery(req);
                         printf("/search.html?op=apropos&amp;expr=");                  printf("\">");
                         html_print(ep ? ep : "");                  html_print(r[i].names);
                         printf("&amp;sec=");                  printf("</A>\n"
                         html_print(sec ? sec : "");                         "</TD>\n"
                         printf("&amp;arch=");                         "<TD CLASS=\"desc\">");
                         html_print(arch ? arch : "");                  html_print(r[i].output);
                         puts("\">apropos</A>?)");                  puts("</TD>\n"
                 }                       "</TR>");
                 puts("</P>");  
                 resp_end_html();  
                 return;  
         }          }
   
         puts("<P></P>\n"          puts("</TABLE>\n"
              "<TABLE>");               "</DIV>");
   
         for (i = 0; i < (int)sz; i++) {          /*
                 printf("<TR><TD CLASS=\"title\"><A HREF=\"");           * In man(1) mode, show one of the pages
                 html_print(progname);           * even if more than one is found.
                 printf("/show/%u/%u.html\">", r[i].volume, r[i].rec);           */
                 html_print(r[i].title);  
                 putchar('(');          if (req->q.equal) {
                 html_print(r[i].cat);                  puts("<HR>");
                 if (r[i].arch && '\0' != *r[i].arch) {                  iuse = 0;
                         putchar('/');                  priouse = 10;
                         html_print(r[i].arch);                  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;
                 }                  }
                 printf(")</A></TD><TD CLASS=\"desc\">");                  resp_show(req, r[iuse].file);
                 html_print(r[i].desc);  
                 puts("</TD></TR>");  
         }          }
   
         puts("</TABLE>");  
   
         resp_end_html();          resp_end_html();
 }  }
   
 /* ARGSUSED */  
 static void  static void
 pg_index(const struct manpaths *ps, const struct req *req, char *path)  catman(const struct req *req, const char *file)
 {  {
   
         resp_index(req);  
 }  
   
 static void  
 catman(const char *file)  
 {  
         FILE            *f;          FILE            *f;
         size_t           len;          size_t           len;
         int              i;          int              i;
Line 530  catman(const char *file)
Line 635  catman(const char *file)
         int              italic, bold;          int              italic, bold;
   
         if (NULL == (f = fopen(file, "r"))) {          if (NULL == (f = fopen(file, "r"))) {
                 resp_baddb();                  puts("<P>You specified an invalid manual file.</P>");
                 return;                  return;
         }          }
   
         resp_begin_http(200, NULL);          puts("<DIV CLASS=\"catman\">\n"
         puts("<!DOCTYPE HTML PUBLIC "                           "\n"               "<PRE>");
              " \"-//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. //-->");  
   
         puts("<PRE>");  
         while (NULL != (p = fgetln(f, &len))) {          while (NULL != (p = fgetln(f, &len))) {
                 bold = italic = 0;                  bold = italic = 0;
                 for (i = 0; i < (int)len - 1; i++) {                  for (i = 0; i < (int)len - 1; i++) {
Line 660  catman(const char *file)
Line 752  catman(const char *file)
         }          }
   
         puts("</PRE>\n"          puts("</PRE>\n"
              "</BODY>\n"               "</DIV>");
              "</HTML>");  
   
         fclose(f);          fclose(f);
 }  }
   
 static void  static void
 format(const char *file)  format(const struct req *req, const char *file)
 {  {
         struct mparse   *mp;          struct mparse   *mp;
         int              fd;          int              fd;
Line 675  format(const char *file)
Line 766  format(const char *file)
         struct man      *man;          struct man      *man;
         void            *vp;          void            *vp;
         enum mandoclevel rc;          enum mandoclevel rc;
         char             opts[MAXPATHLEN + 128];          char             opts[PATH_MAX + 128];
   
         if (-1 == (fd = open(file, O_RDONLY, 0))) {          if (-1 == (fd = open(file, O_RDONLY, 0))) {
                 resp_baddb();                  puts("<P>You specified an invalid manual file.</P>");
                 return;                  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);          rc = mparse_readfd(mp, fd, file);
         close(fd);          close(fd);
   
         if (rc >= MANDOCLEVEL_FATAL) {          if (rc >= MANDOCLEVEL_FATAL) {
                 resp_baddb();                  fprintf(stderr, "fatal mandoc error: %s/%s\n",
                       req->q.manpath, file);
                   pg_error_internal();
                 return;                  return;
         }          }
   
         snprintf(opts, sizeof(opts), "style=/man.css,"          snprintf(opts, sizeof(opts), "fragment,man=%s?"
                         "man=%s/search.html?sec=%%S&expr=%%N,"              "manpath=%s&amp;query=%%N&amp;sec=%%S&amp;arch=%s",
                         /*"includes=/cgi-bin/man.cgi/usr/include/%%I"*/,              scriptname, req->q.manpath,
                         progname);              req->q.arch ? req->q.arch : "");
   
         mparse_result(mp, &mdoc, &man);          mparse_result(mp, &mdoc, &man, NULL);
           if (NULL == man && NULL == mdoc) {
                   fprintf(stderr, "fatal mandoc error: %s/%s\n",
                       req->q.manpath, file);
                   pg_error_internal();
                   mparse_free(mp);
                   return;
           }
   
         vp = html_alloc(opts);          vp = html_alloc(opts);
   
         if (NULL != mdoc) {          if (NULL != mdoc)
                 resp_begin_http(200, NULL);  
                 html_mdoc(vp, mdoc);                  html_mdoc(vp, mdoc);
         } else if (NULL != man) {          else
                 resp_begin_http(200, NULL);  
                 html_man(vp, man);                  html_man(vp, man);
         } else  
                 resp_baddb();  
   
         html_free(vp);          html_free(vp);
         mparse_free(mp);          mparse_free(mp);
 }  }
   
 static void  static void
 pg_show(const struct manpaths *ps, 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(struct req *req, const char *path)
   {
         char            *sub;          char            *sub;
         char             file[MAXPATHLEN];  
         const char      *fn, *cp;  
         int              rc;  
         unsigned int     vol, rec;  
         DB              *idx;  
         DBT              key, val;  
   
         if (NULL == path) {          if (NULL == path || NULL == (sub = strchr(path, '/'))) {
                 resp_error400();                  pg_error_badrequest(
                       "You did not specify a page to show.");
                 return;                  return;
         } else if (NULL == (sub = strrchr(path, '/'))) {          }
                 resp_error400();          *sub++ = '\0';
                 return;  
         } else  
                 *sub++ = '\0';  
   
         if ( ! (atou(path, &vol) && atou(sub, &rec))) {          if ( ! validate_manpath(req, path)) {
                 resp_error400();                  pg_error_badrequest(
                       "You specified an invalid manpath.");
                 return;                  return;
         } else if (vol >= (unsigned int)ps->sz) {  
                 resp_error400();  
                 return;  
         }          }
   
         strlcpy(file, ps->paths[vol], MAXPATHLEN);          /*
         strlcat(file, "/mandoc.index", MAXPATHLEN);           * Begin by chdir()ing into the manpath.
            * This way we can pick up the database files, which are
            * relative to the manpath root.
            */
   
         /* Open the index recno(3) database. */          if (-1 == chdir(path)) {
                   fprintf(stderr, "chdir %s: %s\n",
                       path, strerror(errno));
                   pg_error_internal();
                   return;
           }
   
         idx = dbopen(file, O_RDONLY, 0, DB_RECNO, NULL);          if ( ! validate_filename(sub)) {
         if (NULL == idx) {                  pg_error_badrequest(
                 resp_baddb();                      "You specified an invalid manual file.");
                 return;                  return;
         }          }
   
         key.data = &rec;          if (strcmp(path, "mandoc"))
         key.size = 4;                  req->q.manpath = path;
   
         if (0 != (rc = (*idx->get)(idx, &key, &val, 0))) {          resp_begin_html(200, NULL);
                 rc < 0 ? resp_baddb() : resp_error400();          resp_searchform(req);
                 goto out;          resp_show(req, sub);
         }          resp_end_html();
   
         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);  
 }  }
   
 static void  static void
 pg_search(const struct manpaths *ps, const struct req *req, char *path)  pg_search(const struct req *req)
 {  {
         size_t            tt;          struct mansearch          search;
         int               i, sz, rc, whatis;          struct manpaths           paths;
         const char       *ep, *start;          struct manpage           *res;
         char            **cp;          char                    **cp;
         struct opts       opt;          const char               *ep, *start;
         struct expr      *expr;          size_t                    ressz;
           int                       i, sz;
   
         expr = NULL;          /*
         cp = NULL;           * Begin by chdir()ing into the root of the manpath.
         ep = NULL;           * This way we can pick up the database files, which are
         sz = 0;           * relative to the manpath root.
         whatis = 1;           */
   
         memset(&opt, 0, sizeof(struct opts));          if (-1 == (chdir(req->q.manpath))) {
                   fprintf(stderr, "chdir %s: %s\n",
                       req->q.manpath, strerror(errno));
                   pg_error_internal();
                   return;
           }
   
         for (sz = i = 0; i < (int)req->fieldsz; i++)          search.arch = req->q.arch;
                 if (0 == strcmp(req->fields[i].key, "expr"))          search.sec = req->q.sec;
                         ep = req->fields[i].val;          search.deftype = req->q.equal ? TYPE_Nm : (TYPE_Nm | TYPE_Nd);
                 else if (0 == strcmp(req->fields[i].key, "query"))          search.flags = req->q.equal ? MANSEARCH_MAN : 0;
                         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"))          paths.sz = 1;
                 opt.cat = NULL;          paths.paths = mandoc_malloc(sizeof(char *));
           paths.paths[0] = mandoc_strdup(".");
   
         /*          /*
          * Poor man's tokenisation.           * Poor man's tokenisation: just break apart by spaces.
          * Just break apart by spaces.  
          * Yes, this is half-ass.  But it works for now.           * Yes, this is half-ass.  But it works for now.
          */           */
   
           ep = req->q.expr;
         while (ep && isspace((unsigned char)*ep))          while (ep && isspace((unsigned char)*ep))
                 ep++;                  ep++;
   
           sz = 0;
           cp = NULL;
         while (ep && '\0' != *ep) {          while (ep && '\0' != *ep) {
                 cp = mandoc_realloc(cp, (sz + 1) * sizeof(char *));                  cp = mandoc_reallocarray(cp, sz + 1, sizeof(char *));
                 start = ep;                  start = ep;
                 while ('\0' != *ep && ! isspace((unsigned char)*ep))                  while ('\0' != *ep && ! isspace((unsigned char)*ep))
                         ep++;                          ep++;
Line 840  pg_search(const struct manpaths *ps, const struct req 
Line 925  pg_search(const struct manpaths *ps, const struct req 
                         ep++;                          ep++;
         }          }
   
         rc = -1;          if (0 == mansearch(&search, &paths, sz, cp, "Nd", &res, &ressz))
                   pg_noresult(req, "You entered an invalid query.");
           else if (0 == ressz)
                   pg_noresult(req, "No results found.");
           else
                   pg_searchres(req, res, ressz);
   
         /*  
          * Pump down into apropos backend.  
          * The resp_search() function is called with the results.  
          */  
   
         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);  
   
         /* ...unless errors occured. */  
   
         if (0 == rc)  
                 resp_baddb();  
         else if (-1 == rc)  
                 resp_search(NULL, 0, (void *)req);  
   
         for (i = 0; i < sz; i++)          for (i = 0; i < sz; i++)
                 free(cp[i]);                  free(cp[i]);
   
         free(cp);          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
 main(void)  main(void)
 {  {
         int              i;  
         struct req       req;          struct req       req;
         char            *p, *path, *subpath;          const char      *path;
         struct manpaths  paths;          char            *querystring;
           int              i;
   
         /* HTTP init: read and parse the query string. */          /* Scan our run-time environment. */
   
         progname = getenv("SCRIPT_NAME");          if (NULL == (scriptname = getenv("SCRIPT_NAME")))
         if (NULL == progname)                  scriptname = "";
                 progname = "";  
   
         cache = getenv("CACHE_DIR");          /*
         if (NULL == cache)           * First we change directory into the MAN_DIR so that
                 cache = "/cache/man.cgi";           * subsequent scanning for manpath directories is rooted
            * relative to the same position.
            */
   
         if (-1 == chdir(cache)) {          if (-1 == chdir(MAN_DIR)) {
                 resp_bad();                  fprintf(stderr, "MAN_DIR: %s: %s\n",
                       MAN_DIR, strerror(errno));
                   pg_error_internal();
                 return(EXIT_FAILURE);                  return(EXIT_FAILURE);
         }          }
   
         host = getenv("HTTP_HOST");  
         if (NULL == host)  
                 host = "localhost";  
   
         memset(&req, 0, sizeof(struct req));          memset(&req, 0, sizeof(struct req));
           pathgen(&req);
   
         if (NULL != (p = getenv("QUERY_STRING")))          /* Next parse out the query string. */
                 kval_parse(&req.fields, &req.fieldsz, p);  
   
         /* Resolve leading subpath component. */          if (NULL != (querystring = getenv("QUERY_STRING")))
                   http_parse(&req, querystring);
   
         subpath = path = NULL;          if ( ! validate_manpath(&req, req.q.manpath)) {
         req.page = PAGE__MAX;                  pg_error_badrequest(
                       "You specified an invalid manpath.");
                   return(EXIT_FAILURE);
           }
   
         if (NULL == (path = getenv("PATH_INFO")) || '\0' == *path)          /* Dispatch to the three different pages. */
                 req.page = PAGE_INDEX;  
   
         if (NULL != path && '/' == *path && '\0' == *++path)          path = getenv("PATH_INFO");
                 req.page = PAGE_INDEX;          if (NULL == path)
                   path = "";
           else if ('/' == *path)
                   path++;
   
         /* Strip file suffix. */          if ('\0' != *path)
                   pg_show(&req, path);
           else if (NULL != req.q.expr)
                   pg_search(&req);
           else
                   pg_index(&req);
   
         if (NULL != path && NULL != (p = strrchr(path, '.')))          for (i = 0; i < (int)req.psz; i++)
                 if (NULL != p && NULL == strchr(p, '/'))                  free(req.p[i]);
                         *p++ = '\0';          free(req.p);
   
         /* 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;  
                         }  
   
         /* 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);  
                 break;  
         case (PAGE_SEARCH):  
                 pg_search(&paths, &req, subpath);  
                 break;  
         case (PAGE_SHOW):  
                 pg_show(&paths, &req, subpath);  
                 break;  
         default:  
                 resp_error404(path);  
                 break;  
         }  
   
         manpath_free(&paths);  
         kval_free(req.fields, req.fieldsz);  
   
         return(EXIT_SUCCESS);          return(EXIT_SUCCESS);
 }  }
   
Line 964  static int
Line 1012  static int
 cmp(const void *p1, const void *p2)  cmp(const void *p1, const void *p2)
 {  {
   
         return(strcasecmp(((const struct res *)p1)->title,          return(strcasecmp(((const struct manpage *)p1)->names,
                                 ((const struct res *)p2)->title));              ((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"))) {
                   fprintf(stderr, "%s/manpath.conf: %s\n",
                           MAN_DIR, strerror(errno));
                   pg_error_internal();
                   exit(EXIT_FAILURE);
           }
   
           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);
           }
   
           if ( req->p == NULL ) {
                   fprintf(stderr, "%s/manpath.conf is empty\n", MAN_DIR);
                   pg_error_internal();
                   exit(EXIT_FAILURE);
           }
   }
Legend:
Removed from v.1.19  
changed lines
  Added in v.1.79
CVSweb