blob: 8de3dc83ea983a38c9882c3572717e78c46d8607 (
plain)
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
|
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef NET_BASE_SCHEME_HOST_PORT_MATCHER_H_
#define NET_BASE_SCHEME_HOST_PORT_MATCHER_H_
#include <string>
#include <vector>
#include "net/base/net_export.h"
#include "net/base/scheme_host_port_matcher_rule.h"
namespace net {
// SchemeHostPortMatcher holds an ordered list of rules for matching URLs, that
// is serializable to a string.
//
// Rules are evaluated in reverse, and each can be either an "include this URL"
// or an "exclude this URL".
//
// In a simple configuration, all rules are "include this URL" so evaluation
// order doesn't matter. When combining include and exclude rules,
// later rules will have precedence over earlier rules.
class NET_EXPORT SchemeHostPortMatcher {
public:
using RuleList = std::vector<std::unique_ptr<SchemeHostPortMatcherRule>>;
// Note: This class is movable but not copiable.
SchemeHostPortMatcher();
SchemeHostPortMatcher(SchemeHostPortMatcher&& rhs);
SchemeHostPortMatcher& operator=(SchemeHostPortMatcher&& rhs);
~SchemeHostPortMatcher();
// The delimiter used by |ToString()|.
constexpr static char kPrintRuleListDelimiter = ';';
// The delimiters to use when parsing rules.
constexpr static char kParseRuleListDelimiterList[] = ",;";
// Creates a SchemeHostPortMatcher by best-effort parsing each of the
// |kParseRuleListDelimiterList| separated rules. Any rules that could not be
// parsed are silently rejected. It only parses all the rule types that appear
// in scheme_host_port_rules.h, types with other serializations will need to
// be handled by the caller.
static SchemeHostPortMatcher FromRawString(const std::string& raw);
// Returns the current list of rules.
const RuleList& rules() const { return rules_; }
// Add rule to the matcher as the first one in the rule list.
void AddAsFirstRule(std::unique_ptr<SchemeHostPortMatcherRule> rule);
// Add rule to the matcher as the last one in the rule list.
void AddAsLastRule(std::unique_ptr<SchemeHostPortMatcherRule> rule);
// Replace rule on |index| in the internal RuleList.
void ReplaceRule(size_t index,
std::unique_ptr<SchemeHostPortMatcherRule> rule);
// Returns true if |url| was positively matched by the rules.
bool Includes(const GURL& url) const;
// Returns the result of evaluating the rule list. Prefer using Includes()
// over this function. Evaluate() can be used when the caller needs to
// distinguish when matches were due to negative rules.
SchemeHostPortMatcherResult Evaluate(const GURL& url) const;
// Serializes the rules to a string representation. The serialized
// representation is a |kPrintRuleListDelimiter| delimited list of rules,
// where each rule defines its own serialization.
std::string ToString() const;
// Removes all the rules.
void Clear();
private:
RuleList rules_;
};
} // namespace net
#endif // NET_BASE_SCHEME_HOST_PORT_MATCHER_H_
|
