File: extensions_menu_site_permissions_page_view.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; 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 (455 lines) | stat: -rw-r--r-- 22,182 bytes parent folder | download | duplicates (3)
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
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/browser/ui/views/extensions/extensions_menu_site_permissions_page_view.h"

#include <algorithm>
#include <string>

#include "base/memory/raw_ptr.h"
#include "chrome/browser/extensions/permissions/site_permissions_helper.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/browser/ui/chrome_pages.h"
#include "chrome/browser/ui/color/chrome_color_id.h"
#include "chrome/browser/ui/views/chrome_layout_provider.h"
#include "chrome/browser/ui/views/controls/hover_button.h"
#include "chrome/browser/ui/views/extensions/extensions_dialogs_utils.h"
#include "chrome/browser/ui/views/extensions/extensions_menu_handler.h"
#include "chrome/grit/generated_resources.h"
#include "components/strings/grit/components_strings.h"
#include "components/vector_icons/vector_icons.h"
#include "content/public/browser/web_contents.h"
#include "extensions/browser/permissions_manager.h"
#include "extensions/common/extension.h"
#include "extensions/common/extension_id.h"
#include "ui/base/l10n/l10n_util.h"
#include "ui/base/metadata/metadata_impl_macros.h"
#include "ui/base/models/image_model.h"
#include "ui/gfx/geometry/insets.h"
#include "ui/views/accessibility/view_accessibility.h"
#include "ui/views/border.h"
#include "ui/views/bubble/bubble_frame_view.h"
#include "ui/views/controls/button/button.h"
#include "ui/views/controls/button/image_button.h"
#include "ui/views/controls/button/image_button_factory.h"
#include "ui/views/controls/button/radio_button.h"
#include "ui/views/controls/button/toggle_button.h"
#include "ui/views/controls/highlight_path_generator.h"
#include "ui/views/controls/image_view.h"
#include "ui/views/controls/label.h"
#include "ui/views/controls/separator.h"
#include "ui/views/layout/box_layout.h"
#include "ui/views/layout/box_layout_view.h"
#include "ui/views/layout/flex_layout_view.h"
#include "ui/views/layout/layout_provider.h"
#include "ui/views/layout/layout_types.h"
#include "ui/views/metadata/view_factory_internal.h"
#include "ui/views/style/typography.h"
#include "ui/views/view_class_properties.h"
#include "ui/views/view_utils.h"

