SensorFaceController.cpp

/*
    SPDX-FileCopyrightText: 2020 Marco Martin <mart@kde.org>
 
    SPDX-License-Identifier: LGPL-2.0-or-later
*/
 
#include "SensorFaceController.h"
#include "SensorFaceController_p.h"
#include "SensorFace_p.h"
#include <Sensor.h>
#include <SensorQuery.h>
 
#include <QFileInfo>
#include <QJsonDocument>
#include <QQmlContext>
#include <QQmlEngine>
#include <QTemporaryDir>
#include <QTimer>
 
#include <KConfigLoader>
#include <KConfigPropertyMap>
#include <KDesktopFile>
#include <KLocalizedString>
#include <KPackage/PackageJob>
#include <KPackage/PackageLoader>
#include <KPluginMetaData>
#include <Solid/Block>
#include <Solid/Device>
#include <Solid/Predicate>
#include <Solid/StorageAccess>
#include <Solid/StorageVolume>
 
#include "faces_logging.h"
 
using namespace KSysGuard;
 
FacesModel::FacesModel(QObject *parent)
    : QStandardItemModel(parent)
{
    reload();
}
 
void FacesModel::reload()
{
    clear();
 
    const auto list = KPackage::PackageLoader::self()->listPackages(QStringLiteral("KSysguard/SensorFace"));
    for (auto plugin : list) {
        QStandardItem *item = new QStandardItem(plugin.name());
        item->setData(plugin.pluginId(), FacesModel::PluginIdRole);
        appendRow(item);
    }
}
 
QString FacesModel::pluginId(int row)
{
    return data(index(row, 0), PluginIdRole).toString();
}
 
QHash<int, QByteArray> FacesModel::roleNames() const
{
    QHash<int, QByteArray> roles = QAbstractItemModel::roleNames();
 
    roles[PluginIdRole] = "pluginId";
    return roles;
}
 
PresetsModel::PresetsModel(QObject *parent)
    : QStandardItemModel(parent)
{
    reload();
}
 
void PresetsModel::reload()
{
    clear();
    QList<KPluginMetaData> plugins =
        KPackage::PackageLoader::self()->findPackages(QStringLiteral("Plasma/Applet"), QString(), [](const KPluginMetaData &plugin) {
            return plugin.value(QStringLiteral("X-Plasma-RootPath")) == QStringLiteral("org.kde.plasma.systemmonitor");
        });
 
    QSet<QString> usedNames;
 
    // We iterate backwards because packages under ~/.local are listed first, while we want them last
    auto it = plugins.rbegin();
    for (; it != plugins.rend(); ++it) {
        const auto &plugin = *it;
        KPackage::Package p = KPackage::PackageLoader::self()->loadPackage(QStringLiteral("Plasma/Applet"), plugin.pluginId());
        auto metadata = p.metadata();
 
        QString baseName = metadata.name();
        QString name = baseName;
        int id = 0;
 
        while (usedNames.contains(name)) {
            name = baseName + QStringLiteral(" (") + QString::number(++id) + QStringLiteral(")");
        }
        usedNames << name;
 
        QStandardItem *item = new QStandardItem(baseName);
 
        // TODO config
        QVariantMap config;
 
        KConfigGroup configGroup(KSharedConfig::openConfig(p.filePath("config", QStringLiteral("faceproperties")), KConfig::SimpleConfig),
                                 QStringLiteral("Config"));
 
        const QStringList keys = configGroup.keyList();
        for (const QString &key : keys) {
            // all strings for now, type conversion happens in QML side when we have the config property map
            config.insert(key, configGroup.readEntry(key));
        }
 
        item->setData(plugin.pluginId(), PresetsModel::PluginIdRole);
        item->setData(config, PresetsModel::ConfigRole);
 
        item->setData(QFileInfo(p.metadata().fileName()).isWritable(), PresetsModel::WritableRole);
 
        appendRow(item);
    }
}
 
QHash<int, QByteArray> PresetsModel::roleNames() const
{
    QHash<int, QByteArray> roles = QAbstractItemModel::roleNames();
 
    roles[PluginIdRole] = "pluginId";
    roles[ConfigRole] = "config";
    roles[WritableRole] = "writable";
    return roles;
}
 
SensorResolver::SensorResolver(SensorFaceController *_controller, const QJsonArray &_expected)
    : controller(_controller)
    , expected(_expected)
{
}
 
void SensorResolver::execute()
{
    std::transform(expected.begin(), expected.end(), std::back_inserter(queries), [this](const QJsonValue &entry) -> SensorQuery * {
        if (entry.isNull()) {
            return nullptr;
        }
 
        auto query = new SensorQuery{entry.toString()};
        query->connect(query, &KSysGuard::SensorQuery::finished, controller, [this](SensorQuery *query) {
            query->sortByName();
            query->deleteLater();
 
            const auto ids = query->sensorIds();
            if (ids.isEmpty()) {
                missing.append(query->path());
            } else {
                std::transform(ids.begin(), ids.end(), std::back_inserter(found), [](const QString &id) {
                    return id;
                });
            }
 
            queries.removeOne(query);
            if (queries.isEmpty()) {
                callback(this);
            }
        });
        query->execute();
        return query;
    });
 
    queries.removeAll(nullptr);
}
 
