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