namespace {

using extensions::PermissionsManager;

// Radio buttons group id for site permissions.
constexpr int kSiteAccessButtonsId = 0;
// Indexes for each site permission radio button.
constexpr size_t kOnClickButtonIndex = 0;
constexpr size_t kOnSiteButtonIndex = 1;
constexpr size_t kOnAllSitesButtonIndex = 2;

// Returns the site access button in a site permissions `page`.
std::vector<views::RadioButton*> GetSiteAccessButtons(views::View* page) {
  std::vector<raw_ptr<views::View, VectorExperimental>> buttons;
  page->GetViewsInGroup(kSiteAccessButtonsId, &buttons);

  std::vector<views::RadioButton*> site_access_buttons;
  site_access_buttons.reserve(buttons.size());

  std::ranges::transform(
      buttons, std::back_inserter(site_access_buttons),
      [](views::View* button) {
        return views::AsViewClass<views::RadioButton>(button);
      });
  return site_access_buttons;
}

std::u16string GetShowRequestsToggleAccessibleName(bool is_toggle_on) {
  int label_id =
      is_toggle_on
          ? IDS_EXTENSIONS_MENU_SITE_PERMISSIONS_PAGE_SHOW_REQUESTS_TOGGLE_ON
          : IDS_EXTENSIONS_MENU_SITE_PERMISSIONS_PAGE_SHOW_REQUESTS_TOGGLE_OFF;
  return l10n_util::GetStringUTF16(label_id);
}

// Returns the radio button text for `site_access` option.
std::u16string GetSiteAccessRadioButtonText(
    PermissionsManager::UserSiteAccess site_access,
    std::u16string current_site = std::u16string()) {
  switch (site_access) {
    case PermissionsManager::UserSiteAccess::kOnClick:
      return l10n_util::GetStringUTF16(
          IDS_EXTENSIONS_MENU_SITE_PERMISSIONS_PAGE_SITE_ACCESS_ON_CLICK_TEXT);
    case PermissionsManager::UserSiteAccess::kOnSite:
      return l10n_util::GetStringFUTF16(
          IDS_EXTENSIONS_MENU_SITE_PERMISSIONS_PAGE_SITE_ACCESS_ON_SITE_TEXT,
          current_site);
    case PermissionsManager::UserSiteAccess::kOnAllSites:
      return l10n_util::GetStringUTF16(
          IDS_EXTENSIONS_MENU_SITE_PERMISSIONS_PAGE_SITE_ACCESS_ON_ALL_SITES_TEXT);
    default:
      NOTREACHED();
  }
}

// Returns the radio button description for `site_access` option.
std::u16string GetSiteAccessRadioButtonDescription(
    PermissionsManager::UserSiteAccess site_access) {
  switch (site_access) {
    case PermissionsManager::UserSiteAccess::kOnClick:
      return l10n_util::GetStringUTF16(
          IDS_EXTENSIONS_MENU_SITE_PERMISSIONS_PAGE_SITE_ACCESS_ON_CLICK_DESCRIPTION);
    case PermissionsManager::UserSiteAccess::kOnSite:
      return l10n_util::GetStringUTF16(
          IDS_EXTENSIONS_MENU_SITE_PERMISSIONS_PAGE_SITE_ACCESS_ON_SITE_DESCRIPTION);
    case PermissionsManager::UserSiteAccess::kOnAllSites:
      return l10n_util::GetStringUTF16(
          IDS_EXTENSIONS_MENU_SITE_PERMISSIONS_PAGE_SITE_ACCESS_ON_ALL_SITES_DESCRIPTION);
    default:
      NOTREACHED();
  }
}

// Returns the button index for `site_access`.
int GetSiteAccessButtonIndex(PermissionsManager::UserSiteAccess site_access) {
  switch (site_access) {
    case PermissionsManager::UserSiteAccess::kOnClick:
      return kOnClickButtonIndex;
    case PermissionsManager::UserSiteAccess::kOnSite:
      return kOnSiteButtonIndex;
    case PermissionsManager::UserSiteAccess::kOnAllSites:
      return kOnAllSitesButtonIndex;
  }
}

// Returns the icon for the setting button.
std::unique_ptr<views::ImageView> GetSettingsButtonIcon(int icon_size) {
  return std::make_unique<views::ImageView>(ui::ImageModel::FromVectorIcon(
      vector_icons::kSubmenuArrowChromeRefreshIcon, ui::kColorIconSecondary,
      icon_size));
}

}  // namespace

