[iOS] Add Request Mobile Site cell to tools menu

ios/chrome/browser/ui/tools_menu/tools_menu_view_controller.mm

 // Copyright 2014 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.
 
 #import "ios/chrome/browser/ui/tools_menu/tools_menu_view_controller.h"
 
 #include <stdint.h>
 
 #include "base/ios/ios_util.h"
 #import "base/ios/weak_nsobject.h"
 #include "base/logging.h"
 #include "base/mac/objc_property_releaser.h"
 #include "base/mac/scoped_nsobject.h"
 #include "base/metrics/field_trial.h"
 #include "components/reading_list/core/reading_list_switches.h"
 #include "components/strings/grit/components_strings.h"
 #include "ios/chrome/browser/experimental_flags.h"
 #import "ios/chrome/browser/ui/animation_util.h"
 #import "ios/chrome/browser/ui/commands/UIKit+ChromeExecuteCommand.h"
 #include "ios/chrome/browser/ui/commands/ios_command_ids.h"
 #import "ios/chrome/browser/ui/reading_list/reading_list_menu_notification_delegate.h"
 #import "ios/chrome/browser/ui/reading_list/reading_list_menu_notifier.h"
 #import "ios/chrome/browser/ui/tools_menu/reading_list_menu_view_item.h"
-#import "ios/chrome/browser/ui/tools_menu/tools_menu_context.h"
+#import "ios/chrome/browser/ui/tools_menu/tools_menu_configuration.h"
 #import "ios/chrome/browser/ui/tools_menu/tools_menu_view_item.h"
 #import "ios/chrome/browser/ui/tools_menu/tools_menu_view_tools_cell.h"
 #import "ios/chrome/browser/ui/tools_menu/tools_popup_controller.h"
 #include "ios/chrome/browser/ui/ui_util.h"
 #import "ios/chrome/browser/ui/uikit_ui_util.h"
 #import "ios/chrome/common/material_timing.h"
 #include "ios/chrome/grit/ios_strings.h"
 #include "ios/public/provider/chrome/browser/chrome_browser_provider.h"
 #import "ios/public/provider/chrome/browser/user_feedback/user_feedback_provider.h"
 #import "ios/third_party/material_components_ios/src/components/Ink/src/MaterialInk.h"
+#include "ios/web/public/user_agent.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/l10n/l10n_util_mac.h"
 
+// TODO(crbug.com/678047) Remove this switch when request mobile site
+// functionality is implemented.
+#define HIDE_REQUEST_MOBILE_SITE_CELL
+
 using ios::material::TimingFunction;
 
 NSString* const kToolsMenuNewTabId = @"kToolsMenuNewTabId";
 NSString* const kToolsMenuNewIncognitoTabId = @"kToolsMenuNewIncognitoTabId";
 NSString* const kToolsMenuCloseAllTabsId = @"kToolsMenuCloseAllTabsId";
 NSString* const kToolsMenuCloseAllIncognitoTabsId =
     @"kToolsMenuCloseAllIncognitoTabsId";
 NSString* const kToolsMenuBookmarksId = @"kToolsMenuBookmarksId";
 NSString* const kToolsMenuReadingListId = @"kToolsMenuReadingListId";
 NSString* const kToolsMenuOtherDevicesId = @"kToolsMenuOtherDevicesId";
 NSString* const kToolsMenuHistoryId = @"kToolsMenuHistoryId";
 NSString* const kToolsMenuReportAnIssueId = @"kToolsMenuReportAnIssueId";
 NSString* const kToolsMenuFindInPageId = @"kToolsMenuFindInPageId";
 NSString* const kToolsMenuReaderMode = @"kToolsMenuReaderMode";
 NSString* const kToolsMenuRequestDesktopId = @"kToolsMenuRequestDesktopId";
+NSString* const kToolsMenuRequestMobileId = @"kToolsMenuRequestMobileId";
 NSString* const kToolsMenuSettingsId = @"kToolsMenuSettingsId";
 NSString* const kToolsMenuHelpId = @"kToolsMenuHelpId";
 NSString* const kToolsMenuSuggestionsId = @"kToolsMenuSuggestionsId";
 
 namespace {
 
 // Time for ink to fade into view.
 static const NSTimeInterval kMDCInkTouchDelayInterval = 0.15;
 
 static const CGFloat kMenuItemHeight = 48;
@@ skipping 28 matching lines @@
     kToolbarTypeWebiPad         = 1 << 1,
     kToolbarTypeNoTabsiPad      = 1 << 2,
     kToolbarTypeSwitcheriPhone  = 1 << 3,
     kToolbarTypeWebAll          = kToolbarTypeWebiPhone | kToolbarTypeWebiPad,
     kToolbarTypeAll             = kToolbarTypeWebAll |
                                   kToolbarTypeSwitcheriPhone |
                                   kToolbarTypeNoTabsiPad,
   // clang-format on
 };
 
