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