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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
/******************************************************************************
* Copyright (C) 2015 Felix Rohrbach <kde@fxrh.de>
*
* 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 <memory>
#include <deque>
#include <QtCore/QList>
#include <QtCore/QStringList>
#include <QtCore/QObject>
#include <QtCore/QJsonObject>
#include <QtGui/QPixmap>
#include "jobs/syncjob.h"
#include "events/roommessageevent.h"
#include "joinstate.h"
namespace QMatrixClient
{
class Event;
class Connection;
class User;
class MemberSorter;
class LeaveRoomJob;
class TimelineItem
{
public:
// For compatibility with Qt containers, even though we use
// a std:: container now
using index_t = int;
TimelineItem(RoomEvent* e, index_t number) : evt(e), idx(number) { }
RoomEvent* event() const { return evt.get(); }
RoomEvent* operator->() const { return event(); } //< Synonym for event()
index_t index() const { return idx; }
private:
std::unique_ptr<RoomEvent> evt;
index_t idx;
};
inline QDebug& operator<<(QDebug& d, const TimelineItem& ti)
{
QDebugStateSaver dss(d);
d.nospace() << "(" << ti.index() << "|" << ti->id() << ")";
return d;
}
class Room: public QObject
{
Q_OBJECT
Q_PROPERTY(Connection* connection READ connection CONSTANT)
Q_PROPERTY(User* localUser READ localUser CONSTANT)
Q_PROPERTY(QString id READ id CONSTANT)
Q_PROPERTY(QString name READ name NOTIFY namesChanged)
Q_PROPERTY(QStringList aliases READ aliases NOTIFY namesChanged)
Q_PROPERTY(QString canonicalAlias READ canonicalAlias NOTIFY namesChanged)
Q_PROPERTY(QString displayName READ displayName NOTIFY namesChanged)
Q_PROPERTY(QString topic READ topic NOTIFY topicChanged)
Q_PROPERTY(QString readMarkerEventId READ readMarkerEventId WRITE markMessagesAsRead NOTIFY readMarkerMoved)
public:
using Timeline = std::deque<TimelineItem>;
using rev_iter_t = Timeline::const_reverse_iterator;
Room(Connection* connection, QString id, JoinState initialJoinState);
~Room() override;
Connection* connection() const;
User* localUser() const;
const QString& id() const;
QString name() const;
QStringList aliases() const;
QString canonicalAlias() const;
QString displayName() const;
QString topic() const;
Q_INVOKABLE JoinState joinState() const;
Q_INVOKABLE QList<User*> usersTyping() const;
QList<User*> membersLeft() const;
Q_INVOKABLE QList<User*> users() const;
Q_INVOKABLE QStringList memberNames() const;
Q_INVOKABLE int memberCount() const;
Q_INVOKABLE int timelineSize() const;
/**
* Returns a room avatar and requests it from the network if needed
* @return a pixmap with the avatar or a placeholder if there's none
* available yet
*/
Q_INVOKABLE QPixmap avatar(int width, int height);
/**
* @brief Produces a disambiguated name for a given user in
* the context of the room
*/
Q_INVOKABLE QString roomMembername(User* u) const;
/**
* @brief Produces a disambiguated name for a user with this id in
* the context of the room
*/
Q_INVOKABLE QString roomMembername(const QString& userId) const;
const Timeline& messageEvents() const;
/**
* A convenience method returning the read marker to the before-oldest
* message
*/
rev_iter_t timelineEdge() const;
Q_INVOKABLE TimelineItem::index_t minTimelineIndex() const;
Q_INVOKABLE TimelineItem::index_t maxTimelineIndex() const;
Q_INVOKABLE bool isValidIndex(TimelineItem::index_t timelineIndex) const;
rev_iter_t findInTimeline(TimelineItem::index_t index) const;
rev_iter_t findInTimeline(const QString& evtId) const;
rev_iter_t readMarker(const User* user) const;
rev_iter_t readMarker() const;
QString readMarkerEventId() const;
/**
* @brief Mark the event with uptoEventId as read
*
* Finds in the timeline and marks as read the event with
* the specified id; also posts a read receipt to the server either
* for this message or, if it's from the local user, for
* the nearest non-local message before. uptoEventId must be non-empty.
*/
void markMessagesAsRead(QString uptoEventId);
Q_INVOKABLE bool hasUnreadMessages();
Q_INVOKABLE int notificationCount() const;
Q_INVOKABLE void resetNotificationCount();
Q_INVOKABLE int highlightCount() const;
Q_INVOKABLE void resetHighlightCount();
MemberSorter memberSorter() const;
QJsonObject toJson() const;
void updateData(SyncRoomData&& data );
void setJoinState( JoinState state );
public slots:
void postMessage(const QString& plainText,
MessageEventType type = MessageEventType::Text);
void postMessage(const RoomMessageEvent& event);
/** @deprecated */
void postMessage(const QString& type, const QString& plainText);
void setTopic(const QString& newTopic);
void getPreviousContent(int limit = 10);
void inviteToRoom(const QString& memberId);
LeaveRoomJob* leaveRoom();
void kickMember(const QString& memberId, const QString& reason = {});
void ban(const QString& userId, const QString& reason = {});
void unban(const QString& userId);
/** Mark all messages in the room as read */
void markAllMessagesAsRead();
signals:
void aboutToAddHistoricalMessages(const RoomEvents& events);
void aboutToAddNewMessages(const RoomEvents& events);
void addedMessages();
/**
* @brief The room name, the canonical alias or other aliases changed
*
* Not triggered when displayname changes.
*/
void namesChanged(Room* room);
/** @brief The room displayname changed */
void displaynameChanged(Room* room);
void topicChanged();
void avatarChanged();
void userAdded(User* user);
void userRemoved(User* user);
void memberRenamed(User* user);
void joinStateChanged(JoinState oldState, JoinState newState);
void typingChanged();
void highlightCountChanged(Room* room);
void notificationCountChanged(Room* room);
void lastReadEventChanged(User* user);
void readMarkerMoved();
void unreadMessagesChanged(Room* room);
protected:
virtual void doAddNewMessageEvents(const RoomEvents& events);
virtual void doAddHistoricalMessageEvents(const RoomEvents& events);
virtual void processStateEvents(const RoomEvents& events);
virtual void processEphemeralEvent(Event* event);
private:
class Private;
Private* d;
void addNewMessageEvents(RoomEvents events);
void addHistoricalMessageEvents(RoomEvents events);
void markMessagesAsRead(rev_iter_t upToMarker);
};
class MemberSorter
{
public:
explicit MemberSorter(const Room* r) : room(r) { }
bool operator()(User* u1, User* u2) const;
template <typename ContT>
typename ContT::size_type lowerBoundIndex(const ContT& c,
typename ContT::value_type v) const
{
return std::lower_bound(c.begin(), c.end(), v, *this) - c.begin();
}
private:
const Room* room;
};
} // namespace QMatrixClient
|
