Show invite reason in the UI (hidden by default)

src/Cache.cpp

@@ -2018,7 +2018,8 @@ Cache::saveInvite(lmdb::txn &txn,
             auto display_name =
               msg->content.display_name.empty() ? msg->state_key : msg->content.display_name;
 
-            MemberInfo tmp{display_name, msg->content.avatar_url, msg->content.is_direct};
+            MemberInfo tmp{
+              display_name, msg->content.avatar_url, msg->content.reason, msg->content.is_direct};
 
             membersdb.put(txn, msg->state_key, nlohmann::json(tmp).dump());
         } else {
@@ -3144,6 +3145,29 @@ Cache::getMembers(const std::string &room_id, std::size_t startIndex, std::size_
     }
 }
 
+std::optional<MemberInfo>
+Cache::getInviteMember(const std::string &room_id, const std::string &user_id)
+{
+    if (user_id.empty() || !env_.handle())
+        return std::nullopt;
+
+    try {
+        auto txn = ro_txn(env_);
+
+        auto membersdb = getInviteMembersDb(txn, room_id);
+
+        std::string_view info;
+        if (membersdb.get(txn, user_id, info)) {
+            MemberInfo m = nlohmann::json::parse(info).get<MemberInfo>();
+            return m;
+        }
+    } catch (std::exception &e) {
+        nhlog::db()->warn(
+          "Failed to read member ({}) in invite room ({}): {}", user_id, room_id, e.what());
+    }
+    return std::nullopt;
+}
+
 std::vector<RoomMember>
 Cache::getMembersFromInvite(const std::string &room_id, std::size_t startIndex, std::size_t len)
 {
@@ -4959,6 +4983,8 @@ to_json(nlohmann::json &j, const MemberInfo &info)
     j["avatar_url"] = info.avatar_url;
     if (info.is_direct)
         j["is_direct"] = info.is_direct;
+    if (!info.reason.empty())
+        j["reason"] = info.reason;
 }
 
 void
@@ -4967,6 +4993,7 @@ from_json(const nlohmann::json &j, MemberInfo &info)
     info.name       = j.at("name").get<std::string>();
     info.avatar_url = j.at("avatar_url").get<std::string>();
     info.is_direct  = j.value("is_direct", false);
+    info.reason     = j.value("reason", "");
 }
 
 void

src/CacheStructs.h

@@ -107,6 +107,7 @@ struct MemberInfo
 {
     std::string name;
     std::string avatar_url;
+    std::string reason;
     bool is_direct = false;
 };
 

src/Cache_p.h

@@ -244,6 +244,8 @@ public:
 
     //! Check if a user is a member of the room.
     bool isRoomMember(const std::string &user_id, const std::string &room_id);
+    std::optional<MemberInfo>
+    getInviteMember(const std::string &room_id, const std::string &user_id);
 
     //
     // Outbound Megolm Sessions
@@ -396,7 +398,7 @@ private:
                   e->content.display_name.empty() ? e->state_key : e->content.display_name;
 
                 // Lightweight representation of a member.
-                MemberInfo tmp{display_name, e->content.avatar_url};
+                MemberInfo tmp{display_name, e->content.avatar_url, e->content.reason};
 
                 membersdb.put(txn, e->state_key, nlohmann::json(tmp).dump());
                 break;
@@ -406,8 +408,8 @@ private:
                 break;
             }
             }
-
-            return;
+            // fallthrough to also store it as state event to eventually migrate away from a
+            // separate members db.
         } else if (std::holds_alternative<StateEvent<Encryption>>(event)) {
             setEncryptedRoom(txn, room_id);
             return;

src/timeline/RoomlistModel.cpp

@@ -723,6 +723,13 @@ RoomlistModel::getRoomPreviewById(QString roomid) const
         if (invites.contains(roomid)) {
             i                 = invites.value(roomid);
             preview.isInvite_ = true;
+
+            auto member = cache::client()->getInviteMember(roomid.toStdString(),
+                                                           http::client()->user_id().to_string());
+
+            if (member) {
+                preview.reason_ = QString::fromStdString(member->reason);
+            }
         } else {
             i                 = previewedRooms.value(roomid);
             preview.isInvite_ = false;
@@ -769,6 +776,13 @@ RoomlistModel::setCurrentRoom(const QString &roomid)
         if (invites.contains(roomid)) {
             i           = invites.value(roomid);
             p.isInvite_ = true;
+
+            auto member = cache::client()->getInviteMember(roomid.toStdString(),
+                                                           http::client()->user_id().to_string());
+
+            if (member) {
+                p.reason_ = QString::fromStdString(member->reason);
+            }
         } else {
             i           = previewedRooms.value(roomid);
             p.isInvite_ = false;

src/timeline/RoomlistModel.h

@@ -31,6 +31,7 @@ class RoomPreview
     Q_PROPERTY(QString roomName READ roomName CONSTANT)
     Q_PROPERTY(QString roomTopic READ roomTopic CONSTANT)
     Q_PROPERTY(QString roomAvatarUrl READ roomAvatarUrl CONSTANT)
+    Q_PROPERTY(QString reason READ reason CONSTANT)
     Q_PROPERTY(bool isInvite READ isInvite CONSTANT)
 
 public:
@@ -40,9 +41,10 @@ public:
     QString roomName() const { return roomName_; }
     QString roomTopic() const { return roomTopic_; }
     QString roomAvatarUrl() const { return roomAvatarUrl_; }
+    QString reason() const { return reason_; }
     bool isInvite() const { return isInvite_; }
 
-    QString roomid_, roomName_, roomAvatarUrl_, roomTopic_;
+    QString roomid_, roomName_, roomAvatarUrl_, roomTopic_, reason_;
     bool isInvite_ = false;
 };