path: root/src/analysis/db/collection.c

/* Chrysalide - Outil d'analyse de fichiers binaires
 * collection.c - gestion d'éléments ajoutés par collection
 *
 * Copyright (C) 2014 Cyrille Bagard
 *
 *  This file is part of Chrysalide.
 *
 *  OpenIDA 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.
 *
 *  OpenIDA 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 Foobar.  If not, see <http://www.gnu.org/licenses/>.
 */


#include "collection.h"


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


#include "collection-int.h"
#include "../../common/extstr.h"
#include "../../common/io.h"
#include "../../glibext/chrysamarshal.h"







/* Initialise la classe des collections génériques d'éléments. */
static void g_db_collection_class_init(GDbCollectionClass *);

/* Initialise une collection générique d'éléments. */
static void g_db_collection_init(GDbCollection *);

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

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



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


/* Décrit les colonnes utiles à un chargement de données. */
static bool g_db_collection_setup_load(GDbCollection *, bound_value **, size_t *);

/* Enregistre un élément de collection dans une base de données. */
static bool g_db_collection_store_item(const GDbCollection *, const GDbItem *, sqlite3 *);





/* Indique le type défini pour une collection générique d'éléments. */
G_DEFINE_TYPE(GDbCollection, g_db_collection, G_TYPE_OBJECT);


/******************************************************************************
*                                                                             *
*  Paramètres  : klass = classe à initialiser.                                *
*                                                                             *
*  Description : Initialise la classe des collections génériques d'éléments.  *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

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

    object = G_OBJECT_CLASS(klass);

    object->dispose = (GObjectFinalizeFunc/* ! */)g_db_collection_dispose;
    object->finalize = (GObjectFinalizeFunc)g_db_collection_finalize;

    g_signal_new("content-changed",
                 G_TYPE_DB_COLLECTION,
                 G_SIGNAL_RUN_LAST,
                 G_STRUCT_OFFSET(GDbCollectionClass, content_changed),
                 NULL, NULL,
                 g_cclosure_user_marshal_VOID__ENUM_OBJECT,
                 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_OBJECT);

}


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

static void g_db_collection_init(GDbCollection *collec)
{
    g_rw_lock_init(&collec->params_access);

}


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

static void g_db_collection_dispose(GDbCollection *collec)
{
    G_OBJECT_CLASS(g_db_collection_parent_class)->dispose(G_OBJECT(collec));

}


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

