diff options
| -rw-r--r-- | dom/fetch/FetchConsumer.cpp | 1428 |
1 files changed, 714 insertions, 714 deletions
diff --git a/dom/fetch/FetchConsumer.cpp b/dom/fetch/FetchConsumer.cpp index 581f014d9..d2d07eaa2 100644 --- a/dom/fetch/FetchConsumer.cpp +++ b/dom/fetch/FetchConsumer.cpp @@ -1,714 +1,714 @@ -/* -*- 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 "Fetch.h"
-#include "FetchConsumer.h"
-
-#include "nsIInputStreamPump.h"
-#include "nsProxyRelease.h"
-#include "WorkerPrivate.h"
-#include "WorkerRunnable.h"
-#include "WorkerScope.h"
-#include "Workers.h"
-
-namespace mozilla {
-namespace dom {
-
-using namespace workers;
-
-namespace {
-
-template <class Derived>
-class FetchBodyWorkerHolder final : public workers::WorkerHolder
-{
- RefPtr<FetchBodyConsumer<Derived>> mConsumer;
- bool mWasNotified;
-
-public:
- explicit FetchBodyWorkerHolder(FetchBodyConsumer<Derived>* aConsumer)
- : mConsumer(aConsumer)
- , mWasNotified(false)
- {
- MOZ_ASSERT(aConsumer);
- }
-
- ~FetchBodyWorkerHolder() = default;
-
- bool Notify(workers::Status aStatus) override
- {
- MOZ_ASSERT(aStatus > workers::Running);
- if (!mWasNotified) {
- mWasNotified = true;
- mConsumer->ShutDownMainThreadConsuming();
- }
-
- return true;
- }
-};
-
-template <class Derived>
-class BeginConsumeBodyRunnable final : public Runnable
-{
- RefPtr<FetchBodyConsumer<Derived>> mFetchBodyConsumer;
-
-public:
- explicit BeginConsumeBodyRunnable(FetchBodyConsumer<Derived>* aConsumer)
- : mFetchBodyConsumer(aConsumer)
- { }
-
- NS_IMETHOD
- Run() override
- {
- mFetchBodyConsumer->BeginConsumeBodyMainThread();
- return NS_OK;
- }
-};
-
-/*
- * Called on successfully reading the complete stream.
- */
-template <class Derived>
-class ContinueConsumeBodyRunnable final : public MainThreadWorkerRunnable
-{
- RefPtr<FetchBodyConsumer<Derived>> mFetchBodyConsumer;
- nsresult mStatus;
- uint32_t mLength;
- uint8_t* mResult;
-
-public:
- ContinueConsumeBodyRunnable(FetchBodyConsumer<Derived>* aFetchBodyConsumer,
- nsresult aStatus, uint32_t aLength,
- uint8_t* aResult)
- : MainThreadWorkerRunnable(aFetchBodyConsumer->GetWorkerPrivate())
- , mFetchBodyConsumer(aFetchBodyConsumer)
- , mStatus(aStatus)
- , mLength(aLength)
- , mResult(aResult)
- {
- MOZ_ASSERT(NS_IsMainThread());
- }
-
- bool
- WorkerRun(JSContext* aCx, WorkerPrivate* aWorkerPrivate) override
- {
- mFetchBodyConsumer->ContinueConsumeBody(mStatus, mLength, mResult);
- return true;
- }
-};
-
-template <class Derived>
-class FailConsumeBodyWorkerRunnable : public MainThreadWorkerControlRunnable
-{
- RefPtr<FetchBodyConsumer<Derived>> mBodyConsumer;
-
-public:
- explicit FailConsumeBodyWorkerRunnable(FetchBodyConsumer<Derived>* aBodyConsumer)
- : MainThreadWorkerControlRunnable(aBodyConsumer->GetWorkerPrivate())
- , mBodyConsumer(aBodyConsumer)
- {
- AssertIsOnMainThread();
- }
-
- bool
- WorkerRun(JSContext* aCx, WorkerPrivate* aWorkerPrivate) override
- {
- mBodyConsumer->ContinueConsumeBody(NS_ERROR_FAILURE, 0, nullptr);
- return true;
- }
-};
-
-/*
- * In case of failure to create a stream pump or dispatch stream completion to
- * worker, ensure we cleanup properly. Thread agnostic.
- */
-template <class Derived>
-class MOZ_STACK_CLASS AutoFailConsumeBody final
-{
- RefPtr<FetchBodyConsumer<Derived>> mBodyConsumer;
-
-public:
- explicit AutoFailConsumeBody(FetchBodyConsumer<Derived>* aBodyConsumer)
- : mBodyConsumer(aBodyConsumer)
- {}
-
- ~AutoFailConsumeBody()
- {
- AssertIsOnMainThread();
-
- if (mBodyConsumer) {
- if (mBodyConsumer->GetWorkerPrivate()) {
- RefPtr<FailConsumeBodyWorkerRunnable<Derived>> r =
- new FailConsumeBodyWorkerRunnable<Derived>(mBodyConsumer);
- if (!r->Dispatch()) {
- MOZ_CRASH("We are going to leak");
- }
- } else {
- mBodyConsumer->ContinueConsumeBody(NS_ERROR_FAILURE, 0, nullptr);
- }
- }
- }
-
- void
- DontFail()
- {
- mBodyConsumer = nullptr;
- }
-};
-
-/*
- * Called on successfully reading the complete stream for Blob.
- */
-template <class Derived>
-class ContinueConsumeBlobBodyRunnable final : public MainThreadWorkerRunnable
-{
- RefPtr<FetchBodyConsumer<Derived>> mFetchBodyConsumer;
- RefPtr<BlobImpl> mBlobImpl;
-
-public:
- ContinueConsumeBlobBodyRunnable(FetchBodyConsumer<Derived>* aFetchBodyConsumer,
- BlobImpl* aBlobImpl)
- : MainThreadWorkerRunnable(aFetchBodyConsumer->GetWorkerPrivate())
- , mFetchBodyConsumer(aFetchBodyConsumer)
- , mBlobImpl(aBlobImpl)
- {
- MOZ_ASSERT(NS_IsMainThread());
- MOZ_ASSERT(mBlobImpl);
- }
-
- bool
- WorkerRun(JSContext* aCx, WorkerPrivate* aWorkerPrivate) override
- {
- mFetchBodyConsumer->ContinueConsumeBlobBody(mBlobImpl);
- return true;
- }
-};
-
-template <class Derived>
-class ConsumeBodyDoneObserver : public nsIStreamLoaderObserver
- , public MutableBlobStorageCallback
-{
- RefPtr<FetchBodyConsumer<Derived>> mFetchBodyConsumer;
-
-public:
- NS_DECL_THREADSAFE_ISUPPORTS
-
- explicit ConsumeBodyDoneObserver(FetchBodyConsumer<Derived>* aFetchBodyConsumer)
- : mFetchBodyConsumer(aFetchBodyConsumer)
- { }
-
- NS_IMETHOD
- OnStreamComplete(nsIStreamLoader* aLoader,
- nsISupports* aCtxt,
- nsresult aStatus,
- uint32_t aResultLength,
- const uint8_t* aResult) override
- {
- MOZ_ASSERT(NS_IsMainThread());
-
- // The loading is completed. Let's nullify the pump before continuing the
- // consuming of the body.
- mFetchBodyConsumer->NullifyConsumeBodyPump();
-
- uint8_t* nonconstResult = const_cast<uint8_t*>(aResult);
- if (mFetchBodyConsumer->GetWorkerPrivate()) {
- RefPtr<ContinueConsumeBodyRunnable<Derived>> r =
- new ContinueConsumeBodyRunnable<Derived>(mFetchBodyConsumer,
- aStatus,
- aResultLength,
- nonconstResult);
- if (!r->Dispatch()) {
- NS_WARNING("Could not dispatch ConsumeBodyRunnable");
- // Return failure so that aResult is freed.
- return NS_ERROR_FAILURE;
- }
- } else {
- mFetchBodyConsumer->ContinueConsumeBody(aStatus, aResultLength,
- nonconstResult);
- }
-
- // FetchBody is responsible for data.
- return NS_SUCCESS_ADOPTED_DATA;
- }
-
- virtual void BlobStoreCompleted(MutableBlobStorage* aBlobStorage,
- Blob* aBlob,
- nsresult aRv) override
- {
- // On error.
- if (NS_FAILED(aRv)) {
- OnStreamComplete(nullptr, nullptr, aRv, 0, nullptr);
- return;
- }
-
- // The loading is completed. Let's nullify the pump before continuing the
- // consuming of the body.
- mFetchBodyConsumer->NullifyConsumeBodyPump();
-
- MOZ_ASSERT(aBlob);
-
- if (mFetchBodyConsumer->GetWorkerPrivate()) {
- RefPtr<ContinueConsumeBlobBodyRunnable<Derived>> r =
- new ContinueConsumeBlobBodyRunnable<Derived>(mFetchBodyConsumer,
- aBlob->Impl());
-
- if (!r->Dispatch()) {
- NS_WARNING("Could not dispatch ConsumeBlobBodyRunnable");
- return;
- }
- } else {
- mFetchBodyConsumer->ContinueConsumeBlobBody(aBlob->Impl());
- }
- }
-
-private:
- virtual ~ConsumeBodyDoneObserver()
- { }
-};
-
-template <class Derived>
-NS_IMPL_ADDREF(ConsumeBodyDoneObserver<Derived>)
-template <class Derived>
-NS_IMPL_RELEASE(ConsumeBodyDoneObserver<Derived>)
-template <class Derived>
-NS_INTERFACE_MAP_BEGIN(ConsumeBodyDoneObserver<Derived>)
- NS_INTERFACE_MAP_ENTRY(nsIStreamLoaderObserver)
- NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, nsIStreamLoaderObserver)
-NS_INTERFACE_MAP_END
-
-} // anonymous
-
-template <class Derived>
-/* static */ already_AddRefed<Promise>
-FetchBodyConsumer<Derived>::Create(nsIGlobalObject* aGlobal,
- FetchBody<Derived>* aBody,
- AbortSignal* aSignal,
- FetchConsumeType aType,
- ErrorResult& aRv)
-{
- MOZ_ASSERT(aBody);
-
- nsCOMPtr<nsIInputStream> bodyStream;
- aBody->DerivedClass()->GetBody(getter_AddRefs(bodyStream));
- if (!bodyStream) {
- aRv = NS_NewCStringInputStream(getter_AddRefs(bodyStream), EmptyCString());
- if (NS_WARN_IF(aRv.Failed())) {
- return nullptr;
- }
- }
-
- RefPtr<Promise> promise = Promise::Create(aGlobal, aRv);
- if (aRv.Failed()) {
- return nullptr;
- }
-
- WorkerPrivate* workerPrivate = nullptr;
- if (!NS_IsMainThread()) {
- workerPrivate = GetCurrentThreadWorkerPrivate();
- MOZ_ASSERT(workerPrivate);
- }
-
- RefPtr<FetchBodyConsumer<Derived>> consumer =
- new FetchBodyConsumer<Derived>(aGlobal, workerPrivate, aBody, bodyStream,
- promise, aType);
-
- if (!NS_IsMainThread()) {
- MOZ_ASSERT(workerPrivate);
- if (NS_WARN_IF(!consumer->RegisterWorkerHolder())) {
- aRv.Throw(NS_ERROR_FAILURE);
- return nullptr;
- }
- } else {
- nsCOMPtr<nsIObserverService> os = mozilla::services::GetObserverService();
- if (NS_WARN_IF(!os)) {
- aRv.Throw(NS_ERROR_FAILURE);
- return nullptr;
- }
-
- aRv = os->AddObserver(consumer, DOM_WINDOW_DESTROYED_TOPIC, true);
- if (NS_WARN_IF(aRv.Failed())) {
- return nullptr;
- }
-
- aRv = os->AddObserver(consumer, DOM_WINDOW_FROZEN_TOPIC, true);
- if (NS_WARN_IF(aRv.Failed())) {
- return nullptr;
- }
- }
-
- nsCOMPtr<nsIRunnable> r = new BeginConsumeBodyRunnable<Derived>(consumer);
-
- aRv = NS_DispatchToMainThread(r.forget());
-
- if (NS_WARN_IF(aRv.Failed())) {
- return nullptr;
- }
-
- if (aSignal) {
- consumer->Follow(aSignal);
- }
-
- return promise.forget();
-}
-
-template <class Derived>
-void
-FetchBodyConsumer<Derived>::ReleaseObject()
-{
- AssertIsOnTargetThread();
-
- if (NS_IsMainThread()) {
- nsCOMPtr<nsIObserverService> os = mozilla::services::GetObserverService();
- if (os) {
- os->RemoveObserver(this, DOM_WINDOW_DESTROYED_TOPIC);
- os->RemoveObserver(this, DOM_WINDOW_FROZEN_TOPIC);
- }
- }
-
- mGlobal = nullptr;
- mWorkerHolder = nullptr;
-
-#ifdef DEBUG
- mBody = nullptr;
-#endif
-
- Unfollow();
-}
-
-template <class Derived>
-FetchBodyConsumer<Derived>::FetchBodyConsumer(nsIGlobalObject* aGlobalObject,
- WorkerPrivate* aWorkerPrivate,
- FetchBody<Derived>* aBody,
- nsIInputStream* aBodyStream,
- Promise* aPromise,
- FetchConsumeType aType)
- : mTargetThread(NS_GetCurrentThread())
-#ifdef DEBUG
- , mBody(aBody)
-#endif
- , mBodyStream(aBodyStream)
- , mBlobStorageType(MutableBlobStorage::eOnlyInMemory)
- , mGlobal(aGlobalObject)
- , mWorkerPrivate(aWorkerPrivate)
- , mConsumeType(aType)
- , mConsumePromise(aPromise)
- , mBodyConsumed(false)
- , mShuttingDown(false)
-{
- MOZ_ASSERT(aBody);
- MOZ_ASSERT(aBodyStream);
- MOZ_ASSERT(aPromise);
-
- const mozilla::UniquePtr<mozilla::ipc::PrincipalInfo>& principalInfo =
- aBody->DerivedClass()->GetPrincipalInfo();
- // We support temporary file for blobs only if the principal is known and
- // it's system or content not in private Browsing.
- if (principalInfo &&
- (principalInfo->type() == mozilla::ipc::PrincipalInfo::TSystemPrincipalInfo ||
- (principalInfo->type() == mozilla::ipc::PrincipalInfo::TContentPrincipalInfo &&
- principalInfo->get_ContentPrincipalInfo().attrs().mPrivateBrowsingId == 0))) {
- mBlobStorageType = MutableBlobStorage::eCouldBeInTemporaryFile;
- }
-
- mBodyMimeType = aBody->MimeType();
-}
-
-template <class Derived>
-FetchBodyConsumer<Derived>::~FetchBodyConsumer()
-{
-}
-
-template <class Derived>
-void
-FetchBodyConsumer<Derived>::AssertIsOnTargetThread() const
-{
- MOZ_ASSERT(NS_GetCurrentThread() == mTargetThread);
-}
-
-template <class Derived>
-bool
-FetchBodyConsumer<Derived>::RegisterWorkerHolder()
-{
- MOZ_ASSERT(mWorkerPrivate);
- mWorkerPrivate->AssertIsOnWorkerThread();
-
- MOZ_ASSERT(!mWorkerHolder);
- mWorkerHolder.reset(new FetchBodyWorkerHolder<Derived>(this));
-
- if (!mWorkerHolder->HoldWorker(mWorkerPrivate, Closing)) {
- NS_WARNING("Failed to add workerHolder");
- mWorkerHolder = nullptr;
- return false;
- }
-
- return true;
-}
-
-/*
- * BeginConsumeBodyMainThread() will automatically reject the consume promise
- * and clean up on any failures, so there is no need for callers to do so,
- * reflected in a lack of error return code.
- */
-template <class Derived>
-void
-FetchBodyConsumer<Derived>::BeginConsumeBodyMainThread()
-{
- AssertIsOnMainThread();
-
- AutoFailConsumeBody<Derived> autoReject(this);
-
- if (mShuttingDown) {
- // We haven't started yet, but we have been terminated. AutoFailConsumeBody
- // will dispatch a runnable to release resources.
- return;
- }
-
- nsCOMPtr<nsIInputStreamPump> pump;
- nsresult rv = NS_NewInputStreamPump(getter_AddRefs(pump),
- mBodyStream, -1, -1, 0, 0, false);
- if (NS_WARN_IF(NS_FAILED(rv))) {
- return;
- }
-
- RefPtr<ConsumeBodyDoneObserver<Derived>> p =
- new ConsumeBodyDoneObserver<Derived>(this);
-
- nsCOMPtr<nsIStreamListener> listener;
- if (mConsumeType == CONSUME_BLOB) {
- listener = new MutableBlobStreamListener(mBlobStorageType, nullptr,
- mBodyMimeType, p);
- } else {
- nsCOMPtr<nsIStreamLoader> loader;
- rv = NS_NewStreamLoader(getter_AddRefs(loader), p);
- if (NS_WARN_IF(NS_FAILED(rv))) {
- return;
- }
-
- listener = loader;
- }
-
- rv = pump->AsyncRead(listener, nullptr);
- if (NS_WARN_IF(NS_FAILED(rv))) {
- return;
- }
-
- // Now that everything succeeded, we can assign the pump to a pointer that
- // stays alive for the lifetime of the FetchConsumer.
- mConsumeBodyPump = pump;
-
- // It is ok for retargeting to fail and reads to happen on the main thread.
- autoReject.DontFail();
-
- // Try to retarget, otherwise fall back to main thread.
- nsCOMPtr<nsIThreadRetargetableRequest> rr = do_QueryInterface(pump);
- if (rr) {
- nsCOMPtr<nsIEventTarget> sts = do_GetService(NS_STREAMTRANSPORTSERVICE_CONTRACTID);
- rv = rr->RetargetDeliveryTo(sts);
- if (NS_WARN_IF(NS_FAILED(rv))) {
- NS_WARNING("Retargeting failed");
- }
- }
-}
-
-template <class Derived>
-void
-FetchBodyConsumer<Derived>::ContinueConsumeBody(nsresult aStatus,
- uint32_t aResultLength,
- uint8_t* aResult)
-{
- AssertIsOnTargetThread();
-
- if (mBodyConsumed) {
- return;
- }
- mBodyConsumed = true;
-
- // Just a precaution to ensure ContinueConsumeBody is not called out of
- // sync with a body read.
- MOZ_ASSERT(mBody->BodyUsed());
-
- auto autoFree = mozilla::MakeScopeExit([&] {
- free(aResult);
- });
-
- MOZ_ASSERT(mConsumePromise);
- RefPtr<Promise> localPromise = mConsumePromise.forget();
-
- RefPtr<FetchBodyConsumer<Derived>> self = this;
- auto autoReleaseObject = mozilla::MakeScopeExit([&] {
- self->ReleaseObject();
- });
-
- if (NS_WARN_IF(NS_FAILED(aStatus))) {
- localPromise->MaybeReject(NS_ERROR_DOM_ABORT_ERR);
- }
-
- // Don't warn here since we warned above.
- if (NS_FAILED(aStatus)) {
- return;
- }
-
- // Finish successfully consuming body according to type.
- MOZ_ASSERT(aResult);
-
- AutoJSAPI jsapi;
- if (!jsapi.Init(mGlobal)) {
- localPromise->MaybeReject(NS_ERROR_UNEXPECTED);
- return;
- }
-
- JSContext* cx = jsapi.cx();
- ErrorResult error;
-
- switch (mConsumeType) {
- case CONSUME_ARRAYBUFFER: {
- JS::Rooted<JSObject*> arrayBuffer(cx);
- BodyUtil::ConsumeArrayBuffer(cx, &arrayBuffer, aResultLength, aResult,
- error);
-
- if (!error.Failed()) {
- JS::Rooted<JS::Value> val(cx);
- val.setObjectOrNull(arrayBuffer);
-
- localPromise->MaybeResolve(cx, val);
- // ArrayBuffer takes over ownership.
- aResult = nullptr;
- }
- break;
- }
- case CONSUME_BLOB: {
- MOZ_CRASH("This should not happen.");
- break;
- }
- case CONSUME_FORMDATA: {
- nsCString data;
- data.Adopt(reinterpret_cast<char*>(aResult), aResultLength);
- aResult = nullptr;
-
- RefPtr<dom::FormData> fd =
- BodyUtil::ConsumeFormData(mGlobal, mBodyMimeType, data, error);
- if (!error.Failed()) {
- localPromise->MaybeResolve(fd);
- }
- break;
- }
- case CONSUME_TEXT:
- // fall through handles early exit.
- case CONSUME_JSON: {
- nsString decoded;
- if (NS_SUCCEEDED(BodyUtil::ConsumeText(aResultLength, aResult, decoded))) {
- if (mConsumeType == CONSUME_TEXT) {
- localPromise->MaybeResolve(decoded);
- } else {
- JS::Rooted<JS::Value> json(cx);
- BodyUtil::ConsumeJson(cx, &json, decoded, error);
- if (!error.Failed()) {
- localPromise->MaybeResolve(cx, json);
- }
- }
- };
- break;
- }
- default:
- NS_NOTREACHED("Unexpected consume body type");
- }
-
- error.WouldReportJSException();
- if (error.Failed()) {
- localPromise->MaybeReject(error);
- }
-}
-
-template <class Derived>
-void
-FetchBodyConsumer<Derived>::ContinueConsumeBlobBody(BlobImpl* aBlobImpl)
-{
- AssertIsOnTargetThread();
- MOZ_ASSERT(mConsumeType == CONSUME_BLOB);
-
- if (mBodyConsumed) {
- return;
- }
- mBodyConsumed = true;
-
- // Just a precaution to ensure ContinueConsumeBody is not called out of
- // sync with a body read.
- MOZ_ASSERT(mBody->BodyUsed());
-
- MOZ_ASSERT(mConsumePromise);
- RefPtr<Promise> localPromise = mConsumePromise.forget();
-
- RefPtr<dom::Blob> blob = dom::Blob::Create(mGlobal, aBlobImpl);
- MOZ_ASSERT(blob);
-
- localPromise->MaybeResolve(blob);
-
- ReleaseObject();
-}
-
-template <class Derived>
-void
-FetchBodyConsumer<Derived>::ShutDownMainThreadConsuming()
-{
- if (!NS_IsMainThread()) {
- RefPtr<FetchBodyConsumer<Derived>> self = this;
-
- nsCOMPtr<nsIRunnable> r = NS_NewRunnableFunction(
- [self] () { self->ShutDownMainThreadConsuming(); });
-
- MOZ_ALWAYS_SUCCEEDS(NS_DispatchToMainThread(r.forget()));
- return;
- }
-
- // We need this because maybe, mConsumeBodyPump has not been created yet. We
- // must be sure that we don't try to do it.
- mShuttingDown = true;
-
- if (mConsumeBodyPump) {
- mConsumeBodyPump->Cancel(NS_BINDING_ABORTED);
- mConsumeBodyPump = nullptr;
- }
-}
-
-template <class Derived>
-NS_IMETHODIMP
-FetchBodyConsumer<Derived>::Observe(nsISupports* aSubject,
- const char* aTopic,
- const char16_t* aData)
-{
- AssertIsOnMainThread();
-
- MOZ_ASSERT((strcmp(aTopic, DOM_WINDOW_FROZEN_TOPIC) == 0) ||
- (strcmp(aTopic, DOM_WINDOW_DESTROYED_TOPIC) == 0));
-
- nsCOMPtr<nsPIDOMWindowInner> window = do_QueryInterface(mGlobal);
- if (SameCOMIdentity(aSubject, window)) {
- ContinueConsumeBody(NS_BINDING_ABORTED, 0, nullptr);
- }
-
- return NS_OK;
-}
-
-template <class Derived>
-void
-FetchBodyConsumer<Derived>::Aborted()
-{
- AssertIsOnTargetThread();
- ContinueConsumeBody(NS_ERROR_DOM_ABORT_ERR, 0, nullptr);
-}
-
-template <class Derived>
-NS_IMPL_ADDREF(FetchBodyConsumer<Derived>)
-
-template <class Derived>
-NS_IMPL_RELEASE(FetchBodyConsumer<Derived>)
-
-template <class Derived>
-NS_IMPL_QUERY_INTERFACE(FetchBodyConsumer<Derived>,
- nsIObserver,
- nsISupportsWeakReference)
-
-} // namespace dom
-} // namespace mozilla
+/* -*- 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 "Fetch.h" +#include "FetchConsumer.h" + +#include "nsIInputStreamPump.h" +#include "nsProxyRelease.h" +#include "WorkerPrivate.h" +#include "WorkerRunnable.h" +#include "WorkerScope.h" +#include "Workers.h" + +namespace mozilla { +namespace dom { + +using namespace workers; + +namespace { + +template <class Derived> +class FetchBodyWorkerHolder final : public workers::WorkerHolder +{ + RefPtr<FetchBodyConsumer<Derived>> mConsumer; + bool mWasNotified; + +public: + explicit FetchBodyWorkerHolder(FetchBodyConsumer<Derived>* aConsumer) + : mConsumer(aConsumer) + , mWasNotified(false) + { + MOZ_ASSERT(aConsumer); + } + + ~FetchBodyWorkerHolder() = default; + + bool Notify(workers::Status aStatus) override + { + MOZ_ASSERT(aStatus > workers::Running); + if (!mWasNotified) { + mWasNotified = true; + mConsumer->ShutDownMainThreadConsuming(); + } + + return true; + } +}; + +template <class Derived> +class BeginConsumeBodyRunnable final : public Runnable +{ + RefPtr<FetchBodyConsumer<Derived>> mFetchBodyConsumer; + +public: + explicit BeginConsumeBodyRunnable(FetchBodyConsumer<Derived>* aConsumer) + : mFetchBodyConsumer(aConsumer) + { } + + NS_IMETHOD + Run() override + { + mFetchBodyConsumer->BeginConsumeBodyMainThread(); + return NS_OK; + } +}; + +/* + * Called on successfully reading the complete stream. + */ +template <class Derived> +class ContinueConsumeBodyRunnable final : public MainThreadWorkerRunnable +{ + RefPtr<FetchBodyConsumer<Derived>> mFetchBodyConsumer; + nsresult mStatus; + uint32_t mLength; + uint8_t* mResult; + +public: + ContinueConsumeBodyRunnable(FetchBodyConsumer<Derived>* aFetchBodyConsumer, + nsresult aStatus, uint32_t aLength, + uint8_t* aResult) + : MainThreadWorkerRunnable(aFetchBodyConsumer->GetWorkerPrivate()) + , mFetchBodyConsumer(aFetchBodyConsumer) + , mStatus(aStatus) + , mLength(aLength) + , mResult(aResult) + { + MOZ_ASSERT(NS_IsMainThread()); + } + + bool + WorkerRun(JSContext* aCx, WorkerPrivate* aWorkerPrivate) override + { + mFetchBodyConsumer->ContinueConsumeBody(mStatus, mLength, mResult); + return true; + } +}; + +template <class Derived> +class FailConsumeBodyWorkerRunnable : public MainThreadWorkerControlRunnable +{ + RefPtr<FetchBodyConsumer<Derived>> mBodyConsumer; + +public: + explicit FailConsumeBodyWorkerRunnable(FetchBodyConsumer<Derived>* aBodyConsumer) + : MainThreadWorkerControlRunnable(aBodyConsumer->GetWorkerPrivate()) + , mBodyConsumer(aBodyConsumer) + { + AssertIsOnMainThread(); + } + + bool + WorkerRun(JSContext* aCx, WorkerPrivate* aWorkerPrivate) override + { + mBodyConsumer->ContinueConsumeBody(NS_ERROR_FAILURE, 0, nullptr); + return true; + } +}; + +/* + * In case of failure to create a stream pump or dispatch stream completion to + * worker, ensure we cleanup properly. Thread agnostic. + */ +template <class Derived> +class MOZ_STACK_CLASS AutoFailConsumeBody final +{ + RefPtr<FetchBodyConsumer<Derived>> mBodyConsumer; + +public: + explicit AutoFailConsumeBody(FetchBodyConsumer<Derived>* aBodyConsumer) + : mBodyConsumer(aBodyConsumer) + {} + + ~AutoFailConsumeBody() + { + AssertIsOnMainThread(); + + if (mBodyConsumer) { + if (mBodyConsumer->GetWorkerPrivate()) { + RefPtr<FailConsumeBodyWorkerRunnable<Derived>> r = + new FailConsumeBodyWorkerRunnable<Derived>(mBodyConsumer); + if (!r->Dispatch()) { + MOZ_CRASH("We are going to leak"); + } + } else { + mBodyConsumer->ContinueConsumeBody(NS_ERROR_FAILURE, 0, nullptr); + } + } + } + + void + DontFail() + { + mBodyConsumer = nullptr; + } +}; + +/* + * Called on successfully reading the complete stream for Blob. + */ +template <class Derived> +class ContinueConsumeBlobBodyRunnable final : public MainThreadWorkerRunnable +{ + RefPtr<FetchBodyConsumer<Derived>> mFetchBodyConsumer; + RefPtr<BlobImpl> mBlobImpl; + +public: + ContinueConsumeBlobBodyRunnable(FetchBodyConsumer<Derived>* aFetchBodyConsumer, + BlobImpl* aBlobImpl) + : MainThreadWorkerRunnable(aFetchBodyConsumer->GetWorkerPrivate()) + , mFetchBodyConsumer(aFetchBodyConsumer) + , mBlobImpl(aBlobImpl) + { + MOZ_ASSERT(NS_IsMainThread()); + MOZ_ASSERT(mBlobImpl); + } + + bool + WorkerRun(JSContext* aCx, WorkerPrivate* aWorkerPrivate) override + { + mFetchBodyConsumer->ContinueConsumeBlobBody(mBlobImpl); + return true; + } +}; + +template <class Derived> +class ConsumeBodyDoneObserver : public nsIStreamLoaderObserver + , public MutableBlobStorageCallback +{ + RefPtr<FetchBodyConsumer<Derived>> mFetchBodyConsumer; + +public: + NS_DECL_THREADSAFE_ISUPPORTS + + explicit ConsumeBodyDoneObserver(FetchBodyConsumer<Derived>* aFetchBodyConsumer) + : mFetchBodyConsumer(aFetchBodyConsumer) + { } + + NS_IMETHOD + OnStreamComplete(nsIStreamLoader* aLoader, + nsISupports* aCtxt, + nsresult aStatus, + uint32_t aResultLength, + const uint8_t* aResult) override + { + MOZ_ASSERT(NS_IsMainThread()); + + // The loading is completed. Let's nullify the pump before continuing the + // consuming of the body. + mFetchBodyConsumer->NullifyConsumeBodyPump(); + + uint8_t* nonconstResult = const_cast<uint8_t*>(aResult); + if (mFetchBodyConsumer->GetWorkerPrivate()) { + RefPtr<ContinueConsumeBodyRunnable<Derived>> r = + new ContinueConsumeBodyRunnable<Derived>(mFetchBodyConsumer, + aStatus, + aResultLength, + nonconstResult); + if (!r->Dispatch()) { + NS_WARNING("Could not dispatch ConsumeBodyRunnable"); + // Return failure so that aResult is freed. + return NS_ERROR_FAILURE; + } + } else { + mFetchBodyConsumer->ContinueConsumeBody(aStatus, aResultLength, + nonconstResult); + } + + // FetchBody is responsible for data. + return NS_SUCCESS_ADOPTED_DATA; + } + + virtual void BlobStoreCompleted(MutableBlobStorage* aBlobStorage, + Blob* aBlob, + nsresult aRv) override + { + // On error. + if (NS_FAILED(aRv)) { + OnStreamComplete(nullptr, nullptr, aRv, 0, nullptr); + return; + } + + // The loading is completed. Let's nullify the pump before continuing the + // consuming of the body. + mFetchBodyConsumer->NullifyConsumeBodyPump(); + + MOZ_ASSERT(aBlob); + + if (mFetchBodyConsumer->GetWorkerPrivate()) { + RefPtr<ContinueConsumeBlobBodyRunnable<Derived>> r = + new ContinueConsumeBlobBodyRunnable<Derived>(mFetchBodyConsumer, + aBlob->Impl()); + + if (!r->Dispatch()) { + NS_WARNING("Could not dispatch ConsumeBlobBodyRunnable"); + return; + } + } else { + mFetchBodyConsumer->ContinueConsumeBlobBody(aBlob->Impl()); + } + } + +private: + virtual ~ConsumeBodyDoneObserver() + { } +}; + +template <class Derived> +NS_IMPL_ADDREF(ConsumeBodyDoneObserver<Derived>) +template <class Derived> +NS_IMPL_RELEASE(ConsumeBodyDoneObserver<Derived>) +template <class Derived> +NS_INTERFACE_MAP_BEGIN(ConsumeBodyDoneObserver<Derived>) + NS_INTERFACE_MAP_ENTRY(nsIStreamLoaderObserver) + NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, nsIStreamLoaderObserver) +NS_INTERFACE_MAP_END + +} // anonymous + +template <class Derived> +/* static */ already_AddRefed<Promise> +FetchBodyConsumer<Derived>::Create(nsIGlobalObject* aGlobal, + FetchBody<Derived>* aBody, + AbortSignal* aSignal, + FetchConsumeType aType, + ErrorResult& aRv) +{ + MOZ_ASSERT(aBody); + + nsCOMPtr<nsIInputStream> bodyStream; + aBody->DerivedClass()->GetBody(getter_AddRefs(bodyStream)); + if (!bodyStream) { + aRv = NS_NewCStringInputStream(getter_AddRefs(bodyStream), EmptyCString()); + if (NS_WARN_IF(aRv.Failed())) { + return nullptr; + } + } + + RefPtr<Promise> promise = Promise::Create(aGlobal, aRv); + if (aRv.Failed()) { + return nullptr; + } + + WorkerPrivate* workerPrivate = nullptr; + if (!NS_IsMainThread()) { + workerPrivate = GetCurrentThreadWorkerPrivate(); + MOZ_ASSERT(workerPrivate); + } + + RefPtr<FetchBodyConsumer<Derived>> consumer = + new FetchBodyConsumer<Derived>(aGlobal, workerPrivate, aBody, bodyStream, + promise, aType); + + if (!NS_IsMainThread()) { + MOZ_ASSERT(workerPrivate); + if (NS_WARN_IF(!consumer->RegisterWorkerHolder())) { + aRv.Throw(NS_ERROR_FAILURE); + return nullptr; + } + } else { + nsCOMPtr<nsIObserverService> os = mozilla::services::GetObserverService(); + if (NS_WARN_IF(!os)) { + aRv.Throw(NS_ERROR_FAILURE); + return nullptr; + } + + aRv = os->AddObserver(consumer, DOM_WINDOW_DESTROYED_TOPIC, true); + if (NS_WARN_IF(aRv.Failed())) { + return nullptr; + } + + aRv = os->AddObserver(consumer, DOM_WINDOW_FROZEN_TOPIC, true); + if (NS_WARN_IF(aRv.Failed())) { + return nullptr; + } + } + + nsCOMPtr<nsIRunnable> r = new BeginConsumeBodyRunnable<Derived>(consumer); + + aRv = NS_DispatchToMainThread(r.forget()); + + if (NS_WARN_IF(aRv.Failed())) { + return nullptr; + } + + if (aSignal) { + consumer->Follow(aSignal); + } + + return promise.forget(); +} + +template <class Derived> +void +FetchBodyConsumer<Derived>::ReleaseObject() +{ + AssertIsOnTargetThread(); + + if (NS_IsMainThread()) { + nsCOMPtr<nsIObserverService> os = mozilla::services::GetObserverService(); + if (os) { + os->RemoveObserver(this, DOM_WINDOW_DESTROYED_TOPIC); + os->RemoveObserver(this, DOM_WINDOW_FROZEN_TOPIC); + } + } + + mGlobal = nullptr; + mWorkerHolder = nullptr; + +#ifdef DEBUG + mBody = nullptr; +#endif + + Unfollow(); +} + +template <class Derived> +FetchBodyConsumer<Derived>::FetchBodyConsumer(nsIGlobalObject* aGlobalObject, + WorkerPrivate* aWorkerPrivate, + FetchBody<Derived>* aBody, + nsIInputStream* aBodyStream, + Promise* aPromise, + FetchConsumeType aType) + : mTargetThread(NS_GetCurrentThread()) +#ifdef DEBUG + , mBody(aBody) +#endif + , mBodyStream(aBodyStream) + , mBlobStorageType(MutableBlobStorage::eOnlyInMemory) + , mGlobal(aGlobalObject) + , mWorkerPrivate(aWorkerPrivate) + , mConsumeType(aType) + , mConsumePromise(aPromise) + , mBodyConsumed(false) + , mShuttingDown(false) +{ + MOZ_ASSERT(aBody); + MOZ_ASSERT(aBodyStream); + MOZ_ASSERT(aPromise); + + const mozilla::UniquePtr<mozilla::ipc::PrincipalInfo>& principalInfo = + aBody->DerivedClass()->GetPrincipalInfo(); + // We support temporary file for blobs only if the principal is known and + // it's system or content not in private Browsing. + if (principalInfo && + (principalInfo->type() == mozilla::ipc::PrincipalInfo::TSystemPrincipalInfo || + (principalInfo->type() == mozilla::ipc::PrincipalInfo::TContentPrincipalInfo && + principalInfo->get_ContentPrincipalInfo().attrs().mPrivateBrowsingId == 0))) { + mBlobStorageType = MutableBlobStorage::eCouldBeInTemporaryFile; + } + + mBodyMimeType = aBody->MimeType(); +} + +template <class Derived> +FetchBodyConsumer<Derived>::~FetchBodyConsumer() +{ +} + +template <class Derived> +void +FetchBodyConsumer<Derived>::AssertIsOnTargetThread() const +{ + MOZ_ASSERT(NS_GetCurrentThread() == mTargetThread); +} + +template <class Derived> +bool +FetchBodyConsumer<Derived>::RegisterWorkerHolder() +{ + MOZ_ASSERT(mWorkerPrivate); + mWorkerPrivate->AssertIsOnWorkerThread(); + + MOZ_ASSERT(!mWorkerHolder); + mWorkerHolder.reset(new FetchBodyWorkerHolder<Derived>(this)); + + if (!mWorkerHolder->HoldWorker(mWorkerPrivate, Closing)) { + NS_WARNING("Failed to add workerHolder"); + mWorkerHolder = nullptr; + return false; + } + + return true; +} + +/* + * BeginConsumeBodyMainThread() will automatically reject the consume promise + * and clean up on any failures, so there is no need for callers to do so, + * reflected in a lack of error return code. + */ +template <class Derived> +void +FetchBodyConsumer<Derived>::BeginConsumeBodyMainThread() +{ + AssertIsOnMainThread(); + + AutoFailConsumeBody<Derived> autoReject(this); + + if (mShuttingDown) { + // We haven't started yet, but we have been terminated. AutoFailConsumeBody + // will dispatch a runnable to release resources. + return; + } + + nsCOMPtr<nsIInputStreamPump> pump; + nsresult rv = NS_NewInputStreamPump(getter_AddRefs(pump), + mBodyStream, -1, -1, 0, 0, false); + if (NS_WARN_IF(NS_FAILED(rv))) { + return; + } + + RefPtr<ConsumeBodyDoneObserver<Derived>> p = + new ConsumeBodyDoneObserver<Derived>(this); + + nsCOMPtr<nsIStreamListener> listener; + if (mConsumeType == CONSUME_BLOB) { + listener = new MutableBlobStreamListener(mBlobStorageType, nullptr, + mBodyMimeType, p); + } else { + nsCOMPtr<nsIStreamLoader> loader; + rv = NS_NewStreamLoader(getter_AddRefs(loader), p); + if (NS_WARN_IF(NS_FAILED(rv))) { + return; + } + + listener = loader; + } + + rv = pump->AsyncRead(listener, nullptr); + if (NS_WARN_IF(NS_FAILED(rv))) { + return; + } + + // Now that everything succeeded, we can assign the pump to a pointer that + // stays alive for the lifetime of the FetchConsumer. + mConsumeBodyPump = pump; + + // It is ok for retargeting to fail and reads to happen on the main thread. + autoReject.DontFail(); + + // Try to retarget, otherwise fall back to main thread. + nsCOMPtr<nsIThreadRetargetableRequest> rr = do_QueryInterface(pump); + if (rr) { + nsCOMPtr<nsIEventTarget> sts = do_GetService(NS_STREAMTRANSPORTSERVICE_CONTRACTID); + rv = rr->RetargetDeliveryTo(sts); + if (NS_WARN_IF(NS_FAILED(rv))) { + NS_WARNING("Retargeting failed"); + } + } +} + +template <class Derived> +void +FetchBodyConsumer<Derived>::ContinueConsumeBody(nsresult aStatus, + uint32_t aResultLength, + uint8_t* aResult) +{ + AssertIsOnTargetThread(); + + if (mBodyConsumed) { + return; + } + mBodyConsumed = true; + + // Just a precaution to ensure ContinueConsumeBody is not called out of + // sync with a body read. + MOZ_ASSERT(mBody->BodyUsed()); + + auto autoFree = mozilla::MakeScopeExit([&] { + free(aResult); + }); + + MOZ_ASSERT(mConsumePromise); + RefPtr<Promise> localPromise = mConsumePromise.forget(); + + RefPtr<FetchBodyConsumer<Derived>> self = this; + auto autoReleaseObject = mozilla::MakeScopeExit([&] { + self->ReleaseObject(); + }); + + if (NS_WARN_IF(NS_FAILED(aStatus))) { + localPromise->MaybeReject(NS_ERROR_DOM_ABORT_ERR); + } + + // Don't warn here since we warned above. + if (NS_FAILED(aStatus)) { + return; + } + + // Finish successfully consuming body according to type. + MOZ_ASSERT(aResult); + + AutoJSAPI jsapi; + if (!jsapi.Init(mGlobal)) { + localPromise->MaybeReject(NS_ERROR_UNEXPECTED); + return; + } + + JSContext* cx = jsapi.cx(); + ErrorResult error; + + switch (mConsumeType) { + case CONSUME_ARRAYBUFFER: { + JS::Rooted<JSObject*> arrayBuffer(cx); + BodyUtil::ConsumeArrayBuffer(cx, &arrayBuffer, aResultLength, aResult, + error); + + if (!error.Failed()) { + JS::Rooted<JS::Value> val(cx); + val.setObjectOrNull(arrayBuffer); + + localPromise->MaybeResolve(cx, val); + // ArrayBuffer takes over ownership. + aResult = nullptr; + } + break; + } + case CONSUME_BLOB: { + MOZ_CRASH("This should not happen."); + break; + } + case CONSUME_FORMDATA: { + nsCString data; + data.Adopt(reinterpret_cast<char*>(aResult), aResultLength); + aResult = nullptr; + + RefPtr<dom::FormData> fd = + BodyUtil::ConsumeFormData(mGlobal, mBodyMimeType, data, error); + if (!error.Failed()) { + localPromise->MaybeResolve(fd); + } + break; + } + case CONSUME_TEXT: + // fall through handles early exit. + case CONSUME_JSON: { + nsString decoded; + if (NS_SUCCEEDED(BodyUtil::ConsumeText(aResultLength, aResult, decoded))) { + if (mConsumeType == CONSUME_TEXT) { + localPromise->MaybeResolve(decoded); + } else { + JS::Rooted<JS::Value> json(cx); + BodyUtil::ConsumeJson(cx, &json, decoded, error); + if (!error.Failed()) { + localPromise->MaybeResolve(cx, json); + } + } + }; + break; + } + default: + NS_NOTREACHED("Unexpected consume body type"); + } + + error.WouldReportJSException(); + if (error.Failed()) { + localPromise->MaybeReject(error); + } +} + +template <class Derived> +void +FetchBodyConsumer<Derived>::ContinueConsumeBlobBody(BlobImpl* aBlobImpl) +{ + AssertIsOnTargetThread(); + MOZ_ASSERT(mConsumeType == CONSUME_BLOB); + + if (mBodyConsumed) { + return; + } + mBodyConsumed = true; + + // Just a precaution to ensure ContinueConsumeBody is not called out of + // sync with a body read. + MOZ_ASSERT(mBody->BodyUsed()); + + MOZ_ASSERT(mConsumePromise); + RefPtr<Promise> localPromise = mConsumePromise.forget(); + + RefPtr<dom::Blob> blob = dom::Blob::Create(mGlobal, aBlobImpl); + MOZ_ASSERT(blob); + + localPromise->MaybeResolve(blob); + + ReleaseObject(); +} + +template <class Derived> +void +FetchBodyConsumer<Derived>::ShutDownMainThreadConsuming() +{ + if (!NS_IsMainThread()) { + RefPtr<FetchBodyConsumer<Derived>> self = this; + + nsCOMPtr<nsIRunnable> r = NS_NewRunnableFunction( + [self] () { self->ShutDownMainThreadConsuming(); }); + + MOZ_ALWAYS_SUCCEEDS(NS_DispatchToMainThread(r.forget())); + return; + } + + // We need this because maybe, mConsumeBodyPump has not been created yet. We + // must be sure that we don't try to do it. + mShuttingDown = true; + + if (mConsumeBodyPump) { + mConsumeBodyPump->Cancel(NS_BINDING_ABORTED); + mConsumeBodyPump = nullptr; + } +} + +template <class Derived> +NS_IMETHODIMP +FetchBodyConsumer<Derived>::Observe(nsISupports* aSubject, + const char* aTopic, + const char16_t* aData) +{ + AssertIsOnMainThread(); + + MOZ_ASSERT((strcmp(aTopic, DOM_WINDOW_FROZEN_TOPIC) == 0) || + (strcmp(aTopic, DOM_WINDOW_DESTROYED_TOPIC) == 0)); + + nsCOMPtr<nsPIDOMWindowInner> window = do_QueryInterface(mGlobal); + if (SameCOMIdentity(aSubject, window)) { + ContinueConsumeBody(NS_BINDING_ABORTED, 0, nullptr); + } + + return NS_OK; +} + +template <class Derived> +void +FetchBodyConsumer<Derived>::Aborted() +{ + AssertIsOnTargetThread(); + ContinueConsumeBody(NS_ERROR_DOM_ABORT_ERR, 0, nullptr); +} + +template <class Derived> +NS_IMPL_ADDREF(FetchBodyConsumer<Derived>) + +template <class Derived> +NS_IMPL_RELEASE(FetchBodyConsumer<Derived>) + +template <class Derived> +NS_IMPL_QUERY_INTERFACE(FetchBodyConsumer<Derived>, + nsIObserver, + nsISupportsWeakReference) + +} // namespace dom +} // namespace mozilla |