miscutil.h

   1 #ifndef MISCUTIL_H_INCLUDED
   2 #define MISCUTIL_H_INCLUDED
   3 #define MISCUTIL_H_VERSION "$Id: miscutil.h,v 1.25 2007/01/18 15:03:20 fabiankeil Exp $"
   4 /*********************************************************************
   5  *
   6  * File        :  $Source: /cvsroot/ijbswa/current/miscutil.h,v $
   7  *
   8  * Purpose     :  zalloc, hash_string, safe_strerror, strcmpic,
   9  *                strncmpic, and MinGW32 strdup functions.  These are
  10  *                each too small to deserve their own file but don't
  11  *                really fit in any other file.
  12  *
  13  * Copyright   :  Written by and Copyright (C) 2001-2007 the SourceForge
  14  *                Privoxy team. http://www.privoxy.org/
  15  *
  16  *                Based on the Internet Junkbuster originally written
  17  *                by and Copyright (C) 1997 Anonymous Coders and
  18  *                Junkbusters Corporation.  http://www.junkbusters.com
  19  *
  20  *                This program is free software; you can redistribute it
  21  *                and/or modify it under the terms of the GNU General
  22  *                Public License as published by the Free Software
  23  *                Foundation; either version 2 of the License, or (at
  24  *                your option) any later version.
  25  *
  26  *                This program is distributed in the hope that it will
  27  *                be useful, but WITHOUT ANY WARRANTY; without even the
  28  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  29  *                PARTICULAR PURPOSE.  See the GNU General Public
  30  *                License for more details.
  31  *
  32  *                The GNU General Public License should be included with
  33  *                this file.  If not, you can view it at
  34  *                http://www.gnu.org/copyleft/gpl.html
  35  *                or write to the Free Software Foundation, Inc., 59
  36  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  37  *
  38  * Revisions   :
  39  *    $Log: miscutil.h,v $
  40  *    Revision 1.25  2007/01/18 15:03:20  fabiankeil
  41  *    Don't include replacement timegm() if
  42  *    putenv() or tzset() isn't available.
  43  *
  44  *    Revision 1.24  2006/08/17 17:15:10  fabiankeil
  45  *    - Back to timegm() using GnuPG's replacement if necessary.
  46  *      Using mktime() and localtime() could add a on hour offset if
  47  *      the randomize factor was big enough to lead to a summer/wintertime
  48  *      switch.
  49  *
  50  *    - Removed now-useless Privoxy 3.0.3 compatibility glue.
  51  *
  52  *    - Moved randomization code into pick_from_range().
  53  *
  54  *    - Changed parse_header_time definition.
  55  *      time_t isn't guaranteed to be signed and
  56  *      if it isn't, -1 isn't available as error code.
  57  *      Changed some variable types in client_if_modified_since()
  58  *      because of the same reason.
  59  *
  60  *    Revision 1.23  2006/07/18 14:48:47  david__schmidt
  61  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
  62  *    with what was really the latest development (the v_3_0_branch branch)
  63  *
  64  *    Revision 1.21  2002/04/26 12:55:38  oes
  65  *    New function string_toupper
  66  *
  67  *    Revision 1.20  2002/03/26 22:29:55  swa
  68  *    we have a new homepage!
  69  *
  70  *    Revision 1.19  2002/03/24 13:25:43  swa
  71  *    name change related issues
  72  *
  73  *    Revision 1.18  2002/03/07 03:46:17  oes
  74  *    Fixed compiler warnings
  75  *
  76  *    Revision 1.17  2002/03/04 18:28:32  oes
  77  *    Deleted deletePidFile, played syleguide police
  78  *
  79  *    Revision 1.16  2002/01/21 00:53:36  jongfoster
  80  *    Adding string_join()
  81  *
  82  *    Revision 1.15  2001/12/30 14:07:32  steudten
  83  *    - Add signal handling (unix)
  84  *    - Add SIGHUP handler (unix)
  85  *    - Add creation of pidfile (unix)
  86  *    - Add action 'top' in rc file (RH)
  87  *    - Add entry 'SIGNALS' to manpage
  88  *    - Add exit message to logfile (unix)
  89  *
  90  *    Revision 1.14  2001/11/05 21:43:48  steudten
  91  *    Add global var 'basedir' for unix os.
  92  *
  93  *    Revision 1.13  2001/10/29 03:48:10  david__schmidt
  94  *    OS/2 native needed a snprintf() routine.  Added one to miscutil, brackedted
  95  *    by and __OS2__ ifdef.
  96  *
  97  *    Revision 1.12  2001/10/23 21:27:50  jongfoster
  98  *    Standardising error codes in string_append
  99  *    make_path() no longer adds '\\' if the dir already ends in '\\' (this
 100  *    is just copying a UNIX-specific fix to the Windows-specific part)
 101  *
 102  *    Revision 1.11  2001/10/14 22:02:57  jongfoster
 103  *    New function string_append() which is like strsav(), but running
 104  *    out of memory isn't automatically FATAL.
 105  *
 106  *    Revision 1.10  2001/09/20 13:34:09  steudten
 107  *
 108  *    change long to int for prototype hash_string()
 109  *
 110  *    Revision 1.9  2001/07/29 18:43:08  jongfoster
 111  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
 112  *    ANSI C rules.
 113  *
 114  *    Revision 1.8  2001/06/29 13:32:14  oes
 115  *    Removed logentry from cancelled commit
 116  *
 117  *    Revision 1.7  2001/06/05 22:32:01  jongfoster
 118  *    New function make_path() to splice directory and file names together.
 119  *
 120  *    Revision 1.6  2001/06/03 19:12:30  oes
 121  *    introduced bindup()
 122  *
 123  *    Revision 1.5  2001/06/01 10:31:51  oes
 124  *    Added character class matching to trivimatch; renamed to simplematch
 125  *
 126  *    Revision 1.4  2001/05/31 17:32:31  oes
 127  *
 128  *     - Enhanced domain part globbing with infix and prefix asterisk
 129  *       matching and optional unanchored operation
 130  *
 131  *    Revision 1.3  2001/05/29 23:10:09  oes
 132  *
 133  *
 134  *     - Introduced chomp()
 135  *     - Moved strsav() from showargs to miscutil
 136  *
 137  *    Revision 1.2  2001/05/29 09:50:24  jongfoster
 138  *    Unified blocklist/imagelist/permissionslist.
 139  *    File format is still under discussion, but the internal changes
 140  *    are (mostly) done.
 141  *
 142  *    Also modified interceptor behaviour:
 143  *    - We now intercept all URLs beginning with one of the following
 144  *      prefixes (and *only* these prefixes):
 145  *        * http://i.j.b/
 146  *        * http://ijbswa.sf.net/config/
 147  *        * http://ijbswa.sourceforge.net/config/
 148  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
 149  *    - Internal changes so that intercepted and fast redirect pages
 150  *      are not replaced with an image.
 151  *    - Interceptors now have the option to send a binary page direct
 152  *      to the client. (i.e. ijb-send-banner uses this)
 153  *    - Implemented show-url-info interceptor.  (Which is why I needed
 154  *      the above interceptors changes - a typical URL is
 155  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
 156  *      The previous mechanism would not have intercepted that, and
 157  *      if it had been intercepted then it then it would have replaced
 158  *      it with an image.)
 159  *
 160  *    Revision 1.1.1.1  2001/05/15 13:59:00  oes
 161  *    Initial import of version 2.9.3 source tree
 162  *
 163  *
 164  *********************************************************************/
 165 \f
 166
 167 #include "project.h"
 168
 169 #if defined(__cplusplus)
 170 extern "C" {
 171 #endif
 172
 173 extern const char *basedir;
 174 extern void *zalloc(size_t size);
 175
 176 #if defined(unix)
 177 extern void write_pid_file(void);
 178 #endif /* unix */
 179
 180 extern unsigned int hash_string(const char* s);
 181
 182 extern char *safe_strerror(int err);
 183
 184 extern int strcmpic(const char *s1, const char *s2);
 185 extern int strncmpic(const char *s1, const char *s2, size_t n);
 186
 187 extern char *strsav(char *old, const char *text_to_append);
 188 extern jb_err string_append(char **target_string, const char *text_to_append);
 189 extern jb_err string_join  (char **target_string,       char *text_to_append);
 190
 191 extern char *string_toupper(const char *string);
 192 extern char *chomp(char *string);
 193 extern int simplematch(char *pattern, char *text);
 194
 195 extern char *bindup(const char *string, size_t len);
 196
 197 extern char *make_path(const char * dir, const char * file);
 198
 199 long int pick_from_range(long int range);
 200
 201 #ifdef __MINGW32__
 202 extern char *strdup(const char *s);
 203 #endif /* def __MINGW32__ */
 204
 205 #ifdef __OS2__
 206 extern int snprintf(char *, size_t, const char *, /*args*/ ...);
 207 #endif /* def __OS2__ */
 208
 209 #if !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV)
 210 time_t timegm(struct tm *tm);
 211 #endif /* !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV) */
 212
 213 #if !defined(HAVE_STRLCPY)
 214 /* Here's looking at you, Ulrich. */
 215 #define strlcpy(dst, src, size) (size_t)snprintf((dst), (size), "%s", (src))
 216 #define HAVE_STRLCPY 1
 217 #endif /* ndef HAVE_STRLCPY*/
 218
 219 /* Revision control strings from this header and associated .c file */
 220 extern const char miscutil_rcs[];
 221 extern const char miscutil_h_rcs[];
 222
 223 #if defined(__cplusplus)
 224 }
 225 #endif
 226
 227 #endif /* ndef MISCUTIL_H_INCLUDED */
 228
 229 /*
 230   Local Variables:
 231   tab-width: 3
 232   end:
 233 */