// Copyright (c) 2012 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. #include "content/browser/storage_partition_impl.h" #include "base/sequenced_task_runner.h" #include "base/strings/utf_string_conversions.h" #include "content/browser/browser_main_loop.h" #include "content/browser/fileapi/browser_file_system_helper.h" #include "content/browser/gpu/shader_disk_cache.h" #include "content/common/dom_storage/dom_storage_types.h" #include "content/public/browser/browser_context.h" #include "content/public/browser/browser_thread.h" #include "content/public/browser/dom_storage_context.h" #include "content/public/browser/indexed_db_context.h" #include "content/public/browser/local_storage_usage_info.h" #include "content/public/browser/session_storage_usage_info.h" #include "net/base/completion_callback.h" #include "net/base/net_errors.h" #include "net/cookies/cookie_monster.h" #include "net/url_request/url_request_context.h" #include "net/url_request/url_request_context_getter.h" #include "webkit/browser/database/database_tracker.h" #include "webkit/browser/quota/quota_manager.h" namespace content { namespace { int GenerateQuotaClientMask(uint32 remove_mask) { int quota_client_mask = 0; if (remove_mask & StoragePartition::REMOVE_DATA_MASK_FILE_SYSTEMS) quota_client_mask |= quota::QuotaClient::kFileSystem; if (remove_mask & StoragePartition::REMOVE_DATA_MASK_WEBSQL) quota_client_mask |= quota::QuotaClient::kDatabase; if (remove_mask & StoragePartition::REMOVE_DATA_MASK_APPCACHE) quota_client_mask |= quota::QuotaClient::kAppcache; if (remove_mask & StoragePartition::REMOVE_DATA_MASK_INDEXEDDB) quota_client_mask |= quota::QuotaClient::kIndexedDatabase; return quota_client_mask; } void OnClearedCookies(const base::Closure& callback, int num_deleted) { // The final callback needs to happen from UI thread. if (!BrowserThread::CurrentlyOn(BrowserThread::UI)) { BrowserThread::PostTask( BrowserThread::UI, FROM_HERE, base::Bind(&OnClearedCookies, callback, num_deleted)); return; } callback.Run(); } void ClearCookiesOnIOThread( const scoped_refptr& rq_context, const base::Time begin, const base::Time end, const GURL& remove_origin, const base::Closure& callback) { DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO)); net::CookieStore* cookie_store = rq_context-> GetURLRequestContext()->cookie_store(); if (remove_origin.is_empty()) { cookie_store->GetCookieMonster()->DeleteAllCreatedBetweenAsync( begin, end, base::Bind(&OnClearedCookies, callback)); } else { cookie_store->GetCookieMonster()->DeleteAllCreatedBetweenForHostAsync( begin, end, remove_origin, base::Bind(&OnClearedCookies, callback)); } } void OnQuotaManagedOriginDeleted(const GURL& origin, quota::StorageType type, size_t* origins_to_delete_count, const base::Closure& callback, quota::QuotaStatusCode status) { DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO)); DCHECK_GT(*origins_to_delete_count, 0u); if (status != quota::kQuotaStatusOk) { DLOG(ERROR) << "Couldn't remove data of type " << type << " for origin " << origin << ". Status: " << status; } (*origins_to_delete_count)--; if (*origins_to_delete_count == 0) { delete origins_to_delete_count; callback.Run(); } } void ClearQuotaManagedOriginsOnIOThread(quota::QuotaManager* quota_manager, uint32 remove_mask, const base::Closure& callback, const std::set& origins, quota::StorageType quota_storage_type) { // The QuotaManager manages all storage other than cookies, LocalStorage, // and SessionStorage. This loop wipes out most HTML5 storage for the given // origins. DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO)); if (!origins.size()) { // No origins to clear. callback.Run(); return; } std::set::const_iterator origin; size_t* origins_to_delete_count = new size_t(origins.size()); for (std::set::const_iterator origin = origins.begin(); origin != origins.end(); ++origin) { quota_manager->DeleteOriginData( *origin, quota_storage_type, GenerateQuotaClientMask(remove_mask), base::Bind(&OnQuotaManagedOriginDeleted, origin->GetOrigin(), quota_storage_type, origins_to_delete_count, callback)); } } void ClearedShaderCache(const base::Closure& callback) { if (!BrowserThread::CurrentlyOn(BrowserThread::UI)) { BrowserThread::PostTask( BrowserThread::UI, FROM_HERE, base::Bind(&ClearedShaderCache, callback)); return; } callback.Run(); } void ClearShaderCacheOnIOThread(const base::FilePath& path, const base::Time begin, const base::Time end, const base::Closure& callback) { DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO)); ShaderCacheFactory::GetInstance()->ClearByPath( path, begin, end, base::Bind(&ClearedShaderCache, callback)); } void OnLocalStorageUsageInfo( const scoped_refptr& dom_storage_context, const base::Time delete_begin, const base::Time delete_end, const base::Closure& callback, const std::vector& infos) { DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI)); for (size_t i = 0; i < infos.size(); ++i) { if (infos[i].last_modified >= delete_begin && infos[i].last_modified <= delete_end) { dom_storage_context->DeleteLocalStorage(infos[i].origin); } } callback.Run(); } void OnSessionStorageUsageInfo( const scoped_refptr& dom_storage_context, const base::Closure& callback, const std::vector& infos) { DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI)); for (size_t i = 0; i < infos.size(); ++i) dom_storage_context->DeleteSessionStorage(infos[i]); callback.Run(); } void ClearLocalStorageOnUIThread( const scoped_refptr& dom_storage_context, const GURL& remove_origin, const base::Time begin, const base::Time end, const base::Closure& callback) { DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI)); if (!remove_origin.is_empty()) { dom_storage_context->DeleteLocalStorage(remove_origin); callback.Run(); return; } dom_storage_context->GetLocalStorageUsage( base::Bind(&OnLocalStorageUsageInfo, dom_storage_context, begin, end, callback)); } void ClearSessionStorageOnUIThread( const scoped_refptr& dom_storage_context, const base::Closure& callback) { DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI)); dom_storage_context->GetSessionStorageUsage( base::Bind(&OnSessionStorageUsageInfo, dom_storage_context, callback)); } } // namespace // Helper for deleting quota managed data from a partition. // // Most of the operations in this class are done on IO thread. struct StoragePartitionImpl::QuotaManagedDataDeletionHelper { QuotaManagedDataDeletionHelper(const base::Closure& callback) : callback(callback), task_count(0) { } void IncrementTaskCountOnIO(); void DecrementTaskCountOnIO(); void ClearDataOnIOThread( const scoped_refptr& quota_manager, const base::Time begin, uint32 remove_mask, uint32 quota_storage_remove_mask, const GURL& remove_origin); // Accessed on IO thread. const base::Closure callback; // Accessed on IO thread. int task_count; }; // Helper for deleting all sorts of data from a partition, keeps track of // deletion status. // // StoragePartitionImpl creates an instance of this class to keep track of // data deletion progress. Deletion requires deleting multiple bits of data // (e.g. cookies, local storage, session storage etc.) and hopping between UI // and IO thread. An instance of this class is created in the beginning of // deletion process (StoragePartitionImpl::ClearDataImpl) and the instance is // forwarded and updated on each (sub) deletion's callback. The instance is // finally destroyed when deletion completes (and |callback| is invoked). struct StoragePartitionImpl::DataDeletionHelper { DataDeletionHelper(const base::Closure& callback) : callback(callback), task_count(0) { } void IncrementTaskCountOnUI(); void DecrementTaskCountOnUI(); void ClearDataOnUIThread(uint32 remove_mask, uint32 quota_storage_remove_mask, const GURL& remove_origin, const base::FilePath& path, net::URLRequestContextGetter* rq_context, DOMStorageContextWrapper* dom_storage_context, quota::QuotaManager* quota_manager, WebRTCIdentityStore* webrtc_identity_store, const base::Time begin, const base::Time end); // Accessed on UI thread. const base::Closure callback; // Accessed on UI thread. int task_count; }; void ClearQuotaManagedDataOnIOThread( const scoped_refptr& quota_manager, const base::Time begin, uint32 remove_mask, uint32 quota_storage_remove_mask, const GURL& remove_origin, const base::Closure& callback) { DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO)); StoragePartitionImpl::QuotaManagedDataDeletionHelper* helper = new StoragePartitionImpl::QuotaManagedDataDeletionHelper(callback); helper->ClearDataOnIOThread(quota_manager, begin, remove_mask, quota_storage_remove_mask, remove_origin); } StoragePartitionImpl::StoragePartitionImpl( const base::FilePath& partition_path, quota::QuotaManager* quota_manager, ChromeAppCacheService* appcache_service, fileapi::FileSystemContext* filesystem_context, webkit_database::DatabaseTracker* database_tracker, DOMStorageContextWrapper* dom_storage_context, IndexedDBContextImpl* indexed_db_context, WebRTCIdentityStore* webrtc_identity_store) : partition_path_(partition_path), quota_manager_(quota_manager), appcache_service_(appcache_service), filesystem_context_(filesystem_context), database_tracker_(database_tracker), dom_storage_context_(dom_storage_context), indexed_db_context_(indexed_db_context), webrtc_identity_store_(webrtc_identity_store) {} StoragePartitionImpl::~StoragePartitionImpl() { // These message loop checks are just to avoid leaks in unittests. if (GetDatabaseTracker() && BrowserThread::IsMessageLoopValid(BrowserThread::FILE)) { BrowserThread::PostTask( BrowserThread::FILE, FROM_HERE, base::Bind(&webkit_database::DatabaseTracker::Shutdown, GetDatabaseTracker())); } if (GetFileSystemContext()) GetFileSystemContext()->Shutdown(); if (GetDOMStorageContext()) GetDOMStorageContext()->Shutdown(); } // TODO(ajwong): Break the direct dependency on |context|. We only // need 3 pieces of info from it. StoragePartitionImpl* StoragePartitionImpl::Create( BrowserContext* context, bool in_memory, const base::FilePath& partition_path) { // Ensure that these methods are called on the UI thread, except for // unittests where a UI thread might not have been created. DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI) || !BrowserThread::IsMessageLoopValid(BrowserThread::UI)); // All of the clients have to be created and registered with the // QuotaManager prior to the QuotaManger being used. We do them // all together here prior to handing out a reference to anything // that utilizes the QuotaManager. scoped_refptr quota_manager = new quota::QuotaManager( in_memory, partition_path, BrowserThread::GetMessageLoopProxyForThread(BrowserThread::IO).get(), BrowserThread::GetMessageLoopProxyForThread(BrowserThread::DB).get(), context->GetSpecialStoragePolicy()); // Each consumer is responsible for registering its QuotaClient during // its construction. scoped_refptr filesystem_context = CreateFileSystemContext(context, partition_path, in_memory, quota_manager->proxy()); scoped_refptr database_tracker = new webkit_database::DatabaseTracker( partition_path, in_memory, context->GetSpecialStoragePolicy(), quota_manager->proxy(), BrowserThread::GetMessageLoopProxyForThread(BrowserThread::FILE) .get()); base::FilePath path = in_memory ? base::FilePath() : partition_path; scoped_refptr dom_storage_context = new DOMStorageContextWrapper(path, context->GetSpecialStoragePolicy()); // BrowserMainLoop may not be initialized in unit tests. Tests will // need to inject their own task runner into the IndexedDBContext. base::SequencedTaskRunner* idb_task_runner = BrowserThread::CurrentlyOn(BrowserThread::UI) && BrowserMainLoop::GetInstance() ? BrowserMainLoop::GetInstance()->indexed_db_thread() ->message_loop_proxy().get() : NULL; scoped_refptr indexed_db_context = new IndexedDBContextImpl(path, context->GetSpecialStoragePolicy(), quota_manager->proxy(), idb_task_runner); scoped_refptr appcache_service = new ChromeAppCacheService(quota_manager->proxy()); scoped_refptr webrtc_identity_store( new WebRTCIdentityStore(path, context->GetSpecialStoragePolicy())); return new StoragePartitionImpl(partition_path, quota_manager.get(), appcache_service.get(), filesystem_context.get(), database_tracker.get(), dom_storage_context.get(), indexed_db_context.get(), webrtc_identity_store.get()); } base::FilePath StoragePartitionImpl::GetPath() { return partition_path_; } net::URLRequestContextGetter* StoragePartitionImpl::GetURLRequestContext() { return url_request_context_.get(); } net::URLRequestContextGetter* StoragePartitionImpl::GetMediaURLRequestContext() { return media_url_request_context_.get(); } quota::QuotaManager* StoragePartitionImpl::GetQuotaManager() { return quota_manager_.get(); } ChromeAppCacheService* StoragePartitionImpl::GetAppCacheService() { return appcache_service_.get(); } fileapi::FileSystemContext* StoragePartitionImpl::GetFileSystemContext() { return filesystem_context_.get(); } webkit_database::DatabaseTracker* StoragePartitionImpl::GetDatabaseTracker() { return database_tracker_.get(); } DOMStorageContextWrapper* StoragePartitionImpl::GetDOMStorageContext() { return dom_storage_context_.get(); } IndexedDBContextImpl* StoragePartitionImpl::GetIndexedDBContext() { return indexed_db_context_.get(); } void StoragePartitionImpl::ClearDataImpl( uint32 remove_mask, uint32 quota_storage_remove_mask, const GURL& remove_origin, net::URLRequestContextGetter* rq_context, const base::Time begin, const base::Time end, const base::Closure& callback) { DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI)); DataDeletionHelper* helper = new DataDeletionHelper(callback); // |helper| deletes itself when done in // DataDeletionHelper::DecrementTaskCountOnUI(). helper->ClearDataOnUIThread( remove_mask, quota_storage_remove_mask, remove_origin, GetPath(), rq_context, dom_storage_context_, quota_manager_, webrtc_identity_store_, begin, end); } void StoragePartitionImpl:: QuotaManagedDataDeletionHelper::IncrementTaskCountOnIO() { DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO)); ++task_count; } void StoragePartitionImpl:: QuotaManagedDataDeletionHelper::DecrementTaskCountOnIO() { DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO)); DCHECK_GT(task_count, 0); --task_count; if (task_count) return; callback.Run(); delete this; } void StoragePartitionImpl::QuotaManagedDataDeletionHelper::ClearDataOnIOThread( const scoped_refptr& quota_manager, const base::Time begin, uint32 remove_mask, uint32 quota_storage_remove_mask, const GURL& remove_origin) { std::set origins; if (!remove_origin.is_empty()) origins.insert(remove_origin); IncrementTaskCountOnIO(); base::Closure decrement_callback = base::Bind( &QuotaManagedDataDeletionHelper::DecrementTaskCountOnIO, base::Unretained(this)); if (quota_storage_remove_mask & QUOTA_MANAGED_STORAGE_MASK_PERSISTENT) { IncrementTaskCountOnIO(); if (origins.empty()) { // Remove for all origins. // Ask the QuotaManager for all origins with temporary quota modified // within the user-specified timeframe, and deal with the resulting set in // ClearQuotaManagedOriginsOnIOThread(). quota_manager->GetOriginsModifiedSince( quota::kStorageTypePersistent, begin, base::Bind(&ClearQuotaManagedOriginsOnIOThread, quota_manager, remove_mask, decrement_callback)); } else { ClearQuotaManagedOriginsOnIOThread( quota_manager, remove_mask, decrement_callback, origins, quota::kStorageTypePersistent); } } // Do the same for temporary quota. if (quota_storage_remove_mask & QUOTA_MANAGED_STORAGE_MASK_TEMPORARY) { IncrementTaskCountOnIO(); if (origins.empty()) { // Remove for all origins. quota_manager->GetOriginsModifiedSince( quota::kStorageTypeTemporary, begin, base::Bind(&ClearQuotaManagedOriginsOnIOThread, quota_manager, remove_mask, decrement_callback)); } else { ClearQuotaManagedOriginsOnIOThread( quota_manager, remove_mask, decrement_callback, origins, quota::kStorageTypeTemporary); } } // Do the same for syncable quota. if (quota_storage_remove_mask & QUOTA_MANAGED_STORAGE_MASK_SYNCABLE) { IncrementTaskCountOnIO(); if (origins.empty()) { // Remove for all origins. quota_manager->GetOriginsModifiedSince( quota::kStorageTypeSyncable, begin, base::Bind(&ClearQuotaManagedOriginsOnIOThread, quota_manager, remove_mask, decrement_callback)); } else { ClearQuotaManagedOriginsOnIOThread( quota_manager, remove_mask, decrement_callback, origins, quota::kStorageTypeSyncable); } } DecrementTaskCountOnIO(); } void StoragePartitionImpl::DataDeletionHelper::IncrementTaskCountOnUI() { DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI)); ++task_count; } void StoragePartitionImpl::DataDeletionHelper::DecrementTaskCountOnUI() { if (!BrowserThread::CurrentlyOn(BrowserThread::UI)) { BrowserThread::PostTask( BrowserThread::UI, FROM_HERE, base::Bind(&DataDeletionHelper::DecrementTaskCountOnUI, base::Unretained(this))); return; } DCHECK_GT(task_count, 0); --task_count; if (!task_count) { callback.Run(); delete this; } } void StoragePartitionImpl::DataDeletionHelper::ClearDataOnUIThread( uint32 remove_mask, uint32 quota_storage_remove_mask, const GURL& remove_origin, const base::FilePath& path, net::URLRequestContextGetter* rq_context, DOMStorageContextWrapper* dom_storage_context, quota::QuotaManager* quota_manager, WebRTCIdentityStore* webrtc_identity_store, const base::Time begin, const base::Time end) { DCHECK_NE(remove_mask, 0u); DCHECK(!callback.is_null()); IncrementTaskCountOnUI(); base::Closure decrement_callback = base::Bind( &DataDeletionHelper::DecrementTaskCountOnUI, base::Unretained(this)); if (remove_mask & REMOVE_DATA_MASK_COOKIES) { // Handle the cookies. IncrementTaskCountOnUI(); BrowserThread::PostTask( BrowserThread::IO, FROM_HERE, base::Bind(&ClearCookiesOnIOThread, make_scoped_refptr(rq_context), begin, end, remove_origin, decrement_callback)); } if (remove_mask & REMOVE_DATA_MASK_INDEXEDDB || remove_mask & REMOVE_DATA_MASK_WEBSQL || remove_mask & REMOVE_DATA_MASK_APPCACHE || remove_mask & REMOVE_DATA_MASK_FILE_SYSTEMS) { IncrementTaskCountOnUI(); BrowserThread::PostTask( BrowserThread::IO, FROM_HERE, base::Bind(&ClearQuotaManagedDataOnIOThread, make_scoped_refptr(quota_manager), begin, remove_mask, quota_storage_remove_mask, remove_origin, decrement_callback)); } if (remove_mask & REMOVE_DATA_MASK_LOCAL_STORAGE) { IncrementTaskCountOnUI(); ClearLocalStorageOnUIThread( make_scoped_refptr(dom_storage_context), remove_origin, begin, end, decrement_callback); // ClearDataImpl cannot clear session storage data when a particular origin // is specified. Therefore we ignore clearing session storage in this case. // TODO(lazyboy): Fix. if (remove_origin.is_empty()) { IncrementTaskCountOnUI(); ClearSessionStorageOnUIThread( make_scoped_refptr(dom_storage_context), decrement_callback); } } if (remove_mask & REMOVE_DATA_MASK_SHADER_CACHE) { IncrementTaskCountOnUI(); BrowserThread::PostTask( BrowserThread::IO, FROM_HERE, base::Bind(&ClearShaderCacheOnIOThread, path, begin, end, decrement_callback)); } if (remove_mask & REMOVE_DATA_MASK_WEBRTC_IDENTITY) { IncrementTaskCountOnUI(); BrowserThread::PostTask( BrowserThread::IO, FROM_HERE, base::Bind(&WebRTCIdentityStore::DeleteBetween, webrtc_identity_store, begin, end, decrement_callback)); } DecrementTaskCountOnUI(); } void StoragePartitionImpl::ClearDataForOrigin( uint32 remove_mask, uint32 quota_storage_remove_mask, const GURL& storage_origin, net::URLRequestContextGetter* request_context_getter) { DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI)); ClearDataImpl(remove_mask, quota_storage_remove_mask, storage_origin, request_context_getter, base::Time(), base::Time::Max(), base::Bind(&base::DoNothing)); } void StoragePartitionImpl::ClearDataForUnboundedRange( uint32 remove_mask, uint32 quota_storage_remove_mask) { ClearDataImpl(remove_mask, quota_storage_remove_mask, GURL(), GetURLRequestContext(), base::Time(), base::Time::Max(), base::Bind(&base::DoNothing)); } void StoragePartitionImpl::ClearDataForRange(uint32 remove_mask, uint32 quota_storage_remove_mask, const base::Time& begin, const base::Time& end, const base::Closure& callback) { ClearDataImpl(remove_mask, quota_storage_remove_mask, GURL(), GetURLRequestContext(), begin, end, callback); } WebRTCIdentityStore* StoragePartitionImpl::GetWebRTCIdentityStore() { return webrtc_identity_store_.get(); } void StoragePartitionImpl::SetURLRequestContext( net::URLRequestContextGetter* url_request_context) { url_request_context_ = url_request_context; } void StoragePartitionImpl::SetMediaURLRequestContext( net::URLRequestContextGetter* media_url_request_context) { media_url_request_context_ = media_url_request_context; } } // namespace content