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