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