QList<QPair<QRegularExpression, QString>> KSysGuard::SensorFaceControllerPrivate::sensorIdReplacements;
QRegularExpression SensorFaceControllerPrivate::oldDiskSensor = QRegularExpression(QStringLiteral("^disk\\/(.+)_\\(\\d+:\\d+\\)"));
QRegularExpression SensorFaceControllerPrivate::oldPartitionSensor = QRegularExpression(QStringLiteral("^partitions(\\/.+)\\/"));
 
SensorFaceControllerPrivate::SensorFaceControllerPrivate()
{
    if (SensorFaceControllerPrivate::sensorIdReplacements.isEmpty()) {
        // A list of conversion rules to convert old sensor ids to new ones.
        // When loading, each regular expression tries to match to the sensor
        // id. If it matches, it will be be used to replace the sensor id with
        // the second argument.
        sensorIdReplacements = {
            {QRegularExpression(QStringLiteral("network/interfaces/(.*)")), QStringLiteral("network/\\1")},
            {QRegularExpression(QStringLiteral("network/all/receivedDataRate$")), QStringLiteral("network/all/download")},
            {QRegularExpression(QStringLiteral("network/all/sentDataRate$")), QStringLiteral("network/all/upload")},
            {QRegularExpression(QStringLiteral("network/all/totalReceivedData$")), QStringLiteral("network/all/totalDownload")},
            {QRegularExpression(QStringLiteral("network/all/totalSentData$")), QStringLiteral("network/all/totalUpload")},
            {QRegularExpression(QStringLiteral("(.*)/receiver/data$")), QStringLiteral("\\1/download")},
            {QRegularExpression(QStringLiteral("(.*)/transmitter/data$")), QStringLiteral("\\1/upload")},
            {QRegularExpression(QStringLiteral("(.*)/receiver/dataTotal$")), QStringLiteral("\\1/totalDownload")},
            {QRegularExpression(QStringLiteral("(.*)/transmitter/dataTotal$")), QStringLiteral("\\1/totalUpload")},
            {QRegularExpression(QStringLiteral("(.*)/Rate/rio")), QStringLiteral("\\1/read")},
            {QRegularExpression(QStringLiteral("(.*)/Rate/wio$")), QStringLiteral("\\1/write")},
            {QRegularExpression(QStringLiteral("(.*)/freespace$")), QStringLiteral("\\1/free")},
            {QRegularExpression(QStringLiteral("(.*)/filllevel$")), QStringLiteral("\\1/usedPercent")},
            {QRegularExpression(QStringLiteral("(.*)/usedspace$")), QStringLiteral("\\1/used")},
            {QRegularExpression(QStringLiteral("cpu/system/(.*)$")), QStringLiteral("cpu/all/\\1")},
            {QRegularExpression(QStringLiteral("cpu/(.*)/sys$")), QStringLiteral("cpu/\\1/system")},
            {QRegularExpression(QStringLiteral("cpu/(.*)/TotalLoad$")), QStringLiteral("cpu/\\1/usage")},
            {QRegularExpression(QStringLiteral("cpu/cpu(\\d+)/clock$")), QStringLiteral("cpu/cpu\\1/frequency")},
            {QRegularExpression(QStringLiteral("mem/(.*)level")), QStringLiteral("mem/\\1Percent")},
            {QRegularExpression(QStringLiteral("mem/physical/allocated")), QStringLiteral("memory/physical/used")},
            {QRegularExpression(QStringLiteral("mem/physical/available")), QStringLiteral("memory/physical/free")},
            {QRegularExpression(QStringLiteral("mem/physical/buf")), QStringLiteral("memory/physical/buffer")},
            {QRegularExpression(QStringLiteral("mem/physical/cached")), QStringLiteral("memory/physical/cache")},
            {QRegularExpression(QStringLiteral("^mem/(.*)")), QStringLiteral("memory/\\1")},
            {QRegularExpression(QStringLiteral("nvidia/(.*)/temperature$")), QStringLiteral("gpu/\\1/temperature")},
            {QRegularExpression(QStringLiteral("nvidia/(.*)/memoryClock$")), QStringLiteral("gpu/\\1/memoryFrequency")},
            {QRegularExpression(QStringLiteral("nvidia/(.*)/processorClock$")), QStringLiteral("gpu/\\1/coreFrequency")},
            {QRegularExpression(QStringLiteral("nvidia/(.*)/(memory|sharedMemory)$")), QStringLiteral("gpu/\\1/usedVram")},
            {QRegularExpression(QStringLiteral("nvidia/(.*)/(encoderUsage|decoderUsage)$")), QStringLiteral("gpu/\\1/usage")},
            {QRegularExpression(QStringLiteral("^(uptime|system/uptime/uptime)$")), QStringLiteral("os/system/uptime")},
        };
    }
}
 
QString SensorFaceControllerPrivate::replaceDiskId(const QString &entryName) const
{
    const auto match = oldDiskSensor.match(entryName);
    if (!match.hasMatch()) {
        return entryName;
    }
    const QString device = match.captured(1);
    Solid::Predicate predicate(Solid::DeviceInterface::StorageAccess);
    predicate &= Solid::Predicate(Solid::DeviceInterface::Block, QStringLiteral("device"), QStringLiteral("/dev/%1").arg(device));
    const auto devices = Solid::Device::listFromQuery(predicate);
    if (devices.empty()) {
        return QString();
    }
    QString sensorId = entryName;
    const auto volume = devices[0].as<Solid::StorageVolume>();
    const QString id = volume->uuid().isEmpty() ? volume->label() : volume->uuid();
    return sensorId.replace(match.captured(0), QStringLiteral("disk/") + id);
}
 
