All the functions in this file have been moved to cgisimple.c or loadcfg.c
[privoxy.git] / cgi.c
diff --git a/cgi.c b/cgi.c
index de82743..383c339 100644 (file)
--- a/cgi.c
+++ b/cgi.c
@@ -1,10 +1,12 @@
-const char cgi_rcs[] = "$Id: cgi.c,v 1.25 2001/09/16 15:02:35 jongfoster Exp $";
+const char cgi_rcs[] = "$Id: cgi.c,v 1.26 2001/09/16 15:47:37 jongfoster Exp $";
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/cgi.c,v $
  *
  * Purpose     :  Declares functions to intercept request, generate
  *                html or gif answers, and to compose HTTP resonses.
+ *                This only contains the framework functions, the
+ *                actual handler functions are declared elsewhere.
  *                
  *                Functions declared include:
  * 
@@ -36,6 +38,12 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.25 2001/09/16 15:02:35 jongfoster Exp $";
  *
  * Revisions   :
  *    $Log: cgi.c,v $
+ *    Revision 1.26  2001/09/16 15:47:37  jongfoster
+ *    First version of CGI-based edit interface.  This is very much a
+ *    work-in-progress, and you can't actually use it to edit anything
+ *    yet.  You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
+ *    to have any effect.
+ *
  *    Revision 1.25  2001/09/16 15:02:35  jongfoster
  *    Adding i.j.b/robots.txt.
  *    Inlining add_stats() since it's only ever called from one place.
@@ -197,13 +205,9 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.25 2001/09/16 15:02:35 jongfoster Exp $";
 #include "list.h"
 #include "encode.h"
 #include "ssplit.h"
-#include "jcc.h"
-#include "filters.h"
-#include "actions.h"
 #include "errlog.h"
 #include "miscutil.h"
-#include "showargs.h"
-#include "loadcfg.h"
+#include "cgisimple.h"
 #ifdef FEATURE_CGI_EDIT_ACTIONS
 #include "cgiedit.h"
 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
@@ -422,483 +426,6 @@ struct map *parse_cgi_parameters(char *argstring)
 }
 
 
