1 const char jcc_rcs[] = "$Id: jcc.c,v 1.92 2002/05/08 16:00:46 oes Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/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 2002/05/08 16:00:46 oes
37 * Chat's buffer handling:
38 * - Fixed bug with unchecked out-of-mem conditions
39 * while reading client request & server headers
40 * - No longer predict if the buffer limit will be exceeded
41 * in the next read -- check add_to_iob's new
42 * return code. If buffer couldn't be extended
43 * (policy or out-of-mem) while
44 * - reading from client: abort
45 * - reading server headers: send error page
46 * - buffering server body for filter: flush,
47 * and if that fails: send error page
49 * Revision 1.91 2002/04/08 20:35:58 swa
52 * Revision 1.90 2002/04/02 14:57:28 oes
53 * Made sending wafers independent of FEATURE_COOKIE_JAR
55 * Revision 1.89 2002/03/31 17:18:59 jongfoster
56 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
58 * Revision 1.88 2002/03/27 14:32:43 david__schmidt
59 * More compiler warning message maintenance
61 * Revision 1.87 2002/03/26 22:29:54 swa
62 * we have a new homepage!
64 * Revision 1.86 2002/03/25 17:04:55 david__schmidt
65 * Workaround for closing the jarfile before load_config() comes around again
67 * Revision 1.85 2002/03/24 15:23:33 jongfoster
70 * Revision 1.84 2002/03/24 13:25:43 swa
71 * name change related issues
73 * Revision 1.83 2002/03/16 23:54:06 jongfoster
74 * Adding graceful termination feature, to help look for memory leaks.
75 * If you enable this (which, by design, has to be done by hand
76 * editing config.h) and then go to http://i.j.b/die, then the program
77 * will exit cleanly after the *next* request. It should free all the
78 * memory that was used.
80 * Revision 1.82 2002/03/13 00:27:05 jongfoster
83 * Revision 1.81 2002/03/12 01:42:50 oes
84 * Introduced modular filters
86 * Revision 1.80 2002/03/11 22:07:05 david__schmidt
87 * OS/2 port maintenance:
88 * - Fixed EMX build - it had decayed a little
89 * - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
90 * substituted a memset for now.
92 * Revision 1.79 2002/03/09 20:03:52 jongfoster
93 * - Making various functions return int rather than size_t.
94 * (Undoing a recent change). Since size_t is unsigned on
95 * Windows, functions like read_socket that return -1 on
96 * error cannot return a size_t.
98 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
99 * crashes, and also frequently caused JB to jump to 100%
100 * CPU and stay there. (Because it thought it had just
101 * read ((unsigned)-1) == 4Gb of data...)
103 * - The signature of write_socket has changed, it now simply
104 * returns success=0/failure=nonzero.
106 * - Trying to get rid of a few warnings --with-debug on
107 * Windows, I've introduced a new type "jb_socket". This is
108 * used for the socket file descriptors. On Windows, this
109 * is SOCKET (a typedef for unsigned). Everywhere else, it's
110 * an int. The error value can't be -1 any more, so it's
111 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
112 * Windows it maps to the #define INVALID_SOCKET.)
114 * - The signature of bind_port has changed.
116 * Revision 1.78 2002/03/08 21:35:04 oes
117 * Added optional group supplement to --user option. Will now use default group of user if no group given
119 * Revision 1.77 2002/03/07 03:52:06 oes
120 * - Fixed compiler warnings etc
121 * - Improved handling of failed DNS lookups
123 * Revision 1.76 2002/03/06 22:54:35 jongfoster
124 * Automated function-comment nitpicking.
126 * Revision 1.75 2002/03/06 10:02:19 oes
127 * Fixed stupid bug when --user was not given
129 * Revision 1.74 2002/03/06 00:49:31 jongfoster
130 * Fixing warning on Windows
131 * Making #ifdefs that refer to the same variable consistently
132 * use #ifdef unix rather than mixing #ifdef unix & #ifndef OS2
134 * Revision 1.73 2002/03/05 23:57:30 hal9
135 * Stray character 's' on line 1618 was breaking build.
137 * Revision 1.72 2002/03/05 21:33:45 david__schmidt
138 * - Re-enable OS/2 building after new parms were added
139 * - Fix false out of memory report when resolving CGI templates when no IP
140 * address is available of failed attempt (a la no such domain)
142 * Revision 1.71 2002/03/05 18:13:56 oes
143 * Added --user option
145 * Revision 1.70 2002/03/05 04:52:42 oes
146 * Deleted non-errlog debugging code
148 * Revision 1.69 2002/03/04 23:50:00 jongfoster
149 * Splitting off bind_port() call into bind_port_helper(), with
152 * Revision 1.68 2002/03/04 20:17:32 oes
155 * Revision 1.67 2002/03/04 18:18:57 oes
156 * - Removed _DEBUG mode
157 * - Cleand up cmdline parsing
158 * - Introduced --no-daemon, --pidfile options
159 * - Cleaned up signal handling:
160 * - Terminate cleanly on INT, TERM and ABRT
161 * - Schedule logfile for re-opening on HUP
162 * - Ignore CHLD and PIPE
163 * - Leave the rest with their default handlers
164 * - Uniform handler registration
165 * - Added usage() function
166 * - Played styleguide police
168 * Revision 1.66 2002/03/03 15:06:55 oes
169 * Re-enabled automatic config reloading
171 * Revision 1.65 2002/03/03 14:49:11 oes
172 * Fixed CLF logging: Now uses client's original HTTP request
174 * Revision 1.64 2002/03/03 09:18:03 joergs
175 * Made jumbjuster work on AmigaOS again.
177 * Revision 1.63 2002/03/02 04:14:50 david__schmidt
178 * Clean up a little CRLF unpleasantness that suddenly appeared
180 * Revision 1.62 2002/02/20 23:17:23 jongfoster
181 * Detecting some out-of memory conditions and exiting with a log message.
183 * Revision 1.61 2002/01/17 21:01:52 jongfoster
184 * Moving all our URL and URL pattern parsing code to urlmatch.c.
186 * Revision 1.60 2001/12/30 14:07:32 steudten
187 * - Add signal handling (unix)
188 * - Add SIGHUP handler (unix)
189 * - Add creation of pidfile (unix)
190 * - Add action 'top' in rc file (RH)
191 * - Add entry 'SIGNALS' to manpage
192 * - Add exit message to logfile (unix)
194 * Revision 1.59 2001/12/13 14:07:18 oes
195 * Fixed Bug: 503 error page now sent OK
197 * Revision 1.58 2001/11/30 23:37:24 jongfoster
198 * Renaming the Win32 config file to config.txt - this is almost the
199 * same as the corresponding UNIX name "config"
201 * Revision 1.57 2001/11/16 00:47:43 jongfoster
202 * Changing the tty-disconnection code to use setsid().
204 * Revision 1.56 2001/11/13 20:20:54 jongfoster
205 * Tabs->spaces, fixing a bug with missing {} around an if()
207 * Revision 1.55 2001/11/13 20:14:53 jongfoster
208 * Patch for FreeBSD setpgrp() as suggested by Alexander Lazic
210 * Revision 1.54 2001/11/07 00:03:14 steudten
211 * Give reliable return value if an error
212 * occurs not just 0 with new daemon mode.
214 * Revision 1.53 2001/11/05 21:41:43 steudten
215 * Add changes to be a real daemon just for unix os.
216 * (change cwd to /, detach from controlling tty, set
217 * process group and session leader to the own process.
219 * Add some fatal-error log message for failed malloc().
220 * Add '-d' if compiled with 'configure --with-debug' to
221 * enable debug output.
223 * Revision 1.52 2001/10/26 20:11:20 jongfoster
224 * Fixing type mismatch
226 * Revision 1.51 2001/10/26 17:38:28 oes
229 * Revision 1.50 2001/10/25 03:40:48 david__schmidt
230 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
231 * threads to call select() simultaneously. So, it's time to do a real, live,
232 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
233 * (native). Both versions will work, but using __OS2__ offers multi-threading.
235 * Revision 1.49 2001/10/23 21:41:35 jongfoster
236 * Added call to initialize the (statically-allocated of course)
237 * "out of memory" CGI response.
239 * Revision 1.48 2001/10/10 19:56:46 jongfoster
240 * Moving some code that wasn't cookie-related out of an #ifdef
243 * Revision 1.47 2001/10/10 16:44:36 oes
244 * Added CONNECT destination port limitation check
246 * Revision 1.46 2001/10/08 15:17:41 oes
247 * Re-enabled SSL forwarding
249 * Revision 1.45 2001/10/07 15:42:11 oes
250 * Replaced 6 boolean members of csp with one bitmap (csp->flags)
252 * Moved downgrading of the HTTP version from parse_http_request to
253 * chat(), since we can't decide if it is necessary before we have
254 * determined the actions for the URL. The HTTP command is now
255 * *always* re-built so the repairs need no longer be special-cased.
257 * filter_popups now gets a csp pointer so it can raise the new
258 * CSP_FLAG_MODIFIED flag.
262 * Added configurable size limit for the IOB. If the IOB grows so
263 * large that the next read would exceed the limit, the header
264 * is generated, and the header & unfiltered buffer are flushed
265 * to the client. Chat then continues in non-buffering,
266 * non-filtering body mode.
268 * Revision 1.44 2001/10/02 18:13:57 oes
271 * Revision 1.43 2001/10/02 15:32:13 oes
272 * Moved generation of hdr
274 * Revision 1.42 2001/09/21 23:02:02 david__schmidt
275 * Cleaning up 2 compiler warnings on OS/2.
277 * Revision 1.41 2001/09/16 17:05:14 jongfoster
278 * Removing unused #include showarg.h
280 * Revision 1.40 2001/09/16 15:41:45 jongfoster
281 * Fixing signed/unsigned comparison warning.
283 * Revision 1.39 2001/09/16 13:21:27 jongfoster
284 * Changes to use new list functions.
286 * Revision 1.38 2001/09/16 13:01:46 jongfoster
287 * Removing redundant function call that zeroed zalloc()'d memory.
289 * Revision 1.37 2001/09/10 11:12:24 oes
290 * Deleted unused variable
292 * Revision 1.36 2001/09/10 10:56:15 oes
293 * Silenced compiler warnings
295 * Revision 1.35 2001/07/31 14:44:22 oes
296 * Deleted unused size parameter from filter_popups()
298 * Revision 1.34 2001/07/30 22:08:36 jongfoster
299 * Tidying up #defines:
300 * - All feature #defines are now of the form FEATURE_xxx
301 * - Permanently turned off WIN_GUI_EDIT
302 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
304 * Revision 1.33 2001/07/29 19:32:00 jongfoster
305 * Renaming _main() [mingw32 only] to real_main(), for ANSI compliance.
307 * Revision 1.32 2001/07/29 18:47:05 jongfoster
308 * Adding missing #include "loadcfg.h"
310 * Revision 1.31 2001/07/29 12:17:48 oes
311 * Applied pthread fix by Paul Lieverse
313 * Revision 1.30 2001/07/25 22:57:13 jongfoster
314 * __BEOS__ no longer overrides FEATURE_PTHREAD.
315 * This is because FEATURE_PTHREAD will soon be widely used, so I
316 * want to keep it simple.
318 * Revision 1.29 2001/07/24 12:47:06 oes
319 * Applied BeOS support update by Eugenia
321 * Revision 1.28 2001/07/23 13:26:12 oes
322 * Fixed bug in popup-killing for the first read that caused binary garbage to be sent between headers and body
324 * Revision 1.27 2001/07/19 19:09:47 haroon
325 * - Added code to take care of the situation where while processing the first
326 * server response (which includes the server header), after finding the end
327 * of the headers we were not looking past the end of the headers for
328 * content modification. I enabled it for filter_popups.
329 * Someone else should look to see if other similar operations should be
330 * done to the discarded portion of the buffer.
332 * Note 2001/07/20: No, the other content modification mechanisms will process
333 * the whole iob later anyway. --oes
335 * Revision 1.26 2001/07/18 12:31:36 oes
338 * Revision 1.25 2001/07/15 19:43:49 jongfoster
339 * Supports POSIX threads.
340 * Also removed some unused #includes.
342 * Revision 1.24 2001/07/13 14:00:40 oes
343 * - Generic content modification scheme:
344 * Each feature has its own applicability flag that is set
345 * from csp->action->flags.
346 * Replaced the "filtering" int flag , by a function pointer
347 * "content_filter" to the function that will do the content
348 * modification. If it is != NULL, the document will be buffered
349 * and processed through *content_filter, which must set
350 * csp->content_length and return a modified copy of the body
351 * or return NULL (on failiure).
352 * - Changed csp->is_text to the more generic bitmap csp->content_type
353 * which can currently take the valued CT_TEXT or CT_GIF
355 * - Removed all #ifdef PCRS
357 * Revision 1.23 2001/07/02 02:28:25 iwanttokeepanon
358 * Added "#ifdef ACL_FILES" conditional compilation to line 1291 to exclude
359 * the `block_acl' call. This prevents a compilation error when the user
360 * does not wish to use the "ACL" feature.
362 * Revision 1.22 2001/06/29 21:45:41 oes
363 * Indentation, CRLF->LF, Tab-> Space
365 * Revision 1.21 2001/06/29 13:29:36 oes
366 * - Cleaned up, improved comments
367 * - Unified all possible interceptors (CGI,
368 * block, trust, fast_redirect) in one
369 * place, with one (CGI) answer generation
370 * mechansim. Much clearer now.
371 * - Removed the GIF image generation, which
372 * is now done in filters.c:block_url()
373 * - Made error conditions like domain lookup
374 * failiure or (various) problems while talking
375 * to the server use cgi.c:error_response()
376 * instead of generating HTML/HTTP in chat() (yuck!)
377 * - Removed logentry from cancelled commit
379 * Revision 1.20 2001/06/09 10:55:28 jongfoster
380 * Changing BUFSIZ ==> BUFFER_SIZE
382 * Revision 1.19 2001/06/07 23:12:52 jongfoster
383 * Replacing function pointer in struct gateway with a directly
384 * called function forwarded_connect().
385 * Replacing struct gateway with struct forward_spec
387 * Revision 1.18 2001/06/03 19:12:16 oes
388 * introduced new cgi handling
390 * Revision 1.17 2001/06/01 20:07:23 jongfoster
391 * Now uses action +image-blocker{} rather than config->tinygif
393 * Revision 1.16 2001/06/01 18:49:17 jongfoster
394 * Replaced "list_share" with "list" - the tiny memory gain was not
395 * worth the extra complexity.
397 * Revision 1.15 2001/05/31 21:24:47 jongfoster
398 * Changed "permission" to "action" throughout.
399 * Removed DEFAULT_USER_AGENT - it must now be specified manually.
400 * Moved vanilla wafer check into chat(), since we must now
401 * decide whether or not to add it based on the URL.
403 * Revision 1.14 2001/05/29 20:14:01 joergs
404 * AmigaOS bugfix: PCRS needs a lot of stack, stacksize for child threads
407 * Revision 1.13 2001/05/29 09:50:24 jongfoster
408 * Unified blocklist/imagelist/permissionslist.
409 * File format is still under discussion, but the internal changes
412 * Also modified interceptor behaviour:
413 * - We now intercept all URLs beginning with one of the following
414 * prefixes (and *only* these prefixes):
416 * * http://ijbswa.sf.net/config/
417 * * http://ijbswa.sourceforge.net/config/
418 * - New interceptors "home page" - go to http://i.j.b/ to see it.
419 * - Internal changes so that intercepted and fast redirect pages
420 * are not replaced with an image.
421 * - Interceptors now have the option to send a binary page direct
422 * to the client. (i.e. ijb-send-banner uses this)
423 * - Implemented show-url-info interceptor. (Which is why I needed
424 * the above interceptors changes - a typical URL is
425 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
426 * The previous mechanism would not have intercepted that, and
427 * if it had been intercepted then it then it would have replaced
430 * Revision 1.12 2001/05/27 22:17:04 oes
432 * - re_process_buffer no longer writes the modified buffer
433 * to the client, which was very ugly. It now returns the
434 * buffer, which it is then written by chat.
436 * - content_length now adjusts the Content-Length: header
437 * for modified documents rather than crunch()ing it.
438 * (Length info in csp->content_length, which is 0 for
439 * unmodified documents)
441 * - For this to work, sed() is called twice when filtering.
443 * Revision 1.11 2001/05/26 17:27:53 jongfoster
444 * Added support for CLF and fixed LOG_LEVEL_LOG.
445 * Also did CRLF->LF fix of my previous patch.
447 * Revision 1.10 2001/05/26 15:26:15 jongfoster
448 * ACL feature now provides more security by immediately dropping
449 * connections from untrusted hosts.
451 * Revision 1.9 2001/05/26 00:28:36 jongfoster
452 * Automatic reloading of config file.
453 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
454 * Most of the global variables have been moved to a new
455 * struct configuration_spec, accessed through csp->config->globalname
456 * Most of the globals remaining are used by the Win32 GUI.
458 * Revision 1.8 2001/05/25 22:43:18 jongfoster
459 * Fixing minor memory leak and buffer overflow.
461 * Revision 1.7 2001/05/25 22:34:30 jongfoster
464 * Revision 1.6 2001/05/23 00:13:58 joergs
465 * AmigaOS support fixed.
467 * Revision 1.5 2001/05/22 18:46:04 oes
469 * - Enabled filtering banners by size rather than URL
470 * by adding patterns that replace all standard banner
471 * sizes with the "Junkbuster" gif to the re_filterfile
473 * - Enabled filtering WebBugs by providing a pattern
474 * which kills all 1x1 images
476 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
477 * which is selected by the (nonstandard and therefore
478 * capital) letter 'U' in the option string.
479 * It causes the quantifiers to be ungreedy by default.
480 * Appending a ? turns back to greedy (!).
482 * - Added a new interceptor ijb-send-banner, which
483 * sends back the "Junkbuster" gif. Without imagelist or
484 * MSIE detection support, or if tinygif = 1, or the
485 * URL isn't recognized as an imageurl, a lame HTML
486 * explanation is sent instead.
488 * - Added new feature, which permits blocking remote
489 * script redirects and firing back a local redirect
491 * The feature is conditionally compiled, i.e. it
492 * can be disabled with --disable-fast-redirects,
493 * plus it must be activated by a "fast-redirects"
494 * line in the config file, has its own log level
495 * and of course wants to be displayed by show-proxy-args
496 * Note: Boy, all the #ifdefs in 1001 locations and
497 * all the fumbling with configure.in and acconfig.h
498 * were *way* more work than the feature itself :-(
500 * - Because a generic redirect template was needed for
501 * this, tinygif = 3 now uses the same.
503 * - Moved GIFs, and other static HTTP response templates
508 * - Removed some >400 CRs again (Jon, you really worked
511 * Revision 1.4 2001/05/21 19:34:01 jongfoster
512 * Made failure to bind() a fatal error.
514 * Revision 1.3 2001/05/20 01:21:20 jongfoster
515 * Version 2.9.4 checkin.
516 * - Merged popupfile and cookiefile, and added control over PCRS
517 * filtering, in new "permissionsfile".
518 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
519 * file error you now get a message box (in the Win32 GUI) rather
520 * than the program exiting with no explanation.
521 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
523 * - Removed tabs from "config"
524 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
525 * - Bumped up version number.
527 * Revision 1.2 2001/05/17 22:34:44 oes
528 * - Added hint on GIF char array generation to jcc.c
529 * - Cleaned CRLF's from the sources and related files
530 * - Repaired logging for REF and FRC
532 * Revision 1.1.1.1 2001/05/15 13:58:56 oes
533 * Initial import of version 2.9.3 source tree
536 *********************************************************************/
542 #include <sys/types.h>
549 #ifdef FEATURE_PTHREAD
551 #endif /* def FEATURE_PTHREAD */
554 # ifndef FEATURE_PTHREAD
558 # include <windows.h>
559 # include <process.h>
560 # endif /* ndef FEATURE_PTHREAD */
563 # ifndef _WIN_CONSOLE
565 # endif /* ndef _WIN_CONSOLE */
567 #else /* ifndef _WIN32 */
569 # if !defined (__OS2__)
571 # include <sys/wait.h>
572 # endif /* ndef __OS2__ */
573 # include <sys/time.h>
574 # include <sys/stat.h>
575 # include <sys/ioctl.h>
578 #include <sys/termios.h>
589 # include <socket.h> /* BeOS has select() for sockets only. */
590 # include <OS.h> /* declarations for threads and stuff. */
593 # if defined(__EMX__) || defined(__OS2__)
594 # include <sys/select.h> /* OS/2/EMX needs a little help with select */
599 #define bzero(B,N) memset(B,0x00,n)
614 #include "killpopup.h"
615 #include "miscutil.h"
617 #include "jbsockets.h"
622 #include "urlmatch.h"
624 const char jcc_h_rcs[] = JCC_H_VERSION;
625 const char project_h_rcs[] = PROJECT_H_VERSION;
628 struct client_state clients[1];
629 struct file_list files[1];
631 #ifdef FEATURE_STATISTICS
632 int urls_read = 0; /* total nr of urls read inc rejected */
633 int urls_rejected = 0; /* total nr of urls rejected */
634 #endif /* def FEATURE_STATISTICS */
636 #ifdef FEATURE_GRACEFUL_TERMINATION
640 static void listen_loop(void);
641 static void chat(struct client_state *csp);
643 void serve(struct client_state *csp);
644 #else /* ifndef AMIGA */
645 static void serve(struct client_state *csp);
646 #endif /* def AMIGA */
649 static int32 server_thread(void *data);
650 #endif /* def __BEOS__ */
653 #define sleep(N) Sleep(((N) * 1000))
657 #define sleep(N) DosSleep(((N) * 100))
660 #if defined(unix) || defined(__EMX__)
662 const char *pidfile = NULL;
663 int received_hup_signal = 0;
664 #endif /* defined unix */
666 /* The vanilla wafer. */
667 static const char VANILLA_WAFER[] =
668 "NOTICE=TO_WHOM_IT_MAY_CONCERN_"
669 "Do_not_send_me_any_copyrighted_information_other_than_the_"
670 "document_that_I_am_requesting_or_any_of_its_necessary_components._"
671 "In_particular_do_not_send_me_any_cookies_that_"
672 "are_subject_to_a_claim_of_copyright_by_anybody._"
673 "Take_notice_that_I_refuse_to_be_bound_by_any_license_condition_"
674 "(copyright_or_otherwise)_applying_to_any_cookie._";
677 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
678 /*********************************************************************
680 * Function : sig_handler
682 * Description : Signal handler for different signals.
683 * Exit gracefully on ABRT, TERM and INT
684 * or set a flag that will cause the errlog
685 * to be reopened by the main thread on HUP.
688 * 1 : the_signal = the signal cause this function to call
692 *********************************************************************/
693 static void sig_handler(int the_signal)
700 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
708 received_hup_signal = 1;
713 * We shouldn't be here, unless we catch signals
714 * in main() that we can't handle here!
716 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
724 /*********************************************************************
728 * Description : Once a connection to the client has been accepted,
729 * this function is called (via serve()) to handle the
730 * main business of the communication. When this
731 * function returns, the caller must close the client
735 * 1 : csp = Current client state (buffers, headers, etc...)
737 * Returns : On success, the number of bytes written are returned (zero
738 * indicates nothing was written). On error, -1 is returned,
739 * and errno is set appropriately. If count is zero and the
740 * file descriptor refers to a regular file, 0 will be
741 * returned without causing any other effect. For a special
742 * file, the results are not portable.
744 *********************************************************************/
745 static void chat(struct client_state *csp)
748 * This next lines are a little ugly, but they simplifies the if statements
749 * below. Basically if TOGGLE, then we want the if to test if the
750 * CSP_FLAG_TOGGLED_ON flag ist set, else we don't. And if FEATURE_FORCE_LOAD,
751 * then we want the if to test for CSP_FLAG_FORCED , else we don't
753 #ifdef FEATURE_TOGGLE
754 # define IS_TOGGLED_ON_AND (csp->flags & CSP_FLAG_TOGGLED_ON) &&
755 #else /* ifndef FEATURE_TOGGLE */
756 # define IS_TOGGLED_ON_AND
757 #endif /* ndef FEATURE_TOGGLE */
758 #ifdef FEATURE_FORCE_LOAD
759 # define IS_NOT_FORCED_AND !(csp->flags & CSP_FLAG_FORCED) &&
760 #else /* ifndef FEATURE_FORCE_LOAD */
761 # define IS_NOT_FORCED_AND
762 #endif /* def FEATURE_FORCE_LOAD */
764 #define IS_ENABLED_AND IS_TOGGLED_ON_AND IS_NOT_FORCED_AND
766 char buf[BUFFER_SIZE];
774 int ms_iis5_hack = 0;
776 const struct forward_spec * fwd;
777 struct http_request *http;
778 int len; /* for buffer sizes */
779 #ifdef FEATURE_KILL_POPUPS
780 int block_popups; /* bool, 1==will block popups */
781 int block_popups_now = 0; /* bool, 1==currently blocking popups */
782 #endif /* def FEATURE_KILL_POPUPS */
784 int pcrs_filter; /* bool, 1==will filter through pcrs */
785 int gif_deanimate; /* bool, 1==will deanimate gifs */
787 /* Function that does the content filtering for the current request */
788 char *(*content_filter)() = NULL;
790 /* Skeleton for HTTP response, if we should intercept the request */
791 struct http_response *rsp;
796 * Read the client's request. Note that since we're not using select() we
797 * could get blocked here if a client connected, then didn't say anything!
802 len = read_socket(csp->cfd, buf, sizeof(buf));
804 if (len <= 0) break; /* error! */
807 * If there is no memory left for buffering the
808 * request, there is nothing we can do but hang up
810 if (add_to_iob(csp, buf, len))
815 req = get_header(csp);
819 break; /* no HTTP request! */
824 continue; /* more to come! */
827 #ifdef FEATURE_FORCE_LOAD
828 /* If this request contains the FORCE_PREFIX,
829 * better get rid of it now and set the force flag --oes
832 if (strstr(req, FORCE_PREFIX))
834 strclean(req, FORCE_PREFIX);
835 log_error(LOG_LEVEL_FORCE, "Enforcing request \"%s\".\n", req);
836 csp->flags |= CSP_FLAG_FORCED;
839 #endif /* def FEATURE_FORCE_LOAD */
841 parse_http_request(req, http, csp);
846 if (http->cmd == NULL)
848 strcpy(buf, CHEADER);
849 write_socket(csp->cfd, buf, strlen(buf));
851 log_error(LOG_LEVEL_CLF, "%s - - [%T] \" \" 400 0", csp->ip_addr_str);
856 /* decide how to route the HTTP request */
858 if ((fwd = forward_url(http, csp)) == NULL)
860 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!? This can't happen!");
861 /* Never get here - LOG_LEVEL_FATAL causes program exit */
864 /* build the http request to send to the server
865 * we have to do one of the following:
867 * create = use the original HTTP request to create a new
868 * HTTP request that has either the path component
869 * without the http://domainspec (w/path) or the
870 * full orininal URL (w/url)
871 * Note that the path and/or the HTTP version may
872 * have been altered by now.
874 * connect = Open a socket to the host:port of the server
875 * and short-circuit server and client socket.
877 * pass = Pass the request unchanged if forwarding a CONNECT
878 * request to a parent proxy. Note that we'll be sending
879 * the CFAIL message ourselves if connecting to the parent
880 * fails, but we won't send a CSUCCEED message if it works,
881 * since that would result in a double message (ours and the
882 * parent's). After sending the request to the parent, we simply
888 * +--------+--------+
890 * 0 | create | connect|
892 * Forwarding +--------+--------+
894 * 1 | create | pass |
896 * +--------+--------+
901 * Determine the actions for this URL
903 #ifdef FEATURE_TOGGLE
904 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
906 /* Most compatible set of actions (i.e. none) */
907 init_current_action(csp->action);
910 #endif /* ndef FEATURE_TOGGLE */
912 url_actions(http, csp);
917 * Check if a CONNECT request is allowable:
918 * In the absence of a +limit-connect action, allow only port 443.
919 * If there is an action, allow whatever matches the specificaton.
923 if( ( !(csp->action->flags & ACTION_LIMIT_CONNECT) && csp->http->port != 443)
924 || (csp->action->flags & ACTION_LIMIT_CONNECT
925 && !match_portlist(csp->action->string[ACTION_STRING_LIMIT_CONNECT], csp->http->port)) )
927 strcpy(buf, CFORBIDDEN);
928 write_socket(csp->cfd, buf, strlen(buf));
930 log_error(LOG_LEVEL_CONNECT, "Denying suspicious CONNECT request from %s", csp->ip_addr_str);
931 log_error(LOG_LEVEL_CLF, "%s - - [%T] \" \" 403 0", csp->ip_addr_str);
939 * Downgrade http version from 1.1 to 1.0 if +downgrade
942 if ( (http->ssl == 0)
943 && (!strcmpic(http->ver, "HTTP/1.1"))
944 && (csp->action->flags & ACTION_DOWNGRADE))
947 http->ver = strdup("HTTP/1.0");
949 if (http->ver == NULL)
951 log_error(LOG_LEVEL_FATAL, "Out of memory downgrading HTTP version");
956 * Save a copy of the original request for logging
958 http->ocmd = strdup(http->cmd);
960 if (http->ocmd == NULL)
962 log_error(LOG_LEVEL_FATAL, "Out of memory copying HTTP request line");
966 * (Re)build the HTTP request for non-SSL requests.
967 * If forwarding, use the whole URL, else, use only the path.
973 http->cmd = strdup(http->gpc);
974 string_append(&http->cmd, " ");
976 if (fwd->forward_host)
978 string_append(&http->cmd, http->url);
982 string_append(&http->cmd, http->path);
985 string_append(&http->cmd, " ");
986 string_append(&http->cmd, http->ver);
988 if (http->cmd == NULL)
990 log_error(LOG_LEVEL_FATAL, "Out of memory rewiting SSL command");
993 enlist(csp->headers, http->cmd);
997 * If the user has not supplied any wafers, and the user has not
998 * told us to suppress the vanilla wafer, then send the vanilla wafer.
1000 if (list_is_empty(csp->action->multi[ACTION_MULTI_WAFER])
1001 && ((csp->action->flags & ACTION_VANILLA_WAFER) != 0))
1003 enlist(csp->action->multi[ACTION_MULTI_WAFER], VANILLA_WAFER);
1007 #ifdef FEATURE_KILL_POPUPS
1008 block_popups = ((csp->action->flags & ACTION_NO_POPUPS) != 0);
1009 #endif /* def FEATURE_KILL_POPUPS */
1011 pcrs_filter = (csp->rlist != NULL) && /* There are expressions to be used */
1012 (!list_is_empty(csp->action->multi[ACTION_MULTI_FILTER]));
1014 gif_deanimate = ((csp->action->flags & ACTION_DEANIMATE) != 0);
1016 /* grab the rest of the client's headers */
1020 if ( ( ( p = get_header(csp) ) != NULL) && ( *p == '\0' ) )
1022 len = read_socket(csp->cfd, buf, sizeof(buf));
1025 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1030 * If there is no memory left for buffering the
1031 * request, there is nothing we can do but hang up
1033 if (add_to_iob(csp, buf, len))
1040 if (p == NULL) break;
1042 enlist(csp->headers, p);
1046 * We have a request. Now, check to see if we need to
1047 * intercept it, i.e. If ..
1051 /* a CGI call was detected and answered */
1052 (NULL != (rsp = dispatch_cgi(csp)))
1054 /* or we are enabled and... */
1055 || (IS_ENABLED_AND (
1057 /* ..the request was blocked */
1058 ( NULL != (rsp = block_url(csp)))
1060 /* ..or untrusted */
1061 #ifdef FEATURE_TRUST
1062 || ( NULL != (rsp = trust_url(csp)))
1063 #endif /* def FEATURE_TRUST */
1065 /* ..or a fast redirect kicked in */
1066 #ifdef FEATURE_FAST_REDIRECTS
1067 || (((csp->action->flags & ACTION_FAST_REDIRECTS) != 0) &&
1068 (NULL != (rsp = redirect_url(csp))))
1069 #endif /* def FEATURE_FAST_REDIRECTS */
1073 /* Write the answer to the client */
1074 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1075 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1077 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1080 #ifdef FEATURE_STATISTICS
1081 /* Count as a rejected request */
1082 csp->flags |= CSP_FLAG_REJECTED;
1083 #endif /* def FEATURE_STATISTICS */
1085 /* Log (FIXME: All intercept reasons apprear as "crunch" with Status 200) */
1086 log_error(LOG_LEVEL_GPC, "%s%s crunch!", http->hostport, http->path);
1087 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3", csp->ip_addr_str, http->ocmd);
1089 /* Clean up and return */
1090 free_http_response(rsp);
1094 log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
1096 if (fwd->forward_host)
1098 log_error(LOG_LEVEL_CONNECT, "via %s:%d to: %s",
1099 fwd->forward_host, fwd->forward_port, http->hostport);
1103 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
1106 /* here we connect to the server, gateway, or the forwarder */
1108 csp->sfd = forwarded_connect(fwd, http, csp);
1110 if (csp->sfd == JB_INVALID_SOCKET)
1112 log_error(LOG_LEVEL_CONNECT, "connect to: %s failed: %E",
1115 if (errno == EINVAL)
1117 rsp = error_response(csp, "no-such-domain", errno);
1119 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 404 0",
1120 csp->ip_addr_str, http->ocmd);
1124 rsp = error_response(csp, "connect-failed", errno);
1126 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 503 0",
1127 csp->ip_addr_str, http->ocmd);
1131 /* Write the answer to the client */
1134 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1135 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1137 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1141 free_http_response(rsp);
1145 log_error(LOG_LEVEL_CONNECT, "OK");
1147 hdr = sed(client_patterns, add_client_headers, csp);
1150 /* FIXME Should handle error properly */
1151 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
1154 list_remove_all(csp->headers);
1156 if (fwd->forward_host || (http->ssl == 0))
1158 /* write the client's (modified) header to the server
1159 * (along with anything else that may be in the buffer)
1162 if (write_socket(csp->sfd, hdr, strlen(hdr))
1163 || (flush_socket(csp->sfd, csp) < 0))
1165 log_error(LOG_LEVEL_CONNECT, "write header to: %s failed: %E",
1168 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 503 0",
1169 csp->ip_addr_str, http->ocmd);
1171 rsp = error_response(csp, "connect-failed", errno);
1175 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1176 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1178 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1182 free_http_response(rsp);
1190 * We're running an SSL tunnel and we're not forwarding,
1191 * so just send the "connect succeeded" message to the
1192 * client, flush the rest, and get out of the way.
1194 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 2\n",
1195 csp->ip_addr_str, http->ocmd);
1197 if (write_socket(csp->cfd, CSUCCEED, sizeof(CSUCCEED)-1))
1205 /* we're finished with the client's header */
1208 maxfd = ( csp->cfd > csp->sfd ) ? csp->cfd : csp->sfd;
1210 /* pass data between the client and server
1211 * until one or the other shuts down the connection.
1220 * FD_ZERO here seems to point to an errant macro which crashes.
1221 * So do this by hand for now...
1223 memset(&rfds,0x00,sizeof(fd_set));
1227 FD_SET(csp->cfd, &rfds);
1228 FD_SET(csp->sfd, &rfds);
1230 n = select((int)maxfd+1, &rfds, NULL, NULL, NULL);
1234 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
1238 /* this is the body of the browser's request
1239 * just read it and write it.
1242 if (FD_ISSET(csp->cfd, &rfds))
1244 len = read_socket(csp->cfd, buf, sizeof(buf));
1248 break; /* "game over, man" */
1251 if (write_socket(csp->sfd, buf, (size_t)len))
1253 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1260 * The server wants to talk. It could be the header or the body.
1261 * If `hdr' is null, then it's the header otherwise it's the body.
1262 * FIXME: Does `hdr' really mean `host'? No.
1266 if (FD_ISSET(csp->sfd, &rfds))
1269 len = read_socket(csp->sfd, buf, sizeof(buf) - 1);
1273 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
1275 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 503 0",
1276 csp->ip_addr_str, http->ocmd);
1278 rsp = error_response(csp, "connect-failed", errno);
1282 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1283 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1285 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1289 free_http_response(rsp);
1293 /* Add a trailing zero. This lets filter_popups
1294 * use string operations.
1298 #ifdef FEATURE_KILL_POPUPS
1299 /* Filter the popups on this read. */
1300 if (block_popups_now)
1302 filter_popups(buf, csp);
1304 #endif /* def FEATURE_KILL_POPUPS */
1306 /* Normally, this would indicate that we've read
1307 * as much as the server has sent us and we can
1308 * close the client connection. However, Microsoft
1309 * in its wisdom has released IIS/5 with a bug that
1310 * prevents it from sending the trailing \r\n in
1311 * a 302 redirect header (and possibly other headers).
1312 * To work around this if we've haven't parsed
1313 * a full header we'll append a trailing \r\n
1314 * and see if this now generates a valid one.
1316 * This hack shouldn't have any impacts. If we've
1317 * already transmitted the header or if this is a
1318 * SSL connection, then we won't bother with this
1319 * hack. So we only work on partially received
1320 * headers. If we append a \r\n and this still
1321 * doesn't generate a valid header, then we won't
1322 * transmit anything to the client.
1327 if (server_body || http->ssl)
1330 * If we have been buffering up the document,
1331 * now is the time to apply content modification
1332 * and send the result to the client.
1337 * If the content filter fails, use the original
1338 * buffer and length.
1339 * (see p != NULL ? p : csp->iob->cur below)
1341 if (NULL == (p = (*content_filter)(csp)))
1343 csp->content_length = csp->iob->eod - csp->iob->cur;
1346 hdr = sed(server_patterns, add_server_headers, csp);
1349 /* FIXME Should handle error properly */
1350 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
1353 if (write_socket(csp->cfd, hdr, strlen(hdr))
1354 || write_socket(csp->cfd, p != NULL ? p : csp->iob->cur, csp->content_length))
1356 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
1366 break; /* "game over, man" */
1370 * This is NOT the body, so
1371 * Let's pretend the server just sent us a blank line.
1373 len = sprintf(buf, "\r\n");
1376 * Now, let the normal header parsing algorithm below do its
1377 * job. If it fails, we'll exit instead of continuing.
1384 * If this is an SSL connection or we're in the body
1385 * of the server document, just write it to the client,
1386 * unless we need to buffer the body for later content-filtering
1389 if (server_body || http->ssl)
1394 * If there is no memory left for buffering the content, or the buffer limit
1395 * has been reached, switch to non-filtering mode, i.e. make & write the
1396 * header, flush the iob and buf, and get out of the way.
1398 if (add_to_iob(csp, buf, len))
1403 log_error(LOG_LEVEL_ERROR, "Flushing header and buffers. Stepping back from filtering.");
1405 hdr = sed(server_patterns, add_server_headers, csp);
1409 * Memory is too tight to even generate the header.
1410 * Send our static "Out-of-memory" page.
1412 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
1413 rsp = cgi_error_memory();
1415 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1416 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1418 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1423 hdrlen = strlen(hdr);
1425 if (write_socket(csp->cfd, hdr, hdrlen)
1426 || ((flushed = flush_socket(csp->cfd, csp)) < 0)
1427 || (write_socket(csp->cfd, buf, len)))
1429 log_error(LOG_LEVEL_CONNECT, "Flush header and buffers to client failed: %E");
1435 byte_count += hdrlen + flushed + len;
1437 content_filter = NULL;
1444 if (write_socket(csp->cfd, buf, (size_t)len))
1446 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
1455 /* we're still looking for the end of the
1456 * server's header ... (does that make header
1457 * parsing an "out of body experience" ?
1461 * buffer up the data we just read. If that fails,
1462 * there's little we can do but send our static
1463 * out-of-memory page.
1465 if (add_to_iob(csp, buf, len))
1467 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
1468 rsp = cgi_error_memory();
1470 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
1471 || write_socket(csp->cfd, rsp->body, rsp->content_length))
1473 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1478 /* get header lines from the iob */
1480 while ((p = get_header(csp)) != NULL)
1484 /* see following note */
1487 enlist(csp->headers, p);
1491 /* NOTE: there are no "empty" headers so
1492 * if the pointer `p' is not NULL we must
1493 * assume that we reached the end of the
1494 * buffer before we hit the end of the header.
1501 /* Well, we tried our MS IIS/5
1502 * hack and it didn't work.
1503 * The header is incomplete
1504 * and there isn't anything
1505 * we can do about it.
1511 /* Since we have to wait for
1512 * more from the server before
1513 * we can parse the headers
1514 * we just continue here.
1520 /* we have now received the entire header.
1521 * filter it and send the result to the client
1524 hdr = sed(server_patterns, add_server_headers, csp);
1527 /* FIXME Should handle error properly */
1528 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
1531 #ifdef FEATURE_KILL_POPUPS
1532 /* Start blocking popups if appropriate. */
1534 if ((csp->content_type & CT_TEXT) && /* It's a text / * MIME-Type */
1535 !http->ssl && /* We talk plaintext */
1536 block_popups) /* Policy allows */
1538 block_popups_now = 1;
1540 * Filter the part of the body that came in the same read
1541 * as the last headers:
1543 filter_popups(csp->iob->cur, csp);
1546 #endif /* def FEATURE_KILL_POPUPS */
1548 /* Buffer and pcrs filter this if appropriate. */
1550 if ((csp->content_type & CT_TEXT) && /* It's a text / * MIME-Type */
1551 !http->ssl && /* We talk plaintext */
1552 pcrs_filter) /* Policy allows */
1554 content_filter = pcrs_filter_response;
1557 /* Buffer and gif_deanimate this if appropriate. */
1559 if ((csp->content_type & CT_GIF) && /* It's a image/gif MIME-Type */
1560 !http->ssl && /* We talk plaintext */
1561 gif_deanimate) /* Policy allows */
1563 content_filter = gif_deanimate_response;
1567 * Only write if we're not buffering for content modification
1569 if (!content_filter)
1571 /* write the server's (modified) header to
1572 * the client (along with anything else that
1573 * may be in the buffer)
1576 if (write_socket(csp->cfd, hdr, strlen(hdr))
1577 || ((len = flush_socket(csp->cfd, csp)) < 0))
1579 log_error(LOG_LEVEL_CONNECT, "write header to client failed: %E");
1581 /* the write failed, so don't bother
1582 * mentioning it to the client...
1583 * it probably can't hear us anyway.
1592 /* we're finished with the server's header */
1597 /* If this was a MS IIS/5 hack then it means
1598 * the server has already closed the
1599 * connection. Nothing more to read. Time
1610 return; /* huh? we should never get here */
1613 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %d",
1614 csp->ip_addr_str, http->ocmd, byte_count);
1618 /*********************************************************************
1622 * Description : This is little more than chat. We only "serve" to
1623 * to close any socket that chat may have opened.
1626 * 1 : csp = Current client state (buffers, headers, etc...)
1630 *********************************************************************/
1632 void serve(struct client_state *csp)
1633 #else /* ifndef AMIGA */
1634 static void serve(struct client_state *csp)
1635 #endif /* def AMIGA */
1638 close_socket(csp->cfd);
1640 if (csp->sfd != JB_INVALID_SOCKET)
1642 close_socket(csp->sfd);
1645 csp->flags &= ~CSP_FLAG_ACTIVE;
1651 /*********************************************************************
1653 * Function : server_thread
1655 * Description : We only exist to call `serve' in a threaded environment.
1658 * 1 : data = Current client state (buffers, headers, etc...)
1660 * Returns : Always 0.
1662 *********************************************************************/
1663 static int32 server_thread(void *data)
1665 serve((struct client_state *) data);
1672 /*********************************************************************
1676 * Description : Print usage info & exit.
1678 * Parameters : Pointer to argv[0] for identifying ourselves
1682 *********************************************************************/
1683 void usage(const char *myname)
1685 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
1686 "Usage: %s [--help] [--version] [--no-daemon] [--pidfile pidfile] [--user user[.group]] [configfile]\n"
1687 "Aborting.\n", myname);
1694 /*********************************************************************
1698 * Description : Load the config file and start the listen loop.
1699 * This function is a lot more *sane* with the `load_config'
1700 * and `listen_loop' functions; although it stills does
1701 * a *little* too much for my taste.
1704 * 1 : argc = Number of parameters (including $0).
1705 * 2 : argv = Array of (char *)'s to the parameters.
1707 * Returns : 1 if : can't open config file, unrecognized directive,
1708 * stats requested in multi-thread mode, can't open the
1709 * log file, can't open the jar file, listen port is invalid,
1710 * any load fails, and can't bind port.
1712 * Else main never returns, the process must be signaled
1713 * to terminate execution. Or, on Windows, use the
1714 * "File", "Exit" menu option.
1716 *********************************************************************/
1718 int real_main(int argc, const char *argv[])
1720 int main(int argc, const char *argv[])
1725 struct passwd *pw = NULL;
1726 struct group *grp = NULL;
1734 #if !defined(_WIN32)
1742 * Parse the command line arguments
1744 while (++argc_pos < argc)
1746 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
1748 if (strcmp(argv[argc_pos], "--help") == 0)
1753 else if(strcmp(argv[argc_pos], "--version") == 0)
1755 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
1759 else if (strcmp(argv[argc_pos], "--no-daemon" ) == 0)
1764 else if (strcmp(argv[argc_pos], "--pidfile" ) == 0)
1766 if (++argc_pos == argc) usage(argv[0]);
1767 pidfile = strdup(argv[argc_pos]);
1770 else if (strcmp(argv[argc_pos], "--user" ) == 0)
1772 if (++argc_pos == argc) usage(argv[argc_pos]);
1774 if ((NULL != (p = strchr(argv[argc_pos], '.'))) && *(p + 1) != '0')
1777 if (NULL == (grp = getgrnam(p)))
1779 log_error(LOG_LEVEL_FATAL, "Group %s not found.", p);
1783 if (NULL == (pw = getpwnam(argv[argc_pos])))
1785 log_error(LOG_LEVEL_FATAL, "User %s not found.", argv[argc_pos]);
1788 if (p != NULL) *--p = '\0';
1790 #endif /* defined(unix) */
1792 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
1794 configfile = argv[argc_pos];
1797 } /* -END- while (more arguments) */
1800 if ( *configfile != '/' )
1804 /* make config-filename absolute here */
1805 if ( !(basedir = getcwd( NULL, 1024 )))
1807 perror("get working dir failed");
1811 if ( !(abs_file = malloc( strlen( basedir ) + strlen( configfile ) + 5 )))
1813 perror("malloc failed");
1816 strcpy( abs_file, basedir );
1817 strcat( abs_file, "/" );
1818 strcat( abs_file, configfile );
1819 configfile = abs_file;
1821 #endif /* defined unix */
1828 #elif defined(_WIN32)
1833 * Unix signal handling
1835 * Catch the abort, interrupt and terminate signals for a graceful exit
1836 * Catch the hangup signal so the errlog can be reopened.
1837 * Ignore the broken pipe and child signals
1838 * FIXME: Isn't ignoring the default for SIGCHLD anyway and why ignore SIGPIPE?
1840 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
1843 const int catched_signals[] = { SIGABRT, SIGTERM, SIGINT, SIGHUP, 0 };
1844 const int ignored_signals[] = { SIGPIPE, SIGCHLD, 0 };
1846 for (idx = 0; catched_signals[idx] != 0; idx++)
1848 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
1850 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
1854 for (idx = 0; ignored_signals[idx] != 0; idx++)
1856 if (signal(ignored_signals[idx], SIG_IGN) == SIG_ERR)
1858 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for signal %d: %E", ignored_signals[idx]);
1863 #else /* ifdef _WIN32 */
1864 # ifdef _WIN_CONSOLE
1866 * We *are* in a windows console app.
1867 * Print a verbose messages about FAQ's and such
1869 printf(win32_blurb);
1870 # endif /* def _WIN_CONSOLE */
1871 #endif /* def _WIN32 */
1874 /* Initialize the CGI subsystem */
1875 cgi_init_error_messages();
1878 * If runnig on unix and without the --nodaemon
1879 * option, become a daemon. I.e. fork, detach
1880 * from tty and get process group leadership
1893 if ( pid < 0 ) /* error */
1898 else if ( pid != 0 ) /* parent */
1903 * must check for errors
1904 * child died due to missing files aso
1907 wpid = waitpid( pid, &status, WNOHANG );
1916 /* Should be more portable, but not as well tested */
1921 #else /* ndef __FreeBSD__ */
1923 #endif /* ndef __FreeBSD__ */
1924 fd = open("/dev/tty", O_RDONLY);
1927 /* no error check here */
1928 ioctl( fd, TIOCNOTTY,0 );
1932 /* FIXME: should close stderr (fd 2) here too, but the test
1934 * and load config file is done in listen_loop() and puts
1935 * some messages on stderr there.
1942 } /* -END- if (!no_daemon) */
1945 * As soon as we have written the PID file, we can switch
1946 * to the user and group ID indicated by the --user option
1952 if (((NULL != grp) && setgid(grp->gr_gid)) || (setgid(pw->pw_gid)))
1954 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
1956 if (setuid(pw->pw_uid))
1958 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
1962 #endif /* defined unix */
1972 /*********************************************************************
1974 * Function : bind_port_helper
1976 * Description : Bind the listen port. Handles logging, and aborts
1980 * 1 : config = Privoxy configuration. Specifies port
1983 * Returns : Port that was opened.
1985 *********************************************************************/
1986 static jb_socket bind_port_helper(struct configuration_spec * config)
1991 if ( (config->haddr != NULL)
1992 && (config->haddr[0] == '1')
1993 && (config->haddr[1] == '2')
1994 && (config->haddr[2] == '7')
1995 && (config->haddr[3] == '.') )
1997 log_error(LOG_LEVEL_INFO, "Listening on port %d for local connections only",
2000 else if (config->haddr == NULL)
2002 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
2007 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
2008 config->hport, config->haddr);
2011 result = bind_port(config->haddr, config->hport, &bfd);
2018 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
2019 "There may be another Privoxy or some other "
2020 "proxy running on port %d",
2021 (NULL != config->haddr) ? config->haddr : "INADDR_ANY",
2022 config->hport, config->hport);
2025 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
2026 "The hostname is not resolvable",
2027 (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
2030 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: because %E",
2031 (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
2034 /* shouldn't get here */
2035 return JB_INVALID_SOCKET;
2038 config->need_bind = 0;
2044 /*********************************************************************
2046 * Function : listen_loop
2048 * Description : bind the listen port and enter a "FOREVER" listening loop.
2054 *********************************************************************/
2055 static void listen_loop(void)
2057 struct client_state *csp = NULL;
2059 struct configuration_spec * config;
2061 config = load_config();
2063 bfd = bind_port_helper(config);
2065 #ifdef FEATURE_GRACEFUL_TERMINATION
2066 while (!g_terminate)
2071 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
2072 while (waitpid(-1, NULL, WNOHANG) > 0)
2074 /* zombie children */
2076 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
2079 * Free data that was used by died threads
2085 * Re-open the errlog after HUP signal
2087 if (received_hup_signal)
2089 init_error_log(Argv[0], config->logfile, config->debug);
2090 received_hup_signal = 0;
2095 #ifdef FEATURE_COOKIE_JAR
2097 * Need a workaround here: we have to fclose() the jarfile, or we die because it's
2098 * already open. I think unload_configfile() is not being run, which should do
2099 * this work. Until that can get resolved, we'll use this workaround.
2103 if (csp->config->jar)
2105 fclose(csp->config->jar);
2106 csp->config->jar = NULL;
2108 #endif /* FEATURE_COOKIE_JAR */
2109 #endif /* __OS2__ */
2111 if ( NULL == (csp = (struct client_state *) zalloc(sizeof(*csp))) )
2113 log_error(LOG_LEVEL_FATAL, "malloc(%d) for csp failed: %E", sizeof(*csp));
2117 csp->flags |= CSP_FLAG_ACTIVE;
2118 csp->sfd = JB_INVALID_SOCKET;
2120 csp->config = config = load_config();
2122 if ( config->need_bind )
2125 * Since we were listening to the "old port", we will not see
2126 * a "listen" param change until the next IJB request. So, at
2127 * least 1 more request must be made for us to find the new
2128 * setting. I am simply closing the old socket and binding the
2131 * Which-ever is correct, we will serve 1 more page via the
2132 * old settings. This should probably be a "show-proxy-args"
2133 * request. This should not be a so common of an operation
2134 * that this will hurt people's feelings.
2139 bfd = bind_port_helper(config);
2142 log_error(LOG_LEVEL_CONNECT, "accept connection ... ");
2144 if (!accept_connection(csp, bfd))
2146 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
2159 log_error(LOG_LEVEL_CONNECT, "OK");
2162 #ifdef FEATURE_TOGGLE
2165 csp->flags |= CSP_FLAG_TOGGLED_ON;
2167 #endif /* def FEATURE_TOGGLE */
2169 if (run_loader(csp))
2171 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
2172 /* Never get here - LOG_LEVEL_FATAL causes program exit */
2176 if (block_acl(NULL,csp))
2178 log_error(LOG_LEVEL_CONNECT, "Connection dropped due to ACL");
2179 close_socket(csp->cfd);
2183 #endif /* def FEATURE_ACL */
2185 /* add it to the list of clients */
2186 csp->next = clients->next;
2187 clients->next = csp;
2189 if (config->multi_threaded)
2193 /* this is a switch () statment in the C preprocessor - ugh */
2194 #undef SELECTED_ONE_OPTION
2196 /* Use Pthreads in preference to native code */
2197 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
2198 #define SELECTED_ONE_OPTION
2200 pthread_t the_thread;
2201 pthread_attr_t attrs;
2203 pthread_attr_init(&attrs);
2204 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
2205 child_id = (pthread_create(&the_thread, &attrs,
2206 (void*)serve, csp) ? -1 : 0);
2207 pthread_attr_destroy(&attrs);
2211 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
2212 #define SELECTED_ONE_OPTION
2213 child_id = _beginthread(
2214 (void (*)(void *))serve,
2219 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
2220 #define SELECTED_ONE_OPTION
2221 child_id = _beginthread(
2222 (void(* _Optlink)(void*))serve,
2228 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
2229 #define SELECTED_ONE_OPTION
2231 thread_id tid = spawn_thread
2232 (server_thread, "server", B_NORMAL_PRIORITY, csp);
2234 if ((tid >= 0) && (resume_thread(tid) == B_OK))
2236 child_id = (int) tid;
2245 #if defined(AMIGA) && !defined(SELECTED_ONE_OPTION)
2246 #define SELECTED_ONE_OPTION
2247 csp->cfd = ReleaseSocket(csp->cfd, -1);
2248 if((child_id = (int)CreateNewProcTags(
2249 NP_Entry, (ULONG)server_thread,
2250 NP_Output, Output(),
2251 NP_CloseOutput, FALSE,
2252 NP_Name, (ULONG)"privoxy child",
2253 NP_StackSize, 200*1024,
2257 ((struct Task *)child_id)->tc_UserData = csp;
2258 Signal((struct Task *)child_id, SIGF_SINGLE);
2263 #if !defined(SELECTED_ONE_OPTION)
2266 /* This block is only needed when using fork().
2267 * When using threads, the server thread was
2268 * created and run by the call to _beginthread().
2270 if (child_id == 0) /* child */
2276 else if (child_id > 0) /* parent */
2278 /* in a fork()'d environment, the parent's
2279 * copy of the client socket and the CSP
2283 #if !defined(_WIN32) && defined(__CYGWIN__)
2285 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
2286 close_socket(csp->cfd);
2287 csp->flags &= ~CSP_FLAG_ACTIVE;
2291 #undef SELECTED_ONE_OPTION
2292 /* end of cpp switch () */
2294 if (child_id < 0) /* failed */
2296 char buf[BUFFER_SIZE];
2298 log_error(LOG_LEVEL_ERROR, "can't fork: %E");
2300 sprintf(buf , "Privoxy: can't fork: errno = %d", errno);
2302 write_socket(csp->cfd, buf, strlen(buf));
2303 close_socket(csp->cfd);
2304 csp->flags &= ~CSP_FLAG_ACTIVE;
2315 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
2317 /* Clean up. Aim: free all memory (no leaks) */
2318 #ifdef FEATURE_GRACEFUL_TERMINATION
2320 log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
2322 unload_current_config_file();
2323 unload_current_actions_file();
2324 unload_current_re_filterfile();
2325 #ifdef FEATURE_TRUST
2326 unload_current_trust_file();
2329 if (config->multi_threaded)
2336 } while ((clients->next != NULL) && (--i > 0));
2340 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
2349 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
2350 /* Cleanup - remove taskbar icon etc. */
2355 #endif /* FEATURE_GRACEFUL_TERMINATION */