Move OmniboxFieldTrial to components

chrome/browser/omnibox/omnibox_field_trial.cc

Index: chrome/browser/omnibox/omnibox_field_trial.cc
diff --git a/chrome/browser/omnibox/omnibox_field_trial.cc b/chrome/browser/omnibox/omnibox_field_trial.cc
deleted file mode 100644
index bef5a8445af2ed6b6f99145ed2c477df085b407b..0000000000000000000000000000000000000000
--- a/chrome/browser/omnibox/omnibox_field_trial.cc
+++ /dev/null
@@ -1,443 +0,0 @@
-// 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/omnibox/omnibox_field_trial.h"
-
-#include <cmath>
-#include <string>
-
-#include "base/command_line.h"
-#include "base/metrics/field_trial.h"
-#include "base/strings/string_number_conversions.h"
-#include "base/strings/string_split.h"
-#include "base/strings/string_util.h"
-#include "base/strings/stringprintf.h"
-#include "base/time/time.h"
-#include "chrome/common/chrome_switches.h"
-#include "chrome/common/variations/variation_ids.h"
-#include "components/metrics/proto/omnibox_event.pb.h"
-#include "components/search/search.h"
-#include "components/variations/active_field_trials.h"
-#include "components/variations/metrics_util.h"
-#include "components/variations/variations_associated_data.h"
-
-using metrics::OmniboxEventProto;
-
-namespace {
-
-typedef std::map<std::string, std::string> VariationParams;
-typedef HUPScoringParams::ScoreBuckets ScoreBuckets;
-
-// Field trial names.
-const char kStopTimerFieldTrialName[] = "OmniboxStopTimer";
-
-// The autocomplete dynamic field trial name prefix.  Each field trial is
-// configured dynamically and is retrieved automatically by Chrome during
-// the startup.
-const char kAutocompleteDynamicFieldTrialPrefix[] = "AutocompleteDynamicTrial_";
-// The maximum number of the autocomplete dynamic field trials (aka layers).
-const int kMaxAutocompleteDynamicFieldTrials = 5;
-
-
-// Concatenates the autocomplete dynamic field trial prefix with a field trial
-// ID to form a complete autocomplete field trial name.
-std::string DynamicFieldTrialName(int id) {
-  return base::StringPrintf("%s%d", kAutocompleteDynamicFieldTrialPrefix, id);
-}
-
-void InitializeScoreBuckets(const VariationParams& params,
-                            const char* relevance_cap_param,
-                            const char* half_life_param,
-                            const char* score_buckets_param,
-                            ScoreBuckets* score_buckets) {
-  VariationParams::const_iterator it = params.find(relevance_cap_param);
-  if (it != params.end()) {
-    int relevance_cap;
-    if (base::StringToInt(it->second, &relevance_cap))
-      score_buckets->set_relevance_cap(relevance_cap);
-  }
-
-  it = params.find(half_life_param);
-  if (it != params.end()) {
-    int half_life_days;
-    if (base::StringToInt(it->second, &half_life_days))
-      score_buckets->set_half_life_days(half_life_days);
-  }
-
-  it = params.find(score_buckets_param);
-  if (it != params.end()) {
-    // The value of the score bucket is a comma-separated list of
-    // {DecayedCount + ":" + MaxRelevance}.
-    base::StringPairs kv_pairs;
-    if (base::SplitStringIntoKeyValuePairs(it->second, ':', ',', &kv_pairs)) {
-      for (base::StringPairs::const_iterator it = kv_pairs.begin();
-           it != kv_pairs.end(); ++it) {
-        ScoreBuckets::CountMaxRelevance bucket;
-        base::StringToDouble(it->first, &bucket.first);
-        base::StringToInt(it->second, &bucket.second);
-        score_buckets->buckets().push_back(bucket);
-      }
-      std::sort(score_buckets->buckets().begin(),
-                score_buckets->buckets().end(),
-                std::greater<ScoreBuckets::CountMaxRelevance>());
-    }
-  }
-}
-
-}  // namespace
-
-HUPScoringParams::ScoreBuckets::ScoreBuckets()
-    : relevance_cap_(-1),
-      half_life_days_(-1) {
-}
-
-HUPScoringParams::ScoreBuckets::~ScoreBuckets() {
-}
-
-double HUPScoringParams::ScoreBuckets::HalfLifeTimeDecay(
-    const base::TimeDelta& elapsed_time) const {
-  double time_ms;
-  if ((half_life_days_ <= 0) ||
-      ((time_ms = elapsed_time.InMillisecondsF()) <= 0))
-    return 1.0;
-
-  const double half_life_intervals =
-      time_ms / base::TimeDelta::FromDays(half_life_days_).InMillisecondsF();
-  return pow(2.0, -half_life_intervals);
-}
-
-void OmniboxFieldTrial::ActivateDynamicTrials() {
-  // Initialize all autocomplete dynamic field trials.  This method may be
-  // called multiple times.
-  for (int i = 0; i < kMaxAutocompleteDynamicFieldTrials; ++i)
-    base::FieldTrialList::FindValue(DynamicFieldTrialName(i));
-}
-
-int OmniboxFieldTrial::GetDisabledProviderTypes() {
-  // Make sure that Autocomplete dynamic field trials are activated.  It's OK to
-  // call this method multiple times.
-  ActivateDynamicTrials();
-
-  // Look for group names in form of "DisabledProviders_<mask>" where "mask"
-  // is a bitmap of disabled provider types (AutocompleteProvider::Type).
-  int provider_types = 0;
-  for (int i = 0; i < kMaxAutocompleteDynamicFieldTrials; ++i) {
-    std::string group_name = base::FieldTrialList::FindFullName(
-        DynamicFieldTrialName(i));
-    const char kDisabledProviders[] = "DisabledProviders_";
-    if (!StartsWithASCII(group_name, kDisabledProviders, true))
-      continue;
-    int types = 0;
-    if (!base::StringToInt(base::StringPiece(
-            group_name.substr(strlen(kDisabledProviders))), &types))
-      continue;
-    provider_types |= types;
-  }
-  return provider_types;
-}
-
-void OmniboxFieldTrial::GetActiveSuggestFieldTrialHashes(
-    std::vector<uint32>* field_trial_hashes) {
-  field_trial_hashes->clear();
-  for (int i = 0; i < kMaxAutocompleteDynamicFieldTrials; ++i) {
-    const std::string& trial_name = DynamicFieldTrialName(i);
-    if (base::FieldTrialList::TrialExists(trial_name))
-      field_trial_hashes->push_back(metrics::HashName(trial_name));
-  }
-  if (base::FieldTrialList::TrialExists(kBundledExperimentFieldTrialName)) {
-    field_trial_hashes->push_back(
-        metrics::HashName(kBundledExperimentFieldTrialName));
-  }
-}
-
-base::TimeDelta OmniboxFieldTrial::StopTimerFieldTrialDuration() {
-  int stop_timer_ms;
-  if (base::StringToInt(
-      base::FieldTrialList::FindFullName(kStopTimerFieldTrialName),
-          &stop_timer_ms))
-    return base::TimeDelta::FromMilliseconds(stop_timer_ms);
-  return base::TimeDelta::FromMilliseconds(1500);
-}
-
-bool OmniboxFieldTrial::InZeroSuggestFieldTrial() {
-  if (variations::GetVariationParamValue(
-          kBundledExperimentFieldTrialName, kZeroSuggestRule) == "true")
-    return true;
-  if (variations::GetVariationParamValue(
-          kBundledExperimentFieldTrialName, kZeroSuggestRule) == "false")
-    return false;
-#if defined(OS_WIN) || defined(OS_CHROMEOS) || defined(OS_LINUX) || \
-    (defined(OS_MACOSX) && !defined(OS_IOS))
-  return true;
-#else
-  return false;
-#endif
-}
-
-bool OmniboxFieldTrial::InZeroSuggestMostVisitedFieldTrial() {
-  return variations::GetVariationParamValue(
-      kBundledExperimentFieldTrialName,
-      kZeroSuggestVariantRule) == "MostVisited";
-}
-
-bool OmniboxFieldTrial::InZeroSuggestAfterTypingFieldTrial() {
-  return variations::GetVariationParamValue(
-      kBundledExperimentFieldTrialName,
-      kZeroSuggestVariantRule) == "AfterTyping";
-}
-
-bool OmniboxFieldTrial::InZeroSuggestPersonalizedFieldTrial() {
-  return variations::GetVariationParamValue(
-      kBundledExperimentFieldTrialName,
-      kZeroSuggestVariantRule) == "Personalized";
-}
-
-bool OmniboxFieldTrial::ShortcutsScoringMaxRelevance(
-    OmniboxEventProto::PageClassification current_page_classification,
-    int* max_relevance) {
-  // The value of the rule is a string that encodes an integer containing
-  // the max relevance.
-  const std::string& max_relevance_str =
-      OmniboxFieldTrial::GetValueForRuleInContext(
-          kShortcutsScoringMaxRelevanceRule, current_page_classification);
-  if (max_relevance_str.empty())
-    return false;
-  if (!base::StringToInt(max_relevance_str, max_relevance))
-    return false;
-  return true;
-}
-
-bool OmniboxFieldTrial::SearchHistoryPreventInlining(
-    OmniboxEventProto::PageClassification current_page_classification) {
-  return OmniboxFieldTrial::GetValueForRuleInContext(
-      kSearchHistoryRule, current_page_classification) == "PreventInlining";
-}
-
-bool OmniboxFieldTrial::SearchHistoryDisable(
-    OmniboxEventProto::PageClassification current_page_classification) {
-  return OmniboxFieldTrial::GetValueForRuleInContext(
-      kSearchHistoryRule, current_page_classification) == "Disable";
-}
-
-void OmniboxFieldTrial::GetDemotionsByType(
-    OmniboxEventProto::PageClassification current_page_classification,
-    DemotionMultipliers* demotions_by_type) {
-  demotions_by_type->clear();
-  std::string demotion_rule = OmniboxFieldTrial::GetValueForRuleInContext(
-      kDemoteByTypeRule, current_page_classification);
-  // If there is no demotion rule for this context, then use the default
-  // value for that context.  At the moment the default value is non-empty
-  // only for the fakebox-focus context.
-  if (demotion_rule.empty() &&
-      (current_page_classification ==
-       OmniboxEventProto::INSTANT_NTP_WITH_FAKEBOX_AS_STARTING_FOCUS))
-    demotion_rule = "1:61,2:61,3:61,4:61,16:61";
-
-  // The value of the DemoteByType rule is a comma-separated list of
-  // {ResultType + ":" + Number} where ResultType is an AutocompleteMatchType::
-  // Type enum represented as an integer and Number is an integer number
-  // between 0 and 100 inclusive.   Relevance scores of matches of that result
-  // type are multiplied by Number / 100.  100 means no change.
-  base::StringPairs kv_pairs;
-  if (base::SplitStringIntoKeyValuePairs(demotion_rule, ':', ',', &kv_pairs)) {
-    for (base::StringPairs::const_iterator it = kv_pairs.begin();
-         it != kv_pairs.end(); ++it) {
-      // This is a best-effort conversion; we trust the hand-crafted parameters
-      // downloaded from the server to be perfect.  There's no need to handle
-      // errors smartly.
-      int k, v;
-      base::StringToInt(it->first, &k);
-      base::StringToInt(it->second, &v);
-      (*demotions_by_type)[static_cast<AutocompleteMatchType::Type>(k)] =
-          static_cast<float>(v) / 100.0f;
-    }
-  }
-}
-
-void OmniboxFieldTrial::GetExperimentalHUPScoringParams(
-    HUPScoringParams* scoring_params) {
-  scoring_params->experimental_scoring_enabled = false;
-
-  VariationParams params;
-  if (!variations::GetVariationParams(kBundledExperimentFieldTrialName,
-                                      &params))
-    return;
-
-  VariationParams::const_iterator it = params.find(kHUPNewScoringEnabledParam);
-  if (it != params.end()) {
-    int enabled = 0;
-    if (base::StringToInt(it->second, &enabled))
-      scoring_params->experimental_scoring_enabled = (enabled != 0);
-  }
-
-  InitializeScoreBuckets(params, kHUPNewScoringTypedCountRelevanceCapParam,
-      kHUPNewScoringTypedCountHalfLifeTimeParam,
-      kHUPNewScoringTypedCountScoreBucketsParam,
-      &scoring_params->typed_count_buckets);
-  InitializeScoreBuckets(params, kHUPNewScoringVisitedCountRelevanceCapParam,
-      kHUPNewScoringVisitedCountHalfLifeTimeParam,
-      kHUPNewScoringVisitedCountScoreBucketsParam,
-      &scoring_params->visited_count_buckets);
-}
-
-int OmniboxFieldTrial::HQPBookmarkValue() {
-  std::string bookmark_value_str =
-      variations::GetVariationParamValue(kBundledExperimentFieldTrialName,
-                                         kHQPBookmarkValueRule);
-  if (bookmark_value_str.empty())
-    return 10;
-  // This is a best-effort conversion; we trust the hand-crafted parameters
-  // downloaded from the server to be perfect.  There's no need for handle
-  // errors smartly.
-  int bookmark_value;
-  base::StringToInt(bookmark_value_str, &bookmark_value);
-  return bookmark_value;
-}
-
-bool OmniboxFieldTrial::HQPAllowMatchInTLDValue() {
-  return variations::GetVariationParamValue(
-      kBundledExperimentFieldTrialName,
-      kHQPAllowMatchInTLDRule) == "true";
-}
-
-bool OmniboxFieldTrial::HQPAllowMatchInSchemeValue() {
-  return variations::GetVariationParamValue(
-      kBundledExperimentFieldTrialName,
-      kHQPAllowMatchInSchemeRule) == "true";
-}
-
-bool OmniboxFieldTrial::BookmarksIndexURLsValue() {
-  return variations::GetVariationParamValue(
-      kBundledExperimentFieldTrialName,
-      kBookmarksIndexURLsRule) == "true";
-}
-
-bool OmniboxFieldTrial::DisableInlining() {
-  return variations::GetVariationParamValue(
-      kBundledExperimentFieldTrialName,
-      kDisableInliningRule) == "true";
-}
-
-bool OmniboxFieldTrial::EnableAnswersInSuggest() {
-  const CommandLine* cl = CommandLine::ForCurrentProcess();
-  if (cl->HasSwitch(switches::kDisableAnswersInSuggest))
-    return false;
-  if (cl->HasSwitch(switches::kEnableAnswersInSuggest))
-    return true;
-
-  return variations::GetVariationParamValue(
-      kBundledExperimentFieldTrialName,
-      kAnswersInSuggestRule) == "true";
-}
-
-bool OmniboxFieldTrial::AddUWYTMatchEvenIfPromotedURLs() {
-  return variations::GetVariationParamValue(
-      kBundledExperimentFieldTrialName,
-      kAddUWYTMatchEvenIfPromotedURLsRule) == "true";
-}
-
-bool OmniboxFieldTrial::DisplayHintTextWhenPossible() {
-  return variations::GetVariationParamValue(
-      kBundledExperimentFieldTrialName,
-      kDisplayHintTextWhenPossibleRule) == "true";
-}
-
-const char OmniboxFieldTrial::kBundledExperimentFieldTrialName[] =
-    "OmniboxBundledExperimentV1";
-const char OmniboxFieldTrial::kShortcutsScoringMaxRelevanceRule[] =
-    "ShortcutsScoringMaxRelevance";
-const char OmniboxFieldTrial::kSearchHistoryRule[] = "SearchHistory";
-const char OmniboxFieldTrial::kDemoteByTypeRule[] = "DemoteByType";
-const char OmniboxFieldTrial::kHQPBookmarkValueRule[] =
-    "HQPBookmarkValue";
-const char OmniboxFieldTrial::kHQPAllowMatchInTLDRule[] = "HQPAllowMatchInTLD";
-const char OmniboxFieldTrial::kHQPAllowMatchInSchemeRule[] =
-    "HQPAllowMatchInScheme";
-const char OmniboxFieldTrial::kZeroSuggestRule[] = "ZeroSuggest";
-const char OmniboxFieldTrial::kZeroSuggestVariantRule[] = "ZeroSuggestVariant";
-const char OmniboxFieldTrial::kBookmarksIndexURLsRule[] = "BookmarksIndexURLs";
-const char OmniboxFieldTrial::kDisableInliningRule[] = "DisableInlining";
-const char OmniboxFieldTrial::kAnswersInSuggestRule[] = "AnswersInSuggest";
-const char OmniboxFieldTrial::kAddUWYTMatchEvenIfPromotedURLsRule[] =
-    "AddUWYTMatchEvenIfPromotedURLs";
-const char OmniboxFieldTrial::kDisplayHintTextWhenPossibleRule[] =
-    "DisplayHintTextWhenPossible";
-
-const char OmniboxFieldTrial::kHUPNewScoringEnabledParam[] =
-    "HUPExperimentalScoringEnabled";
-const char OmniboxFieldTrial::kHUPNewScoringTypedCountRelevanceCapParam[] =
-    "TypedCountRelevanceCap";
-const char OmniboxFieldTrial::kHUPNewScoringTypedCountHalfLifeTimeParam[] =
-    "TypedCountHalfLifeTime";
-const char OmniboxFieldTrial::kHUPNewScoringTypedCountScoreBucketsParam[] =
-    "TypedCountScoreBuckets";
-const char OmniboxFieldTrial::kHUPNewScoringVisitedCountRelevanceCapParam[] =
-    "VisitedCountRelevanceCap";
-const char OmniboxFieldTrial::kHUPNewScoringVisitedCountHalfLifeTimeParam[] =
-    "VisitedCountHalfLifeTime";
-const char OmniboxFieldTrial::kHUPNewScoringVisitedCountScoreBucketsParam[] =
-    "VisitedCountScoreBuckets";
-
-// Background and implementation details:
-//
-// Each experiment group in any field trial can come with an optional set of
-// parameters (key-value pairs).  In the bundled omnibox experiment
-// (kBundledExperimentFieldTrialName), each experiment group comes with a
-// list of parameters in the form:
-//   key=<Rule>:
-//       <OmniboxEventProto::PageClassification (as an int)>:
-//       <whether Instant Extended is enabled (as a 1 or 0)>
-//     (note that there are no linebreaks in keys; this format is for
-//      presentation only>
-//   value=<arbitrary string>
-// Both the OmniboxEventProto::PageClassification and the Instant Extended
-// entries can be "*", which means this rule applies for all values of the
-// matching portion of the context.
-// One example parameter is
-//   key=SearchHistory:6:1
-//   value=PreventInlining
-// This means in page classification context 6 (a search result page doing
-// search term replacement) with Instant Extended enabled, the SearchHistory
-// experiment should PreventInlining.
-//
-// When an exact match to the rule in the current context is missing, we
-// give preference to a wildcard rule that matches the instant extended
-// context over a wildcard rule that matches the page classification
-// context.  Hopefully, though, users will write their field trial configs
-// so as not to rely on this fall back order.
-//
-// In short, this function tries to find the value associated with key
-// |rule|:|page_classification|:|instant_extended|, failing that it looks up
-// |rule|:*:|instant_extended|, failing that it looks up
-// |rule|:|page_classification|:*, failing that it looks up |rule|:*:*,
-// and failing that it returns the empty string.
-std::string OmniboxFieldTrial::GetValueForRuleInContext(
-    const std::string& rule,
-    OmniboxEventProto::PageClassification page_classification) {
-  VariationParams params;
-  if (!variations::GetVariationParams(kBundledExperimentFieldTrialName,
-                                      &params)) {
-    return std::string();
-  }
-  const std::string page_classification_str =
-      base::IntToString(static_cast<int>(page_classification));
-  const std::string instant_extended =
-      chrome::IsInstantExtendedAPIEnabled() ? "1" : "0";
-  // Look up rule in this exact context.
-  VariationParams::const_iterator it = params.find(
-      rule + ":" + page_classification_str + ":" + instant_extended);
-  if (it != params.end())
-    return it->second;
-  // Fall back to the global page classification context.
-  it = params.find(rule + ":*:" + instant_extended);
-  if (it != params.end())
-    return it->second;
-  // Fall back to the global instant extended context.
-  it = params.find(rule + ":" + page_classification_str + ":*");
-  if (it != params.end())
-    return it->second;
-  // Look up rule in the global context.
-  it = params.find(rule + ":*:*");
-  return (it != params.end()) ? it->second : std::string();
-}