ExtensionsMenuSitePermissionsPageView::ExtensionsMenuSitePermissionsPageView(
    Browser* browser,
    extensions::ExtensionId extension_id,
    ExtensionsMenuHandler* menu_handler)
    : browser_(browser), extension_id_(extension_id) {
  // TODO(crbug.com/40879945): Same stretch specification as
  // ExtensionsMenuMainPageView. Move to a shared file.
  views::FlexSpecification stretch_specification =
      views::FlexSpecification(views::LayoutOrientation::kHorizontal,
                               views::MinimumFlexSizeRule::kScaleToZero,
                               views::MaximumFlexSizeRule::kUnbounded)
          .WithWeight(1);

  views::LayoutProvider* layout_provider = views::LayoutProvider::Get();
  const gfx::Insets dialog_insets =
      layout_provider->GetInsetsMetric(views::InsetsMetric::INSETS_DIALOG);
  // Back button should use a vector image button, and this value should be the
  // same as the border added by the image button factory.
  const gfx::Insets back_button_border = layout_provider->GetInsetsMetric(
      views::InsetsMetric::INSETS_VECTOR_IMAGE_BUTTON);

  ChromeLayoutProvider* const chrome_layout_provider =
      ChromeLayoutProvider::Get();
  const int icon_size = chrome_layout_provider->GetDistanceMetric(
      DISTANCE_EXTENSIONS_MENU_BUTTON_ICON_SIZE);
  const int horizontal_spacing = chrome_layout_provider->GetDistanceMetric(
      DISTANCE_RELATED_LABEL_HORIZONTAL_LIST);
  const int vertical_spacing = chrome_layout_provider->GetDistanceMetric(
      DISTANCE_UNRELATED_CONTROL_VERTICAL_LARGE);
  // This value must be the same as the `HoverButton` vertical margin.
  const int hover_button_vertical_spacing =
      chrome_layout_provider->GetDistanceMetric(
          views::DISTANCE_CONTROL_LIST_VERTICAL) /
      2;

  // Views that need configuration after construction (e.g access size after a
  // separate view is constructed).
  views::Label* toggle_label;

  const auto create_separator_builder =
      [dialog_insets, vertical_spacing, hover_button_vertical_spacing](
          bool full_width, bool is_bottom_hover_button = false) {
        const int horizontal_margin = full_width ? 0 : dialog_insets.left();
        const int bottom_margin =
            is_bottom_hover_button
                ? vertical_spacing - hover_button_vertical_spacing
                : vertical_spacing;

        return views::Builder<views::Separator>().SetProperty(
            views::kMarginsKey,
            gfx::Insets::TLBR(vertical_spacing, horizontal_margin,
                              bottom_margin, horizontal_margin));
      };

  const auto create_radio_button_builder =
      [=](PermissionsManager::UserSiteAccess site_access) {
        return views::Builder<views::BoxLayoutView>()
            .SetOrientation(views::BoxLayout::Orientation::kVertical)
            // Add dialog horizontal margins, and top margin to separate the
            // items.
            .SetProperty(
                views::kMarginsKey,
                gfx::Insets::TLBR(vertical_spacing, dialog_insets.left(), 0,
                                  dialog_insets.right()))
            .AddChildren(
                views::Builder<views::RadioButton>()
                    .SetText(GetSiteAccessRadioButtonText(site_access))
                    .SetLabelStyle(views::style::STYLE_BODY_3)
                    .SetEnabledTextColors(kColorExtensionsMenuText)
                    .SetGroup(kSiteAccessButtonsId)
                    // To align the radio button icon under the header back
                    // button we add the back button border to the
                    // left of the icon.
                    .SetProperty(
                        views::kMarginsKey,
                        gfx::Insets::TLBR(0, back_button_border.left(), 0, 0))
                    // To align the radio button text under the header label
                    // we add the back button border and horizontal spacing in
                    // between the radio button icon and label.
                    .SetImageLabelSpacing(back_button_border.right() +
                                          horizontal_spacing)
                    .SetCallback(base::BindRepeating(
                        &ExtensionsMenuHandler::OnSiteAccessSelected,
                        base::Unretained(menu_handler), extension_id,
                        site_access)),
                views::Builder<views::Label>()
                    .SetText(GetSiteAccessRadioButtonDescription(site_access))
                    .SetTextStyle(views::style::STYLE_BODY_5)
                    .SetEnabledColor(kColorExtensionsMenuSecondaryText)
                    .SetHorizontalAlignment(gfx::ALIGN_LEFT)
                    .SetMultiLine(true)
                    .SetBorder(views::CreateEmptyBorder(gfx::Insets::VH(
                        0, icon_size + back_button_border.left() +
                               back_button_border.right() +
                               horizontal_spacing))));
      };

  views::Builder<ExtensionsMenuSitePermissionsPageView>(this)
      .SetLayoutManager(std::make_unique<views::BoxLayout>(
          views::BoxLayout::Orientation::kVertical))
      .AddChildren(
          // Header.
          views::Builder<views::FlexLayoutView>()
              // Add top dialog margins, since its the first element, and
              // horizontal dialog margins. Vertical margins will be handled
              // in between the contents.
              .SetInteriorMargin(gfx::Insets::TLBR(dialog_insets.top(),
                                                   dialog_insets.left(), 0,
                                                   dialog_insets.right()))
              .AddChildren(
                  // Back button.
                  views::Builder<views::ImageButton>(
                      views::CreateVectorImageButtonWithNativeTheme(
                          base::BindRepeating(
                              &ExtensionsMenuHandler::OpenMainPage,
                              base::Unretained(menu_handler)),
                          vector_icons::kArrowBackIcon, icon_size))
                      .SetTooltipText(
                          l10n_util::GetStringUTF16(IDS_ACCNAME_BACK))
                      .SetAccessibleName(
                          l10n_util::GetStringUTF16(IDS_ACCNAME_BACK))
                      .CustomConfigure(
                          base::BindOnce([](views::ImageButton* view) {
                            InstallCircleHighlightPathGenerator(view);
                          })),
                  // Extension name.
                  views::Builder<views::FlexLayoutView>()
                      .SetOrientation(views::LayoutOrientation::kHorizontal)
                      .SetCrossAxisAlignment(views::LayoutAlignment::kStretch)
                      .SetProperty(views::kFlexBehaviorKey,
                                   stretch_specification)
                      .AddChildren(
                          views::Builder<views::ImageView>()
                              .CopyAddressTo(&extension_icon_)
                              .SetProperty(views::kMarginsKey,
                                           gfx::Insets::TLBR(
                                               0, horizontal_spacing, 0, 0)),
                          views::Builder<views::Label>()
                              .CopyAddressTo(&extension_name_)
                              .SetTextStyle(views::style::STYLE_HEADLINE_4)
                              .SetEnabledColor(
                                  kColorExtensionsMenuSecondaryText)
                              .SetProperty(views::kMarginsKey,
                                           gfx::Insets::TLBR(
                                               0, horizontal_spacing, 0, 0))
                              .SetElideBehavior(gfx::ELIDE_TAIL)
                              .SetProperty(views::kFlexBehaviorKey,
                                stretch_specification)),
                  // Close button.
                  views::Builder<views::Button>(
                      views::BubbleFrameView::CreateCloseButton(
                          base::BindRepeating(
                              &ExtensionsMenuHandler::CloseBubble,
                              base::Unretained(menu_handler))))),
          create_separator_builder(/*full_width=*/true,
                                   /*is_bottom_hover_button=*/false),
          // Content.
          views::Builder<views::BoxLayoutView>()
              .SetOrientation(views::BoxLayout::Orientation::kVertical)
              .AddChildren(
                  // Site access section.
                  views::Builder<views::Label>()
                      // Add dialog horizontal margins. Vertical margins are
                      // handled by surrounding views.
                      .SetProperty(views::kMarginsKey,
                                   gfx::Insets::VH(0, dialog_insets.left()))
                      .SetText(l10n_util::GetStringUTF16(
                          IDS_EXTENSIONS_MENU_SITE_PERMISSIONS_PAGE_SITE_ACCESS_LABEL))
                      .SetTextStyle(views::style::STYLE_BODY_3_EMPHASIS)
                      .SetEnabledColor(kColorExtensionsMenuText)
                      .SetHorizontalAlignment(gfx::ALIGN_LEFT),
                  create_radio_button_builder(
                      PermissionsManager::UserSiteAccess::kOnClick),
                  create_radio_button_builder(
                      PermissionsManager::UserSiteAccess::kOnSite),
                  create_radio_button_builder(
                      PermissionsManager::UserSiteAccess::kOnAllSites),
                  // Requests in toolbar toggle.
                  create_separator_builder(/*full_width=*/false),
                  views::Builder<views::FlexLayoutView>()
                      .SetCrossAxisAlignment(views::LayoutAlignment::kStart)
                      // Add dialog horizontal margins. Vertical margins are
                      // handled by separators.
                      .SetProperty(views::kMarginsKey,
                                   gfx::Insets::VH(0, dialog_insets.left()))
                      .AddChildren(
                          views::Builder<views::Label>()
                              .CopyAddressTo(&toggle_label)
                              .SetText(l10n_util::GetStringUTF16(
                                  IDS_EXTENSIONS_MENU_SITE_PERMISSIONS_PAGE_SHOW_REQUESTS_LABEL))
                              .SetTextStyle(views::style::STYLE_BODY_3_EMPHASIS)
                              .SetEnabledColor(kColorExtensionsMenuText)
                              .SetProperty(views::kFlexBehaviorKey,
                                           stretch_specification)
                              .SetHorizontalAlignment(gfx::ALIGN_LEFT),
                          views::Builder<views::ToggleButton>()
                              .CopyAddressTo(&show_requests_toggle_)
                              .SetCallback(base::BindRepeating(
                                  [](const extensions::ExtensionId&
                                         extension_id,
                                     views::ToggleButton* toggle_button,
                                     base::RepeatingCallback<void(
                                         const extensions::ExtensionId&, bool)>
                                         callback) {
                                    callback.Run(extension_id,
                                                 toggle_button->GetIsOn());
                                  },
                                  extension_id_, show_requests_toggle_,
                                  base::BindRepeating(
                                      &ExtensionsMenuHandler::
                                          OnShowRequestsTogglePressed,
                                      base::Unretained(menu_handler))))),
                  // Settings button.
                  create_separator_builder(/*full_width=*/false,
                                           /*is_bottom_hover_button=*/true),
                  views::Builder<HoverButton>(
                      std::make_unique<HoverButton>(
                          base::BindRepeating(
                              [](Browser* browser,
                                 extensions::ExtensionId extension_id) {
                                chrome::ShowExtensions(browser, extension_id);
                              },
                              browser, extension_id_),
                          /*icon_view=*/nullptr,
                          l10n_util::GetStringUTF16(
                              IDS_EXTENSIONS_MENU_SITE_PERMISSIONS_PAGE_SETTINGS_BUTTON),
                          /*subtitle=*/std::u16string(),
                          GetSettingsButtonIcon(icon_size)))
                      .SetTitleTextStyle(views::style::STYLE_BODY_3_EMPHASIS,
                                         ui::kColorDialogBackground,
                                         kColorExtensionsMenuText)
                      // Align the hover button text by adding the dialog
                      // horizontal margins for the horizontal borders.
                      .SetBorder(views::CreateEmptyBorder(
                          gfx::Insets::VH(0, dialog_insets.left())))
                      // Add bottom dialog margins since it's the last
                      // element.
                      .SetProperty(
                          views::kMarginsKey,
                          gfx::Insets::TLBR(0, 0,
                                            dialog_insets.bottom() -
                                                hover_button_vertical_spacing,
                                            0))
                      .SetTooltipText(l10n_util::GetStringUTF16(
                          IDS_EXTENSIONS_MENU_SITE_PERMISSIONS_PAGE_SETTINGS_BUTTON_TOOLTIP))))

      .BuildChildren();

  // Align the show requests toggle vertically with the label by getting the
  // label height after construction.
  show_requests_toggle_->SetPreferredSize(
      gfx::Size(show_requests_toggle_->GetPreferredSize().width(),
                toggle_label->GetLineHeight()));
}

