[Web Intents] Localization of intent titles for CWS suggestions

chrome/browser/intents/cws_intents_registry.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/intents/cws_intents_registry.h"
 
 #include "base/callback.h"
 #include "base/json/json_string_value_serializer.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/stl_util.h"
 #include "base/string16.h"
 #include "base/utf_string_conversions.h"
+#include "chrome/common/extensions/extension_l10n_util.h"
+#include "chrome/common/extensions/extension_message_bundle.h"
 #include "chrome/browser/intents/api_key.h"
 #include "chrome/browser/net/chrome_url_request_context.h"
 #include "chrome/browser/webdata/web_data_service.h"
 #include "chrome/common/net/url_util.h"
 #include "net/base/load_flags.h"
 #include "net/base/mime_util.h"
 #include "net/url_request/url_fetcher.h"
 
 namespace {
 
 // Limit for the number of suggestions we fix from CWS. Ideally, the registry
 // simply get all of them, but there is a) chunking on the CWS side, and b)
 // there is a cost with suggestions fetched. (Network overhead for favicons,
 // roundtrips to registry to check if installed).
 //
 // Since the picker limits the number of suggestions displayed to 5, 15 means
 // the suggestion list only has the potential to be shorter than that once the
 // user has at least 10 installed handlers for the particular action/type.
 //
 // TODO(groby): Adopt number of suggestions dynamically so the picker can
 // always display 5 suggestions unless there are less than 5 viable extensions
 // in the CWS.
 const char kMaxSuggestions[] = "15";
 
 // URL for CWS intents API.
 const char kCWSIntentServiceURL[] =
   "https://www.googleapis.com/chromewebstore/v1.1b/items/intent";
 
+// Determines if a string is a candidate for localization.
+bool ShouldLocalize(const std::string& value) {
+  std::string::size_type index = 0;
+  index = value.find(ExtensionMessageBundle::kMessageBegin);
+   if (index == std::string::npos)
+     return false;
+
+  index = value.find(ExtensionMessageBundle::kMessageEnd, index);
+  return (index != std::string::npos);
+}
+
 // Parses a JSON |response| from the CWS into a list of suggested extensions,
 // stored in |intents|. |intents| must not be NULL.
 void ParseResponse(const std::string& response,
                    CWSIntentsRegistry::IntentExtensionList* intents) {
   std::string error;
   scoped_ptr<Value> parsed_response;
   JSONStringValueSerializer serializer(response);
   parsed_response.reset(serializer.Deserialize(NULL, &error));
   if (parsed_response.get() == NULL)
     return;
@@ skipping 33 matching lines @@
 
     DictionaryValue* manifest_dict;
     if (!manifest_value->GetAsDictionary(&manifest_dict) ||
         !manifest_dict->GetString("name", &info.name))
       continue;
 
     string16 url_string;
     if (!item->GetString("icon_url", &url_string))
       continue;
     info.icon_url = GURL(url_string);
 

[Greg Billock, 2012/07/20 15:58:30]

Can you add a comment about why we need this block, and what it would take to
get rid of it?

[groby-ooo-7-16, 2012/07/20 22:59:54]

Done.

+    ListValue* all_locales = NULL;
+    if (ShouldLocalize(UTF16ToUTF8(info.name)) &&
+        item->GetList("locale_data", &all_locales)) {
+      std::map<std::string, std::string> localized_title;
+
+      for (ListValue::const_iterator locale_iter(all_locales->begin());
+           locale_iter != all_locales->end(); ++locale_iter) {
+        DictionaryValue* locale = static_cast<DictionaryValue*>(*locale_iter);
+
+        std::string locale_id, title;
+        if (!locale->GetString("locale_string", &locale_id) ||
+            !locale->GetString("title", &title))

[Greg Billock, 2012/07/20 15:58:30]

So this isn't the normal place, so the extension l10n utils won't work?

[groby-ooo-7-16, 2012/07/20 22:59:54]

That is correct. There's also the point that the CWS reply always calls it
"title", but the manifest might expect other identifiers. (l10n for manifests is
pretty flexible)

+          continue;
+
+        localized_title[locale_id] = title;
+      }
+
+      std::vector<std::string> valid_locales;

[Greg Billock, 2012/07/20 15:58:30]

Can you just use vector<string> here and below? The namespaces are a bit
noisifying.

[groby-ooo-7-16, 2012/07/20 22:59:54]

As far as I can tell, we always prefix. 
On 2012/07/20 15:58:30, Greg Billock wrote:

+      extension_l10n_util::GetAllFallbackLocales(
+          extension_l10n_util::CurrentLocaleOrDefault(),

[Greg Billock, 2012/07/20 15:58:30]

Shouldn't the util class compose these default/current/"all" ordering and just
give you back the vector?

[groby-ooo-7-16, 2012/07/20 22:59:54]

No, because the util class is shared with extension l10n, and that supports
different defaults and application locales.
On 2012/07/20 15:58:30, Greg Billock wrote:

+          "all",
+          &valid_locales);
+      for (std::vector<std::string>::iterator iter = valid_locales.begin();
+          iter != valid_locales.end(); ++iter) {
+        if (localized_title.count(*iter)) {
+            info.name = UTF8ToUTF16(localized_title[*iter]);
+            break;
+        }
+      }
+    }
+
     intents->push_back(info);
   }
 }
 
 }  // namespace
 
 // Internal object representing all data associated with a single query.
 struct CWSIntentsRegistry::IntentsQuery {
   IntentsQuery();
   ~IntentsQuery();
@@ skipping 83 matching lines @@
                                                     "0");
   request = chrome_common_net::AppendQueryParameter(request, "num_results",
                                                     kMaxSuggestions);
   if (web_intents::kApiKey[0]) {
     request = chrome_common_net::AppendQueryParameter(request, "key",
                                                        web_intents::kApiKey);
   }
 
   return request;
 }