Branch data Line data Source code
1 : : /********************************************************************\
2 : : * gnc-job-xml-v2.c -- job 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 "gncJobP.h"
30 : :
31 : : #include "gnc-xml-helper.h"
32 : : #include "sixtp.h"
33 : : #include "sixtp-utils.h"
34 : : #include "sixtp-parsers.h"
35 : : #include "sixtp-utils.h"
36 : : #include "sixtp-dom-parsers.h"
37 : : #include "sixtp-dom-generators.h"
38 : :
39 : : #include "gnc-xml.h"
40 : : #include "io-gncxml-gen.h"
41 : : #include "io-gncxml-v2.h"
42 : :
43 : : #include "gnc-job-xml-v2.h"
44 : : #include "gnc-owner-xml-v2.h"
45 : : #include "xml-helpers.h"
46 : :
47 : : #define _GNC_MOD_NAME GNC_ID_JOB
48 : :
49 : : static QofLogModule log_module = GNC_MOD_IO;
50 : :
51 : : const gchar* job_version_string = "2.0.0";
52 : :
53 : : /* ids */
54 : : #define gnc_job_string "gnc:GncJob"
55 : : #define job_guid_string "job:guid"
56 : : #define job_id_string "job:id"
57 : : #define job_name_string "job:name"
58 : : #define job_reference_string "job:reference"
59 : : #define job_owner_string "job:owner"
60 : : #define job_active_string "job:active"
61 : : #define job_slots_string "job:slots"
62 : :
63 : : static xmlNodePtr
64 : 0 : job_dom_tree_create (GncJob* job)
65 : : {
66 : : xmlNodePtr ret;
67 : :
68 : 0 : ret = xmlNewNode (NULL, BAD_CAST gnc_job_string);
69 : 0 : xmlSetProp (ret, BAD_CAST "version", BAD_CAST job_version_string);
70 : :
71 : 0 : xmlAddChild (ret, guid_to_dom_tree (job_guid_string,
72 : 0 : qof_instance_get_guid (QOF_INSTANCE (job))));
73 : :
74 : 0 : xmlAddChild (ret, text_to_dom_tree (job_id_string,
75 : : gncJobGetID (job)));
76 : :
77 : 0 : xmlAddChild (ret, text_to_dom_tree (job_name_string,
78 : : gncJobGetName (job)));
79 : :
80 : 0 : maybe_add_string (ret, job_reference_string, gncJobGetReference (job));
81 : :
82 : 0 : xmlAddChild (ret, gnc_owner_to_dom_tree (job_owner_string,
83 : 0 : gncJobGetOwner (job)));
84 : :
85 : 0 : xmlAddChild (ret, int_to_dom_tree (job_active_string,
86 : 0 : gncJobGetActive (job)));
87 : :
88 : : /* xmlAddChild won't do anything with a NULL, so tests are superfluous. */
89 : 0 : xmlAddChild (ret, qof_instance_slots_to_dom_tree (job_slots_string,
90 : 0 : QOF_INSTANCE (job)));
91 : :
92 : 0 : return ret;
93 : : }
94 : :
95 : : /***********************************************************************/
96 : :
97 : : struct job_pdata
98 : : {
99 : : GncJob* job;
100 : : QofBook* book;
101 : : };
102 : :
103 : : static gboolean
104 : 2 : set_string (xmlNodePtr node, GncJob* job,
105 : : void (*func) (GncJob* job, const char* txt))
106 : : {
107 : 2 : char* txt = dom_tree_to_text (node);
108 : 2 : g_return_val_if_fail (txt, FALSE);
109 : :
110 : 2 : func (job, txt);
111 : :
112 : 2 : g_free (txt);
113 : :
114 : 2 : return TRUE;
115 : : }
116 : :
117 : : static gboolean
118 : 1 : job_name_handler (xmlNodePtr node, gpointer job_pdata)
119 : : {
120 : 1 : struct job_pdata* pdata = static_cast<decltype (pdata)> (job_pdata);
121 : :
122 : 1 : return set_string (node, pdata->job, gncJobSetName);
123 : : }
124 : :
125 : : static gboolean
126 : 1 : job_guid_handler (xmlNodePtr node, gpointer job_pdata)
127 : : {
128 : 1 : struct job_pdata* pdata = static_cast<decltype (pdata)> (job_pdata);
129 : : GncGUID* guid;
130 : : GncJob* job;
131 : :
132 : 1 : guid = dom_tree_to_guid (node);
133 : 1 : g_return_val_if_fail (guid, FALSE);
134 : 1 : job = gncJobLookup (pdata->book, guid);
135 : 1 : if (job)
136 : : {
137 : 1 : gncJobDestroy (pdata->job);
138 : 1 : pdata->job = job;
139 : 1 : gncJobBeginEdit (job);
140 : : }
141 : : else
142 : : {
143 : 0 : gncJobSetGUID (pdata->job, guid);
144 : : }
145 : :
146 : 1 : guid_free (guid);
147 : :
148 : 1 : return TRUE;
149 : : }
150 : :
151 : : static gboolean
152 : 1 : job_id_handler (xmlNodePtr node, gpointer job_pdata)
153 : : {
154 : 1 : struct job_pdata* pdata = static_cast<decltype (pdata)> (job_pdata);
155 : :
156 : 1 : return set_string (node, pdata->job, gncJobSetID);
157 : : }
158 : :
159 : : static gboolean
160 : 0 : job_reference_handler (xmlNodePtr node, gpointer job_pdata)
161 : : {
162 : 0 : struct job_pdata* pdata = static_cast<decltype (pdata)> (job_pdata);
163 : :
164 : 0 : return set_string (node, pdata->job, gncJobSetReference);
165 : : }
166 : :
167 : : static gboolean
168 : 1 : job_owner_handler (xmlNodePtr node, gpointer job_pdata)
169 : : {
170 : 1 : struct job_pdata* pdata = static_cast<decltype (pdata)> (job_pdata);
171 : : GncOwner owner;
172 : : gboolean ret;
173 : :
174 : 1 : ret = gnc_dom_tree_to_owner (node, &owner, pdata->book);
175 : 1 : if (ret)
176 : 1 : gncJobSetOwner (pdata->job, &owner);
177 : :
178 : 1 : return ret;
179 : : }
180 : :
181 : : static gboolean
182 : 1 : job_active_handler (xmlNodePtr node, gpointer job_pdata)
183 : : {
184 : 1 : struct job_pdata* pdata = static_cast<decltype (pdata)> (job_pdata);
185 : : gint64 val;
186 : : gboolean ret;
187 : :
188 : 1 : ret = dom_tree_to_integer (node, &val);
189 : 1 : if (ret)
190 : 1 : gncJobSetActive (pdata->job, (gboolean)val);
191 : :
192 : 1 : return ret;
193 : : }
194 : :
195 : : static gboolean
196 : 0 : job_slots_handler (xmlNodePtr node, gpointer job_pdata)
197 : : {
198 : 0 : struct job_pdata* pdata = static_cast<decltype (pdata)> (job_pdata);
199 : :
200 : 0 : return dom_tree_create_instance_slots (node, QOF_INSTANCE (pdata->job));
201 : : }
202 : :
203 : : static struct dom_tree_handler job_handlers_v2[] =
204 : : {
205 : : { job_guid_string, job_guid_handler, 1, 0 },
206 : : { job_id_string, job_id_handler, 1, 0 },
207 : : { job_name_string, job_name_handler, 1, 0 },
208 : : { job_reference_string, job_reference_handler, 0, 0 },
209 : : { job_owner_string, job_owner_handler, 1, 0 },
210 : : { job_active_string, job_active_handler, 1, 0 },
211 : : { job_slots_string, job_slots_handler, 0, 0 },
212 : : { NULL, 0, 0, 0 }
213 : : };
214 : :
215 : : static GncJob*
216 : 1 : dom_tree_to_job (xmlNodePtr node, QofBook* book)
217 : : {
218 : : struct job_pdata job_pdata;
219 : : gboolean successful;
220 : :
221 : 1 : job_pdata.job = gncJobCreate (book);
222 : 1 : job_pdata.book = book;
223 : 1 : gncJobBeginEdit (job_pdata.job);
224 : :
225 : 1 : successful = dom_tree_generic_parse (node, job_handlers_v2,
226 : : &job_pdata);
227 : :
228 : 1 : if (successful)
229 : 1 : gncJobCommitEdit (job_pdata.job);
230 : : else
231 : : {
232 : 0 : PERR ("failed to parse job tree");
233 : 0 : gncJobDestroy (job_pdata.job);
234 : 0 : job_pdata.job = NULL;
235 : : }
236 : :
237 : 1 : return job_pdata.job;
238 : : }
239 : :
240 : : static gboolean
241 : 8 : gnc_job_end_handler (gpointer data_for_children,
242 : : GSList* data_from_children, GSList* sibling_data,
243 : : gpointer parent_data, gpointer global_data,
244 : : gpointer* result, const gchar* tag)
245 : : {
246 : : GncJob* job;
247 : 8 : xmlNodePtr tree = (xmlNodePtr)data_for_children;
248 : 8 : gxpf_data* gdata = (gxpf_data*)global_data;
249 : 8 : QofBook* book = static_cast<decltype (book)> (gdata->bookdata);
250 : :
251 : 8 : if (parent_data)
252 : : {
253 : 7 : return TRUE;
254 : : }
255 : :
256 : : /* OK. For some messed up reason this is getting called again with a
257 : : NULL tag. So we ignore those cases */
258 : 1 : if (!tag)
259 : : {
260 : 0 : return TRUE;
261 : : }
262 : :
263 : 1 : g_return_val_if_fail (tree, FALSE);
264 : :
265 : 1 : job = dom_tree_to_job (tree, book);
266 : 1 : if (job != NULL)
267 : : {
268 : 1 : gdata->cb (tag, gdata->parsedata, job);
269 : : }
270 : :
271 : 1 : xmlFreeNode (tree);
272 : :
273 : 1 : return job != NULL;
274 : : }
275 : :
276 : : static sixtp*
277 : 21 : job_sixtp_parser_create (void)
278 : : {
279 : 21 : return sixtp_dom_parser_new (gnc_job_end_handler, NULL, NULL);
280 : : }
281 : :
282 : : static gboolean
283 : 0 : job_should_be_saved (GncJob* job)
284 : : {
285 : : const char* id;
286 : :
287 : : /* make sure this is a valid job before we save it -- should have an ID */
288 : 0 : id = gncJobGetID (job);
289 : 0 : if (id == NULL || *id == '\0')
290 : 0 : return FALSE;
291 : :
292 : 0 : return TRUE;
293 : : }
294 : :
295 : : static void
296 : 0 : do_count (QofInstance* job_p, gpointer count_p)
297 : : {
298 : 0 : int* count = static_cast<decltype (count)> (count_p);
299 : 0 : if (job_should_be_saved ((GncJob*)job_p))
300 : 0 : (*count)++;
301 : 0 : }
302 : :
303 : : static int
304 : 4 : job_get_count (QofBook* book)
305 : : {
306 : 4 : int count = 0;
307 : 4 : qof_object_foreach (_GNC_MOD_NAME, book, do_count, (gpointer) &count);
308 : 4 : return count;
309 : : }
310 : :
311 : : static void
312 : 0 : xml_add_job (QofInstance* job_p, gpointer out_p)
313 : : {
314 : : xmlNodePtr node;
315 : 0 : GncJob* job = (GncJob*) job_p;
316 : 0 : FILE* out = static_cast<decltype (out)> (out_p);
317 : :
318 : 0 : if (ferror (out))
319 : 0 : return;
320 : 0 : if (!job_should_be_saved (job))
321 : 0 : return;
322 : :
323 : 0 : node = job_dom_tree_create (job);
324 : 0 : xmlElemDump (out, NULL, node);
325 : 0 : xmlFreeNode (node);
326 : 0 : if (ferror (out) || fprintf (out, "\n") < 0)
327 : 0 : return;
328 : : }
329 : :
330 : : static gboolean
331 : 4 : job_write (FILE* out, QofBook* book)
332 : : {
333 : 4 : qof_object_foreach_sorted (_GNC_MOD_NAME, book, xml_add_job, (gpointer) out);
334 : 4 : return ferror (out) == 0;
335 : : }
336 : :
337 : : static gboolean
338 : 4 : job_ns (FILE* out)
339 : : {
340 : 4 : g_return_val_if_fail (out, FALSE);
341 : 4 : return gnc_xml2_write_namespace_decl (out, "job");
342 : : }
343 : :
344 : : void
345 : 61 : gnc_job_xml_initialize (void)
346 : : {
347 : : static GncXmlDataType_t be_data =
348 : : {
349 : : GNC_FILE_BACKEND_VERS,
350 : : gnc_job_string,
351 : : job_sixtp_parser_create,
352 : : NULL, /* add_item */
353 : : job_get_count,
354 : : job_write,
355 : : NULL, /* scrub */
356 : : job_ns,
357 : : };
358 : :
359 : 61 : gnc_xml_register_backend(be_data);
360 : 61 : }
|
