1 const char jcc_rcs[] = "$Id: jcc.c,v 1.92.2.2 2002/11/20 14:37:47 oes Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/Attic/jcc.c,v $
6 * Purpose : Main file. Contains main() method, main loop, and
7 * the main connection-handling function.
9 * Copyright : Written by and Copyright (C) 2001 the SourceForge
10 * Privoxy team. http://www.privoxy.org/
12 * Based on the Internet Junkbuster originally written
13 * by and Copyright (C) 1997 Anonymous Coders and
14 * Junkbusters Corporation. http://www.junkbusters.com
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.
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.
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.
36 * Revision 1.92.2.2 2002/11/20 14:37:47 oes
37 * Fix: Head of global clients list now initialized to NULL
39 * Revision 1.92.2.1 2002/09/25 14:52:24 oes
40 * Added basic support for OPTIONS and TRACE HTTP methods:
41 * - New interceptor direct_response() added in chat().
42 * - sed() moved to earlier in the process, so that the
43 * Host: header is evaluated before actions and forwarding
46 * Revision 1.92 2002/05/08 16:00:46 oes
47 * Chat's buffer handling:
48 * - Fixed bug with unchecked out-of-mem conditions
49 * while reading client request & server headers
50 * - No longer predict if the buffer limit will be exceeded
51 * in the next read -- check add_to_iob's new
52 * return code. If buffer couldn't be extended
53 * (policy or out-of-mem) while
54 * - reading from client: abort
55 * - reading server headers: send error page
56 * - buffering server body for filter: flush,
57 * and if that fails: send error page
59 * Revision 1.91 2002/04/08 20:35:58 swa
62 * Revision 1.90 2002/04/02 14:57:28 oes
63 * Made sending wafers independent of FEATURE_COOKIE_JAR
65 * Revision 1.89 2002/03/31 17:18:59 jongfoster
66 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
68 * Revision 1.88 2002/03/27 14:32:43 david__schmidt
69 * More compiler warning message maintenance
71 * Revision 1.87 2002/03/26 22:29:54 swa
72 * we have a new homepage!
74 * Revision 1.86 2002/03/25 17:04:55 david__schmidt
75 * Workaround for closing the jarfile before load_config() comes around again
77 * Revision 1.85 2002/03/24 15:23:33 jongfoster
80 * Revision 1.84 2002/03/24 13:25:43 swa
81 * name change related issues
83 * Revision 1.83 2002/03/16 23:54:06 jongfoster
84 * Adding graceful termination feature, to help look for memory leaks.
85 * If you enable this (which, by design, has to be done by hand
86 * editing config.h) and then go to http://i.j.b/die, then the program
87 * will exit cleanly after the *next* request. It should free all the
88 * memory that was used.
90 * Revision 1.82 2002/03/13 00:27:05 jongfoster
93 * Revision 1.81 2002/03/12 01:42:50 oes
94 * Introduced modular filters
96 * Revision 1.80 2002/03/11 22:07:05 david__schmidt
97 * OS/2 port maintenance:
98 * - Fixed EMX build - it had decayed a little
99 * - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
100 * substituted a memset for now.
102 * Revision 1.79 2002/03/09 20:03:52 jongfoster
103 * - Making various functions return int rather than size_t.
104 * (Undoing a recent change). Since size_t is unsigned on
105 * Windows, functions like read_socket that return -1 on
106 * error cannot return a size_t.
108 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
109 * crashes, and also frequently caused JB to jump to 100%
110 * CPU and stay there. (Because it thought it had just
111 * read ((unsigned)-1) == 4Gb of data...)
113 * - The signature of write_socket has changed, it now simply
114 * returns success=0/failure=nonzero.
116 * - Trying to get rid of a few warnings --with-debug on
117 * Windows, I've introduced a new type "jb_socket". This is
118 * used for the socket file descriptors. On Windows, this
119 * is SOCKET (a typedef for unsigned). Everywhere else, it's
120 * an int. The error value can't be -1 any more, so it's
121 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
122 * Windows it maps to the #define INVALID_SOCKET.)
124 * - The signature of bind_port has changed.
126 * Revision 1.78 2002/03/08 21:35:04 oes
127 * Added optional group supplement to --user option. Will now use default group of user if no group given
129 * Revision 1.77 2002/03/07 03:52:06 oes
130 * - Fixed compiler warnings etc
131 * - Improved handling of failed DNS lookups
133 * Revision 1.76 2002/03/06 22:54:35 jongfoster
134 * Automated function-comment nitpicking.
136 * Revision 1.75 2002/03/06 10:02:19 oes
137 * Fixed stupid bug when --user was not given
139 * Revision 1.74 2002/03/06 00:49:31 jongfoster
140 * Fixing warning on Windows
141 * Making #ifdefs that refer to the same variable consistently
142 * use #ifdef unix rather than mixing #ifdef unix & #ifndef OS2
144 * Revision 1.73 2002/03/05 23:57:30 hal9
145 * Stray character 's' on line 1618 was breaking build.
147 * Revision 1.72 2002/03/05 21:33:45 david__schmidt
148 * - Re-enable OS/2 building after new parms were added
149 * - Fix false out of memory report when resolving CGI templates when no IP
150 * address is available of failed attempt (a la no such domain)
152 * Revision 1.71 2002/03/05 18:13:56 oes
153 * Added --user option
155 * Revision 1.70 2002/03/05 04:52:42 oes
156 * Deleted non-errlog debugging code
158 * Revision 1.69 2002/03/04 23:50:00 jongfoster
159 * Splitting off bind_port() call into bind_port_helper(), with
162 * Revision 1.68 2002/03/04 20:17:32 oes
165 * Revision 1.67 2002/03/04 18:18:57 oes
166 * - Removed _DEBUG mode
167 * - Cleand up cmdline parsing
168 * - Introduced --no-daemon, --pidfile options
169 * - Cleaned up signal handling:
170 * - Terminate cleanly on INT, TERM and ABRT
171 * - Schedule logfile for re-opening on HUP
172 * - Ignore CHLD and PIPE
173 * - Leave the rest with their default handlers
174 * - Uniform handler registration
175 * - Added usage() function
176 * - Played styleguide police
178 * Revision 1.66 2002/03/03 15:06:55 oes
179 * Re-enabled automatic config reloading
181 * Revision 1.65 2002/03/03 14:49:11 oes
182 * Fixed CLF logging: Now uses client's original HTTP request
184 * Revision 1.64 2002/03/03 09:18:03 joergs
185 * Made jumbjuster work on AmigaOS again.
187 * Revision 1.63 2002/03/02 04:14:50 david__schmidt
188 * Clean up a little CRLF unpleasantness that suddenly appeared
190 * Revision 1.62 2002/02/20 23:17:23 jongfoster
191 * Detecting some out-of memory conditions and exiting with a log message.
193 * Revision 1.61 2002/01/17 21:01:52 jongfoster
194 * Moving all our URL and URL pattern parsing code to urlmatch.c.
196 * Revision 1.60 2001/12/30 14:07:32 steudten
197 * - Add signal handling (unix)
198 * - Add SIGHUP handler (unix)
199 * - Add creation of pidfile (unix)
200 * - Add action 'top' in rc file (RH)
201 * - Add entry 'SIGNALS' to manpage
202 * - Add exit message to logfile (unix)
204 * Revision 1.59 2001/12/13 14:07:18 oes
205 * Fixed Bug: 503 error page now sent OK
207 * Revision 1.58 2001/11/30 23:37:24 jongfoster
208 * Renaming the Win32 config file to config.txt - this is almost the
209 * same as the corresponding UNIX name "config"
211 * Revision 1.57 2001/11/16 00:47:43 jongfoster
212 * Changing the tty-disconnection code to use setsid().
214 * Revision 1.56 2001/11/13 20:20:54 jongfoster
215 * Tabs->spaces, fixing a bug with missing {} around an if()
217 * Revision 1.55 2001/11/13 20:14:53 jongfoster
218 * Patch for FreeBSD setpgrp() as suggested by Alexander Lazic
220 * Revision 1.54 2001/11/07 00:03:14 steudten
221 * Give reliable return value if an error
222 * occurs not just 0 with new daemon mode.
224 * Revision 1.53 2001/11/05 21:41:43 steudten
225 * Add changes to be a real daemon just for unix os.
226 * (change cwd to /, detach from controlling tty, set
227 * process group and session leader to the own process.
229 * Add some fatal-error log message for failed malloc().
230 * Add '-d' if compiled with 'configure --with-debug' to
231 * enable debug output.
233 * Revision 1.52 2001/10/26 20:11:20 jongfoster
234 * Fixing type mismatch
236 * Revision 1.51 2001/10/26 17:38:28 oes
239 * Revision 1.50 2001/10/25 03:40:48 david__schmidt
240 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
241 * threads to call select() simultaneously. So, it's time to do a real, live,
242 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
243 * (native). Both versions will work, but using __OS2__ offers multi-threading.
245 * Revision 1.49 2001/10/23 21:41:35 jongfoster
246 * Added call to initialize the (statically-allocated of course)
247 * "out of memory" CGI response.
249 * Revision 1.48 2001/10/10 19:56:46 jongfoster
250 * Moving some code that wasn't cookie-related out of an #ifdef
253 * Revision 1.47 2001/10/10 16:44:36 oes
254 * Added CONNECT destination port limitation check
256 * Revision 1.46 2001/10/08 15:17:41 oes
257 * Re-enabled SSL forwarding
259 * Revision 1.45 2001/10/07 15:42:11 oes
260 * Replaced 6 boolean members of csp with one bitmap (csp->flags)
262 * Moved downgrading of the HTTP version from parse_http_request to
263 * chat(), since we can't decide if it is necessary before we have
264 * determined the actions for the URL. The HTTP command is now
265 * *always* re-built so the repairs need no longer be special-cased.
267 * filter_popups now gets a csp pointer so it can raise the new
268 * CSP_FLAG_MODIFIED flag.
272 * Added configurable size limit for the IOB. If the IOB grows so
273 * large that the next read would exceed the limit, the header
274 * is generated, and the header & unfiltered buffer are flushed
275 * to the client. Chat then continues in non-buffering,
276 * non-filtering body mode.
278 * Revision 1.44 2001/10/02 18:13:57 oes
281 * Revision 1.43 2001/10/02 15:32:13 oes
282 * Moved generation of hdr
284 * Revision 1.42 2001/09/21 23:02:02 david__schmidt
285 * Cleaning up 2 compiler warnings on OS/2.
287 * Revision 1.41 2001/09/16 17:05:14 jongfoster
288 * Removing unused #include showarg.h
290 * Revision 1.40 2001/09/16 15:41:45 jongfoster
291 * Fixing signed/unsigned comparison warning.
293 * Revision 1.39 2001/09/16 13:21:27 jongfoster
294 * Changes to use new list functions.
296 * Revision 1.38 2001/09/16 13:01:46 jongfoster
297 * Removing redundant function call that zeroed zalloc()'d memory.
299 * Revision 1.37 2001/09/10 11:12:24 oes
300 * Deleted unused variable
302 * Revision 1.36 2001/09/10 10:56:15 oes
303 * Silenced compiler warnings
305 * Revision 1.35 2001/07/31 14:44:22 oes
306 * Deleted unused size parameter from filter_popups()
308 * Revision 1.34 2001/07/30 22:08:36 jongfoster
309 * Tidying up #defines:
310 * - All feature #defines are now of the form FEATURE_xxx
311 * - Permanently turned off WIN_GUI_EDIT
312 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
314 * Revision 1.33 2001/07/29 19:32:00 jongfoster
315 * Renaming _main() [mingw32 only] to real_main(), for ANSI compliance.
317 * Revision 1.32 2001/07/29 18:47:05 jongfoster
318 * Adding missing #include "loadcfg.h"
320 * Revision 1.31 2001/07/29 12:17:48 oes
321 * Applied pthread fix by Paul Lieverse
323 * Revision 1.30 2001/07/25 22:57:13 jongfoster
324 * __BEOS__ no longer overrides FEATURE_PTHREAD.
325 * This is because FEATURE_PTHREAD will soon be widely used, so I
326 * want to keep it simple.
328 * Revision 1.29 2001/07/24 12:47:06 oes
329 * Applied BeOS support update by Eugenia
331 * Revision 1.28 2001/07/23 13:26:12 oes
332 * Fixed bug in popup-killing for the first read that caused binary garbage to be sent between headers and body
334 * Revision 1.27 2001/07/19 19:09:47 haroon
335 * - Added code to take care of the situation where while processing the first
336 * server response (which includes the server header), after finding the end
337 * of the headers we were not looking past the end of the headers for
338 * content modification. I enabled it for filter_popups.
339 * Someone else should look to see if other similar operations should be
340 * done to the discarded portion of the buffer.
342 * Note 2001/07/20: No, the other content modification mechanisms will process
343 * the whole iob later anyway. --oes
345 * Revision 1.26 2001/07/18 12:31:36 oes
348 * Revision 1.25 2001/07/15 19:43:49 jongfoster
349 * Supports POSIX threads.
350 * Also removed some unused #includes.
352 * Revision 1.24 2001/07/13 14:00:40 oes
353 * - Generic content modification scheme:
354 * Each feature has its own applicability flag that is set
355 * from csp->action->flags.
356 * Replaced the "filtering" int flag , by a function pointer
357 * "content_filter" to the function that will do the content
358 * modification. If it is != NULL, the document will be buffered
359 * and processed through *content_filter, which must set
360 * csp->content_length and return a modified copy of the body
361 * or return NULL (on failiure).
362 * - Changed csp->is_text to the more generic bitmap csp->content_type
363 * which can currently take the valued CT_TEXT or CT_GIF
365 * - Removed all #ifdef PCRS
367 * Revision 1.23 2001/07/02 02:28:25 iwanttokeepanon
368 * Added "#ifdef ACL_FILES" conditional compilation to line 1291 to exclude
369 * the `block_acl' call. This prevents a compilation error when the user
370 * does not wish to use the "ACL" feature.
372 * Revision 1.22 2001/06/29 21:45:41 oes
373 * Indentation, CRLF->LF, Tab-> Space
375 * Revision 1.21 2001/06/29 13:29:36 oes
376 * - Cleaned up, improved comments
377 * - Unified all possible interceptors (CGI,
378 * block, trust, fast_redirect) in one
379 * place, with one (CGI) answer generation
380 * mechansim. Much clearer now.
381 * - Removed the GIF image generation, which
382 * is now done in filters.c:block_url()
383 * - Made error conditions like domain lookup
384 * failiure or (various) problems while talking
385 * to the server use cgi.c:error_response()
386 * instead of generating HTML/HTTP in chat() (yuck!)
387 * - Removed logentry from cancelled commit
389 * Revision 1.20 2001/06/09 10:55:28 jongfoster
390 * Changing BUFSIZ ==> BUFFER_SIZE
392 * Revision 1.19 2001/06/07 23:12:52 jongfoster
393 * Replacing function pointer in struct gateway with a directly
394 * called function forwarded_connect().
395 * Replacing struct gateway with struct forward_spec
397 * Revision 1.18 2001/06/03 19:12:16 oes
398 * introduced new cgi handling
400 * Revision 1.17 2001/06/01 20:07:23 jongfoster
401 * Now uses action +image-blocker{} rather than config->tinygif
403 * Revision 1.16 2001/06/01 18:49:17 jongfoster
404 * Replaced "list_share" with "list" - the tiny memory gain was not
405 * worth the extra complexity.
407 * Revision 1.15 2001/05/31 21:24:47 jongfoster
408 * Changed "permission" to "action" throughout.
409 * Removed DEFAULT_USER_AGENT - it must now be specified manually.
410 * Moved vanilla wafer check into chat(), since we must now
411 * decide whether or not to add it based on the URL.
413 * Revision 1.14 2001/05/29 20:14:01 joergs
414 * AmigaOS bugfix: PCRS needs a lot of stack, stacksize for child threads
417 * Revision 1.13 2001/05/29 09:50:24 jongfoster
418 * Unified blocklist/imagelist/permissionslist.
419 * File format is still under discussion, but the internal changes
422 * Also modified interceptor behaviour:
423 * - We now intercept all URLs beginning with one of the following
424 * prefixes (and *only* these prefixes):
426 * * http://ijbswa.sf.net/config/
427 * * http://ijbswa.sourceforge.net/config/
428 * - New interceptors "home page" - go to http://i.j.b/ to see it.
429 * - Internal changes so that intercepted and fast redirect pages
430 * are not replaced with an image.
431 * - Interceptors now have the option to send a binary page direct
432 * to the client. (i.e. ijb-send-banner uses this)
433 * - Implemented show-url-info interceptor. (Which is why I needed
434 * the above interceptors changes - a typical URL is
435 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
436 * The previous mechanism would not have intercepted that, and
437 * if it had been intercepted then it then it would have replaced
440 * Revision 1.12 2001/05/27 22:17:04 oes
442 * - re_process_buffer no longer writes the modified buffer
443 * to the client, which was very ugly. It now returns the
444 * buffer, which it is then written by chat.
446 * - content_length now adjusts the Content-Length: header
447 * for modified documents rather than crunch()ing it.
448 * (Length info in csp->content_length, which is 0 for
449 * unmodified documents)
451 * - For this to work, sed() is called twice when filtering.
453 * Revision 1.11 2001/05/26 17:27:53 jongfoster
454 * Added support for CLF and fixed LOG_LEVEL_LOG.
455 * Also did CRLF->LF fix of my previous patch.
457 * Revision 1.10 2001/05/26 15:26:15 jongfoster
458 * ACL feature now provides more security by immediately dropping
459 * connections from untrusted hosts.
461 * Revision 1.9 2001/05/26 00:28:36 jongfoster
462 * Automatic reloading of config file.
463 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
464 * Most of the global variables have been moved to a new
465 * struct configuration_spec, accessed through csp->config->globalname
466 * Most of the globals remaining are used by the Win32 GUI.
468 * Revision 1.8 2001/05/25 22:43:18 jongfoster
469 * Fixing minor memory leak and buffer overflow.
471 * Revision 1.7 2001/05/25 22:34:30 jongfoster
474 * Revision 1.6 2001/05/23 00:13:58 joergs
475 * AmigaOS support fixed.
477 * Revision 1.5 2001/05/22 18:46:04 oes
479 * - Enabled filtering banners by size rather than URL
480 * by adding patterns that replace all standard banner
481 * sizes with the "Junkbuster" gif to the re_filterfile
483 * - Enabled filtering WebBugs by providing a pattern
484 * which kills all 1x1 images
486 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
487 * which is selected by the (nonstandard and therefore
488 * capital) letter 'U' in the option string.
489 * It causes the quantifiers to be ungreedy by default.
490 * Appending a ? turns back to greedy (!).
492 * - Added a new interceptor ijb-send-banner, which
493 * sends back the "Junkbuster" gif. Without imagelist or
494 * MSIE detection support, or if tinygif = 1, or the
495 * URL isn't recognized as an imageurl, a lame HTML
496 * explanation is sent instead.
498 * - Added new feature, which permits blocking remote
499 * script redirects and firing back a local redirect
501 * The feature is conditionally compiled, i.e. it
502 * can be disabled with --disable-fast-redirects,
503 * plus it must be activated by a "fast-redirects"
504 * line in the config file, has its own log level
505 * and of course wants to be displayed by show-proxy-args
506 * Note: Boy, all the #ifdefs in 1001 locations and
507 * all the fumbling with configure.in and acconfig.h
508 * were *way* more work than the feature itself :-(
510 * - Because a generic redirect template was needed for
511 * this, tinygif = 3 now uses the same.
513 * - Moved GIFs, and other static HTTP response templates
518 * - Removed some >400 CRs again (Jon, you really worked
521 * Revision 1.4 2001/05/21 19:34:01 jongfoster
522 * Made failure to bind() a fatal error.
524 * Revision 1.3 2001/05/20 01:21:20 jongfoster
525 * Version 2.9.4 checkin.
526 * - Merged popupfile and cookiefile, and added control over PCRS
527 * filtering, in new "permissionsfile".
528 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
529 * file error you now get a message box (in the Win32 GUI) rather
530 * than the program exiting with no explanation.
531 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
533 * - Removed tabs from "config"
534 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
535 * - Bumped up version number.
537 * Revision 1.2 2001/05/17 22:34:44 oes
538 * - Added hint on GIF char array generation to jcc.c
539 * - Cleaned CRLF's from the sources and related files
540 * - Repaired logging for REF and FRC
542 * Revision 1.1.1.1 2001/05/15 13:58:56 oes
543 * Initial import of version 2.9.3 source tree
546 *********************************************************************/
552 #include <sys/types.h>
559 #ifdef FEATURE_PTHREAD
561 #endif /* def FEATURE_PTHREAD */
564 # ifndef FEATURE_PTHREAD
568 # include <windows.h>
569 # include <process.h>
570 # endif /* ndef FEATURE_PTHREAD */
573 # ifndef _WIN_CONSOLE
575 # endif /* ndef _WIN_CONSOLE */
577 #else /* ifndef _WIN32 */
579 # if !defined (__OS2__)
581 # include <sys/wait.h>
582 # endif /* ndef __OS2__ */
583 # include <sys/time.h>
584 # include <sys/stat.h>
585 # include <sys/ioctl.h>
588 #include <sys/termios.h>
599 # include <socket.h> /* BeOS has select() for sockets only. */
600 # include <OS.h> /* declarations for threads and stuff. */
603 # if defined(__EMX__) || defined(__OS2__)
604 # include <sys/select.h> /* OS/2/EMX needs a little help with select */
609 #define bzero(B,N) memset(B,0x00,n)
624 #include "killpopup.h"
625 #include "miscutil.h"
627 #include "jbsockets.h"
632 #include "urlmatch.h"
634 const char jcc_h_rcs[] = JCC_H_VERSION;
635 const char project_h_rcs[] = PROJECT_H_VERSION;
638 struct client_state clients[1];
639 struct file_list files[1];
641 #ifdef FEATURE_STATISTICS
642 int urls_read = 0; /* total nr of urls read inc rejected */
643 int urls_rejected = 0; /* total nr of urls rejected */
644 #endif /* def FEATURE_STATISTICS */
646 #ifdef FEATURE_GRACEFUL_TERMINATION
650 static void listen_loop(void);
651 static void chat(struct client_state *csp);
653 void serve(struct client_state *csp);
654 #else /* ifndef AMIGA */
655 static void serve(struct client_state *csp);
656 #endif /* def AMIGA */
659 static int32 server_thread(void *data);
660 #endif /* def __BEOS__ */
663 #define sleep(N) Sleep(((N) * 1000))
667 #define sleep(N) DosSleep(((N) * 100))
670 #if defined(unix) || defined(__EMX__)
672 const char *pidfile = NULL;
673 int received_hup_signal = 0;
674 #endif /* defined unix */
676 /* The vanilla wafer. */
677 static const char VANILLA_WAFER[] =
678 "NOTICE=TO_WHOM_IT_MAY_CONCERN_"
679 "Do_not_send_me_any_copyrighted_information_other_than_the_"
680 "document_that_I_am_requesting_or_any_of_its_necessary_components._"
681 "In_particular_do_not_send_me_any_cookies_that_"
682 "are_subject_to_a_claim_of_copyright_by_anybody._"
683 "Take_notice_that_I_refuse_to_be_bound_by_any_license_condition_"
684 "(copyright_or_otherwise)_applying_to_any_cookie._";
687 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
688 /*********************************************************************
690 * Function : sig_handler
692 * Description : Signal handler for different signals.
693 * Exit gracefully on ABRT, TERM and INT
694 * or set a flag that will cause the errlog
695 * to be reopened by the main thread on HUP.
698 * 1 : the_signal = the signal cause this function to call
702 *********************************************************************/
703 static void sig_handler(int the_signal)
710 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
718 received_hup_signal = 1;
723 * We shouldn't be here, unless we catch signals
724 * in main() that we can't handle here!
726 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
734 /*********************************************************************
738 * Description : Once a connection to the client has been accepted,
739 * this function is called (via serve()) to handle the
740 * main business of the communication. When this
741 * function returns, the caller must close the client
745 * 1 : csp = Current client state (buffers, headers, etc...)
747 * Returns : On success, the number of bytes written are returned (zero
748 * indicates nothing was written). On error, -1 is returned,
749 * and errno is set appropriately. If count is zero and the
750 * file descriptor refers to a regular file, 0 will be
751 * returned without causing any other effect. For a special
752 * file, the results are not portable.
754 *********************************************************************/
755 static void chat(struct client_state *csp)
758 * This next lines are a little ugly, but they simplifies the if statements
759 * below. Basically if TOGGLE, then we want the if to test if the
760 * CSP_FLAG_TOGGLED_ON flag ist set, else we don't. And if FEATURE_FORCE_LOAD,
761 * then we want the if to test for CSP_FLAG_FORCED , else we don't
763 #ifdef FEATURE_TOGGLE
764 # define IS_TOGGLED_ON_AND (csp->flags & CSP_FLAG_TOGGLED_ON) &&
765 #else /* ifndef FEATURE_TOGGLE */
766 # define IS_TOGGLED_ON_AND
767 #endif /* ndef FEATURE_TOGGLE */
768 #ifdef FEATURE_FORCE_LOAD
769 # define IS_NOT_FORCED_AND !(csp->flags & CSP_FLAG_FORCED) &&
770 #else /* ifndef FEATURE_FORCE_LOAD */
771 # define IS_NOT_FORCED_AND
772 #endif /* def FEATURE_FORCE_LOAD */
774 #define IS_ENABLED_AND IS_TOGGLED_ON_AND IS_NOT_FORCED_AND
776 char buf[BUFFER_SIZE];
784 int ms_iis5_hack = 0;
786 const struct forward_spec * fwd;
787 struct http_request *http;
788 int len; /* for buffer sizes */
789 #ifdef FEATURE_KILL_POPUPS
790 int block_popups; /* bool, 1==will block popups */
791 int block_popups_now = 0; /* bool, 1==currently blocking popups */
792 #endif /* def FEATURE_KILL_POPUPS */
794 int pcrs_filter; /* bool, 1==will filter through pcrs */
795 int gif_deanimate; /* bool, 1==will deanimate gifs */
797 /* Function that does the content filtering for the current request */
798 char *(*content_filter)() = NULL;
800 /* Skeleton for HTTP response, if we should intercept the request */
801 struct http_response *rsp;
806 * Read the client's request. Note that since we're not using select() we
807 * could get blocked here if a client connected, then didn't say anything!
812 len = read_socket(csp->cfd, buf, sizeof(buf));
814 if (len <= 0) break; /* error! */
817 * If there is no memory left for buffering the
818 * request, there is nothing we can do but hang up
820 if (add_to_iob(csp, buf, len))
825 req = get_header(csp);
829 break; /* no HTTP request! */
834 continue; /* more to come! */
837 #ifdef FEATURE_FORCE_LOAD
838 /* If this request contains the FORCE_PREFIX,
839 * better get rid of it now and set the force flag --oes
842 if (strstr(req, FORCE_PREFIX))
844 strclean(req, FORCE_PREFIX);
845 log_error(LOG_LEVEL_FORCE, "Enforcing request \"%s\".\n", req);
846 csp->flags |= CSP_FLAG_FORCED;
849 #endif /* def FEATURE_FORCE_LOAD */
851 parse_http_request(req, http, csp);
856 if (http->cmd == NULL)
858 strcpy(buf, CHEADER);
859 write_socket(csp->cfd, buf, strlen(buf));
861 log_error(LOG_LEVEL_CLF, "%s - - [%T] \" \" 400 0", csp->ip_addr_str);
863 free_http_request(http);
867 /* decide how to route the HTTP request */
869 if ((fwd = forward_url(http, csp)) == NULL)
871 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!? This can't happen!");
872 /* Never get here - LOG_LEVEL_FATAL causes program exit */
875 /* build the http request to send to the server
876 * we have to do one of the following:
878 * create = use the original HTTP request to create a new
879 * HTTP request that has either the path component
880 * without the http://domainspec (w/path) or the
881 * full orininal URL (w/url)
882 * Note that the path and/or the HTTP version may
883 * have been altered by now.
885 * connect = Open a socket to the host:port of the server
886 * and short-circuit server and client socket.
888 * pass = Pass the request unchanged if forwarding a CONNECT
889 * request to a parent proxy. Note that we'll be sending
890 * the CFAIL message ourselves if connecting to the parent
891 * fails, but we won't send a CSUCCEED message if it works,
892 * since that would result in a double message (ours and the
893 * parent's). After sending the request to the parent, we simply
899 * +--------+--------+
901 * 0 | create | connect|
903 * Forwarding +--------+--------+
905 * 1 | create | pass |
907 * +--------+--------+
912 * Determine the actions for this URL
914 #ifdef FEATURE_TOGGLE
915 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
917 /* Most compatible set of actions (i.e. none) */
918 init_current_action(csp->action);
921 #endif /* ndef FEATURE_TOGGLE */
923 url_actions(http, csp);
928 * Check if a CONNECT request is allowable:
929 * In the absence of a +limit-connect action, allow only port 443.
930 * If there is an action, allow whatever matches the specificaton.
934 if( ( !(csp->action->flags & ACTION_LIMIT_CONNECT) && csp->http->port != 443)
935 || (csp->action->flags & ACTION_LIMIT_CONNECT
936 && !match_portlist(csp->action->string[ACTION_STRING_LIMIT_CONNECT], csp->http->port)) )
938 strcpy(buf, CFORBIDDEN);
939 write_socket(csp->cfd, buf, strlen(buf));
941 log_error(LOG_LEVEL_CONNECT, "Denying suspicious CONNECT request from %s", csp->ip_addr_str);
942 log_error(LOG_LEVEL_CLF, "%s - - [%T] \" \" 403 0", csp->ip_addr_str);
950 * Downgrade http version from 1.1 to 1.0 if +downgrade
953 if ( (http->ssl == 0)
954 && (!strcmpic(http->ver, "HTTP/1.1"))
955 && (csp->action->flags & ACTION_DOWNGRADE))
958 http->ver = strdup("HTTP/1.0");
960 if (http->ver == NULL)
962 log_error(LOG_LEVEL_FATAL, "Out of memory downgrading HTTP version");
967 * Save a copy of the original request for logging
969 http->ocmd = strdup(http->cmd);
971 if (http->ocmd == NULL)
973 log_error(LOG_LEVEL_FATAL, "Out of memory copying HTTP request line");
977 * (Re)build the HTTP request for non-SSL requests.
978 * If forwarding, use the whole URL, else, use only the path.
984 http->cmd = strdup(http->gpc);
985 string_append(&http->cmd, " ");
987 if (fwd->forward_host)
989 string_append(&http->cmd, http->url);
993 string_append(&http->cmd, http->path);
995 string_append(&http->cmd, " ");
996 string_append(&http->cmd, http->ver);
998 if (http->cmd == NULL)
1000 log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
1002 log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", http->cmd);
1004 enlist(csp->headers, http->cmd);
1008 * If the user has not supplied any wafers, and the user has not
1009 * told us to suppress the vanilla wafer, then send the vanilla wafer.
1011 if (list_is_empty(csp->action->multi[ACTION_MULTI_WAFER])
1012 && ((csp->action->flags & ACTION_VANILLA_WAFER) != 0))
1014 enlist(csp->action->multi[ACTION_MULTI_WAFER], VANILLA_WAFER);
1018 #ifdef FEATURE_KILL_POPUPS
1019 block_popups = ((csp->action->flags & ACTION_NO_POPUPS) != 0);
1020 #endif /* def FEATURE_KILL_POPUPS */
1022 pcrs_filter = (csp->rlist != NULL) && /* There are expressions to be used */
1023 (!list_is_empty(csp->action->multi[ACTION_MULTI_FILTER]));
1025 gif_deanimate = ((csp->action->flags & ACTION_DEANIMATE) != 0);
1027 /* grab the rest of the client's headers */
1031 if ( ( ( p = get_header(csp) ) != NULL) && ( *p == '\0' ) )
1033 len = read_socket(csp->cfd, buf, sizeof(buf));
1036 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1041 * If there is no memory left for buffering the
1042 * request, there is nothing we can do but hang up
1044 if (add_to_iob(csp, buf, len))
1051 if (p == NULL) break;
1053 enlist(csp->headers, p);
1058 * We have a request. Now, check to see if we need to
1059 * intercept it, i.e. If ..
1063 /* We may not forward the request by rfc2616 sect 14.31 */
1064 (NULL != (rsp = direct_response(csp)))
1066 /* or a CGI call was detected and answered */
1067 || (NULL != (rsp = dispatch_cgi(csp)))
1069 /* or we are enabled and... */
1070 || (IS_ENABLED_AND (
1072 /* ..the request was blocked */
1073 ( NULL != (rsp = block_url(csp)))
1075 /* ..or untrusted */
1076 #ifdef FEATURE_TRUST
1077 || ( NULL != (rsp = trust_url(csp)))
1078 #endif /* def FEATURE_TRUST */
1080 /* ..or a fast redirect kicked in */
1081 #ifdef FEATURE_FAST_REDIRECTS
1082 || (((csp->action->flags & ACTION_FAST_REDIRECTS) != 0) &&
1083 (NULL != (rsp = redirect_url(csp))))
1084 #endif /* def FEATURE_FAST_REDIRECTS */
1088 /* Write the answer to the client */
1089 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1090 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1092 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1095 #ifdef FEATURE_STATISTICS
1096 /* Count as a rejected request */
1097 csp->flags |= CSP_FLAG_REJECTED;
1098 #endif /* def FEATURE_STATISTICS */
1100 /* Log (FIXME: All intercept reasons apprear as "crunch" with Status 200) */
1101 log_error(LOG_LEVEL_GPC, "%s%s crunch!", http->hostport, http->path);
1102 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3", csp->ip_addr_str, http->ocmd);
1104 /* Clean up and return */
1105 free_http_response(rsp);
1109 hdr = sed(client_patterns, add_client_headers, csp);
1112 /* FIXME Should handle error properly */
1113 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
1116 list_remove_all(csp->headers);
1118 log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
1120 if (fwd->forward_host)
1122 log_error(LOG_LEVEL_CONNECT, "via %s:%d to: %s",
1123 fwd->forward_host, fwd->forward_port, http->hostport);
1127 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
1130 /* here we connect to the server, gateway, or the forwarder */
1132 csp->sfd = forwarded_connect(fwd, http, csp);
1134 if (csp->sfd == JB_INVALID_SOCKET)
1136 log_error(LOG_LEVEL_CONNECT, "connect to: %s failed: %E",
1139 if (errno == EINVAL)
1141 rsp = error_response(csp, "no-such-domain", errno);
1143 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 404 0",
1144 csp->ip_addr_str, http->ocmd);
1148 rsp = error_response(csp, "connect-failed", errno);
1150 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 503 0",
1151 csp->ip_addr_str, http->ocmd);
1155 /* Write the answer to the client */
1158 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1159 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1161 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1165 free_http_response(rsp);
1170 log_error(LOG_LEVEL_CONNECT, "OK");
1172 if (fwd->forward_host || (http->ssl == 0))
1174 /* write the client's (modified) header to the server
1175 * (along with anything else that may be in the buffer)
1178 if (write_socket(csp->sfd, hdr, strlen(hdr))
1179 || (flush_socket(csp->sfd, csp) < 0))
1181 log_error(LOG_LEVEL_CONNECT, "write header to: %s failed: %E",
1184 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 503 0",
1185 csp->ip_addr_str, http->ocmd);
1187 rsp = error_response(csp, "connect-failed", errno);
1191 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1192 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1194 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1198 free_http_response(rsp);
1206 * We're running an SSL tunnel and we're not forwarding,
1207 * so just send the "connect succeeded" message to the
1208 * client, flush the rest, and get out of the way.
1210 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 2\n",
1211 csp->ip_addr_str, http->ocmd);
1213 if (write_socket(csp->cfd, CSUCCEED, sizeof(CSUCCEED)-1))
1221 /* we're finished with the client's header */
1224 maxfd = ( csp->cfd > csp->sfd ) ? csp->cfd : csp->sfd;
1226 /* pass data between the client and server
1227 * until one or the other shuts down the connection.
1236 * FD_ZERO here seems to point to an errant macro which crashes.
1237 * So do this by hand for now...
1239 memset(&rfds,0x00,sizeof(fd_set));
1243 FD_SET(csp->cfd, &rfds);
1244 FD_SET(csp->sfd, &rfds);
1246 n = select((int)maxfd+1, &rfds, NULL, NULL, NULL);
1250 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
1254 /* this is the body of the browser's request
1255 * just read it and write it.
1258 if (FD_ISSET(csp->cfd, &rfds))
1260 len = read_socket(csp->cfd, buf, sizeof(buf));
1264 break; /* "game over, man" */
1267 if (write_socket(csp->sfd, buf, (size_t)len))
1269 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1276 * The server wants to talk. It could be the header or the body.
1277 * If `hdr' is null, then it's the header otherwise it's the body.
1278 * FIXME: Does `hdr' really mean `host'? No.
1282 if (FD_ISSET(csp->sfd, &rfds))
1285 len = read_socket(csp->sfd, buf, sizeof(buf) - 1);
1289 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
1291 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 503 0",
1292 csp->ip_addr_str, http->ocmd);
1294 rsp = error_response(csp, "connect-failed", errno);
1298 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1299 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1301 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1305 free_http_response(rsp);
1309 /* Add a trailing zero. This lets filter_popups
1310 * use string operations.
1314 #ifdef FEATURE_KILL_POPUPS
1315 /* Filter the popups on this read. */
1316 if (block_popups_now)
1318 filter_popups(buf, csp);
1320 #endif /* def FEATURE_KILL_POPUPS */
1322 /* Normally, this would indicate that we've read
1323 * as much as the server has sent us and we can
1324 * close the client connection. However, Microsoft
1325 * in its wisdom has released IIS/5 with a bug that
1326 * prevents it from sending the trailing \r\n in
1327 * a 302 redirect header (and possibly other headers).
1328 * To work around this if we've haven't parsed
1329 * a full header we'll append a trailing \r\n
1330 * and see if this now generates a valid one.
1332 * This hack shouldn't have any impacts. If we've
1333 * already transmitted the header or if this is a
1334 * SSL connection, then we won't bother with this
1335 * hack. So we only work on partially received
1336 * headers. If we append a \r\n and this still
1337 * doesn't generate a valid header, then we won't
1338 * transmit anything to the client.
1343 if (server_body || http->ssl)
1346 * If we have been buffering up the document,
1347 * now is the time to apply content modification
1348 * and send the result to the client.
1353 * If the content filter fails, use the original
1354 * buffer and length.
1355 * (see p != NULL ? p : csp->iob->cur below)
1357 if (NULL == (p = (*content_filter)(csp)))
1359 csp->content_length = csp->iob->eod - csp->iob->cur;
1362 hdr = sed(server_patterns, add_server_headers, csp);
1365 /* FIXME Should handle error properly */
1366 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
1369 if (write_socket(csp->cfd, hdr, strlen(hdr))
1370 || write_socket(csp->cfd, p != NULL ? p : csp->iob->cur, csp->content_length))
1372 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
1382 break; /* "game over, man" */
1386 * This is NOT the body, so
1387 * Let's pretend the server just sent us a blank line.
1389 len = sprintf(buf, "\r\n");
1392 * Now, let the normal header parsing algorithm below do its
1393 * job. If it fails, we'll exit instead of continuing.
1400 * If this is an SSL connection or we're in the body
1401 * of the server document, just write it to the client,
1402 * unless we need to buffer the body for later content-filtering
1405 if (server_body || http->ssl)
1410 * If there is no memory left for buffering the content, or the buffer limit
1411 * has been reached, switch to non-filtering mode, i.e. make & write the
1412 * header, flush the iob and buf, and get out of the way.
1414 if (add_to_iob(csp, buf, len))
1419 log_error(LOG_LEVEL_ERROR, "Flushing header and buffers. Stepping back from filtering.");
1421 hdr = sed(server_patterns, add_server_headers, csp);
1425 * Memory is too tight to even generate the header.
1426 * Send our static "Out-of-memory" page.
1428 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
1429 rsp = cgi_error_memory();
1431 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1432 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1434 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1439 hdrlen = strlen(hdr);
1441 if (write_socket(csp->cfd, hdr, hdrlen)
1442 || ((flushed = flush_socket(csp->cfd, csp)) < 0)
1443 || (write_socket(csp->cfd, buf, len)))
1445 log_error(LOG_LEVEL_CONNECT, "Flush header and buffers to client failed: %E");
1451 byte_count += hdrlen + flushed + len;
1453 content_filter = NULL;
1460 if (write_socket(csp->cfd, buf, (size_t)len))
1462 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
1471 /* we're still looking for the end of the
1472 * server's header ... (does that make header
1473 * parsing an "out of body experience" ?
1477 * buffer up the data we just read. If that fails,
1478 * there's little we can do but send our static
1479 * out-of-memory page.
1481 if (add_to_iob(csp, buf, len))
1483 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
1484 rsp = cgi_error_memory();
1486 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1487 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1489 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1494 /* get header lines from the iob */
1496 while ((p = get_header(csp)) != NULL)
1500 /* see following note */
1503 enlist(csp->headers, p);
1507 /* NOTE: there are no "empty" headers so
1508 * if the pointer `p' is not NULL we must
1509 * assume that we reached the end of the
1510 * buffer before we hit the end of the header.
1517 /* Well, we tried our MS IIS/5
1518 * hack and it didn't work.
1519 * The header is incomplete
1520 * and there isn't anything
1521 * we can do about it.
1527 /* Since we have to wait for
1528 * more from the server before
1529 * we can parse the headers
1530 * we just continue here.
1536 /* we have now received the entire header.
1537 * filter it and send the result to the client
1540 hdr = sed(server_patterns, add_server_headers, csp);
1543 /* FIXME Should handle error properly */
1544 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
1547 #ifdef FEATURE_KILL_POPUPS
1548 /* Start blocking popups if appropriate. */
1550 if ((csp->content_type & CT_TEXT) && /* It's a text / * MIME-Type */
1551 !http->ssl && /* We talk plaintext */
1552 block_popups) /* Policy allows */
1554 block_popups_now = 1;
1556 * Filter the part of the body that came in the same read
1557 * as the last headers:
1559 filter_popups(csp->iob->cur, csp);
1562 #endif /* def FEATURE_KILL_POPUPS */
1564 /* Buffer and pcrs filter this if appropriate. */
1566 if ((csp->content_type & CT_TEXT) && /* It's a text / * MIME-Type */
1567 !http->ssl && /* We talk plaintext */
1568 pcrs_filter) /* Policy allows */
1570 content_filter = pcrs_filter_response;
1573 /* Buffer and gif_deanimate this if appropriate. */
1575 if ((csp->content_type & CT_GIF) && /* It's a image/gif MIME-Type */
1576 !http->ssl && /* We talk plaintext */
1577 gif_deanimate) /* Policy allows */
1579 content_filter = gif_deanimate_response;
1583 * Only write if we're not buffering for content modification
1585 if (!content_filter)
1587 /* write the server's (modified) header to
1588 * the client (along with anything else that
1589 * may be in the buffer)
1592 if (write_socket(csp->cfd, hdr, strlen(hdr))
1593 || ((len = flush_socket(csp->cfd, csp)) < 0))
1595 log_error(LOG_LEVEL_CONNECT, "write header to client failed: %E");
1597 /* the write failed, so don't bother
1598 * mentioning it to the client...
1599 * it probably can't hear us anyway.
1608 /* we're finished with the server's header */
1613 /* If this was a MS IIS/5 hack then it means
1614 * the server has already closed the
1615 * connection. Nothing more to read. Time
1626 return; /* huh? we should never get here */
1629 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %d",
1630 csp->ip_addr_str, http->ocmd, byte_count);
1634 /*********************************************************************
1638 * Description : This is little more than chat. We only "serve" to
1639 * to close any socket that chat may have opened.
1642 * 1 : csp = Current client state (buffers, headers, etc...)
1646 *********************************************************************/
1648 void serve(struct client_state *csp)
1649 #else /* ifndef AMIGA */
1650 static void serve(struct client_state *csp)
1651 #endif /* def AMIGA */
1654 close_socket(csp->cfd);
1656 if (csp->sfd != JB_INVALID_SOCKET)
1658 close_socket(csp->sfd);
1661 csp->flags &= ~CSP_FLAG_ACTIVE;
1667 /*********************************************************************
1669 * Function : server_thread
1671 * Description : We only exist to call `serve' in a threaded environment.
1674 * 1 : data = Current client state (buffers, headers, etc...)
1676 * Returns : Always 0.
1678 *********************************************************************/
1679 static int32 server_thread(void *data)
1681 serve((struct client_state *) data);
1688 /*********************************************************************
1692 * Description : Print usage info & exit.
1694 * Parameters : Pointer to argv[0] for identifying ourselves
1698 *********************************************************************/
1699 void usage(const char *myname)
1701 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
1702 "Usage: %s [--help] [--version] [--no-daemon] [--pidfile pidfile] [--user user[.group]] [configfile]\n"
1703 "Aborting.\n", myname);
1710 /*********************************************************************
1714 * Description : Load the config file and start the listen loop.
1715 * This function is a lot more *sane* with the `load_config'
1716 * and `listen_loop' functions; although it stills does
1717 * a *little* too much for my taste.
1720 * 1 : argc = Number of parameters (including $0).
1721 * 2 : argv = Array of (char *)'s to the parameters.
1723 * Returns : 1 if : can't open config file, unrecognized directive,
1724 * stats requested in multi-thread mode, can't open the
1725 * log file, can't open the jar file, listen port is invalid,
1726 * any load fails, and can't bind port.
1728 * Else main never returns, the process must be signaled
1729 * to terminate execution. Or, on Windows, use the
1730 * "File", "Exit" menu option.
1732 *********************************************************************/
1734 int real_main(int argc, const char *argv[])
1736 int main(int argc, const char *argv[])
1741 struct passwd *pw = NULL;
1742 struct group *grp = NULL;
1750 #if !defined(_WIN32)
1758 * Parse the command line arguments
1760 while (++argc_pos < argc)
1762 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
1764 if (strcmp(argv[argc_pos], "--help") == 0)
1769 else if(strcmp(argv[argc_pos], "--version") == 0)
1771 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
1775 else if (strcmp(argv[argc_pos], "--no-daemon" ) == 0)
1780 else if (strcmp(argv[argc_pos], "--pidfile" ) == 0)
1782 if (++argc_pos == argc) usage(argv[0]);
1783 pidfile = strdup(argv[argc_pos]);
1786 else if (strcmp(argv[argc_pos], "--user" ) == 0)
1788 if (++argc_pos == argc) usage(argv[argc_pos]);
1790 if ((NULL != (p = strchr(argv[argc_pos], '.'))) && *(p + 1) != '0')
1793 if (NULL == (grp = getgrnam(p)))
1795 log_error(LOG_LEVEL_FATAL, "Group %s not found.", p);
1799 if (NULL == (pw = getpwnam(argv[argc_pos])))
1801 log_error(LOG_LEVEL_FATAL, "User %s not found.", argv[argc_pos]);
1804 if (p != NULL) *--p = '\0';
1806 #endif /* defined(unix) */
1808 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
1810 configfile = argv[argc_pos];
1813 } /* -END- while (more arguments) */
1816 if ( *configfile != '/' )
1820 /* make config-filename absolute here */
1821 if ( !(basedir = getcwd( NULL, 1024 )))
1823 perror("get working dir failed");
1827 if ( !(abs_file = malloc( strlen( basedir ) + strlen( configfile ) + 5 )))
1829 perror("malloc failed");
1832 strcpy( abs_file, basedir );
1833 strcat( abs_file, "/" );
1834 strcat( abs_file, configfile );
1835 configfile = abs_file;
1837 #endif /* defined unix */
1841 clients->next = NULL;
1845 #elif defined(_WIN32)
1850 * Unix signal handling
1852 * Catch the abort, interrupt and terminate signals for a graceful exit
1853 * Catch the hangup signal so the errlog can be reopened.
1854 * Ignore the broken pipe and child signals
1855 * FIXME: Isn't ignoring the default for SIGCHLD anyway and why ignore SIGPIPE?
1857 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
1860 const int catched_signals[] = { SIGABRT, SIGTERM, SIGINT, SIGHUP, 0 };
1861 const int ignored_signals[] = { SIGPIPE, SIGCHLD, 0 };
1863 for (idx = 0; catched_signals[idx] != 0; idx++)
1865 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
1867 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
1871 for (idx = 0; ignored_signals[idx] != 0; idx++)
1873 if (signal(ignored_signals[idx], SIG_IGN) == SIG_ERR)
1875 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for signal %d: %E", ignored_signals[idx]);
1880 #else /* ifdef _WIN32 */
1881 # ifdef _WIN_CONSOLE
1883 * We *are* in a windows console app.
1884 * Print a verbose messages about FAQ's and such
1886 printf(win32_blurb);
1887 # endif /* def _WIN_CONSOLE */
1888 #endif /* def _WIN32 */
1891 /* Initialize the CGI subsystem */
1892 cgi_init_error_messages();
1895 * If runnig on unix and without the --nodaemon
1896 * option, become a daemon. I.e. fork, detach
1897 * from tty and get process group leadership
1910 if ( pid < 0 ) /* error */
1915 else if ( pid != 0 ) /* parent */
1920 * must check for errors
1921 * child died due to missing files aso
1924 wpid = waitpid( pid, &status, WNOHANG );
1933 /* Should be more portable, but not as well tested */
1938 #else /* ndef __FreeBSD__ */
1940 #endif /* ndef __FreeBSD__ */
1941 fd = open("/dev/tty", O_RDONLY);
1944 /* no error check here */
1945 ioctl( fd, TIOCNOTTY,0 );
1949 /* FIXME: should close stderr (fd 2) here too, but the test
1951 * and load config file is done in listen_loop() and puts
1952 * some messages on stderr there.
1959 } /* -END- if (!no_daemon) */
1962 * As soon as we have written the PID file, we can switch
1963 * to the user and group ID indicated by the --user option
1969 if (((NULL != grp) && setgid(grp->gr_gid)) || (setgid(pw->pw_gid)))
1971 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
1973 if (setuid(pw->pw_uid))
1975 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
1979 #endif /* defined unix */
1989 /*********************************************************************
1991 * Function : bind_port_helper
1993 * Description : Bind the listen port. Handles logging, and aborts
1997 * 1 : config = Privoxy configuration. Specifies port
2000 * Returns : Port that was opened.
2002 *********************************************************************/
2003 static jb_socket bind_port_helper(struct configuration_spec * config)
2008 if ( (config->haddr != NULL)
2009 && (config->haddr[0] == '1')
2010 && (config->haddr[1] == '2')
2011 && (config->haddr[2] == '7')
2012 && (config->haddr[3] == '.') )
2014 log_error(LOG_LEVEL_INFO, "Listening on port %d for local connections only",
2017 else if (config->haddr == NULL)
2019 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
2024 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
2025 config->hport, config->haddr);
2028 result = bind_port(config->haddr, config->hport, &bfd);
2035 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
2036 "There may be another Privoxy or some other "
2037 "proxy running on port %d",
2038 (NULL != config->haddr) ? config->haddr : "INADDR_ANY",
2039 config->hport, config->hport);
2042 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
2043 "The hostname is not resolvable",
2044 (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
2047 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: because %E",
2048 (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
2051 /* shouldn't get here */
2052 return JB_INVALID_SOCKET;
2055 config->need_bind = 0;
2061 /*********************************************************************
2063 * Function : listen_loop
2065 * Description : bind the listen port and enter a "FOREVER" listening loop.
2071 *********************************************************************/
2072 static void listen_loop(void)
2074 struct client_state *csp = NULL;
2076 struct configuration_spec * config;
2078 config = load_config();
2080 bfd = bind_port_helper(config);
2082 #ifdef FEATURE_GRACEFUL_TERMINATION
2083 while (!g_terminate)
2088 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
2089 while (waitpid(-1, NULL, WNOHANG) > 0)
2091 /* zombie children */
2093 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
2096 * Free data that was used by died threads
2102 * Re-open the errlog after HUP signal
2104 if (received_hup_signal)
2106 init_error_log(Argv[0], config->logfile, config->debug);
2107 received_hup_signal = 0;
2112 #ifdef FEATURE_COOKIE_JAR
2114 * Need a workaround here: we have to fclose() the jarfile, or we die because it's
2115 * already open. I think unload_configfile() is not being run, which should do
2116 * this work. Until that can get resolved, we'll use this workaround.
2120 if (csp->config->jar)
2122 fclose(csp->config->jar);
2123 csp->config->jar = NULL;
2125 #endif /* FEATURE_COOKIE_JAR */
2126 #endif /* __OS2__ */
2128 if ( NULL == (csp = (struct client_state *) zalloc(sizeof(*csp))) )
2130 log_error(LOG_LEVEL_FATAL, "malloc(%d) for csp failed: %E", sizeof(*csp));
2134 csp->flags |= CSP_FLAG_ACTIVE;
2135 csp->sfd = JB_INVALID_SOCKET;
2137 csp->config = config = load_config();
2139 if ( config->need_bind )
2142 * Since we were listening to the "old port", we will not see
2143 * a "listen" param change until the next IJB request. So, at
2144 * least 1 more request must be made for us to find the new
2145 * setting. I am simply closing the old socket and binding the
2148 * Which-ever is correct, we will serve 1 more page via the
2149 * old settings. This should probably be a "show-proxy-args"
2150 * request. This should not be a so common of an operation
2151 * that this will hurt people's feelings.
2156 bfd = bind_port_helper(config);
2159 log_error(LOG_LEVEL_CONNECT, "accept connection ... ");
2161 if (!accept_connection(csp, bfd))
2163 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
2176 log_error(LOG_LEVEL_CONNECT, "OK");
2179 #ifdef FEATURE_TOGGLE
2182 csp->flags |= CSP_FLAG_TOGGLED_ON;
2184 #endif /* def FEATURE_TOGGLE */
2186 if (run_loader(csp))
2188 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
2189 /* Never get here - LOG_LEVEL_FATAL causes program exit */
2193 if (block_acl(NULL,csp))
2195 log_error(LOG_LEVEL_CONNECT, "Connection dropped due to ACL");
2196 close_socket(csp->cfd);
2200 #endif /* def FEATURE_ACL */
2202 /* add it to the list of clients */
2203 csp->next = clients->next;
2204 clients->next = csp;
2206 if (config->multi_threaded)
2210 /* this is a switch () statment in the C preprocessor - ugh */
2211 #undef SELECTED_ONE_OPTION
2213 /* Use Pthreads in preference to native code */
2214 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
2215 #define SELECTED_ONE_OPTION
2217 pthread_t the_thread;
2218 pthread_attr_t attrs;
2220 pthread_attr_init(&attrs);
2221 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
2222 child_id = (pthread_create(&the_thread, &attrs,
2223 (void*)serve, csp) ? -1 : 0);
2224 pthread_attr_destroy(&attrs);
2228 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
2229 #define SELECTED_ONE_OPTION
2230 child_id = _beginthread(
2231 (void (*)(void *))serve,
2236 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
2237 #define SELECTED_ONE_OPTION
2238 child_id = _beginthread(
2239 (void(* _Optlink)(void*))serve,
2245 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
2246 #define SELECTED_ONE_OPTION
2248 thread_id tid = spawn_thread
2249 (server_thread, "server", B_NORMAL_PRIORITY, csp);
2251 if ((tid >= 0) && (resume_thread(tid) == B_OK))
2253 child_id = (int) tid;
2262 #if defined(AMIGA) && !defined(SELECTED_ONE_OPTION)
2263 #define SELECTED_ONE_OPTION
2264 csp->cfd = ReleaseSocket(csp->cfd, -1);
2265 if((child_id = (int)CreateNewProcTags(
2266 NP_Entry, (ULONG)server_thread,
2267 NP_Output, Output(),
2268 NP_CloseOutput, FALSE,
2269 NP_Name, (ULONG)"privoxy child",
2270 NP_StackSize, 200*1024,
2274 ((struct Task *)child_id)->tc_UserData = csp;
2275 Signal((struct Task *)child_id, SIGF_SINGLE);
2280 #if !defined(SELECTED_ONE_OPTION)
2283 /* This block is only needed when using fork().
2284 * When using threads, the server thread was
2285 * created and run by the call to _beginthread().
2287 if (child_id == 0) /* child */
2293 else if (child_id > 0) /* parent */
2295 /* in a fork()'d environment, the parent's
2296 * copy of the client socket and the CSP
2300 #if !defined(_WIN32) && defined(__CYGWIN__)
2302 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
2303 close_socket(csp->cfd);
2304 csp->flags &= ~CSP_FLAG_ACTIVE;
2308 #undef SELECTED_ONE_OPTION
2309 /* end of cpp switch () */
2311 if (child_id < 0) /* failed */
2313 char buf[BUFFER_SIZE];
2315 log_error(LOG_LEVEL_ERROR, "can't fork: %E");
2317 sprintf(buf , "Privoxy: can't fork: errno = %d", errno);
2319 write_socket(csp->cfd, buf, strlen(buf));
2320 close_socket(csp->cfd);
2321 csp->flags &= ~CSP_FLAG_ACTIVE;
2332 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
2334 /* Clean up. Aim: free all memory (no leaks) */
2335 #ifdef FEATURE_GRACEFUL_TERMINATION
2337 log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
2339 unload_current_config_file();
2340 unload_current_actions_file();
2341 unload_current_re_filterfile();
2342 #ifdef FEATURE_TRUST
2343 unload_current_trust_file();
2346 if (config->multi_threaded)
2353 } while ((clients->next != NULL) && (--i > 0));
2357 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
2366 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
2367 /* Cleanup - remove taskbar icon etc. */
2372 #endif /* FEATURE_GRACEFUL_TERMINATION */