static void g_db_collection_finalize(GDbCollection *collec)
{
    g_rw_lock_clear(&collec->params_access);

    G_OBJECT_CLASS(g_db_collection_parent_class)->finalize(G_OBJECT(collec));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : id   = identifiant réseau des éléments à traiter.            *
*                type = type GLib des éléments à placer dans la collection.   *
*                name = indique le nom désignant la table associée.           *
*                                                                             *
*  Description : Prépare la mise en place d'une nouvelle collection.          *
*                                                                             *
*  Retour      : Adresse de l'instance ou NULL en cas d'échec.                *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GDbCollection *g_db_collection_new(uint32_t id, GType type, const char *name)
{
    GDbCollection *result;                  /* Adresse à retourner         */

    result = g_object_new(G_TYPE_DB_COLLECTION, NULL);

    result->featuring = id;
    result->type = type;
    result->name = name;

    return result;

}






/******************************************************************************
*                                                                             *
*  Paramètres  : collec = collection générique d'éléments à consulter.        *
*                                                                             *
*  Description : Décrit le type des éléments rassemblées dans une collection. *
*                                                                             *
*  Retour      : Identifiant interne des éléments collectionés.               *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

uint32_t g_db_collection_get_feature(const GDbCollection *collec)
{
    return collec->featuring;

}














/******************************************************************************
*                                                                             *
*  Paramètres  : collec = ensemble d'éléments à considérer.                   *
*                fd     = flux ouvert en lecture pour la réception de données.*
*                db     = base de données à mettre à jour.                    *
*                                                                             *
*  Description : Réceptionne et traite une requête réseau pour collection.    *
*                                                                             *
*  Retour      : Bilan de l'exécution de l'opération.                         *
*                                                                             *
*  Remarques   : Cette fonction est uniquement destinée aux appels depuis     *
*                la fonction g_cdb_archive_process() ; une partie des         *
*                informations ont déjà été tirées des échanges protocolaires. *
*                                                                             *
******************************************************************************/

bool g_db_collection_recv(GDbCollection *collec, int fd, sqlite3 *db)
{
    bool result;                            /* Bilan à faire remonter      */
    uint32_t val32;                         /* Valeur sur 32 bits          */
    bool status;                            /* Bilan de lecture initiale   */
    DBAction action;                        /* Commande de la requête      */
    GDbItem *item;                          /* Définition d'élément visé   */

    status = safe_recv(fd, &val32, sizeof(uint32_t), 0);
    if (!status) return false;

    action = be32toh(val32);
    if (action < 0 || action >= DBA_COUNT) return false;

    item = g_object_new(collec->type, NULL);

    status = g_db_item_recv(item, fd, 0);
    if (!status) return false;

    result = false;

    switch (action)
    {
        case DBA_ADD_ITEM:
            result = g_db_collection_add_item(collec, item);
            if (result && db != NULL)
                result = g_db_collection_store_item(collec, item, db);
            break;

        case DBA_REM_ITEM:
            break;

        case DBA_MOD_ITEM:
            result = g_db_collection_modify_item(collec, item);
            break;

        default:
            /* Pour GCC : DBA_COUNT */
            break;

    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : collec = ensemble d'éléments à considérer.                   *
*                fd     = flux ouvert en écriture pour l'émission de données. *
*                action = avenir de l'élément fourni.                         *
*                item   = élément de collection à sérialiser.                 *
*                                                                             *
*  Description : Envoie pour traitement une requête réseau pour collection.   *
*                                                                             *
*  Retour      : Bilan de l'exécution de l'opération.                         *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_db_collection_send(GDbCollection *collec, int fd, DBAction action, GDbItem *item)
{
    bool status;                            /* Bilan de lecture initiale   */

    status = safe_send(fd, (uint32_t []) { htobe32(DBC_COLLECTION) }, sizeof(uint32_t), MSG_MORE);
    if (!status) return false;

    status = safe_send(fd, (uint32_t []) { htobe32(collec->featuring) }, sizeof(uint32_t), MSG_MORE);
    if (!status) return false;

    status = safe_send(fd, (uint32_t []) { htobe32(action) }, sizeof(uint32_t), MSG_MORE);
    if (!status) return false;

    status = g_db_item_send(item, fd, 0);
    if (!status) return false;

    return true;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : collec = ensemble d'éléments à considérer.                   *
*                fd     = flux ouvert en écriture pour l'émission de données. *
*                                                                             *
*  Description : Envoie pour mise à jour tous les éléments courants.          *
*                                                                             *
*  Retour      : Bilan de l'exécution de l'opération.                         *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_db_collection_send_all_updates(GDbCollection *collec, int fd)
{
    bool result;                            /* Bilan à renvoyer            */
    GList *iter;                            /* Boucle de parcours          */

    result = true;

    for (iter = g_list_first(collec->items);
         iter != NULL && result;
         iter = g_list_next(iter))
    {
        result = g_db_collection_send(collec, fd, DBA_ADD_ITEM, G_DB_ITEM(iter->data));

    }

    return result;

}







/******************************************************************************
*                                                                             *
*  Paramètres  : collec = collection à mettre à jour.                         *
*                write  = précise le type d'accès prévu (lecture/écriture).   *
*                lock   = indique le sens du verrouillage à mener.            *
*                                                                             *
*  Description : Met à disposition un encadrement des accès aux éléments.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_db_collection_lock_unlock(GDbCollection *collec, bool write, bool lock)
{
    if (write)
    {
        if (lock) g_rw_lock_writer_lock(&collec->params_access);
        else g_rw_lock_writer_unlock(&collec->params_access);
    }
    else
    {
        if (lock) g_rw_lock_reader_lock(&collec->params_access);
        else g_rw_lock_reader_unlock(&collec->params_access);
    }

}


/******************************************************************************
*                                                                             *
*  Paramètres  : collec = ensemble d'éléments à consulter.                    *
*                                                                             *
*  Description : Renvoie la liste des éléments rassemblés.                    *
*                                                                             *
*  Retour      : Liste d'éléments à parcourir.                                *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GList *g_db_collection_list_items(const GDbCollection *collec)
{
    /**
     * Un verrou doit être posé !
     * Il n'y a pas d'assert() possible pour le vérifier...
     */

    return collec->items;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : collec = ensemble d'éléments à consulter.                    *
*                ...    = clef identifiant de manière unique un élément.      *
*                                                                             *
*  Description : Détermine si un élément est déjà présent ou non.             *
*                                                                             *
*  Retour      : Elément trouvé ou NULL si aucun.                             *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GDbItem *g_db_collection_has_key(GDbCollection *collec, ...)
{
    GDbItem *result;                        /* Bilan à retourner           */
    va_list ap;                             /* Liste d'arguments en plus   */

    va_start(ap, collec);

    result = G_DB_COLLECTION_GET_CLASS(collec)->has_key(collec, &ap);

    va_end(ap);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : collec = ensemble d'éléments à consulter.                    *
*                item   = élément complet dont un double est à rechercher.    *
*                                                                             *
*  Description : Détermine si un élément est déjà présent ou non.             *
*                                                                             *
*  Retour      : true si un élément similaire est présent dans la collection. *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_db_collection_has_item(GDbCollection *collec, GDbItem *item)
{
    bool result;                            /* Bilan à retourner           */
    GList *found;                           /* Test de présence existante  */

    /**
     * Un verrou doit être posé !
     * Il n'y a pas d'assert() possible pour le vérifier...
     */

    printf(" --- has\n");

    found = g_list_find_custom(collec->items, item, (GCompareFunc)g_db_item_compare);

    printf(" --- has: %p\n", found);

    result = (found != NULL);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : collec = ensemble d'éléments à considérer.                   *
*                item   = élément de collection à manipuler.                  *
*                lock   = indique si le verrou d'écriture doit être posé.     *
*                                                                             *
*  Description : Procède à l'ajout d'un nouvel élément dans la collection.    *
*                                                                             *
*  Retour      : Bilan de l'exécution de l'opération.                         *
*                                                                             *
*  Remarques   : L'appelant reste le propriétaire de l'object transféré.      *
*                                                                             *
******************************************************************************/

bool _g_db_collection_add_item(GDbCollection *collec, GDbItem *item, bool lock)
{
    bool result;                            /* Bilan à faire remonter      */
    GList *found;                           /* Test de présence existante  */

    if (lock)
        g_db_collection_wlock(collec);

    found = g_list_find_custom(collec->items, item, (GCompareFunc)g_db_item_compare);

    if (found != NULL)
        result = g_db_collection_modify_item(collec, item);

    else
    {
        g_object_ref(G_OBJECT(item));
        collec->items = g_list_append(collec->items, item);

        g_object_ref(G_OBJECT(item));
        collec->sorted = g_list_insert_sorted(collec->sorted, item, (GCompareFunc)g_db_item_compare);

        g_signal_emit_by_name(collec, "content-changed", DBA_ADD_ITEM, item);


        printf(" ==== CONTENT CHANGED (-> %u) !!!\n", g_list_length(collec->items));


        result = true;

    }

    if (lock)
        g_db_collection_wunlock(collec);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : collec = ensemble d'éléments à considérer.                   *
*                item   = élément de collection à copier.                     *
*                lock   = indique si le verrou d'écriture doit être posé.     *
*                                                                             *
*  Description : Procède à la modification d'un élément dans la collection.   *
*                                                                             *
*  Retour      : Bilan de l'exécution de l'opération.                         *
*                                                                             *
*  Remarques   : L'appelant reste le propriétaire de l'object transféré.      *
*                                                                             *
******************************************************************************/

bool _g_db_collection_modify_item(GDbCollection *collec, GDbItem *item, bool lock)
{
    bool result;                            /* Bilan à faire remonter      */
    GList *found;                           /* Test de présence existante  */

    found = g_list_find_custom(collec->items, item, (GCompareFunc)g_db_item_compare);



    result = true;





    return result;

}



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


/******************************************************************************
*                                                                             *
*  Paramètres  : collec = ensemble d'éléments à consulter.                    *
*                values = tableau d'éléments à compléter. [OUT]               *
*                count  = nombre de descriptions renseignées. [OUT]           *
*                                                                             *
*  Description : Décrit les colonnes utiles à un chargement de données.       *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool g_db_collection_setup_load(GDbCollection *collec, bound_value **values, size_t *count)
{
    *values = NULL;
    *count = 0;
    
    return G_DB_COLLECTION_GET_CLASS(collec)->setup_load(collec, values, count);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : collec = ensemble d'éléments à peupler.                      *
*                db     = base de données repondant aux requêtes.             *
*                                                                             *
*  Description : Charge un ensemble d'éléments à partir d'une base de données.*
*                                                                             *
*  Retour      : Bilan de l'exécution de l'opération.                         *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_db_collection_load_all_items(GDbCollection *collec, sqlite3 *db)
{
    bool result;                            /* Conclusion à faire remonter */
    bound_value *values;                    /* Champs de table à inclure   */
    size_t count;                           /* Nombre de ces champs        */
    char *sql;                              /* Requête SQL à construire    */
    size_t i;                               /* Boucle de parcours          */
    sqlite3_stmt *stmt;                     /* Déclaration mise en place   */
    int ret;                                /* Bilan d'un appel à SQLite   */

    if (!g_db_collection_setup_load(collec, &values, &count))
        return false;

    result = false;

    /* Préparation de la requête */

    sql = strdup("SELECT ");

    for (i = 0; i < count; i++)
    {
        if (i > 0) sql = stradd(sql, ", ");

        sql = stradd(sql, values[i].name);

    }

    sql = stradd(sql, " FROM ");
    sql = stradd(sql, collec->name);
    sql = stradd(sql, ";");

	ret = sqlite3_prepare_v2(db, sql, -1, &stmt, NULL);
	if (ret != SQLITE_OK)
    {
		fprintf(stderr, "Can't prepare SELECT statment '%s' (ret=%d): %s\n", sql, ret, sqlite3_errmsg(db));
        goto gdclai_exit;
	}

    /* Chargement des valeurs existantes */

    result = true;

    for (ret = sqlite3_step(stmt); ret == SQLITE_ROW && result; ret = sqlite3_step(stmt))
    {
        /* Conversion des valeurs */

        for (i = 0; i < count; i++)
        {
            values[i].type = sqlite3_column_type(stmt, i);

            switch (values[i].type)
            {
                case SQLITE_INTEGER:
                    values[i].type = SQLITE_INT64;
                    values[i].integer64 = sqlite3_column_int64(stmt, i);
                    break;

                case SQLITE_FLOAT:
                    assert(0); /* TODO */
                    break;

                case SQLITE_TEXT:
                    values[i].cstring = (const char *)sqlite3_column_text(stmt, i);
                    break;

                case SQLITE_BLOB:
                    assert(0); /* TODO */
                    break;

                case SQLITE_NULL:
                    break;

                default:
                    assert(0);
                    break;

            }

        }

        /* Chargement d'un nouvel élément */

        result = G_DB_COLLECTION_GET_CLASS(collec)->load_item(collec, values, count);

    }

    /* Sortie propre */

    sqlite3_finalize(stmt);

 gdclai_exit:

    free(sql);

    printf("LOAD ? %d\n", result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : collec = ensemble d'éléments à considérer.                   *
*                item   = élément de collection à enregistrer.                *
*                db     = base de données à mettre à jour.                    *
*                                                                             *
*  Description : Enregistre un élément de collection dans une base de données.*
*                                                                             *
*  Retour      : Bilan de l'exécution de l'opération.                         *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool g_db_collection_store_item(const GDbCollection *collec, const GDbItem *item, sqlite3 *db)
{
    bool result;                            /* Conclusion à faire remonter */
    bound_value *values;                    /* Champs de table à inclure   */
    size_t count;                           /* Nombre de ces champs        */
    char *sql;                              /* Requête SQL à construire    */
    size_t i;                               /* Boucle de parcours          */
    sqlite3_stmt *stmt;                     /* Déclaration mise en place   */
    int ret;                                /* Bilan d'un appel à SQLite   */
    int index;                              /* Indice de valeur attachée   */

    if (!g_db_item_prepare_db_statement(item, true, &values, &count))
        return false;

    result = false;

    /* Préparation de la requête */

    sql = strdup("INSERT INTO ");
    sql = stradd(sql, collec->name);
    sql = stradd(sql, " (");

    for (i = 0; i < count; i++)
    {
        if (i > 0) sql = stradd(sql, ", ");

        sql = stradd(sql, values[i].name);

    }

    sql = stradd(sql, ") VALUES (");

    for (i = 0; i < count; i++)
    {
        if (i > 0) sql = stradd(sql, ", ");

        if (values[i].type == SQLITE_RAW)
            sql = stradd(sql, values[i].cstring);
        else
            sql = stradd(sql, "?");

    }

    sql = stradd(sql, ");");

	ret = sqlite3_prepare_v2(db, sql, -1, &stmt, NULL);
	if (ret != SQLITE_OK)
    {
		fprintf(stderr, "Can't prepare INSERT statment '%s' (ret=%d): %s\n", sql, ret, sqlite3_errmsg(db));
        goto gdcsi_exit;
	}

    /* Attribution des valeurs */

    index = 1;

    for (i = 0; i < count; i++)
    {
        switch (values[i].type)
        {
            case SQLITE_INT64:
                ret = sqlite3_bind_int64(stmt, index, values[i].integer64);
                index++;
                break;

            case SQLITE_TEXT:
                ret = sqlite3_bind_text(stmt, index, values[i].string, -1, values[i].delete);
                index++;
                break;

            default:
                ret = SQLITE_OK;
                break;

        }

        if (ret != SQLITE_OK)
        {
            fprintf(stderr, "Can't bind value for parameter nb %d in '%s' (ret=%d): %s\n",
                    index - 1, sql, ret, sqlite3_errmsg(db));
            goto gdcsi_exit;
        }

    }

    /* Exécution finale */

	ret = sqlite3_step(stmt);

    if (ret != SQLITE_DONE)
    {
		fprintf(stderr, "INSERT statement '%s' didn't return DONE (ret=%d): %s\n", sql, ret, sqlite3_errmsg(db));
        goto gdcsi_exit;
    }

    sqlite3_finalize(stmt);

    result = true;

 gdcsi_exit:

    free(sql);

    printf("INSERT ? %d\n", result);

    return result;

}




/* ---------------------------------------------------------------------------------- */
/*                     CREATION DE L'ABSTRACTION POUR COLLECTIONS                     */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : list = ensemble de collectons à parcourir.                   *
*                id   = identifiant interne du type d'éléments groupés.       *
*                                                                             *
*  Description : Recherche une collection correspondant à un type donné.      *
*                                                                             *
*  Retour      : Collection trouvée ou NULL en cas d'échec.                   *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GDbCollection *find_collection_in_list(GList *list, uint32_t id)
{
    GDbCollection *result;                  /* Collection trouvée renvoyée */
    GList *iter;                            /* Boucle de parcours          */

    result = NULL;

    for (iter = g_list_first(list);
         iter != NULL;
         iter = g_list_next(iter))
    {
        result = G_DB_COLLECTION(iter->data);

        if (g_db_collection_get_feature(result) == id)
            break;

    }

    return (iter != NULL ? result : NULL);

}