REGRESSION(236154) C API clients not using WKPageSetPageNavigationClient couldn't...
[WebKit-https.git] / Source / WebKit / UIProcess / API / APINavigationClient.h
1 /*
2  * Copyright (C) 2014, 2015 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 #pragma once
27
28 #include "APIData.h"
29 #include "APIString.h"
30 #include "AuthenticationChallengeProxy.h"
31 #include "AuthenticationDecisionListener.h"
32 #include "PluginModuleInfo.h"
33 #include "ProcessTerminationReason.h"
34 #include "SameDocumentNavigationType.h"
35 #include "WebEvent.h"
36 #include "WebFramePolicyListenerProxy.h"
37 #include "WebsitePoliciesData.h"
38 #include <WebCore/FrameLoaderTypes.h>
39 #include <WebCore/LayoutMilestones.h>
40 #include <wtf/Forward.h>
41
42 namespace WebCore {
43 class ResourceError;
44 class ResourceRequest;
45 class ResourceResponse;
46 struct SecurityOriginData;
47 }
48
49 namespace WebKit {
50 class AuthenticationChallengeProxy;
51 class QuickLookDocumentData;
52 class WebBackForwardListItem;
53 class WebFramePolicyListenerProxy;
54 class WebFrameProxy;
55 class WebPageProxy;
56 class WebProtectionSpace;
57 struct NavigationActionData;
58 struct WebNavigationDataStore;
59 }
60
61 namespace API {
62
63 class Dictionary;
64 class Navigation;
65 class NavigationAction;
66 class NavigationResponse;
67 class Object;
68
69 class NavigationClient {
70 public:
71     virtual ~NavigationClient() { }
72
73     virtual void didStartProvisionalNavigation(WebKit::WebPageProxy&, Navigation*, Object*) { }
74     virtual void didReceiveServerRedirectForProvisionalNavigation(WebKit::WebPageProxy&, Navigation*, Object*) { }
75     virtual void willPerformClientRedirect(WebKit::WebPageProxy&, const WTF::String&, double) { }
76     virtual void didCancelClientRedirect(WebKit::WebPageProxy&) { }
77     virtual void didFailProvisionalNavigationWithError(WebKit::WebPageProxy&, WebKit::WebFrameProxy&, Navigation*, const WebCore::ResourceError&, Object*) { }
78     virtual void didFailProvisionalLoadInSubframeWithError(WebKit::WebPageProxy&, WebKit::WebFrameProxy&, const WebCore::SecurityOriginData&, Navigation*, const WebCore::ResourceError&, Object*) { }
79     virtual void didCommitNavigation(WebKit::WebPageProxy&, Navigation*, Object*) { }
80     virtual void didFinishDocumentLoad(WebKit::WebPageProxy&, Navigation*, Object*) { }
81     virtual void didFinishNavigation(WebKit::WebPageProxy&, Navigation*, Object*) { }
82     virtual void didFailNavigationWithError(WebKit::WebPageProxy&, WebKit::WebFrameProxy&, Navigation*, const WebCore::ResourceError&, Object*) { }
83     virtual void didSameDocumentNavigation(WebKit::WebPageProxy&, Navigation*, WebKit::SameDocumentNavigationType, Object*) { }
84
85     virtual void didDisplayInsecureContent(WebKit::WebPageProxy&, API::Object*) { }
86     virtual void didRunInsecureContent(WebKit::WebPageProxy&, API::Object*) { }
87
88     virtual void renderingProgressDidChange(WebKit::WebPageProxy&, WebCore::LayoutMilestones) { }
89
90     virtual void didReceiveAuthenticationChallenge(WebKit::WebPageProxy&, WebKit::AuthenticationChallengeProxy& challenge) { challenge.listener().performDefaultHandling(); }
91
92     // FIXME: These function should not be part of this client.
93     virtual bool processDidTerminate(WebKit::WebPageProxy&, WebKit::ProcessTerminationReason) { return false; }
94     virtual void processDidBecomeResponsive(WebKit::WebPageProxy&) { }
95     virtual void processDidBecomeUnresponsive(WebKit::WebPageProxy&) { }
96
97     virtual RefPtr<Data> webCryptoMasterKey(WebKit::WebPageProxy&) { return nullptr; }
98
99     virtual RefPtr<String> signedPublicKeyAndChallengeString(WebKit::WebPageProxy&, unsigned keySizeIndex, const RefPtr<String>& challengeString, const WebCore::URL&) { return nullptr; }
100
101 #if USE(QUICK_LOOK)
102     virtual void didStartLoadForQuickLookDocumentInMainFrame(const WTF::String& fileName, const WTF::String& uti) { }
103     virtual void didFinishLoadForQuickLookDocumentInMainFrame(const WebKit::QuickLookDocumentData&) { }
104 #endif
105
106     virtual void decidePolicyForNavigationAction(WebKit::WebPageProxy&, Ref<NavigationAction>&&, Ref<WebKit::WebFramePolicyListenerProxy>&& listener, Object*)
107     {
108         listener->use();
109     }
110
111     virtual void decidePolicyForNavigationResponse(WebKit::WebPageProxy&, Ref<NavigationResponse>&&, Ref<WebKit::WebFramePolicyListenerProxy>&& listener, Object*)
112     {
113         listener->use();
114     }
115     
116     virtual void contentRuleListNotification(WebKit::WebPageProxy&, WebCore::URL&&, Vector<WTF::String>&&, Vector<WTF::String>&&) { };
117     
118 #if ENABLE(NETSCAPE_PLUGIN_API)
119     virtual bool didFailToInitializePlugIn(WebKit::WebPageProxy&, API::Dictionary&) { return false; }
120     virtual bool didBlockInsecurePluginVersion(WebKit::WebPageProxy&, API::Dictionary&) { return false; }
121     virtual void decidePolicyForPluginLoad(WebKit::WebPageProxy&, WebKit::PluginModuleLoadPolicy currentPluginLoadPolicy, Dictionary&, CompletionHandler<void(WebKit::PluginModuleLoadPolicy, const WTF::String&)>&& completionHandler)
122     {
123         completionHandler(currentPluginLoadPolicy, { });
124     }
125 #endif
126
127 #if ENABLE(WEBGL)
128     virtual void webGLLoadPolicy(WebKit::WebPageProxy&, const WebCore::URL&, CompletionHandler<void(WebCore::WebGLLoadPolicy)>&& completionHandler) const { completionHandler(WebCore::WebGLLoadPolicy::WebGLAllowCreation); }
129     virtual void resolveWebGLLoadPolicy(WebKit::WebPageProxy&, const WebCore::URL&, CompletionHandler<void(WebCore::WebGLLoadPolicy)>&& completionHandler) const { completionHandler(WebCore::WebGLLoadPolicy::WebGLAllowCreation); }
130 #endif
131     
132     virtual bool willGoToBackForwardListItem(WebKit::WebPageProxy&, WebKit::WebBackForwardListItem&, bool inPageCache, Object*) { return false; }
133
134     virtual void didBeginNavigationGesture(WebKit::WebPageProxy&) { }
135     virtual void willEndNavigationGesture(WebKit::WebPageProxy&, bool willNavigate, WebKit::WebBackForwardListItem&) { }
136     virtual void didEndNavigationGesture(WebKit::WebPageProxy&, bool willNavigate, WebKit::WebBackForwardListItem&) { }
137     virtual void didRemoveNavigationGestureSnapshot(WebKit::WebPageProxy&) { }
138     virtual bool didChangeBackForwardList(WebKit::WebPageProxy&, WebKit::WebBackForwardListItem*, const Vector<Ref<WebKit::WebBackForwardListItem>>&) { return false; }
139 };
140
141 } // namespace API