File: template_url_prepopulate_data_resolver.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (82 lines) | stat: -rw-r--r-- 3,195 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_SEARCH_ENGINES_TEMPLATE_URL_PREPOPULATE_DATA_RESOLVER_H_
#define COMPONENTS_SEARCH_ENGINES_TEMPLATE_URL_PREPOPULATE_DATA_RESOLVER_H_

#include <optional>
#include <vector>

#include "base/memory/raw_ref.h"
#include "components/keyed_service/core/keyed_service.h"
#include "components/regional_capabilities/regional_capabilities_country_id.h"
#include "components/search_engines/keyword_web_data_service.h"

struct TemplateURLData;
class PrefService;

namespace regional_capabilities {
class RegionalCapabilitiesService;
}

namespace TemplateURLPrepopulateData {

// Provides context on TemplateURLPrepopulateData's data set.
struct BuiltinKeywordsMetadata {
  // Country for which we are selecting the built-in prepopulate data.
  regional_capabilities::CountryIdHolder country_id;

  // Version of the built-in prepopulated keywords data.
  int data_version;
};

// Resolves prepopulated engines using on various information from the browser
// context, like country, state of some prefs, etc.
// Use this service instead directly calling functions from
// `TemplateURLPrepopulateData`.
class Resolver : public KeyedService {
 public:
  Resolver(PrefService& prefs,
           regional_capabilities::RegionalCapabilitiesService&
               regional_capabilities);

  // Returns the prepopulated URLs for the profile country.
  std::vector<std::unique_ptr<TemplateURLData>> GetPrepopulatedEngines() const;

  // Returns the prepopulated search engine with the given `prepopulated_id`
  // from the profile country's known prepopulated search engines, or `nullptr`
  // if it's not known there.
  std::unique_ptr<TemplateURLData> GetPrepopulatedEngine(
      int prepopulated_id) const;

  // Returns the prepopulated search engine with the given `prepopulated_id`
  // from the full list of known prepopulated search engines, or `nullptr` if
  // it's not known there.
  std::unique_ptr<TemplateURLData> GetEngineFromFullList(
      int prepopulated_id) const;

  // Returns the fallback default search provider, currently hardcoded to be
  // Google, or whichever one is the first of the list if Google is not in the
  // list of prepopulated search engines.
  // May return `nullptr` if for some reason there are no prepopulated search
  // engines available.
  std::unique_ptr<TemplateURLData> GetFallbackSearch() const;

  // Computes whether updates relative to prepopulated search engines need to be
  // made in the local search engines database.
  //
  // Returns `std::nullopt` when no updates are needed, or a `Metadata`
  // providing country and data version info about the data to be merged in.
  std::optional<BuiltinKeywordsMetadata> ComputeDatabaseUpdateRequirements(
      const WDKeywordsResult::Metadata& keywords_database_metadata) const;

 private:
  raw_ref<PrefService> profile_prefs_;
  raw_ref<regional_capabilities::RegionalCapabilitiesService>
      regional_capabilities_;
};

}  // namespace TemplateURLPrepopulateData

#endif  // COMPONENTS_SEARCH_ENGINES_TEMPLATE_URL_PREPOPULATE_DATA_RESOLVER_H_