Introduce PasswordsModelDelegate as an abstraction between ManagePasswordsBubbleModel and ManagePas…

chrome/browser/ui/passwords/manage_passwords_ui_controller.cc

 // 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.
 
 #include "chrome/browser/ui/passwords/manage_passwords_ui_controller.h"
 
 #include "base/auto_reset.h"
 #include "chrome/app/chrome_command_ids.h"
 #include "chrome/browser/browsing_data/browsing_data_helper.h"
 #include "chrome/browser/password_manager/chrome_password_manager_client.h"
@@ skipping 156 matching lines @@
           password_manager::ui::AUTO_SIGNIN_STATE &&
       passwords_data_.state() !=
           password_manager::ui::CREDENTIAL_REQUEST_STATE) {
     passwords_data_.OnPasswordAutofilled(password_form_map, origin);
     UpdateBubbleAndIconVisibility();
   }
 }
 
 void ManagePasswordsUIController::OnLoginsChanged(
     const password_manager::PasswordStoreChangeList& changes) {
-  password_manager::ui::State current_state = state();
+  password_manager::ui::State current_state = GetState();
   passwords_data_.ProcessLoginsChanged(changes);
-  if (current_state != state())
+  if (current_state != GetState())
     UpdateBubbleAndIconVisibility();
 }
 
