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