SensorTreeModel.cpp

/*
    SPDX-FileCopyrightText: 2019 Eike Hein <hein@kde.org>
    SPDX-FileCopyrightText: 2020 Arjen Hiemstra <ahiemstra@heimr.nl>
 
    SPDX-License-Identifier: LGPL-2.0-or-later
*/
 
#include "SensorTreeModel.h"
 
#include <optional>
 
#include <KLocalizedString>
#include <QCollator>
#include <QDebug>
#include <QMetaEnum>
#include <QMimeData>
#include <QRegularExpression>
 
#include "formatter/Formatter.h"
#include "systemstats/SensorInfo.h"
 
#include "Sensor.h"
#include "SensorDaemonInterface_p.h"
#include "SensorGroup_p.h"
#include "SensorQuery.h"
 
using namespace KSysGuard;
 
struct Compare {
    bool operator()(const QString &first, const QString &second) const
    {
        // Place "All" object at the top.
        if (first == QLatin1String("all") && first != second) {
            return true;
        }
 
        if (second == QLatin1String("all")) {
            return false;
        }
 
        if (!collator) {
            collator = QCollator();
            collator->setNumericMode(true);
            collator->setCaseSensitivity(Qt::CaseInsensitive);
        }
 
        return collator->compare(first, second) < 0;
    }
 
    // This uses thread-local storage because QCollator may not be thread safe.
    // We store it in an optional to make sure we can initialize it above.
    thread_local static std::optional<QCollator> collator;
};
 
thread_local std::optional<QCollator> Compare::collator = std::nullopt;
 
struct Q_DECL_HIDDEN SensorTreeItem {
    SensorTreeItem *parent = nullptr;
    QString segment;
    std::map<QString, std::unique_ptr<SensorTreeItem>, Compare> children;
 
    inline int indexOf(const QString &segment) const
    {
        auto itr = std::find_if(children.cbegin(), children.cend(), [segment](const auto &item) {
            return item.second->segment == segment;
        });
 
        if (itr != children.cend()) {
            return std::distance(children.cbegin(), itr);
        }
 
        return -1;
    }
 
    inline SensorTreeItem *itemAt(std::size_t index) const
    {
        if (index >= children.size()) {
            return nullptr;
        }
 
        auto itr = children.cbegin();
        std::advance(itr, index);
        return itr->second.get();
    }
};
 
class Q_DECL_HIDDEN SensorTreeModel::Private
{
public:
    Private(SensorTreeModel *qq)
        : rootItem(new SensorTreeItem)
        , q(qq)
    {
        m_sensorGroup = new SensorGroup;
    }
    ~Private()
    {
        delete rootItem;
        delete m_sensorGroup;
    }
 
    SensorTreeItem *rootItem;
    QHash<SensorTreeItem *, SensorInfo> sensorInfos;
 
    void addSensor(const QString &sensorId, const SensorInfo &info);
    void removeSensor(const QString &sensorId);
 
    QString sensorId(const QModelIndex &index);
 
    SensorTreeItem *find(const QString &sensorId);
 
    SensorGroup *m_sensorGroup;
 
    QHash<QString, int> m_groupMatches;
 
private:
    SensorTreeModel *q;
};
 
void SensorTreeModel::Private::addSensor(const QString &sensorId, const SensorInfo &info)
{
    const QStringList &segments = sensorId.split(QLatin1Char('/'));
 
    if (!segments.count() || segments.at(0).isEmpty()) {
        qDebug() << "Rejecting sensor" << sensorId << "- sensor id is not well-formed.";
        return;
    }
 
    QString sensorIdExpr = m_sensorGroup->groupRegexForId(sensorId);
 
    if (!sensorIdExpr.isEmpty()) {
        if (m_groupMatches.contains(sensorIdExpr)) {
            m_groupMatches[sensorIdExpr]++;
        } else {
            m_groupMatches[sensorIdExpr] = 1;
        }
 
        if (m_groupMatches[sensorIdExpr] == 2) {
            SensorInfo newInfo;
            newInfo.name = m_sensorGroup->sensorNameForRegEx(sensorIdExpr);
            newInfo.description = info.description;
            newInfo.variantType = info.variantType;
            newInfo.unit = info.unit;
            newInfo.min = info.min;
            newInfo.max = info.max;
 
            addSensor(sensorIdExpr, newInfo);
        }
    }
 
    SensorTreeItem *item = rootItem;
    for (auto segment : segments) {
        if (auto itr = item->children.find(segment); itr != item->children.end() && itr->second) {
            item = itr->second.get();
        } else {
            auto newItem = std::make_unique<SensorTreeItem>();
            newItem->parent = item;
            newItem->segment = segment;
 
            const QModelIndex &parentIndex = (item == rootItem) ? QModelIndex() : q->createIndex(item->parent->indexOf(item->segment), 0, item);
 
            auto index = std::distance(item->children.begin(), item->children.upper_bound(segment));
 
            q->beginInsertRows(parentIndex, index, index);
            item->children[segment] = std::move(newItem);
            q->endInsertRows();
 
            item = item->children[segment].get();
        }
    }
 
    sensorInfos[item] = info;
}
 
