bluetooth: Implement Service.getCharacteristics

content/browser/bluetooth/bluetooth_dispatcher_host.cc

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // ID Not In Map Note:
 // A service, characteristic, or descriptor ID not in the corresponding
 // BluetoothDispatcherHost map [service_to_device_, characteristic_to_service_,
 // descriptor_to_characteristic_] implies a hostile renderer because a renderer
 // obtains the corresponding ID from this class and it will be added to the map
 // at that time.
@@ skipping 289 matching lines @@
 bool BluetoothDispatcherHost::OnMessageReceived(const IPC::Message& message) {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
   bool handled = true;
   IPC_BEGIN_MESSAGE_MAP(BluetoothDispatcherHost, message)
   IPC_MESSAGE_HANDLER(BluetoothHostMsg_RequestDevice, OnRequestDevice)
   IPC_MESSAGE_HANDLER(BluetoothHostMsg_GATTServerConnect, OnGATTServerConnect)
   IPC_MESSAGE_HANDLER(BluetoothHostMsg_GATTServerDisconnect,
                       OnGATTServerDisconnect)
   IPC_MESSAGE_HANDLER(BluetoothHostMsg_GetPrimaryService, OnGetPrimaryService)
   IPC_MESSAGE_HANDLER(BluetoothHostMsg_GetCharacteristic, OnGetCharacteristic)
+  IPC_MESSAGE_HANDLER(BluetoothHostMsg_GetCharacteristics, OnGetCharacteristics)
   IPC_MESSAGE_HANDLER(BluetoothHostMsg_ReadValue, OnReadValue)
   IPC_MESSAGE_HANDLER(BluetoothHostMsg_WriteValue, OnWriteValue)
   IPC_MESSAGE_HANDLER(BluetoothHostMsg_StartNotifications, OnStartNotifications)
   IPC_MESSAGE_HANDLER(BluetoothHostMsg_StopNotifications, OnStopNotifications)
   IPC_MESSAGE_HANDLER(BluetoothHostMsg_RegisterCharacteristic,
                       OnRegisterCharacteristicObject);
   IPC_MESSAGE_HANDLER(BluetoothHostMsg_UnregisterCharacteristic,
                       OnUnregisterCharacteristicObject);
   IPC_MESSAGE_UNHANDLED(handled = false)
   IPC_END_MESSAGE_MAP()
@@ skipping 506 matching lines @@
           thread_id, request_id, characteristic_instance_id,
           static_cast<uint32_t>(characteristic->GetProperties())));
       return;
     }
   }
   RecordGetCharacteristicOutcome(UMAGetCharacteristicOutcome::NOT_FOUND);
   Send(new BluetoothMsg_GetCharacteristicError(
       thread_id, request_id, WebBluetoothError::CharacteristicNotFound));
 }
 
+void BluetoothDispatcherHost::OnGetCharacteristics(
+    int thread_id,
+    int request_id,
+    int frame_routing_id,
+    const std::string& service_instance_id,
+    const std::string& characteristic_uuid) {
+  DCHECK_CURRENTLY_ON(BrowserThread::UI);
+  RecordWebBluetoothFunctionCall(
+      UMAWebBluetoothFunction::SERVICE_GET_CHARACTERISTICS);
+  RecordGetCharacteristicsCharacteristic(characteristic_uuid);
+
+  const CacheQueryResult query_result =
+      QueryCacheForService(GetOrigin(frame_routing_id), service_instance_id);
+
+  if (query_result.outcome == CacheQueryOutcome::BAD_RENDERER) {
+    return;
+  }
+
+  if (query_result.outcome != CacheQueryOutcome::SUCCESS) {
+    RecordGetCharacteristicsOutcome(query_result.outcome);
+    Send(new BluetoothMsg_GetCharacteristicsError(thread_id, request_id,
+                                                  query_result.GetWebError()));
+    return;
+  }
+
+  std::vector<std::string> characteristics_instance_ids;

[Jeffrey Yasskin, 2016/02/24 23:20:29]

Can we transpose these three vectors? That is, make an IPC struct holding an
instance_id, a UUID, and a properties bit-array, and send a vector of those? I
don't want to have to rely on 3 parallel arrays matching up.

[ortuno, 2016/02/25 23:08:27]

Ah. I asked a while ago if three arrays were better than an whole new IPC struct
and the conclusion was that three arrays were much less code and therefore OK.

[Jeffrey Yasskin, 2016/02/25 23:46:57]

Ah, sorry if I've given two contradictory answers to that question. Once we
switch to Mojo, it'd be nice to switch to the struct.

+  std::vector<std::string> characteristics_uuids;
+  std::vector<uint32_t> characteristics_properties;
+
+  for (BluetoothGattCharacteristic* characteristic :
+       query_result.service->GetCharacteristics()) {
+    if (characteristic_uuid.empty() ||
+        characteristic_uuid == characteristic->GetUUID().canonical_value()) {

[Jeffrey Yasskin, 2016/02/24 23:20:29]

Could you add a TODO to incorporate the blacklist here, in case your and
Vincent's patches collide?

[ortuno, 2016/02/25 23:08:27]

Added blacklist check since Vince's patch landed already.

+      characteristics_instance_ids.push_back(characteristic->GetIdentifier());
+      characteristics_uuids.push_back(
+          characteristic->GetUUID().canonical_value());
+      characteristics_properties.push_back(
+          static_cast<uint32_t>(characteristic->GetProperties()));
+    }
+  }
+
+  if (!characteristics_instance_ids.empty()) {
+    RecordGetCharacteristicsOutcome(UMAGetCharacteristicOutcome::SUCCESS);
+    Send(new BluetoothMsg_GetCharacteristicsSuccess(
+        thread_id, request_id, characteristics_instance_ids,
+        characteristics_uuids, characteristics_properties));
+    return;
+  }
+  RecordGetCharacteristicsOutcome(UMAGetCharacteristicOutcome::NOT_FOUND);

[Jeffrey Yasskin, 2016/02/24 23:20:29]

Probably split this by characteristic_uuid.empty() too.

[ortuno, 2016/02/25 23:08:27]

Done.

+  Send(new BluetoothMsg_GetCharacteristicsError(
+      thread_id, request_id, characteristic_uuid.empty()
+                                 ? WebBluetoothError::NoCharacteristicsFound
+                                 : WebBluetoothError::CharacteristicNotFound));
+}
+
 void BluetoothDispatcherHost::OnReadValue(
     int thread_id,
     int request_id,
     int frame_routing_id,
     const std::string& characteristic_instance_id) {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
   RecordWebBluetoothFunctionCall(
       UMAWebBluetoothFunction::CHARACTERISTIC_READ_VALUE);
 
   const CacheQueryResult query_result = QueryCacheForCharacteristic(
@@ skipping 676 matching lines @@
 
 bool BluetoothDispatcherHost::CanFrameAccessCharacteristicInstance(
     int frame_routing_id,
     const std::string& characteristic_instance_id) {
   return QueryCacheForCharacteristic(GetOrigin(frame_routing_id),
                                      characteristic_instance_id)
              .outcome != CacheQueryOutcome::BAD_RENDERER;
 }
 
 }  // namespace content