[ios] Moves find-in-page code out of Tab and into FindTabHelper.

ios/chrome/browser/ui/browser_view_controller.mm

 // Copyright 2012 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/browser_view_controller.h"
 
 #import <AssetsLibrary/AssetsLibrary.h>
 #import <MobileCoreServices/MobileCoreServices.h>
 #import <PassKit/PassKit.h>
 #import <Photos/Photos.h>
@@ skipping 38 matching lines @@
 #include "ios/chrome/browser/bookmarks/bookmark_model_factory.h"
 #include "ios/chrome/browser/browser_state/chrome_browser_state.h"
 #include "ios/chrome/browser/chrome_url_constants.h"
 #include "ios/chrome/browser/chrome_url_util.h"
 #import "ios/chrome/browser/content_suggestions/content_suggestions_coordinator.h"
 #include "ios/chrome/browser/experimental_flags.h"
 #import "ios/chrome/browser/favicon/favicon_loader.h"
 #include "ios/chrome/browser/favicon/ios_chrome_favicon_loader_factory.h"
 #import "ios/chrome/browser/find_in_page/find_in_page_controller.h"
 #import "ios/chrome/browser/find_in_page/find_in_page_model.h"
+#import "ios/chrome/browser/find_in_page/find_tab_helper.h"
 #include "ios/chrome/browser/first_run/first_run.h"
 #import "ios/chrome/browser/geolocation/omnibox_geolocation_controller.h"
 #include "ios/chrome/browser/infobars/infobar_container_ios.h"
 #include "ios/chrome/browser/infobars/infobar_container_view.h"
 #import "ios/chrome/browser/metrics/new_tab_page_uma.h"
 #include "ios/chrome/browser/metrics/tab_usage_recorder.h"
 #import "ios/chrome/browser/native_app_launcher/native_app_navigation_controller.h"
 #import "ios/chrome/browser/open_url_util.h"
 #import "ios/chrome/browser/passwords/password_controller.h"
 #import "ios/chrome/browser/payments/payment_request_manager.h"
@@ skipping 213 matching lines @@
     return true;
   std::string url_host = url.host();
   return url_host != kChromeUIHistoryHost &&
          url_host != kChromeUIHistoryFrameHost;
 }
 
 // Temporary key to use when storing native controllers vended to tabs before
 // they are added to the tab model.
 NSString* const kNativeControllerTemporaryKey = @"NativeControllerTemporaryKey";
 
+// Helper function to return the FindTabHelper for the given |tab|.  If |tab| is
+// nullptr, returns nullptr.

[marq (ping after 24h), 2017/01/31 16:02:49]

Why not just return the helper's FindInPageController or nil, since that's the
only part of the helper this class cares about? Then you can get rid of all the
null checking for the helper.

[rohitrao (ping after 24h), 2017/02/08 16:14:59]

Done.

+FindTabHelper* GetFindTabHelper(Tab* tab) {
+  if (!tab) {
+    return nullptr;
+  }
+  return FindTabHelper::FromWebState(tab.webState);

[Eugene But (OOO till 7-30), 2017/01/31 19:03:48]

Optional nit: do you want to use ternary operator here?

[rohitrao (ping after 24h), 2017/02/08 16:14:59]

Acknowledged.

+}
+
 }  // anonymous namespace
 
 @interface BrowserViewController ()<AppRatingPromptDelegate,
                                     ContextualSearchControllerDelegate,
                                     ContextualSearchPanelMotionObserver,
                                     CRWNativeContentProvider,
                                     CRWWebStateDelegate,
                                     DialogPresenterDelegate,
                                     FullScreenControllerDelegate,
                                     KeyCommandsPlumbing,
@@ skipping 793 matching lines @@
   Tab* tab = [_model currentTab];
   // TODO(shreyasv): Make it so the URL returned by the tab is always valid and
   // remove check on net::NSURLWithGURL(tab.url) ( http://crbug.com/400999 ).
   return tab && !tab.url.SchemeIs(kChromeUIScheme) &&
          net::NSURLWithGURL(tab.url);
 }
 
 - (BOOL)canShowFindBar {
   // Make sure web controller can handle find in page.
   Tab* tab = [_model currentTab];
-  if (![tab.findInPageController canFindInPage])
+  FindTabHelper* findHelper = GetFindTabHelper(tab);
+  if (!findHelper)
+    return NO;
+
+  FindInPageController* controller = findHelper->GetController();
+  if (![controller canFindInPage])
     return NO;
 
   // Don't show twice.
-  if (tab.findInPageController.findInPageModel.enabled)
+  if (controller.findInPageModel.enabled)
     return NO;
 
   return YES;
 }
 
 - (void)setVisible:(BOOL)visible {
   if (_visible == visible)
     return;
   _visible = visible;
 }
