Implement XEP-0118: User Tune: Add manager with tests

1 files changed, 134 insertions, 0 deletions

diff --git a/src/client/QXmppUserTuneManager.cpp b/src/client/QXmppUserTuneManager.cpp
new file mode 100644
index 00000000..73bc257e
--- /dev/null
+++ b/src/client/QXmppUserTuneManager.cpp
@@ -0,0 +1,134 @@
+/*
+ * Copyright (C) 2008-2021 The QXmpp developers
+ *
+ * Author:
+ *  Linus Jahn
+ *
+ * Source:
+ *  https://github.com/qxmpp-project/qxmpp
+ *
+ * This file is a part of QXmpp library.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library 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.
+ *
+ */
+
+#include "QXmppUserTuneManager.h"
+
+#include "QXmppConstants_p.h"
+#include "QXmppFutureUtils_p.h"
+#include "QXmppPubSubEvent.h"
+#include "QXmppPubSubManager.h"
+#include "QXmppTuneItem.h"
+
+using namespace QXmpp::Private;
+
+///
+/// \class QXmppUserTuneManager
+///
+/// The QXmppUserTuneManager implements \xep{0118, User Tune}. You'll receive
+/// tune updates from all presence subscriptions. You can publish tune
+/// information on the user's account (publish()) and request tune information
+/// from specific accounts (request()).
+///
+/// The manager needs to be added to the client first and also requires the
+/// QXmppPubSubManager.
+/// \code
+/// QXmppClient client;
+/// auto *pubSubManager = client.addNewExtension<QXmppPubSubManager>();
+/// auto *tuneManager = client.addNewExtension<QXmppUserTuneManager>();
+/// \endcode
+///
+/// \since QXmpp 1.5
+///
+
+///
+/// \typedef QXmppUserTuneManager::TuneResult
+///
+/// Contains the User Tune information or an error.
+///
+
+///
+/// \typedef QXmppUserTuneManager::PublishResult
+///
+/// Contains the ID of the published item on success or a stanza error.
+///
+
+///
+/// \fn QXmppUserTuneManager::userTuneChanged()
+///
+/// Emitted whenever an \xep{0118, User Tune} items event arrives.
+///
+
+QXmppUserTuneManager::QXmppUserTuneManager()
+{
+}
+
+QStringList QXmppUserTuneManager::discoveryFeatures() const
+{
+    return {
+        ns_tune,
+        ns_tune_notify,
+    };
+}
+
+///
+/// Request User Tune information from an account.
+///
+/// \param jid The account JID to request.
+///
+QFuture<QXmppUserTuneManager::TuneResult> QXmppUserTuneManager::request(const QString &jid)
+{
+    using PubSub = QXmppPubSubManager;
+    using Error = QXmppStanza::Error;
+
+    return chain<TuneResult>(pubSub()->requestItems<QXmppTuneItem>(jid, ns_tune), this,
+                             [](PubSub::ItemsResult<QXmppTuneItem> &&result) -> TuneResult {
+                                 if (const auto items = std::get_if<PubSub::Items<QXmppTuneItem>>(&result)) {
+                                     if (!items->items.isEmpty()) {
+                                         return items->items.constFirst();
+                                     }
+                                     return Error(Error::Cancel, Error::ItemNotFound, QStringLiteral("No tune available."));
+                                 } else {
+                                     return std::get<QXmppStanza::Error>(result);
+                                 }
+                             });
+}
+
+///
+/// Publishes User Tune information on the user's account.
+///
+/// \param item The User Tune item to be published.
+///
+QFuture<QXmppUserTuneManager::PublishResult> QXmppUserTuneManager::publish(const QXmppTuneItem &item)
+{
+    return pubSub()->publishPepItem(ns_tune, item);
+}
+
+/// \cond
+bool QXmppUserTuneManager::handlePubSubEvent(const QDomElement &element, const QString &pubSubService, const QString &nodeName)
+{
+    if (nodeName == ns_tune && QXmppPubSubEvent<QXmppTuneItem>::isPubSubEvent(element)) {
+        QXmppPubSubEvent<QXmppTuneItem> event;
+        event.parse(element);
+
+        if (event.eventType() == QXmppPubSubEventBase::Items) {
+            if (!event.items().isEmpty()) {
+                emit userTuneChanged(pubSubService, event.items().constFirst());
+            } else {
+                emit userTuneChanged(pubSubService, {});
+            }
+            return true;
+        }
+    }
+    return false;
+}
+/// \endcond