Make it harder to mistake url_match()'s
[privoxy.git] / urlmatch.h
1 #ifndef URLMATCH_H_INCLUDED
2 #define URLMATCH_H_INCLUDED
3 #define URLMATCH_H_VERSION "$Id: urlmatch.h,v 1.8 2007/09/02 15:31:20 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.8  2007/09/02 15:31:20  fabiankeil
39  *    Move match_portlist() from filter.c to urlmatch.c.
40  *    It's used for url matching, not for filtering.
41  *
42  *    Revision 1.7  2007/01/06 14:24:38  fabiankeil
43  *    Mark *csp as immutable for parse_http_url()
44  *    and url_match().
45  *
46  *    Revision 1.6  2006/12/06 19:12:43  fabiankeil
47  *    Added prototype for init_domain_components().
48  *
49  *    Revision 1.5  2006/07/18 14:48:47  david__schmidt
50  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
51  *    with what was really the latest development (the v_3_0_branch branch)
52  *
53  *    Revision 1.3  2002/03/26 22:29:55  swa
54  *    we have a new homepage!
55  *
56  *    Revision 1.2  2002/03/24 13:25:43  swa
57  *    name change related issues
58  *
59  *    Revision 1.1  2002/01/17 20:53:46  jongfoster
60  *    Moving all our URL and URL pattern parsing code to the same file - it
61  *    was scattered around in filters.c, loaders.c and parsers.c.
62  *
63  *    Providing a single, simple url_match(pattern,url) function - rather than
64  *    the 3-line match routine which was repeated all over the place.
65  *
66  *    Renaming free_url to free_url_spec, since it frees a struct url_spec.
67  *
68  *    Providing parse_http_url() so that URLs can be parsed without faking a
69  *    HTTP request line for parse_http_request() or repeating the parsing
70  *    code (both of which were techniques that were actually in use).
71  *
72  *    Standardizing that struct http_request is used to represent a URL, and
73  *    struct url_spec is used to represent a URL pattern.  (Before, URLs were
74  *    represented as seperate variables and a partially-filled-in url_spec).
75  *
76  *
77  *********************************************************************/
78 \f
79
80 #include "project.h"
81
82 #ifdef __cplusplus
83 extern "C" {
84 #endif
85
86 extern void free_http_request(struct http_request *http);
87 extern jb_err init_domain_components(struct http_request *http);
88 extern jb_err parse_http_request(const char *req,
89                                  struct http_request *http,
90                                  const struct client_state *csp);
91 extern jb_err parse_http_url(const char * url,
92                              struct http_request *http,
93                              const struct client_state *csp);
94
95 extern int url_match(const struct url_spec *pattern,
96                      const struct http_request *http);
97
98 extern jb_err create_url_spec(struct url_spec * url, const char * buf);
99 extern void free_url_spec(struct url_spec *url);
100 extern int match_portlist(const char *portlist, int port);
101
102
103 /* Revision control strings from this header and associated .c file */
104 extern const char urlmatch_rcs[];
105 extern const char urlmatch_h_rcs[];
106
107 #ifdef __cplusplus
108 } /* extern "C" */
109 #endif
110
111 #endif /* ndef URLMATCH_H_INCLUDED */
112
113 /*
114   Local Variables:
115   tab-width: 3
116   end:
117 */