aboutsummaryrefslogtreecommitdiff
path: root/lib/events/stateevent.h
blob: 1a02646ba202d4d035d1e4bb97a184b7191b86db (plain)
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
/******************************************************************************
 * Copyright (C) 2018 Kitsune Ral <kitsune-ral@users.sf.net>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
 */

#pragma once

#include "roomevent.h"

namespace QMatrixClient {
    class StateEventBase : public RoomEvent
    {
        public:
        using factory_t = EventFactory<StateEventBase>;

        using RoomEvent::RoomEvent;
        ~StateEventBase() override = default;

        bool isStateEvent() const override { return true; }
        QString replacedState() const;
        void dumpTo(QDebug dbg) const override;

        virtual bool repeatsState() const;
    };
    using StateEventPtr = event_ptr_tt<StateEventBase>;
    using StateEvents = EventsArray<StateEventBase>;

    template <> inline bool is<StateEventBase>(const Event& e)
    {
        return e.isStateEvent();
    }

    /**
     * A combination of event type and state key uniquely identifies a piece
     * of state in Matrix.
     * \sa
     * https://matrix.org/docs/spec/client_server/unstable.html#types-of-room-events
     */
    using StateEventKey = QPair<QString, QString>;

    template <typename ContentT> struct Prev {
        template <typename... ContentParamTs>
        explicit Prev(const QJsonObject& unsignedJson,
                      ContentParamTs&&... contentParams)
            : senderId(unsignedJson.value("prev_sender"_ls).toString()),
              content(unsignedJson.value(PrevContentKeyL).toObject(),
                      std::forward<ContentParamTs>(contentParams)...)
        {
        }

        QString senderId;
        ContentT content;
    };

    template <typename ContentT> class StateEvent : public StateEventBase
    {
        public:
        using content_type = ContentT;

        template <typename... ContentParamTs>
        explicit StateEvent(Type type, const QJsonObject& fullJson,
                            ContentParamTs&&... contentParams)
            : StateEventBase(type, fullJson),
              _content(contentJson(),
                       std::forward<ContentParamTs>(contentParams)...)
        {
            const auto& unsignedData = unsignedJson();
            if (unsignedData.contains(PrevContentKeyL))
                _prev = std::make_unique<Prev<ContentT>>(
                        unsignedData,
                        std::forward<ContentParamTs>(contentParams)...);
        }
        template <typename... ContentParamTs>
        explicit StateEvent(Type type, event_mtype_t matrixType,
                            ContentParamTs&&... contentParams)
            : StateEventBase(type, matrixType),
              _content(std::forward<ContentParamTs>(contentParams)...)
        {
            editJson().insert(ContentKey, _content.toJson());
        }

        const ContentT& content() const { return _content; }
        template <typename VisitorT> void editContent(VisitorT&& visitor)
        {
            visitor(_content);
            editJson()[ContentKeyL] = _content.toJson();
        }
        [[deprecated("Use prevContent instead")]] const ContentT*
        prev_content() const
        {
            return prevContent();
        }
        const ContentT* prevContent() const
        {
            return _prev ? &_prev->content : nullptr;
        }
        QString prevSenderId() const
        {
            return _prev ? _prev->senderId : QString();
        }

        private:
        ContentT _content;
        std::unique_ptr<Prev<ContentT>> _prev;
    };
} // namespace QMatrixClient

namespace std {
    template <> struct hash<QMatrixClient::StateEventKey> {
        size_t
        operator()(const QMatrixClient::StateEventKey& k) const Q_DECL_NOEXCEPT
        {
            return qHash(k);
        }
    };
}