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
|
// 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_BROWSER_EXTENSIONS_SCRIPT_EXECUTOR_H_
#define CHROME_BROWSER_EXTENSIONS_SCRIPT_EXECUTOR_H_
#include <string>
#include "base/callback_forward.h"
#include "base/observer_list.h"
#include "chrome/common/extensions/user_script.h"
namespace base {
class ListValue;
} // namespace base
namespace content {
class WebContents;
}
namespace extensions {
// Interface for executing extension content scripts (e.g. executeScript) as
// described by the ExtensionMsg_ExecuteCode_Params IPC, and notifying the
// caller when responded with ExtensionHostMsg_ExecuteCodeFinished.
class ScriptExecutor {
public:
explicit ScriptExecutor(content::WebContents* web_contents);
~ScriptExecutor();
// The type of script being injected.
enum ScriptType {
JAVASCRIPT,
CSS,
};
// The scope of the script injection across the frames.
enum FrameScope {
TOP_FRAME,
ALL_FRAMES,
};
// The type of world to inject into (main world, or its own isolated world).
enum WorldType {
MAIN_WORLD,
ISOLATED_WORLD,
};
// Callback from ExecuteScript. The arguments are (success, page_id, error,
// result). page_id is only valid on success, error is only valid on !success.
typedef base::Callback<void(bool, int32, const std::string&,
const base::ListValue&)>
ExecuteScriptCallback;
class Observer {
public:
// Automatically observes and unobserves *script_executor on construction
// and destruction. *script_executor must outlive *this.
explicit Observer(ScriptExecutor* script_executor);
virtual ~Observer();
virtual void OnExecuteScriptFinished(const std::string& extension_id,
bool success,
int32 page_id,
const std::string& error,
const base::ListValue&) = 0;
private:
ScriptExecutor& script_executor_;
};
// Executes a script. The arguments match ExtensionMsg_ExecuteCode_Params in
// extension_messages.h (request_id is populated automatically).
//
// |callback| will always be called even if the IPC'd renderer is destroyed
// before a response is received (in this case the callback will be with a
// failure and appropriate error message).
void ExecuteScript(const std::string& extension_id,
ScriptType script_type,
const std::string& code,
FrameScope frame_scope,
UserScript::RunLocation run_at,
WorldType world_type,
const ExecuteScriptCallback& callback);
void AddObserver(Observer* obs) {
observer_list_.AddObserver(obs);
}
void RemoveObserver(Observer* obs) {
observer_list_.RemoveObserver(obs);
}
private:
// The next value to use for request_id in ExtensionMsg_ExecuteCode_Params.
int next_request_id_;
// The WebContents this is bound to.
content::WebContents* web_contents_;
ObserverList<Observer> observer_list_;
};
} // namespace extensions
#endif // CHROME_BROWSER_EXTENSIONS_SCRIPT_EXECUTOR_H_
|
