WebSocket++ 0.8.2
C++ websocket client/server library
Loading...
Searching...
No Matches
uri.hpp
1/*
2 * Copyright (c) 2014, Peter Thorson. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 * * Redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer.
8 * * Redistributions in binary form must reproduce the above copyright
9 * notice, this list of conditions and the following disclaimer in the
10 * documentation and/or other materials provided with the distribution.
11 * * Neither the name of the WebSocket++ Project nor the
12 * names of its contributors may be used to endorse or promote products
13 * derived from this software without specific prior written permission.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL PETER THORSON BE LIABLE FOR ANY
19 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 *
26 */
27
28#ifndef WEBSOCKETPP_URI_HPP
29#define WEBSOCKETPP_URI_HPP
30
31#include <websocketpp/error.hpp>
32
33#include <websocketpp/common/memory.hpp>
34#include <websocketpp/common/stdint.hpp>
35
36#include <algorithm>
37#include <sstream>
38#include <string>
39
40namespace websocketpp {
41
42// TODO: figure out why this fixes horrible linking errors.
43
44/// Default port for ws://
45static uint16_t const uri_default_port = 80;
46/// Default port for wss://
47static uint16_t const uri_default_secure_port = 443;
48
49class uri {
50public:
51 explicit uri(std::string const & uri_string) : m_valid(false) {
52 std::string::const_iterator it;
53 std::string::const_iterator temp;
54
55 int state = 0;
56
57 it = uri_string.begin();
58 size_t uri_len = uri_string.length();
59
60 if (uri_len >= 7 && std::equal(it,it+6,"wss://")) {
61 m_secure = true;
62 m_scheme = "wss";
63 it += 6;
64 } else if (uri_len >= 6 && std::equal(it,it+5,"ws://")) {
65 m_secure = false;
66 m_scheme = "ws";
67 it += 5;
68 } else if (uri_len >= 8 && std::equal(it,it+7,"http://")) {
69 m_secure = false;
70 m_scheme = "http";
71 it += 7;
72 } else if (uri_len >= 9 && std::equal(it,it+8,"https://")) {
73 m_secure = true;
74 m_scheme = "https";
75 it += 8;
76 } else {
77 return;
78 }
79
80 // extract host.
81 // either a host string
82 // an IPv4 address
83 // or an IPv6 address
84 if (*it == '[') {
85 ++it;
86 // IPv6 literal
87 // extract IPv6 digits until ]
88
89 // TODO: this doesn't work on g++... not sure why
90 //temp = std::find(it,it2,']');
91
92 temp = it;
93 while (temp != uri_string.end()) {
94 if (*temp == ']') {
95 break;
96 }
97 ++temp;
98 }
99
100 if (temp == uri_string.end()) {
101 return;
102 } else {
103 // validate IPv6 literal parts
104 // can contain numbers, a-f and A-F
105 m_host.append(it,temp);
106 }
107 it = temp+1;
108 if (it == uri_string.end()) {
109 state = 2;
110 } else if (*it == '/') {
111 state = 2;
112 ++it;
113 } else if (*it == ':') {
114 state = 1;
115 ++it;
116 } else {
117 // problem
118 return;
119 }
120 } else {
121 // IPv4 or hostname
122 // extract until : or /
123 while (state == 0) {
124 if (it == uri_string.end()) {
125 state = 2;
126 break;
127 } else if (*it == '/') {
128 state = 2;
129 } else if (*it == ':') {
130 // end hostname start port
131 state = 1;
132 } else {
133 m_host += *it;
134 }
135 ++it;
136 }
137 }
138
139 // parse port
140 std::string port;
141 while (state == 1) {
142 if (it == uri_string.end()) {
143 // state is not used after this point presently.
144 // this should be re-enabled if it ever is needed in a future
145 // refactoring
146 //state = 3;
147 break;
148 } else if (*it == '/') {
149 state = 3;
150 } else {
151 port += *it;
152 }
153 ++it;
154 }
155
156 lib::error_code ec;
157 m_port = get_port_from_string(port, ec);
158
159 if (ec) {
160 return;
161 }
162
163 m_resource = "/";
164 m_resource.append(it,uri_string.end());
165
166
167 m_valid = true;
168 }
169
170 uri(bool secure, std::string const & host, uint16_t port,
171 std::string const & resource)
172 : m_scheme(secure ? "wss" : "ws")
173 , m_host(host)
174 , m_resource(resource.empty() ? "/" : resource)
175 , m_port(port)
176 , m_secure(secure)
177 , m_valid(true) {}
178
179 uri(bool secure, std::string const & host, std::string const & resource)
180 : m_scheme(secure ? "wss" : "ws")
181 , m_host(host)
182 , m_resource(resource.empty() ? "/" : resource)
183 , m_port(secure ? uri_default_secure_port : uri_default_port)
184 , m_secure(secure)
185 , m_valid(true) {}
186
187 uri(bool secure, std::string const & host, std::string const & port,
188 std::string const & resource)
189 : m_scheme(secure ? "wss" : "ws")
190 , m_host(host)
191 , m_resource(resource.empty() ? "/" : resource)
192 , m_secure(secure)
193 {
194 lib::error_code ec;
195 m_port = get_port_from_string(port,ec);
196 m_valid = !ec;
197 }
198
199 uri(std::string const & scheme, std::string const & host, uint16_t port,
200 std::string const & resource)
201 : m_scheme(scheme)
202 , m_host(host)
203 , m_resource(resource.empty() ? "/" : resource)
204 , m_port(port)
205 , m_secure(scheme == "wss" || scheme == "https")
206 , m_valid(true) {}
207
208 uri(std::string scheme, std::string const & host, std::string const & resource)
209 : m_scheme(scheme)
210 , m_host(host)
211 , m_resource(resource.empty() ? "/" : resource)
212 , m_port((scheme == "wss" || scheme == "https") ? uri_default_secure_port : uri_default_port)
213 , m_secure(scheme == "wss" || scheme == "https")
214 , m_valid(true) {}
215
216 uri(std::string const & scheme, std::string const & host,
217 std::string const & port, std::string const & resource)
218 : m_scheme(scheme)
219 , m_host(host)
220 , m_resource(resource.empty() ? "/" : resource)
221 , m_secure(scheme == "wss" || scheme == "https")
222 {
223 lib::error_code ec;
224 m_port = get_port_from_string(port,ec);
225 m_valid = !ec;
226 }
227
228 bool get_valid() const {
229 return m_valid;
230 }
231
232 bool get_secure() const {
233 return m_secure;
234 }
235
236 std::string const & get_scheme() const {
237 return m_scheme;
238 }
239
240 std::string const & get_host() const {
241 return m_host;
242 }
243
244 std::string get_host_port() const {
245 if (m_port == (m_secure ? uri_default_secure_port : uri_default_port)) {
246 return m_host;
247 } else {
248 std::stringstream p;
249 p << m_host << ":" << m_port;
250 return p.str();
251 }
252 }
253
254 std::string get_authority() const {
255 std::stringstream p;
256 p << m_host << ":" << m_port;
257 return p.str();
258 }
259
260 uint16_t get_port() const {
261 return m_port;
262 }
263
264 std::string get_port_str() const {
265 std::stringstream p;
266 p << m_port;
267 return p.str();
268 }
269
270 std::string const & get_resource() const {
271 return m_resource;
272 }
273
274 std::string str() const {
275 std::stringstream s;
276
277 s << m_scheme << "://" << m_host;
278
279 if (m_port != (m_secure ? uri_default_secure_port : uri_default_port)) {
280 s << ":" << m_port;
281 }
282
283 s << m_resource;
284 return s.str();
285 }
286
287 /// Return the query portion
288 /**
289 * Returns the query portion (after the ?) of the URI or an empty string if
290 * there is none.
291 *
292 * @return query portion of the URI.
293 */
294 std::string get_query() const {
295 std::size_t found = m_resource.find('?');
296 if (found != std::string::npos) {
297 return m_resource.substr(found + 1);
298 } else {
299 return "";
300 }
301 }
302
303 // get fragment
304
305 // hi <3
306
307 // get the string representation of this URI
308
309 //std::string base() const; // is this still needed?
310
311 // setter methods set some or all (in the case of parse) based on the input.
312 // These functions throw a uri_exception on failure.
313 /*void set_uri(const std::string& uri);
314
315 void set_secure(bool secure);
316 void set_host(const std::string& host);
317 void set_port(uint16_t port);
318 void set_port(const std::string& port);
319 void set_resource(const std::string& resource);*/
320private:
321 uint16_t get_port_from_string(std::string const & port, lib::error_code &
322 ec) const
323 {
324 ec = lib::error_code();
325
326 if (port.empty()) {
327 return (m_secure ? uri_default_secure_port : uri_default_port);
328 }
329
330 unsigned int t_port = static_cast<unsigned int>(atoi(port.c_str()));
331
332 if (t_port > 65535) {
333 ec = error::make_error_code(error::invalid_port);
334 }
335
336 if (t_port == 0) {
337 ec = error::make_error_code(error::invalid_port);
338 }
339
340 return static_cast<uint16_t>(t_port);
341 }
342
343 std::string m_scheme;
344 std::string m_host;
345 std::string m_resource;
346 uint16_t m_port;
347 bool m_secure;
348 bool m_valid;
349};
350
351/// Pointer to a URI
352typedef lib::shared_ptr<uri> uri_ptr;
353
354} // namespace websocketpp
355
356#endif // WEBSOCKETPP_URI_HPP
#define _WEBSOCKETPP_CPP11_FUNCTIONAL_
#define _WEBSOCKETPP_CPP11_THREAD_
#define _WEBSOCKETPP_CPP11_MEMORY_
#define _WEBSOCKETPP_CPP11_SYSTEM_ERROR_
Concurrency policy that uses std::mutex / boost::mutex.
Definition basic.hpp:37
Stub for user supplied base class.
Stub for user supplied base class.
Stub class for use when disabling permessage_deflate extension.
Definition disabled.hpp:53
Stores, parses, and manipulates HTTP requests.
Definition request.hpp:50
Stores, parses, and manipulates HTTP responses.
Definition response.hpp:57
Basic logger that outputs to an ostream.
Definition basic.hpp:59
Thread safe stub "random" integer generator.
Definition none.hpp:46
Server endpoint role based on the given config.
Basic ASIO endpoint socket component.
Definition none.hpp:317
Asio based endpoint transport component.
Definition endpoint.hpp:54
lib::shared_ptr< type > ptr
Type of a shared pointer to this connection transport component.
connection_hdl get_handle() const
Get the connection handle.
config::alog_type alog_type
Type of this transport's access logging policy.
lib::error_code dispatch(dispatch_handler handler)
Call given handler back within the transport's event system (if present)
void async_shutdown(transport::shutdown_handler handler)
Perform cleanup on socket shutdown_handler.
void set_write_handler(write_handler h)
Sets the write handler.
void set_secure(bool value)
Set whether or not this connection is secure.
void set_shutdown_handler(shutdown_handler h)
Sets the shutdown handler.
connection< config > type
Type of this connection transport component.
config::elog_type elog_type
Type of this transport's error logging policy.
void fatal_error()
Signal transport error.
size_t read_some(char const *buf, size_t len)
Manual input supply (read some)
size_t read_all(char const *buf, size_t len)
Manual input supply (read all)
void async_write(char const *buf, size_t len, transport::write_handler handler)
Asyncronous Transport Write.
size_t readsome(char const *buf, size_t len)
Manual input supply (DEPRECATED)
config::concurrency_type concurrency_type
transport concurrency policy
void init(init_handler handler)
Initialize the connection transport.
timer_ptr set_timer(long, timer_handler)
Call back a function after a period of time.
friend std::istream & operator>>(std::istream &in, type &t)
Overloaded stream input operator.
void set_vector_write_handler(vector_write_handler h)
Sets the vectored write handler.
bool is_secure() const
Tests whether or not the underlying transport is secure.
std::string get_remote_endpoint() const
Get human readable remote endpoint address.
void set_handle(connection_hdl hdl)
Set Connection Handle.
void register_ostream(std::ostream *o)
Register a std::ostream with the transport for writing output.
void async_read_at_least(size_t num_bytes, char *buf, size_t len, read_handler handler)
Initiate an async_read for at least num_bytes bytes into buf.
void async_write(std::vector< buffer > const &bufs, transport::write_handler handler)
Asyncronous Transport Write (scatter-gather)
ptr get_shared()
Get a shared pointer to this component.
iostream::connection< config > transport_con_type
Definition endpoint.hpp:62
config::elog_type elog_type
Type of this endpoint's error logging policy.
Definition endpoint.hpp:56
void set_write_handler(write_handler h)
Sets the write handler.
Definition endpoint.hpp:134
void set_shutdown_handler(shutdown_handler h)
Sets the shutdown handler.
Definition endpoint.hpp:154
bool is_secure() const
Tests whether or not the underlying transport is secure.
Definition endpoint.hpp:116
lib::shared_ptr< type > ptr
Type of a pointer to this endpoint transport component.
Definition endpoint.hpp:51
transport_con_type::ptr transport_con_ptr
Definition endpoint.hpp:65
void async_connect(transport_con_ptr, uri_ptr, connect_handler cb)
Initiate a new connection.
Definition endpoint.hpp:183
lib::error_code init(transport_con_ptr tcon)
Initialize a connection.
Definition endpoint.hpp:197
void init_logging(lib::shared_ptr< alog_type > a, lib::shared_ptr< elog_type > e)
Initialize logging.
Definition endpoint.hpp:171
endpoint type
Type of this endpoint transport component.
Definition endpoint.hpp:49
void register_ostream(std::ostream *o)
Register a default output stream.
Definition endpoint.hpp:80
config::concurrency_type concurrency_type
Type of this endpoint's concurrency policy.
Definition endpoint.hpp:54
void set_secure(bool value)
Set whether or not endpoint can create secure connections.
Definition endpoint.hpp:102
config::alog_type alog_type
Type of this endpoint's access logging policy.
Definition endpoint.hpp:58
iostream transport error category
Definition base.hpp:85
std::string get_query() const
Return the query portion.
Definition uri.hpp:294
#define _WEBSOCKETPP_NOEXCEPT_TOKEN_
Definition cpp11.hpp:113
#define __has_extension
Definition cpp11.hpp:40
#define __has_feature(x)
Definition cpp11.hpp:37
Concurrency handling support.
Definition basic.hpp:34
Library level error codes.
Definition error.hpp:44
@ invalid_port
Invalid port in URI.
Definition error.hpp:120
Implementation of RFC 7692, the permessage-deflate WebSocket extension.
Definition disabled.hpp:44
HTTP handling support.
Definition request.hpp:37
Stub RNG policy that always returns 0.
Definition none.hpp:35
Random number generation policies.
Transport policy that uses asio.
Definition endpoint.hpp:46
Generic transport related errors.
@ pass_through
underlying transport pass through
@ operation_not_supported
Operation not supported.
@ operation_aborted
Operation aborted.
@ invalid_num_bytes
async_read_at_least call requested more bytes than buffer can store
@ action_after_shutdown
read or write after shutdown
@ tls_short_read
TLS short read.
@ double_read
async_read called while another async_read was in progress
iostream transport errors
Definition base.hpp:64
@ invalid_num_bytes
async_read_at_least call requested more bytes than buffer can store
Definition base.hpp:71
@ double_read
async_read called while another async_read was in progress
Definition base.hpp:74
lib::error_code make_error_code(error::value e)
Get an error code with the given value and the iostream transport category.
Definition base.hpp:118
lib::error_category const & get_category()
Get a reference to a static copy of the iostream transport error category.
Definition base.hpp:112
Transport policy that uses STL iostream for I/O and does not support timers.
Definition endpoint.hpp:43
lib::function< lib::error_code(connection_hdl, std::vector< transport::buffer > const &bufs)> vector_write_handler
Definition base.hpp:57
lib::function< lib::error_code(connection_hdl)> shutdown_handler
Definition base.hpp:61
lib::function< lib::error_code(connection_hdl, char const *, size_t)> write_handler
The type and signature of the callback used by iostream transport to write.
Definition base.hpp:48
Transport policies provide network connectivity and timers.
Definition endpoint.hpp:45
lib::function< void(lib::error_code const &, size_t)> read_handler
The type and signature of the callback passed to the read method.
lib::function< void()> dispatch_handler
The type and signature of the callback passed to the dispatch method.
lib::function< void()> interrupt_handler
The type and signature of the callback passed to the interrupt method.
lib::function< void(lib::error_code const &)> accept_handler
The type and signature of the callback passed to the accept method.
Definition endpoint.hpp:69
lib::function< void(lib::error_code const &)> timer_handler
The type and signature of the callback passed to the read method.
lib::function< void(lib::error_code const &)> connect_handler
The type and signature of the callback passed to the connect method.
Definition endpoint.hpp:72
lib::function< void(lib::error_code const &)> write_handler
The type and signature of the callback passed to the write method.
lib::function< void(lib::error_code const &)> init_handler
The type and signature of the callback passed to the init hook.
lib::function< void(lib::error_code const &)> shutdown_handler
The type and signature of the callback passed to the shutdown method.
Namespace for the WebSocket++ project.
static uint16_t const uri_default_secure_port
Default port for wss://.
Definition uri.hpp:47
lib::weak_ptr< void > connection_hdl
A handle to uniquely identify a connection.
static uint16_t const uri_default_port
Default port for ws://.
Definition uri.hpp:45
lib::shared_ptr< uri > uri_ptr
Pointer to a URI.
Definition uri.hpp:352
Server config with asio transport and TLS disabled.
static const long timeout_socket_shutdown
Length of time to wait for socket shutdown.
Definition core.hpp:137
static const long timeout_connect
Length of time to wait for TCP connect.
Definition core.hpp:134
static const long timeout_dns_resolve
Length of time to wait for dns resolution.
Definition core.hpp:131
static const long timeout_proxy
Length of time to wait before a proxy handshake is aborted.
Definition core.hpp:121
static const long timeout_socket_pre_init
Default timer values (in ms)
Definition core.hpp:118
static const long timeout_socket_post_init
Length of time to wait for socket post-initialization.
Definition core.hpp:128
Server config with iostream transport.
Definition core.hpp:68
websocketpp::random::none::int_generator< uint32_t > rng_type
RNG policies.
Definition core.hpp:93
static const websocketpp::log::level elog_level
Default static error logging channels.
Definition core.hpp:176
websocketpp::transport::iostream::endpoint< transport_config > transport_type
Transport Endpoint Component.
Definition core.hpp:142
static const size_t max_http_body_size
Default maximum http body size.
Definition core.hpp:252
static const long timeout_open_handshake
Default timer values (in ms)
Definition core.hpp:152
static const size_t max_message_size
Default maximum message size.
Definition core.hpp:240
static const bool drop_on_protocol_error
Drop connections immediately on protocol error.
Definition core.hpp:213
static const long timeout_close_handshake
Length of time before a closing handshake is aborted.
Definition core.hpp:154
static const websocketpp::log::level alog_level
Default static access logging channels.
Definition core.hpp:189
websocketpp::log::basic< concurrency_type, websocketpp::log::elevel > elog_type
Logging policies.
Definition core.hpp:88
static const long timeout_pong
Length of time to wait for a pong after a ping.
Definition core.hpp:156
static const bool silent_close
Suppresses the return of detailed connection close information.
Definition core.hpp:228
static bool const enable_multithreading
Definition core.hpp:98
static const size_t connection_read_buffer_size
Size of the per-connection read buffer.
Definition core.hpp:204
static const bool enable_extensions
Global flag for enabling/disabling extensions.
Definition core.hpp:255
static const int client_version
WebSocket Protocol version to use as a client.
Definition core.hpp:164
Package of log levels for logging access events.
Definition levels.hpp:112
static level const devel
Development messages (warning: very chatty)
Definition levels.hpp:141
static level const all
Special aggregate value representing "all levels".
Definition levels.hpp:152
Package of log levels for logging errors.
Definition levels.hpp:59
static level const devel
Low level debugging information (warning: very chatty)
Definition levels.hpp:63
static level const all
Special aggregate value representing "all levels".
Definition levels.hpp:80
A simple utility buffer class.
#define _WEBSOCKETPP_ERROR_CODE_ENUM_NS_END_
#define _WEBSOCKETPP_ERROR_CODE_ENUM_NS_START_