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 = 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(SourceType source_type,
  67         scoped_ptr<base::DictionaryValue> value)
  68     : source_type_(source_type),
  69       data_(value.Pass()),
  70       i18n_data_(new base::DictionaryValue),
  71       type_(TYPE_UNKNOWN) {
  72   // FIXME: Hosted apps can contain start_url. Below is wrong.
  73   if (data_->Get(keys::kStartURLKey, NULL)) {
  74     type_ = TYPE_PACKAGED_APP;
  75   } else if (data_->HasKey(keys::kAppKey)) {
  76     if (data_->Get(keys::kLaunchWebURLKey, NULL)) {
  77       type_ = TYPE_HOSTED_APP;
  78     } else if (data_->Get(keys::kLaunchLocalPathKey, NULL)) {
  79       type_ = TYPE_PACKAGED_APP;
  80     }
  81   }
  82
  83   if (data_->HasKey(widget_keys::kWidgetKey) &&
  84       data_->Get(widget_keys::kWidgetKey, NULL))
  85     ParseWGTI18n();
  86
  87   // FIXME: Sounds like a setter calling a getter for the same value.
  88   SetSystemLocale(GetSystemLocale());
  89 }
  90
  91 Manifest::~Manifest() {
  92 }
  93
  94 bool Manifest::ValidateManifest(
  95     std::string* error,
  96     std::vector<InstallWarning>* warnings) const {
  97   // TODO(xiang): support features validation
  98   return true;
  99 }
 100
 101 bool Manifest::HasKey(const std::string& key) const {
 102   return CanAccessKey(key) && data_->HasKey(key);
 103 }
 104
 105 bool Manifest::HasPath(const std::string& path) const {
 106   base::Value* ignored = NULL;
 107   return CanAccessPath(path) && data_->Get(path, &ignored);
 108 }
 109
 110 bool Manifest::Get(
 111     const std::string& path, const base::Value** out_value) const {
 112   return CanAccessPath(path) && data_->Get(path, out_value);
 113 }
 114
 115 bool Manifest::Get(
 116     const std::string& path, base::Value** out_value) const {
 117   return this->Get(
 118       path,
 119       const_cast<const base::Value**>(out_value));
 120 }
 121
 122 bool Manifest::GetBoolean(
 123     const std::string& path, bool* out_value) const {
 124   return CanAccessPath(path) && data_->GetBoolean(path, out_value);
 125 }
 126
 127 bool Manifest::GetInteger(
 128     const std::string& path, int* out_value) const {
 129   return CanAccessPath(path) && data_->GetInteger(path, out_value);
 130 }
 131
 132 bool Manifest::GetString(
 133     const std::string& path, std::string* out_value) const {
 134   if (!CanAccessPath(path))
 135     return false;
 136
 137   if (i18n_data_->Get(path, NULL)) {
 138     List::const_iterator it = user_agent_locales_->begin();
 139     for (; it != user_agent_locales_->end(); ++it) {
 140       if (i18n_data_->GetString(GetLocalizedKey(path, *it), out_value))
 141         return true;
 142     }
 143     return false;
 144   }
 145
 146   return data_->GetString(path, out_value);
 147 }
 148
 149 bool Manifest::GetString(
 150     const std::string& path, base::string16* out_value) const {
 151   if (!CanAccessPath(path))
 152     return false;
 153
 154   if (i18n_data_->Get(path, NULL)) {
 155     List::const_iterator it = user_agent_locales_->begin();
 156     for (; it != user_agent_locales_->end(); ++it) {
 157       if (i18n_data_->GetString(GetLocalizedKey(path, *it), out_value))
 158         return true;
 159     }
 160     return false;
 161   }
 162
 163   return data_->GetString(path, out_value);
 164 }
 165
 166 bool Manifest::GetDictionary(
 167     const std::string& path, const base::DictionaryValue** out_value) const {
 168   return CanAccessPath(path) && data_->GetDictionary(path, out_value);
 169 }
 170
 171 bool Manifest::GetList(
 172     const std::string& path, const base::ListValue** out_value) const {
 173   return CanAccessPath(path) && data_->GetList(path, out_value);
 174 }
 175
 176 Manifest* Manifest::DeepCopy() const {
 177   Manifest* manifest = new Manifest(
 178       source_type_, scoped_ptr<base::DictionaryValue>(data_->DeepCopy()));
 179   manifest->SetApplicationID(application_id_);
 180   return manifest;
 181 }
 182
 183 bool Manifest::Equals(const Manifest* other) const {
 184   return other && data_->Equals(other->value());
 185 }
 186
 187 bool Manifest::CanAccessPath(const std::string& path) const {
 188   return true;
 189 }
 190
 191 bool Manifest::CanAccessKey(const std::string& key) const {
 192   return true;
 193 }
 194
 195 void Manifest::SetSystemLocale(const std::string& locale) {
 196   scoped_ptr<List> list_for_expand(new List);
 197   list_for_expand->push_back(locale);
 198   list_for_expand->push_back(default_locale_);
 199   list_for_expand->push_back(kLocaleUnlocalized);
 200   list_for_expand->push_back(kLocaleAuto);
 201   list_for_expand->push_back(kLocaleFirstOne);
 202   user_agent_locales_ = ExpandUserAgentLocalesList(list_for_expand);
 203 }
 204
 205 void Manifest::ParseWGTI18n() {
 206   data_->GetString(application_widget_keys::kDefaultLocaleKey,
 207                    &default_locale_);
 208   default_locale_ = StringToLowerASCII(default_locale_);
 209
 210   ParseWGTI18nEachPath(kWidgetNamePath);
 211   ParseWGTI18nEachPath(kWidgetDecriptionPath);
 212   ParseWGTI18nEachPath(kWidgetLicensePath);
 213 }
 214
 215 // We might get one element of a list of element from path,
 216 // and we parse each element for fast access.
 217 // For example config.xml is:
 218 // <widget>
 219 //   <name>unlocalized name</name>
 220 //   <name xml:lang="zh-CN">zh-CN name</name>
 221 //   <name xml:lang="en-US" short="en-US short">en-US name</name>
 222 // </widget>
 223 // The path for value in i18n_data_ are :
 224 // "widget.name.#text.@unlocalized" => "unlocalized name".
 225 // "widget.name.#text.zh-cn" => "zh-CN name".
 226 // "widget.name.#text.en-us" => "en-US name".
 227 // "widget.name.@short.en-us" => "en-US short".
 228 // "widget.name.#text.*" => "unlocalized name". (the first one)
 229 // "widget.name.@short.*" => "". (the first one do not have a short name)
 230 void Manifest::ParseWGTI18nEachPath(const std::string& path) {
 231   base::Value* value = NULL;
 232   if (!data_->Get(path, &value))
 233     return;
 234
 235   if (value->IsType(base::Value::TYPE_DICTIONARY)) {
 236     ParseWGTI18nEachElement(value, path);
 237     ParseWGTI18nEachElement(value, path, kLocaleFirstOne);
 238   } else if (value->IsType(base::Value::TYPE_LIST)) {
 239     base::ListValue* list;
 240     value->GetAsList(&list);
 241
 242     bool get_first_one = false;
 243     for (base::ListValue::iterator it = list->begin();
 244         it != list->end(); ++it) {
 245       ParseWGTI18nEachElement(*it, path);
 246       if (!get_first_one)
 247         get_first_one = ParseWGTI18nEachElement(*it, path, kLocaleFirstOne);
 248     }
 249   }
 250 }
 251
 252 bool Manifest::ParseWGTI18nEachElement(base::Value* value,
 253                                        const std::string& path,
 254                                        const std::string& locale) {
 255   base::DictionaryValue* dict;
 256   if (!value->GetAsDictionary(&dict))
 257     return false;
 258
 259   std::string xml_lang(locale);
 260   if (locale.empty())
 261     dict->GetString(application_widget_keys::kXmlLangKey, &xml_lang);
 262
 263   base::DictionaryValue::Iterator iter(*dict);
 264   while (!iter.IsAtEnd()) {
 265     std::string locale_key(
 266         GetLocalizedKey(path + kPathConnectSymbol + iter.key(), xml_lang));
 267     if (!i18n_data_->Get(locale_key, NULL))
 268       i18n_data_->Set(locale_key, iter.value().DeepCopy());
 269
 270     iter.Advance();
 271   }
 272
 273   return true;
 274 }
 275
 276 }  // namespace application
 277 }  // namespace xwalk