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