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

chrome/browser/protector/default_search_provider_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 <algorithm>
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/logging.h"
 #include "base/memory/scoped_ptr.h"
@@ skipping 20 matching lines @@
 #include "grit/theme_resources.h"
 #include "ui/base/l10n/l10n_util.h"
 
 namespace protector {
 
 namespace {
 
 // Maximum length of the search engine name to be displayed.
 const size_t kMaxDisplayedNameLength = 16;
 
+// Priority for the display name.
+const size_t kNamePriority = 100U;
+
 // Matches TemplateURL with all fields set from the prepopulated data equal
 // to fields in another TemplateURL.
 class TemplateURLIsSame {
  public:
   // Creates a matcher based on |other|.
   explicit TemplateURLIsSame(const TemplateURL* other) : other_(other) {
   }
 
   // Returns true if both |other| and |url| are NULL or have same field values.
   bool operator()(const TemplateURL* url) {
@@ skipping 39 matching lines @@
   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 ~DefaultSearchProviderChange();
 
   // TemplateURLServiceObserver overrides:
   virtual void OnTemplateURLServiceChanged() OVERRIDE;
 
   // content::NotificationObserver overrides:
   virtual void Observe(int type,
                        const content::NotificationSource& source,
@@ skipping 31 matching lines @@
   const TemplateURL* new_search_provider_;
   // Default search provider set by Init for the period until user makes a
   // choice and either Apply or Discard is performed. Never is |NULL| during
   // that period since the change will dismiss itself if this provider gets
   // deleted or stops being the default.
   const TemplateURL* default_search_provider_;
   // Stores backup of the default search until it becomes owned by the
   // TemplateURLService or deleted.
   scoped_ptr<TemplateURL> backup_search_provider_;
   content::NotificationRegistrar registrar_;
-

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

Could you, please, leave the blank line?

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

Done.

   DISALLOW_COPY_AND_ASSIGN(DefaultSearchProviderChange);
 };
 
 DefaultSearchProviderChange::DefaultSearchProviderChange(
     const TemplateURL* new_search_provider,
     TemplateURL* backup_search_provider)
     : new_histogram_id_(GetSearchProviderHistogramID(new_search_provider)),
       is_fallback_(false),
       fallback_is_new_(false),
       new_search_provider_(new_search_provider),
@@ skipping 153 matching lines @@
   if (!is_fallback_) {
     string16 name = default_search_provider_->short_name();
     return (name.length() > kMaxDisplayedNameLength) ?
         l10n_util::GetStringUTF16(IDS_KEEP_SETTING) :
         l10n_util::GetStringFUTF16(IDS_KEEP_SEARCH_ENGINE, name);
   }
   // Old setting is lost, offer to go to settings.
   return l10n_util::GetStringUTF16(IDS_SELECT_SEARCH_ENGINE);
 }
 
+BaseSettingChange::DisplayName
+DefaultSearchProviderChange::GetApplyDisplayName() const {
+  if (new_search_provider_ &&
+      new_search_provider_->short_name().length() <= kMaxDisplayedNameLength) {
+    return DisplayName(kNamePriority, new_search_provider_->short_name());
+  }
+  return DisplayName(kDefaultNamePriority, string16());
+}
+
+std::string DefaultSearchProviderChange::GetApplyKeyword() const {
+  std::string host;
+  if (is_fallback_) {
+    // Do not collide this change when fallback was made, since the message
+    // and Discard behaviour is pretty different.
+    return host;
+  }
+  if (!new_search_provider_)
+    return host;
+  // TODO(ivankr): may need to check for google base URL and return something
+  // like "google.com" in that case (same in other changes), so that all google

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

using .com in this case could be confusing ("I thought I was using google.ru"
(c) user), maybe just Google?

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

This "keyword" is only used for comparing changes to decide which should be
merged, user-visible name is returned by GetApplyDisplayName.

It's probably easier to fix the merging algorithm in ProtectorService to merge
changes with "google.*" keywords together.

+  // domains are treated as equal.
+  host = new_search_provider_->url_ref().GetHost();
+  DCHECK(!host.empty());
+  return host;
+}
+
 void DefaultSearchProviderChange::OnTemplateURLServiceChanged() {
   TemplateURLService* url_service = GetTemplateURLService();
   if (url_service->GetDefaultSearchProvider() != default_search_provider_) {
     VLOG(1) << "Default search provider has been changed by user";
     default_search_provider_ = NULL;
     url_service->RemoveObserver(this);
     // Will delete this DefaultSearchProviderChange instance.
     ProtectorServiceFactory::GetForProfile(profile())->DismissChange(this);
   }
 }
@@ skipping 56 matching lines @@
   DCHECK(url_service);
   return url_service;
 }
 
 BaseSettingChange* CreateDefaultSearchProviderChange(const TemplateURL* actual,
                                                      TemplateURL* backup) {
   return new DefaultSearchProviderChange(actual, backup);
 }
 
 }  // namespace protector