parsers.h

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