parsers.h

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