dom/cache/CacheStorage.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_cache_CacheStorage_h
   8 #define mozilla_dom_cache_CacheStorage_h
   9
  10 #include "mozilla/UniquePtr.h"
  11 #include "mozilla/dom/cache/Types.h"
  12 #include "mozilla/dom/cache/TypeUtils.h"
  13 #include "nsCOMPtr.h"
  14 #include "nsISupportsImpl.h"
  15 #include "nsTArray.h"
  16 #include "nsWrapperCache.h"
  17
  18 class nsIGlobalObject;
  19
  20 namespace mozilla {
  21
  22 class ErrorResult;
  23 enum UseCounter : int16_t;
  24 enum class UseCounterWorker : int16_t;
  25
  26 namespace ipc {
  27 class PrincipalInfo;
  28 }  // namespace ipc
  29
  30 namespace dom {
  31
  32 enum class CacheStorageNamespace : uint8_t;
  33 class Promise;
  34 class WorkerPrivate;
  35
  36 namespace cache {
  37
  38 class CacheStorageChild;
  39 class CacheWorkerRef;
  40
  41 class CacheStorage final : public nsISupports,
  42                            public nsWrapperCache,
  43                            public TypeUtils {
  44   using PBackgroundChild = mozilla::ipc::PBackgroundChild;
  45
  46  public:
  47   static already_AddRefed<CacheStorage> CreateOnMainThread(
  48       Namespace aNamespace, nsIGlobalObject* aGlobal, nsIPrincipal* aPrincipal,
  49       bool aForceTrustedOrigin, ErrorResult& aRv);
  50
  51   static already_AddRefed<CacheStorage> CreateOnWorker(
  52       Namespace aNamespace, nsIGlobalObject* aGlobal,
  53       WorkerPrivate* aWorkerPrivate, ErrorResult& aRv);
  54
  55   static bool DefineCachesForSandbox(JSContext* aCx,
  56                                      JS::Handle<JSObject*> aGlobal);
  57
  58   // webidl interface methods
  59   already_AddRefed<Promise> Match(JSContext* aCx,
  60                                   const RequestOrUTF8String& aRequest,
  61                                   const MultiCacheQueryOptions& aOptions,
  62                                   ErrorResult& aRv);
  63   already_AddRefed<Promise> Has(const nsAString& aKey, ErrorResult& aRv);
  64   already_AddRefed<Promise> Open(const nsAString& aKey, ErrorResult& aRv);
  65   already_AddRefed<Promise> Delete(const nsAString& aKey, ErrorResult& aRv);
  66   already_AddRefed<Promise> Keys(ErrorResult& aRv);
  67
  68   // chrome-only webidl interface methods
  69   static already_AddRefed<CacheStorage> Constructor(
  70       const GlobalObject& aGlobal, CacheStorageNamespace aNamespace,
  71       nsIPrincipal* aPrincipal, ErrorResult& aRv);
  72
  73   // binding methods
  74   nsISupports* GetParentObject() const;
  75   virtual JSObject* WrapObject(JSContext* aContext,
  76                                JS::Handle<JSObject*> aGivenProto) override;
  77
  78   // Called when CacheStorageChild actor is being destroyed
  79   void DestroyInternal(CacheStorageChild* aActor);
  80
  81   // TypeUtils methods
  82   virtual nsIGlobalObject* GetGlobalObject() const override;
  83 #ifdef DEBUG
  84   virtual void AssertOwningThread() const override;
  85 #endif
  86
  87   virtual mozilla::ipc::PBackgroundChild* GetIPCManager() override;
  88
  89  private:
  90   CacheStorage(Namespace aNamespace, nsIGlobalObject* aGlobal,
  91                const mozilla::ipc::PrincipalInfo& aPrincipalInfo,
  92                SafeRefPtr<CacheWorkerRef> aWorkerRef);
  93   explicit CacheStorage(nsresult aFailureResult);
  94   ~CacheStorage();
  95
  96   struct Entry;
  97   void RunRequest(UniquePtr<Entry> aEntry);
  98
  99   OpenMode GetOpenMode() const;
 100
 101   bool HasStorageAccess(UseCounter aLabel, UseCounterWorker aLabelWorker) const;
 102
 103   const Namespace mNamespace;
 104   nsCOMPtr<nsIGlobalObject> mGlobal;
 105   const UniquePtr<mozilla::ipc::PrincipalInfo> mPrincipalInfo;
 106
 107   // weak ref cleared in DestroyInternal
 108   CacheStorageChild* mActor;
 109
 110   nsresult mStatus;
 111
 112  public:
 113   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
 114   NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(CacheStorage)
 115 };
 116
 117 }  // namespace cache
 118 }  // namespace dom
 119 }  // namespace mozilla
 120
 121 #endif  // mozilla_dom_cache_CacheStorage_h