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

Diff for /mandoc/cgi.c between version 1.81 and 1.92

version 1.81, 2014/07/24 08:26:57 version 1.92, 2014/08/05 15:29:30
Line 23 
Line 23 
 #include <errno.h>  #include <errno.h>
 #include <fcntl.h>  #include <fcntl.h>
 #include <limits.h>  #include <limits.h>
   #include <stdint.h>
 #include <stdio.h>  #include <stdio.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
Line 39 
Line 40 
  * A query as passed to the search function.   * A query as passed to the search function.
  */   */
 struct  query {  struct  query {
         const char      *manpath; /* desired manual directory */          char            *manpath; /* desired manual directory */
         const char      *arch; /* architecture */          char            *arch; /* architecture */
         const char      *sec; /* manual section */          char            *sec; /* manual section */
         const char      *expr; /* unparsed expression string */          char            *query; /* unparsed query expression */
         int              equal; /* match whole names, not substrings */          int              equal; /* match whole names, not substrings */
 };  };
   
Line 53  struct req {
Line 54  struct req {
 };  };
   
 static  void             catman(const struct req *, const char *);  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             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              http_decode(char *);  static  int              http_decode(char *);
 static  void             http_parse(struct req *, char *);  static  void             http_parse(struct req *, const char *);
 static  void             http_print(const char *);  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 *, const char *);
 static  void             pathgen(struct req *);  static  void             pathgen(struct req *);
 static  void             pg_error_badrequest(const char *);  static  void             pg_error_badrequest(const char *);
 static  void             pg_error_internal(void);  static  void             pg_error_internal(void);
