bluetooth: Subscribe to notifications

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.
 
 // NETWORK_ERROR Note:
 // When a device can't be found in the BluetoothAdapter, that generally
 // indicates that it's gone out of range. We reject with a NetworkError in that
 // case.
 // https://webbluetoothchrome.github.io/web-bluetooth/#dom-bluetoothdevice-connectgatt
 
@@ skipping 181 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_ConnectGATT, OnConnectGATT)
   IPC_MESSAGE_HANDLER(BluetoothHostMsg_GetPrimaryService, OnGetPrimaryService)
   IPC_MESSAGE_HANDLER(BluetoothHostMsg_GetCharacteristic, OnGetCharacteristic)
   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_UNHANDLED(handled = false)
   IPC_END_MESSAGE_MAP()
   return handled;
 }
 
 void BluetoothDispatcherHost::SetBluetoothAdapterForTesting(
     scoped_refptr<device::BluetoothAdapter> mock_adapter) {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
   current_delay_time_ = kTestingDelayTime;
   // Reset the discovery session timer to use the new delay time.
@@ skipping 128 matching lines @@
   for (IDMap<RequestDeviceSession, IDMapOwnPointer>::iterator iter(
            &request_device_sessions_);
        !iter.IsAtEnd(); iter.Advance()) {
     RequestDeviceSession* session = iter.GetCurrentValue();
     if (session->chooser) {
       session->chooser->RemoveDevice(device->GetAddress());
     }
   }
 }
 
+void BluetoothDispatcherHost::GattCharacteristicValueChanged(
+    device::BluetoothAdapter* adapter,
+    device::BluetoothGattCharacteristic* characteristic,
+    const std::vector<uint8>& value) {
+  // TODO(ortuno): Notify renderer the characteristic changed.
+  // http://crbug.com/529560
+  VLOG(1) << "Characteristic updated.";
+}
+
 void BluetoothDispatcherHost::OnRequestDevice(
     int thread_id,
     int request_id,
     int frame_routing_id,
     const std::vector<BluetoothScanFilter>& filters,
     const std::vector<BluetoothUUID>& optional_services) {
   DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
   RecordWebBluetoothFunctionCall(UMAWebBluetoothFunction::REQUEST_DEVICE);
   RecordRequestDeviceArguments(filters, optional_services);
 
@@ skipping 327 matching lines @@
         WebBluetoothError::CharacteristicNoLongerExists));
     return;
   }
   characteristic->WriteRemoteCharacteristic(
       value, base::Bind(&BluetoothDispatcherHost::OnWriteValueSuccess,
                         weak_ptr_factory_.GetWeakPtr(), thread_id, request_id),
       base::Bind(&BluetoothDispatcherHost::OnWriteValueFailed,
                  weak_ptr_factory_.GetWeakPtr(), thread_id, request_id));
 }
 
+void BluetoothDispatcherHost::OnStartNotifications(
+    int thread_id,
+    int request_id,
+    const std::string& characteristic_instance_id) {
+  DCHECK_CURRENTLY_ON(BrowserThread::UI);
+  RecordWebBluetoothFunctionCall(
+      UMAWebBluetoothFunction::CHARACTERISTIC_START_NOTIFICATIONS);
+
+  // Check if already subscribed to notifications.
+  auto notify_session_iter =
+      characteristic_id_to_notify_session_.find(characteristic_instance_id);
+  if (notify_session_iter != characteristic_id_to_notify_session_.end()) {
+    Send(new BluetoothMsg_StartNotificationsSuccess(thread_id, request_id));

[Jeffrey Yasskin, 2015/09/25 23:03:19]

This is vulnerable to races if a second BluetoothHostMsg_StartNotifications
comes in while the first is still registering. I assume that's handled in two
ways: 1) BluetoothDispatcher won't send 2 Start() requests concurrently (and we
don't support multiple thread_ids yet), and 2) OnStartNotifySessionSuccess()
will destroy its notification session if it can't insert it.

Comment this, please. If I've missed a real problem that'll require code to fix,
but it won't make the API unusable, probably file a bug and add a TODO rather
than fixing it in this CL.

[ortuno, 2015/09/29 22:47:36]

This code was wrote before I implemented the queues in Dispatcher.
BluetoothDispatcher should never send a request for a characteristic already
subscribed to notifications. Added a DCHECK.

+    return;
+  }
+
+  // TODO(ortuno): Check if notify/indicate bit is set.

[Jeffrey Yasskin, 2015/09/25 23:03:19]

Add a blank line below this, since it's not connected to looking up the
characteristic.

[ortuno, 2015/09/29 22:47:36]

Done.

