qofbook.cpp

/********************************************************************\
 * 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.cpp
 *
 * 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) 2007 David Hampton <hampton@employees.org>
 */
#include "qof-string-cache.h"
#include <glib.h>
 
#include <config.h>
 
#include <stdlib.h>
#include <string.h>
 
#ifdef GNC_PLATFORM_WINDOWS
  /* Mingw disables the standard type macros for C++ without this override. */
#define __STDC_FORMAT_MACROS = 1
#endif
#include <inttypes.h>
 
#include "qof.h"
#include "qofevent-p.h"
#include "qofbackend.h"
#include "qofbook-p.hpp"
#include "qofid-p.h"
#include "qofobject-p.h"
#include "qofbookslots.h"
#include "kvp-frame.hpp"
#include "gnc-lot.h"
// For GNC_ID_ROOT_ACCOUNT:
#include "AccountP.hpp"
 
#include "qofbook.hpp"
 
static QofLogModule log_module = QOF_MOD_ENGINE;
 
enum
{
    PROP_0,
//  PROP_ROOT_ACCOUNT,                        /* Table */
//  PROP_ROOT_TEMPLATE,                       /* Table */
    PROP_OPT_TRADING_ACCOUNTS,              /* KVP */
    PROP_OPT_AUTO_READONLY_DAYS,            /* KVP */
    PROP_OPT_NUM_FIELD_SOURCE,              /* KVP */
    PROP_OPT_DEFAULT_BUDGET,                /* KVP */
    PROP_OPT_FY_END,                        /* KVP */
};
 
static void
qof_book_option_num_field_source_changed_cb (GObject *gobject,
                                             GParamSpec *pspec,
                                             gpointer    user_data);
static void
qof_book_option_num_autoreadonly_changed_cb (GObject *gobject,
                                             GParamSpec *pspec,
                                             gpointer    user_data);
 
// Use a #define for the GParam name to avoid typos
#define PARAM_NAME_NUM_FIELD_SOURCE "split-action-num-field"
#define PARAM_NAME_NUM_AUTOREAD_ONLY "autoreadonly-days"
 
G_DEFINE_TYPE(QofBook, qof_book, QOF_TYPE_INSTANCE)
QOF_GOBJECT_DISPOSE(qof_book);
QOF_GOBJECT_FINALIZE(qof_book);
 
#undef G_PARAM_READWRITE
#define G_PARAM_READWRITE static_cast<GParamFlags>(G_PARAM_READABLE | G_PARAM_WRITABLE)
/* ====================================================================== */
/* constructor / destructor */
 
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_string_cache_remove,  /* key_destroy_func   */
                                    coll_destroy);                            /* value_destroy_func */
 
    qof_instance_init_data (&book->inst, QOF_ID_BOOK, book);
 
    book->data_tables = g_hash_table_new_full (g_str_hash, g_str_equal,
                                               (GDestroyNotify)qof_string_cache_remove, nullptr);
    book->data_table_finalizers = g_hash_table_new (g_str_hash, g_str_equal);
 
    book->book_open = 'y';
    book->read_only = FALSE;
    book->session_dirty = FALSE;
    book->version = 0;
    book->cached_num_field_source_isvalid = FALSE;
    book->cached_num_days_autoreadonly_isvalid = FALSE;
 
    // Register a callback on this NUM_FIELD_SOURCE property of that object
    // because it gets called quite a lot, so that its value must be stored in
    // a bool member variable instead of a KVP lookup on each getter call.
    g_signal_connect (G_OBJECT(book),
                      "notify::" PARAM_NAME_NUM_FIELD_SOURCE,
                      G_CALLBACK (qof_book_option_num_field_source_changed_cb),
                      book);
 
    // Register a callback on this NUM_AUTOREAD_ONLY property of that object
    // because it gets called quite a lot, so that its value must be stored in
    // a bool member variable instead of a KVP lookup on each getter call.
    g_signal_connect (G_OBJECT(book),
                      "notify::" PARAM_NAME_NUM_AUTOREAD_ONLY,
                      G_CALLBACK (qof_book_option_num_autoreadonly_changed_cb),
                      book);
}
 
static const std::string str_KVP_OPTION_PATH(KVP_OPTION_PATH);
static const std::string str_OPTION_SECTION_ACCOUNTS(OPTION_SECTION_ACCOUNTS);
static const std::string str_OPTION_SECTION_BUDGETING(OPTION_SECTION_BUDGETING);
static const std::string str_OPTION_NAME_DEFAULT_BUDGET(OPTION_NAME_DEFAULT_BUDGET);
static const std::string str_OPTION_NAME_TRADING_ACCOUNTS(OPTION_NAME_TRADING_ACCOUNTS);
static const std::string str_OPTION_NAME_AUTO_READONLY_DAYS(OPTION_NAME_AUTO_READONLY_DAYS);
static const std::string str_OPTION_NAME_NUM_FIELD_SOURCE(OPTION_NAME_NUM_FIELD_SOURCE);
 
