[iOS] Upstream PLATFORM(IOS) changes to Source/WebKit/
[WebKit-https.git] / Source / WebKit / mac / WebCoreSupport / WebFrameLoaderClient.h
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2011, 2012 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 Computer, 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 }
49
50 typedef HashMap<RefPtr<WebCore::ResourceLoader>, RetainPtr<WebResource>> ResourceMap;
51
52 class WebFrameLoaderClient : public WebCore::FrameLoaderClient {
53 public:
54     WebFrameLoaderClient(WebFrame* = 0);
55
56     void setWebFrame(WebFrame* webFrame) { m_webFrame = webFrame; }
57     WebFrame* webFrame() const { return m_webFrame.get(); }
58
59 private:
60     virtual void frameLoaderDestroyed() OVERRIDE;
61     virtual bool hasWebView() const OVERRIDE; // mainly for assertions
62
63     virtual void makeRepresentation(WebCore::DocumentLoader*) OVERRIDE;
64     virtual bool hasHTMLView() const OVERRIDE;
65     virtual void forceLayout() OVERRIDE;
66 #if PLATFORM(IOS)
67     virtual void forceLayoutWithoutRecalculatingStyles() OVERRIDE;
68 #endif
69     virtual void forceLayoutForNonHTML() OVERRIDE;
70
71     virtual void setCopiesOnScroll() OVERRIDE;
72
73     virtual void detachedFromParent2() OVERRIDE;
74     virtual void detachedFromParent3() OVERRIDE;
75
76     virtual void convertMainResourceLoadToDownload(WebCore::DocumentLoader*, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&) OVERRIDE;
77
78     virtual void assignIdentifierToInitialRequest(unsigned long identifier, WebCore::DocumentLoader*, const WebCore::ResourceRequest&) OVERRIDE;
79
80     virtual void dispatchWillSendRequest(WebCore::DocumentLoader*, unsigned long identifier, WebCore::ResourceRequest&, const WebCore::ResourceResponse& redirectResponse) OVERRIDE;
81     virtual bool shouldUseCredentialStorage(WebCore::DocumentLoader*, unsigned long identifier) OVERRIDE;
82     virtual void dispatchDidReceiveAuthenticationChallenge(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::AuthenticationChallenge&) OVERRIDE;
83     virtual void dispatchDidCancelAuthenticationChallenge(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::AuthenticationChallenge&) OVERRIDE;
84 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
85     virtual bool canAuthenticateAgainstProtectionSpace(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ProtectionSpace&) OVERRIDE;
86 #endif
87
88 #if PLATFORM(IOS)
89     virtual RetainPtr<CFDictionaryRef> connectionProperties(WebCore::DocumentLoader*, unsigned long identifier) OVERRIDE;
90 #endif
91
92     virtual void dispatchDidReceiveResponse(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ResourceResponse&) OVERRIDE;
93     virtual void dispatchDidReceiveContentLength(WebCore::DocumentLoader*, unsigned long identifier, int dataLength) OVERRIDE;
94     virtual void dispatchDidFinishLoading(WebCore::DocumentLoader*, unsigned long identifier) OVERRIDE;
95     virtual void dispatchDidFailLoading(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ResourceError&) OVERRIDE;
96
97     virtual NSCachedURLResponse* willCacheResponse(WebCore::DocumentLoader*, unsigned long identifier, NSCachedURLResponse*) const OVERRIDE;
98
99     virtual void dispatchDidHandleOnloadEvents() OVERRIDE;
100     virtual void dispatchDidReceiveServerRedirectForProvisionalLoad() OVERRIDE;
101     virtual void dispatchDidCancelClientRedirect() OVERRIDE;
102     virtual void dispatchWillPerformClientRedirect(const WebCore::URL&, double interval, double fireDate) OVERRIDE;
103     virtual void dispatchDidChangeLocationWithinPage() OVERRIDE;
104     virtual void dispatchDidPushStateWithinPage() OVERRIDE;
105     virtual void dispatchDidReplaceStateWithinPage() OVERRIDE;
106     virtual void dispatchDidPopStateWithinPage() OVERRIDE;
107     
108     virtual void dispatchWillClose() OVERRIDE;
109     virtual void dispatchDidReceiveIcon() OVERRIDE;
110     virtual void dispatchDidStartProvisionalLoad() OVERRIDE;
111     virtual void dispatchDidReceiveTitle(const WebCore::StringWithDirection&) OVERRIDE;
112     virtual void dispatchDidChangeIcons(WebCore::IconType) OVERRIDE;
113     virtual void dispatchDidCommitLoad() OVERRIDE;
114     virtual void dispatchDidFailProvisionalLoad(const WebCore::ResourceError&) OVERRIDE;
115     virtual void dispatchDidFailLoad(const WebCore::ResourceError&) OVERRIDE;
116     virtual void dispatchDidFinishDocumentLoad() OVERRIDE;
117     virtual void dispatchDidFinishLoad() OVERRIDE;
118     virtual void dispatchDidLayout(WebCore::LayoutMilestones) OVERRIDE;
119
120     virtual WebCore::Frame* dispatchCreatePage(const WebCore::NavigationAction&) OVERRIDE;
121     virtual void dispatchShow() OVERRIDE;
122
123     virtual void dispatchDecidePolicyForResponse(const WebCore::ResourceResponse&, const WebCore::ResourceRequest&, WebCore::FramePolicyFunction);
124     virtual void dispatchDecidePolicyForNewWindowAction(const WebCore::NavigationAction&, const WebCore::ResourceRequest&, PassRefPtr<WebCore::FormState>, const WTF::String& frameName, WebCore::FramePolicyFunction) OVERRIDE;
125     virtual void dispatchDecidePolicyForNavigationAction(const WebCore::NavigationAction&, const WebCore::ResourceRequest&, PassRefPtr<WebCore::FormState>, WebCore::FramePolicyFunction) OVERRIDE;
126     virtual void cancelPolicyCheck() OVERRIDE;
127
128     virtual void dispatchUnableToImplementPolicy(const WebCore::ResourceError&) OVERRIDE;
129
130     virtual void dispatchWillSendSubmitEvent(PassRefPtr<WebCore::FormState>) OVERRIDE;
131     virtual void dispatchWillSubmitForm(PassRefPtr<WebCore::FormState>, WebCore::FramePolicyFunction) OVERRIDE;
132
133     virtual void revertToProvisionalState(WebCore::DocumentLoader*) OVERRIDE;
134     virtual void setMainDocumentError(WebCore::DocumentLoader*, const WebCore::ResourceError&) OVERRIDE;
135     virtual bool dispatchDidLoadResourceFromMemoryCache(WebCore::DocumentLoader*, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&, int length) OVERRIDE;
136
137 #if !PLATFORM(IOS)
138     virtual void willChangeEstimatedProgress() OVERRIDE;
139     virtual void didChangeEstimatedProgress() OVERRIDE;
140 #endif
141     virtual void postProgressStartedNotification() OVERRIDE;
142     virtual void postProgressEstimateChangedNotification() OVERRIDE;
143 #if !PLATFORM(IOS)
144     virtual void postProgressFinishedNotification() OVERRIDE;
145 #else
146     virtual void postProgressFinishedNotification() OVERRIDE { }
147 #endif
148     
149     virtual void setMainFrameDocumentReady(bool) OVERRIDE;
150
151     virtual void startDownload(const WebCore::ResourceRequest&, const String& suggestedName = String()) OVERRIDE;
152
153     virtual void willChangeTitle(WebCore::DocumentLoader*) OVERRIDE;
154     virtual void didChangeTitle(WebCore::DocumentLoader*) OVERRIDE;
155
156     virtual void committedLoad(WebCore::DocumentLoader*, const char*, int) OVERRIDE;
157     virtual void finishedLoading(WebCore::DocumentLoader*) OVERRIDE;
158     virtual void updateGlobalHistory() OVERRIDE;
159     virtual void updateGlobalHistoryRedirectLinks() OVERRIDE;
160
161     virtual bool shouldGoToHistoryItem(WebCore::HistoryItem*) const OVERRIDE;
162     virtual bool shouldStopLoadingForHistoryItem(WebCore::HistoryItem*) const OVERRIDE;
163     virtual void updateGlobalHistoryItemForPage() OVERRIDE;
164
165     virtual void didDisplayInsecureContent() OVERRIDE;
166     virtual void didRunInsecureContent(WebCore::SecurityOrigin*, const WebCore::URL&) OVERRIDE;
167     virtual void didDetectXSS(const WebCore::URL&, bool didBlockEntirePage) OVERRIDE;
168
169     virtual WebCore::ResourceError cancelledError(const WebCore::ResourceRequest&) OVERRIDE;
170     virtual WebCore::ResourceError blockedError(const WebCore::ResourceRequest&) OVERRIDE;
171     virtual WebCore::ResourceError cannotShowURLError(const WebCore::ResourceRequest&) OVERRIDE;
172     virtual WebCore::ResourceError interruptedForPolicyChangeError(const WebCore::ResourceRequest&) OVERRIDE;
173
174     virtual WebCore::ResourceError cannotShowMIMETypeError(const WebCore::ResourceResponse&) OVERRIDE;
175     virtual WebCore::ResourceError fileDoesNotExistError(const WebCore::ResourceResponse&) OVERRIDE;
176     virtual WebCore::ResourceError pluginWillHandleLoadError(const WebCore::ResourceResponse&) OVERRIDE;
177
178     virtual bool shouldFallBack(const WebCore::ResourceError&) OVERRIDE;
179
180     virtual WTF::String userAgent(const WebCore::URL&) OVERRIDE;
181     
182     virtual void savePlatformDataToCachedFrame(WebCore::CachedFrame*) OVERRIDE;
183     virtual void transitionToCommittedFromCachedFrame(WebCore::CachedFrame*) OVERRIDE;
184 #if PLATFORM(IOS)
185     virtual void didRestoreFrameHierarchyForCachedFrame() OVERRIDE;
186 #endif
187     virtual void transitionToCommittedForNewPage() OVERRIDE;
188
189     virtual void didSaveToPageCache() OVERRIDE;
190     virtual void didRestoreFromPageCache() OVERRIDE;
191
192     virtual void dispatchDidBecomeFrameset(bool) OVERRIDE;
193
194     virtual bool canHandleRequest(const WebCore::ResourceRequest&) const OVERRIDE;
195     virtual bool canShowMIMEType(const WTF::String& MIMEType) const OVERRIDE;
196     virtual bool canShowMIMETypeAsHTML(const WTF::String& MIMEType) const OVERRIDE;
197     virtual bool representationExistsForURLScheme(const WTF::String& URLScheme) const OVERRIDE;
198     virtual WTF::String generatedMIMETypeForURLScheme(const WTF::String& URLScheme) const OVERRIDE;
199
200     virtual void frameLoadCompleted() OVERRIDE;
201     virtual void saveViewStateToItem(WebCore::HistoryItem*) OVERRIDE;
202     virtual void restoreViewState() OVERRIDE;
203     virtual void provisionalLoadStarted() OVERRIDE;
204     virtual void didFinishLoad() OVERRIDE;
205     virtual void prepareForDataSourceReplacement() OVERRIDE;
206     virtual PassRefPtr<WebCore::DocumentLoader> createDocumentLoader(const WebCore::ResourceRequest&, const WebCore::SubstituteData&) OVERRIDE;
207
208     virtual void setTitle(const WebCore::StringWithDirection&, const WebCore::URL&) OVERRIDE;
209
210     virtual PassRefPtr<WebCore::Frame> createFrame(const WebCore::URL& url, const WTF::String& name, WebCore::HTMLFrameOwnerElement*,
211                                         const WTF::String& referrer, bool allowsScrolling, int marginWidth, int marginHeight) OVERRIDE;
212     virtual PassRefPtr<WebCore::Widget> createPlugin(const WebCore::IntSize&, WebCore::HTMLPlugInElement*, const WebCore::URL&, const Vector<WTF::String>&,
213                                           const Vector<WTF::String>&, const WTF::String&, bool) OVERRIDE;
214     virtual void recreatePlugin(WebCore::Widget*) OVERRIDE;
215     virtual void redirectDataToPlugin(WebCore::Widget* pluginWidget) OVERRIDE;
216     
217     virtual PassRefPtr<WebCore::Widget> createJavaAppletWidget(const WebCore::IntSize&, WebCore::HTMLAppletElement*, const WebCore::URL& baseURL,
218                                                     const Vector<WTF::String>& paramNames, const Vector<WTF::String>& paramValues) OVERRIDE;
219     
220 #if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
221     virtual PassRefPtr<WebCore::Widget> createMediaPlayerProxyPlugin(const WebCore::IntSize&, WebCore::HTMLMediaElement*, const WebCore::URL&, 
222                                         const Vector<WTF::String>&, const Vector<WTF::String>&, const WTF::String&) OVERRIDE;
223     virtual void hideMediaPlayerProxyPlugin(WebCore::Widget*) OVERRIDE;
224     virtual void showMediaPlayerProxyPlugin(WebCore::Widget*) OVERRIDE;
225 #endif
226     
227     virtual WebCore::ObjectContentType objectContentType(const WebCore::URL&, const WTF::String& mimeType, bool shouldPreferPlugInsForImages) OVERRIDE;
228     virtual WTF::String overrideMediaType() const OVERRIDE;
229     
230     virtual void dispatchDidClearWindowObjectInWorld(WebCore::DOMWrapperWorld&) OVERRIDE;
231     virtual void documentElementAvailable() OVERRIDE;
232     virtual void didPerformFirstNavigation() const OVERRIDE;
233
234     virtual void registerForIconNotification(bool listen) OVERRIDE;
235
236 #if PLATFORM(IOS)
237     virtual bool shouldLoadMediaElementURL(const WebCore::URL&) const OVERRIDE;
238 #endif
239
240 #if PLATFORM(MAC)
241     virtual RemoteAXObjectRef accessibilityRemoteObject() OVERRIDE { return 0; }
242 #endif
243     
244     RetainPtr<WebFramePolicyListener> setUpPolicyListener(WebCore::FramePolicyFunction);
245
246     NSDictionary *actionDictionary(const WebCore::NavigationAction&, PassRefPtr<WebCore::FormState>) const;
247     
248     virtual bool canCachePage() const;
249
250     virtual PassRefPtr<WebCore::FrameNetworkingContext> createNetworkingContext();
251
252     virtual bool shouldPaintBrokenImage(const WebCore::URL&) const;
253
254     RetainPtr<WebFrame> m_webFrame;
255
256     RetainPtr<WebFramePolicyListener> m_policyListener;
257 };