summaryrefslogtreecommitdiff
path: root/chromium/components/search_engines/desktop_search_utils.cc
blob: 0999476777168863454070d09d01f0cdf561935f (plain)
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
// Copyright 2016 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 "components/search_engines/desktop_search_utils.h"

#include <string>

#include "base/memory/scoped_ptr.h"
#include "base/metrics/histogram_macros.h"
#include "base/metrics/user_metrics.h"
#include "base/strings/string_util.h"
#include "components/pref_registry/pref_registry_syncable.h"
#include "components/prefs/pref_service.h"
#include "components/search_engines/prepopulated_engines.h"
#include "components/search_engines/template_url_prepopulate_data.h"
#include "components/search_engines/template_url_service.h"
#include "components/search_engines/util.h"
#include "net/base/url_util.h"

namespace {

// Values for the Search.DesktopSearch.URLAction histogram.
enum DesktopSearchURLAction {
  DESKTOP_SEARCH_URL_ACTION_NO_REDIRECTION_FEATURE_DISABLED = 0,
  DESKTOP_SEARCH_URL_ACTION_NO_REDIRECTION_DEFAULT_SEARCH_IS_BING = 1,
  DESKTOP_SEARCH_URL_ACTION_NO_REDIRECTION_INVALID_SEARCH_ENGINE = 2,
  DESKTOP_SEARCH_URL_ACTION_REDIRECTION = 3,
  DESKTOP_SEARCH_URL_ACTION_MAX
};

void RecordDesktopSearchURLAction(DesktopSearchURLAction action) {
  DCHECK_LT(action, DESKTOP_SEARCH_URL_ACTION_MAX);
  UMA_HISTOGRAM_ENUMERATION("Search.DesktopSearch.URLAction", action,
                            DESKTOP_SEARCH_URL_ACTION_MAX);
}

// Detects whether a |url| comes from a desktop search. If so, puts the search
// terms in |search_terms| and returns true.
bool DetectDesktopSearch(const GURL& url,
                         const SearchTermsData& search_terms_data,
                         base::string16* search_terms) {
  DCHECK(search_terms);
  search_terms->clear();

  scoped_ptr<TemplateURLData> template_url_data =
      TemplateURLPrepopulateData::MakeTemplateURLDataFromPrepopulatedEngine(
          TemplateURLPrepopulateData::bing);
  TemplateURL template_url(*template_url_data);
  if (!template_url.ExtractSearchTermsFromURL(url, search_terms_data,
                                              search_terms))
    return false;

  // Query parameter that tells the source of a Bing search URL, and values
  // associated with desktop search.
  const char kBingSourceQueryKey[] = "form";
  const char kBingSourceDesktopText[] = "WNSGPH";
  const char kBingSourceDesktopVoice[] = "WNSBOX";
  for (net::QueryIterator it(url); !it.IsAtEnd(); it.Advance()) {
    // Use a case-insensitive comparison because the key is sometimes in capital
    // letters.
    if (base::EqualsCaseInsensitiveASCII(it.GetKey(), kBingSourceQueryKey)) {
      const std::string source = it.GetValue();
      if (source == kBingSourceDesktopText || source == kBingSourceDesktopVoice)
        return true;
    }
  }

  return false;
}

}  // namespace

namespace prefs {
const char kDesktopSearchRedirectionInfobarShownPref[] =
    "desktop_search_redirection_infobar_shown";
}  // namespace prefs

const base::Feature kDesktopSearchRedirectionFeature{
    "DesktopSearchRedirection", base::FEATURE_DISABLED_BY_DEFAULT};

void RegisterDesktopSearchRedirectionPref(
    user_prefs::PrefRegistrySyncable* registry) {
  registry->RegisterBooleanPref(
      prefs::kDesktopSearchRedirectionInfobarShownPref, false);
}

bool ReplaceDesktopSearchURLWithDefaultSearchURLIfNeeded(
    const PrefService* pref_service,
    TemplateURLService* template_url_service,
    GURL* url) {
  DCHECK(pref_service);
  DCHECK(template_url_service);
  DCHECK(url);

  // Check if |url| is a desktop search.
  base::string16 search_terms;
  if (!DetectDesktopSearch(*url, template_url_service->search_terms_data(),
                           &search_terms))
    return false;

  // Record that the user searched from the desktop.
  base::RecordAction(base::UserMetricsAction("DesktopSearch"));

  // Check if the redirection feature is enabled.
  if (!base::FeatureList::IsEnabled(kDesktopSearchRedirectionFeature)) {
    RecordDesktopSearchURLAction(
        DESKTOP_SEARCH_URL_ACTION_NO_REDIRECTION_FEATURE_DISABLED);
    return false;
  }

  // Check if the default search engine is Bing.
  const TemplateURL* default_search_engine =
      template_url_service->GetDefaultSearchProvider();
  if (default_search_engine &&
      TemplateURLPrepopulateData::GetEngineType(
          *default_search_engine, template_url_service->search_terms_data()) ==
          SEARCH_ENGINE_BING) {
    RecordDesktopSearchURLAction(
        DESKTOP_SEARCH_URL_ACTION_NO_REDIRECTION_DEFAULT_SEARCH_IS_BING);
    return false;
  }

  // Replace |url| by a default search engine URL.
  GURL search_url(
      GetDefaultSearchURLForSearchTerms(template_url_service, search_terms));
  if (!search_url.is_valid()) {
    RecordDesktopSearchURLAction(
        DESKTOP_SEARCH_URL_ACTION_NO_REDIRECTION_INVALID_SEARCH_ENGINE);
    return false;
  }

  RecordDesktopSearchURLAction(DESKTOP_SEARCH_URL_ACTION_REDIRECTION);

  url->Swap(&search_url);
  return !pref_service->GetBoolean(
      prefs::kDesktopSearchRedirectionInfobarShownPref);
}