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 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
|
/**
* @file url_pattern-inl.h
* @brief Declaration for the URLPattern inline functions.
*/
#ifndef ADA_URL_PATTERN_INL_H
#define ADA_URL_PATTERN_INL_H
#include "ada/common_defs.h"
#include "ada/url_pattern_helpers.h"
#include "ada/url_pattern.h"
#include <algorithm>
#include <string_view>
#include <utility>
#if ADA_INCLUDE_URL_PATTERN
namespace ada {
inline bool url_pattern_init::operator==(const url_pattern_init& other) const {
return protocol == other.protocol && username == other.username &&
password == other.password && hostname == other.hostname &&
port == other.port && search == other.search && hash == other.hash &&
pathname == other.pathname;
}
inline bool url_pattern_component_result::operator==(
const url_pattern_component_result& other) const {
return input == other.input && groups == other.groups;
}
template <url_pattern_regex::regex_concept regex_provider>
url_pattern_component_result
url_pattern_component<regex_provider>::create_component_match_result(
std::string&& input,
std::vector<std::optional<std::string>>&& exec_result) {
// Let result be a new URLPatternComponentResult.
// Set result["input"] to input.
// Let groups be a record<USVString, (USVString or undefined)>.
auto result =
url_pattern_component_result{.input = std::move(input), .groups = {}};
// Optimization: Let's reserve the size.
result.groups.reserve(exec_result.size());
// We explicitly start iterating from 0 even though the spec
// says we should start from 1. This case is handled by the
// std_regex_provider.
for (size_t index = 0; index < exec_result.size(); index++) {
result.groups.insert({
group_name_list[index],
std::move(exec_result[index]),
});
}
return result;
}
template <url_pattern_regex::regex_concept regex_provider>
std::string_view url_pattern<regex_provider>::get_protocol() const
ada_lifetime_bound {
// Return this's associated URL pattern's protocol component's pattern string.
return protocol_component.pattern;
}
template <url_pattern_regex::regex_concept regex_provider>
std::string_view url_pattern<regex_provider>::get_username() const
ada_lifetime_bound {
// Return this's associated URL pattern's username component's pattern string.
return username_component.pattern;
}
template <url_pattern_regex::regex_concept regex_provider>
std::string_view url_pattern<regex_provider>::get_password() const
ada_lifetime_bound {
// Return this's associated URL pattern's password component's pattern string.
return password_component.pattern;
}
template <url_pattern_regex::regex_concept regex_provider>
std::string_view url_pattern<regex_provider>::get_hostname() const
ada_lifetime_bound {
// Return this's associated URL pattern's hostname component's pattern string.
return hostname_component.pattern;
}
template <url_pattern_regex::regex_concept regex_provider>
std::string_view url_pattern<regex_provider>::get_port() const
ada_lifetime_bound {
// Return this's associated URL pattern's port component's pattern string.
return port_component.pattern;
}
template <url_pattern_regex::regex_concept regex_provider>
std::string_view url_pattern<regex_provider>::get_pathname() const
ada_lifetime_bound {
// Return this's associated URL pattern's pathname component's pattern string.
return pathname_component.pattern;
}
template <url_pattern_regex::regex_concept regex_provider>
std::string_view url_pattern<regex_provider>::get_search() const
ada_lifetime_bound {
// Return this's associated URL pattern's search component's pattern string.
return search_component.pattern;
}
template <url_pattern_regex::regex_concept regex_provider>
std::string_view url_pattern<regex_provider>::get_hash() const
ada_lifetime_bound {
// Return this's associated URL pattern's hash component's pattern string.
return hash_component.pattern;
}
template <url_pattern_regex::regex_concept regex_provider>
bool url_pattern<regex_provider>::ignore_case() const {
return ignore_case_;
}
template <url_pattern_regex::regex_concept regex_provider>
bool url_pattern<regex_provider>::has_regexp_groups() const {
// If this's associated URL pattern's has regexp groups, then return true.
return protocol_component.has_regexp_groups ||
username_component.has_regexp_groups ||
password_component.has_regexp_groups ||
hostname_component.has_regexp_groups ||
port_component.has_regexp_groups ||
pathname_component.has_regexp_groups ||
search_component.has_regexp_groups || hash_component.has_regexp_groups;
}
inline bool url_pattern_part::is_regexp() const noexcept {
return type == url_pattern_part_type::REGEXP;
}
inline std::string_view url_pattern_compile_component_options::get_delimiter()
const {
if (delimiter) {
return {&delimiter.value(), 1};
}
return {};
}
inline std::string_view url_pattern_compile_component_options::get_prefix()
const {
if (prefix) {
return {&prefix.value(), 1};
}
return {};
}
template <url_pattern_regex::regex_concept regex_provider>
template <url_pattern_encoding_callback F>
tl::expected<url_pattern_component<regex_provider>, errors>
url_pattern_component<regex_provider>::compile(
std::string_view input, F& encoding_callback,
url_pattern_compile_component_options& options) {
ada_log("url_pattern_component::compile input: ", input);
// Let part list be the result of running parse a pattern string given input,
// options, and encoding callback.
auto part_list = url_pattern_helpers::parse_pattern_string(input, options,
encoding_callback);
if (!part_list) {
ada_log("parse_pattern_string failed");
return tl::unexpected(part_list.error());
}
// Let (regular expression string, name list) be the result of running
// generate a regular expression and name list given part list and options.
auto [regular_expression_string, name_list] =
url_pattern_helpers::generate_regular_expression_and_name_list(*part_list,
options);
ada_log("regular expression string: ", regular_expression_string);
// Let pattern string be the result of running generate a pattern
// string given part list and options.
auto pattern_string =
url_pattern_helpers::generate_pattern_string(*part_list, options);
// Let regular expression be RegExpCreate(regular expression string,
// flags). If this throws an exception, catch it, and throw a
// TypeError.
std::optional<typename regex_provider::regex_type> regular_expression =
regex_provider::create_instance(regular_expression_string,
options.ignore_case);
if (!regular_expression) {
return tl::unexpected(errors::type_error);
}
// For each part of part list:
// - If part's type is "regexp", then set has regexp groups to true.
const auto has_regexp = [](const auto& part) { return part.is_regexp(); };
const bool has_regexp_groups = std::ranges::any_of(*part_list, has_regexp);
ada_log("has regexp groups: ", has_regexp_groups);
// Return a new component whose pattern string is pattern string, regular
// expression is regular expression, group name list is name list, and has
// regexp groups is has regexp groups.
return url_pattern_component<regex_provider>(
std::move(pattern_string), std::move(*regular_expression),
std::move(name_list), has_regexp_groups);
}
template <url_pattern_regex::regex_concept regex_provider>
result<std::optional<url_pattern_result>> url_pattern<regex_provider>::exec(
const url_pattern_input& input, const std::string_view* base_url) {
// Return the result of match given this's associated URL pattern, input, and
// baseURL if given.
return match(input, base_url);
}
template <url_pattern_regex::regex_concept regex_provider>
result<bool> url_pattern<regex_provider>::test(
const url_pattern_input& input, const std::string_view* base_url) {
// TODO: Optimization opportunity. Rather than returning `url_pattern_result`
// Implement a fast path just like `can_parse()` in ada_url.
// Let result be the result of match given this's associated URL pattern,
// input, and baseURL if given.
// If result is null, return false.
if (auto result = match(input, base_url); result.has_value()) {
return result->has_value();
}
return tl::unexpected(errors::type_error);
}
template <url_pattern_regex::regex_concept regex_provider>
result<std::optional<url_pattern_result>> url_pattern<regex_provider>::match(
const url_pattern_input& input, const std::string_view* base_url_string) {
std::string protocol{};
std::string username{};
std::string password{};
std::string hostname{};
std::string port{};
std::string pathname{};
std::string search{};
std::string hash{};
// Let inputs be an empty list.
// Append input to inputs.
std::vector inputs{input};
// If input is a URLPatternInit then:
if (std::holds_alternative<url_pattern_init>(input)) {
ada_log(
"url_pattern::match called with url_pattern_init and base_url_string=",
base_url_string);
// If baseURLString was given, throw a TypeError.
if (base_url_string) {
ada_log("failed to match because base_url_string was given");
return tl::unexpected(errors::type_error);
}
// Let applyResult be the result of process a URLPatternInit given input,
// "url", protocol, username, password, hostname, port, pathname, search,
// and hash.
auto apply_result = url_pattern_init::process(
std::get<url_pattern_init>(input), url_pattern_init::process_type::url,
protocol, username, password, hostname, port, pathname, search, hash);
// If this throws an exception, catch it, and return null.
if (!apply_result.has_value()) {
ada_log("match returned std::nullopt because process threw");
return std::nullopt;
}
// Set protocol to applyResult["protocol"].
ADA_ASSERT_TRUE(apply_result->protocol.has_value());
protocol = std::move(apply_result->protocol.value());
// Set username to applyResult["username"].
ADA_ASSERT_TRUE(apply_result->username.has_value());
username = std::move(apply_result->username.value());
// Set password to applyResult["password"].
ADA_ASSERT_TRUE(apply_result->password.has_value());
password = std::move(apply_result->password.value());
// Set hostname to applyResult["hostname"].
ADA_ASSERT_TRUE(apply_result->hostname.has_value());
hostname = std::move(apply_result->hostname.value());
// Set port to applyResult["port"].
ADA_ASSERT_TRUE(apply_result->port.has_value());
port = std::move(apply_result->port.value());
// Set pathname to applyResult["pathname"].
ADA_ASSERT_TRUE(apply_result->pathname.has_value());
pathname = std::move(apply_result->pathname.value());
// Set search to applyResult["search"].
ADA_ASSERT_TRUE(apply_result->search.has_value());
if (apply_result->search->starts_with("?")) {
search = apply_result->search->substr(1);
} else {
search = std::move(apply_result->search.value());
}
// Set hash to applyResult["hash"].
ADA_ASSERT_TRUE(apply_result->hash.has_value());
ADA_ASSERT_TRUE(!apply_result->hash->starts_with("#"));
hash = std::move(apply_result->hash.value());
} else {
ADA_ASSERT_TRUE(std::holds_alternative<std::string_view>(input));
// Let baseURL be null.
result<url_aggregator> base_url;
// If baseURLString was given, then:
if (base_url_string) {
// Let baseURL be the result of parsing baseURLString.
base_url = ada::parse<url_aggregator>(*base_url_string, nullptr);
// If baseURL is failure, return null.
if (!base_url) {
ada_log("match returned std::nullopt because failed to parse base_url=",
*base_url_string);
return std::nullopt;
}
// Append baseURLString to inputs.
inputs.emplace_back(*base_url_string);
}
url_aggregator* base_url_value =
base_url.has_value() ? &*base_url : nullptr;
// Set url to the result of parsing input given baseURL.
auto url = ada::parse<url_aggregator>(std::get<std::string_view>(input),
base_url_value);
// If url is failure, return null.
if (!url) {
ada_log("match returned std::nullopt because url failed");
return std::nullopt;
}
// Set protocol to url's scheme.
// IMPORTANT: Not documented on the URLPattern spec, but protocol suffix ':'
// is removed. Similar work was done on workerd:
// https://github.com/cloudflare/workerd/blob/8620d14012513a6ce04d079e401d3becac3c67bd/src/workerd/jsg/url.c%2B%2B#L2038
protocol = url->get_protocol().substr(0, url->get_protocol().size() - 1);
// Set username to url's username.
username = url->get_username();
// Set password to url's password.
password = url->get_password();
// Set hostname to url's host, serialized, or the empty string if the value
// is null.
hostname = url->get_hostname();
// Set port to url's port, serialized, or the empty string if the value is
// null.
port = url->get_port();
// Set pathname to the result of URL path serializing url.
pathname = url->get_pathname();
// Set search to url's query or the empty string if the value is null.
// IMPORTANT: Not documented on the URLPattern spec, but search prefix '?'
// is removed. Similar work was done on workerd:
// https://github.com/cloudflare/workerd/blob/8620d14012513a6ce04d079e401d3becac3c67bd/src/workerd/jsg/url.c%2B%2B#L2232
if (url->has_search()) {
auto view = url->get_search();
search = view.starts_with("?") ? url->get_search().substr(1) : view;
}
// Set hash to url's fragment or the empty string if the value is null.
// IMPORTANT: Not documented on the URLPattern spec, but hash prefix '#' is
// removed. Similar work was done on workerd:
// https://github.com/cloudflare/workerd/blob/8620d14012513a6ce04d079e401d3becac3c67bd/src/workerd/jsg/url.c%2B%2B#L2242
if (url->has_hash()) {
auto view = url->get_hash();
hash = view.starts_with("#") ? url->get_hash().substr(1) : view;
}
}
// Let protocolExecResult be RegExpBuiltinExec(urlPattern's protocol
// component's regular expression, protocol).
auto protocol_exec_result =
regex_provider::regex_search(protocol, protocol_component.regexp);
if (!protocol_exec_result) {
return std::nullopt;
}
// Let usernameExecResult be RegExpBuiltinExec(urlPattern's username
// component's regular expression, username).
auto username_exec_result =
regex_provider::regex_search(username, username_component.regexp);
if (!username_exec_result) {
return std::nullopt;
}
// Let passwordExecResult be RegExpBuiltinExec(urlPattern's password
// component's regular expression, password).
auto password_exec_result =
regex_provider::regex_search(password, password_component.regexp);
if (!password_exec_result) {
return std::nullopt;
}
// Let hostnameExecResult be RegExpBuiltinExec(urlPattern's hostname
// component's regular expression, hostname).
auto hostname_exec_result =
regex_provider::regex_search(hostname, hostname_component.regexp);
if (!hostname_exec_result) {
return std::nullopt;
}
// Let portExecResult be RegExpBuiltinExec(urlPattern's port component's
// regular expression, port).
auto port_exec_result =
regex_provider::regex_search(port, port_component.regexp);
if (!port_exec_result) {
return std::nullopt;
}
// Let pathnameExecResult be RegExpBuiltinExec(urlPattern's pathname
// component's regular expression, pathname).
auto pathname_exec_result =
regex_provider::regex_search(pathname, pathname_component.regexp);
if (!pathname_exec_result) {
return std::nullopt;
}
// Let searchExecResult be RegExpBuiltinExec(urlPattern's search component's
// regular expression, search).
auto search_exec_result =
regex_provider::regex_search(search, search_component.regexp);
if (!search_exec_result) {
return std::nullopt;
}
// Let hashExecResult be RegExpBuiltinExec(urlPattern's hash component's
// regular expression, hash).
auto hash_exec_result =
regex_provider::regex_search(hash, hash_component.regexp);
if (!hash_exec_result) {
return std::nullopt;
}
// Let result be a new URLPatternResult.
auto result = url_pattern_result{};
// Set result["inputs"] to inputs.
result.inputs = std::move(inputs);
// Set result["protocol"] to the result of creating a component match result
// given urlPattern's protocol component, protocol, and protocolExecResult.
result.protocol = protocol_component.create_component_match_result(
std::move(protocol), std::move(*protocol_exec_result));
// Set result["username"] to the result of creating a component match result
// given urlPattern's username component, username, and usernameExecResult.
result.username = username_component.create_component_match_result(
std::move(username), std::move(*username_exec_result));
// Set result["password"] to the result of creating a component match result
// given urlPattern's password component, password, and passwordExecResult.
result.password = password_component.create_component_match_result(
std::move(password), std::move(*password_exec_result));
// Set result["hostname"] to the result of creating a component match result
// given urlPattern's hostname component, hostname, and hostnameExecResult.
result.hostname = hostname_component.create_component_match_result(
std::move(hostname), std::move(*hostname_exec_result));
// Set result["port"] to the result of creating a component match result given
// urlPattern's port component, port, and portExecResult.
result.port = port_component.create_component_match_result(
std::move(port), std::move(*port_exec_result));
// Set result["pathname"] to the result of creating a component match result
// given urlPattern's pathname component, pathname, and pathnameExecResult.
result.pathname = pathname_component.create_component_match_result(
std::move(pathname), std::move(*pathname_exec_result));
// Set result["search"] to the result of creating a component match result
// given urlPattern's search component, search, and searchExecResult.
result.search = search_component.create_component_match_result(
std::move(search), std::move(*search_exec_result));
// Set result["hash"] to the result of creating a component match result given
// urlPattern's hash component, hash, and hashExecResult.
result.hash = hash_component.create_component_match_result(
std::move(hash), std::move(*hash_exec_result));
return result;
}
} // namespace ada
#endif // ADA_INCLUDE_URL_PATTERN
#endif
|