static void
qof_book_get_property (GObject* object,
               guint prop_id,
               GValue* value,
               GParamSpec* pspec)
{
    QofBook *book;
 
    g_return_if_fail (QOF_IS_BOOK (object));
    book = QOF_BOOK (object);
    switch (prop_id)
    {
    case PROP_OPT_TRADING_ACCOUNTS:
        qof_instance_get_path_kvp (QOF_INSTANCE (book), value, {str_KVP_OPTION_PATH,
                str_OPTION_SECTION_ACCOUNTS, str_OPTION_NAME_TRADING_ACCOUNTS});
        break;
    case PROP_OPT_AUTO_READONLY_DAYS:
        qof_instance_get_path_kvp (QOF_INSTANCE (book), value, {str_KVP_OPTION_PATH,
                str_OPTION_SECTION_ACCOUNTS, str_OPTION_NAME_AUTO_READONLY_DAYS});
        break;
    case PROP_OPT_NUM_FIELD_SOURCE:
        qof_instance_get_path_kvp (QOF_INSTANCE (book), value, {str_KVP_OPTION_PATH,
                str_OPTION_SECTION_ACCOUNTS, str_OPTION_NAME_NUM_FIELD_SOURCE});
        break;
    case PROP_OPT_DEFAULT_BUDGET:
        qof_instance_get_path_kvp (QOF_INSTANCE (book), value, {str_KVP_OPTION_PATH,
                str_OPTION_SECTION_BUDGETING, str_OPTION_NAME_DEFAULT_BUDGET});
        break;
    case PROP_OPT_FY_END:
        qof_instance_get_path_kvp (QOF_INSTANCE (book), value, {"fy_end"});
        break;
    default:
        G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
        break;
    }
}
 
static void
qof_book_set_property (GObject      *object,
               guint         prop_id,
               const GValue *value,
               GParamSpec   *pspec)
{
    QofBook *book;
 
    g_return_if_fail (QOF_IS_BOOK (object));
    book = QOF_BOOK (object);
    g_assert (qof_instance_get_editlevel(book));
 
    switch (prop_id)
    {
    case PROP_OPT_TRADING_ACCOUNTS:
        qof_instance_set_path_kvp (QOF_INSTANCE (book), value, {str_KVP_OPTION_PATH,
                str_OPTION_SECTION_ACCOUNTS, str_OPTION_NAME_TRADING_ACCOUNTS});
        break;
    case PROP_OPT_AUTO_READONLY_DAYS:
        qof_instance_set_path_kvp (QOF_INSTANCE (book), value, {str_KVP_OPTION_PATH,
                str_OPTION_SECTION_ACCOUNTS, str_OPTION_NAME_AUTO_READONLY_DAYS});
        break;
    case PROP_OPT_NUM_FIELD_SOURCE:
        qof_instance_set_path_kvp (QOF_INSTANCE (book), value, {str_KVP_OPTION_PATH,
                str_OPTION_SECTION_ACCOUNTS, str_OPTION_NAME_NUM_FIELD_SOURCE});
        break;
    case PROP_OPT_DEFAULT_BUDGET:
        qof_instance_set_path_kvp (QOF_INSTANCE (book), value, {str_KVP_OPTION_PATH,
                str_OPTION_SECTION_BUDGETING, OPTION_NAME_DEFAULT_BUDGET});
        break;
    case PROP_OPT_FY_END:
        qof_instance_set_path_kvp (QOF_INSTANCE (book), value, {"fy_end"});
        break;
    default:
        G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
        break;
    }
}
 
static void
qof_book_class_init (QofBookClass *klass)
{
    GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
    gobject_class->dispose = qof_book_dispose;
    gobject_class->finalize = qof_book_finalize;
    gobject_class->get_property = qof_book_get_property;
    gobject_class->set_property = qof_book_set_property;
 
    g_object_class_install_property
    (gobject_class,
     PROP_OPT_TRADING_ACCOUNTS,
     g_param_spec_string("trading-accts",
                         "Use Trading Accounts",
                         "Scheme true ('t') or nullptr. If 't', then the book "
                         "uses trading accounts for managing multiple-currency "
                         "transactions.",
                         nullptr,
                         G_PARAM_READWRITE));
 
    g_object_class_install_property
    (gobject_class,
     PROP_OPT_NUM_FIELD_SOURCE,
     g_param_spec_string(PARAM_NAME_NUM_FIELD_SOURCE,
                         "Use Split-Action in the Num Field",
                         "Scheme true ('t') or nullptr. If 't', then the book "
                         "will put the split action value in the Num field.",
                         nullptr,
                         G_PARAM_READWRITE));
 
    g_object_class_install_property
    (gobject_class,
     PROP_OPT_AUTO_READONLY_DAYS,
     g_param_spec_double("autoreadonly-days",
                         "Transaction Auto-read-only Days",
                         "Prevent editing of transactions posted more than "
                         "this many days ago.",
                         0,
                         G_MAXDOUBLE,
                         0,
                         G_PARAM_READWRITE));
 
    g_object_class_install_property
    (gobject_class,
     PROP_OPT_DEFAULT_BUDGET,
     g_param_spec_boxed("default-budget",
                        "Book Default Budget",
                        "The default Budget for this book.",
                        GNC_TYPE_GUID,
                        G_PARAM_READWRITE));
    g_object_class_install_property
    (gobject_class,
     PROP_OPT_FY_END,
     g_param_spec_boxed("fy-end",
                        "Book Fiscal Year End",
                        "A GDate with a bogus year having the last Month and "
                        "Day of the Fiscal year for the book.",
                        G_TYPE_DATE,
                        G_PARAM_READWRITE));
}
 
QofBook *
qof_book_new (void)
{
    QofBook *book;
 
    ENTER (" ");
    book = static_cast<QofBook*>(g_object_new(QOF_TYPE_BOOK, nullptr));
    qof_object_book_begin (book);
 
    qof_event_gen (&book->inst, QOF_EVENT_CREATE, nullptr);
    LEAVE ("book=%p", book);
    return book;
}
 
static void
book_final (gpointer key, gpointer value, gpointer booq)
{
    QofBookFinalCB cb = reinterpret_cast<QofBookFinalCB>(value);
    QofBook *book = static_cast<QofBook*>(booq);
 
    gpointer user_data = g_hash_table_lookup (book->data_tables, key);
    (*cb) (book, key, user_data);
}
 