-/*********************************************************************
- *
- * Function    :  cgi_default
- *
- * Description :  CGI function that is called if no action was given.
- *                Lists menu of available unhidden CGIs.
- *               
- * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  parameters = map of cgi parameters
- *
- * Returns     :  0
- *
- *********************************************************************/
-int cgi_default(struct client_state *csp, struct http_response *rsp,
-                struct map *parameters)
-{
-   char *p;
-   char *tmp = NULL;
-   struct map * exports = default_exports(csp, "");
-
-   /* If there were other parameters, export a dump as "cgi-parameters" */
-   if(parameters)
-   {
-      p = dump_map(parameters);
-      tmp = strsav(tmp, "<p>What made you think this cgi takes parameters?\n"
-                        "Anyway, here they are, in case you're interested:</p>\n");
-      tmp = strsav(tmp, p);
-      map(exports, "cgi-parameters", 1, tmp, 0);
-      free(p);
-   }
-   else
-   {
-      map(exports, "cgi-parameters", 1, "", 1);
-   }
-
-   rsp->body = template_load(csp, "default");
-   template_fill(&rsp->body, exports);
-   free_map(exports);
-   return(0);
-
-}
-
-
-/*********************************************************************
- *
- * Function    :  cgi_send_banner
- *
- * Description :  CGI function that returns a banner. 
- *
- * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  parameters = map of cgi parameters
- *
- * CGI Parameters :
- *           type : Selects the type of banner between "trans" and "jb".
- *                  Defaults to "jb" if absent or != "trans".
- *
- * Returns     :  0
- *
- *********************************************************************/
-int cgi_send_banner(struct client_state *csp, struct http_response *rsp,
-                    struct map *parameters)
-{
-   if(strcmp(lookup(parameters, "type"), "trans"))
-   {
-      rsp->body = bindup(image_junkbuster_gif_data, image_junkbuster_gif_length);
-      rsp->content_length = image_junkbuster_gif_length;
-   }
-   else
-   {
-      rsp->body = bindup(image_blank_gif_data, image_blank_gif_length);
-      rsp->content_length = image_blank_gif_length;
-   }   
-
-   enlist(rsp->headers, "Content-Type: image/gif");
-   rsp->is_static = 1;
-
-   return(0);
-
-}
-
-
-/*********************************************************************
- *
- * Function    :  cgi_show_version
- *
- * Description :  CGI function that returns a a web page describing the
- *                file versions of IJB.
- *
- * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  parameters = map of cgi parameters
- *
- * CGI Parameters :
- *           type : Selects the type of banner between "trans" and "jb".
- *                  Defaults to "jb" if absent or != "trans".
- *
- * Returns     :  0
- *
- *********************************************************************/
-int cgi_show_version(struct client_state *csp, struct http_response *rsp,
-                     struct map *parameters)
-{
-   struct map * exports = default_exports(csp, "show-version");
-
-   map(exports, "sourceversions", 1, show_rcs(), 0);  
-
-   rsp->body = template_load(csp, "show-version");
-   template_fill(&rsp->body, exports);
-   free_map(exports);
-   return(0);
-
-}
-
-/*********************************************************************
- *
- * Function    :  cgi_show_status
- *
- * Description :  CGI function that returns a a web page describing the
- *                current status of IJB.
- *
- * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  parameters = map of cgi parameters
- *
- * CGI Parameters :
- *           type : Selects the type of banner between "trans" and "jb".
- *                  Defaults to "jb" if absent or != "trans".
- *
- * Returns     :  0
- *
- *********************************************************************/
-int cgi_show_status(struct client_state *csp, struct http_response *rsp,
-                    struct map *parameters)
-{
-   char *s = NULL;
-   int i;
-
-   FILE * fp;
-   char buf[BUFFER_SIZE];
-   char * p;
-   const char * filename = NULL;
-   char * file_description = NULL;
-#ifdef FEATURE_STATISTICS
-   float perc_rej;   /* Percentage of http requests rejected */
-   int local_urls_read;
-   int local_urls_rejected;
-#endif /* ndef FEATURE_STATISTICS */
-
-   struct map * exports = default_exports(csp, "show-status");
-
-   switch (*(lookup(parameters, "file")))
-   {
-   case 'p':
-      if (csp->actions_list)
-      {
-         filename = csp->actions_list->filename;
-         file_description = "Actions List";
-      }
-      break;
-
-   case 'r':
-      if (csp->rlist)
-      {
-         filename = csp->rlist->filename;
-         file_description = "Regex Filter List";
-      }
-      break;
-
-#ifdef FEATURE_TRUST
-   case 't':
-      if (csp->tlist)
-      {
-         filename = csp->tlist->filename;
-         file_description = "Trust List";
-      }
-      break;
-#endif /* def FEATURE_TRUST */
-   }
-
-   if (NULL != filename)
-   {
-      map(exports, "file-description", 1, file_description, 1);
-      map(exports, "filepath", 1, html_encode(filename), 0);
-
-      if ((fp = fopen(filename, "r")) == NULL)
-      {
-         map(exports, "content", 1, "<h1>ERROR OPENING FILE!</h1>", 1);
-      }
-      else
-      {
-         while (fgets(buf, sizeof(buf), fp))
-         {
-            p = html_encode(buf);
-            if (p)
-            {
-               s = strsav(s, p);
-               freez(p);
-               s = strsav(s, "<br>");
-            }
-         }
-         fclose(fp);
-         map(exports, "contents", 1, s, 0);
-      }
-      rsp->body = template_load(csp, "show-status-file");
-      template_fill(&rsp->body, exports);
-      free_map(exports);
-      return(0);
-
-   }
-
-   map(exports, "redirect-url", 1, REDIRECT_URL, 1);
-   
-   s = NULL;
-   for (i=0; i < Argc; i++)
-   {
-      s = strsav(s, Argv[i]);
-      s = strsav(s, " ");
-   }
-   map(exports, "invocation", 1, s, 0);
-
-   map(exports, "options", 1, csp->config->proxy_args, 1);
-   show_defines(exports);
-
-#ifdef FEATURE_STATISTICS
-   local_urls_read     = urls_read;
-   local_urls_rejected = urls_rejected;
-
-   /*
-    * Need to alter the stats not to include the fetch of this
-    * page.
-    *
-    * Can't do following thread safely! doh!
-    *
-    * urls_read--;
-    * urls_rejected--; * This will be incremented subsequently *
-    */
-
-   if (local_urls_read == 0)
-   {
-      map_block_killer(exports, "have-stats");
-   }
-   else
-   {
-      map_block_killer(exports, "have-no-stats");
-
-      perc_rej = (float)local_urls_rejected * 100.0F /
-            (float)local_urls_read;
-
-      sprintf(buf, "%d", local_urls_read);
-      map(exports, "requests-received", 1, buf, 1);
-
-      sprintf(buf, "%d", local_urls_rejected);
-      map(exports, "requests-blocked", 1, buf, 1);
-
-      sprintf(buf, "%6.2f", perc_rej);
-      map(exports, "percent-blocked", 1, buf, 1);
-   }
-
-#else /* ndef FEATURE_STATISTICS */
-   map_block_killer(exports, "statistics");
-#endif /* ndef FEATURE_STATISTICS */
-
-   if (csp->actions_list)
-   {
-      map(exports, "actions-filename", 1,  csp->actions_list->filename, 1);
-   }
-   else
-   {
-      map(exports, "actions-filename", 1, "None specified", 1);
-   }
-
-   if (csp->rlist)
-   {
-      map(exports, "re-filter-filename", 1,  csp->rlist->filename, 1);
-   }
-   else
-   {
-      map(exports, "re-filter-filename", 1, "None specified", 1);
-   }
-
-#ifdef FEATURE_TRUST
-   if (csp->tlist)
-   {
-      map(exports, "trust-filename", 1,  csp->tlist->filename, 1);
-   }
-   else
-   {
-       map(exports, "trust-filename", 1, "None specified", 1);
-   }
-#else
-   map_block_killer(exports, "trust-support");
-#endif /* ndef FEATURE_TRUST */
-
-   rsp->body = template_load(csp, "show-status");
-   template_fill(&rsp->body, exports);
-   free_map(exports);
-   return(0);
-
-}
-
-/*********************************************************************
- *
- * Function    :  cgi_show_url_info
- *
- * Description :  CGI function that determines and shows which actions
- *                junkbuster will perform for a given url, and which
- *                matches starting from the defaults have lead to that.
- *
- * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  parameters = map of cgi parameters
- *
- * CGI Parameters :
- *            url : The url whose actions are to be determined.
- *                  If url is unset, the url-given conditional will be
- *                  set, so that all but the form can be suppressed in
- *                  the template.
- *
- * Returns     :  0
- *
- *********************************************************************/
-int cgi_show_url_info(struct client_state *csp, struct http_response *rsp,
-                      struct map *parameters)
-{
-   char *url_param;
-   char *host = NULL;
-   struct map * exports = default_exports(csp, "show-url-info");
-
-   if (NULL == (url_param = strdup(lookup(parameters, "url"))) || *url_param == '\0')
-   {
-      map_block_killer(exports, "url-given");
-      map(exports, "url", 1, "", 1);
-   }
-   else
-   {
-      char *matches = NULL;
-      char *path;
-      char *s;
-      int port = 80;
-      int hits = 0;
-      struct file_list *fl;
-      struct url_actions *b;
-      struct url_spec url[1];
-      struct current_action_spec action[1];
-      
-      host = url_param;
-      host += (strncmp(url_param, "http://", 7)) ? 0 : 7;
-
-      map(exports, "url", 1, host, 1);
-      map(exports, "url-html", 1, html_encode(host), 0);
-
-      init_current_action(action);
-
-      s = current_action_to_text(action);
-      map(exports, "default", 1, s , 0);
-
-      if (((fl = csp->actions_list) == NULL) || ((b = fl->f) == NULL))
-      {
-         map(exports, "matches", 1, "none" , 1);
-         map(exports, "final", 1, lookup(exports, "default"), 1);
-
-         freez(url_param);
-         free_current_action(action);
-
-         rsp->body = template_load(csp, "show-url-info");
-         template_fill(&rsp->body, exports);
-         free_map(exports);
-
-         return 0;
-      }
-
-      s = strchr(host, '/');
-      if (s != NULL)
-      {
-         path = strdup(s);
-         *s = '\0';
-      }
-      else
-      {
-         path = strdup("");
-      }
-      s = strchr(host, ':');
-      if (s != NULL)
-      {
-         *s++ = '\0';
-         port = atoi(s);
-         s = NULL;
-      }
-
-      *url = dsplit(host);
-
-      /* if splitting the domain fails, punt */
-      if (url->dbuf == NULL)
-      {
-         map(exports, "matches", 1, "none" , 1);
-         map(exports, "final", 1, lookup(exports, "default"), 1);
-
-         freez(url_param);
-         freez(path);
-         free_current_action(action);
-
-         rsp->body = template_load(csp, "show-url-info");
-         template_fill(&rsp->body, exports);
-         free_map(exports);
-
-         return 0;
-      }
-
-      for (b = b->next; NULL != b; b = b->next)
-      {
-         if ((b->url->port == 0) || (b->url->port == port))
-         {
-            if ((b->url->domain[0] == '\0') || (domaincmp(b->url, url) == 0))
-            {
-               if ((b->url->path == NULL) ||
-#ifdef REGEX
-                  (regexec(b->url->preg, path, 0, NULL, 0) == 0)
-#else
-                  (strncmp(b->url->path, path, b->url->pathlen) == 0)
-#endif
-               )
-               {
-                  s = actions_to_text(b->action);
-                  matches = strsav(matches, "<b>{");
-                  matches = strsav(matches, s);
-                  matches = strsav(matches, " }</b><br>\n<code>");
-                  matches = strsav(matches, b->url->spec);
-                  matches = strsav(matches, "</code><br>\n<br>\n");
-                  freez(s);
-
-                  merge_current_action(action, b->action);
-                  hits++;
-               }
-            }
-         }
-      }
-
-      if (hits)
-      {
-         map(exports, "matches", 1, matches , 0);
-      }
-      else
-      {
-         map(exports, "matches", 1, "none", 1);
-      }
-      matches = NULL;
-
-      freez(url->dbuf);
-      freez(url->dvec);
-
-      freez(url_param);
-      freez(path);
-
-      s = current_action_to_text(action);
-      map(exports, "final", 1, s, 0);
-      s = NULL;
-
-      free_current_action(action);
-   }
-
-   rsp->body = template_load(csp, "show-url-info");
-   template_fill(&rsp->body, exports);
-   free_map(exports);
-   return 0;
-
-}
-
-
 /*********************************************************************
  *
  * Function    :  error_response
@@ -966,7 +493,7 @@ struct http_response *error_response(struct client_state *csp, const char *templ
  * Returns     :  N/A
  *
  *********************************************************************/
