1 // Copyright 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 "webkit/browser/fileapi/file_system_operation_runner.h"
8 #include "base/message_loop/message_loop_proxy.h"
9 #include "base/stl_util.h"
10 #include "net/url_request/url_request_context.h"
11 #include "webkit/browser/blob/blob_url_request_job_factory.h"
12 #include "webkit/browser/fileapi/file_observers.h"
13 #include "webkit/browser/fileapi/file_stream_writer.h"
14 #include "webkit/browser/fileapi/file_system_context.h"
15 #include "webkit/browser/fileapi/file_system_operation.h"
16 #include "webkit/browser/fileapi/file_writer_delegate.h"
17 #include "webkit/common/blob/shareable_file_reference.h"
21 typedef FileSystemOperationRunner::OperationID OperationID;
23 class FileSystemOperationRunner::BeginOperationScoper
24 : public base::SupportsWeakPtr<
25 FileSystemOperationRunner::BeginOperationScoper> {
27 BeginOperationScoper() {}
29 DISALLOW_COPY_AND_ASSIGN(BeginOperationScoper);
32 FileSystemOperationRunner::OperationHandle::OperationHandle() {}
33 FileSystemOperationRunner::OperationHandle::~OperationHandle() {}
35 FileSystemOperationRunner::~FileSystemOperationRunner() {
38 void FileSystemOperationRunner::Shutdown() {
42 OperationID FileSystemOperationRunner::CreateFile(
43 const FileSystemURL& url,
45 const StatusCallback& callback) {
46 base::PlatformFileError error = base::PLATFORM_FILE_OK;
47 FileSystemOperation* operation =
48 file_system_context_->CreateFileSystemOperation(url, &error);
50 BeginOperationScoper scope;
51 OperationHandle handle = BeginOperation(operation, scope.AsWeakPtr());
53 DidFinish(handle, callback, error);
56 PrepareForWrite(handle.id, url);
57 operation->CreateFile(
59 base::Bind(&FileSystemOperationRunner::DidFinish, AsWeakPtr(),
64 OperationID FileSystemOperationRunner::CreateDirectory(
65 const FileSystemURL& url,
68 const StatusCallback& callback) {
69 base::PlatformFileError error = base::PLATFORM_FILE_OK;
70 FileSystemOperation* operation =
71 file_system_context_->CreateFileSystemOperation(url, &error);
72 BeginOperationScoper scope;
73 OperationHandle handle = BeginOperation(operation, scope.AsWeakPtr());
75 DidFinish(handle, callback, error);
78 PrepareForWrite(handle.id, url);
79 operation->CreateDirectory(
80 url, exclusive, recursive,
81 base::Bind(&FileSystemOperationRunner::DidFinish, AsWeakPtr(),
86 OperationID FileSystemOperationRunner::Copy(
87 const FileSystemURL& src_url,
88 const FileSystemURL& dest_url,
89 CopyOrMoveOption option,
90 const CopyProgressCallback& progress_callback,
91 const StatusCallback& callback) {
92 base::PlatformFileError error = base::PLATFORM_FILE_OK;
93 FileSystemOperation* operation =
94 file_system_context_->CreateFileSystemOperation(dest_url, &error);
95 BeginOperationScoper scope;
96 OperationHandle handle = BeginOperation(operation, scope.AsWeakPtr());
98 DidFinish(handle, callback, error);
101 PrepareForWrite(handle.id, dest_url);
102 PrepareForRead(handle.id, src_url);
104 src_url, dest_url, option,
105 progress_callback.is_null() ?
106 CopyProgressCallback() :
107 base::Bind(&FileSystemOperationRunner::OnCopyProgress, AsWeakPtr(),
108 handle, progress_callback),
109 base::Bind(&FileSystemOperationRunner::DidFinish, AsWeakPtr(),
114 OperationID FileSystemOperationRunner::Move(
115 const FileSystemURL& src_url,
116 const FileSystemURL& dest_url,
117 CopyOrMoveOption option,
118 const StatusCallback& callback) {
119 base::PlatformFileError error = base::PLATFORM_FILE_OK;
120 FileSystemOperation* operation =
121 file_system_context_->CreateFileSystemOperation(dest_url, &error);
122 BeginOperationScoper scope;
123 OperationHandle handle = BeginOperation(operation, scope.AsWeakPtr());
125 DidFinish(handle, callback, error);
128 PrepareForWrite(handle.id, dest_url);
129 PrepareForWrite(handle.id, src_url);
131 src_url, dest_url, option,
132 base::Bind(&FileSystemOperationRunner::DidFinish, AsWeakPtr(),
137 OperationID FileSystemOperationRunner::DirectoryExists(
138 const FileSystemURL& url,
139 const StatusCallback& callback) {
140 base::PlatformFileError error = base::PLATFORM_FILE_OK;
141 FileSystemOperation* operation =
142 file_system_context_->CreateFileSystemOperation(url, &error);
143 BeginOperationScoper scope;
144 OperationHandle handle = BeginOperation(operation, scope.AsWeakPtr());
146 DidFinish(handle, callback, error);
149 PrepareForRead(handle.id, url);
150 operation->DirectoryExists(
152 base::Bind(&FileSystemOperationRunner::DidFinish, AsWeakPtr(),
157 OperationID FileSystemOperationRunner::FileExists(
158 const FileSystemURL& url,
159 const StatusCallback& callback) {
160 base::PlatformFileError error = base::PLATFORM_FILE_OK;
161 FileSystemOperation* operation =
162 file_system_context_->CreateFileSystemOperation(url, &error);
163 BeginOperationScoper scope;
164 OperationHandle handle = BeginOperation(operation, scope.AsWeakPtr());
166 DidFinish(handle, callback, error);
169 PrepareForRead(handle.id, url);
170 operation->FileExists(
172 base::Bind(&FileSystemOperationRunner::DidFinish, AsWeakPtr(),
177 OperationID FileSystemOperationRunner::GetMetadata(
178 const FileSystemURL& url,
179 const GetMetadataCallback& callback) {
180 base::PlatformFileError error = base::PLATFORM_FILE_OK;
181 FileSystemOperation* operation =
182 file_system_context_->CreateFileSystemOperation(url, &error);
183 BeginOperationScoper scope;
184 OperationHandle handle = BeginOperation(operation, scope.AsWeakPtr());
186 DidGetMetadata(handle, callback, error, base::PlatformFileInfo());
189 PrepareForRead(handle.id, url);
190 operation->GetMetadata(
192 base::Bind(&FileSystemOperationRunner::DidGetMetadata, AsWeakPtr(),
197 OperationID FileSystemOperationRunner::ReadDirectory(
198 const FileSystemURL& url,
199 const ReadDirectoryCallback& callback) {
200 base::PlatformFileError error = base::PLATFORM_FILE_OK;
201 FileSystemOperation* operation =
202 file_system_context_->CreateFileSystemOperation(url, &error);
203 BeginOperationScoper scope;
204 OperationHandle handle = BeginOperation(operation, scope.AsWeakPtr());
206 DidReadDirectory(handle, callback, error, std::vector<DirectoryEntry>(),
210 PrepareForRead(handle.id, url);
211 operation->ReadDirectory(
213 base::Bind(&FileSystemOperationRunner::DidReadDirectory, AsWeakPtr(),
218 OperationID FileSystemOperationRunner::Remove(
219 const FileSystemURL& url, bool recursive,
220 const StatusCallback& callback) {
221 base::PlatformFileError error = base::PLATFORM_FILE_OK;
222 FileSystemOperation* operation =
223 file_system_context_->CreateFileSystemOperation(url, &error);
224 BeginOperationScoper scope;
225 OperationHandle handle = BeginOperation(operation, scope.AsWeakPtr());
227 DidFinish(handle, callback, error);
230 PrepareForWrite(handle.id, url);
233 base::Bind(&FileSystemOperationRunner::DidFinish, AsWeakPtr(),
238 OperationID FileSystemOperationRunner::Write(
239 const net::URLRequestContext* url_request_context,
240 const FileSystemURL& url,
241 scoped_ptr<webkit_blob::BlobDataHandle> blob,
243 const WriteCallback& callback) {
244 base::PlatformFileError error = base::PLATFORM_FILE_OK;
245 FileSystemOperation* operation =
246 file_system_context_->CreateFileSystemOperation(url, &error);
248 BeginOperationScoper scope;
249 OperationHandle handle = BeginOperation(operation, scope.AsWeakPtr());
251 DidWrite(handle, callback, error, 0, true);
255 scoped_ptr<FileStreamWriter> writer(
256 file_system_context_->CreateFileStreamWriter(url, offset));
258 // Write is not supported.
259 DidWrite(handle, callback, base::PLATFORM_FILE_ERROR_SECURITY, 0, true);
263 scoped_ptr<FileWriterDelegate> writer_delegate(
264 new FileWriterDelegate(writer.Pass()));
266 scoped_ptr<net::URLRequest> blob_request(
267 webkit_blob::BlobProtocolHandler::CreateBlobRequest(
270 writer_delegate.get()));
272 PrepareForWrite(handle.id, url);
274 url, writer_delegate.Pass(), blob_request.Pass(),
275 base::Bind(&FileSystemOperationRunner::DidWrite, AsWeakPtr(),
280 OperationID FileSystemOperationRunner::Truncate(
281 const FileSystemURL& url, int64 length,
282 const StatusCallback& callback) {
283 base::PlatformFileError error = base::PLATFORM_FILE_OK;
284 FileSystemOperation* operation =
285 file_system_context_->CreateFileSystemOperation(url, &error);
286 BeginOperationScoper scope;
287 OperationHandle handle = BeginOperation(operation, scope.AsWeakPtr());
289 DidFinish(handle, callback, error);
292 PrepareForWrite(handle.id, url);
295 base::Bind(&FileSystemOperationRunner::DidFinish, AsWeakPtr(),
300 void FileSystemOperationRunner::Cancel(
302 const StatusCallback& callback) {
303 if (ContainsKey(finished_operations_, id)) {
304 DCHECK(!ContainsKey(stray_cancel_callbacks_, id));
305 stray_cancel_callbacks_[id] = callback;
308 FileSystemOperation* operation = operations_.Lookup(id);
310 // There is no operation with |id|.
311 callback.Run(base::PLATFORM_FILE_ERROR_INVALID_OPERATION);
314 operation->Cancel(callback);
317 OperationID FileSystemOperationRunner::TouchFile(
318 const FileSystemURL& url,
319 const base::Time& last_access_time,
320 const base::Time& last_modified_time,
321 const StatusCallback& callback) {
322 base::PlatformFileError error = base::PLATFORM_FILE_OK;
323 FileSystemOperation* operation =
324 file_system_context_->CreateFileSystemOperation(url, &error);
325 BeginOperationScoper scope;
326 OperationHandle handle = BeginOperation(operation, scope.AsWeakPtr());
328 DidFinish(handle, callback, error);
331 PrepareForWrite(handle.id, url);
332 operation->TouchFile(
333 url, last_access_time, last_modified_time,
334 base::Bind(&FileSystemOperationRunner::DidFinish, AsWeakPtr(),
339 OperationID FileSystemOperationRunner::OpenFile(
340 const FileSystemURL& url,
342 base::ProcessHandle peer_handle,
343 const OpenFileCallback& callback) {
344 base::PlatformFileError error = base::PLATFORM_FILE_OK;
345 FileSystemOperation* operation =
346 file_system_context_->CreateFileSystemOperation(url, &error);
347 BeginOperationScoper scope;
348 OperationHandle handle = BeginOperation(operation, scope.AsWeakPtr());
350 DidOpenFile(handle, callback, error, base::kInvalidPlatformFileValue,
351 base::Closure(), base::ProcessHandle());
355 (base::PLATFORM_FILE_CREATE | base::PLATFORM_FILE_OPEN_ALWAYS |
356 base::PLATFORM_FILE_CREATE_ALWAYS | base::PLATFORM_FILE_OPEN_TRUNCATED |
357 base::PLATFORM_FILE_WRITE | base::PLATFORM_FILE_EXCLUSIVE_WRITE |
358 base::PLATFORM_FILE_DELETE_ON_CLOSE |
359 base::PLATFORM_FILE_WRITE_ATTRIBUTES)) {
360 PrepareForWrite(handle.id, url);
362 PrepareForRead(handle.id, url);
365 url, file_flags, peer_handle,
366 base::Bind(&FileSystemOperationRunner::DidOpenFile, AsWeakPtr(),
371 OperationID FileSystemOperationRunner::CreateSnapshotFile(
372 const FileSystemURL& url,
373 const SnapshotFileCallback& callback) {
374 base::PlatformFileError error = base::PLATFORM_FILE_OK;
375 FileSystemOperation* operation =
376 file_system_context_->CreateFileSystemOperation(url, &error);
377 BeginOperationScoper scope;
378 OperationHandle handle = BeginOperation(operation, scope.AsWeakPtr());
380 DidCreateSnapshot(handle, callback, error, base::PlatformFileInfo(),
381 base::FilePath(), NULL);
384 PrepareForRead(handle.id, url);
385 operation->CreateSnapshotFile(
387 base::Bind(&FileSystemOperationRunner::DidCreateSnapshot, AsWeakPtr(),
392 OperationID FileSystemOperationRunner::CopyInForeignFile(
393 const base::FilePath& src_local_disk_path,
394 const FileSystemURL& dest_url,
395 const StatusCallback& callback) {
396 base::PlatformFileError error = base::PLATFORM_FILE_OK;
397 FileSystemOperation* operation =
398 file_system_context_->CreateFileSystemOperation(dest_url, &error);
399 BeginOperationScoper scope;
400 OperationHandle handle = BeginOperation(operation, scope.AsWeakPtr());
402 DidFinish(handle, callback, error);
405 operation->CopyInForeignFile(
406 src_local_disk_path, dest_url,
407 base::Bind(&FileSystemOperationRunner::DidFinish, AsWeakPtr(),
412 OperationID FileSystemOperationRunner::RemoveFile(
413 const FileSystemURL& url,
414 const StatusCallback& callback) {
415 base::PlatformFileError error = base::PLATFORM_FILE_OK;
416 FileSystemOperation* operation =
417 file_system_context_->CreateFileSystemOperation(url, &error);
418 BeginOperationScoper scope;
419 OperationHandle handle = BeginOperation(operation, scope.AsWeakPtr());
421 DidFinish(handle, callback, error);
424 operation->RemoveFile(
426 base::Bind(&FileSystemOperationRunner::DidFinish, AsWeakPtr(),
431 OperationID FileSystemOperationRunner::RemoveDirectory(
432 const FileSystemURL& url,
433 const StatusCallback& callback) {
434 base::PlatformFileError error = base::PLATFORM_FILE_OK;
435 FileSystemOperation* operation =
436 file_system_context_->CreateFileSystemOperation(url, &error);
437 BeginOperationScoper scope;
438 OperationHandle handle = BeginOperation(operation, scope.AsWeakPtr());
440 DidFinish(handle, callback, error);
443 operation->RemoveDirectory(
445 base::Bind(&FileSystemOperationRunner::DidFinish, AsWeakPtr(),
450 OperationID FileSystemOperationRunner::CopyFileLocal(
451 const FileSystemURL& src_url,
452 const FileSystemURL& dest_url,
453 CopyOrMoveOption option,
454 const CopyFileProgressCallback& progress_callback,
455 const StatusCallback& callback) {
456 base::PlatformFileError error = base::PLATFORM_FILE_OK;
457 FileSystemOperation* operation =
458 file_system_context_->CreateFileSystemOperation(src_url, &error);
459 BeginOperationScoper scope;
460 OperationHandle handle = BeginOperation(operation, scope.AsWeakPtr());
462 DidFinish(handle, callback, error);
465 operation->CopyFileLocal(
466 src_url, dest_url, option, progress_callback,
467 base::Bind(&FileSystemOperationRunner::DidFinish, AsWeakPtr(),
472 OperationID FileSystemOperationRunner::MoveFileLocal(
473 const FileSystemURL& src_url,
474 const FileSystemURL& dest_url,
475 CopyOrMoveOption option,
476 const StatusCallback& callback) {
477 base::PlatformFileError error = base::PLATFORM_FILE_OK;
478 FileSystemOperation* operation =
479 file_system_context_->CreateFileSystemOperation(src_url, &error);
480 BeginOperationScoper scope;
481 OperationHandle handle = BeginOperation(operation, scope.AsWeakPtr());
483 DidFinish(handle, callback, error);
486 operation->MoveFileLocal(
487 src_url, dest_url, option,
488 base::Bind(&FileSystemOperationRunner::DidFinish, AsWeakPtr(),
493 base::PlatformFileError FileSystemOperationRunner::SyncGetPlatformPath(
494 const FileSystemURL& url,
495 base::FilePath* platform_path) {
496 base::PlatformFileError error = base::PLATFORM_FILE_OK;
497 scoped_ptr<FileSystemOperation> operation(
498 file_system_context_->CreateFileSystemOperation(url, &error));
499 if (!operation.get())
501 return operation->SyncGetPlatformPath(url, platform_path);
504 FileSystemOperationRunner::FileSystemOperationRunner(
505 FileSystemContext* file_system_context)
506 : file_system_context_(file_system_context) {}
508 void FileSystemOperationRunner::DidFinish(
509 const OperationHandle& handle,
510 const StatusCallback& callback,
511 base::PlatformFileError rv) {
513 finished_operations_.insert(handle.id);
514 base::MessageLoopProxy::current()->PostTask(
515 FROM_HERE, base::Bind(&FileSystemOperationRunner::DidFinish,
516 AsWeakPtr(), handle, callback, rv));
520 FinishOperation(handle.id);
523 void FileSystemOperationRunner::DidGetMetadata(
524 const OperationHandle& handle,
525 const GetMetadataCallback& callback,
526 base::PlatformFileError rv,
527 const base::PlatformFileInfo& file_info) {
529 finished_operations_.insert(handle.id);
530 base::MessageLoopProxy::current()->PostTask(
531 FROM_HERE, base::Bind(&FileSystemOperationRunner::DidGetMetadata,
532 AsWeakPtr(), handle, callback, rv, file_info));
535 callback.Run(rv, file_info);
536 FinishOperation(handle.id);
539 void FileSystemOperationRunner::DidReadDirectory(
540 const OperationHandle& handle,
541 const ReadDirectoryCallback& callback,
542 base::PlatformFileError rv,
543 const std::vector<DirectoryEntry>& entries,
546 finished_operations_.insert(handle.id);
547 base::MessageLoopProxy::current()->PostTask(
548 FROM_HERE, base::Bind(&FileSystemOperationRunner::DidReadDirectory,
549 AsWeakPtr(), handle, callback, rv,
553 callback.Run(rv, entries, has_more);
554 if (rv != base::PLATFORM_FILE_OK || !has_more)
555 FinishOperation(handle.id);
558 void FileSystemOperationRunner::DidWrite(
559 const OperationHandle& handle,
560 const WriteCallback& callback,
561 base::PlatformFileError rv,
565 finished_operations_.insert(handle.id);
566 base::MessageLoopProxy::current()->PostTask(
567 FROM_HERE, base::Bind(&FileSystemOperationRunner::DidWrite, AsWeakPtr(),
568 handle, callback, rv, bytes, complete));
571 callback.Run(rv, bytes, complete);
572 if (rv != base::PLATFORM_FILE_OK || complete)
573 FinishOperation(handle.id);
576 void FileSystemOperationRunner::DidOpenFile(
577 const OperationHandle& handle,
578 const OpenFileCallback& callback,
579 base::PlatformFileError rv,
580 base::PlatformFile file,
581 const base::Closure& on_close_callback,
582 base::ProcessHandle peer_handle) {
584 finished_operations_.insert(handle.id);
585 base::MessageLoopProxy::current()->PostTask(
586 FROM_HERE, base::Bind(&FileSystemOperationRunner::DidOpenFile,
587 AsWeakPtr(), handle, callback, rv, file,
588 on_close_callback, peer_handle));
591 callback.Run(rv, file, on_close_callback, peer_handle);
592 FinishOperation(handle.id);
595 void FileSystemOperationRunner::DidCreateSnapshot(
596 const OperationHandle& handle,
597 const SnapshotFileCallback& callback,
598 base::PlatformFileError rv,
599 const base::PlatformFileInfo& file_info,
600 const base::FilePath& platform_path,
601 const scoped_refptr<webkit_blob::ShareableFileReference>& file_ref) {
603 finished_operations_.insert(handle.id);
604 base::MessageLoopProxy::current()->PostTask(
605 FROM_HERE, base::Bind(&FileSystemOperationRunner::DidCreateSnapshot,
606 AsWeakPtr(), handle, callback, rv, file_info,
607 platform_path, file_ref));
610 callback.Run(rv, file_info, platform_path, file_ref);
611 FinishOperation(handle.id);
614 void FileSystemOperationRunner::OnCopyProgress(
615 const OperationHandle& handle,
616 const CopyProgressCallback& callback,
617 FileSystemOperation::CopyProgressType type,
618 const FileSystemURL& source_url,
619 const FileSystemURL& dest_url,
622 base::MessageLoopProxy::current()->PostTask(
623 FROM_HERE, base::Bind(
624 &FileSystemOperationRunner::OnCopyProgress,
625 AsWeakPtr(), handle, callback, type, source_url, dest_url, size));
628 callback.Run(type, source_url, dest_url, size);
631 void FileSystemOperationRunner::PrepareForWrite(OperationID id,
632 const FileSystemURL& url) {
633 if (file_system_context_->GetUpdateObservers(url.type())) {
634 file_system_context_->GetUpdateObservers(url.type())->Notify(
635 &FileUpdateObserver::OnStartUpdate, MakeTuple(url));
637 write_target_urls_[id].insert(url);
640 void FileSystemOperationRunner::PrepareForRead(OperationID id,
641 const FileSystemURL& url) {
642 if (file_system_context_->GetAccessObservers(url.type())) {
643 file_system_context_->GetAccessObservers(url.type())->Notify(
644 &FileAccessObserver::OnAccess, MakeTuple(url));
648 FileSystemOperationRunner::OperationHandle
649 FileSystemOperationRunner::BeginOperation(
650 FileSystemOperation* operation,
651 base::WeakPtr<BeginOperationScoper> scope) {
652 OperationHandle handle;
653 handle.id = operations_.Add(operation);
654 handle.scope = scope;
658 void FileSystemOperationRunner::FinishOperation(OperationID id) {
659 OperationToURLSet::iterator found = write_target_urls_.find(id);
660 if (found != write_target_urls_.end()) {
661 const FileSystemURLSet& urls = found->second;
662 for (FileSystemURLSet::const_iterator iter = urls.begin();
663 iter != urls.end(); ++iter) {
664 if (file_system_context_->GetUpdateObservers(iter->type())) {
665 file_system_context_->GetUpdateObservers(iter->type())->Notify(
666 &FileUpdateObserver::OnEndUpdate, MakeTuple(*iter));
669 write_target_urls_.erase(found);
672 // IDMap::Lookup fails if the operation is NULL, so we don't check
673 // operations_.Lookup(id) here.
675 operations_.Remove(id);
676 finished_operations_.erase(id);
678 // Dispatch stray cancel callback if exists.
679 std::map<OperationID, StatusCallback>::iterator found_cancel =
680 stray_cancel_callbacks_.find(id);
681 if (found_cancel != stray_cancel_callbacks_.end()) {
682 // This cancel has been requested after the operation has finished,
683 // so report that we failed to stop it.
684 found_cancel->second.Run(base::PLATFORM_FILE_ERROR_INVALID_OPERATION);
685 stray_cancel_callbacks_.erase(found_cancel);
689 } // namespace fileapi