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