-// Declare all the possible items.
+// Declares all the possible items.
 static MenuItemInfo itemInfoList[] = {
     // clang-format off
   { IDS_IOS_TOOLS_MENU_NEW_TAB,           kToolsMenuNewTabId,
     IDC_NEW_TAB,                          kToolbarTypeAll,
     0,                                    nil },
   { IDS_IOS_TOOLS_MENU_NEW_INCOGNITO_TAB, kToolsMenuNewIncognitoTabId,
     IDC_NEW_INCOGNITO_TAB,                kToolbarTypeAll,
     0,                                    nil },
   { IDS_IOS_TOOLS_MENU_CLOSE_ALL_TABS,    kToolsMenuCloseAllTabsId,
     IDC_CLOSE_ALL_TABS,                   kToolbarTypeSwitcheriPhone,
@@ skipping 19 matching lines @@
     0,                                    nil },
   { IDS_IOS_OPTIONS_REPORT_AN_ISSUE,      kToolsMenuReportAnIssueId,
     IDC_REPORT_AN_ISSUE,                  kToolbarTypeAll,
     0,                                    nil },
   { IDS_IOS_TOOLS_MENU_FIND_IN_PAGE,      kToolsMenuFindInPageId,
     IDC_FIND,                             kToolbarTypeWebAll,
     0,                                    nil },
   { IDS_IOS_TOOLS_MENU_REQUEST_DESKTOP_SITE, kToolsMenuRequestDesktopId,
     IDC_REQUEST_DESKTOP_SITE,             kToolbarTypeWebAll,
     0,                                    nil },
+  { IDS_IOS_TOOLS_MENU_REQUEST_MOBILE_SITE, kToolsMenuRequestMobileId,
+    IDC_REQUEST_MOBILE_SITE,             kToolbarTypeWebAll,
+    0,                                    nil },
   { IDS_IOS_TOOLS_MENU_READER_MODE,       kToolsMenuReaderMode,
     IDC_READER_MODE,                      kToolbarTypeWebAll,
     0,                                    nil },
   { IDS_IOS_TOOLS_MENU_SETTINGS,          kToolsMenuSettingsId,
     IDC_OPTIONS,                          kToolbarTypeAll,
     0,                                    nil },
   { IDS_IOS_TOOLS_MENU_HELP_MOBILE,           kToolsMenuHelpId,
     IDC_HELP_PAGE_VIA_MENU,               kToolbarTypeWebAll,
     0,                                    nil },
     // clang-format on
 };
 
 NS_INLINE BOOL ItemShouldBeVisible(const MenuItemInfo& item,
-                                   BOOL incognito,
-                                   kToolbarType toolbarType) {
+                                   kToolbarType toolbarType,
+                                   ToolsMenuConfiguration* configuration) {
   if (!(item.toolbar_types & toolbarType))
     return NO;
 
-  if (incognito && (item.visibility & kVisibleNotIncognitoOnly))
+  if (configuration.inIncognito && (item.visibility & kVisibleNotIncognitoOnly))
     return NO;
 
-  if (!incognito && (item.visibility & kVisibleIncognitoOnly))
+  if (!configuration.inIncognito && (item.visibility & kVisibleIncognitoOnly))
     return NO;
 
   if (item.title_id == IDS_IOS_TOOLBAR_SHOW_TABS) {
     if (!IsIPadIdiom()) {
       return NO;
     }
   }
 
   if (item.title_id == IDS_IOS_TOOLS_MENU_READER_MODE) {
     if (!experimental_flags::IsReaderModeEnabled()) {
@@ skipping 14 matching lines @@
   }
 
   if (item.title_id == IDS_IOS_OPTIONS_REPORT_AN_ISSUE) {
     if (!ios::GetChromeBrowserProvider()
              ->GetUserFeedbackProvider()
              ->IsUserFeedbackEnabled()) {
       return NO;
     }
   }
 
+  // TODO(crbug.com/696676): Talk to UI/UX people to decide the correct behavior
+  // of "Requestion Desktop/Mobile Site" (e.g. Whether user agent flag should
+  // stick when going backward and which cell should be visible when navigating
+  // to native pages).
+  if (item.title_id == IDS_IOS_TOOLS_MENU_REQUEST_DESKTOP_SITE) {
+// TODO(crbug.com/678047) Remove this switch when request mobile site
+// functionality is implemented.
+#ifdef HIDE_REQUEST_MOBILE_SITE_CELL
+    return YES;
+#else
+    if (configuration.userAgentType == web::UserAgentType::DESKTOP)
+      return NO;
+#endif
+  }
+
+  if (item.title_id == IDS_IOS_TOOLS_MENU_REQUEST_MOBILE_SITE) {
+// TODO(crbug.com/678047) Remove this switch when request mobile site
+// functionality is implemented.
+#ifdef HIDE_REQUEST_MOBILE_SITE_CELL
+    return NO;
+#else
+    if (configuration.userAgentType != web::UserAgentType::DESKTOP)
+      return NO;
+#endif
+  }
+
   return YES;
 }
 
 NS_INLINE void AnimateInViews(NSArray* views,
                               CGFloat initialX,
                               CGFloat initialY) {
   [views enumerateObjectsUsingBlock:^(UIView* view, NSUInteger index,
                                       BOOL* stop) {
     CGFloat beginTime = index * .035;
     CABasicAnimation* transformAnimation =
@@ skipping 50 matching lines @@
   BOOL _waitForInk;
   // Weak pointer to ReadingListMenuNotifier, used to set the starting values
   // for the reading list badge.
   base::WeakNSObject<ReadingListMenuNotifier> _readingListMenuNotifier;
 }
 @property(nonatomic, retain) ToolsMenuCollectionView* menuView;
 @property(nonatomic, retain) MDCInkView* touchFeedbackView;
 @property(nonatomic, retain) NSMutableArray* menuItems;
 @property(nonatomic, assign) kToolbarType toolbarType;
 
-// Get the reading list cell.
+// Returns the reading list cell.
 - (ReadingListMenuViewCell*)readingListCell;
 @end
 
 @implementation ToolsMenuViewController
 
 @synthesize menuView = _menuView;
 @synthesize isCurrentPageBookmarked = _isCurrentPageBookmarked;
 @synthesize touchFeedbackView = _touchFeedbackView;
 @synthesize isTabLoading = _isTabLoading;
 @synthesize toolbarType = _toolbarType;
@@ skipping 43 matching lines @@
 
   ToolsMenuViewToolsCell* toolsCell = [self toolsCell];
   [[toolsCell starButton] setHidden:_isCurrentPageBookmarked];
   [[toolsCell starredButton] setHidden:!_isCurrentPageBookmarked];
 }
 
 - (void)setCanUseReaderMode:(BOOL)enabled {
   [self setItemEnabled:enabled withTag:IDC_READER_MODE];
 }
 
-- (void)setCanUseDesktopUserAgent:(BOOL)enabled {
-  [self setItemEnabled:enabled withTag:IDC_REQUEST_DESKTOP_SITE];
-}
-
 - (void)setCanShowFindBar:(BOOL)enabled {
   [self setItemEnabled:enabled withTag:IDC_FIND];
 }
 
 - (void)setCanShowShareMenu:(BOOL)enabled {
   ToolsMenuViewToolsCell* toolsCell = [self toolsCell];
   [[toolsCell shareButton] setEnabled:enabled];
   [self setItemEnabled:enabled withTag:IDC_SHARE_PAGE];
 }
 
 - (UIButton*)toolsButton {
   UIButton* toolsButton = [[self toolsCell] toolsButton];
   [toolsButton addTarget:self
                   action:@selector(buttonPressed:)
         forControlEvents:UIControlEventTouchUpInside];
   [toolsButton setTranslatesAutoresizingMaskIntoConstraints:YES];
   [toolsButton setOpaque:NO];
   [toolsButton setBackgroundColor:[UIColor clearColor]];
   return toolsButton;
 }
 
 - (void)setIsTabLoading:(BOOL)isTabLoading {
   _isTabLoading = isTabLoading;
 
   ToolsMenuViewToolsCell* toolsCell = [self toolsCell];
   [[toolsCell stopButton] setHidden:!isTabLoading];
   [[toolsCell reloadButton] setHidden:isTabLoading];
 }
 
-- (void)initializeMenu:(ToolsMenuContext*)context {
-  if (context.readingListMenuNotifier) {
-    _readingListMenuNotifier.reset(context.readingListMenuNotifier);
-    [context.readingListMenuNotifier setDelegate:self];
+- (void)initializeMenuWithConfiguration:(ToolsMenuConfiguration*)configuration {
+  if (configuration.readingListMenuNotifier) {
+    _readingListMenuNotifier.reset(configuration.readingListMenuNotifier);
+    [configuration.readingListMenuNotifier setDelegate:self];
   }
 
   if (IsIPadIdiom()) {
-    _toolbarType = context.hasNoOpenedTabs
+    _toolbarType = configuration.hasNoOpenedTabs
                        ? kToolbarTypeNoTabsiPad
                        : (!IsCompactTablet() ? kToolbarTypeWebiPad
                                              : kToolbarTypeWebiPhone);
   } else {
     // kOptionInTabSwitcher option must be enabled on iPhone with
     // no opened tabs.
-    DCHECK(!context.hasNoOpenedTabs || context.isInTabSwitcher);
-    _toolbarType = context.isInTabSwitcher ? kToolbarTypeSwitcheriPhone
-                                           : kToolbarTypeWebiPhone;
+    DCHECK(!configuration.hasNoOpenedTabs || configuration.isInTabSwitcher);
+    _toolbarType = configuration.isInTabSwitcher ? kToolbarTypeSwitcheriPhone
+                                                 : kToolbarTypeWebiPhone;
   }
 
   // Build the menu, adding all relevant items.
   NSMutableArray* menu = [NSMutableArray array];
 
   for (size_t i = 0; i < arraysize(itemInfoList); ++i) {
     const MenuItemInfo& item = itemInfoList[i];
-    if (!ItemShouldBeVisible(item, context.isInIncognito, _toolbarType))
+    if (!ItemShouldBeVisible(item, _toolbarType, configuration))
       continue;
 
     NSString* title = l10n_util::GetNSStringWithFixup(item.title_id);
     Class itemClass =
         item.item_class ? item.item_class : [ToolsMenuViewItem class];
     // Sanity check that the class is a useful one.
     DCHECK([itemClass respondsToSelector:@selector(menuItemWithTitle:
                                              accessibilityIdentifier:
                                                              command:)]);
     [menu addObject:[itemClass menuItemWithTitle:title
                          accessibilityIdentifier:item.accessibility_id
                                          command:item.command_id]];
   }
 
 #if !defined(NDEBUG)
   NSUserDefaults* standardDefaults = [NSUserDefaults standardUserDefaults];
   if ((_toolbarType & kToolbarTypeWebAll) &&
       [standardDefaults boolForKey:@"DevViewSource"]) {
     // Debug menu, not localized, only visible if turned on by a default.
     [menu addObject:[self createViewSourceItem]];
   }
 #endif  // !defined(NDEBUG)
 
   [self setMenuItems:menu];
 
+  // Decide the enabled state of the currently visible item between
+  // "Request Desktop Site" and "Request Mobile Site".
+  switch (configuration.userAgentType) {
+    case web::UserAgentType::NONE:
+      [self setItemEnabled:NO withTag:IDC_REQUEST_DESKTOP_SITE];
+      break;
+    case web::UserAgentType::MOBILE:
+      [self setItemEnabled:YES withTag:IDC_REQUEST_DESKTOP_SITE];
+      break;
+    case web::UserAgentType::DESKTOP:
+      [self setItemEnabled:YES withTag:IDC_REQUEST_MOBILE_SITE];
+
+// TODO(crbug.com/678047) Remove this switch when request mobile site
+// functionality is implemented.
+#ifdef HIDE_REQUEST_MOBILE_SITE_CELL
+      [self setItemEnabled:NO withTag:IDC_REQUEST_DESKTOP_SITE];
+#endif
+      break;
+  }
+
   // Disable IDC_CLOSE_ALL_TABS menu item if on phone with no tabs.
   if (!IsIPadIdiom()) {
-    [self setItemEnabled:!context.hasNoOpenedTabs withTag:IDC_CLOSE_ALL_TABS];
+    [self setItemEnabled:!configuration.hasNoOpenedTabs
+                 withTag:IDC_CLOSE_ALL_TABS];
   }
 }
 
 #if !defined(NDEBUG)
 - (ToolsMenuViewItem*)createViewSourceItem {
   return [ToolsMenuViewItem menuItemWithTitle:@"View Source"
                       accessibilityIdentifier:@"View Source"
                                       command:IDC_VIEW_SOURCE];
 }
 #endif  // !defined(NDEBUG)
@@ skipping 320 matching lines @@
 
 - (void)unreadCountChanged:(NSInteger)unreadCount {
   [[self readingListCell] updateBadgeCount:unreadCount animated:YES];
 }
 
 - (void)unseenStateChanged:(BOOL)unseenItemsExist {
   [[self readingListCell] updateSeenState:unseenItemsExist animated:YES];
 }
 
 @end