File: plus_address_blocklist_data.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (74 lines) | stat: -rw-r--r-- 2,580 bytes parent folder | download | duplicates (9)
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
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_PLUS_ADDRESSES_PLUS_ADDRESS_BLOCKLIST_DATA_H_
#define COMPONENTS_PLUS_ADDRESSES_PLUS_ADDRESS_BLOCKLIST_DATA_H_

#include <string>

#include "base/sequence_checker.h"
#include "third_party/re2/src/re2/re2.h"

namespace plus_addresses {

// Possible states of parsing the response body when a fetch completes in
// `PlusAddressBlocklistData`.
//
// Needs to be kept in sync with `PlusAddressBlocklistDataParsingResult` in
// tools/metrics/histograms/metadata/plus_addresses/enums.xml.
//
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
enum class PlusAddressBlocklistDataParsingResult {
  // The response body was empty.
  kEmptyResponse = 0,

  // The response body could not be parsed as
  // `CompactPlusAddressBlockedFacets`
  // proto message.
  kParsingError = 1,

  // Parsing was successful.
  kSuccess = 2,

  kMaxValue = kSuccess
};

// This holds the set of patterns that define the set of facets for which Plus
// Addresses should not be offered. The data to populate it is read from the
// Component Updater, which fetches it periodically from Google to get the
// most up-to-date patterns.
class PlusAddressBlocklistData final {
 public:
  static PlusAddressBlocklistData& GetInstance();

  PlusAddressBlocklistData();
  PlusAddressBlocklistData(const PlusAddressBlocklistData&) = delete;
  PlusAddressBlocklistData& operator=(const PlusAddressBlocklistData&) = delete;
  ~PlusAddressBlocklistData();

  // Updates the internal list from a binary proto fetched from the network.
  // This can be called multiple times with new protos. Returns `true` if the
  // parsing process was successful, `false` otherwise.
  bool PopulateDataFromComponent(const std::string& binary_pb);

  // Returns a regular expression that specifies which domains should not have
  // Plus Addresses offered on them.
  const re2::RE2* GetExclusionPattern() const;

  // Returns a regular expression that specifies which domains should be exempt
  // from a blocklist rule.
  const re2::RE2* GetExceptionPattern() const;

 private:
  SEQUENCE_CHECKER(sequence_checker_);

  std::unique_ptr<re2::RE2> exclusion_pattern_
      GUARDED_BY_CONTEXT(sequence_checker_);
  std::unique_ptr<re2::RE2> exception_pattern_
      GUARDED_BY_CONTEXT(sequence_checker_);
};
}  // namespace plus_addresses

#endif  // COMPONENTS_PLUS_ADDRESSES_PLUS_ADDRESS_BLOCKLIST_DATA_H_