#ifndef PROJECT_H_INCLUDED
#define PROJECT_H_INCLUDED
-#define PROJECT_H_VERSION "$Id: project.h,v 1.69 2002/05/08 16:00:16 oes Exp $"
+/** Version string. */
+#define PROJECT_H_VERSION "$Id: project.h,v 1.70 2002/05/12 16:05:50 jongfoster Exp $"
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/project.h,v $
*
* Revisions :
* $Log: project.h,v $
+ * Revision 1.70 2002/05/12 16:05:50 jongfoster
+ * Fixing ACTION_MASK_ALL to be unsigned long rather than
+ * just unsigned int. I don't know if anyone is porting
+ * Privoxy to 16-bit platforms, but if so, +limit-connect
+ * wouldn't have worked because of this bug.
+ *
* Revision 1.69 2002/05/08 16:00:16 oes
* Added size member to struct iob, so it can
* be alloced larger than needed.
extern "C" {
#endif
-/*
- * The type used by sockets. On UNIX it's an int. Microsoft decided to
- * make it an unsigned.
- */
#ifdef _WIN32
+
typedef SOCKET jb_socket;
+
#define JB_INVALID_SOCKET INVALID_SOCKET
+
#else /* ndef _WIN32 */
+
+/**
+ * The type used by sockets. On UNIX it's an int. Microsoft decided to
+ * make it an unsigned.
+ */
typedef int jb_socket;
+
+/**
+ * The error value used for variables of type jb_socket. On UNIX this
+ * is -1, however Microsoft decided to make socket handles unsigned, so
+ * they use a different value.
+ */
+
#define JB_INVALID_SOCKET (-1)
+
#endif /* ndef _WIN32 */
-/*
- * Error codes. Functions returning these should return a jb_err
+/**
+ * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
+ * series of errors.
*/
-#define JB_ERR_OK 0 /* Success, no error */
-#define JB_ERR_MEMORY 1 /* Out of memory */
-#define JB_ERR_CGI_PARAMS 2 /* Missing or corrupt CGI parameters */
-#define JB_ERR_FILE 3 /* Error opening, reading or writing a file */
-#define JB_ERR_PARSE 4 /* Error parsing file */
-#define JB_ERR_MODIFIED 5 /* File has been modified outside of the */
- /* CGI actions editor. */
typedef int jb_err;
+#define JB_ERR_OK 0 /**< Success, no error */
+#define JB_ERR_MEMORY 1 /**< Out of memory */
+#define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters */
+#define JB_ERR_FILE 3 /**< Error opening, reading or writing a file */
+#define JB_ERR_PARSE 4 /**< Error parsing file */
+#define JB_ERR_MODIFIED 5 /**< File has been modified outside of the
+ CGI actions editor. */
-/*
- * This macro is used to free a pointer that may be NULL
+
+/**
+ * This macro is used to free a pointer that may be NULL.
+ * It also sets the variable to NULL after it's been freed.
+ * The paramater should be a simple variable without side effects.
*/
#define freez(X) { if(X) { free((void*)X); X = NULL ; } }
-/* Fix a problem with Solaris. There should be no effect on other
+/**
+ * Fix a problem with Solaris. There should be no effect on other
* platforms.
+ *
* Solaris's isspace() is a macro which uses it's argument directly
* as an array index. Therefore we need to make sure that high-bit
* characters generate +ve values, and ideally we also want to make
#define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
#define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
-/*
+/**
* Use for statically allocated buffers if you have no other choice.
* Remember to check the length of what you write into the buffer
* - we don't want any buffer overflows!
*/
#define BUFFER_SIZE 5000
-/*
- * Max length of CGI parameters (arbitrary limit)
+/**
+ * Max length of CGI parameters (arbitrary limit).
*/
#define CGI_PARAM_LEN_MAX 500
-/*
+/**
* Buffer size for capturing struct hostent data in the
* gethostby(name|addr)_r library calls. Since we don't
* loop over gethostbyname_r, the buffer must be sufficient
*/
#define HOSTENT_BUFFER_SIZE 1024
-/*
- * So you can say "while (FOREVER) { ...do something... }"
+/**
+ * Do not use. Originally this was so that you can
+ * say "while (FOREVER) { ...do something... }".
+ * However, this gives a warning with some compilers (e.g. VC++).
+ * Instead, use "for (;;) { ...do something... }".
*/
#define FOREVER 1
-/* Default IP and port to listen on */
+/**
+ * Default IP address to listen on, as a string.
+ * Set to "127.0.0.1".
+ */
#define HADDR_DEFAULT "127.0.0.1"
+
+/**
+ * Default port to listen on, as a number.
+ * Set to 8118.
+ */
#define HADDR_PORT 8118
-/* Forward defs for various structures */
-/* Need this for struct client_state */
+/* Forward def for struct client_state */
struct configuration_spec;
-/* Generic linked list of strings */
-
+/**
+ * Entry in a linked list of strings.
+ */
struct list_entry
{
+ /**
+ * The string. The "const" is only to discourage modification,
+ * you can actually change it if you *really* want to.
+ * You can even freez() it and replace it with another
+ * malloc()d string. If you replace it with NULL, the list
+ * functions will work, just be careful next time you iterate
+ * through the list in your own code.
+ *
+ * FIXME: Should we remove the "const"?
+ */
const char *str;
+
+ /** Next entry in the linked list, or NULL if no more. */
struct list_entry *next;
};
+/**
+ * A header for a linked list of strings.
+ */
struct list
{
+ /** First entry in the list, or NULL if the list is empty. */
struct list_entry *first;
+
+ /** Last entry in the list, or NULL if the list is empty. */
struct list_entry *last;
};
-/* A map from a string to another string */
-
+/**
+ * An entry in a map. This is a name=value pair.
+ */
struct map_entry
{
+ /** The key for the map. */
const char *name;
+ /** The value associated with that key. */
const char *value;
+ /** The next map entry, or NULL if none. */
struct map_entry *next;
};
+/**
+ * A map from a string to another string.
+ * This is used for the paramaters passed in a HTTP GET request, and
+ * to store the exports when the CGI interface is filling in a template.
+ */
struct map
{
+ /** The first map entry, or NULL if the map is empty. */
struct map_entry *first;
+ /** The last map entry, or NULL if the map is empty. */
struct map_entry *last;
};
+/**
+ * A HTTP request. This includes the method (GET, POST) and
+ * the parsed URL.
+ *
+ * This is also used whenever we want to match a URL against a
+ * URL pattern. This always contains the URL to match, and never
+ * a URL pattern. (See struct url_spec).
+ */
struct http_request
{
- char *cmd; /* Whole command line: method, URL, Version */
- char *ocmd; /* Backup of original cmd for CLF logging */
- char *gpc; /* HTTP method: GET, POST, .. */
- char *url; /* The URL */
- char *ver; /* Protocol version */
- int status; /* HTTP Status */
-
- char *host; /* Host part of URL */
- int port; /* Port of URL or 80 (default) */
- char *path; /* Path of URL */
- char *hostport; /* host[:port] */
- int ssl; /* Flag if protocol is https */
-
- char *host_ip_addr_str; /* String with dotted decimal representation
- * of host's IP. NULL before connect_to() */
-
- char *dbuffer; /* Buffer with '\0'-delimited domain name. */
- char **dvec; /* List of pointers to the strings in dbuffer. */
- int dcount; /* How many parts to this domain? (length of dvec) */
+ char *cmd; /**< Whole command line: method, URL, Version */
+ char *ocmd; /**< Backup of original cmd for CLF logging */
+ char *gpc; /**< HTTP method: GET, POST, ... */
+ char *url; /**< The URL */
+ char *ver; /**< Protocol version */
+ int status; /**< HTTP Status */
+
+ char *host; /**< Host part of URL */
+ int port; /**< Port of URL or 80 (default) */
+ char *path; /**< Path of URL */
+ char *hostport; /**< host[:port] */
+ int ssl; /**< Flag if protocol is https */
+
+ char *host_ip_addr_str; /**< String with dotted decimal representation
+ of host's IP. NULL before connect_to() */
+
+ char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
+ char **dvec; /**< List of pointers to the strings in dbuffer. */
+ int dcount; /**< How many parts to this domain? (length of dvec) */
};
-/*
+
+/**
* Response generated by CGI, blocker, or error handler
*/
struct http_response
{
- char *status; /* HTTP status (string) */
- struct list headers[1]; /* List of header lines */
- char *head; /* Formatted http response head */
- size_t head_length; /* Length of http response head */
- char *body; /* HTTP document body */
- size_t content_length; /* Length of body, REQUIRED if binary body */
- int is_static; /* Nonzero if the content will never change and
- * should be cached by the brwoser (e.g. images) */
+ char *status; /**< HTTP status (string). */
+ struct list headers[1]; /**< List of header lines. */
+ char *head; /**< Formatted http response head. */
+ size_t head_length; /**< Length of http response head. */
+ char *body; /**< HTTP document body. */
+ size_t content_length; /**< Length of body, REQUIRED if binary body. */
+ int is_static; /**< Nonzero if the content will never change and
+ should be cached by the browser (e.g. images). */
};
-/* A URL pattern */
+/**
+ * A URL pattern.
+ */
struct url_spec
{
- char *spec; /* The string which was parsed to produce this */
- /* url_spec. Used for debugging or display only. */
-
- /* Hostname matching, or dbuffer == NULL to match all hosts */
- char *dbuffer; /* Buffer with '\0'-delimited domain name. */
- char **dvec; /* List of pointers to the strings in dbuffer. */
- int dcount; /* How many parts to this domain? (length of dvec) */
- int unanchored; /* Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
-
- /* Port matching: */
- int port; /* The port number, or 0 to match all ports. */
-
- /* Path matching: */
- char *path; /* The path prefix (if not using regex), or source */
- /* for the regex. */
- int pathlen; /* ==strlen(path). Needed for prefix matching. */
- regex_t *preg; /* Regex for matching path part */
+ /** The string which was parsed to produce this url_spec.
+ Used for debugging or display only. */
+ char *spec;
+
+ char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
+ char **dvec; /**< List of pointers to the strings in dbuffer. */
+ int dcount; /**< How many parts to this domain? (length of dvec) */
+ int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
+
+ int port; /**< The port number, or 0 to match all ports. */
+
+ char *path; /**< The source for the regex. */
+ int pathlen; /**< ==strlen(path). Needed for prefix matching. FIXME: Now obsolete? */
+ regex_t *preg; /**< Regex for matching path part */
};
+
+/**
+ * If you declare a static url_spec, this is the value to initialize it to zero.
+ */
#define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
-/* Constants for host part matching in URLs */
+/**
+ * Constant for host part matching in URLs. If set, indicates that the start of
+ * the pattern must match the start of the URL. E.g. this is not set for the
+ * pattern ".example.com", so that it will match both "example.com" and
+ * "www.example.com". It is set for the pattern "example.com", which makes it
+ * match "example.com" only, not "www.example.com".
+ */
#define ANCHOR_LEFT 1
+
+/**
+ * Constant for host part matching in URLs. If set, indicates that the end of
+ * the pattern must match the end of the URL. E.g. this is not set for the
+ * pattern "ad.", so that it will match any host called "ad", irrespective
+ * of how many subdomains are in the fully-qualified domain name.
+ */
#define ANCHOR_RIGHT 2
-/* An I/O buffer */
+/**
+ * An I/O buffer. Holds a string which can be appended to, and can have data
+ * removed from the beginning.
+ */
struct iob
{
- char *buf; /* Start of buffer */
- char *cur; /* Start of relevant data */
- char *eod; /* End of relevant data */
- size_t size; /* Size as malloc()ed */
+ char *buf; /**< Start of buffer */
+ char *cur; /**< Start of relevant data */
+ char *eod; /**< End of relevant data */
+ size_t size; /**< Size as malloc()ed */
};
+/**
+ * Return the number of bytes in the I/O buffer associated with the passed
+ * client_state pointer.
+ * May be zero.
+ */
#define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
+
+
+/**
+ * Remove any data in the I/O buffer associated with the passed
+ * client_state pointer.
+ */
#define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
/* Bits for csp->content_type */
-#define CT_TEXT 1 /* Suitable for pcrs filtering */
-#define CT_GIF 2 /* Suitable for GIF filtering */
-#define CT_TABOO 4 /* DONT filter */
-
+#define CT_TEXT 1 /**< csp->content_type bitmask:
+ Suitable for pcrs filtering. */
+#define CT_GIF 2 /**< csp->content_type bitmask:
+ Suitable for GIF filtering. */
+#define CT_TABOO 4 /**< csp->content_type bitmask:
+ DO NOT filter, irrespective of other flags. */
+
+/**
+ * The mask which includes all actions.
+ */
#define ACTION_MASK_ALL (~0UL)
+/**
+ * The most compatible set of actions - i.e. none.
+ */
#define ACTION_MOST_COMPATIBLE 0x00000000UL
+/** Action bitmap: Block the request. */
#define ACTION_BLOCK 0x00000001UL
+/** Action bitmap: Deanimate if it's a GIF. */
#define ACTION_DEANIMATE 0x00000002UL
+/** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
#define ACTION_DOWNGRADE 0x00000004UL
+/** Action bitmap: Fast redirects. */
#define ACTION_FAST_REDIRECTS 0x00000008UL
+/** Action bitmap: Remove existing "Forwarded" header, and do not add another. */
#define ACTION_HIDE_FORWARDED 0x00000010UL
+/** Action bitmap: Hide "From" header. */
#define ACTION_HIDE_FROM 0x00000020UL
-#define ACTION_HIDE_REFERER 0x00000040UL /* sic - follow HTTP, not English */
+/** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
+#define ACTION_HIDE_REFERER 0x00000040UL
+/** Action bitmap: Hide "User-Agent" and similar headers. */
#define ACTION_HIDE_USER_AGENT 0x00000080UL
+/** Action bitmap: This is an image. */
#define ACTION_IMAGE 0x00000100UL
+/** Action bitmap: Sets the image blocker. */
#define ACTION_IMAGE_BLOCKER 0x00000200UL
+/** Action bitmap: Prevent compression. */
#define ACTION_NO_COMPRESSION 0x00000400UL
+/** Action bitmap: Change cookies to session only cookies. */
#define ACTION_NO_COOKIE_KEEP 0x00000800UL
+/** Action bitmap: Block rending cookies. */
#define ACTION_NO_COOKIE_READ 0x00001000UL
+/** Action bitmap: Block setting cookies. */
#define ACTION_NO_COOKIE_SET 0x00002000UL
+/** Action bitmap: Filter out popups. */
#define ACTION_NO_POPUPS 0x00004000UL
+/** Action bitmap: Send a vanilla wafer. */
#define ACTION_VANILLA_WAFER 0x00008000UL
+/** Action bitmap: Limit CONNECT requests to safe ports. */
#define ACTION_LIMIT_CONNECT 0x00010000UL
+/** Action string index: How to deanimate GIFs */
#define ACTION_STRING_DEANIMATE 0
+/** Action string index: Replacement for "From:" header */
#define ACTION_STRING_FROM 1
+/** Action string index: How to block images */
#define ACTION_STRING_IMAGE_BLOCKER 2
+/** Action string index: Replacement for "Referer:" header */
#define ACTION_STRING_REFERER 3
+/** Action string index: Replacement for "User-Agent:" header */
#define ACTION_STRING_USER_AGENT 4
+/** Action string index: Legal CONNECT ports. */
#define ACTION_STRING_LIMIT_CONNECT 5
+/** Number of string actions. */
#define ACTION_STRING_COUNT 6
+/** Index into current_action_spec::multi[] for headers to add. */
#define ACTION_MULTI_ADD_HEADER 0
+/** Index into current_action_spec::multi[] for headers to add. */
#define ACTION_MULTI_WAFER 1
+/** Index into current_action_spec::multi[] for filters to apply. */
#define ACTION_MULTI_FILTER 2
+/** Number of multi-string actions. */
#define ACTION_MULTI_COUNT 3
-/*
+/**
* This structure contains a list of actions to apply to a URL.
* It only contains positive instructions - no "-" options.
* It is not used to store the actions list itself, only for
*/
struct current_action_spec
{
- unsigned long flags; /* a bit set to "1" = add action */
+ /** Actions to apply. A bit set to "1" means perform the action. */
+ unsigned long flags;
- /* For those actions that require parameters: */
-
- /* each entry is valid if & only if corresponding entry in "add" set. */
+ /**
+ * Paramaters for those actions that require them.
+ * Each entry is valid if & only if the corresponding entry in "flags" is
+ * set.
+ */
char * string[ACTION_STRING_COUNT];
- /* Strings to add */
+ /** Lists of strings for multi-string actions. */
struct list multi[ACTION_MULTI_COUNT][1];
};
-/*
+/**
* This structure contains a set of changes to actions.
* It can contain both positive and negative instructions.
* It is used to store an entry in the actions list.
*/
struct action_spec
{
- unsigned long mask; /* a bit set to "0" = remove action */
- unsigned long add; /* a bit set to "1" = add action */
-
- /* For those actions that require parameters: */
+ unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
+ unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
- /* each entry is valid if & only if corresponding entry in "add" set. */
+ /**
+ * Paramaters for those actions that require them.
+ * Each entry is valid if & only if the corresponding entry in "flags" is
+ * set.
+ */
char * string[ACTION_STRING_COUNT];
- /* Strings to remove. */
+ /** Lists of strings to remove, for multi-string actions. */
struct list multi_remove[ACTION_MULTI_COUNT][1];
- /* If nonzero, remove *all* strings. */
+ /** If nonzero, remove *all* strings from the multi-string action. */
int multi_remove_all[ACTION_MULTI_COUNT];
- /* Strings to add */
+ /** Lists of strings to add, for multi-string actions. */
struct list multi_add[ACTION_MULTI_COUNT][1];
};
-/*
+
+/**
* This structure is used to store the actions list.
*
* It contains a URL pattern, and the chages to the actions.
*/
struct url_actions
{
- struct url_spec url[1];
+ struct url_spec url[1]; /**< URL pattern. */
- struct action_spec action[1];
+ struct action_spec action[1]; /**< Actions. */
- struct url_actions * next;
+ struct url_actions * next; /**< Next action in file, or NULL. */
};
/*
* Flags for use in csp->flags
*/
-#define CSP_FLAG_ACTIVE 0x01 /* Set if this client is processing data.
- * Cleared when the thread associated with
- * this structure dies. */
-#define CSP_FLAG_CHUNKED 0x02 /* Set if the server's reply is in "chunked"
- * transfer encoding */
-#define CSP_FLAG_FORCED 0x04 /* Set if this request was enforced, although
- * it would normally have been blocked. */
-#define CSP_FLAG_MODIFIED 0x08 /* Set if any modification to the body was done */
-#define CSP_FLAG_REJECTED 0x10 /* Set if request was blocked. */
-#define CSP_FLAG_TOGGLED_ON 0x20 /* Set if we are toggled on (FEATURE_TOGGLE) */
+
+/**
+ * Flag for csp->flags: Set if this client is processing data.
+ * Cleared when the thread associated with this structure dies.
+ */
+#define CSP_FLAG_ACTIVE 0x01
-/*
+/**
+ * Flag for csp->flags: Set if the server's reply is in "chunked"
+ * transfer encoding
+ */
+#define CSP_FLAG_CHUNKED 0x02
+
+/**
+ * Flag for csp->flags: Set if this request was enforced, although it would
+ * normally have been blocked.
+ */
+#define CSP_FLAG_FORCED 0x04
+
+/**
+ * Flag for csp->flags: Set if any modification to the body was done.
+ */
+#define CSP_FLAG_MODIFIED 0x08
+
+/**
+ * Flag for csp->flags: Set if request was blocked.
+ */
+#define CSP_FLAG_REJECTED 0x10
+
+/**
+ * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
+ */
+#define CSP_FLAG_TOGGLED_ON 0x20
+
+
+/**
* Maximum number of actions files. This limit is arbitrary - it's just used
* to size an array.
*/
#define MAX_ACTION_FILES 10
-/*
+/**
* The state of a Privoxy processing thread.
*/
struct client_state
{
- /* The proxy's configuration */
+ /** The proxy's configuration */
struct configuration_spec * config;
- /* The actions to perform on the current request */
+ /** The actions to perform on the current request */
struct current_action_spec action[1];
- /* socket to talk to client (web browser) */
+ /** socket to talk to client (web browser) */
jb_socket cfd;
- /* socket to talk to server (web server or proxy) */
+ /** socket to talk to server (web server or proxy) */
jb_socket sfd;
- /* Multi-purpose flag container, see CSP_FLAG_* above */
+ /** Multi-purpose flag container, see CSP_FLAG_* above */
unsigned short int flags;
- /*
- * Client PC's IP address, as reported by the accept()_ function.
- * Both as string and number
- */
+ /** Client PC's IP address, as reported by the accept() function.
+ As a string. */
char *ip_addr_str;
+ /** Client PC's IP address, as reported by the accept() function.
+ As a number. */
long ip_addr_long;
-
- /* Our IP address and hostname, i.e. the IP address that
- the client used to reach us, and the associated hostname,
- both as strings
- */
+ /** Our IP address. I.e. the IP address that the client used to reach us,
+ as a string. */
char *my_ip_addr_str;
+
+ /** Our hostname. I.e. the reverse DNS of the IP address that the client
+ used to reach us, as a string. */
char *my_hostname;
- /* The URL that was requested */
+ /** The URL that was requested */
struct http_request http[1];
- /* An I/O buffer used for buffering data read from the client */
+ /** An I/O buffer used for buffering data read from the network */
struct iob iob[1];
- /* List of all headers for this request */
+ /** List of all headers for this request */
struct list headers[1];
- /* List of all cookies for this request */
+ /** List of all cookies for this request */
struct list cookie_list[1];
- /* MIME-Type key, see CT_* above */
+ /** MIME-Type key, see CT_* above */
unsigned short int content_type;
- /* The "X-Forwarded-For:" header sent by the client */
+ /** The "X-Forwarded-For:" header sent by the client */
char *x_forwarded;
- /* files associated with this client */
+ /** Actions files associated with this client */
struct file_list *actions_list[MAX_ACTION_FILES];
- struct file_list *rlist; /* pcrs job file */
- size_t content_length; /* Length after content modification */
+ /** pcrs job file. */
+ struct file_list *rlist;
+
+ /** Length after content modification. */
+ size_t content_length;
#ifdef FEATURE_TRUST
- struct file_list *tlist; /* trustfile */
+
+ /** Trust file. */
+ struct file_list *tlist;
+
#endif /* def FEATURE_TRUST */
+ /** Next thread in linked list. Only read or modify from the main thread! */
struct client_state *next;
};
-/*
+/**
* A function to add a header
*/
typedef jb_err (*add_header_func_ptr)(struct client_state *);
-/*
+/**
* A function to process a header
*/
typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
-/*
+
+/**
* List of functions to run on a list of headers
*/
struct parsers
{
+ /** The header prefix to match */
char *str;
+
+ /** The length of the prefix to match */
size_t len;
+
+ /** The function to apply to this line */
parser_func_ptr parser;
};
-/*
+/**
* List of available CGI functions.
*/
struct cgi_dispatcher
{
+ /** The URL of the CGI, relative to the CGI root. */
const char * const name;
+
+ /** The handler function for the CGI */
jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
+
+ /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
const char * const description;
};
-/*
+/**
* A data file used by Privoxy. Kept in a linked list.
*/
struct file_list
{
- /*
- * this is a pointer to the data structures associated with the file.
+ /**
+ * This is a pointer to the data structures associated with the file.
* Read-only once the structure has been created.
*/
void *f;
- /* Normally NULL. When we are finished with file (i.e. when we have
+ /**
+ * The unloader function.
+ * Normally NULL. When we are finished with file (i.e. when we have
* loaded a new one), set to a pointer to an unloader function.
* Unloader will be called by sweep() (called from main loop) when
* all clients using this file are done. This prevents threading
*/
void (*unloader)(void *);
- /* Used internally by sweep(). Do not access from elsewhere. */
+ /**
+ * Used internally by sweep(). Do not access from elsewhere.
+ */
int active;
- /* Following variables allow us to check if file has been changed.
+ /**
+ * File last-modified time, so we can check if file has been changed.
* Read-only once the structure has been created.
*/
time_t lastmodified;
+
+ /**
+ * The full filename.
+ */
char * filename;
- /* Pointer to next entry in the linked list of all "file_list"s.
+ /**
+ * Pointer to next entry in the linked list of all "file_list"s.
* This linked list is so that sweep() can navigate it.
* Since sweep() can remove items from the list, we must be careful
* to only access this value from main thread (when we know sweep
#ifdef FEATURE_TRUST
+
+/**
+ * The format of a trust file when loaded into memory.
+ */
struct block_spec
{
- struct url_spec url[1];
- int reject;
- struct block_spec *next;
+ struct url_spec url[1]; /**< The URL pattern */
+ int reject; /**< FIXME: Please document this! */
+ struct block_spec *next; /**< Next entry in linked list */
};
+
#endif /* def FEATURE_TRUST */
-#define SOCKS_NONE 0 /* Don't use a SOCKS server */
-#define SOCKS_4 40 /* original SOCKS 4 protocol */
-#define SOCKS_4A 41 /* as modified for hosts w/o external DNS */
+#define SOCKS_NONE 0 /**< Don't use a SOCKS server */
+#define SOCKS_4 40 /**< original SOCKS 4 protocol */
+#define SOCKS_4A 41 /**< as modified for hosts w/o external DNS */
+
+/**
+ * How to forward a connection to a parent proxy.
+ */
struct forward_spec
{
+ /** URL pattern that this forward_spec is for. */
struct url_spec url[1];
- /* Connection type - must be a SOCKS_xxx constant */
+ /** Connection type. Must be SOCKS_NONE, SOCKS_4, or SOCKS_4A. */
int type;
- /* SOCKS server */
+ /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
char *gateway_host;
+
+ /** SOCKS server port. */
int gateway_port;
- /* Parent HTTP proxy */
+ /** Parent HTTP proxy hostname, or NULL for none. */
char *forward_host;
+
+ /** Parent HTTP proxy port. */
int forward_port;
- /* For the linked list */
+ /** Next entry in the linked list. */
struct forward_spec *next;
};
+
+
+/**
+ * Initializer for a static struct forward_spec.
+ */
#define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
-/*
+/**
* This struct represents one filter (one block) from
* the re_filterfile. If there is more than one filter
* in the file, the file will be represented by a
*/
struct re_filterfile_spec
{
- char *name; /* Name from FILTER: statement in re_filterfile */
- char *description; /* Description from FILTER: statement in re_filterfile */
- struct list patterns[1]; /* The patterns from the re_filterfile */
- pcrs_job *joblist; /* The resulting compiled pcrs_jobs */
- struct re_filterfile_spec *next; /* The pointer for chaining */
+ char *name; /**< Name from FILTER: statement in re_filterfile. */
+ char *description; /**< Description from FILTER: statement in re_filterfile. */
+ struct list patterns[1]; /**< The patterns from the re_filterfile. */
+ pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
+ struct re_filterfile_spec *next; /**< The pointer for chaining. */
};
+
#ifdef FEATURE_ACL
-#define ACL_PERMIT 1 /* accept connection request */
-#define ACL_DENY 2 /* reject connection request */
+#define ACL_PERMIT 1 /**< Accept connection request */
+#define ACL_DENY 2 /**< Reject connection request */
+
+/**
+ * An IP address pattern. Used to specify networks in the ACL.
+ */
struct access_control_addr
{
- unsigned long addr;
- unsigned long mask;
- unsigned long port;
+ unsigned long addr; /**< The IP address as an integer. */
+ unsigned long mask; /**< The network mask as an integer. */
+ unsigned long port; /**< The port number. */
};
+/**
+ * An access control list (ACL) entry.
+ *
+ * This is a linked list.
+ */
struct access_control_list
{
- struct access_control_addr src[1];
- struct access_control_addr dst[1];
+ struct access_control_addr src[1]; /**< Client IP address */
+ struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
- short action;
- struct access_control_list *next;
+ short action; /**< ACL_PERMIT or ACL_DENY */
+ struct access_control_list *next; /**< The next entry in the ACL. */
};
+
#endif /* def FEATURE_ACL */
-/* Maximum number of loaders (actions, re_filter, ...) */
+/** Maximum number of loaders (actions, re_filter, ...) */
#define NLOADERS 8
+/** configuration_spec::feature_flags: CGI actions editor. */
#define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
+
+/** configuration_spec::feature_flags: Web-based toggle. */
#define RUNTIME_FEATURE_CGI_TOGGLE 2
-/*
+/**
* Data loaded from the configuration file.
*
* (Anomaly: toggle is still handled through a global, not this structure)
*/
struct configuration_spec
{
+ /** What to log */
int debug;
+
+ /** Nonzero to enable multithreading. */
int multi_threaded;
- /* Features that can be enabled/disabled through the config file */
+ /**
+ * Bitmask of features that can be enabled/disabled through the config
+ * file. Currently defined bits:
+ *
+ * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
+ * - RUNTIME_FEATURE_CGI_TOGGLE
+ */
unsigned feature_flags;
+ /** The log file name. */
const char *logfile;
+ /** The config file directory. */
const char *confdir;
+
+ /** The log file directory. */
const char *logdir;
+
+ /** The full paths to the actions files. */
const char *actions_file[MAX_ACTION_FILES];
+
+ /** The short names of the actions files. */
const char *actions_file_short[MAX_ACTION_FILES];
- /* The administrator's email address */
+ /** The administrator's email address */
char *admin_address;
- /* A URL with info on this proxy */
+ /** A URL with info on this proxy */
char *proxy_info_url;
- /* URL to the user manual (on our website or local copy) */
+ /** URL to the user manual (on our website or local copy) */
char *usermanual;
+ /** The file name of the pcre filter file */
const char *re_filterfile;
#ifdef FEATURE_COOKIE_JAR
+
+ /** The file name of the cookie jar file */
const char * jarfile;
+
+ /** The handle to the cookie jar file */
FILE * jar;
+
#endif /* def FEATURE_COOKIE_JAR */
- /*
- * Port and IP to bind to.
- * Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8118
- */
+ /** IP address to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
const char *haddr;
+
+ /** Port to bind to. Defaults to HADDR_PORT == 8118. */
int hport;
- /* Size limit for IOB */
+ /** Size limit for IOB */
size_t buffer_limit;
#ifdef FEATURE_TRUST
+
+ /** The file name of the trust file. */
const char * trustfile;
+ /** FIXME: DOCME: Document this. */
struct list trust_info[1];
+
+ /** FIXME: DOCME: Document this. */
struct url_spec *trust_list[64];
+
#endif /* def FEATURE_TRUST */
#ifdef FEATURE_ACL
+
+ /** The access control list (ACL). */
struct access_control_list *acl;
+
#endif /* def FEATURE_ACL */
+ /** Information about parent proxies (forwarding). */
struct forward_spec *forward;
- /* All options from the config file, HTML-formatted */
+ /** All options from the config file, HTML-formatted. */
char *proxy_args;
- /* the configuration file object. */
+ /** The configuration file object. */
struct file_list *config_file_list;
- /* List of loaders */
+ /** List of loaders */
int (*loaders[NLOADERS])(struct client_state *);
- /* bool, nonzero if we need to bind() to the new port */
+ /** Nonzero if we need to bind() to the new port. */
int need_bind;
};
-
+/** Calculates the number of elements in an array, using sizeof. */
#define SZ(X) (sizeof(X) / sizeof(*X))
#ifdef FEATURE_FORCE_LOAD
+/** The force load URL prefix. */
#define FORCE_PREFIX "/PRIVOXY-FORCE"
#endif /* def FEATURE_FORCE_LOAD */
#ifdef FEATURE_NO_GIFS
+/** The MIME type for images ("image/png" or "image/gif"). */
#define BUILTIN_IMAGE_MIMETYPE "image/png"
#else
#define BUILTIN_IMAGE_MIMETYPE "image/gif"
/* Hardwired URLs */
+
+/** URL for the Privoxy home page. No trailing "/". */
#define HOME_PAGE_URL "http://www.privoxy.org"
+
+/** URL for the Privoxy user manual. With a trailing "/". */
#define USER_MANUAL_URL HOME_PAGE_URL "/" VERSION "/user-manual/"
+
+/** FIXME: DOCME: Document this. */
#define HELP_LINK_PREFIX "configuration.html#"
/*
#define CGI_SITE_2_HOST "config.privoxy.org"
#define CGI_SITE_2_PATH ""
-/*
+/**
* The prefix for CGI pages. Written out in generated HTML.
* INCLUDES the trailing slash.
*/
#define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
-/* HTTP snipplets */
+/* HTTP snipplets.
+ *
+ * FIXME: This is very inefficient. There could be one copy of these strings
+ * for each .c file!! They should be "extern", not "static".
+ */
static const char CSUCCEED[] =
"HTTP/1.0 200 Connection established\n"
"Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
projects / privoxy.git / blobdiff