1 /*****************************************************************************
2 * libxml.c: XML parser using libxml2
3 *****************************************************************************
4 * Copyright (C) 2004 the VideoLAN team
7 * Authors: Gildas Bazin <gbazin@videolan.org>
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.
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.
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 *****************************************************************************/
28 #include <vlc_common.h>
29 #include <vlc_plugin.h>
31 #include <vlc_block.h>
32 #include <vlc_stream.h>
35 #include <libxml/xmlreader.h>
36 #include <libxml/catalog.h>
38 /*****************************************************************************
40 *****************************************************************************/
41 static int Open ( vlc_object_t * );
42 static void Close( vlc_object_t * );
45 set_description( N_("XML Parser (using libxml2)") )
46 set_capability( "xml", 10 )
47 set_callbacks( Open, Close )
50 cannot_unload_broken_library()
55 struct xml_reader_sys_t
57 /* libxml2 reader context */
58 xmlTextReaderPtr p_reader;
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 * );
69 static int ReaderUseDTD ( xml_reader_t *, bool );
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 );
75 static vlc_mutex_t lock = VLC_STATIC_MUTEX;
77 /*****************************************************************************
78 * Module initialization
79 *****************************************************************************/
80 static int Open( vlc_object_t *p_this )
82 xml_t *p_xml = (xml_t *)p_this;
84 if( !xmlHasFeature( XML_WITH_THREAD ) )
87 vlc_mutex_lock( &lock );
89 vlc_mutex_unlock( &lock );
91 p_xml->pf_reader_create = ReaderCreate;
92 p_xml->pf_reader_delete = ReaderDelete;
94 p_xml->pf_catalog_load = CatalogLoad;
95 p_xml->pf_catalog_add = CatalogAdd;
100 /*****************************************************************************
101 * Module deinitialization
102 *****************************************************************************/
103 static void Close( vlc_object_t *p_this )
105 #ifdef LIBXML_GETS_A_CLUE_ABOUT_REENTRANCY_AND_MEMORY_LEAKS
106 vlc_mutex_lock( &lock );
108 vlc_mutex_unlock( &lock );
114 /*****************************************************************************
115 * Catalogue functions
116 *****************************************************************************/
117 static void CatalogLoad( xml_t *p_xml, const char *psz_filename )
120 if( !psz_filename ) xmlInitializeCatalog();
121 else xmlLoadCatalog( psz_filename );
124 static void CatalogAdd( xml_t *p_xml, const char *psz_arg1,
125 const char *psz_arg2, const char *psz_filename )
128 xmlCatalogAdd( (unsigned char*)psz_arg1, (unsigned char*)psz_arg2,
129 (unsigned char*)psz_filename );
132 /*****************************************************************************
134 *****************************************************************************/
135 static void ReaderErrorHandler( void *p_arg, const char *p_msg,
136 xmlParserSeverities severity,
137 xmlTextReaderLocatorPtr locator)
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 );
145 static xml_reader_t *ReaderCreate( xml_t *p_xml, stream_t *p_stream )
147 xml_reader_t *p_reader;
148 xml_reader_sys_t *p_sys;
149 xmlTextReaderPtr p_libxml_reader;
151 p_libxml_reader = xmlReaderForIO( StreamRead, NULL, p_stream,
153 if( !p_libxml_reader )
155 msg_Err( p_xml, "failed to create XML parser" );
159 p_reader = malloc( sizeof(xml_reader_t) );
162 xmlFreeTextReader( p_libxml_reader );
165 p_reader->p_sys = p_sys = malloc( sizeof(xml_reader_sys_t) );
168 xmlFreeTextReader( p_libxml_reader );
172 p_reader->p_sys->p_reader = p_libxml_reader;
173 p_reader->p_xml = p_xml;
175 /* Set the error handler */
176 xmlTextReaderSetErrorHandler( p_libxml_reader,
177 ReaderErrorHandler, p_reader );
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;
190 static void ReaderDelete( xml_reader_t *p_reader )
192 xmlFreeTextReader( p_reader->p_sys->p_reader );
193 free( p_reader->p_sys );
197 static int ReaderUseDTD ( xml_reader_t *p_reader, bool b_use )
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 );
208 static int ReaderRead( xml_reader_t *p_reader )
210 int i_ret = xmlTextReaderRead( p_reader->p_sys->p_reader );
222 static int ReaderNodeType( xml_reader_t *p_reader )
224 int i_ret = xmlTextReaderNodeType( p_reader->p_sys->p_reader );
228 case XML_READER_TYPE_ELEMENT:
229 i_ret = XML_READER_STARTELEM;
231 case XML_READER_TYPE_END_ELEMENT:
232 i_ret = XML_READER_ENDELEM;
234 case XML_READER_TYPE_CDATA:
235 case XML_READER_TYPE_TEXT:
236 i_ret = XML_READER_TEXT;
242 i_ret = XML_READER_NONE;
249 static char *ReaderName( xml_reader_t *p_reader )
251 const xmlChar *psz_name =
252 xmlTextReaderConstName( p_reader->p_sys->p_reader );
254 return psz_name ? strdup( (const char *)psz_name ) : NULL;
257 static char *ReaderValue( xml_reader_t *p_reader )
259 const xmlChar *psz_value =
260 xmlTextReaderConstValue( p_reader->p_sys->p_reader );
262 return psz_value ? strdup( (const char *)psz_value ) : NULL;
265 static int ReaderNextAttr( xml_reader_t *p_reader )
267 return ( xmlTextReaderMoveToNextAttribute( p_reader->p_sys->p_reader )
268 == 1 ) ? VLC_SUCCESS : VLC_EGENERIC;
271 static int StreamRead( void *p_context, char *p_buffer, int i_buffer )
273 stream_t *s = (stream_t*)p_context;
274 return stream_Read( s, p_buffer, i_buffer );