WebInspectorProxy.cpp [plain text]
#include "config.h"
#include "WebInspectorProxy.h"
#if ENABLE(INSPECTOR)
#include "APIURLRequest.h"
#include "WebFramePolicyListenerProxy.h"
#include "WebFrameProxy.h"
#include "WebInspectorMessages.h"
#include "WebInspectorProxyMessages.h"
#include "WebPageCreationParameters.h"
#include "WebPageGroup.h"
#include "WebPageProxy.h"
#include "WebPreferences.h"
#include "WebProcessProxy.h"
#include <WebCore/SchemeRegistry.h>
#include <wtf/NeverDestroyed.h>
#include <wtf/text/StringBuilder.h>
#if ENABLE(INSPECTOR_SERVER)
#include "WebInspectorServer.h"
#endif
using namespace WebCore;
namespace WebKit {
const unsigned WebInspectorProxy::minimumWindowWidth = 750;
const unsigned WebInspectorProxy::minimumWindowHeight = 400;
const unsigned WebInspectorProxy::initialWindowWidth = 1000;
const unsigned WebInspectorProxy::initialWindowHeight = 650;
const unsigned WebInspectorProxy::minimumAttachedWidth = 750;
const unsigned WebInspectorProxy::minimumAttachedHeight = 250;
class WebInspectorPageGroups {
public:
static WebInspectorPageGroups& shared()
{
static NeverDestroyed<WebInspectorPageGroups> instance;
return instance;
}
unsigned inspectorLevel(WebPageGroup& inspectedPageGroup)
{
return isInspectorPageGroup(inspectedPageGroup) ? inspectorPageGroupLevel(inspectedPageGroup) + 1 : 1;
}
bool isInspectorPageGroup(WebPageGroup& group)
{
return m_pageGroupLevel.contains(&group);
}
unsigned inspectorPageGroupLevel(WebPageGroup& group)
{
ASSERT(isInspectorPageGroup(group));
return m_pageGroupLevel.get(&group);
}
WebPageGroup* inspectorPageGroupForLevel(unsigned level)
{
ASSERT(level);
auto iterator = m_pageGroupByLevel.find(level);
if (iterator != m_pageGroupByLevel.end())
return iterator->value.get();
RefPtr<WebPageGroup> group = createInspectorPageGroup(level);
m_pageGroupByLevel.set(level, group.get());
m_pageGroupLevel.set(group.get(), level);
return group.get();
}
private:
static PassRefPtr<WebPageGroup> createInspectorPageGroup(unsigned level)
{
RefPtr<WebPageGroup> pageGroup = WebPageGroup::create(String::format("__WebInspectorPageGroupLevel%u__", level), false, false);
#ifndef NDEBUG
pageGroup->preferences().setDeveloperExtrasEnabled(true);
pageGroup->preferences().setLogsPageMessagesToSystemConsoleEnabled(true);
#endif
pageGroup->preferences().setApplicationChromeModeEnabled(true);
return pageGroup.release();
}
typedef HashMap<unsigned, RefPtr<WebPageGroup> > PageGroupByLevelMap;
typedef HashMap<WebPageGroup*, unsigned> PageGroupLevelMap;
PageGroupByLevelMap m_pageGroupByLevel;
PageGroupLevelMap m_pageGroupLevel;
};
WebInspectorProxy::WebInspectorProxy(WebPageProxy* page)
: m_page(page)
, m_isVisible(false)
, m_isAttached(false)
, m_isDebuggingJavaScript(false)
, m_isProfilingJavaScript(false)
, m_isProfilingPage(false)
, m_showMessageSent(false)
, m_createdInspectorPage(false)
, m_ignoreFirstBringToFront(false)
, m_attachmentSide(AttachmentSideBottom)
#if PLATFORM(GTK) || PLATFORM(EFL)
, m_inspectorView(0)
, m_inspectorWindow(0)
#endif
#if ENABLE(INSPECTOR_SERVER)
, m_remoteInspectionPageId(0)
#endif
{
m_level = WebInspectorPageGroups::shared().inspectorLevel(m_page->pageGroup());
m_page->process().addMessageReceiver(Messages::WebInspectorProxy::messageReceiverName(), m_page->pageID(), *this);
}
WebInspectorProxy::~WebInspectorProxy()
{
}
WebPageGroup* WebInspectorProxy::inspectorPageGroup() const
{
return WebInspectorPageGroups::shared().inspectorPageGroupForLevel(m_level);
}
void WebInspectorProxy::invalidate()
{
#if ENABLE(INSPECTOR_SERVER)
if (m_remoteInspectionPageId)
WebInspectorServer::shared().unregisterPage(m_remoteInspectionPageId);
#endif
m_page->process().removeMessageReceiver(Messages::WebInspectorProxy::messageReceiverName(), m_page->pageID());
didClose();
m_page = 0;
}
bool WebInspectorProxy::isFront()
{
if (!m_page)
return false;
return platformIsFront();
}
void WebInspectorProxy::connect()
{
if (!m_page)
return;
if (m_showMessageSent)
return;
m_showMessageSent = true;
m_ignoreFirstBringToFront = true;
m_page->process().send(Messages::WebInspector::Show(), m_page->pageID());
}
void WebInspectorProxy::show()
{
if (!m_page)
return;
if (isConnected()) {
bringToFront();
return;
}
connect();
m_ignoreFirstBringToFront = false;
}
void WebInspectorProxy::hide()
{
if (!m_page)
return;
m_isVisible = false;
platformHide();
}
void WebInspectorProxy::close()
{
if (!m_page)
return;
m_page->process().send(Messages::WebInspector::Close(), m_page->pageID());
didClose();
}
void WebInspectorProxy::showConsole()
{
if (!m_page)
return;
m_page->process().send(Messages::WebInspector::ShowConsole(), m_page->pageID());
}
void WebInspectorProxy::showResources()
{
if (!m_page)
return;
m_page->process().send(Messages::WebInspector::ShowResources(), m_page->pageID());
}
void WebInspectorProxy::showMainResourceForFrame(WebFrameProxy* frame)
{
if (!m_page)
return;
m_page->process().send(Messages::WebInspector::ShowMainResourceForFrame(frame->frameID()), m_page->pageID());
}
void WebInspectorProxy::attachBottom()
{
attach(AttachmentSideBottom);
}
void WebInspectorProxy::attachRight()
{
attach(AttachmentSideRight);
}
void WebInspectorProxy::attach(AttachmentSide side)
{
if (!m_page || !canAttach())
return;
m_isAttached = true;
m_attachmentSide = side;
inspectorPageGroup()->preferences().setInspectorAttachmentSide(side);
if (m_isVisible)
inspectorPageGroup()->preferences().setInspectorStartsAttached(true);
switch (m_attachmentSide) {
case AttachmentSideBottom:
m_page->process().send(Messages::WebInspector::AttachedBottom(), m_page->pageID());
break;
case AttachmentSideRight:
m_page->process().send(Messages::WebInspector::AttachedRight(), m_page->pageID());
break;
}
platformAttach();
}
void WebInspectorProxy::detach()
{
if (!m_page)
return;
m_isAttached = false;
if (m_isVisible)
inspectorPageGroup()->preferences().setInspectorStartsAttached(false);
m_page->process().send(Messages::WebInspector::Detached(), m_page->pageID());
platformDetach();
}
void WebInspectorProxy::setAttachedWindowHeight(unsigned height)
{
inspectorPageGroup()->preferences().setInspectorAttachedHeight(height);
platformSetAttachedWindowHeight(height);
}
void WebInspectorProxy::setAttachedWindowWidth(unsigned width)
{
inspectorPageGroup()->preferences().setInspectorAttachedWidth(width);
platformSetAttachedWindowWidth(width);
}
void WebInspectorProxy::toggleJavaScriptDebugging()
{
if (!m_page)
return;
if (m_isDebuggingJavaScript)
m_page->process().send(Messages::WebInspector::StopJavaScriptDebugging(), m_page->pageID());
else
m_page->process().send(Messages::WebInspector::StartJavaScriptDebugging(), m_page->pageID());
m_isDebuggingJavaScript = !m_isDebuggingJavaScript;
}
void WebInspectorProxy::toggleJavaScriptProfiling()
{
if (!m_page)
return;
if (m_isProfilingJavaScript)
m_page->process().send(Messages::WebInspector::StopJavaScriptProfiling(), m_page->pageID());
else
m_page->process().send(Messages::WebInspector::StartJavaScriptProfiling(), m_page->pageID());
m_isProfilingJavaScript = !m_isProfilingJavaScript;
}
void WebInspectorProxy::togglePageProfiling()
{
if (!m_page)
return;
if (m_isProfilingPage)
m_page->process().send(Messages::WebInspector::StopPageProfiling(), m_page->pageID());
else
m_page->process().send(Messages::WebInspector::StartPageProfiling(), m_page->pageID());
m_isProfilingPage = !m_isProfilingPage;
}
bool WebInspectorProxy::isInspectorPage(WebPageProxy& page)
{
return WebInspectorPageGroups::shared().isInspectorPageGroup(page.pageGroup());
}
static bool isMainOrTestInspectorPage(const WebInspectorProxy* webInspectorProxy, WKURLRequestRef requestRef)
{
URL requestURL(URL(), toImpl(requestRef)->resourceRequest().url());
if (!WebCore::SchemeRegistry::shouldTreatURLSchemeAsLocal(requestURL.protocol()))
return false;
URL mainPageURL(URL(), webInspectorProxy->inspectorPageURL());
ASSERT(WebCore::SchemeRegistry::shouldTreatURLSchemeAsLocal(mainPageURL.protocol()));
if (decodeURLEscapeSequences(requestURL.path()) == decodeURLEscapeSequences(mainPageURL.path()))
return true;
String testPageURLString = webInspectorProxy->inspectorTestPageURL();
if (testPageURLString.isNull())
return false;
URL testPageURL(URL(), webInspectorProxy->inspectorTestPageURL());
ASSERT(WebCore::SchemeRegistry::shouldTreatURLSchemeAsLocal(testPageURL.protocol()));
return decodeURLEscapeSequences(requestURL.path()) == decodeURLEscapeSequences(testPageURL.path());
}
static void decidePolicyForNavigationAction(WKPageRef, WKFrameRef frameRef, WKFrameNavigationType, WKEventModifiers, WKEventMouseButton, WKFrameRef, WKURLRequestRef requestRef, WKFramePolicyListenerRef listenerRef, WKTypeRef, const void* clientInfo)
{
if (!toImpl(frameRef)->isMainFrame()) {
toImpl(listenerRef)->use();
return;
}
const WebInspectorProxy* webInspectorProxy = static_cast<const WebInspectorProxy*>(clientInfo);
ASSERT(webInspectorProxy);
if (isMainOrTestInspectorPage(webInspectorProxy, requestRef)) {
toImpl(listenerRef)->use();
return;
}
toImpl(listenerRef)->ignore();
webInspectorProxy->page()->loadRequest(toImpl(requestRef)->resourceRequest());
}
#if ENABLE(INSPECTOR_SERVER)
void WebInspectorProxy::enableRemoteInspection()
{
if (!m_remoteInspectionPageId)
m_remoteInspectionPageId = WebInspectorServer::shared().registerPage(this);
}
void WebInspectorProxy::remoteFrontendConnected()
{
m_page->process().send(Messages::WebInspector::RemoteFrontendConnected(), m_page->pageID());
}
void WebInspectorProxy::remoteFrontendDisconnected()
{
m_page->process().send(Messages::WebInspector::RemoteFrontendDisconnected(), m_page->pageID());
}
void WebInspectorProxy::dispatchMessageFromRemoteFrontend(const String& message)
{
m_page->process().send(Messages::WebInspector::DispatchMessageFromRemoteFrontend(message), m_page->pageID());
}
#endif
void WebInspectorProxy::createInspectorPage(uint64_t& inspectorPageID, WebPageCreationParameters& inspectorPageParameters)
{
inspectorPageID = 0;
if (!m_page)
return;
m_isAttached = shouldOpenAttached();
m_attachmentSide = static_cast<AttachmentSide>(inspectorPageGroup()->preferences().inspectorAttachmentSide());
WebPageProxy* inspectorPage = platformCreateInspectorPage();
ASSERT(inspectorPage);
if (!inspectorPage)
return;
inspectorPageID = inspectorPage->pageID();
inspectorPageParameters = inspectorPage->creationParameters();
WKPagePolicyClientV1 policyClient = {
{ 1, this },
0,
0,
0,
0,
decidePolicyForNavigationAction,
0,
};
WKPageSetPagePolicyClient(toAPI(inspectorPage), &policyClient.base);
StringBuilder url;
url.append(inspectorPageURL());
url.appendLiteral("?dockSide=");
if (m_isAttached) {
switch (m_attachmentSide) {
case AttachmentSideBottom:
url.appendLiteral("bottom");
m_page->process().send(Messages::WebInspector::AttachedBottom(), m_page->pageID());
break;
case AttachmentSideRight:
url.appendLiteral("right");
m_page->process().send(Messages::WebInspector::AttachedRight(), m_page->pageID());
break;
}
} else
url.appendLiteral("undocked");
m_page->process().assumeReadAccessToBaseURL(inspectorBaseURL());
inspectorPage->loadRequest(URL(URL(), url.toString()));
m_createdInspectorPage = true;
}
void WebInspectorProxy::createInspectorPageForTest(uint64_t& inspectorPageID, WebPageCreationParameters& inspectorPageParameters)
{
inspectorPageID = 0;
if (!m_page)
return;
m_isAttached = false;
WebPageProxy* inspectorPage = platformCreateInspectorPage();
ASSERT(inspectorPage);
if (!inspectorPage)
return;
inspectorPageID = inspectorPage->pageID();
inspectorPageParameters = inspectorPage->creationParameters();
WKPagePolicyClientV1 policyClient = {
{ 1, this },
0,
0,
0,
0,
decidePolicyForNavigationAction,
0,
};
WKPageSetPagePolicyClient(toAPI(inspectorPage), &policyClient.base);
m_page->process().assumeReadAccessToBaseURL(inspectorBaseURL());
inspectorPage->loadRequest(URL(URL(), inspectorTestPageURL()));
m_createdInspectorPage = true;
}
void WebInspectorProxy::open()
{
m_isVisible = true;
platformOpen();
}
void WebInspectorProxy::didClose()
{
if (!m_createdInspectorPage)
return;
m_isVisible = false;
m_isDebuggingJavaScript = false;
m_isProfilingJavaScript = false;
m_isProfilingPage = false;
m_createdInspectorPage = false;
m_showMessageSent = false;
m_ignoreFirstBringToFront = false;
if (m_isAttached)
platformDetach();
m_isAttached = false;
platformDidClose();
}
void WebInspectorProxy::bringToFront()
{
if (m_ignoreFirstBringToFront) {
m_ignoreFirstBringToFront = false;
return;
}
if (m_isVisible)
platformBringToFront();
else
open();
}
void WebInspectorProxy::attachAvailabilityChanged(bool available)
{
platformAttachAvailabilityChanged(available);
}
void WebInspectorProxy::inspectedURLChanged(const String& urlString)
{
platformInspectedURLChanged(urlString);
}
void WebInspectorProxy::save(const String& filename, const String& content, bool base64Encoded, bool forceSaveAs)
{
platformSave(filename, content, base64Encoded, forceSaveAs);
}
void WebInspectorProxy::append(const String& filename, const String& content)
{
platformAppend(filename, content);
}
bool WebInspectorProxy::canAttach()
{
if (m_isAttached)
return true;
if (m_level > 1)
return false;
unsigned inspectedPageHeight = platformInspectedWindowHeight();
unsigned inspectedPageWidth = platformInspectedWindowWidth();
unsigned maximumAttachedHeight = inspectedPageHeight * 3 / 4;
return minimumAttachedHeight <= maximumAttachedHeight && minimumAttachedWidth <= inspectedPageWidth;
}
bool WebInspectorProxy::shouldOpenAttached()
{
return inspectorPageGroup()->preferences().inspectorStartsAttached() && canAttach();
}
#if ENABLE(INSPECTOR_SERVER)
void WebInspectorProxy::sendMessageToRemoteFrontend(const String& message)
{
ASSERT(m_remoteInspectionPageId);
WebInspectorServer::shared().sendMessageOverConnection(m_remoteInspectionPageId, message);
}
#endif
}
#endif // ENABLE(INSPECTOR)