Line 77  static void   resp_begin_http(int, const char *);
Line 76  static void   resp_begin_http(int, const char *);
 static  void             resp_end_html(void);  static  void             resp_end_html(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  void             resp_show(const struct req *, const char *);
   static  void             set_query_attr(char **, char **);
   static  int              validate_filename(const char *);
   static  int              validate_manpath(const struct req *, const char *);
   static  int              validate_urifrag(const char *);
   
 static  const char       *scriptname; /* CGI script name */  static  const char       *scriptname; /* CGI script name */
   
Line 142  html_putchar(char c)
Line 145  html_putchar(char c)
 }  }
   
 static void  static void
 http_printquery(const struct req *req)  http_printquery(const struct req *req, const char *sep)
 {  {
   
         if (NULL != req->q.manpath) {          if (NULL != req->q.query) {
                 printf("&manpath=");                  printf("query=");
                 http_print(req->q.manpath);                  http_print(req->q.query);
         }          }
           if (0 == req->q.equal)
                   printf("%sapropos=1", sep);
         if (NULL != req->q.sec) {          if (NULL != req->q.sec) {
                 printf("&sec=");                  printf("%ssec=", sep);
                 http_print(req->q.sec);                  http_print(req->q.sec);
         }          }
         if (NULL != req->q.arch) {          if (NULL != req->q.arch) {
                 printf("&arch=");                  printf("%sarch=", sep);
                 http_print(req->q.arch);                  http_print(req->q.arch);
         }          }
         if (NULL != req->q.expr) {          if (NULL != req->q.manpath &&
                 printf("&query=");              strcmp(req->q.manpath, req->p[0])) {
                 http_print(req->q.expr);                  printf("%smanpath=", sep);
                   http_print(req->q.manpath);
         }          }
         if (0 == req->q.equal)  
                 printf("&apropos=1");  
 }  }
   
 static void  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)  http_print(const char *p)
 {  {
   
Line 214  html_print(const char *p)
Line 194  html_print(const char *p)
 }  }
   
 /*  /*
  * Parse out key-value pairs from an HTTP request variable.   * Transfer the responsibility for the allocated string *val
  * This can be either a cookie or a POST/GET string, although man.cgi   * to the query structure.
  * uses only GET for simplicity.  
  */   */
 static void  static void
 http_parse(struct req *req, char *p)  set_query_attr(char **attr, char **val)
 {  {
         char            *key, *val;  
   
         memset(&req->q, 0, sizeof(struct query));          free(*attr);
         req->q.manpath = req->p[0];          if (**val == '\0') {
         req->q.equal = 1;                  *attr = NULL;
                   free(*val);
           } else
                   *attr = *val;
           *val = NULL;
   }
   
         while ('\0' != *p) {  /*
                 key = p;   * Parse the QUERY_STRING for key-value pairs
                 val = NULL;   * and store the values into the query structure.
    */
   static void
   http_parse(struct req *req, const char *qs)
   {
           char            *key, *val;
           size_t           keysz, valsz;
   
                 p += (int)strcspn(p, ";&");          req->q.manpath  = NULL;
                 if ('\0' != *p)          req->q.arch     = NULL;
                         *p++ = '\0';          req->q.sec      = NULL;
                 if (NULL != (val = strchr(key, '=')))          req->q.query    = NULL;
                         *val++ = '\0';          req->q.equal    = 1;
   
                 if ('\0' == *key || NULL == val || '\0' == *val)          key = val = NULL;
                         continue;          while (*qs != '\0') {
   
                 /* Just abort handling. */                  /* Parse one key. */
   
                 if ( ! http_decode(key))                  keysz = strcspn(qs, "=;&");
                         break;                  key = mandoc_strndup(qs, keysz);
                 if (NULL != val && ! http_decode(val))                  qs += keysz;
                         break;                  if (*qs != '=')
                           goto next;
   
                 if (0 == strcmp(key, "query"))                  /* Parse one value. */
                         req->q.expr = val;  
                 else if (0 == strcmp(key, "manpath")) {                  valsz = strcspn(++qs, ";&");
                   val = mandoc_strndup(qs, valsz);
                   qs += valsz;
   
                   /* Decode and catch encoding errors. */
   
                   if ( ! (http_decode(key) && http_decode(val)))
                           goto next;
   
                   /* Handle key-value pairs. */
   
                   if ( ! strcmp(key, "query"))
                           set_query_attr(&req->q.query, &val);
   
                   else if ( ! strcmp(key, "apropos"))
                           req->q.equal = !strcmp(val, "0");
   
                   else if ( ! strcmp(key, "manpath")) {
 #ifdef COMPAT_OLDURI  #ifdef COMPAT_OLDURI
                         if (0 == strncmp(val, "OpenBSD ", 8)) {                          if ( ! strncmp(val, "OpenBSD ", 8)) {
                                 val[7] = '-';                                  val[7] = '-';
                                 if ('C' == val[8])                                  if ('C' == val[8])
                                         val[8] = 'c';                                          val[8] = 'c';
                         }                          }
 #endif  #endif
                         req->q.manpath = val;                          set_query_attr(&req->q.manpath, &val);
                 } else if (0 == strcmp(key, "apropos"))                  }
                         req->q.equal = !strcmp(val, "0");  
                 else if (0 == strcmp(key, "sec")) {                  else if ( ! (strcmp(key, "sec")
                         if (strcmp(val, "0"))  
                                 req->q.sec = val;  
 #ifdef COMPAT_OLDURI  #ifdef COMPAT_OLDURI
                 } else if (0 == strcmp(key, "sektion")) {                      && strcmp(key, "sektion")
                         if (strcmp(val, "0"))  
                                 req->q.sec = val;  
 #endif  #endif
                 } else if (0 == strcmp(key, "arch")) {                      )) {
                         if (strcmp(val, "default"))                          if ( ! strcmp(val, "0"))
                                 req->q.arch = val;                                  *val = '\0';
                           set_query_attr(&req->q.sec, &val);
                 }                  }
   
                   else if ( ! strcmp(key, "arch")) {
                           if ( ! strcmp(val, "default"))
                                   *val = '\0';
                           set_query_attr(&req->q.arch, &val);
                   }
   
                   /*
                    * The key must be freed in any case.
                    * The val may have been handed over to the query
                    * structure, in which case it is now NULL.
                    */
   next:
                   free(key);
                   key = NULL;
                   free(val);
                   val = NULL;
   
                   if (*qs != '\0')
                           qs++;
         }          }
   
           /* Fall back to the default manpath. */
   
           if (req->q.manpath == NULL)
                   req->q.manpath = mandoc_strdup(req->p[0]);
 }  }
   
 static void  static void
Line 389  resp_searchform(const struct req *req)
Line 418  resp_searchform(const struct req *req)
   
         printf( "<TABLE><TR><TD>\n"          printf( "<TABLE><TR><TD>\n"
                 "<INPUT TYPE=\"text\" NAME=\"query\" VALUE=\"");                  "<INPUT TYPE=\"text\" NAME=\"query\" VALUE=\"");
         if (NULL != req->q.expr)          if (NULL != req->q.query)
                 html_print(req->q.expr);                  html_print(req->q.query);
         puts("\" SIZE=\"40\">");          puts("\" SIZE=\"40\">");
   
         /* Write submission and reset buttons. */          /* Write submission and reset buttons. */
