komplex-hub/KomplexHubPlugin/packsearchmodel.h

/*
 *  Komplex Wallpaper Engine
 *  Copyright (C) 2026 @DigitalArtifex
 *  https://digitalartifex.dev - https://github.com/DigitalArtifex
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>
 */
#ifndef PackSearchModel_H
#define PackSearchModel_H
#include <QObject>
#include <QQmlEngine>
#include <QList>
#include <QStandardPaths>
#include <QDir>
#include <QFile>
#include <QFileInfo>
#include <QJsonParseError>
#include <QJsonDocument>
#include <QJsonObject>
#include <QJsonArray>
#include <QAbstractListModel>
#include <QProcess>
#include <QNetworkAccessManager>
#include <QNetworkReply>
#include <QNetworkRequest>
#include <QEventLoop>
#include <QtConcurrent/QtConcurrentRun>

#include "paginators/packsearchpaginator.h"

/**
 * @brief The PackSearchModel class
 */
class KOMPLEX_EXPORT PackSearchModel : public QAbstractListModel
{
    Q_OBJECT
    QML_ELEMENT
public:

    /**
     * @brief Used to control the UI state
     */
    enum State
    {
        Idle,
        Loading,
        Error
    };
    Q_ENUM(State)

    /**
     * @brief Data roles used by the view to request data
     */
    enum DataRole {
        UuidRole = Qt::UserRole + 1,
        AuthorRole,
        AuthorIdRole,
        DescriptionRole,
        NameRole,
        ThumbnailRole,
        CreatedDateRole,
        PriceRole,
        CurrencyRole,
        DownloadCountRole,
        TypeRole
    };
    Q_ENUM(DataRole)

    explicit PackSearchModel(QObject *parent = nullptr);

    auto rowCount(const QModelIndex &parent = QModelIndex()) const -> int override;

    /**
     * @brief data
     * Used by the view to pull data from the model.
     * Required by QAbstractListModel
     * @param index
     * @param role
     * @return
     */
    auto data(
        const QModelIndex &index,
        int role = Qt::DisplayRole
    ) const -> QVariant override;

    /**
     * @brief index
     * Used by the view to create an index for the data point.
     * Required by QAbstractListModel
     * @param row
     * @param column
     * @param parent
     * @return
     */
    auto index(
        int row,
        int column,
        const QModelIndex &parent = QModelIndex()
    ) const -> QModelIndex override;

    /**
     * @brief columnCount
     * Required by QAbstractListModel, but just returns 0
     * since we dont use cols
     * @param parent
     * @return
     */
    auto columnCount(
        const QModelIndex &parent = QModelIndex()
    ) const -> int override;

    /**
     * @brief parent
     * @param index
     * @return
     */
    auto parent(const QModelIndex &index) const -> QModelIndex override;

    /**
     * @brief setData
     * Required by QAbstractListModel but not used
     * @param index
     * @param value
     * @param role
     * @return true always
     */
    auto setData(
        const QModelIndex &index,
        const QVariant &value,
        int role = Qt::EditRole
    ) -> bool override;

    /**
     * @brief state
     * Current Model State
     * @return
     */
    auto state() const -> State;

    /**
     * @brief roleNames
     * Used to tell the view what data roles are available
     * and their QML friendly names
     * @return
     */
    auto roleNames() const -> QHash<int, QByteArray> override;

    /**
     * @brief errorString
     * User-friendly error string to be reported to the user
     * @return
     */
    auto errorString() const -> QString;

    /**
     * @brief resultsPerPage
     * @return
     */
    auto resultsPerPage() const -> qsizetype;

    /**
     * @brief setResultsPerPage
     * @param resultsPerPage
     */
    auto setResultsPerPage(qsizetype resultsPerPage) -> void;

    /**
     * @brief totalResults
     * Total number of results available
     * @return
     */
    auto totalResults() const -> qsizetype;

    /**
     * @brief page
     * @return
     */
    auto page() const -> qsizetype;

    /**
     * @brief totalPages
     * Total pages based on the current resultsPerPage
     * @return
     */
    auto totalPages() const -> qsizetype;

    /**
     * @brief nextPage
     * Function for the QML frontend
     */
    Q_INVOKABLE auto nextPage() -> void;

    /**
     * @brief previousPage
     * Function for the QML frontend
     */
    Q_INVOKABLE auto previousPage() -> void;

    /**
     * @brief query
     * Current search query
     * @return
     */
    auto query() const -> QString;