static void
qof_book_dispose_real (G_GNUC_UNUSED GObject *bookp)
{
}
 
static void
qof_book_finalize_real (G_GNUC_UNUSED GObject *bookp)
{
}
 
static void
destroy_lot(QofInstance *inst, [[maybe_unused]]void* data)
{
    auto lot{GNC_LOT(inst)};
    gnc_lot_destroy(lot);
}
 
void
qof_book_destroy (QofBook *book)
{
    GHashTable* cols;
 
    if (!book || !book->hash_of_collections) return;
    ENTER ("book=%p", book);
 
    book->shutting_down = TRUE;
    qof_event_force (&book->inst, QOF_EVENT_DESTROY, nullptr);
 
    /* 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);
 
    /* Lots hold a variety of pointers that need to still exist while
     * cleaning them up so run its book_end before the rest.
     */
    auto lots{qof_book_get_collection(book, GNC_ID_LOT)};
    qof_collection_foreach(lots, destroy_lot, nullptr);
    qof_object_book_end (book);
 
    g_hash_table_destroy (book->data_table_finalizers);
    book->data_table_finalizers = nullptr;
    g_hash_table_destroy (book->data_tables);
    book->data_tables = nullptr;
 
    /* qof_instance_release (&book->inst); */
 
    /* Note: we need to save this hashtable until after we remove ourself
     * from it, otherwise we'll crash in our dispose() function when we
     * DO remove ourself from the collection but the collection had already
     * been destroyed.
     */
    cols = book->hash_of_collections;
    g_object_unref (book);
    g_hash_table_destroy (cols);
 
    LEAVE ("book=%p", book);
}
 
/* ====================================================================== */
 
gboolean
qof_book_session_not_saved (const QofBook *book)
{
    if (!book) return FALSE;
    return !qof_book_empty(book) && book->session_dirty;
 
}
 
void
qof_book_mark_session_saved (QofBook *book)
{
    if (!book) return;
 
    book->dirty_time = 0;
    if (book->session_dirty)
    {
        /* Set the session clean upfront, because the callback will check. */
        book->session_dirty = FALSE;
        if (book->dirty_cb)
            book->dirty_cb(book, FALSE, book->dirty_data);
    }
}
 
void qof_book_mark_session_dirty (QofBook *book)
{
    if (!book) return;
    if (!book->session_dirty)
    {
        /* Set the session dirty upfront, because the callback will check. */
        book->session_dirty = TRUE;
        book->dirty_time = gnc_time (nullptr);
        if (book->dirty_cb)
            book->dirty_cb(book, TRUE, book->dirty_data);
    }
}
 
void
qof_book_print_dirty (const QofBook *book)
{
    if (qof_book_session_not_saved(book))
        PINFO("book is dirty.");
    qof_book_foreach_collection
    (book, (QofCollectionForeachCB)qof_collection_print_dirty, nullptr);
}
 
time64
qof_book_get_session_dirty_time (const QofBook *book)
{
    return book->dirty_time;
}
 
void
qof_book_set_dirty_cb(QofBook *book, QofBookDirtyCB cb, gpointer user_data)
{
    g_return_if_fail(book);
    if (book->dirty_cb)
        PWARN("Already existing callback %p, will be overwritten by %p\n",
                  book->dirty_cb, cb);
    book->dirty_data = user_data;
    book->dirty_cb = cb;
}
 
/* ====================================================================== */
/* getters */
 
QofBackend *
qof_book_get_backend (const QofBook *book)
{
    if (!book) return nullptr;
    return book->backend;
}
 
gboolean
qof_book_shutting_down (const QofBook *book)
{
    if (!book) return FALSE;
    return book->shutting_down;
}
 
/* ====================================================================== */
/* setters */
 
void
qof_book_set_backend (QofBook *book, QofBackend *be)
{
    if (!book) return;
    ENTER ("book=%p be=%p", book, be);
    book->backend = be;
    LEAVE (" ");
}
 
/* ====================================================================== */
/* Store arbitrary pointers in the QofBook for data storage extensibility */
void
qof_book_set_data (QofBook *book, const char *key, gpointer data)
{
    if (!book || !key) return;
    if (data)
        g_hash_table_insert (book->data_tables, (gpointer)CACHE_INSERT(key), data);
    else
        g_hash_table_remove(book->data_tables, key);
}
 
void
qof_book_set_data_fin (QofBook *book, const char *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,
             reinterpret_cast<void*>(cb));
}
 
gpointer
qof_book_get_data (const QofBook *book, const char *key)
{
    if (!book || !key) return nullptr;
    return g_hash_table_lookup (book->data_tables, (gpointer)key);
}
 
/* ====================================================================== */
gboolean
qof_book_is_readonly(const QofBook *book)
{
    g_return_val_if_fail( book != nullptr, TRUE );
    return book->read_only;
}
 
void
qof_book_mark_readonly(QofBook *book)
{
    g_return_if_fail( book != nullptr );
    book->read_only = TRUE;
}
 
gboolean
qof_book_empty(const QofBook *book)
{
    if (!book) return TRUE;
    auto root_acct_col = qof_book_get_collection (book, GNC_ID_ROOT_ACCOUNT);
    return qof_collection_get_data(root_acct_col) == nullptr;
}
 
/* ====================================================================== */
 
QofCollection *
qof_book_get_collection (const QofBook *book, QofIdType entity_type)
{
    QofCollection *col;
 
    if (!book || !entity_type) return nullptr;
 
    col = static_cast<QofCollection*>(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,
            (gpointer)qof_string_cache_insert(entity_type), col);
    }
    return col;
}
 
