Suggested rooms spaces

Add the ability to set and show suggested rooms for spaces. 

This is just adding the basic functionality, we can do more things with it later like sort/filter the space home for example.

src/models/spacechildrenmodel.cpp

@@ -86,6 +86,7 @@ void SpaceChildrenModel::insertChildren(std::vector<Quotient::GetSpaceHierarchyJ
     SpaceTreeItem *parentItem = getItem(parent);
 
     if (children[0].roomId == m_space->id() || children[0].roomId == parentItem->id()) {
+        parentItem->setChildStates(std::move(children[0].childrenState));
         children.erase(children.begin());
     }
 
@@ -112,6 +113,13 @@ void SpaceChildrenModel::insertChildren(std::vector<Quotient::GetSpaceHierarchyJ
                     m_replacedRooms += successorId;
                 }
             }
+            if (children[i].childrenState.size() > 0) {
+                auto job = m_space->connection()->callApi<Quotient::GetSpaceHierarchyJob>(children[i].roomId, Quotient::none, Quotient::none, 1);
+                m_currentJobs.append(job);
+                connect(job, &Quotient::BaseJob::success, this, [this, parent, insertRow, job]() {
+                    insertChildren(job->rooms(), index(insertRow, 0, parent));
+                });
+            }
             parentItem->insertChild(insertRow,
                                     new SpaceTreeItem(dynamic_cast<NeoChatConnection *>(m_space->connection()),
                                                       parentItem,
@@ -123,14 +131,8 @@ void SpaceChildrenModel::insertChildren(std::vector<Quotient::GetSpaceHierarchyJ
                                                       children[i].avatarUrl,
                                                       children[i].guestCanJoin,
                                                       children[i].worldReadable,
-                                                      children[i].roomType == QLatin1String("m.space")));
-            if (children[i].childrenState.size() > 0) {
-                auto job = m_space->connection()->callApi<Quotient::GetSpaceHierarchyJob>(children[i].roomId, Quotient::none, Quotient::none, 1);
-                m_currentJobs.append(job);
-                connect(job, &Quotient::BaseJob::success, this, [this, parent, insertRow, job]() {
-                    insertChildren(job->rooms(), index(insertRow, 0, parent));
-                });
-            }
+                                                      children[i].roomType == QLatin1String("m.space"),
+                                                      std::move(children[i].childrenState)));
         }
     }
     endInsertRows();
@@ -194,6 +196,9 @@ QVariant SpaceChildrenModel::data(const QModelIndex &index, int role) const
     if (role == IsSpaceRole) {
         return child->isSpace();
     }
+    if (role == IsSuggestedRole) {
+        return child->isSuggested();
+    }
     if (role == CanAddChildrenRole) {
         if (const auto room = static_cast<NeoChatRoom *>(m_space->connection()->room(child->id()))) {
             return room->canSendState(QLatin1String("m.space.child"));
@@ -313,6 +318,7 @@ QHash<int, QByteArray> SpaceChildrenModel::roleNames() const
     roles[IsJoinedRole] = "isJoined";
     roles[AliasRole] = "alias";
     roles[IsSpaceRole] = "isSpace";
+    roles[IsSuggestedRole] = "isSuggested";
     roles[CanAddChildrenRole] = "canAddChildren";
     roles[ParentDisplayNameRole] = "parentDisplayName";
     roles[CanSetParentRole] = "canSetParent";

src/models/spacechildrenmodel.h

@@ -44,6 +44,7 @@ public:
         WorldReadableRole,
         IsJoinedRole,
         IsSpaceRole,
+        IsSuggestedRole,
         CanAddChildrenRole,
         ParentDisplayNameRole,
         CanSetParentRole,

src/models/spacetreeitem.cpp

@@ -15,7 +15,8 @@ SpaceTreeItem::SpaceTreeItem(NeoChatConnection *connection,
                              const QUrl &avatarUrl,
                              bool allowGuests,
                              bool worldReadable,
-                             bool isSpace)
+                             bool isSpace,
+                             Quotient::StateEvents childStates)
     : m_connection(connection)
     , m_parentItem(parent)
     , m_id(id)
@@ -27,6 +28,7 @@ SpaceTreeItem::SpaceTreeItem(NeoChatConnection *connection,
     , m_allowGuests(allowGuests)
     , m_worldReadable(worldReadable)
     , m_isSpace(isSpace)
+    , m_childStates(std::move(childStates))
 {
 }
 
@@ -74,7 +76,7 @@ int SpaceTreeItem::row() const
     return 0;
 }
 
-SpaceTreeItem *SpaceTreeItem::parentItem()
+SpaceTreeItem *SpaceTreeItem::parentItem() const
 {
     return m_parentItem;
 }
@@ -138,3 +140,34 @@ bool SpaceTreeItem::isSpace() const
 {
     return m_isSpace;
 }
+
+QJsonObject SpaceTreeItem::childStateContent(const SpaceTreeItem *child) const
+{
+    if (child == nullptr) {
+        return {};
+    }
+    if (child->parentItem() != this) {
+        return {};
+    }
+    for (const auto &childState : m_childStates) {
+        if (childState->stateKey() == child->id()) {
+            return childState->contentJson();
+        }
+    }
+    return {};
+}
+
+void SpaceTreeItem::setChildStates(Quotient::StateEvents childStates)
+{
+    m_childStates.clear();
+    m_childStates = std::move(childStates);
+}
+
+bool SpaceTreeItem::isSuggested() const
+{
+    if (m_parentItem == nullptr) {
+        return false;
+    }
+    const auto childStateContent = m_parentItem->childStateContent(this);
+    return childStateContent.value(QLatin1String("suggested")).toBool();
+}

src/models/spacetreeitem.h

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
 
 #include <Quotient/csapi/space_hierarchy.h>
+#include <Quotient/events/stateevent.h>
 
 class NeoChatConnection;
 
@@ -30,7 +31,8 @@ public:
                            const QUrl &avatarUrl = {},
                            bool allowGuests = {},
                            bool worldReadable = {},
-                           bool isSpace = {});
+                           bool isSpace = {},
+                           Quotient::StateEvents childStates = {});
     ~SpaceTreeItem();
 
     /**
@@ -60,7 +62,7 @@ public:
     /**
      * @brief Return this item's parent.
      */
-    SpaceTreeItem *parentItem();
+    SpaceTreeItem *parentItem() const;
 
     /**
      * @brief Return the row number for this child relative to the parent.
@@ -123,6 +125,23 @@ public:
      */
     bool isSpace() const;
 
+    /**
+     * @brief Return the m.space.child state event content for the given child.
+     */
+    QJsonObject childStateContent(const SpaceTreeItem *child) const;
+
+    /**
+     * @brief Set the list of m.space.child events.
+     *
+     * Overwrites existing states. Calling with no input will clear the existing states.
+     */
+    void setChildStates(Quotient::StateEvents childStates = {});
+
+    /**
+     * @brief Whether the room is suggested in the parent space.
+     */
+    bool isSuggested() const;
+
 private:
     NeoChatConnection *m_connection;
     QList<SpaceTreeItem *> m_children;
@@ -137,4 +156,5 @@ private:
     bool m_allowGuests;
     bool m_worldReadable;
     bool m_isSpace;
+    Quotient::StateEvents m_childStates;
 };