/* * Copyright (C) 2010, 2014 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: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. 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. * * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS 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 APPLE INC. OR ITS 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. */ #import "config.h" #import "WebInspectorProxy.h" #if PLATFORM(MAC) && WK_API_ENABLED #import "WKInspectorPrivateMac.h" #import "WKInspectorViewController.h" #import "WKViewInternal.h" #import "WKWebViewInternal.h" #import "WebInspectorUIMessages.h" #import "WebPageGroup.h" #import "WebPageProxy.h" #import #import #import #import SOFT_LINK_STAGED_FRAMEWORK(WebInspectorUI, PrivateFrameworks, A) using namespace WebCore; using namespace WebKit; static const NSUInteger windowStyleMask = NSWindowStyleMaskTitled | NSWindowStyleMaskClosable | NSWindowStyleMaskMiniaturizable | NSWindowStyleMaskResizable | NSWindowStyleMaskFullSizeContentView; // The time we keep our WebView alive before closing it and its process. // Reusing the WebView improves start up time for people that jump in and out of the Inspector. static const Seconds webViewCloseTimeout { 1_min }; @interface WKWebInspectorProxyObjCAdapter () - (instancetype)initWithWebInspectorProxy:(WebInspectorProxy*)inspectorProxy; - (void)invalidate; @end @implementation WKWebInspectorProxyObjCAdapter { WebInspectorProxy* _inspectorProxy; } - (WKInspectorRef)inspectorRef { return toAPI(_inspectorProxy); } - (instancetype)initWithWebInspectorProxy:(WebInspectorProxy*)inspectorProxy { ASSERT_ARG(inspectorProxy, inspectorProxy); if (!(self = [super init])) return nil; // Unretained to avoid a reference cycle. _inspectorProxy = inspectorProxy; return self; } - (void)invalidate { _inspectorProxy = nullptr; } - (void)windowDidMove:(NSNotification *)notification { if (_inspectorProxy) _inspectorProxy->windowFrameDidChange(); } - (void)windowDidResize:(NSNotification *)notification { if (_inspectorProxy) _inspectorProxy->windowFrameDidChange(); } - (void)windowWillClose:(NSNotification *)notification { if (_inspectorProxy) _inspectorProxy->close(); } - (void)windowDidEnterFullScreen:(NSNotification *)notification { if (_inspectorProxy) _inspectorProxy->windowFullScreenDidChange(); } - (void)windowDidExitFullScreen:(NSNotification *)notification { if (_inspectorProxy) _inspectorProxy->windowFullScreenDidChange(); } - (void)inspectedViewFrameDidChange:(NSNotification *)notification { // Resizing the views while inside this notification can lead to bad results when entering // or exiting full screen. To avoid that we need to perform the work after a delay. We only // depend on this for enforcing the height constraints, so a small delay isn't terrible. Most // of the time the views will already have the correct frames because of autoresizing masks. dispatch_after(DISPATCH_TIME_NOW, dispatch_get_main_queue(), ^{ if (_inspectorProxy) _inspectorProxy->inspectedViewFrameDidChange(); }); } // MARK: WKInspectorViewControllerDelegate methods - (void)inspectorViewControllerInspectorDidCrash:(WKInspectorViewController *)inspectorViewController { if (_inspectorProxy) _inspectorProxy->closeForCrash(); } - (BOOL)inspectorViewControllerInspectorIsUnderTest:(WKInspectorViewController *)inspectorViewController { return _inspectorProxy ? _inspectorProxy->isUnderTest() : false; } @end namespace WebKit { void WebInspectorProxy::attachmentViewDidChange(NSView *oldView, NSView *newView) { [[NSNotificationCenter defaultCenter] removeObserver:m_objCAdapter.get() name:NSViewFrameDidChangeNotification object:oldView]; [[NSNotificationCenter defaultCenter] addObserver:m_objCAdapter.get() selector:@selector(inspectedViewFrameDidChange:) name:NSViewFrameDidChangeNotification object:newView]; if (m_isAttached) attach(m_attachmentSide); } void WebInspectorProxy::setInspectorWindowFrame(WKRect& frame) { if (m_isAttached) return; [m_inspectorWindow setFrame:NSMakeRect(frame.origin.x, frame.origin.y, frame.size.width, frame.size.height) display:YES]; } WKRect WebInspectorProxy::inspectorWindowFrame() { if (m_isAttached) return WKRectMake(0, 0, 0, 0); NSRect frame = m_inspectorWindow.get().frame; return WKRectMake(frame.origin.x, frame.origin.y, frame.size.width, frame.size.height); } void WebInspectorProxy::updateInspectorWindowTitle() const { if (!m_inspectorWindow) return; unsigned level = inspectionLevel(); if (level > 1) { NSString *debugTitle = [NSString stringWithFormat:WEB_UI_STRING("Web Inspector [%d] — %@", "Web Inspector window title when inspecting Web Inspector"), level, (NSString *)m_urlString]; [m_inspectorWindow setTitle:debugTitle]; } else { NSString *title = [NSString stringWithFormat:WEB_UI_STRING("Web Inspector — %@", "Web Inspector window title"), (NSString *)m_urlString]; [m_inspectorWindow setTitle:title]; } } RetainPtr WebInspectorProxy::createFrontendWindow(NSRect savedWindowFrame) { NSRect windowFrame = !NSIsEmptyRect(savedWindowFrame) ? savedWindowFrame : NSMakeRect(0, 0, initialWindowWidth, initialWindowHeight); auto window = adoptNS([[NSWindow alloc] initWithContentRect:windowFrame styleMask:windowStyleMask backing:NSBackingStoreBuffered defer:NO]); [window setMinSize:NSMakeSize(minimumWindowWidth, minimumWindowHeight)]; [window setReleasedWhenClosed:NO]; [window setCollectionBehavior:([window collectionBehavior] | NSWindowCollectionBehaviorFullScreenPrimary)]; CGFloat approximatelyHalfScreenSize = ([window screen].frame.size.width / 2) - 4; CGFloat minimumFullScreenWidth = std::max(636, approximatelyHalfScreenSize); [window setMinFullScreenContentSize:NSMakeSize(minimumFullScreenWidth, minimumWindowHeight)]; [window setCollectionBehavior:([window collectionBehavior] | NSWindowCollectionBehaviorFullScreenAllowsTiling)]; [window setTitlebarAppearsTransparent:YES]; // Center the window if the saved frame was empty. if (NSIsEmptyRect(savedWindowFrame)) [window center]; return window; } WebPageProxy* WebInspectorProxy::platformCreateFrontendPage() { ASSERT(inspectedPage()); ASSERT(!m_inspectorPage); m_closeFrontendAfterInactivityTimer.stop(); m_objCAdapter = adoptNS([[WKWebInspectorProxyObjCAdapter alloc] initWithWebInspectorProxy:this]); NSView *inspectedView = inspectedPage()->inspectorAttachmentView(); [[NSNotificationCenter defaultCenter] addObserver:m_objCAdapter.get() selector:@selector(inspectedViewFrameDidChange:) name:NSViewFrameDidChangeNotification object:inspectedView]; m_inspectorViewController = adoptNS([[WKInspectorViewController alloc] initWithInspectedPage:inspectedPage()]); [m_inspectorViewController.get() setDelegate:m_objCAdapter.get()]; WebPageProxy *inspectorPage = [m_inspectorViewController webView]->_page.get(); ASSERT(inspectorPage); return inspectorPage; } void WebInspectorProxy::platformCreateFrontendWindow() { ASSERT(!m_inspectorWindow); NSString *savedWindowFrameString = inspectedPage()->pageGroup().preferences().inspectorWindowFrame(); NSRect savedWindowFrame = NSRectFromString(savedWindowFrameString); m_inspectorWindow = WebInspectorProxy::createFrontendWindow(savedWindowFrame); [m_inspectorWindow setDelegate:m_objCAdapter.get()]; WKWebView *inspectorView = [m_inspectorViewController webView]; NSView *contentView = [m_inspectorWindow contentView]; inspectorView.frame = [contentView bounds]; [contentView addSubview:inspectorView]; updateInspectorWindowTitle(); } void WebInspectorProxy::closeFrontendPage() { ASSERT(!m_isAttached || !m_inspectorWindow); if (m_inspectorViewController) { [m_inspectorViewController.get() setDelegate:nil]; m_inspectorViewController = nil; } if (m_objCAdapter) { [[NSNotificationCenter defaultCenter] removeObserver:m_objCAdapter.get()]; [m_objCAdapter invalidate]; m_objCAdapter = nil; } } void WebInspectorProxy::closeFrontendAfterInactivityTimerFired() { closeFrontendPage(); } void WebInspectorProxy::platformCloseFrontendPageAndWindow() { if (m_inspectorWindow) { [m_inspectorWindow setDelegate:nil]; [m_inspectorWindow close]; m_inspectorWindow = nil; } m_closeFrontendAfterInactivityTimer.startOneShot(webViewCloseTimeout); } void WebInspectorProxy::platformDidCloseForCrash() { m_closeFrontendAfterInactivityTimer.stop(); closeFrontendPage(); } void WebInspectorProxy::platformInvalidate() { m_closeFrontendAfterInactivityTimer.stop(); closeFrontendPage(); } void WebInspectorProxy::platformHide() { if (m_isAttached) { platformDetach(); return; } if (m_inspectorWindow) { [m_inspectorWindow setDelegate:nil]; [m_inspectorWindow close]; m_inspectorWindow = nil; } } void WebInspectorProxy::platformBringToFront() { // If the Web Inspector is no longer in the same window as the inspected view, // then we need to reopen the Inspector to get it attached to the right window. // This can happen when dragging tabs to another window in Safari. if (m_isAttached && [m_inspectorViewController webView].window != inspectedPage()->platformWindow()) { open(); return; } // FIXME : this will not bring a background tab in Safari to the front, only its window. [[m_inspectorViewController webView].window makeKeyAndOrderFront:nil]; [[m_inspectorViewController webView].window makeFirstResponder:[m_inspectorViewController webView]]; } void WebInspectorProxy::platformBringInspectedPageToFront() { [inspectedPage()->platformWindow() makeKeyAndOrderFront:nil]; } bool WebInspectorProxy::platformIsFront() { // FIXME : this will not return false for a background tab in Safari, only a background window. return m_isVisible && [m_inspectorViewController webView].window.isMainWindow; } bool WebInspectorProxy::platformCanAttach(bool webProcessCanAttach) { if ([m_inspectorWindow styleMask] & NSWindowStyleMaskFullScreen) return false; NSView *inspectedView = inspectedPage()->inspectorAttachmentView(); if ([WKInspectorViewController viewIsInspectorWebView:inspectedView]) return webProcessCanAttach; static const float minimumAttachedHeight = 250; static const float maximumAttachedHeightRatio = 0.75; static const float minimumAttachedWidth = 500; NSRect inspectedViewFrame = inspectedView.frame; float maximumAttachedHeight = NSHeight(inspectedViewFrame) * maximumAttachedHeightRatio; return minimumAttachedHeight <= maximumAttachedHeight && minimumAttachedWidth <= NSWidth(inspectedViewFrame); } void WebInspectorProxy::platformAttachAvailabilityChanged(bool available) { // Do nothing. } void WebInspectorProxy::platformInspectedURLChanged(const String& urlString) { m_urlString = urlString; updateInspectorWindowTitle(); } void WebInspectorProxy::platformSave(const String& suggestedURL, const String& content, bool base64Encoded, bool forceSaveDialog) { ASSERT(!suggestedURL.isEmpty()); NSURL *platformURL = m_suggestedToActualURLMap.get(suggestedURL).get(); if (!platformURL) { platformURL = [NSURL URLWithString:suggestedURL]; // The user must confirm new filenames before we can save to them. forceSaveDialog = true; } ASSERT(platformURL); if (!platformURL) return; // Necessary for the block below. String suggestedURLCopy = suggestedURL; String contentCopy = content; auto saveToURL = ^(NSURL *actualURL) { ASSERT(actualURL); m_suggestedToActualURLMap.set(suggestedURLCopy, actualURL); if (base64Encoded) { Vector out; if (!base64Decode(contentCopy, out, Base64ValidatePadding)) return; RetainPtr dataContent = adoptNS([[NSData alloc] initWithBytes:out.data() length:out.size()]); [dataContent writeToURL:actualURL atomically:YES]; } else [contentCopy writeToURL:actualURL atomically:YES encoding:NSUTF8StringEncoding error:NULL]; m_inspectorPage->process().send(Messages::WebInspectorUI::DidSave([actualURL absoluteString]), m_inspectorPage->pageID()); }; if (!forceSaveDialog) { saveToURL(platformURL); return; } NSSavePanel *panel = [NSSavePanel savePanel]; panel.nameFieldStringValue = platformURL.lastPathComponent; // If we have a file URL we've already saved this file to a path and // can provide a good directory to show. Otherwise, use the system's // default behavior for the initial directory to show in the dialog. if (platformURL.isFileURL) panel.directoryURL = [platformURL URLByDeletingLastPathComponent]; auto completionHandler = ^(NSInteger result) { if (result == NSModalResponseCancel) return; ASSERT(result == NSModalResponseOK); saveToURL(panel.URL); }; if (m_inspectorWindow) [panel beginSheetModalForWindow:m_inspectorWindow.get() completionHandler:completionHandler]; else completionHandler([panel runModal]); } void WebInspectorProxy::platformAppend(const String& suggestedURL, const String& content) { ASSERT(!suggestedURL.isEmpty()); RetainPtr actualURL = m_suggestedToActualURLMap.get(suggestedURL); // Do not append unless the user has already confirmed this filename in save(). if (!actualURL) return; NSFileHandle *handle = [NSFileHandle fileHandleForWritingToURL:actualURL.get() error:NULL]; [handle seekToEndOfFile]; [handle writeData:[content dataUsingEncoding:NSUTF8StringEncoding]]; [handle closeFile]; m_inspectorPage->process().send(Messages::WebInspectorUI::DidAppend([actualURL absoluteString]), m_inspectorPage->pageID()); } void WebInspectorProxy::windowFrameDidChange() { ASSERT(!m_isAttached); ASSERT(m_isVisible); ASSERT(m_inspectorWindow); if (m_isAttached || !m_isVisible || !m_inspectorWindow) return; NSString *frameString = NSStringFromRect([m_inspectorWindow frame]); inspectedPage()->pageGroup().preferences().setInspectorWindowFrame(frameString); } void WebInspectorProxy::windowFullScreenDidChange() { ASSERT(!m_isAttached); ASSERT(m_isVisible); ASSERT(m_inspectorWindow); if (m_isAttached || !m_isVisible || !m_inspectorWindow) return; attachAvailabilityChanged(platformCanAttach(canAttach())); } void WebInspectorProxy::inspectedViewFrameDidChange(CGFloat currentDimension) { if (!m_isVisible) return; if (!m_isAttached) { // Check if the attach availability changed. We need to do this here in case // the attachment view is not the WKView. attachAvailabilityChanged(platformCanAttach(canAttach())); return; } NSView *inspectedView = inspectedPage()->inspectorAttachmentView(); WKWebView *inspectorView = [m_inspectorViewController webView]; NSRect inspectedViewFrame = inspectedView.frame; NSRect oldInspectorViewFrame = inspectorView.frame; NSRect newInspectorViewFrame = NSZeroRect; NSRect parentBounds = inspectedView.superview.bounds; CGFloat inspectedViewTop = NSMaxY(inspectedViewFrame); switch (m_attachmentSide) { case AttachmentSide::Bottom: { if (!currentDimension) currentDimension = NSHeight(oldInspectorViewFrame); CGFloat parentHeight = NSHeight(parentBounds); CGFloat inspectorHeight = InspectorFrontendClientLocal::constrainedAttachedWindowHeight(currentDimension, parentHeight); // Preserve the top position of the inspected view so banners in Safari still work. inspectedViewFrame = NSMakeRect(0, inspectorHeight, NSWidth(parentBounds), inspectedViewTop - inspectorHeight); newInspectorViewFrame = NSMakeRect(0, 0, NSWidth(inspectedViewFrame), inspectorHeight); break; } case AttachmentSide::Right: { if (!currentDimension) currentDimension = NSWidth(oldInspectorViewFrame); CGFloat parentWidth = NSWidth(parentBounds); CGFloat inspectorWidth = InspectorFrontendClientLocal::constrainedAttachedWindowWidth(currentDimension, parentWidth); // Preserve the top position of the inspected view so banners in Safari still work. But don't use that // top position for the inspector view since the banners only stretch as wide as the inspected view. inspectedViewFrame = NSMakeRect(0, 0, parentWidth - inspectorWidth, inspectedViewTop); CGFloat insetExcludingBanners = 0; if ([inspectedView isKindOfClass:[WKView class]]) insetExcludingBanners = ((WKView *)inspectedView)._topContentInset - ((WKView *)inspectedView)._totalHeightOfBanners; newInspectorViewFrame = NSMakeRect(parentWidth - inspectorWidth, 0, inspectorWidth, NSHeight(parentBounds) - insetExcludingBanners); break; } case AttachmentSide::Left: { if (!currentDimension) currentDimension = NSWidth(oldInspectorViewFrame); CGFloat parentWidth = NSWidth(parentBounds); CGFloat inspectorWidth = InspectorFrontendClientLocal::constrainedAttachedWindowWidth(currentDimension, parentWidth); // Preserve the top position of the inspected view so banners in Safari still work. But don't use that // top position for the inspector view since the banners only stretch as wide as the inspected view. inspectedViewFrame = NSMakeRect(inspectorWidth, 0, parentWidth - inspectorWidth, inspectedViewTop); CGFloat insetExcludingBanners = 0; if ([inspectedView isKindOfClass:[WKView class]]) insetExcludingBanners = ((WKView *)inspectedView)._topContentInset - ((WKView *)inspectedView)._totalHeightOfBanners; newInspectorViewFrame = NSMakeRect(0, 0, inspectorWidth, NSHeight(parentBounds) - insetExcludingBanners); break; } } if (NSEqualRects(oldInspectorViewFrame, newInspectorViewFrame) && NSEqualRects([inspectedView frame], inspectedViewFrame)) return; // Disable screen updates to make sure the layers for both views resize in sync. [inspectorView.window disableScreenUpdatesUntilFlush]; [inspectorView setFrame:newInspectorViewFrame]; [inspectedView setFrame:inspectedViewFrame]; } unsigned WebInspectorProxy::platformInspectedWindowHeight() { NSView *inspectedView = inspectedPage()->inspectorAttachmentView(); NSRect inspectedViewRect = [inspectedView frame]; return static_cast(inspectedViewRect.size.height); } unsigned WebInspectorProxy::platformInspectedWindowWidth() { NSView *inspectedView = inspectedPage()->inspectorAttachmentView(); NSRect inspectedViewRect = [inspectedView frame]; return static_cast(inspectedViewRect.size.width); } void WebInspectorProxy::platformAttach() { NSView *inspectedView = inspectedPage()->inspectorAttachmentView(); WKWebView *inspectorView = [m_inspectorViewController webView]; if (m_inspectorWindow) { [m_inspectorWindow setDelegate:nil]; [m_inspectorWindow close]; m_inspectorWindow = nil; } [inspectorView removeFromSuperview]; CGFloat currentDimension; switch (m_attachmentSide) { case AttachmentSide::Bottom: [inspectorView setAutoresizingMask:NSViewWidthSizable | NSViewMaxYMargin]; currentDimension = inspectorPagePreferences().inspectorAttachedHeight(); break; case AttachmentSide::Right: [inspectorView setAutoresizingMask:NSViewHeightSizable | NSViewMinXMargin]; currentDimension = inspectorPagePreferences().inspectorAttachedWidth(); break; case AttachmentSide::Left: [inspectorView setAutoresizingMask:NSViewHeightSizable | NSViewMaxXMargin]; currentDimension = inspectorPagePreferences().inspectorAttachedWidth(); break; } inspectedViewFrameDidChange(currentDimension); [inspectedView.superview addSubview:inspectorView positioned:NSWindowBelow relativeTo:inspectedView]; [inspectorView.window makeFirstResponder:inspectorView]; } void WebInspectorProxy::platformDetach() { NSView *inspectedView = inspectedPage()->inspectorAttachmentView(); WKWebView *inspectorView = [m_inspectorViewController webView]; [inspectorView removeFromSuperview]; // Make sure that we size the inspected view's frame after detaching so that it takes up the space that the // attached inspector used to. Preserve the top position of the inspected view so banners in Safari still work. inspectedView.frame = NSMakeRect(0, 0, NSWidth(inspectedView.superview.bounds), NSMaxY(inspectedView.frame)); // Return early if we are not visible. This means the inspector was closed while attached // and we should not create and show the inspector window. if (!m_isVisible) return; open(); } void WebInspectorProxy::platformSetAttachedWindowHeight(unsigned height) { if (!m_isAttached) return; inspectedViewFrameDidChange(height); } void WebInspectorProxy::platformSetAttachedWindowWidth(unsigned width) { if (!m_isAttached) return; inspectedViewFrameDidChange(width); } void WebInspectorProxy::platformStartWindowDrag() { [m_inspectorViewController webView]->_page->startWindowDrag(); } String WebInspectorProxy::inspectorPageURL() { // Call the soft link framework function to dlopen it, then [NSBundle bundleWithIdentifier:] will work. WebInspectorUILibrary(); NSString *path = [[NSBundle bundleWithIdentifier:@"com.apple.WebInspectorUI"] pathForResource:@"Main" ofType:@"html"]; ASSERT([path length]); return [[NSURL fileURLWithPath:path] absoluteString]; } String WebInspectorProxy::inspectorTestPageURL() { // Call the soft link framework function to dlopen it, then [NSBundle bundleWithIdentifier:] will work. WebInspectorUILibrary(); NSString *path = [[NSBundle bundleWithIdentifier:@"com.apple.WebInspectorUI"] pathForResource:@"Test" ofType:@"html"]; // We might not have a Test.html in Production builds. if (!path) return String(); return [[NSURL fileURLWithPath:path] absoluteString]; } String WebInspectorProxy::inspectorBaseURL() { // Call the soft link framework function to dlopen it, then [NSBundle bundleWithIdentifier:] will work. WebInspectorUILibrary(); NSString *path = [[NSBundle bundleWithIdentifier:@"com.apple.WebInspectorUI"] resourcePath]; ASSERT([path length]); return [[NSURL fileURLWithPath:path] absoluteString]; } } // namespace WebKit #endif // PLATFORM(MAC) && WK_API_ENABLED