QString SensorFaceControllerPrivate::replacePartitionId(const QString &entryName) const
{
    const auto match = oldPartitionSensor.match(entryName);
    if (!match.hasMatch()) {
        return entryName;
    }
    QString sensorId = entryName;
 
    if (match.captured(1) == QLatin1String("/all")) {
        return sensorId.replace(match.captured(0), QStringLiteral("disk/all/"));
    }
 
    const QString filePath = match.captured(1) == QLatin1String("/__root__") ? QStringLiteral("/") : match.captured(1);
    const Solid::Predicate predicate(Solid::DeviceInterface::StorageAccess, QStringLiteral("filePath"), filePath);
    const auto devices = Solid::Device::listFromQuery(predicate);
    if (devices.empty()) {
        return entryName;
    }
    const auto volume = devices[0].as<Solid::StorageVolume>();
    const QString id = volume->uuid().isEmpty() ? volume->label() : volume->uuid();
    return sensorId.replace(match.captured(0), QStringLiteral("disk/%1/").arg(id));
}
 
QJsonArray SensorFaceControllerPrivate::readSensors(const KConfigGroup &read, const QString &entryName)
{
    auto original = QJsonDocument::fromJson(read.readEntry(entryName, QString()).toUtf8()).array();
    QJsonArray newSensors;
    for (auto entry : original) {
        QString sensorId = entry.toString();
        for (auto replacement : std::as_const(sensorIdReplacements)) {
            auto match = replacement.first.match(sensorId);
            if (match.hasMatch()) {
                sensorId.replace(replacement.first, replacement.second);
            }
        }
        sensorId = replaceDiskId(sensorId);
        sensorId = replacePartitionId(sensorId);
        newSensors.append(sensorId);
    }
 
    return newSensors;
}
 
QJsonArray SensorFaceControllerPrivate::readAndUpdateSensors(KConfigGroup &config, const QString &entryName)
{
    auto original = QJsonDocument::fromJson(config.readEntry(entryName, QString()).toUtf8()).array();
 
    const KConfigGroup &group = config;
    auto newSensors = readSensors(group, entryName);
 
    if (newSensors != original) {
        config.writeEntry(entryName, QJsonDocument(newSensors).toJson(QJsonDocument::Compact));
    }
 
    return newSensors;
}
 
void SensorFaceControllerPrivate::resolveSensors(const QJsonArray &partialEntries, std::function<void(SensorResolver *)> callback)
{
    auto resolver = new SensorResolver{q, partialEntries};
    resolver->callback = [this, callback](SensorResolver *resolver) {
        callback(resolver);
 
        if (!resolver->missing.isEmpty()) {
            for (const auto &entry : std::as_const(resolver->missing)) {
                missingSensors.append(entry);
            }
            Q_EMIT q->missingSensorsChanged();
        }
 
        delete resolver;
    };
    resolver->execute();
}
 
SensorFace *SensorFaceControllerPrivate::createGui(const QString &qmlPath)
{
    QQmlComponent *component = new QQmlComponent(engine, qmlPath, nullptr);
    // TODO: eventually support async  components? (only useful for qml files from http, we probably don't want that)
    if (component->status() != QQmlComponent::Ready) {
        qCritical() << "Error creating component:";
        for (auto err : component->errors()) {
            qWarning() << err.toString();
        }
        component->deleteLater();
        return nullptr;
    }
 
    QQmlContext *context = new QQmlContext(engine);
    context->setContextObject(contextObj);
    QObject *guiObject = component->beginCreate(context);
    SensorFace *gui = qobject_cast<SensorFace *>(guiObject);
    if (!gui) {
        qWarning() << "ERROR: QML gui" << guiObject << "not a SensorFace instance";
        guiObject->deleteLater();
        context->deleteLater();
        return nullptr;
    }
    context->setParent(gui);
 
    gui->setController(q);
    gui->setParent(q);
 
    component->completeCreate();
 
    component->deleteLater();
    return gui;
}
 
QQuickItem *SensorFaceControllerPrivate::createConfigUi(const QString &file, const QVariantMap &initialProperties)
{
    QQmlComponent *component = new QQmlComponent(configEngine, file, nullptr);
    // TODO: eventually support async  components? (only useful for qml files from http, we probably don't want that)
    if (component->status() != QQmlComponent::Ready) {
        qCritical() << "Error creating component:";
        for (auto err : component->errors()) {
            qWarning() << err.toString();
        }
        component->deleteLater();
        return nullptr;
    }
 
    QQmlContext *context = new QQmlContext(configEngine);
    context->setContextObject(contextObj);
    QObject *guiObject = component->createWithInitialProperties(initialProperties, context);
    QQuickItem *gui = qobject_cast<QQuickItem *>(guiObject);
    Q_ASSERT(gui);
    context->setParent(gui);
    gui->setParent(q);
 
    component->deleteLater();
 
    return gui;
}
 
