28 #include "gncBillTermP.h" 32 #include "gnc-xml-helper.h" 35 #include "sixtp-utils.h" 36 #include "sixtp-parsers.h" 37 #include "sixtp-utils.h" 38 #include "sixtp-dom-parsers.h" 39 #include "sixtp-dom-generators.h" 42 #include "io-gncxml-gen.h" 44 #include "gnc-bill-term-xml-v2.h" 46 #include "xml-helpers.h" 48 #define _GNC_MOD_NAME GNC_ID_BILLTERM 50 static QofLogModule log_module = GNC_MOD_IO;
52 const gchar* billterm_version_string =
"2.0.0";
55 #define gnc_billterm_string "gnc:GncBillTerm" 56 #define billterm_guid_string "billterm:guid" 57 #define billterm_name_string "billterm:name" 58 #define billterm_desc_string "billterm:desc" 59 #define billterm_refcount_string "billterm:refcount" 60 #define billterm_invisible_string "billterm:invisible" 61 #define billterm_parent_string "billterm:parent" 62 #define billterm_child_string "billterm:child" 63 #define billterm_slots_string "billterm:slots" 65 #define gnc_daystype_string "billterm:days" 66 #define days_duedays_string "bt-days:due-days" 67 #define days_discdays_string "bt-days:disc-days" 68 #define days_discount_string "bt-days:discount" 70 #define gnc_proximotype_string "billterm:proximo" 71 #define prox_dueday_string "bt-prox:due-day" 72 #define prox_discday_string "bt-prox:disc-day" 73 #define prox_discount_string "bt-prox:discount" 74 #define prox_cutoff_string "bt-prox:cutoff-day" 77 billterm_dom_tree_create (GncBillTerm* term)
81 ret = xmlNewNode (NULL, BAD_CAST gnc_billterm_string);
82 xmlSetProp (ret, BAD_CAST
"version", BAD_CAST billterm_version_string);
84 maybe_add_guid (ret, billterm_guid_string, QOF_INSTANCE (term));
85 xmlAddChild (ret, text_to_dom_tree (billterm_name_string,
86 gncBillTermGetName (term)));
87 xmlAddChild (ret, text_to_dom_tree (billterm_desc_string,
88 gncBillTermGetDescription (term)));
90 xmlAddChild (ret, int_to_dom_tree (billterm_refcount_string,
91 gncBillTermGetRefcount (term)));
92 xmlAddChild (ret, int_to_dom_tree (billterm_invisible_string,
93 gncBillTermGetInvisible (term)));
96 xmlAddChild (ret, qof_instance_slots_to_dom_tree (billterm_slots_string,
97 QOF_INSTANCE (term)));
100 if (gncBillTermGetChild (term) != term)
101 maybe_add_guid (ret, billterm_child_string,
102 QOF_INSTANCE (gncBillTermGetChild (term)));
104 maybe_add_guid (ret, billterm_parent_string,
105 QOF_INSTANCE (gncBillTermGetParent (term)));
107 switch (gncBillTermGetType (term))
109 case GNC_TERM_TYPE_DAYS:
110 data = xmlNewChild (ret, NULL, BAD_CAST gnc_daystype_string, NULL);
111 maybe_add_int (data, days_duedays_string, gncBillTermGetDueDays (term));
112 maybe_add_int (data, days_discdays_string,
113 gncBillTermGetDiscountDays (term));
114 maybe_add_numeric (data, days_discount_string,
115 gncBillTermGetDiscount (term));
118 case GNC_TERM_TYPE_PROXIMO:
119 data = xmlNewChild (ret, NULL, BAD_CAST gnc_proximotype_string, NULL);
120 maybe_add_int (data, prox_dueday_string, gncBillTermGetDueDays (term));
121 maybe_add_int (data, prox_discday_string,
122 gncBillTermGetDiscountDays (term));
123 maybe_add_numeric (data, prox_discount_string,
124 gncBillTermGetDiscount (term));
125 maybe_add_int (data, prox_cutoff_string, gncBillTermGetCutoff (term));
141 set_int (xmlNodePtr node, GncBillTerm* term,
142 void (*func) (GncBillTerm*, gint))
145 dom_tree_to_integer (node, &val);
151 set_numeric (xmlNodePtr node, GncBillTerm* term,
152 void (*func) (GncBillTerm*, gnc_numeric))
154 func (term, dom_tree_to_gnc_numeric (node));
164 return set_int (node, pdata->term, gncBillTermSetDueDays);
171 return set_int (node, pdata->term, gncBillTermSetDiscountDays);
178 return set_numeric (node, pdata->term, gncBillTermSetDiscount);
183 { days_duedays_string, days_duedays_handler, 0, 0 },
184 { days_discdays_string, days_discdays_handler, 0, 0 },
185 { days_discount_string, days_discount_handler, 0, 0 },
190 dom_tree_to_days_data (xmlNodePtr node,
struct billterm_pdata* pdata)
194 successful = dom_tree_generic_parse (node, days_data_handlers_v2, pdata);
197 PERR (
"failed to parse billing term days data");
208 return set_int (node, pdata->term, gncBillTermSetDueDays);
215 return set_int (node, pdata->term, gncBillTermSetDiscountDays);
222 return set_numeric (node, pdata->term, gncBillTermSetDiscount);
229 return set_int (node, pdata->term, gncBillTermSetCutoff);
234 { prox_dueday_string, prox_dueday_handler, 0, 0 },
235 { prox_discday_string, prox_discday_handler, 0, 0 },
236 { prox_discount_string, prox_discount_handler, 0, 0 },
237 { prox_cutoff_string, prox_cutoff_handler, 0, 0 },
242 dom_tree_to_prox_data (xmlNodePtr node,
struct billterm_pdata* pdata)
246 successful = dom_tree_generic_parse (node, prox_data_handlers_v2, pdata);
249 PERR (
"failed to parse billing term prox data");
258 void (*func) (GncBillTerm*, GncBillTerm*))
263 guid = dom_tree_to_guid (node);
264 g_return_val_if_fail (guid, FALSE);
265 term = gncBillTermLookup (pdata->book, guid);
268 term = gncBillTermCreate (pdata->book);
269 gncBillTermBeginEdit (term);
270 gncBillTermSetGUID (term, guid);
271 gncBillTermCommitEdit (term);
274 g_return_val_if_fail (term, FALSE);
275 func (pdata->term, term);
281 set_string (xmlNodePtr node, GncBillTerm* term,
282 void (*func) (GncBillTerm*,
const char*))
284 char* txt = dom_tree_to_text (node);
285 g_return_val_if_fail (txt, FALSE);
298 guid = dom_tree_to_guid (node);
299 g_return_val_if_fail (guid, FALSE);
300 term = gncBillTermLookup (pdata->book, guid);
303 gncBillTermDestroy (pdata->term);
305 gncBillTermBeginEdit (term);
309 gncBillTermSetGUID (pdata->term, guid);
321 return set_string (node, pdata->term, gncBillTermSetName);
328 return set_string (node, pdata->term, gncBillTermSetDescription);
332 billterm_refcount_handler (xmlNodePtr node, gpointer
billterm_pdata)
337 dom_tree_to_integer (node, &val);
338 gncBillTermSetRefcount (pdata->term, val);
343 billterm_invisible_handler (xmlNodePtr node, gpointer
billterm_pdata)
348 dom_tree_to_integer (node, &val);
350 gncBillTermMakeInvisible (pdata->term);
355 billterm_parent_handler (xmlNodePtr node, gpointer
billterm_pdata)
358 return set_parent_child (node, pdata, gncBillTermSetParent);
365 return set_parent_child (node, pdata, gncBillTermSetChild);
369 billterm_days_data_handler (xmlNodePtr node, gpointer
billterm_pdata)
373 g_return_val_if_fail (node, FALSE);
374 g_return_val_if_fail (gncBillTermGetType (pdata->term) == 0, FALSE);
376 gncBillTermSetType (pdata->term, GNC_TERM_TYPE_DAYS);
377 return dom_tree_to_days_data (node, pdata);
381 billterm_prox_data_handler (xmlNodePtr node, gpointer
billterm_pdata)
385 g_return_val_if_fail (node, FALSE);
386 g_return_val_if_fail (gncBillTermGetType (pdata->term) == 0, FALSE);
388 gncBillTermSetType (pdata->term, GNC_TERM_TYPE_PROXIMO);
389 return dom_tree_to_prox_data (node, pdata);
396 return dom_tree_create_instance_slots (node, QOF_INSTANCE (pdata->term));
401 { billterm_guid_string, billterm_guid_handler, 1, 0 },
402 { billterm_name_string, billterm_name_handler, 1, 0 },
403 { billterm_desc_string, billterm_desc_handler, 1, 0 },
404 { billterm_refcount_string, billterm_refcount_handler, 1, 0 },
405 { billterm_invisible_string, billterm_invisible_handler, 1, 0 },
406 { billterm_parent_string, billterm_parent_handler, 0, 0 },
407 { billterm_child_string, billterm_child_handler, 0, 0 },
408 { billterm_slots_string, billterm_slots_handler, 0, 0 },
409 { gnc_daystype_string, billterm_days_data_handler, 0, 0 },
410 { gnc_proximotype_string, billterm_prox_data_handler, 0, 0 },
415 dom_tree_to_billterm (xmlNodePtr node, QofBook* book)
424 successful = dom_tree_generic_parse (node, billterm_handlers_v2,
433 PERR (
"failed to parse billing term tree");
442 gnc_billterm_end_handler (gpointer data_for_children,
443 GSList* data_from_children, GSList* sibling_data,
444 gpointer parent_data, gpointer global_data,
445 gpointer* result,
const gchar* tag)
448 xmlNodePtr tree = (xmlNodePtr)data_for_children;
449 gxpf_data* gdata = (gxpf_data*)global_data;
450 QofBook* book =
static_cast<decltype (book)
> (gdata->bookdata);
465 g_return_val_if_fail (tree, FALSE);
467 term = dom_tree_to_billterm (tree, book);
470 gdata->cb (tag, gdata->parsedata, term);
479 billterm_sixtp_parser_create (
void)
481 return sixtp_dom_parser_new (gnc_billterm_end_handler, NULL, NULL);
487 int* count =
static_cast<decltype (count)
> (count_p);
492 billterm_get_count (QofBook* book)
500 xml_add_billterm (
QofInstance* term_p, gpointer out_p)
503 GncBillTerm* term = (GncBillTerm*) term_p;
504 FILE* out =
static_cast<decltype (out)
> (out_p);
509 node = billterm_dom_tree_create (term);
510 xmlElemDump (out, NULL, node);
512 if (ferror (out) || fprintf (out,
"\n") < 0)
517 billterm_write (FILE* out, QofBook* book)
521 return ferror (out) == 0;
525 billterm_is_grandchild (GncBillTerm* term)
527 return (gncBillTermGetParent (gncBillTermGetParent (term)) != NULL);
531 billterm_find_senior (GncBillTerm* term)
533 GncBillTerm* temp, *parent, *gp = NULL;
539 parent = gncBillTermGetParent (temp);
542 gp = gncBillTermGetParent (parent);
559 g_assert (gp == NULL);
567 billterm_scrub_cb (
QofInstance* term_p, gpointer list_p)
569 GncBillTerm* term = GNC_BILLTERM (term_p);
570 GList** list =
static_cast<decltype (list)
> (list_p);
572 if (billterm_is_grandchild (term))
574 *list = g_list_prepend (*list, term);
577 else if (!gncBillTermGetType (term))
579 GncBillTerm* t = gncBillTermGetParent (term);
585 PWARN (
"Fixing broken child billterm: %s", guidstr);
587 gncBillTermBeginEdit (term);
588 gncBillTermSetType (term, gncBillTermGetType (t));
589 gncBillTermSetDueDays (term, gncBillTermGetDueDays (t));
590 gncBillTermSetDiscountDays (term, gncBillTermGetDiscountDays (t));
591 gncBillTermSetDiscount (term, gncBillTermGetDiscount (t));
592 gncBillTermSetCutoff (term, gncBillTermGetCutoff (t));
593 gncBillTermCommitEdit (term);
599 *list = g_list_prepend (*list, term);
608 billterm_scrub_invoices (
QofInstance* invoice_p, gpointer ht_p)
610 GHashTable* ht =
static_cast<decltype (ht)
> (ht_p);
611 GncInvoice* invoice = GNC_INVOICE (invoice_p);
612 GncBillTerm* term, *new_bt;
615 term = gncInvoiceGetTerms (invoice);
618 if (billterm_is_grandchild (term))
622 PWARN (
"Fixing i-billterm on invoice %s\n", guidstr);
623 new_bt = billterm_find_senior (term);
624 gncInvoiceBeginEdit (invoice);
625 gncInvoiceSetTerms (invoice, new_bt);
626 gncInvoiceCommitEdit (invoice);
631 count = GPOINTER_TO_INT (g_hash_table_lookup (ht, term));
633 g_hash_table_insert (ht, term, GINT_TO_POINTER (count));
639 billterm_scrub_cust (
QofInstance* cust_p, gpointer ht_p)
641 GHashTable* ht =
static_cast<decltype (ht)
> (ht_p);
646 term = gncCustomerGetTerms (cust);
649 count = GPOINTER_TO_INT (g_hash_table_lookup (ht, term));
651 g_hash_table_insert (ht, term, GINT_TO_POINTER (count));
652 if (billterm_is_grandchild (term))
658 PWARN (
"customer %s has grandchild billterm %s\n", custstr, termstr);
664 billterm_scrub_vendor (
QofInstance* vendor_p, gpointer ht_p)
666 GHashTable* ht =
static_cast<decltype (ht)
> (ht_p);
667 GncVendor* vendor = GNC_VENDOR (vendor_p);
671 term = gncVendorGetTerms (vendor);
674 count = GPOINTER_TO_INT (g_hash_table_lookup (ht, term));
676 g_hash_table_insert (ht, term, GINT_TO_POINTER (count));
677 if (billterm_is_grandchild (term))
683 PWARN (
"vendor %s has grandchild billterm %s\n", vendstr, termstr);
689 billterm_reset_refcount (gpointer key, gpointer value, gpointer notused)
691 GncBillTerm* term =
static_cast<decltype (term)
> (key);
692 gint32 count = GPOINTER_TO_INT (value);
694 if (count != gncBillTermGetRefcount (term) && !gncBillTermGetInvisible (term))
698 PWARN (
"Fixing refcount on billterm %s (%" G_GINT64_FORMAT
" -> %d)\n",
699 termstr, gncBillTermGetRefcount (term), count);
700 gncBillTermSetRefcount (term, count);
705 billterm_scrub (QofBook* book)
709 GncBillTerm* parent, *term;
710 GHashTable* ht = g_hash_table_new (g_direct_hash, g_direct_equal);
712 DEBUG (
"scrubbing billterms...");
719 for (node = list; node; node = node->next)
722 term =
static_cast<decltype (term)
> (node->data);
725 PWARN (
"deleting grandchild billterm: %s\n", termstr);
728 parent = gncBillTermGetParent (term);
729 gncBillTermSetChild (parent, NULL);
732 gncBillTermBeginEdit (term);
733 gncBillTermDestroy (term);
737 g_hash_table_foreach (ht, billterm_reset_refcount, NULL);
740 g_hash_table_destroy (ht);
744 billterm_ns (FILE* out)
746 g_return_val_if_fail (out, FALSE);
748 gnc_xml2_write_namespace_decl (out,
"billterm")
749 && gnc_xml2_write_namespace_decl (out,
"bt-days")
750 && gnc_xml2_write_namespace_decl (out,
"bt-prox");
754 gnc_billterm_xml_initialize (
void)
756 static GncXmlDataType_t be_data =
758 GNC_FILE_BACKEND_VERS,
760 billterm_sixtp_parser_create,
768 gnc_xml_register_backend(be_data);
772 gnc_billterm_xml_find_or_create (QofBook* book,
GncGUID* guid)
778 g_return_val_if_fail (book, NULL);
779 g_return_val_if_fail (guid, NULL);
780 term = gncBillTermLookup (book, guid);
781 DEBUG (
"looking for billterm %s, found %p", guidstr, term);
784 term = gncBillTermCreate (book);
785 gncBillTermBeginEdit (term);
786 gncBillTermSetGUID (term, guid);
787 gncBillTermCommitEdit (term);
788 DEBUG (
"Created term: %p", term);
791 gncBillTermDecRef (term);
const GncGUID * qof_instance_get_guid(gconstpointer inst)
Return the GncGUID of this instance.
#define DEBUG(format, args...)
Print a debugging message.
gchar * guid_to_string_buff(const GncGUID *guid, gchar *str)
The guid_to_string_buff() routine puts a null-terminated string encoding of the id into the memory po...
#define PERR(format, args...)
Log a serious error.
#define PWARN(format, args...)
Log a warning.
void qof_object_foreach_sorted(QofIdTypeConst type_name, QofBook *book, QofInstanceForeachCB cb, gpointer user_data)
Invoke callback 'cb' on each instance in guid orted order.
api for GnuCash version 2 XML-based file format
#define GUID_ENCODING_LENGTH
Number of characters needed to encode a guid as a string not including the null terminator.
void qof_object_foreach(QofIdTypeConst type_name, QofBook *book, QofInstanceForeachCB cb, gpointer user_data)
Invoke the callback 'cb' on every instance ov a particular object type.
credit, discount and shipaddr are unique to GncCustomer id, name, notes, terms, addr, currency, taxtable, taxtable_override taxincluded, active and jobs are identical to ::GncVendor.
Business Invoice Interface.
The type used to store guids in C.