Modified Omnibox extension api to use JSON Schema Compiler

chrome/browser/extensions/api/omnibox/omnibox_api.cc

 // 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/extensions/api/omnibox/omnibox_api.h"
 
 #include "base/json/json_writer.h"
 #include "base/lazy_instance.h"
 #include "base/metrics/histogram.h"
 #include "base/string16.h"
 #include "base/utf_string_conversions.h"
 #include "base/values.h"
 #include "chrome/browser/extensions/event_router.h"
 #include "chrome/browser/extensions/extension_prefs.h"
 #include "chrome/browser/extensions/extension_service.h"
 #include "chrome/browser/extensions/extension_system.h"
 #include "chrome/browser/extensions/tab_helper.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/search_engines/template_url.h"
 #include "chrome/browser/search_engines/template_url_service.h"
 #include "chrome/browser/search_engines/template_url_service_factory.h"
 #include "chrome/common/chrome_notification_types.h"
+#include "chrome/common/extensions/api/omnibox.h"
 #include "chrome/common/extensions/api/omnibox/omnibox_handler.h"
 #include "chrome/common/extensions/extension.h"
 #include "content/public/browser/notification_details.h"
 #include "content/public/browser/notification_service.h"
 #include "ui/gfx/image/image.h"
 
 namespace events {
 const char kOnInputStarted[] = "omnibox.onInputStarted";
 const char kOnInputChanged[] = "omnibox.onInputChanged";
 const char kOnInputEntered[] = "omnibox.onInputEntered";
 const char kOnInputCancelled[] = "omnibox.onInputCancelled";
 }  // namespace events
 
 namespace extensions {
 
+namespace omnibox = api::omnibox;
+namespace SendSuggestions = omnibox::SendSuggestions;
+namespace SetDefaultSuggestion = omnibox::SetDefaultSuggestion;
+
 namespace {
 
 const char kSuggestionContent[] = "content";
 const char kSuggestionDescription[] = "description";
 const char kSuggestionDescriptionStyles[] = "descriptionStyles";
 const char kSuggestionDescriptionStylesRaw[] = "descriptionStylesRaw";
 const char kDescriptionStylesType[] = "type";
 const char kDescriptionStylesOffset[] = "offset";
 const char kDescriptionStylesLength[] = "length";
 
@@ skipping 171 matching lines @@
       omnibox_popup_icon_manager_.GetIcon(extension_id));
 }
 
 template <>
 void ProfileKeyedAPIFactory<OmniboxAPI>::DeclareFactoryDependencies() {
   DependsOn(ExtensionSystemFactory::GetInstance());
   DependsOn(TemplateURLServiceFactory::GetInstance());
 }
 
 bool OmniboxSendSuggestionsFunction::RunImpl() {
-  ExtensionOmniboxSuggestions suggestions;
-  ListValue* suggestions_value;
-  EXTENSION_FUNCTION_VALIDATE(args_->GetInteger(0, &suggestions.request_id));
-  EXTENSION_FUNCTION_VALIDATE(args_->GetList(1, &suggestions_value));
-
-  suggestions.suggestions.resize(suggestions_value->GetSize());
-  for (size_t i = 0; i < suggestions_value->GetSize(); ++i) {
-    ExtensionOmniboxSuggestion& suggestion = suggestions.suggestions[i];
-    DictionaryValue* suggestion_value;
-    EXTENSION_FUNCTION_VALIDATE(suggestions_value->GetDictionary(
-        i, &suggestion_value));
-    EXTENSION_FUNCTION_VALIDATE(suggestion.Populate(*suggestion_value, true));
-  }
+  scoped_ptr<SendSuggestions::Params> params(
+      SendSuggestions::Params::Create(*args_));
+  EXTENSION_FUNCTION_VALIDATE(params);

[not at google - send to devlin, 2013/03/22 17:33:30]

if we don't validate that the content field was set then this will crash that
that CHECK in the omnibox code. besides which, we need to check for it and set
error_ if it's not there.

see comment in omnibox.json though.

[Aaron Jacobs, 2013/03/22 19:54:15]

I believe the check is no longer needed now that the content field is not
optional.

 
   content::NotificationService::current()->Notify(
       chrome::NOTIFICATION_EXTENSION_OMNIBOX_SUGGESTIONS_READY,
       content::Source<Profile>(profile_->GetOriginalProfile()),
-      content::Details<ExtensionOmniboxSuggestions>(&suggestions));
+      content::Details<SendSuggestions::Params>(params.get()));
 
   return true;
 }
 
 bool OmniboxSetDefaultSuggestionFunction::RunImpl() {
-  ExtensionOmniboxSuggestion suggestion;
-  DictionaryValue* suggestion_value;
-  EXTENSION_FUNCTION_VALIDATE(args_->GetDictionary(0, &suggestion_value));
-  EXTENSION_FUNCTION_VALIDATE(suggestion.Populate(*suggestion_value, false));
+  scoped_ptr<SetDefaultSuggestion::Params> params(
+      SetDefaultSuggestion::Params::Create(*args_));
+  EXTENSION_FUNCTION_VALIDATE(params);
 

[not at google - send to devlin, 2013/03/22 17:33:30]

likewise need to check somewhere that it isn't set (but see comment).

[Aaron Jacobs, 2013/03/22 19:54:15]

This should no longer be needed with the modifications made to
chrome/renderer/resources/extensions/omnibox_custom_bindings.js

   ExtensionPrefs* prefs =
       ExtensionSystem::Get(profile())->extension_service()->extension_prefs();
   if (prefs)
-    prefs->SetOmniboxDefaultSuggestion(extension_id(), suggestion);
+    prefs->SetOmniboxDefaultSuggestion(extension_id(), params->suggestion);
 
   content::NotificationService::current()->Notify(
       chrome::NOTIFICATION_EXTENSION_OMNIBOX_DEFAULT_SUGGESTION_CHANGED,
       content::Source<Profile>(profile_->GetOriginalProfile()),
       content::NotificationService::NoDetails());
 
   return true;
 }
 
