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