LCOV - code coverage report
Current view: top level - libgnucash/backend/xml - gnc-employee-xml-v2.cpp (source / functions) Coverage Total Hit
Test: gnucash.info Lines: 9.6 % 156 15
Test Date: 2025-02-07 16:25:45 Functions: 20.0 % 25 5
Legend: Lines: hit not hit | Branches: + taken - not taken # not executed Branches: - 0 0

             Branch data     Line data    Source code
       1                 :             : /********************************************************************\
       2                 :             :  * gnc-employee-xml-v2.c -- employee xml i/o implementation         *
       3                 :             :  *                                                                  *
       4                 :             :  * Copyright (C) 2002 Derek Atkins <warlord@MIT.EDU>                *
       5                 :             :  *                                                                  *
       6                 :             :  * This program is free software; you can redistribute it and/or    *
       7                 :             :  * modify it under the terms of the GNU General Public License as   *
       8                 :             :  * published by the Free Software Foundation; either version 2 of   *
       9                 :             :  * the License, or (at your option) any later version.              *
      10                 :             :  *                                                                  *
      11                 :             :  * This program is distributed in the hope that it will be useful,  *
      12                 :             :  * but WITHOUT ANY WARRANTY; without even the implied warranty of   *
      13                 :             :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the    *
      14                 :             :  * GNU General Public License for more details.                     *
      15                 :             :  *                                                                  *
      16                 :             :  * You should have received a copy of the GNU General Public License*
      17                 :             :  * along with this program; if not, contact:                        *
      18                 :             :  *                                                                  *
      19                 :             :  * Free Software Foundation           Voice:  +1-617-542-5942       *
      20                 :             :  * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
      21                 :             :  * Boston, MA  02110-1301,  USA       gnu@gnu.org                   *
      22                 :             :  *                                                                  *
      23                 :             : \********************************************************************/
      24                 :             : #include <glib.h>
      25                 :             : 
      26                 :             : #include <config.h>
      27                 :             : #include <stdlib.h>
      28                 :             : #include <string.h>
      29                 :             : #include "gncEmployeeP.h"
      30                 :             : #include "gnc-xml-helper.h"
      31                 :             : #include "sixtp.h"
      32                 :             : #include "sixtp-utils.h"
      33                 :             : #include "sixtp-parsers.h"
      34                 :             : #include "sixtp-utils.h"
      35                 :             : #include "sixtp-dom-parsers.h"
      36                 :             : #include "sixtp-dom-generators.h"
      37                 :             : 
      38                 :             : #include "gnc-xml.h"
      39                 :             : #include "io-gncxml-gen.h"
      40                 :             : #include "io-gncxml-v2.h"
      41                 :             : 
      42                 :             : #include "gnc-employee-xml-v2.h"
      43                 :             : #include "gnc-address-xml-v2.h"
      44                 :             : 
      45                 :             : #define _GNC_MOD_NAME   GNC_ID_EMPLOYEE
      46                 :             : 
      47                 :             : static QofLogModule log_module = GNC_MOD_IO;
      48                 :             : 
      49                 :             : const gchar* employee_version_string = "2.0.0";
      50                 :             : 
      51                 :             : /* ids */
      52                 :             : #define gnc_employee_string "gnc:GncEmployee"
      53                 :             : #define employee_username_string "employee:username"
      54                 :             : #define employee_guid_string "employee:guid"
      55                 :             : #define employee_id_string "employee:id"
      56                 :             : #define employee_addr_string "employee:addr"
      57                 :             : #define employee_language_string "employee:language"
      58                 :             : #define employee_acl_string "employee:acl"
      59                 :             : #define employee_active_string "employee:active"
      60                 :             : #define employee_workday_string "employee:workday"
      61                 :             : #define employee_rate_string "employee:rate"
      62                 :             : #define employee_currency_string "employee:currency"
      63                 :             : #define employee_ccard_string "employee:ccard"
      64                 :             : #define employee_slots_string "employee:slots"
      65                 :             : 
      66                 :             : static void
      67                 :           0 : maybe_add_string (xmlNodePtr ptr, const char* tag, const char* str)
      68                 :             : {
      69                 :           0 :     if (str && *str)
      70                 :           0 :         xmlAddChild (ptr, text_to_dom_tree (tag, str));
      71                 :           0 : }
      72                 :             : 
      73                 :             : static xmlNodePtr
      74                 :           0 : employee_dom_tree_create (GncEmployee* employee)
      75                 :             : {
      76                 :             :     xmlNodePtr ret;
      77                 :             :     gnc_numeric num;
      78                 :             :     Account* ccard_acc;
      79                 :             : 
      80                 :           0 :     ret = xmlNewNode (NULL, BAD_CAST gnc_employee_string);
      81                 :           0 :     xmlSetProp (ret, BAD_CAST "version", BAD_CAST employee_version_string);
      82                 :             : 
      83                 :           0 :     xmlAddChild (ret, guid_to_dom_tree (employee_guid_string,
      84                 :           0 :                                         qof_instance_get_guid (QOF_INSTANCE (employee))));
      85                 :             : 
      86                 :           0 :     xmlAddChild (ret, text_to_dom_tree (employee_username_string,
      87                 :             :                                         gncEmployeeGetUsername (employee)));
      88                 :             : 
      89                 :           0 :     xmlAddChild (ret, text_to_dom_tree (employee_id_string,
      90                 :             :                                         gncEmployeeGetID (employee)));
      91                 :             : 
      92                 :           0 :     xmlAddChild (ret, gnc_address_to_dom_tree (employee_addr_string,
      93                 :             :                                                gncEmployeeGetAddr (employee)));
      94                 :             : 
      95                 :           0 :     maybe_add_string (ret, employee_language_string,
      96                 :             :                       gncEmployeeGetLanguage (employee));
      97                 :           0 :     maybe_add_string (ret, employee_acl_string, gncEmployeeGetAcl (employee));
      98                 :             : 
      99                 :           0 :     xmlAddChild (ret, int_to_dom_tree (employee_active_string,
     100                 :           0 :                                        gncEmployeeGetActive (employee)));
     101                 :             : 
     102                 :           0 :     num = gncEmployeeGetWorkday (employee);
     103                 :           0 :     xmlAddChild (ret, gnc_numeric_to_dom_tree (employee_workday_string, &num));
     104                 :             : 
     105                 :           0 :     num = gncEmployeeGetRate (employee);
     106                 :           0 :     xmlAddChild (ret, gnc_numeric_to_dom_tree (employee_rate_string, &num));
     107                 :             : 
     108                 :             :     xmlAddChild
     109                 :           0 :     (ret,
     110                 :             :      commodity_ref_to_dom_tree (employee_currency_string,
     111                 :           0 :                                 gncEmployeeGetCurrency (employee)));
     112                 :             : 
     113                 :           0 :     ccard_acc = gncEmployeeGetCCard (employee);
     114                 :           0 :     if (ccard_acc)
     115                 :           0 :         xmlAddChild (ret, guid_to_dom_tree (employee_ccard_string,
     116                 :           0 :                                             qof_instance_get_guid (QOF_INSTANCE (ccard_acc))));
     117                 :             : 
     118                 :             :     /* xmlAddChild won't do anything with a NULL, so tests are superfluous. */
     119                 :           0 :     xmlAddChild (ret, qof_instance_slots_to_dom_tree (employee_slots_string,
     120                 :           0 :                                                       QOF_INSTANCE (employee)));
     121                 :           0 :     return ret;
     122                 :             : }
     123                 :             : 
     124                 :             : /***********************************************************************/
     125                 :             : 
     126                 :             : struct employee_pdata
     127                 :             : {
     128                 :             :     GncEmployee* employee;
     129                 :             :     QofBook* book;
     130                 :             : };
     131                 :             : 
     132                 :             : static gboolean
     133                 :           0 : set_string (xmlNodePtr node, GncEmployee* employee,
     134                 :             :             void (*func) (GncEmployee* employee, const char* txt))
     135                 :             : {
     136                 :           0 :     char* txt = dom_tree_to_text (node);
     137                 :           0 :     g_return_val_if_fail (txt, FALSE);
     138                 :             : 
     139                 :           0 :     func (employee, txt);
     140                 :             : 
     141                 :           0 :     g_free (txt);
     142                 :             : 
     143                 :           0 :     return TRUE;
     144                 :             : }
     145                 :             : 
     146                 :             : static gboolean
     147                 :           0 : employee_username_handler (xmlNodePtr node, gpointer employee_pdata)
     148                 :             : {
     149                 :           0 :     struct employee_pdata* pdata = static_cast<decltype (pdata)> (employee_pdata);
     150                 :             : 
     151                 :           0 :     return set_string (node, pdata->employee, gncEmployeeSetUsername);
     152                 :             : }
     153                 :             : 
     154                 :             : static gboolean
     155                 :           0 : employee_guid_handler (xmlNodePtr node, gpointer employee_pdata)
     156                 :             : {
     157                 :           0 :     struct employee_pdata* pdata = static_cast<decltype (pdata)> (employee_pdata);
     158                 :             :     GncGUID* guid;
     159                 :             :     GncEmployee* employee;
     160                 :             : 
     161                 :           0 :     guid = dom_tree_to_guid (node);
     162                 :           0 :     g_return_val_if_fail (guid, FALSE);
     163                 :             : 
     164                 :             :     /* See if we've already created this one */
     165                 :           0 :     employee = gncEmployeeLookup (pdata->book, guid);
     166                 :           0 :     if (employee)
     167                 :             :     {
     168                 :           0 :         gncEmployeeDestroy (pdata->employee);
     169                 :           0 :         pdata->employee = employee;
     170                 :           0 :         gncEmployeeBeginEdit (employee);
     171                 :             :     }
     172                 :             :     else
     173                 :             :     {
     174                 :           0 :         gncEmployeeSetGUID (pdata->employee, guid);
     175                 :             :     }
     176                 :             : 
     177                 :           0 :     guid_free (guid);
     178                 :             : 
     179                 :           0 :     return TRUE;
     180                 :             : }
     181                 :             : 
     182                 :             : static gboolean
     183                 :           0 : employee_id_handler (xmlNodePtr node, gpointer employee_pdata)
     184                 :             : {
     185                 :           0 :     struct employee_pdata* pdata = static_cast<decltype (pdata)> (employee_pdata);
     186                 :             : 
     187                 :           0 :     return set_string (node, pdata->employee, gncEmployeeSetID);
     188                 :             : }
     189                 :             : 
     190                 :             : static gboolean
     191                 :           0 : employee_language_handler (xmlNodePtr node, gpointer employee_pdata)
     192                 :             : {
     193                 :           0 :     struct employee_pdata* pdata = static_cast<decltype (pdata)> (employee_pdata);
     194                 :             : 
     195                 :           0 :     return set_string (node, pdata->employee, gncEmployeeSetLanguage);
     196                 :             : }
     197                 :             : 
     198                 :             : static gboolean
     199                 :           0 : employee_acl_handler (xmlNodePtr node, gpointer employee_pdata)
     200                 :             : {
     201                 :           0 :     struct employee_pdata* pdata = static_cast<decltype (pdata)> (employee_pdata);
     202                 :             : 
     203                 :           0 :     return set_string (node, pdata->employee, gncEmployeeSetAcl);
     204                 :             : }
     205                 :             : 
     206                 :             : static gboolean
     207                 :           0 : employee_addr_handler (xmlNodePtr node, gpointer employee_pdata)
     208                 :             : {
     209                 :           0 :     struct employee_pdata* pdata = static_cast<decltype (pdata)> (employee_pdata);
     210                 :             : 
     211                 :           0 :     return gnc_dom_tree_to_address (node, gncEmployeeGetAddr (pdata->employee));
     212                 :             : }
     213                 :             : 
     214                 :             : static gboolean
     215                 :           0 : employee_active_handler (xmlNodePtr node, gpointer employee_pdata)
     216                 :             : {
     217                 :           0 :     struct employee_pdata* pdata = static_cast<decltype (pdata)> (employee_pdata);
     218                 :             :     gint64 val;
     219                 :             :     gboolean ret;
     220                 :             : 
     221                 :           0 :     ret = dom_tree_to_integer (node, &val);
     222                 :           0 :     if (ret)
     223                 :           0 :         gncEmployeeSetActive (pdata->employee, (gboolean)val);
     224                 :             : 
     225                 :           0 :     return ret;
     226                 :             : }
     227                 :             : 
     228                 :             : static gboolean
     229                 :           0 : employee_workday_handler (xmlNodePtr node, gpointer employee_pdata)
     230                 :             : {
     231                 :           0 :     struct employee_pdata* pdata = static_cast<decltype (pdata)> (employee_pdata);
     232                 :             : 
     233                 :           0 :     gncEmployeeSetWorkday (pdata->employee, dom_tree_to_gnc_numeric (node));
     234                 :           0 :     return TRUE;
     235                 :             : }
     236                 :             : 
     237                 :             : static gboolean
     238                 :           0 : employee_rate_handler (xmlNodePtr node, gpointer employee_pdata)
     239                 :             : {
     240                 :           0 :     struct employee_pdata* pdata = static_cast<decltype (pdata)> (employee_pdata);
     241                 :             : 
     242                 :           0 :     gncEmployeeSetRate (pdata->employee, dom_tree_to_gnc_numeric (node));
     243                 :           0 :     return TRUE;
     244                 :             : }
     245                 :             : 
     246                 :             : static gboolean
     247                 :           0 : employee_currency_handler (xmlNodePtr node, gpointer employee_pdata)
     248                 :             : {
     249                 :           0 :     struct employee_pdata* pdata = static_cast<decltype (pdata)> (employee_pdata);
     250                 :             :     gnc_commodity* com;
     251                 :             : 
     252                 :           0 :     com = dom_tree_to_commodity_ref (node, pdata->book);
     253                 :           0 :     g_return_val_if_fail (com, FALSE);
     254                 :             : 
     255                 :           0 :     gncEmployeeSetCurrency (pdata->employee, com);
     256                 :             : 
     257                 :           0 :     return TRUE;
     258                 :             : }
     259                 :             : 
     260                 :             : static gboolean
     261                 :           0 : employee_ccard_handler (xmlNodePtr node, gpointer employee_pdata)
     262                 :             : {
     263                 :           0 :     struct employee_pdata* pdata = static_cast<decltype (pdata)> (employee_pdata);
     264                 :             :     GncGUID* guid;
     265                 :             :     Account* ccard_acc;
     266                 :             : 
     267                 :           0 :     guid = dom_tree_to_guid (node);
     268                 :           0 :     g_return_val_if_fail (guid, FALSE);
     269                 :             : 
     270                 :           0 :     ccard_acc = xaccAccountLookup (guid, pdata->book);
     271                 :           0 :     guid_free (guid);
     272                 :             : 
     273                 :           0 :     g_return_val_if_fail (ccard_acc, FALSE);
     274                 :           0 :     gncEmployeeSetCCard (pdata->employee, ccard_acc);
     275                 :             : 
     276                 :           0 :     return TRUE;
     277                 :             : }
     278                 :             : 
     279                 :             : static gboolean
     280                 :           0 : employee_slots_handler (xmlNodePtr node, gpointer employee_pdata)
     281                 :             : {
     282                 :           0 :     struct employee_pdata* pdata = static_cast<decltype (pdata)> (employee_pdata);
     283                 :           0 :     return dom_tree_create_instance_slots (node, QOF_INSTANCE (pdata->employee));
     284                 :             : }
     285                 :             : 
     286                 :             : static struct dom_tree_handler employee_handlers_v2[] =
     287                 :             : {
     288                 :             :     { employee_username_string, employee_username_handler, 1, 0 },
     289                 :             :     { employee_guid_string, employee_guid_handler, 1, 0 },
     290                 :             :     { employee_id_string, employee_id_handler, 1, 0 },
     291                 :             :     { employee_addr_string, employee_addr_handler, 1, 0 },
     292                 :             :     { employee_language_string, employee_language_handler, 0, 0 },
     293                 :             :     { employee_acl_string, employee_acl_handler, 0, 0 },
     294                 :             :     { employee_active_string, employee_active_handler, 1, 0 },
     295                 :             :     { employee_workday_string, employee_workday_handler, 1, 0 },
     296                 :             :     { employee_rate_string, employee_rate_handler, 1, 0 },
     297                 :             :     { employee_currency_string, employee_currency_handler, 0, 0 }, /* XXX */
     298                 :             :     { "employee:commodity", employee_currency_handler, 0, 0 }, /* XXX */
     299                 :             :     { employee_ccard_string, employee_ccard_handler, 0, 0 },
     300                 :             :     { employee_slots_string, employee_slots_handler, 0, 0 },
     301                 :             :     { NULL, 0, 0, 0 }
     302                 :             : };
     303                 :             : 
     304                 :             : static GncEmployee*
     305                 :           0 : dom_tree_to_employee (xmlNodePtr node, QofBook* book)
     306                 :             : {
     307                 :             :     struct employee_pdata employee_pdata;
     308                 :             :     gboolean successful;
     309                 :             : 
     310                 :           0 :     employee_pdata.employee = gncEmployeeCreate (book);
     311                 :           0 :     employee_pdata.book = book;
     312                 :           0 :     gncEmployeeBeginEdit (employee_pdata.employee);
     313                 :             : 
     314                 :           0 :     successful = dom_tree_generic_parse (node, employee_handlers_v2,
     315                 :             :                                          &employee_pdata);
     316                 :           0 :     if (successful)
     317                 :           0 :         gncEmployeeCommitEdit (employee_pdata.employee);
     318                 :             :     else
     319                 :             :     {
     320                 :           0 :         PERR ("failed to parse employee tree");
     321                 :           0 :         gncEmployeeDestroy (employee_pdata.employee);
     322                 :           0 :         employee_pdata.employee = NULL;
     323                 :             :     }
     324                 :             : 
     325                 :           0 :     return employee_pdata.employee;
     326                 :             : }
     327                 :             : 
     328                 :             : static gboolean
     329                 :           0 : gnc_employee_end_handler (gpointer data_for_children,
     330                 :             :                           GSList* data_from_children, GSList* sibling_data,
     331                 :             :                           gpointer parent_data, gpointer global_data,
     332                 :             :                           gpointer* result, const gchar* tag)
     333                 :             : {
     334                 :             :     GncEmployee* employee;
     335                 :           0 :     xmlNodePtr tree = (xmlNodePtr)data_for_children;
     336                 :           0 :     gxpf_data* gdata = (gxpf_data*)global_data;
     337                 :           0 :     QofBook* book = static_cast<decltype (book)> (gdata->bookdata);
     338                 :             : 
     339                 :             : 
     340                 :           0 :     if (parent_data)
     341                 :             :     {
     342                 :           0 :         return TRUE;
     343                 :             :     }
     344                 :             : 
     345                 :             :     /* OK.  For some messed up reason this is getting called again with a
     346                 :             :        NULL tag.  So we ignore those cases */
     347                 :           0 :     if (!tag)
     348                 :             :     {
     349                 :           0 :         return TRUE;
     350                 :             :     }
     351                 :             : 
     352                 :           0 :     g_return_val_if_fail (tree, FALSE);
     353                 :             : 
     354                 :           0 :     employee = dom_tree_to_employee (tree, book);
     355                 :           0 :     if (employee != NULL)
     356                 :             :     {
     357                 :           0 :         gdata->cb (tag, gdata->parsedata, employee);
     358                 :             :     }
     359                 :             : 
     360                 :           0 :     xmlFreeNode (tree);
     361                 :             : 
     362                 :           0 :     return employee != NULL;
     363                 :             : }
     364                 :             : 
     365                 :             : static sixtp*
     366                 :          21 : employee_sixtp_parser_create (void)
     367                 :             : {
     368                 :          21 :     return sixtp_dom_parser_new (gnc_employee_end_handler, NULL, NULL);
     369                 :             : }
     370                 :             : 
     371                 :             : static gboolean
     372                 :           0 : employee_should_be_saved (GncEmployee* employee)
     373                 :             : {
     374                 :             :     const char* id;
     375                 :             : 
     376                 :             :     /* make sure this is a valid employee before we save it -- should have an ID */
     377                 :           0 :     id = gncEmployeeGetID (employee);
     378                 :           0 :     if (id == NULL || *id == '\0')
     379                 :           0 :         return FALSE;
     380                 :             : 
     381                 :           0 :     return TRUE;
     382                 :             : }
     383                 :             : 
     384                 :             : static void
     385                 :           0 : do_count (QofInstance* employee_p, gpointer count_p)
     386                 :             : {
     387                 :           0 :     int* count = static_cast<decltype (count)> (count_p);
     388                 :           0 :     if (employee_should_be_saved ((GncEmployee*) employee_p))
     389                 :           0 :         (*count)++;
     390                 :           0 : }
     391                 :             : 
     392                 :             : static int
     393                 :           4 : employee_get_count (QofBook* book)
     394                 :             : {
     395                 :           4 :     int count = 0;
     396                 :           4 :     qof_object_foreach (_GNC_MOD_NAME, book, do_count, (gpointer) &count);
     397                 :           4 :     return count;
     398                 :             : }
     399                 :             : 
     400                 :             : static void
     401                 :           0 : xml_add_employee (QofInstance* employee_p, gpointer out_p)
     402                 :             : {
     403                 :             :     xmlNodePtr node;
     404                 :           0 :     GncEmployee* employee = (GncEmployee*) employee_p;
     405                 :           0 :     FILE* out = static_cast<decltype (out)> (out_p);
     406                 :             : 
     407                 :           0 :     if (ferror (out))
     408                 :           0 :         return;
     409                 :           0 :     if (!employee_should_be_saved (employee))
     410                 :           0 :         return;
     411                 :             : 
     412                 :           0 :     node = employee_dom_tree_create (employee);
     413                 :           0 :     xmlElemDump (out, NULL, node);
     414                 :           0 :     xmlFreeNode (node);
     415                 :           0 :     if (ferror (out) || fprintf (out, "\n") < 0)
     416                 :           0 :         return;
     417                 :             : }
     418                 :             : 
     419                 :             : static gboolean
     420                 :           4 : employee_write (FILE* out, QofBook* book)
     421                 :             : {
     422                 :           4 :     qof_object_foreach_sorted (_GNC_MOD_NAME, book, xml_add_employee,
     423                 :             :                                (gpointer) out);
     424                 :           4 :     return ferror (out) == 0;
     425                 :             : }
     426                 :             : 
     427                 :             : static gboolean
     428                 :           4 : employee_ns (FILE* out)
     429                 :             : {
     430                 :           4 :     g_return_val_if_fail (out, FALSE);
     431                 :           4 :     return gnc_xml2_write_namespace_decl (out, "employee");
     432                 :             : }
     433                 :             : 
     434                 :             : void
     435                 :          61 : gnc_employee_xml_initialize (void)
     436                 :             : {
     437                 :             :     static GncXmlDataType_t be_data =
     438                 :             :     {
     439                 :             :         GNC_FILE_BACKEND_VERS,
     440                 :             :         gnc_employee_string,
     441                 :             :         employee_sixtp_parser_create,
     442                 :             :         NULL,           /* add_item */
     443                 :             :         employee_get_count,
     444                 :             :         employee_write,
     445                 :             :         NULL,           /* scrub */
     446                 :             :         employee_ns,
     447                 :             :     };
     448                 :             : 
     449                 :          61 :     gnc_xml_register_backend (be_data);
     450                 :          61 : }
        

Generated by: LCOV version 2.0-1