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