urlmatch.h

   1 #ifndef URLMATCH_H_INCLUDED
   2 #define URLMATCH_H_INCLUDED
   3 #define URLMATCH_H_VERSION "$Id: urlmatch.h,v 1.11 2008/05/04 13:30:55 fabiankeil Exp $"
   4 /*********************************************************************
   5  *
   6  * File        :  $Source: /cvsroot/ijbswa/current/urlmatch.h,v $
   7  *
   8  * Purpose     :  Declares functions to match URLs against URL
   9  *                patterns.
  10  *
  11  * Copyright   :  Written by and Copyright (C) 2001-2002, 2006 the SourceForge
  12  *                Privoxy team. http://www.privoxy.org/
  13  *
  14  *                Based on the Internet Junkbuster originally written
  15  *                by and Copyright (C) 1997 Anonymous Coders and
  16  *                Junkbusters Corporation.  http://www.junkbusters.com
  17  *
  18  *                This program is free software; you can redistribute it
  19  *                and/or modify it under the terms of the GNU General
  20  *                Public License as published by the Free Software
  21  *                Foundation; either version 2 of the License, or (at
  22  *                your option) any later version.
  23  *
  24  *                This program is distributed in the hope that it will
  25  *                be useful, but WITHOUT ANY WARRANTY; without even the
  26  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  27  *                PARTICULAR PURPOSE.  See the GNU General Public
  28  *                License for more details.
  29  *
  30  *                The GNU General Public License should be included with
  31  *                this file.  If not, you can view it at
  32  *                http://www.gnu.org/copyleft/gpl.html
  33  *                or write to the Free Software Foundation, Inc., 59
  34  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  35  *
  36  * Revisions   :
  37  *    $Log: urlmatch.h,v $
  38  *    Revision 1.11  2008/05/04 13:30:55  fabiankeil
  39  *    Streamline parse_http_url()'s prototype.
  40  *
  41  *    Revision 1.10  2008/04/14 18:11:21  fabiankeil
  42  *    The compiler might not notice it, but the buffer passed to
  43  *    create_url_spec() is modified later on and thus shouldn't
  44  *    be declared immutable.
  45  *
  46  *    Revision 1.9  2008/04/08 16:07:39  fabiankeil
  47  *    Make it harder to mistake url_match()'s
  48  *    second parameter for an url_spec.
  49  *
  50  *    Revision 1.8  2007/09/02 15:31:20  fabiankeil
  51  *    Move match_portlist() from filter.c to urlmatch.c.
  52  *    It's used for url matching, not for filtering.
  53  *
  54  *    Revision 1.7  2007/01/06 14:24:38  fabiankeil
  55  *    Mark *csp as immutable for parse_http_url()
  56  *    and url_match().
  57  *
  58  *    Revision 1.6  2006/12/06 19:12:43  fabiankeil
  59  *    Added prototype for init_domain_components().
  60  *
  61  *    Revision 1.5  2006/07/18 14:48:47  david__schmidt
  62  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
  63  *    with what was really the latest development (the v_3_0_branch branch)
  64  *
  65  *    Revision 1.3  2002/03/26 22:29:55  swa
  66  *    we have a new homepage!
  67  *
  68  *    Revision 1.2  2002/03/24 13:25:43  swa
  69  *    name change related issues
  70  *
  71  *    Revision 1.1  2002/01/17 20:53:46  jongfoster
  72  *    Moving all our URL and URL pattern parsing code to the same file - it
  73  *    was scattered around in filters.c, loaders.c and parsers.c.
  74  *
  75  *    Providing a single, simple url_match(pattern,url) function - rather than
  76  *    the 3-line match routine which was repeated all over the place.
  77  *
  78  *    Renaming free_url to free_url_spec, since it frees a struct url_spec.
  79  *
  80  *    Providing parse_http_url() so that URLs can be parsed without faking a
  81  *    HTTP request line for parse_http_request() or repeating the parsing
  82  *    code (both of which were techniques that were actually in use).
  83  *
  84  *    Standardizing that struct http_request is used to represent a URL, and
  85  *    struct url_spec is used to represent a URL pattern.  (Before, URLs were
  86  *    represented as seperate variables and a partially-filled-in url_spec).
  87  *
  88  *
  89  *********************************************************************/
  90 \f
  91
  92 #include "project.h"
  93
  94 #ifdef __cplusplus
  95 extern "C" {
  96 #endif
  97
  98 extern void free_http_request(struct http_request *http);
  99 extern jb_err init_domain_components(struct http_request *http);
 100 extern jb_err parse_http_request(const char *req,
 101                                  struct http_request *http,
 102                                  const struct client_state *csp);
 103 extern jb_err parse_http_url(const char *url,
 104                              struct http_request *http,
 105                              int require_protocol);
 106 #define REQUIRE_PROTOCOL 1
 107
 108 extern int url_match(const struct url_spec *pattern,
 109                      const struct http_request *http);
 110
 111 extern jb_err create_url_spec(struct url_spec *url, char *buf);
 112 extern void free_url_spec(struct url_spec *url);
 113 extern int match_portlist(const char *portlist, int port);
 114
 115
 116 /* Revision control strings from this header and associated .c file */
 117 extern const char urlmatch_rcs[];
 118 extern const char urlmatch_h_rcs[];
 119
 120 #ifdef __cplusplus
 121 } /* extern "C" */
 122 #endif
 123
 124 #endif /* ndef URLMATCH_H_INCLUDED */
 125
 126 /*
 127   Local Variables:
 128   tab-width: 3
 129   end:
 130 */