quickengine.cpp

/*
    SPDX-FileCopyrightText: 2016 Dan Leinir Turthra Jensen <[email protected]>
 
    SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/
 
#include "quickengine.h"
#include "quicksettings.h"
 
#if KNEWSTUFFQUICK_BUILD_DEPRECATED_SINCE(5, 81)
#include <KAuthorized>
#endif
#include <KLocalizedString>
 
#include "categoriesmodel.h"
#include "quickquestionlistener.h"
#include "searchpresetmodel.h"
 
#include "engine.h"
 
class EnginePrivate
{
public:
    EnginePrivate()
        : engine(nullptr)
        , categoriesModel(nullptr)
        , searchPresetModel(nullptr)
    {
    }
    KNSCore::Engine *engine;
    bool isLoading{false};
    bool isValid{false};
    CategoriesModel *categoriesModel;
    SearchPresetModel *searchPresetModel;
    QString configFile;
 
#if KNEWSTUFF_BUILD_DEPRECATED_SINCE(5, 82)
    KNSCore::EntryInternal::List changedEntries;
    static KNSCore::EntryWrapper *getChangedEntry(QQmlListProperty<KNSCore::EntryWrapper> *property, int i)
    {
        KNSCore::EntryWrapper *entry{nullptr};
        if (property) {
            auto d = static_cast<EnginePrivate *>(property->data);
            if (d) {
                if (i >= 0 && i < d->changedEntries.count()) {
                    // Lifetime management for these objects should be done by the consumer,
                    // but are also parented for auto-delete on application shutdown
                    entry = new KNSCore::EntryWrapper(d->changedEntries[i], property->object);
                }
            }
        }
        return entry;
    }
    static int getChangedEntriesCount(QQmlListProperty<KNSCore::EntryWrapper> *property)
    {
        int count{0};
        if (property) {
            auto d = static_cast<EnginePrivate *>(property->data);
            if (d) {
                count = d->changedEntries.count();
            }
        }
        return count;
    }
#endif
};
 
Engine::Engine(QObject *parent)
    : QObject(parent)
    , d(new EnginePrivate)
{
}
 
Engine::~Engine() = default;
 
#if KNEWSTUFFQUICK_BUILD_DEPRECATED_SINCE(5, 81)
bool Engine::allowedByKiosk() const
{
    return KAuthorized::authorize(KAuthorized::GHNS);
}
#endif
 
QString Engine::configFile() const
{
    return d->configFile;
}
 
void Engine::setConfigFile(const QString &newFile)
{
    if (d->configFile != newFile) {
        d->isLoading = true;
        Q_EMIT isLoadingChanged();
        d->configFile = newFile;
        Q_EMIT configFileChanged();
 
        if (KNewStuffQuick::Settings::instance()->allowedByKiosk()) {
            if (!d->engine) {
                d->engine = new KNSCore::Engine(this);
                connect(d->engine, &KNSCore::Engine::signalProvidersLoaded, this, [=]() {
                    d->isLoading = false;
                    Q_EMIT isLoadingChanged();
                });
                connect(d->engine, &KNSCore::Engine::signalMessage, this, &Engine::message);
                connect(d->engine, &KNSCore::Engine::busyStateChanged, this, [this]() {
                    if (!d->engine->busyState()) {
                        idleMessage(QString());
                    } else {
                        busyMessage(d->engine->busyMessage());
                    }
                });
                connect(d->engine,
                        &KNSCore::Engine::signalErrorCode,
                        this,
                        [=](const KNSCore::ErrorCode &theErrorCode, const QString &message, const QVariant &metadata) {
                            Q_EMIT errorCode(static_cast<ErrorCode>(theErrorCode), message, metadata);
                            if (theErrorCode == KNSCore::ProviderError) {
                                // This means loading the providers file failed entirely and we cannot complete the
                                // initialisation. It also means the engine is done loading, but that nothing will
                                // work, and we need to inform the user of this.
                                d->isLoading = false;
                                Q_EMIT isLoadingChanged();
                            }
                            Q_EMIT errorMessage(message);
                        });
                connect(d->engine,
                        &KNSCore::Engine::signalEntryEvent,
                        this,
                        [this](const KNSCore::EntryInternal &entry, KNSCore::EntryInternal::EntryEvent event) {
                            KNSCore::EntryWrapper *wrappedEntry = new KNSCore::EntryWrapper(entry, this);
                            // Just forward the event but not do anything more
                            if (event != KNSCore::EntryInternal::StatusChangedEvent) {
                                Q_EMIT entryEvent(wrappedEntry, (EntryEvent)event);
                                return;
                            }
 
                            // We do not want to emit the entries changed signal for intermediate changed
                            // this would cause the KCMs to reload their view unnecessarily, BUG: 431568
                            if (entry.status() == KNS3::Entry::Installing || entry.status() == KNS3::Entry::Updating) {
                                return;
                            }
                            Q_EMIT entryEvent(wrappedEntry, (EntryEvent)event);
#if KNEWSTUFF_BUILD_DEPRECATED_SINCE(5, 82)
                            if (d->changedEntries.contains(entry)) {
                                d->changedEntries.removeAll(entry);
                            }
                            d->changedEntries << entry;
                            Q_EMIT changedEntriesChanged();
#endif
                        });
                Q_EMIT engineChanged();
                KNewStuffQuick::QuickQuestionListener::instance();
                d->categoriesModel = new CategoriesModel(this);
                Q_EMIT categoriesChanged();
                d->searchPresetModel = new SearchPresetModel(this);
                Q_EMIT searchPresetModelChanged();
                // And finally, let's just make sure we don't miss out the various things here getting changed
                // In other words, when we're asked to reset the view, actually do that
                connect(d->engine, &KNSCore::Engine::signalResetView, this, &Engine::categoriesFilterChanged);
                connect(d->engine, &KNSCore::Engine::signalResetView, this, &Engine::filterChanged);
                connect(d->engine, &KNSCore::Engine::signalResetView, this, &Engine::sortOrderChanged);
                connect(d->engine, &KNSCore::Engine::signalResetView, this, &Engine::searchTermChanged);
                Q_EMIT categoriesFilterChanged();
                Q_EMIT filterChanged();
                Q_EMIT sortOrderChanged();
                Q_EMIT searchTermChanged();
            }
            d->isValid = d->engine->init(d->configFile);
            Q_EMIT engineInitialized();
        } else {
            // This is not an error message in the proper sense, and the message is not intended to look like an error (as there is really
            // nothing the user can do to fix it, and we just tell them so they're not wondering what's wrong)
            Q_EMIT message(
                i18nc("An informational message which is shown to inform the user they are not authorized to use GetHotNewStuff functionality",
                      "You are not authorized to Get Hot New Stuff. If you think this is in error, please contact the person in charge of your permissions."));
        }
    }
}
 
QObject *Engine::engine() const
{
    return d->engine;
}
 
bool Engine::isLoading() const
{
    return d->isLoading;
}
 
bool Engine::hasAdoptionCommand() const
{
    if (d->engine) {
        return d->engine->hasAdoptionCommand();
    }
    return false;
}
 
QString Engine::name() const
{
    if (d->engine) {
        return d->engine->name();
    }
    return QString{};
}
 
QObject *Engine::categories() const
{
    return d->categoriesModel;
}
 
QStringList Engine::categoriesFilter() const
{
    if (d->engine) {
        return d->engine->categoriesFilter();
    }
    return QStringList{};
}
 
void Engine::setCategoriesFilter(const QStringList &newCategoriesFilter)
{
    if (d->engine) {
        // This ensures that if we somehow end up with any empty entries (such as the default
        // option in the categories dropdowns), our list will remain empty.
        QStringList filter{newCategoriesFilter};
        filter.removeAll({});
        if (d->engine->categoriesFilter() != filter) {
            d->engine->setCategoriesFilter(filter);
            Q_EMIT categoriesFilterChanged();
        }
    }
}
 
void Engine::resetCategoriesFilter()
{
    if (d->engine) {
        d->engine->setCategoriesFilter(d->engine->categories());
    }
}
 
int Engine::filter() const
{
    if (d->engine) {
        return d->engine->filter();
    }
    return 0;
}
 
void Engine::setFilter(int newFilter)
{
    if (d->engine && d->engine->filter() != newFilter) {
        d->engine->setFilter(static_cast<KNSCore::Provider::Filter>(newFilter));
        Q_EMIT filterChanged();
    }
}
 
int Engine::sortOrder() const
{
    if (d->engine) {
        return d->engine->sortMode();
    }
    return 0;
}
 
void Engine::setSortOrder(int newSortOrder)
{
    if (d->engine && d->engine->sortMode() != newSortOrder) {
        d->engine->setSortMode(static_cast<KNSCore::Provider::SortMode>(newSortOrder));
        Q_EMIT sortOrderChanged();
    }
}
 
QString Engine::searchTerm() const
{
    if (d->engine) {
        return d->engine->searchTerm();
    }
    return QString{};
}
 
void Engine::setSearchTerm(const QString &newSearchTerm)
{
    if (d->engine && d->isValid && d->engine->searchTerm() != newSearchTerm) {
        d->engine->setSearchTerm(newSearchTerm);
        Q_EMIT searchTermChanged();
    }
}
 
QObject *Engine::searchPresetModel() const
{
    return d->searchPresetModel;
}
 
void Engine::resetSearchTerm()
{
    setSearchTerm(QString{});
}
 
#if KNEWSTUFF_BUILD_DEPRECATED_SINCE(5, 82)
QQmlListProperty<KNSCore::EntryWrapper> Engine::changedEntries()
{
    return QQmlListProperty<KNSCore::EntryWrapper>(this, d.get(), &EnginePrivate::getChangedEntriesCount, &EnginePrivate::getChangedEntry);
}
 
int Engine::changedEntriesCount() const
{
    return d->changedEntries.count();
}
 
void Engine::resetChangedEntries()
{
    if (!d->changedEntries.isEmpty()) {
        d->changedEntries.clear();
        Q_EMIT changedEntriesChanged();
    }
}
#endif
 
bool Engine::isValid()
{
    return d->isValid;
}