git.sesse.net Git - vlc/blob - modules/demux/playlist/xspf.c

   1 /*******************************************************************************
   2  * Copyright (C) 2006 Daniel Stränger <vlc at schmaller dot de>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  17  *******************************************************************************/
  18 /**
  19  * \file modules/demux/playlist/xspf.c
  20  * \brief XSPF playlist import functions
  21  */
  22
  23 #include <vlc/vlc.h>
  24 #include <vlc/input.h>
  25 #include <vlc/intf.h>
  26
  27 #include "playlist.h"
  28 #include "vlc_xml.h"
  29 #include "vlc_strings.h"
  30 #include "xspf.h"
  31
  32 struct demux_sys_t
  33 {
  34     playlist_item_t *p_item_in_category;
  35     int i_parent_id;
  36 };
  37
  38 /**
  39  * \brief XSPF submodule initialization function
  40  */
  41 int E_(xspf_import_Activate)( vlc_object_t *p_this )
  42 {
  43     demux_t *p_demux = (demux_t *)p_this;
  44     char    *psz_ext;
  45
  46     psz_ext = strrchr( p_demux->psz_path, '.' );
  47
  48     if( ( psz_ext && !strcasecmp( psz_ext, ".xspf") ) ||
  49         ( p_demux->psz_demux && !strcmp(p_demux->psz_demux, "xspf-open") ) )
  50     {
  51         ;
  52     }
  53     else
  54     {
  55         return VLC_EGENERIC;
  56     }
  57     msg_Dbg( p_demux, "using xspf playlist import");
  58
  59     p_demux->p_sys = (demux_sys_t*)malloc(sizeof(demux_sys_t ) );
  60
  61     p_demux->pf_control = xspf_import_Control;
  62     p_demux->pf_demux = xspf_import_Demux;
  63
  64     return VLC_SUCCESS;
  65 }
  66
  67 /**
  68  * \brief demuxer function for XSPF parsing
  69  */
  70 int xspf_import_Demux( demux_t *p_demux )
  71 {
  72     int i_ret = VLC_SUCCESS;
  73     xml_t *p_xml = NULL;
  74     xml_reader_t *p_xml_reader = NULL;
  75     char *psz_name = NULL;
  76     INIT_PLAYLIST_STUFF;
  77     p_demux->p_sys->p_item_in_category = p_item_in_category;
  78     p_demux->p_sys->i_parent_id = i_parent_id;
  79
  80     /* create new xml parser from stream */
  81     p_xml = xml_Create( p_demux );
  82     if( !p_xml )
  83         i_ret = VLC_ENOMOD;
  84     else
  85     {
  86         p_xml_reader = xml_ReaderCreate( p_xml, p_demux->s );
  87         if( !p_xml_reader )
  88             i_ret = VLC_EGENERIC;
  89     }
  90
  91     /* locating the root node */
  92     if( i_ret == VLC_SUCCESS )
  93     {
  94         do
  95         {
  96             if( xml_ReaderRead( p_xml_reader ) != 1 )
  97             {
  98                 msg_Err( p_demux, "can't read xml stream" );
  99                 i_ret = VLC_EGENERIC;
 100             }
 101         } while( i_ret == VLC_SUCCESS &&
 102                  xml_ReaderNodeType( p_xml_reader ) != XML_READER_STARTELEM );
 103     }
 104     /* checking root node name */
 105     if( i_ret == VLC_SUCCESS )
 106     {
 107         psz_name = xml_ReaderName( p_xml_reader );
 108         if( !psz_name || strcmp( psz_name, "playlist" ) )
 109         {
 110             msg_Err( p_demux, "invalid root node name: %s", psz_name );
 111             i_ret = VLC_EGENERIC;
 112         }
 113         FREE_NAME();
 114     }
 115
 116     i_ret = parse_playlist_node( p_demux, p_playlist, p_current, NULL,
 117                                  p_xml_reader, "playlist" );
 118     HANDLE_PLAY_AND_RELEASE;
 119     if( p_xml_reader )
 120         xml_ReaderDelete( p_xml, p_xml_reader );
 121     if( p_xml )
 122         xml_Delete( p_xml );
 123
 124     return i_ret;
 125     return 0;
 126 }
 127
 128 /** \brief dummy function for demux callback interface */
 129 int xspf_import_Control( demux_t *p_demux, int i_query, va_list args )
 130 {
 131     return VLC_EGENERIC;
 132 }
 133
 134 /**
 135  * \brief parse the root node of a XSPF playlist
 136  * \param p_demux demuxer instance
 137  * \param p_playlist playlist instance
 138  * \param p_item current playlist item
 139  * \param p_input current input item
 140  * \param p_xml_reader xml reader instance
 141  * \param psz_element name of element to parse
 142  */
 143 static vlc_bool_t parse_playlist_node COMPLEX_INTERFACE
 144 {
 145     char *psz_name=NULL;
 146     char *psz_value=NULL;
 147     vlc_bool_t b_version_found = VLC_FALSE;
 148     int i_node;
 149     xml_elem_hnd_t *p_handler=NULL;
 150
 151     xml_elem_hnd_t pl_elements[] =
 152         { {"title",        SIMPLE_CONTENT,  {.smpl = set_item_info} },
 153           {"creator",      SIMPLE_CONTENT,  {.smpl = set_item_info} },
 154           {"annotation",   SIMPLE_CONTENT,  {NULL} },
 155           {"info",         SIMPLE_CONTENT,  {NULL} },
 156           {"location",     SIMPLE_CONTENT,  {NULL} },
 157           {"identifier",   SIMPLE_CONTENT,  {NULL} },
 158           {"image",        SIMPLE_CONTENT,  {NULL} },
 159           {"date",         SIMPLE_CONTENT,  {NULL} },
 160           {"license",      SIMPLE_CONTENT,  {NULL} },
 161           {"attribution",  COMPLEX_CONTENT, {.cmplx = skip_element} },
 162           {"link",         SIMPLE_CONTENT,  {NULL} },
 163           {"meta",         SIMPLE_CONTENT,  {NULL} },
 164           {"extension",    COMPLEX_CONTENT, {.cmplx = skip_element} },
 165           {"trackList",    COMPLEX_CONTENT, {.cmplx = parse_tracklist_node} },
 166           {NULL,           UNKNOWN_CONTENT, {NULL} }
 167         };
 168
 169     /* read all playlist attributes */
 170     while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
 171     {
 172         psz_name = xml_ReaderName( p_xml_reader );
 173         psz_value = xml_ReaderValue( p_xml_reader );
 174         if( !psz_name || !psz_value )
 175         {
 176             msg_Err( p_demux, "invalid xml stream @ <playlist>" );
 177             FREE_ATT();
 178             return VLC_FALSE;
 179         }
 180         /* attribute: version */
 181         if( !strcmp( psz_name, "version" ) )
 182         {
 183             b_version_found = VLC_TRUE;
 184             if( strcmp( psz_value, "0" ) && strcmp( psz_value, "1" ) )
 185                 msg_Warn( p_demux, "unsupported XSPF version" );
 186         }
 187         /* attribute: xmlns */
 188         else if( !strcmp( psz_name, "xmlns" ) )
 189             ;
 190         /* unknown attribute */
 191         else
 192             msg_Warn( p_demux, "invalid <playlist> attribute:\"%s\"", psz_name);
 193
 194         FREE_ATT();
 195     }
 196     /* attribute version is mandatory !!! */
 197     if( !b_version_found )
 198         msg_Warn( p_demux, "<playlist> requires \"version\" attribute" );
 199
 200     /* parse the child elements - we only take care of <trackList> */
 201     while( xml_ReaderRead( p_xml_reader ) == 1 )
 202     {
 203         i_node = xml_ReaderNodeType( p_xml_reader );
 204         switch( i_node )
 205         {
 206             case XML_READER_NONE:
 207                 break;
 208             case XML_READER_STARTELEM:
 209                 /*  element start tag  */
 210                 psz_name = xml_ReaderName( p_xml_reader );
 211                 if( !psz_name || !*psz_name )
 212                 {
 213                     msg_Err( p_demux, "invalid xml stream" );
 214                     FREE_ATT();
 215                     return VLC_FALSE;
 216                 }
 217                 /* choose handler */
 218                 for( p_handler = pl_elements;
 219                      p_handler->name && strcmp( psz_name, p_handler->name );
 220                      p_handler++ );
 221                 if( !p_handler->name )
 222                 {
 223                     msg_Err( p_demux, "unexpected element <%s>", psz_name );
 224                     FREE_ATT();
 225                     return VLC_FALSE;
 226                 }
 227                 FREE_NAME();
 228                 /* complex content is parsed in a separate function */
 229                 if( p_handler->type == COMPLEX_CONTENT )
 230                 {
 231                     if( p_handler->pf_handler.cmplx( p_demux,
 232                                                      p_playlist,
 233                                                      p_item,NULL,
 234                                                      p_xml_reader,
 235                                                      p_handler->name ) )
 236                     {
 237                         p_handler = NULL;
 238                         FREE_ATT();
 239                     }
 240                     else
 241                     {
 242                         FREE_ATT();
 243                         return VLC_FALSE;
 244                     }
 245                 }
 246                 break;
 247
 248             case XML_READER_TEXT:
 249                 /* simple element content */
 250                 FREE_ATT();
 251                 psz_value = xml_ReaderValue( p_xml_reader );
 252                 if( !psz_value )
 253                 {
 254                     msg_Err( p_demux, "invalid xml stream" );
 255                     FREE_ATT();
 256                     return VLC_FALSE;
 257                 }
 258                 break;
 259
 260             case XML_READER_ENDELEM:
 261                 /* element end tag */
 262                 psz_name = xml_ReaderName( p_xml_reader );
 263                 if( !psz_name )
 264                 {
 265                     msg_Err( p_demux, "invalid xml stream" );
 266                     FREE_ATT();
 267                     return VLC_FALSE;
 268                 }
 269                 /* leave if the current parent node <playlist> is terminated */
 270                 if( !strcmp( psz_name, psz_element ) )
 271                 {
 272                     FREE_ATT();
 273                     return VLC_TRUE;
 274                 }
 275                 /* there MUST have been a start tag for that element name */
 276                 if( !p_handler || !p_handler->name
 277                     || strcmp( p_handler->name, psz_name ))
 278                 {
 279                     msg_Err( p_demux, "there's no open element left for <%s>",
 280                              psz_name );
 281                     FREE_ATT();
 282                     return VLC_FALSE;
 283                 }
 284
 285                 if( p_handler->pf_handler.smpl )
 286                 {
 287                     p_handler->pf_handler.smpl( p_item, NULL, p_handler->name,
 288                                                 psz_value );
 289                 }
 290                 FREE_ATT();
 291                 p_handler = NULL;
 292                 break;
 293
 294             default:
 295                 /* unknown/unexpected xml node */
 296                 msg_Err( p_demux, "unexpected xml node %i", i_node );
 297                 FREE_ATT();
 298                 return VLC_FALSE;
 299         }
 300         FREE_NAME();
 301     }
 302     return VLC_FALSE;
 303 }
 304
 305 /**
 306  * \brief parses the tracklist node which only may contain <track>s
 307  */
 308 static vlc_bool_t parse_tracklist_node COMPLEX_INTERFACE
 309 {
 310     char *psz_name=NULL;
 311     int i_node;
 312     int i_ntracks = 0;
 313
 314     /* now parse the <track>s */
 315     while( xml_ReaderRead( p_xml_reader ) == 1 )
 316     {
 317         i_node = xml_ReaderNodeType( p_xml_reader );
 318         if( i_node == XML_READER_STARTELEM )
 319         {
 320             psz_name = xml_ReaderName( p_xml_reader );
 321             if( !psz_name )
 322             {
 323                 msg_Err( p_demux, "unexpected end of xml data" );
 324                 FREE_NAME();
 325                 return VLC_FALSE;
 326             }
 327             if( strcmp( psz_name, "track") )
 328             {
 329                 msg_Err( p_demux, "unexpected child of <trackList>: <%s>",
 330                          psz_name );
 331                 FREE_NAME();
 332                 return VLC_FALSE;
 333             }
 334             FREE_NAME();
 335
 336             /* parse the track data in a separate function */
 337             if( parse_track_node( p_demux, p_playlist, p_item, NULL,
 338                                    p_xml_reader,"track" ) == VLC_TRUE )
 339                 i_ntracks++;
 340         }
 341         else if( i_node == XML_READER_ENDELEM )
 342             break;
 343     }
 344
 345     /* the <trackList> has to be terminated */
 346     if( xml_ReaderNodeType( p_xml_reader ) != XML_READER_ENDELEM )
 347     {
 348         msg_Err( p_demux, "there's a missing </trackList>" );
 349         FREE_NAME();
 350         return VLC_FALSE;
 351     }
 352     psz_name = xml_ReaderName( p_xml_reader );
 353     if( !psz_name || strcmp( psz_name, "trackList" ) )
 354     {
 355         msg_Err( p_demux, "expected: </trackList>, found: </%s>", psz_name );
 356         FREE_NAME();
 357         return VLC_FALSE;
 358     }
 359     FREE_NAME();
 360
 361     msg_Dbg( p_demux, "parsed %i tracks successfully", i_ntracks );
 362
 363     return VLC_TRUE;
 364 }
 365
 366 /**
 367  * \brief parse one track element
 368  * \param COMPLEX_INTERFACE
 369  */
 370 static vlc_bool_t parse_track_node COMPLEX_INTERFACE
 371 {
 372     input_item_t *p_new_input = NULL;
 373     int i_node;
 374     char *psz_name=NULL;
 375     char *psz_value=NULL;
 376     xml_elem_hnd_t *p_handler=NULL;
 377
 378     xml_elem_hnd_t track_elements[] =
 379         { {"location",     SIMPLE_CONTENT,  {NULL} },
 380           {"identifier",   SIMPLE_CONTENT,  {NULL} },
 381           {"title",        SIMPLE_CONTENT,  {.smpl = set_item_info} },
 382           {"creator",      SIMPLE_CONTENT,  {.smpl = set_item_info} },
 383           {"annotation",   SIMPLE_CONTENT,  {NULL} },
 384           {"info",         SIMPLE_CONTENT,  {NULL} },
 385           {"image",        SIMPLE_CONTENT,  {NULL} },
 386           {"album",        SIMPLE_CONTENT,  {.smpl = set_item_info} },
 387           {"trackNum",     SIMPLE_CONTENT,  {.smpl = set_item_info} },
 388           {"duration",     SIMPLE_CONTENT,  {.smpl = set_item_info} },
 389           {"link",         SIMPLE_CONTENT,  {NULL} },
 390           {"meta",         SIMPLE_CONTENT,  {NULL} },
 391           {"extension",    COMPLEX_CONTENT, {.cmplx = skip_element} },
 392           {NULL,           UNKNOWN_CONTENT, {NULL} }
 393         };
 394
 395     while( xml_ReaderRead( p_xml_reader ) == 1 )
 396     {
 397         i_node = xml_ReaderNodeType( p_xml_reader );
 398         switch( i_node )
 399         {
 400             case XML_READER_NONE:
 401                 break;
 402
 403             case XML_READER_STARTELEM:
 404                 /*  element start tag  */
 405                 psz_name = xml_ReaderName( p_xml_reader );
 406                 if( !psz_name || !*psz_name )
 407                 {
 408                     msg_Err( p_demux, "invalid xml stream" );
 409                     FREE_ATT();
 410                     return VLC_FALSE;
 411                 }
 412                 /* choose handler */
 413                 for( p_handler = track_elements;
 414                      p_handler->name && strcmp( psz_name, p_handler->name );
 415                      p_handler++ );
 416                 if( !p_handler->name )
 417                 {
 418                     msg_Err( p_demux, "unexpected element <%s>", psz_name );
 419                     FREE_ATT();
 420                     return VLC_FALSE;
 421                 }
 422                 FREE_NAME();
 423                 /* complex content is parsed in a separate function */
 424                 if( p_handler->type == COMPLEX_CONTENT )
 425                 {
 426                     if( !p_new_input )
 427                     {
 428                         msg_Err( p_demux,
 429                                  "at <%s> level no new item has been allocated",
 430                                  p_handler->name );
 431                         FREE_ATT();
 432                         return VLC_FALSE;
 433                     }
 434                     if( p_handler->pf_handler.cmplx( p_demux,
 435                                                      p_playlist,
 436                                                      NULL, p_new_input,
 437                                                      p_xml_reader,
 438                                                      p_handler->name ) )
 439                     {
 440                         p_handler = NULL;
 441                         FREE_ATT();
 442                     }
 443                     else
 444                     {
 445                         FREE_ATT();
 446                         return VLC_FALSE;
 447                     }
 448                 }
 449                 break;
 450
 451             case XML_READER_TEXT:
 452                 /* simple element content */
 453                 FREE_ATT();
 454                 psz_value = xml_ReaderValue( p_xml_reader );
 455                 if( !psz_value )
 456                 {
 457                     msg_Err( p_demux, "invalid xml stream" );
 458                     FREE_ATT();
 459                     return VLC_FALSE;
 460                 }
 461                 break;
 462
 463             case XML_READER_ENDELEM:
 464                 /* element end tag */
 465                 psz_name = xml_ReaderName( p_xml_reader );
 466                 if( !psz_name )
 467                 {
 468                     msg_Err( p_demux, "invalid xml stream" );
 469                     FREE_ATT();
 470                     return VLC_FALSE;
 471                 }
 472                 /* leave if the current parent node <track> is terminated */
 473                 if( !strcmp( psz_name, psz_element ) )
 474                 {
 475                     FREE_ATT();
 476                     /* Add it */
 477                     playlist_AddWhereverNeeded( p_playlist, p_new_input,
 478                               p_item, p_demux->p_sys->p_item_in_category,
 479                               (p_demux->p_sys->i_parent_id >0 ) ? VLC_TRUE:
 480                               VLC_FALSE, PLAYLIST_APPEND );
 481                     return VLC_TRUE;
 482                 }
 483                 /* there MUST have been a start tag for that element name */
 484                 if( !p_handler || !p_handler->name
 485                     || strcmp( p_handler->name, psz_name ))
 486                 {
 487                     msg_Err( p_demux, "there's no open element left for <%s>",
 488                              psz_name );
 489                     FREE_ATT();
 490                     return VLC_FALSE;
 491                 }
 492
 493                 /* special case: location */
 494                 if( !strcmp( p_handler->name, "location" ) )
 495                 {
 496                     char *psz_uri=NULL;
 497                     /* there MUST NOT be an item */
 498                     if( p_new_input )
 499                     {
 500                         msg_Err( p_demux, "item <%s> already created",
 501                                  psz_name );
 502                         FREE_ATT();
 503                         return VLC_FALSE;
 504                     }
 505                     psz_uri = unescape_URI_duplicate( psz_value );
 506
 507                     if( psz_uri )
 508                     {
 509                         p_new_input = input_ItemNewExt( p_playlist, psz_uri,
 510                                                         NULL, 0, NULL, -1 );
 511                         p_new_input->p_meta = vlc_meta_New();
 512                         free( psz_uri );
 513                         vlc_input_item_CopyOptions( p_item->p_input, p_new_input );
 514                         psz_uri = NULL;
 515                         FREE_ATT();
 516                         p_handler = NULL;
 517                     }
 518                     else
 519                     {
 520                         FREE_ATT();
 521                         return VLC_FALSE;
 522                     }
 523                 }
 524                 else
 525                 {
 526                     /* there MUST be an item */
 527                     if( !p_new_input )
 528                     {
 529                         msg_Err( p_demux, "item not yet created at <%s>",
 530                                  psz_name );
 531                         FREE_ATT();
 532                         return VLC_FALSE;
 533                     }
 534                     if( p_handler->pf_handler.smpl )
 535                     {
 536                         p_handler->pf_handler.smpl( NULL, p_input,
 537                                                     p_handler->name,
 538                                                     psz_value );
 539                         FREE_ATT();
 540                     }
 541                 }
 542                 FREE_ATT();
 543                 p_handler = NULL;
 544                 break;
 545
 546             default:
 547                 /* unknown/unexpected xml node */
 548                 msg_Err( p_demux, "unexpected xml node %i", i_node );
 549                 FREE_ATT();
 550                 return VLC_FALSE;
 551         }
 552         FREE_NAME();
 553     }
 554     msg_Err( p_demux, "unexpected end of xml data" );
 555     FREE_ATT();
 556     return VLC_FALSE;
 557 }
 558
 559 /**
 560  * \brief handles the supported <track> sub-elements
 561  */
 562 static vlc_bool_t set_item_info SIMPLE_INTERFACE
 563 {
 564     /* exit if setting is impossible */
 565     if( !psz_name || !psz_value || !p_input )
 566         return VLC_FALSE;
 567
 568     /* re-convert xml special characters inside psz_value */
 569     resolve_xml_special_chars( psz_value );
 570
 571     /* handle each info element in a separate "if" clause */
 572     if( !strcmp( psz_name, "title" ) )
 573     {
 574         p_input->psz_name = strdup( (char*)psz_value );
 575     }
 576     else if( !strcmp( psz_name, "creator" ) )
 577     {
 578         vlc_meta_SetArtist( p_input->p_meta, psz_value );
 579     }
 580     else if( !strcmp( psz_name, "album" ) )
 581     {
 582         vlc_meta_SetAlbum( p_input->p_meta, psz_value );
 583
 584     }
 585     else if( !strcmp( psz_name, "trackNum" ) )
 586     {
 587         vlc_meta_SetTracknum( p_input->p_meta, psz_value );
 588     }
 589     else if( !strcmp( psz_name, "duration" ) )
 590     {
 591         long i_num = atol( psz_value );
 592         p_input->i_duration = i_num*1000;
 593     }
 594     return VLC_TRUE;
 595 }
 596
 597 /**
 598  * \brief skips complex element content that we can't manage
 599  */
 600 static vlc_bool_t skip_element COMPLEX_INTERFACE
 601 {
 602     char *psz_endname;
 603
 604     while( xml_ReaderRead( p_xml_reader ) == 1 )
 605     {
 606         if( xml_ReaderNodeType( p_xml_reader ) == XML_READER_ENDELEM )
 607         {
 608             psz_endname = xml_ReaderName( p_xml_reader );
 609             if( !psz_endname )
 610                 return VLC_FALSE;
 611             if( !strcmp( psz_element, psz_endname ) )
 612             {
 613                 free( psz_endname );
 614                 return VLC_TRUE;
 615             }
 616             else
 617                 free( psz_endname );
 618         }
 619     }
 620     return VLC_FALSE;
 621 }