/*******************************************************************************
- * Copyright (C) 2006 Daniel Stränger <vlc at schmaller dot de>
+ * xspf.c : XSPF playlist import functions
+ *******************************************************************************
+ * Copyright (C) 2006-2011 VLC authors and VideoLAN
+ * $Id$
*
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * Authors: Daniel Stränger <vlc at schmaller dot de>
+ * Yoann Peronneau <yoann@videolan.org>
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
*
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
- *******************************************************************************/
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ ******************************************************************************/
/**
* \file modules/demux/playlist/xspf.c
* \brief XSPF playlist import functions
*/
-#include <vlc/vlc.h>
-#include <vlc/input.h>
-#include <vlc/intf.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
+#include <vlc_demux.h>
+#include <vlc_xml.h>
+#include <vlc_strings.h>
+#include <vlc_url.h>
#include "playlist.h"
-#include "vlc_xml.h"
-#include "vlc_strings.h"
-#include "xspf.h"
-struct demux_sys_t
+#define FREE_VALUE() do { free(psz_value);psz_value=NULL; } while(0)
+
+#define SIMPLE_INTERFACE (input_item_t *p_input,\
+ const char *psz_name,\
+ char *psz_value)
+#define COMPLEX_INTERFACE (demux_t *p_demux,\
+ input_item_node_t *p_input_node,\
+ xml_reader_t *p_xml_reader,\
+ const char *psz_element)
+
+/* prototypes */
+static bool parse_playlist_node COMPLEX_INTERFACE;
+static bool parse_tracklist_node COMPLEX_INTERFACE;
+static bool parse_track_node COMPLEX_INTERFACE;
+static bool parse_extension_node COMPLEX_INTERFACE;
+static bool parse_extitem_node COMPLEX_INTERFACE;
+static bool set_item_info SIMPLE_INTERFACE;
+static bool set_option SIMPLE_INTERFACE;
+static bool skip_element COMPLEX_INTERFACE;
+
+/* datatypes */
+typedef struct
+{
+ const char *name;
+ union
+ {
+ bool (*smpl) SIMPLE_INTERFACE;
+ bool (*cmplx) COMPLEX_INTERFACE;
+ } pf_handler;
+ bool cmplx;
+} xml_elem_hnd_t;
+struct demux_sys_t
{
- playlist_item_t *p_item_in_category;
- int i_parent_id;
+ input_item_t **pp_tracklist;
+ int i_tracklist_entries;
+ int i_track_id;
+ char * psz_base;
};
+static int Demux(demux_t *);
+
/**
* \brief XSPF submodule initialization function
*/
-int E_(xspf_import_Activate)( vlc_object_t *p_this )
+int Import_xspf(vlc_object_t *p_this)
{
- demux_t *p_demux = (demux_t *)p_this;
- char *psz_ext;
-
- psz_ext = strrchr ( p_demux->psz_path, '.' );
-
- if( ( psz_ext && !strcasecmp( psz_ext, ".xspf") ) ||
- ( p_demux->psz_demux && !strcmp(p_demux->psz_demux, "xspf-open") ) )
- {
- ;
- }
- else
- {
- return VLC_EGENERIC;
- }
- msg_Dbg( p_demux, "using xspf playlist import");
-
- p_demux->p_sys = (demux_sys_t*)malloc(sizeof(demux_sys_t ) );
-
- p_demux->pf_control = xspf_import_Control;
- p_demux->pf_demux = xspf_import_Demux;
-
+ DEMUX_BY_EXTENSION_OR_FORCED_MSG(".xspf", "xspf-open",
+ "using XSPF playlist reader");
return VLC_SUCCESS;
}
+void Close_xspf(vlc_object_t *p_this)
+{
+ demux_t *p_demux = (demux_t *)p_this;
+ demux_sys_t *p_sys = p_demux->p_sys;
+ for (int i = 0; i < p_sys->i_tracklist_entries; i++)
+ if (p_sys->pp_tracklist[i])
+ vlc_gc_decref(p_sys->pp_tracklist[i]);
+ free(p_sys->pp_tracklist);
+ free(p_sys->psz_base);
+ free(p_sys);
+}
+
/**
* \brief demuxer function for XSPF parsing
*/
-int xspf_import_Demux( demux_t *p_demux )
+static int Demux(demux_t *p_demux)
{
- int i_ret = VLC_SUCCESS;
- xml_t *p_xml = NULL;
+ int i_ret = -1;
xml_reader_t *p_xml_reader = NULL;
- char *psz_name = NULL;
- INIT_PLAYLIST_STUFF;
- p_demux->p_sys->p_item_in_category = p_item_in_category;
- p_demux->p_sys->i_parent_id = i_parent_id;
+ const char *name = NULL;
+ input_item_t *p_current_input = GetCurrentItem(p_demux);
+ p_demux->p_sys->pp_tracklist = NULL;
+ p_demux->p_sys->i_tracklist_entries = 0;
+ p_demux->p_sys->i_track_id = -1;
+ p_demux->p_sys->psz_base = NULL;
/* create new xml parser from stream */
- p_xml = xml_Create( p_demux );
- if( !p_xml )
- i_ret = VLC_ENOMOD;
- else
+ p_xml_reader = xml_ReaderCreate(p_demux, p_demux->s);
+ if (!p_xml_reader)
+ goto end;
+
+ /* locating the root node */
+ if (xml_ReaderNextNode(p_xml_reader, &name) != XML_READER_STARTELEM)
{
- p_xml_reader = xml_ReaderCreate( p_xml, p_demux->s );
- if( !p_xml_reader )
- i_ret = VLC_EGENERIC;
+ msg_Err(p_demux, "can't read xml stream");
+ goto end;
}
- /* start with parsing the root node */
- if ( i_ret == VLC_SUCCESS )
- if ( xml_ReaderRead( p_xml_reader ) != 1 )
- {
- msg_Err( p_demux, "can't read xml stream" );
- i_ret = VLC_EGENERIC;
- }
- /* checking root node type */
- if ( i_ret == VLC_SUCCESS )
- if( xml_ReaderNodeType( p_xml_reader ) != XML_READER_STARTELEM )
- {
- msg_Err( p_demux, "invalid root node type: %i",
- xml_ReaderNodeType( p_xml_reader ) );
- i_ret = VLC_EGENERIC;
- }
/* checking root node name */
- if ( i_ret == VLC_SUCCESS )
- psz_name = xml_ReaderName( p_xml_reader );
- if ( !psz_name || strcmp( psz_name, "playlist" ) )
+ if (strcmp(name, "playlist"))
+ {
+ msg_Err(p_demux, "invalid root node name <%s>", name);
+ goto end;
+ }
+
+ input_item_node_t *p_subitems =
+ input_item_node_Create(p_current_input);
+
+ i_ret = parse_playlist_node(p_demux, p_subitems,
+ p_xml_reader, "playlist") ? 0 : -1;
+
+ for (int i = 0 ; i < p_demux->p_sys->i_tracklist_entries ; i++)
{
- msg_Err( p_demux, "invalid root node name: %s", psz_name );
- i_ret = VLC_EGENERIC;
+ input_item_t *p_new_input = p_demux->p_sys->pp_tracklist[i];
+ if (p_new_input)
+ {
+ input_item_node_AppendItem(p_subitems, p_new_input);
+ }
}
- FREE_NAME();
-
- i_ret = parse_playlist_node( p_demux, p_playlist, p_current, NULL,
- p_xml_reader, "playlist" );
- HANDLE_PLAY_AND_RELEASE;
- if ( p_xml_reader )
- xml_ReaderDelete( p_xml, p_xml_reader );
- if ( p_xml )
- xml_Delete( p_xml );
-
- return i_ret;
- return 0;
+
+ input_item_node_PostAndDelete(p_subitems);
+
+end:
+ vlc_gc_decref(p_current_input);
+ if (p_xml_reader)
+ xml_ReaderDelete(p_xml_reader);
+ return i_ret; /* Needed for correct operation of go back */
}
-/** \brief dummy function for demux callback interface */
-int xspf_import_Control( demux_t *p_demux, int i_query, va_list args )
+static const xml_elem_hnd_t *get_handler(const xml_elem_hnd_t *tab, size_t n, const char *name)
{
- return VLC_EGENERIC;
+ for (size_t i = 0; i < n / sizeof(xml_elem_hnd_t); i++)
+ if (!strcmp(name, tab[i].name))
+ return &tab[i];
+ return NULL;
}
+#define get_handler(tab, name) get_handler(tab, sizeof tab, name)
/**
* \brief parse the root node of a XSPF playlist
* \param p_demux demuxer instance
- * \param p_playlist playlist instance
- * \param p_item current playlist node
+ * \param p_input_item current input item
* \param p_xml_reader xml reader instance
* \param psz_element name of element to parse
*/
-static vlc_bool_t parse_playlist_node COMPLEX_INTERFACE
+static bool parse_playlist_node COMPLEX_INTERFACE
{
- char *psz_name=NULL;
- char *psz_value=NULL;
- vlc_bool_t b_version_found = VLC_FALSE;
+ input_item_t *p_input_item = p_input_node->p_item;
+ char *psz_value = NULL;
+ bool b_version_found = false;
int i_node;
- xml_elem_hnd_t *p_handler=NULL;
-
- xml_elem_hnd_t pl_elements[] =
- { {"title", SIMPLE_CONTENT, {.smpl = set_item_info} },
- {"creator", SIMPLE_CONTENT, {.smpl = set_item_info} },
- {"annotation", SIMPLE_CONTENT, {NULL} },
- {"info", SIMPLE_CONTENT, {NULL} },
- {"location", SIMPLE_CONTENT, {NULL} },
- {"identifier", SIMPLE_CONTENT, {NULL} },
- {"image", SIMPLE_CONTENT, {NULL} },
- {"date", SIMPLE_CONTENT, {NULL} },
- {"license", SIMPLE_CONTENT, {NULL} },
- {"attribution", COMPLEX_CONTENT, {.cmplx = skip_element} },
- {"link", SIMPLE_CONTENT, {NULL} },
- {"meta", SIMPLE_CONTENT, {NULL} },
- {"extension", COMPLEX_CONTENT, {.cmplx = skip_element} },
- {"trackList", COMPLEX_CONTENT, {.cmplx = parse_tracklist_node} },
- {NULL, UNKNOWN_CONTENT, {NULL} }
+ bool b_ret = false;
+ const xml_elem_hnd_t *p_handler = NULL;
+
+ static const xml_elem_hnd_t pl_elements[] =
+ { {"title", {.smpl = set_item_info}, false },
+ {"creator", {.smpl = set_item_info}, false },
+ {"annotation", {.smpl = set_item_info}, false },
+ {"info", {NULL}, false },
+ {"location", {NULL}, false },
+ {"identifier", {NULL}, false },
+ {"image", {.smpl = set_item_info}, false },
+ {"date", {NULL}, false },
+ {"license", {NULL}, false },
+ {"attribution", {.cmplx = skip_element}, true },
+ {"link", {NULL}, false },
+ {"meta", {NULL}, false },
+ {"extension", {.cmplx = parse_extension_node}, true },
+ {"trackList", {.cmplx = parse_tracklist_node}, true },
};
-
- /* read all playlist attributes */
- while ( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
+/* read all playlist attributes */
+ const char *name, *value;
+ while ((name = xml_ReaderNextAttr(p_xml_reader, &value)) != NULL)
{
- psz_name = xml_ReaderName ( p_xml_reader );
- psz_value = xml_ReaderValue ( p_xml_reader );
- if ( !psz_name || !psz_value )
- {
- msg_Err( p_demux, "invalid xml stream @ <playlist>" );
- FREE_ATT();
- return VLC_FALSE;
- }
/* attribute: version */
- if ( !strcmp( psz_name, "version" ) )
+ if (!strcmp(name, "version"))
{
- b_version_found = VLC_TRUE;
- if ( strcmp( psz_value, "0" ) && strcmp( psz_value, "1" ) )
- msg_Warn( p_demux, "unsupported XSPF version" );
+ b_version_found = true;
+ if (strcmp(value, "0") && strcmp(value, "1"))
+ msg_Warn(p_demux, "unsupported XSPF version %s", value);
}
/* attribute: xmlns */
- else if ( !strcmp ( psz_name, "xmlns" ) )
+ else if (!strcmp(name, "xmlns") || !strcmp(name, "xmlns:vlc"))
;
+ else if (!strcmp(name, "xml:base") && psz_value)
+ {
+ free(p_demux->p_sys->psz_base);
+ p_demux->p_sys->psz_base = strdup(psz_value);
+ }
/* unknown attribute */
else
- msg_Warn( p_demux, "invalid <playlist> attribute:\"%s\"", psz_name);
-
- FREE_ATT();
+ msg_Warn(p_demux, "invalid <playlist> attribute: \"%s\"", name);
}
/* attribute version is mandatory !!! */
- if ( !b_version_found )
- msg_Warn( p_demux, "<playlist> requires \"version\" attribute" );
+ if (!b_version_found)
+ msg_Warn(p_demux, "<playlist> requires \"version\" attribute");
/* parse the child elements - we only take care of <trackList> */
- while ( xml_ReaderRead( p_xml_reader ) == 1 )
+ psz_value = NULL;
+ while ((i_node = xml_ReaderNextNode(p_xml_reader, &name)) > 0)
+ switch (i_node)
{
- i_node = xml_ReaderNodeType( p_xml_reader );
- switch ( i_node )
+ /* element start tag */
+ case XML_READER_STARTELEM:
+ if (!*name)
{
- case XML_READER_NONE:
- break;
- case XML_READER_STARTELEM:
- /* element start tag */
- psz_name = xml_ReaderName( p_xml_reader );
- if ( !psz_name || !*psz_name )
- {
- msg_Err( p_demux, "invalid xml stream" );
- FREE_ATT();
- return VLC_FALSE;
- }
- /* choose handler */
- for( p_handler = pl_elements;
- p_handler->name && strcmp( psz_name, p_handler->name );
- p_handler++ );
- if ( !p_handler->name )
- {
- msg_Err( p_demux, "unexpected element <%s>", psz_name );
- FREE_ATT();
- return VLC_FALSE;
- }
- FREE_NAME();
- /* complex content is parsed in a separate function */
- if ( p_handler->type == COMPLEX_CONTENT )
- {
- if ( p_handler->pf_handler.cmplx( p_demux,
- p_playlist,
- p_item,NULL,
- p_xml_reader,
- p_handler->name ) )
- {
- p_handler = NULL;
- FREE_ATT();
- }
- else
- {
- FREE_ATT();
- return VLC_FALSE;
- }
- }
- break;
-
- case XML_READER_TEXT:
- /* simple element content */
- FREE_ATT();
- psz_value = xml_ReaderValue( p_xml_reader );
- if ( !psz_value )
- {
- msg_Err( p_demux, "invalid xml stream" );
- FREE_ATT();
- return VLC_FALSE;
- }
- break;
-
- case XML_READER_ENDELEM:
- /* element end tag */
- psz_name = xml_ReaderName( p_xml_reader );
- if ( !psz_name )
- {
- msg_Err( p_demux, "invalid xml stream" );
- FREE_ATT();
- return VLC_FALSE;
- }
- /* leave if the current parent node <playlist> is terminated */
- if ( !strcmp( psz_name, psz_element ) )
- {
- FREE_ATT();
- return VLC_TRUE;
- }
- /* there MUST have been a start tag for that element name */
- if ( !p_handler || !p_handler->name
- || strcmp( p_handler->name, psz_name ))
- {
- msg_Err( p_demux, "there's no open element left for <%s>",
- psz_name );
- FREE_ATT();
- return VLC_FALSE;
- }
-
- if ( p_handler->pf_handler.smpl )
- {
- p_handler->pf_handler.smpl( p_item, NULL, p_handler->name,
- psz_value );
- }
- FREE_ATT();
- p_handler = NULL;
- break;
-
- default:
- /* unknown/unexpected xml node */
- msg_Err( p_demux, "unexpected xml node %i", i_node );
- FREE_ATT();
- return VLC_FALSE;
+ msg_Err(p_demux, "invalid XML stream");
+ goto end;
+ }
+ /* choose handler */
+ p_handler = get_handler(pl_elements, name);
+ if (!p_handler)
+ {
+ msg_Err(p_demux, "unexpected element <%s>", name);
+ goto end;
+ }
+ /* complex content is parsed in a separate function */
+ if (p_handler->cmplx)
+ {
+ FREE_VALUE();
+ if (!p_handler->pf_handler.cmplx(p_demux, p_input_node,
+ p_xml_reader, p_handler->name))
+ return false;
+ p_handler = NULL;
+ }
+ break;
+
+ /* simple element content */
+ case XML_READER_TEXT:
+ psz_value = strdup(name);
+ if (unlikely(!name))
+ goto end;
+ break;
+
+ /* element end tag */
+ case XML_READER_ENDELEM:
+ /* leave if the current parent node <playlist> is terminated */
+ if (!strcmp(name, psz_element))
+ {
+ b_ret = true;
+ goto end;
}
- FREE_NAME();
+ /* there MUST have been a start tag for that element name */
+ if (!p_handler || !p_handler->name || strcmp(p_handler->name, name))
+ {
+ msg_Err(p_demux, "there's no open element left for <%s>", name);
+ goto end;
+ }
+
+ if (p_handler->pf_handler.smpl)
+ p_handler->pf_handler.smpl(p_input_item, p_handler->name, psz_value);
+ FREE_VALUE();
+ p_handler = NULL;
+ break;
}
- return VLC_FALSE;
+
+end:
+ free(psz_value);
+ return b_ret;
}
/**
* \brief parses the tracklist node which only may contain <track>s
*/
-static vlc_bool_t parse_tracklist_node COMPLEX_INTERFACE
+static bool parse_tracklist_node COMPLEX_INTERFACE
{
- char *psz_name=NULL;
+ VLC_UNUSED(psz_element);
+ const char *name;
+ unsigned i_ntracks = 0;
int i_node;
- int i_ntracks = 0;
/* now parse the <track>s */
- while ( xml_ReaderRead( p_xml_reader ) == 1 )
+ while ((i_node = xml_ReaderNextNode(p_xml_reader, &name)) > 0)
{
- i_node = xml_ReaderNodeType( p_xml_reader );
- if ( i_node == XML_READER_STARTELEM )
+ if (i_node == XML_READER_STARTELEM)
{
- psz_name = xml_ReaderName( p_xml_reader );
- if ( !psz_name )
+ if (strcmp(name, "track"))
{
- msg_Err( p_demux, "unexpected end of xml data" );
- FREE_NAME();
- return VLC_FALSE;
+ msg_Err(p_demux, "unexpected child of <trackList>: <%s>",
+ name);
+ return false;
}
- if ( strcmp( psz_name, "track") )
- {
- msg_Err( p_demux, "unexpected child of <trackList>: <%s>",
- psz_name );
- FREE_NAME();
- return VLC_FALSE;
- }
- FREE_NAME();
/* parse the track data in a separate function */
- if ( parse_track_node( p_demux, p_playlist, p_item, NULL,
- p_xml_reader,"track" ) == VLC_TRUE )
+ if (parse_track_node(p_demux, p_input_node, p_xml_reader, "track"))
i_ntracks++;
}
- else if ( i_node == XML_READER_ENDELEM )
+ else if (i_node == XML_READER_ENDELEM)
break;
}
/* the <trackList> has to be terminated */
- if ( xml_ReaderNodeType( p_xml_reader ) != XML_READER_ENDELEM )
+ if (i_node != XML_READER_ENDELEM)
{
- msg_Err( p_demux, "there's a missing </trackList>" );
- FREE_NAME();
- return VLC_FALSE;
+ msg_Err(p_demux, "there's a missing </trackList>");
+ return false;
}
- psz_name = xml_ReaderName( p_xml_reader );
- if ( !psz_name || strcmp( psz_name, "trackList" ) )
+ if (strcmp(name, "trackList"))
{
- msg_Err( p_demux, "expected: </trackList>, found: </%s>", psz_name );
- FREE_NAME();
- return VLC_FALSE;
+ msg_Err(p_demux, "expected: </trackList>, found: </%s>", name);
+ return false;
}
- FREE_NAME();
- msg_Dbg( p_demux, "parsed %i tracks successfully", i_ntracks );
-
- return VLC_TRUE;
+ msg_Dbg(p_demux, "parsed %u tracks successfully", i_ntracks);
+ return true;
}
/**
* \brief parse one track element
* \param COMPLEX_INTERFACE
*/
-static vlc_bool_t parse_track_node COMPLEX_INTERFACE
+static bool parse_track_node COMPLEX_INTERFACE
{
- input_item_t *p_new_input = NULL;
+ input_item_t *p_input_item = p_input_node->p_item;
+ const char *name;
+ char *psz_value = NULL;
+ const xml_elem_hnd_t *p_handler = NULL;
+ demux_sys_t *p_sys = p_demux->p_sys;
int i_node;
- char *psz_name=NULL;
- char *psz_value=NULL;
- xml_elem_hnd_t *p_handler=NULL;
-
- xml_elem_hnd_t track_elements[] =
- { {"location", SIMPLE_CONTENT, {NULL} },
- {"identifier", SIMPLE_CONTENT, {NULL} },
- {"title", SIMPLE_CONTENT, {.smpl = set_item_info} },
- {"creator", SIMPLE_CONTENT, {.smpl = set_item_info} },
- {"annotation", SIMPLE_CONTENT, {NULL} },
- {"info", SIMPLE_CONTENT, {NULL} },
- {"image", SIMPLE_CONTENT, {NULL} },
- {"album", SIMPLE_CONTENT, {.smpl = set_item_info} },
- {"trackNum", SIMPLE_CONTENT, {.smpl = set_item_info} },
- {"duration", SIMPLE_CONTENT, {.smpl = set_item_info} },
- {"link", SIMPLE_CONTENT, {NULL} },
- {"meta", SIMPLE_CONTENT, {NULL} },
- {"extension", COMPLEX_CONTENT, {.cmplx = skip_element} },
- {NULL, UNKNOWN_CONTENT, {NULL} }
+
+ static const xml_elem_hnd_t track_elements[] =
+ { {"location", {NULL}, false },
+ {"identifier", {NULL}, false },
+ {"title", {.smpl = set_item_info}, false },
+ {"creator", {.smpl = set_item_info}, false },
+ {"annotation", {.smpl = set_item_info}, false },
+ {"info", {.smpl = set_item_info}, false },
+ {"image", {.smpl = set_item_info}, false },
+ {"album", {.smpl = set_item_info}, false },
+ {"trackNum", {.smpl = set_item_info}, false },
+ {"duration", {.smpl = set_item_info}, false },
+ {"link", {NULL}, false },
+ {"meta", {NULL}, false },
+ {"extension", {.cmplx = parse_extension_node}, true },
};
- while ( xml_ReaderRead( p_xml_reader ) == 1 )
+ input_item_t *p_new_input = input_item_New(NULL, NULL);
+ if (!p_new_input)
+ return false;
+ input_item_node_t *p_new_node = input_item_node_Create(p_new_input);
+
+ /* reset i_track_id */
+ p_sys->i_track_id = -1;
+
+ while ((i_node = xml_ReaderNextNode(p_xml_reader, &name)) > 0)
+ switch (i_node)
{
- i_node = xml_ReaderNodeType( p_xml_reader );
- switch ( i_node )
+ /* element start tag */
+ case XML_READER_STARTELEM:
+ if (!*name)
{
- case XML_READER_NONE:
- break;
+ msg_Err(p_demux, "invalid XML stream");
+ goto end;
+ }
+ /* choose handler */
+ p_handler = get_handler(track_elements, name);
+ if (!p_handler)
+ {
+ msg_Err(p_demux, "unexpected element <%s>", name);
+ goto end;
+ }
+ /* complex content is parsed in a separate function */
+ if (p_handler->cmplx)
+ {
+ FREE_VALUE();
+
+ if (!p_handler->pf_handler.cmplx(p_demux, p_new_node,
+ p_xml_reader, p_handler->name)) {
+ input_item_node_Delete(p_new_node);
+ return false;
+ }
+
+ p_handler = NULL;
+ }
+ break;
+
+ /* simple element content */
+ case XML_READER_TEXT:
+ free(psz_value);
+ psz_value = strdup(name);
+ if (unlikely(!psz_value))
+ goto end;
+ break;
+
+ /* element end tag */
+ case XML_READER_ENDELEM:
+ /* leave if the current parent node <track> is terminated */
+ if (!strcmp(name, psz_element))
+ {
+ free(psz_value);
+
+ /* Make sure we have a URI */
+ char *psz_uri = input_item_GetURI(p_new_input);
+ if (!psz_uri)
+ input_item_SetURI(p_new_input, "vlc://nop");
+ else
+ free(psz_uri);
+
+ if (p_sys->i_track_id < 0
+ || (unsigned)p_sys->i_track_id >= (SIZE_MAX / sizeof(p_new_input)))
+ {
+ input_item_node_AppendNode(p_input_node, p_new_node);
+ vlc_gc_decref(p_new_input);
+ return true;
+ }
+
+ if (p_sys->i_track_id >= p_sys->i_tracklist_entries)
+ {
+ input_item_t **pp;
+ pp = realloc(p_sys->pp_tracklist,
+ (p_sys->i_track_id + 1) * sizeof(*pp));
+ if (!pp)
+ {
+ vlc_gc_decref(p_new_input);
+ input_item_node_Delete(p_new_node);
+ return false;
+ }
+ p_sys->pp_tracklist = pp;
+ while (p_sys->i_track_id >= p_sys->i_tracklist_entries)
+ pp[p_sys->i_tracklist_entries++] = NULL;
+ }
+ else if (p_sys->pp_tracklist[p_sys->i_track_id] != NULL)
+ {
+ msg_Err(p_demux, "track ID %d collision", p_sys->i_track_id);
+ vlc_gc_decref(p_new_input);
+ input_item_node_Delete(p_new_node);
+ return false;
+ }
+ p_sys->pp_tracklist[ p_sys->i_track_id ] = p_new_input;
+ input_item_node_Delete(p_new_node);
+ return true;
+ }
+ /* there MUST have been a start tag for that element name */
+ if (!p_handler || !p_handler->name || strcmp(p_handler->name, name))
+ {
+ msg_Err(p_demux, "there's no open element left for <%s>", name);
+ goto end;
+ }
+
+ /* special case: location */
+ if (!strcmp(p_handler->name, "location"))
+ {
+ if (psz_value == NULL)
+ input_item_SetURI(p_new_input, "vlc://nop");
+ else
+ /* FIXME (#4005): This is broken. Scheme-relative (//...) locations
+ * and anchors (#...) are not resolved correctly. Also,
+ * host-relative (/...) and directory-relative locations
+ * ("relative path" in vernacular) should be resolved.
+ * Last, psz_base should default to the XSPF resource
+ * location if missing (not the current working directory).
+ * -- Courmisch */
+ if (p_sys->psz_base && !strstr(psz_value, "://"))
+ {
+ char* psz_tmp;
+ if (asprintf(&psz_tmp, "%s%s", p_sys->psz_base, psz_value)
+ == -1)
+ {
+ goto end;
+ }
+ input_item_SetURI(p_new_input, psz_tmp);
+ free(psz_tmp);
+ }
+ else
+ input_item_SetURI(p_new_input, psz_value);
+ input_item_CopyOptions(p_input_item, p_new_input);
+ }
+ else
+ {
+ /* there MUST be an item */
+ if (p_handler->pf_handler.smpl)
+ p_handler->pf_handler.smpl(p_new_input, p_handler->name,
+ psz_value);
+ }
+ FREE_VALUE();
+ p_handler = NULL;
+ break;
+ }
+ msg_Err(p_demux, "unexpected end of xml data");
+
+end:
+
+ input_item_node_Delete(p_new_node);
+ free(psz_value);
+ return false;
+}
+
+/**
+ * \brief handles the supported <track> sub-elements
+ */
+static bool set_item_info SIMPLE_INTERFACE
+{
+ /* exit if setting is impossible */
+ if (!psz_name || !psz_value || !p_input)
+ return false;
+
+ /* re-convert xml special characters inside psz_value */
+ resolve_xml_special_chars(psz_value);
+
+ /* handle each info element in a separate "if" clause */
+ if (!strcmp(psz_name, "title"))
+ input_item_SetTitle(p_input, psz_value);
+ else if (!strcmp(psz_name, "creator"))
+ input_item_SetArtist(p_input, psz_value);
+ else if (!strcmp(psz_name, "album"))
+ input_item_SetAlbum(p_input, psz_value);
+ else if (!strcmp(psz_name, "trackNum"))
+ input_item_SetTrackNum(p_input, psz_value);
+ else if (!strcmp(psz_name, "duration"))
+ {
+ long i_num = atol(psz_value);
+ input_item_SetDuration(p_input, (mtime_t) i_num*1000);
+ }
+ else if (!strcmp(psz_name, "annotation"))
+ input_item_SetDescription(p_input, psz_value);
+ else if (!strcmp(psz_name, "info"))
+ input_item_SetURL(p_input, psz_value);
+ else if (!strcmp(psz_name, "image"))
+ input_item_SetArtURL(p_input, psz_value);
+ return true;
+}
+
+/**
+ * \brief handles the <vlc:option> elements
+ */
+static bool set_option SIMPLE_INTERFACE
+{
+ /* exit if setting is impossible */
+ if (!psz_name || !psz_value || !p_input)
+ return false;
+
+ /* re-convert xml special characters inside psz_value */
+ resolve_xml_special_chars(psz_value);
+
+ input_item_AddOption(p_input, psz_value, 0);
+
+ return true;
+}
+
+/**
+ * \brief parse the extension node of a XSPF playlist
+ */
+static bool parse_extension_node COMPLEX_INTERFACE
+{
+ input_item_t *p_input_item = p_input_node->p_item;
+ char *psz_value = NULL;
+ char *psz_title = NULL;
+ char *psz_application = NULL;
+ int i_node;
+ bool b_release_input_item = false;
+ const xml_elem_hnd_t *p_handler = NULL;
+ input_item_t *p_new_input = NULL;
+
+ static const xml_elem_hnd_t pl_elements[] =
+ { {"vlc:node", {.cmplx = parse_extension_node}, true },
+ {"vlc:item", {.cmplx = parse_extitem_node}, true },
+ {"vlc:id", {NULL}, false },
+ {"vlc:option", {.smpl = set_option}, false },
+ };
+
+ /* read all extension node attributes */
+ const char *name, *value;
+ while ((name = xml_ReaderNextAttr(p_xml_reader, &value)) != NULL)
+ {
+ /* attribute: title */
+ if (!strcmp(name, "title"))
+ {
+ free(psz_title);
+ psz_title = strdup(value);
+ if (likely(psz_title != NULL))
+ resolve_xml_special_chars(psz_title);
+ }
+ /* extension attribute: application */
+ else if (!strcmp(name, "application"))
+ {
+ free(psz_application);
+ psz_application = strdup(value);
+ }
+ /* unknown attribute */
+ else
+ msg_Warn(p_demux, "invalid <%s> attribute:\"%s\"", psz_element,
+ name);
+ }
+
+ /* attribute title is mandatory except for <extension> */
+ if (!strcmp(psz_element, "vlc:node"))
+ {
+ if (!psz_title)
+ {
+ msg_Warn(p_demux, "<vlc:node> requires \"title\" attribute");
+ return false;
+ }
+ p_new_input = input_item_NewWithType("vlc://nop", psz_title,
+ 0, NULL, 0, -1,
+ ITEM_TYPE_DIRECTORY);
+ if (p_new_input)
+ {
+ p_input_node =
+ input_item_node_AppendItem(p_input_node, p_new_input);
+ p_input_item = p_new_input;
+ b_release_input_item = true;
+ }
+ free(psz_title);
+ }
+ else if (!strcmp(psz_element, "extension"))
+ {
+ if (!psz_application)
+ {
+ msg_Warn(p_demux, "<extension> requires \"application\" attribute");
+ return false;
+ }
+ /* Skip the extension if the application is not vlc
+ This will skip all children of the current node */
+ else if (strcmp(psz_application, "http://www.videolan.org/vlc/playlist/0"))
+ {
+ msg_Dbg(p_demux, "Skipping \"%s\" extension tag", psz_application);
+ free(psz_application);
+ /* Skip all children */
+ for (unsigned lvl = 1; lvl;)
+ switch (xml_ReaderNextNode(p_xml_reader, NULL))
+ {
+ case XML_READER_STARTELEM: lvl++; break;
+ case XML_READER_ENDELEM: lvl--; break;
+ case 0: case -1: return -1;
+ }
+ return true;
+ }
+ }
+ free(psz_application);
+
+
+ /* parse the child elements */
+ while ((i_node = xml_ReaderNextNode(p_xml_reader, &name)) > 0)
+ {
+ switch (i_node)
+ {
+ /* element start tag */
case XML_READER_STARTELEM:
- /* element start tag */
- psz_name = xml_ReaderName( p_xml_reader );
- if ( !psz_name || !*psz_name )
+ if (!*name)
{
- msg_Err( p_demux, "invalid xml stream" );
- FREE_ATT();
- return VLC_FALSE;
+ msg_Err(p_demux, "invalid xml stream");
+ FREE_VALUE();
+ if (b_release_input_item) vlc_gc_decref(p_new_input);
+ return false;
}
/* choose handler */
- for( p_handler = track_elements;
- p_handler->name && strcmp( psz_name, p_handler->name );
- p_handler++ );
- if ( !p_handler->name )
+ p_handler = get_handler(pl_elements, name);
+ if (!p_handler)
{
- msg_Err( p_demux, "unexpected element <%s>", psz_name );
- FREE_ATT();
- return VLC_FALSE;
+ msg_Err(p_demux, "unexpected element <%s>", name);
+ FREE_VALUE();
+ if (b_release_input_item) vlc_gc_decref(p_new_input);
+ return false;
}
- FREE_NAME();
/* complex content is parsed in a separate function */
- if ( p_handler->type == COMPLEX_CONTENT )
+ if (p_handler->cmplx)
{
- if ( !p_new_input )
- {
- msg_Err( p_demux,
- "at <%s> level no new item has been allocated",
- p_handler->name );
- FREE_ATT();
- return VLC_FALSE;
- }
- if ( p_handler->pf_handler.cmplx( p_demux,
- p_playlist,
- NULL, p_new_input,
- p_xml_reader,
- p_handler->name ) )
+ if (p_handler->pf_handler.cmplx(p_demux,
+ p_input_node,
+ p_xml_reader,
+ p_handler->name))
{
p_handler = NULL;
- FREE_ATT();
+ FREE_VALUE();
}
else
{
- FREE_ATT();
- return VLC_FALSE;
+ FREE_VALUE();
+ if (b_release_input_item) vlc_gc_decref(p_new_input);
+ return false;
}
}
break;
case XML_READER_TEXT:
/* simple element content */
- FREE_ATT();
- psz_value = xml_ReaderValue( p_xml_reader );
- if ( !psz_value )
+ FREE_VALUE();
+ psz_value = strdup(name);
+ if (unlikely(!psz_value))
{
- msg_Err( p_demux, "invalid xml stream" );
- FREE_ATT();
- return VLC_FALSE;
+ FREE_VALUE();
+ if (b_release_input_item) vlc_gc_decref(p_new_input);
+ return false;
}
break;
+ /* element end tag */
case XML_READER_ENDELEM:
- /* element end tag */
- psz_name = xml_ReaderName( p_xml_reader );
- if ( !psz_name )
+ /* leave if the current parent node is terminated */
+ if (!strcmp(name, psz_element))
{
- msg_Err( p_demux, "invalid xml stream" );
- FREE_ATT();
- return VLC_FALSE;
- }
- /* leave if the current parent node <track> is terminated */
- if ( !strcmp( psz_name, psz_element ) )
- {
- FREE_ATT();
- /* Add it */
- playlist_AddWhereverNeeded( p_playlist, p_new_input,
- p_item, p_demux->p_sys->p_item_in_category,
- (p_demux->p_sys->i_parent_id >0 ) ? VLC_TRUE:
- VLC_FALSE, PLAYLIST_APPEND );
- return VLC_TRUE;
+ FREE_VALUE();
+ if (b_release_input_item) vlc_gc_decref(p_new_input);
+ return true;
}
/* there MUST have been a start tag for that element name */
- if ( !p_handler || !p_handler->name
- || strcmp( p_handler->name, psz_name ))
+ if (!p_handler || !p_handler->name
+ || strcmp(p_handler->name, name))
{
- msg_Err( p_demux, "there's no open element left for <%s>",
- psz_name );
- FREE_ATT();
- return VLC_FALSE;
+ msg_Err(p_demux, "there's no open element left for <%s>",
+ name);
+ FREE_VALUE();
+ if (b_release_input_item) vlc_gc_decref(p_new_input);
+ return false;
}
- /* special case: location */
- if ( !strcmp( p_handler->name, "location" ) )
+ /* special tag <vlc:id> */
+ if (!strcmp(p_handler->name, "vlc:id"))
{
- char *psz_uri=NULL;
- /* there MUST NOT be an item */
- if ( p_new_input )
- {
- msg_Err( p_demux, "item <%s> already created",
- psz_name );
- FREE_ATT();
- return VLC_FALSE;
- }
- psz_uri = unescape_URI_duplicate( psz_value );
-
- if ( psz_uri )
- {
- p_new_input = input_ItemNewExt( p_playlist, psz_uri,
- NULL, 0, NULL, -1 );
- p_new_input->p_meta = vlc_meta_New();
- free( psz_uri );
- vlc_input_item_CopyOptions( p_item->p_input, p_new_input );
- psz_uri = NULL;
- FREE_ATT();
- p_handler = NULL;
- }
- else
- {
- FREE_ATT();
- return VLC_FALSE;
- }
+ p_demux->p_sys->i_track_id = atoi(psz_value);
}
- else
+ else if (p_handler->pf_handler.smpl)
{
- /* there MUST be an item */
- if ( !p_new_input )
- {
- msg_Err( p_demux, "item not yet created at <%s>",
- psz_name );
- FREE_ATT();
- return VLC_FALSE;
- }
- if ( p_handler->pf_handler.smpl )
- {
- p_handler->pf_handler.smpl( NULL, p_input,
- p_handler->name,
- psz_value );
- FREE_ATT();
- }
+ p_handler->pf_handler.smpl(p_input_item, p_handler->name,
+ psz_value);
}
- FREE_ATT();
+ FREE_VALUE();
p_handler = NULL;
break;
-
- default:
- /* unknown/unexpected xml node */
- msg_Err( p_demux, "unexpected xml node %i", i_node );
- FREE_ATT();
- return VLC_FALSE;
}
- FREE_NAME();
}
- msg_Err( p_demux, "unexpected end of xml data" );
- FREE_ATT();
- return VLC_FALSE;
+ if (b_release_input_item) vlc_gc_decref(p_new_input);
+ return false;
}
/**
- * \brief handles the supported <track> sub-elements
+ * \brief parse the extension item node of a XSPF playlist
*/
-static vlc_bool_t set_item_info SIMPLE_INTERFACE
+static bool parse_extitem_node COMPLEX_INTERFACE
{
- /* exit if setting is impossible */
- if ( !psz_name || !psz_value || !p_input )
- return VLC_FALSE;
-
- /* re-convert xml special characters inside psz_value */
- resolve_xml_special_chars ( psz_value );
+ VLC_UNUSED(psz_element);
+ input_item_t *p_new_input = NULL;
+ int i_tid = -1;
- /* handle each info element in a separate "if" clause */
- if ( !strcmp( psz_name, "title" ) )
+ /* read all extension item attributes */
+ const char *name, *value;
+ while ((name = xml_ReaderNextAttr(p_xml_reader, &value)) != NULL)
{
- p_input->psz_name = strdup( (char*)psz_value );
+ /* attribute: href */
+ if (!strcmp(name, "tid"))
+ i_tid = atoi(value);
+ /* unknown attribute */
+ else
+ msg_Warn(p_demux, "invalid <vlc:item> attribute: \"%s\"", name);
}
- else if ( !strcmp( psz_name, "creator" ) )
+
+ /* attribute href is mandatory */
+ if (i_tid < 0)
{
- vlc_meta_SetArtist( p_input->p_meta, psz_value );
+ msg_Warn(p_demux, "<vlc:item> requires \"tid\" attribute");
+ return false;
}
- else if ( !strcmp( psz_name, "album" ) )
- {
- vlc_meta_SetAlbum( p_input->p_meta, psz_value );
- }
- else if ( !strcmp( psz_name, "trackNum" ) )
+ if (i_tid >= p_demux->p_sys->i_tracklist_entries)
{
- vlc_meta_SetTracknum( p_input->p_meta, psz_value );
+ msg_Warn(p_demux, "invalid \"tid\" attribute");
+ return false;
}
- else if ( !strcmp( psz_name, "duration" ) )
+
+ p_new_input = p_demux->p_sys->pp_tracklist[ i_tid ];
+ if (p_new_input)
{
- long i_num = atol( psz_value );
- p_input->i_duration = i_num*1000;
+ input_item_node_AppendItem(p_input_node, p_new_input);
+ vlc_gc_decref(p_new_input);
+ p_demux->p_sys->pp_tracklist[i_tid] = NULL;
}
- return VLC_TRUE;
+
+ return true;
}
/**
* \brief skips complex element content that we can't manage
*/
-static vlc_bool_t skip_element COMPLEX_INTERFACE
+static bool skip_element COMPLEX_INTERFACE
{
- char *psz_endname;
+ VLC_UNUSED(p_demux); VLC_UNUSED(p_input_node);
+ VLC_UNUSED(psz_element);
- while ( xml_ReaderRead( p_xml_reader ) == 1 )
- {
- if ( xml_ReaderNodeType( p_xml_reader ) == XML_READER_ENDELEM )
+ for (unsigned lvl = 1; lvl;)
+ switch (xml_ReaderNextNode(p_xml_reader, NULL))
{
- psz_endname = xml_ReaderName( p_xml_reader );
- if ( !psz_endname )
- return VLC_FALSE;
- if ( !strcmp( psz_element, psz_endname ) )
- {
- free( psz_endname );
- return VLC_TRUE;
- }
- else
- free( psz_endname );
+ case XML_READER_STARTELEM: lvl++; break;
+ case XML_READER_ENDELEM: lvl--; break;
+ case 0: case -1: return false;
}
- }
- return VLC_FALSE;
+
+ return true;
}