dbusserver.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2014 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1

 
#ifndef SWIFT_MISC_DBUSSERVER_H
#define SWIFT_MISC_DBUSSERVER_H
 
#include <QDBusConnection>
#include <QDBusError>
#include <QFlags>
#include <QMap>
#include <QObject>
#include <QScopedPointer>
#include <QString>
 
#include "misc/logcategories.h"
#include "misc/swiftmiscexport.h"
 
class QDBusServer;

#define SWIFT_SERVICENAME "org.swift-project"
 
namespace swift::misc
{
    class SWIFT_MISC_EXPORT CDBusServer : public QObject
    {
        Q_OBJECT
 
    public:
        static const QString &coreServiceName();

        static const QString &coreServiceName(const QDBusConnection &connection);

        static const QStringList &getLogCategories();

        enum ServerMode
        {
            SERVERMODE_P2P,
            SERVERMODE_SESSIONBUS,
            SERVERMODE_SYSTEMBUS
        };

        CDBusServer(const QString &address, QObject *parent = nullptr) : CDBusServer(coreServiceName(), address, parent)
        {}

        CDBusServer(const QString &service, const QString &address, QObject *parent = nullptr);

        ~CDBusServer() override;

        void addObject(const QString &name, QObject *object);

        QDBusError lastQDBusServerError() const;

        const QDBusServer *qDBusServer() const;

        bool hasQDBusServer() const;

        void removeAllObjects();

        static const QDBusConnection &defaultConnection();

        static const QString &sessionBusAddress();

        static const QString &systemBusAddress();

        static QDBusConnection connectToDBus(const QString &dbusAddress, const QString &name = {});

        static void disconnectFromDBus(const QDBusConnection &connection, const QString &dBusAddress);

        static QString p2pAddress(const QString &host, const QString &port = "");

        static const QString &p2pConnectionName();

        static QString normalizeAddress(const QString &address);

        static ServerMode modeOfAddress(QString address);

        static const QString &modeToString(ServerMode mode);

        static bool isQtDBusAddress(const QString &address);

        static bool isSessionOrSystemAddress(const QString &address);

        static bool isP2PAddress(const QString &address);

        static bool isP2PConnection(const QDBusConnection &connection);

        static bool dBusAddressToHostAndPort(const QString &dbusAddress, QString &o_host, int &o_port);

        static bool dBusAddressToHostAndPort(const QString &dbusAddress, QString &o_host, QString &o_port);

        static bool isQtDefaultConnection(const QDBusConnection &connection);

        static bool isDBusAvailable(const QString &host, int port, int timeoutMs = 1500);
        static bool isDBusAvailable(const QString &host, int port, QString &message, int timeoutMs = 1500);
        static bool isDBusAvailable(const QString &dbusAddress, QString &message, int timeoutMs = 1500);
        static bool isDBusAvailable(const QString &dbusAddress, int timeoutMs = 1500);
 
    private:
        ServerMode m_serverMode = SERVERMODE_P2P;
        QScopedPointer<QDBusServer> m_busServer;
        QMap<QString, QObject *> m_objects;
        QMap<QString, QDBusConnection> m_connections;

        static QString getDBusInterfaceFromClassInfo(QObject *object);

        static QDBusConnection::RegisterOptions registerOptions();

        bool registerObjectsWithP2PConnection(QDBusConnection connection);
    };
} // namespace swift::misc
 
#endif // SWIFT_MISC_DBUSSERVER_H