script/dom/wakelock/
wakelock.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5use std::rc::Rc;
6
7use dom_struct::dom_struct;
8use embedder_traits::{AllowOrDeny, EmbedderMsg};
9use js::context::JSContext;
10use js::realm::CurrentRealm;
11use servo_constellation_traits::ScriptToConstellationMessage;
12
13use crate::dom::bindings::codegen::Bindings::DocumentBinding::{
14    DocumentMethods, DocumentVisibilityState,
15};
16use crate::dom::bindings::codegen::Bindings::WakeLockBinding::{WakeLockMethods, WakeLockType};
17use crate::dom::bindings::codegen::Bindings::WindowBinding::WindowMethods;
18use crate::dom::bindings::error::Error;
19use crate::dom::bindings::reflector::{DomGlobal, Reflector, reflect_dom_object_with_cx};
20use crate::dom::bindings::root::DomRoot;
21use crate::dom::globalscope::GlobalScope;
22use crate::dom::promise::Promise;
23use crate::dom::wakelock::wakelocksentinel::WakeLockSentinel;
24use crate::routed_promise::{RoutedPromiseListener, callback_promise};
25use crate::script_runtime::CanGc;
26
27/// <https://w3c.github.io/screen-wake-lock/#the-wakelock-interface>
28#[dom_struct]
29pub(crate) struct WakeLock {
30    reflector_: Reflector,
31}
32
33impl WakeLock {
34    pub(crate) fn new_inherited() -> Self {
35        Self {
36            reflector_: Reflector::new(),
37        }
38    }
39
40    pub(crate) fn new(cx: &mut js::context::JSContext, global: &GlobalScope) -> DomRoot<Self> {
41        reflect_dom_object_with_cx(Box::new(Self::new_inherited()), global, cx)
42    }
43}
44
45impl WakeLockMethods<crate::DomTypeHolder> for WakeLock {
46    /// <https://w3c.github.io/screen-wake-lock/#the-request-method>
47    fn Request(&self, cx: &mut CurrentRealm, _type_: WakeLockType) -> Rc<Promise> {
48        let global = GlobalScope::from_current_realm(cx);
49        let promise = Promise::new_in_realm(cx);
50
51        // Step 1. Let document be this's relevant global object's associated Document.
52        let document = global.as_window().Document();
53
54        // Step 2. If document is not fully active, reject with NotAllowedError.
55        if !document.is_fully_active() {
56            promise.reject_error(Error::NotAllowed(None), CanGc::from_cx(cx));
57            return promise;
58        }
59
60        // Step 3. If document's visibility state is "hidden", reject with NotAllowedError.
61        if document.VisibilityState() == DocumentVisibilityState::Hidden {
62            promise.reject_error(Error::NotAllowed(None), CanGc::from_cx(cx));
63            return promise;
64        }
65
66        // Step 4. Obtain permission for "screen-wake-lock".
67        // <https://w3c.github.io/screen-wake-lock/#dfn-obtain-permission>
68        let Some(webview_id) = global.webview_id() else {
69            promise.reject_error(Error::NotAllowed(None), CanGc::from_cx(cx));
70            return promise;
71        };
72
73        let task_source = global.task_manager().dom_manipulation_task_source();
74        let callback = callback_promise(&promise, self, task_source);
75        global.send_to_embedder(EmbedderMsg::RequestWakeLockPermission(webview_id, callback));
76
77        promise
78    }
79}
80
81impl RoutedPromiseListener<AllowOrDeny> for WakeLock {
82    /// <https://w3c.github.io/screen-wake-lock/#the-request-method>
83    fn handle_response(&self, cx: &mut JSContext, response: AllowOrDeny, promise: &Rc<Promise>) {
84        let can_gc = CanGc::from_cx(cx);
85        match response {
86            // Step 7a. If permission is denied, reject with NotAllowedError.
87            AllowOrDeny::Deny => {
88                promise.reject_error(Error::NotAllowed(None), can_gc);
89            },
90            // Step 7b-7c. Acquire the lock and resolve with a WakeLockSentinel.
91            AllowOrDeny::Allow => {
92                let global = self.global();
93                global.as_window().send_to_constellation(
94                    ScriptToConstellationMessage::AcquireWakeLock(
95                        servo_wakelock::WakeLockType::Screen,
96                    ),
97                );
98
99                let sentinel = WakeLockSentinel::new(cx, &global, WakeLockType::Screen);
100                promise.resolve_native(&sentinel, can_gc);
101            },
102        }
103    }
104}
script/dom/wakelock/wakelock.rs

script/dom/wakelock/
wakelock.rs
