KoJsonTrader Class Reference

#include <KoJsonTrader.h>

Classes
struct	Plugin
struct	PluginCacheEntry

Public Member Functions
	KoJsonTrader ()
QList< Plugin >	query (const QString &servicetype, const QString &mimetype)
	~KoJsonTrader ()

Static Public Member Functions
static KoJsonTrader *	instance ()

Private Member Functions
void	initializePluginLoaderCache ()

Private Attributes
QMutex	m_mutex
QList< PluginCacheEntry >	m_pluginLoaderCache
QString	m_pluginPath

Detailed Description

Support class to fetch a list of relevant plugins

Static singleton

Definition at line 25 of file KoJsonTrader.h.

Constructor & Destructor Documentation

KoJsonTrader()

KoJsonTrader::KoJsonTrader

(

)

Definition at line 33 of file KoJsonTrader.cpp.

{
    // Allow a command line variable KRITA_PLUGIN_PATH to override the automatic search
    m_pluginPath = QProcessEnvironment::systemEnvironment().value("KRITA_PLUGIN_PATH");
 
    if (m_pluginPath.isEmpty() ||
        !(QFileInfo(m_pluginPath).exists() && QFileInfo(m_pluginPath).isDir())) {
 
        QList<QDir> searchDirs;
 
        QDir appDir(qApp->applicationDirPath());
        appDir.cdUp();
#ifdef Q_OS_MACOS
        // Help Krita run without deployment
        QDir d(appDir);
        d.cd("../../../");
        searchDirs << d;
#endif
 
#ifdef Q_OS_ANDROID
        appDir.cdUp();
#endif
        searchDirs << appDir;
 
        Q_FOREACH (const QDir& dir, searchDirs) {
            const QStringList nameFilters = {
#ifdef Q_OS_MACOS
                "*PlugIns*",
#endif
                "lib*",
            };
            Q_FOREACH (const QFileInfo &info, dir.entryInfoList(nameFilters, QDir::Dirs | QDir::NoDotAndDotDot)) {
#ifdef Q_OS_MACOS
                if (info.fileName().contains("PlugIns")) {
                    m_pluginPath = info.absoluteFilePath();
                    break;
                }
                else if (info.fileName().contains("lib")) {
#else
                if (info.fileName().contains("lib")) {
#endif
                    QDir libDir(info.absoluteFilePath());
 
#ifdef Q_OS_ANDROID
#if defined(Q_PROCESSOR_ARM_64)
                    libDir.cd("arm64-v8a");
#elif defined(Q_PROCESSOR_ARM)
                    libDir.cd("armeabi-v7a");
#elif defined(Q_PROCESSOR_X86_64)
                    libDir.cd("x86_64");
#elif defined(Q_PROCESSOR_x86)
                    libDir.cd("x86");
#endif
                    m_pluginPath = libDir.absolutePath();
                    break;
#else
                    // on many systems this will be the actual lib dir (and krita subdir contains plugins)
                    if (libDir.cd("kritaplugins")) {
                        m_pluginPath = libDir.absolutePath();
                        break;
                    }
 
                    // on debian at least the actual libdir is a subdir named like "lib/x86_64-linux-gnu"
                    // so search there for the Krita subdir which will contain our plugins
                    // FIXME: what are the chances of there being more than one Krita install with different arch and compiler ABI?
                    Q_FOREACH (const QFileInfo &subInfo, libDir.entryInfoList(QDir::Dirs | QDir::NoDotAndDotDot)) {
                        QDir subDir(subInfo.absoluteFilePath());
                        if (subDir.cd("kritaplugins")) {
                            m_pluginPath = subDir.absolutePath();
                            break; // will only break inner loop so we need the extra check below
                        }
                    }
 
                    if (!m_pluginPath.isEmpty()) {
                        break;
                    }
#endif
                }
            }
 
            if (!m_pluginPath.isEmpty()) {
                break;
            }
        }
        dbgPlugins << "KoJsonTrader will load its plugins from" << m_pluginPath;
    }
 
    initializePluginLoaderCache();
}

References dbgPlugins, initializePluginLoaderCache(), and m_pluginPath.

~KoJsonTrader()

KoJsonTrader::~KoJsonTrader

(

)

Definition at line 123 of file KoJsonTrader.cpp.

{
}

Member Function Documentation

initializePluginLoaderCache()

void KoJsonTrader::initializePluginLoaderCache ( )

private

Definition at line 135 of file KoJsonTrader.cpp.

{
    QMutexLocker l(&m_mutex);
 
    KIS_SAFE_ASSERT_RECOVER_RETURN(m_pluginLoaderCache.isEmpty());
 
    QList<QPluginLoader *>list;
    QDirIterator dirIter(m_pluginPath, QDirIterator::Subdirectories);
    while (dirIter.hasNext()) {
        dirIter.next();
#ifdef Q_OS_ANDROID
        // files starting with lib_krita are plugins, it is needed because of the loading rules in NDK
        if (dirIter.fileInfo().isFile() && dirIter.fileName().startsWith("lib_krita")) {
#elif defined(_MSC_VER)
        if (dirIter.fileInfo().isFile() && dirIter.fileName().startsWith("krita") && !dirIter.fileName().endsWith(".pdb") && !dirIter.fileName().endsWith(".lib")) {
#else
        if (dirIter.fileInfo().isFile() && dirIter.fileName().startsWith("krita") && !dirIter.fileName().endsWith(".debug")) {
#endif
 
            dbgPlugins << dirIter.fileName();
            std::unique_ptr<QPluginLoader> loader(new QPluginLoader(dirIter.filePath()));
            QJsonObject json = loader->metaData().value("MetaData").toObject();
 
            dbgPlugins << json << json.value("X-KDE-ServiceTypes");
 
            if (json.isEmpty()) {
                qWarning() << dirIter.filePath() << "has no json!";
                continue;
            } else {
                QJsonArray  serviceTypes = json.value("X-KDE-ServiceTypes").toArray();
                if (serviceTypes.isEmpty()) {
                    qWarning() << dirIter.fileName() << "has no X-KDE-ServiceTypes";
                    continue;
                }
 
                QStringList mimeTypes = json.value("X-KDE-ExtraNativeMimeTypes").toString().split(',');
                mimeTypes += json.value("MimeType").toString().split(';');
                mimeTypes += json.value("X-KDE-NativeMimeType").toString();
 
                PluginCacheEntry cacheEntry;
                cacheEntry.filePath = dirIter.filePath();
                cacheEntry.serviceTypes = serviceTypes;
                cacheEntry.mimeTypes = mimeTypes;
                cacheEntry.loader = toQShared(loader.release());
                m_pluginLoaderCache << cacheEntry;
            }
        }
    }
}

References dbgPlugins, KoJsonTrader::PluginCacheEntry::filePath, KIS_SAFE_ASSERT_RECOVER_RETURN, KoJsonTrader::PluginCacheEntry::loader, m_mutex, m_pluginLoaderCache, m_pluginPath, KoJsonTrader::PluginCacheEntry::mimeTypes, KoJsonTrader::PluginCacheEntry::serviceTypes, and toQShared().

instance()

KoJsonTrader * KoJsonTrader::instance ( )

static

Returns the instance of this class.

Definition at line 130 of file KoJsonTrader.cpp.

{
    return s_instance;
}

query()

QList< KoJsonTrader::Plugin > KoJsonTrader::query	(	const QString &	servicetype,
		const QString &	mimetype )

The main function in the KoJsonTrader class. It tries to automatically locate the base path containing Krita plugins. It attempts to do so in the current application directory qApp->applicationDirPath().

The environment variable KRITA_PLUGIN_PATH overrides the automatic search path when the algorithm is insufficient. Try setting this if the "LittleCMS color management plugin is not installed" error appears.

A better algorithm or another solution could be a welcome alternative. One thing that might help would be to build all Krita plugins in a single plugins folder, so that an installation step is unnecessary to put them together in a single folder here. Another solution might be to construct several QPluginLoaders.

Parameters

servicetype	A service type like 'KMyApp/Plugin' or 'KFilePlugin'.
mimetype	A MimeType to constrain the search.

Returns

A list of QPluginLoader that satisfy the query

Definition at line 185 of file KoJsonTrader.cpp.

{
    QMutexLocker l(&m_mutex);
 
    QList<Plugin> list;
    Q_FOREACH(const PluginCacheEntry &plugin, m_pluginLoaderCache) {
        if (!plugin.serviceTypes.contains(QJsonValue(servicetype))) {
            continue;
        }
 
        if (!mimetype.isEmpty() && !plugin.mimeTypes.contains(mimetype)) {
            continue;
        }
 
        list << Plugin(plugin.loader, &m_mutex);
    }
 
    return list;
}

References KoJsonTrader::PluginCacheEntry::loader, m_mutex, m_pluginLoaderCache, KoJsonTrader::PluginCacheEntry::mimeTypes, and KoJsonTrader::PluginCacheEntry::serviceTypes.

Member Data Documentation

m_mutex

QMutex KoJsonTrader::m_mutex

mutableprivate

Definition at line 81 of file KoJsonTrader.h.

m_pluginLoaderCache

QList<PluginCacheEntry> KoJsonTrader::m_pluginLoaderCache

private

Definition at line 85 of file KoJsonTrader.h.

m_pluginPath

QString KoJsonTrader::m_pluginPath

private

Definition at line 80 of file KoJsonTrader.h.

---

The documentation for this class was generated from the following files:

• libs/koplugin/KoJsonTrader.h
• libs/koplugin/KoJsonTrader.cpp