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