chrome/browser/ui/tabs/tab_menu_model.cc

// Copyright 2012 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/tabs/tab_menu_model.h"

#include <memory>

#include "base/command_line.h"
#include "base/feature_list.h"
#include "base/i18n/rtl.h"
#include "base/metrics/user_metrics.h"
#include "build/build_config.h"
#include "chrome/app/vector_icons/vector_icons.h"
#include "chrome/browser/commerce/browser_utils.h"
#include "chrome/browser/commerce/product_specifications/product_specifications_service_factory.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/send_tab_to_self/send_tab_to_self_util.h"
#include "chrome/browser/ui/tabs/existing_comparison_table_sub_menu_model.h"
#include "chrome/browser/ui/tabs/existing_tab_group_sub_menu_model.h"
#include "chrome/browser/ui/tabs/existing_window_sub_menu_model.h"
#include "chrome/browser/ui/tabs/organization/tab_organization_service_factory.h"
#include "chrome/browser/ui/tabs/organization/tab_organization_utils.h"
#include "chrome/browser/ui/tabs/split_tab_menu_model.h"
#include "chrome/browser/ui/tabs/tab_menu_model_delegate.h"
#include "chrome/browser/ui/tabs/tab_strip_model.h"
#include "chrome/browser/ui/tabs/tab_strip_model_delegate.h"
#include "chrome/browser/ui/tabs/tab_utils.h"
#include "chrome/browser/ui/ui_features.h"
#include "chrome/browser/ui/web_applications/web_app_tabbed_utils.h"
#include "chrome/browser/user_education/user_education_service.h"
#include "chrome/common/chrome_features.h"
#include "chrome/grit/branded_strings.h"
#include "chrome/grit/generated_resources.h"
#include "components/commerce/core/commerce_constants.h"
#include "components/commerce/core/commerce_feature_list.h"
#include "components/feed/feed_feature_list.h"
#include "ui/base/l10n/l10n_util.h"

using base::UserMetricsAction;

DEFINE_CLASS_ELEMENT_IDENTIFIER_VALUE(TabMenuModel, kAddANoteTabMenuItem);
DEFINE_CLASS_ELEMENT_IDENTIFIER_VALUE(TabMenuModel, kSplitTabsMenuItem);
DEFINE_CLASS_ELEMENT_IDENTIFIER_VALUE(TabMenuModel, kArrangeSplitTabsMenuItem);
DEFINE_CLASS_ELEMENT_IDENTIFIER_VALUE(TabMenuModel, kSwapSplitTabsMenuItem);

TabMenuModel::TabMenuModel(ui::SimpleMenuModel::Delegate* delegate,
                           TabMenuModelDelegate* tab_menu_model_delegate,
                           TabStripModel* tab_strip,
                           int index)
    : ui::SimpleMenuModel(delegate),
      tab_menu_model_delegate_(tab_menu_model_delegate) {
  if (tab_strip->delegate()->IsForWebApp()) {
    BuildForWebApp(tab_strip, index);
  } else {
    Build(tab_strip, index);
  }
}

TabMenuModel::~TabMenuModel() = default;

void TabMenuModel::BuildForWebApp(TabStripModel* tab_strip, int index) {
  AddItemWithStringId(TabStripModel::CommandCopyURL, IDS_COPY_URL);
  AddItemWithStringId(TabStripModel::CommandReload, IDS_TAB_CXMENU_RELOAD);
  AddItemWithStringId(TabStripModel::CommandGoBack, IDS_CONTENT_CONTEXT_BACK);

  if (!web_app::IsPinnedHomeTab(tab_strip, index) &&
      (!web_app::HasPinnedHomeTab(tab_strip) ||
       *tab_strip->selection_model().selected_indices().begin() != 0)) {
    int num_tabs = tab_strip->selection_model().selected_indices().size();
    if (ExistingWindowSubMenuModel::ShouldShowSubmenuForApp(
            tab_menu_model_delegate_)) {
      // Create submenu with existing windows
      add_to_existing_window_submenu_ = ExistingWindowSubMenuModel::Create(
          delegate(), tab_menu_model_delegate_, tab_strip, index);
      AddSubMenu(TabStripModel::CommandMoveToExistingWindow,
                 l10n_util::GetPluralStringFUTF16(
                     IDS_TAB_CXMENU_MOVETOANOTHERWINDOW, num_tabs),
                 add_to_existing_window_submenu_.get());
    } else {
      AddItem(TabStripModel::CommandMoveTabsToNewWindow,
              l10n_util::GetPluralStringFUTF16(
                  IDS_TAB_CXMENU_MOVE_TABS_TO_NEW_WINDOW, num_tabs));
    }
  }

  AddSeparator(ui::NORMAL_SEPARATOR);

  if (!web_app::IsPinnedHomeTab(tab_strip, index)) {
    AddItemWithStringId(TabStripModel::CommandCloseTab,
                        IDS_TAB_CXMENU_CLOSETAB);
    AddItemWithStringId(TabStripModel::CommandCloseOtherTabs,
                        IDS_TAB_CXMENU_CLOSEOTHERTABS);
  }
  if (web_app::HasPinnedHomeTab(tab_strip)) {
    AddItemWithStringId(TabStripModel::CommandCloseAllTabs,
                        IDS_TAB_CXMENU_CLOSEALLTABS);
  }
}

