Add support for time based deletion of browsing data on iOS

Change existing browsing data deletion methods to take a browsing_data::TimePeriod as a parameter.

Keep old methods around until all call sites are changed downstream.

BUG=642334

Review-Url: https://codereview.chromium.org/2270063005
Cr-Commit-Position: refs/heads/master@{#419433}

components/signin/ios/browser/account_consistency_service.h

@@ -78,7 +78,8 @@ class AccountConsistencyService : public KeyedService,
   // Does nothing if the cookie is not set on |domain|.
   void RemoveChromeConnectedCookieFromDomain(const std::string& domain);
 
-  // Notifies the AccountConsistencyService that browsing data has been removed.
+  // Notifies the AccountConsistencyService that browsing data has been removed
+  // for any time period.
   void OnBrowsingDataRemoved();
 
  private:

ios/chrome/browser/browsing_data/browsing_data_remover_helper.cc

@@ -17,8 +17,9 @@ BrowsingDataRemoverHelper::~BrowsingDataRemoverHelper() {
 
 BrowsingDataRemoverHelper::BrowsingDataRemovalInfo::BrowsingDataRemovalInfo(
     int remove_mask,
+    browsing_data::TimePeriod time_period,
     const base::Closure& callback)
-    : remove_mask(remove_mask) {
+    : remove_mask(remove_mask), time_period(time_period) {
   callbacks.push_back(callback);
 }
 
@@ -27,6 +28,7 @@ BrowsingDataRemoverHelper::BrowsingDataRemovalInfo::~BrowsingDataRemovalInfo() {
 
 void BrowsingDataRemoverHelper::Remove(ios::ChromeBrowserState* browser_state,
                                        int remove_mask,
+                                       browsing_data::TimePeriod time_period,
                                        const base::Closure& callback) {
   DCHECK(browser_state);
   DCHECK(!browser_state->IsOffTheRecord());
@@ -43,7 +45,7 @@ void BrowsingDataRemoverHelper::Remove(ios::ChromeBrowserState* browser_state,
     auto pending_removals_iter = pending_removals_.find(browser_state);
     if (pending_removals_iter == pending_removals_.end()) {
       std::unique_ptr<BrowsingDataRemovalInfo> removal_info(
-          new BrowsingDataRemovalInfo(remove_mask, callback));
+          new BrowsingDataRemovalInfo(remove_mask, time_period, callback));
       pending_removals_[browser_state] = std::move(removal_info);
     } else {
       pending_removals_iter->second->remove_mask |= remove_mask;
@@ -51,11 +53,17 @@ void BrowsingDataRemoverHelper::Remove(ios::ChromeBrowserState* browser_state,
     }
   } else {
     std::unique_ptr<BrowsingDataRemovalInfo> removal_info(
-        new BrowsingDataRemovalInfo(remove_mask, callback));
+        new BrowsingDataRemovalInfo(remove_mask, time_period, callback));
     DoRemove(browser_state, std::move(removal_info));
   }
 }
 
+void BrowsingDataRemoverHelper::Remove(ios::ChromeBrowserState* browser_state,
+                                       int remove_mask,
+                                       const base::Closure& callback) {
+  Remove(browser_state, remove_mask, browsing_data::ALL_TIME, callback);
+}
+
 void BrowsingDataRemoverHelper::OnIOSChromeBrowsingDataRemoverDone() {
   current_remover_ = nullptr;
 
@@ -90,7 +98,7 @@ void BrowsingDataRemoverHelper::DoRemove(
   // IOSChromeBrowsingDataRemover deletes itself.
   IOSChromeBrowsingDataRemover* remover =
       IOSChromeBrowsingDataRemover::CreateForPeriod(
-          browser_state, IOSChromeBrowsingDataRemover::EVERYTHING);
+          browser_state, current_removal_info_->time_period);
   remover->AddObserver(this);
   current_remover_ = remover;
   int remove_mask = current_removal_info_->remove_mask;

ios/chrome/browser/browsing_data/browsing_data_remover_helper.h

@@ -30,6 +30,13 @@ class BrowsingDataRemoverHelper
   // |callback| is called on the main thread.
   // Note: Removal operations are not necessarily processed in the sequence that
   // they are received in.
+  void Remove(ios::ChromeBrowserState* browser_state,
+              int remove_mask,
+              browsing_data::TimePeriod time_period,
+              const base::Closure& callback);
+
+  // DEPRECATED: Same as above, but setting the |time_period| to ALL_TIME.
+  // TODO(ioanap): Remove after all call sites are changed.
   void Remove(ios::ChromeBrowserState* browser_state,
               int remove_mask,
               const base::Closure& callback);
@@ -39,11 +46,15 @@ class BrowsingDataRemoverHelper
   // a ChromeBrowserState.
   struct BrowsingDataRemovalInfo {
     // Creates a BrowsingDataRemovalInfo with a single callback |callback|.
-    BrowsingDataRemovalInfo(int remove_mask, const base::Closure& callback);
+    BrowsingDataRemovalInfo(int remove_mask,
+                            browsing_data::TimePeriod time_period,
+                            const base::Closure& callback);
     ~BrowsingDataRemovalInfo();
     // The mask of all the types of browsing data that needs to be removed.
     // Obtained from BrowsingDataRemoved::RemoveDataMask.
     int remove_mask;
+    // Time period for which the user wants to remove the data.
+    browsing_data::TimePeriod time_period;
     // The vector of callbacks that need to be run when browsing data is
     // actually removed.
     std::vector<base::Closure> callbacks;

ios/chrome/browser/browsing_data/ios_chrome_browsing_data_remover.h

@@ -15,6 +15,7 @@
 #include "base/sequenced_task_runner_helpers.h"
 #include "base/task/cancelable_task_tracker.h"
 #include "base/time/time.h"
+#include "components/browsing_data/core/browsing_data_utils.h"
 #include "components/prefs/pref_member.h"
 #include "components/search_engines/template_url_service.h"
 #include "url/gurl.h"
@@ -33,9 +34,6 @@ class URLRequestContextGetter;
 
 class IOSChromeBrowsingDataRemover {
  public:
-  // Time period ranges available when doing browsing data removals.
-  enum TimePeriod { EVERYTHING };
-
   // Mask used for Remove.
   enum RemoveDataMask {
     REMOVE_APPCACHE = 1 << 0,
@@ -119,10 +117,7 @@ class IOSChromeBrowsingDataRemover {
   // itself once finished.
   static IOSChromeBrowsingDataRemover* CreateForPeriod(
       ios::ChromeBrowserState* browser_state,
-      TimePeriod period);
-
-  // Calculate the begin time for the deletion range specified by |time_period|.
-  static base::Time CalculateBeginDeleteTime(TimePeriod time_period);
+      browsing_data::TimePeriod period);
 
   // Is the IOSChromeBrowsingDataRemover currently in the process of removing
   // data?

ios/chrome/browser/browsing_data/ios_chrome_browsing_data_remover.mm

@@ -90,15 +90,26 @@ IOSChromeBrowsingDataRemover::NotificationDetails::~NotificationDetails() {}
 // Static.
 IOSChromeBrowsingDataRemover* IOSChromeBrowsingDataRemover::CreateForPeriod(
     ios::ChromeBrowserState* browser_state,
-    TimePeriod period) {
+    browsing_data::TimePeriod period) {
   switch (period) {
-    case EVERYTHING:
+    case browsing_data::LAST_HOUR:
+      base::RecordAction(UserMetricsAction("ClearBrowsingData_LastHour"));
+      break;
+    case browsing_data::LAST_DAY:
+      base::RecordAction(UserMetricsAction("ClearBrowsingData_LastDay"));
+      break;
+    case browsing_data::LAST_WEEK:
+      base::RecordAction(UserMetricsAction("ClearBrowsingData_LastWeek"));
+      break;
+    case browsing_data::FOUR_WEEKS:
+      base::RecordAction(UserMetricsAction("ClearBrowsingData_LastMonth"));
+      break;
+    case browsing_data::ALL_TIME:
       base::RecordAction(UserMetricsAction("ClearBrowsingData_Everything"));
       break;
   }
   return new IOSChromeBrowsingDataRemover(
-      browser_state,
-      IOSChromeBrowsingDataRemover::CalculateBeginDeleteTime(period),
+      browser_state, browsing_data::CalculateBeginDeleteTime(period),
       base::Time::Max());
 }
 
@@ -303,9 +314,9 @@ void IOSChromeBrowsingDataRemover::RemoveImpl(int remove_mask) {
     base::RecordAction(UserMetricsAction("ClearBrowsingData_Cache"));
 
     waiting_for_clear_cache_ = true;
-    DCHECK(delete_begin_.is_null()) << "Partial clearing not supported";
     ClearHttpCache(browser_state_->GetRequestContext(),
                    WebThread::GetTaskRunnerForThread(WebThread::IO),
+                   delete_begin_, delete_end_,
                    base::Bind(&IOSChromeBrowsingDataRemover::OnClearedCache,
                               base::Unretained(this)));
   }
@@ -350,21 +361,6 @@ void IOSChromeBrowsingDataRemover::OnHistoryDeletionDone() {
   NotifyAndDeleteIfDone();
 }
 
-base::Time IOSChromeBrowsingDataRemover::CalculateBeginDeleteTime(
-    TimePeriod time_period) {
-  base::TimeDelta diff;
-  base::Time delete_begin_time = base::Time::Now();
-  switch (time_period) {
-    case EVERYTHING:
-      delete_begin_time = base::Time();
-      break;
-    default:
-      NOTREACHED() << L"Missing item";
-      break;
-  }
-  return delete_begin_time - diff;
-}
-
 bool IOSChromeBrowsingDataRemover::AllDone() {
   return !waiting_for_clear_autofill_origin_urls_ &&
          !waiting_for_clear_cache_ && !waiting_for_clear_channel_ids_ &&

ios/chrome/browser/signin/browser_state_data_remover.mm

@@ -40,7 +40,8 @@ void BrowserStateDataRemover::RemoveBrowserStateData(ProceduralBlock callback) {
   base::scoped_nsobject<ClearBrowsingDataCommand> command(
       [[ClearBrowsingDataCommand alloc]
           initWithBrowserState:browser_state_
-                          mask:kRemoveAllDataMask]);
+                          mask:kRemoveAllDataMask
+                    timePeriod:browsing_data::ALL_TIME]);
 
   UIWindow* mainWindow = [[UIApplication sharedApplication] keyWindow];
   DCHECK(mainWindow);

ios/chrome/browser/ui/commands/clear_browsing_data_command.h

@@ -7,6 +7,7 @@
 
 #import <Foundation/Foundation.h>
 
+#import "components/browsing_data/core/browsing_data_utils.h"
 #import "ios/chrome/browser/ui/commands/generic_chrome_command.h"
 
 namespace ios {
@@ -20,9 +21,16 @@ class ChromeBrowserState;
 - (instancetype)initWithTag:(NSInteger)tag NS_UNAVAILABLE;
 
 // Initializes a command intented to clear browsing data for |browserState|
-// that correspong to removal mask |mask|.
+// that corresponds to removal mask |mask| for the time period |timePeriod|.
 - (instancetype)initWithBrowserState:(ios::ChromeBrowserState*)browserState
-                                mask:(int)mask NS_DESIGNATED_INITIALIZER;
+                                mask:(int)mask
+                          timePeriod:(browsing_data::TimePeriod)timePeriod
+    NS_DESIGNATED_INITIALIZER;
+
+// DEPRECATED: Same as above, but setting |timePeriod| to ALL_TIME.
+// TODO(ioanap): Remove after all call sites are changed.
+- (instancetype)initWithBrowserState:(ios::ChromeBrowserState*)browserState
+                                mask:(int)mask;
 
 // When executed this command will remove browsing data for this BrowserState.
 @property(nonatomic, readonly) ios::ChromeBrowserState* browserState;
@@ -30,6 +38,9 @@ class ChromeBrowserState;
 // Removal mask: see BrowsingDataRemover::RemoveDataMask.
 @property(nonatomic, readonly) int mask;
 
+// Time period for which the browsing data will be removed.
+@property(nonatomic, readonly) browsing_data::TimePeriod timePeriod;
+
 @end
 
 #endif  // IOS_CHROME_BROWSER_UI_COMMANDS_CLEAR_BROWSING_DATA_COMMAND_H_

ios/chrome/browser/ui/commands/clear_browsing_data_command.mm

@@ -11,6 +11,7 @@
 
 @synthesize browserState = _browserState;
 @synthesize mask = _mask;
+@synthesize timePeriod = _timePeriod;
 
 - (instancetype)initWithTag:(NSInteger)tag {
   NOTREACHED();
@@ -18,14 +19,23 @@
 }
 
 - (instancetype)initWithBrowserState:(ios::ChromeBrowserState*)browserState
-                                mask:(int)mask {
+                                mask:(int)mask
+                          timePeriod:(browsing_data::TimePeriod)timePeriod {
   self = [super initWithTag:IDC_CLEAR_BROWSING_DATA_IOS];
   if (self) {
     DCHECK(browserState);
     _browserState = browserState;
     _mask = mask;
+    _timePeriod = timePeriod;
   }
   return self;
 }
 
+- (instancetype)initWithBrowserState:(ios::ChromeBrowserState*)browserState
+                                mask:(int)mask {
+  return [self initWithBrowserState:browserState
+                               mask:mask
+                         timePeriod:browsing_data::ALL_TIME];
+}
+
 @end

ios/crnet/crnet_environment.mm

@@ -506,7 +506,7 @@ std::string CrNetEnvironment::user_agent() {
 
 void CrNetEnvironment::ClearCache(ClearCacheCallback callback) {
   PostToNetworkThread(
-      FROM_HERE,
-      base::Bind(&net::ClearHttpCache, main_context_getter_,
-                 network_io_thread_->task_runner(), base::BindBlock(callback)));
+      FROM_HERE, base::Bind(&net::ClearHttpCache, main_context_getter_,
+                            network_io_thread_->task_runner(), base::Time(),
+                            base::Time::Max(), base::BindBlock(callback)));
 }

ios/net/http_cache_helper.cc

@@ -33,11 +33,14 @@ void PostCallback(const scoped_refptr<base::TaskRunner>& task_runner,
 // Clears the disk_cache::Backend on the IO thread and deletes |backend|.
 void DoomHttpCache(std::unique_ptr<disk_cache::Backend*> backend,
                    const scoped_refptr<base::TaskRunner>& client_task_runner,
+                   const base::Time& delete_begin,
+                   const base::Time& delete_end,
                    const net::CompletionCallback& callback,
                    int error) {
   // |*backend| may be null in case of error.
   if (*backend) {
-    (*backend)->DoomAllEntries(
+    (*backend)->DoomEntriesBetween(
+        delete_begin, delete_end,
         base::Bind(&PostCallback, client_task_runner, callback));
   } else {
     client_task_runner->PostTask(FROM_HERE, base::Bind(callback, error));
@@ -49,6 +52,8 @@ void DoomHttpCache(std::unique_ptr<disk_cache::Backend*> backend,
 void ClearHttpCacheOnIOThread(
     const scoped_refptr<net::URLRequestContextGetter>& getter,
     const scoped_refptr<base::TaskRunner>& client_task_runner,
+    const base::Time& delete_begin,
+    const base::Time& delete_end,
     const net::CompletionCallback& callback) {
   net::HttpCache* http_cache =
       getter->GetURLRequestContext()->http_transaction_factory()->GetCache();
@@ -72,7 +77,7 @@ void ClearHttpCacheOnIOThread(
   disk_cache::Backend** backend_ptr = backend.get();
   net::CompletionCallback doom_callback =
       base::Bind(&DoomHttpCache, base::Passed(std::move(backend)),
-                 client_task_runner, callback);
+                 client_task_runner, delete_begin, delete_end, callback);
 
   int rv = http_cache->GetBackend(backend_ptr, doom_callback);
 
@@ -89,10 +94,14 @@ namespace net {
 
 void ClearHttpCache(const scoped_refptr<net::URLRequestContextGetter>& getter,
                     const scoped_refptr<base::TaskRunner>& network_task_runner,
+                    const base::Time& delete_begin,
+                    const base::Time& delete_end,
                     const net::CompletionCallback& callback) {
+  DCHECK(delete_end != base::Time());
   network_task_runner->PostTask(
       FROM_HERE, base::Bind(&ClearHttpCacheOnIOThread, getter,
-                            base::ThreadTaskRunnerHandle::Get(), callback));
+                            base::ThreadTaskRunnerHandle::Get(), delete_begin,
+                            delete_end, callback));
 }
 
 }  // namespace net

ios/net/http_cache_helper.h

@@ -19,6 +19,8 @@ class URLRequestContextGetter;
 // Clears the HTTP cache and calls |closure| back.
 void ClearHttpCache(const scoped_refptr<net::URLRequestContextGetter>& getter,
                     const scoped_refptr<base::TaskRunner>& network_task_runner,
+                    const base::Time& delete_begin,
+                    const base::Time& delete_end,
                     const net::CompletionCallback& callback);
 
 }  // namespace net