SensorFaceController::SensorFaceController(KConfigGroup &config, QQmlEngine *engine, QQmlEngine *configEngine)
    : QObject(engine)
    , d(std::make_unique<SensorFaceControllerPrivate>())
{
    d->q = this;
    d->configGroup = config;
    d->appearanceGroup = KConfigGroup(&config, "Appearance");
    d->sensorsGroup = KConfigGroup(&config, "Sensors");
    d->colorsGroup = KConfigGroup(&config, "SensorColors");
    d->labelsGroup = KConfigGroup(&config, "SensorLabels");
    d->engine = engine;
    // Ensure we don't re-use the Plasma Theme coloring by using separate configEngine, BUG:483689
    d->configEngine = configEngine;
    d->syncTimer = new QTimer(this);
    d->syncTimer->setSingleShot(true);
    d->syncTimer->setInterval(5000);
    connect(d->syncTimer, &QTimer::timeout, this, [this]() {
        if (!d->shouldSync) {
            return;
        }
        d->appearanceGroup.sync();
        d->sensorsGroup.sync();
    });
 
    d->contextObj = new KLocalizedContext(this);
 
    d->resolveSensors(d->readAndUpdateSensors(d->sensorsGroup, QStringLiteral("totalSensors")), [this](SensorResolver *resolver) {
        d->totalSensors = resolver->found;
        Q_EMIT totalSensorsChanged();
    });
    d->resolveSensors(d->readAndUpdateSensors(d->sensorsGroup, QStringLiteral("lowPrioritySensorIds")), [this](SensorResolver *resolver) {
        d->lowPrioritySensorIds = resolver->found;
        Q_EMIT lowPrioritySensorIdsChanged();
    });
    d->resolveSensors(d->readAndUpdateSensors(d->sensorsGroup, QStringLiteral("highPrioritySensorIds")), [this](SensorResolver *resolver) {
        d->highPrioritySensorIds = resolver->found;
        Q_EMIT highPrioritySensorIdsChanged();
    });
 
    setFaceId(d->appearanceGroup.readEntry("chartFace", QStringLiteral("org.kde.ksysguard.piechart")));
}
 
SensorFaceController::~SensorFaceController()
{
    if (!d->faceProperties.isValid()) {
        return;
    }
 
    auto forceSave = d->faceProperties.readEntry(QStringLiteral("ForceSaveOnDestroy"), false);
    if (!forceSave) {
        if (!d->shouldSync) {
            // If we should not sync automatically, clear all changes before we
            // destroy the config objects, otherwise they will be written during
            // destruction.
            d->appearanceGroup.markAsClean();
            d->colorsGroup.markAsClean();
            d->labelsGroup.markAsClean();
            if (d->faceConfigLoader && d->faceConfigLoader->isSaveNeeded()) {
                d->faceConfigLoader->load();
            }
        }
    } else {
        d->faceConfigLoader->save();
    }
}
 
KConfigGroup KSysGuard::SensorFaceController::configGroup() const
{
    return d->configGroup;
}
 
QString SensorFaceController::title() const
{
    // both Title and title can exist to allow i18n of Title
    if (d->appearanceGroup.hasKey("title")) {
        return d->appearanceGroup.readEntry("title");
    } else {
        // if neither exist fall back to name
        return d->appearanceGroup.readEntry("Title", i18n("System Monitor Sensor"));
    }
}
 
void SensorFaceController::setTitle(const QString &title)
{
    if (title == SensorFaceController::title()) {
        return;
    }
 
    d->appearanceGroup.writeEntry("title", title);
    d->syncTimer->start();
 
    Q_EMIT titleChanged();
}
 
bool SensorFaceController::showTitle() const
{
    return d->appearanceGroup.readEntry("showTitle", true);
}
 
void SensorFaceController::setShowTitle(bool show)
{
    if (show == showTitle()) {
        return;
    }
 
    d->appearanceGroup.writeEntry("showTitle", show);
    d->syncTimer->start();
 
    Q_EMIT showTitleChanged();
}
 
QJsonArray SensorFaceController::totalSensors() const
{
    return d->totalSensors;
}
 
void SensorFaceController::setTotalSensors(const QJsonArray &totalSensors)
{
    if (totalSensors == d->totalSensors) {
        return;
    }
    const auto currentEntry = QJsonDocument::fromJson(d->sensorsGroup.readEntry("totalSensors").toUtf8()).array();
    if (totalSensors == currentEntry) {
        return;
    }
    d->sensorsGroup.writeEntry("totalSensors", QJsonDocument(totalSensors).toJson(QJsonDocument::Compact));
    // Until we have resolved
    d->totalSensors = totalSensors;
    d->syncTimer->start();
    Q_EMIT totalSensorsChanged();
    d->resolveSensors(totalSensors, [this](SensorResolver *resolver) {
        if (resolver->found == d->totalSensors) {
            return;
        }
        d->totalSensors = resolver->found;
        Q_EMIT totalSensorsChanged();
    });
}
 
QJsonArray SensorFaceController::highPrioritySensorIds() const
{
    return d->highPrioritySensorIds;
}
 
void SensorFaceController::setHighPrioritySensorIds(const QJsonArray &highPrioritySensorIds)
{
    if (highPrioritySensorIds == d->highPrioritySensorIds) {
        return;
    }
    const auto currentEntry = QJsonDocument::fromJson(d->sensorsGroup.readEntry("highPrioritySensorIds").toUtf8()).array();
    if (highPrioritySensorIds == currentEntry) {
        return;
    }
    d->sensorsGroup.writeEntry("highPrioritySensorIds", QJsonDocument(highPrioritySensorIds).toJson(QJsonDocument::Compact));
    // Until we have resolved
    d->syncTimer->start();
    d->highPrioritySensorIds = highPrioritySensorIds;
    Q_EMIT highPrioritySensorIdsChanged();
    d->resolveSensors(highPrioritySensorIds, [this](SensorResolver *resolver) {
        if (resolver->found == d->highPrioritySensorIds) {
            return;
        }
        d->highPrioritySensorIds = resolver->found;
        Q_EMIT highPrioritySensorIdsChanged();
    });
}
 