struct _iterate
{
    QofCollectionForeachCB  fn;
    gpointer                data;
};
 
static void
foreach_cb (G_GNUC_UNUSED gpointer key, gpointer item, gpointer arg)
{
    struct _iterate *iter = static_cast<_iterate*>(arg);
    QofCollection *col = static_cast<QofCollection*>(item);
 
    iter->fn (col, iter->data);
}
 
void
qof_book_foreach_collection (const QofBook *book,
                             QofCollectionForeachCB cb, gpointer user_data)
{
    struct _iterate iter;
 
    g_return_if_fail (book);
    g_return_if_fail (cb);
 
    iter.fn = cb;
    iter.data = user_data;
 
    g_hash_table_foreach (book->hash_of_collections, foreach_cb, &iter);
}
 
/* ====================================================================== */
 
void qof_book_mark_closed (QofBook *book)
{
    if (!book)
    {
        return;
    }
    book->book_open = 'n';
}
 
gboolean qof_book_is_open (const QofBook *book)
{
    g_return_val_if_fail (book, FALSE);
    return book->book_open == 'y';
}
 
void qof_book_swap_books_readonly (QofBook *book, QofBook *other)
{
    g_return_if_fail (book && other);
    std::swap (book->read_only, other->read_only);
}
 
gint64
qof_book_get_counter (QofBook *book, const char *counter_name)
{
    KvpFrame *kvp;
    KvpValue *value;
 
    if (!book)
    {
        PWARN ("No book!!!");
        return -1;
    }
 
    if (!counter_name || *counter_name == '\0')
    {
        PWARN ("Invalid counter name.");
        return -1;
    }
 
    /* Use the KVP in the book */
    kvp = qof_instance_get_slots (QOF_INSTANCE (book));
 
    if (!kvp)
    {
        PWARN ("Book has no KVP_Frame");
        return -1;
    }
 
    value = kvp->get_slot({"counters", counter_name});
    if (value)
    {
        auto int_value{value->get<int64_t>()};
        /* Might be a double because of
         * https://bugs.gnucash.org/show_bug.cgi?id=798930
         */
        if (!int_value)
            int_value = static_cast<int64_t>(value->get<double>());
        return int_value;
    }
    else
    {
        /* New counter */
        return 0;
    }
}
 
gchar *
qof_book_increment_and_format_counter (QofBook *book, const char *counter_name)
{
    KvpFrame *kvp;
    KvpValue *value;
    gint64 counter;
    gchar* format;
    gchar* result;
 
    if (!book)
    {
        PWARN ("No book!!!");
        return nullptr;
    }
 
    if (!counter_name || *counter_name == '\0')
    {
        PWARN ("Invalid counter name.");
        return nullptr;
    }
 
    /* Get the current counter value from the KVP in the book. */
    counter = qof_book_get_counter(book, counter_name);
 
    /* Check if an error occurred */
    if (counter < 0)
        return nullptr;
 
    /* Increment the counter */
    counter++;
 
    /* Get the KVP from the current book */
    kvp = qof_instance_get_slots (QOF_INSTANCE (book));
 
    if (!kvp)
    {
        PWARN ("Book has no KVP_Frame");
        return nullptr;
    }
 
    /* Save off the new counter */
    qof_book_begin_edit(book);
    value = new KvpValue(counter);
    delete kvp->set_path({"counters", counter_name}, value);
    qof_instance_set_dirty (QOF_INSTANCE (book));
    qof_book_commit_edit(book);
 
    format = qof_book_get_counter_format(book, counter_name);
 
    if (!format)
    {
        PWARN("Cannot get format for counter");
        return nullptr;
    }
 
    /* Generate a string version of the counter */
    result = g_strdup_printf(format, counter);
    g_free (format);
    return result;
}
 
char *
qof_book_get_counter_format(const QofBook *book, const char *counter_name)
{
    KvpFrame *kvp;
    const char *user_format = nullptr;
    gchar *norm_format = nullptr;
    KvpValue *value;
    gchar *error = nullptr;
 
    if (!book)
    {
        PWARN ("No book!!!");
        return nullptr;
    }
 
    if (!counter_name || *counter_name == '\0')
    {
        PWARN ("Invalid counter name.");
        return nullptr;
    }
 
    /* Get the KVP from the current book */
    kvp = qof_instance_get_slots (QOF_INSTANCE (book));
 
    if (!kvp)
    {
        PWARN ("Book has no KVP_Frame");
        return nullptr;
    }
 
    /* Get the format string */
    value = kvp->get_slot({"counter_formats", counter_name});
    if (value)
    {
        user_format = value->get<const char*>();
        norm_format = qof_book_normalize_counter_format(user_format, &error);
        if (!norm_format)
        {
            PWARN("Invalid counter format string. Format string: '%s' Counter: '%s' Error: '%s')", user_format, counter_name, error);
            /* Invalid format string */
            user_format = nullptr;
            g_free(error);
        }
    }
 
    /* If no (valid) format string was found, use the default format
     * string */
    if (!norm_format)
    {
        /* Use the default format */
        norm_format = g_strdup ("%.6" PRIi64);
    }
    return norm_format;
}
 
gchar *
qof_book_normalize_counter_format(const gchar *p, gchar **err_msg)
{
    const gchar *valid_formats [] = {
            G_GINT64_FORMAT,
            "lli",
            "I64i",
            PRIi64,
            "li",
            nullptr,
    };
    int i = 0;
    gchar *normalized_spec = nullptr;
 
    while (valid_formats[i])
    {
 
        if (err_msg && *err_msg)
        {
            g_free (*err_msg);
            *err_msg = nullptr;
        }
 
        normalized_spec = qof_book_normalize_counter_format_internal(p, valid_formats[i], err_msg);
        if (normalized_spec)
            return normalized_spec;  /* Found a valid format specifier, return */
        i++;
    }
 
    return nullptr;
}
 
