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