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