/* -*- 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/. */

#include "mozilla/dom/cache/Cache.h"

#include "mozilla/dom/Headers.h"

#include "mozilla/dom/InternalResponse.h"

#include "mozilla/dom/Promise.h"

#include "mozilla/dom/PromiseNativeHandler.h"

#include "mozilla/dom/Response.h"

#include "mozilla/dom/WorkerPrivate.h"

#include "mozilla/dom/CacheBinding.h"

#include "mozilla/dom/cache/AutoUtils.h"

#include "mozilla/dom/cache/CacheChild.h"

#include "mozilla/dom/cache/CacheWorkerHolder.h"

#include "mozilla/dom/cache/ReadStream.h"

#include "mozilla/dom/DOMPrefs.h"

#include "mozilla/ErrorResult.h"

#include "mozilla/Preferences.h"

#include "mozilla/Unused.h"

#include "nsIGlobalObject.h"

namespace mozilla {

namespace dom {

namespace cache {

using mozilla::ipc::PBackgroundChild;

namespace {

enum class PutStatusPolicy {

  Default,

  RequireOK

};

bool

IsValidPutRequestURL(const nsAString& aUrl, ErrorResult& aRv)

{

  bool validScheme = false;

  // make a copy because ProcessURL strips the fragmet

  NS_ConvertUTF16toUTF8 url(aUrl);

  TypeUtils::ProcessURL(url, &validScheme, nullptr, nullptr, aRv);

  if (aRv.Failed()) {

    return false;

  }

  if (!validScheme) {

    aRv.ThrowTypeError<MSG_INVALID_URL_SCHEME>(NS_LITERAL_STRING("Request"),

                                               aUrl);

    return false;

  }

  return true;

}

static bool

IsValidPutRequestMethod(const Request& aRequest, ErrorResult& aRv)

{

  nsAutoCString method;

  aRequest.GetMethod(method);

  if (!method.LowerCaseEqualsLiteral("get")) {

    NS_ConvertASCIItoUTF16 label(method);

    aRv.ThrowTypeError<MSG_INVALID_REQUEST_METHOD>(label);

    return false;

  }

  return true;

}

static bool

IsValidPutRequestMethod(const RequestOrUSVString& aRequest, ErrorResult& aRv)

{

  // If the provided request is a string URL, then it will default to

  // a valid http method automatically.

  if (!aRequest.IsRequest()) {

    return true;

  }

  return IsValidPutRequestMethod(aRequest.GetAsRequest(), aRv);

}

static bool

IsValidPutResponseStatus(Response& aResponse, PutStatusPolicy aPolicy,

                         ErrorResult& aRv)

{

  if ((aPolicy == PutStatusPolicy::RequireOK && !aResponse.Ok()) ||

      aResponse.Status() == 206) {

    uint32_t t = static_cast<uint32_t>(aResponse.Type());

    NS_ConvertASCIItoUTF16 type(ResponseTypeValues::strings[t].value,

                                ResponseTypeValues::strings[t].length);

    nsAutoString status;

    status.AppendInt(aResponse.Status());

    nsAutoString url;

    aResponse.GetUrl(url);

    aRv.ThrowTypeError<MSG_CACHE_ADD_FAILED_RESPONSE>(type, status, url);

    return false;

  }

  return true;

}

} // namespace

// Helper class to wait for Add()/AddAll() fetch requests to complete and

// then perform a PutAll() with the responses.  This class holds a WorkerHolder

// to keep the Worker thread alive.  This is mainly to ensure that Add/AddAll

// act the same as other Cache operations that directly create a CacheOpChild

// actor.

class Cache::FetchHandler final : public PromiseNativeHandler

{

public:

  FetchHandler(CacheWorkerHolder* aWorkerHolder, Cache* aCache,

               nsTArray<RefPtr<Request>>&& aRequestList, Promise* aPromise)

    : mWorkerHolder(aWorkerHolder)

    , mCache(aCache)

    , mRequestList(std::move(aRequestList))

    , mPromise(aPromise)

  {

    MOZ_ASSERT_IF(!NS_IsMainThread(), mWorkerHolder);

    MOZ_DIAGNOSTIC_ASSERT(mCache);

    MOZ_DIAGNOSTIC_ASSERT(mPromise);

  }

  virtual void

  ResolvedCallback(JSContext* aCx, JS::Handle<JS::Value> aValue) override

