chromium/chromeos/ash/components/dbus/shill/shill_profile_client.cc

// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chromeos/ash/components/dbus/shill/shill_profile_client.h"

#include <map>
#include <memory>
#include <utility>

#include "base/functional/bind.h"
#include "base/memory/raw_ptr.h"
#include "base/values.h"
#include "chromeos/ash/components/dbus/shill/fake_shill_profile_client.h"
#include "chromeos/ash/components/dbus/shill/shill_property_changed_observer.h"
#include "dbus/bus.h"
#include "dbus/message.h"
#include "dbus/object_path.h"
#include "dbus/values_util.h"
#include "third_party/cros_system_api/dbus/service_constants.h"

namespace ash {

namespace {

const char kSharedProfilePath[] = "/profile/default";

ShillProfileClient* g_instance = nullptr;

class ShillProfileClientImpl : public ShillProfileClient {
 public:
  explicit ShillProfileClientImpl(dbus::Bus* bus) : bus_(bus) {}

  ShillProfileClientImpl(const ShillProfileClientImpl&) = delete;
  ShillProfileClientImpl& operator=(const ShillProfileClientImpl&) = delete;

  ~ShillProfileClientImpl() override = default;

  void AddPropertyChangedObserver(
      const dbus::ObjectPath& profile_path,
      ShillPropertyChangedObserver* observer) override {
    GetHelper(profile_path)->AddPropertyChangedObserver(observer);
  }

  void RemovePropertyChangedObserver(
      const dbus::ObjectPath& profile_path,
      ShillPropertyChangedObserver* observer) override {
    GetHelper(profile_path)->RemovePropertyChangedObserver(observer);
  }

  void GetProperties(
      const dbus::ObjectPath& profile_path,
      base::OnceCallback<void(base::Value::Dict result)> callback,
      ErrorCallback error_callback) override;
  void SetProperty(const dbus::ObjectPath& profile_path,
                   const std::string& name,
                   const base::Value& property,
                   base::OnceClosure callback,
                   ErrorCallback error_callback) override;
  void SetObjectPathProperty(const dbus::ObjectPath& profile_path,
                             const std::string& name,
                             const dbus::ObjectPath& property,
                             base::OnceClosure callback,
                             ErrorCallback error_callback) override;
  void GetEntry(const dbus::ObjectPath& profile_path,
                const std::string& entry_path,
                base::OnceCallback<void(base::Value::Dict result)> callback,
                ErrorCallback error_callback) override;
  void DeleteEntry(const dbus::ObjectPath& profile_path,
                   const std::string& entry_path,
                   base::OnceClosure callback,
                   ErrorCallback error_callback) override;

  TestInterface* GetTestInterface() override { return nullptr; }

 private:
  using HelperMap = std::map<std::string, std::unique_ptr<ShillClientHelper>>;

  // Returns the corresponding ShillClientHelper for the profile.
  ShillClientHelper* GetHelper(const dbus::ObjectPath& profile_path);

  raw_ptr<dbus::Bus> bus_;
  HelperMap helpers_;
};

ShillClientHelper* ShillProfileClientImpl::GetHelper(
    const dbus::ObjectPath& profile_path) {
  HelperMap::const_iterator it = helpers_.find(profile_path.value());
  if (it != helpers_.end())
    return it->second.get();

  // There is no helper for the profile, create it.
  dbus::ObjectProxy* object_proxy =
      bus_->GetObjectProxy(shill::kFlimflamServiceName, profile_path);
  std::unique_ptr<ShillClientHelper> helper(
      new ShillClientHelper(object_proxy));
  helper->MonitorPropertyChanged(shill::kFlimflamProfileInterface);
  ShillClientHelper* helper_ptr = helper.get();
  helpers_[profile_path.value()] = std::move(helper);
  return helper_ptr;
}

void ShillProfileClientImpl::GetProperties(
    const dbus::ObjectPath& profile_path,
    base::OnceCallback<void(base::Value::Dict result)> callback,
    ErrorCallback error_callback) {
  dbus::MethodCall method_call(shill::kFlimflamProfileInterface,
                               shill::kGetPropertiesFunction);
  GetHelper(profile_path)
      ->CallDictValueMethodWithErrorCallback(&method_call, std::move(callback),
                                             std::move(error_callback));
}

void ShillProfileClientImpl::SetProperty(const dbus::ObjectPath& profile_path,
                                         const std::string& name,
                                         const base::Value& property,
                                         base::OnceClosure callback,
                                         ErrorCallback error_callback) {
  dbus::MethodCall method_call(shill::kFlimflamProfileInterface,
                               shill::kSetPropertyFunction);
  dbus::MessageWriter writer(&method_call);
  writer.AppendString(name);
  ShillClientHelper::AppendValueDataAsVariant(&writer, name, property);
  GetHelper(profile_path)
      ->CallVoidMethodWithErrorCallback(&method_call, std::move(callback),
                                        std::move(error_callback));
}

void ShillProfileClientImpl::SetObjectPathProperty(
    const dbus::ObjectPath& profile_path,
    const std::string& name,
    const dbus::ObjectPath& property,
    base::OnceClosure callback,
    ErrorCallback error_callback) {
  dbus::MethodCall method_call(shill::kFlimflamProfileInterface,
                               shill::kSetPropertyFunction);

  dbus::MessageWriter writer(&method_call);
  writer.AppendString(name);
  writer.AppendVariantOfObjectPath(property);
  GetHelper(profile_path)
      ->CallVoidMethodWithErrorCallback(&method_call, std::move(callback),
                                        std::move(error_callback));
}

void ShillProfileClientImpl::GetEntry(
    const dbus::ObjectPath& profile_path,
    const std::string& entry_path,
    base::OnceCallback<void(base::Value::Dict result)> callback,
    ErrorCallback error_callback) {
  dbus::MethodCall method_call(shill::kFlimflamProfileInterface,
                               shill::kGetEntryFunction);
  dbus::MessageWriter writer(&method_call);
  writer.AppendString(entry_path);
  GetHelper(profile_path)
      ->CallDictValueMethodWithErrorCallback(&method_call, std::move(callback),
                                             std::move(error_callback));
}

void ShillProfileClientImpl::DeleteEntry(const dbus::ObjectPath& profile_path,
                                         const std::string& entry_path,
                                         base::OnceClosure callback,
                                         ErrorCallback error_callback) {
  dbus::MethodCall method_call(shill::kFlimflamProfileInterface,
                               shill::kDeleteEntryFunction);
  dbus::MessageWriter writer(&method_call);
  writer.AppendString(entry_path);
  GetHelper(profile_path)
      ->CallVoidMethodWithErrorCallback(&method_call, std::move(callback),
                                        std::move(error_callback));
}

}  // namespace

ShillProfileClient::ShillProfileClient() {
  DCHECK(!g_instance);
  g_instance = this;
}

ShillProfileClient::~ShillProfileClient() {
  DCHECK_EQ(this, g_instance);
  g_instance = nullptr;
}

// static
void ShillProfileClient::Initialize(dbus::Bus* bus) {
  DCHECK(bus);
  new ShillProfileClientImpl(bus);
}

// static
void ShillProfileClient::InitializeFake() {
  new FakeShillProfileClient();
}

// static
void ShillProfileClient::Shutdown() {
  DCHECK(g_instance);
  delete g_instance;
}

// static
ShillProfileClient* ShillProfileClient::Get() {
  return g_instance;
}

// static
std::string ShillProfileClient::GetSharedProfilePath() {
  return std::string(kSharedProfilePath);
}

}  // namespace ash