Use macros for the magic numbers in decompress_iob().
[privoxy.git] / parsers.c
index 1dd1a22..fafd0e8 100644 (file)
--- a/parsers.c
+++ b/parsers.c
@@ -1,4 +1,4 @@
-const char parsers_rcs[] = "$Id: parsers.c,v 1.161 2009/05/19 18:02:03 fabiankeil Exp $";
+const char parsers_rcs[] = "$Id: parsers.c,v 1.172 2009/06/01 16:34:48 fabiankeil Exp $";
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/parsers.c,v $
@@ -67,6 +67,15 @@ const char parsers_rcs[] = "$Id: parsers.c,v 1.161 2009/05/19 18:02:03 fabiankei
 
 #ifdef FEATURE_ZLIB
 #include <zlib.h>
+
+#define GZIP_IDENTIFIER_1       0x1f
+#define GZIP_IDENTIFIER_2       0x8b
+
+#define GZIP_FLAG_CHECKSUM      0x02
+#define GZIP_FLAG_EXTRA_FIELDS  0x04
+#define GZIP_FLAG_FILE_NAME     0x08
+#define GZIP_FLAG_COMMENT       0x10
+#define GZIP_FLAG_RESERVED_BITS 0xe0
 #endif
 
 #if !defined(_WIN32) && !defined(__OS2__)
@@ -423,8 +432,8 @@ jb_err decompress_iob(struct client_state *csp)
        * Strip off the gzip header. Please see RFC 1952 for more
        * explanation of the appropriate fields.
        */