Line 403  resp_searchform(const struct req *req)
Line 432  resp_searchform(const struct req *req)
         printf( "</TD><TD>\n"          printf( "</TD><TD>\n"
                 "<INPUT TYPE=\"radio\" ");                  "<INPUT TYPE=\"radio\" ");
         if (req->q.equal)          if (req->q.equal)
                 printf("CHECKED ");                  printf("CHECKED=\"checked\" ");
         printf( "NAME=\"apropos\" ID=\"show\" VALUE=\"0\">\n"          printf( "NAME=\"apropos\" ID=\"show\" VALUE=\"0\">\n"
                 "<LABEL FOR=\"show\">Show named manual page</LABEL>\n");                  "<LABEL FOR=\"show\">Show named manual page</LABEL>\n");
   
         /* Write section selector. */          /* Write section selector. */
   
         printf( "</TD></TR><TR><TD>\n"          puts(   "</TD></TR><TR><TD>\n"
                 "<SELECT NAME=\"sec\">");                  "<SELECT NAME=\"sec\">");
         for (i = 0; i < sec_MAX; i++) {          for (i = 0; i < sec_MAX; i++) {
                 printf("<OPTION VALUE=\"%s\"", sec_numbers[i]);                  printf("<OPTION VALUE=\"%s\"", sec_numbers[i]);
                 if (NULL != req->q.sec &&                  if (NULL != req->q.sec &&
                     0 == strcmp(sec_numbers[i], req->q.sec))                      0 == strcmp(sec_numbers[i], req->q.sec))
                         printf(" SELECTED");                          printf(" SELECTED=\"selected\"");
                 printf(">%s</OPTION>\n", sec_names[i]);                  printf(">%s</OPTION>\n", sec_names[i]);
         }          }
         puts("</SELECT>");          puts("</SELECT>");
Line 425  resp_searchform(const struct req *req)
Line 454  resp_searchform(const struct req *req)
         printf( "<SELECT NAME=\"arch\">\n"          printf( "<SELECT NAME=\"arch\">\n"
                 "<OPTION VALUE=\"default\"");                  "<OPTION VALUE=\"default\"");
         if (NULL == req->q.arch)          if (NULL == req->q.arch)
                 printf(" SELECTED");                  printf(" SELECTED=\"selected\"");
         puts(">All Architectures</OPTION>");          puts(">All Architectures</OPTION>");
         for (i = 0; i < arch_MAX; i++) {          for (i = 0; i < arch_MAX; i++) {
                 printf("<OPTION VALUE=\"%s\"", arch_names[i]);                  printf("<OPTION VALUE=\"%s\"", arch_names[i]);
                 if (NULL != req->q.arch &&                  if (NULL != req->q.arch &&
                     0 == strcmp(arch_names[i], req->q.arch))                      0 == strcmp(arch_names[i], req->q.arch))
                         printf(" SELECTED");                          printf(" SELECTED=\"selected\"");
                 printf(">%s</OPTION>\n", arch_names[i]);                  printf(">%s</OPTION>\n", arch_names[i]);
         }          }
         puts("</SELECT>");          puts("</SELECT>");
Line 444  resp_searchform(const struct req *req)
Line 473  resp_searchform(const struct req *req)
                         printf("<OPTION ");                          printf("<OPTION ");
                         if (NULL == req->q.manpath ? 0 == i :                          if (NULL == req->q.manpath ? 0 == i :
                             0 == strcmp(req->q.manpath, req->p[i]))                              0 == strcmp(req->q.manpath, req->p[i]))
                                 printf("SELECTED ");                                  printf("SELECTED=\"selected\" ");
                         printf("VALUE=\"");                          printf("VALUE=\"");
                         html_print(req->p[i]);                          html_print(req->p[i]);
                         printf("\">");                          printf("\">");
Line 459  resp_searchform(const struct req *req)
Line 488  resp_searchform(const struct req *req)
         printf( "</TD><TD>\n"          printf( "</TD><TD>\n"
                 "<INPUT TYPE=\"radio\" ");                  "<INPUT TYPE=\"radio\" ");
         if (0 == req->q.equal)          if (0 == req->q.equal)
                 printf("CHECKED ");                  printf("CHECKED=\"checked\" ");
         printf( "NAME=\"apropos\" ID=\"search\" VALUE=\"1\">\n"          printf( "NAME=\"apropos\" ID=\"search\" VALUE=\"1\">\n"
                 "<LABEL FOR=\"search\">Search with apropos query</LABEL>\n");                  "<LABEL FOR=\"search\">Search with apropos query</LABEL>\n");
   
