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