QJsonArray KSysGuard::SensorFaceController::missingSensors() const
{
    return d->missingSensors;
}
 
QVariantMap SensorFaceController::sensorColors() const
{
    QVariantMap colors;
    for (const auto &key : d->colorsGroup.keyList()) {
        QColor color = d->colorsGroup.readEntry(key, QColor());
 
        if (color.isValid()) {
            colors[key] = color;
        }
    }
    return colors;
}
 
void SensorFaceController::setSensorColors(const QVariantMap &colors)
{
    if (colors == this->sensorColors()) {
        return;
    }
 
    d->colorsGroup.deleteGroup();
    d->colorsGroup = KConfigGroup(&d->configGroup, "SensorColors");
 
    auto it = colors.constBegin();
    for (; it != colors.constEnd(); ++it) {
        d->colorsGroup.writeEntry(it.key(), it.value());
    }
 
    d->syncTimer->start();
    Q_EMIT sensorColorsChanged();
}
 
QVariantMap SensorFaceController::sensorLabels() const
{
    QVariantMap labels;
    for (const auto &key : d->labelsGroup.keyList()) {
        labels[key] = d->labelsGroup.readEntry(key);
    }
    return labels;
}
 
void SensorFaceController::setSensorLabels(const QVariantMap &labels)
{
    if (labels == this->sensorLabels()) {
        return;
    }
 
    d->labelsGroup.deleteGroup();
    d->labelsGroup = KConfigGroup(&d->configGroup, "SensorLabels");
 
    for (auto it = labels.cbegin(); it != labels.cend(); ++it) {
        const auto label = it.value().toString();
        if (!label.isEmpty()) {
            d->labelsGroup.writeEntry(it.key(), label);
        }
    }
 
    d->syncTimer->start();
    Q_EMIT sensorLabelsChanged();
}
 
QJsonArray SensorFaceController::lowPrioritySensorIds() const
{
    return d->lowPrioritySensorIds;
}
 
void SensorFaceController::setLowPrioritySensorIds(const QJsonArray &lowPrioritySensorIds)
{
    if (lowPrioritySensorIds == d->lowPrioritySensorIds) {
        return;
    }
    const auto currentEntry = QJsonDocument::fromJson(d->sensorsGroup.readEntry("lowPrioritySensorIds").toUtf8()).array();
    if (lowPrioritySensorIds == currentEntry) {
        return;
    }
    d->sensorsGroup.writeEntry("lowPrioritySensorIds", QJsonDocument(lowPrioritySensorIds).toJson(QJsonDocument::Compact));
    // Until we have resolved
    d->lowPrioritySensorIds = lowPrioritySensorIds;
    d->syncTimer->start();
    Q_EMIT lowPrioritySensorIdsChanged();
    d->resolveSensors(lowPrioritySensorIds, [this](SensorResolver *resolver) {
        if (resolver->found == d->lowPrioritySensorIds) {
            return;
        }
        d->lowPrioritySensorIds = resolver->found;
        Q_EMIT lowPrioritySensorIdsChanged();
    });
}
 
int SensorFaceController::updateRateLimit() const
{
    return d->appearanceGroup.readEntry<int>(QStringLiteral("updateRateLimit"), 0);
}
 
void SensorFaceController::setUpdateRateLimit(int limit)
{
    if (limit == updateRateLimit()) {
        return;
    }
 
    d->appearanceGroup.writeEntry("updateRateLimit", limit);
    d->syncTimer->start();
 
    Q_EMIT updateRateLimitChanged();
}
 
// from face config, immutable by the user
QString SensorFaceController::name() const
{
    return d->facePackage.metadata().name();
}
 
const QString SensorFaceController::icon() const
{
    return d->facePackage.metadata().iconName();
}
 
bool SensorFaceController::supportsSensorsColors() const
{
    if (!d->faceProperties.isValid()) {
        return false;
    }
 
    return d->faceProperties.readEntry("SupportsSensorsColors", false);
}
 
bool SensorFaceController::supportsTotalSensors() const
{
    if (!d->faceProperties.isValid()) {
        return false;
    }
 
    return d->faceProperties.readEntry("SupportsTotalSensors", false);
}
 
bool SensorFaceController::supportsLowPrioritySensors() const
{
    if (!d->faceProperties.isValid()) {
        return false;
    }
 
    return d->faceProperties.readEntry("SupportsLowPrioritySensors", false);
}
 
int SensorFaceController::maxTotalSensors() const
{
    if (!d->faceProperties.isValid()) {
        return 1;
    }
 
    return d->faceProperties.readEntry("MaxTotalSensors", 1);
}
 
