summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/analysis/scan/core.c
blob: 16df9a99510d88715edc33e1bfca683055812df5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179

/* Chrysalide - Outil d'analyse de fichiers binaires
 * core.c - équivalent Python du fichier "analysis/scan/core.c"
 *
 * Copyright (C) 2023 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 "core.h"


#include <pygobject.h>


#include <analysis/scan/core.h>


#include "patterns/modifier.h"
#include "../../access.h"
#include "../../helpers.h"



/* Inscrit un modificateur dans la liste des disponibles. */
static PyObject *py_scan_register_token_modifier(PyObject *, PyObject *);

/* Fournit le modificateur correspondant à un nom. */
static PyObject *py_scan_find_token_modifiers_for_name(PyObject *, PyObject *);



/******************************************************************************
*                                                                             *
*  Paramètres  : self = objet Python concerné par l'appel.                    *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Inscrit un modificateur dans la liste des disponibles.       *
*                                                                             *
*  Retour      : Bilan des enregistrements effectués : True si nouveauté.     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_scan_register_token_modifier(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Bilan à retourner           */
    PyObject *instance;                     /* Instance Python fournie     */
    GScanTokenModifier *modifier;           /* Version native              */
    int ret;                                /* Bilan de lecture des args.  */
    bool status;                            /* Bilan d'un enregistrement   */

#define SCAN_REGISTER_TOKEN_MODIFIER_METHOD PYTHON_METHOD_DEF           \
(                                                                       \
    register_token_modifier, "inst, /",                                 \
    METH_VARARGS, py_scan,                                              \
    "Register a token modifier for byte patterns to scan.\n"            \
    "\n"                                                                \
    "This instance will be used as singleton and has to be a"           \
    " subclass of pychrysalide.analysis.scan.patterns.TokenModifier."   \
)

    ret = PyArg_ParseTuple(args, "O!", get_python_scan_token_modifier_type(), &instance);
    if (!ret) return NULL;

    modifier = G_SCAN_TOKEN_MODIFIER(pygobject_get(instance));

    status = register_scan_token_modifier(modifier);

    result = status ? Py_True : Py_False;
    Py_INCREF(result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = objet Python concerné par l'appel.                    *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Fournit le modificateur correspondant à un nom.              *
*                                                                             *
*  Retour      : Instance du modificateur identifié ou None.                  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_scan_find_token_modifiers_for_name(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Bilan à retourner           */
    sized_string_t name;                    /* Nom d'appel à rechercher    */
    Py_ssize_t len;                         /* Taille de ce nom            */
    int ret;                                /* Bilan de lecture des args.  */
    GScanTokenModifier *modifier;           /* Instance mise en place      */

#define SCAN_FIND_TOKEN_MODIFIERS_FOR_NAME_METHOD PYTHON_METHOD_DEF \
(                                                                   \
    find_token_modifiers_for_name, "name, /",                       \
    METH_VARARGS, py_scan,                                          \
    "Provide the registered instance of a pattern modifier linked"  \
    " to a given *name* provided as a key string.\n"                \
    "\n"                                                            \
    "The returned instance is an object inherited from"             \
    " pychrysalide.analysis.scan.patterns.TokenModifier or *None*"  \
    " if no instance was found for the provided name."              \
)

    ret = PyArg_ParseTuple(args, "s#", &name.static_data, &len);
    if (!ret) return NULL;

    name.len = len;

    modifier = find_scan_token_modifiers_for_name(&name);

    if (modifier != NULL)
    {
        result = pygobject_new(G_OBJECT(modifier));
        g_object_unref(G_OBJECT(modifier));
    }
    else
    {
        result = Py_None;
        Py_INCREF(result);
    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Définit une extension du module 'scan' à compléter.          *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool populate_scan_module_with_core_methods(void)
{
    bool result;                            /* Bilan à retourner           */
    PyObject *module;                       /* Module à recompléter        */

    static PyMethodDef py_core_methods[] = {
        SCAN_REGISTER_TOKEN_MODIFIER_METHOD,
        SCAN_FIND_TOKEN_MODIFIERS_FOR_NAME_METHOD,
        { NULL }
    };

    module = get_access_to_python_module("pychrysalide.analysis.scan");

    result = register_python_module_methods(module, py_core_methods);

    return result;

}