  {

    NS_ASSERT_OWNINGTHREAD(FetchHandler);

    // Stop holding the worker alive when we leave this method.

    RefPtr<CacheWorkerHolder> workerHolder;

    workerHolder.swap(mWorkerHolder);

    // Promise::All() passed an array of fetch() Promises should give us

    // an Array of Response objects.  The following code unwraps these

    // JS values back to an nsTArray<RefPtr<Response>>.

    AutoTArray<RefPtr<Response>, 256> responseList;

    responseList.SetCapacity(mRequestList.Length());

    bool isArray;

    if (NS_WARN_IF(!JS_IsArrayObject(aCx, aValue, &isArray) || !isArray)) {

      Fail();

      return;

    }

    JS::Rooted<JSObject*> obj(aCx, &aValue.toObject());

    uint32_t length;

    if (NS_WARN_IF(!JS_GetArrayLength(aCx, obj, &length))) {

      Fail();

      return;

    }

    for (uint32_t i = 0; i < length; ++i) {

      JS::Rooted<JS::Value> value(aCx);

      if (NS_WARN_IF(!JS_GetElement(aCx, obj, i, &value))) {

        Fail();

        return;

      }

      if (NS_WARN_IF(!value.isObject())) {

        Fail();

        return;

      }

      JS::Rooted<JSObject*> responseObj(aCx, &value.toObject());

      RefPtr<Response> response;

      nsresult rv = UNWRAP_OBJECT(Response, responseObj, response);

      if (NS_WARN_IF(NS_FAILED(rv))) {

        Fail();

        return;

      }

      if (NS_WARN_IF(response->Type() == ResponseType::Error)) {

        Fail();

        return;

      }

      // Do not allow the convenience methods .add()/.addAll() to store failed

      // or invalid responses.  A consequence of this is that these methods

      // cannot be used to store opaque or opaqueredirect responses since they

      // always expose a 0 status value.

      ErrorResult errorResult;

      if (!IsValidPutResponseStatus(*response, PutStatusPolicy::RequireOK,

                                    errorResult)) {

        // TODO: abort the fetch requests we have running (bug 1157434)

        mPromise->MaybeReject(errorResult);

        return;

      }

      responseList.AppendElement(std::move(response));

    }

    MOZ_DIAGNOSTIC_ASSERT(mRequestList.Length() == responseList.Length());

    // Now store the unwrapped Response list in the Cache.

    ErrorResult result;

    // TODO: Here we use the JSContext as received by the ResolvedCallback, and

    // its state could be the wrong one. The spec doesn't say anything

    // about it, yet (bug 1384006)

    RefPtr<Promise> put = mCache->PutAll(aCx, mRequestList, responseList, result);

    if (NS_WARN_IF(result.Failed())) {

      // TODO: abort the fetch requests we have running (bug 1157434)

      mPromise->MaybeReject(result);

      return;

    }

    // Chain the Cache::Put() promise to the original promise returned to

    // the content script.

    mPromise->MaybeResolve(put);

  }

  virtual void

  RejectedCallback(JSContext* aCx, JS::Handle<JS::Value> aValue) override

  {

    NS_ASSERT_OWNINGTHREAD(FetchHandler);

    Fail();

  }

private:

  ~FetchHandler()

  {

  }

  void

  Fail()

  {

    ErrorResult rv;

    rv.ThrowTypeError<MSG_FETCH_FAILED>();

    mPromise->MaybeReject(rv);

  }

  RefPtr<CacheWorkerHolder> mWorkerHolder;

  RefPtr<Cache> mCache;

  nsTArray<RefPtr<Request>> mRequestList;

  RefPtr<Promise> mPromise;

  NS_DECL_ISUPPORTS

};

NS_IMPL_ISUPPORTS0(Cache::FetchHandler)

NS_IMPL_CYCLE_COLLECTING_ADDREF(mozilla::dom::cache::Cache);

NS_IMPL_CYCLE_COLLECTING_RELEASE(mozilla::dom::cache::Cache);

NS_IMPL_CYCLE_COLLECTION_WRAPPERCACHE(mozilla::dom::cache::Cache, mGlobal);

NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(Cache)

  NS_WRAPPERCACHE_INTERFACE_MAP_ENTRY

  NS_INTERFACE_MAP_ENTRY(nsISupports)

NS_INTERFACE_MAP_END

Cache::Cache(nsIGlobalObject* aGlobal, CacheChild* aActor, Namespace aNamespace)

  : mGlobal(aGlobal)

  , mActor(aActor)

