Teaching BrowsingDataRemover how to delete application data.

chrome/browser/browsing_data_remover.cc

 // 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 "chrome/browser/browsing_data_remover.h"
 
 #include <map>
 #include <set>
 
 #include "base/bind.h"
@@ skipping 43 matching lines @@
 #include "net/base/server_bound_cert_service.h"
 #include "net/base/server_bound_cert_store.h"
 #include "net/base/transport_security_state.h"
 #include "net/cookies/cookie_store.h"
 #include "net/disk_cache/disk_cache.h"
 #include "net/http/http_cache.h"
 #include "net/url_request/url_request_context.h"
 #include "net/url_request/url_request_context_getter.h"
 #include "webkit/quota/quota_manager.h"
 #include "webkit/quota/quota_types.h"
+#include "webkit/quota/special_storage_policy.h"
+#include "third_party/WebKit/Source/WebKit/chromium/public/platform/WebCString.h"

[Bernhard Bauer, 2012/05/31 15:57:31]

Nit: Alphabetize

[Mike West, 2012/06/01 13:35:17]

Done.

+#include "third_party/WebKit/Source/WebKit/chromium/public/platform/WebString.h"
+#include "third_party/WebKit/Source/WebKit/chromium/public/WebSecurityOrigin.h"
+#include "webkit/glue/webkit_glue.h"
 
 using content::BrowserContext;
 using content::BrowserThread;
 using content::DOMStorageContext;
 using content::DownloadManager;
 using content::UserMetricsAction;
 
 bool BrowsingDataRemover::removing_ = false;
 
 BrowsingDataRemover::NotificationDetails::NotificationDetails()
     : removal_begin(base::Time()),
       removal_mask(-1) {
 }
 
 BrowsingDataRemover::NotificationDetails::NotificationDetails(
     const BrowsingDataRemover::NotificationDetails& details)
     : removal_begin(details.removal_begin),
       removal_mask(details.removal_mask) {
 }
 
 BrowsingDataRemover::NotificationDetails::NotificationDetails(
     base::Time removal_begin,
     int removal_mask)
     : removal_begin(removal_begin),
       removal_mask(removal_mask) {
 }
 
 BrowsingDataRemover::NotificationDetails::~NotificationDetails() {}
 
 BrowsingDataRemover::BrowsingDataRemover(Profile* profile,

[Bernhard Bauer, 2012/05/31 15:57:31]

If you feel like some yak-shaving (and you do have a *lot* of free time,
right?), we should have only one constructor, and two methods that set the time
interval to delete data.

[Mike West, 2012/06/01 13:35:17]

http://crbug.com/130732

                                          base::Time delete_begin,
                                          base::Time delete_end)
     : profile_(profile),
       quota_manager_(NULL),
+      dom_storage_context_(NULL),
       special_storage_policy_(profile->GetExtensionSpecialStoragePolicy()),
       delete_begin_(delete_begin),
       delete_end_(delete_end),
       next_cache_state_(STATE_NONE),
       cache_(NULL),
       main_context_getter_(profile->GetRequestContext()),
       media_context_getter_(profile->GetRequestContextForMedia()),
       deauthorize_content_licenses_request_id_(0),
       waiting_for_clear_cache_(false),
       waiting_for_clear_cookies_count_(0),
       waiting_for_clear_history_(false),
+      waiting_for_clear_local_storage_(false),
       waiting_for_clear_networking_history_(false),
       waiting_for_clear_server_bound_certs_(false),
       waiting_for_clear_plugin_data_(false),
       waiting_for_clear_quota_managed_data_(false),
       waiting_for_clear_content_licenses_(false),
       remove_mask_(0),
       remove_origin_(GURL()),
