Teaching BrowsingDataRemover how to delete application data.

chrome/browser/browsing_data_remover.h

 // 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.
 
 #ifndef CHROME_BROWSER_BROWSING_DATA_REMOVER_H_
 #define CHROME_BROWSER_BROWSING_DATA_REMOVER_H_
 #pragma once
 
 #include <set>
 
 #include "base/gtest_prod_util.h"
 #include "base/memory/ref_counted.h"
 #include "base/message_loop_helpers.h"
 #include "base/observer_list.h"
 #include "base/synchronization/waitable_event_watcher.h"
 #include "base/time.h"
 #include "chrome/browser/cancelable_request.h"
 #include "chrome/browser/pepper_flash_settings_manager.h"
 #include "chrome/browser/prefs/pref_member.h"
+#include "content/public/browser/dom_storage_context.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
 #include "googleurl/src/gurl.h"
+#include "webkit/dom_storage/dom_storage_context.h"
 #include "webkit/quota/quota_types.h"
 
 class ExtensionSpecialStoragePolicy;
 class IOThread;
 class Profile;
 
 namespace content {
-class DOMStorageContext;
 class PluginDataRemover;
 }
 
 namespace disk_cache {
 class Backend;
 }
 
 namespace net {
 class URLRequestContextGetter;
 }
@@ skipping 74 matching lines @@
   // Creates a BrowsingDataRemover to remove browser data from the specified
   // profile in the specified time range. Use Remove to initiate the removal.
   BrowsingDataRemover(Profile* profile, base::Time delete_begin,
                       base::Time delete_end);
 
   // Creates a BrowsingDataRemover to remove browser data from the specified
   // profile in the specified time range.
   BrowsingDataRemover(Profile* profile, TimePeriod time_period,
                       base::Time delete_end);
 
-  // Removes the specified items related to browsing for all origins.
-  void Remove(int remove_mask);
+  // Removes the specified items related to browsing for all origins that match
+  // the provided |origin_set_mask| (see BrowsingDataHelper::OriginSetMask).
+  void Remove(int remove_mask, int origin_set_mask);
 
   void AddObserver(Observer* observer);
   void RemoveObserver(Observer* observer);
 
   // Called when history deletion is done.
   void OnHistoryDeletionDone();
 
   // Quota managed data uses a different bitmask for types than
   // BrowsingDataRemover uses. This method generates that mask.
   static int GenerateQuotaClientMask(int remove_mask);
@@ skipping 42 matching lines @@
   // WaitableEventWatcher implementation.
   // Called when plug-in data has been cleared. Invokes NotifyAndDeleteIfDone.
   virtual void OnWaitableEventSignaled(
       base::WaitableEvent* waitable_event) OVERRIDE;
 
   // PepperFlashSettingsManager::Client implementation.
   virtual void OnDeauthorizeContentLicensesCompleted(uint32 request_id,
                                                      bool success) OVERRIDE;
 
   // Removes the specified items related to browsing for a specific host. If the
-  // provided |origin| is empty, data is removed for all origins. If
-  // |remove_protected_origins| is true, then data is removed even if the origin
-  // is otherwise protected (e.g. as an installed application).
+  // provided |origin| is empty, data is removed for all origins. The
+  // |origin_set_mask| parameter defines the set of origins from which data
+  // should be removed (protected, unprotected, or both).
   void RemoveImpl(int remove_mask,
                   const GURL& origin,
-                  bool remove_protected_origins);
+                  int origin_set_mask);
 
   // If we're not waiting on anything, notifies observers and deletes this
   // object.
   void NotifyAndDeleteIfDone();
 
   // Callback when the network history has been deleted. Invokes
   // NotifyAndDeleteIfDone.
   void ClearedNetworkHistory();
 
   // Invoked on the IO thread to clear the HostCache, speculative data about
   // subresources on visited sites, and initial navigation history.
   void ClearNetworkingHistory(IOThread* io_thread);
 
   // 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);
 
+  // Invoked on the UI thread to delete local storage.
+  void ClearLocalStorageOnUIThread();
+
+  // Callback to deal with the list gathered in ClearLocalStorageOnUIThread.
+  void OnGotLocalStorageUsageInfo(
+      const std::vector<dom_storage::DomStorageContext::UsageInfo>& infos);
+
+  // Callback on deletion of local storage data. Invokes NotifyAndDeleteIfDone.
+  void OnLocalStorageCleared();
+
   // Invoked on the IO thread to delete all storage types managed by the quota
   // system: AppCache, Databases, FileSystems.
   void ClearQuotaManagedDataOnIOThread();
 
   // Callback to respond to QuotaManager::GetOriginsModifiedSince, which is the
   // core of 'ClearQuotaManagedDataOnIOThread'.
   void OnGotQuotaManagedOrigins(const std::set<GURL>& origins,
                                 quota::StorageType type);
 
   // Callback responding to deletion of a single quota managed origin's
@@ skipping 24 matching lines @@
   void OnClearedServerBoundCerts();
 
   // 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_cookies_count_&&
            !waiting_for_clear_history_ &&
+           !waiting_for_clear_local_storage_ &&
            !waiting_for_clear_networking_history_ &&
            !waiting_for_clear_server_bound_certs_ &&
            !waiting_for_clear_plugin_data_ &&
            !waiting_for_clear_quota_managed_data_ &&
            !waiting_for_clear_content_licenses_;
   }
 
   // Setter for removing_; DCHECKs that we can only start removing if we're not
   // already removing, and vice-versa.
   static void set_removing(bool removing);
 
   content::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_;
 
+  // The DOMStorageContext is owned by the profile; we'll store a raw pointer.
+  content::DOMStorageContext* dom_storage_context_;
+
   // '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.
@@ skipping 13 matching lines @@
   // Used to deauthorize content licenses for Pepper Flash.
   scoped_ptr<PepperFlashSettingsManager> pepper_flash_settings_manager_;
   uint32 deauthorize_content_licenses_request_id_;
 
   // True if we're waiting for various data to be deleted.
   // These may only be accessed from UI thread in order to avoid races!
   bool waiting_for_clear_cache_;
   // Non-zero if waiting for cookies to be cleared.
   int waiting_for_clear_cookies_count_;
   bool waiting_for_clear_history_;
+  bool waiting_for_clear_local_storage_;
   bool waiting_for_clear_networking_history_;
   bool waiting_for_clear_server_bound_certs_;
   bool waiting_for_clear_plugin_data_;
   bool waiting_for_clear_quota_managed_data_;
   bool waiting_for_clear_content_licenses_;
 
   // Tracking how many origins need to be deleted, and whether we're finished
   // gathering origins.
   int quota_managed_origins_to_delete_count_;
   int quota_managed_storage_types_to_delete_count_;
 
   // The removal mask for the current removal operation.
   int remove_mask_;
 
   // The origin for the current removal operation.
   GURL remove_origin_;
 
-  // Should data for protected origins be removed?
-  bool remove_protected_;
+  // From which types of origins should we remove data?
+  int origin_set_mask_;
 
   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_