File: extension_url_pattern_index_matcher.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (112 lines) | stat: -rw-r--r-- 4,707 bytes parent folder | download | duplicates (7)
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
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef EXTENSIONS_BROWSER_API_DECLARATIVE_NET_REQUEST_EXTENSION_URL_PATTERN_INDEX_MATCHER_H_
#define EXTENSIONS_BROWSER_API_DECLARATIVE_NET_REQUEST_EXTENSION_URL_PATTERN_INDEX_MATCHER_H_

#include <vector>

#include "base/containers/flat_set.h"
#include "base/memory/raw_ptr.h"
#include "components/url_pattern_index/url_pattern_index.h"
#include "extensions/browser/api/declarative_net_request/constants.h"
#include "extensions/browser/api/declarative_net_request/ruleset_matcher_base.h"

namespace extensions::declarative_net_request {

// ExtensionUrlPatternIndexMatcher is an implementation detail of
// RulesetMatcher. It deals with matching of filter list style rules. This uses
// the url_pattern_index component to achieve fast matching of network requests
// against declarative rules.
class ExtensionUrlPatternIndexMatcher final : public RulesetMatcherBase {
 public:
  using UrlPatternIndexList = flatbuffers::Vector<
      flatbuffers::Offset<url_pattern_index::flat::UrlPatternIndex>>;
  ExtensionUrlPatternIndexMatcher(
      const ExtensionId& extension_id,
      RulesetID ruleset_id,
      const UrlPatternIndexList* before_request_index_list,
      const UrlPatternIndexList* headers_received_index_list,
      const ExtensionMetadataList* metadata_list);

  ExtensionUrlPatternIndexMatcher(const ExtensionUrlPatternIndexMatcher&) =
      delete;
  ExtensionUrlPatternIndexMatcher& operator=(
      const ExtensionUrlPatternIndexMatcher&) = delete;

  // RulesetMatcherBase override:
  ~ExtensionUrlPatternIndexMatcher() override;
  std::vector<RequestAction> GetModifyHeadersActions(
      const RequestParams& params,
      RulesetMatchingStage stage,
      std::optional<uint64_t> min_priority) const override;
  bool IsExtraHeadersMatcher() const override;
  size_t GetRulesCount() const override;
  size_t GetBeforeRequestRulesCount() const override;
  size_t GetHeadersReceivedRulesCount() const override;

  // Sets the disabled rule ids so that the disabled rules are not matched.
  void SetDisabledRuleIds(base::flat_set<int> disabled_rule_ids);

  const base::flat_set<int>& GetDisabledRuleIdsForTesting() const;

 private:
  using UrlPatternIndexMatcher = url_pattern_index::UrlPatternIndexMatcher;

  // RulesetMatcherBase override:
  std::optional<RequestAction> GetAllowAllRequestsAction(
      const RequestParams& params,
      RulesetMatchingStage stage) const override;
  std::optional<RequestAction> GetActionIgnoringAncestors(
      const RequestParams& params,
      RulesetMatchingStage stage) const override;

  // Returns the highest priority action from
  // |flat::IndexType_before_request_except_allow_all_requests| index.
  std::optional<RequestAction> GetActionHelper(
      const RequestParams& params,
      const std::vector<UrlPatternIndexMatcher>& matchers) const;

  const url_pattern_index::flat::UrlRule* GetMatchingRule(
      const RequestParams& params,
      const std::vector<UrlPatternIndexMatcher>& matchers,
      flat::IndexType index,
      UrlPatternIndexMatcher::FindRuleStrategy strategy =
          UrlPatternIndexMatcher::FindRuleStrategy::kAny) const;

  std::vector<const url_pattern_index::flat::UrlRule*> GetAllMatchingRules(
      const RequestParams& params,
      const std::vector<UrlPatternIndexMatcher>& matchers,
      flat::IndexType index) const;

  // Returns the corresponding rule matchers for the given rule matching
  // `stage`.
  const std::vector<UrlPatternIndexMatcher>& GetMatchersForStage(
      RulesetMatchingStage stage) const;

  const raw_ptr<const ExtensionMetadataList> metadata_list_;

  // UrlPatternIndexMatchers for rules to be matched in the onBeforeRequest
  // phase corresponding to entries in flat::IndexType.
  const std::vector<UrlPatternIndexMatcher> before_request_matchers_;

  // UrlPatternIndexMatchers for rules to be matched in the onHeadersReceived
  // phase corresponding to entries in flat::IndexType.
  const std::vector<UrlPatternIndexMatcher> headers_received_matchers_;

  const size_t before_request_rules_count_;

  const size_t headers_received_rules_count_;

  // Whether this matcher contains rules that will match on, or modify headers.
  const bool is_extra_headers_matcher_;

  // Disabled rule ids. The ids are passed to the matching algorithm in the
  // UrlPatternIndexMatcher so that the algorithm can skip the disabled rules.
  base::flat_set<int> disabled_rule_ids_;
};

}  // namespace extensions::declarative_net_request

#endif  // EXTENSIONS_BROWSER_API_DECLARATIVE_NET_REQUEST_EXTENSION_URL_PATTERN_INDEX_MATCHER_H_