File: pref_mapping.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 (114 lines) | stat: -rw-r--r-- 3,547 bytes parent folder | download | duplicates (5)
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
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_EXTENSIONS_PREF_MAPPING_H_
#define CHROME_BROWSER_EXTENSIONS_PREF_MAPPING_H_

#include <map>
#include <memory>
#include <string>

#include "base/containers/span.h"
#include "base/memory/singleton.h"
#include "build/build_config.h"
#include "extensions/buildflags/buildflags.h"
#include "extensions/common/permissions/api_permission.h"

static_assert(BUILDFLAG(ENABLE_EXTENSIONS_CORE));

namespace extensions {

class PrefTransformerInterface;

struct PrefMappingEntry {
  // Name of the preference referenced by the extension API JSON.
  const char* extension_pref;

  // Name of the preference in the PrefStores.
  const char* browser_pref;

  // Permission required to read and observe this preference.
  // Use APIPermissionID::kInvalid for `read_permission` to express that
  // the read permission should not be granted.
  extensions::mojom::APIPermissionID read_permission;

  // Permission required to write this preference.
  // Use APIPermissionID::kInvalid for `write_permission` to express that
  // the write permission should not be granted.
  extensions::mojom::APIPermissionID write_permission;
};

class PrefMapping {
 public:
  PrefMapping(const PrefMapping&) = delete;
  PrefMapping& operator=(const PrefMapping&) = delete;

  static PrefMapping* GetInstance();

  static base::span<const PrefMappingEntry> GetMappings();

  bool FindBrowserPrefForExtensionPref(
      const std::string& extension_pref,
      std::string* browser_pref,
      extensions::mojom::APIPermissionID* read_permission,
      extensions::mojom::APIPermissionID* write_permission) const;

  bool FindEventForBrowserPref(
      const std::string& browser_pref,
      std::string* event_name,
      extensions::mojom::APIPermissionID* permission) const;

  PrefTransformerInterface* FindTransformerForBrowserPref(
      const std::string& browser_pref) const;

  void RegisterPrefTransformer(
      const std::string& browser_pref,
      std::unique_ptr<PrefTransformerInterface> transformer);

 private:
  friend struct base::DefaultSingletonTraits<PrefMapping>;

  PrefMapping();
  ~PrefMapping();

  struct PrefMapData {
    PrefMapData() = default;

    PrefMapData(const std::string& pref_name,
                extensions::mojom::APIPermissionID read,
                extensions::mojom::APIPermissionID write)
        : pref_name(pref_name),
          read_permission(read),
          write_permission(write) {}

    // Browser or extension preference to which the data maps.
    std::string pref_name;

    // Permission needed to read the preference.
    extensions::mojom::APIPermissionID read_permission =
        extensions::mojom::APIPermissionID::kInvalid;

    // Permission needed to write the preference.
    extensions::mojom::APIPermissionID write_permission =
        extensions::mojom::APIPermissionID::kInvalid;
  };

  using PrefMap = std::map<std::string, PrefMapData>;

  // Mapping from extension pref keys to browser pref keys and permissions.
  PrefMap mapping_;

  // Mapping from browser pref keys to extension event names and permissions.
  PrefMap event_mapping_;

  // Mapping from browser pref keys to transformers.
  std::map<std::string, std::unique_ptr<PrefTransformerInterface>>
      transformers_;

  std::unique_ptr<PrefTransformerInterface> identity_transformer_;
};

}  // namespace extensions

#endif  // CHROME_BROWSER_EXTENSIONS_PREF_MAPPING_H_