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