/******************************************************************************
* 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 "avatar.h"
#include "connection.h"
#include "converters.h"
#include "e2ee.h"
#include "syncdata.h"
#include "user.h"
#include "csapi/account-data.h"
#include "csapi/banning.h"
#include "csapi/inviting.h"
#include "csapi/kicking.h"
#include "csapi/leaving.h"
#include "csapi/receipts.h"
#include "csapi/redaction.h"
#include "csapi/room_send.h"
#include "csapi/room_state.h"
#include "csapi/room_upgrades.h"
#include "csapi/rooms.h"
#include "csapi/tags.h"
#include "events/callanswerevent.h"
#include "events/callcandidatesevent.h"
#include "events/callhangupevent.h"
#include "events/callinviteevent.h"
#include "events/encryptionevent.h"
#include "events/reactionevent.h"
#include "events/receiptevent.h"
#include "events/redactionevent.h"
#include "events/roomavatarevent.h"
#include "events/roomcreateevent.h"
#include "events/roommemberevent.h"
#include "events/roomtombstoneevent.h"
#include "events/simplestateevents.h"
#include "events/typingevent.h"
#include "jobs/downloadfilejob.h"
#include "jobs/mediathumbnailjob.h"
#include "jobs/postreadmarkersjob.h"
#include <QtCore/QDir>
#include <QtCore/QHash>
#include <QtCore/QMimeDatabase>
#include <QtCore/QPointer>
#include <QtCore/QRegularExpression>
#include <QtCore/QStringBuilder> // for efficient string concats (operator%)
#include <QtCore/QTemporaryFile>
#include <array>
#include <cmath>
#include <functional>
#include <groupsession.h> // QtOlm
#include <message.h> // QtOlm
#include <session.h> // QtOlm
using namespace QMatrixClient;
using namespace std::placeholders;
using std::move;
#if !(defined __GLIBCXX__ && __GLIBCXX__ <= 20150123)
using std::llround;
#endif
enum EventsPlacement : int { Older = -1, Newer = 1 };
class Room::Private {
public:
/// Map of user names to users
/** User names potentially duplicate, hence QMultiHash. */
using members_map_t = QMultiHash<QString, User*>;
Private(Connection* c, QString id_, JoinState initialJoinState)
: q(nullptr), connection(c), id(move(id_)), joinState(initialJoinState)
{}
Room* q;
Connection* connection;
QString id;
JoinState joinState;
RoomSummary summary = { none, 0, none };
/// The state of the room at timeline position before-0
/// \sa timelineBase
std::unordered_map<StateEventKey, StateEventPtr> baseState;
/// State event stubs - events without content, just type and state key
static decltype(baseState) stubbedState;
/// The state of the room at timeline position after-maxTimelineIndex()
/// \sa Room::syncEdge
QHash<StateEventKey, const StateEventBase*> currentState;
/// Servers with aliases for this room except the one of the local user
/// \sa Room::remoteAliases
QSet<QString> aliasServers;
Timeline timeline;
PendingEvents unsyncedEvents;
QHash<QString, TimelineItem::index_t> eventsIndex;
// A map from evtId to a map of relation type to a vector of event
// pointers. Not using QMultiHash, because we want to quickly return
// a number of relations for a given event without enumerating them.
QHash<QPair<QString, QString>, RelatedEvents> relations;
QString displayname;
Avatar avatar;
int highlightCount = 0;
int notificationCount = 0;
members_map_t membersMap;
QList<User*> usersTyping;
QMultiHash<QString, User*> eventIdReadUsers;
QList<User*> usersInvited;
QList<User*> membersLeft;
int unreadMessages = 0;
bool displayed = false;
QString firstDisplayedEventId;
QString lastDisplayedEventId;
QHash<const User*, QString> lastReadEventIds;
QString serverReadMarker;
TagsMap tags;
std::unordered_map<QString, EventPtr> accountData;
QString prevBatch;
QPointer<GetRoomEventsJob> eventsHistoryJob;
QPointer<GetMembersByRoomJob> allMembersJob;
struct FileTransferPrivateInfo {
FileTransferPrivateInfo() = default;
FileTransferPrivateInfo(BaseJob* j, const QString& fileName,
bool isUploading = false)
: status(FileTransferInfo::Started)
, job(j)
, localFileInfo(fileName)
, isUpload(isUploading)
{}
FileTransferInfo::Status status = FileTransferInfo::None;
QPointer<BaseJob> job = nullptr;
QFileInfo localFileInfo {};
bool isUpload = false;
qint64 progress = 0;
qint64 total = -1;
void update(qint64 p, qint64 t)
{
if (t == 0) {
t = -1;
if (p == 0)
p = -1;
}
if (p != -1)
qCDebug(PROFILER) << "Transfer progress:" << p << "/" << t
<< "=" << llround(double(p) / t * 100) << "%";
progress = p;
total = t;
}
};
void failedTransfer(const QString& tid, const QString& errorMessage = {})
{
qCWarning(MAIN) << "File transfer failed for id" << tid;
if (!errorMessage.isEmpty())
qCWarning(MAIN) << "Message:" << errorMessage;
fileTransfers[tid].status = FileTransferInfo::Failed;
emit q->fileTransferFailed(tid, errorMessage);
}
/// A map from event/txn ids to information about the long operation;
/// used for both download and upload operations
QHash<QString, FileTransferPrivateInfo> fileTransfers;
const RoomMessageEvent* getEventWithFile(const QString& eventId) const;
QString fileNameToDownload(const RoomMessageEvent* event) const;
Changes setSummary(RoomSummary&& newSummary);
// void inviteUser(User* u); // We might get it at some point in time.
void insertMemberIntoMap(User* u);
void renameMember(User* u, const QString& oldName);
void removeMemberFromMap(const QString& username, User* u);
// This updates the room displayname field (which is the way a room
// should be shown in the room list); called whenever the list of
// members, the room name (m.room.name) or canonical alias change.
void updateDisplayname();
// This is used by updateDisplayname() but only calculates the new name
// without any updates.
QString calculateDisplayname() const;
/// A point in the timeline corresponding to baseState
rev_iter_t timelineBase() const { return q->findInTimeline(-1); }
void getPreviousContent(int limit = 10);
template <typename EventT>
const EventT* getCurrentState(const QString& stateKey = {}) const
{
const StateEventKey evtKey { EventT::matrixTypeId(), stateKey };
const auto* evt = currentState.value(evtKey, nullptr);
if (!evt) {
if (stubbedState.find(evtKey) == stubbedState.end()) {
// In the absence of a real event, make a stub as-if an event
// with empty content has been received. Event classes should be
// prepared for empty/invalid/malicious content anyway.
stubbedState.emplace(evtKey,
loadStateEvent(EventT::matrixTypeId(), {},
stateKey));
qCDebug(MAIN) << "A new stub event created for key {"
<< evtKey.first << evtKey.second << "}";
}
evt = stubbedState[evtKey].get();
Q_ASSERT(evt);
}
Q_ASSERT(evt->type() == EventT::typeId()
&& evt->matrixType() == EventT::matrixTypeId());
return static_cast<const EventT*>(evt);
}
bool isEventNotable(const TimelineItem& ti) const
{
return !ti->isRedacted() && ti->senderId() != connection->userId()
&& is<RoomMessageEvent>(*ti);
}
template <typename EventArrayT>
Changes updateStateFrom(EventArrayT&& events)
{
Changes changes = NoChange;
if (!events.empty()) {
QElapsedTimer et;
et.start();
for (auto&& eptr : events) {
const auto& evt = *eptr;
Q_ASSERT(evt.isStateEvent());
// Update baseState afterwards to make sure that the old state
// is valid and usable inside processStateEvent
changes |= q->processStateEvent(evt);
baseState[{ evt.matrixType(), evt.stateKey() }] = move(eptr);
}
if (events.size() > 9 || et.nsecsElapsed() >= profilerMinNsecs())
qCDebug(PROFILER)
<< "*** Room::Private::updateStateFrom():" << events.size()
<< "event(s)," << et;
}
return changes;
}
Changes addNewMessageEvents(RoomEvents&& events);
void addHistoricalMessageEvents(RoomEvents&& events);
/** Move events into the timeline
*
* Insert events into the timeline, either new or historical.
* Pointers in the original container become empty, the ownership
* is passed to the timeline container.
* @param events - the range of events to be inserted
* @param placement - position and direction of insertion: Older for
* historical messages, Newer for new ones
*/
Timeline::size_type moveEventsToTimeline(RoomEventsRange events,
EventsPlacement placement);
/**
* Remove events from the passed container that are already in the timeline
*/
void dropDuplicateEvents(RoomEvents& events) const;
Changes setLastReadEvent(User* u, QString eventId);
void updateUnreadCount(rev_iter_t from, rev_iter_t to);
Changes promoteReadMarker(User* u, rev_iter_t newMarker, bool force = false);
Changes markMessagesAsRead(rev_iter_t upToMarker);
void getAllMembers();
QString sendEvent(RoomEventPtr&& event);
template <typename EventT, typename... ArgTs>
QString sendEvent(ArgTs&&... eventArgs)
{
return sendEvent(makeEvent<EventT>(std::forward<ArgTs>(eventArgs)...));
}
RoomEvent* addAsPending(RoomEventPtr&& event);
QString doSendEvent(const RoomEvent* pEvent);
void onEventSendingFailure(const QString& txnId, BaseJob* call = nullptr);
SetRoomStateWithKeyJob* requestSetState(const StateEventBase& event)
{
// if (event.roomId().isEmpty())
// event.setRoomId(id);
// if (event.senderId().isEmpty())
// event.setSender(connection->userId());
// TODO: Queue up state events sending (see #133).
// TODO: Maybe addAsPending() as well, despite having no txnId
return connection->callApi<SetRoomStateWithKeyJob>(
id, event.matrixType(), event.stateKey(), event.contentJson());
}
template <typename EvT, typename... ArgTs>
auto requestSetState(ArgTs&&... args)
{
return requestSetState(EvT(std::forward<ArgTs>(args)...));
}
/*! Apply redaction to the timeline
*
* Tries to find an event in the timeline and redact it; deletes the
* redaction event whether the redacted event was found or not.
* \return true if the event has been found and redacted; false otherwise
*/
bool processRedaction(const RedactionEvent& redaction);
/*! Apply a new revision of the event to the timeline
*
* Tries to find an event in the timeline and replace it with the new
* content passed in \p newMessage.
* \return true if the event has been found and replaced; false otherwise
*/
bool processReplacement(const RoomMessageEvent& newMessage);
void setTags(TagsMap newTags);
QJsonObject toJson() const;
private:
using users_shortlist_t = std::array<User*, 3>;
template <typename ContT>
users_shortlist_t buildShortlist(const ContT& users) const;
users_shortlist_t buildShortlist(const QStringList& userIds) const;
bool isLocalUser(const User* u) const { return u == q->localUser(); }
};
decltype(Room::Private::baseState) Room::Private::stubbedState {};
Room::Room(Connection* connection, QString id, JoinState initialJoinState)
: QObject(connection), d(new Private(connection, id, initialJoinState))
{
setObjectName(id);
// See "Accessing the Public Class" section in
// https://marcmutz.wordpress.com/translated-articles/pimp-my-pimpl-%E2%80%94-reloaded/
d->q = this;
d->displayname = d->calculateDisplayname(); // Set initial "Empty room" name
connectUntil(connection, &Connection::loadedRoomState, this, [this](Room* r) {
if (this == r)
emit baseStateLoaded();
return this == r; // loadedRoomState fires only once per room
});
qCDebug(MAIN) << "New" << toCString(initialJoinState) << "Room:" << id;
}
Room::~Room() { delete d; }
const QString& Room::id() const { return d->id; }
QString Room::version() const
{
const auto v = d->getCurrentState<RoomCreateEvent>()->version();
return v.isEmpty() ? QStringLiteral("1") : v;
}
bool Room::isUnstable() const
{
return !connection()->loadingCapabilities()
&& !connection()->stableRoomVersions().contains(version());
}
QString Room::predecessorId() const
{
return d->getCurrentState<RoomCreateEvent>()->predecessor().roomId;
}
QString Room::successorId() const
{
return d->getCurrentState<RoomTombstoneEvent>()->successorRoomId();
}
const Room::Timeline& Room::messageEvents() const { return d->timeline; }
const Room::PendingEvents& Room::pendingEvents() const
{
return d->unsyncedEvents;
}
bool Room::allHistoryLoaded() const
{
return !d->timeline.empty() && is<RoomCreateEvent>(*d->timeline.front());
}
QString Room::name() const
{
return d->getCurrentState<RoomNameEvent>()->name();
}
QStringList Room::localAliases() const
{
return d
->getCurrentState<RoomAliasesEvent>(
connection()->homeserver().authority())
->aliases();
}
QStringList Room::remoteAliases() const
{
QStringList result;
for (const auto& s : d->aliasServers)
result += d->getCurrentState<RoomAliasesEvent>(s)->aliases();
return result;
}
QString Room::canonicalAlias() const
{
return d->getCurrentState<RoomCanonicalAliasEvent>()->alias();
}
QString Room::displayName() const { return d->displayname; }
void Room::refreshDisplayName() { d->updateDisplayname(); }
QString Room::topic() const
{
return d->getCurrentState<RoomTopicEvent>()->topic();
}
QString Room::avatarMediaId() const { return d->avatar.mediaId(); }
QUrl Room::avatarUrl() const { return d->avatar.url(); }
const Avatar& Room::avatarObject() const { return d->avatar; }
QImage Room::avatar(int dimension) { return avatar(dimension, dimension); }
QImage Room::avatar(int width, int height)
{
if (!d->avatar.url().isEmpty())
return d->avatar.get(connection(), width, height,
[=] { emit avatarChanged(); });
// Use the first (excluding self) user's avatar for direct chats
const auto dcUsers = directChatUsers();
for (auto* u : dcUsers)
if (u != localUser())
return u->avatar(width, height, this, [=] { emit avatarChanged(); });
return {};
}
User* Room::user(const QString& userId) const
{
return connection()->user(userId);
}
JoinState Room::memberJoinState(User* user) const
{
return d->membersMap.contains(user->name(this), user) ? JoinState::Join
: JoinState::Leave;
}
JoinState Room::joinState() const { return d->joinState; }
void Room::setJoinState(JoinState state)
{
JoinState oldState = d->joinState;
if (state == oldState)
return;
d->joinState = state;
qCDebug(MAIN) << "Room" << id() << "changed state: " << int(oldState)
<< "->" << int(state);
emit changed(Change::JoinStateChange);
emit joinStateChanged(oldState, state);
}
Room::Changes Room::Private::setLastReadEvent(User* u, QString eventId)
{
auto& storedId = lastReadEventIds[u];
if (storedId == eventId)
return Change::NoChange;
eventIdReadUsers.remove(storedId, u);
eventIdReadUsers.insert(eventId, u);
swap(storedId, eventId);
emit q->lastReadEventChanged(u);
emit q->readMarkerForUserMoved(u, eventId, storedId);
if (isLocalUser(u)) {
if (storedId != serverReadMarker)
connection->callApi<PostReadMarkersJob>(id, storedId);
emit q->readMarkerMoved(eventId, storedId);
return Change::ReadMarkerChange;
}
return Change::NoChange;
}
void Room::Private::updateUnreadCount(rev_iter_t from, rev_iter_t to)
{
Q_ASSERT(from >= timeline.crbegin() && from <= timeline.crend());
Q_ASSERT(to >= from && to <= timeline.crend());
// Catch a special case when the last read event id refers to an event
// that has just arrived. In this case we should recalculate
// unreadMessages and might need to promote the read marker further
// over local-origin messages.
const auto readMarker = q->readMarker();
if (readMarker >= from && readMarker < to) {
promoteReadMarker(q->localUser(), readMarker, true);
return;
}
Q_ASSERT(to <= readMarker);
QElapsedTimer et;
et.start();
const auto newUnreadMessages =
count_if(from, to, std::bind(&Room::Private::isEventNotable, this, _1));
if (et.nsecsElapsed() > profilerMinNsecs() / 10)
qCDebug(PROFILER) << "Counting gained unread messages took" << et;
if (newUnreadMessages > 0) {
// See https://github.com/quotient-im/libQuotient/wiki/unread_count
if (unreadMessages < 0)
unreadMessages = 0;
unreadMessages += newUnreadMessages;
qCDebug(MAIN) << "Room" << q->objectName() << "has gained"
<< newUnreadMessages << "unread message(s),"
<< (q->readMarker() == timeline.crend()
? "in total at least"
: "in total")
<< unreadMessages << "unread message(s)";
emit q->unreadMessagesChanged(q);
}
}
Room::Changes Room::Private::promoteReadMarker(User* u, rev_iter_t newMarker,
bool force)
{
Q_ASSERT_X(u, __FUNCTION__, "User* should not be nullptr");
Q_ASSERT(newMarker >= timeline.crbegin() && newMarker <= timeline.crend());
const auto prevMarker = q->readMarker(u);
if (!force && prevMarker <= newMarker) // Remember, we deal with reverse
// iterators
return Change::NoChange;
Q_ASSERT(newMarker < timeline.crend());
// Try to auto-promote the read marker over the user's own messages
// (switch to direct iterators for that).
auto eagerMarker = find_if(newMarker.base(), timeline.cend(),
[=](const TimelineItem& ti) {
return ti->senderId() != u->id();
});
auto changes = setLastReadEvent(u, (*(eagerMarker - 1))->id());
if (isLocalUser(u)) {
const auto oldUnreadCount = unreadMessages;
QElapsedTimer et;
et.start();
unreadMessages =
int(count_if(eagerMarker, timeline.cend(),
std::bind(&Room::Private::isEventNotable, this, _1)));
if (et.nsecsElapsed() > profilerMinNsecs() / 10)
qCDebug(PROFILER) << "Recounting unread messages took" << et;
// See https://github.com/quotient-im/libQuotient/wiki/unread_count
if (unreadMessages == 0)
unreadMessages = -1;
if (force || unreadMessages != oldUnreadCount) {
if (unreadMessages == -1) {
qCDebug(MAIN)
<< "Room" << displayname << "has no more unread messages";
} else
qCDebug(MAIN) << "Room" << displayname << "still has"
<< unreadMessages << "unread message(s)";
emit q->unreadMessagesChanged(q);
changes |= Change::UnreadNotifsChange;
}
}
return changes;
}
Room::Changes Room::Private::markMessagesAsRead(rev_iter_t upToMarker)
{
const auto prevMarker = q->readMarker();
auto changes = promoteReadMarker(q->localUser(), upToMarker);
if (prevMarker != upToMarker)
qCDebug(MAIN) << "Marked messages as read until" << *q->readMarker();
// We shouldn't send read receipts for the local user's own messages - so
// search earlier messages for the latest message not from the local user
// until the previous last-read message, whichever comes first.
for (; upToMarker < prevMarker; ++upToMarker) {
if ((*upToMarker)->senderId() != q->localUser()->id()) {
connection->callApi<PostReceiptJob>(id, QStringLiteral("m.read"),
QUrl::toPercentEncoding(
(*upToMarker)->id()));
break;
}
}
return changes;
}
void Room::markMessagesAsRead(QString uptoEventId)
{
d->markMessagesAsRead(findInTimeline(uptoEventId));
}
void Room::markAllMessagesAsRead()
{
if (!d->timeline.empty())
d->markMessagesAsRead(d->timeline.crbegin());
}
bool Room::canSwitchVersions() const
{
if (!successorId().isEmpty())
return false; // No one can upgrade a room that's already upgraded
// TODO, #276: m.room.power_levels
const auto* plEvt =
d->currentState.value({ QStringLiteral("m.room.power_levels"), {} });
if (!plEvt)
return true;
const auto plJson = plEvt->contentJson();
const auto currentUserLevel =
plJson.value("users"_ls)
.toObject()
.value(localUser()->id())
.toInt(plJson.value("users_default"_ls).toInt());
const auto tombstonePowerLevel =
plJson.value("events"_ls)
.toObject()
.value("m.room.tombstone"_ls)
.toInt(plJson.value("state_default"_ls).toInt());
return currentUserLevel >= tombstonePowerLevel;
}
bool Room::hasUnreadMessages() const { return unreadCount() >= 0; }
int Room::unreadCount() const { return d->unreadMessages; }
Room::rev_iter_t Room::historyEdge() const { return d->timeline.crend(); }
Room::Timeline::const_iterator Room::syncEdge() const
{
return d->timeline.cend();
}
Room::rev_iter_t Room::timelineEdge() const { return historyEdge(); }
TimelineItem::index_t Room::minTimelineIndex() const
{
return d->timeline.empty() ? 0 : d->timeline.front().index();
}
TimelineItem::index_t Room::maxTimelineIndex() const
{
return d->timeline.empty() ? 0 : d->timeline.back().index();
}
bool Room::isValidIndex(TimelineItem::index_t timelineIndex) const
{
return !d->timeline.empty() && timelineIndex >= minTimelineIndex()
&& timelineIndex <= maxTimelineIndex();
}
Room::rev_iter_t Room::findInTimeline(TimelineItem::index_t index) const
{
return timelineEdge()
- (isValidIndex(index) ? index - minTimelineIndex() + 1 : 0);
}
Room::rev_iter_t Room::findInTimeline(const QString& evtId) const
{
if (!d->timeline.empty() && d->eventsIndex.contains(evtId)) {
auto it = findInTimeline(d->eventsIndex.value(evtId));
Q_ASSERT(it != historyEdge() && (*it)->id() == evtId);
return it;
}
return historyEdge();
}
Room::PendingEvents::iterator Room::findPendingEvent(const QString& txnId)
{
return std::find_if(d->unsyncedEvents.begin(), d->unsyncedEvents.end(),
[txnId](const auto& item) {
return item->transactionId() == txnId;
});
}
Room::PendingEvents::const_iterator
Room::findPendingEvent(const QString& txnId) const
{
return std::find_if(d->unsyncedEvents.cbegin(), d->unsyncedEvents.cend(),
[txnId](const auto& item) {
return item->transactionId() == txnId;
});
}
const Room::RelatedEvents Room::relatedEvents(const QString& evtId,
const char* relType) const
{
return d->relations.value({ evtId, relType });
}
const Room::RelatedEvents Room::relatedEvents(const RoomEvent& evt,
const char* relType) const
{
return relatedEvents(evt.id(), relType);
}
void Room::Private::getAllMembers()
{
// If already loaded or already loading, there's nothing to do here.
if (q->joinedCount() <= membersMap.size() || isJobRunning(allMembersJob))
return;
allMembersJob = connection->callApi<GetMembersByRoomJob>(
id, connection->nextBatchToken(), "join");
auto nextIndex = timeline.empty() ? 0 : timeline.back().index() + 1;
connect(allMembersJob, &BaseJob::success, q, [=] {
Q_ASSERT(timeline.empty() || nextIndex <= q->maxTimelineIndex() + 1);
auto roomChanges = updateStateFrom(allMembersJob->chunk());
// Replay member events that arrived after the point for which
// the full members list was requested.
if (!timeline.empty())
for (auto it = q->findInTimeline(nextIndex).base();
it != timeline.cend(); ++it)
if (is<RoomMemberEvent>(**it))
roomChanges |= q->processStateEvent(**it);
if (roomChanges & MembersChange)
emit q->memberListChanged();
emit q->allMembersLoaded();
});
}
bool Room::displayed() const { return d->displayed; }
void Room::setDisplayed(bool displayed)
{
if (d->displayed == displayed)
return;
d->displayed = displayed;
emit displayedChanged(displayed);
if (displayed) {
resetHighlightCount();
resetNotificationCount();
d->getAllMembers();
}
}
QString Room::firstDisplayedEventId() const { return d->firstDisplayedEventId; }
Room::rev_iter_t Room::firstDisplayedMarker() const
{
return findInTimeline(firstDisplayedEventId());
}
void Room::setFirstDisplayedEventId(const QString& eventId)
{
if (d->firstDisplayedEventId == eventId)
return;
d->firstDisplayedEventId = eventId;
emit firstDisplayedEventChanged();
}
void Room::setFirstDisplayedEvent(TimelineItem::index_t index)
{
Q_ASSERT(isValidIndex(index));
setFirstDisplayedEventId(findInTimeline(index)->event()->id());
}
QString Room::lastDisplayedEventId() const { return d->lastDisplayedEventId; }
Room::rev_iter_t Room::lastDisplayedMarker() const
{
return findInTimeline(lastDisplayedEventId());
}
void Room::setLastDisplayedEventId(const QString& eventId)
{
if (d->lastDisplayedEventId == eventId)
return;
d->lastDisplayedEventId = eventId;
emit lastDisplayedEventChanged();
}
void Room::setLastDisplayedEvent(TimelineItem::index_t index)
{
Q_ASSERT(isValidIndex(index));
setLastDisplayedEventId(findInTimeline(index)->event()->id());
}
Room::rev_iter_t Room::readMarker(const User* user) const
{
Q_ASSERT(user);
return findInTimeline(d->lastReadEventIds.value(user));
}
Room::rev_iter_t Room::readMarker() const { return readMarker(localUser()); }
QString Room::readMarkerEventId() const
{
return d->lastReadEventIds.value(localUser());
}
QList<User*> Room::usersAtEventId(const QString& eventId)
{
return d->eventIdReadUsers.values(eventId);
}
int Room::notificationCount() const { return d->notificationCount; }
void Room::resetNotificationCount()
{
if (d->notificationCount == 0)
return;
d->notificationCount = 0;
emit notificationCountChanged();
}
int Room::highlightCount() const { return d->highlightCount; }
void Room::resetHighlightCount()
{
if (d->highlightCount == 0)
return;
d->highlightCount = 0;
emit highlightCountChanged();
}
void Room::switchVersion(QString newVersion)
{
if (!successorId().isEmpty()) {
Q_ASSERT(!successorId().isEmpty());
emit upgradeFailed(tr("The room is already upgraded"));
}
if (auto* job = connection()->callApi<UpgradeRoomJob>(id(), newVersion))
connect(job, &BaseJob::failure, this,
[this, job] { emit upgradeFailed(job->errorString()); });
else
emit upgradeFailed(tr("Couldn't initiate upgrade"));
}
bool Room::hasAccountData(const QString& type) const
{
return d->accountData.find(type) != d->accountData.end();
}
const EventPtr& Room::accountData(const QString& type) const
{
static EventPtr NoEventPtr {};
const auto it = d->accountData.find(type);
return it != d->accountData.end() ? it->second : NoEventPtr;
}
QStringList Room::tagNames() const { return d->tags.keys(); }
TagsMap Room::tags() const { return d->tags; }
TagRecord Room::tag(const QString& name) const { return d->tags.value(name); }
std::pair<bool, QString> validatedTag(QString name)
{
if (name.contains('.'))
return { false, name };
qWarning(MAIN) << "The tag" << name
<< "doesn't follow the CS API conventions";
name.prepend("u.");
qWarning(MAIN) << "Using " << name << "instead";
return { true, name };
}
void Room::addTag(const QString& name, const TagRecord& record)
{
const auto& checkRes = validatedTag(name);
if (d->tags.contains(name)
|| (checkRes.first && d->tags.contains(checkRes.second)))
return;
emit tagsAboutToChange();
d->tags.insert(checkRes.second, record);
emit tagsChanged();
connection()->callApi<SetRoomTagJob>(localUser()->id(), id(),
checkRes.second, record.order);
}
void Room::addTag(const QString& name, float order)
{
addTag(name, TagRecord { order });
}
void Room::removeTag(const QString& name)
{
if (d->tags.contains(name)) {
emit tagsAboutToChange();
d->tags.remove(name);
emit tagsChanged();
connection()->callApi<DeleteRoomTagJob>(localUser()->id(), id(), name);
} else if (!name.startsWith("u."))
removeTag("u." + name);
else
qWarning(MAIN) << "Tag" << name << "on room" << objectName()
<< "not found, nothing to remove";
}
void Room::setTags(TagsMap newTags)
{
d->setTags(move(newTags));
connection()->callApi<SetAccountDataPerRoomJob>(
localUser()->id(), id(), TagEvent::matrixTypeId(),
TagEvent(d->tags).contentJson());
}
void Room::Private::setTags(TagsMap newTags)
{
emit q->tagsAboutToChange();
const auto keys = newTags.keys();
for (const auto& k : keys) {
const auto& checkRes = validatedTag(k);
if (checkRes.first) {
if (newTags.contains(checkRes.second))
newTags.remove(k);
else
newTags.insert(checkRes.second, newTags.take(k));
}
}
tags = move(newTags);
qCDebug(MAIN) << "Room" << q->objectName() << "is tagged with"
<< q->tagNames().join(QStringLiteral(", "));
emit q->tagsChanged();
}
bool Room::isFavourite() const { return d->tags.contains(FavouriteTag); }
bool Room::isLowPriority() const { return d->tags.contains(LowPriorityTag); }
bool Room::isDirectChat() const { return connection()->isDirectChat(id()); }
QList<User*> Room::directChatUsers() const
{
return connection()->directChatUsers(this);
}
const RoomMessageEvent*
Room::Private::getEventWithFile(const QString& eventId) const
{
auto evtIt = q->findInTimeline(eventId);
if (evtIt != timeline.rend() && is<RoomMessageEvent>(**evtIt)) {
auto* event = evtIt->viewAs<RoomMessageEvent>();
if (event->hasFileContent())
return event;
}
qWarning() << "No files to download in event" << eventId;
return nullptr;
}
QString Room::Private::fileNameToDownload(const RoomMessageEvent* event) const
{
Q_ASSERT(event->hasFileContent());
const auto* fileInfo = event->content()->fileInfo();
QString fileName;
if (!fileInfo->originalName.isEmpty()) {
fileName = QFileInfo(fileInfo->originalName).fileName();
} else if (!event->plainBody().isEmpty()) {
// Having no better options, assume that the body has
// the original file URL or at least the file name.
QUrl u { event->plainBody() };
if (u.isValid())
fileName = QFileInfo(u.path()).fileName();
}
// Check the file name for sanity
if (fileName.isEmpty() || !QTemporaryFile(fileName).open())
return "file." % fileInfo->mimeType.preferredSuffix();
if (QSysInfo::productType() == "windows") {
const auto& suffixes = fileInfo->mimeType.suffixes();
if (!suffixes.isEmpty()
&& std::none_of(suffixes.begin(), suffixes.end(),
[&fileName](const QString& s) {
return fileName.endsWith(s);
}))
return fileName % '.' % fileInfo->mimeType.preferredSuffix();
}
return fileName;
}
QUrl Room::urlToThumbnail(const QString& eventId) const
{
if (auto* event = d->getEventWithFile(eventId))
if (event->hasThumbnail()) {
auto* thumbnail = event->content()->thumbnailInfo();
Q_ASSERT(thumbnail != nullptr);
return MediaThumbnailJob::makeRequestUrl(connection()->homeserver(),
thumbnail->url,
thumbnail->imageSize);
}
qDebug() << "Event" << eventId << "has no thumbnail";
return {};
}
QUrl Room::urlToDownload(const QString& eventId) const
{
if (auto* event = d->getEventWithFile(eventId)) {
auto* fileInfo = event->content()->fileInfo();
Q_ASSERT(fileInfo != nullptr);
return DownloadFileJob::makeRequestUrl(connection()->homeserver(),
fileInfo->url);
}
return {};
}
QString Room::fileNameToDownload(const QString& eventId) const
{
if (auto* event = d->getEventWithFile(eventId))
return d->fileNameToDownload(event);
return {};
}
FileTransferInfo Room::fileTransferInfo(const QString& id) const
{
auto infoIt = d->fileTransfers.find(id);
if (infoIt == d->fileTransfers.end())
return {};
// FIXME: Add lib tests to make sure FileTransferInfo::status stays
// consistent with FileTransferInfo::job
qint64 progress = infoIt->progress;
qint64 total = infoIt->total;
if (total > INT_MAX) {
// JavaScript doesn't deal with 64-bit integers; scale down if necessary
progress = llround(double(progress) / total * INT_MAX);
total = INT_MAX;
}
#ifdef BROKEN_INITIALIZER_LISTS
FileTransferInfo fti;
fti.status = infoIt->status;
fti.progress = int(progress);
fti.total = int(total);
fti.localDir = QUrl::fromLocalFile(infoIt->localFileInfo.absolutePath());
fti.localPath = QUrl::fromLocalFile(infoIt->localFileInfo.absoluteFilePath());
return fti;
#else
return { infoIt->status,
infoIt->isUpload,
int(progress),
int(total),
QUrl::fromLocalFile(infoIt->localFileInfo.absolutePath()),
QUrl::fromLocalFile(infoIt->localFileInfo.absoluteFilePath()) };
#endif
}
QUrl Room::fileSource(const QString& id) const
{
auto url = urlToDownload(id);
if (url.isValid())
return url;
// No urlToDownload means it's a pending or completed upload.
auto infoIt = d->fileTransfers.find(id);
if (infoIt != d->fileTransfers.end())
return QUrl::fromLocalFile(infoIt->localFileInfo.absoluteFilePath());
qCWarning(MAIN) << "File source for identifier" << id << "not found";
return {};
}
QString Room::prettyPrint(const QString& plainText) const
{
return QMatrixClient::prettyPrint(plainText);
}
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(); }
QStringList Room::memberNames() const
{
QStringList res;
for (auto u : qAsConst(d->membersMap))
res.append(roomMembername(u));
return res;
}
int Room::memberCount() const { return d->membersMap.size(); }
int Room::timelineSize() const { return int(d->timeline.size()); }
bool Room::usesEncryption() const
{
return !d->getCurrentState<EncryptionEvent>()->algorithm().isEmpty();
}
const RoomEvent* Room::decryptMessage(EncryptedEvent* encryptedEvent) const
{
if (encryptedEvent->algorithm() == OlmV1Curve25519AesSha2AlgoKey) {
QString identityKey = connection()->olmAccount()->curve25519IdentityKey();
QJsonObject personalCipherObject =
encryptedEvent->ciphertext(identityKey);
if (personalCipherObject.isEmpty()) {
qCDebug(EVENTS) << "Encrypted event is not for the current device";
return nullptr;
}
return makeEvent<RoomMessageEvent>(
decryptMessage(personalCipherObject,
encryptedEvent->senderKey().toLatin1()))
.get();
}
if (encryptedEvent->algorithm() == MegolmV1AesSha2AlgoKey) {
return makeEvent<RoomMessageEvent>(
decryptMessage(encryptedEvent->ciphertext(),
encryptedEvent->senderKey(),
encryptedEvent->deviceId(),
encryptedEvent->sessionId()))
.get();
}
return nullptr;
}
const QString Room::decryptMessage(QJsonObject personalCipherObject,
QByteArray senderKey) const
{
QString decrypted;
using namespace QtOlm;
// TODO: new objects to private fields:
InboundSession* session;
int type = personalCipherObject.value(TypeKeyL).toInt(-1);
QByteArray body = personalCipherObject.value(BodyKeyL).toString().toLatin1();
PreKeyMessage* preKeyMessage = new PreKeyMessage(body);
session = new InboundSession(connection()->olmAccount(), preKeyMessage,
senderKey);
if (type == 0) {
if (!session->matches(preKeyMessage, senderKey)) {
connection()->olmAccount()->removeOneTimeKeys(session);
}
try {
decrypted = session->decrypt(preKeyMessage);
} catch (std::runtime_error& e) {
qWarning(EVENTS) << "Decrypt failed:" << e.what();
}
} else if (type == 1) {
Message* message = new Message(body);
if (!session->matches(preKeyMessage, senderKey)) {
qWarning(EVENTS) << "Invalid encrypted message";
}
try {
decrypted = session->decrypt(message);
} catch (std::runtime_error& e) {
qWarning(EVENTS) << "Decrypt failed:" << e.what();
}
}
return decrypted;
}
const QString Room::sessionKey(const QString& senderKey, const QString& deviceId,
const QString& sessionId) const
{
// TODO: handling an m.room_key event
return "";
}
const QString Room::decryptMessage(QByteArray cipher, const QString& senderKey,
const QString& deviceId,
const QString& sessionId) const
{
QString decrypted;
using namespace QtOlm;
InboundGroupSession* groupSession;
groupSession = new InboundGroupSession(
sessionKey(senderKey, deviceId, sessionId).toLatin1());
groupSession->decrypt(cipher);
// TODO: avoid replay attacks
return decrypted;
}
int Room::joinedCount() const
{
return d->summary.joinedMemberCount.omitted()
? d->membersMap.size()
: d->summary.joinedMemberCount.value();
}
int Room::invitedCount() const
{
// TODO: Store invited users in Room too
Q_ASSERT(!d->summary.invitedMemberCount.omitted());
return d->summary.invitedMemberCount.value();
}
int Room::totalMemberCount() const { return joinedCount() + invitedCount(); }
GetRoomEventsJob* Room::eventsHistoryJob() const { return d->eventsHistoryJob; }
Room::Changes Room::Private::setSummary(RoomSummary&& newSummary)
{
if (!summary.merge(newSummary))
return Change::NoChange;
qCDebug(MAIN).nospace().noquote()
<< "Updated room summary for " << q->objectName() << ": " << summary;
emit q->memberListChanged();
return Change::SummaryChange;
}
void Room::Private::insertMemberIntoMap(User* u)
{
const auto userName = u->name(q);
// If there is exactly one namesake of the added user, signal member
// renaming for that other one because the two should be disambiguated now.
const auto namesakes = membersMap.values(userName);
// Callers should check they are not adding an existing user once more.
Q_ASSERT(!namesakes.contains(u));
if (namesakes.size() == 1)
emit q->memberAboutToRename(namesakes.front(),
namesakes.front()->fullName(q));
membersMap.insert(userName, u);
if (namesakes.size() == 1)
emit q->memberRenamed(namesakes.front());
}
void Room::Private::renameMember(User* u, const QString& oldName)
{
if (u->name(q) == oldName) {
qCWarning(MAIN) << "Room::Private::renameMember(): the user "
<< u->fullName(q)
<< "is already known in the room under a new name.";
} else if (membersMap.contains(oldName, u)) {
removeMemberFromMap(oldName, u);
insertMemberIntoMap(u);
}
}
void Room::Private::removeMemberFromMap(const QString& username, User* u)
{
User* namesake = nullptr;
auto namesakes = membersMap.values(username);
if (namesakes.size() == 2) {
namesake = namesakes.front() == u ? namesakes.back() : namesakes.front();
Q_ASSERT_X(namesake != u, __FUNCTION__, "Room members list is broken");
emit q->memberAboutToRename(namesake, username);
}
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 any more.
if (namesake)
emit q->memberRenamed(namesake);
}
inline auto makeErrorStr(const Event& e, QByteArray msg)
{
return msg.append("; event dump follows:\n").append(e.originalJson());
}
Room::Timeline::size_type
Room::Private::moveEventsToTimeline(RoomEventsRange events,
EventsPlacement placement)
{
Q_ASSERT(!events.empty());
// Historical messages arrive in newest-to-oldest order, so the process for
// them is almost symmetric to the one for new messages. New messages get
// appended from index 0; old messages go backwards from index -1.
auto index = timeline.empty()
? -((placement + 1) / 2) /* 1 -> -1; -1 -> 0 */
: placement == Older ? timeline.front().index()
: timeline.back().index();
auto baseIndex = index;
for (auto&& e : events) {
const auto eId = e->id();
Q_ASSERT_X(e, __FUNCTION__, "Attempt to add nullptr to timeline");
Q_ASSERT_X(
!eId.isEmpty(), __FUNCTION__,
makeErrorStr(*e, "Event with empty id cannot be in the timeline"));
Q_ASSERT_X(
!eventsIndex.contains(eId), __FUNCTION__,
makeErrorStr(*e, "Event is already in the timeline; "
"incoming events were not properly deduplicated"));
if (placement == Older)
timeline.emplace_front(move(e), --index);
else
timeline.emplace_back(move(e), ++index);
eventsIndex.insert(eId, index);
Q_ASSERT(q->findInTimeline(eId)->event()->id() == eId);
}
const auto insertedSize = (index - baseIndex) * placement;
Q_ASSERT(insertedSize == int(events.size()));
return insertedSize;
}
QString Room::roomMembername(const User* u) const
{
// See the CS spec, section 11.2.2.3
const auto username = u->name(this);
if (username.isEmpty())
return u->id();
auto namesakesIt = qAsConst(d->membersMap).find(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 full name, just in case.
if (namesakesIt == d->membersMap.cend())
return u->fullName(this);
auto nextUserIt = namesakesIt + 1;
if (nextUserIt == d->membersMap.cend() || nextUserIt.key() != username)
return username; // No disambiguation necessary
// Check if we can get away just attaching the bridge postfix
// (extension to the spec)
QVector<QString> bridges;
for (; namesakesIt != d->membersMap.cend() && namesakesIt.key() == username;
++namesakesIt) {
const auto bridgeName = (*namesakesIt)->bridged();
if (bridges.contains(bridgeName)) // Two accounts on the same bridge
return u->fullName(this); // Disambiguate fully
// Don't bother sorting, not so many bridges out there
bridges.push_back(bridgeName);
}
return u->rawName(this); // Disambiguate using the bridge postfix only
}
QString Room::roomMembername(const QString& userId) const
{
return roomMembername(user(userId));
}
void Room::updateData(SyncRoomData&& data, bool fromCache)
{
if (d->prevBatch.isEmpty())
d->prevBatch = data.timelinePrevBatch;
setJoinState(data.joinState);
Changes roomChanges = Change::NoChange;
QElapsedTimer et;
et.start();
for (auto&& event : data.accountData)
roomChanges |= processAccountDataEvent(move(event));
roomChanges |= d->updateStateFrom(data.state);
if (!data.timeline.empty()) {
et.restart();
roomChanges |= d->addNewMessageEvents(move(data.timeline));
if (data.timeline.size() > 9 || et.nsecsElapsed() >= profilerMinNsecs())
qCDebug(PROFILER)
<< "*** Room::addNewMessageEvents():" << data.timeline.size()
<< "event(s)," << et;
}
if (roomChanges & TopicChange)
emit topicChanged();
if (roomChanges & NameChange)
emit namesChanged(this);
if (roomChanges & MembersChange)
emit memberListChanged();
roomChanges |= d->setSummary(move(data.summary));
for (auto&& ephemeralEvent : data.ephemeral)
roomChanges |= processEphemeralEvent(move(ephemeralEvent));
// See https://github.com/quotient-im/libQuotient/wiki/unread_count
if (data.unreadCount != -2 && data.unreadCount != d->unreadMessages) {
qCDebug(MAIN) << "Setting unread_count to" << data.unreadCount;
d->unreadMessages = data.unreadCount;
emit unreadMessagesChanged(this);
}
if (data.highlightCount != d->highlightCount) {
d->highlightCount = data.highlightCount;
emit highlightCountChanged();
}
if (data.notificationCount != d->notificationCount) {
d->notificationCount = data.notificationCount;
emit notificationCountChanged();
}
if (roomChanges != Change::NoChange) {
d->updateDisplayname();
emit changed(roomChanges);
if (!fromCache)
connection()->saveRoomState(this);
}
}
RoomEvent* Room::Private::addAsPending(RoomEventPtr&& event)
{
if (event->transactionId().isEmpty())
event->setTransactionId(connection->generateTxnId());
if (event->roomId().isEmpty())
event->setRoomId(id);
if (event->senderId().isEmpty())
event->setSender(connection->userId());
auto* pEvent = rawPtr(event);
emit q->pendingEventAboutToAdd(pEvent);
unsyncedEvents.emplace_back(move(event));
emit q->pendingEventAdded();
return pEvent;
}
QString Room::Private::sendEvent(RoomEventPtr&& event)
{
if (q->usesEncryption()) {
qCCritical(MAIN) << "Room" << q->objectName()
<< "enforces encryption; sending encrypted messages "
"is not supported yet";
}
if (q->successorId().isEmpty())
return doSendEvent(addAsPending(std::move(event)));
qCWarning(MAIN) << q << "has been upgraded, event won't be sent";
return {};
}
QString Room::Private::doSendEvent(const RoomEvent* pEvent)
{
const auto txnId = pEvent->transactionId();
// TODO, #133: Enqueue the job rather than immediately trigger it.
if (auto call = connection->callApi<SendMessageJob>(
BackgroundRequest, id, pEvent->matrixType(), txnId,
pEvent->contentJson())) {
Room::connect(call, &BaseJob::started, q, [this, txnId] {
auto it = q->findPendingEvent(txnId);
if (it == unsyncedEvents.end()) {
qWarning(EVENTS) << "Pending event for transaction" << txnId
<< "not found - got synced so soon?";
return;
}
it->setDeparted();
emit q->pendingEventChanged(int(it - unsyncedEvents.begin()));
});
Room::connect(call, &BaseJob::failure, q,
std::bind(&Room::Private::onEventSendingFailure, this,
txnId, call));
Room::connect(call, &BaseJob::success, q, [this, call, txnId] {
emit q->messageSent(txnId, call->eventId());
auto it = q->findPendingEvent(txnId);
if (it == unsyncedEvents.end()) {
qDebug(EVENTS) << "Pending event for transaction" << txnId
<< "already merged";
return;
}
if (it->deliveryStatus() != EventStatus::ReachedServer) {
it->setReachedServer(call->eventId());
emit q->pendingEventChanged(int(it - unsyncedEvents.begin()));
}
});
} else
onEventSendingFailure(txnId);
return txnId;
}
void Room::Private::onEventSendingFailure(const QString& txnId, BaseJob* call)
{
auto it = q->findPendingEvent(txnId);
if (it == unsyncedEvents.end()) {
qCritical(EVENTS) << "Pending event for transaction" << txnId
<< "could not be sent";
return;
}
it->setSendingFailed(call ? call->statusCaption() % ": " % call->errorString()
: tr("The call could not be started"));
emit q->pendingEventChanged(int(it - unsyncedEvents.begin()));
}
QString Room::retryMessage(const QString& txnId)
{
const auto it = findPendingEvent(txnId);
Q_ASSERT(it != d->unsyncedEvents.end());
qDebug(EVENTS) << "Retrying transaction" << txnId;
const auto& transferIt = d->fileTransfers.find(txnId);
if (transferIt != d->fileTransfers.end()) {
Q_ASSERT(transferIt->isUpload);
if (transferIt->status == FileTransferInfo::Completed) {
qCDebug(MAIN) << "File for transaction" << txnId
<< "has already been uploaded, bypassing re-upload";
} else {
if (isJobRunning(transferIt->job)) {
qCDebug(MAIN) << "Abandoning the upload job for transaction"
<< txnId << "and starting again";
transferIt->job->abandon();
emit fileTransferFailed(txnId,
tr("File upload will be retried"));
}
uploadFile(txnId, QUrl::fromLocalFile(
transferIt->localFileInfo.absoluteFilePath()));
// FIXME: Content type is no more passed here but it should
}
}
if (it->deliveryStatus() == EventStatus::ReachedServer) {
qCWarning(MAIN)
<< "The previous attempt has reached the server; two"
" events are likely to be in the timeline after retry";
}
it->resetStatus();
emit pendingEventChanged(int(it - d->unsyncedEvents.begin()));
return d->doSendEvent(it->event());
}
void Room::discardMessage(const QString& txnId)
{
auto it = std::find_if(d->unsyncedEvents.begin(), d->unsyncedEvents.end(),
[txnId](const auto& evt) {
return evt->transactionId() == txnId;
});
Q_ASSERT(it != d->unsyncedEvents.end());
qDebug(EVENTS) << "Discarding transaction" << txnId;
const auto& transferIt = d->fileTransfers.find(txnId);
if (transferIt != d->fileTransfers.end()) {
Q_ASSERT(transferIt->isUpload);
if (isJobRunning(transferIt->job)) {
transferIt->status = FileTransferInfo::Cancelled;
transferIt->job->abandon();
emit fileTransferFailed(txnId, tr("File upload cancelled"));
} else if (transferIt->status == FileTransferInfo::Completed) {
qCWarning(MAIN)
<< "File for transaction" << txnId
<< "has been uploaded but the message was discarded";
}
}
emit pendingEventAboutToDiscard(int(it - d->unsyncedEvents.begin()));
d->unsyncedEvents.erase(it);
emit pendingEventDiscarded();
}
QString Room::postMessage(const QString& plainText, MessageEventType type)
{
return d->sendEvent<RoomMessageEvent>(plainText, type);
}
QString Room::postPlainText(const QString& plainText)
{
return postMessage(plainText, MessageEventType::Text);
}
QString Room::postHtmlMessage(const QString& plainText, const QString& html,
MessageEventType type)
{
return d->sendEvent<RoomMessageEvent>(
plainText, type,
new EventContent::TextContent(html, QStringLiteral("text/html")));
}
QString Room::postHtmlText(const QString& plainText, const QString& html)
{
return postHtmlMessage(plainText, html);
}
QString Room::postReaction(const QString& eventId, const QString& key)
{
return d->sendEvent<ReactionEvent>(EventRelation::annotate(eventId, key));
}
QString Room::postFile(const QString& plainText, const QUrl& localPath,
bool asGenericFile)
{
QFileInfo localFile { localPath.toLocalFile() };
Q_ASSERT(localFile.isFile());
const auto txnId = connection()->generateTxnId();
// Remote URL will only be known after upload; fill in the local path
// to enable the preview while the event is pending.
uploadFile(txnId, localPath);
{
auto&& event = makeEvent<RoomMessageEvent>(plainText, localFile,
asGenericFile);
event->setTransactionId(txnId);
d->addAsPending(std::move(event));
}
auto* context = new QObject(this);
connect(this, &Room::fileTransferCompleted, context,
[context, this, txnId](const QString& id, QUrl, const QUrl& mxcUri) {
if (id == txnId) {
auto it = findPendingEvent(txnId);
if (it != d->unsyncedEvents.end()) {
it->setFileUploaded(mxcUri);
emit pendingEventChanged(
int(it - d->unsyncedEvents.begin()));
d->doSendEvent(it->get());
} else {
// Normally in this situation we should instruct
// the media server to delete the file; alas, there's no
// API specced for that.
qCWarning(MAIN) << "File uploaded to" << mxcUri
<< "but the event referring to it was "
"cancelled";
}
context->deleteLater();
}
});
connect(this, &Room::fileTransferCancelled, this,
[context, this, txnId](const QString& id) {
if (id == txnId) {
auto it = findPendingEvent(txnId);
if (it != d->unsyncedEvents.end()) {
const auto idx = int(it - d->unsyncedEvents.begin());
emit pendingEventAboutToDiscard(idx);
// See #286 on why iterator may not be valid here.
d->unsyncedEvents.erase(d->unsyncedEvents.begin() + idx);
emit pendingEventDiscarded();
}
context->deleteLater();
}
});
return txnId;
}
QString Room::postEvent(RoomEvent* event)
{
return d->sendEvent(RoomEventPtr(event));
}
QString Room::postJson(const QString& matrixType,
const QJsonObject& eventContent)
{
return d->sendEvent(loadEvent<RoomEvent>(matrixType, eventContent));
}
SetRoomStateWithKeyJob* Room::setState(const StateEventBase& evt) const
{
return d->requestSetState(evt);
}
void Room::setName(const QString& newName)
{
d->requestSetState<RoomNameEvent>(newName);
}
void Room::setCanonicalAlias(const QString& newAlias)
{
d->requestSetState<RoomCanonicalAliasEvent>(newAlias);
}
void Room::setLocalAliases(const QStringList& aliases)
{
d->requestSetState<RoomAliasesEvent>(connection()->homeserver().authority(),
aliases);
}
void Room::setTopic(const QString& newTopic)
{
d->requestSetState<RoomTopicEvent>(newTopic);
}
bool isEchoEvent(const RoomEventPtr& le, const PendingEventItem& re)
{
if (le->type() != re->type())
return false;
if (!re->id().isEmpty())
return le->id() == re->id();
if (!re->transactionId().isEmpty())
return le->transactionId() == re->transactionId();
// This one is not reliable (there can be two unsynced
// events with the same type, sender and state key) but
// it's the best we have for state events.
if (re->isStateEvent())
return le->stateKey() == re->stateKey();
// Empty id and no state key, hmm... (shrug)
return le->contentJson() == re->contentJson();
}
bool Room::supportsCalls() const { return joinedCount() == 2; }
void Room::checkVersion()
{
const auto defaultVersion = connection()->defaultRoomVersion();
const auto stableVersions = connection()->stableRoomVersions();
Q_ASSERT(!defaultVersion.isEmpty());
// This method is only called after the base state has been loaded
// or the server capabilities have been loaded.
emit stabilityUpdated(defaultVersion, stableVersions);
if (!stableVersions.contains(version())) {
qCDebug(MAIN) << this << "version is" << version()
<< "which the server doesn't count as stable";
if (canSwitchVersions())
qCDebug(MAIN) << "The current user has enough privileges to fix it";
}
}
void Room::inviteCall(const QString& callId, const int lifetime,
const QString& sdp)
{
Q_ASSERT(supportsCalls());
d->sendEvent<CallInviteEvent>(callId, lifetime, sdp);
}
void Room::sendCallCandidates(const QString& callId,
const QJsonArray& candidates)
{
Q_ASSERT(supportsCalls());
d->sendEvent<CallCandidatesEvent>(callId, candidates);
}
void Room::answerCall(const QString& callId, const int lifetime,
const QString& sdp)
{
Q_ASSERT(supportsCalls());
d->sendEvent<CallAnswerEvent>(callId, lifetime, sdp);
}
void Room::answerCall(const QString& callId, const QString& sdp)
{
Q_ASSERT(supportsCalls());
d->sendEvent<CallAnswerEvent>(callId, sdp);
}
void Room::hangupCall(const QString& callId)
{
Q_ASSERT(supportsCalls());
d->sendEvent<CallHangupEvent>(callId);
}
void Room::getPreviousContent(int limit) { d->getPreviousContent(limit); }
void Room::Private::getPreviousContent(int limit)
{
if (isJobRunning(eventsHistoryJob))
return;
eventsHistoryJob = connection->callApi<GetRoomEventsJob>(id, prevBatch, "b",
"", limit);
emit q->eventsHistoryJobChanged();
connect(eventsHistoryJob, &BaseJob::success, q, [=] {
prevBatch = eventsHistoryJob->end();
addHistoricalMessageEvents(eventsHistoryJob->chunk());
});
connect(eventsHistoryJob, &QObject::destroyed, q,
&Room::eventsHistoryJobChanged);
}
void Room::inviteToRoom(const QString& memberId)
{
connection()->callApi<InviteUserJob>(id(), memberId);
}
LeaveRoomJob* Room::leaveRoom()
{
// FIXME, #63: It should be RoomManager, not Connection
return connection()->leaveRoom(this);
}
SetRoomStateWithKeyJob* Room::setMemberState(const QString& memberId,
const RoomMemberEvent& event) const
{
return d->requestSetState<RoomMemberEvent>(memberId, event.content());
}
void Room::kickMember(const QString& memberId, const QString& reason)
{
connection()->callApi<KickJob>(id(), memberId, reason);
}
void Room::ban(const QString& userId, const QString& reason)
{
connection()->callApi<BanJob>(id(), userId, reason);
}
void Room::unban(const QString& userId)
{
connection()->callApi<UnbanJob>(id(), userId);
}
void Room::redactEvent(const QString& eventId, const QString& reason)
{
connection()->callApi<RedactEventJob>(id(), QUrl::toPercentEncoding(eventId),
connection()->generateTxnId(), reason);
}
void Room::uploadFile(const QString& id, const QUrl& localFilename,
const QString& overrideContentType)
{
Q_ASSERT_X(localFilename.isLocalFile(), __FUNCTION__,
"localFilename should point at a local file");
auto fileName = localFilename.toLocalFile();
auto job = connection()->uploadFile(fileName, overrideContentType);
if (isJobRunning(job)) {
d->fileTransfers.insert(id, { job, fileName, true });
connect(job, &BaseJob::uploadProgress, this,
[this, id](qint64 sent, qint64 total) {
d->fileTransfers[id].update(sent, total);
emit fileTransferProgress(id, sent, total);
});
connect(job, &BaseJob::success, this, [this, id, localFilename, job] {
d->fileTransfers[id].status = FileTransferInfo::Completed;
emit fileTransferCompleted(id, localFilename, job->contentUri());
});
connect(job, &BaseJob::failure, this,
std::bind(&Private::failedTransfer, d, id, job->errorString()));
emit newFileTransfer(id, localFilename);
} else
d->failedTransfer(id);
}
void Room::downloadFile(const QString& eventId, const QUrl& localFilename)
{
auto ongoingTransfer = d->fileTransfers.find(eventId);
if (ongoingTransfer != d->fileTransfers.end()
&& ongoingTransfer->status == FileTransferInfo::Started) {
qCWarning(MAIN) << "Transfer for" << eventId
<< "is ongoing; download won't start";
return;
}
Q_ASSERT_X(localFilename.isEmpty() || localFilename.isLocalFile(),
__FUNCTION__, "localFilename should point at a local file");
const auto* event = d->getEventWithFile(eventId);
if (!event) {
qCCritical(MAIN)
<< eventId << "is not in the local timeline or has no file content";
Q_ASSERT(false);
return;
}
const auto* const fileInfo = event->content()->fileInfo();
if (!fileInfo->isValid()) {
qCWarning(MAIN) << "Event" << eventId
<< "has an empty or malformed mxc URL; won't download";
return;
}
const auto fileUrl = fileInfo->url;
auto filePath = localFilename.toLocalFile();
if (filePath.isEmpty()) {
// Build our own file path, starting with temp directory and eventId.
filePath = eventId;
filePath = QDir::tempPath() % '/'
% filePath.replace(QRegularExpression("[/\\<>|\"*?:]"), "_")
% '#' % d->fileNameToDownload(event);
}
auto job = connection()->downloadFile(fileUrl, filePath);
if (isJobRunning(job)) {
// If there was a previous transfer (completed or failed), remove it.
d->fileTransfers.remove(eventId);
d->fileTransfers.insert(eventId, { job, job->targetFileName() });
connect(job, &BaseJob::downloadProgress, this,
[this, eventId](qint64 received, qint64 total) {
d->fileTransfers[eventId].update(received, total);
emit fileTransferProgress(eventId, received, total);
});
connect(job, &BaseJob::success, this, [this, eventId, fileUrl, job] {
d->fileTransfers[eventId].status = FileTransferInfo::Completed;
emit fileTransferCompleted(
eventId, fileUrl, QUrl::fromLocalFile(job->targetFileName()));
});
connect(job, &BaseJob::failure, this,
std::bind(&Private::failedTransfer, d, eventId,
job->errorString()));
} else
d->failedTransfer(eventId);
}
void Room::cancelFileTransfer(const QString& id)
{
auto it = d->fileTransfers.find(id);
if (it == d->fileTransfers.end()) {
qCWarning(MAIN) << "No information on file transfer" << id << "in room"
<< d->id;
return;
}
if (isJobRunning(it->job))
it->job->abandon();
d->fileTransfers.remove(id);
emit fileTransferCancelled(id);
}
void Room::Private::dropDuplicateEvents(RoomEvents& events) const
{
if (events.empty())
return;
// Multiple-remove (by different criteria), single-erase
// 1. Check for duplicates against the timeline.
auto dupsBegin = remove_if(events.begin(), events.end(),
[&](const RoomEventPtr& e) {
return eventsIndex.contains(e->id());
});
// 2. Check for duplicates within the batch if there are still events.
for (auto eIt = events.begin(); distance(eIt, dupsBegin) > 1; ++eIt)
dupsBegin = remove_if(eIt + 1, dupsBegin, [&](const RoomEventPtr& e) {
return e->id() == (*eIt)->id();
});
if (dupsBegin == events.end())
return;
qCDebug(EVENTS) << "Dropping" << distance(dupsBegin, events.end())
<< "duplicate event(s)";
events.erase(dupsBegin, events.end());
}
/** Make a redacted event
*
* This applies the redaction procedure as defined by the CS API specification
* to the event's JSON and returns the resulting new event. It is
* the responsibility of the caller to dispose of the original event after that.
*/
RoomEventPtr makeRedacted(const RoomEvent& target,
const RedactionEvent& redaction)
{
auto originalJson = target.originalJsonObject();
static const QStringList keepKeys { EventIdKey,
TypeKey,
QStringLiteral("room_id"),
QStringLiteral("sender"),
StateKeyKey,
QStringLiteral("prev_content"),
ContentKey,
QStringLiteral("hashes"),
QStringLiteral("signatures"),
QStringLiteral("depth"),
QStringLiteral("prev_events"),
QStringLiteral("prev_state"),
QStringLiteral("auth_events"),
QStringLiteral("origin"),
QStringLiteral("origin_server_ts"),
QStringLiteral("membership") };
std::vector<std::pair<Event::Type, QStringList>> keepContentKeysMap {
{ RoomMemberEvent::typeId(), { QStringLiteral("membership") } },
{ RoomCreateEvent::typeId(), { QStringLiteral("creator") } }
// , { RoomJoinRules::typeId(), { QStringLiteral("join_rule") } }
// , { RoomPowerLevels::typeId(),
// { QStringLiteral("ban"), QStringLiteral("events"),
// QStringLiteral("events_default"),
// QStringLiteral("kick"), QStringLiteral("redact"),
// QStringLiteral("state_default"), QStringLiteral("users"),
// QStringLiteral("users_default") } }
,
{ RoomAliasesEvent::typeId(), { QStringLiteral("aliases") } }
// , { RoomHistoryVisibility::typeId(),
// { QStringLiteral("history_visibility") } }
};
for (auto it = originalJson.begin(); it != originalJson.end();) {
if (!keepKeys.contains(it.key()))
it = originalJson.erase(it); // TODO: shred the value
else
++it;
}
auto keepContentKeys =
find_if(keepContentKeysMap.begin(), keepContentKeysMap.end(),
[&target](const auto& t) { return target.type() == t.first; });
if (keepContentKeys == keepContentKeysMap.end()) {
originalJson.remove(ContentKeyL);
originalJson.remove(PrevContentKeyL);
} else {
auto content = originalJson.take(ContentKeyL).toObject();
for (auto it = content.begin(); it != content.end();) {
if (!keepContentKeys->second.contains(it.key()))
it = content.erase(it);
else
++it;
}
originalJson.insert(ContentKey, content);
}
auto unsignedData = originalJson.take(UnsignedKeyL).toObject();
unsignedData[RedactedCauseKeyL] = redaction.originalJsonObject();
originalJson.insert(QStringLiteral("unsigned"), unsignedData);
return loadEvent<RoomEvent>(originalJson);
}
bool Room::Private::processRedaction(const RedactionEvent& redaction)
{
// Can't use findInTimeline because it returns a const iterator, and
// we need to change the underlying TimelineItem.
const auto pIdx = eventsIndex.find(redaction.redactedEvent());
if (pIdx == eventsIndex.end())
return false;
Q_ASSERT(q->isValidIndex(*pIdx));
auto& ti = timeline[Timeline::size_type(*pIdx - q->minTimelineIndex())];
if (ti->isRedacted() && ti->redactedBecause()->id() == redaction.id()) {
qCDebug(MAIN) << "Redaction" << redaction.id() << "of event" << ti->id()
<< "already done, skipping";
return true;
}
// Make a new event from the redacted JSON and put it in the timeline
// instead of the redacted one. oldEvent will be deleted on return.
auto oldEvent = ti.replaceEvent(makeRedacted(*ti, redaction));
qCDebug(MAIN) << "Redacted" << oldEvent->id() << "with" << redaction.id();
if (oldEvent->isStateEvent()) {
const StateEventKey evtKey { oldEvent->matrixType(),
oldEvent->stateKey() };
Q_ASSERT(currentState.contains(evtKey));
if (currentState.value(evtKey) == oldEvent.get()) {
Q_ASSERT(ti.index() >= 0); // Historical states can't be in
// currentState
qCDebug(MAIN).nospace()
<< "Redacting state " << oldEvent->matrixType() << "/"
<< oldEvent->stateKey();
// Retarget the current state to the newly made event.
if (q->processStateEvent(*ti))
emit q->namesChanged(q);
updateDisplayname();
}
}
if (const auto* reaction = eventCast<ReactionEvent>(oldEvent)) {
const auto& targetEvtId = reaction->relation().eventId;
const auto lookupKey = qMakePair(targetEvtId,
EventRelation::Annotation());
if (relations.contains(lookupKey)) {
relations[lookupKey].removeOne(reaction);
}
}
q->onRedaction(*oldEvent, *ti);
emit q->replacedEvent(ti.event(), rawPtr(oldEvent));
return true;
}
/** Make a replaced event
*
* Takes \p target and returns a copy of it with content taken from
* \p replacement. Disposal of the original event after that is on the caller.
*/
RoomEventPtr makeReplaced(const RoomEvent& target,
const RoomMessageEvent& replacement)
{
auto originalJson = target.originalJsonObject();
originalJson[ContentKeyL] = replacement.contentJson();
auto unsignedData = originalJson.take(UnsignedKeyL).toObject();
auto relations = unsignedData.take("m.relations"_ls).toObject();
relations["m.replace"_ls] = replacement.id();
unsignedData.insert(QStringLiteral("m.relations"), relations);
originalJson.insert(UnsignedKey, unsignedData);
return loadEvent<RoomEvent>(originalJson);
}
bool Room::Private::processReplacement(const RoomMessageEvent& newEvent)
{
// Can't use findInTimeline because it returns a const iterator, and
// we need to change the underlying TimelineItem.
const auto pIdx = eventsIndex.find(newEvent.replacedEvent());
if (pIdx == eventsIndex.end())
return false;
Q_ASSERT(q->isValidIndex(*pIdx));
auto& ti = timeline[Timeline::size_type(*pIdx - q->minTimelineIndex())];
if (ti->replacedBy() == newEvent.id()) {
qCDebug(MAIN) << "Event" << ti->id() << "is already replaced with"
<< newEvent.id();
return true;
}
// Make a new event from the redacted JSON and put it in the timeline
// instead of the redacted one. oldEvent will be deleted on return.
auto oldEvent = ti.replaceEvent(makeReplaced(*ti, newEvent));
qCDebug(MAIN) << "Replaced" << oldEvent->id() << "with" << newEvent.id();
emit q->replacedEvent(ti.event(), rawPtr(oldEvent));
return true;
}
Connection* Room::connection() const
{
Q_ASSERT(d->connection);
return d->connection;
}
User* Room::localUser() const { return connection()->user(); }
/// Whether the event is a redaction or a replacement
inline bool isEditing(const RoomEventPtr& ep)
{
Q_ASSERT(ep);
if (is<RedactionEvent>(*ep))
return true;
if (auto* msgEvent = eventCast<RoomMessageEvent>(ep))
return msgEvent->replacedEvent().isEmpty();
return false;
}
Room::Changes Room::Private::addNewMessageEvents(RoomEvents&& events)
{
dropDuplicateEvents(events);
if (events.empty())
return Change::NoChange;
{
// Pre-process redactions and edits so that events that get
// redacted/replaced in the same batch landed in the timeline already
// treated.
// NB: We have to store redacting/replacing events to the timeline too -
// see #220.
auto it = std::find_if(events.begin(), events.end(), isEditing);
for (const auto& eptr : RoomEventsRange(it, events.end())) {
if (auto* r = eventCast<RedactionEvent>(eptr)) {
// Try to find the target in the timeline, then in the batch.
if (processRedaction(*r))
continue;
auto targetIt = std::find_if(events.begin(), it,
[id = r->redactedEvent()](
const RoomEventPtr& ep) {
return ep->id() == id;
});
if (targetIt != it)
*targetIt = makeRedacted(**targetIt, *r);
else
qCDebug(MAIN)
<< "Redaction" << r->id() << "ignored: target event"
<< r->redactedEvent() << "is not found";
// If the target event comes later, it comes already redacted.
}
if (auto* msg = eventCast<RoomMessageEvent>(eptr)) {
if (!msg->replacedEvent().isEmpty()) {
if (processReplacement(*msg))
continue;
auto targetIt = std::find_if(events.begin(), it,
[id = msg->replacedEvent()](
const RoomEventPtr& ep) {
return ep->id() == id;
});
if (targetIt != it)
*targetIt = makeReplaced(**targetIt, *msg);
else // FIXME: don't ignore, just show it wherever it arrived
qCDebug(MAIN) << "Replacing event" << msg->id()
<< "ignored: replaced event"
<< msg->replacedEvent() << "is not found";
// Same as with redactions above, the replaced event coming
// later will come already with the new content.
}
}
}
}
// State changes arrive as a part of timeline; the current room state gets
// updated before merging events to the timeline because that's what
// clients historically expect. This may eventually change though if we
// postulate that the current state is only current between syncs but not
// within a sync.
Changes roomChanges = Change::NoChange;
for (const auto& eptr : events)
roomChanges |= q->processStateEvent(*eptr);
auto timelineSize = timeline.size();
size_t totalInserted = 0;
for (auto it = events.begin(); it != events.end();) {
auto nextPendingPair = findFirstOf(it, events.end(),
unsyncedEvents.begin(),
unsyncedEvents.end(), isEchoEvent);
const auto& remoteEcho = nextPendingPair.first;
const auto& localEcho = nextPendingPair.second;
if (it != remoteEcho) {
RoomEventsRange eventsSpan { it, remoteEcho };
emit q->aboutToAddNewMessages(eventsSpan);
auto insertedSize = moveEventsToTimeline(eventsSpan, Newer);
totalInserted += insertedSize;
auto firstInserted = timeline.cend() - insertedSize;
q->onAddNewTimelineEvents(firstInserted);
emit q->addedMessages(firstInserted->index(),
timeline.back().index());
}
if (remoteEcho == events.end())
break;
it = remoteEcho + 1;
auto* nextPendingEvt = remoteEcho->get();
const auto pendingEvtIdx = int(localEcho - unsyncedEvents.begin());
if (localEcho->deliveryStatus() != EventStatus::ReachedServer) {
localEcho->setReachedServer(nextPendingEvt->id());
emit q->pendingEventChanged(pendingEvtIdx);
}
emit q->pendingEventAboutToMerge(nextPendingEvt, pendingEvtIdx);
qDebug(EVENTS) << "Merging pending event from transaction"
<< nextPendingEvt->transactionId() << "into"
<< nextPendingEvt->id();
auto transfer = fileTransfers.take(nextPendingEvt->transactionId());
if (transfer.status != FileTransferInfo::None)
fileTransfers.insert(nextPendingEvt->id(), transfer);
// After emitting pendingEventAboutToMerge() above we cannot rely
// on the previously obtained localEcho staying valid
// because a signal handler may send another message, thereby altering
// unsyncedEvents (see #286). Fortunately, unsyncedEvents only grows at
// its back so we can rely on the index staying valid at least.
unsyncedEvents.erase(unsyncedEvents.begin() + pendingEvtIdx);
if (auto insertedSize = moveEventsToTimeline({ remoteEcho, it }, Newer)) {
totalInserted += insertedSize;
q->onAddNewTimelineEvents(timeline.cend() - insertedSize);
}
emit q->pendingEventMerged();
}
// Events merged and transferred from `events` to `timeline` now.
const auto from = timeline.cend() - totalInserted;
if (q->supportsCalls())
for (auto it = from; it != timeline.cend(); ++it)
if (auto* evt = it->viewAs<CallEventBase>())
emit q->callEvent(q, evt);
if (totalInserted > 0) {
for (auto it = from; it != timeline.cend(); ++it) {
if (const auto* reaction = it->viewAs<ReactionEvent>()) {
const auto& relation = reaction->relation();
relations[{ relation.eventId, relation.type }] << reaction;
emit q->updatedEvent(relation.eventId);
}
}
qCDebug(MAIN) << "Room" << q->objectName() << "received" << totalInserted
<< "new events; the last event is now" << timeline.back();
// The first event in the just-added batch (referred to by `from`)
// defines whose read marker can possibly be promoted any further over
// the same author's events newly arrived. Others will need explicit
// read receipts from the server (or, for the local user,
// markMessagesAsRead() invocation) to promote their read markers over
// the new message events.
auto firstWriter = q->user((*from)->senderId());
if (q->readMarker(firstWriter) != timeline.crend()) {
roomChanges |= promoteReadMarker(firstWriter, rev_iter_t(from) - 1);
qCDebug(MAIN) << "Auto-promoted read marker for" << firstWriter->id()
<< "to" << *q->readMarker(firstWriter);
}
updateUnreadCount(timeline.crbegin(), rev_iter_t(from));
roomChanges |= Change::UnreadNotifsChange;
}
Q_ASSERT(timeline.size() == timelineSize + totalInserted);
return roomChanges;
}
void Room::Private::addHistoricalMessageEvents(RoomEvents&& events)
{
QElapsedTimer et;
et.start();
const auto timelineSize = timeline.size();
dropDuplicateEvents(events);
if (events.empty())
return;
// In case of lazy-loading new members may be loaded with historical
// messages. Also, the cache doesn't store events with empty content;
// so when such events show up in the timeline they should be properly
// incorporated.
for (const auto& eptr : events) {
const auto& e = *eptr;
if (e.isStateEvent()
&& !currentState.contains({ e.matrixType(), e.stateKey() })) {
q->processStateEvent(e);
}
}
emit q->aboutToAddHistoricalMessages(events);
const auto insertedSize = moveEventsToTimeline(events, Older);
const auto from = timeline.crend() - insertedSize;
qCDebug(MAIN) << "Room" << displayname << "received" << insertedSize
<< "past events; the oldest event is now" << timeline.front();
q->onAddHistoricalTimelineEvents(from);
emit q->addedMessages(timeline.front().index(), from->index());
for (auto it = from; it != timeline.crend(); ++it) {
if (const auto* reaction = it->viewAs<ReactionEvent>()) {
const auto& relation = reaction->relation();
relations[{ relation.eventId, relation.type }] << reaction;
emit q->updatedEvent(relation.eventId);
}
}
if (from <= q->readMarker())
updateUnreadCount(from, timeline.crend());
Q_ASSERT(timeline.size() == timelineSize + insertedSize);
if (insertedSize > 9 || et.nsecsElapsed() >= profilerMinNsecs())
qCDebug(PROFILER) << "*** Room::addHistoricalMessageEvents():"
<< insertedSize << "event(s)," << et;
}
Room::Changes Room::processStateEvent(const RoomEvent& e)
{
if (!e.isStateEvent())
return Change::NoChange;
const auto* oldStateEvent =
std::exchange(d->currentState[{ e.matrixType(), e.stateKey() }],
static_cast<const StateEventBase*>(&e));
Q_ASSERT(!oldStateEvent
|| (oldStateEvent->matrixType() == e.matrixType()
&& oldStateEvent->stateKey() == e.stateKey()));
if (!is<RoomMemberEvent>(e)) // Room member events are too numerous
qCDebug(EVENTS) << "Room state event:" << e;
// clang-format off
return visit(e
, [] (const RoomNameEvent&) {
return NameChange;
}
, [this,oldStateEvent] (const RoomAliasesEvent& ae) {
// clang-format on
if (ae.aliases().isEmpty()) {
qDebug(MAIN).noquote()
<< ae.stateKey() << "no more has aliases for room"
<< objectName();
d->aliasServers.remove(ae.stateKey());
} else {
d->aliasServers.insert(ae.stateKey());
qDebug(MAIN).nospace().noquote()
<< "New server with aliases for room " << objectName()
<< ": " << ae.stateKey();
}
const auto previousAliases =
oldStateEvent
? static_cast<const RoomAliasesEvent*>(oldStateEvent)->aliases()
: QStringList();
connection()->updateRoomAliases(id(), ae.stateKey(),
previousAliases, ae.aliases());
return OtherChange;
// clang-format off
}
, [this] (const RoomCanonicalAliasEvent& evt) {
setObjectName(evt.alias().isEmpty() ? d->id : evt.alias());
return CanonicalAliasChange;
}
, [] (const RoomTopicEvent&) {
return TopicChange;
}
, [this] (const RoomAvatarEvent& evt) {
if (d->avatar.updateUrl(evt.url()))
emit avatarChanged();
return AvatarChange;
}
, [this,oldStateEvent] (const RoomMemberEvent& evt) {
// clang-format on
auto* u = user(evt.userId());
const auto* oldMemberEvent =
static_cast<const RoomMemberEvent*>(oldStateEvent);
u->processEvent(evt, this, oldMemberEvent == nullptr);
const auto prevMembership = oldMemberEvent
? oldMemberEvent->membership()
: MembershipType::Leave;
if (u == localUser() && evt.membership() == MembershipType::Invite
&& evt.isDirect())
connection()->addToDirectChats(this, user(evt.senderId()));
switch (prevMembership) {
case MembershipType::Invite:
if (evt.membership() != prevMembership) {
d->usersInvited.removeOne(u);
Q_ASSERT(!d->usersInvited.contains(u));
}
break;
case MembershipType::Join:
if (evt.membership() == MembershipType::Invite)
qCWarning(MAIN) << "Invalid membership change from "
"Join to Invite:"
<< evt;
if (evt.membership() != prevMembership) {
disconnect(u, &User::nameAboutToChange, this, nullptr);
disconnect(u, &User::nameChanged, this, nullptr);
d->removeMemberFromMap(u->name(this), u);
emit userRemoved(u);
}
break;
default:
if (evt.membership() == MembershipType::Invite
|| evt.membership() == MembershipType::Join) {
d->membersLeft.removeOne(u);
Q_ASSERT(!d->membersLeft.contains(u));
}
}
switch (evt.membership()) {
case MembershipType::Join:
if (prevMembership != MembershipType::Join) {
d->insertMemberIntoMap(u);
connect(u, &User::nameAboutToChange, this,
[=](QString newName, QString, const Room* context) {
if (context == this)
emit memberAboutToRename(u, newName);
});
connect(u, &User::nameChanged, this,
[=](QString, QString oldName, const Room* context) {
if (context == this) {
d->renameMember(u, oldName);
emit memberRenamed(u);
}
});
emit userAdded(u);
}
break;
case MembershipType::Invite:
if (!d->usersInvited.contains(u))
d->usersInvited.push_back(u);
break;
default:
if (!d->membersLeft.contains(u))
d->membersLeft.append(u);
}
return MembersChange;
// clang-format off
}
, [this] (const EncryptionEvent&) {
emit encryption(); // It can only be done once, so emit it here.
return OtherChange;
}
, [this] (const RoomTombstoneEvent& evt) {
const auto successorId = evt.successorRoomId();
if (auto* successor = connection()->room(successorId))
emit upgraded(evt.serverMessage(), successor);
else
connectUntil(connection(), &Connection::loadedRoomState, this,
[this,successorId,serverMsg=evt.serverMessage()]
(Room* newRoom) {
if (newRoom->id() != successorId)
return false;
emit upgraded(serverMsg, newRoom);
return true;
});
return OtherChange;
}
);
// clang-format on
}
Room::Changes Room::processEphemeralEvent(EventPtr&& event)
{
Changes changes = NoChange;
QElapsedTimer et;
et.start();
if (auto* evt = eventCast<TypingEvent>(event)) {
d->usersTyping.clear();
for (const QString& userId : qAsConst(evt->users())) {
auto u = user(userId);
if (memberJoinState(u) == JoinState::Join)
d->usersTyping.append(u);
}
if (evt->users().size() > 3 || et.nsecsElapsed() >= profilerMinNsecs())
qCDebug(PROFILER) << "*** Room::processEphemeralEvent(typing):"
<< evt->users().size() << "users," << et;
emit typingChanged();
}
if (auto* evt = eventCast<ReceiptEvent>(event)) {
int totalReceipts = 0;
for (const auto& p : qAsConst(evt->eventsWithReceipts())) {
totalReceipts += p.receipts.size();
{
if (p.receipts.size() == 1)
qCDebug(EPHEMERAL) << "Marking" << p.evtId << "as read for"
<< p.receipts[0].userId;
else
qCDebug(EPHEMERAL) << "Marking" << p.evtId << "as read for"
<< p.receipts.size() << "users";
}
const auto newMarker = findInTimeline(p.evtId);
if (newMarker != timelineEdge()) {
for (const Receipt& r : p.receipts) {
if (r.userId == connection()->userId())
continue; // FIXME, #185
auto u = user(r.userId);
if (memberJoinState(u) == JoinState::Join)
changes |= d->promoteReadMarker(u, newMarker);
}
} else {
qCDebug(EPHEMERAL) << "Event" << p.evtId
<< "not found; saving read receipts anyway";
// If the event is not found (most likely, because it's too old
// and hasn't been fetched from the server yet), but there is
// a previous marker for a user, keep the previous marker.
// Otherwise, blindly store the event id for this user.
for (const Receipt& r : p.receipts) {
if (r.userId == connection()->userId())
continue; // FIXME, #185
auto u = user(r.userId);
if (memberJoinState(u) == JoinState::Join
&& readMarker(u) == timelineEdge())
changes |= d->setLastReadEvent(u, p.evtId);
}
}
}
if (evt->eventsWithReceipts().size() > 3 || totalReceipts > 10
|| et.nsecsElapsed() >= profilerMinNsecs())
qCDebug(PROFILER)
<< "*** Room::processEphemeralEvent(receipts):"
<< evt->eventsWithReceipts().size() << "event(s) with"
<< totalReceipts << "receipt(s)," << et;
}
return changes;
}
Room::Changes Room::processAccountDataEvent(EventPtr&& event)
{
Changes changes = NoChange;
if (auto* evt = eventCast<TagEvent>(event)) {
d->setTags(evt->tags());
changes |= Change::TagsChange;
}
if (auto* evt = eventCast<ReadMarkerEvent>(event)) {
auto readEventId = evt->event_id();
qCDebug(MAIN) << "Server-side read marker at" << readEventId;
d->serverReadMarker = readEventId;
const auto newMarker = findInTimeline(readEventId);
changes |= newMarker != timelineEdge()
? d->markMessagesAsRead(newMarker)
: d->setLastReadEvent(localUser(), readEventId);
}
// For all account data events
auto& currentData = d->accountData[event->matrixType()];
// A polymorphic event-specific comparison might be a bit more
// efficient; maaybe do it another day
if (!currentData || currentData->contentJson() != event->contentJson()) {
emit accountDataAboutToChange(event->matrixType());
currentData = move(event);
qCDebug(MAIN) << "Updated account data of type"
<< currentData->matrixType();
emit accountDataChanged(currentData->matrixType());
return Change::AccountDataChange;
}
return Change::NoChange;
}
template <typename ContT>
Room::Private::users_shortlist_t
Room::Private::buildShortlist(const ContT& users) const
{
// To calculate room display name 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. The below code selects 3 topmost users,
// slightly extending the spec.
users_shortlist_t shortlist {}; // Prefill with nullptrs
std::partial_sort_copy(
users.begin(), users.end(), shortlist.begin(), shortlist.end(),
[this](const User* u1, const User* u2) {
// localUser(), if it's in the list, is sorted
// below all others
return isLocalUser(u2) || (!isLocalUser(u1) && u1->id() < u2->id());
});
return shortlist;
}
Room::Private::users_shortlist_t
Room::Private::buildShortlist(const QStringList& userIds) const
{
QList<User*> users;
users.reserve(userIds.size());
for (const auto& h : userIds)
users.push_back(q->user(h));
return buildShortlist(users);
}
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)
auto dispName = q->name();
if (!dispName.isEmpty()) {
return dispName;
}
// 2. Canonical alias
dispName = q->canonicalAlias();
if (!dispName.isEmpty())
return dispName;
// Using m.room.aliases in naming is explicitly discouraged by the spec
// Supplementary code for 3 and 4: build the shortlist of users whose names
// will be used to construct the room name. Takes into account MSC688's
// "heroes" if available.
const bool localUserIsIn = joinState == JoinState::Join;
const bool emptyRoom = membersMap.isEmpty()
|| (membersMap.size() == 1
&& isLocalUser(*membersMap.begin()));
const bool nonEmptySummary = !summary.heroes.omitted()
&& !summary.heroes->empty();
auto shortlist = nonEmptySummary ? buildShortlist(summary.heroes.value())
: !emptyRoom ? buildShortlist(membersMap)
: users_shortlist_t {};
// When lazy-loading is on, we can rely on the heroes list.
// If it's off, the below code gathers invited and left members.
// NB: including invitations, if any, into naming is a spec extension.
// This kicks in when there's no lazy loading and it's a room with
// the local user as the only member, with more users invited.
if (!shortlist.front() && localUserIsIn)
shortlist = buildShortlist(usersInvited);
if (!shortlist.front()) // Still empty shortlist; use left members
shortlist = buildShortlist(membersLeft);
QStringList names;
for (auto u : shortlist) {
if (u == nullptr || isLocalUser(u))
break;
// Only disambiguate if the room is not empty
names.push_back(u->displayname(emptyRoom ? nullptr : q));
}
const auto usersCountExceptLocal =
!emptyRoom
? q->joinedCount() - int(joinState == JoinState::Join)
: !usersInvited.empty()
? usersInvited.count()
: membersLeft.size() - int(joinState == JoinState::Leave);
if (usersCountExceptLocal > int(shortlist.size()))
names << tr(
"%Ln other(s)",
"Used to make a room name from user names: A, B and _N others_",
usersCountExceptLocal - int(shortlist.size()));
const auto namesList = QLocale().createSeparatedList(names);
// 3. Room members
if (!emptyRoom)
return namesList;
// (Spec extension) Invited users
if (!usersInvited.empty())
return tr("Empty room (invited: %1)").arg(namesList);
// 4. Users that previously left the room
if (membersLeft.size() > 0)
return tr("Empty room (was: %1)").arg(namesList);
// 5. Fail miserably
return tr("Empty room (%1)").arg(id);
}
void Room::Private::updateDisplayname()
{
auto swappedName = calculateDisplayname();
if (swappedName != displayname) {
emit q->displaynameAboutToChange(q);
swap(displayname, swappedName);
qDebug(MAIN) << q->objectName() << "has changed display name from"
<< swappedName << "to" << displayname;
emit q->displaynameChanged(q, swappedName);
}
}
QJsonObject Room::Private::toJson() const
{
QElapsedTimer et;
et.start();
QJsonObject result;
addParam<IfNotEmpty>(result, QStringLiteral("summary"), summary);
{
QJsonArray stateEvents;
for (const auto* evt : currentState) {
Q_ASSERT(evt->isStateEvent());
if ((evt->isRedacted() && !is<RoomMemberEvent>(*evt))
|| evt->contentJson().isEmpty())
continue;
auto json = evt->fullJson();
auto unsignedJson = evt->unsignedJson();
unsignedJson.remove(QStringLiteral("prev_content"));
json[UnsignedKeyL] = unsignedJson;
stateEvents.append(json);
}
const auto stateObjName = joinState == JoinState::Invite
? QStringLiteral("invite_state")
: QStringLiteral("state");
result.insert(stateObjName,
QJsonObject { { QStringLiteral("events"), stateEvents } });
}
if (!accountData.empty()) {
QJsonArray accountDataEvents;
for (const auto& e : accountData) {
if (!e.second->contentJson().isEmpty())
accountDataEvents.append(e.second->fullJson());
}
result.insert(QStringLiteral("account_data"),
QJsonObject {
{ QStringLiteral("events"), accountDataEvents } });
}
QJsonObject unreadNotifObj { { SyncRoomData::UnreadCountKey,
unreadMessages } };
if (highlightCount > 0)
unreadNotifObj.insert(QStringLiteral("highlight_count"), highlightCount);
if (notificationCount > 0)
unreadNotifObj.insert(QStringLiteral("notification_count"),
notificationCount);
result.insert(QStringLiteral("unread_notifications"), unreadNotifObj);
if (et.elapsed() > 30)
qCDebug(PROFILER) << "Room::toJson() for" << displayname << "took" << et;
return result;
}
QJsonObject Room::toJson() const { return d->toJson(); }
MemberSorter Room::memberSorter() const { return MemberSorter(this); }
bool MemberSorter::operator()(User* u1, User* u2) const
{
return operator()(u1, room->roomMembername(u2));
}
bool MemberSorter::operator()(User* u1, const QString& u2name) const
{
auto n1 = room->roomMembername(u1);
if (n1.startsWith('@'))
n1.remove(0, 1);
auto n2 = u2name.midRef(u2name.startsWith('@') ? 1 : 0);
return n1.localeAwareCompare(n2) < 0;
}