1/*
2 * Copyright (C) 2010, 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 * 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#ifndef WebFrameLoaderClient_h
27#define WebFrameLoaderClient_h
28
29#include <WebCore/FrameLoaderClient.h>
30
31namespace WebKit {
32
33class PluginView;
34class WebFrame;
35
36class WebFrameLoaderClient : public WebCore::FrameLoaderClient {
37public:
38    WebFrameLoaderClient(WebFrame*);
39    ~WebFrameLoaderClient();
40
41    WebFrame* webFrame() const { return m_frame; }
42
43    bool frameHasCustomRepresentation() const { return m_frameHasCustomRepresentation; }
44
45private:
46    virtual void frameLoaderDestroyed() OVERRIDE;
47
48    virtual bool hasHTMLView() const OVERRIDE;
49    virtual bool hasWebView() const OVERRIDE;
50
51    virtual void makeRepresentation(WebCore::DocumentLoader*) OVERRIDE;
52    virtual void forceLayout() OVERRIDE;
53    virtual void forceLayoutForNonHTML() OVERRIDE;
54
55    virtual void setCopiesOnScroll() OVERRIDE;
56
57    virtual void detachedFromParent2() OVERRIDE;
58    virtual void detachedFromParent3() OVERRIDE;
59
60    virtual void assignIdentifierToInitialRequest(unsigned long identifier, WebCore::DocumentLoader*, const WebCore::ResourceRequest&) OVERRIDE;
61
62    virtual void dispatchWillSendRequest(WebCore::DocumentLoader*, unsigned long identifier, WebCore::ResourceRequest&, const WebCore::ResourceResponse& redirectResponse) OVERRIDE;
63    virtual bool shouldUseCredentialStorage(WebCore::DocumentLoader*, unsigned long identifier) OVERRIDE;
64    virtual void dispatchDidReceiveAuthenticationChallenge(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::AuthenticationChallenge&) OVERRIDE;
65    virtual void dispatchDidCancelAuthenticationChallenge(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::AuthenticationChallenge&) OVERRIDE;
66#if USE(PROTECTION_SPACE_AUTH_CALLBACK)
67    virtual bool canAuthenticateAgainstProtectionSpace(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ProtectionSpace&) OVERRIDE;
68#endif
69    virtual void dispatchDidReceiveResponse(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ResourceResponse&) OVERRIDE;
70    virtual void dispatchDidReceiveContentLength(WebCore::DocumentLoader*, unsigned long identifier, int dataLength) OVERRIDE;
71    virtual void dispatchDidFinishLoading(WebCore::DocumentLoader*, unsigned long identifier) OVERRIDE;
72    virtual void dispatchDidFailLoading(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ResourceError&) OVERRIDE;
73    virtual bool dispatchDidLoadResourceFromMemoryCache(WebCore::DocumentLoader*, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&, int length) OVERRIDE;
74
75    virtual void dispatchDidHandleOnloadEvents() OVERRIDE;
76    virtual void dispatchDidReceiveServerRedirectForProvisionalLoad() OVERRIDE;
77    virtual void dispatchDidCancelClientRedirect() OVERRIDE;
78    virtual void dispatchWillPerformClientRedirect(const WebCore::KURL&, double interval, double fireDate) OVERRIDE;
79    virtual void dispatchDidChangeLocationWithinPage() OVERRIDE;
80    virtual void dispatchDidPushStateWithinPage() OVERRIDE;
81    virtual void dispatchDidReplaceStateWithinPage() OVERRIDE;
82    virtual void dispatchDidPopStateWithinPage() OVERRIDE;
83    virtual void dispatchWillClose() OVERRIDE;
84    virtual void dispatchDidReceiveIcon() OVERRIDE;
85    virtual void dispatchDidStartProvisionalLoad() OVERRIDE;
86    virtual void dispatchDidReceiveTitle(const WebCore::StringWithDirection&) OVERRIDE;
87    virtual void dispatchDidChangeIcons(WebCore::IconType) OVERRIDE;
88    virtual void dispatchDidCommitLoad() OVERRIDE;
89    virtual void dispatchDidFailProvisionalLoad(const WebCore::ResourceError&) OVERRIDE;
90    virtual void dispatchDidFailLoad(const WebCore::ResourceError&) OVERRIDE;
91    virtual void dispatchDidFinishDocumentLoad() OVERRIDE;
92    virtual void dispatchDidFinishLoad() OVERRIDE;
93
94    virtual void dispatchDidLayout(WebCore::LayoutMilestones) OVERRIDE;
95    virtual void dispatchDidLayout() OVERRIDE;
96
97    virtual WebCore::Frame* dispatchCreatePage(const WebCore::NavigationAction&) OVERRIDE;
98    virtual void dispatchShow() OVERRIDE;
99
100    virtual void dispatchDecidePolicyForResponse(WebCore::FramePolicyFunction, const WebCore::ResourceResponse&, const WebCore::ResourceRequest&) OVERRIDE;
101    virtual void dispatchDecidePolicyForNewWindowAction(WebCore::FramePolicyFunction, const WebCore::NavigationAction&, const WebCore::ResourceRequest&, PassRefPtr<WebCore::FormState>, const String& frameName) OVERRIDE;
102    virtual void dispatchDecidePolicyForNavigationAction(WebCore::FramePolicyFunction, const WebCore::NavigationAction&, const WebCore::ResourceRequest&, PassRefPtr<WebCore::FormState>) OVERRIDE;
103    virtual void cancelPolicyCheck() OVERRIDE;
104
105    virtual void dispatchUnableToImplementPolicy(const WebCore::ResourceError&) OVERRIDE;
106
107    virtual void dispatchWillSendSubmitEvent(PassRefPtr<WebCore::FormState>) OVERRIDE;
108    virtual void dispatchWillSubmitForm(WebCore::FramePolicyFunction, PassRefPtr<WebCore::FormState>) OVERRIDE;
109
110    virtual void revertToProvisionalState(WebCore::DocumentLoader*) OVERRIDE;
111    virtual void setMainDocumentError(WebCore::DocumentLoader*, const WebCore::ResourceError&) OVERRIDE;
112
113    // Maybe these should go into a ProgressTrackerClient some day
114    virtual void willChangeEstimatedProgress() OVERRIDE;
115    virtual void didChangeEstimatedProgress() OVERRIDE;
116    virtual void postProgressStartedNotification() OVERRIDE;
117    virtual void postProgressEstimateChangedNotification() OVERRIDE;
118    virtual void postProgressFinishedNotification() OVERRIDE;
119
120    virtual void setMainFrameDocumentReady(bool) OVERRIDE;
121
122    virtual void startDownload(const WebCore::ResourceRequest&, const String& suggestedName = String()) OVERRIDE;
123
124    virtual void willChangeTitle(WebCore::DocumentLoader*) OVERRIDE;
125    virtual void didChangeTitle(WebCore::DocumentLoader*) OVERRIDE;
126
127    virtual void committedLoad(WebCore::DocumentLoader*, const char*, int) OVERRIDE;
128    virtual void finishedLoading(WebCore::DocumentLoader*) OVERRIDE;
129
130    virtual void updateGlobalHistory() OVERRIDE;
131    virtual void updateGlobalHistoryRedirectLinks() OVERRIDE;
132
133    virtual bool shouldGoToHistoryItem(WebCore::HistoryItem*) const OVERRIDE;
134    virtual bool shouldStopLoadingForHistoryItem(WebCore::HistoryItem*) const OVERRIDE;
135
136    virtual void didDisplayInsecureContent() OVERRIDE;
137    virtual void didRunInsecureContent(WebCore::SecurityOrigin*, const WebCore::KURL&) OVERRIDE;
138    virtual void didDetectXSS(const WebCore::KURL&, bool didBlockEntirePage) OVERRIDE;
139
140    virtual WebCore::ResourceError cancelledError(const WebCore::ResourceRequest&) OVERRIDE;
141    virtual WebCore::ResourceError blockedError(const WebCore::ResourceRequest&) OVERRIDE;
142    virtual WebCore::ResourceError cannotShowURLError(const WebCore::ResourceRequest&) OVERRIDE;
143    virtual WebCore::ResourceError interruptedForPolicyChangeError(const WebCore::ResourceRequest&) OVERRIDE;
144
145    virtual WebCore::ResourceError cannotShowMIMETypeError(const WebCore::ResourceResponse&) OVERRIDE;
146    virtual WebCore::ResourceError fileDoesNotExistError(const WebCore::ResourceResponse&) OVERRIDE;
147    virtual WebCore::ResourceError pluginWillHandleLoadError(const WebCore::ResourceResponse&) OVERRIDE;
148
149    virtual bool shouldFallBack(const WebCore::ResourceError&) OVERRIDE;
150
151    virtual bool canHandleRequest(const WebCore::ResourceRequest&) const OVERRIDE;
152    virtual bool canShowMIMEType(const String& MIMEType) const OVERRIDE;
153    virtual bool canShowMIMETypeAsHTML(const String& MIMEType) const OVERRIDE;
154    virtual bool representationExistsForURLScheme(const String& URLScheme) const OVERRIDE;
155    virtual String generatedMIMETypeForURLScheme(const String& URLScheme) const OVERRIDE;
156
157    virtual void frameLoadCompleted() OVERRIDE;
158    virtual void saveViewStateToItem(WebCore::HistoryItem*) OVERRIDE;
159    virtual void restoreViewState() OVERRIDE;
160    virtual void provisionalLoadStarted() OVERRIDE;
161    virtual void didFinishLoad() OVERRIDE;
162    virtual void prepareForDataSourceReplacement() OVERRIDE;
163
164    virtual PassRefPtr<WebCore::DocumentLoader> createDocumentLoader(const WebCore::ResourceRequest&, const WebCore::SubstituteData&);
165    virtual void setTitle(const WebCore::StringWithDirection&, const WebCore::KURL&) OVERRIDE;
166
167    virtual String userAgent(const WebCore::KURL&) OVERRIDE;
168
169    virtual void savePlatformDataToCachedFrame(WebCore::CachedFrame*) OVERRIDE;
170    virtual void transitionToCommittedFromCachedFrame(WebCore::CachedFrame*) OVERRIDE;
171    virtual void transitionToCommittedForNewPage() OVERRIDE;
172
173    virtual void didSaveToPageCache() OVERRIDE;
174    virtual void didRestoreFromPageCache() OVERRIDE;
175
176    virtual void dispatchDidBecomeFrameset(bool) OVERRIDE;
177
178    virtual bool canCachePage() const OVERRIDE;
179    virtual void convertMainResourceLoadToDownload(WebCore::DocumentLoader*, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&) OVERRIDE;
180
181    virtual PassRefPtr<WebCore::Frame> createFrame(const WebCore::KURL& url, const String& name, WebCore::HTMLFrameOwnerElement* ownerElement,
182                                          const String& referrer, bool allowsScrolling, int marginWidth, int marginHeight) OVERRIDE;
183
184    virtual PassRefPtr<WebCore::Widget> createPlugin(const WebCore::IntSize&, WebCore::HTMLPlugInElement*, const WebCore::KURL&, const Vector<String>&, const Vector<String>&, const String&, bool loadManually) OVERRIDE;
185    virtual void recreatePlugin(WebCore::Widget*) OVERRIDE;
186    virtual void redirectDataToPlugin(WebCore::Widget* pluginWidget) OVERRIDE;
187
188    virtual PassRefPtr<WebCore::Widget> createJavaAppletWidget(const WebCore::IntSize&, WebCore::HTMLAppletElement*, const WebCore::KURL& baseURL, const Vector<String>& paramNames, const Vector<String>& paramValues) OVERRIDE;
189
190#if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
191    virtual PassRefPtr<WebCore::Widget> createMediaPlayerProxyPlugin(const WebCore::IntSize&, WebCore::HTMLMediaElement*, const WebCore::KURL&, const Vector<String>&, const Vector<String>&, const String&) OVERRIDE;
192    virtual void hideMediaPlayerProxyPlugin(WebCore::Widget*) OVERRIDE;
193    virtual void showMediaPlayerProxyPlugin(WebCore::Widget*) OVERRIDE;
194#endif
195
196    virtual WebCore::ObjectContentType objectContentType(const WebCore::KURL&, const String& mimeType, bool shouldPreferPlugInsForImages) OVERRIDE;
197    virtual String overrideMediaType() const OVERRIDE;
198
199    virtual void dispatchDidClearWindowObjectInWorld(WebCore::DOMWrapperWorld*) OVERRIDE;
200
201    virtual void dispatchGlobalObjectAvailable(WebCore::DOMWrapperWorld*) OVERRIDE;
202    virtual void dispatchWillDisconnectDOMWindowExtensionFromGlobalObject(WebCore::DOMWindowExtension*) OVERRIDE;
203    virtual void dispatchDidReconnectDOMWindowExtensionToGlobalObject(WebCore::DOMWindowExtension*) OVERRIDE;
204    virtual void dispatchWillDestroyGlobalObjectForDOMWindowExtension(WebCore::DOMWindowExtension*) OVERRIDE;
205
206    virtual void documentElementAvailable() OVERRIDE;
207    virtual void didPerformFirstNavigation() const OVERRIDE; // "Navigation" here means a transition from one page to another that ends up in the back/forward list.
208
209    virtual void registerForIconNotification(bool listen = true) OVERRIDE;
210
211#if PLATFORM(MAC)
212    virtual RemoteAXObjectRef accessibilityRemoteObject() OVERRIDE;
213
214    virtual NSCachedURLResponse* willCacheResponse(WebCore::DocumentLoader*, unsigned long identifier, NSCachedURLResponse*) const OVERRIDE;
215#endif
216
217    virtual bool shouldAlwaysUsePluginDocument(const String& /*mimeType*/) const OVERRIDE;
218
219    virtual void didChangeScrollOffset() OVERRIDE;
220
221    virtual bool allowScript(bool enabledPerSettings) OVERRIDE;
222
223    virtual bool shouldForceUniversalAccessFromLocalURL(const WebCore::KURL&) OVERRIDE;
224
225    virtual PassRefPtr<WebCore::FrameNetworkingContext> createNetworkingContext() OVERRIDE;
226
227    virtual void forcePageTransitionIfNeeded() OVERRIDE;
228
229    WebFrame* m_frame;
230    RefPtr<PluginView> m_pluginView;
231    bool m_hasSentResponseToPluginView;
232    bool m_didCompletePageTransitionAlready;
233    bool m_frameHasCustomRepresentation;
234    bool m_frameCameFromPageCache;
235};
236
237// As long as EmptyFrameLoaderClient exists in WebCore, this can return 0.
238inline WebFrameLoaderClient* toWebFrameLoaderClient(WebCore::FrameLoaderClient* client)
239{
240    return client->isEmptyFrameLoaderClient() ? 0 : static_cast<WebFrameLoaderClient*>(client);
241}
242
243} // namespace WebKit
244
245#endif // WebFrameLoaderClient_h
246