~thomas-voss/dbus-cpp/add_fallback_objects

/*
 * Copyright © 2012 Canonical Ltd.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Authored by: Thomas Voß <thomas.voss@canonical.com>
 */

#include <core/dbus/bus.h>
#include <core/dbus/dbus.h>
#include <core/dbus/match_rule.h>
#include <core/dbus/object.h>

#include <core/dbus/traits/timeout.h>
#include <core/dbus/traits/watch.h>

#include "message_p.h"
#include "message_factory_impl.h"
#include "pending_call_impl.h"

namespace
{
struct VTable
{
    static void unregister_object_path(DBusConnection*, void* data)
    {
        delete static_cast<VTable*>(data);
    }

    static DBusHandlerResult on_new_message(
            DBusConnection*,
            DBusMessage* message,
            void* data)
    {
        auto thiz = static_cast<VTable*>(data);

        if (thiz->object->on_new_message(
                    core::dbus::Message::from_raw_message(
                        message)))
            return DBUS_HANDLER_RESULT_HANDLED;

        return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
    }

    std::shared_ptr<core::dbus::Object> object;
};

DBusHandlerResult static_handle_message(
        DBusConnection* connection,
        DBusMessage* message,
        void* user_data)
{
    (void) connection;
    auto thiz =
            static_cast<core::dbus::Bus*>(user_data);
    return static_cast<DBusHandlerResult>(
                thiz->handle_message(
                    core::dbus::Message::from_raw_message(
                        message)));
}

void init_libdbus_thread_support_and_install_shutdown_handler()
{
    static std::once_flag once;
    std::call_once(once, []() { dbus_threads_init_default(); std::atexit(dbus_shutdown); });
}
}

namespace core
{
namespace dbus
{

Bus::Name::Name(const std::string &name) : name(name)
{
}

const std::string& Bus::Name::as_string() const
{
    return name;
}

struct Bus::Private
{
    Private()
        : connection(nullptr),
          message_factory_impl(new impl::MessageFactory()),
          message_type_router([](const Message::Ptr& msg) { return msg->type(); }),
          signal_router([](const Message::Ptr& msg){ return msg->path(); })
    {
        init_libdbus_thread_support_and_install_shutdown_handler();
    }

