95b12bb02c306c695e690e8aa07cf093b4f0b549
[WebKit-https.git] / Source / WebCore / inspector / InjectedScript.cpp
1 /*
2  * Copyright (C) 2010, 2011 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #include "config.h"
32 #include "InjectedScript.h"
33
34 #if ENABLE(INSPECTOR)
35
36 #include "DOMWindow.h"
37 #include "Frame.h"
38 #include "InjectedScriptHost.h"
39 #include "InjectedScriptManager.h"
40 #include "InspectorInstrumentation.h"
41 #include "InspectorValues.h"
42 #include "Node.h"
43 #include "PlatformString.h"
44 #include "ScriptFunctionCall.h"
45
46 namespace WebCore {
47
48 InjectedScript::InjectedScript()
49     : m_inspectedStateAccessCheck(0)
50 {
51 }
52
53 InjectedScript::InjectedScript(ScriptObject injectedScriptObject, InspectedStateAccessCheck accessCheck)
54     : m_injectedScriptObject(injectedScriptObject)
55     , m_inspectedStateAccessCheck(accessCheck)
56 {
57 }
58
59 void InjectedScript::evaluate(ErrorString* errorString, const String& expression, const String& objectGroup, bool includeCommandLineAPI, bool returnByValue, RefPtr<InspectorObject>* result, bool* wasThrown)
60 {
61     ScriptFunctionCall function(m_injectedScriptObject, "evaluate");
62     function.appendArgument(expression);
63     function.appendArgument(objectGroup);
64     function.appendArgument(includeCommandLineAPI);
65     function.appendArgument(returnByValue);
66     makeEvalCall(errorString, function, result, wasThrown);
67 }
68
69 void InjectedScript::callFunctionOn(ErrorString* errorString, const String& objectId, const String& expression, const String& arguments, bool returnByValue, RefPtr<InspectorObject>* result, bool* wasThrown)
70 {
71     ScriptFunctionCall function(m_injectedScriptObject, "callFunctionOn");
72     function.appendArgument(objectId);
73     function.appendArgument(expression);
74     function.appendArgument(arguments);
75     function.appendArgument(returnByValue);
76     makeEvalCall(errorString, function, result, wasThrown);
77 }
78
79 void InjectedScript::evaluateOnCallFrame(ErrorString* errorString, const ScriptValue& callFrames, const String& callFrameId, const String& expression, const String& objectGroup, bool includeCommandLineAPI, bool returnByValue, RefPtr<InspectorObject>* result, bool* wasThrown)
80 {
81     ScriptFunctionCall function(m_injectedScriptObject, "evaluateOnCallFrame");
82     function.appendArgument(callFrames);
83     function.appendArgument(callFrameId);
84     function.appendArgument(expression);
85     function.appendArgument(objectGroup);
86     function.appendArgument(includeCommandLineAPI);
87     function.appendArgument(returnByValue);
88     makeEvalCall(errorString, function, result, wasThrown);
89 }
90
91 void InjectedScript::getProperties(ErrorString* errorString, const String& objectId, bool ownProperties, RefPtr<InspectorArray>* properties)
92 {
93     ScriptFunctionCall function(m_injectedScriptObject, "getProperties");
94     function.appendArgument(objectId);
95     function.appendArgument(ownProperties);
96
97     RefPtr<InspectorValue> result;
98     makeCall(function, &result);
99     if (!result || result->type() != InspectorValue::TypeArray) {
100         *errorString = "Internal error";
101         return;
102     }
103     *properties = result->asArray();
104 }
105
106 Node* InjectedScript::nodeForObjectId(const String& objectId)
107 {
108     if (hasNoValue() || !canAccessInspectedWindow())
109         return 0;
110
111     ScriptFunctionCall function(m_injectedScriptObject, "nodeForObjectId");
112     function.appendArgument(objectId);
113
114     bool hadException = false;
115     ScriptValue resultValue = function.call(hadException);
116     ASSERT(!hadException);
117
118     return InjectedScriptHost::scriptValueAsNode(resultValue);
119 }
120
121 void InjectedScript::releaseObject(const String& objectId)
122 {
123     ScriptFunctionCall function(m_injectedScriptObject, "releaseObject");
124     function.appendArgument(objectId);
125     RefPtr<InspectorValue> result;
126     makeCall(function, &result);
127 }
128
129 #if ENABLE(JAVASCRIPT_DEBUGGER)
130 PassRefPtr<InspectorArray> InjectedScript::wrapCallFrames(const ScriptValue& callFrames)
131 {
132     ASSERT(!hasNoValue());
133     ScriptFunctionCall function(m_injectedScriptObject, "wrapCallFrames");
134     function.appendArgument(callFrames);
135     ScriptValue callFramesValue = function.call();
136     RefPtr<InspectorValue> result = callFramesValue.toInspectorValue(m_injectedScriptObject.scriptState());
137     if (result->type() == InspectorValue::TypeArray)
138         return result->asArray();
139     return InspectorArray::create();
140 }
141 #endif
142
143 PassRefPtr<InspectorObject> InjectedScript::wrapObject(ScriptValue value, const String& groupName)
144 {
145     ASSERT(!hasNoValue());
146     ScriptFunctionCall wrapFunction(m_injectedScriptObject, "wrapObject");
147     wrapFunction.appendArgument(value);
148     wrapFunction.appendArgument(groupName);
149     wrapFunction.appendArgument(canAccessInspectedWindow());
150     bool hadException = false;
151     ScriptValue r = wrapFunction.call(hadException);
152     if (hadException) {
153         RefPtr<InspectorObject> result = InspectorObject::create();
154         result->setString("description", "<exception>");
155         return result;
156     }
157     return r.toInspectorValue(m_injectedScriptObject.scriptState())->asObject();
158 }
159
160 PassRefPtr<InspectorObject> InjectedScript::wrapNode(Node* node, const String& groupName)
161 {
162     return wrapObject(nodeAsScriptValue(node), groupName);
163 }
164
165 void InjectedScript::inspectNode(Node* node)
166 {
167     ASSERT(!hasNoValue());
168     ScriptFunctionCall function(m_injectedScriptObject, "inspectNode");
169     function.appendArgument(nodeAsScriptValue(node));
170     RefPtr<InspectorValue> result;
171     makeCall(function, &result);
172 }
173
174 void InjectedScript::releaseObjectGroup(const String& objectGroup)
175 {
176     ASSERT(!hasNoValue());
177     ScriptFunctionCall releaseFunction(m_injectedScriptObject, "releaseObjectGroup");
178     releaseFunction.appendArgument(objectGroup);
179     releaseFunction.call();
180 }
181
182 bool InjectedScript::canAccessInspectedWindow()
183 {
184     return m_inspectedStateAccessCheck(m_injectedScriptObject.scriptState());
185 }
186
187 void InjectedScript::makeCall(ScriptFunctionCall& function, RefPtr<InspectorValue>* result)
188 {
189     if (hasNoValue() || !canAccessInspectedWindow()) {
190         *result = InspectorValue::null();
191         return;
192     }
193
194     DOMWindow* domWindow = domWindowFromScriptState(m_injectedScriptObject.scriptState());
195     InspectorInstrumentationCookie cookie = domWindow && domWindow->frame() ? InspectorInstrumentation::willCallFunction(domWindow->frame()->page(), "InjectedScript", 1) : InspectorInstrumentationCookie();
196     bool hadException = false;
197     ScriptValue resultValue = function.call(hadException);
198     InspectorInstrumentation::didCallFunction(cookie);
199
200     ASSERT(!hadException);
201     if (!hadException) {
202         *result = resultValue.toInspectorValue(m_injectedScriptObject.scriptState());
203         if (!*result)
204             *result = InspectorString::create(String::format("Object has too long reference chain(must not be longer than %d)", InspectorValue::maxDepth));
205     } else
206         *result = InspectorString::create("Exception while making a call.");
207 }
208
209 void InjectedScript::makeEvalCall(ErrorString* errorString, ScriptFunctionCall& function, RefPtr<InspectorObject>* objectResult, bool* wasThrown)
210 {
211     RefPtr<InspectorValue> result;
212     makeCall(function, &result);
213     if (!result) {
214         *errorString = "Internal error: result value is empty";
215         return;
216     }
217     if (result->type() == InspectorValue::TypeString) {
218         result->asString(errorString);
219         return;
220     }
221     RefPtr<InspectorObject> resultPair = result->asObject();
222     if (!resultPair) {
223         *errorString = "Internal error: result is not an Object";
224         return;
225     }
226     RefPtr<InspectorObject> resultObj = resultPair->getObject("result");
227     bool wasThrownVal = false;
228     if (!resultObj || !resultPair->getBoolean("wasThrown", &wasThrownVal)) {
229         *errorString = "Internal error: result is not a pair of value and wasThrown flag";
230         return;
231     }
232     *objectResult = resultObj;
233     *wasThrown = wasThrownVal;
234 }
235
236 ScriptValue InjectedScript::nodeAsScriptValue(Node* node)
237 {
238     return InjectedScriptHost::nodeAsScriptValue(m_injectedScriptObject.scriptState(), node);
239 }
240
241 } // namespace WebCore
242
243 #endif // ENABLE(INSPECTOR)