components/search_engines/template_url_prepopulate_data.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef COMPONENTS_SEARCH_ENGINES_TEMPLATE_URL_PREPOPULATE_DATA_H_
   6 #define COMPONENTS_SEARCH_ENGINES_TEMPLATE_URL_PREPOPULATE_DATA_H_
   7
   8 #include <stddef.h>
   9 #include <string>
  10 #include <vector>
  11
  12 #include "base/memory/scoped_ptr.h"
  13 #include "base/memory/scoped_vector.h"
  14 #include "base/strings/string16.h"
  15 #include "components/search_engines/search_engine_type.h"
  16
  17 class GURL;
  18 class PrefService;
  19 class Profile;
  20 class SearchTermsData;
  21 class TemplateURL;
  22 struct TemplateURLData;
  23
  24 namespace user_prefs {
  25 class PrefRegistrySyncable;
  26 }
  27
  28 namespace TemplateURLPrepopulateData {
  29
  30 extern const int kMaxPrepopulatedEngineID;
  31
  32 void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry);
  33
  34 // Returns the current version of the prepopulate data, so callers can know when
  35 // they need to re-merge. If the prepopulate data comes from the preferences
  36 // file then it returns the version specified there.
  37 int GetDataVersion(PrefService* prefs);
  38
  39 // Loads the set of TemplateURLs from the prepopulate data. On return,
  40 // |default_search_provider_index| is set to the index of the default search
  41 // provider.
  42 ScopedVector<TemplateURLData> GetPrepopulatedEngines(
  43     PrefService* prefs,
  44     size_t* default_search_provider_index);
  45
  46 // Removes prepopulated engines and their version stored in user prefs.
  47 void ClearPrepopulatedEnginesInPrefs(PrefService* prefs);
  48
  49 // Returns the default search provider specified by the prepopulate data, which
  50 // may be NULL.
  51 // If |prefs| is NULL, any search provider overrides from the preferences are
  52 // not used.
  53 scoped_ptr<TemplateURLData> GetPrepopulatedDefaultSearch(PrefService* prefs);
  54
  55 // Returns the type of the provided engine, or SEARCH_ENGINE_OTHER if no engines
  56 // match.  This checks the TLD+1 for the most part, but will report the type as
  57 // SEARCH_ENGINE_GOOGLE for any hostname that causes
  58 // google_util::IsGoogleHostname() to return true.
  59 //
  60 // NOTE: Must be called on the UI thread.
  61 SearchEngineType GetEngineType(const TemplateURL& template_url,
  62                                const SearchTermsData& search_terms_data);
  63
  64 // Like the above, but takes a GURL which is expected to represent a search URL.
  65 // This may be called on any thread.
  66 SearchEngineType GetEngineType(const GURL& url);
  67
  68 }  // namespace TemplateURLPrepopulateData
  69
  70 #endif  // COMPONENTS_SEARCH_ENGINES_TEMPLATE_URL_PREPOPULATE_DATA_H_