Adding graceful termination feature, to help look for memory leaks.
[privoxy.git] / cgisimple.c
index c3836db..1621baa 100644 (file)
@@ -1,4 +1,4 @@
-const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.14 2002/03/02 04:14:50 david__schmidt 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,21 @@ const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.14 2002/03/02 04:14:50 david_
  *
  * 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
  *
@@ -241,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
@@ -335,7 +392,7 @@ jb_err cgi_send_banner(struct client_state *csp,
    if (imagetype == 'a') /* auto */
    {
       /* Default to logo */
-      imagetype = 'l';
+      imagetype = 'p';
 #ifdef FEATURE_IMAGE_BLOCKING
       if ((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
       {
@@ -345,21 +402,31 @@ 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  if (imagetype == 'l') /* logo */
+   {
+      rsp->body = bindup(image_logo_data, image_logo_length);
+      rsp->content_length = image_logo_length;
+   }   
+   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)
@@ -367,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;
    }
@@ -381,9 +448,9 @@ 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...)
@@ -396,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;
    }
@@ -1058,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 */