8fa42deb5399235b634e930fa9509ccd81ecb32c
[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
35 #include "playlist.h"
36 #include "vlc_xml.h"
37 #include "vlc_strings.h"
38 #include "vlc_url.h"
39 #include "itml.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 = NULL;
139     char *psz_value = NULL;
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
191     while( xml_ReaderRead( p_xml_reader ) == 1 )
192     {
193         i_node = xml_ReaderNodeType( p_xml_reader );
194         switch( i_node )
195         {
196             case XML_READER_NONE:
197                 break;
198
199             case XML_READER_STARTELEM:
200                 /*  element start tag  */
201                 psz_name = xml_ReaderName( p_xml_reader );
202                 if( !psz_name || !*psz_name )
203                 {
204                     msg_Err( p_demux, "invalid xml stream" );
205                     FREE_ATT_KEY();
206                     return false;
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                     FREE_ATT_KEY();
216                     return false;
217                 }
218                 FREE_NAME();
219                 /* complex content is parsed in a separate function */
220                 if( p_handler->type == COMPLEX_CONTENT )
221                 {
222                     if( p_handler->pf_handler.cmplx( p_demux,
223                                                      p_input_item,
224                                                      NULL,
225                                                      p_xml_reader,
226                                                      p_handler->name,
227                                                      NULL ) )
228                     {
229                         p_handler = NULL;
230                         FREE_ATT_KEY();
231                     }
232                     else
233                     {
234                         FREE_ATT_KEY();
235                         return false;
236                     }
237                 }
238                 break;
239
240             case XML_READER_TEXT:
241                 /* simple element content */
242                 FREE_ATT();
243                 psz_value = xml_ReaderValue( p_xml_reader );
244                 if( !psz_value )
245                 {
246                     msg_Err( p_demux, "invalid xml stream" );
247                     FREE_ATT_KEY();
248                     return false;
249                 }
250                 break;
251
252             case XML_READER_ENDELEM:
253                 /* element end tag */
254                 psz_name = xml_ReaderName( p_xml_reader );
255                 if( !psz_name )
256                 {
257                     msg_Err( p_demux, "invalid xml stream" );
258                     FREE_ATT_KEY();
259                     return false;
260                 }
261                 /* leave if the current parent node <track> is terminated */
262                 if( !strcmp( psz_name, psz_element ) )
263                 {
264                     FREE_ATT_KEY();
265                     return true;
266                 }
267                 /* there MUST have been a start tag for that element name */
268                 if( !p_handler || !p_handler->name
269                     || strcmp( p_handler->name, psz_name ))
270                 {
271                     msg_Err( p_demux, "there's no open element left for <%s>",
272                              psz_name );
273                     FREE_ATT_KEY();
274                     return false;
275                 }
276                 /* special case: key */
277                 if( !strcmp( p_handler->name, "key" ) )
278                 {
279                     psz_key = strdup( psz_value );
280                 }
281                 /* call the simple handler */
282                 else if( p_handler->pf_handler.smpl )
283                 {
284                     p_handler->pf_handler.smpl( p_track, psz_key, psz_value );
285                 }
286                 FREE_ATT();
287                 p_handler = NULL;
288                 break;
289
290             default:
291                 /* unknown/unexpected xml node */
292                 msg_Err( p_demux, "unexpected xml node %i", i_node );
293                 FREE_ATT_KEY();
294                 return false;
295         }
296         FREE_NAME();
297     }
298     msg_Err( p_demux, "unexpected end of xml data" );
299     FREE_ATT_KEY();
300     return false;
301 }
302
303 static bool parse_plist_dict( demux_t *p_demux, input_item_t *p_input_item,
304                               track_elem_t *p_track, xml_reader_t *p_xml_reader,
305                               const char *psz_element,
306                               xml_elem_hnd_t *p_handlers )
307 {
308     VLC_UNUSED(p_track); VLC_UNUSED(psz_element); VLC_UNUSED(p_handlers);
309     xml_elem_hnd_t pl_elements[] =
310         { {"dict",    COMPLEX_CONTENT, {.cmplx = parse_tracks_dict} },
311           {"array",   SIMPLE_CONTENT,  {NULL} },
312           {"key",     SIMPLE_CONTENT,  {NULL} },
313           {"integer", SIMPLE_CONTENT,  {NULL} },
314           {"string",  SIMPLE_CONTENT,  {NULL} },
315           {"date",    SIMPLE_CONTENT,  {NULL} },
316           {"true",    SIMPLE_CONTENT,  {NULL} },
317           {"false",   SIMPLE_CONTENT,  {NULL} },
318           {NULL,      UNKNOWN_CONTENT, {NULL} }
319         };
320
321     return parse_dict( p_demux, p_input_item, NULL, p_xml_reader,
322                        "dict", pl_elements );
323 }
324
325 static bool parse_tracks_dict( demux_t *p_demux, input_item_t *p_input_item,
326                                track_elem_t *p_track, xml_reader_t *p_xml_reader,
327                                const char *psz_element,
328                                xml_elem_hnd_t *p_handlers )
329 {
330     VLC_UNUSED(p_track); VLC_UNUSED(psz_element); VLC_UNUSED(p_handlers);
331     xml_elem_hnd_t tracks_elements[] =
332         { {"dict",    COMPLEX_CONTENT, {.cmplx = parse_track_dict} },
333           {"key",     SIMPLE_CONTENT,  {NULL} },
334           {NULL,      UNKNOWN_CONTENT, {NULL} }
335         };
336
337     parse_dict( p_demux, p_input_item, NULL, p_xml_reader,
338                 "dict", tracks_elements );
339
340     msg_Info( p_demux, "added %i tracks successfully",
341               p_demux->p_sys->i_ntracks );
342
343     return true;
344 }
345
346 static bool parse_track_dict( demux_t *p_demux, input_item_t *p_input_item,
347                               track_elem_t *p_track, xml_reader_t *p_xml_reader,
348                               const char *psz_element,
349                               xml_elem_hnd_t *p_handlers )
350 {
351     VLC_UNUSED(psz_element); VLC_UNUSED(p_handlers);
352     input_item_t *p_new_input = NULL;
353     int i_ret = -1;
354     char *psz_uri = NULL;
355     p_track = new_track();
356
357     xml_elem_hnd_t track_elements[] =
358         { {"array",   COMPLEX_CONTENT, {.cmplx = skip_element} },
359           {"key",     SIMPLE_CONTENT,  {.smpl = save_data} },
360           {"integer", SIMPLE_CONTENT,  {.smpl = save_data} },
361           {"string",  SIMPLE_CONTENT,  {.smpl = save_data} },
362           {"date",    SIMPLE_CONTENT,  {.smpl = save_data} },
363           {"true",    SIMPLE_CONTENT,  {NULL} },
364           {"false",   SIMPLE_CONTENT,  {NULL} },
365           {NULL,      UNKNOWN_CONTENT, {NULL} }
366         };
367
368     i_ret = parse_dict( p_demux, p_input_item, p_track,
369                         p_xml_reader, "dict", track_elements );
370
371     msg_Dbg( p_demux, "name: %s, artist: %s, album: %s, genre: %s, trackNum: %s, location: %s",
372              p_track->name, p_track->artist, p_track->album, p_track->genre, p_track->trackNum, p_track->location );
373
374     if( !p_track->location )
375     {
376         msg_Err( p_demux, "Track needs Location" );
377         free_track( p_track );
378         return false;
379     }
380
381     psz_uri = decode_URI_duplicate( p_track->location );
382
383     if( psz_uri )
384     {
385         if( strlen( psz_uri ) > 17 &&
386             !strncmp( psz_uri, "file://localhost/", 17 ) )
387         {
388             /* remove 'localhost/' */
389             memmove( psz_uri + 7, psz_uri + 17, strlen( psz_uri ) - 9 );
390             msg_Info( p_demux, "Adding '%s'", psz_uri );
391
392             p_new_input = input_item_New( p_demux, psz_uri, NULL );
393             input_item_AddSubItem( p_input_item, p_new_input );
394
395             /* add meta info */
396             add_meta( p_new_input, p_track );
397             vlc_gc_decref( p_new_input );
398
399             p_demux->p_sys->i_ntracks++;
400         }
401         else
402         {
403             msg_Err( p_demux, "Don't know how to handle %s", psz_uri );
404         }
405         free( psz_uri );
406     }
407
408     free_track( p_track );
409     return i_ret;
410 }
411
412 static track_elem_t *new_track()
413 {
414     track_elem_t *p_track = NULL;
415     p_track = malloc( sizeof( track_elem_t ) );
416     if( p_track )
417     {
418         p_track->name = NULL;
419         p_track->artist = NULL;
420         p_track->album = NULL;
421         p_track->genre = NULL;
422         p_track->trackNum = NULL;
423         p_track->location = NULL;
424         p_track->duration = 0;
425     }
426     return p_track;
427 }
428
429 static void free_track( track_elem_t *p_track )
430 {
431     fprintf( stderr, "free track\n" );
432     if ( !p_track )
433         return;
434
435     FREENULL( p_track->name );
436     FREENULL( p_track->artist );
437     FREENULL( p_track->album );
438     FREENULL( p_track->genre );
439     FREENULL( p_track->trackNum );
440     FREENULL( p_track->location );
441     p_track->duration = 0;
442     free( p_track );
443 }
444
445 static bool save_data( track_elem_t *p_track, const char *psz_name,
446                        char *psz_value)
447 {
448     /* exit if setting is impossible */
449     if( !psz_name || !psz_value || !p_track )
450         return false;
451
452     /* re-convert xml special characters inside psz_value */
453     resolve_xml_special_chars( psz_value );
454
455 #define SAVE_INFO( name, value ) \
456     if( !strcmp( psz_name, name ) ) { p_track->value = strdup( psz_value ); }
457
458     SAVE_INFO( "Name", name )
459     else SAVE_INFO( "Artist", artist )
460     else SAVE_INFO( "Album", album )
461     else SAVE_INFO( "Genre", genre )
462     else SAVE_INFO( "Track Number", trackNum )
463     else SAVE_INFO( "Location", location )
464     else if( !strcmp( psz_name, "Total Time" ) )
465     {
466         long i_num = atol( psz_value );
467         p_track->duration = (mtime_t) i_num*1000;
468     }
469 #undef SAVE_INFO
470     return true;
471 }
472
473 /**
474  * \brief handles the supported <track> sub-elements
475  */
476 static bool add_meta( input_item_t *p_input_item, track_elem_t *p_track )
477 {
478     /* exit if setting is impossible */
479     if( !p_input_item || !p_track )
480         return false;
481
482 #define SET_INFO( type, prop ) \
483     if( p_track->prop ) {input_item_Set##type( p_input_item, p_track->prop );}
484     SET_INFO( Title, name )
485     SET_INFO( Artist, artist )
486     SET_INFO( Album, album )
487     SET_INFO( Genre, genre )
488     SET_INFO( TrackNum, trackNum )
489     SET_INFO( Duration, duration )
490 #undef SET_INFO
491     return true;
492 }
493
494 /**
495  * \brief skips complex element content that we can't manage
496  */
497 static bool skip_element( demux_t *p_demux, input_item_t *p_input_item,
498                           track_elem_t *p_track, xml_reader_t *p_xml_reader,
499                           const char *psz_element, xml_elem_hnd_t *p_handlers )
500 {
501     VLC_UNUSED(p_demux); VLC_UNUSED(p_input_item);
502     VLC_UNUSED(p_track); VLC_UNUSED(p_handlers);
503     char *psz_endname;
504
505     while( xml_ReaderRead( p_xml_reader ) == 1 )
506     {
507         if( xml_ReaderNodeType( p_xml_reader ) == XML_READER_ENDELEM )
508         {
509             psz_endname = xml_ReaderName( p_xml_reader );
510             if( !psz_endname )
511                 return false;
512             if( !strcmp( psz_element, psz_endname ) )
513             {
514                 free( psz_endname );
515                 return true;
516             }
517             else
518                 free( psz_endname );
519         }
520     }
521     return false;
522 }