1/* 2 * Copyright (C) 2006, 2007, 2008, 2011, 2012 Apple Inc. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of Apple Inc. ("Apple") nor the names of 14 * its contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY 18 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 20 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY 21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29#import <WebCore/FrameLoaderClient.h> 30#import <WebCore/Timer.h> 31#import <wtf/Forward.h> 32#import <wtf/HashMap.h> 33#import <wtf/RetainPtr.h> 34 35@class WebDownload; 36@class WebFrame; 37@class WebFramePolicyListener; 38@class WebHistoryItem; 39@class WebResource; 40 41namespace WebCore { 42 class AuthenticationChallenge; 43 class CachedFrame; 44 class HistoryItem; 45 class ProtectionSpace; 46 class ResourceLoader; 47 class ResourceRequest; 48} 49 50typedef HashMap<RefPtr<WebCore::ResourceLoader>, RetainPtr<WebResource>> ResourceMap; 51 52class WebFrameLoaderClient : public WebCore::FrameLoaderClient { 53public: 54 WebFrameLoaderClient(WebFrame* = 0); 55 56 void setWebFrame(WebFrame* webFrame) { m_webFrame = webFrame; } 57 WebFrame* webFrame() const { return m_webFrame.get(); } 58 59private: 60 virtual void frameLoaderDestroyed() override; 61 virtual bool hasWebView() const override; // mainly for assertions 62 63 virtual void makeRepresentation(WebCore::DocumentLoader*) override; 64 virtual bool hasHTMLView() const override; 65#if PLATFORM(IOS) 66 virtual bool forceLayoutOnRestoreFromPageCache() override; 67#endif 68 virtual void forceLayoutForNonHTML() override; 69 70 virtual void setCopiesOnScroll() override; 71 72 virtual void detachedFromParent2() override; 73 virtual void detachedFromParent3() override; 74 75 virtual void convertMainResourceLoadToDownload(WebCore::DocumentLoader*, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&) override; 76 77 virtual void assignIdentifierToInitialRequest(unsigned long identifier, WebCore::DocumentLoader*, const WebCore::ResourceRequest&) override; 78 79 virtual void dispatchWillSendRequest(WebCore::DocumentLoader*, unsigned long identifier, WebCore::ResourceRequest&, const WebCore::ResourceResponse& redirectResponse) override; 80 virtual bool shouldUseCredentialStorage(WebCore::DocumentLoader*, unsigned long identifier) override; 81 virtual void dispatchDidReceiveAuthenticationChallenge(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::AuthenticationChallenge&) override; 82 virtual void dispatchDidCancelAuthenticationChallenge(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::AuthenticationChallenge&) override; 83#if USE(PROTECTION_SPACE_AUTH_CALLBACK) 84 virtual bool canAuthenticateAgainstProtectionSpace(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ProtectionSpace&) override; 85#endif 86 87#if PLATFORM(IOS) 88 virtual RetainPtr<CFDictionaryRef> connectionProperties(WebCore::DocumentLoader*, unsigned long identifier) override; 89#endif 90 91 virtual void dispatchDidReceiveResponse(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ResourceResponse&) override; 92 virtual void dispatchDidReceiveContentLength(WebCore::DocumentLoader*, unsigned long identifier, int dataLength) override; 93 virtual void dispatchDidFinishLoading(WebCore::DocumentLoader*, unsigned long identifier) override; 94 virtual void dispatchDidFailLoading(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ResourceError&) override; 95 96 virtual NSCachedURLResponse* willCacheResponse(WebCore::DocumentLoader*, unsigned long identifier, NSCachedURLResponse*) const override; 97 98 virtual void dispatchDidHandleOnloadEvents() override; 99 virtual void dispatchDidReceiveServerRedirectForProvisionalLoad() override; 100 virtual void dispatchDidCancelClientRedirect() override; 101 virtual void dispatchWillPerformClientRedirect(const WebCore::URL&, double interval, double fireDate) override; 102 virtual void dispatchDidChangeLocationWithinPage() override; 103 virtual void dispatchDidPushStateWithinPage() override; 104 virtual void dispatchDidReplaceStateWithinPage() override; 105 virtual void dispatchDidPopStateWithinPage() override; 106 107 virtual void dispatchWillClose() override; 108 virtual void dispatchDidReceiveIcon() override; 109 virtual void dispatchDidStartProvisionalLoad() override; 110 virtual void dispatchDidReceiveTitle(const WebCore::StringWithDirection&) override; 111 virtual void dispatchDidChangeIcons(WebCore::IconType) override; 112 virtual void dispatchDidCommitLoad() override; 113 virtual void dispatchDidFailProvisionalLoad(const WebCore::ResourceError&) override; 114 virtual void dispatchDidFailLoad(const WebCore::ResourceError&) override; 115 virtual void dispatchDidFinishDocumentLoad() override; 116 virtual void dispatchDidFinishLoad() override; 117 virtual void dispatchDidLayout(WebCore::LayoutMilestones) override; 118 119 virtual WebCore::Frame* dispatchCreatePage(const WebCore::NavigationAction&) override; 120 virtual void dispatchShow() override; 121 122 virtual void dispatchDecidePolicyForResponse(const WebCore::ResourceResponse&, const WebCore::ResourceRequest&, WebCore::FramePolicyFunction); 123 virtual void dispatchDecidePolicyForNewWindowAction(const WebCore::NavigationAction&, const WebCore::ResourceRequest&, PassRefPtr<WebCore::FormState>, const WTF::String& frameName, WebCore::FramePolicyFunction) override; 124 virtual void dispatchDecidePolicyForNavigationAction(const WebCore::NavigationAction&, const WebCore::ResourceRequest&, PassRefPtr<WebCore::FormState>, WebCore::FramePolicyFunction) override; 125 virtual void cancelPolicyCheck() override; 126 127 virtual void dispatchUnableToImplementPolicy(const WebCore::ResourceError&) override; 128 129 virtual void dispatchWillSendSubmitEvent(PassRefPtr<WebCore::FormState>) override; 130 virtual void dispatchWillSubmitForm(PassRefPtr<WebCore::FormState>, WebCore::FramePolicyFunction) override; 131 132 virtual void revertToProvisionalState(WebCore::DocumentLoader*) override; 133 virtual void setMainDocumentError(WebCore::DocumentLoader*, const WebCore::ResourceError&) override; 134 virtual bool dispatchDidLoadResourceFromMemoryCache(WebCore::DocumentLoader*, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&, int length) override; 135 136 virtual void setMainFrameDocumentReady(bool) override; 137 138 virtual void startDownload(const WebCore::ResourceRequest&, const String& suggestedName = String()) override; 139 140 virtual void willChangeTitle(WebCore::DocumentLoader*) override; 141 virtual void didChangeTitle(WebCore::DocumentLoader*) override; 142 143 virtual void committedLoad(WebCore::DocumentLoader*, const char*, int) override; 144 virtual void finishedLoading(WebCore::DocumentLoader*) override; 145 virtual void updateGlobalHistory() override; 146 virtual void updateGlobalHistoryRedirectLinks() override; 147 148 virtual bool shouldGoToHistoryItem(WebCore::HistoryItem*) const override; 149 virtual void updateGlobalHistoryItemForPage() override; 150 151 virtual void didDisplayInsecureContent() override; 152 virtual void didRunInsecureContent(WebCore::SecurityOrigin*, const WebCore::URL&) override; 153 virtual void didDetectXSS(const WebCore::URL&, bool didBlockEntirePage) override; 154 155 virtual WebCore::ResourceError cancelledError(const WebCore::ResourceRequest&) override; 156 virtual WebCore::ResourceError blockedError(const WebCore::ResourceRequest&) override; 157 virtual WebCore::ResourceError cannotShowURLError(const WebCore::ResourceRequest&) override; 158 virtual WebCore::ResourceError interruptedForPolicyChangeError(const WebCore::ResourceRequest&) override; 159 160 virtual WebCore::ResourceError cannotShowMIMETypeError(const WebCore::ResourceResponse&) override; 161 virtual WebCore::ResourceError fileDoesNotExistError(const WebCore::ResourceResponse&) override; 162 virtual WebCore::ResourceError pluginWillHandleLoadError(const WebCore::ResourceResponse&) override; 163 164 virtual bool shouldFallBack(const WebCore::ResourceError&) override; 165 166 virtual WTF::String userAgent(const WebCore::URL&) override; 167 168 virtual void savePlatformDataToCachedFrame(WebCore::CachedFrame*) override; 169 virtual void transitionToCommittedFromCachedFrame(WebCore::CachedFrame*) override; 170#if PLATFORM(IOS) 171 virtual void didRestoreFrameHierarchyForCachedFrame() override; 172#endif 173 virtual void transitionToCommittedForNewPage() override; 174 175 virtual void didSaveToPageCache() override; 176 virtual void didRestoreFromPageCache() override; 177 178 virtual void dispatchDidBecomeFrameset(bool) override; 179 180 virtual bool canHandleRequest(const WebCore::ResourceRequest&) const override; 181 virtual bool canShowMIMEType(const WTF::String& MIMEType) const override; 182 virtual bool canShowMIMETypeAsHTML(const WTF::String& MIMEType) const override; 183 virtual bool representationExistsForURLScheme(const WTF::String& URLScheme) const override; 184 virtual WTF::String generatedMIMETypeForURLScheme(const WTF::String& URLScheme) const override; 185 186 virtual void frameLoadCompleted() override; 187 virtual void saveViewStateToItem(WebCore::HistoryItem*) override; 188 virtual void restoreViewState() override; 189 virtual void provisionalLoadStarted() override; 190 virtual void didFinishLoad() override; 191 virtual void prepareForDataSourceReplacement() override; 192 virtual PassRefPtr<WebCore::DocumentLoader> createDocumentLoader(const WebCore::ResourceRequest&, const WebCore::SubstituteData&) override; 193 194 virtual void setTitle(const WebCore::StringWithDirection&, const WebCore::URL&) override; 195 196 virtual PassRefPtr<WebCore::Frame> createFrame(const WebCore::URL& url, const WTF::String& name, WebCore::HTMLFrameOwnerElement*, 197 const WTF::String& referrer, bool allowsScrolling, int marginWidth, int marginHeight) override; 198 virtual PassRefPtr<WebCore::Widget> createPlugin(const WebCore::IntSize&, WebCore::HTMLPlugInElement*, const WebCore::URL&, const Vector<WTF::String>&, 199 const Vector<WTF::String>&, const WTF::String&, bool) override; 200 virtual void recreatePlugin(WebCore::Widget*) override; 201 virtual void redirectDataToPlugin(WebCore::Widget* pluginWidget) override; 202 203#if ENABLE(WEBGL) 204 virtual WebCore::WebGLLoadPolicy webGLPolicyForURL(const String&) const override; 205 virtual WebCore::WebGLLoadPolicy resolveWebGLPolicyForURL(const String&) const override; 206#endif // ENABLE(WEBGL) 207 208 virtual PassRefPtr<WebCore::Widget> createJavaAppletWidget(const WebCore::IntSize&, WebCore::HTMLAppletElement*, const WebCore::URL& baseURL, 209 const Vector<WTF::String>& paramNames, const Vector<WTF::String>& paramValues) override; 210 211 virtual WebCore::ObjectContentType objectContentType(const WebCore::URL&, const WTF::String& mimeType, bool shouldPreferPlugInsForImages) override; 212 virtual WTF::String overrideMediaType() const override; 213 214 virtual void dispatchDidClearWindowObjectInWorld(WebCore::DOMWrapperWorld&) override; 215 216 virtual void registerForIconNotification(bool listen) override; 217 218#if PLATFORM(IOS) 219 virtual bool shouldLoadMediaElementURL(const WebCore::URL&) const override; 220#endif 221 222 virtual RemoteAXObjectRef accessibilityRemoteObject() override { return 0; } 223 224 RetainPtr<WebFramePolicyListener> setUpPolicyListener(WebCore::FramePolicyFunction); 225 226 NSDictionary *actionDictionary(const WebCore::NavigationAction&, PassRefPtr<WebCore::FormState>) const; 227 228 virtual bool canCachePage() const; 229 230 virtual PassRefPtr<WebCore::FrameNetworkingContext> createNetworkingContext(); 231 232 virtual bool shouldPaintBrokenImage(const WebCore::URL&) const; 233 234#if USE(QUICK_LOOK) 235 virtual void didCreateQuickLookHandle(WebCore::QuickLookHandle&) override; 236#endif 237 238 virtual void contentFilterDidBlockLoad(std::unique_ptr<WebCore::ContentFilter>) override; 239 240 RetainPtr<WebFrame> m_webFrame; 241 242 RetainPtr<WebFramePolicyListener> m_policyListener; 243}; 244