Correct HTML, external Stylesheets, eye candy, some fixes
[privoxy.git] / cgisimple.c
index 527db0e..54d4eec 100644 (file)
@@ -1,16 +1,16 @@
-const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.13 2002/02/21 00:10:37 jongfoster Exp $";
+const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.26 2002/04/04 00:36:36 gliptak Exp $";
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/cgisimple.c,v $
  *
- * Purpose     :  Simple CGIs to get information about JunkBuster's
+ * Purpose     :  Simple CGIs to get information about Privoxy's
  *                status.
  *                
  *                Functions declared include:
  * 
  *
  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
- *                IJBSWA team.  http://ijbswa.sourceforge.net
+ *                Privoxy team. http://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
  *                by and Copyright (C) 1997 Anonymous Coders and 
@@ -36,6 +36,52 @@ const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.13 2002/02/21 00:10:37 jongfo
  *
  * Revisions   :
  *    $Log: cgisimple.c,v $
+ *    Revision 1.26  2002/04/04 00:36:36  gliptak
+ *    always use pcre for matching
+ *
+ *    Revision 1.25  2002/04/03 22:28:03  gliptak
+ *    Removed references to gnu_regex
+ *
+ *    Revision 1.24  2002/04/02 16:12:47  oes
+ *    Fix: moving misplaced lines into #ifdef FEATURE_FORCE
+ *
+ *    Revision 1.23  2002/03/26 22:29:54  swa
+ *    we have a new homepage!
+ *
+ *    Revision 1.22  2002/03/24 16:18:15  jongfoster
+ *    Removing old logo
+ *
+ *    Revision 1.21  2002/03/24 15:23:33  jongfoster
+ *    Name changes
+ *
+ *    Revision 1.20  2002/03/24 13:25:43  swa
+ *    name change related issues
+ *
+ *    Revision 1.19  2002/03/16 23:54:06  jongfoster
+ *    Adding graceful termination feature, to help look for memory leaks.
+ *    If you enable this (which, by design, has to be done by hand
+ *    editing config.h) and then go to http://i.j.b/die, then the program
+ *    will exit cleanly after the *next* request.  It should free all the
+ *    memory that was used.
+ *
+ *    Revision 1.18  2002/03/12 01:44:49  oes
+ *    Changed default for "blocked" image from jb logo to checkboard pattern
+ *
+ *    Revision 1.17  2002/03/08 16:43:18  oes
+ *    Added choice beween GIF and PNG built-in images
+ *
+ *    Revision 1.16  2002/03/07 03:48:38  oes
+ *     - Changed built-in images from GIF to PNG
+ *       (with regard to Unisys patent issue)
+ *     - Added a 4x4 pattern PNG which is less intrusive
+ *       than the logo but also clearly marks the deleted banners
+ *
+ *    Revision 1.15  2002/03/06 22:54:35  jongfoster
+ *    Automated function-comment nitpicking.
+ *
+ *    Revision 1.14  2002/03/02 04:14:50  david__schmidt
+ *    Clean up a little CRLF unpleasantness that suddenly appeared
+ *
  *    Revision 1.13  2002/02/21 00:10:37  jongfoster
  *    Adding send-banner?type=auto option
  *
@@ -119,6 +165,7 @@ const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.13 2002/02/21 00:10:37 jongfo
 #include "loadcfg.h"
 #include "parsers.h"
 #include "urlmatch.h"
+#include "errlog.h"
 
 const char cgisimple_h_rcs[] = CGISIMPLE_H_VERSION;
 
@@ -135,9 +182,9 @@ static jb_err show_defines(struct map *exports);
  *                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
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
+ *           :  parameters = map of cgi parameters
  *
  * CGI Parameters : none
  *
