Time-based removal of temporary file systems via BrowsingDataRemover

chrome/browser/browsing_data_remover.h

 // Copyright (c) 2011 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 CHROME_BROWSER_BROWSING_DATA_REMOVER_H_
 #define CHROME_BROWSER_BROWSING_DATA_REMOVER_H_
 #pragma once
 
 #include <vector>
 
 #include "base/memory/ref_counted.h"
 #include "base/observer_list.h"
 #include "base/synchronization/waitable_event_watcher.h"
 #include "base/time.h"
 #include "content/browser/appcache/chrome_appcache_service.h"
 #include "content/browser/cancelable_request.h"
 #include "content/common/notification_observer.h"
 #include "content/common/notification_registrar.h"
+#include "webkit/quota/quota_types.h"
 
 class ExtensionSpecialStoragePolicy;
 class IOThread;
 class PluginDataRemover;
 class Profile;
 
 namespace disk_cache {
 class Backend;
 }
 
 namespace net {
 class URLRequestContextGetter;
 }
 
 namespace webkit_database {
 class DatabaseTracker;
 }
 
+namespace quota {
+class QuotaManager;
+}
+
 // BrowsingDataRemover is responsible for removing data related to browsing:
 // visits in url database, downloads, cookies ...
 
 class BrowsingDataRemover : public NotificationObserver,
                             public base::WaitableEventWatcher::Delegate {
  public:
   // Time period ranges available when doing browsing data removals.
   enum TimePeriod {
     LAST_HOUR = 0,
     LAST_DAY,
@@ skipping 89 matching lines @@
 
   // Callback when the cache has been deleted. Invokes NotifyAndDeleteIfDone.
   void ClearedCache();
 
   // Invoked on the IO thread to delete from the cache.
   void ClearCacheOnIOThread();
 
   // Performs the actual work to delete the cache.
   void DoClearCache(int rv);
 
+  // Callback responding to deletion of a single quota managed origin's
+  // temporary data.
+  void OnTemporaryQuotaManagedOriginDeletion(quota::QuotaStatusCode);
+
+  // Callback to respond to QuotaManager::GetOriginsModifiedSince, which is the
+  // core of 'ClearQuotaManagedDataOnIOThread'.
+  void OnGotTemporaryQuotaManagedOrigins(const std::set<GURL>&);
+
+  // Callback responding to deletion of a single quota managed origin's
+  // persistent data
+  void OnPersistentQuotaManagedOriginDeletion(quota::QuotaStatusCode);
+
+  // Callback to respond to QuotaManager::GetOriginsModifiedSince, which is the
+  // core of `ClearQuotaManagedDataOnIOThread`
+  void OnGotPersistentQuotaManagedOrigins(const std::set<GURL>&);
+
+  // Called to check whether all temporary and persistent origin data that
+  // should be deleted has been deleted. If everything's good to go, invokes
+  // NotifyAndDeleteIfDone on the UI thread.
+  void CheckTemporaryQuotaManagedDataDeletionStatus();
+  void CheckPersistentQuotaManagedDataDeletionStatus();
+
+  // Invoked on the IO thread to delete all storage types managed by the quota
+  // system: AppCache, Databases, FileSystems.
+  void ClearQuotaManagedDataOnIOThread();
+
   // Callback when HTML5 databases have been deleted. Invokes
   // NotifyAndDeleteIfDone.
   void OnClearedDatabases(int rv);

[michaeln, 2011/07/26 22:40:19]

can this be deleted too?

[Mike West, 2011/07/27 12:49:18]

I was under the impression that this handled IndexedDB as well, but Jochen
assures me that it doesn't. Throwing it out the window.

 
   // Invoked on the FILE thread to delete HTML5 databases.
   void ClearDatabasesOnFILEThread();

[michaeln, 2011/07/26 22:40:19]

ditto

[Mike West, 2011/07/27 12:49:18]

Done.

 
   // Callback when HTML5 file systems have been cleared.  Invokes
   // NotifyAndDeleteIfDone.
   void OnClearedFileSystems();

[michaeln, 2011/07/26 22:40:19]

ditto

[Mike West, 2011/07/27 12:49:18]

Done.

 
   // Invoked on the FILE thread to delete HTML5 file systems.
   void ClearFileSystemsOnFILEThread();

[michaeln, 2011/07/26 22:40:19]

ditto

[Mike West, 2011/07/27 12:49:18]

Done.

 
-  // Callback when the appcache has been cleared. Invokes
-  // NotifyAndDeleteIfDone.
-  void OnClearedAppCache();
-
-  // Invoked on the IO thread to delete from the AppCache.
-  void ClearAppCacheOnIOThread();
-
-  // Lower level helpers.
-  void OnGotAppCacheInfo(int rv);
-  void OnAppCacheDeleted(int rv);
-
   // Callback when Gears data has been deleted. Invokes NotifyAndDeleteIfDone.
   void OnClearedGearsData();

[Mike West, 2011/07/27 12:49:18]

Throwing these away too, as we've removed Gears.

 
   // Invoked on the FILE thread to delete old Gears data.
   void ClearGearsDataOnFILEThread(const FilePath& profile_dir);
 
   // Calculate the begin time for the deletion range specified by |time_period|.
   base::Time CalculateBeginDeleteTime(TimePeriod time_period);
 
   // Returns true if we're all done.
   bool all_done() {
     return registrar_.IsEmpty() && !waiting_for_clear_cache_ &&
            !waiting_for_clear_history_ &&
+           !waiting_for_clear_temporary_quota_managed_data_ &&
+           !waiting_for_clear_persistent_quota_managed_data_ &&
            !waiting_for_clear_networking_history_ &&
-           !waiting_for_clear_databases_ && !waiting_for_clear_appcache_ &&
            !waiting_for_clear_lso_data_ && !waiting_for_clear_gears_data_ &&
-           !waiting_for_clear_file_systems_;
+           !waiting_for_clear_databases_;
   }
 
   NotificationRegistrar registrar_;
 
   // Profile we're to remove from.
   Profile* profile_;
 
+  // the QuotaManager is owned by the profile; we can use a raw pointer here,
+  // and rely on the profile to destroy the object whenever it's reasonable.
+  quota::QuotaManager* quota_manager_;
+
   // 'Protected' origins are not subject to data removal.
   scoped_refptr<ExtensionSpecialStoragePolicy> special_storage_policy_;
 
   // Start time to delete from.
   const base::Time delete_begin_;
 
   // End time to delete to.
   const base::Time delete_end_;
 
   // True if Remove has been invoked.
   static bool removing_;
 
   // Reference to database tracker held while deleting databases.
   scoped_refptr<webkit_database::DatabaseTracker> database_tracker_;

[michaeln, 2011/07/26 22:40:19]

ditto

[Mike West, 2011/07/27 12:49:18]

Done.

 
   net::CompletionCallbackImpl<BrowsingDataRemover> database_cleared_callback_;

[michaeln, 2011/07/26 22:40:19]

ditto

[Mike West, 2011/07/27 12:49:18]

Done.

   net::CompletionCallbackImpl<BrowsingDataRemover> cache_callback_;
 
-  // Used to clear the appcache.
-  scoped_refptr<ChromeAppCacheService> appcache_service_;
-  net::CompletionCallbackImpl<BrowsingDataRemover> appcache_got_info_callback_;
-  net::CompletionCallbackImpl<BrowsingDataRemover> appcache_deleted_callback_;
-  scoped_refptr<appcache::AppCacheInfoCollection> appcache_info_;
-  int appcaches_to_be_deleted_count_;
-
   // Used to delete data from the HTTP caches.
   CacheState next_cache_state_;
   disk_cache::Backend* cache_;
 
-  // Used to delete data from HTTP cache and appcache.
+  // Used to delete data from HTTP cache.
   scoped_refptr<net::URLRequestContextGetter> main_context_getter_;
   scoped_refptr<net::URLRequestContextGetter> media_context_getter_;
 
   // Used to delete plugin data.
   scoped_refptr<PluginDataRemover> plugin_data_remover_;
   base::WaitableEventWatcher watcher_;
 
   // True if we're waiting for various data to be deleted.
   bool waiting_for_clear_databases_;

[michaeln, 2011/07/26 22:40:19]

ditto

[Mike West, 2011/07/27 12:49:18]

Done.

   bool waiting_for_clear_history_;
+  bool waiting_for_clear_temporary_quota_managed_data_;
+  bool waiting_for_clear_persistent_quota_managed_data_;

[michaeln, 2011/07/26 22:40:19]

see comments in the .cc file, maybe consolidate these two members into one...
waiting_for_clear_quota_manager_;

[Mike West, 2011/07/27 12:49:18]

I've done this, but I don't really see a way around flags for the
temp/persistent queues. See the CC file, as well as the three new tests I've
added. In short, I can't tell the difference between having no origins of a
certain type, and having no origins period.

   bool waiting_for_clear_networking_history_;
   bool waiting_for_clear_cache_;
-  bool waiting_for_clear_appcache_;
   bool waiting_for_clear_lso_data_;
   bool waiting_for_clear_gears_data_;
-  bool waiting_for_clear_file_systems_;
+
+  // Tracking how many origins need to be deleted.
+  int temporary_quota_origins_to_delete_count_;
+  int persistent_quota_origins_to_delete_count_;

[michaeln, 2011/07/26 22:40:19]

ditto consolidation

[Mike West, 2011/07/27 12:49:18]

ditto explanation. :)

 
   ObserverList<Observer> observer_list_;
 
   // Used if we need to clear history.
   CancelableRequestConsumer request_consumer_;
 
   DISALLOW_COPY_AND_ASSIGN(BrowsingDataRemover);
 };
 
 #endif  // CHROME_BROWSER_BROWSING_DATA_REMOVER_H_