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