pythonplugin.cpp

Go to the documentation of this file.

/* ============================================================
* Falkon - Qt web browser
* Copyright (C) 2018 David Rosca <nowrep@gmail.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program.  If not, see <http://www.gnu.org/licenses/>.
* ============================================================ */
#include "pythonplugin.h"
 
#include "datapaths.h"
#include "desktopfile.h"
 
#include <QDir>
#include <QCoreApplication>
 
#include <PyFalkon/pyfalkon_python.h>
 
extern "C" PyObject *PyInit_PyFalkon();
 
enum State
{
    PythonUninitialized,
    PythonInitialized,
    PythonError
};
 
State state = PythonUninitialized;
 
PluginInterface *pluginInterface = nullptr;
QHash<PyObject*, PluginInterface*> pluginInstances;
 
static void cleanup()
{
    if (state > PythonUninitialized) {
        Py_Finalize();
        state = PythonUninitialized;
    }
}
 
static void set_path(const QStringList &scriptPaths)
{
    const QString originalPath = QString::fromLocal8Bit(qgetenv("PYTHONPATH"));
 
    QStringList paths = scriptPaths;
    paths.append(originalPath);
 
    qputenv("PYTHONPATH", paths.join(QL1C(':')).toLocal8Bit());
}
 
static State init()
{
    if (state > PythonUninitialized) {
        return state;
    }
 
    set_path(DataPaths::allPaths(DataPaths::Plugins));
 
    if (PyImport_AppendInittab("Falkon", PyInit_PyFalkon) != 0) {
        PyErr_Print();
        qWarning() << "Failed to initialize Falkon module!";
        return state = PythonError;
    }
 
    Py_Initialize();
    qAddPostRoutine(cleanup);
    return state = PythonInitialized;
}
 
void pyfalkon_register_plugin(PluginInterface *plugin)
{
    pluginInterface = plugin;
}
 
void *pyfalkon_load_plugin(const QString &name)
{
    QString fullPath;
    if (QFileInfo(name).isAbsolute()) {
        fullPath = name;
    } else {
        fullPath = DataPaths::locate(DataPaths::Plugins, name);
        if (fullPath.isEmpty()) {
            qWarning() << "Python plugin" << name << "not found";
            return nullptr;
        }
    }
 
    Plugins::Plugin *plugin = new Plugins::Plugin;
    plugin->type = Plugins::Plugin::PythonPlugin;
    plugin->pluginId = QSL("python:%1").arg(QFileInfo(name).fileName());
    plugin->pluginPath = fullPath;
    plugin->pluginSpec = Plugins::createSpec(DesktopFile(fullPath + QSL("/metadata.desktop")));
    return plugin;
}
 
void pyfalkon_init_plugin(Plugins::Plugin *plugin)
{
    if (init() != PythonInitialized) {
        return;
    }
 
    PyObject *module = static_cast<PyObject*>(plugin->data.value<void*>());
    if (module) {
        plugin->instance = pluginInstances.value(module);
        return;
    }
 
    const QString moduleName = plugin->pluginId.mid(7);
 
    pluginInterface = nullptr;
 
    module = PyImport_ImportModule(qPrintable(moduleName));
    if (!module) {
        PyErr_Print();
        qWarning() << "Failed to import module" << moduleName;
        return;
    }
    if (!pluginInterface) {
        qWarning() << "No plugin registered! Falkon.registerPlugin() must be called from script.";
        return;
    }
 
    pluginInstances[module] = pluginInterface;
    plugin->instance = pluginInterface;
    plugin->data = QVariant::fromValue(static_cast<void*>(module));
}