/* * Copyright (C) 2010-2020 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. */ #include "config.h" #include "InjectedBundlePage.h" #include "ActivateFonts.h" #include "InjectedBundle.h" #include "ReftestFunctions.h" #include "StringFunctions.h" #include "WebCoreTestSupport.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #if USE(CF) #include #endif #if USE(CF) && !PLATFORM(WIN_CAIRO) #include "WebArchiveDumpSupport.h" #endif using namespace std; namespace WTF { template<> class StringTypeAdapter { public: StringTypeAdapter(WKStringRef); unsigned length() const { return m_string ? WKStringGetLength(m_string) : 0; } bool is8Bit() const { return !m_string; } template void writeTo(CharacterType*) const; private: WKStringRef m_string; }; inline StringTypeAdapter::StringTypeAdapter(WKStringRef string) : m_string { string } { } template<> inline void StringTypeAdapter::writeTo(LChar*) const { } template<> inline void StringTypeAdapter::writeTo(UChar* destination) const { if (m_string) WKStringGetCharacters(m_string, reinterpret_cast(destination), WKStringGetLength(m_string)); } } namespace WTR { static double numericWindowProperty(WKBundleFrameRef frame, const char* name) { auto context = WKBundleFrameGetJavaScriptContext(frame); return numericProperty(context, JSContextGetGlobalObject(context), name); } static WTF::String dumpPath(JSGlobalContextRef context, JSObjectRef nodeValue) { auto name = toWTFString(stringProperty(context, nodeValue, "nodeName")); if (auto parentNode = objectProperty(context, nodeValue, "parentNode")) return makeString(name, " > ", dumpPath(context, parentNode)); return name; } static WTF::String dumpPath(WKBundlePageRef page, WKBundleScriptWorldRef world, WKBundleNodeHandleRef node) { if (!node) return "(null)"_s; WKBundleFrameRef frame = WKBundlePageGetMainFrame(page); JSGlobalContextRef context = WKBundleFrameGetJavaScriptContextForWorld(frame, world); JSValueRef nodeValue = WKBundleFrameGetJavaScriptWrapperForNodeForWorld(frame, node, world); ASSERT(JSValueIsObject(context, nodeValue)); JSObjectRef nodeObject = (JSObjectRef)nodeValue; return dumpPath(context, nodeObject); } static WTF::String string(WKBundlePageRef page, WKBundleScriptWorldRef world, WKBundleRangeHandleRef rangeRef) { if (!rangeRef) return "(null)"_s; auto frame = WKBundlePageGetMainFrame(page); auto context = WKBundleFrameGetJavaScriptContextForWorld(frame, world); auto rangeValue = WKBundleFrameGetJavaScriptWrapperForRangeForWorld(frame, rangeRef, world); ASSERT(JSValueIsObject(context, rangeValue)); auto rangeObject = (JSObjectRef)rangeValue; return makeString("range from ", numericProperty(context, rangeObject, "startOffset"), " of ", dumpPath(context, objectProperty(context, rangeObject, "startContainer")), " to ", numericProperty(context, rangeObject, "endOffset"), " of ", dumpPath(context, objectProperty(context, rangeObject, "endContainer")) ); } static WKRetainPtr NavigationTypeToString(WKFrameNavigationType type) { switch (type) { case kWKFrameNavigationTypeLinkClicked: return toWK("link clicked"); case kWKFrameNavigationTypeFormSubmitted: return toWK("form submitted"); case kWKFrameNavigationTypeBackForward: return toWK("back/forward"); case kWKFrameNavigationTypeReload: return toWK("reload"); case kWKFrameNavigationTypeFormResubmitted: return toWK("form resubmitted"); case kWKFrameNavigationTypeOther: return toWK("other"); } return toWK("illegal value"); } static WTF::String styleDecToStr(WKBundleCSSStyleDeclarationRef) { // DumpRenderTree calls -[DOMCSSStyleDeclaration description], which just dumps class name and object address. // No existing tests actually hit this code path at the time of this writing, because WebCore doesn't call // the editing client if the styling operation source is CommandFromDOM or CommandFromDOMWithUserInterface. return ""_s; } static WTF::String string(WKSecurityOriginRef origin) { return makeString('{', adoptWK(WKSecurityOriginCopyProtocol(origin)).get(), ", ", adoptWK(WKSecurityOriginCopyHost(origin)).get(), ", ", WKSecurityOriginGetPort(origin), '}'); } static WTF::String string(WKBundleFrameRef frame) { auto name = adoptWK(WKBundleFrameCopyName(frame)); bool isMain = WKBundleFrameIsMainFrame(frame); if (WKStringIsEmpty(name.get())) return isMain ? "main frame"_s : "frame (anonymous)"_s; return makeString(isMain ? "main frame \"" : "frame \"", name.get(), '"'); } static inline bool isLocalFileScheme(WKStringRef scheme) { return WKStringIsEqualToUTF8CStringIgnoringCase(scheme, "file"); } static const char divider = '/'; static inline WTF::String pathSuitableForTestResult(WKURLRef fileUrl) { if (!fileUrl) return "(null)"_s; auto schemeString = adoptWK(WKURLCopyScheme(fileUrl)); if (!isLocalFileScheme(schemeString.get())) return toWTFString(adoptWK(WKURLCopyString(fileUrl))); WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(InjectedBundle::singleton().page()->page()); auto mainFrameURL = adoptWK(WKBundleFrameCopyURL(mainFrame)); if (!mainFrameURL) mainFrameURL = adoptWK(WKBundleFrameCopyProvisionalURL(mainFrame)); String pathString = toWTFString(adoptWK(WKURLCopyPath(fileUrl))); String mainFrameURLPathString = toWTFString(adoptWK(WKURLCopyPath(mainFrameURL.get()))); auto basePath = StringView(mainFrameURLPathString).left(mainFrameURLPathString.reverseFind(divider) + 1); if (!basePath.isEmpty() && pathString.startsWith(basePath)) return pathString.substring(basePath.length()); return toWTFString(adoptWK(WKURLCopyLastPathComponent(fileUrl))); // We lose some information here, but it's better than exposing a full path, which is always machine specific. } static HashMap& assignedUrlsCache() { static NeverDestroyed> cache; return cache.get(); } static inline void dumpResourceURL(uint64_t identifier, StringBuilder& stringBuilder) { if (assignedUrlsCache().contains(identifier)) stringBuilder.append(assignedUrlsCache().get(identifier)); else stringBuilder.append(""); } static HashMap& bundlePageMap() { static NeverDestroyed> map; return map.get(); } InjectedBundlePage::InjectedBundlePage(WKBundlePageRef page) : m_page(page) , m_world(adoptWK(WKBundleScriptWorldCreateWorld())) { ASSERT(!bundlePageMap().contains(page)); bundlePageMap().set(page, this); WKBundlePageLoaderClientV9 loaderClient = { { 9, this }, didStartProvisionalLoadForFrame, didReceiveServerRedirectForProvisionalLoadForFrame, didFailProvisionalLoadWithErrorForFrame, didCommitLoadForFrame, didFinishDocumentLoadForFrame, didFinishLoadForFrame, didFailLoadWithErrorForFrame, didSameDocumentNavigationForFrame, didReceiveTitleForFrame, 0, // didFirstLayoutForFrame 0, // didFirstVisuallyNonEmptyLayoutForFrame 0, // didRemoveFrameFromHierarchy didDisplayInsecureContentForFrame, didRunInsecureContentForFrame, didClearWindowForFrame, didCancelClientRedirectForFrame, willPerformClientRedirectForFrame, didHandleOnloadEventsForFrame, 0, // didLayoutForFrame 0, // didNewFirstVisuallyNonEmptyLayout_unavailable didDetectXSSForFrame, 0, // shouldGoToBackForwardListItem 0, // didCreateGlobalObjectForFrame 0, // willDisconnectDOMWindowExtensionFromGlobalObject 0, // didReconnectDOMWindowExtensionToGlobalObject 0, // willDestroyGlobalObjectForDOMWindowExtension didFinishProgress, // didFinishProgress 0, // shouldForceUniversalAccessFromLocalURL 0, // didReceiveIntentForFrame 0, // registerIntentServiceForFrame 0, // didLayout 0, // featuresUsedInPage 0, // willLoadURLRequest 0, // willLoadDataRequest 0, // willDestroyFrame_unavailable 0, // userAgentForURL willInjectUserScriptForFrame }; WKBundlePageSetPageLoaderClient(m_page, &loaderClient.base); WKBundlePageResourceLoadClientV1 resourceLoadClient = { { 1, this }, didInitiateLoadForResource, willSendRequestForFrame, didReceiveResponseForResource, didReceiveContentLengthForResource, didFinishLoadForResource, didFailLoadForResource, shouldCacheResponse, 0 // shouldUseCredentialStorage }; WKBundlePageSetResourceLoadClient(m_page, &resourceLoadClient.base); WKBundlePagePolicyClientV0 policyClient = { { 0, this }, decidePolicyForNavigationAction, decidePolicyForNewWindowAction, decidePolicyForResponse, unableToImplementPolicy }; ALLOW_DEPRECATED_DECLARATIONS_BEGIN WKBundlePageSetPolicyClient(m_page, &policyClient.base); ALLOW_DEPRECATED_DECLARATIONS_END WKBundlePageUIClientV2 uiClient = { { 2, this }, willAddMessageToConsole, willSetStatusbarText, willRunJavaScriptAlert, willRunJavaScriptConfirm, willRunJavaScriptPrompt, 0, /*mouseDidMoveOverElement*/ 0, /*pageDidScroll*/ 0, /*paintCustomOverhangArea*/ 0, /*shouldGenerateFileForUpload*/ 0, /*generateFileForUpload*/ 0, /*shouldRubberBandInDirection*/ 0, /*statusBarIsVisible*/ 0, /*menuBarIsVisible*/ 0, /*toolbarsAreVisible*/ didReachApplicationCacheOriginQuota, didExceedDatabaseQuota, 0, /*plugInStartLabelTitle*/ 0, /*plugInStartLabelSubtitle*/ 0, /*plugInExtraStyleSheet*/ 0, /*plugInExtraScript*/ }; WKBundlePageSetUIClient(m_page, &uiClient.base); WKBundlePageEditorClientV1 editorClient = { { 1, this }, shouldBeginEditing, shouldEndEditing, shouldInsertNode, shouldInsertText, shouldDeleteRange, shouldChangeSelectedRange, shouldApplyStyle, didBeginEditing, didEndEditing, didChange, didChangeSelection, 0, /* willWriteToPasteboard */ 0, /* getPasteboardDataForRange */ 0, /* didWriteToPasteboard */ 0, /* performTwoStepDrop */ }; WKBundlePageSetEditorClient(m_page, &editorClient.base); #if ENABLE(FULLSCREEN_API) WKBundlePageFullScreenClientV1 fullScreenClient = { { 1, this }, supportsFullScreen, enterFullScreenForElement, exitFullScreenForElement, beganEnterFullScreen, beganExitFullScreen, closeFullScreen, }; WKBundlePageSetFullScreenClient(m_page, &fullScreenClient.base); #endif } InjectedBundlePage::~InjectedBundlePage() { ASSERT(bundlePageMap().contains(m_page)); bundlePageMap().remove(m_page); } void InjectedBundlePage::stopLoading() { WKBundlePageStopLoading(m_page); } void InjectedBundlePage::prepare() { WKBundlePageClearMainFrameName(m_page); WKBundlePageSetPageZoomFactor(m_page, 1); WKBundlePageSetTextZoomFactor(m_page, 1); WKPoint origin = { 0, 0 }; WKBundlePageSetScaleAtOrigin(m_page, 1, origin); WKBundleClearHistoryForTesting(m_page); WKBundleFrameClearOpener(WKBundlePageGetMainFrame(m_page)); WKBundlePageSetTracksRepaints(m_page, false); // Force consistent "responsive" behavior for WebPage::eventThrottlingDelay() for testing. Tests can override via internals. WKEventThrottlingBehavior behavior = kWKEventThrottlingBehaviorResponsive; WKBundlePageSetEventThrottlingBehaviorOverride(m_page, &behavior); } void InjectedBundlePage::resetAfterTest() { WKBundleFrameRef frame = WKBundlePageGetMainFrame(m_page); // WebKit currently doesn't reset focus even when navigating to a new page. This may or may not be a bug // (see ), however for tests, we want to start each one with a clean state. WKBundleFrameFocus(frame); WebCoreTestSupport::resetInternalsObject(WKBundleFrameGetJavaScriptContext(frame)); assignedUrlsCache().clear(); // User scripts need to be removed after the test and before loading about:blank, as otherwise they would run in about:blank, and potentially leak results into a subsequest test. WKBundlePageRemoveAllUserContent(m_page); uninstallFakeHelvetica(); InjectedBundle::singleton().resetUserScriptInjectedCount(); m_didCommitMainFrameLoad = false; } // Loader Client Callbacks static void dumpLoadEvent(WKBundleFrameRef frame, const char* eventName) { InjectedBundle::singleton().outputText(makeString(string(frame), " - ", eventName, '\n')); } static String string(WKURLRequestRef request) { auto url = adoptWK(WKURLRequestCopyURL(request)); auto firstParty = adoptWK(WKURLRequestCopyFirstPartyForCookies(request)); auto httpMethod = adoptWK(WKURLRequestCopyHTTPMethod(request)); return makeString("'); } static String string(WKURLResponseRef response, bool shouldDumpResponseHeaders = false) { auto url = adoptWK(WKURLResponseCopyURL(response)); if (!url) return "(null)"_s; if (!shouldDumpResponseHeaders) { return makeString("'); } return makeString(""); } #if !PLATFORM(COCOA) // FIXME: Implement this for non-Cocoa ports. [GTK][WPE] https://bugs.webkit.org/show_bug.cgi?id=184295 uint64_t InjectedBundlePage::responseHeaderCount(WKURLResponseRef response) { return 0; } #endif static inline void dumpErrorDescriptionSuitableForTestResult(WKErrorRef error, StringBuilder& stringBuilder) { auto errorDomain = toWTFString(adoptWK(WKErrorCopyDomain(error))); auto errorCode = WKErrorGetErrorCode(error); // We need to do some error mapping here to match the test expectations (Mac error names are expected). if (errorDomain == "WebKitNetworkError"_s) { errorDomain = "NSURLErrorDomain"_s; errorCode = -999; } if (errorDomain == "WebKitPolicyError"_s) errorDomain = "WebKitErrorDomain"_s; stringBuilder.append("'); } void InjectedBundlePage::didStartProvisionalLoadForFrame(WKBundlePageRef page, WKBundleFrameRef frame, WKTypeRef*, const void *clientInfo) { static_cast(const_cast(clientInfo))->didStartProvisionalLoadForFrame(frame); } void InjectedBundlePage::didReceiveServerRedirectForProvisionalLoadForFrame(WKBundlePageRef page, WKBundleFrameRef frame, WKTypeRef*, const void *clientInfo) { static_cast(const_cast(clientInfo))->didReceiveServerRedirectForProvisionalLoadForFrame(frame); } void InjectedBundlePage::didFailProvisionalLoadWithErrorForFrame(WKBundlePageRef page, WKBundleFrameRef frame, WKErrorRef error, WKTypeRef*, const void *clientInfo) { static_cast(const_cast(clientInfo))->didFailProvisionalLoadWithErrorForFrame(frame, error); } void InjectedBundlePage::didCommitLoadForFrame(WKBundlePageRef page, WKBundleFrameRef frame, WKTypeRef*, const void *clientInfo) { static_cast(const_cast(clientInfo))->didCommitLoadForFrame(frame); } void InjectedBundlePage::didFinishLoadForFrame(WKBundlePageRef page, WKBundleFrameRef frame, WKTypeRef*, const void *clientInfo) { static_cast(const_cast(clientInfo))->didFinishLoadForFrame(frame); } void InjectedBundlePage::didFinishProgress(WKBundlePageRef, const void *clientInfo) { static_cast(const_cast(clientInfo))->didFinishProgress(); } void InjectedBundlePage::willInjectUserScriptForFrame(WKBundlePageRef, WKBundleFrameRef, WKBundleScriptWorldRef, const void* clientInfo) { static_cast(const_cast(clientInfo))->willInjectUserScriptForFrame(); } void InjectedBundlePage::didFinishDocumentLoadForFrame(WKBundlePageRef page, WKBundleFrameRef frame, WKTypeRef*, const void* clientInfo) { static_cast(const_cast(clientInfo))->didFinishDocumentLoadForFrame(frame); } void InjectedBundlePage::didFailLoadWithErrorForFrame(WKBundlePageRef page, WKBundleFrameRef frame, WKErrorRef error, WKTypeRef*, const void *clientInfo) { static_cast(const_cast(clientInfo))->didFailLoadWithErrorForFrame(frame, error); } void InjectedBundlePage::didReceiveTitleForFrame(WKBundlePageRef page, WKStringRef title, WKBundleFrameRef frame, WKTypeRef*, const void *clientInfo) { static_cast(const_cast(clientInfo))->didReceiveTitleForFrame(title, frame); } void InjectedBundlePage::didClearWindowForFrame(WKBundlePageRef page, WKBundleFrameRef frame, WKBundleScriptWorldRef world, const void *clientInfo) { static_cast(const_cast(clientInfo))->didClearWindowForFrame(frame, world); } void InjectedBundlePage::didCancelClientRedirectForFrame(WKBundlePageRef page, WKBundleFrameRef frame, const void* clientInfo) { static_cast(const_cast(clientInfo))->didCancelClientRedirectForFrame(frame); } void InjectedBundlePage::willPerformClientRedirectForFrame(WKBundlePageRef page, WKBundleFrameRef frame, WKURLRef url, double delay, double date, const void* clientInfo) { static_cast(const_cast(clientInfo))->willPerformClientRedirectForFrame(page, frame, url, delay, date); } void InjectedBundlePage::didSameDocumentNavigationForFrame(WKBundlePageRef page, WKBundleFrameRef frame, WKSameDocumentNavigationType type, WKTypeRef*, const void* clientInfo) { static_cast(const_cast(clientInfo))->didSameDocumentNavigationForFrame(frame, type); } void InjectedBundlePage::didHandleOnloadEventsForFrame(WKBundlePageRef page, WKBundleFrameRef frame, const void* clientInfo) { static_cast(const_cast(clientInfo))->didHandleOnloadEventsForFrame(frame); } void InjectedBundlePage::didDisplayInsecureContentForFrame(WKBundlePageRef page, WKBundleFrameRef frame, WKTypeRef*, const void* clientInfo) { static_cast(const_cast(clientInfo))->didDisplayInsecureContentForFrame(frame); } void InjectedBundlePage::didDetectXSSForFrame(WKBundlePageRef page, WKBundleFrameRef frame, WKTypeRef*, const void* clientInfo) { static_cast(const_cast(clientInfo))->didDetectXSSForFrame(frame); } void InjectedBundlePage::didRunInsecureContentForFrame(WKBundlePageRef page, WKBundleFrameRef frame, WKTypeRef*, const void* clientInfo) { static_cast(const_cast(clientInfo))->didRunInsecureContentForFrame(frame); } void InjectedBundlePage::didInitiateLoadForResource(WKBundlePageRef page, WKBundleFrameRef frame, uint64_t identifier, WKURLRequestRef request, bool pageLoadIsProvisional, const void* clientInfo) { static_cast(const_cast(clientInfo))->didInitiateLoadForResource(page, frame, identifier, request, pageLoadIsProvisional); } WKURLRequestRef InjectedBundlePage::willSendRequestForFrame(WKBundlePageRef page, WKBundleFrameRef frame, uint64_t identifier, WKURLRequestRef request, WKURLResponseRef redirectResponse, const void* clientInfo) { return static_cast(const_cast(clientInfo))->willSendRequestForFrame(page, frame, identifier, request, redirectResponse); } void InjectedBundlePage::didReceiveResponseForResource(WKBundlePageRef page, WKBundleFrameRef frame, uint64_t identifier, WKURLResponseRef response, const void* clientInfo) { static_cast(const_cast(clientInfo))->didReceiveResponseForResource(page, frame, identifier, response); } void InjectedBundlePage::didReceiveContentLengthForResource(WKBundlePageRef page, WKBundleFrameRef frame, uint64_t identifier, uint64_t length, const void* clientInfo) { static_cast(const_cast(clientInfo))->didReceiveContentLengthForResource(page, frame, identifier, length); } void InjectedBundlePage::didFinishLoadForResource(WKBundlePageRef page, WKBundleFrameRef frame, uint64_t identifier, const void* clientInfo) { static_cast(const_cast(clientInfo))->didFinishLoadForResource(page, frame, identifier); } void InjectedBundlePage::didFailLoadForResource(WKBundlePageRef page, WKBundleFrameRef frame, uint64_t identifier, WKErrorRef error, const void* clientInfo) { static_cast(const_cast(clientInfo))->didFailLoadForResource(page, frame, identifier, error); } bool InjectedBundlePage::shouldCacheResponse(WKBundlePageRef page, WKBundleFrameRef frame, uint64_t identifier, const void* clientInfo) { return static_cast(const_cast(clientInfo))->shouldCacheResponse(page, frame, identifier); } void InjectedBundlePage::didStartProvisionalLoadForFrame(WKBundleFrameRef frame) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; if (!injectedBundle.testRunner()->testURL()) { auto testURL = adoptWK(WKBundleFrameCopyProvisionalURL(frame)); injectedBundle.testRunner()->setTestURL(testURL.get()); } platformDidStartProvisionalLoadForFrame(frame); if (injectedBundle.testRunner()->shouldDumpFrameLoadCallbacks()) dumpLoadEvent(frame, "didStartProvisionalLoadForFrame"); if (!injectedBundle.topLoadingFrame()) injectedBundle.setTopLoadingFrame(frame); if (injectedBundle.testRunner()->shouldStopProvisionalFrameLoads()) dumpLoadEvent(frame, "stopping load in didStartProvisionalLoadForFrame callback"); } void InjectedBundlePage::didReceiveServerRedirectForProvisionalLoadForFrame(WKBundleFrameRef frame) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; if (!injectedBundle.testRunner()->shouldDumpFrameLoadCallbacks()) return; dumpLoadEvent(frame, "didReceiveServerRedirectForProvisionalLoadForFrame"); } void InjectedBundlePage::didFailProvisionalLoadWithErrorForFrame(WKBundleFrameRef frame, WKErrorRef error) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; // In case of a COOP process-swap, the old process gets a didFailProvisionalLoadWithErrorForFrame delegate call. We want to ignore // this call since it causes the test to dump its output too eagerly, before the test has had a chance to run in the new process. if (WKErrorGetErrorCode(error) == kWKErrorCodeFrameLoadInterruptedByPolicyChange && WKBundleFrameIsMainFrame(frame) && !m_didCommitMainFrameLoad && injectedBundle.page() == this) return; if (injectedBundle.testRunner()->shouldDumpFrameLoadCallbacks()) { dumpLoadEvent(frame, "didFailProvisionalLoadWithError"); auto code = WKErrorGetErrorCode(error); if (code == kWKErrorCodeCannotShowURL) dumpLoadEvent(frame, "(ErrorCodeCannotShowURL)"); else if (code == kWKErrorCodeFrameLoadBlockedByContentBlocker) dumpLoadEvent(frame, "(kWKErrorCodeFrameLoadBlockedByContentBlocker)"); } frameDidChangeLocation(frame); } void InjectedBundlePage::didCommitLoadForFrame(WKBundleFrameRef frame) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; if (WKBundleFrameIsMainFrame(frame)) m_didCommitMainFrameLoad = true; if (!injectedBundle.testRunner()->shouldDumpFrameLoadCallbacks()) return; dumpLoadEvent(frame, "didCommitLoadForFrame"); } void InjectedBundlePage::didFinishProgress() { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; if (!injectedBundle.testRunner()->shouldDumpProgressFinishedCallback()) return; injectedBundle.outputText("postProgressFinishedNotification\n"_s); } void InjectedBundlePage::willInjectUserScriptForFrame() { InjectedBundle::singleton().increaseUserScriptInjectedCount(); } enum FrameNamePolicy { ShouldNotIncludeFrameName, ShouldIncludeFrameName }; static void dumpFrameScrollPosition(WKBundleFrameRef frame, StringBuilder& stringBuilder, FrameNamePolicy shouldIncludeFrameName = ShouldNotIncludeFrameName) { double x = numericWindowProperty(frame, "pageXOffset"); double y = numericWindowProperty(frame, "pageYOffset"); if (fabs(x) <= 0.00000001 && fabs(y) <= 0.00000001) return; if (shouldIncludeFrameName) stringBuilder.append("frame '", adoptWK(WKBundleFrameCopyName(frame)).get(), "' "); stringBuilder.append("scrolled to ", x, ',', y, '\n'); } static void dumpDescendantFrameScrollPositions(WKBundleFrameRef frame, StringBuilder& stringBuilder) { auto childFrames = adoptWK(WKBundleFrameCopyChildFrames(frame)); size_t size = WKArrayGetSize(childFrames.get()); for (size_t i = 0; i < size; ++i) { WKBundleFrameRef subframe = static_cast(WKArrayGetItemAtIndex(childFrames.get(), i)); dumpFrameScrollPosition(subframe, stringBuilder, ShouldIncludeFrameName); dumpDescendantFrameScrollPositions(subframe, stringBuilder); } } void InjectedBundlePage::dumpAllFrameScrollPositions(StringBuilder& stringBuilder) { WKBundleFrameRef frame = WKBundlePageGetMainFrame(m_page); dumpFrameScrollPosition(frame, stringBuilder); dumpDescendantFrameScrollPositions(frame, stringBuilder); } static bool hasDocumentElement(WKBundleFrameRef frame) { auto context = WKBundleFrameGetJavaScriptContext(frame); return objectProperty(context, JSContextGetGlobalObject(context), { "document", "documentElement" }); } static void dumpFrameText(WKBundleFrameRef frame, StringBuilder& builder) { // If the frame doesn't have a document element, its inner text will be an empty string, so // we'll end up just appending a single newline below. Since DumpRenderTree didn't append // anything in this case, we decided to preserve that behavior. if (!hasDocumentElement(frame)) return; // To keep things tidy, strip all trailing spaces: they are not a meaningful part of dumpAsText test output. // Breaking the string up into lines lets us efficiently strip and has a side effect of adding a newline after the last line. auto text = toWTFString(adoptWK(WKBundleFrameCopyInnerText(frame))); for (auto line : StringView(text).splitAllowingEmptyEntries('\n')) { while (line.endsWith(' ')) line = line.left(line.length() - 1); builder.append(line, '\n'); } } static void dumpDescendantFramesText(WKBundleFrameRef frame, StringBuilder& stringBuilder) { auto childFrames = adoptWK(WKBundleFrameCopyChildFrames(frame)); size_t size = WKArrayGetSize(childFrames.get()); for (size_t i = 0; i < size; ++i) { WKBundleFrameRef subframe = static_cast(WKArrayGetItemAtIndex(childFrames.get(), i)); auto subframeName = adoptWK(WKBundleFrameCopyName(subframe)); // DumpRenderTree ignores empty frames, so do the same thing here. if (!hasDocumentElement(subframe)) continue; stringBuilder.append("\n--------\nFrame: '", subframeName.get(), "'\n--------\n"); dumpFrameText(subframe, stringBuilder); dumpDescendantFramesText(subframe, stringBuilder); } } void InjectedBundlePage::dumpAllFramesText(StringBuilder& stringBuilder) { WKBundleFrameRef frame = WKBundlePageGetMainFrame(m_page); dumpFrameText(frame, stringBuilder); dumpDescendantFramesText(frame, stringBuilder); } void InjectedBundlePage::dumpDOMAsWebArchive(WKBundleFrameRef frame, StringBuilder& stringBuilder) { #if USE(CF) && !PLATFORM(WIN_CAIRO) auto wkData = adoptWK(WKBundleFrameCopyWebArchive(frame)); auto cfData = adoptCF(CFDataCreate(0, WKDataGetBytes(wkData.get()), WKDataGetSize(wkData.get()))); stringBuilder.append(WebCoreTestSupport::createXMLStringFromWebArchiveData(cfData.get()).get()); #endif } void InjectedBundlePage::dump() { auto& injectedBundle = InjectedBundle::singleton(); ASSERT(injectedBundle.isTestRunning()); // Force a paint before dumping. This matches DumpRenderTree on Windows. (DumpRenderTree on Mac // does this at a slightly different time.) See for details. WKBundlePageForceRepaint(m_page); WKBundlePageFlushPendingEditorStateUpdate(m_page); WKBundleFrameRef frame = WKBundlePageGetMainFrame(m_page); auto urlRef = adoptWK(WKBundleFrameCopyURL(frame)); String url = toWTFString(adoptWK(WKURLCopyString(urlRef.get()))); auto mimeType = adoptWK(WKBundleFrameCopyMIMETypeForResourceWithURL(frame, urlRef.get())); if (url.find("dumpAsText/"_s) != notFound || WKStringIsEqualToUTF8CString(mimeType.get(), "text/plain")) injectedBundle.testRunner()->dumpAsText(false); StringBuilder stringBuilder; switch (injectedBundle.testRunner()->whatToDump()) { case WhatToDump::RenderTree: { if (injectedBundle.testRunner()->isPrinting()) stringBuilder.append(adoptWK(WKBundlePageCopyRenderTreeExternalRepresentationForPrinting(m_page)).get()); else stringBuilder.append(adoptWK(WKBundlePageCopyRenderTreeExternalRepresentation(m_page, injectedBundle.testRunner()->renderTreeDumpOptions())).get()); break; } case WhatToDump::MainFrameText: dumpFrameText(WKBundlePageGetMainFrame(m_page), stringBuilder); break; case WhatToDump::AllFramesText: dumpAllFramesText(stringBuilder); break; case WhatToDump::Audio: break; case WhatToDump::DOMAsWebArchive: dumpDOMAsWebArchive(frame, stringBuilder); break; } if (injectedBundle.testRunner()->shouldDumpAllFrameScrollPositions()) dumpAllFrameScrollPositions(stringBuilder); else if (injectedBundle.testRunner()->shouldDumpMainFrameScrollPosition()) dumpFrameScrollPosition(WKBundlePageGetMainFrame(m_page), stringBuilder); if (injectedBundle.testRunner()->shouldDumpBackForwardListsForAllWindows()) injectedBundle.dumpBackForwardListsForAllPages(stringBuilder); if (injectedBundle.shouldDumpPixels() && injectedBundle.testRunner()->shouldDumpPixels()) { bool shouldCreateSnapshot = injectedBundle.testRunner()->isPrinting(); if (shouldCreateSnapshot) { WKSnapshotOptions options = kWKSnapshotOptionsShareable; WKRect snapshotRect = WKBundleFrameGetVisibleContentBounds(WKBundlePageGetMainFrame(m_page)); if (injectedBundle.testRunner()->isPrinting()) options |= kWKSnapshotOptionsPrinting; else { options |= kWKSnapshotOptionsInViewCoordinates; if (injectedBundle.testRunner()->shouldDumpSelectionRect()) options |= kWKSnapshotOptionsPaintSelectionRectangle; } injectedBundle.setPixelResult(adoptWK(WKBundlePageCreateSnapshotWithOptions(m_page, snapshotRect, options)).get()); } else injectedBundle.setPixelResultIsPending(true); if (WKBundlePageIsTrackingRepaints(m_page) && !injectedBundle.testRunner()->isPrinting()) injectedBundle.setRepaintRects(adoptWK(WKBundlePageCopyTrackedRepaintRects(m_page)).get()); } injectedBundle.outputText(stringBuilder.toString(), InjectedBundle::IsFinalTestOutput::Yes); injectedBundle.done(); } void InjectedBundlePage::didFinishLoadForFrame(WKBundleFrameRef frame) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; if (injectedBundle.testRunner()->shouldDumpFrameLoadCallbacks()) dumpLoadEvent(frame, "didFinishLoadForFrame"); frameDidChangeLocation(frame); } void InjectedBundlePage::didFailLoadWithErrorForFrame(WKBundleFrameRef frame, WKErrorRef) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; if (injectedBundle.testRunner()->shouldDumpFrameLoadCallbacks()) dumpLoadEvent(frame, "didFailLoadWithError"); frameDidChangeLocation(frame); } void InjectedBundlePage::didReceiveTitleForFrame(WKStringRef title, WKBundleFrameRef frame) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; StringBuilder stringBuilder; if (injectedBundle.testRunner()->shouldDumpFrameLoadCallbacks()) stringBuilder.append(string(frame), " - didReceiveTitle: ", title, '\n'); if (injectedBundle.testRunner()->shouldDumpTitleChanges()) stringBuilder.append("TITLE CHANGED: '", title, "'\n"); injectedBundle.outputText(stringBuilder.toString()); } void InjectedBundlePage::didClearWindowForFrame(WKBundleFrameRef frame, WKBundleScriptWorldRef world) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; auto context = WKBundleFrameGetJavaScriptContextForWorld(frame, world); if (WKBundleScriptWorldNormalWorld() != world) { setGlobalObjectProperty(context, "__worldID", TestRunner::worldIDForWorld(world)); return; } injectedBundle.testRunner()->makeWindowObject(context); injectedBundle.gcController()->makeWindowObject(context); injectedBundle.eventSendingController()->makeWindowObject(context); injectedBundle.textInputController()->makeWindowObject(context); #if ENABLE(ACCESSIBILITY) injectedBundle.accessibilityController()->makeWindowObject(context); #endif WebCoreTestSupport::injectInternalsObject(context); } void InjectedBundlePage::didCancelClientRedirectForFrame(WKBundleFrameRef frame) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; if (injectedBundle.testRunner()->shouldDumpFrameLoadCallbacks()) dumpLoadEvent(frame, "didCancelClientRedirectForFrame"); injectedBundle.testRunner()->setDidCancelClientRedirect(true); } void InjectedBundlePage::willPerformClientRedirectForFrame(WKBundlePageRef, WKBundleFrameRef frame, WKURLRef url, double delay, double date) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; if (!injectedBundle.testRunner()->shouldDumpFrameLoadCallbacks()) return; injectedBundle.outputText(makeString(string(frame), " - willPerformClientRedirectToURL: ", pathSuitableForTestResult(url), '\n')); } void InjectedBundlePage::didSameDocumentNavigationForFrame(WKBundleFrameRef frame, WKSameDocumentNavigationType type) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; if (!injectedBundle.testRunner()->shouldDumpFrameLoadCallbacks()) return; if (type != kWKSameDocumentNavigationAnchorNavigation) return; dumpLoadEvent(frame, "didChangeLocationWithinPageForFrame"); } void InjectedBundlePage::didFinishDocumentLoadForFrame(WKBundleFrameRef frame) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; if (injectedBundle.testRunner()->shouldDumpFrameLoadCallbacks()) dumpLoadEvent(frame, "didFinishDocumentLoadForFrame"); if (unsigned pendingFrameUnloadEvents = WKBundleFrameGetPendingUnloadCount(frame)) injectedBundle.outputText(makeString(string(frame), " - has ", pendingFrameUnloadEvents, " onunload handler(s)\n")); } void InjectedBundlePage::didHandleOnloadEventsForFrame(WKBundleFrameRef frame) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; if (injectedBundle.testRunner()->shouldDumpFrameLoadCallbacks()) dumpLoadEvent(frame, "didHandleOnloadEventsForFrame"); } void InjectedBundlePage::didDisplayInsecureContentForFrame(WKBundleFrameRef) { auto& injectedBundle = InjectedBundle::singleton(); if (injectedBundle.testRunner()->shouldDumpFrameLoadCallbacks()) injectedBundle.outputText("didDisplayInsecureContent\n"_s); } void InjectedBundlePage::didRunInsecureContentForFrame(WKBundleFrameRef) { auto& injectedBundle = InjectedBundle::singleton(); if (injectedBundle.testRunner()->shouldDumpFrameLoadCallbacks()) injectedBundle.outputText("didRunInsecureContent\n"_s); } void InjectedBundlePage::didDetectXSSForFrame(WKBundleFrameRef) { auto& injectedBundle = InjectedBundle::singleton(); if (injectedBundle.testRunner()->shouldDumpFrameLoadCallbacks()) injectedBundle.outputText("didDetectXSS\n"_s); } void InjectedBundlePage::didInitiateLoadForResource(WKBundlePageRef page, WKBundleFrameRef, uint64_t identifier, WKURLRequestRef request, bool) { if (!InjectedBundle::singleton().isTestRunning()) return; auto url = adoptWK(WKURLRequestCopyURL(request)); assignedUrlsCache().add(identifier, pathSuitableForTestResult(url.get())); } // Resource Load Client Callbacks static inline bool isLocalHost(WKStringRef host) { return WKStringIsEqualToUTF8CString(host, "127.0.0.1") || WKStringIsEqualToUTF8CString(host, "localhost"); } static inline bool isHTTPOrHTTPSScheme(WKStringRef scheme) { return WKStringIsEqualToUTF8CStringIgnoringCase(scheme, "http") || WKStringIsEqualToUTF8CStringIgnoringCase(scheme, "https"); } static inline bool isAllowedHost(WKStringRef host) { return InjectedBundle::singleton().isAllowedHost(host); } WKURLRequestRef InjectedBundlePage::willSendRequestForFrame(WKBundlePageRef page, WKBundleFrameRef frame, uint64_t identifier, WKURLRequestRef request, WKURLResponseRef response) { auto& injectedBundle = InjectedBundle::singleton(); if (injectedBundle.isTestRunning() && injectedBundle.testRunner()->shouldDumpResourceLoadCallbacks()) { StringBuilder stringBuilder; dumpResourceURL(identifier, stringBuilder); stringBuilder.append(" - willSendRequest ", string(request), " redirectResponse ", string(response, injectedBundle.testRunner()->shouldDumpAllHTTPRedirectedResponseHeaders()), '\n'); injectedBundle.outputText(stringBuilder.toString()); } if (injectedBundle.isTestRunning() && injectedBundle.testRunner()->willSendRequestReturnsNull()) return nullptr; auto redirectURL = adoptWK(WKURLResponseCopyURL(response)); if (injectedBundle.isTestRunning() && injectedBundle.testRunner()->willSendRequestReturnsNullOnRedirect() && redirectURL) { injectedBundle.outputText("Returning null for this redirect\n"_s); return nullptr; } auto url = adoptWK(WKURLRequestCopyURL(request)); auto host = adoptWK(WKURLCopyHostName(url.get())); auto scheme = adoptWK(WKURLCopyScheme(url.get())); auto urlString = adoptWK(WKURLCopyString(url.get())); if (host && !WKStringIsEmpty(host.get()) && isHTTPOrHTTPSScheme(scheme.get()) && !WKStringIsEqualToUTF8CString(host.get(), "255.255.255.255") // Used in some tests that expect to get back an error. && !isLocalHost(host.get())) { bool mainFrameIsExternal = false; if (injectedBundle.isTestRunning()) { WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(m_page); auto mainFrameURL = adoptWK(WKBundleFrameCopyURL(mainFrame)); if (!mainFrameURL || WKStringIsEqualToUTF8CString(adoptWK(WKURLCopyString(mainFrameURL.get())).get(), "about:blank")) mainFrameURL = adoptWK(WKBundleFrameCopyProvisionalURL(mainFrame)); if (mainFrameURL) { auto mainFrameHost = adoptWK(WKURLCopyHostName(mainFrameURL.get())); auto mainFrameScheme = adoptWK(WKURLCopyScheme(mainFrameURL.get())); mainFrameIsExternal = isHTTPOrHTTPSScheme(mainFrameScheme.get()) && !isLocalHost(mainFrameHost.get()); } } if (!mainFrameIsExternal && !isAllowedHost(host.get())) { injectedBundle.outputText(makeString("Blocked access to external URL ", urlString.get(), '\n')); return nullptr; } } if (injectedBundle.isTestRunning()) { String body = injectedBundle.testRunner()->willSendRequestHTTPBody(); if (!body.isEmpty()) { CString cBody = body.utf8(); auto body = adoptWK(WKDataCreate(reinterpret_cast(cBody.data()), cBody.length())); return WKURLRequestCopySettingHTTPBody(request, body.get()); } } WKRetain(request); return request; } void InjectedBundlePage::didReceiveResponseForResource(WKBundlePageRef page, WKBundleFrameRef, uint64_t identifier, WKURLResponseRef response) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; if (injectedBundle.testRunner()->shouldDumpResourceLoadCallbacks()) { StringBuilder stringBuilder; dumpResourceURL(identifier, stringBuilder); stringBuilder.append(" - didReceiveResponse ", string(response), '\n'); injectedBundle.outputText(stringBuilder.toString()); } if (!injectedBundle.testRunner()->shouldDumpResourceResponseMIMETypes()) return; auto url = adoptWK(WKURLResponseCopyURL(response)); auto urlString = adoptWK(WKURLCopyLastPathComponent(url.get())); auto mimeTypeString = adoptWK(WKURLResponseCopyMIMEType(response)); StringBuilder stringBuilder; stringBuilder.append(urlString.get(), " has MIME type ", mimeTypeString.get()); String platformMimeType = platformResponseMimeType(response); if (!platformMimeType.isEmpty() && platformMimeType != toWTFString(mimeTypeString)) { stringBuilder.append(" but platform response has ", platformMimeType); } stringBuilder.append('\n'); injectedBundle.outputText(stringBuilder.toString()); } void InjectedBundlePage::didReceiveContentLengthForResource(WKBundlePageRef, WKBundleFrameRef, uint64_t, uint64_t) { } void InjectedBundlePage::didFinishLoadForResource(WKBundlePageRef, WKBundleFrameRef, uint64_t identifier) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; if (!injectedBundle.testRunner()->shouldDumpResourceLoadCallbacks()) return; StringBuilder stringBuilder; dumpResourceURL(identifier, stringBuilder); stringBuilder.append(" - didFinishLoading\n"); injectedBundle.outputText(stringBuilder.toString()); } void InjectedBundlePage::didFailLoadForResource(WKBundlePageRef, WKBundleFrameRef, uint64_t identifier, WKErrorRef error) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; if (!injectedBundle.testRunner()->shouldDumpResourceLoadCallbacks()) return; StringBuilder stringBuilder; dumpResourceURL(identifier, stringBuilder); stringBuilder.append(" - didFailLoadingWithError: "); dumpErrorDescriptionSuitableForTestResult(error, stringBuilder); stringBuilder.append('\n'); injectedBundle.outputText(stringBuilder.toString()); } bool InjectedBundlePage::shouldCacheResponse(WKBundlePageRef, WKBundleFrameRef, uint64_t identifier) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return true; if (!injectedBundle.testRunner()->shouldDumpWillCacheResponse()) return true; injectedBundle.outputText(makeString(identifier, " - willCacheResponse: called\n")); // The default behavior is the cache the response. return true; } // Policy Client Callbacks WKBundlePagePolicyAction InjectedBundlePage::decidePolicyForNavigationAction(WKBundlePageRef page, WKBundleFrameRef frame, WKBundleNavigationActionRef navigationAction, WKURLRequestRef request, WKTypeRef* userData, const void* clientInfo) { return static_cast(const_cast(clientInfo))->decidePolicyForNavigationAction(page, frame, navigationAction, request, userData); } WKBundlePagePolicyAction InjectedBundlePage::decidePolicyForNewWindowAction(WKBundlePageRef page, WKBundleFrameRef frame, WKBundleNavigationActionRef navigationAction, WKURLRequestRef request, WKStringRef frameName, WKTypeRef* userData, const void* clientInfo) { return static_cast(const_cast(clientInfo))->decidePolicyForNewWindowAction(page, frame, navigationAction, request, frameName, userData); } WKBundlePagePolicyAction InjectedBundlePage::decidePolicyForResponse(WKBundlePageRef page, WKBundleFrameRef frame, WKURLResponseRef response, WKURLRequestRef request, WKTypeRef* userData, const void* clientInfo) { return static_cast(const_cast(clientInfo))->decidePolicyForResponse(page, frame, response, request, userData); } void InjectedBundlePage::unableToImplementPolicy(WKBundlePageRef page, WKBundleFrameRef frame, WKErrorRef error, WKTypeRef* userData, const void* clientInfo) { static_cast(const_cast(clientInfo))->unableToImplementPolicy(page, frame, error, userData); } WKBundlePagePolicyAction InjectedBundlePage::decidePolicyForNavigationAction(WKBundlePageRef page, WKBundleFrameRef frame, WKBundleNavigationActionRef navigationAction, WKURLRequestRef request, WKTypeRef* userData) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return WKBundlePagePolicyActionUse; if (injectedBundle.testRunner()->shouldDumpPolicyCallbacks()) { injectedBundle.outputText(makeString(" - decidePolicyForNavigationAction\n", string(request), " is main frame - ", WKBundleFrameIsMainFrame(frame) ? "yes" : "no", " should open URLs externally - ", WKBundleNavigationActionGetShouldOpenExternalURLs(navigationAction) ? "yes" : "no", '\n')); } if (!injectedBundle.testRunner()->isPolicyDelegateEnabled()) return WKBundlePagePolicyActionPassThrough; auto url = adoptWK(WKURLRequestCopyURL(request)); auto urlScheme = adoptWK(WKURLCopyScheme(url.get())); StringBuilder stringBuilder; stringBuilder.append("Policy delegate: attempt to load "); if (isLocalFileScheme(urlScheme.get())) stringBuilder.append(adoptWK(WKURLCopyLastPathComponent(url.get())).get()); else stringBuilder.append(adoptWK(WKURLCopyString(url.get())).get()); stringBuilder.append(" with navigation type \'", NavigationTypeToString(WKBundleNavigationActionGetNavigationType(navigationAction)).get(), '\''); auto hitTestResultRef = adoptWK(WKBundleNavigationActionCopyHitTestResult(navigationAction)); if (hitTestResultRef) { auto nodeHandleRef = adoptWK(WKBundleHitTestResultCopyNodeHandle(hitTestResultRef.get())); stringBuilder.append(" originating from ", dumpPath(m_page, m_world.get(), nodeHandleRef.get())); } stringBuilder.append('\n'); injectedBundle.outputText(stringBuilder.toString()); injectedBundle.testRunner()->notifyDone(); return WKBundlePagePolicyActionPassThrough; } WKBundlePagePolicyAction InjectedBundlePage::decidePolicyForNewWindowAction(WKBundlePageRef, WKBundleFrameRef, WKBundleNavigationActionRef, WKURLRequestRef, WKStringRef, WKTypeRef*) { return WKBundlePagePolicyActionPassThrough; } WKBundlePagePolicyAction InjectedBundlePage::decidePolicyForResponse(WKBundlePageRef page, WKBundleFrameRef, WKURLResponseRef response, WKURLRequestRef, WKTypeRef*) { auto& injectedBundle = InjectedBundle::singleton(); if (injectedBundle.testRunner() && injectedBundle.testRunner()->isPolicyDelegateEnabled() && WKURLResponseIsAttachment(response)) { InjectedBundle::singleton().outputText(makeString("Policy delegate: resource is an attachment, suggested file name \'", adoptWK(WKURLResponseCopySuggestedFilename(response)).get(), "'\n")); } return WKBundlePagePolicyActionPassThrough; } void InjectedBundlePage::unableToImplementPolicy(WKBundlePageRef, WKBundleFrameRef, WKErrorRef, WKTypeRef*) { } // UI Client Callbacks void InjectedBundlePage::willAddMessageToConsole(WKBundlePageRef page, WKStringRef message, uint32_t /* lineNumber */, const void *clientInfo) { static_cast(const_cast(clientInfo))->willAddMessageToConsole(message); } void InjectedBundlePage::willSetStatusbarText(WKBundlePageRef page, WKStringRef statusbarText, const void *clientInfo) { static_cast(const_cast(clientInfo))->willSetStatusbarText(statusbarText); } void InjectedBundlePage::willRunJavaScriptAlert(WKBundlePageRef page, WKStringRef message, WKBundleFrameRef frame, const void *clientInfo) { static_cast(const_cast(clientInfo))->willRunJavaScriptAlert(message, frame); } void InjectedBundlePage::willRunJavaScriptConfirm(WKBundlePageRef page, WKStringRef message, WKBundleFrameRef frame, const void *clientInfo) { return static_cast(const_cast(clientInfo))->willRunJavaScriptConfirm(message, frame); } void InjectedBundlePage::willRunJavaScriptPrompt(WKBundlePageRef page, WKStringRef message, WKStringRef defaultValue, WKBundleFrameRef frame, const void *clientInfo) { static_cast(const_cast(clientInfo))->willRunJavaScriptPrompt(message, defaultValue, frame); } void InjectedBundlePage::didReachApplicationCacheOriginQuota(WKBundlePageRef page, WKSecurityOriginRef origin, int64_t totalBytesNeeded, const void* clientInfo) { static_cast(const_cast(clientInfo))->didReachApplicationCacheOriginQuota(origin, totalBytesNeeded); } uint64_t InjectedBundlePage::didExceedDatabaseQuota(WKBundlePageRef page, WKSecurityOriginRef origin, WKStringRef databaseName, WKStringRef databaseDisplayName, uint64_t currentQuotaBytes, uint64_t currentOriginUsageBytes, uint64_t currentDatabaseUsageBytes, uint64_t expectedUsageBytes, const void* clientInfo) { return static_cast(const_cast(clientInfo))->didExceedDatabaseQuota(origin, databaseName, databaseDisplayName, currentQuotaBytes, currentOriginUsageBytes, currentDatabaseUsageBytes, expectedUsageBytes); } static WTF::String stripTrailingSpacesAddNewline(const WTF::String& string) { StringBuilder builder; for (auto line : StringView(string).splitAllowingEmptyEntries('\n')) { while (line.endsWith(' ')) line = line.left(line.length() - 1); builder.append(line, '\n'); } return builder.toString(); } static WTF::String addLeadingSpaceStripTrailingSpacesAddNewline(const WTF::String& string) { auto result = stripTrailingSpacesAddNewline(string); return (result.isEmpty() || result.startsWith('\n')) ? result : makeString(' ', result); } static StringView lastFileURLPathComponent(StringView path) { auto pos = path.find("file://"_s); ASSERT(WTF::notFound != pos); auto tmpPath = path.substring(pos + 7); if (tmpPath.length() < 2) // Keep the lone slash to avoid empty output. return tmpPath; // Remove the trailing delimiter if (tmpPath[tmpPath.length() - 1] == '/') tmpPath = tmpPath.left(tmpPath.length() - 1); pos = tmpPath.reverseFind('/'); if (WTF::notFound != pos) return tmpPath.substring(pos + 1); return tmpPath; } void InjectedBundlePage::willAddMessageToConsole(WKStringRef message) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; auto messageString = toWTFString(message); messageString = messageString.left(messageString.find(nullCharacter)); size_t fileProtocolStart = messageString.find("file://"_s); if (fileProtocolStart != WTF::notFound) { StringView messageStringView { messageString }; // FIXME: The code below does not handle additional text after url nor multiple urls. This matches DumpRenderTree implementation. messageString = makeString(messageStringView.left(fileProtocolStart), lastFileURLPathComponent(messageStringView.substring(fileProtocolStart))); } messageString = makeString("CONSOLE MESSAGE:", addLeadingSpaceStripTrailingSpacesAddNewline(messageString)); if (injectedBundle.dumpJSConsoleLogInStdErr()) injectedBundle.dumpToStdErr(messageString); else injectedBundle.outputText(messageString); } void InjectedBundlePage::willSetStatusbarText(WKStringRef statusbarText) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; if (!injectedBundle.testRunner()->shouldDumpStatusCallbacks()) return; injectedBundle.outputText(makeString("UI DELEGATE STATUS CALLBACK: setStatusText:", statusbarText, '\n')); } void InjectedBundlePage::willRunJavaScriptAlert(WKStringRef message, WKBundleFrameRef) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; injectedBundle.outputText(makeString("ALERT:", addLeadingSpaceStripTrailingSpacesAddNewline(toWTFString(message)))); } void InjectedBundlePage::willRunJavaScriptConfirm(WKStringRef message, WKBundleFrameRef) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; injectedBundle.outputText(makeString("CONFIRM:", addLeadingSpaceStripTrailingSpacesAddNewline(toWTFString(message)))); } void InjectedBundlePage::willRunJavaScriptPrompt(WKStringRef message, WKStringRef defaultValue, WKBundleFrameRef) { InjectedBundle::singleton().outputText(makeString("PROMPT: ", message, ", default text:", addLeadingSpaceStripTrailingSpacesAddNewline(toWTFString(defaultValue)))); } void InjectedBundlePage::didReachApplicationCacheOriginQuota(WKSecurityOriginRef origin, int64_t totalBytesNeeded) { auto& injectedBundle = InjectedBundle::singleton(); if (injectedBundle.testRunner()->shouldDumpApplicationCacheDelegateCallbacks()) { // For example, numbers from 30000 - 39999 will output as 30000. // Rounding up or down does not really matter for these tests. It's // sufficient to just get a range of 10000 to determine if we were // above or below a threshold. auto truncatedSpaceNeeded = (totalBytesNeeded / 10000) * 10000; injectedBundle.outputText(makeString("UI DELEGATE APPLICATION CACHE CALLBACK: exceededApplicationCacheOriginQuotaForSecurityOrigin:", string(origin), " totalSpaceNeeded:~", truncatedSpaceNeeded, '\n')); } if (injectedBundle.testRunner()->shouldDisallowIncreaseForApplicationCacheQuota()) return; // Reset default application cache quota. WKBundlePageResetApplicationCacheOriginQuota(injectedBundle.page()->page(), adoptWK(WKSecurityOriginCopyToString(origin)).get()); } uint64_t InjectedBundlePage::didExceedDatabaseQuota(WKSecurityOriginRef origin, WKStringRef databaseName, WKStringRef databaseDisplayName, uint64_t currentQuotaBytes, uint64_t currentOriginUsageBytes, uint64_t currentDatabaseUsageBytes, uint64_t expectedUsageBytes) { auto& injectedBundle = InjectedBundle::singleton(); if (injectedBundle.testRunner()->shouldDumpDatabaseCallbacks()) injectedBundle.outputText(makeString("UI DELEGATE DATABASE CALLBACK: exceededDatabaseQuotaForSecurityOrigin:", string(origin), " database:", databaseName, '\n')); uint64_t defaultQuota = 5 * 1024 * 1024; double testDefaultQuota = injectedBundle.testRunner()->databaseDefaultQuota(); if (testDefaultQuota >= 0) defaultQuota = testDefaultQuota; unsigned long long newQuota = defaultQuota; double maxQuota = injectedBundle.testRunner()->databaseMaxQuota(); if (maxQuota >= 0) { if (defaultQuota < expectedUsageBytes && expectedUsageBytes <= maxQuota) { newQuota = expectedUsageBytes; injectedBundle.outputText(makeString("UI DELEGATE DATABASE CALLBACK: increased quota to ", newQuota, '\n')); } } return newQuota; } // Editor Client Callbacks bool InjectedBundlePage::shouldBeginEditing(WKBundlePageRef page, WKBundleRangeHandleRef range, const void* clientInfo) { return static_cast(const_cast(clientInfo))->shouldBeginEditing(range); } bool InjectedBundlePage::shouldEndEditing(WKBundlePageRef page, WKBundleRangeHandleRef range, const void* clientInfo) { return static_cast(const_cast(clientInfo))->shouldEndEditing(range); } bool InjectedBundlePage::shouldInsertNode(WKBundlePageRef page, WKBundleNodeHandleRef node, WKBundleRangeHandleRef rangeToReplace, WKInsertActionType action, const void* clientInfo) { return static_cast(const_cast(clientInfo))->shouldInsertNode(node, rangeToReplace, action); } bool InjectedBundlePage::shouldInsertText(WKBundlePageRef page, WKStringRef text, WKBundleRangeHandleRef rangeToReplace, WKInsertActionType action, const void* clientInfo) { return static_cast(const_cast(clientInfo))->shouldInsertText(text, rangeToReplace, action); } bool InjectedBundlePage::shouldDeleteRange(WKBundlePageRef page, WKBundleRangeHandleRef range, const void* clientInfo) { return static_cast(const_cast(clientInfo))->shouldDeleteRange(range); } bool InjectedBundlePage::shouldChangeSelectedRange(WKBundlePageRef page, WKBundleRangeHandleRef fromRange, WKBundleRangeHandleRef toRange, WKAffinityType affinity, bool stillSelecting, const void* clientInfo) { return static_cast(const_cast(clientInfo))->shouldChangeSelectedRange(fromRange, toRange, affinity, stillSelecting); } bool InjectedBundlePage::shouldApplyStyle(WKBundlePageRef page, WKBundleCSSStyleDeclarationRef style, WKBundleRangeHandleRef range, const void* clientInfo) { return static_cast(const_cast(clientInfo))->shouldApplyStyle(style, range); } void InjectedBundlePage::didBeginEditing(WKBundlePageRef page, WKStringRef notificationName, const void* clientInfo) { static_cast(const_cast(clientInfo))->didBeginEditing(notificationName); } void InjectedBundlePage::didEndEditing(WKBundlePageRef page, WKStringRef notificationName, const void* clientInfo) { static_cast(const_cast(clientInfo))->didEndEditing(notificationName); } void InjectedBundlePage::didChange(WKBundlePageRef page, WKStringRef notificationName, const void* clientInfo) { static_cast(const_cast(clientInfo))->didChange(notificationName); } void InjectedBundlePage::didChangeSelection(WKBundlePageRef page, WKStringRef notificationName, const void* clientInfo) { static_cast(const_cast(clientInfo))->didChangeSelection(notificationName); } bool InjectedBundlePage::shouldBeginEditing(WKBundleRangeHandleRef range) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return true; if (injectedBundle.testRunner()->shouldDumpEditingCallbacks()) injectedBundle.outputText(makeString("EDITING DELEGATE: shouldBeginEditingInDOMRange:", string(m_page, m_world.get(), range), '\n')); return injectedBundle.testRunner()->shouldAllowEditing(); } bool InjectedBundlePage::shouldEndEditing(WKBundleRangeHandleRef range) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return true; if (injectedBundle.testRunner()->shouldDumpEditingCallbacks()) injectedBundle.outputText(makeString("EDITING DELEGATE: shouldEndEditingInDOMRange:", string(m_page, m_world.get(), range), '\n')); return injectedBundle.testRunner()->shouldAllowEditing(); } bool InjectedBundlePage::shouldInsertNode(WKBundleNodeHandleRef node, WKBundleRangeHandleRef rangeToReplace, WKInsertActionType action) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return true; static constexpr const char* insertactionstring[] = { "WebViewInsertActionTyped", "WebViewInsertActionPasted", "WebViewInsertActionDropped", }; if (injectedBundle.testRunner()->shouldDumpEditingCallbacks()) { injectedBundle.outputText(makeString("EDITING DELEGATE:" " shouldInsertNode:", dumpPath(m_page, m_world.get(), node), " replacingDOMRange:", string(m_page, m_world.get(), rangeToReplace), " givenAction:", insertactionstring[action], '\n')); } return injectedBundle.testRunner()->shouldAllowEditing(); } bool InjectedBundlePage::shouldInsertText(WKStringRef text, WKBundleRangeHandleRef rangeToReplace, WKInsertActionType action) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return true; static constexpr const char* insertactionstring[] = { "WebViewInsertActionTyped", "WebViewInsertActionPasted", "WebViewInsertActionDropped", }; if (injectedBundle.testRunner()->shouldDumpEditingCallbacks()) { injectedBundle.outputText(makeString("EDITING DELEGATE:" " shouldInsertText:", text, " replacingDOMRange:", string(m_page, m_world.get(), rangeToReplace), " givenAction:", insertactionstring[action], '\n')); } return injectedBundle.testRunner()->shouldAllowEditing(); } bool InjectedBundlePage::shouldDeleteRange(WKBundleRangeHandleRef range) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return true; if (injectedBundle.testRunner()->shouldDumpEditingCallbacks()) injectedBundle.outputText(makeString("EDITING DELEGATE: shouldDeleteDOMRange:", string(m_page, m_world.get(), range), '\n')); return injectedBundle.testRunner()->shouldAllowEditing(); } bool InjectedBundlePage::shouldChangeSelectedRange(WKBundleRangeHandleRef fromRange, WKBundleRangeHandleRef toRange, WKAffinityType affinity, bool stillSelecting) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return true; static constexpr const char* affinitystring[] = { "NSSelectionAffinityUpstream", "NSSelectionAffinityDownstream" }; if (injectedBundle.testRunner()->shouldDumpEditingCallbacks()) { injectedBundle.outputText(makeString("EDITING DELEGATE:" " shouldChangeSelectedDOMRange:", string(m_page, m_world.get(), fromRange), " toDOMRange:", string(m_page, m_world.get(), toRange), " affinity:", affinitystring[affinity], " stillSelecting:", stillSelecting ? "TRUE" : "FALSE", '\n')); } return injectedBundle.testRunner()->shouldAllowEditing(); } bool InjectedBundlePage::shouldApplyStyle(WKBundleCSSStyleDeclarationRef style, WKBundleRangeHandleRef range) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return true; if (injectedBundle.testRunner()->shouldDumpEditingCallbacks()) { injectedBundle.outputText(makeString("EDITING DELEGATE:" " shouldApplyStyle:", styleDecToStr(style), " toElementsInDOMRange:", string(m_page, m_world.get(), range), '\n')); } return injectedBundle.testRunner()->shouldAllowEditing(); } void InjectedBundlePage::didBeginEditing(WKStringRef notificationName) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; if (!injectedBundle.testRunner()->shouldDumpEditingCallbacks()) return; injectedBundle.outputText(makeString("EDITING DELEGATE: webViewDidBeginEditing:", notificationName, '\n')); } void InjectedBundlePage::didEndEditing(WKStringRef notificationName) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; if (!injectedBundle.testRunner()->shouldDumpEditingCallbacks()) return; injectedBundle.outputText(makeString("EDITING DELEGATE: webViewDidEndEditing:", notificationName, '\n')); } void InjectedBundlePage::didChange(WKStringRef notificationName) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; if (!injectedBundle.testRunner()->shouldDumpEditingCallbacks()) return; injectedBundle.outputText(makeString("EDITING DELEGATE: webViewDidChange:", notificationName, '\n')); } void InjectedBundlePage::didChangeSelection(WKStringRef notificationName) { auto& injectedBundle = InjectedBundle::singleton(); if (!injectedBundle.isTestRunning()) return; if (!injectedBundle.testRunner()->shouldDumpEditingCallbacks()) return; injectedBundle.outputText(makeString("EDITING DELEGATE: webViewDidChangeSelection:", notificationName, '\n')); } #if ENABLE(FULLSCREEN_API) bool InjectedBundlePage::supportsFullScreen(WKBundlePageRef pageRef, WKFullScreenKeyboardRequestType requestType) { auto& injectedBundle = InjectedBundle::singleton(); if (injectedBundle.testRunner()->shouldDumpFullScreenCallbacks()) injectedBundle.outputText("supportsFullScreen() == true\n"_s); return true; } void InjectedBundlePage::enterFullScreenForElement(WKBundlePageRef pageRef, WKBundleNodeHandleRef elementRef) { ASSERT(bundlePageMap().contains(pageRef)); if (auto* injectedBundlePage = bundlePageMap().get(pageRef)) injectedBundlePage->enterFullScreenForElement(elementRef); } void InjectedBundlePage::enterFullScreenForElement(WKBundleNodeHandleRef elementRef) { auto& injectedBundle = InjectedBundle::singleton(); if (injectedBundle.testRunner()->shouldDumpFullScreenCallbacks()) injectedBundle.outputText("enterFullScreenForElement()\n"_s); if (m_fullscreenState == EnteringFullscreen) return; m_fullscreenState = EnteringFullscreen; if (!injectedBundle.testRunner()->hasCustomFullScreenBehavior()) { WKBundlePageWillEnterFullScreen(m_page); if (m_fullscreenState != EnteringFullscreen) return; WKBundlePageDidEnterFullScreen(m_page); if (m_fullscreenState != EnteringFullscreen) return; } else injectedBundle.testRunner()->callEnterFullscreenForElementCallback(); m_fullscreenState = InFullscreen; } void InjectedBundlePage::exitFullScreenForElement(WKBundlePageRef pageRef, WKBundleNodeHandleRef elementRef) { ASSERT(bundlePageMap().contains(pageRef)); if (auto* injectedBundlePage = bundlePageMap().get(pageRef)) injectedBundlePage->exitFullScreenForElement(elementRef); } void InjectedBundlePage::exitFullScreenForElement(WKBundleNodeHandleRef elementRef) { auto& injectedBundle = InjectedBundle::singleton(); if (injectedBundle.testRunner()->shouldDumpFullScreenCallbacks()) injectedBundle.outputText("exitFullScreenForElement()\n"_s); if (m_fullscreenState == ExitingFullscreen) return; m_fullscreenState = ExitingFullscreen; if (!injectedBundle.testRunner()->hasCustomFullScreenBehavior()) { WKBundlePageWillExitFullScreen(m_page); if (m_fullscreenState != ExitingFullscreen) return; WKBundlePageDidExitFullScreen(m_page); if (m_fullscreenState != ExitingFullscreen) return; } else injectedBundle.testRunner()->callExitFullscreenForElementCallback(); m_fullscreenState = NotInFullscreen; } void InjectedBundlePage::beganEnterFullScreen(WKBundlePageRef, WKRect, WKRect) { auto& injectedBundle = InjectedBundle::singleton(); if (injectedBundle.testRunner()->shouldDumpFullScreenCallbacks()) injectedBundle.outputText("beganEnterFullScreen()\n"_s); } void InjectedBundlePage::beganExitFullScreen(WKBundlePageRef, WKRect, WKRect) { auto& injectedBundle = InjectedBundle::singleton(); if (injectedBundle.testRunner()->shouldDumpFullScreenCallbacks()) injectedBundle.outputText("beganExitFullScreen()\n"_s); } void InjectedBundlePage::closeFullScreen(WKBundlePageRef pageRef) { auto& injectedBundle = InjectedBundle::singleton(); if (injectedBundle.testRunner()->shouldDumpFullScreenCallbacks()) injectedBundle.outputText("closeFullScreen()\n"_s); if (!injectedBundle.testRunner()->hasCustomFullScreenBehavior()) { WKBundlePageWillExitFullScreen(pageRef); WKBundlePageDidExitFullScreen(pageRef); } } #endif String InjectedBundlePage::dumpHistory() { return makeString( "\n============== Back Forward List ==============\n", adoptWK(WKBundlePageDumpHistoryForTesting(m_page, toWK("/LayoutTests/").get())).get(), "===============================================\n" ); } #if !PLATFORM(COCOA) void InjectedBundlePage::platformDidStartProvisionalLoadForFrame(WKBundleFrameRef) { } String InjectedBundlePage::platformResponseMimeType(WKURLResponseRef) { return String(); } #endif static bool hasReftestWaitAttribute(WKBundlePageRef page) { auto frame = WKBundlePageGetMainFrame(page); return frame && hasReftestWaitAttribute(WKBundleFrameGetJavaScriptContext(frame)); } static void dumpAfterWaitAttributeIsRemoved(WKBundlePageRef page) { if (hasReftestWaitAttribute(page)) { WKRetain(page); // Use a 1ms interval between tries to allow lower priority run loop sources with zero delays to run. RunLoop::current().dispatchAfter(1_ms, [page] { WKBundlePageCallAfterTasksAndTimers(page, [] (void* typelessPage) { auto page = static_cast(typelessPage); dumpAfterWaitAttributeIsRemoved(page); WKRelease(page); }, const_cast(page)); }); return; } if (auto& bundle = InjectedBundle::singleton(); bundle.isTestRunning()) { if (auto currentPage = bundle.page(); currentPage && currentPage->page() == page) currentPage->dump(); } } void InjectedBundlePage::frameDidChangeLocation(WKBundleFrameRef frame) { auto& injectedBundle = InjectedBundle::singleton(); if (frame != injectedBundle.topLoadingFrame()) return; injectedBundle.setTopLoadingFrame(nullptr); if (injectedBundle.testRunner()->shouldDisplayOnLoadFinish()) { if (auto page = InjectedBundle::singleton().page()) WKBundlePageForceRepaint(page->page()); } if (injectedBundle.testRunner()->shouldWaitUntilDone()) return; if (injectedBundle.shouldProcessWorkQueue()) { injectedBundle.processWorkQueue(); return; } auto page = InjectedBundle::singleton().page(); if (!page) { injectedBundle.done(); return; } if (auto frame = WKBundlePageGetMainFrame(page->page())) sendTestRenderedEvent(WKBundleFrameGetJavaScriptContext(frame)); dumpAfterWaitAttributeIsRemoved(page->page()); } } // namespace WTR