-ExtensionOmniboxSuggestion::ExtensionOmniboxSuggestion() {}
+// This function converts style information populated by the JSON schema
+// compiler into an ACMatchClassifications object.
+ACMatchClassifications StyleTypesToACMatchClassifications(
+    const omnibox::SuggestResult &suggestion) {
+  ACMatchClassifications match_classifications;
+  if (suggestion.description_styles) {
+    string16 description = UTF8ToUTF16(suggestion.description);
+    std::vector<int> styles;
+    styles.resize(description.length()); // sets all styles to 0

[not at google - send to devlin, 2013/03/22 17:33:30]

you should be able to give this as an argument to the constructor.
std::vector<int> styles(description.length(), 0);

make sure the order is right..

[Aaron Jacobs, 2013/03/22 19:54:15]

Done.

 
-ExtensionOmniboxSuggestion::~ExtensionOmniboxSuggestion() {}
+    for (std::vector<linked_ptr<omnibox::SuggestResult::DescriptionStylesType> >

[not at google - send to devlin, 2013/03/22 17:33:30]

wow. maybe we should generate typedefs in the schema compiler.

+        ::iterator i = suggestion.description_styles->begin();
+        i != suggestion.description_styles->end(); ++i) {

[not at google - send to devlin, 2013/03/22 17:33:30]

super nit: for loop style is to align vertically, not 4 spaces, i.e.

for (std::vector...
     ::iterator...)

not

for (std::vector,
    ::iterator)

[Aaron Jacobs, 2013/03/22 19:54:15]

Done.

+      int type_class, offset, length;

[not at google - send to devlin, 2013/03/22 17:33:30]

just declare them when they're initialized.

[Aaron Jacobs, 2013/03/22 19:54:15]

Done.

 
-bool ExtensionOmniboxSuggestion::Populate(const base::DictionaryValue& value,
-                                          bool require_content) {
-  if (!value.GetString(kSuggestionContent, &content) && require_content)
-    return false;
+      if ((*i).get() && (*i)->length)

[not at google - send to devlin, 2013/03/22 17:33:30]

please save a reference to *i (or better: the raw pointer underlying it), it's
pretty hard to read.

[Aaron Jacobs, 2013/03/22 19:54:15]

Done.

+        length = *(*i)->length;
+      if (length < 0)
+        length = description.length();
 
-  if (!value.GetString(kSuggestionDescription, &description))
-    return false;
+      offset = (*i)->offset;
+      if (offset < 0)
+        offset = std::max(0, static_cast<int>(description.length()) + offset);

[not at google - send to devlin, 2013/03/22 17:33:30]

if you make this a size_t and ternary-initialize it then you wouldn't need the
static_cast below.

[Aaron Jacobs, 2013/03/22 19:54:15]

Done.

 
-  description_styles.clear();
-  if (value.HasKey(kSuggestionDescriptionStyles)) {
-    // This version comes from the extension.
-    const ListValue* styles = NULL;
-    if (!value.GetList(kSuggestionDescriptionStyles, &styles) ||
-        !ReadStylesFromValue(*styles)) {
-      return false;
+      switch ((*i)->type) {
+        case omnibox::SuggestResult::DescriptionStylesType::TYPE_URL:
+          type_class = AutocompleteMatch::ACMatchClassification::URL;
+          break;
+        case omnibox::SuggestResult::DescriptionStylesType::TYPE_MATCH:
+          type_class = AutocompleteMatch::ACMatchClassification::MATCH;
+          break;
+        case omnibox::SuggestResult::DescriptionStylesType::TYPE_DIM:
+          type_class = AutocompleteMatch::ACMatchClassification::DIM;
+          break;
+        default:
+          type_class = AutocompleteMatch::ACMatchClassification::NONE;
+          return match_classifications;
+      }
+
+      for (int j = offset;
+          j < offset + length && j < static_cast<int>(styles.size()); ++j)
+        styles[j] |= type_class;
     }
-  } else if (value.HasKey(kSuggestionDescriptionStylesRaw)) {
-    // This version comes from ToValue(), which we use to persist to disk.
-    const ListValue* styles = NULL;
-    if (!value.GetList(kSuggestionDescriptionStylesRaw, &styles) ||
-        styles->empty()) {
-      return false;
-    }
-    for (size_t i = 0; i < styles->GetSize(); ++i) {
-      const base::DictionaryValue* style = NULL;
-      int offset, type;
-      if (!styles->GetDictionary(i, &style))
-        return false;
-      if (!style->GetInteger(kDescriptionStylesType, &type))
-        return false;
-      if (!style->GetInteger(kDescriptionStylesOffset, &offset))
-        return false;
-      description_styles.push_back(ACMatchClassification(offset, type));
+
+    for (size_t i = 0; i < styles.size(); ++i) {
+      if (i ==0 || styles[i] != styles[i-1])
+        match_classifications.push_back(
+            ACMatchClassification(i, styles[i]));
     }
   } else {
-    description_styles.push_back(
+    match_classifications.push_back(
         ACMatchClassification(0, ACMatchClassification::NONE));
   }
 
-  return true;
+  return match_classifications;
 }
 
-bool ExtensionOmniboxSuggestion::ReadStylesFromValue(
-    const ListValue& styles_value) {
-  description_styles.clear();
-
-  // Step 1: Build a vector of styles, 1 per character of description text.
-  std::vector<int> styles;
-  styles.resize(description.length());  // sets all styles to 0
-
-  for (size_t i = 0; i < styles_value.GetSize(); ++i) {
-    const DictionaryValue* style;
-    std::string type;
-    int offset;
-    int length;
-    if (!styles_value.GetDictionary(i, &style))
-      return false;
-    if (!style->GetString(kDescriptionStylesType, &type))
-      return false;
-    if (!style->GetInteger(kDescriptionStylesOffset, &offset))
-      return false;
-    if (!style->GetInteger(kDescriptionStylesLength, &length) || length < 0)
-      length = description.length();
-
-    if (offset < 0)
-      offset = std::max(0, static_cast<int>(description.length()) + offset);
-
-    int type_class =
-        (type == "url") ? ACMatchClassification::URL :
-        (type == "match") ? ACMatchClassification::MATCH :
-        (type == "dim") ? ACMatchClassification::DIM : -1;
-    if (type_class == -1)
-      return false;
-
-    for (int j = offset;
-         j < offset + length && j < static_cast<int>(styles.size()); ++j)
-      styles[j] |= type_class;
-  }
-
-  // Step 2: Convert the vector into continuous runs of common styles.
-  for (size_t i = 0; i < styles.size(); ++i) {
-    if (i == 0 || styles[i] != styles[i-1])
-      description_styles.push_back(ACMatchClassification(i, styles[i]));
-  }
-
-  return true;
-}
-
-scoped_ptr<base::DictionaryValue> ExtensionOmniboxSuggestion::ToValue() const {
-  scoped_ptr<base::DictionaryValue> value(new base::DictionaryValue());
-
-  value->SetString(kSuggestionContent, content);
-  value->SetString(kSuggestionDescription, description);
-
-  if (description_styles.size() > 0) {
-    base::ListValue* styles_value = new base::ListValue();
-    for (size_t i = 0; i < description_styles.size(); ++i) {
-      base::DictionaryValue* style = new base::DictionaryValue();
-      style->SetInteger(kDescriptionStylesOffset, description_styles[i].offset);
-      style->SetInteger(kDescriptionStylesType, description_styles[i].style);
-      styles_value->Append(style);
-    }
-
-    value->Set(kSuggestionDescriptionStylesRaw, styles_value);
-  }
-
-  return value.Pass();
-}
-
-ExtensionOmniboxSuggestions::ExtensionOmniboxSuggestions() : request_id(0) {}
-
-ExtensionOmniboxSuggestions::~ExtensionOmniboxSuggestions() {}
-
 void ApplyDefaultSuggestionForExtensionKeyword(
     Profile* profile,
     const TemplateURL* keyword,
     const string16& remaining_input,
     AutocompleteMatch* match) {
   DCHECK(keyword->IsExtensionKeyword());
 
   ExtensionPrefs* prefs =
       ExtensionSystem::Get(profile)->extension_service()->extension_prefs();
   if (!prefs)
     return;
 
-  ExtensionOmniboxSuggestion suggestion =
-      prefs->GetOmniboxDefaultSuggestion(keyword->GetExtensionId());
-  if (suggestion.description.empty())
+  scoped_ptr<omnibox::SuggestResult> suggestion(
+      prefs->GetOmniboxDefaultSuggestion(keyword->GetExtensionId()));
+  if (!suggestion || suggestion->description.empty())
     return;  // fall back to the universal default
 
   const string16 kPlaceholderText(ASCIIToUTF16("%s"));
   const string16 kReplacementText(ASCIIToUTF16("<input>"));
 
-  string16 description = suggestion.description;
+  string16 description = UTF8ToUTF16(suggestion->description);
   ACMatchClassifications& description_styles = match->contents_class;
-  description_styles = suggestion.description_styles;
+  description_styles = StyleTypesToACMatchClassifications(*suggestion);
 
   // Replace "%s" with the user's input and adjust the style offsets to the
   // new length of the description.
-  size_t placeholder(suggestion.description.find(kPlaceholderText, 0));
+  size_t placeholder(description.find(kPlaceholderText, 0));
   if (placeholder != string16::npos) {
     string16 replacement =
         remaining_input.empty() ? kReplacementText : remaining_input;
     description.replace(placeholder, kPlaceholderText.length(), replacement);
 
     for (size_t i = 0; i < description_styles.size(); ++i) {
       if (description_styles[i].offset > placeholder)
         description_styles[i].offset += replacement.length() - 2;
     }
   }
 
   match->contents.assign(description);
 }
 
 }  // namespace extensions