void TabMenuModel::Build(TabStripModel* tab_strip, int index) {
  std::vector<int> indices;
  if (tab_strip->IsTabSelected(index)) {
    const ui::ListSelectionModel::SelectedIndices& sel =
        tab_strip->selection_model().selected_indices();
    indices = std::vector<int>(sel.begin(), sel.end());
  } else {
    indices = {index};
  }

  int num_tabs = indices.size();
  AddItemWithStringId(TabStripModel::CommandNewTabToRight,
                      base::i18n::IsRTL() ? IDS_TAB_CXMENU_NEWTABTOLEFT
                                          : IDS_TAB_CXMENU_NEWTABTORIGHT);
  if (tab_strip->delegate()->SupportsReadLater()) {
    AddItem(
        TabStripModel::CommandAddToReadLater,
        l10n_util::GetPluralStringFUTF16(IDS_TAB_CXMENU_READ_LATER, num_tabs));
    SetEnabledAt(GetItemCount() - 1,
                 tab_strip->IsReadLaterSupportedForAny(indices));
  }
  if (ExistingTabGroupSubMenuModel::ShouldShowSubmenu(
          tab_strip, index, tab_menu_model_delegate_)) {
    // Create submenu with existing groups
    add_to_existing_group_submenu_ =
        std::make_unique<ExistingTabGroupSubMenuModel>(
            delegate(), tab_menu_model_delegate_, tab_strip, index);
    AddSubMenu(TabStripModel::CommandAddToExistingGroup,
               l10n_util::GetPluralStringFUTF16(IDS_TAB_CXMENU_ADD_TAB_TO_GROUP,
                                                num_tabs),
               add_to_existing_group_submenu_.get());
  } else {
    AddItem(TabStripModel::CommandAddToNewGroup,
            l10n_util::GetPluralStringFUTF16(
                IDS_TAB_CXMENU_ADD_TAB_TO_NEW_GROUP, num_tabs));
    SetElementIdentifierAt(GetItemCount() - 1, kAddToNewGroupItemIdentifier);
  }
  if (base::FeatureList::IsEnabled(features::kSideBySide)) {
    if (!tab_strip->GetSplitForTab(index).has_value()) {
      if (tab_strip->GetActiveTab()->IsSplit()) {
        AddItemWithStringId(TabStripModel::CommandSwapWithActiveSplit,
                            IDS_TAB_CXMENU_SWAP_WITH_ACTIVE_SPLIT);
        const int swap_with_split_index = GetItemCount() - 1;
        SetEnabledAt(swap_with_split_index, num_tabs == 1);
        SetElementIdentifierAt(swap_with_split_index, kSwapSplitTabsMenuItem);
      } else {
        AddItemWithStringId(TabStripModel::CommandAddToSplit,
                            IDS_TAB_CXMENU_ADD_TAB_TO_NEW_SPLIT);
        const int add_to_split_index = GetItemCount() - 1;
        SetEnabledAt(add_to_split_index, num_tabs == 1);
        SetElementIdentifierAt(add_to_split_index, kSplitTabsMenuItem);
      }
    } else {
      arrange_split_view_submenu_ =
          std::make_unique<SplitTabMenuModel>(tab_strip, index);
      // The arrange split menu doesn't need the close entry.
      arrange_split_view_submenu_->RemoveItemAt(
          arrange_split_view_submenu_
              ->GetIndexOfCommandId(
                  static_cast<int>(SplitTabMenuModel::CommandId::kClose))
              .value());
      AddSubMenuWithStringId(TabStripModel::CommandArrangeSplit,
                             IDS_TAB_CXMENU_ARRANGE_SPLIT,
                             arrange_split_view_submenu_.get());
      SetElementIdentifierAt(GetItemCount() - 1, kArrangeSplitTabsMenuItem);
    }
    SetIsNewFeatureAt(GetItemCount() - 1,
                      UserEducationService::MaybeShowNewBadge(
                          tab_strip->profile(), features::kSideBySide));
  }

  for (const auto& selection : indices) {
    if (tab_strip->GetTabGroupForTab(selection).has_value()) {
      AddItemWithStringId(TabStripModel::CommandRemoveFromGroup,
                          IDS_TAB_CXMENU_REMOVE_TAB_FROM_GROUP);
      break;
    }
  }

  if (num_tabs == 1 &&
      base::FeatureList::IsEnabled(commerce::kProductSpecifications)) {
    auto* product_specs_service =
        commerce::ProductSpecificationsServiceFactory::GetForBrowserContext(
            tab_strip->profile());
    if (commerce::ExistingComparisonTableSubMenuModel::ShouldShowSubmenu(
            tab_strip->GetWebContentsAt(index)->GetLastCommittedURL(),
            product_specs_service)) {
      // Create submenu with existing comparison tables.
      add_to_existing_comparison_table_submenu_ =
          std::make_unique<commerce::ExistingComparisonTableSubMenuModel>(
              delegate(), tab_menu_model_delegate_, tab_strip, index,
              product_specs_service);
      AddSubMenuWithStringId(TabStripModel::CommandAddToExistingComparisonTable,
                             IDS_COMPARE_ADD_TAB_TO_COMPARISON_TABLE,
                             add_to_existing_comparison_table_submenu_.get());
    } else if (product_specs_service) {
      AddItemWithStringId(TabStripModel::CommandAddToNewComparisonTable,
                          IDS_TAB_CXMENU_ADD_TAB_TO_NEW_COMPARISON_TABLE);
    }
  }

  if (ExistingWindowSubMenuModel::ShouldShowSubmenu(tab_strip->profile())) {
    // Create submenu with existing windows
    add_to_existing_window_submenu_ = ExistingWindowSubMenuModel::Create(
        delegate(), tab_menu_model_delegate_, tab_strip, index);
    AddSubMenu(TabStripModel::CommandMoveToExistingWindow,
               l10n_util::GetPluralStringFUTF16(
                   IDS_TAB_CXMENU_MOVETOANOTHERWINDOW, num_tabs),
               add_to_existing_window_submenu_.get());
  } else {
    AddItem(TabStripModel::CommandMoveTabsToNewWindow,
            l10n_util::GetPluralStringFUTF16(
                IDS_TAB_CXMENU_MOVE_TABS_TO_NEW_WINDOW, num_tabs));
  }

  if (TabOrganizationUtils::GetInstance()->IsEnabled(tab_strip->profile())) {
    auto* const tab_organization_service =
        TabOrganizationServiceFactory::GetForProfile(tab_strip->profile());
    if (tab_organization_service) {
      AddItemWithStringId(TabStripModel::CommandOrganizeTabs,
                          IDS_TAB_CXMENU_ORGANIZE_TABS);
    }
  }

  if (commerce::IsProductSpecsMultiSelectMenuEnabled(
          tab_strip->profile(), tab_strip->GetWebContentsAt(index)) &&
      num_tabs >= commerce::kProductSpecificationsMinTabsCount) {
    AddItemWithStringId(TabStripModel::CommandCommerceProductSpecifications,
                        IDS_TAB_CXMENU_COMMERCE_PRODUCT_SPEC);
  }

  AddSeparator(ui::NORMAL_SEPARATOR);
  AddItemWithStringId(TabStripModel::CommandReload, IDS_TAB_CXMENU_RELOAD);

  AddItemWithStringId(TabStripModel::CommandDuplicate,
                      IDS_TAB_CXMENU_DUPLICATE);

  bool will_pin = tab_strip->WillContextMenuPin(index);
  AddItemWithStringId(
      TabStripModel::CommandTogglePinned,
      will_pin ? IDS_TAB_CXMENU_PIN_TAB : IDS_TAB_CXMENU_UNPIN_TAB);

  const bool will_mute = !AreAllSitesMuted(*tab_strip, indices);
  AddItem(TabStripModel::CommandToggleSiteMuted,
          will_mute ? l10n_util::GetPluralStringFUTF16(
                          IDS_TAB_CXMENU_SOUND_MUTE_SITE, num_tabs)
                    : l10n_util::GetPluralStringFUTF16(
                          IDS_TAB_CXMENU_SOUND_UNMUTE_SITE, num_tabs));
  if (send_tab_to_self::ShouldDisplayEntryPoint(
          tab_strip->GetWebContentsAt(index))) {
    AddSeparator(ui::NORMAL_SEPARATOR);
#if BUILDFLAG(IS_MAC)
    AddItem(TabStripModel::CommandSendTabToSelf,
            l10n_util::GetStringUTF16(IDS_MENU_SEND_TAB_TO_SELF));
#else
    AddItemWithIcon(TabStripModel::CommandSendTabToSelf,
                    l10n_util::GetStringUTF16(IDS_MENU_SEND_TAB_TO_SELF),
                    ui::ImageModel::FromVectorIcon(kDevicesIcon));
#endif
  }

  AddSeparator(ui::NORMAL_SEPARATOR);
  AddItemWithStringId(TabStripModel::CommandCloseTab, IDS_TAB_CXMENU_CLOSETAB);
  AddItemWithStringId(TabStripModel::CommandCloseOtherTabs,
                      IDS_TAB_CXMENU_CLOSEOTHERTABS);
  {
    AddItemWithStringId(TabStripModel::CommandCloseTabsToRight,
                        base::i18n::IsRTL() ? IDS_TAB_CXMENU_CLOSETABSTOLEFT
                                            : IDS_TAB_CXMENU_CLOSETABSTORIGHT);
    SetEnabledAt(GetItemCount() - 1,
                 tab_strip->IsContextMenuCommandEnabled(
                     index, TabStripModel::CommandCloseTabsToRight));
  }
}

DEFINE_CLASS_ELEMENT_IDENTIFIER_VALUE(TabMenuModel,
                                      kAddToNewGroupItemIdentifier);