audioscrobbler: read the metadata when it has been extracted.
[vlc.git] / 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]; /**< authentification 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\n");
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 an username or disable "
297                         "audioscrobbler plugin, and then restart VLC.\n"
298                         "Visit https://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, "Authentification 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 successfull!" );
437         }
438         else
439         {
440             msg_Dbg( p_intf, "Authentification 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 != INIT_S )
463         ReadMetaData( p_intf );
464
465     if( newval.i_int == END_S || newval.i_int == ERROR_S )
466     {
467         playlist_t *p_playlist = pl_Yield( p_intf );
468         PL_LOCK;
469         if( p_playlist->request.i_status == PLAYLIST_STOPPED )
470         {
471             /* if we stopped, we won't submit playing song */
472             p_sys->b_submit = VLC_FALSE;
473         }
474         PL_UNLOCK;
475         pl_Release( p_playlist );
476     }
477     else if( oldval.i_int == PLAYING_S && newval.i_int == PAUSE_S )
478         time( &p_sys->time_pause );
479     else if( oldval.i_int == PAUSE_S && newval.i_int == PLAYING_S )
480         p_sys->time_total_pauses += time( NULL ) - p_sys->time_pause;
481
482     return VLC_SUCCESS;
483 }
484
485 /*****************************************************************************
486  * ItemChange: Playlist item change callback
487  *****************************************************************************/
488 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
489                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
490 {
491     playlist_t          *p_playlist;
492     input_thread_t      *p_input;
493     intf_thread_t       *p_intf     = ( intf_thread_t* ) p_data;
494     intf_sys_t          *p_sys      = p_intf->p_sys;
495     input_item_t        *p_item;
496     vlc_value_t         video_val;
497
498     VLC_UNUSED( p_this ); VLC_UNUSED( psz_var );
499     VLC_UNUSED( oldval ); VLC_UNUSED( newval );
500
501     if( p_intf->b_dead )
502         return VLC_SUCCESS;
503
504     p_sys->b_state_cb       = VLC_FALSE;
505     p_sys->b_meta_read      = VLC_FALSE;
506
507     /* We'll try to add the previously playing song in the queue */
508     if( AddToQueue( p_intf ) == VLC_ENOMEM )
509         return VLC_ENOMEM;
510
511     p_playlist = pl_Yield( p_intf );
512     PL_LOCK;
513     p_input = p_playlist->p_input;
514
515     if( !p_input || p_input->b_dead )
516     {
517         PL_UNLOCK;
518         pl_Release( p_playlist );
519         p_sys->b_submit = VLC_FALSE;
520         return VLC_SUCCESS;
521     }
522
523     vlc_object_yield( p_input );
524     PL_UNLOCK;
525     pl_Release( p_playlist );
526
527     p_item = input_GetItem( p_input );
528     if( !p_item )
529     {
530         vlc_object_release( p_input );
531         p_sys->b_submit = VLC_FALSE;
532         return VLC_SUCCESS;
533     }
534
535     var_Change( p_input, "video-es", VLC_VAR_CHOICESCOUNT, &video_val, NULL );
536     if( ( video_val.i_int > 0 ) || p_item->i_type == ITEM_TYPE_NET )
537     {
538         msg_Dbg( p_this, "Not an audio local file, not submitting");
539         vlc_object_release( p_input );
540         p_sys->b_submit = VLC_FALSE;
541         return VLC_SUCCESS;
542     }
543
544     p_sys->b_submit = VLC_TRUE;
545     p_sys->time_total_pauses = 0;
546     time( &p_sys->p_current_song.date );
547
548     var_AddCallback( p_input, "state", PlayingChange, p_intf );
549     p_sys->b_state_cb = VLC_TRUE;
550
551     if( input_item_IsPreparsed( p_item ) )
552         ReadMetaData( p_intf );
553     /* if the input item was not preparsed, we'll do it in PlayingChange()
554      * callback, when "state" != INIT_S */
555
556     vlc_object_release( p_input );
557     return VLC_SUCCESS;
558 }
559
560 /*****************************************************************************
561  * AddToQueue: Add the played song to the queue to be submitted
562  *****************************************************************************/
563 static int AddToQueue ( intf_thread_t *p_this )
564 {
565     time_t                      played_time;
566     intf_sys_t                  *p_sys = p_this->p_sys;
567
568     vlc_mutex_lock( &p_sys->lock );
569     if( !p_sys->b_submit )
570     {
571         DeleteSong( &p_sys->p_current_song );
572         vlc_mutex_unlock( &p_sys->lock );
573         return VLC_SUCCESS;
574     }
575
576     /* wait for the user to listen enough before submitting */
577     time ( &played_time );
578     played_time -= p_sys->p_current_song.date;
579     played_time -= p_sys->time_total_pauses;
580     if( ( played_time < 240 ) &&
581         ( played_time < ( p_sys->p_current_song.i_l / 2 ) ) )
582     {
583         msg_Dbg( p_this, "Song not listened long enough, not submitting" );
584         DeleteSong( &p_sys->p_current_song );
585         vlc_mutex_unlock( &p_sys->lock );
586         return VLC_SUCCESS;
587     }
588
589     if( p_sys->p_current_song.i_l < 30 )
590     {
591         msg_Dbg( p_this, "Song too short (< 30s), not submitting" );
592         DeleteSong( &p_sys->p_current_song );
593         vlc_mutex_unlock( &p_sys->lock );
594         return VLC_SUCCESS;
595     }
596
597     if( !p_sys->p_current_song.psz_a || !*p_sys->p_current_song.psz_a ||
598         !p_sys->p_current_song.psz_t || !*p_sys->p_current_song.psz_t )
599     {
600         msg_Dbg( p_this, "Missing artist or title, not submitting" );
601         DeleteSong( &p_sys->p_current_song );
602         vlc_mutex_unlock( &p_sys->lock );
603         return VLC_SUCCESS;
604     }
605
606     if( p_sys->i_songs == 50 )
607     {
608         msg_Warn( p_this, "Submission queue is full, not submitting" );
609         DeleteSong( &p_sys->p_current_song );
610         vlc_mutex_unlock( &p_sys->lock );
611         return VLC_SUCCESS;
612     }
613
614     msg_Dbg( p_this, "Song will be submitted." );
615
616 #define QUEUE_COPY( a ) \
617     p_sys->p_queue[p_sys->i_songs].a = p_sys->p_current_song.a
618
619 #define QUEUE_COPY_NULL( a ) \
620     QUEUE_COPY( a ); \
621     p_sys->p_current_song.a = NULL
622
623     QUEUE_COPY( i_l );
624     QUEUE_COPY_NULL( psz_n );
625     QUEUE_COPY_NULL( psz_a );
626     QUEUE_COPY_NULL( psz_t );
627     QUEUE_COPY_NULL( psz_b );
628     QUEUE_COPY_NULL( psz_m );
629     QUEUE_COPY( date );
630 #undef QUEUE_COPY_NULL
631 #undef QUEUE_COPY
632
633     p_sys->i_songs++;
634
635     /* signal the main loop we have something to submit */
636     vlc_object_lock( p_this );
637     vlc_cond_signal( &p_this->object_wait );
638     vlc_object_unlock( p_this );
639
640     vlc_mutex_unlock( &p_sys->lock );
641     return VLC_SUCCESS;
642 }
643
644 /*****************************************************************************
645  * ParseURL : Split an http:// URL into host, file, and port
646  *
647  * Example: "62.216.251.205:80/protocol_1.2"
648  *      will be split into "62.216.251.205", 80, "protocol_1.2"
649  *
650  * psz_url will be freed before returning
651  * *psz_file & *psz_host will be freed before use
652  *
653  * Return value:
654  *  VLC_ENOMEM      Out Of Memory
655  *  VLC_EGENERIC    Invalid url provided
656  *  VLC_SUCCESS     Success
657  *****************************************************************************/
658 static int ParseURL( char *psz_url, char **psz_host, char **psz_file,
659                         int *i_port )
660 {
661     int i_pos;
662     int i_len = strlen( psz_url );
663     FREENULL( *psz_host );
664     FREENULL( *psz_file );
665
666     i_pos = strcspn( psz_url, ":" );
667     if( i_pos == i_len )
668         return VLC_EGENERIC;
669
670     *psz_host = strndup( psz_url, i_pos );
671     if( !*psz_host )
672         return VLC_ENOMEM;
673
674     i_pos++; /* skip the ':' */
675     *i_port = atoi( psz_url + i_pos );
676     if( *i_port <= 0 )
677     {
678         FREENULL( *psz_host );
679         return VLC_EGENERIC;
680     }
681
682     i_pos = strcspn( psz_url, "/" );
683
684     if( i_pos == i_len )
685         return VLC_EGENERIC;
686
687     i_pos++; /* skip the '/' */
688     *psz_file = strdup( psz_url + i_pos );
689     if( !*psz_file )
690     {
691         FREENULL( *psz_host );
692         return VLC_ENOMEM;
693     }
694
695     free( psz_url );
696     return VLC_SUCCESS;
697 }
698
699 /*****************************************************************************
700  * Handshake : Init audioscrobbler connection
701  *****************************************************************************/
702 static int Handshake( intf_thread_t *p_this )
703 {
704     char                *psz_username, *psz_password;
705     time_t              timestamp;
706     char                psz_timestamp[33];
707
708     struct md5_s        p_struct_md5;
709     char                psz_password_md5[33];
710
711     stream_t            *p_stream;
712     char                *psz_handshake_url;
713     uint8_t             p_buffer[1024];
714     char                *p_buffer_pos;
715
716     int                 i_ret;
717     char                *psz_url;
718
719     intf_thread_t       *p_intf                 = ( intf_thread_t* ) p_this;
720     intf_sys_t          *p_sys                  = p_this->p_sys;
721
722     psz_username = config_GetPsz( p_this, "lastfm-username" );
723     if( !psz_username )
724         return VLC_ENOMEM;
725
726     psz_password = config_GetPsz( p_this, "lastfm-password" );
727     if( !psz_password )
728     {
729         free( psz_username );
730         return VLC_ENOMEM;
731     }
732
733     /* username or password have not been setup */
734     if ( !*psz_username || !*psz_password )
735     {
736         free( psz_username );
737         free( psz_password );
738         return VLC_ENOVAR;
739     }
740
741     time( &timestamp );
742
743     /* generates a md5 hash of the password */
744     InitMD5( &p_struct_md5 );
745     AddMD5( &p_struct_md5, ( uint8_t* ) psz_password, strlen( psz_password ) );
746     EndMD5( &p_struct_md5 );
747
748     free( psz_password );
749
750     int i;
751     for ( i = 0; i < 4; i++ )
752     {
753         sprintf( &psz_password_md5[8*i], "%02x%02x%02x%02x",
754             p_struct_md5.p_digest[i] & 0xff,
755             ( p_struct_md5.p_digest[i] >> 8 ) & 0xff,
756             ( p_struct_md5.p_digest[i] >> 16 ) & 0xff,
757             p_struct_md5.p_digest[i] >> 24
758         );
759     }
760
761     snprintf( psz_timestamp, 33, "%llu", (uintmax_t)timestamp );
762
763     /* generates a md5 hash of :
764      * - md5 hash of the password, plus
765      * - timestamp in clear text
766      */
767     InitMD5( &p_struct_md5 );
768     AddMD5( &p_struct_md5, ( uint8_t* ) psz_password_md5, 32 );
769     AddMD5( &p_struct_md5, ( uint8_t* ) psz_timestamp, strlen( psz_timestamp ));
770     EndMD5( &p_struct_md5 );
771
772     for ( i = 0; i < 4; i++ )
773     {
774         sprintf( &p_sys->psz_auth_token[8*i], "%02x%02x%02x%02x",
775             p_struct_md5.p_digest[i] & 0xff,
776             ( p_struct_md5.p_digest[i] >> 8 ) & 0xff,
777             ( p_struct_md5.p_digest[i] >> 16 ) & 0xff,
778             p_struct_md5.p_digest[i] >> 24
779         );
780     }
781
782     p_sys->psz_auth_token[32] = '\0';
783
784     if( !asprintf( &psz_handshake_url,
785     "http://post.audioscrobbler.com/?hs=true&p=1.2&c=%s&v=%s&u=%s&t=%s&a=%s",
786         CLIENT_NAME, CLIENT_VERSION, psz_username, psz_timestamp,
787         p_sys->psz_auth_token ) )
788     {
789         free( psz_username );
790         return VLC_ENOMEM;
791     }
792     free( psz_username );
793
794     /* send the http handshake request */
795     p_stream = stream_UrlNew( p_intf, psz_handshake_url );
796     free( psz_handshake_url );
797
798     if( !p_stream )
799         return VLC_EGENERIC;
800
801     /* read answer */
802     i_ret = stream_Read( p_stream, p_buffer, 1023 );
803     if( i_ret == 0 )
804     {
805         stream_Delete( p_stream );
806         return VLC_EGENERIC;
807     }
808     p_buffer[i_ret] = '\0';
809     stream_Delete( p_stream );
810
811     p_buffer_pos = strstr( ( char* ) p_buffer, "FAILED " );
812     if ( p_buffer_pos )
813     {
814         /* handshake request failed, sorry */
815         msg_Warn( p_this, "last.fm handshake failed: %s", p_buffer_pos + 7 );
816         return VLC_EGENERIC;
817     }
818
819     p_buffer_pos = strstr( ( char* ) p_buffer, "BADAUTH" );
820     if ( p_buffer_pos )
821     {
822         /* authentication failed, bad username/password combination */
823         intf_UserFatal( p_this, VLC_FALSE,
824             _("last.fm: Authentication failed"),
825             _("last.fm Username or Password is incorrect,"
826               " please verify your settings and relaunch VLC." ) );
827         return VLC_AUDIOSCROBBLER_EFATAL;
828     }
829
830     p_buffer_pos = strstr( ( char* ) p_buffer, "BANNED" );
831     if ( p_buffer_pos )
832     {
833         /* oops, our version of vlc has been banned by last.fm servers */
834         msg_Err( p_intf, "This version of VLC has been banned by last.fm. "
835                          "You should upgrade VLC, or disable last.fm plugin." );
836         return VLC_AUDIOSCROBBLER_EFATAL;
837     }
838
839     p_buffer_pos = strstr( ( char* ) p_buffer, "BADTIME" );
840     if ( p_buffer_pos )
841     {
842         /* The system clock isn't good */
843         msg_Err( p_intf, "last.fm handshake failed because your clock is too "
844                          "much shifted. Please correct it, and relaunch VLC." );
845         return VLC_AUDIOSCROBBLER_EFATAL;
846     }
847
848     p_buffer_pos = strstr( ( char* ) p_buffer, "OK" );
849     if ( !p_buffer_pos )
850         goto proto;
851
852     p_buffer_pos = strstr( p_buffer_pos, "\n" );
853     if( !p_buffer_pos || strlen( p_buffer_pos ) < 34 )
854         goto proto;
855     p_buffer_pos++; /* we skip the '\n' */
856
857     /* save the session ID */
858     snprintf( &p_sys->psz_auth_token[0], 33, "%s", p_buffer_pos );
859
860     p_buffer_pos = strstr( p_buffer_pos, "http://" );
861     if( !p_buffer_pos || strlen( p_buffer_pos ) == 7 )
862         goto proto;
863
864     /* We need to read the nowplaying url */
865     p_buffer_pos += 7; /* we skip "http://" */
866 #if 0 //NOT USED
867     psz_url = strndup( p_buffer_pos, strcspn( p_buffer_pos, "\n" ) );
868     if( !psz_url )
869         goto oom;
870
871     switch( ParseURL( psz_url, &p_sys->psz_nowp_host,
872                 &p_sys->psz_nowp_file, &p_sys->i_nowp_port ) )
873     {
874         case VLC_ENOMEM:
875             goto oom;
876         case VLC_EGENERIC:
877             goto proto;
878         case VLC_SUCCESS:
879         default:
880             break;
881     }
882 #endif
883     p_buffer_pos = strstr( p_buffer_pos, "http://" );
884     if( !p_buffer_pos || strlen( p_buffer_pos ) == 7 )
885         goto proto;
886
887     /* We need to read the submission url */
888     p_buffer_pos += 7; /* we skip "http://" */
889     psz_url = strndup( p_buffer_pos, strcspn( p_buffer_pos, "\n" ) );
890     if( !psz_url )
891         goto oom;
892
893     switch( ParseURL( psz_url, &p_sys->psz_submit_host,
894                 &p_sys->psz_submit_file, &p_sys->i_submit_port ) )
895     {
896         case VLC_ENOMEM:
897             goto oom;
898         case VLC_EGENERIC:
899             goto proto;
900         case VLC_SUCCESS:
901         default:
902             break;
903     }
904
905     return VLC_SUCCESS;
906
907 oom:
908     return VLC_ENOMEM;
909
910 proto:
911     msg_Warn( p_intf, "Handshake: can't recognize server protocol" );
912     return VLC_EGENERIC;
913 }
914
915 /*****************************************************************************
916  * DeleteSong : Delete the char pointers in a song
917  *****************************************************************************/
918 static void DeleteSong( audioscrobbler_song_t* p_song )
919 {
920     FREENULL( p_song->psz_a );
921     FREENULL( p_song->psz_b );
922     FREENULL( p_song->psz_t );
923     FREENULL( p_song->psz_m );
924     FREENULL( p_song->psz_n );
925 }
926
927 /*****************************************************************************
928  * ReadMetaData : Read meta data when parsed by vlc
929  *****************************************************************************/
930 static int ReadMetaData( intf_thread_t *p_this )
931 {
932     playlist_t          *p_playlist;
933     input_thread_t      *p_input;
934     input_item_t        *p_item;
935
936     intf_sys_t          *p_sys = p_this->p_sys;
937
938     p_playlist = pl_Yield( p_this );
939     PL_LOCK;
940     p_input = p_playlist->p_input;
941     if( !p_input )
942     {
943         PL_UNLOCK;
944         pl_Release( p_playlist );
945         return( VLC_SUCCESS );
946     }
947
948     vlc_object_yield( p_input );
949     PL_UNLOCK;
950     pl_Release( p_playlist );
951
952     p_item = input_GetItem( p_input );
953     if( !p_item )
954         return VLC_SUCCESS;
955
956     char *psz_meta;
957 #define ALLOC_ITEM_META( a, b ) \
958     psz_meta = input_item_Get##b( p_item ); \
959     if( psz_meta && *psz_meta ) \
960     { \
961         a = encode_URI_component( psz_meta ); \
962         if( !a ) \
963         { \
964             free( psz_meta ); \
965             return VLC_ENOMEM; \
966         } \
967         free( psz_meta ); \
968     }
969
970     vlc_mutex_lock( &p_sys->lock );
971
972     p_sys->b_meta_read = VLC_TRUE;
973
974     ALLOC_ITEM_META( p_sys->p_current_song.psz_a, Artist )
975     else
976     {
977         vlc_mutex_unlock( &p_sys->lock );
978         msg_Dbg( p_this, "No artist.." );
979         vlc_object_release( p_input );
980         free( psz_meta );
981         return VLC_EGENERIC;
982     }
983
984     ALLOC_ITEM_META( p_sys->p_current_song.psz_t, Title )
985     else
986     {
987         vlc_mutex_unlock( &p_sys->lock );
988         msg_Dbg( p_this, "No track name.." );
989         vlc_object_release( p_input );
990         free( p_sys->p_current_song.psz_a );
991         free( psz_meta );
992         return VLC_EGENERIC;
993     }
994
995     ALLOC_ITEM_META( p_sys->p_current_song.psz_b, Album )
996     else
997         p_sys->p_current_song.psz_b = calloc( 1, 1 );
998
999     ALLOC_ITEM_META( p_sys->p_current_song.psz_m, TrackID )
1000     else
1001         p_sys->p_current_song.psz_m = calloc( 1, 1 );
1002
1003     p_sys->p_current_song.i_l = input_item_GetDuration( p_item ) / 1000000;
1004
1005     ALLOC_ITEM_META( p_sys->p_current_song.psz_n, TrackNum )
1006     else
1007         p_sys->p_current_song.psz_n = calloc( 1, 1 );
1008 #undef ALLOC_ITEM_META
1009
1010     msg_Dbg( p_this, "Meta data registered" );
1011
1012     vlc_mutex_unlock( &p_sys->lock );
1013     vlc_object_release( p_input );
1014     return VLC_SUCCESS;
1015
1016 }
1017
1018 static void HandleInterval( time_t *next, unsigned int *i_interval )
1019 {
1020     if( *i_interval == 0 )
1021     {
1022         /* first interval is 1 minute */
1023         *i_interval = 60;
1024     }
1025     else
1026     {
1027         /* else we double the previous interval, up to 120 minutes */
1028         *i_interval = *i_interval * 2;
1029         if( *i_interval > 60*120 )
1030             *i_interval = 60*120;
1031     }
1032     *next = time( NULL ) + *i_interval;
1033 }
1034