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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
|
/******************************************************************************
* 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
*/
#include "room.h"
#include <array>
#include <QtCore/QHash>
#include <QtCore/QJsonArray>
#include <QtCore/QStringBuilder> // for efficient string concats (operator%)
#include <QtCore/QDebug>
#include "connection.h"
#include "state.h"
#include "user.h"
#include "events/event.h"
#include "events/roommessageevent.h"
#include "events/roomnameevent.h"
#include "events/roomaliasesevent.h"
#include "events/roomcanonicalaliasevent.h"
#include "events/roomtopicevent.h"
#include "events/roommemberevent.h"
#include "events/typingevent.h"
#include "events/receiptevent.h"
#include "jobs/roommessagesjob.h"
using namespace QMatrixClient;
class Room::Private
{
public:
/** Map of user names to users. User names potentially duplicate, hence a multi-hashmap. */
typedef QMultiHash<QString, User*> members_map_t;
Private(Room* parent): q(parent) {}
Room* q;
//static LogMessage* parseMessage(const QJsonObject& message);
// This updates the room displayname field (which is the way a room
// should be shown in the room list) It should be called whenever the
// list of members or the room name (m.room.name) or canonical alias change.
void updateDisplayname();
Connection* connection;
QList<Event*> messageEvents;
QString id;
QStringList aliases;
QString canonicalAlias;
QString name;
QString displayname;
QString topic;
JoinState joinState;
int highlightCount;
int notificationCount;
members_map_t membersMap;
QList<User*> usersTyping;
QList<User*> membersLeft;
QHash<User*, QString> lastReadEvent;
QString prevBatch;
RoomMessagesJob* roomMessagesJob;
// Convenience methods to work with the membersMap and usersLeft.
// addMember() and removeMember() emit respective Room:: signals
// after a succesful operation.
//void inviteUser(User* u); // We might get it at some point in time.
void addMember(User* u);
bool hasMember(User* u) const;
// You can't identify a single user by displayname, only by id
User* member(QString id) const;
void renameMember(User* u, QString oldName);
void removeMember(User* u);
void getPreviousContent();
private:
QString calculateDisplayname() const;
QString roomNameFromMemberNames(const QList<User*>& userlist) const;
void insertMemberIntoMap(User* u);
void removeMemberFromMap(QString username, User* u);
};
Room::Room(Connection* connection, QString id)
: QObject(connection), d(new Private(this))
{
d->id = id;
d->connection = connection;
d->joinState = JoinState::Join;
d->roomMessagesJob = nullptr;
qDebug() << "New Room:" << id;
//connection->getMembers(this); // I don't think we need this anymore in r0.0.1
}
Room::~Room()
{
qDebug() << "deconstructing room" << id();
delete d;
}
QString Room::id() const
{
return d->id;
}
QList< Event* > Room::messageEvents() const
{
return d->messageEvents;
}
QString Room::name() const
{
return d->name;
}
QStringList Room::aliases() const
{
return d->aliases;
}
QString Room::canonicalAlias() const
{
return d->canonicalAlias;
}
QString Room::displayName() const
{
return d->displayname;
}
QString Room::topic() const
{
return d->topic;
}
JoinState Room::joinState() const
{
return d->joinState;
}
void Room::setJoinState(JoinState state)
{
JoinState oldState = d->joinState;
if( state == oldState )
return;
d->joinState = state;
emit joinStateChanged(oldState, state);
}
void Room::markMessageAsRead(Event* event)
{
d->connection->postReceipt(this, event);
}
QString Room::lastReadEvent(User* user)
{
return d->lastReadEvent.value(user);
}
int Room::notificationCount() const
{
return d->notificationCount;
}
void Room::resetNotificationCount()
{
if( d->notificationCount == 0 )
return;
d->notificationCount = 0;
emit notificationCountChanged(this);
}
int Room::highlightCount() const
{
return d->highlightCount;
}
void Room::resetHighlightCount()
{
if( d->highlightCount == 0 )
return;
d->highlightCount = 0;
emit highlightCountChanged(this);
}
QList< User* > Room::usersTyping() const
{
return d->usersTyping;
}
QList< User* > Room::membersLeft() const
{
return d->membersLeft;
}
QList< User* > Room::users() const
{
return d->membersMap.values();
}
void Room::Private::insertMemberIntoMap(User *u)
{
QList<User*> namesakes = membersMap.values(u->name());
membersMap.insert(u->name(), u);
// If there is exactly one namesake of the added user, signal member renaming
// for that other one because the two should be disambiguated now.
if (namesakes.size() == 1)
emit q->memberRenamed(namesakes[0]);
updateDisplayname();
}
void Room::Private::removeMemberFromMap(QString username, User* u)
{
membersMap.remove(username, u);
// If there was one namesake besides the removed user, signal member renaming
// for it because it doesn't need to be disambiguated anymore.
// TODO: Think about left users.
QList<User*> formerNamesakes = membersMap.values(username);
if (formerNamesakes.size() == 1)
emit q->memberRenamed(formerNamesakes[0]);
updateDisplayname();
}
void Room::Private::addMember(User *u)
{
if (!hasMember(u))
{
insertMemberIntoMap(u);
connect(u, &User::nameChanged, q, &Room::userRenamed);
emit q->userAdded(u);
}
}
bool Room::Private::hasMember(User* u) const
{
return membersMap.values(u->name()).contains(u);
}
User* Room::Private::member(QString id) const
{
User* u = connection->user(id);
return hasMember(u) ? u : nullptr;
}
void Room::Private::renameMember(User* u, QString oldName)
{
if (hasMember(u))
{
qWarning() << "Room::Private::renameMember(): the user "
<< u->name()
<< "is already known in the room under a new name.";
return;
}
if (membersMap.values(oldName).contains(u))
{
removeMemberFromMap(oldName, u);
insertMemberIntoMap(u);
emit q->memberRenamed(u);
updateDisplayname();
}
}
void Room::Private::removeMember(User* u)
{
if (hasMember(u))
{
if ( !membersLeft.contains(u) )
membersLeft.append(u);
removeMemberFromMap(u->name(), u);
emit q->userRemoved(u);
}
}
void Room::userRenamed(User* user, QString oldName)
{
d->renameMember(user, oldName);
}
QString Room::roomMembername(User *u) const
{
// See the CS spec, section 11.2.2.3
QString username = u->name();
if (username.isEmpty())
return u->id();
// Get the list of users with the same display name. Most likely,
// there'll be one, but there's a chance there are more.
auto namesakes = d->membersMap.values(username);
if (namesakes.size() == 1)
return username;
// We expect a user to be a member of the room - but technically it is
// possible to invoke roomMemberName() even for non-members. In such case
// we return the name _with_ id, to stay on a safe side.
if ( !namesakes.contains(u) )
{
qWarning()
<< "Room::roomMemberName(): user" << u->id()
<< "is not a member of the room" << id();
}
// In case of more than one namesake, disambiguate with user id.
return username % " <" % u->id() % ">";
}
QString Room::roomMembername(QString userId) const
{
return roomMembername(connection()->user(userId));
}
void Room::addMessage(Event* event)
{
processMessageEvent(event);
emit newMessage(event);
//d->addState(event);
}
void Room::addInitialState(State* state)
{
processStateEvent(state->event());
}
void Room::updateData(const SyncRoomData& data)
{
if( d->prevBatch.isEmpty() )
d->prevBatch = data.timelinePrevBatch;
setJoinState(data.joinState);
for( Event* stateEvent: data.state )
{
processStateEvent(stateEvent);
}
for( Event* timelineEvent: data.timeline )
{
processMessageEvent(timelineEvent);
emit newMessage(timelineEvent);
// State changes can arrive in a timeline event - try to check those.
processStateEvent(timelineEvent);
}
for( Event* ephemeralEvent: data.ephemeral )
{
processEphemeralEvent(ephemeralEvent);
}
if( data.highlightCount != d->highlightCount )
{
d->highlightCount = data.highlightCount;
emit highlightCountChanged(this);
}
if( data.notificationCount != d->notificationCount )
{
d->notificationCount = data.notificationCount;
emit notificationCountChanged(this);
}
}
void Room::getPreviousContent()
{
d->getPreviousContent();
}
void Room::Private::getPreviousContent()
{
if( !roomMessagesJob )
{
roomMessagesJob = connection->getMessages(q, prevBatch);
connect( roomMessagesJob, &RoomMessagesJob::result, [=]() {
if( !roomMessagesJob->error() )
{
for( Event* event: roomMessagesJob->events() )
{
q->processMessageEvent(event);
emit q->newMessage(event);
}
prevBatch = roomMessagesJob->end();
}
roomMessagesJob = nullptr;
});
}
}
Connection* Room::connection() const
{
return d->connection;
}
void Room::processMessageEvent(Event* event)
{
d->messageEvents.insert(findInsertionPos(d->messageEvents, event), event);
}
void Room::processStateEvent(Event* event)
{
if( event->type() == EventType::RoomName )
{
if (RoomNameEvent* nameEvent = static_cast<RoomNameEvent*>(event))
{
d->name = nameEvent->name();
qDebug() << "room name:" << d->name;
d->updateDisplayname();
emit namesChanged(this);
} else
{
qDebug() <<
"!!! event type is RoomName but the event is not RoomNameEvent";
}
}
if( event->type() == EventType::RoomAliases )
{
RoomAliasesEvent* aliasesEvent = static_cast<RoomAliasesEvent*>(event);
d->aliases = aliasesEvent->aliases();
qDebug() << "room aliases:" << d->aliases;
// No displayname update - aliases are not used to render a displayname
emit namesChanged(this);
}
if( event->type() == EventType::RoomCanonicalAlias )
{
RoomCanonicalAliasEvent* aliasEvent = static_cast<RoomCanonicalAliasEvent*>(event);
d->canonicalAlias = aliasEvent->alias();
qDebug() << "room canonical alias:" << d->canonicalAlias;
d->updateDisplayname();
emit namesChanged(this);
}
if( event->type() == EventType::RoomTopic )
{
RoomTopicEvent* topicEvent = static_cast<RoomTopicEvent*>(event);
d->topic = topicEvent->topic();
emit topicChanged();
}
if( event->type() == EventType::RoomMember )
{
RoomMemberEvent* memberEvent = static_cast<RoomMemberEvent*>(event);
User* u = d->connection->user(memberEvent->userId());
u->processEvent(event);
if( memberEvent->membership() == MembershipType::Join )
{
d->addMember(u);
}
else if( memberEvent->membership() == MembershipType::Leave )
{
d->removeMember(u);
}
}
}
void Room::processEphemeralEvent(Event* event)
{
if( event->type() == EventType::Typing )
{
TypingEvent* typingEvent = static_cast<TypingEvent*>(event);
d->usersTyping.clear();
for( const QString& user: typingEvent->users() )
{
d->usersTyping.append(d->connection->user(user));
}
emit typingChanged();
}
if( event->type() == EventType::Receipt )
{
auto receiptEvent = static_cast<ReceiptEvent*>(event);
for( QString eventId: receiptEvent->events() )
{
const auto receipts = receiptEvent->receiptsForEvent(eventId);
for( const Receipt r: receipts )
{
d->lastReadEvent.insert(d->connection->user(r.userId), eventId);
}
}
}
}
QString Room::Private::roomNameFromMemberNames(const QList<User *> &userlist) const
{
// This is part 3(i,ii,iii) in the room displayname algorithm described
// in the CS spec (see also Room::Private::updateDisplayname() ).
// The spec requires to sort users lexicographically by state_key (user id)
// and use disambiguated display names of two topmost users excluding
// the current one to render the name of the room.
// std::array is the leanest C++ container
std::array<User*, 2> first_two = { {nullptr, nullptr} };
std::partial_sort_copy(
userlist.begin(), userlist.end(),
first_two.begin(), first_two.end(),
[this](const User* u1, const User* u2) {
// Filter out the "me" user so that it never hits the room name
return u1 != connection->user() && u1->id() < u2->id();
}
);
// i. One-on-one chat. first_two[1] == connection->user() in this case.
if (userlist.size() == 2)
return q->roomMembername(first_two[0]);
// ii. Two users besides the current one.
if (userlist.size() == 3)
return tr("%1 and %2")
.arg(q->roomMembername(first_two[0]))
.arg(q->roomMembername(first_two[1]));
// iii. More users.
if (userlist.size() > 3)
return tr("%1 and %L2 others")
.arg(q->roomMembername(first_two[0]))
.arg(userlist.size() - 3);
// userlist.size() < 2 - apparently, there's only current user in the room
return QString();
}
QString Room::Private::calculateDisplayname() const
{
// CS spec, section 11.2.2.5 Calculating the display name for a room
// Numbers below refer to respective parts in the spec.
// 1. Name (from m.room.name)
if (!name.isEmpty()) {
// The below two lines extend the spec. They take care of the case
// when there are two rooms with the same name.
// The format is unwittingly borrowed from the email address format.
if (!canonicalAlias.isEmpty())
return name % " <" % canonicalAlias % ">";
return name;
}
// 2. Canonical alias
if (!canonicalAlias.isEmpty())
return canonicalAlias;
// 3. Room members
QString topMemberNames = roomNameFromMemberNames(membersMap.values());
if (!topMemberNames.isEmpty())
return topMemberNames;
// 4. Users that previously left the room
topMemberNames = roomNameFromMemberNames(membersLeft);
if (!topMemberNames.isEmpty())
return tr("Empty room (was: %1)").arg(topMemberNames);
// 5. Fail miserably
return tr("Empty room (%1)").arg(id);
// Using m.room.aliases is explicitly discouraged by the spec
//if (!aliases.empty() && !aliases.at(0).isEmpty())
// displayname = aliases.at(0);
}
void Room::Private::updateDisplayname()
{
const QString old_name = displayname;
displayname = calculateDisplayname();
if (old_name != displayname)
emit q->displaynameChanged(q);
}
// void Room::setAlias(QString alias)
// {
// d->alias = alias;
// emit aliasChanged(this);
// }
//
// bool Room::parseEvents(const QJsonObject& json)
// {
// QList<LogMessage*> newMessages;
// QJsonValue value = json.value("messages").toObject().value("chunk");
// if( !value.isArray() )
// {
// return false;
// }
// QJsonArray messages = value.toArray();
// for(const QJsonValue& val: messages )
// {
// if( !val.isObject() )
// continue;
// LogMessage* msg = Private::parseMessage(val.toObject());
// if( msg )
// {
// newMessages.append(msg);
// }
//
// }
// addMessages(newMessages);
// return true;
// }
//
// bool Room::parseSingleEvent(const QJsonObject& json)
// {
// qDebug() << "parseSingleEvent";
// LogMessage* msg = Private::parseMessage(json);
// if( msg )
// {
// addMessage(msg);
// return true;
// }
// return false;
// }
//
// bool Room::parseState(const QJsonObject& json)
// {
// QJsonValue value = json.value("state");
// if( !value.isArray() )
// {
// return false;
// }
// QJsonArray states = value.toArray();
// for( const QJsonValue& val: states )
// {
// QJsonObject state = val.toObject();
// QString type = state.value("type").toString();
// if( type == "m.room.aliases" )
// {
// QJsonArray aliases = state.value("content").toObject().value("aliases").toArray();
// if( aliases.count() > 0 )
// {
// setAlias(aliases.at(0).toString());
// }
// }
// }
// return true;
// }
//
// LogMessage* Room::Private::parseMessage(const QJsonObject& message)
// {
// if( message.value("type") == "m.room.message" )
// {
// QJsonObject content = message.value("content").toObject();
// if( content.value("msgtype").toString() != "m.text" )
// return 0;
// QString user = message.value("user_id").toString();
// QString body = content.value("body").toString();
// LogMessage* msg = new LogMessage( LogMessage::UserMessage, body, user );
// return msg;
// }
// return 0;
// }
|