aboutsummaryrefslogtreecommitdiff
path: root/src/base/QXmppPubSubNodeConfig.h
blob: 383b59eebc7e13969d8635e788751fcb679ab0b2 (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
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
// SPDX-FileCopyrightText: 2020 Linus Jahn <lnj@kaidan.im>
//
// SPDX-License-Identifier: LGPL-2.1-or-later

#ifndef QXMPPPUBSUBNODECONFIG_H
#define QXMPPPUBSUBNODECONFIG_H

#include "QXmppDataForm.h"
#include "QXmppDataFormBase.h"

#include <variant>

class QXmppPubSubNodeConfigPrivate;

class QXMPP_EXPORT QXmppPubSubNodeConfig : public QXmppExtensibleDataFormBase
{
public:
    struct Unset
    {
    };
    struct Max
    {
    };
    using ItemLimit = std::variant<Unset, uint64_t, Max>;

    enum AccessModel : uint8_t {
        Open,
        Presence,
        Roster,
        Authorize,
        Allowlist
    };
    static std::optional<AccessModel> accessModelFromString(const QString &);
    static QString accessModelToString(AccessModel);

    enum PublishModel : uint8_t {
        Publishers,
        Subscribers,
        Anyone
    };
    static std::optional<PublishModel> publishModelFromString(const QString &);
    static QString publishModelToString(PublishModel);

    enum class ChildAssociationPolicy : uint8_t {
        All,
        Owners,
        Whitelist
    };
    static std::optional<ChildAssociationPolicy> childAssociatationPolicyFromString(const QString &);
    static QString childAssociationPolicyToString(ChildAssociationPolicy);

    enum ItemPublisher : uint8_t {
        NodeOwner,
        Publisher
    };
    static std::optional<ItemPublisher> itemPublisherFromString(const QString &);
    static QString itemPublisherToString(ItemPublisher);

    enum NodeType : uint8_t {
        Leaf,
        Collection
    };
    static std::optional<NodeType> nodeTypeFromString(const QString &);
    static QString nodeTypeToString(NodeType);

    enum NotificationType : uint8_t {
        Normal,
        Headline
    };
    static std::optional<NotificationType> notificationTypeFromString(const QString &);
    static QString notificationTypeToString(NotificationType);

    enum SendLastItemType : uint8_t {
        Never,
        OnSubscription,
        OnSubscriptionAndPresence
    };
    static std::optional<SendLastItemType> sendLastItemTypeFromString(const QString &);
    static QString sendLastItemTypeToString(SendLastItemType);

    static std::optional<QXmppPubSubNodeConfig> fromDataForm(const QXmppDataForm &form);

    QXmppPubSubNodeConfig();
    QXmppPubSubNodeConfig(const QXmppPubSubNodeConfig &);
    QXmppPubSubNodeConfig(QXmppPubSubNodeConfig &&);
    ~QXmppPubSubNodeConfig();

    QXmppPubSubNodeConfig &operator=(const QXmppPubSubNodeConfig &);
    QXmppPubSubNodeConfig &operator=(QXmppPubSubNodeConfig &&);

    std::optional<AccessModel> accessModel() const;
    void setAccessModel(std::optional<AccessModel> accessModel);

    QString bodyXslt() const;
    void setBodyXslt(const QString &bodyXslt);

    std::optional<ChildAssociationPolicy> childAssociationPolicy() const;
    void setChildAssociationPolicy(std::optional<ChildAssociationPolicy> childAssociationPolicy);

    QStringList childAssociationAllowlist() const;
    void setChildAssociationAllowlist(const QStringList &childAssociationWhitelist);

    QStringList childNodes() const;
    void setChildNodes(const QStringList &childNodes);

    std::optional<quint32> childNodesMax() const;
    void setChildNodesMax(std::optional<quint32> childNodesMax);

    QStringList collections() const;
    void setCollections(const QStringList &collections);

    QStringList contactJids() const;
    void setContactJids(const QStringList &contactJids);

    QString dataFormXslt() const;
    void setDataFormXslt(const QString &dataFormXslt);

    std::optional<bool> notificationsEnabled() const;
    void setNotificationsEnabled(std::optional<bool> notificationsEnabled);

    std::optional<bool> includePayloads() const;
    void setIncludePayloads(std::optional<bool> includePayloads);

    QString description() const;
    void setDescription(const QString &description);

    std::optional<quint32> itemExpiry() const;
    void setItemExpiry(std::optional<quint32> itemExpiry);

    std::optional<ItemPublisher> notificationItemPublisher() const;
    void setNotificationItemPublisher(std::optional<ItemPublisher> notificationItemPublisher);

    QString language() const;
    void setLanguage(const QString &language);

    ItemLimit maxItems() const;
    void setMaxItems(ItemLimit maxItems);
    inline void resetMaxItems() { setMaxItems(Unset()); }

    std::optional<quint32> maxPayloadSize() const;
    void setMaxPayloadSize(std::optional<quint32> maxPayloadSize);

    std::optional<NodeType> nodeType() const;
    void setNodeType(std::optional<NodeType> nodeType);

    std::optional<QXmppPubSubNodeConfig::NotificationType> notificationType() const;
    void setNotificationType(std::optional<QXmppPubSubNodeConfig::NotificationType> notificationType);

    std::optional<bool> configNotificationsEnabled() const;
    void setConfigNotificationsEnabled(std::optional<bool> configNotificationsEnabled);

    std::optional<bool> deleteNotificationsEnabled() const;
    void setDeleteNotificationsEnabled(std::optional<bool> nodeDeleteNotificationsEnabled);

    std::optional<bool> retractNotificationsEnabled() const;
    void setRetractNotificationsEnabled(std::optional<bool> retractNotificationsEnabled);

    std::optional<bool> subNotificationsEnabled() const;
    void setSubNotificationsEnabled(std::optional<bool> subNotificationsEnabled);

    std::optional<bool> persistItems() const;
    void setPersistItems(std::optional<bool> persistItems);

    std::optional<bool> presenceBasedNotifications() const;
    void setPresenceBasedNotifications(std::optional<bool> presenceBasedNotifications);

    std::optional<PublishModel> publishModel() const;
    void setPublishModel(std::optional<PublishModel> publishModel);

    std::optional<bool> purgeWhenOffline() const;
    void setPurgeWhenOffline(std::optional<bool> purgeWhenOffline);

    QStringList allowedRosterGroups() const;
    void setAllowedRosterGroups(const QStringList &allowedRosterGroups);

    std::optional<SendLastItemType> sendLastItem() const;
    void setSendLastItem(std::optional<SendLastItemType> sendLastItem);

    std::optional<bool> temporarySubscriptions() const;
    void setTemporarySubscriptions(std::optional<bool> temporarySubscriptions);

    std::optional<bool> allowSubscriptions() const;
    void setAllowSubscriptions(std::optional<bool> allowSubscriptions);

    QString title() const;
    void setTitle(const QString &title);

    QString payloadType() const;
    void setPayloadType(const QString &payloadType);

protected:
    QString formType() const override;
    bool parseField(const QXmppDataForm::Field &) override;
    void serializeForm(QXmppDataForm &) const override;

private:
    QSharedDataPointer<QXmppPubSubNodeConfigPrivate> d;
};

class QXMPP_EXPORT QXmppPubSubPublishOptions : public QXmppPubSubNodeConfig
{
public:
    static std::optional<QXmppPubSubPublishOptions> fromDataForm(const QXmppDataForm &form);

protected:
    QString formType() const override;
};

Q_DECLARE_METATYPE(QXmppPubSubNodeConfig);
Q_DECLARE_METATYPE(QXmppPubSubPublishOptions);

#endif  // QXMPPPUBSUBNODECONFIG_H