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