    std::shared_ptr<DBusConnection> connection;
    std::shared_ptr<MessageFactory> message_factory_impl;
    Executor::Ptr executor;
    MessageTypeRouter message_type_router;
    SignalRouter signal_router;
};

Bus::MessageHandlerResult Bus::handle_message(const Message::Ptr& message)
{
    d->message_type_router(message);
    return Bus::MessageHandlerResult::not_yet_handled;
}

Bus::Bus(const std::string& address)
    : d(new Private())
{
    Error se;
    d->connection.reset(
                dbus_connection_open_private(address.c_str(), std::addressof(se.raw())),
                [](DBusConnection*){}
    );

    if (!d->connection)
        throw std::runtime_error(se.print());

    d->message_type_router.install_route(
                Message::Type::signal,
                std::bind(
                    &Bus::SignalRouter::operator(),
                    std::ref(d->signal_router),
                    std::placeholders::_1));

    dbus_connection_add_filter(
                d->connection.get(),
                static_handle_message,
                this,
                nullptr);

    auto message = dbus::Message::make_method_call(
                DBus::name(),
                DBus::path(),
                DBus::interface(),
                "Hello");

    auto reply = send_with_reply_and_block_for_at_most(message, std::chrono::seconds(1));

    if (reply->type() == Message::Type::error)
        throw std::runtime_error(reply->error().print());

    dbus_connection_set_exit_on_disconnect(d->connection.get(), FALSE);
}

Bus::Bus(WellKnownBus bus)
    : d(new Private())
{
    Error se;
    d->connection.reset(
                dbus_bus_get_private(static_cast<DBusBusType>(bus), std::addressof(se.raw())),
                [](DBusConnection*){}
    );

    if (!d->connection)
        throw std::runtime_error(se.print());

    d->message_type_router.install_route(
                Message::Type::signal,
                std::bind(
                    &Bus::SignalRouter::operator(),
                    std::ref(d->signal_router),
                    std::placeholders::_1));

    dbus_connection_add_filter(
                d->connection.get(),
                static_handle_message,
                this,
                nullptr);

    dbus_connection_set_exit_on_disconnect(d->connection.get(), FALSE);
}

Bus::~Bus() noexcept
{
    dbus_connection_remove_filter(d->connection.get(), static_handle_message, this);
    dbus_connection_close(d->connection.get());
    dbus_connection_unref(d->connection.get());
}

const std::shared_ptr<MessageFactory> Bus::message_factory()
{
    return d->message_factory_impl;
}

std::unique_ptr<Bus::Name> Bus::request_name_on_bus(
        const std::string& name,
        Bus::RequestNameFlag flags)
{
    Error error;
    auto rc = dbus_bus_request_name(
                d->connection.get(),
                name.c_str(),
                static_cast<unsigned int>(flags),
                std::addressof(error.raw()));

    std::unique_ptr<Bus::Name> result{new Bus::Name{name}};

    switch (rc)
    {
    case DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER: return std::move(result);
    case DBUS_REQUEST_NAME_REPLY_IN_QUEUE: return std::move(result);
    case DBUS_REQUEST_NAME_REPLY_EXISTS: throw Bus::Errors::AlreadyOwned{}; break;
    case DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER: throw Bus::Errors::AlreadyOwner{}; break;
    case -1: throw std::runtime_error(error.print());
    }

    return std::move(result);
}

void Bus::release_name_on_bus(std::unique_ptr<Bus::Name> name)
{
    Error error;
    dbus_bus_release_name(
                d->connection.get(),
                name->as_string().c_str(),
                std::addressof(error.raw()));
}

uint32_t Bus::send(const std::shared_ptr<Message>& msg)
{
    dbus_uint32_t serial;
    if (!dbus_connection_send(
                d->connection.get(),
                msg->d->dbus_message.get(),
                std::addressof(serial)))
        throw std::runtime_error("Problem sending message");

    return serial;
}

std::shared_ptr<Message> Bus::send_with_reply_and_block_for_at_most(
        const std::shared_ptr<Message>& msg,
        const std::chrono::milliseconds& milliseconds)
{
    // TODO(tvoss): Enable this once method handlers have been adjusted to
    // operate on contexts.
    // if (d->executor)
    // {
    //    throw std::logic_error("Calling Bus::send_with_reply_and_block_for_at_most on a "
    //                           "connection that is run by an executor, i.e., an event loop "
    //                           "is not supported as the underlying implementation in libdbus "
    //                           "is racy");
    //}

    Error se;

    auto result = dbus_connection_send_with_reply_and_block(
                d->connection.get(),
                msg->d->dbus_message.get(),
                milliseconds.count(),
                std::addressof(se.raw()));

    if (!result)
        throw std::runtime_error(se.print());

    return Message::from_raw_message(result);
}

PendingCall::Ptr Bus::send_with_reply_and_timeout(
        const std::shared_ptr<Message>& msg,
        const std::chrono::milliseconds& timeout)
{
    DBusPendingCall* pending_call;
    auto result = dbus_connection_send_with_reply(
                d->connection.get(),
                msg->d->dbus_message.get(),
                std::addressof(pending_call),
                timeout.count());

    if (result == FALSE)
        throw Errors::NoMemory{};

    if (!pending_call)
        throw std::runtime_error("Connection disconnected or tried to send fd's over a transport that does not support it");

    return impl::PendingCall::create(pending_call);
}

void Bus::add_match(const MatchRule& rule)
{
    Error se;
    dbus_bus_add_match(d->connection.get(), rule.as_string().c_str(), std::addressof(se.raw()));
    if (se)
        throw std::runtime_error(se.print());
}

void Bus::remove_match(const MatchRule& rule)
{
    Error se;
    dbus_bus_remove_match(d->connection.get(), rule.as_string().c_str(), std::addressof(se.raw()));
    if (se)
        throw std::runtime_error(se.print());
}

bool Bus::has_owner_for_name(const std::string& name)
{
    return dbus_bus_name_has_owner(d->connection.get(), name.c_str(), nullptr);
}

void Bus::install_executor(const Executor::Ptr& e)
{
    d->executor = e;
}

void Bus::stop()
{
    if (!d->executor)
        throw std::runtime_error("Missing executor, cannot stop.");
    d->executor->stop();
}

void Bus::run()
{
    if (!d->executor)
        throw std::runtime_error("Missing executor, cannot run.");
    d->executor->run();
}

void Bus::register_object_for_path(
        const types::ObjectPath& path,
        const std::shared_ptr<Object>& object)
{
    auto vtable = new DBusObjectPathVTable
    {
            VTable::unregister_object_path,
            VTable::on_new_message,
            nullptr,
            nullptr,
            nullptr,
            nullptr
    };

    Error e;
    auto result = dbus_connection_try_register_object_path(
                d->connection.get(),
                path.as_string().c_str(),
                vtable,
                new VTable{object},
                std::addressof(e.raw()));

    if (!result || e)
    {
        delete vtable;
        throw std::runtime_error(e.print());
    }
}

void Bus::unregister_object_path(
        const types::ObjectPath& path)
{
    dbus_connection_unregister_object_path(
                d->connection.get(),
                path.as_string().c_str());
}

Bus::SignalRouter& Bus::access_signal_router()
{
    return d->signal_router;
}

DBusConnection* Bus::raw() const
{
    return d->connection.get();
}
}
}