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