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