Remove the Timer parameters from timer callbacks
[WebKit-https.git] / Source / WebCore / inspector / InspectorFrontendClientLocal.cpp
1 /*
2  * Copyright (C) 2010 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
33 #if ENABLE(INSPECTOR)
34
35 #include "InspectorFrontendClientLocal.h"
36
37 #include "Chrome.h"
38 #include "DOMWrapperWorld.h"
39 #include "Document.h"
40 #include "FloatRect.h"
41 #include "FrameLoadRequest.h"
42 #include "FrameLoader.h"
43 #include "FrameView.h"
44 #include "InspectorController.h"
45 #include "InspectorFrontendHost.h"
46 #include "InspectorPageAgent.h"
47 #include "MainFrame.h"
48 #include "Page.h"
49 #include "ScriptController.h"
50 #include "ScriptGlobalObject.h"
51 #include "ScriptState.h"
52 #include "Settings.h"
53 #include "Timer.h"
54 #include "UserGestureIndicator.h"
55 #include "WindowFeatures.h"
56 #include <bindings/ScriptValue.h>
57 #include <inspector/InspectorBackendDispatchers.h>
58 #include <wtf/Deque.h>
59 #include <wtf/text/CString.h>
60
61 using namespace Inspector;
62
63 namespace WebCore {
64
65 static const char* inspectorAttachedHeightSetting = "inspectorAttachedHeight";
66 static const unsigned defaultAttachedHeight = 300;
67 static const float minimumAttachedHeight = 250.0f;
68 static const float maximumAttachedHeightRatio = 0.75f;
69 static const float minimumAttachedWidth = 750.0f;
70 static const float minimumAttachedInspectedWidth = 320.0f;
71
72 class InspectorBackendDispatchTask {
73     WTF_MAKE_FAST_ALLOCATED;
74 public:
75     InspectorBackendDispatchTask(InspectorController* inspectorController)
76         : m_inspectorController(inspectorController)
77         , m_timer(*this, &InspectorBackendDispatchTask::timerFired)
78     {
79     }
80
81     void dispatch(const String& message)
82     {
83         m_messages.append(message);
84         if (!m_timer.isActive())
85             m_timer.startOneShot(0);
86     }
87
88     void reset()
89     {
90         m_messages.clear();
91         m_timer.stop();
92     }
93
94     void timerFired()
95     {
96         if (!m_messages.isEmpty()) {
97             // Dispatch can lead to the timer destruction -> schedule the next shot first.
98             m_timer.startOneShot(0);
99             m_inspectorController->dispatchMessageFromFrontend(m_messages.takeFirst());
100         }
101     }
102
103 private:
104     InspectorController* m_inspectorController;
105     Timer m_timer;
106     Deque<String> m_messages;
107 };
108
109 String InspectorFrontendClientLocal::Settings::getProperty(const String&)
110 {
111     return String();
112 }
113
114 void InspectorFrontendClientLocal::Settings::setProperty(const String&, const String&)
115 {
116 }
117
118 InspectorFrontendClientLocal::InspectorFrontendClientLocal(InspectorController* inspectorController, Page* frontendPage, std::unique_ptr<Settings> settings)
119     : m_inspectorController(inspectorController)
120     , m_frontendPage(frontendPage)
121     , m_settings(WTF::move(settings))
122     , m_frontendLoaded(false)
123     , m_dockSide(DockSide::Undocked)
124 {
125     m_frontendPage->settings().setAllowFileAccessFromFileURLs(true);
126     m_dispatchTask = std::make_unique<InspectorBackendDispatchTask>(inspectorController);
127 }
128
129 InspectorFrontendClientLocal::~InspectorFrontendClientLocal()
130 {
131     if (m_frontendHost)
132         m_frontendHost->disconnectClient();
133     m_frontendPage = 0;
134     m_inspectorController = 0;
135 }
136
137 void InspectorFrontendClientLocal::windowObjectCleared()
138 {
139     if (m_frontendHost)
140         m_frontendHost->disconnectClient();
141     
142     JSC::ExecState* frontendExecState = execStateFromPage(debuggerWorld(), m_frontendPage);
143     m_frontendHost = InspectorFrontendHost::create(this, m_frontendPage);
144     ScriptGlobalObject::set(frontendExecState, "InspectorFrontendHost", m_frontendHost.get());
145 }
146
147 void InspectorFrontendClientLocal::frontendLoaded()
148 {
149     // Call setDockingUnavailable before bringToFront. If we display the inspector window via bringToFront first it causes
150     // the call to canAttachWindow to return the wrong result on Windows.
151     // Calling bringToFront first causes the visibleHeight of the inspected page to always return 0 immediately after. 
152     // Thus if we call canAttachWindow first we can avoid this problem. This change does not cause any regressions on Mac.
153     setDockingUnavailable(!canAttachWindow());
154     bringToFront();
155     m_frontendLoaded = true;
156     for (Vector<String>::iterator it = m_evaluateOnLoad.begin(); it != m_evaluateOnLoad.end(); ++it)
157         evaluateOnLoad(*it);
158     m_evaluateOnLoad.clear();
159 }
160
161 void InspectorFrontendClientLocal::requestSetDockSide(DockSide dockSide)
162 {
163     if (dockSide == DockSide::Undocked) {
164         detachWindow();
165         setAttachedWindow(dockSide);
166     } else if (canAttachWindow()) {
167         attachWindow(dockSide);
168         setAttachedWindow(dockSide);
169     }
170 }
171
172 bool InspectorFrontendClientLocal::canAttachWindow()
173 {
174     // Don't allow attaching to another inspector -- two inspectors in one window is too much!
175     bool isInspectorPage = m_inspectorController->hasInspectorFrontendClient();
176     if (isInspectorPage)
177         return false;
178
179     // If we are already attached, allow attaching again to allow switching sides.
180     if (m_dockSide != DockSide::Undocked)
181         return true;
182
183     // Don't allow the attach if the window would be too small to accommodate the minimum inspector size.
184     unsigned inspectedPageHeight = m_inspectorController->inspectedPage().mainFrame().view()->visibleHeight();
185     unsigned inspectedPageWidth = m_inspectorController->inspectedPage().mainFrame().view()->visibleWidth();
186     unsigned maximumAttachedHeight = inspectedPageHeight * maximumAttachedHeightRatio;
187     return minimumAttachedHeight <= maximumAttachedHeight && minimumAttachedWidth <= inspectedPageWidth;
188 }
189
190 void InspectorFrontendClientLocal::setDockingUnavailable(bool unavailable)
191 {
192     evaluateOnLoad(String::format("[\"setDockingUnavailable\", %s]", unavailable ? "true" : "false"));
193 }
194
195 void InspectorFrontendClientLocal::changeAttachedWindowHeight(unsigned height)
196 {
197     unsigned totalHeight = m_frontendPage->mainFrame().view()->visibleHeight() + m_inspectorController->inspectedPage().mainFrame().view()->visibleHeight();
198     unsigned attachedHeight = constrainedAttachedWindowHeight(height, totalHeight);
199     m_settings->setProperty(inspectorAttachedHeightSetting, String::number(attachedHeight));
200     setAttachedWindowHeight(attachedHeight);
201 }
202
203 void InspectorFrontendClientLocal::changeAttachedWindowWidth(unsigned width)
204 {
205     unsigned totalWidth = m_frontendPage->mainFrame().view()->visibleWidth() + m_inspectorController->inspectedPage().mainFrame().view()->visibleWidth();
206     unsigned attachedWidth = constrainedAttachedWindowWidth(width, totalWidth);
207     setAttachedWindowWidth(attachedWidth);
208 }
209
210 void InspectorFrontendClientLocal::openInNewTab(const String& url)
211 {
212     UserGestureIndicator indicator(DefinitelyProcessingUserGesture);
213     Frame& mainFrame = m_inspectorController->inspectedPage().mainFrame();
214     FrameLoadRequest request(mainFrame.document()->securityOrigin(), ResourceRequest(), "_blank");
215
216     bool created;
217     WindowFeatures windowFeatures;
218     RefPtr<Frame> frame = WebCore::createWindow(&mainFrame, &mainFrame, request, windowFeatures, created);
219     if (!frame)
220         return;
221
222     frame->loader().setOpener(&mainFrame);
223     frame->page()->setOpenedByDOM();
224
225     // FIXME: Why does one use mainFrame and the other frame?
226     frame->loader().changeLocation(mainFrame.document()->securityOrigin(), frame->document()->completeURL(url), "", LockHistory::No, LockBackForwardList::No);
227 }
228
229 void InspectorFrontendClientLocal::moveWindowBy(float x, float y)
230 {
231     FloatRect frameRect = m_frontendPage->chrome().windowRect();
232     frameRect.move(x, y);
233     m_frontendPage->chrome().setWindowRect(frameRect);
234 }
235
236 void InspectorFrontendClientLocal::setAttachedWindow(DockSide dockSide)
237 {
238     const char* side = "undocked";
239     switch (dockSide) {
240     case DockSide::Undocked:
241         side = "undocked";
242         break;
243     case DockSide::Right:
244         side = "right";
245         break;
246     case DockSide::Bottom:
247         side = "bottom";
248         break;
249     }
250
251     m_dockSide = dockSide;
252
253     evaluateOnLoad(String::format("[\"setDockSide\", \"%s\"]", side));
254 }
255
256 void InspectorFrontendClientLocal::restoreAttachedWindowHeight()
257 {
258     unsigned inspectedPageHeight = m_inspectorController->inspectedPage().mainFrame().view()->visibleHeight();
259     String value = m_settings->getProperty(inspectorAttachedHeightSetting);
260     unsigned preferredHeight = value.isEmpty() ? defaultAttachedHeight : value.toUInt();
261     
262     // This call might not go through (if the window starts out detached), but if the window is initially created attached,
263     // InspectorController::attachWindow is never called, so we need to make sure to set the attachedWindowHeight.
264     // FIXME: Clean up code so we only have to call setAttachedWindowHeight in InspectorController::attachWindow
265     setAttachedWindowHeight(constrainedAttachedWindowHeight(preferredHeight, inspectedPageHeight));
266 }
267
268 bool InspectorFrontendClientLocal::isDebuggingEnabled()
269 {
270     if (m_frontendLoaded)
271         return evaluateAsBoolean("[\"isDebuggingEnabled\"]");
272     return false;
273 }
274
275 void InspectorFrontendClientLocal::setDebuggingEnabled(bool enabled)
276 {
277     evaluateOnLoad(String::format("[\"setDebuggingEnabled\", %s]", enabled ? "true" : "false"));
278 }
279
280 bool InspectorFrontendClientLocal::isTimelineProfilingEnabled()
281 {
282     if (m_frontendLoaded)
283         return evaluateAsBoolean("[\"isTimelineProfilingEnabled\"]");
284     return false;
285 }
286
287 void InspectorFrontendClientLocal::setTimelineProfilingEnabled(bool enabled)
288 {
289     evaluateOnLoad(String::format("[\"setTimelineProfilingEnabled\", %s]", enabled ? "true" : "false"));
290 }
291
292 bool InspectorFrontendClientLocal::isProfilingJavaScript()
293 {
294     if (m_frontendLoaded)
295         return evaluateAsBoolean("[\"isProfilingJavaScript\"]");
296     return false;
297 }
298
299 void InspectorFrontendClientLocal::startProfilingJavaScript()
300 {
301     evaluateOnLoad("[\"startProfilingJavaScript\"]");
302 }
303
304 void InspectorFrontendClientLocal::stopProfilingJavaScript()
305 {
306     evaluateOnLoad("[\"stopProfilingJavaScript\"]");
307 }
308
309 void InspectorFrontendClientLocal::showConsole()
310 {
311     evaluateOnLoad("[\"showConsole\"]");
312 }
313
314 void InspectorFrontendClientLocal::showResources()
315 {
316     evaluateOnLoad("[\"showResources\"]");
317 }
318
319 void InspectorFrontendClientLocal::showMainResourceForFrame(Frame* frame)
320 {
321     String frameId = m_inspectorController->pageAgent()->frameId(frame);
322     evaluateOnLoad(String::format("[\"showMainResourceForFrame\", \"%s\"]", frameId.ascii().data()));
323 }
324
325 unsigned InspectorFrontendClientLocal::constrainedAttachedWindowHeight(unsigned preferredHeight, unsigned totalWindowHeight)
326 {
327     return roundf(std::max(minimumAttachedHeight, std::min<float>(preferredHeight, totalWindowHeight * maximumAttachedHeightRatio)));
328 }
329
330 unsigned InspectorFrontendClientLocal::constrainedAttachedWindowWidth(unsigned preferredWidth, unsigned totalWindowWidth)
331 {
332     return roundf(std::max(minimumAttachedWidth, std::min<float>(preferredWidth, totalWindowWidth - minimumAttachedInspectedWidth)));
333 }
334
335 void InspectorFrontendClientLocal::sendMessageToBackend(const String& message)
336 {
337     m_dispatchTask->dispatch(message);
338 }
339
340 bool InspectorFrontendClientLocal::isUnderTest()
341 {
342     return m_inspectorController->isUnderTest();
343 }
344
345 bool InspectorFrontendClientLocal::evaluateAsBoolean(const String& expression)
346 {
347     Deprecated::ScriptValue value = m_frontendPage->mainFrame().script().executeScript(expression);
348     return value.toString(mainWorldExecState(&m_frontendPage->mainFrame())) == "true";
349 }
350
351 void InspectorFrontendClientLocal::evaluateOnLoad(const String& expression)
352 {
353     if (m_frontendLoaded)
354         m_frontendPage->mainFrame().script().executeScript("InspectorFrontendAPI.dispatch(" + expression + ")");
355     else
356         m_evaluateOnLoad.append(expression);
357 }
358
359 } // namespace WebCore
360
361 #endif