  , mNamespace(aNamespace)

{

  MOZ_DIAGNOSTIC_ASSERT(mGlobal);

  MOZ_DIAGNOSTIC_ASSERT(mActor);

  MOZ_DIAGNOSTIC_ASSERT(mNamespace != INVALID_NAMESPACE);

  mActor->SetListener(this);

}

already_AddRefed<Promise>

Cache::Match(JSContext* aCx, const RequestOrUSVString& aRequest,

             const CacheQueryOptions& aOptions, ErrorResult& aRv)

{

  if (NS_WARN_IF(!mActor)) {

    aRv.Throw(NS_ERROR_UNEXPECTED);

    return nullptr;

  }

  CacheChild::AutoLock actorLock(mActor);

  RefPtr<InternalRequest> ir =

    ToInternalRequest(aCx, aRequest, IgnoreBody, aRv);

  if (NS_WARN_IF(aRv.Failed())) {

    return nullptr;

  }

  CacheQueryParams params;

  ToCacheQueryParams(params, aOptions);

  AutoChildOpArgs args(this,

                       CacheMatchArgs(CacheRequest(), params, GetOpenMode()),

                       1);

  args.Add(ir, IgnoreBody, IgnoreInvalidScheme, aRv);

  if (NS_WARN_IF(aRv.Failed())) {

    return nullptr;

  }

  return ExecuteOp(args, aRv);

}

already_AddRefed<Promise>

Cache::MatchAll(JSContext* aCx, const Optional<RequestOrUSVString>& aRequest,

                const CacheQueryOptions& aOptions, ErrorResult& aRv)

{

  if (NS_WARN_IF(!mActor)) {

    aRv.Throw(NS_ERROR_UNEXPECTED);

    return nullptr;

  }

  CacheChild::AutoLock actorLock(mActor);

  CacheQueryParams params;

  ToCacheQueryParams(params, aOptions);

  AutoChildOpArgs args(this,

                       CacheMatchAllArgs(void_t(), params, GetOpenMode()),

                       1);

  if (aRequest.WasPassed()) {

    RefPtr<InternalRequest> ir = ToInternalRequest(aCx, aRequest.Value(),

                                                   IgnoreBody, aRv);

    if (aRv.Failed()) {

      return nullptr;

    }

    args.Add(ir, IgnoreBody, IgnoreInvalidScheme, aRv);

    if (aRv.Failed()) {

      return nullptr;

    }

  }

  return ExecuteOp(args, aRv);

}

already_AddRefed<Promise>

Cache::Add(JSContext* aContext, const RequestOrUSVString& aRequest,

           CallerType aCallerType, ErrorResult& aRv)

{

  if (NS_WARN_IF(!mActor)) {

    aRv.Throw(NS_ERROR_UNEXPECTED);

    return nullptr;

  }

  CacheChild::AutoLock actorLock(mActor);

  if (!IsValidPutRequestMethod(aRequest, aRv)) {

    return nullptr;

  }

  GlobalObject global(aContext, mGlobal->GetGlobalJSObject());

  MOZ_DIAGNOSTIC_ASSERT(!global.Failed());

  nsTArray<RefPtr<Request>> requestList(1);

  RefPtr<Request> request = Request::Constructor(global, aRequest,

                                                   RequestInit(), aRv);

  if (NS_WARN_IF(aRv.Failed())) {

    return nullptr;

  }

  nsAutoString url;

  request->GetUrl(url);

  if (NS_WARN_IF(!IsValidPutRequestURL(url, aRv))) {

    return nullptr;

  }

  requestList.AppendElement(std::move(request));

  return AddAll(global, std::move(requestList), aCallerType, aRv);

}

already_AddRefed<Promise>

Cache::AddAll(JSContext* aContext,

              const Sequence<OwningRequestOrUSVString>& aRequestList,

              CallerType aCallerType,

              ErrorResult& aRv)

{

  if (NS_WARN_IF(!mActor)) {

    aRv.Throw(NS_ERROR_UNEXPECTED);

    return nullptr;

  }

  CacheChild::AutoLock actorLock(mActor);

  GlobalObject global(aContext, mGlobal->GetGlobalJSObject());

  MOZ_DIAGNOSTIC_ASSERT(!global.Failed());

  nsTArray<RefPtr<Request>> requestList(aRequestList.Length());

  for (uint32_t i = 0; i < aRequestList.Length(); ++i) {

    RequestOrUSVString requestOrString;

    if (aRequestList[i].IsRequest()) {

      requestOrString.SetAsRequest() = aRequestList[i].GetAsRequest();

      if (NS_WARN_IF(!IsValidPutRequestMethod(requestOrString.GetAsRequest(),

                     aRv))) {

        return nullptr;

      }

    } else {

      requestOrString.SetAsUSVString().Rebind(

        aRequestList[i].GetAsUSVString().Data(),

        aRequestList[i].GetAsUSVString().Length());

    }

    RefPtr<Request> request = Request::Constructor(global, requestOrString,

                                                     RequestInit(), aRv);

    if (NS_WARN_IF(aRv.Failed())) {

      return nullptr;

    }

    nsAutoString url;

    request->GetUrl(url);

    if (NS_WARN_IF(!IsValidPutRequestURL(url, aRv))) {

      return nullptr;

    }

    requestList.AppendElement(std::move(request));

  }

  return AddAll(global, std::move(requestList), aCallerType, aRv);

}

already_AddRefed<Promise>

Cache::Put(JSContext* aCx, const RequestOrUSVString& aRequest,

           Response& aResponse, ErrorResult& aRv)

{

  if (NS_WARN_IF(!mActor)) {

    aRv.Throw(NS_ERROR_UNEXPECTED);

    return nullptr;

  }

  CacheChild::AutoLock actorLock(mActor);

  if (NS_WARN_IF(!IsValidPutRequestMethod(aRequest, aRv))) {

    return nullptr;

  }

  if (!IsValidPutResponseStatus(aResponse, PutStatusPolicy::Default, aRv)) {

    return nullptr;

  }

  RefPtr<InternalRequest> ir = ToInternalRequest(aCx, aRequest, ReadBody, aRv);

  if (NS_WARN_IF(aRv.Failed())) {

    return nullptr;

  }

  AutoChildOpArgs args(this, CachePutAllArgs(), 1);

  args.Add(aCx, ir, ReadBody, TypeErrorOnInvalidScheme,

           aResponse, aRv);

  if (NS_WARN_IF(aRv.Failed())) {

    return nullptr;

  }

  return ExecuteOp(args, aRv);

}

already_AddRefed<Promise>

Cache::Delete(JSContext* aCx, const RequestOrUSVString& aRequest,

              const CacheQueryOptions& aOptions, ErrorResult& aRv)

{

  if (NS_WARN_IF(!mActor)) {

    aRv.Throw(NS_ERROR_UNEXPECTED);

    return nullptr;

  }

  CacheChild::AutoLock actorLock(mActor);

  RefPtr<InternalRequest> ir =

    ToInternalRequest(aCx, aRequest, IgnoreBody, aRv);

  if (NS_WARN_IF(aRv.Failed())) {

    return nullptr;

  }

  CacheQueryParams params;

  ToCacheQueryParams(params, aOptions);

  AutoChildOpArgs args(this, CacheDeleteArgs(CacheRequest(), params), 1);

  args.Add(ir, IgnoreBody, IgnoreInvalidScheme, aRv);

  if (NS_WARN_IF(aRv.Failed())) {

    return nullptr;

  }

  return ExecuteOp(args, aRv);

}

already_AddRefed<Promise>

Cache::Keys(JSContext* aCx, const Optional<RequestOrUSVString>& aRequest,

            const CacheQueryOptions& aOptions, ErrorResult& aRv)

{

  if (NS_WARN_IF(!mActor)) {

    aRv.Throw(NS_ERROR_UNEXPECTED);

    return nullptr;

  }

  CacheChild::AutoLock actorLock(mActor);

  CacheQueryParams params;

  ToCacheQueryParams(params, aOptions);

  AutoChildOpArgs args(this,

                       CacheKeysArgs(void_t(), params, GetOpenMode()),

                       1);

  if (aRequest.WasPassed()) {

    RefPtr<InternalRequest> ir =

      ToInternalRequest(aCx, aRequest.Value(), IgnoreBody, aRv);

    if (NS_WARN_IF(aRv.Failed())) {

      return nullptr;

    }

    args.Add(ir, IgnoreBody, IgnoreInvalidScheme, aRv);

    if (NS_WARN_IF(aRv.Failed())) {

      return nullptr;

    }

  }

  return ExecuteOp(args, aRv);

}

nsISupports*

Cache::GetParentObject() const

{

  return mGlobal;

}

JSObject*

Cache::WrapObject(JSContext* aContext, JS::Handle<JSObject*> aGivenProto)

{

  return Cache_Binding::Wrap(aContext, this, aGivenProto);

}

void

Cache::DestroyInternal(CacheChild* aActor)

{

  MOZ_DIAGNOSTIC_ASSERT(mActor);

  MOZ_DIAGNOSTIC_ASSERT(mActor == aActor);

  mActor->ClearListener();

  mActor = nullptr;

}

nsIGlobalObject*

Cache::GetGlobalObject() const

{

  return mGlobal;

}

#ifdef DEBUG

void

Cache::AssertOwningThread() const

{

  NS_ASSERT_OWNINGTHREAD(Cache);

}

#endif

PBackgroundChild*

Cache::GetIPCManager()

{

  NS_ASSERT_OWNINGTHREAD(Cache);

  MOZ_DIAGNOSTIC_ASSERT(mActor);

  return mActor->Manager();

}

Cache::~Cache()

{

  NS_ASSERT_OWNINGTHREAD(Cache);

  if (mActor) {

    mActor->StartDestroyFromListener();

    // DestroyInternal() is called synchronously by StartDestroyFromListener().

    // So we should have already cleared the mActor.

    MOZ_DIAGNOSTIC_ASSERT(!mActor);

  }

}

already_AddRefed<Promise>

Cache::ExecuteOp(AutoChildOpArgs& aOpArgs, ErrorResult& aRv)

{

  MOZ_DIAGNOSTIC_ASSERT(mActor);

  RefPtr<Promise> promise = Promise::Create(mGlobal, aRv);

  if (NS_WARN_IF(!promise)) {

    return nullptr;

  }

  mActor->ExecuteOp(mGlobal, promise, this, aOpArgs.SendAsOpArgs());

  return promise.forget();

}

already_AddRefed<Promise>

Cache::AddAll(const GlobalObject& aGlobal,

              nsTArray<RefPtr<Request>>&& aRequestList,

              CallerType aCallerType, ErrorResult& aRv)

{

  MOZ_DIAGNOSTIC_ASSERT(mActor);

  // If there is no work to do, then resolve immediately

  if (aRequestList.IsEmpty()) {

    RefPtr<Promise> promise = Promise::Create(mGlobal, aRv);

    if (NS_WARN_IF(!promise)) {

      return nullptr;

    }

    promise->MaybeResolveWithUndefined();

    return promise.forget();

  }

  AutoTArray<RefPtr<Promise>, 256> fetchList;

  fetchList.SetCapacity(aRequestList.Length());

  // Begin fetching each request in parallel.  For now, if an error occurs just

  // abandon our previous fetch calls.  In theory we could cancel them in the

  // future once fetch supports it.

  for (uint32_t i = 0; i < aRequestList.Length(); ++i) {

    RequestOrUSVString requestOrString;

    requestOrString.SetAsRequest() = aRequestList[i];

    RefPtr<Promise> fetch = FetchRequest(mGlobal, requestOrString,

                                         RequestInit(), aCallerType, aRv);

    if (NS_WARN_IF(aRv.Failed())) {

      return nullptr;

    }

    fetchList.AppendElement(std::move(fetch));

  }

  RefPtr<Promise> promise = Promise::Create(mGlobal, aRv);

  if (NS_WARN_IF(aRv.Failed())) {

    return nullptr;

  }

  RefPtr<FetchHandler> handler =

    new FetchHandler(mActor->GetWorkerHolder(), this,

                     std::move(aRequestList), promise);

  RefPtr<Promise> fetchPromise = Promise::All(aGlobal.Context(), fetchList, aRv);

  if (NS_WARN_IF(aRv.Failed())) {

    return nullptr;

  }

  fetchPromise->AppendNativeHandler(handler);

  return promise.forget();

}

already_AddRefed<Promise>

Cache::PutAll(JSContext* aCx, const nsTArray<RefPtr<Request>>& aRequestList,

              const nsTArray<RefPtr<Response>>& aResponseList,

              ErrorResult& aRv)

{

  MOZ_DIAGNOSTIC_ASSERT(aRequestList.Length() == aResponseList.Length());

  if (NS_WARN_IF(!mActor)) {

    aRv.Throw(NS_ERROR_UNEXPECTED);

    return nullptr;

  }

  CacheChild::AutoLock actorLock(mActor);

  AutoChildOpArgs args(this, CachePutAllArgs(), aRequestList.Length());

  for (uint32_t i = 0; i < aRequestList.Length(); ++i) {

    RefPtr<InternalRequest> ir = aRequestList[i]->GetInternalRequest();

    args.Add(aCx, ir, ReadBody, TypeErrorOnInvalidScheme, *aResponseList[i],

             aRv);

    if (NS_WARN_IF(aRv.Failed())) {

      return nullptr;

    }

  }

  return ExecuteOp(args, aRv);

}

OpenMode

Cache::GetOpenMode() const

{

  return mNamespace == CHROME_ONLY_NAMESPACE ? OpenMode::Eager : OpenMode::Lazy;

}

} // namespace cache

} // namespace dom

} // namespace mozilla