src/extensions/common/extension_l10n_util.cc

   1 // Copyright 2014 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 "extensions/common/extension_l10n_util.h"
   6
   7 #include <algorithm>
   8 #include <set>
   9 #include <string>
  10 #include <vector>
  11
  12 #include "base/file_util.h"
  13 #include "base/files/file_enumerator.h"
  14 #include "base/json/json_file_value_serializer.h"
  15 #include "base/logging.h"
  16 #include "base/memory/linked_ptr.h"
  17 #include "base/strings/stringprintf.h"
  18 #include "base/strings/utf_string_conversions.h"
  19 #include "base/values.h"
  20 #include "extensions/common/constants.h"
  21 #include "extensions/common/error_utils.h"
  22 #include "extensions/common/file_util.h"
  23 #include "extensions/common/manifest_constants.h"
  24 #include "extensions/common/message_bundle.h"
  25 #include "third_party/icu/source/common/unicode/uloc.h"
  26 #include "ui/base/l10n/l10n_util.h"
  27
  28 namespace errors = extensions::manifest_errors;
  29 namespace keys = extensions::manifest_keys;
  30
  31 namespace {
  32
  33 // Loads contents of the messages file for given locale. If file is not found,
  34 // or there was parsing error we return NULL and set |error|.
  35 // Caller owns the returned object.
  36 base::DictionaryValue* LoadMessageFile(const base::FilePath& locale_path,
  37                                        const std::string& locale,
  38                                        std::string* error) {
  39   base::FilePath file =
  40       locale_path.AppendASCII(locale).Append(extensions::kMessagesFilename);
  41   JSONFileValueSerializer messages_serializer(file);
  42   base::Value* dictionary = messages_serializer.Deserialize(NULL, error);
  43   if (!dictionary) {
  44     if (error->empty()) {
  45       // JSONFileValueSerializer just returns NULL if file cannot be found. It
  46       // doesn't set the error, so we have to do it.
  47       *error = base::StringPrintf("Catalog file is missing for locale %s.",
  48                                   locale.c_str());
  49     } else {
  50       *error = extensions::ErrorUtils::FormatErrorMessage(
  51           errors::kLocalesInvalidLocale,
  52           base::UTF16ToUTF8(file.LossyDisplayName()),
  53           *error);
  54     }
  55   }
  56
  57   return static_cast<base::DictionaryValue*>(dictionary);
  58 }
  59
  60 // Localizes manifest value of string type for a given key.
  61 bool LocalizeManifestValue(const std::string& key,
  62                            const extensions::MessageBundle& messages,
  63                            base::DictionaryValue* manifest,
  64                            std::string* error) {
  65   std::string result;
  66   if (!manifest->GetString(key, &result))
  67     return true;
  68
  69   if (!messages.ReplaceMessages(&result, error))
  70     return false;
  71
  72   manifest->SetString(key, result);
  73   return true;
  74 }
  75
  76 // Localizes manifest value of list type for a given key.
  77 bool LocalizeManifestListValue(const std::string& key,
  78                                const extensions::MessageBundle& messages,
  79                                base::DictionaryValue* manifest,
  80                                std::string* error) {
  81   base::ListValue* list = NULL;
  82   if (!manifest->GetList(key, &list))
  83     return true;
  84
  85   bool ret = true;
  86   for (size_t i = 0; i < list->GetSize(); ++i) {
  87     std::string result;
  88     if (list->GetString(i, &result)) {
  89       if (messages.ReplaceMessages(&result, error))
  90         list->Set(i, new base::StringValue(result));
  91       else
  92         ret = false;
  93     }
  94   }
  95   return ret;
  96 }
  97
  98 std::string& GetProcessLocale() {
  99   CR_DEFINE_STATIC_LOCAL(std::string, locale, ());
 100   return locale;
 101 }
 102
 103 }  // namespace
 104
 105 namespace extension_l10n_util {
 106
 107 void SetProcessLocale(const std::string& locale) {
 108   GetProcessLocale() = locale;
 109 }
 110
 111 std::string GetDefaultLocaleFromManifest(const base::DictionaryValue& manifest,
 112                                          std::string* error) {
 113   std::string default_locale;
 114   if (manifest.GetString(keys::kDefaultLocale, &default_locale))
 115     return default_locale;
 116
 117   *error = errors::kInvalidDefaultLocale;
 118   return std::string();
 119 }
 120
 121 bool ShouldRelocalizeManifest(const base::DictionaryValue* manifest) {
 122   if (!manifest)
 123     return false;
 124
 125   if (!manifest->HasKey(keys::kDefaultLocale))
 126     return false;
 127
 128   std::string manifest_current_locale;
 129   manifest->GetString(keys::kCurrentLocale, &manifest_current_locale);
 130   return manifest_current_locale != CurrentLocaleOrDefault();
 131 }
 132
 133 bool LocalizeManifest(const extensions::MessageBundle& messages,
 134                       base::DictionaryValue* manifest,
 135                       std::string* error) {
 136   // Initialize name.
 137   std::string result;
 138   if (!manifest->GetString(keys::kName, &result)) {
 139     *error = errors::kInvalidName;
 140     return false;
 141   }
 142   if (!LocalizeManifestValue(keys::kName, messages, manifest, error)) {
 143     return false;
 144   }
 145
 146   // Initialize short name.
 147   if (!LocalizeManifestValue(keys::kShortName, messages, manifest, error))
 148     return false;
 149
 150   // Initialize description.
 151   if (!LocalizeManifestValue(keys::kDescription, messages, manifest, error))
 152     return false;
 153
 154   // Initialize browser_action.default_title
 155   std::string key(keys::kBrowserAction);
 156   key.append(".");
 157   key.append(keys::kPageActionDefaultTitle);
 158   if (!LocalizeManifestValue(key, messages, manifest, error))
 159     return false;
 160
 161   // Initialize page_action.default_title
 162   key.assign(keys::kPageAction);
 163   key.append(".");
 164   key.append(keys::kPageActionDefaultTitle);
 165   if (!LocalizeManifestValue(key, messages, manifest, error))
 166     return false;
 167
 168   // Initialize omnibox.keyword.
 169   if (!LocalizeManifestValue(keys::kOmniboxKeyword, messages, manifest, error))
 170     return false;
 171
 172   base::ListValue* file_handlers = NULL;
 173   if (manifest->GetList(keys::kFileBrowserHandlers, &file_handlers)) {
 174     key.assign(keys::kFileBrowserHandlers);
 175     for (size_t i = 0; i < file_handlers->GetSize(); i++) {
 176       base::DictionaryValue* handler = NULL;
 177       if (!file_handlers->GetDictionary(i, &handler)) {
 178         *error = errors::kInvalidFileBrowserHandler;
 179         return false;
 180       }
 181       if (!LocalizeManifestValue(
 182               keys::kPageActionDefaultTitle, messages, handler, error))
 183         return false;
 184     }
 185   }
 186
 187   base::ListValue* media_galleries_handlers = NULL;
 188   if (manifest->GetList(keys::kMediaGalleriesHandlers,
 189                         &media_galleries_handlers)) {
 190     key.assign(keys::kMediaGalleriesHandlers);
 191     for (size_t i = 0; i < media_galleries_handlers->GetSize(); i++) {
 192       base::DictionaryValue* handler = NULL;
 193       if (!media_galleries_handlers->GetDictionary(i, &handler)) {
 194         *error = errors::kInvalidMediaGalleriesHandler;
 195         return false;
 196       }
 197       if (!LocalizeManifestValue(
 198               keys::kPageActionDefaultTitle, messages, handler, error))
 199         return false;
 200     }
 201   }
 202
 203   // Initialize all input_components
 204   base::ListValue* input_components = NULL;
 205   if (manifest->GetList(keys::kInputComponents, &input_components)) {
 206     for (size_t i = 0; i < input_components->GetSize(); ++i) {
 207       base::DictionaryValue* module = NULL;
 208       if (!input_components->GetDictionary(i, &module)) {
 209         *error = errors::kInvalidInputComponents;
 210         return false;
 211       }
 212       if (!LocalizeManifestValue(keys::kName, messages, module, error))
 213         return false;
 214       if (!LocalizeManifestValue(keys::kDescription, messages, module, error))
 215         return false;
 216     }
 217   }
 218
 219   // Initialize app.launch.local_path.
 220   if (!LocalizeManifestValue(keys::kLaunchLocalPath, messages, manifest, error))
 221     return false;
 222
 223   // Initialize app.launch.web_url.
 224   if (!LocalizeManifestValue(keys::kLaunchWebURL, messages, manifest, error))
 225     return false;
 226
 227   // Initialize description of commmands.
 228   base::DictionaryValue* commands_handler = NULL;
 229   if (manifest->GetDictionary(keys::kCommands, &commands_handler)) {
 230     for (base::DictionaryValue::Iterator iter(*commands_handler);
 231          !iter.IsAtEnd();
 232          iter.Advance()) {
 233       key.assign(
 234           base::StringPrintf("commands.%s.description", iter.key().c_str()));
 235       if (!LocalizeManifestValue(key, messages, manifest, error))
 236         return false;
 237     }
 238   }
 239
 240   // Initialize search_provider fields.
 241   base::DictionaryValue* search_provider = NULL;
 242   if (manifest->GetDictionary(keys::kOverrideSearchProvider,
 243                               &search_provider)) {
 244     for (base::DictionaryValue::Iterator iter(*search_provider);
 245          !iter.IsAtEnd();
 246          iter.Advance()) {
 247       key.assign(base::StringPrintf(
 248           "%s.%s", keys::kOverrideSearchProvider, iter.key().c_str()));
 249       bool success =
 250           (key == keys::kSettingsOverrideAlternateUrls)
 251               ? LocalizeManifestListValue(key, messages, manifest, error)
 252               : LocalizeManifestValue(key, messages, manifest, error);
 253       if (!success)
 254         return false;
 255     }
 256   }
 257
 258   // Initialize chrome_settings_overrides.homepage.
 259   if (!LocalizeManifestValue(
 260           keys::kOverrideHomepage, messages, manifest, error))
 261     return false;
 262
 263   // Initialize chrome_settings_overrides.startup_pages.
 264   if (!LocalizeManifestListValue(
 265           keys::kOverrideStartupPage, messages, manifest, error))
 266     return false;
 267
 268   // Add current locale key to the manifest, so we can overwrite prefs
 269   // with new manifest when chrome locale changes.
 270   manifest->SetString(keys::kCurrentLocale, CurrentLocaleOrDefault());
 271   return true;
 272 }
 273
 274 bool LocalizeExtension(const base::FilePath& extension_path,
 275                        base::DictionaryValue* manifest,
 276                        std::string* error) {
 277   DCHECK(manifest);
 278
 279   std::string default_locale = GetDefaultLocaleFromManifest(*manifest, error);
 280
 281   scoped_ptr<extensions::MessageBundle> message_bundle(
 282       extensions::file_util::LoadMessageBundle(
 283           extension_path, default_locale, error));
 284
 285   if (!message_bundle.get() && !error->empty())
 286     return false;
 287
 288   if (message_bundle.get() &&
 289       !LocalizeManifest(*message_bundle, manifest, error))
 290     return false;
 291
 292   return true;
 293 }
 294
 295 bool AddLocale(const std::set<std::string>& chrome_locales,
 296                const base::FilePath& locale_folder,
 297                const std::string& locale_name,
 298                std::set<std::string>* valid_locales,
 299                std::string* error) {
 300   // Accept name that starts with a . but don't add it to the list of supported
 301   // locales.
 302   if (locale_name.find(".") == 0)
 303     return true;
 304   if (chrome_locales.find(locale_name) == chrome_locales.end()) {
 305     // Warn if there is an extension locale that's not in the Chrome list,
 306     // but don't fail.
 307     DLOG(WARNING) << base::StringPrintf("Supplied locale %s is not supported.",
 308                                         locale_name.c_str());
 309     return true;
 310   }
 311   // Check if messages file is actually present (but don't check content).
 312   if (base::PathExists(locale_folder.Append(extensions::kMessagesFilename))) {
 313     valid_locales->insert(locale_name);
 314   } else {
 315     *error = base::StringPrintf("Catalog file is missing for locale %s.",
 316                                 locale_name.c_str());
 317     return false;
 318   }
 319
 320   return true;
 321 }
 322
 323 std::string CurrentLocaleOrDefault() {
 324   std::string current_locale = l10n_util::NormalizeLocale(GetProcessLocale());
 325   if (current_locale.empty())
 326     current_locale = "en";
 327
 328   return current_locale;
 329 }
 330
 331 void GetAllLocales(std::set<std::string>* all_locales) {
 332   const std::vector<std::string>& available_locales =
 333       l10n_util::GetAvailableLocales();
 334   // Add all parents of the current locale to the available locales set.
 335   // I.e. for sr_Cyrl_RS we add sr_Cyrl_RS, sr_Cyrl and sr.
 336   for (size_t i = 0; i < available_locales.size(); ++i) {
 337     std::vector<std::string> result;
 338     l10n_util::GetParentLocales(available_locales[i], &result);
 339     all_locales->insert(result.begin(), result.end());
 340   }
 341 }
 342
 343 void GetAllFallbackLocales(const std::string& application_locale,
 344                            const std::string& default_locale,
 345                            std::vector<std::string>* all_fallback_locales) {
 346   DCHECK(all_fallback_locales);
 347   if (!application_locale.empty() && application_locale != default_locale)
 348     l10n_util::GetParentLocales(application_locale, all_fallback_locales);
 349   all_fallback_locales->push_back(default_locale);
 350 }
 351
 352 bool GetValidLocales(const base::FilePath& locale_path,
 353                      std::set<std::string>* valid_locales,
 354                      std::string* error) {
 355   std::set<std::string> chrome_locales;
 356   GetAllLocales(&chrome_locales);
 357
 358   // Enumerate all supplied locales in the extension.
 359   base::FileEnumerator locales(
 360       locale_path, false, base::FileEnumerator::DIRECTORIES);
 361   base::FilePath locale_folder;
 362   while (!(locale_folder = locales.Next()).empty()) {
 363     std::string locale_name = locale_folder.BaseName().MaybeAsASCII();
 364     if (locale_name.empty()) {
 365       NOTREACHED();
 366       continue;  // Not ASCII.
 367     }
 368     if (!AddLocale(
 369             chrome_locales, locale_folder, locale_name, valid_locales, error)) {
 370       return false;
 371     }
 372   }
 373
 374   if (valid_locales->empty()) {
 375     *error = errors::kLocalesNoValidLocaleNamesListed;
 376     return false;
 377   }
 378
 379   return true;
 380 }
 381
 382 extensions::MessageBundle* LoadMessageCatalogs(
 383     const base::FilePath& locale_path,
 384     const std::string& default_locale,
 385     const std::string& application_locale,
 386     const std::set<std::string>& valid_locales,
 387     std::string* error) {
 388   std::vector<std::string> all_fallback_locales;
 389   GetAllFallbackLocales(
 390       application_locale, default_locale, &all_fallback_locales);
 391
 392   std::vector<linked_ptr<base::DictionaryValue> > catalogs;
 393   for (size_t i = 0; i < all_fallback_locales.size(); ++i) {
 394     // Skip all parent locales that are not supplied.
 395     if (valid_locales.find(all_fallback_locales[i]) == valid_locales.end())
 396       continue;
 397     linked_ptr<base::DictionaryValue> catalog(
 398         LoadMessageFile(locale_path, all_fallback_locales[i], error));
 399     if (!catalog.get()) {
 400       // If locale is valid, but messages.json is corrupted or missing, return
 401       // an error.
 402       return NULL;
 403     } else {
 404       catalogs.push_back(catalog);
 405     }
 406   }
 407
 408   return extensions::MessageBundle::Create(catalogs, error);
 409 }
 410
 411 bool ValidateExtensionLocales(const base::FilePath& extension_path,
 412                               const base::DictionaryValue* manifest,
 413                               std::string* error) {
 414   std::string default_locale = GetDefaultLocaleFromManifest(*manifest, error);
 415
 416   if (default_locale.empty())
 417     return true;
 418
 419   base::FilePath locale_path = extension_path.Append(extensions::kLocaleFolder);
 420
 421   std::set<std::string> valid_locales;
 422   if (!GetValidLocales(locale_path, &valid_locales, error))
 423     return false;
 424
 425   for (std::set<std::string>::const_iterator locale = valid_locales.begin();
 426        locale != valid_locales.end();
 427        ++locale) {
 428     std::string locale_error;
 429     scoped_ptr<base::DictionaryValue> catalog(
 430         LoadMessageFile(locale_path, *locale, &locale_error));
 431
 432     if (!locale_error.empty()) {
 433       if (!error->empty())
 434         error->append(" ");
 435       error->append(locale_error);
 436     }
 437   }
 438
 439   return error->empty();
 440 }
 441
 442 bool ShouldSkipValidation(const base::FilePath& locales_path,
 443                           const base::FilePath& locale_path,
 444                           const std::set<std::string>& all_locales) {
 445   // Since we use this string as a key in a DictionaryValue, be paranoid about
 446   // skipping any strings with '.'. This happens sometimes, for example with
 447   // '.svn' directories.
 448   base::FilePath relative_path;
 449   if (!locales_path.AppendRelativePath(locale_path, &relative_path)) {
 450     NOTREACHED();
 451     return true;
 452   }
 453   std::string subdir = relative_path.MaybeAsASCII();
 454   if (subdir.empty())
 455     return true;  // Non-ASCII.
 456
 457   if (std::find(subdir.begin(), subdir.end(), '.') != subdir.end())
 458     return true;
 459
 460   if (all_locales.find(subdir) == all_locales.end())
 461     return true;
 462
 463   return false;
 464 }
 465
 466 ScopedLocaleForTest::ScopedLocaleForTest()
 467     : locale_(extension_l10n_util::CurrentLocaleOrDefault()) {}
 468
 469 ScopedLocaleForTest::ScopedLocaleForTest(const std::string& locale)
 470     : locale_(extension_l10n_util::CurrentLocaleOrDefault()) {
 471   extension_l10n_util::SetProcessLocale(locale);
 472 }
 473
 474 ScopedLocaleForTest::~ScopedLocaleForTest() {
 475   extension_l10n_util::SetProcessLocale(locale_);
 476 }
 477
 478 }  // namespace extension_l10n_util