Make Autofill work again on iPads running iOS 9.

ios/chrome/browser/autofill/form_input_accessory_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/autofill/form_input_accessory_view_controller.h"
 
 #include "base/ios/block_types.h"
+#include "base/ios/ios_util.h"
 #include "base/mac/foundation_util.h"
 #include "base/mac/scoped_block.h"
 #include "base/mac/scoped_nsobject.h"
 #include "base/memory/scoped_ptr.h"
-#include "base/strings/sys_string_conversions.h"
-#include "base/strings/utf_string_conversions.h"
 #import "components/autofill/ios/browser/js_suggestion_manager.h"
 #import "ios/chrome/browser/autofill/form_input_accessory_view.h"
+#import "ios/chrome/browser/autofill/form_suggestion_view.h"
 #import "ios/chrome/browser/passwords/password_generation_utils.h"
+#include "ios/chrome/browser/ui/ui_util.h"
 #include "ios/web/public/test/crw_test_js_injection_receiver.h"
 #include "ios/web/public/url_scheme_util.h"
 #import "ios/web/public/web_state/crw_web_view_proxy.h"
 #include "ios/web/public/web_state/url_verification_constants.h"
 #include "ios/web/public/web_state/web_state.h"
 #include "url/gurl.h"
 
 namespace autofill {
 NSString* const kFormSuggestionAssistButtonPreviousElement = @"previousTap";
 NSString* const kFormSuggestionAssistButtonNextElement = @"nextTap";
 NSString* const kFormSuggestionAssistButtonDone = @"done";
+CGFloat const kInputAccessoryHeight = 44.0f;
 }  // namespace autofill
 
 namespace {
 
 // Finds all views of a particular kind if class |klass| in the subview
 // hierarchy of the given |root| view.
 NSArray* FindDescendantsOfClass(UIView* root, Class klass) {
   DCHECK(root);
   NSMutableArray* viewsToExamine = [NSMutableArray arrayWithObject:root];
   NSMutableArray* descendants = [NSMutableArray array];
@@ skipping 48 matching lines @@
 
 // Computes the frame of each part of the accessory view of the keyboard. It is
 // assumed that the keyboard has either two parts (when it is split) or one part
 // (when it is merged).
 //
 // If there are two parts, the frame of the left part is returned in
 // |leftFrame| and the frame of the right part is returned in |rightFrame|.
 // If there is only one part, the frame is returned in |leftFrame| and
 // |rightFrame| has size zero.
 //
-// Heuristics are used to compute this information. It returns true if the
+// Heuristics are used to compute this information. It returns false if the
 // number of |inputAccessoryView.subviews| is not 2.
 bool ComputeFramesOfKeyboardParts(UIView* inputAccessoryView,
                                   CGRect* leftFrame,
                                   CGRect* rightFrame) {
   // It is observed (on iOS 6) there are always two subviews in the original
   // input accessory view. When the keyboard is split, each subview represents
   // one part of the accesssary view of the keyboard. When the keyboard is
   // merged, one subview has the same frame as that of the whole accessory view
   // and the other has zero size with the screen width as origin.x.
   // The computation here is based on this observation.
@@ skipping 16 matching lines @@
 
 }  // namespace
 
 @interface FormInputAccessoryViewController ()
 
 // Allows injection of the JsSuggestionManager.
 - (instancetype)initWithWebState:(web::WebState*)webState
              JSSuggestionManager:(JsSuggestionManager*)JSSuggestionManager
                        providers:(NSArray*)providers;
 
-// Called when the keyboard did change frame.
-- (void)keyboardDidChangeFrame:(NSNotification*)notification;
+// Called when the keyboard will or did change frame.
+- (void)keyboardWillOrDidChangeFrame:(NSNotification*)notification;
 
 // Called when the keyboard is dismissed.
 - (void)keyboardDidHide:(NSNotification*)notification;
 
 // Hides the subviews in |accessoryView|.
 - (void)hideSubviewsInOriginalAccessoryView:(UIView*)accessoryView;
 
 // Attempts to execute/tap/send-an-event-to the iOS built-in "next" and
 // "previous" form assist controls. Returns NO if this attempt failed, YES
 // otherwise. [HACK]
@@ skipping 35 matching lines @@
   base::scoped_nsobject<JsSuggestionManager> _JSSuggestionManager;
 
   // The original subviews in keyboard accessory view that were originally not
   // hidden but were hidden when showing Autofill suggestions.
   base::scoped_nsobject<NSMutableArray> _hiddenOriginalSubviews;
 
   // The objects that can provide a custom input accessory view while filling
   // forms.
   base::scoped_nsobject<NSArray> _providers;
 
+  // Whether suggestions have previously been shown.
+  BOOL _suggestionsHaveBeenShown;
+
   // The object that manages the currently-shown custom accessory view.
   base::WeakNSProtocol<id<FormInputAccessoryViewProvider>> _currentProvider;
 }
 
 - (instancetype)initWithWebState:(web::WebState*)webState
                        providers:(NSArray*)providers {
   JsSuggestionManager* suggestionManager =
       base::mac::ObjCCastStrict<JsSuggestionManager>(
           [webState->GetJSInjectionReceiver()
               instanceOfClass:[JsSuggestionManager class]]);
   return [self initWithWebState:webState
             JSSuggestionManager:suggestionManager
                       providers:providers];
 }
 
 - (instancetype)initWithWebState:(web::WebState*)webState
              JSSuggestionManager:(JsSuggestionManager*)JSSuggestionManager
                        providers:(NSArray*)providers {
   self = [super init];
   if (self) {
     _JSSuggestionManager.reset([JSSuggestionManager retain]);
     _hiddenOriginalSubviews.reset([[NSMutableArray alloc] init]);
     _webStateObserverBridge.reset(
         new web::WebStateObserverBridge(webState, self));
     _providers.reset([providers copy]);
-    // There is no defined relation on the timing of JavaScript events and
-    // keyboard showing up. So it is necessary to listen to the keyboard
-    // notification to make sure the keyboard is updated.
-    [[NSNotificationCenter defaultCenter]
-        addObserver:self
-           selector:@selector(keyboardDidChangeFrame:)
-               name:UIKeyboardDidChangeFrameNotification
-             object:nil];
-    [[NSNotificationCenter defaultCenter]
-        addObserver:self
-           selector:@selector(keyboardDidHide:)
-               name:UIKeyboardDidHideNotification
-             object:nil];
+    _suggestionsHaveBeenShown = NO;
   }
   return self;
 }
 
+- (void)wasShown {
+  // There is no defined relation on the timing of JavaScript events and
+  // keyboard showing up. So it is necessary to listen to the keyboard
+  // notification to make sure the keyboard is updated.
+  if (base::ios::IsRunningOnIOS9OrLater() && IsIPadIdiom()) {
+    [[NSNotificationCenter defaultCenter]
+        addObserver:self
+           selector:@selector(keyboardWillOrDidChangeFrame:)
+               name:UIKeyboardWillChangeFrameNotification
+             object:nil];
+  }
+  [[NSNotificationCenter defaultCenter]
+      addObserver:self
+         selector:@selector(keyboardWillOrDidChangeFrame:)
+             name:UIKeyboardDidChangeFrameNotification
+           object:nil];
+  [[NSNotificationCenter defaultCenter]
+      addObserver:self
+         selector:@selector(keyboardDidHide:)
+             name:UIKeyboardDidHideNotification
+           object:nil];
+}
+
+- (void)wasHidden {
+  [_customAccessoryView removeFromSuperview];
+  [[NSNotificationCenter defaultCenter] removeObserver:self];
+}
+
 - (void)dealloc {
   [[NSNotificationCenter defaultCenter] removeObserver:self];
   [super dealloc];
 }
 
 - (web::WebState*)webState {
   return _webStateObserverBridge ? _webStateObserverBridge->web_state()
                                  : nullptr;
 }
 
 - (id<CRWWebViewProxy>)webViewProxy {
   return self.webState ? self.webState->GetWebViewProxy() : nil;
 }
 
 - (void)hideSubviewsInOriginalAccessoryView:(UIView*)accessoryView {
   for (UIView* subview in [accessoryView subviews]) {
     if (!subview.hidden) {
       [_hiddenOriginalSubviews addObject:subview];
       subview.hidden = YES;
     }
   }
 }
 
 - (void)showCustomInputAccessoryView:(UIView*)view {

[justincohen, 2015/08/20 17:29:16]

DCHECK(view)

[Justin Donnelly, 2015/08/20 20:24:28]

Done.

-  [self restoreDefaultInputAccessoryView];
-  CGRect leftFrame;
-  CGRect rightFrame;
-  UIView* inputAccessoryView = [self.webViewProxy getKeyboardAccessory];
-  if (ComputeFramesOfKeyboardParts(inputAccessoryView, &leftFrame,
-                                   &rightFrame)) {
-    [self hideSubviewsInOriginalAccessoryView:inputAccessoryView];
+  if (base::ios::IsRunningOnIOS9OrLater() && IsIPadIdiom()) {
+    // On iPads running iOS 9 or later, there's no inputAccessoryView available
+    // so we attach the custom view directly to the keyboard view instead.
+    [_customAccessoryView removeFromSuperview];
+    UIViewController* rootViewController =
+        [UIApplication sharedApplication].keyWindow.rootViewController;
+
+    // If the keyboard isn't visible, another controller has been presented over
+    // the webview (as in the case of the credit card unmask dialog), or no
+    // suggestions have been trigger yet, don't show the custom view.

[justincohen, 2015/08/20 17:29:16]

triggered

[Justin Donnelly, 2015/08/20 20:24:28]

Done.

+    int numSuggestions =
+        [[static_cast<FormSuggestionView*>(view) suggestions] count];
+    if (CGRectIntersection([UIScreen mainScreen].bounds, _keyboardFrame)
+                .size.height == 0 ||
+        CGRectEqualToRect(_keyboardFrame, CGRectZero) ||
+        [rootViewController presentedViewController] ||
+        (!_suggestionsHaveBeenShown && numSuggestions == 0)) {
+      _customAccessoryView.reset();
+      return;
+    }
+    _suggestionsHaveBeenShown = YES;
+
+    CGFloat height = autofill::kInputAccessoryHeight;
+    CGRect frame = CGRectMake(_keyboardFrame.origin.x, -height,
+                              _keyboardFrame.size.width, height);
     _customAccessoryView.reset(
-        [[FormInputAccessoryView alloc] initWithFrame:inputAccessoryView.frame
-                                             delegate:self
-                                           customView:view
-                                            leftFrame:leftFrame
-                                           rightFrame:rightFrame]);
-    [inputAccessoryView addSubview:_customAccessoryView];
+        [[FormInputAccessoryView alloc] initWithFrame:frame customView:view]);
+    UIView* keyboardView = [self getKeyboardView];
+    DCHECK(keyboardView);

[justincohen, 2015/08/20 17:29:16]

I'm curious what keyboardView is if you have a physical keyboard attached (you
can fake this in the simulator).

I'm guessing the view exists, it's just layed out just beneath the bottom of the
rootViewController's bounds.

[Justin Donnelly, 2015/08/20 20:24:28]

I actually do most of my testing in the simulator with a hardware keyboard.
Right, except that the QuickType bar portion of the keyboard view is shown when
available even when the keyboard part of the keyboard view is out of bounds.

+    [keyboardView addSubview:_customAccessoryView];
+  } else {
+    // On all other versions, the custom view replaces the default UI of the
+    // inputAccessoryView.
+    [self restoreDefaultInputAccessoryView];
+    CGRect leftFrame;
+    CGRect rightFrame;
+    UIView* inputAccessoryView = [self.webViewProxy getKeyboardAccessory];
+    if (ComputeFramesOfKeyboardParts(inputAccessoryView, &leftFrame,
+                                     &rightFrame)) {
+      [self hideSubviewsInOriginalAccessoryView:inputAccessoryView];
+      _customAccessoryView.reset([[FormInputAccessoryView alloc]
+          initWithFrame:inputAccessoryView.frame
+               delegate:self
+             customView:view
+              leftFrame:leftFrame
+             rightFrame:rightFrame]);
+      [inputAccessoryView addSubview:_customAccessoryView];
+    }
   }
 }
 
 - (void)restoreDefaultInputAccessoryView {
   [_customAccessoryView removeFromSuperview];
   _customAccessoryView.reset();
   for (UIView* subview in _hiddenOriginalSubviews.get()) {
     subview.hidden = NO;
   }
   [_hiddenOriginalSubviews removeAllObjects];
@@ skipping 194 matching lines @@
                                      webState:webState
                      accessoryViewUpdateBlock:readyCompletion];
       };
 
   // Run all the blocks in |findProviderBlocks| until one invokes its
   // completion with YES. The first one to do so will be passed to
   // |onProviderFound|.
   passwords::RunSearchPipeline(findProviderBlocks, onProviderFound);
 }
 