-      if ((*cur++ != (char)0x1f)
-       || (*cur++ != (char)0x8b)
+      if (((*cur++ & 0xff) != GZIP_IDENTIFIER_1)
+       || ((*cur++ & 0xff) != GZIP_IDENTIFIER_2)
        || (*cur++ != Z_DEFLATED))
       {
          log_error(LOG_LEVEL_ERROR, "Invalid gzip header when decompressing");
@@ -433,11 +442,7 @@ jb_err decompress_iob(struct client_state *csp)
       else
       {
          int flags = *cur++;
-         /*
-          * XXX: These magic numbers should be replaced
-          * with macros to give a better idea what they do.
-          */
-         if (flags & 0xe0)
+         if (flags & GZIP_FLAG_RESERVED_BITS)
          {
             /* The gzip header has reserved bits set; bail out. */
             log_error(LOG_LEVEL_ERROR, "Invalid gzip header flags when decompressing");
@@ -446,35 +451,18 @@ jb_err decompress_iob(struct client_state *csp)
          cur += 6;
 
          /* Skip extra fields if necessary. */
-         if (flags & 0x04)
+         if (flags & GZIP_FLAG_EXTRA_FIELDS)
          {
             /*
              * Skip a given number of bytes, specified
              * as a 16-bit little-endian value.
-             */
-            /*
-             * XXX: This code used to be:
-             * 
-             * csp->iob->cur += *csp->iob->cur++ + (*csp->iob->cur++ << 8);
-             *
-             * which I had to change into:
-             *
-             * cur += *cur++ + (*cur++ << 8);
-             *
-             * at which point gcc43 finally noticed that the value
-             * of cur is undefined (it depends on which of the
-             * summands is evaluated first).
              *
-             * I haven't come across a site where this
-             * code is actually executed yet, but I hope
-             * it works anyway.
+             * XXX: this code is untested and should probably be removed.
              */
             int skip_bytes;
             skip_bytes = *cur++;
             skip_bytes += *cur++ << 8;
 
-            assert(skip_bytes == *csp->iob->cur - 2 + ((*csp->iob->cur - 1) << 8));
-
             /*
              * The number of bytes to skip should be positive
              * and we'd like to stay in the buffer.
@@ -493,7 +481,7 @@ jb_err decompress_iob(struct client_state *csp)
          }
 
          /* Skip the filename if necessary. */
-         if (flags & 0x08)
+         if (flags & GZIP_FLAG_FILE_NAME)
          {
             /* A null-terminated string is supposed to follow. */
             while (*cur++ && (cur < csp->iob->eod));
@@ -501,14 +489,14 @@ jb_err decompress_iob(struct client_state *csp)
          }
 
          /* Skip the comment if necessary. */
-         if (flags & 0x10)
+         if (flags & GZIP_FLAG_COMMENT)
          {
             /* A null-terminated string is supposed to follow. */
             while (*cur++ && (cur < csp->iob->eod));
          }
 
          /* Skip the CRC if necessary. */
-         if (flags & 0x02)
+         if (flags & GZIP_FLAG_CHECKSUM)
          {
             cur += 2;
          }
@@ -568,7 +556,7 @@ jb_err decompress_iob(struct client_state *csp)
     * Passing -MAX_WBITS to inflateInit2 tells the library
     * that there is no zlib header.
     */
-   if (inflateInit2 (&zstr, -MAX_WBITS) != Z_OK)
+   if (inflateInit2(&zstr, -MAX_WBITS) != Z_OK)
    {
       log_error(LOG_LEVEL_ERROR, "Error initializing decompression");
       return JB_ERR_COMPRESS;
@@ -599,14 +587,15 @@ jb_err decompress_iob(struct client_state *csp)
       char *tmpbuf;                /* used for realloc'ing the buffer */
       size_t oldbufsize = bufsize; /* keep track of the old bufsize */
 
-      /*
-       * If zlib wants more data then there's a problem, because
-       * the complete compressed file should have been buffered.
-       */
       if (0 == zstr.avail_in)
       {
-         log_error(LOG_LEVEL_ERROR, "Unexpected end of compressed iob");
-         return JB_ERR_COMPRESS;
+         /*
+          * If zlib wants more data then there's a problem, because
+          * the complete compressed file should have been buffered.
+          */
+         log_error(LOG_LEVEL_ERROR,
+            "Unexpected end of compressed iob. Using what we got so far.");
+         break;
       }
 
       /*
@@ -676,11 +665,15 @@ jb_err decompress_iob(struct client_state *csp)
        */
    }
 
-   if (status != Z_STREAM_END)
+   if ((status != Z_STREAM_END) && (0 != zstr.avail_in))
    {
-      /* We failed to decompress the stream. */
+      /*
+       * We failed to decompress the stream and it's
+       * not simply because of missing data.
+       */
       log_error(LOG_LEVEL_ERROR,
-         "Error in decompressing to the buffer (iob): %s", zstr.msg);
+         "Unexpected error while decompressing to the buffer (iob): %s",
+         zstr.msg);
       return JB_ERR_COMPRESS;
    }
 
@@ -2230,7 +2223,6 @@ static jb_err server_last_modified(struct client_state *csp, char **header)
 #endif
    struct tm *timeptr = NULL;
    time_t now, last_modified;                  
-   long int rtime;
    long int days, hours, minutes, seconds;
    
    /*
@@ -2280,7 +2272,7 @@ static jb_err server_last_modified(struct client_state *csp, char **header)
       now = time(NULL);
 #ifdef HAVE_GMTIME_R
       gmtime_r(&now, &gmt);
-#elif FEATURE_PTHREAD
+#elif defined(MUTEX_LOCKS_AVAILABLE)
       privoxy_mutex_lock(&gmtime_mutex);
       gmtime(&now);
       privoxy_mutex_unlock(&gmtime_mutex);
@@ -2294,23 +2286,25 @@ static jb_err server_last_modified(struct client_state *csp, char **header)
       }
       else
       {
-         rtime = (long int)difftime(now, last_modified);
+         long int rtime = (long int)difftime(now, last_modified);
          if (rtime)
          {
-            int negative = 0;
+            const int negative_delta = (rtime < 0);
 
-            if (rtime < 0)
+            if (negative_delta)
             {
                rtime *= -1; 
-               negative = 1;
                log_error(LOG_LEVEL_HEADER, "Server time in the future.");
             }
             rtime = pick_from_range(rtime);
-            if (negative) rtime *= -1;
+            if (negative_delta)
+            {
+               rtime *= -1;
+            }
             last_modified += rtime;
 #ifdef HAVE_GMTIME_R
             timeptr = gmtime_r(&last_modified, &gmt);
-#elif FEATURE_PTHREAD
+#elif defined(MUTEX_LOCKS_AVAILABLE)
             privoxy_mutex_lock(&gmtime_mutex);
             timeptr = gmtime(&last_modified);
             privoxy_mutex_unlock(&gmtime_mutex);
@@ -2972,9 +2966,7 @@ static jb_err client_if_modified_since(struct client_state *csp, char **header)
    struct tm *timeptr = NULL;
    time_t tm = 0;                  
    const char *newval;
-   long int rtime;
    long int hours, minutes, seconds;
-   int negative = 0;
    char * endptr;
    
    if ( 0 == strcmpic(*header, "If-Modified-Since: Wed, 08 Jun 1955 12:00:00 GMT"))
@@ -3009,15 +3001,16 @@ static jb_err client_if_modified_since(struct client_state *csp, char **header)
          }
          else
          {
-            rtime = strtol(newval, &endptr, 0);
+            long int rtime = strtol(newval, &endptr, 0);
+            const int negative_range = (rtime < 0);
+
             if (rtime)
             {
                log_error(LOG_LEVEL_HEADER, "Randomizing: %s (random range: %d minut%s)",
                   *header, rtime, (rtime == 1 || rtime == -1) ? "e": "es");
-               if (rtime < 0)
+               if (negative_range)
                {
                   rtime *= -1; 
-                  negative = 1;
                }
                rtime *= 60;
                rtime = pick_from_range(rtime);
@@ -3027,10 +3020,10 @@ static jb_err client_if_modified_since(struct client_state *csp, char **header)
                log_error(LOG_LEVEL_ERROR, "Random range is 0. Assuming time transformation test.",
                   *header);
             }
-            tm += rtime * (negative ? -1 : 1);
+            tm += rtime * (negative_range ? -1 : 1);
 #ifdef HAVE_GMTIME_R
             timeptr = gmtime_r(&tm, &gmt);
-#elif FEATURE_PTHREAD
+#elif defined(MUTEX_LOCKS_AVAILABLE)
             privoxy_mutex_lock(&gmtime_mutex);
             timeptr = gmtime(&tm);
             privoxy_mutex_unlock(&gmtime_mutex);
@@ -3055,7 +3048,7 @@ static jb_err client_if_modified_since(struct client_state *csp, char **header)
 
             log_error(LOG_LEVEL_HEADER,
                "Randomized:  %s (%s %d hou%s %d minut%s %d second%s",
-               *header, (negative) ? "subtracted" : "added", hours,
+               *header, (negative_range) ? "subtracted" : "added", hours,
                (hours == 1) ? "r" : "rs", minutes, (minutes == 1) ? "e" : "es",
                seconds, (seconds == 1) ? ")" : "s)");
          }
@@ -3389,7 +3382,8 @@ static jb_err server_connection_adder(struct client_state *csp)
  * Function    :  server_proxy_connection_adder
  *
  * Description :  Adds a "Proxy-Connection: keep-alive" header to
- *                csp->headers. XXX: We should reuse existant ones.
+ *                csp->headers if the client asked for keep-alive.
+ *                XXX: We should reuse existant ones.
  *
  * Parameters  :
  *          1  :  csp = Current client state (buffers, headers, etc...)
@@ -3401,8 +3395,15 @@ static jb_err server_connection_adder(struct client_state *csp)
 static jb_err server_proxy_connection_adder(struct client_state *csp)
 {
    static const char proxy_connection_header[] = "Proxy-Connection: keep-alive";
-   log_error(LOG_LEVEL_HEADER, "Adding: %s", proxy_connection_header);
-   return enlist(csp->headers, proxy_connection_header);
+   jb_err err = JB_ERR_OK;
+
+   if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
+   {
+      log_error(LOG_LEVEL_HEADER, "Adding: %s", proxy_connection_header);
+      err = enlist(csp->headers, proxy_connection_header);
+   }
+
+   return err;
 }
 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
 
@@ -3423,15 +3424,20 @@ static jb_err server_proxy_connection_adder(struct client_state *csp)
  *********************************************************************/
 static jb_err client_connection_header_adder(struct client_state *csp)
 {
-   const unsigned int flags = csp->flags;
    const char *wanted_header = get_appropiate_connection_header(csp);
 
-   if (!(flags & CSP_FLAG_CLIENT_HEADER_PARSING_DONE)
-     && (flags & CSP_FLAG_CLIENT_CONNECTION_HEADER_SET))
+   if (!(csp->flags & CSP_FLAG_CLIENT_HEADER_PARSING_DONE)
+     && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_HEADER_SET))
    {
       return JB_ERR_OK;
    }
 
+   if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
+      && (csp->http->ssl == 0))
+   {
+      csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
+   }
+
    log_error(LOG_LEVEL_HEADER, "Adding: %s", wanted_header);
 
    return enlist(csp->headers, wanted_header);