bfbd2f7836f648b8070ac743f2eac836a5c96912
[WebKit-https.git] / Source / WebKit / mac / WebCoreSupport / WebFrameLoaderClient.h
1 /*
2  * Copyright (C) 2006-2017 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
41 namespace WebCore {
42 class AuthenticationChallenge;
43 class CachedFrame;
44 class HistoryItem;
45 class ProtectionSpace;
46 class ResourceLoader;
47 class ResourceRequest;
48 class SessionID;
49 }
50
51 typedef HashMap<RefPtr<WebCore::ResourceLoader>, RetainPtr<WebResource>> ResourceMap;
52
53 class WebFrameLoaderClient : public WebCore::FrameLoaderClient {
54 public:
55     WebFrameLoaderClient(WebFrame* = 0);
56
57     void setWebFrame(WebFrame* webFrame) { m_webFrame = webFrame; }
58     WebFrame* webFrame() const { return m_webFrame.get(); }
59
60 private:
61     void frameLoaderDestroyed() final;
62     bool hasWebView() const final; // mainly for assertions
63
64     void makeRepresentation(WebCore::DocumentLoader*) final;
65     bool hasHTMLView() const final;
66 #if PLATFORM(IOS)
67     bool forceLayoutOnRestoreFromPageCache() final;
68 #endif
69     void forceLayoutForNonHTML() final;
70
71     void setCopiesOnScroll() final;
72
73     void detachedFromParent2() final;
74     void detachedFromParent3() final;
75
76     void convertMainResourceLoadToDownload(WebCore::DocumentLoader*, WebCore::SessionID, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&) final;
77
78     void assignIdentifierToInitialRequest(unsigned long identifier, WebCore::DocumentLoader*, const WebCore::ResourceRequest&) final;
79
80     void dispatchWillSendRequest(WebCore::DocumentLoader*, unsigned long identifier, WebCore::ResourceRequest&, const WebCore::ResourceResponse& redirectResponse) final;
81     bool shouldUseCredentialStorage(WebCore::DocumentLoader*, unsigned long identifier) final;
82     void dispatchDidReceiveAuthenticationChallenge(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::AuthenticationChallenge&) final;
83 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
84     bool canAuthenticateAgainstProtectionSpace(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ProtectionSpace&) final;
85 #endif
86
87 #if PLATFORM(IOS)
88     RetainPtr<CFDictionaryRef> connectionProperties(WebCore::DocumentLoader*, unsigned long identifier) final;
89 #endif
90
91     void dispatchDidReceiveResponse(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ResourceResponse&) final;
92     void dispatchDidReceiveContentLength(WebCore::DocumentLoader*, unsigned long identifier, int dataLength) final;
93     void dispatchDidFinishLoading(WebCore::DocumentLoader*, unsigned long identifier) final;
94 #if ENABLE(DATA_DETECTION)
95     void dispatchDidFinishDataDetection(NSArray *detectionResults) final;
96 #endif
97     void dispatchDidFailLoading(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ResourceError&) final;
98
99     NSCachedURLResponse* willCacheResponse(WebCore::DocumentLoader*, unsigned long identifier, NSCachedURLResponse*) const final;
100
101     void dispatchDidDispatchOnloadEvents() final;
102     void dispatchDidReceiveServerRedirectForProvisionalLoad() final;
103     void dispatchDidCancelClientRedirect() final;
104     void dispatchWillPerformClientRedirect(const WebCore::URL&, double interval, double fireDate) final;
105     void dispatchDidChangeLocationWithinPage() final;
106     void dispatchDidPushStateWithinPage() final;
107     void dispatchDidReplaceStateWithinPage() final;
108     void dispatchDidPopStateWithinPage() final;
109     
110     void dispatchWillClose() final;
111     void dispatchDidReceiveIcon() final;
112     void dispatchDidStartProvisionalLoad() final;
113     void dispatchDidReceiveTitle(const WebCore::StringWithDirection&) final;
114     void dispatchDidCommitLoad(std::optional<WebCore::HasInsecureContent>) final;
115     void dispatchDidFailProvisionalLoad(const WebCore::ResourceError&) final;
116     void dispatchDidFailLoad(const WebCore::ResourceError&) final;
117     void dispatchDidFinishDocumentLoad() final;
118     void dispatchDidFinishLoad() final;
119     void dispatchDidReachLayoutMilestone(WebCore::LayoutMilestones) final;
120
121     WebCore::Frame* dispatchCreatePage(const WebCore::NavigationAction&) final;
122     void dispatchShow() final;
123
124     void dispatchDecidePolicyForResponse(const WebCore::ResourceResponse&, const WebCore::ResourceRequest&, WebCore::FramePolicyFunction) final;
125     void dispatchDecidePolicyForNewWindowAction(const WebCore::NavigationAction&, const WebCore::ResourceRequest&, WebCore::FormState*, const WTF::String& frameName, WebCore::FramePolicyFunction) final;
126     void dispatchDecidePolicyForNavigationAction(const WebCore::NavigationAction&, const WebCore::ResourceRequest&, WebCore::FormState*, WebCore::FramePolicyFunction) final;
127     void cancelPolicyCheck() final;
128
129     void dispatchUnableToImplementPolicy(const WebCore::ResourceError&) final;
130
131     void dispatchWillSendSubmitEvent(Ref<WebCore::FormState>&&) final;
132     void dispatchWillSubmitForm(WebCore::FormState&, WebCore::FramePolicyFunction) final;
133
134     void revertToProvisionalState(WebCore::DocumentLoader*) final;
135     void setMainDocumentError(WebCore::DocumentLoader*, const WebCore::ResourceError&) final;
136     bool dispatchDidLoadResourceFromMemoryCache(WebCore::DocumentLoader*, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&, int length) final;
137
138     void setMainFrameDocumentReady(bool) final;
139
140     void startDownload(const WebCore::ResourceRequest&, const String& suggestedName = String()) final;
141
142     void willChangeTitle(WebCore::DocumentLoader*) final;
143     void didChangeTitle(WebCore::DocumentLoader*) final;
144
145     void willReplaceMultipartContent() final { }
146     void didReplaceMultipartContent() final;
147
148     void committedLoad(WebCore::DocumentLoader*, const char*, int) final;
149     void finishedLoading(WebCore::DocumentLoader*) final;
150     void updateGlobalHistory() final;
151     void updateGlobalHistoryRedirectLinks() final;
152
153     bool shouldGoToHistoryItem(WebCore::HistoryItem*) const final;
154     void updateGlobalHistoryItemForPage() final;
155
156     void didDisplayInsecureContent() final;
157     void didRunInsecureContent(WebCore::SecurityOrigin*, const WebCore::URL&) final;
158     void didDetectXSS(const WebCore::URL&, bool didBlockEntirePage) final;
159
160     WebCore::ResourceError cancelledError(const WebCore::ResourceRequest&) final;
161     WebCore::ResourceError blockedError(const WebCore::ResourceRequest&) final;
162     WebCore::ResourceError blockedByContentBlockerError(const WebCore::ResourceRequest&) final;
163     WebCore::ResourceError cannotShowURLError(const WebCore::ResourceRequest&) final;
164     WebCore::ResourceError interruptedForPolicyChangeError(const WebCore::ResourceRequest&) final;
165 #if ENABLE(CONTENT_FILTERING)
166     WebCore::ResourceError blockedByContentFilterError(const WebCore::ResourceRequest&) final;
167 #endif
168
169     WebCore::ResourceError cannotShowMIMETypeError(const WebCore::ResourceResponse&) final;
170     WebCore::ResourceError fileDoesNotExistError(const WebCore::ResourceResponse&) final;
171     WebCore::ResourceError pluginWillHandleLoadError(const WebCore::ResourceResponse&) final;
172
173     bool shouldFallBack(const WebCore::ResourceError&) final;
174
175     WTF::String userAgent(const WebCore::URL&) final;
176     
177     void savePlatformDataToCachedFrame(WebCore::CachedFrame*) final;
178     void transitionToCommittedFromCachedFrame(WebCore::CachedFrame*) final;
179 #if PLATFORM(IOS)
180     void didRestoreFrameHierarchyForCachedFrame() final;
181 #endif
182     void transitionToCommittedForNewPage() final;
183
184     void didSaveToPageCache() final;
185     void didRestoreFromPageCache() final;
186
187     void dispatchDidBecomeFrameset(bool) final;
188
189     bool canHandleRequest(const WebCore::ResourceRequest&) const final;
190     bool canShowMIMEType(const WTF::String& MIMEType) const final;
191     bool canShowMIMETypeAsHTML(const WTF::String& MIMEType) const final;
192     bool representationExistsForURLScheme(const WTF::String& URLScheme) const final;
193     WTF::String generatedMIMETypeForURLScheme(const WTF::String& URLScheme) const final;
194
195     void frameLoadCompleted() final;
196     void saveViewStateToItem(WebCore::HistoryItem&) final;
197     void restoreViewState() final;
198     void provisionalLoadStarted() final;
199     void didFinishLoad() final;
200     void prepareForDataSourceReplacement() final;
201     Ref<WebCore::DocumentLoader> createDocumentLoader(const WebCore::ResourceRequest&, const WebCore::SubstituteData&) final;
202     void updateCachedDocumentLoader(WebCore::DocumentLoader&) final { }
203
204     void setTitle(const WebCore::StringWithDirection&, const WebCore::URL&) final;
205
206     RefPtr<WebCore::Frame> createFrame(const WebCore::URL&, const WTF::String& name, WebCore::HTMLFrameOwnerElement&,
207         const WTF::String& referrer, bool allowsScrolling, int marginWidth, int marginHeight) final;
208     RefPtr<WebCore::Widget> createPlugin(const WebCore::IntSize&, WebCore::HTMLPlugInElement&, const WebCore::URL&,
209         const Vector<WTF::String>&, const Vector<WTF::String>&, const WTF::String&, bool) final;
210     void recreatePlugin(WebCore::Widget*) final;
211     void redirectDataToPlugin(WebCore::Widget* pluginWidget) final;
212
213 #if ENABLE(WEBGL)
214     WebCore::WebGLLoadPolicy webGLPolicyForURL(const String&) const final;
215     WebCore::WebGLLoadPolicy resolveWebGLPolicyForURL(const String&) const final;
216 #endif
217
218     RefPtr<WebCore::Widget> createJavaAppletWidget(const WebCore::IntSize&, WebCore::HTMLAppletElement&, const WebCore::URL& baseURL,
219         const Vector<WTF::String>& paramNames, const Vector<WTF::String>& paramValues) final;
220     
221     WebCore::ObjectContentType objectContentType(const WebCore::URL&, const WTF::String& mimeType) final;
222     WTF::String overrideMediaType() const final;
223     
224     void dispatchDidClearWindowObjectInWorld(WebCore::DOMWrapperWorld&) final;
225
226     void registerForIconNotification(bool listen) final;
227
228 #if PLATFORM(IOS)
229     bool shouldLoadMediaElementURL(const WebCore::URL&) const final;
230 #endif
231
232     RemoteAXObjectRef accessibilityRemoteObject() final { return 0; }
233     
234     RetainPtr<WebFramePolicyListener> setUpPolicyListener(WebCore::FramePolicyFunction, NSURL *appLinkURL = nil);
235
236     NSDictionary *actionDictionary(const WebCore::NavigationAction&, WebCore::FormState*) const;
237     
238     bool canCachePage() const final;
239
240     Ref<WebCore::FrameNetworkingContext> createNetworkingContext() final;
241
242 #if ENABLE(REQUEST_AUTOCOMPLETE)
243     void didRequestAutocomplete(Ref<WebCore::FormState>&&) final { }
244 #endif
245
246     bool shouldPaintBrokenImage(const WebCore::URL&) const final;
247
248 #if USE(QUICK_LOOK)
249     void didCreateQuickLookHandle(WebCore::QuickLookHandle&) final;
250 #endif
251
252 #if ENABLE(CONTENT_FILTERING)
253     void contentFilterDidBlockLoad(WebCore::ContentFilterUnblockHandler) final;
254 #endif
255
256     void prefetchDNS(const String&) final;
257
258     RetainPtr<WebFrame> m_webFrame;
259
260     RetainPtr<WebFramePolicyListener> m_policyListener;
261 };