src/xwalk/application/common/manifest.cc

   1 // Copyright (c) 2012 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 "xwalk/application/common/manifest.h"
   6
   7 #include <list>
   8
   9 #include "base/basictypes.h"
  10 #include "base/lazy_instance.h"
  11 #include "base/logging.h"
  12 #include "base/strings/string_util.h"
  13 #include "base/strings/stringprintf.h"
  14 #include "base/strings/string_split.h"
  15 #include "base/strings/utf_string_conversions.h"
  16 #include "xwalk/application/common/application_manifest_constants.h"
  17 #include "xwalk/runtime/common/xwalk_system_locale.h"
  18
  19 namespace errors = xwalk::application_manifest_errors;
  20 namespace keys   = xwalk::application_manifest_keys;
  21 namespace widget_keys = xwalk::application_widget_keys;
  22
  23 namespace xwalk {
  24 namespace application {
  25 namespace {
  26 const char kLocaleUnlocalized[] = "@unlocalized";
  27 #if defined(OS_TIZEN)
  28 const char kLocaleAuto[] = "en-gb";
  29 #else
  30 const char kLocaleAuto[] = "en-us";
  31 #endif
  32 const char kLocaleFirstOne[] = "*";
  33
  34 const char kWidgetNamePath[] = "widget.name";
  35 const char kWidgetDecriptionPath[] = "widget.description";
  36 const char kWidgetLicensePath[] = "widget.license";
  37
  38 const char kPathConnectSymbol = '.';
  39
  40 typedef std::list<std::string> List;
  41
  42 std::string GetLocalizedKey(const std::string& key,
  43                             const std::string& local) {
  44   std::string lower_local = base::StringToLowerASCII(local);
  45   if (lower_local.empty())
  46     lower_local = kLocaleUnlocalized;
  47   return key + kPathConnectSymbol + lower_local;
  48 }
  49
  50 scoped_ptr<List> ExpandUserAgentLocalesList(const scoped_ptr<List>& list) {
  51   scoped_ptr<List> expansion_list(new List);
  52   for (List::const_iterator it = list->begin(); it != list->end(); ++it) {
  53     std::string copy_locale(*it);
  54     size_t position;
  55     do {
  56       expansion_list->push_back(copy_locale);
  57       position = copy_locale.find_last_of("-");
  58       copy_locale = copy_locale.substr(0, position);
  59     } while (position != std::string::npos);
  60   }
  61   return expansion_list.Pass();
  62 }
  63
  64 }  // namespace
  65
  66 Manifest::Manifest(scoped_ptr<base::DictionaryValue> value)
  67     : data_(value.Pass()),
  68       i18n_data_(new base::DictionaryValue),
  69       type_(TYPE_UNKNOWN) {
  70   // FIXME: Hosted apps can contain start_url. Below is wrong.
  71   if (data_->Get(keys::kStartURLKey, NULL)) {
  72     type_ = TYPE_PACKAGED_APP;
  73   } else if (data_->HasKey(keys::kAppKey)) {
  74     if (data_->Get(keys::kLaunchWebURLKey, NULL)) {
  75       type_ = TYPE_HOSTED_APP;
  76     } else if (data_->Get(keys::kLaunchLocalPathKey, NULL)) {
  77       type_ = TYPE_PACKAGED_APP;
  78     }
  79 #if defined(OS_TIZEN)
  80   } else if (HasPath(widget_keys::kContentNamespace)) {
  81     std::string ns;
  82     if (data_->GetString(widget_keys::kContentNamespace, &ns) &&
  83         ns == kTizenNamespacePrefix)
  84       type_ = TYPE_HOSTED_APP;
  85     else
  86       type_ = TYPE_PACKAGED_APP;
  87 #endif
  88   }
  89
  90   if (data_->HasKey(widget_keys::kWidgetKey) &&
  91       data_->Get(widget_keys::kWidgetKey, NULL))
  92     ParseWGTI18n();
  93
  94   // FIXME: Sounds like a setter calling a getter for the same value.
  95   SetSystemLocale(GetSystemLocale());
  96 }
  97
  98 Manifest::~Manifest() {
  99 }
 100
 101 bool Manifest::ValidateManifest(
 102     std::string* error) const {
 103   // TODO(xiang): support features validation
 104   return true;
 105 }
 106
 107 bool Manifest::HasKey(const std::string& key) const {
 108   return CanAccessKey(key) && data_->HasKey(key);
 109 }
 110
 111 bool Manifest::HasPath(const std::string& path) const {
 112   base::Value* ignored = NULL;
 113   return CanAccessPath(path) && data_->Get(path, &ignored);
 114 }
 115
 116 bool Manifest::Get(
 117     const std::string& path, const base::Value** out_value) const {
 118   return CanAccessPath(path) && data_->Get(path, out_value);
 119 }
 120
 121 bool Manifest::Get(
 122     const std::string& path, base::Value** out_value) const {
 123   return this->Get(
 124       path,
 125       const_cast<const base::Value**>(out_value));
 126 }
 127
 128 bool Manifest::GetBoolean(
 129     const std::string& path, bool* out_value) const {
 130   return CanAccessPath(path) && data_->GetBoolean(path, out_value);
 131 }
 132
 133 bool Manifest::GetInteger(
 134     const std::string& path, int* out_value) const {
 135   return CanAccessPath(path) && data_->GetInteger(path, out_value);
 136 }
 137
 138 bool Manifest::GetString(
 139     const std::string& path, std::string* out_value) const {
 140   if (!CanAccessPath(path))
 141     return false;
 142
 143   if (i18n_data_->Get(path, NULL)) {
 144     List::const_iterator it = user_agent_locales_->begin();
 145     for (; it != user_agent_locales_->end(); ++it) {
 146       if (i18n_data_->GetString(GetLocalizedKey(path, *it), out_value))
 147         return true;
 148     }
 149     return false;
 150   }
 151
 152   return data_->GetString(path, out_value);
 153 }
 154
 155 bool Manifest::GetString(
 156     const std::string& path, base::string16* out_value) const {
 157   if (!CanAccessPath(path))
 158     return false;
 159
 160   if (i18n_data_->Get(path, NULL)) {
 161     List::const_iterator it = user_agent_locales_->begin();
 162     for (; it != user_agent_locales_->end(); ++it) {
 163       if (i18n_data_->GetString(GetLocalizedKey(path, *it), out_value))
 164         return true;
 165     }
 166     return false;
 167   }
 168
 169   return data_->GetString(path, out_value);
 170 }
 171
 172 bool Manifest::GetDictionary(
 173     const std::string& path, const base::DictionaryValue** out_value) const {
 174   return CanAccessPath(path) && data_->GetDictionary(path, out_value);
 175 }
 176
 177 bool Manifest::GetList(
 178     const std::string& path, const base::ListValue** out_value) const {
 179   return CanAccessPath(path) && data_->GetList(path, out_value);
 180 }
 181
 182 Manifest* Manifest::DeepCopy() const {
 183   Manifest* manifest = new Manifest(
 184       scoped_ptr<base::DictionaryValue>(data_->DeepCopy()));
 185   manifest->SetApplicationID(application_id_);
 186   return manifest;
 187 }
 188
 189 bool Manifest::Equals(const Manifest* other) const {
 190   return other && data_->Equals(other->value());
 191 }
 192
 193 bool Manifest::CanAccessPath(const std::string& path) const {
 194   return true;
 195 }
 196
 197 bool Manifest::CanAccessKey(const std::string& key) const {
 198   return true;
 199 }
 200
 201 void Manifest::SetSystemLocale(const std::string& locale) {
 202   scoped_ptr<List> list_for_expand(new List);
 203   list_for_expand->push_back(locale);
 204   list_for_expand->push_back(default_locale_);
 205   list_for_expand->push_back(kLocaleUnlocalized);
 206   list_for_expand->push_back(kLocaleAuto);
 207   list_for_expand->push_back(kLocaleFirstOne);
 208   user_agent_locales_ = ExpandUserAgentLocalesList(list_for_expand);
 209 }
 210
 211 void Manifest::ParseWGTI18n() {
 212   data_->GetString(application_widget_keys::kDefaultLocaleKey,
 213                    &default_locale_);
 214   default_locale_ = base::StringToLowerASCII(default_locale_);
 215
 216   ParseWGTI18nEachPath(kWidgetNamePath);
 217   ParseWGTI18nEachPath(kWidgetDecriptionPath);
 218   ParseWGTI18nEachPath(kWidgetLicensePath);
 219 }
 220
 221 // We might get one element of a list of element from path,
 222 // and we parse each element for fast access.
 223 // For example config.xml is:
 224 // <widget>
 225 //   <name>unlocalized name</name>
 226 //   <name xml:lang="zh-CN">zh-CN name</name>
 227 //   <name xml:lang="en-US" short="en-US short">en-US name</name>
 228 // </widget>
 229 // The path for value in i18n_data_ are :
 230 // "widget.name.#text.@unlocalized" => "unlocalized name".
 231 // "widget.name.#text.zh-cn" => "zh-CN name".
 232 // "widget.name.#text.en-us" => "en-US name".
 233 // "widget.name.@short.en-us" => "en-US short".
 234 // "widget.name.#text.*" => "unlocalized name". (the first one)
 235 // "widget.name.@short.*" => "". (the first one do not have a short name)
 236 void Manifest::ParseWGTI18nEachPath(const std::string& path) {
 237   base::Value* value = NULL;
 238   if (!data_->Get(path, &value))
 239     return;
 240
 241   if (value->IsType(base::Value::TYPE_DICTIONARY)) {
 242     ParseWGTI18nEachElement(value, path);
 243     ParseWGTI18nEachElement(value, path, kLocaleFirstOne);
 244   } else if (value->IsType(base::Value::TYPE_LIST)) {
 245     base::ListValue* list;
 246     value->GetAsList(&list);
 247
 248     bool get_first_one = false;
 249     for (base::ListValue::iterator it = list->begin();
 250         it != list->end(); ++it) {
 251       ParseWGTI18nEachElement(*it, path);
 252       if (!get_first_one)
 253         get_first_one = ParseWGTI18nEachElement(*it, path, kLocaleFirstOne);
 254     }
 255   }
 256 }
 257
 258 bool Manifest::ParseWGTI18nEachElement(base::Value* value,
 259                                        const std::string& path,
 260                                        const std::string& locale) {
 261   base::DictionaryValue* dict;
 262   if (!value->GetAsDictionary(&dict))
 263     return false;
 264
 265   std::string xml_lang(locale);
 266   if (locale.empty())
 267     dict->GetString(application_widget_keys::kXmlLangKey, &xml_lang);
 268
 269   base::DictionaryValue::Iterator iter(*dict);
 270   while (!iter.IsAtEnd()) {
 271     std::string locale_key(
 272         GetLocalizedKey(path + kPathConnectSymbol + iter.key(), xml_lang));
 273     if (!i18n_data_->Get(locale_key, NULL))
 274       i18n_data_->Set(locale_key, iter.value().DeepCopy());
 275
 276     iter.Advance();
 277   }
 278
 279   return true;
 280 }
 281
 282 }  // namespace application
 283 }  // namespace xwalk