miscutil.h

   1 #ifndef MISCUTIL_H_INCLUDED
   2 #define MISCUTIL_H_INCLUDED
   3 #define MISCUTIL_H_VERSION "$Id: miscutil.h,v 1.29 2007/09/09 18:20: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.29  2007/09/09 18:20:20  fabiankeil
  41  *    Turn privoxy_strlcpy() into a function and try to work with
  42  *    b0rked snprintf() implementations too. Reported by icmp30.
  43  *
  44  *    Revision 1.28  2007/05/11 11:48:16  fabiankeil
  45  *    - Delete strsav() which was replaced
  46  *      by string_append() years ago.
  47  *    - Add a strlcat() look-alike.
  48  *    - Use strlcat() and strlcpy() in those parts
  49  *      of the code that are run on unixes.
  50  *
  51  *    Revision 1.27  2007/04/09 17:48:51  fabiankeil
  52  *    Check for HAVE_SNPRINTF instead of __OS2__
  53  *    before including the portable snprintf() code.
  54  *
  55  *    Revision 1.26  2007/04/08 17:04:51  fabiankeil
  56  *    Add macro for strlcpy() in case the libc lacks it.
  57  *
  58  *    Revision 1.25  2007/01/18 15:03:20  fabiankeil
  59  *    Don't include replacement timegm() if
  60  *    putenv() or tzset() isn't available.
  61  *
  62  *    Revision 1.24  2006/08/17 17:15:10  fabiankeil
  63  *    - Back to timegm() using GnuPG's replacement if necessary.
  64  *      Using mktime() and localtime() could add a on hour offset if
  65  *      the randomize factor was big enough to lead to a summer/wintertime
  66  *      switch.
  67  *
  68  *    - Removed now-useless Privoxy 3.0.3 compatibility glue.
  69  *
  70  *    - Moved randomization code into pick_from_range().
  71  *
  72  *    - Changed parse_header_time definition.
  73  *      time_t isn't guaranteed to be signed and
  74  *      if it isn't, -1 isn't available as error code.
  75  *      Changed some variable types in client_if_modified_since()
  76  *      because of the same reason.
  77  *
  78  *    Revision 1.23  2006/07/18 14:48:47  david__schmidt
  79  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
  80  *    with what was really the latest development (the v_3_0_branch branch)
  81  *
  82  *    Revision 1.21  2002/04/26 12:55:38  oes
  83  *    New function string_toupper
  84  *
  85  *    Revision 1.20  2002/03/26 22:29:55  swa
  86  *    we have a new homepage!
  87  *
  88  *    Revision 1.19  2002/03/24 13:25:43  swa
  89  *    name change related issues
  90  *
  91  *    Revision 1.18  2002/03/07 03:46:17  oes
  92  *    Fixed compiler warnings
  93  *
  94  *    Revision 1.17  2002/03/04 18:28:32  oes
  95  *    Deleted deletePidFile, played syleguide police
  96  *
  97  *    Revision 1.16  2002/01/21 00:53:36  jongfoster
  98  *    Adding string_join()
  99  *
 100  *    Revision 1.15  2001/12/30 14:07:32  steudten
 101  *    - Add signal handling (unix)
 102  *    - Add SIGHUP handler (unix)
 103  *    - Add creation of pidfile (unix)
 104  *    - Add action 'top' in rc file (RH)
 105  *    - Add entry 'SIGNALS' to manpage
 106  *    - Add exit message to logfile (unix)
 107  *
 108  *    Revision 1.14  2001/11/05 21:43:48  steudten
 109  *    Add global var 'basedir' for unix os.
 110  *
 111  *    Revision 1.13  2001/10/29 03:48:10  david__schmidt
 112  *    OS/2 native needed a snprintf() routine.  Added one to miscutil, brackedted
 113  *    by and __OS2__ ifdef.
 114  *
 115  *    Revision 1.12  2001/10/23 21:27:50  jongfoster
 116  *    Standardising error codes in string_append
 117  *    make_path() no longer adds '\\' if the dir already ends in '\\' (this
 118  *    is just copying a UNIX-specific fix to the Windows-specific part)
 119  *
 120  *    Revision 1.11  2001/10/14 22:02:57  jongfoster
 121  *    New function string_append() which is like strsav(), but running
 122  *    out of memory isn't automatically FATAL.
 123  *
 124  *    Revision 1.10  2001/09/20 13:34:09  steudten
 125  *
 126  *    change long to int for prototype hash_string()
 127  *
 128  *    Revision 1.9  2001/07/29 18:43:08  jongfoster
 129  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
 130  *    ANSI C rules.
 131  *
 132  *    Revision 1.8  2001/06/29 13:32:14  oes
 133  *    Removed logentry from cancelled commit
 134  *
 135  *    Revision 1.7  2001/06/05 22:32:01  jongfoster
 136  *    New function make_path() to splice directory and file names together.
 137  *
 138  *    Revision 1.6  2001/06/03 19:12:30  oes
 139  *    introduced bindup()
 140  *
 141  *    Revision 1.5  2001/06/01 10:31:51  oes
 142  *    Added character class matching to trivimatch; renamed to simplematch
 143  *
 144  *    Revision 1.4  2001/05/31 17:32:31  oes
 145  *
 146  *     - Enhanced domain part globbing with infix and prefix asterisk
 147  *       matching and optional unanchored operation
 148  *
 149  *    Revision 1.3  2001/05/29 23:10:09  oes
 150  *
 151  *
 152  *     - Introduced chomp()
 153  *     - Moved strsav() from showargs to miscutil
 154  *
 155  *    Revision 1.2  2001/05/29 09:50:24  jongfoster
 156  *    Unified blocklist/imagelist/permissionslist.
 157  *    File format is still under discussion, but the internal changes
 158  *    are (mostly) done.
 159  *
 160  *    Also modified interceptor behaviour:
 161  *    - We now intercept all URLs beginning with one of the following
 162  *      prefixes (and *only* these prefixes):
 163  *        * http://i.j.b/
 164  *        * http://ijbswa.sf.net/config/
 165  *        * http://ijbswa.sourceforge.net/config/
 166  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
 167  *    - Internal changes so that intercepted and fast redirect pages
 168  *      are not replaced with an image.
 169  *    - Interceptors now have the option to send a binary page direct
 170  *      to the client. (i.e. ijb-send-banner uses this)
 171  *    - Implemented show-url-info interceptor.  (Which is why I needed
 172  *      the above interceptors changes - a typical URL is
 173  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
 174  *      The previous mechanism would not have intercepted that, and
 175  *      if it had been intercepted then it then it would have replaced
 176  *      it with an image.)
 177  *
 178  *    Revision 1.1.1.1  2001/05/15 13:59:00  oes
 179  *    Initial import of version 2.9.3 source tree
 180  *
 181  *
 182  *********************************************************************/
 183 \f
 184
 185 #include "project.h"
 186
 187 #if defined(__cplusplus)
 188 extern "C" {
 189 #endif
 190
 191 extern const char *basedir;
 192 extern void *zalloc(size_t size);
 193
 194 #if defined(unix)
 195 extern void write_pid_file(void);
 196 #endif /* unix */
 197
 198 extern unsigned int hash_string(const char* s);
 199
 200 extern char *safe_strerror(int err);
 201
 202 extern int strcmpic(const char *s1, const char *s2);
 203 extern int strncmpic(const char *s1, const char *s2, size_t n);
 204
 205 extern jb_err string_append(char **target_string, const char *text_to_append);
 206 extern jb_err string_join  (char **target_string,       char *text_to_append);
 207
 208 extern char *string_toupper(const char *string);
 209 extern char *chomp(char *string);
 210 extern char *bindup(const char *string, size_t len);
 211
 212 extern char *make_path(const char * dir, const char * file);
 213
 214 long int pick_from_range(long int range);
 215
 216 #ifdef __MINGW32__
 217 extern char *strdup(const char *s);
 218 #endif /* def __MINGW32__ */
 219
 220 #ifndef HAVE_SNPRINTF
 221 extern int snprintf(char *, size_t, const char *, /*args*/ ...);
 222 #endif /* ndef HAVE_SNPRINTF */
 223
 224 #if !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV)
 225 time_t timegm(struct tm *tm);
 226 #endif /* !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV) */
 227
 228 /* Here's looking at you, Ulrich. */
 229 #if !defined(HAVE_STRLCPY)
 230 size_t privoxy_strlcpy(char *destination, const char *source, size_t size);
 231 #define strlcpy privoxy_strlcpy
 232 #define USE_PRIVOXY_STRLCPY 1
 233 #define HAVE_STRLCPY 1
 234 #endif /* ndef HAVE_STRLCPY*/
 235
 236 #ifndef HAVE_STRLCAT
 237 size_t privoxy_strlcat(char *destination, const char *source, size_t size);
 238 #define strlcat privoxy_strlcat
 239 #endif /* ndef HAVE_STRLCAT */
 240
 241 /* Revision control strings from this header and associated .c file */
 242 extern const char miscutil_rcs[];
 243 extern const char miscutil_h_rcs[];
 244
 245 #if defined(__cplusplus)
 246 }
 247 #endif
 248
 249 #endif /* ndef MISCUTIL_H_INCLUDED */
 250
 251 /*
 252   Local Variables:
 253   tab-width: 3
 254   end:
 255 */