1 const char jcc_rcs[] = "$Id: jcc.c,v 1.401 2012/10/21 12:58:03 fabiankeil 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-2012 the
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.
34 *********************************************************************/
40 #include <sys/types.h>
49 # ifndef FEATURE_PTHREAD
55 # endif /* ndef FEATURE_PTHREAD */
60 # endif /* ndef _WIN_CONSOLE */
61 # include "w32svrapi.h"
63 #else /* ifndef _WIN32 */
65 # if !defined (__OS2__)
67 # include <sys/wait.h>
68 # endif /* ndef __OS2__ */
69 # include <sys/time.h>
70 # include <sys/stat.h>
71 # include <sys/ioctl.h>
74 #include <sys/termios.h>
85 # include <socket.h> /* BeOS has select() for sockets only. */
86 # include <OS.h> /* declarations for threads and stuff. */
89 # if defined(__EMX__) || defined(__OS2__)
90 # include <sys/select.h> /* OS/2/EMX needs a little help with select */
95 #define bzero(B,N) memset(B,0x00,n)
110 #include "miscutil.h"
112 #include "jbsockets.h"
117 #include "urlmatch.h"
119 const char jcc_h_rcs[] = JCC_H_VERSION;
120 const char project_h_rcs[] = PROJECT_H_VERSION;
123 struct client_states clients[1];
124 struct file_list files[1];
126 #ifdef FEATURE_STATISTICS
127 int urls_read = 0; /* total nr of urls read inc rejected */
128 int urls_rejected = 0; /* total nr of urls rejected */
129 #endif /* def FEATURE_STATISTICS */
131 #ifdef FEATURE_GRACEFUL_TERMINATION
135 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
136 static void sig_handler(int the_signal);
138 static int client_protocol_is_unsupported(const struct client_state *csp, char *req);
139 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers);
140 static jb_err get_server_headers(struct client_state *csp);
141 static const char *crunch_reason(const struct http_response *rsp);
142 static void send_crunch_response(const struct client_state *csp, struct http_response *rsp);
143 static char *get_request_line(struct client_state *csp);
144 static jb_err receive_client_request(struct client_state *csp);
145 static jb_err parse_client_request(struct client_state *csp);
146 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line);
147 static jb_err change_request_destination(struct client_state *csp);
148 static void chat(struct client_state *csp);
149 static void serve(struct client_state *csp);
150 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
151 static void usage(const char *myname);
153 static void initialize_mutexes(void);
154 static jb_socket bind_port_helper(const char *haddr, int hport);
155 static void bind_ports_helper(struct configuration_spec *config, jb_socket sockets[]);
156 static void close_ports_helper(jb_socket sockets[]);
157 static void listen_loop(void);
160 void serve(struct client_state *csp);
161 #else /* ifndef AMIGA */
162 static void serve(struct client_state *csp);
163 #endif /* def AMIGA */
166 static int32 server_thread(void *data);
167 #endif /* def __BEOS__ */
170 #define sleep(N) Sleep(((N) * 1000))
174 #define sleep(N) DosSleep(((N) * 100))
177 #ifdef MUTEX_LOCKS_AVAILABLE
179 * XXX: Does the locking stuff really belong in this file?
181 privoxy_mutex_t log_mutex;
182 privoxy_mutex_t log_init_mutex;
183 privoxy_mutex_t connection_reuse_mutex;
185 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
186 privoxy_mutex_t resolver_mutex;
187 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
189 #ifndef HAVE_GMTIME_R
190 privoxy_mutex_t gmtime_mutex;
191 #endif /* ndef HAVE_GMTIME_R */
193 #ifndef HAVE_LOCALTIME_R
194 privoxy_mutex_t localtime_mutex;
195 #endif /* ndef HAVE_GMTIME_R */
198 privoxy_mutex_t rand_mutex;
199 #endif /* ndef HAVE_RANDOM */
201 #endif /* def MUTEX_LOCKS_AVAILABLE */
204 const char *basedir = NULL;
205 const char *pidfile = NULL;
206 static int received_hup_signal = 0;
207 #endif /* defined unix */
209 /* HTTP snipplets. */
210 static const char CSUCCEED[] =
211 "HTTP/1.1 200 Connection established\r\n"
212 "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
214 static const char CHEADER[] =
215 "HTTP/1.1 400 Invalid header received from client\r\n"
216 "Proxy-Agent: Privoxy " VERSION "\r\n"
217 "Content-Type: text/plain\r\n"
218 "Connection: close\r\n\r\n"
219 "Invalid header received from client.\r\n";
221 static const char FTP_RESPONSE[] =
222 "HTTP/1.1 400 Invalid request received from client\r\n"
223 "Content-Type: text/plain\r\n"
224 "Connection: close\r\n\r\n"
225 "Invalid request. Privoxy doesn't support FTP.\r\n";
227 static const char GOPHER_RESPONSE[] =
228 "HTTP/1.1 400 Invalid request received from client\r\n"
229 "Content-Type: text/plain\r\n"
230 "Connection: close\r\n\r\n"
231 "Invalid request. Privoxy doesn't support gopher.\r\n";
233 /* XXX: should be a template */
234 static const char MISSING_DESTINATION_RESPONSE[] =
235 "HTTP/1.1 400 Bad request received from client\r\n"
236 "Proxy-Agent: Privoxy " VERSION "\r\n"
237 "Content-Type: text/plain\r\n"
238 "Connection: close\r\n\r\n"
239 "Bad request. Privoxy was unable to extract the destination.\r\n";
241 /* XXX: should be a template */
242 static const char INVALID_SERVER_HEADERS_RESPONSE[] =
243 "HTTP/1.1 502 Server or forwarder response invalid\r\n"
244 "Proxy-Agent: Privoxy " VERSION "\r\n"
245 "Content-Type: text/plain\r\n"
246 "Connection: close\r\n\r\n"
247 "Bad response. The server or forwarder response doesn't look like HTTP.\r\n";
249 /* XXX: should be a template */
250 static const char MESSED_UP_REQUEST_RESPONSE[] =
251 "HTTP/1.1 400 Malformed request after rewriting\r\n"
252 "Proxy-Agent: Privoxy " VERSION "\r\n"
253 "Content-Type: text/plain\r\n"
254 "Connection: close\r\n\r\n"
255 "Bad request. Messed up with header filters.\r\n";
257 static const char TOO_MANY_CONNECTIONS_RESPONSE[] =
258 "HTTP/1.1 503 Too many open connections\r\n"
259 "Proxy-Agent: Privoxy " VERSION "\r\n"
260 "Content-Type: text/plain\r\n"
261 "Connection: close\r\n\r\n"
262 "Maximum number of open connections reached.\r\n";
264 static const char CLIENT_CONNECTION_TIMEOUT_RESPONSE[] =
265 "HTTP/1.1 504 Connection timeout\r\n"
266 "Proxy-Agent: Privoxy " VERSION "\r\n"
267 "Content-Type: text/plain\r\n"
268 "Connection: close\r\n\r\n"
269 "The connection timed out because the client request didn't arrive in time.\r\n";
271 /* A function to crunch a response */
272 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
274 /* Crunch function flags */
275 #define CF_NO_FLAGS 0
276 /* Cruncher applies to forced requests as well */
277 #define CF_IGNORE_FORCE 1
278 /* Crunched requests are counted for the block statistics */
279 #define CF_COUNT_AS_REJECT 2
281 /* A crunch function and its flags */
284 const crunch_func_ptr cruncher;
288 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
290 /* Complete list of cruncher functions */
291 static const struct cruncher crunchers_all[] = {
292 { direct_response, CF_COUNT_AS_REJECT|CF_IGNORE_FORCE},
293 { block_url, CF_COUNT_AS_REJECT },
295 { trust_url, CF_COUNT_AS_REJECT },
296 #endif /* def FEATURE_TRUST */
297 { redirect_url, CF_NO_FLAGS },
298 { dispatch_cgi, CF_IGNORE_FORCE},
302 /* Light version, used after tags are applied */
303 static const struct cruncher crunchers_light[] = {
304 { block_url, CF_COUNT_AS_REJECT },
305 { redirect_url, CF_NO_FLAGS },
311 * XXX: Don't we really mean
317 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
318 /*********************************************************************
320 * Function : sig_handler
322 * Description : Signal handler for different signals.
323 * Exit gracefully on TERM and INT
324 * or set a flag that will cause the errlog
325 * to be reopened by the main thread on HUP.
328 * 1 : the_signal = the signal cause this function to call
332 *********************************************************************/
333 static void sig_handler(int the_signal)
339 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
351 received_hup_signal = 1;
357 * We shouldn't be here, unless we catch signals
358 * in main() that we can't handle here!
360 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
368 /*********************************************************************
370 * Function : client_protocol_is_unsupported
372 * Description : Checks if the client used a known unsupported
373 * protocol and deals with it by sending an error
377 * 1 : csp = Current client state (buffers, headers, etc...)
378 * 2 : req = the first request line send by the client
380 * Returns : TRUE if an error response has been generated, or
381 * FALSE if the request doesn't look invalid.
383 *********************************************************************/
384 static int client_protocol_is_unsupported(const struct client_state *csp, char *req)
387 * If it's a FTP or gopher request, we don't support it.
389 * These checks are better than nothing, but they might
390 * not work in all configurations and some clients might
391 * have problems digesting the answer.
393 * They should, however, never cause more problems than
394 * Privoxy's old behaviour (returning the misleading HTML
397 * "Could not resolve http://(ftp|gopher)://example.org").
399 if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
401 const char *response = NULL;
402 const char *protocol = NULL;
404 if (!strncmpic(req, "GET ftp://", 10))
406 response = FTP_RESPONSE;
411 response = GOPHER_RESPONSE;
414 log_error(LOG_LEVEL_ERROR,
415 "%s tried to use Privoxy as %s proxy: %s",
416 csp->ip_addr_str, protocol, req);
417 log_error(LOG_LEVEL_CLF,
418 "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, req);
420 write_socket(csp->cfd, response, strlen(response));
429 /*********************************************************************
431 * Function : get_request_destination_elsewhere
433 * Description : If the client's request was redirected into
434 * Privoxy without the client's knowledge,
435 * the request line lacks the destination host.
437 * This function tries to get it elsewhere,
438 * provided accept-intercepted-requests is enabled.
440 * "Elsewhere" currently only means "Host: header",
441 * but in the future we may ask the redirecting
442 * packet filter to look the destination up.
444 * If the destination stays unknown, an error
445 * response is send to the client and headers
446 * are freed so that chat() can return directly.
449 * 1 : csp = Current client state (buffers, headers, etc...)
450 * 2 : headers = a header list
452 * Returns : JB_ERR_OK if the destination is now known, or
453 * JB_ERR_PARSE if it isn't.
455 *********************************************************************/
456 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
460 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
462 log_error(LOG_LEVEL_ERROR, "%s's request: \'%s\' is invalid."
463 " Privoxy isn't configured to accept intercepted requests.",
464 csp->ip_addr_str, csp->http->cmd);
465 /* XXX: Use correct size */
466 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
467 csp->ip_addr_str, csp->http->cmd);
469 write_socket(csp->cfd, CHEADER, strlen(CHEADER));
470 destroy_list(headers);
474 else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
476 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
477 /* Split the domain we just got for pattern matching */
478 init_domain_components(csp->http);
485 /* We can't work without destination. Go spread the news.*/
487 req = list_to_text(headers);
489 /* XXX: Use correct size */
490 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
491 csp->ip_addr_str, csp->http->cmd);
492 log_error(LOG_LEVEL_ERROR,
493 "Privoxy was unable to get the destination for %s's request:\n%s\n%s",
494 csp->ip_addr_str, csp->http->cmd, req);
497 write_socket(csp->cfd, MISSING_DESTINATION_RESPONSE, strlen(MISSING_DESTINATION_RESPONSE));
498 destroy_list(headers);
503 * TODO: If available, use PF's ioctl DIOCNATLOOK as last resort
504 * to get the destination IP address, use it as host directly
505 * or do a reverse DNS lookup first.
510 /*********************************************************************
512 * Function : get_server_headers
514 * Description : Parses server headers in iob and fills them
515 * into csp->headers so that they can later be
519 * 1 : csp = Current client state (buffers, headers, etc...)
521 * Returns : JB_ERR_OK if everything went fine, or
522 * JB_ERR_PARSE if the headers were incomplete.
524 *********************************************************************/
525 static jb_err get_server_headers(struct client_state *csp)
527 int continue_hack_in_da_house = 0;
530 while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
535 * continue hack in da house. Ignore the ending of
536 * this head and continue enlisting header lines.
537 * The reason is described below.
539 enlist(csp->headers, "");
540 continue_hack_in_da_house = 0;
543 else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
546 * It's a bodyless continue response, don't
547 * stop header parsing after reaching its end.
549 * As a result Privoxy will concatenate the
550 * next response's head and parse and deliver
551 * the headers as if they belonged to one request.
553 * The client will separate them because of the
554 * empty line between them.
556 * XXX: What we're doing here is clearly against
557 * the intended purpose of the continue header,
558 * and under some conditions (HTTP/1.0 client request)
559 * it's a standard violation.
561 * Anyway, "sort of against the spec" is preferable
562 * to "always getting confused by Continue responses"
563 * (Privoxy's behaviour before this hack was added)
565 log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
566 continue_hack_in_da_house = 1;
568 else if (*header == '\0')
571 * If the header is empty, but the Continue hack
572 * isn't active, we can assume that we reached the
573 * end of the buffer before we hit the end of the
576 * Inform the caller an let it decide how to handle it.
581 if (JB_ERR_MEMORY == enlist(csp->headers, header))
584 * XXX: Should we quit the request and return a
585 * out of memory error page instead?
587 log_error(LOG_LEVEL_ERROR,
588 "Out of memory while enlisting server headers. %s lost.",
598 /*********************************************************************
600 * Function : crunch_reason
602 * Description : Translates the crunch reason code into a string.
605 * 1 : rsp = a http_response
607 * Returns : A string with the crunch reason or an error description.
609 *********************************************************************/
610 static const char *crunch_reason(const struct http_response *rsp)
612 char * reason = NULL;
617 return "Internal error while searching for crunch reason";
620 switch (rsp->crunch_reason)
623 reason = "Unsupported HTTP feature";
629 reason = "Untrusted";
632 reason = "Redirected";
638 reason = "DNS failure";
640 case FORWARDING_FAILED:
641 reason = "Forwarding failed";
644 reason = "Connection failure";
647 reason = "Out of memory (may mask other reasons)";
649 case CONNECTION_TIMEOUT:
650 reason = "Connection timeout";
653 reason = "No server data received";
656 reason = "No reason recorded";
664 /*********************************************************************
666 * Function : log_applied_actions
668 * Description : Logs the applied actions if LOG_LEVEL_ACTIONS is
672 * 1 : actions = Current action spec to log
676 *********************************************************************/
677 static void log_applied_actions(const struct current_action_spec *actions)
680 * The conversion to text requires lots of memory allocations so
681 * we only do the conversion if the user is actually interested.
683 if (debug_level_is_enabled(LOG_LEVEL_ACTIONS))
685 char *actions_as_text = actions_to_line_of_text(actions);
686 log_error(LOG_LEVEL_ACTIONS, "%s", actions_as_text);
687 freez(actions_as_text);
692 /*********************************************************************
694 * Function : send_crunch_response
696 * Description : Delivers already prepared response for
697 * intercepted requests, logs the interception
698 * and frees the response.
701 * 1 : csp = Current client state (buffers, headers, etc...)
702 * 1 : rsp = Fully prepared response. Will be freed on exit.
706 *********************************************************************/
707 static void send_crunch_response(const struct client_state *csp, struct http_response *rsp)
709 const struct http_request *http = csp->http;
713 assert(rsp->head != NULL);
717 log_error(LOG_LEVEL_FATAL, "NULL response in send_crunch_response.");
721 * Extract the status code from the actual head
722 * that will be send to the client. It is the only
723 * way to get it right for all requests, including
724 * the fixed ones for out-of-memory problems.
726 * A head starts like this: 'HTTP/1.1 200...'
730 status_code[0] = rsp->head[9];
731 status_code[1] = rsp->head[10];
732 status_code[2] = rsp->head[11];
733 status_code[3] = '\0';
735 /* Log that the request was crunched and why. */
736 log_applied_actions(csp->action);
737 log_error(LOG_LEVEL_CRUNCH, "%s: %s", crunch_reason(rsp), http->url);
738 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" %s %u",
739 csp->ip_addr_str, http->ocmd, status_code, rsp->content_length);
741 /* Write the answer to the client */
742 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
743 || write_socket(csp->cfd, rsp->body, rsp->content_length))
745 /* There is nothing we can do about it. */
746 log_error(LOG_LEVEL_ERROR,
747 "Couldn't deliver the error message through client socket %d: %E",
751 /* Clean up and return */
752 if (cgi_error_memory() != rsp)
754 free_http_response(rsp);
760 /*********************************************************************
762 * Function : crunch_response_triggered
764 * Description : Checks if the request has to be crunched,
765 * and delivers the crunch response if necessary.
768 * 1 : csp = Current client state (buffers, headers, etc...)
769 * 2 : crunchers = list of cruncher functions to run
771 * Returns : TRUE if the request was answered with a crunch response
774 *********************************************************************/
775 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
777 struct http_response *rsp = NULL;
778 const struct cruncher *c;
781 * If CGI request crunching is disabled,
782 * check the CGI dispatcher out of order to
783 * prevent unintentional blocks or redirects.
785 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
786 && (NULL != (rsp = dispatch_cgi(csp))))
788 /* Deliver, log and free the interception response. */
789 send_crunch_response(csp, rsp);
790 csp->flags |= CSP_FLAG_CRUNCHED;
794 for (c = crunchers; c->cruncher != NULL; c++)
797 * Check the cruncher if either Privoxy is toggled
798 * on and the request isn't forced, or if the cruncher
799 * applies to forced requests as well.
801 if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
802 !(csp->flags & CSP_FLAG_FORCED)) ||
803 (c->flags & CF_IGNORE_FORCE))
805 rsp = c->cruncher(csp);
808 /* Deliver, log and free the interception response. */
809 send_crunch_response(csp, rsp);
810 csp->flags |= CSP_FLAG_CRUNCHED;
811 #ifdef FEATURE_STATISTICS
812 if (c->flags & CF_COUNT_AS_REJECT)
814 csp->flags |= CSP_FLAG_REJECTED;
816 #endif /* def FEATURE_STATISTICS */
827 /*********************************************************************
829 * Function : build_request_line
831 * Description : Builds the HTTP request line.
833 * If a HTTP forwarder is used it expects the whole URL,
834 * web servers only get the path.
837 * 1 : csp = Current client state (buffers, headers, etc...)
838 * 2 : fwd = The forwarding spec used for the request
839 * XXX: Should use http->fwd instead.
840 * 3 : request_line = The old request line which will be replaced.
842 * Returns : Nothing. Terminates in case of memory problems.
844 *********************************************************************/
845 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
847 struct http_request *http = csp->http;
849 assert(http->ssl == 0);
852 * Downgrade http version from 1.1 to 1.0
853 * if +downgrade action applies.
855 if ((csp->action->flags & ACTION_DOWNGRADE)
856 && (!strcmpic(http->ver, "HTTP/1.1")))
859 http->ver = strdup_or_die("HTTP/1.0");
863 * Rebuild the request line.
865 freez(*request_line);
866 *request_line = strdup(http->gpc);
867 string_append(request_line, " ");
869 if (fwd->forward_host)
871 string_append(request_line, http->url);
875 string_append(request_line, http->path);
877 string_append(request_line, " ");
878 string_append(request_line, http->ver);
880 if (*request_line == NULL)
882 log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
884 log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
888 /*********************************************************************
890 * Function : change_request_destination
892 * Description : Parse a (rewritten) request line and regenerate
893 * the http request data.
896 * 1 : csp = Current client state (buffers, headers, etc...)
898 * Returns : Forwards the parse_http_request() return code.
899 * Terminates in case of memory problems.
901 *********************************************************************/
902 static jb_err change_request_destination(struct client_state *csp)
904 struct http_request *http = csp->http;
907 log_error(LOG_LEVEL_INFO, "Rewrite detected: %s", csp->headers->first->str);
908 free_http_request(http);
909 err = parse_http_request(csp->headers->first->str, http);
910 if (JB_ERR_OK != err)
912 log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
913 jb_err_to_string(err));
917 /* XXX: ocmd is a misleading name */
918 http->ocmd = strdup_or_die(http->cmd);
925 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
926 /*********************************************************************
928 * Function : server_response_is_complete
930 * Description : Determines whether we should stop reading
931 * from the server socket.
934 * 1 : csp = Current client state (buffers, headers, etc...)
935 * 2 : content_length = Length of content received so far.
937 * Returns : TRUE if the response is complete,
940 *********************************************************************/
941 static int server_response_is_complete(struct client_state *csp,
942 unsigned long long content_length)
944 int content_length_known = !!(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
946 if (!strcmpic(csp->http->gpc, "HEAD"))
949 * "HEAD" implies no body, we are thus expecting
950 * no content. XXX: incomplete "list" of methods?
952 csp->expected_content_length = 0;
953 content_length_known = TRUE;
956 if (csp->http->status == 204 || csp->http->status == 304)
959 * Expect no body. XXX: incomplete "list" of status codes?
961 csp->expected_content_length = 0;
962 content_length_known = TRUE;
965 return (content_length_known && ((0 == csp->expected_content_length)
966 || (csp->expected_content_length <= content_length)));
970 #ifdef FEATURE_CONNECTION_SHARING
971 /*********************************************************************
973 * Function : wait_for_alive_connections
975 * Description : Waits for alive connections to timeout.
981 *********************************************************************/
982 static void wait_for_alive_connections(void)
984 int connections_alive = close_unusable_connections();
986 while (0 < connections_alive)
988 log_error(LOG_LEVEL_CONNECT,
989 "Waiting for %d connections to timeout.",
992 connections_alive = close_unusable_connections();
995 log_error(LOG_LEVEL_CONNECT, "No connections to wait for left.");
998 #endif /* def FEATURE_CONNECTION_SHARING */
1001 /*********************************************************************
1003 * Function : save_connection_destination
1005 * Description : Remembers a connection for reuse later on.
1008 * 1 : sfd = Open socket to remember.
1009 * 2 : http = The destination for the connection.
1010 * 3 : fwd = The forwarder settings used.
1011 * 3 : server_connection = storage.
1015 *********************************************************************/
1016 void save_connection_destination(jb_socket sfd,
1017 const struct http_request *http,
1018 const struct forward_spec *fwd,
1019 struct reusable_connection *server_connection)
1021 assert(sfd != JB_INVALID_SOCKET);
1022 assert(NULL != http->host);
1024 server_connection->sfd = sfd;
1025 server_connection->host = strdup_or_die(http->host);
1026 server_connection->port = http->port;
1028 assert(NULL != fwd);
1029 assert(server_connection->gateway_host == NULL);
1030 assert(server_connection->gateway_port == 0);
1031 assert(server_connection->forwarder_type == 0);
1032 assert(server_connection->forward_host == NULL);
1033 assert(server_connection->forward_port == 0);
1035 server_connection->forwarder_type = fwd->type;
1036 if (NULL != fwd->gateway_host)
1038 server_connection->gateway_host = strdup_or_die(fwd->gateway_host);
1042 server_connection->gateway_host = NULL;
1044 server_connection->gateway_port = fwd->gateway_port;
1046 if (NULL != fwd->forward_host)
1048 server_connection->forward_host = strdup_or_die(fwd->forward_host);
1052 server_connection->forward_host = NULL;
1054 server_connection->forward_port = fwd->forward_port;
1058 /*********************************************************************
1060 * Function : verify_request_length
1062 * Description : Checks if we already got the whole client requests
1063 * and sets CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ if
1066 * Data that doesn't belong to the current request is
1067 * thrown away to let the client retry on a clean socket.
1069 * XXX: This is a hack until we can deal with multiple
1070 * pipelined requests at the same time.
1074 * 1 : csp = Current client state (buffers, headers, etc...)
1078 *********************************************************************/
1079 static void verify_request_length(struct client_state *csp)
1081 unsigned long long buffered_request_bytes =
1082 (unsigned long long)(csp->client_iob->eod - csp->client_iob->cur);
1084 if ((csp->expected_client_content_length != 0)
1085 && (buffered_request_bytes != 0))
1087 if (csp->expected_client_content_length >= buffered_request_bytes)
1089 csp->expected_client_content_length -= buffered_request_bytes;
1090 log_error(LOG_LEVEL_CONNECT, "Reduced expected bytes to %llu "
1091 "to account for the %llu ones we already got.",
1092 csp->expected_client_content_length, buffered_request_bytes);
1096 assert(csp->client_iob->eod > csp->client_iob->cur + csp->expected_client_content_length);
1097 csp->client_iob->eod = csp->client_iob->cur + csp->expected_client_content_length;
1098 log_error(LOG_LEVEL_CONNECT, "Reducing expected bytes to 0. "
1099 "Marking the server socket tainted after throwing %llu bytes away.",
1100 buffered_request_bytes - csp->expected_client_content_length);
1101 csp->expected_client_content_length = 0;
1102 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1105 if (csp->expected_client_content_length == 0)
1107 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1111 if (!(csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ)
1112 && ((csp->client_iob->cur[0] != '\0') || (csp->expected_client_content_length != 0)))
1114 if (strcmpic(csp->http->gpc, "GET")
1115 && strcmpic(csp->http->gpc, "HEAD")
1116 && strcmpic(csp->http->gpc, "TRACE")
1117 && strcmpic(csp->http->gpc, "OPTIONS")
1118 && strcmpic(csp->http->gpc, "DELETE"))
1120 /* XXX: this is an incomplete hack */
1121 csp->flags &= ~CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1122 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1123 log_error(LOG_LEVEL_CONNECT,
1124 "There might be a request body. The connection will not be kept alive.");
1128 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1130 if ((csp->config->feature_flags & RUNTIME_FEATURE_TOLERATE_PIPELINING) == 0)
1132 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1133 log_error(LOG_LEVEL_CONNECT,
1134 "Possible pipeline attempt detected. The connection will not "
1135 "be kept alive and we will only serve the first request.");
1136 /* Nuke the pipelined requests from orbit, just to be sure. */
1137 clear_iob(csp->client_iob);
1142 * Keep the pipelined data around for now, we'll deal with
1143 * it once we're done serving the current request.
1145 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
1146 assert(csp->client_iob->eod > csp->client_iob->cur);
1147 log_error(LOG_LEVEL_CONNECT, "Complete client request followed by "
1148 "%d bytes of pipelined data received.",
1149 (int)(csp->client_iob->eod - csp->client_iob->cur));
1155 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1156 log_error(LOG_LEVEL_CONNECT, "Complete client request received.");
1159 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1162 /*********************************************************************
1164 * Function : mark_server_socket_tainted
1166 * Description : Makes sure we don't reuse a server socket
1167 * (if we didn't read everything the server sent
1168 * us reusing the socket would lead to garbage).
1171 * 1 : csp = Current client state (buffers, headers, etc...)
1175 *********************************************************************/
1176 static void mark_server_socket_tainted(struct client_state *csp)
1179 * For consistency we always mark the server socket
1180 * tainted, however, to reduce the log noise we only
1181 * emit a log message if the server socket could have
1182 * actually been reused.
1184 if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
1185 && !(csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED))
1187 log_error(LOG_LEVEL_CONNECT,
1188 "Marking the server socket %d tainted.",
1189 csp->server_connection.sfd);
1191 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1194 /*********************************************************************
1196 * Function : get_request_line
1198 * Description : Read the client request line.
1201 * 1 : csp = Current client state (buffers, headers, etc...)
1203 * Returns : Pointer to request line or NULL in case of errors.
1205 *********************************************************************/
1206 static char *get_request_line(struct client_state *csp)
1208 char buf[BUFFER_SIZE];
1209 char *request_line = NULL;
1212 memset(buf, 0, sizeof(buf));
1214 if ((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
1217 * If there are multiple pipelined requests waiting,
1218 * the flag will be set again once the next request
1221 csp->flags &= ~CSP_FLAG_PIPELINED_REQUEST_WAITING;
1223 request_line = get_header(csp->client_iob);
1224 if ((NULL != request_line) && ('\0' != *request_line))
1226 return request_line;
1230 log_error(LOG_LEVEL_CONNECT, "No complete request line "
1231 "received yet. Continuing reading from %d.", csp->cfd);
1237 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1239 if (socket_is_still_alive(csp->cfd))
1241 log_error(LOG_LEVEL_CONNECT,
1242 "No request line on socket %d received in time. Timeout: %d.",
1243 csp->cfd, csp->config->socket_timeout);
1244 write_socket(csp->cfd, CLIENT_CONNECTION_TIMEOUT_RESPONSE,
1245 strlen(CLIENT_CONNECTION_TIMEOUT_RESPONSE));
1249 log_error(LOG_LEVEL_CONNECT,
1250 "The client side of the connection on socket %d got "
1251 "closed without sending a complete request line.", csp->cfd);
1256 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1258 if (len <= 0) return NULL;
1261 * If there is no memory left for buffering the
1262 * request, there is nothing we can do but hang up
1264 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1269 request_line = get_header(csp->client_iob);
1271 } while ((NULL != request_line) && ('\0' == *request_line));
1273 return request_line;
1278 /*********************************************************************
1280 * Function : receive_client_request
1282 * Description : Read the client's request (more precisely the
1283 * client headers) and answer it if necessary.
1286 * 1 : csp = Current client state (buffers, headers, etc...)
1288 * Returns : JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
1290 *********************************************************************/
1291 static jb_err receive_client_request(struct client_state *csp)
1293 char buf[BUFFER_SIZE];
1296 struct http_request *http;
1300 /* Temporary copy of the client's headers before they get enlisted in csp->headers */
1301 struct list header_list;
1302 struct list *headers = &header_list;
1306 memset(buf, 0, sizeof(buf));
1308 req = get_request_line(csp);
1311 mark_server_socket_tainted(csp);
1312 return JB_ERR_PARSE;
1314 assert(*req != '\0');
1316 if (client_protocol_is_unsupported(csp, req))
1318 return JB_ERR_PARSE;
1321 #ifdef FEATURE_FORCE_LOAD
1323 * If this request contains the FORCE_PREFIX and blocks
1324 * aren't enforced, get rid of it and set the force flag.
1326 if (strstr(req, FORCE_PREFIX))
1328 if (csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
1330 log_error(LOG_LEVEL_FORCE,
1331 "Ignored force prefix in request: \"%s\".", req);
1335 strclean(req, FORCE_PREFIX);
1336 log_error(LOG_LEVEL_FORCE, "Enforcing request: \"%s\".", req);
1337 csp->flags |= CSP_FLAG_FORCED;
1340 #endif /* def FEATURE_FORCE_LOAD */
1342 err = parse_http_request(req, http);
1344 if (JB_ERR_OK != err)
1346 write_socket(csp->cfd, CHEADER, strlen(CHEADER));
1347 /* XXX: Use correct size */
1348 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1349 log_error(LOG_LEVEL_ERROR,
1350 "Couldn't parse request line received from %s: %s",
1351 csp->ip_addr_str, jb_err_to_string(err));
1353 free_http_request(http);
1354 return JB_ERR_PARSE;
1357 /* grab the rest of the client's headers */
1361 p = get_header(csp->client_iob);
1365 /* There are no additional headers to read. */
1372 * We didn't receive a complete header
1373 * line yet, get the rest of it.
1375 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1377 log_error(LOG_LEVEL_ERROR,
1378 "Stopped grabbing the client headers.");
1379 destroy_list(headers);
1380 return JB_ERR_PARSE;
1383 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1386 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1387 destroy_list(headers);
1388 return JB_ERR_PARSE;
1391 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1394 * If there is no memory left for buffering the
1395 * request, there is nothing we can do but hang up
1397 destroy_list(headers);
1398 return JB_ERR_MEMORY;
1404 * We were able to read a complete
1405 * header and can finally enlist it.
1412 if (http->host == NULL)
1415 * If we still don't know the request destination,
1416 * the request is invalid or the client uses
1417 * Privoxy without its knowledge.
1419 if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1422 * Our attempts to get the request destination
1423 * elsewhere failed or Privoxy is configured
1424 * to only accept proxy requests.
1426 * An error response has already been send
1427 * and we're done here.
1429 return JB_ERR_PARSE;
1434 * Determine the actions for this URL
1436 #ifdef FEATURE_TOGGLE
1437 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1439 /* Most compatible set of actions (i.e. none) */
1440 init_current_action(csp->action);
1443 #endif /* ndef FEATURE_TOGGLE */
1445 get_url_actions(csp, http);
1449 * Save a copy of the original request for logging
1451 http->ocmd = strdup_or_die(http->cmd);
1452 enlist(csp->headers, http->cmd);
1454 /* Append the previously read headers */
1455 list_append_list_unique(csp->headers, headers);
1456 destroy_list(headers);
1463 /*********************************************************************
1465 * Function : parse_client_request
1467 * Description : Parses the client's request and decides what to do
1470 * Note that since we're not using select() we could get
1471 * blocked here if a client connected, then didn't say
1475 * 1 : csp = Current client state (buffers, headers, etc...)
1477 * Returns : JB_ERR_OK or JB_ERR_PARSE
1479 *********************************************************************/
1480 static jb_err parse_client_request(struct client_state *csp)
1482 struct http_request *http = csp->http;
1485 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1486 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1487 && (!strcmpic(csp->http->ver, "HTTP/1.1"))
1488 && (csp->http->ssl == 0))
1490 /* Assume persistence until further notice */
1491 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1494 if (csp->http->ssl == 0)
1496 csp->expected_client_content_length = get_expected_content_length(csp->headers);
1497 verify_request_length(csp);
1499 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1501 err = sed(csp, FILTER_CLIENT_HEADERS);
1502 if (JB_ERR_OK != err)
1504 /* XXX: Should be handled in sed(). */
1505 assert(err == JB_ERR_PARSE);
1506 log_error(LOG_LEVEL_FATAL, "Failed to parse client headers.");
1508 csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1510 /* Check request line for rewrites. */
1511 if ((NULL == csp->headers->first->str)
1512 || (strcmp(http->cmd, csp->headers->first->str) &&
1513 (JB_ERR_OK != change_request_destination(csp))))
1516 * A header filter broke the request line - bail out.
1518 write_socket(csp->cfd, MESSED_UP_REQUEST_RESPONSE, strlen(MESSED_UP_REQUEST_RESPONSE));
1519 /* XXX: Use correct size */
1520 log_error(LOG_LEVEL_CLF,
1521 "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
1522 log_error(LOG_LEVEL_ERROR,
1523 "Invalid request line after applying header filters.");
1524 free_http_request(http);
1526 return JB_ERR_PARSE;
1534 /*********************************************************************
1538 * Description : Once a connection from the client has been accepted,
1539 * this function is called (via serve()) to handle the
1540 * main business of the communication. This function
1541 * returns after dealing with a single request. It can
1542 * be called multiple times with the same client socket
1543 * if the client is keeping the connection alive.
1545 * The decision whether or not a client connection will
1546 * be kept alive is up to the caller which also must
1547 * close the client socket when done.
1549 * FIXME: chat is nearly thousand lines long.
1553 * 1 : csp = Current client state (buffers, headers, etc...)
1555 * Returns : Nothing.
1557 *********************************************************************/
1558 static void chat(struct client_state *csp)
1560 char buf[BUFFER_SIZE];
1567 int ms_iis5_hack = 0;
1568 unsigned long long byte_count = 0;
1569 const struct forward_spec *fwd;
1570 struct http_request *http;
1571 long len = 0; /* for buffer sizes (and negative error codes) */
1572 int buffer_and_filter_content = 0;
1574 /* Skeleton for HTTP response, if we should intercept the request */
1575 struct http_response *rsp;
1576 struct timeval timeout;
1577 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1578 int watch_client_socket;
1581 memset(buf, 0, sizeof(buf));
1585 if (receive_client_request(csp) != JB_ERR_OK)
1589 if (parse_client_request(csp) != JB_ERR_OK)
1594 /* decide how to route the HTTP request */
1595 fwd = forward_url(csp, http);
1598 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!? This can't happen!");
1599 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1604 * build the http request to send to the server
1605 * we have to do one of the following:
1607 * create = use the original HTTP request to create a new
1608 * HTTP request that has either the path component
1609 * without the http://domainspec (w/path) or the
1610 * full orininal URL (w/url)
1611 * Note that the path and/or the HTTP version may
1612 * have been altered by now.
1614 * connect = Open a socket to the host:port of the server
1615 * and short-circuit server and client socket.
1617 * pass = Pass the request unchanged if forwarding a CONNECT
1618 * request to a parent proxy. Note that we'll be sending
1619 * the CFAIL message ourselves if connecting to the parent
1620 * fails, but we won't send a CSUCCEED message if it works,
1621 * since that would result in a double message (ours and the
1622 * parent's). After sending the request to the parent, we simply
1625 * here's the matrix:
1628 * +--------+--------+
1630 * 0 | create | connect|
1632 * Forwarding +--------+--------+
1634 * 1 | create | pass |
1636 * +--------+--------+
1640 if (http->ssl && connect_port_is_forbidden(csp))
1642 const char *acceptable_connect_ports =
1643 csp->action->string[ACTION_STRING_LIMIT_CONNECT];
1644 assert(NULL != acceptable_connect_ports);
1645 log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
1646 "limit-connect{%s} doesn't allow CONNECT requests to %s",
1647 csp->ip_addr_str, acceptable_connect_ports, csp->http->hostport);
1648 csp->action->flags |= ACTION_BLOCK;
1654 freez(csp->headers->first->str);
1655 build_request_line(csp, fwd, &csp->headers->first->str);
1659 * We have a request. Check if one of the crunchers wants it.
1661 if (crunch_response_triggered(csp, crunchers_all))
1664 * Yes. The client got the crunch response and we're done here.
1669 log_applied_actions(csp->action);
1670 log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
1672 if (fwd->forward_host)
1674 log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
1675 fwd->forward_host, fwd->forward_port, http->hostport);
1679 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
1682 /* here we connect to the server, gateway, or the forwarder */
1684 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1685 if ((csp->server_connection.sfd != JB_INVALID_SOCKET)
1686 && socket_is_still_alive(csp->server_connection.sfd)
1687 && connection_destination_matches(&csp->server_connection, http, fwd))
1689 log_error(LOG_LEVEL_CONNECT,
1690 "Reusing server socket %d connected to %s. Total requests: %u.",
1691 csp->server_connection.sfd, csp->server_connection.host,
1692 csp->server_connection.requests_sent_total);
1696 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
1698 log_error(LOG_LEVEL_CONNECT,
1699 "Closing server socket %u. Opened for %s.",
1700 csp->server_connection.sfd, csp->server_connection.host);
1701 close_socket(csp->server_connection.sfd);
1702 mark_connection_closed(&csp->server_connection);
1704 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1706 csp->server_connection.sfd = forwarded_connect(fwd, http, csp);
1708 if (csp->server_connection.sfd == JB_INVALID_SOCKET)
1710 if (fwd->type != SOCKS_NONE)
1713 rsp = error_response(csp, "forwarding-failed");
1715 else if (errno == EINVAL)
1717 rsp = error_response(csp, "no-such-domain");
1721 rsp = error_response(csp, "connect-failed");
1724 /* Write the answer to the client */
1727 send_crunch_response(csp, rsp);
1732 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1733 save_connection_destination(csp->server_connection.sfd,
1734 http, fwd, &csp->server_connection);
1735 csp->server_connection.keep_alive_timeout =
1736 (unsigned)csp->config->keep_alive_timeout;
1738 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1740 csp->server_connection.requests_sent_total++;
1742 if (fwd->forward_host || (http->ssl == 0))
1745 hdr = list_to_text(csp->headers);
1748 /* FIXME Should handle error properly */
1749 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
1751 list_remove_all(csp->headers);
1754 * Write the client's (modified) header to the server
1755 * (along with anything else that may be in the buffer)
1757 write_failure = 0 != write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
1762 log_error(LOG_LEVEL_CONNECT,
1763 "Failed sending request headers to: %s: %E", http->hostport);
1765 else if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
1766 && (flush_socket(csp->server_connection.sfd, csp->client_iob) < 0))
1769 log_error(LOG_LEVEL_CONNECT,
1770 "Failed sending request body to: %s: %E", http->hostport);
1775 rsp = error_response(csp, "connect-failed");
1778 send_crunch_response(csp, rsp);
1786 * We're running an SSL tunnel and we're not forwarding,
1787 * so just ditch the client headers, send the "connect succeeded"
1788 * message to the client, flush the rest, and get out of the way.
1790 list_remove_all(csp->headers);
1791 if (write_socket(csp->cfd, CSUCCEED, strlen(CSUCCEED)))
1795 clear_iob(csp->client_iob);
1798 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
1800 csp->server_connection.request_sent = time(NULL);
1802 maxfd = (csp->cfd > csp->server_connection.sfd) ?
1803 csp->cfd : csp->server_connection.sfd;
1805 /* pass data between the client and server
1806 * until one or the other shuts down the connection.
1811 watch_client_socket = 0 == (csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING);
1817 * FD_ZERO here seems to point to an errant macro which crashes.
1818 * So do this by hand for now...
1820 memset(&rfds,0x00,sizeof(fd_set));
1824 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1825 if (!watch_client_socket)
1827 maxfd = csp->server_connection.sfd;
1830 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1832 FD_SET(csp->cfd, &rfds);
1835 FD_SET(csp->server_connection.sfd, &rfds);
1837 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1838 if ((csp->flags & CSP_FLAG_CHUNKED)
1839 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
1840 && ((csp->iob->eod - csp->iob->cur) >= 5)
1841 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
1844 * XXX: This check should be obsolete now,
1845 * but let's wait a while to be sure.
1847 log_error(LOG_LEVEL_CONNECT,
1848 "Looks like we got the last chunk together with "
1849 "the server headers but didn't detect it earlier. "
1850 "We better stop reading.");
1851 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
1852 csp->expected_content_length = byte_count;
1853 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
1855 if (server_body && server_response_is_complete(csp, byte_count))
1857 if (csp->expected_content_length == byte_count)
1859 log_error(LOG_LEVEL_CONNECT,
1860 "Done reading from server. Content length: %llu as expected. "
1861 "Bytes most recently read: %d.",
1866 log_error(LOG_LEVEL_CONNECT,
1867 "Done reading from server. Expected content length: %llu. "
1868 "Actual content length: %llu. Bytes most recently read: %d.",
1869 csp->expected_content_length, byte_count, len);
1873 * XXX: should not jump around,
1874 * chat() is complicated enough already.
1878 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1880 timeout.tv_sec = csp->config->socket_timeout;
1881 timeout.tv_usec = 0;
1882 n = select((int)maxfd+1, &rfds, NULL, NULL, &timeout);
1886 log_error(LOG_LEVEL_ERROR,
1887 "Didn't receive data in time: %s", http->url);
1888 if ((byte_count == 0) && (http->ssl == 0))
1890 send_crunch_response(csp, error_response(csp, "connection-timeout"));
1892 mark_server_socket_tainted(csp);
1897 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
1898 mark_server_socket_tainted(csp);
1903 * This is the body of the browser's request,
1904 * just read and write it.
1906 * XXX: Make sure the client doesn't use pipelining
1907 * behind Privoxy's back.
1909 if (FD_ISSET(csp->cfd, &rfds))
1911 int max_bytes_to_read = sizeof(buf) - 1;
1913 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1914 if ((csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ))
1916 if (data_is_available(csp->cfd, 0))
1919 * If the next request is already waiting, we have
1920 * to stop select()ing the client socket. Otherwise
1921 * we would always return right away and get nothing
1924 watch_client_socket = 0;
1925 log_error(LOG_LEVEL_CONNECT,
1926 "Stopping to watch the client socket %d. "
1927 "There's already another request waiting.",
1932 * If the client socket is set, but there's no data
1933 * available on the socket, the client went fishing
1934 * and continuing talking to the server makes no sense.
1936 log_error(LOG_LEVEL_CONNECT,
1937 "The client closed socket %d while "
1938 "the server socket %d is still open.",
1939 csp->cfd, csp->server_connection.sfd);
1940 mark_server_socket_tainted(csp);
1943 if (csp->expected_client_content_length != 0)
1945 if (csp->expected_client_content_length < (sizeof(buf) - 1))
1947 max_bytes_to_read = (int)csp->expected_client_content_length;
1949 log_error(LOG_LEVEL_CONNECT,
1950 "Waiting for up to %d bytes from the client.",
1953 assert(max_bytes_to_read < sizeof(buf));
1954 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1956 len = read_socket(csp->cfd, buf, max_bytes_to_read);
1960 /* XXX: not sure if this is necessary. */
1961 mark_server_socket_tainted(csp);
1962 break; /* "game over, man" */
1965 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1966 if (csp->expected_client_content_length != 0)
1968 assert(len <= max_bytes_to_read);
1969 csp->expected_client_content_length -= (unsigned)len;
1970 log_error(LOG_LEVEL_CONNECT,
1971 "Expected client content length set to %llu "
1972 "after reading %d bytes.",
1973 csp->expected_client_content_length, len);
1974 if (csp->expected_client_content_length == 0)
1976 log_error(LOG_LEVEL_CONNECT,
1977 "Done reading from the client.");
1978 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1981 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1983 if (write_socket(csp->server_connection.sfd, buf, (size_t)len))
1985 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1986 mark_server_socket_tainted(csp);
1993 * The server wants to talk. It could be the header or the body.
1994 * If `hdr' is null, then it's the header otherwise it's the body.
1995 * FIXME: Does `hdr' really mean `host'? No.
1997 if (FD_ISSET(csp->server_connection.sfd, &rfds))
1999 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2001 * If we are buffering content, we don't want to eat up to
2002 * buffer-limit bytes if the client no longer cares about them.
2003 * If we aren't buffering, however, a dead client socket will be
2004 * noticed pretty much right away anyway, so we can reduce the
2005 * overhead by skipping the check.
2007 if (buffer_and_filter_content && !socket_is_still_alive(csp->cfd))
2010 log_error(LOG_LEVEL_CONNECT,
2011 "The server still wants to talk, but the client may already have hung up on us.");
2013 log_error(LOG_LEVEL_CONNECT,
2014 "The server still wants to talk, but the client hung up on us.");
2015 mark_server_socket_tainted(csp);
2017 #endif /* def _WIN32 */
2019 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2021 len = read_socket(csp->server_connection.sfd, buf, sizeof(buf) - 1);
2025 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
2027 if (http->ssl && (fwd->forward_host == NULL))
2030 * Just hang up. We already confirmed the client's CONNECT
2031 * request with status code 200 and unencrypted content is
2032 * no longer welcome.
2034 log_error(LOG_LEVEL_ERROR,
2035 "CONNECT already confirmed. Unable to tell the client about the problem.");
2038 else if (byte_count)
2041 * Just hang up. We already transmitted the original headers
2042 * and parts of the original content and therefore missed the
2043 * chance to send an error message (without risking data corruption).
2045 * XXX: we could retry with a fancy range request here.
2047 log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
2048 "Unable to tell the client about the problem.");
2049 mark_server_socket_tainted(csp);
2053 * XXX: Consider handling the cases above the same.
2055 mark_server_socket_tainted(csp);
2059 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2060 if (csp->flags & CSP_FLAG_CHUNKED)
2062 if ((len >= 5) && !memcmp(buf+len-5, "0\r\n\r\n", 5))
2064 /* XXX: this is a temporary hack */
2065 log_error(LOG_LEVEL_CONNECT,
2066 "Looks like we reached the end of the last chunk. "
2067 "We better stop reading.");
2068 csp->expected_content_length = byte_count + (unsigned long long)len;
2069 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2073 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2076 * Add a trailing zero to let be able to use string operations.
2077 * XXX: do we still need this with filter_popups gone?
2082 * Normally, this would indicate that we've read
2083 * as much as the server has sent us and we can
2084 * close the client connection. However, Microsoft
2085 * in its wisdom has released IIS/5 with a bug that
2086 * prevents it from sending the trailing \r\n in
2087 * a 302 redirect header (and possibly other headers).
2088 * To work around this if we've haven't parsed
2089 * a full header we'll append a trailing \r\n
2090 * and see if this now generates a valid one.
2092 * This hack shouldn't have any impacts. If we've
2093 * already transmitted the header or if this is a
2094 * SSL connection, then we won't bother with this
2095 * hack. So we only work on partially received
2096 * headers. If we append a \r\n and this still
2097 * doesn't generate a valid header, then we won't
2098 * transmit anything to the client.
2103 if (server_body || http->ssl)
2106 * If we have been buffering up the document,
2107 * now is the time to apply content modification
2108 * and send the result to the client.
2110 if (buffer_and_filter_content)
2112 p = execute_content_filters(csp);
2114 * If content filtering fails, use the original
2115 * buffer and length.
2116 * (see p != NULL ? p : csp->iob->cur below)
2120 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
2122 #ifdef FEATURE_COMPRESSION
2123 else if ((csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE)
2124 && (csp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION))
2126 char *compressed_content = compress_buffer(p,
2127 (size_t *)&csp->content_length, csp->config->compression_level);
2128 if (compressed_content != NULL)
2131 p = compressed_content;
2132 csp->flags |= CSP_FLAG_BUFFERED_CONTENT_DEFLATED;
2137 if (JB_ERR_OK != update_server_headers(csp))
2139 log_error(LOG_LEVEL_FATAL,
2140 "Failed to update server headers. after filtering.");
2143 hdr = list_to_text(csp->headers);
2146 /* FIXME Should handle error properly */
2147 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2150 if (write_socket(csp->cfd, hdr, strlen(hdr))
2151 || write_socket(csp->cfd,
2152 ((p != NULL) ? p : csp->iob->cur), (size_t)csp->content_length))
2154 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
2157 mark_server_socket_tainted(csp);
2165 break; /* "game over, man" */
2169 * This is NOT the body, so
2170 * Let's pretend the server just sent us a blank line.
2172 snprintf(buf, sizeof(buf), "\r\n");
2173 len = (int)strlen(buf);
2176 * Now, let the normal header parsing algorithm below do its
2177 * job. If it fails, we'll exit instead of continuing.
2184 * If this is an SSL connection or we're in the body
2185 * of the server document, just write it to the client,
2186 * unless we need to buffer the body for later content-filtering
2188 if (server_body || http->ssl)
2190 if (buffer_and_filter_content)
2193 * If there is no memory left for buffering the content, or the buffer limit
2194 * has been reached, switch to non-filtering mode, i.e. make & write the
2195 * header, flush the iob and buf, and get out of the way.
2197 if (add_to_iob(csp->iob, csp->config->buffer_limit, buf, len))
2202 log_error(LOG_LEVEL_INFO,
2203 "Flushing header and buffers. Stepping back from filtering.");
2205 hdr = list_to_text(csp->headers);
2209 * Memory is too tight to even generate the header.
2210 * Send our static "Out-of-memory" page.
2212 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
2213 rsp = cgi_error_memory();
2214 send_crunch_response(csp, rsp);
2215 mark_server_socket_tainted(csp);
2218 hdrlen = strlen(hdr);
2220 if (write_socket(csp->cfd, hdr, hdrlen)
2221 || ((flushed = flush_socket(csp->cfd, csp->iob)) < 0)
2222 || (write_socket(csp->cfd, buf, (size_t)len)))
2224 log_error(LOG_LEVEL_CONNECT,
2225 "Flush header and buffers to client failed: %E");
2227 mark_server_socket_tainted(csp);
2232 * Reset the byte_count to the amount of bytes
2233 * we just flushed. len will be added a few lines below,
2234 * hdrlen doesn't matter for LOG_LEVEL_CLF.
2236 byte_count = (unsigned long long)flushed;
2238 buffer_and_filter_content = 0;
2244 if (write_socket(csp->cfd, buf, (size_t)len))
2246 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
2247 mark_server_socket_tainted(csp);
2251 byte_count += (unsigned long long)len;
2257 * We're still looking for the end of the server's header.
2258 * Buffer up the data we just read. If that fails, there's
2259 * little we can do but send our static out-of-memory page.
2261 if (add_to_iob(csp->iob, csp->config->buffer_limit, buf, len))
2263 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
2264 rsp = cgi_error_memory();
2265 send_crunch_response(csp, rsp);
2266 mark_server_socket_tainted(csp);
2270 /* Convert iob into something sed() can digest */
2271 if (JB_ERR_PARSE == get_server_headers(csp))
2276 * Well, we tried our MS IIS/5 hack and it didn't work.
2277 * The header is incomplete and there isn't anything
2278 * we can do about it.
2280 log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
2281 "Applying the MS IIS5 hack didn't help.");
2282 log_error(LOG_LEVEL_CLF,
2283 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2284 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2285 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2286 mark_server_socket_tainted(csp);
2292 * Since we have to wait for more from the server before
2293 * we can parse the headers we just continue here.
2295 log_error(LOG_LEVEL_CONNECT,
2296 "Continuing buffering server headers from socket %d. "
2297 "Bytes most recently read: %d.", csp->cfd, len);
2304 * Account for the content bytes we
2305 * might have gotten with the headers.
2307 assert(csp->iob->eod >= csp->iob->cur);
2308 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2311 /* Did we actually get anything? */
2312 if (NULL == csp->headers->first)
2314 if ((csp->flags & CSP_FLAG_REUSED_CLIENT_CONNECTION))
2316 log_error(LOG_LEVEL_ERROR,
2317 "No server or forwarder response received on socket %d. "
2318 "Closing client socket %d without sending data.",
2319 csp->server_connection.sfd, csp->cfd);
2320 log_error(LOG_LEVEL_CLF,
2321 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2325 log_error(LOG_LEVEL_ERROR,
2326 "No server or forwarder response received on socket %d.",
2327 csp->server_connection.sfd);
2328 send_crunch_response(csp, error_response(csp, "no-server-data"));
2330 free_http_request(http);
2331 mark_server_socket_tainted(csp);
2335 assert(csp->headers->first->str);
2337 if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
2338 strncmpic(csp->headers->first->str, "ICY", 3))
2341 * It doesn't look like a HTTP (or Shoutcast) response:
2342 * tell the client and log the problem.
2344 if (strlen(csp->headers->first->str) > 30)
2346 csp->headers->first->str[30] = '\0';
2348 log_error(LOG_LEVEL_ERROR,
2349 "Invalid server or forwarder response. Starts with: %s",
2350 csp->headers->first->str);
2351 log_error(LOG_LEVEL_CLF,
2352 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2353 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2354 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2355 free_http_request(http);
2356 mark_server_socket_tainted(csp);
2361 * We have now received the entire server header,
2362 * filter it and send the result to the client
2364 if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
2366 log_error(LOG_LEVEL_FATAL, "Failed to parse server headers.");
2368 hdr = list_to_text(csp->headers);
2371 /* FIXME Should handle error properly */
2372 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2375 if ((csp->flags & CSP_FLAG_CHUNKED)
2376 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2377 && ((csp->iob->eod - csp->iob->cur) >= 5)
2378 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
2380 log_error(LOG_LEVEL_CONNECT,
2381 "Looks like we got the last chunk together with "
2382 "the server headers. We better stop reading.");
2383 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2384 csp->expected_content_length = byte_count;
2385 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2388 csp->server_connection.response_received = time(NULL);
2390 if (crunch_response_triggered(csp, crunchers_light))
2393 * One of the tags created by a server-header
2394 * tagger triggered a crunch. We already
2395 * delivered the crunch response to the client
2396 * and are done here after cleaning up.
2399 mark_server_socket_tainted(csp);
2402 /* Buffer and pcrs filter this if appropriate. */
2404 if (!http->ssl) /* We talk plaintext */
2406 buffer_and_filter_content = content_requires_filtering(csp);
2409 * Only write if we're not buffering for content modification
2411 if (!buffer_and_filter_content)
2414 * Write the server's (modified) header to
2415 * the client (along with anything else that
2416 * may be in the buffer)
2419 if (write_socket(csp->cfd, hdr, strlen(hdr))
2420 || ((len = flush_socket(csp->cfd, csp->iob)) < 0))
2422 log_error(LOG_LEVEL_CONNECT, "write header to client failed: %E");
2425 * The write failed, so don't bother mentioning it
2426 * to the client... it probably can't hear us anyway.
2429 mark_server_socket_tainted(csp);
2434 /* we're finished with the server's header */
2440 * If this was a MS IIS/5 hack then it means the server
2441 * has already closed the connection. Nothing more to read.
2446 log_error(LOG_LEVEL_ERROR,
2447 "Closed server connection detected. "
2448 "Applying the MS IIS5 hack didn't help.");
2449 log_error(LOG_LEVEL_CLF,
2450 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2451 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2452 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2453 mark_server_socket_tainted(csp);
2459 mark_server_socket_tainted(csp);
2460 return; /* huh? we should never get here */
2463 if (csp->content_length == 0)
2466 * If Privoxy didn't recalculate the Content-Length,
2467 * byte_count is still correct.
2469 csp->content_length = byte_count;
2472 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2473 if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2474 && (csp->expected_content_length != byte_count))
2476 log_error(LOG_LEVEL_CONNECT,
2477 "Received %llu bytes while expecting %llu.",
2478 byte_count, csp->expected_content_length);
2479 mark_server_socket_tainted(csp);
2483 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
2484 csp->ip_addr_str, http->ocmd, csp->content_length);
2486 csp->server_connection.timestamp = time(NULL);
2490 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2491 /*********************************************************************
2493 * Function : prepare_csp_for_next_request
2495 * Description : Put the csp in a mostly vergin state.
2498 * 1 : csp = Current client state (buffers, headers, etc...)
2502 *********************************************************************/
2503 static void prepare_csp_for_next_request(struct client_state *csp)
2505 unsigned int toggled_on_flag_set = (0 != (csp->flags & CSP_FLAG_TOGGLED_ON));
2507 csp->content_type = 0;
2508 csp->content_length = 0;
2509 csp->expected_content_length = 0;
2510 csp->expected_client_content_length = 0;
2511 list_remove_all(csp->headers);
2512 clear_iob(csp->iob);
2513 freez(csp->error_message);
2514 free_http_request(csp->http);
2515 destroy_list(csp->headers);
2516 destroy_list(csp->tags);
2517 free_current_action(csp->action);
2518 if (NULL != csp->fwd)
2520 unload_forward_spec(csp->fwd);
2523 /* XXX: Store per-connection flags someplace else. */
2524 csp->flags = (CSP_FLAG_ACTIVE | CSP_FLAG_REUSED_CLIENT_CONNECTION);
2525 if (toggled_on_flag_set)
2527 csp->flags |= CSP_FLAG_TOGGLED_ON;
2530 if (csp->client_iob->eod > csp->client_iob->cur)
2532 long bytes_to_shift = csp->client_iob->cur - csp->client_iob->buf;
2533 size_t data_length = (size_t)(csp->client_iob->eod - csp->client_iob->cur);
2535 assert(bytes_to_shift > 0);
2536 assert(data_length > 0);
2538 log_error(LOG_LEVEL_CONNECT, "Shifting %d pipelined bytes by %d bytes",
2539 data_length, bytes_to_shift);
2540 memmove(csp->client_iob->buf, csp->client_iob->cur, data_length);
2541 csp->client_iob->cur = csp->client_iob->buf;
2542 assert(csp->client_iob->eod == csp->client_iob->buf + bytes_to_shift + data_length);
2543 csp->client_iob->eod = csp->client_iob->buf + data_length;
2544 memset(csp->client_iob->eod, '\0', (size_t)bytes_to_shift);
2546 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
2551 * We mainly care about resetting client_iob->cur so we don't
2552 * waste buffer space at the beginning and don't mess up the
2553 * request restoration done by cgi_show_request().
2555 * Freeing the buffer itself isn't technically necessary,
2556 * but makes debugging more convenient.
2558 clear_iob(csp->client_iob);
2561 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2564 /*********************************************************************
2568 * Description : This is little more than chat. We only "serve" to
2569 * to close (or remember) any socket that chat may have
2573 * 1 : csp = Current client state (buffers, headers, etc...)
2577 *********************************************************************/
2579 void serve(struct client_state *csp)
2580 #else /* ifndef AMIGA */
2581 static void serve(struct client_state *csp)
2582 #endif /* def AMIGA */
2584 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2585 #ifdef FEATURE_CONNECTION_SHARING
2586 static int monitor_thread_running = 0;
2587 #endif /* def FEATURE_CONNECTION_SHARING */
2588 int continue_chatting = 0;
2589 int config_file_change_detected = 0; /* Only used for debugging */
2591 log_error(LOG_LEVEL_CONNECT, "Accepted connection from %s on socket %d",
2592 csp->ip_addr_str, csp->cfd);
2596 unsigned int latency;
2601 * If the request has been crunched,
2602 * the calculated latency is zero.
2604 latency = (unsigned)(csp->server_connection.response_received -
2605 csp->server_connection.request_sent) / 2;
2607 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
2608 && (csp->flags & CSP_FLAG_CRUNCHED)
2609 && (csp->expected_client_content_length != 0))
2611 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
2612 log_error(LOG_LEVEL_CONNECT,
2613 "Tainting client socket %d due to unread data.", csp->cfd);
2616 continue_chatting = (csp->config->feature_flags
2617 & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
2618 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
2619 && (csp->cfd != JB_INVALID_SOCKET)
2620 && ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
2621 || (csp->config->feature_flags &
2622 RUNTIME_FEATURE_CONNECTION_SHARING));
2624 if (!(csp->flags & CSP_FLAG_CRUNCHED)
2625 && (csp->server_connection.sfd != JB_INVALID_SOCKET))
2627 if (!(csp->flags & CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET))
2629 csp->server_connection.keep_alive_timeout = csp->config->default_server_timeout;
2631 if (!(csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
2632 || (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
2633 || !socket_is_still_alive(csp->server_connection.sfd)
2634 || !(latency < csp->server_connection.keep_alive_timeout))
2636 log_error(LOG_LEVEL_CONNECT,
2637 "Closing connection on server socket %d to %s: "
2638 "keep-alive %u, tainted: %u, socket alive %u. %s timeout: %u.",
2639 csp->server_connection.sfd, csp->server_connection.host,
2640 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
2641 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
2642 socket_is_still_alive(csp->server_connection.sfd),
2643 ((csp->flags & CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET) ?
2644 "Specified" : "Assumed"), csp->server_connection.keep_alive_timeout);
2645 #ifdef FEATURE_CONNECTION_SHARING
2646 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
2648 forget_connection(csp->server_connection.sfd);
2650 #endif /* def FEATURE_CONNECTION_SHARING */
2651 close_socket(csp->server_connection.sfd);
2652 mark_connection_closed(&csp->server_connection);
2656 if (continue_chatting && any_loaded_file_changed(csp->config->config_file_list))
2658 continue_chatting = 0;
2659 config_file_change_detected = 1;
2662 if (continue_chatting)
2664 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
2665 && socket_is_still_alive(csp->cfd))
2667 log_error(LOG_LEVEL_CONNECT, "A client request has been "
2668 "pipelined on socket %d and the socket is still alive.",
2670 prepare_csp_for_next_request(csp);
2674 if (0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
2676 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
2678 log_error(LOG_LEVEL_CONNECT,
2679 "Waiting for the next client request on socket %d. "
2680 "Keeping the server socket %d to %s open.",
2681 csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
2685 log_error(LOG_LEVEL_CONNECT,
2686 "Waiting for the next client request on socket %d. "
2687 "No server socket to keep open.", csp->cfd);
2691 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
2692 && data_is_available(csp->cfd, (int)csp->config->keep_alive_timeout)
2693 && socket_is_still_alive(csp->cfd))
2695 log_error(LOG_LEVEL_CONNECT,
2696 "Client request arrived in time on socket %d.", csp->cfd);
2697 prepare_csp_for_next_request(csp);
2701 #ifdef FEATURE_CONNECTION_SHARING
2702 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
2703 && (csp->server_connection.sfd != JB_INVALID_SOCKET)
2704 && (socket_is_still_alive(csp->server_connection.sfd)))
2706 time_t time_open = time(NULL) - csp->server_connection.timestamp;
2708 if (csp->server_connection.keep_alive_timeout < time_open - (time_t)latency)
2713 remember_connection(&csp->server_connection);
2714 csp->server_connection.sfd = JB_INVALID_SOCKET;
2715 drain_and_close_socket(csp->cfd);
2716 csp->cfd = JB_INVALID_SOCKET;
2717 privoxy_mutex_lock(&connection_reuse_mutex);
2718 if (!monitor_thread_running)
2720 monitor_thread_running = 1;
2721 privoxy_mutex_unlock(&connection_reuse_mutex);
2722 wait_for_alive_connections();
2723 privoxy_mutex_lock(&connection_reuse_mutex);
2724 monitor_thread_running = 0;
2726 privoxy_mutex_unlock(&connection_reuse_mutex);
2728 #endif /* def FEATURE_CONNECTION_SHARING */
2732 else if (csp->server_connection.sfd != JB_INVALID_SOCKET)
2734 log_error(LOG_LEVEL_CONNECT,
2735 "Closing server socket %d connected to %s. Keep-alive %u. "
2736 "Tainted: %u. Socket alive %u. Timeout: %u. "
2737 "Configuration file change detected: %u",
2738 csp->server_connection.sfd, csp->server_connection.host,
2739 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
2740 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
2741 socket_is_still_alive(csp->server_connection.sfd),
2742 csp->server_connection.keep_alive_timeout,
2743 config_file_change_detected);
2745 } while (continue_chatting);
2749 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2751 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
2753 #ifdef FEATURE_CONNECTION_SHARING
2754 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
2756 forget_connection(csp->server_connection.sfd);
2758 #endif /* def FEATURE_CONNECTION_SHARING */
2759 close_socket(csp->server_connection.sfd);
2762 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2763 mark_connection_closed(&csp->server_connection);
2766 if (csp->cfd != JB_INVALID_SOCKET)
2768 log_error(LOG_LEVEL_CONNECT, "Closing client socket %d. "
2769 "Keep-alive: %u, Socket alive: %u. Data available: %u. "
2770 "Configuration file change detected: %u.",
2771 csp->cfd, 0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE),
2772 socket_is_still_alive(csp->cfd), data_is_available(csp->cfd, 0),
2773 config_file_change_detected);
2774 drain_and_close_socket(csp->cfd);
2777 csp->flags &= ~CSP_FLAG_ACTIVE;
2783 /*********************************************************************
2785 * Function : server_thread
2787 * Description : We only exist to call `serve' in a threaded environment.
2790 * 1 : data = Current client state (buffers, headers, etc...)
2792 * Returns : Always 0.
2794 *********************************************************************/
2795 static int32 server_thread(void *data)
2797 serve((struct client_state *) data);
2804 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
2805 /*********************************************************************
2809 * Description : Print usage info & exit.
2811 * Parameters : Pointer to argv[0] for identifying ourselves
2815 *********************************************************************/
2816 static void usage(const char *myname)
2818 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
2822 #endif /* defined(unix) */
2825 "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
2826 #endif /* defined(unix) */
2827 "[--version] [configfile]\n"
2828 "Aborting\n", myname);
2833 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
2836 #ifdef MUTEX_LOCKS_AVAILABLE
2837 /*********************************************************************
2839 * Function : privoxy_mutex_lock
2841 * Description : Locks a mutex.
2844 * 1 : mutex = The mutex to lock.
2846 * Returns : Void. May exit in case of errors.
2848 *********************************************************************/
2849 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
2851 #ifdef FEATURE_PTHREAD
2852 int err = pthread_mutex_lock(mutex);
2855 if (mutex != &log_mutex)
2857 log_error(LOG_LEVEL_FATAL,
2858 "Mutex locking failed: %s.\n", strerror(err));
2863 EnterCriticalSection(mutex);
2864 #endif /* def FEATURE_PTHREAD */
2868 /*********************************************************************
2870 * Function : privoxy_mutex_unlock
2872 * Description : Unlocks a mutex.
2875 * 1 : mutex = The mutex to unlock.
2877 * Returns : Void. May exit in case of errors.
2879 *********************************************************************/
2880 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
2882 #ifdef FEATURE_PTHREAD
2883 int err = pthread_mutex_unlock(mutex);
2886 if (mutex != &log_mutex)
2888 log_error(LOG_LEVEL_FATAL,
2889 "Mutex unlocking failed: %s.\n", strerror(err));
2894 LeaveCriticalSection(mutex);
2895 #endif /* def FEATURE_PTHREAD */
2899 /*********************************************************************
2901 * Function : privoxy_mutex_init
2903 * Description : Prepares a mutex.
2906 * 1 : mutex = The mutex to initialize.
2908 * Returns : Void. May exit in case of errors.
2910 *********************************************************************/
2911 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
2913 #ifdef FEATURE_PTHREAD
2914 int err = pthread_mutex_init(mutex, 0);
2917 printf("Fatal error. Mutex initialization failed: %s.\n",
2922 InitializeCriticalSection(mutex);
2923 #endif /* def FEATURE_PTHREAD */
2925 #endif /* def MUTEX_LOCKS_AVAILABLE */
2927 /*********************************************************************
2929 * Function : initialize_mutexes
2931 * Description : Prepares mutexes if mutex support is available.
2935 * Returns : Void, exits in case of errors.
2937 *********************************************************************/
2938 static void initialize_mutexes(void)
2940 #ifdef MUTEX_LOCKS_AVAILABLE
2942 * Prepare global mutex semaphores
2944 privoxy_mutex_init(&log_mutex);
2945 privoxy_mutex_init(&log_init_mutex);
2946 privoxy_mutex_init(&connection_reuse_mutex);
2949 * XXX: The assumptions below are a bit naive
2950 * and can cause locks that aren't necessary.
2952 * For example older FreeBSD versions (< 6.x?)
2953 * have no gethostbyname_r, but gethostbyname is
2956 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
2957 privoxy_mutex_init(&resolver_mutex);
2958 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
2960 * XXX: should we use a single mutex for
2961 * localtime() and gmtime() as well?
2963 #ifndef HAVE_GMTIME_R
2964 privoxy_mutex_init(&gmtime_mutex);
2965 #endif /* ndef HAVE_GMTIME_R */
2967 #ifndef HAVE_LOCALTIME_R
2968 privoxy_mutex_init(&localtime_mutex);
2969 #endif /* ndef HAVE_GMTIME_R */
2972 privoxy_mutex_init(&rand_mutex);
2973 #endif /* ndef HAVE_RANDOM */
2975 #endif /* def MUTEX_LOCKS_AVAILABLE */
2979 /*********************************************************************
2983 * Description : Load the config file and start the listen loop.
2984 * This function is a lot more *sane* with the `load_config'
2985 * and `listen_loop' functions; although it stills does
2986 * a *little* too much for my taste.
2989 * 1 : argc = Number of parameters (including $0).
2990 * 2 : argv = Array of (char *)'s to the parameters.
2992 * Returns : 1 if : can't open config file, unrecognized directive,
2993 * stats requested in multi-thread mode, can't open the
2994 * log file, can't open the jar file, listen port is invalid,
2995 * any load fails, and can't bind port.
2997 * Else main never returns, the process must be signaled
2998 * to terminate execution. Or, on Windows, use the
2999 * "File", "Exit" menu option.
3001 *********************************************************************/
3003 int real_main(int argc, char **argv)
3005 int main(int argc, char **argv)
3009 unsigned int random_seed;
3011 struct passwd *pw = NULL;
3012 struct group *grp = NULL;
3014 char *pre_chroot_nslookup_to_load_resolver = NULL;
3021 #if !defined(_WIN32)
3028 /* Prepare mutexes if supported and necessary. */
3029 initialize_mutexes();
3031 /* Enable logging until further notice. */
3035 * Parse the command line arguments
3037 * XXX: simply printing usage information in case of
3038 * invalid arguments isn't particularly user friendly.
3040 while (++argc_pos < argc)
3043 /* Check to see if the service must be installed or uninstalled */
3044 if (strncmp(argv[argc_pos], "--install", 9) == 0)
3046 const char *pName = argv[argc_pos] + 9;
3049 exit((install_service(pName)) ? 0 : 1);
3051 else if (strncmp(argv[argc_pos], "--uninstall", 11) == 0)
3053 const char *pName = argv[argc_pos] + 11;
3056 exit((uninstall_service(pName)) ? 0 : 1);
3058 else if (strcmp(argv[argc_pos], "--service") == 0)
3060 bRunAsService = TRUE;
3061 w32_set_service_cwd();
3062 atexit(w32_service_exit_notify);
3065 #endif /* defined(_WIN32) */
3068 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
3070 if (strcmp(argv[argc_pos], "--help") == 0)
3075 else if (strcmp(argv[argc_pos], "--version") == 0)
3077 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
3083 else if (strcmp(argv[argc_pos], "--no-daemon") == 0)
3085 set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
3089 else if (strcmp(argv[argc_pos], "--pidfile") == 0)
3091 if (++argc_pos == argc) usage(argv[0]);
3092 pidfile = strdup_or_die(argv[argc_pos]);
3095 else if (strcmp(argv[argc_pos], "--user") == 0)
3100 if (++argc_pos == argc) usage(argv[argc_pos]);
3102 user_arg = strdup_or_die(argv[argc_pos]);
3103 group_name = strchr(user_arg, '.');
3104 if (NULL != group_name)
3106 /* Nul-terminate the user name */
3109 /* Skip the former delimiter to actually reach the group name */
3112 grp = getgrnam(group_name);
3115 log_error(LOG_LEVEL_FATAL, "Group '%s' not found.", group_name);
3118 pw = getpwnam(user_arg);
3121 log_error(LOG_LEVEL_FATAL, "User '%s' not found.", user_arg);
3127 else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup") == 0)
3129 if (++argc_pos == argc) usage(argv[0]);
3130 pre_chroot_nslookup_to_load_resolver = strdup_or_die(argv[argc_pos]);
3133 else if (strcmp(argv[argc_pos], "--chroot") == 0)
3137 #endif /* defined(unix) */
3139 else if (argc_pos + 1 != argc)
3142 * This is neither the last command line
3143 * option, nor was it recognized before,
3144 * therefore it must be invalid.
3150 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
3152 configfile = argv[argc_pos];
3155 } /* -END- while (more arguments) */
3157 show_version(Argv[0]);
3160 if (*configfile != '/')
3162 char cwd[BUFFER_SIZE];
3164 size_t abs_file_size;
3166 /* make config-filename absolute here */
3167 if (NULL == getcwd(cwd, sizeof(cwd)))
3169 perror("failed to get current working directory");
3173 basedir = strdup_or_die(cwd);
3175 abs_file_size = strlen(cwd) + strlen(configfile) + 5;
3176 abs_file = malloc_or_die(abs_file_size);
3177 strlcpy(abs_file, basedir, abs_file_size);
3178 strlcat(abs_file, "/", abs_file_size);
3179 strlcat(abs_file, configfile, abs_file_size);
3180 configfile = abs_file;
3182 #endif /* defined unix */
3186 clients->next = NULL;
3188 /* XXX: factor out initialising after the next stable release. */
3191 #elif defined(_WIN32)
3195 random_seed = (unsigned int)time(NULL);
3197 srandom(random_seed);
3200 #endif /* ifdef HAVE_RANDOM */
3203 * Unix signal handling
3205 * Catch the abort, interrupt and terminate signals for a graceful exit
3206 * Catch the hangup signal so the errlog can be reopened.
3207 * Ignore the broken pipe signals (FIXME: Why?)
3209 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
3212 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP };
3214 for (idx = 0; idx < SZ(catched_signals); idx++)
3216 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
3217 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
3219 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
3220 #endif /* ifdef sun */
3222 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
3226 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
3228 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for SIGPIPE: %E");
3232 #else /* ifdef _WIN32 */
3233 # ifdef _WIN_CONSOLE
3235 * We *are* in a windows console app.
3236 * Print a verbose messages about FAQ's and such
3238 printf("%s", win32_blurb);
3239 # endif /* def _WIN_CONSOLE */
3240 #endif /* def _WIN32 */
3243 /* Initialize the CGI subsystem */
3244 cgi_init_error_messages();
3247 * If runnig on unix and without the --nodaemon
3248 * option, become a daemon. I.e. fork, detach
3249 * from tty and get process group leadership
3258 if (pid < 0) /* error */
3263 else if (pid != 0) /* parent */
3268 * must check for errors
3269 * child died due to missing files aso
3272 wpid = waitpid(pid, &status, WNOHANG);
3284 * stderr (fd 2) will be closed later on,
3285 * when the config file has been parsed.
3291 * Reserve fd 0 and 1 to prevent abort() and friends
3292 * from sending stuff to the clients or servers.
3294 fd = open("/dev/null", O_RDONLY);
3297 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
3301 if (dup2(fd, 0) == -1)
3303 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 0: %E");
3307 fd = open("/dev/null", O_WRONLY);
3310 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
3314 if (dup2(fd, 1) == -1)
3316 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 1: %E");
3323 } /* -END- if (daemon_mode) */
3326 * As soon as we have written the PID file, we can switch
3327 * to the user and group ID indicated by the --user option
3333 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
3335 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
3339 if (setgroups(1, &grp->gr_gid))
3341 log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
3344 else if (initgroups(pw->pw_name, pw->pw_gid))
3346 log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
3352 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
3354 /* Read the time zone file from /etc before doing chroot. */
3356 if (NULL != pre_chroot_nslookup_to_load_resolver
3357 && '\0' != pre_chroot_nslookup_to_load_resolver[0])
3359 /* Initialize resolver library. */
3360 (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
3362 if (chroot(pw->pw_dir) < 0)
3364 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
3368 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
3371 if (setuid(pw->pw_uid))
3373 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
3377 char putenv_dummy[64];
3379 strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
3380 if (putenv(putenv_dummy) != 0)
3382 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
3385 snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
3386 if (putenv(putenv_dummy) != 0)
3388 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
3394 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
3397 #endif /* defined unix */
3400 /* This will be FALSE unless the command line specified --service
3404 /* Yup, so now we must attempt to establish a connection
3405 * with the service dispatcher. This will only work if this
3406 * process was launched by the service control manager to
3407 * actually run as a service. If this isn't the case, i've
3408 * known it take around 30 seconds or so for the call to return.
3411 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
3412 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
3414 /* Service has run, and at this point is now being stopped, so just return */
3419 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
3421 /* An error occurred. Usually it's because --service was wrongly specified
3422 * and we were unable to connect to the Service Control Dispatcher because
3423 * it wasn't expecting us and is therefore not listening.
3425 * For now, just continue below to call the listen_loop function.
3428 #endif /* def _WIN32 */
3438 /*********************************************************************
3440 * Function : bind_port_helper
3442 * Description : Bind the listen port. Handles logging, and aborts
3446 * 1 : haddr = Host addres to bind to. Use NULL to bind to
3448 * 2 : hport = Specifies port to bind to.
3450 * Returns : Port that was opened.
3452 *********************************************************************/
3453 static jb_socket bind_port_helper(const char *haddr, int hport)
3458 result = bind_port(haddr, hport, &bfd);
3462 const char *bind_address = (NULL != haddr) ? haddr : "INADDR_ANY";
3466 log_error(LOG_LEVEL_FATAL,
3467 "can't bind to %s:%d: There may be another Privoxy "
3468 "or some other proxy running on port %d",
3469 bind_address, hport, hport);
3472 log_error(LOG_LEVEL_FATAL,
3473 "can't bind to %s:%d: The hostname is not resolvable",
3474 bind_address, hport);
3477 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: %E",
3478 bind_address, hport);
3481 /* shouldn't get here */
3482 return JB_INVALID_SOCKET;
3487 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
3492 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
3500 /*********************************************************************
3502 * Function : bind_ports_helper
3504 * Description : Bind the listen ports. Handles logging, and aborts
3508 * 1 : config = Privoxy configuration. Specifies ports
3510 * 2 : sockets = Preallocated array of opened sockets
3511 * corresponding to specification in config.
3512 * All non-opened sockets will be set to
3513 * JB_INVALID_SOCKET.
3515 * Returns : Nothing. Inspect sockets argument.
3517 *********************************************************************/
3518 static void bind_ports_helper(struct configuration_spec * config,
3519 jb_socket sockets[])
3523 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
3525 if (config->hport[i])
3527 sockets[i] = bind_port_helper(config->haddr[i], config->hport[i]);
3531 sockets[i] = JB_INVALID_SOCKET;
3534 config->need_bind = 0;
3538 /*********************************************************************
3540 * Function : close_ports_helper
3542 * Description : Close listenings ports.
3545 * 1 : sockets = Array of opened and non-opened sockets to
3546 * close. All sockets will be set to
3547 * JB_INVALID_SOCKET.
3549 * Returns : Nothing.
3551 *********************************************************************/
3552 static void close_ports_helper(jb_socket sockets[])
3556 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
3558 if (JB_INVALID_SOCKET != sockets[i])
3560 close_socket(sockets[i]);
3562 sockets[i] = JB_INVALID_SOCKET;
3568 /* Without this simple workaround we get this compiler warning from _beginthread
3569 * warning C4028: formal parameter 1 different from declaration
3571 void w32_service_listen_loop(void *p)
3575 #endif /* def _WIN32 */
3578 /*********************************************************************
3580 * Function : listen_loop
3582 * Description : bind the listen port and enter a "FOREVER" listening loop.
3588 *********************************************************************/
3589 static void listen_loop(void)
3591 struct client_states *csp_list = NULL;
3592 struct client_state *csp = NULL;
3593 jb_socket bfds[MAX_LISTENING_SOCKETS];
3594 struct configuration_spec *config;
3595 unsigned int active_threads = 0;
3597 config = load_config();
3599 #ifdef FEATURE_CONNECTION_SHARING
3601 * XXX: Should be relocated once it no
3602 * longer needs to emit log messages.
3604 initialize_reusable_connections();
3605 #endif /* def FEATURE_CONNECTION_SHARING */
3607 bind_ports_helper(config, bfds);
3609 #ifdef FEATURE_GRACEFUL_TERMINATION
3610 while (!g_terminate)
3615 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
3616 while (waitpid(-1, NULL, WNOHANG) > 0)
3618 /* zombie children */
3620 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
3623 * Free data that was used by died threads
3625 active_threads = sweep();
3629 * Re-open the errlog after HUP signal
3631 if (received_hup_signal)
3633 if (NULL != config->logfile)
3635 init_error_log(Argv[0], config->logfile);
3637 received_hup_signal = 0;
3641 csp_list = (struct client_states *)zalloc(sizeof(*csp_list));
3642 if (NULL == csp_list)
3644 log_error(LOG_LEVEL_FATAL,
3645 "malloc(%d) for csp_list failed: %E", sizeof(*csp_list));
3648 csp = &csp_list->csp;
3650 log_error(LOG_LEVEL_CONNECT, "Listening for new connections ... ");
3652 if (!accept_connection(csp, bfds))
3654 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
3666 csp->flags |= CSP_FLAG_ACTIVE;
3667 csp->server_connection.sfd = JB_INVALID_SOCKET;
3669 csp->config = config = load_config();
3671 if (config->need_bind)
3674 * Since we were listening to the "old port", we will not see
3675 * a "listen" param change until the next request. So, at
3676 * least 1 more request must be made for us to find the new
3677 * setting. I am simply closing the old socket and binding the
3680 * Which-ever is correct, we will serve 1 more page via the
3681 * old settings. This should probably be a "show-proxy-args"
3682 * request. This should not be a so common of an operation
3683 * that this will hurt people's feelings.
3686 close_ports_helper(bfds);
3688 bind_ports_helper(config, bfds);
3691 #ifdef FEATURE_TOGGLE
3692 if (global_toggle_state)
3693 #endif /* def FEATURE_TOGGLE */
3695 csp->flags |= CSP_FLAG_TOGGLED_ON;
3698 if (run_loader(csp))
3700 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
3701 /* Never get here - LOG_LEVEL_FATAL causes program exit */
3705 if (block_acl(NULL,csp))
3707 log_error(LOG_LEVEL_CONNECT,
3708 "Connection from %s on socket %d dropped due to ACL", csp->ip_addr_str, csp->cfd);
3709 close_socket(csp->cfd);
3710 freez(csp->ip_addr_str);
3714 #endif /* def FEATURE_ACL */
3716 if ((0 != config->max_client_connections)
3717 && (active_threads >= config->max_client_connections))
3719 log_error(LOG_LEVEL_CONNECT,
3720 "Rejecting connection from %s. Maximum number of connections reached.",
3722 write_socket(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
3723 strlen(TOO_MANY_CONNECTIONS_RESPONSE));
3724 close_socket(csp->cfd);
3725 freez(csp->ip_addr_str);
3730 /* add it to the list of clients */
3731 csp_list->next = clients->next;
3732 clients->next = csp_list;
3734 if (config->multi_threaded)
3738 /* this is a switch () statement in the C preprocessor - ugh */
3739 #undef SELECTED_ONE_OPTION
3741 /* Use Pthreads in preference to native code */
3742 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
3743 #define SELECTED_ONE_OPTION
3745 pthread_t the_thread;
3746 pthread_attr_t attrs;
3748 pthread_attr_init(&attrs);
3749 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
3750 errno = pthread_create(&the_thread, &attrs,
3751 (void * (*)(void *))serve, csp);
3752 child_id = errno ? -1 : 0;
3753 pthread_attr_destroy(&attrs);
3757 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
3758 #define SELECTED_ONE_OPTION
3759 child_id = _beginthread(
3760 (void (*)(void *))serve,
3765 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
3766 #define SELECTED_ONE_OPTION
3767 child_id = _beginthread(
3768 (void(* _Optlink)(void*))serve,
3774 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
3775 #define SELECTED_ONE_OPTION
3777 thread_id tid = spawn_thread
3778 (server_thread, "server", B_NORMAL_PRIORITY, csp);
3780 if ((tid >= 0) && (resume_thread(tid) == B_OK))
3782 child_id = (int) tid;
3791 #if defined(AMIGA) && !defined(SELECTED_ONE_OPTION)
3792 #define SELECTED_ONE_OPTION
3793 csp->cfd = ReleaseSocket(csp->cfd, -1);
3796 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
3797 NP_Output, Output(),
3798 NP_CloseOutput, FALSE,
3799 NP_Name, (ULONG)"privoxy child",
3803 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
3804 NP_Output, Output(),
3805 NP_CloseOutput, FALSE,
3806 NP_Name, (ULONG)"privoxy child",
3807 NP_StackSize, 200*1024,
3813 ((struct Task *)child_id)->tc_UserData = csp;
3814 Signal((struct Task *)child_id, SIGF_SINGLE);
3819 #if !defined(SELECTED_ONE_OPTION)
3822 /* This block is only needed when using fork().
3823 * When using threads, the server thread was
3824 * created and run by the call to _beginthread().
3826 if (child_id == 0) /* child */
3829 #ifdef FEATURE_TOGGLE
3830 int inherited_toggle_state = global_toggle_state;
3831 #endif /* def FEATURE_TOGGLE */
3836 * If we've been toggled or we've blocked the request, tell Mom
3839 #ifdef FEATURE_TOGGLE
3840 if (inherited_toggle_state != global_toggle_state)
3842 rc |= RC_FLAG_TOGGLED;
3844 #endif /* def FEATURE_TOGGLE */
3846 #ifdef FEATURE_STATISTICS
3847 if (csp->flags & CSP_FLAG_REJECTED)
3849 rc |= RC_FLAG_BLOCKED;
3851 #endif /* ndef FEATURE_STATISTICS */
3855 else if (child_id > 0) /* parent */
3857 /* in a fork()'d environment, the parent's
3858 * copy of the client socket and the CSP
3862 #if !defined(_WIN32) && !defined(__CYGWIN__)
3864 wait(&child_status);
3867 * Evaluate child's return code: If the child has
3868 * - been toggled, toggle ourselves
3869 * - blocked its request, bump up the stats counter
3872 #ifdef FEATURE_TOGGLE
3873 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
3875 global_toggle_state = !global_toggle_state;
3877 #endif /* def FEATURE_TOGGLE */
3879 #ifdef FEATURE_STATISTICS
3881 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
3885 #endif /* def FEATURE_STATISTICS */
3887 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
3888 close_socket(csp->cfd);
3889 csp->flags &= ~CSP_FLAG_ACTIVE;
3893 #undef SELECTED_ONE_OPTION
3894 /* end of cpp switch () */
3899 * Spawning the child failed, assume it's because
3900 * there are too many children running already.
3901 * XXX: If you assume ...
3903 log_error(LOG_LEVEL_ERROR,
3904 "Unable to take any additional connections: %E");
3905 write_socket(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
3906 strlen(TOO_MANY_CONNECTIONS_RESPONSE));
3907 close_socket(csp->cfd);
3908 csp->flags &= ~CSP_FLAG_ACTIVE;
3917 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
3919 /* Clean up. Aim: free all memory (no leaks) */
3920 #ifdef FEATURE_GRACEFUL_TERMINATION
3922 log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
3924 unload_current_config_file();
3925 unload_current_actions_file();
3926 unload_current_re_filterfile();
3927 #ifdef FEATURE_TRUST
3928 unload_current_trust_file();
3931 if (config->multi_threaded)
3938 } while ((clients->next != NULL) && (--i > 0));
3942 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
3952 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
3953 /* Cleanup - remove taskbar icon etc. */
3958 #endif /* FEATURE_GRACEFUL_TERMINATION */