itml: cleaning and factorize.
[vlc.git] / modules / demux / playlist / itml.c
1 /*******************************************************************************
2  * itml.c : iTunes Music Library import functions
3  *******************************************************************************
4  * Copyright (C) 2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Yoann Peronneau <yoann@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  * \file modules/demux/playlist/itml.c
25  * \brief iTunes Music Library import functions
26  */
27
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
31
32 #include <vlc_common.h>
33 #include <vlc_demux.h>
34 #include <vlc_xml.h>
35 #include <vlc_strings.h>
36 #include <vlc_url.h>
37
38 #include "itml.h"
39 #include "playlist.h"
40
41 struct demux_sys_t
42 {
43     int i_ntracks;
44 };
45
46 static int Control( demux_t *, int, va_list );
47 static int Demux( demux_t * );
48
49 /**
50  * \brief iTML submodule initialization function
51  */
52 int Import_iTML( vlc_object_t *p_this )
53 {
54     DEMUX_BY_EXTENSION_OR_FORCED_MSG( ".xml", "itml",
55                                       "using iTunes Media Library reader" );
56     return VLC_SUCCESS;
57 }
58
59 void Close_iTML( vlc_object_t *p_this )
60 {
61     demux_t *p_demux = (demux_t *)p_this;
62     free( p_demux->p_sys );
63 }
64
65 /**
66  * \brief demuxer function for iTML parsing
67  */
68 int Demux( demux_t *p_demux )
69 {
70     xml_t *p_xml = NULL;
71     xml_reader_t *p_xml_reader = NULL;
72     char *psz_name = NULL;
73
74     INIT_PLAYLIST_STUFF;
75     p_demux->p_sys->i_ntracks = 0;
76
77     /* create new xml parser from stream */
78     p_xml = xml_Create( p_demux );
79     if( !p_xml )
80         goto end;
81
82     p_xml_reader = xml_ReaderCreate( p_xml, p_demux->s );
83     if( !p_xml_reader )
84         goto end;
85
86     /* locating the root node */
87     do
88     {
89         if( xml_ReaderRead( p_xml_reader ) != 1 )
90         {
91             msg_Err( p_demux, "can't read xml stream" );
92             goto end;
93         }
94     } while( xml_ReaderNodeType( p_xml_reader ) != XML_READER_STARTELEM );
95
96     /* checking root node name */
97     psz_name = xml_ReaderName( p_xml_reader );
98     if( !psz_name || strcmp( psz_name, "plist" ) )
99     {
100         msg_Err( p_demux, "invalid root node name: %s", psz_name );
101         goto end;
102     }
103
104     xml_elem_hnd_t pl_elements[] =
105         { {"dict",    COMPLEX_CONTENT, {.cmplx = parse_plist_dict} } };
106     parse_plist_node( p_demux, p_current_input, NULL, p_xml_reader, "plist",
107                       pl_elements );
108
109     HANDLE_PLAY_AND_RELEASE;
110
111 end:
112     free( psz_name );
113     if( p_xml_reader )
114         xml_ReaderDelete( p_xml, p_xml_reader );
115     if( p_xml )
116         xml_Delete( p_xml );
117
118     /* Needed for correct operation of go back */
119     return 0;
120 }
121
122 /** \brief dummy function for demux callback interface */
123 static int Control( demux_t *p_demux, int i_query, va_list args )
124 {
125     VLC_UNUSED(p_demux); VLC_UNUSED(i_query); VLC_UNUSED(args);
126     return VLC_EGENERIC;
127 }
128
129 /**
130  * \brief parse the root node of the playlist
131  */
132 static bool parse_plist_node( demux_t *p_demux, input_item_t *p_input_item,
133                               track_elem_t *p_track, xml_reader_t *p_xml_reader,
134                               const char *psz_element,
135                               xml_elem_hnd_t *p_handlers )
136 {
137     VLC_UNUSED(p_track); VLC_UNUSED(psz_element);
138     char *psz_name;
139     char *psz_value;
140     bool b_version_found = false;
141
142     /* read all playlist attributes */
143     while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
144     {
145         psz_name = xml_ReaderName( p_xml_reader );
146         psz_value = xml_ReaderValue( p_xml_reader );
147         if( !psz_name || !psz_value )
148         {
149             msg_Err( p_demux, "invalid xml stream @ <plist>" );
150             free( psz_name );
151             free( psz_value );
152             return false;
153         }
154         /* attribute: version */
155         if( !strcmp( psz_name, "version" ) )
156         {
157             b_version_found = true;
158             if( strcmp( psz_value, "1.0" ) )
159                 msg_Warn( p_demux, "unsupported iTunes Media Library version" );
160         }
161         /* unknown attribute */
162         else
163             msg_Warn( p_demux, "invalid <plist> attribute:\"%s\"", psz_name);
164
165         free( psz_name );
166         free( psz_value );
167     }
168
169     /* attribute version is mandatory !!! */
170     if( !b_version_found )
171         msg_Warn( p_demux, "<plist> requires \"version\" attribute" );
172
173     return parse_dict( p_demux, p_input_item, NULL, p_xml_reader,
174                        "plist", p_handlers );
175 }
176
177 /**
178  * \brief parse a <dict>
179  * \param COMPLEX_INTERFACE
180  */
181 static bool parse_dict( demux_t *p_demux, input_item_t *p_input_item,
182                         track_elem_t *p_track, xml_reader_t *p_xml_reader,
183                         const char *psz_element, xml_elem_hnd_t *p_handlers )
184 {
185     int i_node;
186     char *psz_name = NULL;
187     char *psz_value = NULL;
188     char *psz_key = NULL;
189     xml_elem_hnd_t *p_handler = NULL;
190     bool b_ret = false;
191
192     while( xml_ReaderRead( p_xml_reader ) == 1 )
193     {
194         i_node = xml_ReaderNodeType( p_xml_reader );
195         switch( i_node )
196         {
197             case XML_READER_NONE:
198                 break;
199
200             case XML_READER_STARTELEM:
201                 /*  element start tag  */
202                 psz_name = xml_ReaderName( p_xml_reader );
203                 if( !psz_name || !*psz_name )
204                 {
205                     msg_Err( p_demux, "invalid xml stream" );
206                     goto end;
207                 }
208                 /* choose handler */
209                 for( p_handler = p_handlers;
210                      p_handler->name && strcmp( psz_name, p_handler->name );
211                      p_handler++ );
212                 if( !p_handler->name )
213                 {
214                     msg_Err( p_demux, "unexpected element <%s>", psz_name );
215                     goto end;
216                 }
217                 FREE_NAME();
218                 /* complex content is parsed in a separate function */
219                 if( p_handler->type == COMPLEX_CONTENT )
220                 {
221                     if( p_handler->pf_handler.cmplx( p_demux,
222                                                      p_input_item,
223                                                      NULL,
224                                                      p_xml_reader,
225                                                      p_handler->name,
226                                                      NULL ) )
227                     {
228                         p_handler = NULL;
229                         FREE_ATT_KEY();
230                     }
231                     else
232                     {
233                         goto end;
234                     }
235                 }
236                 break;
237
238             case XML_READER_TEXT:
239                 /* simple element content */
240                 FREE_ATT();
241                 psz_value = xml_ReaderValue( p_xml_reader );
242                 if( !psz_value )
243                 {
244                     msg_Err( p_demux, "invalid xml stream" );
245                     goto end;
246                 }
247                 break;
248
249             case XML_READER_ENDELEM:
250                 /* element end tag */
251                 psz_name = xml_ReaderName( p_xml_reader );
252                 if( !psz_name )
253                 {
254                     msg_Err( p_demux, "invalid xml stream" );
255                     goto end;
256                 }
257                 /* leave if the current parent node <track> is terminated */
258                 if( !strcmp( psz_name, psz_element ) )
259                 {
260                     b_ret = true;
261                     goto end;
262                 }
263                 /* there MUST have been a start tag for that element name */
264                 if( !p_handler || !p_handler->name
265                     || strcmp( p_handler->name, psz_name ))
266                 {
267                     msg_Err( p_demux, "there's no open element left for <%s>",
268                              psz_name );
269                     goto end;
270                 }
271                 /* special case: key */
272                 if( !strcmp( p_handler->name, "key" ) )
273                 {
274                     psz_key = strdup( psz_value );
275                 }
276                 /* call the simple handler */
277                 else if( p_handler->pf_handler.smpl )
278                 {
279                     p_handler->pf_handler.smpl( p_track, psz_key, psz_value );
280                 }
281                 FREE_ATT();
282                 p_handler = NULL;
283                 break;
284
285             default:
286                 /* unknown/unexpected xml node */
287                 msg_Err( p_demux, "unexpected xml node %i", i_node );
288                 goto end;
289         }
290         FREE_NAME();
291     }
292     msg_Err( p_demux, "unexpected end of xml data" );
293
294 end:
295     FREE_ATT_KEY();
296     return b_ret;
297 }
298
299 static bool parse_plist_dict( demux_t *p_demux, input_item_t *p_input_item,
300                               track_elem_t *p_track, xml_reader_t *p_xml_reader,
301                               const char *psz_element,
302                               xml_elem_hnd_t *p_handlers )
303 {
304     VLC_UNUSED(p_track); VLC_UNUSED(psz_element); VLC_UNUSED(p_handlers);
305     xml_elem_hnd_t pl_elements[] =
306         { {"dict",    COMPLEX_CONTENT, {.cmplx = parse_tracks_dict} },
307           {"array",   SIMPLE_CONTENT,  {NULL} },
308           {"key",     SIMPLE_CONTENT,  {NULL} },
309           {"integer", SIMPLE_CONTENT,  {NULL} },
310           {"string",  SIMPLE_CONTENT,  {NULL} },
311           {"date",    SIMPLE_CONTENT,  {NULL} },
312           {"true",    SIMPLE_CONTENT,  {NULL} },
313           {"false",   SIMPLE_CONTENT,  {NULL} },
314           {NULL,      UNKNOWN_CONTENT, {NULL} }
315         };
316
317     return parse_dict( p_demux, p_input_item, NULL, p_xml_reader,
318                        "dict", pl_elements );
319 }
320
321 static bool parse_tracks_dict( demux_t *p_demux, input_item_t *p_input_item,
322                                track_elem_t *p_track, xml_reader_t *p_xml_reader,
323                                const char *psz_element,
324                                xml_elem_hnd_t *p_handlers )
325 {
326     VLC_UNUSED(p_track); VLC_UNUSED(psz_element); VLC_UNUSED(p_handlers);
327     xml_elem_hnd_t tracks_elements[] =
328         { {"dict",    COMPLEX_CONTENT, {.cmplx = parse_track_dict} },
329           {"key",     SIMPLE_CONTENT,  {NULL} },
330           {NULL,      UNKNOWN_CONTENT, {NULL} }
331         };
332
333     parse_dict( p_demux, p_input_item, NULL, p_xml_reader,
334                 "dict", tracks_elements );
335
336     msg_Info( p_demux, "added %i tracks successfully",
337               p_demux->p_sys->i_ntracks );
338
339     return true;
340 }
341
342 static bool parse_track_dict( demux_t *p_demux, input_item_t *p_input_item,
343                               track_elem_t *p_track, xml_reader_t *p_xml_reader,
344                               const char *psz_element,
345                               xml_elem_hnd_t *p_handlers )
346 {
347     VLC_UNUSED(psz_element); VLC_UNUSED(p_handlers);
348     input_item_t *p_new_input = NULL;
349     int i_ret = -1;
350     char *psz_uri = NULL;
351     p_track = new_track();
352
353     xml_elem_hnd_t track_elements[] =
354         { {"array",   COMPLEX_CONTENT, {.cmplx = skip_element} },
355           {"key",     SIMPLE_CONTENT,  {.smpl = save_data} },
356           {"integer", SIMPLE_CONTENT,  {.smpl = save_data} },
357           {"string",  SIMPLE_CONTENT,  {.smpl = save_data} },
358           {"date",    SIMPLE_CONTENT,  {.smpl = save_data} },
359           {"true",    SIMPLE_CONTENT,  {NULL} },
360           {"false",   SIMPLE_CONTENT,  {NULL} },
361           {NULL,      UNKNOWN_CONTENT, {NULL} }
362         };
363
364     i_ret = parse_dict( p_demux, p_input_item, p_track,
365                         p_xml_reader, "dict", track_elements );
366
367     msg_Dbg( p_demux, "name: %s, artist: %s, album: %s, genre: %s, trackNum: %s, location: %s",
368              p_track->name, p_track->artist, p_track->album, p_track->genre, p_track->trackNum, p_track->location );
369
370     if( !p_track->location )
371     {
372         msg_Err( p_demux, "Track needs Location" );
373         free_track( p_track );
374         return false;
375     }
376
377     psz_uri = decode_URI_duplicate( p_track->location );
378
379     if( psz_uri )
380     {
381         if( strlen( psz_uri ) > 17 &&
382             !strncmp( psz_uri, "file://localhost/", 17 ) )
383         {
384             /* remove 'localhost/' */
385             memmove( psz_uri + 7, psz_uri + 17, strlen( psz_uri ) - 9 );
386             msg_Info( p_demux, "Adding '%s'", psz_uri );
387
388             p_new_input = input_item_New( p_demux, psz_uri, NULL );
389             input_item_AddSubItem( p_input_item, p_new_input );
390
391             /* add meta info */
392             add_meta( p_new_input, p_track );
393             vlc_gc_decref( p_new_input );
394
395             p_demux->p_sys->i_ntracks++;
396         }
397         else
398         {
399             msg_Err( p_demux, "Don't know how to handle %s", psz_uri );
400         }
401         free( psz_uri );
402     }
403
404     free_track( p_track );
405     return i_ret;
406 }
407
408 static track_elem_t *new_track()
409 {
410     track_elem_t *p_track = NULL;
411     p_track = malloc( sizeof( track_elem_t ) );
412     if( p_track )
413     {
414         p_track->name = NULL;
415         p_track->artist = NULL;
416         p_track->album = NULL;
417         p_track->genre = NULL;
418         p_track->trackNum = NULL;
419         p_track->location = NULL;
420         p_track->duration = 0;
421     }
422     return p_track;
423 }
424
425 static void free_track( track_elem_t *p_track )
426 {
427     fprintf( stderr, "free track\n" );
428     if ( !p_track )
429         return;
430
431     FREENULL( p_track->name );
432     FREENULL( p_track->artist );
433     FREENULL( p_track->album );
434     FREENULL( p_track->genre );
435     FREENULL( p_track->trackNum );
436     FREENULL( p_track->location );
437     p_track->duration = 0;
438     free( p_track );
439 }
440
441 static bool save_data( track_elem_t *p_track, const char *psz_name,
442                        char *psz_value)
443 {
444     /* exit if setting is impossible */
445     if( !psz_name || !psz_value || !p_track )
446         return false;
447
448     /* re-convert xml special characters inside psz_value */
449     resolve_xml_special_chars( psz_value );
450
451 #define SAVE_INFO( name, value ) \
452     if( !strcmp( psz_name, name ) ) { p_track->value = strdup( psz_value ); }
453
454     SAVE_INFO( "Name", name )
455     else SAVE_INFO( "Artist", artist )
456     else SAVE_INFO( "Album", album )
457     else SAVE_INFO( "Genre", genre )
458     else SAVE_INFO( "Track Number", trackNum )
459     else SAVE_INFO( "Location", location )
460     else if( !strcmp( psz_name, "Total Time" ) )
461     {
462         long i_num = atol( psz_value );
463         p_track->duration = (mtime_t) i_num*1000;
464     }
465 #undef SAVE_INFO
466     return true;
467 }
468
469 /**
470  * \brief handles the supported <track> sub-elements
471  */
472 static bool add_meta( input_item_t *p_input_item, track_elem_t *p_track )
473 {
474     /* exit if setting is impossible */
475     if( !p_input_item || !p_track )
476         return false;
477
478 #define SET_INFO( type, prop ) \
479     if( p_track->prop ) {input_item_Set##type( p_input_item, p_track->prop );}
480     SET_INFO( Title, name )
481     SET_INFO( Artist, artist )
482     SET_INFO( Album, album )
483     SET_INFO( Genre, genre )
484     SET_INFO( TrackNum, trackNum )
485     SET_INFO( Duration, duration )
486 #undef SET_INFO
487     return true;
488 }
489
490 /**
491  * \brief skips complex element content that we can't manage
492  */
493 static bool skip_element( demux_t *p_demux, input_item_t *p_input_item,
494                           track_elem_t *p_track, xml_reader_t *p_xml_reader,
495                           const char *psz_element, xml_elem_hnd_t *p_handlers )
496 {
497     VLC_UNUSED(p_demux); VLC_UNUSED(p_input_item);
498     VLC_UNUSED(p_track); VLC_UNUSED(p_handlers);
499     char *psz_endname;
500
501     while( xml_ReaderRead( p_xml_reader ) == 1 )
502     {
503         if( xml_ReaderNodeType( p_xml_reader ) == XML_READER_ENDELEM )
504         {
505             psz_endname = xml_ReaderName( p_xml_reader );
506             if( !psz_endname )
507                 return false;
508             if( !strcmp( psz_element, psz_endname ) )
509             {
510                 free( psz_endname );
511                 return true;
512             }
513             else
514                 free( psz_endname );
515         }
516     }
517     return false;
518 }