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