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 // Checks to see if the application has a valid ID.
69 static bool IsIDValid(const std::string& id);
71 Manifest::Type GetType() const;
73 // Returns an absolute url to a resource inside of an application. The
74 // |application_url| argument should be the url() from an Application object.
75 // The |relative_path| can be untrusted user input. The returned URL will
76 // either be invalid() or a child of |application_url|.
77 // NOTE: Static so that it can be used from multiple threads.
78 static GURL GetResourceURL(const GURL& application_url,
79 const std::string& relative_path);
80 GURL GetResourceURL(const std::string& relative_path) const {
81 return GetResourceURL(URL(), relative_path);
84 // Returns the base application url for a given |application_id|.
85 static GURL GetBaseURLFromApplicationId(const std::string& application_id);
87 // Get the manifest data associated with the key, or NULL if there is none.
88 // Can only be called after InitValue is finished.
89 ManifestData* GetManifestData(const std::string& key) const;
91 // Sets |data| to be associated with the key. Takes ownership of |data|.
92 // Can only be called before InitValue is finished. Not thread-safe;
93 // all SetManifestData calls should be on only one thread.
94 void SetManifestData(const std::string& key, ManifestData* data);
98 const base::FilePath& Path() const { return path_; }
99 void SetPath(const base::FilePath& path) { path_ = path; }
100 const GURL& URL() const { return application_url_; }
101 Manifest::SourceType GetSourceType() const;
102 const std::string& ID() const;
103 const base::Version* Version() const { return version_.get(); }
104 const std::string VersionString() const;
105 const std::string& Name() const { return name_; }
106 const std::string& NonLocalizedName() const { return non_localized_name_; }
107 const std::string& Description() const { return description_; }
108 int ManifestVersion() const { return manifest_version_; }
110 const Manifest* GetManifest() const {
111 return manifest_.get();
115 void SetEvents(const std::set<std::string>& events);
116 const std::set<std::string>& GetEvents() const;
118 bool IsDirty() const { return is_dirty_; }
120 const base::Time& install_time() const { return install_time_; }
123 bool IsPlatformApp() const;
124 bool IsHostedApp() const;
126 // Permission related.
127 StoredPermission GetPermission(
128 std::string& permission_name) const;
129 bool SetPermission(const std::string& permission_name,
130 StoredPermission perm);
131 void ClearPermissions();
132 PermissionSet GetManifestPermissions() const;
134 bool HasMainDocument() const;
135 Manifest::PackageType GetPackageType() const;
137 #if defined(OS_TIZEN)
138 bool HasCSPDefined() const;
141 bool SetApplicationLocale(const std::string& locale, base::string16* error);
144 friend class base::RefCountedThreadSafe<ApplicationData>;
145 friend class ApplicationStorageImpl;
147 // Chooses the application ID for an application based on a variety of
148 // criteria. The chosen ID will be set in |manifest|.
149 static bool InitApplicationID(Manifest* manifest,
150 const base::FilePath& path,
151 const std::string& explicit_id,
152 base::string16* error);
154 ApplicationData(const base::FilePath& path,
155 scoped_ptr<Manifest> manifest);
156 virtual ~ApplicationData();
158 // Initialize the application from a parsed manifest.
159 bool Init(base::string16* error);
161 // The following are helpers for InitFromValue to load various features of the
162 // application from the manifest.
163 bool LoadName(base::string16* error);
164 bool LoadVersion(base::string16* error);
165 bool LoadDescription(base::string16* error);
166 bool LoadManifestVersion(base::string16* error);
168 // The application's human-readable name. Name is used for display purpose. It
169 // might be wrapped with unicode bidi control characters so that it is
170 // displayed correctly in RTL context.
171 // NOTE: Name is UTF-8 and may contain non-ascii characters.
174 // A non-localized version of the application's name. This is useful for
176 std::string non_localized_name_;
178 // The version of this application's manifest. We increase the manifest
179 // version when making breaking changes to the application system.
180 // Version 1 was the first manifest version (implied by a lack of a
181 // manifest_version attribute in the application's manifest). We initialize
182 // this member variable to 0 to distinguish the "uninitialized" case from
183 // the case when we know the manifest version actually is 1.
184 int manifest_version_;
186 // The absolute path to the directory the application is stored in.
187 base::FilePath path_;
189 // Any warnings that occurred when trying to create/parse the application.
190 std::vector<InstallWarning> install_warnings_;
193 std::set<std::string> events_;
195 // If it's true, means the data have been changed,
196 // and need to save in database.
199 // The base application url for the application.
200 GURL application_url_;
202 // The application's version.
203 scoped_ptr<base::Version> version_;
205 // An optional longer description of the application.
206 std::string description_;
208 // The manifest from which this application was created.
209 scoped_ptr<Manifest> manifest_;
211 // Stored parsed manifest data.
212 ManifestDataMap manifest_data_;
214 // Set to true at the end of InitValue when initialization is finished.
215 bool finished_parsing_manifest_;
217 base::Time install_time_;
219 // Ensures that any call to GetManifestData() prior to finishing
220 // initialization happens from the same thread (this can happen when certain
221 // parts of the initialization process need information from previous parts).
222 base::ThreadChecker thread_checker_;
224 // Application's persistent permissions.
225 StoredPermissionMap permission_map_;
227 DISALLOW_COPY_AND_ASSIGN(ApplicationData);
230 } // namespace application
233 #endif // XWALK_APPLICATION_COMMON_APPLICATION_DATA_H_