mirror of
https://github.com/Gnucash/gnucash.git
synced 2024-12-02 05:29:20 -06:00
1238b9d8cd
This will avoid a ninja-build from picking up a config.h generated by the autotools build (in the root build directory). Picking up the wrong config.h may lead to all kinds of subtle issues if the autotools run was done with different options than the cmake run.
543 lines
16 KiB
C++
543 lines
16 KiB
C++
/********************************************************************\
|
|
* gnc-customer-xml-v2.c -- customer xml i/o implementation *
|
|
* *
|
|
* Copyright (C) 2002 Derek Atkins <warlord@MIT.EDU> *
|
|
* *
|
|
* 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 *
|
|
* *
|
|
\********************************************************************/
|
|
extern "C"
|
|
{
|
|
#include <config.h>
|
|
|
|
#include <glib.h>
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
|
|
#include "gncBillTermP.h"
|
|
#include "gncCustomerP.h"
|
|
#include "gncTaxTableP.h"
|
|
}
|
|
|
|
#include "gnc-xml-helper.h"
|
|
#include "gnc-customer-xml-v2.h"
|
|
#include "gnc-address-xml-v2.h"
|
|
#include "gnc-bill-term-xml-v2.h"
|
|
#include "sixtp.h"
|
|
#include "sixtp-utils.h"
|
|
#include "sixtp-parsers.h"
|
|
#include "sixtp-utils.h"
|
|
#include "sixtp-dom-parsers.h"
|
|
#include "sixtp-dom-generators.h"
|
|
|
|
#include "gnc-xml.h"
|
|
#include "io-gncxml-gen.h"
|
|
#include "io-gncxml-v2.h"
|
|
|
|
#include "xml-helpers.h"
|
|
|
|
#define _GNC_MOD_NAME GNC_ID_CUSTOMER
|
|
|
|
static QofLogModule log_module = GNC_MOD_IO;
|
|
|
|
const gchar* customer_version_string = "2.0.0";
|
|
|
|
/* ids */
|
|
#define gnc_customer_string "gnc:GncCustomer"
|
|
#define cust_name_string "cust:name"
|
|
#define cust_guid_string "cust:guid"
|
|
#define cust_id_string "cust:id"
|
|
#define cust_addr_string "cust:addr"
|
|
#define cust_shipaddr_string "cust:shipaddr"
|
|
#define cust_notes_string "cust:notes"
|
|
#define cust_terms_string "cust:terms"
|
|
#define cust_taxincluded_string "cust:taxincluded"
|
|
#define cust_active_string "cust:active"
|
|
#define cust_discount_string "cust:discount"
|
|
#define cust_credit_string "cust:credit"
|
|
#define cust_currency_string "cust:currency"
|
|
#define cust_taxtable_string "cust:taxtable"
|
|
#define cust_taxtableoverride_string "cust:use-tt"
|
|
#define cust_slots_string "cust:slots"
|
|
|
|
static xmlNodePtr
|
|
customer_dom_tree_create (GncCustomer* cust)
|
|
{
|
|
xmlNodePtr ret;
|
|
gnc_numeric num;
|
|
GncBillTerm* term;
|
|
GncTaxTable* taxtable;
|
|
|
|
ret = xmlNewNode (NULL, BAD_CAST gnc_customer_string);
|
|
xmlSetProp (ret, BAD_CAST "version", BAD_CAST customer_version_string);
|
|
|
|
xmlAddChild (ret, guid_to_dom_tree (cust_guid_string,
|
|
qof_instance_get_guid (QOF_INSTANCE (cust))));
|
|
|
|
xmlAddChild (ret, text_to_dom_tree (cust_name_string,
|
|
gncCustomerGetName (cust)));
|
|
|
|
xmlAddChild (ret, text_to_dom_tree (cust_id_string,
|
|
gncCustomerGetID (cust)));
|
|
|
|
xmlAddChild (ret, gnc_address_to_dom_tree (cust_addr_string,
|
|
gncCustomerGetAddr (cust)));
|
|
|
|
xmlAddChild (ret, gnc_address_to_dom_tree (cust_shipaddr_string,
|
|
gncCustomerGetShipAddr (cust)));
|
|
|
|
maybe_add_string (ret, cust_notes_string, gncCustomerGetNotes (cust));
|
|
|
|
term = gncCustomerGetTerms (cust);
|
|
if (term)
|
|
xmlAddChild (ret, guid_to_dom_tree (cust_terms_string,
|
|
qof_instance_get_guid (QOF_INSTANCE (term))));
|
|
|
|
xmlAddChild (ret, text_to_dom_tree (cust_taxincluded_string,
|
|
gncTaxIncludedTypeToString (
|
|
gncCustomerGetTaxIncluded (cust))));
|
|
|
|
xmlAddChild (ret, int_to_dom_tree (cust_active_string,
|
|
gncCustomerGetActive (cust)));
|
|
|
|
num = gncCustomerGetDiscount (cust);
|
|
xmlAddChild (ret, gnc_numeric_to_dom_tree (cust_discount_string, &num));
|
|
|
|
num = gncCustomerGetCredit (cust);
|
|
xmlAddChild (ret, gnc_numeric_to_dom_tree (cust_credit_string, &num));
|
|
|
|
xmlAddChild
|
|
(ret,
|
|
commodity_ref_to_dom_tree (cust_currency_string,
|
|
gncCustomerGetCurrency (cust)));
|
|
|
|
xmlAddChild (ret, int_to_dom_tree (cust_taxtableoverride_string,
|
|
gncCustomerGetTaxTableOverride (cust)));
|
|
taxtable = gncCustomerGetTaxTable (cust);
|
|
if (taxtable)
|
|
xmlAddChild (ret, guid_to_dom_tree (cust_taxtable_string,
|
|
qof_instance_get_guid (QOF_INSTANCE (taxtable))));
|
|
|
|
/* xmlAddChild won't do anything with a NULL, so tests are superfluous. */
|
|
xmlAddChild (ret, qof_instance_slots_to_dom_tree (cust_slots_string,
|
|
QOF_INSTANCE (cust)));
|
|
|
|
return ret;
|
|
}
|
|
|
|
/***********************************************************************/
|
|
|
|
struct customer_pdata
|
|
{
|
|
GncCustomer* customer;
|
|
QofBook* book;
|
|
};
|
|
|
|
static gboolean
|
|
set_string (xmlNodePtr node, GncCustomer* cust,
|
|
void (*func) (GncCustomer* cust, const char* txt))
|
|
{
|
|
char* txt = dom_tree_to_text (node);
|
|
g_return_val_if_fail (txt, FALSE);
|
|
|
|
func (cust, txt);
|
|
|
|
g_free (txt);
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
static gboolean
|
|
set_boolean (xmlNodePtr node, GncCustomer* cust,
|
|
void (*func) (GncCustomer* cust, gboolean b))
|
|
{
|
|
gint64 val;
|
|
gboolean ret;
|
|
|
|
ret = dom_tree_to_integer (node, &val);
|
|
if (ret)
|
|
func (cust, (gboolean)val);
|
|
|
|
return ret;
|
|
}
|
|
|
|
static gboolean
|
|
customer_name_handler (xmlNodePtr node, gpointer cust_pdata)
|
|
{
|
|
struct customer_pdata* pdata = static_cast<decltype (pdata)> (cust_pdata);
|
|
|
|
return set_string (node, pdata->customer, gncCustomerSetName);
|
|
}
|
|
|
|
static gboolean
|
|
customer_guid_handler (xmlNodePtr node, gpointer cust_pdata)
|
|
{
|
|
struct customer_pdata* pdata = static_cast<decltype (pdata)> (cust_pdata);
|
|
GncGUID* guid;
|
|
GncCustomer* cust;
|
|
|
|
guid = dom_tree_to_guid (node);
|
|
g_return_val_if_fail (guid, FALSE);
|
|
cust = gncCustomerLookup (pdata->book, guid);
|
|
if (cust)
|
|
{
|
|
gncCustomerDestroy (pdata->customer);
|
|
pdata->customer = cust;
|
|
gncCustomerBeginEdit (cust);
|
|
}
|
|
else
|
|
{
|
|
gncCustomerSetGUID (pdata->customer, guid);
|
|
}
|
|
|
|
g_free (guid);
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
static gboolean
|
|
customer_id_handler (xmlNodePtr node, gpointer cust_pdata)
|
|
{
|
|
struct customer_pdata* pdata = static_cast<decltype (pdata)> (cust_pdata);
|
|
|
|
return set_string (node, pdata->customer, gncCustomerSetID);
|
|
}
|
|
|
|
static gboolean
|
|
customer_notes_handler (xmlNodePtr node, gpointer cust_pdata)
|
|
{
|
|
struct customer_pdata* pdata = static_cast<decltype (pdata)> (cust_pdata);
|
|
|
|
return set_string (node, pdata->customer, gncCustomerSetNotes);
|
|
}
|
|
|
|
static gboolean
|
|
customer_terms_handler (xmlNodePtr node, gpointer cust_pdata)
|
|
{
|
|
struct customer_pdata* pdata = static_cast<decltype (pdata)> (cust_pdata);
|
|
GncGUID* guid;
|
|
GncBillTerm* term;
|
|
|
|
guid = dom_tree_to_guid (node);
|
|
g_return_val_if_fail (guid, FALSE);
|
|
term = gnc_billterm_xml_find_or_create (pdata->book, guid);
|
|
g_assert (term);
|
|
g_free (guid);
|
|
gncCustomerSetTerms (pdata->customer, term);
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
static gboolean
|
|
customer_addr_handler (xmlNodePtr node, gpointer cust_pdata)
|
|
{
|
|
struct customer_pdata* pdata = static_cast<decltype (pdata)> (cust_pdata);
|
|
|
|
return gnc_dom_tree_to_address (node, gncCustomerGetAddr (pdata->customer));
|
|
}
|
|
|
|
static gboolean
|
|
customer_shipaddr_handler (xmlNodePtr node, gpointer cust_pdata)
|
|
{
|
|
struct customer_pdata* pdata = static_cast<decltype (pdata)> (cust_pdata);
|
|
|
|
return gnc_dom_tree_to_address (node,
|
|
gncCustomerGetShipAddr (pdata->customer));
|
|
}
|
|
|
|
|
|
static gboolean
|
|
customer_taxincluded_handler (xmlNodePtr node, gpointer cust_pdata)
|
|
{
|
|
struct customer_pdata* pdata = static_cast<decltype (pdata)> (cust_pdata);
|
|
GncTaxIncluded type;
|
|
char* str;
|
|
gboolean ret;
|
|
|
|
str = dom_tree_to_text (node);
|
|
g_return_val_if_fail (str, FALSE);
|
|
|
|
ret = gncTaxIncludedStringToType (str, &type);
|
|
g_free (str);
|
|
|
|
if (ret)
|
|
gncCustomerSetTaxIncluded (pdata->customer, type);
|
|
|
|
return ret;
|
|
}
|
|
|
|
static gboolean
|
|
customer_active_handler (xmlNodePtr node, gpointer cust_pdata)
|
|
{
|
|
struct customer_pdata* pdata = static_cast<decltype (pdata)> (cust_pdata);
|
|
return set_boolean (node, pdata->customer, gncCustomerSetActive);
|
|
}
|
|
|
|
static gboolean
|
|
customer_discount_handler (xmlNodePtr node, gpointer cust_pdata)
|
|
{
|
|
struct customer_pdata* pdata = static_cast<decltype (pdata)> (cust_pdata);
|
|
gnc_numeric* val;
|
|
|
|
val = dom_tree_to_gnc_numeric (node);
|
|
g_return_val_if_fail (val, FALSE);
|
|
|
|
gncCustomerSetDiscount (pdata->customer, *val);
|
|
g_free (val);
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
static gboolean
|
|
customer_credit_handler (xmlNodePtr node, gpointer cust_pdata)
|
|
{
|
|
struct customer_pdata* pdata = static_cast<decltype (pdata)> (cust_pdata);
|
|
gnc_numeric* val;
|
|
|
|
val = dom_tree_to_gnc_numeric (node);
|
|
g_return_val_if_fail (val, FALSE);
|
|
|
|
gncCustomerSetCredit (pdata->customer, *val);
|
|
g_free (val);
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
static gboolean
|
|
customer_currency_handler (xmlNodePtr node, gpointer customer_pdata)
|
|
{
|
|
struct customer_pdata* pdata = static_cast<decltype (pdata)> (customer_pdata);
|
|
gnc_commodity* com;
|
|
|
|
com = dom_tree_to_commodity_ref (node, pdata->book);
|
|
g_return_val_if_fail (com, FALSE);
|
|
|
|
gncCustomerSetCurrency (pdata->customer, com);
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
static gboolean
|
|
customer_taxtable_handler (xmlNodePtr node, gpointer cust_pdata)
|
|
{
|
|
struct customer_pdata* pdata = static_cast<decltype (pdata)> (cust_pdata);
|
|
GncGUID* guid;
|
|
GncTaxTable* taxtable;
|
|
|
|
guid = dom_tree_to_guid (node);
|
|
g_return_val_if_fail (guid, FALSE);
|
|
taxtable = gncTaxTableLookup (pdata->book, guid);
|
|
if (!taxtable)
|
|
{
|
|
taxtable = gncTaxTableCreate (pdata->book);
|
|
gncTaxTableBeginEdit (taxtable);
|
|
gncTaxTableSetGUID (taxtable, guid);
|
|
gncTaxTableCommitEdit (taxtable);
|
|
}
|
|
else
|
|
gncTaxTableDecRef (taxtable);
|
|
|
|
gncCustomerSetTaxTable (pdata->customer, taxtable);
|
|
g_free (guid);
|
|
return TRUE;
|
|
}
|
|
|
|
static gboolean
|
|
customer_taxtableoverride_handler (xmlNodePtr node, gpointer cust_pdata)
|
|
{
|
|
struct customer_pdata* pdata = static_cast<decltype (pdata)> (cust_pdata);
|
|
return set_boolean (node, pdata->customer, gncCustomerSetTaxTableOverride);
|
|
}
|
|
|
|
static gboolean
|
|
customer_slots_handler (xmlNodePtr node, gpointer cust_pdata)
|
|
{
|
|
struct customer_pdata* pdata = static_cast<decltype (pdata)> (cust_pdata);
|
|
return dom_tree_create_instance_slots (node, QOF_INSTANCE (pdata->customer));
|
|
}
|
|
|
|
static struct dom_tree_handler customer_handlers_v2[] =
|
|
{
|
|
{ cust_name_string, customer_name_handler, 1, 0 },
|
|
{ cust_guid_string, customer_guid_handler, 1, 0 },
|
|
{ cust_id_string, customer_id_handler, 1, 0 },
|
|
{ cust_addr_string, customer_addr_handler, 1, 0 },
|
|
{ cust_shipaddr_string, customer_shipaddr_handler, 1, 0 },
|
|
{ cust_notes_string, customer_notes_handler, 0, 0 },
|
|
{ cust_terms_string, customer_terms_handler, 0, 0 },
|
|
{ cust_taxincluded_string, customer_taxincluded_handler, 1, 0 },
|
|
{ cust_active_string, customer_active_handler, 1, 0 },
|
|
{ cust_discount_string, customer_discount_handler, 1, 0 },
|
|
{ cust_credit_string, customer_credit_handler, 1, 0 },
|
|
{ cust_currency_string, customer_currency_handler, 0, 0 }, /* XXX */
|
|
{ "cust:commodity", customer_currency_handler, 0, 0 }, /* XXX */
|
|
{ cust_taxtable_string, customer_taxtable_handler, 0, 0 },
|
|
{ cust_taxtableoverride_string, customer_taxtableoverride_handler, 0, 0 },
|
|
{ cust_slots_string, customer_slots_handler, 0, 0 },
|
|
{ NULL, 0, 0, 0 }
|
|
};
|
|
|
|
static GncCustomer*
|
|
dom_tree_to_customer (xmlNodePtr node, QofBook* book)
|
|
{
|
|
struct customer_pdata cust_pdata;
|
|
gboolean successful;
|
|
|
|
cust_pdata.customer = gncCustomerCreate (book);
|
|
cust_pdata.book = book;
|
|
gncCustomerBeginEdit (cust_pdata.customer);
|
|
|
|
successful = dom_tree_generic_parse (node, customer_handlers_v2,
|
|
&cust_pdata);
|
|
|
|
if (successful)
|
|
gncCustomerCommitEdit (cust_pdata.customer);
|
|
else
|
|
{
|
|
PERR ("failed to parse customer tree");
|
|
gncCustomerDestroy (cust_pdata.customer);
|
|
cust_pdata.customer = NULL;
|
|
}
|
|
|
|
return cust_pdata.customer;
|
|
}
|
|
|
|
static gboolean
|
|
gnc_customer_end_handler (gpointer data_for_children,
|
|
GSList* data_from_children, GSList* sibling_data,
|
|
gpointer parent_data, gpointer global_data,
|
|
gpointer* result, const gchar* tag)
|
|
{
|
|
GncCustomer* cust;
|
|
xmlNodePtr tree = (xmlNodePtr)data_for_children;
|
|
gxpf_data* gdata = (gxpf_data*)global_data;
|
|
QofBook* book = static_cast<decltype (book)> (gdata->bookdata);
|
|
|
|
|
|
if (parent_data)
|
|
{
|
|
return TRUE;
|
|
}
|
|
|
|
/* OK. For some messed up reason this is getting called again with a
|
|
NULL tag. So we ignore those cases */
|
|
if (!tag)
|
|
{
|
|
return TRUE;
|
|
}
|
|
|
|
g_return_val_if_fail (tree, FALSE);
|
|
|
|
cust = dom_tree_to_customer (tree, book);
|
|
if (cust != NULL)
|
|
{
|
|
gdata->cb (tag, gdata->parsedata, cust);
|
|
}
|
|
|
|
xmlFreeNode (tree);
|
|
|
|
return cust != NULL;
|
|
}
|
|
|
|
static sixtp*
|
|
customer_sixtp_parser_create (void)
|
|
{
|
|
return sixtp_dom_parser_new (gnc_customer_end_handler, NULL, NULL);
|
|
}
|
|
|
|
static gboolean
|
|
customer_should_be_saved (GncCustomer* customer)
|
|
{
|
|
const char* id;
|
|
|
|
/* make sure this is a valid customer before we save it -- should have an ID */
|
|
id = gncCustomerGetID (customer);
|
|
if (id == NULL || *id == '\0')
|
|
return FALSE;
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
static void
|
|
do_count (QofInstance* cust_p, gpointer count_p)
|
|
{
|
|
int* count = static_cast<decltype (count)> (count_p);
|
|
if (customer_should_be_saved ((GncCustomer*)cust_p))
|
|
(*count)++;
|
|
}
|
|
|
|
static int
|
|
customer_get_count (QofBook* book)
|
|
{
|
|
int count = 0;
|
|
qof_object_foreach (_GNC_MOD_NAME, book, do_count, (gpointer) &count);
|
|
return count;
|
|
}
|
|
|
|
static void
|
|
xml_add_customer (QofInstance* cust_p, gpointer out_p)
|
|
{
|
|
xmlNodePtr node;
|
|
GncCustomer* cust = (GncCustomer*) cust_p;
|
|
FILE* out = static_cast<decltype (out)> (out_p);
|
|
|
|
if (ferror (out))
|
|
return;
|
|
if (!customer_should_be_saved (cust))
|
|
return;
|
|
|
|
node = customer_dom_tree_create (cust);
|
|
xmlElemDump (out, NULL, node);
|
|
xmlFreeNode (node);
|
|
if (ferror (out) || fprintf (out, "\n") < 0)
|
|
return;
|
|
}
|
|
|
|
static gboolean
|
|
customer_write (FILE* out, QofBook* book)
|
|
{
|
|
qof_object_foreach_sorted (_GNC_MOD_NAME, book, xml_add_customer,
|
|
(gpointer) out);
|
|
return ferror (out) == 0;
|
|
}
|
|
|
|
static gboolean
|
|
customer_ns (FILE* out)
|
|
{
|
|
g_return_val_if_fail (out, FALSE);
|
|
return gnc_xml2_write_namespace_decl (out, "cust");
|
|
}
|
|
|
|
void
|
|
gnc_customer_xml_initialize (void)
|
|
{
|
|
static GncXmlDataType_t be_data =
|
|
{
|
|
GNC_FILE_BACKEND_VERS,
|
|
gnc_customer_string,
|
|
customer_sixtp_parser_create,
|
|
NULL, /* add_item */
|
|
customer_get_count,
|
|
customer_write,
|
|
NULL, /* scrub */
|
|
customer_ns,
|
|
};
|
|
|
|
gnc_xml_register_backend (be_data);
|
|
}
|