gchar *
qof_book_normalize_counter_format_internal(const gchar *p,
        const gchar *gint64_format, gchar **err_msg)
{
    const gchar *conv_start, *base, *tmp = nullptr;
    gchar *normalized_str = nullptr, *aux_str = nullptr;
 
    /* Validate a counter format. This is a very simple "parser" that
     * simply checks for a single gint64 conversion specification,
     * allowing all modifiers and flags that printf(3) specifies (except
     * for the * width and precision, which need an extra argument). */
    base = p;
 
    /* Skip a prefix of any character except % */
    while (*p)
    {
        /* Skip two adjacent percent marks, which are literal percent
         * marks */
        if (p[0] == '%' && p[1] == '%')
        {
            p += 2;
            continue;
        }
        /* Break on a single percent mark, which is the start of the
         * conversion specification */
        if (*p == '%')
            break;
        /* Skip all other characters */
        p++;
    }
 
    if (!*p)
    {
        if (err_msg)
            *err_msg = g_strdup("Format string ended without any conversion specification");
        return nullptr;
    }
 
    /* Store the start of the conversion for error messages */
    conv_start = p;
 
    /* Skip the % */
    p++;
 
    /* See whether we have already reached the correct format
     * specification (e.g. "li" on Unix, "I64i" on Windows). */
    tmp = strstr(p, gint64_format);
 
    if (!tmp)
    {
        if (err_msg)
            *err_msg = g_strdup_printf("Format string doesn't contain requested format specifier: %s", gint64_format);
        return nullptr;
    }
 
    /* Skip any number of flag characters */
    while (*p && (tmp != p) && strchr("#0- +'I", *p))
    {
        p++;
        tmp = strstr(p, gint64_format);
    }
 
    /* Skip any number of field width digits,
     * and precision specifier digits (including the leading dot) */
    while (*p && (tmp != p) && strchr("0123456789.", *p))
    {
        p++;
        tmp = strstr(p, gint64_format);
    }
 
    if (!*p)
    {
        if (err_msg)
            *err_msg = g_strdup_printf("Format string ended during the conversion specification. Conversion seen so far: %s", conv_start);
        return nullptr;
    }
 
    /* See if the format string starts with the correct format
     * specification. */
    tmp = strstr(p, gint64_format);
    if (tmp == nullptr)
    {
        if (err_msg)
            *err_msg = g_strdup_printf("Invalid length modifier and/or conversion specifier ('%.4s'), it should be: %s", p, gint64_format);
        return nullptr;
    }
    else if (tmp != p)
    {
        if (err_msg)
            *err_msg = g_strdup_printf("Garbage before length modifier and/or conversion specifier: '%*s'", (int)(tmp - p), p);
        return nullptr;
    }
 
    /* Copy the string we have so far and add normalized format specifier for long int */
    aux_str = g_strndup (base, p - base);
    normalized_str = g_strconcat (aux_str, PRIi64, nullptr);
    g_free (aux_str);
 
    /* Skip length modifier / conversion specifier */
    p += strlen(gint64_format);
    tmp = p;
 
    /* Skip a suffix of any character except % */
    while (*p)
    {
        /* Skip two adjacent percent marks, which are literal percent
         * marks */
        if (p[0] == '%' && p[1] == '%')
        {
            p += 2;
            continue;
        }
        /* Break on a single percent mark, which is the start of the
         * conversion specification */
        if (*p == '%')
        {
            if (err_msg)
                *err_msg = g_strdup_printf("Format string contains unescaped %% signs (or multiple conversion specifications) at '%s'", p);
            g_free (normalized_str);
            return nullptr;
        }
        /* Skip all other characters */
        p++;
    }
 
    /* Add the suffix to our normalized string */
    aux_str = normalized_str;
    normalized_str = g_strconcat (aux_str, tmp, nullptr);
    g_free (aux_str);
 
    /* If we end up here, the string was valid, so return no error
     * message */
    return normalized_str;
}
 
/* Determine whether this book uses trading accounts */
gboolean
qof_book_use_trading_accounts (const QofBook *book)
{
    char *opt = nullptr;
    qof_instance_get (QOF_INSTANCE (book), "trading-accts", &opt, nullptr);
    auto retval = (opt && opt[0] == 't' && opt[1] == 0);
    g_free (opt);
    return retval;
}
 
/* Returns TRUE if this book uses split action field as the 'Num' field, FALSE
 * if it uses transaction number field */
gboolean
qof_book_use_split_action_for_num_field (const QofBook *book)
{
    g_return_val_if_fail (book, FALSE);
    if (!book->cached_num_field_source_isvalid)
    {
        // No cached value? Then do the expensive KVP lookup
        gboolean result;
        char *opt = nullptr;
        qof_instance_get (QOF_INSTANCE (book),
                          PARAM_NAME_NUM_FIELD_SOURCE, &opt,
                          nullptr);
 
        if (opt && opt[0] == 't' && opt[1] == 0)
            result = TRUE;
        else
            result = FALSE;
        g_free (opt);
 
        // We need to const_cast the "book" argument into a non-const pointer,
        // but as we are dealing only with cache variables, I think this is
        // understandable enough.
        const_cast<QofBook*>(book)->cached_num_field_source = result;
        const_cast<QofBook*>(book)->cached_num_field_source_isvalid = TRUE;
    }
    // Value is cached now. Use the cheap variable returning.
    return book->cached_num_field_source;
}
 
