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