summaryrefslogtreecommitdiff
path: root/src/analysis/db/item.c
blob: f01a953e875feb39c07478df1070ef25e438d084 (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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729

/* Chrysalide - Outil d'analyse de fichiers binaires
 * item.c - gestion d'éléments destinés à une collection générique
 *
 * Copyright (C) 2014-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 Chrysalide.  If not, see <http://www.gnu.org/licenses/>.
 */


#include "item.h"


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


#include "item-int.h"
#include "../../core/params.h"



/* Initialise la classe des bases d'éléments pour collection. */
static void g_db_item_class_init(GDbItemClass *);

/* Initialise une base d'élément pour collection générique. */
static void g_db_item_init(GDbItem *);

/* Supprime toutes les références externes. */
static void g_db_item_dispose(GDbItem *);

/* Procède à la libération totale de la mémoire. */
static void g_db_item_finalize(GDbItem *);

/* Importe la définition d'une base d'éléments pour collection. */
static bool _g_db_item_unpack(GDbItem *, packed_buffer *);

/* Exporte la définition d'une base d'éléments pour collection. */
static bool _g_db_item_pack(const GDbItem *, packed_buffer *);



/* --------------------- MANIPULATIONS AVEC UNE BASE DE DONNEES --------------------- */


/* Constitue les champs destinés à une insertion / modification. */
static bool _g_db_item_prepare_db_statement(const GDbItem *, bound_value **, size_t *);

/* Charge les valeurs utiles pour un élément de collection. */
static bool _g_db_item_load(GDbItem *, const bound_value *, size_t);



/* Indique le type défini pour une base d'élément de collection générique. */
G_DEFINE_TYPE(GDbItem, g_db_item, G_TYPE_OBJECT);


/******************************************************************************
*                                                                             *
*  Paramètres  : klass = classe à initialiser.                                *
*                                                                             *
*  Description : Initialise la classe des bases d'éléments pour collection.   *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_db_item_class_init(GDbItemClass *klass)
{
    GObjectClass *object;                   /* Autre version de la classe  */

    object = G_OBJECT_CLASS(klass);

    object->dispose = (GObjectFinalizeFunc/* ! */)g_db_item_dispose;
    object->finalize = (GObjectFinalizeFunc)g_db_item_finalize;

    klass->cmp = (cmp_db_item_fc)g_db_item_cmp;

    klass->unpack = (unpack_db_item_fc)_g_db_item_unpack;
    klass->pack = (pack_db_item_fc)_g_db_item_pack;

    klass->prepare_stmt = (prepare_db_statement)_g_db_item_prepare_db_statement;
    klass->load = (load_db_item_fc)_g_db_item_load;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : item = instance à initialiser.                               *
*                                                                             *
*  Description : Initialise une base d'élément pour collection générique.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_db_item_init(GDbItem *item)
{
    const char *author;                     /* Identification à diffuser   */
#ifndef NDEBUG
    bool status;                            /* Bilan d'une obtention       */
#endif

#ifndef NDEBUG
    status = g_generic_config_get_value(get_main_configuration(), MPK_AUTHOR_NAME, &author);
    assert(status);
#else
    g_generic_config_get_value(get_main_configuration(), MPK_AUTHOR_NAME, &author);
#endif

    set_static_rle_string(&item->author, author);

    item->is_volatile = false;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : item = instance d'objet GLib à traiter.                      *
*                                                                             *
*  Description : Supprime toutes les références externes.                     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_db_item_dispose(GDbItem *item)
{
    G_OBJECT_CLASS(g_db_item_parent_class)->dispose(G_OBJECT(item));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : item = instance d'objet GLib à traiter.                      *
*                                                                             *
*  Description : Procède à la libération totale de la mémoire.                *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_db_item_finalize(GDbItem *item)
{
    exit_rle_string(&item->author);
    exit_rle_string(&item->tool);

    if (item->label != NULL)
        free(item->label);

    G_OBJECT_CLASS(g_db_item_parent_class)->finalize(G_OBJECT(item));

}



/******************************************************************************
*                                                                             *
*  Paramètres  : item = élément de collection à consulter.                    *
*                                                                             *
*  Description : Indique la fonctionnalité représentée par l'élément.         *
*                                                                             *
*  Retour      : Identifiant valide pour le protocole.                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

DBFeatures g_db_item_get_feature(const GDbItem *item)
{
    return G_DB_ITEM_GET_CLASS(item)->feature;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : item = élément de collection à traiter.                      *
*                                                                             *
*  Description : Indique à l'élément qu'il se trouve du côté serveur.         *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_db_item_set_server_side(GDbItem *item)
{
    init_timestamp(&item->created);
    item->timestamp = item->created;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : a    = premier élément à analyser.                           *
*                b    = second élément à analyser.                            *
*                with = précise les horodatages à prendre en compte.          *
*                                                                             *
*  Description : Effectue la comparaison entre deux éléments de collection.   *
*                                                                             *
*  Retour      : Bilan de la comparaison : -1, 0 ou 1.                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

gint g_db_item_cmp(GDbItem *a, GDbItem *b, bool with)
{
    gint result;                            /* Bilan à retourner           */

    if (with)
        result = cmp_timestamp(&a->timestamp, &b->timestamp);
    else
        result = 0;

    if (result == 0)
        result = cmp_timestamp(&a->created, &b->created);

    if (result == 0)
        result = strcmp(g_db_item_get_label(a), g_db_item_get_label(b));

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : a = premier élément à analyser.                              *
*                b = second élément à analyser.                               *
*                                                                             *
*  Description : Effectue la comparaison entre deux éléments de collection.   *
*                                                                             *
*  Retour      : Bilan de la comparaison : -1, 0 ou 1.                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

gint g_db_item_compare_with_timestamp(GDbItem *a, GDbItem *b)
{
    return G_DB_ITEM_GET_CLASS(a)->cmp(a, b, true);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : a = premier élément à analyser.                              *
*                b = second élément à analyser.                               *
*                                                                             *
*  Description : Effectue la comparaison entre deux éléments de collection.   *
*                                                                             *
*  Retour      : Bilan de la comparaison : -1, 0 ou 1.                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

gint g_db_item_compare_without_timestamp(GDbItem *a, GDbItem *b)
{
    return G_DB_ITEM_GET_CLASS(a)->cmp(a, b, false);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : item = base d'éléments à charger. [OUT]                      *
*                pbuf = paquet de données où venir puiser les infos.          *
*                                                                             *
*  Description : Importe la définition d'une base d'éléments pour collection. *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool _g_db_item_unpack(GDbItem *item, packed_buffer *pbuf)
{
    bool result;                            /* Bilan à retourner           */

    result = unpack_timestamp(&item->created, pbuf);

    if (result)
        result = unpack_timestamp(&item->timestamp, pbuf);

    if (result)
        result = unpack_rle_string(&item->author, pbuf);

    if (result)
        result = unpack_rle_string(&item->tool, pbuf);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : item = base d'éléments à charger. [OUT]                      *
*                pbuf = paquet de données où venir puiser les infos.          *
*                                                                             *
*  Description : Importe la définition d'une base d'éléments pour collection. *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_db_item_unpack(GDbItem *item, packed_buffer *pbuf)
{
    bool result;                            /* Bilan à retourner           */

    result = G_DB_ITEM_GET_CLASS(item)->unpack(item, pbuf);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : item = informations à sauvegarer.                            *
*                pbuf = paquet de données où venir inscrire les infos.        *
*                                                                             *
*  Description : Exporte la définition d'une base d'éléments pour collection. *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool _g_db_item_pack(const GDbItem *item, packed_buffer *pbuf)
{
    bool result;                            /* Bilan à retourner           */

    result = pack_timestamp(&item->created, pbuf);

    if (result)
        result = pack_timestamp(&item->timestamp, pbuf);

    if (result)
        result = pack_rle_string(&item->author, pbuf);

    if (result)
        result = pack_rle_string(&item->tool, pbuf);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : item = informations à sauvegarer.                            *
*                pbuf = paquet de données où venir inscrire les infos.        *
*                                                                             *
*  Description : Exporte la définition d'une base d'éléments pour collection. *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_db_item_pack(const GDbItem *item, packed_buffer *pbuf)
{
    return G_DB_ITEM_GET_CLASS(item)->pack(item, pbuf);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : item   = élément de collection à manipuler.                  *
*                binary = binaire chargé en mémoire à modifier.               *
*                                                                             *
*  Description : Applique un élément de collection sur un binaire.            *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_db_item_apply(GDbItem *item, GLoadedBinary *binary)
{
    bool result;                            /* Bilan à faire remonter      */

    assert(g_db_item_is_active(item));

    result = G_DB_ITEM_GET_CLASS(item)->apply(item, binary);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : item   = élément de collection à manipuler.                  *
*                binary = binaire chargé en mémoire à modifier.               *
*                                                                             *
*  Description : Annule une bascule d'affichage d'opérande sur un binaire.    *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_db_item_cancel(GDbItem *item, GLoadedBinary *binary)
{
    bool result;                            /* Bilan à faire remonter      */

    assert(!g_db_item_is_active(item));

    result = G_DB_ITEM_GET_CLASS(item)->cancel(item, binary);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : item = élément de collection à consulter.                    *
*                                                                             *
*  Description : Décrit l'élément de collection en place.                     *
*                                                                             *
*  Retour      : Chaîne de caractère correspondante.                          *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

const char *g_db_item_get_label(GDbItem *item)
{
    if (item->label == NULL)
    {
        G_DB_ITEM_GET_CLASS(item)->build_label(item);
        assert(item->label != NULL);
    }

    return item->label;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : item = élément de collection à consulter.                    *
*                                                                             *
*  Description : Fournit l'horodatage associé à l'élément de collection.      *
*                                                                             *
*  Retour      : Date d'activité de l'élément.                                *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

timestamp_t g_db_item_get_timestamp(const GDbItem *item)
{
    return item->timestamp;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : item   = élément de collection à mettre à jour.              *
*                binary = binaire chargé en mémoire à modifier.               *
*                first  = horodatage du premier élément désactivé ou NULL.    *
*                                                                             *
*  Description : Active ou désactive un élément de collection en place.       *
*                                                                             *
*  Retour      : Bilan de la mise à jour de l'élément.                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_db_item_set_activity(GDbItem *item, GLoadedBinary *binary, timestamp_t *first)
{
    bool result;                            /* Bilan à faire remonter      */
    bool active;                            /* Etat avant changement       */

    active = g_db_item_is_active(item);

    /* Archivage de l'état */

    if (first == NULL)
    {
        assert(!active);
        item->timestamp = item->created;
    }
    else
    {
        assert(active);
        item->timestamp = --(*first);
    }

    /* Application de l'état */

    if (binary != NULL)
    {
        if (active)
            result = g_db_item_cancel(item, binary);
        else
            result = g_db_item_apply(item, binary);
    }
    else
        result = true;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : item = élément de collection à consulter.                    *
*                                                                             *
*  Description : Indique si l'élément est activé ou désactivé.                *
*                                                                             *
*  Retour      : Etat de l'activité de l'élément.                             *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_db_item_is_active(const GDbItem *item)
{
    return (cmp_timestamp(&item->created, &item->timestamp) == 0);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : item        = base d'éléments à modifier.                    *
*                is_volatile = état du besoin en sauvegarde.                  *
*                                                                             *
*  Description : Définit si l'élément contient des données à oublier ou non.  *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_db_item_set_volatile(GDbItem *item, bool is_volatile)
{
    item->is_volatile = is_volatile;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : item = base d'éléments à consulter.                          *
*                                                                             *
*  Description : Indique si l'élément contient des données à oublier ou non.  *
*                                                                             *
*  Retour      : Etat du besoin en sauvegarde.                                *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_db_item_is_volatile(const GDbItem *item)
{
    return item->is_volatile;

}



/* ---------------------------------------------------------------------------------- */
/*                       MANIPULATIONS AVEC UNE BASE DE DONNEES                       */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : item   = base d'éléments sur laquelle s'appuyer.             *
*                values = couples de champs et de valeurs à lier. [OUT]       *
*                count  = nombre de ces couples. [OUT]                        *
*                                                                             *
*  Description : Constitue les champs destinés à une insertion / modification.*
*                                                                             *
*  Retour      : Bilan de l'opération : succès ou non.                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool _g_db_item_prepare_db_statement(const GDbItem *item, bound_value **values, size_t *count)
{
    bool result;                            /* Bilan à retourner           */

    result = true;

    result &= prepare_db_statement_for_timestamp(&item->created, "created", values, count);

    result &= prepare_db_statement_for_timestamp(&item->timestamp, "timestamp", values, count);

    result &= prepare_db_statement_for_rle_string(&item->author, "author", values, count);

    result &= prepare_db_statement_for_rle_string(&item->tool, "tool", values, count);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : item   = base d'éléments sur laquelle s'appuyer.             *
*                values = couples de champs et de valeurs à lier. [OUT]       *
*                count  = nombre de ces couples. [OUT]                        *
*                                                                             *
*  Description : Constitue les champs destinés à une insertion / modification.*
*                                                                             *
*  Retour      : Bilan de l'opération : succès ou non.                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_db_item_prepare_db_statement(const GDbItem *item, bound_value **values, size_t *count)
{
    *values = NULL;
    *count = 0;

    return G_DB_ITEM_GET_CLASS(item)->prepare_stmt(item, values, count);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : item   = base d'éléments à charger depuis les réponses.      *
*                values = tableau d'éléments à consulter.                     *
*                count  = nombre de descriptions renseignées.                 *
*                                                                             *
*  Description : Charge les valeurs utiles pour un élément de collection.     *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool _g_db_item_load(GDbItem *item, const bound_value *values, size_t count)
{
    bool result;                            /* Bilan global à retourner    */

    result = true;

    result &= load_timestamp(&item->created, "created", values, count);

    result &= load_timestamp(&item->timestamp, "timestamp", values, count);

    result &= load_rle_string(&item->author, "author", values, count);

    result &= load_rle_string(&item->tool, "tool", values, count);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : item   = base d'éléments à charger depuis les réponses.      *
*                values = tableau d'éléments à consulter.                     *
*                count  = nombre de descriptions renseignées.                 *
*                                                                             *
*  Description : Charge les valeurs utiles pour un élément de collection.     *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_db_item_load(GDbItem *item, const bound_value *values, size_t count)
{
    bool result;                            /* Bilan à retourner           */

    result = G_DB_ITEM_GET_CLASS(item)->load(item, values, count);

    return result;

}