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

script/dom/
servointernals.rs