-static void get_http_time(int time_offset, char * buf)
+void get_http_time(int time_offset, char * buf)
 {
    static const char day_names[7][4] =
       { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
@@ -1480,47 +1007,6 @@ char *dump_map(const struct map *the_map)
 }
 
 
-/*********************************************************************
- *
- * Function    :  cgi_robots_txt
- *
- * Description :  CGI function to return "/robots.txt".
- *
- * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  parameters = map of cgi parameters
- *
- * CGI Parameters : None
- *
- * Returns     :  0
- *
- *********************************************************************/
-int cgi_robots_txt(struct client_state *csp, struct http_response *rsp,
-                   struct map *parameters)
-{
-   char buf[100];
-
-   rsp->body = strdup(
-      "# This is the Internet Junkbuster control interface.\n"
-      "# It isn't very useful to index it, and you're likely to break stuff.\n"
-      "# So go away!\n"
-      "\n"
-      "User-agent: *\n"
-      "Disallow: /\n"
-      "\n");
-
-   enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
-
-   rsp->is_static = 1;
-
-   get_http_time(7 * 24 * 60 * 60, buf); /* 7 days into future */
-   enlist_unique_header(rsp->headers, "Expires", buf);
-
-   return 0;
-}
-
-
 /*
   Local Variables:
   tab-width: 3