modules/demux/playlist/xspf.c

   1 /*******************************************************************************
   2  * xspf.c : XSPF playlist import functions
   3  *******************************************************************************
   4  * Copyright (C) 2006 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Daniel Stränger <vlc at schmaller dot de>
   8  *          Yoann Peronneau <yoann@videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  ******************************************************************************/
  24 /**
  25  * \file modules/demux/playlist/xspf.c
  26  * \brief XSPF playlist import functions
  27  */
  28
  29 #ifdef HAVE_CONFIG_H
  30 # include "config.h"
  31 #endif
  32
  33 #include <vlc_common.h>
  34 #include <vlc_demux.h>
  35
  36 #include <vlc_xml.h>
  37 #include <vlc_strings.h>
  38 #include <vlc_url.h>
  39 #include "xspf.h"
  40 #include "playlist.h"
  41
  42 struct demux_sys_t
  43 {
  44     input_item_t **pp_tracklist;
  45     int i_tracklist_entries;
  46     int i_track_id;
  47     char * psz_base;
  48 };
  49
  50 static int Control( demux_t *, int, va_list );
  51 static int Demux( demux_t * );
  52
  53 /**
  54  * \brief XSPF submodule initialization function
  55  */
  56 int Import_xspf( vlc_object_t *p_this )
  57 {
  58     DEMUX_BY_EXTENSION_OR_FORCED_MSG( ".xspf", "xspf-open",
  59                                       "using XSPF playlist reader" );
  60     return VLC_SUCCESS;
  61 }
  62
  63 void Close_xspf( vlc_object_t *p_this )
  64 {
  65     demux_t *p_demux = (demux_t *)p_this;
  66     int i;
  67     for(i = 0; i < p_demux->p_sys->i_tracklist_entries; i++)
  68     {
  69         if(p_demux->p_sys->pp_tracklist[i])
  70             vlc_gc_decref( p_demux->p_sys->pp_tracklist[i] );
  71     }
  72     free( p_demux->p_sys->pp_tracklist );
  73     free( p_demux->p_sys->psz_base );
  74     free( p_demux->p_sys );
  75 }
  76
  77 /**
  78  * \brief demuxer function for XSPF parsing
  79  */
  80 int Demux( demux_t *p_demux )
  81 {
  82     int i_ret = 1;
  83     xml_t *p_xml = NULL;
  84     xml_reader_t *p_xml_reader = NULL;
  85     char *psz_name = NULL;
  86     INIT_PLAYLIST_STUFF;
  87     p_demux->p_sys->pp_tracklist = NULL;
  88     p_demux->p_sys->i_tracklist_entries = 0;
  89     p_demux->p_sys->i_track_id = -1;
  90     p_demux->p_sys->psz_base = NULL;
  91
  92     /* create new xml parser from stream */
  93     p_xml = xml_Create( p_demux );
  94     if( !p_xml )
  95         i_ret = -1;
  96     else
  97     {
  98         p_xml_reader = xml_ReaderCreate( p_xml, p_demux->s );
  99         if( !p_xml_reader )
 100             i_ret = -1;
 101     }
 102
 103     /* locating the root node */
 104     if( i_ret == 1 )
 105     {
 106         do
 107         {
 108             if( xml_ReaderRead( p_xml_reader ) != 1 )
 109             {
 110                 msg_Err( p_demux, "can't read xml stream" );
 111                 i_ret = -1;
 112             }
 113         } while( i_ret == VLC_SUCCESS &&
 114                  xml_ReaderNodeType( p_xml_reader ) != XML_READER_STARTELEM );
 115     }
 116     /* checking root node name */
 117     if( i_ret == 1 )
 118     {
 119         psz_name = xml_ReaderName( p_xml_reader );
 120         if( !psz_name || strcmp( psz_name, "playlist" ) )
 121         {
 122             msg_Err( p_demux, "invalid root node name: %s", psz_name );
 123             i_ret = -1;
 124         }
 125         FREE_NAME();
 126     }
 127
 128     if( i_ret == 1 )
 129         i_ret = parse_playlist_node( p_demux, p_current_input,
 130                                      p_xml_reader, "playlist" ) ? 0 : -1;
 131
 132     int i;
 133     for( i = 0 ; i < p_demux->p_sys->i_tracklist_entries ; i++ )
 134     {
 135         input_item_t *p_new_input = p_demux->p_sys->pp_tracklist[i];
 136         if( p_new_input )
 137         {
 138             input_item_AddSubItem( p_current_input, p_new_input );
 139         }
 140     }
 141
 142     HANDLE_PLAY_AND_RELEASE;
 143     if( p_xml_reader )
 144         xml_ReaderDelete( p_xml, p_xml_reader );
 145     if( p_xml )
 146         xml_Delete( p_xml );
 147     return i_ret; /* Needed for correct operation of go back */
 148 }
 149
 150 /** \brief dummy function for demux callback interface */
 151 static int Control( demux_t *p_demux, int i_query, va_list args )
 152 {
 153     VLC_UNUSED(p_demux); VLC_UNUSED(i_query); VLC_UNUSED(args);
 154     return VLC_EGENERIC;
 155 }
 156
 157 /**
 158  * \brief parse the root node of a XSPF playlist
 159  * \param p_demux demuxer instance
 160  * \param p_input_item current input item
 161  * \param p_xml_reader xml reader instance
 162  * \param psz_element name of element to parse
 163  */
 164 static bool parse_playlist_node COMPLEX_INTERFACE
 165 {
 166     char *psz_name = NULL;
 167     char *psz_value = NULL;
 168     bool b_version_found = false;
 169     int i_node;
 170     xml_elem_hnd_t *p_handler = NULL;
 171
 172     xml_elem_hnd_t pl_elements[] =
 173         { {"title",        SIMPLE_CONTENT,  {.smpl = set_item_info} },
 174           {"creator",      SIMPLE_CONTENT,  {.smpl = set_item_info} },
 175           {"annotation",   SIMPLE_CONTENT,  {.smpl = set_item_info} },
 176           {"info",         SIMPLE_CONTENT,  {NULL} },
 177           {"location",     SIMPLE_CONTENT,  {NULL} },
 178           {"identifier",   SIMPLE_CONTENT,  {NULL} },
 179           {"image",        SIMPLE_CONTENT,  {.smpl = set_item_info} },
 180           {"date",         SIMPLE_CONTENT,  {NULL} },
 181           {"license",      SIMPLE_CONTENT,  {NULL} },
 182           {"attribution",  COMPLEX_CONTENT, {.cmplx = skip_element} },
 183           {"link",         SIMPLE_CONTENT,  {NULL} },
 184           {"meta",         SIMPLE_CONTENT,  {NULL} },
 185           {"extension",    COMPLEX_CONTENT, {.cmplx = parse_extension_node} },
 186           {"trackList",    COMPLEX_CONTENT, {.cmplx = parse_tracklist_node} },
 187           {NULL,           UNKNOWN_CONTENT, {NULL} }
 188         };
 189
 190     /* read all playlist attributes */
 191     while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
 192     {
 193         psz_name = xml_ReaderName( p_xml_reader );
 194         psz_value = xml_ReaderValue( p_xml_reader );
 195         if( !psz_name || !psz_value )
 196         {
 197             msg_Err( p_demux, "invalid xml stream @ <playlist>" );
 198             FREE_ATT();
 199             return false;
 200         }
 201         /* attribute: version */
 202         if( !strcmp( psz_name, "version" ) )
 203         {
 204             b_version_found = true;
 205             if( strcmp( psz_value, "0" ) && strcmp( psz_value, "1" ) )
 206                 msg_Warn( p_demux, "unsupported XSPF version" );
 207         }
 208         /* attribute: xmlns */
 209         else if( !strcmp( psz_name, "xmlns" ) || !strcmp( psz_name, "xmlns:vlc" ) )
 210             ;
 211         else if( !strcmp( psz_name, "xml:base" ) )
 212         {
 213             p_demux->p_sys->psz_base = decode_URI_duplicate( psz_value );
 214         }
 215         /* unknown attribute */
 216         else
 217             msg_Warn( p_demux, "invalid <playlist> attribute:\"%s\"", psz_name);
 218
 219         FREE_ATT();
 220     }
 221     /* attribute version is mandatory !!! */
 222     if( !b_version_found )
 223         msg_Warn( p_demux, "<playlist> requires \"version\" attribute" );
 224
 225     /* parse the child elements - we only take care of <trackList> */
 226     while( xml_ReaderRead( p_xml_reader ) == 1 )
 227     {
 228         i_node = xml_ReaderNodeType( p_xml_reader );
 229         switch( i_node )
 230         {
 231             case XML_READER_NONE:
 232                 break;
 233             case XML_READER_STARTELEM:
 234                 /*  element start tag  */
 235                 psz_name = xml_ReaderName( p_xml_reader );
 236                 if( !psz_name || !*psz_name )
 237                 {
 238                     msg_Err( p_demux, "invalid xml stream" );
 239                     FREE_ATT();
 240                     return false;
 241                 }
 242                 /* choose handler */
 243                 for( p_handler = pl_elements;
 244                      p_handler->name && strcmp( psz_name, p_handler->name );
 245                      p_handler++ );
 246                 if( !p_handler->name )
 247                 {
 248                     msg_Err( p_demux, "unexpected element <%s>", psz_name );
 249                     FREE_ATT();
 250                     return false;
 251                 }
 252                 FREE_NAME();
 253                 /* complex content is parsed in a separate function */
 254                 if( p_handler->type == COMPLEX_CONTENT )
 255                 {
 256                     if( p_handler->pf_handler.cmplx( p_demux,
 257                                                      p_input_item,
 258                                                      p_xml_reader,
 259                                                      p_handler->name ) )
 260                     {
 261                         p_handler = NULL;
 262                         FREE_ATT();
 263                     }
 264                     else
 265                     {
 266                         FREE_ATT();
 267                         return false;
 268                     }
 269                 }
 270                 break;
 271
 272             case XML_READER_TEXT:
 273                 /* simple element content */
 274                 FREE_ATT();
 275                 psz_value = xml_ReaderValue( p_xml_reader );
 276                 if( !psz_value )
 277                 {
 278                     msg_Err( p_demux, "invalid xml stream" );
 279                     FREE_ATT();
 280                     return false;
 281                 }
 282                 break;
 283
 284             case XML_READER_ENDELEM:
 285                 /* element end tag */
 286                 psz_name = xml_ReaderName( p_xml_reader );
 287                 if( !psz_name )
 288                 {
 289                     msg_Err( p_demux, "invalid xml stream" );
 290                     FREE_ATT();
 291                     return false;
 292                 }
 293                 /* leave if the current parent node <playlist> is terminated */
 294                 if( !strcmp( psz_name, psz_element ) )
 295                 {
 296                     FREE_ATT();
 297                     return true;
 298                 }
 299                 /* there MUST have been a start tag for that element name */
 300                 if( !p_handler || !p_handler->name
 301                     || strcmp( p_handler->name, psz_name ))
 302                 {
 303                     msg_Err( p_demux, "there's no open element left for <%s>",
 304                              psz_name );
 305                     FREE_ATT();
 306                     return false;
 307                 }
 308
 309                 if( p_handler->pf_handler.smpl )
 310                 {
 311                     p_handler->pf_handler.smpl( p_input_item, p_handler->name,
 312                                                 psz_value );
 313                 }
 314                 FREE_ATT();
 315                 p_handler = NULL;
 316                 break;
 317
 318             default:
 319                 /* unknown/unexpected xml node */
 320                 msg_Err( p_demux, "unexpected xml node %i", i_node );
 321                 FREE_ATT();
 322                 return false;
 323         }
 324         FREE_NAME();
 325     }
 326     return false;
 327 }
 328
 329 /**
 330  * \brief parses the tracklist node which only may contain <track>s
 331  */
 332 static bool parse_tracklist_node COMPLEX_INTERFACE
 333 {
 334     VLC_UNUSED(psz_element);
 335     char *psz_name = NULL;
 336     int i_node;
 337     int i_ntracks = 0;
 338
 339     /* now parse the <track>s */
 340     while( xml_ReaderRead( p_xml_reader ) == 1 )
 341     {
 342         i_node = xml_ReaderNodeType( p_xml_reader );
 343         if( i_node == XML_READER_STARTELEM )
 344         {
 345             psz_name = xml_ReaderName( p_xml_reader );
 346             if( !psz_name )
 347             {
 348                 msg_Err( p_demux, "unexpected end of xml data" );
 349                 FREE_NAME();
 350                 return false;
 351             }
 352             if( strcmp( psz_name, "track") )
 353             {
 354                 msg_Err( p_demux, "unexpected child of <trackList>: <%s>",
 355                          psz_name );
 356                 FREE_NAME();
 357                 return false;
 358             }
 359             FREE_NAME();
 360
 361             /* parse the track data in a separate function */
 362             if( parse_track_node( p_demux, p_input_item,
 363                                    p_xml_reader,"track" ) == true )
 364                 i_ntracks++;
 365         }
 366         else if( i_node == XML_READER_ENDELEM )
 367             break;
 368     }
 369
 370     /* the <trackList> has to be terminated */
 371     if( xml_ReaderNodeType( p_xml_reader ) != XML_READER_ENDELEM )
 372     {
 373         msg_Err( p_demux, "there's a missing </trackList>" );
 374         FREE_NAME();
 375         return false;
 376     }
 377     psz_name = xml_ReaderName( p_xml_reader );
 378     if( !psz_name || strcmp( psz_name, "trackList" ) )
 379     {
 380         msg_Err( p_demux, "expected: </trackList>, found: </%s>", psz_name );
 381         FREE_NAME();
 382         return false;
 383     }
 384     FREE_NAME();
 385
 386     msg_Dbg( p_demux, "parsed %i tracks successfully", i_ntracks );
 387
 388     return true;
 389 }
 390
 391 /**
 392  * \brief parse one track element
 393  * \param COMPLEX_INTERFACE
 394  */
 395 static bool parse_track_node COMPLEX_INTERFACE
 396 {
 397     int i_node;
 398     char *psz_name = NULL;
 399     char *psz_value = NULL;
 400     xml_elem_hnd_t *p_handler = NULL;
 401
 402     xml_elem_hnd_t track_elements[] =
 403         { {"location",     SIMPLE_CONTENT,  {NULL} },
 404           {"identifier",   SIMPLE_CONTENT,  {NULL} },
 405           {"title",        SIMPLE_CONTENT,  {.smpl = set_item_info} },
 406           {"creator",      SIMPLE_CONTENT,  {.smpl = set_item_info} },
 407           {"annotation",   SIMPLE_CONTENT,  {.smpl = set_item_info} },
 408           {"info",         SIMPLE_CONTENT,  {NULL} },
 409           {"image",        SIMPLE_CONTENT,  {.smpl = set_item_info} },
 410           {"album",        SIMPLE_CONTENT,  {.smpl = set_item_info} },
 411           {"trackNum",     SIMPLE_CONTENT,  {.smpl = set_item_info} },
 412           {"duration",     SIMPLE_CONTENT,  {.smpl = set_item_info} },
 413           {"link",         SIMPLE_CONTENT,  {NULL} },
 414           {"meta",         SIMPLE_CONTENT,  {NULL} },
 415           {"extension",    COMPLEX_CONTENT, {.cmplx = parse_extension_node} },
 416           {NULL,           UNKNOWN_CONTENT, {NULL} }
 417         };
 418
 419     input_item_t *p_new_input = input_item_New( p_demux, NULL, NULL );
 420
 421     if( !p_new_input )
 422     {
 423         /* malloc has failed for input_item_New, so bailout early */
 424         return false;
 425     }
 426
 427     /* reset i_track_id */
 428     p_demux->p_sys->i_track_id = -1;
 429
 430     while( xml_ReaderRead( p_xml_reader ) == 1 )
 431     {
 432         i_node = xml_ReaderNodeType( p_xml_reader );
 433         switch( i_node )
 434         {
 435             case XML_READER_NONE:
 436                 break;
 437
 438             case XML_READER_STARTELEM:
 439                 /*  element start tag  */
 440                 psz_name = xml_ReaderName( p_xml_reader );
 441                 if( !psz_name || !*psz_name )
 442                 {
 443                     msg_Err( p_demux, "invalid xml stream" );
 444                     FREE_ATT();
 445                     return false;
 446                 }
 447                 /* choose handler */
 448                 for( p_handler = track_elements;
 449                      p_handler->name && strcmp( psz_name, p_handler->name );
 450                      p_handler++ );
 451                 if( !p_handler->name )
 452                 {
 453                     msg_Err( p_demux, "unexpected element <%s>", psz_name );
 454                     FREE_ATT();
 455                     return false;
 456                 }
 457                 FREE_NAME();
 458                 /* complex content is parsed in a separate function */
 459                 if( p_handler->type == COMPLEX_CONTENT )
 460                 {
 461                     if( !p_new_input )
 462                     {
 463                         msg_Err( p_demux,
 464                                  "at <%s> level no new item has been allocated",
 465                                  p_handler->name );
 466                         FREE_ATT();
 467                         return false;
 468                     }
 469                     if( p_handler->pf_handler.cmplx( p_demux,
 470                                                      p_new_input,
 471                                                      p_xml_reader,
 472                                                      p_handler->name ) )
 473                     {
 474                         p_handler = NULL;
 475                         FREE_ATT();
 476                     }
 477                     else
 478                     {
 479                         FREE_ATT();
 480                         return false;
 481                     }
 482                 }
 483                 break;
 484
 485             case XML_READER_TEXT:
 486                 /* simple element content */
 487                 FREE_ATT();
 488                 psz_value = xml_ReaderValue( p_xml_reader );
 489                 if( !psz_value )
 490                 {
 491                     msg_Err( p_demux, "invalid xml stream" );
 492                     FREE_ATT();
 493                     return false;
 494                 }
 495                 break;
 496
 497             case XML_READER_ENDELEM:
 498                 /* element end tag */
 499                 psz_name = xml_ReaderName( p_xml_reader );
 500                 if( !psz_name )
 501                 {
 502                     msg_Err( p_demux, "invalid xml stream" );
 503                     FREE_ATT();
 504                     return false;
 505                 }
 506                 /* leave if the current parent node <track> is terminated */
 507                 if( !strcmp( psz_name, psz_element ) )
 508                 {
 509                     FREE_ATT();
 510
 511                     if( p_demux->p_sys->i_track_id < 0 )
 512                     {
 513                         input_item_AddSubItem( p_input_item, p_new_input );
 514                         vlc_gc_decref( p_new_input );
 515                         return true;
 516                     }
 517
 518                     if( p_demux->p_sys->i_track_id >=
 519                            p_demux->p_sys->i_tracklist_entries )
 520                     {
 521                         input_item_t **pp;
 522                         pp = realloc( p_demux->p_sys->pp_tracklist,
 523                             (p_demux->p_sys->i_track_id + 1) * sizeof(*pp) );
 524                         if( !pp )
 525                             return false;
 526                         p_demux->p_sys->pp_tracklist = pp;
 527                         while( p_demux->p_sys->i_track_id >=
 528                                p_demux->p_sys->i_tracklist_entries )
 529                             pp[p_demux->p_sys->i_tracklist_entries++] = NULL;
 530                     }
 531
 532                     p_demux->p_sys->pp_tracklist[
 533                             p_demux->p_sys->i_track_id ] = p_new_input;
 534                     return true;
 535                 }
 536                 /* there MUST have been a start tag for that element name */
 537                 if( !p_handler || !p_handler->name
 538                     || strcmp( p_handler->name, psz_name ))
 539                 {
 540                     msg_Err( p_demux, "there's no open element left for <%s>",
 541                              psz_name );
 542                     FREE_ATT();
 543                     return false;
 544                 }
 545
 546                 /* special case: location */
 547                 if( !strcmp( p_handler->name, "location" ) )
 548                 {
 549                     char *psz_location = psz_value;
 550                     if( !strncmp( psz_value, "file://", 7 ) )   /* file path */
 551                         psz_location = decode_URI( psz_value + 7 );
 552                     else if( !strstr( psz_value, "://" ) )  /* relative path */
 553                         psz_location = decode_URI( psz_value );
 554
 555                     if( !psz_location )
 556                     {
 557                         FREE_ATT();
 558                         return false;
 559                     }
 560
 561                     if( p_demux->p_sys->psz_base && !strstr( psz_value, "://" ) )
 562                     {
 563                         char* psz_tmp;
 564                         if( asprintf( &psz_tmp, "%s%s", p_demux->p_sys->psz_base,
 565                                       psz_location ) == -1 )
 566                         {
 567                             FREE_ATT();
 568                             return NULL;
 569                         }
 570                         input_item_SetURI( p_new_input, psz_tmp );
 571                         free( psz_tmp );
 572                     }
 573                     else
 574                         input_item_SetURI( p_new_input, psz_location );
 575                     input_item_CopyOptions( p_input_item, p_new_input );
 576                     FREE_ATT();
 577                     p_handler = NULL;
 578                 }
 579                 else
 580                 {
 581                     /* there MUST be an item */
 582                     if( !p_new_input )
 583                     {
 584                         msg_Err( p_demux, "item not yet created at <%s>",
 585                                  psz_name );
 586                         FREE_ATT();
 587                         return false;
 588                     }
 589                     if( p_handler->pf_handler.smpl )
 590                     {
 591                         p_handler->pf_handler.smpl( p_new_input,
 592                                                     p_handler->name,
 593                                                     psz_value );
 594                         FREE_ATT();
 595                     }
 596                 }
 597                 FREE_ATT();
 598                 p_handler = NULL;
 599                 break;
 600
 601             default:
 602                 /* unknown/unexpected xml node */
 603                 msg_Err( p_demux, "unexpected xml node %i", i_node );
 604                 FREE_ATT();
 605                 return false;
 606         }
 607         FREE_NAME();
 608     }
 609     msg_Err( p_demux, "unexpected end of xml data" );
 610     FREE_ATT();
 611     return false;
 612 }
 613
 614 /**
 615  * \brief handles the supported <track> sub-elements
 616  */
 617 static bool set_item_info SIMPLE_INTERFACE
 618 {
 619     /* exit if setting is impossible */
 620     if( !psz_name || !psz_value || !p_input )
 621         return false;
 622
 623
 624     /* re-convert xml special characters inside psz_value */
 625     resolve_xml_special_chars( psz_value );
 626
 627     /* handle each info element in a separate "if" clause */
 628     if( !strcmp( psz_name, "title" ) )
 629     {
 630         input_item_SetTitle( p_input, psz_value );
 631     }
 632     else if( !strcmp( psz_name, "creator" ) )
 633     {
 634         input_item_SetArtist( p_input, psz_value );
 635     }
 636     else if( !strcmp( psz_name, "album" ) )
 637     {
 638         input_item_SetAlbum( p_input, psz_value );
 639
 640     }
 641     else if( !strcmp( psz_name, "trackNum" ) )
 642     {
 643         input_item_SetTrackNum( p_input, psz_value );
 644     }
 645     else if( !strcmp( psz_name, "duration" ) )
 646     {
 647         long i_num = atol( psz_value );
 648         input_item_SetDuration( p_input, (mtime_t) i_num*1000 );
 649     }
 650     else if( !strcmp( psz_name, "annotation" ) )
 651     {
 652         input_item_SetDescription( p_input, psz_value );
 653     }
 654     else if( !strcmp( psz_name, "image" ) )
 655     {
 656         input_item_SetArtURL( p_input, psz_value );
 657     }
 658     return true;
 659 }
 660
 661 /**
 662  * \brief handles the <vlc:option> elements
 663  */
 664 static bool set_option SIMPLE_INTERFACE
 665 {
 666     /* exit if setting is impossible */
 667     if( !psz_name || !psz_value || !p_input )
 668         return false;
 669
 670     /* re-convert xml special characters inside psz_value */
 671     resolve_xml_special_chars( psz_value );
 672
 673     input_item_AddOption( p_input, psz_value, 0 );
 674
 675     return true;
 676 }
 677
 678 /**
 679  * \brief parse the extension node of a XSPF playlist
 680  */
 681 static bool parse_extension_node COMPLEX_INTERFACE
 682 {
 683     char *psz_name = NULL;
 684     char *psz_value = NULL;
 685     char *psz_title = NULL;
 686     char *psz_application = NULL;
 687     int i_node;
 688     bool b_release_input_item = false;
 689     xml_elem_hnd_t *p_handler = NULL;
 690     input_item_t *p_new_input = NULL;
 691
 692     xml_elem_hnd_t pl_elements[] =
 693         { {"vlc:node",   COMPLEX_CONTENT, {.cmplx = parse_extension_node} },
 694           {"vlc:item",   COMPLEX_CONTENT, {.cmplx = parse_extitem_node} },
 695           {"vlc:id",     SIMPLE_CONTENT, {NULL} },
 696           {"vlc:option", SIMPLE_CONTENT, {.smpl = set_option} },
 697           {NULL,    UNKNOWN_CONTENT, {NULL} }
 698         };
 699
 700     /* read all extension node attributes */
 701     while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
 702     {
 703         psz_name = xml_ReaderName( p_xml_reader );
 704         psz_value = xml_ReaderValue( p_xml_reader );
 705         if( !psz_name || !psz_value )
 706         {
 707             msg_Err( p_demux, "invalid xml stream @ <vlc:node>" );
 708             FREE_ATT();
 709             return false;
 710         }
 711         /* attribute: title */
 712         if( !strcmp( psz_name, "title" ) )
 713         {
 714             resolve_xml_special_chars( psz_value );
 715             psz_title = strdup( psz_value );
 716         }
 717         /* extension attribute: application */
 718         else if( !strcmp( psz_name, "application" ) )
 719         {
 720             psz_application = strdup( psz_value );
 721         }
 722         /* unknown attribute */
 723         else
 724             msg_Warn( p_demux, "invalid <%s> attribute:\"%s\"", psz_element,
 725                       psz_name );
 726
 727         FREE_ATT();
 728     }
 729
 730     /* attribute title is mandatory except for <extension> */
 731     if( !strcmp( psz_element, "vlc:node" ) )
 732     {
 733         if( !psz_title )
 734         {
 735             msg_Warn( p_demux, "<vlc:node> requires \"title\" attribute" );
 736             return false;
 737         }
 738         p_new_input = input_item_NewWithType( VLC_OBJECT( p_demux ),
 739                           "vlc://nop", psz_title, 0, NULL, 0, -1,
 740                           ITEM_TYPE_DIRECTORY );
 741         if( p_new_input )
 742         {
 743             input_item_AddSubItem( p_input_item, p_new_input );
 744             p_input_item = p_new_input;
 745             b_release_input_item = true;
 746         }
 747         free( psz_title );
 748     }
 749     else if( !strcmp( psz_element, "extension" ) )
 750     {
 751         if( !psz_application )
 752         {
 753             msg_Warn( p_demux, "<extension> requires \"application\" attribute" );
 754             return false;
 755         }
 756         else if( strcmp( psz_application, "http://www.videolan.org/vlc/playlist/0" ) )
 757         {
 758             msg_Dbg( p_demux, "Skipping \"%s\" extension tag", psz_application );
 759             free( psz_application );
 760             return false;
 761         }
 762     }
 763     free( psz_application );
 764
 765     /* parse the child elements */
 766     while( xml_ReaderRead( p_xml_reader ) == 1 )
 767     {
 768         i_node = xml_ReaderNodeType( p_xml_reader );
 769         switch( i_node )
 770         {
 771             case XML_READER_NONE:
 772                 break;
 773             case XML_READER_STARTELEM:
 774                 /*  element start tag  */
 775                 psz_name = xml_ReaderName( p_xml_reader );
 776                 if( !psz_name || !*psz_name )
 777                 {
 778                     msg_Err( p_demux, "invalid xml stream" );
 779                     FREE_ATT();
 780                     if( b_release_input_item ) vlc_gc_decref( p_new_input );
 781                     return false;
 782                 }
 783                 /* choose handler */
 784                 for( p_handler = pl_elements;
 785                      p_handler->name && strcmp( psz_name, p_handler->name );
 786                      p_handler++ );
 787                 if( !p_handler->name )
 788                 {
 789                     msg_Err( p_demux, "unexpected element <%s>", psz_name );
 790                     FREE_ATT();
 791                     if( b_release_input_item ) vlc_gc_decref( p_new_input );
 792                     return false;
 793                 }
 794                 FREE_NAME();
 795                 /* complex content is parsed in a separate function */
 796                 if( p_handler->type == COMPLEX_CONTENT )
 797                 {
 798                     if( p_handler->pf_handler.cmplx( p_demux,
 799                                                      p_input_item,
 800                                                      p_xml_reader,
 801                                                      p_handler->name ) )
 802                     {
 803                         p_handler = NULL;
 804                         FREE_ATT();
 805                     }
 806                     else
 807                     {
 808                         FREE_ATT();
 809                         if( b_release_input_item ) vlc_gc_decref( p_new_input );
 810                         return false;
 811                     }
 812                 }
 813                 break;
 814
 815             case XML_READER_TEXT:
 816                 /* simple element content */
 817                 FREE_ATT();
 818                 psz_value = xml_ReaderValue( p_xml_reader );
 819                 if( !psz_value )
 820                 {
 821                     msg_Err( p_demux, "invalid xml stream" );
 822                     FREE_ATT();
 823                     if( b_release_input_item ) vlc_gc_decref( p_new_input );
 824                     return false;
 825                 }
 826                 break;
 827
 828             case XML_READER_ENDELEM:
 829                 /* element end tag */
 830                 psz_name = xml_ReaderName( p_xml_reader );
 831                 if( !psz_name )
 832                 {
 833                     msg_Err( p_demux, "invalid xml stream" );
 834                     FREE_ATT();
 835                     if( b_release_input_item ) vlc_gc_decref( p_new_input );
 836                     return false;
 837                 }
 838                 /* leave if the current parent node is terminated */
 839                 if( !strcmp( psz_name, psz_element ) )
 840                 {
 841                     FREE_ATT();
 842                     if( b_release_input_item ) vlc_gc_decref( p_new_input );
 843                     return true;
 844                 }
 845                 /* there MUST have been a start tag for that element name */
 846                 if( !p_handler || !p_handler->name
 847                     || strcmp( p_handler->name, psz_name ))
 848                 {
 849                     msg_Err( p_demux, "there's no open element left for <%s>",
 850                              psz_name );
 851                     FREE_ATT();
 852                     if( b_release_input_item ) vlc_gc_decref( p_new_input );
 853                     return false;
 854                 }
 855
 856                 /* special tag <vlc:id> */
 857                 if( !strcmp( p_handler->name, "vlc:id" ) )
 858                 {
 859                     p_demux->p_sys->i_track_id = atoi( psz_value );
 860                 }
 861                 else if( p_handler->pf_handler.smpl )
 862                 {
 863                     p_handler->pf_handler.smpl( p_input_item, p_handler->name,
 864                                                 psz_value );
 865                 }
 866                 FREE_ATT();
 867                 p_handler = NULL;
 868                 break;
 869
 870             default:
 871                 /* unknown/unexpected xml node */
 872                 msg_Err( p_demux, "unexpected xml node %i", i_node );
 873                 FREE_ATT();
 874                 if( b_release_input_item ) vlc_gc_decref( p_new_input );
 875                 return false;
 876         }
 877         FREE_NAME();
 878     }
 879     if( b_release_input_item ) vlc_gc_decref( p_new_input );
 880     return false;
 881 }
 882
 883 /**
 884  * \brief parse the extension item node of a XSPF playlist
 885  */
 886 static bool parse_extitem_node COMPLEX_INTERFACE
 887 {
 888     VLC_UNUSED(psz_element);
 889     input_item_t *p_new_input = NULL;
 890     char *psz_name = NULL;
 891     char *psz_value = NULL;
 892     int i_tid = -1;
 893
 894     /* read all extension item attributes */
 895     while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
 896     {
 897         psz_name = xml_ReaderName( p_xml_reader );
 898         psz_value = xml_ReaderValue( p_xml_reader );
 899         if( !psz_name || !psz_value )
 900         {
 901             msg_Err( p_demux, "invalid xml stream @ <vlc:item>" );
 902             FREE_ATT();
 903             return false;
 904         }
 905         /* attribute: href */
 906         if( !strcmp( psz_name, "tid" ) )
 907         {
 908             i_tid = atoi( psz_value );
 909         }
 910         /* unknown attribute */
 911         else
 912             msg_Warn( p_demux, "invalid <vlc:item> attribute:\"%s\"", psz_name);
 913
 914         FREE_ATT();
 915     }
 916
 917     /* attribute href is mandatory */
 918     if( i_tid < 0 )
 919     {
 920         msg_Warn( p_demux, "<vlc:item> requires \"tid\" attribute" );
 921         return false;
 922     }
 923
 924     if( i_tid >= p_demux->p_sys->i_tracklist_entries )
 925     {
 926         msg_Warn( p_demux, "invalid \"tid\" attribute" );
 927         return false;
 928     }
 929
 930     p_new_input = p_demux->p_sys->pp_tracklist[ i_tid ];
 931     if( p_new_input )
 932     {
 933         input_item_AddSubItem( p_input_item, p_new_input );
 934         vlc_gc_decref( p_new_input );
 935         p_demux->p_sys->pp_tracklist[i_tid] = NULL;
 936     }
 937
 938     /* kludge for #1293 - XTAG sends ENDELEM for self closing tag */
 939     /* (libxml sends NONE) */
 940     xml_ReaderRead( p_xml_reader );
 941
 942     return true;
 943 }
 944
 945 /**
 946  * \brief skips complex element content that we can't manage
 947  */
 948 static bool skip_element COMPLEX_INTERFACE
 949 {
 950     VLC_UNUSED(p_demux); VLC_UNUSED(p_input_item);
 951     char *psz_endname;
 952
 953     while( xml_ReaderRead( p_xml_reader ) == 1 )
 954     {
 955         if( xml_ReaderNodeType( p_xml_reader ) == XML_READER_ENDELEM )
 956         {
 957             psz_endname = xml_ReaderName( p_xml_reader );
 958             if( !psz_endname )
 959                 return false;
 960             if( !strcmp( psz_element, psz_endname ) )
 961             {
 962                 free( psz_endname );
 963                 return true;
 964             }
 965             else
 966                 free( psz_endname );
 967         }
 968     }
 969     return false;
 970 }