Pop up requestAutocomplete UI when autofill server hints chrome client that it is in a multipage au…

chrome/browser/autofill/autofill_manager.h

 // Copyright (c) 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.
 
 #ifndef CHROME_BROWSER_AUTOFILL_AUTOFILL_MANAGER_H_
 #define CHROME_BROWSER_AUTOFILL_AUTOFILL_MANAGER_H_
 
 #include <list>
 #include <map>
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/gtest_prod_util.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/scoped_vector.h"
 #include "base/memory/weak_ptr.h"
 #include "base/prefs/public/pref_change_registrar.h"
 #include "base/string16.h"
 #include "base/time.h"
 #include "chrome/browser/api/sync/profile_sync_service_observer.h"
 #include "chrome/browser/autofill/autocomplete_history_manager.h"
 #include "chrome/browser/autofill/autofill_download.h"
 #include "chrome/browser/autofill/field_types.h"
 #include "chrome/browser/autofill/form_structure.h"
 #include "chrome/browser/autofill/personal_data_manager.h"
+#include "chrome/common/form_data.h"

[Ilya Sherman, 2013/01/15 06:31:52]

nit: Move this to the .cc file.

[Raman Kakilate, 2013/01/15 23:02:33]

Removed here.

 #include "content/public/browser/web_contents_observer.h"
 #include "content/public/common/ssl_status.h"
 
 class AutofillExternalDelegate;
 class AutofillField;
 class AutofillProfile;
 class AutofillMetrics;
 class CreditCard;
 class FormGroup;
 class GURL;
@@ skipping 59 matching lines @@
                                      int max_length,
                                      const content::PasswordForm& form);
 
   // Remove the credit card or Autofill profile that matches |unique_id|
   // from the database.
   void RemoveAutofillProfileOrCreditCard(int unique_id);
 
   // Remove the specified Autocomplete entry.
   void RemoveAutocompleteEntry(const string16& name, const string16& value);
 
+  virtual void ShowAutofillFlowDialog(const FormData& form,
+                                      const GURL& frame_url,
+                                      const content::SSLStatus& ssl_status);

[Ilya Sherman, 2013/01/15 06:31:52]

Please create a new file named something like AutocheckoutManager to house all
of the Autocheckout code.  The AutofillManager class is already quite sprawling;
let's not exacerbate that while the code is still easy to untangle.

[Raman Kakilate, 2013/01/15 23:02:33]

I am little confused about what you mean by AutocheckoutManager. Should it
inherit WebContentsObserver similar to AutofillManager and listen to similar
messages from renderer and plug the popping up UI thing from AutocheckoutManager
? If yes, we might have to extract FormStructure once more in
AutocheckoutManager, and this approach seems like overkill.

Or do you mean AutocheckoutManager to be an object contained within
AutofillManager (exposing ShowAutocheckoutFlowDialog and
ReturnAutocheckoutFlowData methods) ? In this case, we need reference of
web_content() to be passed to AutocheckoutManager from Autofill server to init
AutofillDialogController.

Non of the options look good. Please advice.
Present approach I took is extract any utilities required for autocheckout into
autocheckout_util, and have the browser->render interactions done in
autofill_manager itself.

[Ilya Sherman, 2013/01/15 23:24:46]

I mean option (2): Have the AutofillManager call methods on AutocheckoutManager,
and pass in any needed dependencies.  What do you dislike about this approach?

[Raman Kakilate, 2013/01/16 19:20:12]

Ack. Refactored code.

I disliked AutofillManager acting as a proxy, but I now think its fine.

+
  protected:
   // Only test code should subclass AutofillManager.
   friend class base::RefCounted<AutofillManager>;
 
   AutofillManager(content::WebContents* web_contents,
                   autofill::AutofillManagerDelegate* delegate);
   virtual ~AutofillManager();
 
   // Test code should prefer to use this constructor.
   AutofillManager(content::WebContents* web_contents,
@@ skipping 112 matching lines @@
                      const std::vector<int>& unique_ids);
 
   // Requests an interactive autocomplete UI be shown.
   void OnRequestAutocomplete(const FormData& form,
                              const GURL& frame_url,
                              const content::SSLStatus& ssl_status);
 
   // Passes return data for an OnRequestAutocomplete call back to the page.
   void ReturnAutocompleteData(const FormStructure* result);
 
+  // Passes return data for an ShowAutofillFlowDialog call back to the page.
+  void ReturnAutofillFlowData(const FormStructure* result);
+
   // Fills |host| with the RenderViewHost for this tab.
   // Returns false if Autofill is disabled or if the host is unavailable.
   bool GetHost(content::RenderViewHost** host) const WARN_UNUSED_RESULT;
 
   // Unpacks |unique_id| and fills |form_group| and |variant| with the
   // appropriate data source and variant index.  Returns false if the unpacked
   // id cannot be found.
   bool GetProfileOrCreditCard(int unique_id,
                               const FormGroup** form_group,
                               size_t* variant) const WARN_UNUSED_RESULT;
@@ skipping 143 matching lines @@
   FRIEND_TEST_ALL_PREFIXES(AutofillManagerTest,
                            TestTabContentsWithExternalDelegate);
   FRIEND_TEST_ALL_PREFIXES(AutofillMetricsTest,
                            UserHappinessFormLoadAndSubmission);
   FRIEND_TEST_ALL_PREFIXES(AutofillMetricsTest, UserHappinessFormInteraction);
 
   DISALLOW_COPY_AND_ASSIGN(AutofillManager);
 };
 
 #endif  // CHROME_BROWSER_AUTOFILL_AUTOFILL_MANAGER_H_