| // 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 CONTENT_BROWSER_BROWSING_DATA_BROWSING_DATA_REMOVER_IMPL_H_ |
| #define CONTENT_BROWSER_BROWSING_DATA_BROWSING_DATA_REMOVER_IMPL_H_ |
| |
| #include <stdint.h> |
| |
| #include <set> |
| |
| #include "base/cancelable_callback.h" |
| #include "base/containers/queue.h" |
| #include "base/gtest_prod_util.h" |
| #include "base/macros.h" |
| #include "base/memory/weak_ptr.h" |
| #include "base/observer_list.h" |
| #include "base/supports_user_data.h" |
| #include "base/synchronization/waitable_event_watcher.h" |
| #include "base/time/time.h" |
| #include "build/build_config.h" |
| #include "content/common/content_export.h" |
| #include "content/public/browser/browsing_data_remover.h" |
| #include "url/origin.h" |
| |
| namespace content { |
| |
| class BrowserContext; |
| class BrowsingDataFilterBuilder; |
| class StoragePartition; |
| |
| class CONTENT_EXPORT BrowsingDataRemoverImpl |
| : public BrowsingDataRemover, |
| public base::SupportsUserData::Data { |
| public: |
| explicit BrowsingDataRemoverImpl(BrowserContext* browser_context); |
| ~BrowsingDataRemoverImpl() override; |
| |
| // Is the BrowsingDataRemoverImpl currently in the process of removing data? |
| bool is_removing() { return is_removing_; } |
| |
| // BrowsingDataRemover implementation: |
| void SetEmbedderDelegate( |
| BrowsingDataRemoverDelegate* embedder_delegate) override; |
| bool DoesOriginMatchMask( |
| int origin_type_mask, |
| const url::Origin& origin, |
| storage::SpecialStoragePolicy* special_storage_policy) override; |
| void Remove(const base::Time& delete_begin, |
| const base::Time& delete_end, |
| int remove_mask, |
| int origin_type_mask) override; |
| void RemoveAndReply(const base::Time& delete_begin, |
| const base::Time& delete_end, |
| int remove_mask, |
| int origin_type_mask, |
| Observer* observer) override; |
| void RemoveWithFilter( |
| const base::Time& delete_begin, |
| const base::Time& delete_end, |
| int remove_mask, |
| int origin_type_mask, |
| std::unique_ptr<BrowsingDataFilterBuilder> filter_builder) override; |
| void RemoveWithFilterAndReply( |
| const base::Time& delete_begin, |
| const base::Time& delete_end, |
| int remove_mask, |
| int origin_type_mask, |
| std::unique_ptr<BrowsingDataFilterBuilder> filter_builder, |
| Observer* observer) override; |
| |
| void AddObserver(Observer* observer) override; |
| void RemoveObserver(Observer* observer) override; |
| |
| void SetWouldCompleteCallbackForTesting( |
| const base::Callback<void(const base::Closure& continue_to_completion)>& |
| callback) override; |
| |
| const base::Time& GetLastUsedBeginTime() override; |
| const base::Time& GetLastUsedEndTime() override; |
| int GetLastUsedRemovalMask() override; |
| int GetLastUsedOriginTypeMask() override; |
| |
| // Used for testing. |
| void OverrideStoragePartitionForTesting(StoragePartition* storage_partition); |
| |
| protected: |
| // A common reduction of all public Remove[WithFilter][AndReply] methods. |
| virtual void RemoveInternal( |
| const base::Time& delete_begin, |
| const base::Time& delete_end, |
| int remove_mask, |
| int origin_type_mask, |
| std::unique_ptr<BrowsingDataFilterBuilder> filter_builder, |
| Observer* observer); |
| |
| private: |
| // Testing the private RemovalTask. |
| FRIEND_TEST_ALL_PREFIXES(BrowsingDataRemoverImplTest, MultipleTasks); |
| |
| // For debugging purposes. Please add new deletion tasks at the end. |
| // This enum is recorded in a histogram, so don't change or reuse ids. |
| // Entries must also be added to BrowsingDataRemoverTasks in enums.xml. |
| enum class TracingDataType { |
| kSynchronous = 1, |
| kEmbedderData = 2, |
| kStoragePartition = 3, |
| kHttpCache = 4, |
| kHttpAndMediaCaches = 5, |
| kReportingCache = 6, |
| kChannelIds = 7, |
| kNetworkHistory = 8, |
| kAuthCache = 9, |
| kCodeCaches = 10, |
| kNetworkErrorLogging = 11, |
| kMaxValue = kNetworkErrorLogging, |
| }; |
| |
| // Represents a single removal task. Contains all parameters needed to execute |
| // it and a pointer to the observer that added it. CONTENT_EXPORTed to be |
| // visible in tests. |
| struct CONTENT_EXPORT RemovalTask { |
| RemovalTask(const base::Time& delete_begin, |
| const base::Time& delete_end, |
| int remove_mask, |
| int origin_type_mask, |
| std::unique_ptr<BrowsingDataFilterBuilder> filter_builder, |
| Observer* observer); |
| RemovalTask(RemovalTask&& other) noexcept; |
| ~RemovalTask(); |
| |
| base::Time delete_begin; |
| base::Time delete_end; |
| int remove_mask; |
| int origin_type_mask; |
| std::unique_ptr<BrowsingDataFilterBuilder> filter_builder; |
| Observer* observer; |
| base::Time task_started; |
| }; |
| |
| // Setter for |is_removing_|; DCHECKs that we can only start removing if we're |
| // not already removing, and vice-versa. |
| void SetRemoving(bool is_removing); |
| |
| // Executes the next removal task. Called after the previous task was finished |
| // or directly from Remove() if the task queue was empty. |
| void RunNextTask(); |
| |
| // Removes the specified items related to browsing for a specific host. If the |
| // provided |remove_url| is empty, data is removed for all origins; otherwise, |
| // it is restricted by the origin filter origin (where implemented yet). The |
| // |origin_type_mask| parameter defines the set of origins from which data |
| // should be removed (protected, unprotected, or both). |
| // TODO(ttr314): Remove "(where implemented yet)" constraint above once |
| // crbug.com/113621 is done. |
| // TODO(crbug.com/589586): Support all backends w/ origin filter. |
| void RemoveImpl(const base::Time& delete_begin, |
| const base::Time& delete_end, |
| int remove_mask, |
| BrowsingDataFilterBuilder* filter_builder, |
| int origin_type_mask); |
| |
| // Notifies observers and transitions to the idle state. |
| void Notify(); |
| |
| // Called by the closures returned by CreateTaskCompletionClosure(). |
| // Checks if all tasks have completed, and if so, calls Notify(). |
| void OnTaskComplete(TracingDataType data_type); |
| |
| // Increments the number of pending tasks by one, and returns a OnceClosure |
| // that calls OnTaskComplete(). The Remover is complete once all the closures |
| // created by this method have been invoked. |
| base::OnceClosure CreateTaskCompletionClosure(TracingDataType data_type); |
| |
| // Same as CreateTaskCompletionClosure() but guarantees that |
| // OnTaskComplete() is called if the task is dropped. That can typically |
| // happen when the connection is closed while an interface call is made. |
| base::OnceClosure CreateTaskCompletionClosureForMojo( |
| TracingDataType data_type); |
| |
| // Records unfinished tasks from |pending_sub_tasks_| after a delay. |
| void RecordUnfinishedSubTasks(); |
| |
| // Like GetWeakPtr(), but returns a weak pointer to BrowsingDataRemoverImpl |
| // for internal purposes. |
| base::WeakPtr<BrowsingDataRemoverImpl> GetWeakPtr(); |
| |
| // The browser context we're to remove from. |
| BrowserContext* browser_context_; |
| |
| // A delegate to delete the embedder-specific data. Owned by the embedder. |
| BrowsingDataRemoverDelegate* embedder_delegate_; |
| |
| // Start time to delete from. |
| base::Time delete_begin_; |
| |
| // End time to delete to. |
| base::Time delete_end_; |
| |
| // The removal mask for the current removal operation. |
| int remove_mask_ = 0; |
| |
| // From which types of origins should we remove data? |
| int origin_type_mask_ = 0; |
| |
| // True if Remove has been invoked. |
| bool is_removing_; |
| |
| // Removal tasks to be processed. |
| base::queue<RemovalTask> task_queue_; |
| |
| // If non-null, the |would_complete_callback_| is called each time an instance |
| // is about to complete a browsing data removal process, and has the ability |
| // to artificially delay completion. Used for testing. |
| base::Callback<void(const base::Closure& continue_to_completion)> |
| would_complete_callback_; |
| |
| // Records which tasks of a deletion are currently active. |
| std::set<TracingDataType> pending_sub_tasks_; |
| |
| // Fires after some time to track slow tasks. Cancelled when all tasks |
| // are finished. |
| base::CancelableClosure slow_pending_tasks_closure_; |
| |
| // Observers of the global state and individual tasks. |
| base::ObserverList<Observer, true>::Unchecked observer_list_; |
| |
| // We do not own this. |
| StoragePartition* storage_partition_for_testing_; |
| |
| base::WeakPtrFactory<BrowsingDataRemoverImpl> weak_ptr_factory_{this}; |
| |
| DISALLOW_COPY_AND_ASSIGN(BrowsingDataRemoverImpl); |
| }; |
| |
| } // namespace content |
| |
| #endif // CONTENT_BROWSER_BROWSING_DATA_BROWSING_DATA_REMOVER_IMPL_H_ |