Get rid of WebCore IconDatabase code.
[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 WebCore {
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 dispatchDidPerformClientRedirect() final;
92     void dispatchDidChangeProvisionalURL() final;
93     void dispatchDidCancelClientRedirect() final;
94     void dispatchWillPerformClientRedirect(const WebCore::URL&, double interval, double fireDate) final;
95     void dispatchDidChangeLocationWithinPage() final;
96     void dispatchDidPushStateWithinPage() final;
97     void dispatchDidReplaceStateWithinPage() final;
98     void dispatchDidPopStateWithinPage() final;
99     void dispatchWillClose() final;
100     void dispatchDidStartProvisionalLoad() final;
101     void dispatchDidReceiveTitle(const WebCore::StringWithDirection&) final;
102     void dispatchDidCommitLoad(std::optional<WebCore::HasInsecureContent>) final;
103     void dispatchDidFailProvisionalLoad(const WebCore::ResourceError&) final;
104     void dispatchDidFailLoad(const WebCore::ResourceError&) final;
105     void dispatchDidFinishDocumentLoad() final;
106     void dispatchDidFinishLoad() final;
107
108     void dispatchDidReachLayoutMilestone(WebCore::LayoutMilestones) final;
109     void dispatchDidLayout() final;
110
111     WebCore::Frame* dispatchCreatePage(const WebCore::NavigationAction&) final;
112     void dispatchShow() final;
113     
114     void dispatchDecidePolicyForResponse(const WebCore::ResourceResponse&, const WebCore::ResourceRequest&, WebCore::FramePolicyFunction&&) final;
115     void dispatchDecidePolicyForNewWindowAction(const WebCore::NavigationAction&, const WebCore::ResourceRequest&, WebCore::FormState*, const String& frameName, WebCore::FramePolicyFunction&&) final;
116     void dispatchDecidePolicyForNavigationAction(const WebCore::NavigationAction&, const WebCore::ResourceRequest&, WebCore::FormState*, WebCore::FramePolicyFunction&&) final;
117     void cancelPolicyCheck() final;
118     
119     void dispatchUnableToImplementPolicy(const WebCore::ResourceError&) final;
120     
121     void dispatchWillSendSubmitEvent(Ref<WebCore::FormState>&&) final;
122     void dispatchWillSubmitForm(WebCore::FormState&, WebCore::FramePolicyFunction&&) final;
123     
124     void revertToProvisionalState(WebCore::DocumentLoader*) final;
125     void setMainDocumentError(WebCore::DocumentLoader*, const WebCore::ResourceError&) final;
126     
127     void setMainFrameDocumentReady(bool) final;
128     
129     void startDownload(const WebCore::ResourceRequest&, const String& suggestedName = String()) final;
130     
131     void willChangeTitle(WebCore::DocumentLoader*) final;
132     void didChangeTitle(WebCore::DocumentLoader*) final;
133
134     void willReplaceMultipartContent() final;
135     void didReplaceMultipartContent() final;
136
137     void committedLoad(WebCore::DocumentLoader*, const char*, int) final;
138     void finishedLoading(WebCore::DocumentLoader*) final;
139     
140     void updateGlobalHistory() final;
141     void updateGlobalHistoryRedirectLinks() final;
142     
143     bool shouldGoToHistoryItem(WebCore::HistoryItem*) const final;
144
145     void didDisplayInsecureContent() final;
146     void didRunInsecureContent(WebCore::SecurityOrigin&, const WebCore::URL&) final;
147     void didDetectXSS(const WebCore::URL&, bool didBlockEntirePage) final;
148
149     WebCore::ResourceError cancelledError(const WebCore::ResourceRequest&) final;
150     WebCore::ResourceError blockedError(const WebCore::ResourceRequest&) final;
151     WebCore::ResourceError blockedByContentBlockerError(const WebCore::ResourceRequest&) final;
152     WebCore::ResourceError cannotShowURLError(const WebCore::ResourceRequest&) final;
153     WebCore::ResourceError interruptedForPolicyChangeError(const WebCore::ResourceRequest&) final;
154 #if ENABLE(CONTENT_FILTERING)
155     WebCore::ResourceError blockedByContentFilterError(const WebCore::ResourceRequest&) final;
156 #endif
157     
158     WebCore::ResourceError cannotShowMIMETypeError(const WebCore::ResourceResponse&) final;
159     WebCore::ResourceError fileDoesNotExistError(const WebCore::ResourceResponse&) final;
160     WebCore::ResourceError pluginWillHandleLoadError(const WebCore::ResourceResponse&) final;
161     
162     bool shouldFallBack(const WebCore::ResourceError&) final;
163     
164     bool canHandleRequest(const WebCore::ResourceRequest&) const final;
165     bool canShowMIMEType(const String& MIMEType) const final;
166     bool canShowMIMETypeAsHTML(const String& MIMEType) const final;
167     bool representationExistsForURLScheme(const String& URLScheme) const final;
168     String generatedMIMETypeForURLScheme(const String& URLScheme) const final;
169     
170     void frameLoadCompleted() final;
171     void saveViewStateToItem(WebCore::HistoryItem&) final;
172     void restoreViewState() final;
173     void provisionalLoadStarted() final;
174     void didFinishLoad() final;
175     void prepareForDataSourceReplacement() final;
176     
177     Ref<WebCore::DocumentLoader> createDocumentLoader(const WebCore::ResourceRequest&, const WebCore::SubstituteData&) final;
178     void updateCachedDocumentLoader(WebCore::DocumentLoader&) final;
179
180     void setTitle(const WebCore::StringWithDirection&, const WebCore::URL&) final;
181     
182     String userAgent(const WebCore::URL&) final;
183
184     String overrideContentSecurityPolicy() const final;
185
186     void savePlatformDataToCachedFrame(WebCore::CachedFrame*) final;
187     void transitionToCommittedFromCachedFrame(WebCore::CachedFrame*) final;
188 #if PLATFORM(IOS)
189     void didRestoreFrameHierarchyForCachedFrame() final;
190 #endif
191     void transitionToCommittedForNewPage() final;
192
193     void didSaveToPageCache() final;
194     void didRestoreFromPageCache() final;
195
196     void dispatchDidBecomeFrameset(bool) final;
197
198     bool canCachePage() const final;
199     void convertMainResourceLoadToDownload(WebCore::DocumentLoader*, WebCore::SessionID, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&) final;
200
201     RefPtr<WebCore::Frame> createFrame(const WebCore::URL&, const String& name, WebCore::HTMLFrameOwnerElement&, const String& referrer, bool allowsScrolling, int marginWidth, int marginHeight) final;
202
203     RefPtr<WebCore::Widget> createPlugin(const WebCore::IntSize&, WebCore::HTMLPlugInElement&, const WebCore::URL&, const Vector<String>&, const Vector<String>&, const String&, bool loadManually) final;
204     void recreatePlugin(WebCore::Widget*) final;
205     void redirectDataToPlugin(WebCore::Widget&) final;
206     
207 #if ENABLE(WEBGL)
208     WebCore::WebGLLoadPolicy webGLPolicyForURL(const String&) const final;
209     WebCore::WebGLLoadPolicy resolveWebGLPolicyForURL(const String&) const final;
210 #endif // ENABLE(WEBGL)
211
212     RefPtr<WebCore::Widget> createJavaAppletWidget(const WebCore::IntSize&, WebCore::HTMLAppletElement&, const WebCore::URL& baseURL, const Vector<String>& paramNames, const Vector<String>& paramValues) final;
213     
214     WebCore::ObjectContentType objectContentType(const WebCore::URL&, const String& mimeType) final;
215     String overrideMediaType() const final;
216
217     void dispatchDidClearWindowObjectInWorld(WebCore::DOMWrapperWorld&) final;
218     
219     void dispatchGlobalObjectAvailable(WebCore::DOMWrapperWorld&) final;
220     void dispatchWillDisconnectDOMWindowExtensionFromGlobalObject(WebCore::DOMWindowExtension*) final;
221     void dispatchDidReconnectDOMWindowExtensionToGlobalObject(WebCore::DOMWindowExtension*) final;
222     void dispatchWillDestroyGlobalObjectForDOMWindowExtension(WebCore::DOMWindowExtension*) final;
223     
224 #if PLATFORM(COCOA)
225     RemoteAXObjectRef accessibilityRemoteObject() final;
226     
227     NSCachedURLResponse* willCacheResponse(WebCore::DocumentLoader*, unsigned long identifier, NSCachedURLResponse*) const final;
228
229     NSDictionary *dataDetectionContext() final;
230 #endif
231
232     bool shouldAlwaysUsePluginDocument(const String& /*mimeType*/) const final;
233
234     void didChangeScrollOffset() final;
235
236     bool allowScript(bool enabledPerSettings) final;
237
238     bool shouldForceUniversalAccessFromLocalURL(const WebCore::URL&) 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     void forcePageTransitionIfNeeded() final;
247
248 #if USE(QUICK_LOOK)
249     RefPtr<WebCore::PreviewLoaderClient> createPreviewLoaderClient(const String& fileName, const String& uti) 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     void didRestoreScrollPosition() final;
259
260     void getLoadDecisionForIcons(const Vector<std::pair<WebCore::LinkIcon&, uint64_t>>&) final;
261     void finishedLoadingIcon(uint64_t callbackIdentifier, WebCore::SharedBuffer*) final;
262
263     WebFrame* m_frame;
264     RefPtr<PluginView> m_pluginView;
265     bool m_hasSentResponseToPluginView;
266     bool m_didCompletePageTransition;
267     bool m_frameHasCustomContentProvider;
268     bool m_frameCameFromPageCache;
269     bool m_useIconLoadingClient { false };
270 };
271
272 // As long as EmptyFrameLoaderClient exists in WebCore, this can return 0.
273 inline WebFrameLoaderClient* toWebFrameLoaderClient(WebCore::FrameLoaderClient& client)
274 {
275     return client.isEmptyFrameLoaderClient() ? 0 : static_cast<WebFrameLoaderClient*>(&client);
276 }
277
278 } // namespace WebKit