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