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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
// Copyright 2020 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_PERMISSIONS_PERMISSIONS_CLIENT_H_
#define COMPONENTS_PERMISSIONS_PERMISSIONS_CLIENT_H_
#include "base/callback_forward.h"
#include "base/memory/weak_ptr.h"
#include "base/optional.h"
#include "build/build_config.h"
#include "components/content_settings/core/common/content_settings_types.h"
#include "components/permissions/permission_prompt.h"
#include "components/permissions/permission_util.h"
#include "services/metrics/public/cpp/ukm_source_id.h"
#include "url/origin.h"
#if defined(OS_ANDROID)
#include "base/android/scoped_java_ref.h"
#endif
class GURL;
class HostContentSettingsMap;
namespace content {
class BrowserContext;
class WebContents;
} // namespace content
namespace infobars {
class InfoBar;
class InfoBarManager;
} // namespace infobars
namespace permissions {
class ChooserContextBase;
class NotificationPermissionUiSelector;
class PermissionDecisionAutoBlocker;
class PermissionManager;
class PermissionPromptAndroid;
// Interface to be implemented by permissions embedder to access embedder
// specific logic.
class PermissionsClient {
public:
PermissionsClient(const PermissionsClient&) = delete;
PermissionsClient& operator=(const PermissionsClient&) = delete;
PermissionsClient();
virtual ~PermissionsClient();
// Return the permissions client.
static PermissionsClient* Get();
// Retrieves the HostContentSettingsMap for this context. The returned pointer
// has the same lifetime as |browser_context|.
virtual HostContentSettingsMap* GetSettingsMap(
content::BrowserContext* browser_context) = 0;
// Retrieves the PermissionDecisionAutoBlocker for this context. The returned
// pointer has the same lifetime as |browser_context|.
virtual PermissionDecisionAutoBlocker* GetPermissionDecisionAutoBlocker(
content::BrowserContext* browser_context) = 0;
// Retrieves the PermissionManager for this context. The returned
// pointer has the same lifetime as |browser_context|.
virtual PermissionManager* GetPermissionManager(
content::BrowserContext* browser_context) = 0;
// Gets the ChooserContextBase for the given type and context, which must be a
// *_CHOOSER_DATA value. May return null if the context does not exist.
virtual ChooserContextBase* GetChooserContext(
content::BrowserContext* browser_context,
ContentSettingsType type) = 0;
// Gets the embedder defined engagement score for this |origin|.
virtual double GetSiteEngagementScore(
content::BrowserContext* browser_context,
const GURL& origin);
// Determines whether some origins are "important". |origins| is an in-out
// param that passes in the list of origins which need judgment as the first
// item in each pair, and the determination of importance should be stored in
// the second item in the pair (true meaning important).
virtual void AreSitesImportant(
content::BrowserContext* browser_context,
std::vector<std::pair<url::Origin, bool>>* origins);
// Retrieves the ukm::SourceId (if any) associated with this |browser_context|
// and |web_contents|. |web_contents| may be null. |callback| will be called
// with the result, and may be run synchronously if the result is available
// immediately.
using GetUkmSourceIdCallback =
base::OnceCallback<void(base::Optional<ukm::SourceId>)>;
virtual void GetUkmSourceId(content::BrowserContext* browser_context,
const content::WebContents* web_contents,
const GURL& requesting_origin,
GetUkmSourceIdCallback callback);
// Returns the icon ID that should be used for permissions UI for |type|. If
// the embedder returns an empty IconId, the default icon for |type| will be
// used.
virtual PermissionRequest::IconId GetOverrideIconId(ContentSettingsType type);
// Allows the embedder to provide a selector for chossing the UI to use for
// notification permission requests. If the embedder returns null here, the
// normal UI will be used.
virtual std::unique_ptr<NotificationPermissionUiSelector>
CreateNotificationPermissionUiSelector(
content::BrowserContext* browser_context);
// Called for each request type when a permission prompt is resolved.
virtual void OnPromptResolved(content::BrowserContext* browser_context,
PermissionRequestType request_type,
PermissionAction action);
// If the embedder returns an origin here, any requests matching that origin
// will be approved. Requests that do not match the returned origin will
// immediately be finished without granting/denying the permission.
virtual base::Optional<url::Origin> GetAutoApprovalOrigin();
// Allows the embedder to bypass checking the embedding origin when performing
// permission availability checks. This is used for example when a permission
// should only be available on secure origins. Return true to bypass embedding
// origin checks for the passed in origins.
virtual bool CanBypassEmbeddingOriginCheck(const GURL& requesting_origin,
const GURL& embedding_origin);
// Allows embedder to override the canonical origin for a permission request.
// This is the origin that will be used for requesting/storing/displaying
// permissions.
virtual base::Optional<GURL> OverrideCanonicalOrigin(
const GURL& requesting_origin,
const GURL& embedding_origin);
#if defined(OS_ANDROID)
// Returns whether the permission is controlled by the default search
// engine (DSE). For example, in Chrome, making a search engine default
// automatically grants notification permissions for the associated origin.
virtual bool IsPermissionControlledByDse(
content::BrowserContext* browser_context,
ContentSettingsType type,
const url::Origin& origin);
// Resets the permission if it's controlled by the default search
// engine (DSE). The return value is true if the permission was reset.
virtual bool ResetPermissionIfControlledByDse(
content::BrowserContext* browser_context,
ContentSettingsType type,
const url::Origin& origin);
// Retrieves the InfoBarManager for the web contents. The returned
// pointer has the same lifetime as |web_contents|.
virtual infobars::InfoBarManager* GetInfoBarManager(
content::WebContents* web_contents);
// Allows the embedder to create an info bar to use as the permission prompt.
// Might return null based on internal logic (e.g. |type| does not support
// infobar permission prompts). The returned infobar is owned by the info bar
// manager.
virtual infobars::InfoBar* MaybeCreateInfoBar(
content::WebContents* web_contents,
ContentSettingsType type,
base::WeakPtr<PermissionPromptAndroid> prompt);
// Returns a handle to the Java counterpart of this class.
virtual base::android::ScopedJavaLocalRef<jobject> GetJavaObject();
// Converts the given chromium |resource_id| (e.g. IDR_INFOBAR_TRANSLATE) to
// an Android drawable resource ID. Returns 0 if a mapping wasn't found.
virtual int MapToJavaDrawableId(int resource_id);
#else
// Creates a permission prompt.
// TODO(crbug.com/1025609): Move the desktop permission prompt implementation
// into //components/permissions and remove this.
virtual std::unique_ptr<PermissionPrompt> CreatePrompt(
content::WebContents* web_contents,
PermissionPrompt::Delegate* delegate);
#endif
};
} // namespace permissions
#endif // COMPONENTS_PERMISSIONS_PERMISSIONS_CLIENT_H_
|
