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