project.h

   1 #ifndef PROJECT_H_INCLUDED
   2 #define PROJECT_H_INCLUDED
   3 /** Version string. */
   4 #define PROJECT_H_VERSION "$Id: project.h,v 1.164 2011/04/19 13:00:47 fabiankeil Exp $"
   5 /*********************************************************************
   6  *
   7  * File        :  $Source: /cvsroot/ijbswa/current/project.h,v $
   8  *
   9  * Purpose     :  Defines data structures which are widely used in the
  10  *                project.  Does not define any variables or functions
  11  *                (though it does declare some macros).
  12  *
  13  * Copyright   :  Written by and Copyright (C) 2001-2010 the
  14  *                Privoxy team. http://www.privoxy.org/
  15  *
  16  *                Based on the Internet Junkbuster originally written
  17  *                by and Copyright (C) 1997 Anonymous Coders and
  18  *                Junkbusters Corporation.  http://www.junkbusters.com
  19  *
  20  *                This program is free software; you can redistribute it
  21  *                and/or modify it under the terms of the GNU General
  22  *                Public License as published by the Free Software
  23  *                Foundation; either version 2 of the License, or (at
  24  *                your option) any later version.
  25  *
  26  *                This program is distributed in the hope that it will
  27  *                be useful, but WITHOUT ANY WARRANTY; without even the
  28  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  29  *                PARTICULAR PURPOSE.  See the GNU General Public
  30  *                License for more details.
  31  *
  32  *                The GNU General Public License should be included with
  33  *                this file.  If not, you can view it at
  34  *                http://www.gnu.org/copyleft/gpl.html
  35  *                or write to the Free Software Foundation, Inc., 59
  36  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  37  *
  38  *********************************************************************/
  39
  40
  41 /* Declare struct FILE for vars and funcs. */
  42 #include <stdio.h>
  43
  44 /* Need time_t for file_list */
  45 #include <time.h>
  46 /* Needed for pcre choice */
  47 #include "config.h"
  48
  49 /* Need for struct sockaddr_storage */
  50 #ifdef HAVE_RFC2553
  51 #  ifndef _WIN32
  52 #    include <netdb.h>
  53 #    include <sys/socket.h>
  54 #  else
  55 #    include <stdint.h>
  56 #    include <winsock2.h>
  57 #    include <ws2tcpip.h>
  58      typedef unsigned short in_port_t;
  59 #  endif
  60 #endif
  61
  62
  63 /*
  64  * Include appropriate regular expression libraries.
  65  * Note that pcrs and pcre (native) are needed for cgi
  66  * and are included anyway.
  67  */
  68
  69 #ifdef STATIC_PCRE
  70 #  include "pcre.h"
  71 #else
  72 #  ifdef PCRE_H_IN_SUBDIR
  73 #    include <pcre/pcre.h>
  74 #  else
  75 #    include <pcre.h>
  76 #  endif
  77 #endif
  78
  79 #ifdef STATIC_PCRS
  80 #  include "pcrs.h"
  81 #else
  82 #  include <pcrs.h>
  83 #endif
  84
  85 #ifdef STATIC_PCRE
  86 #  include "pcreposix.h"
  87 #else
  88 #  ifdef PCRE_H_IN_SUBDIR
  89 #    include <pcre/pcreposix.h>
  90 #  else
  91 #    include <pcreposix.h>
  92 #  endif
  93 #endif
  94
  95 #ifdef AMIGA
  96 #include "amiga.h"
  97 #endif /* def AMIGA */
  98
  99 #ifdef _WIN32
 100 /*
 101  * I don't want to have to #include all this just for the declaration
 102  * of SOCKET.  However, it looks like we have to...
 103  */
 104 #ifndef STRICT
 105 #define STRICT
 106 #endif
 107 #include <windows.h>
 108 #endif
 109
 110
 111 #ifdef __cplusplus
 112 extern "C" {
 113 #endif
 114
 115 #ifdef _WIN32
 116
 117 typedef SOCKET jb_socket;
 118
 119 #define JB_INVALID_SOCKET INVALID_SOCKET
 120
 121 #else /* ndef _WIN32 */
 122
 123 /**
 124  * The type used by sockets.  On UNIX it's an int.  Microsoft decided to
 125  * make it an unsigned.
 126  */
 127 typedef int jb_socket;
 128
 129 /**
 130  * The error value used for variables of type jb_socket.  On UNIX this
 131  * is -1, however Microsoft decided to make socket handles unsigned, so
 132  * they use a different value.
 133  */
 134
 135 #define JB_INVALID_SOCKET (-1)
 136
 137 #endif /* ndef _WIN32 */
 138
 139
 140 /**
 141  * A standard error code.  This should be JB_ERR_OK or one of the JB_ERR_xxx
 142  * series of errors.
 143  */
 144 typedef int jb_err;
 145
 146 #define JB_ERR_OK         0 /**< Success, no error                        */
 147 #define JB_ERR_MEMORY     1 /**< Out of memory                            */
 148 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters        */
 149 #define JB_ERR_FILE       3 /**< Error opening, reading or writing a file */
 150 #define JB_ERR_PARSE      4 /**< Error parsing file                       */
 151 #define JB_ERR_MODIFIED   5 /**< File has been modified outside of the
 152                                  CGI actions editor.                      */
 153 #define JB_ERR_COMPRESS   6 /**< Error on decompression                   */
 154
 155 /**
 156  * This macro is used to free a pointer that may be NULL.
 157  * It also sets the variable to NULL after it's been freed.
 158  * The paramater should be a simple variable without side effects.
 159  */
 160 #define freez(X)  { if(X) { free((void*)X); X = NULL ; } }
 161
 162
 163 /**
 164  * Fix a problem with Solaris.  There should be no effect on other
 165  * platforms.
 166  *
 167  * Solaris's isspace() is a macro which uses it's argument directly
 168  * as an array index.  Therefore we need to make sure that high-bit
 169  * characters generate +ve values, and ideally we also want to make
 170  * the argument match the declared parameter type of "int".
 171  *
 172  * Note: Remember to #include <ctype.h> if you use these macros.
 173  */
 174 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
 175 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
 176 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
 177
 178 /**
 179  * Use for statically allocated buffers if you have no other choice.
 180  * Remember to check the length of what you write into the buffer
 181  * - we don't want any buffer overflows!
 182  */
 183 #define BUFFER_SIZE 5000
 184
 185 /**
 186  * Max length of CGI parameters (arbitrary limit).
 187  */
 188 #define CGI_PARAM_LEN_MAX 500U
 189
 190 /**
 191  * Minimum length which a buffer has to reach before
 192  * Privoxy bothers to (re-)compress it. Completely arbitrary.
 193  */
 194 #define LOWER_LENGTH_LIMIT_FOR_COMRPESSION 1024U
 195
 196 /**
 197  * Buffer size for capturing struct hostent data in the
 198  * gethostby(name|addr)_r library calls. Since we don't
 199  * loop over gethostbyname_r, the buffer must be sufficient
 200  * to accommodate multiple IN A RRs, as used in DNS round robin
 201  * load balancing. W3C's wwwlib uses 1K, so that should be
 202  * good enough for us, too.
 203  */
 204 /**
 205  * XXX: Temporary doubled, for some configurations
 206  * 1K is still too small and we didn't get the
 207  * real fix ready for inclusion.
 208  */
 209 #define HOSTENT_BUFFER_SIZE 2048
 210
 211 /**
 212  * Do not use.  Originally this was so that you can
 213  * say "while (FOREVER) { ...do something... }".
 214  * However, this gives a warning with some compilers (e.g. VC++).
 215  * Instead, use "for (;;) { ...do something... }".
 216  */
 217 #define FOREVER 1
 218
 219 /**
 220  * Default TCP/IP address to listen on, as a string.
 221  * Set to "127.0.0.1:8118".
 222  */
 223 #define HADDR_DEFAULT   "127.0.0.1:8118"
 224
 225
 226 /* Forward def for struct client_state */
 227 struct configuration_spec;
 228
 229
 230 /**
 231  * Entry in a linked list of strings.
 232  */
 233 struct list_entry
 234 {
 235    /**
 236     * The string pointer. It must point to a dynamically malloc()ed
 237     * string or be NULL for the list functions to work. In the latter
 238     * case, just be careful next time you iterate through the list in
 239     * your own code.
 240     */
 241    char *str;
 242
 243    /** Next entry in the linked list, or NULL if no more. */
 244    struct list_entry *next;
 245 };
 246
 247 /**
 248  * A header for a linked list of strings.
 249  */
 250 struct list
 251 {
 252    /** First entry in the list, or NULL if the list is empty. */
 253    struct list_entry *first;
 254
 255    /** Last entry in the list, or NULL if the list is empty. */
 256    struct list_entry *last;
 257 };
 258
 259
 260 /**
 261  * An entry in a map.  This is a name=value pair.
 262  */
 263 struct map_entry
 264 {
 265    /** The key for the map. */
 266    const char *name;
 267    /** The value associated with that key. */
 268    const char *value;
 269    /** The next map entry, or NULL if none. */
 270    struct map_entry *next;
 271 };
 272
 273 /**
 274  * A map from a string to another string.
 275  * This is used for the paramaters passed in a HTTP GET request, and
 276  * to store the exports when the CGI interface is filling in a template.
 277  */
 278 struct map
 279 {
 280    /** The first map entry, or NULL if the map is empty. */
 281    struct map_entry *first;
 282    /** The last map entry, or NULL if the map is empty. */
 283    struct map_entry *last;
 284 };
 285
 286
 287 /**
 288  * A HTTP request.  This includes the method (GET, POST) and
 289  * the parsed URL.
 290  *
 291  * This is also used whenever we want to match a URL against a
 292  * URL pattern.  This always contains the URL to match, and never
 293  * a URL pattern.  (See struct url_spec).
 294  */
 295 struct http_request
 296 {
 297    char *cmd;      /**< Whole command line: method, URL, Version */
 298    char *ocmd;     /**< Backup of original cmd for CLF logging */
 299    char *gpc;      /**< HTTP method: GET, POST, ... */
 300    char *url;      /**< The URL */
 301    char *ver;      /**< Protocol version */
 302    int status;     /**< HTTP Status */
 303
 304    char *host;     /**< Host part of URL */
 305    int   port;     /**< Port of URL or 80 (default) */
 306    char *path;     /**< Path of URL */
 307    char *hostport; /**< host[:port] */
 308    int   ssl;      /**< Flag if protocol is https */
 309
 310    char *host_ip_addr_str; /**< String with dotted decimal representation
 311                                 of host's IP. NULL before connect_to() */
 312
 313 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
 314    char  *dbuffer; /**< Buffer with '\0'-delimited domain name.           */
 315    char **dvec;    /**< List of pointers to the strings in dbuffer.       */
 316    int    dcount;  /**< How many parts to this domain? (length of dvec)   */
 317 #endif /* ndef FEATURE_EXTENDED_HOST_PATTERNS */
 318 };
 319
 320 /**
 321  * Reasons for generating a http_response instead of delivering
 322  * the requested resource. Mostly ordered the way they are checked
 323  * for in chat().
 324  */
 325 enum crunch_reason
 326 {
 327    UNSUPPORTED,
 328    BLOCKED,
 329    UNTRUSTED,
 330    REDIRECTED,
 331    CGI_CALL,
 332    NO_SUCH_DOMAIN,
 333    FORWARDING_FAILED,
 334    CONNECT_FAILED,
 335    OUT_OF_MEMORY,
 336    INTERNAL_ERROR,
 337    CONNECTION_TIMEOUT,
 338    NO_SERVER_DATA
 339 };
 340
 341 /**
 342  * Response generated by CGI, blocker, or error handler
 343  */
 344 struct http_response
 345 {
 346   enum crunch_reason crunch_reason; /**< Why the response was generated in the first place. */
 347   char  *status;                    /**< HTTP status (string). */
 348   struct list headers[1];           /**< List of header lines. */
 349   char  *head;                      /**< Formatted http response head. */
 350   size_t head_length;               /**< Length of http response head. */
 351   char  *body;                      /**< HTTP document body. */
 352   size_t content_length;            /**< Length of body, REQUIRED if binary body. */
 353   int    is_static;                 /**< Nonzero if the content will never change and
 354                                          should be cached by the browser (e.g. images). */
 355 };
 356
 357 /**
 358  * A URL or a tag pattern.
 359  */
 360 struct url_spec
 361 {
 362    /** The string which was parsed to produce this url_spec.
 363        Used for debugging or display only.  */
 364    char  *spec;
 365
 366 #ifdef FEATURE_EXTENDED_HOST_PATTERNS
 367    regex_t *host_regex;/**< Regex for host matching                          */
 368 #else
 369    char  *dbuffer;     /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
 370    char **dvec;        /**< List of pointers to the strings in dbuffer.       */
 371    int    dcount;      /**< How many parts to this domain? (length of dvec)   */
 372    int    unanchored;  /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT.  */
 373 #endif /* defined FEATURE_EXTENDED_HOST_PATTERNS */
 374
 375    char  *port_list;   /**< List of acceptable ports, or NULL to match all ports */
 376
 377    regex_t *preg;      /**< Regex for matching path part                      */
 378    regex_t *tag_regex; /**< Regex for matching tags                           */
 379 };
 380
 381 /**
 382  * If you declare a static url_spec, this is the value to initialize it to zero.
 383  */
 384 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
 385 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, NULL, NULL, NULL }
 386 #else
 387 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, NULL }
 388 #endif /* def FEATURE_EXTENDED_HOST_PATTERNS */
 389
 390 /**
 391  * Constant for host part matching in URLs.  If set, indicates that the start of
 392  * the pattern must match the start of the URL.  E.g. this is not set for the
 393  * pattern ".example.com", so that it will match both "example.com" and
 394  * "www.example.com".  It is set for the pattern "example.com", which makes it
 395  * match "example.com" only, not "www.example.com".
 396  */
 397 #define ANCHOR_LEFT  1
 398
 399 /**
 400  * Constant for host part matching in URLs.  If set, indicates that the end of
 401  * the pattern must match the end of the URL.  E.g. this is not set for the
 402  * pattern "ad.", so that it will match any host called "ad", irrespective
 403  * of how many subdomains are in the fully-qualified domain name.
 404  */
 405 #define ANCHOR_RIGHT 2
 406
 407
 408 /**
 409  * An I/O buffer.  Holds a string which can be appended to, and can have data
 410  * removed from the beginning.
 411  */
 412 struct iob
 413 {
 414    char *buf;    /**< Start of buffer        */
 415    char *cur;    /**< Start of relevant data */
 416    char *eod;    /**< End of relevant data   */
 417    size_t size;  /**< Size as malloc()ed     */
 418 };
 419
 420
 421 /**
 422  * Return the number of bytes in the I/O buffer associated with the passed
 423  * client_state pointer.
 424  * May be zero.
 425  */
 426 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
 427
 428
 429 /**
 430  * Remove any data in the I/O buffer associated with the passed
 431  * client_state pointer.
 432  */
 433 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
 434
 435 /* Bits for csp->content_type bitmask: */
 436 #define CT_TEXT    0x0001U /**< Suitable for pcrs filtering. */
 437 #define CT_GIF     0x0002U /**< Suitable for GIF filtering.  */
 438 #define CT_TABOO   0x0004U /**< DO NOT filter, irrespective of other flags. */
 439
 440 /* Although these are not, strictly speaking, content types
 441  * (they are content encodings), it is simple to handle them
 442  * as such.
 443  */
 444 #define CT_GZIP    0x0010U /**< gzip-compressed data. */
 445 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
 446
 447 /**
 448  * Flag to signal that the server declared the content type,
 449  * so we can differentiate between unknown and undeclared
 450  * content types.
 451  */
 452 #define CT_DECLARED 0x0040U
 453
 454 /**
 455  * The mask which includes all actions.
 456  */
 457 #define ACTION_MASK_ALL        (~0UL)
 458
 459 /**
 460  * The most compatible set of actions - i.e. none.
 461  */
 462 #define ACTION_MOST_COMPATIBLE                       0x00000000UL
 463
 464 /** Action bitmap: Block the request. */
 465 #define ACTION_BLOCK                                 0x00000001UL
 466 /** Action bitmap: Deanimate if it's a GIF. */
 467 #define ACTION_DEANIMATE                             0x00000002UL
 468 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
 469 #define ACTION_DOWNGRADE                             0x00000004UL
 470 /** Action bitmap: Fast redirects. */
 471 #define ACTION_FAST_REDIRECTS                        0x00000008UL
 472 /** Action bitmap: Remove or add "X-Forwarded-For" header. */
 473 #define ACTION_CHANGE_X_FORWARDED_FOR                0x00000010UL
 474 /** Action bitmap: Hide "From" header. */
 475 #define ACTION_HIDE_FROM                             0x00000020UL
 476 /** Action bitmap: Hide "Referer" header.  (sic - follow HTTP, not English). */
 477 #define ACTION_HIDE_REFERER                          0x00000040UL
 478 /** Action bitmap: Hide "User-Agent" and similar headers. */
 479 #define ACTION_HIDE_USER_AGENT                       0x00000080UL
 480 /** Action bitmap: This is an image. */
 481 #define ACTION_IMAGE                                 0x00000100UL
 482 /** Action bitmap: Sets the image blocker. */
 483 #define ACTION_IMAGE_BLOCKER                         0x00000200UL
 484 /** Action bitmap: Prevent compression. */
 485 #define ACTION_NO_COMPRESSION                        0x00000400UL
 486 /** Action bitmap: Change cookies to session only cookies. */
 487 #define ACTION_NO_COOKIE_KEEP                        0x00000800UL
 488 /** Action bitmap: Block rending cookies. */
 489 #define ACTION_NO_COOKIE_READ                        0x00001000UL
 490 /** Action bitmap: Block setting cookies. */
 491 #define ACTION_NO_COOKIE_SET                         0x00002000UL
 492 /** Action bitmap: Override the forward settings in the config file */
 493 #define ACTION_FORWARD_OVERRIDE                      0x00004000UL
 494 /** Action bitmap: Block as empty document */
 495 #define  ACTION_HANDLE_AS_EMPTY_DOCUMENT             0x00008000UL
 496 /** Action bitmap: Limit CONNECT requests to safe ports. */
 497 #define ACTION_LIMIT_CONNECT                         0x00010000UL
 498 /** Action bitmap: Redirect request. */
 499 #define  ACTION_REDIRECT                             0x00020000UL
 500 /** Action bitmap: Crunch or modify "if-modified-since" header. */
 501 #define ACTION_HIDE_IF_MODIFIED_SINCE                0x00040000UL
 502 /** Action bitmap: Overwrite Content-Type header. */
 503 #define ACTION_CONTENT_TYPE_OVERWRITE                0x00080000UL
 504 /** Action bitmap: Crunch specified server header. */
 505 #define ACTION_CRUNCH_SERVER_HEADER                  0x00100000UL
 506 /** Action bitmap: Crunch specified client header */
 507 #define ACTION_CRUNCH_CLIENT_HEADER                  0x00200000UL
 508 /** Action bitmap: Enable text mode by force */
 509 #define ACTION_FORCE_TEXT_MODE                       0x00400000UL
 510 /** Action bitmap: Enable text mode by force */
 511 #define ACTION_CRUNCH_IF_NONE_MATCH                  0x00800000UL
 512 /** Action bitmap: Enable content-disposition crunching */
 513 #define ACTION_HIDE_CONTENT_DISPOSITION              0x01000000UL
 514 /** Action bitmap: Replace or block Last-Modified header */
 515 #define ACTION_OVERWRITE_LAST_MODIFIED               0x02000000UL
 516 /** Action bitmap: Replace or block Accept-Language header */
 517 #define ACTION_HIDE_ACCEPT_LANGUAGE                  0x04000000UL
 518
 519
 520 /** Action string index: How to deanimate GIFs */
 521 #define ACTION_STRING_DEANIMATE             0
 522 /** Action string index: Replacement for "From:" header */
 523 #define ACTION_STRING_FROM                  1
 524 /** Action string index: How to block images */
 525 #define ACTION_STRING_IMAGE_BLOCKER         2
 526 /** Action string index: Replacement for "Referer:" header */
 527 #define ACTION_STRING_REFERER               3
 528 /** Action string index: Replacement for "User-Agent:" header */
 529 #define ACTION_STRING_USER_AGENT            4
 530 /** Action string index: Legal CONNECT ports. */
 531 #define ACTION_STRING_LIMIT_CONNECT         5
 532 /** Action string index: Server headers containing this pattern are crunched*/
 533 #define ACTION_STRING_SERVER_HEADER         6
 534 /** Action string index: Client headers containing this pattern are crunched*/
 535 #define ACTION_STRING_CLIENT_HEADER         7
 536 /** Action string index: Replacement for the "Accept-Language:" header*/
 537 #define ACTION_STRING_LANGUAGE              8
 538 /** Action string index: Replacement for the "Content-Type:" header*/
 539 #define ACTION_STRING_CONTENT_TYPE          9
 540 /** Action string index: Replacement for the "content-disposition:" header*/
 541 #define ACTION_STRING_CONTENT_DISPOSITION  10
 542 /** Action string index: Replacement for the "If-Modified-Since:" header*/
 543 #define ACTION_STRING_IF_MODIFIED_SINCE    11
 544 /** Action string index: Replacement for the "Last-Modified:" header. */
 545 #define ACTION_STRING_LAST_MODIFIED        12
 546 /** Action string index: Redirect URL */
 547 #define ACTION_STRING_REDIRECT             13
 548 /** Action string index: Decode before redirect? */
 549 #define ACTION_STRING_FAST_REDIRECTS       14
 550 /** Action string index: Overriding forward rule. */
 551 #define ACTION_STRING_FORWARD_OVERRIDE     15
 552 /** Action string index: Reason for the block. */
 553 #define ACTION_STRING_BLOCK                16
 554 /** Action string index: what to do with the "X-Forwarded-For" header. */
 555 #define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17
 556 /** Number of string actions. */
 557 #define ACTION_STRING_COUNT                18
 558
 559
 560 /* To make the ugly hack in sed easier to understand */
 561 #define CHECK_EVERY_HEADER_REMAINING 0
 562
 563
 564 /** Index into current_action_spec::multi[] for headers to add. */
 565 #define ACTION_MULTI_ADD_HEADER              0
 566 /** Index into current_action_spec::multi[] for content filters to apply. */
 567 #define ACTION_MULTI_FILTER                  1
 568 /** Index into current_action_spec::multi[] for server-header filters to apply. */
 569 #define ACTION_MULTI_SERVER_HEADER_FILTER    2
 570 /** Index into current_action_spec::multi[] for client-header filters to apply. */
 571 #define ACTION_MULTI_CLIENT_HEADER_FILTER    3
 572 /** Index into current_action_spec::multi[] for client-header tags to apply. */
 573 #define ACTION_MULTI_CLIENT_HEADER_TAGGER    4
 574 /** Index into current_action_spec::multi[] for server-header tags to apply. */
 575 #define ACTION_MULTI_SERVER_HEADER_TAGGER    5
 576 /** Number of multi-string actions. */
 577 #define ACTION_MULTI_COUNT                   6
 578
 579
 580 /**
 581  * This structure contains a list of actions to apply to a URL.
 582  * It only contains positive instructions - no "-" options.
 583  * It is not used to store the actions list itself, only for
 584  * url_actions() to return the current values.
 585  */
 586 struct current_action_spec
 587 {
 588    /** Actions to apply.  A bit set to "1" means perform the action. */
 589    unsigned long flags;
 590
 591    /**
 592     * Paramaters for those actions that require them.
 593     * Each entry is valid if & only if the corresponding entry in "flags" is
 594     * set.
 595     */
 596    char * string[ACTION_STRING_COUNT];
 597
 598    /** Lists of strings for multi-string actions. */
 599    struct list multi[ACTION_MULTI_COUNT][1];
 600 };
 601
 602
 603 /**
 604  * This structure contains a set of changes to actions.
 605  * It can contain both positive and negative instructions.
 606  * It is used to store an entry in the actions list.
 607  */
 608 struct action_spec
 609 {
 610    unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
 611    unsigned long add;  /**< Actions to add.  A bit set to "1" means add action.    */
 612
 613    /**
 614     * Paramaters for those actions that require them.
 615     * Each entry is valid if & only if the corresponding entry in "flags" is
 616     * set.
 617     */
 618    char * string[ACTION_STRING_COUNT];
 619
 620    /** Lists of strings to remove, for multi-string actions. */
 621    struct list multi_remove[ACTION_MULTI_COUNT][1];
 622
 623    /** If nonzero, remove *all* strings from the multi-string action. */
 624    int         multi_remove_all[ACTION_MULTI_COUNT];
 625
 626    /** Lists of strings to add, for multi-string actions. */
 627    struct list multi_add[ACTION_MULTI_COUNT][1];
 628 };
 629
 630
 631 /**
 632  * This structure is used to store action files.
 633  *
 634  * It contains an URL or tag pattern, and the changes to
 635  * the actions. It's a linked list and should only be
 636  * free'd through unload_actions_file() unless there's
 637  * only a single entry.
 638  */
 639 struct url_actions
 640 {
 641    struct url_spec url[1];     /**< The URL or tag pattern. */
 642
 643    struct action_spec *action; /**< Action settings that might be shared with
 644                                     the list entry before or after the current
 645                                     one and can't be free'd willy nilly. */
 646
 647    struct url_actions *next;   /**< Next action section in file, or NULL. */
 648 };
 649
 650
 651 /*
 652  * Structure to hold the server socket and the information
 653  * required to make sure we only reuse the connection if
 654  * the host and forwarding settings are the same.
 655  */
 656 struct reusable_connection
 657 {
 658    jb_socket sfd;
 659    int       in_use;
 660    time_t    timestamp; /* XXX: rename? */
 661
 662    time_t    request_sent;
 663    time_t    response_received;
 664
 665    /*
 666     * Number of seconds after which this
 667     * connection will no longer be reused.
 668     */
 669    unsigned int keep_alive_timeout;
 670
 671    char *host;
 672    int  port;
 673    int  forwarder_type;
 674    char *gateway_host;
 675    int  gateway_port;
 676    char *forward_host;
 677    int  forward_port;
 678 };
 679
 680
 681 /*
 682  * Flags for use in csp->flags
 683  */
 684
 685 /**
 686  * Flag for csp->flags: Set if this client is processing data.
 687  * Cleared when the thread associated with this structure dies.
 688  */
 689 #define CSP_FLAG_ACTIVE     0x01U
 690
 691 /**
 692  * Flag for csp->flags: Set if the server's reply is in "chunked"
 693  * transfer encoding
 694  */
 695 #define CSP_FLAG_CHUNKED    0x02U
 696
 697 /**
 698  * Flag for csp->flags: Set if this request was enforced, although it would
 699  * normally have been blocked.
 700  */
 701 #define CSP_FLAG_FORCED     0x04U
 702
 703 /**
 704  * Flag for csp->flags: Set if any modification to the body was done.
 705  */
 706 #define CSP_FLAG_MODIFIED   0x08U
 707
 708 /**
 709  * Flag for csp->flags: Set if request was blocked.
 710  */
 711 #define CSP_FLAG_REJECTED   0x10U
 712
 713 /**
 714  * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
 715  */
 716 #define CSP_FLAG_TOGGLED_ON 0x20U
 717
 718 /**
 719  * Flag for csp->flags: Set if we answered the request ourselve.
 720  */
 721 #define CSP_FLAG_CRUNCHED   0x40U
 722
 723 /**
 724  * Flag for csp->flags: Set if an acceptable Connection header
 725  * has already been set by the client.
 726  */
 727 #define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET  0x00000040U
 728
 729 /**
 730  * Flag for csp->flags: Set if an acceptable Connection header
 731  * has already been set by the server.
 732  */
 733 #define CSP_FLAG_SERVER_CONNECTION_HEADER_SET  0x00000080U
 734
 735 /**
 736  * Flag for csp->flags: Signals header parsers whether they
 737  * are parsing server or client headers.
 738  */
 739 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE    0x00000100U
 740
 741 /**
 742  * Flag for csp->flags: Set if adding the Host: header
 743  * isn't necessary.
 744  */
 745 #define CSP_FLAG_HOST_HEADER_IS_SET            0x00000200U
 746
 747 /**
 748  * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
 749  * XXX: As we now have tags we might as well ditch this.
 750  */
 751 #define CSP_FLAG_NO_FILTERING                  0x00000400U
 752
 753 /**
 754  * Flag for csp->flags: Set the client IP has appended to
 755  * an already existing X-Forwarded-For header in which case
 756  * no new header has to be generated.
 757  */
 758 #define CSP_FLAG_X_FORWARDED_FOR_APPENDED      0x00000800U
 759
 760 /**
 761  * Flag for csp->flags: Set if the server wants to keep
 762  * the connection alive.
 763  */
 764 #define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE  0x00001000U
 765
 766 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
 767 /**
 768  * Flag for csp->flags: Set if the server specified the
 769  * content length.
 770  */
 771 #define CSP_FLAG_SERVER_CONTENT_LENGTH_SET     0x00002000U
 772
 773 /**
 774  * Flag for csp->flags: Set if we know the content length,
 775  * either because the server set it, or we figured it out
 776  * on our own.
 777  */
 778 #define CSP_FLAG_CONTENT_LENGTH_SET            0x00004000U
 779
 780 /**
 781  * Flag for csp->flags: Set if the client wants to keep
 782  * the connection alive.
 783  */
 784 #define CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE  0x00008000U
 785
 786 /**
 787  * Flag for csp->flags: Set if we think we got the whole
 788  * client request and shouldn't read any additional data
 789  * coming from the client until the current request has
 790  * been dealt with.
 791  */
 792 #define CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ 0x00010000U
 793
 794 /**
 795  * Flag for csp->flags: Set if the server promised us to
 796  * keep the connection open for a known number of seconds.
 797  */
 798 #define CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET  0x00020000U
 799
 800 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
 801
 802 /**
 803  * Flag for csp->flags: Set if we think we can't reuse
 804  * the server socket.
 805  */
 806 #define CSP_FLAG_SERVER_SOCKET_TAINTED          0x00040000U
 807
 808 /**
 809  * Flag for csp->flags: Set if the Proxy-Connection header
 810  * is among the server headers.
 811  */
 812 #define CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET 0x00080000U
 813
 814 /**
 815  * Flag for csp->flags: Set if the client reused its connection.
 816  */
 817 #define CSP_FLAG_REUSED_CLIENT_CONNECTION           0x00100000U
 818
 819 /**
 820  * Flag for csp->flags: Set if the supports deflate compression.
 821  */
 822 #define CSP_FLAG_CLIENT_SUPPORTS_DEFLATE            0x00200000U
 823
 824 /**
 825  * Flag for csp->flags: Set if the content has been deflated by Privoxy
 826  */
 827 #define CSP_FLAG_BUFFERED_CONTENT_DEFLATED          0x00400000U
 828
 829
 830 /*
 831  * Flags for use in return codes of child processes
 832  */
 833
 834 /**
 835  * Flag for process return code: Set if exiting porcess has been toggled
 836  * during its lifetime.
 837  */
 838 #define RC_FLAG_TOGGLED   0x10
 839
 840 /**
 841  * Flag for process return code: Set if exiting porcess has blocked its
 842  * request.
 843  */
 844 #define RC_FLAG_BLOCKED   0x20
 845
 846 /**
 847  * Maximum number of actions/filter files.  This limit is arbitrary - it's just used
 848  * to size an array.
 849  */
 850 #define MAX_AF_FILES 10
 851
 852 /**
 853  * The state of a Privoxy processing thread.
 854  */
 855 struct client_state
 856 {
 857    /** The proxy's configuration */
 858    struct configuration_spec * config;
 859
 860    /** The actions to perform on the current request */
 861    struct current_action_spec  action[1];
 862
 863    /** socket to talk to client (web browser) */
 864    jb_socket cfd;
 865
 866    /** current connection to the server (may go through a proxy) */
 867    struct reusable_connection server_connection;
 868
 869    /** Multi-purpose flag container, see CSP_FLAG_* above */
 870    unsigned int flags;
 871
 872    /** Client PC's IP address, as reported by the accept() function.
 873        As a string. */
 874    char *ip_addr_str;
 875 #ifdef HAVE_RFC2553
 876    /** Client PC's TCP address, as reported by the accept() function.
 877        As a sockaddr. */
 878    struct sockaddr_storage tcp_addr;
 879 #else
 880    /** Client PC's IP address, as reported by the accept() function.
 881        As a number. */
 882    unsigned long ip_addr_long;
 883 #endif /* def HAVE_RFC2553 */
 884
 885    /** The URL that was requested */
 886    struct http_request http[1];
 887
 888    /*
 889     * The final forwarding settings.
 890     * XXX: Currently this is only used for forward-override,
 891     * so we can free the space in sweep.
 892     */
 893    struct forward_spec * fwd;
 894
 895    /** An I/O buffer used for buffering data read from the network */
 896    struct iob iob[1];
 897
 898    /** List of all headers for this request */
 899    struct list headers[1];
 900
 901    /** List of all tags that apply to this request */
 902    struct list tags[1];
 903
 904    /** MIME-Type key, see CT_* above */
 905    unsigned int content_type;
 906
 907    /** Actions files associated with this client */
 908    struct file_list *actions_list[MAX_AF_FILES];
 909
 910    /** pcrs job files. */
 911    struct file_list *rlist[MAX_AF_FILES];
 912
 913    /** Length after content modification. */
 914    unsigned long long content_length;
 915
 916 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
 917    /* XXX: is this the right location? */
 918
 919    /** Expected length of content after which we
 920     * should stop reading from the server socket.
 921     */
 922    unsigned long long expected_content_length;
 923
 924    /** Expected length of content after which we
 925     *  should stop reading from the client socket.
 926     */
 927    unsigned long long expected_client_content_length;
 928 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
 929
 930 #ifdef FEATURE_TRUST
 931
 932    /** Trust file. */
 933    struct file_list *tlist;
 934
 935 #endif /* def FEATURE_TRUST */
 936
 937    /**
 938     * Failure reason to embedded in the CGI error page,
 939     * or NULL. Currently only used for socks errors.
 940     */
 941    char *error_message;
 942 };
 943
 944 /**
 945  * List of client states so the main thread can keep
 946  * track of them and garbage collect their resources.
 947  */
 948 struct client_states
 949 {
 950    struct client_states *next;
 951    struct client_state csp;
 952 };
 953
 954 /**
 955  * A function to add a header
 956  */
 957 typedef jb_err (*add_header_func_ptr)(struct client_state *);
 958
 959 /**
 960  * A function to process a header
 961  */
 962 typedef jb_err (*parser_func_ptr    )(struct client_state *, char **);
 963
 964
 965 /**
 966  * List of available CGI functions.
 967  */
 968 struct cgi_dispatcher
 969 {
 970    /** The URL of the CGI, relative to the CGI root. */
 971    const char * const name;
 972
 973    /** The handler function for the CGI */
 974    jb_err    (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
 975
 976    /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
 977    const char * const description;
 978
 979    /** A flag that indicates whether unintentional calls to this CGI can cause damage */
 980    int harmless;
 981 };
 982
 983
 984 /**
 985  * A data file used by Privoxy.  Kept in a linked list.
 986  */
 987 struct file_list
 988 {
 989    /**
 990     * This is a pointer to the data structures associated with the file.
 991     * Read-only once the structure has been created.
 992     */
 993    void *f;
 994
 995    /**
 996     * The unloader function.
 997     * Normally NULL.  When we are finished with file (i.e. when we have
 998     * loaded a new one), set to a pointer to an unloader function.
 999     * Unloader will be called by sweep() (called from main loop) when
1000     * all clients using this file are done.  This prevents threading
1001     * problems.
1002     */
1003    void (*unloader)(void *);
1004
1005    /**
1006     * Used internally by sweep().  Do not access from elsewhere.
1007     */
1008    int active;
1009
1010    /**
1011     * File last-modified time, so we can check if file has been changed.
1012     * Read-only once the structure has been created.
1013     */
1014    time_t lastmodified;
1015
1016    /**
1017     * The full filename.
1018     */
1019    char * filename;
1020
1021    /**
1022     * Pointer to next entry in the linked list of all "file_list"s.
1023     * This linked list is so that sweep() can navigate it.
1024     * Since sweep() can remove items from the list, we must be careful
1025     * to only access this value from main thread (when we know sweep
1026     * won't be running).
1027     */
1028    struct file_list *next;
1029 };
1030
1031
1032 #ifdef FEATURE_TRUST
1033
1034 /**
1035  * The format of a trust file when loaded into memory.
1036  */
1037 struct block_spec
1038 {
1039    struct url_spec url[1];   /**< The URL pattern              */
1040    int    reject;            /**< FIXME: Please document this! */
1041    struct block_spec *next;  /**< Next entry in linked list    */
1042 };
1043
1044 /**
1045  * Arbitrary limit for the number of trusted referrers.
1046  */
1047 #define MAX_TRUSTED_REFERRERS 512
1048
1049 #endif /* def FEATURE_TRUST */
1050
1051 enum forwarder_type {
1052    /**< Don't use a SOCKS server               */
1053    SOCKS_NONE =  0,
1054    /**< original SOCKS 4 protocol              */
1055    SOCKS_4    = 40,
1056    /**< SOCKS 4A, DNS resolution is done by the SOCKS server */
1057    SOCKS_4A   = 41,
1058    /**< SOCKS 5 with hostnames, DNS resolution is done by the SOCKS server */
1059    SOCKS_5    = 50,
1060 };
1061
1062 /**
1063  * How to forward a connection to a parent proxy.
1064  */
1065 struct forward_spec
1066 {
1067    /** URL pattern that this forward_spec is for. */
1068    struct url_spec url[1];
1069
1070    /** Connection type.  Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1071    enum forwarder_type type;
1072
1073    /** SOCKS server hostname.  Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1074    char *gateway_host;
1075
1076    /** SOCKS server port. */
1077    int   gateway_port;
1078
1079    /** Parent HTTP proxy hostname, or NULL for none. */
1080    char *forward_host;
1081
1082    /** Parent HTTP proxy port. */
1083    int   forward_port;
1084
1085    /** Next entry in the linked list. */
1086    struct forward_spec *next;
1087 };
1088
1089
1090 /**
1091  * Initializer for a static struct forward_spec.
1092  */
1093 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1094
1095 /* Supported filter types */
1096 enum filter_type
1097 {
1098    FT_CONTENT_FILTER       = 0,
1099    FT_CLIENT_HEADER_FILTER = 1,
1100    FT_SERVER_HEADER_FILTER = 2,
1101    FT_CLIENT_HEADER_TAGGER = 3,
1102    FT_SERVER_HEADER_TAGGER = 4,
1103 };
1104 #define MAX_FILTER_TYPES        5
1105
1106 /**
1107  * This struct represents one filter (one block) from
1108  * the re_filterfile. If there is more than one filter
1109  * in the file, the file will be represented by a
1110  * chained list of re_filterfile specs.
1111  */
1112 struct re_filterfile_spec
1113 {
1114    char *name;                      /**< Name from FILTER: statement in re_filterfile. */
1115    char *description;               /**< Description from FILTER: statement in re_filterfile. */
1116    struct list patterns[1];         /**< The patterns from the re_filterfile. */
1117    pcrs_job *joblist;               /**< The resulting compiled pcrs_jobs. */
1118    enum filter_type type;           /**< Filter type (content, client-header, server-header). */
1119    int dynamic;                     /**< Set to one if the pattern might contain variables
1120                                          and has to be recompiled for every request. */
1121    struct re_filterfile_spec *next; /**< The pointer for chaining. */
1122 };
1123
1124
1125 #ifdef FEATURE_ACL
1126
1127 #define ACL_PERMIT   1  /**< Accept connection request */
1128 #define ACL_DENY     2  /**< Reject connection request */
1129
1130 /**
1131  * An IP address pattern.  Used to specify networks in the ACL.
1132  */
1133 struct access_control_addr
1134 {
1135 #ifdef HAVE_RFC2553
1136    struct sockaddr_storage addr; /* <The TCP address in network order. */
1137    struct sockaddr_storage mask; /* <The TCP mask in network order. */
1138 #else
1139    unsigned long addr;  /**< The IP address as an integer. */
1140    unsigned long mask;  /**< The network mask as an integer. */
1141    unsigned long port;  /**< The port number. */
1142 #endif /* HAVE_RFC2553 */
1143 };
1144
1145 /**
1146  * An access control list (ACL) entry.
1147  *
1148  * This is a linked list.
1149  */
1150 struct access_control_list
1151 {
1152    struct access_control_addr src[1];  /**< Client IP address */
1153    struct access_control_addr dst[1];  /**< Website or parent proxy IP address */
1154 #ifdef HAVE_RFC2553
1155    int wildcard_dst;                   /** < dst address is wildcard */
1156 #endif
1157
1158    short action;                       /**< ACL_PERMIT or ACL_DENY */
1159    struct access_control_list *next;   /**< The next entry in the ACL. */
1160 };
1161
1162 #endif /* def FEATURE_ACL */
1163
1164
1165 /** Maximum number of loaders (actions, re_filter, ...) */
1166 #define NLOADERS 8
1167
1168
1169 /** configuration_spec::feature_flags: CGI actions editor. */
1170 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS             1U
1171
1172 /** configuration_spec::feature_flags: Web-based toggle. */
1173 #define RUNTIME_FEATURE_CGI_TOGGLE                   2U
1174
1175 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1176 #define RUNTIME_FEATURE_HTTP_TOGGLE                  4U
1177
1178 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1179 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS            8U
1180
1181 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1182 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16U
1183
1184 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1185 #define RUNTIME_FEATURE_ENFORCE_BLOCKS              32U
1186
1187 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1188 #define RUNTIME_FEATURE_CGI_CRUNCHING               64U
1189
1190 /** configuration_spec::feature_flags: Try to keep the connection to the server alive. */
1191 #define RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE      128U
1192
1193 /** configuration_spec::feature_flags: Share outgoing connections between different client connections. */
1194 #define RUNTIME_FEATURE_CONNECTION_SHARING         256U
1195
1196 /** configuration_spec::feature_flags: Pages blocked with +handle-as-empty-doc get a return status of 200 OK. */
1197 #define RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK       512U
1198
1199 /**
1200  * Data loaded from the configuration file.
1201  *
1202  * (Anomaly: toggle is still handled through a global, not this structure)
1203  */
1204 struct configuration_spec
1205 {
1206    /** What to log */
1207    int debug;
1208
1209    /** Nonzero to enable multithreading. */
1210    int multi_threaded;
1211
1212    /**
1213     * Bitmask of features that can be enabled/disabled through the config
1214     * file.  Currently defined bits:
1215     *
1216     * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1217     * - RUNTIME_FEATURE_CGI_TOGGLE
1218     * - RUNTIME_FEATURE_HTTP_TOGGLE
1219     * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
1220     * - RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS
1221     * - RUNTIME_FEATURE_ENFORCE_BLOCKS
1222     * - RUNTIME_FEATURE_CGI_CRUNCHING
1223     * - RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE
1224     * - RUNTIME_FEATURE_CONNECTION_SHARING
1225     * - RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK
1226     */
1227    unsigned feature_flags;
1228
1229    /** The log file name. */
1230    const char *logfile;
1231
1232    /** The config file directory. */
1233    const char *confdir;
1234
1235    /** The directory for customized CGI templates. */
1236    const char *templdir;
1237
1238    /** The log file directory. */
1239    const char *logdir;
1240
1241    /** The full paths to the actions files. */
1242    const char *actions_file[MAX_AF_FILES];
1243
1244    /** The short names of the actions files. */
1245    const char *actions_file_short[MAX_AF_FILES];
1246
1247    /** The administrator's email address */
1248    char *admin_address;
1249
1250    /** A URL with info on this proxy */
1251    char *proxy_info_url;
1252
1253    /** URL to the user manual (on our website or local copy) */
1254    char *usermanual;
1255
1256    /** The file names of the pcre filter files. */
1257    const char *re_filterfile[MAX_AF_FILES];
1258
1259    /** The short names of the pcre filter files. */
1260    const char *re_filterfile_short[MAX_AF_FILES];
1261
1262    /** The hostname to show on CGI pages, or NULL to use the real one. */
1263    const char *hostname;
1264
1265    /** IP address to bind to.  Defaults to HADDR_DEFAULT == 127.0.0.1. */
1266    const char *haddr;
1267
1268    /** Port to bind to.  Defaults to HADDR_PORT == 8118. */
1269    int         hport;
1270
1271    /** Size limit for IOB */
1272    size_t buffer_limit;
1273
1274 #ifdef FEATURE_TRUST
1275
1276    /** The file name of the trust file. */
1277    const char * trustfile;
1278
1279    /** FIXME: DOCME: Document this. */
1280    struct list trust_info[1];
1281
1282    /** FIXME: DOCME: Document this. */
1283    struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1284
1285 #endif /* def FEATURE_TRUST */
1286
1287 #ifdef FEATURE_ACL
1288
1289    /** The access control list (ACL). */
1290    struct access_control_list *acl;
1291
1292 #endif /* def FEATURE_ACL */
1293
1294    /** Information about parent proxies (forwarding). */
1295    struct forward_spec *forward;
1296
1297    /** Number of retries in case a forwarded connection attempt fails */
1298    int forwarded_connect_retries;
1299
1300    /** Maximum number of client connections. */
1301    int max_client_connections;
1302
1303    /* Timeout when waiting on sockets for data to become available. */
1304    int socket_timeout;
1305
1306 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1307    /* Maximum number of seconds after which an open connection will no longer be reused. */
1308    unsigned int keep_alive_timeout;
1309
1310    /* Assumed server-side keep alive timeout if none is specified. */
1311    unsigned int default_server_timeout;
1312 #endif
1313
1314    /** All options from the config file, HTML-formatted. */
1315    char *proxy_args;
1316
1317    /** The configuration file object. */
1318    struct file_list *config_file_list;
1319
1320    /** List of loaders */
1321    int (*loaders[NLOADERS])(struct client_state *);
1322
1323    /** Nonzero if we need to bind() to the new port. */
1324    int need_bind;
1325 };
1326
1327 /** Calculates the number of elements in an array, using sizeof. */
1328 #define SZ(X)  (sizeof(X) / sizeof(*X))
1329
1330 #ifdef FEATURE_FORCE_LOAD
1331 /** The force load URL prefix. */
1332 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1333 #endif /* def FEATURE_FORCE_LOAD */
1334
1335 #ifdef FEATURE_NO_GIFS
1336 /** The MIME type for images ("image/png" or "image/gif"). */
1337 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1338 #else
1339 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1340 #endif /* def FEATURE_NO_GIFS */
1341
1342
1343 /*
1344  * Hardwired URLs
1345  */
1346
1347 /** URL for the Privoxy home page. */
1348 #define HOME_PAGE_URL     "http://www.privoxy.org/"
1349
1350 /** URL for the Privoxy user manual. */
1351 #define USER_MANUAL_URL   HOME_PAGE_URL VERSION "/user-manual/"
1352
1353 /** Prefix for actions help links  (append to USER_MANUAL_URL). */
1354 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1355
1356 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1357 #define CONFIG_HELP_PREFIX  "config.html#"
1358
1359 /*
1360  * The "hosts" to intercept and display CGI pages.
1361  * First one is a hostname only, second one can specify host and path.
1362  *
1363  * Notes:
1364  * 1) Do not specify the http: prefix
1365  * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1366  * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1367  */
1368 #define CGI_SITE_1_HOST "p.p"
1369 #define CGI_SITE_2_HOST "config.privoxy.org"
1370 #define CGI_SITE_2_PATH ""
1371
1372 /**
1373  * The prefix for CGI pages.  Written out in generated HTML.
1374  * INCLUDES the trailing slash.
1375  */
1376 #define CGI_PREFIX  "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1377
1378 #ifdef __cplusplus
1379 } /* extern "C" */
1380 #endif
1381
1382 #endif /* ndef PROJECT_H_INCLUDED */
1383
1384 /*
1385   Local Variables:
1386   tab-width: 3
1387   end:
1388 */