Add SPI WKNavigationResponse._downloadAttribute
[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 struct WebsitePoliciesData;
39     
40 class WebFrameLoaderClient final : public WebCore::FrameLoaderClient {
41 public:
42     WebFrameLoaderClient();
43     ~WebFrameLoaderClient();
44
45     void setWebFrame(WebFrame* webFrame) { m_frame = webFrame; }
46     WebFrame* webFrame() const { return m_frame; }
47
48     bool frameHasCustomContentProvider() const { return m_frameHasCustomContentProvider; }
49
50     void setUseIconLoadingClient(bool useIconLoadingClient) { m_useIconLoadingClient = useIconLoadingClient; }
51
52     void applyToDocumentLoader(WebsitePoliciesData&&);
53
54     Optional<uint64_t> pageID() const final;
55     Optional<uint64_t> frameID() const final;
56     PAL::SessionID sessionID() const final;
57
58 #if ENABLE(RESOURCE_LOAD_STATISTICS)
59     bool hasFrameSpecificStorageAccess() { return m_hasFrameSpecificStorageAccess; }
60     void setHasFrameSpecificStorageAccess(bool value) { m_hasFrameSpecificStorageAccess = value; };
61 #endif
62     
63 private:
64     void frameLoaderDestroyed() final;
65
66     bool hasHTMLView() const final;
67     bool hasWebView() const final;
68     
69     void makeRepresentation(WebCore::DocumentLoader*) final;
70 #if PLATFORM(IOS_FAMILY)
71     bool forceLayoutOnRestoreFromPageCache() final;
72 #endif
73     void forceLayoutForNonHTML() final;
74     
75     void setCopiesOnScroll() final;
76     
77     void detachedFromParent2() final;
78     void detachedFromParent3() final;
79     
80     void assignIdentifierToInitialRequest(unsigned long identifier, WebCore::DocumentLoader*, const WebCore::ResourceRequest&) final;
81     
82     void dispatchWillSendRequest(WebCore::DocumentLoader*, unsigned long identifier, WebCore::ResourceRequest&, const WebCore::ResourceResponse& redirectResponse) final;
83     bool shouldUseCredentialStorage(WebCore::DocumentLoader*, unsigned long identifier) final;
84     void dispatchDidReceiveAuthenticationChallenge(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::AuthenticationChallenge&) final;
85 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
86     bool canAuthenticateAgainstProtectionSpace(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ProtectionSpace&) final;
87 #endif
88 #if PLATFORM(IOS_FAMILY)
89     RetainPtr<CFDictionaryRef> connectionProperties(WebCore::DocumentLoader*, unsigned long identifier) final;
90 #endif
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     void dispatchDidFailLoading(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ResourceError&) final;
95     bool dispatchDidLoadResourceFromMemoryCache(WebCore::DocumentLoader*, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&, int length) final;
96 #if ENABLE(DATA_DETECTION)
97     void dispatchDidFinishDataDetection(NSArray *detectionResults) final;
98 #endif
99     void dispatchDidChangeMainDocument() final;
100     void dispatchWillChangeDocument(const URL& currentUrl, const URL& newUrl) final;
101
102     void dispatchDidDispatchOnloadEvents() final;
103     void dispatchDidReceiveServerRedirectForProvisionalLoad() final;
104     void dispatchDidChangeProvisionalURL() final;
105     void dispatchDidCancelClientRedirect() final;
106     void dispatchWillPerformClientRedirect(const URL&, double interval, WallTime fireDate, WebCore::LockBackForwardList) final;
107     void dispatchDidChangeLocationWithinPage() final;
108     void dispatchDidPushStateWithinPage() final;
109     void dispatchDidReplaceStateWithinPage() final;
110     void dispatchDidPopStateWithinPage() final;
111     void dispatchWillClose() final;
112     void dispatchDidStartProvisionalLoad() final;
113     void dispatchDidReceiveTitle(const WebCore::StringWithDirection&) final;
114     void dispatchDidCommitLoad(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
120     void dispatchDidReachLayoutMilestone(OptionSet<WebCore::LayoutMilestone>) final;
121     void dispatchDidLayout() final;
122
123     WebCore::Frame* dispatchCreatePage(const WebCore::NavigationAction&) final;
124     void dispatchShow() final;
125     
126     void dispatchDecidePolicyForResponse(const WebCore::ResourceResponse&, const WebCore::ResourceRequest&, WebCore::PolicyCheckIdentifier, const String&, WebCore::FramePolicyFunction&&) final;
127     void dispatchDecidePolicyForNewWindowAction(const WebCore::NavigationAction&, const WebCore::ResourceRequest&, WebCore::FormState*, const String& frameName, WebCore::PolicyCheckIdentifier, WebCore::FramePolicyFunction&&) final;
128     void dispatchDecidePolicyForNavigationAction(const WebCore::NavigationAction&, const WebCore::ResourceRequest&, const WebCore::ResourceResponse& redirectResponse, WebCore::FormState*, WebCore::PolicyDecisionMode, WebCore::PolicyCheckIdentifier, WebCore::FramePolicyFunction&&) final;
129     void cancelPolicyCheck() final;
130     
131     void dispatchUnableToImplementPolicy(const WebCore::ResourceError&) final;
132     
133     void dispatchWillSendSubmitEvent(Ref<WebCore::FormState>&&) final;
134     void dispatchWillSubmitForm(WebCore::FormState&, CompletionHandler<void()>&&) final;
135     
136     void revertToProvisionalState(WebCore::DocumentLoader*) final;
137     void setMainDocumentError(WebCore::DocumentLoader*, const WebCore::ResourceError&) final;
138     
139     void setMainFrameDocumentReady(bool) final;
140     
141     void startDownload(const WebCore::ResourceRequest&, const String& suggestedName = String()) final;
142     
143     void willChangeTitle(WebCore::DocumentLoader*) final;
144     void didChangeTitle(WebCore::DocumentLoader*) final;
145
146     void willReplaceMultipartContent() final;
147     void didReplaceMultipartContent() final;
148
149     void committedLoad(WebCore::DocumentLoader*, const char*, int) final;
150     void finishedLoading(WebCore::DocumentLoader*) final;
151     
152     void updateGlobalHistory() final;
153     void updateGlobalHistoryRedirectLinks() final;
154     
155     bool shouldGoToHistoryItem(WebCore::HistoryItem&) const final;
156
157     void didDisplayInsecureContent() final;
158     void didRunInsecureContent(WebCore::SecurityOrigin&, const URL&) final;
159     void didDetectXSS(const URL&, bool didBlockEntirePage) final;
160
161     WebCore::ResourceError cancelledError(const WebCore::ResourceRequest&) final;
162     WebCore::ResourceError blockedError(const WebCore::ResourceRequest&) final;
163     WebCore::ResourceError blockedByContentBlockerError(const WebCore::ResourceRequest&) final;
164     WebCore::ResourceError cannotShowURLError(const WebCore::ResourceRequest&) final;
165     WebCore::ResourceError interruptedForPolicyChangeError(const WebCore::ResourceRequest&) final;
166 #if ENABLE(CONTENT_FILTERING)
167     WebCore::ResourceError blockedByContentFilterError(const WebCore::ResourceRequest&) final;
168 #endif
169     
170     WebCore::ResourceError cannotShowMIMETypeError(const WebCore::ResourceResponse&) final;
171     WebCore::ResourceError fileDoesNotExistError(const WebCore::ResourceResponse&) final;
172     WebCore::ResourceError pluginWillHandleLoadError(const WebCore::ResourceResponse&) final;
173     
174     bool shouldFallBack(const WebCore::ResourceError&) final;
175     
176     bool canHandleRequest(const WebCore::ResourceRequest&) const final;
177     bool canShowMIMEType(const String& MIMEType) const final;
178     bool canShowMIMETypeAsHTML(const String& MIMEType) const final;
179     bool representationExistsForURLScheme(const String& URLScheme) const final;
180     String generatedMIMETypeForURLScheme(const String& URLScheme) const final;
181     
182     void frameLoadCompleted() final;
183     void saveViewStateToItem(WebCore::HistoryItem&) final;
184     void restoreViewState() final;
185     void provisionalLoadStarted() final;
186     void didFinishLoad() final;
187     void prepareForDataSourceReplacement() final;
188     
189     Ref<WebCore::DocumentLoader> createDocumentLoader(const WebCore::ResourceRequest&, const WebCore::SubstituteData&) final;
190     void updateCachedDocumentLoader(WebCore::DocumentLoader&) final;
191
192     void setTitle(const WebCore::StringWithDirection&, const URL&) final;
193     
194     String userAgent(const URL&) final;
195
196     String overrideContentSecurityPolicy() const final;
197
198     void savePlatformDataToCachedFrame(WebCore::CachedFrame*) final;
199     void transitionToCommittedFromCachedFrame(WebCore::CachedFrame*) final;
200 #if PLATFORM(IOS_FAMILY)
201     void didRestoreFrameHierarchyForCachedFrame() final;
202 #endif
203     void transitionToCommittedForNewPage() final;
204
205     void didSaveToPageCache() final;
206     void didRestoreFromPageCache() final;
207
208     void dispatchDidBecomeFrameset(bool) final;
209
210     bool canCachePage() const final;
211     void convertMainResourceLoadToDownload(WebCore::DocumentLoader*, PAL::SessionID, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&) final;
212
213     RefPtr<WebCore::Frame> createFrame(const URL&, const String& name, WebCore::HTMLFrameOwnerElement&, const String& referrer) final;
214
215     RefPtr<WebCore::Widget> createPlugin(const WebCore::IntSize&, WebCore::HTMLPlugInElement&, const URL&, const Vector<String>&, const Vector<String>&, const String&, bool loadManually) final;
216     void redirectDataToPlugin(WebCore::Widget&) final;
217     
218 #if ENABLE(WEBGL)
219     WebCore::WebGLLoadPolicy webGLPolicyForURL(const URL&) const final;
220     WebCore::WebGLLoadPolicy resolveWebGLPolicyForURL(const URL&) const final;
221 #endif // ENABLE(WEBGL)
222
223     RefPtr<WebCore::Widget> createJavaAppletWidget(const WebCore::IntSize&, WebCore::HTMLAppletElement&, const URL& baseURL, const Vector<String>& paramNames, const Vector<String>& paramValues) final;
224     
225     WebCore::ObjectContentType objectContentType(const URL&, const String& mimeType) final;
226     String overrideMediaType() const final;
227
228     void dispatchDidClearWindowObjectInWorld(WebCore::DOMWrapperWorld&) final;
229     
230     void dispatchGlobalObjectAvailable(WebCore::DOMWrapperWorld&) final;
231     void dispatchWillDisconnectDOMWindowExtensionFromGlobalObject(WebCore::DOMWindowExtension*) final;
232     void dispatchDidReconnectDOMWindowExtensionToGlobalObject(WebCore::DOMWindowExtension*) final;
233     void dispatchWillDestroyGlobalObjectForDOMWindowExtension(WebCore::DOMWindowExtension*) final;
234
235     void willInjectUserScript(WebCore::DOMWrapperWorld&) final;
236
237 #if PLATFORM(COCOA)
238     RemoteAXObjectRef accessibilityRemoteObject() final;
239     
240     void willCacheResponse(WebCore::DocumentLoader*, unsigned long identifier, NSCachedURLResponse*, CompletionHandler<void(NSCachedURLResponse *)>&&) const final;
241
242     NSDictionary *dataDetectionContext() final;
243 #endif
244
245     void didChangeScrollOffset() final;
246
247     bool allowScript(bool enabledPerSettings) final;
248
249     bool shouldForceUniversalAccessFromLocalURL(const URL&) final;
250
251     Ref<WebCore::FrameNetworkingContext> createNetworkingContext() final;
252
253     void forcePageTransitionIfNeeded() final;
254
255 #if USE(QUICK_LOOK)
256     RefPtr<WebCore::PreviewLoaderClient> createPreviewLoaderClient(const String& fileName, const String& uti) final;
257 #endif
258
259 #if ENABLE(CONTENT_FILTERING)
260     void contentFilterDidBlockLoad(WebCore::ContentFilterUnblockHandler) final;
261 #endif
262
263     void prefetchDNS(const String&) final;
264
265     void didRestoreScrollPosition() final;
266
267     void getLoadDecisionForIcons(const Vector<std::pair<WebCore::LinkIcon&, uint64_t>>&) final;
268     void finishedLoadingIcon(uint64_t callbackIdentifier, WebCore::SharedBuffer*) final;
269
270     void didCreateWindow(WebCore::DOMWindow&) final;
271
272 #if ENABLE(APPLICATION_MANIFEST)
273     void finishedLoadingApplicationManifest(uint64_t, const Optional<WebCore::ApplicationManifest>&) final;
274 #endif
275
276     WebFrame* m_frame;
277     RefPtr<PluginView> m_pluginView;
278     bool m_hasSentResponseToPluginView;
279     bool m_didCompletePageTransition;
280     bool m_frameHasCustomContentProvider;
281     bool m_frameCameFromPageCache;
282     bool m_useIconLoadingClient { false };
283 #if ENABLE(RESOURCE_LOAD_STATISTICS)
284     bool m_hasFrameSpecificStorageAccess { false };
285 #endif
286 };
287
288 // As long as EmptyFrameLoaderClient exists in WebCore, this can return 0.
289 inline WebFrameLoaderClient* toWebFrameLoaderClient(WebCore::FrameLoaderClient& client)
290 {
291     return client.isEmptyFrameLoaderClient() ? 0 : static_cast<WebFrameLoaderClient*>(&client);
292 }
293
294 } // namespace WebKit