Connection::userIds() and Quotient::isGuestUserId()

The former one is a replacement of Connection::users() that was removed
in #746 with no alternative provided; the latter one allows to check
MXIDs without having to create a User object, as User objects are
not something readily available from Connection (and besides, they were
never necessary to check if a user id is that of a guest).

Author: KitsuneRal

Quotient/connection.cpp

@@ -1302,6 +1302,8 @@ void Connection::removeFromIgnoredUsers(const QString& userId)
     }
 }
 
+QStringList Connection::userIds() const { return d->userMap.keys(); }
+
 const ConnectionData* Connection::connectionData() const
 {
     return d->data.get();

Quotient/connection.h

@@ -283,6 +283,11 @@ class QUOTIENT_API Connection : public QObject {
     //! \sa ignoredUsersListChanged
     Q_INVOKABLE void removeFromIgnoredUsers(const QString& userId);
 
+    //! \brief Get the entire list of users known to the current user on this homeserver
+    //! \note Be mindful that this can easily count thousands or tens of thousands, and use
+    //!       sparingly; when in a room context, always use Room::members() instead
+    Q_INVOKABLE QStringList userIds() const;
+
     //! Get the base URL of the homeserver to connect to
     QUrl homeserver() const;
     //! Get the domain name used for ids/aliases on the server

Quotient/connection_p.h

@@ -39,6 +39,7 @@ class Q_DECL_HIDDEN Quotient::Connection::Private {
     QHash<QString, QString> roomAliasMap;
     QVector<QString> roomIdsToForget;
     QVector<QString> pendingStateRoomIds;
+    // It's an ordered map to make Connection::userIds() return an already sorted list
     QMap<QString, User*> userMap;
     std::unordered_map<QString, Avatar> userAvatarMap;
     DirectChatsMap directChats;

Quotient/util.cpp

@@ -128,6 +128,12 @@ int Quotient::minorVersion()
 
 int Quotient::patchVersion() { return Quotient_VERSION_PATCH; }
 
+bool Quotient::isGuestUserId(const UserId& uId)
+{
+    static const QRegularExpression guestMxIdRe{ QStringLiteral("^@\\d+:") };
+    return guestMxIdRe.match(uId).hasMatch();
+}
+
 bool Quotient::HomeserverData::checkMatrixSpecVersion(QStringView targetVersion) const
 {
     // TODO: Replace this naïve implementation with something smarter that can check things like

Quotient/util.h

@@ -429,6 +429,8 @@ using UserId = QString;
 using RoomId = QString;
 using EventId = QString;
 
+QUOTIENT_API bool isGuestUserId(const UserId& uId);
+
 struct QUOTIENT_API HomeserverData {
     QUrl baseUrl;
     QStringList supportedSpecVersions;

autotests/utiltests.cpp

@@ -25,6 +25,7 @@ class TestUtils : public QObject {
     Q_OBJECT
 private Q_SLOTS:
     void testLinkifyUrl();
+    void testIsGuestUserId();
 
 private:
     void testLinkified(QString original, const QString& expected, const int sourceLine) const
@@ -69,5 +70,11 @@ void TestUtils::testLinkifyUrl()
 #undef T
 }
 
+void TestUtils::testIsGuestUserId()
+{
+    QVERIFY(isGuestUserId("@123:example.org"_ls));
+    QVERIFY(!isGuestUserId("@normal:example.org"_ls));
+}
+
 QTEST_APPLESS_MAIN(TestUtils)
 #include "utiltests.moc"