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