1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
|
/* Firebox Tools - Outils de configurations pour le WM Firebox
* xml.c - lecture ou écriture de documents XML
*
* Copyright (C) 2006-2007 Cyrille Bagard
*
* This file is part of Firebox Tools.
*
* Firebox Tools 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.
*
* Firebox Tools 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, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#include "xml.h"
#include <stdarg.h>
#include <string.h>
#ifdef DEBUG
# define XML_LOG fprintf
#else
# define XML_LOG if (FALSE) fprintf
#endif
/* ---------------------------------------------------------------------------------- */
/* OPERATIONS DE LECTURE D'UN FICHIER XML */
/* ---------------------------------------------------------------------------------- */
/******************************************************************************
* *
* Paramètres : filename = nom du fichier à ouvrir. *
* xdoc = structure XML chargée. [OUT] *
* xroot = noeud premier de l'ensemble des définitions.[OUT] *
* xpathCtx = contexte à utiliser pour les recherches. [OUT] *
* *
* Description : Ouvre un fichier XML de façon encadrée. *
* *
* Retour : true si l'opération a pu s'effectuer, false sinon. *
* *
* Remarques : - *
* *
******************************************************************************/
gboolean open_xml_file(const char *filename, xmlDoc **xdoc, xmlNode **xroot, xmlXPathContextPtr *xpathCtx)
{
*xdoc = xmlParseFile(filename);
if (*xdoc == NULL)
{
XML_LOG(stderr, "Can not parse the XML file '%s'\n", filename);
return FALSE;
}
*xroot = xmlDocGetRootElement(*xdoc);
if (*xroot == NULL)
{
XML_LOG(stderr, "Can not access the root node in '%s'\n", filename);
xmlFreeDoc(*xdoc);
return FALSE;
}
*xpathCtx = xmlXPathNewContext(*xdoc);
if (*xpathCtx == NULL)
{
XML_LOG(stderr, "Unable to create new XPath context\n");
xmlFreeDoc(*xdoc);
return FALSE;
}
return TRUE;
}
/******************************************************************************
* *
* Paramètres : xpathCtx = contexte à utiliser pour les recherches. *
* path = chemin d'accès au noeud visé. *
* *
* Description : Obtient de façon encadrée l'accès à un noeud défini. *
* *
* Retour : Adresse de l'accès trouvé. *
* *
* Remarques : - *
* *
******************************************************************************/
xmlXPathObjectPtr get_node_xpath_object(xmlXPathContextPtr xpathCtx, const char *path)
{
xmlXPathObjectPtr result; /* Noeud XML à renvoyer */
result = xmlXPathEvalExpression(BAD_CAST path, xpathCtx);
if (result == NULL)
{
XML_LOG(stderr, "Unable to evaluate xpath expression '%s'\n", path);
return NULL;
}
if (result->nodesetval == NULL)
{
XML_LOG(stderr, "Node '%s' not found\n", path);
xmlXPathFreeObject(result);
return NULL;
}
return result;
}
/******************************************************************************
* *
* Paramètres : node = noeud dont une propriété est à lire. *
* *
* Description : Obtient une valeur placée entre <...> et </...>. *
* *
* Retour : Valeur sous forme de chaîne de caractères ou NULL. *
* *
* Remarques : - *
* *
******************************************************************************/
char *qck_get_node_text_value(xmlNodePtr node)
{
char *result; /* Valeur en question renvoyée */
result = NULL;
if (node != NULL)
if (node->children != NULL)
if (node->children->content != NULL)
result = strdup((char *)node->children->content);
if (result == NULL) XML_LOG(stderr, "No text value for node '%s'\n", node->name);
return result;
}
/******************************************************************************
* *
* Paramètres : xpathCtx = contexte à utiliser pour les recherches. *
* path = chemin d'accès au noeud visé. *
* *
* Description : Obtient une valeur placée entre <...> et </...>. *
* *
* Retour : Valeur sous forme de chaîne de caractères ou NULL. *
* *
* Remarques : - *
* *
******************************************************************************/
char *get_node_text_value(xmlXPathContextPtr xpathCtx, const char *path)
{
char *result; /* Valeur en question renvoyée */
xmlXPathObjectPtr xpathObj; /* Point de départ XML */
result = NULL;
xpathObj = get_node_xpath_object(xpathCtx, path);
if (xpathObj == NULL) return NULL;
if (xpathObj->nodesetval->nodeNr > 0)
result = qck_get_node_text_value(xpathObj->nodesetval->nodeTab[0]);
xmlXPathFreeObject(xpathObj);
return result;
}
/******************************************************************************
* *
* Paramètres : node = noeud dont une propriété est à lire. *
* name = nom de la propriété à lire. *
* *
* Description : Obtient la valeur d'une propriété d'un élément. *
* *
* Retour : Valeur sous forme de chaîne de caractères ou NULL. *
* *
* Remarques : - *
* *
******************************************************************************/
char *qck_get_node_prop_value(xmlNodePtr node, const char *name)
{
char *result; /* Valeur en question renvoyée */
xmlAttrPtr attrib; /* Liste d'attributs présents */
result = NULL;
if (node == NULL) return NULL;
/* Lecture de la valeur */
for (attrib = node->properties; attrib != NULL && result == NULL; attrib = attrib->next)
if (xmlStrEqual(attrib->name, BAD_CAST name)) result = strdup((char *)attrib->children->content);
return result;
}
/******************************************************************************
* *
* Paramètres : xpathCtx = contexte à utiliser pour les recherches. *
* path = chemin d'accès au noeud à traiter. *
* name = nom de la propriété à lire. *
* *
* Description : Obtient la valeur d'une propriété d'un élément. *
* *
* Retour : Valeur sous forme de chaîne de caractères ou NULL. *
* *
* Remarques : - *
* *
******************************************************************************/
char *get_node_prop_value(xmlXPathContextPtr xpathCtx, const char *path, const char *name)
{
char *result; /* Valeur en question renvoyée */
xmlXPathObjectPtr xpathObj; /* Point de départ XML */
result = NULL;
xpathObj = get_node_xpath_object(xpathCtx, path);
if (xpathObj == NULL) return NULL;
if (xpathObj->nodesetval->nodeNr > 0)
result = qck_get_node_prop_value(xpathObj->nodesetval->nodeTab[0], name);
xmlXPathFreeObject(xpathObj);
return result;
}
/******************************************************************************
* *
* Paramètres : node = noeud de texte avec un lien avec le document XML. *
* *
* Description : Construit un chemin d'accès complet selon le fichier XML. *
* *
* Retour : Valeur à libérer de la mémoire après usage ou NULL. *
* *
* Remarques : - *
* *
******************************************************************************/
char *qck_build_filename_with_doc_url(xmlNodePtr node)
{
char *result; /* Construction à retourner */
char *text; /* Valeur du texte lu */
char *last; /* Point de remplacement */
result = NULL;
text = qck_get_node_text_value(node);
if (text != NULL)
{
result = (char *)calloc(xmlStrlen(node->doc->URL) + strlen(text) + 1, sizeof(char));
strcpy(result, (const char *)node->doc->URL);
last = strrchr(result, '/');
last++;
strcpy(last, text);
free(text);
}
return result;
}
/******************************************************************************
* *
* Paramètres : xpathCtx = contexte à utiliser pour les recherches. *
* path = chemin d'accès au noeud à traiter. *
* *
* Description : Construit un chemin d'accès complet selon le fichier XML. *
* *
* Retour : Valeur sous forme de chaîne de caractères ou NULL. *
* *
* Remarques : - *
* *
******************************************************************************/
char *build_filename_with_doc_url(xmlXPathContextPtr xpathCtx, const char *path)
{
char *result; /* Valeur en question renvoyée */
xmlXPathObjectPtr xpathObj; /* Point de départ XML */
result = NULL;
xpathObj = get_node_xpath_object(xpathCtx, path);
if (xpathObj == NULL) return NULL;
if (xpathObj->nodesetval->nodeNr > 0)
result = qck_build_filename_with_doc_url(xpathObj->nodesetval->nodeTab[0]);
xmlXPathFreeObject(xpathObj);
return result;
}
/* ---------------------------------------------------------------------------------- */
/* OPERATIONS D'ECRITURE D'UN FICHIER XML */
/* ---------------------------------------------------------------------------------- */
/******************************************************************************
* *
* Paramètres : filename = nom du fichier à ouvrir. *
* *
* Description : Amorce l'écriture d'un nouveau fichier XML. *
* *
* Retour : Rédacteur mis en place ou NULL en cas d'erreur. *
* *
* Remarques : - *
* *
******************************************************************************/
xmlTextWriterPtr start_writing_xml_file(const char *filename)
{
xmlTextWriterPtr result; /* Moyen à retourner */
int retval; /* Bilan d'une opération */
result = xmlNewTextWriterFilename(filename, 0);
if (result == NULL)
{
XML_LOG(stderr, "Error creating the xml writer\n");
return NULL;
}
retval = xmlTextWriterStartDocument(result, NULL, "UTF-8", "yes");
if (retval < 0)
{
XML_LOG(stderr, "Error at xmlTextWriterStartDocument\n");
xmlFreeTextWriter(result);
return NULL;
}
retval = xmlTextWriterSetIndent(result, 1);
if (retval < 0)
{
XML_LOG(stderr, "Error setting indentation\n");
xmlFreeTextWriter(result);
return NULL;
}
retval = xmlTextWriterSetIndentString(result, BAD_CAST "\t");
if (retval < 0)
{
XML_LOG(stderr, "Error setting indentation string\n");
xmlFreeTextWriter(result);
return NULL;
}
return result;
}
/******************************************************************************
* *
* Paramètres : writer = rédacteur dédié à l'écriture. *
* *
* Description : Met fin à l'écriture d'un nouveau fichier XML. *
* *
* Retour : Bilan de l'opération : true ou false. *
* *
* Remarques : Ferme au besoin toutes les balises encore ouvertes. *
* *
******************************************************************************/
bool end_writing_xml_file(xmlTextWriterPtr writer)
{
int retval; /* Bilan de l'opération */
retval = xmlTextWriterEndDocument(writer);
if (retval < 0)
{
XML_LOG(stderr, "Error at xmlTextWriterEndDocument\n");
return false;
}
xmlFreeTextWriter(writer);
return true;
}
/******************************************************************************
* *
* Paramètres : writer = rédacteur dédié à l'écriture. *
* name = nom de la balise à écrire. *
* *
* Description : Ecrit une balise et ne la referme pas. *
* *
* Retour : Bilan de l'opération : true ou false. *
* *
* Remarques : - *
* *
******************************************************************************/
bool open_xml_element(xmlTextWriterPtr writer, const char *name)
{
int retval; /* Bilan de l'opération */
retval = xmlTextWriterStartElement(writer, BAD_CAST name);
if (retval < 0)
XML_LOG(stderr, "Error at xmlTextWriterWriteFormatElement\n");
return (retval >= 0);
}
/******************************************************************************
* *
* Paramètres : writer = rédacteur dédié à l'écriture. *
* *
* Description : Ferme la dernière balise laissée ouverte. *
* *
* Retour : Bilan de l'opération : true ou false. *
* *
* Remarques : - *
* *
******************************************************************************/
bool close_xml_element(xmlTextWriterPtr writer)
{
int retval; /* Bilan de l'opération */
retval = xmlTextWriterEndElement(writer);
if (retval < 0)
XML_LOG(stderr, "Error at xmlTextWriterWriteFormatElement\n");
return (retval >= 0);
}
/******************************************************************************
* *
* Paramètres : writer = rédacteur dédié à l'écriture. *
* name = nom de la balise à écrire. *
* format = format de la chaîne à traiter. *
* ... = informations à inscrire. *
* *
* Description : Ecrit une balise avec un contenu textuel. *
* *
* Retour : Bilan de l'opération : true ou false. *
* *
* Remarques : - *
* *
******************************************************************************/
bool write_xml_element_with_content(xmlTextWriterPtr writer, const char *name, const char *format, ...)
{
va_list ap; /* Liste d'arguments variable */
int retval; /* Bilan de l'opération */
va_start(ap, format);
retval = xmlTextWriterWriteVFormatElement(writer, BAD_CAST name, format, ap);
if (retval < 0)
XML_LOG(stderr, "Error at xmlTextWriterWriteFormatElement\n");
va_end(ap);
return (retval >= 0);
}
/******************************************************************************
* *
* Paramètres : writer = rédacteur dédié à l'écriture. *
* name = nom de l'attribut à écrire. *
* format = format de la chaîne à traiter. *
* ... = informations à inscrire. *
* *
* Description : Ecrit un attribut avec un contenu textuel. *
* *
* Retour : Bilan de l'opération : true ou false. *
* *
* Remarques : - *
* *
******************************************************************************/
bool write_xml_attribute(xmlTextWriterPtr writer, const char *name, const char *format, ...)
{
va_list ap; /* Liste d'arguments variable */
int retval; /* Bilan de l'opération */
va_start(ap, format);
retval = xmlTextWriterWriteVFormatAttribute(writer, BAD_CAST name, format, ap);
if (retval < 0)
XML_LOG(stderr, "Error at xmlTextWriterWriteFormatElement\n");
va_end(ap);
return (retval >= 0);
}
/******************************************************************************
* *
* Paramètres : writer = rédacteur dédié à l'écriture. *
* format = format de la chaîne à traiter. *
* ... = informations à inscrire. *
* *
* Description : Ecrit un contenu textuel. *
* *
* Retour : Bilan de l'opération : true ou false. *
* *
* Remarques : - *
* *
******************************************************************************/
bool write_xml_content(xmlTextWriterPtr writer, const char *format, ...)
{
va_list ap; /* Liste d'arguments variable */
int retval; /* Bilan de l'opération */
va_start(ap, format);
retval = xmlTextWriterWriteVFormatString(writer, format, ap);
if (retval < 0)
XML_LOG(stderr, "Error at xmlTextWriterWriteFormatElement\n");
va_end(ap);
return (retval >= 0);
}
|