void SensorFaceController::setFaceId(const QString &face)
{
    if (d->faceId == face) {
        return;
    }
 
    if (d->fullRepresentation) {
        d->fullRepresentation->deleteLater();
        d->fullRepresentation.clear();
    }
    if (d->compactRepresentation) {
        d->compactRepresentation->deleteLater();
        d->compactRepresentation.clear();
    }
    if (d->faceConfigUi) {
        d->faceConfigUi->deleteLater();
        d->faceConfigUi.clear();
    }
 
    d->faceId = face;
 
    d->facePackage = KPackage::PackageLoader::self()->loadPackage(QStringLiteral("KSysguard/SensorFace"), face);
 
    if (d->faceConfiguration) {
        d->faceConfiguration->deleteLater();
        d->faceConfiguration = nullptr;
    }
    if (d->faceConfigLoader) {
        d->faceConfigLoader->deleteLater();
        d->faceConfigLoader = nullptr;
    }
 
    if (!d->facePackage.isValid()) {
        Q_EMIT faceIdChanged();
        return;
    }
 
    d->contextObj->setTranslationDomain(QLatin1String("ksysguard_face_") + face);
 
    d->faceProperties = KConfigGroup(KSharedConfig::openConfig(d->facePackage.filePath("FaceProperties"), KConfig::SimpleConfig), QStringLiteral("Config"));
 
    if (!d->faceProperties.isValid()) {
        Q_EMIT faceIdChanged();
        return;
    }
 
    reloadFaceConfiguration();
 
    d->appearanceGroup.writeEntry("chartFace", face);
    d->syncTimer->start();
    Q_EMIT faceIdChanged();
    return;
}
 
QString SensorFaceController::faceId() const
{
    return d->faceId;
}
 
KConfigPropertyMap *SensorFaceController::faceConfiguration() const
{
    return d->faceConfiguration;
}
 
QQuickItem *SensorFaceController::compactRepresentation()
{
    if (!d->facePackage.isValid()) {
        return nullptr;
    } else if (d->compactRepresentation) {
        return d->compactRepresentation;
    }
 
    d->compactRepresentation = d->createGui(d->facePackage.filePath("ui", QStringLiteral("CompactRepresentation.qml")));
    return d->compactRepresentation;
}
 
QQuickItem *SensorFaceController::fullRepresentation()
{
    if (!d->facePackage.isValid()) {
        return nullptr;
    } else if (d->fullRepresentation) {
        return d->fullRepresentation;
    }
 
    d->fullRepresentation = d->createGui(d->facePackage.filePath("ui", QStringLiteral("FullRepresentation.qml")));
    return d->fullRepresentation;
}
 
QQuickItem *SensorFaceController::faceConfigUi()
{
    if (!d->facePackage.isValid()) {
        return nullptr;
    } else if (d->faceConfigUi) {
        return d->faceConfigUi;
    }
 
    const QString filePath = d->facePackage.filePath("ui", QStringLiteral("Config.qml"));
 
    if (filePath.isEmpty()) {
        return nullptr;
    }
 
    d->faceConfigUi = d->createConfigUi(QStringLiteral(":/FaceDetailsConfig.qml"),
                                        {{QStringLiteral("controller"), QVariant::fromValue(this)}, {QStringLiteral("source"), QUrl::fromLocalFile(filePath)}});
 
    if (d->faceConfigUi && !d->faceConfigUi->property("item").value<QQuickItem *>()) {
        d->faceConfigUi->deleteLater();
        d->faceConfigUi.clear();
    }
    return d->faceConfigUi;
}
 
QQuickItem *SensorFaceController::appearanceConfigUi()
{
    if (d->appearanceConfigUi) {
        return d->appearanceConfigUi;
    }
 
    d->appearanceConfigUi = d->createConfigUi(QStringLiteral(":/ConfigAppearance.qml"), {{QStringLiteral("controller"), QVariant::fromValue(this)}});
 
    return d->appearanceConfigUi;
}
 
QQuickItem *SensorFaceController::sensorsConfigUi()
{
    if (d->sensorsConfigUi) {
        return d->sensorsConfigUi;
    }
 
    if (d->faceProperties.isValid() && d->faceProperties.readEntry("SupportsSensors", true)) {
        d->sensorsConfigUi = d->createConfigUi(QStringLiteral(":/ConfigSensors.qml"), {{QStringLiteral("controller"), QVariant::fromValue(this)}});
    } else {
        d->sensorsConfigUi = new QQuickItem;
    }
    return d->sensorsConfigUi;
}
 
QAbstractItemModel *SensorFaceController::availableFacesModel()
{
    if (d->availableFacesModel) {
        return d->availableFacesModel;
    }
 
    d->availableFacesModel = new FacesModel(this);
    return d->availableFacesModel;
}
 
QAbstractItemModel *SensorFaceController::availablePresetsModel()
{
    if (d->availablePresetsModel) {
        return d->availablePresetsModel;
    }
 
    d->availablePresetsModel = new PresetsModel(this);
 
    return d->availablePresetsModel;
}
 
