]> git.sesse.net Git - vlc/blob - modules/demux/playlist/podcast.c
Force to specify options flags in input_item_New*.
[vlc] / modules / demux / playlist / podcast.c
1 /*****************************************************************************
2  * podcast.c : podcast playlist imports
3  *****************************************************************************
4  * Copyright (C) 2005 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Antoine Cellerier <dionoea -at- videolan -dot- 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 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <vlc_common.h>
32 #include <vlc_demux.h>
33
34 #include "playlist.h"
35 #include "vlc_xml.h"
36
37 struct demux_sys_t
38 {
39     char *psz_prefix;
40     xml_t *p_xml;
41     xml_reader_t *p_xml_reader;
42 };
43
44 /*****************************************************************************
45  * Local prototypes
46  *****************************************************************************/
47 static int Demux( demux_t *p_demux);
48 static int Control( demux_t *p_demux, int i_query, va_list args );
49
50 /*****************************************************************************
51  * Import_podcast: main import function
52  *****************************************************************************/
53 int Import_podcast( vlc_object_t *p_this )
54 {
55     demux_t *p_demux = (demux_t *)p_this;
56
57     if( !demux_IsForced( p_demux, "podcast" ) )
58         return VLC_EGENERIC;
59
60     STANDARD_DEMUX_INIT_MSG( "using podcast reader" );
61     p_demux->p_sys->psz_prefix = FindPrefix( p_demux );
62     p_demux->p_sys->p_xml = NULL;
63     p_demux->p_sys->p_xml_reader = NULL;
64
65     return VLC_SUCCESS;
66 }
67
68 /*****************************************************************************
69  * Deactivate: frees unused data
70  *****************************************************************************/
71 void Close_podcast( vlc_object_t *p_this )
72 {
73     demux_t *p_demux = (demux_t *)p_this;
74     demux_sys_t *p_sys = p_demux->p_sys;
75
76     free( p_sys->psz_prefix );
77     if( p_sys->p_xml_reader ) xml_ReaderDelete( p_sys->p_xml, p_sys->p_xml_reader );
78     if( p_sys->p_xml ) xml_Delete( p_sys->p_xml );
79     free( p_sys );
80 }
81
82 /* "specs" : http://phobos.apple.com/static/iTunesRSS.html */
83 static int Demux( demux_t *p_demux )
84 {
85     demux_sys_t *p_sys = p_demux->p_sys;
86
87     bool b_item = false;
88     bool b_image = false;
89     int i_ret;
90
91     xml_t *p_xml;
92     xml_reader_t *p_xml_reader;
93     char *psz_elname = NULL;
94     char *psz_item_mrl = NULL;
95     char *psz_item_size = NULL;
96     char *psz_item_type = NULL;
97     char *psz_item_name = NULL;
98     char *psz_item_date = NULL;
99     char *psz_item_author = NULL;
100     char *psz_item_category = NULL;
101     char *psz_item_duration = NULL;
102     char *psz_item_keywords = NULL;
103     char *psz_item_subtitle = NULL;
104     char *psz_item_summary = NULL;
105     int i_type;
106     input_item_t *p_input;
107
108     INIT_PLAYLIST_STUFF;
109
110     p_xml = p_sys->p_xml = xml_Create( p_demux );
111     if( !p_xml ) return -1;
112
113 /*    psz_elname = stream_ReadLine( p_demux->s );
114     if( psz_elname ) free( psz_elname );
115     psz_elname = 0;*/
116
117     p_xml_reader = xml_ReaderCreate( p_xml, p_demux->s );
118     if( !p_xml_reader ) return -1;
119     p_sys->p_xml_reader = p_xml_reader;
120
121     /* xml */
122     /* check root node */
123     if( xml_ReaderRead( p_xml_reader ) != 1 )
124     {
125         msg_Err( p_demux, "invalid file (no root node)" );
126         return -1;
127     }
128
129     while( xml_ReaderNodeType( p_xml_reader ) == XML_READER_NONE )
130         if( xml_ReaderRead( p_xml_reader ) != 1 )
131         {
132             msg_Err( p_demux, "invalid file (no root node)" );
133             return -1;
134         }
135
136     if( xml_ReaderNodeType( p_xml_reader ) != XML_READER_STARTELEM ||
137         ( psz_elname = xml_ReaderName( p_xml_reader ) ) == NULL ||
138         strcmp( psz_elname, "rss" ) )
139     {
140         msg_Err( p_demux, "invalid root node %i, %s",
141                  xml_ReaderNodeType( p_xml_reader ), psz_elname );
142         free( psz_elname );
143         return -1;
144     }
145     free( psz_elname ); psz_elname = NULL;
146
147     while( (i_ret = xml_ReaderRead( p_xml_reader )) == 1 )
148     {
149         // Get the node type
150         i_type = xml_ReaderNodeType( p_xml_reader );
151         switch( i_type )
152         {
153             // Error
154             case -1:
155                 return -1;
156                 break;
157
158             case XML_READER_STARTELEM:
159             {
160                 // Read the element name
161                 free( psz_elname );
162                 psz_elname = xml_ReaderName( p_xml_reader );
163                 if( !psz_elname ) return -1;
164
165                 if( !strcmp( psz_elname, "item" ) )
166                 {
167                     b_item = true;
168                 }
169                 else if( !strcmp( psz_elname, "image" ) )
170                 {
171                     b_item = true;
172                 }
173
174                 // Read the attributes
175                 while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
176                 {
177                     char *psz_name = xml_ReaderName( p_xml_reader );
178                     char *psz_value = xml_ReaderValue( p_xml_reader );
179                     if( !psz_name || !psz_value )
180                     {
181                         free( psz_name );
182                         free( psz_value );
183                         free( psz_elname );
184                         return -1;
185                     }
186                     if( !strcmp( psz_elname, "enclosure" ) &&
187                         !strcmp( psz_name, "url" ) )
188                     {
189                         free( psz_item_mrl );
190                         psz_item_mrl = strdup( psz_value );
191                     }
192                     else if( !strcmp( psz_elname, "enclosure" ) &&
193                         !strcmp( psz_name, "length" ) )
194                     {
195                         free( psz_item_size );
196                         psz_item_size = strdup( psz_value );
197                     }
198                     else if( !strcmp( psz_elname, "enclosure" ) &&
199                         !strcmp( psz_name, "type" ) )
200                     {
201                         free( psz_item_type );
202                         psz_item_type = strdup( psz_value );
203                     }
204                     else
205                     {
206                         msg_Dbg( p_demux,"unhandled attribure %s in element %s",
207                                   psz_name, psz_elname );
208                     }
209                     free( psz_name );
210                     free( psz_value );
211                 }
212                 break;
213             }
214             case XML_READER_TEXT:
215             {
216 #define SET_DATA( field, name ) else if( b_item == true \
217                 && !strcmp( psz_elname, name ) ) \
218                 { \
219                     field = strdup( psz_text ); \
220                 }
221                 char *psz_text = xml_ReaderValue( p_xml_reader );
222                 /* item specific meta data */
223                 if( b_item == true && !strcmp( psz_elname, "title" ) )
224                 {
225                     psz_item_name = strdup( psz_text );
226                 }
227                 else if( b_item == true
228                          && ( !strcmp( psz_elname, "itunes:author" )
229                             ||!strcmp( psz_elname, "author" ) ) )
230                 { /* <author> isn't standard iTunes podcast stuff */
231                     psz_item_author = strdup( psz_text );
232                 }
233                 else if( b_item == true
234                          && ( !strcmp( psz_elname, "itunes:summary" )
235                             ||!strcmp( psz_elname, "description" ) ) )
236                 { /* <description> isn't standard iTunes podcast stuff */
237                     psz_item_summary = strdup( psz_text );
238                 }
239                 SET_DATA( psz_item_date, "pubDate" )
240                 SET_DATA( psz_item_category, "itunes:category" )
241                 SET_DATA( psz_item_duration, "itunes:duration" )
242                 SET_DATA( psz_item_keywords, "itunes:keywords" )
243                 SET_DATA( psz_item_subtitle, "itunes:subtitle" )
244 #undef SET_DATA
245                 /* toplevel meta data */
246                 else if( b_item == false && b_image == false
247                          && !strcmp( psz_elname, "title" ) )
248                 {
249                     input_item_SetName( p_current_input, psz_text );
250                 }
251 #define ADD_GINFO( info, name ) \
252     else if( !b_item && !b_image && !strcmp( psz_elname, name ) ) \
253     { \
254         input_item_AddInfo( p_current_input, _("Podcast Info"), \
255                                 _( info ), "%s", psz_text ); \
256     }
257                 ADD_GINFO( "Podcast Link", "link" )
258                 ADD_GINFO( "Podcast Copyright", "copyright" )
259                 ADD_GINFO( "Podcast Category", "itunes:category" )
260                 ADD_GINFO( "Podcast Keywords", "itunes:keywords" )
261                 ADD_GINFO( "Podcast Subtitle", "itunes:subtitle" )
262 #undef ADD_GINFO
263                 else if( b_item == false && b_image == false
264                          && ( !strcmp( psz_elname, "itunes:summary" )
265                             ||!strcmp( psz_elname, "description" ) ) )
266                 { /* <description> isn't standard iTunes podcast stuff */
267                     input_item_AddInfo( p_current_input,
268                              _( "Podcast Info" ), _( "Podcast Summary" ),
269                              "%s", psz_text );
270                 }
271                 else
272                 {
273                     msg_Dbg( p_demux, "unhandled text in element '%s'",
274                               psz_elname );
275                 }
276                 free( psz_text );
277                 break;
278             }
279             // End element
280             case XML_READER_ENDELEM:
281             {
282                 // Read the element name
283                 free( psz_elname );
284                 psz_elname = xml_ReaderName( p_xml_reader );
285                 if( !psz_elname ) return -1;
286                 if( !strcmp( psz_elname, "item" ) )
287                 {
288                     if( psz_item_mrl == NULL )
289                     {
290                         msg_Err( p_demux, "invalid XML (no enclosure markup)" );
291                         free( psz_elname );
292                         return -1;
293                     }
294                     p_input = input_item_NewExt( p_demux, psz_item_mrl,
295                                                 psz_item_name, 0, NULL, 0, -1 );
296                     if( p_input == NULL ) break;
297 #define ADD_INFO( info, field ) \
298     if( field ) { input_item_AddInfo( p_input, \
299                             _( "Podcast Info" ),  _( info ), "%s", field ); }
300                     ADD_INFO( "Podcast Publication Date", psz_item_date  );
301                     ADD_INFO( "Podcast Author", psz_item_author );
302                     ADD_INFO( "Podcast Subcategory", psz_item_category );
303                     ADD_INFO( "Podcast Duration", psz_item_duration );
304                     ADD_INFO( "Podcast Keywords", psz_item_keywords );
305                     ADD_INFO( "Podcast Subtitle", psz_item_subtitle );
306                     ADD_INFO( "Podcast Summary", psz_item_summary );
307                     ADD_INFO( "Podcast Type", psz_item_type );
308 #undef ADD_INFO
309                     if( psz_item_size )
310                     {
311                         input_item_AddInfo( p_input,
312                                                 _( "Podcast Info" ),
313                                                 _( "Podcast Size" ),
314                                                 "%s bytes",
315                                                 psz_item_size );
316                     }
317                     input_item_AddSubItem( p_current_input, p_input );
318                     vlc_gc_decref( p_input );
319                     FREENULL( psz_item_name );
320                     FREENULL( psz_item_mrl );
321                     FREENULL( psz_item_size );
322                     FREENULL( psz_item_type );
323                     FREENULL( psz_item_date );
324                     FREENULL( psz_item_author );
325                     FREENULL( psz_item_category );
326                     FREENULL( psz_item_duration );
327                     FREENULL( psz_item_keywords );
328                     FREENULL( psz_item_subtitle );
329                     FREENULL( psz_item_summary );
330                     b_item = false;
331                 }
332                 else if( !strcmp( psz_elname, "image" ) )
333                 {
334                     b_image = false;
335                 }
336                 free( psz_elname );
337                 psz_elname = strdup( "" );
338
339                 break;
340             }
341         }
342     }
343
344     if( i_ret != 0 )
345     {
346         msg_Warn( p_demux, "error while parsing data" );
347     }
348
349     free( psz_elname );
350
351     HANDLE_PLAY_AND_RELEASE;
352     return 0; /* Needed for correct operation of go back */
353 }
354
355 static int Control( demux_t *p_demux, int i_query, va_list args )
356 {
357     VLC_UNUSED(p_demux); VLC_UNUSED(i_query); VLC_UNUSED(args);
358     return VLC_EGENERIC;
359 }