jcc.c

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