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