diff options
author | rockot@chromium.org <rockot@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2014-04-08 23:32:52 +0000 |
---|---|---|
committer | rockot@chromium.org <rockot@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2014-04-08 23:32:52 +0000 |
commit | 6668e5d092c93131a8ba9735a08c9a85515e121b (patch) | |
tree | a82aadb249f10b150a0cfdb45508296e6b31c4bc /extensions/common/extension_l10n_util.h | |
parent | a1c9554114647996f50e05ea5ee95390125ebc30 (diff) | |
download | chromium_src-6668e5d092c93131a8ba9735a08c9a85515e121b.zip chromium_src-6668e5d092c93131a8ba9735a08c9a85515e121b.tar.gz chromium_src-6668e5d092c93131a8ba9735a08c9a85515e121b.tar.bz2 |
Move core extensions l10n code to //extensions
There are three important changes in this CL, all
interdependent enough that it seemed best to tackle
them at the same time.
1. message_bundle moves to //extensions. (mechanical)
2. extension_l10n_util moves to //extensions. (mechanical)
3. MessageBundle-related functionality from
//chrome/c/e/extension_file_util has been
moved into //extensions/common/file_util
to support the move of extension_l10n_util.
BUG=359836
TBR=sky@chromium.org for chrome/utility, browser_process_impl
TBR=kalman@chromium.org for tabs API
TBR=zork@chromium.org for //c/b/chromeos/input_method
TBR=satorux@chromium.org for //c/b/chromeos/e/file_manager
Review URL: https://codereview.chromium.org/228073005
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@262552 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'extensions/common/extension_l10n_util.h')
-rw-r--r-- | extensions/common/extension_l10n_util.h | 133 |
1 files changed, 133 insertions, 0 deletions
diff --git a/extensions/common/extension_l10n_util.h b/extensions/common/extension_l10n_util.h new file mode 100644 index 0000000..b52a7e6 --- /dev/null +++ b/extensions/common/extension_l10n_util.h @@ -0,0 +1,133 @@ +// Copyright 2014 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. +// +// This file declares extension specific l10n utils. + +#ifndef EXTENSIONS_COMMON_EXTENSION_L10N_UTIL_H_ +#define EXTENSIONS_COMMON_EXTENSION_L10N_UTIL_H_ + +#include <set> +#include <string> +#include <vector> + +namespace base { +class DictionaryValue; +class FilePath; +} + +namespace extensions { +struct ExtensionInfo; +class MessageBundle; +} + +namespace extension_l10n_util { + +// Set the locale for this process to a fixed value, rather than using the +// normal file-based lookup mechanisms. This is used to set the locale inside +// the sandboxed utility process, where file reading is not allowed. +void SetProcessLocale(const std::string& locale); + +// Returns default locale in form "en-US" or "sr" or empty string if +// "default_locale" section was not defined in the manifest.json file. +std::string GetDefaultLocaleFromManifest(const base::DictionaryValue& manifest, + std::string* error); + +// Returns true iff the extension was localized, and the current locale +// doesn't match the locale written into info.extension_manifest. +bool ShouldRelocalizeManifest(const base::DictionaryValue* manifest); + +// Localize extension name, description, browser_action and other fields +// in the manifest. +bool LocalizeManifest(const extensions::MessageBundle& messages, + base::DictionaryValue* manifest, + std::string* error); + +// Load message catalogs, localize manifest and attach message bundle to the +// extension. +bool LocalizeExtension(const base::FilePath& extension_path, + base::DictionaryValue* manifest, + std::string* error); + +// Adds locale_name to the extension if it's in chrome_locales, and +// if messages file is present (we don't check content of messages file here). +// Returns false if locale_name was not found in chrome_locales, and sets +// error with locale_name. +// If file name starts with . return true (helps testing extensions under svn). +bool AddLocale(const std::set<std::string>& chrome_locales, + const base::FilePath& locale_folder, + const std::string& locale_name, + std::set<std::string>* valid_locales, + std::string* error); + +// Returns normalized current locale, or default locale - en_US. +std::string CurrentLocaleOrDefault(); + +// Extends list of Chrome locales to them and their parents, so we can do +// proper fallback. +void GetAllLocales(std::set<std::string>* all_locales); + +// Provides a vector of all fallback locales for message localization. +// The vector is ordered by priority of locale - |application_locale|, +// first_parent, ..., |default_locale|. +void GetAllFallbackLocales(const std::string& application_locale, + const std::string& default_locale, + std::vector<std::string>* all_fallback_locales); + +// Adds valid locales to the extension. +// 1. Do nothing if _locales directory is missing (not an error). +// 2. Get list of Chrome locales. +// 3. Enumerate all subdirectories of _locales directory. +// 4. Intersect both lists, and add intersection to the extension. +// Returns false if any of supplied locales don't match chrome list of locales. +// Fills out error with offending locale name. +bool GetValidLocales(const base::FilePath& locale_path, + std::set<std::string>* locales, + std::string* error); + +// Loads messages file for default locale, and application locales (application +// locales doesn't have to exist). Application locale is current locale and its +// parents. +// Returns message bundle if it can load default locale messages file, and all +// messages are valid, else returns NULL and sets error. +extensions::MessageBundle* LoadMessageCatalogs( + const base::FilePath& locale_path, + const std::string& default_locale, + const std::string& app_locale, + const std::set<std::string>& valid_locales, + std::string* error); + +// Loads message catalogs for all locales to check for validity. +bool ValidateExtensionLocales(const base::FilePath& extension_path, + const base::DictionaryValue* manifest, + std::string* error); + +// Returns true if directory has "." in the name (for .svn) or if it doesn't +// belong to Chrome locales. +// |locales_path| is extension_id/_locales +// |locale_path| is extension_id/_locales/xx +// |all_locales| is a set of all valid Chrome locales. +bool ShouldSkipValidation(const base::FilePath& locales_path, + const base::FilePath& locale_path, + const std::set<std::string>& all_locales); + +// Sets the process locale for the duration of the current scope, then reverts +// back to whatever the current locale was before constructing this. +// For testing purposed only! +class ScopedLocaleForTest { + public: + // Only revert back to current locale at end of scope, don't set locale. + ScopedLocaleForTest(); + + // Set temporary locale for the current scope + explicit ScopedLocaleForTest(const std::string& locale); + + ~ScopedLocaleForTest(); + + private: + std::string locale_; // The current locale at ctor time. +}; + +} // namespace extension_l10n_util + +#endif // EXTENSIONS_COMMON_EXTENSION_L10N_UTIL_H_ |