blob: 207026621c11003372f30fa93a370779bdecfe4a (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
// SPDX-FileCopyrightText: 2019 Jeremy Lainé <jeremy.laine@m4x.org>
// SPDX-FileCopyrightText: 2019 Linus Jahn <lnj@kaidan.im>
//
// SPDX-License-Identifier: LGPL-2.1-or-later
#pragma once
#include "QXmppGlobal.h"
#include <QDomElement>
#include <QMetaType>
#include <QSharedDataPointer>
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<typename PayloadChecker>
static bool isItem(const QDomElement &element, PayloadChecker isPayloadValid);
private:
QSharedDataPointer<QXmppPubSubBaseItemPrivate> 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<typename PayloadChecker>
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)
|
