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

   1 /*****************************************************************************
   2  * audioscrobbler.c : audioscrobbler submission plugin
   3  *****************************************************************************
   4  * Copyright (C) 2006-2007 the VideoLAN team
   5  * $Id$
   6  *
   7  * Author: Rafaël Carré <funman at videolanorg>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /* audioscrobbler protocol version: 1.2
  25  * http://www.audioscrobbler.net/development/protocol/
  26  *
  27  * TODO:    "Now Playing" feature (not mandatory)
  28  */
  29 /*****************************************************************************
  30  * Preamble
  31  *****************************************************************************/
  32
  33 #if defined( WIN32 )
  34 #include <time.h>
  35 #endif
  36
  37 #include <vlc/vlc.h>
  38 #include <vlc_interface.h>
  39 #include <vlc_meta.h>
  40 #include <vlc_md5.h>
  41 #include <vlc_block.h>
  42 #include <vlc_stream.h>
  43 #include <vlc_url.h>
  44 #include <vlc_network.h>
  45 #include <vlc_interface.h>
  46 #include <vlc_playlist.h>
  47
  48 /*****************************************************************************
  49  * Local prototypes
  50  *****************************************************************************/
  51
  52 /* Keeps track of metadata to be submitted */
  53 typedef struct audioscrobbler_song_t
  54 {
  55     char        *psz_a;             /**< track artist     */
  56     char        *psz_t;             /**< track title      */
  57     char        *psz_b;             /**< track album      */
  58     char        *psz_n;             /**< track number     */
  59     int         i_l;                /**< track length     */
  60     char        *psz_m;             /**< musicbrainz id   */
  61     time_t      date;               /**< date since epoch */
  62 } audioscrobbler_song_t;
  63
  64 struct intf_sys_t
  65 {
  66     audioscrobbler_song_t   p_queue[50];        /**< songs not submitted yet*/
  67     int                     i_songs;            /**< number of songs        */
  68
  69     vlc_mutex_t             lock;               /**< p_sys mutex            */
  70
  71     /* data about audioscrobbler session */
  72     time_t                  next_exchange;      /**< when can we send data  */
  73     unsigned int            i_interval;         /**< waiting interval (secs)*/
  74
  75     /* submission of played songs */
  76     char                    *psz_submit_host;   /**< where to submit data   */
  77     int                     i_submit_port;      /**< port to which submit   */
  78     char                    *psz_submit_file;   /**< file to which submit   */
  79
  80     /* submission of playing song */
  81 #if 0 //NOT USED
  82     char                    *psz_nowp_host;     /**< where to submit data   */
  83     int                     i_nowp_port;        /**< port to which submit   */
  84     char                    *psz_nowp_file;     /**< file to which submit   */
  85 #endif
  86     vlc_bool_t              b_handshaked;       /**< are we authenticated ? */
  87     char                    psz_auth_token[33]; /**< Authentication token */
  88
  89     /* data about song currently playing */
  90     audioscrobbler_song_t   p_current_song;     /**< song being played      */
  91
  92     time_t                  time_pause;         /**< time when vlc paused   */
  93     time_t                  time_total_pauses;  /**< total time in pause    */
  94
  95     vlc_bool_t              b_submit;           /**< do we have to submit ? */
  96
  97     vlc_bool_t              b_state_cb;         /**< if we registered the
  98                                                  * "state" callback         */
  99
 100     vlc_bool_t              b_meta_read;        /**< if we read the song's
 101                                                  * metadata already         */
 102 };
 103
 104 static int  Open            ( vlc_object_t * );
 105 static void Close           ( vlc_object_t * );
 106 static void Unload          ( intf_thread_t * );
 107 static void Run             ( intf_thread_t * );
 108
 109 static int ItemChange       ( vlc_object_t *, const char *, vlc_value_t,
 110                                 vlc_value_t, void * );
 111 static int PlayingChange    ( vlc_object_t *, const char *, vlc_value_t,
 112                                 vlc_value_t, void * );
 113
 114 static int AddToQueue       ( intf_thread_t * );
 115 static int Handshake        ( intf_thread_t * );
 116 static int ReadMetaData     ( intf_thread_t * );
 117 static void DeleteSong      ( audioscrobbler_song_t* );
 118 static int ParseURL         ( char *, char **, char **, int * );
 119 static void HandleInterval  ( time_t *, unsigned int * );
 120
 121 /*****************************************************************************
 122  * Module descriptor
 123  ****************************************************************************/
 124
 125 #define USERNAME_TEXT       N_("Username")
 126 #define USERNAME_LONGTEXT   N_("The username of your last.fm account")
 127 #define PASSWORD_TEXT       N_("Password")
 128 #define PASSWORD_LONGTEXT   N_("The password of your last.fm account")
 129
 130 /* This error value is used when last.fm plugin has to be unloaded. */
 131 #define VLC_AUDIOSCROBBLER_EFATAL -69
 132
 133 /* last.fm client identifier */
 134 #define CLIENT_NAME     PACKAGE
 135 #define CLIENT_VERSION  VERSION
 136
 137 /* HTTP POST request : to submit data */
 138 #define    POST_REQUEST "POST /%s HTTP/1.1\n"                               \
 139                         "Accept-Encoding: identity\n"                       \
 140                         "Content-length: %u\n"                              \
 141                         "Connection: close\n"                               \
 142                         "Content-type: application/x-www-form-urlencoded\n" \
 143                         "Host: %s\n"                                        \
 144                         "User-agent: VLC Media Player/%s\r\n"               \
 145                         "\r\n"                                              \
 146                         "%s\r\n"                                            \
 147                         "\r\n"
 148
 149 vlc_module_begin();
 150     set_category( CAT_INTERFACE );
 151     set_subcategory( SUBCAT_INTERFACE_CONTROL );
 152     set_shortname( N_( "Audioscrobbler" ) );
 153     set_description( N_("Submission of played songs to last.fm") );
 154     add_string( "lastfm-username", "", NULL,
 155                 USERNAME_TEXT, USERNAME_LONGTEXT, VLC_FALSE );
 156     add_password( "lastfm-password", "", NULL,
 157                 PASSWORD_TEXT, PASSWORD_LONGTEXT, VLC_FALSE );
 158     set_capability( "interface", 0 );
 159     set_callbacks( Open, Close );
 160 vlc_module_end();
 161
 162 /*****************************************************************************
 163  * Open: initialize and create stuff
 164  *****************************************************************************/
 165 static int Open( vlc_object_t *p_this )
 166 {
 167     playlist_t      *p_playlist;
 168     intf_thread_t   *p_intf     = ( intf_thread_t* ) p_this;
 169     intf_sys_t      *p_sys      = calloc( 1, sizeof( intf_sys_t ) );
 170
 171     if( !p_sys )
 172         return VLC_ENOMEM;
 173
 174     p_intf->p_sys = p_sys;
 175
 176     vlc_mutex_init( p_this, &p_sys->lock );
 177
 178     p_playlist = pl_Yield( p_intf );
 179     PL_LOCK;
 180     var_AddCallback( p_playlist, "playlist-current", ItemChange, p_intf );
 181     PL_UNLOCK;
 182     pl_Release( p_playlist );
 183
 184     p_intf->pf_run = Run;
 185
 186     return VLC_SUCCESS;
 187 }
 188
 189 /*****************************************************************************
 190  * Close: destroy interface stuff
 191  *****************************************************************************/
 192 static void Close( vlc_object_t *p_this )
 193 {
 194     playlist_t                  *p_playlist;
 195     input_thread_t              *p_input;
 196     intf_thread_t               *p_intf = ( intf_thread_t* ) p_this;
 197     intf_sys_t                  *p_sys  = p_intf->p_sys;
 198
 199     p_playlist = pl_Yield( p_intf );
 200     PL_LOCK;
 201
 202     var_DelCallback( p_playlist, "playlist-current", ItemChange, p_intf );
 203
 204     p_input = p_playlist->p_input;
 205     if ( p_input )
 206     {
 207         vlc_object_yield( p_input );
 208
 209         if( p_sys->b_state_cb )
 210             var_DelCallback( p_input, "state", PlayingChange, p_intf );
 211
 212         vlc_object_release( p_input );
 213     }
 214
 215     PL_UNLOCK;
 216     pl_Release( p_playlist );
 217
 218     p_intf->b_dead = VLC_TRUE;
 219     /* we lock the mutex in case p_sys is being accessed from a callback */
 220     vlc_mutex_lock ( &p_sys->lock );
 221     int i;
 222     for( i = 0; i < p_sys->i_songs; i++ )
 223         DeleteSong( &p_sys->p_queue[i] );
 224     free( p_sys->psz_submit_host );
 225     free( p_sys->psz_submit_file );
 226 #if 0 //NOT USED
 227     free( p_sys->psz_nowp_host );
 228     free( p_sys->psz_nowp_file );
 229 #endif
 230     vlc_mutex_unlock ( &p_sys->lock );
 231     vlc_mutex_destroy( &p_sys->lock );
 232     free( p_sys );
 233 }
 234
 235
 236 /*****************************************************************************
 237  * Unload: Unloads the audioscrobbler when encountering fatal errors
 238  *****************************************************************************/
 239 static void Unload( intf_thread_t *p_this )
 240 {
 241     vlc_object_kill( p_this );
 242     vlc_object_detach( p_this );
 243     if( p_this->p_module )
 244         module_Unneed( p_this, p_this->p_module );
 245     vlc_mutex_destroy( &p_this->change_lock );
 246     vlc_object_destroy( p_this );
 247 }
 248
 249 /*****************************************************************************
 250  * Run : call Handshake() then submit songs
 251  *****************************************************************************/
 252 static void Run( intf_thread_t *p_intf )
 253 {
 254     char                    *psz_submit, *psz_submit_song, *psz_submit_tmp;
 255     int                     i_net_ret;
 256     int                     i_song;
 257     uint8_t                 p_buffer[1024];
 258     char                    *p_buffer_pos;
 259     int                     i_post_socket;
 260     vlc_bool_t              b_die;
 261
 262     intf_sys_t *p_sys = p_intf->p_sys;
 263
 264     /* main loop */
 265     while( !p_intf->b_die && !p_intf->p_libvlc->b_die )
 266     {
 267         /* waiting for data to submit, if waiting interval is elapsed */
 268         vlc_object_lock( p_intf );
 269         if( time( NULL ) < p_sys->next_exchange )
 270             b_die = vlc_object_timedwait( p_intf, p_sys->next_exchange );
 271         else
 272             b_die = vlc_object_wait( p_intf );
 273         vlc_object_unlock( p_intf );
 274
 275         if( b_die )
 276         {
 277             msg_Dbg( p_intf, "audioscrobbler is dying");
 278             return;
 279         }
 280
 281         /* handshake if needed */
 282         if( p_sys->b_handshaked == VLC_FALSE )
 283         {
 284             msg_Dbg( p_intf, "Handshaking with last.fm ..." );
 285
 286             switch( Handshake( p_intf ) )
 287             {
 288                 case VLC_ENOMEM:
 289                     Unload( p_intf );
 290                     return;
 291
 292                 case VLC_ENOVAR:
 293                     /* username not set */
 294                     intf_UserFatal( p_intf, VLC_FALSE,
 295                         _("Last.fm username not set"),
 296                         _("Please set a username or disable the "
 297                         "audioscrobbler plugin, and restart VLC.\n"
 298                         "Visit http://www.last.fm/join/ to get an account.")
 299                     );
 300                     Unload( p_intf );
 301                     return;
 302
 303                 case VLC_SUCCESS:
 304                     msg_Dbg( p_intf, "Handshake successfull :)" );
 305                     p_sys->b_handshaked = VLC_TRUE;
 306                     p_sys->i_interval = 0;
 307                     time( &p_sys->next_exchange );
 308                     break;
 309
 310                 case VLC_AUDIOSCROBBLER_EFATAL:
 311                     msg_Warn( p_intf, "Unloading..." );
 312                     Unload( p_intf );
 313                     return;
 314
 315                 case VLC_EGENERIC:
 316                 default:
 317                     /* protocol error : we'll try later */
 318                     HandleInterval( &p_sys->next_exchange, &p_sys->i_interval );
 319                     break;
 320             }
 321             /* if handshake failed let's restart the loop */
 322             if( p_sys->b_handshaked == VLC_FALSE )
 323                 continue;
 324         }
 325
 326         msg_Dbg( p_intf, "Going to submit some data..." );
 327
 328         if( !asprintf( &psz_submit, "s=%s", p_sys->psz_auth_token ) )
 329         {   /* Out of memory */
 330             Unload( p_intf );
 331             return;
 332         }
 333
 334         /* forge the HTTP POST request */
 335         vlc_mutex_lock( &p_sys->lock );
 336         audioscrobbler_song_t *p_song;
 337         for( i_song = 0 ; i_song < p_sys->i_songs ; i_song++ )
 338         {
 339             p_song = &p_sys->p_queue[i_song];
 340             if( !asprintf( &psz_submit_song,
 341                     "&a%%5B%d%%5D=%s&t%%5B%d%%5D=%s"
 342                     "&i%%5B%d%%5D=%llu&o%%5B%d%%5D=P&r%%5B%d%%5D="
 343                     "&l%%5B%d%%5D=%d&b%%5B%d%%5D=%s"
 344                     "&n%%5B%d%%5D=%s&m%%5B%d%%5D=%s",
 345                     i_song, p_song->psz_a,           i_song, p_song->psz_t,
 346                     i_song, (uintmax_t)p_song->date, i_song, i_song,
 347                     i_song, p_song->i_l,             i_song, p_song->psz_b,
 348                     i_song, p_song->psz_n,           i_song, p_song->psz_m
 349             ) )
 350             {   /* Out of memory */
 351                 vlc_mutex_unlock( &p_sys->lock );
 352                 Unload( p_intf );
 353                 return;
 354             }
 355             psz_submit_tmp = psz_submit;
 356             if( !asprintf( &psz_submit, "%s%s",
 357                     psz_submit_tmp, psz_submit_song ) )
 358             {   /* Out of memory */
 359                 free( psz_submit_tmp );
 360                 free( psz_submit_song );
 361                 vlc_mutex_unlock( &p_sys->lock );
 362                 Unload( p_intf );
 363                 return;
 364             }
 365             free( psz_submit_song );
 366             free( psz_submit_tmp );
 367         }
 368         vlc_mutex_unlock( &p_sys->lock );
 369
 370         i_post_socket = net_ConnectTCP( p_intf,
 371             p_sys->psz_submit_host, p_sys->i_submit_port );
 372
 373         if ( i_post_socket == -1 )
 374         {
 375             /* If connection fails, we assume we must handshake again */
 376             HandleInterval( &p_sys->next_exchange, &p_sys->i_interval );
 377             p_sys->b_handshaked = VLC_FALSE;
 378             free( psz_submit );
 379             continue;
 380         }
 381
 382         /* we transmit the data */
 383         i_net_ret = net_Printf(
 384             VLC_OBJECT( p_intf ), i_post_socket, NULL,
 385             POST_REQUEST, p_sys->psz_submit_file,
 386             (unsigned)strlen( psz_submit ), p_sys->psz_submit_file,
 387             VERSION, psz_submit
 388         );
 389
 390         free( psz_submit );
 391         if ( i_net_ret == -1 )
 392         {
 393             /* If connection fails, we assume we must handshake again */
 394             HandleInterval( &p_sys->next_exchange, &p_sys->i_interval );
 395             p_sys->b_handshaked = VLC_FALSE;
 396             continue;
 397         }
 398
 399         i_net_ret = net_Read( p_intf, i_post_socket, NULL,
 400                     p_buffer, 1023, VLC_FALSE );
 401         if ( i_net_ret <= 0 )
 402         {
 403             /* if we get no answer, something went wrong : try again */
 404             continue;
 405         }
 406
 407         net_Close( i_post_socket );
 408         p_buffer[i_net_ret] = '\0';
 409
 410         p_buffer_pos = strstr( ( char * ) p_buffer, "FAILED" );
 411         if ( p_buffer_pos )
 412         {
 413             msg_Warn( p_intf, "%s", p_buffer_pos );
 414             HandleInterval( &p_sys->next_exchange, &p_sys->i_interval );
 415             continue;
 416         }
 417
 418         p_buffer_pos = strstr( ( char * ) p_buffer, "BADSESSION" );
 419         if ( p_buffer_pos )
 420         {
 421             msg_Dbg( p_intf, "Authentication failed, handshaking again" );
 422             p_sys->b_handshaked = VLC_FALSE;
 423             HandleInterval( &p_sys->next_exchange, &p_sys->i_interval );
 424             continue;
 425         }
 426
 427         p_buffer_pos = strstr( ( char * ) p_buffer, "OK" );
 428         if ( p_buffer_pos )
 429         {
 430             int i;
 431             for( i = 0; i < p_sys->i_songs; i++ )
 432                 DeleteSong( &p_sys->p_queue[i] );
 433             p_sys->i_songs = 0;
 434             p_sys->i_interval = 0;
 435             time( &p_sys->next_exchange );
 436             msg_Dbg( p_intf, "Submission successful!" );
 437         }
 438         else
 439         {
 440             msg_Dbg( p_intf, "Authentication failed, handshaking again" );
 441             p_sys->b_handshaked = VLC_FALSE;
 442             HandleInterval( &p_sys->next_exchange, &p_sys->i_interval );
 443             continue;
 444         }
 445     }
 446 }
 447
 448 /*****************************************************************************
 449  * PlayingChange: Playing status change callback
 450  *****************************************************************************/
 451 static int PlayingChange( vlc_object_t *p_this, const char *psz_var,
 452                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 453 {
 454     intf_thread_t   *p_intf = ( intf_thread_t* ) p_data;
 455     intf_sys_t      *p_sys  = p_intf->p_sys;
 456
 457     VLC_UNUSED( p_this ); VLC_UNUSED( psz_var );
 458
 459     if( p_intf->b_dead )
 460         return VLC_SUCCESS;
 461
 462     if( p_sys->b_meta_read == VLC_FALSE && newval.i_int == PLAYING_S )
 463         ReadMetaData( p_intf );
 464
 465     if( newval.i_int == END_S || newval.i_int == ERROR_S )
 466     {
 467         /* We'll try to add the previously playing song in the queue */
 468         if( AddToQueue( p_intf ) == VLC_ENOMEM )
 469             return VLC_ENOMEM;
 470     }
 471     else if( oldval.i_int == PLAYING_S && newval.i_int == PAUSE_S )
 472         time( &p_sys->time_pause );
 473     else if( oldval.i_int == PAUSE_S && newval.i_int == PLAYING_S )
 474         p_sys->time_total_pauses += time( NULL ) - p_sys->time_pause;
 475
 476     return VLC_SUCCESS;
 477 }
 478
 479 /*****************************************************************************
 480  * ItemChange: Playlist item change callback
 481  *****************************************************************************/
 482 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
 483                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 484 {
 485     playlist_t          *p_playlist;
 486     input_thread_t      *p_input;
 487     intf_thread_t       *p_intf     = ( intf_thread_t* ) p_data;
 488     intf_sys_t          *p_sys      = p_intf->p_sys;
 489     input_item_t        *p_item;
 490     vlc_value_t         video_val;
 491
 492     VLC_UNUSED( p_this ); VLC_UNUSED( psz_var );
 493     VLC_UNUSED( oldval ); VLC_UNUSED( newval );
 494
 495     if( p_intf->b_dead )
 496         return VLC_SUCCESS;
 497
 498     p_sys->b_state_cb       = VLC_FALSE;
 499     p_sys->b_meta_read      = VLC_FALSE;
 500     p_sys->b_submit         = VLC_FALSE;
 501
 502     p_playlist = pl_Yield( p_intf );
 503     PL_LOCK;
 504     p_input = p_playlist->p_input;
 505
 506     if( !p_input || p_input->b_dead )
 507     {
 508         PL_UNLOCK;
 509         pl_Release( p_playlist );
 510         return VLC_SUCCESS;
 511     }
 512
 513     vlc_object_yield( p_input );
 514     PL_UNLOCK;
 515     pl_Release( p_playlist );
 516
 517     p_item = input_GetItem( p_input );
 518     if( !p_item )
 519     {
 520         vlc_object_release( p_input );
 521         return VLC_SUCCESS;
 522     }
 523
 524     var_Change( p_input, "video-es", VLC_VAR_CHOICESCOUNT, &video_val, NULL );
 525     if( ( video_val.i_int > 0 ) || p_item->i_type == ITEM_TYPE_NET )
 526     {
 527         msg_Dbg( p_this, "Not an audio local file, not submitting");
 528         vlc_object_release( p_input );
 529         return VLC_SUCCESS;
 530     }
 531
 532     p_sys->time_total_pauses = 0;
 533     time( &p_sys->p_current_song.date );
 534
 535     var_AddCallback( p_input, "state", PlayingChange, p_intf );
 536     p_sys->b_state_cb = VLC_TRUE;
 537
 538     if( input_item_IsPreparsed( p_item ) )
 539         ReadMetaData( p_intf );
 540     /* if the input item was not preparsed, we'll do it in PlayingChange()
 541      * callback, when "state" == PLAYING_S */
 542
 543     vlc_object_release( p_input );
 544     return VLC_SUCCESS;
 545 }
 546
 547 /*****************************************************************************
 548  * AddToQueue: Add the played song to the queue to be submitted
 549  *****************************************************************************/
 550 static int AddToQueue ( intf_thread_t *p_this )
 551 {
 552     time_t                      played_time;
 553     intf_sys_t                  *p_sys = p_this->p_sys;
 554
 555     vlc_mutex_lock( &p_sys->lock );
 556     if( !p_sys->b_submit )
 557     {
 558         DeleteSong( &p_sys->p_current_song );
 559         vlc_mutex_unlock( &p_sys->lock );
 560         return VLC_SUCCESS;
 561     }
 562
 563     /* wait for the user to listen enough before submitting */
 564     time ( &played_time );
 565     played_time -= p_sys->p_current_song.date;
 566     played_time -= p_sys->time_total_pauses;
 567     if( ( played_time < 240 ) &&
 568         ( played_time < ( p_sys->p_current_song.i_l / 2 ) ) )
 569     {
 570         msg_Dbg( p_this, "Song not listened long enough, not submitting" );
 571         DeleteSong( &p_sys->p_current_song );
 572         vlc_mutex_unlock( &p_sys->lock );
 573         return VLC_SUCCESS;
 574     }
 575
 576     if( p_sys->p_current_song.i_l < 30 )
 577     {
 578         msg_Dbg( p_this, "Song too short (< 30s), not submitting" );
 579         DeleteSong( &p_sys->p_current_song );
 580         vlc_mutex_unlock( &p_sys->lock );
 581         return VLC_SUCCESS;
 582     }
 583
 584     if( !p_sys->p_current_song.psz_a || !*p_sys->p_current_song.psz_a ||
 585         !p_sys->p_current_song.psz_t || !*p_sys->p_current_song.psz_t )
 586     {
 587         msg_Dbg( p_this, "Missing artist or title, not submitting" );
 588         DeleteSong( &p_sys->p_current_song );
 589         vlc_mutex_unlock( &p_sys->lock );
 590         return VLC_SUCCESS;
 591     }
 592
 593     if( p_sys->i_songs == 50 )
 594     {
 595         msg_Warn( p_this, "Submission queue is full, not submitting" );
 596         DeleteSong( &p_sys->p_current_song );
 597         vlc_mutex_unlock( &p_sys->lock );
 598         return VLC_SUCCESS;
 599     }
 600
 601     msg_Dbg( p_this, "Song will be submitted." );
 602
 603 #define QUEUE_COPY( a ) \
 604     p_sys->p_queue[p_sys->i_songs].a = p_sys->p_current_song.a
 605
 606 #define QUEUE_COPY_NULL( a ) \
 607     QUEUE_COPY( a ); \
 608     p_sys->p_current_song.a = NULL
 609
 610     QUEUE_COPY( i_l );
 611     QUEUE_COPY_NULL( psz_n );
 612     QUEUE_COPY_NULL( psz_a );
 613     QUEUE_COPY_NULL( psz_t );
 614     QUEUE_COPY_NULL( psz_b );
 615     QUEUE_COPY_NULL( psz_m );
 616     QUEUE_COPY( date );
 617 #undef QUEUE_COPY_NULL
 618 #undef QUEUE_COPY
 619
 620     p_sys->i_songs++;
 621
 622     /* signal the main loop we have something to submit */
 623     vlc_object_lock( p_this );
 624     vlc_cond_signal( &p_this->object_wait );
 625     vlc_object_unlock( p_this );
 626
 627     vlc_mutex_unlock( &p_sys->lock );
 628     return VLC_SUCCESS;
 629 }
 630
 631 /*****************************************************************************
 632  * ParseURL : Split an http:// URL into host, file, and port
 633  *
 634  * Example: "62.216.251.205:80/protocol_1.2"
 635  *      will be split into "62.216.251.205", 80, "protocol_1.2"
 636  *
 637  * psz_url will be freed before returning
 638  * *psz_file & *psz_host will be freed before use
 639  *
 640  * Return value:
 641  *  VLC_ENOMEM      Out Of Memory
 642  *  VLC_EGENERIC    Invalid url provided
 643  *  VLC_SUCCESS     Success
 644  *****************************************************************************/
 645 static int ParseURL( char *psz_url, char **psz_host, char **psz_file,
 646                         int *i_port )
 647 {
 648     int i_pos;
 649     int i_len = strlen( psz_url );
 650     FREENULL( *psz_host );
 651     FREENULL( *psz_file );
 652
 653     i_pos = strcspn( psz_url, ":" );
 654     if( i_pos == i_len )
 655         return VLC_EGENERIC;
 656
 657     *psz_host = strndup( psz_url, i_pos );
 658     if( !*psz_host )
 659         return VLC_ENOMEM;
 660
 661     i_pos++; /* skip the ':' */
 662     *i_port = atoi( psz_url + i_pos );
 663     if( *i_port <= 0 )
 664     {
 665         FREENULL( *psz_host );
 666         return VLC_EGENERIC;
 667     }
 668
 669     i_pos = strcspn( psz_url, "/" );
 670
 671     if( i_pos == i_len )
 672         return VLC_EGENERIC;
 673
 674     i_pos++; /* skip the '/' */
 675     *psz_file = strdup( psz_url + i_pos );
 676     if( !*psz_file )
 677     {
 678         FREENULL( *psz_host );
 679         return VLC_ENOMEM;
 680     }
 681
 682     free( psz_url );
 683     return VLC_SUCCESS;
 684 }
 685
 686 /*****************************************************************************
 687  * Handshake : Init audioscrobbler connection
 688  *****************************************************************************/
 689 static int Handshake( intf_thread_t *p_this )
 690 {
 691     char                *psz_username, *psz_password;
 692     time_t              timestamp;
 693     char                psz_timestamp[33];
 694
 695     struct md5_s        p_struct_md5;
 696     char                psz_password_md5[33];
 697
 698     stream_t            *p_stream;
 699     char                *psz_handshake_url;
 700     uint8_t             p_buffer[1024];
 701     char                *p_buffer_pos;
 702
 703     int                 i_ret;
 704     char                *psz_url;
 705
 706     intf_thread_t       *p_intf                 = ( intf_thread_t* ) p_this;
 707     intf_sys_t          *p_sys                  = p_this->p_sys;
 708
 709     psz_username = config_GetPsz( p_this, "lastfm-username" );
 710     if( !psz_username )
 711         return VLC_ENOMEM;
 712
 713     psz_password = config_GetPsz( p_this, "lastfm-password" );
 714     if( !psz_password )
 715     {
 716         free( psz_username );
 717         return VLC_ENOMEM;
 718     }
 719
 720     /* username or password have not been setup */
 721     if ( !*psz_username || !*psz_password )
 722     {
 723         free( psz_username );
 724         free( psz_password );
 725         return VLC_ENOVAR;
 726     }
 727
 728     time( &timestamp );
 729
 730     /* generates a md5 hash of the password */
 731     InitMD5( &p_struct_md5 );
 732     AddMD5( &p_struct_md5, ( uint8_t* ) psz_password, strlen( psz_password ) );
 733     EndMD5( &p_struct_md5 );
 734
 735     free( psz_password );
 736
 737     int i;
 738     for ( i = 0; i < 4; i++ )
 739     {
 740         sprintf( &psz_password_md5[8*i], "%02x%02x%02x%02x",
 741             p_struct_md5.p_digest[i] & 0xff,
 742             ( p_struct_md5.p_digest[i] >> 8 ) & 0xff,
 743             ( p_struct_md5.p_digest[i] >> 16 ) & 0xff,
 744             p_struct_md5.p_digest[i] >> 24
 745         );
 746     }
 747
 748     snprintf( psz_timestamp, 33, "%llu", (uintmax_t)timestamp );
 749
 750     /* generates a md5 hash of :
 751      * - md5 hash of the password, plus
 752      * - timestamp in clear text
 753      */
 754     InitMD5( &p_struct_md5 );
 755     AddMD5( &p_struct_md5, ( uint8_t* ) psz_password_md5, 32 );
 756     AddMD5( &p_struct_md5, ( uint8_t* ) psz_timestamp, strlen( psz_timestamp ));
 757     EndMD5( &p_struct_md5 );
 758
 759     for ( i = 0; i < 4; i++ )
 760     {
 761         sprintf( &p_sys->psz_auth_token[8*i], "%02x%02x%02x%02x",
 762             p_struct_md5.p_digest[i] & 0xff,
 763             ( p_struct_md5.p_digest[i] >> 8 ) & 0xff,
 764             ( p_struct_md5.p_digest[i] >> 16 ) & 0xff,
 765             p_struct_md5.p_digest[i] >> 24
 766         );
 767     }
 768
 769     p_sys->psz_auth_token[32] = '\0';
 770
 771     if( !asprintf( &psz_handshake_url,
 772     "http://post.audioscrobbler.com/?hs=true&p=1.2&c=%s&v=%s&u=%s&t=%s&a=%s",
 773         CLIENT_NAME, CLIENT_VERSION, psz_username, psz_timestamp,
 774         p_sys->psz_auth_token ) )
 775     {
 776         free( psz_username );
 777         return VLC_ENOMEM;
 778     }
 779     free( psz_username );
 780
 781     /* send the http handshake request */
 782     p_stream = stream_UrlNew( p_intf, psz_handshake_url );
 783     free( psz_handshake_url );
 784
 785     if( !p_stream )
 786         return VLC_EGENERIC;
 787
 788     /* read answer */
 789     i_ret = stream_Read( p_stream, p_buffer, 1023 );
 790     if( i_ret == 0 )
 791     {
 792         stream_Delete( p_stream );
 793         return VLC_EGENERIC;
 794     }
 795     p_buffer[i_ret] = '\0';
 796     stream_Delete( p_stream );
 797
 798     p_buffer_pos = strstr( ( char* ) p_buffer, "FAILED " );
 799     if ( p_buffer_pos )
 800     {
 801         /* handshake request failed, sorry */
 802         msg_Warn( p_this, "last.fm handshake failed: %s", p_buffer_pos + 7 );
 803         return VLC_EGENERIC;
 804     }
 805
 806     p_buffer_pos = strstr( ( char* ) p_buffer, "BADAUTH" );
 807     if ( p_buffer_pos )
 808     {
 809         /* authentication failed, bad username/password combination */
 810         intf_UserFatal( p_this, VLC_FALSE,
 811             _("last.fm: Authentication failed"),
 812             _("last.fm username or password is incorrect. "
 813               "Please verify your settings and relaunch VLC." ) );
 814         return VLC_AUDIOSCROBBLER_EFATAL;
 815     }
 816
 817     p_buffer_pos = strstr( ( char* ) p_buffer, "BANNED" );
 818     if ( p_buffer_pos )
 819     {
 820         /* oops, our version of vlc has been banned by last.fm servers */
 821         msg_Err( p_intf, "This version of VLC has been banned by last.fm. "
 822                          "You should upgrade VLC, or disable the last.fm plugin." );
 823         return VLC_AUDIOSCROBBLER_EFATAL;
 824     }
 825
 826     p_buffer_pos = strstr( ( char* ) p_buffer, "BADTIME" );
 827     if ( p_buffer_pos )
 828     {
 829         /* The system clock isn't good */
 830         msg_Err( p_intf, "last.fm handshake failed because your clock is too "
 831                          "much shifted. Please correct it, and relaunch VLC." );
 832         return VLC_AUDIOSCROBBLER_EFATAL;
 833     }
 834
 835     p_buffer_pos = strstr( ( char* ) p_buffer, "OK" );
 836     if ( !p_buffer_pos )
 837         goto proto;
 838
 839     p_buffer_pos = strstr( p_buffer_pos, "\n" );
 840     if( !p_buffer_pos || strlen( p_buffer_pos ) < 34 )
 841         goto proto;
 842     p_buffer_pos++; /* we skip the '\n' */
 843
 844     /* save the session ID */
 845     snprintf( &p_sys->psz_auth_token[0], 33, "%s", p_buffer_pos );
 846
 847     p_buffer_pos = strstr( p_buffer_pos, "http://" );
 848     if( !p_buffer_pos || strlen( p_buffer_pos ) == 7 )
 849         goto proto;
 850
 851     /* We need to read the nowplaying url */
 852     p_buffer_pos += 7; /* we skip "http://" */
 853 #if 0 //NOT USED
 854     psz_url = strndup( p_buffer_pos, strcspn( p_buffer_pos, "\n" ) );
 855     if( !psz_url )
 856         goto oom;
 857
 858     switch( ParseURL( psz_url, &p_sys->psz_nowp_host,
 859                 &p_sys->psz_nowp_file, &p_sys->i_nowp_port ) )
 860     {
 861         case VLC_ENOMEM:
 862             goto oom;
 863         case VLC_EGENERIC:
 864             goto proto;
 865         case VLC_SUCCESS:
 866         default:
 867             break;
 868     }
 869 #endif
 870     p_buffer_pos = strstr( p_buffer_pos, "http://" );
 871     if( !p_buffer_pos || strlen( p_buffer_pos ) == 7 )
 872         goto proto;
 873
 874     /* We need to read the submission url */
 875     p_buffer_pos += 7; /* we skip "http://" */
 876     psz_url = strndup( p_buffer_pos, strcspn( p_buffer_pos, "\n" ) );
 877     if( !psz_url )
 878         goto oom;
 879
 880     switch( ParseURL( psz_url, &p_sys->psz_submit_host,
 881                 &p_sys->psz_submit_file, &p_sys->i_submit_port ) )
 882     {
 883         case VLC_ENOMEM:
 884             goto oom;
 885         case VLC_EGENERIC:
 886             goto proto;
 887         case VLC_SUCCESS:
 888         default:
 889             break;
 890     }
 891
 892     return VLC_SUCCESS;
 893
 894 oom:
 895     return VLC_ENOMEM;
 896
 897 proto:
 898     msg_Warn( p_intf, "Handshake: can't recognize server protocol" );
 899     return VLC_EGENERIC;
 900 }
 901
 902 /*****************************************************************************
 903  * DeleteSong : Delete the char pointers in a song
 904  *****************************************************************************/
 905 static void DeleteSong( audioscrobbler_song_t* p_song )
 906 {
 907     FREENULL( p_song->psz_a );
 908     FREENULL( p_song->psz_b );
 909     FREENULL( p_song->psz_t );
 910     FREENULL( p_song->psz_m );
 911     FREENULL( p_song->psz_n );
 912 }
 913
 914 /*****************************************************************************
 915  * ReadMetaData : Read meta data when parsed by vlc
 916  *****************************************************************************/
 917 static int ReadMetaData( intf_thread_t *p_this )
 918 {
 919     playlist_t          *p_playlist;
 920     input_thread_t      *p_input;
 921     input_item_t        *p_item;
 922
 923     intf_sys_t          *p_sys = p_this->p_sys;
 924
 925     p_playlist = pl_Yield( p_this );
 926     PL_LOCK;
 927     p_input = p_playlist->p_input;
 928     if( !p_input )
 929     {
 930         PL_UNLOCK;
 931         pl_Release( p_playlist );
 932         return( VLC_SUCCESS );
 933     }
 934
 935     vlc_object_yield( p_input );
 936     PL_UNLOCK;
 937     pl_Release( p_playlist );
 938
 939     p_item = input_GetItem( p_input );
 940     if( !p_item )
 941         return VLC_SUCCESS;
 942
 943     char *psz_meta;
 944 #define ALLOC_ITEM_META( a, b ) \
 945     psz_meta = input_item_Get##b( p_item ); \
 946     if( psz_meta && *psz_meta ) \
 947     { \
 948         a = encode_URI_component( psz_meta ); \
 949         if( !a ) \
 950         { \
 951             free( psz_meta ); \
 952             return VLC_ENOMEM; \
 953         } \
 954         free( psz_meta ); \
 955     }
 956
 957     vlc_mutex_lock( &p_sys->lock );
 958
 959     p_sys->b_meta_read = VLC_TRUE;
 960
 961     ALLOC_ITEM_META( p_sys->p_current_song.psz_a, Artist )
 962     else
 963     {
 964         vlc_mutex_unlock( &p_sys->lock );
 965         msg_Dbg( p_this, "No artist.." );
 966         vlc_object_release( p_input );
 967         free( psz_meta );
 968         return VLC_EGENERIC;
 969     }
 970
 971     ALLOC_ITEM_META( p_sys->p_current_song.psz_t, Title )
 972     else
 973     {
 974         vlc_mutex_unlock( &p_sys->lock );
 975         msg_Dbg( p_this, "No track name.." );
 976         vlc_object_release( p_input );
 977         free( p_sys->p_current_song.psz_a );
 978         free( psz_meta );
 979         return VLC_EGENERIC;
 980     }
 981
 982     /* Now we have read the mandatory meta data, so we can submit that info */
 983     p_sys->b_submit = VLC_TRUE;
 984
 985     ALLOC_ITEM_META( p_sys->p_current_song.psz_b, Album )
 986     else
 987         p_sys->p_current_song.psz_b = calloc( 1, 1 );
 988
 989     ALLOC_ITEM_META( p_sys->p_current_song.psz_m, TrackID )
 990     else
 991         p_sys->p_current_song.psz_m = calloc( 1, 1 );
 992
 993     p_sys->p_current_song.i_l = input_item_GetDuration( p_item ) / 1000000;
 994
 995     ALLOC_ITEM_META( p_sys->p_current_song.psz_n, TrackNum )
 996     else
 997         p_sys->p_current_song.psz_n = calloc( 1, 1 );
 998 #undef ALLOC_ITEM_META
 999
1000     msg_Dbg( p_this, "Meta data registered" );
1001
1002     vlc_mutex_unlock( &p_sys->lock );
1003     vlc_object_release( p_input );
1004     return VLC_SUCCESS;
1005
1006 }
1007
1008 static void HandleInterval( time_t *next, unsigned int *i_interval )
1009 {
1010     if( *i_interval == 0 )
1011     {
1012         /* first interval is 1 minute */
1013         *i_interval = 60;
1014     }
1015     else
1016     {
1017         /* else we double the previous interval, up to 120 minutes */
1018         *i_interval = *i_interval * 2;
1019         if( *i_interval > 60*120 )
1020             *i_interval = 60*120;
1021     }
1022     *next = time( NULL ) + *i_interval;
1023 }
1024