Split browsing data masks between content and embedder

chrome/browser/browsing_data/chrome_browsing_data_remover_delegate.h

 // Copyright 2016 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_CHROME_BROWSING_DATA_REMOVER_DELEGATE_H_
 #define CHROME_BROWSER_BROWSING_DATA_CHROME_BROWSING_DATA_REMOVER_DELEGATE_H_
 
 #include <memory>
 
 #include "base/callback_forward.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/weak_ptr.h"
 #include "base/synchronization/waitable_event_watcher.h"
 #include "base/task/cancelable_task_tracker.h"
 #include "chrome/browser/browsing_data/browsing_data_remover.h"
 #include "chrome/browser/browsing_data/browsing_data_remover_delegate.h"
 #include "chrome/common/features.h"
 #include "components/browsing_data/core/browsing_data_utils.h"
 #include "components/offline_pages/core/offline_page_model.h"
 #include "components/search_engines/template_url_service.h"
+#include "extensions/features/features.h"
 #include "media/media_features.h"
 #include "ppapi/features/features.h"
 
 #if BUILDFLAG(ENABLE_PLUGINS)
 #include "chrome/browser/pepper_flash_settings_manager.h"
 #endif
 
 #if defined(OS_CHROMEOS)
 #include "chromeos/dbus/dbus_method_call_status.h"
 #endif
 
 class BrowsingDataFlashLSOHelper;
 class Profile;
 class WebappRegistry;
 
 namespace content {
 class BrowserContext;
 class PluginDataRemover;
 }
 
 // A delegate used by BrowsingDataRemover to delete data specific to Chrome
 // as the embedder.
 class ChromeBrowsingDataRemoverDelegate : public BrowsingDataRemoverDelegate
 #if BUILDFLAG(ENABLE_PLUGINS)
     , public PepperFlashSettingsManager::Client
 #endif
 {
  public:
+  // This is an extension of BrowsingDataRemover::RemoveDataMask which includes
+  // all datatypes therefrom and adds additional Chrome-specific ones.
+  // TODO(crbug.com/668114): Extend this to uint64_t to ensure that we won't
+  // run out of space anytime soon.
+  enum DataType {
+    // Inherited from BrowsingDataRemover.
+    DATA_TYPE_APP_CACHE = BrowsingDataRemover::DATA_TYPE_APP_CACHE,

[jam, 2017/03/10 16:13:42]

why do you duplicate the list in content here? Now every time content changes,
chrome has to as well.

Is this just to avoid having different namespaces? If so I don't think this is
something that matters; this is what we do today for all the other enums that
chrome/ extends.

+    DATA_TYPE_FILE_SYSTEMS = BrowsingDataRemover::DATA_TYPE_FILE_SYSTEMS,
+    DATA_TYPE_INDEXED_DB = BrowsingDataRemover::DATA_TYPE_INDEXED_DB,
+    DATA_TYPE_LOCAL_STORAGE = BrowsingDataRemover::DATA_TYPE_LOCAL_STORAGE,
+    DATA_TYPE_WEB_SQL = BrowsingDataRemover::DATA_TYPE_WEB_SQL,
+    DATA_TYPE_SERVICE_WORKERS = BrowsingDataRemover::DATA_TYPE_SERVICE_WORKERS,
+    DATA_TYPE_CACHE_STORAGE = BrowsingDataRemover::DATA_TYPE_CACHE_STORAGE,
+    DATA_TYPE_COOKIES = BrowsingDataRemover::DATA_TYPE_COOKIES,
+    DATA_TYPE_CHANNEL_IDS = BrowsingDataRemover::DATA_TYPE_CHANNEL_IDS,
+    DATA_TYPE_CACHE = BrowsingDataRemover::DATA_TYPE_CACHE,
+    DATA_TYPE_DOWNLOADS = BrowsingDataRemover::DATA_TYPE_DOWNLOADS,
+    DATA_TYPE_MEDIA_LICENSES = BrowsingDataRemover::DATA_TYPE_MEDIA_LICENSES,
+    DATA_TYPE_NO_CHECKS = BrowsingDataRemover::DATA_TYPE_NO_CHECKS,
+
+    // Embedder can start adding datatypes after the last platform datatype.
+    DATA_TYPE_EMBEDDER_BEGIN = BrowsingDataRemover::DATA_TYPE_CONTENT_END << 1,
+
+    // Chrome-specific datatypes.
+    DATA_TYPE_HISTORY = DATA_TYPE_EMBEDDER_BEGIN,
+    DATA_TYPE_FORM_DATA = DATA_TYPE_EMBEDDER_BEGIN << 1,
+    DATA_TYPE_PASSWORDS = DATA_TYPE_EMBEDDER_BEGIN << 2,
+    DATA_TYPE_PLUGIN_DATA = DATA_TYPE_EMBEDDER_BEGIN << 3,
+#if defined(OS_ANDROID)
+    DATA_TYPE_WEB_APP_DATA = DATA_TYPE_EMBEDDER_BEGIN << 4,
+#endif
+    DATA_TYPE_SITE_USAGE_DATA = DATA_TYPE_EMBEDDER_BEGIN << 5,
+    DATA_TYPE_DURABLE_PERMISSION = DATA_TYPE_EMBEDDER_BEGIN << 6,
+    DATA_TYPE_EXTERNAL_PROTOCOL_DATA = DATA_TYPE_EMBEDDER_BEGIN << 7,
+    DATA_TYPE_HOSTED_APP_DATA_TEST_ONLY = DATA_TYPE_EMBEDDER_BEGIN << 8,
+
+    // Group datatypes.
+
+    // "Site data" includes storage backend accessible to websites and some
+    // additional metadata kept by the browser (e.g. site usage data).
+    DATA_TYPE_SITE_DATA = DATA_TYPE_APP_CACHE |
+                          DATA_TYPE_COOKIES |
+                          DATA_TYPE_FILE_SYSTEMS |
+                          DATA_TYPE_INDEXED_DB |
+                          DATA_TYPE_LOCAL_STORAGE |
+                          DATA_TYPE_PLUGIN_DATA |
+                          DATA_TYPE_SERVICE_WORKERS |
+                          DATA_TYPE_CACHE_STORAGE |
+                          DATA_TYPE_WEB_SQL |
+                          DATA_TYPE_CHANNEL_IDS |
+#if defined(OS_ANDROID)
+                          DATA_TYPE_WEB_APP_DATA |
+#endif
+                          DATA_TYPE_SITE_USAGE_DATA |
+                          DATA_TYPE_DURABLE_PERMISSION |
+                          DATA_TYPE_EXTERNAL_PROTOCOL_DATA,
+
+    // Datatypes protected by Important Sites.
+    IMPORTANT_SITES_DATA_TYPES = DATA_TYPE_SITE_DATA | DATA_TYPE_CACHE,
+
+    // Datatypes that can be deleted partially per URL / origin / domain,
+    // whichever makes sense.
+    FILTERABLE_DATA_TYPES = DATA_TYPE_SITE_DATA |
+                            DATA_TYPE_CACHE |
+                            DATA_TYPE_DOWNLOADS,
+
+    // 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.
+    ALL_DATA_TYPES = DATA_TYPE_SITE_DATA |
+                     DATA_TYPE_CACHE |
+                     DATA_TYPE_DOWNLOADS |
+                     DATA_TYPE_FORM_DATA |
+                     DATA_TYPE_HISTORY |
+                     DATA_TYPE_PASSWORDS |
+                     DATA_TYPE_MEDIA_LICENSES,
+
+    // Includes all available remove options. Meant to be used when the Profile
+    // is scheduled to be deleted, and all possible data should be wiped from
+    // disk as soon as possible.
+    WIPE_PROFILE = ALL_DATA_TYPES | DATA_TYPE_NO_CHECKS,
+  };
+
+  // This is an extension of BrowsingDataRemover::OriginType which includes all
+  // origin types therefrom and adds additional Chrome-specific ones.
+  enum OriginType {
+    // Types inherited from BrowsingDataRemover::OriginType.
+
+    // Origins not protected by a special storage policy; this is most of
+    // the web.
+    ORIGIN_TYPE_UNPROTECTED_WEB =
+        BrowsingDataRemover::ORIGIN_TYPE_UNPROTECTED_WEB,
+
+    // Origins that are protected by a special storage policy; in Chrome's case,
+    // these are origins for which there is a hosted application installed.
+    ORIGIN_TYPE_PROTECTED_WEB =
+        BrowsingDataRemover::ORIGIN_TYPE_PROTECTED_WEB,
+
+    // Embedder can start adding origin types after the last
+    // platform origin type.
+    ORIGIN_TYPE_EMBEDDER_BEGIN =
+        BrowsingDataRemover::ORIGIN_TYPE_CONTENT_END << 1,
+
+#if BUILDFLAG(ENABLE_EXTENSIONS)
+    // Packaged apps and extensions (chrome-extension://*).
+    ORIGIN_TYPE_EXTENSION = ORIGIN_TYPE_EMBEDDER_BEGIN,
+#endif
+
+    // All origin types.
+    ALL_ORIGIN_TYPES = ORIGIN_TYPE_UNPROTECTED_WEB |
+#if BUILDFLAG(ENABLE_EXTENSIONS)
+                       ORIGIN_TYPE_EXTENSION |
+#endif
+                       ORIGIN_TYPE_PROTECTED_WEB,
+  };
+
+  // Important sites protect a small set of sites from the deletion of certain
+  // datatypes. Therefore, those datatypes must be filterable by
+  // url/origin/domain.
+  static_assert(0 == (IMPORTANT_SITES_DATA_TYPES & ~FILTERABLE_DATA_TYPES),

[Bernhard Bauer, 2017/03/09 17:35:48]

Nit: Can you flip the condition around so it reads more straightforward? It's
not like we have to avoid an accidental assignment here anyway.

[msramek, 2017/03/13 17:57:33]

Done.

+                "All important sites datatypes must be filterable.");
+
   // Used to track the deletion of a single data storage backend.
   class SubTask {
    public:
     // Creates a SubTask that calls |forward_callback| when completed.
     // |forward_callback| is only kept as a reference and must outlive SubTask.
     explicit SubTask(const base::Closure& forward_callback);
     ~SubTask();
 
     // Indicate that the task is in progress and we're waiting.
     void Start();
 
     // Returns a callback that should be called to indicate that the task
     // has been finished.
     base::Closure GetCompletionCallback();
 
     // Whether the task is still in progress.
     bool is_pending() const { return is_pending_; }
 
    private:
     void CompletionCallback();
 
     bool is_pending_;
     const base::Closure& forward_callback_;
     base::WeakPtrFactory<SubTask> weak_ptr_factory_;
   };
 
   ChromeBrowsingDataRemoverDelegate(content::BrowserContext* browser_context);
   ~ChromeBrowsingDataRemoverDelegate() override;
 
-  // Removes Chrome-specific data.
+  // BrowsingDataRemoverDelegate:
+  bool DoesOriginMatchEmbedderMask(
+      int origin_type_mask,
+      const GURL& origin,
+      storage::SpecialStoragePolicy* special_storage_policy) const override;
   void RemoveEmbedderData(
       const base::Time& delete_begin,
       const base::Time& delete_end,
       int remove_mask,
       const content::BrowsingDataFilterBuilder& filter_builder,
       int origin_type_mask,
       const base::Closure& callback) override;
 
 #if defined(OS_ANDROID)
   void OverrideWebappRegistryForTesting(
@@ skipping 114 matching lines @@
   // not initialised, so the registry must be mocked out.
   std::unique_ptr<WebappRegistry> webapp_registry_;
 #endif
 
   base::WeakPtrFactory<ChromeBrowsingDataRemoverDelegate> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(ChromeBrowsingDataRemoverDelegate);
 };
 
 #endif  // CHROME_BROWSER_BROWSING_DATA_CHROME_BROWSING_DATA_REMOVER_DELEGATE_H_