// 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_BROWSING_DATA_REMOVER_H_
#define CHROME_BROWSER_BROWSING_DATA_BROWSING_DATA_REMOVER_H_
#include <set>
#include "base/gtest_prod_util.h"
#include "base/memory/ref_counted.h"
#include "base/observer_list.h"
#include "base/prefs/pref_member.h"
#include "base/sequenced_task_runner_helpers.h"
#include "base/synchronization/waitable_event_watcher.h"
#include "base/task/cancelable_task_tracker.h"
#include "base/time/time.h"
#include "chrome/browser/pepper_flash_settings_manager.h"
#include "chrome/browser/search_engines/template_url_service.h"
#if defined(OS_CHROMEOS)
#include "chromeos/dbus/dbus_method_call_status.h"
#endif
#include "url/gurl.h"
#include "webkit/common/quota/quota_types.h"
class ExtensionSpecialStoragePolicy;
class IOThread;
class Profile;
namespace content {
class PluginDataRemover;
class StoragePartition;
}
namespace disk_cache {
class Backend;
}
namespace net {
class URLRequestContextGetter;
}
namespace quota {
class QuotaManager;
}
namespace content {
class DOMStorageContext;
struct LocalStorageUsageInfo;
struct SessionStorageUsageInfo;
}
// BrowsingDataRemover is responsible for removing data related to browsing:
// visits in url database, downloads, cookies ...
class BrowsingDataRemover
#if defined(ENABLE_PLUGINS)
: public PepperFlashSettingsManager::Client
#endif
{
public:
// Time period ranges available when doing browsing data removals.
enum TimePeriod {
LAST_HOUR = 0,
LAST_DAY,
LAST_WEEK,
FOUR_WEEKS,
EVERYTHING
};
// Mask used for Remove.
enum RemoveDataMask {
REMOVE_APPCACHE = 1 << 0,
REMOVE_CACHE = 1 << 1,
REMOVE_COOKIES = 1 << 2,
REMOVE_DOWNLOADS = 1 << 3,
REMOVE_FILE_SYSTEMS = 1 << 4,
REMOVE_FORM_DATA = 1 << 5,
// In addition to visits, REMOVE_HISTORY removes keywords and last session.
REMOVE_HISTORY = 1 << 6,
REMOVE_INDEXEDDB = 1 << 7,
REMOVE_LOCAL_STORAGE = 1 << 8,
REMOVE_PLUGIN_DATA = 1 << 9,
REMOVE_PASSWORDS = 1 << 10,
REMOVE_WEBSQL = 1 << 11,
REMOVE_SERVER_BOUND_CERTS = 1 << 12,
REMOVE_CONTENT_LICENSES = 1 << 13,
#if defined(OS_ANDROID)
REMOVE_APP_BANNER_DATA = 1 << 14,
#endif
// The following flag is used only in tests. In normal usage, hosted app
// data is controlled by the REMOVE_COOKIES flag, applied to the
// protected-web origin.
REMOVE_HOSTED_APP_DATA_TESTONLY = 1 << 31,
// "Site data" includes cookies, appcache, file systems, indexedDBs, local
// storage, webSQL, and plugin data.
REMOVE_SITE_DATA = REMOVE_APPCACHE |
REMOVE_COOKIES |
REMOVE_FILE_SYSTEMS |
REMOVE_INDEXEDDB |
REMOVE_LOCAL_STORAGE |
REMOVE_PLUGIN_DATA |
REMOVE_WEBSQL |
#if defined(OS_ANDROID)
REMOVE_APP_BANNER_DATA |
#endif
REMOVE_SERVER_BOUND_CERTS,
// Includes all the available remove options. Meant to be used by clients
// that wish to wipe as much data as possible from a Profile, to make it
// look like a new Profile.
REMOVE_ALL = REMOVE_SITE_DATA |
REMOVE_CACHE |
REMOVE_DOWNLOADS |
REMOVE_FORM_DATA |
REMOVE_HISTORY |
REMOVE_PASSWORDS |
REMOVE_CONTENT_LICENSES,
};
// When BrowsingDataRemover successfully removes data, a notification of type
// NOTIFICATION_BROWSING_DATA_REMOVED is triggered with a Details object of
// this type.
struct NotificationDetails {
NotificationDetails();
NotificationDetails(const NotificationDetails& details);
NotificationDetails(base::Time removal_begin,
int removal_mask,
int origin_set_mask);
~NotificationDetails();
// The beginning of the removal time range.
base::Time removal_begin;
// The removal mask (see the RemoveDataMask enum for details).
int removal_mask;
// The origin set mask (see BrowsingDataHelper::OriginSetMask for details).
int origin_set_mask;
};
// Observer is notified when the removal is done. Done means keywords have
// been deleted, cache cleared and all other tasks scheduled.
class Observer {
public:
virtual void OnBrowsingDataRemoverDone() = 0;
protected:
virtual ~Observer() {}
};
// Creates a BrowsingDataRemover object that removes data regardless of the
// time it was last modified. Returns a raw pointer, as BrowsingDataRemover
// retains ownership of itself, and deletes itself once finished.
static BrowsingDataRemover* CreateForUnboundedRange(Profile* profile);
// Creates a BrowsingDataRemover object bound on both sides by a time. Returns
// a raw pointer, as BrowsingDataRemover retains ownership of itself, and
// deletes itself once finished.
static BrowsingDataRemover* CreateForRange(Profile* profile,
base::Time delete_begin,
base::Time delete_end);
// Creates a BrowsingDataRemover bound to a specific period of time (as
// defined via a TimePeriod). Returns a raw pointer, as BrowsingDataRemover
// retains ownership of itself, and deletes itself once finished.
static BrowsingDataRemover* CreateForPeriod(Profile* profile,
TimePeriod period);
// Calculate the begin time for the deletion range specified by |time_period|.
static base::Time CalculateBeginDeleteTime(TimePeriod time_period);
// Is the BrowsingDataRemover currently in the process of removing data?
static bool is_removing() { return is_removing_; }
// 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();
// Used for testing.
void OverrideStoragePartitionForTesting(
content::StoragePartition* storage_partition);
private:
// The clear API needs to be able to toggle removing_ in order to test that
// only one BrowsingDataRemover instance can be called at a time.
FRIEND_TEST_ALL_PREFIXES(ExtensionBrowsingDataTest, OneAtATime);
// The BrowsingDataRemover tests need to be able to access the implementation
// of Remove(), as it exposes details that aren't yet available in the public
// API. As soon as those details are exposed via new methods, this should be
// removed.
//
// TODO(mkwst): See http://crbug.com/113621
friend class BrowsingDataRemoverTest;
enum CacheState {
STATE_NONE,
STATE_CREATE_MAIN,
STATE_CREATE_MEDIA,
STATE_DELETE_MAIN,
STATE_DELETE_MEDIA,
STATE_DONE
};
// Setter for |is_removing_|; DCHECKs that we can only start removing if we're
// not already removing, and vice-versa.
static void set_removing(bool is_removing);
// 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);
// BrowsingDataRemover deletes itself (using DeleteHelper) and is not supposed
// to be deleted by other objects so make destructor private and DeleteHelper
// a friend.
friend class base::DeleteHelper<BrowsingDataRemover>;
virtual ~BrowsingDataRemover();
// Callback for when TemplateURLService has finished loading. Clears the data,
// clears the respective waiting flag, and invokes NotifyAndDeleteIfDone.
void OnKeywordsLoaded();
// Called when plug-in data has been cleared. Invokes NotifyAndDeleteIfDone.
void OnWaitableEventSignaled(base::WaitableEvent* waitable_event);
#if defined(ENABLE_PLUGINS)
// PepperFlashSettingsManager::Client implementation.
virtual void OnDeauthorizeContentLicensesCompleted(uint32 request_id,
bool success) OVERRIDE;
#endif
#if defined (OS_CHROMEOS)
void OnClearPlatformKeys(chromeos::DBusMethodCallStatus call_status,
bool result);
#endif
// Removes the specified items related to browsing for a specific host. If the
// 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,
int origin_set_mask);
// If we're not waiting on anything, notifies observers and deletes this
// object.
void NotifyAndDeleteIfDone();
// Callback for when the hostname resolution cache has been cleared.
// Clears the respective waiting flag and invokes NotifyAndDeleteIfDone.
void OnClearedHostnameResolutionCache();
// Invoked on the IO thread to clear the hostname resolution cache.
void ClearHostnameResolutionCacheOnIOThread(IOThread* io_thread);
// Callback for when the LoggedIn Predictor has been cleared.
// Clears the respective waiting flag and invokes NotifyAndDeleteIfDone.
void OnClearedLoggedInPredictor();
// Clears the LoggedIn Predictor.
void ClearLoggedInPredictor();
// Callback for when speculative data in the network Predictor has been
// cleared. Clears the respective waiting flag and invokes
// NotifyAndDeleteIfDone.
void OnClearedNetworkPredictor();
// Invoked on the IO thread to clear speculative data related to hostname
// pre-resolution from the network Predictor.
void ClearNetworkPredictorOnIOThread();
// Callback for when network related data in ProfileIOData has been cleared.
// Clears the respective waiting flag and invokes NotifyAndDeleteIfDone.
void OnClearedNetworkingHistory();
// Callback for 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);
#if !defined(DISABLE_NACL)
// Callback for when the NaCl cache has been deleted. Invokes
// NotifyAndDeleteIfDone.
void ClearedNaClCache();
// Invokes the ClearedNaClCache on the UI thread.
void ClearedNaClCacheOnIOThread();
// Invoked on the IO thread to delete the NaCl cache.
void ClearNaClCacheOnIOThread();
// Callback for when the PNaCl translation cache has been deleted. Invokes
// NotifyAndDeleteIfDone.
void ClearedPnaclCache();
// Invokes ClearedPnaclCacheOn on the UI thread.
void ClearedPnaclCacheOnIOThread();
// Invoked on the IO thread to delete entries in the PNaCl translation cache.
void ClearPnaclCacheOnIOThread(base::Time begin, base::Time end);
#endif
// Callback for when Cookies has been deleted. Invokes NotifyAndDeleteIfDone.
void OnClearedCookies(int num_deleted);
// Invoked on the IO thread to delete cookies.
void ClearCookiesOnIOThread(net::URLRequestContextGetter* rq_context);
// Invoked on the IO thread to delete server bound certs.
void ClearServerBoundCertsOnIOThread(
net::URLRequestContextGetter* rq_context);
// Callback on IO Thread when server bound certs have been deleted. Clears SSL
// connection pool and posts to UI thread to run OnClearedServerBoundCerts.
void OnClearedServerBoundCertsOnIOThread(
net::URLRequestContextGetter* rq_context);
// Callback for when server bound certs have been deleted. Invokes
// NotifyAndDeleteIfDone.
void OnClearedServerBoundCerts();
// Callback from the above method.
void OnClearedFormData();
// Callback for when the Autofill profile and credit card origin URLs have
// been deleted.
void OnClearedAutofillOriginURLs();
// Callback on UI thread when the storage partition related data are cleared.
void OnClearedStoragePartitionData();
#if defined(ENABLE_WEBRTC)
// Callback on UI thread when the WebRTC logs have been deleted.
void OnClearedWebRtcLogs();
#endif
// Returns true if we're all done.
bool AllDone();
// Profile we're to remove from.
Profile* profile_;
// '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.
base::Time delete_end_;
// True if Remove has been invoked.
static bool is_removing_;
CacheState next_cache_state_;
disk_cache::Backend* cache_;
// Used to delete data from HTTP cache.
scoped_refptr<net::URLRequestContextGetter> main_context_getter_;
scoped_refptr<net::URLRequestContextGetter> media_context_getter_;
#if defined(ENABLE_PLUGINS)
// Used to delete plugin data.
scoped_ptr<content::PluginDataRemover> plugin_data_remover_;
base::WaitableEventWatcher watcher_;
// Used to deauthorize content licenses for Pepper Flash.
scoped_ptr<PepperFlashSettingsManager> pepper_flash_settings_manager_;
#endif
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_autofill_origin_urls_;
bool waiting_for_clear_cache_;
bool waiting_for_clear_content_licenses_;
// Non-zero if waiting for cookies to be cleared.
int waiting_for_clear_cookies_count_;
bool waiting_for_clear_form_;
bool waiting_for_clear_history_;
bool waiting_for_clear_hostname_resolution_cache_;
bool waiting_for_clear_keyword_data_;
bool waiting_for_clear_logged_in_predictor_;
bool waiting_for_clear_nacl_cache_;
bool waiting_for_clear_network_predictor_;
bool waiting_for_clear_networking_history_;
bool waiting_for_clear_platform_keys_;
bool waiting_for_clear_plugin_data_;
bool waiting_for_clear_pnacl_cache_;
bool waiting_for_clear_server_bound_certs_;
bool waiting_for_clear_storage_partition_data_;
#if defined(ENABLE_WEBRTC)
bool waiting_for_clear_webrtc_logs_;
#endif
// The removal mask for the current removal operation.
int remove_mask_;
// The origin for the current removal operation.
GURL remove_origin_;
// From which types of origins should we remove data?
int origin_set_mask_;
ObserverList<Observer> observer_list_;
// Used if we need to clear history.
base::CancelableTaskTracker history_task_tracker_;
scoped_ptr<TemplateURLService::Subscription> template_url_sub_;
// We do not own this.
content::StoragePartition* storage_partition_for_testing_;
DISALLOW_COPY_AND_ASSIGN(BrowsingDataRemover);
};
#endif // CHROME_BROWSER_BROWSING_DATA_BROWSING_DATA_REMOVER_H_