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