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