kprotocolinfofactory.cpp

/*
    This file is part of the KDE libraries
    SPDX-FileCopyrightText: 1999 Torben Weis <weis@kde.org>
    SPDX-FileCopyrightText: 2003 Waldo Bastian <bastian@kde.org>
    SPDX-FileCopyrightText: 2012 David Faure <faure@kde.org>
 
    SPDX-License-Identifier: LGPL-2.0-only
*/
 
#include "kprotocolinfo_p.h"
#include "kprotocolinfofactory_p.h"
 
#include <KPluginMetaData>
 
#include <QCoreApplication>
#include <QDirIterator>
#include <QStandardPaths>
 
#include "kiocoredebug.h"
 
Q_GLOBAL_STATIC(KProtocolInfoFactory, kProtocolInfoFactoryInstance)
 
KProtocolInfoFactory *KProtocolInfoFactory::self()
{
    return kProtocolInfoFactoryInstance();
}
 
KProtocolInfoFactory::KProtocolInfoFactory()
    : m_cacheDirty(true)
{
}
 
KProtocolInfoFactory::~KProtocolInfoFactory()
{
    QMutexLocker locker(&m_mutex);
    qDeleteAll(m_cache);
    m_cache.clear();
}
 
QStringList KProtocolInfoFactory::protocols()
{
    QMutexLocker locker(&m_mutex);
 
    // fill cache, if not already done and use it
    fillCache();
    return m_cache.keys();
}
 
QList<KProtocolInfoPrivate *> KProtocolInfoFactory::allProtocols()
{
    QMutexLocker locker(&m_mutex);
 
    // fill cache, if not already done and use it
    fillCache();
    return m_cache.values();
}
 
KProtocolInfoPrivate *KProtocolInfoFactory::findProtocol(const QString &protocol, bool updateCacheIfNotfound)
{
    Q_ASSERT(!protocol.isEmpty());
    Q_ASSERT(!protocol.contains(QLatin1Char(':')));
 
    QMutexLocker locker(&m_mutex);
 
    const bool filled = fillCache();
 
    KProtocolInfoPrivate *info = m_cache.value(protocol);
    if (!info && !filled && updateCacheIfNotfound) {
        // Unknown protocol! Maybe it just got installed and our cache is out of date?
        qCDebug(KIO_CORE) << "Refilling KProtocolInfoFactory cache in the hope to find" << protocol;
        m_cacheDirty = true;
        fillCache();
        info = m_cache.value(protocol);
    }
    return info;
}
 
bool KProtocolInfoFactory::fillCache()
{
    // mutex MUST be locked from the outside!
    Q_ASSERT(!m_mutex.tryLock());
 
    // no work if filled
    if (!m_cacheDirty) {
        return false;
    }
 
    qDeleteAll(m_cache);
    m_cache.clear();
 
    // first: search for meta data protocol info, that might be bundled with applications
    // we search in all library paths inside kf5/kio
    const QList<KPluginMetaData> plugins = KPluginMetaData::findPlugins(QStringLiteral("kf6/kio"));
    for (const KPluginMetaData &md : plugins) {
        // get worker name & protocols it supports, if any
        const QString workerPath = md.fileName();
        const QJsonObject protocols(md.rawData().value(QStringLiteral("KDE-KIO-Protocols")).toObject());
        qCDebug(KIO_CORE) << workerPath << "supports protocols" << protocols.keys();
 
        // add all protocols, does nothing if object invalid
        for (auto it = protocols.begin(); it != protocols.end(); ++it) {
            // skip empty objects
            const QJsonObject protocol(it.value().toObject());
            if (protocol.isEmpty()) {
                continue;
            }
 
            // add to cache, skip double entries
            if (!m_cache.contains(it.key())) {
                m_cache.insert(it.key(), new KProtocolInfoPrivate(it.key(), workerPath, protocol));
            }
        }
    }
 
    // all done, don't do it again
    m_cacheDirty = false;
    return true;
}