1use script_bindings::reflector::{DomObject, reflect_dom_object};
6use servo_base::generic_channel::{GenericCallback, GenericSender};
7use servo_bluetooth_traits::{BluetoothError, BluetoothRequest, GATTType};
8use servo_bluetooth_traits::{BluetoothResponse, BluetoothResponseResult};
9use servo_bluetooth_traits::blocklist::{Blocklist, uuid_is_blocklisted};
10use servo_bluetooth_traits::scanfilter::{BluetoothScanfilter, BluetoothScanfilterSequence};
11use servo_bluetooth_traits::scanfilter::{RequestDeviceoptions, ServiceUUIDSequence};
12use js::realm::CurrentRealm;
13use script_bindings::cformat;
14use crate::conversions::Convert;
15use script_bindings::cell::{Ref, DomRefCell};
16use crate::dom::bindings::codegen::Bindings::BluetoothBinding::BluetoothDataFilterInit;
17use crate::dom::bindings::codegen::Bindings::BluetoothBinding::{BluetoothMethods, RequestDeviceOptions};
18use crate::dom::bindings::codegen::Bindings::BluetoothBinding::BluetoothLEScanFilterInit;
19use crate::dom::bindings::codegen::Bindings::BluetoothPermissionResultBinding::BluetoothPermissionDescriptor;
20use crate::dom::bindings::codegen::Bindings::BluetoothRemoteGATTServerBinding::BluetoothRemoteGATTServer_Binding::
21BluetoothRemoteGATTServerMethods;
22use crate::dom::bindings::codegen::Bindings::PermissionStatusBinding::{PermissionName, PermissionState};
23use crate::dom::bindings::codegen::UnionTypes::{ArrayBufferViewOrArrayBuffer, StringOrUnsignedLong};
24use crate::dom::bindings::error::Error::{self, Network, Security, Type};
25use crate::dom::bindings::error::Fallible;
26use crate::dom::bindings::refcounted::{Trusted, TrustedPromise};
27use crate::dom::bindings::reflector::DomGlobal;
28use crate::dom::bindings::root::{Dom, DomRoot};
29use crate::dom::bindings::str::DOMString;
30use crate::dom::bluetoothdevice::BluetoothDevice;
31use crate::dom::bluetoothpermissionresult::BluetoothPermissionResult;
32use crate::dom::bluetoothuuid::{BluetoothServiceUUID, BluetoothUUID, UUID};
33use crate::dom::eventtarget::EventTarget;
34use crate::dom::globalscope::GlobalScope;
35use crate::dom::permissions::{descriptor_permission_state, PermissionAlgorithm};
36use crate::dom::promise::Promise;
37use crate::script_runtime::CanGc;
38use crate::task::TaskOnce;
39use dom_struct::dom_struct;
40use js::conversions::ConversionResult;
41use js::jsapi::JSObject;
42use js::jsval::{ObjectValue, UndefinedValue};
43use profile_traits::{generic_channel};
44use std::collections::HashMap;
45use std::ffi::CStr;
46use std::rc::Rc;
47use std::sync::{Arc, Mutex};
48
49const KEY_CONVERSION_ERROR: &str =
50 "This `manufacturerData` key can not be parsed as unsigned short:";
51const FILTER_EMPTY_ERROR: &CStr =
52 c"'filters' member, if present, must be nonempty to find any devices.";
53const FILTER_ERROR: &CStr = c"A filter must restrict the devices in some way.";
54const MANUFACTURER_DATA_ERROR: &CStr =
55 c"'manufacturerData', if present, must be non-empty to filter devices.";
56const MASK_LENGTH_ERROR: &CStr = c"`mask`, if present, must have the same length as `dataPrefix`.";
57const MAX_DEVICE_NAME_LENGTH: usize = 248;
59const NAME_PREFIX_ERROR: &CStr = c"'namePrefix', if present, must be nonempty.";
60const NAME_TOO_LONG_ERROR: &CStr = c"A device name can't be longer than 248 bytes.";
61const SERVICE_DATA_ERROR: &CStr =
62 c"'serviceData', if present, must be non-empty to filter devices.";
63const SERVICE_ERROR: &CStr = c"'services', if present, must contain at least one service.";
64const OPTIONS_ERROR: &CStr = c"Fields of 'options' conflict with each other.
65 Either 'acceptAllDevices' member must be true, or 'filters' member must be set to a value.";
66const BT_DESC_CONVERSION_ERROR: &CStr =
67 c"Can't convert to an IDL value of type BluetoothPermissionDescriptor";
68
69#[derive(JSTraceable, MallocSizeOf)]
70#[expect(non_snake_case)]
71pub(crate) struct AllowedBluetoothDevice {
72 pub(crate) deviceId: DOMString,
73 pub(crate) mayUseGATT: bool,
74}
75
76#[derive(JSTraceable, MallocSizeOf)]
77pub(crate) struct BluetoothExtraPermissionData {
78 allowed_devices: DomRefCell<Vec<AllowedBluetoothDevice>>,
79}
80
81impl BluetoothExtraPermissionData {
82 pub(crate) fn new() -> BluetoothExtraPermissionData {
83 BluetoothExtraPermissionData {
84 allowed_devices: DomRefCell::new(Vec::new()),
85 }
86 }
87
88 pub(crate) fn add_new_allowed_device(&self, allowed_device: AllowedBluetoothDevice) {
89 self.allowed_devices.borrow_mut().push(allowed_device);
90 }
91
92 fn get_allowed_devices(&self) -> Ref<'_, Vec<AllowedBluetoothDevice>> {
93 self.allowed_devices.borrow()
94 }
95
96 pub(crate) fn allowed_devices_contains_id(&self, id: DOMString) -> bool {
97 self.allowed_devices
98 .borrow()
99 .iter()
100 .any(|d| d.deviceId == id)
101 }
102}
103
104impl Default for BluetoothExtraPermissionData {
105 fn default() -> Self {
106 Self::new()
107 }
108}
109
110struct BluetoothContext<T: AsyncBluetoothListener + DomObject> {
111 promise: Option<TrustedPromise>,
112 receiver: Trusted<T>,
113}
114
115pub(crate) trait AsyncBluetoothListener {
116 fn handle_response(
117 &self,
118 cx: &mut js::context::JSContext,
119 result: BluetoothResponse,
120 promise: &Rc<Promise>,
121 );
122}
123
124impl<T> BluetoothContext<T>
125where
126 T: AsyncBluetoothListener + DomObject,
127{
128 fn response(&mut self, cx: &mut js::context::JSContext, response: BluetoothResponseResult) {
129 let promise = self.promise.take().expect("bt promise is missing").root();
130
131 match response {
134 Ok(response) => self.receiver.root().handle_response(cx, response, &promise),
135 Err(error) => promise.reject_error(error.convert(), CanGc::from_cx(cx)),
138 }
139 }
140}
141
142#[dom_struct]
144pub(crate) struct Bluetooth {
145 eventtarget: EventTarget,
146 device_instance_map: DomRefCell<HashMap<String, Dom<BluetoothDevice>>>,
147}
148
149impl Bluetooth {
150 pub(crate) fn new_inherited() -> Bluetooth {
151 Bluetooth {
152 eventtarget: EventTarget::new_inherited(),
153 device_instance_map: DomRefCell::new(HashMap::new()),
154 }
155 }
156
157 pub(crate) fn new(global: &GlobalScope, can_gc: CanGc) -> DomRoot<Bluetooth> {
158 reflect_dom_object(Box::new(Bluetooth::new_inherited()), global, can_gc)
159 }
160
161 fn get_bluetooth_thread(&self) -> GenericSender<BluetoothRequest> {
162 self.global().as_window().bluetooth_thread()
163 }
164
165 pub(crate) fn get_device_map(&self) -> &DomRefCell<HashMap<String, Dom<BluetoothDevice>>> {
166 &self.device_instance_map
167 }
168
169 fn request_bluetooth_devices(
171 &self,
172 cx: &mut js::context::JSContext,
173 p: &Rc<Promise>,
174 filters: &Option<Vec<BluetoothLEScanFilterInit>>,
175 optional_services: &[BluetoothServiceUUID],
176 sender: GenericCallback<BluetoothResponseResult>,
177 ) {
178 let mut uuid_filters = vec![];
182
183 if let Some(filters) = filters {
184 if filters.is_empty() {
186 p.reject_error(Type(FILTER_EMPTY_ERROR.to_owned()), CanGc::from_cx(cx));
187 return;
188 }
189
190 for filter in filters {
194 match canonicalize_filter(filter) {
196 Ok(f) => uuid_filters.push(f),
198 Err(e) => {
199 p.reject_error(e, CanGc::from_cx(cx));
200 return;
201 },
202 }
203 }
205 }
206
207 let mut optional_services_uuids = vec![];
208 for opt_service in optional_services {
209 let uuid = match BluetoothUUID::service(opt_service.clone()) {
211 Ok(u) => u.to_string(),
212 Err(e) => {
213 p.reject_error(e, CanGc::from_cx(cx));
214 return;
215 },
216 };
217
218 if !uuid_is_blocklisted(uuid.as_ref(), Blocklist::All) {
222 optional_services_uuids.push(uuid);
223 }
224 }
225
226 let option = RequestDeviceoptions::new(
227 self.global().as_window().webview_id(),
228 BluetoothScanfilterSequence::new(uuid_filters),
229 ServiceUUIDSequence::new(optional_services_uuids),
230 );
231
232 if let PermissionState::Denied =
234 descriptor_permission_state(PermissionName::Bluetooth, None)
235 {
236 return p.reject_error(Error::NotFound(None), CanGc::from_cx(cx));
237 }
238
239 self.get_bluetooth_thread()
242 .send(BluetoothRequest::RequestDevice(option, sender))
243 .unwrap();
244 }
245}
246
247pub(crate) fn response_async<T: AsyncBluetoothListener + DomObject + 'static>(
248 promise: &Rc<Promise>,
249 receiver: &T,
250) -> GenericCallback<BluetoothResponseResult> {
251 let task_source = receiver
252 .global()
253 .task_manager()
254 .networking_task_source()
255 .to_sendable();
256 let context = Arc::new(Mutex::new(BluetoothContext {
257 promise: Some(TrustedPromise::new(promise.clone())),
258 receiver: Trusted::new(receiver),
259 }));
260 GenericCallback::new(move |message| {
261 struct ListenerTask<T: AsyncBluetoothListener + DomObject> {
262 context: Arc<Mutex<BluetoothContext<T>>>,
263 action: BluetoothResponseResult,
264 }
265
266 impl<T> TaskOnce for ListenerTask<T>
267 where
268 T: AsyncBluetoothListener + DomObject,
269 {
270 fn run_once(self, cx: &mut js::context::JSContext) {
271 let mut context = self.context.lock().unwrap();
272 context.response(cx, self.action);
273 }
274 }
275
276 let task = ListenerTask {
277 context: context.clone(),
278 action: message.unwrap(),
279 };
280
281 task_source.queue_unconditionally(task);
282 })
283 .expect("Could not create callback")
284}
285
286#[allow(clippy::too_many_arguments)]
288pub(crate) fn get_gatt_children<T, F>(
289 cx: &mut CurrentRealm,
290 attribute: &T,
291 single: bool,
292 uuid_canonicalizer: F,
293 uuid: Option<StringOrUnsignedLong>,
294 instance_id: String,
295 connected: bool,
296 child_type: GATTType,
297) -> Rc<Promise>
298where
299 T: AsyncBluetoothListener + DomObject + 'static,
300 F: FnOnce(StringOrUnsignedLong) -> Fallible<UUID>,
301{
302 let p = Promise::new_in_realm(cx);
303
304 let result_uuid = if let Some(u) = uuid {
305 let canonicalized = match uuid_canonicalizer(u) {
307 Ok(canonicalized_uuid) => canonicalized_uuid.to_string(),
308 Err(e) => {
309 p.reject_error(e, CanGc::from_cx(cx));
310 return p;
311 },
312 };
313 if uuid_is_blocklisted(canonicalized.as_ref(), Blocklist::All) {
315 p.reject_error(Security(None), CanGc::from_cx(cx));
316 return p;
317 }
318 Some(canonicalized)
319 } else {
320 None
321 };
322
323 if !connected {
325 p.reject_error(Network(None), CanGc::from_cx(cx));
326 return p;
327 }
328
329 let sender = response_async(&p, attribute);
334 attribute
335 .global()
336 .as_window()
337 .bluetooth_thread()
338 .send(BluetoothRequest::GetGATTChildren(
339 instance_id,
340 result_uuid,
341 single,
342 child_type,
343 sender,
344 ))
345 .unwrap();
346 p
347}
348
349fn canonicalize_filter(filter: &BluetoothLEScanFilterInit) -> Fallible<BluetoothScanfilter> {
351 if filter.services.is_none() &&
353 filter.name.is_none() &&
354 filter.namePrefix.is_none() &&
355 filter.manufacturerData.is_none() &&
356 filter.serviceData.is_none()
357 {
358 return Err(Type(FILTER_ERROR.to_owned()));
359 }
360
361 let services_vec = match filter.services {
366 Some(ref services) => {
367 if services.is_empty() {
369 return Err(Type(SERVICE_ERROR.to_owned()));
370 }
371
372 let mut services_vec = vec![];
373
374 for service in services {
375 let uuid = BluetoothUUID::service(service.clone())?.to_string();
377
378 if uuid_is_blocklisted(uuid.as_ref(), Blocklist::All) {
380 return Err(Security(None));
381 }
382
383 services_vec.push(uuid);
384 }
385 services_vec
387 },
388 None => vec![],
389 };
390
391 let name = match filter.name {
393 Some(ref name) => {
394 if name.len() > MAX_DEVICE_NAME_LENGTH {
397 return Err(Type(NAME_TOO_LONG_ERROR.to_owned()));
398 }
399
400 Some(name.to_string())
402 },
403 None => None,
404 };
405
406 let name_prefix = match filter.namePrefix {
408 Some(ref name_prefix) => {
409 if name_prefix.is_empty() {
411 return Err(Type(NAME_PREFIX_ERROR.to_owned()));
412 }
413 if name_prefix.len() > MAX_DEVICE_NAME_LENGTH {
414 return Err(Type(NAME_TOO_LONG_ERROR.to_owned()));
415 }
416
417 name_prefix.to_string()
419 },
420 None => String::new(),
421 };
422
423 let manufacturer_data = match filter.manufacturerData {
425 Some(ref manufacturer_data_map) => {
426 if manufacturer_data_map.is_empty() {
428 return Err(Type(MANUFACTURER_DATA_ERROR.to_owned()));
429 }
430 let mut map = HashMap::new();
431 for (key, bdfi) in manufacturer_data_map.iter() {
432 let manufacturer_id = match key.str().parse::<u16>() {
434 Ok(id) => id,
435 Err(err) => {
436 return Err(Type(cformat!("{} {} {}", KEY_CONVERSION_ERROR, key, err)));
437 },
438 };
439
440 map.insert(
444 manufacturer_id,
445 canonicalize_bluetooth_data_filter_init(bdfi)?,
446 );
447 }
448 Some(map)
449 },
450 None => None,
451 };
452
453 let service_data = match filter.serviceData {
455 Some(ref service_data_map) => {
456 if service_data_map.is_empty() {
458 return Err(Type(SERVICE_DATA_ERROR.to_owned()));
459 }
460 let mut map = HashMap::new();
461 for (key, bdfi) in service_data_map.iter() {
462 let service_name = match key.str().parse::<u32>() {
463 Ok(number) => StringOrUnsignedLong::UnsignedLong(number),
465 _ => StringOrUnsignedLong::String(key.clone()),
467 };
468
469 let service = BluetoothUUID::service(service_name)?.to_string();
471
472 if uuid_is_blocklisted(service.as_ref(), Blocklist::All) {
474 return Err(Security(None));
475 }
476
477 map.insert(service, canonicalize_bluetooth_data_filter_init(bdfi)?);
481 }
482 Some(map)
483 },
484 None => None,
485 };
486
487 Ok(BluetoothScanfilter::new(
489 name,
490 name_prefix,
491 services_vec,
492 manufacturer_data,
493 service_data,
494 ))
495}
496
497fn canonicalize_bluetooth_data_filter_init(
499 bdfi: &BluetoothDataFilterInit,
500) -> Fallible<(Vec<u8>, Vec<u8>)> {
501 let data_prefix = match bdfi.dataPrefix {
503 Some(ArrayBufferViewOrArrayBuffer::ArrayBufferView(ref avb)) => avb.to_vec(),
504 Some(ArrayBufferViewOrArrayBuffer::ArrayBuffer(ref ab)) => ab.to_vec(),
505 None => vec![],
506 };
507
508 let mask = match bdfi.mask {
512 Some(ArrayBufferViewOrArrayBuffer::ArrayBufferView(ref avb)) => avb.to_vec(),
513 Some(ArrayBufferViewOrArrayBuffer::ArrayBuffer(ref ab)) => ab.to_vec(),
514 None => vec![0xFF; data_prefix.len()],
515 };
516
517 if mask.len() != data_prefix.len() {
519 return Err(Type(MASK_LENGTH_ERROR.to_owned()));
520 }
521
522 Ok((data_prefix, mask))
524}
525
526impl Convert<Error> for BluetoothError {
527 fn convert(self) -> Error {
528 match self {
529 BluetoothError::Type(message) => Error::Type(cformat!("{message}")),
530 BluetoothError::Network => Error::Network(None),
531 BluetoothError::NotFound => Error::NotFound(None),
532 BluetoothError::NotSupported => Error::NotSupported(None),
533 BluetoothError::Security => Error::Security(None),
534 BluetoothError::InvalidState => Error::InvalidState(None),
535 }
536 }
537}
538
539impl BluetoothMethods<crate::DomTypeHolder> for Bluetooth {
540 fn RequestDevice(&self, cx: &mut CurrentRealm, option: &RequestDeviceOptions) -> Rc<Promise> {
542 let p = Promise::new_in_realm(cx);
543 if (option.filters.is_some() && option.acceptAllDevices) ||
545 (option.filters.is_none() && !option.acceptAllDevices)
546 {
547 p.reject_error(Error::Type(OPTIONS_ERROR.to_owned()), CanGc::from_cx(cx));
548 return p;
549 }
550
551 let sender = response_async(&p, self);
553 self.request_bluetooth_devices(cx, &p, &option.filters, &option.optionalServices, sender);
554 p
556 }
557
558 fn GetAvailability(&self, cx: &mut CurrentRealm) -> Rc<Promise> {
560 let p = Promise::new_in_realm(cx);
561 let sender = response_async(&p, self);
564 self.get_bluetooth_thread()
565 .send(BluetoothRequest::GetAvailability(sender))
566 .unwrap();
567 p
568 }
569
570 event_handler!(
572 availabilitychanged,
573 GetOnavailabilitychanged,
574 SetOnavailabilitychanged
575 );
576}
577
578impl AsyncBluetoothListener for Bluetooth {
579 fn handle_response(
580 &self,
581 cx: &mut js::context::JSContext,
582 response: BluetoothResponse,
583 promise: &Rc<Promise>,
584 ) {
585 match response {
586 BluetoothResponse::RequestDevice(device) => {
589 let mut device_instance_map = self.device_instance_map.borrow_mut();
590 if let Some(existing_device) = device_instance_map.get(&device.id) {
591 return promise.resolve_native(&**existing_device, CanGc::from_cx(cx));
592 }
593 let bt_device = BluetoothDevice::new(
594 cx,
595 &self.global(),
596 DOMString::from(device.id.clone()),
597 device.name.map(DOMString::from),
598 self,
599 );
600 device_instance_map.insert(device.id.clone(), Dom::from_ref(&bt_device));
601
602 self.global()
603 .as_window()
604 .bluetooth_extra_permission_data()
605 .add_new_allowed_device(AllowedBluetoothDevice {
606 deviceId: DOMString::from(device.id),
607 mayUseGATT: true,
608 });
609 promise.resolve_native(&bt_device, CanGc::from_cx(cx));
612 },
613 BluetoothResponse::GetAvailability(is_available) => {
616 promise.resolve_native(&is_available, CanGc::from_cx(cx));
617 },
618 _ => promise.reject_error(
619 Error::Type(c"Something went wrong...".to_owned()),
620 CanGc::from_cx(cx),
621 ),
622 }
623 }
624}
625
626impl PermissionAlgorithm for Bluetooth {
627 type Descriptor = BluetoothPermissionDescriptor;
628 type Status = BluetoothPermissionResult;
629
630 fn create_descriptor(
631 cx: &mut js::context::JSContext,
632 permission_descriptor_obj: *mut JSObject,
633 ) -> Result<BluetoothPermissionDescriptor, Error> {
634 rooted!(&in(cx) let mut property = UndefinedValue());
635 property
636 .handle_mut()
637 .set(ObjectValue(permission_descriptor_obj));
638 match BluetoothPermissionDescriptor::new(cx.into(), property.handle(), CanGc::from_cx(cx)) {
639 Ok(ConversionResult::Success(descriptor)) => Ok(descriptor),
640 Ok(ConversionResult::Failure(error)) => Err(Error::Type(error.into_owned())),
641 Err(_) => Err(Error::Type(BT_DESC_CONVERSION_ERROR.into())),
642 }
643 }
644
645 fn permission_query(
647 cx: &mut js::context::JSContext,
648 promise: &Rc<Promise>,
649 descriptor: &BluetoothPermissionDescriptor,
650 status: &BluetoothPermissionResult,
651 ) {
652 status.set_state(descriptor_permission_state(status.get_query(), None));
656
657 if let PermissionState::Denied = status.get_state() {
659 status.set_devices(Vec::new());
660 return promise.resolve_native(status, CanGc::from_cx(cx));
661 }
662
663 rooted_vec!(let mut matching_devices);
665
666 let global = status.global();
668 let allowed_devices = global
669 .as_window()
670 .bluetooth_extra_permission_data()
671 .get_allowed_devices();
672
673 let bluetooth = status.get_bluetooth();
674 let device_map = bluetooth.get_device_map().borrow();
675
676 for allowed_device in allowed_devices.iter() {
678 if let Some(ref id) = descriptor.deviceId &&
680 &allowed_device.deviceId != id
681 {
682 continue;
683 }
684 let device_id = String::from(allowed_device.deviceId.str());
685
686 if let Some(ref filters) = descriptor.filters {
688 let mut scan_filters: Vec<BluetoothScanfilter> = Vec::new();
689
690 for filter in filters {
692 match canonicalize_filter(filter) {
693 Ok(f) => scan_filters.push(f),
694 Err(error) => return promise.reject_error(error, CanGc::from_cx(cx)),
695 }
696 }
697
698 let (sender, receiver) =
702 generic_channel::channel(global.time_profiler_chan().clone()).unwrap();
703 status
704 .get_bluetooth_thread()
705 .send(BluetoothRequest::MatchesFilter(
706 device_id.clone(),
707 BluetoothScanfilterSequence::new(scan_filters),
708 sender,
709 ))
710 .unwrap();
711
712 match receiver.recv().unwrap() {
713 Ok(true) => (),
714 Ok(false) => continue,
715 Err(error) => return promise.reject_error(error.convert(), CanGc::from_cx(cx)),
716 };
717 }
718
719 if let Some(device) = device_map.get(&device_id) {
723 matching_devices.push(Dom::from_ref(&**device));
724 }
725 }
726
727 status.set_devices(std::mem::take(&mut matching_devices));
729
730 promise.resolve_native(status, CanGc::from_cx(cx));
733 }
734
735 fn permission_request(
737 cx: &mut js::context::JSContext,
738 promise: &Rc<Promise>,
739 descriptor: &BluetoothPermissionDescriptor,
740 status: &BluetoothPermissionResult,
741 ) {
742 if descriptor.filters.is_some() == descriptor.acceptAllDevices {
744 return promise.reject_error(Error::Type(OPTIONS_ERROR.to_owned()), CanGc::from_cx(cx));
745 }
746
747 let sender = response_async(promise, status);
749 let bluetooth = status.get_bluetooth();
750 bluetooth.request_bluetooth_devices(
751 cx,
752 promise,
753 &descriptor.filters,
754 &descriptor.optionalServices,
755 sender,
756 );
757
758 }
760
761 fn permission_revoke(
763 cx: &mut js::context::JSContext,
764 _descriptor: &BluetoothPermissionDescriptor,
765 status: &BluetoothPermissionResult,
766 ) {
767 let global = status.global();
769 let allowed_devices = global
770 .as_window()
771 .bluetooth_extra_permission_data()
772 .get_allowed_devices();
773 let bluetooth = status.get_bluetooth();
775 let device_map = bluetooth.get_device_map().borrow();
776 for (id, device) in device_map.iter() {
777 let id = DOMString::from(id.clone());
778 if allowed_devices.iter().any(|d| d.deviceId == id) &&
780 !device.is_represented_device_null()
781 {
782 continue;
786 }
787 let _ = device.get_gatt(cx).Disconnect(cx);
789 }
790 }
791}