git.sesse.net Git - vlc/blob - 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     int i_ret = VLC_SUCCESS;
  71     xml_t *p_xml = NULL;
  72     xml_reader_t *p_xml_reader = NULL;
  73     char *psz_name = NULL;
  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         i_ret = VLC_ENOMOD;
  81     else
  82     {
  83         p_xml_reader = xml_ReaderCreate( p_xml, p_demux->s );
  84         if( !p_xml_reader )
  85             i_ret = VLC_EGENERIC;
  86     }
  87
  88     /* locating the root node */
  89     if( i_ret == VLC_SUCCESS )
  90     {
  91         do
  92         {
  93             if( xml_ReaderRead( p_xml_reader ) != 1 )
  94             {
  95                 msg_Err( p_demux, "can't read xml stream" );
  96                 i_ret = VLC_EGENERIC;
  97             }
  98         } while( i_ret == VLC_SUCCESS &&
  99                  xml_ReaderNodeType( p_xml_reader ) != XML_READER_STARTELEM );
 100     }
 101     /* checking root node name */
 102     if( i_ret == VLC_SUCCESS )
 103     {
 104         psz_name = xml_ReaderName( p_xml_reader );
 105         if( !psz_name || strcmp( psz_name, "plist" ) )
 106         {
 107             msg_Err( p_demux, "invalid root node name: %s", psz_name );
 108             i_ret = VLC_EGENERIC;
 109         }
 110         FREE_NAME();
 111     }
 112
 113     if( i_ret == VLC_SUCCESS )
 114     {
 115         xml_elem_hnd_t pl_elements[] =
 116             { {"dict",    COMPLEX_CONTENT, {.cmplx = parse_plist_dict} } };
 117         i_ret = parse_plist_node( p_demux, p_current_input,
 118                                      NULL, p_xml_reader, "plist",
 119                                      pl_elements );
 120         HANDLE_PLAY_AND_RELEASE;
 121     }
 122
 123     if( p_xml_reader )
 124         xml_ReaderDelete( p_xml, p_xml_reader );
 125     if( p_xml )
 126         xml_Delete( p_xml );
 127     return 0; /* Needed for correct operation of go back */
 128 }
 129
 130 /** \brief dummy function for demux callback interface */
 131 static int Control( demux_t *p_demux, int i_query, va_list args )
 132 {
 133     VLC_UNUSED(p_demux); VLC_UNUSED(i_query); VLC_UNUSED(args);
 134     return VLC_EGENERIC;
 135 }
 136
 137 /**
 138  * \brief parse the root node of the playlist
 139  */
 140 static bool parse_plist_node COMPLEX_INTERFACE
 141 {
 142     VLC_UNUSED(p_track); VLC_UNUSED(psz_element);
 143     char *psz_name = NULL;
 144     char *psz_value = NULL;
 145     bool b_version_found = false;
 146
 147     /* read all playlist attributes */
 148     while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
 149     {
 150         psz_name = xml_ReaderName( p_xml_reader );
 151         psz_value = xml_ReaderValue( p_xml_reader );
 152         if( !psz_name || !psz_value )
 153         {
 154             msg_Err( p_demux, "invalid xml stream @ <plist>" );
 155             FREE_ATT();
 156             return false;
 157         }
 158         /* attribute: version */
 159         if( !strcmp( psz_name, "version" ) )
 160         {
 161             b_version_found = true;
 162             if( strcmp( psz_value, "1.0" ) )
 163                 msg_Warn( p_demux, "unsupported iTunes Media Library version" );
 164         }
 165         /* unknown attribute */
 166         else
 167             msg_Warn( p_demux, "invalid <plist> attribute:\"%s\"", psz_name);
 168
 169         FREE_ATT();
 170     }
 171     /* attribute version is mandatory !!! */
 172     if( !b_version_found )
 173         msg_Warn( p_demux, "<plist> requires \"version\" attribute" );
 174
 175     return parse_dict( p_demux, p_input_item, NULL, p_xml_reader,
 176                        "plist", p_handlers );
 177 }
 178
 179 /**
 180  * \brief parse a <dict>
 181  * \param COMPLEX_INTERFACE
 182  */
 183 static bool parse_dict COMPLEX_INTERFACE
 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 COMPLEX_INTERFACE
 304 {
 305     VLC_UNUSED(p_track); VLC_UNUSED(psz_element); VLC_UNUSED(p_handlers);
 306     xml_elem_hnd_t pl_elements[] =
 307         { {"dict",    COMPLEX_CONTENT, {.cmplx = parse_tracks_dict} },
 308           {"array",   SIMPLE_CONTENT,  {NULL} },
 309           {"key",     SIMPLE_CONTENT,  {NULL} },
 310           {"integer", SIMPLE_CONTENT,  {NULL} },
 311           {"string",  SIMPLE_CONTENT,  {NULL} },
 312           {"date",    SIMPLE_CONTENT,  {NULL} },
 313           {"true",    SIMPLE_CONTENT,  {NULL} },
 314           {"false",   SIMPLE_CONTENT,  {NULL} },
 315           {NULL,      UNKNOWN_CONTENT, {NULL} }
 316         };
 317
 318     return parse_dict( p_demux, p_input_item, NULL, p_xml_reader,
 319                        "dict", pl_elements );
 320 }
 321
 322 static bool parse_tracks_dict COMPLEX_INTERFACE
 323 {
 324     VLC_UNUSED(p_track); VLC_UNUSED(psz_element); VLC_UNUSED(p_handlers);
 325     xml_elem_hnd_t tracks_elements[] =
 326         { {"dict",    COMPLEX_CONTENT, {.cmplx = parse_track_dict} },
 327           {"key",     SIMPLE_CONTENT,  {NULL} },
 328           {NULL,      UNKNOWN_CONTENT, {NULL} }
 329         };
 330
 331     parse_dict( p_demux, p_input_item, NULL, p_xml_reader,
 332                 "dict", tracks_elements );
 333
 334     msg_Info( p_demux, "added %i tracks successfully",
 335               p_demux->p_sys->i_ntracks );
 336
 337     return true;
 338 }
 339
 340 static bool parse_track_dict COMPLEX_INTERFACE
 341 {
 342     VLC_UNUSED(psz_element); VLC_UNUSED(p_handlers);
 343     input_item_t *p_new_input = NULL;
 344     int i_ret = -1;
 345     char *psz_uri = NULL;
 346     p_track = new_track();
 347
 348     xml_elem_hnd_t track_elements[] =
 349         { {"array",   COMPLEX_CONTENT, {.cmplx = skip_element} },
 350           {"key",     SIMPLE_CONTENT,  {.smpl = save_data} },
 351           {"integer", SIMPLE_CONTENT,  {.smpl = save_data} },
 352           {"string",  SIMPLE_CONTENT,  {.smpl = save_data} },
 353           {"date",    SIMPLE_CONTENT,  {.smpl = save_data} },
 354           {"true",    SIMPLE_CONTENT,  {NULL} },
 355           {"false",   SIMPLE_CONTENT,  {NULL} },
 356           {NULL,      UNKNOWN_CONTENT, {NULL} }
 357         };
 358
 359     i_ret = parse_dict( p_demux, p_input_item, p_track,
 360                         p_xml_reader, "dict", track_elements );
 361
 362     msg_Dbg( p_demux, "name: %s, artist: %s, album: %s, genre: %s, trackNum: %s, location: %s",
 363              p_track->name, p_track->artist, p_track->album, p_track->genre, p_track->trackNum, p_track->location );
 364
 365     if( !p_track->location )
 366     {
 367         msg_Err( p_demux, "Track needs Location" );
 368         free_track( p_track );
 369         return false;
 370     }
 371
 372     psz_uri = decode_URI_duplicate( p_track->location );
 373
 374     if( psz_uri )
 375     {
 376         if( strlen( psz_uri ) > 17 &&
 377             !strncmp( psz_uri, "file://localhost/", 17 ) )
 378         {
 379             /* remove 'localhost/' */
 380             memmove( psz_uri + 7, psz_uri + 17, strlen( psz_uri ) - 9 );
 381             msg_Info( p_demux, "Adding '%s'", psz_uri );
 382
 383             p_new_input = input_ItemNewExt( p_demux, psz_uri,
 384                                             NULL, 0, NULL, -1 );
 385             input_ItemAddSubItem( p_input_item, p_new_input );
 386
 387             /* add meta info */
 388             add_meta( p_new_input, p_track );
 389             vlc_gc_decref( p_new_input );
 390
 391             p_demux->p_sys->i_ntracks++;
 392         }
 393         else
 394         {
 395             msg_Err( p_demux, "Don't know how to handle %s", psz_uri );
 396         }
 397         free( psz_uri );
 398     }
 399
 400     free_track( p_track );
 401     return i_ret;
 402 }
 403
 404 static track_elem_t *new_track()
 405 {
 406     track_elem_t *p_track = NULL;
 407     p_track = (track_elem_t *)malloc( sizeof( track_elem_t ) );
 408     if( p_track )
 409     {
 410         p_track->name = NULL;
 411         p_track->artist = NULL;
 412         p_track->album = NULL;
 413         p_track->genre = NULL;
 414         p_track->trackNum = NULL;
 415         p_track->location = NULL;
 416         p_track->duration = 0;
 417     }
 418     return p_track;
 419 }
 420
 421 static void free_track( track_elem_t *p_track )
 422 {
 423     fprintf( stderr, "free track\n" );
 424     if ( !p_track )
 425         return;
 426
 427     FREE( p_track->name )
 428     FREE( p_track->artist )
 429     FREE( p_track->album )
 430     FREE( p_track->genre )
 431     FREE( p_track->trackNum )
 432     FREE( p_track->location )
 433     p_track->duration = 0;
 434     free( p_track );
 435 }
 436
 437 static bool save_data SIMPLE_INTERFACE
 438 {
 439     /* exit if setting is impossible */
 440     if( !psz_name || !psz_value || !p_track )
 441         return false;
 442
 443     /* re-convert xml special characters inside psz_value */
 444     resolve_xml_special_chars( psz_value );
 445
 446 #define SAVE_INFO( name, value ) \
 447     if( !strcmp( psz_name, name ) ) { p_track->value = strdup( psz_value ); }
 448
 449     SAVE_INFO( "Name", name )
 450     else SAVE_INFO( "Artist", artist )
 451     else SAVE_INFO( "Album", album )
 452     else SAVE_INFO( "Genre", genre )
 453     else SAVE_INFO( "Track Number", trackNum )
 454     else SAVE_INFO( "Location", location )
 455     else if( !strcmp( psz_name, "Total Time" ) )
 456     {
 457         long i_num = atol( psz_value );
 458         p_track->duration = (mtime_t) i_num*1000;
 459     }
 460     return true;
 461 }
 462
 463 /**
 464  * \brief handles the supported <track> sub-elements
 465  */
 466 static bool add_meta( input_item_t *p_input_item,
 467                             track_elem_t *p_track )
 468 {
 469     /* exit if setting is impossible */
 470     if( !p_input_item || !p_track )
 471         return false;
 472
 473 #define SET_INFO( func, prop ) \
 474     if( p_track->prop ) { func( p_input_item, p_track->prop ); }
 475
 476     SET_INFO( input_item_SetTitle, name )
 477     SET_INFO( input_item_SetArtist, artist )
 478     SET_INFO( input_item_SetAlbum, album )
 479     SET_INFO( input_item_SetGenre, genre )
 480     SET_INFO( input_item_SetTrackNum, trackNum )
 481     SET_INFO( input_item_SetDuration, duration )
 482     return true;
 483 }
 484
 485 /**
 486  * \brief skips complex element content that we can't manage
 487  */
 488 static bool skip_element COMPLEX_INTERFACE
 489 {
 490     VLC_UNUSED(p_demux); VLC_UNUSED(p_input_item);
 491     VLC_UNUSED(p_track); VLC_UNUSED(p_handlers);
 492     char *psz_endname;
 493
 494     while( xml_ReaderRead( p_xml_reader ) == 1 )
 495     {
 496         if( xml_ReaderNodeType( p_xml_reader ) == XML_READER_ENDELEM )
 497         {
 498             psz_endname = xml_ReaderName( p_xml_reader );
 499             if( !psz_endname )
 500                 return false;
 501             if( !strcmp( psz_element, psz_endname ) )
 502             {
 503                 free( psz_endname );
 504                 return true;
 505             }
 506             else
 507                 free( psz_endname );
 508         }
 509     }
 510     return false;
 511 }