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/main_document_handler.h"
  30 #include "xwalk/application/common/manifest_handlers/permissions_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   return Version()->GetString();
 141 }
 142
 143 bool ApplicationData::IsPlatformApp() const {
 144   return manifest_->IsPackaged();
 145 }
 146
 147 bool ApplicationData::IsHostedApp() const {
 148   return GetManifest()->IsHosted();
 149 }
 150
 151 Manifest::PackageType ApplicationData::GetPackageType() const {
 152   return manifest_->GetPackageType();
 153 }
 154
 155 bool ApplicationData::HasMainDocument() const {
 156   MainDocumentInfo* main_info = ToMainDocumentInfo(
 157       GetManifestData(application_manifest_keys::kAppMainKey));
 158
 159   return main_info != NULL;
 160 }
 161
 162 // static
 163 bool ApplicationData::InitApplicationID(xwalk::application::Manifest* manifest,
 164                                 const base::FilePath& path,
 165                                 const std::string& explicit_id,
 166                                 base::string16* error) {
 167   std::string application_id;
 168 #if defined(OS_TIZEN)
 169   if (manifest->HasKey(keys::kTizenAppIdKey)) {
 170     if (!manifest->GetString(keys::kTizenAppIdKey, &application_id)) {
 171       NOTREACHED() << "Could not get Tizen application key";
 172       return false;
 173     }
 174   }
 175
 176   if (!application_id.empty()) {
 177     manifest->SetApplicationID(application_id);
 178     return true;
 179   }
 180 #endif
 181
 182   if (!explicit_id.empty()) {
 183     manifest->SetApplicationID(explicit_id);
 184     return true;
 185   }
 186
 187   application_id = GenerateIdForPath(path);
 188   if (application_id.empty()) {
 189     NOTREACHED() << "Could not create ID from path.";
 190     return false;
 191   }
 192   manifest->SetApplicationID(application_id);
 193   return true;
 194 }
 195
 196 ApplicationData::ApplicationData(const base::FilePath& path,
 197                      scoped_ptr<xwalk::application::Manifest> manifest)
 198     : manifest_version_(0),
 199       is_dirty_(false),
 200       manifest_(manifest.release()),
 201       finished_parsing_manifest_(false) {
 202   DCHECK(path.empty() || path.IsAbsolute());
 203   path_ = path;
 204 }
 205
 206 ApplicationData::~ApplicationData() {
 207 }
 208
 209 // static
 210 GURL ApplicationData::GetResourceURL(const GURL& application_url,
 211                                const std::string& relative_path) {
 212   DCHECK(application_url.SchemeIs(xwalk::application::kApplicationScheme));
 213   DCHECK_EQ("/", application_url.path());
 214
 215   std::string path = relative_path;
 216
 217   // If the relative path starts with "/", it is "absolute" relative to the
 218   // application base directory, but application_url is already specified to
 219   // refer to that base directory, so strip the leading "/" if present.
 220   if (relative_path.size() > 0 && relative_path[0] == '/')
 221     path = relative_path.substr(1);
 222
 223   GURL ret_val = GURL(application_url.spec() + path);
 224   DCHECK(StartsWithASCII(ret_val.spec(), application_url.spec(), false));
 225
 226   return ret_val;
 227 }
 228
 229 Manifest::Type ApplicationData::GetType() const {
 230   return manifest_->GetType();
 231 }
 232
 233 bool ApplicationData::Init(base::string16* error) {
 234   DCHECK(error);
 235
 236   if (!LoadName(error))
 237     return false;
 238   if (!LoadVersion(error))
 239       return false;
 240   if (!LoadDescription(error))
 241       return false;
 242   if (!LoadManifestVersion(error))
 243     return false;
 244
 245   application_url_ = ApplicationData::GetBaseURLFromApplicationId(ID());
 246
 247   ManifestHandlerRegistry* registry =
 248       ManifestHandlerRegistry::GetInstance(GetPackageType());
 249   if (!registry->ParseAppManifest(this, error))
 250     return false;
 251
 252   finished_parsing_manifest_ = true;
 253   return true;
 254 }
 255
 256 bool ApplicationData::LoadName(base::string16* error) {
 257   DCHECK(error);
 258   base::string16 localized_name;
 259   std::string name_key(GetNameKey(GetPackageType()));
 260
 261   if (!manifest_->GetString(name_key, &localized_name) &&
 262       manifest_->IsXPKPackaged()) {
 263     *error = base::ASCIIToUTF16(errors::kInvalidName);
 264     return false;
 265   }
 266   non_localized_name_ = base::UTF16ToUTF8(localized_name);
 267   base::i18n::AdjustStringForLocaleDirection(&localized_name);
 268   name_ = base::UTF16ToUTF8(localized_name);
 269   return true;
 270 }
 271
 272 bool ApplicationData::LoadVersion(base::string16* error) {
 273   DCHECK(error);
 274   std::string version_str;
 275   std::string version_key(GetVersionKey(GetPackageType()));
 276
 277   if (!manifest_->GetString(version_key, &version_str) &&
 278       manifest_->IsXPKPackaged()) {
 279     *error = base::ASCIIToUTF16(errors::kInvalidVersion);
 280     return false;
 281   }
 282   version_.reset(new base::Version(version_str));
 283   if (manifest_->IsXPKPackaged() &&
 284       (!version_->IsValid() || version_->components().size() > 4)) {
 285     *error = base::ASCIIToUTF16(errors::kInvalidVersion);
 286     return false;
 287   }
 288   return true;
 289 }
 290
 291 bool ApplicationData::LoadDescription(base::string16* error) {
 292   DCHECK(error);
 293   if (manifest_->HasKey(keys::kDescriptionKey) &&
 294       !manifest_->GetString(keys::kDescriptionKey, &description_) &&
 295       manifest_->IsXPKPackaged()) {
 296     *error = base::ASCIIToUTF16(errors::kInvalidDescription);
 297     return false;
 298   }
 299   return true;
 300 }
 301
 302 bool ApplicationData::LoadManifestVersion(base::string16* error) {
 303   DCHECK(error);
 304   // Get the original value out of the dictionary so that we can validate it
 305   // more strictly.
 306   if (manifest_->value()->HasKey(keys::kManifestVersionKey)) {
 307     int manifest_version = 1;
 308     if (!manifest_->GetInteger(keys::kManifestVersionKey, &manifest_version) ||
 309         manifest_version < 1) {
 310       if (manifest_->IsXPKPackaged()) {
 311         *error = base::ASCIIToUTF16(errors::kInvalidManifestVersion);
 312         return false;
 313       }
 314     }
 315   }
 316
 317   manifest_version_ = manifest_->GetManifestVersion();
 318   return true;
 319 }
 320
 321 void ApplicationData::SetEvents(const std::set<std::string>& events) {
 322   events_ = events;
 323   is_dirty_ = true;
 324 }
 325
 326 const std::set<std::string>& ApplicationData::GetEvents() const {
 327   return events_;
 328 }
 329
 330 StoredPermission ApplicationData::GetPermission(
 331     std::string& permission_name) const {
 332   StoredPermissionMap::const_iterator iter =
 333       permission_map_.find(permission_name);
 334   if (iter == permission_map_.end())
 335     return UNDEFINED_STORED_PERM;
 336   return iter->second;
 337 }
 338
 339 bool ApplicationData::SetPermission(const std::string& permission_name,
 340                                     StoredPermission perm) {
 341   if (perm != UNDEFINED_STORED_PERM) {
 342     permission_map_[permission_name] = perm;
 343     is_dirty_ = true;
 344     return true;
 345   }
 346   return false;
 347 }
 348
 349 void ApplicationData::ClearPermissions() {
 350   permission_map_.clear();
 351 }
 352
 353 PermissionSet ApplicationData::GetManifestPermissions() const {
 354   PermissionSet permissions;
 355   if (manifest_->value()->HasKey(keys::kPermissionsKey)) {
 356     const PermissionsInfo* perm_info = static_cast<PermissionsInfo*>(
 357                            GetManifestData(keys::kPermissionsKey));
 358     permissions = perm_info->GetAPIPermissions();
 359   }
 360   return permissions;
 361 }
 362
 363 }   // namespace application
 364 }   // namespace xwalk