Move NeoChatConnection and NeoChatRoom to LibNeoChat

Move `NeoChatConnection` and `NeoChatRoom` to `LibNeoChat` along with any required dependencies.

src/libneochat/spacehierarchycache.h

@@ -0,0 +1,119 @@
+
+// SPDX-FileCopyrightText: 2022 Snehit Sah <hi@snehit.dev>
+// SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
+
+#pragma once
+
+#include <QHash>
+#include <QList>
+#include <QObject>
+#include <QQmlEngine>
+#include <QString>
+
+namespace Quotient
+{
+class Room;
+class GetSpaceHierarchyJob;
+}
+
+class NeoChatConnection;
+
+/**
+ * @class SpaceHierarchyCache
+ *
+ * A class to store the child spaces for each space.
+ *
+ * Spaces are cached on startup or when the user enters a new space.
+ */
+class SpaceHierarchyCache : public QObject
+{
+    Q_OBJECT
+    QML_ELEMENT
+    QML_SINGLETON
+
+    Q_PROPERTY(NeoChatConnection *connection READ connection WRITE setConnection NOTIFY connectionChanged)
+    Q_PROPERTY(QString recommendedSpaceId READ recommendedSpaceId CONSTANT)
+    Q_PROPERTY(QString recommendedSpaceAvatar READ recommendedSpaceAvatar CONSTANT)
+    Q_PROPERTY(QString recommendedSpaceDisplayName READ recommendedSpaceDisplayName CONSTANT)
+    Q_PROPERTY(QString recommendedSpaceDescription READ recommendedSpaceDescription CONSTANT)
+    Q_PROPERTY(bool recommendedSpaceHidden READ recommendedSpaceHidden WRITE setRecommendedSpaceHidden NOTIFY recommendedSpaceHiddenChanged)
+
+public:
+    static SpaceHierarchyCache &instance()
+    {
+        static SpaceHierarchyCache _instance;
+        return _instance;
+    }
+    static SpaceHierarchyCache *create(QQmlEngine *engine, QJSEngine *)
+    {
+        engine->setObjectOwnership(&instance(), QQmlEngine::CppOwnership);
+        return &instance();
+    }
+
+    /**
+     * @brief Returns the list of parent spaces for a child if any.
+     */
+    QStringList parentSpaces(const QString &roomId);
+
+    /**
+     * @brief Whether the given room is a member of the given space.
+     */
+    Q_INVOKABLE bool isSpaceChild(const QString &spaceId, const QString &roomId);
+
+    /**
+     * @brief Return the list of child rooms for the given space ID.
+     */
+    [[nodiscard]] QList<QString> &getRoomListForSpace(const QString &spaceId, bool updateCache);
+
+    /**
+     * @brief Return the number of notifications for the child rooms in a given space ID.
+     */
+    qsizetype notificationCountForSpace(const QString &spaceId);
+
+    /**
+     * @brief Whether any of the child rooms have highlight notifications.
+     */
+    bool spaceHasHighlightNotifications(const QString &spaceId);
+
+    /**
+     * @brief Returns whether the room is a child space of any space.
+     *
+     * @note We need to do this from the hierarchy as it is not guaranteed that the
+     *       child knows it's in a space. See
+     *       https://spec.matrix.org/v1.8/client-server-api/#managing-roomsspaces-included-in-a-space
+     */
+    [[nodiscard]] bool isChild(const QString &roomId) const;
+
+    NeoChatConnection *connection() const;
+    void setConnection(NeoChatConnection *connection);
+
+    QString recommendedSpaceId() const;
+    QString recommendedSpaceAvatar() const;
+    QString recommendedSpaceDisplayName() const;
+    QString recommendedSpaceDescription() const;
+
+    bool recommendedSpaceHidden() const;
+    void setRecommendedSpaceHidden(bool hidden);
+
+Q_SIGNALS:
+    void spaceHierarchyChanged();
+    void connectionChanged();
+    void spaceNotifcationCountChanged(const QStringList &spaces);
+    void recommendedSpaceHiddenChanged();
+
+private Q_SLOTS:
+    void addSpaceToHierarchy(Quotient::Room *room);
+    void removeSpaceFromHierarchy(Quotient::Room *room);
+
+private:
+    explicit SpaceHierarchyCache(QObject *parent = nullptr);
+
+    QList<QString> m_activeSpaceRooms;
+    QHash<QString, QList<QString>> m_spaceHierarchy;
+    void cacheSpaceHierarchy();
+
+    QHash<QString, std::optional<QString>> m_nextBatchTokens;
+    void populateSpaceHierarchy(const QString &spaceId);
+    void addBatch(const QString &spaceId, Quotient::GetSpaceHierarchyJob *job);
+    QPointer<NeoChatConnection> m_connection;
+};