+  auto characteristic_iter =
+      characteristic_to_service_.find(characteristic_instance_id);
+  // A characteristic_instance_id not in the map implies a hostile renderer
+  // because a renderer obtains the characteristic id from this class and
+  // it will be added to the map at that time.
+  if (characteristic_iter == characteristic_to_service_.end()) {
+    // Kill the renderer
+    bad_message::ReceivedBadMessage(this,
+                                    bad_message::BDH_INVALID_CHARACTERISTIC_ID);
+    return;
+  }
+
+  const std::string& service_instance_id = characteristic_iter->second;
+  auto device_iter = service_to_device_.find(service_instance_id);
+  CHECK(device_iter != service_to_device_.end());
+
+  device::BluetoothDevice* device =
+      adapter_->GetDevice(device_iter->second /* device_instance_id */);
+  if (device == nullptr) {  // See "NETWORK_ERROR Note" above.
+    RecordStartNotificationsOutcome(UMAGATTOperationOutcome::NO_DEVICE);
+    Send(new BluetoothMsg_StartNotificationsError(
+        thread_id, request_id, WebBluetoothError::DeviceNoLongerInRange));
+    return;
+  }
+
+  BluetoothGattService* service = device->GetGattService(service_instance_id);
+  if (service == nullptr) {
+    RecordStartNotificationsOutcome(UMAGATTOperationOutcome::NO_SERVICE);
+    Send(new BluetoothMsg_StartNotificationsError(
+        thread_id, request_id, WebBluetoothError::ServiceNoLongerExists));
+    return;
+  }
+
+  BluetoothGattCharacteristic* characteristic =
+      service->GetCharacteristic(characteristic_instance_id);
+  if (characteristic == nullptr) {
+    RecordStartNotificationsOutcome(UMAGATTOperationOutcome::NO_CHARACTERISTIC);
+    Send(new BluetoothMsg_StartNotificationsError(
+        thread_id, request_id,
+        WebBluetoothError::CharacteristicNoLongerExists));
+    return;
+  }
+
+  characteristic->StartNotifySession(
+      base::Bind(&BluetoothDispatcherHost::OnStartNotifySessionSuccess,
+                 weak_ptr_factory_.GetWeakPtr(), thread_id, request_id),
+      base::Bind(&BluetoothDispatcherHost::OnStartNotifySessionFailed,
+                 weak_ptr_factory_.GetWeakPtr(), thread_id, request_id));
+}
+void BluetoothDispatcherHost::OnStopNotifications(
+    int thread_id,
+    int request_id,
+    const std::string& characteristic_instance_id) {
+  DCHECK_CURRENTLY_ON(BrowserThread::UI);
+  RecordWebBluetoothFunctionCall(
+      UMAWebBluetoothFunction::CHARACTERISTIC_STOP_NOTIFICATIONS);
+
+  auto notify_session_iter =
+      characteristic_id_to_notify_session_.find(characteristic_instance_id);
+  if (notify_session_iter == characteristic_id_to_notify_session_.end()) {
+    Send(new BluetoothMsg_StopNotificationsSuccess(thread_id, request_id));
+    return;
+  }
+  notify_session_iter->second->Stop(
+      base::Bind(&BluetoothDispatcherHost::OnStopNotifySession,
+                 weak_ptr_factory_.GetWeakPtr(), thread_id, request_id,
+                 characteristic_instance_id));
+}
+
 void BluetoothDispatcherHost::OnDiscoverySessionStarted(
     int chooser_id,
     scoped_ptr<device::BluetoothDiscoverySession> discovery_session) {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
   VLOG(1) << "Started discovery session for " << chooser_id;
   if (RequestDeviceSession* session =
           request_device_sessions_.Lookup(chooser_id)) {
     session->discovery_session = discovery_session.Pass();
 
     // Arrange to stop discovery later.
@@ skipping 209 matching lines @@
 void BluetoothDispatcherHost::OnWriteValueFailed(
     int thread_id,
     int request_id,
     device::BluetoothGattService::GattErrorCode error_code) {
   // TranslateGATTError calls RecordGATTOperationOutcome.
   Send(new BluetoothMsg_WriteCharacteristicValueError(
       thread_id, request_id,
       TranslateGATTError(error_code, UMAGATTOperation::CHARACTERISTIC_WRITE)));
 }
 
+void BluetoothDispatcherHost::OnStartNotifySessionSuccess(
+    int thread_id,
+    int request_id,
+    scoped_ptr<device::BluetoothGattNotifySession> notify_session) {
+  characteristic_id_to_notify_session_.insert(
+      notify_session->GetCharacteristicIdentifier(), notify_session.Pass());
+  Send(new BluetoothMsg_StartNotificationsSuccess(thread_id, request_id));

[Jeffrey Yasskin, 2015/09/25 23:03:19]

Call RecordStartNotificationsOutcome() here, right?

[ortuno, 2015/09/29 22:47:36]

Done.

+}
+
+void BluetoothDispatcherHost::OnStartNotifySessionFailed(
+    int thread_id,
+    int request_id,
+    device::BluetoothGattService::GattErrorCode error_code) {
+  // TranslateGATTError calls RecordGATTOperationOutcome.
+  Send(new BluetoothMsg_StartNotificationsError(
+      thread_id, request_id,
+      TranslateGATTError(error_code, UMAGATTOperation::START_NOTIFICATIONS)));
+}
+
+void BluetoothDispatcherHost::OnStopNotifySession(
+    int thread_id,
+    int request_id,
+    const std::string& characteristic_instance_id) {
+  characteristic_id_to_notify_session_.erase(characteristic_instance_id);
+  Send(new BluetoothMsg_StopNotificationsSuccess(thread_id, request_id));
+}
+
 void BluetoothDispatcherHost::ShowBluetoothOverviewLink() {
   NOTIMPLEMENTED();
 }
 
 void BluetoothDispatcherHost::ShowBluetoothPairingLink() {
   NOTIMPLEMENTED();
 }
 
 void BluetoothDispatcherHost::ShowBluetoothAdapterOffLink() {
   NOTIMPLEMENTED();
 }
 
 }  // namespace content