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