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