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

Diff for /mandoc/cgi.c between version 1.64 and 1.67

version 1.64, 2014/07/12 01:55:30 version 1.67, 2014/07/12 18:32:47
Line 33 
Line 33 
 #include "main.h"  #include "main.h"
 #include "manpath.h"  #include "manpath.h"
 #include "mansearch.h"  #include "mansearch.h"
   #include "cgi.h"
   
 enum    page {  
         PAGE_INDEX,  
         PAGE_SEARCH,  
         PAGE_SHOW,  
         PAGE__MAX  
 };  
   
 /*  /*
  * A query as passed to the search function.   * A query as passed to the search function.
  */   */
Line 49  struct query {
Line 43  struct query {
         const char      *arch; /* architecture */          const char      *arch; /* architecture */
         const char      *sec; /* manual section */          const char      *sec; /* manual section */
         const char      *expr; /* unparsed expression string */          const char      *expr; /* unparsed expression string */
         int              legacy; /* whether legacy mode */          int              equal; /* match whole names, not substrings */
 };  };
   
 struct  req {  struct  req {
         struct query      q;          struct query      q;
         char            **p; /* array of available manpaths */          char            **p; /* array of available manpaths */
         size_t            psz; /* number of available manpaths */          size_t            psz; /* number of available manpaths */
         enum page         page;  
 };  };
   
 static  void             catman(const struct req *, const char *);  static  void             catman(const struct req *, const char *);
