Pass a completion handler instead of a WebFramePolicyListenerProxy during policy...
[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 "DownloadID.h"
30 #include "PluginModuleInfo.h"
31 #include "ProcessTerminationReason.h"
32 #include "SameDocumentNavigationType.h"
33 #include "WebEvent.h"
34 #include "WebsitePolicies.h"
35 #include <WebCore/FrameLoaderTypes.h>
36 #include <WebCore/LayoutMilestones.h>
37 #include <wtf/Forward.h>
38
39 namespace WebCore {
40 class ResourceError;
41 class ResourceRequest;
42 class ResourceResponse;
43 class URL;
44 struct SecurityOriginData;
45 }
46
47 namespace WebKit {
48 class AuthenticationChallengeProxy;
49 class DownloadID;
50 class QuickLookDocumentData;
51 class WebBackForwardListItem;
52 class WebFrameProxy;
53 class WebPageProxy;
54 class WebProtectionSpace;
55 struct NavigationActionData;
56 struct WebNavigationDataStore;
57 }
58
59 namespace API {
60
61 class Dictionary;
62 class Navigation;
63 class NavigationAction;
64 class NavigationResponse;
65 class Object;
66
67 class NavigationClient {
68 public:
69     virtual ~NavigationClient() { }
70
71     virtual void didStartProvisionalNavigation(WebKit::WebPageProxy&, Navigation*, Object*) { }
72     virtual void didReceiveServerRedirectForProvisionalNavigation(WebKit::WebPageProxy&, Navigation*, Object*) { }
73     virtual void willPerformClientRedirect(WebKit::WebPageProxy&, const WTF::String&, double) { }
74     virtual void didCancelClientRedirect(WebKit::WebPageProxy&) { }
75     virtual void didFailProvisionalNavigationWithError(WebKit::WebPageProxy&, WebKit::WebFrameProxy&, Navigation*, const WebCore::ResourceError&, Object*) { }
76     virtual void didFailProvisionalLoadInSubframeWithError(WebKit::WebPageProxy&, WebKit::WebFrameProxy&, const WebCore::SecurityOriginData&, Navigation*, const WebCore::ResourceError&, Object*) { }
77     virtual void didCommitNavigation(WebKit::WebPageProxy&, Navigation*, Object*) { }
78     virtual void didFinishDocumentLoad(WebKit::WebPageProxy&, Navigation*, Object*) { }
79     virtual void didFinishNavigation(WebKit::WebPageProxy&, Navigation*, Object*) { }
80     virtual void didFailNavigationWithError(WebKit::WebPageProxy&, WebKit::WebFrameProxy&, Navigation*, const WebCore::ResourceError&, Object*) { }
81     virtual void didSameDocumentNavigation(WebKit::WebPageProxy&, Navigation*, WebKit::SameDocumentNavigationType, Object*) { }
82
83     virtual void renderingProgressDidChange(WebKit::WebPageProxy&, WebCore::LayoutMilestones) { }
84
85     virtual bool canAuthenticateAgainstProtectionSpace(WebKit::WebPageProxy&, WebKit::WebProtectionSpace*) { return false; }
86     virtual void didReceiveAuthenticationChallenge(WebKit::WebPageProxy&, WebKit::AuthenticationChallengeProxy*) { }
87
88     // FIXME: These function should not be part of this client.
89     virtual void processDidTerminate(WebKit::WebPageProxy&, WebKit::ProcessTerminationReason) { }
90     virtual void processDidBecomeResponsive(WebKit::WebPageProxy&) { }
91     virtual void processDidBecomeUnresponsive(WebKit::WebPageProxy&) { }
92
93     virtual RefPtr<Data> webCryptoMasterKey(WebKit::WebPageProxy&) { return nullptr; }
94
95 #if USE(QUICK_LOOK)
96     virtual void didStartLoadForQuickLookDocumentInMainFrame(const WTF::String& fileName, const WTF::String& uti) { }
97     virtual void didFinishLoadForQuickLookDocumentInMainFrame(const WebKit::QuickLookDocumentData&) { }
98 #endif
99
100     virtual void decidePolicyForNavigationAction(WebKit::WebPageProxy&, Ref<NavigationAction>&&, Function<void(WebCore::PolicyAction, std::optional<WebKit::WebsitePolicies>&&)>&& completionHandler, Object*)
101     {
102         completionHandler(WebCore::PolicyAction::Use, std::nullopt);
103     }
104
105     virtual void decidePolicyForNavigationResponse(WebKit::WebPageProxy&, NavigationResponse&, Function<void(WebCore::PolicyAction, std::optional<WebKit::WebsitePolicies>&&)>&& completionHandler, Object*)
106     {
107         completionHandler(WebCore::PolicyAction::Use, std::nullopt);
108     }
109     
110 #if ENABLE(NETSCAPE_PLUGIN_API)
111     virtual WebKit::PluginModuleLoadPolicy decidePolicyForPluginLoad(WebKit::WebPageProxy&, WebKit::PluginModuleLoadPolicy currentPluginLoadPolicy, Dictionary*, WTF::String&)
112     {
113         return currentPluginLoadPolicy;
114     }
115 #endif
116
117 #if ENABLE(WEBGL)
118     virtual void webGLLoadPolicy(WebKit::WebPageProxy&, const WebCore::URL&, WTF::Function<void(WebCore::WebGLLoadPolicy)>&& completionHandler) const { completionHandler(WebCore::WebGLLoadPolicy::WebGLAllowCreation); }
119     virtual void resolveWebGLLoadPolicy(WebKit::WebPageProxy&, const WebCore::URL&, WTF::Function<void(WebCore::WebGLLoadPolicy)>&& completionHandler) const { completionHandler(WebCore::WebGLLoadPolicy::WebGLAllowCreation); }
120 #endif
121
122     virtual void didBeginNavigationGesture(WebKit::WebPageProxy&) { }
123     virtual void willEndNavigationGesture(WebKit::WebPageProxy&, bool willNavigate, WebKit::WebBackForwardListItem&) { }
124     virtual void didEndNavigationGesture(WebKit::WebPageProxy&, bool willNavigate, WebKit::WebBackForwardListItem&) { }
125     virtual void didRemoveNavigationGestureSnapshot(WebKit::WebPageProxy&) { }
126 };
127
128 } // namespace API