1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
|
// Copyright 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef STORAGE_BROWSER_FILEAPI_SANDBOX_FILE_SYSTEM_BACKEND_DELEGATE_H_
#define STORAGE_BROWSER_FILEAPI_SANDBOX_FILE_SYSTEM_BACKEND_DELEGATE_H_
#include <map>
#include <set>
#include <string>
#include <utility>
#include "base/files/file_path.h"
#include "base/gtest_prod_util.h"
#include "base/memory/ref_counted.h"
#include "base/memory/scoped_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/threading/thread_checker.h"
#include "base/time/time.h"
#include "storage/browser/fileapi/file_system_backend.h"
#include "storage/browser/fileapi/file_system_options.h"
#include "storage/browser/fileapi/file_system_quota_util.h"
#include "storage/browser/fileapi/task_runner_bound_observer_list.h"
#include "storage/browser/storage_browser_export.h"
namespace base {
class SequencedTaskRunner;
}
namespace content {
class SandboxFileSystemBackendDelegateTest;
class SandboxFileSystemTestHelper;
}
namespace storage {
class QuotaManagerProxy;
class SpecialStoragePolicy;
}
namespace storage {
class FileStreamReader;
}
namespace storage {
class AsyncFileUtil;
class FileStreamWriter;
class FileSystemFileUtil;
class FileSystemOperationContext;
class FileSystemURL;
class FileSystemUsageCache;
class ObfuscatedFileUtil;
class QuotaReservationManager;
class SandboxFileSystemBackend;
class SandboxQuotaObserver;
// Delegate implementation of the some methods in Sandbox/SyncFileSystemBackend.
// An instance of this class is created and owned by FileSystemContext.
class STORAGE_EXPORT SandboxFileSystemBackendDelegate
: public FileSystemQuotaUtil {
public:
typedef FileSystemBackend::OpenFileSystemCallback OpenFileSystemCallback;
// The FileSystem directory name.
static const base::FilePath::CharType kFileSystemDirectory[];
// Origin enumerator interface.
// An instance of this interface is assumed to be called on the file thread.
class OriginEnumerator {
public:
virtual ~OriginEnumerator() {}
// Returns the next origin. Returns empty if there are no more origins.
virtual GURL Next() = 0;
// Returns the current origin's information.
virtual bool HasFileSystemType(FileSystemType type) const = 0;
};
// Returns the type directory name in sandbox directory for given |type|.
static std::string GetTypeString(FileSystemType type);
SandboxFileSystemBackendDelegate(
storage::QuotaManagerProxy* quota_manager_proxy,
base::SequencedTaskRunner* file_task_runner,
const base::FilePath& profile_path,
storage::SpecialStoragePolicy* special_storage_policy,
const FileSystemOptions& file_system_options);
~SandboxFileSystemBackendDelegate() override;
// Returns an origin enumerator of sandbox filesystem.
// This method can only be called on the file thread.
OriginEnumerator* CreateOriginEnumerator();
// Gets a base directory path of the sandboxed filesystem that is
// specified by |origin_url| and |type|.
// (The path is similar to the origin's root path but doesn't contain
// the 'unique' part.)
// Returns an empty path if the given type is invalid.
// This method can only be called on the file thread.
base::FilePath GetBaseDirectoryForOriginAndType(
const GURL& origin_url,
FileSystemType type,
bool create);
// FileSystemBackend helpers.
void OpenFileSystem(
const GURL& origin_url,
FileSystemType type,
OpenFileSystemMode mode,
const OpenFileSystemCallback& callback,
const GURL& root_url);
scoped_ptr<FileSystemOperationContext> CreateFileSystemOperationContext(
const FileSystemURL& url,
FileSystemContext* context,
base::File::Error* error_code) const;
scoped_ptr<storage::FileStreamReader> CreateFileStreamReader(
const FileSystemURL& url,
int64 offset,
const base::Time& expected_modification_time,
FileSystemContext* context) const;
scoped_ptr<FileStreamWriter> CreateFileStreamWriter(
const FileSystemURL& url,
int64 offset,
FileSystemContext* context,
FileSystemType type) const;
// FileSystemQuotaUtil overrides.
base::File::Error DeleteOriginDataOnFileTaskRunner(
FileSystemContext* context,
storage::QuotaManagerProxy* proxy,
const GURL& origin_url,
FileSystemType type) override;
void GetOriginsForTypeOnFileTaskRunner(FileSystemType type,
std::set<GURL>* origins) override;
void GetOriginsForHostOnFileTaskRunner(FileSystemType type,
const std::string& host,
std::set<GURL>* origins) override;
int64 GetOriginUsageOnFileTaskRunner(FileSystemContext* context,
const GURL& origin_url,
FileSystemType type) override;
scoped_refptr<QuotaReservation> CreateQuotaReservationOnFileTaskRunner(
const GURL& origin_url,
FileSystemType type) override;
// Adds an observer for the secified |type| of a file system, bound to
// |task_runner|.
virtual void AddFileUpdateObserver(FileSystemType type,
FileUpdateObserver* observer,
base::SequencedTaskRunner* task_runner);
virtual void AddFileChangeObserver(FileSystemType type,
FileChangeObserver* observer,
base::SequencedTaskRunner* task_runner);
virtual void AddFileAccessObserver(FileSystemType type,
FileAccessObserver* observer,
base::SequencedTaskRunner* task_runner);
// Returns observer lists for the specified |type| of a file system.
virtual const UpdateObserverList* GetUpdateObservers(
FileSystemType type) const;
virtual const ChangeObserverList* GetChangeObservers(
FileSystemType type) const;
virtual const AccessObserverList* GetAccessObservers(
FileSystemType type) const;
// Registers quota observer for file updates on filesystem of |type|.
void RegisterQuotaUpdateObserver(FileSystemType type);
void InvalidateUsageCache(const GURL& origin_url,
FileSystemType type);
void StickyInvalidateUsageCache(const GURL& origin_url,
FileSystemType type);
void CollectOpenFileSystemMetrics(base::File::Error error_code);
// Used for migrating from the general storage partition to an isolated
// storage partition
void CopyFileSystem(const GURL& origin_url,
FileSystemType type,
SandboxFileSystemBackendDelegate* destination);
base::SequencedTaskRunner* file_task_runner() {
return file_task_runner_.get();
}
AsyncFileUtil* file_util() { return sandbox_file_util_.get(); }
FileSystemUsageCache* usage_cache() { return file_system_usage_cache_.get(); }
SandboxQuotaObserver* quota_observer() { return quota_observer_.get(); }
storage::SpecialStoragePolicy* special_storage_policy() {
return special_storage_policy_.get();
}
const FileSystemOptions& file_system_options() const {
return file_system_options_;
}
FileSystemFileUtil* sync_file_util();
private:
friend class QuotaBackendImpl;
friend class SandboxQuotaObserver;
friend class content::SandboxFileSystemBackendDelegateTest;
friend class content::SandboxFileSystemTestHelper;
// Performs API-specific validity checks on the given path |url|.
// Returns true if access to |url| is valid in this filesystem.
bool IsAccessValid(const FileSystemURL& url) const;
// Returns true if the given |url|'s scheme is allowed to access
// filesystem.
bool IsAllowedScheme(const GURL& url) const;
// Returns a path to the usage cache file.
base::FilePath GetUsageCachePathForOriginAndType(
const GURL& origin_url,
FileSystemType type);
// Returns a path to the usage cache file (static version).
static base::FilePath GetUsageCachePathForOriginAndType(
ObfuscatedFileUtil* sandbox_file_util,
const GURL& origin_url,
FileSystemType type,
base::File::Error* error_out);
int64 RecalculateUsage(FileSystemContext* context,
const GURL& origin,
FileSystemType type);
ObfuscatedFileUtil* obfuscated_file_util();
scoped_refptr<base::SequencedTaskRunner> file_task_runner_;
scoped_ptr<AsyncFileUtil> sandbox_file_util_;
scoped_ptr<FileSystemUsageCache> file_system_usage_cache_;
scoped_ptr<SandboxQuotaObserver> quota_observer_;
scoped_ptr<QuotaReservationManager> quota_reservation_manager_;
scoped_refptr<storage::SpecialStoragePolicy> special_storage_policy_;
FileSystemOptions file_system_options_;
bool is_filesystem_opened_;
base::ThreadChecker io_thread_checker_;
// Accessed only on the file thread.
std::set<GURL> visited_origins_;
std::set<std::pair<GURL, FileSystemType> > sticky_dirty_origins_;
std::map<FileSystemType, UpdateObserverList> update_observers_;
std::map<FileSystemType, ChangeObserverList> change_observers_;
std::map<FileSystemType, AccessObserverList> access_observers_;
base::Time next_release_time_for_open_filesystem_stat_;
base::WeakPtrFactory<SandboxFileSystemBackendDelegate> weak_factory_;
DISALLOW_COPY_AND_ASSIGN(SandboxFileSystemBackendDelegate);
};
} // namespace storage
#endif // STORAGE_BROWSER_FILEAPI_SANDBOX_FILE_SYSTEM_BACKEND_DELEGATE_H_
|