Revert revision 1.195 and try again.
[privoxy.git] / jcc.c
1 const char jcc_rcs[] = "$Id: jcc.c,v 1.200 2008/10/26 16:53:18 fabiankeil Exp $";
2 /*********************************************************************
3  *
4  * File        :  $Source: /cvsroot/ijbswa/current/jcc.c,v $
5  *
6  * Purpose     :  Main file.  Contains main() method, main loop, and
7  *                the main connection-handling function.
8  *
9  * Copyright   :  Written by and Copyright (C) 2001-2008 the SourceForge
10  *                Privoxy team. http://www.privoxy.org/
11  *
12  *                Based on the Internet Junkbuster originally written
13  *                by and Copyright (C) 1997 Anonymous Coders and
14  *                Junkbusters Corporation.  http://www.junkbusters.com
15  *
16  *                This program is free software; you can redistribute it
17  *                and/or modify it under the terms of the GNU General
18  *                Public License as published by the Free Software
19  *                Foundation; either version 2 of the License, or (at
20  *                your option) any later version.
21  *
22  *                This program is distributed in the hope that it will
23  *                be useful, but WITHOUT ANY WARRANTY; without even the
24  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
25  *                PARTICULAR PURPOSE.  See the GNU General Public
26  *                License for more details.
27  *
28  *                The GNU General Public License should be included with
29  *                this file.  If not, you can view it at
30  *                http://www.gnu.org/copyleft/gpl.html
31  *                or write to the Free Software Foundation, Inc., 59
32  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
33  *
34  * Revisions   :
35  *    $Log: jcc.c,v $
36  *    Revision 1.200  2008/10/26 16:53:18  fabiankeil
37  *    Fix gcc44 warning.
38  *
39  *    Revision 1.199  2008/10/26 15:36:10  fabiankeil
40  *    Remove two debug messages with LOG_LEVEL_INFO.
41  *
42  *    Revision 1.198  2008/10/22 15:19:55  fabiankeil
43  *    Once More, With Feeling: if there is no logfile
44  *    because the user didn't specify one, we shouldn't
45  *    call init_error_log() after receiving SIGHUP either.
46  *
47  *    Revision 1.197  2008/10/20 17:02:40  fabiankeil
48  *    If SIGHUP is received while we aren't running in daemon
49  *    mode, calling init_error_log() would be a mistake.
50  *
51  *    Revision 1.196  2008/10/16 09:16:41  fabiankeil
52  *    - Fix two gcc44 conversion warnings.
53  *    - Don't bother logging the last five bytes
54  *      of the 0-chunk.
55  *
56  *    Revision 1.195  2008/10/13 16:04:37  fabiankeil
57  *    Make sure we don't try to reuse tainted server sockets.
58  *
59  *    Revision 1.194  2008/10/12 18:35:18  fabiankeil
60  *    The last commit was a bit too ambitious, apparently the content
61  *    length adjustment is only necessary if we aren't buffering.
62  *
63  *    Revision 1.193  2008/10/12 15:57:35  fabiankeil
64  *    Fix content length calculation if we read headers
65  *    and the start of the body at once. Now that we have
66  *    FEATURE_CONNECTION_KEEP_ALIVE, it actually matters.
67  *
68  *    Revision 1.192  2008/10/11 18:19:14  fabiankeil
69  *    Even more chat() cosmetics.
70  *
71  *    Revision 1.191  2008/10/11 18:00:14  fabiankeil
72  *    Reformat some comments in chat().
73  *
74  *    Revision 1.190  2008/10/11 14:58:00  fabiankeil
75  *    In case of chunk-encoded content, stop reading if
76  *    the buffer looks like it ends with the last chunk.
77  *
78  *    Revision 1.189  2008/10/11 09:53:00  fabiankeil
79  *    Let server_response_is_complete() deal properly with
80  *    content that is neither buffered nor read all at once.
81  *
82  *    Revision 1.188  2008/10/09 18:21:41  fabiankeil
83  *    Flush work-in-progress changes to keep outgoing connections
84  *    alive where possible. Incomplete and mostly #ifdef'd out.
85  *
86  *    Revision 1.187  2008/09/07 12:35:05  fabiankeil
87  *    Add mutex lock support for _WIN32.
88  *
89  *    Revision 1.186  2008/09/04 08:13:58  fabiankeil
90  *    Prepare for critical sections on Windows by adding a
91  *    layer of indirection before the pthread mutex functions.
92  *
93  *    Revision 1.185  2008/08/30 12:03:07  fabiankeil
94  *    Remove FEATURE_COOKIE_JAR.
95  *
96  *    Revision 1.184  2008/08/22 15:34:45  fabiankeil
97  *    - Silence LLVM/Clang complaint.
98  *    - Make received_hup_signal static.
99  *    - Hide definitions for basedir, pidfile and received_hup_signal
100  *      from __EMX__ as they only seem to be used in case of #ifdef unix.
101  *
102  *    Revision 1.183  2008/08/21 07:09:35  fabiankeil
103  *    Accept Shoutcast responses again. Problem reported
104  *    and fix suggested by Stefan in #2062860.
105  *
106  *    Revision 1.182  2008/06/27 11:13:56  fabiankeil
107  *    Fix possible NULL-pointer dereference reported
108  *    by din_a4 in #2003937. Pointy hat to me.
109  *
110  *    Revision 1.181  2008/05/21 15:47:15  fabiankeil
111  *    Streamline sed()'s prototype and declare
112  *    the header parse and add structures static.
113  *
114  *    Revision 1.180  2008/05/21 15:26:32  fabiankeil
115  *    - Mark csp as immutable for send_crunch_response().
116  *    - Fix comment spelling.
117  *
118  *    Revision 1.179  2008/05/20 20:13:32  fabiankeil
119  *    Factor update_server_headers() out of sed(), ditch the
120  *    first_run hack and make server_patterns_light static.
121  *
122  *    Revision 1.178  2008/05/10 13:23:38  fabiankeil
123  *    Don't provide get_header() with the whole client state
124  *    structure when it only needs access to csp->iob.
125  *
126  *    Revision 1.177  2008/05/10 11:51:12  fabiankeil
127  *    Make the "read the rest of the headers" loop a bit more readable.
128  *
129  *    Revision 1.176  2008/05/10 11:37:57  fabiankeil
130  *    - Instead of logging when the IIS5 hack is enabled, log when it fails.
131  *    - Remove useless comment.
132  *
133  *    Revision 1.175  2008/05/09 18:53:59  fabiankeil
134  *    Fix comment grammar.
135  *
136  *    Revision 1.174  2008/05/07 18:05:53  fabiankeil
137  *    Remove the pointless buffer in client_protocol_is_unsupported().
138  *
139  *    Revision 1.173  2008/05/06 15:09:00  fabiankeil
140  *    Least-effort fix for bug #1821930 (reported by Lee):
141  *    If the response doesn't look like HTTP,
142  *    tell the client and log the problem.
143  *
144  *    Revision 1.172  2008/04/16 16:38:21  fabiankeil
145  *    Don't pass the whole csp structure to flush_socket()
146  *    when it only needs a file descriptor and a buffer.
147  *
148  *    Revision 1.171  2008/03/27 18:27:25  fabiankeil
149  *    Remove kill-popups action.
150  *
151  *    Revision 1.170  2008/03/06 16:33:46  fabiankeil
152  *    If limit-connect isn't used, don't limit CONNECT requests to port 443.
153  *
154  *    Revision 1.169  2008/03/04 18:30:39  fabiankeil
155  *    Remove the treat-forbidden-connects-like-blocks action. We now
156  *    use the "blocked" page for forbidden CONNECT requests by default.
157  *
158  *    Revision 1.168  2008/03/02 12:25:25  fabiankeil
159  *    Also use shiny new connect_port_is_forbidden() in jcc.c.
160  *
161  *    Revision 1.167  2008/02/23 16:57:12  fabiankeil
162  *    Rename url_actions() to get_url_actions() and let it
163  *    use the standard parameter ordering.
164  *
165  *    Revision 1.166  2008/02/23 16:33:43  fabiankeil
166  *    Let forward_url() use the standard parameter ordering
167  *    and mark its second parameter immutable.
168  *
169  *    Revision 1.165  2008/02/02 19:36:56  fabiankeil
170  *    Remove the "Listening ... for local connections only" log message.
171  *    Whether or not remote connections are able to reach Privoxy is up
172  *    to the operating system.
173  *
174  *    Revision 1.164  2007/12/16 18:32:46  fabiankeil
175  *    Prevent the log messages for CONNECT requests to unacceptable
176  *    ports from printing the limit-connect argument as [null] if
177  *    limit-connect hasn't been explicitly enabled.
178  *
179  *    Revision 1.163  2007/12/13 01:47:11  david__schmidt
180  *    Make sure all console-mode apps get a usage() instance
181  *
182  *    Revision 1.162  2007/12/06 17:54:57  fabiankeil
183  *    Reword NO_SERVER_DATA_RESPONSE to make it harder
184  *    to misunderstand what the message is all about.
185  *
186  *    Revision 1.161  2007/12/04 19:44:22  fabiankeil
187  *    Unbreak trustfile which previously didn't work without
188  *    FEATURE_TOGGLE. Fixes BR#1843585, reported by Lee.
189  *
190  *    Revision 1.160  2007/11/29 18:00:29  fabiankeil
191  *    Plug memory leak. Spotted by Valgrind, triggered by
192  *    Privoxy-Regression-Test feeding proxyfuzz.py.
193  *
194  *    Revision 1.159  2007/11/24 14:34:09  fabiankeil
195  *    In the HTTP snipplets, refer to the client as client.
196  *
197  *    Revision 1.158  2007/11/11 16:44:17  fabiankeil
198  *    Emit a log message when activating the MS IIS5 hack.
199  *
200  *    Revision 1.157  2007/11/03 17:34:49  fabiankeil
201  *    Log the "weak randomization factor" warning only
202  *    once for mingw32 and provide some more details.
203  *
204  *    Revision 1.156  2007/11/01 18:20:58  fabiankeil
205  *    Initialize log module after initializing mutexes, future
206  *    deadlocks in that code should now work cross-platform.
207  *
208  *    Revision 1.155  2007/10/23 20:12:45  fabiankeil
209  *    Fix first CSUCCEED line to end in \r\n as required by RFC1945.
210  *    Reported by Bert van Leeuwen in BR#1818808.
211  *
212  *    Revision 1.154  2007/10/19 17:00:08  fabiankeil
213  *    Downgrade "Flushing header and buffers" message to LOG_LEVEL_INFO.
214  *
215  *    Revision 1.153  2007/10/14 14:12:41  fabiankeil
216  *    When in daemon mode, close stderr after the configuration file has been
217  *    parsed the first time. If logfile isn't set, stop logging. Fixes BR#897436.
218  *
219  *    Revision 1.152  2007/10/04 18:03:34  fabiankeil
220  *    - Fix a crash when parsing invalid requests whose first header
221  *      is rejected by get_header(). Regression (re?)introduced
222  *      in r1.143 by yours truly.
223  *    - Move ACTION_VANILLA_WAFER handling into parsers.c's
224  *      client_cookie_adder() to make sure send-vanilla-wafer can be
225  *      controlled through tags (and thus regression-tested).
226  *
227  *    Revision 1.151  2007/09/29 10:21:16  fabiankeil
228  *    - Move get_filter_function() from jcc.c to filters.c
229  *      so the filter functions can be static.
230  *    - Don't bother filtering body-less responses.
231  *
232  *    Revision 1.150  2007/09/28 16:39:29  fabiankeil
233  *    Execute content filters through execute_content_filter().
234  *
235  *    Revision 1.149  2007/09/04 15:08:48  fabiankeil
236  *    Initialize req to NULL to make sure it's defined if the
237  *    first read_socket() call fails. Reported by icmp30.
238  *
239  *    Revision 1.148  2007/08/26 16:47:13  fabiankeil
240  *    Add Stephen Gildea's --pre-chroot-nslookup patch [#1276666],
241  *    extensive comments moved to user manual.
242  *
243  *    Revision 1.147  2007/08/25 14:42:40  fabiankeil
244  *    Don't crash if a broken header filter wiped out the request line.
245  *
246  *    Revision 1.146  2007/08/20 17:09:32  fabiankeil
247  *    Fix byte_count calculation in case of flushes
248  *    and don't parse the server headers a second time.
249  *
250  *    Revision 1.145  2007/08/19 13:13:31  fabiankeil
251  *    - If there's a connection problem after we already forwarded
252  *      parts of the original content, just hang up. Fixes BR#1776724.
253  *    - Fix warnings about unused code on mingw32.
254  *    - In case of flushes, calculate the byte count
255  *      less incorrectly (I think).
256  *
257  *    Revision 1.144  2007/08/11 14:43:22  fabiankeil
258  *    Add some more prototypes for static functions.
259  *
260  *    Revision 1.143  2007/08/05 13:58:19  fabiankeil
261  *    Comment out request_contains_null_bytes() until it's used again.
262  *
263  *    Revision 1.142  2007/08/05 13:50:26  fabiankeil
264  *    #1763173 from Stefan Huehner: s@const static@static const@
265  *    and declare some more functions static.
266  *
267  *    Revision 1.141  2007/08/04 09:56:23  fabiankeil
268  *    - Log rejected CONNECT requests with LOG_LEVEL_INFO
269  *      and explain why they were rejected in the first place.
270  *    - Fix the LOG_LEVEL_CLF message for crunches of unallowed
271  *      CONNECT requests. The request line was missing.
272  *    - Add two more XXX reminders as we don't have enough already.
273  *
274  *    Revision 1.140  2007/07/21 11:51:36  fabiankeil
275  *    As Hal noticed, checking dispatch_cgi() as the last cruncher
276  *    looks like a bug if CGI requests are blocked unintentionally,
277  *    so don't do it unless the user enabled the new config option
278  *    "allow-cgi-request-crunching".
279  *
280  *    Revision 1.139  2007/07/14 07:46:41  fabiankeil
281  *    - Allow to rewrite the request destination behind the client's back.
282  *    - Turn the weird-looking unconditional for loop that
283  *      reads the client request into a conditional while loop.
284  *      Move the stuff that only runs once out of the loop.
285  *    - Move parts of chat(), server_content_type() and the
286  *      necessary stuff to fix BR#1750917 into get_filter_function().
287  *
288  *    Revision 1.138  2007/06/03 18:45:18  fabiankeil
289  *    Temporary workaround for BR#1730105.
290  *
291  *    Revision 1.137  2007/06/01 18:16:36  fabiankeil
292  *    Use the same mutex for gethostbyname() and gethostbyaddr() to prevent
293  *    deadlocks and crashes on OpenBSD and possibly other OS with neither
294  *    gethostbyname_r() nor gethostaddr_r(). Closes BR#1729174.
295  *    Thanks to Ralf Horstmann for report and solution.
296  *
297  *    Revision 1.136  2007/06/01 16:41:11  fabiankeil
298  *    Add forward-override{} to change the forwarding settings through
299  *    action sections. This is mainly interesting to forward different
300  *    clients differently (for example based on User-Agent or request
301  *    origin).
302  *
303  *    Revision 1.135  2007/05/24 17:03:50  fabiankeil
304  *    - Let usage() mention the --chroot parameter.
305  *    - Use read_socket() consistently and always leave
306  *      the last buffer byte alone, even in cases where
307  *      null termination (currently) doesn't matter.
308  *
309  *    Revision 1.134  2007/05/16 14:59:46  fabiankeil
310  *    - Fix config file loading on Unix if no config file is specified.
311  *      Since r1.97 Privoxy would always interpret the last argument as
312  *      config file, even if it's a valid command line option.
313  *    - Abort in case of unrecognized command line options. Closes #1719696.
314  *    - Remove a bunch of unnecessary strcpy() calls (yay for c&p without thinking).
315  *    - Replace the remaining strcpy() and strcat() calls with strlcpy() and strcat().
316  *
317  *    Revision 1.133  2007/05/04 11:23:19  fabiankeil
318  *    - Don't rerun crunchers that only depend on the request URL.
319  *    - Don't count redirects and CGI requests as "blocked requests".
320  *
321  *    Revision 1.132  2007/04/25 15:15:17  fabiankeil
322  *    Support crunching based on tags created by server-header taggers.
323  *
324  *    Revision 1.131  2007/04/22 13:24:50  fabiankeil
325  *    Make HTTP snippets static (again). Add a Content-Type for those
326  *    with content so the browser doesn't guess it based on the URL.
327  *
328  *    Revision 1.130  2007/04/19 13:47:34  fabiankeil
329  *    Move crunching and request line rebuilding out of chat().
330  *
331  *    Revision 1.129  2007/04/15 16:39:20  fabiankeil
332  *    Introduce tags as alternative way to specify which
333  *    actions apply to a request. At the moment tags can be
334  *    created based on client and server headers.
335  *
336  *    Revision 1.128  2007/03/25 16:55:54  fabiankeil
337  *    Don't CLF-log CONNECT requests twice.
338  *
339  *    Revision 1.127  2007/03/20 13:53:17  fabiankeil
340  *    Log the source address for ACL-related connection drops.
341  *
342  *    Revision 1.126  2007/03/17 15:20:05  fabiankeil
343  *    New config option: enforce-blocks.
344  *
345  *    Revision 1.125  2007/03/09 14:12:00  fabiankeil
346  *    - Move null byte check into separate function.
347  *    - Don't confuse the client with error pages
348  *      if a CONNECT request was already confirmed.
349  *
350  *    Revision 1.124  2007/02/23 14:59:54  fabiankeil
351  *    Speed up NULL byte escaping and only log the complete
352  *    NULL byte requests with header debugging enabled.
353  *
354  *    Revision 1.123  2007/02/21 18:42:10  fabiankeil
355  *    Answer requests that contain NULL bytes with
356  *    a custom response instead of waiting for more
357  *    data until the client eventually hangs up.
358  *
359  *    Revision 1.122  2007/02/07 11:12:02  fabiankeil
360  *    - Move delivery and logging of crunched responses
361  *      from chat() into send_crunch_response().
362  *    - Display the reason for generating http_responses.
363  *    - Log the content length for LOG_LEVEL_CLF correctly
364  *      (still incorrect for some fixed responses).
365  *    - Reword an incorrect comment about
366  *      treat-forbidden-connects-like-blocks violating
367  *      the specs.
368  *    - Add some log messages.
369  *
370  *    Revision 1.121  2007/01/27 10:52:56  fabiankeil
371  *    Move mutex initialization into separate
372  *    function and exit in case of errors.
373  *
374  *    Revision 1.120  2007/01/26 14:18:42  fabiankeil
375  *    - Start to reduce chat()'s line count and move
376  *      parts of it into separate functions.
377  *    - Add "HTTP/1.1 100 Continue" hack for BR 756734.
378  *
379  *    Revision 1.119  2007/01/25 14:02:30  fabiankeil
380  *    - Add Proxy-Agent header to HTTP snippets that are
381  *      supposed to reach HTTP clients only.
382  *    - Made a few CONNECT log messages more descriptive.
383  *    - Catch completely empty server responses (as seen
384  *      with Tor's fake ".noconnect" top level domain).
385  *    - Use shiny new "forwarding-failed" template for socks errors.
386  *
387  *    Revision 1.118  2007/01/07 07:43:43  joergs
388  *    AmigaOS4 support added.
389  *
390  *    Revision 1.117  2006/12/31 17:56:37  fabiankeil
391  *    Added config option accept-intercepted-requests
392  *    and disabled it by default.
393  *
394  *    Revision 1.116  2006/12/29 19:08:22  fabiankeil
395  *    Reverted parts of my last commit
396  *    to keep error handling working.
397  *
398  *    Revision 1.115  2006/12/29 17:38:57  fabiankeil
399  *    Fixed gcc43 conversion warnings.
400  *
401  *    Revision 1.114  2006/12/27 18:52:02  fabiankeil
402  *    Fix -pedantic ISO C warning about converting
403  *    from function pointer to object pointer.
404  *
405  *    Revision 1.113  2006/12/26 17:38:50  fabiankeil
406  *    Silence compiler warning I introduced with my last commit.
407  *
408  *    Revision 1.112  2006/12/26 17:31:41  fabiankeil
409  *    Mutex protect rand() if POSIX threading
410  *    is used, warn the user if that's not possible
411  *    and stop using it on _WIN32 where it could
412  *    cause crashes.
413  *
414  *    Revision 1.111  2006/12/23 16:15:06  fabiankeil
415  *    Don't prevent core dumps by catching SIGABRT.
416  *    It's rude and makes debugging unreasonable painful.
417  *
418  *    Revision 1.110  2006/12/13 14:52:53  etresoft
419  *    Fix build failure on MacOS X. Global symbols can be either static or extern, but not both.
420  *
421  *    Revision 1.109  2006/12/06 19:41:40  fabiankeil
422  *    Privoxy is now able to run as intercepting
423  *    proxy in combination with any packet filter
424  *    that does the port redirection. The destination
425  *    is extracted from the "Host:" header which
426  *    should be available for nearly all requests.
427  *
428  *    Moved HTTP snipplets into jcc.c.
429  *    Added error message for gopher proxy requests.
430  *
431  *    Revision 1.108  2006/11/28 15:38:51  fabiankeil
432  *    Only unlink the pidfile if it's actually used.
433  *
434  *    Change order of interception checks to make
435  *    it possible to block or redirect requests for
436  *    the cgi pages.
437  *
438  *    Revision 1.107  2006/11/13 19:05:51  fabiankeil
439  *    Make pthread mutex locking more generic. Instead of
440  *    checking for OSX and OpenBSD, check for FEATURE_PTHREAD
441  *    and use mutex locking unless there is an _r function
442  *    available. Better safe than sorry.
443  *
444  *    Fixes "./configure --disable-pthread" and should result
445  *    in less threading-related problems on pthread-using platforms,
446  *    but it still doesn't fix BR#1122404.
447  *
448  *    Revision 1.106  2006/11/06 19:58:23  fabiankeil
449  *    Move pthread.h inclusion from jcc.c to jcc.h.
450  *    Fixes build on x86-freebsd1 (FreeBSD 5.4-RELEASE).
451  *
452  *    Revision 1.105  2006/11/06 14:26:02  fabiankeil
453  *    Don't exit after receiving the second SIGHUP on Solaris.
454  *
455  *    Fixes BR 1052235, but the same problem may exist on other
456  *    systems. Once 3.0.6 is out we should use sigset()
457  *    where available and see if it breaks anything.
458  *
459  *    Revision 1.104  2006/09/23 13:26:38  roro
460  *    Replace TABs by spaces in source code.
461  *
462  *    Revision 1.103  2006/09/21 12:54:43  fabiankeil
463  *    Fix +redirect{}. Didn't work with -fast-redirects.
464  *
465  *    Revision 1.102  2006/09/06 13:03:04  fabiankeil
466  *    Respond with 400 and a short text message
467  *    if the client tries to use Privoxy as FTP proxy.
468  *
469  *    Revision 1.101  2006/09/06 09:23:37  fabiankeil
470  *    Make number of retries in case of forwarded-connect problems
471  *    a config file option (forwarded-connect-retries) and use 0 as
472  *    default.
473  *
474  *    Revision 1.100  2006/09/03 19:42:59  fabiankeil
475  *    Set random(3) seed.
476  *
477  *    Revision 1.99  2006/09/02 15:36:42  fabiankeil
478  *    Follow the OpenBSD port's lead and protect the resolve
479  *    functions on OpenBSD as well.
480  *
481  *    Revision 1.98  2006/08/24 11:01:34  fabiankeil
482  *    --user fix. Only use the user as group if no group is specified.
483  *    Solves BR 1492612. Thanks to Spinor S. and David Laight.
484  *
485  *    Revision 1.97  2006/08/18 15:23:17  david__schmidt
486  *    Windows service (re-)integration
487  *
488  *    The new args are:
489  *
490  *    --install[:service_name]
491  *    --uninstall[:service_name]
492  *    --service
493  *
494  *    They work as follows:
495  *    --install will create a service for you and then terminate.
496  *    By default the service name will be "privoxy" (without the quotes).
497  *    However you can run multiple services if you wish, just by adding
498  *    a colon and then a name (no spaces).
499  *
500  *    --uninstall follows the exact same rules a --install.
501  *
502  *    --service is used when the program is executed by the service
503  *    control manager, and in normal circumstances would never be
504  *    used as a command line argument.
505  *
506  *    Revision 1.96  2006/08/15 20:12:36  david__schmidt
507  *    Windows service integration
508  *
509  *    Revision 1.95  2006/08/03 02:46:41  david__schmidt
510  *    Incorporate Fabian Keil's patch work:
511 http://www.fabiankeil.de/sourcecode/privoxy/
512  *
513  *    Revision 1.94  2006/07/18 14:48:46  david__schmidt
514  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
515  *    with what was really the latest development (the v_3_0_branch branch)
516  *
517  *    Revision 1.92.2.16  2005/04/03 20:10:50  david__schmidt
518  *    Thanks to Jindrich Makovicka for a race condition fix for the log
519  *    file.  The race condition remains for non-pthread implementations.
520  *    Reference patch #1175720.
521  *
522  *    Revision 1.92.2.15  2004/10/03 12:53:32  david__schmidt
523  *    Add the ability to check jpeg images for invalid
524  *    lengths of comment blocks.  Defensive strategy
525  *    against the exploit:
526  *       Microsoft Security Bulletin MS04-028
527  *       Buffer Overrun in JPEG Processing (GDI+) Could
528  *       Allow Code Execution (833987)
529  *    Enabled with +inspect-jpegs in actions files.
530  *
531  *    Revision 1.92.2.14  2003/12/12 12:52:53  oes
532  *    - Fixed usage info for non-unix platforms
533  *    - Fixed small cmdline parsing bug
534  *
535  *    Revision 1.92.2.13  2003/11/27 19:20:27  oes
536  *    Diagnostics: Now preserve the returncode of pthread_create
537  *    in errno. Closes BR #775721. Thanks to Geoffrey Hausheer.
538  *
539  *    Revision 1.92.2.12  2003/07/11 11:34:19  oes
540  *    No longer ignore SIGCHLD. Fixes bug #769381
541  *
542  *    Revision 1.92.2.11  2003/05/14 12:32:02  oes
543  *    Close jarfile on graceful exit, remove stray line
544  *
545  *    Revision 1.92.2.10  2003/05/08 15:13:46  oes
546  *    Cosmetics: Killed a warning, a typo and an allocation left at exit
547  *
548  *    Revision 1.92.2.9  2003/04/03 15:08:42  oes
549  *    No longer rely on non-POSIX.1 extensions of getcwd().
550  *    Fixes bug #711001
551  *
552  *    Revision 1.92.2.8  2003/03/31 13:12:32  oes
553  *    Replaced setenv() by posix-compliant putenv()
554  *    Thanks to Neil McCalden (nmcc AT users.sf.net).
555  *
556  *    Revision 1.92.2.7  2003/03/17 16:48:59  oes
557  *    Added chroot ability, thanks to patch by Sviatoslav Sviridov
558  *
559  *    Revision 1.92.2.6  2003/03/11 11:55:00  oes
560  *    Clean-up and extension of improvements for forked mode:
561  *     - Child's return code now consists of flags RC_FLAG_*
562  *     - Reporting toggle to parent now properly #ifdef'ed
563  *     - Children now report blocking to parent. This enables
564  *       statistics in forked mode
565  *
566  *    Revision 1.92.2.5  2003/03/10 23:45:32  oes
567  *    Fixed bug #700381: Non-Threaded version now capable of being toggled.
568  *    Children now report having been toggled through _exit(17), parents
569  *    watch for that code and toggle themselves if found.
570  *
571  *    Revision 1.92.2.4  2003/03/07 03:41:04  david__schmidt
572  *    Wrapping all *_r functions (the non-_r versions of them) with 
573  *    mutex semaphores for OSX.  Hopefully this will take care of all 
574  *    of those pesky crash reports.
575  *
576  *    Revision 1.92.2.3  2003/02/28 12:53:06  oes
577  *    Fixed two mostly harmless mem leaks
578  *
579  *    Revision 1.92.2.2  2002/11/20 14:37:47  oes
580  *    Fix: Head of global clients list now initialized to NULL
581  *
582  *    Revision 1.92.2.1  2002/09/25 14:52:24  oes
583  *    Added basic support for OPTIONS and TRACE HTTP methods:
584  *     - New interceptor direct_response() added in chat().
585  *     - sed() moved to earlier in the process, so that the
586  *       Host: header is evaluated before actions and forwarding
587  *       are decided on.
588  *
589  *    Revision 1.92  2002/05/08 16:00:46  oes
590  *    Chat's buffer handling:
591  *     - Fixed bug with unchecked out-of-mem conditions
592  *       while reading client request & server headers
593  *     - No longer predict if the buffer limit will be exceeded
594  *       in the next read -- check add_to_iob's new
595  *       return code. If buffer couldn't be extended
596  *       (policy or out-of-mem) while
597  *       - reading from client: abort
598  *       - reading server headers: send error page
599  *       - buffering server body for filter: flush,
600  *         and if that fails: send error page
601  *
602  *    Revision 1.91  2002/04/08 20:35:58  swa
603  *    fixed JB spelling
604  *
605  *    Revision 1.90  2002/04/02 14:57:28  oes
606  *    Made sending wafers independent of FEATURE_COOKIE_JAR
607  *
608  *    Revision 1.89  2002/03/31 17:18:59  jongfoster
609  *    Win32 only: Enabling STRICT to fix a VC++ compile warning.
610  *
611  *    Revision 1.88  2002/03/27 14:32:43  david__schmidt
612  *    More compiler warning message maintenance
613  *
614  *    Revision 1.87  2002/03/26 22:29:54  swa
615  *    we have a new homepage!
616  *
617  *    Revision 1.86  2002/03/25 17:04:55  david__schmidt
618  *    Workaround for closing the jarfile before load_config() comes around again
619  *
620  *    Revision 1.85  2002/03/24 15:23:33  jongfoster
621  *    Name changes
622  *
623  *    Revision 1.84  2002/03/24 13:25:43  swa
624  *    name change related issues
625  *
626  *    Revision 1.83  2002/03/16 23:54:06  jongfoster
627  *    Adding graceful termination feature, to help look for memory leaks.
628  *    If you enable this (which, by design, has to be done by hand
629  *    editing config.h) and then go to http://i.j.b/die, then the program
630  *    will exit cleanly after the *next* request.  It should free all the
631  *    memory that was used.
632  *
633  *    Revision 1.82  2002/03/13 00:27:05  jongfoster
634  *    Killing warnings
635  *
636  *    Revision 1.81  2002/03/12 01:42:50  oes
637  *    Introduced modular filters
638  *
639  *    Revision 1.80  2002/03/11 22:07:05  david__schmidt
640  *    OS/2 port maintenance:
641  *    - Fixed EMX build - it had decayed a little
642  *    - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
643  *      substituted a memset for now.
644  *
645  *    Revision 1.79  2002/03/09 20:03:52  jongfoster
646  *    - Making various functions return int rather than size_t.
647  *      (Undoing a recent change).  Since size_t is unsigned on
648  *      Windows, functions like read_socket that return -1 on
649  *      error cannot return a size_t.
650  *
651  *      THIS WAS A MAJOR BUG - it caused frequent, unpredictable
652  *      crashes, and also frequently caused JB to jump to 100%
653  *      CPU and stay there.  (Because it thought it had just
654  *      read ((unsigned)-1) == 4Gb of data...)
655  *
656  *    - The signature of write_socket has changed, it now simply
657  *      returns success=0/failure=nonzero.
658  *
659  *    - Trying to get rid of a few warnings --with-debug on
660  *      Windows, I've introduced a new type "jb_socket".  This is
661  *      used for the socket file descriptors.  On Windows, this
662  *      is SOCKET (a typedef for unsigned).  Everywhere else, it's
663  *      an int.  The error value can't be -1 any more, so it's
664  *      now JB_INVALID_SOCKET (which is -1 on UNIX, and in
665  *      Windows it maps to the #define INVALID_SOCKET.)
666  *
667  *    - The signature of bind_port has changed.
668  *
669  *    Revision 1.78  2002/03/08 21:35:04  oes
670  *    Added optional group supplement to --user option. Will now use default group of user if no group given
671  *
672  *    Revision 1.77  2002/03/07 03:52:06  oes
673  *     - Fixed compiler warnings etc
674  *     - Improved handling of failed DNS lookups
675  *
676  *    Revision 1.76  2002/03/06 22:54:35  jongfoster
677  *    Automated function-comment nitpicking.
678  *
679  *    Revision 1.75  2002/03/06 10:02:19  oes
680  *    Fixed stupid bug when --user was not given
681  *
682  *    Revision 1.74  2002/03/06 00:49:31  jongfoster
683  *    Fixing warning on Windows
684  *    Making #ifdefs that refer to the same variable consistently
685  *    use #ifdef unix rather than mixing #ifdef unix & #ifndef OS2
686  *
687  *    Revision 1.73  2002/03/05 23:57:30  hal9
688  *    Stray character 's' on line 1618 was breaking build.
689  *
690  *    Revision 1.72  2002/03/05 21:33:45  david__schmidt
691  *    - Re-enable OS/2 building after new parms were added
692  *    - Fix false out of memory report when resolving CGI templates when no IP
693  *      address is available of failed attempt (a la no such domain)
694  *
695  *    Revision 1.71  2002/03/05 18:13:56  oes
696  *    Added --user option
697  *
698  *    Revision 1.70  2002/03/05 04:52:42  oes
699  *    Deleted non-errlog debugging code
700  *
701  *    Revision 1.69  2002/03/04 23:50:00  jongfoster
702  *    Splitting off bind_port() call into bind_port_helper(), with
703  *    improved logging.
704  *
705  *    Revision 1.68  2002/03/04 20:17:32  oes
706  *    Fixed usage info
707  *
708  *    Revision 1.67  2002/03/04 18:18:57  oes
709  *    - Removed _DEBUG mode
710  *    - Cleand up cmdline parsing
711  *    - Introduced --no-daemon, --pidfile options
712  *    - Cleaned up signal handling:
713  *      - Terminate cleanly on INT, TERM and ABRT
714  *      - Schedule logfile for re-opening on HUP
715  *      - Ignore CHLD and PIPE
716  *      - Leave the rest with their default handlers
717  *      - Uniform handler registration
718  *    - Added usage() function
719  *    - Played styleguide police
720  *
721  *    Revision 1.66  2002/03/03 15:06:55  oes
722  *    Re-enabled automatic config reloading
723  *
724  *    Revision 1.65  2002/03/03 14:49:11  oes
725  *    Fixed CLF logging: Now uses client's original HTTP request
726  *
727  *    Revision 1.64  2002/03/03 09:18:03  joergs
728  *    Made jumbjuster work on AmigaOS again.
729  *
730  *    Revision 1.63  2002/03/02 04:14:50  david__schmidt
731  *    Clean up a little CRLF unpleasantness that suddenly appeared
732  *
733  *    Revision 1.62  2002/02/20 23:17:23  jongfoster
734  *    Detecting some out-of memory conditions and exiting with a log message.
735  *
736  *    Revision 1.61  2002/01/17 21:01:52  jongfoster
737  *    Moving all our URL and URL pattern parsing code to urlmatch.c.
738  *
739  *    Revision 1.60  2001/12/30 14:07:32  steudten
740  *    - Add signal handling (unix)
741  *    - Add SIGHUP handler (unix)
742  *    - Add creation of pidfile (unix)
743  *    - Add action 'top' in rc file (RH)
744  *    - Add entry 'SIGNALS' to manpage
745  *    - Add exit message to logfile (unix)
746  *
747  *    Revision 1.59  2001/12/13 14:07:18  oes
748  *    Fixed Bug: 503 error page now sent OK
749  *
750  *    Revision 1.58  2001/11/30 23:37:24  jongfoster
751  *    Renaming the Win32 config file to config.txt - this is almost the
752  *    same as the corresponding UNIX name "config"
753  *
754  *    Revision 1.57  2001/11/16 00:47:43  jongfoster
755  *    Changing the tty-disconnection code to use setsid().
756  *
757  *    Revision 1.56  2001/11/13 20:20:54  jongfoster
758  *    Tabs->spaces, fixing a bug with missing {} around an if()
759  *
760  *    Revision 1.55  2001/11/13 20:14:53  jongfoster
761  *    Patch for FreeBSD setpgrp() as suggested by Alexander Lazic
762  *
763  *    Revision 1.54  2001/11/07 00:03:14  steudten
764  *    Give reliable return value if an error
765  *    occurs not just 0 with new daemon mode.
766  *
767  *    Revision 1.53  2001/11/05 21:41:43  steudten
768  *    Add changes to be a real daemon just for unix os.
769  *    (change cwd to /, detach from controlling tty, set
770  *    process group and session leader to the own process.
771  *    Add DBG() Macro.
772  *    Add some fatal-error log message for failed malloc().
773  *    Add '-d' if compiled with 'configure --with-debug' to
774  *    enable debug output.
775  *
776  *    Revision 1.52  2001/10/26 20:11:20  jongfoster
777  *    Fixing type mismatch
778  *
779  *    Revision 1.51  2001/10/26 17:38:28  oes
780  *    Cosmetics
781  *
782  *    Revision 1.50  2001/10/25 03:40:48  david__schmidt
783  *    Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
784  *    threads to call select() simultaneously.  So, it's time to do a real, live,
785  *    native OS/2 port.  See defines for __EMX__ (the porting layer) vs. __OS2__
786  *    (native). Both versions will work, but using __OS2__ offers multi-threading.
787  *
788  *    Revision 1.49  2001/10/23 21:41:35  jongfoster
789  *    Added call to initialize the (statically-allocated of course)
790  *    "out of memory" CGI response.
791  *
792  *    Revision 1.48  2001/10/10 19:56:46  jongfoster
793  *    Moving some code that wasn't cookie-related out of an #ifdef
794  *    FEATURE_COOKIE_JAR
795  *
796  *    Revision 1.47  2001/10/10 16:44:36  oes
797  *    Added CONNECT destination port limitation check
798  *
799  *    Revision 1.46  2001/10/08 15:17:41  oes
800  *    Re-enabled SSL forwarding
801  *
802  *    Revision 1.45  2001/10/07 15:42:11  oes
803  *    Replaced 6 boolean members of csp with one bitmap (csp->flags)
804  *
805  *    Moved downgrading of the HTTP version from parse_http_request to
806  *      chat(), since we can't decide if it is necessary before we have
807  *      determined the actions for the URL. The HTTP command is now
808  *      *always* re-built so the repairs need no longer be special-cased.
809  *
810  *    filter_popups now gets a csp pointer so it can raise the new
811  *      CSP_FLAG_MODIFIED flag.
812  *
813  *    Bugfix
814  *
815  *    Added configurable size limit for the IOB. If the IOB grows so
816  *      large that the next read would exceed the limit, the header
817  *      is generated, and the header & unfiltered buffer are flushed
818  *      to the client. Chat then continues in non-buffering,
819  *      non-filtering body mode.
820  *
821  *    Revision 1.44  2001/10/02 18:13:57  oes
822  *    Ooops
823  *
824  *    Revision 1.43  2001/10/02 15:32:13  oes
825  *    Moved generation of hdr
826  *
827  *    Revision 1.42  2001/09/21 23:02:02  david__schmidt
828  *    Cleaning up 2 compiler warnings on OS/2.
829  *
830  *    Revision 1.41  2001/09/16 17:05:14  jongfoster
831  *    Removing unused #include showarg.h
832  *
833  *    Revision 1.40  2001/09/16 15:41:45  jongfoster
834  *    Fixing signed/unsigned comparison warning.
835  *
836  *    Revision 1.39  2001/09/16 13:21:27  jongfoster
837  *    Changes to use new list functions.
838  *
839  *    Revision 1.38  2001/09/16 13:01:46  jongfoster
840  *    Removing redundant function call that zeroed zalloc()'d memory.
841  *
842  *    Revision 1.37  2001/09/10 11:12:24  oes
843  *    Deleted unused variable
844  *
845  *    Revision 1.36  2001/09/10 10:56:15  oes
846  *    Silenced compiler warnings
847  *
848  *    Revision 1.35  2001/07/31 14:44:22  oes
849  *    Deleted unused size parameter from filter_popups()
850  *
851  *    Revision 1.34  2001/07/30 22:08:36  jongfoster
852  *    Tidying up #defines:
853  *    - All feature #defines are now of the form FEATURE_xxx
854  *    - Permanently turned off WIN_GUI_EDIT
855  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
856  *
857  *    Revision 1.33  2001/07/29 19:32:00  jongfoster
858  *    Renaming _main() [mingw32 only] to real_main(), for ANSI compliance.
859  *
860  *    Revision 1.32  2001/07/29 18:47:05  jongfoster
861  *    Adding missing #include "loadcfg.h"
862  *
863  *    Revision 1.31  2001/07/29 12:17:48  oes
864  *    Applied pthread fix by Paul Lieverse
865  *
866  *    Revision 1.30  2001/07/25 22:57:13  jongfoster
867  *    __BEOS__ no longer overrides FEATURE_PTHREAD.
868  *    This is because FEATURE_PTHREAD will soon be widely used, so I
869  *    want to keep it simple.
870  *
871  *    Revision 1.29  2001/07/24 12:47:06  oes
872  *    Applied BeOS support update by Eugenia
873  *
874  *    Revision 1.28  2001/07/23 13:26:12  oes
875  *    Fixed bug in popup-killing for the first read that caused binary garbage to be sent between headers and body
876  *
877  *    Revision 1.27  2001/07/19 19:09:47  haroon
878  *    - Added code to take care of the situation where while processing the first
879  *      server response (which includes the server header), after finding the end
880  *      of the headers we were not looking past the end of the headers for
881  *      content modification. I enabled it for filter_popups.
882  *      Someone else should look to see if other similar operations should be
883  *      done to the discarded portion of the buffer.
884  *
885  *      Note 2001/07/20: No, the other content modification mechanisms will process
886  *                       the whole iob later anyway. --oes
887  *
888  *    Revision 1.26  2001/07/18 12:31:36  oes
889  *    cosmetics
890  *
891  *    Revision 1.25  2001/07/15 19:43:49  jongfoster
892  *    Supports POSIX threads.
893  *    Also removed some unused #includes.
894  *
895  *    Revision 1.24  2001/07/13 14:00:40  oes
896  *     - Generic content modification scheme:
897  *       Each feature has its own applicability flag that is set
898  *       from csp->action->flags.
899  *       Replaced the "filtering" int flag , by a function pointer
900  *       "content_filter" to the function that will do the content
901  *       modification. If it is != NULL, the document will be buffered
902  *       and processed through *content_filter, which must set
903  *       csp->content_length and return a modified copy of the body
904  *       or return NULL (on failiure).
905  *     - Changed csp->is_text to the more generic bitmap csp->content_type
906  *       which can currently take the valued CT_TEXT or CT_GIF
907  *     - Reformatting etc
908  *     - Removed all #ifdef PCRS
909  *
910  *    Revision 1.23  2001/07/02 02:28:25  iwanttokeepanon
911  *    Added "#ifdef ACL_FILES" conditional compilation to line 1291 to exclude
912  *    the `block_acl' call.  This prevents a compilation error when the user
913  *    does not wish to use the "ACL" feature.
914  *
915  *    Revision 1.22  2001/06/29 21:45:41  oes
916  *    Indentation, CRLF->LF, Tab-> Space
917  *
918  *    Revision 1.21  2001/06/29 13:29:36  oes
919  *    - Cleaned up, improved comments
920  *    - Unified all possible interceptors (CGI,
921  *      block, trust, fast_redirect) in one
922  *      place, with one (CGI) answer generation
923  *      mechansim. Much clearer now.
924  *    - Removed the GIF image generation, which
925  *      is now done in filters.c:block_url()
926  *    - Made error conditions like domain lookup
927  *      failiure or (various) problems while talking
928  *      to the server use cgi.c:error_response()
929  *      instead of generating HTML/HTTP in chat() (yuck!)
930  *    - Removed logentry from cancelled commit
931  *
932  *    Revision 1.20  2001/06/09 10:55:28  jongfoster
933  *    Changing BUFSIZ ==> BUFFER_SIZE
934  *
935  *    Revision 1.19  2001/06/07 23:12:52  jongfoster
936  *    Replacing function pointer in struct gateway with a directly
937  *    called function forwarded_connect().
938  *    Replacing struct gateway with struct forward_spec
939  *
940  *    Revision 1.18  2001/06/03 19:12:16  oes
941  *    introduced new cgi handling
942  *
943  *    Revision 1.17  2001/06/01 20:07:23  jongfoster
944  *    Now uses action +image-blocker{} rather than config->tinygif
945  *
946  *    Revision 1.16  2001/06/01 18:49:17  jongfoster
947  *    Replaced "list_share" with "list" - the tiny memory gain was not
948  *    worth the extra complexity.
949  *
950  *    Revision 1.15  2001/05/31 21:24:47  jongfoster
951  *    Changed "permission" to "action" throughout.
952  *    Removed DEFAULT_USER_AGENT - it must now be specified manually.
953  *    Moved vanilla wafer check into chat(), since we must now
954  *    decide whether or not to add it based on the URL.
955  *
956  *    Revision 1.14  2001/05/29 20:14:01  joergs
957  *    AmigaOS bugfix: PCRS needs a lot of stack, stacksize for child threads
958  *    increased.
959  *
960  *    Revision 1.13  2001/05/29 09:50:24  jongfoster
961  *    Unified blocklist/imagelist/permissionslist.
962  *    File format is still under discussion, but the internal changes
963  *    are (mostly) done.
964  *
965  *    Also modified interceptor behaviour:
966  *    - We now intercept all URLs beginning with one of the following
967  *      prefixes (and *only* these prefixes):
968  *        * http://i.j.b/
969  *        * http://ijbswa.sf.net/config/
970  *        * http://ijbswa.sourceforge.net/config/
971  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
972  *    - Internal changes so that intercepted and fast redirect pages
973  *      are not replaced with an image.
974  *    - Interceptors now have the option to send a binary page direct
975  *      to the client. (i.e. ijb-send-banner uses this)
976  *    - Implemented show-url-info interceptor.  (Which is why I needed
977  *      the above interceptors changes - a typical URL is
978  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
979  *      The previous mechanism would not have intercepted that, and
980  *      if it had been intercepted then it then it would have replaced
981  *      it with an image.)
982  *
983  *    Revision 1.12  2001/05/27 22:17:04  oes
984  *
985  *    - re_process_buffer no longer writes the modified buffer
986  *      to the client, which was very ugly. It now returns the
987  *      buffer, which it is then written by chat.
988  *
989  *    - content_length now adjusts the Content-Length: header
990  *      for modified documents rather than crunch()ing it.
991  *      (Length info in csp->content_length, which is 0 for
992  *      unmodified documents)
993  *
994  *    - For this to work, sed() is called twice when filtering.
995  *
996  *    Revision 1.11  2001/05/26 17:27:53  jongfoster
997  *    Added support for CLF and fixed LOG_LEVEL_LOG.
998  *    Also did CRLF->LF fix of my previous patch.
999  *
1000  *    Revision 1.10  2001/05/26 15:26:15  jongfoster
1001  *    ACL feature now provides more security by immediately dropping
1002  *    connections from untrusted hosts.
1003  *
1004  *    Revision 1.9  2001/05/26 00:28:36  jongfoster
1005  *    Automatic reloading of config file.
1006  *    Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
1007  *    Most of the global variables have been moved to a new
1008  *    struct configuration_spec, accessed through csp->config->globalname
1009  *    Most of the globals remaining are used by the Win32 GUI.
1010  *
1011  *    Revision 1.8  2001/05/25 22:43:18  jongfoster
1012  *    Fixing minor memory leak and buffer overflow.
1013  *
1014  *    Revision 1.7  2001/05/25 22:34:30  jongfoster
1015  *    Hard tabs->Spaces
1016  *
1017  *    Revision 1.6  2001/05/23 00:13:58  joergs
1018  *    AmigaOS support fixed.
1019  *
1020  *    Revision 1.5  2001/05/22 18:46:04  oes
1021  *
1022  *    - Enabled filtering banners by size rather than URL
1023  *      by adding patterns that replace all standard banner
1024  *      sizes with the "Junkbuster" gif to the re_filterfile
1025  *
1026  *    - Enabled filtering WebBugs by providing a pattern
1027  *      which kills all 1x1 images
1028  *
1029  *    - Added support for PCRE_UNGREEDY behaviour to pcrs,
1030  *      which is selected by the (nonstandard and therefore
1031  *      capital) letter 'U' in the option string.
1032  *      It causes the quantifiers to be ungreedy by default.
1033  *      Appending a ? turns back to greedy (!).
1034  *
1035  *    - Added a new interceptor ijb-send-banner, which
1036  *      sends back the "Junkbuster" gif. Without imagelist or
1037  *      MSIE detection support, or if tinygif = 1, or the
1038  *      URL isn't recognized as an imageurl, a lame HTML
1039  *      explanation is sent instead.
1040  *
1041  *    - Added new feature, which permits blocking remote
1042  *      script redirects and firing back a local redirect
1043  *      to the browser.
1044  *      The feature is conditionally compiled, i.e. it
1045  *      can be disabled with --disable-fast-redirects,
1046  *      plus it must be activated by a "fast-redirects"
1047  *      line in the config file, has its own log level
1048  *      and of course wants to be displayed by show-proxy-args
1049  *      Note: Boy, all the #ifdefs in 1001 locations and
1050  *      all the fumbling with configure.in and acconfig.h
1051  *      were *way* more work than the feature itself :-(
1052  *
1053  *    - Because a generic redirect template was needed for
1054  *      this, tinygif = 3 now uses the same.
1055  *
1056  *    - Moved GIFs, and other static HTTP response templates
1057  *      to project.h
1058  *
1059  *    - Some minor fixes
1060  *
1061  *    - Removed some >400 CRs again (Jon, you really worked
1062  *      a lot! ;-)
1063  *
1064  *    Revision 1.4  2001/05/21 19:34:01  jongfoster
1065  *    Made failure to bind() a fatal error.
1066  *
1067  *    Revision 1.3  2001/05/20 01:21:20  jongfoster
1068  *    Version 2.9.4 checkin.
1069  *    - Merged popupfile and cookiefile, and added control over PCRS
1070  *      filtering, in new "permissionsfile".
1071  *    - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
1072  *      file error you now get a message box (in the Win32 GUI) rather
1073  *      than the program exiting with no explanation.
1074  *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
1075  *      skipping.
1076  *    - Removed tabs from "config"
1077  *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
1078  *    - Bumped up version number.
1079  *
1080  *    Revision 1.2  2001/05/17 22:34:44  oes
1081  *     - Added hint on GIF char array generation to jcc.c
1082  *     - Cleaned CRLF's from the sources and related files
1083  *     - Repaired logging for REF and FRC
1084  *
1085  *    Revision 1.1.1.1  2001/05/15 13:58:56  oes
1086  *    Initial import of version 2.9.3 source tree
1087  *
1088  *
1089  *********************************************************************/
1090 \f
1091
1092 #include "config.h"
1093
1094 #include <stdio.h>
1095 #include <sys/types.h>
1096 #include <stdlib.h>
1097 #include <string.h>
1098 #include <signal.h>
1099 #include <fcntl.h>
1100 #include <errno.h>
1101 #include <assert.h>
1102
1103 #ifdef _WIN32
1104 # ifndef FEATURE_PTHREAD
1105 #  ifndef STRICT
1106 #   define STRICT
1107 #  endif
1108 #  include <windows.h>
1109 #  include <process.h>
1110 # endif /* ndef FEATURE_PTHREAD */
1111
1112 # include "win32.h"
1113 # ifndef _WIN_CONSOLE
1114 #  include "w32log.h"
1115 # endif /* ndef _WIN_CONSOLE */
1116 # include "w32svrapi.h"
1117
1118 #else /* ifndef _WIN32 */
1119
1120 # if !defined (__OS2__)
1121 # include <unistd.h>
1122 # include <sys/wait.h>
1123 # endif /* ndef __OS2__ */
1124 # include <sys/time.h>
1125 # include <sys/stat.h>
1126 # include <sys/ioctl.h>
1127
1128 #ifdef sun
1129 #include <sys/termios.h>
1130 #endif /* sun */
1131
1132 #ifdef unix
1133 #include <pwd.h>
1134 #include <grp.h>
1135 #endif
1136
1137 # include <signal.h>
1138
1139 # ifdef __BEOS__
1140 #  include <socket.h>  /* BeOS has select() for sockets only. */
1141 #  include <OS.h>      /* declarations for threads and stuff. */
1142 # endif
1143
1144 # if defined(__EMX__) || defined(__OS2__)
1145 #  include <sys/select.h>  /* OS/2/EMX needs a little help with select */
1146 # endif
1147 # ifdef __OS2__
1148 #define INCL_DOS
1149 # include <os2.h>
1150 #define bzero(B,N) memset(B,0x00,n)
1151 # endif
1152
1153 # ifndef FD_ZERO
1154 #  include <select.h>
1155 # endif
1156
1157 #endif
1158
1159 #include "project.h"
1160 #include "list.h"
1161 #include "jcc.h"
1162 #include "filters.h"
1163 #include "loaders.h"
1164 #include "parsers.h"
1165 #include "miscutil.h"
1166 #include "errlog.h"
1167 #include "jbsockets.h"
1168 #include "gateway.h"
1169 #include "actions.h"
1170 #include "cgi.h"
1171 #include "loadcfg.h"
1172 #include "urlmatch.h"
1173
1174 const char jcc_h_rcs[] = JCC_H_VERSION;
1175 const char project_h_rcs[] = PROJECT_H_VERSION;
1176
1177 int no_daemon = 0;
1178 struct client_state  clients[1];
1179 struct file_list     files[1];
1180
1181 #ifdef FEATURE_STATISTICS
1182 int urls_read     = 0;     /* total nr of urls read inc rejected */
1183 int urls_rejected = 0;     /* total nr of urls rejected */
1184 #endif /* def FEATURE_STATISTICS */
1185
1186 #ifdef FEATURE_GRACEFUL_TERMINATION
1187 int g_terminate = 0;
1188 #endif
1189
1190 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
1191 static void sig_handler(int the_signal);
1192 #endif
1193 static int client_protocol_is_unsupported(const struct client_state *csp, char *req);
1194 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers);
1195 static jb_err get_server_headers(struct client_state *csp);
1196 static const char *crunch_reason(const struct http_response *rsp);
1197 static void send_crunch_response(const struct client_state *csp, struct http_response *rsp);
1198 /*
1199  * static int request_contains_null_bytes(const struct client_state *csp, char *buf, int len);
1200  */
1201 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line);
1202 static jb_err change_request_destination(struct client_state *csp);
1203 static void chat(struct client_state *csp);
1204 static void serve(struct client_state *csp);
1205 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
1206 static void usage(const char *myname);
1207 #endif
1208 static void initialize_mutexes(void);
1209 static jb_socket bind_port_helper(struct configuration_spec *config);
1210 static void listen_loop(void);
1211
1212 #ifdef AMIGA
1213 void serve(struct client_state *csp);
1214 #else /* ifndef AMIGA */
1215 static void serve(struct client_state *csp);
1216 #endif /* def AMIGA */
1217
1218 #ifdef __BEOS__
1219 static int32 server_thread(void *data);
1220 #endif /* def __BEOS__ */
1221
1222 #ifdef _WIN32
1223 #define sleep(N)  Sleep(((N) * 1000))
1224 #endif
1225
1226 #ifdef __OS2__
1227 #define sleep(N)  DosSleep(((N) * 100))
1228 #endif
1229
1230 #ifdef MUTEX_LOCKS_AVAILABLE
1231 /*
1232  * XXX: Does the locking stuff really belong in this file?
1233  */
1234 privoxy_mutex_t log_mutex;
1235 privoxy_mutex_t log_init_mutex;
1236 privoxy_mutex_t connection_reuse_mutex;
1237
1238 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
1239 privoxy_mutex_t resolver_mutex;
1240 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
1241
1242 #ifndef HAVE_GMTIME_R
1243 privoxy_mutex_t gmtime_mutex;
1244 #endif /* ndef HAVE_GMTIME_R */
1245
1246 #ifndef HAVE_LOCALTIME_R
1247 privoxy_mutex_t localtime_mutex;
1248 #endif /* ndef HAVE_GMTIME_R */
1249
1250 #ifndef HAVE_RANDOM
1251 privoxy_mutex_t rand_mutex;
1252 #endif /* ndef HAVE_RANDOM */
1253
1254 #endif /* def MUTEX_LOCKS_AVAILABLE */
1255
1256 #if defined(unix)
1257 const char *basedir = NULL;
1258 const char *pidfile = NULL;
1259 static int received_hup_signal = 0;
1260 #endif /* defined unix */
1261
1262 /* HTTP snipplets. */
1263 static const char CSUCCEED[] =
1264    "HTTP/1.0 200 Connection established\r\n"
1265    "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
1266
1267 static const char CHEADER[] =
1268    "HTTP/1.0 400 Invalid header received from client\r\n"
1269    "Proxy-Agent: Privoxy " VERSION "\r\n"
1270    "Content-Type: text/plain\r\n"
1271    "Connection: close\r\n\r\n"
1272    "Invalid header received from client.\r\n";
1273
1274 static const char FTP_RESPONSE[] =
1275    "HTTP/1.0 400 Invalid request received from client\r\n"
1276    "Content-Type: text/plain\r\n"
1277    "Connection: close\r\n\r\n"
1278    "Invalid request. Privoxy doesn't support FTP.\r\n";
1279
1280 static const char GOPHER_RESPONSE[] =
1281    "HTTP/1.0 400 Invalid request received from client\r\n"
1282    "Content-Type: text/plain\r\n"
1283    "Connection: close\r\n\r\n"
1284    "Invalid request. Privoxy doesn't support gopher.\r\n";
1285
1286 /* XXX: should be a template */
1287 static const char MISSING_DESTINATION_RESPONSE[] =
1288    "HTTP/1.0 400 Bad request received from client\r\n"
1289    "Proxy-Agent: Privoxy " VERSION "\r\n"
1290    "Content-Type: text/plain\r\n"
1291    "Connection: close\r\n\r\n"
1292    "Bad request. Privoxy was unable to extract the destination.\r\n";
1293
1294 /* XXX: should be a template */
1295 static const char NO_SERVER_DATA_RESPONSE[] =
1296    "HTTP/1.0 502 Server or forwarder response empty\r\n"
1297    "Proxy-Agent: Privoxy " VERSION "\r\n"
1298    "Content-Type: text/plain\r\n"
1299    "Connection: close\r\n\r\n"
1300    "Empty server or forwarder response.\r\n"
1301    "The connection has been closed but Privoxy didn't receive any data.\r\n";
1302
1303 /* XXX: should be a template */
1304 static const char INVALID_SERVER_HEADERS_RESPONSE[] =
1305    "HTTP/1.0 502 Server or forwarder response invalid\r\n"
1306    "Proxy-Agent: Privoxy " VERSION "\r\n"
1307    "Content-Type: text/plain\r\n"
1308    "Connection: close\r\n\r\n"
1309    "Bad response. The server or forwarder response doesn't look like HTTP.\r\n";
1310
1311 #if 0
1312 /* XXX: should be a template */
1313 static const char NULL_BYTE_RESPONSE[] =
1314    "HTTP/1.0 400 Bad request received from client\r\n"
1315    "Proxy-Agent: Privoxy " VERSION "\r\n"
1316    "Content-Type: text/plain\r\n"
1317    "Connection: close\r\n\r\n"
1318    "Bad request. Null byte(s) before end of request.\r\n";
1319 #endif
1320
1321 /* XXX: should be a template */
1322 static const char MESSED_UP_REQUEST_RESPONSE[] =
1323    "HTTP/1.0 400 Malformed request after rewriting\r\n"
1324    "Proxy-Agent: Privoxy " VERSION "\r\n"
1325    "Content-Type: text/plain\r\n"
1326    "Connection: close\r\n\r\n"
1327    "Bad request. Messed up with header filters.\r\n";
1328
1329 /* A function to crunch a response */
1330 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
1331
1332 /* Crunch function flags */
1333 #define CF_NO_FLAGS        0
1334 /* Cruncher applies to forced requests as well */
1335 #define CF_IGNORE_FORCE    1
1336 /* Crunched requests are counted for the block statistics */
1337 #define CF_COUNT_AS_REJECT 2
1338
1339 /* A crunch function and its flags */
1340 struct cruncher
1341 {
1342    const crunch_func_ptr cruncher;
1343    const int flags;
1344 };
1345
1346 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
1347
1348 /* Complete list of cruncher functions */
1349 static const struct cruncher crunchers_all[] = {
1350    { direct_response, CF_COUNT_AS_REJECT|CF_IGNORE_FORCE},
1351    { block_url,       CF_COUNT_AS_REJECT },
1352 #ifdef FEATURE_TRUST
1353    { trust_url,       CF_COUNT_AS_REJECT },
1354 #endif /* def FEATURE_TRUST */
1355    { redirect_url,    CF_NO_FLAGS  },
1356    { dispatch_cgi,    CF_IGNORE_FORCE},
1357    { NULL,            0 }
1358 };
1359
1360 /* Light version, used after tags are applied */
1361 static const struct cruncher crunchers_light[] = {
1362    { block_url,       CF_COUNT_AS_REJECT },
1363    { redirect_url,    CF_NO_FLAGS },
1364    { NULL,            0 }
1365 };
1366
1367
1368 /*
1369  * XXX: Don't we really mean
1370  *
1371  * #if defined(unix)
1372  *
1373  * here?
1374  */
1375 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
1376 /*********************************************************************
1377  *
1378  * Function    :  sig_handler 
1379  *
1380  * Description :  Signal handler for different signals.
1381  *                Exit gracefully on TERM and INT
1382  *                or set a flag that will cause the errlog
1383  *                to be reopened by the main thread on HUP.
1384  *
1385  * Parameters  :
1386  *          1  :  the_signal = the signal cause this function to call
1387  *
1388  * Returns     :  - 
1389  *
1390  *********************************************************************/
1391 static void sig_handler(int the_signal)
1392 {
1393    switch(the_signal)
1394    {
1395       case SIGTERM:
1396       case SIGINT:
1397          log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
1398 #if defined(unix)
1399          if(pidfile)
1400          {
1401             unlink(pidfile);
1402          }
1403 #endif /* unix */
1404          exit(the_signal);
1405          break;
1406
1407       case SIGHUP:
1408 #if defined(unix)
1409          received_hup_signal = 1;
1410 #endif
1411          break;         
1412
1413       default:
1414          /* 
1415           * We shouldn't be here, unless we catch signals
1416           * in main() that we can't handle here!
1417           */
1418          log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
1419    }
1420    return;
1421
1422 }
1423 #endif
1424
1425
1426 /*********************************************************************
1427  *
1428  * Function    :  client_protocol_is_unsupported
1429  *
1430  * Description :  Checks if the client used a known unsupported
1431  *                protocol and deals with it by sending an error
1432  *                response.
1433  *
1434  * Parameters  :
1435  *          1  :  csp = Current client state (buffers, headers, etc...)
1436  *          2  :  req = the first request line send by the client
1437  *
1438  * Returns     :  TRUE if an error response has been generated, or
1439  *                FALSE if the request doesn't look invalid.
1440  *
1441  *********************************************************************/
1442 static int client_protocol_is_unsupported(const struct client_state *csp, char *req)
1443 {
1444    /*
1445     * If it's a FTP or gopher request, we don't support it.
1446     *
1447     * These checks are better than nothing, but they might
1448     * not work in all configurations and some clients might
1449     * have problems digesting the answer.
1450     *
1451     * They should, however, never cause more problems than
1452     * Privoxy's old behaviour (returning the misleading HTML
1453     * error message:
1454     *
1455     * "Could not resolve http://(ftp|gopher)://example.org").
1456     */
1457    if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
1458    {
1459       const char *response = NULL;
1460       const char *protocol = NULL;
1461
1462       if (!strncmpic(req, "GET ftp://", 10))
1463       {
1464          response = FTP_RESPONSE;
1465          protocol = "FTP";
1466       }
1467       else
1468       {
1469          response = GOPHER_RESPONSE;
1470          protocol = "GOPHER";
1471       }
1472       log_error(LOG_LEVEL_ERROR,
1473          "%s tried to use Privoxy as %s proxy: %s",
1474          csp->ip_addr_str, protocol, req);
1475       log_error(LOG_LEVEL_CLF,
1476          "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, req);
1477       freez(req);
1478       write_socket(csp->cfd, response, strlen(response));
1479
1480       return TRUE;
1481    }
1482
1483    return FALSE;
1484 }
1485
1486
1487 /*********************************************************************
1488  *
1489  * Function    :  get_request_destination_elsewhere
1490  *
1491  * Description :  If the client's request was redirected into
1492  *                Privoxy without the client's knowledge,
1493  *                the request line lacks the destination host.
1494  *
1495  *                This function tries to get it elsewhere,
1496  *                provided accept-intercepted-requests is enabled.
1497  *
1498  *                "Elsewhere" currently only means "Host: header",
1499  *                but in the future we may ask the redirecting
1500  *                packet filter to look the destination up.
1501  *
1502  *                If the destination stays unknown, an error
1503  *                response is send to the client and headers
1504  *                are freed so that chat() can return directly.
1505  *
1506  * Parameters  :
1507  *          1  :  csp = Current client state (buffers, headers, etc...)
1508  *          2  :  headers = a header list
1509  *
1510  * Returns     :  JB_ERR_OK if the destination is now known, or
1511  *                JB_ERR_PARSE if it isn't.
1512  *
1513  *********************************************************************/
1514 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
1515 {
1516    char *req;
1517
1518    if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
1519    {
1520       log_error(LOG_LEVEL_ERROR, "%s's request: \'%s\' is invalid."
1521          " Privoxy isn't configured to accept intercepted requests.",
1522          csp->ip_addr_str, csp->http->cmd);
1523       /* XXX: Use correct size */
1524       log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
1525          csp->ip_addr_str, csp->http->cmd);
1526
1527       write_socket(csp->cfd, CHEADER, strlen(CHEADER));
1528       destroy_list(headers);
1529
1530       return JB_ERR_PARSE;
1531    }
1532    else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
1533    {
1534       /* Split the domain we just got for pattern matching */
1535       init_domain_components(csp->http);
1536
1537       return JB_ERR_OK;
1538    }
1539    else
1540    {
1541       /* We can't work without destination. Go spread the news.*/
1542
1543       req = list_to_text(headers);
1544       chomp(req);
1545       /* XXX: Use correct size */
1546       log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
1547          csp->ip_addr_str, csp->http->cmd);
1548       log_error(LOG_LEVEL_ERROR,
1549          "Privoxy was unable to get the destination for %s's request:\n%s\n%s",
1550          csp->ip_addr_str, csp->http->cmd, req);
1551       freez(req);
1552
1553       write_socket(csp->cfd, MISSING_DESTINATION_RESPONSE, strlen(MISSING_DESTINATION_RESPONSE));
1554       destroy_list(headers);
1555
1556       return JB_ERR_PARSE;
1557    }
1558    /*
1559     * TODO: If available, use PF's ioctl DIOCNATLOOK as last resort
1560     * to get the destination IP address, use it as host directly
1561     * or do a reverse DNS lookup first.
1562     */
1563 }
1564
1565
1566 /*********************************************************************
1567  *
1568  * Function    :  get_server_headers
1569  *
1570  * Description :  Parses server headers in iob and fills them
1571  *                into csp->headers so that they can later be
1572  *                handled by sed().
1573  *
1574  * Parameters  :
1575  *          1  :  csp = Current client state (buffers, headers, etc...)
1576  *
1577  * Returns     :  JB_ERR_OK if everything went fine, or
1578  *                JB_ERR_PARSE if the headers were incomplete.
1579  *
1580  *********************************************************************/
1581 static jb_err get_server_headers(struct client_state *csp)
1582 {
1583    int continue_hack_in_da_house = 0;
1584    char * header;
1585
1586    while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
1587    {
1588       if (header == NULL)
1589       {
1590          /*
1591           * continue hack in da house. Ignore the ending of
1592           * this head and continue enlisting header lines.
1593           * The reason is described below.
1594           */
1595          enlist(csp->headers, "");
1596          continue_hack_in_da_house = 0;
1597          continue;
1598       }
1599       else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
1600       {
1601          /*
1602           * It's a bodyless continue response, don't
1603           * stop header parsing after reaching its end.
1604           *
1605           * As a result Privoxy will concatenate the
1606           * next response's head and parse and deliver
1607           * the headers as if they belonged to one request.
1608           *
1609           * The client will separate them because of the
1610           * empty line between them.
1611           *
1612           * XXX: What we're doing here is clearly against
1613           * the intended purpose of the continue header,
1614           * and under some conditions (HTTP/1.0 client request)
1615           * it's a standard violation.
1616           *
1617           * Anyway, "sort of against the spec" is preferable
1618           * to "always getting confused by Continue responses"
1619           * (Privoxy's behaviour before this hack was added)
1620           */
1621          log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
1622          continue_hack_in_da_house = 1;
1623       }
1624       else if (*header == '\0') 
1625       {
1626          /*
1627           * If the header is empty, but the Continue hack
1628           * isn't active, we can assume that we reached the
1629           * end of the buffer before we hit the end of the
1630           * head.
1631           *
1632           * Inform the caller an let it decide how to handle it.
1633           */
1634          return JB_ERR_PARSE;
1635       }
1636
1637       if (JB_ERR_MEMORY == enlist(csp->headers, header))
1638       {
1639          /*
1640           * XXX: Should we quit the request and return a
1641           * out of memory error page instead?
1642           */
1643          log_error(LOG_LEVEL_ERROR,
1644             "Out of memory while enlisting server headers. %s lost.",
1645             header);
1646       }
1647       freez(header);
1648    }
1649
1650    return JB_ERR_OK;
1651 }
1652
1653
1654 /*********************************************************************
1655  *
1656  * Function    :  crunch_reason
1657  *
1658  * Description :  Translates the crunch reason code into a string.
1659  *
1660  * Parameters  :
1661  *          1  :  rsp = a http_response
1662  *
1663  * Returns     :  A string with the crunch reason or an error description.
1664  *
1665  *********************************************************************/
1666 static const char *crunch_reason(const struct http_response *rsp)
1667 {
1668    char * reason = NULL;
1669
1670    assert(rsp != NULL);
1671    if (rsp == NULL)
1672    {
1673       return "Internal error while searching for crunch reason";
1674    }
1675
1676    switch (rsp->reason)
1677    {
1678       case RSP_REASON_UNSUPPORTED:
1679          reason = "Unsupported HTTP feature";
1680          break;
1681       case RSP_REASON_BLOCKED:
1682          reason = "Blocked";
1683          break;
1684       case RSP_REASON_UNTRUSTED:
1685          reason = "Untrusted";
1686          break;
1687       case RSP_REASON_REDIRECTED:
1688          reason = "Redirected";
1689          break;
1690       case RSP_REASON_CGI_CALL:
1691          reason = "CGI Call";
1692          break;
1693       case RSP_REASON_NO_SUCH_DOMAIN:
1694          reason = "DNS failure";
1695          break;
1696       case RSP_REASON_FORWARDING_FAILED:
1697          reason = "Forwarding failed";
1698          break;
1699       case RSP_REASON_CONNECT_FAILED:
1700          reason = "Connection failure";
1701          break;
1702       case RSP_REASON_OUT_OF_MEMORY:
1703          reason = "Out of memory (may mask other reasons)";
1704          break;
1705       default:
1706          reason = "No reason recorded";
1707          break;
1708    }
1709
1710    return reason;
1711 }
1712
1713
1714 /*********************************************************************
1715  *
1716  * Function    :  send_crunch_response
1717  *
1718  * Description :  Delivers already prepared response for
1719  *                intercepted requests, logs the interception
1720  *                and frees the response.
1721  *
1722  * Parameters  :
1723  *          1  :  csp = Current client state (buffers, headers, etc...)
1724  *          1  :  rsp = Fully prepared response. Will be freed on exit.
1725  *
1726  * Returns     :  Nothing.
1727  *
1728  *********************************************************************/
1729 static void send_crunch_response(const struct client_state *csp, struct http_response *rsp)
1730 {
1731       const struct http_request *http = csp->http;
1732       char status_code[4];
1733
1734       assert(rsp != NULL);
1735       assert(rsp->head != NULL);
1736
1737       if (rsp == NULL)
1738       {
1739          /*
1740           * Not supposed to happen. If it does
1741           * anyway, treat it as an unknown error.
1742           */
1743          cgi_error_unknown(csp, rsp, RSP_REASON_INTERNAL_ERROR);
1744          /* return code doesn't matter */
1745       }
1746
1747       if (rsp == NULL)
1748       {
1749          /* If rsp is still NULL, we have serious internal problems. */
1750          log_error(LOG_LEVEL_FATAL,
1751             "NULL response in send_crunch_response and cgi_error_unknown failed as well.");
1752       }
1753
1754       /*
1755        * Extract the status code from the actual head
1756        * that was send to the client. It is the only
1757        * way to get it right for all requests, including
1758        * the fixed ones for out-of-memory problems.
1759        *
1760        * A head starts like this: 'HTTP/1.1 200...'
1761        *                           0123456789|11
1762        *                                     10
1763        */
1764       status_code[0] = rsp->head[9];
1765       status_code[1] = rsp->head[10];
1766       status_code[2] = rsp->head[11];
1767       status_code[3] = '\0';
1768
1769       /* Write the answer to the client */
1770       if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1771        || write_socket(csp->cfd, rsp->body, rsp->content_length))
1772       {
1773          /* There is nothing we can do about it. */
1774          log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", csp->http->host);
1775       }
1776
1777       /* Log that the request was crunched and why. */
1778       log_error(LOG_LEVEL_GPC, "%s%s crunch! (%s)",
1779          http->hostport, http->path, crunch_reason(rsp));
1780       log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" %s %d",
1781          csp->ip_addr_str, http->ocmd, status_code, rsp->content_length);
1782
1783       /* Clean up and return */
1784       if (cgi_error_memory() != rsp)
1785       {
1786          free_http_response(rsp);
1787       } 
1788       return;
1789 }
1790
1791
1792 #if 0
1793 /*********************************************************************
1794  *
1795  * Function    :  request_contains_null_bytes
1796  *
1797  * Description :  Checks for NULL bytes in the request and sends
1798  *                an error message to the client if any were found.
1799  *
1800  *                XXX: currently not used, see comment in chat().
1801  *
1802  * Parameters  :
1803  *          1  :  csp = Current client state (buffers, headers, etc...)
1804  *          2  :  buf = Data from the client's request to check.
1805  *          3  :  len = The data length.
1806  *
1807  * Returns     :  TRUE if the request contained one or more NULL bytes, or
1808  *                FALSE otherwise.
1809  *
1810  *********************************************************************/
1811 static int request_contains_null_bytes(const struct client_state *csp, char *buf, int len)
1812 {
1813    size_t c_len; /* Request lenght when treated as C string */
1814
1815    c_len = strlen(buf);
1816
1817    if (c_len < len)
1818    {
1819       /*
1820        * Null byte(s) found. Log the request,
1821        * return an error response and hang up.
1822        */
1823       size_t tmp_len = c_len;
1824
1825       do
1826       {
1827         /*
1828          * Replace NULL byte(s) with '°' characters
1829          * so the request can be logged as string.
1830          * XXX: Is there a better replacement character?
1831          */
1832          buf[tmp_len]='°';
1833          tmp_len += strlen(buf+tmp_len);
1834       } while (tmp_len < len);
1835
1836       log_error(LOG_LEVEL_ERROR, "%s\'s request contains at least one NULL byte "
1837          "(length=%d, strlen=%d).", csp->ip_addr_str, len, c_len);
1838       log_error(LOG_LEVEL_HEADER, 
1839          "Offending request data with NULL bytes turned into \'°\' characters: %s", buf);
1840
1841       write_socket(csp->cfd, NULL_BYTE_RESPONSE, strlen(NULL_BYTE_RESPONSE));
1842
1843       /* XXX: Log correct size */
1844       log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1845
1846       return TRUE;
1847    }
1848
1849    return FALSE;
1850 }
1851 #endif
1852
1853
1854 /*********************************************************************
1855  *
1856  * Function    :  crunch_response_triggered
1857  *
1858  * Description :  Checks if the request has to be crunched,
1859  *                and delivers the crunch response if necessary.
1860  *
1861  * Parameters  :
1862  *          1  :  csp = Current client state (buffers, headers, etc...)
1863  *          2  :  crunchers = list of cruncher functions to run
1864  *
1865  * Returns     :  TRUE if the request was answered with a crunch response
1866  *                FALSE otherwise.
1867  *
1868  *********************************************************************/
1869 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
1870 {
1871    struct http_response *rsp = NULL;
1872    const struct cruncher *c;
1873
1874    /*
1875     * If CGI request crunching is disabled,
1876     * check the CGI dispatcher out of order to
1877     * prevent unintentional blocks or redirects. 
1878     */
1879    if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
1880        && (NULL != (rsp = dispatch_cgi(csp))))
1881    {
1882       /* Deliver, log and free the interception response. */
1883       send_crunch_response(csp, rsp);
1884       return TRUE;
1885    }
1886
1887    for (c = crunchers; c->cruncher != NULL; c++)
1888    {
1889       /*
1890        * Check the cruncher if either Privoxy is toggled
1891        * on and the request isn't forced, or if the cruncher
1892        * applies to forced requests as well.
1893        */
1894       if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
1895           !(csp->flags & CSP_FLAG_FORCED)) ||
1896           (c->flags & CF_IGNORE_FORCE))
1897       {
1898          rsp = c->cruncher(csp);
1899          if (NULL != rsp)
1900          {
1901             /* Deliver, log and free the interception response. */
1902             send_crunch_response(csp, rsp);
1903 #ifdef FEATURE_STATISTICS
1904             if (c->flags & CF_COUNT_AS_REJECT)
1905             {
1906                csp->flags |= CSP_FLAG_REJECTED;
1907             }
1908 #endif /* def FEATURE_STATISTICS */
1909
1910             return TRUE;
1911          }
1912       }
1913    }
1914
1915    return FALSE;
1916 }
1917
1918
1919 /*********************************************************************
1920  *
1921  * Function    :  build_request_line
1922  *
1923  * Description :  Builds the HTTP request line.
1924  *
1925  *                If a HTTP forwarder is used it expects the whole URL,
1926  *                web servers only get the path.
1927  *
1928  * Parameters  :
1929  *          1  :  csp = Current client state (buffers, headers, etc...)
1930  *          2  :  fwd = The forwarding spec used for the request
1931  *                XXX: Should use http->fwd instead.
1932  *          3  :  request_line = The old request line which will be replaced.
1933  *
1934  * Returns     :  Nothing. Terminates in case of memory problems.
1935  *
1936  *********************************************************************/
1937 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
1938 {
1939    struct http_request *http = csp->http;
1940
1941    assert(http->ssl == 0);
1942
1943    /*
1944     * Downgrade http version from 1.1 to 1.0
1945     * if +downgrade action applies.
1946     */
1947    if ( (csp->action->flags & ACTION_DOWNGRADE)
1948      && (!strcmpic(http->ver, "HTTP/1.1")))
1949    {
1950       freez(http->ver);
1951       http->ver = strdup("HTTP/1.0");
1952
1953       if (http->ver == NULL)
1954       {
1955          log_error(LOG_LEVEL_FATAL, "Out of memory downgrading HTTP version");
1956       }
1957    }
1958
1959    /*
1960     * Rebuild the request line.
1961     */
1962    freez(*request_line);
1963    *request_line = strdup(http->gpc);
1964    string_append(request_line, " ");
1965
1966    if (fwd->forward_host)
1967    {
1968       string_append(request_line, http->url);
1969    }
1970    else
1971    {
1972       string_append(request_line, http->path);
1973    }
1974    string_append(request_line, " ");
1975    string_append(request_line, http->ver);
1976
1977    if (*request_line == NULL)
1978    {
1979       log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
1980    }
1981    log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
1982 }
1983
1984
1985 /*********************************************************************
1986  *
1987  * Function    :  change_request_destination
1988  *
1989  * Description :  Parse a (rewritten) request line and regenerate
1990  *                the http request data.
1991  *
1992  * Parameters  :
1993  *          1  :  csp = Current client state (buffers, headers, etc...)
1994  *
1995  * Returns     :  Forwards the parse_http_request() return code.
1996  *                Terminates in case of memory problems.
1997  *
1998  *********************************************************************/
1999 static jb_err change_request_destination(struct client_state *csp)
2000 {
2001    struct http_request *http = csp->http;
2002    jb_err err;
2003
2004    log_error(LOG_LEVEL_INFO, "Rewrite detected: %s", csp->headers->first->str);
2005    free_http_request(http);
2006    err = parse_http_request(csp->headers->first->str, http, csp);
2007    if (JB_ERR_OK != err)
2008    {
2009       log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
2010          jb_err_to_string(err));
2011    }
2012    else
2013    {
2014       /* XXX: ocmd is a misleading name */
2015       http->ocmd = strdup(http->cmd);
2016       if (http->ocmd == NULL)
2017       {
2018          log_error(LOG_LEVEL_FATAL,
2019             "Out of memory copying rewritten HTTP request line");
2020       }
2021    }
2022
2023    return err;
2024 }
2025
2026
2027 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2028 /*********************************************************************
2029  *
2030  * Function    :  server_response_is_complete
2031  *
2032  * Description :  Determines whether we should stop reading
2033  *                from the server socket.
2034  *
2035  * Parameters  :
2036  *          1  :  csp = Current client state (buffers, headers, etc...)
2037  *          2  :  content_length = Length of content received so far.
2038  *
2039  * Returns     :  TRUE if the response is complete,
2040  *                FALSE otherwise.
2041  *
2042  *********************************************************************/
2043 static int server_response_is_complete(struct client_state *csp, size_t content_length)
2044 {
2045    int content_length_known = (csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
2046
2047    if (!strcmpic(csp->http->gpc, "HEAD"))
2048    {
2049       /*
2050        * "HEAD" implies no body, we are thus expecting
2051        * no content. XXX: incomplete "list" of methods?
2052        */
2053       csp->expected_content_length = 0;
2054       content_length_known = TRUE;
2055    }
2056
2057    if (csp->http->status == 304)
2058    {
2059       /*
2060        * Expect no body. XXX: incomplete "list" of status codes?
2061        */
2062       csp->expected_content_length = 0;
2063       content_length_known = TRUE;
2064    }
2065
2066    return (content_length_known && ((0 == csp->expected_content_length)
2067             || (csp->expected_content_length <= content_length)));
2068 }
2069 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2070
2071 /*********************************************************************
2072  *
2073  * Function    :  mark_server_socket_tainted
2074  *
2075  * Description :  Makes sure we don't reuse a server socket
2076  *                (if we didn't read everything the server sent
2077  *                us reusing the socket would lead to garbage).
2078  *
2079  * Parameters  :
2080  *          1  :  csp = Current client state (buffers, headers, etc...)
2081  *
2082  * Returns     :  void.
2083  *
2084  *********************************************************************/
2085 static void mark_server_socket_tainted(struct client_state *csp)
2086 {
2087    if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE))
2088    {
2089       log_error(LOG_LEVEL_CONNECT, "Unsetting keep-alive flag.");
2090       csp->flags &= ~CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE;
2091    }
2092 }
2093
2094 /*********************************************************************
2095  *
2096  * Function    :  chat
2097  *
2098  * Description :  Once a connection to the client has been accepted,
2099  *                this function is called (via serve()) to handle the
2100  *                main business of the communication.  When this
2101  *                function returns, the caller must close the client
2102  *                socket handle.
2103  *
2104  *                FIXME: chat is nearly thousand lines long.
2105  *                Ridiculous.
2106  *
2107  * Parameters  :
2108  *          1  :  csp = Current client state (buffers, headers, etc...)
2109  *
2110  * Returns     :  Nothing.
2111  *
2112  *********************************************************************/
2113 static void chat(struct client_state *csp)
2114 {
2115    char buf[BUFFER_SIZE];
2116    char *hdr;
2117    char *p;
2118    char *req = NULL;
2119    fd_set rfds;
2120    int n;
2121    jb_socket maxfd;
2122    int server_body;
2123    int ms_iis5_hack = 0;
2124    size_t byte_count = 0;
2125    int forwarded_connect_retries = 0;
2126    int max_forwarded_connect_retries = csp->config->forwarded_connect_retries;
2127    const struct forward_spec * fwd;
2128    struct http_request *http;
2129    int len; /* for buffer sizes (and negative error codes) */
2130    jb_err err;
2131
2132    /* Function that does the content filtering for the current request */
2133    filter_function_ptr content_filter = NULL;
2134
2135    /* Skeleton for HTTP response, if we should intercept the request */
2136    struct http_response *rsp;
2137
2138    /* Temporary copy of the client's headers before they get enlisted in csp->headers */
2139    struct list header_list;
2140    struct list *headers = &header_list;
2141
2142    http = csp->http;
2143
2144    memset(buf, 0, sizeof(buf));
2145
2146    /*
2147     * Read the client's request.  Note that since we're not using select() we
2148     * could get blocked here if a client connected, then didn't say anything!
2149     */
2150
2151    do
2152    {
2153       len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
2154
2155       if (len <= 0) break;      /* error! */
2156
2157       /*
2158        * If there is no memory left for buffering the
2159        * request, there is nothing we can do but hang up
2160        */
2161       if (add_to_iob(csp, buf, len))
2162       {
2163          return;
2164       }
2165
2166       req = get_header(csp->iob);
2167
2168    } while ((NULL != req) && ('\0' == *req));
2169
2170    if ((NULL != req) && ('\0' != *req))
2171    {
2172       /* Request received. Validate and parse it. */
2173
2174 #if 0
2175       /*
2176        * XXX: Temporary disabled to prevent problems
2177        * with POST requests whose bodies are allowed to
2178        * contain NULL bytes. BR#1730105.
2179        *
2180        * The main purpose of this check is to properly
2181        * log stuff like BitTorrent traffic and other junk
2182        * that hits public proxies. It's not required for
2183        * Privoxy to functions as those requests are discarded
2184        * later on anyway.
2185        *
2186        * It probably should be rewritten to only check
2187        * the head of the request. Another option would
2188        * be to let all POST requests pass, although that
2189        * may not be good enough.
2190        */
2191       if (request_contains_null_bytes(csp, buf, len))
2192       {
2193          /* NULL bytes found and dealt with, just hang up. */
2194          return;
2195       }
2196 #endif
2197
2198       /* Does the request line look invalid? */
2199       if (client_protocol_is_unsupported(csp, req))
2200       {
2201          /* 
2202           * Yes. The request has already been
2203           * answered with a error response, the buffers
2204           * were freed and we're done with chatting.
2205           */
2206          return;
2207       }
2208
2209 #ifdef FEATURE_FORCE_LOAD
2210       /*
2211        * If this request contains the FORCE_PREFIX and blocks
2212        * aren't enforced, get rid of it and set the force flag.
2213        */
2214       if (strstr(req, FORCE_PREFIX))
2215       {
2216          if (csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
2217          {
2218             log_error(LOG_LEVEL_FORCE,
2219                "Ignored force prefix in request: \"%s\".", req);
2220          }
2221          else
2222          {
2223             strclean(req, FORCE_PREFIX);
2224             log_error(LOG_LEVEL_FORCE, "Enforcing request: \"%s\".", req);
2225             csp->flags |= CSP_FLAG_FORCED;
2226          }
2227       }
2228
2229 #endif /* def FEATURE_FORCE_LOAD */
2230       err = parse_http_request(req, http, csp);
2231       if (JB_ERR_OK != err)
2232       {
2233          log_error(LOG_LEVEL_ERROR, "Couldn't parse request: %s.", jb_err_to_string(err));
2234       }
2235
2236       freez(req);
2237    }
2238
2239    if (http->cmd == NULL)
2240    {
2241       write_socket(csp->cfd, CHEADER, strlen(CHEADER));
2242       /* XXX: Use correct size */
2243       log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
2244       log_error(LOG_LEVEL_ERROR, "Invalid header received from %s.", csp->ip_addr_str);
2245
2246       free_http_request(http);
2247       return;
2248    }
2249
2250    /* grab the rest of the client's headers */
2251    init_list(headers);
2252    for (;;)
2253    {
2254       p = get_header(csp->iob);
2255
2256       if (p == NULL)
2257       {
2258          /* There are no additional headers to read. */
2259          break;
2260       }
2261
2262       if (*p == '\0')
2263       {
2264          /*
2265           * We didn't receive a complete header
2266           * line yet, get the rest of it.
2267           */
2268          len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
2269          if (len <= 0)
2270          {
2271             log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
2272             destroy_list(headers);
2273             return;
2274          }
2275          
2276          if (add_to_iob(csp, buf, len))
2277          {
2278             /*
2279              * If there is no memory left for buffering the
2280              * request, there is nothing we can do but hang up
2281              */
2282             destroy_list(headers);
2283             return;
2284          }
2285       }
2286       else
2287       {
2288          /*
2289           * We were able to read a complete
2290           * header and can finaly enlist it.
2291           */
2292          enlist(headers, p);
2293          freez(p);
2294       }
2295    }
2296
2297    if (http->host == NULL)
2298    {
2299       /*
2300        * If we still don't know the request destination,
2301        * the request is invalid or the client uses
2302        * Privoxy without its knowledge.
2303        */
2304       if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
2305       {
2306          /*
2307           * Our attempts to get the request destination
2308           * elsewhere failed or Privoxy is configured
2309           * to only accept proxy requests.
2310           *
2311           * An error response has already been send
2312           * and we're done here.
2313           */
2314          return;
2315       }
2316    }
2317
2318    /*
2319     * Determine the actions for this URL
2320     */
2321 #ifdef FEATURE_TOGGLE
2322    if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
2323    {
2324       /* Most compatible set of actions (i.e. none) */
2325       init_current_action(csp->action);
2326    }
2327    else
2328 #endif /* ndef FEATURE_TOGGLE */
2329    {
2330       get_url_actions(csp, http);
2331    }
2332
2333    /* 
2334     * Save a copy of the original request for logging
2335     */
2336    http->ocmd = strdup(http->cmd);
2337
2338    if (http->ocmd == NULL)
2339    {
2340       log_error(LOG_LEVEL_FATAL, "Out of memory copying HTTP request line");
2341    }
2342
2343    enlist(csp->headers, http->cmd);
2344
2345    /* Append the previously read headers */
2346    list_append_list_unique(csp->headers, headers);
2347    destroy_list(headers);
2348
2349    err = sed(csp, FILTER_CLIENT_HEADERS);
2350    if (JB_ERR_OK != err)
2351    {
2352       assert(err == JB_ERR_PARSE);
2353       log_error(LOG_LEVEL_FATAL, "Failed to parse client headers");
2354    }
2355    csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
2356
2357    /* Check request line for rewrites. */
2358    if ((NULL == csp->headers->first->str)
2359       || (strcmp(http->cmd, csp->headers->first->str) &&
2360          (JB_ERR_OK != change_request_destination(csp))))
2361    {
2362       /*
2363        * A header filter broke the request line - bail out.
2364        */
2365       write_socket(csp->cfd, MESSED_UP_REQUEST_RESPONSE, strlen(MESSED_UP_REQUEST_RESPONSE));
2366       /* XXX: Use correct size */
2367       log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
2368       log_error(LOG_LEVEL_ERROR, "Invalid request line after applying header filters.");
2369
2370       free_http_request(http);
2371       return;
2372    }
2373
2374    /* decide how to route the HTTP request */
2375    fwd = forward_url(csp, http);
2376    if (NULL == fwd)
2377    {
2378       log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!?  This can't happen!");
2379       /* Never get here - LOG_LEVEL_FATAL causes program exit */
2380    }
2381
2382    /*
2383     * build the http request to send to the server
2384     * we have to do one of the following:
2385     *
2386     * create = use the original HTTP request to create a new
2387     *          HTTP request that has either the path component
2388     *          without the http://domainspec (w/path) or the
2389     *          full orininal URL (w/url)
2390     *          Note that the path and/or the HTTP version may
2391     *          have been altered by now.
2392     *
2393     * connect = Open a socket to the host:port of the server
2394     *           and short-circuit server and client socket.
2395     *
2396     * pass =  Pass the request unchanged if forwarding a CONNECT
2397     *         request to a parent proxy. Note that we'll be sending
2398     *         the CFAIL message ourselves if connecting to the parent
2399     *         fails, but we won't send a CSUCCEED message if it works,
2400     *         since that would result in a double message (ours and the
2401     *         parent's). After sending the request to the parent, we simply
2402     *         tunnel.
2403     *
2404     * here's the matrix:
2405     *                        SSL
2406     *                    0        1
2407     *                +--------+--------+
2408     *                |        |        |
2409     *             0  | create | connect|
2410     *                | w/path |        |
2411     *  Forwarding    +--------+--------+
2412     *                |        |        |
2413     *             1  | create | pass   |
2414     *                | w/url  |        |
2415     *                +--------+--------+
2416     *
2417     */
2418
2419    if (http->ssl && connect_port_is_forbidden(csp))
2420    {
2421       const char *acceptable_connect_ports =
2422          csp->action->string[ACTION_STRING_LIMIT_CONNECT];
2423       assert(NULL != acceptable_connect_ports);
2424       log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
2425          "limit-connect{%s} doesn't allow CONNECT requests to port %d.",
2426          csp->ip_addr_str, acceptable_connect_ports, csp->http->port);
2427       csp->action->flags |= ACTION_BLOCK;
2428       http->ssl = 0;
2429    }
2430
2431    if (http->ssl == 0)
2432    {
2433       freez(csp->headers->first->str);
2434       build_request_line(csp, fwd, &csp->headers->first->str);
2435    }
2436
2437    hdr = list_to_text(csp->headers);
2438    if (hdr == NULL)
2439    {
2440       /* FIXME Should handle error properly */
2441       log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
2442    }
2443
2444    /*
2445     * We have a request. Check if one of the crunchers wants it.
2446     */
2447    if (crunch_response_triggered(csp, crunchers_all))
2448    {
2449       /*
2450        * Yes. The client got the crunch response
2451        * and we are done here after cleaning up.
2452        */
2453       freez(hdr);
2454       list_remove_all(csp->headers);
2455
2456       return;
2457    }
2458
2459    /*
2460     * The headers can't be removed earlier because
2461     * they were still needed for the referrer check
2462     * in case of CGI crunches.
2463     *
2464     * XXX: Would it be worth to move the referrer check
2465     * into client_referrer() and set a flag if it's trusted?
2466     */
2467    list_remove_all(csp->headers);
2468
2469    log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
2470
2471    if (fwd->forward_host)
2472    {
2473       log_error(LOG_LEVEL_CONNECT, "via %s:%d to: %s",
2474                fwd->forward_host, fwd->forward_port, http->hostport);
2475    }
2476    else
2477    {
2478       log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
2479    }
2480
2481    /* here we connect to the server, gateway, or the forwarder */
2482
2483    while ( (csp->sfd = forwarded_connect(fwd, http, csp))
2484          && (errno == EINVAL) && (forwarded_connect_retries++ < max_forwarded_connect_retries))
2485    {
2486       log_error(LOG_LEVEL_ERROR, "failed request #%u to connect to %s. Trying again.",
2487                 forwarded_connect_retries, http->hostport);
2488    }
2489
2490    if (csp->sfd == JB_INVALID_SOCKET)
2491    {
2492       if (fwd->type != SOCKS_NONE)
2493       {
2494          /* Socks error. */
2495          rsp = error_response(csp, "forwarding-failed", errno);
2496       }
2497       else if (errno == EINVAL)
2498       {
2499          rsp = error_response(csp, "no-such-domain", errno);
2500       }
2501       else
2502       {
2503          rsp = error_response(csp, "connect-failed", errno);
2504          log_error(LOG_LEVEL_CONNECT, "connect to: %s failed: %E",
2505                 http->hostport);
2506       }
2507
2508       /* Write the answer to the client */
2509       if (rsp != NULL)
2510       {
2511          send_crunch_response(csp, rsp);
2512       }
2513
2514       freez(hdr);
2515       return;
2516    }
2517
2518    if (fwd->forward_host || (http->ssl == 0))
2519    {
2520       /*
2521        * Write the client's (modified) header to the server
2522        * (along with anything else that may be in the buffer)
2523        */
2524       if (write_socket(csp->sfd, hdr, strlen(hdr))
2525        || (flush_socket(csp->sfd, csp->iob) <  0))
2526       {
2527          log_error(LOG_LEVEL_CONNECT,
2528             "write header to: %s failed: %E", http->hostport);
2529
2530          rsp = error_response(csp, "connect-failed", errno);
2531          if (rsp)
2532          {
2533             send_crunch_response(csp, rsp);
2534          }
2535
2536          freez(hdr);
2537          return;
2538       }
2539    }
2540    else
2541    {
2542       /*
2543        * We're running an SSL tunnel and we're not forwarding,
2544        * so just send the "connect succeeded" message to the
2545        * client, flush the rest, and get out of the way.
2546        */
2547       if (write_socket(csp->cfd, CSUCCEED, strlen(CSUCCEED)))
2548       {
2549          freez(hdr);
2550          return;
2551       }
2552       IOB_RESET(csp);
2553    }
2554
2555    log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
2556
2557    /* we're finished with the client's header */
2558    freez(hdr);
2559
2560    maxfd = (csp->cfd > csp->sfd) ? csp->cfd : csp->sfd;
2561
2562    /* pass data between the client and server
2563     * until one or the other shuts down the connection.
2564     */
2565
2566    server_body = 0;
2567
2568    for (;;)
2569    {
2570 #ifdef __OS2__
2571       /*
2572        * FD_ZERO here seems to point to an errant macro which crashes.
2573        * So do this by hand for now...
2574        */
2575       memset(&rfds,0x00,sizeof(fd_set));
2576 #else
2577       FD_ZERO(&rfds);
2578 #endif
2579       FD_SET(csp->cfd, &rfds);
2580       FD_SET(csp->sfd, &rfds);
2581
2582 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2583       if (server_body && server_response_is_complete(csp, byte_count))
2584       {
2585          log_error(LOG_LEVEL_CONNECT,
2586             "Done reading from server. Expected content length: %d. "
2587             "Actual content length: %d. Most recently received: %d.",
2588             csp->expected_content_length, byte_count, len);
2589          len = 0;
2590          /*
2591           * XXX: should not jump around,
2592           * chat() is complicated enough already.
2593           */
2594          goto reading_done;
2595       }
2596 #endif  /* FEATURE_CONNECTION_KEEP_ALIVE */
2597
2598       n = select((int)maxfd+1, &rfds, NULL, NULL, NULL);
2599
2600       if (n < 0)
2601       {
2602          log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
2603          mark_server_socket_tainted(csp);
2604          return;
2605       }
2606
2607       /*
2608        * This is the body of the browser's request,
2609        * just read and write it.
2610        */
2611       if (FD_ISSET(csp->cfd, &rfds))
2612       {
2613          len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
2614
2615          if (len <= 0)
2616          {
2617             /* XXX: not sure if this is necessary. */
2618             mark_server_socket_tainted(csp);
2619             break; /* "game over, man" */
2620          }
2621
2622          if (write_socket(csp->sfd, buf, (size_t)len))
2623          {
2624             log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
2625             mark_server_socket_tainted(csp);
2626             return;
2627          }
2628          continue;
2629       }
2630
2631       /*
2632        * The server wants to talk. It could be the header or the body.
2633        * If `hdr' is null, then it's the header otherwise it's the body.
2634        * FIXME: Does `hdr' really mean `host'? No.
2635        */
2636       if (FD_ISSET(csp->sfd, &rfds))
2637       {
2638          fflush(0);
2639          len = read_socket(csp->sfd, buf, sizeof(buf) - 1);
2640
2641          if (len < 0)
2642          {
2643             log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
2644
2645             if (http->ssl && (fwd->forward_host == NULL))
2646             {
2647                /*
2648                 * Just hang up. We already confirmed the client's CONNECT
2649                 * request with status code 200 and unencrypted content is
2650                 * no longer welcome.
2651                 */
2652                log_error(LOG_LEVEL_ERROR,
2653                   "CONNECT already confirmed. Unable to tell the client about the problem.");
2654                return;
2655             }
2656             else if (byte_count)
2657             {
2658                /*
2659                 * Just hang up. We already transmitted the original headers
2660                 * and parts of the original content and therefore missed the
2661                 * chance to send an error message (without risking data corruption).
2662                 *
2663                 * XXX: we could retry with a fancy range request here.
2664                 */
2665                log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
2666                   "Unable to tell the client about the problem.");
2667                mark_server_socket_tainted(csp);
2668                return;
2669             }
2670
2671             rsp = error_response(csp, "connect-failed", errno);
2672             if (rsp)
2673             {
2674                send_crunch_response(csp, rsp);
2675             }
2676
2677             return;
2678          }
2679
2680 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2681          if (csp->flags & CSP_FLAG_CHUNKED)
2682          {
2683             if ((len > 5) && !memcmp(buf+len-5, "0\r\n\r\n", 5))
2684             {
2685                /* XXX: this is a temporary hack */
2686                log_error(LOG_LEVEL_CONNECT,
2687                   "Looks like we reached the end of the last chunk. "
2688                   "We better stop reading.");
2689                csp->expected_content_length = byte_count + (size_t)len;
2690                csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2691             }
2692          }
2693          reading_done:
2694 #endif  /* FEATURE_CONNECTION_KEEP_ALIVE */
2695
2696          /*
2697           * Add a trailing zero to let be able to use string operations.
2698           * XXX: do we still need this with filter_popups gone?
2699           */
2700          buf[len] = '\0';
2701
2702          /*
2703           * Normally, this would indicate that we've read
2704           * as much as the server has sent us and we can
2705           * close the client connection.  However, Microsoft
2706           * in its wisdom has released IIS/5 with a bug that
2707           * prevents it from sending the trailing \r\n in
2708           * a 302 redirect header (and possibly other headers).
2709           * To work around this if we've haven't parsed
2710           * a full header we'll append a trailing \r\n
2711           * and see if this now generates a valid one.
2712           *
2713           * This hack shouldn't have any impacts.  If we've
2714           * already transmitted the header or if this is a
2715           * SSL connection, then we won't bother with this
2716           * hack.  So we only work on partially received
2717           * headers.  If we append a \r\n and this still
2718           * doesn't generate a valid header, then we won't
2719           * transmit anything to the client.
2720           */
2721          if (len == 0)
2722          {
2723
2724             if (server_body || http->ssl)
2725             {
2726                /*
2727                 * If we have been buffering up the document,
2728                 * now is the time to apply content modification
2729                 * and send the result to the client.
2730                 */
2731                if (content_filter)
2732                {
2733                   p = execute_content_filter(csp, content_filter);
2734                   /*
2735                    * If the content filter fails, use the original
2736                    * buffer and length.
2737                    * (see p != NULL ? p : csp->iob->cur below)
2738                    */
2739                   if (NULL == p)
2740                   {
2741                      csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
2742                   }
2743
2744                   if (JB_ERR_OK != update_server_headers(csp))
2745                   {
2746                      log_error(LOG_LEVEL_FATAL,
2747                         "Failed to update server headers. after filtering.");
2748                   }
2749
2750                   hdr = list_to_text(csp->headers);
2751                   if (hdr == NULL)
2752                   {
2753                      /* FIXME Should handle error properly */
2754                      log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2755                   }
2756
2757                   if (write_socket(csp->cfd, hdr, strlen(hdr))
2758                    || write_socket(csp->cfd, p != NULL ? p : csp->iob->cur, csp->content_length))
2759                   {
2760                      log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
2761                      freez(hdr);
2762                      freez(p);
2763                      mark_server_socket_tainted(csp);
2764                      return;
2765                   }
2766
2767                   freez(hdr);
2768                   freez(p);
2769                }
2770
2771                break; /* "game over, man" */
2772             }
2773
2774             /*
2775              * This is NOT the body, so
2776              * Let's pretend the server just sent us a blank line.
2777              */
2778             snprintf(buf, sizeof(buf), "\r\n");
2779             len = (int)strlen(buf);
2780
2781             /*
2782              * Now, let the normal header parsing algorithm below do its
2783              * job.  If it fails, we'll exit instead of continuing.
2784              */
2785
2786             ms_iis5_hack = 1;
2787          }
2788
2789          /*
2790           * If this is an SSL connection or we're in the body
2791           * of the server document, just write it to the client,
2792           * unless we need to buffer the body for later content-filtering
2793           */
2794          if (server_body || http->ssl)
2795          {
2796             if (content_filter)
2797             {
2798                /*
2799                 * If there is no memory left for buffering the content, or the buffer limit
2800                 * has been reached, switch to non-filtering mode, i.e. make & write the
2801                 * header, flush the iob and buf, and get out of the way.
2802                 */
2803                if (add_to_iob(csp, buf, len))
2804                {
2805                   size_t hdrlen;
2806                   int flushed;
2807
2808                   log_error(LOG_LEVEL_INFO,
2809                      "Flushing header and buffers. Stepping back from filtering.");
2810
2811                   hdr = list_to_text(csp->headers);
2812                   if (hdr == NULL)
2813                   {
2814                      /* 
2815                       * Memory is too tight to even generate the header.
2816                       * Send our static "Out-of-memory" page.
2817                       */
2818                      log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
2819                      rsp = cgi_error_memory();
2820                      send_crunch_response(csp, rsp);
2821                      mark_server_socket_tainted(csp);
2822                      return;
2823                   }
2824                   hdrlen = strlen(hdr);
2825
2826                   if (write_socket(csp->cfd, hdr, hdrlen)
2827                    || ((flushed = flush_socket(csp->cfd, csp->iob)) < 0)
2828                    || (write_socket(csp->cfd, buf, (size_t)len)))
2829                   {
2830                      log_error(LOG_LEVEL_CONNECT,
2831                         "Flush header and buffers to client failed: %E");
2832                      freez(hdr);
2833                      mark_server_socket_tainted(csp);
2834                      return;
2835                   }
2836
2837                   /*
2838                    * Reset the byte_count to the amount of bytes
2839                    * we just flushed. len will be added a few lines below,
2840                    * hdrlen doesn't matter for LOG_LEVEL_CLF.
2841                    */
2842                   byte_count = (size_t)flushed;
2843                   freez(hdr);
2844                   content_filter = NULL;
2845                   server_body = 1;
2846                }
2847             }
2848             else
2849             {
2850                if (write_socket(csp->cfd, buf, (size_t)len))
2851                {
2852                   log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
2853                   mark_server_socket_tainted(csp);
2854                   return;
2855                }
2856             }
2857             byte_count += (size_t)len;
2858             continue;
2859          }
2860          else
2861          {
2862             const char *header_start;
2863             /*
2864              * We're still looking for the end of the server's header.
2865              * Buffer up the data we just read.  If that fails, there's
2866              * little we can do but send our static out-of-memory page.
2867              */
2868             if (add_to_iob(csp, buf, len))
2869             {
2870                log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
2871                rsp = cgi_error_memory();
2872                send_crunch_response(csp, rsp);               
2873                mark_server_socket_tainted(csp);
2874                return;
2875             }
2876
2877             header_start = csp->iob->cur;
2878
2879             /* Convert iob into something sed() can digest */
2880             if (JB_ERR_PARSE == get_server_headers(csp))
2881             {
2882                if (ms_iis5_hack)
2883                {
2884                   /*
2885                    * Well, we tried our MS IIS/5 hack and it didn't work.
2886                    * The header is incomplete and there isn't anything
2887                    * we can do about it.
2888                    */
2889                   log_error(LOG_LEVEL_INFO,
2890                      "MS IIS5 hack didn't produce valid headers.");
2891                   break;
2892                }
2893                else
2894                {
2895                   /*
2896                    * Since we have to wait for more from the server before
2897                    * we can parse the headers we just continue here.
2898                    */
2899                   continue;
2900                }
2901             }
2902
2903             /* Did we actually get anything? */
2904             if (NULL == csp->headers->first)
2905             {
2906                log_error(LOG_LEVEL_ERROR, "Empty server or forwarder response.");
2907                log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2908                write_socket(csp->cfd, NO_SERVER_DATA_RESPONSE, strlen(NO_SERVER_DATA_RESPONSE));
2909                free_http_request(http);
2910                mark_server_socket_tainted(csp);
2911                return;
2912             }
2913
2914             assert(csp->headers->first->str);
2915             assert(!http->ssl);
2916             if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
2917                 strncmpic(csp->headers->first->str, "ICY", 3))
2918             {
2919                /*
2920                 * It doesn't look like a HTTP (or Shoutcast) response:
2921                 * tell the client and log the problem.
2922                 */
2923                if (strlen(csp->headers->first->str) > 30)
2924                {
2925                   csp->headers->first->str[30] = '\0';
2926                }
2927                log_error(LOG_LEVEL_ERROR,
2928                   "Invalid server or forwarder response. Starts with: %s",
2929                   csp->headers->first->str);
2930                log_error(LOG_LEVEL_CLF,
2931                   "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2932                write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2933                   strlen(INVALID_SERVER_HEADERS_RESPONSE));
2934                free_http_request(http);
2935                mark_server_socket_tainted(csp);
2936                return;
2937             }
2938
2939             /*
2940              * We have now received the entire server header,
2941              * filter it and send the result to the client
2942              */
2943             if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
2944             {
2945                log_error(LOG_LEVEL_FATAL, "Failed to parse server headers.");
2946             }
2947             hdr = list_to_text(csp->headers);
2948             if (hdr == NULL)
2949             {
2950                /* FIXME Should handle error properly */
2951                log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2952             }
2953
2954             if (crunch_response_triggered(csp, crunchers_light))
2955             {
2956                /*
2957                 * One of the tags created by a server-header
2958                 * tagger triggered a crunch. We already
2959                 * delivered the crunch response to the client
2960                 * and are done here after cleaning up.
2961                 */
2962                 freez(hdr);
2963                 mark_server_socket_tainted(csp);
2964                 return;
2965             }
2966             /* Buffer and pcrs filter this if appropriate. */
2967
2968             if (!http->ssl) /* We talk plaintext */
2969             {
2970                content_filter = get_filter_function(csp);
2971             }
2972             /*
2973              * Only write if we're not buffering for content modification
2974              */
2975             if (!content_filter)
2976             {
2977                /*
2978                 * Write the server's (modified) header to
2979                 * the client (along with anything else that
2980                 * may be in the buffer)
2981                 */
2982
2983                if (write_socket(csp->cfd, hdr, strlen(hdr))
2984                 || ((len = flush_socket(csp->cfd, csp->iob)) < 0))
2985                {
2986                   log_error(LOG_LEVEL_CONNECT, "write header to client failed: %E");
2987
2988                   /*
2989                    * The write failed, so don't bother mentioning it
2990                    * to the client... it probably can't hear us anyway.
2991                    */
2992                   freez(hdr);
2993                   mark_server_socket_tainted(csp);
2994                   return;
2995                }
2996
2997                byte_count += (size_t)len;
2998             }
2999             else
3000             {
3001                /*
3002                 * XXX: the header lenght should probably
3003                 * be calculated by get_server_headers().
3004                 */
3005                int header_length = csp->iob->cur - header_start;
3006                assert(csp->iob->cur > header_start);
3007                byte_count += (size_t)(len - header_length);
3008             }
3009
3010             /* we're finished with the server's header */
3011
3012             freez(hdr);
3013             server_body = 1;
3014
3015             /*
3016              * If this was a MS IIS/5 hack then it means the server
3017              * has already closed the connection. Nothing more to read.
3018              * Time to bail.
3019              */
3020             if (ms_iis5_hack)
3021             {
3022                log_error(LOG_LEVEL_INFO,
3023                   "Closed server connection detected with MS IIS5 hack enabled.");
3024                break;
3025             }
3026          }
3027          continue;
3028       }
3029       mark_server_socket_tainted(csp);
3030       return; /* huh? we should never get here */
3031    }
3032
3033    if (csp->content_length == 0)
3034    {
3035       /*
3036        * If Privoxy didn't recalculate the Content-Lenght,
3037        * byte_count is still correct.
3038        */
3039       csp->content_length = byte_count;
3040    }
3041
3042    log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %d",
3043       csp->ip_addr_str, http->ocmd, csp->content_length);
3044 }
3045
3046
3047 /*********************************************************************
3048  *
3049  * Function    :  serve
3050  *
3051  * Description :  This is little more than chat.  We only "serve" to
3052  *                to close any socket that chat may have opened.
3053  *
3054  * Parameters  :
3055  *          1  :  csp = Current client state (buffers, headers, etc...)
3056  *
3057  * Returns     :  N/A
3058  *
3059  *********************************************************************/
3060 #ifdef AMIGA
3061 void serve(struct client_state *csp)
3062 #else /* ifndef AMIGA */
3063 static void serve(struct client_state *csp)
3064 #endif /* def AMIGA */
3065 {
3066    chat(csp);
3067    close_socket(csp->cfd);
3068
3069    if (csp->sfd != JB_INVALID_SOCKET)
3070    {
3071 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3072       if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE))
3073       {
3074          remember_connection(csp->sfd, csp->http, forward_url(csp, csp->http));
3075       }
3076       else
3077       {
3078          forget_connection(csp->sfd);
3079          close_socket(csp->sfd);
3080       }
3081 #else
3082       close_socket(csp->sfd);
3083 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3084    }
3085
3086    csp->flags &= ~CSP_FLAG_ACTIVE;
3087
3088 }
3089
3090
3091 #ifdef __BEOS__
3092 /*********************************************************************
3093  *
3094  * Function    :  server_thread
3095  *
3096  * Description :  We only exist to call `serve' in a threaded environment.
3097  *
3098  * Parameters  :
3099  *          1  :  data = Current client state (buffers, headers, etc...)
3100  *
3101  * Returns     :  Always 0.
3102  *
3103  *********************************************************************/
3104 static int32 server_thread(void *data)
3105 {
3106    serve((struct client_state *) data);
3107    return 0;
3108
3109 }
3110 #endif
3111
3112
3113 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
3114 /*********************************************************************
3115  *
3116  * Function    :  usage
3117  *
3118  * Description :  Print usage info & exit.
3119  *
3120  * Parameters  :  Pointer to argv[0] for identifying ourselves
3121  *
3122  * Returns     :  No. ,-)
3123  *
3124  *********************************************************************/
3125 static void usage(const char *myname)
3126 {
3127    printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
3128           "Usage: %s "
3129 #if defined(unix)
3130           "[--chroot] "
3131 #endif /* defined(unix) */
3132           "[--help] "
3133 #if defined(unix)
3134           "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
3135 #endif /* defined(unix) */
3136           "[--version] [configfile]\n"
3137           "Aborting\n", myname);
3138
3139    exit(2);
3140
3141 }
3142 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
3143
3144
3145 #ifdef MUTEX_LOCKS_AVAILABLE
3146 /*********************************************************************
3147  *
3148  * Function    :  privoxy_mutex_lock
3149  *
3150  * Description :  Locks a mutex.
3151  *
3152  * Parameters  :
3153  *          1  :  mutex = The mutex to lock.
3154  *
3155  * Returns     :  Void. May exit in case of errors.
3156  *
3157  *********************************************************************/
3158 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
3159 {
3160 #ifdef FEATURE_PTHREAD
3161    int err = pthread_mutex_lock(mutex);
3162    if (err)
3163    {
3164       if (mutex != &log_mutex)
3165       {
3166          log_error(LOG_LEVEL_FATAL,
3167             "Mutex locking failed: %s.\n", strerror(err));
3168       }
3169       exit(1);
3170    }
3171 #else
3172    EnterCriticalSection(mutex);
3173 #endif /* def FEATURE_PTHREAD */
3174 }
3175
3176
3177 /*********************************************************************
3178  *
3179  * Function    :  privoxy_mutex_unlock
3180  *
3181  * Description :  Unlocks a mutex.
3182  *
3183  * Parameters  :
3184  *          1  :  mutex = The mutex to unlock.
3185  *
3186  * Returns     :  Void. May exit in case of errors.
3187  *
3188  *********************************************************************/
3189 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
3190 {
3191 #ifdef FEATURE_PTHREAD
3192    int err = pthread_mutex_unlock(mutex);
3193    if (err)
3194    {
3195       if (mutex != &log_mutex)
3196       {
3197          log_error(LOG_LEVEL_FATAL,
3198             "Mutex unlocking failed: %s.\n", strerror(err));
3199       }
3200       exit(1);
3201    }
3202 #else
3203    LeaveCriticalSection(mutex);
3204 #endif /* def FEATURE_PTHREAD */
3205 }
3206
3207
3208 /*********************************************************************
3209  *
3210  * Function    :  privoxy_mutex_init
3211  *
3212  * Description :  Prepares a mutex.
3213  *
3214  * Parameters  :
3215  *          1  :  mutex = The mutex to initialize.
3216  *
3217  * Returns     :  Void. May exit in case of errors.
3218  *
3219  *********************************************************************/
3220 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
3221 {
3222 #ifdef FEATURE_PTHREAD
3223    int err = pthread_mutex_init(mutex, 0);
3224    if (err)
3225    {
3226       printf("Fatal error. Mutex initialization failed: %s.\n",
3227          strerror(err));
3228       exit(1);
3229    }
3230 #else
3231    InitializeCriticalSection(mutex);
3232 #endif /* def FEATURE_PTHREAD */
3233 }
3234 #endif /* def MUTEX_LOCKS_AVAILABLE */
3235
3236 /*********************************************************************
3237  *
3238  * Function    :  initialize_mutexes
3239  *
3240  * Description :  Prepares mutexes if mutex support is available.
3241  *
3242  * Parameters  :  None
3243  *
3244  * Returns     :  Void, exits in case of errors.
3245  *
3246  *********************************************************************/
3247 static void initialize_mutexes(void)
3248 {
3249 #ifdef MUTEX_LOCKS_AVAILABLE
3250    /*
3251     * Prepare global mutex semaphores
3252     */
3253    privoxy_mutex_init(&log_mutex);
3254    privoxy_mutex_init(&log_init_mutex);
3255    privoxy_mutex_init(&connection_reuse_mutex);
3256
3257    /*
3258     * XXX: The assumptions below are a bit naive
3259     * and can cause locks that aren't necessary.
3260     *
3261     * For example older FreeBSD versions (< 6.x?)
3262     * have no gethostbyname_r, but gethostbyname is
3263     * thread safe.
3264     */
3265 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
3266    privoxy_mutex_init(&resolver_mutex);
3267 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
3268    /*
3269     * XXX: should we use a single mutex for
3270     * localtime() and gmtime() as well?
3271     */
3272 #ifndef HAVE_GMTIME_R
3273    privoxy_mutex_init(&gmtime_mutex);
3274 #endif /* ndef HAVE_GMTIME_R */
3275
3276 #ifndef HAVE_LOCALTIME_R
3277    privoxy_mutex_init(&localtime_mutex);
3278 #endif /* ndef HAVE_GMTIME_R */
3279
3280 #ifndef HAVE_RANDOM
3281    privoxy_mutex_init(&rand_mutex);
3282 #endif /* ndef HAVE_RANDOM */
3283 #endif /* def MUTEX_LOCKS_AVAILABLE */
3284 }
3285
3286
3287 /*********************************************************************
3288  *
3289  * Function    :  main
3290  *
3291  * Description :  Load the config file and start the listen loop.
3292  *                This function is a lot more *sane* with the `load_config'
3293  *                and `listen_loop' functions; although it stills does
3294  *                a *little* too much for my taste.
3295  *
3296  * Parameters  :
3297  *          1  :  argc = Number of parameters (including $0).
3298  *          2  :  argv = Array of (char *)'s to the parameters.
3299  *
3300  * Returns     :  1 if : can't open config file, unrecognized directive,
3301  *                stats requested in multi-thread mode, can't open the
3302  *                log file, can't open the jar file, listen port is invalid,
3303  *                any load fails, and can't bind port.
3304  *
3305  *                Else main never returns, the process must be signaled
3306  *                to terminate execution.  Or, on Windows, use the
3307  *                "File", "Exit" menu option.
3308  *
3309  *********************************************************************/
3310 #ifdef __MINGW32__
3311 int real_main(int argc, const char *argv[])
3312 #else
3313 int main(int argc, const char *argv[])
3314 #endif
3315 {
3316    int argc_pos = 0;
3317    unsigned int random_seed;
3318 #ifdef unix
3319    struct passwd *pw = NULL;
3320    struct group *grp = NULL;
3321    char *p;
3322    int do_chroot = 0;
3323    char *pre_chroot_nslookup_to_load_resolver = NULL;
3324 #endif
3325
3326    Argc = argc;
3327    Argv = argv;
3328
3329    configfile =
3330 #if !defined(_WIN32)
3331    "config"
3332 #else
3333    "config.txt"
3334 #endif
3335       ;
3336
3337    /*
3338     * Parse the command line arguments
3339     *
3340     * XXX: simply printing usage information in case of
3341     * invalid arguments isn't particularly user friendly.
3342     */
3343    while (++argc_pos < argc)
3344    {
3345 #ifdef _WIN32
3346       /* Check to see if the service must be installed or uninstalled */
3347       if (strncmp(argv[argc_pos], "--install", 9) == 0)
3348       {
3349          const char *pName = argv[argc_pos] + 9;
3350          if (*pName == ':')
3351             pName++;
3352          exit( (install_service(pName)) ? 0 : 1 );
3353       }
3354       else if (strncmp(argv[argc_pos], "--uninstall", + 11) == 0)
3355       {
3356          const char *pName = argv[argc_pos] + 11;
3357          if (*pName == ':')
3358             pName++;
3359          exit((uninstall_service(pName)) ? 0 : 1);
3360       }
3361       else if (strcmp(argv[argc_pos], "--service" ) == 0)
3362       {
3363          bRunAsService = TRUE;
3364          w32_set_service_cwd();
3365          atexit(w32_service_exit_notify);
3366       }
3367       else
3368 #endif /* defined(_WIN32) */
3369
3370
3371 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
3372
3373       if (strcmp(argv[argc_pos], "--help") == 0)
3374       {
3375          usage(argv[0]);
3376       }
3377
3378       else if(strcmp(argv[argc_pos], "--version") == 0)
3379       {
3380          printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
3381          exit(0);
3382       }
3383
3384 #if defined(unix)
3385
3386       else if (strcmp(argv[argc_pos], "--no-daemon" ) == 0)
3387       {
3388          no_daemon = 1;
3389       }
3390
3391       else if (strcmp(argv[argc_pos], "--pidfile" ) == 0)
3392       {
3393          if (++argc_pos == argc) usage(argv[0]);
3394          pidfile = strdup(argv[argc_pos]);
3395       }
3396
3397       else if (strcmp(argv[argc_pos], "--user" ) == 0)
3398       {
3399          if (++argc_pos == argc) usage(argv[argc_pos]);
3400
3401          if ((NULL != (p = strchr(argv[argc_pos], '.'))) && *(p + 1) != '0')
3402          {
3403             *p++ = '\0';
3404             if (NULL == (grp = getgrnam(p)))
3405             {
3406                log_error(LOG_LEVEL_FATAL, "Group %s not found.", p);
3407             }
3408          }
3409
3410          if (NULL == (pw = getpwnam(argv[argc_pos])))
3411          {
3412             log_error(LOG_LEVEL_FATAL, "User %s not found.", argv[argc_pos]);
3413          }
3414
3415          if (p != NULL) *--p = '\0';
3416       }
3417
3418       else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup" ) == 0)
3419       {
3420          if (++argc_pos == argc) usage(argv[0]);
3421          pre_chroot_nslookup_to_load_resolver = strdup(argv[argc_pos]);
3422       }
3423
3424       else if (strcmp(argv[argc_pos], "--chroot" ) == 0)
3425       {
3426          do_chroot = 1;
3427       }
3428 #endif /* defined(unix) */
3429
3430       else if (argc_pos + 1 != argc)
3431       {
3432          /*
3433           * This is neither the last command line
3434           * option, nor was it recognized before,
3435           * therefore it must be invalid.
3436           */
3437          usage(argv[0]);
3438       }
3439       else
3440
3441 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
3442       {
3443          configfile = argv[argc_pos];
3444       }
3445
3446    } /* -END- while (more arguments) */
3447
3448 #if defined(unix)
3449    if ( *configfile != '/' )
3450    {
3451       char cwd[BUFFER_SIZE];
3452       char *abs_file;
3453       size_t abs_file_size; 
3454
3455       /* make config-filename absolute here */
3456       if (NULL == getcwd(cwd, sizeof(cwd)))
3457       {
3458          perror("failed to get current working directory");
3459          exit( 1 );
3460       }
3461
3462       /* XXX: why + 5? */
3463       abs_file_size = strlen(cwd) + strlen(configfile) + 5;
3464       basedir = strdup(cwd);
3465
3466       if (NULL == basedir ||
3467           NULL == (abs_file = malloc(abs_file_size)))
3468       {
3469          perror("malloc failed");
3470          exit( 1 );
3471       }
3472       strlcpy(abs_file, basedir, abs_file_size);
3473       strlcat(abs_file, "/", abs_file_size );
3474       strlcat(abs_file, configfile, abs_file_size);
3475       configfile = abs_file;
3476    }
3477 #endif /* defined unix */
3478
3479
3480    files->next = NULL;
3481    clients->next = NULL;
3482
3483    /* XXX: factor out initialising after the next stable release. */
3484 #ifdef AMIGA
3485    InitAmiga();
3486 #elif defined(_WIN32)
3487    InitWin32();
3488 #endif
3489
3490    /* Prepare mutexes if supported and necessary. */
3491    initialize_mutexes();
3492
3493    /* Enable logging until further notice. */
3494    init_log_module(Argv[0]);
3495
3496    random_seed = (unsigned int)time(NULL);
3497 #ifdef HAVE_RANDOM
3498    srandom(random_seed);
3499 #else
3500    srand(random_seed);
3501 #endif /* ifdef HAVE_RANDOM */
3502
3503    /*
3504     * Unix signal handling
3505     *
3506     * Catch the abort, interrupt and terminate signals for a graceful exit
3507     * Catch the hangup signal so the errlog can be reopened.
3508     * Ignore the broken pipe signals (FIXME: Why?)
3509     */
3510 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
3511 {
3512    int idx;
3513    const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP, 0 };
3514    const int ignored_signals[] = { SIGPIPE, 0 };
3515
3516    for (idx = 0; catched_signals[idx] != 0; idx++)
3517    {
3518 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */ 
3519       if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
3520 #else
3521       if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
3522 #endif /* ifdef sun */
3523       {
3524          log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
3525       }
3526    }
3527
3528    for (idx = 0; ignored_signals[idx] != 0; idx++)
3529    {
3530       if (signal(ignored_signals[idx], SIG_IGN) == SIG_ERR)
3531       {
3532          log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for signal %d: %E", ignored_signals[idx]);
3533       }
3534    }
3535
3536 }
3537 #else /* ifdef _WIN32 */
3538 # ifdef _WIN_CONSOLE
3539    /*
3540     * We *are* in a windows console app.
3541     * Print a verbose messages about FAQ's and such
3542     */
3543    printf("%s", win32_blurb);
3544 # endif /* def _WIN_CONSOLE */
3545 #endif /* def _WIN32 */
3546
3547
3548    /* Initialize the CGI subsystem */
3549    cgi_init_error_messages();
3550
3551    /*
3552     * If runnig on unix and without the --nodaemon
3553     * option, become a daemon. I.e. fork, detach
3554     * from tty and get process group leadership
3555     */
3556 #if defined(unix)
3557 {
3558    pid_t pid = 0;
3559 #if 0
3560    int   fd;
3561 #endif
3562
3563    if (!no_daemon)
3564    {
3565       pid  = fork();
3566
3567       if ( pid < 0 ) /* error */
3568       {
3569          perror("fork");
3570          exit( 3 );
3571       }
3572       else if ( pid != 0 ) /* parent */
3573       {
3574          int status;
3575          pid_t wpid;
3576          /*
3577           * must check for errors
3578           * child died due to missing files aso
3579           */
3580          sleep( 1 );
3581          wpid = waitpid( pid, &status, WNOHANG );
3582          if ( wpid != 0 )
3583          {
3584             exit( 1 );
3585          }
3586          exit( 0 );
3587       }
3588       /* child */
3589 #if 1
3590       /* Should be more portable, but not as well tested */
3591       setsid();
3592 #else /* !1 */
3593 #ifdef __FreeBSD__
3594       setpgrp(0,0);
3595 #else /* ndef __FreeBSD__ */
3596       setpgrp();
3597 #endif /* ndef __FreeBSD__ */
3598       fd = open("/dev/tty", O_RDONLY);
3599       if ( fd )
3600       {
3601          /* no error check here */
3602          ioctl( fd, TIOCNOTTY,0 );
3603          close ( fd );
3604       }
3605 #endif /* 1 */
3606       /*
3607        * stderr (fd 2) will be closed later on, when the
3608        * log file has been parsed.
3609        */
3610
3611       close( 0 );
3612       close( 1 );
3613       chdir("/");
3614
3615    } /* -END- if (!no_daemon) */
3616
3617    /*
3618     * As soon as we have written the PID file, we can switch
3619     * to the user and group ID indicated by the --user option
3620     */
3621    write_pid_file();
3622
3623    if (NULL != pw)
3624    {
3625       if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
3626       {
3627          log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
3628       }
3629       if (do_chroot)
3630       {
3631          if (!pw->pw_dir)
3632          {
3633             log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
3634          }
3635          /* Read the time zone file from /etc before doing chroot. */
3636          tzset();
3637          if (NULL != pre_chroot_nslookup_to_load_resolver
3638              && '\0' != pre_chroot_nslookup_to_load_resolver[0])
3639          {
3640             /* Initialize resolver library. */
3641             (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
3642          }
3643          if (chroot(pw->pw_dir) < 0)
3644          {
3645             log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
3646          }
3647          if (chdir ("/"))
3648          {
3649             log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
3650          }
3651       }
3652       if (setuid(pw->pw_uid))
3653       {
3654          log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
3655       }
3656       if (do_chroot)
3657       {
3658          char putenv_dummy[64];
3659
3660          strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
3661          if (putenv(putenv_dummy) != 0)
3662          {
3663             log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
3664          }                
3665
3666          snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
3667          if (putenv(putenv_dummy) != 0)
3668          {
3669             log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
3670          }
3671       }
3672    }
3673    else if (do_chroot)
3674    {
3675       log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
3676    }
3677 }
3678 #endif /* defined unix */
3679
3680 #ifdef _WIN32
3681    /* This will be FALSE unless the command line specified --service
3682     */
3683    if (bRunAsService)
3684    {
3685       /* Yup, so now we must attempt to establish a connection 
3686        * with the service dispatcher. This will only work if this
3687        * process was launched by the service control manager to
3688        * actually run as a service. If this isn't the case, i've
3689        * known it take around 30 seconds or so for the call to return.
3690        */
3691
3692       /* The StartServiceCtrlDispatcher won't return until the service is stopping */
3693       if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
3694       {
3695          /* Service has run, and at this point is now being stopped, so just return */
3696          return 0;
3697       }
3698
3699 #ifdef _WIN_CONSOLE
3700       printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
3701 #endif
3702       /* An error occurred. Usually it's because --service was wrongly specified
3703        * and we were unable to connect to the Service Control Dispatcher because
3704        * it wasn't expecting us and is therefore not listening.
3705        *
3706        * For now, just continue below to call the listen_loop function.
3707        */
3708    }
3709 #endif /* def _WIN32 */
3710
3711    listen_loop();
3712
3713    /* NOTREACHED */
3714    return(-1);
3715
3716 }
3717
3718
3719 /*********************************************************************
3720  *
3721  * Function    :  bind_port_helper
3722  *
3723  * Description :  Bind the listen port.  Handles logging, and aborts
3724  *                on failure.
3725  *
3726  * Parameters  :
3727  *          1  :  config = Privoxy configuration.  Specifies port
3728  *                         to bind to.
3729  *
3730  * Returns     :  Port that was opened.
3731  *
3732  *********************************************************************/
3733 static jb_socket bind_port_helper(struct configuration_spec * config)
3734 {
3735    int result;
3736    jb_socket bfd;
3737
3738    if (config->haddr == NULL)
3739    {
3740       log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
3741                 config->hport);
3742    }
3743    else
3744    {
3745       log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
3746                 config->hport, config->haddr);
3747    }
3748
3749    result = bind_port(config->haddr, config->hport, &bfd);
3750
3751    if (result < 0)
3752    {
3753       switch(result)
3754       {
3755          case -3 :
3756             log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
3757                "There may be another Privoxy or some other "
3758                "proxy running on port %d",
3759                (NULL != config->haddr) ? config->haddr : "INADDR_ANY",
3760                       config->hport, config->hport);
3761
3762          case -2 :
3763             log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: " 
3764                "The hostname is not resolvable",
3765                (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
3766
3767          default :
3768             log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: because %E",
3769                (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
3770       }
3771
3772       /* shouldn't get here */
3773       return JB_INVALID_SOCKET;
3774    }
3775
3776    config->need_bind = 0;
3777
3778    return bfd;
3779 }
3780
3781
3782 #ifdef _WIN32
3783 /* Without this simple workaround we get this compiler warning from _beginthread
3784  *     warning C4028: formal parameter 1 different from declaration
3785  */
3786 void w32_service_listen_loop(void *p)
3787 {
3788    listen_loop();
3789 }
3790 #endif /* def _WIN32 */
3791
3792
3793 /*********************************************************************
3794  *
3795  * Function    :  listen_loop
3796  *
3797  * Description :  bind the listen port and enter a "FOREVER" listening loop.
3798  *
3799  * Parameters  :  N/A
3800  *
3801  * Returns     :  Never.
3802  *
3803  *********************************************************************/
3804 static void listen_loop(void)
3805 {
3806    struct client_state *csp = NULL;
3807    jb_socket bfd;
3808    struct configuration_spec * config;
3809
3810    config = load_config();
3811
3812 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3813    /*
3814     * XXX: Should be relocated once it no
3815     * longer needs to emit log messages.
3816     */
3817    initialize_reusable_connections();
3818 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3819
3820    bfd = bind_port_helper(config);
3821
3822 #ifdef FEATURE_GRACEFUL_TERMINATION
3823    while (!g_terminate)
3824 #else
3825    for (;;)
3826 #endif
3827    {
3828 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
3829       while (waitpid(-1, NULL, WNOHANG) > 0)
3830       {
3831          /* zombie children */
3832       }
3833 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
3834
3835       /*
3836        * Free data that was used by died threads
3837        */
3838       sweep();
3839
3840 #if defined(unix)
3841       /*
3842        * Re-open the errlog after HUP signal
3843        */
3844       if (received_hup_signal)
3845       {
3846          if (NULL != config->logfile)
3847          {
3848             init_error_log(Argv[0], config->logfile);
3849          }
3850          received_hup_signal = 0;
3851       }
3852 #endif
3853
3854       if ( NULL == (csp = (struct client_state *) zalloc(sizeof(*csp))) )
3855       {
3856          log_error(LOG_LEVEL_FATAL, "malloc(%d) for csp failed: %E", sizeof(*csp));
3857          continue;
3858       }
3859
3860       csp->flags |= CSP_FLAG_ACTIVE;
3861       csp->sfd    = JB_INVALID_SOCKET;
3862
3863       csp->config = config = load_config();
3864
3865       if ( config->need_bind )
3866       {
3867          /*
3868           * Since we were listening to the "old port", we will not see
3869           * a "listen" param change until the next IJB request.  So, at
3870           * least 1 more request must be made for us to find the new
3871           * setting.  I am simply closing the old socket and binding the
3872           * new one.
3873           *
3874           * Which-ever is correct, we will serve 1 more page via the
3875           * old settings.  This should probably be a "show-proxy-args"
3876           * request.  This should not be a so common of an operation
3877           * that this will hurt people's feelings.
3878           */
3879
3880          close_socket(bfd);
3881
3882          bfd = bind_port_helper(config);
3883       }
3884
3885       log_error(LOG_LEVEL_CONNECT, "Listening for new connections ... ");
3886
3887       if (!accept_connection(csp, bfd))
3888       {
3889          log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
3890
3891 #ifdef AMIGA
3892          if(!childs)
3893          {
3894             exit(1);
3895          }
3896 #endif
3897          freez(csp);
3898          continue;
3899       }
3900       else
3901       {
3902          log_error(LOG_LEVEL_CONNECT, "accepted connection from %s", csp->ip_addr_str);
3903       }
3904
3905 #ifdef FEATURE_TOGGLE
3906       if (global_toggle_state)
3907 #endif /* def FEATURE_TOGGLE */
3908       {
3909          csp->flags |= CSP_FLAG_TOGGLED_ON;
3910       }
3911
3912       if (run_loader(csp))
3913       {
3914          log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
3915          /* Never get here - LOG_LEVEL_FATAL causes program exit */
3916       }
3917
3918 #ifdef FEATURE_ACL
3919       if (block_acl(NULL,csp))
3920       {
3921          log_error(LOG_LEVEL_CONNECT, "Connection from %s dropped due to ACL", csp->ip_addr_str);
3922          close_socket(csp->cfd);
3923          freez(csp);
3924          continue;
3925       }
3926 #endif /* def FEATURE_ACL */
3927
3928       /* add it to the list of clients */
3929       csp->next = clients->next;
3930       clients->next = csp;
3931
3932       if (config->multi_threaded)
3933       {
3934          int child_id;
3935
3936 /* this is a switch () statment in the C preprocessor - ugh */
3937 #undef SELECTED_ONE_OPTION
3938
3939 /* Use Pthreads in preference to native code */
3940 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
3941 #define SELECTED_ONE_OPTION
3942          {
3943             pthread_t the_thread;
3944             pthread_attr_t attrs;
3945
3946             pthread_attr_init(&attrs);
3947             pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
3948             errno = pthread_create(&the_thread, &attrs,
3949                (void * (*)(void *))serve, csp);
3950             child_id = errno ? -1 : 0;
3951             pthread_attr_destroy(&attrs);
3952          }
3953 #endif
3954
3955 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
3956 #define SELECTED_ONE_OPTION
3957          child_id = _beginthread(
3958             (void (*)(void *))serve,
3959             64 * 1024,
3960             csp);
3961 #endif
3962
3963 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
3964 #define SELECTED_ONE_OPTION
3965          child_id = _beginthread(
3966             (void(* _Optlink)(void*))serve,
3967             NULL,
3968             64 * 1024,
3969             csp);
3970 #endif
3971
3972 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
3973 #define SELECTED_ONE_OPTION
3974          {
3975             thread_id tid = spawn_thread
3976                (server_thread, "server", B_NORMAL_PRIORITY, csp);
3977
3978             if ((tid >= 0) && (resume_thread(tid) == B_OK))
3979             {
3980                child_id = (int) tid;
3981             }
3982             else
3983             {
3984                child_id = -1;
3985             }
3986          }
3987 #endif
3988
3989 #if defined(AMIGA) && !defined(SELECTED_ONE_OPTION)
3990 #define SELECTED_ONE_OPTION
3991          csp->cfd = ReleaseSocket(csp->cfd, -1);
3992          
3993 #ifdef __amigaos4__
3994          child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
3995                                            NP_Output, Output(),
3996                                            NP_CloseOutput, FALSE,
3997                                            NP_Name, (ULONG)"privoxy child",
3998                                            NP_Child, TRUE,
3999                                            TAG_DONE);
4000 #else
4001          child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
4002                                            NP_Output, Output(),
4003                                            NP_CloseOutput, FALSE,
4004                                            NP_Name, (ULONG)"privoxy child",
4005                                            NP_StackSize, 200*1024,
4006                                            TAG_DONE);
4007 #endif
4008          if(0 != child_id)
4009          {
4010             childs++;
4011             ((struct Task *)child_id)->tc_UserData = csp;
4012             Signal((struct Task *)child_id, SIGF_SINGLE);
4013             Wait(SIGF_SINGLE);
4014          }
4015 #endif
4016
4017 #if !defined(SELECTED_ONE_OPTION)
4018          child_id = fork();
4019
4020          /* This block is only needed when using fork().
4021           * When using threads, the server thread was
4022           * created and run by the call to _beginthread().
4023           */
4024          if (child_id == 0)   /* child */
4025          {
4026             int rc = 0;
4027 #ifdef FEATURE_TOGGLE
4028             int inherited_toggle_state = global_toggle_state;
4029 #endif /* def FEATURE_TOGGLE */
4030
4031             serve(csp);
4032
4033             /* 
4034              * If we've been toggled or we've blocked the request, tell Mom
4035              */
4036
4037 #ifdef FEATURE_TOGGLE
4038             if (inherited_toggle_state != global_toggle_state)
4039             {
4040                rc |= RC_FLAG_TOGGLED;
4041             }
4042 #endif /* def FEATURE_TOGGLE */
4043
4044 #ifdef FEATURE_STATISTICS  
4045             if (csp->flags & CSP_FLAG_REJECTED)
4046             {
4047                rc |= RC_FLAG_BLOCKED;
4048             }
4049 #endif /* ndef FEATURE_STATISTICS */
4050
4051             _exit(rc);
4052          }
4053          else if (child_id > 0) /* parent */
4054          {
4055             /* in a fork()'d environment, the parent's
4056              * copy of the client socket and the CSP
4057              * are not used.
4058              */
4059             int child_status;
4060 #if !defined(_WIN32) && !defined(__CYGWIN__)
4061
4062             wait( &child_status );
4063
4064             /* 
4065              * Evaluate child's return code: If the child has
4066              *  - been toggled, toggle ourselves
4067              *  - blocked its request, bump up the stats counter
4068              */
4069
4070 #ifdef FEATURE_TOGGLE
4071             if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
4072             {
4073                global_toggle_state = !global_toggle_state;
4074             }
4075 #endif /* def FEATURE_TOGGLE */
4076
4077 #ifdef FEATURE_STATISTICS
4078             urls_read++;
4079             if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
4080             {
4081                urls_rejected++;
4082             }
4083 #endif /* def FEATURE_STATISTICS */ 
4084
4085 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
4086             close_socket(csp->cfd);
4087             csp->flags &= ~CSP_FLAG_ACTIVE;
4088          }
4089 #endif
4090
4091 #undef SELECTED_ONE_OPTION
4092 /* end of cpp switch () */
4093
4094          if (child_id < 0) /* failed */
4095          {
4096             char buf[BUFFER_SIZE];
4097
4098             log_error(LOG_LEVEL_ERROR, "can't fork: %E");
4099
4100             snprintf(buf , sizeof(buf), "Privoxy: can't fork: errno = %d", errno);
4101
4102             write_socket(csp->cfd, buf, strlen(buf));
4103             close_socket(csp->cfd);
4104             csp->flags &= ~CSP_FLAG_ACTIVE;
4105             sleep(5);
4106             continue;
4107          }
4108       }
4109       else
4110       {
4111          serve(csp);
4112       }
4113    }
4114
4115    /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
4116
4117    /* Clean up.  Aim: free all memory (no leaks) */
4118 #ifdef FEATURE_GRACEFUL_TERMINATION
4119
4120    log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
4121
4122    unload_current_config_file();
4123    unload_current_actions_file();
4124    unload_current_re_filterfile();
4125 #ifdef FEATURE_TRUST
4126    unload_current_trust_file();
4127 #endif
4128
4129    if (config->multi_threaded)
4130    {
4131       int i = 60;
4132       do
4133       {
4134          sleep(1);
4135          sweep();
4136       } while ((clients->next != NULL) && (--i > 0));
4137
4138       if (i <= 0)
4139       {
4140          log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
4141       }
4142    }
4143    sweep();
4144    sweep();
4145
4146 #if defined(unix)
4147    freez(basedir);
4148 #endif
4149    freez(configfile);
4150
4151 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
4152    /* Cleanup - remove taskbar icon etc. */
4153    TermLogWindow();
4154 #endif
4155
4156    exit(0);
4157 #endif /* FEATURE_GRACEFUL_TERMINATION */
4158
4159 }
4160
4161
4162 /*
4163   Local Variables:
4164   tab-width: 3
4165   end:
4166 */