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_common.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( N_("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     xmlInitParser();
  78
  79     p_xml->pf_reader_create = ReaderCreate;
  80     p_xml->pf_reader_delete = ReaderDelete;
  81
  82     p_xml->pf_catalog_load = CatalogLoad;
  83     p_xml->pf_catalog_add  = CatalogAdd;
  84
  85     return VLC_SUCCESS;
  86 }
  87
  88 /*****************************************************************************
  89  * Module deinitialization
  90  *****************************************************************************/
  91 static void Close( vlc_object_t *p_this )
  92 {
  93     xmlCleanupParser();
  94     VLC_UNUSED(p_this);
  95     return;
  96 }
  97
  98 /*****************************************************************************
  99  * Catalogue functions
 100  *****************************************************************************/
 101 static void CatalogLoad( xml_t *p_xml, const char *psz_filename )
 102 {
 103     VLC_UNUSED(p_xml);
 104     if( !psz_filename ) xmlInitializeCatalog();
 105     else xmlLoadCatalog( psz_filename );
 106 }
 107
 108 static void CatalogAdd( xml_t *p_xml, const char *psz_arg1,
 109                           const char *psz_arg2, const char *psz_filename )
 110 {
 111     VLC_UNUSED(p_xml);
 112     xmlCatalogAdd( (unsigned char*)psz_arg1, (unsigned char*)psz_arg2,
 113         (unsigned char*)psz_filename );
 114 }
 115
 116 /*****************************************************************************
 117  * Reader functions
 118  *****************************************************************************/
 119 static void ReaderErrorHandler( void *p_arg, const char *p_msg,
 120                                 xmlParserSeverities severity,
 121                                 xmlTextReaderLocatorPtr locator)
 122 {
 123     VLC_UNUSED(severity);
 124     xml_reader_t *p_reader = (xml_reader_t *)p_arg;
 125     int line = xmlTextReaderLocatorLineNumber( locator );
 126     msg_Err( p_reader->p_xml, "XML parser error (line %d) : %s", line, p_msg );
 127 }
 128
 129 static xml_reader_t *ReaderCreate( xml_t *p_xml, stream_t *p_stream )
 130 {
 131     xml_reader_t *p_reader;
 132     xml_reader_sys_t *p_sys;
 133     xmlTextReaderPtr p_libxml_reader;
 134
 135     p_libxml_reader = xmlReaderForIO( StreamRead, NULL, p_stream,
 136                                       NULL, NULL, 0 );
 137     if( !p_libxml_reader )
 138     {
 139         msg_Err( p_xml, "failed to create XML parser" );
 140         return NULL;
 141     }
 142
 143     p_reader = malloc( sizeof(xml_reader_t) );
 144     if( !p_reader )
 145     {
 146         xmlFreeTextReader( p_libxml_reader );
 147         return NULL;
 148     }
 149     p_reader->p_sys = p_sys = malloc( sizeof(xml_reader_sys_t) );
 150     if( !p_sys )
 151     {
 152         xmlFreeTextReader( p_libxml_reader );
 153         free( p_reader );
 154         return NULL;
 155     }
 156     p_reader->p_sys->p_reader = p_libxml_reader;
 157     p_reader->p_xml = p_xml;
 158
 159     /* Set the error handler */
 160     xmlTextReaderSetErrorHandler( p_libxml_reader,
 161                                   ReaderErrorHandler, p_reader );
 162
 163
 164     p_reader->pf_read = ReaderRead;
 165     p_reader->pf_node_type = ReaderNodeType;
 166     p_reader->pf_name = ReaderName;
 167     p_reader->pf_value = ReaderValue;
 168     p_reader->pf_next_attr = ReaderNextAttr;
 169     p_reader->pf_use_dtd = ReaderUseDTD;
 170
 171     return p_reader;
 172 }
 173
 174 static void ReaderDelete( xml_reader_t *p_reader )
 175 {
 176     xmlFreeTextReader( p_reader->p_sys->p_reader );
 177     free( p_reader->p_sys );
 178     free( p_reader );
 179 }
 180
 181 static int ReaderUseDTD ( xml_reader_t *p_reader, bool b_use )
 182 {
 183     /* Activate DTD validation */
 184     xmlTextReaderSetParserProp( p_reader->p_sys->p_reader,
 185                                 XML_PARSER_DEFAULTATTRS, b_use );
 186     xmlTextReaderSetParserProp( p_reader->p_sys->p_reader,
 187                                 XML_PARSER_VALIDATE, b_use );
 188
 189     return VLC_SUCCESS;
 190 }
 191
 192 static int ReaderRead( xml_reader_t *p_reader )
 193 {
 194     int i_ret = xmlTextReaderRead( p_reader->p_sys->p_reader );
 195
 196 #if 0
 197     switch( i_ret )
 198     {
 199     default:
 200     }
 201 #endif
 202
 203     return i_ret;
 204 }
 205
 206 static int ReaderNodeType( xml_reader_t *p_reader )
 207 {
 208     int i_ret = xmlTextReaderNodeType( p_reader->p_sys->p_reader );
 209
 210     switch( i_ret )
 211     {
 212     case XML_READER_TYPE_ELEMENT:
 213         i_ret = XML_READER_STARTELEM;
 214         break;
 215     case XML_READER_TYPE_END_ELEMENT:
 216         i_ret = XML_READER_ENDELEM;
 217         break;
 218     case XML_READER_TYPE_CDATA:
 219     case XML_READER_TYPE_TEXT:
 220         i_ret = XML_READER_TEXT;
 221         break;
 222     case -1:
 223         i_ret = -1;
 224         break;
 225     default:
 226         i_ret = XML_READER_NONE;
 227         break;
 228     }
 229
 230     return i_ret;
 231 }
 232
 233 static char *ReaderName( xml_reader_t *p_reader )
 234 {
 235     const xmlChar *psz_name =
 236         xmlTextReaderConstName( p_reader->p_sys->p_reader );
 237
 238     if( psz_name ) return strdup( (const char *)psz_name );
 239     else return 0;
 240 }
 241
 242 static char *ReaderValue( xml_reader_t *p_reader )
 243 {
 244     const xmlChar *psz_value =
 245         xmlTextReaderConstValue( p_reader->p_sys->p_reader );
 246
 247     if( psz_value ) return strdup( (const char *)psz_value );
 248     else return 0;
 249 }
 250
 251 static int ReaderNextAttr( xml_reader_t *p_reader )
 252 {
 253     return ( xmlTextReaderMoveToNextAttribute( p_reader->p_sys->p_reader )
 254              == 1 ) ? VLC_SUCCESS : VLC_EGENERIC;
 255 }
 256
 257 static int StreamRead( void *p_context, char *p_buffer, int i_buffer )
 258 {
 259     stream_t *s = (stream_t*)p_context;
 260     return stream_Read( s, p_buffer, i_buffer );
 261 }