git.sesse.net Git - vlc/blob - 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_NewExt( p_demux, NULL, NULL, 0, NULL, 0, -1 );
 420
 421     if( !p_new_input )
 422     {
 423         /* malloc has failed for input_item_NewExt, 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_uri = NULL;
 550                     psz_uri = decode_URI_duplicate( psz_value );
 551
 552                     if( !psz_uri )
 553                     {
 554                         FREE_ATT();
 555                         return false;
 556                     }
 557
 558                     if( p_demux->p_sys->psz_base && !strstr( psz_uri, "://" ) )
 559                     {
 560                         char* psz_tmp;
 561                         if( asprintf( &psz_tmp, "%s%s", p_demux->p_sys->psz_base,
 562                                       psz_uri ) == -1 )
 563                         {
 564                             free( psz_uri );
 565                             FREE_ATT();
 566                             return NULL;
 567                         }
 568                         free( psz_uri );
 569                         psz_uri = psz_tmp;
 570                     }
 571                     input_item_SetURI( p_new_input, psz_uri );
 572                     free( psz_uri );
 573                     input_item_CopyOptions( p_input_item, p_new_input );
 574                     psz_uri = NULL;
 575                     FREE_ATT();
 576                     p_handler = NULL;
 577                 }
 578                 else
 579                 {
 580                     /* there MUST be an item */
 581                     if( !p_new_input )
 582                     {
 583                         msg_Err( p_demux, "item not yet created at <%s>",
 584                                  psz_name );
 585                         FREE_ATT();
 586                         return false;
 587                     }
 588                     if( p_handler->pf_handler.smpl )
 589                     {
 590                         p_handler->pf_handler.smpl( p_new_input,
 591                                                     p_handler->name,
 592                                                     psz_value );
 593                         FREE_ATT();
 594                     }
 595                 }
 596                 FREE_ATT();
 597                 p_handler = NULL;
 598                 break;
 599
 600             default:
 601                 /* unknown/unexpected xml node */
 602                 msg_Err( p_demux, "unexpected xml node %i", i_node );
 603                 FREE_ATT();
 604                 return false;
 605         }
 606         FREE_NAME();
 607     }
 608     msg_Err( p_demux, "unexpected end of xml data" );
 609     FREE_ATT();
 610     return false;
 611 }
 612
 613 /**
 614  * \brief handles the supported <track> sub-elements
 615  */
 616 static bool set_item_info SIMPLE_INTERFACE
 617 {
 618     /* exit if setting is impossible */
 619     if( !psz_name || !psz_value || !p_input )
 620         return false;
 621
 622
 623     /* re-convert xml special characters inside psz_value */
 624     resolve_xml_special_chars( psz_value );
 625
 626     /* handle each info element in a separate "if" clause */
 627     if( !strcmp( psz_name, "title" ) )
 628     {
 629         input_item_SetTitle( p_input, psz_value );
 630     }
 631     else if( !strcmp( psz_name, "creator" ) )
 632     {
 633         input_item_SetArtist( p_input, psz_value );
 634     }
 635     else if( !strcmp( psz_name, "album" ) )
 636     {
 637         input_item_SetAlbum( p_input, psz_value );
 638
 639     }
 640     else if( !strcmp( psz_name, "trackNum" ) )
 641     {
 642         input_item_SetTrackNum( p_input, psz_value );
 643     }
 644     else if( !strcmp( psz_name, "duration" ) )
 645     {
 646         long i_num = atol( psz_value );
 647         input_item_SetDuration( p_input, (mtime_t) i_num*1000 );
 648     }
 649     else if( !strcmp( psz_name, "annotation" ) )
 650     {
 651         input_item_SetDescription( p_input, psz_value );
 652     }
 653     else if( !strcmp( psz_name, "image" ) )
 654     {
 655         char *psz_uri = decode_URI_duplicate( psz_value );
 656         input_item_SetArtURL( p_input, psz_uri );
 657         free( psz_uri );
 658     }
 659     return true;
 660 }
 661
 662 /**
 663  * \brief handles the <vlc:option> elements
 664  */
 665 static bool set_option SIMPLE_INTERFACE
 666 {
 667     /* exit if setting is impossible */
 668     if( !psz_name || !psz_value || !p_input )
 669         return false;
 670
 671     /* re-convert xml special characters inside psz_value */
 672     resolve_xml_special_chars( psz_value );
 673
 674     input_item_AddOption( p_input, psz_value, 0 );
 675
 676     return true;
 677 }
 678
 679 /**
 680  * \brief parse the extension node of a XSPF playlist
 681  */
 682 static bool parse_extension_node COMPLEX_INTERFACE
 683 {
 684     char *psz_name = NULL;
 685     char *psz_value = NULL;
 686     char *psz_title = NULL;
 687     char *psz_application = NULL;
 688     int i_node;
 689     bool b_release_input_item = false;
 690     xml_elem_hnd_t *p_handler = NULL;
 691     input_item_t *p_new_input = NULL;
 692
 693     xml_elem_hnd_t pl_elements[] =
 694         { {"vlc:node",   COMPLEX_CONTENT, {.cmplx = parse_extension_node} },
 695           {"vlc:item",   COMPLEX_CONTENT, {.cmplx = parse_extitem_node} },
 696           {"vlc:id",     SIMPLE_CONTENT, {NULL} },
 697           {"vlc:option", SIMPLE_CONTENT, {.smpl = set_option} },
 698           {NULL,    UNKNOWN_CONTENT, {NULL} }
 699         };
 700
 701     /* read all extension node attributes */
 702     while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
 703     {
 704         psz_name = xml_ReaderName( p_xml_reader );
 705         psz_value = xml_ReaderValue( p_xml_reader );
 706         if( !psz_name || !psz_value )
 707         {
 708             msg_Err( p_demux, "invalid xml stream @ <vlc:node>" );
 709             FREE_ATT();
 710             return false;
 711         }
 712         /* attribute: title */
 713         if( !strcmp( psz_name, "title" ) )
 714         {
 715             resolve_xml_special_chars( psz_value );
 716             psz_title = strdup( psz_value );
 717         }
 718         /* extension attribute: application */
 719         else if( !strcmp( psz_name, "application" ) )
 720         {
 721             psz_application = strdup( psz_value );
 722         }
 723         /* unknown attribute */
 724         else
 725             msg_Warn( p_demux, "invalid <%s> attribute:\"%s\"", psz_element,
 726                       psz_name );
 727
 728         FREE_ATT();
 729     }
 730
 731     /* attribute title is mandatory except for <extension> */
 732     if( !strcmp( psz_element, "vlc:node" ) )
 733     {
 734         if( !psz_title )
 735         {
 736             msg_Warn( p_demux, "<vlc:node> requires \"title\" attribute" );
 737             return false;
 738         }
 739         p_new_input = input_item_NewWithType( VLC_OBJECT( p_demux ),
 740                           "vlc://nop", psz_title, 0, NULL, 0, -1,
 741                           ITEM_TYPE_DIRECTORY );
 742         if( p_new_input )
 743         {
 744             input_item_AddSubItem( p_input_item, p_new_input );
 745             p_input_item = p_new_input;
 746             b_release_input_item = true;
 747         }
 748         free( psz_title );
 749     }
 750     else if( !strcmp( psz_element, "extension" ) )
 751     {
 752         if( !psz_application )
 753         {
 754             msg_Warn( p_demux, "<extension> requires \"application\" attribute" );
 755             return false;
 756         }
 757         else if( strcmp( psz_application, "http://www.videolan.org/vlc/playlist/0" ) )
 758         {
 759             msg_Dbg( p_demux, "Skipping \"%s\" extension tag", psz_application );
 760             free( psz_application );
 761             return false;
 762         }
 763     }
 764     free( psz_application );
 765
 766     /* parse the child elements */
 767     while( xml_ReaderRead( p_xml_reader ) == 1 )
 768     {
 769         i_node = xml_ReaderNodeType( p_xml_reader );
 770         switch( i_node )
 771         {
 772             case XML_READER_NONE:
 773                 break;
 774             case XML_READER_STARTELEM:
 775                 /*  element start tag  */
 776                 psz_name = xml_ReaderName( p_xml_reader );
 777                 if( !psz_name || !*psz_name )
 778                 {
 779                     msg_Err( p_demux, "invalid xml stream" );
 780                     FREE_ATT();
 781                     if( b_release_input_item ) vlc_gc_decref( p_new_input );
 782                     return false;
 783                 }
 784                 /* choose handler */
 785                 for( p_handler = pl_elements;
 786                      p_handler->name && strcmp( psz_name, p_handler->name );
 787                      p_handler++ );
 788                 if( !p_handler->name )
 789                 {
 790                     msg_Err( p_demux, "unexpected element <%s>", psz_name );
 791                     FREE_ATT();
 792                     if( b_release_input_item ) vlc_gc_decref( p_new_input );
 793                     return false;
 794                 }
 795                 FREE_NAME();
 796                 /* complex content is parsed in a separate function */
 797                 if( p_handler->type == COMPLEX_CONTENT )
 798                 {
 799                     if( p_handler->pf_handler.cmplx( p_demux,
 800                                                      p_input_item,
 801                                                      p_xml_reader,
 802                                                      p_handler->name ) )
 803                     {
 804                         p_handler = NULL;
 805                         FREE_ATT();
 806                     }
 807                     else
 808                     {
 809                         FREE_ATT();
 810                         if( b_release_input_item ) vlc_gc_decref( p_new_input );
 811                         return false;
 812                     }
 813                 }
 814                 break;
 815
 816             case XML_READER_TEXT:
 817                 /* simple element content */
 818                 FREE_ATT();
 819                 psz_value = xml_ReaderValue( p_xml_reader );
 820                 if( !psz_value )
 821                 {
 822                     msg_Err( p_demux, "invalid xml stream" );
 823                     FREE_ATT();
 824                     if( b_release_input_item ) vlc_gc_decref( p_new_input );
 825                     return false;
 826                 }
 827                 break;
 828
 829             case XML_READER_ENDELEM:
 830                 /* element end tag */
 831                 psz_name = xml_ReaderName( p_xml_reader );
 832                 if( !psz_name )
 833                 {
 834                     msg_Err( p_demux, "invalid xml stream" );
 835                     FREE_ATT();
 836                     if( b_release_input_item ) vlc_gc_decref( p_new_input );
 837                     return false;
 838                 }
 839                 /* leave if the current parent node is terminated */
 840                 if( !strcmp( psz_name, psz_element ) )
 841                 {
 842                     FREE_ATT();
 843                     if( b_release_input_item ) vlc_gc_decref( p_new_input );
 844                     return true;
 845                 }
 846                 /* there MUST have been a start tag for that element name */
 847                 if( !p_handler || !p_handler->name
 848                     || strcmp( p_handler->name, psz_name ))
 849                 {
 850                     msg_Err( p_demux, "there's no open element left for <%s>",
 851                              psz_name );
 852                     FREE_ATT();
 853                     if( b_release_input_item ) vlc_gc_decref( p_new_input );
 854                     return false;
 855                 }
 856
 857                 /* special tag <vlc:id> */
 858                 if( !strcmp( p_handler->name, "vlc:id" ) )
 859                 {
 860                     p_demux->p_sys->i_track_id = atoi( psz_value );
 861                 }
 862                 else if( p_handler->pf_handler.smpl )
 863                 {
 864                     p_handler->pf_handler.smpl( p_input_item, p_handler->name,
 865                                                 psz_value );
 866                 }
 867                 FREE_ATT();
 868                 p_handler = NULL;
 869                 break;
 870
 871             default:
 872                 /* unknown/unexpected xml node */
 873                 msg_Err( p_demux, "unexpected xml node %i", i_node );
 874                 FREE_ATT();
 875                 if( b_release_input_item ) vlc_gc_decref( p_new_input );
 876                 return false;
 877         }
 878         FREE_NAME();
 879     }
 880     if( b_release_input_item ) vlc_gc_decref( p_new_input );
 881     return false;
 882 }
 883
 884 /**
 885  * \brief parse the extension item node of a XSPF playlist
 886  */
 887 static bool parse_extitem_node COMPLEX_INTERFACE
 888 {
 889     VLC_UNUSED(psz_element);
 890     input_item_t *p_new_input = NULL;
 891     char *psz_name = NULL;
 892     char *psz_value = NULL;
 893     int i_tid = -1;
 894
 895     /* read all extension item attributes */
 896     while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
 897     {
 898         psz_name = xml_ReaderName( p_xml_reader );
 899         psz_value = xml_ReaderValue( p_xml_reader );
 900         if( !psz_name || !psz_value )
 901         {
 902             msg_Err( p_demux, "invalid xml stream @ <vlc:item>" );
 903             FREE_ATT();
 904             return false;
 905         }
 906         /* attribute: href */
 907         if( !strcmp( psz_name, "tid" ) )
 908         {
 909             i_tid = atoi( psz_value );
 910         }
 911         /* unknown attribute */
 912         else
 913             msg_Warn( p_demux, "invalid <vlc:item> attribute:\"%s\"", psz_name);
 914
 915         FREE_ATT();
 916     }
 917
 918     /* attribute href is mandatory */
 919     if( i_tid < 0 )
 920     {
 921         msg_Warn( p_demux, "<vlc:item> requires \"tid\" attribute" );
 922         return false;
 923     }
 924
 925     if( i_tid >= p_demux->p_sys->i_tracklist_entries )
 926     {
 927         msg_Warn( p_demux, "invalid \"tid\" attribute" );
 928         return false;
 929     }
 930
 931     p_new_input = p_demux->p_sys->pp_tracklist[ i_tid ];
 932     if( p_new_input )
 933     {
 934         input_item_AddSubItem( p_input_item, p_new_input );
 935         vlc_gc_decref( p_new_input );
 936         p_demux->p_sys->pp_tracklist[i_tid] = NULL;
 937     }
 938
 939     /* kludge for #1293 - XTAG sends ENDELEM for self closing tag */
 940     /* (libxml sends NONE) */
 941     xml_ReaderRead( p_xml_reader );
 942
 943     return true;
 944 }
 945
 946 /**
 947  * \brief skips complex element content that we can't manage
 948  */
 949 static bool skip_element COMPLEX_INTERFACE
 950 {
 951     VLC_UNUSED(p_demux); VLC_UNUSED(p_input_item);
 952     char *psz_endname;
 953
 954     while( xml_ReaderRead( p_xml_reader ) == 1 )
 955     {
 956         if( xml_ReaderNodeType( p_xml_reader ) == XML_READER_ENDELEM )
 957         {
 958             psz_endname = xml_ReaderName( p_xml_reader );
 959             if( !psz_endname )
 960                 return false;
 961             if( !strcmp( psz_element, psz_endname ) )
 962             {
 963                 free( psz_endname );
 964                 return true;
 965             }
 966             else
 967                 free( psz_endname );
 968         }
 969     }
 970     return false;
 971 }