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