From 4f0a029070091d11ab3d2e17e30e39b4476105e5 Mon Sep 17 00:00:00 2001 From: Linus Jahn Date: Wed, 28 Dec 2022 20:03:49 +0100 Subject: PubSubManager: Add 'own' to PEP function names This makes it clear that the functions use the own PEP nodes. This is clear in some cases (createPepNode()), but in others not so clear (requestPepItem()). To keep it consistent all PEP functions get an 'own' now. Closes #520. --- src/client/QXmppPubSubManager.h | 46 ++++++++++++++++----------------- src/client/QXmppUserLocationManager.cpp | 2 +- src/client/QXmppUserTuneManager.cpp | 2 +- src/omemo/QXmppOmemoManager_p.cpp | 26 +++++++++---------- 4 files changed, 38 insertions(+), 38 deletions(-) (limited to 'src') diff --git a/src/client/QXmppPubSubManager.h b/src/client/QXmppPubSubManager.h index 3c309dc1..ddd3840c 100644 --- a/src/client/QXmppPubSubManager.h +++ b/src/client/QXmppPubSubManager.h @@ -117,31 +117,31 @@ public: QFuture unsubscribeFromNode(const QString &serviceJid, const QString &nodeName, const QString &subscriberJid); // PEP-specific (the PubSub service is the current account) - inline QFuture fetchPepNodes() { return fetchNodes(client()->configuration().jidBare()); }; - inline QFuture createPepNode(const QString &nodeName) { return createNode(client()->configuration().jidBare(), nodeName); } - inline QFuture createPepNode(const QString &nodeName, const QXmppPubSubNodeConfig &config) { return createNode(client()->configuration().jidBare(), nodeName, config); } - inline QFuture deletePepNode(const QString &nodeName) { return deleteNode(client()->configuration().jidBare(), nodeName); } + QFuture requestOwnPepNodes() { return requestNodes(client()->configuration().jidBare()); }; + QFuture createOwnPepNode(const QString &nodeName) { return createNode(client()->configuration().jidBare(), nodeName); } + QFuture createOwnPepNode(const QString &nodeName, const QXmppPubSubNodeConfig &config) { return createNode(client()->configuration().jidBare(), nodeName, config); } + QFuture deleteOwnPepNode(const QString &nodeName) { return deleteNode(client()->configuration().jidBare(), nodeName); } template - inline QFuture> requestPepItem(const QString &nodeName, const QString &itemId) { return requestItem(client()->configuration().jidBare(), nodeName, itemId); } + QFuture> requestOwnPepItem(const QString &nodeName, const QString &itemId) { return requestItem(client()->configuration().jidBare(), nodeName, itemId); } template - inline QFuture> requestPepItem(const QString &nodeName, StandardItemId itemId) { return requestItem(client()->configuration().jidBare(), nodeName, itemId); } + QFuture> requestOwnPepItem(const QString &nodeName, StandardItemId itemId) { return requestItem(client()->configuration().jidBare(), nodeName, itemId); } template - inline QFuture> requestPepItems(const QString &nodeName) { return requestItems(client()->configuration().jidBare(), nodeName); } - inline QFuture requestPepItemIds(const QString &nodeName) { return requestItemIds(client()->configuration().jidBare(), nodeName); } + QFuture> requestOwnPepItems(const QString &nodeName) { return requestItems(client()->configuration().jidBare(), nodeName); } + QFuture requestOwnPepItemIds(const QString &nodeName) { return requestItemIds(client()->configuration().jidBare(), nodeName); } template - QFuture publishPepItem(const QString &nodeName, const T &item, const QXmppPubSubPublishOptions &publishOptions); + QFuture publishOwnPepItem(const QString &nodeName, const T &item, const QXmppPubSubPublishOptions &publishOptions); template - QFuture publishPepItem(const QString &nodeName, const T &item); + QFuture publishOwnPepItem(const QString &nodeName, const T &item); template - QFuture publishPepItems(const QString &nodeName, const QVector &items, const QXmppPubSubPublishOptions &publishOptions); + QFuture publishOwnPepItems(const QString &nodeName, const QVector &items, const QXmppPubSubPublishOptions &publishOptions); template - QFuture publishPepItems(const QString &nodeName, const QVector &items); - inline QFuture retractPepItem(const QString &nodeName, const QString &itemId) { return retractItem(client()->configuration().jidBare(), nodeName, itemId); } - inline QFuture retractPepItem(const QString &nodeName, StandardItemId itemId) { return retractItem(client()->configuration().jidBare(), nodeName, itemId); } - inline QFuture purgePepItems(const QString &nodeName) { return purgeItems(client()->configuration().jidBare(), nodeName); } - inline QFuture requestPepNodeConfiguration(const QString &nodeName) { return requestNodeConfiguration(client()->configuration().jidBare(), nodeName); } - inline QFuture configurePepNode(const QString &nodeName, const QXmppPubSubNodeConfig &config) { return configureNode(client()->configuration().jidBare(), nodeName, config); } - inline QFuture cancelPepNodeConfiguration(const QString &nodeName) { return cancelNodeConfiguration(client()->configuration().jidBare(), nodeName); } + QFuture publishOwnPepItems(const QString &nodeName, const QVector &items); + QFuture retractOwnPepItem(const QString &nodeName, const QString &itemId) { return retractItem(client()->configuration().jidBare(), nodeName, itemId); } + QFuture retractOwnPepItem(const QString &nodeName, StandardItemId itemId) { return retractItem(client()->configuration().jidBare(), nodeName, itemId); } + QFuture purgeOwnPepItems(const QString &nodeName) { return purgeItems(client()->configuration().jidBare(), nodeName); } + QFuture requestOwnPepNodeConfiguration(const QString &nodeName) { return requestNodeConfiguration(client()->configuration().jidBare(), nodeName); } + QFuture configureOwnPepNode(const QString &nodeName, const QXmppPubSubNodeConfig &config) { return configureNode(client()->configuration().jidBare(), nodeName, config); } + QFuture cancelOwnPepNodeConfiguration(const QString &nodeName) { return cancelNodeConfiguration(client()->configuration().jidBare(), nodeName); } static QString standardItemIdToString(StandardItemId itemId); @@ -156,7 +156,7 @@ private: friend class QXmppOmemoManagerPrivate; QFuture requestFeatures(const QString &serviceJid, ServiceType serviceType = PubSubOrPep); - QFuture requestPepFeatures() { return requestFeatures(client()->configuration().jidBare(), Pep); }; + QFuture requestOwnPepFeatures() { return requestFeatures(client()->configuration().jidBare(), Pep); }; QFuture publishItem(QXmpp::Private::PubSubIqBase &&iq); QFuture publishItems(QXmpp::Private::PubSubIqBase &&iq); @@ -346,7 +346,7 @@ QFuture QXmppPubSubManager::publishItems /// \return /// template -QFuture QXmppPubSubManager::publishPepItem(const QString &nodeName, const T &item, const QXmppPubSubPublishOptions &publishOptions) +QFuture QXmppPubSubManager::publishOwnPepItem(const QString &nodeName, const T &item, const QXmppPubSubPublishOptions &publishOptions) { return publishItem(client()->configuration().jidBare(), nodeName, item, publishOptions); } @@ -359,7 +359,7 @@ QFuture QXmppPubSubManager::publishPepIte /// \return /// template -QFuture QXmppPubSubManager::publishPepItem(const QString &nodeName, const T &item) +QFuture QXmppPubSubManager::publishOwnPepItem(const QString &nodeName, const T &item) { return publishItem(client()->configuration().jidBare(), nodeName, item); } @@ -374,7 +374,7 @@ QFuture QXmppPubSubManager::publishPepIte /// \return /// template -QFuture QXmppPubSubManager::publishPepItems(const QString &nodeName, const QVector &items, const QXmppPubSubPublishOptions &publishOptions) +QFuture QXmppPubSubManager::publishOwnPepItems(const QString &nodeName, const QVector &items, const QXmppPubSubPublishOptions &publishOptions) { return publishItems(client()->configuration().jidBare(), nodeName, items, publishOptions); } @@ -387,7 +387,7 @@ QFuture QXmppPubSubManager::publishPepIt /// \return /// template -QFuture QXmppPubSubManager::publishPepItems(const QString &nodeName, const QVector &items) +QFuture QXmppPubSubManager::publishOwnPepItems(const QString &nodeName, const QVector &items) { return publishItems(client()->configuration().jidBare(), nodeName, items); } diff --git a/src/client/QXmppUserLocationManager.cpp b/src/client/QXmppUserLocationManager.cpp index 5c79e6b7..cf35013e 100644 --- a/src/client/QXmppUserLocationManager.cpp +++ b/src/client/QXmppUserLocationManager.cpp @@ -90,7 +90,7 @@ auto QXmppUserLocationManager::request(const QString &jid) auto QXmppUserLocationManager::publish(const QXmppGeolocItem &item) -> QFuture { - return pubSub(client())->publishPepItem(ns_geoloc, item); + return pubSub(client())->publishOwnPepItem(ns_geoloc, item); } /// \cond diff --git a/src/client/QXmppUserTuneManager.cpp b/src/client/QXmppUserTuneManager.cpp index f9b527a0..e0023416 100644 --- a/src/client/QXmppUserTuneManager.cpp +++ b/src/client/QXmppUserTuneManager.cpp @@ -91,7 +91,7 @@ auto QXmppUserTuneManager::request(const QString &jid) auto QXmppUserTuneManager::publish(const QXmppTuneItem &item) -> QFuture { - return pubSub(client())->publishPepItem(ns_tune, item); + return pubSub(client())->publishOwnPepItem(ns_tune, item); } /// \cond diff --git a/src/omemo/QXmppOmemoManager_p.cpp b/src/omemo/QXmppOmemoManager_p.cpp index b61918ec..2de0b5f3 100644 --- a/src/omemo/QXmppOmemoManager_p.cpp +++ b/src/omemo/QXmppOmemoManager_p.cpp @@ -616,7 +616,7 @@ signal_protocol_session_store ManagerPrivate::createSessionStore() const // QFuture ManagerPrivate::setUpDeviceId() { - auto future = pubSubManager->requestPepItemIds(ns_omemo_2_bundles); + auto future = pubSubManager->requestOwnPepItemIds(ns_omemo_2_bundles); return chain(future, q, [this](QXmppPubSubManager::ItemIdsResult result) mutable { // There can be the following cases: // 1. There is no PubSub node for device bundles: XEP-0030 states that a server must @@ -1882,7 +1882,7 @@ QFuture ManagerPrivate::publishOmemoData() { QFutureInterface interface(QFutureInterfaceBase::Started); - auto future = pubSubManager->requestPepFeatures(); + auto future = pubSubManager->requestOwnPepFeatures(); await(future, q, [=](QXmppPubSubManager::FeaturesResult result) mutable { if (const auto error = std::get_if(&result)) { warning("Features of PEP service '" % ownBareJid() % "' could not be retrieved: " % errorToString(*error)); @@ -1900,7 +1900,7 @@ QFuture ManagerPrivate::publishOmemoData() // TODO: Uncomment the following line and remove the other one once ejabberd released version > 21.12 // if (pepServiceFeatures.contains(ns_pubsub_publish) && pepServiceFeatures.contains(ns_pubsub_multi_items)) { if (pepServiceFeatures.contains(ns_pubsub_publish)) { - auto future = pubSubManager->fetchPepNodes(); + auto future = pubSubManager->requestOwnPepNodes(); await(future, q, [=](QXmppPubSubManager::NodesResult result) mutable { if (const auto error = std::get_if(&result)) { warning("Nodes of JID '" % ownBareJid() % "' could not be fetched to check if nodes '" % @@ -2616,7 +2616,7 @@ template void ManagerPrivate::updateOwnDevicesLocally(bool isDeviceListNodeExistent, Function continuation) { if (isDeviceListNodeExistent && otherOwnDevices().isEmpty()) { - auto future = pubSubManager->requestPepItem(ns_omemo_2_devices, QXmppPubSubManager::Current); + auto future = pubSubManager->requestOwnPepItem(ns_omemo_2_devices, QXmppPubSubManager::Current); await(future, q, [=](QXmppPubSubManager::ItemResult result) mutable { if (const auto error = std::get_if(&result)) { warning("Device list for JID '" % ownBareJid() % @@ -2835,14 +2835,14 @@ void ManagerPrivate::handleIrregularDeviceListChanges(const QString &deviceOwner // Publish a new device list for the own devices if their device list // item is removed, if their device list node is removed or if all // the node's items are removed. - auto future = pubSubManager->deletePepNode(ns_omemo_2_devices); + auto future = pubSubManager->deleteOwnPepNode(ns_omemo_2_devices); await(future, q, [=](QXmppPubSubManager::Result result) { if (const auto error = std::get_if(&result)) { warning("Node '" % QString(ns_omemo_2_devices) % "' of JID '" % deviceOwnerJid % "' could not be deleted in order to recover from an inconsistent node: " % errorToString(*error)); } else { - auto future = pubSubManager->requestPepFeatures(); + auto future = pubSubManager->requestOwnPepFeatures(); await(future, q, [=](QXmppPubSubManager::FeaturesResult result) { if (const auto error = std::get_if(&result)) { warning("Features of PEP service '" % deviceOwnerJid % @@ -2915,7 +2915,7 @@ void ManagerPrivate::deleteDeviceElement(Function continuation) template void ManagerPrivate::createNode(const QString &node, Function continuation) { - runPubSubQueryWithContinuation(pubSubManager->createPepNode(node), + runPubSubQueryWithContinuation(pubSubManager->createOwnPepNode(node), "Node '" % node % "' of JID '" % ownBareJid() % "' could not be created", std::move(continuation)); } @@ -2930,7 +2930,7 @@ void ManagerPrivate::createNode(const QString &node, Function continuation) template void ManagerPrivate::createNode(const QString &node, const QXmppPubSubNodeConfig &config, Function continuation) { - runPubSubQueryWithContinuation(pubSubManager->createPepNode(node, config), + runPubSubQueryWithContinuation(pubSubManager->createOwnPepNode(node, config), "Node '" % node % "' of JID '" % ownBareJid() % "' could not be created", std::move(continuation)); } @@ -2945,7 +2945,7 @@ void ManagerPrivate::createNode(const QString &node, const QXmppPubSubNodeConfig template void ManagerPrivate::configureNode(const QString &node, const QXmppPubSubNodeConfig &config, Function continuation) { - runPubSubQueryWithContinuation(pubSubManager->configurePepNode(node, config), + runPubSubQueryWithContinuation(pubSubManager->configureOwnPepNode(node, config), "Node '" % node % "' of JID '" % ownBareJid() % "' could not be configured", std::move(continuation)); } @@ -2961,7 +2961,7 @@ template void ManagerPrivate::retractItem(const QString &node, uint32_t itemId, Function continuation) { const auto itemIdString = QString::number(itemId); - runPubSubQueryWithContinuation(pubSubManager->retractPepItem(node, itemIdString), + runPubSubQueryWithContinuation(pubSubManager->retractOwnPepItem(node, itemIdString), "Item '" % itemIdString % "' of node '" % node % "' and JID '" % ownBareJid() % "' could not be retracted", std::move(continuation)); } @@ -2975,7 +2975,7 @@ void ManagerPrivate::retractItem(const QString &node, uint32_t itemId, Function template void ManagerPrivate::deleteNode(const QString &node, Function continuation) { - auto future = pubSubManager->deletePepNode(node); + auto future = pubSubManager->deleteOwnPepNode(node); await(future, q, [=, continuation = std::move(continuation)](QXmppPubSubManager::Result result) mutable { const auto error = std::get_if(&result); if (error) { @@ -3006,7 +3006,7 @@ void ManagerPrivate::deleteNode(const QString &node, Function continuation) template void ManagerPrivate::publishItem(const QString &node, const T &item, Function continuation) { - runPubSubQueryWithContinuation(pubSubManager->publishPepItem(node, item), + runPubSubQueryWithContinuation(pubSubManager->publishOwnPepItem(node, item), "Item with ID '" % item.id() % "' could not be published to node '" % node % "' of JID '" % ownBareJid() % "'", @@ -3024,7 +3024,7 @@ void ManagerPrivate::publishItem(const QString &node, const T &item, Function co template void ManagerPrivate::publishItem(const QString &node, const T &item, const QXmppPubSubPublishOptions &publishOptions, Function continuation) { - runPubSubQueryWithContinuation(pubSubManager->publishPepItem(node, item, publishOptions), + runPubSubQueryWithContinuation(pubSubManager->publishOwnPepItem(node, item, publishOptions), "Item with ID '" % item.id() % "' could not be published to node '" % node % "' of JID '" % ownBareJid() % "'", std::move(continuation)); } -- cgit v1.2.3