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