File: embedded_permission_prompt_android.cc

package info (click to toggle)
chromium 139.0.7258.138-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,120,676 kB
  • sloc: cpp: 35,100,869; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (370 lines) | stat: -rw-r--r-- 14,468 bytes parent folder | download | duplicates (4)
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "components/permissions/android/permission_prompt/embedded_permission_prompt_android.h"

#include "base/android/jni_array.h"
#include "base/android/jni_string.h"
#include "base/memory/weak_ptr.h"
#include "components/permissions/android/permission_prompt/permission_dialog_delegate.h"
#include "components/permissions/features.h"
#include "components/permissions/permission_request.h"
#include "components/permissions/permissions_client.h"
#include "components/resources/android/theme_resources.h"
#include "components/strings/grit/components_strings.h"
#include "components/url_formatter/elide_url.h"
#include "content/public/browser/web_contents.h"
#include "ui/base/l10n/l10n_util.h"
#include "ui/strings/grit/ui_strings.h"

namespace permissions {

using Variant = EmbeddedPermissionPromptFlowModel::Variant;
using Action = permissions::EmbeddedPermissionPromptFlowModel::DelegateAction;
using base::android::ConvertUTF16ToJavaString;

EmbeddedPermissionPromptAndroid::EmbeddedPermissionPromptAndroid(
    content::WebContents* web_contents,
    Delegate* delegate)
    : PermissionPromptAndroid(web_contents, delegate) {
  prompt_model_ = std::make_unique<EmbeddedPermissionPromptFlowModel>(
      web_contents, delegate);
  prompt_model_->CalculateCurrentVariant();
  CreatePermissionDialogDelegate();

  const auto& current_prompt_variant = prompt_model_->prompt_variant();
  prompt_model_->RecordElementAnchoredBubbleVariantUMA(current_prompt_variant);
  if (current_prompt_variant == Variant::kOsPrompt ||
      current_prompt_variant == Variant::kOsSystemSettings) {
    prompt_model_->StartFirstDisplayTime();
  }
}

EmbeddedPermissionPromptAndroid::~EmbeddedPermissionPromptAndroid() {
  if (!prompt_model_->HasDelegateActionSet()) {
    prompt_model_->SetDelegateAction(Action::kDismiss);
  }
}

// static
std::unique_ptr<EmbeddedPermissionPromptAndroid>
EmbeddedPermissionPromptAndroid::Create(content::WebContents* web_contents,
                                        Delegate* delegate) {
  auto prompt =
      std::make_unique<EmbeddedPermissionPromptAndroid>(web_contents, delegate);
  if (!prompt->permission_dialog_delegate() ||
      prompt->permission_dialog_delegate()->IsJavaDelegateDestroyed()) {
    return nullptr;
  }
  return prompt;
}

PermissionPromptDisposition
EmbeddedPermissionPromptAndroid::GetPromptDisposition() const {
  return PermissionPromptDisposition::ELEMENT_ANCHORED_BUBBLE;
}

bool EmbeddedPermissionPromptAndroid::ShouldFinalizeRequestAfterDecided()
    const {
  return false;
}

std::optional<gfx::Rect>
EmbeddedPermissionPromptAndroid::GetViewBoundsInScreen() const {
  // This is a modal prompt, the view bounds will cover the whole content
  // view.
  return web_contents()->GetContainerBounds();
}

bool EmbeddedPermissionPromptAndroid::IsAskPrompt() const {
  return (GetEmbeddedPromptVariant() == Variant::kAsk);
}

std::vector<permissions::ElementAnchoredBubbleVariant>
EmbeddedPermissionPromptAndroid::GetPromptVariants() const {
  std::vector<permissions::ElementAnchoredBubbleVariant> variants;
  return prompt_model_->GetPromptVariants();
}

Variant EmbeddedPermissionPromptAndroid::GetEmbeddedPromptVariant() const {
  return prompt_model_->prompt_variant();
}

void EmbeddedPermissionPromptAndroid::Closing() {
  prompt_model_->PrecalculateVariantsForMetrics();
  // TODO(crbug.com/388408021): in Android, there will be no x button and more
  // than only one dismiss reason of clicking outside the dialog. We are
  // grouping all of them into one single type for now and might expose others
  // later.
  prompt_model_->RecordOsMetrics(permissions::OsScreenAction::kDismissedScrim);
  prompt_model_->RecordPermissionActionUKM(
      permissions::ElementAnchoredBubbleAction::kDismissedScrim);
  prompt_model_->SetDelegateAction(Action::kDismiss);
  delegate()->FinalizeCurrentRequests();
}

void EmbeddedPermissionPromptAndroid::Accept() {
  prompt_model_->PrecalculateVariantsForMetrics();
  prompt_model_->RecordPermissionActionUKM(
      permissions::ElementAnchoredBubbleAction::kGranted);
  prompt_model_->SetDelegateAction(Action::kAllow);
  MaybeUpdateDialogWithNewScreenVariant();
}

void EmbeddedPermissionPromptAndroid::Acknowledge() {
  prompt_model_->RecordPermissionActionUKM(
      permissions::ElementAnchoredBubbleAction::kOk);
  prompt_model_->SetDelegateAction(Action::kDismiss);
  delegate()->FinalizeCurrentRequests();
}

void EmbeddedPermissionPromptAndroid::AcceptThisTime() {
  prompt_model_->PrecalculateVariantsForMetrics();
  prompt_model_->RecordPermissionActionUKM(
      permissions::ElementAnchoredBubbleAction::kGrantedOnce);
  prompt_model_->SetDelegateAction(Action::kAllowThisTime);
  MaybeUpdateDialogWithNewScreenVariant();
}

void EmbeddedPermissionPromptAndroid::Deny() {
  prompt_model_->PrecalculateVariantsForMetrics();
  prompt_model_->RecordPermissionActionUKM(
      permissions::ElementAnchoredBubbleAction::kDenied);
  prompt_model_->SetDelegateAction(Action::kDeny);
  delegate()->FinalizeCurrentRequests();
}

void EmbeddedPermissionPromptAndroid::Resumed() {
  MaybeUpdateDialogWithNewScreenVariant();
}

void EmbeddedPermissionPromptAndroid::SystemSettingsShown() {
  prompt_model_->RecordOsMetrics(permissions::OsScreenAction::kSystemSettings);
  prompt_model_->RecordPermissionActionUKM(
      permissions::ElementAnchoredBubbleAction::kSystemSettings);
}

void EmbeddedPermissionPromptAndroid::SystemPermissionResolved(bool accepted) {
  if (accepted) {
    prompt_model_->RecordOsMetrics(
        permissions::OsScreenAction::kOsPromptAllowed);
    MaybeUpdateDialogWithNewScreenVariant();
  } else {
    prompt_model_->PrecalculateVariantsForMetrics();
    prompt_model_->RecordOsMetrics(
        permissions::OsScreenAction::kOsPromptDenied);
    prompt_model_->SetDelegateAction(Action::kDismiss);
    delegate()->FinalizeCurrentRequests();
  }
}

bool EmbeddedPermissionPromptAndroid::ShouldCurrentRequestUseQuietUI() {
  return false;
}

std::optional<PermissionUiSelector::QuietUiReason>
EmbeddedPermissionPromptAndroid::ReasonForUsingQuietUi() const {
  return std::nullopt;
}

PermissionRequest::AnnotatedMessageText
EmbeddedPermissionPromptAndroid::GetAnnotatedMessageText() const {
  switch (GetEmbeddedPromptVariant()) {
    case Variant::kAsk: {
      const auto& requests = Requests();
      if (requests.size() == 1) {
        return requests[0]->GetDialogAnnotatedMessageText(
            delegate()->GetEmbeddingOrigin());
      }
      CheckValidRequestGroup(requests);
      return GetDialogAnnotatedMessageTextWithOrigin(
          IDS_MEDIA_CAPTURE_AUDIO_AND_VIDEO_INFOBAR_TEXT);
    }
    case Variant::kAdministratorGranted:
      return PermissionRequest::AnnotatedMessageText(
          l10n_util::GetStringFUTF16(IDS_EMBEDDED_PROMPT_ADMIN_ALLOWED,
                                     GetPermissionNameTextFragment()),
          /*bolded_ranges=*/{});
    case Variant::kPreviouslyGranted:
      return PermissionRequest::AnnotatedMessageText(
          l10n_util::GetStringFUTF16(IDS_EMBEDDED_PROMPT_PREVIOUSLY_ALLOWED,
                                     GetPermissionNameTextFragment()),
          /*bolded_ranges=*/{});
    case Variant::kOsSystemSettings:
      return PermissionRequest::AnnotatedMessageText(
          l10n_util::GetStringFUTF16(
              IDS_PERMISSION_OFF_FOR_CHROME, GetPermissionNameTextFragment(),
              PermissionsClient::Get()->GetClientApplicationName()),
          /*bolded_ranges=*/{});
    case Variant::kPreviouslyDenied:
      return PermissionRequest::AnnotatedMessageText(
          l10n_util::GetStringFUTF16(IDS_EMBEDDED_PROMPT_PREVIOUSLY_NOT_ALLOWED,
                                     GetPermissionNameTextFragment()),
          /*bolded_ranges=*/{});
    case Variant::kAdministratorDenied:
      return PermissionRequest::AnnotatedMessageText(
          l10n_util::GetStringFUTF16(IDS_EMBEDDED_PROMPT_ADMIN_BLOCKED,
                                     GetPermissionNameTextFragment()),
          /*bolded_ranges=*/{});
    case Variant::kOsPrompt:
      return PermissionRequest::AnnotatedMessageText(std::u16string(),
                                                     /*bolded_ranges=*/{});
    case Variant::kUninitialized:
      NOTREACHED();
  }
  NOTREACHED();
}

base::android::ScopedJavaLocalRef<jstring>
EmbeddedPermissionPromptAndroid::GetPositiveButtonText(JNIEnv* env,
                                                       bool is_one_time) const {
  switch (GetEmbeddedPromptVariant()) {
    case Variant::kAsk:
      return is_one_time
                 ? ConvertUTF16ToJavaString(
                       env, l10n_util::GetStringUTF16(
                                IDS_PERMISSION_ALLOW_WHILE_VISITING))
                 : ConvertUTF16ToJavaString(
                       env, l10n_util::GetStringUTF16(IDS_PERMISSION_ALLOW));

    case Variant::kPreviouslyGranted:
      return ConvertUTF16ToJavaString(
          env,
          l10n_util::GetStringUTF16(IDS_EMBEDDED_PROMPT_CONTINUE_ALLOWING));
    case Variant::kOsSystemSettings:
      return ConvertUTF16ToJavaString(
          env, l10n_util::GetStringFUTF16(
                   IDS_EMBEDDED_PROMPT_OPEN_SYSTEM_SETTINGS,
                   l10n_util::GetStringUTF16(IDS_ANDROID_NAME_FRAGMENT)));
    case Variant::kPreviouslyDenied:
      return ConvertUTF16ToJavaString(
          env,
          l10n_util::GetStringUTF16(IDS_EMBEDDED_PROMPT_CONTINUE_NOT_ALLOWING));
    case Variant::kAdministratorDenied:
    case Variant::kAdministratorGranted:
    case Variant::kOsPrompt:
      return ConvertUTF16ToJavaString(env, std::u16string_view());
    case Variant::kUninitialized:
      NOTREACHED();
  }
  NOTREACHED();
}

base::android::ScopedJavaLocalRef<jstring>
EmbeddedPermissionPromptAndroid::GetNegativeButtonText(JNIEnv* env,
                                                       bool is_one_time) const {
  switch (GetEmbeddedPromptVariant()) {
    case Variant::kAsk:
      return ConvertUTF16ToJavaString(
          env, l10n_util::GetStringUTF16(IDS_PERMISSION_DONT_ALLOW));
    case Variant::kPreviouslyGranted:
      return ConvertUTF16ToJavaString(
          env, l10n_util::GetStringUTF16(IDS_EMBEDDED_PROMPT_STOP_ALLOWING));
    case Variant::kOsSystemSettings:
      return ConvertUTF16ToJavaString(
          env, l10n_util::GetStringUTF16(IDS_EMBEDDED_PROMPT_CANCEL_LABEL));
    case Variant::kPreviouslyDenied:
      return ConvertUTF16ToJavaString(
          env, l10n_util::GetStringUTF16(IDS_PERMISSION_ALLOW_THIS_TIME));
    case Variant::kAdministratorGranted:
    case Variant::kAdministratorDenied:
      return ConvertUTF16ToJavaString(
          env, l10n_util::GetStringUTF16(IDS_EMBEDDED_PROMPT_OK_LABEL));
    case Variant::kOsPrompt:
      return ConvertUTF16ToJavaString(env, std::u16string_view());
    case Variant::kUninitialized:
      NOTREACHED();
  }
  NOTREACHED();
}
base::android::ScopedJavaLocalRef<jstring>
EmbeddedPermissionPromptAndroid::GetPositiveEphemeralButtonText(
    JNIEnv* env,
    bool is_one_time) const {
  if (!is_one_time || GetEmbeddedPromptVariant() !=
                          EmbeddedPermissionPromptFlowModel::Variant::kAsk) {
    return ConvertUTF16ToJavaString(env, std::u16string_view());
  }

  return ConvertUTF16ToJavaString(
      env, l10n_util::GetStringUTF16(IDS_PERMISSION_ALLOW_THIS_TIME));
}

base::android::ScopedJavaLocalRef<jobjectArray>
EmbeddedPermissionPromptAndroid::GetRadioButtonTexts(JNIEnv* env,
                                                     bool is_one_time) const {
  return base::android::ToJavaArrayOfStrings(env, base::span<std::string>());
}

bool EmbeddedPermissionPromptAndroid::ShouldUseRequestingOriginFavicon() const {
  return false;
}

const std::vector<base::WeakPtr<permissions::PermissionRequest>>&
EmbeddedPermissionPromptAndroid::Requests() const {
  return prompt_model_->requests();
}

int EmbeddedPermissionPromptAndroid::GetIconId() const {
  if (prompt_model_->prompt_variant() == Variant::kAdministratorDenied ||
      prompt_model_->prompt_variant() == Variant::kAdministratorGranted) {
    return IDR_BUSINESS;
  }
  return PermissionPromptAndroid::GetIconId();
}

void EmbeddedPermissionPromptAndroid::MaybeUpdateDialogWithNewScreenVariant() {
  const auto& old_prompt_variant = prompt_model_->prompt_variant();
  prompt_model_->CalculateCurrentVariant();
  const auto& current_prompt_variant = prompt_model_->prompt_variant();
  if (current_prompt_variant == Variant::kPreviouslyGranted) {
    // Here the whole permission flow has already ended with permission allowed.
    // It's necessary to notify to Java side, for example to update omnibox
    // icon.
    permission_dialog_delegate()->NotifyPermissionAllowed();
    // TODO(crbug.com/374282626): change on renderer side, dispatching event not
    // simply following the action on the dialog but respecting how the
    // permission status change. Then we should translate the dismiss here to
    // "resolve" event if needed.
    prompt_model_->SetDelegateAction(Action::kDismiss);
    delegate()->FinalizeCurrentRequests();
    return;
  }
  if (current_prompt_variant != old_prompt_variant) {
    permission_dialog_delegate()->UpdateDialog();
    prompt_model_->RecordElementAnchoredBubbleVariantUMA(
        current_prompt_variant);
  }

  if (current_prompt_variant == Variant::kOsPrompt ||
      current_prompt_variant == Variant::kOsSystemSettings) {
    prompt_model_->StartFirstDisplayTime();
  }
}

PermissionRequest::AnnotatedMessageText
EmbeddedPermissionPromptAndroid::GetDialogAnnotatedMessageTextWithOrigin(
    int message_id) const {
  return PermissionRequest::GetDialogAnnotatedMessageText(
      url_formatter::FormatUrlForSecurityDisplay(
          delegate()->GetRequestingOrigin(),
          url_formatter::SchemeDisplay::OMIT_CRYPTOGRAPHIC),
      message_id,
      /*format_origin_bold=*/
      true);
}

std::u16string EmbeddedPermissionPromptAndroid::GetPermissionNameTextFragment()
    const {
  const auto& requests = Requests();
  std::u16string permission_name;
  if (requests.size() == 1) {
    return requests[0]->GetPermissionNameTextFragment();
  }
  CheckValidRequestGroup(requests);
  return l10n_util::GetStringUTF16(
      IDS_CAMERA_AND_MICROPHONE_PERMISSION_NAME_FRAGMENT);
}

}  // namespace permissions