Adding graceful termination feature, to help look for memory leaks.
[privoxy.git] / cgisimple.c
index 53634c8..1621baa 100644 (file)
@@ -1,4 +1,4 @@
-const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.12 2002/01/23 01:03:32 jongfoster Exp $";
+const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.18 2002/03/12 01:44:49 oes Exp $";
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/cgisimple.c,v $
@@ -36,6 +36,27 @@ const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.12 2002/01/23 01:03:32 jongfo
  *
  * Revisions   :
  *    $Log: cgisimple.c,v $
+ *    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
+ *
  *    Revision 1.12  2002/01/23 01:03:32  jongfoster
  *    Fixing gcc [CygWin] compiler warnings
  *
@@ -132,9 +153,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
  *
@@ -199,9 +220,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
  *
@@ -235,6 +256,48 @@ jb_err cgi_error_404(struct client_state *csp,
 }
 
 
+#ifdef FEATURE_GRACEFUL_TERMINATION
+/*********************************************************************
+ *
+ * Function    :  cgi_die
+ *
+ * Description :  CGI function to shut down JunkBuster.
+ *                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
@@ -243,9 +306,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
  *
@@ -306,14 +369,14 @@ 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",
- *                  and "auto". Defaults to "logo" if absent or invalid.\r
- *                  "auto" means to select as if we were image-blocking.\r
+ *                  and "auto". Defaults to "logo" if absent or invalid.
+ *                  "auto" means to select as if we were image-blocking.
  *                  (Only the first character really counts).
  *
  * Returns     :  JB_ERR_OK on success
@@ -323,37 +386,47 @@ jb_err cgi_show_request(struct client_state *csp,
 jb_err cgi_send_banner(struct client_state *csp,
                        struct http_response *rsp,
                        const struct map *parameters)
-{\r
+{
    char imagetype = lookup(parameters, "type")[0];
-\r
-   if (imagetype == 'a') /* auto */\r
-   {\r
-      /* Default to logo */\r
-      imagetype = 'l';\r
-#ifdef FEATURE_IMAGE_BLOCKING\r
-      if ((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)\r
-      {\r
-         /* determine HOW images should be blocked */\r
-         const char * p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER];\r
-\r
-         /* and handle accordingly: */\r
-         if ((p != NULL) && (0 == strcmpic(p, "blank")))\r
-         {\r
-            imagetype = 't';\r
-         }\r
-      }\r
-#endif /* def FEATURE_IMAGE_BLOCKING */\r
-   }\r
-      \r
-   if ((imagetype != 't') && (imagetype != 'b')) /* transparant/blank */
+
+   if (imagetype == 'a') /* auto */
+   {
+      /* Default to logo */
+      imagetype = 'p';
+#ifdef FEATURE_IMAGE_BLOCKING
+      if ((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
+      {
+         /* determine HOW images should be blocked */
+         const char * p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER];
+
+         /* and handle accordingly: */
+         if ((p != NULL) && (0 == strcmpic(p, "blank")))
+         {
+            imagetype = 'b';
+         }
+         else if ((p != NULL) && (0 == strcmpic(p, "pattern")))
+         {
+            imagetype = 'p';
+         }
+      }
+#endif /* def FEATURE_IMAGE_BLOCKING */
+   }
+      
+   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  if (imagetype == 'l') /* logo */
    {
-      rsp->body = bindup(image_blank_gif_data, image_blank_gif_length);
-      rsp->content_length = image_blank_gif_length;
+      rsp->body = bindup(image_logo_data, image_logo_length);
+      rsp->content_length = image_logo_length;
+   }   
+   else /* pattern */
+   {
+      rsp->body = bindup(image_pattern_data, image_pattern_length);
+      rsp->content_length = image_pattern_length;
    }   
 
    if (rsp->body == NULL)
@@ -361,7 +434,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;
    }
@@ -375,14 +448,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
  *
@@ -390,19 +463,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,
+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;
    }
@@ -422,9 +495,9 @@ jb_err cgi_transparent_gif(struct client_state *csp,
  *                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
+ *           :  csp = Current client state (buffers, headers, etc...)
+ *           :  rsp = http_response data structure for output
+ *           :  parameters = map of cgi parameters
  *
  * CGI Parameters : none
  *
@@ -465,9 +538,9 @@ jb_err cgi_show_version(struct client_state *csp,
  *                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
+ *           :  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,
@@ -686,9 +759,9 @@ jb_err cgi_show_status(struct client_state *csp,
  *                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.
@@ -945,9 +1018,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
  *
@@ -994,7 +1067,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.  
@@ -1052,6 +1125,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 */