    /**
     * @brief setQuery
     * Sets the current search query
     * @param query
     */
    auto setQuery(const QString &query) -> void;

    /**
     * @brief hasNextPage
     * Calculates if there are more pages based on the current page calculation
     * @return
     */
    auto hasNextPage() const -> bool;

    /**
     * @brief hasPreviousPage
     * If page is greater than 1, returns true
     * @return
     */
    auto hasPreviousPage() const -> bool;

protected:

    /**
     * @brief onPaginatorFetching
     * Sets current state to loading. Triggered when paginator's cache controller
     * needs to fetch data from the remote endpoint.
     */
    auto onPaginatorFetching() -> void;

    /**
     * @brief setErrorString
     * @param errorString
     */
    auto setErrorString(const QString &errorString) -> void;

    /**
     * @brief setState
     * @param state
     */
    auto setState(State state) -> void;

    /**
     * @brief resetState
     */
    auto resetState() -> void;

    /**
     * @brief resetDataModel
     * Clears the data model and creates a new one if data exists
     */
    auto resetDataModel() -> void;

signals:
    /**
     * @brief stateChanged
     * Signaled when reported state changes
     */
    auto stateChanged() -> void;

    /**
     * @brief errorStringChanged
     * Signaled when reported error message changes
     */
    auto errorStringChanged() -> void;

    /**
     * @brief pageChanged
     * Forwarding signal connected in constructor
     */
    auto resultsPerPageChanged() -> void;

    /**
     * @brief pageChanged
     * Forwarding signal connected in constructor
     */
    auto pageChanged() -> void;

    /**
     * @brief pageChanged
     * Forwarding signal connected in constructor
     */
    auto totalResultsChanged() -> void;

    /**
     * @brief pageChanged
     * Forwarding signal connected in constructor
     */
    auto totalPagesChanged() -> void;

    /**
     * @brief pageChanged
     * Forwarding signal connected in constructor
     */
    auto queryChanged() -> void;

private:
    /**
     * Data role map that connects PackSearchModel::DataRole to it's QML accessor name
     */
    static inline const QHash<int, QByteArray> m_dataRoles =
    {
        {
            static_cast<int>(UuidRole),
            QByteArray("uuid")
        },
        {
            static_cast<int>(AuthorRole),
            QByteArray("author")
        },
        {
            static_cast<int>(AuthorIdRole),
            QByteArray("authorId")
        },
        {
            static_cast<int>(DescriptionRole),
            QByteArray("description")
        },
        {
            static_cast<int>(NameRole),
            QByteArray("name")
        },
        {
            static_cast<int>(ThumbnailRole),
            QByteArray("thumbnail")
        },
        {
            static_cast<int>(CreatedDateRole),
            QByteArray("createdDate")
        },
        {
            static_cast<int>(PriceRole),
            QByteArray("price")
        },
        {
            static_cast<int>(CurrencyRole),
            QByteArray("currency")
        },
        {
            static_cast<int>(DownloadCountRole),
            QByteArray("downloadCount")
        },
        {
            static_cast<int>(TypeRole),
            QByteArray("type")
        }
    };

    State m_state = Idle;

    QString m_errorString = QString();

    PackSearchPaginator *m_paginator = nullptr;

    Q_PROPERTY(State state READ state WRITE setState RESET resetState NOTIFY stateChanged FINAL)
    Q_PROPERTY(QString errorString READ errorString WRITE setErrorString NOTIFY errorStringChanged FINAL)
    Q_PROPERTY(qsizetype resultsPerPage READ resultsPerPage WRITE setResultsPerPage NOTIFY resultsPerPageChanged FINAL)
    Q_PROPERTY(qsizetype totalResults READ totalResults NOTIFY totalResultsChanged FINAL)
    Q_PROPERTY(qsizetype totalPages READ totalPages NOTIFY totalPagesChanged FINAL)
    Q_PROPERTY(qsizetype page READ page NOTIFY pageChanged FINAL)
    Q_PROPERTY(bool hasNextPage READ hasNextPage NOTIFY pageChanged FINAL)
    Q_PROPERTY(bool hasPreviousPage READ hasPreviousPage NOTIFY pageChanged FINAL)
    Q_PROPERTY(QString query READ query WRITE setQuery NOTIFY queryChanged FINAL)
};
Q_DECLARE_METATYPE(PackSearchModel)

#endif // PackSearchModel_H