libcruft-util/uri.hpp

128 lines
4.1 KiB
C++
Raw Normal View History

2015-02-11 16:18:18 +11:00
/*
2018-08-04 15:14:06 +10:00
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
2015-02-11 16:18:18 +11:00
*
* Copyright 2015, 2017, 2021 Danny Robson <danny@nerdcruft.net>
2015-02-11 16:18:18 +11:00
*/
2021-12-13 16:55:14 +11:00
#pragma once
2015-02-09 17:43:24 +11:00
#include "debug/assert.hpp"
#include "view.hpp"
#include <array>
2021-12-13 16:55:01 +11:00
#include <iosfwd>
#include <map>
#include <stdexcept>
#include <string>
#include <string_view>
2015-02-09 17:43:24 +11:00
namespace cruft {
// parsing of rfc3986 uniform resource identifiers
//
// does not currently perform normalisation (scheme or protocol),
// comparison, or other associated operations. though these should be
// added in the future.
//
// note that the parsed results may not always conform to expectations
// for some protocols. eg, mailto identifiers are complex to parse
// reliably and would require a specialised parser to be reliable.
//
// not all fields will be present for all protocols (or all instances of
// any given protocol). eg, the "tel" is unlikely to have port numbers.
2015-02-09 17:43:24 +11:00
class uri {
public:
uri (std::string &&);
uri& operator= (uri &&) noexcept;
uri (uri const&);
uri& operator= (uri const&);
uri (const std::string&);
uri (const char *);
uri (view<const char *>);
2015-02-09 17:43:24 +11:00
uri (
std::string_view scheme,
std::string_view authority,
std::string_view path,
std::string_view query,
std::string_view fragment
);
2015-02-09 17:43:24 +11:00
class parse_error : public std::runtime_error
{ using runtime_error::runtime_error; };
// URI: 'https://user:password@example.com:80/path/to?foo=bar#fragment'
//
// SCHEME: 'https'
// HIERARCHICAL: 'user:password@example.com:80/path/to'
// AUTHORITY: 'user:password@example.com:80'
// USER: 'user:password'
// HOST: 'example.com'
// PORT: '80'
// PATH: '/path/to'
// QUERY: 'foo=bar'
// FRAGMENT: 'fragment'
enum component {
/* 0 */ SCHEME,
/* 1 */ HIERARCHICAL,
/* 2 */ AUTHORITY,
/* 3 */ USER,
/* 4 */ HOST,
/* 5 */ PORT,
/* 6 */ PATH,
/* 7 */ QUERY,
/* 8 */ FRAGMENT,
2015-02-09 17:43:24 +11:00
NUM_COMPONENTS
};
std::string_view
get (component c) const&;
void set (component c, std::string_view);
std::string_view all (void) const& { return m_value; }
2021-11-07 12:13:15 +11:00
std::string const& value (void) const& { return m_value; }
std::string_view scheme (void) const& { return get (SCHEME); }
std::string_view heirarchical (void) const& { return get (HIERARCHICAL); }
std::string_view authority (void) const& { return get (AUTHORITY); }
std::string_view user (void) const& { return get (USER); }
std::string_view host (void) const& { return get (HOST); }
std::string_view port (void) const& { return get (PORT); }
std::string_view path (void) const& { return get (PATH); }
std::string_view query (void) const& { return get (QUERY); }
std::string_view fragment (void) const& { return get (FRAGMENT); }
// void clear (component);
void clear_fragment (void);
2021-12-13 16:56:18 +11:00
auto components (void) const& noexcept { return m_views; }
2015-02-09 17:43:24 +11:00
static std::string percent_decode (view<const char*>);
2015-02-09 17:43:24 +11:00
private:
void parse (void);
std::array<view<const char*>, NUM_COMPONENTS> m_views;
2015-02-09 17:43:24 +11:00
std::string m_value;
};
std::map<std::string, std::string> query_to_map (std::string_view);
std::string map_to_query (std::map<std::string, std::string> const&);
bool operator== (uri const&, uri const&) noexcept;
cruft::uri resolve (cruft::uri const &base, cruft::uri const &child);
cruft::uri normalise (cruft::uri const &);
2021-12-13 16:56:28 +11:00
2021-12-13 16:55:01 +11:00
std::ostream& operator<< (std::ostream&, uri const&);
2015-02-09 17:43:24 +11:00
std::ostream& operator<< (std::ostream&, uri::component);
}