Line 517  pg_index(const struct req *req)
Line 546  pg_index(const struct req *req)
         resp_begin_html(200, NULL);          resp_begin_html(200, NULL);
         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\n"
                "<A HREF=\"%s/mandoc/man8/man.cgi.8\">man.cgi</A> "                 "<A HREF=\"%s/mandoc/man8/man.cgi.8\">man.cgi</A>\n"
                "manual, and the "                 "manual, and the\n"
                "<A HREF=\"%s/mandoc/man1/apropos.1\">apropos</A> "                 "<A HREF=\"%s/mandoc/man1/apropos.1\">apropos</A>\n"
                "manual explains the query syntax.\n"                 "manual explains the query syntax.\n"
                "</P>\n",                 "</P>\n",
                scriptname, scriptname);                 scriptname, scriptname);
Line 586  pg_searchres(const struct req *req, struct manpage *r,
Line 615  pg_searchres(const struct req *req, struct manpage *r,
                 printf("Status: 303 See Other\r\n");                  printf("Status: 303 See Other\r\n");
                 printf("Location: http://%s%s/%s/%s?",                  printf("Location: http://%s%s/%s/%s?",
                     HTTP_HOST, scriptname, req->q.manpath, r[0].file);                      HTTP_HOST, scriptname, req->q.manpath, r[0].file);
                 http_printquery(req);                  http_printquery(req, "&");
                 printf("\r\n"                  printf("\r\n"
                      "Content-Type: text/html; charset=utf-8\r\n"                       "Content-Type: text/html; charset=utf-8\r\n"
                      "\r\n");                       "\r\n");
                 return;                  return;
         }          }
   
         qsort(r, sz, sizeof(struct manpage), cmp);  
   
         resp_begin_html(200, NULL);          resp_begin_html(200, NULL);
         resp_searchform(req);          resp_searchform(req);
         puts("<DIV CLASS=\"results\">");          puts("<DIV CLASS=\"results\">");
