-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
PageRuntimeAgent.cpp
217 lines (179 loc) · 9.27 KB
/
PageRuntimeAgent.cpp
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
/*
* Copyright (C) 2011 Google Inc. All rights reserved.
* Copyright (C) 2015 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "PageRuntimeAgent.h"
#include "DOMWrapperWorld.h"
#include "Document.h"
#include "InspectorPageAgent.h"
#include "InstrumentingAgents.h"
#include "JSExecState.h"
#include "JSLocalDOMWindowCustom.h"
#include "LocalFrame.h"
#include "Page.h"
#include "PageConsoleClient.h"
#include "ScriptController.h"
#include "SecurityOrigin.h"
#include "UserGestureEmulationScope.h"
#include <JavaScriptCore/InjectedScript.h>
#include <JavaScriptCore/InjectedScriptManager.h>
#include <JavaScriptCore/InspectorProtocolObjects.h>
namespace WebCore {
using namespace Inspector;
PageRuntimeAgent::PageRuntimeAgent(PageAgentContext& context)
: InspectorRuntimeAgent(context)
, m_frontendDispatcher(makeUnique<Inspector::RuntimeFrontendDispatcher>(context.frontendRouter))
, m_backendDispatcher(Inspector::RuntimeBackendDispatcher::create(context.backendDispatcher, this))
, m_instrumentingAgents(context.instrumentingAgents)
, m_inspectedPage(context.inspectedPage)
{
}
PageRuntimeAgent::~PageRuntimeAgent() = default;
Protocol::ErrorStringOr<void> PageRuntimeAgent::enable()
{
if (m_instrumentingAgents.enabledPageRuntimeAgent() == this)
return { };
auto result = InspectorRuntimeAgent::enable();
if (!result)
return result;
// Report initial contexts before enabling instrumentation as the reporting
// can force creation of script state which could result in duplicate notifications.
reportExecutionContextCreation();
m_instrumentingAgents.setEnabledPageRuntimeAgent(this);
return result;
}
Protocol::ErrorStringOr<void> PageRuntimeAgent::disable()
{
m_instrumentingAgents.setEnabledPageRuntimeAgent(nullptr);
return InspectorRuntimeAgent::disable();
}
void PageRuntimeAgent::frameNavigated(LocalFrame& frame)
{
// Ensure execution context is created for the frame even if it doesn't have scripts.
mainWorldGlobalObject(frame);
}
void PageRuntimeAgent::didClearWindowObjectInWorld(LocalFrame& frame, DOMWrapperWorld& world)
{
auto* pageAgent = m_instrumentingAgents.enabledPageAgent();
if (!pageAgent)
return;
notifyContextCreated(pageAgent->frameId(&frame), frame.script().globalObject(world), world);
}
InjectedScript PageRuntimeAgent::injectedScriptForEval(Protocol::ErrorString& errorString, std::optional<Protocol::Runtime::ExecutionContextId>&& executionContextId)
{
if (!executionContextId) {
auto* localMainFrame = dynamicDowncast<LocalFrame>(m_inspectedPage.mainFrame());
if (!localMainFrame)
return InjectedScript();
InjectedScript result = injectedScriptManager().injectedScriptFor(&mainWorldGlobalObject(*localMainFrame));
if (result.hasNoValue())
errorString = "Internal error: main world execution context not found"_s;
return result;
}
InjectedScript injectedScript = injectedScriptManager().injectedScriptForId(*executionContextId);
if (injectedScript.hasNoValue())
errorString = "Missing injected script for given executionContextId"_s;
return injectedScript;
}
void PageRuntimeAgent::muteConsole()
{
PageConsoleClient::mute();
}
void PageRuntimeAgent::unmuteConsole()
{
PageConsoleClient::unmute();
}
void PageRuntimeAgent::reportExecutionContextCreation()
{
auto* pageAgent = m_instrumentingAgents.enabledPageAgent();
if (!pageAgent)
return;
m_inspectedPage.forEachFrame([&](LocalFrame& frame) {
if (!frame.script().canExecuteScripts(ReasonForCallingCanExecuteScripts::NotAboutToExecuteScript))
return;
auto frameId = pageAgent->frameId(&frame);
// Always send the main world first.
auto& mainGlobalObject = mainWorldGlobalObject(frame);
notifyContextCreated(frameId, &mainGlobalObject, mainThreadNormalWorld());
for (auto& jsWindowProxy : frame.windowProxy().jsWindowProxiesAsVector()) {
auto* globalObject = jsWindowProxy->window();
if (globalObject == &mainGlobalObject)
continue;
auto& securityOrigin = downcast<LocalDOMWindow>(jsWindowProxy->wrapped()).document()->securityOrigin();
notifyContextCreated(frameId, globalObject, jsWindowProxy->world(), &securityOrigin);
}
});
}
static Protocol::Runtime::ExecutionContextType toProtocol(DOMWrapperWorld::Type type)
{
switch (type) {
case DOMWrapperWorld::Type::Normal:
return Protocol::Runtime::ExecutionContextType::Normal;
case DOMWrapperWorld::Type::User:
return Protocol::Runtime::ExecutionContextType::User;
case DOMWrapperWorld::Type::Internal:
return Protocol::Runtime::ExecutionContextType::Internal;
}
ASSERT_NOT_REACHED();
return Protocol::Runtime::ExecutionContextType::Internal;
}
void PageRuntimeAgent::notifyContextCreated(const Protocol::Network::FrameId& frameId, JSC::JSGlobalObject* globalObject, const DOMWrapperWorld& world, SecurityOrigin* securityOrigin)
{
auto injectedScript = injectedScriptManager().injectedScriptFor(globalObject);
if (injectedScript.hasNoValue())
return;
auto name = world.name();
if (name.isEmpty() && securityOrigin)
name = securityOrigin->toRawString();
m_frontendDispatcher->executionContextCreated(Protocol::Runtime::ExecutionContextDescription::create()
.setId(injectedScriptManager().injectedScriptIdFor(globalObject))
.setType(toProtocol(world.type()))
.setName(name)
.setFrameId(frameId)
.release());
}
Protocol::ErrorStringOr<std::tuple<Ref<Protocol::Runtime::RemoteObject>, std::optional<bool> /* wasThrown */, std::optional<int> /* savedResultIndex */>> PageRuntimeAgent::evaluate(const String& expression, const String& objectGroup, std::optional<bool>&& includeCommandLineAPI, std::optional<bool>&& doNotPauseOnExceptionsAndMuteConsole, std::optional<Protocol::Runtime::ExecutionContextId>&& executionContextId, std::optional<bool>&& returnByValue, std::optional<bool>&& generatePreview, std::optional<bool>&& saveResult, std::optional<bool>&& emulateUserGesture)
{
Protocol::ErrorString errorString;
auto injectedScript = injectedScriptForEval(errorString, WTFMove(executionContextId));
if (injectedScript.hasNoValue())
return makeUnexpected(errorString);
UserGestureEmulationScope userGestureScope(m_inspectedPage, emulateUserGesture.value_or(false), dynamicDowncast<Document>(executionContext(injectedScript.globalObject())));
return InspectorRuntimeAgent::evaluate(injectedScript, expression, objectGroup, WTFMove(includeCommandLineAPI), WTFMove(doNotPauseOnExceptionsAndMuteConsole), WTFMove(returnByValue), WTFMove(generatePreview), WTFMove(saveResult), WTFMove(emulateUserGesture));
}
Protocol::ErrorStringOr<std::tuple<Ref<Protocol::Runtime::RemoteObject>, std::optional<bool> /* wasThrown */>> PageRuntimeAgent::callFunctionOn(const Protocol::Runtime::RemoteObjectId& objectId, const String& expression, RefPtr<JSON::Array>&& optionalArguments, std::optional<bool>&& doNotPauseOnExceptionsAndMuteConsole, std::optional<bool>&& returnByValue, std::optional<bool>&& generatePreview, std::optional<bool>&& emulateUserGesture)
{
auto injectedScript = injectedScriptManager().injectedScriptForObjectId(objectId);
if (injectedScript.hasNoValue())
return makeUnexpected("Missing injected script for given objectId"_s);
UserGestureEmulationScope userGestureScope(m_inspectedPage, emulateUserGesture.value_or(false), dynamicDowncast<Document>(executionContext(injectedScript.globalObject())));
return InspectorRuntimeAgent::callFunctionOn(injectedScript, objectId, expression, WTFMove(optionalArguments), WTFMove(doNotPauseOnExceptionsAndMuteConsole), WTFMove(returnByValue), WTFMove(generatePreview), WTFMove(emulateUserGesture));
}
} // namespace WebCore