-void ManagePasswordsUIController::NavigateToPasswordManagerSettingsPage() {
-#if defined(OS_ANDROID)
-  chrome::android::ChromeApplication::ShowPasswordSettings();
-#else
-  chrome::ShowSettingsSubPage(
-      chrome::FindBrowserWithWebContents(web_contents()),
-      chrome::kPasswordManagerSubPage);
-#endif
+const GURL& ManagePasswordsUIController::GetOrigin() const {
+  return passwords_data_.origin();
+}
+
+password_manager::ui::State ManagePasswordsUIController::GetState() const {
+  return passwords_data_.state();
+}
+
+const autofill::PasswordForm& ManagePasswordsUIController::
+    GetPendingPassword() const {
+  if (GetState() == password_manager::ui::AUTO_SIGNIN_STATE)
+    return *GetCurrentForms()[0];
+
+  DCHECK(GetState() == password_manager::ui::PENDING_PASSWORD_STATE ||
+         GetState() == password_manager::ui::PENDING_PASSWORD_UPDATE_STATE ||
+         GetState() == password_manager::ui::CONFIRMATION_STATE)
+      << GetState();
+  password_manager::PasswordFormManager* form_manager =
+      passwords_data_.form_manager();
+  return form_manager->pending_credentials();
+}
+
+bool ManagePasswordsUIController::IsPasswordOverridden() const {
+  const password_manager::PasswordFormManager* form_manager =
+      passwords_data_.form_manager();
+  return form_manager ? form_manager->password_overridden() : false;
+}
+
+const std::vector<const autofill::PasswordForm*>&
+ManagePasswordsUIController::GetCurrentForms() const {
+  return passwords_data_.GetCurrentForms();
+}
+
+const std::vector<const autofill::PasswordForm*>&
+ManagePasswordsUIController::GetFederatedForms() const {
+  return passwords_data_.federated_credentials_forms();
+}
+
+void ManagePasswordsUIController::OnBubbleShown() {
+  should_pop_up_bubble_ = false;
+}
+
+void ManagePasswordsUIController::OnBubbleHidden() {
+  // Avoid using |state()| which is overridden for some unit tests.

[vabr (Chromium), 2015/11/18 08:59:45]

There is no more state(), and the code below is using the replacement,
GetState(). The comment should be updated (or deleted, if there is no more
concern).

[vasilii, 2015/11/18 12:27:45]

Done.

+  if (GetState() == password_manager::ui::CREDENTIAL_REQUEST_STATE ||
+      GetState() == password_manager::ui::CONFIRMATION_STATE ||
+      GetState() == password_manager::ui::AUTO_SIGNIN_STATE) {
+    passwords_data_.TransitionToState(password_manager::ui::MANAGE_STATE);
+    UpdateBubbleAndIconVisibility();
+  }
+}
+
+void ManagePasswordsUIController::OnNoInteractionOnUpdate() {
+  if (GetState() != password_manager::ui::PENDING_PASSWORD_UPDATE_STATE) {
+    // Do nothing if the state was changed. It can happen for example when the
+    // update bubble is active and a page navigation happens.
+    return;
+  }
+  password_manager::PasswordFormManager* form_manager =
+      passwords_data_.form_manager();
+  DCHECK(form_manager);
+  form_manager->OnNoInteractionOnUpdate();
+}
+
+void ManagePasswordsUIController::OnNopeUpdateClicked() {
+  password_manager::PasswordFormManager* form_manager =
+      passwords_data_.form_manager();
+  DCHECK(form_manager);
+  form_manager->OnNopeUpdateClicked();
+}
+
+void ManagePasswordsUIController::NeverSavePassword() {
+  DCHECK_EQ(password_manager::ui::PENDING_PASSWORD_STATE, GetState());
+  NeverSavePasswordInternal();
+  // The state stays the same.
+}
+
+void ManagePasswordsUIController::SavePassword() {
+  DCHECK_EQ(password_manager::ui::PENDING_PASSWORD_STATE, GetState());
+  SavePasswordInternal();
+  passwords_data_.TransitionToState(password_manager::ui::MANAGE_STATE);
+  UpdateBubbleAndIconVisibility();
+}
+
+void ManagePasswordsUIController::UpdatePassword(
+    const autofill::PasswordForm& password_form) {
+  DCHECK_EQ(password_manager::ui::PENDING_PASSWORD_UPDATE_STATE, GetState());
+  UpdatePasswordInternal(password_form);
+  passwords_data_.TransitionToState(password_manager::ui::MANAGE_STATE);
+  UpdateBubbleAndIconVisibility();
+}
+
+void ManagePasswordsUIController::ChooseCredential(
+    const autofill::PasswordForm& form,
+    password_manager::CredentialType credential_type) {
+  passwords_data_.ChooseCredential(form, credential_type);
 }
 
 void ManagePasswordsUIController::NavigateToExternalPasswordManager() {
 #if defined(OS_ANDROID)
   NOTREACHED();
 #else
   chrome::NavigateParams params(
       chrome::FindBrowserWithWebContents(web_contents()),
       GURL(chrome::kPasswordManagerAccountDashboardURL),
       ui::PAGE_TRANSITION_LINK);
@@ skipping 20 matching lines @@
   NOTREACHED();
 #else
   chrome::NavigateParams params(
       chrome::FindBrowserWithWebContents(web_contents()),
       GURL(chrome::kSmartLockHelpPage), ui::PAGE_TRANSITION_LINK);
   params.disposition = NEW_FOREGROUND_TAB;
   chrome::Navigate(&params);
 #endif
 }
 
-void ManagePasswordsUIController::SavePassword() {
-  DCHECK_EQ(password_manager::ui::PENDING_PASSWORD_STATE, state());
-  SavePasswordInternal();
-  passwords_data_.TransitionToState(password_manager::ui::MANAGE_STATE);
-  UpdateBubbleAndIconVisibility();
-}
-
-void ManagePasswordsUIController::UpdatePassword(
-    const autofill::PasswordForm& password_form) {
-  DCHECK_EQ(password_manager::ui::PENDING_PASSWORD_UPDATE_STATE, state());
-  UpdatePasswordInternal(password_form);
-  passwords_data_.TransitionToState(password_manager::ui::MANAGE_STATE);
-  UpdateBubbleAndIconVisibility();
-}
-
-void ManagePasswordsUIController::ChooseCredential(
-    const autofill::PasswordForm& form,
-    password_manager::CredentialType credential_type) {
-  passwords_data_.ChooseCredential(form, credential_type);
+void ManagePasswordsUIController::NavigateToPasswordManagerSettingsPage() {
+#if defined(OS_ANDROID)
+  chrome::android::ChromeApplication::ShowPasswordSettings();
+#else
+  chrome::ShowSettingsSubPage(
+      chrome::FindBrowserWithWebContents(web_contents()),
+      chrome::kPasswordManagerSubPage);
+#endif
 }
 
 void ManagePasswordsUIController::SavePasswordInternal() {
   password_manager::PasswordStore* password_store =
       GetPasswordStore(web_contents());
   password_manager::PasswordFormManager* form_manager =
       passwords_data_.form_manager();
   for (const autofill::PasswordForm* form :
        form_manager->blacklisted_matches()) {
     password_store->RemoveLogin(*form);
   }
 
   form_manager->Save();
 }
 
 void ManagePasswordsUIController::UpdatePasswordInternal(
     const autofill::PasswordForm& password_form) {
   password_manager::PasswordFormManager* form_manager =
       passwords_data_.form_manager();
   form_manager->Update(password_form);
 }
 
-void ManagePasswordsUIController::NeverSavePassword() {
-  DCHECK_EQ(password_manager::ui::PENDING_PASSWORD_STATE, state());
-  NeverSavePasswordInternal();
-  // The state stays the same.
-}
-
 void ManagePasswordsUIController::NeverSavePasswordInternal() {
   password_manager::PasswordFormManager* form_manager =
       passwords_data_.form_manager();
   DCHECK(form_manager);
   form_manager->PermanentlyBlacklist();
 }
 
 void ManagePasswordsUIController::DidNavigateMainFrame(
     const content::LoadCommittedDetails& details,
     const content::FrameNavigateParams& params) {
@@ skipping 13 matching lines @@
   // process of navigating to the landing page is longer than 1 second.
   timer_.reset(new base::ElapsedTimer());
 }
 
 void ManagePasswordsUIController::WasHidden() {
 #if !defined(OS_ANDROID)
   TabDialogs::FromWebContents(web_contents())->HideManagePasswordsBubble();
 #endif
 }
 
-const autofill::PasswordForm& ManagePasswordsUIController::
-    PendingPassword() const {
-  if (state() == password_manager::ui::AUTO_SIGNIN_STATE)
-    return *GetCurrentForms()[0];
-
-  DCHECK(state() == password_manager::ui::PENDING_PASSWORD_STATE ||
-         state() == password_manager::ui::PENDING_PASSWORD_UPDATE_STATE ||
-         state() == password_manager::ui::CONFIRMATION_STATE)
-      << state();
-  password_manager::PasswordFormManager* form_manager =
-      passwords_data_.form_manager();
-  return form_manager->pending_credentials();
-}
-
-bool ManagePasswordsUIController::PasswordOverridden() const {
-  const password_manager::PasswordFormManager* form_manager =
-      passwords_data_.form_manager();
-  return form_manager ? form_manager->password_overridden() : false;
-}
-
 #if !defined(OS_ANDROID)
 void ManagePasswordsUIController::UpdateIconAndBubbleState(
     ManagePasswordsIconView* icon) {
   if (should_pop_up_bubble_) {
     // We must display the icon before showing the bubble, as the bubble would
     // be otherwise unanchored.
-    icon->SetState(state());
+    icon->SetState(GetState());
     ShowBubbleWithoutUserInteraction();
   } else {
-    icon->SetState(state());
+    icon->SetState(GetState());
   }
 }
 #endif
 
-void ManagePasswordsUIController::OnBubbleShown() {
-  should_pop_up_bubble_ = false;
-}
-
-void ManagePasswordsUIController::OnNopeUpdateClicked() {
-  password_manager::PasswordFormManager* form_manager =
-      passwords_data_.form_manager();
-  DCHECK(form_manager);
-  form_manager->OnNopeUpdateClicked();
-}
-
-void ManagePasswordsUIController::OnNoInteractionOnUpdate() {
-  if (state() != password_manager::ui::PENDING_PASSWORD_UPDATE_STATE) {
-    // Do nothing if the state was changed. It can happen for example when the
-    // update bubble is active and a page navigation happens.
-    return;
-  }
-  password_manager::PasswordFormManager* form_manager =
-      passwords_data_.form_manager();
-  DCHECK(form_manager);
-  form_manager->OnNoInteractionOnUpdate();
-}
-
-void ManagePasswordsUIController::OnBubbleHidden() {
-  // Avoid using |state()| which is overridden for some unit tests.
-  if (state() == password_manager::ui::CREDENTIAL_REQUEST_STATE ||
-      state() == password_manager::ui::CONFIRMATION_STATE ||
-      state() == password_manager::ui::AUTO_SIGNIN_STATE) {
-    passwords_data_.TransitionToState(password_manager::ui::MANAGE_STATE);
-    UpdateBubbleAndIconVisibility();
-  }
-}
-
-password_manager::ui::State ManagePasswordsUIController::state() const {
-  return passwords_data_.state();
-}
-
 void ManagePasswordsUIController::ShowBubbleWithoutUserInteraction() {
   DCHECK(should_pop_up_bubble_);
 #if !defined(OS_ANDROID)
   Browser* browser = chrome::FindBrowserWithWebContents(web_contents());
   if (!browser || browser->toolbar_model()->input_in_progress())
     return;
 
   CommandUpdater* updater = browser->command_controller()->command_updater();
   updater->ExecuteCommand(IDC_MANAGE_PASSWORDS_FOR_PAGE);
 #endif
 }
 
 void ManagePasswordsUIController::WebContentsDestroyed() {
   password_manager::PasswordStore* password_store =
       GetPasswordStore(web_contents());
   if (password_store)
     password_store->RemoveObserver(this);
 }
+
+PasswordsModelDelegate* PasswordsModelDelegateFromWebContents(

[vabr (Chromium), 2015/11/18 08:59:45]

I am not happy about the definition of this function sitting with
ManagePasswordsUIController, while the declaration being with
PasswordsModelDelegate. It creates the false impression that you don't need
ManagePasswordsUIController to get the PasswordsModelDelegate instance.
Separating the two files in the future could cause problems.

I suggest placing this function (def. and decl.) in one .h/.cc pair. They
obviously cannot be in password_model_delegate.* due to a circular dependency of
headers, but they can very well be in the UI controller file. That would mean
that that you have to #include the controller everywhere where you obtain an
instance of the delegate (as opposed to just have it passed from elsewhere), but
that's fair, because the knowledge of the particular implementation is already
tied to calling this function.

Alternatively you can move the function to any other .h/.cc pair, as long as
#includes do not form a circle.

[vasilii, 2015/11/18 12:27:45]

Done.

[vabr (Chromium), 2015/11/18 12:36:40]

Just to acknowledge that I was incorrect here, and that I like your current
solution.

+    content::WebContents* web_contents) {
+  DCHECK(web_contents);
+  return ManagePasswordsUIController::FromWebContents(web_contents);
+}