dbus_object.hpp

Go to the documentation of this file.

/*
 *    Copyright (c) 2019, The OpenThread Authors.
 *    All rights reserved.
 *
 *    Redistribution and use in source and binary forms, with or without
 *    modification, are permitted provided that the following conditions are met:
 *    1. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *    3. Neither the name of the copyright holder nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 *    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *    POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef OTBR_DBUS_DBUS_OBJECT_HPP_
#define OTBR_DBUS_DBUS_OBJECT_HPP_
 
#ifndef OTBR_LOG_TAG
#define OTBR_LOG_TAG "DBUS"
#endif
 
#include <functional>
#include <memory>
#include <string>
#include <unordered_map>
 
#include <dbus/dbus.h>
 
#include "common/code_utils.hpp"
#include "common/types.hpp"
#include "dbus/common/constants.hpp"
#include "dbus/common/dbus_message_dump.hpp"
#include "dbus/common/dbus_message_helper.hpp"
#include "dbus/common/dbus_resources.hpp"
#include "dbus/server/dbus_request.hpp"
 
namespace otbr {
namespace DBus {
 
class DBusObject : private NonCopyable
{
public:
    using MethodHandlerType = std::function<void(DBusRequest &)>;
 
    using PropertyHandlerType = std::function<otError(DBusMessageIter &)>;
 
    DBusObject(DBusConnection *aConnection, const std::string &aObjectPath);
 
    virtual otbrError Init(void);
 
    void RegisterMethod(const std::string &      aInterfaceName,
                        const std::string &      aMethodName,
                        const MethodHandlerType &aHandler);
 
    virtual void RegisterGetPropertyHandler(const std::string &        aInterfaceName,
                                            const std::string &        aPropertyName,
                                            const PropertyHandlerType &aHandler);
 
    virtual void RegisterSetPropertyHandler(const std::string &        aInterfaceName,
                                            const std::string &        aPropertyName,
                                            const PropertyHandlerType &aHandler);
 
    template <typename... FieldTypes>
    otbrError Signal(const std::string &              aInterfaceName,
                     const std::string &              aSignalName,
                     const std::tuple<FieldTypes...> &aArgs)
    {
        UniqueDBusMessage signalMsg = NewSignalMessage(aInterfaceName, aSignalName);
        otbrError         error     = OTBR_ERROR_NONE;
 
        VerifyOrExit(signalMsg != nullptr, error = OTBR_ERROR_DBUS);
        SuccessOrExit(error = otbr::DBus::TupleToDBusMessage(*signalMsg, aArgs));
 
        VerifyOrExit(dbus_connection_send(mConnection, signalMsg.get(), nullptr), error = OTBR_ERROR_DBUS);
 
    exit:
        return error;
    }
 
    template <typename ValueType>
    otbrError SignalPropertyChanged(const std::string &aInterfaceName,
                                    const std::string &aPropertyName,
                                    const ValueType &  aValue)
    {
        UniqueDBusMessage signalMsg = NewSignalMessage(DBUS_INTERFACE_PROPERTIES, DBUS_PROPERTIES_CHANGED_SIGNAL);
        DBusMessageIter   iter, subIter, dictEntryIter;
        otbrError         error = OTBR_ERROR_NONE;
 
        VerifyOrExit(signalMsg != nullptr, error = OTBR_ERROR_DBUS);
        dbus_message_iter_init_append(signalMsg.get(), &iter);
 
        // interface_name
        VerifyOrExit(DBusMessageEncode(&iter, aInterfaceName) == OTBR_ERROR_NONE, error = OTBR_ERROR_DBUS);
 
        // changed_properties
        VerifyOrExit(dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
                                                      "{" DBUS_TYPE_STRING_AS_STRING DBUS_TYPE_VARIANT_AS_STRING "}",
                                                      &subIter),
                     error = OTBR_ERROR_DBUS);
        VerifyOrExit(dbus_message_iter_open_container(&subIter, DBUS_TYPE_DICT_ENTRY, nullptr, &dictEntryIter),
                     error = OTBR_ERROR_DBUS);
 
        SuccessOrExit(error = DBusMessageEncode(&dictEntryIter, aPropertyName));
        SuccessOrExit(error = DBusMessageEncodeToVariant(&dictEntryIter, aValue));
 
        VerifyOrExit(dbus_message_iter_close_container(&subIter, &dictEntryIter), error = OTBR_ERROR_DBUS);
        VerifyOrExit(dbus_message_iter_close_container(&iter, &subIter), error = OTBR_ERROR_DBUS);
 
        // invalidated_properties
        SuccessOrExit(error = DBusMessageEncode(&iter, std::vector<std::string>()));
 
        if (otbrLogGetLevel() >= OTBR_LOG_DEBUG)
        {
            otbrLogDebug("Signal %s.%s", aInterfaceName.c_str(), aPropertyName.c_str());
            DumpDBusMessage(*signalMsg);
        }
 
        VerifyOrExit(dbus_connection_send(mConnection, signalMsg.get(), nullptr), error = OTBR_ERROR_DBUS);
 
    exit:
        return error;
    }
 
    virtual ~DBusObject(void);
 
    void Flush(void);
 
private:
    void GetAllPropertiesMethodHandler(DBusRequest &aRequest);
    void GetPropertyMethodHandler(DBusRequest &aRequest);
    void SetPropertyMethodHandler(DBusRequest &aRequest);
 
    static DBusHandlerResult sMessageHandler(DBusConnection *aConnection, DBusMessage *aMessage, void *aData);
    DBusHandlerResult        MessageHandler(DBusConnection *aConnection, DBusMessage *aMessage);
 
    UniqueDBusMessage NewSignalMessage(const std::string &aInterfaceName, const std::string &aSignalName);
 
    std::unordered_map<std::string, MethodHandlerType>                                    mMethodHandlers;
    std::unordered_map<std::string, std::unordered_map<std::string, PropertyHandlerType>> mGetPropertyHandlers;
    std::unordered_map<std::string, PropertyHandlerType>                                  mSetPropertyHandlers;
    DBusConnection *                                                                      mConnection;
    std::string                                                                           mObjectPath;
};
 
} // namespace DBus
} // namespace otbr
 
#endif // OTBR_DBUS_DBUS_SERVER_HPP_