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
  30 #include "vlc_block.h"
  31 #include "vlc_stream.h"
  32 #include "vlc_xml.h"
  33
  34 #include <libxml/xmlreader.h>
  35 #include <libxml/catalog.h>
  36
  37 /*****************************************************************************
  38  * Module descriptor
  39  *****************************************************************************/
  40 static int  Open ( vlc_object_t * );
  41 static void Close( vlc_object_t * );
  42
  43 vlc_module_begin();
  44     set_description( _("XML Parser (using libxml2)") );
  45     set_capability( "xml", 10 );
  46     set_callbacks( Open, Close );
  47 vlc_module_end();
  48
  49 struct xml_reader_sys_t
  50 {
  51     /* libxml2 reader context */
  52     xmlTextReaderPtr p_reader;
  53 };
  54
  55 static xml_reader_t *ReaderCreate( xml_t *, stream_t * );
  56 static void ReaderDelete( xml_reader_t * );
  57 static int ReaderRead( xml_reader_t * );
  58 static int ReaderNodeType( xml_reader_t * );
  59 static char *ReaderName( xml_reader_t * );
  60 static char *ReaderValue( xml_reader_t * );
  61 static int ReaderNextAttr( xml_reader_t * );
  62
  63 static int ReaderUseDTD ( xml_reader_t *, vlc_bool_t );
  64
  65 static void CatalogLoad( xml_t *, const char * );
  66 static void CatalogAdd( xml_t *, const char *, const char *, const char * );
  67 static int StreamRead( void *p_context, char *p_buffer, int i_buffer );
  68
  69 /*****************************************************************************
  70  * Module initialization
  71  *****************************************************************************/
  72 static int Open( vlc_object_t *p_this )
  73 {
  74     xml_t *p_xml = (xml_t *)p_this;
  75
  76     p_xml->pf_reader_create = ReaderCreate;
  77     p_xml->pf_reader_delete = ReaderDelete;
  78
  79     p_xml->pf_catalog_load = CatalogLoad;
  80     p_xml->pf_catalog_add  = CatalogAdd;
  81
  82     return VLC_SUCCESS;
  83 }
  84
  85 /*****************************************************************************
  86  * Module deinitialization
  87  *****************************************************************************/
  88 static void Close( vlc_object_t *p_this )
  89 {
  90     return;
  91 }
  92
  93 /*****************************************************************************
  94  * Catalogue functions
  95  *****************************************************************************/
  96 static void CatalogLoad( xml_t *p_xml, const char *psz_filename )
  97 {
  98     if( !psz_filename ) xmlInitializeCatalog();
  99     else xmlLoadCatalog( psz_filename );
 100 }
 101
 102 static void CatalogAdd( xml_t *p_xml, const char *psz_arg1,
 103                           const char *psz_arg2, const char *psz_filename )
 104 {
 105     xmlCatalogAdd( (unsigned char*)psz_arg1, (unsigned char*)psz_arg2,
 106         (unsigned char*)psz_filename );
 107 }
 108
 109 /*****************************************************************************
 110  * Reader functions
 111  *****************************************************************************/
 112 static void ReaderErrorHandler( void *p_arg, const char *p_msg,
 113                                 xmlParserSeverities severity,
 114                                 xmlTextReaderLocatorPtr locator)
 115 {
 116     xml_reader_t *p_reader = (xml_reader_t *)p_arg;
 117     int line = xmlTextReaderLocatorLineNumber( locator );
 118     msg_Err( p_reader->p_xml, "XML parser error (line %d) : %s", line, p_msg );
 119 }
 120
 121 static xml_reader_t *ReaderCreate( xml_t *p_xml, stream_t *p_stream )
 122 {
 123     xml_reader_t *p_reader;
 124     xml_reader_sys_t *p_sys;
 125     xmlTextReaderPtr p_libxml_reader;
 126
 127     p_libxml_reader = xmlReaderForIO( StreamRead, NULL, p_stream,
 128                                       NULL, NULL, 0 );
 129     if( !p_libxml_reader )
 130     {
 131         msg_Err( p_xml, "failed to create XML parser" );
 132         return 0;
 133     }
 134
 135     p_reader = malloc( sizeof(xml_reader_t) );
 136     p_reader->p_sys = p_sys = malloc( sizeof(xml_reader_sys_t) );
 137     p_reader->p_sys->p_reader = p_libxml_reader;
 138     p_reader->p_xml = p_xml;
 139
 140     /* Set the error handler */
 141     xmlTextReaderSetErrorHandler( p_libxml_reader,
 142                                   ReaderErrorHandler, p_reader );
 143
 144
 145     p_reader->pf_read = ReaderRead;
 146     p_reader->pf_node_type = ReaderNodeType;
 147     p_reader->pf_name = ReaderName;
 148     p_reader->pf_value = ReaderValue;
 149     p_reader->pf_next_attr = ReaderNextAttr;
 150     p_reader->pf_use_dtd = ReaderUseDTD;
 151
 152     return p_reader;
 153 }
 154
 155 static void ReaderDelete( xml_reader_t *p_reader )
 156 {
 157     xmlFreeTextReader( p_reader->p_sys->p_reader );
 158     free( p_reader->p_sys );
 159     free( p_reader );
 160 }
 161
 162 static int ReaderUseDTD ( xml_reader_t *p_reader, vlc_bool_t b_use )
 163 {
 164     /* Activate DTD validation */
 165     xmlTextReaderSetParserProp( p_reader->p_sys->p_reader,
 166                                 XML_PARSER_DEFAULTATTRS, b_use );
 167     xmlTextReaderSetParserProp( p_reader->p_sys->p_reader,
 168                                 XML_PARSER_VALIDATE, b_use );
 169
 170     return VLC_SUCCESS;
 171 }
 172
 173 static int ReaderRead( xml_reader_t *p_reader )
 174 {
 175     int i_ret = xmlTextReaderRead( p_reader->p_sys->p_reader );
 176
 177 #if 0
 178     switch( i_ret )
 179     {
 180     default:
 181     }
 182 #endif
 183
 184     return i_ret;
 185 }
 186
 187 static int ReaderNodeType( xml_reader_t *p_reader )
 188 {
 189     int i_ret = xmlTextReaderNodeType( p_reader->p_sys->p_reader );
 190
 191     switch( i_ret )
 192     {
 193     case XML_READER_TYPE_ELEMENT:
 194         i_ret = XML_READER_STARTELEM;
 195         break;
 196     case XML_READER_TYPE_END_ELEMENT:
 197         i_ret = XML_READER_ENDELEM;
 198         break;
 199     case XML_READER_TYPE_CDATA:
 200     case XML_READER_TYPE_TEXT:
 201         i_ret = XML_READER_TEXT;
 202         break;
 203     case -1:
 204         i_ret = -1;
 205         break;
 206     default:
 207         i_ret = XML_READER_NONE;
 208         break;
 209     }
 210
 211     return i_ret;
 212 }
 213
 214 static char *ReaderName( xml_reader_t *p_reader )
 215 {
 216     const xmlChar *psz_name =
 217         xmlTextReaderConstName( p_reader->p_sys->p_reader );
 218
 219     if( psz_name ) return strdup( (const char *)psz_name );
 220     else return 0;
 221 }
 222
 223 static char *ReaderValue( xml_reader_t *p_reader )
 224 {
 225     const xmlChar *psz_value =
 226         xmlTextReaderConstValue( p_reader->p_sys->p_reader );
 227
 228     if( psz_value ) return strdup( (const char *)psz_value );
 229     else return 0;
 230 }
 231
 232 static int ReaderNextAttr( xml_reader_t *p_reader )
 233 {
 234     return ( xmlTextReaderMoveToNextAttribute( p_reader->p_sys->p_reader )
 235              == 1 ) ? VLC_SUCCESS : VLC_EGENERIC;
 236 }
 237
 238 static int StreamRead( void *p_context, char *p_buffer, int i_buffer )
 239 {
 240     stream_t *s = (stream_t*)p_context;
 241     return stream_Read( s, p_buffer, i_buffer );
 242 }