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