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