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