1c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch// Copyright 2014 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch#ifndef EXTENSIONS_COMMON_MESSAGE_BUNDLE_H_ 6c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch#define EXTENSIONS_COMMON_MESSAGE_BUNDLE_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <map> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <vector> 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/linked_ptr.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace base { 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class DictionaryValue; 162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class Value; 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace extensions { 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Contains localized extension messages for one locale. Any messages that the 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// locale does not provide are pulled from the default locale. 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class MessageBundle { 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::map<std::string, std::string> SubstitutionMap; 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::vector<linked_ptr<base::DictionaryValue> > CatalogVector; 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // JSON keys of interest for messages file. 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char* kContentKey; 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char* kMessageKey; 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char* kPlaceholdersKey; 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Begin/end markers for placeholders and messages 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char* kPlaceholderBegin; 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char* kPlaceholderEnd; 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char* kMessageBegin; 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char* kMessageEnd; 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Reserved message names in the dictionary. 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Update i18n documentation when adding new reserved value. 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char* kUILocaleKey; 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See http://code.google.com/apis/gadgets/docs/i18n.html#BIDI for 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // description. 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(cira): point to chrome docs once they are out. 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char* kBidiDirectionKey; 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char* kBidiReversedDirectionKey; 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char* kBidiStartEdgeKey; 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char* kBidiEndEdgeKey; 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Extension id gets added in the 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // browser/renderer_host/resource_message_filter.cc to enable message 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // replacement for non-localized extensions. 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char* kExtensionIdKey; 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Values for some of the reserved messages. 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char* kBidiLeftEdgeValue; 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char* kBidiRightEdgeValue; 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates MessageBundle or returns NULL if there was an error. Expects 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // locale_catalogs to be sorted from more specific to less specific, with 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // default catalog at the end. 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static MessageBundle* Create(const CatalogVector& locale_catalogs, 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string* error); 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get message from the catalog with given key. 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returned message has all of the internal placeholders resolved to their 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // value (content). 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns empty string if it can't find a message. 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // We don't use simple GetMessage name, since there is a global 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // #define GetMessage GetMessageW override in Chrome code. 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string GetL10nMessage(const std::string& name) const; 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get message from the given catalog with given key. 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static std::string GetL10nMessage(const std::string& name, 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const SubstitutionMap& dictionary); 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Number of messages in the catalog. 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Used for unittesting only. 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t size() const { return dictionary_.size(); } 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Replaces all __MSG_message__ with values from the catalog. 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns false if there is a message in text that's not defined in the 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // dictionary. 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool ReplaceMessages(std::string* text, std::string* error) const; 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Static version that accepts dictionary. 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool ReplaceMessagesWithExternalDictionary( 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const SubstitutionMap& dictionary, std::string* text, std::string* error); 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Replaces each occurance of variable placeholder with its value. 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // I.e. replaces __MSG_name__ with value from the catalog with the key "name". 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns false if for a valid message/placeholder name there is no matching 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // replacement. 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Public for easier unittesting. 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool ReplaceVariables(const SubstitutionMap& variables, 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& var_begin, 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& var_end, 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string* message, 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string* error); 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Allow only ascii 0-9, a-z, A-Z, and _ in the variable name. 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns false if the input is empty or if it has illegal characters. 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool IsValidName(const std::string& name); 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Getter for dictionary_. 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const SubstitutionMap* dictionary() const { return &dictionary_; } 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~MessageBundle(); 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Testing friend. 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class MessageBundleTest; 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Use Create to create MessageBundle instance. 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MessageBundle(); 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Initializes the instance from the contents of vector of catalogs. 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If the key is not present in more specific catalog we fall back to next one 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // (less specific). 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns false on error. 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool Init(const CatalogVector& locale_catalogs, std::string* error); 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Appends locale specific reserved messages to the dictionary. 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns false if there was a conflict with user defined messages. 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool AppendReservedMessagesForLocale(const std::string& application_locale, 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string* error); 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Helper methods that navigate JSON tree and return simplified message. 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // They replace all $PLACEHOLDERS$ with their value, and return just key/value 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // of the message. 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool GetMessageValue(const std::string& key, 1302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const base::Value& name_value, 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string* value, 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string* error) const; 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get all placeholders for a given message from JSON subtree. 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool GetPlaceholders(const base::DictionaryValue& name_tree, 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& name_key, 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SubstitutionMap* placeholders, 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string* error) const; 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // For a given message, replaces all placeholders with their actual value. 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns false if replacement failed (see ReplaceVariables). 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool ReplacePlaceholders(const SubstitutionMap& placeholders, 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string* message, 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string* error) const; 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Holds all messages for application locale. 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SubstitutionMap dictionary_; 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/////////////////////////////////////////////////////////////////////////////// 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Renderer helper typedefs and functions. 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/////////////////////////////////////////////////////////////////////////////// 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A map of message name to message. 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef std::map<std::string, std::string> L10nMessagesMap; 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A map of extension ID to l10n message map. 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef std::map<std::string, L10nMessagesMap > ExtensionToL10nMessagesMap; 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Returns the extension_id to messages map. 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)ExtensionToL10nMessagesMap* GetExtensionToL10nMessagesMap(); 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Returns message map that matches given extension_id, or NULL. 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)L10nMessagesMap* GetL10nMessagesMap(const std::string& extension_id); 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Erases the L10nMessagesMap for the given |extension_id|. 1692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)void EraseL10nMessagesMap(const std::string& extension_id); 1702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1710529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch} // namespace extensions 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 173c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch#endif // EXTENSIONS_COMMON_MESSAGE_BUNDLE_H_ 174