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