1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CONTENT_BROWSER_RENDERER_HOST_NAVIGATOR_DELEGATE_H_
#define CONTENT_BROWSER_RENDERER_HOST_NAVIGATOR_DELEGATE_H_
#include "content/common/navigation_client.mojom.h"
#include "content/public/browser/allow_service_worker_result.h"
#include "content/public/browser/commit_deferring_condition.h"
#include "content/public/browser/cookie_access_details.h"
#include "content/public/browser/invalidate_type.h"
#include "content/public/browser/navigation_controller.h"
#include "content/public/browser/navigation_throttle.h"
#include "content/public/browser/navigation_ui_data.h"
#include "content/public/browser/reload_type.h"
#include "content/public/browser/trust_token_access_details.h"
class GURL;
namespace blink {
struct UserAgentOverride;
} // namespace blink
namespace network::mojom {
class SharedDictionaryAccessDetails;
} // namespace network::mojom
namespace content {
class CommitDeferringCondition;
class NavigationHandle;
class NavigationRequest;
class RenderFrameHostImpl;
struct LoadCommittedDetails;
struct OpenURLParams;
// A delegate API used by Navigator to notify its embedder of navigation
// related events.
class NavigatorDelegate {
public:
// Called when a navigation started. The same NavigationHandle will be
// provided for events related to the same navigation.
virtual void DidStartNavigation(NavigationHandle* navigation_handle) = 0;
// Called when a navigation was redirected.
virtual void DidRedirectNavigation(NavigationHandle* navigation_handle) = 0;
// Called when the navigation is about to be committed in a renderer.
virtual void ReadyToCommitNavigation(NavigationHandle* navigation_handle) = 0;
// Called when the navigation finished: it was either committed or canceled
// before commit. Note that |navigation_handle| will be destroyed at the end
// of this call.
virtual void DidFinishNavigation(NavigationHandle* navigation_handle) = 0;
// TODO(clamy): all methods below that are related to navigation
// events should go away in favor of the ones above.
// Handles post-navigation tasks in navigation BEFORE the entry has been
// committed to the NavigationController.
virtual void DidNavigateMainFramePreCommit(
FrameTreeNode* frame_tree_node,
bool navigation_is_within_page) = 0;
// Handles post-navigation tasks in navigation AFTER the entry has been
// committed to the NavigationController. Note that the NavigationEntry is
// not provided since it may be invalid/changed after being committed. The
// NavigationController's last committed entry is for this navigation.
virtual void DidNavigateMainFramePostCommit(
RenderFrameHostImpl* render_frame_host,
const LoadCommittedDetails& details) = 0;
virtual void DidNavigateAnyFramePostCommit(
RenderFrameHostImpl* render_frame_host,
const LoadCommittedDetails& details) = 0;
// Notification to the Navigator embedder that navigation state has
// changed. This method corresponds to
// WebContents::NotifyNavigationStateChanged.
virtual void NotifyChangedNavigationState(InvalidateTypes changed_flags) = 0;
// Opens a URL with the given parameters. See PageNavigator::OpenURL, which
// this is an alias of.
virtual WebContents* OpenURL(const OpenURLParams& params) = 0;
// Returns whether to continue a navigation that needs to transfer to a
// different process between the load start and commit.
virtual bool ShouldAllowRendererInitiatedCrossProcessNavigation(
bool is_outermost_main_frame_navigation) = 0;
// Returns the overridden user agent string if it's set.
virtual const blink::UserAgentOverride& GetUserAgentOverride() = 0;
// Returns the value to use for NavigationEntry::IsOverridingUserAgent() for
// a renderer initiated navigation.
virtual bool ShouldOverrideUserAgentForRendererInitiatedNavigation() = 0;
// Returns the NavigationThrottles to add to this navigation. Normally these
// are defined by the content/ embedder, except in the case of interstitials
// where no NavigationThrottles are added to the navigation.
virtual std::vector<std::unique_ptr<NavigationThrottle>>
CreateThrottlesForNavigation(NavigationHandle* navigation_handle) = 0;
// Returns commit deferring conditions to add to this navigation.
virtual std::vector<std::unique_ptr<CommitDeferringCondition>>
CreateDeferringConditionsForNavigationCommit(
NavigationHandle& navigation_handle,
CommitDeferringCondition::NavigationType type) = 0;
// Called at the start of the navigation to get opaque data the embedder
// wants to see passed to the corresponding URLRequest on the IO thread.
// In the case of a navigation to an interstitial, no call will be made to the
// embedder and |nullptr| is returned.
virtual std::unique_ptr<NavigationUIData> GetNavigationUIData(
NavigationHandle* navigation_handle) = 0;
// Called when a navigation accessed ServiceWorker to check if it should be
// handled by the ServiceWorker or not.
virtual void OnServiceWorkerAccessed(NavigationHandle* navigation,
const GURL& scope,
AllowServiceWorkerResult allowed) = 0;
// Called when a network request issued by this navigation set or read a
// cookie.
virtual void OnCookiesAccessed(NavigationHandle* navigation,
const CookieAccessDetails& details) = 0;
// Called when a network request issued by this navigation accesses a Trust
// Token.
virtual void OnTrustTokensAccessed(
NavigationHandle* navigation,
const TrustTokenAccessDetails& details) = 0;
// Called when a network request issued by this navigation accesses a shared
// dictionary.
virtual void OnSharedDictionaryAccessed(
NavigationHandle* navigation,
const network::mojom::SharedDictionaryAccessDetails& details) = 0;
// Does a global walk of the session history and all committed/pending-commit
// origins, and registers origins that match |origin| to their respective
// BrowsingInstances. |navigation_request_to_exclude| allows the
// NavigationRequest that initiates this process to avoid marking itself as
// non-opted-in before it gets the chance to opt-in.
virtual void RegisterExistingOriginAsHavingDefaultIsolation(
const url::Origin& origin,
NavigationRequest* navigation_request_to_exclude) = 0;
};
} // namespace content
#endif // CONTENT_BROWSER_RENDERER_HOST_NAVIGATOR_DELEGATE_H_
|
