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