summaryrefslogtreecommitdiff
path: root/src/plugins/pglist.c
blob: 2edc3924143ab1e154ec792f05cc5552cb5b2fb9 (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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311

/* Chrysalide - Outil d'analyse de fichiers binaires
 * pglist.c - gestion de l'ensemble des greffons
 *
 * Copyright (C) 2009-2017 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 "pglist.h"


#include <assert.h>
#include <dirent.h>
#include <malloc.h>
#include <string.h>


#include <config.h>


#include "plugin-int.h"
#include "../common/extstr.h"


/* Représentation dédiée aux listes de greffons */
typedef struct _pg_array
{
    PluginAction action;                    /* Action commune ou PGA_ALL   */

    GPluginModule **plugins;                /* Liste de greffons           */
    size_t plugins_count;                   /* Taille de cette liste       */

} pg_array;

/* Propriétés de l'ensemble des greffons */
typedef struct _plugins_list
{
    GObject *ref;                           /* Référencement global        */

    pg_array *all;                          /* Liste de tous les greffons  */
    pg_array sorted[PGA_COUNT];             /* Tri par catégories          */

} plugins_list;


/* Liste de l'ensemble des greffons */
static plugins_list _list;


/* Filtre les répertoire et les modules de greffons pootentels. */
int filter_dirs_or_mods(const struct dirent *);

/* Part à la recherche de greffons sous forme de modules. */
void browse_directory_for_plugins(plugins_list *, const char *);



/******************************************************************************
*                                                                             *
*  Paramètres  : ref = espace de référencement global.                        *
*                                                                             *
*  Description : Procède au chargement des différents greffons trouvés.       *
*                                                                             *
*  Retour      : Toujours true (même s'il y a des erreurs de chargement).     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool init_all_plugins(GObject *ref)
{
    size_t i;                               /* Boucle de parcours          */

    _list.ref = ref;
    g_object_ref(ref);

    for (i = 0; i < PGA_COUNT; i++)
        _list.sorted[i].action = PGA_EMPTY;

    _list.sorted[0].action = PGA_ALL;
    _list.all = &_list.sorted[0];

    browse_directory_for_plugins(&_list, PACKAGE_SOURCE_DIR "/plugins");

    return true;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Procède au déchargement des différents greffons présents.    *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void exit_all_plugins(void)
{
    size_t i;                               /* Boucle de parcours          */

    for (i = 0; i < _list.all->plugins_count; i++)
        g_object_unref(_list.all->plugins[i]);

    for (i = 0; i < PGA_COUNT; i++)
        free(_list.sorted[i].plugins);

    g_object_unref(_list.ref);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : entry = entrée de répertoire à analyser.                     *
*                                                                             *
*  Description : Filtre les répertoire et les modules de greffons pootentels. *
*                                                                             *
*  Retour      : Valeur non nulle pour garder l'élément.                      *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

int filter_dirs_or_mods(const struct dirent *entry)
{
    int result;                             /* Conclusion à remonter       */

    if (entry->d_type == DT_DIR)
        result = strcmp(entry->d_name, ".") * strcmp(entry->d_name, "..");

    else
        result = (strrcmp(entry->d_name, "." G_MODULE_SUFFIX) == 0 ? 1 : 0);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : list = liste de greffons à compléter si possible.            *
*                dir  = répertoire à parcourir en quête de greffons (sans /). *
*                                                                             *
*  Description : Part à la recherche de greffons sous forme de modules.       *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void browse_directory_for_plugins(plugins_list *list, const char *dir)
{
    struct dirent **namelist;               /* Eléments trouvés            */
    int ret;                                /* Bilan du parcours           */
    char *filename;                         /* Elément à ausculter         */
    GPluginModule *plugin;                  /* Greffon à intégrer ou pas   */

    ret = scandir(dir, &namelist, filter_dirs_or_mods, alphasort);
    if (ret < 0)
    {
        perror("scandir");
        return;
    }

    while (ret--)
    {
        filename = (char *)calloc(strlen(dir) + 1 + strlen(namelist[ret]->d_name) + 1, sizeof(char));

        strcpy(filename, dir);
        strcat(filename, G_DIR_SEPARATOR_S);
        strcat(filename, namelist[ret]->d_name);

        if (namelist[ret]->d_type == DT_DIR)
            browse_directory_for_plugins(list, filename);

        else
        {
            plugin = g_plugin_module_new(filename, _list.ref);

            if (plugin != NULL)
                add_plugin_to_main_list(plugin);

        }

        free(filename);
        free(namelist[ret]);

    }

    free(namelist);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : action = fonctionnalité recherchée.                          *
*                count  = nombre de greffons trouvés. [OUT]                   *
*                                                                             *
*  Description : Founit les greffons offrant le service demandé.              *
*                                                                             *
*  Retour      : Liste de greffons correspondants issue d'un tri interne.     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

const GPluginModule **get_all_plugins_for_action(PluginAction action, size_t *count)
{
    const GPluginModule **result;           /* Greffon à retourner         */
    size_t i;                               /* Boucle de parcours          */

    result = NULL;
    *count = 0;

    for (i = 0; i < PGA_COUNT; i++)
        if (_list.sorted[i].action == action)
        {
            result = (const GPluginModule **)_list.sorted[i].plugins;
            *count = _list.sorted[i].plugins_count;
            break;
        }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : plugin = greffon à ajouter aux autres disponibles.           *
*                                                                             *
*  Description : Ajoute un greffon à la liste principale de greffons.         *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void add_plugin_to_main_list(GPluginModule *plugin)
{
    const plugin_interface *interface;      /* Informations à consulter    */
    size_t i;                               /* Boucle de parcours #1       */
    size_t j;                               /* Boucle de parcours #2       */

    interface = g_plugin_module_get_interface(plugin);

    void add_plugin_into_array(pg_array *array, GPluginModule *pg)
    {
        array->plugins = (GPluginModule **)realloc(array->plugins,
                                                   ++array->plugins_count * sizeof(GPluginModule));

        array->plugins[array->plugins_count - 1] = pg;

    }

    /* FIXME : lock */

    add_plugin_into_array(_list.all, plugin);

    for (i = 0; i < interface->actions_count; i++)
    {
        if (interface->actions[i] == PGA_ALL) continue;

        for (j = 1; j < PGA_COUNT; j++)
        {
            if (_list.sorted[j].action == interface->actions[i])
            {
                add_plugin_into_array(&_list.sorted[j], plugin);
                break;
            }

            else if (_list.sorted[j].action == PGA_EMPTY)
            {
                add_plugin_into_array(&_list.sorted[j], plugin);
                _list.sorted[j].action = interface->actions[i];
                break;
            }

        }

        assert(j < PGA_COUNT);

    }

    /* FIXME : lock */

}