-- (void)keyboardDidChangeFrame:(NSNotification*)notification {
+- (UIView*)getKeyboardView {
+  NSArray* windows = [UIApplication sharedApplication].windows;
+  if (windows.count < 2)
+    return nil;
+
+  UIWindow* window = windows[1];
+  for (UIView* subview in window.subviews) {
+    if ([NSStringFromClass([subview class])
+            isEqualToString:@"UIPeripheralHost"]) {
+      return subview;
+    }
+    if ([NSStringFromClass([subview class])
+            isEqualToString:@"UIInputSetContainerView"]) {
+      for (UIView* subsubview in subview.subviews) {
+        if ([NSStringFromClass([subsubview class])
+                isEqualToString:@"UIInputSetHostView"]) {
+          return subsubview;
+        }
+      }
+    }
+  }
+
+  return nil;
+}
+
+- (void)keyboardWillOrDidChangeFrame:(NSNotification*)notification {
   if (!self.webState || !_currentProvider)
     return;
   CGRect keyboardFrame =
       [notification.userInfo[UIKeyboardFrameEndUserInfoKey] CGRectValue];
   // With iOS8 (beta) this method can be called even when the rect has not
   // changed. When this is detected we exit early.
   if (CGRectEqualToRect(CGRectIntegral(_keyboardFrame),
                         CGRectIntegral(keyboardFrame))) {
     return;
   }
   _keyboardFrame = keyboardFrame;
   [_currentProvider resizeAccessoryView];
 }
 
 - (void)keyboardDidHide:(NSNotification*)notification {
   _keyboardFrame = CGRectZero;
 }
 
 @end