bd5850813dd7035fc0c3e2c1cdf7b31a6a7dd745
[asterisk/asterisk.git] / main / xml.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2008, Eliel C. Sardanons (LU1ALY) <eliels@gmail.com>
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 /*! \file
18  *
19  * \brief XML abstraction layer
20  *
21  * \author Eliel C. Sardanons (LU1ALY) <eliels@gmail.com>
22  */
23
24 /*** MODULEINFO
25         <support_level>core</support_level>
26  ***/
27
28 #include "asterisk.h"
29 #include "asterisk/xml.h"
30 #include "asterisk/logger.h"
31 #include "asterisk/utils.h"
32 #include "asterisk/autoconfig.h"
33
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
35
36 #if defined(HAVE_LIBXML2)
37 #include <libxml/parser.h>
38 #include <libxml/tree.h>
39 #include <libxml/xinclude.h>
40 #include <libxml/xpath.h>
41 /* libxml2 ast_xml implementation. */
42 #ifdef HAVE_LIBXSLT
43         #include <libxslt/xsltInternals.h>
44         #include <libxslt/transform.h>
45 #endif /* HAVE_LIBXSLT */
46
47
48 int ast_xml_init(void)
49 {
50         LIBXML_TEST_VERSION
51
52         return 0;
53 }
54
55 int ast_xml_finish(void)
56 {
57         xmlCleanupParser();
58
59         return 0;
60 }
61
62 struct ast_xml_doc *ast_xml_open(char *filename)
63 {
64         xmlDoc *doc;
65
66         if (!filename) {
67                 return NULL;
68         }
69
70         doc = xmlReadFile(filename, NULL, XML_PARSE_RECOVER);
71         if (!doc) {
72                 return NULL;
73         }
74
75         /* process xinclude elements. */
76         if (xmlXIncludeProcess(doc) < 0) {
77                 xmlFreeDoc(doc);
78                 return NULL;
79         }
80
81 #ifdef HAVE_LIBXSLT
82         {
83                 xsltStylesheetPtr xslt = xsltLoadStylesheetPI(doc);
84                 if (xslt) {
85                         xmlDocPtr tmpdoc = xsltApplyStylesheet(xslt, doc, NULL);
86                         xsltFreeStylesheet(xslt);
87                         xmlFreeDoc(doc);
88                         if (!tmpdoc) {
89                                 return NULL;
90                         }
91                         doc = tmpdoc;
92                 }
93         }
94 #else /* no HAVE_LIBXSLT */
95         ast_log(LOG_NOTICE, "XSLT support not found. XML documentation may be incomplete.\n");
96 #endif /* HAVE_LIBXSLT */
97
98         return (struct ast_xml_doc *) doc;
99 }
100
101 struct ast_xml_doc *ast_xml_new(void)
102 {
103         xmlDoc *doc;
104
105         doc = xmlNewDoc((const xmlChar *) "1.0");
106         return (struct ast_xml_doc *) doc;
107 }
108
109 struct ast_xml_node *ast_xml_new_node(const char *name)
110 {
111         xmlNode *node;
112         if (!name) {
113                 return NULL;
114         }
115
116         node = xmlNewNode(NULL, (const xmlChar *) name);
117
118         return (struct ast_xml_node *) node;
119 }
120
121 struct ast_xml_node *ast_xml_new_child(struct ast_xml_node *parent, const char *child_name)
122 {
123         xmlNode *child;
124
125         if (!parent || !child_name) {
126                 return NULL;
127         }
128
129         child = xmlNewChild((xmlNode *) parent, NULL, (const xmlChar *) child_name, NULL);
130         return (struct ast_xml_node *) child;
131 }
132
133 struct ast_xml_node *ast_xml_add_child(struct ast_xml_node *parent, struct ast_xml_node *child)
134 {
135         if (!parent || !child) {
136                 return NULL;
137         }
138         return (struct ast_xml_node *) xmlAddChild((xmlNode *) parent, (xmlNode *) child);
139 }
140
141 struct ast_xml_doc *ast_xml_read_memory(char *buffer, size_t size)
142 {
143         xmlDoc *doc;
144
145         if (!buffer) {
146                 return NULL;
147         }
148
149         if (!(doc = xmlParseMemory(buffer, (int) size))) {
150                 /* process xinclude elements. */
151                 if (xmlXIncludeProcess(doc) < 0) {
152                         xmlFreeDoc(doc);
153                         return NULL;
154                 }
155         }
156
157         return (struct ast_xml_doc *) doc;
158 }
159
160 void ast_xml_close(struct ast_xml_doc *doc)
161 {
162         if (!doc) {
163                 return;
164         }
165
166         xmlFreeDoc((xmlDoc *) doc);
167         doc = NULL;
168 }
169
170 void ast_xml_set_root(struct ast_xml_doc *doc, struct ast_xml_node *node)
171 {
172         if (!doc || !node) {
173                 return;
174         }
175
176         xmlDocSetRootElement((xmlDoc *) doc, (xmlNode *) node);
177 }
178
179 struct ast_xml_node *ast_xml_get_root(struct ast_xml_doc *doc)
180 {
181         xmlNode *root_node;
182
183         if (!doc) {
184                 return NULL;
185         }
186
187         root_node = xmlDocGetRootElement((xmlDoc *) doc);
188
189         return (struct ast_xml_node *) root_node;
190 }
191
192 void ast_xml_free_node(struct ast_xml_node *node)
193 {
194         if (!node) {
195                 return;
196         }
197
198         xmlFreeNode((xmlNode *) node);
199         node = NULL;
200 }
201
202 void ast_xml_free_attr(const char *attribute)
203 {
204         if (attribute) {
205                 xmlFree((char *) attribute);
206         }
207 }
208
209 void ast_xml_free_text(const char *text)
210 {
211         if (text) {
212                 xmlFree((char *) text);
213         }
214 }
215
216 const char *ast_xml_get_attribute(struct ast_xml_node *node, const char *attrname)
217 {
218         xmlChar *attrvalue;
219
220         if (!node) {
221                 return NULL;
222         }
223
224         if (!attrname) {
225                 return NULL;
226         }
227
228         attrvalue = xmlGetProp((xmlNode *) node, (xmlChar *) attrname);
229
230         return (const char *) attrvalue;
231 }
232
233 int ast_xml_set_attribute(struct ast_xml_node *node, const char *name, const char *value)
234 {
235         if (!name || !value) {
236                 return -1;
237         }
238
239         if (!xmlSetProp((xmlNode *) node, (xmlChar *) name, (xmlChar *) value)) {
240                 return -1;
241         }
242
243         return 0;
244 }
245
246 struct ast_xml_node *ast_xml_find_element(struct ast_xml_node *root_node, const char *name, const char *attrname, const char *attrvalue)
247 {
248         struct ast_xml_node *cur;
249         const char *attr;
250
251         if (!root_node) {
252                 return NULL;
253         }
254
255         for (cur = root_node; cur; cur = ast_xml_node_get_next(cur)) {
256                 /* Check if the name matchs */
257                 if (strcmp(ast_xml_node_get_name(cur), name)) {
258                         continue;
259                 }
260                 /* We need to check for a specific attribute name? */
261                 if (!attrname || !attrvalue) {
262                         return cur;
263                 }
264                 /* Get the attribute, we need to compare it. */
265                 if ((attr = ast_xml_get_attribute(cur, attrname))) {
266                         /* does attribute name/value matches? */
267                         if (!strcmp(attr, attrvalue)) {
268                                 ast_xml_free_attr(attr);
269                                 return cur;
270                         }
271                         ast_xml_free_attr(attr);
272                 }
273         }
274
275         return NULL;
276 }
277
278 struct ast_xml_doc *ast_xml_get_doc(struct ast_xml_node *node)
279 {
280         if (!node) {
281                 return NULL;
282         }
283
284         return (struct ast_xml_doc *) ((xmlNode *)node)->doc;
285 }
286
287 struct ast_xml_ns *ast_xml_find_namespace(struct ast_xml_doc *doc, struct ast_xml_node *node, const char *ns_name) {
288         xmlNsPtr ns = xmlSearchNs((xmlDocPtr) doc, (xmlNodePtr) node, (xmlChar *) ns_name);
289         return (struct ast_xml_ns *) ns;
290 }
291
292 const char *ast_xml_get_ns_href(struct ast_xml_ns *ns)
293 {
294         return (const char *) ((xmlNsPtr) ns)->href;
295 }
296
297 const char *ast_xml_get_text(struct ast_xml_node *node)
298 {
299         if (!node) {
300                 return NULL;
301         }
302
303         return (const char *) xmlNodeGetContent((xmlNode *) node);
304 }
305
306 void ast_xml_set_text(struct ast_xml_node *node, const char *content)
307 {
308         if (!node || !content) {
309                 return;
310         }
311
312         xmlNodeSetContent((xmlNode *) node, (const xmlChar *) content);
313 }
314
315 int ast_xml_doc_dump_file(FILE *output, struct ast_xml_doc *doc)
316 {
317         return xmlDocDump(output, (xmlDocPtr)doc);
318 }
319
320 const char *ast_xml_node_get_name(struct ast_xml_node *node)
321 {
322         return (const char *) ((xmlNode *) node)->name;
323 }
324
325 struct ast_xml_node *ast_xml_node_get_children(struct ast_xml_node *node)
326 {
327         return (struct ast_xml_node *) ((xmlNode *) node)->children;
328 }
329
330 struct ast_xml_node *ast_xml_node_get_next(struct ast_xml_node *node)
331 {
332         return (struct ast_xml_node *) ((xmlNode *) node)->next;
333 }
334
335 struct ast_xml_node *ast_xml_node_get_prev(struct ast_xml_node *node)
336 {
337         return (struct ast_xml_node *) ((xmlNode *) node)->prev;
338 }
339
340 struct ast_xml_node *ast_xml_node_get_parent(struct ast_xml_node *node)
341 {
342         return (struct ast_xml_node *) ((xmlNode *) node)->parent;
343 }
344
345 struct ast_xml_node *ast_xml_xpath_get_first_result(struct ast_xml_xpath_results *results)
346 {
347         return (struct ast_xml_node *) ((xmlXPathObjectPtr) results)->nodesetval->nodeTab[0];
348 }
349
350 void ast_xml_xpath_results_free(struct ast_xml_xpath_results *results)
351 {
352         xmlXPathFreeObject((xmlXPathObjectPtr) results);
353 }
354
355 int ast_xml_xpath_num_results(struct ast_xml_xpath_results *results)
356 {
357         return ((xmlXPathObjectPtr) results)->nodesetval->nodeNr;
358 }
359
360 struct ast_xml_xpath_results *ast_xml_query(struct ast_xml_doc *doc, const char *xpath_str)
361 {
362         xmlXPathContextPtr context;
363         xmlXPathObjectPtr result;
364         if (!(context = xmlXPathNewContext((xmlDoc *) doc))) {
365                 ast_log(LOG_ERROR, "Could not create XPath context!\n");
366                 return NULL;
367         }
368         result = xmlXPathEvalExpression((xmlChar *) xpath_str, context);
369         xmlXPathFreeContext(context);
370         if (!result) {
371                 ast_log(LOG_WARNING, "Error for query: %s\n", xpath_str);
372                 return NULL;
373         }
374         if (xmlXPathNodeSetIsEmpty(result->nodesetval)) {
375                 xmlXPathFreeObject(result);
376                 ast_debug(5, "No results for query: %s\n", xpath_str);
377                 return NULL;
378         }
379         return (struct ast_xml_xpath_results *) result;
380 }
381
382 #endif /* defined(HAVE_LIBXML2) */
383