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