src/chrome/browser/autocomplete/autocomplete_provider.cc

   1 // Copyright (c) 2012 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 #include "chrome/browser/autocomplete/autocomplete_provider.h"
   6
   7 #include "base/logging.h"
   8 #include "base/prefs/pref_service.h"
   9 #include "base/strings/utf_string_conversions.h"
  10 #include "chrome/browser/autocomplete/autocomplete_match.h"
  11 #include "chrome/browser/autocomplete/autocomplete_provider_listener.h"
  12 #include "chrome/browser/bookmarks/bookmark_model.h"
  13 #include "chrome/browser/bookmarks/bookmark_model_factory.h"
  14 #include "chrome/browser/profiles/profile.h"
  15 #include "chrome/common/pref_names.h"
  16 #include "content/public/common/url_constants.h"
  17 #include "net/base/net_util.h"
  18 #include "url/gurl.h"
  19
  20 // static
  21 const size_t AutocompleteProvider::kMaxMatches = 3;
  22
  23 AutocompleteProvider::AutocompleteProvider(
  24     AutocompleteProviderListener* listener,
  25     Profile* profile,
  26     Type type)
  27     : profile_(profile),
  28       listener_(listener),
  29       done_(true),
  30       type_(type) {
  31 }
  32
  33 // static
  34 const char* AutocompleteProvider::TypeToString(Type type) {
  35   switch (type) {
  36     case TYPE_BOOKMARK:
  37       return "Bookmark";
  38     case TYPE_BUILTIN:
  39       return "Builtin";
  40     case TYPE_CONTACT:
  41       return "Contact";
  42     case TYPE_EXTENSION_APP:
  43       return "ExtensionApp";
  44     case TYPE_HISTORY_QUICK:
  45       return "HistoryQuick";
  46     case TYPE_HISTORY_URL:
  47       return "HistoryURL";
  48     case TYPE_KEYWORD:
  49       return "Keyword";
  50     case TYPE_SEARCH:
  51       return "Search";
  52     case TYPE_SHORTCUTS:
  53       return "Shortcuts";
  54     case TYPE_ZERO_SUGGEST:
  55       return "ZeroSuggest";
  56     default:
  57       NOTREACHED() << "Unhandled AutocompleteProvider::Type " << type;
  58       return "Unknown";
  59   }
  60 }
  61
  62 void AutocompleteProvider::Stop(bool clear_cached_results) {
  63   done_ = true;
  64 }
  65
  66 const char* AutocompleteProvider::GetName() const {
  67   return TypeToString(type_);
  68 }
  69
  70 metrics::OmniboxEventProto_ProviderType AutocompleteProvider::
  71     AsOmniboxEventProviderType() const {
  72   switch (type_) {
  73     case TYPE_BOOKMARK:
  74       return metrics::OmniboxEventProto::BOOKMARK;
  75     case TYPE_BUILTIN:
  76       return metrics::OmniboxEventProto::BUILTIN;
  77     case TYPE_CONTACT:
  78       return metrics::OmniboxEventProto::CONTACT;
  79     case TYPE_EXTENSION_APP:
  80       return metrics::OmniboxEventProto::EXTENSION_APPS;
  81     case TYPE_HISTORY_QUICK:
  82       return metrics::OmniboxEventProto::HISTORY_QUICK;
  83     case TYPE_HISTORY_URL:
  84       return metrics::OmniboxEventProto::HISTORY_URL;
  85     case TYPE_KEYWORD:
  86       return metrics::OmniboxEventProto::KEYWORD;
  87     case TYPE_SEARCH:
  88       return metrics::OmniboxEventProto::SEARCH;
  89     case TYPE_SHORTCUTS:
  90       return metrics::OmniboxEventProto::SHORTCUTS;
  91     case TYPE_ZERO_SUGGEST:
  92       return metrics::OmniboxEventProto::ZERO_SUGGEST;
  93     default:
  94       NOTREACHED() << "Unhandled AutocompleteProvider::Type " << type_;
  95       return metrics::OmniboxEventProto::UNKNOWN_PROVIDER;
  96   }
  97 }
  98
  99 void AutocompleteProvider::DeleteMatch(const AutocompleteMatch& match) {
 100   DLOG(WARNING) << "The AutocompleteProvider '" << GetName()
 101                 << "' has not implemented DeleteMatch.";
 102 }
 103
 104 void AutocompleteProvider::AddProviderInfo(ProvidersInfo* provider_info) const {
 105 }
 106
 107 void AutocompleteProvider::ResetSession() {
 108 }
 109
 110 string16 AutocompleteProvider::StringForURLDisplay(const GURL& url,
 111                                                    bool check_accept_lang,
 112                                                    bool trim_http) const {
 113   std::string languages = (check_accept_lang && profile_) ?
 114       profile_->GetPrefs()->GetString(prefs::kAcceptLanguages) : std::string();
 115   return net::FormatUrl(url, languages,
 116       net::kFormatUrlOmitAll & ~(trim_http ? 0 : net::kFormatUrlOmitHTTP),
 117       net::UnescapeRule::SPACES, NULL, NULL, NULL);
 118 }
 119
 120 AutocompleteProvider::~AutocompleteProvider() {
 121   Stop(false);
 122 }
 123
 124 void AutocompleteProvider::UpdateStarredStateOfMatches() {
 125   if (matches_.empty())
 126     return;
 127
 128   if (!profile_)
 129     return;
 130
 131   BookmarkModel* bookmark_model = BookmarkModelFactory::GetForProfile(profile_);
 132   if (!bookmark_model || !bookmark_model->loaded())
 133     return;
 134
 135   for (ACMatches::iterator i(matches_.begin()); i != matches_.end(); ++i)
 136     i->starred = bookmark_model->IsBookmarked(i->destination_url);
 137 }