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 #include "asterisk.h"
  25 #include "asterisk/xml.h"
  26
  27 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
  28
  29 #if defined(HAVE_LIBXML2)
  30 #include <libxml/parser.h>
  31 #include <libxml/tree.h>
  32 #include <libxml/xinclude.h>
  33 /* libxml2 ast_xml implementation. */
  34
  35
  36 int ast_xml_init(void)
  37 {
  38         LIBXML_TEST_VERSION
  39
  40         return 0;
  41 }
  42
  43 int ast_xml_finish(void)
  44 {
  45         xmlCleanupParser();
  46
  47         return 0;
  48 }
  49
  50 struct ast_xml_doc *ast_xml_open(char *filename)
  51 {
  52         xmlDoc *doc;
  53
  54         if (!filename) {
  55                 return NULL;
  56         }
  57
  58         doc = xmlReadFile(filename, NULL, XML_PARSE_RECOVER);
  59         if (doc) {
  60                 /* process xinclude elements. */
  61                 if (xmlXIncludeProcess(doc) < 0) {
  62                         xmlFreeDoc(doc);
  63                         return NULL;
  64                 }
  65         }
  66
  67         return (struct ast_xml_doc *) doc;
  68 }
  69
  70 void ast_xml_close(struct ast_xml_doc *doc)
  71 {
  72         if (!doc) {
  73                 return;
  74         }
  75
  76         xmlFreeDoc((xmlDoc *) doc);
  77         doc = NULL;
  78 }
  79
  80
  81 struct ast_xml_node *ast_xml_get_root(struct ast_xml_doc *doc)
  82 {
  83         xmlNode *root_node;
  84
  85         if (!doc) {
  86                 return NULL;
  87         }
  88
  89         root_node = xmlDocGetRootElement((xmlDoc *) doc);
  90
  91         return (struct ast_xml_node *) root_node;
  92 }
  93
  94 void ast_xml_free_node(struct ast_xml_node *node)
  95 {
  96         if (!node) {
  97                 return;
  98         }
  99
 100         xmlFreeNode((xmlNode *) node);
 101         node = NULL;
 102 }
 103
 104 void ast_xml_free_attr(const char *attribute)
 105 {
 106         if (attribute) {
 107                 xmlFree((char *) attribute);
 108         }
 109 }
 110
 111 void ast_xml_free_text(const char *text)
 112 {
 113         if (text) {
 114                 xmlFree((char *) text);
 115         }
 116 }
 117
 118 const char *ast_xml_get_attribute(struct ast_xml_node *node, const char *attrname)
 119 {
 120         xmlChar *attrvalue;
 121
 122         if (!node) {
 123                 return NULL;
 124         }
 125
 126         if (!attrname) {
 127                 return NULL;
 128         }
 129
 130         attrvalue = xmlGetProp((xmlNode *) node, (xmlChar *) attrname);
 131
 132         return (const char *) attrvalue;
 133 }
 134
 135 struct ast_xml_node *ast_xml_find_element(struct ast_xml_node *root_node, const char *name, const char *attrname, const char *attrvalue)
 136 {
 137         struct ast_xml_node *cur;
 138         const char *attr;
 139
 140         if (!root_node) {
 141                 return NULL;
 142         }
 143
 144         for (cur = root_node; cur; cur = ast_xml_node_get_next(cur)) {
 145                 /* Check if the name matchs */
 146                 if (strcmp(ast_xml_node_get_name(cur), name)) {
 147                         continue;
 148                 }
 149                 /* We need to check for a specific attribute name? */
 150                 if (!attrname || !attrvalue) {
 151                         return cur;
 152                 }
 153                 /* Get the attribute, we need to compare it. */
 154                 if ((attr = ast_xml_get_attribute(cur, attrname))) {
 155                         /* does attribute name/value matches? */
 156                         if (!strcmp(attr, attrvalue)) {
 157                                 ast_xml_free_attr(attr);
 158                                 return cur;
 159                         }
 160                         ast_xml_free_attr(attr);
 161                 }
 162         }
 163
 164         return NULL;
 165 }
 166
 167 const char *ast_xml_get_text(struct ast_xml_node *node)
 168 {
 169         if (!node) {
 170                 return NULL;
 171         }
 172
 173         return (const char *) xmlNodeGetContent((xmlNode *) node);
 174 }
 175
 176 const char *ast_xml_node_get_name(struct ast_xml_node *node)
 177 {
 178         return (const char *) ((xmlNode *) node)->name;
 179 }
 180
 181 struct ast_xml_node *ast_xml_node_get_children(struct ast_xml_node *node)
 182 {
 183         return (struct ast_xml_node *) ((xmlNode *) node)->children;
 184 }
 185
 186 struct ast_xml_node *ast_xml_node_get_next(struct ast_xml_node *node)
 187 {
 188         return (struct ast_xml_node *) ((xmlNode *) node)->next;
 189 }
 190
 191 struct ast_xml_node *ast_xml_node_get_prev(struct ast_xml_node *node)
 192 {
 193         return (struct ast_xml_node *) ((xmlNode *) node)->prev;
 194 }
 195
 196 struct ast_xml_node *ast_xml_node_get_parent(struct ast_xml_node *node)
 197 {
 198         return (struct ast_xml_node *) ((xmlNode *) node)->parent;
 199 }
 200
 201 #endif /* defined(HAVE_LIBXML2) */
 202