PrismLauncher/launcher/ui/pages/modplatform/ResourceModel.cpp

// SPDX-FileCopyrightText: 2023 flowln <flowlnlnln@gmail.com>
//
// SPDX-License-Identifier: GPL-3.0-only

#include "ResourceModel.h"

#include <QCryptographicHash>
#include <QIcon>
#include <QList>
#include <QMessageBox>
#include <QPixmapCache>
#include <QUrl>
#include <algorithm>
#include <memory>
#include <utility>

#include "Application.h"
#include "BuildConfig.h"
#include "settings/SettingsObject.h"

#include "modplatform/ResourceAPI.h"
#include "net/ApiDownload.h"
#include "net/NetJob.h"

#include "modplatform/ModIndex.h"

#include "ui/widgets/ProjectItem.h"

namespace ResourceDownload {

QHash<ResourceModel*, bool> ResourceModel::s_running_models;

ResourceModel::ResourceModel(ResourceAPI* api) : m_api(api)
{
    s_running_models.insert(this, true);
    if (APPLICATION_DYN) {
        m_current_info_job.setMaxConcurrent(APPLICATION->settings()->get("NumberOfConcurrentDownloads").toInt());
    }
}

ResourceModel::~ResourceModel()
{
    s_running_models.find(this).value() = false;
}

auto ResourceModel::data(const QModelIndex& index, int role) const -> QVariant
{
    int pos = index.row();
    if (pos >= m_packs.size() || pos < 0 || !index.isValid()) {
        return QString("INVALID INDEX %1").arg(pos);
    }

    auto pack = m_packs.at(pos);
    switch (role) {
        case Qt::ToolTipRole: {
            if (pack->description.length() > 100) {
                // some magic to prevent to long tooltips and replace html linebreaks
                QString edit = pack->description.left(97);
                edit = edit.left(edit.lastIndexOf("<br>")).left(edit.lastIndexOf(" ")).append("...");
                return edit;
            }
            return pack->description;
        }
        case Qt::DecorationRole: {
            if (APPLICATION_DYN) {
                if (auto iconOrNone = const_cast<ResourceModel*>(this)->getIcon(const_cast<QModelIndex&>(index), pack->logoUrl);
                    iconOrNone.has_value()) {
                    return iconOrNone.value();
                }

                return QIcon::fromTheme("screenshot-placeholder");
            }
            return {};
        }
        case Qt::SizeHintRole:
            return QSize(0, 58);
        case Qt::UserRole: {
            QVariant v;
            v.setValue(pack);
            return v;
        }
            // Custom data
        case UserDataTypes::TITLE:
            return pack->name;
        case UserDataTypes::DESCRIPTION:
            return pack->description;
        case Qt::CheckStateRole:
            return pack->isAnyVersionSelected() ? Qt::Checked : Qt::Unchecked;
        case UserDataTypes::INSTALLED:
            return this->isPackInstalled(pack);
        default:
            break;
    }

    return {};
}

QHash<int, QByteArray> ResourceModel::roleNames() const
{
    QHash<int, QByteArray> roles;

    roles[Qt::ToolTipRole] = "toolTip";
    roles[Qt::DecorationRole] = "decoration";
    roles[Qt::SizeHintRole] = "sizeHint";
    roles[Qt::UserRole] = "pack";
    roles[UserDataTypes::TITLE] = "title";
    roles[UserDataTypes::DESCRIPTION] = "description";
    roles[UserDataTypes::INSTALLED] = "installed";

    return roles;
}

bool ResourceModel::setData(const QModelIndex& index, const QVariant& value, [[maybe_unused]] int role)
{
    int pos = index.row();
    if (pos >= m_packs.size() || pos < 0 || !index.isValid()) {
        return false;
    }

    m_packs[pos] = value.value<ModPlatform::IndexedPack::Ptr>();
    emit dataChanged(index, index);

    return true;
}

QString ResourceModel::debugName() const
{
    return "ResourceDownload (Model)";
}

void ResourceModel::fetchMore(const QModelIndex& parent)
{
    if (parent.isValid() || m_search_state == SearchState::Finished) {
        return;
    }

    search();
}

void ResourceModel::search()
{
    if (hasActiveSearchJob()) {
        return;
    }

    if (m_search_state != SearchState::ResetRequested && m_search_term.startsWith("#")) {
        auto projectId = m_search_term.mid(1);
        if (!projectId.isEmpty()) {
            ResourceAPI::Callback<ModPlatform::IndexedPack::Ptr> callbacks;

            callbacks.on_fail = [this](QString reason, int networkErrorCode) {
                if (!s_running_models.constFind(this).value()) {
                    return;
                }
                if (networkErrorCode == 404) {
                    m_search_state = SearchState::ResetRequested;
                }
                searchRequestFailed(std::move(reason), networkErrorCode);
            };
            callbacks.on_abort = [this] {
                if (!s_running_models.constFind(this).value()) {
                    return;
                }
                searchRequestAborted();
            };

            callbacks.on_succeed = [this](auto& pack) {
                if (!s_running_models.constFind(this).value()) {
                    return;
                }
                searchRequestForOneSucceeded(pack);
            };
            auto project = std::make_shared<ModPlatform::IndexedPack>();
            project->addonId = projectId;
            if (auto job = m_api->getProjectInfo({ project }, std::move(callbacks), false); job) {
                runSearchJob(job);
            }
            return;
        }
    }
    auto args{ createSearchArguments() };

    ResourceAPI::Callback<QList<ModPlatform::IndexedPack::Ptr>> callbacks{};

    callbacks.on_succeed = [this](auto& doc) {
        if (!s_running_models.constFind(this).value()) {
            return;
        }
        searchRequestSucceeded(doc);
    };
    callbacks.on_fail = [this](QString reason, int networkErrorCode) {
        if (!s_running_models.constFind(this).value()) {
            return;
        }
        searchRequestFailed(std::move(reason), networkErrorCode);
    };
    callbacks.on_abort = [this] {
        if (!s_running_models.constFind(this).value()) {
            return;
        }
        searchRequestAborted();
    };

    if (auto job = m_api->searchProjects(std::move(args), std::move(callbacks)); job) {
        runSearchJob(job);
    }
}

void ResourceModel::loadEntry(const QModelIndex& entry)
{
    const auto& pack = m_packs[entry.row()];

    if (!hasActiveInfoJob()) {
        m_current_info_job.clear();
    }

    if (!pack->versionsLoaded) {
        auto args{ createVersionsArguments(entry) };
        ResourceAPI::Callback<QVector<ModPlatform::IndexedVersion>> callbacks{};

        auto addonId = pack->addonId;
        // Use default if no callbacks are set
        if (!callbacks.on_succeed) {
            callbacks.on_succeed = [this, entry, addonId](auto& doc) {
                if (!s_running_models.constFind(this).value()) {
                    return;
                }
                versionRequestSucceeded(doc, addonId, entry);
            };
        }
        if (!callbacks.on_fail) {
            callbacks.on_fail = [](const QString& reason, int) {
                QMessageBox::critical(nullptr, tr("Error"),
                                      tr("A network error occurred. Could not load project versions: %1").arg(reason));
            };
        }

        if (auto job = m_api->getProjectVersions(std::move(args), std::move(callbacks)); job) {
            runInfoJob(job);
        }
    }

    if (!pack->extraDataLoaded) {
        auto args{ createInfoArguments(entry) };
        ResourceAPI::Callback<ModPlatform::IndexedPack::Ptr> callbacks{};

        callbacks.on_succeed = [this, entry](auto& newpack) {
            if (!s_running_models.constFind(this).value()) {
                return;
            }
            infoRequestSucceeded(newpack, entry);
        };
        callbacks.on_fail = [this](const QString& reason, int) {
            if (!s_running_models.constFind(this).value()) {
                return;
            }
            QMessageBox::critical(nullptr, tr("Error"), tr("A network error occurred. Could not load project info: %1").arg(reason));
        };
        callbacks.on_abort = [this] {
            if (!s_running_models.constFind(this).value()) {
                return;
            }
            qCritical() << tr("The request was aborted for an unknown reason");
        };

        if (auto job = m_api->getProjectInfo(std::move(args), std::move(callbacks)); job) {
            runInfoJob(job);
        }
    }
}

void ResourceModel::refresh()
{
    bool resetRequested = false;

    if (hasActiveInfoJob()) {
        m_current_info_job.abort();
        resetRequested = true;
    }

    if (hasActiveSearchJob()) {
        m_current_search_job->abort();
        resetRequested = true;
    }

    if (resetRequested) {
        m_search_state = SearchState::ResetRequested;
        return;
    }

    clearData();
    m_search_state = SearchState::None;

    m_next_search_offset = 0;
    search();
}

void ResourceModel::clearData()
{
    beginResetModel();
    m_packs.clear();
    endResetModel();
}

void ResourceModel::runSearchJob(Task::Ptr ptr)
{
    m_current_search_job.reset(ptr);  // clean up first
    m_current_search_job->start();
}
void ResourceModel::runInfoJob(Task::Ptr ptr)
{
    if (!m_current_info_job.isRunning()) {
        m_current_info_job.clear();
    }

    m_current_info_job.addTask(std::move(ptr));

    if (!m_current_info_job.isRunning()) {
        m_current_info_job.run();
    }
}

std::optional<ResourceAPI::SortingMethod> ResourceModel::getCurrentSortingMethodByIndex() const
{
    std::optional<ResourceAPI::SortingMethod> sort{};

    {  // Find sorting method by ID
        auto sortingMethods = getSortingMethods();
        auto method = std::find_if(sortingMethods.constBegin(), sortingMethods.constEnd(),
                                   [this](const auto& e) { return m_current_sort_index == e.index; });
        if (method != sortingMethods.constEnd()) {
            sort = *method;
        }
    }

    return sort;
}

std::optional<QIcon> ResourceModel::getIcon(QModelIndex& index, const QUrl& url)
{
    QPixmap pixmap;
    if (QPixmapCache::find(url.toString(), &pixmap)) {
        return { pixmap };
    }

    if (!m_current_icon_job) {
        m_current_icon_job.reset(new NetJob("IconJob", APPLICATION->network()));
        m_current_icon_job->setAskRetry(false);
    }

    if (m_currently_running_icon_actions.contains(url)) {
        return {};
    }
    if (m_failed_icon_actions.contains(url)) {
        return {};
    }

    auto cacheEntry = APPLICATION->metacache()->resolveEntry(
        metaEntryBase(),
        QString("logos/%1").arg(QString(QCryptographicHash::hash(url.toEncoded(), QCryptographicHash::Algorithm::Sha1).toHex())));
    auto iconFetchAction = Net::ApiDownload::makeCached(url, cacheEntry);

    auto fullFilePath = cacheEntry->getFullPath();
    connect(iconFetchAction.get(), &Task::succeeded, this, [this, url, fullFilePath, index] {
        auto icon = QIcon(fullFilePath);
        QPixmapCache::insert(url.toString(), icon.pixmap(icon.actualSize({ 64, 64 })));

        m_currently_running_icon_actions.remove(url);

        emit dataChanged(index, index, { Qt::DecorationRole });
    });
    connect(iconFetchAction.get(), &Task::failed, this, [this, url] {
        m_currently_running_icon_actions.remove(url);
        m_failed_icon_actions.insert(url);
    });

    m_currently_running_icon_actions.insert(url);

    m_current_icon_job->addNetAction(iconFetchAction);
    if (!m_current_icon_job->isRunning()) {
        QMetaObject::invokeMethod(m_current_icon_job.get(), &NetJob::start);
    }

    return {};
}

/* Default callbacks */

void ResourceModel::searchRequestSucceeded(QList<ModPlatform::IndexedPack::Ptr>& newList)
{
    QList<ModPlatform::IndexedPack::Ptr> filteredNewList;
    for (auto pack : newList) {
        ModPlatform::IndexedPack::Ptr p;
        if (auto sel = std::ranges::find_if(m_selected,
                                            [&pack](const DownloadTaskPtr& i) {
                                                const auto ipack = i->getPack();
                                                return ipack->provider == pack->provider && ipack->addonId == pack->addonId;
                                            });
            sel != m_selected.end()) {
            p = sel->get()->getPack();
        } else {
            p = pack;
        }
        if (checkFilters(p)) {
            filteredNewList << p;
        }
    }

    if (newList.size() < 25) {
        m_search_state = SearchState::Finished;
    } else {
        m_next_search_offset += 25;
        m_search_state = SearchState::CanFetchMore;
    }

    // When you have a Qt build with assertions turned on, proceeding here will abort the application
    if (filteredNewList.size() == 0) {
        return;
    }

    beginInsertRows(QModelIndex(), m_packs.size(), m_packs.size() + filteredNewList.size() - 1);
    m_packs.append(filteredNewList);
    endInsertRows();
}

void ResourceModel::searchRequestForOneSucceeded(ModPlatform::IndexedPack::Ptr pack)
{
    m_search_state = SearchState::Finished;

    beginInsertRows(QModelIndex(), m_packs.size(), m_packs.size() + 1);
    m_packs.append(pack);
    endInsertRows();
}

void ResourceModel::searchRequestFailed([[maybe_unused]] QString reason, int networkErrorCode)
{
    switch (networkErrorCode) {
        default:
            // Network error
            QMessageBox::critical(nullptr, tr("Error"), tr("A network error occurred. Could not load mods."));
            break;
        case 404:
            // 404 Not Found, some APIs return this when nothing is found, no need to bother the user
            break;
        case 409:
            // 409 Gone, notify user to update
            QMessageBox::critical(nullptr, tr("Error"),
                                  QString("%1").arg(tr("API version too old!\nPlease update %1!").arg(BuildConfig.LAUNCHER_DISPLAYNAME)));
            break;
    }

    if (m_search_state == SearchState::ResetRequested) {
        clearData();

        m_next_search_offset = 0;
        search();
    } else {
        m_search_state = SearchState::Finished;
    }
}

void ResourceModel::searchRequestAborted()
{
    if (m_search_state != SearchState::ResetRequested) {
        qCritical() << "Search task in" << debugName() << "aborted by an unknown reason!";
    }

    // Retry fetching
    clearData();

    m_next_search_offset = 0;
    search();
}

void ResourceModel::versionRequestSucceeded(QVector<ModPlatform::IndexedVersion>& doc, QVariant pack, const QModelIndex& index)
{
    auto currentPack = data(index, Qt::UserRole).value<ModPlatform::IndexedPack::Ptr>();

    // Check if the index is still valid for this resource or not
    if (pack != currentPack->addonId) {
        return;
    }

    currentPack->versions = doc;
    currentPack->versionsLoaded = true;

    // Cache info :^)
    QVariant newPack;
    newPack.setValue(currentPack);
    if (!setData(index, newPack, Qt::UserRole)) {
        qWarning() << "Failed to cache resource versions!";
        return;
    }

    emit versionListUpdated(index);
}

void ResourceModel::infoRequestSucceeded(ModPlatform::IndexedPack::Ptr pack, const QModelIndex& index)
{
    auto currentPack = data(index, Qt::UserRole).value<ModPlatform::IndexedPack::Ptr>();

    // Check if the index is still valid for this resource or not
    if (pack->addonId != currentPack->addonId) {
        return;
    }

    // Cache info :^)
    QVariant newPack;
    newPack.setValue(pack);
    if (!setData(index, newPack, Qt::UserRole)) {
        qWarning() << "Failed to cache resource info!";
        return;
    }

    emit projectInfoUpdated(index);
}

void ResourceModel::addPack(ModPlatform::IndexedPack::Ptr pack,
                            ModPlatform::IndexedVersion& version,
                            ResourceFolderModel* packs,
                            bool isIndexed,
                            QString downloadReason)
{
    version.is_currently_selected = true;
    m_selected.append(makeShared<ResourceDownloadTask>(std::move(pack), version, packs, isIndexed, std::move(downloadReason)));
}

void ResourceModel::removePack(const QString& rem)
{
    auto pred = [&rem](const DownloadTaskPtr& i) { return rem == i->getName(); };
#if QT_VERSION >= QT_VERSION_CHECK(6, 1, 0)
    m_selected.removeIf(pred);
#else
    {
        for (auto it = m_selected.begin(); it != m_selected.end();)
            if (pred(*it))
                it = m_selected.erase(it);
            else
                ++it;
    }
#endif
    auto pack = std::ranges::find_if(m_packs, [&rem](const ModPlatform::IndexedPack::Ptr& i) { return rem == i->name; });
    if (pack == m_packs.end()) {  // ignore it if is not in the current search
        return;
    }
    if (!pack->get()->versionsLoaded) {
        return;
    }
    for (auto& ver : pack->get()->versions) {
        ver.is_currently_selected = false;
    }
}

bool ResourceModel::checkVersionFilters(const ModPlatform::IndexedVersion& v)
{
    return (!optedOut(v));
}
}  // namespace ResourceDownload