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

   1 /*****************************************************************************
   2  * audioscrobbler.c : audioscrobbler submission plugin
   3  *****************************************************************************
   4  * Copyright (C) 2006 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Rafaël Carré <funman at videolan org>
   8  *          Kenneth Ostby <kenneo -at- idi -dot- ntnu -dot- no>
   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 /* audioscrobbler protocol version: 1.1
  26  * http://audioscrobbler.net/wiki/Protocol1.1
  27  * */
  28
  29 /*****************************************************************************
  30  * Preamble
  31  *****************************************************************************/
  32
  33 #define _GNU_SOURCE
  34 #include <string.h>
  35
  36 #if defined( WIN32 )
  37 #include <time.h>
  38 #endif
  39
  40 #include <vlc/vlc.h>
  41 #include <vlc_interface.h>
  42 #include <vlc_meta.h>
  43 #include <vlc_md5.h>
  44 #include <vlc_block.h>
  45 #include <vlc_stream.h>
  46 #include <vlc_url.h>
  47 #include <vlc_network.h>
  48 #include <vlc_interface.h>
  49 #include <vlc_playlist.h>
  50
  51 /*****************************************************************************
  52  * Local prototypes
  53  *****************************************************************************/
  54
  55 /* Keeps track of metadata to be submitted */
  56 typedef struct audioscrobbler_song_t
  57 {
  58     char        *psz_a;                /* track artist     */
  59     char        *psz_t;                /* track title      */
  60     char        *psz_b;                /* track album      */
  61     int         i_l;                   /* track length     */
  62     char        *psz_m;                /* musicbrainz id   */
  63     char        *psz_i;                /* date             */
  64     time_t      time_playing;          /* date (epoch)     */
  65 } audioscrobbler_song_t;
  66
  67
  68 /* Queue to be submitted to server, 10 songs max */
  69 typedef struct audioscrobbler_queue_t
  70 {
  71     audioscrobbler_song_t   **p_queue;      /* contains up to 10 songs        */
  72     int                     i_songs_nb;     /* number of songs                */
  73     void                    *p_next_queue;  /* if queue full, pointer to next */
  74 } audioscrobbler_queue_t;
  75
  76 struct intf_sys_t
  77 {
  78     audioscrobbler_queue_t  *p_first_queue;     /* 1st queue              */
  79     vlc_mutex_t             lock;               /* p_sys mutex            */
  80
  81     /* data about audioscrobbler session */
  82     time_t                  time_next_exchange; /* when can we send data? */
  83     char                    *psz_submit_host;   /* where to submit data ? */
  84     int                     i_submit_port;      /* at which port ?        */
  85     char                    *psz_submit_file;   /* in which file ?        */
  86     char                    *psz_username;      /* last.fm username       */
  87     vlc_bool_t              b_handshaked;       /* did we handshake ?     */
  88     char                    *psz_response_md5;  /* md5 response to use    */
  89
  90     /* data about song currently playing */
  91     audioscrobbler_song_t   *p_current_song;    /* song being played      */
  92     time_t                  time_pause;         /* time when vlc paused   */
  93     time_t                  time_total_pauses;  /* sum of time in pause   */
  94     vlc_bool_t              b_queued;           /* has it been queud ?    */
  95     vlc_bool_t              b_metadata_read;    /* did we read metadata ? */
  96     vlc_bool_t              b_paused;           /* is vlc paused ?        */
  97     vlc_bool_t              b_waiting_meta;     /* we need fetched data?  */
  98 };
  99
 100 intf_sys_t *p_sys_global;     /* to retrieve p_sys in Run() thread */
 101
 102 static int  Open        ( vlc_object_t * );
 103 static void Close       ( vlc_object_t * );
 104 static void Run         ( intf_thread_t * );
 105 static int ItemChange   ( vlc_object_t *, const char *, vlc_value_t,
 106                                 vlc_value_t, void * );
 107 static int PlayingChange( vlc_object_t *, const char *, vlc_value_t,
 108                                 vlc_value_t, void * );
 109 static int AddToQueue   ( intf_thread_t *p_this );
 110 static int Handshake    ( intf_thread_t *p_sd );
 111 static int ReadMetaData ( intf_thread_t *p_this );
 112 void DeleteQueue        ( audioscrobbler_queue_t *p_queue );
 113
 114 /*****************************************************************************
 115  * Module descriptor
 116  ****************************************************************************/
 117
 118 #define USERNAME_TEXT       N_("Username")
 119 #define USERNAME_LONGTEXT   N_("The username of your last.fm account")
 120 #define PASSWORD_TEXT       N_("Password")
 121 #define PASSWORD_LONGTEXT   N_("The password of your last.fm account")
 122
 123 /* if something goes wrong, we wait at least one minute before trying again */
 124 #define DEFAULT_INTERVAL 60
 125
 126 /* last.fm client identifier */
 127 #define CLIENT_NAME     PACKAGE
 128 #define CLIENT_VERSION  VERSION
 129
 130 /* HTTP POST request : to submit data */
 131 #define    POST_REQUEST "POST /%s HTTP/1.1\n"                               \
 132                         "Accept-Encoding: identity\n"                       \
 133                         "Content-length: %d\n"                              \
 134                         "Connection: close\n"                               \
 135                         "Content-type: application/x-www-form-urlencoded\n" \
 136                         "Host: %s\n"                                        \
 137                         "User-agent: VLC Media Player/%s\r\n"               \
 138                         "\r\n"                                              \
 139                         "%s\r\n"                                            \
 140                         "\r\n"
 141
 142 /* data to submit */
 143 #define POST_DATA       "&a%%5B%d%%5D=%s&t%%5B%d%%5D=%s&b%%5B%d%%5D=%s" \
 144                         "&m%%5B%d%%5D=%s&l%%5B%d%%5D=%d&i%%5B%d%%5D=%s"
 145 #define HTTPPOST_MAXLEN 2048
 146
 147 vlc_module_begin();
 148     set_category( CAT_INTERFACE );
 149     set_subcategory( SUBCAT_INTERFACE_CONTROL );
 150     set_shortname( N_( "Audioscrobbler" ) );
 151     set_description( N_("Audioscrobbler submission Plugin") );
 152     add_string( "lastfm-username", "", NULL,
 153                 USERNAME_TEXT, USERNAME_LONGTEXT, VLC_FALSE );
 154     add_string( "lastfm-password", "", NULL,
 155                 PASSWORD_TEXT, PASSWORD_LONGTEXT, VLC_FALSE );
 156     set_capability( "interface", 0 );
 157     set_callbacks( Open, Close );
 158 vlc_module_end();
 159
 160 /*****************************************************************************
 161  * Open: initialize and create stuff
 162  *****************************************************************************/
 163
 164 static int Open( vlc_object_t *p_this )
 165 {
 166     playlist_t      *p_playlist;
 167     intf_thread_t   *p_intf     = ( intf_thread_t* ) p_this;
 168     intf_sys_t      *p_sys      = malloc( sizeof( intf_sys_t ) );
 169
 170 #define MEM_ERROR \
 171     free( p_sys->p_current_song ); \
 172     free( p_sys->p_first_queue ); \
 173     free( p_sys->psz_response_md5 ); \
 174     free( p_sys ); \
 175     return VLC_ENOMEM;
 176
 177     if( !p_sys )
 178     {
 179         MEM_ERROR
 180     }
 181
 182     p_intf->p_sys = p_sys;
 183
 184     vlc_mutex_init( p_this, &p_sys->lock );
 185
 186     p_sys_global = p_sys;
 187     p_sys->psz_submit_host = NULL;
 188     p_sys->psz_submit_file = NULL;
 189     p_sys->b_handshaked = VLC_FALSE;
 190     p_sys->time_next_exchange = time( NULL );
 191     p_sys->psz_username = NULL;
 192     p_sys->b_paused = VLC_FALSE;
 193
 194 #define MALLOC_CHECK( a ) \
 195     if( !a ) { \
 196         vlc_mutex_destroy( &p_sys->lock ); \
 197         MEM_ERROR \
 198     }
 199
 200     /* md5 response is 32 chars, + final \0 */
 201     p_sys->psz_response_md5 = malloc( 33 );
 202     MALLOC_CHECK( p_sys->psz_response_md5 )
 203
 204     p_sys->p_first_queue = malloc( sizeof( audioscrobbler_queue_t ) );
 205     MALLOC_CHECK( p_sys->p_first_queue )
 206
 207     p_sys->p_current_song = malloc( sizeof( audioscrobbler_song_t ) );
 208     MALLOC_CHECK( p_sys->p_current_song )
 209     time( &p_sys->p_current_song->time_playing );
 210
 211     /* queues can't contain more than 10 songs */
 212     p_sys->p_first_queue->p_queue =
 213         malloc( 10 * sizeof( audioscrobbler_song_t ) );
 214     MALLOC_CHECK( p_sys->p_current_song )
 215
 216     p_sys->p_first_queue->i_songs_nb = 0;
 217     p_sys->p_first_queue->p_next_queue = NULL;
 218
 219     p_playlist = pl_Yield( p_intf );
 220     PL_LOCK;
 221     var_AddCallback( p_playlist, "playlist-current", ItemChange, p_intf );
 222     PL_UNLOCK;
 223     pl_Release( p_playlist );
 224
 225     p_intf->pf_run = Run;
 226
 227     return VLC_SUCCESS;
 228 #undef MEM_ERROR
 229 #undef MALLOC_CHECK
 230 }
 231
 232 /*****************************************************************************
 233  * Close: destroy interface stuff
 234  *****************************************************************************/
 235 static void Close( vlc_object_t *p_this )
 236 {
 237     audioscrobbler_queue_t      *p_current_queue, *p_next_queue;
 238     playlist_t                  *p_playlist;
 239     input_thread_t              *p_input;
 240     intf_thread_t               *p_intf = ( intf_thread_t* ) p_this;
 241     intf_sys_t                  *p_sys  = p_intf->p_sys;
 242
 243     p_playlist = pl_Yield( p_intf );
 244     PL_LOCK;
 245     var_DelCallback( p_playlist, "playlist-current", ItemChange, p_intf );
 246
 247     p_input = p_playlist->p_input;
 248     if ( p_input )
 249     {
 250         vlc_object_yield( p_input );
 251         var_DelCallback( p_input, "state", PlayingChange, p_intf );
 252         vlc_object_release( p_input );
 253     }
 254
 255     PL_UNLOCK;
 256     pl_Release( p_playlist );
 257
 258     vlc_mutex_lock ( &p_sys->lock );
 259     p_current_queue = p_sys->p_first_queue;
 260     vlc_mutex_unlock ( &p_sys->lock );
 261
 262     while( ( p_current_queue->i_songs_nb == 10 ) &&
 263         ( p_current_queue->p_next_queue != NULL ) )
 264     {
 265         p_next_queue = p_current_queue->p_next_queue;
 266         DeleteQueue( p_current_queue );
 267         free( p_current_queue );
 268         p_current_queue = p_next_queue;
 269     }
 270
 271     DeleteQueue( p_current_queue );
 272     free( p_current_queue );
 273
 274     vlc_mutex_lock ( &p_sys->lock );
 275     free( p_sys->psz_username );
 276     free( p_sys->p_current_song );
 277     free( p_sys->psz_submit_host );
 278     free( p_sys->psz_submit_file );
 279     free( p_sys->psz_response_md5 );
 280     vlc_mutex_unlock ( &p_sys->lock );
 281     vlc_mutex_destroy( &p_sys->lock );
 282     free( p_sys );
 283 }
 284
 285 /*****************************************************************************
 286  * Run : call Handshake() then submit songs
 287  *****************************************************************************/
 288 static void Run( intf_thread_t *p_this )
 289 {
 290     char                    *psz_submit         = NULL;
 291     char                    *psz_submit_song    = NULL;
 292     int                     i_net_ret;
 293     int                     i_song;
 294     playlist_t              *p_playlist;
 295     uint8_t                 *p_buffer           = NULL;
 296     char                    *p_buffer_pos       = NULL;
 297     audioscrobbler_queue_t  *p_first_queue;
 298     int                     i_post_socket;
 299     time_t                  played_time;
 300
 301     p_this->p_sys = p_sys_global;
 302     intf_sys_t *p_sys = p_this->p_sys;
 303
 304     #define MEM_ERROR \
 305         free( psz_submit ); \
 306         free( psz_submit_song ); \
 307         free( p_buffer ); \
 308         msg_Err( p_this, "Out of memory" ); \
 309         return;
 310
 311     psz_submit = malloc( HTTPPOST_MAXLEN );
 312     psz_submit_song = malloc( HTTPPOST_MAXLEN );
 313     p_buffer = ( uint8_t* ) malloc( 1024 );
 314
 315     if( !psz_submit || !psz_submit_song || !p_buffer )
 316     {
 317         MEM_ERROR
 318     }
 319
 320     /* main loop */
 321     while( !p_this->b_die )
 322     {
 323         /* verify if there is data to submit
 324          * and if waiting interval is elapsed */
 325         if ( ( p_sys->p_first_queue->i_songs_nb > 0 ) &&
 326             ( time( NULL ) >= p_sys->time_next_exchange ) )
 327         {
 328             /* handshake if needed */
 329             if( p_sys->b_handshaked == VLC_FALSE )
 330             {
 331                 msg_Dbg( p_this, "Handshaking with last.fm ..." );
 332
 333                 switch( Handshake( p_this ) )
 334                 {
 335                     case VLC_ENOMEM:
 336                         MEM_ERROR
 337                         break;
 338
 339                     case VLC_ENOVAR:
 340                         /* username not set */
 341                         vlc_mutex_unlock ( &p_sys->lock );
 342                         intf_UserFatal( p_this, VLC_FALSE,
 343                             _("Last.fm username not set"),
 344                             _("Please set an username or disable "
 345                             "audioscrobbler plugin, and then restart VLC.\n"
 346                             "Visit https://www.last.fm/join/ to get an account")
 347                         );
 348                         free( psz_submit );
 349                         free( psz_submit_song );
 350                         free( p_buffer );
 351                         return;
 352                         break;
 353
 354                     case VLC_SUCCESS:
 355                         msg_Dbg( p_this, "Handshake successfull :)" );
 356                         vlc_mutex_lock ( &p_sys->lock );
 357                         p_sys->b_handshaked = VLC_TRUE;
 358                         vlc_mutex_unlock ( &p_sys->lock );
 359                         break;
 360
 361                     case VLC_EGENERIC:
 362                     default:
 363                         /* protocol error : we'll try later */
 364                         vlc_mutex_lock ( &p_sys->lock );
 365                         time( &p_sys->time_next_exchange );
 366                         p_sys->time_next_exchange += DEFAULT_INTERVAL;
 367                         vlc_mutex_unlock ( &p_sys->lock );
 368                         break;
 369                 }
 370             }
 371
 372             msg_Dbg( p_this, "Going to submit some data..." );
 373             vlc_mutex_lock ( &p_sys->lock );
 374
 375             snprintf( psz_submit, HTTPPOST_MAXLEN, "u=%s&s=%s",
 376                 p_sys->psz_username, p_sys->psz_response_md5 );
 377
 378             /* forge the HTTP POST request */
 379             for (i_song = 0 ; i_song < p_sys->p_first_queue->i_songs_nb ;
 380                 i_song++ )
 381             {
 382                 snprintf( psz_submit_song, HTTPPOST_MAXLEN -1, POST_DATA,
 383                     i_song, p_sys->p_first_queue->p_queue[i_song]->psz_a,
 384                     i_song, p_sys->p_first_queue->p_queue[i_song]->psz_t,
 385                     i_song, p_sys->p_first_queue->p_queue[i_song]->psz_b,
 386                     i_song, p_sys->p_first_queue->p_queue[i_song]->psz_m,
 387                     i_song, p_sys->p_first_queue->p_queue[i_song]->i_l,
 388                     i_song, p_sys->p_first_queue->p_queue[i_song]->psz_i
 389                 );
 390                 strncat( psz_submit, psz_submit_song, HTTPPOST_MAXLEN - 1 );
 391             }
 392
 393             i_post_socket = net_ConnectTCP( p_this,
 394                 p_sys->psz_submit_host, p_sys->i_submit_port);
 395
 396             if ( i_post_socket == -1 )
 397             {
 398                 /* If connection fails, we assume we must handshake again */
 399                 time( &p_sys->time_next_exchange );
 400                 p_sys->time_next_exchange += DEFAULT_INTERVAL;
 401                 p_sys->b_handshaked = VLC_FALSE;
 402                 vlc_mutex_unlock( &p_sys->lock );
 403                 continue;
 404             }
 405
 406             /* we transmit the data */
 407             i_net_ret = net_Printf(
 408                 VLC_OBJECT(p_this), i_post_socket, NULL,
 409                 POST_REQUEST, p_sys->psz_submit_file,
 410                 strlen( psz_submit ), p_sys->psz_submit_file,
 411                 VERSION, psz_submit
 412             );
 413
 414             if ( i_net_ret == -1 )
 415             {
 416                 /* If connection fails, we assume we must handshake again */
 417                 time( &p_sys->time_next_exchange );
 418                 p_sys->time_next_exchange += DEFAULT_INTERVAL;
 419                 p_sys->b_handshaked = VLC_FALSE;
 420                 vlc_mutex_unlock( &p_sys->lock );
 421                 continue;
 422             }
 423
 424             memset( p_buffer, '\0', 1024 );
 425
 426             i_net_ret = net_Read( p_this, i_post_socket, NULL,
 427                         p_buffer, 1024, VLC_FALSE );
 428             if ( i_net_ret <= 0 )
 429             {
 430                 /* if we get no answer, something went wrong : try again */
 431                 vlc_mutex_unlock( &p_sys->lock );
 432                 continue;
 433             }
 434
 435             net_Close( i_post_socket );
 436
 437             /* record interval */
 438             p_buffer_pos = strstr( ( char * ) p_buffer, "INTERVAL" );
 439             if ( p_buffer_pos )
 440             {
 441                 time( &p_sys->time_next_exchange );
 442                 p_sys->time_next_exchange += atoi( p_buffer_pos +
 443                                             strlen( "INTERVAL " ) );
 444             }
 445
 446             p_buffer_pos = strstr( ( char * ) p_buffer, "FAILED" );
 447             if ( p_buffer_pos )
 448             {
 449                 /* woops, submission failed */
 450                 msg_Dbg( p_this, "%s", p_buffer_pos );
 451                 vlc_mutex_unlock ( &p_sys->lock );
 452                 continue;
 453             }
 454
 455             p_buffer_pos = strstr( ( char * ) p_buffer, "BADAUTH" );
 456             if ( p_buffer_pos )
 457             {
 458                 msg_Dbg( p_this, "Authentification failed, handshaking again" );
 459                 p_sys->b_handshaked = VLC_FALSE;
 460                 vlc_mutex_unlock ( &p_sys->lock );
 461                 continue;
 462             }
 463
 464             p_buffer_pos = strstr( ( char * ) p_buffer, "OK" );
 465             if ( p_buffer_pos )
 466             {
 467                 if ( p_sys->p_first_queue->i_songs_nb == 10 )
 468                 {
 469                     /* if there are more than one queue, delete the 1st */
 470                     p_first_queue = p_sys->p_first_queue->p_next_queue;
 471                     DeleteQueue( p_sys->p_first_queue );
 472                     free( p_sys->p_first_queue );
 473                     p_sys->p_first_queue = p_first_queue;
 474                 }
 475                 else
 476                 {
 477                     DeleteQueue( p_sys->p_first_queue );
 478                     p_sys->p_first_queue->i_songs_nb = 0;
 479                 }
 480                 msg_Dbg( p_this, "Submission successfull!" );
 481             }
 482             vlc_mutex_unlock ( &p_sys->lock );
 483         } /* data transmission finished or skipped */
 484
 485         msleep( INTF_IDLE_SLEEP );
 486
 487         p_playlist = pl_Yield( p_this );
 488         PL_LOCK;
 489         if( p_playlist->request.i_status == PLAYLIST_STOPPED )
 490         {
 491             /* if we stopped, we won't submit playing song */
 492             vlc_mutex_lock( &p_sys->lock );
 493             p_sys->b_queued = VLC_TRUE;
 494             p_sys->b_metadata_read = VLC_TRUE;
 495             vlc_mutex_unlock( &p_sys->lock );
 496         }
 497         PL_UNLOCK;
 498         pl_Release( p_playlist );
 499
 500         vlc_mutex_lock( &p_sys->lock );
 501         if( p_sys->b_metadata_read == VLC_FALSE )
 502         {
 503             /* we read the metadata of the playing song */
 504             time( &played_time );
 505             played_time -= p_sys->p_current_song->time_playing;
 506             played_time -= p_sys->time_total_pauses;
 507
 508             vlc_mutex_unlock( &p_sys->lock );
 509
 510             if( played_time > 20 )
 511             /* wait at least 20 secondes before reading the meta data
 512              * since the songs must be at least 30s */
 513             {
 514                 if ( ReadMetaData( p_this ) == VLC_ENOMEM )
 515                 {
 516                     MEM_ERROR
 517                 }
 518             }
 519         }
 520         else
 521         {
 522             /* we add the playing song into the queue */
 523             if( ( p_sys->b_queued == VLC_FALSE )
 524                 && ( p_sys->b_paused == VLC_FALSE ) )
 525             {
 526                 vlc_mutex_unlock( &p_sys->lock );
 527                 if( AddToQueue( p_this ) == VLC_ENOMEM )
 528                 {
 529                     MEM_ERROR
 530                 }
 531             }
 532             else
 533             {
 534                 vlc_mutex_unlock( &p_sys->lock );
 535             }
 536         }
 537     }
 538 #undef MEM_ERROR
 539 }
 540
 541 /*****************************************************************************
 542  * PlayingChange: Playing status change callback
 543  *****************************************************************************/
 544 static int PlayingChange( vlc_object_t *p_this, const char *psz_var,
 545                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 546 {
 547     intf_thread_t   *p_intf = ( intf_thread_t* ) p_data;
 548     intf_sys_t      *p_sys  = p_intf->p_sys;
 549
 550     (void)p_this; (void)psz_var; (void)oldval;
 551
 552     /* don't bother if song has already been queued */
 553     if( p_sys->b_queued == VLC_TRUE )
 554         return VLC_SUCCESS;
 555
 556     vlc_mutex_lock( &p_sys->lock );
 557
 558     if( newval.i_int == PAUSE_S )
 559     {
 560         time( &p_sys->time_pause );
 561         p_sys->b_paused = VLC_TRUE;
 562     }
 563
 564     else if( newval.i_int == PLAYING_S )
 565     {
 566         p_sys->time_total_pauses += time( NULL ) - p_sys->time_pause;
 567         p_sys->b_paused = VLC_FALSE;
 568     }
 569
 570     vlc_mutex_unlock( &p_sys->lock );
 571
 572     return VLC_SUCCESS;
 573 }
 574
 575 /*****************************************************************************
 576  * ItemChange: Playlist item change callback
 577  *****************************************************************************/
 578 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
 579                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 580 {
 581     playlist_t          *p_playlist;
 582     input_thread_t      *p_input    = NULL;
 583     time_t              epoch;
 584     struct tm           *epoch_tm;
 585     char                psz_date[20];
 586     intf_thread_t       *p_intf     = ( intf_thread_t* ) p_data;
 587     intf_sys_t          *p_sys      = p_intf->p_sys;
 588     (void)p_this; (void)psz_var; (void)oldval; (void)newval;
 589
 590     p_playlist = pl_Yield( p_intf );
 591     PL_LOCK;
 592     p_input = p_playlist->p_input;
 593
 594     if( !p_input )
 595     {
 596         PL_UNLOCK;
 597         pl_Release( p_playlist );
 598
 599         vlc_mutex_lock( &p_sys->lock );
 600
 601         p_sys->b_queued = VLC_TRUE;
 602         p_sys->b_metadata_read = VLC_TRUE;
 603
 604         vlc_mutex_unlock( &p_sys->lock );
 605
 606         return VLC_SUCCESS;
 607     }
 608
 609     vlc_object_yield( p_input );
 610     PL_UNLOCK;
 611     pl_Release( p_playlist );
 612
 613     var_AddCallback( p_input, "state", PlayingChange, p_intf );
 614
 615     vlc_mutex_lock ( &p_sys->lock );
 616
 617     /* reset pause counter */
 618     p_sys->time_total_pauses = 0;
 619
 620     /* we'll read metadata when it's present */
 621     p_sys->b_metadata_read = VLC_FALSE;
 622     p_sys->b_waiting_meta = VLC_FALSE;
 623
 624     time( &epoch );
 625     epoch_tm = gmtime( &epoch );
 626     snprintf( psz_date, 20, "%.4d-%.2d-%.2d %.2d:%.2d:%.2d",
 627         epoch_tm->tm_year+1900, epoch_tm->tm_mon+1, epoch_tm->tm_mday,
 628         epoch_tm->tm_hour, epoch_tm->tm_min, epoch_tm->tm_sec );
 629
 630     p_sys->p_current_song->psz_i = encode_URI_component( psz_date );
 631     p_sys->p_current_song->time_playing = epoch;
 632
 633     p_sys->b_paused = ( p_input->b_dead || !input_GetItem(p_input)->psz_name )
 634                       ? VLC_TRUE : VLC_FALSE;
 635
 636     vlc_mutex_unlock( &p_sys->lock );
 637
 638     vlc_object_release( p_input );
 639     return VLC_SUCCESS;
 640 }
 641
 642 /*****************************************************************************
 643  * AddToQueue: Add the played song to the queue to be submitted
 644  *****************************************************************************/
 645 static int AddToQueue ( intf_thread_t *p_this )
 646 {
 647     int                         i_songs_nb;
 648     time_t                      played_time;
 649     audioscrobbler_queue_t      *p_queue        = NULL,
 650                                 *p_next_queue   = NULL;
 651     intf_sys_t                  *p_sys          = p_this->p_sys;
 652
 653     /* wait for the user to listen enough before submitting */
 654     time ( &played_time );
 655     vlc_mutex_lock( &p_sys->lock );
 656
 657     played_time -= p_sys->p_current_song->time_playing;
 658     played_time -= p_sys->time_total_pauses;
 659
 660     #define NO_SUBMISSION \
 661         p_sys->b_queued = VLC_TRUE; \
 662         vlc_mutex_unlock( &p_sys->lock ); \
 663         return VLC_SUCCESS;
 664
 665     if( ( played_time < 240 ) &&
 666         ( played_time < ( p_sys->p_current_song->i_l / 2 ) ) )
 667     {
 668         //msg_Dbg( p_this, "Song not listened long enough -> waiting" );
 669         vlc_mutex_unlock( &p_sys->lock );
 670         return VLC_SUCCESS;
 671     }
 672
 673     if( p_sys->p_current_song->i_l < 30 )
 674     {
 675         msg_Dbg( p_this, "Song too short (< 30s) -> not submitting" );
 676         NO_SUBMISSION
 677     }
 678
 679     if( !*p_sys->p_current_song->psz_a || !*p_sys->p_current_song->psz_t )
 680     {
 681         msg_Dbg( p_this, "Missing artist or title -> not submitting" );
 682         NO_SUBMISSION
 683     }
 684
 685     msg_Dbg( p_this, "Ok. We'll put it in the queue for submission" );
 686
 687     /* go to last queue */
 688     p_queue = p_sys->p_first_queue;
 689     while( ( p_queue->i_songs_nb == 10 ) && ( p_queue->p_next_queue != NULL ) )
 690         p_queue = p_queue->p_next_queue;
 691
 692     i_songs_nb = p_queue->i_songs_nb;
 693
 694     #define MALLOC_CHECK( a ) \
 695         if( !a ) { \
 696             vlc_mutex_unlock( &p_sys->lock ); \
 697             return VLC_ENOMEM; \
 698         }
 699
 700     if( i_songs_nb == 10 )
 701     {
 702         p_next_queue = malloc( sizeof( audioscrobbler_queue_t ) );
 703         MALLOC_CHECK( p_next_queue );
 704         p_queue->p_next_queue = p_next_queue;
 705         p_queue = p_next_queue;
 706         i_songs_nb = 0;
 707         p_queue->i_songs_nb = i_songs_nb;
 708     }
 709
 710     p_queue->p_queue[i_songs_nb] = malloc( sizeof( audioscrobbler_song_t ) );
 711     MALLOC_CHECK( p_queue->p_queue[i_songs_nb] );
 712
 713     #define QUEUE_COPY( a ) \
 714         p_queue->p_queue[i_songs_nb]->a = p_sys->p_current_song->a
 715
 716     QUEUE_COPY(i_l);
 717     QUEUE_COPY(psz_a);
 718     QUEUE_COPY(psz_t);
 719     QUEUE_COPY(psz_b);
 720     QUEUE_COPY(psz_m);
 721     QUEUE_COPY(psz_i);
 722
 723     p_queue->i_songs_nb++;
 724     p_sys->b_queued = VLC_TRUE;
 725
 726     vlc_mutex_unlock( &p_sys->lock );
 727
 728     return VLC_SUCCESS;
 729 #undef QUEUE_COPY
 730 #undef MALLOC_CHECK
 731 #undef NO_SUBMISSION
 732 }
 733
 734 /*****************************************************************************
 735  * Handshake : Init audioscrobbler connection
 736  *****************************************************************************/
 737 static int Handshake( intf_thread_t *p_this )
 738 {
 739     char                *psz_password           = NULL;
 740     struct md5_s        *p_struct_md5           = NULL;
 741     char                *psz_password_md5       = NULL;
 742     char                *ps_challenge_md5       = NULL;
 743     stream_t            *p_stream;
 744     char                *psz_handshake_url      = NULL;
 745     uint8_t             *p_buffer               = NULL;
 746     char                *p_buffer_pos           = NULL;
 747     char                *psz_url_parser         = NULL;
 748     char                *psz_buffer_substring;
 749     int                 i_url_pos, i;
 750
 751     intf_thread_t       *p_intf                 = ( intf_thread_t* ) p_this;
 752     intf_sys_t          *p_sys                  = p_this->p_sys;
 753
 754     vlc_mutex_lock ( &p_sys->lock );
 755
 756     #define MEM_ERROR \
 757         free( p_buffer ); \
 758         free( p_struct_md5 ); \
 759         free( ps_challenge_md5 ); \
 760         vlc_mutex_unlock( &p_sys->lock ); \
 761         return VLC_ENOMEM;
 762
 763     #define PROTOCOL_ERROR \
 764         free( p_buffer ); \
 765         vlc_mutex_unlock( &p_sys->lock ); \
 766         return VLC_EGENERIC;
 767
 768     #define MALLOC_CHECK( a ) \
 769         if( !a ) \
 770         { \
 771             MEM_ERROR \
 772         }
 773
 774     p_sys->psz_username = config_GetPsz(p_this, "lastfm-username");
 775     MALLOC_CHECK( p_sys->psz_username )
 776
 777     /* username has not been setup, ignoring */
 778     if ( !*p_sys->psz_username )
 779         return VLC_ENOVAR;
 780
 781     psz_handshake_url = malloc( 1024 );
 782     MALLOC_CHECK( p_sys->psz_username )
 783
 784     snprintf( psz_handshake_url, 1024,
 785         "http://post.audioscrobbler.com/?hs=true&p=1.1&c=%s&v=%s&u=%s",
 786         CLIENT_NAME, CLIENT_VERSION, p_sys->psz_username );
 787
 788     /* send the http handshake request */
 789     p_stream = stream_UrlNew( p_intf, psz_handshake_url);
 790
 791     free( psz_handshake_url );
 792
 793     if( !p_stream )
 794     {
 795         vlc_mutex_unlock ( &p_sys->lock );
 796         return VLC_EGENERIC;
 797     }
 798
 799     p_buffer = ( uint8_t* ) calloc( 1, 1024 );
 800     if ( !p_buffer )
 801     {
 802         stream_Delete( p_stream );
 803         MEM_ERROR
 804     }
 805
 806     /* read answer */
 807     if ( stream_Read( p_stream, p_buffer, 1024 ) == 0 )
 808     {
 809         stream_Delete( p_stream );
 810         PROTOCOL_ERROR
 811     }
 812
 813     stream_Delete( p_stream );
 814
 815     /* record interval before next submission */
 816     p_buffer_pos = strstr( ( char* ) p_buffer, "INTERVAL" );
 817     if ( p_buffer_pos )
 818     {
 819         time( &p_sys->time_next_exchange );
 820         p_sys->time_next_exchange +=
 821                 atoi( p_buffer_pos + strlen( "INTERVAL " ) );
 822     }
 823
 824     p_buffer_pos = strstr( ( char* ) p_buffer, "FAILED" );
 825     if ( p_buffer_pos )
 826     {
 827         /* handshake request failed, sorry */
 828         msg_Dbg( p_this, "%s", p_buffer_pos );
 829         PROTOCOL_ERROR
 830     }
 831
 832     p_buffer_pos = strstr( ( char* ) p_buffer, "BADUSER" );
 833     if ( p_buffer_pos )
 834     {
 835         /* username does not exist on the server */
 836         intf_UserFatal( p_this, VLC_FALSE, _("Bad last.fm Username"),
 837             _("last.fm username is incorrect, please verify your settings")
 838         );
 839         PROTOCOL_ERROR
 840     }
 841
 842     p_buffer_pos = strstr( ( char* ) p_buffer, "UPDATE" );
 843     if ( p_buffer_pos )
 844     {
 845         /* protocol has been updated, time to update the code */
 846         msg_Dbg( p_intf, "Protocol updated : plugin may be outdated" );
 847         msg_Dbg( p_intf, "%s", p_buffer_pos );
 848     }
 849
 850     else
 851     {
 852         p_buffer_pos = strstr( ( char* ) p_buffer, "UPTODATE" );
 853         if ( !p_buffer_pos )
 854         {
 855             msg_Dbg( p_intf, "Can't recognize server protocol" );
 856             PROTOCOL_ERROR
 857         }
 858     }
 859
 860     psz_buffer_substring = strstr( p_buffer_pos, "\n" );
 861     if( ( psz_buffer_substring == NULL ) || \
 862             ( strlen( psz_buffer_substring + 1 ) < 32 ) )
 863     {
 864         msg_Dbg( p_intf, "Can't recognize server protocol" );
 865         PROTOCOL_ERROR
 866     }
 867     else
 868     {
 869         ps_challenge_md5 = malloc( 32 );
 870         MALLOC_CHECK( ps_challenge_md5 )
 871         memcpy( ps_challenge_md5, psz_buffer_substring + 1, 32 );
 872     }
 873
 874     p_buffer_pos = ( void* ) strstr( ( char* ) p_buffer, "http://" );
 875
 876     /* free old information */
 877     free( p_sys->psz_submit_host );
 878     free( p_sys->psz_submit_file );
 879
 880     psz_url_parser = p_buffer_pos + strlen( "http://" );
 881     i_url_pos = strcspn( psz_url_parser, ":" );
 882
 883     p_sys->psz_submit_host = strndup( psz_url_parser, i_url_pos );
 884     MALLOC_CHECK( p_sys->psz_submit_host )
 885
 886     p_sys->i_submit_port = atoi( psz_url_parser + i_url_pos + 1 );
 887
 888     psz_url_parser += strcspn( psz_url_parser , "/" ) + 1;
 889     i_url_pos = strcspn( psz_url_parser, "\n" );
 890     p_sys->psz_submit_file = strndup( psz_url_parser, i_url_pos );
 891     MALLOC_CHECK( p_sys->psz_submit_file )
 892
 893     free(p_buffer);
 894
 895     p_struct_md5 = malloc( sizeof( struct md5_s ) );
 896     MALLOC_CHECK( p_struct_md5 )
 897
 898     psz_password = config_GetPsz(p_this, "lastfm-password");
 899     MALLOC_CHECK( psz_password )
 900
 901     /* generates a md5 hash of the password */
 902     InitMD5( p_struct_md5 );
 903     AddMD5( p_struct_md5, ( uint8_t* ) psz_password, strlen( psz_password ) );
 904     EndMD5( p_struct_md5 );
 905
 906     free( psz_password );
 907
 908     psz_password_md5 = malloc ( 33 );
 909     MALLOC_CHECK( psz_password_md5 )
 910
 911     for ( i = 0; i < 4; i++ )
 912     {
 913         sprintf( &psz_password_md5[8*i], "%02x%02x%02x%02x",
 914             p_struct_md5->p_digest[i] & 0xff,
 915             ( p_struct_md5->p_digest[i] >> 8 ) & 0xff,
 916             ( p_struct_md5->p_digest[i] >> 16 ) & 0xff,
 917             p_struct_md5->p_digest[i] >> 24
 918         );
 919     }
 920
 921     /* generates a md5 hash of :
 922      * - md5 hash of the password, plus
 923      * - md5 challenge sent by last.fm server
 924      */
 925     InitMD5( p_struct_md5 );
 926     AddMD5( p_struct_md5, ( uint8_t* ) psz_password_md5, 32 );
 927     AddMD5( p_struct_md5, ( uint8_t* ) ps_challenge_md5, 32 );
 928     EndMD5( p_struct_md5 );
 929
 930     free( ps_challenge_md5 );
 931     free( psz_password_md5 );
 932
 933     for ( i = 0; i < 4; i++ )
 934     {
 935         sprintf( &p_sys->psz_response_md5[8*i], "%02x%02x%02x%02x",
 936             p_struct_md5->p_digest[i] & 0xff,
 937             ( p_struct_md5->p_digest[i] >> 8 ) & 0xff,
 938             ( p_struct_md5->p_digest[i] >> 16 ) & 0xff,
 939             p_struct_md5->p_digest[i] >> 24
 940         );
 941     }
 942
 943     p_sys->psz_response_md5[32] = '\0';
 944
 945     vlc_mutex_unlock ( &p_sys->lock );
 946
 947     return VLC_SUCCESS;
 948 #undef MEM_ERROR
 949 #undef PROTOCOL_ERROR
 950 #undef MALLOC_CHECK
 951 }
 952
 953 /*****************************************************************************
 954  * DeleteQueue : Free all songs from an audioscrobbler_queue_t
 955  *****************************************************************************/
 956 void DeleteQueue( audioscrobbler_queue_t *p_queue )
 957 {
 958     int     i;
 959
 960     for( i = 0; i < p_queue->i_songs_nb; i++ )
 961     {
 962         free( p_queue->p_queue[i]->psz_a );
 963         free( p_queue->p_queue[i]->psz_b );
 964         free( p_queue->p_queue[i]->psz_t );
 965         free( p_queue->p_queue[i]->psz_i );
 966         free( p_queue->p_queue[i] );
 967     }
 968 }
 969
 970 /*****************************************************************************
 971  * ReadMetaData : Read meta data when parsed by vlc
 972  * or wait for fetching if unavailable
 973  *****************************************************************************/
 974 static int ReadMetaData( intf_thread_t *p_this )
 975 {
 976     playlist_t          *p_playlist;
 977     input_thread_t      *p_input        = NULL;
 978     vlc_value_t         video_val;
 979
 980     char                *psz_title      = NULL;
 981     char                *psz_artist     = NULL;
 982     char                *psz_album      = NULL;
 983     char                *psz_trackid    = NULL;
 984     int                 i_length        = -1;
 985     vlc_bool_t          b_waiting;
 986     intf_sys_t          *p_sys          = p_this->p_sys;
 987     int                 i_status;
 988
 989     p_playlist = pl_Yield( p_this );
 990     PL_LOCK;
 991     p_input = p_playlist->p_input;
 992
 993     if( !p_input )
 994     {
 995         PL_UNLOCK;
 996         pl_Release( p_playlist );
 997         return( VLC_SUCCESS );
 998     }
 999
1000     vlc_object_yield( p_input );
1001     PL_UNLOCK;
1002     pl_Release( p_playlist );
1003
1004     var_Change( p_input, "video-es", VLC_VAR_CHOICESCOUNT, &video_val, NULL );
1005     if( ( video_val.i_int > 0 ) || \
1006         ( input_GetItem(p_input)->i_type == ITEM_TYPE_NET ) )
1007     {
1008         msg_Dbg( p_this, "Not an audio only local file -> no submission");
1009         vlc_object_release( p_input );
1010
1011         vlc_mutex_lock( &p_sys->lock );
1012         p_sys->b_queued = VLC_TRUE;
1013         p_sys->b_metadata_read = VLC_TRUE;
1014         vlc_mutex_unlock( &p_sys->lock );
1015
1016         return VLC_SUCCESS;
1017     }
1018
1019     #define FREE_INPUT_AND_CHARS \
1020         vlc_object_release( p_input ); \
1021         free( psz_title ); \
1022         free( psz_artist ); \
1023         free( psz_album ); \
1024         free( psz_trackid );
1025
1026     #define WAIT_METADATA_FETCHING( a ) \
1027         if ( b_waiting == VLC_TRUE ) \
1028         { \
1029             a = calloc( 1, 1 ); \
1030         } \
1031         else \
1032         { \
1033             vlc_object_release( p_input ); \
1034             vlc_mutex_lock( &p_sys->lock ); \
1035             p_sys->b_waiting_meta = VLC_TRUE; \
1036             vlc_mutex_unlock( &p_sys->lock ); \
1037             free( psz_artist ); \
1038             return VLC_SUCCESS; \
1039         }
1040
1041     #define ALLOC_ITEM_META( a, b ) \
1042         if ( input_item_Get##b( input_GetItem(p_input) ) ) \
1043         { \
1044             a = encode_URI_component( \
1045                 input_item_Get##b( input_GetItem(p_input) )); \
1046             if( !a ) \
1047             { \
1048                 FREE_INPUT_AND_CHARS \
1049                 return VLC_ENOMEM; \
1050             } \
1051         }
1052
1053     i_status = input_GetItem(p_input)->p_meta->i_status;
1054
1055     vlc_mutex_lock( &p_sys->lock );
1056     b_waiting = p_sys->b_waiting_meta;
1057     vlc_mutex_unlock( &p_sys->lock );
1058
1059     if( i_status & ( !b_waiting ? ITEM_PREPARSED : ITEM_META_FETCHED ) )
1060     {
1061         ALLOC_ITEM_META( psz_artist, Artist )
1062         else
1063         {
1064             msg_Dbg( p_this, "No artist.." );
1065             WAIT_METADATA_FETCHING( psz_artist )
1066         }
1067
1068         if( input_GetItem(p_input)->psz_name )
1069         {
1070             psz_title = encode_URI_component( input_GetItem(p_input)->psz_name );
1071             if( !psz_title )
1072             {
1073                 FREE_INPUT_AND_CHARS
1074                 return VLC_ENOMEM;
1075             }
1076         }
1077         else
1078         {
1079             msg_Dbg( p_this, "No track name.." );
1080             WAIT_METADATA_FETCHING( psz_title );
1081         }
1082
1083         ALLOC_ITEM_META( psz_album, Album )
1084         else
1085             psz_album = calloc( 1, 1 );
1086
1087         ALLOC_ITEM_META( psz_trackid, TrackID )
1088         else
1089             psz_trackid = calloc( 1, 1 );
1090
1091         i_length = input_GetItem(p_input)->i_duration / 1000000;
1092
1093         vlc_mutex_lock ( &p_sys->lock );
1094
1095         p_sys->p_current_song->psz_a    = strdup( psz_artist );
1096         p_sys->p_current_song->psz_t    = strdup( psz_title );
1097         p_sys->p_current_song->psz_b    = strdup( psz_album );
1098         p_sys->p_current_song->psz_m    = strdup( psz_trackid );
1099         p_sys->p_current_song->i_l      = i_length;
1100         p_sys->b_queued                 = VLC_FALSE;
1101         p_sys->b_metadata_read          = VLC_TRUE;
1102
1103         vlc_mutex_unlock( &p_sys->lock );
1104
1105         msg_Dbg( p_this, "Meta data registered, waiting to be queued" );
1106     }
1107
1108     FREE_INPUT_AND_CHARS
1109     return VLC_SUCCESS;
1110 #undef FREE_INPUT_AND_CHARS
1111 #undef ALLOC_ITEM_META
1112 #undef WAIT_METADATA_FETCHING
1113 }