CLI: Create ast_cli_completion_add function.
[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         return (struct ast_xml_doc *) doc;
100 }
101
102 struct ast_xml_doc *ast_xml_new(void)
103 {
104         xmlDoc *doc;
105
106         doc = xmlNewDoc((const xmlChar *) "1.0");
107         return (struct ast_xml_doc *) doc;
108 }
109
110 struct ast_xml_node *ast_xml_new_node(const char *name)
111 {
112         xmlNode *node;
113         if (!name) {
114                 return NULL;
115         }
116
117         node = xmlNewNode(NULL, (const xmlChar *) name);
118
119         return (struct ast_xml_node *) node;
120 }
121
122 struct ast_xml_node *ast_xml_new_child(struct ast_xml_node *parent, const char *child_name)
123 {
124         xmlNode *child;
125
126         if (!parent || !child_name) {
127                 return NULL;
128         }
129
130         child = xmlNewChild((xmlNode *) parent, NULL, (const xmlChar *) child_name, NULL);
131         return (struct ast_xml_node *) child;
132 }
133
134 struct ast_xml_node *ast_xml_add_child(struct ast_xml_node *parent, struct ast_xml_node *child)
135 {
136         if (!parent || !child) {
137                 return NULL;
138         }
139         return (struct ast_xml_node *) xmlAddChild((xmlNode *) parent, (xmlNode *) child);
140 }
141
142 struct ast_xml_doc *ast_xml_read_memory(char *buffer, size_t size)
143 {
144         xmlDoc *doc;
145
146         if (!buffer) {
147                 return NULL;
148         }
149
150         if (!(doc = xmlParseMemory(buffer, (int) size))) {
151                 /* process xinclude elements. */
152                 if (xmlXIncludeProcess(doc) < 0) {
153                         xmlFreeDoc(doc);
154                         return NULL;
155                 }
156         }
157
158         return (struct ast_xml_doc *) doc;
159 }
160
161 void ast_xml_close(struct ast_xml_doc *doc)
162 {
163         if (!doc) {
164                 return;
165         }
166
167         xmlFreeDoc((xmlDoc *) doc);
168         doc = NULL;
169 }
170
171 void ast_xml_set_root(struct ast_xml_doc *doc, struct ast_xml_node *node)
172 {
173         if (!doc || !node) {
174                 return;
175         }
176
177         xmlDocSetRootElement((xmlDoc *) doc, (xmlNode *) node);
178 }
179
180 struct ast_xml_node *ast_xml_get_root(struct ast_xml_doc *doc)
181 {
182         xmlNode *root_node;
183
184         if (!doc) {
185                 return NULL;
186         }
187
188         root_node = xmlDocGetRootElement((xmlDoc *) doc);
189
190         return (struct ast_xml_node *) root_node;
191 }
192
193 void ast_xml_free_node(struct ast_xml_node *node)
194 {
195         if (!node) {
196                 return;
197         }
198
199         xmlFreeNode((xmlNode *) node);
200         node = NULL;
201 }
202
203 void ast_xml_free_attr(const char *attribute)
204 {
205         if (attribute) {
206                 xmlFree((char *) attribute);
207         }
208 }
209
210 void ast_xml_free_text(const char *text)
211 {
212         if (text) {
213                 xmlFree((char *) text);
214         }
215 }
216
217 const char *ast_xml_get_attribute(struct ast_xml_node *node, const char *attrname)
218 {
219         xmlChar *attrvalue;
220
221         if (!node) {
222                 return NULL;
223         }
224
225         if (!attrname) {
226                 return NULL;
227         }
228
229         attrvalue = xmlGetProp((xmlNode *) node, (xmlChar *) attrname);
230
231         return (const char *) attrvalue;
232 }
233
234 int ast_xml_set_attribute(struct ast_xml_node *node, const char *name, const char *value)
235 {
236         if (!name || !value) {
237                 return -1;
238         }
239
240         if (!xmlSetProp((xmlNode *) node, (xmlChar *) name, (xmlChar *) value)) {
241                 return -1;
242         }
243
244         return 0;
245 }
246
247 struct ast_xml_node *ast_xml_find_element(struct ast_xml_node *root_node, const char *name, const char *attrname, const char *attrvalue)
248 {
249         struct ast_xml_node *cur;
250         const char *attr;
251
252         if (!root_node) {
253                 return NULL;
254         }
255
256         for (cur = root_node; cur; cur = ast_xml_node_get_next(cur)) {
257                 /* Check if the name matchs */
258                 if (strcmp(ast_xml_node_get_name(cur), name)) {
259                         continue;
260                 }
261                 /* We need to check for a specific attribute name? */
262                 if (!attrname || !attrvalue) {
263                         return cur;
264                 }
265                 /* Get the attribute, we need to compare it. */
266                 if ((attr = ast_xml_get_attribute(cur, attrname))) {
267                         /* does attribute name/value matches? */
268                         if (!strcmp(attr, attrvalue)) {
269                                 ast_xml_free_attr(attr);
270                                 return cur;
271                         }
272                         ast_xml_free_attr(attr);
273                 }
274         }
275
276         return NULL;
277 }
278
279 struct ast_xml_doc *ast_xml_get_doc(struct ast_xml_node *node)
280 {
281         if (!node) {
282                 return NULL;
283         }
284
285         return (struct ast_xml_doc *) ((xmlNode *)node)->doc;
286 }
287
288 struct ast_xml_ns *ast_xml_find_namespace(struct ast_xml_doc *doc, struct ast_xml_node *node, const char *ns_name) {
289         xmlNsPtr ns = xmlSearchNs((xmlDocPtr) doc, (xmlNodePtr) node, (xmlChar *) ns_name);
290         return (struct ast_xml_ns *) ns;
291 }
292
293 const char *ast_xml_get_ns_href(struct ast_xml_ns *ns)
294 {
295         return (const char *) ((xmlNsPtr) ns)->href;
296 }
297
298 const char *ast_xml_get_text(struct ast_xml_node *node)
299 {
300         if (!node) {
301                 return NULL;
302         }
303
304         return (const char *) xmlNodeGetContent((xmlNode *) node);
305 }
306
307 void ast_xml_set_text(struct ast_xml_node *node, const char *content)
308 {
309         if (!node || !content) {
310                 return;
311         }
312
313         xmlNodeSetContent((xmlNode *) node, (const xmlChar *) content);
314 }
315
316 int ast_xml_doc_dump_file(FILE *output, struct ast_xml_doc *doc)
317 {
318         return xmlDocDump(output, (xmlDocPtr)doc);
319 }
320
321 const char *ast_xml_node_get_name(struct ast_xml_node *node)
322 {
323         return (const char *) ((xmlNode *) node)->name;
324 }
325
326 struct ast_xml_node *ast_xml_node_get_children(struct ast_xml_node *node)
327 {
328         return (struct ast_xml_node *) ((xmlNode *) node)->children;
329 }
330
331 struct ast_xml_node *ast_xml_node_get_next(struct ast_xml_node *node)
332 {
333         return (struct ast_xml_node *) ((xmlNode *) node)->next;
334 }
335
336 struct ast_xml_node *ast_xml_node_get_prev(struct ast_xml_node *node)
337 {
338         return (struct ast_xml_node *) ((xmlNode *) node)->prev;
339 }
340
341 struct ast_xml_node *ast_xml_node_get_parent(struct ast_xml_node *node)
342 {
343         return (struct ast_xml_node *) ((xmlNode *) node)->parent;
344 }
345
346 struct ast_xml_node *ast_xml_xpath_get_first_result(struct ast_xml_xpath_results *results)
347 {
348         return (struct ast_xml_node *) ((xmlXPathObjectPtr) results)->nodesetval->nodeTab[0];
349 }
350
351 void ast_xml_xpath_results_free(struct ast_xml_xpath_results *results)
352 {
353         xmlXPathFreeObject((xmlXPathObjectPtr) results);
354 }
355
356 int ast_xml_xpath_num_results(struct ast_xml_xpath_results *results)
357 {
358         return ((xmlXPathObjectPtr) results)->nodesetval->nodeNr;
359 }
360
361 struct ast_xml_xpath_results *ast_xml_query(struct ast_xml_doc *doc, const char *xpath_str)
362 {
363         xmlXPathContextPtr context;
364         xmlXPathObjectPtr result;
365         if (!(context = xmlXPathNewContext((xmlDoc *) doc))) {
366                 ast_log(LOG_ERROR, "Could not create XPath context!\n");
367                 return NULL;
368         }
369         result = xmlXPathEvalExpression((xmlChar *) xpath_str, context);
370         xmlXPathFreeContext(context);
371         if (!result) {
372                 ast_log(LOG_WARNING, "Error for query: %s\n", xpath_str);
373                 return NULL;
374         }
375         if (xmlXPathNodeSetIsEmpty(result->nodesetval)) {
376                 xmlXPathFreeObject(result);
377                 ast_debug(5, "No results for query: %s\n", xpath_str);
378                 return NULL;
379         }
380         return (struct ast_xml_xpath_results *) result;
381 }
382
383 #endif /* defined(HAVE_LIBXML2) */
384