parsers.h

   1 #ifndef PARSERS_H_INCLUDED
   2 #define PARSERS_H_INCLUDED
   3 #define PARSERS_H_VERSION "$Id: parsers.h,v 1.28 2006/07/18 14:48:47 david__schmidt 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.28  2006/07/18 14:48:47  david__schmidt
  47  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
  48  *    with what was really the latest development (the v_3_0_branch branch)
  49  *
  50  *    Revision 1.26.2.1  2002/09/25 14:52:46  oes
  51  *    Added basic support for OPTIONS and TRACE HTTP methods:
  52  *     - New parser function client_max_forwards which decrements
  53  *       the Max-Forwards HTTP header field of OPTIONS and TRACE
  54  *       requests by one before forwarding
  55  *     - New parser function client_host which extracts the host
  56  *       and port information from the HTTP header field if the
  57  *       request URI was not absolute
  58  *     - Don't crumble and re-add the Host: header, but only generate
  59  *       and append if missing
  60  *
  61  *    Revision 1.26  2002/05/08 15:59:53  oes
  62  *    Changed add_to_iob signature (now returns jb_err)
  63  *
  64  *    Revision 1.25  2002/03/26 22:29:55  swa
  65  *    we have a new homepage!
  66  *
  67  *    Revision 1.24  2002/03/24 13:25:43  swa
  68  *    name change related issues
  69  *
  70  *    Revision 1.23  2002/03/13 00:27:05  jongfoster
  71  *    Killing warnings
  72  *
  73  *    Revision 1.22  2002/03/09 20:03:52  jongfoster
  74  *    - Making various functions return int rather than size_t.
  75  *      (Undoing a recent change).  Since size_t is unsigned on
  76  *      Windows, functions like read_socket that return -1 on
  77  *      error cannot return a size_t.
  78  *
  79  *      THIS WAS A MAJOR BUG - it caused frequent, unpredictable
  80  *      crashes, and also frequently caused JB to jump to 100%
  81  *      CPU and stay there.  (Because it thought it had just
  82  *      read ((unsigned)-1) == 4Gb of data...)
  83  *
  84  *    - The signature of write_socket has changed, it now simply
  85  *      returns success=0/failure=nonzero.
  86  *
  87  *    - Trying to get rid of a few warnings --with-debug on
  88  *      Windows, I've introduced a new type "jb_socket".  This is
  89  *      used for the socket file descriptors.  On Windows, this
  90  *      is SOCKET (a typedef for unsigned).  Everywhere else, it's
  91  *      an int.  The error value can't be -1 any more, so it's
  92  *      now JB_INVALID_SOCKET (which is -1 on UNIX, and in
  93  *      Windows it maps to the #define INVALID_SOCKET.)
  94  *
  95  *    - The signature of bind_port has changed.
  96  *
  97  *    Revision 1.21  2002/03/07 03:46:17  oes
  98  *    Fixed compiler warnings
  99  *
 100  *    Revision 1.20  2002/02/20 23:15:13  jongfoster
 101  *    Parsing functions now handle out-of-memory gracefully by returning
 102  *    an error code.
 103  *
 104  *    Revision 1.19  2002/01/17 21:03:47  jongfoster
 105  *    Moving all our URL and URL pattern parsing code to urlmatch.c.
 106  *
 107  *    Revision 1.18  2001/10/26 17:40:23  oes
 108  *    Introduced get_header_value()
 109  *    Removed client_accept()
 110  *
 111  *    Revision 1.17  2001/10/13 12:47:32  joergs
 112  *    Removed client_host, added client_host_adder
 113  *
 114  *    Revision 1.16  2001/10/07 18:50:16  oes
 115  *    Added server_content_encoding, renamed server_transfer_encoding
 116  *
 117  *    Revision 1.15  2001/10/07 18:01:55  oes
 118  *    Changed server_http11 to server_http
 119  *
 120  *    Revision 1.14  2001/10/07 15:45:48  oes
 121  *    added client_accept_encoding, client_te, client_accept_encoding_adder
 122  *
 123  *    renamed content_type and content_length
 124  *
 125  *    fixed client_host and strclean prototypes
 126  *
 127  *    Revision 1.13  2001/09/29 12:56:03  joergs
 128  *    IJB now changes HTTP/1.1 to HTTP/1.0 in requests and answers.
 129  *
 130  *    Revision 1.12  2001/09/13 23:05:50  jongfoster
 131  *    Changing the string paramater to the header parsers a "const".
 132  *
 133  *    Revision 1.11  2001/07/31 14:46:53  oes
 134  *    Added prototype for connection_close_adder
 135  *
 136  *    Revision 1.10  2001/07/30 22:08:36  jongfoster
 137  *    Tidying up #defines:
 138  *    - All feature #defines are now of the form FEATURE_xxx
 139  *    - Permanently turned off WIN_GUI_EDIT
 140  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
 141  *
 142  *    Revision 1.9  2001/07/29 18:43:08  jongfoster
 143  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
 144  *    ANSI C rules.
 145  *
 146  *    Revision 1.8  2001/07/13 14:01:54  oes
 147  *    Removed all #ifdef PCRS
 148  *
 149  *    Revision 1.7  2001/06/29 13:32:14  oes
 150  *    Removed logentry from cancelled commit
 151  *
 152  *    Revision 1.6  2001/06/03 19:12:38  oes
 153  *    deleted const struct interceptors
 154  *
 155  *    Revision 1.5  2001/05/31 21:30:33  jongfoster
 156  *    Removed list code - it's now in list.[ch]
 157  *    Renamed "permission" to "action", and changed many features
 158  *    to use the actions file rather than the global config.
 159  *
 160  *    Revision 1.4  2001/05/27 13:19:06  oes
 161  *    Patched Joergs solution for the content-length in.
 162  *
 163  *    Revision 1.3  2001/05/26 13:39:32  jongfoster
 164  *    Only crunches Content-Length header if applying RE filtering.
 165  *    Without this fix, Microsoft Windows Update wouldn't work.
 166  *
 167  *    Revision 1.2  2001/05/20 01:21:20  jongfoster
 168  *    Version 2.9.4 checkin.
 169  *    - Merged popupfile and cookiefile, and added control over PCRS
 170  *      filtering, in new "permissionsfile".
 171  *    - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
 172  *      file error you now get a message box (in the Win32 GUI) rather
 173  *      than the program exiting with no explanation.
 174  *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
 175  *      skipping.
 176  *    - Removed tabs from "config"
 177  *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
 178  *    - Bumped up version number.
 179  *
 180  *    Revision 1.1.1.1  2001/05/15 13:59:01  oes
 181  *    Initial import of version 2.9.3 source tree
 182  *
 183  *
 184  *********************************************************************/
 185 \f
 186
 187 #include "project.h"
 188
 189 #ifdef __cplusplus
 190 extern "C" {
 191 #endif
 192
 193 extern const struct parsers client_patterns[];
 194 extern const struct parsers server_patterns[];
 195 extern const struct parsers server_patterns_light[];
 196
 197 extern const add_header_func_ptr add_client_headers[];
 198 extern const add_header_func_ptr add_server_headers[];
 199
 200 extern int flush_socket(jb_socket fd, struct client_state *csp);
 201 extern jb_err add_to_iob(struct client_state *csp, char *buf, int n);
 202 extern char *get_header(struct client_state *csp);
 203 extern char *get_header_value(const struct list *header_list, const char *header_name);
 204 extern char *sed(const struct parsers pats[], const add_header_func_ptr more_headers[], struct client_state *csp);
 205 extern void get_http_time(int time_offset, char *buf);
 206
 207 extern jb_err crumble                (struct client_state *csp, char **header);
 208 extern jb_err client_referrer        (struct client_state *csp, char **header);
 209 extern jb_err client_uagent          (struct client_state *csp, char **header);
 210 extern jb_err client_ua              (struct client_state *csp, char **header);
 211 extern jb_err client_from            (struct client_state *csp, char **header);
 212 extern jb_err client_send_cookie     (struct client_state *csp, char **header);
 213 extern jb_err client_x_forwarded     (struct client_state *csp, char **header);
 214 extern jb_err client_accept_encoding (struct client_state *csp, char **header);
 215 extern jb_err client_te              (struct client_state *csp, char **header);
 216 extern jb_err client_max_forwards    (struct client_state *csp, char **header);
 217 extern jb_err client_host(struct client_state *csp, char **header);
 218 extern jb_err client_if_modified_since(struct client_state *csp, char **header);
 219 extern jb_err client_accept_language  (struct client_state *csp, char **header);
 220 extern jb_err client_if_none_match    (struct client_state *csp, char **header);
 221 extern jb_err crunch_client_header    (struct client_state *csp, char **header);
 222 extern jb_err filter_header           (struct client_state *csp, char **header);
 223 extern jb_err client_x_filter         (struct client_state *csp, char **header);
 224
 225
 226 extern jb_err client_host_adder           (struct client_state *csp);
 227 extern jb_err client_cookie_adder         (struct client_state *csp);
 228 extern jb_err client_xtra_adder           (struct client_state *csp);
 229 extern jb_err client_accept_encoding_adder(struct client_state *csp);
 230 extern jb_err client_x_forwarded_adder    (struct client_state *csp);
 231
 232 extern jb_err connection_close_adder      (struct client_state *csp);
 233
 234 extern jb_err server_set_cookie      (struct client_state *csp, char **header);
 235 extern jb_err server_content_type    (struct client_state *csp, char **header);
 236 extern jb_err server_content_length  (struct client_state *csp, char **header);
 237 extern jb_err server_content_md5     (struct client_state *csp, char **header);
 238 extern jb_err server_content_encoding(struct client_state *csp, char **header);
 239 extern jb_err server_transfer_coding (struct client_state *csp, char **header);
 240 extern jb_err server_http            (struct client_state *csp, char **header);
 241 extern jb_err crunch_server_header   (struct client_state *csp, char **header);
 242 extern jb_err server_last_modified   (struct client_state *csp, char **header);
 243 extern jb_err server_content_disposition(struct client_state *csp, char **header);
 244
 245 #ifdef FEATURE_FORCE_LOAD
 246 extern int strclean(const char *string, const char *substring);
 247 #endif /* def FEATURE_FORCE_LOAD */
 248
 249 /* Revision control strings from this header and associated .c file */
 250 extern const char parsers_rcs[];
 251 extern const char parsers_h_rcs[];
 252
 253 extern int debug;
 254
 255 #ifdef __cplusplus
 256 } /* extern "C" */
 257 #endif
 258
 259 #endif /* ndef PARSERS_H_INCLUDED */
 260
 261 /*
 262   Local Variables:
 263   tab-width: 3
 264   end:
 265 */