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
|
//
// VMime library (http://www.vmime.org)
// Copyright (C) 2002 Vincent Richard <vincent@vmime.org>
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 3 of
// the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// Linking this library statically or dynamically with other modules is making
// a combined work based on this library. Thus, the terms and conditions of
// the GNU General Public License cover the whole combination.
//
#ifndef VMIME_UTILITY_URL_HPP_INCLUDED
#define VMIME_UTILITY_URL_HPP_INCLUDED
#include "vmime/types.hpp"
#include "vmime/base.hpp"
#include "vmime/propertySet.hpp"
namespace vmime {
namespace utility {
/** This class represents a Uniform Resource Locator (a pointer
* to a "resource" on the World Wide Web).
*
* Format:
* "protocol://[username[:password]@]host[:port][/path]"
*/
class VMIME_EXPORT url {
public:
/** Means "port not specified" (use default port). */
static const port_t UNSPECIFIED_PORT;
/** Standard name for FILE protocol (local file-system). */
static const string PROTOCOL_FILE;
/** Standard name for HTTP protocol. */
static const string PROTOCOL_HTTP;
/** Standard name for FTP protocol. */
static const string PROTOCOL_FTP;
/** Construct an URL from a string (parse the URL components).
*
* @param s full URL string (eg. http://www.vmime.org:80/download.html)
* @throw exceptions::malformed_url if URL is malformed
*/
url(const string& s);
/** Construct an URL from another URL object.
*
* @param u other URL object
*/
url(const url& u);
/** Construct an URL from the components.
*
* @param protocol protocol (eg. "http", "ftp"...)
* @param host host name (eg. "www.vmime.org", "123.45.67.89")
* @param port optional port number (eg. 80, 110 or UNSPECIFIED_PORT to mean "default")
* @param path optional full path (eg. "download.html")
* @param username optional user name
* @param password optional user password
*/
url(
const string& protocol,
const string& host,
const port_t port = UNSPECIFIED_PORT,
const string& path = "",
const string& username = "",
const string& password = ""
);
/** Return the protocol of the URL (eg: "http").
*
* @return protocol of the URL
*/
const string& getProtocol() const;
/** Set the protocol of the URL.
*
* @param protocol new protocol (eg: "http")
*/
void setProtocol(const string& protocol);
/** Return the username specified in the URL
* or empty if not specified.
*
* @return user name
*/
const string& getUsername() const;
/** Set the username of the URL.
*
* @param username user name
*/
void setUsername(const string& username);
/** Return the password specified in the URL
* or empty if not specified.
*
* @return user password
*/
const string& getPassword() const;
/** Set the password of the URL.
*
* @param password user password
*/
void setPassword(const string& password);
/** Return the host name of the URL (server name or IP address).
*
* @return host name
*/
const string& getHost() const;
/** Set the host name of the URL.
*
* @param host server name or IP address
*/
void setHost(const string& host);
/** Return the port of the URL, or url::UNSPECIFIED_PORT if
* the default port if used.
*
* @return server port
*/
port_t getPort() const;
/** Set the port of the URL.
*
* @param port server port or url::UNSPECIFIED_PORT to
* use the default port of the protocol
*/
void setPort(const port_t port);
/** Return the path portion of the URL,
* or empty if not specified.
*
* @return path
*/
const string& getPath() const;
/** Set the part portion of the URL.
*
* @param path path
*/
void setPath(const string& path);
/** Return the parameters of the URL (read-only).
*
* @return parameters
*/
const std::map <string, string>& getParams() const;
/** Return the parameters of the URL.
*
* @return parameters
*/
std::map <string, string>& getParams();
/** Build a string URL from this object.
*/
operator string() const;
url& operator=(const url& u);
url& operator=(const string& s);
private:
const string build() const;
void parse(const string& str);
string m_protocol;
string m_username;
string m_password;
string m_host;
port_t m_port;
string m_path;
std::map <string, string> m_params;
};
} // utility
} // vmime
#endif // VMIME_UTILITY_URL_HPP_INCLUDED
|
