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
|
// Copyright 2013 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_EXECUTE_CODE_FUNCTION_H_
#define EXTENSIONS_BROWSER_API_EXECUTE_CODE_FUNCTION_H_
#include <memory>
#include <optional>
#include <string>
#include <vector>
#include "extensions/browser/extension_function.h"
#include "extensions/browser/script_executor.h"
#include "extensions/common/api/extension_types.h"
#include "extensions/common/mojom/host_id.mojom.h"
namespace extensions {
// Base class for javascript code injection.
// This is used by both chrome.webview.executeScript and
// chrome.tabs.executeScript.
class ExecuteCodeFunction : public ExtensionFunction {
public:
ExecuteCodeFunction();
ExecuteCodeFunction(const ExecuteCodeFunction&) = delete;
ExecuteCodeFunction& operator=(const ExecuteCodeFunction&) = delete;
protected:
~ExecuteCodeFunction() override;
// ExtensionFunction implementation.
ResponseAction Run() override;
enum InitResult {
// ExtensionFunction validation failure.
// Warning: Validation failures kill the renderer and should only be used
// for circumstances that should never happen.
VALIDATION_FAILURE,
// Failure other than validation.
// Failures return an error to the extension function and should be used
// when an error situation occurs: e.g. trying to execute script during
// browser shutdown.
FAILURE,
SUCCESS
};
// Initializes `details_` and other variables if they haven't already been.
// Returns whether or not it succeeded. Failure can be tolerable (FAILURE), or
// fatal (VALIDATION_FAILURE).
virtual InitResult Init() = 0;
virtual bool ShouldInsertCSS() const = 0;
virtual bool ShouldRemoveCSS() const = 0;
virtual bool CanExecuteScriptOnPage(std::string* error) = 0;
virtual ScriptExecutor* GetScriptExecutor(std::string* error) = 0;
virtual bool IsWebView() const = 0;
virtual int GetRootFrameId() const = 0;
virtual const GURL& GetWebViewSrc() const = 0;
virtual bool LoadFile(const std::string& file, std::string* error);
// Called when contents from the loaded file have been localized.
void DidLoadAndLocalizeFile(const std::string& file,
std::vector<std::unique_ptr<std::string>> data,
std::optional<std::string> load_error);
const mojom::HostID& host_id() const { return host_id_; }
void set_host_id(const mojom::HostID& host_id) { host_id_ = host_id; }
InitResult set_init_result(InitResult init_result) {
init_result_ = init_result;
return init_result_.value();
}
InitResult set_init_result_error(const std::string& error) {
init_error_ = error;
return set_init_result(FAILURE);
}
// The injection details.
// Note that for tabs.removeCSS we still use `InjectDetails` rather than
// `DeleteInjectionDetails`, since the two types are compatible; the value
// of `run_at` defaults to `RUN_AT_NONE`.
std::optional<api::extension_types::InjectDetails> details_;
std::optional<InitResult> init_result_;
// Set iff `init_result_` == FAILURE, holds the error string.
std::optional<std::string> init_error_;
private:
void OnExecuteCodeFinished(std::vector<ScriptExecutor::FrameResult> results);
// Run in UI thread. Code string contains the code to be executed. Returns
// true on success. If true is returned, this does an AddRef. Returns false on
// failure and sets `error`.
bool Execute(const std::string& code_string, std::string* error);
// The URL of the file being injected into the page, in the
// chrome-extension: scheme.
GURL script_url_;
// The ID of the injection host.
mojom::HostID host_id_;
// The ID of the root frame to inject into.
int root_frame_id_ = -1;
};
} // namespace extensions
#endif // EXTENSIONS_BROWSER_API_EXECUTE_CODE_FUNCTION_H_
|
