Pass WebState to NativeAppNavigationController

ios/chrome/browser/native_app_launcher/native_app_navigation_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/native_app_launcher/native_app_navigation_controller.h"
 
 #import <StoreKit/StoreKit.h>
 
 #include "base/metrics/user_metrics.h"
 #include "base/metrics/user_metrics_action.h"
 #include "components/infobars/core/infobar_manager.h"
+#include "ios/chrome/browser/infobars/infobar_manager_impl.h"
 #import "ios/chrome/browser/installation_notifier.h"
 #include "ios/chrome/browser/native_app_launcher/native_app_infobar_delegate.h"
+#include "ios/chrome/browser/native_app_launcher/native_app_navigation_utils.h"
 #import "ios/chrome/browser/open_url_util.h"
 #import "ios/chrome/browser/tabs/tab.h"
 #include "ios/public/provider/chrome/browser/chrome_browser_provider.h"
 #import "ios/public/provider/chrome/browser/native_app_launcher/native_app_metadata.h"
 #import "ios/public/provider/chrome/browser/native_app_launcher/native_app_types.h"
 #import "ios/public/provider/chrome/browser/native_app_launcher/native_app_whitelist_manager.h"
-#import "ios/web/navigation/navigation_manager_impl.h"
-#include "ios/web/public/navigation_item.h"
+#include "ios/web/public/web_state/web_state.h"

[Eugene But (OOO till 7-30), 2017/01/26 01:04:38]

s/include/import

[pkl (ping after 24h if needed), 2017/01/26 02:26:28]

Since web_state.h defines a C++ class, isn't #include correct?

[Eugene But (OOO till 7-30), 2017/01/26 03:10:02]

web_state.h is an Objective-C header (it has @class CRWJSInjectionReceiver;) and
per Style Guide supposed to be imported. 

 #import "net/base/mac/url_conversions.h"
 #include "net/url_request/url_request_context_getter.h"
 
 using base::UserMetricsAction;
 
 @interface NativeAppNavigationController ()
 // Shows a native app infobar by looking at the page's URL and by checking
 // wheter that infobar should be bypassed or not.
 - (void)showInfoBarIfNecessary;
 
 // Returns a pointer to the NSMutableSet of |_appsPossiblyBeingInstalled|
 - (NSMutableSet*)appsPossiblyBeingInstalled;
 
 // Records what type of infobar was opened.
 - (void)recordInfobarDisplayedOfType:(NativeAppControllerType)type
                     onLinkNavigation:(BOOL)isLinkNavigation;
 
-// Returns whether the current state is Link Navigation in the sense of Native
-// App Launcher, i.e. a navigation caused by an explicit user action in the
-// rectangle of the web content area.
-- (BOOL)isLinkNavigation;
-
 @end
 
 @implementation NativeAppNavigationController {
+  // WebState provides access to the *TabHelper objects. This will eventually
+  // replace the need to have |_tab| in this object.
+  web::WebState* _webState;
   // A reference to the URLRequestContextGetter needed to fetch icons.
   scoped_refptr<net::URLRequestContextGetter> _requestContextGetter;
-  // Tab hosting the infobar.
+  // DEPRECATED: Tab hosting the infobar and is also used for accessing Tab
+  // states such as navigation manager and whether it is a pre-rendered tab.
+  // Use |webState| whenever possible.
   __unsafe_unretained Tab* _tab;  // weak
   base::scoped_nsprotocol<id<NativeAppMetadata>> _metadata;
   // A set of appIds encoded as NSStrings.
   base::scoped_nsobject<NSMutableSet> _appsPossiblyBeingInstalled;
 }
 
-// This prevents incorrect initialization of this object.
-- (id)init {
-  NOTREACHED();
-  return nil;
-}
-
 // Designated initializer. Use this instead of -init.
