4e40e9e9eb7b7a5a3b3df3beb308e295ca055191
[WebKit-https.git] / Source / WebKit / WebProcess / WebCoreSupport / WebFrameLoaderClient.h
1 /*
2  * Copyright (C) 2010-2016 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include <WebCore/FrameLoaderClient.h>
29
30 namespace PAL {
31 class SessionID;
32 }
33
34 namespace WebKit {
35
36 class PluginView;
37 class WebFrame;
38     
39 class WebFrameLoaderClient final : public WebCore::FrameLoaderClient {
40 public:
41     WebFrameLoaderClient();
42     ~WebFrameLoaderClient();
43
44     void setWebFrame(WebFrame* webFrame) { m_frame = webFrame; }
45     WebFrame* webFrame() const { return m_frame; }
46
47     bool frameHasCustomContentProvider() const { return m_frameHasCustomContentProvider; }
48
49     void setUseIconLoadingClient(bool useIconLoadingClient) { m_useIconLoadingClient = useIconLoadingClient; }
50
51 private:
52     void frameLoaderDestroyed() final;
53
54     bool hasHTMLView() const final;
55     bool hasWebView() const final;
56     
57     void makeRepresentation(WebCore::DocumentLoader*) final;
58 #if PLATFORM(IOS)
59     bool forceLayoutOnRestoreFromPageCache() final;
60 #endif
61     void forceLayoutForNonHTML() final;
62     
63     void setCopiesOnScroll() final;
64     
65     void detachedFromParent2() final;
66     void detachedFromParent3() final;
67     
68     void assignIdentifierToInitialRequest(unsigned long identifier, WebCore::DocumentLoader*, const WebCore::ResourceRequest&) final;
69     
70     void dispatchWillSendRequest(WebCore::DocumentLoader*, unsigned long identifier, WebCore::ResourceRequest&, const WebCore::ResourceResponse& redirectResponse) final;
71     bool shouldUseCredentialStorage(WebCore::DocumentLoader*, unsigned long identifier) final;
72     void dispatchDidReceiveAuthenticationChallenge(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::AuthenticationChallenge&) final;
73 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
74     bool canAuthenticateAgainstProtectionSpace(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ProtectionSpace&) final;
75 #endif
76 #if PLATFORM(IOS)
77     RetainPtr<CFDictionaryRef> connectionProperties(WebCore::DocumentLoader*, unsigned long identifier) final;
78 #endif
79     void dispatchDidReceiveResponse(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ResourceResponse&) final;
80     void dispatchDidReceiveContentLength(WebCore::DocumentLoader*, unsigned long identifier, int dataLength) final;
81     void dispatchDidFinishLoading(WebCore::DocumentLoader*, unsigned long identifier) final;
82     void dispatchDidFailLoading(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ResourceError&) final;
83     bool dispatchDidLoadResourceFromMemoryCache(WebCore::DocumentLoader*, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&, int length) final;
84 #if ENABLE(DATA_DETECTION)
85     void dispatchDidFinishDataDetection(NSArray *detectionResults) final;
86 #endif
87     void dispatchDidChangeMainDocument() final;
88
89     void dispatchDidDispatchOnloadEvents() final;
90     void dispatchDidReceiveServerRedirectForProvisionalLoad() final;
91     void dispatchDidChangeProvisionalURL() final;
92     void dispatchDidCancelClientRedirect() final;
93     void dispatchWillPerformClientRedirect(const WebCore::URL&, double interval, double fireDate) final;
94     void dispatchDidChangeLocationWithinPage() final;
95     void dispatchDidPushStateWithinPage() final;
96     void dispatchDidReplaceStateWithinPage() final;
97     void dispatchDidPopStateWithinPage() final;
98     void dispatchWillClose() final;
99     void dispatchDidStartProvisionalLoad() final;
100     void dispatchDidReceiveTitle(const WebCore::StringWithDirection&) final;
101     void dispatchDidCommitLoad(std::optional<WebCore::HasInsecureContent>) final;
102     void dispatchDidFailProvisionalLoad(const WebCore::ResourceError&) final;
103     void dispatchDidFailLoad(const WebCore::ResourceError&) final;
104     void dispatchDidFinishDocumentLoad() final;
105     void dispatchDidFinishLoad() final;
106
107     void dispatchDidReachLayoutMilestone(WebCore::LayoutMilestones) final;
108     void dispatchDidLayout() final;
109
110     WebCore::Frame* dispatchCreatePage(const WebCore::NavigationAction&) final;
111     void dispatchShow() final;
112     
113     void dispatchDecidePolicyForResponse(const WebCore::ResourceResponse&, const WebCore::ResourceRequest&, WebCore::FramePolicyFunction&&) final;
114     void dispatchDecidePolicyForNewWindowAction(const WebCore::NavigationAction&, const WebCore::ResourceRequest&, WebCore::FormState*, const String& frameName, WebCore::FramePolicyFunction&&) final;
115     void dispatchDecidePolicyForNavigationAction(const WebCore::NavigationAction&, const WebCore::ResourceRequest&, bool didReceiveRedirectResponse, WebCore::FormState*, WebCore::FramePolicyFunction&&) final;
116     void cancelPolicyCheck() final;
117     
118     void dispatchUnableToImplementPolicy(const WebCore::ResourceError&) final;
119     
120     void dispatchWillSendSubmitEvent(Ref<WebCore::FormState>&&) final;
121     void dispatchWillSubmitForm(WebCore::FormState&, WebCore::FramePolicyFunction&&) final;
122     
123     void revertToProvisionalState(WebCore::DocumentLoader*) final;
124     void setMainDocumentError(WebCore::DocumentLoader*, const WebCore::ResourceError&) final;
125     
126     void setMainFrameDocumentReady(bool) final;
127     
128     void startDownload(const WebCore::ResourceRequest&, const String& suggestedName = String()) final;
129     
130     void willChangeTitle(WebCore::DocumentLoader*) final;
131     void didChangeTitle(WebCore::DocumentLoader*) final;
132
133     void willReplaceMultipartContent() final;
134     void didReplaceMultipartContent() final;
135
136     void committedLoad(WebCore::DocumentLoader*, const char*, int) final;
137     void finishedLoading(WebCore::DocumentLoader*) final;
138     
139     void updateGlobalHistory() final;
140     void updateGlobalHistoryRedirectLinks() final;
141     
142     bool shouldGoToHistoryItem(WebCore::HistoryItem*) const final;
143
144     void didDisplayInsecureContent() final;
145     void didRunInsecureContent(WebCore::SecurityOrigin&, const WebCore::URL&) final;
146     void didDetectXSS(const WebCore::URL&, bool didBlockEntirePage) final;
147
148     WebCore::ResourceError cancelledError(const WebCore::ResourceRequest&) final;
149     WebCore::ResourceError blockedError(const WebCore::ResourceRequest&) final;
150     WebCore::ResourceError blockedByContentBlockerError(const WebCore::ResourceRequest&) final;
151     WebCore::ResourceError cannotShowURLError(const WebCore::ResourceRequest&) final;
152     WebCore::ResourceError interruptedForPolicyChangeError(const WebCore::ResourceRequest&) final;
153 #if ENABLE(CONTENT_FILTERING)
154     WebCore::ResourceError blockedByContentFilterError(const WebCore::ResourceRequest&) final;
155 #endif
156     
157     WebCore::ResourceError cannotShowMIMETypeError(const WebCore::ResourceResponse&) final;
158     WebCore::ResourceError fileDoesNotExistError(const WebCore::ResourceResponse&) final;
159     WebCore::ResourceError pluginWillHandleLoadError(const WebCore::ResourceResponse&) final;
160     
161     bool shouldFallBack(const WebCore::ResourceError&) final;
162     
163     bool canHandleRequest(const WebCore::ResourceRequest&) const final;
164     bool canShowMIMEType(const String& MIMEType) const final;
165     bool canShowMIMETypeAsHTML(const String& MIMEType) const final;
166     bool representationExistsForURLScheme(const String& URLScheme) const final;
167     String generatedMIMETypeForURLScheme(const String& URLScheme) const final;
168     
169     void frameLoadCompleted() final;
170     void saveViewStateToItem(WebCore::HistoryItem&) final;
171     void restoreViewState() final;
172     void provisionalLoadStarted() final;
173     void didFinishLoad() final;
174     void prepareForDataSourceReplacement() final;
175     
176     Ref<WebCore::DocumentLoader> createDocumentLoader(const WebCore::ResourceRequest&, const WebCore::SubstituteData&) final;
177     void updateCachedDocumentLoader(WebCore::DocumentLoader&) final;
178
179     void setTitle(const WebCore::StringWithDirection&, const WebCore::URL&) final;
180     
181     String userAgent(const WebCore::URL&) final;
182
183     String overrideContentSecurityPolicy() const final;
184
185     void savePlatformDataToCachedFrame(WebCore::CachedFrame*) final;
186     void transitionToCommittedFromCachedFrame(WebCore::CachedFrame*) final;
187 #if PLATFORM(IOS)
188     void didRestoreFrameHierarchyForCachedFrame() final;
189 #endif
190     void transitionToCommittedForNewPage() final;
191
192     void didSaveToPageCache() final;
193     void didRestoreFromPageCache() final;
194
195     void dispatchDidBecomeFrameset(bool) final;
196
197     bool canCachePage() const final;
198     void convertMainResourceLoadToDownload(WebCore::DocumentLoader*, PAL::SessionID, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&) final;
199
200     RefPtr<WebCore::Frame> createFrame(const WebCore::URL&, const String& name, WebCore::HTMLFrameOwnerElement&, const String& referrer, bool allowsScrolling, int marginWidth, int marginHeight) final;
201
202     RefPtr<WebCore::Widget> createPlugin(const WebCore::IntSize&, WebCore::HTMLPlugInElement&, const WebCore::URL&, const Vector<String>&, const Vector<String>&, const String&, bool loadManually) final;
203     void recreatePlugin(WebCore::Widget*) final;
204     void redirectDataToPlugin(WebCore::Widget&) final;
205     
206 #if ENABLE(WEBGL)
207     WebCore::WebGLLoadPolicy webGLPolicyForURL(const String&) const final;
208     WebCore::WebGLLoadPolicy resolveWebGLPolicyForURL(const String&) const final;
209 #endif // ENABLE(WEBGL)
210
211     RefPtr<WebCore::Widget> createJavaAppletWidget(const WebCore::IntSize&, WebCore::HTMLAppletElement&, const WebCore::URL& baseURL, const Vector<String>& paramNames, const Vector<String>& paramValues) final;
212     
213     WebCore::ObjectContentType objectContentType(const WebCore::URL&, const String& mimeType) final;
214     String overrideMediaType() const final;
215
216     void dispatchDidClearWindowObjectInWorld(WebCore::DOMWrapperWorld&) final;
217     
218     void dispatchGlobalObjectAvailable(WebCore::DOMWrapperWorld&) final;
219     void dispatchWillDisconnectDOMWindowExtensionFromGlobalObject(WebCore::DOMWindowExtension*) final;
220     void dispatchDidReconnectDOMWindowExtensionToGlobalObject(WebCore::DOMWindowExtension*) final;
221     void dispatchWillDestroyGlobalObjectForDOMWindowExtension(WebCore::DOMWindowExtension*) final;
222     
223 #if PLATFORM(COCOA)
224     RemoteAXObjectRef accessibilityRemoteObject() final;
225     
226     NSCachedURLResponse* willCacheResponse(WebCore::DocumentLoader*, unsigned long identifier, NSCachedURLResponse*) const final;
227
228     NSDictionary *dataDetectionContext() final;
229 #endif
230
231     bool shouldAlwaysUsePluginDocument(const String& /*mimeType*/) const final;
232
233     void didChangeScrollOffset() final;
234
235     bool allowScript(bool enabledPerSettings) final;
236
237     bool shouldForceUniversalAccessFromLocalURL(const WebCore::URL&) final;
238
239     Ref<WebCore::FrameNetworkingContext> createNetworkingContext() final;
240
241     void forcePageTransitionIfNeeded() final;
242
243 #if USE(QUICK_LOOK)
244     RefPtr<WebCore::PreviewLoaderClient> createPreviewLoaderClient(const String& fileName, const String& uti) final;
245 #endif
246
247 #if ENABLE(CONTENT_FILTERING)
248     void contentFilterDidBlockLoad(WebCore::ContentFilterUnblockHandler) final;
249 #endif
250
251     void prefetchDNS(const String&) final;
252
253     void didRestoreScrollPosition() final;
254
255     void getLoadDecisionForIcons(const Vector<std::pair<WebCore::LinkIcon&, uint64_t>>&) final;
256     void finishedLoadingIcon(uint64_t callbackIdentifier, WebCore::SharedBuffer*) final;
257
258     WebFrame* m_frame;
259     RefPtr<PluginView> m_pluginView;
260     bool m_hasSentResponseToPluginView;
261     bool m_didCompletePageTransition;
262     bool m_frameHasCustomContentProvider;
263     bool m_frameCameFromPageCache;
264     bool m_useIconLoadingClient { false };
265 };
266
267 // As long as EmptyFrameLoaderClient exists in WebCore, this can return 0.
268 inline WebFrameLoaderClient* toWebFrameLoaderClient(WebCore::FrameLoaderClient& client)
269 {
270     return client.isEmptyFrameLoaderClient() ? 0 : static_cast<WebFrameLoaderClient*>(&client);
271 }
272
273 } // namespace WebKit