// The callback that is called when the KVP option value of
// "split-action-num-field" changes, so that we mark the cached value as
// invalid.
static void
qof_book_option_num_field_source_changed_cb (GObject *gobject,
                                             GParamSpec *pspec,
                                             gpointer    user_data)
{
    QofBook *book = reinterpret_cast<QofBook*>(user_data);
    g_return_if_fail(QOF_IS_BOOK(book));
    book->cached_num_field_source_isvalid = FALSE;
}
 
gboolean qof_book_uses_autoreadonly (const QofBook *book)
{
    g_assert(book);
    return (qof_book_get_num_days_autoreadonly(book) != 0);
}
 
void qof_book_reset_num_days_autoreadonly_cache (QofBook *book)
{
    g_return_if_fail (book);
    book->cached_num_days_autoreadonly_isvalid = FALSE;
}
 
gint qof_book_get_num_days_autoreadonly (const QofBook *book)
{
    g_assert(book);
 
    if (!book->cached_num_days_autoreadonly_isvalid)
    {
        double tmp;
 
        // No cached value? Then do the expensive KVP lookup
        qof_instance_get (QOF_INSTANCE (book),
              PARAM_NAME_NUM_AUTOREAD_ONLY, &tmp,
              nullptr);
 
        const_cast<QofBook*>(book)->cached_num_days_autoreadonly = tmp;
        const_cast<QofBook*>(book)->cached_num_days_autoreadonly_isvalid = TRUE;
    }
    // Value is cached now. Use the cheap variable returning.
    return (gint) book->cached_num_days_autoreadonly;
}
 
GDate* qof_book_get_autoreadonly_gdate (const QofBook *book)
{
    gint num_days;
    GDate* result = nullptr;
 
    g_assert(book);
    num_days = qof_book_get_num_days_autoreadonly(book);
    if (num_days > 0)
    {
        result = gnc_g_date_new_today();
        g_date_subtract_days(result, num_days);
    }
    return result;
}
 
// The callback that is called when the KVP option value of
// "autoreadonly-days" changes, so that we mark the cached value as
// invalid.
static void
qof_book_option_num_autoreadonly_changed_cb (GObject *gobject,
                                             GParamSpec *pspec,
                                             gpointer    user_data)
{
    QofBook *book = reinterpret_cast<QofBook*>(user_data);
    g_return_if_fail(QOF_IS_BOOK(book));
    book->cached_num_days_autoreadonly_isvalid = FALSE;
}
 
static KvpValue*
get_option_default_invoice_report_value (QofBook *book)
{
    KvpFrame *root = qof_instance_get_slots (QOF_INSTANCE(book));
    return root->get_slot ({KVP_OPTION_PATH,
                            OPTION_SECTION_BUSINESS,
                            OPTION_NAME_DEFAULT_INVOICE_REPORT});
}
 
void
qof_book_set_default_invoice_report (QofBook *book, const gchar *guid,
                                     const gchar *name)
{
    const gchar *existing_guid_name = nullptr;
    gchar *new_guid_name;
 
    if (!book)
    {
        PWARN ("No book!!!");
        return;
    }
 
    if (!guid)
    {
        PWARN ("No guid!!!");
        return;
    }
 
    if (!name)
    {
        PWARN ("No name!!!");
        return;
    }
 
    KvpValue *value = get_option_default_invoice_report_value (book);
 
    if (value)
        existing_guid_name = {value->get<const char*>()};
 
    new_guid_name = g_strconcat (guid, "/", name, nullptr);
 
    if (g_strcmp0 (existing_guid_name, new_guid_name) != 0)
    {
        auto value = new KvpValue {g_strdup(new_guid_name)};
        KvpFrame *root = qof_instance_get_slots (QOF_INSTANCE(book));
        qof_book_begin_edit (book);
        delete root->set_path ({KVP_OPTION_PATH,
                                OPTION_SECTION_BUSINESS,
                                OPTION_NAME_DEFAULT_INVOICE_REPORT}, value);
        qof_instance_set_dirty (QOF_INSTANCE(book));
        qof_book_commit_edit (book);
    }
    g_free (new_guid_name);
}
 
gchar *
qof_book_get_default_invoice_report_guid (const QofBook *book)
{
    gchar *report_guid = nullptr;
 
    if (!book)
    {
        PWARN ("No book!!!");
        return report_guid;
    }
 
    KvpValue *value = get_option_default_invoice_report_value (const_cast<QofBook*>(book));
 
    if (value)
    {
        auto str {value->get<const char*>()};
        auto ptr = strchr (str, '/');
        if (ptr)
        {
            if (ptr - str == GUID_ENCODING_LENGTH)
            {
                if (strlen (str) > GUID_ENCODING_LENGTH)
                    report_guid = g_strndup (&str[0], GUID_ENCODING_LENGTH);
            }
        }
    }
    return report_guid;
}
 
gchar *
qof_book_get_default_invoice_report_name (const QofBook *book)
{
    gchar *report_name = nullptr;
 
    if (!book)
    {
        PWARN ("No book!!!");
        return report_name;
    }
 
    KvpValue *value = get_option_default_invoice_report_value (const_cast<QofBook*>(book));
 
    if (value)
    {
        auto str {value->get<const char*>()};
        auto ptr = strchr (str, '/');
        if (ptr)
        {
            if (ptr - str == GUID_ENCODING_LENGTH)
            {
                if (strlen (str) > GUID_ENCODING_LENGTH + 1)
                    report_name = g_strdup (&str[GUID_ENCODING_LENGTH + 1]);
                else
                    report_name = g_strdup ("");
            }
        }
    }
    return report_name;
}
 
