jcc.h

   1 #ifndef JCC_H_INCLUDED
   2 #define JCC_H_INCLUDED
   3 #define JCC_H_VERSION "$Id: jcc.h,v 1.22 2007/06/01 18:16:36 fabiankeil Exp $"
   4 /*********************************************************************
   5  *
   6  * File        :  $Source: /cvsroot/ijbswa/current/jcc.h,v $
   7  *
   8  * Purpose     :  Main file.  Contains main() method, main loop, and
   9  *                the main connection-handling function.
  10  *
  11  * Copyright   :  Written by and Copyright (C) 2001-2006 the SourceForge
  12  *                Privoxy team. http://www.privoxy.org/
  13  *
  14  *                Based on the Internet Junkbuster originally written
  15  *                by and Copyright (C) 1997 Anonymous Coders and
  16  *                Junkbusters Corporation.  http://www.junkbusters.com
  17  *
  18  *                This program is free software; you can redistribute it
  19  *                and/or modify it under the terms of the GNU General
  20  *                Public License as published by the Free Software
  21  *                Foundation; either version 2 of the License, or (at
  22  *                your option) any later version.
  23  *
  24  *                This program is distributed in the hope that it will
  25  *                be useful, but WITHOUT ANY WARRANTY; without even the
  26  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  27  *                PARTICULAR PURPOSE.  See the GNU General Public
  28  *                License for more details.
  29  *
  30  *                The GNU General Public License should be included with
  31  *                this file.  If not, you can view it at
  32  *                http://www.gnu.org/copyleft/gpl.html
  33  *                or write to the Free Software Foundation, Inc., 59
  34  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  35  *
  36  * Revisions   :
  37  *    $Log: jcc.h,v $
  38  *    Revision 1.22  2007/06/01 18:16:36  fabiankeil
  39  *    Use the same mutex for gethostbyname() and gethostbyaddr() to prevent
  40  *    deadlocks and crashes on OpenBSD and possibly other OS with neither
  41  *    gethostbyname_r() nor gethostaddr_r(). Closes BR#1729174.
  42  *    Thanks to Ralf Horstmann for report and solution.
  43  *
  44  *    Revision 1.21  2007/04/22 13:18:06  fabiankeil
  45  *    Keep the HTTP snippets local.
  46  *
  47  *    Revision 1.20  2006/12/26 17:31:41  fabiankeil
  48  *    Mutex protect rand() if POSIX threading
  49  *    is used, warn the user if that's not possible
  50  *    and stop using it on _WIN32 where it could
  51  *    cause crashes.
  52  *
  53  *    Revision 1.19  2006/12/06 19:41:39  fabiankeil
  54  *    Privoxy is now able to run as intercepting
  55  *    proxy in combination with any packet filter
  56  *    that does the port redirection. The destination
  57  *    is extracted from the "Host:" header which
  58  *    should be available for nearly all requests.
  59  *
  60  *    Moved HTTP snipplets into jcc.c.
  61  *    Added error message for gopher proxy requests.
  62  *
  63  *    Revision 1.18  2006/11/13 19:05:51  fabiankeil
  64  *    Make pthread mutex locking more generic. Instead of
  65  *    checking for OSX and OpenBSD, check for FEATURE_PTHREAD
  66  *    and use mutex locking unless there is an _r function
  67  *    available. Better safe than sorry.
  68  *
  69  *    Fixes "./configure --disable-pthread" and should result
  70  *    in less threading-related problems on pthread-using platforms,
  71  *    but it still doesn't fix BR#1122404.
  72  *
  73  *    Revision 1.17  2006/11/06 19:58:23  fabiankeil
  74  *    Move pthread.h inclusion from jcc.c to jcc.h.
  75  *    Fixes build on x86-freebsd1 (FreeBSD 5.4-RELEASE).
  76  *
  77  *    Revision 1.16  2006/09/02 15:36:42  fabiankeil
  78  *    Follow the OpenBSD port's lead and protect the resolve
  79  *    functions on OpenBSD as well.
  80  *
  81  *    Revision 1.15  2006/09/02 10:24:30  fabiankeil
  82  *    Include pthread.h for OpenBSD to make Privoxy build again.
  83  *
  84  *    Tested shortly on OpenBSD 3.9 without problems, but the OpenBSD
  85  *    port has additional patches to use the mutexes OSX_DARWIN needs,
  86  *    and it should be investigated if they are still required for
  87  *    reliable operation.
  88  *
  89  *    Revision 1.14  2006/07/18 14:48:46  david__schmidt
  90  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
  91  *    with what was really the latest development (the v_3_0_branch branch)
  92  *
  93  *    Revision 1.12.2.3  2006/01/21 16:16:08  david__schmidt
  94  *    Thanks to  Edward Carrel for his patch to modernize OSX's\rpthreads support.  See bug #1409623.
  95  *
  96  *    Revision 1.12.2.2  2005/04/03 20:10:50  david__schmidt
  97  *    Thanks to Jindrich Makovicka for a race condition fix for the log
  98  *    file.  The race condition remains for non-pthread implementations.
  99  *    Reference patch #1175720.
 100  *
 101  *    Revision 1.12.2.1  2003/03/07 03:41:05  david__schmidt
 102  *    Wrapping all *_r functions (the non-_r versions of them) with mutex
 103  *    semaphores for OSX.  Hopefully this will take care of all of those pesky
 104  *    crash reports.
 105  *
 106  *    Revision 1.12  2002/03/26 22:29:55  swa
 107  *    we have a new homepage!
 108  *
 109  *    Revision 1.11  2002/03/24 13:25:43  swa
 110  *    name change related issues
 111  *
 112  *    Revision 1.10  2002/03/16 23:54:06  jongfoster
 113  *    Adding graceful termination feature, to help look for memory leaks.
 114  *    If you enable this (which, by design, has to be done by hand
 115  *    editing config.h) and then go to http://i.j.b/die, then the program
 116  *    will exit cleanly after the *next* request.  It should free all the
 117  *    memory that was used.
 118  *
 119  *    Revision 1.9  2002/03/07 03:52:44  oes
 120  *    Set logging to tty for --no-daemon mode
 121  *
 122  *    Revision 1.8  2002/03/04 18:19:49  oes
 123  *    Added extern const char *pidfile
 124  *
 125  *    Revision 1.7  2001/11/05 21:41:43  steudten
 126  *    Add changes to be a real daemon just for unix os.
 127  *    (change cwd to /, detach from controlling tty, set
 128  *    process group and session leader to the own process.
 129  *    Add DBG() Macro.
 130  *    Add some fatal-error log message for failed malloc().
 131  *    Add '-d' if compiled with 'configure --with-debug' to
 132  *    enable debug output.
 133  *
 134  *    Revision 1.6  2001/07/30 22:08:36  jongfoster
 135  *    Tidying up #defines:
 136  *    - All feature #defines are now of the form FEATURE_xxx
 137  *    - Permanently turned off WIN_GUI_EDIT
 138  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
 139  *
 140  *    Revision 1.5  2001/07/29 19:32:00  jongfoster
 141  *    Renaming _main() [mingw32 only] to real_main(), for ANSI compliance.
 142  *
 143  *    Revision 1.4  2001/07/29 18:58:15  jongfoster
 144  *    Removing nested #includes, adding forward declarations for needed
 145  *    structures, and changing the #define _FILENAME_H to FILENAME_H_INCLUDED.
 146  *
 147  *    Revision 1.3  2001/07/18 12:31:58  oes
 148  *    moved #define freez from jcc.h to project.h
 149  *
 150  *    Revision 1.2  2001/05/31 21:24:47  jongfoster
 151  *    Changed "permission" to "action" throughout.
 152  *    Removed DEFAULT_USER_AGENT - it must now be specified manually.
 153  *    Moved vanilla wafer check into chat(), since we must now
 154  *    decide whether or not to add it based on the URL.
 155  *
 156  *    Revision 1.1.1.1  2001/05/15 13:58:56  oes
 157  *    Initial import of version 2.9.3 source tree
 158  *
 159  *
 160  *********************************************************************/
 161 \f
 162
 163 #ifdef __cplusplus
 164 extern "C" {
 165 #endif
 166
 167 struct client_state;
 168 struct file_list;
 169
 170 /* Global variables */
 171
 172 #ifdef FEATURE_STATISTICS
 173 extern int urls_read;
 174 extern int urls_rejected;
 175 #endif /*def FEATURE_STATISTICS*/
 176
 177 extern struct client_state clients[1];
 178 extern struct file_list    files[1];
 179
 180 #ifdef unix
 181 extern const char *pidfile;
 182 #endif
 183 extern int no_daemon;
 184
 185 #ifdef FEATURE_GRACEFUL_TERMINATION
 186 extern int g_terminate;
 187 #endif
 188
 189 #ifdef FEATURE_PTHREAD
 190 #include <pthread.h>
 191
 192 typedef pthread_mutex_t privoxy_mutex_t;
 193
 194 extern void privoxy_mutex_lock(privoxy_mutex_t *mutex);
 195 extern void privoxy_mutex_unlock(privoxy_mutex_t *mutex);
 196
 197 extern privoxy_mutex_t log_mutex;
 198 extern privoxy_mutex_t log_init_mutex;
 199
 200 #ifndef HAVE_GMTIME_R
 201 extern privoxy_mutex_t gmtime_mutex;
 202 #endif /* ndef HAVE_GMTIME_R */
 203
 204 #ifndef HAVE_LOCALTIME_R
 205 extern privoxy_mutex_t localtime_mutex;
 206 #endif /* ndef HAVE_GMTIME_R */
 207
 208 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
 209 extern privoxy_mutex_t resolver_mutex;
 210 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
 211
 212 #ifndef HAVE_RANDOM
 213 extern privoxy_mutex_t rand_mutex;
 214 #endif /* ndef HAVE_RANDOM */
 215
 216 #endif /* FEATURE_PTHREAD */
 217
 218 /* Functions */
 219
 220 #ifdef __MINGW32__
 221 int real_main(int argc, const char *argv[]);
 222 #else
 223 int main(int argc, const char *argv[]);
 224 #endif
 225
 226 /* Revision control strings from this header and associated .c file */
 227 extern const char jcc_rcs[];
 228 extern const char jcc_h_rcs[];
 229
 230 #ifdef __cplusplus
 231 } /* extern "C" */
 232 #endif
 233
 234 #endif /* ndef JCC_H_INCLUDED */
 235
 236 /*
 237   Local Variables:
 238   tab-width: 3
 239   end:
 240 */