Reference action files in CGI URLs by id instead
[privoxy.git] / miscutil.c
index a1715d1..38f9fc0 100644 (file)
@@ -1,4 +1,4 @@
-const char miscutil_rcs[] = "$Id: miscutil.c,v 1.29 2002/03/04 02:08:02 david__schmidt Exp $";
+const char miscutil_rcs[] = "$Id: miscutil.c,v 1.47 2007/03/17 11:52:15 fabiankeil Exp $";
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/miscutil.c,v $
@@ -9,13 +9,21 @@ const char miscutil_rcs[] = "$Id: miscutil.c,v 1.29 2002/03/04 02:08:02 david__s
  *                These are each too small to deserve their own file
  *                but don't really fit in any other file.
  *
- * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
- *                IJBSWA team.  http://ijbswa.sourceforge.net
+ * Copyright   :  Written by and Copyright (C) 2001-2007
+ *                the SourceForge Privoxy team. http://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
  *                by and Copyright (C) 1997 Anonymous Coders and 
  *                Junkbusters Corporation.  http://www.junkbusters.com
  *
+ *                The timegm replacement function was taken from GnuPG,
+ *                Copyright (C) 2004 Free Software Foundation, Inc.
+ *
+ *                The snprintf replacement function is written by
+ *                Mark Martinec who also holds the copyright. It can be
+ *                used under the terms of the GPL or the terms of the
+ *                "Frontier Artistic License".
+ *
  *                This program is free software; you can redistribute it 
  *                and/or modify it under the terms of the GNU General
  *                Public License as published by the Free Software
@@ -36,6 +44,96 @@ const char miscutil_rcs[] = "$Id: miscutil.c,v 1.29 2002/03/04 02:08:02 david__s
  *
  * Revisions   :
  *    $Log: miscutil.c,v $
+ *    Revision 1.47  2007/03/17 11:52:15  fabiankeil
+ *    - Use snprintf instead of sprintf.
+ *    - Mention copyright for the replacement
+ *      functions in the copyright header.
+ *
+ *    Revision 1.46  2007/01/18 15:03:20  fabiankeil
+ *    Don't include replacement timegm() if
+ *    putenv() or tzset() isn't available.
+ *
+ *    Revision 1.45  2006/12/26 17:31:41  fabiankeil
+ *    Mutex protect rand() if POSIX threading
+ *    is used, warn the user if that's not possible
+ *    and stop using it on _WIN32 where it could
+ *    cause crashes.
+ *
+ *    Revision 1.44  2006/11/07 12:46:43  fabiankeil
+ *    Silence compiler warning on NetBSD 3.1.
+ *
+ *    Revision 1.43  2006/09/23 13:26:38  roro
+ *    Replace TABs by spaces in source code.
+ *
+ *    Revision 1.42  2006/09/09 14:01:45  fabiankeil
+ *    Integrated Oliver Yeoh's domain pattern fix
+ *    to make sure *x matches xx. Closes Patch 1217393
+ *    and Bug 1170767.
+ *
+ *    Revision 1.41  2006/08/18 16:03:17  david__schmidt
+ *    Tweak for OS/2 build happiness.
+ *
+ *    Revision 1.40  2006/08/17 17:15:10  fabiankeil
+ *    - Back to timegm() using GnuPG's replacement if necessary.
+ *      Using mktime() and localtime() could add a on hour offset if
+ *      the randomize factor was big enough to lead to a summer/wintertime
+ *      switch.
+ *
+ *    - Removed now-useless Privoxy 3.0.3 compatibility glue.
+ *
+ *    - Moved randomization code into pick_from_range().
+ *
+ *    - Changed parse_header_time definition.
+ *      time_t isn't guaranteed to be signed and
+ *      if it isn't, -1 isn't available as error code.
+ *      Changed some variable types in client_if_modified_since()
+ *      because of the same reason.
+ *
+ *    Revision 1.39  2006/07/18 14:48:46  david__schmidt
+ *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
+ *    with what was really the latest development (the v_3_0_branch branch)
+ *
+ *    Revision 1.37.2.4  2003/12/01 14:45:14  oes
+ *    Fixed two more problems with wildcarding in simplematch()
+ *
+ *    Revision 1.37.2.3  2003/11/20 11:39:24  oes
+ *    Bugfix: The "?" wildcard for domain names had never been implemented. Ooops\!
+ *
+ *    Revision 1.37.2.2  2002/11/12 14:28:18  oes
+ *    Proper backtracking in simplematch; fixes bug #632888
+ *
+ *    Revision 1.37.2.1  2002/09/25 12:58:51  oes
+ *    Made strcmpic and strncmpic safe against NULL arguments
+ *    (which are now treated as empty strings).
+ *
+ *    Revision 1.37  2002/04/26 18:29:43  jongfoster
+ *    Fixing this Visual C++ warning:
+ *    miscutil.c(710) : warning C4090: '=' : different 'const' qualifiers
+ *
+ *    Revision 1.36  2002/04/26 12:55:38  oes
+ *    New function string_toupper
+ *
+ *    Revision 1.35  2002/03/26 22:29:55  swa
+ *    we have a new homepage!
+ *
+ *    Revision 1.34  2002/03/24 13:25:43  swa
+ *    name change related issues
+ *
+ *    Revision 1.33  2002/03/07 03:46:53  oes
+ *    Fixed compiler warnings etc
+ *
+ *    Revision 1.32  2002/03/06 23:02:57  jongfoster
+ *    Removing tabs
+ *
+ *    Revision 1.31  2002/03/05 04:52:42  oes
+ *    Deleted non-errlog debugging code
+ *
+ *    Revision 1.30  2002/03/04 18:27:42  oes
+ *    - Deleted deletePidFile
+ *    - Made write_pid_file use the --pidfile option value
+ *      (or no PID file, if the option was absent)
+ *    - Played styleguide police
+ *
  *    Revision 1.29  2002/03/04 02:08:02  david__schmidt
  *    Enable web editing of actions file on OS/2 (it had been broken all this time!)
  *
