Create a placeholder for Python registered items in order to keep scans working.

6 files changed, 260 insertions, 1 deletions

diff --git a/plugins/pychrysalide/analysis/scan/Makefile.am b/plugins/pychrysalide/analysis/scan/Makefile.am
index 80cfa8c..b07154a 100644
--- a/plugins/pychrysalide/analysis/scan/Makefile.am
+++ b/plugins/pychrysalide/analysis/scan/Makefile.am
@@ -6,6 +6,7 @@ libpychrysaanalysisscan_la_SOURCES =		\
 	context.h context.c						\
 	expr.h expr.c							\
 	func.h func.c							\
+	item.h item.c							\
 	module.h module.c						\
 	options.h options.c						\
 	scanner.h scanner.c						\
diff --git a/plugins/pychrysalide/analysis/scan/func.c b/plugins/pychrysalide/analysis/scan/func.c
index 61731ec..5dd846f 100644
--- a/plugins/pychrysalide/analysis/scan/func.c
+++ b/plugins/pychrysalide/analysis/scan/func.c
@@ -36,6 +36,9 @@
 #include <plugins/pychrysalide/analysis/content.h>
 
 
+#include "item.h"
+
+
 
 CREATE_DYN_ABSTRACT_CONSTRUCTOR(scan_function, G_TYPE_SCAN_FUNCTION, NULL);
 
@@ -152,6 +155,9 @@ bool ensure_python_scan_function_is_registered(void)
 
         dict = PyModule_GetDict(module);
 
+        if (!ensure_python_registered_item_is_registered())
+            return false;
+
         if (!register_class_for_pygobject(dict, G_TYPE_SCAN_FUNCTION, type, &PyGObject_Type))
             return false;
 
