[protector] Support for collapsing multiple changes into a single one.

chrome/browser/protector/session_startup_change.cc

 // 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.
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/logging.h"
 #include "base/metrics/histogram.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/browser/prefs/session_startup_pref.h"
 #include "chrome/browser/protector/base_prefs_change.h"
 #include "chrome/browser/protector/histograms.h"
 #include "chrome/browser/protector/protector_service.h"
 #include "chrome/browser/protector/protector_service_factory.h"
 #include "chrome/browser/tabs/tab_strip_model.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/browser_navigator.h"
 #include "chrome/common/pref_names.h"
 #include "grit/chromium_strings.h"
 #include "grit/generated_resources.h"
 #include "grit/theme_resources.h"
 #include "ui/base/l10n/l10n_util.h"
 
 namespace protector {
 
+namespace {
+
+// Priority for the display name.
+const size_t kNamePriority = 50U;

[whywhat, 2012/04/06 16:28:32]

Maybe we should put the priorities in a single file so it's easy to figure out
which change has a greater one?
Otherwise I have to look up all priorities when adding a new change type to see
if the priority for it is correctly aligned with the others.

[Ivan Korotkov, 2012/04/09 14:46:47]

Done.

+
+}  // namespace
+
 // Session startup settings change tracked by Protector.
 class SessionStartupChange : public BasePrefsChange {
  public:
   SessionStartupChange(const SessionStartupPref& actual_startup_pref,
                        const PinnedTabCodec::Tabs& actual_pinned_tabs,
                        const SessionStartupPref& backup_startup_pref,
                        const PinnedTabCodec::Tabs& backup_pinned_tabs);
 
   // BaseSettingChange overrides:
   virtual bool Init(Profile* profile) OVERRIDE;
   virtual void Apply(Browser* browser) OVERRIDE;
   virtual void Discard(Browser* browser) OVERRIDE;
   virtual void Timeout() OVERRIDE;
   virtual int GetBadgeIconID() const OVERRIDE;
   virtual int GetMenuItemIconID() const OVERRIDE;
   virtual int GetBubbleIconID() const OVERRIDE;
   virtual string16 GetBubbleTitle() const OVERRIDE;
   virtual string16 GetBubbleMessage() const OVERRIDE;
   virtual string16 GetApplyButtonText() const OVERRIDE;
   virtual string16 GetDiscardButtonText() const OVERRIDE;
+  virtual DisplayName GetApplyDisplayName() const OVERRIDE;
+  virtual std::string GetApplyKeyword() const OVERRIDE;
 
  private:
   virtual ~SessionStartupChange();
 
+  // Returns the first URL among new startup pages. Returns an empty URL if
+  // there are no new startup pages.
+  GURL GetFirstNewURL() const;

[whywhat, 2012/04/06 16:28:32]

What if the first new URL is the same as the old one?
I.e. third party adds their homepage as the last one?

[Ivan Korotkov, 2012/04/09 14:46:47]

I considered that a non-common use case but you're right, ideally we should
compare new and old URLs and pick the first in new that wasn't present in old.
Added a TODO.

+
   // Opens all tabs in |tabs| and makes them pinned.
   void OpenPinnedTabs(Browser* browser, const PinnedTabCodec::Tabs& tabs);
 
   SessionStartupPref new_startup_pref_;
   SessionStartupPref backup_startup_pref_;
   PinnedTabCodec::Tabs new_pinned_tabs_;
   PinnedTabCodec::Tabs backup_pinned_tabs_;
 
   DISALLOW_COPY_AND_ASSIGN(SessionStartupChange);
 };
@@ skipping 72 matching lines @@
 }
 
 string16 SessionStartupChange::GetBubbleMessage() const {
   return l10n_util::GetStringUTF16(IDS_STARTUP_SETTINGS_CHANGE_BUBBLE_MESSAGE);
 }
 
 string16 SessionStartupChange::GetApplyButtonText() const {
   if (new_startup_pref_.type == SessionStartupPref::LAST)
       return l10n_util::GetStringUTF16(IDS_CHANGE_STARTUP_SETTINGS_RESTORE);
 
-  string16 first_url;
-  if (new_startup_pref_.type == SessionStartupPref::URLS &&
-      !new_startup_pref_.urls.empty()) {
-    // Display the domain name of the first statrup URL.
-    first_url = UTF8ToUTF16(new_startup_pref_.urls[0].host());
-  } else if (!new_pinned_tabs_.empty()) {
-    // Start with NTP or no URLs (basically the same): display the domain name
-    // of the first pinned tab, if any.
-    first_url = UTF8ToUTF16(new_pinned_tabs_[0].url.host());
-  }
+  // Display the domain name of the first startup/pinned URL.
+  string16 first_url = UTF8ToUTF16(GetFirstNewURL().host());

[whywhat, 2012/04/06 16:28:32]

so is it first_url or first_url_host?

[Ivan Korotkov, 2012/04/09 14:46:47]

Fixed.

   return first_url.empty() ?
       l10n_util::GetStringUTF16(IDS_CHANGE_STARTUP_SETTINGS_NTP) :
       l10n_util::GetStringFUTF16(IDS_CHANGE_STARTUP_SETTINGS_URLS,
                                  first_url);
 }
 
 string16 SessionStartupChange::GetDiscardButtonText() const {
   return l10n_util::GetStringUTF16(IDS_KEEP_SETTING);
 }
 
+BaseSettingChange::DisplayName
+SessionStartupChange::GetApplyDisplayName() const {
+  string16 first_url = UTF8ToUTF16(GetFirstNewURL().host());
+  return first_url.empty() ? DisplayName(kDefaultNamePriority, string16()) :
+      DisplayName(kNamePriority, first_url);
+}
+
+std::string SessionStartupChange::GetApplyKeyword() const {
+  return GetFirstNewURL().host();
+}
+
+GURL SessionStartupChange::GetFirstNewURL() const {

[whywhat, 2012/04/06 16:28:32]

I guess it could return .host() since it's what every caller is calling
afterwards.

[Ivan Korotkov, 2012/04/09 14:46:47]

Done.

+  if (new_startup_pref_.type == SessionStartupPref::URLS &&
+      !new_startup_pref_.urls.empty()) {
+    return new_startup_pref_.urls[0];
+  }
+  if (!new_pinned_tabs_.empty())
+    return new_pinned_tabs_[0].url;
+  return GURL();
+}
+
 void SessionStartupChange::OpenPinnedTabs(
     Browser* browser,
     const PinnedTabCodec::Tabs& tabs) {
   for (size_t i = 0; i < tabs.size(); ++i) {
     browser::NavigateParams params(browser, tabs[i].url,
                                    content::PAGE_TRANSITION_START_PAGE);
     params.disposition = NEW_BACKGROUND_TAB;
     params.tabstrip_index = -1;
     params.tabstrip_add_types = TabStripModel::ADD_PINNED;
     params.extension_app_id = tabs[i].app_id;
     browser::Navigate(&params);
   }
 }
 
 BaseSettingChange* CreateSessionStartupChange(
     const SessionStartupPref& actual_startup_pref,
     const PinnedTabCodec::Tabs& actual_pinned_tabs,
     const SessionStartupPref& backup_startup_pref,
     const PinnedTabCodec::Tabs& backup_pinned_tabs) {
   return new SessionStartupChange(actual_startup_pref, actual_pinned_tabs,
                                   backup_startup_pref, backup_pinned_tabs);
 }
 
 }  // namespace protector