/* 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_Cache_h
#define mozilla_dom_cache_Cache_h

#include "mozilla/dom/cache/TypeUtils.h"
#include "mozilla/dom/cache/Types.h"
#include "nsCOMPtr.h"
#include "nsISupportsImpl.h"
#include "nsString.h"
#include "nsWrapperCache.h"

class nsIGlobalObject;

namespace mozilla {

class ErrorResult;

namespace dom {

class OwningRequestOrUTF8String;
class Promise;
struct CacheQueryOptions;
class RequestOrUTF8String;
class Response;
template <typename T>
class Optional;
template <typename T>
class Sequence;
enum class CallerType : uint32_t;

namespace cache {

class AutoChildOpArgs;
class CacheChild;

enum class PutStatusPolicy { Default, RequireOK };
bool IsValidPutRequestURL(nsIURI* aUrl, ErrorResult& aRv);
bool IsValidPutRequestMethod(const RequestOrUTF8String& aRequest,
                             ErrorResult& aRv);
bool IsValidPutRequestMethod(const Request& aRequest, ErrorResult& aRv);
bool IsValidPutResponseStatus(Response& aResponse, PutStatusPolicy aPolicy,
                              ErrorResult& aRv);

class Cache final : public nsISupports,
                    public nsWrapperCache,
                    public TypeUtils,
                    public CacheChildListener {
 public:
  Cache(nsIGlobalObject* aGlobal, CacheChild* aActor, Namespace aNamespace);

  static bool CachesEnabled(JSContext* aCx, JSObject*);

  // webidl interface methods
  already_AddRefed<Promise> Match(JSContext* aCx,
                                  const RequestOrUTF8String& aRequest,
                                  const CacheQueryOptions& aOptions,
                                  ErrorResult& aRv);
  already_AddRefed<Promise> MatchAll(
      JSContext* aCx, const Optional<RequestOrUTF8String>& aRequest,
      const CacheQueryOptions& aOptions, ErrorResult& aRv);
  already_AddRefed<Promise> Add(JSContext* aContext,
                                const RequestOrUTF8String& aRequest,
                                CallerType aCallerType, ErrorResult& aRv);
  already_AddRefed<Promise> AddAll(
      JSContext* aContext, const Sequence<OwningRequestOrUTF8String>& aRequests,
      CallerType aCallerType, ErrorResult& aRv);
  already_AddRefed<Promise> Put(JSContext* aCx,
                                const RequestOrUTF8String& aRequest,
                                Response& aResponse, ErrorResult& aRv);
  already_AddRefed<Promise> Delete(JSContext* aCx,
                                   const RequestOrUTF8String& aRequest,
                                   const CacheQueryOptions& aOptions,
                                   ErrorResult& aRv);
  already_AddRefed<Promise> Keys(JSContext* aCx,
                                 const Optional<RequestOrUTF8String>& aRequest,
                                 const CacheQueryOptions& aParams,
                                 ErrorResult& aRv);

  // binding methods
  nsISupports* GetParentObject() const;
  virtual JSObject* WrapObject(JSContext* aContext,
                               JS::Handle<JSObject*> aGivenProto) override;

  // Called when CacheChild actor is being destroyed.
  // Overrides CacheChildListener method
  void OnActorDestroy(CacheChild* aActor) override;

  // TypeUtils methods
  virtual nsIGlobalObject* GetGlobalObject() const override;

#ifdef DEBUG
  virtual void AssertOwningThread() const override;
#endif

 private:
  class FetchHandler;

  ~Cache();

  // Called when we're destroyed or CCed.
  void DisconnectFromActor();

  already_AddRefed<Promise> ExecuteOp(AutoChildOpArgs& aOpArgs,
                                      ErrorResult& aRv);

  already_AddRefed<Promise> AddAll(const GlobalObject& aGlobal,
                                   nsTArray<SafeRefPtr<Request>>&& aRequestList,
                                   CallerType aCallerType, ErrorResult& aRv);

  already_AddRefed<Promise> PutAll(
      JSContext* aCx, const nsTArray<SafeRefPtr<Request>>& aRequestList,
      const nsTArray<RefPtr<Response>>& aResponseList, ErrorResult& aRv);

  OpenMode GetOpenMode() const;

  nsCOMPtr<nsIGlobalObject> mGlobal;
  CacheChild* mActor;
  const Namespace mNamespace;

 public:
  NS_DECL_CYCLE_COLLECTING_ISUPPORTS_FINAL
  NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(Cache)
};

}  // namespace cache
}  // namespace dom
}  // namespace mozilla

#endif  // mozilla_dom_Cache_h