gdouble
qof_book_get_default_invoice_report_timeout (const QofBook *book)
{
    double ret = 0;
 
    if (!book)
    {
        PWARN ("No book!!!");
        return ret;
    }
 
    KvpFrame *root = qof_instance_get_slots (QOF_INSTANCE(book));
    KvpValue *value = root->get_slot ({KVP_OPTION_PATH,
                                       OPTION_SECTION_BUSINESS,
                                       OPTION_NAME_DEFAULT_INVOICE_REPORT_TIMEOUT});
 
    if (value)
        ret = {value->get<double>()};
 
    return ret;
}
 
/* Note: this will fail if the book slots we're looking for here are flattened at some point !
 * When that happens, this function can be removed. */
static Path opt_name_to_path (const char* opt_name)
{
    Path result;
    g_return_val_if_fail (opt_name, result);
    auto opt_name_list = g_strsplit(opt_name, "/", -1);
    for (int i=0; opt_name_list[i]; i++)
        result.push_back (opt_name_list[i]);
    g_strfreev (opt_name_list);
    return result;
}
 
const char*
qof_book_get_string_option(const QofBook* book, const char* opt_name)
{
    auto slot = qof_instance_get_slots(QOF_INSTANCE (book))->get_slot(opt_name_to_path(opt_name));
    if (slot == nullptr)
        return nullptr;
    return slot->get<const char*>();
}
 
void
qof_book_set_string_option(QofBook* book, const char* opt_name, const char* opt_val)
{
    qof_book_begin_edit(book);
    auto frame = qof_instance_get_slots(QOF_INSTANCE(book));
    auto opt_path = opt_name_to_path(opt_name);
    if (opt_val && (*opt_val != '\0'))
        delete frame->set_path(opt_path, new KvpValue(g_strdup(opt_val)));
    else
        delete frame->set_path(opt_path, nullptr);
    qof_instance_set_dirty (QOF_INSTANCE (book));
    qof_book_commit_edit(book);
}
 
const GncGUID*
qof_book_get_guid_option(QofBook* book, GSList* path)
{
    g_return_val_if_fail(book != nullptr, nullptr);
    g_return_val_if_fail(path != nullptr, nullptr);
 
    auto table_value = qof_book_get_option(book, path);
    if (!table_value)
        return nullptr;
    return table_value->get<GncGUID*>();
}
 
void
qof_book_option_frame_delete (QofBook *book, const char* opt_name)
{
    if (opt_name && (*opt_name != '\0'))
    {
        qof_book_begin_edit(book);
        auto frame = qof_instance_get_slots(QOF_INSTANCE(book));
        auto opt_path = opt_name_to_path(opt_name);
        delete frame->set_path(opt_path, nullptr);
        qof_instance_set_dirty (QOF_INSTANCE (book));
        qof_book_commit_edit(book);
    }
}
 
void
qof_book_begin_edit (QofBook *book)
{
    qof_begin_edit(&book->inst);
}
 
static void commit_err (G_GNUC_UNUSED QofInstance *inst, QofBackendError errcode)
{
    PERR ("Failed to commit: %d", errcode);
//  gnc_engine_signal_commit_error( errcode );
}
 
#define GNC_FEATURES "features"
static void
add_feature_to_hash (const gchar *key, KvpValue *value, GHashTable * user_data)
{
    gchar *descr = g_strdup(value->get<const char*>());
    g_hash_table_insert (user_data, (gchar*)key, descr);
}
 
GHashTable *
qof_book_get_features (QofBook *book)
{
    KvpFrame *frame = qof_instance_get_slots (QOF_INSTANCE (book));
    GHashTable *features = g_hash_table_new_full (g_str_hash, g_str_equal,
                                                  nullptr, g_free);
 
    PWARN ("qof_book_get_features is now deprecated.");
 
    auto slot = frame->get_slot({GNC_FEATURES});
    if (slot != nullptr)
    {
        frame = slot->get<KvpFrame*>();
        frame->for_each_slot_temp(&add_feature_to_hash, features);
    }
    return features;
}
 
void
qof_book_set_feature (QofBook *book, const gchar *key, const gchar *descr)
{
    KvpFrame *frame = qof_instance_get_slots (QOF_INSTANCE (book));
    KvpValue* feature = nullptr;
    auto feature_slot = frame->get_slot({GNC_FEATURES});
    if (feature_slot)
    {
        auto feature_frame = feature_slot->get<KvpFrame*>();
        feature = feature_frame->get_slot({key});
    }
    if (feature == nullptr || g_strcmp0 (feature->get<const char*>(), descr))
    {
        qof_book_begin_edit (book);
        delete frame->set_path({GNC_FEATURES, key}, new KvpValue(g_strdup (descr)));
        qof_instance_set_dirty (QOF_INSTANCE (book));
        qof_book_commit_edit (book);
    }
}
 
FeatureSet
qof_book_get_unknown_features (QofBook *book, const FeaturesTable& features)
{
    FeatureSet rv;
    auto test_feature = [&](const KvpFrameImpl::map_type::value_type& feature)
    {
        if (features.find (feature.first) == features.end ())
            rv.emplace_back (feature.first, feature.second->get<const char*>());
    };
    auto frame = qof_instance_get_slots (QOF_INSTANCE (book));
    auto slot = frame->get_slot({GNC_FEATURES});
    if (slot != nullptr)
    {
        frame = slot->get<KvpFrame*>();
        std::for_each (frame->begin (), frame->end (), test_feature);
    }
    return rv;
}
 
