Implement remaining chrome.searchEnginesPrivate methods.

chrome/browser/extensions/api/search_engines_private/search_engines_private_api.cc

 // Copyright 2015 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/extensions/api/search_engines_private/search_engines_private_api.h"
 
+#include "base/prefs/pref_service.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/values.h"
 #include "chrome/browser/extensions/chrome_extension_function.h"
 #include "chrome/browser/profiles/profile.h"
+#include "chrome/browser/search/hotword_audio_history_handler.h"
+#include "chrome/browser/search/hotword_service.h"
+#include "chrome/browser/search/hotword_service_factory.h"
 #include "chrome/browser/search_engines/template_url_service_factory.h"
-#include "chrome/common/extensions/api/search_engines_private.h"
+#include "chrome/browser/signin/signin_manager_factory.h"
+#include "chrome/common/pref_names.h"
+#include "chrome/common/url_constants.h"
+#include "chrome/grit/generated_resources.h"
 #include "components/search_engines/template_url_service.h"
+#include "components/signin/core/browser/signin_manager_base.h"
 #include "extensions/browser/extension_function_registry.h"
+#include "ui/base/l10n/l10n_util.h"
 
 namespace extensions {
 
+namespace search_engines_private = api::search_engines_private;
+
 ////////////////////////////////////////////////////////////////////////////////
-// SearchEnginesPrivateGetDefaultSearchEnginesFunction
+// SearchEnginesPrivateGetSearchEnginesFunction
 
-SearchEnginesPrivateGetDefaultSearchEnginesFunction::
-    SearchEnginesPrivateGetDefaultSearchEnginesFunction()
+SearchEnginesPrivateGetSearchEnginesFunction::
+    SearchEnginesPrivateGetSearchEnginesFunction()
     : chrome_details_(this) {
 }
 
-SearchEnginesPrivateGetDefaultSearchEnginesFunction::
-    ~SearchEnginesPrivateGetDefaultSearchEnginesFunction() {
+SearchEnginesPrivateGetSearchEnginesFunction::
+    ~SearchEnginesPrivateGetSearchEnginesFunction() {
 }
 
 ExtensionFunction::ResponseAction
-SearchEnginesPrivateGetDefaultSearchEnginesFunction::Run() {
+SearchEnginesPrivateGetSearchEnginesFunction::Run() {
   TemplateURLService* template_url_service =
       TemplateURLServiceFactory::GetForProfile(chrome_details_.GetProfile());
   base::ListValue* engines = new base::ListValue();
 
   const TemplateURL* default_url =
       template_url_service->GetDefaultSearchProvider();
   std::vector<TemplateURL*> urls = template_url_service->GetTemplateURLs();
   for (size_t i = 0; i < urls.size(); i++) {
-    api::search_engines_private::SearchEngine engine;
+    search_engines_private::SearchEngine engine;
     engine.guid = urls[i]->sync_guid();
     engine.name = base::UTF16ToASCII(urls[i]->short_name());
+    engine.keyword = base::UTF16ToASCII(urls[i]->keyword());
+    engine.url = urls[i]->url();
+    engine.type = urls[i]->show_in_default_list()
+        ? search_engines_private::SearchEngineType::SEARCH_ENGINE_TYPE_DEFAULT
+        : search_engines_private::SearchEngineType::SEARCH_ENGINE_TYPE_OTHER;
+
     if (urls[i] == default_url)
       engine.is_selected = scoped_ptr<bool>(new bool(true));
 
     engines->Append(engine.ToValue().release());
   }
 
   return RespondNow(OneArgument(engines));
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // SearchEnginesPrivateSetSelectedSearchEngineFunction
 
 SearchEnginesPrivateSetSelectedSearchEngineFunction::
     SearchEnginesPrivateSetSelectedSearchEngineFunction()
     : chrome_details_(this) {
 }
 
 SearchEnginesPrivateSetSelectedSearchEngineFunction::
     ~SearchEnginesPrivateSetSelectedSearchEngineFunction() {
 }
 
 ExtensionFunction::ResponseAction
 SearchEnginesPrivateSetSelectedSearchEngineFunction::Run() {
-  scoped_ptr<api::search_engines_private::SetSelectedSearchEngine::Params>
+  scoped_ptr<search_engines_private::SetSelectedSearchEngine::Params>
       parameters =
-          api::search_engines_private::SetSelectedSearchEngine::Params::Create(
+          search_engines_private::SetSelectedSearchEngine::Params::Create(
               *args_);
   EXTENSION_FUNCTION_VALIDATE(parameters.get());
 
   TemplateURLService* template_url_service =
       TemplateURLServiceFactory::GetForProfile(chrome_details_.GetProfile());
   template_url_service->SetUserSelectedDefaultSearchProvider(
       template_url_service->GetTemplateURLForGUID(parameters->guid));
   return RespondNow(NoArguments());
 }
 
+////////////////////////////////////////////////////////////////////////////////
+// SearchEnginesPrivateAddOtherSearchEngineFunction
+
+SearchEnginesPrivateAddOtherSearchEngineFunction::
+    SearchEnginesPrivateAddOtherSearchEngineFunction()
+    : chrome_details_(this) {
+}
+
+SearchEnginesPrivateAddOtherSearchEngineFunction::
+    ~SearchEnginesPrivateAddOtherSearchEngineFunction() {
+}
+
+ExtensionFunction::ResponseAction
+SearchEnginesPrivateAddOtherSearchEngineFunction::Run() {
+  scoped_ptr<search_engines_private::AddOtherSearchEngine::Params> parameters =
+      search_engines_private::AddOtherSearchEngine::Params::Create(*args_);
+  EXTENSION_FUNCTION_VALIDATE(parameters.get());
+
+  TemplateURLData data;
+  data.short_name = base::ASCIIToUTF16(parameters->name);
+  data.SetKeyword(base::ASCIIToUTF16(parameters->keyword));
+  data.SetURL(parameters->url);
+  TemplateURL* turl = new TemplateURL(data);
+
+  TemplateURLService* template_url_service =
+      TemplateURLServiceFactory::GetForProfile(chrome_details_.GetProfile());
+  template_url_service->Add(turl);
+  return RespondNow(NoArguments());
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// SearchEnginesPrivateUpdateSearchEngineFunction
+
+SearchEnginesPrivateUpdateSearchEngineFunction::
+    SearchEnginesPrivateUpdateSearchEngineFunction()
+    : chrome_details_(this) {
+}
+
+SearchEnginesPrivateUpdateSearchEngineFunction::
+    ~SearchEnginesPrivateUpdateSearchEngineFunction() {
+}
+
+ExtensionFunction::ResponseAction
+SearchEnginesPrivateUpdateSearchEngineFunction::Run() {
+  scoped_ptr<search_engines_private::UpdateSearchEngine::Params> parameters =
+      search_engines_private::UpdateSearchEngine::Params::Create(*args_);
+  EXTENSION_FUNCTION_VALIDATE(parameters.get());
+
+  TemplateURLService* template_url_service =
+      TemplateURLServiceFactory::GetForProfile(chrome_details_.GetProfile());
+  TemplateURL* turl =
+      template_url_service->GetTemplateURLForGUID(parameters->guid);
+
+  template_url_service->ResetTemplateURL(
+      turl, base::ASCIIToUTF16(parameters->name),
+      base::ASCIIToUTF16(parameters->keyword), parameters->url);
+
+  return RespondNow(NoArguments());
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// SearchEnginesPrivateRemoveSearchEngineFunction
+
+SearchEnginesPrivateRemoveSearchEngineFunction::
+    SearchEnginesPrivateRemoveSearchEngineFunction()
+    : chrome_details_(this) {
+}
+
+SearchEnginesPrivateRemoveSearchEngineFunction::
+    ~SearchEnginesPrivateRemoveSearchEngineFunction() {
+}
+
+ExtensionFunction::ResponseAction
+SearchEnginesPrivateRemoveSearchEngineFunction::Run() {
+  scoped_ptr<search_engines_private::RemoveSearchEngine::Params> parameters =
+      search_engines_private::RemoveSearchEngine::Params::Create(*args_);
+  EXTENSION_FUNCTION_VALIDATE(parameters.get());
+
+  TemplateURLService* template_url_service =
+      TemplateURLServiceFactory::GetForProfile(chrome_details_.GetProfile());
+  TemplateURL* turl =
+      template_url_service->GetTemplateURLForGUID(parameters->guid);
+  template_url_service->Remove(turl);
+  return RespondNow(NoArguments());
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// SearchEnginesPrivateGetHotwordStateFunction
+
+SearchEnginesPrivateGetHotwordStateFunction::
+    SearchEnginesPrivateGetHotwordStateFunction()
+    : chrome_details_(this), weak_ptr_factory_(this) {
+}
+
+SearchEnginesPrivateGetHotwordStateFunction::
+    ~SearchEnginesPrivateGetHotwordStateFunction() {
+}
+
+ExtensionFunction::ResponseAction
+SearchEnginesPrivateGetHotwordStateFunction::Run() {
+  Profile* profile = chrome_details_.GetProfile();
+  TemplateURLService* template_url_service =
+      TemplateURLServiceFactory::GetForProfile(profile);
+
+  scoped_ptr<search_engines_private::HotwordState> state(
+      new search_engines_private::HotwordState());
+
+  bool is_search_provider_google = false;
+  if (template_url_service && template_url_service->loaded()) {
+    const TemplateURL* default_url =
+        template_url_service->GetDefaultSearchProvider();
+    if (default_url &&
+        default_url->HasGoogleBaseURLs(
+            template_url_service->search_terms_data())) {
+      is_search_provider_google = true;
+    } else {
+      // If the user has chosen a default search provide other than Google, turn
+      // off hotwording since other providers don't provide that functionality.
+      HotwordService* hotword_service =
+          HotwordServiceFactory::GetForProfile(profile);
+      if (hotword_service)
+        hotword_service->DisableHotwordPreferences();
+    }
+  }
+
+  if (!HotwordServiceFactory::IsHotwordAllowed(profile) ||
+      !is_search_provider_google) {
+    return RespondNow(OneArgument(state->ToValue().release()));
+  }
+
+  state->availability.push_back(
+      search_engines_private::HotwordFeature::HOTWORD_FEATURE_SEARCH);
+
+  SigninManagerBase* signin = SigninManagerFactory::GetForProfile(profile);
+  bool authenticated = signin && signin->IsAuthenticated();
+  bool always_on =
+      HotwordServiceFactory::IsAlwaysOnAvailable() && authenticated;
+
+  if (always_on) {
+    state->availability.push_back(
+        search_engines_private::HotwordFeature::HOTWORD_FEATURE_ALWAYS_ON);
+    if (profile->GetPrefs()->GetBoolean(prefs::kHotwordAlwaysOnSearchEnabled)) {
+      state->availability.push_back(
+          search_engines_private::HotwordFeature::HOTWORD_FEATURE_RETRAIN_LINK);
+    }
+  }
+
+  int error = HotwordServiceFactory::GetCurrentError(profile);
+  if (error) {
+    base::string16 hotword_help_url =
+        base::ASCIIToUTF16(chrome::kHotwordLearnMoreURL);

[stevenjb, 2015/04/28 22:27:11]

Since this is only used inside the if() below, we should move it there (or
eliminate the local and inline it since it's only used once).

[Oren Blasberg, 2015/04/29 00:24:59]

Done.

+    std::string error_message(l10n_util::GetStringUTF8(error));
+    if (error == IDS_HOTWORD_GENERIC_ERROR_MESSAGE) {
+      error_message = l10n_util::GetStringFUTF8(error, hotword_help_url);
+    }
+    state->error_msg.reset(new std::string(error_message));
+  }
+
+  // Audio history should be displayed if it's enabled regardless of the
+  // hotword error state if the user is signed in. If the user is not signed
+  // in, audio history is meaningless. This is only displayed if always-on
+  // hotwording is available.
+  if (authenticated && always_on) {
+    std::string user_display_name = signin->GetAuthenticatedUsername();
+    DCHECK(!user_display_name.empty());

[stevenjb, 2015/04/28 22:27:11]

I realize this was mostly copied from browser_options, but we should generally
avoid DCHECK in extension API code. In this case an empty display name would be
bad from a UI perspective, but not fatal. We can trust that other code, i.e.
SigninManager will ensure this value is valid.

[Oren Blasberg, 2015/04/29 00:24:59]

Thanks for reviewing this code thoroughly :) Done.

+    base::string16 audio_history_state =
+        l10n_util::GetStringFUTF16(IDS_HOTWORD_AUDIO_HISTORY_ENABLED,
+                                   base::ASCIIToUTF16(user_display_name));

[stevenjb, 2015/04/28 22:27:11]

Here also, declare where it is used or inline.

Note: Before clang format, maintaining the formatting of lengthy function calls
like the one below was kind of a pain, so devs used local variables more
frequently. With clang format, inlining is generally preferred unless the
variable is used more than once or the variable name provides some added
clarity.

Again, I realize the code was probably copied from elsewhere, but always good to
make things a little cleaner as we go.

[Oren Blasberg, 2015/04/29 00:24:59]

Done.

+    HotwordService* hotword_service =
+        HotwordServiceFactory::GetForProfile(profile);
+    if (hotword_service) {
+      hotword_service->GetAudioHistoryHandler()->GetAudioHistoryEnabled(
+          base::Bind(&SearchEnginesPrivateGetHotwordStateFunction::
+                         OnAudioHistoryChecked,
+                     weak_ptr_factory_.GetWeakPtr(), base::Passed(&state),
+                     audio_history_state));
+      return RespondLater();
+    }
+  }
+
+  return RespondNow(OneArgument(state->ToValue().release()));
+}
+
+void SearchEnginesPrivateGetHotwordStateFunction::OnAudioHistoryChecked(
+    scoped_ptr<search_engines_private::HotwordState> state,
+    const base::string16& audio_history_state,
+    bool success,
+    bool logging_enabled) {
+  if (success && logging_enabled) {
+    state->availability.push_back(
+        search_engines_private::HotwordFeature::HOTWORD_FEATURE_AUDIO_HISTORY);
+    std::string audio_history_state_str(
+        base::UTF16ToASCII(audio_history_state));
+    state->audio_history_state = make_scoped_ptr(&audio_history_state_str);

[stevenjb, 2015/04/28 22:27:11]

state->audio_history_state(new
std::string(base::UTF16ToASCII(audio_history_state));

[Oren Blasberg, 2015/04/29 00:24:59]

Done. (assuming you meant to have a .reset in there)

+  }
+  Respond(OneArgument(state->ToValue().release()));
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// SearchEnginesPrivateOptIntoHotwordingFunction
+
+SearchEnginesPrivateOptIntoHotwordingFunction::
+    SearchEnginesPrivateOptIntoHotwordingFunction()
+    : chrome_details_(this) {
+}
+
+SearchEnginesPrivateOptIntoHotwordingFunction::
+    ~SearchEnginesPrivateOptIntoHotwordingFunction() {
+}
+
+ExtensionFunction::ResponseAction
+SearchEnginesPrivateOptIntoHotwordingFunction::Run() {
+  scoped_ptr<search_engines_private::OptIntoHotwording::Params> parameters =
+      search_engines_private::OptIntoHotwording::Params::Create(*args_);
+  EXTENSION_FUNCTION_VALIDATE(parameters.get());
+
+  Profile* profile = chrome_details_.GetProfile();
+
+  HotwordService::LaunchMode launch_mode =
+      HotwordService::HOTWORD_AND_AUDIO_HISTORY;
+
+  if (parameters->retrain) {
+    if (!profile->GetPrefs()->GetBoolean(
+            prefs::kHotwordAlwaysOnSearchEnabled) ||
+        !profile->GetPrefs()->GetBoolean(

[stevenjb, 2015/04/28 22:27:11]

nit: we call profile->GetPrefs() a bunch in this method; a local might clean
this up a bit.

[Oren Blasberg, 2015/04/29 00:24:59]

Done.

+            prefs::kHotwordAudioLoggingEnabled)) {
+      return RespondNow(Error(
+          "Cannot retrain without always search and audio logging enabled"));

[stevenjb, 2015/04/28 22:27:11]

For error messages passed in an API we should use const char[] variables at the
top of the file.

[Oren Blasberg, 2015/04/29 00:24:59]

Done.

+    }
+
+    launch_mode = HotwordService::RETRAIN;
+  } else if (profile->GetPrefs()->GetBoolean(
+                 prefs::kHotwordAudioLoggingEnabled)) {
+    if (profile->GetPrefs()->GetBoolean(prefs::kHotwordAlwaysOnSearchEnabled)) {
+      return RespondNow(Error(
+          "Cannot opt in with audio logging but also with always on enabled"));
+
+    }
+    launch_mode = HotwordService::HOTWORD_ONLY;
+  } else {
+    if (profile->GetPrefs()->GetBoolean(prefs::kHotwordAlwaysOnSearchEnabled))
+      return RespondNow(Error(
+          "Cannot opt in if already opted in"));
+  }
+
+  HotwordService* hotword_service =
+      HotwordServiceFactory::GetForProfile(profile);
+  if (hotword_service)

[stevenjb, 2015/04/28 22:27:11]

nit: if (!hotword_service) all of the above is pointless, so we should declare
it towards the top and early exit with an error if null.

[Oren Blasberg, 2015/04/29 00:24:59]

Done.

+    hotword_service->OptIntoHotwording(launch_mode);
+  return RespondNow(NoArguments());
+}
+
 }  // namespace extensions