diff options
Diffstat (limited to 'dom/cache/CacheStorage.h')
-rw-r--r-- | dom/cache/CacheStorage.h | 120 |
1 files changed, 120 insertions, 0 deletions
diff --git a/dom/cache/CacheStorage.h b/dom/cache/CacheStorage.h new file mode 100644 index 0000000000..306c7cccd4 --- /dev/null +++ b/dom/cache/CacheStorage.h @@ -0,0 +1,120 @@ +/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* vim: set ts=8 sts=2 et sw=2 tw=80: */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +#ifndef mozilla_dom_cache_CacheStorage_h +#define mozilla_dom_cache_CacheStorage_h + +#include "mozilla/UniquePtr.h" +#include "mozilla/dom/cache/Types.h" +#include "mozilla/dom/cache/TypeUtils.h" +#include "nsCOMPtr.h" +#include "nsISupportsImpl.h" +#include "nsTArray.h" +#include "nsWrapperCache.h" + +class nsIGlobalObject; + +namespace mozilla { + +class ErrorResult; +enum UseCounter : int16_t; +enum class UseCounterWorker : int16_t; + +namespace ipc { +class PrincipalInfo; +} // namespace ipc + +namespace dom { + +enum class CacheStorageNamespace : uint8_t; +class Promise; +class WorkerPrivate; + +namespace cache { + +class CacheStorageChild; +class CacheWorkerRef; + +class CacheStorage final : public nsISupports, + public nsWrapperCache, + public TypeUtils { + using PBackgroundChild = mozilla::ipc::PBackgroundChild; + + public: + static already_AddRefed<CacheStorage> CreateOnMainThread( + Namespace aNamespace, nsIGlobalObject* aGlobal, nsIPrincipal* aPrincipal, + bool aForceTrustedOrigin, ErrorResult& aRv); + + static already_AddRefed<CacheStorage> CreateOnWorker( + Namespace aNamespace, nsIGlobalObject* aGlobal, + WorkerPrivate* aWorkerPrivate, ErrorResult& aRv); + + static bool DefineCaches(JSContext* aCx, JS::Handle<JSObject*> aGlobal); + + // webidl interface methods + already_AddRefed<Promise> Match(JSContext* aCx, + const RequestOrUSVString& aRequest, + const MultiCacheQueryOptions& aOptions, + ErrorResult& aRv); + already_AddRefed<Promise> Has(const nsAString& aKey, ErrorResult& aRv); + already_AddRefed<Promise> Open(const nsAString& aKey, ErrorResult& aRv); + already_AddRefed<Promise> Delete(const nsAString& aKey, ErrorResult& aRv); + already_AddRefed<Promise> Keys(ErrorResult& aRv); + + // chrome-only webidl interface methods + static already_AddRefed<CacheStorage> Constructor( + const GlobalObject& aGlobal, CacheStorageNamespace aNamespace, + nsIPrincipal* aPrincipal, ErrorResult& aRv); + + // binding methods + nsISupports* GetParentObject() const; + virtual JSObject* WrapObject(JSContext* aContext, + JS::Handle<JSObject*> aGivenProto) override; + + // Called when CacheStorageChild actor is being destroyed + void DestroyInternal(CacheStorageChild* aActor); + + // TypeUtils methods + virtual nsIGlobalObject* GetGlobalObject() const override; +#ifdef DEBUG + virtual void AssertOwningThread() const override; +#endif + + virtual mozilla::ipc::PBackgroundChild* GetIPCManager() override; + + private: + CacheStorage(Namespace aNamespace, nsIGlobalObject* aGlobal, + const mozilla::ipc::PrincipalInfo& aPrincipalInfo, + SafeRefPtr<CacheWorkerRef> aWorkerRef); + explicit CacheStorage(nsresult aFailureResult); + ~CacheStorage(); + + struct Entry; + void RunRequest(UniquePtr<Entry> aEntry); + + OpenMode GetOpenMode() const; + + bool HasStorageAccess(UseCounter aLabel, UseCounterWorker aLabelWorker) const; + + const Namespace mNamespace; + nsCOMPtr<nsIGlobalObject> mGlobal; + const UniquePtr<mozilla::ipc::PrincipalInfo> mPrincipalInfo; + + // weak ref cleared in DestroyInternal + CacheStorageChild* mActor; + + nsresult mStatus; + + public: + NS_DECL_CYCLE_COLLECTING_ISUPPORTS + NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(CacheStorage) +}; + +} // namespace cache +} // namespace dom +} // namespace mozilla + +#endif // mozilla_dom_cache_CacheStorage_h |