Line 605  pg_searchres(const struct req *req, struct manpage *r,
Line 632  pg_searchres(const struct req *req, struct manpage *r,
                        "<TD CLASS=\"title\">\n"                         "<TD CLASS=\"title\">\n"
                        "<A HREF=\"%s/%s/%s?",                         "<A HREF=\"%s/%s/%s?",
                     scriptname, req->q.manpath, r[i].file);                      scriptname, req->q.manpath, r[i].file);
                 html_printquery(req);                  http_printquery(req, "&amp;");
                 printf("\">");                  printf("\">");
                 html_print(r[i].names);                  html_print(r[i].names);
                 printf("</A>\n"                  printf("</A>\n"
Line 799  static void
Line 826  static void
 format(const struct req *req, const char *file)  format(const struct req *req, const char *file)
 {  {
         struct mparse   *mp;          struct mparse   *mp;
         int              fd;  
         struct mdoc     *mdoc;          struct mdoc     *mdoc;
         struct man      *man;          struct man      *man;
         void            *vp;          void            *vp;
           char            *opts;
         enum mandoclevel rc;          enum mandoclevel rc;
         char             opts[PATH_MAX + 128];          int              fd;
           int              usepath;
   
         if (-1 == (fd = open(file, O_RDONLY, 0))) {          if (-1 == (fd = open(file, O_RDONLY, 0))) {
                 puts("<P>You specified an invalid manual file.</P>");                  puts("<P>You specified an invalid manual file.</P>");
Line 823  format(const struct req *req, const char *file)
Line 851  format(const struct req *req, const char *file)
                 return;                  return;
         }          }
   
         snprintf(opts, sizeof(opts), "fragment,man=%s?"          usepath = strcmp(req->q.manpath, req->p[0]);
             "manpath=%s&amp;query=%%N&amp;sec=%%S&amp;arch=%s",          mandoc_asprintf(&opts,
             scriptname, req->q.manpath,              "fragment,man=%s?query=%%N&sec=%%S%s%s%s%s",
             req->q.arch ? req->q.arch : "");              scriptname,
               req->q.arch ? "&arch="       : "",
               req->q.arch ? req->q.arch    : "",
               usepath     ? "&manpath="    : "",
               usepath     ? req->q.manpath : "");
   
         mparse_result(mp, &mdoc, &man, NULL);          mparse_result(mp, &mdoc, &man, NULL);
         if (NULL == man && NULL == mdoc) {          if (NULL == man && NULL == mdoc) {
Line 846  format(const struct req *req, const char *file)
Line 878  format(const struct req *req, const char *file)
   
         html_free(vp);          html_free(vp);
         mparse_free(mp);          mparse_free(mp);
           free(opts);
 }  }
   
 static void  static void
Line 862  resp_show(const struct req *req, const char *file)
Line 895  resp_show(const struct req *req, const char *file)
 }  }
   
 static void  static void
 pg_show(struct req *req, const char *path)  pg_show(struct req *req, const char *fullpath)
 {  {
         char            *sub;          char            *manpath;
           const char      *file;
   
         if (NULL == path || NULL == (sub = strchr(path, '/'))) {          if ((file = strchr(fullpath, '/')) == NULL) {
                 pg_error_badrequest(                  pg_error_badrequest(
                     "You did not specify a page to show.");                      "You did not specify a page to show.");
                 return;                  return;
         }          }
         *sub++ = '\0';          manpath = mandoc_strndup(fullpath, file - fullpath);
           file++;
   
         if ( ! validate_manpath(req, path)) {          if ( ! validate_manpath(req, manpath)) {
                 pg_error_badrequest(                  pg_error_badrequest(
                     "You specified an invalid manpath.");                      "You specified an invalid manpath.");
                   free(manpath);
                 return;                  return;
         }          }
   
Line 885  pg_show(struct req *req, const char *path)
Line 921  pg_show(struct req *req, const char *path)
          * relative to the manpath root.           * relative to the manpath root.
          */           */
   
         if (-1 == chdir(path)) {          if (chdir(manpath) == -1) {
                 fprintf(stderr, "chdir %s: %s\n",                  fprintf(stderr, "chdir %s: %s\n",
                     path, strerror(errno));                      manpath, strerror(errno));
                 pg_error_internal();                  pg_error_internal();
                   free(manpath);
                 return;                  return;
         }          }
   
         if ( ! validate_filename(sub)) {          if (strcmp(manpath, "mandoc")) {
                   free(req->q.manpath);
                   req->q.manpath = manpath;
           } else
                   free(manpath);
   
           if ( ! validate_filename(file)) {
                 pg_error_badrequest(                  pg_error_badrequest(
                     "You specified an invalid manual file.");                      "You specified an invalid manual file.");
                 return;                  return;
         }          }
   
         if (strcmp(path, "mandoc"))  
                 req->q.manpath = path;  
   
         resp_begin_html(200, NULL);          resp_begin_html(200, NULL);
         resp_searchform(req);          resp_searchform(req);
         resp_show(req, sub);          resp_show(req, file);
         resp_end_html();          resp_end_html();
 }  }
   
Line 945  pg_search(const struct req *req)
Line 985  pg_search(const struct req *req)
          * Yes, this is half-ass.  But it works for now.           * Yes, this is half-ass.  But it works for now.
          */           */
   
         ep = req->q.expr;          ep = req->q.query;
         while (ep && isspace((unsigned char)*ep))          while (ep && isspace((unsigned char)*ep))
                 ep++;                  ep++;
   
Line 990  main(void)
Line 1030  main(void)
 {  {
         struct req       req;          struct req       req;
         const char      *path;          const char      *path;
         char            *querystring;          const char      *querystring;
         int              i;          int              i;
   
         /* Scan our run-time environment. */          /* Scan our run-time environment. */
Line 1026  main(void)
Line 1066  main(void)
         if (NULL != (querystring = getenv("QUERY_STRING")))          if (NULL != (querystring = getenv("QUERY_STRING")))
                 http_parse(&req, querystring);                  http_parse(&req, querystring);
   
         if ( ! validate_manpath(&req, req.q.manpath)) {          if ( ! (NULL == req.q.manpath ||
               validate_manpath(&req, req.q.manpath))) {
                 pg_error_badrequest(                  pg_error_badrequest(
                     "You specified an invalid manpath.");                      "You specified an invalid manpath.");
                 return(EXIT_FAILURE);                  return(EXIT_FAILURE);
Line 1048  main(void)
Line 1089  main(void)
   
         if ('\0' != *path)          if ('\0' != *path)
                 pg_show(&req, path);                  pg_show(&req, path);
         else if (NULL != req.q.expr)          else if (NULL != req.q.query)
                 pg_search(&req);                  pg_search(&req);
         else          else
                 pg_index(&req);                  pg_index(&req);
   
           free(req.q.manpath);
           free(req.q.arch);
           free(req.q.sec);
           free(req.q.query);
         for (i = 0; i < (int)req.psz; i++)          for (i = 0; i < (int)req.psz; i++)
                 free(req.p[i]);                  free(req.p[i]);
         free(req.p);          free(req.p);
         return(EXIT_SUCCESS);          return(EXIT_SUCCESS);
 }  
   
 static int  
 cmp(const void *p1, const void *p2)  
 {  
   
         return(strcasecmp(((const struct manpage *)p1)->names,  
             ((const struct manpage *)p2)->names));  
 }  }
   
 /*  /*
Legend:
Removed from v.1.81  
changed lines
  Added in v.1.92
CVSweb