void SensorFaceController::reloadConfig()
{
    if (d->faceConfigLoader) {
        d->faceConfigLoader->load();
    }
 
    d->missingSensors = QJsonArray{};
    Q_EMIT missingSensorsChanged();
 
    d->resolveSensors(d->readAndUpdateSensors(d->sensorsGroup, QStringLiteral("totalSensors")), [this](SensorResolver *resolver) {
        d->totalSensors = resolver->found;
        Q_EMIT totalSensorsChanged();
    });
    d->resolveSensors(d->readAndUpdateSensors(d->sensorsGroup, QStringLiteral("lowPrioritySensorIds")), [this](SensorResolver *resolver) {
        d->lowPrioritySensorIds = resolver->found;
        Q_EMIT lowPrioritySensorIdsChanged();
    });
    d->resolveSensors(d->readAndUpdateSensors(d->sensorsGroup, QStringLiteral("highPrioritySensorIds")), [this](SensorResolver *resolver) {
        d->highPrioritySensorIds = resolver->found;
        Q_EMIT highPrioritySensorIdsChanged();
    });
 
    // Force to re-read all the values
    setFaceId(d->appearanceGroup.readEntry("chartFace", QStringLiteral("org.kde.ksysguard.textonly")));
    Q_EMIT titleChanged();
    Q_EMIT sensorColorsChanged();
    Q_EMIT sensorLabelsChanged();
    Q_EMIT showTitleChanged();
    Q_EMIT updateRateLimitChanged();
}
 
void SensorFaceController::loadPreset(const QString &preset)
{
    if (preset.isEmpty()) {
        return;
    }
 
    auto presetPackage = KPackage::PackageLoader::self()->loadPackage(QStringLiteral("Plasma/Applet"));
 
    presetPackage.setPath(preset);
 
    if (!presetPackage.isValid()) {
        return;
    }
 
    if (presetPackage.metadata().value(QStringLiteral("X-Plasma-RootPath")) != QStringLiteral("org.kde.plasma.systemmonitor")) {
        return;
    }
 
    auto c = KSharedConfig::openConfig(presetPackage.filePath("config", QStringLiteral("faceproperties")), KConfig::SimpleConfig);
    const KConfigGroup presetGroup(c, QStringLiteral("Config"));
    const KConfigGroup colorsGroup(c, QStringLiteral("SensorColors"));
 
    // Load the title
    setTitle(presetPackage.metadata().name());
 
    // Remove the "custom" value from presets models
    if (d->availablePresetsModel && d->availablePresetsModel->data(d->availablePresetsModel->index(0, 0), PresetsModel::PluginIdRole).toString().isEmpty()) {
        d->availablePresetsModel->removeRow(0);
    }
 
    setTotalSensors(d->readSensors(presetGroup, QStringLiteral("totalSensors")));
    setHighPrioritySensorIds(d->readSensors(presetGroup, QStringLiteral("highPrioritySensorIds")));
    setLowPrioritySensorIds(d->readSensors(presetGroup, QStringLiteral("lowPrioritySensorIds")));
 
    setFaceId(presetGroup.readEntry(QStringLiteral("chartFace"), QStringLiteral("org.kde.ksysguard.piechart")));
 
    colorsGroup.copyTo(&d->colorsGroup);
    Q_EMIT sensorColorsChanged();
 
    if (d->faceConfigLoader) {
        KConfigGroup presetGroup(KSharedConfig::openConfig(presetPackage.filePath("FaceProperties"), KConfig::SimpleConfig), QStringLiteral("FaceConfig"));
 
        for (const QString &key : presetGroup.keyList()) {
            KConfigSkeletonItem *item = d->faceConfigLoader->findItemByName(key);
            if (item) {
                if (item->property().type() == QVariant::StringList) {
                    item->setProperty(presetGroup.readEntry(key, QStringList()));
                } else {
                    item->setProperty(presetGroup.readEntry(key));
                }
                d->faceConfigLoader->save();
                d->faceConfigLoader->read();
            }
        }
    }
}
 
void SensorFaceController::savePreset()
{
    // Important! We need to ensure the directory remains valid as long as it has
    // not been installed yet. Since the install is asynchronous, we need to make
    // sure that the QTemporaryDir does not go out of scope until the install is
    // finished, so this directory will be moved into the lambda connected to the
    // job finished signal below to ensure it lives as long as the job.
    QTemporaryDir dir;
    if (!dir.isValid()) {
        return;
    }
 
    savePreset(std::filesystem::path(dir.path().toStdString()));
 
    auto *job = KPackage::PackageJob::install(QStringLiteral("Plasma/Applet"), dir.path());
    connect(job, &KJob::finished, this, [this, dir = std::move(dir)](KJob *job) {
        if (job->error() == 0) {
            d->availablePresetsModel->reload();
        } else {
            qCWarning(LIBKSYSGUARD_FACES) << "Failed to install package:" << qPrintable(job->errorString());
        }
    });
}
 