@@ skipping 346 matching lines @@
                     selector:@selector(tabWasAdded:)
                         name:kTabModelNewTabWillOpenNotification
                       object:_model];
 }
 
 - (void)pageLoadStarting:(NSNotification*)notify {
   Tab* tab = notify.userInfo[kTabModelTabKey];
   DCHECK(tab && ([_model indexOfTab:tab] != NSNotFound));
   // Hide find bar when navigating to a new page.
   [self hideFindBarWithAnimation:NO];
-  tab.findInPageController.findInPageModel.enabled = NO;
+
+  FindTabHelper* findHelper = GetFindTabHelper(tab);
+  if (findHelper) {
+    FindInPageController* controller =
+        findHelper->GetController();
+    controller.findInPageModel.enabled = NO;
+  }
+
   if (tab == [_model currentTab]) {
     // TODO(pinkerton): Fill in here about hiding the forward button on
     // navigation.
   }
 }
 
 - (void)pageLoadStarted:(NSNotification*)notify {
   Tab* tab = notify.userInfo[kTabModelTabKey];
   DCHECK(tab);
   if (tab == [_model currentTab]) {
@@ skipping 442 matching lines @@
 
   if (tab.isPrerenderTab && !_toolbarModelIOS->IsLoading())
     [_toolbarController showPrerenderingAnimation];
 
   // Also update the loading state for the tools menu (that is really an
   // extension of the toolbar on the iPhone).
   if (!IsIPadIdiom())
     [[_toolbarController toolsPopupController]
         setIsTabLoading:_toolbarModelIOS->IsLoading()];
 
-  if (tab.findInPageController.findInPageModel.enabled)
-    [self showFindBarWithAnimation:NO
-                        selectText:YES
-                       shouldFocus:[_findBarController isFocused]];
+  FindTabHelper* findHelper = GetFindTabHelper(tab);
+  if (findHelper) {
+    FindInPageController* controller =
+        findHelper->GetController();
+    if (controller.findInPageModel.enabled)
+      [self showFindBarWithAnimation:NO
+            selectText:YES
+            shouldFocus:[_findBarController isFocused]];
+  }
 
   // Hide the toolbar if displaying phone NTP.
   if (!IsIPadIdiom()) {
     CRWSessionEntry* entry =
         [[tab navigationManager]->GetSessionController() currentEntry];
     BOOL hideToolbar = NO;
     if (entry) {
       GURL url = [entry navigationItem]->GetURL();
       BOOL isNTP = url.GetOrigin() == GURL(kChromeUINewTabURL);
       hideToolbar = isNTP && !_isOffTheRecord &&
@@ skipping 1999 matching lines @@
             currentlyBookmarked:_toolbarModelIOS->IsCurrentTabBookmarkedByUser()
                          inView:[_toolbarController bookmarkButtonView]
                      originRect:[_toolbarController bookmarkButtonAnchorRect]];
       break;
     case IDC_CLOSE_TAB:
       [self closeCurrentTab];
       break;
     case IDC_FIND:
       [self initFindBarForTab];
       break;
-    case IDC_FIND_NEXT:
+    case IDC_FIND_NEXT: {
+      FindInPageController* findInPageController =
+          FindTabHelper::FromWebState([_model currentTab].webState)

[Eugene But (OOO till 7-30), 2017/01/31 19:03:48]

Should you use your helper function here and in other places?

[rohitrao (ping after 24h), 2017/02/08 16:14:59]

Changed for now, but I'm going to revisit.  I think in some of these places it's
safe to assume that |tab| is not nil.

+              ->GetController();
       // TODO(crbug.com/603524): Reshow find bar if necessary.
-      [[_model currentTab].findInPageController
-          findNextStringInPageWithCompletionHandler:^{
-            FindInPageModel* model =
-                [_model currentTab].findInPageController.findInPageModel;
-            [_findBarController updateResultsCount:model];
-          }];
+      [findInPageController findNextStringInPageWithCompletionHandler:^{
+        FindInPageModel* model = findInPageController.findInPageModel;
+        [_findBarController updateResultsCount:model];
+      }];
       break;
-    case IDC_FIND_PREVIOUS:
+    }
+    case IDC_FIND_PREVIOUS: {
+      FindInPageController* findInPageController =
+          FindTabHelper::FromWebState([_model currentTab].webState)
+              ->GetController();
       // TODO(crbug.com/603524): Reshow find bar if necessary.
-      [[_model currentTab].findInPageController
-          findPreviousStringInPageWithCompletionHandler:^{
-            FindInPageModel* model =
-                [_model currentTab].findInPageController.findInPageModel;
-            [_findBarController updateResultsCount:model];
-          }];
+      [findInPageController findPreviousStringInPageWithCompletionHandler:^{
+        FindInPageModel* model = findInPageController.findInPageModel;
+        [_findBarController updateResultsCount:model];
+      }];
       break;
+    }
     case IDC_FIND_CLOSE:
       [self closeFindInPage];
       break;
     case IDC_FIND_UPDATE:
       [self searchFindInPage];
       break;
     case IDC_FORWARD:
       [[_model currentTab] goForward];
       break;
     case IDC_FULLSCREEN:
@@ skipping 218 matching lines @@
 
 - (void)clearPresentedStateWithCompletion:(ProceduralBlock)completion {
   [[_dependencyFactory shareControllerInstance] cancelShareAnimated:NO];
   [_bookmarkInteractionController dismissBookmarkModalControllerAnimated:NO];
   [_bookmarkInteractionController dismissSnackbar];
   [_toolbarController cancelOmniboxEdit];
   [_dialogPresenter cancelAllDialogs];
   [self hidePageInfoPopupForView:nil];
   if (_voiceSearchController)
     _voiceSearchController->DismissMicPermissionsHelp();
-  [[_model currentTab] dismissModals];
-  [[_model currentTab].findInPageController
-      disableFindInPageWithCompletionHandler:^{
+
+  Tab* currentTab = [_model currentTab];
+  [currentTab dismissModals];
+
+  FindTabHelper* findHelper = GetFindTabHelper(currentTab);
+  if (findHelper) {
+    FindInPageController* findInPageController =
+        findHelper
+        ->GetController();
+    [findInPageController disableFindInPageWithCompletionHandler:^{
         [self updateFindBar:NO shouldFocus:NO];
       }];
+  }
+
   [_contextualSearchController movePanelOffscreen];
-
   [_paymentRequestManager cancelRequest];
-
   [_printController dismissAnimated:YES];
   _printController.reset();
   if (_noTabsController.get())
     [_noTabsController dismissToolsMenuPopup];
   else
     [_toolbarController dismissToolsMenuPopup];
   [_contextMenuCoordinator stop];
   [self dismissRateThisAppDialog];
 
   [_contentSuggestionsCoordinator stop];
@@ skipping 79 matching lines @@
 // Create find bar controller and pass it to the web controller.
 - (void)initFindBarForTab {
   if (!self.canShowFindBar)
     return;
 
   if (!_findBarController)
     _findBarController.reset(
         [[FindBarControllerIOS alloc] initWithIncognito:_isOffTheRecord]);
 
   Tab* tab = [_model currentTab];
-  DCHECK(!tab.findInPageController.findInPageModel.enabled);
-  tab.findInPageController.findInPageModel.enabled = YES;
+  FindInPageController* controller =
+      FindTabHelper::FromWebState(tab.webState)->GetController();
+  DCHECK(!controller.findInPageModel.enabled);
+  controller.findInPageModel.enabled = YES;
   [self showFindBarWithAnimation:YES selectText:YES shouldFocus:YES];
 }
 
 - (void)searchFindInPage {
   FindInPageController* findInPageController =
-      [[_model currentTab] findInPageController];
+      FindTabHelper::FromWebState([_model currentTab].webState)
+          ->GetController();
   base::WeakNSObject<BrowserViewController> weakSelf(self);
-  [findInPageController
-       findStringInPage:[_findBarController searchTerm]
-      completionHandler:^{
-        FindInPageModel* model =
-            [_model currentTab].findInPageController.findInPageModel;
-        [_findBarController updateResultsCount:model];
-      }];
+  [findInPageController findStringInPage:[_findBarController searchTerm]
+                       completionHandler:^{
+                         FindInPageModel* model =
+                             findInPageController.findInPageModel;
+                         [_findBarController updateResultsCount:model];
+                       }];
   if (!_isOffTheRecord)
     [findInPageController saveSearchTerm];
 }
 
 - (void)closeFindInPage {
   base::WeakNSObject<BrowserViewController> weakSelf(self);
-  [[_model currentTab].findInPageController
-      disableFindInPageWithCompletionHandler:^{
-        [weakSelf updateFindBar:NO shouldFocus:NO];
-      }];
+  FindInPageController* findInPageController =
+      FindTabHelper::FromWebState([_model currentTab].webState)
+          ->GetController();
+  [findInPageController disableFindInPageWithCompletionHandler:^{
+    [weakSelf updateFindBar:NO shouldFocus:NO];
+  }];
 }
 
 - (void)updateFindBar:(BOOL)initialUpdate shouldFocus:(BOOL)shouldFocus {
-  FindInPageModel* model =
-      [_model currentTab].findInPageController.findInPageModel;
+  FindInPageController* findInPageController =
+      FindTabHelper::FromWebState([_model currentTab].webState)
+          ->GetController();
+  FindInPageModel* model = findInPageController.findInPageModel;
   if (model.enabled) {
     if (initialUpdate && !_isOffTheRecord) {
-      [[_model currentTab].findInPageController restoreSearchTerm];
+      [findInPageController restoreSearchTerm];
     }
 
     [self setFramesForHeaders:[self headerViews]
                      atOffset:[self currentHeaderOffset]];
     [_findBarController updateView:model
                      initialUpdate:initialUpdate
                     focusTextfield:shouldFocus];
   } else {
     [self hideFindBarWithAnimation:YES];
   }
@@ skipping 798 matching lines @@
 
 - (UIView*)voiceSearchButton {
   return _voiceSearchButton;
 }
 
 - (id<LogoAnimationControllerOwner>)logoAnimationControllerOwner {
   return [self currentLogoAnimationControllerOwner];
 }
 
 @end