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.
5 #include "xwalk/application/common/application_data.h"
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/manifest_handlers/tizen_application_handler.h"
32 #include "xwalk/application/common/permission_policy_manager.h"
33 #include "content/public/common/url_constants.h"
34 #include "url/url_util.h"
35 #include "ui/base/l10n/l10n_util.h"
37 namespace keys = xwalk::application_manifest_keys;
38 namespace widget_keys = xwalk::application_widget_keys;
39 namespace errors = xwalk::application_manifest_errors;
42 namespace application {
45 scoped_refptr<ApplicationData> ApplicationData::Create(
46 const base::FilePath& path, const std::string& explicit_id,
47 SourceType source_type, scoped_ptr<Manifest> manifest,
48 std::string* error_message) {
49 DCHECK(error_message);
51 if (!manifest->ValidateManifest(error_message))
54 scoped_refptr<ApplicationData> app_data =
55 new ApplicationData(path, source_type, manifest.Pass());
56 if (!app_data->Init(explicit_id, &error)) {
57 *error_message = base::UTF16ToUTF8(error);
61 ManifestHandlerRegistry* registry =
62 ManifestHandlerRegistry::GetInstance(app_data->manifest_type());
64 if (!registry->ValidateAppManifest(app_data, error_message))
71 GURL ApplicationData::GetBaseURLFromApplicationId(
72 const std::string& application_id) {
73 return GURL(std::string(kApplicationScheme) +
74 url::kStandardSchemeSeparator + application_id + "/");
77 ApplicationData::ManifestData* ApplicationData::GetManifestData(
78 const std::string& key) const {
79 DCHECK(finished_parsing_manifest_ || thread_checker_.CalledOnValidThread());
80 ManifestDataMap::const_iterator iter = manifest_data_.find(key);
81 if (iter != manifest_data_.end())
82 return iter->second.get();
86 void ApplicationData::SetManifestData(const std::string& key,
87 ApplicationData::ManifestData* data) {
88 DCHECK(!finished_parsing_manifest_ && thread_checker_.CalledOnValidThread());
89 manifest_data_[key] = linked_ptr<ManifestData>(data);
93 std::string ApplicationData::GetPackageID() const {
94 return AppIdToPkgId(application_id_);
98 const std::string ApplicationData::VersionString() const {
99 if (!version_->components().empty())
100 return Version()->GetString();
105 bool ApplicationData::IsHostedApp() const {
106 bool hosted = source_type_ == EXTERNAL_URL;
107 #if defined(OS_TIZEN)
108 if (manifest_->HasPath(widget_keys::kContentNamespace)) {
110 if (manifest_->GetString(widget_keys::kContentNamespace, &ns) &&
111 ns == kTizenNamespacePrefix)
118 ApplicationData::ApplicationData(const base::FilePath& path,
119 SourceType source_type, scoped_ptr<Manifest> manifest)
120 : manifest_version_(0),
122 manifest_(manifest.release()),
123 finished_parsing_manifest_(false),
124 source_type_(source_type) {
125 DCHECK(path_.empty() || path_.IsAbsolute());
128 ApplicationData::~ApplicationData() {
132 GURL ApplicationData::GetResourceURL(const GURL& application_url,
133 const std::string& relative_path) {
134 DCHECK(application_url.SchemeIs(kApplicationScheme));
135 DCHECK_EQ("/", application_url.path());
137 std::string path = relative_path;
139 // If the relative path starts with "/", it is "absolute" relative to the
140 // application base directory, but application_url is already specified to
141 // refer to that base directory, so strip the leading "/" if present.
142 if (relative_path.size() > 0 && relative_path[0] == '/')
143 path = relative_path.substr(1);
145 GURL ret_val = GURL(application_url.spec() + path);
146 DCHECK(StartsWithASCII(ret_val.spec(), application_url.spec(), false));
151 GURL ApplicationData::GetResourceURL(const std::string& relative_path) const {
152 if (!base::PathExists(path_.Append(relative_path))) {
153 LOG(ERROR) << "The path does not exist in the application directory: "
158 return GetResourceURL(URL(), relative_path);
161 bool ApplicationData::Init(const std::string& explicit_id,
162 base::string16* error) {
164 ManifestHandlerRegistry* registry =
165 ManifestHandlerRegistry::GetInstance(manifest_type());
166 if (!registry->ParseAppManifest(this, error))
169 if (!LoadID(explicit_id, error))
171 if (!LoadName(error))
173 if (!LoadVersion(error))
175 if (!LoadDescription(error))
178 application_url_ = ApplicationData::GetBaseURLFromApplicationId(ID());
180 finished_parsing_manifest_ = true;
184 bool ApplicationData::LoadID(const std::string& explicit_id,
185 base::string16* error) {
186 std::string application_id;
187 #if defined(OS_TIZEN)
188 if (manifest_type() == Manifest::TYPE_WIDGET) {
189 const TizenApplicationInfo* tizen_app_info =
190 static_cast<TizenApplicationInfo*>(GetManifestData(
191 widget_keys::kTizenApplicationKey));
192 CHECK(tizen_app_info);
193 application_id = tizen_app_info->id();
194 } else if (manifest_->HasKey(keys::kTizenAppIdKey)) {
195 if (!manifest_->GetString(keys::kTizenAppIdKey, &application_id)) {
196 NOTREACHED() << "Could not get Tizen application key";
201 if (!application_id.empty()) {
202 application_id_ = application_id;
207 if (!explicit_id.empty()) {
208 application_id_ = explicit_id;
212 application_id = GenerateIdForPath(path_);
213 if (application_id.empty()) {
214 NOTREACHED() << "Could not create ID from path.";
217 application_id_ = application_id;
221 bool ApplicationData::LoadName(base::string16* error) {
223 base::string16 localized_name;
224 std::string name_key(GetNameKey(manifest_type()));
226 if (!manifest_->GetString(name_key, &localized_name) &&
227 manifest_type() == Manifest::TYPE_MANIFEST) {
228 *error = base::ASCIIToUTF16(errors::kInvalidName);
231 non_localized_name_ = base::UTF16ToUTF8(localized_name);
232 base::i18n::AdjustStringForLocaleDirection(&localized_name);
233 name_ = base::UTF16ToUTF8(localized_name);
237 bool ApplicationData::LoadVersion(base::string16* error) {
239 std::string version_str;
241 version_.reset(new base::Version());
243 if (manifest_type() == Manifest::TYPE_WIDGET) {
244 bool ok = manifest_->GetString(widget_keys::kVersionKey, &version_str);
246 *error = base::ASCIIToUTF16(errors::kInvalidVersion);
250 version_.reset(new base::Version(version_str));
254 // W3C Manifest (XPK and hosted):
256 bool hasDeprecatedKey = manifest_->HasKey(keys::kDeprecatedVersionKey);
257 bool hasKey = manifest_->HasKey(keys::kXWalkVersionKey);
259 if (!hasKey && !hasDeprecatedKey) {
260 // xwalk_version is optional.
266 if (hasDeprecatedKey) {
267 LOG(WARNING) << "Deprecated key '" << keys::kDeprecatedVersionKey
268 << "' found in addition to '" << keys::kXWalkVersionKey
269 << "'. Consider removing.";
271 ok = manifest_->GetString(keys::kXWalkVersionKey, &version_str);
274 if (!hasKey && hasDeprecatedKey) {
275 LOG(WARNING) << "Deprecated key '" << keys::kDeprecatedVersionKey
276 << "' found. Please migrate to using '" << keys::kXWalkVersionKey
278 ok = manifest_->GetString(keys::kDeprecatedVersionKey, &version_str);
281 version_.reset(new base::Version(version_str));
283 if (!ok || !version_->IsValid() || version_->components().size() > 4) {
284 *error = base::ASCIIToUTF16(errors::kInvalidVersion);
285 version_.reset(new base::Version());
292 bool ApplicationData::LoadDescription(base::string16* error) {
294 // FIXME: Better to assert on use from Widget.
295 if (manifest_type() != Manifest::TYPE_MANIFEST)
296 return true; // No error.
298 bool hasDeprecatedKey = manifest_->HasKey(keys::kDeprecatedDescriptionKey);
299 bool hasKey = manifest_->HasKey(keys::kXWalkDescriptionKey);
302 if (hasDeprecatedKey) {
303 LOG(WARNING) << "Deprecated key '" << keys::kDeprecatedDescriptionKey
304 << "' found in addition to '" << keys::kXWalkDescriptionKey
305 << "'. Consider removing.";
307 bool ok = manifest_->GetString(keys::kXWalkDescriptionKey, &description_);
309 *error = base::ASCIIToUTF16(errors::kInvalidDescription);
313 if (hasDeprecatedKey) {
314 LOG(WARNING) << "Deprecated key '" << keys::kDeprecatedDescriptionKey
315 << "' found. Please migrate to using '" << keys::kXWalkDescriptionKey
317 bool ok = manifest_->GetString(
318 keys::kDeprecatedDescriptionKey, &description_);
320 *error = base::ASCIIToUTF16(errors::kInvalidDescription);
324 // No error but also no description found.
328 StoredPermission ApplicationData::GetPermission(
329 const std::string& permission_name) const {
330 StoredPermissionMap::const_iterator iter =
331 permission_map_.find(permission_name);
332 if (iter == permission_map_.end())
333 return UNDEFINED_STORED_PERM;
337 bool ApplicationData::SetPermission(const std::string& permission_name,
338 StoredPermission perm) {
339 if (perm != UNDEFINED_STORED_PERM) {
340 permission_map_[permission_name] = perm;
346 void ApplicationData::ClearPermissions() {
347 permission_map_.clear();
350 PermissionSet ApplicationData::GetManifestPermissions() const {
351 PermissionSet permissions;
352 if (manifest_->value()->HasKey(keys::kPermissionsKey)) {
353 const PermissionsInfo* perm_info = static_cast<PermissionsInfo*>(
354 GetManifestData(keys::kPermissionsKey));
355 permissions = perm_info->GetAPIPermissions();
360 bool ApplicationData::HasCSPDefined() const {
361 #if defined(OS_TIZEN)
362 return manifest_->HasPath(GetCSPKey(manifest_type())) ||
363 manifest_->HasPath(widget_keys::kCSPReportOnlyKey) ||
364 manifest_->HasPath(widget_keys::kAllowNavigationKey);
366 return manifest_->HasPath(GetCSPKey(manifest_type()));
370 bool ApplicationData::SetApplicationLocale(const std::string& locale,
371 base::string16* error) {
372 DCHECK(thread_checker_.CalledOnValidThread());
373 manifest_->SetSystemLocale(locale);
374 if (!LoadName(error))
376 if (!LoadDescription(error))
379 // Only update when the package is wgt and we have parsed the widget handler,
380 // otherwise we can not get widget_info.
381 if (WidgetInfo* widget_info = static_cast<WidgetInfo*>(
382 GetManifestData(widget_keys::kWidgetKey))) {
383 std::string string_value;
384 if (manifest_->GetString(widget_keys::kNameKey, &string_value))
385 widget_info->SetName(string_value);
386 if (manifest_->GetString(widget_keys::kShortNameKey, &string_value))
387 widget_info->SetShortName(string_value);
388 if (manifest_->GetString(widget_keys::kDescriptionKey, &string_value))
389 widget_info->SetDescription(string_value);
394 } // namespace application