qofbook.c

/********************************************************************\
 * qofbook.c -- dataset access (set of books of entities)           *
 *                                                                  *
 * This program 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 2 of   *
 * the License, or (at your option) any later version.              *
 *                                                                  *
 * This program 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, contact:                        *
 *                                                                  *
 * Free Software Foundation           Voice:  +1-617-542-5942       *
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
 * Boston, MA  02110-1301,  USA       gnu@gnu.org                   *
\********************************************************************/

/*
 * FILE:
 * qofbook.c
 *
 * FUNCTION:
 * Encapsulate all the information about a QOF dataset.
 *
 * HISTORY:
 * Created by Linas Vepstas December 1998
 * Copyright (c) 1998-2001,2003 Linas Vepstas <linas@linas.org>
 * Copyright (c) 2000 Dave Peticolas
 * Copyright (c) 2006 Neil Williams <linux@codehelp.co.uk>
 */

#include "config.h"
#include <stdlib.h>
#include <string.h>
#include <glib.h>
#include "qof.h"
#include "qofevent-p.h"
#include "qofbackend-p.h"
#include "qofbook-p.h"
#include "qofid-p.h"
#include "qofobject-p.h"

static QofLogModule log_module = QOF_MOD_ENGINE;

static void
coll_destroy (gpointer col)
{
    qof_collection_destroy ((QofCollection *) col);
}

static void
qof_book_init (QofBook * book)
{
    if (!book)
        return;

    book->hash_of_collections =
        g_hash_table_new_full (g_str_hash, g_str_equal,
        (GDestroyNotify) qof_util_string_cache_remove, coll_destroy);
    qof_instance_init (&book->inst, QOF_ID_BOOK, book);
    book->data_tables = g_hash_table_new (g_str_hash, g_str_equal);
    book->data_table_finalizers =
        g_hash_table_new (g_str_hash, g_str_equal);
    book->book_open = 'y';
    book->version = 0;
    book->idata = 0;
    book->undo_data = g_new0 (QofUndo, 1);
}

QofBook *
qof_book_new (void)
{
    QofBook *book;

    ENTER (" ");
    book = g_new0 (QofBook, 1);
    qof_book_init (book);
    qof_object_book_begin (book);
    qof_event_gen (&book->inst.entity, QOF_EVENT_CREATE, NULL);
    LEAVE ("book=%p", book);
    return book;
}

static void
book_final (gpointer key, gpointer value, gpointer booq)
{
    QofBookFinalCB cb = value;
    QofBook *book = booq;

    gpointer user_data = g_hash_table_lookup (book->data_tables, key);
    (*cb) (book, key, user_data);
}

void
qof_book_destroy (QofBook * book)
{
    if (!book)
        return;
    ENTER ("book=%p", book);
    book->shutting_down = TRUE;
    qof_event_force (&book->inst.entity, QOF_EVENT_DESTROY, NULL);
    /* Call the list of finalizers, let them do their thing. 
     * Do this before tearing into the rest of the book.
     */
    g_hash_table_foreach (book->data_table_finalizers, book_final, book);
    qof_object_book_end (book);
    g_hash_table_destroy (book->data_table_finalizers);
    book->data_table_finalizers = NULL;
    g_hash_table_destroy (book->data_tables);
    book->data_tables = NULL;
    qof_instance_release (&book->inst);
    g_hash_table_destroy (book->hash_of_collections);
    book->hash_of_collections = NULL;
    g_free (book);
    LEAVE ("book=%p", book);
}

/* call is_equal callbacks on QofObject ? */

gboolean
qof_book_equal (QofBook * book_1, QofBook * book_2)
{
    if (book_1 == book_2)
        return TRUE;
    if (!book_1 || !book_2)
        return FALSE;
    return TRUE;
}

gboolean
qof_book_not_saved (QofBook * book)
{
    if (!book)
        return FALSE;

    return (book->inst.dirty || qof_object_is_dirty (book));
}

void
qof_book_mark_saved (QofBook * book)
{
    if (!book)
        return;

    book->inst.dirty = FALSE;
    qof_object_mark_clean (book);
}

QofBackend *
qof_book_get_backend (QofBook * book)
{
    if (!book)
        return NULL;
    return book->backend;
}

gboolean
qof_book_shutting_down (QofBook * book)
{
    if (!book)
        return FALSE;
    return book->shutting_down;
}

void
qof_book_set_backend (QofBook * book, QofBackend * be)
{
    if (!book)
        return;
    ENTER ("book=%p be=%p", book, be);
    book->backend = be;
    LEAVE (" ");
}

void
qof_book_kvp_changed (QofBook * book)
{
    if (!book)
        return;
    book->inst.dirty = TRUE;
}

