/* Chrysalide - Outil d'analyse de fichiers binaires
* core-ui.c - plugin permettant des extensions UI en Python
*
* Copyright (C) 2025 Cyrille Bagard
*
* This file is part of Chrysalide.
*
* Chrysalide 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.
*
* Chrysalide 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 Chrysalide. If not, see .
*/
#include "core-ui.h"
#include
#include
#include
#include
#include "bindings.h"
#include "core-ui-int.h"
#include "arch/module-ui.h"
#include "glibext/module-ui.h"
/* Note la nature du chargement */
static bool _standalone = true;
/* ---------------------- COMPOSITION DE NOUVEAU GREFFON NATIF ---------------------- */
/* Initialise la classe des greffons de support Python. */
static void g_pychrysalide_plugin_ui_class_init(GPyChrysalidePluginUIClass *);
/* Procède à l'initialisation de l'interface de gestion. */
static void g_pychrysalide_plugin_ui_plugin_manager_interface_init(GPluginManagerInterface *);
/* Initialise une instance de greffon de support Python. */
static void g_pychrysalide_plugin_ui_init(GPyChrysalidePluginUI *);
/* Supprime toutes les références externes. */
static void g_pychrysalide_plugin_ui_dispose(GObject *);
/* Procède à la libération totale de la mémoire. */
static void g_pychrysalide_plugin_ui_finalize(GObject *);
/* --------------------- IMPLEMENTATION DES FONCTIONS DE CLASSE --------------------- */
/* Prend acte de l'activation du greffon. */
static bool g_pychrysalide_plugin_ui_enable(GPluginModule *);
/* -------------------- INTERVENTION DANS LA GESTION DE GREFFONS -------------------- */
/* Prend acte du chargement de l'ensemble des greffons natifs. */
static void g_pychrysalide_plugin_ui_handle_native_plugins_loaded_event(GPluginManager *);
/* --------------------------- POINT D'ENTREE POUR PYTHON --------------------------- */
/* Inscrit les défintions des objets UI Python de Chrysalide. */
static bool populate_python_modules_ui(void);
/* ---------------------------------------------------------------------------------- */
/* COMPOSITION DE NOUVEAU GREFFON NATIF */
/* ---------------------------------------------------------------------------------- */
/* Indique le type défini pour un greffon de liaison Python */
G_DEFINE_TYPE_WITH_CODE(GPyChrysalidePluginUI, g_pychrysalide_plugin_ui, G_TYPE_PYCHRYSALIDE_PLUGIN,
G_IMPLEMENT_INTERFACE(G_TYPE_PLUGIN_MANAGER, g_pychrysalide_plugin_ui_plugin_manager_interface_init));
NATIVE_PLUGIN_ENTRYPOINT(g_pychrysalide_plugin_ui_new);
/******************************************************************************
* *
* Paramètres : class = classe à initialiser. *
* *
* Description : Initialise la classe des greffons de support Python. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void g_pychrysalide_plugin_ui_class_init(GPyChrysalidePluginUIClass *class)
{
GObjectClass *object; /* Autre version de la classe */
GPluginModuleClass *plugin; /* Version parente de la classe*/
object = G_OBJECT_CLASS(class);
object->dispose = g_pychrysalide_plugin_ui_dispose;
object->finalize = g_pychrysalide_plugin_ui_finalize;
plugin = G_PLUGIN_MODULE_CLASS(class);
plugin->enable = g_pychrysalide_plugin_ui_enable;
}
/******************************************************************************
* *
* Paramètres : iface = interface GLib à initialiser. *
* *
* Description : Procède à l'initialisation de l'interface de gestion. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void g_pychrysalide_plugin_ui_plugin_manager_interface_init(GPluginManagerInterface *iface)
{
iface->handle_native = g_pychrysalide_plugin_ui_handle_native_plugins_loaded_event;
}
/******************************************************************************
* *
* Paramètres : plugin = instance à initialiser. *
* *
* Description : Initialise une instance de greffon de support Python. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void g_pychrysalide_plugin_ui_init(GPyChrysalidePluginUI *plugin)
{
}
/******************************************************************************
* *
* Paramètres : object = instance d'objet GLib à traiter. *
* *
* Description : Supprime toutes les références externes. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void g_pychrysalide_plugin_ui_dispose(GObject *object)
{
G_OBJECT_CLASS(g_pychrysalide_plugin_ui_parent_class)->dispose(object);
}
/******************************************************************************
* *
* Paramètres : object = instance d'objet GLib à traiter. *
* *
* Description : Procède à la libération totale de la mémoire. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void g_pychrysalide_plugin_ui_finalize(GObject *object)
{
G_OBJECT_CLASS(g_pychrysalide_plugin_ui_parent_class)->finalize(object);
}
/******************************************************************************
* *
* Paramètres : module = extension vue du système. *
* *
* Description : Crée un module pour un greffon de support Python. *
* *
* Retour : Adresse de la structure mise en place. *
* *
* Remarques : Le transfert de propriétée du module est total. *
* *
******************************************************************************/
GPluginModule *g_pychrysalide_plugin_ui_new(GModule *module)
{
GPyChrysalidePluginUI *result; /* Structure à retourner */
result = g_object_new(G_TYPE_PYCHRYSALIDE_PLUGIN_UI, NULL);
if (!g_pychrysalide_plugin_ui_create(result, module))
g_clear_object(&result);
return G_PLUGIN_MODULE(result);
}
/******************************************************************************
* *
* Paramètres : plugin = instance à initialiser pleinement. *
* module = extension vue du système. *
* *
* Description : Met en place un module pour un greffon de support Python. *
* *
* Retour : Bilan de l'opération. *
* *
* Remarques : Le transfert de propriétée du module est total. *
* *
******************************************************************************/
bool g_pychrysalide_plugin_ui_create(GPyChrysalidePluginUI *plugin, GModule *module)
{
bool result; /* Bilan à retourner */
result = g_pychrysalide_plugin_create(G_PYCHRYSALIDE_PLUGIN(plugin), module);
return result;
}
/* ---------------------------------------------------------------------------------- */
/* IMPLEMENTATION DES FONCTIONS DE CLASSE */
/* ---------------------------------------------------------------------------------- */
/******************************************************************************
* *
* Paramètres : plugin = greffon à manipuler. *
* *
* Description : Prend acte de l'activation du greffon. *
* *
* Retour : Bilan de l'opération. *
* *
* Remarques : - *
* *
******************************************************************************/
static bool g_pychrysalide_plugin_ui_enable(GPluginModule *plugin)
{
bool result; /* Bilan à retourner */
GPyChrysalidePlugin *pychr_plugin; /* Version spécialisée */
PyGILState_STATE gstate; /* Sauvegarde d'environnement */
int ret; /* Bilan de préparatifs */
_standalone = false;
pychr_plugin = G_PYCHRYSALIDE_PLUGIN(plugin);
/* Chargement du module pour Python */
ret = PyImport_AppendInittab("pychrysalide", &PyInit_pychrysalideui);
if (ret == -1)
{
g_plugin_module_log_simple_message(plugin, LMT_ERROR,
_("Can not extend the existing table of Python built-in modules."));
result = false;
goto done;
}
Py_Initialize();
gstate = PyGILState_Ensure();
pychr_plugin->py_module = PyImport_ImportModule("pychrysalide");
/**
* Pour mémoire, une situation concrête conduisant à un échec :
* le paquet python3-gi-dbg n'est pas installé alors que le
* programme est compilé en mode débogage.
*
* Dans ce cas, pygobject_init(-1, -1, -1) échoue, et Py_Initialize()
* le laisse rien filtrer...
*
* En mode autonome, le shell Python remonte bien l'erreur par contre.
*/
// TODO : check (2025)
result = (pychr_plugin->py_module != NULL);
PyGILState_Release(gstate);
done:
return result;
}
/* ---------------------------------------------------------------------------------- */
/* INTERVENTION DANS LA GESTION DE GREFFONS */
/* ---------------------------------------------------------------------------------- */
/******************************************************************************
* *
* Paramètres : manager = interface à manipuler. *
* *
* Description : Accompagne la fin du chargement des modules natifs. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void g_pychrysalide_plugin_ui_handle_native_plugins_loaded_event(GPluginManager *manager)
{
GPluginModule *plugin; /* Version de base du greffon */
#ifdef DISCARD_LOCAL
char *edir; /* Répertoire de base effectif */
DIR *dir; /* Répertoire à parcourir */
#endif
GPluginManagerInterface *iface; /* Interface utilisée */
GPluginManagerInterface *parent_iface; /* Interface parente */
plugin = G_PLUGIN_MODULE(manager);
/* Définition des zones d'influence */
#ifndef DISCARD_LOCAL
extend_python_path(plugin, PACKAGE_SOURCE_DIR G_DIR_SEPARATOR_S "plugins" G_DIR_SEPARATOR_S "pythonui");
#else
edir = get_effective_directory(PLUGINS_DATA_DIR G_DIR_SEPARATOR_S "pythonui");
dir = opendir(edir);
if (dir != NULL)
{
closedir(dir);
extend_python_path(plugin, edir);
}
free(edir);
#endif
/* Chargements des extensions Python */
iface = G_PLUGIN_MANAGER_GET_IFACE(manager);
parent_iface = g_type_interface_peek_parent(iface);
parent_iface->handle_native(manager);
}
/* ---------------------------------------------------------------------------------- */
/* POINT D'ENTREE POUR PYTHON */
/* ---------------------------------------------------------------------------------- */
/******************************************************************************
* *
* Paramètres : - *
* *
* Description : Inscrit les défintions des objets UI Python de Chrysalide. *
* *
* Retour : Bilan de l'opération. *
* *
* Remarques : - *
* *
******************************************************************************/
static bool populate_python_modules_ui(void)
{
bool result; /* Bilan à retourner */
result = true;
if (result) result = populate_arch_module_ui();
if (result) result = populate_glibext_module_ui();
return result;
}
/******************************************************************************
* *
* Paramètres : - *
* *
* Description : Point d'entrée pour l'initialisation de Python. *
* *
* Retour : ? *
* *
* Remarques : - *
* *
******************************************************************************/
PyMODINIT_FUNC PyInit_pychrysalideui(void)
{
PyObject *result; /* Module Python à retourner */
pyinit_details_t details; /* Détails de chargement */
details.standalone = _standalone;
details.populate_extra = populate_python_modules_ui;
details.create_self = g_pychrysalide_plugin_ui_new;
result = init_python_pychrysalide_module(&details);
return result;
}