src/xwalk/application/common/application_data.cc

   1 // Copyright (c) 2013 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/application_data.h"
   6
   7 #include "base/base64.h"
   8 #include "base/basictypes.h"
   9 #include "base/command_line.h"
  10 #include "base/file_util.h"
  11 #include "base/files/file_path.h"
  12 #include "base/i18n/rtl.h"
  13 #include "base/logging.h"
  14 #include "base/memory/singleton.h"
  15 #include "base/stl_util.h"
  16 #include "base/strings/string16.h"
  17 #include "base/strings/string_util.h"
  18 #include "base/strings/stringprintf.h"
  19 #include "base/strings/string_number_conversions.h"
  20 #include "base/strings/string_piece.h"
  21 #include "base/strings/utf_string_conversions.h"
  22 #include "base/values.h"
  23 #include "base/version.h"
  24 #include "xwalk/application/common/application_manifest_constants.h"
  25 #include "xwalk/application/common/id_util.h"
  26 #include "xwalk/application/common/constants.h"
  27 #include "xwalk/application/common/manifest.h"
  28 #include "xwalk/application/common/manifest_handler.h"
  29 #include "xwalk/application/common/manifest_handlers/permissions_handler.h"
  30 #include "xwalk/application/common/manifest_handlers/widget_handler.h"
  31 #include "xwalk/application/common/permission_policy_manager.h"
  32 #include "content/public/common/url_constants.h"
  33 #include "url/url_util.h"
  34 #include "ui/base/l10n/l10n_util.h"
  35
  36 namespace keys = xwalk::application_manifest_keys;
  37 namespace widget_keys = xwalk::application_widget_keys;
  38 namespace errors = xwalk::application_manifest_errors;
  39
  40 namespace xwalk {
  41 namespace application {
  42
  43 // static
  44 scoped_refptr<ApplicationData> ApplicationData::Create(
  45     const base::FilePath& path,
  46     Manifest::SourceType source_type,
  47     const base::DictionaryValue& manifest_data,
  48     const std::string& explicit_id,
  49     std::string* error_message) {
  50   DCHECK(error_message);
  51   base::string16 error;
  52   scoped_ptr<xwalk::application::Manifest> manifest(
  53       new xwalk::application::Manifest(source_type,
  54                  scoped_ptr<base::DictionaryValue>(manifest_data.DeepCopy())));
  55
  56   if (!InitApplicationID(manifest.get(), path, explicit_id, &error)) {
  57     *error_message = base::UTF16ToUTF8(error);
  58     return NULL;
  59   }
  60
  61   std::vector<InstallWarning> install_warnings;
  62   if (!manifest->ValidateManifest(error_message, &install_warnings)) {
  63     return NULL;
  64   }
  65
  66   scoped_refptr<ApplicationData> application = new ApplicationData(path,
  67                                                            manifest.Pass());
  68   application->install_warnings_.swap(install_warnings);
  69
  70   if (!application->Init(&error)) {
  71     *error_message = base::UTF16ToUTF8(error);
  72     return NULL;
  73   }
  74
  75   return application;
  76 }
  77
  78 // static
  79 bool ApplicationData::IsIDValid(const std::string& id) {
  80   std::string temp = StringToLowerASCII(id);
  81
  82 #if defined(OS_TIZEN)
  83   // An ID with 10 characters is most likely a legacy Tizen ID.
  84   if (temp.size() == kLegacyTizenIdSize) {
  85     for (size_t i = 0; i < kLegacyTizenIdSize; ++i) {
  86       const char c = temp[i];
  87       const bool valid = (c >= '0' && c <= '9') || (c >= 'a' && c <= 'z');
  88       if (!valid)
  89         return false;
  90     }
  91
  92     return true;
  93   }
  94 #endif
  95
  96   // Verify that the id is legal.
  97   if (temp.size() != (kIdSize * 2))
  98     return false;
  99
 100   // We only support lowercase IDs, because IDs can be used as URL components
 101   // (where GURL will lowercase it).
 102   for (size_t i = 0; i < temp.size(); ++i)
 103     if (temp[i] < 'a' || temp[i] > 'p')
 104       return false;
 105
 106   return true;
 107 }
 108
 109 // static
 110 GURL ApplicationData::GetBaseURLFromApplicationId(
 111     const std::string& application_id) {
 112   return GURL(std::string(xwalk::application::kApplicationScheme) +
 113               content::kStandardSchemeSeparator + application_id + "/");
 114 }
 115
 116 ApplicationData::ManifestData* ApplicationData::GetManifestData(
 117         const std::string& key) const {
 118   DCHECK(finished_parsing_manifest_ || thread_checker_.CalledOnValidThread());
 119   ManifestDataMap::const_iterator iter = manifest_data_.find(key);
 120   if (iter != manifest_data_.end())
 121     return iter->second.get();
 122   return NULL;
 123 }
 124
 125 void ApplicationData::SetManifestData(const std::string& key,
 126                                       ApplicationData::ManifestData* data) {
 127   DCHECK(!finished_parsing_manifest_ && thread_checker_.CalledOnValidThread());
 128   manifest_data_[key] = linked_ptr<ManifestData>(data);
 129 }
 130
 131 Manifest::SourceType ApplicationData::GetSourceType() const {
 132   return manifest_->GetSourceType();
 133 }
 134
 135 const std::string& ApplicationData::ID() const {
 136   return manifest_->GetApplicationID();
 137 }
 138
 139 const std::string ApplicationData::VersionString() const {
 140   if (!version_->components().empty())
 141     return Version()->GetString();
 142
 143   return "";
 144 }
 145
 146 bool ApplicationData::IsPlatformApp() const {
 147   return manifest_->IsPackaged();
 148 }
 149
 150 bool ApplicationData::IsHostedApp() const {
 151   return GetManifest()->IsHosted();
 152 }
 153
 154 // static
 155 bool ApplicationData::InitApplicationID(xwalk::application::Manifest* manifest,
 156                                 const base::FilePath& path,
 157                                 const std::string& explicit_id,
 158                                 base::string16* error) {
 159   std::string application_id;
 160 #if defined(OS_TIZEN)
 161   if (manifest->HasKey(keys::kTizenAppIdKey)) {
 162     if (!manifest->GetString(keys::kTizenAppIdKey, &application_id)) {
 163       NOTREACHED() << "Could not get Tizen application key";
 164       return false;
 165     }
 166   }
 167
 168   if (!application_id.empty()) {
 169     manifest->SetApplicationID(application_id);
 170     return true;
 171   }
 172 #endif
 173
 174   if (!explicit_id.empty()) {
 175     manifest->SetApplicationID(explicit_id);
 176     return true;
 177   }
 178
 179   application_id = GenerateIdForPath(path);
 180   if (application_id.empty()) {
 181     NOTREACHED() << "Could not create ID from path.";
 182     return false;
 183   }
 184   manifest->SetApplicationID(application_id);
 185   return true;
 186 }
 187
 188 ApplicationData::ApplicationData(const base::FilePath& path,
 189                      scoped_ptr<xwalk::application::Manifest> manifest)
 190     : manifest_version_(0),
 191       manifest_(manifest.release()),
 192       finished_parsing_manifest_(false) {
 193   DCHECK(path.empty() || path.IsAbsolute());
 194   path_ = path;
 195   if (manifest_->HasPath(widget_keys::kWidgetKey))
 196     package_type_ = Package::WGT;
 197   else
 198     package_type_ = Package::XPK;
 199 }
 200
 201 ApplicationData::~ApplicationData() {
 202 }
 203
 204 // static
 205 GURL ApplicationData::GetResourceURL(const GURL& application_url,
 206                                const std::string& relative_path) {
 207   DCHECK(application_url.SchemeIs(xwalk::application::kApplicationScheme));
 208   DCHECK_EQ("/", application_url.path());
 209
 210   std::string path = relative_path;
 211
 212   // If the relative path starts with "/", it is "absolute" relative to the
 213   // application base directory, but application_url is already specified to
 214   // refer to that base directory, so strip the leading "/" if present.
 215   if (relative_path.size() > 0 && relative_path[0] == '/')
 216     path = relative_path.substr(1);
 217
 218   GURL ret_val = GURL(application_url.spec() + path);
 219   DCHECK(StartsWithASCII(ret_val.spec(), application_url.spec(), false));
 220
 221   return ret_val;
 222 }
 223
 224 Manifest::Type ApplicationData::GetType() const {
 225   return manifest_->GetType();
 226 }
 227
 228 bool ApplicationData::Init(base::string16* error) {
 229   DCHECK(error);
 230
 231   if (!LoadName(error))
 232     return false;
 233   if (!LoadVersion(error))
 234       return false;
 235   if (!LoadDescription(error))
 236       return false;
 237   if (!LoadManifestVersion(error))
 238     return false;
 239
 240   application_url_ = ApplicationData::GetBaseURLFromApplicationId(ID());
 241
 242   ManifestHandlerRegistry* registry =
 243       ManifestHandlerRegistry::GetInstance(GetPackageType());
 244   if (!registry->ParseAppManifest(this, error))
 245     return false;
 246
 247   finished_parsing_manifest_ = true;
 248   return true;
 249 }
 250
 251 bool ApplicationData::LoadName(base::string16* error) {
 252   DCHECK(error);
 253   base::string16 localized_name;
 254   std::string name_key(GetNameKey(GetPackageType()));
 255
 256   if (!manifest_->GetString(name_key, &localized_name) &&
 257       package_type_ == Package::XPK) {
 258     *error = base::ASCIIToUTF16(errors::kInvalidName);
 259     return false;
 260   }
 261   non_localized_name_ = base::UTF16ToUTF8(localized_name);
 262   base::i18n::AdjustStringForLocaleDirection(&localized_name);
 263   name_ = base::UTF16ToUTF8(localized_name);
 264   return true;
 265 }
 266
 267 bool ApplicationData::LoadVersion(base::string16* error) {
 268   DCHECK(error);
 269   std::string version_str;
 270   std::string version_key(GetVersionKey(GetPackageType()));
 271
 272   if (!manifest_->GetString(version_key, &version_str) &&
 273       package_type_ == Package::XPK) {
 274     *error = base::ASCIIToUTF16(errors::kInvalidVersion);
 275     return false;
 276   }
 277   version_.reset(new base::Version(version_str));
 278   if (package_type_ == Package::XPK &&
 279       (!version_->IsValid() || version_->components().size() > 4)) {
 280     *error = base::ASCIIToUTF16(errors::kInvalidVersion);
 281     return false;
 282   }
 283   return true;
 284 }
 285
 286 bool ApplicationData::LoadDescription(base::string16* error) {
 287   DCHECK(error);
 288   if (manifest_->HasKey(keys::kDescriptionKey) &&
 289       !manifest_->GetString(keys::kDescriptionKey, &description_) &&
 290       package_type_ == Package::XPK) {
 291     *error = base::ASCIIToUTF16(errors::kInvalidDescription);
 292     return false;
 293   }
 294   return true;
 295 }
 296
 297 bool ApplicationData::LoadManifestVersion(base::string16* error) {
 298   DCHECK(error);
 299   // Get the original value out of the dictionary so that we can validate it
 300   // more strictly.
 301   if (manifest_->value()->HasKey(keys::kManifestVersionKey)) {
 302     int manifest_version = 1;
 303     if (!manifest_->GetInteger(keys::kManifestVersionKey, &manifest_version) ||
 304         manifest_version < 1) {
 305       if (package_type_ == Package::XPK) {
 306         *error = base::ASCIIToUTF16(errors::kInvalidManifestVersion);
 307         return false;
 308       }
 309     }
 310   }
 311
 312   manifest_version_ = manifest_->GetManifestVersion();
 313   return true;
 314 }
 315
 316 StoredPermission ApplicationData::GetPermission(
 317     const std::string& permission_name) const {
 318   StoredPermissionMap::const_iterator iter =
 319       permission_map_.find(permission_name);
 320   if (iter == permission_map_.end())
 321     return UNDEFINED_STORED_PERM;
 322   return iter->second;
 323 }
 324
 325 bool ApplicationData::SetPermission(const std::string& permission_name,
 326                                     StoredPermission perm) {
 327   if (perm != UNDEFINED_STORED_PERM) {
 328     permission_map_[permission_name] = perm;
 329     return true;
 330   }
 331   return false;
 332 }
 333
 334 void ApplicationData::ClearPermissions() {
 335   permission_map_.clear();
 336 }
 337
 338 PermissionSet ApplicationData::GetManifestPermissions() const {
 339   PermissionSet permissions;
 340   if (manifest_->value()->HasKey(keys::kPermissionsKey)) {
 341     const PermissionsInfo* perm_info = static_cast<PermissionsInfo*>(
 342                            GetManifestData(keys::kPermissionsKey));
 343     permissions = perm_info->GetAPIPermissions();
 344   }
 345   return permissions;
 346 }
 347
 348 bool ApplicationData::HasCSPDefined() const {
 349 #if defined(OS_TIZEN)
 350   return  manifest_->HasPath(GetCSPKey(package_type_)) ||
 351           manifest_->HasPath(widget_keys::kCSPReportOnlyKey) ||
 352           manifest_->HasPath(widget_keys::kAllowNavigationKey);
 353 #else
 354   return manifest_->HasPath(GetCSPKey(package_type_));
 355 #endif
 356 }
 357
 358 bool ApplicationData::SetApplicationLocale(const std::string& locale,
 359                                            base::string16* error) {
 360   DCHECK(thread_checker_.CalledOnValidThread());
 361   manifest_->SetSystemLocale(locale);
 362   if (!LoadName(error))
 363     return false;
 364   if (!LoadDescription(error))
 365     return false;
 366
 367   // Only update when the package is wgt and we have parsed the widget handler,
 368   // otherwise we can not get widget_info.
 369   if (WidgetInfo* widget_info = static_cast<WidgetInfo*>(
 370           GetManifestData(widget_keys::kWidgetKey))) {
 371     std::string string_value;
 372     if (manifest_->GetString(widget_keys::kNameKey, &string_value))
 373       widget_info->SetName(string_value);
 374     if (manifest_->GetString(widget_keys::kShortNameKey, &string_value))
 375       widget_info->SetShortName(string_value);
 376     if (manifest_->GetString(widget_keys::kDescriptionKey, &string_value))
 377       widget_info->SetDescription(string_value);
 378   }
 379   return true;
 380 }
 381
 382 }   // namespace application
 383 }   // namespace xwalk