@@ -188,6 +286,10 @@ const char miscutil_rcs[] = "$Id: miscutil.c,v 1.29 2002/03/04 02:08:02 david__s
 #include <ctype.h>
 #include <assert.h>
 
+#if !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV)
+#include <time.h>
+#endif /* !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV) */
+
 #include "project.h"
 #include "miscutil.h"
 #include "errlog.h"
@@ -208,7 +310,7 @@ const char miscutil_h_rcs[] = MISCUTIL_H_VERSION;
  * Returns     :  Pointer to newly malloc'd memory chunk.
  *
  *********************************************************************/
-void *zalloc(int size)
+void *zalloc(size_t size)
 {
    void * ret;
 
@@ -279,7 +381,7 @@ unsigned int hash_string( const char* s )
 
    for ( ; *s; ++s )
    {
-      h = 5 * h + *s;
+      h = 5 * h + (unsigned int)*s;
    }
 
    return (h);
@@ -347,7 +449,7 @@ char *safe_strerror(int err)
 
    if (s == NULL)
    {
-      sprintf(buf, "(errno = %d)", err);
+      snprintf(buf, sizeof(buf), "(errno = %d)", err);
       s = buf;
    }
 
@@ -371,6 +473,9 @@ char *safe_strerror(int err)
  *********************************************************************/
 int strcmpic(const char *s1, const char *s2)
 {
+   if (!s1) s1 = "";
+   if (!s2) s2 = "";
+
    while (*s1 && *s2)
    {
       if ( ( *s1 != *s2 ) && ( ijb_tolower(*s1) != ijb_tolower(*s2) ) )
@@ -401,7 +506,9 @@ int strcmpic(const char *s1, const char *s2)
 int strncmpic(const char *s1, const char *s2, size_t n)
 {
    if (n <= 0) return(0);
-
+   if (!s1) s1 = "";
+   if (!s2) s2 = "";
+   
    while (*s1 && *s2)
    {
       if ( ( *s1 != *s2 ) && ( ijb_tolower(*s1) != ijb_tolower(*s2) ) )
@@ -491,10 +598,10 @@ char *chomp(char *string)
  *********************************************************************/
 char *strsav(char *old, const char *text_to_append)
 {
-   int old_len, new_len = 0;
+   size_t old_len, new_len = 0;
    char *p;
 
-   if (( text_to_append == NULL) || (*text_to_append == '\0'))
+   if ((text_to_append == NULL) || (*text_to_append == '\0'))
    {
       return(old);
    }
@@ -503,7 +610,7 @@ char *strsav(char *old, const char *text_to_append)
    {
       if ((p = strdup(text_to_append)) == NULL)
       {
-         log_error(LOG_LEVEL_FATAL, "strdup() failed!", new_len);
+         log_error(LOG_LEVEL_FATAL, "strdup() failed!");
          /* Never get here - LOG_LEVEL_FATAL causes program exit */
       }
       return p;
@@ -660,6 +767,43 @@ jb_err string_join(char **target_string, char *text_to_append)
 }
 
 
+/*********************************************************************
+ *
+ * Function    :  string_toupper
+ *
+ * Description :  Produce a copy of string with all convertible
+ *                characters converted to uppercase.
+ *
+ * Parameters  :
+ *          1  :  string = string to convert
+ *
+ * Returns     :  Uppercase copy of string if possible, 
+ *                NULL on out-of-memory or if string was NULL.
+ *
+ *********************************************************************/
+char *string_toupper(const char *string)
+{
+   char *result, *p;
+   const char *q;
+
+   if (!string || ((result = (char *) zalloc(strlen(string) + 1)) == NULL))
+   {
+      return NULL;
+   }
+   
+   q = string;
+   p = result;
+
+   while (*q != '\0')
+   {
+      *p++ = toupper((int) *q++);
+   }
+
+   return result;
+
+}
+
+
 /*********************************************************************
  *
  * Function    :  simplematch
@@ -687,14 +831,20 @@ int simplematch(char *pattern, char *text)
    unsigned i;
    unsigned char charmap[32];
   
-  
    while (*txt)
    {
 
       /* EOF pattern but !EOF text? */
       if (*pat == '\0')
       {
-         return 1;
+         if (wildcard)
+         {
+            pat = fallback;
+         }
+         else
+         {
+            return 1;
+         }
       }
 
       /* '*' in the pattern?  */
@@ -743,26 +893,42 @@ int simplematch(char *pattern, char *text)
       } /* -END- if Character range specification */
 
 
-      /* Compare: Char match, or char range match*/
-      if ((*pat == *txt)  
-      || ((*pat == ']') && (charmap[*txt / 8] & (1 << (*txt % 8)))) )
+      /* 
+       * Char match, or char range match? 
+       */
+      if ( (*pat == *txt)
+      ||   (*pat == '?')
+      ||   ((*pat == ']') && (charmap[*txt / 8] & (1 << (*txt % 8)))) )
       {
-         /* Sucess, go ahead */
+         /* 
+          * Sucess: Go ahead
+          */
          pat++;
       }
-      else
+      else if (!wildcard)
       {
-         /* In wildcard mode, just try again after failiure */
-         if(wildcard)
-         {
-            pat = fallback;
-         }
-
-         /* Else, bad luck */
-         else
+         /* 
+          * No match && no wildcard: No luck
+          */
+         return 1;
+      }
+      else if (pat != fallback)
+      {
+         /*
+          * Increment text pointer if in char range matching
+          */
+         if (*pat == ']')
          {
-            return 1;
+            txt++;
          }
+         /*
+          * Wildcard mode && nonmatch beyond fallback: Rewind pattern
+          */
+         pat = fallback;
+         /*
+          * Restart matching from current text pointer
+          */
+         continue;
       }
       txt++;
    }
@@ -785,25 +951,25 @@ int simplematch(char *pattern, char *text)
  *
  * Parameters  :
  *          1  :  string = string to be duplicated
- *          2  :  n = number of bytes to duplicate
+ *          2  :  len = number of bytes to duplicate
  *
  * Returns     :  pointer to copy, or NULL if failiure
  *
  *********************************************************************/
-char *bindup(const char *string, int n)
+char *bindup(const char *string, size_t len)
 {
-   char *dup;
+   char *duplicate;
 
-   if (NULL == (dup = (char *)malloc(n)))
+   if (NULL == (duplicate = (char *)malloc(len)))
    {
       return NULL;
    }
    else
    {
-     memcpy(dup, string, n);
+     memcpy(duplicate, string, len);
    }
 
-   return dup;
+   return duplicate;
 
 }
 
@@ -884,18 +1050,17 @@ char * make_path(const char * dir, const char * file)
 #if defined(unix)
       if ( *dir != '/' && basedir && *basedir )
       {
-             path = malloc( strlen( basedir ) + strlen(dir) + strlen(file) + 3);
-             if (!path ) log_error(LOG_LEVEL_FATAL, "malloc failed!");
-             strcpy(path, basedir);
-             strcat(path, "/");
-             strcat(path, dir);
-             DBG(1, ("make_path: path: %s\n",path) );
+         path = malloc( strlen( basedir ) + strlen(dir) + strlen(file) + 3);
+         if (!path ) log_error(LOG_LEVEL_FATAL, "malloc failed!");
+         strcpy(path, basedir);
+         strcat(path, "/");
+         strcat(path, dir);
       }
       else
       {
-             path = malloc(strlen(dir) + strlen(file) + 2);
-             if (!path ) log_error(LOG_LEVEL_FATAL, "malloc failed!");
-             strcpy(path, dir);
+         path = malloc(strlen(dir) + strlen(file) + 2);
+         if (!path ) log_error(LOG_LEVEL_FATAL, "malloc failed!");
+         strcpy(path, dir);
       }
 #else
 
@@ -924,11 +1089,114 @@ char * make_path(const char * dir, const char * file)
 }
 
 
+/*********************************************************************
+ *
+ * Function    :  pick_from_range
+ *
+ * Description :  Pick a positive number out of a given range.
+ *                Should only be used if randomness would be nice,
+ *                but isn't really necessary.
+ *
+ * Parameters  :
+ *          1  :  range: Highest possible number to pick.
+ *
+ * Returns     :  Picked number. 
+ *
+ *********************************************************************/
+
+long int pick_from_range(long int range)
+{
+   long int number;
+#ifdef HAVE_RANDOM
+   number = random() % range + 1; 
+#elif defined(FEATURE_PTHREAD)
+   pthread_mutex_lock(&rand_mutex);
+   number = rand() % (long int)(range + 1);
+   pthread_mutex_unlock(&rand_mutex);
+#else
+#ifdef _WIN32
+   /*
+    * On Windows and mingw32 srand() has to be called in every
+    * rand()-using thread, but can cause crashes if it's not
+    * mutex protected.
+    *
+    * Currently we don't have mutexes for mingw32, and for
+    * our purpose this cludge is probably preferable to crashes.
+    */
+   log_error(LOG_LEVEL_INFO, "No thread-safe PRNG available? Using weak \'randomization\' factor.");
+   number = (range + GetCurrentThreadId() % range) / 2;
+#else
+   /*
+    * XXX: Which platforms reach this and are there
+    * better options than just using rand() and hoping
+    * that it's safe?
+    */
+   log_error(LOG_LEVEL_INFO, "No thread-safe PRNG available? Header time randomization might cause "
+      "crashes, predictable results or even combine these fine options.");
+   number = rand() % (long int)(range + 1);
+#endif /* def _WIN32 */ 
+
+#endif /* (def HAVE_RANDOM) */
+
+   return (number);
+}
+
+
+#if !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV)
+/*********************************************************************
+ *
+ * Function    :  timegm
+ *
+ * Description :  libc replacement function for the inverse of gmtime()
+ *                Copyright (C) 2004 Free Software Foundation, Inc.
+ *                Code copied from GnuPG with minor style changes.
+ *
+ * Parameters  :
+ *          1  :  tm: Broken-down time struct.
+ *
+ * Returns     :  tm converted into time_t seconds. 
+ *
+ *********************************************************************/
+
+time_t timegm(struct tm *tm)
+{
+   time_t answer;
+   char *zone;
+
+   zone=getenv("TZ");
+   putenv("TZ=UTC");
+   tzset();
+   answer=mktime(tm);
+   if(zone)
+   {
+      char *old_zone;
+
+      old_zone=malloc(3+strlen(zone)+1);
+      if(old_zone)
+      {
+         strcpy(old_zone,"TZ=");
+         strcat(old_zone,zone);
+         putenv(old_zone);
+      }
+   }
+   else
+   {
+#ifdef HAVE_UNSETENV
+      unsetenv("TZ");
+#else
+      putenv("TZ");
+#endif
+   }
+   tzset();
+   return answer;
+}
+#endif /* !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV) */
+
+
+#ifndef HAVE_SNPRINTF
 /*
  * What follows is a portable snprintf routine, written by Mark Martinec.
  * See: http://www.ijs.si/software/snprintf/
- * Anyone who needs it can add a define for themselves... so far, only 
- * OS/2 (native) lacks snprintf.
 
                                   snprintf.c
                    - a portable implementation of snprintf,
@@ -950,8 +1218,6 @@ Author
 
  */
 
-#ifdef __OS2__
-
 #define PORTABLE_SNPRINTF_VERSION_MAJOR 2
 #define PORTABLE_SNPRINTF_VERSION_MINOR 2
 
@@ -1008,24 +1274,24 @@ Author
  * Small values favor memcpy, large values favor inline code.
  */
 #if defined(__alpha__) || defined(__alpha)
-#  define breakeven_point   2  /* AXP (DEC Alpha)     - gcc or cc or egcs */
+#  define breakeven_point   2    /* AXP (DEC Alpha)     - gcc or cc or egcs */
 #endif
 #if defined(__i386__)  || defined(__i386)
-#  define breakeven_point  12  /* Intel Pentium/Linux - gcc 2.96 */
+#  define breakeven_point  12    /* Intel Pentium/Linux - gcc 2.96 */
 #endif
 #if defined(__hppa)
-#  define breakeven_point  10  /* HP-PA               - gcc */
+#  define breakeven_point  10    /* HP-PA               - gcc */
 #endif
 #if defined(__sparc__) || defined(__sparc)
-#  define breakeven_point  33  /* Sun Sparc 5         - gcc 2.8.1 */
+#  define breakeven_point  33    /* Sun Sparc 5         - gcc 2.8.1 */
 #endif
 
 /* some other values of possible interest: */
-/* #define breakeven_point  8 */  /* VAX 4000          - vaxc */
-/* #define breakeven_point 19 */  /* VAX 4000          - gcc 2.7.0 */
+/* #define breakeven_point  8 */ /* VAX 4000          - vaxc */
+/* #define breakeven_point 19 */ /* VAX 4000          - gcc 2.7.0 */
 
 #ifndef breakeven_point
-#  define breakeven_point   6  /* some reasonable one-size-fits-all value */
+#  define breakeven_point   6    /* some reasonable one-size-fits-all value */
 #endif
 
 #define fast_memcpy(d,s,n) \
@@ -1691,7 +1957,7 @@ int portable_vsnprintf(char *str, size_t str_m, const char *fmt, va_list ap) {
   return (int) str_l;
 }
 #endif
-#endif /* __OS2__ */
+#endif /* ndef HAVE_SNPRINTF */
 /*
   Local Variables:
   tab-width: 3