void ExtensionsMenuSitePermissionsPageView::Update(
    const std::u16string& extension_name,
    const ui::ImageModel& extension_icon,
    const std::u16string& current_site,
    PermissionsManager::UserSiteAccess user_site_access,
    bool is_show_requests_toggle_on,
    bool is_on_site_enabled,
    bool is_on_all_sites_enabled) {
  extension_icon_->SetImage(extension_icon);
  extension_name_->SetText(extension_name);

  // Update the site access buttons with new `user_site_access` and
  // `current_site`.
  int new_selected_index = GetSiteAccessButtonIndex(user_site_access);
  std::vector<views::RadioButton*> site_access_buttons =
      GetSiteAccessButtons(this);
  for (int i = 0; i < static_cast<int>(site_access_buttons.size()); ++i) {
    site_access_buttons[i]->SetChecked(i == new_selected_index);
    if (i == kOnSiteButtonIndex) {
      site_access_buttons[i]->SetText(GetSiteAccessRadioButtonText(
          PermissionsManager::UserSiteAccess::kOnSite, current_site));
    }
  }

  // Enable the site access buttons accordingly. The extension is guaranteed to
  // at least have "on click" enabled when this page is opened.
  site_access_buttons[kOnSiteButtonIndex]->SetEnabled(is_on_site_enabled);
  site_access_buttons[kOnAllSitesButtonIndex]->SetEnabled(
      is_on_all_sites_enabled);

  UpdateShowRequestsToggle(is_show_requests_toggle_on);
}

void ExtensionsMenuSitePermissionsPageView::UpdateShowRequestsToggle(
    bool is_on) {
  show_requests_toggle_->SetIsOn(is_on);
  show_requests_toggle_->GetViewAccessibility().SetName(
      GetShowRequestsToggleAccessibleName(is_on));
}

views::RadioButton*
ExtensionsMenuSitePermissionsPageView::GetSiteAccessButtonForTesting(
    PermissionsManager::UserSiteAccess site_access) {
  std::vector<views::RadioButton*> site_access_buttons =
      GetSiteAccessButtons(this);
  return site_access_buttons[GetSiteAccessButtonIndex(site_access)];
}

views::Label*
ExtensionsMenuSitePermissionsPageView::GetExtensionNameForTesting() {
  return extension_name_;
}

BEGIN_METADATA(ExtensionsMenuSitePermissionsPageView)
END_METADATA