@@ -202,9 +249,9 @@ jb_err cgi_default(struct client_state *csp,
  *                given.
  *               
  * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  parameters = map of cgi parameters
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
+ *           :  parameters = map of cgi parameters
  *
  * CGI Parameters : none
  *
@@ -227,7 +274,7 @@ jb_err cgi_error_404(struct client_state *csp,
       return JB_ERR_MEMORY;
    }
 
-   rsp->status = strdup("404 JunkBuster configuration page not found");
+   rsp->status = strdup("404 Privoxy configuration page not found");
    if (rsp->status == NULL)
    {
       free_map(exports);
@@ -238,6 +285,48 @@ jb_err cgi_error_404(struct client_state *csp,
 }
 
 
+#ifdef FEATURE_GRACEFUL_TERMINATION
+/*********************************************************************
+ *
+ * Function    :  cgi_die
+ *
+ * Description :  CGI function to shut down Privoxy.
+ *                NOTE: Turning this on in a production build
+ *                would be a BAD idea.  An EXTREMELY BAD idea.
+ *                In short, don't do it.
+ *               
+ * 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     :  JB_ERR_OK on success
+ *                JB_ERR_MEMORY on out-of-memory error.  
+ *
+ *********************************************************************/
+jb_err cgi_die (struct client_state *csp,
+                struct http_response *rsp,
+                const struct map *parameters)
+{
+   assert(csp);
+   assert(rsp);
+   assert(parameters);
+
+   /* quit */
+   g_terminate = 1;
+
+   /*
+    * I don't really care what gets sent back to the browser.
+    * Take the easy option - "out of memory" page.
+    */
+
+   return JB_ERR_MEMORY;
+}
+#endif /* def FEATURE_GRACEFUL_TERMINATION */
+
+
 /*********************************************************************
  *
  * Function    :  cgi_show_request
@@ -246,9 +335,9 @@ jb_err cgi_error_404(struct client_state *csp,
  *                made of it.
  *               
  * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  parameters = map of cgi parameters
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
+ *           :  parameters = map of cgi parameters
  *
  * CGI Parameters : none
  *
@@ -309,9 +398,9 @@ jb_err cgi_show_request(struct client_state *csp,
  * 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
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
+ *           :  parameters = map of cgi parameters
  *
  * CGI Parameters :
  *           type : Selects the type of banner between "trans", "logo",
@@ -331,8 +420,8 @@ jb_err cgi_send_banner(struct client_state *csp,
 
    if (imagetype == 'a') /* auto */
    {
-      /* Default to logo */
-      imagetype = 'l';
+      /* Default to pattern */
+      imagetype = 'p';
 #ifdef FEATURE_IMAGE_BLOCKING
       if ((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
       {
@@ -342,21 +431,26 @@ jb_err cgi_send_banner(struct client_state *csp,
          /* and handle accordingly: */
          if ((p != NULL) && (0 == strcmpic(p, "blank")))
          {
-            imagetype = 't';
+            imagetype = 'b';
+         }
+         else if ((p != NULL) && (0 == strcmpic(p, "pattern")))
+         {
+            imagetype = 'p';
          }
       }
 #endif /* def FEATURE_IMAGE_BLOCKING */
    }
       
-   if ((imagetype != 't') && (imagetype != 'b')) /* transparant/blank */
+   if ((imagetype == 'b') || (imagetype == 't')) /* blank / transparent */
    {
-      rsp->body = bindup(image_junkbuster_gif_data, image_junkbuster_gif_length);
-      rsp->content_length = image_junkbuster_gif_length;
+      rsp->body = bindup(image_blank_data, image_blank_length);
+      rsp->content_length = image_blank_length;
+
    }
-   else
+   else /* pattern */
    {
-      rsp->body = bindup(image_blank_gif_data, image_blank_gif_length);
-      rsp->content_length = image_blank_gif_length;
+      rsp->body = bindup(image_pattern_data, image_pattern_length);
+      rsp->content_length = image_pattern_length;
    }   
 
    if (rsp->body == NULL)
@@ -364,7 +458,7 @@ jb_err cgi_send_banner(struct client_state *csp,
       return JB_ERR_MEMORY;
    }
 
-   if (enlist(rsp->headers, "Content-Type: image/gif"))
+   if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
    {
       return JB_ERR_MEMORY;
    }
@@ -378,14 +472,14 @@ jb_err cgi_send_banner(struct client_state *csp,
 
 /*********************************************************************
  *
- * Function    :  cgi_transparent_gif
+ * Function    :  cgi_transparent_image
  *
- * Description :  CGI function that sends a 1x1 transparent GIF.
+ * Description :  CGI function that sends a 1x1 transparent image.
  *
  * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  parameters = map of cgi parameters
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
+ *           :  parameters = map of cgi parameters
  *
  * CGI Parameters : None
  *
@@ -393,19 +487,19 @@ jb_err cgi_send_banner(struct client_state *csp,
  *                JB_ERR_MEMORY on out-of-memory error.  
  *
  *********************************************************************/
-jb_err cgi_transparent_gif(struct client_state *csp,
-                           struct http_response *rsp,
-                           const struct map *parameters)
+jb_err cgi_transparent_image(struct client_state *csp,
+                             struct http_response *rsp,
+                             const struct map *parameters)
 {
-   rsp->body = bindup(image_blank_gif_data, image_blank_gif_length);
-   rsp->content_length = image_blank_gif_length;
+   rsp->body = bindup(image_blank_data, image_blank_length);
+   rsp->content_length = image_blank_length;
 
    if (rsp->body == NULL)
    {
       return JB_ERR_MEMORY;
    }
 
-   if (enlist(rsp->headers, "Content-Type: image/gif"))
+   if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
    {
       return JB_ERR_MEMORY;
    }
@@ -417,17 +511,68 @@ jb_err cgi_transparent_gif(struct client_state *csp,
 }
 
 
+/*********************************************************************
+ *
+ * Function    :  cgi_send_stylesheet
+ *
+ * Description :  CGI function that sends a css stylesheet found
+ *                in the cgi-style.css template
+ *
+ * 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     :  JB_ERR_OK on success
+ *                JB_ERR_MEMORY on out-of-memory error.  
+ *
+ *********************************************************************/
+jb_err cgi_send_stylesheet(struct client_state *csp,
+                           struct http_response *rsp,
+                           const struct map *parameters)
+{
+   jb_err err;
+   
+   assert(csp);
+   assert(rsp);
+
+   err = template_load(csp, &rsp->body, "cgi-style.css");
+
+   if (err == JB_ERR_FILE)
+   {
+      /*
+       * No way to tell user; send empty stylesheet
+       */
+      log_error(LOG_LEVEL_ERROR, "Could not find cgi-style.css template");
+   }
+   else if (err)
+   {
+      return err; /* JB_ERR_MEMORY */
+   }
+
+   if (enlist(rsp->headers, "Content-Type: text/css"))
+   {
+      return JB_ERR_MEMORY;
+   }
+
+   return JB_ERR_OK;
+
+}
+
+
 /*********************************************************************
  *
  * Function    :  cgi_show_version
  *
  * Description :  CGI function that returns a a web page describing the
- *                file versions of IJB.
+ *                file versions of Privoxy.
  *
  * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  parameters = map of cgi parameters
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
+ *           :  parameters = map of cgi parameters
  *
  * CGI Parameters : none
  *
@@ -465,12 +610,12 @@ jb_err cgi_show_version(struct client_state *csp,
  * Function    :  cgi_show_status
  *
  * Description :  CGI function that returns a a web page describing the
- *                current status of IJB.
+ *                current status of Privoxy.
  *
  * Parameters  :
- *           1 :  csp = Current client state (buffers, headers, etc...)
- *           2 :  rsp = http_response data structure for output
- *           3 :  parameters = map of cgi parameters
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
+ *           :  parameters = map of cgi parameters
  *
  * CGI Parameters :
  *        file :  Which file to show.  Only first letter is checked,
@@ -565,7 +710,6 @@ jb_err cgi_show_status(struct client_state *csp,
          while ((s != NULL) && fgets(buf, sizeof(buf), fp))
          {
             string_join  (&s, html_encode(buf));
-            string_append(&s, "<br>");
          }
          fclose(fp);
 
@@ -685,13 +829,13 @@ jb_err cgi_show_status(struct client_state *csp,
  * Function    :  cgi_show_url_info
  *
  * Description :  CGI function that determines and shows which actions
- *                junkbuster will perform for a given url, and which
+ *                Privoxy 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
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
+ *           :  parameters = map of cgi parameters
  *
  * CGI Parameters :
  *            url : The url whose actions are to be determined.
@@ -948,9 +1092,9 @@ jb_err cgi_show_url_info(struct client_state *csp,
  * 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
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
+ *           :  parameters = map of cgi parameters
  *
  * CGI Parameters : None
  *
@@ -966,7 +1110,7 @@ jb_err cgi_robots_txt(struct client_state *csp,
    jb_err err;
 
    rsp->body = strdup(
-      "# This is the Internet Junkbuster control interface.\n"
+      "# This is the Privoxy control interface.\n"
       "# It isn't very useful to index it, and you're likely to break stuff.\n"
       "# So go away!\n"
       "\n"
@@ -997,7 +1141,7 @@ jb_err cgi_robots_txt(struct client_state *csp,
  *                used when building
  *
  * Parameters  :
- *           1 :  exports = map to extend
+ *           :  exports = map to extend
  *
  * Returns     :  JB_ERR_OK on success
  *                JB_ERR_MEMORY on out-of-memory error.  
@@ -1033,8 +1177,10 @@ static jb_err show_defines(struct map *exports)
 
 #ifdef FEATURE_FORCE_LOAD
    if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 1);
+   if (!err) err = map(exports, "FORCE_PREFIX", 1, FORCE_PREFIX, 1);
 #else /* ifndef FEATURE_FORCE_LOAD */
    if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 0);
+   if (!err) err = map(exports, "FORCE_PREFIX", 1, "(none - disabled)", 1);
 #endif /* ndef FEATURE_FORCE_LOAD */
 
 #ifdef FEATURE_IMAGE_BLOCKING
@@ -1055,6 +1201,12 @@ static jb_err show_defines(struct map *exports)
    if (!err) err = map_conditional(exports, "FEATURE_KILL_POPUPS", 0);
 #endif /* ndef FEATURE_KILL_POPUPS */
 
+#ifdef FEATURE_NO_GIFS
+   if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 1);
+#else /* ifndef FEATURE_NO_GIFS */
+   if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 0);
+#endif /* ndef FEATURE_NO_GIFS */
+
 #ifdef FEATURE_PTHREAD
    if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 1);
 #else /* ifndef FEATURE_PTHREAD */
@@ -1079,18 +1231,6 @@ static jb_err show_defines(struct map *exports)
    if (!err) err = map_conditional(exports, "FEATURE_TRUST", 0);
 #endif /* ndef FEATURE_TRUST */
 
-#ifdef REGEX_GNU
-   if (!err) err = map_conditional(exports, "REGEX_GNU", 1);
-#else /* ifndef REGEX_GNU */
-   if (!err) err = map_conditional(exports, "REGEX_GNU", 0);
-#endif /* def REGEX_GNU */
-
-#ifdef REGEX_PCRE
-   if (!err) err = map_conditional(exports, "REGEX_PCRE", 1);
-#else /* ifndef REGEX_PCRE */
-   if (!err) err = map_conditional(exports, "REGEX_PCRE", 0);
-#endif /* def REGEX_PCRE */
-
 #ifdef STATIC_PCRE
    if (!err) err = map_conditional(exports, "STATIC_PCRE", 1);
 #else /* ifndef STATIC_PCRE */
@@ -1103,8 +1243,6 @@ static jb_err show_defines(struct map *exports)
    if (!err) err = map_conditional(exports, "STATIC_PCRS", 0);
 #endif /* ndef STATIC_PCRS */
 
-   if (!err) err = map(exports, "FORCE_PREFIX", 1, FORCE_PREFIX, 1);
-
    return err;
 }
 
@@ -1161,10 +1299,6 @@ static char *show_rcs(void)
    SHOW_RCS(filters_rcs)
    SHOW_RCS(gateway_h_rcs)
    SHOW_RCS(gateway_rcs)
-#ifdef GNU_REGEX
-   SHOW_RCS(gnu_regex_h_rcs)
-   SHOW_RCS(gnu_regex_rcs)
-#endif /* def GNU_REGEX */
    SHOW_RCS(jbsockets_h_rcs)
    SHOW_RCS(jbsockets_rcs)
    SHOW_RCS(jcc_h_rcs)