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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
// Copyright 2023 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_USER_SCRIPTS_USER_SCRIPTS_API_H_
#define EXTENSIONS_BROWSER_API_USER_SCRIPTS_USER_SCRIPTS_API_H_
#include "extensions/browser/extension_function.h"
#include "extensions/browser/extension_function_histogram_value.h"
#include "extensions/browser/scripting_utils.h"
#include "extensions/common/api/user_scripts.h"
namespace extensions {
class UserScriptsRegisterFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("userScripts.register", USERSCRIPTS_REGISTER)
UserScriptsRegisterFunction() = default;
UserScriptsRegisterFunction(const UserScriptsRegisterFunction&) = delete;
const UserScriptsRegisterFunction& operator=(
const UserScriptsRegisterFunction&) = delete;
// ExtensionFunction:
ResponseAction Run() override;
private:
~UserScriptsRegisterFunction() override = default;
// Called when user script files have been validated.
void OnUserScriptFilesValidated(scripting::ValidateScriptsResult result);
// Called when user scripts have been registered.
void OnUserScriptsRegistered(const std::optional<std::string>& error);
};
class UserScriptsGetScriptsFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("userScripts.getScripts", USERSCRIPTS_GETSCRIPTS)
UserScriptsGetScriptsFunction() = default;
UserScriptsGetScriptsFunction(const UserScriptsRegisterFunction&) = delete;
const UserScriptsGetScriptsFunction& operator=(
const UserScriptsGetScriptsFunction&) = delete;
// ExtensionFunction:
ResponseAction Run() override;
private:
~UserScriptsGetScriptsFunction() override = default;
};
class UserScriptsUnregisterFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("userScripts.unregister", USERSCRIPTS_UNREGISTER)
UserScriptsUnregisterFunction() = default;
UserScriptsUnregisterFunction(const UserScriptsUnregisterFunction&) = delete;
const UserScriptsUnregisterFunction& operator=(
const UserScriptsUnregisterFunction&) = delete;
// ExtensionFunction:
ResponseAction Run() override;
private:
~UserScriptsUnregisterFunction() override = default;
// Called when user scripts have been unregistered..
void OnUserScriptsUnregistered(const std::optional<std::string>& error);
};
class UserScriptsUpdateFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("userScripts.update", USERSCRIPTS_UPDATE)
UserScriptsUpdateFunction() = default;
UserScriptsUpdateFunction(const UserScriptsUpdateFunction&) = delete;
const UserScriptsUpdateFunction& operator=(const UserScriptsUpdateFunction&) =
delete;
// ExtensionFunction:
ResponseAction Run() override;
private:
~UserScriptsUpdateFunction() override = default;
// Returns a UserScript object by updating the `original_script` with the
// `new_script` given delta. If the updated script cannot be parsed, populates
// `parse_error` and returns nullptr.
std::unique_ptr<UserScript> ApplyUpdate(
api::user_scripts::RegisteredUserScript& new_script,
api::user_scripts::RegisteredUserScript& original_script,
std::u16string* parse_error);
// Called when user script files have been validated.
void OnUserScriptFilesValidated(scripting::ValidateScriptsResult result);
// Called when user scripts have been updated..
void OnUserScriptsUpdated(const std::optional<std::string>& error);
};
class UserScriptsExecuteFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("userScripts.execute", USERSCRIPTS_EXECUTE)
UserScriptsExecuteFunction() = default;
UserScriptsExecuteFunction(const UserScriptsExecuteFunction&) = delete;
const UserScriptsExecuteFunction& operator=(
const UserScriptsExecuteFunction&) = delete;
// ExtensionFunction:
ResponseAction Run() override;
private:
~UserScriptsExecuteFunction() override = default;
// Called when the resource files to be injected has been loaded.
void DidLoadResources(ScriptExecutor* script_executor,
ScriptExecutor::FrameScope frame_scope,
std::set<int> frame_ids,
std::vector<std::optional<mojom::JSSourcePtr>> sources,
std::vector<scripting::InjectedFileSource> file_sources,
std::optional<std::string> load_error);
// Triggers the execution of `sources` in the appropriate context.
void Execute(std::vector<std::optional<mojom::JSSourcePtr>> sources,
ScriptExecutor* script_executor,
ScriptExecutor::FrameScope frame_scope,
std::set<int> frame_ids,
std::string* error);
// Invoked when script execution is complete.
void OnScriptExecuted(std::vector<ScriptExecutor::FrameResult> frame_results);
api::user_scripts::UserScriptInjection injection_;
};
class UserScriptsConfigureWorldFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("userScripts.configureWorld",
USERSCRIPTS_CONFIGUREWORLD)
UserScriptsConfigureWorldFunction() = default;
UserScriptsConfigureWorldFunction(const UserScriptsConfigureWorldFunction&) =
delete;
const UserScriptsConfigureWorldFunction& operator=(
const UserScriptsConfigureWorldFunction&) = delete;
// ExtensionFunction:
ResponseAction Run() override;
private:
~UserScriptsConfigureWorldFunction() override = default;
};
class UserScriptsGetWorldConfigurationsFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("userScripts.getWorldConfigurations",
USERSCRIPTS_GETWORLDCONFIGURATIONS)
UserScriptsGetWorldConfigurationsFunction() = default;
UserScriptsGetWorldConfigurationsFunction(
const UserScriptsGetWorldConfigurationsFunction&) = delete;
const UserScriptsGetWorldConfigurationsFunction& operator=(
const UserScriptsGetWorldConfigurationsFunction&) = delete;
// ExtensionFunction:
ResponseAction Run() override;
private:
~UserScriptsGetWorldConfigurationsFunction() override = default;
};
class UserScriptsResetWorldConfigurationFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("userScripts.resetWorldConfiguration",
USERSCRIPTS_RESETWORLDCONFIGURATION)
UserScriptsResetWorldConfigurationFunction() = default;
UserScriptsResetWorldConfigurationFunction(
const UserScriptsResetWorldConfigurationFunction&) = delete;
const UserScriptsResetWorldConfigurationFunction& operator=(
const UserScriptsResetWorldConfigurationFunction&) = delete;
// ExtensionFunction:
ResponseAction Run() override;
private:
~UserScriptsResetWorldConfigurationFunction() override = default;
};
} // namespace extensions
#endif // EXTENSIONS_BROWSER_API_USER_SCRIPTS_USER_SCRIPTS_API_H_
|
