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