1116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch// Copyright 2014 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch#ifndef COMPONENTS_SEARCH_ENGINES_TEMPLATE_URL_SERVICE_H_ 6116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch#define COMPONENTS_SEARCH_ENGINES_TEMPLATE_URL_SERVICE_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <list> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <map> 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <set> 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <vector> 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 144e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)#include "base/callback_list.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/gtest_prod_util.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/scoped_ptr.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/observer_list.h" 182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/prefs/pref_change_registrar.h" 19f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles)#include "components/google/core/browser/google_url_tracker.h" 20a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)#include "components/keyed_service/core/keyed_service.h" 21116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch#include "components/search_engines/default_search_manager.h" 22116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch#include "components/search_engines/keyword_web_data_service.h" 23116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch#include "components/search_engines/template_url.h" 24f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles)#include "components/search_engines/template_url_id.h" 25116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch#include "components/webdata/common/web_data_service_consumer.h" 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "sync/api/sync_change.h" 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "sync/api/syncable_service.h" 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class GURL; 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class PrefService; 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class SearchHostToURLsMap; 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class SearchTermsData; 335c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liuclass TemplateURL; 345c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liustruct TemplateURLData; 35116680a4aac90f2aa7413d9095a592090648e557Ben Murdochclass TemplateURLServiceClient; 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class TemplateURLServiceObserver; 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 38116680a4aac90f2aa7413d9095a592090648e557Ben Murdochnamespace rappor { 39116680a4aac90f2aa7413d9095a592090648e557Ben Murdochclass RapporService; 40116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch} 41116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace syncer { 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class SyncData; 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class SyncErrorFactory; 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// TemplateURLService is the backend for keywords. It's used by 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// KeywordAutocomplete. 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// TemplateURLService stores a vector of TemplateURLs. The TemplateURLs are 51116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch// persisted to the database maintained by KeywordWebDataService. 52116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch// *ALL* mutations to the TemplateURLs must funnel through TemplateURLService. 53116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch// This allows TemplateURLService to notify listeners of changes as well as keep 54116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch// the database in sync. 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// TemplateURLService does not load the vector of TemplateURLs in its 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// constructor (except for testing). Use the Load method to trigger a load. 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// When TemplateURLService has completed loading, observers are notified via 594e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)// OnTemplateURLServiceChanged, or by a callback registered prior to calling 604e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)// the Load method. 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// TemplateURLService takes ownership of any TemplateURL passed to it. If there 63116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch// is a KeywordWebDataService, deletion is handled by KeywordWebDataService, 64116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch// otherwise TemplateURLService handles deletion. 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class TemplateURLService : public WebDataServiceConsumer, 67a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) public KeyedService, 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public syncer::SyncableService { 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::map<std::string, std::string> QueryTerms; 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::vector<TemplateURL*> TemplateURLVector; 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Type for a static function pointer that acts as a time source. 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef base::Time(TimeProvider)(); 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::map<std::string, syncer::SyncData> SyncDataMap; 754e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) typedef base::CallbackList<void(void)>::Subscription Subscription; 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Struct used for initializing the data store with fake data. 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Each initializer is mapped to a TemplateURL. 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct Initializer { 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* const keyword; 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* const url; 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* const content; 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch struct URLVisitedDetails { 86116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch GURL url; 87116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch bool is_keyword_transition; 88ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch }; 89ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 901320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci TemplateURLService( 911320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci PrefService* prefs, 921320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci scoped_ptr<SearchTermsData> search_terms_data, 931320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci const scoped_refptr<KeywordWebDataService>& web_data_service, 941320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci scoped_ptr<TemplateURLServiceClient> client, 951320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci GoogleURLTracker* google_url_tracker, 961320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci rappor::RapporService* rappor_service, 971320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci const base::Closure& dsp_change_callback); 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The following is for testing. 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TemplateURLService(const Initializer* initializers, const int count); 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~TemplateURLService(); 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 102010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // Creates a TemplateURLData that was previously saved to |prefs| via 103010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // SaveDefaultSearchProviderToPrefs or set via policy. 104010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // Returns true if successful, false otherwise. 105010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // If the user or the policy has opted for no default search, this 106010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // returns true but default_provider is set to NULL. 107010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // |*is_managed| specifies whether the default is managed via policy. 108010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) static bool LoadDefaultSearchProviderFromPrefs( 109010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) PrefService* prefs, 110010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) scoped_ptr<TemplateURLData>* default_provider_data, 111010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) bool* is_managed); 112010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Removes any unnecessary characters from a user input keyword. 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This removes the leading scheme, "www." and any trailing slash. 115a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) static base::string16 CleanUserInputKeyword(const base::string16& keyword); 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 117010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // Saves enough of url to |prefs| so that it can be loaded from preferences on 118010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // start up. 1190de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) static void SaveDefaultSearchProviderToPrefs(const TemplateURL* url, 1200de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) PrefService* prefs); 121010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if there is no TemplateURL that conflicts with the 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // keyword/url pair, or there is one but it can be replaced. If there is an 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // existing keyword that can be replaced and template_url_to_replace is 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // non-NULL, template_url_to_replace is set to the keyword to replace. 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // url gives the url of the search query. The url is used to avoid generating 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // a TemplateURL for an existing TemplateURL that shares the same host. 129a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) bool CanReplaceKeyword(const base::string16& keyword, 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const GURL& url, 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TemplateURL** template_url_to_replace); 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 133eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch // Returns (in |matches|) all TemplateURLs whose keywords begin with |prefix|, 134eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch // sorted shortest keyword-first. If |support_replacement_only| is true, only 135eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch // TemplateURLs that support replacement are returned. 136a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) void FindMatchingKeywords(const base::string16& prefix, 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool support_replacement_only, 138010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) TemplateURLVector* matches); 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Looks up |keyword| and returns the element it maps to. Returns NULL if 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the keyword was not found. 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The caller should not try to delete the returned pointer; the data store 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // retains ownership of it. 144a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) TemplateURL* GetTemplateURLForKeyword(const base::string16& keyword); 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns that TemplateURL with the specified GUID, or NULL if not found. 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The caller should not try to delete the returned pointer; the data store 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // retains ownership of it. 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TemplateURL* GetTemplateURLForGUID(const std::string& sync_guid); 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the first TemplateURL found with a URL using the specified |host|, 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // or NULL if there are no such TemplateURLs 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TemplateURL* GetTemplateURLForHost(const std::string& host); 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Takes ownership of |template_url| and adds it to this model. For obvious 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // reasons, it is illegal to Add() the same |template_url| pointer twice. 1570de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // Returns true if the Add is successful. 1580de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) bool Add(TemplateURL* template_url); 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Like Add(), but overwrites the |template_url|'s values with the provided 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ones. 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AddWithOverrides(TemplateURL* template_url, 163a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) const base::string16& short_name, 164a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) const base::string16& keyword, 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& url); 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 167116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // Adds a search engine with the specified info. 168116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch void AddExtensionControlledTURL( 169116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch TemplateURL* template_url, 170116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch scoped_ptr<TemplateURL::AssociatedExtensionInfo> info); 1711e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Removes the keyword from the model. This deletes the supplied TemplateURL. 1735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This fails if the supplied template_url is the default search provider. 1745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Remove(TemplateURL* template_url); 1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 176116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // Removes any TemplateURL of the specified |type| associated with 177116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // |extension_id|. Unlike with Remove(), this can be called when the 1781e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // TemplateURL in question is the current default search provider. 179116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch void RemoveExtensionControlledTURL(const std::string& extension_id, 180116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch TemplateURL::Type type); 1811e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Removes all auto-generated keywords that were created on or after the 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // date passed in. 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RemoveAutoGeneratedSince(base::Time created_after); 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Removes all auto-generated keywords that were created in the specified 1875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // range. 1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RemoveAutoGeneratedBetween(base::Time created_after, 1895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::Time created_before); 1905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Removes all auto-generated keywords that were created in the specified 1925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // range for a specified |origin|. If |origin| is empty, deletes all 1935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // auto-generated keywords in the range. 1945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RemoveAutoGeneratedForOriginBetween(const GURL& origin, 1955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::Time created_after, 1965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::Time created_before); 1975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1982a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Adds a TemplateURL for an extension with an omnibox keyword. 1992a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Only 1 keyword is allowed for a given extension. If a keyword 2005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // already exists for this extension, does nothing. 2011e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) void RegisterOmniboxKeyword(const std::string& extension_id, 2021e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) const std::string& extension_name, 203116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch const std::string& keyword, 204116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch const std::string& template_url_string); 2055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the set of URLs describing the keywords. The elements are owned 2075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // by TemplateURLService and should not be deleted. 2085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TemplateURLVector GetTemplateURLs(); 2095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Increment the usage count of a keyword. 2115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a URL is loaded that was generated from a keyword. 2125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void IncrementUsageCount(TemplateURL* url); 2135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Resets the title, keyword and search url of the specified TemplateURL. 2155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The TemplateURL is marked as not replaceable. 2165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ResetTemplateURL(TemplateURL* url, 217a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) const base::string16& title, 218a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) const base::string16& keyword, 2195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& search_url); 2205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 221f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // Return true if the given |url| can be made the default. This returns false 222f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // regardless of |url| if the default search provider is managed by policy or 223f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // controlled by an extension. 2245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool CanMakeDefault(const TemplateURL* url); 2255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Set the default search provider. |url| may be null. 2275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This will assert if the default search is managed; the UI should not be 2285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // invoking this method in that situation. 2295c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu void SetUserSelectedDefaultSearchProvider(TemplateURL* url); 2305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the default search provider. If the TemplateURLService hasn't been 2325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // loaded, the default search provider is pulled from preferences. 2335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 2345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // NOTE: At least in unittest mode, this may return NULL. 2355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TemplateURL* GetDefaultSearchProvider(); 2365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 237ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Returns true if the |url| is a search results page from the default search 238ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // provider. 239ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch bool IsSearchResultsPageFromDefaultSearchProvider(const GURL& url); 240ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 2415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if the default search is managed through group policy. 2420de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) bool is_default_search_managed() const { 2430de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) return default_search_provider_source_ == DefaultSearchManager::FROM_POLICY; 2440de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) } 2455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 246f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // Returns true if the default search provider is controlled by an extension. 247f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) bool IsExtensionControlledDefaultSearch(); 248f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) 2495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the default search specified in the prepopulated data, if it 2505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // exists. If not, returns first URL in |template_urls_|, or NULL if that's 2515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // empty. The returned object is owned by TemplateURLService and can be 2525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // destroyed at any time so should be used right after the call. 2535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TemplateURL* FindNewDefaultSearchProvider(); 2545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2554e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // Performs the same actions that happen when the prepopulate data version is 2564e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // revved: all existing prepopulated entries are checked against the current 2574e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // prepopulate data, any now-extraneous safe_for_autoreplace() entries are 2584e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // removed, any existing engines are reset to the provided data (except for 259010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // user-edited names or keywords), and any new prepopulated engines are 2604e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // added. 2614e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // 2624e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // After this, the default search engine is reset to the default entry in the 2634e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // prepopulate data. 2644e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) void RepairPrepopulatedSearchEngines(); 265868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) 2665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Observers used to listen for changes to the model. 2675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TemplateURLService does NOT delete the observers when deleted. 2685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AddObserver(TemplateURLServiceObserver* observer); 2695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RemoveObserver(TemplateURLServiceObserver* observer); 2705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Loads the keywords. This has no effect if the keywords have already been 2725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // loaded. 2735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Observers are notified when loading completes via the method 2745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // OnTemplateURLServiceChanged. 2755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Load(); 2765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2774e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // Registers a callback to be called when the service has loaded. 2784e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // 2794e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // If the service has already loaded, this function does nothing. 2804e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) scoped_ptr<Subscription> RegisterOnLoadedCallback( 2814e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) const base::Closure& callback); 2824e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) 2835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(UNIT_TEST) 2845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_loaded(bool value) { loaded_ = value; } 2855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 2865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Whether or not the keywords have been loaded. 2885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool loaded() { return loaded_; } 2895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Notification that the keywords have been loaded. 2915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This is invoked from WebDataService, and should not be directly 2925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // invoked. 2935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnWebDataServiceRequestDone( 294116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch KeywordWebDataService::Handle h, 2955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const WDTypedResult* result) OVERRIDE; 2965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the locale-direction-adjusted short name for the given keyword. 2985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Also sets the out param to indicate whether the keyword belongs to an 2991e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // Omnibox extension. 300a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) base::string16 GetKeywordShortName(const base::string16& keyword, 301a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) bool* is_omnibox_api_extension_keyword); 3025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 303116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // Called by the history service when a URL is visited. 304116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch void OnHistoryURLVisited(const URLVisitedDetails& details); 3055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 306a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) // KeyedService implementation. 307c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual void Shutdown() OVERRIDE; 308c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 3095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // syncer::SyncableService implementation. 3105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns all syncable TemplateURLs from this model as SyncData. This should 3125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // include every search engine and no Extension keywords. 3135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual syncer::SyncDataList GetAllSyncData( 3145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) syncer::ModelType type) const OVERRIDE; 3155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Process new search engine changes from Sync, merging them into our local 3165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // data. This may send notifications if local search engines are added, 3175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // updated or removed. 3185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual syncer::SyncError ProcessSyncChanges( 3195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const tracked_objects::Location& from_here, 3205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const syncer::SyncChangeList& change_list) OVERRIDE; 3215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Merge initial search engine data from Sync and push any local changes up 3225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to Sync. This may send notifications if local search engines are added, 3235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // updated or removed. 3242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual syncer::SyncMergeResult MergeDataAndStartSyncing( 3255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) syncer::ModelType type, 3265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const syncer::SyncDataList& initial_sync_data, 3275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<syncer::SyncChangeProcessor> sync_processor, 3285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<syncer::SyncErrorFactory> sync_error_factory) OVERRIDE; 3295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void StopSyncing(syncer::ModelType type) OVERRIDE; 3305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Processes a local TemplateURL change for Sync. |turl| is the TemplateURL 3325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // that has been modified, and |type| is the Sync ChangeType that took place. 3335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This may send a new SyncChange to the cloud. If our model has not yet been 3345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // associated with Sync, or if this is triggered by a Sync change, then this 3355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // does nothing. 3365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ProcessTemplateURLChange(const tracked_objects::Location& from_here, 3375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const TemplateURL* turl, 3385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) syncer::SyncChange::SyncChangeType type); 3395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 340f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // Returns a SearchTermsData which can be used to call TemplateURL methods. 341f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) const SearchTermsData& search_terms_data() const { 342f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) return *search_terms_data_; 343f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) } 344f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 3455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns a SyncData with a sync representation of the search engine data 3465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // from |turl|. 3475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static syncer::SyncData CreateSyncDataFromTemplateURL( 3485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const TemplateURL& turl); 3495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates a new heap-allocated TemplateURL* which is populated by overlaying 3515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |sync_data| atop |existing_turl|. |existing_turl| may be NULL; if not it 3525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // remains unmodified. The caller owns the returned TemplateURL*. 3535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 3545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If the created TemplateURL is migrated in some way from out-of-date sync 3555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // data, an appropriate SyncChange is added to |change_list|. If the sync 3565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // data is bad for some reason, an ACTION_DELETE change is added and the 3575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // function returns NULL. 3585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static TemplateURL* CreateTemplateURLFromTemplateURLAndSyncData( 359116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch PrefService* prefs, 360116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch const SearchTermsData& search_terms_data, 3615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TemplateURL* existing_turl, 3625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const syncer::SyncData& sync_data, 3635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) syncer::SyncChangeList* change_list); 3645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns a map mapping Sync GUIDs to pointers to syncer::SyncData. 3665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static SyncDataMap CreateGUIDToSyncDataMap( 3675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const syncer::SyncDataList& sync_data); 3685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(UNIT_TEST) 3700de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // Sets a different time provider function, such as 3710de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // base::MockTimeProvider::StaticNow, for testing calls to base::Time::Now. 3725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_time_provider(TimeProvider* time_provider) { 3735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) time_provider_ = time_provider; 3745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 3765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 3785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(TemplateURLServiceTest, TestManagedDefaultSearch); 3795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(TemplateURLServiceTest, 3805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) UpdateKeywordSearchTermsForURL); 3815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(TemplateURLServiceTest, 3825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DontUpdateKeywordSearchForNonReplaceable); 3835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(TemplateURLServiceTest, ChangeGoogleBaseValue); 3845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(TemplateURLServiceTest, MergeDeletesUnusedProviders); 3855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(TemplateURLServiceSyncTest, UniquifyKeyword); 3865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(TemplateURLServiceSyncTest, 387010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) IsLocalTemplateURLBetter); 388010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(TemplateURLServiceSyncTest, 3895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ResolveSyncKeywordConflict); 3905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(TemplateURLServiceSyncTest, PreSyncDeletes); 3915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(TemplateURLServiceSyncTest, MergeInSyncTemplateURL); 3925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 393cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) friend class InstantUnitTestBase; 394116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch friend class TemplateURLServiceTestUtil; 3955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3965d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) typedef std::map<base::string16, TemplateURL*> KeywordToTemplateMap; 3975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::map<std::string, TemplateURL*> GUIDToTemplateMap; 3985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Declaration of values to be used in an enumerated histogram to tally 4005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // changes to the default search provider from various entry points. In 4015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // particular, we use this to see what proportion of changes are from Sync 4025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // entry points, to help spot erroneous Sync activity. 4035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum DefaultSearchChangeOrigin { 4045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Various known Sync entry points. 4055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DSP_CHANGE_SYNC_PREF, 4065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DSP_CHANGE_SYNC_ADD, 4075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DSP_CHANGE_SYNC_DELETE, 4085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DSP_CHANGE_SYNC_NOT_MANAGED, 4095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "Other" origins. We differentiate between Sync and not Sync so we know if 4105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // certain changes were intentionally from the system, or possibly some 4115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // unintentional change from when we were Syncing. 4125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DSP_CHANGE_SYNC_UNINTENTIONAL, 413effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch // All changes that don't fall into another category; we can't reorder the 414effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch // list for clarity as this would screw up stat collection. 4157dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch DSP_CHANGE_OTHER, 4167dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch // Changed through "Profile Reset" feature. 4177dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch DSP_CHANGE_PROFILE_RESET, 4181e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // Changed by an extension through the Override Settings API. 4191e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) DSP_CHANGE_OVERRIDE_SETTINGS_EXTENSION, 420effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch // New DSP during database/prepopulate data load, which was not previously 421effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch // in the known engine set, and with no previous value in prefs. The 422effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch // typical time to see this is during first run. 423effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch DSP_CHANGE_NEW_ENGINE_NO_PREFS, 4245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Boundary value. 4255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DSP_CHANGE_MAX, 4265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 4275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Helper functor for FindMatchingKeywords(), for finding the range of 4295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // keywords which begin with a prefix. 4305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class LessWithPrefix; 4315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Init(const Initializer* initializers, int num_initializers); 4335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RemoveFromMaps(TemplateURL* template_url); 4355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AddToMaps(TemplateURL* template_url); 4375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sets the keywords. This is used once the keywords have been loaded. 4395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This does NOT notify the delegate or the database. 440d0247b1b59f9c528cb6df88b4f2b9afaf80d181eTorne (Richard Coles) // 441d0247b1b59f9c528cb6df88b4f2b9afaf80d181eTorne (Richard Coles) // This transfers ownership of the elements in |urls| to |this|, and may 442d0247b1b59f9c528cb6df88b4f2b9afaf80d181eTorne (Richard Coles) // delete some elements, so it's not safe for callers to access any elements 443d0247b1b59f9c528cb6df88b4f2b9afaf80d181eTorne (Richard Coles) // after calling; to reinforce this, this function clears |urls| on exit. 444d0247b1b59f9c528cb6df88b4f2b9afaf80d181eTorne (Richard Coles) void SetTemplateURLs(TemplateURLVector* urls); 4455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Transitions to the loaded state. 4475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ChangeToLoadedState(); 4485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4490de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // Called by DefaultSearchManager when the effective default search engine has 4500de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // changed. 4510de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) void OnDefaultSearchChange(const TemplateURLData* new_dse_data, 4520de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) DefaultSearchManager::Source source); 4530de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) 454cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // Applies a DSE change and reports metrics if appropriate. 4550de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) void ApplyDefaultSearchChange(const TemplateURLData* new_dse_data, 4560de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) DefaultSearchManager::Source source); 457868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) 458cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 459cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // Applies a DSE change. May be called at startup or after transitioning to 460cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // the loaded state. Returns true if a change actually occurred. 461cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) bool ApplyDefaultSearchChangeNoMetrics(const TemplateURLData* new_dse_data, 462cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) DefaultSearchManager::Source source); 463cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 4645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if there is no TemplateURL that has a search url with the 4655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // specified host, or the only TemplateURLs matching the specified host can 4665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // be replaced. 4675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool CanReplaceKeywordForHost(const std::string& host, 4685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TemplateURL** to_replace); 4695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if the TemplateURL is replaceable. This doesn't look at the 4715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // uniqueness of the keyword or host and is intended to be called after those 4725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // checks have been done. This returns true if the TemplateURL doesn't appear 4735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // in the default list and is marked as safe_for_autoreplace. 4745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool CanReplace(const TemplateURL* t_url); 4755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Like GetTemplateURLForKeyword(), but ignores extension-provided keywords. 477a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) TemplateURL* FindNonExtensionTemplateURLForKeyword( 478a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) const base::string16& keyword); 4795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Updates the information in |existing_turl| using the information from 4815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |new_values|, but the ID for |existing_turl| is retained. Notifying 4825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // observers is the responsibility of the caller. Returns whether 4835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |existing_turl| was found in |template_urls_| and thus could be updated. 4845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 4855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // NOTE: This should not be called with an extension keyword as there are no 4865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // updates needed in that case. 4875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool UpdateNoNotify(TemplateURL* existing_turl, 488116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch const TemplateURL& new_values); 4895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4902a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // If the TemplateURL comes from a prepopulated URL available in the current 4912a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // country, update all its fields save for the keyword, short name and id so 4922a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // that they match the internal prepopulated URL. TemplateURLs not coming from 4932a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // a prepopulated URL are not modified. 4942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static void UpdateTemplateURLIfPrepopulated(TemplateURL* existing_turl, 495116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch PrefService* prefs); 4962a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 4970de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // If the TemplateURL's sync GUID matches the kSyncedDefaultSearchProviderGUID 4980de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // preference it will be used to update the DSE in memory and as persisted in 4990de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // preferences. 5000de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) void MaybeUpdateDSEAfterSync(TemplateURL* synced_turl); 5010de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) 5025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Iterates through the TemplateURLs to see if one matches the visited url. 5035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // For each TemplateURL whose url matches the visited url 5045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // SetKeywordSearchTermsForURL is invoked. 505116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch void UpdateKeywordSearchTermsForURL(const URLVisitedDetails& details); 5065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If necessary, generates a visit for the site http:// + t_url.keyword(). 5085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AddTabToSearchVisit(const TemplateURL& t_url); 5095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 510116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // Requests the Google URL tracker to check the server if necessary. 511116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch void RequestGoogleURLTrackerServerCheckIfNecessary(); 512116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 5135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Invoked when the Google base URL has changed. Updates the mapping for all 5145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TemplateURLs that have a replacement term of {google:baseURL} or 5155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // {google:baseSuggestURL}. 516116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch void GoogleBaseURLChanged(); 5175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Adds a new TemplateURL to this model. TemplateURLService will own the 5195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // reference, and delete it when the TemplateURL is removed. 5205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If |newly_adding| is false, we assume that this TemplateURL was already 5215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // part of the model in the past, and therefore we don't need to do things 5225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // like assign it an ID or notify sync. 5235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This function guarantees that on return the model will not have two 5245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // non-extension TemplateURLs with the same keyword. If that means that it 5255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // cannot add the provided argument, it will delete it and return false. 5265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Caller is responsible for notifying observers if this function returns 5275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // true. 5285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool AddNoNotify(TemplateURL* template_url, bool newly_adding); 5295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Removes the keyword from the model. This deletes the supplied TemplateURL. 5315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This fails if the supplied template_url is the default search provider. 5325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Caller is responsible for notifying observers. 5335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RemoveNoNotify(TemplateURL* template_url); 5345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 535010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // Like ResetTemplateURL(), but instead of notifying observers, returns 536010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // whether anything has changed. 537010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) bool ResetTemplateURLNoNotify(TemplateURL* url, 538010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) const base::string16& title, 539010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) const base::string16& keyword, 540010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) const std::string& search_url); 541010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) 5425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Notify the observers that the model has changed. This is done only if the 5435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // model is loaded. 5445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void NotifyObservers(); 5455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5460de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // Updates |template_urls| so that the only "created by policy" entry is 5470de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // |default_from_prefs|. |default_from_prefs| may be NULL if there is no 5480de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // policy-defined DSE in effect. 5490de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) void UpdateProvidersCreatedByPolicy( 5505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TemplateURLVector* template_urls, 5510de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) const TemplateURLData* default_from_prefs); 5525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Resets the sync GUID of the specified TemplateURL and persists the change 5545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to the database. This does not notify observers. 5555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ResetTemplateURLGUID(TemplateURL* url, const std::string& guid); 5565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Attempts to generate a unique keyword for |turl| based on its original 5585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // keyword. If its keyword is already unique, that is returned. Otherwise, it 5595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // tries to return the autogenerated keyword if that is unique to the Service, 5605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // and finally it repeatedly appends special characters to the keyword until 5615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // it is unique to the Service. If |force| is true, then this will only 5625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // execute the special character appending functionality. 563a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) base::string16 UniquifyKeyword(const TemplateURL& turl, bool force); 5645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true iff |local_turl| is considered "better" than |sync_turl| for 5665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the purposes of resolving conflicts. |local_turl| must be a TemplateURL 5675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // known to the local model (though it may already be synced), and |sync_turl| 5685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // is a new TemplateURL known to Sync but not yet known to the local model. 5695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The criteria for if |local_turl| is better than |sync_turl| is whether any 5705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // of the following are true: 5715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // * |local_turl|'s last_modified timestamp is newer than sync_turl. 5725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // * |local_turl| is created by policy. 5735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // * |local_turl| is the local default search provider. 5745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool IsLocalTemplateURLBetter(const TemplateURL* local_turl, 5755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const TemplateURL* sync_turl); 5765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Given two synced TemplateURLs with a conflicting keyword, one of which 5785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // needs to be added to or updated in the local model (|unapplied_sync_turl|) 5795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // and one which is already known to the local model (|applied_sync_turl|), 5805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // prepares the local model so that |unapplied_sync_turl| can be added to it, 5815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // or applied as an update to an existing TemplateURL. 5825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Since both entries are known to Sync and one of their keywords will change, 5835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // an ACTION_UPDATE will be appended to |change_list| to reflect this change. 5845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Note that |applied_sync_turl| must not be an extension keyword. 5855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ResolveSyncKeywordConflict(TemplateURL* unapplied_sync_turl, 5865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TemplateURL* applied_sync_turl, 5875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) syncer::SyncChangeList* change_list); 5885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Adds |sync_turl| into the local model, possibly removing or updating a 5905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // local TemplateURL to make room for it. This expects |sync_turl| to be a new 5915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // entry from Sync, not currently known to the local model. |sync_data| should 5925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // be a SyncDataMap where the contents are entries initially known to Sync 5935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // during MergeDataAndStartSyncing. 5945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Any necessary updates to Sync will be appended to |change_list|. This can 5955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // include updates on local TemplateURLs, if they are found in |sync_data|. 5965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |initial_data| should be a SyncDataMap of the entries known to the local 5975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // model during MergeDataAndStartSyncing. If |sync_turl| replaces a local 5985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // entry, that entry is removed from |initial_data| to prevent it from being 5995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // sent up to Sync. 6002a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // |merge_result| tracks the changes made to the local model. Added/modified/ 6012a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // deleted are updated depending on how the |sync_turl| is merged in. 6025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This should only be called from MergeDataAndStartSyncing. 6035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void MergeInSyncTemplateURL(TemplateURL* sync_turl, 6045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const SyncDataMap& sync_data, 6055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) syncer::SyncChangeList* change_list, 6062a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) SyncDataMap* local_data, 6072a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) syncer::SyncMergeResult* merge_result); 6085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Goes through a vector of TemplateURLs and ensure that both the in-memory 6105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // and database copies have valid sync_guids. This is to fix crbug.com/102038, 6115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // where old entries were being pushed to Sync without a sync_guid. 6125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void PatchMissingSyncGUIDs(TemplateURLVector* template_urls); 6135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6142a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void OnSyncedDefaultSearchProviderGUIDChanged(); 6152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 6160de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // Adds |template_urls| to |template_urls_|. 617d0247b1b59f9c528cb6df88b4f2b9afaf80d181eTorne (Richard Coles) // 618d0247b1b59f9c528cb6df88b4f2b9afaf80d181eTorne (Richard Coles) // This transfers ownership of the elements in |template_urls| to |this|, and 619d0247b1b59f9c528cb6df88b4f2b9afaf80d181eTorne (Richard Coles) // may delete some elements, so it's not safe for callers to access any 620d0247b1b59f9c528cb6df88b4f2b9afaf80d181eTorne (Richard Coles) // elements after calling; to reinforce this, this function clears 621d0247b1b59f9c528cb6df88b4f2b9afaf80d181eTorne (Richard Coles) // |template_urls| on exit. 6220de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) void AddTemplateURLs(TemplateURLVector* template_urls); 623868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) 6240de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // Returns the TemplateURL corresponding to |prepopulated_id|, if any. 6250de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) TemplateURL* FindPrepopulatedTemplateURL(int prepopulated_id); 6260de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) 6271e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // Returns the TemplateURL associated with |extension_id|, if any. 6281e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) TemplateURL* FindTemplateURLForExtension(const std::string& extension_id, 629010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) TemplateURL::Type type); 6301e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) 6310de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // Finds the extension-supplied TemplateURL that matches |data|, if any. 6320de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) TemplateURL* FindMatchingExtensionTemplateURL(const TemplateURLData& data, 6330de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) TemplateURL::Type type); 6341e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) 6350de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // Finds the most recently-installed NORMAL_CONTROLLED_BY_EXTENSION engine 6360de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // that supports replacement and wants to be default, if any. Notifies the 6370de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // DefaultSearchManager, which might change the effective default search 6380de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // engine. 6390de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) void UpdateExtensionDefaultSearchEngine(); 6401e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) 641116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 642116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // ---------- Browser state related members --------------------------------- 643116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch PrefService* prefs_; 644116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 645116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch scoped_ptr<SearchTermsData> search_terms_data_; 646116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 647116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // ---------- Dependencies on other components ------------------------------ 648116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // Service used to store entries. 649116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch scoped_refptr<KeywordWebDataService> web_data_service_; 650116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 651116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch scoped_ptr<TemplateURLServiceClient> client_; 652116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 653116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch GoogleURLTracker* google_url_tracker_; 654116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 655116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // ---------- Metrics related members --------------------------------------- 656116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch rappor::RapporService* rappor_service_; 657116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 658116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // This closure is run when the default search provider is set to Google. 659116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch base::Closure dsp_change_callback_; 660116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 661116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 6625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PrefChangeRegistrar pref_change_registrar_; 6635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Mapping from keyword to the TemplateURL. 6655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) KeywordToTemplateMap keyword_to_template_map_; 6665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Mapping from Sync GUIDs to the TemplateURL. 6685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GUIDToTemplateMap guid_to_template_map_; 6695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TemplateURLVector template_urls_; 6715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ObserverList<TemplateURLServiceObserver> model_observers_; 6735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Maps from host to set of TemplateURLs whose search url host is host. 6755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // NOTE: This is always non-NULL; we use a scoped_ptr<> to avoid circular 6765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // header dependencies. 6775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<SearchHostToURLsMap> provider_map_; 6785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Whether the keywords have been loaded. 6805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool loaded_; 6815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 682010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // Set when the web data service fails to load properly. This prevents 683010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // further communication with sync or writing to prefs, so we don't persist 684010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // inconsistent state data anywhere. 6855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool load_failed_; 6865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If non-zero, we're waiting on a load. 688116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch KeywordWebDataService::Handle load_handle_; 6895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // All visits that occurred before we finished loading. Once loaded 6915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // UpdateKeywordSearchTermsForURL is invoked for each element of the vector. 692116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch std::vector<URLVisitedDetails> visits_to_add_; 6935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Once loaded, the default search provider. This is a pointer to a 695010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // TemplateURL owned by |template_urls_|. 6965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TemplateURL* default_search_provider_; 6975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6980de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // A temporary location for the DSE until Web Data has been loaded and it can 6990de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // be merged into |template_urls_|. 7005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<TemplateURL> initial_default_search_provider_; 7015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7020de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) // Source of the default search provider. 7030de6073388f4e2780db8536178b129cd8f6ab386Torne (Richard Coles) DefaultSearchManager::Source default_search_provider_source_; 7045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ID assigned to next TemplateURL added to this model. This is an ever 7065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // increasing integer that is initialized from the database. 7075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TemplateURLID next_id_; 7085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Function returning current time in base::Time units. 7105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TimeProvider* time_provider_; 7115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Do we have an active association between the TemplateURLs and sync models? 7135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Set in MergeDataAndStartSyncing, reset in StopSyncing. While this is not 7145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // set, we ignore any local search engine changes (when we start syncing we 7155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // will look up the most recent values anyways). 7165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool models_associated_; 7175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Whether we're currently processing changes from the syncer. While this is 7195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // true, we ignore any local search engine changes, since we triggered them. 7205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool processing_syncer_changes_; 7215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sync's syncer::SyncChange handler. We push all our changes through this. 7235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<syncer::SyncChangeProcessor> sync_processor_; 7245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sync's error handler. We use it to create a sync error. 7265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<syncer::SyncErrorFactory> sync_error_factory_; 7275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // A set of sync GUIDs denoting TemplateURLs that have been removed from this 729116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // model or the underlying KeywordWebDataService prior to 730116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // MergeDataAndStartSyncing. 7315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This set is used to determine what entries from the server we want to 7325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ignore locally and return a delete command for. 7335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::set<std::string> pre_sync_deletes_; 7345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This is used to log the origin of changes to the default search provider. 7365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // We set this value to increasingly specific values when we know what is the 7375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // cause/origin of a default search change. 7385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DefaultSearchChangeOrigin dsp_change_origin_; 7395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7404e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // Stores a list of callbacks to be run after TemplateURLService has loaded. 7414e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) base::CallbackList<void(void)> on_loaded_callbacks_; 7424e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) 743010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) // Helper class to manage the default search engine. 744010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) DefaultSearchManager default_search_manager_; 7455c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 746cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) scoped_ptr<GoogleURLTracker::Subscription> google_url_updated_subscription_; 747cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 7485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(TemplateURLService); 7495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 7505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 751116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch#endif // COMPONENTS_SEARCH_ENGINES_TEMPLATE_URL_SERVICE_H_ 752