/* Store arbitrary pointers in the QofBook for data storage extensibility */
/* XXX if data is NULL, we should remove the key from the hash table!
 */
void
qof_book_set_data (QofBook * book, const gchar * key, gpointer data)
{
    if (!book || !key)
        return;
    g_hash_table_insert (book->data_tables, (gpointer) key, data);
}

void
qof_book_set_data_fin (QofBook * book, const gchar * key,
    gpointer data, QofBookFinalCB cb)
{
    if (!book || !key)
        return;
    g_hash_table_insert (book->data_tables, (gpointer) key, data);

    if (!cb)
        return;
    g_hash_table_insert (book->data_table_finalizers, (gpointer) key, cb);
}

gpointer
qof_book_get_data (QofBook * book, const gchar * key)
{
    if (!book || !key)
        return NULL;
    return g_hash_table_lookup (book->data_tables, (gpointer) key);
}

QofCollection *
qof_book_get_collection (QofBook * book, QofIdType entity_type)
{
    QofCollection *col;

    if (!book || !entity_type)
        return NULL;
    col = g_hash_table_lookup (book->hash_of_collections, entity_type);
    if (!col)
    {
        col = qof_collection_new (entity_type);
        g_hash_table_insert (book->hash_of_collections,
            qof_util_string_cache_insert ((gpointer) entity_type), col);
    }
    return col;
}

struct _iterate
{
    QofCollectionForeachCB fn;
    gpointer data;
};

static void
foreach_cb (gpointer key __attribute__ ((unused)), gpointer item, gpointer arg)
{
    struct _iterate *qiter = arg;
    QofCollection *col = item;

    qiter->fn (col, qiter->data);
}

void
qof_book_foreach_collection (QofBook * book,
    QofCollectionForeachCB cb, gpointer user_data)
{
    struct _iterate qiter;

    g_return_if_fail (book);
    g_return_if_fail (cb);
    qiter.fn = cb;
    qiter.data = user_data;
    g_hash_table_foreach (book->hash_of_collections, foreach_cb, &qiter);
}

void
qof_book_mark_closed (QofBook * book)
{
    if (!book)
    {
        return;
    }
    book->book_open = 'n';
}

gchar
qof_book_get_open_marker (QofBook * book)
{
    if (!book)
    {
        return 'n';
    }
    return book->book_open;
}

gint32
qof_book_get_version (QofBook * book)
{
    if (!book)
    {
        return -1;
    }
    return book->version;
}

guint32
qof_book_get_idata (QofBook * book)
{
    if (!book)
    {
        return 0;
    }
    return book->idata;
}

void
qof_book_set_version (QofBook * book, gint32 version)
{
    if (!book && version < 0)
    {
        return;
    }
    book->version = version;
}

void
qof_book_set_idata (QofBook * book, guint32 idata)
{
    if (!book && idata == 0)
    {
        return;
    }
    book->idata = idata;
}

gint64
qof_book_get_counter (QofBook * book, const gchar * counter_name)
{
    QofBackend *be;
    KvpFrame *kvp;
    KvpValue *value;
    gint64 counter;

    if (!book)
    {
        PWARN ("No book!!!");
        return -1;
    }
    if (!counter_name || *counter_name == '\0')
    {
        PWARN ("Invalid counter name.");
        return -1;
    }
    /* If we've got a backend with a counter method, call it */
    be = book->backend;
    if (be && be->counter)
        return ((be->counter) (be, counter_name));
    /* If not, then use the KVP in the book */
    kvp = qof_book_get_slots (book);
    if (!kvp)
    {
        PWARN ("Book has no KVP_Frame");
        return -1;
    }
    value = kvp_frame_get_slot_path (kvp, "counters", counter_name, NULL);
    if (value)
    {
        /* found it */
        counter = kvp_value_get_gint64 (value);
    }
    else
    {
        /* New counter */
        counter = 0;
    }
    /* Counter is now valid; increment it */
    counter++;
    /* Save off the new counter */
    value = kvp_value_new_gint64 (counter);
    kvp_frame_set_slot_path (kvp, value, "counters", counter_name, NULL);
    kvp_value_delete (value);
    /* and return the value */
    return counter;
}

/* QofObject function implementation and registration */
gboolean
qof_book_register (void)
{
    static QofParam params[] = {
        {QOF_PARAM_GUID, QOF_TYPE_GUID,
                (QofAccessFunc) qof_entity_get_guid,
            NULL, NULL},
        {QOF_PARAM_KVP, QOF_TYPE_KVP,
                (QofAccessFunc) qof_instance_get_slots,
            NULL, NULL},
        {NULL, NULL, NULL, NULL, NULL},
    };

    qof_class_register (QOF_ID_BOOK, NULL, params);

    return TRUE;
}

/* ========================== END OF FILE =============================== */

---