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