1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
|
/* -*- 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/Permissions.h"
#include "PermissionUtils.h"
#include "mozilla/StaticPrefs_permissions.h"
#include "mozilla/dom/Document.h"
#include "mozilla/dom/MidiPermissionStatus.h"
#include "mozilla/dom/PermissionSetParametersBinding.h"
#include "mozilla/dom/PermissionStatus.h"
#include "mozilla/dom/PermissionsBinding.h"
#include "mozilla/dom/Promise.h"
#include "mozilla/dom/RootedDictionary.h"
#include "mozilla/dom/StorageAccessPermissionStatus.h"
namespace mozilla::dom {
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(Permissions)
NS_WRAPPERCACHE_INTERFACE_MAP_ENTRY
NS_INTERFACE_MAP_ENTRY(nsISupports)
NS_INTERFACE_MAP_END
NS_IMPL_CYCLE_COLLECTING_ADDREF(Permissions)
NS_IMPL_CYCLE_COLLECTING_RELEASE(Permissions)
NS_IMPL_CYCLE_COLLECTION_WRAPPERCACHE_0(Permissions)
Permissions::Permissions(nsIGlobalObject* aGlobal)
: GlobalTeardownObserver(aGlobal) {}
Permissions::~Permissions() = default;
JSObject* Permissions::WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) {
return Permissions_Binding::Wrap(aCx, this, aGivenProto);
}
namespace {
// Steps to parse PermissionDescriptor in
// https://w3c.github.io/permissions/#query-method and relevant WebDriver
// commands
RefPtr<PermissionStatus> CreatePermissionStatus(
JSContext* aCx, JS::Handle<JSObject*> aPermissionDesc,
nsIGlobalObject* aGlobal, ErrorResult& aRv) {
// Step 2: Let rootDesc be the object permissionDesc refers to, converted to
// an IDL value of type PermissionDescriptor.
PermissionDescriptor rootDesc;
JS::Rooted<JS::Value> permissionDescValue(
aCx, JS::ObjectOrNullValue(aPermissionDesc));
if (NS_WARN_IF(!rootDesc.Init(aCx, permissionDescValue))) {
// Step 3: If the conversion throws an exception, return a promise rejected
// with that exception.
// Step 4: If rootDesc["name"] is not supported, return a promise rejected
// with a TypeError. (This is done by `enum PermissionName`, as the spec
// note says: "implementers are encouraged to use their own custom enum
// here")
aRv.NoteJSContextException(aCx);
return nullptr;
}
// Step 5: Let typedDescriptor be the object permissionDesc refers to,
// converted to an IDL value of rootDesc's name's permission descriptor type.
// Step 6: If the conversion throws an exception, return a promise rejected
// with that exception.
// Step 8.1: Let status be create a PermissionStatus with typedDescriptor.
// (The rest is done by the caller)
switch (rootDesc.mName) {
case PermissionName::Midi: {
MidiPermissionDescriptor midiPerm;
if (NS_WARN_IF(!midiPerm.Init(aCx, permissionDescValue))) {
aRv.NoteJSContextException(aCx);
return nullptr;
}
return new MidiPermissionStatus(aGlobal, midiPerm.mSysex);
}
case PermissionName::Storage_access:
return new StorageAccessPermissionStatus(aGlobal);
case PermissionName::Geolocation:
case PermissionName::Notifications:
case PermissionName::Push:
case PermissionName::Persistent_storage:
case PermissionName::Screen_wake_lock:
return new PermissionStatus(aGlobal, rootDesc.mName);
case PermissionName::Camera:
if (!StaticPrefs::permissions_media_query_enabled()) {
aRv.ThrowTypeError(
"'camera' (value of 'name' member of PermissionDescriptor) is not "
"a valid value for enumeration PermissionName.");
return nullptr;
}
return new PermissionStatus(aGlobal, rootDesc.mName);
case PermissionName::Microphone:
if (!StaticPrefs::permissions_media_query_enabled()) {
aRv.ThrowTypeError(
"'microphone' (value of 'name' member of PermissionDescriptor) is "
"not a valid value for enumeration PermissionName.");
return nullptr;
}
return new PermissionStatus(aGlobal, rootDesc.mName);
default:
MOZ_ASSERT_UNREACHABLE("Unhandled type");
aRv.Throw(NS_ERROR_NOT_IMPLEMENTED);
return nullptr;
}
}
} // namespace
// https://w3c.github.io/permissions/#query-method
already_AddRefed<Promise> Permissions::Query(JSContext* aCx,
JS::Handle<JSObject*> aPermission,
ErrorResult& aRv) {
// Step 1: If this's relevant global object is a Window object, then:
// Step 1.1: If the current settings object's associated Document is not fully
// active, return a promise rejected with an "InvalidStateError" DOMException.
nsCOMPtr<nsIGlobalObject> global = GetOwnerGlobal();
if (NS_WARN_IF(!global)) {
aRv.ThrowInvalidStateError("The context is not fully active.");
return nullptr;
}
if (NS_IsMainThread()) {
nsCOMPtr<nsPIDOMWindowInner> window = do_QueryInterface(global);
if (!window || !window->IsFullyActive()) {
aRv.ThrowInvalidStateError("The document is not fully active.");
return nullptr;
}
}
// Step 2 - 6 and 8.1:
RefPtr<PermissionStatus> status =
CreatePermissionStatus(aCx, aPermission, global, aRv);
if (!status) {
return nullptr;
}
// Step 7: Let promise be a new promise.
RefPtr<Promise> promise = Promise::Create(global, aRv);
if (NS_WARN_IF(aRv.Failed())) {
return nullptr;
}
// Step 8.2 - 8.3: (Done by the Init method)
// Step 8.4: Queue a global task on the permissions task source with this's
// relevant global object to resolve promise with status.
status->Init()->Then(
GetCurrentSerialEventTarget(), __func__,
[status, promise]() {
promise->MaybeResolve(status);
return;
},
[promise](nsresult aError) {
MOZ_ASSERT(NS_FAILED(aError));
NS_WARNING("Failed PermissionStatus creation");
promise->MaybeReject(aError);
return;
});
return promise.forget();
}
already_AddRefed<PermissionStatus> Permissions::ParseSetParameters(
JSContext* aCx, const PermissionSetParameters& aParameters,
ErrorResult& aRv) {
// Step 1: Let parametersDict be the parameters argument, converted to an IDL
// value of type PermissionSetParameters. If this throws an exception,
// return an invalid argument error.
// (Done by IDL layer, and the error type should be handled by the caller)
// Step 2: If parametersDict.state is an inappropriate permission state for
// any implementation-defined reason, return a invalid argument error.
// (We don't do this)
// Step 3: Let rootDesc be parametersDict.descriptor.
JS::Rooted<JSObject*> rootDesc(aCx, aParameters.mDescriptor);
// Step 4: Let typedDescriptor be the object rootDesc refers to, converted
// to an IDL value of rootDesc.name's permission descriptor type. If this
// throws an exception, return a invalid argument error.
//
// We use PermissionStatus as the typed object.
RefPtr<PermissionStatus> status =
CreatePermissionStatus(aCx, rootDesc, nullptr, aRv);
if (aRv.Failed()) {
return nullptr;
}
// Set the state too so that the caller can use it for step 5.
status->SetState(aParameters.mState);
return status.forget();
}
} // namespace mozilla::dom
|