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
|
// Copyright 2017 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_COMMON_API_DECLARATIVE_NET_REQUEST_DNR_MANIFEST_DATA_H_
#define EXTENSIONS_COMMON_API_DECLARATIVE_NET_REQUEST_DNR_MANIFEST_DATA_H_
#include <map>
#include <string>
#include <vector>
#include "base/files/file_path.h"
#include "base/memory/raw_ptr.h"
#include "extensions/common/api/declarative_net_request/constants.h"
#include "extensions/common/extension.h"
namespace extensions::declarative_net_request {
// Manifest data required for the kDeclarativeNetRequestKey manifest
// key.
struct DNRManifestData : Extension::ManifestData {
struct RulesetInfo {
RulesetInfo();
~RulesetInfo();
RulesetInfo(RulesetInfo&&);
RulesetInfo& operator=(RulesetInfo&&);
base::FilePath relative_path;
// ID provided for the ruleset in the extension manifest. Uniquely
// identifies the ruleset.
// TODO(karandeepb): Rename to `public_id`.
std::string manifest_id;
// Uniquely identifies an extension ruleset. The order of rulesets within
// the manifest defines the order for ids. In practice, this is equal to
// kMinValidStaticRulesetID + the index of the ruleset within `rulesets`.
// Note: we introduce another notion of a ruleset ID in addition to
// `manifest_id` since the id is also used as an input to preference keys
// and indexed ruleset file paths, and integral IDs are easier to reason
// about here. E.g. a string ID can have invalid file path characters.
RulesetID id;
// Whether the ruleset is enabled by default. Note that this value
// corresponds to the one specified in the extension manifest. Extensions
// may further dynamically toggle whether a ruleset is enabled or not.
bool enabled = false;
};
using ManifestIDToRulesetMap =
std::map<std::string, raw_ptr<const RulesetInfo, CtnExperimental>>;
explicit DNRManifestData(std::vector<RulesetInfo> ruleset);
DNRManifestData(const DNRManifestData&) = delete;
DNRManifestData& operator=(const DNRManifestData&) = delete;
~DNRManifestData() override;
// Returns the RulesetInfo for the `extension`. For an extension, which didn't
// specify a static ruleset, an empty vector is returned.
static const std::vector<RulesetInfo>& GetRulesets(
const Extension& extension);
// Returns the RulesetInfo corresponding to the given `ruleset_id`. Must only
// be called for a valid `ruleset_id`.
static const RulesetInfo& GetRuleset(const Extension& extension,
RulesetID ruleset_id);
static const ManifestIDToRulesetMap& GetManifestIDToRulesetMap(
const Extension& extension);
// Static rulesets specified by the extension in its manifest, in the order in
// which they were specified.
std::vector<RulesetInfo> rulesets;
// Map from the manifest ID to the corresponding RulesetInfo.
ManifestIDToRulesetMap manifest_id_to_ruleset_map;
};
} // namespace extensions::declarative_net_request
#endif // EXTENSIONS_COMMON_API_DECLARATIVE_NET_REQUEST_DNR_MANIFEST_DATA_H_
|
