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