1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2000 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* Portions of this software are based upon public domain software
* originally written at the National Center for Supercomputing Applications,
* University of Illinois, Urbana-Champaign.
*/
/*
* util_uri.h: External Interface of util_uri.c
*/
#ifndef UTIL_URI_H
#define UTIL_URI_H
#ifdef __cplusplus
extern "C" {
#endif
/**
* @package Apache URI library
*/
typedef struct schemes_t schemes_t;
/** Structure to store various schemes and their default ports */
struct schemes_t {
/** The name of the scheme */
const char *name;
/** The default port for the scheme */
apr_port_t default_port;
};
#define DEFAULT_FTP_DATA_PORT 20
#define DEFAULT_FTP_PORT 21
#define DEFAULT_GOPHER_PORT 70
#define DEFAULT_NNTP_PORT 119
#define DEFAULT_WAIS_PORT 210
#define DEFAULT_SNEWS_PORT 563
#define DEFAULT_PROSPERO_PORT 1525 /* WARNING: conflict w/Oracle */
/* Flags passed to unparse_uri_components(): */
#define UNP_OMITSITEPART (1U<<0) /* suppress "scheme://user@site:port" */
#define UNP_OMITUSER (1U<<1) /* Just omit user */
#define UNP_OMITPASSWORD (1U<<2) /* Just omit password */
#define UNP_OMITUSERINFO (UNP_OMITUSER|UNP_OMITPASSWORD) /* omit "user:password@" part */
#define UNP_REVEALPASSWORD (1U<<3) /* Show plain text password (default: show XXXXXXXX) */
#define UNP_OMITPATHINFO (1U<<4) /* Show "scheme://user@site:port" only */
#define UNP_OMITQUERY (1U<<5) /* Omit the "?queryarg" from the path */
typedef struct uri_components uri_components;
/**
* A structure to encompass all of the fields in a uri
*/
struct uri_components {
/** scheme ("http"/"ftp"/...) */
char *scheme;
/** combined [user[:password]@]host[:port] */
char *hostinfo;
/** user name, as in http://user:passwd@host:port/ */
char *user;
/** password, as in http://user:passwd@host:port/ */
char *password;
/** hostname from URI (or from Host: header) */
char *hostname;
/** port string (integer representation is in "port") */
char *port_str;
/** the request path (or "/" if only scheme://host was given) */
char *path;
/** Everything after a '?' in the path, if present */
char *query;
/** Trailing "#fragment" string, if present */
char *fragment;
/** structure returned from gethostbyname()
* @defvar struct hostent *hostent */
struct hostent *hostent;
/** The port number, numeric, valid only if port_str != NULL */
apr_port_t port;
/** has the structure been initialized */
unsigned is_initialized:1;
/** has the DNS been looked up yet */
unsigned dns_looked_up:1;
/** has the dns been resolved yet */
unsigned dns_resolved:1;
};
/* util_uri.c */
/**
* Return the default port for a given scheme. The schemes recognized are
* http, ftp, https, gopher, wais, nntp, snews, and prospero
* @param scheme_str The string that contains the current scheme
* @return The default port for this scheme
* @deffunc apr_port_t ap_default_port_for_scheme(const char *scheme_str)
*/
AP_DECLARE(apr_port_t) ap_default_port_for_scheme(const char *scheme_str);
/**
* Return the default for the current request
* @param r The current request
* @return The default port
* @deffunc apr_port_t ap_default_port_for_request(const request_rec *r)
*/
AP_DECLARE(apr_port_t) ap_default_port_for_request(const request_rec *r);
/**
* Create a copy of a "struct hostent" record; it was presumably returned
* from a call to gethostbyname() and lives in static storage.
* By creating a copy we can tuck it away for later use.
* @param p Pool to allocate out of
* @param hp hostent to duplicate
* @deffunc struct hostent * ap_pduphostent(apr_pool_t *p, const struct hostent *hp)
*/
AP_DECLARE(struct hostent *) ap_pduphostent(apr_pool_t *p, const struct hostent *hp);
/**
* resolve hostname, if successful return an ALLOCATED COPY OF the hostent
* structure, intended to be stored and used later.
* @param p The pool to allocate out of
* @param hostname The hostname to resolve
* @return The allocated hostent structure
* @deffunc struct hostent * ap_pgethostbyname(apr_pool_t *p, const char *hostname)
*/
AP_DECLARE(struct hostent *) ap_pgethostbyname(apr_pool_t *p, const char *hostname);
/**
* Unparse a uri_components structure to an URI string. Optionally suppress
* the password for security reasons.
* @param p The pool to allocate out of
* @param uri_components All of the parts of the uri
* @param flags How to unparse the uri. One of:
* <PRE>
* UNP_OMITSITEPART suppress "scheme://user@site:port"
* UNP_OMITUSER Just omit user
* UNP_OMITPASSWORD Just omit password
* UNP_OMITUSERINFO omit "user:password@" part
* UNP_REVEALPASSWORD Show plain text password (default: show XXXXXXXX)
* UNP_OMITPATHINFO Show "scheme://user@site:port" only
* UNP_OMITQUERY Omit the "?queryarg" from the path
* </PRE>
* @return The uri as a string
* @deffunc char * ap_unparse_uri_components(apr_pool_t *p, const uri_components *uptr, unsigned flags)
*/
AP_DECLARE(char *) ap_unparse_uri_components(apr_pool_t *p, const uri_components *uptr,
unsigned flags);
/**
* Parse a given URI, fill in all supplied fields of a uri_components
* structure. This eliminates the necessity of extracting host, port,
* path, query info repeatedly in the modules.
* @param p The pool to allocate out of
* @param uri The uri to parse
* @param uptr The uri_components to fill out
* @return An HTTP status code
* @deffunc int ap_parse_uri_components(apr_pool_t *p, const char *uri, uri_components *uptr)
*/
AP_DECLARE(int) ap_parse_uri_components(apr_pool_t *p, const char *uri, uri_components *uptr);
/**
* Special case for CONNECT parsing: it comes with the hostinfo part only
* @param p The pool to allocate out of
* @param hostinfo The hostinfo string to parse
* @param uptr The uri_components to fill out
* @return An HTTP status code
* @deffunc int ap_parse_hostinfo_components(apr_pool_t *p, const char *hostinfo, uri_components *uptr)
*/
AP_DECLARE(int) ap_parse_hostinfo_components(apr_pool_t *p, const char *hostinfo, uri_components *uptr);
/**
* Setup everything necessary to parse uri's
* @deffunc void ap_util_uri_init(void)
*/
AP_DECLARE(void) ap_util_uri_init(void);
#ifdef __cplusplus
}
#endif
#endif /*UTIL_URI_H*/
|
