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

   1 /******************************************************************************
   2  * xspf.c : XSPF playlist export 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 /**
  26  * \file modules/misc/playlist/xspf.c
  27  * \brief XSPF playlist export functions
  28  */
  29 #include <vlc/vlc.h>
  30 #include <vlc_interface.h>
  31 #include <vlc_playlist.h>
  32 #include <vlc_input.h>
  33 #include <vlc_meta.h>
  34 #include <vlc_strings.h>
  35 #include <vlc_charset.h>
  36 #include "xspf.h"
  37
  38 /**
  39  * \brief Prints the XSPF header to file, writes each item by xspf_export_item()
  40  * and closes the open xml elements
  41  * \param p_this the VLC playlist object
  42  * \return VLC_SUCCESS if some memory is available, otherwise VLC_ENONMEM
  43  */
  44 int E_(xspf_export_playlist)( vlc_object_t *p_this )
  45 {
  46     const playlist_t *p_playlist = (playlist_t *)p_this;
  47     const playlist_export_t *p_export =
  48         (playlist_export_t *)p_playlist->p_private;
  49     int               i, i_count;
  50     char             *psz_temp;
  51     playlist_item_t  *p_node = p_export->p_root;
  52
  53     /* write XSPF XML header */
  54     fprintf( p_export->p_file, "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" );
  55     fprintf( p_export->p_file,
  56              "<playlist version=\"1\" xmlns=\"http://xspf.org/ns/0/\">\n" );
  57
  58     if( !p_node ) return VLC_SUCCESS;
  59
  60     /* save name of the playlist node */
  61     psz_temp = convert_xml_special_chars( p_node->p_input->psz_name );
  62     if( *psz_temp )
  63     {
  64         fprintf(  p_export->p_file, "\t<title>%s</title>\n", psz_temp );
  65     }
  66     free( psz_temp );
  67
  68     /* save location of the playlist node */
  69     psz_temp = assertUTF8URI( p_export->psz_filename );
  70     if( psz_temp && *psz_temp )
  71     {
  72         fprintf( p_export->p_file, "\t<location>%s</location>\n", psz_temp );
  73         free( psz_temp );
  74     }
  75
  76     /* export all items in a flat format */
  77     fprintf( p_export->p_file, "\t<trackList>\n" );
  78     i_count = 0;
  79     for( i = 0; i < p_node->i_children; i++ )
  80     {
  81         xspf_export_item( p_node->pp_children[i], p_export->p_file,
  82                           &i_count );
  83     }
  84     fprintf( p_export->p_file, "\t</trackList>\n" );
  85
  86     /* export the tree structure in <extension> */
  87     fprintf( p_export->p_file, "\t<extension>\n" );
  88     i_count = 0;
  89     for( i = 0; i < p_node->i_children; i++ )
  90     {
  91         xspf_extension_item( p_node->pp_children[i], p_export->p_file,
  92                              &i_count );
  93     }
  94     fprintf( p_export->p_file, "\t</extension>\n" );
  95
  96     /* close the header elements */
  97     fprintf( p_export->p_file, "</playlist>\n" );
  98
  99     return VLC_SUCCESS;
 100 }
 101
 102 /**
 103  * \brief exports one item to file or traverse if item is a node
 104  * \param p_item playlist item to export
 105  * \param p_file file to write xml-converted item to
 106  * \param p_i_count counter for track identifiers
 107  */
 108 static void xspf_export_item( playlist_item_t *p_item, FILE *p_file,
 109                               int *p_i_count )
 110 {
 111     char *psz;
 112     char *psz_temp;
 113
 114     if( !p_item ) return;
 115
 116     /* if we get a node here, we must traverse it */
 117     if( p_item->i_children > 0 )
 118     {
 119         int i;
 120         for( i = 0; i < p_item->i_children; i++ )
 121         {
 122             xspf_export_item( p_item->pp_children[i], p_file, p_i_count );
 123         }
 124         return;
 125     }
 126
 127     /* don't write empty nodes */
 128     if( p_item->i_children == 0 )
 129     {
 130         return;
 131     }
 132
 133     /* leaves can be written directly */
 134     fprintf( p_file, "\t\t<track>\n" );
 135
 136     /* print identifier and increase the counter */
 137     fprintf( p_file, "\t\t\t<identifier>%i</identifier>\n", *p_i_count );
 138     ( *p_i_count )++;
 139
 140     /* -> the location */
 141     if( p_item->p_input->psz_uri && *p_item->p_input->psz_uri )
 142     {
 143         psz = assertUTF8URI( p_item->p_input->psz_uri );
 144         fprintf( p_file, "\t\t\t<location>%s</location>\n", psz );
 145         free( psz );
 146     }
 147
 148     /* -> the name/title (only if different from uri)*/
 149     if( p_item->p_input->psz_name &&
 150         p_item->p_input->psz_uri &&
 151         strcmp( p_item->p_input->psz_uri, p_item->p_input->psz_name ) )
 152     {
 153         psz_temp = convert_xml_special_chars( p_item->p_input->psz_name );
 154         if( *psz_temp )
 155             fprintf( p_file, "\t\t\t<title>%s</title>\n", psz_temp );
 156         free( psz_temp );
 157     }
 158
 159     if( p_item->p_input->p_meta == NULL )
 160     {
 161         goto xspfexportitem_end;
 162     }
 163
 164     /* -> the artist/creator */
 165     psz = input_item_GetArtist( p_item->p_input );
 166     if( psz == NULL ) psz = strdup( "" );
 167     psz_temp = convert_xml_special_chars( psz );
 168     free( psz );
 169     if( *psz_temp )
 170     {
 171         fprintf( p_file, "\t\t\t<creator>%s</creator>\n", psz_temp );
 172     }
 173     free( psz_temp );
 174
 175     /* -> the album */
 176     psz = input_item_GetAlbum( p_item->p_input );
 177     if( psz == NULL ) psz = strdup( "" );
 178     psz_temp = convert_xml_special_chars( psz );
 179     free( psz );
 180     if( *psz_temp )
 181     {
 182         fprintf( p_file, "\t\t\t<album>%s</album>\n", psz_temp );
 183     }
 184     free( psz_temp );
 185
 186     /* -> the track number */
 187     psz = input_item_GetTrackNum( p_item->p_input );
 188     if( psz == NULL ) psz = strdup( "" );
 189     if( psz )
 190     {
 191         if( *psz )
 192         {
 193             fprintf( p_file, "\t\t\t<trackNum>%i</trackNum>\n", atoi( psz ) );
 194         }
 195     }
 196     free( psz );
 197
 198     /* -> the description */
 199     psz = input_item_GetDescription( p_item->p_input );
 200     if( psz == NULL ) psz = strdup( "" );
 201     psz_temp = convert_xml_special_chars( psz );
 202     free( psz );
 203     if( *psz_temp )
 204     {
 205         fprintf( p_file, "\t\t\t<annotation>%s</annotation>\n", psz_temp );
 206     }
 207     free( psz_temp );
 208
 209 xspfexportitem_end:
 210     /* -> the duration */
 211     if( p_item->p_input->i_duration > 0 )
 212     {
 213         fprintf( p_file, "\t\t\t<duration>%ld</duration>\n",
 214                  (long)(p_item->p_input->i_duration / 1000) );
 215     }
 216
 217     fprintf( p_file, "\t\t</track>\n" );
 218
 219     return;
 220 }
 221
 222 /**
 223  * \brief exports one item in extension to file and traverse if item is a node
 224  * \param p_item playlist item to export
 225  * \param p_file file to write xml-converted item to
 226  * \param p_i_count counter for track identifiers
 227  */
 228 static void xspf_extension_item( playlist_item_t *p_item, FILE *p_file,
 229                                  int *p_i_count )
 230 {
 231     if( !p_item ) return;
 232
 233     /* if we get a node here, we must traverse it */
 234     if( p_item->i_children >= 0 )
 235     {
 236         int i;
 237         char *psz_temp;
 238         psz_temp = convert_xml_special_chars( p_item->p_input->psz_name );
 239         fprintf( p_file, "\t\t<node title=\"%s\">\n",
 240                  *psz_temp ? p_item->p_input->psz_name : "" );
 241         free( psz_temp );
 242
 243         for( i = 0; i < p_item->i_children; i++ )
 244         {
 245             xspf_extension_item( p_item->pp_children[i], p_file, p_i_count );
 246         }
 247
 248         fprintf( p_file, "\t\t</node>\n" );
 249         return;
 250     }
 251
 252
 253     /* print leaf and increase the counter */
 254     fprintf( p_file, "\t\t\t<item href=\"%i\" />\n", *p_i_count );
 255     ( *p_i_count )++;
 256
 257     return;
 258 }
 259
 260 /**
 261  * \param psz_name the location of the media ressource (e.g. local file,
 262  *        device, network stream, etc.)
 263  * \return a new char buffer which asserts that the location is valid UTF-8
 264  *         and a valid URI
 265  * \note the returned buffer must be freed, when it isn't used anymore
 266  */
 267 static char *assertUTF8URI( char *psz_name )
 268 {
 269     char *psz_ret = NULL;              /**< the new result buffer to return */
 270     char *psz_s = NULL, *psz_d = NULL; /**< src & dest pointers for URI conversion */
 271     vlc_bool_t b_name_is_uri = VLC_FALSE;
 272
 273     if( !psz_name || !*psz_name )
 274         return NULL;
 275
 276     /* check that string is valid UTF-8 */
 277     /* XXX: Why do we even need to do that ? (all strings in core are UTF-8 encoded */
 278     if( !( psz_s = EnsureUTF8( psz_name ) ) )
 279         return NULL;
 280
 281     /* max. 3x for URI conversion (percent escaping) and
 282        8 bytes for "file://" and NULL-termination */
 283     psz_ret = (char *)malloc( sizeof(char)*strlen(psz_name)*6*3+8 );
 284     if( !psz_ret )
 285         return NULL;
 286
 287     /** \todo check for a valid scheme part preceding the colon */
 288     if( strchr( psz_s, ':' ) )
 289     {
 290         psz_d = psz_ret;
 291         b_name_is_uri = VLC_TRUE;
 292     }
 293     /* assume "file" scheme if no scheme-part is included */
 294     else
 295     {
 296         strcpy( psz_ret, "file://" );
 297         psz_d = psz_ret + 7;
 298     }
 299
 300     while( *psz_s )
 301     {
 302         /* percent-encode all non-ASCII and the XML special characters and the percent sign itself */
 303         if( *psz_s & B10000000 ||
 304             *psz_s == '<' ||
 305             *psz_s == '>' ||
 306             *psz_s == '&' ||
 307             *psz_s == ' ' ||
 308             ( *psz_s == '%' && !b_name_is_uri ) )
 309         {
 310             *psz_d++ = '%';
 311             *psz_d++ = hexchars[(*psz_s >> 4) & B00001111];
 312             *psz_d++ = hexchars[*psz_s & B00001111];
 313         }
 314         else
 315         {
 316             *psz_d++ = *psz_s;
 317         }
 318
 319         psz_s++;
 320     }
 321     *psz_d = '\0';
 322
 323     return (char *)realloc( psz_ret, sizeof(char)*strlen( psz_ret ) + 1 );
 324 }