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 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
|
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/url_matcher/url_matcher.h"
#include <algorithm>
#include <iterator>
#include <utility>
#include "base/check.h"
#include "base/containers/contains.h"
#include "base/memory/ptr_util.h"
#include "base/notreached.h"
#include "url/gurl.h"
#include "url/url_canon.h"
using base::MatcherStringPattern;
using base::SubstringSetMatcher;
namespace url_matcher {
// This set of classes implement a mapping of URL Component Patterns, such as
// host_prefix, host_suffix, host_equals, ..., etc., to MatcherStringPatterns
// for use in substring comparisons.
//
// The idea of this mapping is to reduce the problem of comparing many
// URL Component Patterns against one URL to the problem of searching many
// substrings in one string:
//
// ---------------------- ------------------------
// | URL Query operator | ----translate----> | MatcherStringPattern |
// ---------------------- ------------------------
// ^
// |
// compare
// |
// v
// ---------------------- -----------------
// | URL to compare | | |
// | to all URL Query | ----translate----> | String |
// | operators | | |
// ---------------------- -----------------
//
// The reason for this problem reduction is that there are efficient algorithms
// for searching many substrings in one string (see Aho-Corasick algorithm).
//
// Additionally, some of the same pieces are reused to implement regular
// expression comparisons. The FilteredRE2 implementation for matching many
// regular expressions against one string uses prefiltering, in which a set
// of substrings (derived from the regexes) are first searched for, to reduce
// the number of regular expressions to test; the prefiltering step also
// uses Aho-Corasick.
//
// Case 1: {host,path,query}_{prefix,suffix,equals} searches.
// ==========================================================
//
// For searches in this class, we normalize URLs as follows:
//
// Step 1:
// Remove scheme, port and segment from URL:
// -> http://www.example.com:8080/index.html?search=foo#first_match becomes
// www.example.com/index.html?search=foo
//
// We remove the scheme and port number because they can be checked later
// in a secondary filter step. We remove the segment (the #... part) because
// this is not guaranteed to be ASCII-7 encoded.
//
// Step 2:
// Translate URL to String and add the following position markers:
// - BU = Beginning of URL
// - ED = End of Domain
// - EP = End of Path
// - EU = End of URL
// Furthermore, the hostname is canonicalized to start with a ".".
//
// Position markers are represented as characters >127, which are therefore
// guaranteed not to be part of the ASCII-7 encoded URL character set.
//
// -> www.example.com/index.html?search=foo becomes
// BU .www.example.com ED /index.html EP ?search=foo EU
//
// -> www.example.com/index.html becomes
// BU .www.example.com ED /index.html EP EU
//
// Step 3:
// Translate URL Component Patterns as follows:
//
// host_prefix(prefix) = BU add_missing_dot_prefix(prefix)
// -> host_prefix("www.example") = BU .www.example
//
// host_suffix(suffix) = suffix ED
// -> host_suffix("example.com") = example.com ED
// -> host_suffix(".example.com") = .example.com ED
//
// host_equals(domain) = BU add_missing_dot_prefix(domain) ED
// -> host_equals("www.example.com") = BU .www.example.com ED
//
// Similarly for path query parameters ({path, query}_{prefix, suffix, equals}).
//
// With this, we can search the MatcherStringPatterns in the normalized URL.
//
//
// Case 2: url_{prefix,suffix,equals,contains} searches.
// =====================================================
//
// Step 1: as above, except that
// - the scheme is not removed
// - the port is not removed if it is specified and does not match the default
// port for the given scheme.
//
// Step 2:
// Translate URL to String and add the following position markers:
// - BU = Beginning of URL
// - EU = End of URL
//
// -> http://www.example.com:8080/index.html?search=foo#first_match becomes
// BU http://www.example.com:8080/index.html?search=foo EU
// -> http://www.example.com:80/index.html?search=foo#first_match becomes
// BU http://www.example.com/index.html?search=foo EU
//
// url_prefix(prefix) = BU prefix
// -> url_prefix("http://www.example") = BU http://www.example
//
// url_contains(substring) = substring
// -> url_contains("index") = index
//
//
// Case 3: {host,path,query}_contains searches.
// ============================================
//
// These kinds of searches are not supported directly but can be derived
// by a combination of a url_contains() query followed by an explicit test:
//
// host_contains(str) = url_contains(str) followed by test whether str occurs
// in host component of original URL.
// -> host_contains("example.co") = example.co
// followed by gurl.host().find("example.co");
//
// [similarly for path_contains and query_contains].
//
//
// Regular expression matching (url_matches searches)
// ==================================================
//
// This class also supports matching regular expressions (RE2 syntax)
// against full URLs, which are transformed as in case 2.
namespace {
bool IsRegexCriterion(URLMatcherCondition::Criterion criterion) {
return criterion == URLMatcherCondition::URL_MATCHES;
}
bool IsOriginAndPathRegexCriterion(URLMatcherCondition::Criterion criterion) {
return criterion == URLMatcherCondition::ORIGIN_AND_PATH_MATCHES;
}
bool IsMatcherEmpty(const std::unique_ptr<SubstringSetMatcher>& matcher) {
return !matcher || matcher->IsEmpty();
}
} // namespace
//
// URLMatcherCondition
//
URLMatcherCondition::URLMatcherCondition()
: criterion_(HOST_PREFIX), string_pattern_(nullptr) {}
URLMatcherCondition::~URLMatcherCondition() = default;
URLMatcherCondition::URLMatcherCondition(
Criterion criterion,
const MatcherStringPattern* string_pattern)
: criterion_(criterion), string_pattern_(string_pattern) {}
bool URLMatcherCondition::operator<(const URLMatcherCondition& rhs) const {
if (criterion_ < rhs.criterion_)
return true;
if (criterion_ > rhs.criterion_)
return false;
if (string_pattern_ != nullptr && rhs.string_pattern_ != nullptr)
return *string_pattern_ < *rhs.string_pattern_;
if (string_pattern_ == nullptr && rhs.string_pattern_ != nullptr)
return true;
// Either string_pattern_ != NULL && rhs.string_pattern_ == NULL,
// or both are NULL.
return false;
}
bool URLMatcherCondition::IsFullURLCondition() const {
// For these criteria the SubstringMatcher needs to be executed on the
// GURL that is canonicalized with
// URLMatcherConditionFactory::CanonicalizeURLForFullSearches.
switch (criterion_) {
case HOST_CONTAINS:
case PATH_CONTAINS:
case QUERY_CONTAINS:
case URL_PREFIX:
case URL_SUFFIX:
case URL_CONTAINS:
case URL_EQUALS:
return true;
default:
break;
}
return false;
}
bool URLMatcherCondition::IsRegexCondition() const {
return IsRegexCriterion(criterion_);
}
bool URLMatcherCondition::IsOriginAndPathRegexCondition() const {
return IsOriginAndPathRegexCriterion(criterion_);
}
bool URLMatcherCondition::IsMatch(
const std::set<MatcherStringPattern::ID>& matching_patterns,
const GURL& url) const {
DCHECK(string_pattern_);
if (!base::Contains(matching_patterns, string_pattern_->id()))
return false;
// The criteria HOST_CONTAINS, PATH_CONTAINS, QUERY_CONTAINS are based on
// a substring match on the raw URL. In case of a match, we need to verify
// that the match was found in the correct component of the URL.
switch (criterion_) {
case HOST_CONTAINS:
return url.host().find(string_pattern_->pattern()) != std::string::npos;
case PATH_CONTAINS:
return url.path().find(string_pattern_->pattern()) != std::string::npos;
case QUERY_CONTAINS:
return url.query().find(string_pattern_->pattern()) != std::string::npos;
default:
break;
}
return true;
}
//
// URLMatcherConditionFactory
//
namespace {
// These are symbols that are not contained in 7-bit ASCII used in GURLs.
const char kBeginningOfURL[] = {static_cast<char>(-1), 0};
const char kEndOfDomain[] = {static_cast<char>(-2), 0};
const char kEndOfPath[] = {static_cast<char>(-3), 0};
const char kQueryComponentDelimiter[] = {static_cast<char>(-4), 0};
const char kEndOfURL[] = {static_cast<char>(-5), 0};
// The delimiter for query parameters
const char kQuerySeparator = '&';
} // namespace
URLMatcherConditionFactory::URLMatcherConditionFactory() = default;
URLMatcherConditionFactory::~URLMatcherConditionFactory() = default;
std::string URLMatcherConditionFactory::CanonicalizeURLForComponentSearches(
const GURL& url) const {
return kBeginningOfURL + CanonicalizeHostname(url.host()) + kEndOfDomain +
url.path() + kEndOfPath +
(url.has_query() ? CanonicalizeQuery(url.query(), true, true)
: std::string()) +
kEndOfURL;
}
URLMatcherCondition URLMatcherConditionFactory::CreateHostPrefixCondition(
const std::string& prefix) {
return CreateCondition(URLMatcherCondition::HOST_PREFIX,
kBeginningOfURL + CanonicalizeHostPrefix(prefix));
}
URLMatcherCondition URLMatcherConditionFactory::CreateHostSuffixCondition(
const std::string& suffix) {
return CreateCondition(URLMatcherCondition::HOST_SUFFIX,
CanonicalizeHostSuffix(suffix) + kEndOfDomain);
}
URLMatcherCondition URLMatcherConditionFactory::CreateHostContainsCondition(
const std::string& str) {
return CreateCondition(URLMatcherCondition::HOST_CONTAINS, str);
}
URLMatcherCondition URLMatcherConditionFactory::CreateHostEqualsCondition(
const std::string& str) {
return CreateCondition(
URLMatcherCondition::HOST_EQUALS,
kBeginningOfURL + CanonicalizeHostname(str) + kEndOfDomain);
}
URLMatcherCondition URLMatcherConditionFactory::CreatePathPrefixCondition(
const std::string& prefix) {
return CreateCondition(URLMatcherCondition::PATH_PREFIX,
kEndOfDomain + prefix);
}
URLMatcherCondition URLMatcherConditionFactory::CreatePathSuffixCondition(
const std::string& suffix) {
return CreateCondition(URLMatcherCondition::PATH_SUFFIX, suffix + kEndOfPath);
}
URLMatcherCondition URLMatcherConditionFactory::CreatePathContainsCondition(
const std::string& str) {
return CreateCondition(URLMatcherCondition::PATH_CONTAINS, str);
}
URLMatcherCondition URLMatcherConditionFactory::CreatePathEqualsCondition(
const std::string& str) {
return CreateCondition(URLMatcherCondition::PATH_EQUALS,
kEndOfDomain + str + kEndOfPath);
}
URLMatcherCondition URLMatcherConditionFactory::CreateQueryPrefixCondition(
const std::string& prefix) {
std::string pattern;
if (!prefix.empty() && prefix[0] == '?')
pattern = kEndOfPath + CanonicalizeQuery(prefix.substr(1), true, false);
else
pattern = kEndOfPath + CanonicalizeQuery(prefix, true, false);
return CreateCondition(URLMatcherCondition::QUERY_PREFIX, pattern);
}
URLMatcherCondition URLMatcherConditionFactory::CreateQuerySuffixCondition(
const std::string& suffix) {
if (!suffix.empty() && suffix[0] == '?') {
return CreateQueryEqualsCondition(suffix);
} else {
return CreateCondition(URLMatcherCondition::QUERY_SUFFIX,
CanonicalizeQuery(suffix, false, true) + kEndOfURL);
}
}
URLMatcherCondition URLMatcherConditionFactory::CreateQueryContainsCondition(
const std::string& str) {
if (!str.empty() && str[0] == '?')
return CreateQueryPrefixCondition(str);
else
return CreateCondition(URLMatcherCondition::QUERY_CONTAINS, str);
}
URLMatcherCondition URLMatcherConditionFactory::CreateQueryEqualsCondition(
const std::string& str) {
std::string pattern;
if (!str.empty() && str[0] == '?')
pattern =
kEndOfPath + CanonicalizeQuery(str.substr(1), true, true) + kEndOfURL;
else
pattern = kEndOfPath + CanonicalizeQuery(str, true, true) + kEndOfURL;
return CreateCondition(URLMatcherCondition::QUERY_EQUALS, pattern);
}
URLMatcherCondition
URLMatcherConditionFactory::CreateHostSuffixPathPrefixCondition(
const std::string& host_suffix,
const std::string& path_prefix) {
return CreateCondition(
URLMatcherCondition::HOST_SUFFIX_PATH_PREFIX,
CanonicalizeHostSuffix(host_suffix) + kEndOfDomain + path_prefix);
}
URLMatcherCondition
URLMatcherConditionFactory::CreateHostEqualsPathPrefixCondition(
const std::string& host,
const std::string& path_prefix) {
return CreateCondition(URLMatcherCondition::HOST_EQUALS_PATH_PREFIX,
kBeginningOfURL + CanonicalizeHostname(host) +
kEndOfDomain + path_prefix);
}
std::string URLMatcherConditionFactory::CanonicalizeURLForFullSearches(
const GURL& url) const {
GURL::Replacements replacements;
replacements.ClearPassword();
replacements.ClearUsername();
replacements.ClearRef();
// Clear port if it is implicit from scheme.
if (url.has_port()) {
const std::string& port = url.scheme();
if (url::DefaultPortForScheme(port) == url.EffectiveIntPort()) {
replacements.ClearPort();
}
}
return kBeginningOfURL + url.ReplaceComponents(replacements).spec() +
kEndOfURL;
}
static std::string CanonicalizeURLForRegexSearchesHelper(const GURL& url,
bool clear_query) {
GURL::Replacements replacements;
replacements.ClearPassword();
replacements.ClearUsername();
replacements.ClearRef();
if (clear_query)
replacements.ClearQuery();
// Clear port if it is implicit from scheme.
if (url.has_port()) {
const std::string& port = url.scheme();
if (url::DefaultPortForScheme(port) == url.EffectiveIntPort()) {
replacements.ClearPort();
}
}
return url.ReplaceComponents(replacements).spec();
}
std::string URLMatcherConditionFactory::CanonicalizeURLForRegexSearches(
const GURL& url) const {
return CanonicalizeURLForRegexSearchesHelper(url, false);
}
std::string
URLMatcherConditionFactory::CanonicalizeURLForOriginAndPathRegexSearches(
const GURL& url) const {
return CanonicalizeURLForRegexSearchesHelper(url, true);
}
URLMatcherCondition URLMatcherConditionFactory::CreateURLPrefixCondition(
const std::string& prefix) {
return CreateCondition(URLMatcherCondition::URL_PREFIX,
kBeginningOfURL + prefix);
}
URLMatcherCondition URLMatcherConditionFactory::CreateURLSuffixCondition(
const std::string& suffix) {
return CreateCondition(URLMatcherCondition::URL_SUFFIX, suffix + kEndOfURL);
}
URLMatcherCondition URLMatcherConditionFactory::CreateURLContainsCondition(
const std::string& str) {
return CreateCondition(URLMatcherCondition::URL_CONTAINS, str);
}
URLMatcherCondition URLMatcherConditionFactory::CreateURLEqualsCondition(
const std::string& str) {
return CreateCondition(URLMatcherCondition::URL_EQUALS,
kBeginningOfURL + str + kEndOfURL);
}
URLMatcherCondition URLMatcherConditionFactory::CreateURLMatchesCondition(
const std::string& regex) {
return CreateCondition(URLMatcherCondition::URL_MATCHES, regex);
}
URLMatcherCondition
URLMatcherConditionFactory::CreateOriginAndPathMatchesCondition(
const std::string& regex) {
return CreateCondition(URLMatcherCondition::ORIGIN_AND_PATH_MATCHES, regex);
}
void URLMatcherConditionFactory::ForgetUnusedPatterns(
const std::set<MatcherStringPattern::ID>& used_patterns) {
auto i = substring_pattern_singletons_.begin();
while (i != substring_pattern_singletons_.end()) {
if (base::Contains(used_patterns, i->first->id()))
++i;
else
substring_pattern_singletons_.erase(i++);
}
i = regex_pattern_singletons_.begin();
while (i != regex_pattern_singletons_.end()) {
if (base::Contains(used_patterns, i->first->id()))
++i;
else
regex_pattern_singletons_.erase(i++);
}
i = origin_and_path_regex_pattern_singletons_.begin();
while (i != origin_and_path_regex_pattern_singletons_.end()) {
if (base::Contains(used_patterns, i->first->id()))
++i;
else
origin_and_path_regex_pattern_singletons_.erase(i++);
}
}
bool URLMatcherConditionFactory::IsEmpty() const {
return substring_pattern_singletons_.empty() &&
regex_pattern_singletons_.empty() &&
origin_and_path_regex_pattern_singletons_.empty();
}
URLMatcherCondition URLMatcherConditionFactory::CreateCondition(
URLMatcherCondition::Criterion criterion,
const std::string& pattern) {
MatcherStringPattern search_pattern(pattern, 0);
PatternSingletons* pattern_singletons = nullptr;
if (IsRegexCriterion(criterion))
pattern_singletons = ®ex_pattern_singletons_;
else if (IsOriginAndPathRegexCriterion(criterion))
pattern_singletons = &origin_and_path_regex_pattern_singletons_;
else
pattern_singletons = &substring_pattern_singletons_;
auto iter = pattern_singletons->find(&search_pattern);
if (iter != pattern_singletons->end())
return URLMatcherCondition(criterion, iter->first);
MatcherStringPattern* new_pattern =
new MatcherStringPattern(pattern, GetNextID());
(*pattern_singletons)[new_pattern] = base::WrapUnique(new_pattern);
return URLMatcherCondition(criterion, new_pattern);
}
std::string URLMatcherConditionFactory::CanonicalizeHostSuffix(
const std::string& suffix) const {
if (suffix.empty())
return ".";
return suffix.back() == '.' ? suffix : suffix + ".";
}
std::string URLMatcherConditionFactory::CanonicalizeHostPrefix(
const std::string& prefix) const {
if (prefix.empty())
return ".";
return prefix[0] == '.' ? prefix : "." + prefix;
}
std::string URLMatcherConditionFactory::CanonicalizeHostname(
const std::string& hostname) const {
return CanonicalizeHostPrefix(CanonicalizeHostSuffix(hostname));
}
// This function prepares the query string by replacing query separator with a
// magic value (|kQueryComponentDelimiter|). When the boolean
// |prepend_beginning_of_query_component| is true the function prepends the
// query with the same magic. This is done to locate the start of a key value
// pair in the query string. The parameter |query| is passed by value
// intentionally, since it is locally modified.
std::string URLMatcherConditionFactory::CanonicalizeQuery(
std::string query,
bool prepend_beginning_of_query_component,
bool append_end_of_query_component) const {
for (std::string::iterator it = query.begin(); it != query.end(); ++it) {
if (*it == kQuerySeparator)
*it = kQueryComponentDelimiter[0];
}
if (prepend_beginning_of_query_component)
query = kQueryComponentDelimiter + query;
if (append_end_of_query_component)
query += kQueryComponentDelimiter;
return query;
}
base::MatcherStringPattern::ID URLMatcherConditionFactory::GetNextID() {
id_counter_++;
if (id_counter_ == MatcherStringPattern::kInvalidId)
id_counter_++;
return id_counter_;
}
bool URLMatcherConditionFactory::MatcherStringPatternPointerCompare::operator()(
MatcherStringPattern* lhs,
MatcherStringPattern* rhs) const {
if (lhs == nullptr && rhs != nullptr)
return true;
if (lhs != nullptr && rhs != nullptr)
return lhs->pattern() < rhs->pattern();
// Either both are NULL or only rhs is NULL.
return false;
}
//
// URLQueryElementMatcherCondition
//
URLQueryElementMatcherCondition::URLQueryElementMatcherCondition(
const std::string& key,
const std::string& value,
QueryValueMatchType query_value_match_type,
QueryElementType query_element_type,
Type match_type,
URLMatcherConditionFactory* factory) {
match_type_ = match_type;
if (query_element_type == ELEMENT_TYPE_KEY_VALUE) {
key_ = kQueryComponentDelimiter + key + "=";
value_ = value;
} else {
key_ = kQueryComponentDelimiter + key;
value_ = std::string();
}
if (query_value_match_type == QUERY_VALUE_MATCH_EXACT)
value_ += kQueryComponentDelimiter;
// If |value_| is empty no need to find the |key_| and verify if the value
// matches. Simply checking the presence of key is sufficient, which is done
// by MATCH_ANY
if (value_.empty())
match_type_ = MATCH_ANY;
URLMatcherCondition condition;
// If |match_type_| is MATCH_ANY, then we could simply look for the
// combination of |key_| + |value_|, which can be efficiently done by
// SubstringMatcher
if (match_type_ == MATCH_ANY)
condition = factory->CreateQueryContainsCondition(key_ + value_);
else
condition = factory->CreateQueryContainsCondition(key_);
string_pattern_ = condition.string_pattern();
key_length_ = key_.length();
value_length_ = value_.length();
}
URLQueryElementMatcherCondition::URLQueryElementMatcherCondition(
const URLQueryElementMatcherCondition& other) = default;
URLQueryElementMatcherCondition::~URLQueryElementMatcherCondition() = default;
bool URLQueryElementMatcherCondition::operator<(
const URLQueryElementMatcherCondition& rhs) const {
if (match_type_ != rhs.match_type_)
return match_type_ < rhs.match_type_;
if (string_pattern_ != nullptr && rhs.string_pattern_ != nullptr)
return *string_pattern_ < *rhs.string_pattern_;
if (string_pattern_ == nullptr && rhs.string_pattern_ != nullptr)
return true;
// Either string_pattern_ != NULL && rhs.string_pattern_ == NULL,
// or both are NULL.
return false;
}
bool URLQueryElementMatcherCondition::IsMatch(
const std::string& url_for_component_searches) const {
switch (match_type_) {
case MATCH_ANY: {
// For MATCH_ANY, no additional verification step is needed. We can trust
// the SubstringMatcher to do the verification.
return true;
}
case MATCH_ALL: {
size_t start = 0;
int found = 0;
size_t offset;
while ((offset = url_for_component_searches.find(key_, start)) !=
std::string::npos) {
if (url_for_component_searches.compare(offset + key_length_,
value_length_, value_) != 0) {
return false;
} else {
++found;
}
start = offset + key_length_ + value_length_ - 1;
}
return !!found;
}
case MATCH_FIRST: {
size_t offset = url_for_component_searches.find(key_);
return url_for_component_searches.compare(offset + key_length_,
value_length_, value_) == 0;
}
case MATCH_LAST: {
size_t offset = url_for_component_searches.rfind(key_);
return url_for_component_searches.compare(offset + key_length_,
value_length_, value_) == 0;
}
}
NOTREACHED();
}
//
// URLMatcherSchemeFilter
//
URLMatcherSchemeFilter::URLMatcherSchemeFilter(const std::string& filter)
: filters_(1) {
filters_.push_back(filter);
}
URLMatcherSchemeFilter::URLMatcherSchemeFilter(
const std::vector<std::string>& filters)
: filters_(filters) {}
URLMatcherSchemeFilter::~URLMatcherSchemeFilter() = default;
bool URLMatcherSchemeFilter::IsMatch(const GURL& url) const {
return base::Contains(filters_, url.scheme());
}
//
// URLMatcherPortFilter
//
URLMatcherPortFilter::URLMatcherPortFilter(
const std::vector<URLMatcherPortFilter::Range>& ranges)
: ranges_(ranges) {}
URLMatcherPortFilter::~URLMatcherPortFilter() = default;
bool URLMatcherPortFilter::IsMatch(const GURL& url) const {
int port = url.EffectiveIntPort();
for (auto i = ranges_.begin(); i != ranges_.end(); ++i) {
if (i->first <= port && port <= i->second)
return true;
}
return false;
}
// static
URLMatcherPortFilter::Range URLMatcherPortFilter::CreateRange(int from,
int to) {
return Range(from, to);
}
// static
URLMatcherPortFilter::Range URLMatcherPortFilter::CreateRange(int port) {
return Range(port, port);
}
//
// URLMatcherCidrBlockFilter
//
URLMatcherCidrBlockFilter::URLMatcherCidrBlockFilter(
std::vector<URLMatcherCidrBlockFilter::CidrBlock>&& cidr_blocks)
: cidr_blocks_(std::move(cidr_blocks)) {}
URLMatcherCidrBlockFilter::~URLMatcherCidrBlockFilter() = default;
bool URLMatcherCidrBlockFilter::IsMatch(const GURL& url) const {
// Make sure host is an IP address.
if (!url.HostIsIPAddress()) {
return false;
}
// Parse the input IP literal to a number.
net::IPAddress ip_address;
if (!ip_address.AssignFromIPLiteral(url.HostNoBracketsPiece())) {
return false;
}
return std::ranges::any_of(cidr_blocks_, [&ip_address](
const CidrBlock& block) {
return net::IPAddressMatchesPrefix(ip_address, block.first, block.second);
});
}
// static
base::expected<URLMatcherCidrBlockFilter::CidrBlock, std::string>
URLMatcherCidrBlockFilter::CreateCidrBlock(const std::string& entry) {
net::IPAddress ip_address;
size_t prefix_length_in_bits = 0;
if (!net::ParseCIDRBlock(entry, &ip_address, &prefix_length_in_bits)) {
return base::unexpected("Failed parsing CIDR");
}
return CidrBlock(ip_address, prefix_length_in_bits);
}
//
// URLMatcherConditionSet
//
URLMatcherConditionSet::~URLMatcherConditionSet() = default;
URLMatcherConditionSet::URLMatcherConditionSet(
base::MatcherStringPattern::ID id,
const Conditions& conditions)
: id_(id), conditions_(conditions) {}
URLMatcherConditionSet::URLMatcherConditionSet(
base::MatcherStringPattern::ID id,
const Conditions& conditions,
std::unique_ptr<URLMatcherSchemeFilter> scheme_filter,
std::unique_ptr<URLMatcherPortFilter> port_filter,
std::unique_ptr<URLMatcherCidrBlockFilter> cidr_block_filter)
: id_(id),
conditions_(conditions),
scheme_filter_(std::move(scheme_filter)),
port_filter_(std::move(port_filter)),
cidr_block_filter_(std::move(cidr_block_filter)) {}
URLMatcherConditionSet::URLMatcherConditionSet(
base::MatcherStringPattern::ID id,
const Conditions& conditions,
const QueryConditions& query_conditions,
std::unique_ptr<URLMatcherSchemeFilter> scheme_filter,
std::unique_ptr<URLMatcherPortFilter> port_filter)
: id_(id),
conditions_(conditions),
query_conditions_(query_conditions),
scheme_filter_(std::move(scheme_filter)),
port_filter_(std::move(port_filter)) {}
bool URLMatcherConditionSet::IsMatch(
const std::set<MatcherStringPattern::ID>& matching_patterns,
const GURL& url) const {
return IsMatch(matching_patterns, url, std::string());
}
bool URLMatcherConditionSet::IsMatch(
const std::set<MatcherStringPattern::ID>& matching_patterns,
const GURL& url,
const std::string& url_for_component_searches) const {
for (auto i = conditions_.begin(); i != conditions_.end(); ++i) {
if (!i->IsMatch(matching_patterns, url))
return false;
}
if (scheme_filter_.get() && !scheme_filter_->IsMatch(url))
return false;
if (port_filter_.get() && !port_filter_->IsMatch(url))
return false;
if (cidr_block_filter_.get() && !cidr_block_filter_->IsMatch(url)) {
return false;
}
if (query_conditions_.empty())
return true;
// The loop is duplicated below for performance reasons. If not all query
// elements are found, no need to verify match that is expected to take more
// cycles.
for (auto i = query_conditions_.begin(); i != query_conditions_.end(); ++i) {
if (!base::Contains(matching_patterns, i->string_pattern()->id()))
return false;
}
for (auto i = query_conditions_.begin(); i != query_conditions_.end(); ++i) {
if (!i->IsMatch(url_for_component_searches))
return false;
}
return true;
}
//
// URLMatcher
//
URLMatcher::URLMatcher() = default;
URLMatcher::~URLMatcher() = default;
void URLMatcher::AddConditionSets(
const URLMatcherConditionSet::Vector& condition_sets) {
for (auto i = condition_sets.begin(); i != condition_sets.end(); ++i) {
DCHECK(url_matcher_condition_sets_.find((*i)->id()) ==
url_matcher_condition_sets_.end());
url_matcher_condition_sets_[(*i)->id()] = *i;
}
UpdateInternalDatastructures();
}
void URLMatcher::RemoveConditionSets(
const std::vector<base::MatcherStringPattern::ID>& condition_set_ids) {
for (auto id : condition_set_ids) {
DCHECK(url_matcher_condition_sets_.find(id) !=
url_matcher_condition_sets_.end());
url_matcher_condition_sets_.erase(id);
}
UpdateInternalDatastructures();
}
void URLMatcher::ClearUnusedConditionSets() {
UpdateConditionFactory();
}
std::set<base::MatcherStringPattern::ID> URLMatcher::MatchURL(
const GURL& url) const {
// Find all IDs of MatcherStringPatterns that match |url|.
// See URLMatcherConditionFactory for the canonicalization of URLs and the
// distinction between full url searches and url component searches.
std::set<MatcherStringPattern::ID> matches;
std::string url_for_component_searches;
if (!IsMatcherEmpty(full_url_matcher_)) {
full_url_matcher_->Match(
condition_factory_.CanonicalizeURLForFullSearches(url), &matches);
}
if (!IsMatcherEmpty(url_component_matcher_)) {
url_for_component_searches =
condition_factory_.CanonicalizeURLForComponentSearches(url);
url_component_matcher_->Match(url_for_component_searches, &matches);
}
if (!regex_set_matcher_.IsEmpty()) {
regex_set_matcher_.Match(
condition_factory_.CanonicalizeURLForRegexSearches(url), &matches);
}
if (!origin_and_path_regex_set_matcher_.IsEmpty()) {
origin_and_path_regex_set_matcher_.Match(
condition_factory_.CanonicalizeURLForOriginAndPathRegexSearches(url),
&matches);
}
// Calculate all URLMatcherConditionSets for which all URLMatcherConditions
// were fulfilled.
std::set<base::MatcherStringPattern::ID> result;
for (auto i = matches.begin(); i != matches.end(); ++i) {
// For each URLMatcherConditionSet there is exactly one condition
// registered in substring_match_triggers_. This means that the following
// logic tests each URLMatcherConditionSet exactly once if it can be
// completely fulfilled.
auto triggered_condition_sets_iter = substring_match_triggers_.find(*i);
if (triggered_condition_sets_iter == substring_match_triggers_.end())
continue; // Not all substring matches are triggers for a condition set.
const std::set<base::MatcherStringPattern::ID>& condition_sets =
triggered_condition_sets_iter->second;
for (auto j = condition_sets.begin(); j != condition_sets.end(); ++j) {
auto condition_set_iter = url_matcher_condition_sets_.find(*j);
// Expensive: DCHECK as this is a tight loop.
DCHECK(condition_set_iter != url_matcher_condition_sets_.end());
if (condition_set_iter->second->IsMatch(matches, url,
url_for_component_searches))
result.insert(*j);
}
}
return result;
}
bool URLMatcher::IsEmpty() const {
return condition_factory_.IsEmpty() && url_matcher_condition_sets_.empty() &&
substring_match_triggers_.empty() &&
IsMatcherEmpty(full_url_matcher_) &&
IsMatcherEmpty(url_component_matcher_) &&
regex_set_matcher_.IsEmpty() &&
origin_and_path_regex_set_matcher_.IsEmpty();
}
void URLMatcher::UpdateSubstringSetMatcher(bool full_url_conditions) {
// The purpose of |full_url_conditions| is just that we need to execute
// the same logic once for Full URL searches and once for URL Component
// searches (see URLMatcherConditionFactory).
// Determine which patterns need to be registered when this function
// terminates.
std::set<const MatcherStringPattern*> new_patterns;
for (URLMatcherConditionSets::const_iterator condition_set_iter =
url_matcher_condition_sets_.begin();
condition_set_iter != url_matcher_condition_sets_.end();
++condition_set_iter) {
const URLMatcherConditionSet::Conditions& conditions =
condition_set_iter->second->conditions();
for (auto condition_iter = conditions.begin();
condition_iter != conditions.end(); ++condition_iter) {
// If we are called to process Full URL searches, ignore others, and
// vice versa. (Regex conditions are updated in UpdateRegexSetMatcher.)
if (!condition_iter->IsRegexCondition() &&
!condition_iter->IsOriginAndPathRegexCondition() &&
full_url_conditions == condition_iter->IsFullURLCondition())
new_patterns.insert(condition_iter->string_pattern());
}
if (full_url_conditions)
continue;
const URLMatcherConditionSet::QueryConditions& query_conditions =
condition_set_iter->second->query_conditions();
for (auto query_condition_iter = query_conditions.begin();
query_condition_iter != query_conditions.end();
++query_condition_iter) {
new_patterns.insert(query_condition_iter->string_pattern());
}
}
// Update the SubstringSetMatcher.
std::unique_ptr<SubstringSetMatcher>& url_matcher =
full_url_conditions ? full_url_matcher_ : url_component_matcher_;
url_matcher = std::make_unique<SubstringSetMatcher>();
bool success = url_matcher->Build(std::vector<const MatcherStringPattern*>(
new_patterns.begin(), new_patterns.end()));
CHECK(success);
}
void URLMatcher::UpdateRegexSetMatcher() {
std::vector<const MatcherStringPattern*> new_patterns;
std::vector<const MatcherStringPattern*> new_origin_and_path_patterns;
for (URLMatcherConditionSets::const_iterator condition_set_iter =
url_matcher_condition_sets_.begin();
condition_set_iter != url_matcher_condition_sets_.end();
++condition_set_iter) {
const URLMatcherConditionSet::Conditions& conditions =
condition_set_iter->second->conditions();
for (auto condition_iter = conditions.begin();
condition_iter != conditions.end(); ++condition_iter) {
if (condition_iter->IsRegexCondition()) {
new_patterns.push_back(condition_iter->string_pattern());
} else if (condition_iter->IsOriginAndPathRegexCondition()) {
new_origin_and_path_patterns.push_back(
condition_iter->string_pattern());
}
}
}
// Start over from scratch. We can't really do better than this, since the
// FilteredRE2 backend doesn't support incremental updates.
regex_set_matcher_.ClearPatterns();
regex_set_matcher_.AddPatterns(new_patterns);
origin_and_path_regex_set_matcher_.ClearPatterns();
origin_and_path_regex_set_matcher_.AddPatterns(new_origin_and_path_patterns);
}
void URLMatcher::UpdateTriggers() {
// Count substring pattern frequencies.
std::map<MatcherStringPattern::ID, size_t> substring_pattern_frequencies;
for (URLMatcherConditionSets::const_iterator condition_set_iter =
url_matcher_condition_sets_.begin();
condition_set_iter != url_matcher_condition_sets_.end();
++condition_set_iter) {
const URLMatcherConditionSet::Conditions& conditions =
condition_set_iter->second->conditions();
for (auto condition_iter = conditions.begin();
condition_iter != conditions.end(); ++condition_iter) {
const MatcherStringPattern* pattern = condition_iter->string_pattern();
substring_pattern_frequencies[pattern->id()]++;
}
const URLMatcherConditionSet::QueryConditions& query_conditions =
condition_set_iter->second->query_conditions();
for (auto query_condition_iter = query_conditions.begin();
query_condition_iter != query_conditions.end();
++query_condition_iter) {
const MatcherStringPattern* pattern =
query_condition_iter->string_pattern();
substring_pattern_frequencies[pattern->id()]++;
}
}
// Update trigger conditions: Determine for each URLMatcherConditionSet which
// URLMatcherCondition contains a MatcherStringPattern that occurs least
// frequently in this URLMatcher. We assume that this condition is very
// specific and occurs rarely in URLs. If a match occurs for this
// URLMatcherCondition, we want to test all other URLMatcherCondition in the
// respective URLMatcherConditionSet as well to see whether the entire
// URLMatcherConditionSet is considered matching.
substring_match_triggers_.clear();
for (URLMatcherConditionSets::const_iterator condition_set_iter =
url_matcher_condition_sets_.begin();
condition_set_iter != url_matcher_condition_sets_.end();
++condition_set_iter) {
const URLMatcherConditionSet::Conditions& conditions =
condition_set_iter->second->conditions();
if (conditions.empty())
continue;
auto condition_iter = conditions.begin();
MatcherStringPattern::ID trigger = condition_iter->string_pattern()->id();
// We skip the first element in the following loop.
++condition_iter;
for (; condition_iter != conditions.end(); ++condition_iter) {
MatcherStringPattern::ID current_id =
condition_iter->string_pattern()->id();
if (substring_pattern_frequencies[trigger] >
substring_pattern_frequencies[current_id]) {
trigger = current_id;
}
}
const URLMatcherConditionSet::QueryConditions& query_conditions =
condition_set_iter->second->query_conditions();
for (auto query_condition_iter = query_conditions.begin();
query_condition_iter != query_conditions.end();
++query_condition_iter) {
MatcherStringPattern::ID current_id =
query_condition_iter->string_pattern()->id();
if (substring_pattern_frequencies[trigger] >
substring_pattern_frequencies[current_id]) {
trigger = current_id;
}
}
substring_match_triggers_[trigger].insert(condition_set_iter->second->id());
}
}
void URLMatcher::UpdateConditionFactory() {
std::set<MatcherStringPattern::ID> used_patterns;
for (URLMatcherConditionSets::const_iterator condition_set_iter =
url_matcher_condition_sets_.begin();
condition_set_iter != url_matcher_condition_sets_.end();
++condition_set_iter) {
const URLMatcherConditionSet::Conditions& conditions =
condition_set_iter->second->conditions();
for (auto condition_iter = conditions.begin();
condition_iter != conditions.end(); ++condition_iter) {
used_patterns.insert(condition_iter->string_pattern()->id());
}
const URLMatcherConditionSet::QueryConditions& query_conditions =
condition_set_iter->second->query_conditions();
for (auto query_condition_iter = query_conditions.begin();
query_condition_iter != query_conditions.end();
++query_condition_iter) {
used_patterns.insert(query_condition_iter->string_pattern()->id());
}
}
condition_factory_.ForgetUnusedPatterns(used_patterns);
}
void URLMatcher::UpdateInternalDatastructures() {
UpdateSubstringSetMatcher(false);
UpdateSubstringSetMatcher(true);
UpdateRegexSetMatcher();
UpdateTriggers();
UpdateConditionFactory();
}
} // namespace url_matcher
|