git.sesse.net Git - vlc/blob - modules/misc/xml/libxml.c

   1 /*****************************************************************************
   2  * libxml.c: XML parser using libxml2
   3  *****************************************************************************
   4  * Copyright (C) 2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Gildas Bazin <gbazin@videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifdef HAVE_CONFIG_H
  25 # include "config.h"
  26 #endif
  27
  28 #include <vlc/vlc.h>
  29 #include <vlc_plugin.h>
  30
  31 #include "vlc_block.h"
  32 #include "vlc_stream.h"
  33 #include "vlc_xml.h"
  34
  35 #include <libxml/xmlreader.h>
  36 #include <libxml/catalog.h>
  37
  38 /*****************************************************************************
  39  * Module descriptor
  40  *****************************************************************************/
  41 static int  Open ( vlc_object_t * );
  42 static void Close( vlc_object_t * );
  43
  44 vlc_module_begin();
  45     set_description( _("XML Parser (using libxml2)") );
  46     set_capability( "xml", 10 );
  47     set_callbacks( Open, Close );
  48 vlc_module_end();
  49
  50 struct xml_reader_sys_t
  51 {
  52     /* libxml2 reader context */
  53     xmlTextReaderPtr p_reader;
  54 };
  55
  56 static xml_reader_t *ReaderCreate( xml_t *, stream_t * );
  57 static void ReaderDelete( xml_reader_t * );
  58 static int ReaderRead( xml_reader_t * );
  59 static int ReaderNodeType( xml_reader_t * );
  60 static char *ReaderName( xml_reader_t * );
  61 static char *ReaderValue( xml_reader_t * );
  62 static int ReaderNextAttr( xml_reader_t * );
  63
  64 static int ReaderUseDTD ( xml_reader_t *, bool );
  65
  66 static void CatalogLoad( xml_t *, const char * );
  67 static void CatalogAdd( xml_t *, const char *, const char *, const char * );
  68 static int StreamRead( void *p_context, char *p_buffer, int i_buffer );
  69
  70 /*****************************************************************************
  71  * Module initialization
  72  *****************************************************************************/
  73 static int Open( vlc_object_t *p_this )
  74 {
  75     xml_t *p_xml = (xml_t *)p_this;
  76
  77     p_xml->pf_reader_create = ReaderCreate;
  78     p_xml->pf_reader_delete = ReaderDelete;
  79
  80     p_xml->pf_catalog_load = CatalogLoad;
  81     p_xml->pf_catalog_add  = CatalogAdd;
  82
  83     return VLC_SUCCESS;
  84 }
  85
  86 /*****************************************************************************
  87  * Module deinitialization
  88  *****************************************************************************/
  89 static void Close( vlc_object_t *p_this )
  90 {
  91     VLC_UNUSED(p_this);
  92     return;
  93 }
  94
  95 /*****************************************************************************
  96  * Catalogue functions
  97  *****************************************************************************/
  98 static void CatalogLoad( xml_t *p_xml, const char *psz_filename )
  99 {
 100     VLC_UNUSED(p_xml);
 101     if( !psz_filename ) xmlInitializeCatalog();
 102     else xmlLoadCatalog( psz_filename );
 103 }
 104
 105 static void CatalogAdd( xml_t *p_xml, const char *psz_arg1,
 106                           const char *psz_arg2, const char *psz_filename )
 107 {
 108     VLC_UNUSED(p_xml);
 109     xmlCatalogAdd( (unsigned char*)psz_arg1, (unsigned char*)psz_arg2,
 110         (unsigned char*)psz_filename );
 111 }
 112
 113 /*****************************************************************************
 114  * Reader functions
 115  *****************************************************************************/
 116 static void ReaderErrorHandler( void *p_arg, const char *p_msg,
 117                                 xmlParserSeverities severity,
 118                                 xmlTextReaderLocatorPtr locator)
 119 {
 120     VLC_UNUSED(severity);
 121     xml_reader_t *p_reader = (xml_reader_t *)p_arg;
 122     int line = xmlTextReaderLocatorLineNumber( locator );
 123     msg_Err( p_reader->p_xml, "XML parser error (line %d) : %s", line, p_msg );
 124 }
 125
 126 static xml_reader_t *ReaderCreate( xml_t *p_xml, stream_t *p_stream )
 127 {
 128     xml_reader_t *p_reader;
 129     xml_reader_sys_t *p_sys;
 130     xmlTextReaderPtr p_libxml_reader;
 131
 132     p_libxml_reader = xmlReaderForIO( StreamRead, NULL, p_stream,
 133                                       NULL, NULL, 0 );
 134     if( !p_libxml_reader )
 135     {
 136         msg_Err( p_xml, "failed to create XML parser" );
 137         return 0;
 138     }
 139
 140     p_reader = malloc( sizeof(xml_reader_t) );
 141     p_reader->p_sys = p_sys = malloc( sizeof(xml_reader_sys_t) );
 142     p_reader->p_sys->p_reader = p_libxml_reader;
 143     p_reader->p_xml = p_xml;
 144
 145     /* Set the error handler */
 146     xmlTextReaderSetErrorHandler( p_libxml_reader,
 147                                   ReaderErrorHandler, p_reader );
 148
 149
 150     p_reader->pf_read = ReaderRead;
 151     p_reader->pf_node_type = ReaderNodeType;
 152     p_reader->pf_name = ReaderName;
 153     p_reader->pf_value = ReaderValue;
 154     p_reader->pf_next_attr = ReaderNextAttr;
 155     p_reader->pf_use_dtd = ReaderUseDTD;
 156
 157     return p_reader;
 158 }
 159
 160 static void ReaderDelete( xml_reader_t *p_reader )
 161 {
 162     xmlFreeTextReader( p_reader->p_sys->p_reader );
 163     free( p_reader->p_sys );
 164     free( p_reader );
 165 }
 166
 167 static int ReaderUseDTD ( xml_reader_t *p_reader, bool b_use )
 168 {
 169     /* Activate DTD validation */
 170     xmlTextReaderSetParserProp( p_reader->p_sys->p_reader,
 171                                 XML_PARSER_DEFAULTATTRS, b_use );
 172     xmlTextReaderSetParserProp( p_reader->p_sys->p_reader,
 173                                 XML_PARSER_VALIDATE, b_use );
 174
 175     return VLC_SUCCESS;
 176 }
 177
 178 static int ReaderRead( xml_reader_t *p_reader )
 179 {
 180     int i_ret = xmlTextReaderRead( p_reader->p_sys->p_reader );
 181
 182 #if 0
 183     switch( i_ret )
 184     {
 185     default:
 186     }
 187 #endif
 188
 189     return i_ret;
 190 }
 191
 192 static int ReaderNodeType( xml_reader_t *p_reader )
 193 {
 194     int i_ret = xmlTextReaderNodeType( p_reader->p_sys->p_reader );
 195
 196     switch( i_ret )
 197     {
 198     case XML_READER_TYPE_ELEMENT:
 199         i_ret = XML_READER_STARTELEM;
 200         break;
 201     case XML_READER_TYPE_END_ELEMENT:
 202         i_ret = XML_READER_ENDELEM;
 203         break;
 204     case XML_READER_TYPE_CDATA:
 205     case XML_READER_TYPE_TEXT:
 206         i_ret = XML_READER_TEXT;
 207         break;
 208     case -1:
 209         i_ret = -1;
 210         break;
 211     default:
 212         i_ret = XML_READER_NONE;
 213         break;
 214     }
 215
 216     return i_ret;
 217 }
 218
 219 static char *ReaderName( xml_reader_t *p_reader )
 220 {
 221     const xmlChar *psz_name =
 222         xmlTextReaderConstName( p_reader->p_sys->p_reader );
 223
 224     if( psz_name ) return strdup( (const char *)psz_name );
 225     else return 0;
 226 }
 227
 228 static char *ReaderValue( xml_reader_t *p_reader )
 229 {
 230     const xmlChar *psz_value =
 231         xmlTextReaderConstValue( p_reader->p_sys->p_reader );
 232
 233     if( psz_value ) return strdup( (const char *)psz_value );
 234     else return 0;
 235 }
 236
 237 static int ReaderNextAttr( xml_reader_t *p_reader )
 238 {
 239     return ( xmlTextReaderMoveToNextAttribute( p_reader->p_sys->p_reader )
 240              == 1 ) ? VLC_SUCCESS : VLC_EGENERIC;
 241 }
 242
 243 static int StreamRead( void *p_context, char *p_buffer, int i_buffer )
 244 {
 245     stream_t *s = (stream_t*)p_context;
 246     return stream_Read( s, p_buffer, i_buffer );
 247 }