content/browser/storage_partition_impl.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CONTENT_BROWSER_STORAGE_PARTITION_IMPL_H_
   6 #define CONTENT_BROWSER_STORAGE_PARTITION_IMPL_H_
   7
   8 #include "base/compiler_specific.h"
   9 #include "base/files/file_path.h"
  10 #include "base/memory/ref_counted.h"
  11 #include "content/browser/appcache/chrome_appcache_service.h"
  12 #include "content/browser/background_sync/background_sync_context_impl.h"
  13 #include "content/browser/cache_storage/cache_storage_context_impl.h"
  14 #include "content/browser/dom_storage/dom_storage_context_wrapper.h"
  15 #include "content/browser/host_zoom_level_context.h"
  16 #include "content/browser/indexed_db/indexed_db_context_impl.h"
  17 #include "content/browser/media/webrtc_identity_store.h"
  18 #include "content/browser/navigator_connect/navigator_connect_context_impl.h"
  19 #include "content/browser/notifications/platform_notification_context_impl.h"
  20 #include "content/browser/service_worker/service_worker_context_wrapper.h"
  21 #include "content/common/content_export.h"
  22 #include "content/public/browser/storage_partition.h"
  23 #include "storage/browser/quota/special_storage_policy.h"
  24
  25 namespace content {
  26
  27 class StoragePartitionImpl : public StoragePartition {
  28  public:
  29   CONTENT_EXPORT ~StoragePartitionImpl() override;
  30
  31   // Quota managed data uses a different bitmask for types than
  32   // StoragePartition uses. This method generates that mask.
  33   CONTENT_EXPORT static int GenerateQuotaClientMask(uint32 remove_mask);
  34
  35   CONTENT_EXPORT void OverrideQuotaManagerForTesting(
  36       storage::QuotaManager* quota_manager);
  37   CONTENT_EXPORT void OverrideSpecialStoragePolicyForTesting(
  38       storage::SpecialStoragePolicy* special_storage_policy);
  39
  40   // StoragePartition interface.
  41   base::FilePath GetPath() override;
  42   net::URLRequestContextGetter* GetURLRequestContext() override;
  43   net::URLRequestContextGetter* GetMediaURLRequestContext() override;
  44   storage::QuotaManager* GetQuotaManager() override;
  45   ChromeAppCacheService* GetAppCacheService() override;
  46   storage::FileSystemContext* GetFileSystemContext() override;
  47   storage::DatabaseTracker* GetDatabaseTracker() override;
  48   DOMStorageContextWrapper* GetDOMStorageContext() override;
  49   IndexedDBContextImpl* GetIndexedDBContext() override;
  50   // TODO(jsbell): Expose this on the public API as well. crbug.com/466371
  51   CacheStorageContextImpl* GetCacheStorageContext();
  52   ServiceWorkerContextWrapper* GetServiceWorkerContext() override;
  53   GeofencingManager* GetGeofencingManager() override;
  54   HostZoomMap* GetHostZoomMap() override;
  55   HostZoomLevelContext* GetHostZoomLevelContext() override;
  56   ZoomLevelDelegate* GetZoomLevelDelegate() override;
  57   NavigatorConnectContextImpl* GetNavigatorConnectContext() override;
  58   PlatformNotificationContextImpl* GetPlatformNotificationContext() override;
  59   BackgroundSyncContextImpl* GetBackgroundSyncContext();
  60
  61   void ClearDataForOrigin(uint32 remove_mask,
  62                           uint32 quota_storage_remove_mask,
  63                           const GURL& storage_origin,
  64                           net::URLRequestContextGetter* request_context_getter,
  65                           const base::Closure& callback) override;
  66   void ClearData(uint32 remove_mask,
  67                  uint32 quota_storage_remove_mask,
  68                  const GURL& storage_origin,
  69                  const OriginMatcherFunction& origin_matcher,
  70                  const base::Time begin,
  71                  const base::Time end,
  72                  const base::Closure& callback) override;
  73
  74   void Flush() override;
  75
  76   WebRTCIdentityStore* GetWebRTCIdentityStore();
  77
  78   // Can return nullptr while |this| is being destroyed.
  79   BrowserContext* browser_context() const;
  80
  81   struct DataDeletionHelper;
  82   struct QuotaManagedDataDeletionHelper;
  83
  84  private:
  85   friend class StoragePartitionImplMap;
  86   FRIEND_TEST_ALL_PREFIXES(StoragePartitionShaderClearTest, ClearShaderCache);
  87   FRIEND_TEST_ALL_PREFIXES(StoragePartitionImplTest,
  88                            RemoveQuotaManagedDataForeverBoth);
  89   FRIEND_TEST_ALL_PREFIXES(StoragePartitionImplTest,
  90                            RemoveQuotaManagedDataForeverOnlyTemporary);
  91   FRIEND_TEST_ALL_PREFIXES(StoragePartitionImplTest,
  92                            RemoveQuotaManagedDataForeverOnlyPersistent);
  93   FRIEND_TEST_ALL_PREFIXES(StoragePartitionImplTest,
  94                            RemoveQuotaManagedDataForeverNeither);
  95   FRIEND_TEST_ALL_PREFIXES(StoragePartitionImplTest,
  96                            RemoveQuotaManagedDataForeverSpecificOrigin);
  97   FRIEND_TEST_ALL_PREFIXES(StoragePartitionImplTest,
  98                            RemoveQuotaManagedDataForLastHour);
  99   FRIEND_TEST_ALL_PREFIXES(StoragePartitionImplTest,
 100                            RemoveQuotaManagedDataForLastWeek);
 101   FRIEND_TEST_ALL_PREFIXES(StoragePartitionImplTest,
 102                            RemoveQuotaManagedUnprotectedOrigins);
 103   FRIEND_TEST_ALL_PREFIXES(StoragePartitionImplTest,
 104                            RemoveQuotaManagedProtectedSpecificOrigin);
 105   FRIEND_TEST_ALL_PREFIXES(StoragePartitionImplTest,
 106                            RemoveQuotaManagedProtectedOrigins);
 107   FRIEND_TEST_ALL_PREFIXES(StoragePartitionImplTest,
 108                            RemoveQuotaManagedIgnoreDevTools);
 109   FRIEND_TEST_ALL_PREFIXES(StoragePartitionImplTest, RemoveCookieForever);
 110   FRIEND_TEST_ALL_PREFIXES(StoragePartitionImplTest, RemoveCookieLastHour);
 111   FRIEND_TEST_ALL_PREFIXES(StoragePartitionImplTest,
 112                            RemoveUnprotectedLocalStorageForever);
 113   FRIEND_TEST_ALL_PREFIXES(StoragePartitionImplTest,
 114                            RemoveProtectedLocalStorageForever);
 115   FRIEND_TEST_ALL_PREFIXES(StoragePartitionImplTest,
 116                            RemoveLocalStorageForLastWeek);
 117
 118   // The |partition_path| is the absolute path to the root of this
 119   // StoragePartition's on-disk storage.
 120   //
 121   // If |in_memory| is true, the |partition_path| is (ab)used as a way of
 122   // distinguishing different in-memory partitions, but nothing is persisted
 123   // on to disk.
 124   static StoragePartitionImpl* Create(BrowserContext* context,
 125                                       bool in_memory,
 126                                       const base::FilePath& profile_path);
 127
 128   CONTENT_EXPORT StoragePartitionImpl(
 129       BrowserContext* browser_context,
 130       const base::FilePath& partition_path,
 131       storage::QuotaManager* quota_manager,
 132       ChromeAppCacheService* appcache_service,
 133       storage::FileSystemContext* filesystem_context,
 134       storage::DatabaseTracker* database_tracker,
 135       DOMStorageContextWrapper* dom_storage_context,
 136       IndexedDBContextImpl* indexed_db_context,
 137       CacheStorageContextImpl* cache_storage_context,
 138       ServiceWorkerContextWrapper* service_worker_context,
 139       WebRTCIdentityStore* webrtc_identity_store,
 140       storage::SpecialStoragePolicy* special_storage_policy,
 141       GeofencingManager* geofencing_manager,
 142       HostZoomLevelContext* host_zoom_level_context,
 143       NavigatorConnectContextImpl* navigator_connect_context,
 144       PlatformNotificationContextImpl* platform_notification_context,
 145       BackgroundSyncContextImpl* background_sync_context);
 146
 147   void ClearDataImpl(uint32 remove_mask,
 148                      uint32 quota_storage_remove_mask,
 149                      const GURL& remove_origin,
 150                      const OriginMatcherFunction& origin_matcher,
 151                      net::URLRequestContextGetter* rq_context,
 152                      const base::Time begin,
 153                      const base::Time end,
 154                      const base::Closure& callback);
 155
 156   // Used by StoragePartitionImplMap.
 157   //
 158   // TODO(ajwong): These should be taken in the constructor and in Create() but
 159   // because the URLRequestContextGetter still lives in Profile with a tangled
 160   // initialization, if we try to retrieve the URLRequestContextGetter()
 161   // before the default StoragePartition is created, we end up reentering the
 162   // construction and double-initializing.  For now, we retain the legacy
 163   // behavior while allowing StoragePartitionImpl to expose these accessors by
 164   // letting StoragePartitionImplMap call these two private settings at the
 165   // appropriate time.  These should move back into the constructor once
 166   // URLRequestContextGetter's lifetime is sorted out. We should also move the
 167   // PostCreateInitialization() out of StoragePartitionImplMap.
 168   CONTENT_EXPORT void SetURLRequestContext(
 169       net::URLRequestContextGetter* url_request_context);
 170   void SetMediaURLRequestContext(
 171       net::URLRequestContextGetter* media_url_request_context);
 172
 173   base::FilePath partition_path_;
 174   scoped_refptr<net::URLRequestContextGetter> url_request_context_;
 175   scoped_refptr<net::URLRequestContextGetter> media_url_request_context_;
 176   scoped_refptr<storage::QuotaManager> quota_manager_;
 177   scoped_refptr<ChromeAppCacheService> appcache_service_;
 178   scoped_refptr<storage::FileSystemContext> filesystem_context_;
 179   scoped_refptr<storage::DatabaseTracker> database_tracker_;
 180   scoped_refptr<DOMStorageContextWrapper> dom_storage_context_;
 181   scoped_refptr<IndexedDBContextImpl> indexed_db_context_;
 182   scoped_refptr<CacheStorageContextImpl> cache_storage_context_;
 183   scoped_refptr<ServiceWorkerContextWrapper> service_worker_context_;
 184   scoped_refptr<WebRTCIdentityStore> webrtc_identity_store_;
 185   scoped_refptr<storage::SpecialStoragePolicy> special_storage_policy_;
 186   scoped_refptr<GeofencingManager> geofencing_manager_;
 187   scoped_refptr<HostZoomLevelContext> host_zoom_level_context_;
 188   scoped_refptr<NavigatorConnectContextImpl> navigator_connect_context_;
 189   scoped_refptr<PlatformNotificationContextImpl> platform_notification_context_;
 190   scoped_refptr<BackgroundSyncContextImpl> background_sync_context_;
 191
 192   // Raw pointer that should always be valid. The BrowserContext owns the
 193   // StoragePartitionImplMap which then owns StoragePartitionImpl. When the
 194   // BrowserContext is destroyed, |this| will be destroyed too.
 195   BrowserContext* browser_context_;
 196
 197   DISALLOW_COPY_AND_ASSIGN(StoragePartitionImpl);
 198 };
 199
 200 }  // namespace content
 201
 202 #endif  // CONTENT_BROWSER_STORAGE_PARTITION_IMPL_H_