parsers.h

   1 #ifndef PARSERS_H_INCLUDED
   2 #define PARSERS_H_INCLUDED
   3 #define PARSERS_H_VERSION "$Id: parsers.h,v 1.32 2006/12/06 19:14:23 fabiankeil Exp $"
   4 /*********************************************************************
   5  *
   6  * File        :  $Source: /cvsroot/ijbswa/current/parsers.h,v $
   7  *
   8  * Purpose     :  Declares functions to parse/crunch headers and pages.
   9  *                Functions declared include:
  10  *                   `add_to_iob', `client_cookie_adder', `client_from',
  11  *                   `client_referrer', `client_send_cookie', `client_ua',
  12  *                   `client_uagent', `client_x_forwarded',
  13  *                   `client_x_forwarded_adder', `client_xtra_adder',
  14  *                   `content_type', `crumble', `destroy_list', `enlist',
  15  *                   `flush_socket', `free_http_request', `get_header',
  16  *                   `list_to_text', `parse_http_request', `sed',
  17  *                   and `server_set_cookie'.
  18  *
  19  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
  20  *                Privoxy team. http://www.privoxy.org/
  21  *
  22  *                Based on the Internet Junkbuster originally written
  23  *                by and Copyright (C) 1997 Anonymous Coders and
  24  *                Junkbusters Corporation.  http://www.junkbusters.com
  25  *
  26  *                This program is free software; you can redistribute it
  27  *                and/or modify it under the terms of the GNU General
  28  *                Public License as published by the Free Software
  29  *                Foundation; either version 2 of the License, or (at
  30  *                your option) any later version.
  31  *
  32  *                This program is distributed in the hope that it will
  33  *                be useful, but WITHOUT ANY WARRANTY; without even the
  34  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  35  *                PARTICULAR PURPOSE.  See the GNU General Public
  36  *                License for more details.
  37  *
  38  *                The GNU General Public License should be included with
  39  *                this file.  If not, you can view it at
  40  *                http://www.gnu.org/copyleft/gpl.html
  41  *                or write to the Free Software Foundation, Inc., 59
  42  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  43  *
  44  * Revisions   :
  45  *    $Log: parsers.h,v $
  46  *    Revision 1.32  2006/12/06 19:14:23  fabiankeil
  47  *    Added prototype for get_destination_from_headers().
  48  *
  49  *    Revision 1.31  2006/08/17 17:15:10  fabiankeil
  50  *    - Back to timegm() using GnuPG's replacement if necessary.
  51  *      Using mktime() and localtime() could add a on hour offset if
  52  *      the randomize factor was big enough to lead to a summer/wintertime
  53  *      switch.
  54  *
  55  *    - Removed now-useless Privoxy 3.0.3 compatibility glue.
  56  *
  57  *    - Moved randomization code into pick_from_range().
  58  *
  59  *    - Changed parse_header_time definition.
  60  *      time_t isn't guaranteed to be signed and
  61  *      if it isn't, -1 isn't available as error code.
  62  *      Changed some variable types in client_if_modified_since()
  63  *      because of the same reason.
  64  *
  65  *    Revision 1.30  2006/08/14 08:25:19  fabiankeil
  66  *    Split filter-headers{} into filter-client-headers{}
  67  *    and filter-server-headers{}.
  68  *    Added parse_header_time() to share some code.
  69  *    Replaced timegm() with mktime().
  70  *
  71  *    Revision 1.29  2006/08/03 02:46:41  david__schmidt
  72  *    Incorporate Fabian Keil's patch work:\rhttp://www.fabiankeil.de/sourcecode/privoxy/
  73  *
  74  *    Revision 1.28  2006/07/18 14:48:47  david__schmidt
  75  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
  76  *    with what was really the latest development (the v_3_0_branch branch)
  77  *
  78  *    Revision 1.26.2.1  2002/09/25 14:52:46  oes
  79  *    Added basic support for OPTIONS and TRACE HTTP methods:
  80  *     - New parser function client_max_forwards which decrements
  81  *       the Max-Forwards HTTP header field of OPTIONS and TRACE
  82  *       requests by one before forwarding
  83  *     - New parser function client_host which extracts the host
  84  *       and port information from the HTTP header field if the
  85  *       request URI was not absolute
  86  *     - Don't crumble and re-add the Host: header, but only generate
  87  *       and append if missing
  88  *
  89  *    Revision 1.26  2002/05/08 15:59:53  oes
  90  *    Changed add_to_iob signature (now returns jb_err)
  91  *
  92  *    Revision 1.25  2002/03/26 22:29:55  swa
  93  *    we have a new homepage!
  94  *
  95  *    Revision 1.24  2002/03/24 13:25:43  swa
  96  *    name change related issues
  97  *
  98  *    Revision 1.23  2002/03/13 00:27:05  jongfoster
  99  *    Killing warnings
 100  *
 101  *    Revision 1.22  2002/03/09 20:03:52  jongfoster
 102  *    - Making various functions return int rather than size_t.
 103  *      (Undoing a recent change).  Since size_t is unsigned on
 104  *      Windows, functions like read_socket that return -1 on
 105  *      error cannot return a size_t.
 106  *
 107  *      THIS WAS A MAJOR BUG - it caused frequent, unpredictable
 108  *      crashes, and also frequently caused JB to jump to 100%
 109  *      CPU and stay there.  (Because it thought it had just
 110  *      read ((unsigned)-1) == 4Gb of data...)
 111  *
 112  *    - The signature of write_socket has changed, it now simply
 113  *      returns success=0/failure=nonzero.
 114  *
 115  *    - Trying to get rid of a few warnings --with-debug on
 116  *      Windows, I've introduced a new type "jb_socket".  This is
 117  *      used for the socket file descriptors.  On Windows, this
 118  *      is SOCKET (a typedef for unsigned).  Everywhere else, it's
 119  *      an int.  The error value can't be -1 any more, so it's
 120  *      now JB_INVALID_SOCKET (which is -1 on UNIX, and in
 121  *      Windows it maps to the #define INVALID_SOCKET.)
 122  *
 123  *    - The signature of bind_port has changed.
 124  *
 125  *    Revision 1.21  2002/03/07 03:46:17  oes
 126  *    Fixed compiler warnings
 127  *
 128  *    Revision 1.20  2002/02/20 23:15:13  jongfoster
 129  *    Parsing functions now handle out-of-memory gracefully by returning
 130  *    an error code.
 131  *
 132  *    Revision 1.19  2002/01/17 21:03:47  jongfoster
 133  *    Moving all our URL and URL pattern parsing code to urlmatch.c.
 134  *
 135  *    Revision 1.18  2001/10/26 17:40:23  oes
 136  *    Introduced get_header_value()
 137  *    Removed client_accept()
 138  *
 139  *    Revision 1.17  2001/10/13 12:47:32  joergs
 140  *    Removed client_host, added client_host_adder
 141  *
 142  *    Revision 1.16  2001/10/07 18:50:16  oes
 143  *    Added server_content_encoding, renamed server_transfer_encoding
 144  *
 145  *    Revision 1.15  2001/10/07 18:01:55  oes
 146  *    Changed server_http11 to server_http
 147  *
 148  *    Revision 1.14  2001/10/07 15:45:48  oes
 149  *    added client_accept_encoding, client_te, client_accept_encoding_adder
 150  *
 151  *    renamed content_type and content_length
 152  *
 153  *    fixed client_host and strclean prototypes
 154  *
 155  *    Revision 1.13  2001/09/29 12:56:03  joergs
 156  *    IJB now changes HTTP/1.1 to HTTP/1.0 in requests and answers.
 157  *
 158  *    Revision 1.12  2001/09/13 23:05:50  jongfoster
 159  *    Changing the string paramater to the header parsers a "const".
 160  *
 161  *    Revision 1.11  2001/07/31 14:46:53  oes
 162  *    Added prototype for connection_close_adder
 163  *
 164  *    Revision 1.10  2001/07/30 22:08:36  jongfoster
 165  *    Tidying up #defines:
 166  *    - All feature #defines are now of the form FEATURE_xxx
 167  *    - Permanently turned off WIN_GUI_EDIT
 168  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
 169  *
 170  *    Revision 1.9  2001/07/29 18:43:08  jongfoster
 171  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
 172  *    ANSI C rules.
 173  *
 174  *    Revision 1.8  2001/07/13 14:01:54  oes
 175  *    Removed all #ifdef PCRS
 176  *
 177  *    Revision 1.7  2001/06/29 13:32:14  oes
 178  *    Removed logentry from cancelled commit
 179  *
 180  *    Revision 1.6  2001/06/03 19:12:38  oes
 181  *    deleted const struct interceptors
 182  *
 183  *    Revision 1.5  2001/05/31 21:30:33  jongfoster
 184  *    Removed list code - it's now in list.[ch]
 185  *    Renamed "permission" to "action", and changed many features
 186  *    to use the actions file rather than the global config.
 187  *
 188  *    Revision 1.4  2001/05/27 13:19:06  oes
 189  *    Patched Joergs solution for the content-length in.
 190  *
 191  *    Revision 1.3  2001/05/26 13:39:32  jongfoster
 192  *    Only crunches Content-Length header if applying RE filtering.
 193  *    Without this fix, Microsoft Windows Update wouldn't work.
 194  *
 195  *    Revision 1.2  2001/05/20 01:21:20  jongfoster
 196  *    Version 2.9.4 checkin.
 197  *    - Merged popupfile and cookiefile, and added control over PCRS
 198  *      filtering, in new "permissionsfile".
 199  *    - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
 200  *      file error you now get a message box (in the Win32 GUI) rather
 201  *      than the program exiting with no explanation.
 202  *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
 203  *      skipping.
 204  *    - Removed tabs from "config"
 205  *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
 206  *    - Bumped up version number.
 207  *
 208  *    Revision 1.1.1.1  2001/05/15 13:59:01  oes
 209  *    Initial import of version 2.9.3 source tree
 210  *
 211  *
 212  *********************************************************************/
 213 \f
 214
 215 #include "project.h"
 216
 217 #ifdef __cplusplus
 218 extern "C" {
 219 #endif
 220
 221 extern const struct parsers client_patterns[];
 222 extern const struct parsers server_patterns[];
 223 extern const struct parsers server_patterns_light[];
 224
 225 extern const add_header_func_ptr add_client_headers[];
 226 extern const add_header_func_ptr add_server_headers[];
 227
 228 extern int flush_socket(jb_socket fd, struct client_state *csp);
 229 extern jb_err add_to_iob(struct client_state *csp, char *buf, size_t n);
 230 extern char *get_header(struct client_state *csp);
 231 extern char *get_header_value(const struct list *header_list, const char *header_name);
 232 extern char *sed(const struct parsers pats[], const add_header_func_ptr more_headers[], struct client_state *csp);
 233 extern void get_http_time(int time_offset, char *buf);
 234 extern struct tm *parse_header_time(char *header, time_t *tm);
 235 extern jb_err get_destination_from_headers(const struct list *headers, struct http_request *http);
 236
 237 extern jb_err crumble                (struct client_state *csp, char **header);
 238 extern jb_err client_referrer        (struct client_state *csp, char **header);
 239 extern jb_err client_uagent          (struct client_state *csp, char **header);
 240 extern jb_err client_ua              (struct client_state *csp, char **header);
 241 extern jb_err client_from            (struct client_state *csp, char **header);
 242 extern jb_err client_send_cookie     (struct client_state *csp, char **header);
 243 extern jb_err client_x_forwarded     (struct client_state *csp, char **header);
 244 extern jb_err client_accept_encoding (struct client_state *csp, char **header);
 245 extern jb_err client_te              (struct client_state *csp, char **header);
 246 extern jb_err client_max_forwards    (struct client_state *csp, char **header);
 247 extern jb_err client_host(struct client_state *csp, char **header);
 248 extern jb_err client_if_modified_since(struct client_state *csp, char **header);
 249 extern jb_err client_accept_language  (struct client_state *csp, char **header);
 250 extern jb_err client_if_none_match    (struct client_state *csp, char **header);
 251 extern jb_err crunch_client_header    (struct client_state *csp, char **header);
 252 extern jb_err filter_header           (struct client_state *csp, char **header);
 253 extern jb_err filter_client_header    (struct client_state *csp, char **header);
 254 extern jb_err filter_server_header    (struct client_state *csp, char **header);
 255 extern jb_err client_x_filter         (struct client_state *csp, char **header);
 256
 257
 258 extern jb_err client_host_adder           (struct client_state *csp);
 259 extern jb_err client_cookie_adder         (struct client_state *csp);
 260 extern jb_err client_xtra_adder           (struct client_state *csp);
 261 extern jb_err client_accept_encoding_adder(struct client_state *csp);
 262 extern jb_err client_x_forwarded_adder    (struct client_state *csp);
 263
 264 extern jb_err connection_close_adder      (struct client_state *csp);
 265
 266 extern jb_err server_set_cookie      (struct client_state *csp, char **header);
 267 extern jb_err server_content_type    (struct client_state *csp, char **header);
 268 extern jb_err server_content_length  (struct client_state *csp, char **header);
 269 extern jb_err server_content_md5     (struct client_state *csp, char **header);
 270 extern jb_err server_content_encoding(struct client_state *csp, char **header);
 271 extern jb_err server_transfer_coding (struct client_state *csp, char **header);
 272 extern jb_err server_http            (struct client_state *csp, char **header);
 273 extern jb_err crunch_server_header   (struct client_state *csp, char **header);
 274 extern jb_err server_last_modified   (struct client_state *csp, char **header);
 275 extern jb_err server_content_disposition(struct client_state *csp, char **header);
 276
 277 #ifdef FEATURE_FORCE_LOAD
 278 extern int strclean(const char *string, const char *substring);
 279 #endif /* def FEATURE_FORCE_LOAD */
 280
 281 /* Revision control strings from this header and associated .c file */
 282 extern const char parsers_rcs[];
 283 extern const char parsers_h_rcs[];
 284
 285 extern int debug;
 286
 287 #ifdef __cplusplus
 288 } /* extern "C" */
 289 #endif
 290
 291 #endif /* ndef PARSERS_H_INCLUDED */
 292
 293 /*
 294   Local Variables:
 295   tab-width: 3
 296   end:
 297 */