Introduces a search term extraction mechanism working for arbitrary search providers.

chrome/browser/search_engines/template_url_service.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 "chrome/browser/search_engines/template_url_service.h"
 
 #include "base/auto_reset.h"
 #include "base/command_line.h"
 #include "base/compiler_specific.h"
 #include "base/environment.h"
@@ skipping 67 matching lines @@
     return true;
   return (url1 != NULL) && (url2 != NULL) &&
       (url1->short_name() == url2->short_name()) &&
       url1->HasSameKeywordAs(*url2) &&
       (url1->url() == url2->url()) &&
       (url1->suggestions_url() == url2->suggestions_url()) &&
       (url1->instant_url() == url2->instant_url()) &&
       (url1->favicon_url() == url2->favicon_url()) &&
       (url1->safe_for_autoreplace() == url2->safe_for_autoreplace()) &&
       (url1->show_in_default_list() == url2->show_in_default_list()) &&
-      (url1->input_encodings() == url2->input_encodings());
+      (url1->input_encodings() == url2->input_encodings()) &&
+      (url1->alternate_urls() == url2->alternate_urls());
 }
 
 const char kFirstPotentialEngineHistogramName[] =
     "Search.FirstPotentialEngineCalled";
 
 // Values for an enumerated histogram used to track whenever
 // FirstPotentialDefaultEngine is called, and from where.
 enum FirstPotentialEngineCaller {
   FIRST_POTENTIAL_CALLSITE_FIND_NEW_DSP,
   FIRST_POTENTIAL_CALLSITE_FIND_NEW_DSP_PROCESSING_SYNC_CHANGES,
@@ skipping 1195 matching lines @@
   se_specifics->set_safe_for_autoreplace(turl.safe_for_autoreplace());
   se_specifics->set_originating_url(turl.originating_url().spec());
   se_specifics->set_date_created(turl.date_created().ToInternalValue());
   se_specifics->set_input_encodings(JoinString(turl.input_encodings(), ';'));
   se_specifics->set_show_in_default_list(turl.show_in_default_list());
   se_specifics->set_suggestions_url(turl.suggestions_url());
   se_specifics->set_prepopulate_id(turl.prepopulate_id());
   se_specifics->set_instant_url(turl.instant_url());
   se_specifics->set_last_modified(turl.last_modified().ToInternalValue());
   se_specifics->set_sync_guid(turl.sync_guid());
+  for (size_t i = 0; i < turl.alternate_urls().size(); ++i)
+    se_specifics->add_alternate_urls(turl.alternate_urls()[i]);

[Peter Kasting, 2012/10/02 21:47:59]

Would be nice if we could just call a
"set_alternate_urls(turl.alternate_urls())" function.  Is that possible?

Similar question applies to reading the value back out.

[beaudoin, 2012/10/03 22:46:52]

Unfortunately, here is the complete interface generated for alternate_urls in
se_specifics:

  // repeated string alternate_urls = 19;
  inline int alternate_urls_size() const;
  inline void clear_alternate_urls();
  static const int kAlternateUrlsFieldNumber = 19;
  inline const ::std::string& alternate_urls(int index) const;
  inline ::std::string* mutable_alternate_urls(int index);
  inline void set_alternate_urls(int index, const ::std::string& value);
  inline void set_alternate_urls(int index, const char* value);
  inline void set_alternate_urls(int index, const char* value, size_t size);
  inline ::std::string* add_alternate_urls();
  inline void add_alternate_urls(const ::std::string& value);
  inline void add_alternate_urls(const char* value);
  inline void add_alternate_urls(const char* value, size_t size);
  inline const ::google::protobuf::RepeatedPtrField< ::std::string>&
alternate_urls() const;
  inline ::google::protobuf::RepeatedPtrField< ::std::string>*
mutable_alternate_urls();

And RepeatedPtrField does not seem to allow direct assignment from STL vectors
either...

+
   return syncer::SyncData::CreateLocalData(se_specifics->sync_guid(),
                                    se_specifics->keyword(),
                                    specifics);
 }
 
 // static
 TemplateURL* TemplateURLService::CreateTemplateURLFromTemplateURLAndSyncData(
     Profile* profile,
     TemplateURL* existing_turl,
     const syncer::SyncData& sync_data,
@@ skipping 39 matching lines @@
   base::SplitString(specifics.input_encodings(), ';', &data.input_encodings);
   // If the server data has duplicate encodings, we'll want to push an update
   // below to correct it.  Note that we also fix this in
   // GetSearchProvidersUsingKeywordResult(), since otherwise we'd never correct
   // local problems for clients which have disabled search engine sync.
   bool deduped = DeDupeEncodings(&data.input_encodings);
   data.date_created = base::Time::FromInternalValue(specifics.date_created());
   data.last_modified = base::Time::FromInternalValue(specifics.last_modified());
   data.prepopulate_id = specifics.prepopulate_id();
   data.sync_guid = specifics.sync_guid();
+  data.alternate_urls.clear();
+  for (int i = 0; i < specifics.alternate_urls_size(); ++i)
+    data.alternate_urls.push_back(specifics.alternate_urls(i));
 
   TemplateURL* turl = new TemplateURL(profile, data);
   DCHECK(!turl->IsExtensionKeyword());
   if (reset_keyword || deduped) {
     if (reset_keyword)
       turl->ResetKeywordIfNecessary(true);
     syncer::SyncData sync_data = CreateSyncDataFromTemplateURL(*turl);
     change_list->push_back(
         syncer::SyncChange(FROM_HERE,
                            syncer::SyncChange::ACTION_UPDATE,
@@ skipping 272 matching lines @@
   prefs->SetBoolean(prefs::kDefaultSearchProviderEnabled, enabled);
   prefs->SetString(prefs::kDefaultSearchProviderSearchURL, search_url);
   prefs->SetString(prefs::kDefaultSearchProviderSuggestURL, suggest_url);
   prefs->SetString(prefs::kDefaultSearchProviderInstantURL, instant_url);
   prefs->SetString(prefs::kDefaultSearchProviderIconURL, icon_url);
   prefs->SetString(prefs::kDefaultSearchProviderEncodings, encodings);
   prefs->SetString(prefs::kDefaultSearchProviderName, short_name);
   prefs->SetString(prefs::kDefaultSearchProviderKeyword, keyword);
   prefs->SetString(prefs::kDefaultSearchProviderID, id_string);
   prefs->SetString(prefs::kDefaultSearchProviderPrepopulateID, prepopulate_id);
+  ListValue alternate_urls_value;

[Peter Kasting, 2012/10/02 21:47:59]

Nit: Move this up to with the other temps above, name it |alternate_urls|, and
populate it inside the "if (t_url)" conditional with everything else

[beaudoin, 2012/10/03 22:46:52]

Done.

+  if (t_url) {
+    for (size_t i = 0; i < t_url->alternate_urls().size(); ++i)
+      alternate_urls_value.AppendString(t_url->alternate_urls()[i]);
+  }
+  prefs->Set(prefs::kDefaultSearchProviderAlternateURLs, alternate_urls_value);
 }
 
 bool TemplateURLService::LoadDefaultSearchProviderFromPrefs(
     scoped_ptr<TemplateURL>* default_provider,
     bool* is_managed) {
   PrefService* prefs = GetPrefs();
   if (!prefs || !prefs->HasPrefPath(prefs::kDefaultSearchProviderSearchURL))
     return false;
 
   const PrefService::Preference* pref =
@@ skipping 28 matching lines @@
       prefs->GetString(prefs::kDefaultSearchProviderSuggestURL);
   std::string instant_url =
       prefs->GetString(prefs::kDefaultSearchProviderInstantURL);
   std::string icon_url =
       prefs->GetString(prefs::kDefaultSearchProviderIconURL);
   std::string encodings =
       prefs->GetString(prefs::kDefaultSearchProviderEncodings);
   std::string id_string = prefs->GetString(prefs::kDefaultSearchProviderID);
   std::string prepopulate_id =
       prefs->GetString(prefs::kDefaultSearchProviderPrepopulateID);
+  const ListValue* alternate_urls =
+      prefs->GetList(prefs::kDefaultSearchProviderAlternateURLs);
 
   TemplateURLData data;
   data.short_name = name;
   data.SetKeyword(keyword);
   data.SetURL(search_url);
   data.suggestions_url = suggest_url;
   data.instant_url = instant_url;
   data.favicon_url = GURL(icon_url);
   data.show_in_default_list = true;
+  data.alternate_urls.clear();
+  std::string alternate_url;

[Peter Kasting, 2012/10/02 21:47:59]

Nit: Declare inside loop (the efficiency loss doesn't matter)

[beaudoin, 2012/10/03 22:46:52]

Done.

+  for (size_t i = 0; i < alternate_urls->GetSize(); ++i) {
+    if (alternate_urls->GetString(i, &alternate_url))
+      data.alternate_urls.push_back(alternate_url);

[Peter Kasting, 2012/10/02 21:47:59]

Isn't there some helper already that can return a ListValue as a vector?

If not we should consider adding helpers to the Value class to convert
ListValues to/from vectors.

[beaudoin, 2012/10/03 22:46:52]

I think the problem is that ListValue does not guarantee it contains only
strings. (Because there is an AppendStrings() method.)

I could create base/value_utils.* for such specialized ListValue (or maybe that
is what base/value_conversion.* is for?)

In all cases, unless you feel strongly about this, I suggest we wrap that CL.
I'm happy to follow-up quickly with this afterward.

[Peter Kasting, 2012/10/03 22:59:33]

It's fine to not address this in this CL.  We may end up doing nothing here.

+  }
   base::SplitString(encodings, ';', &data.input_encodings);
   if (!id_string.empty() && !*is_managed) {
     int64 value;
     base::StringToInt64(id_string, &value);
     data.id = value;
   }
   if (!prepopulate_id.empty() && !*is_managed) {
     int value;
     base::StringToInt(prepopulate_id, &value);
     data.prepopulate_id = value;
@@ skipping 802 matching lines @@
     // TODO(mpcomplete): If we allow editing extension keywords, then those
     // should be persisted to disk and synced.
     if (template_url->sync_guid().empty() &&
         !template_url->IsExtensionKeyword()) {
       template_url->data_.sync_guid = base::GenerateGUID();
       if (service_.get())
         service_->UpdateKeyword(template_url->data());
     }
   }
 }