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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_COMMON_EXTENSIONS_FEATURES_FEATURE_H_
#define CHROME_COMMON_EXTENSIONS_FEATURES_FEATURE_H_
#include <set>
#include <string>
#include "base/values.h"
#include "chrome/common/chrome_version_info.h"
#include "chrome/common/extensions/extension.h"
#include "chrome/common/extensions/manifest.h"
class GURL;
namespace extensions {
// Represents a single feature accessible to an extension developer, such as a
// top-level manifest key, a permission, or a programmatic API. A feature can
// express requirements for where it can be accessed, and supports testing
// support for those requirements.
class Feature {
public:
// The JavaScript contexts the feature is supported in.
enum Context {
UNSPECIFIED_CONTEXT,
// A context in a privileged extension process.
BLESSED_EXTENSION_CONTEXT,
// A context in an unprivileged extension process.
UNBLESSED_EXTENSION_CONTEXT,
// A context from a content script.
CONTENT_SCRIPT_CONTEXT,
// A normal web page. This should have an associated URL matching pattern.
WEB_PAGE_CONTEXT,
};
// The location required of extensions the feature is supported in.
enum Location {
UNSPECIFIED_LOCATION,
COMPONENT_LOCATION
};
// The platforms the feature is supported in.
enum Platform {
UNSPECIFIED_PLATFORM,
CHROMEOS_PLATFORM
};
// Whether a feature is available in a given situation or not, and if not,
// why not.
enum AvailabilityResult {
IS_AVAILABLE,
NOT_FOUND_IN_WHITELIST,
INVALID_URL,
INVALID_TYPE,
INVALID_CONTEXT,
INVALID_LOCATION,
INVALID_PLATFORM,
INVALID_MIN_MANIFEST_VERSION,
INVALID_MAX_MANIFEST_VERSION,
NOT_PRESENT,
UNSUPPORTED_CHANNEL,
};
// Container for AvailabiltyResult that also exposes a user-visible error
// message in cases where the feature is not available.
class Availability {
public:
AvailabilityResult result() const { return result_; }
bool is_available() const { return result_ == IS_AVAILABLE; }
const std::string& message() const { return message_; }
private:
friend class SimpleFeature;
friend class Feature;
// Instances should be created via Feature::CreateAvailability.
Availability(AvailabilityResult result, const std::string& message)
: result_(result), message_(message) { }
const AvailabilityResult result_;
const std::string message_;
};
Feature();
virtual ~Feature();
// Used by ChromeV8Context until the feature system is fully functional.
static Availability CreateAvailability(AvailabilityResult result,
const std::string& message);
// Gets the current channel as seen by the Feature system.
static chrome::VersionInfo::Channel GetCurrentChannel();
// Sets the current channel as seen by the Feature system. In the browser
// process this should be chrome::VersionInfo::GetChannel(), and in the
// renderer this will need to come from an IPC.
static void SetCurrentChannel(chrome::VersionInfo::Channel channel);
// Gets the default channel as seen by the Feature system.
static chrome::VersionInfo::Channel GetDefaultChannel();
// Scoped channel setter. Use for tests.
class ScopedCurrentChannel {
public:
explicit ScopedCurrentChannel(chrome::VersionInfo::Channel channel)
: original_channel_(chrome::VersionInfo::CHANNEL_UNKNOWN) {
original_channel_ = GetCurrentChannel();
SetCurrentChannel(channel);
}
~ScopedCurrentChannel() {
SetCurrentChannel(original_channel_);
}
private:
chrome::VersionInfo::Channel original_channel_;
};
const std::string& name() const { return name_; }
void set_name(const std::string& name) { name_ = name; }
const std::set<std::string>& dependencies() { return dependencies_; }
// Gets the platform the code is currently running on.
static Platform GetCurrentPlatform();
// Gets the Feature::Location value for the specified Manifest::Location.
static Location ConvertLocation(Manifest::Location extension_location);
virtual std::set<Context>* GetContexts() = 0;
// Tests whether this is an internal API or not.
virtual bool IsInternal() const = 0;
// Returns true if the feature is available to be parsed into a new extension
// manifest.
Availability IsAvailableToManifest(const std::string& extension_id,
Manifest::Type type,
Location location,
int manifest_version) const {
return IsAvailableToManifest(extension_id, type, location, manifest_version,
GetCurrentPlatform());
}
virtual Availability IsAvailableToManifest(const std::string& extension_id,
Manifest::Type type,
Location location,
int manifest_version,
Platform platform) const = 0;
// Returns true if the feature is available to be used in the specified
// extension and context.
Availability IsAvailableToContext(const Extension* extension,
Context context,
const GURL& url) const {
return IsAvailableToContext(extension, context, url, GetCurrentPlatform());
}
virtual Availability IsAvailableToContext(const Extension* extension,
Context context,
const GURL& url,
Platform platform) const = 0;
virtual std::string GetAvailabilityMessage(AvailabilityResult result,
Manifest::Type type,
const GURL& url) const = 0;
protected:
std::string name_;
std::set<std::string> dependencies_;
};
} // namespace extensions
#endif // CHROME_COMMON_EXTENSIONS_FEATURES_FEATURE_H_
|