diff --git a/plugins/pychrysalide/analysis/scan/item.c b/plugins/pychrysalide/analysis/scan/item.c
new file mode 100644
index 0000000..9e9d4d3
--- /dev/null
+++ b/plugins/pychrysalide/analysis/scan/item.c
@@ -0,0 +1,205 @@
+
+/* Chrysalide - Outil d'analyse de fichiers binaires
+ * item.c - équivalent Python du fichier "analysis/scan/item.c"
+ *
+ * Copyright (C) 2022 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 this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+
+#include "item.h"
+
+
+#include <pygobject.h>
+
+
+#include <i18n.h>
+#include <analysis/scan/item-int.h>
+#include <plugins/pychrysalide/access.h>
+#include <plugins/pychrysalide/helpers.h>
+
+
+
+CREATE_DYN_CONSTRUCTOR(registered_item, G_TYPE_REGISTERED_ITEM);
+
+/* Initialise une instance sur la base du dérivé de GObject. */
+static int py_registered_item_init(PyObject *, PyObject *, PyObject *);
+
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self = objet à initialiser (théoriquement).                  *
+*                args = arguments fournis à l'appel.                          *
+*                kwds = arguments de type key=val fournis.                    *
+*                                                                             *
+*  Description : Initialise une instance sur la base du dérivé de GObject.    *
+*                                                                             *
+*  Retour      : 0.                                                           *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static int py_registered_item_init(PyObject *self, PyObject *args, PyObject *kwds)
+{
+    int ret;                                /* Bilan de lecture des args.  */
+
+#define REGISTERED_ITEM_DOC                                            \
+    "The *RegisteredItem* class defines the basics for evaluation"  \
+    " items involved into content scanning.\n"                      \
+    "\n"                                                            \
+    "Instances can be created using the following constructor:\n"   \
+    "\n"                                                            \
+    "    RegisteredItem()"
+
+    /* Initialisation d'un objet GLib */
+
+    ret = forward_pygobjet_init(self);
+    if (ret == -1) return -1;
+
+    return 0;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : -                                                            *
+*                                                                             *
+*  Description : Fournit un accès à une définition de type à diffuser.        *
+*                                                                             *
+*  Retour      : Définition d'objet pour Python.                              *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+PyTypeObject *get_python_registered_item_type(void)
+{
+    static PyMethodDef py_registered_item_methods[] = {
+        { NULL }
+    };
+
+    static PyGetSetDef py_registered_item_getseters[] = {
+        { NULL }
+    };
+
+    static PyTypeObject py_registered_item_type = {
+
+        PyVarObject_HEAD_INIT(NULL, 0)
+
+        .tp_name        = "pychrysalide.analysis.scan.RegisteredItem",
+        .tp_basicsize   = sizeof(PyGObject),
+
+        .tp_flags       = Py_TPFLAGS_DEFAULT,
+
+        .tp_doc         = REGISTERED_ITEM_DOC,
+
+        .tp_methods     = py_registered_item_methods,
+        .tp_getset      = py_registered_item_getseters,
+
+        .tp_init        = py_registered_item_init,
+        .tp_new         = py_registered_item_new,
+
+    };
+
+    return &py_registered_item_type;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : -                                                            *
+*                                                                             *
+*  Description : Prend en charge l'objet 'pychrysalide...scan.RegisteredItem'.*
+*                                                                             *
+*  Retour      : Bilan de l'opération.                                        *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+bool ensure_python_registered_item_is_registered(void)
+{
+    PyTypeObject *type;                     /* Type Python 'RegisteredItem' */
+    PyObject *module;                       /* Module à recompléter        */
+    PyObject *dict;                         /* Dictionnaire du module      */
+
+    type = get_python_registered_item_type();
+
+    if (!PyType_HasFeature(type, Py_TPFLAGS_READY))
+    {
+        module = get_access_to_python_module("pychrysalide.analysis.scan");
+
+        dict = PyModule_GetDict(module);
+
+        if (!register_class_for_pygobject(dict, G_TYPE_REGISTERED_ITEM, type, &PyGObject_Type))
+            return false;
+
+    }
+
+    return true;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : arg = argument quelconque à tenter de convertir.             *
+*                dst = destination des valeurs récupérées en cas de succès.   *
+*                                                                             *
+*  Description : Tente de convertir en expression d'évaluation généraliste.   *
+*                                                                             *
+*  Retour      : Bilan de l'opération, voire indications supplémentaires.     *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+int convert_to_registered_item(PyObject *arg, void *dst)
+{
+    int result;                             /* Bilan à retourner           */
+
+    result = PyObject_IsInstance(arg, (PyObject *)get_python_registered_item_type());
+
+    switch (result)
+    {
+        case -1:
+            /* L'exception est déjà fixée par Python */
+            result = 0;
+            break;
+
+        case 0:
+            PyErr_SetString(PyExc_TypeError, "unable to convert the provided argument to generic scan expression");
+            break;
+
+        case 1:
+            *((GRegisteredItem **)dst) = G_REGISTERED_ITEM(pygobject_get(arg));
+            break;
+
+        default:
+            assert(false);
+            break;
+
+    }
+
+    return result;
+
+}
diff --git a/plugins/pychrysalide/analysis/scan/item.h b/plugins/pychrysalide/analysis/scan/item.h
new file mode 100644
index 0000000..b3f1661
--- /dev/null
+++ b/plugins/pychrysalide/analysis/scan/item.h
@@ -0,0 +1,45 @@
+
+/* Chrysalide - Outil d'analyse de fichiers binaires
+ * item.h - prototypes pour l'équivalent Python du fichier "analysis/scan/item.h"
+ *
+ * Copyright (C) 2022 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 this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+
+#ifndef _PLUGINS_PYCHRYSALIDE_ANALYSIS_SCAN_ITEM_H
+#define _PLUGINS_PYCHRYSALIDE_ANALYSIS_SCAN_ITEM_H
+
+
+#include <Python.h>
+#include <stdbool.h>
+
+
+
+/* Fournit un accès à une définition de type à diffuser. */
+PyTypeObject *get_python_registered_item_type(void);
+
+/* Prend en charge l'objet 'pychrysalide.analysis.scan.RegisteredItem'. */
+bool ensure_python_registered_item_is_registered(void);
+
+/* Tente de convertir en expression d'évaluation généraliste. */
+int convert_to_registered_item(PyObject *, void *);
+
+
+
+#endif  /* _PLUGINS_PYCHRYSALIDE_ANALYSIS_SCAN_ITEM_H */
diff --git a/plugins/pychrysalide/analysis/scan/module.c b/plugins/pychrysalide/analysis/scan/module.c
index 48b7100..3af4af2 100644
--- a/plugins/pychrysalide/analysis/scan/module.c
+++ b/plugins/pychrysalide/analysis/scan/module.c
@@ -31,6 +31,7 @@
 #include "context.h"
 #include "expr.h"
 #include "func.h"
+#include "item.h"
 #include "options.h"
 #include "scanner.h"
 #include "space.h"
@@ -107,6 +108,7 @@ bool populate_analysis_scan_module(void)
     if (result) result = ensure_python_scan_context_is_registered();
     if (result) result = ensure_python_scan_expression_is_registered();
     if (result) result = ensure_python_scan_function_is_registered();
+    if (result) result = ensure_python_registered_item_is_registered();
     if (result) result = ensure_python_scan_options_is_registered();
     if (result) result = ensure_python_scan_namespace_is_registered();
 
diff --git a/plugins/pychrysalide/analysis/scan/options.c b/plugins/pychrysalide/analysis/scan/options.c
index c3b29e9..ddced33 100644
--- a/plugins/pychrysalide/analysis/scan/options.c
+++ b/plugins/pychrysalide/analysis/scan/options.c
@@ -74,7 +74,7 @@ static int py_scan_options_init(PyObject *self, PyObject *args, PyObject *kwds)
 
 #define SCAN_OPTIONS_DOC                                            \
     "The *ScanOptions* class stores all parameters used to tune"    \
-    " a scanning process..\n"                                       \
+    " a scanning process.\n"                                        \
     "\n"                                                            \
     "Instances can be created using the following constructor:\n"   \
     "\n"                                                            \