1 const char jcc_rcs[] = "$Id: jcc.c,v 1.289 2009/09/10 14:58:54 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-2009 the SourceForge
10 * Privoxy team. http://www.privoxy.org/
12 * Based on the Internet Junkbuster originally written
13 * by and Copyright (C) 1997 Anonymous Coders and
14 * Junkbusters Corporation. http://www.junkbusters.com
16 * This program is free software; you can redistribute it
17 * and/or modify it under the terms of the GNU General
18 * Public License as published by the Free Software
19 * Foundation; either version 2 of the License, or (at
20 * your option) any later version.
22 * This program is distributed in the hope that it will
23 * be useful, but WITHOUT ANY WARRANTY; without even the
24 * implied warranty of MERCHANTABILITY or FITNESS FOR A
25 * PARTICULAR PURPOSE. See the GNU General Public
26 * License for more details.
28 * The GNU General Public License should be included with
29 * this file. If not, you can view it at
30 * http://www.gnu.org/copyleft/gpl.html
31 * or write to the Free Software Foundation, Inc., 59
32 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
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_state 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(struct configuration_spec *config);
155 static void listen_loop(void);
158 void serve(struct client_state *csp);
159 #else /* ifndef AMIGA */
160 static void serve(struct client_state *csp);
161 #endif /* def AMIGA */
164 static int32 server_thread(void *data);
165 #endif /* def __BEOS__ */
168 #define sleep(N) Sleep(((N) * 1000))
172 #define sleep(N) DosSleep(((N) * 100))
175 #ifdef MUTEX_LOCKS_AVAILABLE
177 * XXX: Does the locking stuff really belong in this file?
179 privoxy_mutex_t log_mutex;
180 privoxy_mutex_t log_init_mutex;
181 privoxy_mutex_t connection_reuse_mutex;
183 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
184 privoxy_mutex_t resolver_mutex;
185 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
187 #ifndef HAVE_GMTIME_R
188 privoxy_mutex_t gmtime_mutex;
189 #endif /* ndef HAVE_GMTIME_R */
191 #ifndef HAVE_LOCALTIME_R
192 privoxy_mutex_t localtime_mutex;
193 #endif /* ndef HAVE_GMTIME_R */
196 privoxy_mutex_t rand_mutex;
197 #endif /* ndef HAVE_RANDOM */
199 #endif /* def MUTEX_LOCKS_AVAILABLE */
202 const char *basedir = NULL;
203 const char *pidfile = NULL;
204 static int received_hup_signal = 0;
205 #endif /* defined unix */
207 /* HTTP snipplets. */
208 static const char CSUCCEED[] =
209 "HTTP/1.0 200 Connection established\r\n"
210 "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
212 static const char CHEADER[] =
213 "HTTP/1.0 400 Invalid header received from client\r\n"
214 "Proxy-Agent: Privoxy " VERSION "\r\n"
215 "Content-Type: text/plain\r\n"
216 "Connection: close\r\n\r\n"
217 "Invalid header received from client.\r\n";
219 static const char FTP_RESPONSE[] =
220 "HTTP/1.0 400 Invalid request received from client\r\n"
221 "Content-Type: text/plain\r\n"
222 "Connection: close\r\n\r\n"
223 "Invalid request. Privoxy doesn't support FTP.\r\n";
225 static const char GOPHER_RESPONSE[] =
226 "HTTP/1.0 400 Invalid request received from client\r\n"
227 "Content-Type: text/plain\r\n"
228 "Connection: close\r\n\r\n"
229 "Invalid request. Privoxy doesn't support gopher.\r\n";
231 /* XXX: should be a template */
232 static const char MISSING_DESTINATION_RESPONSE[] =
233 "HTTP/1.0 400 Bad request received from client\r\n"
234 "Proxy-Agent: Privoxy " VERSION "\r\n"
235 "Content-Type: text/plain\r\n"
236 "Connection: close\r\n\r\n"
237 "Bad request. Privoxy was unable to extract the destination.\r\n";
239 /* XXX: should be a template */
240 static const char INVALID_SERVER_HEADERS_RESPONSE[] =
241 "HTTP/1.0 502 Server or forwarder response invalid\r\n"
242 "Proxy-Agent: Privoxy " VERSION "\r\n"
243 "Content-Type: text/plain\r\n"
244 "Connection: close\r\n\r\n"
245 "Bad response. The server or forwarder response doesn't look like HTTP.\r\n";
248 /* XXX: should be a template */
249 static const char NULL_BYTE_RESPONSE[] =
250 "HTTP/1.0 400 Bad request received from client\r\n"
251 "Proxy-Agent: Privoxy " VERSION "\r\n"
252 "Content-Type: text/plain\r\n"
253 "Connection: close\r\n\r\n"
254 "Bad request. Null byte(s) before end of request.\r\n";
257 /* XXX: should be a template */
258 static const char MESSED_UP_REQUEST_RESPONSE[] =
259 "HTTP/1.0 400 Malformed request after rewriting\r\n"
260 "Proxy-Agent: Privoxy " VERSION "\r\n"
261 "Content-Type: text/plain\r\n"
262 "Connection: close\r\n\r\n"
263 "Bad request. Messed up with header filters.\r\n";
265 static const char TOO_MANY_CONNECTIONS_RESPONSE[] =
266 "HTTP/1.0 503 Too many open connections\r\n"
267 "Proxy-Agent: Privoxy " VERSION "\r\n"
268 "Content-Type: text/plain\r\n"
269 "Connection: close\r\n\r\n"
270 "Maximum number of open connections reached.\r\n";
272 static const char CLIENT_CONNECTION_TIMEOUT_RESPONSE[] =
273 "HTTP/1.0 504 Connection timeout\r\n"
274 "Proxy-Agent: Privoxy " VERSION "\r\n"
275 "Content-Type: text/plain\r\n"
276 "Connection: close\r\n\r\n"
277 "The connection timed out because the client request didn't arrive in time.\r\n";
279 /* A function to crunch a response */
280 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
282 /* Crunch function flags */
283 #define CF_NO_FLAGS 0
284 /* Cruncher applies to forced requests as well */
285 #define CF_IGNORE_FORCE 1
286 /* Crunched requests are counted for the block statistics */
287 #define CF_COUNT_AS_REJECT 2
289 /* A crunch function and its flags */
292 const crunch_func_ptr cruncher;
296 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
298 /* Complete list of cruncher functions */
299 static const struct cruncher crunchers_all[] = {
300 { direct_response, CF_COUNT_AS_REJECT|CF_IGNORE_FORCE},
301 { block_url, CF_COUNT_AS_REJECT },
303 { trust_url, CF_COUNT_AS_REJECT },
304 #endif /* def FEATURE_TRUST */
305 { redirect_url, CF_NO_FLAGS },
306 { dispatch_cgi, CF_IGNORE_FORCE},
310 /* Light version, used after tags are applied */
311 static const struct cruncher crunchers_light[] = {
312 { block_url, CF_COUNT_AS_REJECT },
313 { redirect_url, CF_NO_FLAGS },
319 * XXX: Don't we really mean
325 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
326 /*********************************************************************
328 * Function : sig_handler
330 * Description : Signal handler for different signals.
331 * Exit gracefully on TERM and INT
332 * or set a flag that will cause the errlog
333 * to be reopened by the main thread on HUP.
336 * 1 : the_signal = the signal cause this function to call
340 *********************************************************************/
341 static void sig_handler(int the_signal)
347 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
359 received_hup_signal = 1;
365 * We shouldn't be here, unless we catch signals
366 * in main() that we can't handle here!
368 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
376 /*********************************************************************
378 * Function : client_protocol_is_unsupported
380 * Description : Checks if the client used a known unsupported
381 * protocol and deals with it by sending an error
385 * 1 : csp = Current client state (buffers, headers, etc...)
386 * 2 : req = the first request line send by the client
388 * Returns : TRUE if an error response has been generated, or
389 * FALSE if the request doesn't look invalid.
391 *********************************************************************/
392 static int client_protocol_is_unsupported(const struct client_state *csp, char *req)
395 * If it's a FTP or gopher request, we don't support it.
397 * These checks are better than nothing, but they might
398 * not work in all configurations and some clients might
399 * have problems digesting the answer.
401 * They should, however, never cause more problems than
402 * Privoxy's old behaviour (returning the misleading HTML
405 * "Could not resolve http://(ftp|gopher)://example.org").
407 if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
409 const char *response = NULL;
410 const char *protocol = NULL;
412 if (!strncmpic(req, "GET ftp://", 10))
414 response = FTP_RESPONSE;
419 response = GOPHER_RESPONSE;
422 log_error(LOG_LEVEL_ERROR,
423 "%s tried to use Privoxy as %s proxy: %s",
424 csp->ip_addr_str, protocol, req);
425 log_error(LOG_LEVEL_CLF,
426 "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, req);
428 write_socket(csp->cfd, response, strlen(response));
437 /*********************************************************************
439 * Function : get_request_destination_elsewhere
441 * Description : If the client's request was redirected into
442 * Privoxy without the client's knowledge,
443 * the request line lacks the destination host.
445 * This function tries to get it elsewhere,
446 * provided accept-intercepted-requests is enabled.
448 * "Elsewhere" currently only means "Host: header",
449 * but in the future we may ask the redirecting
450 * packet filter to look the destination up.
452 * If the destination stays unknown, an error
453 * response is send to the client and headers
454 * are freed so that chat() can return directly.
457 * 1 : csp = Current client state (buffers, headers, etc...)
458 * 2 : headers = a header list
460 * Returns : JB_ERR_OK if the destination is now known, or
461 * JB_ERR_PARSE if it isn't.
463 *********************************************************************/
464 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
468 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
470 log_error(LOG_LEVEL_ERROR, "%s's request: \'%s\' is invalid."
471 " Privoxy isn't configured to accept intercepted requests.",
472 csp->ip_addr_str, csp->http->cmd);
473 /* XXX: Use correct size */
474 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
475 csp->ip_addr_str, csp->http->cmd);
477 write_socket(csp->cfd, CHEADER, strlen(CHEADER));
478 destroy_list(headers);
482 else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
484 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
485 /* Split the domain we just got for pattern matching */
486 init_domain_components(csp->http);
493 /* We can't work without destination. Go spread the news.*/
495 req = list_to_text(headers);
497 /* XXX: Use correct size */
498 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
499 csp->ip_addr_str, csp->http->cmd);
500 log_error(LOG_LEVEL_ERROR,
501 "Privoxy was unable to get the destination for %s's request:\n%s\n%s",
502 csp->ip_addr_str, csp->http->cmd, req);
505 write_socket(csp->cfd, MISSING_DESTINATION_RESPONSE, strlen(MISSING_DESTINATION_RESPONSE));
506 destroy_list(headers);
511 * TODO: If available, use PF's ioctl DIOCNATLOOK as last resort
512 * to get the destination IP address, use it as host directly
513 * or do a reverse DNS lookup first.
518 /*********************************************************************
520 * Function : get_server_headers
522 * Description : Parses server headers in iob and fills them
523 * into csp->headers so that they can later be
527 * 1 : csp = Current client state (buffers, headers, etc...)
529 * Returns : JB_ERR_OK if everything went fine, or
530 * JB_ERR_PARSE if the headers were incomplete.
532 *********************************************************************/
533 static jb_err get_server_headers(struct client_state *csp)
535 int continue_hack_in_da_house = 0;
538 while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
543 * continue hack in da house. Ignore the ending of
544 * this head and continue enlisting header lines.
545 * The reason is described below.
547 enlist(csp->headers, "");
548 continue_hack_in_da_house = 0;
551 else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
554 * It's a bodyless continue response, don't
555 * stop header parsing after reaching its end.
557 * As a result Privoxy will concatenate the
558 * next response's head and parse and deliver
559 * the headers as if they belonged to one request.
561 * The client will separate them because of the
562 * empty line between them.
564 * XXX: What we're doing here is clearly against
565 * the intended purpose of the continue header,
566 * and under some conditions (HTTP/1.0 client request)
567 * it's a standard violation.
569 * Anyway, "sort of against the spec" is preferable
570 * to "always getting confused by Continue responses"
571 * (Privoxy's behaviour before this hack was added)
573 log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
574 continue_hack_in_da_house = 1;
576 else if (*header == '\0')
579 * If the header is empty, but the Continue hack
580 * isn't active, we can assume that we reached the
581 * end of the buffer before we hit the end of the
584 * Inform the caller an let it decide how to handle it.
589 if (JB_ERR_MEMORY == enlist(csp->headers, header))
592 * XXX: Should we quit the request and return a
593 * out of memory error page instead?
595 log_error(LOG_LEVEL_ERROR,
596 "Out of memory while enlisting server headers. %s lost.",
606 /*********************************************************************
608 * Function : crunch_reason
610 * Description : Translates the crunch reason code into a string.
613 * 1 : rsp = a http_response
615 * Returns : A string with the crunch reason or an error description.
617 *********************************************************************/
618 static const char *crunch_reason(const struct http_response *rsp)
620 char * reason = NULL;
625 return "Internal error while searching for crunch reason";
630 case RSP_REASON_UNSUPPORTED:
631 reason = "Unsupported HTTP feature";
633 case RSP_REASON_BLOCKED:
636 case RSP_REASON_UNTRUSTED:
637 reason = "Untrusted";
639 case RSP_REASON_REDIRECTED:
640 reason = "Redirected";
642 case RSP_REASON_CGI_CALL:
645 case RSP_REASON_NO_SUCH_DOMAIN:
646 reason = "DNS failure";
648 case RSP_REASON_FORWARDING_FAILED:
649 reason = "Forwarding failed";
651 case RSP_REASON_CONNECT_FAILED:
652 reason = "Connection failure";
654 case RSP_REASON_OUT_OF_MEMORY:
655 reason = "Out of memory (may mask other reasons)";
657 case RSP_REASON_CONNECTION_TIMEOUT:
658 reason = "Connection timeout";
660 case RSP_REASON_NO_SERVER_DATA:
661 reason = "No server data received";
664 reason = "No reason recorded";
672 /*********************************************************************
674 * Function : send_crunch_response
676 * Description : Delivers already prepared response for
677 * intercepted requests, logs the interception
678 * and frees the response.
681 * 1 : csp = Current client state (buffers, headers, etc...)
682 * 1 : rsp = Fully prepared response. Will be freed on exit.
686 *********************************************************************/
687 static void send_crunch_response(const struct client_state *csp, struct http_response *rsp)
689 const struct http_request *http = csp->http;
693 assert(rsp->head != NULL);
698 * Not supposed to happen. If it does
699 * anyway, treat it as an unknown error.
701 cgi_error_unknown(csp, rsp, RSP_REASON_INTERNAL_ERROR);
702 /* return code doesn't matter */
707 /* If rsp is still NULL, we have serious internal problems. */
708 log_error(LOG_LEVEL_FATAL,
709 "NULL response in send_crunch_response and cgi_error_unknown failed as well.");
713 * Extract the status code from the actual head
714 * that was send to the client. It is the only
715 * way to get it right for all requests, including
716 * the fixed ones for out-of-memory problems.
718 * A head starts like this: 'HTTP/1.1 200...'
722 status_code[0] = rsp->head[9];
723 status_code[1] = rsp->head[10];
724 status_code[2] = rsp->head[11];
725 status_code[3] = '\0';
727 /* Write the answer to the client */
728 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
729 || write_socket(csp->cfd, rsp->body, rsp->content_length))
731 /* There is nothing we can do about it. */
732 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", csp->http->host);
735 /* Log that the request was crunched and why. */
736 log_error(LOG_LEVEL_CRUNCH, "%s: %s", crunch_reason(rsp), http->url);
737 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" %s %u",
738 csp->ip_addr_str, http->ocmd, status_code, rsp->content_length);
740 /* Clean up and return */
741 if (cgi_error_memory() != rsp)
743 free_http_response(rsp);
750 /*********************************************************************
752 * Function : request_contains_null_bytes
754 * Description : Checks for NULL bytes in the request and sends
755 * an error message to the client if any were found.
757 * XXX: currently not used, see comment in chat().
760 * 1 : csp = Current client state (buffers, headers, etc...)
761 * 2 : buf = Data from the client's request to check.
762 * 3 : len = The data length.
764 * Returns : TRUE if the request contained one or more NULL bytes, or
767 *********************************************************************/
768 static int request_contains_null_bytes(const struct client_state *csp, char *buf, int len)
770 size_t c_len; /* Request lenght when treated as C string */
777 * Null byte(s) found. Log the request,
778 * return an error response and hang up.
780 size_t tmp_len = c_len;
785 * Replace NULL byte(s) with '°' characters
786 * so the request can be logged as string.
787 * XXX: Is there a better replacement character?
790 tmp_len += strlen(buf+tmp_len);
791 } while (tmp_len < len);
793 log_error(LOG_LEVEL_ERROR, "%s\'s request contains at least one NULL byte "
794 "(length=%d, strlen=%u).", csp->ip_addr_str, len, c_len);
795 log_error(LOG_LEVEL_HEADER,
796 "Offending request data with NULL bytes turned into \'°\' characters: %s", buf);
798 write_socket(csp->cfd, NULL_BYTE_RESPONSE, strlen(NULL_BYTE_RESPONSE));
800 /* XXX: Log correct size */
801 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
811 /*********************************************************************
813 * Function : crunch_response_triggered
815 * Description : Checks if the request has to be crunched,
816 * and delivers the crunch response if necessary.
819 * 1 : csp = Current client state (buffers, headers, etc...)
820 * 2 : crunchers = list of cruncher functions to run
822 * Returns : TRUE if the request was answered with a crunch response
825 *********************************************************************/
826 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
828 struct http_response *rsp = NULL;
829 const struct cruncher *c;
832 * If CGI request crunching is disabled,
833 * check the CGI dispatcher out of order to
834 * prevent unintentional blocks or redirects.
836 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
837 && (NULL != (rsp = dispatch_cgi(csp))))
839 /* Deliver, log and free the interception response. */
840 send_crunch_response(csp, rsp);
844 for (c = crunchers; c->cruncher != NULL; c++)
847 * Check the cruncher if either Privoxy is toggled
848 * on and the request isn't forced, or if the cruncher
849 * applies to forced requests as well.
851 if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
852 !(csp->flags & CSP_FLAG_FORCED)) ||
853 (c->flags & CF_IGNORE_FORCE))
855 rsp = c->cruncher(csp);
858 /* Deliver, log and free the interception response. */
859 send_crunch_response(csp, rsp);
860 #ifdef FEATURE_STATISTICS
861 if (c->flags & CF_COUNT_AS_REJECT)
863 csp->flags |= CSP_FLAG_REJECTED;
865 #endif /* def FEATURE_STATISTICS */
876 /*********************************************************************
878 * Function : build_request_line
880 * Description : Builds the HTTP request line.
882 * If a HTTP forwarder is used it expects the whole URL,
883 * web servers only get the path.
886 * 1 : csp = Current client state (buffers, headers, etc...)
887 * 2 : fwd = The forwarding spec used for the request
888 * XXX: Should use http->fwd instead.
889 * 3 : request_line = The old request line which will be replaced.
891 * Returns : Nothing. Terminates in case of memory problems.
893 *********************************************************************/
894 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
896 struct http_request *http = csp->http;
898 assert(http->ssl == 0);
901 * Downgrade http version from 1.1 to 1.0
902 * if +downgrade action applies.
904 if ( (csp->action->flags & ACTION_DOWNGRADE)
905 && (!strcmpic(http->ver, "HTTP/1.1")))
908 http->ver = strdup("HTTP/1.0");
910 if (http->ver == NULL)
912 log_error(LOG_LEVEL_FATAL, "Out of memory downgrading HTTP version");
917 * Rebuild the request line.
919 freez(*request_line);
920 *request_line = strdup(http->gpc);
921 string_append(request_line, " ");
923 if (fwd->forward_host)
925 string_append(request_line, http->url);
929 string_append(request_line, http->path);
931 string_append(request_line, " ");
932 string_append(request_line, http->ver);
934 if (*request_line == NULL)
936 log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
938 log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
942 /*********************************************************************
944 * Function : change_request_destination
946 * Description : Parse a (rewritten) request line and regenerate
947 * the http request data.
950 * 1 : csp = Current client state (buffers, headers, etc...)
952 * Returns : Forwards the parse_http_request() return code.
953 * Terminates in case of memory problems.
955 *********************************************************************/
956 static jb_err change_request_destination(struct client_state *csp)
958 struct http_request *http = csp->http;
961 log_error(LOG_LEVEL_INFO, "Rewrite detected: %s", csp->headers->first->str);
962 free_http_request(http);
963 err = parse_http_request(csp->headers->first->str, http);
964 if (JB_ERR_OK != err)
966 log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
967 jb_err_to_string(err));
971 /* XXX: ocmd is a misleading name */
972 http->ocmd = strdup(http->cmd);
973 if (http->ocmd == NULL)
975 log_error(LOG_LEVEL_FATAL,
976 "Out of memory copying rewritten HTTP request line");
984 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
985 /*********************************************************************
987 * Function : server_response_is_complete
989 * Description : Determines whether we should stop reading
990 * from the server socket.
993 * 1 : csp = Current client state (buffers, headers, etc...)
994 * 2 : content_length = Length of content received so far.
996 * Returns : TRUE if the response is complete,
999 *********************************************************************/
1000 static int server_response_is_complete(struct client_state *csp,
1001 unsigned long long content_length)
1003 int content_length_known = !!(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
1005 if (!strcmpic(csp->http->gpc, "HEAD"))
1008 * "HEAD" implies no body, we are thus expecting
1009 * no content. XXX: incomplete "list" of methods?
1011 csp->expected_content_length = 0;
1012 content_length_known = TRUE;
1015 if (csp->http->status == 304)
1018 * Expect no body. XXX: incomplete "list" of status codes?
1020 csp->expected_content_length = 0;
1021 content_length_known = TRUE;
1024 return (content_length_known && ((0 == csp->expected_content_length)
1025 || (csp->expected_content_length <= content_length)));
1029 #ifdef FEATURE_CONNECTION_SHARING
1030 /*********************************************************************
1032 * Function : wait_for_alive_connections
1034 * Description : Waits for alive connections to timeout.
1040 *********************************************************************/
1041 static void wait_for_alive_connections(void)
1043 int connections_alive = close_unusable_connections();
1045 while (0 < connections_alive)
1047 log_error(LOG_LEVEL_CONNECT,
1048 "Waiting for %d connections to timeout.",
1051 connections_alive = close_unusable_connections();
1054 log_error(LOG_LEVEL_CONNECT, "No connections to wait for left.");
1057 #endif /* def FEATURE_CONNECTION_SHARING */
1060 /*********************************************************************
1062 * Function : save_connection_destination
1064 * Description : Remembers a connection for reuse later on.
1067 * 1 : sfd = Open socket to remember.
1068 * 2 : http = The destination for the connection.
1069 * 3 : fwd = The forwarder settings used.
1070 * 3 : server_connection = storage.
1074 *********************************************************************/
1075 void save_connection_destination(jb_socket sfd,
1076 const struct http_request *http,
1077 const struct forward_spec *fwd,
1078 struct reusable_connection *server_connection)
1080 assert(sfd != JB_INVALID_SOCKET);
1081 assert(NULL != http->host);
1083 server_connection->sfd = sfd;
1084 server_connection->host = strdup(http->host);
1085 if (NULL == server_connection->host)
1087 log_error(LOG_LEVEL_FATAL, "Out of memory saving socket.");
1089 server_connection->port = http->port;
1091 assert(NULL != fwd);
1092 assert(server_connection->gateway_host == NULL);
1093 assert(server_connection->gateway_port == 0);
1094 assert(server_connection->forwarder_type == 0);
1095 assert(server_connection->forward_host == NULL);
1096 assert(server_connection->forward_port == 0);
1098 server_connection->forwarder_type = fwd->type;
1099 if (NULL != fwd->gateway_host)
1101 server_connection->gateway_host = strdup(fwd->gateway_host);
1102 if (NULL == server_connection->gateway_host)
1104 log_error(LOG_LEVEL_FATAL, "Out of memory saving gateway_host.");
1109 server_connection->gateway_host = NULL;
1111 server_connection->gateway_port = fwd->gateway_port;
1113 if (NULL != fwd->forward_host)
1115 server_connection->forward_host = strdup(fwd->forward_host);
1116 if (NULL == server_connection->forward_host)
1118 log_error(LOG_LEVEL_FATAL, "Out of memory saving forward_host.");
1123 server_connection->forward_host = NULL;
1125 server_connection->forward_port = fwd->forward_port;
1129 /*********************************************************************
1131 * Function : verify_request_length
1133 * Description : Checks if we already got the whole client requests
1134 * and sets CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ if
1137 * Data that doesn't belong to the current request is
1138 * thrown away to let the client retry on a clean socket.
1140 * XXX: This is a hack until we can deal with multiple
1141 * pipelined requests at the same time.
1145 * 1 : csp = Current client state (buffers, headers, etc...)
1149 *********************************************************************/
1150 static void verify_request_length(struct client_state *csp)
1152 unsigned long long buffered_request_bytes =
1153 (unsigned long long)(csp->iob->eod - csp->iob->cur);
1155 if ((csp->expected_client_content_length != 0)
1156 && (buffered_request_bytes != 0))
1158 if (csp->expected_client_content_length >= buffered_request_bytes)
1160 csp->expected_client_content_length -= buffered_request_bytes;
1161 log_error(LOG_LEVEL_CONNECT, "Reduced expected bytes to %llu "
1162 "to account for the %llu ones we already got.",
1163 csp->expected_client_content_length, buffered_request_bytes);
1167 assert(csp->iob->eod > csp->iob->cur + csp->expected_client_content_length);
1168 csp->iob->eod = csp->iob->cur + csp->expected_client_content_length;
1169 log_error(LOG_LEVEL_CONNECT, "Reducing expected bytes to 0. "
1170 "Marking the server socket tainted after throwing %llu bytes away.",
1171 buffered_request_bytes - csp->expected_client_content_length);
1172 csp->expected_client_content_length = 0;
1173 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1176 if (csp->expected_client_content_length == 0)
1178 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1182 if (!(csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ)
1183 && ((csp->iob->cur[0] != '\0') || (csp->expected_client_content_length != 0)))
1185 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1186 if (strcmpic(csp->http->gpc, "GET")
1187 && strcmpic(csp->http->gpc, "HEAD")
1188 && strcmpic(csp->http->gpc, "TRACE")
1189 && strcmpic(csp->http->gpc, "OPTIONS")
1190 && strcmpic(csp->http->gpc, "DELETE"))
1192 /* XXX: this is an incomplete hack */
1193 csp->flags &= ~CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1194 log_error(LOG_LEVEL_CONNECT,
1195 "There might be a request body. The connection will not be kept alive.");
1199 /* XXX: and so is this */
1200 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1201 log_error(LOG_LEVEL_CONNECT,
1202 "Possible pipeline attempt detected. The connection will not "
1203 "be kept alive and we will only serve the first request.");
1204 /* Nuke the pipelined requests from orbit, just to be sure. */
1205 csp->iob->buf[0] = '\0';
1206 csp->iob->eod = csp->iob->cur = csp->iob->buf;
1211 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1212 log_error(LOG_LEVEL_CONNECT, "Complete client request received.");
1215 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1218 /*********************************************************************
1220 * Function : mark_server_socket_tainted
1222 * Description : Makes sure we don't reuse a server socket
1223 * (if we didn't read everything the server sent
1224 * us reusing the socket would lead to garbage).
1227 * 1 : csp = Current client state (buffers, headers, etc...)
1231 *********************************************************************/
1232 static void mark_server_socket_tainted(struct client_state *csp)
1234 if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE))
1236 log_error(LOG_LEVEL_CONNECT,
1237 "Marking the server socket %d tainted.", csp->sfd);
1238 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1242 /*********************************************************************
1244 * Function : get_request_line
1246 * Description : Read the client request line.
1249 * 1 : csp = Current client state (buffers, headers, etc...)
1251 * Returns : Pointer to request line or NULL in case of errors.
1253 *********************************************************************/
1254 static char *get_request_line(struct client_state *csp)
1256 char buf[BUFFER_SIZE];
1257 char *request_line = NULL;
1260 memset(buf, 0, sizeof(buf));
1264 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1266 log_error(LOG_LEVEL_ERROR,
1267 "Stopped waiting for the request line.");
1268 write_socket(csp->cfd, CLIENT_CONNECTION_TIMEOUT_RESPONSE,
1269 strlen(CLIENT_CONNECTION_TIMEOUT_RESPONSE));
1273 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1275 if (len <= 0) return NULL;
1278 * If there is no memory left for buffering the
1279 * request, there is nothing we can do but hang up
1281 if (add_to_iob(csp, buf, len))
1286 request_line = get_header(csp->iob);
1288 } while ((NULL != request_line) && ('\0' == *request_line));
1290 return request_line;
1295 /*********************************************************************
1297 * Function : receive_client_request
1299 * Description : Read the client's request (more precisely the
1300 * client headers) and answer it if necessary.
1302 * Note that since we're not using select() we could get
1303 * blocked here if a client connected, then didn't say
1307 * 1 : csp = Current client state (buffers, headers, etc...)
1309 * Returns : JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
1311 *********************************************************************/
1312 static jb_err receive_client_request(struct client_state *csp)
1314 char buf[BUFFER_SIZE];
1317 struct http_request *http;
1321 /* Temporary copy of the client's headers before they get enlisted in csp->headers */
1322 struct list header_list;
1323 struct list *headers = &header_list;
1327 memset(buf, 0, sizeof(buf));
1329 req = get_request_line(csp);
1332 return JB_ERR_PARSE;
1334 assert(*req != '\0');
1336 if (client_protocol_is_unsupported(csp, req))
1338 return JB_ERR_PARSE;
1341 #ifdef FEATURE_FORCE_LOAD
1343 * If this request contains the FORCE_PREFIX and blocks
1344 * aren't enforced, get rid of it and set the force flag.
1346 if (strstr(req, FORCE_PREFIX))
1348 if (csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
1350 log_error(LOG_LEVEL_FORCE,
1351 "Ignored force prefix in request: \"%s\".", req);
1355 strclean(req, FORCE_PREFIX);
1356 log_error(LOG_LEVEL_FORCE, "Enforcing request: \"%s\".", req);
1357 csp->flags |= CSP_FLAG_FORCED;
1360 #endif /* def FEATURE_FORCE_LOAD */
1362 err = parse_http_request(req, http);
1364 if (JB_ERR_OK != err)
1366 write_socket(csp->cfd, CHEADER, strlen(CHEADER));
1367 /* XXX: Use correct size */
1368 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1369 log_error(LOG_LEVEL_ERROR,
1370 "Couldn't parse request line received from %s: %s",
1371 csp->ip_addr_str, jb_err_to_string(err));
1373 free_http_request(http);
1374 return JB_ERR_PARSE;
1377 /* grab the rest of the client's headers */
1381 p = get_header(csp->iob);
1385 /* There are no additional headers to read. */
1392 * We didn't receive a complete header
1393 * line yet, get the rest of it.
1395 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1397 log_error(LOG_LEVEL_ERROR,
1398 "Stopped grabbing the client headers.");
1399 destroy_list(headers);
1400 return JB_ERR_PARSE;
1403 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1406 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1407 destroy_list(headers);
1408 return JB_ERR_PARSE;
1411 if (add_to_iob(csp, buf, len))
1414 * If there is no memory left for buffering the
1415 * request, there is nothing we can do but hang up
1417 destroy_list(headers);
1418 return JB_ERR_MEMORY;
1424 * We were able to read a complete
1425 * header and can finaly enlist it.
1432 if (http->host == NULL)
1435 * If we still don't know the request destination,
1436 * the request is invalid or the client uses
1437 * Privoxy without its knowledge.
1439 if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1442 * Our attempts to get the request destination
1443 * elsewhere failed or Privoxy is configured
1444 * to only accept proxy requests.
1446 * An error response has already been send
1447 * and we're done here.
1449 return JB_ERR_PARSE;
1454 * Determine the actions for this URL
1456 #ifdef FEATURE_TOGGLE
1457 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1459 /* Most compatible set of actions (i.e. none) */
1460 init_current_action(csp->action);
1463 #endif /* ndef FEATURE_TOGGLE */
1465 get_url_actions(csp, http);
1469 * Save a copy of the original request for logging
1471 http->ocmd = strdup(http->cmd);
1472 if (http->ocmd == NULL)
1474 log_error(LOG_LEVEL_FATAL,
1475 "Out of memory copying HTTP request line");
1477 enlist(csp->headers, http->cmd);
1479 /* Append the previously read headers */
1480 list_append_list_unique(csp->headers, headers);
1481 destroy_list(headers);
1488 /*********************************************************************
1490 * Function : parse_client_request
1492 * Description : Parses the client's request and decides what to do
1495 * Note that since we're not using select() we could get
1496 * blocked here if a client connected, then didn't say
1500 * 1 : csp = Current client state (buffers, headers, etc...)
1502 * Returns : JB_ERR_OK or JB_ERR_PARSE
1504 *********************************************************************/
1505 static jb_err parse_client_request(struct client_state *csp)
1507 struct http_request *http = csp->http;
1510 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1511 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1512 && (!strcmpic(csp->http->ver, "HTTP/1.1"))
1513 && (csp->http->ssl == 0))
1515 /* Assume persistence until further notice */
1516 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1518 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1520 err = sed(csp, FILTER_CLIENT_HEADERS);
1521 if (JB_ERR_OK != err)
1523 /* XXX: Should be handled in sed(). */
1524 assert(err == JB_ERR_PARSE);
1525 log_error(LOG_LEVEL_FATAL, "Failed to parse client headers.");
1527 csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1529 /* Check request line for rewrites. */
1530 if ((NULL == csp->headers->first->str)
1531 || (strcmp(http->cmd, csp->headers->first->str) &&
1532 (JB_ERR_OK != change_request_destination(csp))))
1535 * A header filter broke the request line - bail out.
1537 write_socket(csp->cfd, MESSED_UP_REQUEST_RESPONSE, strlen(MESSED_UP_REQUEST_RESPONSE));
1538 /* XXX: Use correct size */
1539 log_error(LOG_LEVEL_CLF,
1540 "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
1541 log_error(LOG_LEVEL_ERROR,
1542 "Invalid request line after applying header filters.");
1543 free_http_request(http);
1545 return JB_ERR_PARSE;
1548 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1549 if (csp->http->ssl == 0)
1551 verify_request_length(csp);
1553 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1560 /*********************************************************************
1564 * Description : Once a connection to the client has been accepted,
1565 * this function is called (via serve()) to handle the
1566 * main business of the communication. When this
1567 * function returns, the caller must close the client
1570 * FIXME: chat is nearly thousand lines long.
1574 * 1 : csp = Current client state (buffers, headers, etc...)
1576 * Returns : Nothing.
1578 *********************************************************************/
1579 static void chat(struct client_state *csp)
1581 char buf[BUFFER_SIZE];
1588 int ms_iis5_hack = 0;
1589 unsigned long long byte_count = 0;
1590 int forwarded_connect_retries = 0;
1591 int max_forwarded_connect_retries = csp->config->forwarded_connect_retries;
1592 const struct forward_spec *fwd;
1593 struct http_request *http;
1594 long len = 0; /* for buffer sizes (and negative error codes) */
1596 /* Function that does the content filtering for the current request */
1597 filter_function_ptr content_filter = NULL;
1599 /* Skeleton for HTTP response, if we should intercept the request */
1600 struct http_response *rsp;
1601 struct timeval timeout;
1602 int watch_client_socket = 1;
1604 memset(buf, 0, sizeof(buf));
1608 if (receive_client_request(csp) != JB_ERR_OK)
1612 if (parse_client_request(csp) != JB_ERR_OK)
1617 /* decide how to route the HTTP request */
1618 fwd = forward_url(csp, http);
1621 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!? This can't happen!");
1622 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1627 * build the http request to send to the server
1628 * we have to do one of the following:
1630 * create = use the original HTTP request to create a new
1631 * HTTP request that has either the path component
1632 * without the http://domainspec (w/path) or the
1633 * full orininal URL (w/url)
1634 * Note that the path and/or the HTTP version may
1635 * have been altered by now.
1637 * connect = Open a socket to the host:port of the server
1638 * and short-circuit server and client socket.
1640 * pass = Pass the request unchanged if forwarding a CONNECT
1641 * request to a parent proxy. Note that we'll be sending
1642 * the CFAIL message ourselves if connecting to the parent
1643 * fails, but we won't send a CSUCCEED message if it works,
1644 * since that would result in a double message (ours and the
1645 * parent's). After sending the request to the parent, we simply
1648 * here's the matrix:
1651 * +--------+--------+
1653 * 0 | create | connect|
1655 * Forwarding +--------+--------+
1657 * 1 | create | pass |
1659 * +--------+--------+
1663 if (http->ssl && connect_port_is_forbidden(csp))
1665 const char *acceptable_connect_ports =
1666 csp->action->string[ACTION_STRING_LIMIT_CONNECT];
1667 assert(NULL != acceptable_connect_ports);
1668 log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
1669 "limit-connect{%s} doesn't allow CONNECT requests to port %d.",
1670 csp->ip_addr_str, acceptable_connect_ports, csp->http->port);
1671 csp->action->flags |= ACTION_BLOCK;
1677 freez(csp->headers->first->str);
1678 build_request_line(csp, fwd, &csp->headers->first->str);
1682 * We have a request. Check if one of the crunchers wants it.
1684 if (crunch_response_triggered(csp, crunchers_all))
1687 * Yes. The client got the crunch response
1688 * and we are done here after cleaning up.
1690 /* XXX: why list_remove_all()? */
1691 list_remove_all(csp->headers);
1696 log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
1698 if (fwd->forward_host)
1700 log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
1701 fwd->forward_host, fwd->forward_port, http->hostport);
1705 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
1708 /* here we connect to the server, gateway, or the forwarder */
1710 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1711 if ((csp->sfd != JB_INVALID_SOCKET)
1712 && socket_is_still_usable(csp->sfd)
1713 && connection_destination_matches(&csp->server_connection, http, fwd))
1715 log_error(LOG_LEVEL_CONNECT,
1716 "Reusing server socket %u. Opened for %s.",
1717 csp->sfd, csp->server_connection.host);
1721 if (csp->sfd != JB_INVALID_SOCKET)
1723 log_error(LOG_LEVEL_CONNECT,
1724 "Closing server socket %u. Opened for %s.",
1725 csp->sfd, csp->server_connection.host);
1726 close_socket(csp->sfd);
1727 mark_connection_closed(&csp->server_connection);
1729 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1731 while ((csp->sfd = forwarded_connect(fwd, http, csp))
1732 && (errno == EINVAL)
1733 && (forwarded_connect_retries++ < max_forwarded_connect_retries))
1735 log_error(LOG_LEVEL_ERROR,
1736 "failed request #%u to connect to %s. Trying again.",
1737 forwarded_connect_retries, http->hostport);
1740 if (csp->sfd == JB_INVALID_SOCKET)
1742 if (fwd->type != SOCKS_NONE)
1745 rsp = error_response(csp, "forwarding-failed");
1747 else if (errno == EINVAL)
1749 rsp = error_response(csp, "no-such-domain");
1753 rsp = error_response(csp, "connect-failed");
1754 log_error(LOG_LEVEL_CONNECT, "connect to: %s failed: %E",
1758 /* Write the answer to the client */
1761 send_crunch_response(csp, rsp);
1766 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1767 save_connection_destination(csp->sfd, http, fwd, &csp->server_connection);
1768 csp->server_connection.keep_alive_timeout = (unsigned)csp->config->keep_alive_timeout;
1770 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1772 hdr = list_to_text(csp->headers);
1775 /* FIXME Should handle error properly */
1776 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
1778 list_remove_all(csp->headers);
1780 if (fwd->forward_host || (http->ssl == 0))
1783 * Write the client's (modified) header to the server
1784 * (along with anything else that may be in the buffer)
1786 if (write_socket(csp->sfd, hdr, strlen(hdr))
1787 || (flush_socket(csp->sfd, csp->iob) < 0))
1789 log_error(LOG_LEVEL_CONNECT,
1790 "write header to: %s failed: %E", http->hostport);
1792 rsp = error_response(csp, "connect-failed");
1795 send_crunch_response(csp, rsp);
1805 * We're running an SSL tunnel and we're not forwarding,
1806 * so just send the "connect succeeded" message to the
1807 * client, flush the rest, and get out of the way.
1809 if (write_socket(csp->cfd, CSUCCEED, strlen(CSUCCEED)))
1817 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
1819 csp->server_connection.request_sent = time(NULL);
1821 /* we're finished with the client's header */
1824 maxfd = (csp->cfd > csp->sfd) ? csp->cfd : csp->sfd;
1826 /* pass data between the client and server
1827 * until one or the other shuts down the connection.
1836 * FD_ZERO here seems to point to an errant macro which crashes.
1837 * So do this by hand for now...
1839 memset(&rfds,0x00,sizeof(fd_set));
1843 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1844 if (!watch_client_socket)
1849 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1851 FD_SET(csp->cfd, &rfds);
1854 FD_SET(csp->sfd, &rfds);
1856 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1857 if ((csp->flags & CSP_FLAG_CHUNKED)
1858 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
1859 && ((csp->iob->eod - csp->iob->cur) >= 5)
1860 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
1862 log_error(LOG_LEVEL_CONNECT,
1863 "Looks like we read the last chunk together with "
1864 "the server headers. We better stop reading.");
1865 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
1866 csp->expected_content_length = byte_count;
1867 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
1869 if (server_body && server_response_is_complete(csp, byte_count))
1871 log_error(LOG_LEVEL_CONNECT,
1872 "Done reading from server. Expected content length: %llu. "
1873 "Actual content length: %llu. Bytes most recently read: %d.",
1874 csp->expected_content_length, byte_count, len);
1877 * XXX: should not jump around,
1878 * chat() is complicated enough already.
1882 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1884 timeout.tv_sec = csp->config->socket_timeout;
1885 timeout.tv_usec = 0;
1886 n = select((int)maxfd+1, &rfds, NULL, NULL, &timeout);
1890 log_error(LOG_LEVEL_ERROR,
1891 "Didn't receive data in time: %s", http->url);
1892 if ((byte_count == 0) && (http->ssl == 0))
1894 send_crunch_response(csp, error_response(csp, "connection-timeout"));
1896 mark_server_socket_tainted(csp);
1901 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
1902 mark_server_socket_tainted(csp);
1907 * This is the body of the browser's request,
1908 * just read and write it.
1910 * XXX: Make sure the client doesn't use pipelining
1911 * behind Privoxy's back.
1913 if (FD_ISSET(csp->cfd, &rfds))
1915 int max_bytes_to_read = sizeof(buf) - 1;
1917 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1918 if ((csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ))
1920 if (data_is_available(csp->cfd, 0))
1923 * If the next request is already waiting, we have
1924 * to stop select()ing the client socket. Otherwise
1925 * we would always return right away and get nothing
1928 watch_client_socket = 0;
1929 log_error(LOG_LEVEL_CONNECT,
1930 "Stopping to watch the client socket. "
1931 "There's already another request waiting.");
1935 * If the client socket is set, but there's no data
1936 * available on the socket, the client went fishing
1937 * and continuing talking to the server makes no sense.
1939 log_error(LOG_LEVEL_CONNECT, "The client closed socket %d while "
1940 "the server socket %d is still open.", csp->cfd, csp->sfd);
1941 mark_server_socket_tainted(csp);
1944 if (csp->expected_client_content_length != 0)
1946 if (csp->expected_client_content_length < (sizeof(buf) - 1))
1948 max_bytes_to_read = (int)csp->expected_client_content_length;
1950 log_error(LOG_LEVEL_CONNECT,
1951 "Waiting for up to %d bytes from the client.",
1954 assert(max_bytes_to_read < sizeof(buf));
1955 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1957 len = read_socket(csp->cfd, buf, max_bytes_to_read);
1961 /* XXX: not sure if this is necessary. */
1962 mark_server_socket_tainted(csp);
1963 break; /* "game over, man" */
1966 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1967 if (csp->expected_client_content_length != 0)
1969 assert(len <= max_bytes_to_read);
1970 csp->expected_client_content_length -= (unsigned)len;
1971 log_error(LOG_LEVEL_CONNECT,
1972 "Expected client content length set to %llu "
1973 "after reading %d bytes.",
1974 csp->expected_client_content_length, len);
1975 if (csp->expected_client_content_length == 0)
1977 log_error(LOG_LEVEL_CONNECT,
1978 "Done reading from the client.");
1979 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1982 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1984 if (write_socket(csp->sfd, buf, (size_t)len))
1986 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1987 mark_server_socket_tainted(csp);
1994 * The server wants to talk. It could be the header or the body.
1995 * If `hdr' is null, then it's the header otherwise it's the body.
1996 * FIXME: Does `hdr' really mean `host'? No.
1998 if (FD_ISSET(csp->sfd, &rfds))
2000 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2001 if (!socket_is_still_usable(csp->cfd))
2004 log_error(LOG_LEVEL_CONNECT,
2005 "The server still wants to talk, but the client may already have hung up on us.");
2007 log_error(LOG_LEVEL_CONNECT,
2008 "The server still wants to talk, but the client hung up on us.");
2009 mark_server_socket_tainted(csp);
2011 #endif /* def _WIN32 */
2013 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2016 len = read_socket(csp->sfd, buf, sizeof(buf) - 1);
2020 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
2022 if (http->ssl && (fwd->forward_host == NULL))
2025 * Just hang up. We already confirmed the client's CONNECT
2026 * request with status code 200 and unencrypted content is
2027 * no longer welcome.
2029 log_error(LOG_LEVEL_ERROR,
2030 "CONNECT already confirmed. Unable to tell the client about the problem.");
2033 else if (byte_count)
2036 * Just hang up. We already transmitted the original headers
2037 * and parts of the original content and therefore missed the
2038 * chance to send an error message (without risking data corruption).
2040 * XXX: we could retry with a fancy range request here.
2042 log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
2043 "Unable to tell the client about the problem.");
2044 mark_server_socket_tainted(csp);
2048 * XXX: Consider handling the cases above the same.
2050 mark_server_socket_tainted(csp);
2054 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2055 if (csp->flags & CSP_FLAG_CHUNKED)
2057 if ((len >= 5) && !memcmp(buf+len-5, "0\r\n\r\n", 5))
2059 /* XXX: this is a temporary hack */
2060 log_error(LOG_LEVEL_CONNECT,
2061 "Looks like we reached the end of the last chunk. "
2062 "We better stop reading.");
2063 csp->expected_content_length = byte_count + (unsigned long long)len;
2064 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2068 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2071 * Add a trailing zero to let be able to use string operations.
2072 * XXX: do we still need this with filter_popups gone?
2077 * Normally, this would indicate that we've read
2078 * as much as the server has sent us and we can
2079 * close the client connection. However, Microsoft
2080 * in its wisdom has released IIS/5 with a bug that
2081 * prevents it from sending the trailing \r\n in
2082 * a 302 redirect header (and possibly other headers).
2083 * To work around this if we've haven't parsed
2084 * a full header we'll append a trailing \r\n
2085 * and see if this now generates a valid one.
2087 * This hack shouldn't have any impacts. If we've
2088 * already transmitted the header or if this is a
2089 * SSL connection, then we won't bother with this
2090 * hack. So we only work on partially received
2091 * headers. If we append a \r\n and this still
2092 * doesn't generate a valid header, then we won't
2093 * transmit anything to the client.
2098 if (server_body || http->ssl)
2101 * If we have been buffering up the document,
2102 * now is the time to apply content modification
2103 * and send the result to the client.
2107 p = execute_content_filter(csp, content_filter);
2109 * If the content filter fails, use the original
2110 * buffer and length.
2111 * (see p != NULL ? p : csp->iob->cur below)
2115 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
2118 if (JB_ERR_OK != update_server_headers(csp))
2120 log_error(LOG_LEVEL_FATAL,
2121 "Failed to update server headers. after filtering.");
2124 hdr = list_to_text(csp->headers);
2127 /* FIXME Should handle error properly */
2128 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2131 if (write_socket(csp->cfd, hdr, strlen(hdr))
2132 || write_socket(csp->cfd,
2133 ((p != NULL) ? p : csp->iob->cur), (size_t)csp->content_length))
2135 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
2138 mark_server_socket_tainted(csp);
2146 break; /* "game over, man" */
2150 * This is NOT the body, so
2151 * Let's pretend the server just sent us a blank line.
2153 snprintf(buf, sizeof(buf), "\r\n");
2154 len = (int)strlen(buf);
2157 * Now, let the normal header parsing algorithm below do its
2158 * job. If it fails, we'll exit instead of continuing.
2165 * If this is an SSL connection or we're in the body
2166 * of the server document, just write it to the client,
2167 * unless we need to buffer the body for later content-filtering
2169 if (server_body || http->ssl)
2174 * If there is no memory left for buffering the content, or the buffer limit
2175 * has been reached, switch to non-filtering mode, i.e. make & write the
2176 * header, flush the iob and buf, and get out of the way.
2178 if (add_to_iob(csp, buf, len))
2183 log_error(LOG_LEVEL_INFO,
2184 "Flushing header and buffers. Stepping back from filtering.");
2186 hdr = list_to_text(csp->headers);
2190 * Memory is too tight to even generate the header.
2191 * Send our static "Out-of-memory" page.
2193 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
2194 rsp = cgi_error_memory();
2195 send_crunch_response(csp, rsp);
2196 mark_server_socket_tainted(csp);
2199 hdrlen = strlen(hdr);
2201 if (write_socket(csp->cfd, hdr, hdrlen)
2202 || ((flushed = flush_socket(csp->cfd, csp->iob)) < 0)
2203 || (write_socket(csp->cfd, buf, (size_t)len)))
2205 log_error(LOG_LEVEL_CONNECT,
2206 "Flush header and buffers to client failed: %E");
2208 mark_server_socket_tainted(csp);
2213 * Reset the byte_count to the amount of bytes
2214 * we just flushed. len will be added a few lines below,
2215 * hdrlen doesn't matter for LOG_LEVEL_CLF.
2217 byte_count = (unsigned long long)flushed;
2219 content_filter = NULL;
2225 if (write_socket(csp->cfd, buf, (size_t)len))
2227 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
2228 mark_server_socket_tainted(csp);
2232 byte_count += (unsigned long long)len;
2238 * We're still looking for the end of the server's header.
2239 * Buffer up the data we just read. If that fails, there's
2240 * little we can do but send our static out-of-memory page.
2242 if (add_to_iob(csp, buf, len))
2244 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
2245 rsp = cgi_error_memory();
2246 send_crunch_response(csp, rsp);
2247 mark_server_socket_tainted(csp);
2251 /* Convert iob into something sed() can digest */
2252 if (JB_ERR_PARSE == get_server_headers(csp))
2257 * Well, we tried our MS IIS/5 hack and it didn't work.
2258 * The header is incomplete and there isn't anything
2259 * we can do about it.
2261 log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
2262 "Applying the MS IIS5 hack didn't help.");
2263 log_error(LOG_LEVEL_CLF,
2264 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2265 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2266 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2267 mark_server_socket_tainted(csp);
2273 * Since we have to wait for more from the server before
2274 * we can parse the headers we just continue here.
2276 log_error(LOG_LEVEL_CONNECT,
2277 "Continuing buffering headers. Bytes most recently read: %d.",
2285 * Account for the content bytes we
2286 * might have gotten with the headers.
2288 assert(csp->iob->eod >= csp->iob->cur);
2289 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2292 /* Did we actually get anything? */
2293 if (NULL == csp->headers->first)
2295 log_error(LOG_LEVEL_ERROR,
2296 "Empty server or forwarder response received on socket %d.", csp->sfd);
2297 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2298 send_crunch_response(csp, error_response(csp, "no-server-data"));
2299 free_http_request(http);
2300 mark_server_socket_tainted(csp);
2304 assert(csp->headers->first->str);
2306 if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
2307 strncmpic(csp->headers->first->str, "ICY", 3))
2310 * It doesn't look like a HTTP (or Shoutcast) response:
2311 * tell the client and log the problem.
2313 if (strlen(csp->headers->first->str) > 30)
2315 csp->headers->first->str[30] = '\0';
2317 log_error(LOG_LEVEL_ERROR,
2318 "Invalid server or forwarder response. Starts with: %s",
2319 csp->headers->first->str);
2320 log_error(LOG_LEVEL_CLF,
2321 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2322 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2323 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2324 free_http_request(http);
2325 mark_server_socket_tainted(csp);
2330 * We have now received the entire server header,
2331 * filter it and send the result to the client
2333 if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
2335 log_error(LOG_LEVEL_FATAL, "Failed to parse server headers.");
2337 hdr = list_to_text(csp->headers);
2340 /* FIXME Should handle error properly */
2341 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2344 csp->server_connection.response_received = time(NULL);
2346 if (crunch_response_triggered(csp, crunchers_light))
2349 * One of the tags created by a server-header
2350 * tagger triggered a crunch. We already
2351 * delivered the crunch response to the client
2352 * and are done here after cleaning up.
2355 mark_server_socket_tainted(csp);
2358 /* Buffer and pcrs filter this if appropriate. */
2360 if (!http->ssl) /* We talk plaintext */
2362 content_filter = get_filter_function(csp);
2365 * Only write if we're not buffering for content modification
2367 if (!content_filter)
2370 * Write the server's (modified) header to
2371 * the client (along with anything else that
2372 * may be in the buffer)
2375 if (write_socket(csp->cfd, hdr, strlen(hdr))
2376 || ((len = flush_socket(csp->cfd, csp->iob)) < 0))
2378 log_error(LOG_LEVEL_CONNECT, "write header to client failed: %E");
2381 * The write failed, so don't bother mentioning it
2382 * to the client... it probably can't hear us anyway.
2385 mark_server_socket_tainted(csp);
2390 /* we're finished with the server's header */
2396 * If this was a MS IIS/5 hack then it means the server
2397 * has already closed the connection. Nothing more to read.
2402 log_error(LOG_LEVEL_ERROR,
2403 "Closed server connection detected. "
2404 "Applying the MS IIS5 hack didn't help.");
2405 log_error(LOG_LEVEL_CLF,
2406 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2407 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2408 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2409 mark_server_socket_tainted(csp);
2415 mark_server_socket_tainted(csp);
2416 return; /* huh? we should never get here */
2419 if (csp->content_length == 0)
2422 * If Privoxy didn't recalculate the Content-Lenght,
2423 * byte_count is still correct.
2425 csp->content_length = byte_count;
2428 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2429 if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2430 && (csp->expected_content_length != byte_count))
2432 log_error(LOG_LEVEL_CONNECT,
2433 "Received %llu bytes while expecting %llu.",
2434 byte_count, csp->expected_content_length);
2435 mark_server_socket_tainted(csp);
2439 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
2440 csp->ip_addr_str, http->ocmd, csp->content_length);
2442 csp->server_connection.timestamp = time(NULL);
2446 /*********************************************************************
2450 * Description : This is little more than chat. We only "serve" to
2451 * to close (or remember) any socket that chat may have
2455 * 1 : csp = Current client state (buffers, headers, etc...)
2459 *********************************************************************/
2461 void serve(struct client_state *csp)
2462 #else /* ifndef AMIGA */
2463 static void serve(struct client_state *csp)
2464 #endif /* def AMIGA */
2466 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2467 #ifdef FEATURE_CONNECTION_SHARING
2468 static int monitor_thread_running = 0;
2469 #endif /* def FEATURE_CONNECTION_SHARING */
2470 int continue_chatting = 0;
2471 unsigned int latency = 0;
2477 continue_chatting = (csp->config->feature_flags
2478 & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
2479 && (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
2480 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
2481 && (csp->cfd != JB_INVALID_SOCKET)
2482 && (csp->sfd != JB_INVALID_SOCKET)
2483 && socket_is_still_usable(csp->sfd)
2484 && (latency < csp->server_connection.keep_alive_timeout);
2486 if (continue_chatting)
2488 unsigned int client_timeout;
2490 if (!(csp->flags & CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET))
2492 log_error(LOG_LEVEL_CONNECT, "The server didn't specify how long "
2493 "the connection will stay open. Assume it's only a second.");
2494 csp->server_connection.keep_alive_timeout = 1;
2497 client_timeout = (unsigned)csp->server_connection.keep_alive_timeout - latency;
2499 log_error(LOG_LEVEL_CONNECT,
2500 "Waiting for the next client request. "
2501 "Keeping the server socket %d to %s open.",
2502 csp->sfd, csp->server_connection.host);
2504 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
2505 && data_is_available(csp->cfd, (int)client_timeout)
2506 && socket_is_still_usable(csp->cfd))
2508 log_error(LOG_LEVEL_CONNECT, "Client request arrived in "
2509 "time or the client closed the connection.");
2511 * Get the csp in a mostly vergin state again.
2512 * XXX: Should be done elsewhere.
2514 csp->content_type = 0;
2515 csp->content_length = 0;
2516 csp->expected_content_length = 0;
2517 csp->expected_client_content_length = 0;
2518 list_remove_all(csp->headers);
2519 freez(csp->iob->buf);
2520 memset(csp->iob, 0, sizeof(csp->iob));
2521 freez(csp->error_message);
2522 free_http_request(csp->http);
2523 destroy_list(csp->headers);
2524 destroy_list(csp->tags);
2525 free_current_action(csp->action);
2526 if (NULL != csp->fwd)
2528 unload_forward_spec(csp->fwd);
2532 /* XXX: Store per-connection flags someplace else. */
2533 csp->flags = CSP_FLAG_ACTIVE | (csp->flags & CSP_FLAG_TOGGLED_ON);
2537 log_error(LOG_LEVEL_CONNECT,
2538 "No additional client request received in time.");
2539 #ifdef FEATURE_CONNECTION_SHARING
2540 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
2541 && (socket_is_still_usable(csp->sfd)))
2543 remember_connection(csp, forward_url(csp, csp->http));
2544 csp->sfd = JB_INVALID_SOCKET;
2545 close_socket(csp->cfd);
2546 csp->cfd = JB_INVALID_SOCKET;
2547 privoxy_mutex_lock(&connection_reuse_mutex);
2548 if (!monitor_thread_running)
2550 monitor_thread_running = 1;
2551 privoxy_mutex_unlock(&connection_reuse_mutex);
2552 wait_for_alive_connections();
2553 privoxy_mutex_lock(&connection_reuse_mutex);
2554 monitor_thread_running = 0;
2556 privoxy_mutex_unlock(&connection_reuse_mutex);
2558 #endif /* def FEATURE_CONNECTION_SHARING */
2562 else if (csp->sfd != JB_INVALID_SOCKET)
2564 log_error(LOG_LEVEL_CONNECT,
2565 "The connection on server socket %d to %s isn't reusable. "
2566 "Closing.", csp->sfd, csp->server_connection.host);
2568 } while (continue_chatting);
2570 mark_connection_closed(&csp->server_connection);
2573 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2575 if (csp->sfd != JB_INVALID_SOCKET)
2577 #ifdef FEATURE_CONNECTION_SHARING
2578 forget_connection(csp->sfd);
2579 #endif /* def FEATURE_CONNECTION_SHARING */
2580 close_socket(csp->sfd);
2583 if (csp->cfd != JB_INVALID_SOCKET)
2585 close_socket(csp->cfd);
2588 csp->flags &= ~CSP_FLAG_ACTIVE;
2594 /*********************************************************************
2596 * Function : server_thread
2598 * Description : We only exist to call `serve' in a threaded environment.
2601 * 1 : data = Current client state (buffers, headers, etc...)
2603 * Returns : Always 0.
2605 *********************************************************************/
2606 static int32 server_thread(void *data)
2608 serve((struct client_state *) data);
2615 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
2616 /*********************************************************************
2620 * Description : Print usage info & exit.
2622 * Parameters : Pointer to argv[0] for identifying ourselves
2626 *********************************************************************/
2627 static void usage(const char *myname)
2629 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
2633 #endif /* defined(unix) */
2636 "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
2637 #endif /* defined(unix) */
2638 "[--version] [configfile]\n"
2639 "Aborting\n", myname);
2644 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
2647 #ifdef MUTEX_LOCKS_AVAILABLE
2648 /*********************************************************************
2650 * Function : privoxy_mutex_lock
2652 * Description : Locks a mutex.
2655 * 1 : mutex = The mutex to lock.
2657 * Returns : Void. May exit in case of errors.
2659 *********************************************************************/
2660 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
2662 #ifdef FEATURE_PTHREAD
2663 int err = pthread_mutex_lock(mutex);
2666 if (mutex != &log_mutex)
2668 log_error(LOG_LEVEL_FATAL,
2669 "Mutex locking failed: %s.\n", strerror(err));
2674 EnterCriticalSection(mutex);
2675 #endif /* def FEATURE_PTHREAD */
2679 /*********************************************************************
2681 * Function : privoxy_mutex_unlock
2683 * Description : Unlocks a mutex.
2686 * 1 : mutex = The mutex to unlock.
2688 * Returns : Void. May exit in case of errors.
2690 *********************************************************************/
2691 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
2693 #ifdef FEATURE_PTHREAD
2694 int err = pthread_mutex_unlock(mutex);
2697 if (mutex != &log_mutex)
2699 log_error(LOG_LEVEL_FATAL,
2700 "Mutex unlocking failed: %s.\n", strerror(err));
2705 LeaveCriticalSection(mutex);
2706 #endif /* def FEATURE_PTHREAD */
2710 /*********************************************************************
2712 * Function : privoxy_mutex_init
2714 * Description : Prepares a mutex.
2717 * 1 : mutex = The mutex to initialize.
2719 * Returns : Void. May exit in case of errors.
2721 *********************************************************************/
2722 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
2724 #ifdef FEATURE_PTHREAD
2725 int err = pthread_mutex_init(mutex, 0);
2728 printf("Fatal error. Mutex initialization failed: %s.\n",
2733 InitializeCriticalSection(mutex);
2734 #endif /* def FEATURE_PTHREAD */
2736 #endif /* def MUTEX_LOCKS_AVAILABLE */
2738 /*********************************************************************
2740 * Function : initialize_mutexes
2742 * Description : Prepares mutexes if mutex support is available.
2746 * Returns : Void, exits in case of errors.
2748 *********************************************************************/
2749 static void initialize_mutexes(void)
2751 #ifdef MUTEX_LOCKS_AVAILABLE
2753 * Prepare global mutex semaphores
2755 privoxy_mutex_init(&log_mutex);
2756 privoxy_mutex_init(&log_init_mutex);
2757 privoxy_mutex_init(&connection_reuse_mutex);
2760 * XXX: The assumptions below are a bit naive
2761 * and can cause locks that aren't necessary.
2763 * For example older FreeBSD versions (< 6.x?)
2764 * have no gethostbyname_r, but gethostbyname is
2767 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
2768 privoxy_mutex_init(&resolver_mutex);
2769 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
2771 * XXX: should we use a single mutex for
2772 * localtime() and gmtime() as well?
2774 #ifndef HAVE_GMTIME_R
2775 privoxy_mutex_init(&gmtime_mutex);
2776 #endif /* ndef HAVE_GMTIME_R */
2778 #ifndef HAVE_LOCALTIME_R
2779 privoxy_mutex_init(&localtime_mutex);
2780 #endif /* ndef HAVE_GMTIME_R */
2783 privoxy_mutex_init(&rand_mutex);
2784 #endif /* ndef HAVE_RANDOM */
2785 #endif /* def MUTEX_LOCKS_AVAILABLE */
2789 /*********************************************************************
2793 * Description : Load the config file and start the listen loop.
2794 * This function is a lot more *sane* with the `load_config'
2795 * and `listen_loop' functions; although it stills does
2796 * a *little* too much for my taste.
2799 * 1 : argc = Number of parameters (including $0).
2800 * 2 : argv = Array of (char *)'s to the parameters.
2802 * Returns : 1 if : can't open config file, unrecognized directive,
2803 * stats requested in multi-thread mode, can't open the
2804 * log file, can't open the jar file, listen port is invalid,
2805 * any load fails, and can't bind port.
2807 * Else main never returns, the process must be signaled
2808 * to terminate execution. Or, on Windows, use the
2809 * "File", "Exit" menu option.
2811 *********************************************************************/
2813 int real_main(int argc, char **argv)
2815 int main(int argc, char **argv)
2819 unsigned int random_seed;
2821 struct passwd *pw = NULL;
2822 struct group *grp = NULL;
2825 char *pre_chroot_nslookup_to_load_resolver = NULL;
2832 #if !defined(_WIN32)
2839 /* Prepare mutexes if supported and necessary. */
2840 initialize_mutexes();
2842 /* Enable logging until further notice. */
2846 * Parse the command line arguments
2848 * XXX: simply printing usage information in case of
2849 * invalid arguments isn't particularly user friendly.
2851 while (++argc_pos < argc)
2854 /* Check to see if the service must be installed or uninstalled */
2855 if (strncmp(argv[argc_pos], "--install", 9) == 0)
2857 const char *pName = argv[argc_pos] + 9;
2860 exit( (install_service(pName)) ? 0 : 1 );
2862 else if (strncmp(argv[argc_pos], "--uninstall", + 11) == 0)
2864 const char *pName = argv[argc_pos] + 11;
2867 exit((uninstall_service(pName)) ? 0 : 1);
2869 else if (strcmp(argv[argc_pos], "--service" ) == 0)
2871 bRunAsService = TRUE;
2872 w32_set_service_cwd();
2873 atexit(w32_service_exit_notify);
2876 #endif /* defined(_WIN32) */
2879 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
2881 if (strcmp(argv[argc_pos], "--help") == 0)
2886 else if(strcmp(argv[argc_pos], "--version") == 0)
2888 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
2894 else if (strcmp(argv[argc_pos], "--no-daemon" ) == 0)
2896 set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
2900 else if (strcmp(argv[argc_pos], "--pidfile" ) == 0)
2902 if (++argc_pos == argc) usage(argv[0]);
2903 pidfile = strdup(argv[argc_pos]);
2906 else if (strcmp(argv[argc_pos], "--user" ) == 0)
2908 if (++argc_pos == argc) usage(argv[argc_pos]);
2910 if ((NULL != (p = strchr(argv[argc_pos], '.'))) && *(p + 1) != '0')
2913 if (NULL == (grp = getgrnam(p)))
2915 log_error(LOG_LEVEL_FATAL, "Group %s not found.", p);
2919 if (NULL == (pw = getpwnam(argv[argc_pos])))
2921 log_error(LOG_LEVEL_FATAL, "User %s not found.", argv[argc_pos]);
2924 if (p != NULL) *--p = '\0';
2927 else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup" ) == 0)
2929 if (++argc_pos == argc) usage(argv[0]);
2930 pre_chroot_nslookup_to_load_resolver = strdup(argv[argc_pos]);
2933 else if (strcmp(argv[argc_pos], "--chroot" ) == 0)
2937 #endif /* defined(unix) */
2939 else if (argc_pos + 1 != argc)
2942 * This is neither the last command line
2943 * option, nor was it recognized before,
2944 * therefore it must be invalid.
2950 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
2952 configfile = argv[argc_pos];
2955 } /* -END- while (more arguments) */
2957 show_version(Argv[0]);
2960 if ( *configfile != '/' )
2962 char cwd[BUFFER_SIZE];
2964 size_t abs_file_size;
2966 /* make config-filename absolute here */
2967 if (NULL == getcwd(cwd, sizeof(cwd)))
2969 perror("failed to get current working directory");
2974 abs_file_size = strlen(cwd) + strlen(configfile) + 5;
2975 basedir = strdup(cwd);
2977 if (NULL == basedir ||
2978 NULL == (abs_file = malloc(abs_file_size)))
2980 perror("malloc failed");
2983 strlcpy(abs_file, basedir, abs_file_size);
2984 strlcat(abs_file, "/", abs_file_size );
2985 strlcat(abs_file, configfile, abs_file_size);
2986 configfile = abs_file;
2988 #endif /* defined unix */
2992 clients->next = NULL;
2994 /* XXX: factor out initialising after the next stable release. */
2997 #elif defined(_WIN32)
3001 random_seed = (unsigned int)time(NULL);
3003 srandom(random_seed);
3006 #endif /* ifdef HAVE_RANDOM */
3009 * Unix signal handling
3011 * Catch the abort, interrupt and terminate signals for a graceful exit
3012 * Catch the hangup signal so the errlog can be reopened.
3013 * Ignore the broken pipe signals (FIXME: Why?)
3015 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
3018 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP, 0 };
3019 const int ignored_signals[] = { SIGPIPE, 0 };
3021 for (idx = 0; catched_signals[idx] != 0; idx++)
3023 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
3024 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
3026 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
3027 #endif /* ifdef sun */
3029 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
3033 for (idx = 0; ignored_signals[idx] != 0; idx++)
3035 if (signal(ignored_signals[idx], SIG_IGN) == SIG_ERR)
3037 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for signal %d: %E", ignored_signals[idx]);
3042 #else /* ifdef _WIN32 */
3043 # ifdef _WIN_CONSOLE
3045 * We *are* in a windows console app.
3046 * Print a verbose messages about FAQ's and such
3048 printf("%s", win32_blurb);
3049 # endif /* def _WIN_CONSOLE */
3050 #endif /* def _WIN32 */
3053 /* Initialize the CGI subsystem */
3054 cgi_init_error_messages();
3057 * If runnig on unix and without the --nodaemon
3058 * option, become a daemon. I.e. fork, detach
3059 * from tty and get process group leadership
3072 if ( pid < 0 ) /* error */
3077 else if ( pid != 0 ) /* parent */
3082 * must check for errors
3083 * child died due to missing files aso
3086 wpid = waitpid( pid, &status, WNOHANG );
3095 /* Should be more portable, but not as well tested */
3100 #else /* ndef __FreeBSD__ */
3102 #endif /* ndef __FreeBSD__ */
3103 fd = open("/dev/tty", O_RDONLY);
3106 /* no error check here */
3107 ioctl( fd, TIOCNOTTY,0 );
3112 * stderr (fd 2) will be closed later on,
3113 * when the config file has been parsed.
3120 } /* -END- if (!no_daemon) */
3123 * As soon as we have written the PID file, we can switch
3124 * to the user and group ID indicated by the --user option
3130 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
3132 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
3136 if (setgroups(1, &grp->gr_gid))
3138 log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
3141 else if (initgroups(pw->pw_name, pw->pw_gid))
3143 log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
3149 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
3151 /* Read the time zone file from /etc before doing chroot. */
3153 if (NULL != pre_chroot_nslookup_to_load_resolver
3154 && '\0' != pre_chroot_nslookup_to_load_resolver[0])
3156 /* Initialize resolver library. */
3157 (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
3159 if (chroot(pw->pw_dir) < 0)
3161 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
3165 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
3168 if (setuid(pw->pw_uid))
3170 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
3174 char putenv_dummy[64];
3176 strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
3177 if (putenv(putenv_dummy) != 0)
3179 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
3182 snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
3183 if (putenv(putenv_dummy) != 0)
3185 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
3191 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
3194 #endif /* defined unix */
3197 /* This will be FALSE unless the command line specified --service
3201 /* Yup, so now we must attempt to establish a connection
3202 * with the service dispatcher. This will only work if this
3203 * process was launched by the service control manager to
3204 * actually run as a service. If this isn't the case, i've
3205 * known it take around 30 seconds or so for the call to return.
3208 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
3209 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
3211 /* Service has run, and at this point is now being stopped, so just return */
3216 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
3218 /* An error occurred. Usually it's because --service was wrongly specified
3219 * and we were unable to connect to the Service Control Dispatcher because
3220 * it wasn't expecting us and is therefore not listening.
3222 * For now, just continue below to call the listen_loop function.
3225 #endif /* def _WIN32 */
3235 /*********************************************************************
3237 * Function : bind_port_helper
3239 * Description : Bind the listen port. Handles logging, and aborts
3243 * 1 : config = Privoxy configuration. Specifies port
3246 * Returns : Port that was opened.
3248 *********************************************************************/
3249 static jb_socket bind_port_helper(struct configuration_spec * config)
3254 if (config->haddr == NULL)
3256 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
3261 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
3262 config->hport, config->haddr);
3265 result = bind_port(config->haddr, config->hport, &bfd);
3272 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
3273 "There may be another Privoxy or some other "
3274 "proxy running on port %d",
3275 (NULL != config->haddr) ? config->haddr : "INADDR_ANY",
3276 config->hport, config->hport);
3279 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
3280 "The hostname is not resolvable",
3281 (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
3284 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: %E",
3285 (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
3288 /* shouldn't get here */
3289 return JB_INVALID_SOCKET;
3292 config->need_bind = 0;
3299 /* Without this simple workaround we get this compiler warning from _beginthread
3300 * warning C4028: formal parameter 1 different from declaration
3302 void w32_service_listen_loop(void *p)
3306 #endif /* def _WIN32 */
3309 /*********************************************************************
3311 * Function : listen_loop
3313 * Description : bind the listen port and enter a "FOREVER" listening loop.
3319 *********************************************************************/
3320 static void listen_loop(void)
3322 struct client_state *csp = NULL;
3324 struct configuration_spec *config;
3325 unsigned int active_threads = 0;
3327 config = load_config();
3329 #ifdef FEATURE_CONNECTION_SHARING
3331 * XXX: Should be relocated once it no
3332 * longer needs to emit log messages.
3334 initialize_reusable_connections();
3335 #endif /* def FEATURE_CONNECTION_SHARING */
3337 bfd = bind_port_helper(config);
3339 #ifdef FEATURE_GRACEFUL_TERMINATION
3340 while (!g_terminate)
3345 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
3346 while (waitpid(-1, NULL, WNOHANG) > 0)
3348 /* zombie children */
3350 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
3353 * Free data that was used by died threads
3355 active_threads = sweep();
3359 * Re-open the errlog after HUP signal
3361 if (received_hup_signal)
3363 if (NULL != config->logfile)
3365 init_error_log(Argv[0], config->logfile);
3367 received_hup_signal = 0;
3371 if ( NULL == (csp = (struct client_state *) zalloc(sizeof(*csp))) )
3373 log_error(LOG_LEVEL_FATAL, "malloc(%d) for csp failed: %E", sizeof(*csp));
3377 csp->flags |= CSP_FLAG_ACTIVE;
3378 csp->sfd = JB_INVALID_SOCKET;
3380 csp->config = config = load_config();
3382 if ( config->need_bind )
3385 * Since we were listening to the "old port", we will not see
3386 * a "listen" param change until the next request. So, at
3387 * least 1 more request must be made for us to find the new
3388 * setting. I am simply closing the old socket and binding the
3391 * Which-ever is correct, we will serve 1 more page via the
3392 * old settings. This should probably be a "show-proxy-args"
3393 * request. This should not be a so common of an operation
3394 * that this will hurt people's feelings.
3399 bfd = bind_port_helper(config);
3402 log_error(LOG_LEVEL_CONNECT, "Listening for new connections ... ");
3404 if (!accept_connection(csp, bfd))
3406 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
3419 log_error(LOG_LEVEL_CONNECT, "accepted connection from %s", csp->ip_addr_str);
3422 #ifdef FEATURE_TOGGLE
3423 if (global_toggle_state)
3424 #endif /* def FEATURE_TOGGLE */
3426 csp->flags |= CSP_FLAG_TOGGLED_ON;
3429 if (run_loader(csp))
3431 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
3432 /* Never get here - LOG_LEVEL_FATAL causes program exit */
3436 if (block_acl(NULL,csp))
3438 log_error(LOG_LEVEL_CONNECT, "Connection from %s dropped due to ACL", csp->ip_addr_str);
3439 close_socket(csp->cfd);
3440 freez(csp->ip_addr_str);
3444 #endif /* def FEATURE_ACL */
3446 if ((0 != config->max_client_connections)
3447 && (active_threads >= config->max_client_connections))
3449 log_error(LOG_LEVEL_CONNECT,
3450 "Rejecting connection from %s. Maximum number of connections reached.",
3452 write_socket(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
3453 strlen(TOO_MANY_CONNECTIONS_RESPONSE));
3454 close_socket(csp->cfd);
3455 freez(csp->ip_addr_str);
3460 /* add it to the list of clients */
3461 csp->next = clients->next;
3462 clients->next = csp;
3464 if (config->multi_threaded)
3468 /* this is a switch () statment in the C preprocessor - ugh */
3469 #undef SELECTED_ONE_OPTION
3471 /* Use Pthreads in preference to native code */
3472 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
3473 #define SELECTED_ONE_OPTION
3475 pthread_t the_thread;
3476 pthread_attr_t attrs;
3478 pthread_attr_init(&attrs);
3479 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
3480 errno = pthread_create(&the_thread, &attrs,
3481 (void * (*)(void *))serve, csp);
3482 child_id = errno ? -1 : 0;
3483 pthread_attr_destroy(&attrs);
3487 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
3488 #define SELECTED_ONE_OPTION
3489 child_id = _beginthread(
3490 (void (*)(void *))serve,
3495 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
3496 #define SELECTED_ONE_OPTION
3497 child_id = _beginthread(
3498 (void(* _Optlink)(void*))serve,
3504 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
3505 #define SELECTED_ONE_OPTION
3507 thread_id tid = spawn_thread
3508 (server_thread, "server", B_NORMAL_PRIORITY, csp);
3510 if ((tid >= 0) && (resume_thread(tid) == B_OK))
3512 child_id = (int) tid;
3521 #if defined(AMIGA) && !defined(SELECTED_ONE_OPTION)
3522 #define SELECTED_ONE_OPTION
3523 csp->cfd = ReleaseSocket(csp->cfd, -1);
3526 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
3527 NP_Output, Output(),
3528 NP_CloseOutput, FALSE,
3529 NP_Name, (ULONG)"privoxy child",
3533 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
3534 NP_Output, Output(),
3535 NP_CloseOutput, FALSE,
3536 NP_Name, (ULONG)"privoxy child",
3537 NP_StackSize, 200*1024,
3543 ((struct Task *)child_id)->tc_UserData = csp;
3544 Signal((struct Task *)child_id, SIGF_SINGLE);
3549 #if !defined(SELECTED_ONE_OPTION)
3552 /* This block is only needed when using fork().
3553 * When using threads, the server thread was
3554 * created and run by the call to _beginthread().
3556 if (child_id == 0) /* child */
3559 #ifdef FEATURE_TOGGLE
3560 int inherited_toggle_state = global_toggle_state;
3561 #endif /* def FEATURE_TOGGLE */
3566 * If we've been toggled or we've blocked the request, tell Mom
3569 #ifdef FEATURE_TOGGLE
3570 if (inherited_toggle_state != global_toggle_state)
3572 rc |= RC_FLAG_TOGGLED;
3574 #endif /* def FEATURE_TOGGLE */
3576 #ifdef FEATURE_STATISTICS
3577 if (csp->flags & CSP_FLAG_REJECTED)
3579 rc |= RC_FLAG_BLOCKED;
3581 #endif /* ndef FEATURE_STATISTICS */
3585 else if (child_id > 0) /* parent */
3587 /* in a fork()'d environment, the parent's
3588 * copy of the client socket and the CSP
3592 #if !defined(_WIN32) && !defined(__CYGWIN__)
3594 wait( &child_status );
3597 * Evaluate child's return code: If the child has
3598 * - been toggled, toggle ourselves
3599 * - blocked its request, bump up the stats counter
3602 #ifdef FEATURE_TOGGLE
3603 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
3605 global_toggle_state = !global_toggle_state;
3607 #endif /* def FEATURE_TOGGLE */
3609 #ifdef FEATURE_STATISTICS
3611 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
3615 #endif /* def FEATURE_STATISTICS */
3617 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
3618 close_socket(csp->cfd);
3619 csp->flags &= ~CSP_FLAG_ACTIVE;
3623 #undef SELECTED_ONE_OPTION
3624 /* end of cpp switch () */
3629 * Spawning the child failed, assume it's because
3630 * there are too many children running already.
3631 * XXX: If you assume ...
3633 log_error(LOG_LEVEL_ERROR,
3634 "Unable to take any additional connections: %E");
3635 write_socket(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
3636 strlen(TOO_MANY_CONNECTIONS_RESPONSE));
3637 close_socket(csp->cfd);
3638 csp->flags &= ~CSP_FLAG_ACTIVE;
3647 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
3649 /* Clean up. Aim: free all memory (no leaks) */
3650 #ifdef FEATURE_GRACEFUL_TERMINATION
3652 log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
3654 unload_current_config_file();
3655 unload_current_actions_file();
3656 unload_current_re_filterfile();
3657 #ifdef FEATURE_TRUST
3658 unload_current_trust_file();
3661 if (config->multi_threaded)
3668 } while ((clients->next != NULL) && (--i > 0));
3672 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
3683 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
3684 /* Cleanup - remove taskbar icon etc. */
3689 #endif /* FEATURE_GRACEFUL_TERMINATION */