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