bool
qof_book_test_feature (QofBook *book, const char *feature)
{
    auto frame = qof_instance_get_slots (QOF_INSTANCE (book));
    return (frame->get_slot({GNC_FEATURES, feature}) != nullptr);
}
 
void
qof_book_unset_feature (QofBook *book, const gchar *key)
{
    KvpFrame *frame = qof_instance_get_slots (QOF_INSTANCE (book));
    auto feature_slot = frame->get_slot({GNC_FEATURES, key});
    if (!feature_slot)
    {
        PWARN ("no feature %s. bail out.", key);
        return;
    }
    qof_book_begin_edit (book);
    delete frame->set_path({GNC_FEATURES, key}, nullptr);
    qof_instance_set_dirty (QOF_INSTANCE (book));
    qof_book_commit_edit (book);
}
 
void
qof_book_load_options (QofBook *book, GncOptionLoad load_cb, GncOptionDB *odb)
{
    load_cb (odb, book);
}
 
void
qof_book_save_options (QofBook *book, GncOptionSave save_cb,
                       GncOptionDB* odb, gboolean clear)
{
    /* Wrap this in begin/commit so that it commits only once instead of doing
     * so for every option. Qof_book_set_option will take care of dirtying the
     * book.
     */
    qof_book_begin_edit (book);
    save_cb (odb, book, clear);
    qof_book_commit_edit (book);
}
 
static void noop (QofInstance *inst) {}
 
void
qof_book_commit_edit(QofBook *book)
{
    if (!qof_commit_edit (QOF_INSTANCE(book))) return;
    qof_commit_edit_part2 (&book->inst, commit_err, noop, noop/*lot_free*/);
}
 
/* Deal with the fact that some options are not in the "options" tree but rather
 * in the "counters" or "counter_formats" tree */
static Path gslist_to_option_path (GSList *gspath)
{
    Path tmp_path;
    if (!gspath) return tmp_path;
 
    Path path_v {str_KVP_OPTION_PATH};
    for (auto item = gspath; item != nullptr; item = g_slist_next(item))
        tmp_path.push_back(static_cast<const char*>(item->data));
    if ((tmp_path.front() == "counters") || (tmp_path.front() == "counter_formats"))
        return tmp_path;
 
    path_v.insert(path_v.end(), tmp_path.begin(), tmp_path.end());
    return path_v;
}
 
void
qof_book_set_option (QofBook *book, KvpValue *value, GSList *path)
{
    KvpFrame *root = qof_instance_get_slots (QOF_INSTANCE (book));
    qof_book_begin_edit (book);
    delete root->set_path(gslist_to_option_path(path), value);
    qof_instance_set_dirty (QOF_INSTANCE (book));
    qof_book_commit_edit (book);
 
    // Also, mark any cached value as invalid
    book->cached_num_field_source_isvalid = FALSE;
}
 
KvpValue*
qof_book_get_option (QofBook *book, GSList *path)
{
    KvpFrame *root = qof_instance_get_slots(QOF_INSTANCE (book));
    return root->get_slot(gslist_to_option_path(path));
}
 
void
qof_book_options_delete (QofBook *book, GSList *path)
{
    KvpFrame *root = qof_instance_get_slots(QOF_INSTANCE (book));
    if (path != nullptr)
    {
        Path path_v {str_KVP_OPTION_PATH};
        Path tmp_path;
        for (auto item = path; item != nullptr; item = g_slist_next(item))
            tmp_path.push_back(static_cast<const char*>(item->data));
        delete root->set_path(gslist_to_option_path(path), nullptr);
    }
    else
        delete root->set_path({str_KVP_OPTION_PATH}, nullptr);
}
 
/* QofObject function implementation and registration */
gboolean qof_book_register (void)
{
    static QofParam params[] =
    {
        { QOF_PARAM_GUID, QOF_TYPE_GUID, (QofAccessFunc)qof_entity_get_guid, nullptr },
        { QOF_PARAM_KVP,  QOF_TYPE_KVP,  (QofAccessFunc)qof_instance_get_slots, nullptr },
        { nullptr },
    };
 
    qof_class_register (QOF_ID_BOOK, nullptr, params);
 
    return TRUE;
}
 
 
 
static gboolean get_session_dirty(const QofBook *book){ return book->session_dirty; }
static gboolean get_read_only(const QofBook *book){ return book->read_only; }
static QofBookDirtyCB get_dirty_cb(const QofBook *book){ return book->dirty_cb; }
static void set_shutting_down(QofBook *book, gboolean state){ book->shutting_down = state; }
static gpointer get_dirty_data(const QofBook *book){ return book->dirty_data; }
static GHashTable* get_collections(const QofBook *book){ return book->hash_of_collections; }
static GHashTable* get_data_tables(const QofBook *book){ return book->data_tables; }
static GHashTable* get_data_table_finalizers(const QofBook *book){ return book->data_table_finalizers; }
static char get_book_open(const QofBook *book){ return book->book_open; }
static int get_version(const QofBook *book){ return book->version; }
 
 
QofBookTestFunctions*
_utest_qofbook_fill_functions (void)
{
    QofBookTestFunctions *func = g_new (QofBookTestFunctions, 1);
 
    func->get_session_dirty = get_session_dirty;
    func->get_read_only = get_read_only;
    func->get_dirty_cb = get_dirty_cb;
    func->set_shutting_down = set_shutting_down;
    func->get_dirty_data = get_dirty_data;
    func->get_collections = get_collections;
    func->get_data_tables = get_data_tables;
    func->get_data_table_finalizers = get_data_table_finalizers;
    func->get_book_open = get_book_open;
    func->get_version = get_version;
    return func;
}
 
 
/* ========================== END OF FILE =============================== */