D-Bus Clients for BlueZ 5 API

chromeos/dbus/experimental_bluetooth_adapter_client.cc

+// Copyright (c) 2013 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.
+
+#include "chromeos/dbus/experimental_bluetooth_adapter_client.h"
+
+#include <map>
+
+#include "base/bind.h"
+#include "base/logging.h"
+#include "chromeos/dbus/bluetooth_property.h"
+#include "dbus/bus.h"
+#include "dbus/message.h"
+#include "dbus/object_manager.h"
+#include "dbus/object_path.h"
+#include "dbus/object_proxy.h"
+#include "third_party/cros_system_api/dbus/service_constants.h"
+
+namespace chromeos {
+
+const char ExperimentalBluetoothAdapterClient::kNoResponseError[] =
+    "org.chromium.Error.NoResponse";
+const char ExperimentalBluetoothAdapterClient::kUnknownAdapterError[] =
+    "org.chromium.Error.UnknownAdapter";
+
+ExperimentalBluetoothAdapterClient::Properties::Properties(
+    dbus::ObjectProxy* object_proxy,
+    const std::string& interface_name,
+    const PropertyChangedCallback& callback)
+    : dbus::PropertySet(object_proxy, interface_name, callback) {
+  RegisterProperty(bluetooth_adapter::kAddressProperty, &address);
+  RegisterProperty(bluetooth_adapter::kNameProperty, &name);
+  RegisterProperty(bluetooth_adapter::kAliasProperty, &alias);
+  RegisterProperty(bluetooth_adapter::kClassProperty, &bluetooth_class);
+  RegisterProperty(bluetooth_adapter::kPoweredProperty, &powered);
+  RegisterProperty(bluetooth_adapter::kDiscoverableProperty, &discoverable);
+  RegisterProperty(bluetooth_adapter::kPairableProperty, &pairable);
+  RegisterProperty(bluetooth_adapter::kPairableTimeoutProperty,
+                   &pairable_timeout);
+  RegisterProperty(bluetooth_adapter::kDiscoverableTimeoutProperty,
+                   &discoverable_timeout);
+  RegisterProperty(bluetooth_adapter::kDiscoveringProperty, &discovering);
+  RegisterProperty(bluetooth_adapter::kUUIDsProperty, &uuids);
+  RegisterProperty(bluetooth_adapter::kModaliasProperty, &modalias);
+}
+
+ExperimentalBluetoothAdapterClient::Properties::~Properties() {
+}
+
+
+// The ExperimentalBluetoothAdapterClient implementation used in production.
+class ExperimentalBluetoothAdapterClientImpl
+    : public ExperimentalBluetoothAdapterClient,
+      public dbus::ObjectManager::Interface {
+ public:
+  explicit ExperimentalBluetoothAdapterClientImpl(dbus::Bus* bus)
+      : bus_(bus),
+        weak_ptr_factory_(this) {
+    object_manager_ = bus_->GetObjectManager(
+        bluetooth_manager::kBluetoothManagerServiceName,
+        dbus::ObjectPath(bluetooth_manager::kBluetoothManagerServicePath));
+    object_manager_->RegisterInterface(
+        bluetooth_adapter::kExperimentalBluetoothAdapterInterface, this);
+  }
+
+  virtual ~ExperimentalBluetoothAdapterClientImpl() {
+    object_manager_->UnregisterInterface(
+        bluetooth_adapter::kExperimentalBluetoothAdapterInterface);
+  }
+
+  // ExperimentalBluetoothAdapterClient override.
+  virtual void AddObserver(
+      ExperimentalBluetoothAdapterClient::Observer* observer) OVERRIDE {
+    DCHECK(observer);
+    observers_.AddObserver(observer);
+  }
+
+  // ExperimentalBluetoothAdapterClient override.
+  virtual void RemoveObserver(
+      ExperimentalBluetoothAdapterClient::Observer* observer) OVERRIDE {
+    DCHECK(observer);
+    observers_.RemoveObserver(observer);
+  }
+
+  // Returns the list of adapter object paths known to the system.
+  virtual std::vector<dbus::ObjectPath> GetAdapters() {
+    return object_manager_->GetObjectsWithInterface(
+        bluetooth_adapter::kExperimentalBluetoothAdapterInterface);
+  }
+
+  // dbus::ObjectManager::Interface override.
+  virtual dbus::PropertySet* CreateProperties(
+      dbus::ObjectProxy* object_proxy,
+      const dbus::ObjectPath& object_path,
+      const std::string& interface_name) {
+    Properties* properties = new Properties(
+        object_proxy, interface_name,
+        base::Bind(&ExperimentalBluetoothAdapterClientImpl::OnPropertyChanged,
+                   weak_ptr_factory_.GetWeakPtr(),
+                   object_path));
+    return static_cast<dbus::PropertySet*>(properties);
+  }
+
+  // ExperimentalBluetoothAdapterClient override.
+  virtual Properties* GetProperties(const dbus::ObjectPath& object_path)
+      OVERRIDE {
+    return static_cast<Properties*>(
+        object_manager_->GetProperties(
+            object_path,
+            bluetooth_adapter::kExperimentalBluetoothAdapterInterface));
+  }
+
+  // ExperimentalBluetoothAdapterClient override.
+  virtual void StartDiscovery(const dbus::ObjectPath& object_path,
+                              const base::Closure& callback,
+                              const ErrorCallback& error_callback) OVERRIDE {
+    dbus::MethodCall method_call(
+        bluetooth_adapter::kExperimentalBluetoothAdapterInterface,
+        bluetooth_adapter::kStartDiscovery);
+
+    dbus::ObjectProxy* object_proxy =
+        object_manager_->GetObjectProxy(object_path);
+    if (!object_proxy) {
+      error_callback.Run(kUnknownAdapterError, "");
+      return;
+    }
+
+    object_proxy->CallMethodWithErrorCallback(
+        &method_call,
+        dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
+        base::Bind(&ExperimentalBluetoothAdapterClientImpl::OnSuccess,
+                   weak_ptr_factory_.GetWeakPtr(), callback),
+        base::Bind(&ExperimentalBluetoothAdapterClientImpl::OnError,
+                   weak_ptr_factory_.GetWeakPtr(), error_callback));
+  }
+
+  // ExperimentalBluetoothAdapterClient override.
+  virtual void StopDiscovery(const dbus::ObjectPath& object_path,
+                             const base::Closure& callback,
+                             const ErrorCallback& error_callback) OVERRIDE {
+    dbus::MethodCall method_call(
+        bluetooth_adapter::kExperimentalBluetoothAdapterInterface,
+        bluetooth_adapter::kStopDiscovery);
+
+    dbus::ObjectProxy* object_proxy =
+        object_manager_->GetObjectProxy(object_path);
+    if (!object_proxy) {
+      error_callback.Run(kUnknownAdapterError, "");
+      return;
+    }
+
+    object_proxy->CallMethodWithErrorCallback(
+        &method_call,
+        dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
+        base::Bind(&ExperimentalBluetoothAdapterClientImpl::OnSuccess,
+                   weak_ptr_factory_.GetWeakPtr(), callback),
+        base::Bind(&ExperimentalBluetoothAdapterClientImpl::OnError,
+                   weak_ptr_factory_.GetWeakPtr(), error_callback));
+  }
+
+  // ExperimentalBluetoothAdapterClient override.
+  virtual void RemoveDevice(const dbus::ObjectPath& object_path,
+                            const dbus::ObjectPath& device_path,
+                            const base::Closure& callback,
+                            const ErrorCallback& error_callback) OVERRIDE {
+    dbus::MethodCall method_call(
+        bluetooth_adapter::kExperimentalBluetoothAdapterInterface,
+        bluetooth_adapter::kRemoveDevice);
+
+    dbus::MessageWriter writer(&method_call);
+    writer.AppendObjectPath(device_path);
+
+    dbus::ObjectProxy* object_proxy =
+        object_manager_->GetObjectProxy(object_path);
+    if (!object_proxy) {
+      error_callback.Run(kUnknownAdapterError, "");
+      return;
+    }
+
+    object_proxy->CallMethodWithErrorCallback(
+        &method_call,
+        dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
+        base::Bind(&ExperimentalBluetoothAdapterClientImpl::OnSuccess,
+                   weak_ptr_factory_.GetWeakPtr(), callback),
+        base::Bind(&ExperimentalBluetoothAdapterClientImpl::OnError,
+                   weak_ptr_factory_.GetWeakPtr(), error_callback));
+  }
+
+ private:
+  // Called by dbus::ObjectManager when an object with the adapter interface
+  // is created. Informs observers.
+  void ObjectAdded(const dbus::ObjectPath& object_path,
+                   const std::string& interface_name) OVERRIDE {
+    FOR_EACH_OBSERVER(ExperimentalBluetoothAdapterClient::Observer, observers_,
+                      AdapterAdded(object_path));
+  }
+
+  // Called by dbus::ObjectManager when an object with the adapter interface
+  // is removed. Informs observers.
+  void ObjectRemoved(const dbus::ObjectPath& object_path,
+                     const std::string& interface_name) OVERRIDE {
+    FOR_EACH_OBSERVER(ExperimentalBluetoothAdapterClient::Observer, observers_,
+                      AdapterRemoved(object_path));
+  }
+
+  // Called by dbus::PropertySet when a property value is changed,
+  // either by result of a signal or response to a GetAll() or Get()
+  // call. Informs observers.
+  void OnPropertyChanged(const dbus::ObjectPath& object_path,
+                         const std::string& property_name) {
+    FOR_EACH_OBSERVER(ExperimentalBluetoothAdapterClient::Observer, observers_,
+                      AdapterPropertyChanged(object_path, property_name));
+  }
+
+  // Called when a response for successful method call is received.
+  void OnSuccess(const base::Closure& callback,
+                 dbus::Response* response) {
+    DCHECK(response);
+    callback.Run();
+  }
+
+  // Called when a response for a failed method call is received.
+  void OnError(const ErrorCallback& error_callback,
+               dbus::ErrorResponse* response) {
+    // Error response has optional error message argument.
+    std::string error_name;
+    std::string error_message;
+    if (response) {
+      dbus::MessageReader reader(response);
+      error_name = response->GetErrorName();
+      reader.PopString(&error_message);
+    } else {
+      error_name = kNoResponseError;
+      error_message = "";
+    }
+    error_callback.Run(error_name, error_message);
+  }
+
+  dbus::Bus* bus_;
+  dbus::ObjectManager* object_manager_;
+
+  // List of observers interested in event notifications from us.
+  ObserverList<ExperimentalBluetoothAdapterClient::Observer> observers_;
+
+  // Weak pointer factory for generating 'this' pointers that might live longer
+  // than we do.
+  // Note: This should remain the last member so it'll be destroyed and
+  // invalidate its weak pointers before any other members are destroyed.
+  base::WeakPtrFactory<ExperimentalBluetoothAdapterClientImpl>
+      weak_ptr_factory_;
+
+  DISALLOW_COPY_AND_ASSIGN(ExperimentalBluetoothAdapterClientImpl);
+};
+
+// The ExperimentalBluetoothAdapterClient implementation used on Linux desktop,
+// which does nothing.
+class ExperimentalBluetoothAdapterClientStubImpl
+    : public ExperimentalBluetoothAdapterClient {
+ public:
+  struct Properties : public ExperimentalBluetoothAdapterClient::Properties {
+    explicit Properties(const PropertyChangedCallback& callback)
+        : ExperimentalBluetoothAdapterClient::Properties(
+              NULL,
+              bluetooth_adapter::kExperimentalBluetoothAdapterInterface,
+              callback) {
+    }
+
+    virtual ~Properties() {
+    }
+
+    virtual void Get(dbus::PropertyBase* property,
+                     dbus::PropertySet::GetCallback callback) OVERRIDE {
+      VLOG(1) << "Get " << property->name();
+      callback.Run(false);
+    }
+
+    virtual void GetAll() OVERRIDE {
+      VLOG(1) << "GetAll";
+    }
+
+    virtual void Set(dbus::PropertyBase *property,
+                     dbus::PropertySet::SetCallback callback) OVERRIDE {
+      VLOG(1) << "Set " << property->name();
+      if (property->name() == "Powered") {
+        property->ReplaceValueWithSetValue();
+        NotifyPropertyChanged(property->name());
+        callback.Run(true);
+      } else {
+        callback.Run(false);
+      }
+    }
+  };
+
+  ExperimentalBluetoothAdapterClientStubImpl() {
+    properties_.reset(new Properties(base::Bind(
+        &ExperimentalBluetoothAdapterClientStubImpl::OnPropertyChanged,
+        base::Unretained(this))));
+
+    properties_->address.ReplaceValue("hci0");
+    properties_->name.ReplaceValue("Fake Adapter");
+    properties_->pairable.ReplaceValue(true);
+  }
+
+  // ExperimentalBluetoothAdapterClient override.
+  virtual void AddObserver(Observer* observer) OVERRIDE {
+    observers_.AddObserver(observer);
+  }
+
+  // ExperimentalBluetoothAdapterClient override.
+  virtual void RemoveObserver(Observer* observer) OVERRIDE {
+    observers_.RemoveObserver(observer);
+  }
+
+  // ExperimentalBluetoothAdapterClient override.
+  virtual std::vector<dbus::ObjectPath> GetAdapters() OVERRIDE {
+    std::vector<dbus::ObjectPath> object_paths;
+    object_paths.push_back(dbus::ObjectPath("/fake/hci0"));
+    return object_paths;
+  }
+
+  // ExperimentalBluetoothAdapterClient override.
+  virtual Properties* GetProperties(const dbus::ObjectPath& object_path)
+      OVERRIDE {
+    VLOG(1) << "GetProperties: " << object_path.value();
+    if (object_path.value() == "/fake/hci0")
+      return properties_.get();
+    else
+      return NULL;
+  }
+
+  // ExperimentalBluetoothAdapterClient override.
+  virtual void StartDiscovery(const dbus::ObjectPath& object_path,
+                              const base::Closure& callback,
+                              const ErrorCallback& error_callback) OVERRIDE {
+    VLOG(1) << "StartDiscovery: " << object_path.value();
+    error_callback.Run(kNoResponseError, "");
+  }
+
+  // ExperimentalBluetoothAdapterClient override.
+  virtual void StopDiscovery(const dbus::ObjectPath& object_path,
+                             const base::Closure& callback,
+                             const ErrorCallback& error_callback) OVERRIDE {
+    VLOG(1) << "StopDiscovery: " << object_path.value();
+    error_callback.Run(kNoResponseError, "");
+  }
+
+  // ExperimentalBluetoothAdapterClient override.
+  virtual void RemoveDevice(const dbus::ObjectPath& object_path,
+                            const dbus::ObjectPath& device_path,
+                            const base::Closure& callback,
+                            const ErrorCallback& error_callback) OVERRIDE {
+    VLOG(1) << "RemoveDevice: " << object_path.value()
+            << " " << device_path.value();
+    error_callback.Run(kNoResponseError, "");
+  }
+
+ private:
+  void OnPropertyChanged(const std::string& property_name) {
+    FOR_EACH_OBSERVER(ExperimentalBluetoothAdapterClient::Observer, observers_,
+                      AdapterPropertyChanged(dbus::ObjectPath("/fake/hci0"),
+                                             property_name));
+  }
+
+  // List of observers interested in event notifications from us.
+  ObserverList<Observer> observers_;
+
+  // Static properties we return.
+  scoped_ptr<Properties> properties_;
+};
+
+ExperimentalBluetoothAdapterClient::ExperimentalBluetoothAdapterClient() {
+}
+
+ExperimentalBluetoothAdapterClient::~ExperimentalBluetoothAdapterClient() {
+}
+
+ExperimentalBluetoothAdapterClient* ExperimentalBluetoothAdapterClient::Create(
+    DBusClientImplementationType type,
+    dbus::Bus* bus) {
+  if (type == REAL_DBUS_CLIENT_IMPLEMENTATION)
+    return new ExperimentalBluetoothAdapterClientImpl(bus);
+  DCHECK_EQ(STUB_DBUS_CLIENT_IMPLEMENTATION, type);
+  return new ExperimentalBluetoothAdapterClientStubImpl();
+}
+
+}  // namespace chromeos