-- (id)initWithRequestContextGetter:(net::URLRequestContextGetter*)context
-                               tab:(Tab*)tab {
+- (instancetype)initWithWebState:(web::WebState*)webState
+            requestContextGetter:(net::URLRequestContextGetter*)context
+                             tab:(Tab*)tab {
   self = [super init];
   if (self) {
     DCHECK(context);
     _requestContextGetter = context;
-    // Allows |tab| to be nil for unit testing.
+    DCHECK(webState);
+    _webState = webState;
+    // Allows |tab| to be nil for unit testing. If not nil, it should have the
+    // same webState.
+    DCHECK(!tab || [tab webState] == webState);
     _tab = tab;
     _appsPossiblyBeingInstalled.reset([[NSMutableSet alloc] init]);
   }
   return self;
 }
 
 - (void)copyStateFrom:(NativeAppNavigationController*)controller {
   DCHECK(controller);
   _appsPossiblyBeingInstalled.reset([[NSMutableSet alloc]
       initWithSet:[controller appsPossiblyBeingInstalled]]);
@@ skipping 14 matching lines @@
   [[InstallationNotifier sharedInstance] unregisterForNotifications:self];
   [super dealloc];
 }
 
 - (NSMutableSet*)appsPossiblyBeingInstalled {
   return _appsPossiblyBeingInstalled;
 }
 
 - (void)showInfoBarIfNecessary {
   // Find a potential matching native app.
-  GURL pageURL = _tab.webState->GetLastCommittedURL();
+  GURL pageURL = _webState->GetLastCommittedURL();
   _metadata.reset(
       [ios::GetChromeBrowserProvider()->GetNativeAppWhitelistManager()
           newNativeAppForURL:pageURL]);
   if (!_metadata || [_metadata shouldBypassInfoBars])
     return;
 
   // Select the infobar type.
   NativeAppControllerType type;
   if ([_metadata canOpenURL:pageURL]) {  // App is installed.
-    type = [self isLinkNavigation] && ![_metadata shouldAutoOpenLinks]
+    type = native_app_launcher::IsLinkNavigation(_webState) &&
+                   ![_metadata shouldAutoOpenLinks]
                ? NATIVE_APP_OPEN_POLICY_CONTROLLER
                : NATIVE_APP_LAUNCHER_CONTROLLER;
   } else {  // App is not installed.
     // Check if the user already opened the store for this app.
     if ([_appsPossiblyBeingInstalled containsObject:[_metadata appId]])
       return;
     type = NATIVE_APP_INSTALLER_CONTROLLER;
   }
   // Inform the metadata that an infobar of |type| will be shown so that metrics
   // and ignored behavior can be handled.
   [_metadata willBeShownInInfobarOfType:type];
   // Display the proper infobar.
-  infobars::InfoBarManager* infoBarManager = [_tab infoBarManager];
+  infobars::InfoBarManager* infoBarManager =
+      InfoBarManagerImpl::FromWebState(_webState);
   NativeAppInfoBarDelegate::Create(infoBarManager, self, pageURL, type);
   [self recordInfobarDisplayedOfType:type
-                    onLinkNavigation:[self isLinkNavigation]];
+                    onLinkNavigation:native_app_launcher::IsLinkNavigation(

[Eugene But (OOO till 7-30), 2017/01/26 01:04:38]

nit: Do you want to use local variable for
native_app_launcher::IsLinkNavigation?

[pkl (ping after 24h if needed), 2017/01/26 02:26:28]

I think so since WebState is not going to change between the 2 calls.

+                                         _webState)];
 }
 
 - (void)recordInfobarDisplayedOfType:(NativeAppControllerType)type
                     onLinkNavigation:(BOOL)isLinkNavigation {
   switch (type) {
     case NATIVE_APP_INSTALLER_CONTROLLER:
       base::RecordAction(
           isLinkNavigation
               ? UserMetricsAction("MobileGALInstallInfoBarLinkNavigation")
               : UserMetricsAction("MobileGALInstallInfoBarDirectNavigation"));
@@ skipping 32 matching lines @@
       registerForInstallationNotifications:self
                               withSelector:@selector(appDidInstall:)
                                  forScheme:[_metadata anyScheme]];
   NSString* appIdString = [self appId];
   // Defensively early return if native app metadata returns an nil string for
   // appId which can cause subsequent -addObject: to throw exceptions.
   if (![appIdString length])
     return;
   DCHECK(![_appsPossiblyBeingInstalled containsObject:appIdString]);
   [_appsPossiblyBeingInstalled addObject:appIdString];
+  // TODO(crbug.com/684063): Preferred method is to add a helper object to
+  // WebState and use the helper object to launch Store Kit.
   [_tab openAppStore:appIdString];
 }
 
 - (void)launchApp:(const GURL&)URL {
   // TODO(crbug.com/353957): Pass the ChromeIdentity to
   // -launchURLWithURL:identity:
   GURL launchURL([_metadata launchURLWithURL:URL identity:nil]);
   if (launchURL.is_valid()) {
     OpenUrlWithCompletionHandler(net::NSURLWithGURL(launchURL), nil);
   }
 }
 
 - (void)updateMetadataWithUserAction:(NativeAppActionType)userAction {
   [_metadata updateWithUserAction:userAction];
 }
 
 #pragma mark -
 #pragma mark CRWWebControllerObserver methods
 
 - (void)pageLoaded:(CRWWebController*)webController {
   if (![_tab isPrerenderTab])
     [self showInfoBarIfNecessary];
 }
 
 - (void)webControllerWillClose:(CRWWebController*)webController {
   [webController removeObserver:self];
 }
 
-- (BOOL)isLinkNavigation {
-  if (![_tab navigationManager])
-    return NO;
-  web::NavigationItem* userItem = [_tab navigationManager]->GetLastUserItem();
-  if (!userItem)
-    return NO;
-  ui::PageTransition currentTransition = userItem->GetTransitionType();
-  return PageTransitionCoreTypeIs(currentTransition,
-                                  ui::PAGE_TRANSITION_LINK) ||
-         PageTransitionCoreTypeIs(currentTransition,
-                                  ui::PAGE_TRANSITION_AUTO_BOOKMARK);
-}
-
 - (void)appDidInstall:(NSNotification*)notification {
   [self removeAppFromNotification:notification];
   [self showInfoBarIfNecessary];
 }
 
 - (void)removeAppFromNotification:(NSNotification*)notification {
   DCHECK([[notification object] isKindOfClass:[InstallationNotifier class]]);
   NSString* schemeOfInstalledApp = [notification name];
   __block NSString* appIDToRemove = nil;
   [_appsPossiblyBeingInstalled
       enumerateObjectsUsingBlock:^(id appID, BOOL* stop) {
         NSURL* appURL =
             [ios::GetChromeBrowserProvider()->GetNativeAppWhitelistManager()
                 schemeForAppId:appID];
         if ([[appURL scheme] isEqualToString:schemeOfInstalledApp]) {
           appIDToRemove = appID;
           *stop = YES;
         }
       }];
   DCHECK(appIDToRemove);
   [_appsPossiblyBeingInstalled removeObject:appIDToRemove];
 }
 
 @end