From fcd8224256e38d50d4ec67b71c504dcb6e480e95 Mon Sep 17 00:00:00 2001 From: Linus Jahn Date: Thu, 9 Mar 2023 18:48:21 +0100 Subject: Rename PubSubItem -> PubSubBaseItem to be able to include old PubSubItem --- src/base/QXmppGeolocItem.cpp | 2 +- src/base/QXmppGeolocItem.h | 4 +- src/base/QXmppMixInfoItem.h | 4 +- src/base/QXmppMixItems.cpp | 4 +- src/base/QXmppMixParticipantItem.h | 4 +- src/base/QXmppPubSubBaseItem.cpp | 152 +++++++++++++++++++++++++++++++++++++ src/base/QXmppPubSubBaseItem.h | 87 +++++++++++++++++++++ src/base/QXmppPubSubEvent.h | 4 +- src/base/QXmppPubSubIq_p.h | 4 +- src/base/QXmppPubSubItem.cpp | 152 ------------------------------------- src/base/QXmppPubSubItem.h | 90 ---------------------- src/base/QXmppUserTuneItem.cpp | 2 +- src/base/QXmppUserTuneItem.h | 4 +- 13 files changed, 255 insertions(+), 258 deletions(-) create mode 100644 src/base/QXmppPubSubBaseItem.cpp create mode 100644 src/base/QXmppPubSubBaseItem.h delete mode 100644 src/base/QXmppPubSubItem.cpp delete mode 100644 src/base/QXmppPubSubItem.h (limited to 'src/base') diff --git a/src/base/QXmppGeolocItem.cpp b/src/base/QXmppGeolocItem.cpp index b6bf0b85..32e08189 100644 --- a/src/base/QXmppGeolocItem.cpp +++ b/src/base/QXmppGeolocItem.cpp @@ -146,7 +146,7 @@ bool QXmppGeolocItem::isItem(const QDomElement &itemElement) payload.namespaceURI() == ns_geoloc; }; - return QXmppPubSubItem::isItem(itemElement, isPayloadValid); + return QXmppPubSubBaseItem::isItem(itemElement, isPayloadValid); } /// \cond diff --git a/src/base/QXmppGeolocItem.h b/src/base/QXmppGeolocItem.h index 05d42dba..58914b1b 100644 --- a/src/base/QXmppGeolocItem.h +++ b/src/base/QXmppGeolocItem.h @@ -5,7 +5,7 @@ #ifndef QXMPPGEOLOCITEM_H #define QXMPPGEOLOCITEM_H -#include "QXmppPubSubItem.h" +#include "QXmppPubSubBaseItem.h" #include @@ -13,7 +13,7 @@ class QXmppGeolocItemPrivate; -class QXMPP_EXPORT QXmppGeolocItem : public QXmppPubSubItem +class QXMPP_EXPORT QXmppGeolocItem : public QXmppPubSubBaseItem { public: QXmppGeolocItem(); diff --git a/src/base/QXmppMixInfoItem.h b/src/base/QXmppMixInfoItem.h index 9a28decb..313c3e14 100644 --- a/src/base/QXmppMixInfoItem.h +++ b/src/base/QXmppMixInfoItem.h @@ -5,11 +5,11 @@ #ifndef QXMPPMIXINFOITEM_H #define QXMPPMIXINFOITEM_H -#include "QXmppPubSubItem.h" +#include "QXmppPubSubBaseItem.h" class QXmppMixInfoItemPrivate; -class QXMPP_EXPORT QXmppMixInfoItem : public QXmppPubSubItem +class QXMPP_EXPORT QXmppMixInfoItem : public QXmppPubSubBaseItem { public: QXmppMixInfoItem(); diff --git a/src/base/QXmppMixItems.cpp b/src/base/QXmppMixItems.cpp index e08dd3f2..a19edbb0 100644 --- a/src/base/QXmppMixItems.cpp +++ b/src/base/QXmppMixItems.cpp @@ -138,7 +138,7 @@ void QXmppMixInfoItem::setContactJids(QStringList contactJids) /// bool QXmppMixInfoItem::isItem(const QDomElement &element) { - return QXmppPubSubItem::isItem(element, [](const QDomElement &payload) { + return QXmppPubSubBaseItem::isItem(element, [](const QDomElement &payload) { // check FORM_TYPE without parsing a full QXmppDataForm if (payload.tagName() != u'x' || payload.namespaceURI() != ns_data) { return false; @@ -264,7 +264,7 @@ void QXmppMixParticipantItem::serializePayload(QXmlStreamWriter *writer) const /// bool QXmppMixParticipantItem::isItem(const QDomElement &element) { - return QXmppPubSubItem::isItem(element, [](const QDomElement &payload) { + return QXmppPubSubBaseItem::isItem(element, [](const QDomElement &payload) { return payload.tagName() == QStringLiteral("participant") && payload.namespaceURI() == ns_mix; }); diff --git a/src/base/QXmppMixParticipantItem.h b/src/base/QXmppMixParticipantItem.h index f0f2abaa..ce179fbe 100644 --- a/src/base/QXmppMixParticipantItem.h +++ b/src/base/QXmppMixParticipantItem.h @@ -5,11 +5,11 @@ #ifndef QXMPPMIXPARTICIPANTITEM_H #define QXMPPMIXPARTICIPANTITEM_H -#include "QXmppPubSubItem.h" +#include "QXmppPubSubBaseItem.h" class QXmppMixParticipantItemPrivate; -class QXMPP_EXPORT QXmppMixParticipantItem : public QXmppPubSubItem +class QXMPP_EXPORT QXmppMixParticipantItem : public QXmppPubSubBaseItem { public: QXmppMixParticipantItem(); diff --git a/src/base/QXmppPubSubBaseItem.cpp b/src/base/QXmppPubSubBaseItem.cpp new file mode 100644 index 00000000..43b1aa88 --- /dev/null +++ b/src/base/QXmppPubSubBaseItem.cpp @@ -0,0 +1,152 @@ +// SPDX-FileCopyrightText: 2019 Jeremy Lainé +// SPDX-FileCopyrightText: 2019 Linus Jahn +// +// SPDX-License-Identifier: LGPL-2.1-or-later + +#include "QXmppPubSubBaseItem.h" + +#include "QXmppElement.h" +#include "QXmppUtils.h" + +#include + +class QXmppPubSubBaseItemPrivate : public QSharedData +{ +public: + QXmppPubSubBaseItemPrivate(const QString &id, const QString &publisher); + + QString id; + QString publisher; +}; + +QXmppPubSubBaseItemPrivate::QXmppPubSubBaseItemPrivate(const QString &id, const QString &publisher) + : id(id), publisher(publisher) +{ +} + +/// +/// \class QXmppPubSubBaseItem +/// +/// The QXmppPubSubBaseItem class represents a publish-subscribe item as defined by +/// \xep{0060, Publish-Subscribe}. +/// +/// To access the payload of an item, you need to create a derived class of this +/// and override QXmppPubSubBaseItem::parsePayload() and +/// QXmppPubSubBaseItem::serializePayload(). +/// +/// It is also required that you override QXmppPubSubBaseItem::isItem() and also +/// check for the correct payload of the PubSub item. This can be easily done by +/// using the protected overload of isItem() with an function that checks the +/// tag name and namespace of the payload. The function is only called if a +/// payload exists. +/// +/// In short, you need to reimplement these methods: +/// * QXmppPubSubBaseItem::parsePayload() +/// * QXmppPubSubBaseItem::serializePayload() +/// * QXmppPubSubBaseItem::isItem() +/// +/// \since QXmpp 1.5 +/// + +/// +/// Constructs an item with \a id and \a publisher. +/// +/// \param id +/// \param publisher +/// +QXmppPubSubBaseItem::QXmppPubSubBaseItem(const QString &id, const QString &publisher) + : d(new QXmppPubSubBaseItemPrivate(id, publisher)) +{ +} + +/// Default copy-constructor +QXmppPubSubBaseItem::QXmppPubSubBaseItem(const QXmppPubSubBaseItem &iq) = default; +/// Default move-constructor +QXmppPubSubBaseItem::QXmppPubSubBaseItem(QXmppPubSubBaseItem &&) = default; +QXmppPubSubBaseItem::~QXmppPubSubBaseItem() = default; +/// Default assignment operator +QXmppPubSubBaseItem &QXmppPubSubBaseItem::operator=(const QXmppPubSubBaseItem &iq) = default; +/// Default move-assignment operator +QXmppPubSubBaseItem &QXmppPubSubBaseItem::operator=(QXmppPubSubBaseItem &&iq) = default; + +/// +/// Returns the ID of the PubSub item. +/// +QString QXmppPubSubBaseItem::id() const +{ + return d->id; +} + +/// +/// Sets the ID of the PubSub item. +/// +/// \param id +/// +void QXmppPubSubBaseItem::setId(const QString &id) +{ + d->id = id; +} + +/// +/// Returns the JID of the publisher of the item. +/// +QString QXmppPubSubBaseItem::publisher() const +{ + return d->publisher; +} + +/// +/// Sets the JID of the publisher of the item. +/// +void QXmppPubSubBaseItem::setPublisher(const QString &publisher) +{ + d->publisher = publisher; +} + +/// \cond +void QXmppPubSubBaseItem::parse(const QDomElement &element) +{ + d->id = element.attribute(QStringLiteral("id")); + d->publisher = element.attribute(QStringLiteral("publisher")); + + parsePayload(element.firstChildElement()); +} + +void QXmppPubSubBaseItem::toXml(QXmlStreamWriter *writer) const +{ + writer->writeStartElement(QStringLiteral("item")); + helperToXmlAddAttribute(writer, QStringLiteral("id"), d->id); + helperToXmlAddAttribute(writer, QStringLiteral("publisher"), d->publisher); + + serializePayload(writer); + + writer->writeEndElement(); +} +/// \endcond + +/// +/// Returns true, if the element is possibly a PubSub item. +/// +bool QXmppPubSubBaseItem::isItem(const QDomElement &element) +{ + return element.tagName() == QStringLiteral("item"); +} + +/// +/// Parses the payload of the item (the child element of the <item/>). +/// +/// This method needs to be overriden to perform the payload-specific parsing. +/// +void QXmppPubSubBaseItem::parsePayload(const QDomElement &) +{ +} + +/// +/// Serializes the payload of the item (the child element of the <item/>). +/// +/// This method needs to be overriden to perform the payload-specific +/// serialization. +/// +void QXmppPubSubBaseItem::serializePayload(QXmlStreamWriter *) const +{ +} diff --git a/src/base/QXmppPubSubBaseItem.h b/src/base/QXmppPubSubBaseItem.h new file mode 100644 index 00000000..20702662 --- /dev/null +++ b/src/base/QXmppPubSubBaseItem.h @@ -0,0 +1,87 @@ +// SPDX-FileCopyrightText: 2019 Jeremy Lainé +// SPDX-FileCopyrightText: 2019 Linus Jahn +// +// SPDX-License-Identifier: LGPL-2.1-or-later + +#pragma once + +#include "QXmppGlobal.h" + +#include +#include +#include + +class QXmlStreamWriter; +class QXmppPubSubBaseItemPrivate; + +class QXMPP_EXPORT QXmppPubSubBaseItem +{ +public: + QXmppPubSubBaseItem(const QString &id = {}, const QString &publisher = {}); + QXmppPubSubBaseItem(const QXmppPubSubBaseItem &); + QXmppPubSubBaseItem(QXmppPubSubBaseItem &&); + virtual ~QXmppPubSubBaseItem(); + + QXmppPubSubBaseItem &operator=(const QXmppPubSubBaseItem &); + QXmppPubSubBaseItem &operator=(QXmppPubSubBaseItem &&); + + QString id() const; + void setId(const QString &id); + + QString publisher() const; + void setPublisher(const QString &publisher); + + /// \cond + void parse(const QDomElement &element); + void toXml(QXmlStreamWriter *writer) const; + /// \endcond + + static bool isItem(const QDomElement &element); + +protected: + virtual void parsePayload(const QDomElement &payloadElement); + virtual void serializePayload(QXmlStreamWriter *writer) const; + + template + static bool isItem(const QDomElement &element, PayloadChecker isPayloadValid); + +private: + QSharedDataPointer d; +}; + +/// +/// Returns true, if the element is a valid PubSub item and (if existant) the +/// payload is correct. +/// +/// \param element The element to be checked to be an <item/> element. +/// \param isPayloadValid A function that validates the payload element (first +/// child element). The functions needs to return true, if the payload is valid. +/// In case there is no payload, the function is not called. +/// +/// Here is an example covering how this could be used to check for the +/// \xep{0118, User Tune} payload: +/// \code +/// auto isPayloadValid = [](const QDomElement &payload) -> bool { +/// return payload.tagName() == "tune" && payload.namespaceURI() == ns_tune; +/// }; +/// +/// bool valid = QXmppPubSubItem::isItem(itemElement, isPayloadValid); +/// \endcode +/// +template +bool QXmppPubSubBaseItem::isItem(const QDomElement &element, PayloadChecker isPayloadValid) +{ + if (!isItem(element)) { + return false; + } + + const QDomElement payload = element.firstChildElement(); + + // we can only check the payload if it's existant + if (!payload.isNull()) { + return isPayloadValid(payload); + } + return true; +} + +Q_DECLARE_METATYPE(QXmppPubSubBaseItem) diff --git a/src/base/QXmppPubSubEvent.h b/src/base/QXmppPubSubEvent.h index 0faf62b6..3625c8aa 100644 --- a/src/base/QXmppPubSubEvent.h +++ b/src/base/QXmppPubSubEvent.h @@ -15,7 +15,7 @@ class QXmppDataForm; class QXmppPubSubEventPrivate; -class QXmppPubSubItem; +class QXmppPubSubBaseItem; class QXMPP_EXPORT QXmppPubSubEventBase : public QXmppMessage { @@ -73,7 +73,7 @@ private: QSharedDataPointer d; }; -template +template class QXmppPubSubEvent : public QXmppPubSubEventBase { public: diff --git a/src/base/QXmppPubSubIq_p.h b/src/base/QXmppPubSubIq_p.h index eb5ed43f..6868eb84 100644 --- a/src/base/QXmppPubSubIq_p.h +++ b/src/base/QXmppPubSubIq_p.h @@ -15,7 +15,7 @@ class QXmppDataForm; class QXmppPubSubIqPrivate; -class QXmppPubSubItem; +class QXmppPubSubBaseItem; class QXmppPubSubSubscription; class QXmppPubSubAffiliation; class QXmppResultSetReply; @@ -103,7 +103,7 @@ private: QSharedDataPointer d; }; -template +template class PubSubIq : public PubSubIqBase { public: diff --git a/src/base/QXmppPubSubItem.cpp b/src/base/QXmppPubSubItem.cpp deleted file mode 100644 index f87c5d6e..00000000 --- a/src/base/QXmppPubSubItem.cpp +++ /dev/null @@ -1,152 +0,0 @@ -// SPDX-FileCopyrightText: 2019 Jeremy Lainé -// SPDX-FileCopyrightText: 2019 Linus Jahn -// -// SPDX-License-Identifier: LGPL-2.1-or-later - -#include "QXmppPubSubItem.h" - -#include "QXmppElement.h" -#include "QXmppUtils.h" - -#include - -class QXmppPubSubItemPrivate : public QSharedData -{ -public: - QXmppPubSubItemPrivate(const QString &id, const QString &publisher); - - QString id; - QString publisher; -}; - -QXmppPubSubItemPrivate::QXmppPubSubItemPrivate(const QString &id, const QString &publisher) - : id(id), publisher(publisher) -{ -} - -/// -/// \class QXmppPubSubItem -/// -/// The QXmppPubSubItem class represents a publish-subscribe item as defined by -/// \xep{0060, Publish-Subscribe}. -/// -/// To access the payload of an item, you need to create a derived class of this -/// and override QXmppPubSubItem::parsePayload() and -/// QXmppPubSubItem::serializePayload(). -/// -/// It is also required that you override QXmppPubSubItem::isItem() and also -/// check for the correct payload of the PubSub item. This can be easily done by -/// using the protected overload of isItem() with an function that checks the -/// tag name and namespace of the payload. The function is only called if a -/// payload exists. -/// -/// In short, you need to reimplement these methods: -/// * QXmppPubSubItem::parsePayload() -/// * QXmppPubSubItem::serializePayload() -/// * QXmppPubSubItem::isItem() -/// -/// \since QXmpp 1.5 -/// - -/// -/// Constructs an item with \a id and \a publisher. -/// -/// \param id -/// \param publisher -/// -QXmppPubSubItem::QXmppPubSubItem(const QString &id, const QString &publisher) - : d(new QXmppPubSubItemPrivate(id, publisher)) -{ -} - -/// Default copy-constructor -QXmppPubSubItem::QXmppPubSubItem(const QXmppPubSubItem &iq) = default; -/// Default move-constructor -QXmppPubSubItem::QXmppPubSubItem(QXmppPubSubItem &&) = default; -QXmppPubSubItem::~QXmppPubSubItem() = default; -/// Default assignment operator -QXmppPubSubItem &QXmppPubSubItem::operator=(const QXmppPubSubItem &iq) = default; -/// Default move-assignment operator -QXmppPubSubItem &QXmppPubSubItem::operator=(QXmppPubSubItem &&iq) = default; - -/// -/// Returns the ID of the PubSub item. -/// -QString QXmppPubSubItem::id() const -{ - return d->id; -} - -/// -/// Sets the ID of the PubSub item. -/// -/// \param id -/// -void QXmppPubSubItem::setId(const QString &id) -{ - d->id = id; -} - -/// -/// Returns the JID of the publisher of the item. -/// -QString QXmppPubSubItem::publisher() const -{ - return d->publisher; -} - -/// -/// Sets the JID of the publisher of the item. -/// -void QXmppPubSubItem::setPublisher(const QString &publisher) -{ - d->publisher = publisher; -} - -/// \cond -void QXmppPubSubItem::parse(const QDomElement &element) -{ - d->id = element.attribute(QStringLiteral("id")); - d->publisher = element.attribute(QStringLiteral("publisher")); - - parsePayload(element.firstChildElement()); -} - -void QXmppPubSubItem::toXml(QXmlStreamWriter *writer) const -{ - writer->writeStartElement(QStringLiteral("item")); - helperToXmlAddAttribute(writer, QStringLiteral("id"), d->id); - helperToXmlAddAttribute(writer, QStringLiteral("publisher"), d->publisher); - - serializePayload(writer); - - writer->writeEndElement(); -} -/// \endcond - -/// -/// Returns true, if the element is possibly a PubSub item. -/// -bool QXmppPubSubItem::isItem(const QDomElement &element) -{ - return element.tagName() == QStringLiteral("item"); -} - -/// -/// Parses the payload of the item (the child element of the <item/>). -/// -/// This method needs to be overriden to perform the payload-specific parsing. -/// -void QXmppPubSubItem::parsePayload(const QDomElement &) -{ -} - -/// -/// Serializes the payload of the item (the child element of the <item/>). -/// -/// This method needs to be overriden to perform the payload-specific -/// serialization. -/// -void QXmppPubSubItem::serializePayload(QXmlStreamWriter *) const -{ -} diff --git a/src/base/QXmppPubSubItem.h b/src/base/QXmppPubSubItem.h deleted file mode 100644 index e585de9d..00000000 --- a/src/base/QXmppPubSubItem.h +++ /dev/null @@ -1,90 +0,0 @@ -// SPDX-FileCopyrightText: 2019 Jeremy Lainé -// SPDX-FileCopyrightText: 2019 Linus Jahn -// -// SPDX-License-Identifier: LGPL-2.1-or-later - -#ifndef QXMPPPUBSUBITEM_H -#define QXMPPPUBSUBITEM_H - -#include "QXmppGlobal.h" - -#include -#include -#include - -class QXmlStreamWriter; -class QXmppPubSubItemPrivate; - -class QXMPP_EXPORT QXmppPubSubItem -{ -public: - QXmppPubSubItem(const QString &id = {}, const QString &publisher = {}); - QXmppPubSubItem(const QXmppPubSubItem &); - QXmppPubSubItem(QXmppPubSubItem &&); - virtual ~QXmppPubSubItem(); - - QXmppPubSubItem &operator=(const QXmppPubSubItem &); - QXmppPubSubItem &operator=(QXmppPubSubItem &&); - - QString id() const; - void setId(const QString &id); - - QString publisher() const; - void setPublisher(const QString &publisher); - - /// \cond - void parse(const QDomElement &element); - void toXml(QXmlStreamWriter *writer) const; - /// \endcond - - static bool isItem(const QDomElement &element); - -protected: - virtual void parsePayload(const QDomElement &payloadElement); - virtual void serializePayload(QXmlStreamWriter *writer) const; - - template - static bool isItem(const QDomElement &element, PayloadChecker isPayloadValid); - -private: - QSharedDataPointer d; -}; - -/// -/// Returns true, if the element is a valid PubSub item and (if existant) the -/// payload is correct. -/// -/// \param element The element to be checked to be an <item/> element. -/// \param isPayloadValid A function that validates the payload element (first -/// child element). The functions needs to return true, if the payload is valid. -/// In case there is no payload, the function is not called. -/// -/// Here is an example covering how this could be used to check for the -/// \xep{0118, User Tune} payload: -/// \code -/// auto isPayloadValid = [](const QDomElement &payload) -> bool { -/// return payload.tagName() == "tune" && payload.namespaceURI() == ns_tune; -/// }; -/// -/// bool valid = QXmppPubSubItem::isItem(itemElement, isPayloadValid); -/// \endcode -/// -template -bool QXmppPubSubItem::isItem(const QDomElement &element, PayloadChecker isPayloadValid) -{ - if (!isItem(element)) { - return false; - } - - const QDomElement payload = element.firstChildElement(); - - // we can only check the payload if it's existant - if (!payload.isNull()) { - return isPayloadValid(payload); - } - return true; -} - -Q_DECLARE_METATYPE(QXmppPubSubItem) - -#endif // QXMPPPUBSUBITEM_H diff --git a/src/base/QXmppUserTuneItem.cpp b/src/base/QXmppUserTuneItem.cpp index 6d8fb8bf..55d30333 100644 --- a/src/base/QXmppUserTuneItem.cpp +++ b/src/base/QXmppUserTuneItem.cpp @@ -224,7 +224,7 @@ bool QXmppTuneItem::isItem(const QDomElement &itemElement) payload.namespaceURI() == ns_tune; }; - return QXmppPubSubItem::isItem(itemElement, isPayloadValid); + return QXmppPubSubBaseItem::isItem(itemElement, isPayloadValid); } /// \cond diff --git a/src/base/QXmppUserTuneItem.h b/src/base/QXmppUserTuneItem.h index 03bafb1e..c4b1f0a8 100644 --- a/src/base/QXmppUserTuneItem.h +++ b/src/base/QXmppUserTuneItem.h @@ -5,7 +5,7 @@ #ifndef QXMPPUSERTUNEITEM_H #define QXMPPUSERTUNEITEM_H -#include "QXmppPubSubItem.h" +#include "QXmppPubSubBaseItem.h" #include #include @@ -16,7 +16,7 @@ class QXmppTuneItemPrivate; class QUrl; -class QXMPP_EXPORT QXmppTuneItem : public QXmppPubSubItem +class QXMPP_EXPORT QXmppTuneItem : public QXmppPubSubBaseItem { public: QXmppTuneItem(); -- cgit v1.2.3