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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
// 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
#include "QXmppPubSubBaseItem.h"
#include "QXmppElement.h"
#include "QXmppUtils.h"
#include <QDomElement>
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
{
}
|
