summaryrefslogtreecommitdiffstats
path: root/dom/locks/LockManager.cpp
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 17:32:43 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 17:32:43 +0000
commit6bf0a5cb5034a7e684dcc3500e841785237ce2dd (patch)
treea68f146d7fa01f0134297619fbe7e33db084e0aa /dom/locks/LockManager.cpp
parentInitial commit. (diff)
downloadthunderbird-6bf0a5cb5034a7e684dcc3500e841785237ce2dd.tar.xz
thunderbird-6bf0a5cb5034a7e684dcc3500e841785237ce2dd.zip
Adding upstream version 1:115.7.0.upstream/1%115.7.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--dom/locks/LockManager.cpp207
1 files changed, 207 insertions, 0 deletions
diff --git a/dom/locks/LockManager.cpp b/dom/locks/LockManager.cpp
new file mode 100644
index 0000000000..c8beff7d56
--- /dev/null
+++ b/dom/locks/LockManager.cpp
@@ -0,0 +1,207 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim:set ts=2 sw=2 sts=2 et cindent: */
+/* 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/LockManager.h"
+#include "mozilla/dom/AutoEntryScript.h"
+#include "mozilla/dom/WorkerCommon.h"
+#include "mozilla/dom/locks/LockManagerChild.h"
+#include "mozilla/dom/locks/LockRequestChild.h"
+#include "mozilla/Assertions.h"
+#include "mozilla/ErrorResult.h"
+#include "mozilla/dom/LockManagerBinding.h"
+#include "mozilla/dom/Promise.h"
+#include "mozilla/dom/locks/PLockManager.h"
+#include "mozilla/ipc/BackgroundChild.h"
+#include "mozilla/ipc/BackgroundUtils.h"
+#include "mozilla/ipc/PBackgroundChild.h"
+
+namespace mozilla::dom {
+
+NS_IMPL_CYCLE_COLLECTION_WRAPPERCACHE(LockManager, mOwner, mActor)
+NS_IMPL_CYCLE_COLLECTING_ADDREF(LockManager)
+NS_IMPL_CYCLE_COLLECTING_RELEASE(LockManager)
+NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(LockManager)
+ NS_WRAPPERCACHE_INTERFACE_MAP_ENTRY
+ NS_INTERFACE_MAP_ENTRY(nsISupports)
+NS_INTERFACE_MAP_END
+
+JSObject* LockManager::WrapObject(JSContext* aCx,
+ JS::Handle<JSObject*> aGivenProto) {
+ return LockManager_Binding::Wrap(aCx, this, aGivenProto);
+}
+
+LockManager::LockManager(nsIGlobalObject* aGlobal) : mOwner(aGlobal) {
+ Maybe<ClientInfo> clientInfo = aGlobal->GetClientInfo();
+ if (!clientInfo) {
+ return;
+ }
+
+ const mozilla::ipc::PrincipalInfo& principalInfo =
+ clientInfo->PrincipalInfo();
+
+ if (principalInfo.type() !=
+ mozilla::ipc::PrincipalInfo::TContentPrincipalInfo) {
+ return;
+ }
+
+ mozilla::ipc::PBackgroundChild* backgroundActor =
+ mozilla::ipc::BackgroundChild::GetOrCreateForCurrentThread();
+ mActor = new locks::LockManagerChild(aGlobal);
+ backgroundActor->SendPLockManagerConstructor(mActor, principalInfo,
+ clientInfo->Id());
+
+ if (!NS_IsMainThread()) {
+ mWorkerRef = WeakWorkerRef::Create(GetCurrentThreadWorkerPrivate(),
+ [self = RefPtr(this)]() {
+ // Others may grab a strong reference
+ // and block immediate destruction.
+ // Shutdown early as we don't have to
+ // wait for them.
+ self->Shutdown();
+ self->mWorkerRef = nullptr;
+ });
+ }
+}
+
+static bool ValidateRequestArguments(const nsAString& name,
+ const LockOptions& options,
+ ErrorResult& aRv) {
+ if (name.Length() > 0 && name.First() == u'-') {
+ aRv.ThrowNotSupportedError("Names starting with `-` are reserved");
+ return false;
+ }
+ if (options.mSteal) {
+ if (options.mIfAvailable) {
+ aRv.ThrowNotSupportedError(
+ "`steal` and `ifAvailable` cannot be used together");
+ return false;
+ }
+ if (options.mMode != LockMode::Exclusive) {
+ aRv.ThrowNotSupportedError(
+ "`steal` is only supported for exclusive lock requests");
+ return false;
+ }
+ }
+ if (options.mSignal.WasPassed()) {
+ if (options.mSteal) {
+ aRv.ThrowNotSupportedError(
+ "`steal` and `signal` cannot be used together");
+ return false;
+ }
+ if (options.mIfAvailable) {
+ aRv.ThrowNotSupportedError(
+ "`ifAvailable` and `signal` cannot be used together");
+ return false;
+ }
+ if (options.mSignal.Value().Aborted()) {
+ AutoJSAPI jsapi;
+ if (!jsapi.Init(options.mSignal.Value().GetParentObject())) {
+ aRv.ThrowNotSupportedError("Signal's realm isn't active anymore.");
+ return false;
+ }
+
+ JSContext* cx = jsapi.cx();
+ JS::Rooted<JS::Value> reason(cx);
+ options.mSignal.Value().GetReason(cx, &reason);
+ aRv.MightThrowJSException();
+ aRv.ThrowJSException(cx, reason);
+ return false;
+ }
+ }
+ return true;
+}
+
+already_AddRefed<Promise> LockManager::Request(const nsAString& aName,
+ LockGrantedCallback& aCallback,
+ ErrorResult& aRv) {
+ return Request(aName, LockOptions(), aCallback, aRv);
+};
+already_AddRefed<Promise> LockManager::Request(const nsAString& aName,
+ const LockOptions& aOptions,
+ LockGrantedCallback& aCallback,
+ ErrorResult& aRv) {
+ if (!mOwner->GetClientInfo()) {
+ // We do have nsPIDOMWindowInner::IsFullyActive for this kind of check,
+ // but this should be sufficient here as unloaded iframe is the only
+ // non-fully-active case that Web Locks should worry about (since it does
+ // not enter bfcache).
+ aRv.ThrowInvalidStateError(
+ "The document of the lock manager is not fully active");
+ return nullptr;
+ }
+
+ if (mOwner->GetStorageAccess() <= StorageAccess::eDeny) {
+ // Step 4: If origin is an opaque origin, then return a promise rejected
+ // with a "SecurityError" DOMException.
+ // But per https://wicg.github.io/web-locks/#lock-managers this really means
+ // whether it has storage access.
+ aRv.ThrowSecurityError("request() is not allowed in this context");
+ return nullptr;
+ }
+
+ if (!mActor) {
+ aRv.ThrowNotSupportedError(
+ "Web Locks API is not enabled for this kind of document");
+ return nullptr;
+ }
+
+ if (!ValidateRequestArguments(aName, aOptions, aRv)) {
+ return nullptr;
+ }
+
+ RefPtr<Promise> promise = Promise::Create(mOwner, aRv);
+ if (aRv.Failed()) {
+ return nullptr;
+ }
+
+ mActor->RequestLock({nsString(aName), promise, &aCallback}, aOptions);
+ return promise.forget();
+};
+
+already_AddRefed<Promise> LockManager::Query(ErrorResult& aRv) {
+ if (!mOwner->GetClientInfo()) {
+ aRv.ThrowInvalidStateError(
+ "The document of the lock manager is not fully active");
+ return nullptr;
+ }
+
+ if (mOwner->GetStorageAccess() <= StorageAccess::eDeny) {
+ aRv.ThrowSecurityError("query() is not allowed in this context");
+ return nullptr;
+ }
+
+ if (!mActor) {
+ aRv.ThrowNotSupportedError(
+ "Web Locks API is not enabled for this kind of document");
+ return nullptr;
+ }
+
+ RefPtr<Promise> promise = Promise::Create(mOwner, aRv);
+ if (aRv.Failed()) {
+ return nullptr;
+ }
+
+ mActor->SendQuery()->Then(
+ GetCurrentSerialEventTarget(), __func__,
+ [promise](locks::LockManagerChild::QueryPromise::ResolveOrRejectValue&&
+ aResult) {
+ if (aResult.IsResolve()) {
+ promise->MaybeResolve(aResult.ResolveValue());
+ } else {
+ promise->MaybeRejectWithUnknownError("Query failed");
+ }
+ });
+ return promise.forget();
+};
+
+void LockManager::Shutdown() {
+ if (mActor) {
+ locks::PLockManagerChild::Send__delete__(mActor);
+ mActor = nullptr;
+ }
+}
+
+} // namespace mozilla::dom