parsers.h

   1 #ifndef PARSERS_H_INCLUDED
   2 #define PARSERS_H_INCLUDED
   3 #define PARSERS_H_VERSION "$Id: parsers.h,v 1.43 2008/05/10 13:23:38 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.43  2008/05/10 13:23:38  fabiankeil
  47  *    Don't provide get_header() with the whole client state
  48  *    structure when it only needs access to csp->iob.
  49  *
  50  *    Revision 1.42  2008/04/17 14:40:49  fabiankeil
  51  *    Provide get_http_time() with the buffer size so it doesn't
  52  *    have to blindly assume that the buffer is big enough.
  53  *
  54  *    Revision 1.41  2008/04/16 16:38:21  fabiankeil
  55  *    Don't pass the whole csp structure to flush_socket()
  56  *    when it only needs a file descriptor and a buffer.
  57  *
  58  *    Revision 1.40  2007/08/11 14:47:26  fabiankeil
  59  *    Remove the prototypes for functions that are only
  60  *    used in parsers.c and thus should be static.
  61  *
  62  *    Revision 1.39  2007/06/01 16:31:55  fabiankeil
  63  *    Change sed() to return a jb_err in preparation for forward-override{}.
  64  *
  65  *    Revision 1.38  2007/03/25 14:27:11  fabiankeil
  66  *    Let parse_header_time() return a jb_err code
  67  *    instead of a pointer that can only be used to
  68  *    check for NULL anyway.
  69  *
  70  *    Revision 1.37  2007/03/20 15:22:17  fabiankeil
  71  *    - Remove filter_client_header() and filter_client_header(),
  72  *      filter_header() now checks the shiny new
  73  *      CSP_FLAG_CLIENT_HEADER_PARSING_DONE flag instead.
  74  *
  75  *    Revision 1.36  2007/03/05 13:25:32  fabiankeil
  76  *    - Cosmetical changes for LOG_LEVEL_RE_FILTER messages.
  77  *    - Handle "Cookie:" and "Connection:" headers a bit smarter
  78  *      (don't crunch them just to recreate them later on).
  79  *    - Add another non-standard time format for the cookie
  80  *      expiration date detection.
  81  *    - Fix a valgrind warning.
  82  *
  83  *    Revision 1.35  2007/01/01 19:36:37  fabiankeil
  84  *    Integrate a modified version of Wil Mahan's
  85  *    zlib patch (PR #895531).
  86  *
  87  *    Revision 1.34  2006/12/29 19:08:22  fabiankeil
  88  *    Reverted parts of my last commit
  89  *    to keep error handling working.
  90  *
  91  *    Revision 1.33  2006/12/29 18:04:40  fabiankeil
  92  *    Fixed gcc43 conversion warnings.
  93  *
  94  *    Revision 1.32  2006/12/06 19:14:23  fabiankeil
  95  *    Added prototype for get_destination_from_headers().
  96  *
  97  *    Revision 1.31  2006/08/17 17:15:10  fabiankeil
  98  *    - Back to timegm() using GnuPG's replacement if necessary.
  99  *      Using mktime() and localtime() could add a on hour offset if
 100  *      the randomize factor was big enough to lead to a summer/wintertime
 101  *      switch.
 102  *
 103  *    - Removed now-useless Privoxy 3.0.3 compatibility glue.
 104  *
 105  *    - Moved randomization code into pick_from_range().
 106  *
 107  *    - Changed parse_header_time definition.
 108  *      time_t isn't guaranteed to be signed and
 109  *      if it isn't, -1 isn't available as error code.
 110  *      Changed some variable types in client_if_modified_since()
 111  *      because of the same reason.
 112  *
 113  *    Revision 1.30  2006/08/14 08:25:19  fabiankeil
 114  *    Split filter-headers{} into filter-client-headers{}
 115  *    and filter-server-headers{}.
 116  *    Added parse_header_time() to share some code.
 117  *    Replaced timegm() with mktime().
 118  *
 119  *    Revision 1.29  2006/08/03 02:46:41  david__schmidt
 120  *    Incorporate Fabian Keil's patch work:\rhttp://www.fabiankeil.de/sourcecode/privoxy/
 121  *
 122  *    Revision 1.28  2006/07/18 14:48:47  david__schmidt
 123  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
 124  *    with what was really the latest development (the v_3_0_branch branch)
 125  *
 126  *    Revision 1.26.2.1  2002/09/25 14:52:46  oes
 127  *    Added basic support for OPTIONS and TRACE HTTP methods:
 128  *     - New parser function client_max_forwards which decrements
 129  *       the Max-Forwards HTTP header field of OPTIONS and TRACE
 130  *       requests by one before forwarding
 131  *     - New parser function client_host which extracts the host
 132  *       and port information from the HTTP header field if the
 133  *       request URI was not absolute
 134  *     - Don't crumble and re-add the Host: header, but only generate
 135  *       and append if missing
 136  *
 137  *    Revision 1.26  2002/05/08 15:59:53  oes
 138  *    Changed add_to_iob signature (now returns jb_err)
 139  *
 140  *    Revision 1.25  2002/03/26 22:29:55  swa
 141  *    we have a new homepage!
 142  *
 143  *    Revision 1.24  2002/03/24 13:25:43  swa
 144  *    name change related issues
 145  *
 146  *    Revision 1.23  2002/03/13 00:27:05  jongfoster
 147  *    Killing warnings
 148  *
 149  *    Revision 1.22  2002/03/09 20:03:52  jongfoster
 150  *    - Making various functions return int rather than size_t.
 151  *      (Undoing a recent change).  Since size_t is unsigned on
 152  *      Windows, functions like read_socket that return -1 on
 153  *      error cannot return a size_t.
 154  *
 155  *      THIS WAS A MAJOR BUG - it caused frequent, unpredictable
 156  *      crashes, and also frequently caused JB to jump to 100%
 157  *      CPU and stay there.  (Because it thought it had just
 158  *      read ((unsigned)-1) == 4Gb of data...)
 159  *
 160  *    - The signature of write_socket has changed, it now simply
 161  *      returns success=0/failure=nonzero.
 162  *
 163  *    - Trying to get rid of a few warnings --with-debug on
 164  *      Windows, I've introduced a new type "jb_socket".  This is
 165  *      used for the socket file descriptors.  On Windows, this
 166  *      is SOCKET (a typedef for unsigned).  Everywhere else, it's
 167  *      an int.  The error value can't be -1 any more, so it's
 168  *      now JB_INVALID_SOCKET (which is -1 on UNIX, and in
 169  *      Windows it maps to the #define INVALID_SOCKET.)
 170  *
 171  *    - The signature of bind_port has changed.
 172  *
 173  *    Revision 1.21  2002/03/07 03:46:17  oes
 174  *    Fixed compiler warnings
 175  *
 176  *    Revision 1.20  2002/02/20 23:15:13  jongfoster
 177  *    Parsing functions now handle out-of-memory gracefully by returning
 178  *    an error code.
 179  *
 180  *    Revision 1.19  2002/01/17 21:03:47  jongfoster
 181  *    Moving all our URL and URL pattern parsing code to urlmatch.c.
 182  *
 183  *    Revision 1.18  2001/10/26 17:40:23  oes
 184  *    Introduced get_header_value()
 185  *    Removed client_accept()
 186  *
 187  *    Revision 1.17  2001/10/13 12:47:32  joergs
 188  *    Removed client_host, added client_host_adder
 189  *
 190  *    Revision 1.16  2001/10/07 18:50:16  oes
 191  *    Added server_content_encoding, renamed server_transfer_encoding
 192  *
 193  *    Revision 1.15  2001/10/07 18:01:55  oes
 194  *    Changed server_http11 to server_http
 195  *
 196  *    Revision 1.14  2001/10/07 15:45:48  oes
 197  *    added client_accept_encoding, client_te, client_accept_encoding_adder
 198  *
 199  *    renamed content_type and content_length
 200  *
 201  *    fixed client_host and strclean prototypes
 202  *
 203  *    Revision 1.13  2001/09/29 12:56:03  joergs
 204  *    IJB now changes HTTP/1.1 to HTTP/1.0 in requests and answers.
 205  *
 206  *    Revision 1.12  2001/09/13 23:05:50  jongfoster
 207  *    Changing the string paramater to the header parsers a "const".
 208  *
 209  *    Revision 1.11  2001/07/31 14:46:53  oes
 210  *    Added prototype for connection_close_adder
 211  *
 212  *    Revision 1.10  2001/07/30 22:08:36  jongfoster
 213  *    Tidying up #defines:
 214  *    - All feature #defines are now of the form FEATURE_xxx
 215  *    - Permanently turned off WIN_GUI_EDIT
 216  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
 217  *
 218  *    Revision 1.9  2001/07/29 18:43:08  jongfoster
 219  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
 220  *    ANSI C rules.
 221  *
 222  *    Revision 1.8  2001/07/13 14:01:54  oes
 223  *    Removed all #ifdef PCRS
 224  *
 225  *    Revision 1.7  2001/06/29 13:32:14  oes
 226  *    Removed logentry from cancelled commit
 227  *
 228  *    Revision 1.6  2001/06/03 19:12:38  oes
 229  *    deleted const struct interceptors
 230  *
 231  *    Revision 1.5  2001/05/31 21:30:33  jongfoster
 232  *    Removed list code - it's now in list.[ch]
 233  *    Renamed "permission" to "action", and changed many features
 234  *    to use the actions file rather than the global config.
 235  *
 236  *    Revision 1.4  2001/05/27 13:19:06  oes
 237  *    Patched Joergs solution for the content-length in.
 238  *
 239  *    Revision 1.3  2001/05/26 13:39:32  jongfoster
 240  *    Only crunches Content-Length header if applying RE filtering.
 241  *    Without this fix, Microsoft Windows Update wouldn't work.
 242  *
 243  *    Revision 1.2  2001/05/20 01:21:20  jongfoster
 244  *    Version 2.9.4 checkin.
 245  *    - Merged popupfile and cookiefile, and added control over PCRS
 246  *      filtering, in new "permissionsfile".
 247  *    - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
 248  *      file error you now get a message box (in the Win32 GUI) rather
 249  *      than the program exiting with no explanation.
 250  *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
 251  *      skipping.
 252  *    - Removed tabs from "config"
 253  *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
 254  *    - Bumped up version number.
 255  *
 256  *    Revision 1.1.1.1  2001/05/15 13:59:01  oes
 257  *    Initial import of version 2.9.3 source tree
 258  *
 259  *
 260  *********************************************************************/
 261 \f
 262
 263 #include "project.h"
 264
 265 #ifdef __cplusplus
 266 extern "C" {
 267 #endif
 268
 269 /**
 270  * List of functions to run on a list of headers.
 271  * XXX: make parsers local to parsers.c.
 272  */
 273 struct parsers
 274 {
 275    /** The header prefix to match */
 276    const char *str;
 277
 278    /** The length of the prefix to match */
 279    const size_t len;
 280
 281    /** The function to apply to this line */
 282    const parser_func_ptr parser;
 283 };
 284
 285 extern const struct parsers client_patterns[];
 286 extern const struct parsers server_patterns[];
 287 extern const struct parsers server_patterns_light[];
 288
 289 extern const add_header_func_ptr add_client_headers[];
 290 extern const add_header_func_ptr add_server_headers[];
 291
 292 extern int flush_socket(jb_socket fd, struct iob *iob);
 293 extern jb_err add_to_iob(struct client_state *csp, char *buf, int n);
 294 extern jb_err decompress_iob(struct client_state *csp);
 295 extern char *get_header(struct iob *iob);
 296 extern char *get_header_value(const struct list *header_list, const char *header_name);
 297 extern jb_err sed(const struct parsers pats[], const add_header_func_ptr more_headers[], struct client_state *csp);
 298 extern void get_http_time(int time_offset, char *buf, size_t buffer_size);
 299 extern jb_err get_destination_from_headers(const struct list *headers, struct http_request *http);
 300
 301 #ifdef FEATURE_FORCE_LOAD
 302 extern int strclean(const char *string, const char *substring);
 303 #endif /* def FEATURE_FORCE_LOAD */
 304
 305 /* Revision control strings from this header and associated .c file */
 306 extern const char parsers_rcs[];
 307 extern const char parsers_h_rcs[];
 308
 309 extern int debug;
 310
 311 #ifdef __cplusplus
 312 } /* extern "C" */
 313 #endif
 314
 315 #endif /* ndef PARSERS_H_INCLUDED */
 316
 317 /*
 318   Local Variables:
 319   tab-width: 3
 320   end:
 321 */