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