QXmppRosterManager.h

// SPDX-FileCopyrightText: 2010 Manjeet Dahiya <manjeetdahiya@gmail.com>
// SPDX-FileCopyrightText: 2010 Jeremy Lainé <jeremy.laine@m4x.org>
// SPDX-FileCopyrightText: 2021 Melvin Keskin <melvo@olomono.de>
// SPDX-FileCopyrightText: 2024 Filipe Azevedo <pasnox@gmail.com>
//
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#ifndef QXMPPROSTERMANAGER_H
#define QXMPPROSTERMANAGER_H
 
#include "QXmppClientExtension.h"
#include "QXmppPresence.h"
#include "QXmppRosterIq.h"
#include "QXmppSendResult.h"
 
#include <memory>
#include <variant>
 
#include <QMap>
#include <QObject>
#include <QStringList>
 
template<typename T>
class QXmppTask;
class QXmppRosterManagerPrivate;
class QXmppRosterStorage;
 
class QXMPP_EXPORT QXmppRosterManager : public QXmppClientExtension
{
    Q_OBJECT
 
public:
    using Result = std::variant<QXmpp::Success, QXmppError>;
 
    explicit QXmppRosterManager(QXmppClient *stream);
    ~QXmppRosterManager() override;
 
    QXmppRosterStorage *storage() const;
    void setStorage(std::unique_ptr<QXmppRosterStorage> storage);
    QXmppTask<void> clearCache();
 
    bool isRosterReceived() const;
    QStringList getRosterBareJids() const;
    QXmppRosterIq::Item getRosterEntry(const QString &bareJid) const;
 
    QStringList getResources(const QString &bareJid) const;
    QMap<QString, QXmppPresence> getAllPresencesForBareJid(
        const QString &bareJid) const;
    QXmppPresence getPresence(const QString &bareJid,
                              const QString &resource) const;
 
    QXmppTask<Result> addRosterItem(const QString &bareJid, const QString &name = {}, const QSet<QString> &groups = {});
    QXmppTask<Result> removeRosterItem(const QString &bareJid);
    QXmppTask<Result> renameRosterItem(const QString &bareJid, const QString &name);
    QXmppTask<QXmpp::SendResult> subscribeTo(const QString &bareJid, const QString &reason = {});
    QXmppTask<QXmpp::SendResult> unsubscribeFrom(const QString &bareJid, const QString &reason = {});
 
    bool handleStanza(const QDomElement &element) override;
 
    Q_SLOT bool acceptSubscription(const QString &bareJid, const QString &reason = {});
    Q_SLOT bool refuseSubscription(const QString &bareJid, const QString &reason = {});
    Q_SLOT bool addItem(const QString &bareJid, const QString &name = {}, const QSet<QString> &groups = {});
    Q_SLOT bool removeItem(const QString &bareJid);
    Q_SLOT bool renameItem(const QString &bareJid, const QString &name);
    Q_SLOT bool subscribe(const QString &bareJid, const QString &reason = {});
    Q_SLOT bool unsubscribe(const QString &bareJid, const QString &reason = {});
 
    Q_SIGNAL void rosterReceived();
 
    Q_SIGNAL void presenceChanged(const QString &bareJid, const QString &resource);
 
    Q_SIGNAL void subscriptionReceived(const QString &bareJid);
 
    Q_SIGNAL void subscriptionRequestReceived(const QString &subscriberBareJid, const QXmppPresence &presence);
 
    Q_SIGNAL void itemAdded(const QString &bareJid);
 
    Q_SIGNAL void itemChanged(const QString &bareJid);
 
    Q_SIGNAL void itemRemoved(const QString &bareJid);
 
protected:
    void onRegistered(QXmppClient *client) override;
    void onUnregistered(QXmppClient *client) override;
 
private:
    using RosterResult = std::variant<QXmppRosterIq, QXmppError>;
 
    Q_SLOT void _q_connected();
    Q_SLOT void _q_disconnected();
    Q_SLOT void _q_presenceReceived(const QXmppPresence &);
 
    void handleSubscriptionRequest(const QString &bareJid, const QXmppPresence &presence);
    QXmppTask<void> initRosterFromCacheAndSync();
    QXmppTask<RosterResult> requestRoster();
 
    const std::unique_ptr<QXmppRosterManagerPrivate> d;
 
    friend class QXmppMixManager;
};
 
#endif  // QXMPPROSTER_H