void KSysGuard::SensorFaceController::savePreset(const std::filesystem::path &path)
{
    QString pluginName = QStringLiteral("org.kde.plasma.systemmonitor.") + title().simplified().replace(QLatin1Char(' '), QStringLiteral("")).toLower();
    int suffix = 0;
 
    auto presetPackage = KPackage::PackageLoader::self()->loadPackage(QStringLiteral("Plasma/Applet"));
 
    presetPackage.setPath(pluginName);
    if (presetPackage.isValid()) {
        do {
            presetPackage.setPath(QString());
            presetPackage.setPath(pluginName + QString::number(++suffix));
        } while (presetPackage.isValid());
 
        pluginName += QString::number(suffix);
    }
 
    // First write "new style" plugin JSON file.
    QJsonDocument json;
    json.setObject({
        {"KPlugin",
         QJsonObject{
             {"Id", pluginName},
             {"Name", title()},
             {"Icon", "ksysguardd"},
             {"Category", "System Information"},
             {"License", "LGPL 2.1+"},
             {"EnabledByDefault", true},
             {"Version", "0.1"},
         }},
        {"X-Plasma-API", "declarativeappletscript"},
        {"X-Plasma-MainScript", "ui/main.qml"},
        {"X-Plasma-Provides", "org.kde.plasma.systemmonitor"},
        {"X-Plasma-RootPath", "org.kde.plasma.systemmonitor"},
        {"KPackageStructure", "Plasma/Applet"},
    });
 
    if (QFile file{path / "metadata.json"}; file.open(QIODevice::WriteOnly)) {
        file.write(json.toJson());
    } else {
        qWarning() << "Could not write metadata.json file for preset" << title();
    }
 
    std::filesystem::create_directories(path / "contents" / "config");
 
    KConfig faceConfig(QString::fromStdString((path / "contents" / "config" / "faceproperties").string()));
 
    KConfigGroup configGroup(&faceConfig, "Config");
 
    auto sensors = d->readAndUpdateSensors(d->sensorsGroup, QStringLiteral("totalSensors"));
    configGroup.writeEntry(QStringLiteral("totalSensors"), QJsonDocument(sensors).toJson(QJsonDocument::Compact));
    sensors = d->readAndUpdateSensors(d->sensorsGroup, QStringLiteral("highPrioritySensorIds"));
    configGroup.writeEntry(QStringLiteral("highPrioritySensorIds"), QJsonDocument(sensors).toJson(QJsonDocument::Compact));
    sensors = d->readAndUpdateSensors(d->sensorsGroup, QStringLiteral("lowPrioritySensorIds"));
    configGroup.writeEntry(QStringLiteral("lowPrioritySensorIds"), QJsonDocument(sensors).toJson(QJsonDocument::Compact));
    configGroup.writeEntry(QStringLiteral("chartFace"), faceId());
 
    KConfigGroup colorsGroup(&faceConfig, "SensorColors");
    d->colorsGroup.copyTo(&colorsGroup);
    colorsGroup.sync();
 
    configGroup = KConfigGroup(&faceConfig, "FaceConfig");
    if (d->faceConfigLoader) {
        const auto &items = d->faceConfigLoader->items();
        for (KConfigSkeletonItem *item : items) {
            configGroup.writeEntry(item->key(), item->property());
        }
    }
    configGroup.sync();
}
 
void SensorFaceController::uninstallPreset(const QString &pluginId)
{
    auto presetPackage = KPackage::PackageLoader::self()->loadPackage(QStringLiteral("Plasma/Applet"), pluginId);
 
    if (presetPackage.metadata().value(QStringLiteral("X-Plasma-RootPath")) != QStringLiteral("org.kde.plasma.systemmonitor")) {
        return;
    }
 
    QDir root(presetPackage.path());
    root.cdUp();
    auto *job = KPackage::PackageJob::uninstall(QStringLiteral("Plasma/Applet"), pluginId, root.path());
 
    connect(job, &KJob::finished, this, [this]() {
        d->availablePresetsModel->reload();
    });
}
 
bool SensorFaceController::shouldSync() const
{
    return d->shouldSync;
}
 
void SensorFaceController::setShouldSync(bool sync)
{
    d->shouldSync = sync;
    if (!d->shouldSync && d->syncTimer->isActive()) {
        d->syncTimer->stop();
    }
}
 
void SensorFaceController::reloadFaceConfiguration()
{
    const QString xmlPath = d->facePackage.filePath("mainconfigxml");
 
    if (!xmlPath.isEmpty()) {
        QFile file(xmlPath);
        KConfigGroup cg(&d->configGroup, d->faceId);
 
        if (d->faceConfigLoader) {
            delete d->faceConfigLoader;
        }
 
        if (d->faceConfiguration) {
            delete d->faceConfiguration;
        }
 
        d->faceConfigLoader = new KConfigLoader(cg, &file, this);
        d->faceConfiguration = new KConfigPropertyMap(d->faceConfigLoader, this);
        connect(d->faceConfiguration, &KConfigPropertyMap::valueChanged, this, [this](const QString &key) {
            auto item = d->faceConfigLoader->findItemByName(key);
            if (item) {
                item->writeConfig(d->faceConfigLoader->config());
            }
        });
 
        Q_EMIT faceConfigurationChanged();
    }
}
 
void KSysGuard::SensorFaceController::replaceSensors(const QString &from, const QString &to)
{
    auto replaceSensors = [this, from, to](const QString &configEntry) {
        auto array = QJsonDocument::fromJson(d->sensorsGroup.readEntry(configEntry, QString()).toUtf8()).array();
        for (auto itr = array.begin(); itr != array.end(); ++itr) {
            if (itr->toString() == from) {
                *itr = QJsonValue(to);
            }
        }
        return QJsonDocument(array).toJson(QJsonDocument::Compact);
    };
 
    d->sensorsGroup.writeEntry("totalSensors", replaceSensors(QStringLiteral("totalSensors")));
    d->sensorsGroup.writeEntry("highPrioritySensorIds", replaceSensors(QStringLiteral("highPrioritySensorIds")));
    d->sensorsGroup.writeEntry("lowPrioritySensorIds", replaceSensors(QStringLiteral("lowPrioritySensorIds")));
 
    if (d->shouldSync) {
        d->sensorsGroup.sync();
    }
}
 
#include "moc_SensorFaceController.cpp"