From 07485711f867813098180afcfe15e4af393b66ec Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Wed, 28 Feb 2018 14:46:36 +0900 Subject: Profiling logs: added µs, less empty profiling log lines MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Closes #177. --- connection.cpp | 6 ++---- jobs/syncjob.cpp | 3 ++- logging.h | 11 +++++++++++ room.cpp | 37 ++++++++++++++++--------------------- user.cpp | 6 ++---- 5 files changed, 33 insertions(+), 30 deletions(-) diff --git a/connection.cpp b/connection.cpp index 9a5a5a4e..06da17e0 100644 --- a/connection.cpp +++ b/connection.cpp @@ -684,8 +684,7 @@ void Connection::saveState(const QUrl &toFile) const qCDebug(MAIN) << "Writing state to file" << outfile.fileName(); outfile.write(data.data(), data.size()); - qCDebug(PROFILER) << "*** Cached state for" << userId() - << "saved in" << et.elapsed() << "ms"; + qCDebug(PROFILER) << "*** Cached state for" << userId() << "saved in" << et; } void Connection::loadState(const QUrl &fromFile) @@ -722,8 +721,7 @@ void Connection::loadState(const QUrl &fromFile) SyncData sync; sync.parseJson(jsonDoc); onSyncSuccess(std::move(sync)); - qCDebug(PROFILER) << "*** Cached state for" << userId() - << "loaded in" << et.elapsed() << "ms"; + qCDebug(PROFILER) << "*** Cached state for" << userId() << "loaded in" << et; } QString Connection::stateCachePath() const diff --git a/jobs/syncjob.cpp b/jobs/syncjob.cpp index 7b066f4f..fd8bfc1a 100644 --- a/jobs/syncjob.cpp +++ b/jobs/syncjob.cpp @@ -83,7 +83,8 @@ BaseJob::Status SyncData::parseJson(const QJsonDocument &data) roomData.emplace_back(roomIt.key(), JoinState(i), roomIt.value().toObject()); } - qCDebug(PROFILER) << "*** SyncData::parseJson():" << et.elapsed() << "ms"; + qCDebug(PROFILER) << "*** SyncData::parseJson(): batch with" + << rooms.size() << "room(s) in" << et; return BaseJob::Success; } diff --git a/logging.h b/logging.h index aaeceeac..ae7e0332 100644 --- a/logging.h +++ b/logging.h @@ -18,6 +18,7 @@ #pragma once +#include #include Q_DECLARE_LOGGING_CATEGORY(MAIN) @@ -65,3 +66,13 @@ namespace QMatrixClient return qdm(debug_object); } } + +inline QDebug operator<< (QDebug debug_object, const QElapsedTimer& et) +{ + auto val = et.nsecsElapsed() / 1000; + if (val < 1000) + debug_object << val << u"µs"; + else + debug_object << val / 1000 << "ms"; + return debug_object; +} diff --git a/room.cpp b/room.cpp index db36a713..20b19e93 100644 --- a/room.cpp +++ b/room.cpp @@ -876,7 +876,7 @@ void Room::updateData(SyncRoomData&& data) et.start(); processStateEvents(data.state); qCDebug(PROFILER) << "*** Room::processStateEvents(state):" - << et.elapsed() << "ms," << data.state.size() << "events"; + << data.state.size() << "event(s)," << et; } if (!data.timeline.empty()) { @@ -884,30 +884,17 @@ void Room::updateData(SyncRoomData&& data) // State changes can arrive in a timeline event; so check those. processStateEvents(data.timeline); qCDebug(PROFILER) << "*** Room::processStateEvents(timeline):" - << et.elapsed() << "ms," << data.timeline.size() << "events"; + << data.timeline.size() << "event(s)," << et; et.restart(); d->addNewMessageEvents(move(data.timeline)); - qCDebug(PROFILER) << "*** Room::addNewMessageEvents():" - << et.elapsed() << "ms"; - } - if (!data.ephemeral.empty()) - { - et.restart(); - for( auto&& ephemeralEvent: data.ephemeral ) - processEphemeralEvent(move(ephemeralEvent)); - qCDebug(PROFILER) << "*** Room::processEphemeralEvents():" - << et.elapsed() << "ms"; + qCDebug(PROFILER) << "*** Room::addNewMessageEvents():" << et; } + for( auto&& ephemeralEvent: data.ephemeral ) + processEphemeralEvent(move(ephemeralEvent)); - if (!data.accountData.empty()) - { - et.restart(); - for (auto&& event: data.accountData) - processAccountDataEvent(move(event)); - qCDebug(PROFILER) << "*** Room::processAccountData():" - << et.elapsed() << "ms"; - } + for (auto&& event: data.accountData) + processAccountDataEvent(move(event)); if( data.highlightCount != d->highlightCount ) { @@ -1406,6 +1393,7 @@ void Room::processStateEvents(const RoomEvents& events) void Room::processEphemeralEvent(EventPtr event) { + QElapsedTimer et; et.start(); switch (event->type()) { case EventType::Typing: { @@ -1417,6 +1405,9 @@ void Room::processEphemeralEvent(EventPtr event) if (memberJoinState(u) == JoinState::Join) d->usersTyping.append(u); } + if (!typingEvent->users().isEmpty()) + qCDebug(PROFILER) << "*** Room::processEphemeralEvent(typing):" + << typingEvent->users().size() << "users," << et; emit typingChanged(); break; } @@ -1459,13 +1450,17 @@ void Room::processEphemeralEvent(EventPtr event) } } } + if (!receiptEvent->eventsWithReceipts().isEmpty()) + qCDebug(PROFILER) << "*** Room::processEphemeralEvent(receipts):" + << receiptEvent->eventsWithReceipts().size() + << "events with receipts," << et; if (receiptEvent->unreadMessages()) d->unreadMessages = true; break; } default: qCWarning(EPHEMERAL) << "Unexpected event type in 'ephemeral' batch:" - << event->type(); + << event->jsonType(); } } diff --git a/user.cpp b/user.cpp index 308b217c..54eaf38c 100644 --- a/user.cpp +++ b/user.cpp @@ -128,8 +128,7 @@ void User::Private::setNameForRoom(const Room* r, QString newName, mostUsedName = newName; otherNames.remove(newName); if (totalRooms > MIN_JOINED_ROOMS_TO_LOG) - qCDebug(PROFILER) << et.elapsed() - << "ms to switch the most used name"; + qCDebug(PROFILER) << et << "to switch the most used name"; } else otherNames.insert(newName, r); @@ -186,8 +185,7 @@ void User::Private::setAvatarForRoom(const Room* r, const QUrl& newUrl, avatarsToRooms.insert(nextMostUsed->url(), r1); if (totalRooms > MIN_JOINED_ROOMS_TO_LOG) - qCDebug(PROFILER) << et.elapsed() - << "ms to switch the most used avatar"; + qCDebug(PROFILER) << et << "to switch the most used avatar"; } else { otherAvatars.insert(newUrl, makeAvatar(newUrl)); avatarsToRooms.insert(newUrl, r); -- cgit v1.2.3 From 164938cc1900afe94128e83c8c52bf04a8981ded Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Wed, 28 Feb 2018 15:21:41 +0900 Subject: To the previous commit: µ (mu, micro) is a part of Latin-1 code page. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit And QDebug doesn't work with u"" anyway. --- logging.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/logging.h b/logging.h index ae7e0332..8dbfdf30 100644 --- a/logging.h +++ b/logging.h @@ -71,7 +71,7 @@ inline QDebug operator<< (QDebug debug_object, const QElapsedTimer& et) { auto val = et.nsecsElapsed() / 1000; if (val < 1000) - debug_object << val << u"µs"; + debug_object << val << "µs"; else debug_object << val / 1000 << "ms"; return debug_object; -- cgit v1.2.3 From efd37913fdb4223168a0bb0e7897d75be4606d1f Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Wed, 28 Feb 2018 16:41:43 +0900 Subject: Don't resolve the homeserver port from a user MXID Closes #176. The right way (c) of server name resolution will be done in #178 (see also the Google Doc mentioned in it). --- connection.cpp | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/connection.cpp b/connection.cpp index 06da17e0..7914639e 100644 --- a/connection.cpp +++ b/connection.cpp @@ -98,12 +98,13 @@ void Connection::resolveServer(const QString& mxidOrDomain) // Try to parse as an FQID; if there's no @ part, assume it's a domain name. QRegularExpression parser( "^(@.+?:)?" // Optional username (allow everything for compatibility) - "((\\[[^]]+\\]|[^:@]+)" // Either IPv6 address or hostname/IPv4 address - "(:\\d{1,5})?)$", // Optional port + "(\\[[^]]+\\]|[^:@]+)" // Either IPv6 address or hostname/IPv4 address + "(:\\d{1,5})?$", // Optional port QRegularExpression::UseUnicodePropertiesOption); // Because asian digits auto match = parser.match(mxidOrDomain); QUrl maybeBaseUrl = QUrl::fromUserInput(match.captured(2)); + maybeBaseUrl.setScheme("https"); // Instead of the Qt-default "http" if (!match.hasMatch() || !maybeBaseUrl.isValid()) { emit resolveError( @@ -112,16 +113,14 @@ void Connection::resolveServer(const QString& mxidOrDomain) return; } - maybeBaseUrl.setScheme("https"); // Instead of the Qt-default "http" - if (maybeBaseUrl.port() != -1) - { - setHomeserver(maybeBaseUrl); - emit resolved(); - return; - } + setHomeserver(maybeBaseUrl); + emit resolved(); + return; + // FIXME, #178: The below code is incorrect and is no more executed. The + // correct server resolution should be done from .well-known/matrix/client auto domain = maybeBaseUrl.host(); - qCDebug(MAIN) << "Resolving server" << domain; + qCDebug(MAIN) << "Finding the server" << domain; // Check if the Matrix server has a dedicated service record. QDnsLookup* dns = new QDnsLookup(); dns->setType(QDnsLookup::SRV); @@ -190,9 +189,8 @@ void Connection::Private::connectWithToken(const QString& user, userId = user; data->setToken(accessToken.toLatin1()); data->setDeviceId(deviceId); - qCDebug(MAIN) << "Using server" << data->baseUrl() << "by user" - << userId - << "from device" << deviceId; + qCDebug(MAIN) << "Using server" << data->baseUrl().toDisplayString() + << "by user" << userId << "from device" << deviceId; emit q->connected(); } -- cgit v1.2.3 From 9ff04e98d62f93a7a6003fc80d189e96c6835f84 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Wed, 28 Feb 2018 17:11:10 +0900 Subject: Skip retry interval if the last job attempt timed out Closes #175. --- jobs/basejob.cpp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/jobs/basejob.cpp b/jobs/basejob.cpp index c3b110f0..7669d1d4 100644 --- a/jobs/basejob.cpp +++ b/jobs/basejob.cpp @@ -373,7 +373,8 @@ void BaseJob::finishJob() // TODO: The whole retrying thing should be put to ConnectionManager // otherwise independently retrying jobs make a bit of notification // storm towards the UI. - const auto retryInterval = getNextRetryInterval(); + const auto retryInterval = + error() == TimeoutError ? 0 : getNextRetryInterval(); ++d->retriesTaken; qCWarning(d->logCat) << this << "will take retry" << d->retriesTaken << "in" << retryInterval/1000 << "s"; -- cgit v1.2.3 From 646ee63846c8985b6222ae1096ccc970a1834ce5 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Thu, 1 Mar 2018 20:12:43 +0900 Subject: Fix tags saving/restoring (finally) Closes #134. --- events/tagevent.cpp | 21 +++++++++++++++++++++ events/tagevent.h | 27 +++++++++++++++++++++++++-- room.cpp | 45 ++++++++++++++++++++++++--------------------- room.h | 2 +- 4 files changed, 71 insertions(+), 24 deletions(-) diff --git a/events/tagevent.cpp b/events/tagevent.cpp index c6297003..886a10c6 100644 --- a/events/tagevent.cpp +++ b/events/tagevent.cpp @@ -24,6 +24,12 @@ TagRecord::TagRecord(const QJsonObject& json) : order(json.value("order").toString()) { } +TagEvent::TagEvent() + : Event(Type::Tag) +{ + // TODO: Support getting a list of tags and saving it +} + TagEvent::TagEvent(const QJsonObject& obj) : Event(Type::Tag, obj) { @@ -44,6 +50,21 @@ QHash TagEvent::tags() const return result; } +bool TagEvent::empty() const +{ + return tagsObject().empty(); +} + +bool TagEvent::contains(const QString& name) const +{ + return tagsObject().contains(name); +} + +TagRecord TagEvent::recordForTag(const QString& name) const +{ + return TagRecord(tagsObject().value(name).toObject()); +} + QJsonObject TagEvent::tagsObject() const { return contentJson().value("tags").toObject(); diff --git a/events/tagevent.h b/events/tagevent.h index 44a7e49a..26fe8788 100644 --- a/events/tagevent.h +++ b/events/tagevent.h @@ -35,6 +35,7 @@ namespace QMatrixClient class TagEvent : public Event { public: + TagEvent(); explicit TagEvent(const QJsonObject& obj); /** Get the list of tag names */ @@ -43,9 +44,31 @@ namespace QMatrixClient /** Get the list of tags along with information on each */ QHash tags() const; - static constexpr const char * TypeId = "m.tag"; + /** Check if the event lists no tags */ + bool empty() const; + + /** Check whether the tags list contains the specified name */ + bool contains(const QString& name) const; - protected: + /** Get the record for the given tag name */ + TagRecord recordForTag(const QString& name) const; + + /** Get the whole tags content as a JSON object + * It's NOT recommended to use this method directly from client code. + * Use other convenience methods provided by the class. + */ QJsonObject tagsObject() const; + + static constexpr const char * TypeId = "m.tag"; }; + + using TagEventPtr = event_ptr_tt; + + inline QJsonValue toJson(const TagEventPtr& tagEvent) + { + return QJsonObject {{ "type", "m.tag" }, + // TODO: Replace tagsObject() with a genuine list of tags + // (or make the needed JSON upon TagEvent creation) + { "content", QJsonObject {{ "tags", tagEvent->tagsObject() }} }}; + } } diff --git a/room.cpp b/room.cpp index 20b19e93..ae3360dc 100644 --- a/room.cpp +++ b/room.cpp @@ -95,8 +95,8 @@ class Room::Private QString firstDisplayedEventId; QString lastDisplayedEventId; QHash lastReadEventIds; - QHash tags; - QHash accountData; + TagEventPtr tags = std::make_unique(); + QHash accountData; QString prevBatch; QPointer roomMessagesJob; @@ -556,27 +556,27 @@ void Room::resetHighlightCount() QStringList Room::tagNames() const { - return d->tags.keys(); + return d->tags->tagNames(); } -const QHash& Room::tags() const +QHash Room::tags() const { - return d->tags; + return d->tags->tags(); } TagRecord Room::tag(const QString& name) const { - return d->tags.value(name); + return d->tags->recordForTag(name); } bool Room::isFavourite() const { - return d->tags.contains(FavouriteTag); + return d->tags->contains(FavouriteTag); } bool Room::isLowPriority() const { - return d->tags.contains(LowPriorityTag); + return d->tags->contains(LowPriorityTag); } const RoomMessageEvent* @@ -1469,11 +1469,13 @@ void Room::processAccountDataEvent(EventPtr event) switch (event->type()) { case EventType::Tag: - d->tags = static_cast(event.get())->tags(); + d->tags.reset(static_cast(event.release())); + qCDebug(MAIN) << "Room" << id() << "is tagged with: " + << tagNames().join(", "); emit tagsChanged(); break; default: - d->accountData[event->jsonType()] = event->contentJson(); + d->accountData[event->jsonType()] = event->contentJson().toVariantHash(); } } @@ -1645,19 +1647,20 @@ QJsonObject Room::Private::toJson() const result.insert("ephemeral", ephemeralObj); } + QJsonArray accountDataEvents; + if (!tags->empty()) + accountDataEvents.append(QMatrixClient::toJson(tags)); + + if (!accountData.empty()) { - QJsonObject accountDataObj; - if (!tags.empty()) - { - QJsonObject tagsObj; - for (auto it = tags.begin(); it != tags.end(); ++it) - tagsObj.insert(it.key(), { {"order", it->order} }); - if (!tagsObj.empty()) - accountDataObj.insert("m.tag", tagsObj); - } - if (!accountDataObj.empty()) - result.insert("account_data", accountDataObj); + for (auto it = accountData.begin(); it != accountData.end(); ++it) + accountDataEvents.append(QJsonObject { + {"type", it.key()}, + {"content", QJsonObject::fromVariantHash(it.value())} + }); } + QJsonObject accountDataEventsObj; + result.insert("account_data", QJsonObject { {"events", accountDataEvents} }); QJsonObject unreadNotificationsObj; if (highlightCount > 0) diff --git a/room.h b/room.h index 8e27a608..71d5c433 100644 --- a/room.h +++ b/room.h @@ -241,7 +241,7 @@ namespace QMatrixClient Q_INVOKABLE void resetHighlightCount(); QStringList tagNames() const; - const QHash& tags() const; + QHash tags() const; TagRecord tag(const QString& name) const; /** Check whether the list of tags has m.favourite */ -- cgit v1.2.3 From e15645d0e7afc0f45727d0d6611445fc26ef5219 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Thu, 1 Mar 2018 20:19:48 +0900 Subject: Connection::tagNames() To be able to get all available tags throughout the connection. --- connection.cpp | 11 +++++++++++ connection.h | 3 +++ 2 files changed, 14 insertions(+) diff --git a/connection.cpp b/connection.cpp index 7914639e..1c65d66f 100644 --- a/connection.cpp +++ b/connection.cpp @@ -534,6 +534,17 @@ QHash> Connection::tagsToRooms() const return result; } +QStringList Connection::tagNames() const +{ + QStringList tags ({"m.favourite"}); + for (auto* r: d->roomMap) + for (const auto& tag: r->tagNames()) + if (tag != "m.lowpriority" && !tags.contains(tag)) + tags.push_back(tag); + tags.push_back("m.lowpriority"); + return tags; +} + QVector Connection::roomsWithTag(const QString& tagName) const { QVector rooms; diff --git a/connection.h b/connection.h index b45a171d..1e9df5e2 100644 --- a/connection.h +++ b/connection.h @@ -83,6 +83,9 @@ namespace QMatrixClient */ QHash> tagsToRooms() const; + /** Get all room tags known on this connection */ + QStringList tagNames() const; + /** Get the list of rooms with the specified tag */ QVector roomsWithTag(const QString& tagName) const; -- cgit v1.2.3 From c94c36418461f0909f125d3833e323689c4357f8 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Fri, 2 Mar 2018 13:58:01 +0900 Subject: Travis CI: run qmc-example on OSX; set valgrind options externally The first part at least checks that qmc-example works on OSX (and we no more make a useless bundle for it). The second part allows to change valgrind options without tinkering .travis.yml. --- .travis.yml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index b75418f2..001ba11f 100644 --- a/.travis.yml +++ b/.travis.yml @@ -22,15 +22,16 @@ matrix: before_install: - eval "${ENV_EVAL}" -- if [ "$TRAVIS_OS_NAME" = "linux" ]; then . /opt/qt56/bin/qt56-env.sh; fi +- if [ "$TRAVIS_OS_NAME" = "linux" ]; then VALGRIND="valgrind $VALGRIND_OPTIONS"; . /opt/qt56/bin/qt56-env.sh; fi script: - mkdir build && cd build - cmake .. - cmake --build . --target all - cd .. -- qmake qmc-example.pro "CONFIG += debug" "QMAKE_CC = $CC" "QMAKE_CXX = $CXX" && make all -- if [ "$TRAVIS_OS_NAME" = "linux" ]; then valgrind --tool=memcheck --leak-check=yes --show-reachable=yes ./qmc-example "$QMC_TEST_USER" "$QMC_TEST_PWD" '#qmc-test:matrix.org'; fi +- qmake qmc-example.pro "CONFIG += debug" "CONFIG -= app_bundle" "QMAKE_CC = $CC" "QMAKE_CXX = $CXX" +- make all +- $VALGRIND ./qmc-example "$QMC_TEST_USER" "$QMC_TEST_PWD" '#qmc-test:matrix.org' notifications: webhooks: -- cgit v1.2.3 From fa5a91b92c3b397c2959c78aaa2fd023d0cfea2a Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Fri, 2 Mar 2018 20:47:48 +0900 Subject: ISSUE_TEMPLATE.md --- ISSUE_TEMPLATE.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 ISSUE_TEMPLATE.md diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..64a80350 --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,39 @@ + + +### Description + +Describe here the problem that you are experiencing, or the feature you are requesting. + +### Steps to reproduce + +- For bugs, list the steps +- that reproduce the bug +- using hyphens as bullet points + +Describe how what happens differs from what you expected. + +libqmatrixclient-based clients either have a log file or dump log to the standard output. +If you can identify any log snippets relevant to your issue, please include +those here (please be careful to remove any personal or private data): + +### Version information + + + +- **The client application**: +- **libqmatrixclient version if you know it**: +- **Qt version**: +- **Install method**: +- **Platform**: -- cgit v1.2.3 From 4916c0b65f8415db1e189e7a9963fce71d3b8b71 Mon Sep 17 00:00:00 2001 From: Roman Plášil Date: Thu, 1 Mar 2018 23:46:35 +0800 Subject: Improve compatibility with gcc 4.9 to be able to build for Android with QtCreator --- events/tagevent.cpp | 2 +- jobs/syncjob.cpp | 2 +- room.cpp | 18 +++++++++++++----- 3 files changed, 15 insertions(+), 7 deletions(-) diff --git a/events/tagevent.cpp b/events/tagevent.cpp index 886a10c6..c643ac62 100644 --- a/events/tagevent.cpp +++ b/events/tagevent.cpp @@ -44,7 +44,7 @@ QStringList TagEvent::tagNames() const QHash TagEvent::tags() const { QHash result; - auto allTags { tagsObject() }; + auto allTags = tagsObject(); for (auto it = allTags.begin(); it != allTags.end(); ++ it) result.insert(it.key(), TagRecord(it.value().toObject())); return result; diff --git a/jobs/syncjob.cpp b/jobs/syncjob.cpp index fd8bfc1a..6b3f3acf 100644 --- a/jobs/syncjob.cpp +++ b/jobs/syncjob.cpp @@ -68,7 +68,7 @@ BaseJob::Status SyncData::parseJson(const QJsonDocument &data) { QElapsedTimer et; et.start(); - auto json { data.object() }; + auto json = data.object(); nextBatch_ = json.value("next_batch").toString(); // TODO: presence accountData.fromJson(json); diff --git a/room.cpp b/room.cpp index ae3360dc..bbad694d 100644 --- a/room.cpp +++ b/room.cpp @@ -52,9 +52,19 @@ using namespace QMatrixClient; using namespace std::placeholders; +#if !(defined __GLIBCXX__ && __GLIBCXX__ <= 20150123) +using std::llround; +#endif enum EventsPlacement : int { Older = -1, Newer = 1 }; +// A workaround for MSVC 2015 that fails with "error C2440: 'return': +// cannot convert from 'initializer list' to 'QMatrixClient::FileTransferInfo'" +#if (defined(_MSC_VER) && _MSC_VER < 1910) || (defined(__GNUC__) && __GNUC__ <= 4) +# define WORKAROUND_EXTENDED_INITIALIZER_LIST +#endif + + class Room::Private { public: @@ -102,7 +112,7 @@ class Room::Private struct FileTransferPrivateInfo { -#if (defined(_MSC_VER) && _MSC_VER < 1910) || (defined(__GNUC__) && __GNUC__ <= 4) +#ifdef WORKAROUND_EXTENDED_INITIALIZER_LIST FileTransferPrivateInfo() = default; FileTransferPrivateInfo(BaseJob* j, QString fileName) : job(j), localFileInfo(fileName) @@ -647,13 +657,11 @@ FileTransferInfo Room::fileTransferInfo(const QString& id) const if (total > INT_MAX) { // JavaScript doesn't deal with 64-bit integers; scale down if necessary - progress = std::llround(double(progress) / total * INT_MAX); + progress = llround(double(progress) / total * INT_MAX); total = INT_MAX; } -#if (defined(_MSC_VER) && _MSC_VER < 1910) || (defined(__GNUC__) && __GNUC__ <= 4) - // A workaround for MSVC 2015 that fails with "error C2440: 'return': - // cannot convert from 'initializer list' to 'QMatrixClient::FileTransferInfo'" +#ifdef WORKAROUND_EXTENDED_INITIALIZER_LIST FileTransferInfo fti; fti.status = infoIt->status; fti.progress = int(progress); -- cgit v1.2.3 From 2e6585db10d905e4e7e93fc6765240789f43fdaa Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Sat, 3 Mar 2018 23:26:29 +0900 Subject: Caching: switching to binary JSON format; yield to event loop while making a cache payload --- connection.cpp | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/connection.cpp b/connection.cpp index 1c65d66f..ad893168 100644 --- a/connection.cpp +++ b/connection.cpp @@ -636,7 +636,7 @@ void Connection::setHomeserver(const QUrl& url) emit homeserverChanged(homeserver()); } -static constexpr int CACHE_VERSION_MAJOR = 3; +static constexpr int CACHE_VERSION_MAJOR = 4; static constexpr int CACHE_VERSION_MINOR = 0; void Connection::saveState(const QUrl &toFile) const @@ -666,12 +666,13 @@ void Connection::saveState(const QUrl &toFile) const { QJsonObject rooms; QJsonObject inviteRooms; - for (auto i : roomMap()) // Pass on rooms in Leave state + for (const auto* i : roomMap()) // Pass on rooms in Leave state { if (i->joinState() == JoinState::Invite) inviteRooms.insert(i->id(), i->toJson()); else rooms.insert(i->id(), i->toJson()); + QCoreApplication::instance()->processEvents(); } if (!rooms.isEmpty()) @@ -689,7 +690,7 @@ void Connection::saveState(const QUrl &toFile) const versionObj.insert("minor", CACHE_VERSION_MINOR); rootObj.insert("cache_version", versionObj); - QByteArray data = QJsonDocument(rootObj).toJson(QJsonDocument::Compact); + QByteArray data = QJsonDocument(rootObj).toBinaryData(); qCDebug(MAIN) << "Writing state to file" << outfile.fileName(); outfile.write(data.data(), data.size()); @@ -713,7 +714,7 @@ void Connection::loadState(const QUrl &fromFile) file.open(QFile::ReadOnly); QByteArray data = file.readAll(); - auto jsonDoc = QJsonDocument::fromJson(data); + auto jsonDoc = QJsonDocument::fromBinaryData(data); auto actualCacheVersionMajor = jsonDoc.object() .value("cache_version").toObject() -- cgit v1.2.3 From 9faea79681597a50e21abb8a530ef36e87391f31 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Sun, 4 Mar 2018 14:58:59 +0900 Subject: CMakeLists.txt: indent files with 4 spaces as everywhere else [skip ci] --- CMakeLists.txt | 54 +++++++++++++++++++++++++++--------------------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 709860e8..d7762e17 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -44,33 +44,33 @@ message( STATUS ) # Set up source files set(libqmatrixclient_SRCS - networkaccessmanager.cpp - connectiondata.cpp - connection.cpp - logging.cpp - room.cpp - user.cpp - avatar.cpp - settings.cpp - networksettings.cpp - events/event.cpp - events/eventcontent.cpp - events/roommessageevent.cpp - events/roommemberevent.cpp - events/roomavatarevent.cpp - events/typingevent.cpp - events/receiptevent.cpp - events/tagevent.cpp - jobs/requestdata.cpp - jobs/basejob.cpp - jobs/checkauthmethods.cpp - jobs/sendeventjob.cpp - jobs/setroomstatejob.cpp - jobs/joinroomjob.cpp - jobs/roommessagesjob.cpp - jobs/syncjob.cpp - jobs/mediathumbnailjob.cpp - jobs/downloadfilejob.cpp + networkaccessmanager.cpp + connectiondata.cpp + connection.cpp + logging.cpp + room.cpp + user.cpp + avatar.cpp + settings.cpp + networksettings.cpp + events/event.cpp + events/eventcontent.cpp + events/roommessageevent.cpp + events/roommemberevent.cpp + events/roomavatarevent.cpp + events/typingevent.cpp + events/receiptevent.cpp + events/tagevent.cpp + jobs/requestdata.cpp + jobs/basejob.cpp + jobs/checkauthmethods.cpp + jobs/sendeventjob.cpp + jobs/setroomstatejob.cpp + jobs/joinroomjob.cpp + jobs/roommessagesjob.cpp + jobs/syncjob.cpp + jobs/mediathumbnailjob.cpp + jobs/downloadfilejob.cpp ) aux_source_directory(jobs/generated libqmatrixclient_job_SRCS) -- cgit v1.2.3 From 2222bb226f43e9419c4a231c9f95da8466de4c0a Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Sun, 4 Mar 2018 15:00:32 +0900 Subject: QCoreApplication::processEvents() is static, doesn't need instance() Thanks to clang-tidy for spotting that. --- connection.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/connection.cpp b/connection.cpp index ad893168..f76d9fbe 100644 --- a/connection.cpp +++ b/connection.cpp @@ -274,7 +274,7 @@ void Connection::onSyncSuccess(SyncData &&data) { } if ( auto* r = provideRoom(roomData.roomId, roomData.joinState) ) r->updateData(std::move(roomData)); - QCoreApplication::instance()->processEvents(); + QCoreApplication::processEvents(); } } @@ -672,7 +672,7 @@ void Connection::saveState(const QUrl &toFile) const inviteRooms.insert(i->id(), i->toJson()); else rooms.insert(i->id(), i->toJson()); - QCoreApplication::instance()->processEvents(); + QCoreApplication::processEvents(); } if (!rooms.isEmpty()) -- cgit v1.2.3 From 5f346a377c6c2e1989c61ba62cc08e1629ab15f4 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Sun, 4 Mar 2018 15:21:25 +0900 Subject: Room::toJson(): Use QJsonObject/Array modern constructors; check execution time Now that we're on Qt 5.6 we can afford brace-initialization of those objects. --- room.cpp | 115 +++++++++++++++++++++++++++------------------------------------ 1 file changed, 49 insertions(+), 66 deletions(-) diff --git a/room.cpp b/room.cpp index bbad694d..cfa705bb 100644 --- a/room.cpp +++ b/room.cpp @@ -1572,87 +1572,67 @@ void Room::Private::updateDisplayname() emit q->displaynameChanged(q); } -template void appendStateEvent(QJsonArray& events, const QString& type, - const QString& name, const T& content) + const QJsonObject& content, const QString& stateKey = {}) { - if (content.isEmpty()) - return; - - QJsonObject contentObj; - contentObj.insert(name, content); - - QJsonObject eventObj; - eventObj.insert("type", type); - eventObj.insert("content", contentObj); - eventObj.insert("state_key", {}); // Mandatory for state events - - events.append(eventObj); + if (!content.isEmpty() || !stateKey.isEmpty()) + events.append(QJsonObject + { { QStringLiteral("type"), type } + , { QStringLiteral("content"), content } + , { QStringLiteral("state_key"), stateKey } + }); } +#define ADD_STATE_EVENT(events, type, name, content) \ + appendStateEvent((events), QStringLiteral(type), \ + {{ QStringLiteral(name), content }}); + QJsonObject Room::Private::toJson() const { + QElapsedTimer et; et.start(); QJsonObject result; { QJsonArray stateEvents; - appendStateEvent(stateEvents, "m.room.name", "name", name); - appendStateEvent(stateEvents, "m.room.topic", "topic", topic); - appendStateEvent(stateEvents, "m.room.avatar", "url", - avatar.url().toString()); - appendStateEvent(stateEvents, "m.room.aliases", "aliases", - QJsonArray::fromStringList(aliases)); - appendStateEvent(stateEvents, "m.room.canonical_alias", "alias", - canonicalAlias); + ADD_STATE_EVENT(stateEvents, "m.room.name", "name", name); + ADD_STATE_EVENT(stateEvents, "m.room.topic", "topic", topic); + ADD_STATE_EVENT(stateEvents, "m.room.avatar", "url", + avatar.url().toString()); + ADD_STATE_EVENT(stateEvents, "m.room.aliases", "aliases", + QJsonArray::fromStringList(aliases)); + ADD_STATE_EVENT(stateEvents, "m.room.canonical_alias", "alias", + canonicalAlias); for (const auto *m : membersMap) - { - QJsonObject content; - content.insert("membership", QStringLiteral("join")); - content.insert("displayname", m->name(q)); - content.insert("avatar_url", m->avatarUrl(q).toString()); - - QJsonObject memberEvent; - memberEvent.insert("type", QStringLiteral("m.room.member")); - memberEvent.insert("state_key", m->id()); - memberEvent.insert("content", content); - stateEvents.append(memberEvent); - } - - QJsonObject roomStateObj; - roomStateObj.insert("events", stateEvents); - - result.insert( - joinState == JoinState::Invite ? "invite_state" : "state", - roomStateObj); + appendStateEvent(stateEvents, QStringLiteral("m.room.member"), + { { QStringLiteral("membership"), QStringLiteral("join") } + , { QStringLiteral("displayname"), m->name(q) } + , { QStringLiteral("avatar_url"), m->avatarUrl(q).toString() } + }, m->id()); + + const auto stateObjName = joinState == JoinState::Invite ? + QStringLiteral("invite_state") : QStringLiteral("state"); + result.insert(stateObjName, + QJsonObject {{ QStringLiteral("events"), stateEvents }}); } if (!q->readMarkerEventId().isEmpty()) { - QJsonArray ephemeralEvents; - { - // Don't dump the timestamp because it's useless in the cache. - QJsonObject user; - user.insert(connection->userId(), {}); - - QJsonObject receipt; - receipt.insert("m.read", user); - - QJsonObject lastReadEvent; - lastReadEvent.insert(q->readMarkerEventId(), receipt); - lastReadEvent.insert("x-qmatrixclient.unread_messages", - unreadMessages); - - QJsonObject receiptsObj; - receiptsObj.insert("type", QStringLiteral("m.receipt")); - receiptsObj.insert("content", lastReadEvent); - ephemeralEvents.append(receiptsObj); - } - - QJsonObject ephemeralObj; - ephemeralObj.insert("events", ephemeralEvents); - - result.insert("ephemeral", ephemeralObj); + result.insert(QStringLiteral("ephemeral"), + QJsonObject {{ QStringLiteral("events"), + QJsonArray { QJsonObject( + { { QStringLiteral("type"), QStringLiteral("m.receipt") } + , { QStringLiteral("content"), QJsonObject( + { { q->readMarkerEventId(), + QJsonObject {{ QStringLiteral("m.read"), + QJsonObject {{ connection->userId(), {} }} }} + } + , { QStringLiteral("x-qmatrixclient.unread_messages"), + unreadMessages } + }) } + } + ) } + }}); } QJsonArray accountDataEvents; @@ -1668,7 +1648,7 @@ QJsonObject Room::Private::toJson() const }); } QJsonObject accountDataEventsObj; - result.insert("account_data", QJsonObject { {"events", accountDataEvents} }); + result.insert("account_data", QJsonObject {{ "events", accountDataEvents }}); QJsonObject unreadNotificationsObj; if (highlightCount > 0) @@ -1678,6 +1658,9 @@ QJsonObject Room::Private::toJson() const if (!unreadNotificationsObj.isEmpty()) result.insert("unread_notifications", unreadNotificationsObj); + if (et.elapsed() > 50) + qCDebug(PROFILER) << "Room::toJson() for" << displayname << "took" << et; + return result; } -- cgit v1.2.3 From fc4daac8862ad6a9824ec86628f222d74ce21201 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Sun, 4 Mar 2018 15:22:27 +0900 Subject: Connection: allow to choose between binary and text JSON cache --- README.md | 5 +++++ connection.cpp | 29 ++++++++++++++++++++--------- 2 files changed, 25 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index fc9ad5e0..dc6b22ca 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,8 @@ This will get you `debug/qmc-example` and `release/qmc-example` console executab ## Troubleshooting +#### Building fails + If `cmake` fails with... ``` CMake Warning at CMakeLists.txt:11 (find_package): @@ -85,3 +87,6 @@ where ``` QT_LOGGING_RULES="libqmatrixclient.*.debug=true,libqmatrixclient.jobs.debug=false" ``` + +#### Cache format +In case of troubles with room state and troubles with caching it may be useful to switch cache format from binary to JSON. To do that, set the following value in your client's configuration file/registry key (you might need to create the libqmatrixclient key for that): `libqmatrixclient/cache_type` to `json`. This will make cache saving and loading work slightly slower but the cache will be in a text JSON file (very long and unindented so prepare a good JSON viewer or text editor with JSON formatting capabilities). diff --git a/connection.cpp b/connection.cpp index f76d9fbe..c00a9b61 100644 --- a/connection.cpp +++ b/connection.cpp @@ -21,6 +21,7 @@ #include "user.h" #include "events/event.h" #include "room.h" +#include "settings.h" #include "jobs/generated/login.h" #include "jobs/generated/logout.h" #include "jobs/generated/receipts.h" @@ -68,6 +69,8 @@ class Connection::Private SyncJob* syncJob = nullptr; bool cacheState = true; + bool cacheToBinary = SettingsGroup("libqmatrixclient") + .value("cache_type").toString() != "json"; void connectWithToken(const QString& user, const QString& accessToken, const QString& deviceId); @@ -636,7 +639,7 @@ void Connection::setHomeserver(const QUrl& url) emit homeserverChanged(homeserver()); } -static constexpr int CACHE_VERSION_MAJOR = 4; +static constexpr int CACHE_VERSION_MAJOR = 5; static constexpr int CACHE_VERSION_MINOR = 0; void Connection::saveState(const QUrl &toFile) const @@ -690,11 +693,13 @@ void Connection::saveState(const QUrl &toFile) const versionObj.insert("minor", CACHE_VERSION_MINOR); rootObj.insert("cache_version", versionObj); - QByteArray data = QJsonDocument(rootObj).toBinaryData(); + QJsonDocument json { rootObj }; + auto data = d->cacheToBinary ? json.toBinaryData() : + json.toJson(QJsonDocument::Compact); + qCDebug(PROFILER) << "Cache for" << userId() << "generated in" << et; - qCDebug(MAIN) << "Writing state to file" << outfile.fileName(); outfile.write(data.data(), data.size()); - qCDebug(PROFILER) << "*** Cached state for" << userId() << "saved in" << et; + qCDebug(MAIN) << "State cache saved to" << outfile.fileName(); } void Connection::loadState(const QUrl &fromFile) @@ -714,17 +719,23 @@ void Connection::loadState(const QUrl &fromFile) file.open(QFile::ReadOnly); QByteArray data = file.readAll(); - auto jsonDoc = QJsonDocument::fromBinaryData(data); + QJsonParseError e; + auto jsonDoc = d->cacheToBinary ? QJsonDocument::fromBinaryData(data) : + QJsonDocument::fromJson(data, &e); + if (e.error == QJsonParseError::NoError) + { + qCWarning(MAIN) << "Cache file not found or broken, discarding"; + return; + } auto actualCacheVersionMajor = jsonDoc.object() .value("cache_version").toObject() .value("major").toInt(); if (actualCacheVersionMajor < CACHE_VERSION_MAJOR) { - qCWarning(MAIN) << "Major version of the cache file is" - << actualCacheVersionMajor << "but" - << CACHE_VERSION_MAJOR - << "required; discarding the cache"; + qCWarning(MAIN) + << "Major version of the cache file is" << actualCacheVersionMajor + << "but" << CACHE_VERSION_MAJOR << "required; discarding the cache"; return; } -- cgit v1.2.3 From ff85bba352ee23d6e2689804da40a9433a117e71 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 5 Mar 2018 10:22:00 +0900 Subject: Fix a typo leading to cache never working --- connection.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/connection.cpp b/connection.cpp index c00a9b61..a57bd8b4 100644 --- a/connection.cpp +++ b/connection.cpp @@ -722,7 +722,7 @@ void Connection::loadState(const QUrl &fromFile) QJsonParseError e; auto jsonDoc = d->cacheToBinary ? QJsonDocument::fromBinaryData(data) : QJsonDocument::fromJson(data, &e); - if (e.error == QJsonParseError::NoError) + if (e.error != QJsonParseError::NoError) { qCWarning(MAIN) << "Cache file not found or broken, discarding"; return; -- cgit v1.2.3 From 089a23093dd8e73b4e1e5b1a2aa3935028066faa Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Sun, 4 Mar 2018 18:44:47 +0900 Subject: simplestateevents.h: minor tweaks --- events/simplestateevents.h | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/events/simplestateevents.h b/events/simplestateevents.h index d5841bdc..6b0cd51a 100644 --- a/events/simplestateevents.h +++ b/events/simplestateevents.h @@ -19,36 +19,35 @@ #pragma once #include "event.h" - #include "eventcontent.h" namespace QMatrixClient { -#define DECLARE_SIMPLE_STATE_EVENT(_Name, _TypeId, _EnumType, _ContentType, _ContentKey) \ +#define DEFINE_SIMPLE_STATE_EVENT(_Name, _TypeId, _EnumType, _ContentType, _ContentKey) \ class _Name \ : public StateEvent> \ { \ public: \ static constexpr const char* TypeId = _TypeId; \ explicit _Name(const QJsonObject& obj) \ - : StateEvent(_EnumType, obj, #_ContentKey) \ + : StateEvent(_EnumType, obj, QStringLiteral(#_ContentKey)) \ { } \ template \ explicit _Name(T&& value) \ - : StateEvent(_EnumType, #_ContentKey, \ + : StateEvent(_EnumType, QStringLiteral(#_ContentKey), \ std::forward(value)) \ { } \ - _ContentType _ContentKey() const { return content().value; } \ + const _ContentType& _ContentKey() const { return content().value; } \ }; - DECLARE_SIMPLE_STATE_EVENT(RoomNameEvent, "m.room.name", - Event::Type::RoomName, QString, name) - DECLARE_SIMPLE_STATE_EVENT(RoomAliasesEvent, "m.room.aliases", - Event::Type::RoomAliases, QStringList, aliases) - DECLARE_SIMPLE_STATE_EVENT(RoomCanonicalAliasEvent, "m.room.canonical_alias", - Event::Type::RoomCanonicalAlias, QString, alias) - DECLARE_SIMPLE_STATE_EVENT(RoomTopicEvent, "m.room.topic", - Event::Type::RoomTopic, QString, topic) - DECLARE_SIMPLE_STATE_EVENT(EncryptionEvent, "m.room.encryption", - Event::Type::RoomEncryption, QString, algorithm) + DEFINE_SIMPLE_STATE_EVENT(RoomNameEvent, "m.room.name", + Event::Type::RoomName, QString, name) + DEFINE_SIMPLE_STATE_EVENT(RoomAliasesEvent, "m.room.aliases", + Event::Type::RoomAliases, QStringList, aliases) + DEFINE_SIMPLE_STATE_EVENT(RoomCanonicalAliasEvent, "m.room.canonical_alias", + Event::Type::RoomCanonicalAlias, QString, alias) + DEFINE_SIMPLE_STATE_EVENT(RoomTopicEvent, "m.room.topic", + Event::Type::RoomTopic, QString, topic) + DEFINE_SIMPLE_STATE_EVENT(EncryptionEvent, "m.room.encryption", + Event::Type::RoomEncryption, QString, algorithm) } // namespace QMatrixClient -- cgit v1.2.3 From 1edfe9d82ea9d9a50645d419c736db45bf940978 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Tue, 27 Feb 2018 20:14:47 +0900 Subject: jobs/generated: SetAccountDataJob, SetAccountDataPerRoomJob --- jobs/generated/account-data.cpp | 28 ++++++++++++++++++++++++++++ jobs/generated/account-data.h | 27 +++++++++++++++++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 jobs/generated/account-data.cpp create mode 100644 jobs/generated/account-data.h diff --git a/jobs/generated/account-data.cpp b/jobs/generated/account-data.cpp new file mode 100644 index 00000000..35ee94c0 --- /dev/null +++ b/jobs/generated/account-data.cpp @@ -0,0 +1,28 @@ +/****************************************************************************** + * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN + */ + +#include "account-data.h" + +#include "converters.h" + +#include + +using namespace QMatrixClient; + +static const auto basePath = QStringLiteral("/_matrix/client/r0"); + +SetAccountDataJob::SetAccountDataJob(const QString& userId, const QString& type, const QJsonObject& content) + : BaseJob(HttpVerb::Put, "SetAccountDataJob", + basePath % "/user/" % userId % "/account_data/" % type) +{ + setRequestData(Data(content)); +} + +SetAccountDataPerRoomJob::SetAccountDataPerRoomJob(const QString& userId, const QString& roomId, const QString& type, const QJsonObject& content) + : BaseJob(HttpVerb::Put, "SetAccountDataPerRoomJob", + basePath % "/user/" % userId % "/rooms/" % roomId % "/account_data/" % type) +{ + setRequestData(Data(content)); +} + diff --git a/jobs/generated/account-data.h b/jobs/generated/account-data.h new file mode 100644 index 00000000..69ad9fb4 --- /dev/null +++ b/jobs/generated/account-data.h @@ -0,0 +1,27 @@ +/****************************************************************************** + * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN + */ + +#pragma once + +#include "../basejob.h" + +#include + + +namespace QMatrixClient +{ + // Operations + + class SetAccountDataJob : public BaseJob + { + public: + explicit SetAccountDataJob(const QString& userId, const QString& type, const QJsonObject& content = {}); + }; + + class SetAccountDataPerRoomJob : public BaseJob + { + public: + explicit SetAccountDataPerRoomJob(const QString& userId, const QString& roomId, const QString& type, const QJsonObject& content = {}); + }; +} // namespace QMatrixClient -- cgit v1.2.3 From bc08637eaaf25fb83b685e48e86553d3edacc09a Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Sun, 4 Mar 2018 18:00:05 +0900 Subject: converters.h: pass QJsonValue by reference; add support of QHash --- converters.h | 56 +++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 39 insertions(+), 17 deletions(-) diff --git a/converters.h b/converters.h index 00d1d339..96efe5f8 100644 --- a/converters.h +++ b/converters.h @@ -46,17 +46,22 @@ namespace QMatrixClient inline QJsonValue toJson(const QByteArray& bytes) { -#if QT_VERSION < QT_VERSION_CHECK(5, 3, 0) - return QJsonValue(QLatin1String(bytes.constData())); -#else return QJsonValue(bytes.constData()); -#endif + } + + template + inline QJsonValue toJson(const QHash& hashMap) + { + QJsonObject json; + for (auto it = hashMap.begin(); it != hashMap.end(); ++it) + json.insert(it.key(), toJson(it.value())); + return json; } template struct FromJson { - T operator()(QJsonValue jv) const { return static_cast(jv); } + T operator()(const QJsonValue& jv) const { return static_cast(jv); } }; template @@ -67,32 +72,32 @@ namespace QMatrixClient template <> struct FromJson { - bool operator()(QJsonValue jv) const { return jv.toBool(); } + bool operator()(const QJsonValue& jv) const { return jv.toBool(); } }; template <> struct FromJson { - int operator()(QJsonValue jv) const { return jv.toInt(); } + int operator()(const QJsonValue& jv) const { return jv.toInt(); } }; template <> struct FromJson { - double operator()(QJsonValue jv) const { return jv.toDouble(); } + double operator()(const QJsonValue& jv) const { return jv.toDouble(); } }; template <> struct FromJson { - qint64 operator()(QJsonValue jv) const { return qint64(jv.toDouble()); } + qint64 operator()(const QJsonValue& jv) const { return qint64(jv.toDouble()); } }; template <> struct FromJson { - QString operator()(QJsonValue jv) const { return jv.toString(); } + QString operator()(const QJsonValue& jv) const { return jv.toString(); } }; template <> struct FromJson { - QDateTime operator()(QJsonValue jv) const + QDateTime operator()(const QJsonValue& jv) const { return QDateTime::fromMSecsSinceEpoch(fromJson(jv), Qt::UTC); } @@ -100,7 +105,7 @@ namespace QMatrixClient template <> struct FromJson { - QDate operator()(QJsonValue jv) const + QDate operator()(const QJsonValue& jv) const { return fromJson(jv).date(); } @@ -108,17 +113,23 @@ namespace QMatrixClient template <> struct FromJson { - QJsonObject operator()(QJsonValue jv) const { return jv.toObject(); } + QJsonObject operator()(const QJsonValue& jv) const + { + return jv.toObject(); + } }; template <> struct FromJson { - QJsonArray operator()(QJsonValue jv) const { return jv.toArray(); } + QJsonArray operator()(const QJsonValue& jv) const + { + return jv.toArray(); + } }; template struct FromJson> { - QVector operator()(QJsonValue jv) const + QVector operator()(const QJsonValue& jv) const { const auto jsonArray = jv.toArray(); QVector vect; vect.resize(jsonArray.size()); @@ -130,7 +141,7 @@ namespace QMatrixClient template struct FromJson> { - QList operator()(QJsonValue jv) const + QList operator()(const QJsonValue& jv) const { const auto jsonArray = jv.toArray(); QList sl; sl.reserve(jsonArray.size()); @@ -144,10 +155,21 @@ namespace QMatrixClient template <> struct FromJson { - QByteArray operator()(QJsonValue jv) const + inline QByteArray operator()(const QJsonValue& jv) const { return fromJson(jv).toLatin1(); } }; + template struct FromJson> + { + QHash operator()(const QJsonValue& jv) const + { + const auto json = jv.toObject(); + QHash h; h.reserve(json.size()); + for (auto it = json.begin(); it != json.end(); ++it) + h.insert(it.key(), fromJson(it.value())); + return h; + } + }; } // namespace QMatrixClient -- cgit v1.2.3 From 0be3571d7c96e3df7ec523217e02d58850c7fe73 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 5 Mar 2018 10:08:30 +0900 Subject: Support saving account data on the server Closes #152. Saving of specific event types should be added separately. --- room.cpp | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/room.cpp b/room.cpp index cfa705bb..e03a2b5b 100644 --- a/room.cpp +++ b/room.cpp @@ -24,6 +24,7 @@ #include "jobs/generated/leaving.h" #include "jobs/generated/receipts.h" #include "jobs/generated/redaction.h" +#include "jobs/generated/account-data.h" #include "jobs/setroomstatejob.h" #include "events/simplestateevents.h" #include "events/roomavatarevent.h" @@ -202,6 +203,13 @@ class Room::Private */ void processRedaction(RoomEventPtr redactionEvent); + template + SetAccountDataPerRoomJob* setAccountData(const EvT& event) + { + return connection->callApi( + connection->userId(), id, EvT::typeId(), event.toJson()); + } + QJsonObject toJson() const; private: -- cgit v1.2.3 From 9057fc02b06bdd3e38e9cf39e68287e02d58596b Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 5 Mar 2018 13:17:27 +0900 Subject: Use constants instead of hardcoded strings --- connection.cpp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/connection.cpp b/connection.cpp index a57bd8b4..80685dd1 100644 --- a/connection.cpp +++ b/connection.cpp @@ -539,12 +539,12 @@ QHash> Connection::tagsToRooms() const QStringList Connection::tagNames() const { - QStringList tags ({"m.favourite"}); + QStringList tags ({FavouriteTag}); for (auto* r: d->roomMap) for (const auto& tag: r->tagNames()) - if (tag != "m.lowpriority" && !tags.contains(tag)) + if (tag != LowPriorityTag && !tags.contains(tag)) tags.push_back(tag); - tags.push_back("m.lowpriority"); + tags.push_back(LowPriorityTag); return tags; } -- cgit v1.2.3 From 6ea1fb621488910de055bd3af4d00343a763541a Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 5 Mar 2018 10:16:20 +0900 Subject: ReadMarkerEvent; TagEvent remade with less boilerplate code tagevent.h -> accountdataevents.h now has a macro to define more simplistic events along the lines of simplestateevents.h but inheriting from Event instead. TagEvent and ReadMarkerEvent(m.fully_read) are defined using this macro. ReadMarkerEvent is also wired through event.* (but not further yet). --- CMakeLists.txt | 1 - events/accountdataevents.h | 78 ++++++++++++++++++++++++++++++++++++++++++++++ events/event.cpp | 5 +-- events/event.h | 2 +- events/tagevent.cpp | 71 ----------------------------------------- events/tagevent.h | 74 ------------------------------------------- libqmatrixclient.pri | 3 +- room.cpp | 36 ++++++++++++++------- room.h | 10 +++--- 9 files changed, 112 insertions(+), 168 deletions(-) create mode 100644 events/accountdataevents.h delete mode 100644 events/tagevent.cpp delete mode 100644 events/tagevent.h diff --git a/CMakeLists.txt b/CMakeLists.txt index d7762e17..e95c72d0 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -60,7 +60,6 @@ set(libqmatrixclient_SRCS events/roomavatarevent.cpp events/typingevent.cpp events/receiptevent.cpp - events/tagevent.cpp jobs/requestdata.cpp jobs/basejob.cpp jobs/checkauthmethods.cpp diff --git a/events/accountdataevents.h b/events/accountdataevents.h new file mode 100644 index 00000000..78cf9c46 --- /dev/null +++ b/events/accountdataevents.h @@ -0,0 +1,78 @@ +#include + +/****************************************************************************** + * Copyright (C) 2018 Kitsune Ral + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#pragma once + +#include "event.h" +#include "eventcontent.h" + +namespace QMatrixClient +{ + static constexpr const char* FavouriteTag = "m.favourite"; + static constexpr const char* LowPriorityTag = "m.lowpriority"; + + struct TagRecord + { + TagRecord (QString order) : order(std::move(order)) { } + explicit TagRecord(const QJsonValue& jv = {}) + : order(jv.toObject().value("order").toString()) + { } + + QString order; + + bool operator==(const TagRecord& other) const + { return order == other.order; } + bool operator!=(const TagRecord& other) const + { return !operator==(other); } + }; + + inline QJsonValue toJson(const TagRecord& rec) + { + return QJsonObject {{ QStringLiteral("order"), rec.order }}; + } + + using TagsMap = QHash; + +#define DEFINE_SIMPLE_EVENT(_Name, _TypeId, _EnumType, _ContentType, _ContentKey) \ + class _Name : public Event \ + { \ + public: \ + static constexpr const char* TypeId = _TypeId; \ + static const char* typeId() { return TypeId; } \ + explicit _Name(const QJsonObject& obj) \ + : Event((_EnumType), obj) \ + , _content(contentJson(), QStringLiteral(#_ContentKey)) \ + { } \ + template \ + explicit _Name(Ts&&... contentArgs) \ + : Event(_EnumType) \ + , _content(QStringLiteral(#_ContentKey), \ + std::forward(contentArgs)...) \ + { } \ + const _ContentType& _ContentKey() const { return _content.value; } \ + QJsonObject toJson() const { return _content.toJson(); } \ + protected: \ + EventContent::SimpleContent<_ContentType> _content; \ + }; + + DEFINE_SIMPLE_EVENT(TagEvent, "m.tag", EventType::Tag, TagsMap, tags) + DEFINE_SIMPLE_EVENT(ReadMarkerEvent, "m.fully_read", EventType::ReadMarker, + QString, event_id) +} diff --git a/events/event.cpp b/events/event.cpp index 74a2c3d7..f3e965e2 100644 --- a/events/event.cpp +++ b/events/event.cpp @@ -24,7 +24,7 @@ #include "roomavatarevent.h" #include "typingevent.h" #include "receiptevent.h" -#include "tagevent.h" +#include "accountdataevents.h" #include "redactionevent.h" #include "logging.h" @@ -88,7 +88,8 @@ EventPtr _impl::doMakeEvent(const QJsonObject& obj) return EventPtr(move(e)); return EventPtr { makeIfMatches(obj, obj["type"].toString()) }; + TypingEvent, ReceiptEvent, TagEvent, ReadMarkerEvent>( + obj, obj["type"].toString()) }; } RoomEvent::RoomEvent(Event::Type type) : Event(type) { } diff --git a/events/event.h b/events/event.h index f0ca2d15..eccfec41 100644 --- a/events/event.h +++ b/events/event.h @@ -45,7 +45,7 @@ namespace QMatrixClient enum class Type : quint16 { Unknown = 0, - Typing, Receipt, Tag, DirectChat, + Typing, Receipt, Tag, DirectChat, ReadMarker, RoomEventBase = 0x1000, RoomMessage = RoomEventBase + 1, RoomEncryptedMessage, Redaction, diff --git a/events/tagevent.cpp b/events/tagevent.cpp deleted file mode 100644 index c643ac62..00000000 --- a/events/tagevent.cpp +++ /dev/null @@ -1,71 +0,0 @@ -/****************************************************************************** - * Copyright (C) 2018 Kitsune Ral - * - * 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 "tagevent.h" - -using namespace QMatrixClient; - -TagRecord::TagRecord(const QJsonObject& json) - : order(json.value("order").toString()) -{ } - -TagEvent::TagEvent() - : Event(Type::Tag) -{ - // TODO: Support getting a list of tags and saving it -} - -TagEvent::TagEvent(const QJsonObject& obj) - : Event(Type::Tag, obj) -{ - Q_ASSERT(obj["type"].toString() == TypeId); -} - -QStringList TagEvent::tagNames() const -{ - return tagsObject().keys(); -} - -QHash TagEvent::tags() const -{ - QHash result; - auto allTags = tagsObject(); - for (auto it = allTags.begin(); it != allTags.end(); ++ it) - result.insert(it.key(), TagRecord(it.value().toObject())); - return result; -} - -bool TagEvent::empty() const -{ - return tagsObject().empty(); -} - -bool TagEvent::contains(const QString& name) const -{ - return tagsObject().contains(name); -} - -TagRecord TagEvent::recordForTag(const QString& name) const -{ - return TagRecord(tagsObject().value(name).toObject()); -} - -QJsonObject TagEvent::tagsObject() const -{ - return contentJson().value("tags").toObject(); -} diff --git a/events/tagevent.h b/events/tagevent.h deleted file mode 100644 index 26fe8788..00000000 --- a/events/tagevent.h +++ /dev/null @@ -1,74 +0,0 @@ -/****************************************************************************** - * Copyright (C) 2018 Kitsune Ral - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - */ - -#pragma once - -#include "event.h" - -namespace QMatrixClient -{ - static constexpr const char* FavouriteTag = "m.favourite"; - static constexpr const char* LowPriorityTag = "m.lowpriority"; - - struct TagRecord - { - explicit TagRecord(const QJsonObject& json = {}); - - QString order; - }; - - class TagEvent : public Event - { - public: - TagEvent(); - explicit TagEvent(const QJsonObject& obj); - - /** Get the list of tag names */ - QStringList tagNames() const; - - /** Get the list of tags along with information on each */ - QHash tags() const; - - /** Check if the event lists no tags */ - bool empty() const; - - /** Check whether the tags list contains the specified name */ - bool contains(const QString& name) const; - - /** Get the record for the given tag name */ - TagRecord recordForTag(const QString& name) const; - - /** Get the whole tags content as a JSON object - * It's NOT recommended to use this method directly from client code. - * Use other convenience methods provided by the class. - */ - QJsonObject tagsObject() const; - - static constexpr const char * TypeId = "m.tag"; - }; - - using TagEventPtr = event_ptr_tt; - - inline QJsonValue toJson(const TagEventPtr& tagEvent) - { - return QJsonObject {{ "type", "m.tag" }, - // TODO: Replace tagsObject() with a genuine list of tags - // (or make the needed JSON upon TagEvent creation) - { "content", QJsonObject {{ "tags", tagEvent->tagsObject() }} }}; - } -} diff --git a/libqmatrixclient.pri b/libqmatrixclient.pri index 7cfa94a1..c7b95617 100644 --- a/libqmatrixclient.pri +++ b/libqmatrixclient.pri @@ -24,7 +24,7 @@ HEADERS += \ $$PWD/events/roomavatarevent.h \ $$PWD/events/typingevent.h \ $$PWD/events/receiptevent.h \ - $$PWD/events/tagevent.h \ + $$PWD/events/accountdataevents.h \ $$PWD/events/redactionevent.h \ $$PWD/jobs/requestdata.h \ $$PWD/jobs/basejob.h \ @@ -56,7 +56,6 @@ SOURCES += \ $$PWD/events/roommemberevent.cpp \ $$PWD/events/typingevent.cpp \ $$PWD/events/receiptevent.cpp \ - $$PWD/events/tagevent.cpp \ $$PWD/jobs/requestdata.cpp \ $$PWD/jobs/basejob.cpp \ $$PWD/jobs/checkauthmethods.cpp \ diff --git a/room.cpp b/room.cpp index e03a2b5b..971e4121 100644 --- a/room.cpp +++ b/room.cpp @@ -65,7 +65,6 @@ enum EventsPlacement : int { Older = -1, Newer = 1 }; # define WORKAROUND_EXTENDED_INITIALIZER_LIST #endif - class Room::Private { public: @@ -106,7 +105,7 @@ class Room::Private QString firstDisplayedEventId; QString lastDisplayedEventId; QHash lastReadEventIds; - TagEventPtr tags = std::make_unique(); + TagsMap tags; QHash accountData; QString prevBatch; QPointer roomMessagesJob; @@ -574,27 +573,36 @@ void Room::resetHighlightCount() QStringList Room::tagNames() const { - return d->tags->tagNames(); + return d->tags.keys(); } -QHash Room::tags() const +TagsMap Room::tags() const { - return d->tags->tags(); + return d->tags; } TagRecord Room::tag(const QString& name) const { - return d->tags->recordForTag(name); + return d->tags.value(name); +} + +void Room::setTags(const TagsMap& newTags) +{ + if (newTags == d->tags) + return; + d->tags = newTags; + d->setAccountData(TagEvent(d->tags)); + emit tagsChanged(); } bool Room::isFavourite() const { - return d->tags->contains(FavouriteTag); + return d->tags.contains(FavouriteTag); } bool Room::isLowPriority() const { - return d->tags->contains(LowPriorityTag); + return d->tags.contains(LowPriorityTag); } const RoomMessageEvent* @@ -1485,13 +1493,19 @@ void Room::processAccountDataEvent(EventPtr event) switch (event->type()) { case EventType::Tag: - d->tags.reset(static_cast(event.release())); + { + auto newTags = static_cast(event.get())->tags(); + if (newTags == d->tags) + break; + d->tags = newTags; qCDebug(MAIN) << "Room" << id() << "is tagged with: " << tagNames().join(", "); emit tagsChanged(); break; + } default: - d->accountData[event->jsonType()] = event->contentJson().toVariantHash(); + d->accountData[event->jsonType()] = + event->contentJson().toVariantHash(); } } @@ -1644,7 +1658,7 @@ QJsonObject Room::Private::toJson() const } QJsonArray accountDataEvents; - if (!tags->empty()) + if (!tags.empty()) accountDataEvents.append(QMatrixClient::toJson(tags)); if (!accountData.empty()) diff --git a/room.h b/room.h index 71d5c433..bdd11452 100644 --- a/room.h +++ b/room.h @@ -20,13 +20,9 @@ #include "jobs/syncjob.h" #include "events/roommessageevent.h" -#include "events/tagevent.h" +#include "events/accountdataevents.h" #include "joinstate.h" -#include -#include -#include -#include #include #include @@ -241,9 +237,11 @@ namespace QMatrixClient Q_INVOKABLE void resetHighlightCount(); QStringList tagNames() const; - QHash tags() const; + TagsMap tags() const; TagRecord tag(const QString& name) const; + void setTags(const TagsMap& newTags); + /** Check whether the list of tags has m.favourite */ bool isFavourite() const; /** Check whether the list of tags has m.lowpriority */ -- cgit v1.2.3 From fcf335e202a49c62be29566daf233866cd2f3584 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 5 Mar 2018 13:18:37 +0900 Subject: Room::toJson(): Fix caching of tags --- room.cpp | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/room.cpp b/room.cpp index 971e4121..86d1e6cd 100644 --- a/room.cpp +++ b/room.cpp @@ -1659,7 +1659,10 @@ QJsonObject Room::Private::toJson() const QJsonArray accountDataEvents; if (!tags.empty()) - accountDataEvents.append(QMatrixClient::toJson(tags)); + accountDataEvents.append(QJsonObject( + { { QStringLiteral("type"), QStringLiteral("m.tag") } + , { QStringLiteral("content"), TagEvent(tags).toJson() } + })); if (!accountData.empty()) { -- cgit v1.2.3 From f9cd6410623b7ddebf97e248584d1a8e838b4da8 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 5 Mar 2018 11:44:00 +0900 Subject: Room: addTag() and removeTag() Slightly changed TagRecord constructors to match. --- events/accountdataevents.h | 4 ++-- room.cpp | 20 ++++++++++++++++++++ room.h | 19 +++++++++++++++++++ 3 files changed, 41 insertions(+), 2 deletions(-) diff --git a/events/accountdataevents.h b/events/accountdataevents.h index 78cf9c46..f3ba27bb 100644 --- a/events/accountdataevents.h +++ b/events/accountdataevents.h @@ -30,8 +30,8 @@ namespace QMatrixClient struct TagRecord { - TagRecord (QString order) : order(std::move(order)) { } - explicit TagRecord(const QJsonValue& jv = {}) + TagRecord (QString order = {}) : order(std::move(order)) { } + explicit TagRecord(const QJsonValue& jv) : order(jv.toObject().value("order").toString()) { } diff --git a/room.cpp b/room.cpp index 86d1e6cd..cb94ddb6 100644 --- a/room.cpp +++ b/room.cpp @@ -586,6 +586,26 @@ TagRecord Room::tag(const QString& name) const return d->tags.value(name); } +void Room::addTag(const QString& name, const TagRecord& record) +{ + if (d->tags.contains(name)) + return; + + d->tags.insert(name, record); + d->setAccountData(TagEvent(d->tags)); + emit tagsChanged(); +} + +void Room::removeTag(const QString& name) +{ + if (!d->tags.contains(name)) + return; + + d->tags.remove(name); + d->setAccountData(TagEvent(d->tags)); + emit tagsChanged(); +} + void Room::setTags(const TagsMap& newTags) { if (newTags == d->tags) diff --git a/room.h b/room.h index bdd11452..0eb5ecc3 100644 --- a/room.h +++ b/room.h @@ -240,6 +240,25 @@ namespace QMatrixClient TagsMap tags() const; TagRecord tag(const QString& name) const; + /** Add a new tag to this room + * If this room already has this tag, nothing happens. If it's a new + * tag for the room, the respective tag record is added to the set + * of tags and the new set is sent to the server to update other + * clients. + */ + void addTag(const QString& name, const TagRecord& record = {}); + + /** Remove a tag from the room */ + void removeTag(const QString& name); + + /** Overwrite the room's tags + * This completely replaces the existing room's tags with a set + * of new ones and updates the new set on the server. Unlike + * most other methods in Room, this one sends a signal about changes + * immediately, not waiting for confirmation from the server + * (because tags are saved in account data rather than in shared + * room state). + */ void setTags(const TagsMap& newTags); /** Check whether the list of tags has m.favourite */ -- cgit v1.2.3 From 2e7627528308da7629f1293757de2fb4bb22a7ad Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 5 Mar 2018 16:12:47 +0900 Subject: qmc-example: tests for redaction and tagging; send origin in test messages --- .travis.yml | 2 +- examples/qmc-example.cpp | 108 +++++++++++++++++++++++++++++++++++++++-------- 2 files changed, 91 insertions(+), 19 deletions(-) diff --git a/.travis.yml b/.travis.yml index 001ba11f..c9002c13 100644 --- a/.travis.yml +++ b/.travis.yml @@ -31,7 +31,7 @@ script: - cd .. - qmake qmc-example.pro "CONFIG += debug" "CONFIG -= app_bundle" "QMAKE_CC = $CC" "QMAKE_CXX = $CXX" - make all -- $VALGRIND ./qmc-example "$QMC_TEST_USER" "$QMC_TEST_PWD" '#qmc-test:matrix.org' +- $VALGRIND ./qmc-example "$QMC_TEST_USER" "$QMC_TEST_PWD" '#qmc-test:matrix.org' "Travis CI job $TRAVIS_JOB_NUMBER" notifications: webhooks: diff --git a/examples/qmc-example.cpp b/examples/qmc-example.cpp index e0aabca9..f63b32a2 100644 --- a/examples/qmc-example.cpp +++ b/examples/qmc-example.cpp @@ -2,18 +2,68 @@ #include "connection.h" #include "room.h" #include "user.h" +#include "jobs/sendeventjob.h" #include #include +#include #include using namespace QMatrixClient; using std::cout; using std::endl; -using std::bind; using namespace std::placeholders; -void onNewRoom(Room* r, const char* targetRoomName) +static int semaphor = 0; +static Room* targetRoom = nullptr; + +#define QMC_CHECK(origin, description, condition) \ + cout << (description) \ + << (!!(condition) ? " successul" : " FAILED") << endl; \ + targetRoom->postMessage(QString(origin) % ": " % QStringLiteral(description) % \ + (!!(condition) ? QStringLiteral(" successful") : \ + QStringLiteral(" FAILED")), MessageEventType::Notice) + +void addAndRemoveTag(const char* origin) +{ + ++semaphor; + static const auto TestTag = QStringLiteral("org.qmatrixclient.test"); + QObject::connect(targetRoom, &Room::tagsChanged, targetRoom, [=] { + cout << "Room " << targetRoom->id().toStdString() + << ", tag(s) changed:" << endl + << " " << targetRoom->tagNames().join(", ").toStdString() << endl; + if (targetRoom->tags().contains(TestTag)) + { + targetRoom->removeTag(TestTag); + QMC_CHECK(origin, "Tagging test", + !targetRoom->tags().contains(TestTag)); + --semaphor; + QObject::disconnect(targetRoom, &Room::tagsChanged, nullptr, nullptr); + } + }); + // The reverse order because tagsChanged is emitted synchronously. + targetRoom->addTag(TestTag); +} + +void sendAndRedact(const char* origin) +{ + ++semaphor; + auto* job = targetRoom->connection()->callApi(targetRoom->id(), + RoomMessageEvent("Message to redact")); + QObject::connect(job, &BaseJob::success, targetRoom, [job] { + targetRoom->redactEvent(job->eventId(), "qmc-example"); + }); + QObject::connect(targetRoom, &Room::replacedEvent, targetRoom, + [=] (const RoomEvent* newEvent) { + QMC_CHECK(origin, "Redaction", newEvent->isRedacted() && + newEvent->redactionReason() == "qmc-example"); + --semaphor; + QObject::disconnect(targetRoom, &Room::replacedEvent, + nullptr, nullptr); + }); +} + +void onNewRoom(Room* r, const char* targetRoomName, const char* origin) { cout << "New room: " << r->id().toStdString() << endl; QObject::connect(r, &Room::namesChanged, [=] { @@ -24,11 +74,15 @@ void onNewRoom(Room* r, const char* targetRoomName) if (targetRoomName && (r->name() == targetRoomName || r->canonicalAlias() == targetRoomName)) { - r->postMessage( - "This is a test message from an example application\n" - "The current user is " % r->localUser()->fullName(r) % "\n" % - QStringLiteral("This room has %1 member(s)") - .arg(r->memberCount()) % "\n" % + cout << "Found the target room, proceeding for tests" << endl; + targetRoom = r; + addAndRemoveTag(origin); + sendAndRedact(origin); + targetRoom->postMessage( + "This is a test notice from an example application\n" + "Origin: " % QString(origin) % "\n" + "The current user is " % + targetRoom->localUser()->fullName(targetRoom) % "\n" % // "The room is " % // (r->isDirectChat() ? "" : "not ") % "a direct chat\n" % "Have a good day", @@ -36,11 +90,7 @@ void onNewRoom(Room* r, const char* targetRoomName) ); } }); - QObject::connect(r, &Room::tagsChanged, [=] { - cout << "Room " << r->id().toStdString() << ", tag(s) changed:" << endl - << " " << r->tagNames().join(", ").toStdString() << endl << endl; - }); - QObject::connect(r, &Room::aboutToAddNewMessages, [=] (RoomEventsRange timeline) { + QObject::connect(r, &Room::aboutToAddNewMessages, [r] (RoomEventsRange timeline) { cout << timeline.size() << " new event(s) in room " << r->id().toStdString() << endl; // for (const auto& item: timeline) @@ -56,13 +106,15 @@ void onNewRoom(Room* r, const char* targetRoomName) void finalize(Connection* conn) { + if (semaphor) + cout << "One or more tests FAILED" << endl; cout << "Logging out" << endl; conn->logout(); QObject::connect(conn, &Connection::loggedOut, QCoreApplication::instance(), [conn] { conn->deleteLater(); - QCoreApplication::instance()->processEvents(); - QCoreApplication::instance()->quit(); + QCoreApplication::processEvents(); + QCoreApplication::exit(semaphor); }); } @@ -83,10 +135,30 @@ int main(int argc, char* argv[]) }); const char* targetRoomName = argc >= 4 ? argv[3] : nullptr; if (targetRoomName) - cout << "Target room name: " << targetRoomName; + cout << "Target room name: " << targetRoomName << endl; + const char* origin = argc >= 5 ? argv[4] : nullptr; + if (origin) + cout << "Origin for the test message: " << origin << endl; QObject::connect(conn, &Connection::newRoom, - bind(onNewRoom, _1, targetRoomName)); - QObject::connect(conn, &Connection::syncDone, - bind(finalize, conn)); + [=](Room* room) { onNewRoom(room, targetRoomName, origin); }); + QObject::connect(conn, &Connection::syncDone, conn, [conn] { + cout << "Sync complete, " << semaphor << " tests in the air" << endl; + if (semaphor) + conn->sync(10000); + else + { + if (targetRoom) + { + auto j = conn->callApi(targetRoom->id(), + RoomMessageEvent("All tests finished")); + QObject::connect(j, &BaseJob::finished, + conn, [conn] { finalize(conn); }); + } + else + finalize(conn); + } + }); + // Big red countdown + QTimer::singleShot(180000, conn, [conn] { finalize(conn); }); return app.exec(); } -- cgit v1.2.3 From 5c4238d43acfd5bbd5d3c387a4705348de490fe0 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 5 Mar 2018 18:27:51 +0900 Subject: qmc-example: Rewritten with a QObject for clearer dispatching --- examples/qmc-example.cpp | 202 +++++++++++++++++++++++++++-------------------- 1 file changed, 117 insertions(+), 85 deletions(-) diff --git a/examples/qmc-example.cpp b/examples/qmc-example.cpp index f63b32a2..13a1b7c4 100644 --- a/examples/qmc-example.cpp +++ b/examples/qmc-example.cpp @@ -14,17 +14,113 @@ using std::cout; using std::endl; using namespace std::placeholders; -static int semaphor = 0; -static Room* targetRoom = nullptr; +class QMCTest : public QObject +{ + public: + QMCTest(Connection* conn, const QString& testRoomName, QString source); + + private slots: + void onNewRoom(Room* r, const QString& testRoomName); + void doTests(); + void addAndRemoveTag(); + void sendAndRedact(); + void finalize(); + + private: + QScopedPointer c; + QString origin; + Room* targetRoom = nullptr; + int semaphor = 0; -#define QMC_CHECK(origin, description, condition) \ +}; + +#define QMC_CHECK(description, condition) \ cout << (description) \ << (!!(condition) ? " successul" : " FAILED") << endl; \ - targetRoom->postMessage(QString(origin) % ": " % QStringLiteral(description) % \ + targetRoom->postMessage(origin % ": " % QStringLiteral(description) % \ (!!(condition) ? QStringLiteral(" successful") : \ QStringLiteral(" FAILED")), MessageEventType::Notice) -void addAndRemoveTag(const char* origin) +QMCTest::QMCTest(Connection* conn, const QString& testRoomName, QString source) + : c(conn), origin(std::move(source)) +{ + if (!origin.isEmpty()) + cout << "Origin for the test message: " << origin.toStdString() << endl; + if (!testRoomName.isEmpty()) + cout << "Test room name: " << testRoomName.toStdString() << endl; + + connect(c.data(), &Connection::newRoom, + this, [this,testRoomName] (Room* r) { onNewRoom(r, testRoomName); }); + connect(c.data(), &Connection::syncDone, c.data(), [this] { + cout << "Sync complete, " << semaphor << " tests in the air" << endl; + if (semaphor) + { +// if (targetRoom) +// targetRoom->postMessage( +// QString("%1: sync done, %2 test(s) in the air") +// .arg(origin).arg(semaphor), +// MessageEventType::Notice); + c->sync(10000); + } + else + { + if (targetRoom) + { + auto j = c->callApi(targetRoom->id(), + RoomMessageEvent(origin % ": All tests finished")); + connect(j, &BaseJob::finished, this, &QMCTest::finalize); + } + else + finalize(); + } + }); + // Big countdown watchdog + QTimer::singleShot(180000, this, &QMCTest::finalize); +} + +void QMCTest::onNewRoom(Room* r, const QString& testRoomName) +{ + cout << "New room: " << r->id().toStdString() << endl; + connect(r, &Room::namesChanged, this, [=] { + cout << "Room " << r->id().toStdString() << ", name(s) changed:" << endl + << " Name: " << r->name().toStdString() << endl + << " Canonical alias: " << r->canonicalAlias().toStdString() << endl + << endl << endl; + if (!testRoomName.isEmpty() && (r->name() == testRoomName || + r->canonicalAlias() == testRoomName)) + { + cout << "Found the target room, proceeding for tests" << endl; + targetRoom = r; + ++semaphor; + auto j = targetRoom->connection()->callApi( + targetRoom->id(), + RoomMessageEvent(origin % ": connected to test room", + MessageEventType::Notice)); + connect(j, &BaseJob::success, + this, [this] { doTests(); --semaphor; }); + } + }); + connect(r, &Room::aboutToAddNewMessages, r, [r] (RoomEventsRange timeline) { + cout << timeline.size() << " new event(s) in room " + << r->id().toStdString() << endl; +// for (const auto& item: timeline) +// { +// cout << "From: " +// << r->roomMembername(item->senderId()).toStdString() +// << endl << "Timestamp:" +// << item->timestamp().toString().toStdString() << endl +// << "JSON:" << endl << item->originalJson().toStdString() << endl; +// } + }); +} + +void QMCTest::doTests() +{ + addAndRemoveTag(); + sendAndRedact(); +} + +void QMCTest::addAndRemoveTag() { ++semaphor; static const auto TestTag = QStringLiteral("org.qmatrixclient.test"); @@ -35,8 +131,7 @@ void addAndRemoveTag(const char* origin) if (targetRoom->tags().contains(TestTag)) { targetRoom->removeTag(TestTag); - QMC_CHECK(origin, "Tagging test", - !targetRoom->tags().contains(TestTag)); + QMC_CHECK("Tagging test", !targetRoom->tags().contains(TestTag)); --semaphor; QObject::disconnect(targetRoom, &Room::tagsChanged, nullptr, nullptr); } @@ -45,17 +140,17 @@ void addAndRemoveTag(const char* origin) targetRoom->addTag(TestTag); } -void sendAndRedact(const char* origin) +void QMCTest::sendAndRedact() { ++semaphor; auto* job = targetRoom->connection()->callApi(targetRoom->id(), RoomMessageEvent("Message to redact")); - QObject::connect(job, &BaseJob::success, targetRoom, [job] { + QObject::connect(job, &BaseJob::success, targetRoom, [job,this] { targetRoom->redactEvent(job->eventId(), "qmc-example"); }); QObject::connect(targetRoom, &Room::replacedEvent, targetRoom, [=] (const RoomEvent* newEvent) { - QMC_CHECK(origin, "Redaction", newEvent->isRedacted() && + QMC_CHECK("Redaction", newEvent->isRedacted() && newEvent->redactionReason() == "qmc-example"); --semaphor; QObject::disconnect(targetRoom, &Room::replacedEvent, @@ -63,56 +158,15 @@ void sendAndRedact(const char* origin) }); } -void onNewRoom(Room* r, const char* targetRoomName, const char* origin) -{ - cout << "New room: " << r->id().toStdString() << endl; - QObject::connect(r, &Room::namesChanged, [=] { - cout << "Room " << r->id().toStdString() << ", name(s) changed:" << endl - << " Name: " << r->name().toStdString() << endl - << " Canonical alias: " << r->canonicalAlias().toStdString() << endl - << endl << endl; - if (targetRoomName && (r->name() == targetRoomName || - r->canonicalAlias() == targetRoomName)) - { - cout << "Found the target room, proceeding for tests" << endl; - targetRoom = r; - addAndRemoveTag(origin); - sendAndRedact(origin); - targetRoom->postMessage( - "This is a test notice from an example application\n" - "Origin: " % QString(origin) % "\n" - "The current user is " % - targetRoom->localUser()->fullName(targetRoom) % "\n" % -// "The room is " % -// (r->isDirectChat() ? "" : "not ") % "a direct chat\n" % - "Have a good day", - MessageEventType::Notice - ); - } - }); - QObject::connect(r, &Room::aboutToAddNewMessages, [r] (RoomEventsRange timeline) { - cout << timeline.size() << " new event(s) in room " - << r->id().toStdString() << endl; -// for (const auto& item: timeline) -// { -// cout << "From: " -// << r->roomMembername(item->senderId()).toStdString() -// << endl << "Timestamp:" -// << item->timestamp().toString().toStdString() << endl -// << "JSON:" << endl << item->originalJson().toStdString() << endl; -// } - }); -} - -void finalize(Connection* conn) +void QMCTest::finalize() { if (semaphor) cout << "One or more tests FAILED" << endl; cout << "Logging out" << endl; - conn->logout(); - QObject::connect(conn, &Connection::loggedOut, QCoreApplication::instance(), - [conn] { - conn->deleteLater(); + c->logout(); + connect(c.data(), &Connection::loggedOut, QCoreApplication::instance(), + [this] { + c->deleteLater(); QCoreApplication::processEvents(); QCoreApplication::exit(semaphor); }); @@ -121,44 +175,22 @@ void finalize(Connection* conn) int main(int argc, char* argv[]) { QCoreApplication app(argc, argv); - if (argc < 3) + if (argc < 4) + { + cout << "Usage: qmc-example [ [origin]]" << endl; return -1; + } cout << "Connecting to the server as " << argv[1] << endl; auto conn = new Connection; - conn->connectToServer(argv[1], argv[2], "QMatrixClient example application"); + conn->connectToServer(argv[1], argv[2], argv[3]); QObject::connect(conn, &Connection::connected, [=] { cout << "Connected, server: " << conn->homeserver().toDisplayString().toStdString() << endl; cout << "Access token: " << conn->accessToken().toStdString() << endl; conn->sync(); }); - const char* targetRoomName = argc >= 4 ? argv[3] : nullptr; - if (targetRoomName) - cout << "Target room name: " << targetRoomName << endl; - const char* origin = argc >= 5 ? argv[4] : nullptr; - if (origin) - cout << "Origin for the test message: " << origin << endl; - QObject::connect(conn, &Connection::newRoom, - [=](Room* room) { onNewRoom(room, targetRoomName, origin); }); - QObject::connect(conn, &Connection::syncDone, conn, [conn] { - cout << "Sync complete, " << semaphor << " tests in the air" << endl; - if (semaphor) - conn->sync(10000); - else - { - if (targetRoom) - { - auto j = conn->callApi(targetRoom->id(), - RoomMessageEvent("All tests finished")); - QObject::connect(j, &BaseJob::finished, - conn, [conn] { finalize(conn); }); - } - else - finalize(conn); - } - }); - // Big red countdown - QTimer::singleShot(180000, conn, [conn] { finalize(conn); }); + QMCTest test { conn, argc >= 5 ? argv[4] : nullptr, + argc >= 6 ? argv[5] : nullptr }; return app.exec(); } -- cgit v1.2.3 From 9a3a7e39cb8e88ddfd929647325dc919d0a02a1b Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 5 Mar 2018 18:30:53 +0900 Subject: Profile-log if saving state has been interrupted by processEvents for long enough --- connection.cpp | 3 +++ 1 file changed, 3 insertions(+) diff --git a/connection.cpp b/connection.cpp index 80685dd1..7ba11145 100644 --- a/connection.cpp +++ b/connection.cpp @@ -675,7 +675,10 @@ void Connection::saveState(const QUrl &toFile) const inviteRooms.insert(i->id(), i->toJson()); else rooms.insert(i->id(), i->toJson()); + QElapsedTimer et1; et1.start(); QCoreApplication::processEvents(); + if (et1.elapsed() > 1) + qCDebug(PROFILER) << "processEvents() borrowed" << et1; } if (!rooms.isEmpty()) -- cgit v1.2.3 From 1c5b7f8a1c6d82a612f4a2a74eeb644a40370ca5 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 5 Mar 2018 18:36:29 +0900 Subject: Travis: added one more parameter to qmc-example --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index c9002c13..cbf1cfd9 100644 --- a/.travis.yml +++ b/.travis.yml @@ -31,7 +31,7 @@ script: - cd .. - qmake qmc-example.pro "CONFIG += debug" "CONFIG -= app_bundle" "QMAKE_CC = $CC" "QMAKE_CXX = $CXX" - make all -- $VALGRIND ./qmc-example "$QMC_TEST_USER" "$QMC_TEST_PWD" '#qmc-test:matrix.org' "Travis CI job $TRAVIS_JOB_NUMBER" +- $VALGRIND ./qmc-example "$QMC_TEST_USER" "$QMC_TEST_PWD" qmc-example-travis '#qmc-test:matrix.org' "Travis CI job $TRAVIS_JOB_NUMBER" notifications: webhooks: -- cgit v1.2.3 From e8b6e90feedd4aec3e255984da8952ef716c68db Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 5 Mar 2018 10:25:46 +0900 Subject: First pieces of server-side read marker support --- room.cpp | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/room.cpp b/room.cpp index cb94ddb6..4f818473 100644 --- a/room.cpp +++ b/room.cpp @@ -402,8 +402,9 @@ void Room::Private::markMessagesAsRead(Room::rev_iter_t upToMarker) { if ((*markers.second)->senderId() != q->localUser()->id()) { - connection->callApi( - id, "m.read", (*markers.second)->id()); + auto eventId = (*markers.second)->id(); + connection->callApi(id, "m.read", eventId); + setAccountData(ReadMarkerEvent(eventId)); break; } } -- cgit v1.2.3 From f207955e2e0a77b7a47b47513374ccc3e6a71c1e Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 5 Mar 2018 19:15:32 +0900 Subject: qmc-example: Logging tweaks --- examples/qmc-example.cpp | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/examples/qmc-example.cpp b/examples/qmc-example.cpp index 13a1b7c4..3fa74d42 100644 --- a/examples/qmc-example.cpp +++ b/examples/qmc-example.cpp @@ -130,6 +130,7 @@ void QMCTest::addAndRemoveTag() << " " << targetRoom->tagNames().join(", ").toStdString() << endl; if (targetRoom->tags().contains(TestTag)) { + cout << "Test tag set, removing it now" << endl; targetRoom->removeTag(TestTag); QMC_CHECK("Tagging test", !targetRoom->tags().contains(TestTag)); --semaphor; @@ -137,15 +138,18 @@ void QMCTest::addAndRemoveTag() } }); // The reverse order because tagsChanged is emitted synchronously. + cout << "Adding a tag" << endl; targetRoom->addTag(TestTag); } void QMCTest::sendAndRedact() { ++semaphor; + cout << "Sending a message to redact" << endl; auto* job = targetRoom->connection()->callApi(targetRoom->id(), - RoomMessageEvent("Message to redact")); + RoomMessageEvent(origin % ": Message to redact")); QObject::connect(job, &BaseJob::success, targetRoom, [job,this] { + cout << "Message to redact has been succesfully sent, redacting" << endl; targetRoom->redactEvent(job->eventId(), "qmc-example"); }); QObject::connect(targetRoom, &Room::replacedEvent, targetRoom, -- cgit v1.2.3 From 63efbe26f37819048bb236d4839cc5f25c102785 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 5 Mar 2018 21:06:16 +0900 Subject: Support server-side read marker (m.full_read) Closes #183. There's also the m.read part but it can be done sometime later, as it's pure optimisation. --- events/receiptevent.cpp | 6 ---- events/receiptevent.h | 2 -- jobs/postreadmarkersjob.h | 37 ++++++++++++++++++++ libqmatrixclient.pri | 3 +- room.cpp | 87 +++++++++++++++++++++++++---------------------- 5 files changed, 86 insertions(+), 49 deletions(-) create mode 100644 jobs/postreadmarkersjob.h diff --git a/events/receiptevent.cpp b/events/receiptevent.cpp index 3c4d34ee..7555db82 100644 --- a/events/receiptevent.cpp +++ b/events/receiptevent.cpp @@ -66,11 +66,5 @@ ReceiptEvent::ReceiptEvent(const QJsonObject& obj) } _eventsWithReceipts.push_back({eventIt.key(), std::move(receipts)}); } - static const auto UnreadMsgsKey = - QStringLiteral("x-qmatrixclient.unread_messages"); - if (contents.contains(UnreadMsgsKey)) - _unreadMessages = contents["x-qmatrixclient.unread_messages"].toBool(); - else - _unreadMessages = obj["x-qmatrixclient.unread_messages"].toBool(); } diff --git a/events/receiptevent.h b/events/receiptevent.h index 92dace82..5b99ae3f 100644 --- a/events/receiptevent.h +++ b/events/receiptevent.h @@ -41,12 +41,10 @@ namespace QMatrixClient EventsWithReceipts eventsWithReceipts() const { return _eventsWithReceipts; } - bool unreadMessages() const { return _unreadMessages; } static constexpr const char* const TypeId = "m.receipt"; private: EventsWithReceipts _eventsWithReceipts; - bool _unreadMessages; // Spec extension for caching purposes }; } // namespace QMatrixClient diff --git a/jobs/postreadmarkersjob.h b/jobs/postreadmarkersjob.h new file mode 100644 index 00000000..d0198821 --- /dev/null +++ b/jobs/postreadmarkersjob.h @@ -0,0 +1,37 @@ +/****************************************************************************** + * Copyright (C) 2017 Kitsune Ral + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#pragma once + +#include "basejob.h" + +using namespace QMatrixClient; + +class PostReadMarkersJob : public BaseJob +{ + public: + explicit PostReadMarkersJob(const QString& roomId, + const QString& readUpToEventId) + : BaseJob(HttpVerb::Post, "PostReadMarkersJob", + QStringLiteral("_matrix/client/r0/rooms/%1/read_markers") + .arg(roomId)) + { + setRequestData(QJsonObject {{ + QStringLiteral("m.fully_read"), readUpToEventId }}); + } +}; diff --git a/libqmatrixclient.pri b/libqmatrixclient.pri index c7b95617..74e9d8c7 100644 --- a/libqmatrixclient.pri +++ b/libqmatrixclient.pri @@ -42,7 +42,8 @@ HEADERS += \ $$PWD/settings.h \ $$PWD/networksettings.h \ $$PWD/networkaccessmanager.h \ - $$PWD/jobs/downloadfilejob.h + $$PWD/jobs/downloadfilejob.h \ + $$PWD/jobs/postreadmarkersjob.h SOURCES += \ $$PWD/connectiondata.cpp \ diff --git a/room.cpp b/room.cpp index 4f818473..beeca6e3 100644 --- a/room.cpp +++ b/room.cpp @@ -36,6 +36,7 @@ #include "jobs/roommessagesjob.h" #include "jobs/mediathumbnailjob.h" #include "jobs/downloadfilejob.h" +#include "jobs/postreadmarkersjob.h" #include "avatar.h" #include "connection.h" #include "user.h" @@ -105,6 +106,7 @@ class Room::Private QString firstDisplayedEventId; QString lastDisplayedEventId; QHash lastReadEventIds; + QString serverReadMarker; TagsMap tags; QHash accountData; QString prevBatch; @@ -202,11 +204,12 @@ class Room::Private */ void processRedaction(RoomEventPtr redactionEvent); - template - SetAccountDataPerRoomJob* setAccountData(const EvT& event) + void broadcastTagUpdates() { - return connection->callApi( - connection->userId(), id, EvT::typeId(), event.toJson()); + connection->callApi( + connection->userId(), id, TagEvent::typeId(), + TagEvent(tags).toJson()); + emit q->tagsChanged(); } QJsonObject toJson() const; @@ -347,7 +350,11 @@ void Room::Private::setLastReadEvent(User* u, const QString& eventId) storedId = eventId; emit q->lastReadEventChanged(u); if (isLocalUser(u)) + { + if (eventId != serverReadMarker) + connection->callApi(id, eventId); emit q->readMarkerMoved(); + } } Room::Private::rev_iter_pair_t @@ -402,9 +409,8 @@ void Room::Private::markMessagesAsRead(Room::rev_iter_t upToMarker) { if ((*markers.second)->senderId() != q->localUser()->id()) { - auto eventId = (*markers.second)->id(); - connection->callApi(id, "m.read", eventId); - setAccountData(ReadMarkerEvent(eventId)); + connection->callApi(id, "m.read", + (*markers.second)->id()); break; } } @@ -593,8 +599,7 @@ void Room::addTag(const QString& name, const TagRecord& record) return; d->tags.insert(name, record); - d->setAccountData(TagEvent(d->tags)); - emit tagsChanged(); + d->broadcastTagUpdates(); } void Room::removeTag(const QString& name) @@ -603,8 +608,7 @@ void Room::removeTag(const QString& name) return; d->tags.remove(name); - d->setAccountData(TagEvent(d->tags)); - emit tagsChanged(); + d->broadcastTagUpdates(); } void Room::setTags(const TagsMap& newTags) @@ -612,8 +616,7 @@ void Room::setTags(const TagsMap& newTags) if (newTags == d->tags) return; d->tags = newTags; - d->setAccountData(TagEvent(d->tags)); - emit tagsChanged(); + d->broadcastTagUpdates(); } bool Room::isFavourite() const @@ -915,10 +918,13 @@ void Room::updateData(SyncRoomData&& data) d->prevBatch = data.timelinePrevBatch; setJoinState(data.joinState); - QElapsedTimer et; + QElapsedTimer et; et.start(); + for (auto&& event: data.accountData) + processAccountDataEvent(move(event)); + if (!data.state.empty()) { - et.start(); + et.restart(); processStateEvents(data.state); qCDebug(PROFILER) << "*** Room::processStateEvents(state):" << data.state.size() << "event(s)," << et; @@ -938,9 +944,6 @@ void Room::updateData(SyncRoomData&& data) for( auto&& ephemeralEvent: data.ephemeral ) processEphemeralEvent(move(ephemeralEvent)); - for (auto&& event: data.accountData) - processAccountDataEvent(move(event)); - if( data.highlightCount != d->highlightCount ) { d->highlightCount = data.highlightCount; @@ -1499,8 +1502,6 @@ void Room::processEphemeralEvent(EventPtr event) qCDebug(PROFILER) << "*** Room::processEphemeralEvent(receipts):" << receiptEvent->eventsWithReceipts().size() << "events with receipts," << et; - if (receiptEvent->unreadMessages()) - d->unreadMessages = true; break; } default: @@ -1524,6 +1525,20 @@ void Room::processAccountDataEvent(EventPtr event) emit tagsChanged(); break; } + case EventType::ReadMarker: + { + const auto* rmEvent = static_cast(event.get()); + const auto& readEventId = rmEvent->event_id(); + qCDebug(MAIN) << "Server-side read marker at " << readEventId; + static const auto UnreadMsgsKey = + QStringLiteral("x-qmatrixclient.unread_messages"); + if (rmEvent->contentJson().contains(UnreadMsgsKey)) + d->unreadMessages = + rmEvent->contentJson().value(UnreadMsgsKey).toBool(); + d->serverReadMarker = readEventId; + markMessagesAsRead(readEventId); + break; + } default: d->accountData[event->jsonType()] = event->contentJson().toVariantHash(); @@ -1659,32 +1674,24 @@ QJsonObject Room::Private::toJson() const QJsonObject {{ QStringLiteral("events"), stateEvents }}); } - if (!q->readMarkerEventId().isEmpty()) - { - result.insert(QStringLiteral("ephemeral"), - QJsonObject {{ QStringLiteral("events"), - QJsonArray { QJsonObject( - { { QStringLiteral("type"), QStringLiteral("m.receipt") } - , { QStringLiteral("content"), QJsonObject( - { { q->readMarkerEventId(), - QJsonObject {{ QStringLiteral("m.read"), - QJsonObject {{ connection->userId(), {} }} }} - } - , { QStringLiteral("x-qmatrixclient.unread_messages"), - unreadMessages } - }) } - } - ) } - }}); - } - QJsonArray accountDataEvents; if (!tags.empty()) accountDataEvents.append(QJsonObject( - { { QStringLiteral("type"), QStringLiteral("m.tag") } + { { QStringLiteral("type"), TagEvent::typeId() } , { QStringLiteral("content"), TagEvent(tags).toJson() } })); + if (!serverReadMarker.isEmpty()) + { + auto contentJson = ReadMarkerEvent(serverReadMarker).toJson(); + contentJson.insert(QStringLiteral("x-qmatrixclient.unread_messages"), + unreadMessages); + accountDataEvents.append(QJsonObject( + { { QStringLiteral("type"), ReadMarkerEvent::typeId() } + , { QStringLiteral("content"), contentJson } + })); + } + if (!accountData.empty()) { for (auto it = accountData.begin(); it != accountData.end(); ++it) -- cgit v1.2.3 From bcbdf7e418de975c43a0bd4bd8ecbeabd2f4ca0d Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Tue, 6 Mar 2018 17:34:06 +0900 Subject: Make sure the read marker is reinstated after Quaternion restart --- room.cpp | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/room.cpp b/room.cpp index beeca6e3..5fffec19 100644 --- a/room.cpp +++ b/room.cpp @@ -1472,9 +1472,9 @@ void Room::processEphemeralEvent(EventPtr event) << "as read for" << p.receipts.size() << "users"; } - if (d->eventsIndex.contains(p.evtId)) + const auto newMarker = findInTimeline(p.evtId); + if (newMarker != timelineEdge()) { - const auto newMarker = findInTimeline(p.evtId); for( const Receipt& r: p.receipts ) { auto u = user(r.userId); @@ -1536,7 +1536,11 @@ void Room::processAccountDataEvent(EventPtr event) d->unreadMessages = rmEvent->contentJson().value(UnreadMsgsKey).toBool(); d->serverReadMarker = readEventId; - markMessagesAsRead(readEventId); + const auto newMarker = findInTimeline(readEventId); + if (newMarker != timelineEdge()) + d->markMessagesAsRead(newMarker); + else + d->setLastReadEvent(localUser(), readEventId); break; } default: -- cgit v1.2.3 From 78d5fa9aa0a675b74053da76811d9fb9e02aa511 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Tue, 6 Mar 2018 18:07:43 +0900 Subject: CONTRIBUTING.md: add sections on API, doc-comments; update on automatic testing. --- CONTRIBUTING.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e67fabed..e576b886 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -108,6 +108,14 @@ We will gladly give credit to anyone who reports a vulnerability so that we can The code should strive to be DRY (don't repeat yourself), clear, and obviously correct. Some technical debt is inevitable, just don't bankrupt us with it. Refactoring is welcome. +### Library API and doc-comments + +Whenever you add a new call to the library API that you expect to be used from client code, you must supply a proper doc-comment along with the call. Doxygen (with backslashes) style is preferred. You can find that some parts of the code still use JavaDoc (with @'s) style; feel free to replace it with Doxygen backslashes if that bothers you. + +Calls, data structures and other symbols not intended for use by clients should _not_ be exposed in (public) .h files, unless they are necessary to declare other public symbols. In particular, this involves private members (functions, typedefs, or variables) in public classes; use pimpl idiom to hide implementation details as much as possible. + +Note: As of now, all header files of libqmatrixclient are considered public; this may change eventually. + ### Qt-flavoured C++ This is our primary language. We don't have a particular code style _as of yet_ but some rules-of-thumb are below: @@ -124,7 +132,7 @@ This is our primary language. We don't have a particular code style _as of yet_ ### Automated tests -There's no testing framework as of now; either Catch or QTest or both will be used eventually (PRs welcome, just don't expect a quick merge of one - we'll hunt you down to actually write some tests first :-D ). +There's no testing framework as of now; either Catch or QTest or both will be used eventually. However, as a stopgap measure, qmc-example is used for end-to-end testing; so please add another private slot and call it from `QMCTest::doTests()` whenever you add new function worth it. PRs to set up a proper testing appliance instead are very welcome (make sure to migrate tests from qmc-example though). ### Security, privacy, and performance -- cgit v1.2.3 From 86d8895f939d8b36dbf8e5104f238b2eaed87a94 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Wed, 7 Mar 2018 08:57:17 +0900 Subject: qmc-example: Ensure prerequisites before running the tagging test --- examples/qmc-example.cpp | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/examples/qmc-example.cpp b/examples/qmc-example.cpp index 3fa74d42..b7c56cb4 100644 --- a/examples/qmc-example.cpp +++ b/examples/qmc-example.cpp @@ -124,6 +124,10 @@ void QMCTest::addAndRemoveTag() { ++semaphor; static const auto TestTag = QStringLiteral("org.qmatrixclient.test"); + // Pre-requisite + if (targetRoom->tags().contains(TestTag)) + targetRoom->removeTag(TestTag); + QObject::connect(targetRoom, &Room::tagsChanged, targetRoom, [=] { cout << "Room " << targetRoom->id().toStdString() << ", tag(s) changed:" << endl -- cgit v1.2.3 From 1b3e61777b89194ec81a2327683be094e7aa3c99 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Wed, 7 Mar 2018 14:33:06 +0900 Subject: qmc-example: Remove no more needed deleteLater Might help with autotest segfaulting on OSX. --- examples/qmc-example.cpp | 1 - 1 file changed, 1 deletion(-) diff --git a/examples/qmc-example.cpp b/examples/qmc-example.cpp index b7c56cb4..0ca221c9 100644 --- a/examples/qmc-example.cpp +++ b/examples/qmc-example.cpp @@ -174,7 +174,6 @@ void QMCTest::finalize() c->logout(); connect(c.data(), &Connection::loggedOut, QCoreApplication::instance(), [this] { - c->deleteLater(); QCoreApplication::processEvents(); QCoreApplication::exit(semaphor); }); -- cgit v1.2.3 From d2afe5e1342e012b45245d86c8211b3f06df0062 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Wed, 7 Mar 2018 17:50:13 +0900 Subject: qmc-example: Fix redaction test to work even if the synced message is already redacted --- examples/qmc-example.cpp | 73 ++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 62 insertions(+), 11 deletions(-) diff --git a/examples/qmc-example.cpp b/examples/qmc-example.cpp index 0ca221c9..513e7efa 100644 --- a/examples/qmc-example.cpp +++ b/examples/qmc-example.cpp @@ -8,6 +8,7 @@ #include #include #include +#include using namespace QMatrixClient; using std::cout; @@ -21,9 +22,10 @@ class QMCTest : public QObject private slots: void onNewRoom(Room* r, const QString& testRoomName); - void doTests(); - void addAndRemoveTag(); - void sendAndRedact(); + void doTests(); + void addAndRemoveTag(); + void sendAndRedact(); + void checkRedactionOutcome(QString evtIdToRedact, RoomEventsRange events); void finalize(); private: @@ -152,18 +154,67 @@ void QMCTest::sendAndRedact() cout << "Sending a message to redact" << endl; auto* job = targetRoom->connection()->callApi(targetRoom->id(), RoomMessageEvent(origin % ": Message to redact")); - QObject::connect(job, &BaseJob::success, targetRoom, [job,this] { + connect(job, &BaseJob::success, targetRoom, [job,this] { cout << "Message to redact has been succesfully sent, redacting" << endl; - targetRoom->redactEvent(job->eventId(), "qmc-example"); + targetRoom->redactEvent(job->eventId(), origin); + // Make sure to save the event id because the job is about to end. + connect(targetRoom, &Room::aboutToAddNewMessages, this, + std::bind(&QMCTest::checkRedactionOutcome, + this, job->eventId(), _1)); }); - QObject::connect(targetRoom, &Room::replacedEvent, targetRoom, - [=] (const RoomEvent* newEvent) { - QMC_CHECK("Redaction", newEvent->isRedacted() && - newEvent->redactionReason() == "qmc-example"); +} + +void QMCTest::checkRedactionOutcome(QString evtIdToRedact, + RoomEventsRange events) +{ + static bool checkSucceeded = false; + // There are two possible (correct) outcomes: either the event comes already + // redacted at the next sync, or the nearest sync completes with + // the unredacted event but the next one brings redaction. + auto it = std::find_if(events.begin(), events.end(), + [=] (const RoomEventPtr& e) { + return e->id() == evtIdToRedact; + }); + if (it == events.end()) + return; // Waiting for the next sync + + if ((*it)->isRedacted()) + { + if (checkSucceeded) + { + const auto msg = + "The redacted event came in with the sync again, ignoring"; + cout << msg << endl; + targetRoom->postMessage(msg); + return; + } + cout << "The sync brought already redacted message" << endl; + QMC_CHECK("Redaction", true); + --semaphor; + // Not disconnecting because there are other connections from this class + // to aboutToAddNewMessages + checkSucceeded = true; + return; + } + // The event is not redacted + if (checkSucceeded) + { + const auto msg = + "Warning: the redacted event came non-redacted with the sync!"; + cout << msg << endl; + targetRoom->postMessage(msg); + } + cout << "Message came non-redacted with the sync, waiting for redaction" << endl; + connect(targetRoom, &Room::replacedEvent, targetRoom, + [=] (const RoomEvent* newEvent, const RoomEvent* oldEvent) { + QMC_CHECK("Redaction", oldEvent->id() == evtIdToRedact && + newEvent->isRedacted() && + newEvent->redactionReason() == origin); --semaphor; - QObject::disconnect(targetRoom, &Room::replacedEvent, - nullptr, nullptr); + checkSucceeded = true; + disconnect(targetRoom, &Room::replacedEvent, nullptr, nullptr); }); + } void QMCTest::finalize() -- cgit v1.2.3 From 5b2fb28a8ccc434a80a062b187236bb6af8c9912 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Wed, 7 Mar 2018 18:38:14 +0900 Subject: Travis: experimental Valgrind suppressions file --- .valgrind.qmc-example.supp | 159 +++++++++++++++++++++++++++++++++++++++++++++ qmc-example.pro | 3 + 2 files changed, 162 insertions(+) create mode 100644 .valgrind.qmc-example.supp diff --git a/.valgrind.qmc-example.supp b/.valgrind.qmc-example.supp new file mode 100644 index 00000000..3d15c500 --- /dev/null +++ b/.valgrind.qmc-example.supp @@ -0,0 +1,159 @@ +{ + libc_dirty_free_on_exit + Memcheck:Free + fun:free + fun:__libc_freeres + fun:_vgnU_freeres + fun:__run_exit_handlers + fun:exit +} + +{ + sendPostedEvents1 + Memcheck:Leak + match-leak-kinds: possible + fun:_Znwm + fun:_ZN15QtSharedPointer20ExternalRefCountData9getAndRefEPK7QObject + obj:/opt/qt56/lib/libQt5Network.so.5.6.3 +} + +{ + sendPostedEvents3 + Memcheck:Leak + match-leak-kinds: possible + fun:_Znwm + obj:/opt/qt56/lib/libQt5Network.so.5.6.3 + obj:/opt/qt56/lib/libQt5Network.so.5.6.3 + fun:_ZN7QObject5eventEP6QEvent + fun:_ZN16QCoreApplication6notifyEP7QObjectP6QEvent + fun:_ZN16QCoreApplication15notifyInternal2EP7QObjectP6QEvent + fun:_ZN23QCoreApplicationPrivate16sendPostedEventsEP7QObjectiP11QThreadData + obj:/opt/qt56/lib/libQt5Core.so.5.6.3 +} + +{ + QAuthenticator + Memcheck:Leak + match-leak-kinds: possible + ... + fun:_ZN14QAuthenticator6detachEv +} + +{ + sendPostedEvents5 + Memcheck:Leak + match-leak-kinds: possible + fun:realloc + fun:_ZN9QListData12realloc_growEi + fun:_ZN9QListData7prependEv + obj:/opt/qt56/lib/libQt5Network.so.5.6.3 + obj:/opt/qt56/lib/libQt5Network.so.5.6.3 + obj:/opt/qt56/lib/libQt5Network.so.5.6.3 + fun:_ZN7QObject5eventEP6QEvent + fun:_ZN16QCoreApplication6notifyEP7QObjectP6QEvent + fun:_ZN16QCoreApplication15notifyInternal2EP7QObjectP6QEvent + fun:_ZN23QCoreApplicationPrivate16sendPostedEventsEP7QObjectiP11QThreadData +} + +{ + QObject_connect + Memcheck:Leak + match-leak-kinds: possible + ... + obj:/opt/qt56/lib/libQt5Core.so.5.6.3 + fun:_ZN7QObject7connectEPKS_PKcS1_S3_N2Qt14ConnectionTypeE +} + +{ + QNetworkProxy + Memcheck:Leak + match-leak-kinds: possible + fun:_Znwm + fun:_ZN13QNetworkProxyC1ENS_9ProxyTypeERK7QStringtS3_S3_ + obj:/opt/qt56/lib/libQt5Network.so.5.6.3 +} + +{ + QTimer + Memcheck:Leak + match-leak-kinds: possible + fun:_Znwm + fun:_ZN7QObjectC1EPS_ + fun:_ZN6QTimerC1EP7QObject +} + +{ + QSslConfiguration + Memcheck:Leak + match-leak-kinds: possible + fun:_Znwm + ... + fun:_ZN17QSslConfigurationC1Ev +} + +{ + sendPostedEvents6 + Memcheck:Leak + match-leak-kinds: possible + fun:_Znwm + obj:/opt/qt56/lib/libQt5Network.so.5.6.3 + obj:/opt/qt56/lib/libQt5Network.so.5.6.3 + obj:/opt/qt56/lib/libQt5Network.so.5.6.3 + fun:_ZN7QObject5eventEP6QEvent + fun:_ZN16QCoreApplication6notifyEP7QObjectP6QEvent + fun:_ZN16QCoreApplication15notifyInternal2EP7QObjectP6QEvent + fun:_ZN23QCoreApplicationPrivate16sendPostedEventsEP7QObjectiP11QThreadData +} + +{ + QMetaObject_activate_in_QtNetwork + Memcheck:Leak + match-leak-kinds: possible + fun:_Znwm + obj:/opt/qt56/lib/libQt5Network.so.5.6.3 + obj:/opt/qt56/lib/libQt5Network.so.5.6.3 + fun:_ZN11QMetaObject8activateEP7QObjectiiPPv +} + +{ + QMapDatabase_from_QtNetwork + Memcheck:Leak + match-leak-kinds: possible + fun:_Znwm + fun:_ZN12QMapDataBase10createDataEv + obj:/opt/qt56/lib/libQt5Network.so.5.6.3 +} + +{ + QThread + Memcheck:Leak + match-leak-kinds: possible + ... + fun:_ZN7QThread5startENS_8PriorityE +} + +{ + libcrypto_ASN1 + Memcheck:Leak + match-leak-kinds: definite + fun:malloc + ... + fun:ASN1_item_ex_d2i +} + +{ + QObject_from_QtNetwork + Memcheck:Leak + match-leak-kinds: possible + fun:_Znwm + fun:_ZN7QObjectC1EPS_ + obj:/opt/qt56/lib/libQt5Network.so.5.6.3 +} + +{ + array_new_from_QtNetwork + Memcheck:Leak + match-leak-kinds: possible + fun:_Znam + obj:/opt/qt56/lib/libQt5Network.so.5.6.3 +} diff --git a/qmc-example.pro b/qmc-example.pro index 4dc3fed1..0c8bda22 100644 --- a/qmc-example.pro +++ b/qmc-example.pro @@ -5,3 +5,6 @@ windows { CONFIG += console } include(libqmatrixclient.pri) SOURCES += examples/qmc-example.cpp + +DISTFILES += \ + .valgrind.qmc-example.supp -- cgit v1.2.3 From 7340ba9ac15202b065c121f43b9f7b5e1cf0b5f3 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Wed, 7 Mar 2018 19:04:11 +0900 Subject: Fix resetting the read marker if a read receipt comes from the sync Closes #184. --- room.cpp | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/room.cpp b/room.cpp index 5fffec19..51fe83ec 100644 --- a/room.cpp +++ b/room.cpp @@ -1477,6 +1477,8 @@ void Room::processEphemeralEvent(EventPtr event) { for( const Receipt& r: p.receipts ) { + if (r.userId == connection()->userId()) + continue; // FIXME, #185 auto u = user(r.userId); if (memberJoinState(u) == JoinState::Join) d->promoteReadMarker(u, newMarker); @@ -1491,6 +1493,8 @@ void Room::processEphemeralEvent(EventPtr event) // 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()) -- cgit v1.2.3 From ce79719dd2f8e3ba320449409ea559fee2f836d6 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Wed, 7 Mar 2018 19:28:58 +0900 Subject: Travis: Small fixes to Valgrind suppressions --- .valgrind.qmc-example.supp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.valgrind.qmc-example.supp b/.valgrind.qmc-example.supp index 3d15c500..a02f34ff 100644 --- a/.valgrind.qmc-example.supp +++ b/.valgrind.qmc-example.supp @@ -22,7 +22,7 @@ Memcheck:Leak match-leak-kinds: possible fun:_Znwm - obj:/opt/qt56/lib/libQt5Network.so.5.6.3 + ... obj:/opt/qt56/lib/libQt5Network.so.5.6.3 fun:_ZN7QObject5eventEP6QEvent fun:_ZN16QCoreApplication6notifyEP7QObjectP6QEvent @@ -110,7 +110,7 @@ Memcheck:Leak match-leak-kinds: possible fun:_Znwm - obj:/opt/qt56/lib/libQt5Network.so.5.6.3 + ... obj:/opt/qt56/lib/libQt5Network.so.5.6.3 fun:_ZN11QMetaObject8activateEP7QObjectiiPPv } -- cgit v1.2.3 From a614db0d7103cd52c4b593fddb0ecaf019eac407 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Wed, 7 Mar 2018 19:29:40 +0900 Subject: User: use std::unique_ptr instead of QScopedPointer Slightly safer for the case (probably). --- user.cpp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/user.cpp b/user.cpp index 54eaf38c..ec32a7a1 100644 --- a/user.cpp +++ b/user.cpp @@ -59,7 +59,7 @@ class User::Private QString mostUsedName; QString bridged; - const QScopedPointer mostUsedAvatar { makeAvatar({}) }; + const std::unique_ptr mostUsedAvatar { makeAvatar({}) }; QMultiHash otherNames; QHash otherAvatars; QMultiHash avatarsToRooms; @@ -80,7 +80,7 @@ Avatar* User::Private::makeAvatar(QUrl url) { static const QIcon icon { QIcon::fromTheme(QStringLiteral("user-available")) }; - return new Avatar(url, icon); + return new Avatar(move(url), icon); } QString User::Private::nameForRoom(const Room* r, const QString& hint) const @@ -315,7 +315,7 @@ QString User::bridged() const const Avatar& User::avatarObject(const Room* room) const { return *d->otherAvatars.value(d->avatarUrlForRoom(room), - d->mostUsedAvatar.data()); + d->mostUsedAvatar.get()); } QImage User::avatar(int dimension, const Room* room) -- cgit v1.2.3 From e7f5da903228d32de47a9c6021e4d59cda0101ef Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Thu, 8 Mar 2018 08:28:59 +0900 Subject: Avatar: check URLs before fetching, not on updating the URL Closes #187. --- avatar.cpp | 35 +++++++++++++++++++++++------------ 1 file changed, 23 insertions(+), 12 deletions(-) diff --git a/avatar.cpp b/avatar.cpp index 9664199c..1ff2aae1 100644 --- a/avatar.cpp +++ b/avatar.cpp @@ -37,6 +37,8 @@ class Avatar::Private get_callback_t callback) const; bool upload(UploadContentJob* job, upload_callback_t callback); + bool checkUrl(QUrl url) const; + const QIcon _defaultIcon; QUrl _url; @@ -44,7 +46,8 @@ class Avatar::Private mutable QImage _originalImage; mutable std::vector> _scaledImages; mutable QSize _requestedSize; - mutable bool _valid = false; + mutable bool _bannedUrl = false; + mutable bool _fetched = false; mutable QPointer _thumbnailRequest = nullptr; mutable QPointer _uploadRequest = nullptr; mutable std::vector callbacks; @@ -105,9 +108,9 @@ QImage Avatar::Private::get(Connection* connection, QSize size, // is a sure way to trick the below code into constantly getting another // image from the server because the existing one is alleged unsatisfactory. // This is plain abuse by the client, though; so not critical for now. - if( ( !(_valid || _thumbnailRequest) + if( ( !(_fetched || _thumbnailRequest) || size.width() > _requestedSize.width() - || size.height() > _requestedSize.height() ) && _url.isValid() ) + || size.height() > _requestedSize.height() ) && checkUrl(_url) ) { qCDebug(MAIN) << "Getting avatar from" << _url.toString(); _requestedSize = size; @@ -117,7 +120,7 @@ QImage Avatar::Private::get(Connection* connection, QSize size, _thumbnailRequest = connection->getThumbnail(_url, size); QObject::connect( _thumbnailRequest, &MediaThumbnailJob::success, [this] { - _valid = true; + _fetched = true; _originalImage = _thumbnailRequest->scaledThumbnail(_requestedSize); _scaledImages.clear(); for (auto n: callbacks) @@ -153,6 +156,21 @@ bool Avatar::Private::upload(UploadContentJob* job, upload_callback_t callback) return true; } +bool Avatar::Private::checkUrl(QUrl url) const +{ + if (_bannedUrl || url.isEmpty()) + return false; + + // FIXME: Make "mxc" a library-wide constant and maybe even make + // the URL checker a Connection(?) method. + _bannedUrl = !(url.isValid() && + url.scheme() == "mxc" && url.path().count('/') == 1); + if (_bannedUrl) + qCWarning(MAIN) << "Avatar URL is invalid or not mxc-based:" + << url.toDisplayString(); + return !_bannedUrl; +} + QUrl Avatar::url() const { return d->_url; } bool Avatar::updateUrl(const QUrl& newUrl) @@ -160,15 +178,8 @@ bool Avatar::updateUrl(const QUrl& newUrl) if (newUrl == d->_url) return false; - // FIXME: Make it a library-wide constant and maybe even make the URL checker - // a Connection(?) method. - if (newUrl.scheme() != "mxc" || newUrl.path().count('/') != 1) - { - qCWarning(MAIN) << "Malformed avatar URL:" << newUrl.toDisplayString(); - return false; - } d->_url = newUrl; - d->_valid = false; + d->_fetched = false; if (isJobRunning(d->_thumbnailRequest)) d->_thumbnailRequest->abandon(); return true; -- cgit v1.2.3 From 551935c24f66b7db4c6845c8a92cecc980fe3834 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Thu, 8 Mar 2018 13:29:57 +0900 Subject: User: Streamline Avatar storage Don't use pointers and explicit operator new() for Avatars now that we store them in a separate container from the avatar(url)-to-room mapping. Less heap wasted. --- user.cpp | 66 ++++++++++++++++++++++++++++++++-------------------------------- 1 file changed, 33 insertions(+), 33 deletions(-) diff --git a/user.cpp b/user.cpp index ec32a7a1..cfcb2f4d 100644 --- a/user.cpp +++ b/user.cpp @@ -34,7 +34,6 @@ #include #include -#include using namespace QMatrixClient; using namespace std::placeholders; @@ -43,25 +42,30 @@ using std::move; class User::Private { public: - static Avatar* makeAvatar(QUrl url); + static Avatar makeAvatar(QUrl url) + { + static const QIcon icon + { QIcon::fromTheme(QStringLiteral("user-available")) }; + return Avatar(move(url), icon); + } Private(QString userId, Connection* connection) : userId(move(userId)), connection(connection) { } - ~Private() - { - for (auto a: otherAvatars) - delete a; - } QString userId; Connection* connection; - QString mostUsedName; QString bridged; - const std::unique_ptr mostUsedAvatar { makeAvatar({}) }; + QString mostUsedName; QMultiHash otherNames; - QHash otherAvatars; + Avatar mostUsedAvatar { makeAvatar({}) }; + std::vector otherAvatars; + auto otherAvatar(QUrl url) + { + return std::find_if(otherAvatars.begin(), otherAvatars.end(), + [&url] (const auto& av) { return av.url() == url; }); + } QMultiHash avatarsToRooms; mutable int totalRooms = 0; @@ -76,12 +80,6 @@ class User::Private }; -Avatar* User::Private::makeAvatar(QUrl url) -{ - static const QIcon icon - { QIcon::fromTheme(QStringLiteral("user-available")) }; - return new Avatar(move(url), icon); -} QString User::Private::nameForRoom(const Room* r, const QString& hint) const { @@ -138,32 +136,33 @@ void User::Private::setNameForRoom(const Room* r, QString newName, QUrl User::Private::avatarUrlForRoom(const Room* r, const QUrl& hint) const { // If the hint is accurate, this function is O(1) instead of O(n) - if (hint == mostUsedAvatar->url() || avatarsToRooms.contains(hint, r)) + if (hint == mostUsedAvatar.url() || avatarsToRooms.contains(hint, r)) return hint; auto it = std::find(avatarsToRooms.begin(), avatarsToRooms.end(), r); - return it == avatarsToRooms.end() ? mostUsedAvatar->url() : it.key(); + return it == avatarsToRooms.end() ? mostUsedAvatar.url() : it.key(); } void User::Private::setAvatarForRoom(const Room* r, const QUrl& newUrl, const QUrl& oldUrl) { Q_ASSERT(oldUrl != newUrl); - Q_ASSERT(oldUrl == mostUsedAvatar->url() || + Q_ASSERT(oldUrl == mostUsedAvatar.url() || avatarsToRooms.contains(oldUrl, r)); if (totalRooms < 2) { Q_ASSERT_X(totalRooms > 0 && otherAvatars.empty(), __FUNCTION__, "Internal structures inconsistency"); - mostUsedAvatar->updateUrl(newUrl); + mostUsedAvatar.updateUrl(newUrl); return; } avatarsToRooms.remove(oldUrl, r); if (!avatarsToRooms.contains(oldUrl)) { - delete otherAvatars.value(oldUrl); - otherAvatars.remove(oldUrl); + auto it = otherAvatar(oldUrl); + if (it != otherAvatars.end()) + otherAvatars.erase(it); } - if (newUrl != mostUsedAvatar->url()) + if (newUrl != mostUsedAvatar.url()) { // Check if the new avatar is about to become most used. if (avatarsToRooms.count(newUrl) >= totalRooms - avatarsToRooms.size()) @@ -172,22 +171,23 @@ void User::Private::setAvatarForRoom(const Room* r, const QUrl& newUrl, if (totalRooms > MIN_JOINED_ROOMS_TO_LOG) { qCDebug(MAIN) << "Switching the most used avatar of user" << userId - << "from" << mostUsedAvatar->url().toDisplayString() + << "from" << mostUsedAvatar.url().toDisplayString() << "to" << newUrl.toDisplayString(); et.start(); } avatarsToRooms.remove(newUrl); - auto* nextMostUsed = otherAvatars.take(newUrl); - std::swap(*mostUsedAvatar, *nextMostUsed); - otherAvatars.insert(nextMostUsed->url(), nextMostUsed); + auto nextMostUsedIt = otherAvatar(newUrl); + Q_ASSERT(nextMostUsedIt != otherAvatars.end()); + std::swap(mostUsedAvatar, *nextMostUsedIt); for (const auto* r1: connection->roomMap()) - if (avatarUrlForRoom(r1) == nextMostUsed->url()) - avatarsToRooms.insert(nextMostUsed->url(), r1); + if (avatarUrlForRoom(r1) == nextMostUsedIt->url()) + avatarsToRooms.insert(nextMostUsedIt->url(), r1); if (totalRooms > MIN_JOINED_ROOMS_TO_LOG) qCDebug(PROFILER) << et << "to switch the most used avatar"; } else { - otherAvatars.insert(newUrl, makeAvatar(newUrl)); + if (otherAvatar(newUrl) == otherAvatars.end()) + otherAvatars.emplace_back(makeAvatar(newUrl)); avatarsToRooms.insert(newUrl, r); } } @@ -241,7 +241,7 @@ void User::updateName(const QString& newName, const QString& oldName, void User::updateAvatarUrl(const QUrl& newUrl, const QUrl& oldUrl, const Room* room) { - Q_ASSERT(oldUrl == d->mostUsedAvatar->url() || + Q_ASSERT(oldUrl == d->mostUsedAvatar.url() || d->avatarsToRooms.contains(oldUrl, room)); if (newUrl != oldUrl) { @@ -314,8 +314,8 @@ QString User::bridged() const const Avatar& User::avatarObject(const Room* room) const { - return *d->otherAvatars.value(d->avatarUrlForRoom(room), - d->mostUsedAvatar.get()); + auto it = d->otherAvatar(d->avatarUrlForRoom(room)); + return it != d->otherAvatars.end() ? *it : d->mostUsedAvatar; } QImage User::avatar(int dimension, const Room* room) -- cgit v1.2.3 From 17d3333a8952e3bd2491080081d00a251157e34a Mon Sep 17 00:00:00 2001 From: Lewis Rockliffe Date: Sun, 18 Mar 2018 13:08:28 +0000 Subject: fix error handling in loadState() --- connection.cpp | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/connection.cpp b/connection.cpp index 7ba11145..b3f1ceb8 100644 --- a/connection.cpp +++ b/connection.cpp @@ -719,15 +719,18 @@ void Connection::loadState(const QUrl &fromFile) qCDebug(MAIN) << "No state cache file found"; return; } - file.open(QFile::ReadOnly); + if(!file.open(QFile::ReadOnly)) + { + qCWarning(MAIN) << "file " << file.fileName() << "failed to open for read"; + return; + } QByteArray data = file.readAll(); - QJsonParseError e; auto jsonDoc = d->cacheToBinary ? QJsonDocument::fromBinaryData(data) : - QJsonDocument::fromJson(data, &e); - if (e.error != QJsonParseError::NoError) + QJsonDocument::fromJson(data); + if (jsonDoc.isNull()) { - qCWarning(MAIN) << "Cache file not found or broken, discarding"; + qCWarning(MAIN) << "Cache file broken, discarding"; return; } auto actualCacheVersionMajor = -- cgit v1.2.3 From 4e78035d03817c29ceac46bdf9cb045e4ba3a101 Mon Sep 17 00:00:00 2001 From: Krombel Date: Tue, 20 Mar 2018 23:33:42 +0100 Subject: ignore possible appendixes from content type Currently libqmatrixclient fails checking the `Content-Type` header when there is an appendix like "charset". That is allowed e.g. in [rfc7231](https://tools.ietf.org/html/rfc7231#section-3.1.1.5)) One example is a Content-Type `application/json` vs `application/json;charset=UTF-8` Setting of the charset appendis is currently not supported. It fails with libqmatrixclient.jobs: "LoginJob" status 106 : "Incorrect content type of the response" This PR aims to just drop that appendix as it is currently not handled somewhere else. --- jobs/basejob.cpp | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/jobs/basejob.cpp b/jobs/basejob.cpp index 7669d1d4..981b75b1 100644 --- a/jobs/basejob.cpp +++ b/jobs/basejob.cpp @@ -282,9 +282,12 @@ bool checkContentType(const QByteArray& type, const QByteArrayList& patterns) if (patterns.isEmpty()) return true; + // ignore possible appendixes of the content type + const auto ctype = type.split(';').front(); + for (const auto& pattern: patterns) { - if (pattern.startsWith('*') || type == pattern) // Fast lane + if (pattern.startsWith('*') || ctype == pattern) // Fast lane return true; auto patternParts = pattern.split('/'); @@ -292,7 +295,7 @@ bool checkContentType(const QByteArray& type, const QByteArrayList& patterns) "BaseJob: Expected content type should have up to two" " /-separated parts; violating pattern: " + pattern); - if (type.split('/').front() == patternParts.front() && + if (ctype.split('/').front() == patternParts.front() && patternParts.back() == "*") return true; // Exact match already went on fast lane } -- cgit v1.2.3 From 3fc58ced0f65acae4696946a29ccda832263b4c2 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Wed, 21 Mar 2018 20:08:26 +0900 Subject: Fix Travis failing to build PRs --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index cbf1cfd9..3018d987 100644 --- a/.travis.yml +++ b/.travis.yml @@ -31,7 +31,7 @@ script: - cd .. - qmake qmc-example.pro "CONFIG += debug" "CONFIG -= app_bundle" "QMAKE_CC = $CC" "QMAKE_CXX = $CXX" - make all -- $VALGRIND ./qmc-example "$QMC_TEST_USER" "$QMC_TEST_PWD" qmc-example-travis '#qmc-test:matrix.org' "Travis CI job $TRAVIS_JOB_NUMBER" +- if [ "$QMC_TEST_USER" != "" ]; then $VALGRIND ./qmc-example "$QMC_TEST_USER" "$QMC_TEST_PWD" qmc-example-travis '#qmc-test:matrix.org' "Travis CI job $TRAVIS_JOB_NUMBER"; fi notifications: webhooks: -- cgit v1.2.3 From 791d6b2a86e81cdaf610913140ca94989ca1e41d Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Fri, 23 Mar 2018 10:34:58 +0900 Subject: Room::downloadFile(): Make sure a generated file name is sane Closes #191. --- room.cpp | 87 +++++++++++++++++++++++++++++++++++++--------------------------- 1 file changed, 50 insertions(+), 37 deletions(-) diff --git a/room.cpp b/room.cpp index 51fe83ec..6be00721 100644 --- a/room.cpp +++ b/room.cpp @@ -46,6 +46,7 @@ #include #include #include +#include #include #include @@ -153,6 +154,7 @@ class Room::Private QHash fileTransfers; const RoomMessageEvent* getEventWithFile(const QString& eventId) const; + QString fileNameToDownload(const RoomMessageEvent* event) const; //void inviteUser(User* u); // We might get it at some point in time. void insertMemberIntoMap(User* u); @@ -644,6 +646,39 @@ Room::Private::getEventWithFile(const QString& eventId) const 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) { if (auto* event = d->getEventWithFile(eventId)) @@ -673,13 +708,7 @@ QUrl Room::urlToDownload(const QString& eventId) QString Room::fileNameToDownload(const QString& eventId) { if (auto* event = d->getEventWithFile(eventId)) - { - auto* fileInfo = event->content()->fileInfo(); - Q_ASSERT(fileInfo != nullptr); - return !fileInfo->originalName.isEmpty() ? fileInfo->originalName : - !event->plainBody().isEmpty() ? event->plainBody() : - QString(); - } + return d->fileNameToDownload(event); return {}; } @@ -1067,40 +1096,24 @@ void Room::downloadFile(const QString& eventId, const QUrl& localFilename) { Q_ASSERT_X(localFilename.isEmpty() || localFilename.isLocalFile(), __FUNCTION__, "localFilename should point at a local file"); - auto evtIt = findInTimeline(eventId); - if (evtIt == timelineEdge() || - evtIt->event()->type() != EventType::RoomMessage) + auto* event = d->getEventWithFile(eventId); + if (!event) { - qCritical() << "Cannot download a file from event" << eventId - << "(there's no such message event in the local timeline)"; + qCCritical(MAIN) + << eventId << "is not in the local timeline or has no file content"; Q_ASSERT(false); return; } - auto* event = static_cast(evtIt->event()); - if (!event->hasFileContent()) + const auto fileUrl = event->content()->fileInfo()->url; + auto filePath = localFilename.toLocalFile(); + if (filePath.isEmpty()) { - qCritical() << eventId << "has no file content; nothing to download"; - Q_ASSERT(false); - return; - } - auto* fileInfo = event->content()->fileInfo(); - auto safeTempPrefix = eventId; - safeTempPrefix.replace(':', '_'); - safeTempPrefix = QDir::tempPath() + '/' + safeTempPrefix + '#'; - auto fileName = !localFilename.isEmpty() ? localFilename.toLocalFile() : - !fileInfo->originalName.isEmpty() ? - (safeTempPrefix + fileInfo->originalName) : - !event->plainBody().isEmpty() ? (safeTempPrefix + event->plainBody()) : - (safeTempPrefix + 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); })) - fileName += '.' + fileInfo->mimeType.preferredSuffix(); + // Build our own file path, starting with temp directory and eventId. + filePath = eventId; + filePath = QDir::tempPath() % '/' % filePath.replace(':', '_') % + '#' % d->fileNameToDownload(event); } - auto job = connection()->downloadFile(fileInfo->url, fileName); + auto job = connection()->downloadFile(fileUrl, filePath); if (isJobRunning(job)) { d->fileTransfers.insert(eventId, { job, job->targetFileName() }); @@ -1109,9 +1122,9 @@ void Room::downloadFile(const QString& eventId, const QUrl& localFilename) d->fileTransfers[eventId].update(received, total); emit fileTransferProgress(eventId, received, total); }); - connect(job, &BaseJob::success, this, [this,eventId,fileInfo,job] { + connect(job, &BaseJob::success, this, [this,eventId,fileUrl,job] { d->fileTransfers[eventId].status = FileTransferInfo::Completed; - emit fileTransferCompleted(eventId, fileInfo->url, + emit fileTransferCompleted(eventId, fileUrl, QUrl::fromLocalFile(job->targetFileName())); }); connect(job, &BaseJob::failure, this, -- cgit v1.2.3 From bac178f488299ec37ebe86aa91053cf1133d1c12 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Fri, 23 Mar 2018 10:43:39 +0900 Subject: BaseJob::start(): self-destruct if not succesfully started Closes #193. --- jobs/basejob.cpp | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/jobs/basejob.cpp b/jobs/basejob.cpp index 981b75b1..eb250723 100644 --- a/jobs/basejob.cpp +++ b/jobs/basejob.cpp @@ -235,8 +235,12 @@ void BaseJob::start(const ConnectionData* connData) { d->connection = connData; beforeStart(connData); - sendRequest(); - afterStart(connData, d->reply.data()); + if (status().good()) + sendRequest(); + if (status().good()) + afterStart(connData, d->reply.data()); + if (!status().good()) + QTimer::singleShot(0, this, &BaseJob::finishJob); } void BaseJob::sendRequest() -- cgit v1.2.3 From f31cf101872420a14995f2b24d21377a65adc9dd Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Fri, 23 Mar 2018 12:00:13 +0900 Subject: Room::downloadFile(): don't start another job if the transfer is ongoing --- room.cpp | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/room.cpp b/room.cpp index 6be00721..3ea6c323 100644 --- a/room.cpp +++ b/room.cpp @@ -1094,6 +1094,15 @@ void Room::uploadFile(const QString& id, const QUrl& localFilename, 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) << "Download for" << eventId + << "already started; to restart, cancel it first"; + return; + } + Q_ASSERT_X(localFilename.isEmpty() || localFilename.isLocalFile(), __FUNCTION__, "localFilename should point at a local file"); auto* event = d->getEventWithFile(eventId); -- cgit v1.2.3 From 403dde950b4a7398c856d495ed2d66157b175bf1 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Fri, 23 Mar 2018 12:01:46 +0900 Subject: DownloadFileJob::beforeStart(): make sure to immediately return in case of error --- jobs/downloadfilejob.cpp | 1 + 1 file changed, 1 insertion(+) diff --git a/jobs/downloadfilejob.cpp b/jobs/downloadfilejob.cpp index 07d14197..6a3d8483 100644 --- a/jobs/downloadfilejob.cpp +++ b/jobs/downloadfilejob.cpp @@ -54,6 +54,7 @@ void DownloadFileJob::beforeStart(const ConnectionData*) qCWarning(JOBS) << "Couldn't open the temporary file" << d->tempFile->fileName() << "for writing"; setStatus(FileError, "Could not open the temporary download file"); + return; } qCDebug(JOBS) << "Downloading to" << d->tempFile->fileName(); } -- cgit v1.2.3 From 062840871f0d740d55cec0aadb8c18b95f7cef62 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Fri, 23 Mar 2018 12:15:56 +0900 Subject: Room::downloadFile(): make sure to store the initiated file transfer anew QHash doesn't overwrite an entry if it already exists; this might lead to the target file name from the previous transfer kept in the table of file transfers. The commit fixes that. --- room.cpp | 2 ++ 1 file changed, 2 insertions(+) diff --git a/room.cpp b/room.cpp index 3ea6c323..b48a1fc4 100644 --- a/room.cpp +++ b/room.cpp @@ -1125,6 +1125,8 @@ void Room::downloadFile(const QString& eventId, const QUrl& localFilename) 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) { -- cgit v1.2.3 From a5428e53525afbc6fe6f697edb4f742d84c9ae0c Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Fri, 23 Mar 2018 14:47:52 +0900 Subject: Room::downloadFile(): Events are const --- room.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/room.cpp b/room.cpp index b48a1fc4..6c8d762b 100644 --- a/room.cpp +++ b/room.cpp @@ -1105,7 +1105,7 @@ void Room::downloadFile(const QString& eventId, const QUrl& localFilename) Q_ASSERT_X(localFilename.isEmpty() || localFilename.isLocalFile(), __FUNCTION__, "localFilename should point at a local file"); - auto* event = d->getEventWithFile(eventId); + const auto* event = d->getEventWithFile(eventId); if (!event) { qCCritical(MAIN) -- cgit v1.2.3 From 08fb435749f33ee5d266bbc2ea63c7c42169be97 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Fri, 23 Mar 2018 23:15:24 +0900 Subject: converters.h: Make the default toJson() less greedy template toJson(T&&) grabbed even things that it cannot convert, leading to unpleasant effects in a situation when all that was needed was one implicit conversion (e.g. from QList to QStringList). So now it's three trivial toJson() overloads instead of a template. --- converters.h | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/converters.h b/converters.h index 96efe5f8..f7d99f48 100644 --- a/converters.h +++ b/converters.h @@ -24,14 +24,13 @@ namespace QMatrixClient { - template - inline QJsonValue toJson(T&& val) - { - return QJsonValue(std::forward(val)); - } + // This catches anything implicitly convertible to QJsonValue/Object/Array + inline QJsonValue toJson(const QJsonValue& val) { return val; } + inline QJsonObject toJson(const QJsonObject& o) { return o; } + inline QJsonArray toJson(const QJsonArray& arr) { return arr; } template - inline QJsonValue toJson(const QVector& vals) + inline QJsonArray toJson(const QVector& vals) { QJsonArray ar; for (const auto& v: vals) @@ -39,7 +38,7 @@ namespace QMatrixClient return ar; } - inline QJsonValue toJson(const QStringList& strings) + inline QJsonArray toJson(const QStringList& strings) { return QJsonArray::fromStringList(strings); } @@ -50,7 +49,7 @@ namespace QMatrixClient } template - inline QJsonValue toJson(const QHash& hashMap) + inline QJsonObject toJson(const QHash& hashMap) { QJsonObject json; for (auto it = hashMap.begin(); it != hashMap.end(); ++it) -- cgit v1.2.3 From 4e31b0371cea6441dc4281aaa28a9b693a751454 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Tue, 27 Feb 2018 11:40:03 +0900 Subject: MemberEventContent/RoomMemberEvent: parse and expose is_direct --- events/roommemberevent.cpp | 1 + events/roommemberevent.h | 2 ++ 2 files changed, 3 insertions(+) diff --git a/events/roommemberevent.cpp b/events/roommemberevent.cpp index a9e301a4..76b003c2 100644 --- a/events/roommemberevent.cpp +++ b/events/roommemberevent.cpp @@ -51,6 +51,7 @@ namespace QMatrixClient MemberEventContent::MemberEventContent(const QJsonObject& json) : membership(fromJson(json["membership"])) + , isDirect(json["is_direct"].toBool()) , displayName(json["displayname"].toString()) , avatarUrl(json["avatar_url"].toString()) { } diff --git a/events/roommemberevent.h b/events/roommemberevent.h index b9ff0d70..89b970c9 100644 --- a/events/roommemberevent.h +++ b/events/roommemberevent.h @@ -38,6 +38,7 @@ namespace QMatrixClient explicit MemberEventContent(const QJsonObject& json); MembershipType membership; + bool isDirect = false; QString displayName; QUrl avatarUrl; @@ -66,6 +67,7 @@ namespace QMatrixClient MembershipType membership() const { return content().membership; } QString userId() const { return originalJsonObject().value("state_key").toString(); } + bool isDirect() const { return content().isDirect; } QString displayName() const { return content().displayName; } QUrl avatarUrl() const { return content().avatarUrl; } -- cgit v1.2.3 From 962f7f4beb192810afe82bfd4b68613a96a69063 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Tue, 27 Feb 2018 11:41:09 +0900 Subject: Introduce DirectChatEvent (parse only, no processing yet) --- CMakeLists.txt | 1 + events/directchatevent.cpp | 36 ++++++++++++++++++++++++++++++++++++ events/directchatevent.h | 34 ++++++++++++++++++++++++++++++++++ events/event.cpp | 3 ++- libqmatrixclient.pri | 2 ++ 5 files changed, 75 insertions(+), 1 deletion(-) create mode 100644 events/directchatevent.cpp create mode 100644 events/directchatevent.h diff --git a/CMakeLists.txt b/CMakeLists.txt index e95c72d0..82ab2b55 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -60,6 +60,7 @@ set(libqmatrixclient_SRCS events/roomavatarevent.cpp events/typingevent.cpp events/receiptevent.cpp + events/directchatevent.cpp jobs/requestdata.cpp jobs/basejob.cpp jobs/checkauthmethods.cpp diff --git a/events/directchatevent.cpp b/events/directchatevent.cpp new file mode 100644 index 00000000..7049d967 --- /dev/null +++ b/events/directchatevent.cpp @@ -0,0 +1,36 @@ +/****************************************************************************** + * Copyright (C) 2018 Kitsune Ral + * + * 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 "directchatevent.h" + +#include "converters.h" + +using namespace QMatrixClient; + +DirectChatEvent::DirectChatEvent(const QJsonObject& obj) + : Event(Type::DirectChat, obj) +{ } + +QMultiHash DirectChatEvent::usersToDirectChats() const +{ + QMultiHash result; + for (auto it = contentJson().begin(); it != contentJson().end(); ++it) + for (auto roomIdValue: it.value().toArray()) + result.insert(it.key(), roomIdValue.toString()); + return result; +} diff --git a/events/directchatevent.h b/events/directchatevent.h new file mode 100644 index 00000000..2b0ad0a0 --- /dev/null +++ b/events/directchatevent.h @@ -0,0 +1,34 @@ +/****************************************************************************** + * Copyright (C) 2018 Kitsune Ral + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#pragma once + +#include "event.h" + +namespace QMatrixClient +{ + class DirectChatEvent : public Event + { + public: + explicit DirectChatEvent(const QJsonObject& obj); + + QMultiHash usersToDirectChats() const; + + static constexpr const char * TypeId = "m.direct"; + }; +} diff --git a/events/event.cpp b/events/event.cpp index f3e965e2..8ddf3945 100644 --- a/events/event.cpp +++ b/events/event.cpp @@ -25,6 +25,7 @@ #include "typingevent.h" #include "receiptevent.h" #include "accountdataevents.h" +#include "directchatevent.h" #include "redactionevent.h" #include "logging.h" @@ -88,7 +89,7 @@ EventPtr _impl::doMakeEvent(const QJsonObject& obj) return EventPtr(move(e)); return EventPtr { makeIfMatches( + TypingEvent, ReceiptEvent, TagEvent, ReadMarkerEvent, DirectChatEvent>( obj, obj["type"].toString()) }; } diff --git a/libqmatrixclient.pri b/libqmatrixclient.pri index 74e9d8c7..144c9dbc 100644 --- a/libqmatrixclient.pri +++ b/libqmatrixclient.pri @@ -25,6 +25,7 @@ HEADERS += \ $$PWD/events/typingevent.h \ $$PWD/events/receiptevent.h \ $$PWD/events/accountdataevents.h \ + $$PWD/events/directchatevent.h \ $$PWD/events/redactionevent.h \ $$PWD/jobs/requestdata.h \ $$PWD/jobs/basejob.h \ @@ -57,6 +58,7 @@ SOURCES += \ $$PWD/events/roommemberevent.cpp \ $$PWD/events/typingevent.cpp \ $$PWD/events/receiptevent.cpp \ + $$PWD/events/directchatevent.cpp \ $$PWD/jobs/requestdata.cpp \ $$PWD/jobs/basejob.cpp \ $$PWD/jobs/checkauthmethods.cpp \ -- cgit v1.2.3 From f7ee38b6c1d6c809feddd91647d83e6c6fdd3837 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Fri, 23 Mar 2018 15:40:54 +0900 Subject: Dealing with direct chats Receiving and caching m.direct (and other non-room account data along the way); Connection::addToDirectChats/removeFromDirectChats (might get siblings in Room eventually but not now), Connection/User::requestDirectChat. Closes #163. --- connection.cpp | 156 +++++++++++++++++++++++++++++++++++++++++++++++++++++---- connection.h | 49 +++++++++++++++++- room.cpp | 5 ++ user.cpp | 6 +++ user.h | 1 + 5 files changed, 204 insertions(+), 13 deletions(-) diff --git a/connection.cpp b/connection.cpp index b3f1ceb8..fb946392 100644 --- a/connection.cpp +++ b/connection.cpp @@ -20,12 +20,14 @@ #include "connectiondata.h" #include "user.h" #include "events/event.h" +#include "events/directchatevent.h" #include "room.h" #include "settings.h" #include "jobs/generated/login.h" #include "jobs/generated/logout.h" #include "jobs/generated/receipts.h" #include "jobs/generated/leaving.h" +#include "jobs/generated/account-data.h" #include "jobs/sendeventjob.h" #include "jobs/joinroomjob.h" #include "jobs/roommessagesjob.h" @@ -45,6 +47,8 @@ using namespace QMatrixClient; +using DirectChatsMap = QMultiHash; + class Connection::Private { public: @@ -64,6 +68,8 @@ class Connection::Private QHash, Room*> roomMap; QVector roomIdsToForget; QMap userMap; + DirectChatsMap directChats; + QHash accountData; QString userId; SyncJob* syncJob = nullptr; @@ -74,6 +80,7 @@ class Connection::Private void connectWithToken(const QString& user, const QString& accessToken, const QString& deviceId); + void applyDirectChatUpdates(const DirectChatsMap& newMap); }; Connection::Connection(const QUrl& server, QObject* parent) @@ -258,7 +265,7 @@ void Connection::sync(int timeout) void Connection::onSyncSuccess(SyncData &&data) { d->data->setLastEvent(data.nextBatch()); - for( auto&& roomData: data.takeRoomData() ) + for (auto&& roomData: data.takeRoomData()) { const auto forgetIdx = d->roomIdsToForget.indexOf(roomData.roomId); if (forgetIdx != -1) @@ -279,7 +286,29 @@ void Connection::onSyncSuccess(SyncData &&data) { r->updateData(std::move(roomData)); QCoreApplication::processEvents(); } - + for (auto&& accountEvent: data.takeAccountData()) + { + if (accountEvent->type() == EventType::DirectChat) + { + DirectChatsMap newDirectChats; + const auto* event = static_cast(accountEvent.get()); + auto usersToDCs = event->usersToDirectChats(); + for (auto it = usersToDCs.begin(); it != usersToDCs.end(); ++it) + { + newDirectChats.insert(user(it.key()), it.value()); + qCDebug(MAIN) << "Marked room" << it.value() + << "as a direct chat with" << it.key(); + } + if (newDirectChats != d->directChats) + { + d->directChats = newDirectChats; + emit directChatsListChanged(); + } + continue; + } + d->accountData[accountEvent->jsonType()] = + accountEvent->contentJson().toVariantHash(); + } } void Connection::stopSync() @@ -405,6 +434,42 @@ CreateRoomJob* Connection::createRoom(RoomVisibility visibility, return job; } +void Connection::requestDirectChat(const QString& userId) +{ + auto roomId = d->directChats.value(user(userId)); + if (roomId.isEmpty()) + { + auto j = createDirectChat(userId); + connect(j, &BaseJob::success, this, [this,j,userId,roomId] { + qCDebug(MAIN) << "Direct chat with" << userId + << "has been created as" << roomId; + emit directChatAvailable(roomMap().value({j->roomId(), false})); + }); + return; + } + + auto room = roomMap().value({roomId, false}, nullptr); + if (room) + { + Q_ASSERT(room->id() == roomId); + qCDebug(MAIN) << "Requested direct chat with" << userId + << "is already available as" << room->id(); + emit directChatAvailable(room); + return; + } + room = roomMap().value({roomId, true}, nullptr); + if (room) + { + Q_ASSERT(room->id() == roomId); + auto j = joinRoom(room->id()); + connect(j, &BaseJob::success, this, [this,j,roomId,userId] { + qCDebug(MAIN) << "Joined the already invited direct chat with" + << userId << "as" << roomId; + emit directChatAvailable(roomMap().value({roomId, false})); + }); + } +} + CreateRoomJob* Connection::createDirectChat(const QString& userId, const QString& topic, const QString& name) { @@ -470,11 +535,14 @@ User* Connection::user(const QString& userId) return user; } -User *Connection::user() +const User* Connection::user() const { - if( d->userId.isEmpty() ) - return nullptr; - return user(d->userId); + return d->userId.isEmpty() ? nullptr : d->userMap.value(d->userId, nullptr); +} + +User* Connection::user() +{ + return d->userId.isEmpty() ? nullptr : user(d->userId); } QString Connection::userId() const @@ -556,6 +624,56 @@ QVector Connection::roomsWithTag(const QString& tagName) const return rooms; } +QJsonObject toJson(const DirectChatsMap& directChats) +{ + QJsonObject json; + for (auto it = directChats.keyBegin(); it != directChats.keyEnd(); ++it) + json.insert((*it)->id(), toJson(directChats.values(*it))); + return json; +} + +void Connection::Private::applyDirectChatUpdates(const DirectChatsMap& newMap) +{ + auto j = q->callApi(userId, "m.direct", toJson(newMap)); + connect(j, &BaseJob::success, q, [this, newMap] { + if (directChats != newMap) + { + directChats = newMap; + emit q->directChatsListChanged(); + } + }); +} + +void Connection::addToDirectChats(const Room* room, const User* user) +{ + Q_ASSERT(room != nullptr && user != nullptr); + if (d->directChats.contains(user, room->id())) + return; + auto newMap = d->directChats; + newMap.insert(user, room->id()); + d->applyDirectChatUpdates(newMap); +} + +void Connection::removeFromDirectChats(const Room* room, const User* user) +{ + Q_ASSERT(room != nullptr); + if ((user != nullptr && !d->directChats.contains(user, room->id())) || + d->directChats.key(room->id()) == nullptr) + return; + DirectChatsMap newMap; + for (auto it = d->directChats.begin(); it != d->directChats.end(); ++it) + { + if (it.value() != room->id() || (user != nullptr && it.key() != user)) + newMap.insert(it.key(), it.value()); + } + d->applyDirectChatUpdates(newMap); +} + +bool Connection::isDirectChat(const Room* room) const +{ + return d->directChats.key(room->id()) != nullptr; +} + QMap Connection::users() const { return d->userMap; @@ -639,7 +757,7 @@ void Connection::setHomeserver(const QUrl& url) emit homeserverChanged(homeserver()); } -static constexpr int CACHE_VERSION_MAJOR = 5; +static constexpr int CACHE_VERSION_MAJOR = 6; static constexpr int CACHE_VERSION_MINOR = 0; void Connection::saveState(const QUrl &toFile) const @@ -665,7 +783,7 @@ void Connection::saveState(const QUrl &toFile) const return; } - QJsonObject roomObj; + QJsonObject rootObj; { QJsonObject rooms; QJsonObject inviteRooms; @@ -681,15 +799,31 @@ void Connection::saveState(const QUrl &toFile) const qCDebug(PROFILER) << "processEvents() borrowed" << et1; } + QJsonObject roomObj; if (!rooms.isEmpty()) roomObj.insert("join", rooms); if (!inviteRooms.isEmpty()) roomObj.insert("invite", inviteRooms); + + rootObj.insert("next_batch", d->data->lastEvent()); + rootObj.insert("rooms", roomObj); } + { + QJsonArray accountDataEvents { + QJsonObject { + { QStringLiteral("type"), QStringLiteral("m.direct") }, + { QStringLiteral("content"), toJson(d->directChats) } + } + }; - QJsonObject rootObj; - rootObj.insert("next_batch", d->data->lastEvent()); - rootObj.insert("rooms", roomObj); + for (auto it = d->accountData.begin(); it != d->accountData.end(); ++it) + accountDataEvents.append(QJsonObject { + {"type", it.key()}, + {"content", QJsonObject::fromVariantHash(it.value())} + }); + rootObj.insert("account_data", + QJsonObject {{ QStringLiteral("events"), accountDataEvents }}); + } QJsonObject versionObj; versionObj.insert("major", CACHE_VERSION_MAJOR); diff --git a/connection.h b/connection.h index 1e9df5e2..e046d4a0 100644 --- a/connection.h +++ b/connection.h @@ -89,12 +89,26 @@ namespace QMatrixClient /** Get the list of rooms with the specified tag */ QVector roomsWithTag(const QString& tagName) const; + /** Mark the room as a direct chat with the user */ + void addToDirectChats(const Room* room, const User* user); + + /** Unmark the room from direct chats + * This function removes the room from direct chats either for + * a specific \p user or for all users if \p user in nullptr. + */ + void removeFromDirectChats(const Room* room, + const User* user = nullptr); + + /** Check whether the room is a direct chat */ + bool isDirectChat(const Room* room) const; + QMap users() const; // FIXME: Convert Q_INVOKABLEs to Q_PROPERTIES // (breaks back-compatibility) QUrl homeserver() const; Q_INVOKABLE User* user(const QString& userId); + const User* user() const; User* user(); QString userId() const; QString deviceId() const; @@ -223,7 +237,21 @@ namespace QMatrixClient const QVector& invite3pids = {}, const QJsonObject creationContent = {}); - /** Create a direct chat with a single user, optional name and topic */ + /** Get a direct chat with a single user + * This method may return synchronously or asynchoronously depending + * on whether a direct chat room with the respective person exists + * already. + * + * \sa directChatAvailable + */ + Q_INVOKABLE void requestDirectChat(const QString& userId); + + /** Create a direct chat with a single user, optional name and topic + * A room will always be created, unlike in requestDirectChat. + * It is advised to use requestDirectChat as a default way of getting + * one-on-one with a person, and only use createDirectChat when + * a new creation is explicitly desired. + */ CreateRoomJob* createDirectChat(const QString& userId, const QString& topic = {}, const QString& name = {}); @@ -341,13 +369,30 @@ namespace QMatrixClient /** The room object is about to be deleted */ void aboutToDeleteRoom(Room* room); - /** The room has just been created by createRoom or createDirectChat + /** The room has just been created by createRoom or requestDirectChat + * * This signal is not emitted in usual room state transitions, * only as an outcome of room creation operations invoked by * the client. + * \note requestDirectChat doesn't necessarily create a new chat; + * use directChatAvailable signal if you just need to obtain + * a direct chat room. */ void createdRoom(Room* room); + /** The direct chat room is ready for using + * This signal is emitted upon any successful outcome from + * requestDirectChat. + */ + void directChatAvailable(Room* directChat); + + /** The list of direct chats has changed + * This signal is emitted every time when the mapping of users + * to direct chat rooms is changed (because of either local updates + * or a different list arrived from the server). + */ + void directChatsListChanged(); + void cacheStateChanged(); protected: diff --git a/room.cpp b/room.cpp index 6c8d762b..48c27ba0 100644 --- a/room.cpp +++ b/room.cpp @@ -1424,6 +1424,11 @@ void Room::processStateEvents(const RoomEvents& events) auto memberEvent = static_cast(event); auto u = user(memberEvent->userId()); u->processEvent(memberEvent, this); + if (u == localUser() && memberJoinState(u) == JoinState::Invite + && memberEvent->isDirect()) + connection()->addToDirectChats(this, + user(memberEvent->senderId())); + if( memberEvent->membership() == MembershipType::Join ) { if (memberJoinState(u) != JoinState::Join) diff --git a/user.cpp b/user.cpp index cfcb2f4d..7a6dbc73 100644 --- a/user.cpp +++ b/user.cpp @@ -287,6 +287,12 @@ bool User::setAvatar(QIODevice* source) std::bind(&Private::setAvatarOnServer, d.data(), _1, this)); } +void User::requestDirectChat() +{ + Q_ASSERT(d->connection); + d->connection->requestDirectChat(d->userId); +} + void User::Private::setAvatarOnServer(QString contentUri, User* q) { auto* j = connection->callApi(userId, contentUri); diff --git a/user.h b/user.h index d19fa8f4..f76f9e0a 100644 --- a/user.h +++ b/user.h @@ -101,6 +101,7 @@ namespace QMatrixClient void rename(const QString& newName, const Room* r); bool setAvatar(const QString& fileName); bool setAvatar(QIODevice* source); + void requestDirectChat(); signals: void nameAboutToChange(QString newName, QString oldName, -- cgit v1.2.3 From de75f8f525c6dfe599580018d4a5dbb885dfa456 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Sat, 24 Mar 2018 14:59:21 +0900 Subject: Test/example for direct chats marking Also: refactored to gather up code dealing with the semaphor. --- examples/qmc-example.cpp | 78 +++++++++++++++++++++++++++++++++--------------- 1 file changed, 54 insertions(+), 24 deletions(-) diff --git a/examples/qmc-example.cpp b/examples/qmc-example.cpp index 513e7efa..5ea91856 100644 --- a/examples/qmc-example.cpp +++ b/examples/qmc-example.cpp @@ -26,6 +26,8 @@ class QMCTest : public QObject void addAndRemoveTag(); void sendAndRedact(); void checkRedactionOutcome(QString evtIdToRedact, RoomEventsRange events); + void markDirectChat(); + void checkDirectChatOutcome(); void finalize(); private: @@ -37,11 +39,15 @@ class QMCTest : public QObject }; #define QMC_CHECK(description, condition) \ +{ \ cout << (description) \ << (!!(condition) ? " successul" : " FAILED") << endl; \ targetRoom->postMessage(origin % ": " % QStringLiteral(description) % \ (!!(condition) ? QStringLiteral(" successful") : \ - QStringLiteral(" FAILED")), MessageEventType::Notice) + QStringLiteral(" FAILED")), \ + !!(condition) ? MessageEventType::Notice : MessageEventType::Text); \ + --semaphor; \ +} QMCTest::QMCTest(Connection* conn, const QString& testRoomName, QString source) : c(conn), origin(std::move(source)) @@ -56,25 +62,15 @@ QMCTest::QMCTest(Connection* conn, const QString& testRoomName, QString source) connect(c.data(), &Connection::syncDone, c.data(), [this] { cout << "Sync complete, " << semaphor << " tests in the air" << endl; if (semaphor) - { -// if (targetRoom) -// targetRoom->postMessage( -// QString("%1: sync done, %2 test(s) in the air") -// .arg(origin).arg(semaphor), -// MessageEventType::Notice); c->sync(10000); - } - else + else if (targetRoom) { - if (targetRoom) - { - auto j = c->callApi(targetRoom->id(), - RoomMessageEvent(origin % ": All tests finished")); - connect(j, &BaseJob::finished, this, &QMCTest::finalize); - } - else - finalize(); + auto j = c->callApi(targetRoom->id(), + RoomMessageEvent(origin % ": All tests finished")); + connect(j, &BaseJob::finished, this, &QMCTest::finalize); } + else + finalize(); }); // Big countdown watchdog QTimer::singleShot(180000, this, &QMCTest::finalize); @@ -118,13 +114,13 @@ void QMCTest::onNewRoom(Room* r, const QString& testRoomName) void QMCTest::doTests() { - addAndRemoveTag(); - sendAndRedact(); + ++semaphor; addAndRemoveTag(); + ++semaphor; sendAndRedact(); + ++semaphor; markDirectChat(); } void QMCTest::addAndRemoveTag() { - ++semaphor; static const auto TestTag = QStringLiteral("org.qmatrixclient.test"); // Pre-requisite if (targetRoom->tags().contains(TestTag)) @@ -139,7 +135,6 @@ void QMCTest::addAndRemoveTag() cout << "Test tag set, removing it now" << endl; targetRoom->removeTag(TestTag); QMC_CHECK("Tagging test", !targetRoom->tags().contains(TestTag)); - --semaphor; QObject::disconnect(targetRoom, &Room::tagsChanged, nullptr, nullptr); } }); @@ -150,7 +145,6 @@ void QMCTest::addAndRemoveTag() void QMCTest::sendAndRedact() { - ++semaphor; cout << "Sending a message to redact" << endl; auto* job = targetRoom->connection()->callApi(targetRoom->id(), RoomMessageEvent(origin % ": Message to redact")); @@ -190,7 +184,6 @@ void QMCTest::checkRedactionOutcome(QString evtIdToRedact, } cout << "The sync brought already redacted message" << endl; QMC_CHECK("Redaction", true); - --semaphor; // Not disconnecting because there are other connections from this class // to aboutToAddNewMessages checkSucceeded = true; @@ -210,13 +203,50 @@ void QMCTest::checkRedactionOutcome(QString evtIdToRedact, QMC_CHECK("Redaction", oldEvent->id() == evtIdToRedact && newEvent->isRedacted() && newEvent->redactionReason() == origin); - --semaphor; checkSucceeded = true; disconnect(targetRoom, &Room::replacedEvent, nullptr, nullptr); }); } +void QMCTest::markDirectChat() +{ + if (c->isDirectChat(targetRoom)) + { + cout << "Warning: the room is already a direct chat," + " only unmarking will be tested" << endl; + checkDirectChatOutcome(); + } + cout << "Marking the room as a direct chat" << endl; + c->addToDirectChats(targetRoom, c->user()); + connect(c.data(), &Connection::directChatsListChanged, + this, &QMCTest::checkDirectChatOutcome); +} + +void QMCTest::checkDirectChatOutcome() +{ + if (!c->isDirectChat(targetRoom)) + { + cout << "Room not (yet?) added to direct chats, waiting" << endl; + return; + } + + cout << "Room marked as a direct chat, unmarking now" << endl; + disconnect(c.data(), &Connection::directChatsListChanged, nullptr, nullptr); + c->removeFromDirectChats(targetRoom, c->user()); + connect(c.data(), &Connection::directChatsListChanged, this, [this] { + if (c->isDirectChat(targetRoom)) + { + cout << "Room not (yet?) removed from direct chats, waiting" << endl; + return; + } + + QMC_CHECK("Direct chat test", !c->isDirectChat(targetRoom)); + disconnect(c.data(), &Connection::directChatsListChanged, + nullptr, nullptr); + }); +} + void QMCTest::finalize() { if (semaphor) -- cgit v1.2.3 From 47cb949973a05cea6fb3a13ffd19b6e07e7720ae Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Sat, 24 Mar 2018 15:25:40 +0900 Subject: Work around a bug in MSVC leading to "ambiguous call" compilation error --- converters.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/converters.h b/converters.h index f7d99f48..bba298e0 100644 --- a/converters.h +++ b/converters.h @@ -28,6 +28,9 @@ namespace QMatrixClient inline QJsonValue toJson(const QJsonValue& val) { return val; } inline QJsonObject toJson(const QJsonObject& o) { return o; } inline QJsonArray toJson(const QJsonArray& arr) { return arr; } +#ifdef _MSC_VER // MSVC gets lost and doesn't know which overload to use + inline QJsonValue toJson(const QString& s) { return s; } +#endif template inline QJsonArray toJson(const QVector& vals) -- cgit v1.2.3 From 7a2e843dde6b78aabab05811d3f481176537098e Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Sat, 24 Mar 2018 17:15:18 +0900 Subject: .travis.yml: Escape all env variables in the configuration with ' Not only those that already caused trouble. --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 3018d987..a5938670 100644 --- a/.travis.yml +++ b/.travis.yml @@ -14,7 +14,7 @@ matrix: include: - os: linux compiler: gcc - env: [ ENV_EVAL="CC=gcc-5 && CXX=g++-5" ] + env: [ 'ENV_EVAL="CC=gcc-5 && CXX=g++-5"' ] - os: linux compiler: clang - os: osx -- cgit v1.2.3 From e7e9330d665c1d8d2391707d27019a7f454cbcdf Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 26 Mar 2018 11:43:00 +0900 Subject: Introduce JoinStates (QFlags) This required to change numeric values for JoinState enum; so anybody who relied on them being 0-based and/or contiguous, beware. --- jobs/syncjob.cpp | 5 +++-- joinstate.h | 15 +++++++++++---- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/jobs/syncjob.cpp b/jobs/syncjob.cpp index 6b3f3acf..ed579f12 100644 --- a/jobs/syncjob.cpp +++ b/jobs/syncjob.cpp @@ -74,13 +74,14 @@ BaseJob::Status SyncData::parseJson(const QJsonDocument &data) accountData.fromJson(json); QJsonObject rooms = json.value("rooms").toObject(); - for (size_t i = 0; i < JoinStateStrings.size(); ++i) + JoinStates::Int ii = 1; // ii is used to make a JoinState value + for (size_t i = 0; i < JoinStateStrings.size(); ++i, ii <<= 1) { const auto rs = rooms.value(JoinStateStrings[i]).toObject(); // We have a Qt container on the right and an STL one on the left roomData.reserve(static_cast(rs.size())); for(auto roomIt = rs.begin(); roomIt != rs.end(); ++roomIt) - roomData.emplace_back(roomIt.key(), JoinState(i), + roomData.emplace_back(roomIt.key(), JoinState(ii), roomIt.value().toObject()); } qCDebug(PROFILER) << "*** SyncData::parseJson(): batch with" diff --git a/joinstate.h b/joinstate.h index d6c374d2..42613895 100644 --- a/joinstate.h +++ b/joinstate.h @@ -18,17 +18,21 @@ #pragma once +#include + #include namespace QMatrixClient { enum class JoinState { - Join = 0, - Invite, - Leave + Join = 0x1, + Invite = 0x2, + Leave = 0x4 }; + Q_DECLARE_FLAGS(JoinStates, JoinState) + // We cannot use REGISTER_ENUM outside of a Q_OBJECT and besides, we want // to use strings that match respective JSON keys. static const std::array JoinStateStrings @@ -36,6 +40,9 @@ namespace QMatrixClient inline const char* toCString(JoinState js) { - return JoinStateStrings[size_t(js)]; + size_t state = size_t(js), index = 0; + while (state >>= 1) ++index; + return JoinStateStrings[index]; } } // namespace QMatrixClient +Q_DECLARE_OPERATORS_FOR_FLAGS(QMatrixClient::JoinStates) -- cgit v1.2.3 From e9cdf6c887b80210dcb6d754c1db82d3fad2ec06 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 26 Mar 2018 11:45:46 +0900 Subject: Connection::room() and Connection::invitation() --- connection.cpp | 23 +++++++++++++++++++++++ connection.h | 3 +++ 2 files changed, 26 insertions(+) diff --git a/connection.cpp b/connection.cpp index fb946392..df9fd35f 100644 --- a/connection.cpp +++ b/connection.cpp @@ -525,6 +525,29 @@ QUrl Connection::homeserver() const return d->data->baseUrl(); } +Room* Connection::room(const QString& roomId, JoinStates states) const +{ + Room* room = d->roomMap.value({roomId, false}, nullptr); + if (states.testFlag(JoinState::Join) && + room && room->joinState() == JoinState::Join) + return room; + + if (states.testFlag(JoinState::Invite)) + if (Room* invRoom = invitation(roomId)) + return invRoom; + + if (states.testFlag(JoinState::Leave) && + room && room->joinState() == JoinState::Leave) + return room; + + return nullptr; +} + +Room* Connection::invitation(const QString& roomId) const +{ + return d->roomMap.value({roomId, true}, nullptr); +} + User* Connection::user(const QString& userId) { if( d->userMap.contains(userId) ) diff --git a/connection.h b/connection.h index e046d4a0..4497e200 100644 --- a/connection.h +++ b/connection.h @@ -107,6 +107,9 @@ namespace QMatrixClient // FIXME: Convert Q_INVOKABLEs to Q_PROPERTIES // (breaks back-compatibility) QUrl homeserver() const; + Q_INVOKABLE Room* room(const QString& roomId, + JoinStates states = JoinState::Invite|JoinState::Join) const; + Q_INVOKABLE Room* invitation(const QString& roomId) const; Q_INVOKABLE User* user(const QString& userId); const User* user() const; User* user(); -- cgit v1.2.3 From 2aa9d96134567576d15e4807071990883f3ef6d3 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 26 Mar 2018 12:54:44 +0900 Subject: One more Valgrind suppression for cases when the test run into "Too many requests" --- .valgrind.qmc-example.supp | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.valgrind.qmc-example.supp b/.valgrind.qmc-example.supp index a02f34ff..cb4e1e74 100644 --- a/.valgrind.qmc-example.supp +++ b/.valgrind.qmc-example.supp @@ -157,3 +157,15 @@ fun:_Znam obj:/opt/qt56/lib/libQt5Network.so.5.6.3 } + +{ + malloc_from_libcrypto + Memcheck:Leak + match-leak-kinds: possible + fun:malloc + fun:CRYPTO_malloc + ... + obj:/lib/x86_64-linux-gnu/libcrypto.so.1.0.0 + ... + obj:/opt/qt56/lib/libQt5Network.so.5.6.3 +} -- cgit v1.2.3 From b385baadc8e73ff3c499a0111e2a553d35dd29b6 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 26 Mar 2018 12:30:23 -0700 Subject: Direct chat (un)marking: update internal structure synchronously The asynchronous update first implemented was more verbose and caused more problems than provided solutions. The idea was that the internal directChats map would better reflect the server state if updated asynchronously. However, it also causes a local race condition; e.g., to quickly remove rooms from direct chats one after another becomes very non-trivial (one has to wait until the previous operation succeeds). So after some playing with the code, hitting pitfalls along the way, I decided to align the logic with the one for room tags; synchronously issued signals look uglyish but at least work predictably. And race conditions between several clients generally cannot be cleanly resolved anyway. --- connection.cpp | 50 +++++++++++++++++++++++------------------------- connection.h | 22 ++++++++++++++++----- examples/qmc-example.cpp | 31 +++++++++++------------------- 3 files changed, 52 insertions(+), 51 deletions(-) diff --git a/connection.cpp b/connection.cpp index df9fd35f..b32f38ea 100644 --- a/connection.cpp +++ b/connection.cpp @@ -80,7 +80,7 @@ class Connection::Private void connectWithToken(const QString& user, const QString& accessToken, const QString& deviceId); - void applyDirectChatUpdates(const DirectChatsMap& newMap); + void broadcastDirectChatUpdates(); }; Connection::Connection(const QUrl& server, QObject* parent) @@ -655,16 +655,11 @@ QJsonObject toJson(const DirectChatsMap& directChats) return json; } -void Connection::Private::applyDirectChatUpdates(const DirectChatsMap& newMap) +void Connection::Private::broadcastDirectChatUpdates() { - auto j = q->callApi(userId, "m.direct", toJson(newMap)); - connect(j, &BaseJob::success, q, [this, newMap] { - if (directChats != newMap) - { - directChats = newMap; - emit q->directChatsListChanged(); - } - }); + auto j = q->callApi(userId, QStringLiteral("m.direct"), + toJson(directChats)); + emit q->directChatsListChanged(); } void Connection::addToDirectChats(const Room* room, const User* user) @@ -672,29 +667,32 @@ void Connection::addToDirectChats(const Room* room, const User* user) Q_ASSERT(room != nullptr && user != nullptr); if (d->directChats.contains(user, room->id())) return; - auto newMap = d->directChats; - newMap.insert(user, room->id()); - d->applyDirectChatUpdates(newMap); + d->directChats.insert(user, room->id()); + d->broadcastDirectChatUpdates(); } -void Connection::removeFromDirectChats(const Room* room, const User* user) +void Connection::removeFromDirectChats(const QString& roomId, const User* user) { - Q_ASSERT(room != nullptr); - if ((user != nullptr && !d->directChats.contains(user, room->id())) || - d->directChats.key(room->id()) == nullptr) + Q_ASSERT(!roomId.isEmpty()); + if ((user != nullptr && !d->directChats.contains(user, roomId)) || + d->directChats.key(roomId) == nullptr) return; - DirectChatsMap newMap; - for (auto it = d->directChats.begin(); it != d->directChats.end(); ++it) - { - if (it.value() != room->id() || (user != nullptr && it.key() != user)) - newMap.insert(it.key(), it.value()); - } - d->applyDirectChatUpdates(newMap); + if (user != nullptr) + d->directChats.remove(user, roomId); + else + for (auto it = d->directChats.begin(); it != d->directChats.end();) + { + if (it.value() == roomId) + it = d->directChats.erase(it); + else + ++it; + } + d->broadcastDirectChatUpdates(); } -bool Connection::isDirectChat(const Room* room) const +bool Connection::isDirectChat(const QString& roomId) const { - return d->directChats.key(room->id()) != nullptr; + return d->directChats.key(roomId) != nullptr; } QMap Connection::users() const diff --git a/connection.h b/connection.h index 4497e200..6a5285f9 100644 --- a/connection.h +++ b/connection.h @@ -89,18 +89,30 @@ namespace QMatrixClient /** Get the list of rooms with the specified tag */ QVector roomsWithTag(const QString& tagName) const; - /** Mark the room as a direct chat with the user */ + /** Mark the room as a direct chat with the user + * This function marks \p room as a direct chat with \p user. + * Emits the signal synchronously, without waiting to complete + * synchronisation with the server. + * + * \sa directChatsListChanged + */ void addToDirectChats(const Room* room, const User* user); /** Unmark the room from direct chats - * This function removes the room from direct chats either for + * This function removes the room id from direct chats either for * a specific \p user or for all users if \p user in nullptr. + * The room id is used to allow removal of, e.g., ids of forgotten + * rooms; a Room object need not exist. Emits the signal + * immediately, without waiting to complete synchronisation with + * the server. + * + * \sa directChatsListChanged */ - void removeFromDirectChats(const Room* room, + void removeFromDirectChats(const QString& roomId, const User* user = nullptr); - /** Check whether the room is a direct chat */ - bool isDirectChat(const Room* room) const; + /** Check whether the room id corresponds to a direct chat */ + bool isDirectChat(const QString& roomId) const; QMap users() const; diff --git a/examples/qmc-example.cpp b/examples/qmc-example.cpp index 5ea91856..23a1bff1 100644 --- a/examples/qmc-example.cpp +++ b/examples/qmc-example.cpp @@ -126,7 +126,8 @@ void QMCTest::addAndRemoveTag() if (targetRoom->tags().contains(TestTag)) targetRoom->removeTag(TestTag); - QObject::connect(targetRoom, &Room::tagsChanged, targetRoom, [=] { + // Connect first because the signal is emitted synchronously. + connect(targetRoom, &Room::tagsChanged, targetRoom, [=] { cout << "Room " << targetRoom->id().toStdString() << ", tag(s) changed:" << endl << " " << targetRoom->tagNames().join(", ").toStdString() << endl; @@ -138,7 +139,6 @@ void QMCTest::addAndRemoveTag() QObject::disconnect(targetRoom, &Room::tagsChanged, nullptr, nullptr); } }); - // The reverse order because tagsChanged is emitted synchronously. cout << "Adding a tag" << endl; targetRoom->addTag(TestTag); } @@ -211,40 +211,31 @@ void QMCTest::checkRedactionOutcome(QString evtIdToRedact, void QMCTest::markDirectChat() { - if (c->isDirectChat(targetRoom)) + if (c->isDirectChat(targetRoom->id())) { cout << "Warning: the room is already a direct chat," " only unmarking will be tested" << endl; checkDirectChatOutcome(); } - cout << "Marking the room as a direct chat" << endl; - c->addToDirectChats(targetRoom, c->user()); + // Connect first because the signal is emitted synchronously. connect(c.data(), &Connection::directChatsListChanged, this, &QMCTest::checkDirectChatOutcome); + cout << "Marking the room as a direct chat" << endl; + c->addToDirectChats(targetRoom, c->user()); } void QMCTest::checkDirectChatOutcome() { - if (!c->isDirectChat(targetRoom)) + disconnect(c.data(), &Connection::directChatsListChanged, nullptr, nullptr); + if (!c->isDirectChat(targetRoom->id())) { - cout << "Room not (yet?) added to direct chats, waiting" << endl; + QMC_CHECK("Direct chat test", false); return; } cout << "Room marked as a direct chat, unmarking now" << endl; - disconnect(c.data(), &Connection::directChatsListChanged, nullptr, nullptr); - c->removeFromDirectChats(targetRoom, c->user()); - connect(c.data(), &Connection::directChatsListChanged, this, [this] { - if (c->isDirectChat(targetRoom)) - { - cout << "Room not (yet?) removed from direct chats, waiting" << endl; - return; - } - - QMC_CHECK("Direct chat test", !c->isDirectChat(targetRoom)); - disconnect(c.data(), &Connection::directChatsListChanged, - nullptr, nullptr); - }); + c->removeFromDirectChats(targetRoom->id(), c->user()); + QMC_CHECK("Direct chat test", !c->isDirectChat(targetRoom->id())); } void QMCTest::finalize() -- cgit v1.2.3 From 381ab25563cce26be8e3983b3fb3b8090385a766 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 26 Mar 2018 12:35:49 +0900 Subject: Connection::doInDirectChat() and refactored direct chat requesting logic Basically, the whole requestDirectChat() body has been moved and generalised to doInDirectChat(), and requestDirectChat() delegates to doInDirectChat(). The logic has been updated to cope with formerly left/forgotten rooms present in the list of direct chats (cleaning up the list along the way). --- connection.cpp | 65 ++++++++++++++++++++++++++++++++-------------------------- connection.h | 9 ++++++++ 2 files changed, 45 insertions(+), 29 deletions(-) diff --git a/connection.cpp b/connection.cpp index b32f38ea..2a748eb1 100644 --- a/connection.cpp +++ b/connection.cpp @@ -436,38 +436,45 @@ CreateRoomJob* Connection::createRoom(RoomVisibility visibility, void Connection::requestDirectChat(const QString& userId) { - auto roomId = d->directChats.value(user(userId)); - if (roomId.isEmpty()) - { - auto j = createDirectChat(userId); - connect(j, &BaseJob::success, this, [this,j,userId,roomId] { - qCDebug(MAIN) << "Direct chat with" << userId - << "has been created as" << roomId; - emit directChatAvailable(roomMap().value({j->roomId(), false})); - }); - return; - } + doInDirectChat(userId, [this] (Room* r) { emit directChatAvailable(r); }); +} - auto room = roomMap().value({roomId, false}, nullptr); - if (room) - { - Q_ASSERT(room->id() == roomId); - qCDebug(MAIN) << "Requested direct chat with" << userId - << "is already available as" << room->id(); - emit directChatAvailable(room); - return; - } - room = roomMap().value({roomId, true}, nullptr); - if (room) +void Connection::doInDirectChat(const QString& userId, + std::function operation) +{ + // There can be more than one DC; find the first valid, and delete invalid + // (left/forgotten) ones along the way. + for (auto roomId: d->directChats.values(user(userId))) { - Q_ASSERT(room->id() == roomId); - auto j = joinRoom(room->id()); - connect(j, &BaseJob::success, this, [this,j,roomId,userId] { - qCDebug(MAIN) << "Joined the already invited direct chat with" - << userId << "as" << roomId; - emit directChatAvailable(roomMap().value({roomId, false})); - }); + if (auto r = room(roomId, JoinState::Join)) + { + Q_ASSERT(r->id() == roomId); + qCDebug(MAIN) << "Requested direct chat with" << userId + << "is already available as" << r->id(); + operation(r); + return; + } + if (auto ir = invitation(roomId)) + { + Q_ASSERT(ir->id() == roomId); + auto j = joinRoom(ir->id()); + connect(j, &BaseJob::success, this, [this,roomId,userId,operation] { + qCDebug(MAIN) << "Joined the already invited direct chat with" + << userId << "as" << roomId; + operation(room(roomId, JoinState::Join)); + }); + } + qCWarning(MAIN) << "Direct chat with" << userId << "known as room" + << roomId << "is not valid, discarding it"; + removeFromDirectChats(roomId); } + + auto j = createDirectChat(userId); + connect(j, &BaseJob::success, this, [this,j,userId,operation] { + qCDebug(MAIN) << "Direct chat with" << userId + << "has been created as" << j->roomId(); + operation(room(j->roomId(), JoinState::Join)); + }); } CreateRoomJob* Connection::createDirectChat(const QString& userId, diff --git a/connection.h b/connection.h index 6a5285f9..7c11c32d 100644 --- a/connection.h +++ b/connection.h @@ -261,6 +261,15 @@ namespace QMatrixClient */ Q_INVOKABLE void requestDirectChat(const QString& userId); + /** Run an operation in a direct chat with the user + * This method may return synchronously or asynchoronously depending + * on whether a direct chat room with the respective person exists + * already. Instead of emitting a signal it executes the passed + * function object with the direct chat room as its parameter. + */ + Q_INVOKABLE void doInDirectChat(const QString& userId, + std::function operation); + /** Create a direct chat with a single user, optional name and topic * A room will always be created, unlike in requestDirectChat. * It is advised to use requestDirectChat as a default way of getting -- cgit v1.2.3 From a73bb17418a6dfea556a837c48463e454c8db130 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Sun, 25 Mar 2018 22:06:46 -0700 Subject: Minor cleanup --- connection.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/connection.cpp b/connection.cpp index 2a748eb1..db8bb085 100644 --- a/connection.cpp +++ b/connection.cpp @@ -664,8 +664,8 @@ QJsonObject toJson(const DirectChatsMap& directChats) void Connection::Private::broadcastDirectChatUpdates() { - auto j = q->callApi(userId, QStringLiteral("m.direct"), - toJson(directChats)); + q->callApi(userId, QStringLiteral("m.direct"), + toJson(directChats)); emit q->directChatsListChanged(); } -- cgit v1.2.3 From de05579f18a5c264fe0dbea68ea83abcff526d00 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 26 Mar 2018 08:03:16 -0400 Subject: Connection::directChatUsers() --- connection.cpp | 6 ++++++ connection.h | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/connection.cpp b/connection.cpp index db8bb085..e4e622a3 100644 --- a/connection.cpp +++ b/connection.cpp @@ -702,6 +702,12 @@ bool Connection::isDirectChat(const QString& roomId) const return d->directChats.key(roomId) != nullptr; } +QList Connection::directChatUsers(const Room* room) const +{ + Q_ASSERT(room != nullptr); + return d->directChats.keys(room->id()); +} + QMap Connection::users() const { return d->userMap; diff --git a/connection.h b/connection.h index 7c11c32d..c6d543ec 100644 --- a/connection.h +++ b/connection.h @@ -114,6 +114,12 @@ namespace QMatrixClient /** Check whether the room id corresponds to a direct chat */ bool isDirectChat(const QString& roomId) const; + /** Retrieve the list of users the room is a direct chat with + * @return The list of users for which this room is marked as + * a direct chat; an empty list if the room is not a direct chat + */ + QList directChatUsers(const Room* room) const; + QMap users() const; // FIXME: Convert Q_INVOKABLEs to Q_PROPERTIES -- cgit v1.2.3 From 93dc89d9353e9f30d42528d8ffaba992f58139aa Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 26 Mar 2018 08:05:01 -0400 Subject: Room: isDirectChat() and directChatUsers() isDirectChat() has been declared previously but not implemented, hence a bit of strangeness in the commit. --- room.cpp | 10 ++++++++++ room.h | 3 +++ 2 files changed, 13 insertions(+) diff --git a/room.cpp b/room.cpp index 48c27ba0..01055013 100644 --- a/room.cpp +++ b/room.cpp @@ -631,6 +631,16 @@ bool Room::isLowPriority() const return d->tags.contains(LowPriorityTag); } +bool Room::isDirectChat() const +{ + return connection()->isDirectChat(id()); +} + +QList Room::directChatUsers() const +{ + return connection()->directChatUsers(this); +} + const RoomMessageEvent* Room::Private::getEventWithFile(const QString& eventId) const { diff --git a/room.h b/room.h index 0eb5ecc3..59566092 100644 --- a/room.h +++ b/room.h @@ -269,6 +269,9 @@ namespace QMatrixClient /** Check whether this room is a direct chat */ bool isDirectChat() const; + /** Get the list of users this room is a direct chat with */ + QList directChatUsers() const; + Q_INVOKABLE QUrl urlToThumbnail(const QString& eventId); Q_INVOKABLE QUrl urlToDownload(const QString& eventId); Q_INVOKABLE QString fileNameToDownload(const QString& eventId); -- cgit v1.2.3 From 39a8c43d96896aa1401a791b246de53794e06f65 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 26 Mar 2018 08:06:04 -0400 Subject: Count unread messages --- room.cpp | 111 +++++++++++++++++++++++++++++++++++++++++++++------------------ room.h | 3 +- 2 files changed, 82 insertions(+), 32 deletions(-) diff --git a/room.cpp b/room.cpp index 01055013..65d0b775 100644 --- a/room.cpp +++ b/room.cpp @@ -102,7 +102,7 @@ class Room::Private members_map_t membersMap; QList usersTyping; QList membersLeft; - bool unreadMessages = false; + int unreadMessages = 0; bool displayed = false; QString firstDisplayedEventId; QString lastDisplayedEventId; @@ -113,6 +113,8 @@ class Room::Private QString prevBatch; QPointer roomMessagesJob; + static const QString UnreadMsgsKey; + struct FileTransferPrivateInfo { #ifdef WORKAROUND_EXTENDED_INITIALIZER_LIST @@ -193,6 +195,8 @@ class Room::Private void checkUnreadMessages(timeline_iter_t from); void setLastReadEvent(User* u, const QString& eventId); + void updateUnreadCount(timeline_iter_t from, int knownMinimum = 0); + void addUnreadCount(timeline_iter_t from, timeline_iter_t to); rev_iter_pair_t promoteReadMarker(User* u, rev_iter_t newMarker, bool force = false); @@ -226,6 +230,9 @@ class Room::Private } }; +const QString Room::Private::UnreadMsgsKey = + QStringLiteral("x-qmatrixclient.unread_messages_count"); + RoomEventPtr TimelineItem::replaceEvent(RoomEventPtr&& other) { return std::exchange(evt, std::move(other)); @@ -359,6 +366,45 @@ void Room::Private::setLastReadEvent(User* u, const QString& eventId) } } +void Room::Private::updateUnreadCount(timeline_iter_t from, int knownMinimum) +{ + Q_ASSERT(from >= q->readMarker().base() && from < timeline.cend()); + auto oldUnreadCount = unreadMessages; + QElapsedTimer et; et.start(); + unreadMessages = std::max(knownMinimum, + count_if(from, timeline.cend(), + std::bind(&Room::Private::isEventNotable, this, _1))); + if (et.elapsed() > 10) + qCDebug(PROFILER) << "Recounting unread messages took" << et; + + if (unreadMessages != oldUnreadCount) + { + qCDebug(MAIN) << "Room" << displayname + << (q->readMarker() == timeline.crend() ? "has at least" : "has") + << unreadMessages << "unread message(s)"; + emit q->unreadMessagesChanged(q); + } +} + +void Room::Private::addUnreadCount(timeline_iter_t from, timeline_iter_t to) +{ + QElapsedTimer et; et.start(); + const auto newUnreadMessages = count_if(from, to, + std::bind(&Room::Private::isEventNotable, this, _1)); + if (et.elapsed() > 10) + qCDebug(PROFILER) << "Counting gained unread messages took" << et; + + if(newUnreadMessages > 0) + { + unreadMessages += newUnreadMessages; + qCDebug(MAIN) << "Room" << displayname << "has gained" + << newUnreadMessages << "unread messages, total unread" + << (q->readMarker() == timeline.crend() ? " at least" : "") + << unreadMessages << "message(s)"; + emit q->unreadMessagesChanged(q); + } +} + Room::Private::rev_iter_pair_t Room::Private::promoteReadMarker(User* u, Room::rev_iter_t newMarker, bool force) @@ -378,19 +424,15 @@ Room::Private::promoteReadMarker(User* u, Room::rev_iter_t newMarker, [=](const TimelineItem& ti) { return ti->senderId() != u->id(); }); setLastReadEvent(u, (*(eagerMarker - 1))->id()); - if (isLocalUser(u) && unreadMessages) + if (isLocalUser(u)) { - auto stillUnreadMessagesCount = count_if(eagerMarker, timeline.cend(), - std::bind(&Room::Private::isEventNotable, this, _1)); - - if (stillUnreadMessagesCount == 0) + updateUnreadCount(eagerMarker); + if (unreadMessages == 0) { - unreadMessages = false; qCDebug(MAIN) << "Room" << displayname << "has no more unread messages"; - emit q->unreadMessagesChanged(q); } else qCDebug(MAIN) << "Room" << displayname << "still has" - << stillUnreadMessagesCount << "unread message(s)"; + << unreadMessages << "unread message(s)"; } // Return newMarker, rather than eagerMarker, to save markMessagesAsRead() @@ -429,7 +471,12 @@ void Room::markAllMessagesAsRead() d->markMessagesAsRead(d->timeline.crbegin()); } -bool Room::hasUnreadMessages() +bool Room::hasUnreadMessages() const +{ + return unreadMessagesCount() > 0; +} + +int Room::unreadMessagesCount() const { return d->unreadMessages; } @@ -1324,9 +1371,6 @@ void Room::Private::addNewMessageEvents(RoomEvents&& events) void Room::Private::checkUnreadMessages(timeline_iter_t from) { Q_ASSERT(from < timeline.cend()); - const auto newUnreadMessages = count_if(from, timeline.cend(), - std::bind(&Room::Private::isEventNotable, this, _1)); - // 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 @@ -1341,12 +1385,7 @@ void Room::Private::checkUnreadMessages(timeline_iter_t from) << "to" << *q->readMarker(firstWriter); } - if(!unreadMessages && newUnreadMessages > 0) - { - unreadMessages = true; - emit q->unreadMessagesChanged(q); - qCDebug(MAIN) << "Room" << displayname << "has unread messages"; - } + addUnreadCount(from, timeline.cend()); } void Room::Private::addHistoricalMessageEvents(RoomEvents&& events) @@ -1367,12 +1406,18 @@ void Room::Private::addHistoricalMessageEvents(RoomEvents&& events) // Catch a special case when the last read event id refers to an event // that was outside the loaded timeline and has just arrived. Depending on // other messages next to the last read one, we might need to promote - // the read marker and update unreadMessages flag. + // the read marker and update unreadMessages. const auto curReadMarker = q->readMarker(); - if (thereWasNoReadMarker && curReadMarker != timeline.crend()) + if (thereWasNoReadMarker) { - qCDebug(MAIN) << "Discovered last read event in a historical batch"; - promoteReadMarker(q->localUser(), curReadMarker, true); + if (curReadMarker != timeline.crend()) + { + qCDebug(MAIN) << "Discovered last read event in a historical batch"; + promoteReadMarker(q->localUser(), curReadMarker, true); + } + else + addUnreadCount(timeline.cbegin(), + timeline.cbegin() + insertedSize); } qCDebug(MAIN) << "Room" << displayname << "received" << insertedSize << "past events; the oldest event is now" << timeline.front(); @@ -1573,17 +1618,22 @@ void Room::processAccountDataEvent(EventPtr event) const auto* rmEvent = static_cast(event.get()); const auto& readEventId = rmEvent->event_id(); qCDebug(MAIN) << "Server-side read marker at " << readEventId; - static const auto UnreadMsgsKey = - QStringLiteral("x-qmatrixclient.unread_messages"); - if (rmEvent->contentJson().contains(UnreadMsgsKey)) - d->unreadMessages = - rmEvent->contentJson().value(UnreadMsgsKey).toBool(); d->serverReadMarker = readEventId; const auto newMarker = findInTimeline(readEventId); if (newMarker != timelineEdge()) d->markMessagesAsRead(newMarker); - else + else { d->setLastReadEvent(localUser(), readEventId); + // No accurate information about the read marker whereabouts. + // There two sources of information; the (difference between + // the old and the) new read marker and the contents of + // UnreadMsgsKey. + if (rmEvent->contentJson().contains(d->UnreadMsgsKey)) + d->unreadMessages = + rmEvent->contentJson().value(d->UnreadMsgsKey).toInt(); + + d->updateUnreadCount(timelineEdge().base(), d->unreadMessages); + } break; } default: @@ -1731,8 +1781,7 @@ QJsonObject Room::Private::toJson() const if (!serverReadMarker.isEmpty()) { auto contentJson = ReadMarkerEvent(serverReadMarker).toJson(); - contentJson.insert(QStringLiteral("x-qmatrixclient.unread_messages"), - unreadMessages); + contentJson.insert(UnreadMsgsKey, unreadMessages); accountDataEvents.append(QJsonObject( { { QStringLiteral("type"), ReadMarkerEvent::typeId() } , { QStringLiteral("content"), contentJson } diff --git a/room.h b/room.h index 59566092..c153bfc3 100644 --- a/room.h +++ b/room.h @@ -229,7 +229,8 @@ namespace QMatrixClient */ void markMessagesAsRead(QString uptoEventId); - Q_INVOKABLE bool hasUnreadMessages(); + Q_INVOKABLE bool hasUnreadMessages() const; + int unreadMessagesCount() const; Q_INVOKABLE int notificationCount() const; Q_INVOKABLE void resetNotificationCount(); -- cgit v1.2.3 From 85d0ea867ee9b607595962dc93d4f09ac0ae1f9a Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 26 Mar 2018 08:29:31 -0400 Subject: Fix compilation on some environments ...where deque<>::difference_type is long rather than int. --- room.cpp | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/room.cpp b/room.cpp index 65d0b775..01cba079 100644 --- a/room.cpp +++ b/room.cpp @@ -371,9 +371,11 @@ void Room::Private::updateUnreadCount(timeline_iter_t from, int knownMinimum) Q_ASSERT(from >= q->readMarker().base() && from < timeline.cend()); auto oldUnreadCount = unreadMessages; QElapsedTimer et; et.start(); + // A cast to int, because on some environments count_if returns a long; + // but Qt can only handle int's for container indices etc. unreadMessages = std::max(knownMinimum, - count_if(from, timeline.cend(), - std::bind(&Room::Private::isEventNotable, this, _1))); + int(count_if(from, timeline.cend(), + std::bind(&Room::Private::isEventNotable, this, _1)))); if (et.elapsed() > 10) qCDebug(PROFILER) << "Recounting unread messages took" << et; -- cgit v1.2.3 From d38020752c4a03fdc5b74f9704b28b302ec5ebf8 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 26 Mar 2018 23:13:42 +0900 Subject: Room::updateUnreadCount(): Fix a too stringent assertion --- room.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/room.cpp b/room.cpp index 01cba079..d7014a10 100644 --- a/room.cpp +++ b/room.cpp @@ -368,7 +368,7 @@ void Room::Private::setLastReadEvent(User* u, const QString& eventId) void Room::Private::updateUnreadCount(timeline_iter_t from, int knownMinimum) { - Q_ASSERT(from >= q->readMarker().base() && from < timeline.cend()); + Q_ASSERT(from >= q->readMarker().base() && from <= timeline.cend()); auto oldUnreadCount = unreadMessages; QElapsedTimer et; et.start(); // A cast to int, because on some environments count_if returns a long; -- cgit v1.2.3 From f213e02daa6b9e83e8e76d1576e446357c6c3bc7 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Tue, 27 Mar 2018 20:34:46 +0900 Subject: Rework unread messages counting logic The previous one didn't cover all the cases; the current one seems to do. Closes #192. Accompanied by the developer's notes at: https://github.com/QMatrixClient/libqmatrixclient/wiki/unread_count --- connection.cpp | 2 +- jobs/syncjob.cpp | 22 ++++-- jobs/syncjob.h | 3 + room.cpp | 237 ++++++++++++++++++++++++++----------------------------- room.h | 24 +++++- 5 files changed, 153 insertions(+), 135 deletions(-) diff --git a/connection.cpp b/connection.cpp index e4e622a3..ee719b40 100644 --- a/connection.cpp +++ b/connection.cpp @@ -792,7 +792,7 @@ void Connection::setHomeserver(const QUrl& url) } static constexpr int CACHE_VERSION_MAJOR = 6; -static constexpr int CACHE_VERSION_MINOR = 0; +static constexpr int CACHE_VERSION_MINOR = 1; void Connection::saveState(const QUrl &toFile) const { diff --git a/jobs/syncjob.cpp b/jobs/syncjob.cpp index ed579f12..435dfd0e 100644 --- a/jobs/syncjob.cpp +++ b/jobs/syncjob.cpp @@ -89,6 +89,9 @@ BaseJob::Status SyncData::parseJson(const QJsonDocument &data) return BaseJob::Success; } +const QString SyncRoomData::UnreadCountKey = + QStringLiteral("x-qmatrixclient.unread_count"); + SyncRoomData::SyncRoomData(const QString& roomId_, JoinState joinState_, const QJsonObject& room_) : roomId(roomId_) @@ -116,12 +119,15 @@ SyncRoomData::SyncRoomData(const QString& roomId_, JoinState joinState_, qCWarning(SYNCJOB) << "SyncRoomData: Unknown JoinState value, ignoring:" << int(joinState); } - QJsonObject timeline = room_.value("timeline").toObject(); - timelineLimited = timeline.value("limited").toBool(); - timelinePrevBatch = timeline.value("prev_batch").toString(); - - QJsonObject unread = room_.value("unread_notifications").toObject(); - highlightCount = unread.value("highlight_count").toInt(); - notificationCount = unread.value("notification_count").toInt(); - qCDebug(SYNCJOB) << "Highlights: " << highlightCount << " Notifications:" << notificationCount; + auto timelineJson = room_.value("timeline").toObject(); + timelineLimited = timelineJson.value("limited").toBool(); + timelinePrevBatch = timelineJson.value("prev_batch").toString(); + + auto unreadJson = room_.value("unread_notifications").toObject(); + unreadCount = unreadJson.value(UnreadCountKey).toInt(-2); + highlightCount = unreadJson.value("highlight_count").toInt(); + notificationCount = unreadJson.value("notification_count").toInt(); + if (highlightCount > 0 || notificationCount > 0) + qCDebug(SYNCJOB) << "Highlights: " << highlightCount + << " Notifications:" << notificationCount; } diff --git a/jobs/syncjob.h b/jobs/syncjob.h index 5956e73b..919060be 100644 --- a/jobs/syncjob.h +++ b/jobs/syncjob.h @@ -53,6 +53,7 @@ namespace QMatrixClient bool timelineLimited; QString timelinePrevBatch; + int unreadCount; int highlightCount; int notificationCount; @@ -60,6 +61,8 @@ namespace QMatrixClient const QJsonObject& room_); SyncRoomData(SyncRoomData&&) = default; SyncRoomData& operator=(SyncRoomData&&) = default; + + static const QString UnreadCountKey; }; // QVector cannot work with non-copiable objects, std::vector can. using SyncDataList = std::vector; diff --git a/room.cpp b/room.cpp index d7014a10..9dec2b4a 100644 --- a/room.cpp +++ b/room.cpp @@ -72,7 +72,6 @@ class Room::Private public: /** Map of user names to users. User names potentially duplicate, hence a multi-hashmap. */ typedef QMultiHash members_map_t; - typedef std::pair rev_iter_pair_t; Private(Connection* c, QString id_, JoinState initialJoinState) : q(nullptr), connection(c), id(std::move(id_)) @@ -113,8 +112,6 @@ class Room::Private QString prevBatch; QPointer roomMessagesJob; - static const QString UnreadMsgsKey; - struct FileTransferPrivateInfo { #ifdef WORKAROUND_EXTENDED_INITIALIZER_LIST @@ -192,12 +189,10 @@ class Room::Private * Removes events from the passed container that are already in the timeline */ void dropDuplicateEvents(RoomEvents* events) const; - void checkUnreadMessages(timeline_iter_t from); void setLastReadEvent(User* u, const QString& eventId); - void updateUnreadCount(timeline_iter_t from, int knownMinimum = 0); - void addUnreadCount(timeline_iter_t from, timeline_iter_t to); - rev_iter_pair_t promoteReadMarker(User* u, rev_iter_t newMarker, + void updateUnreadCount(rev_iter_t from, rev_iter_t to); + void promoteReadMarker(User* u, rev_iter_t newMarker, bool force = false); void markMessagesAsRead(rev_iter_t upToMarker); @@ -230,9 +225,6 @@ class Room::Private } }; -const QString Room::Private::UnreadMsgsKey = - QStringLiteral("x-qmatrixclient.unread_messages_count"); - RoomEventPtr TimelineItem::replaceEvent(RoomEventPtr&& other) { return std::exchange(evt, std::move(other)); @@ -366,57 +358,55 @@ void Room::Private::setLastReadEvent(User* u, const QString& eventId) } } -void Room::Private::updateUnreadCount(timeline_iter_t from, int knownMinimum) +void Room::Private::updateUnreadCount(rev_iter_t from, rev_iter_t to) { - Q_ASSERT(from >= q->readMarker().base() && from <= timeline.cend()); - auto oldUnreadCount = unreadMessages; - QElapsedTimer et; et.start(); - // A cast to int, because on some environments count_if returns a long; - // but Qt can only handle int's for container indices etc. - unreadMessages = std::max(knownMinimum, - int(count_if(from, timeline.cend(), - std::bind(&Room::Private::isEventNotable, this, _1)))); - if (et.elapsed() > 10) - qCDebug(PROFILER) << "Recounting unread messages took" << et; - - if (unreadMessages != oldUnreadCount) + 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) { - qCDebug(MAIN) << "Room" << displayname - << (q->readMarker() == timeline.crend() ? "has at least" : "has") - << unreadMessages << "unread message(s)"; - emit q->unreadMessagesChanged(q); + qCDebug(MAIN) << "Discovered last read event in room" << displayname; + promoteReadMarker(q->localUser(), readMarker, true); + return; } -} -void Room::Private::addUnreadCount(timeline_iter_t from, timeline_iter_t to) -{ + Q_ASSERT(to <= readMarker); + QElapsedTimer et; et.start(); const auto newUnreadMessages = count_if(from, to, std::bind(&Room::Private::isEventNotable, this, _1)); - if (et.elapsed() > 10) + if (et.nsecsElapsed() > 10000) qCDebug(PROFILER) << "Counting gained unread messages took" << et; if(newUnreadMessages > 0) { + // See https://github.com/QMatrixClient/libqmatrixclient/wiki/unread_count + if (unreadMessages < 0) + unreadMessages = 0; + unreadMessages += newUnreadMessages; qCDebug(MAIN) << "Room" << displayname << "has gained" - << newUnreadMessages << "unread messages, total unread" - << (q->readMarker() == timeline.crend() ? " at least" : "") - << unreadMessages << "message(s)"; + << newUnreadMessages << "unread message(s)," + << (q->readMarker() == timeline.crend() ? + "in total at least" : "in total") + << unreadMessages << "unread message(s)"; emit q->unreadMessagesChanged(q); } } -Room::Private::rev_iter_pair_t -Room::Private::promoteReadMarker(User* u, Room::rev_iter_t newMarker, - bool force) +void 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 { prevMarker, prevMarker }; + return; Q_ASSERT(newMarker < timeline.crend()); @@ -428,35 +418,47 @@ Room::Private::promoteReadMarker(User* u, Room::rev_iter_t newMarker, setLastReadEvent(u, (*(eagerMarker - 1))->id()); if (isLocalUser(u)) { - updateUnreadCount(eagerMarker); + const auto oldUnreadCount = unreadMessages; + QElapsedTimer et; et.start(); + unreadMessages = count_if(eagerMarker, timeline.cend(), + std::bind(&Room::Private::isEventNotable, this, _1)); + if (et.nsecsElapsed() > 10000) + qCDebug(PROFILER) << "Recounting unread messages took" << et; + + // See https://github.com/QMatrixClient/libqmatrixclient/wiki/unread_count if (unreadMessages == 0) + unreadMessages = -1; + + if (force || unreadMessages != oldUnreadCount) { - qCDebug(MAIN) << "Room" << displayname << "has no more unread messages"; - } else - qCDebug(MAIN) << "Room" << displayname << "still has" - << unreadMessages << "unread message(s)"; + 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); + } } - - // Return newMarker, rather than eagerMarker, to save markMessagesAsRead() - // (that calls this method) from going back through knowingly-local messages. - return { prevMarker, newMarker }; } -void Room::Private::markMessagesAsRead(Room::rev_iter_t upToMarker) +void Room::Private::markMessagesAsRead(rev_iter_t upToMarker) { - rev_iter_pair_t markers = promoteReadMarker(q->localUser(), upToMarker); - if (markers.first != markers.second) + const auto prevMarker = q->readMarker(); + 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 (; markers.second < markers.first; ++markers.second) + for (; upToMarker < prevMarker; ++upToMarker) { - if ((*markers.second)->senderId() != q->localUser()->id()) + if ((*upToMarker)->senderId() != q->localUser()->id()) { connection->callApi(id, "m.read", - (*markers.second)->id()); + (*upToMarker)->id()); break; } } @@ -475,10 +477,10 @@ void Room::markAllMessagesAsRead() bool Room::hasUnreadMessages() const { - return unreadMessagesCount() > 0; + return unreadCount() >= 0; } -int Room::unreadMessagesCount() const +int Room::unreadCount() const { return d->unreadMessages; } @@ -1032,6 +1034,14 @@ void Room::updateData(SyncRoomData&& data) for( auto&& ephemeralEvent: data.ephemeral ) processEphemeralEvent(move(ephemeralEvent)); + // See https://github.com/QMatrixClient/libqmatrixclient/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; @@ -1352,42 +1362,38 @@ void Room::Private::addNewMessageEvents(RoomEvents&& events) if (!normalEvents.empty()) emit q->aboutToAddNewMessages(normalEvents); const auto insertedSize = insertEvents(std::move(normalEvents), Newer); + const auto from = timeline.cend() - insertedSize; if (insertedSize > 0) { qCDebug(MAIN) << "Room" << displayname << "received" << insertedSize << "new events; the last event is now" << timeline.back(); - q->onAddNewTimelineEvents(timeline.cend() - insertedSize); + q->onAddNewTimelineEvents(from); } for (auto&& r: redactions) processRedaction(move(r)); if (insertedSize > 0) { emit q->addedMessages(); - checkUnreadMessages(timeline.cend() - insertedSize); - } - Q_ASSERT(timeline.size() == timelineSize + insertedSize); -} + // 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()) + { + promoteReadMarker(firstWriter, rev_iter_t(from) - 1); + qCDebug(MAIN) << "Auto-promoted read marker for" << firstWriter->id() + << "to" << *q->readMarker(firstWriter); + } -void Room::Private::checkUnreadMessages(timeline_iter_t from) -{ - Q_ASSERT(from < timeline.cend()); - // 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()) - { - promoteReadMarker(firstWriter, q->findInTimeline((*from)->id())); - qCDebug(MAIN) << "Auto-promoted read marker for" << firstWriter->id() - << "to" << *q->readMarker(firstWriter); + updateUnreadCount(timeline.crbegin(), rev_iter_t(from)); } - addUnreadCount(from, timeline.cend()); + Q_ASSERT(timeline.size() == timelineSize + insertedSize); } void Room::Private::addHistoricalMessageEvents(RoomEvents&& events) @@ -1402,30 +1408,17 @@ void Room::Private::addHistoricalMessageEvents(RoomEvents&& events) return; emit q->aboutToAddHistoricalMessages(normalEvents); - const bool thereWasNoReadMarker = q->readMarker() == timeline.crend(); const auto insertedSize = insertEvents(std::move(normalEvents), Older); + const auto from = timeline.crend() - insertedSize; - // Catch a special case when the last read event id refers to an event - // that was outside the loaded timeline and has just arrived. Depending on - // other messages next to the last read one, we might need to promote - // the read marker and update unreadMessages. - const auto curReadMarker = q->readMarker(); - if (thereWasNoReadMarker) - { - if (curReadMarker != timeline.crend()) - { - qCDebug(MAIN) << "Discovered last read event in a historical batch"; - promoteReadMarker(q->localUser(), curReadMarker, true); - } - else - addUnreadCount(timeline.cbegin(), - timeline.cbegin() + insertedSize); - } qCDebug(MAIN) << "Room" << displayname << "received" << insertedSize << "past events; the oldest event is now" << timeline.front(); - q->onAddHistoricalTimelineEvents(timeline.crend() - insertedSize); + q->onAddHistoricalTimelineEvents(from); emit q->addedMessages(); + if (from <= q->readMarker()) + updateUnreadCount(from, timeline.crend()); + Q_ASSERT(timeline.size() == timelineSize + insertedSize); } @@ -1610,7 +1603,7 @@ void Room::processAccountDataEvent(EventPtr event) if (newTags == d->tags) break; d->tags = newTags; - qCDebug(MAIN) << "Room" << id() << "is tagged with: " + qCDebug(MAIN) << "Room" << id() << "is tagged with:" << tagNames().join(", "); emit tagsChanged(); break; @@ -1619,22 +1612,13 @@ void Room::processAccountDataEvent(EventPtr event) { const auto* rmEvent = static_cast(event.get()); const auto& readEventId = rmEvent->event_id(); - qCDebug(MAIN) << "Server-side read marker at " << readEventId; + qCDebug(MAIN) << "Server-side read marker at" << readEventId; d->serverReadMarker = readEventId; const auto newMarker = findInTimeline(readEventId); if (newMarker != timelineEdge()) d->markMessagesAsRead(newMarker); else { d->setLastReadEvent(localUser(), readEventId); - // No accurate information about the read marker whereabouts. - // There two sources of information; the (difference between - // the old and the) new read marker and the contents of - // UnreadMsgsKey. - if (rmEvent->contentJson().contains(d->UnreadMsgsKey)) - d->unreadMessages = - rmEvent->contentJson().value(d->UnreadMsgsKey).toInt(); - - d->updateUnreadCount(timelineEdge().base(), d->unreadMessages); } break; } @@ -1744,6 +1728,22 @@ void appendStateEvent(QJsonArray& events, const QString& type, appendStateEvent((events), QStringLiteral(type), \ {{ QStringLiteral(name), content }}); +void appendEvent(QJsonArray& events, const QString& type, + const QJsonObject& content) +{ + if (!content.isEmpty()) + events.append(QJsonObject + { { QStringLiteral("type"), type } + , { QStringLiteral("content"), content } + }); +} + +template +void appendEvent(QJsonArray& events, const EvtT& event) +{ + appendEvent(events, EvtT::TypeId, event.toJson()); +} + QJsonObject Room::Private::toJson() const { QElapsedTimer et; et.start(); @@ -1775,39 +1775,28 @@ QJsonObject Room::Private::toJson() const QJsonArray accountDataEvents; if (!tags.empty()) - accountDataEvents.append(QJsonObject( - { { QStringLiteral("type"), TagEvent::typeId() } - , { QStringLiteral("content"), TagEvent(tags).toJson() } - })); + appendEvent(accountDataEvents, TagEvent(tags)); if (!serverReadMarker.isEmpty()) - { - auto contentJson = ReadMarkerEvent(serverReadMarker).toJson(); - contentJson.insert(UnreadMsgsKey, unreadMessages); - accountDataEvents.append(QJsonObject( - { { QStringLiteral("type"), ReadMarkerEvent::typeId() } - , { QStringLiteral("content"), contentJson } - })); - } + appendEvent(accountDataEvents, ReadMarkerEvent(serverReadMarker)); if (!accountData.empty()) { for (auto it = accountData.begin(); it != accountData.end(); ++it) - accountDataEvents.append(QJsonObject { - {"type", it.key()}, - {"content", QJsonObject::fromVariantHash(it.value())} - }); + appendEvent(accountDataEvents, it.key(), + QJsonObject::fromVariantHash(it.value())); } - QJsonObject accountDataEventsObj; result.insert("account_data", QJsonObject {{ "events", accountDataEvents }}); QJsonObject unreadNotificationsObj; + + unreadNotificationsObj.insert(SyncRoomData::UnreadCountKey, unreadMessages); if (highlightCount > 0) unreadNotificationsObj.insert("highlight_count", highlightCount); if (notificationCount > 0) unreadNotificationsObj.insert("notification_count", notificationCount); - if (!unreadNotificationsObj.isEmpty()) - result.insert("unread_notifications", unreadNotificationsObj); + + result.insert("unread_notifications", unreadNotificationsObj); if (et.elapsed() > 50) qCDebug(PROFILER) << "Room::toJson() for" << displayname << "took" << et; diff --git a/room.h b/room.h index c153bfc3..015e9dfc 100644 --- a/room.h +++ b/room.h @@ -113,6 +113,8 @@ namespace QMatrixClient Q_PROPERTY(QString lastDisplayedEventId READ lastDisplayedEventId WRITE setLastDisplayedEventId NOTIFY lastDisplayedEventChanged) Q_PROPERTY(QString readMarkerEventId READ readMarkerEventId WRITE markMessagesAsRead NOTIFY readMarkerMoved) + Q_PROPERTY(bool hasUnreadMessages READ hasUnreadMessages NOTIFY unreadMessagesChanged) + Q_PROPERTY(int unreadCount READ unreadCount NOTIFY unreadMessagesChanged) Q_PROPERTY(QStringList tagNames READ tagNames NOTIFY tagsChanged) public: @@ -229,8 +231,26 @@ namespace QMatrixClient */ void markMessagesAsRead(QString uptoEventId); - Q_INVOKABLE bool hasUnreadMessages() const; - int unreadMessagesCount() const; + /** Check whether there are unread messages in the room */ + bool hasUnreadMessages() const; + + /** Get the number of unread messages in the room + * Depending on the read marker state, this call may return either + * a precise or an estimate number of unread events. Only "notable" + * events (non-redacted message events from users other than local) + * are counted. + * + * In a case when readMarker() == timelineEdge() (the local read + * marker is beyond the local timeline) only the bottom limit of + * the unread messages number can be estimated (and even that may + * be slightly off due to, e.g., redactions of events not loaded + * to the local timeline). + * + * If all messages are read, this function will return -1 (_not_ 0, + * as zero may mean "zero or more unread messages" in a situation + * when the read marker is outside the local timeline. + */ + int unreadCount() const; Q_INVOKABLE int notificationCount() const; Q_INVOKABLE void resetNotificationCount(); -- cgit v1.2.3 From 503957c86a84f1be190719a17984df1bb1267658 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Wed, 28 Mar 2018 11:29:41 +0900 Subject: BaseJob: small refactoring and cleanup in logging code --- jobs/basejob.cpp | 17 +++-------------- jobs/basejob.h | 12 +++++++++++- 2 files changed, 14 insertions(+), 15 deletions(-) diff --git a/jobs/basejob.cpp b/jobs/basejob.cpp index eb250723..5198c45c 100644 --- a/jobs/basejob.cpp +++ b/jobs/basejob.cpp @@ -84,18 +84,6 @@ class BaseJob::Private LoggingCategory logCat = JOBS; }; -inline QDebug operator<<(QDebug dbg, const BaseJob* j) -{ - return dbg << j->objectName(); -} - -QDebug QMatrixClient::operator<<(QDebug dbg, const BaseJob::Status& s) -{ - QRegularExpression filter { "(access_token)(=|: )[-_A-Za-z0-9]+" }; - return dbg << s.code << ':' - << QString(s.message).replace(filter, "\\1 HIDDEN"); -} - BaseJob::BaseJob(HttpVerb verb, const QString& name, const QString& endpoint, bool needsToken) : BaseJob(verb, name, endpoint, Query { }, Data { }, needsToken) { } @@ -319,7 +307,7 @@ BaseJob::Status BaseJob::checkReply(QNetworkReply* reply) const if (checkContentType(reply->rawHeader("Content-Type"), d->expectedContentTypes)) return NoError; - else + else // A warning in the logs might be more proper instead return { IncorrectResponseError, "Incorrect content type of the response" }; @@ -383,7 +371,7 @@ void BaseJob::finishJob() const auto retryInterval = error() == TimeoutError ? 0 : getNextRetryInterval(); ++d->retriesTaken; - qCWarning(d->logCat) << this << "will take retry" << d->retriesTaken + qCWarning(d->logCat) << this << "will retry" << d->retriesTaken << "in" << retryInterval/1000 << "s"; d->retryTimer.start(retryInterval); emit retryScheduled(d->retriesTaken, retryInterval); @@ -456,6 +444,7 @@ void BaseJob::setStatus(Status s) void BaseJob::setStatus(int code, QString message) { + message.replace(d->connection->accessToken(), "(REDACTED)"); setStatus({ code, message }); } diff --git a/jobs/basejob.h b/jobs/basejob.h index a5b457c5..fa253d96 100644 --- a/jobs/basejob.h +++ b/jobs/basejob.h @@ -98,7 +98,12 @@ namespace QMatrixClient Status(int c, QString m) : code(c), message(std::move(m)) { } bool good() const { return code < ErrorLevel; } - friend QDebug operator<<(QDebug dbg, const Status& s); + friend QDebug operator<<(QDebug dbg, const Status& s) + { + QDebug(dbg).noquote().nospace() + << s.code << ": " << s.message; + return dbg; + } int code; QString message; @@ -124,6 +129,11 @@ namespace QMatrixClient Q_INVOKABLE duration_t getNextRetryInterval() const; Q_INVOKABLE duration_t millisToRetry() const; + friend QDebug operator<<(QDebug dbg, const BaseJob* j) + { + return dbg << j->objectName(); + } + public slots: void start(const ConnectionData* connData); -- cgit v1.2.3 From d602de60433da80fc66a7152881d3dfe934eca62 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Wed, 28 Mar 2018 11:33:06 +0900 Subject: BaseJob: Process error 429 (Too Many Requests) The job will retry after the period either advised by the server or the default retry period. Closes #186. --- jobs/basejob.cpp | 24 ++++++++++++++++++++++++ jobs/basejob.h | 1 + 2 files changed, 25 insertions(+) diff --git a/jobs/basejob.cpp b/jobs/basejob.cpp index 5198c45c..37345338 100644 --- a/jobs/basejob.cpp +++ b/jobs/basejob.cpp @@ -263,7 +263,28 @@ void BaseJob::gotReply() { auto json = QJsonDocument::fromJson(d->reply->readAll()).object(); if (!json.isEmpty()) + { + if (error() == TooManyRequestsError) + { + QString msg = tr("Too many requests"); + auto retryInterval = json.value("retry_after_ms").toInt(-1); + if (retryInterval != -1) + msg += tr(", next retry advised after %1 ms") + .arg(retryInterval); + else // We still have to figure some reasonable interval + retryInterval = getNextRetryInterval(); + + setStatus(TooManyRequestsError, msg); + + // Shortcut to retry instead of executing the whole finishJob() + stop(); + qCWarning(d->logCat) << this << "will retry in" << retryInterval; + d->retryTimer.start(retryInterval); + emit retryScheduled(d->retriesTaken, retryInterval); + return; + } setStatus(IncorrectRequestError, json.value("error").toString()); + } } finishJob(); @@ -324,6 +345,9 @@ BaseJob::Status BaseJob::checkReply(QNetworkReply* reply) const return { NotFoundError, reply->errorString() }; default: + if (reply->attribute(QNetworkRequest::HttpStatusCodeAttribute) + .toInt() == 429) // Qt doesn't know about it yet + return { TooManyRequestsError, tr("Too many requests") }; return { NetworkError, reply->errorString() }; } } diff --git a/jobs/basejob.h b/jobs/basejob.h index fa253d96..ed630a67 100644 --- a/jobs/basejob.h +++ b/jobs/basejob.h @@ -62,6 +62,7 @@ namespace QMatrixClient , NotFoundError , IncorrectRequestError , IncorrectResponseError + , TooManyRequestsError , UserDefinedError = 200 }; -- cgit v1.2.3 From b2d22d7ce9d7235cf9ab61268e48102ff06cb727 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Wed, 28 Mar 2018 12:26:31 +0900 Subject: BaseJob: more improvements in logging and errors detection --- jobs/basejob.cpp | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/jobs/basejob.cpp b/jobs/basejob.cpp index 37345338..79cfb9e0 100644 --- a/jobs/basejob.cpp +++ b/jobs/basejob.cpp @@ -264,7 +264,8 @@ void BaseJob::gotReply() auto json = QJsonDocument::fromJson(d->reply->readAll()).object(); if (!json.isEmpty()) { - if (error() == TooManyRequestsError) + if (error() == TooManyRequestsError || + json.value("errcode").toString() == "M_LIMIT_EXCEEDED") { QString msg = tr("Too many requests"); auto retryInterval = json.value("retry_after_ms").toInt(-1); @@ -318,10 +319,16 @@ bool checkContentType(const QByteArray& type, const QByteArrayList& patterns) BaseJob::Status BaseJob::checkReply(QNetworkReply* reply) const { - qCDebug(d->logCat) << this << "returned" + const auto httpCode = + reply->attribute(QNetworkRequest::HttpStatusCodeAttribute).toInt(); + qCDebug(d->logCat).nospace().noquote() << this << " returned HTTP code " + << httpCode << ": " << (reply->error() == QNetworkReply::NoError ? "Success" : reply->errorString()) - << "from" << reply->url().toDisplayString(); + << " (URL: " << reply->url().toDisplayString() << ")"; + + // Should we check httpCode instead? Maybe even use it in BaseJob::Status? + // That would make codes logs slightly more readable. switch( reply->error() ) { case QNetworkReply::NoError: @@ -345,8 +352,7 @@ BaseJob::Status BaseJob::checkReply(QNetworkReply* reply) const return { NotFoundError, reply->errorString() }; default: - if (reply->attribute(QNetworkRequest::HttpStatusCodeAttribute) - .toInt() == 429) // Qt doesn't know about it yet + if (httpCode == 429) // Qt doesn't know about it yet return { TooManyRequestsError, tr("Too many requests") }; return { NetworkError, reply->errorString() }; } -- cgit v1.2.3 From 244fa53c10ee8697ff30e4135f6ac4cb4abb4506 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Wed, 28 Mar 2018 13:19:21 +0900 Subject: BaseJob: Dump error body (if there's any) to logs; detect error 429 more reliably --- jobs/basejob.cpp | 58 ++++++++++++++++++++++++++++++++------------------------ 1 file changed, 33 insertions(+), 25 deletions(-) diff --git a/jobs/basejob.cpp b/jobs/basejob.cpp index 79cfb9e0..3cde7c50 100644 --- a/jobs/basejob.cpp +++ b/jobs/basejob.cpp @@ -261,30 +261,37 @@ void BaseJob::gotReply() setStatus(parseReply(d->reply.data())); else { - auto json = QJsonDocument::fromJson(d->reply->readAll()).object(); - if (!json.isEmpty()) + const auto body = d->reply->readAll(); + if (!body.isEmpty()) { - if (error() == TooManyRequestsError || - json.value("errcode").toString() == "M_LIMIT_EXCEEDED") - { - QString msg = tr("Too many requests"); - auto retryInterval = json.value("retry_after_ms").toInt(-1); - if (retryInterval != -1) - msg += tr(", next retry advised after %1 ms") - .arg(retryInterval); - else // We still have to figure some reasonable interval - retryInterval = getNextRetryInterval(); - - setStatus(TooManyRequestsError, msg); - - // Shortcut to retry instead of executing the whole finishJob() - stop(); - qCWarning(d->logCat) << this << "will retry in" << retryInterval; - d->retryTimer.start(retryInterval); - emit retryScheduled(d->retriesTaken, retryInterval); - return; + qCDebug(d->logCat).noquote() << "Error body:" << body; + auto json = QJsonDocument::fromJson(body).object(); + if (json.isEmpty()) + setStatus(IncorrectRequestError, body); + else { + if (error() == TooManyRequestsError || + json.value("errcode").toString() == "M_LIMIT_EXCEEDED") + { + QString msg = tr("Too many requests"); + auto retryInterval = json.value("retry_after_ms").toInt(-1); + if (retryInterval != -1) + msg += tr(", next retry advised after %1 ms") + .arg(retryInterval); + else // We still have to figure some reasonable interval + retryInterval = getNextRetryInterval(); + + setStatus(TooManyRequestsError, msg); + + // Shortcut to retry instead of executing finishJob() + stop(); + qCWarning(d->logCat) + << this << "will retry in" << retryInterval; + d->retryTimer.start(retryInterval); + emit retryScheduled(d->retriesTaken, retryInterval); + return; + } + setStatus(IncorrectRequestError, json.value("error").toString()); } - setStatus(IncorrectRequestError, json.value("error").toString()); } } @@ -327,8 +334,11 @@ BaseJob::Status BaseJob::checkReply(QNetworkReply* reply) const "Success" : reply->errorString()) << " (URL: " << reply->url().toDisplayString() << ")"; + if (httpCode == 429) // Qt doesn't know about it yet + return { TooManyRequestsError, tr("Too many requests") }; + // Should we check httpCode instead? Maybe even use it in BaseJob::Status? - // That would make codes logs slightly more readable. + // That would make codes in logs slightly more readable. switch( reply->error() ) { case QNetworkReply::NoError: @@ -352,8 +362,6 @@ BaseJob::Status BaseJob::checkReply(QNetworkReply* reply) const return { NotFoundError, reply->errorString() }; default: - if (httpCode == 429) // Qt doesn't know about it yet - return { TooManyRequestsError, tr("Too many requests") }; return { NetworkError, reply->errorString() }; } } -- cgit v1.2.3 From e7868adbf5b275f66529fb2dae323ed8aeb69e05 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Thu, 29 Mar 2018 08:53:40 +0900 Subject: Room: Track encryption state and do not allow sending (unencrypted) messages to it Closes #138. This is of course not encryption support yet, rather a safeguard for rooms that use encryption. --- connection.cpp | 4 ++-- room.cpp | 21 +++++++++++++++++++++ room.h | 3 +++ 3 files changed, 26 insertions(+), 2 deletions(-) diff --git a/connection.cpp b/connection.cpp index ee719b40..2d7235b9 100644 --- a/connection.cpp +++ b/connection.cpp @@ -791,8 +791,8 @@ void Connection::setHomeserver(const QUrl& url) emit homeserverChanged(homeserver()); } -static constexpr int CACHE_VERSION_MAJOR = 6; -static constexpr int CACHE_VERSION_MINOR = 1; +static constexpr int CACHE_VERSION_MAJOR = 7; +static constexpr int CACHE_VERSION_MINOR = 0; void Connection::saveState(const QUrl &toFile) const { diff --git a/room.cpp b/room.cpp index 9dec2b4a..25669889 100644 --- a/room.cpp +++ b/room.cpp @@ -94,6 +94,7 @@ class Room::Private QString name; QString displayname; QString topic; + QString encryptionAlgorithm; Avatar avatar; JoinState joinState; int highlightCount = 0; @@ -883,6 +884,11 @@ int Room::timelineSize() const return int(d->timeline.size()); } +bool Room::usesEncryption() const +{ + return !d->encryptionAlgorithm.isEmpty(); +} + void Room::Private::insertMemberIntoMap(User *u) { const auto userName = u->name(q); @@ -1066,6 +1072,11 @@ void Room::postMessage(const QString& plainText, MessageEventType type) void Room::postMessage(const RoomMessageEvent& event) { + if (usesEncryption()) + { + qCCritical(MAIN) << "Room" << displayName() + << "enforces encryption; sending encrypted messages is not supported yet"; + } connection()->callApi(id(), event); } @@ -1509,6 +1520,14 @@ void Room::processStateEvents(const RoomEvents& events) } break; } + case EventType::RoomEncryption: + { + d->encryptionAlgorithm = + static_cast(event)->algorithm(); + qCDebug(MAIN) << "Encryption switched on in" << displayName(); + emit encryption(); + break; + } default: /* Ignore events of other types */; } } @@ -1759,6 +1778,8 @@ QJsonObject Room::Private::toJson() const QJsonArray::fromStringList(aliases)); ADD_STATE_EVENT(stateEvents, "m.room.canonical_alias", "alias", canonicalAlias); + ADD_STATE_EVENT(stateEvents, "m.room.encryption", "algorithm", + encryptionAlgorithm); for (const auto *m : membersMap) appendStateEvent(stateEvents, QStringLiteral("m.room.member"), diff --git a/room.h b/room.h index 015e9dfc..bdef04ee 100644 --- a/room.h +++ b/room.h @@ -103,6 +103,7 @@ namespace QMatrixClient Q_PROPERTY(QString topic READ topic NOTIFY topicChanged) Q_PROPERTY(QString avatarMediaId READ avatarMediaId NOTIFY avatarChanged STORED false) Q_PROPERTY(QUrl avatarUrl READ avatarUrl NOTIFY avatarChanged) + Q_PROPERTY(bool usesEncryption READ usesEncryption NOTIFY encryption) Q_PROPERTY(int timelineSize READ timelineSize NOTIFY addedMessages) Q_PROPERTY(QStringList memberNames READ memberNames NOTIFY memberListChanged) @@ -145,6 +146,7 @@ namespace QMatrixClient QStringList memberNames() const; int memberCount() const; int timelineSize() const; + bool usesEncryption() const; /** * Returns a square room avatar with the given size and requests it @@ -360,6 +362,7 @@ namespace QMatrixClient void memberAboutToRename(User* user, QString newName); void memberRenamed(User* user); void memberListChanged(); + void encryption(); void joinStateChanged(JoinState oldState, JoinState newState); void typingChanged(); -- cgit v1.2.3