-      remove_protected_(false) {
+      origin_set_mask_(0) {
   DCHECK(profile);
 }
 
 BrowsingDataRemover::BrowsingDataRemover(Profile* profile,
                                          TimePeriod time_period,
                                          base::Time delete_end)
     : profile_(profile),
       quota_manager_(NULL),
+      dom_storage_context_(NULL),
       special_storage_policy_(profile->GetExtensionSpecialStoragePolicy()),
       delete_begin_(CalculateBeginDeleteTime(time_period)),
       delete_end_(delete_end),
       next_cache_state_(STATE_NONE),
       cache_(NULL),
       main_context_getter_(profile->GetRequestContext()),
       media_context_getter_(profile->GetRequestContextForMedia()),
       deauthorize_content_licenses_request_id_(0),
       waiting_for_clear_cache_(false),
       waiting_for_clear_cookies_count_(0),
       waiting_for_clear_history_(false),
+      waiting_for_clear_local_storage_(false),
       waiting_for_clear_networking_history_(false),
       waiting_for_clear_server_bound_certs_(false),
       waiting_for_clear_plugin_data_(false),
       waiting_for_clear_quota_managed_data_(false),
       waiting_for_clear_content_licenses_(false),
       remove_mask_(0),
       remove_origin_(GURL()),
-      remove_protected_(false) {
+      origin_set_mask_(0) {
   DCHECK(profile);
 }
 
 BrowsingDataRemover::~BrowsingDataRemover() {
   DCHECK(all_done());
 }
 
 // Static.
 void BrowsingDataRemover::set_removing(bool removing) {
   DCHECK(removing_ != removing);
   removing_ = removing;
 }
 
 // Static.
 int BrowsingDataRemover::GenerateQuotaClientMask(int remove_mask) {
   int quota_client_mask = 0;
   if (remove_mask & BrowsingDataRemover::REMOVE_FILE_SYSTEMS)
     quota_client_mask |= quota::QuotaClient::kFileSystem;
   if (remove_mask & BrowsingDataRemover::REMOVE_WEBSQL)
     quota_client_mask |= quota::QuotaClient::kDatabase;
   if (remove_mask & BrowsingDataRemover::REMOVE_APPCACHE)
     quota_client_mask |= quota::QuotaClient::kAppcache;
   if (remove_mask & BrowsingDataRemover::REMOVE_INDEXEDDB)
     quota_client_mask |= quota::QuotaClient::kIndexedDatabase;
 
   return quota_client_mask;
 }
 
-void BrowsingDataRemover::Remove(int remove_mask) {
-  RemoveImpl(remove_mask, GURL(), false);
+void BrowsingDataRemover::Remove(int remove_mask, int origin_set_mask) {
+  RemoveImpl(remove_mask, GURL(), origin_set_mask);
 }
 
 void BrowsingDataRemover::RemoveImpl(int remove_mask,
                                      const GURL& origin,
-                                     bool remove_protected_origins) {
+                                     int origin_set_mask) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   set_removing(true);
   remove_mask_ = remove_mask;
   remove_origin_ = origin;
-  remove_protected_ = remove_protected_origins;
+  origin_set_mask_ = origin_set_mask;
 
   if (remove_mask & REMOVE_HISTORY) {
     HistoryService* history_service =
         profile_->GetHistoryService(Profile::EXPLICIT_ACCESS);
     if (history_service) {
       std::set<GURL> restrict_urls;
       if (!remove_origin_.is_empty())
         restrict_urls.insert(remove_origin_);
       content::RecordAction(UserMetricsAction("ClearBrowsingData_History"));
       waiting_for_clear_history_ = true;
@@ skipping 110 matching lines @@
     if (rq_context) {
       waiting_for_clear_server_bound_certs_ = true;
       BrowserThread::PostTask(
           BrowserThread::IO, FROM_HERE,
           base::Bind(&BrowsingDataRemover::ClearServerBoundCertsOnIOThread,
                      base::Unretained(this), base::Unretained(rq_context)));
     }
   }
 
   if (remove_mask & REMOVE_LOCAL_STORAGE) {
-    BrowserContext::GetDOMStorageContext(profile_)->DeleteDataModifiedSince(
-        delete_begin_);
+    waiting_for_clear_local_storage_ = true;
+    if (!dom_storage_context_)
+      dom_storage_context_ = BrowserContext::GetDOMStorageContext(profile_);
+    BrowserThread::PostTask(
+        BrowserThread::IO, FROM_HERE,
+        base::Bind(&BrowsingDataRemover::ClearLocalStorageOnIOThread,

[michaeln, 2012/06/01 03:13:40]

Also, its fine to call the DSC methods on the UI thread.

+                   base::Unretained(this)));
   }
 
   if (remove_mask & REMOVE_INDEXEDDB || remove_mask & REMOVE_WEBSQL ||
       remove_mask & REMOVE_APPCACHE || remove_mask & REMOVE_FILE_SYSTEMS) {
     if (!quota_manager_)
       quota_manager_ = content::BrowserContext::GetQuotaManager(profile_);
     waiting_for_clear_quota_managed_data_ = true;
     BrowserThread::PostTask(
         BrowserThread::IO, FROM_HERE,
         base::Bind(&BrowsingDataRemover::ClearQuotaManagedDataOnIOThread,
@@ skipping 263 matching lines @@
       }
       default: {
         NOTREACHED() << "bad state";
         next_cache_state_ = STATE_NONE;  // Stop looping.
         break;
       }
     }
   }
 }
 
+void BrowsingDataRemover::ClearLocalStorageOnIOThread() {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
+  DCHECK(waiting_for_clear_local_storage_);
+
+  dom_storage_context_->GetAllStorageFiles(

[michaeln, 2012/05/31 22:49:07]

The return type for this method pains me... a list of files whose names are
encoded just so. Please see the comments in public/browser/dom_storage_context.h
about fixing up this api which would also resolve the blocking io on the io
thread thing brought up by bernhard.

wdyt?

+      base::Bind(&BrowsingDataRemover::OnGotLocalStorageFiles,
+                 base::Unretained(this)));
+}
+
+void BrowsingDataRemover::OnGotLocalStorageFiles(
+    const std::vector<FilePath>& files) {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
+  DCHECK(waiting_for_clear_local_storage_);
+
+  for (size_t i = 0; i < files.size(); ++i) {
+    FilePath file_path = files[i];
+    GURL origin(WebKit::WebSecurityOrigin::createFromDatabaseIdentifier(
+        webkit_glue::FilePathToWebString(file_path.BaseName())).toString());
+    if (!BrowsingDataHelper::DoesOriginMatchMask(origin, origin_set_mask_,
+                                                 special_storage_policy_))
+      continue;
+
+    base::PlatformFileInfo file_info;
+    file_util::GetFileInfo(file_path, &file_info);

[Bernhard Bauer, 2012/05/31 15:57:31]

Wait, are you doing file access on the IO thread?

[Mike West, 2012/06/01 13:35:17]

No! Well, not now anyway.

+
+    if (file_info.last_modified >= delete_begin_ &&
+        file_info.last_modified <= delete_end_)
+      dom_storage_context_->DeleteLocalStorageFile(file_path);
+  }
+  BrowserThread::PostTask(
+      BrowserThread::UI, FROM_HERE,
+      base::Bind(&BrowsingDataRemover::OnLocalStorageCleared,
+                 base::Unretained(this)));
+}
+
+void BrowsingDataRemover::OnLocalStorageCleared() {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
+  DCHECK(waiting_for_clear_local_storage_);
+  waiting_for_clear_local_storage_ = false;
+  NotifyAndDeleteIfDone();
+}
+
 void BrowsingDataRemover::ClearQuotaManagedDataOnIOThread() {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
 
   // Ask the QuotaManager for all origins with temporary quota modified within
   // the user-specified timeframe, and deal with the resulting set in
   // OnGotQuotaManagedOrigins().
   quota_managed_origins_to_delete_count_ = 0;
   quota_managed_storage_types_to_delete_count_ = 2;
 
-  if (delete_begin_ == base::Time()) {
-    // If we're deleting since the beginning of time, ask the QuotaManager for
-    // all origins with persistent quota modified within the user-specified
-    // timeframe, and deal with the resulting set in
-    // OnGotPersistentQuotaManagedOrigins.
+  if (delete_begin_ == base::Time() ||
+      origin_set_mask_ &
+          (BrowsingDataHelper::PROTECTED_WEB | BrowsingDataHelper::EXTENSION)) {
+    // If we're deleting since the beginning of time, or we're removing
+    // protected origins, then ask the QuotaManager for all origins with
+    // persistent quota modified within the user-specified timeframe, and deal
+    // with the resulting set in OnGotPersistentQuotaManagedOrigins.
     quota_manager_->GetOriginsModifiedSince(
         quota::kStorageTypePersistent, delete_begin_,
         base::Bind(&BrowsingDataRemover::OnGotQuotaManagedOrigins,
                    base::Unretained(this)));
   } else {
     // Otherwise, we don't need to deal with persistent storage.
     --quota_managed_storage_types_to_delete_count_;
   }
 
-  // Do the same for temporary quota, regardless, passing the resulting set into
-  // OnGotTemporaryQuotaManagedOrigins.
-  quota_manager_->GetOriginsModifiedSince(
-      quota::kStorageTypeTemporary, delete_begin_,
-      base::Bind(&BrowsingDataRemover::OnGotQuotaManagedOrigins,
-                 base::Unretained(this)));
+  if (origin_set_mask_ & BrowsingDataHelper::UNPROTECTED_WEB) {
+    // Do the same for temporary quota, if we're removing unprotected origins,
+    // by passing the resulting set into OnGotTemporaryQuotaManagedOrigins.
+    quota_manager_->GetOriginsModifiedSince(
+        quota::kStorageTypeTemporary, delete_begin_,
+        base::Bind(&BrowsingDataRemover::OnGotQuotaManagedOrigins,
+                   base::Unretained(this)));
+  }

[Bernhard Bauer, 2012/05/31 15:57:31]

Do you need to decrement the count in the other case?

It might also be less fragile if you increase it when posting a task instead of
decreasing it when you don't.

[Mike West, 2012/06/01 13:35:17]

Makes sense. Done.

 }
 
 void BrowsingDataRemover::OnGotQuotaManagedOrigins(
     const std::set<GURL>& origins, quota::StorageType type) {
   DCHECK_GT(quota_managed_storage_types_to_delete_count_, 0);
   // Walk through the origins passed in, delete quota of |type| from each that
-  // isn't protected.
+  // matches the |origin_set_mask_|.
   std::set<GURL>::const_iterator origin;
   for (origin = origins.begin(); origin != origins.end(); ++origin) {
-    if (!BrowsingDataHelper::IsValidScheme(origin->scheme()))
-      continue;
-    if (special_storage_policy_->IsStorageProtected(origin->GetOrigin()))
-      continue;
     if (!remove_origin_.is_empty() && remove_origin_ != origin->GetOrigin())

[Bernhard Bauer, 2012/05/31 15:57:31]

This whole thing looks weird. If |remote_origin_| is non-empty, we iterate over
the whole set, but ignore every entry except for one which we already knew
before? That seems like it could be simplified.

[Mike West, 2012/06/01 13:35:17]

You're entirely correct, and it's certainly something I want to fix before a
"Forget this site" feature launches. Filed http://crbug.com/130732

       continue;
+
+    if (!BrowsingDataHelper::DoesOriginMatchMask(origin->GetOrigin(),
+                                                 origin_set_mask_,
+                                                 special_storage_policy_))
+      continue;
+
     ++quota_managed_origins_to_delete_count_;
     quota_manager_->DeleteOriginData(
         origin->GetOrigin(), type,
         BrowsingDataRemover::GenerateQuotaClientMask(remove_mask_),
         base::Bind(&BrowsingDataRemover::OnQuotaManagedOriginDeletion,
                    base::Unretained(this)));
   }
 
   --quota_managed_storage_types_to_delete_count_;
   CheckQuotaManagedDataDeletionStatus();
@@ skipping 82 matching lines @@
       BrowserThread::UI, FROM_HERE,
       base::Bind(&BrowsingDataRemover::OnClearedServerBoundCerts,
                  base::Unretained(this)));
 }
 
 void BrowsingDataRemover::OnClearedServerBoundCerts() {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   waiting_for_clear_server_bound_certs_ = false;
   NotifyAndDeleteIfDone();
 }