script/dom/
servointernals.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 js::gc::MutableHandleValue;
9use js::jsapi::Heap;
10use js::jsval::UndefinedValue;
11use js::rust::HandleObject;
12use profile_traits::mem::MemoryReportResult;
13use script_bindings::conversions::SafeToJSValConvertible;
14use script_bindings::error::{Error, Fallible};
15use script_bindings::interfaces::ServoInternalsHelpers;
16use script_bindings::reflector::{Reflector, reflect_dom_object};
17use script_bindings::script_runtime::JSContext;
18use script_bindings::str::USVString;
19use servo_config::prefs::{self, PrefValue, Preferences};
20use servo_constellation_traits::ScriptToConstellationMessage;
21
22use crate::dom::bindings::codegen::Bindings::ServoInternalsBinding::ServoInternalsMethods;
23use crate::dom::bindings::import::base::SafeJSContext;
24use crate::dom::bindings::reflector::DomGlobal;
25use crate::dom::bindings::root::DomRoot;
26use crate::dom::globalscope::GlobalScope;
27use crate::dom::promise::Promise;
28use crate::realms::{AlreadyInRealm, InRealm};
29use crate::routed_promise::{RoutedPromiseListener, callback_promise};
30use crate::script_runtime::CanGc;
31use crate::script_thread::ScriptThread;
32
33fn pref_to_jsval(pref: &PrefValue, cx: JSContext, rval: MutableHandleValue, can_gc: CanGc) {
34    match pref {
35        PrefValue::Bool(b) => b.safe_to_jsval(cx, rval, can_gc),
36        PrefValue::Int(i) => i.safe_to_jsval(cx, rval, can_gc),
37        PrefValue::UInt(u) => u.safe_to_jsval(cx, rval, can_gc),
38        PrefValue::Str(s) => s.safe_to_jsval(cx, rval, can_gc),
39        PrefValue::Float(f) => f.safe_to_jsval(cx, rval, can_gc),
40        PrefValue::Array(arr) => {
41            rooted_vec!(let mut js_arr);
42            for item in arr {
43                rooted!(in(*cx) let mut js_val = UndefinedValue());
44                pref_to_jsval(item, cx, js_val.handle_mut(), can_gc);
45                js_arr.push(Heap::boxed(js_val.get()));
46            }
47            js_arr.safe_to_jsval(cx, rval, can_gc);
48        },
49    }
50}
51
52#[dom_struct]
53pub(crate) struct ServoInternals {
54    reflector_: Reflector,
55}
56
57impl ServoInternals {
58    pub fn new_inherited() -> ServoInternals {
59        ServoInternals {
60            reflector_: Reflector::new(),
61        }
62    }
63
64    pub(crate) fn new(global: &GlobalScope, can_gc: CanGc) -> DomRoot<ServoInternals> {
65        reflect_dom_object(Box::new(ServoInternals::new_inherited()), global, can_gc)
66    }
67}
68
69impl ServoInternalsMethods<crate::DomTypeHolder> for ServoInternals {
70    /// <https://servo.org/internal-no-spec>
71    fn ReportMemory(&self, comp: InRealm, can_gc: CanGc) -> Rc<Promise> {
72        let global = &self.global();
73        let promise = Promise::new_in_current_realm(comp, can_gc);
74        let task_source = global.task_manager().dom_manipulation_task_source();
75        let callback = callback_promise(&promise, self, task_source);
76
77        let script_to_constellation_chan = global.script_to_constellation_chan();
78        if script_to_constellation_chan
79            .send(ScriptToConstellationMessage::ReportMemory(callback))
80            .is_err()
81        {
82            promise.reject_error(Error::Operation(None), can_gc);
83        }
84        promise
85    }
86
87    /// <https://servo.org/internal-no-spec>
88    fn GarbageCollectAllContexts(&self) {
89        let global = &self.global();
90
91        let script_to_constellation_chan = global.script_to_constellation_chan();
92        let _ = script_to_constellation_chan
93            .send(ScriptToConstellationMessage::TriggerGarbageCollection);
94    }
95
96    /// <https://servo.org/internal-no-spec>
97    fn PreferenceList(&self) -> Vec<USVString> {
98        Preferences::all_fields()
99            .into_iter()
100            .map(|s| USVString::from(s.to_string()))
101            .collect()
102    }
103
104    /// <https://servo.org/internal-no-spec>
105    fn PreferenceType(&self, name: USVString) -> Fallible<USVString> {
106        if !Preferences::exists(&name) {
107            return Err(Error::NotFound(None));
108        }
109        let type_name = Preferences::type_of(&name).split("::").last().unwrap();
110        Ok(USVString::from(type_name.to_string()))
111    }
112
113    /// <https://servo.org/internal-no-spec>
114    fn DefaultPreferenceValue(
115        &self,
116        cx: SafeJSContext,
117        name: USVString,
118        rval: MutableHandleValue,
119    ) -> Fallible<()> {
120        if !Preferences::exists(&name) {
121            return Err(Error::NotFound(None));
122        }
123        let pref = Preferences::default().get_value(&name);
124        pref_to_jsval(&pref, cx, rval, CanGc::deprecated_note());
125        Ok(())
126    }
127
128    /// <https://servo.org/internal-no-spec>
129    fn GetPreference(
130        &self,
131        cx: JSContext,
132        name: USVString,
133        rval: MutableHandleValue,
134    ) -> Fallible<()> {
135        if !Preferences::exists(&name) {
136            return Err(Error::NotFound(None));
137        }
138        let pref = prefs::get().get_value(&name);
139        pref_to_jsval(&pref, cx, rval, CanGc::deprecated_note());
140        Ok(())
141    }
142
143    /// <https://servo.org/internal-no-spec>
144    fn GetBoolPreference(&self, name: USVString) -> Fallible<bool> {
145        if !Preferences::exists(&name) {
146            return Err(Error::NotFound(None));
147        }
148        if let PrefValue::Bool(b) = prefs::get().get_value(&name) {
149            return Ok(b);
150        }
151        Err(Error::TypeMismatch(None))
152    }
153
154    /// <https://servo.org/internal-no-spec>
155    fn GetIntPreference(&self, name: USVString) -> Fallible<i64> {
156        if !Preferences::exists(&name) {
157            return Err(Error::NotFound(None));
158        }
159        if let PrefValue::Int(i) = prefs::get().get_value(&name) {
160            return Ok(i);
161        }
162        Err(Error::TypeMismatch(None))
163    }
164
165    /// <https://servo.org/internal-no-spec>
166    fn GetStringPreference(&self, name: USVString) -> Fallible<USVString> {
167        if !Preferences::exists(&name) {
168            return Err(Error::NotFound(None));
169        }
170        if let PrefValue::Str(s) = prefs::get().get_value(&name) {
171            return Ok(s.into());
172        }
173        Err(Error::TypeMismatch(None))
174    }
175
176    /// <https://servo.org/internal-no-spec>
177    fn SetBoolPreference(&self, name: USVString, value: bool) {
178        let mut current_prefs = prefs::get().clone();
179        current_prefs.set_value(&name, value.into());
180        prefs::set(current_prefs);
181    }
182
183    /// <https://servo.org/internal-no-spec>
184    fn SetIntPreference(&self, name: USVString, value: i64) {
185        let mut current_prefs = prefs::get().clone();
186        current_prefs.set_value(&name, value.into());
187        prefs::set(current_prefs);
188    }
189
190    /// <https://servo.org/internal-no-spec>
191    fn SetStringPreference(&self, name: USVString, value: USVString) {
192        let mut current_prefs = prefs::get().clone();
193        current_prefs.set_value(&name, value.0.into());
194        prefs::set(current_prefs);
195    }
196}
197
198impl RoutedPromiseListener<MemoryReportResult> for ServoInternals {
199    fn handle_response(
200        &self,
201        cx: &mut js::context::JSContext,
202        response: MemoryReportResult,
203        promise: &Rc<Promise>,
204    ) {
205        let stringified = serde_json::to_string(&response.results)
206            .unwrap_or_else(|_| "{ error: \"failed to create memory report\"}".to_owned());
207        promise.resolve_native(&stringified, CanGc::from_cx(cx));
208    }
209}
210
211impl ServoInternalsHelpers for ServoInternals {
212    /// The navigator.servo api is exposed to about: pages except about:blank, as
213    /// well as any URLs provided by embedders that register new protocol handlers.
214    #[expect(unsafe_code)]
215    fn is_servo_internal(cx: JSContext, _global: HandleObject) -> bool {
216        unsafe {
217            let in_realm_proof = AlreadyInRealm::assert_for_cx(cx);
218            let global_scope = GlobalScope::from_context(*cx, InRealm::Already(&in_realm_proof));
219            let url = global_scope.get_url();
220            (url.scheme() == "about" && url.as_str() != "about:blank") ||
221                ScriptThread::is_servo_privileged(url)
222        }
223    }
224}
script/dom/servointernals.rs

script/dom/
servointernals.rs