void SensorTreeModel::Private::removeSensor(const QString &sensorId)
{
    QString sensorIdExpr = m_sensorGroup->groupRegexForId(sensorId);
    if (!sensorIdExpr.isEmpty()) {
        if (m_groupMatches[sensorIdExpr] == 1) {
            m_groupMatches.remove(sensorIdExpr);
            removeSensor(sensorIdExpr);
        } else if (m_groupMatches.contains(sensorIdExpr)) {
            m_groupMatches[sensorIdExpr]--;
        }
    }
 
    SensorTreeItem *item = find(sensorId);
    if (!item) {
        return;
    }
 
    SensorTreeItem *parent = item->parent;
    if (!parent) {
        return;
    }
 
    auto remove = [this](SensorTreeItem *item, SensorTreeItem *parent) {
        const int index = item->parent->indexOf(item->segment);
 
        const QModelIndex &parentIndex = (parent == rootItem) ? QModelIndex() : q->createIndex(parent->parent->indexOf(parent->segment), 0, parent);
        q->beginRemoveRows(parentIndex, index, index);
 
        auto itr = item->parent->children.find(item->segment);
        item->parent->children.erase(itr);
 
        q->endRemoveRows();
 
        sensorInfos.remove(item);
    };
 
    remove(item, parent);
 
    while (!parent->children.size()) {
        item = parent;
        parent = parent->parent;
 
        if (!parent) {
            break;
        }
 
        remove(item, parent);
    }
}
 
QString SensorTreeModel::Private::sensorId(const QModelIndex &index)
{
    QStringList segments;
 
    SensorTreeItem *item = static_cast<SensorTreeItem *>(index.internalPointer());
 
    segments << item->segment;
 
    while (item->parent && item->parent != rootItem) {
        item = item->parent;
        segments.prepend(item->segment);
    }
 
    return segments.join(QLatin1Char('/'));
}
 
SensorTreeItem *KSysGuard::SensorTreeModel::Private::find(const QString &sensorId)
{
    auto item = rootItem;
    const auto segments = sensorId.split(QLatin1Char('/'));
    for (const QString &segment : segments) {
        if (auto itr = item->children.find(segment); itr != item->children.end() && itr->second) {
            item = itr->second.get();
        } else {
            return nullptr;
        }
    }
    return item;
}
 
SensorTreeModel::SensorTreeModel(QObject *parent)
    : QAbstractItemModel(parent)
    , d(new Private(this))
{
    connect(SensorDaemonInterface::instance(), &SensorDaemonInterface::sensorAdded, this, &SensorTreeModel::onSensorAdded);
    connect(SensorDaemonInterface::instance(), &SensorDaemonInterface::sensorRemoved, this, &SensorTreeModel::onSensorRemoved);
    connect(SensorDaemonInterface::instance(), &SensorDaemonInterface::metaDataChanged, this, &SensorTreeModel::onMetaDataChanged);
    init();
}
 
SensorTreeModel::~SensorTreeModel()
{
}
 
QHash<int, QByteArray> SensorTreeModel::roleNames() const
{
    QHash<int, QByteArray> roles = QAbstractItemModel::roleNames();
 
    QMetaEnum e = metaObject()->enumerator(metaObject()->indexOfEnumerator("AdditionalRoles"));
 
    for (int i = 0; i < e.keyCount(); ++i) {
        roles.insert(e.value(i), e.key(i));
    }
 
    return roles;
}
 
QVariant SensorTreeModel::headerData(int section, Qt::Orientation, int role) const
{
    if (role != Qt::DisplayRole) {
        return QVariant();
    }
 
    if (section == 0) {
        return i18n("Sensor Browser");
    }
 
    return QVariant();
}
 
QStringList SensorTreeModel::mimeTypes() const
{
    return QStringList() << QStringLiteral("application/x-ksysguard");
}
 