Line 71  static void   http_print(const char *);
Line 64  static void   http_print(const char *);
 static  void             http_putchar(char);  static  void             http_putchar(char);
 static  void             http_printquery(const struct req *);  static  void             http_printquery(const struct req *);
 static  void             pathgen(struct req *);  static  void             pathgen(struct req *);
 static  void             pg_index(const struct req *, char *);  static  void             pg_search(const struct req *);
 static  void             pg_search(const struct req *, char *);  static  void             pg_show(const struct req *, const char *);
 static  void             pg_show(const struct req *, 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_error_badrequest(const char *);  static  void             resp_error_badrequest(const char *);
 static  void             resp_error_internal(void);  static  void             resp_error_internal(void);
 static  void             resp_error_notfound(const char *);  
 static  void             resp_index(const struct req *);  static  void             resp_index(const struct req *);
 static  void             resp_noresult(const struct req *,  static  void             resp_noresult(const struct req *,
                                 const char *);                                  const char *);
Line 88  static void   resp_search(const struct req *,
Line 79  static void   resp_search(const struct req *,
 static  void             resp_searchform(const struct req *);  static  void             resp_searchform(const struct req *);
   
 static  const char       *scriptname; /* CGI script name */  static  const char       *scriptname; /* CGI script name */
 static  const char       *mandir; /* contains all manpath directories */  
 static  const char       *cssdir; /* css directory */  
 static  const char       *httphost; /* hostname used in the URIs */  static  const char       *httphost; /* hostname used in the URIs */
   
 static  const char * const pages[PAGE__MAX] = {  
         "index", /* PAGE_INDEX */  
         "search", /* PAGE_SEARCH */  
         "show", /* PAGE_SHOW */  
 };  
   
 /*  /*
  * Print a character, escaping HTML along the way.   * Print a character, escaping HTML along the way.
  * This will pass non-ASCII straight to output: be warned!   * This will pass non-ASCII straight to output: be warned!
Line 142  http_printquery(const struct req *req)
Line 125  http_printquery(const struct req *req)
                 http_print(req->q.arch);                  http_print(req->q.arch);
         }          }
         if (NULL != req->q.expr) {          if (NULL != req->q.expr) {
                 printf("&expr=");                  printf("&query=");
                 http_print(req->q.expr ? req->q.expr : "");                  http_print(req->q.expr);
         }          }
           if (0 == req->q.equal)
                   printf("&apropos=1");
 }  }
   
 static void  static void
Line 164  html_printquery(const struct req *req)
Line 149  html_printquery(const struct req *req)
                 html_print(req->q.arch);                  html_print(req->q.arch);
         }          }
         if (NULL != req->q.expr) {          if (NULL != req->q.expr) {
                 printf("&expr=");                  printf("&query=");
                 html_print(req->q.expr);                  html_print(req->q.expr);
         }          }
           if (0 == req->q.equal)
                   printf("&apropos=1");
 }  }
   
 static void  static void
Line 202  static void
Line 189  static void
 http_parse(struct req *req, char *p)  http_parse(struct req *req, char *p)
 {  {
         char            *key, *val;          char            *key, *val;
         int              legacy;  
   
         memset(&req->q, 0, sizeof(struct query));          memset(&req->q, 0, sizeof(struct query));
         req->q.manpath = req->p[0];          req->q.manpath = req->p[0];
           req->q.equal = 1;
   
         legacy = -1;  
         while ('\0' != *p) {          while ('\0' != *p) {
                 key = p;                  key = p;
                 val = NULL;                  val = NULL;
Line 228  http_parse(struct req *req, char *p)
Line 214  http_parse(struct req *req, char *p)
                 if (NULL != val && ! http_decode(val))                  if (NULL != val && ! http_decode(val))
                         break;                          break;
   
                 if (0 == strcmp(key, "expr"))                  if (0 == strcmp(key, "query"))
                         req->q.expr = val;                          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"))                  else if (0 == strcmp(key, "manpath"))
                         req->q.manpath = val;                          req->q.manpath = val;
                 else if (0 == strcmp(key, "apropos"))                  else if (0 == strcmp(key, "apropos"))
                         legacy = 0 == strcmp(val, "0");                          req->q.equal = !strcmp(val, "0");
                   else if (0 == strcmp(key, "sec") ||
                            0 == strcmp(key, "sektion")) {
                           if (strcmp(val, "0"))
                                   req->q.sec = val;
                   } else if (0 == strcmp(key, "arch")) {
                           if (strcmp(val, "default"))
                                   req->q.arch = val;
                   }
         }          }
   
         /* 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;  
 }  }
   
 static void  static void
Line 343  resp_begin_html(int code, const char *msg)
Line 313  resp_begin_html(int code, const char *msg)
                " TYPE=\"text/css\" media=\"all\">\n"                 " TYPE=\"text/css\" media=\"all\">\n"
                "<LINK REL=\"stylesheet\" HREF=\"%s/man.css\""                 "<LINK REL=\"stylesheet\" HREF=\"%s/man.css\""
                " TYPE=\"text/css\" media=\"all\">\n"                 " TYPE=\"text/css\" media=\"all\">\n"
                "<TITLE>System Manpage Reference</TITLE>\n"                 "<TITLE>%s</TITLE>\n"
                "</HEAD>\n"                 "</HEAD>\n"
                "<BODY>\n"                 "<BODY>\n"
                "<!-- Begin page content. //-->\n",                 "<!-- Begin page content. //-->\n",
                cssdir, cssdir);                 CSS_DIR, CSS_DIR, CUSTOMIZE_TITLE);
 }  }
   
 static void  static void
Line 363  resp_searchform(const struct req *req)
Line 333  resp_searchform(const struct req *req)
 {  {
         int              i;          int              i;
   
           puts(CUSTOMIZE_BEGIN);
         puts("<!-- Begin search form. //-->");          puts("<!-- Begin search form. //-->");
         printf("<DIV ID=\"mancgi\">\n"          printf("<DIV ID=\"mancgi\">\n"
                "<FORM ACTION=\"%s/search\" METHOD=\"get\">\n"                 "<FORM ACTION=\"%s\" METHOD=\"get\">\n"
                "<FIELDSET>\n"                 "<FIELDSET>\n"
                "<LEGEND>Search Parameters</LEGEND>\n"                 "<LEGEND>Search Parameters</LEGEND>\n"
                "<INPUT TYPE=\"submit\" "                 "<INPUT TYPE=\"submit\" VALUE=\"Search\"> "
                " VALUE=\"Search\"> for manuals matching \n"                 "for manuals \n",
                "<INPUT TYPE=\"text\" NAME=\"expr\" VALUE=\"",  
                scriptname);                 scriptname);
           printf("<SELECT NAME=\"apropos\">\n"
                  "<OPTION VALUE=\"0\"");
           if (req->q.equal)
                   printf(" SELECTED=\"selected\"");
           printf(">named</OPTION>\n"
                  "<OPTION VALUE=\"1\"");
           if (0 == req->q.equal)
                   printf(" SELECTED=\"selected\"");
           printf(">matching</OPTION>\n"
                  "</SELECT>\n"
                  "<INPUT TYPE=\"text\" NAME=\"query\" VALUE=\"");
         html_print(req->q.expr ? req->q.expr : "");          html_print(req->q.expr ? req->q.expr : "");
         printf("\">, section "          printf("\">, section "
                "<INPUT TYPE=\"text\""                 "<INPUT TYPE=\"text\""
Line 410  resp_index(const struct req *req)
Line 391  resp_index(const struct req *req)
 {  {
   
         resp_begin_html(200, NULL);          resp_begin_html(200, NULL);
         puts("<H1>\n"  
              "Online manuals with "  
              "<A HREF=\"http://mdocml.bsd.lv/\">mandoc</A>\n"  
              "</H1>");  
         resp_searchform(req);          resp_searchform(req);
         printf("<P>\n"          printf("<P>\n"
                "This web interface is documented in the "                 "This web interface is documented in the "
                "<A HREF=\"%s/search?expr=Nm~^man\\.cgi$&amp;sec=8\">"                 "<A HREF=\"%s?query=man.cgi&amp;sec=8\">"
                "man.cgi</A> manual, and the "                 "man.cgi</A> manual, and the "
                "<A HREF=\"%s/search?expr=Nm~^apropos$&amp;sec=1\">"                 "<A HREF=\"%s?query=apropos&amp;sec=1\">"
                "apropos</A> manual explains the query syntax.\n"                 "apropos</A> manual explains the query syntax.\n"
                "</P>\n",                 "</P>\n",
                scriptname, scriptname);                 scriptname, scriptname);
Line 452  resp_error_badrequest(const char *msg)
Line 429  resp_error_badrequest(const char *msg)
 }  }
   
 static void  static void
 resp_error_notfound(const char *page)  
 {  
   
         resp_begin_html(404, "Not Found");  
         puts("<H1>Page Not Found</H1>\n"  
              "<P>\n"  
              "The page you're looking for, ");  
         printf("<B>");  
         html_print(page);  
         printf("</B>,\n"  
                "could not be found.\n"  
                "Try searching from the\n"  
                "<A HREF=\"%s\">main page</A>.\n"  
                "</P>", scriptname);  
         resp_end_html();  
 }  
   
 static void  
 resp_error_internal(void)  resp_error_internal(void)
 {  {
         resp_begin_html(500, "Internal Server Error");          resp_begin_html(500, "Internal Server Error");
Line 488  resp_search(const struct req *req, struct manpage *r, 
Line 447  resp_search(const struct req *req, struct manpage *r, 
                  * without any delay.                   * without any delay.
                  */                   */
                 printf("Status: 303 See Other\r\n");                  printf("Status: 303 See Other\r\n");
                 printf("Location: http://%s%s/show/%s/%s?",                  printf("Location: http://%s%s/%s/%s?",
                     httphost, scriptname, req->q.manpath, r[0].file);                      httphost, scriptname, req->q.manpath, r[0].file);
                 http_printquery(req);                  http_printquery(req);
                 printf("\r\n"                  printf("\r\n"
Line 507  resp_search(const struct req *req, struct manpage *r, 
Line 466  resp_search(const struct req *req, struct manpage *r, 
         for (i = 0; i < sz; i++) {          for (i = 0; i < sz; i++) {
                 printf("<TR>\n"                  printf("<TR>\n"
                        "<TD CLASS=\"title\">\n"                         "<TD CLASS=\"title\">\n"
                        "<A HREF=\"%s/show/%s/%s?",                         "<A HREF=\"%s/%s/%s?",
                     scriptname, req->q.manpath, r[i].file);                      scriptname, req->q.manpath, r[i].file);
                 html_printquery(req);                  html_printquery(req);
                 printf("\">");                  printf("\">");
Line 525  resp_search(const struct req *req, struct manpage *r, 
Line 484  resp_search(const struct req *req, struct manpage *r, 
         resp_end_html();          resp_end_html();
 }  }
   
 /* ARGSUSED */  
 static void  static void
 pg_index(const struct req *req, char *path)  
 {  
   
         resp_index(req);  
 }  
   
 static void  
 catman(const struct req *req, const char *file)  catman(const struct req *req, const char *file)
 {  {
         FILE            *f;          FILE            *f;
Line 700  format(const struct req *req, const char *file)
Line 651  format(const struct req *req, const char *file)
         }          }
   
         snprintf(opts, sizeof(opts),          snprintf(opts, sizeof(opts),
             "fragment,man=%s/search?sec=%%S&expr=Nm~^%%N$",              "fragment,man=%s?query=%%N&amp;sec=%%S",
             scriptname);              scriptname);
   
         mparse_result(mp, &mdoc, &man, NULL);          mparse_result(mp, &mdoc, &man, NULL);
Line 730  format(const struct req *req, const char *file)
Line 681  format(const struct req *req, const char *file)
 }  }
   
 static void  static void
 pg_show(const struct req *req, char *path)  pg_show(const struct req *req, const char *path)
 {  {
         char            *sub;          char            *sub;
   
Line 760  pg_show(const struct req *req, char *path)
Line 711  pg_show(const struct req *req, char *path)
 }  }
   
 static void  static void
 pg_search(const struct req *req, char *path)  pg_search(const struct req *req)
 {  {
         struct mansearch          search;          struct mansearch          search;
         struct manpaths           paths;          struct manpaths           paths;
Line 784  pg_search(const struct req *req, char *path)
Line 735  pg_search(const struct req *req, char *path)
   
         search.arch = req->q.arch;          search.arch = req->q.arch;
         search.sec = req->q.sec;          search.sec = req->q.sec;
         search.deftype = TYPE_Nm | TYPE_Nd;          search.deftype = req->q.equal ? TYPE_Nm : (TYPE_Nm | TYPE_Nd);
         search.flags = 0;          search.flags = req->q.equal ? MANSEARCH_MAN : 0;
   
         paths.sz = 1;          paths.sz = 1;
         paths.paths = mandoc_malloc(sizeof(char *));          paths.paths = mandoc_malloc(sizeof(char *));
Line 839  pg_search(const struct req *req, char *path)
Line 790  pg_search(const struct req *req, char *path)
 int  int
 main(void)  main(void)
 {  {
         int              i;  
         struct req       req;          struct req       req;
         char            *querystring, *path, *subpath;          const char      *path;
           char            *querystring;
           int              i;
   
         /* Scan our run-time environment. */          /* Scan our run-time environment. */
   
         if (NULL == (mandir = getenv("MAN_DIR")))  
                 mandir = "/man";  
   
         if (NULL == (scriptname = getenv("SCRIPT_NAME")))          if (NULL == (scriptname = getenv("SCRIPT_NAME")))
                 scriptname = "";                  scriptname = "";
   
         if (NULL == (cssdir = getenv("CSS_DIR")))  
                 cssdir = "";  
   
         if (NULL == (httphost = getenv("HTTP_HOST")))          if (NULL == (httphost = getenv("HTTP_HOST")))
                 httphost = "localhost";                  httphost = "localhost";
   
         /*          /*
          * First we change directory into the mandir so that           * First we change directory into the MAN_DIR so that
          * subsequent scanning for manpath directories is rooted           * subsequent scanning for manpath directories is rooted
          * relative to the same position.           * relative to the same position.
          */           */
   
         if (-1 == chdir(mandir)) {          if (-1 == chdir(MAN_DIR)) {
                 fprintf(stderr, "MAN_DIR: %s: %s\n",                  fprintf(stderr, "MAN_DIR: %s: %s\n",
                     mandir, strerror(errno));                      MAN_DIR, strerror(errno));
                 resp_error_internal();                  resp_error_internal();
                 return(EXIT_FAILURE);                  return(EXIT_FAILURE);
         }          }
Line 878  main(void)
Line 824  main(void)
         if (NULL != (querystring = getenv("QUERY_STRING")))          if (NULL != (querystring = getenv("QUERY_STRING")))
                 http_parse(&req, querystring);                  http_parse(&req, querystring);
   
         /*          /* Dispatch to the three different pages. */
          * 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;          path = getenv("PATH_INFO");
         req.page = PAGE__MAX;          if (NULL == path)
                   path = "";
           else if ('/' == *path)
                   path++;
   
         if (NULL == (path = getenv("PATH_INFO")) || '\0' == *path)          if ('\0' != *path)
                 req.page = PAGE_INDEX;                  pg_show(&req, path);
           else if (NULL != req.q.expr)
         if (NULL != path && '/' == *path && '\0' == *++path)                  pg_search(&req);
                 req.page = PAGE_INDEX;          else
                   resp_index(&req);
         /* 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_error_notfound(path);  
                 break;  
         }  
   
         for (i = 0; i < (int)req.psz; i++)          for (i = 0; i < (int)req.psz; i++)
                 free(req.p[i]);                  free(req.p[i]);
Legend:
Removed from v.1.64  
changed lines
  Added in v.1.67
CVSweb