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 #ifndef XWALK_APPLICATION_COMMON_APPLICATION_DATA_H_
6 #define XWALK_APPLICATION_COMMON_APPLICATION_DATA_H_
16 #include "base/files/file_path.h"
17 #include "base/memory/linked_ptr.h"
18 #include "base/memory/ref_counted.h"
19 #include "base/memory/scoped_ptr.h"
20 #include "base/strings/string_util.h"
21 #include "base/synchronization/lock.h"
22 #include "base/threading/thread_checker.h"
23 #include "base/time/time.h"
25 #include "xwalk/application/common/install_warning.h"
26 #include "xwalk/application/common/manifest.h"
27 #include "xwalk/application/common/permission_types.h"
30 class DictionaryValue;
36 namespace application {
38 class ApplicationData : public base::RefCountedThreadSafe<ApplicationData> {
42 struct ApplicationIdCompare {
43 bool operator()(const std::string& s1, const std::string& s2) const {
44 return base::strcasecmp(s1.c_str(), s2.c_str()) < 0;
48 typedef std::map<const std::string, linked_ptr<ManifestData> >
50 typedef std::map<std::string,
51 scoped_refptr<ApplicationData>, ApplicationIdCompare>
53 typedef ApplicationDataMap::iterator ApplicationDataMapIterator;
55 // A base class for parsed manifest data that APIs want to store on
56 // the application. Related to base::SupportsUserData, but with an immutable
57 // thread-safe interface to match Application.
59 virtual ~ManifestData() {}
62 static scoped_refptr<ApplicationData> Create(const base::FilePath& path,
63 Manifest::SourceType source_type,
64 const base::DictionaryValue& manifest_data,
65 const std::string& explicit_id,
66 std::string* error_message);
68 static scoped_refptr<ApplicationData> Create(const GURL& url,
69 std::string* error_message);
71 // Checks to see if the application has a valid ID.
72 static bool IsIDValid(const std::string& id);
74 Manifest::Type GetType() const;
76 // Returns an absolute url to a resource inside of an application. The
77 // |application_url| argument should be the url() from an Application object.
78 // The |relative_path| can be untrusted user input. The returned URL will
79 // either be invalid() or a child of |application_url|.
80 // NOTE: Static so that it can be used from multiple threads.
81 static GURL GetResourceURL(const GURL& application_url,
82 const std::string& relative_path);
83 GURL GetResourceURL(const std::string& relative_path) const {
84 return GetResourceURL(URL(), relative_path);
87 // Returns the base application url for a given |application_id|.
88 static GURL GetBaseURLFromApplicationId(const std::string& application_id);
90 // Get the manifest data associated with the key, or NULL if there is none.
91 // Can only be called after InitValue is finished.
92 ManifestData* GetManifestData(const std::string& key) const;
94 // Sets |data| to be associated with the key. Takes ownership of |data|.
95 // Can only be called before InitValue is finished. Not thread-safe;
96 // all SetManifestData calls should be on only one thread.
97 void SetManifestData(const std::string& key, ManifestData* data);
101 const base::FilePath& Path() const { return path_; }
102 void SetPath(const base::FilePath& path) { path_ = path; }
103 const GURL& URL() const { return application_url_; }
104 Manifest::SourceType GetSourceType() const;
105 const std::string& ID() const;
106 const base::Version* Version() const { return version_.get(); }
107 const std::string VersionString() const;
108 const std::string& Name() const { return name_; }
109 const std::string& NonLocalizedName() const { return non_localized_name_; }
110 const std::string& Description() const { return description_; }
111 int ManifestVersion() const { return manifest_version_; }
113 const Manifest* GetManifest() const {
114 return manifest_.get();
117 const base::Time& install_time() const { return install_time_; }
120 bool IsPlatformApp() const;
121 bool IsHostedApp() const;
123 // Permission related.
124 StoredPermission GetPermission(
125 const std::string& permission_name) const;
126 bool SetPermission(const std::string& permission_name,
127 StoredPermission perm);
128 void ClearPermissions();
129 PermissionSet GetManifestPermissions() const;
131 Package::Type GetPackageType() const { return package_type_; }
133 bool HasCSPDefined() const;
135 bool SetApplicationLocale(const std::string& locale, base::string16* error);
138 friend class base::RefCountedThreadSafe<ApplicationData>;
139 friend class ApplicationStorageImpl;
141 // Chooses the application ID for an application based on a variety of
142 // criteria. The chosen ID will be set in |manifest|.
143 static bool InitApplicationID(Manifest* manifest,
144 const base::FilePath& path,
145 const std::string& explicit_id,
146 base::string16* error);
148 ApplicationData(const base::FilePath& path,
149 scoped_ptr<Manifest> manifest);
150 virtual ~ApplicationData();
152 // Initialize the application from a parsed manifest.
153 bool Init(base::string16* error);
155 // The following are helpers for InitFromValue to load various features of the
156 // application from the manifest.
157 bool LoadName(base::string16* error);
158 bool LoadVersion(base::string16* error);
159 bool LoadDescription(base::string16* error);
160 bool LoadManifestVersion(base::string16* error);
162 // The application's human-readable name. Name is used for display purpose. It
163 // might be wrapped with unicode bidi control characters so that it is
164 // displayed correctly in RTL context.
165 // NOTE: Name is UTF-8 and may contain non-ascii characters.
168 // A non-localized version of the application's name. This is useful for
170 std::string non_localized_name_;
172 // The version of this application's manifest. We increase the manifest
173 // version when making breaking changes to the application system.
174 // Version 1 was the first manifest version (implied by a lack of a
175 // manifest_version attribute in the application's manifest). We initialize
176 // this member variable to 0 to distinguish the "uninitialized" case from
177 // the case when we know the manifest version actually is 1.
178 int manifest_version_;
180 // The absolute path to the directory the application is stored in.
181 base::FilePath path_;
183 // Any warnings that occurred when trying to create/parse the application.
184 std::vector<InstallWarning> install_warnings_;
187 std::set<std::string> events_;
189 // If it's true, means the data have been changed,
190 // and need to save in database.
193 // The base application url for the application.
194 GURL application_url_;
196 // The application's version.
197 scoped_ptr<base::Version> version_;
199 // An optional longer description of the application.
200 std::string description_;
202 // The manifest from which this application was created.
203 scoped_ptr<Manifest> manifest_;
205 // Stored parsed manifest data.
206 ManifestDataMap manifest_data_;
208 // Set to true at the end of InitValue when initialization is finished.
209 bool finished_parsing_manifest_;
211 base::Time install_time_;
213 // Ensures that any call to GetManifestData() prior to finishing
214 // initialization happens from the same thread (this can happen when certain
215 // parts of the initialization process need information from previous parts).
216 base::ThreadChecker thread_checker_;
218 // Application's persistent permissions.
219 StoredPermissionMap permission_map_;
221 // The package type, wgt or xpk.
222 Package::Type package_type_;
224 DISALLOW_COPY_AND_ASSIGN(ApplicationData);
227 } // namespace application
230 #endif // XWALK_APPLICATION_COMMON_APPLICATION_DATA_H_