handle-as-empty-document shouldn't be dependent on the image blocking
[privoxy.git] / jcc.c
1 const char jcc_rcs[] = "$Id: jcc.c,v 1.301 2009/10/08 07:36:37 fabiankeil Exp $";
2 /*********************************************************************
3  *
4  * File        :  $Source: /cvsroot/ijbswa/current/jcc.c,v $
5  *
6  * Purpose     :  Main file.  Contains main() method, main loop, and
7  *                the main connection-handling function.
8  *
9  * Copyright   :  Written by and Copyright (C) 2001-2009 the SourceForge
10  *                Privoxy team. http://www.privoxy.org/
11  *
12  *                Based on the Internet Junkbuster originally written
13  *                by and Copyright (C) 1997 Anonymous Coders and
14  *                Junkbusters Corporation.  http://www.junkbusters.com
15  *
16  *                This program is free software; you can redistribute it
17  *                and/or modify it under the terms of the GNU General
18  *                Public License as published by the Free Software
19  *                Foundation; either version 2 of the License, or (at
20  *                your option) any later version.
21  *
22  *                This program is distributed in the hope that it will
23  *                be useful, but WITHOUT ANY WARRANTY; without even the
24  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
25  *                PARTICULAR PURPOSE.  See the GNU General Public
26  *                License for more details.
27  *
28  *                The GNU General Public License should be included with
29  *                this file.  If not, you can view it at
30  *                http://www.gnu.org/copyleft/gpl.html
31  *                or write to the Free Software Foundation, Inc., 59
32  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
33  *
34  *********************************************************************/
35
36
37 #include "config.h"
38
39 #include <stdio.h>
40 #include <sys/types.h>
41 #include <stdlib.h>
42 #include <string.h>
43 #include <signal.h>
44 #include <fcntl.h>
45 #include <errno.h>
46 #include <assert.h>
47
48 #ifdef _WIN32
49 # ifndef FEATURE_PTHREAD
50 #  ifndef STRICT
51 #   define STRICT
52 #  endif
53 #  include <windows.h>
54 #  include <process.h>
55 # endif /* ndef FEATURE_PTHREAD */
56
57 # include "win32.h"
58 # ifndef _WIN_CONSOLE
59 #  include "w32log.h"
60 # endif /* ndef _WIN_CONSOLE */
61 # include "w32svrapi.h"
62
63 #else /* ifndef _WIN32 */
64
65 # if !defined (__OS2__)
66 # include <unistd.h>
67 # include <sys/wait.h>
68 # endif /* ndef __OS2__ */
69 # include <sys/time.h>
70 # include <sys/stat.h>
71 # include <sys/ioctl.h>
72
73 #ifdef sun
74 #include <sys/termios.h>
75 #endif /* sun */
76
77 #ifdef unix
78 #include <pwd.h>
79 #include <grp.h>
80 #endif
81
82 # include <signal.h>
83
84 # ifdef __BEOS__
85 #  include <socket.h>  /* BeOS has select() for sockets only. */
86 #  include <OS.h>      /* declarations for threads and stuff. */
87 # endif
88
89 # if defined(__EMX__) || defined(__OS2__)
90 #  include <sys/select.h>  /* OS/2/EMX needs a little help with select */
91 # endif
92 # ifdef __OS2__
93 #define INCL_DOS
94 # include <os2.h>
95 #define bzero(B,N) memset(B,0x00,n)
96 # endif
97
98 # ifndef FD_ZERO
99 #  include <select.h>
100 # endif
101
102 #endif
103
104 #include "project.h"
105 #include "list.h"
106 #include "jcc.h"
107 #include "filters.h"
108 #include "loaders.h"
109 #include "parsers.h"
110 #include "miscutil.h"
111 #include "errlog.h"
112 #include "jbsockets.h"
113 #include "gateway.h"
114 #include "actions.h"
115 #include "cgi.h"
116 #include "loadcfg.h"
117 #include "urlmatch.h"
118
119 const char jcc_h_rcs[] = JCC_H_VERSION;
120 const char project_h_rcs[] = PROJECT_H_VERSION;
121
122 int no_daemon = 0;
123 struct client_state  clients[1];
124 struct file_list     files[1];
125
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 */
130
131 #ifdef FEATURE_GRACEFUL_TERMINATION
132 int g_terminate = 0;
133 #endif
134
135 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
136 static void sig_handler(int the_signal);
137 #endif
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);
152 #endif
153 static void initialize_mutexes(void);
154 static jb_socket bind_port_helper(struct configuration_spec *config);
155 static void listen_loop(void);
156
157 #ifdef AMIGA
158 void serve(struct client_state *csp);
159 #else /* ifndef AMIGA */
160 static void serve(struct client_state *csp);
161 #endif /* def AMIGA */
162
163 #ifdef __BEOS__
164 static int32 server_thread(void *data);
165 #endif /* def __BEOS__ */
166
167 #ifdef _WIN32
168 #define sleep(N)  Sleep(((N) * 1000))
169 #endif
170
171 #ifdef __OS2__
172 #define sleep(N)  DosSleep(((N) * 100))
173 #endif
174
175 #ifdef MUTEX_LOCKS_AVAILABLE
176 /*
177  * XXX: Does the locking stuff really belong in this file?
178  */
179 privoxy_mutex_t log_mutex;
180 privoxy_mutex_t log_init_mutex;
181 privoxy_mutex_t connection_reuse_mutex;
182
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) */
186
187 #ifndef HAVE_GMTIME_R
188 privoxy_mutex_t gmtime_mutex;
189 #endif /* ndef HAVE_GMTIME_R */
190
191 #ifndef HAVE_LOCALTIME_R
192 privoxy_mutex_t localtime_mutex;
193 #endif /* ndef HAVE_GMTIME_R */
194
195 #ifndef HAVE_RANDOM
196 privoxy_mutex_t rand_mutex;
197 #endif /* ndef HAVE_RANDOM */
198
199 #endif /* def MUTEX_LOCKS_AVAILABLE */
200
201 #if defined(unix)
202 const char *basedir = NULL;
203 const char *pidfile = NULL;
204 static int received_hup_signal = 0;
205 #endif /* defined unix */
206
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";
211
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";
218
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";
224
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";
230
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";
238
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";
246
247 #if 0
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";
255 #endif
256
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";
264
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";
271
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";
278
279 /* A function to crunch a response */
280 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
281
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
288
289 /* A crunch function and its flags */
290 struct cruncher
291 {
292    const crunch_func_ptr cruncher;
293    const int flags;
294 };
295
296 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
297
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 },
302 #ifdef FEATURE_TRUST
303    { trust_url,       CF_COUNT_AS_REJECT },
304 #endif /* def FEATURE_TRUST */
305    { redirect_url,    CF_NO_FLAGS  },
306    { dispatch_cgi,    CF_IGNORE_FORCE},
307    { NULL,            0 }
308 };
309
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 },
314    { NULL,            0 }
315 };
316
317
318 /*
319  * XXX: Don't we really mean
320  *
321  * #if defined(unix)
322  *
323  * here?
324  */
325 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
326 /*********************************************************************
327  *
328  * Function    :  sig_handler 
329  *
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.
334  *
335  * Parameters  :
336  *          1  :  the_signal = the signal cause this function to call
337  *
338  * Returns     :  - 
339  *
340  *********************************************************************/
341 static void sig_handler(int the_signal)
342 {
343    switch(the_signal)
344    {
345       case SIGTERM:
346       case SIGINT:
347          log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
348 #if defined(unix)
349          if(pidfile)
350          {
351             unlink(pidfile);
352          }
353 #endif /* unix */
354          exit(the_signal);
355          break;
356
357       case SIGHUP:
358 #if defined(unix)
359          received_hup_signal = 1;
360 #endif
361          break;         
362
363       default:
364          /* 
365           * We shouldn't be here, unless we catch signals
366           * in main() that we can't handle here!
367           */
368          log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
369    }
370    return;
371
372 }
373 #endif
374
375
376 /*********************************************************************
377  *
378  * Function    :  client_protocol_is_unsupported
379  *
380  * Description :  Checks if the client used a known unsupported
381  *                protocol and deals with it by sending an error
382  *                response.
383  *
384  * Parameters  :
385  *          1  :  csp = Current client state (buffers, headers, etc...)
386  *          2  :  req = the first request line send by the client
387  *
388  * Returns     :  TRUE if an error response has been generated, or
389  *                FALSE if the request doesn't look invalid.
390  *
391  *********************************************************************/
392 static int client_protocol_is_unsupported(const struct client_state *csp, char *req)
393 {
394    /*
395     * If it's a FTP or gopher request, we don't support it.
396     *
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.
400     *
401     * They should, however, never cause more problems than
402     * Privoxy's old behaviour (returning the misleading HTML
403     * error message:
404     *
405     * "Could not resolve http://(ftp|gopher)://example.org").
406     */
407    if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
408    {
409       const char *response = NULL;
410       const char *protocol = NULL;
411
412       if (!strncmpic(req, "GET ftp://", 10))
413       {
414          response = FTP_RESPONSE;
415          protocol = "FTP";
416       }
417       else
418       {
419          response = GOPHER_RESPONSE;
420          protocol = "GOPHER";
421       }
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);
427       freez(req);
428       write_socket(csp->cfd, response, strlen(response));
429
430       return TRUE;
431    }
432
433    return FALSE;
434 }
435
436
437 /*********************************************************************
438  *
439  * Function    :  get_request_destination_elsewhere
440  *
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.
444  *
445  *                This function tries to get it elsewhere,
446  *                provided accept-intercepted-requests is enabled.
447  *
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.
451  *
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.
455  *
456  * Parameters  :
457  *          1  :  csp = Current client state (buffers, headers, etc...)
458  *          2  :  headers = a header list
459  *
460  * Returns     :  JB_ERR_OK if the destination is now known, or
461  *                JB_ERR_PARSE if it isn't.
462  *
463  *********************************************************************/
464 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
465 {
466    char *req;
467
468    if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
469    {
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);
476
477       write_socket(csp->cfd, CHEADER, strlen(CHEADER));
478       destroy_list(headers);
479
480       return JB_ERR_PARSE;
481    }
482    else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
483    {
484 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
485       /* Split the domain we just got for pattern matching */
486       init_domain_components(csp->http);
487 #endif
488
489       return JB_ERR_OK;
490    }
491    else
492    {
493       /* We can't work without destination. Go spread the news.*/
494
495       req = list_to_text(headers);
496       chomp(req);
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);
503       freez(req);
504
505       write_socket(csp->cfd, MISSING_DESTINATION_RESPONSE, strlen(MISSING_DESTINATION_RESPONSE));
506       destroy_list(headers);
507
508       return JB_ERR_PARSE;
509    }
510    /*
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.
514     */
515 }
516
517
518 /*********************************************************************
519  *
520  * Function    :  get_server_headers
521  *
522  * Description :  Parses server headers in iob and fills them
523  *                into csp->headers so that they can later be
524  *                handled by sed().
525  *
526  * Parameters  :
527  *          1  :  csp = Current client state (buffers, headers, etc...)
528  *
529  * Returns     :  JB_ERR_OK if everything went fine, or
530  *                JB_ERR_PARSE if the headers were incomplete.
531  *
532  *********************************************************************/
533 static jb_err get_server_headers(struct client_state *csp)
534 {
535    int continue_hack_in_da_house = 0;
536    char * header;
537
538    while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
539    {
540       if (header == NULL)
541       {
542          /*
543           * continue hack in da house. Ignore the ending of
544           * this head and continue enlisting header lines.
545           * The reason is described below.
546           */
547          enlist(csp->headers, "");
548          continue_hack_in_da_house = 0;
549          continue;
550       }
551       else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
552       {
553          /*
554           * It's a bodyless continue response, don't
555           * stop header parsing after reaching its end.
556           *
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.
560           *
561           * The client will separate them because of the
562           * empty line between them.
563           *
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.
568           *
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)
572           */
573          log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
574          continue_hack_in_da_house = 1;
575       }
576       else if (*header == '\0') 
577       {
578          /*
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
582           * head.
583           *
584           * Inform the caller an let it decide how to handle it.
585           */
586          return JB_ERR_PARSE;
587       }
588
589       if (JB_ERR_MEMORY == enlist(csp->headers, header))
590       {
591          /*
592           * XXX: Should we quit the request and return a
593           * out of memory error page instead?
594           */
595          log_error(LOG_LEVEL_ERROR,
596             "Out of memory while enlisting server headers. %s lost.",
597             header);
598       }
599       freez(header);
600    }
601
602    return JB_ERR_OK;
603 }
604
605
606 /*********************************************************************
607  *
608  * Function    :  crunch_reason
609  *
610  * Description :  Translates the crunch reason code into a string.
611  *
612  * Parameters  :
613  *          1  :  rsp = a http_response
614  *
615  * Returns     :  A string with the crunch reason or an error description.
616  *
617  *********************************************************************/
618 static const char *crunch_reason(const struct http_response *rsp)
619 {
620    char * reason = NULL;
621
622    assert(rsp != NULL);
623    if (rsp == NULL)
624    {
625       return "Internal error while searching for crunch reason";
626    }
627
628    switch (rsp->reason)
629    {
630       case RSP_REASON_UNSUPPORTED:
631          reason = "Unsupported HTTP feature";
632          break;
633       case RSP_REASON_BLOCKED:
634          reason = "Blocked";
635          break;
636       case RSP_REASON_UNTRUSTED:
637          reason = "Untrusted";
638          break;
639       case RSP_REASON_REDIRECTED:
640          reason = "Redirected";
641          break;
642       case RSP_REASON_CGI_CALL:
643          reason = "CGI Call";
644          break;
645       case RSP_REASON_NO_SUCH_DOMAIN:
646          reason = "DNS failure";
647          break;
648       case RSP_REASON_FORWARDING_FAILED:
649          reason = "Forwarding failed";
650          break;
651       case RSP_REASON_CONNECT_FAILED:
652          reason = "Connection failure";
653          break;
654       case RSP_REASON_OUT_OF_MEMORY:
655          reason = "Out of memory (may mask other reasons)";
656          break;
657       case RSP_REASON_CONNECTION_TIMEOUT:
658          reason = "Connection timeout";
659          break;
660       case RSP_REASON_NO_SERVER_DATA:
661          reason = "No server data received";
662          break;
663       default:
664          reason = "No reason recorded";
665          break;
666    }
667
668    return reason;
669 }
670
671
672 /*********************************************************************
673  *
674  * Function    :  send_crunch_response
675  *
676  * Description :  Delivers already prepared response for
677  *                intercepted requests, logs the interception
678  *                and frees the response.
679  *
680  * Parameters  :
681  *          1  :  csp = Current client state (buffers, headers, etc...)
682  *          1  :  rsp = Fully prepared response. Will be freed on exit.
683  *
684  * Returns     :  Nothing.
685  *
686  *********************************************************************/
687 static void send_crunch_response(const struct client_state *csp, struct http_response *rsp)
688 {
689       const struct http_request *http = csp->http;
690       char status_code[4];
691
692       assert(rsp != NULL);
693       assert(rsp->head != NULL);
694
695       if (rsp == NULL)
696       {
697          /*
698           * Not supposed to happen. If it does
699           * anyway, treat it as an unknown error.
700           */
701          cgi_error_unknown(csp, rsp, RSP_REASON_INTERNAL_ERROR);
702          /* return code doesn't matter */
703       }
704
705       if (rsp == NULL)
706       {
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.");
710       }
711
712       /*
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.
717        *
718        * A head starts like this: 'HTTP/1.1 200...'
719        *                           0123456789|11
720        *                                     10
721        */
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';
726
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))
730       {
731          /* There is nothing we can do about it. */
732          log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", csp->http->host);
733       }
734
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);
739
740       /* Clean up and return */
741       if (cgi_error_memory() != rsp)
742       {
743          free_http_response(rsp);
744       } 
745       return;
746 }
747
748
749 #if 0
750 /*********************************************************************
751  *
752  * Function    :  request_contains_null_bytes
753  *
754  * Description :  Checks for NULL bytes in the request and sends
755  *                an error message to the client if any were found.
756  *
757  *                XXX: currently not used, see comment in chat().
758  *
759  * Parameters  :
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.
763  *
764  * Returns     :  TRUE if the request contained one or more NULL bytes, or
765  *                FALSE otherwise.
766  *
767  *********************************************************************/
768 static int request_contains_null_bytes(const struct client_state *csp, char *buf, int len)
769 {
770    size_t c_len; /* Request lenght when treated as C string */
771
772    c_len = strlen(buf);
773
774    if (c_len < len)
775    {
776       /*
777        * Null byte(s) found. Log the request,
778        * return an error response and hang up.
779        */
780       size_t tmp_len = c_len;
781
782       do
783       {
784         /*
785          * Replace NULL byte(s) with '°' characters
786          * so the request can be logged as string.
787          * XXX: Is there a better replacement character?
788          */
789          buf[tmp_len]='°';
790          tmp_len += strlen(buf+tmp_len);
791       } while (tmp_len < len);
792
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);
797
798       write_socket(csp->cfd, NULL_BYTE_RESPONSE, strlen(NULL_BYTE_RESPONSE));
799
800       /* XXX: Log correct size */
801       log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
802
803       return TRUE;
804    }
805
806    return FALSE;
807 }
808 #endif
809
810
811 /*********************************************************************
812  *
813  * Function    :  crunch_response_triggered
814  *
815  * Description :  Checks if the request has to be crunched,
816  *                and delivers the crunch response if necessary.
817  *
818  * Parameters  :
819  *          1  :  csp = Current client state (buffers, headers, etc...)
820  *          2  :  crunchers = list of cruncher functions to run
821  *
822  * Returns     :  TRUE if the request was answered with a crunch response
823  *                FALSE otherwise.
824  *
825  *********************************************************************/
826 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
827 {
828    struct http_response *rsp = NULL;
829    const struct cruncher *c;
830
831    /*
832     * If CGI request crunching is disabled,
833     * check the CGI dispatcher out of order to
834     * prevent unintentional blocks or redirects. 
835     */
836    if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
837        && (NULL != (rsp = dispatch_cgi(csp))))
838    {
839       /* Deliver, log and free the interception response. */
840       send_crunch_response(csp, rsp);
841       return TRUE;
842    }
843
844    for (c = crunchers; c->cruncher != NULL; c++)
845    {
846       /*
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.
850        */
851       if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
852           !(csp->flags & CSP_FLAG_FORCED)) ||
853           (c->flags & CF_IGNORE_FORCE))
854       {
855          rsp = c->cruncher(csp);
856          if (NULL != rsp)
857          {
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)
862             {
863                csp->flags |= CSP_FLAG_REJECTED;
864             }
865 #endif /* def FEATURE_STATISTICS */
866
867             return TRUE;
868          }
869       }
870    }
871
872    return FALSE;
873 }
874
875
876 /*********************************************************************
877  *
878  * Function    :  build_request_line
879  *
880  * Description :  Builds the HTTP request line.
881  *
882  *                If a HTTP forwarder is used it expects the whole URL,
883  *                web servers only get the path.
884  *
885  * Parameters  :
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.
890  *
891  * Returns     :  Nothing. Terminates in case of memory problems.
892  *
893  *********************************************************************/
894 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
895 {
896    struct http_request *http = csp->http;
897
898    assert(http->ssl == 0);
899
900    /*
901     * Downgrade http version from 1.1 to 1.0
902     * if +downgrade action applies.
903     */
904    if ( (csp->action->flags & ACTION_DOWNGRADE)
905      && (!strcmpic(http->ver, "HTTP/1.1")))
906    {
907       freez(http->ver);
908       http->ver = strdup("HTTP/1.0");
909
910       if (http->ver == NULL)
911       {
912          log_error(LOG_LEVEL_FATAL, "Out of memory downgrading HTTP version");
913       }
914    }
915
916    /*
917     * Rebuild the request line.
918     */
919    freez(*request_line);
920    *request_line = strdup(http->gpc);
921    string_append(request_line, " ");
922
923    if (fwd->forward_host)
924    {
925       string_append(request_line, http->url);
926    }
927    else
928    {
929       string_append(request_line, http->path);
930    }
931    string_append(request_line, " ");
932    string_append(request_line, http->ver);
933
934    if (*request_line == NULL)
935    {
936       log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
937    }
938    log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
939 }
940
941
942 /*********************************************************************
943  *
944  * Function    :  change_request_destination
945  *
946  * Description :  Parse a (rewritten) request line and regenerate
947  *                the http request data.
948  *
949  * Parameters  :
950  *          1  :  csp = Current client state (buffers, headers, etc...)
951  *
952  * Returns     :  Forwards the parse_http_request() return code.
953  *                Terminates in case of memory problems.
954  *
955  *********************************************************************/
956 static jb_err change_request_destination(struct client_state *csp)
957 {
958    struct http_request *http = csp->http;
959    jb_err err;
960
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)
965    {
966       log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
967          jb_err_to_string(err));
968    }
969    else
970    {
971       /* XXX: ocmd is a misleading name */
972       http->ocmd = strdup(http->cmd);
973       if (http->ocmd == NULL)
974       {
975          log_error(LOG_LEVEL_FATAL,
976             "Out of memory copying rewritten HTTP request line");
977       }
978    }
979
980    return err;
981 }
982
983
984 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
985 /*********************************************************************
986  *
987  * Function    :  server_response_is_complete
988  *
989  * Description :  Determines whether we should stop reading
990  *                from the server socket.
991  *
992  * Parameters  :
993  *          1  :  csp = Current client state (buffers, headers, etc...)
994  *          2  :  content_length = Length of content received so far.
995  *
996  * Returns     :  TRUE if the response is complete,
997  *                FALSE otherwise.
998  *
999  *********************************************************************/
1000 static int server_response_is_complete(struct client_state *csp,
1001    unsigned long long content_length)
1002 {
1003    int content_length_known = !!(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
1004
1005    if (!strcmpic(csp->http->gpc, "HEAD"))
1006    {
1007       /*
1008        * "HEAD" implies no body, we are thus expecting
1009        * no content. XXX: incomplete "list" of methods?
1010        */
1011       csp->expected_content_length = 0;
1012       content_length_known = TRUE;
1013    }
1014
1015    if (csp->http->status == 304)
1016    {
1017       /*
1018        * Expect no body. XXX: incomplete "list" of status codes?
1019        */
1020       csp->expected_content_length = 0;
1021       content_length_known = TRUE;
1022    }
1023
1024    return (content_length_known && ((0 == csp->expected_content_length)
1025             || (csp->expected_content_length <= content_length)));
1026 }
1027
1028
1029 #ifdef FEATURE_CONNECTION_SHARING
1030 /*********************************************************************
1031  *
1032  * Function    :  wait_for_alive_connections
1033  *
1034  * Description :  Waits for alive connections to timeout.
1035  *
1036  * Parameters  :  N/A
1037  *
1038  * Returns     :  N/A
1039  *
1040  *********************************************************************/
1041 static void wait_for_alive_connections(void)
1042 {
1043    int connections_alive = close_unusable_connections();
1044
1045    while (0 < connections_alive)
1046    {
1047       log_error(LOG_LEVEL_CONNECT,
1048          "Waiting for %d connections to timeout.",
1049          connections_alive);
1050       sleep(60);
1051       connections_alive = close_unusable_connections();
1052    }
1053
1054    log_error(LOG_LEVEL_CONNECT, "No connections to wait for left.");
1055
1056 }
1057 #endif /* def FEATURE_CONNECTION_SHARING */
1058
1059
1060 /*********************************************************************
1061  *
1062  * Function    :  save_connection_destination
1063  *
1064  * Description :  Remembers a connection for reuse later on.
1065  *
1066  * Parameters  :
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.
1071  *
1072  * Returns     : void
1073  *
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)
1079 {
1080    assert(sfd != JB_INVALID_SOCKET);
1081    assert(NULL != http->host);
1082
1083    server_connection->sfd = sfd;
1084    server_connection->host = strdup(http->host);
1085    if (NULL == server_connection->host)
1086    {
1087       log_error(LOG_LEVEL_FATAL, "Out of memory saving socket.");
1088    }
1089    server_connection->port = http->port;
1090
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);
1097
1098    server_connection->forwarder_type = fwd->type;
1099    if (NULL != fwd->gateway_host)
1100    {
1101       server_connection->gateway_host = strdup(fwd->gateway_host);
1102       if (NULL == server_connection->gateway_host)
1103       {
1104          log_error(LOG_LEVEL_FATAL, "Out of memory saving gateway_host.");
1105       }
1106    }
1107    else
1108    {
1109       server_connection->gateway_host = NULL;
1110    }
1111    server_connection->gateway_port = fwd->gateway_port;
1112
1113    if (NULL != fwd->forward_host)
1114    {
1115       server_connection->forward_host = strdup(fwd->forward_host);
1116       if (NULL == server_connection->forward_host)
1117       {
1118          log_error(LOG_LEVEL_FATAL, "Out of memory saving forward_host.");
1119       }
1120    }
1121    else
1122    {
1123       server_connection->forward_host = NULL;
1124    }
1125    server_connection->forward_port = fwd->forward_port;
1126 }
1127
1128
1129 /*********************************************************************
1130  *
1131  * Function    : verify_request_length
1132  *
1133  * Description : Checks if we already got the whole client requests
1134  *               and sets CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ if
1135  *               we do.
1136  *
1137  *               Data that doesn't belong to the current request is
1138  *               thrown away to let the client retry on a clean socket.
1139  *
1140  *               XXX: This is a hack until we can deal with multiple
1141  *                    pipelined requests at the same time.
1142  *
1143  *
1144  * Parameters  :
1145  *          1  :  csp = Current client state (buffers, headers, etc...)
1146  *
1147  * Returns     :  void
1148  *
1149  *********************************************************************/
1150 static void verify_request_length(struct client_state *csp)
1151 {
1152    unsigned long long buffered_request_bytes =
1153       (unsigned long long)(csp->iob->eod - csp->iob->cur);
1154
1155    if ((csp->expected_client_content_length != 0)
1156       && (buffered_request_bytes != 0))
1157    {
1158       if (csp->expected_client_content_length >= buffered_request_bytes)
1159       {
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);
1164       }
1165       else
1166       {
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;
1174       }
1175
1176       if (csp->expected_client_content_length == 0)
1177       {
1178          csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1179       }
1180    }
1181
1182    if (!(csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ)
1183     && ((csp->iob->cur[0] != '\0') || (csp->expected_client_content_length != 0)))
1184    {
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"))
1191       {
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.");
1196       }
1197       else
1198       {
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;
1207       }
1208    }
1209    else
1210    {
1211       csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1212       log_error(LOG_LEVEL_CONNECT, "Complete client request received.");
1213    }
1214 }
1215 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1216
1217
1218 /*********************************************************************
1219  *
1220  * Function    :  mark_server_socket_tainted
1221  *
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).
1225  *
1226  * Parameters  :
1227  *          1  :  csp = Current client state (buffers, headers, etc...)
1228  *
1229  * Returns     :  void.
1230  *
1231  *********************************************************************/
1232 static void mark_server_socket_tainted(struct client_state *csp)
1233 {
1234    if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
1235       && !(csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED))
1236    {
1237       log_error(LOG_LEVEL_CONNECT,
1238          "Marking the server socket %d tainted.",
1239          csp->server_connection.sfd);
1240       csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1241    }
1242 }
1243
1244 /*********************************************************************
1245  *
1246  * Function    :  get_request_line
1247  *
1248  * Description : Read the client request line.
1249  *
1250  * Parameters  :
1251  *          1  :  csp = Current client state (buffers, headers, etc...)
1252  *
1253  * Returns     :  Pointer to request line or NULL in case of errors.
1254  *
1255  *********************************************************************/
1256 static char *get_request_line(struct client_state *csp)
1257 {
1258    char buf[BUFFER_SIZE];
1259    char *request_line = NULL;
1260    int len;
1261
1262    memset(buf, 0, sizeof(buf));
1263
1264    do
1265    {
1266       if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1267       {
1268          log_error(LOG_LEVEL_CONNECT,
1269             "Stopped waiting for the request line. Timeout: %d.",
1270             csp->config->socket_timeout);
1271          write_socket(csp->cfd, CLIENT_CONNECTION_TIMEOUT_RESPONSE,
1272             strlen(CLIENT_CONNECTION_TIMEOUT_RESPONSE));
1273          return NULL;
1274       }
1275
1276       len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1277
1278       if (len <= 0) return NULL;
1279
1280       /*
1281        * If there is no memory left for buffering the
1282        * request, there is nothing we can do but hang up
1283        */
1284       if (add_to_iob(csp, buf, len))
1285       {
1286          return NULL;
1287       }
1288
1289       request_line = get_header(csp->iob);
1290
1291    } while ((NULL != request_line) && ('\0' == *request_line));
1292
1293    return request_line;
1294
1295 }
1296
1297
1298 /*********************************************************************
1299  *
1300  * Function    :  receive_client_request
1301  *
1302  * Description : Read the client's request (more precisely the
1303  *               client headers) and answer it if necessary.
1304  *
1305  *               Note that since we're not using select() we could get
1306  *               blocked here if a client connected, then didn't say
1307  *               anything!
1308  *
1309  * Parameters  :
1310  *          1  :  csp = Current client state (buffers, headers, etc...)
1311  *
1312  * Returns     :  JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
1313  *
1314  *********************************************************************/
1315 static jb_err receive_client_request(struct client_state *csp)
1316 {
1317    char buf[BUFFER_SIZE];
1318    char *p;
1319    char *req = NULL;
1320    struct http_request *http;
1321    int len;
1322    jb_err err;
1323
1324    /* Temporary copy of the client's headers before they get enlisted in csp->headers */
1325    struct list header_list;
1326    struct list *headers = &header_list;
1327
1328    http = csp->http;
1329
1330    memset(buf, 0, sizeof(buf));
1331
1332    req = get_request_line(csp);
1333    if (req == NULL)
1334    {
1335       mark_server_socket_tainted(csp);
1336       return JB_ERR_PARSE;
1337    }
1338    assert(*req != '\0');
1339
1340    if (client_protocol_is_unsupported(csp, req))
1341    {
1342       return JB_ERR_PARSE;
1343    }
1344
1345 #ifdef FEATURE_FORCE_LOAD
1346    /*
1347     * If this request contains the FORCE_PREFIX and blocks
1348     * aren't enforced, get rid of it and set the force flag.
1349     */
1350    if (strstr(req, FORCE_PREFIX))
1351    {
1352       if (csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
1353       {
1354          log_error(LOG_LEVEL_FORCE,
1355             "Ignored force prefix in request: \"%s\".", req);
1356       }
1357       else
1358       {
1359          strclean(req, FORCE_PREFIX);
1360          log_error(LOG_LEVEL_FORCE, "Enforcing request: \"%s\".", req);
1361          csp->flags |= CSP_FLAG_FORCED;
1362       }
1363    }
1364 #endif /* def FEATURE_FORCE_LOAD */
1365
1366    err = parse_http_request(req, http);
1367    freez(req);
1368    if (JB_ERR_OK != err)
1369    {
1370       write_socket(csp->cfd, CHEADER, strlen(CHEADER));
1371       /* XXX: Use correct size */
1372       log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1373       log_error(LOG_LEVEL_ERROR,
1374          "Couldn't parse request line received from %s: %s",
1375          csp->ip_addr_str, jb_err_to_string(err));
1376
1377       free_http_request(http);
1378       return JB_ERR_PARSE;
1379    }
1380
1381    /* grab the rest of the client's headers */
1382    init_list(headers);
1383    for (;;)
1384    {
1385       p = get_header(csp->iob);
1386
1387       if (p == NULL)
1388       {
1389          /* There are no additional headers to read. */
1390          break;
1391       }
1392
1393       if (*p == '\0')
1394       {
1395          /*
1396           * We didn't receive a complete header
1397           * line yet, get the rest of it.
1398           */
1399          if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1400          {
1401             log_error(LOG_LEVEL_ERROR,
1402                "Stopped grabbing the client headers.");
1403             destroy_list(headers);
1404             return JB_ERR_PARSE;
1405          }
1406
1407          len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1408          if (len <= 0)
1409          {
1410             log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1411             destroy_list(headers);
1412             return JB_ERR_PARSE;
1413          }
1414          
1415          if (add_to_iob(csp, buf, len))
1416          {
1417             /*
1418              * If there is no memory left for buffering the
1419              * request, there is nothing we can do but hang up
1420              */
1421             destroy_list(headers);
1422             return JB_ERR_MEMORY;
1423          }
1424       }
1425       else
1426       {
1427          /*
1428           * We were able to read a complete
1429           * header and can finaly enlist it.
1430           */
1431          enlist(headers, p);
1432          freez(p);
1433       }
1434    }
1435
1436    if (http->host == NULL)
1437    {
1438       /*
1439        * If we still don't know the request destination,
1440        * the request is invalid or the client uses
1441        * Privoxy without its knowledge.
1442        */
1443       if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1444       {
1445          /*
1446           * Our attempts to get the request destination
1447           * elsewhere failed or Privoxy is configured
1448           * to only accept proxy requests.
1449           *
1450           * An error response has already been send
1451           * and we're done here.
1452           */
1453          return JB_ERR_PARSE;
1454       }
1455    }
1456
1457    /*
1458     * Determine the actions for this URL
1459     */
1460 #ifdef FEATURE_TOGGLE
1461    if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1462    {
1463       /* Most compatible set of actions (i.e. none) */
1464       init_current_action(csp->action);
1465    }
1466    else
1467 #endif /* ndef FEATURE_TOGGLE */
1468    {
1469       get_url_actions(csp, http);
1470    }
1471
1472    /* 
1473     * Save a copy of the original request for logging
1474     */
1475    http->ocmd = strdup(http->cmd);
1476    if (http->ocmd == NULL)
1477    {
1478       log_error(LOG_LEVEL_FATAL,
1479          "Out of memory copying HTTP request line");
1480    }
1481    enlist(csp->headers, http->cmd);
1482
1483    /* Append the previously read headers */
1484    list_append_list_unique(csp->headers, headers);
1485    destroy_list(headers);
1486
1487    return JB_ERR_OK;
1488
1489 }
1490
1491
1492 /*********************************************************************
1493  *
1494  * Function    : parse_client_request
1495  *
1496  * Description : Parses the client's request and decides what to do
1497  *               with it.
1498  *
1499  *               Note that since we're not using select() we could get
1500  *               blocked here if a client connected, then didn't say
1501  *               anything!
1502  *
1503  * Parameters  :
1504  *          1  :  csp = Current client state (buffers, headers, etc...)
1505  *
1506  * Returns     :  JB_ERR_OK or JB_ERR_PARSE
1507  *
1508  *********************************************************************/
1509 static jb_err parse_client_request(struct client_state *csp)
1510 {
1511    struct http_request *http = csp->http;
1512    jb_err err;
1513
1514 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1515    if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1516     && (!strcmpic(csp->http->ver, "HTTP/1.1"))
1517     && (csp->http->ssl == 0))
1518    {
1519       /* Assume persistence until further notice */
1520       csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1521    }
1522 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1523
1524    err = sed(csp, FILTER_CLIENT_HEADERS);
1525    if (JB_ERR_OK != err)
1526    {
1527       /* XXX: Should be handled in sed(). */
1528       assert(err == JB_ERR_PARSE);
1529       log_error(LOG_LEVEL_FATAL, "Failed to parse client headers.");
1530    }
1531    csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1532
1533    /* Check request line for rewrites. */
1534    if ((NULL == csp->headers->first->str)
1535       || (strcmp(http->cmd, csp->headers->first->str) &&
1536          (JB_ERR_OK != change_request_destination(csp))))
1537    {
1538       /*
1539        * A header filter broke the request line - bail out.
1540        */
1541       write_socket(csp->cfd, MESSED_UP_REQUEST_RESPONSE, strlen(MESSED_UP_REQUEST_RESPONSE));
1542       /* XXX: Use correct size */
1543       log_error(LOG_LEVEL_CLF,
1544          "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
1545       log_error(LOG_LEVEL_ERROR,
1546          "Invalid request line after applying header filters.");
1547       free_http_request(http);
1548
1549       return JB_ERR_PARSE;
1550    }
1551
1552 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1553    if (csp->http->ssl == 0)
1554    {
1555       verify_request_length(csp);
1556    }
1557 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1558
1559    return JB_ERR_OK;
1560
1561 }
1562
1563
1564 /*********************************************************************
1565  *
1566  * Function    :  chat
1567  *
1568  * Description :  Once a connection to the client has been accepted,
1569  *                this function is called (via serve()) to handle the
1570  *                main business of the communication.  When this
1571  *                function returns, the caller must close the client
1572  *                socket handle.
1573  *
1574  *                FIXME: chat is nearly thousand lines long.
1575  *                Ridiculous.
1576  *
1577  * Parameters  :
1578  *          1  :  csp = Current client state (buffers, headers, etc...)
1579  *
1580  * Returns     :  Nothing.
1581  *
1582  *********************************************************************/
1583 static void chat(struct client_state *csp)
1584 {
1585    char buf[BUFFER_SIZE];
1586    char *hdr;
1587    char *p;
1588    fd_set rfds;
1589    int n;
1590    jb_socket maxfd;
1591    int server_body;
1592    int ms_iis5_hack = 0;
1593    unsigned long long byte_count = 0;
1594    int forwarded_connect_retries = 0;
1595    int max_forwarded_connect_retries = csp->config->forwarded_connect_retries;
1596    const struct forward_spec *fwd;
1597    struct http_request *http;
1598    long len = 0; /* for buffer sizes (and negative error codes) */
1599
1600    /* Function that does the content filtering for the current request */
1601    filter_function_ptr content_filter = NULL;
1602
1603    /* Skeleton for HTTP response, if we should intercept the request */
1604    struct http_response *rsp;
1605    struct timeval timeout;
1606 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1607    int watch_client_socket = 1;
1608 #endif
1609
1610    memset(buf, 0, sizeof(buf));
1611
1612    http = csp->http;
1613
1614    if (receive_client_request(csp) != JB_ERR_OK)
1615    {
1616       return;
1617    }
1618    if (parse_client_request(csp) != JB_ERR_OK)
1619    {
1620       return;
1621    }
1622
1623    /* decide how to route the HTTP request */
1624    fwd = forward_url(csp, http);
1625    if (NULL == fwd)
1626    {
1627       log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!?  This can't happen!");
1628       /* Never get here - LOG_LEVEL_FATAL causes program exit */
1629       return;
1630    }
1631
1632    /*
1633     * build the http request to send to the server
1634     * we have to do one of the following:
1635     *
1636     * create = use the original HTTP request to create a new
1637     *          HTTP request that has either the path component
1638     *          without the http://domainspec (w/path) or the
1639     *          full orininal URL (w/url)
1640     *          Note that the path and/or the HTTP version may
1641     *          have been altered by now.
1642     *
1643     * connect = Open a socket to the host:port of the server
1644     *           and short-circuit server and client socket.
1645     *
1646     * pass =  Pass the request unchanged if forwarding a CONNECT
1647     *         request to a parent proxy. Note that we'll be sending
1648     *         the CFAIL message ourselves if connecting to the parent
1649     *         fails, but we won't send a CSUCCEED message if it works,
1650     *         since that would result in a double message (ours and the
1651     *         parent's). After sending the request to the parent, we simply
1652     *         tunnel.
1653     *
1654     * here's the matrix:
1655     *                        SSL
1656     *                    0        1
1657     *                +--------+--------+
1658     *                |        |        |
1659     *             0  | create | connect|
1660     *                | w/path |        |
1661     *  Forwarding    +--------+--------+
1662     *                |        |        |
1663     *             1  | create | pass   |
1664     *                | w/url  |        |
1665     *                +--------+--------+
1666     *
1667     */
1668
1669    if (http->ssl && connect_port_is_forbidden(csp))
1670    {
1671       const char *acceptable_connect_ports =
1672          csp->action->string[ACTION_STRING_LIMIT_CONNECT];
1673       assert(NULL != acceptable_connect_ports);
1674       log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
1675          "limit-connect{%s} doesn't allow CONNECT requests to port %d.",
1676          csp->ip_addr_str, acceptable_connect_ports, csp->http->port);
1677       csp->action->flags |= ACTION_BLOCK;
1678       http->ssl = 0;
1679    }
1680
1681    if (http->ssl == 0)
1682    {
1683       freez(csp->headers->first->str);
1684       build_request_line(csp, fwd, &csp->headers->first->str);
1685    }
1686
1687    /*
1688     * We have a request. Check if one of the crunchers wants it.
1689     */
1690    if (crunch_response_triggered(csp, crunchers_all))
1691    {
1692       /*
1693        * Yes. The client got the crunch response
1694        * and we are done here after cleaning up.
1695        */
1696       /* XXX: why list_remove_all()? */
1697       list_remove_all(csp->headers);
1698
1699       return;
1700    }
1701
1702    log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
1703
1704    if (fwd->forward_host)
1705    {
1706       log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
1707          fwd->forward_host, fwd->forward_port, http->hostport);
1708    }
1709    else
1710    {
1711       log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
1712    }
1713
1714    /* here we connect to the server, gateway, or the forwarder */
1715
1716 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1717    if ((csp->server_connection.sfd != JB_INVALID_SOCKET)
1718       && socket_is_still_usable(csp->server_connection.sfd)
1719       && connection_destination_matches(&csp->server_connection, http, fwd))
1720    {
1721       log_error(LOG_LEVEL_CONNECT,
1722          "Reusing server socket %u. Opened for %s.",
1723          csp->server_connection.sfd, csp->server_connection.host);
1724    }
1725    else
1726    {
1727       if (csp->server_connection.sfd != JB_INVALID_SOCKET)
1728       {
1729          log_error(LOG_LEVEL_CONNECT,
1730             "Closing server socket %u. Opened for %s.",
1731             csp->server_connection.sfd, csp->server_connection.host);
1732          close_socket(csp->server_connection.sfd);
1733          mark_connection_closed(&csp->server_connection);
1734       }
1735 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1736
1737       while ((csp->server_connection.sfd = forwarded_connect(fwd, http, csp))
1738          && (errno == EINVAL)
1739          && (forwarded_connect_retries++ < max_forwarded_connect_retries))
1740       {
1741          log_error(LOG_LEVEL_ERROR,
1742             "failed request #%u to connect to %s. Trying again.",
1743             forwarded_connect_retries, http->hostport);
1744       }
1745
1746       if (csp->server_connection.sfd == JB_INVALID_SOCKET)
1747       {
1748          if (fwd->type != SOCKS_NONE)
1749          {
1750             /* Socks error. */
1751             rsp = error_response(csp, "forwarding-failed");
1752          }
1753          else if (errno == EINVAL)
1754          {
1755             rsp = error_response(csp, "no-such-domain");
1756          }
1757          else
1758          {
1759             rsp = error_response(csp, "connect-failed");
1760             log_error(LOG_LEVEL_CONNECT, "connect to: %s failed: %E",
1761                http->hostport);
1762          }
1763
1764          /* Write the answer to the client */
1765          if (rsp != NULL)
1766          {
1767             send_crunch_response(csp, rsp);
1768          }
1769
1770          return;
1771       }
1772 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1773       save_connection_destination(csp->server_connection.sfd,
1774          http, fwd, &csp->server_connection);
1775       csp->server_connection.keep_alive_timeout =
1776          (unsigned)csp->config->keep_alive_timeout;
1777    }
1778 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1779
1780    hdr = list_to_text(csp->headers);
1781    if (hdr == NULL)
1782    {
1783       /* FIXME Should handle error properly */
1784       log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
1785    }
1786    list_remove_all(csp->headers);
1787
1788    if (fwd->forward_host || (http->ssl == 0))
1789    {
1790       /*
1791        * Write the client's (modified) header to the server
1792        * (along with anything else that may be in the buffer)
1793        */
1794       if (write_socket(csp->server_connection.sfd, hdr, strlen(hdr))
1795        || (flush_socket(csp->server_connection.sfd, csp->iob) <  0))
1796       {
1797          log_error(LOG_LEVEL_CONNECT,
1798             "write header to: %s failed: %E", http->hostport);
1799
1800          rsp = error_response(csp, "connect-failed");
1801          if (rsp)
1802          {
1803             send_crunch_response(csp, rsp);
1804          }
1805
1806          freez(hdr);
1807          return;
1808       }
1809    }
1810    else
1811    {
1812       /*
1813        * We're running an SSL tunnel and we're not forwarding,
1814        * so just send the "connect succeeded" message to the
1815        * client, flush the rest, and get out of the way.
1816        */
1817       if (write_socket(csp->cfd, CSUCCEED, strlen(CSUCCEED)))
1818       {
1819          freez(hdr);
1820          return;
1821       }
1822       IOB_RESET(csp);
1823    }
1824
1825    log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
1826
1827    csp->server_connection.request_sent = time(NULL);
1828
1829    /* we're finished with the client's header */
1830    freez(hdr);
1831
1832    maxfd = (csp->cfd > csp->server_connection.sfd) ?
1833       csp->cfd : csp->server_connection.sfd;
1834
1835    /* pass data between the client and server
1836     * until one or the other shuts down the connection.
1837     */
1838
1839    server_body = 0;
1840
1841    for (;;)
1842    {
1843 #ifdef __OS2__
1844       /*
1845        * FD_ZERO here seems to point to an errant macro which crashes.
1846        * So do this by hand for now...
1847        */
1848       memset(&rfds,0x00,sizeof(fd_set));
1849 #else
1850       FD_ZERO(&rfds);
1851 #endif
1852 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1853       if (!watch_client_socket)
1854       {
1855          maxfd = csp->server_connection.sfd;
1856       }
1857       else
1858 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1859       {
1860          FD_SET(csp->cfd, &rfds);
1861       }
1862
1863       FD_SET(csp->server_connection.sfd, &rfds);
1864
1865 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1866       if ((csp->flags & CSP_FLAG_CHUNKED)
1867          && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
1868          && ((csp->iob->eod - csp->iob->cur) >= 5)
1869          && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
1870       {
1871          log_error(LOG_LEVEL_CONNECT,
1872             "Looks like we read the last chunk together with "
1873             "the server headers. We better stop reading.");
1874          byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
1875          csp->expected_content_length = byte_count;
1876          csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
1877       }
1878       if (server_body && server_response_is_complete(csp, byte_count))
1879       {
1880          if (csp->expected_content_length == byte_count)
1881          {
1882             log_error(LOG_LEVEL_CONNECT,
1883                "Done reading from server. Content length: %llu as expected. "
1884                "Bytes most recently read: %d.",
1885                byte_count, len);
1886          }
1887          else
1888          {
1889             log_error(LOG_LEVEL_CONNECT,
1890                "Done reading from server. Expected content length: %llu. "
1891                "Actual content length: %llu. Bytes most recently read: %d.",
1892                csp->expected_content_length, byte_count, len);
1893          }
1894          len = 0;
1895          /*
1896           * XXX: should not jump around,
1897           * chat() is complicated enough already.
1898           */
1899          goto reading_done;
1900       }
1901 #endif  /* FEATURE_CONNECTION_KEEP_ALIVE */
1902
1903       timeout.tv_sec = csp->config->socket_timeout;
1904       timeout.tv_usec = 0;
1905       n = select((int)maxfd+1, &rfds, NULL, NULL, &timeout);
1906
1907       if (n == 0)
1908       {
1909          log_error(LOG_LEVEL_ERROR,
1910             "Didn't receive data in time: %s", http->url);
1911          if ((byte_count == 0) && (http->ssl == 0))
1912          {
1913             send_crunch_response(csp, error_response(csp, "connection-timeout"));
1914          }
1915          mark_server_socket_tainted(csp);
1916          return;
1917       }
1918       else if (n < 0)
1919       {
1920          log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
1921          mark_server_socket_tainted(csp);
1922          return;
1923       }
1924
1925       /*
1926        * This is the body of the browser's request,
1927        * just read and write it.
1928        *
1929        * XXX: Make sure the client doesn't use pipelining
1930        * behind Privoxy's back.
1931        */
1932       if (FD_ISSET(csp->cfd, &rfds))
1933       {
1934          int max_bytes_to_read = sizeof(buf) - 1;
1935
1936 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1937          if ((csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ))
1938          {
1939             if (data_is_available(csp->cfd, 0))
1940             {
1941                /*
1942                 * If the next request is already waiting, we have
1943                 * to stop select()ing the client socket. Otherwise
1944                 * we would always return right away and get nothing
1945                 * else done.
1946                 */
1947                watch_client_socket = 0;
1948                log_error(LOG_LEVEL_CONNECT,
1949                   "Stopping to watch the client socket. "
1950                   "There's already another request waiting.");
1951                continue;
1952             }
1953             /*
1954              * If the client socket is set, but there's no data
1955              * available on the socket, the client went fishing
1956              * and continuing talking to the server makes no sense.
1957              */
1958             log_error(LOG_LEVEL_CONNECT,
1959                "The client closed socket %d while "
1960                "the server socket %d is still open.",
1961                csp->cfd, csp->server_connection.sfd);
1962             mark_server_socket_tainted(csp);
1963             break;
1964          }
1965          if (csp->expected_client_content_length != 0)
1966          {
1967             if (csp->expected_client_content_length < (sizeof(buf) - 1))
1968             {
1969                max_bytes_to_read = (int)csp->expected_client_content_length;
1970             }
1971             log_error(LOG_LEVEL_CONNECT,
1972                "Waiting for up to %d bytes from the client.",
1973                max_bytes_to_read);
1974          }
1975          assert(max_bytes_to_read < sizeof(buf));
1976 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1977
1978          len = read_socket(csp->cfd, buf, max_bytes_to_read);
1979
1980          if (len <= 0)
1981          {
1982             /* XXX: not sure if this is necessary. */
1983             mark_server_socket_tainted(csp);
1984             break; /* "game over, man" */
1985          }
1986
1987 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1988          if (csp->expected_client_content_length != 0)
1989          {
1990             assert(len <= max_bytes_to_read);
1991             csp->expected_client_content_length -= (unsigned)len;
1992             log_error(LOG_LEVEL_CONNECT,
1993                "Expected client content length set to %llu "
1994                "after reading %d bytes.",
1995                csp->expected_client_content_length, len);
1996             if (csp->expected_client_content_length == 0)
1997             {
1998                log_error(LOG_LEVEL_CONNECT,
1999                   "Done reading from the client.");
2000                csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
2001             }
2002          }
2003 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2004
2005          if (write_socket(csp->server_connection.sfd, buf, (size_t)len))
2006          {
2007             log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
2008             mark_server_socket_tainted(csp);
2009             return;
2010          }
2011          continue;
2012       }
2013
2014       /*
2015        * The server wants to talk. It could be the header or the body.
2016        * If `hdr' is null, then it's the header otherwise it's the body.
2017        * FIXME: Does `hdr' really mean `host'? No.
2018        */
2019       if (FD_ISSET(csp->server_connection.sfd, &rfds))
2020       {
2021 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2022          if (!socket_is_still_usable(csp->cfd))
2023          {
2024 #ifdef _WIN32
2025             log_error(LOG_LEVEL_CONNECT,
2026                "The server still wants to talk, but the client may already have hung up on us.");
2027 #else
2028             log_error(LOG_LEVEL_CONNECT,
2029                "The server still wants to talk, but the client hung up on us.");
2030             mark_server_socket_tainted(csp);
2031             return;
2032 #endif /* def _WIN32 */
2033          }
2034 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2035
2036          fflush(NULL);
2037          len = read_socket(csp->server_connection.sfd, buf, sizeof(buf) - 1);
2038
2039          if (len < 0)
2040          {
2041             log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
2042
2043             if (http->ssl && (fwd->forward_host == NULL))
2044             {
2045                /*
2046                 * Just hang up. We already confirmed the client's CONNECT
2047                 * request with status code 200 and unencrypted content is
2048                 * no longer welcome.
2049                 */
2050                log_error(LOG_LEVEL_ERROR,
2051                   "CONNECT already confirmed. Unable to tell the client about the problem.");
2052                return;
2053             }
2054             else if (byte_count)
2055             {
2056                /*
2057                 * Just hang up. We already transmitted the original headers
2058                 * and parts of the original content and therefore missed the
2059                 * chance to send an error message (without risking data corruption).
2060                 *
2061                 * XXX: we could retry with a fancy range request here.
2062                 */
2063                log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
2064                   "Unable to tell the client about the problem.");
2065                mark_server_socket_tainted(csp);
2066                return;
2067             }
2068             /*
2069              * XXX: Consider handling the cases above the same.
2070              */
2071             mark_server_socket_tainted(csp);
2072             len = 0;
2073          }
2074
2075 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2076          if (csp->flags & CSP_FLAG_CHUNKED)
2077          {
2078             if ((len >= 5) && !memcmp(buf+len-5, "0\r\n\r\n", 5))
2079             {
2080                /* XXX: this is a temporary hack */
2081                log_error(LOG_LEVEL_CONNECT,
2082                   "Looks like we reached the end of the last chunk. "
2083                   "We better stop reading.");
2084                csp->expected_content_length = byte_count + (unsigned long long)len;
2085                csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2086             }
2087          }
2088          reading_done:
2089 #endif  /* FEATURE_CONNECTION_KEEP_ALIVE */
2090
2091          /*
2092           * Add a trailing zero to let be able to use string operations.
2093           * XXX: do we still need this with filter_popups gone?
2094           */
2095          buf[len] = '\0';
2096
2097          /*
2098           * Normally, this would indicate that we've read
2099           * as much as the server has sent us and we can
2100           * close the client connection.  However, Microsoft
2101           * in its wisdom has released IIS/5 with a bug that
2102           * prevents it from sending the trailing \r\n in
2103           * a 302 redirect header (and possibly other headers).
2104           * To work around this if we've haven't parsed
2105           * a full header we'll append a trailing \r\n
2106           * and see if this now generates a valid one.
2107           *
2108           * This hack shouldn't have any impacts.  If we've
2109           * already transmitted the header or if this is a
2110           * SSL connection, then we won't bother with this
2111           * hack.  So we only work on partially received
2112           * headers.  If we append a \r\n and this still
2113           * doesn't generate a valid header, then we won't
2114           * transmit anything to the client.
2115           */
2116          if (len == 0)
2117          {
2118
2119             if (server_body || http->ssl)
2120             {
2121                /*
2122                 * If we have been buffering up the document,
2123                 * now is the time to apply content modification
2124                 * and send the result to the client.
2125                 */
2126                if (content_filter)
2127                {
2128                   p = execute_content_filter(csp, content_filter);
2129                   /*
2130                    * If the content filter fails, use the original
2131                    * buffer and length.
2132                    * (see p != NULL ? p : csp->iob->cur below)
2133                    */
2134                   if (NULL == p)
2135                   {
2136                      csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
2137                   }
2138
2139                   if (JB_ERR_OK != update_server_headers(csp))
2140                   {
2141                      log_error(LOG_LEVEL_FATAL,
2142                         "Failed to update server headers. after filtering.");
2143                   }
2144
2145                   hdr = list_to_text(csp->headers);
2146                   if (hdr == NULL)
2147                   {
2148                      /* FIXME Should handle error properly */
2149                      log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2150                   }
2151
2152                   if (write_socket(csp->cfd, hdr, strlen(hdr))
2153                    || write_socket(csp->cfd,
2154                          ((p != NULL) ? p : csp->iob->cur), (size_t)csp->content_length))
2155                   {
2156                      log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
2157                      freez(hdr);
2158                      freez(p);
2159                      mark_server_socket_tainted(csp);
2160                      return;
2161                   }
2162
2163                   freez(hdr);
2164                   freez(p);
2165                }
2166
2167                break; /* "game over, man" */
2168             }
2169
2170             /*
2171              * This is NOT the body, so
2172              * Let's pretend the server just sent us a blank line.
2173              */
2174             snprintf(buf, sizeof(buf), "\r\n");
2175             len = (int)strlen(buf);
2176
2177             /*
2178              * Now, let the normal header parsing algorithm below do its
2179              * job.  If it fails, we'll exit instead of continuing.
2180              */
2181
2182             ms_iis5_hack = 1;
2183          }
2184
2185          /*
2186           * If this is an SSL connection or we're in the body
2187           * of the server document, just write it to the client,
2188           * unless we need to buffer the body for later content-filtering
2189           */
2190          if (server_body || http->ssl)
2191          {
2192             if (content_filter)
2193             {
2194                /*
2195                 * If there is no memory left for buffering the content, or the buffer limit
2196                 * has been reached, switch to non-filtering mode, i.e. make & write the
2197                 * header, flush the iob and buf, and get out of the way.
2198                 */
2199                if (add_to_iob(csp, buf, len))
2200                {
2201                   size_t hdrlen;
2202                   long flushed;
2203
2204                   log_error(LOG_LEVEL_INFO,
2205                      "Flushing header and buffers. Stepping back from filtering.");
2206
2207                   hdr = list_to_text(csp->headers);
2208                   if (hdr == NULL)
2209                   {
2210                      /* 
2211                       * Memory is too tight to even generate the header.
2212                       * Send our static "Out-of-memory" page.
2213                       */
2214                      log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
2215                      rsp = cgi_error_memory();
2216                      send_crunch_response(csp, rsp);
2217                      mark_server_socket_tainted(csp);
2218                      return;
2219                   }
2220                   hdrlen = strlen(hdr);
2221
2222                   if (write_socket(csp->cfd, hdr, hdrlen)
2223                    || ((flushed = flush_socket(csp->cfd, csp->iob)) < 0)
2224                    || (write_socket(csp->cfd, buf, (size_t)len)))
2225                   {
2226                      log_error(LOG_LEVEL_CONNECT,
2227                         "Flush header and buffers to client failed: %E");
2228                      freez(hdr);
2229                      mark_server_socket_tainted(csp);
2230                      return;
2231                   }
2232
2233                   /*
2234                    * Reset the byte_count to the amount of bytes
2235                    * we just flushed. len will be added a few lines below,
2236                    * hdrlen doesn't matter for LOG_LEVEL_CLF.
2237                    */
2238                   byte_count = (unsigned long long)flushed;
2239                   freez(hdr);
2240                   content_filter = NULL;
2241                   server_body = 1;
2242                }
2243             }
2244             else
2245             {
2246                if (write_socket(csp->cfd, buf, (size_t)len))
2247                {
2248                   log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
2249                   mark_server_socket_tainted(csp);
2250                   return;
2251                }
2252             }
2253             byte_count += (unsigned long long)len;
2254             continue;
2255          }
2256          else
2257          {
2258             /*
2259              * We're still looking for the end of the server's header.
2260              * Buffer up the data we just read.  If that fails, there's
2261              * little we can do but send our static out-of-memory page.
2262              */
2263             if (add_to_iob(csp, buf, len))
2264             {
2265                log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
2266                rsp = cgi_error_memory();
2267                send_crunch_response(csp, rsp);               
2268                mark_server_socket_tainted(csp);
2269                return;
2270             }
2271
2272             /* Convert iob into something sed() can digest */
2273             if (JB_ERR_PARSE == get_server_headers(csp))
2274             {
2275                if (ms_iis5_hack)
2276                {
2277                   /*
2278                    * Well, we tried our MS IIS/5 hack and it didn't work.
2279                    * The header is incomplete and there isn't anything
2280                    * we can do about it.
2281                    */
2282                   log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
2283                      "Applying the MS IIS5 hack didn't help.");
2284                   log_error(LOG_LEVEL_CLF,
2285                      "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2286                   write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2287                      strlen(INVALID_SERVER_HEADERS_RESPONSE));
2288                   mark_server_socket_tainted(csp);
2289                   return;
2290                }
2291                else
2292                {
2293                   /*
2294                    * Since we have to wait for more from the server before
2295                    * we can parse the headers we just continue here.
2296                    */
2297                   log_error(LOG_LEVEL_CONNECT,
2298                      "Continuing buffering headers. Bytes most recently read: %d.",
2299                      len);
2300                   continue;
2301                }
2302             }
2303             else
2304             {
2305                /*
2306                 * Account for the content bytes we
2307                 * might have gotten with the headers.
2308                 */
2309                assert(csp->iob->eod >= csp->iob->cur);
2310                byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2311             }
2312
2313             /* Did we actually get anything? */
2314             if (NULL == csp->headers->first)
2315             {
2316                if ((csp->flags & CSP_FLAG_REUSED_CLIENT_CONNECTION))
2317                {
2318                   log_error(LOG_LEVEL_ERROR,
2319                      "Empty server or forwarder response received on socket %d. "
2320                      "Closing client connection %d without sending data.",
2321                      csp->server_connection.sfd, csp->cfd);
2322                }
2323                else
2324                {
2325                   log_error(LOG_LEVEL_ERROR,
2326                      "Empty server or forwarder response received on socket %d.",
2327                      csp->server_connection.sfd);
2328                   send_crunch_response(csp, error_response(csp, "no-server-data"));
2329                }
2330                log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2331                free_http_request(http);
2332                mark_server_socket_tainted(csp);
2333                return;
2334             }
2335
2336             assert(csp->headers->first->str);
2337             assert(!http->ssl);
2338             if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
2339                 strncmpic(csp->headers->first->str, "ICY", 3))
2340             {
2341                /*
2342                 * It doesn't look like a HTTP (or Shoutcast) response:
2343                 * tell the client and log the problem.
2344                 */
2345                if (strlen(csp->headers->first->str) > 30)
2346                {
2347                   csp->headers->first->str[30] = '\0';
2348                }
2349                log_error(LOG_LEVEL_ERROR,
2350                   "Invalid server or forwarder response. Starts with: %s",
2351                   csp->headers->first->str);
2352                log_error(LOG_LEVEL_CLF,
2353                   "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2354                write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2355                   strlen(INVALID_SERVER_HEADERS_RESPONSE));
2356                free_http_request(http);
2357                mark_server_socket_tainted(csp);
2358                return;
2359             }
2360
2361             /*
2362              * We have now received the entire server header,
2363              * filter it and send the result to the client
2364              */
2365             if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
2366             {
2367                log_error(LOG_LEVEL_FATAL, "Failed to parse server headers.");
2368             }
2369             hdr = list_to_text(csp->headers);
2370             if (hdr == NULL)
2371             {
2372                /* FIXME Should handle error properly */
2373                log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2374             }
2375
2376             csp->server_connection.response_received = time(NULL);
2377
2378             if (crunch_response_triggered(csp, crunchers_light))
2379             {
2380                /*
2381                 * One of the tags created by a server-header
2382                 * tagger triggered a crunch. We already
2383                 * delivered the crunch response to the client
2384                 * and are done here after cleaning up.
2385                 */
2386                 freez(hdr);
2387                 mark_server_socket_tainted(csp);
2388                 return;
2389             }
2390             /* Buffer and pcrs filter this if appropriate. */
2391
2392             if (!http->ssl) /* We talk plaintext */
2393             {
2394                content_filter = get_filter_function(csp);
2395             }
2396             /*
2397              * Only write if we're not buffering for content modification
2398              */
2399             if (!content_filter)
2400             {
2401                /*
2402                 * Write the server's (modified) header to
2403                 * the client (along with anything else that
2404                 * may be in the buffer)
2405                 */
2406
2407                if (write_socket(csp->cfd, hdr, strlen(hdr))
2408                 || ((len = flush_socket(csp->cfd, csp->iob)) < 0))
2409                {
2410                   log_error(LOG_LEVEL_CONNECT, "write header to client failed: %E");
2411
2412                   /*
2413                    * The write failed, so don't bother mentioning it
2414                    * to the client... it probably can't hear us anyway.
2415                    */
2416                   freez(hdr);
2417                   mark_server_socket_tainted(csp);
2418                   return;
2419                }
2420             }
2421
2422             /* we're finished with the server's header */
2423
2424             freez(hdr);
2425             server_body = 1;
2426
2427             /*
2428              * If this was a MS IIS/5 hack then it means the server
2429              * has already closed the connection. Nothing more to read.
2430              * Time to bail.
2431              */
2432             if (ms_iis5_hack)
2433             {
2434                log_error(LOG_LEVEL_ERROR,
2435                   "Closed server connection detected. "
2436                   "Applying the MS IIS5 hack didn't help.");
2437                log_error(LOG_LEVEL_CLF,
2438                   "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2439                write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2440                   strlen(INVALID_SERVER_HEADERS_RESPONSE));
2441                mark_server_socket_tainted(csp);
2442                return;
2443             }
2444          }
2445          continue;
2446       }
2447       mark_server_socket_tainted(csp);
2448       return; /* huh? we should never get here */
2449    }
2450
2451    if (csp->content_length == 0)
2452    {
2453       /*
2454        * If Privoxy didn't recalculate the Content-Lenght,
2455        * byte_count is still correct.
2456        */
2457       csp->content_length = byte_count;
2458    }
2459
2460 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2461    if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2462       && (csp->expected_content_length != byte_count))
2463    {
2464       log_error(LOG_LEVEL_CONNECT,
2465          "Received %llu bytes while expecting %llu.",
2466          byte_count, csp->expected_content_length);
2467       mark_server_socket_tainted(csp);
2468    }
2469 #endif
2470
2471    log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
2472       csp->ip_addr_str, http->ocmd, csp->content_length);
2473
2474    csp->server_connection.timestamp = time(NULL);
2475 }
2476
2477
2478 /*********************************************************************
2479  *
2480  * Function    :  serve
2481  *
2482  * Description :  This is little more than chat.  We only "serve" to
2483  *                to close (or remember) any socket that chat may have
2484  *                opened.
2485  *
2486  * Parameters  :
2487  *          1  :  csp = Current client state (buffers, headers, etc...)
2488  *
2489  * Returns     :  N/A
2490  *
2491  *********************************************************************/
2492 #ifdef AMIGA
2493 void serve(struct client_state *csp)
2494 #else /* ifndef AMIGA */
2495 static void serve(struct client_state *csp)
2496 #endif /* def AMIGA */
2497 {
2498 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2499 #ifdef FEATURE_CONNECTION_SHARING
2500    static int monitor_thread_running = 0;
2501 #endif /* def FEATURE_CONNECTION_SHARING */
2502    int continue_chatting = 0;
2503
2504    do
2505    {
2506       unsigned int latency;
2507
2508       chat(csp);
2509
2510       latency = (unsigned)(csp->server_connection.response_received -
2511          csp->server_connection.request_sent) / 2;
2512
2513       continue_chatting = (csp->config->feature_flags
2514          & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
2515          && (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
2516          && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
2517          && (csp->cfd != JB_INVALID_SOCKET)
2518          && (csp->server_connection.sfd != JB_INVALID_SOCKET)
2519          && socket_is_still_usable(csp->server_connection.sfd)
2520          && (latency < csp->server_connection.keep_alive_timeout);
2521
2522       if (continue_chatting)
2523       {
2524          unsigned int client_timeout;
2525
2526          if (!(csp->flags & CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET))
2527          {
2528             log_error(LOG_LEVEL_CONNECT, "The server didn't specify how long "
2529                "the connection will stay open. Assume it's only a second.");
2530             csp->server_connection.keep_alive_timeout = 1;
2531          }
2532
2533          client_timeout = (unsigned)csp->server_connection.keep_alive_timeout - latency;
2534
2535          log_error(LOG_LEVEL_CONNECT,
2536             "Waiting for the next client request. "
2537             "Keeping the server socket %d to %s open.",
2538             csp->server_connection.sfd, csp->server_connection.host);
2539
2540          if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
2541             && data_is_available(csp->cfd, (int)client_timeout)
2542             && socket_is_still_usable(csp->cfd))
2543          {
2544             log_error(LOG_LEVEL_CONNECT, "Client request arrived in "
2545                "time or the client closed the connection.");
2546             /*
2547              * Get the csp in a mostly vergin state again.
2548              * XXX: Should be done elsewhere.
2549              */
2550             csp->content_type = 0;
2551             csp->content_length = 0;
2552             csp->expected_content_length = 0;
2553             csp->expected_client_content_length = 0;
2554             list_remove_all(csp->headers);
2555             freez(csp->iob->buf);
2556             memset(csp->iob, 0, sizeof(csp->iob));
2557             freez(csp->error_message);
2558             free_http_request(csp->http);
2559             destroy_list(csp->headers);
2560             destroy_list(csp->tags);
2561             free_current_action(csp->action);
2562             if (NULL != csp->fwd)
2563             {
2564                unload_forward_spec(csp->fwd);
2565                csp->fwd = NULL;
2566             }
2567
2568             /* XXX: Store per-connection flags someplace else. */
2569             csp->flags = CSP_FLAG_ACTIVE |
2570                (csp->flags & CSP_FLAG_TOGGLED_ON) | CSP_FLAG_REUSED_CLIENT_CONNECTION;
2571          }
2572          else
2573          {
2574             log_error(LOG_LEVEL_CONNECT,
2575                "No additional client request received in time.");
2576 #ifdef FEATURE_CONNECTION_SHARING
2577             if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
2578                && (socket_is_still_usable(csp->server_connection.sfd)))
2579             {
2580                time_t time_open = time(NULL) - csp->server_connection.timestamp;
2581
2582                if (csp->server_connection.keep_alive_timeout < time_open + latency)
2583                {
2584                   break;
2585                }
2586
2587                remember_connection(&csp->server_connection);
2588                csp->server_connection.sfd = JB_INVALID_SOCKET;
2589                close_socket(csp->cfd);
2590                csp->cfd = JB_INVALID_SOCKET;
2591                privoxy_mutex_lock(&connection_reuse_mutex);
2592                if (!monitor_thread_running)
2593                {
2594                   monitor_thread_running = 1;
2595                   privoxy_mutex_unlock(&connection_reuse_mutex);
2596                   wait_for_alive_connections();
2597                   privoxy_mutex_lock(&connection_reuse_mutex);
2598                   monitor_thread_running = 0;
2599                }
2600                privoxy_mutex_unlock(&connection_reuse_mutex);
2601             }
2602 #endif /* def FEATURE_CONNECTION_SHARING */
2603             break;
2604          }
2605       }
2606       else if (csp->server_connection.sfd != JB_INVALID_SOCKET)
2607       {
2608          log_error(LOG_LEVEL_CONNECT,
2609             "The connection on server socket %d to %s isn't reusable. "
2610             "Closing.", csp->server_connection.sfd, csp->server_connection.host);
2611       }
2612    } while (continue_chatting);
2613
2614 #else
2615    chat(csp);
2616 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2617
2618    if (csp->server_connection.sfd != JB_INVALID_SOCKET)
2619    {
2620 #ifdef FEATURE_CONNECTION_SHARING
2621       forget_connection(csp->server_connection.sfd);
2622 #endif /* def FEATURE_CONNECTION_SHARING */
2623       close_socket(csp->server_connection.sfd);
2624    }
2625
2626 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2627    mark_connection_closed(&csp->server_connection);
2628 #endif
2629
2630    if (csp->cfd != JB_INVALID_SOCKET)
2631    {
2632       close_socket(csp->cfd);
2633    }
2634
2635    csp->flags &= ~CSP_FLAG_ACTIVE;
2636
2637 }
2638
2639
2640 #ifdef __BEOS__
2641 /*********************************************************************
2642  *
2643  * Function    :  server_thread
2644  *
2645  * Description :  We only exist to call `serve' in a threaded environment.
2646  *
2647  * Parameters  :
2648  *          1  :  data = Current client state (buffers, headers, etc...)
2649  *
2650  * Returns     :  Always 0.
2651  *
2652  *********************************************************************/
2653 static int32 server_thread(void *data)
2654 {
2655    serve((struct client_state *) data);
2656    return 0;
2657
2658 }
2659 #endif
2660
2661
2662 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
2663 /*********************************************************************
2664  *
2665  * Function    :  usage
2666  *
2667  * Description :  Print usage info & exit.
2668  *
2669  * Parameters  :  Pointer to argv[0] for identifying ourselves
2670  *
2671  * Returns     :  No. ,-)
2672  *
2673  *********************************************************************/
2674 static void usage(const char *myname)
2675 {
2676    printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
2677           "Usage: %s "
2678 #if defined(unix)
2679           "[--chroot] "
2680 #endif /* defined(unix) */
2681           "[--help] "
2682 #if defined(unix)
2683           "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
2684 #endif /* defined(unix) */
2685           "[--version] [configfile]\n"
2686           "Aborting\n", myname);
2687
2688    exit(2);
2689
2690 }
2691 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
2692
2693
2694 #ifdef MUTEX_LOCKS_AVAILABLE
2695 /*********************************************************************
2696  *
2697  * Function    :  privoxy_mutex_lock
2698  *
2699  * Description :  Locks a mutex.
2700  *
2701  * Parameters  :
2702  *          1  :  mutex = The mutex to lock.
2703  *
2704  * Returns     :  Void. May exit in case of errors.
2705  *
2706  *********************************************************************/
2707 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
2708 {
2709 #ifdef FEATURE_PTHREAD
2710    int err = pthread_mutex_lock(mutex);
2711    if (err)
2712    {
2713       if (mutex != &log_mutex)
2714       {
2715          log_error(LOG_LEVEL_FATAL,
2716             "Mutex locking failed: %s.\n", strerror(err));
2717       }
2718       exit(1);
2719    }
2720 #else
2721    EnterCriticalSection(mutex);
2722 #endif /* def FEATURE_PTHREAD */
2723 }
2724
2725
2726 /*********************************************************************
2727  *
2728  * Function    :  privoxy_mutex_unlock
2729  *
2730  * Description :  Unlocks a mutex.
2731  *
2732  * Parameters  :
2733  *          1  :  mutex = The mutex to unlock.
2734  *
2735  * Returns     :  Void. May exit in case of errors.
2736  *
2737  *********************************************************************/
2738 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
2739 {
2740 #ifdef FEATURE_PTHREAD
2741    int err = pthread_mutex_unlock(mutex);
2742    if (err)
2743    {
2744       if (mutex != &log_mutex)
2745       {
2746          log_error(LOG_LEVEL_FATAL,
2747             "Mutex unlocking failed: %s.\n", strerror(err));
2748       }
2749       exit(1);
2750    }
2751 #else
2752    LeaveCriticalSection(mutex);
2753 #endif /* def FEATURE_PTHREAD */
2754 }
2755
2756
2757 /*********************************************************************
2758  *
2759  * Function    :  privoxy_mutex_init
2760  *
2761  * Description :  Prepares a mutex.
2762  *
2763  * Parameters  :
2764  *          1  :  mutex = The mutex to initialize.
2765  *
2766  * Returns     :  Void. May exit in case of errors.
2767  *
2768  *********************************************************************/
2769 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
2770 {
2771 #ifdef FEATURE_PTHREAD
2772    int err = pthread_mutex_init(mutex, 0);
2773    if (err)
2774    {
2775       printf("Fatal error. Mutex initialization failed: %s.\n",
2776          strerror(err));
2777       exit(1);
2778    }
2779 #else
2780    InitializeCriticalSection(mutex);
2781 #endif /* def FEATURE_PTHREAD */
2782 }
2783 #endif /* def MUTEX_LOCKS_AVAILABLE */
2784
2785 /*********************************************************************
2786  *
2787  * Function    :  initialize_mutexes
2788  *
2789  * Description :  Prepares mutexes if mutex support is available.
2790  *
2791  * Parameters  :  None
2792  *
2793  * Returns     :  Void, exits in case of errors.
2794  *
2795  *********************************************************************/
2796 static void initialize_mutexes(void)
2797 {
2798 #ifdef MUTEX_LOCKS_AVAILABLE
2799    /*
2800     * Prepare global mutex semaphores
2801     */
2802    privoxy_mutex_init(&log_mutex);
2803    privoxy_mutex_init(&log_init_mutex);
2804    privoxy_mutex_init(&connection_reuse_mutex);
2805
2806    /*
2807     * XXX: The assumptions below are a bit naive
2808     * and can cause locks that aren't necessary.
2809     *
2810     * For example older FreeBSD versions (< 6.x?)
2811     * have no gethostbyname_r, but gethostbyname is
2812     * thread safe.
2813     */
2814 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
2815    privoxy_mutex_init(&resolver_mutex);
2816 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
2817    /*
2818     * XXX: should we use a single mutex for
2819     * localtime() and gmtime() as well?
2820     */
2821 #ifndef HAVE_GMTIME_R
2822    privoxy_mutex_init(&gmtime_mutex);
2823 #endif /* ndef HAVE_GMTIME_R */
2824
2825 #ifndef HAVE_LOCALTIME_R
2826    privoxy_mutex_init(&localtime_mutex);
2827 #endif /* ndef HAVE_GMTIME_R */
2828
2829 #ifndef HAVE_RANDOM
2830    privoxy_mutex_init(&rand_mutex);
2831 #endif /* ndef HAVE_RANDOM */
2832 #endif /* def MUTEX_LOCKS_AVAILABLE */
2833 }
2834
2835
2836 /*********************************************************************
2837  *
2838  * Function    :  main
2839  *
2840  * Description :  Load the config file and start the listen loop.
2841  *                This function is a lot more *sane* with the `load_config'
2842  *                and `listen_loop' functions; although it stills does
2843  *                a *little* too much for my taste.
2844  *
2845  * Parameters  :
2846  *          1  :  argc = Number of parameters (including $0).
2847  *          2  :  argv = Array of (char *)'s to the parameters.
2848  *
2849  * Returns     :  1 if : can't open config file, unrecognized directive,
2850  *                stats requested in multi-thread mode, can't open the
2851  *                log file, can't open the jar file, listen port is invalid,
2852  *                any load fails, and can't bind port.
2853  *
2854  *                Else main never returns, the process must be signaled
2855  *                to terminate execution.  Or, on Windows, use the
2856  *                "File", "Exit" menu option.
2857  *
2858  *********************************************************************/
2859 #ifdef __MINGW32__
2860 int real_main(int argc, char **argv)
2861 #else
2862 int main(int argc, char **argv)
2863 #endif
2864 {
2865    int argc_pos = 0;
2866    unsigned int random_seed;
2867 #ifdef unix
2868    struct passwd *pw = NULL;
2869    struct group *grp = NULL;
2870    char *p;
2871    int do_chroot = 0;
2872    char *pre_chroot_nslookup_to_load_resolver = NULL;
2873 #endif
2874
2875    Argc = argc;
2876    Argv = argv;
2877
2878    configfile =
2879 #if !defined(_WIN32)
2880    "config"
2881 #else
2882    "config.txt"
2883 #endif
2884       ;
2885
2886    /* Prepare mutexes if supported and necessary. */
2887    initialize_mutexes();
2888
2889    /* Enable logging until further notice. */
2890    init_log_module();
2891
2892    /*
2893     * Parse the command line arguments
2894     *
2895     * XXX: simply printing usage information in case of
2896     * invalid arguments isn't particularly user friendly.
2897     */
2898    while (++argc_pos < argc)
2899    {
2900 #ifdef _WIN32
2901       /* Check to see if the service must be installed or uninstalled */
2902       if (strncmp(argv[argc_pos], "--install", 9) == 0)
2903       {
2904          const char *pName = argv[argc_pos] + 9;
2905          if (*pName == ':')
2906             pName++;
2907          exit( (install_service(pName)) ? 0 : 1 );
2908       }
2909       else if (strncmp(argv[argc_pos], "--uninstall", + 11) == 0)
2910       {
2911          const char *pName = argv[argc_pos] + 11;
2912          if (*pName == ':')
2913             pName++;
2914          exit((uninstall_service(pName)) ? 0 : 1);
2915       }
2916       else if (strcmp(argv[argc_pos], "--service" ) == 0)
2917       {
2918          bRunAsService = TRUE;
2919          w32_set_service_cwd();
2920          atexit(w32_service_exit_notify);
2921       }
2922       else
2923 #endif /* defined(_WIN32) */
2924
2925
2926 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
2927
2928       if (strcmp(argv[argc_pos], "--help") == 0)
2929       {
2930          usage(argv[0]);
2931       }
2932
2933       else if(strcmp(argv[argc_pos], "--version") == 0)
2934       {
2935          printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
2936          exit(0);
2937       }
2938
2939 #if defined(unix)
2940
2941       else if (strcmp(argv[argc_pos], "--no-daemon" ) == 0)
2942       {
2943          set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
2944          no_daemon = 1;
2945       }
2946
2947       else if (strcmp(argv[argc_pos], "--pidfile" ) == 0)
2948       {
2949          if (++argc_pos == argc) usage(argv[0]);
2950          pidfile = strdup(argv[argc_pos]);
2951       }
2952
2953       else if (strcmp(argv[argc_pos], "--user" ) == 0)
2954       {
2955          if (++argc_pos == argc) usage(argv[argc_pos]);
2956
2957          if ((NULL != (p = strchr(argv[argc_pos], '.'))) && *(p + 1) != '0')
2958          {
2959             *p++ = '\0';
2960             if (NULL == (grp = getgrnam(p)))
2961             {
2962                log_error(LOG_LEVEL_FATAL, "Group %s not found.", p);
2963             }
2964          }
2965
2966          if (NULL == (pw = getpwnam(argv[argc_pos])))
2967          {
2968             log_error(LOG_LEVEL_FATAL, "User %s not found.", argv[argc_pos]);
2969          }
2970
2971          if (p != NULL) *--p = '\0';
2972       }
2973
2974       else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup" ) == 0)
2975       {
2976          if (++argc_pos == argc) usage(argv[0]);
2977          pre_chroot_nslookup_to_load_resolver = strdup(argv[argc_pos]);
2978       }
2979
2980       else if (strcmp(argv[argc_pos], "--chroot" ) == 0)
2981       {
2982          do_chroot = 1;
2983       }
2984 #endif /* defined(unix) */
2985
2986       else if (argc_pos + 1 != argc)
2987       {
2988          /*
2989           * This is neither the last command line
2990           * option, nor was it recognized before,
2991           * therefore it must be invalid.
2992           */
2993          usage(argv[0]);
2994       }
2995       else
2996
2997 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
2998       {
2999          configfile = argv[argc_pos];
3000       }
3001
3002    } /* -END- while (more arguments) */
3003
3004    show_version(Argv[0]);
3005
3006 #if defined(unix)
3007    if ( *configfile != '/' )
3008    {
3009       char cwd[BUFFER_SIZE];
3010       char *abs_file;
3011       size_t abs_file_size; 
3012
3013       /* make config-filename absolute here */
3014       if (NULL == getcwd(cwd, sizeof(cwd)))
3015       {
3016          perror("failed to get current working directory");
3017          exit( 1 );
3018       }
3019
3020       /* XXX: why + 5? */
3021       abs_file_size = strlen(cwd) + strlen(configfile) + 5;
3022       basedir = strdup(cwd);
3023
3024       if (NULL == basedir ||
3025           NULL == (abs_file = malloc(abs_file_size)))
3026       {
3027          perror("malloc failed");
3028          exit( 1 );
3029       }
3030       strlcpy(abs_file, basedir, abs_file_size);
3031       strlcat(abs_file, "/", abs_file_size );
3032       strlcat(abs_file, configfile, abs_file_size);
3033       configfile = abs_file;
3034    }
3035 #endif /* defined unix */
3036
3037
3038    files->next = NULL;
3039    clients->next = NULL;
3040
3041    /* XXX: factor out initialising after the next stable release. */
3042 #ifdef AMIGA
3043    InitAmiga();
3044 #elif defined(_WIN32)
3045    InitWin32();
3046 #endif
3047
3048    random_seed = (unsigned int)time(NULL);
3049 #ifdef HAVE_RANDOM
3050    srandom(random_seed);
3051 #else
3052    srand(random_seed);
3053 #endif /* ifdef HAVE_RANDOM */
3054
3055    /*
3056     * Unix signal handling
3057     *
3058     * Catch the abort, interrupt and terminate signals for a graceful exit
3059     * Catch the hangup signal so the errlog can be reopened.
3060     * Ignore the broken pipe signals (FIXME: Why?)
3061     */
3062 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
3063 {
3064    int idx;
3065    const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP, 0 };
3066    const int ignored_signals[] = { SIGPIPE, 0 };
3067
3068    for (idx = 0; catched_signals[idx] != 0; idx++)
3069    {
3070 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */ 
3071       if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
3072 #else
3073       if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
3074 #endif /* ifdef sun */
3075       {
3076          log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
3077       }
3078    }
3079
3080    for (idx = 0; ignored_signals[idx] != 0; idx++)
3081    {
3082       if (signal(ignored_signals[idx], SIG_IGN) == SIG_ERR)
3083       {
3084          log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for signal %d: %E", ignored_signals[idx]);
3085       }
3086    }
3087
3088 }
3089 #else /* ifdef _WIN32 */
3090 # ifdef _WIN_CONSOLE
3091    /*
3092     * We *are* in a windows console app.
3093     * Print a verbose messages about FAQ's and such
3094     */
3095    printf("%s", win32_blurb);
3096 # endif /* def _WIN_CONSOLE */
3097 #endif /* def _WIN32 */
3098
3099
3100    /* Initialize the CGI subsystem */
3101    cgi_init_error_messages();
3102
3103    /*
3104     * If runnig on unix and without the --nodaemon
3105     * option, become a daemon. I.e. fork, detach
3106     * from tty and get process group leadership
3107     */
3108 #if defined(unix)
3109 {
3110    pid_t pid = 0;
3111 #if 0
3112    int   fd;
3113 #endif
3114
3115    if (!no_daemon)
3116    {
3117       pid  = fork();
3118
3119       if ( pid < 0 ) /* error */
3120       {
3121          perror("fork");
3122          exit( 3 );
3123       }
3124       else if ( pid != 0 ) /* parent */
3125       {
3126          int status;
3127          pid_t wpid;
3128          /*
3129           * must check for errors
3130           * child died due to missing files aso
3131           */
3132          sleep( 1 );
3133          wpid = waitpid( pid, &status, WNOHANG );
3134          if ( wpid != 0 )
3135          {
3136             exit( 1 );
3137          }
3138          exit( 0 );
3139       }
3140       /* child */
3141 #if 1
3142       /* Should be more portable, but not as well tested */
3143       setsid();
3144 #else /* !1 */
3145 #ifdef __FreeBSD__
3146       setpgrp(0,0);
3147 #else /* ndef __FreeBSD__ */
3148       setpgrp();
3149 #endif /* ndef __FreeBSD__ */
3150       fd = open("/dev/tty", O_RDONLY);
3151       if ( fd )
3152       {
3153          /* no error check here */
3154          ioctl( fd, TIOCNOTTY,0 );
3155          close ( fd );
3156       }
3157 #endif /* 1 */
3158       /*
3159        * stderr (fd 2) will be closed later on,
3160        * when the config file has been parsed.
3161        */
3162
3163       close( 0 );
3164       close( 1 );
3165       chdir("/");
3166
3167    } /* -END- if (!no_daemon) */
3168
3169    /*
3170     * As soon as we have written the PID file, we can switch
3171     * to the user and group ID indicated by the --user option
3172     */
3173    write_pid_file();
3174
3175    if (NULL != pw)
3176    {
3177       if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
3178       {
3179          log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
3180       }
3181       if (NULL != grp)
3182       {
3183          if (setgroups(1, &grp->gr_gid))
3184          {
3185             log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
3186          }
3187       }
3188       else if (initgroups(pw->pw_name, pw->pw_gid))
3189       {
3190          log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
3191       }
3192       if (do_chroot)
3193       {
3194          if (!pw->pw_dir)
3195          {
3196             log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
3197          }
3198          /* Read the time zone file from /etc before doing chroot. */
3199          tzset();
3200          if (NULL != pre_chroot_nslookup_to_load_resolver
3201              && '\0' != pre_chroot_nslookup_to_load_resolver[0])
3202          {
3203             /* Initialize resolver library. */
3204             (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
3205          }
3206          if (chroot(pw->pw_dir) < 0)
3207          {
3208             log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
3209          }
3210          if (chdir ("/"))
3211          {
3212             log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
3213          }
3214       }
3215       if (setuid(pw->pw_uid))
3216       {
3217          log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
3218       }
3219       if (do_chroot)
3220       {
3221          char putenv_dummy[64];
3222
3223          strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
3224          if (putenv(putenv_dummy) != 0)
3225          {
3226             log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
3227          }                
3228
3229          snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
3230          if (putenv(putenv_dummy) != 0)
3231          {
3232             log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
3233          }
3234       }
3235    }
3236    else if (do_chroot)
3237    {
3238       log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
3239    }
3240 }
3241 #endif /* defined unix */
3242
3243 #ifdef _WIN32
3244    /* This will be FALSE unless the command line specified --service
3245     */
3246    if (bRunAsService)
3247    {
3248       /* Yup, so now we must attempt to establish a connection 
3249        * with the service dispatcher. This will only work if this
3250        * process was launched by the service control manager to
3251        * actually run as a service. If this isn't the case, i've
3252        * known it take around 30 seconds or so for the call to return.
3253        */
3254
3255       /* The StartServiceCtrlDispatcher won't return until the service is stopping */
3256       if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
3257       {
3258          /* Service has run, and at this point is now being stopped, so just return */
3259          return 0;
3260       }
3261
3262 #ifdef _WIN_CONSOLE
3263       printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
3264 #endif
3265       /* An error occurred. Usually it's because --service was wrongly specified
3266        * and we were unable to connect to the Service Control Dispatcher because
3267        * it wasn't expecting us and is therefore not listening.
3268        *
3269        * For now, just continue below to call the listen_loop function.
3270        */
3271    }
3272 #endif /* def _WIN32 */
3273
3274    listen_loop();
3275
3276    /* NOTREACHED */
3277    return(-1);
3278
3279 }
3280
3281
3282 /*********************************************************************
3283  *
3284  * Function    :  bind_port_helper
3285  *
3286  * Description :  Bind the listen port.  Handles logging, and aborts
3287  *                on failure.
3288  *
3289  * Parameters  :
3290  *          1  :  config = Privoxy configuration.  Specifies port
3291  *                         to bind to.
3292  *
3293  * Returns     :  Port that was opened.
3294  *
3295  *********************************************************************/
3296 static jb_socket bind_port_helper(struct configuration_spec * config)
3297 {
3298    int result;
3299    jb_socket bfd;
3300
3301    if (config->haddr == NULL)
3302    {
3303       log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
3304                 config->hport);
3305    }
3306    else
3307    {
3308       log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
3309                 config->hport, config->haddr);
3310    }
3311
3312    result = bind_port(config->haddr, config->hport, &bfd);
3313
3314    if (result < 0)
3315    {
3316       switch(result)
3317       {
3318          case -3 :
3319             log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
3320                "There may be another Privoxy or some other "
3321                "proxy running on port %d",
3322                (NULL != config->haddr) ? config->haddr : "INADDR_ANY",
3323                       config->hport, config->hport);
3324
3325          case -2 :
3326             log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: " 
3327                "The hostname is not resolvable",
3328                (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
3329
3330          default :
3331             log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: %E",
3332                (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
3333       }
3334
3335       /* shouldn't get here */
3336       return JB_INVALID_SOCKET;
3337    }
3338
3339    config->need_bind = 0;
3340
3341    return bfd;
3342 }
3343
3344
3345 #ifdef _WIN32
3346 /* Without this simple workaround we get this compiler warning from _beginthread
3347  *     warning C4028: formal parameter 1 different from declaration
3348  */
3349 void w32_service_listen_loop(void *p)
3350 {
3351    listen_loop();
3352 }
3353 #endif /* def _WIN32 */
3354
3355
3356 /*********************************************************************
3357  *
3358  * Function    :  listen_loop
3359  *
3360  * Description :  bind the listen port and enter a "FOREVER" listening loop.
3361  *
3362  * Parameters  :  N/A
3363  *
3364  * Returns     :  Never.
3365  *
3366  *********************************************************************/
3367 static void listen_loop(void)
3368 {
3369    struct client_state *csp = NULL;
3370    jb_socket bfd;
3371    struct configuration_spec *config;
3372    unsigned int active_threads = 0;
3373
3374    config = load_config();
3375
3376 #ifdef FEATURE_CONNECTION_SHARING
3377    /*
3378     * XXX: Should be relocated once it no
3379     * longer needs to emit log messages.
3380     */
3381    initialize_reusable_connections();
3382 #endif /* def FEATURE_CONNECTION_SHARING */
3383
3384    bfd = bind_port_helper(config);
3385
3386 #ifdef FEATURE_GRACEFUL_TERMINATION
3387    while (!g_terminate)
3388 #else
3389    for (;;)
3390 #endif
3391    {
3392 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
3393       while (waitpid(-1, NULL, WNOHANG) > 0)
3394       {
3395          /* zombie children */
3396       }
3397 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
3398
3399       /*
3400        * Free data that was used by died threads
3401        */
3402       active_threads = sweep();
3403
3404 #if defined(unix)
3405       /*
3406        * Re-open the errlog after HUP signal
3407        */
3408       if (received_hup_signal)
3409       {
3410          if (NULL != config->logfile)
3411          {
3412             init_error_log(Argv[0], config->logfile);
3413          }
3414          received_hup_signal = 0;
3415       }
3416 #endif
3417
3418       if ( NULL == (csp = (struct client_state *) zalloc(sizeof(*csp))) )
3419       {
3420          log_error(LOG_LEVEL_FATAL, "malloc(%d) for csp failed: %E", sizeof(*csp));
3421          continue;
3422       }
3423
3424       csp->flags |= CSP_FLAG_ACTIVE;
3425       csp->server_connection.sfd = JB_INVALID_SOCKET;
3426
3427       csp->config = config = load_config();
3428
3429       if ( config->need_bind )
3430       {
3431          /*
3432           * Since we were listening to the "old port", we will not see
3433           * a "listen" param change until the next request.  So, at
3434           * least 1 more request must be made for us to find the new
3435           * setting.  I am simply closing the old socket and binding the
3436           * new one.
3437           *
3438           * Which-ever is correct, we will serve 1 more page via the
3439           * old settings.  This should probably be a "show-proxy-args"
3440           * request.  This should not be a so common of an operation
3441           * that this will hurt people's feelings.
3442           */
3443
3444          close_socket(bfd);
3445
3446          bfd = bind_port_helper(config);
3447       }
3448
3449       log_error(LOG_LEVEL_CONNECT, "Listening for new connections ... ");
3450
3451       if (!accept_connection(csp, bfd))
3452       {
3453          log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
3454
3455 #ifdef AMIGA
3456          if(!childs)
3457          {
3458             exit(1);
3459          }
3460 #endif
3461          freez(csp);
3462          continue;
3463       }
3464       else
3465       {
3466          log_error(LOG_LEVEL_CONNECT, "accepted connection from %s", csp->ip_addr_str);
3467       }
3468
3469 #ifdef FEATURE_TOGGLE
3470       if (global_toggle_state)
3471 #endif /* def FEATURE_TOGGLE */
3472       {
3473          csp->flags |= CSP_FLAG_TOGGLED_ON;
3474       }
3475
3476       if (run_loader(csp))
3477       {
3478          log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
3479          /* Never get here - LOG_LEVEL_FATAL causes program exit */
3480       }
3481
3482 #ifdef FEATURE_ACL
3483       if (block_acl(NULL,csp))
3484       {
3485          log_error(LOG_LEVEL_CONNECT, "Connection from %s dropped due to ACL", csp->ip_addr_str);
3486          close_socket(csp->cfd);
3487          freez(csp->ip_addr_str);
3488          freez(csp);
3489          continue;
3490       }
3491 #endif /* def FEATURE_ACL */
3492
3493       if ((0 != config->max_client_connections)
3494          && (active_threads >= config->max_client_connections))
3495       {
3496          log_error(LOG_LEVEL_CONNECT,
3497             "Rejecting connection from %s. Maximum number of connections reached.",
3498             csp->ip_addr_str);
3499          write_socket(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
3500             strlen(TOO_MANY_CONNECTIONS_RESPONSE));
3501          close_socket(csp->cfd);
3502          freez(csp->ip_addr_str);
3503          freez(csp);
3504          continue;
3505       }
3506
3507       /* add it to the list of clients */
3508       csp->next = clients->next;
3509       clients->next = csp;
3510
3511       if (config->multi_threaded)
3512       {
3513          int child_id;
3514
3515 /* this is a switch () statment in the C preprocessor - ugh */
3516 #undef SELECTED_ONE_OPTION
3517
3518 /* Use Pthreads in preference to native code */
3519 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
3520 #define SELECTED_ONE_OPTION
3521          {
3522             pthread_t the_thread;
3523             pthread_attr_t attrs;
3524
3525             pthread_attr_init(&attrs);
3526             pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
3527             errno = pthread_create(&the_thread, &attrs,
3528                (void * (*)(void *))serve, csp);
3529             child_id = errno ? -1 : 0;
3530             pthread_attr_destroy(&attrs);
3531          }
3532 #endif
3533
3534 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
3535 #define SELECTED_ONE_OPTION
3536          child_id = _beginthread(
3537             (void (*)(void *))serve,
3538             64 * 1024,
3539             csp);
3540 #endif
3541
3542 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
3543 #define SELECTED_ONE_OPTION
3544          child_id = _beginthread(
3545             (void(* _Optlink)(void*))serve,
3546             NULL,
3547             64 * 1024,
3548             csp);
3549 #endif
3550
3551 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
3552 #define SELECTED_ONE_OPTION
3553          {
3554             thread_id tid = spawn_thread
3555                (server_thread, "server", B_NORMAL_PRIORITY, csp);
3556
3557             if ((tid >= 0) && (resume_thread(tid) == B_OK))
3558             {
3559                child_id = (int) tid;
3560             }
3561             else
3562             {
3563                child_id = -1;
3564             }
3565          }
3566 #endif
3567
3568 #if defined(AMIGA) && !defined(SELECTED_ONE_OPTION)
3569 #define SELECTED_ONE_OPTION
3570          csp->cfd = ReleaseSocket(csp->cfd, -1);
3571          
3572 #ifdef __amigaos4__
3573          child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
3574                                            NP_Output, Output(),
3575                                            NP_CloseOutput, FALSE,
3576                                            NP_Name, (ULONG)"privoxy child",
3577                                            NP_Child, TRUE,
3578                                            TAG_DONE);
3579 #else
3580          child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
3581                                            NP_Output, Output(),
3582                                            NP_CloseOutput, FALSE,
3583                                            NP_Name, (ULONG)"privoxy child",
3584                                            NP_StackSize, 200*1024,
3585                                            TAG_DONE);
3586 #endif
3587          if(0 != child_id)
3588          {
3589             childs++;
3590             ((struct Task *)child_id)->tc_UserData = csp;
3591             Signal((struct Task *)child_id, SIGF_SINGLE);
3592             Wait(SIGF_SINGLE);
3593          }
3594 #endif
3595
3596 #if !defined(SELECTED_ONE_OPTION)
3597          child_id = fork();
3598
3599          /* This block is only needed when using fork().
3600           * When using threads, the server thread was
3601           * created and run by the call to _beginthread().
3602           */
3603          if (child_id == 0)   /* child */
3604          {
3605             int rc = 0;
3606 #ifdef FEATURE_TOGGLE
3607             int inherited_toggle_state = global_toggle_state;
3608 #endif /* def FEATURE_TOGGLE */
3609
3610             serve(csp);
3611
3612             /* 
3613              * If we've been toggled or we've blocked the request, tell Mom
3614              */
3615
3616 #ifdef FEATURE_TOGGLE
3617             if (inherited_toggle_state != global_toggle_state)
3618             {
3619                rc |= RC_FLAG_TOGGLED;
3620             }
3621 #endif /* def FEATURE_TOGGLE */
3622
3623 #ifdef FEATURE_STATISTICS  
3624             if (csp->flags & CSP_FLAG_REJECTED)
3625             {
3626                rc |= RC_FLAG_BLOCKED;
3627             }
3628 #endif /* ndef FEATURE_STATISTICS */
3629
3630             _exit(rc);
3631          }
3632          else if (child_id > 0) /* parent */
3633          {
3634             /* in a fork()'d environment, the parent's
3635              * copy of the client socket and the CSP
3636              * are not used.
3637              */
3638             int child_status;
3639 #if !defined(_WIN32) && !defined(__CYGWIN__)
3640
3641             wait( &child_status );
3642
3643             /* 
3644              * Evaluate child's return code: If the child has
3645              *  - been toggled, toggle ourselves
3646              *  - blocked its request, bump up the stats counter
3647              */
3648
3649 #ifdef FEATURE_TOGGLE
3650             if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
3651             {
3652                global_toggle_state = !global_toggle_state;
3653             }
3654 #endif /* def FEATURE_TOGGLE */
3655
3656 #ifdef FEATURE_STATISTICS
3657             urls_read++;
3658             if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
3659             {
3660                urls_rejected++;
3661             }
3662 #endif /* def FEATURE_STATISTICS */ 
3663
3664 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
3665             close_socket(csp->cfd);
3666             csp->flags &= ~CSP_FLAG_ACTIVE;
3667          }
3668 #endif
3669
3670 #undef SELECTED_ONE_OPTION
3671 /* end of cpp switch () */
3672
3673          if (child_id < 0)
3674          {
3675             /*
3676              * Spawning the child failed, assume it's because
3677              * there are too many children running already.
3678              * XXX: If you assume ...
3679              */
3680             log_error(LOG_LEVEL_ERROR,
3681                "Unable to take any additional connections: %E");
3682             write_socket(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
3683                strlen(TOO_MANY_CONNECTIONS_RESPONSE));
3684             close_socket(csp->cfd);
3685             csp->flags &= ~CSP_FLAG_ACTIVE;
3686          }
3687       }
3688       else
3689       {
3690          serve(csp);
3691       }
3692    }
3693
3694    /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
3695
3696    /* Clean up.  Aim: free all memory (no leaks) */
3697 #ifdef FEATURE_GRACEFUL_TERMINATION
3698
3699    log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
3700
3701    unload_current_config_file();
3702    unload_current_actions_file();
3703    unload_current_re_filterfile();
3704 #ifdef FEATURE_TRUST
3705    unload_current_trust_file();
3706 #endif
3707
3708    if (config->multi_threaded)
3709    {
3710       int i = 60;
3711       do
3712       {
3713          sleep(1);
3714          sweep();
3715       } while ((clients->next != NULL) && (--i > 0));
3716
3717       if (i <= 0)
3718       {
3719          log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
3720       }
3721    }
3722    sweep();
3723    sweep();
3724
3725 #if defined(unix)
3726    freez(basedir);
3727 #endif
3728    freez(configfile);
3729
3730 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
3731    /* Cleanup - remove taskbar icon etc. */
3732    TermLogWindow();
3733 #endif
3734
3735    exit(0);
3736 #endif /* FEATURE_GRACEFUL_TERMINATION */
3737
3738 }
3739
3740
3741 /*
3742   Local Variables:
3743   tab-width: 3
3744   end:
3745 */