QVariant SensorTreeModel::data(const QModelIndex &index, int role) const
{
    if (!checkIndex(index, CheckIndexOption::IndexIsValid)) {
        return QVariant();
    }
 
    if (role == Qt::DisplayRole) {
        SensorTreeItem *item = static_cast<SensorTreeItem *>(index.internalPointer());
 
        if (d->sensorInfos.contains(item)) {
            auto info = d->sensorInfos.value(item);
            const QString &unit = Formatter::symbol(info.unit);
 
            if (!unit.isEmpty()) {
                return i18nc("Name (unit)", "%1 (%2)", info.name, unit);
            }
 
            return info.name;
        }
 
        return d->m_sensorGroup->segmentNameForRegEx(item->segment);
        // Only leaf nodes are valid sensors
    } else if (role == SensorId) {
        if (rowCount(index)) {
            return QString();
        } else {
            return d->sensorId(index);
        }
    }
 
    return QVariant();
}
 
QMimeData *SensorTreeModel::mimeData(const QModelIndexList &indexes) const
{
    QMimeData *mimeData = new QMimeData();
 
    if (indexes.count() != 1) {
        return mimeData;
    }
 
    const QModelIndex &index = indexes.at(0);
 
    if (!checkIndex(index, CheckIndexOption::IndexIsValid)) {
        return mimeData;
    }
 
    if (rowCount(index)) {
        return mimeData;
    }
 
    mimeData->setData(QStringLiteral("application/x-ksysguard"), d->sensorId(index).toUtf8());
 
    return mimeData;
}
 
Qt::ItemFlags SensorTreeModel::flags(const QModelIndex &index) const
{
    if (!checkIndex(index, CheckIndexOption::IndexIsValid)) {
        return Qt::NoItemFlags;
    }
 
    if (!rowCount(index)) {
        return Qt::ItemIsDragEnabled | Qt::ItemIsSelectable | Qt::ItemIsEnabled;
    }
 
    return Qt::ItemIsEnabled;
}
 
int SensorTreeModel::rowCount(const QModelIndex &parent) const
{
    if (parent.isValid()) {
        if (!checkIndex(parent, CheckIndexOption::IndexIsValid)) {
            return 0;
        }
 
        const SensorTreeItem *item = static_cast<SensorTreeItem *>(parent.internalPointer());
        return item->children.size();
    }
 
    return d->rootItem->children.size();
}
 
int SensorTreeModel::columnCount(const QModelIndex &parent) const
{
    Q_UNUSED(parent)
 
    return 1;
}
 
QModelIndex SensorTreeModel::index(int row, int column, const QModelIndex &parent) const
{
    SensorTreeItem *parentItem = d->rootItem;
 
    if (parent.isValid()) {
        if (parent.model() != this) {
            return QModelIndex();
        }
 
        parentItem = static_cast<SensorTreeItem *>(parent.internalPointer());
    }
 
    if (row < 0 || row >= int(parentItem->children.size())) {
        return QModelIndex();
    }
 
    if (column < 0) {
        return QModelIndex();
    }
 
    return createIndex(row, column, parentItem->itemAt(row));
}
 
QModelIndex SensorTreeModel::parent(const QModelIndex &index) const
{
    if (!checkIndex(index, CheckIndexOption::IndexIsValid | CheckIndexOption::DoNotUseParent)) {
        return QModelIndex();
    }
 
    if (index.column() > 0) {
        return QModelIndex();
    }
 
    const SensorTreeItem *item = static_cast<SensorTreeItem *>(index.internalPointer());
    SensorTreeItem *parentItem = item->parent;
 
    if (parentItem == d->rootItem) {
        return QModelIndex();
    }
 
    return createIndex(parentItem->parent->indexOf(parentItem->segment), 0, parentItem);
}
 
void SensorTreeModel::init()
{
    auto query = new SensorQuery{QString(), this};
    connect(query, &SensorQuery::finished, [query, this]() {
        query->deleteLater();
        const auto result = query->result();
        beginResetModel();
        for (auto pair : result) {
            d->addSensor(pair.first, pair.second);
        }
        endResetModel();
    });
    query->execute();
}
 
void KSysGuard::SensorTreeModel::onSensorAdded(const QString &sensor)
{
    SensorDaemonInterface::instance()->requestMetaData(sensor);
}
 
void KSysGuard::SensorTreeModel::onSensorRemoved(const QString &sensor)
{
    d->removeSensor(sensor);
}
 
void KSysGuard::SensorTreeModel::onMetaDataChanged(const QString &sensorId, const SensorInfo &info)
{
    auto item = d->find(sensorId);
    if (!item) {
        d->addSensor(sensorId, info);
    } else {
        d->sensorInfos[item] = info;
 
        auto parentItem = item->parent;
        if (!parentItem) {
            return;
        }
 
        auto parentIndex = QModelIndex{};
        if (parentItem != d->rootItem) {
            parentIndex = createIndex(parentItem->parent->indexOf(parentItem->segment), 0, parentItem);
        }
 
        auto itemIndex = index(parentItem->indexOf(item->segment), 0, parentIndex);
        Q_EMIT dataChanged(itemIndex, itemIndex);
    }
}