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