Commit 28f90a27 authored by Rafaël Carré's avatar Rafaël Carré

audioscrobbler: clean up

- cosmetics ( xx ) -> (xx) (look at patch with -w)
- remove useless header inclusion
- move some variables from p_sys to Run() function scope
- fix invalid asprintf() return value checks
...
parent 58267d2b
/*****************************************************************************
* audioscrobbler.c : audioscrobbler submission plugin
*****************************************************************************
* Copyright © 2006-2009 the VideoLAN team
* Copyright © 2006-2011 the VideoLAN team
* $Id$
*
* Author: Rafaël Carré <funman at videolanorg>
......@@ -32,10 +32,6 @@
* Preamble
*****************************************************************************/
#if defined( WIN32 )
#include <time.h>
#endif
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
......@@ -78,10 +74,6 @@ struct intf_sys_t
vlc_mutex_t lock; /**< p_sys mutex */
vlc_cond_t wait; /**< song to submit event */
/* data about audioscrobbler session */
mtime_t next_exchange; /**< when can we send data */
unsigned int i_interval; /**< waiting interval (secs)*/
/* submission of played songs */
char *psz_submit_host; /**< where to submit data */
int i_submit_port; /**< port to which submit */
......@@ -93,7 +85,6 @@ struct intf_sys_t
int i_nowp_port; /**< port to which submit */
char *psz_nowp_file; /**< file to which submit */
#endif
bool b_handshaked; /**< are we authenticated ? */
char psz_auth_token[33]; /**< Authentication token */
/* data about song currently playing */
......@@ -111,9 +102,9 @@ struct intf_sys_t
* metadata already */
};
static int Open ( vlc_object_t * );
static void Close ( vlc_object_t * );
static void Run ( intf_thread_t * );
static int Open (vlc_object_t *);
static void Close (vlc_object_t *);
static void Run (intf_thread_t *);
/*****************************************************************************
* Module descriptor
......@@ -133,128 +124,116 @@ static void Run ( intf_thread_t * );
#define CLIENT_NAME PACKAGE
#define CLIENT_VERSION VERSION
/* HTTP POST request : to submit data */
#define POST_REQUEST "POST /%s HTTP/1.1\n" \
"Accept-Encoding: identity\n" \
"Content-length: %u\n" \
"Connection: close\n" \
"Content-type: application/x-www-form-urlencoded\n" \
"Host: %s\n" \
"User-agent: VLC media player/%s\r\n" \
"\r\n" \
"%s\r\n" \
"\r\n"
vlc_module_begin ()
set_category( CAT_INTERFACE )
set_subcategory( SUBCAT_INTERFACE_CONTROL )
set_shortname( N_( "Audioscrobbler" ) )
set_description( N_("Submission of played songs to last.fm") )
add_string( "lastfm-username", "",
USERNAME_TEXT, USERNAME_LONGTEXT, false )
add_password( "lastfm-password", "",
PASSWORD_TEXT, PASSWORD_LONGTEXT, false )
add_string( "scrobbler-url", "post.audioscrobbler.com",
URL_TEXT, URL_LONGTEXT, false )
set_capability( "interface", 0 )
set_callbacks( Open, Close )
set_category(CAT_INTERFACE)
set_subcategory(SUBCAT_INTERFACE_CONTROL)
set_shortname(N_("Audioscrobbler"))
set_description(N_("Submission of played songs to last.fm"))
add_string("lastfm-username", "",
USERNAME_TEXT, USERNAME_LONGTEXT, false)
add_password("lastfm-password", "",
PASSWORD_TEXT, PASSWORD_LONGTEXT, false)
add_string("scrobbler-url", "post.audioscrobbler.com",
URL_TEXT, URL_LONGTEXT, false)
set_capability("interface", 0)
set_callbacks(Open, Close)
vlc_module_end ()
/*****************************************************************************
* DeleteSong : Delete the char pointers in a song
*****************************************************************************/
static void DeleteSong( audioscrobbler_song_t* p_song )
static void DeleteSong(audioscrobbler_song_t* p_song)
{
FREENULL( p_song->psz_a );
FREENULL( p_song->psz_b );
FREENULL( p_song->psz_t );
FREENULL( p_song->psz_m );
FREENULL( p_song->psz_n );
FREENULL(p_song->psz_a);
FREENULL(p_song->psz_b);
FREENULL(p_song->psz_t);
FREENULL(p_song->psz_m);
FREENULL(p_song->psz_n);
}
/*****************************************************************************
* ReadMetaData : Read meta data when parsed by vlc
*****************************************************************************/
static void ReadMetaData( intf_thread_t *p_this )
static void ReadMetaData(intf_thread_t *p_this)
{
input_thread_t *p_input;
input_item_t *p_item;
intf_sys_t *p_sys = p_this->p_sys;
p_input = playlist_CurrentInput( pl_Get( p_this ) );
if( !p_input )
p_input = playlist_CurrentInput(pl_Get(p_this));
if (!p_input)
return;
p_item = input_GetItem( p_input );
if( !p_item )
p_item = input_GetItem(p_input);
if (!p_item)
{
vlc_object_release( p_input );
vlc_object_release(p_input);
return;
}
#define ALLOC_ITEM_META( a, b ) do { \
char *psz_meta = input_item_Get##b( p_item ); \
if( psz_meta && *psz_meta ) \
a = encode_URI_component( psz_meta ); \
free( psz_meta ); \
} while(0)
#define ALLOC_ITEM_META(a, b) do { \
char *psz_meta = input_item_Get##b(p_item); \
if (psz_meta && *psz_meta) \
a = encode_URI_component(psz_meta); \
free(psz_meta); \
} while (0)
vlc_mutex_lock( &p_sys->lock );
vlc_mutex_lock(&p_sys->lock);
p_sys->b_meta_read = true;
ALLOC_ITEM_META( p_sys->p_current_song.psz_a, Artist );
if( !p_sys->p_current_song.psz_a )
ALLOC_ITEM_META(p_sys->p_current_song.psz_a, Artist);
if (!p_sys->p_current_song.psz_a)
{
msg_Dbg( p_this, "No artist.." );
DeleteSong( &p_sys->p_current_song );
msg_Dbg(p_this, "No artist..");
DeleteSong(&p_sys->p_current_song);
goto end;
}
ALLOC_ITEM_META( p_sys->p_current_song.psz_t, Title );
if( !p_sys->p_current_song.psz_t )
ALLOC_ITEM_META(p_sys->p_current_song.psz_t, Title);
if (!p_sys->p_current_song.psz_t)
{
msg_Dbg( p_this, "No track name.." );
DeleteSong( &p_sys->p_current_song );
msg_Dbg(p_this, "No track name..");
DeleteSong(&p_sys->p_current_song);
goto end;
}
/* Now we have read the mandatory meta data, so we can submit that info */
p_sys->b_submit = true;
ALLOC_ITEM_META( p_sys->p_current_song.psz_b, Album );
if( !p_sys->p_current_song.psz_b )
p_sys->p_current_song.psz_b = calloc( 1, 1 );
ALLOC_ITEM_META(p_sys->p_current_song.psz_b, Album);
if (!p_sys->p_current_song.psz_b)
p_sys->p_current_song.psz_b = calloc(1, 1);
ALLOC_ITEM_META( p_sys->p_current_song.psz_m, TrackID );
if( !p_sys->p_current_song.psz_m )
p_sys->p_current_song.psz_m = calloc( 1, 1 );
ALLOC_ITEM_META(p_sys->p_current_song.psz_m, TrackID);
if (!p_sys->p_current_song.psz_m)
p_sys->p_current_song.psz_m = calloc(1, 1);
p_sys->p_current_song.i_l = input_item_GetDuration( p_item ) / 1000000;
p_sys->p_current_song.i_l = input_item_GetDuration(p_item) / 1000000;
ALLOC_ITEM_META( p_sys->p_current_song.psz_n, TrackNum );
if( !p_sys->p_current_song.psz_n )
p_sys->p_current_song.psz_n = calloc( 1, 1 );
ALLOC_ITEM_META(p_sys->p_current_song.psz_n, TrackNum);
if (!p_sys->p_current_song.psz_n)
p_sys->p_current_song.psz_n = calloc(1, 1);
#undef ALLOC_ITEM_META
msg_Dbg( p_this, "Meta data registered" );
msg_Dbg(p_this, "Meta data registered");
end:
vlc_mutex_unlock( &p_sys->lock );
vlc_object_release( p_input );
vlc_mutex_unlock(&p_sys->lock);
vlc_object_release(p_input);
}
/*****************************************************************************
* AddToQueue: Add the played song to the queue to be submitted
*****************************************************************************/
static void AddToQueue ( intf_thread_t *p_this )
static void AddToQueue (intf_thread_t *p_this)
{
mtime_t played_time;
intf_sys_t *p_sys = p_this->p_sys;
vlc_mutex_lock( &p_sys->lock );
if( !p_sys->b_submit )
vlc_mutex_lock(&p_sys->lock);
if (!p_sys->b_submit)
goto end;
/* wait for the user to listen enough before submitting */
......@@ -264,110 +243,107 @@ static void AddToQueue ( intf_thread_t *p_this )
/*HACK: it seam that the preparsing sometime fail,
so use the playing time as the song length */
if( p_sys->p_current_song.i_l == 0 )
if (p_sys->p_current_song.i_l == 0)
p_sys->p_current_song.i_l = played_time;
/* Don't send song shorter than 30s */
if( p_sys->p_current_song.i_l < 30 )
if (p_sys->p_current_song.i_l < 30)
{
msg_Dbg( p_this, "Song too short (< 30s), not submitting" );
msg_Dbg(p_this, "Song too short (< 30s), not submitting");
goto end;
}
/* Send if the user had listen more than 240s OR half the track length */
if( ( played_time < 240 ) &&
( played_time < ( p_sys->p_current_song.i_l / 2 ) ) )
if ((played_time < 240) &&
(played_time < (p_sys->p_current_song.i_l / 2)))
{
msg_Dbg( p_this, "Song not listened long enough, not submitting" );
msg_Dbg(p_this, "Song not listened long enough, not submitting");
goto end;
}
/* Check that all meta are present */
if( !p_sys->p_current_song.psz_a || !*p_sys->p_current_song.psz_a ||
!p_sys->p_current_song.psz_t || !*p_sys->p_current_song.psz_t )
if (!p_sys->p_current_song.psz_a || !*p_sys->p_current_song.psz_a ||
!p_sys->p_current_song.psz_t || !*p_sys->p_current_song.psz_t)
{
msg_Dbg( p_this, "Missing artist or title, not submitting" );
msg_Dbg(p_this, "Missing artist or title, not submitting");
goto end;
}
if( p_sys->i_songs >= QUEUE_MAX )
if (p_sys->i_songs >= QUEUE_MAX)
{
msg_Warn( p_this, "Submission queue is full, not submitting" );
msg_Warn(p_this, "Submission queue is full, not submitting");
goto end;
}
msg_Dbg( p_this, "Song will be submitted." );
msg_Dbg(p_this, "Song will be submitted.");
#define QUEUE_COPY( a ) \
#define QUEUE_COPY(a) \
p_sys->p_queue[p_sys->i_songs].a = p_sys->p_current_song.a
#define QUEUE_COPY_NULL( a ) \
QUEUE_COPY( a ); \
#define QUEUE_COPY_NULL(a) \
QUEUE_COPY(a); \
p_sys->p_current_song.a = NULL
QUEUE_COPY( i_l );
QUEUE_COPY_NULL( psz_n );
QUEUE_COPY_NULL( psz_a );
QUEUE_COPY_NULL( psz_t );
QUEUE_COPY_NULL( psz_b );
QUEUE_COPY_NULL( psz_m );
QUEUE_COPY( date );
QUEUE_COPY(i_l);
QUEUE_COPY_NULL(psz_n);
QUEUE_COPY_NULL(psz_a);
QUEUE_COPY_NULL(psz_t);
QUEUE_COPY_NULL(psz_b);
QUEUE_COPY_NULL(psz_m);
QUEUE_COPY(date);
#undef QUEUE_COPY_NULL
#undef QUEUE_COPY
p_sys->i_songs++;
/* signal the main loop we have something to submit */
vlc_cond_signal( &p_sys->wait );
vlc_cond_signal(&p_sys->wait);
end:
DeleteSong( &p_sys->p_current_song );
DeleteSong(&p_sys->p_current_song);
p_sys->b_submit = false;
vlc_mutex_unlock( &p_sys->lock );
vlc_mutex_unlock(&p_sys->lock);
}
/*****************************************************************************
* PlayingChange: Playing status change callback
*****************************************************************************/
static int PlayingChange( vlc_object_t *p_this, const char *psz_var,
vlc_value_t oldval, vlc_value_t newval, void *p_data )
static int PlayingChange(vlc_object_t *p_this, const char *psz_var,
vlc_value_t oldval, vlc_value_t newval, void *p_data)
{
VLC_UNUSED( oldval );
VLC_UNUSED(oldval);
intf_thread_t *p_intf = ( intf_thread_t* ) p_data;
intf_thread_t *p_intf = (intf_thread_t*) p_data;
intf_sys_t *p_sys = p_intf->p_sys;
input_thread_t *p_input = ( input_thread_t* )p_this;
vlc_value_t state_value;
input_thread_t *p_input = (input_thread_t*)p_this;
int state;
VLC_UNUSED( p_this ); VLC_UNUSED( psz_var );
VLC_UNUSED(psz_var);
if( newval.i_int != INPUT_EVENT_STATE ) return VLC_SUCCESS;
if (newval.i_int != INPUT_EVENT_STATE) return VLC_SUCCESS;
if( var_CountChoices( p_input, "video-es" ) )
if (var_CountChoices(p_input, "video-es"))
{
msg_Dbg( p_this, "Not an audio-only input, not submitting");
msg_Dbg(p_this, "Not an audio-only input, not submitting");
return VLC_SUCCESS;
}
state_value.i_int = 0;
var_Get( p_input, "state", &state_value );
state = var_GetInteger(p_input, "state");
if( !p_sys->b_meta_read && state_value.i_int >= PLAYING_S )
if (!p_sys->b_meta_read && state >= PLAYING_S)
{
ReadMetaData( p_intf );
ReadMetaData(p_intf);
return VLC_SUCCESS;
}
if( state_value.i_int >= END_S )
AddToQueue( p_intf );
else if( state_value.i_int == PAUSE_S )
if (state >= END_S)
AddToQueue(p_intf);
else if (state == PAUSE_S)
p_sys->time_pause = mdate();
else if( p_sys->time_pause > 0 && state_value.i_int == PLAYING_S )
else if (p_sys->time_pause > 0 && state == PLAYING_S)
{
p_sys->time_total_pauses += ( mdate() - p_sys->time_pause );
p_sys->time_total_pauses += (mdate() - p_sys->time_pause);
p_sys->time_pause = 0;
}
......@@ -377,73 +353,73 @@ static int PlayingChange( vlc_object_t *p_this, const char *psz_var,
/*****************************************************************************
* ItemChange: Playlist item change callback
*****************************************************************************/
static int ItemChange( vlc_object_t *p_this, const char *psz_var,
vlc_value_t oldval, vlc_value_t newval, void *p_data )
static int ItemChange(vlc_object_t *p_this, const char *psz_var,
vlc_value_t oldval, vlc_value_t newval, void *p_data)
{
input_thread_t *p_input;
intf_thread_t *p_intf = ( intf_thread_t* ) p_data;
intf_thread_t *p_intf = (intf_thread_t*) p_data;
intf_sys_t *p_sys = p_intf->p_sys;
input_item_t *p_item;
VLC_UNUSED( p_this ); VLC_UNUSED( psz_var );
VLC_UNUSED( oldval ); VLC_UNUSED( newval );
VLC_UNUSED(p_this); VLC_UNUSED(psz_var);
VLC_UNUSED(oldval); VLC_UNUSED(newval);
p_sys->b_state_cb = false;
p_sys->b_meta_read = false;
p_sys->b_submit = false;
p_input = playlist_CurrentInput( pl_Get( p_intf ) );
p_input = playlist_CurrentInput(pl_Get(p_intf));
if( !p_input || p_input->b_dead )
if (!p_input || p_input->b_dead)
return VLC_SUCCESS;
p_item = input_GetItem( p_input );
if( !p_item )
p_item = input_GetItem(p_input);
if (!p_item)
{
vlc_object_release( p_input );
vlc_object_release(p_input);
return VLC_SUCCESS;
}
if( var_CountChoices( p_input, "video-es" ) )
if (var_CountChoices(p_input, "video-es"))
{
msg_Dbg( p_this, "Not an audio-only input, not submitting");
vlc_object_release( p_input );
msg_Dbg(p_this, "Not an audio-only input, not submitting");
vlc_object_release(p_input);
return VLC_SUCCESS;
}
p_sys->time_total_pauses = 0;
time( &p_sys->p_current_song.date ); /* to be sent to last.fm */
time(&p_sys->p_current_song.date); /* to be sent to last.fm */
p_sys->p_current_song.i_start = mdate(); /* only used locally */
var_AddCallback( p_input, "intf-event", PlayingChange, p_intf );
var_AddCallback(p_input, "intf-event", PlayingChange, p_intf);
p_sys->b_state_cb = true;
if( input_item_IsPreparsed( p_item ) )
ReadMetaData( p_intf );
if (input_item_IsPreparsed(p_item))
ReadMetaData(p_intf);
/* if the input item was not preparsed, we'll do it in PlayingChange()
* callback, when "state" == PLAYING_S */
vlc_object_release( p_input );
vlc_object_release(p_input);
return VLC_SUCCESS;
}
/*****************************************************************************
* Open: initialize and create stuff
*****************************************************************************/
static int Open( vlc_object_t *p_this )
static int Open(vlc_object_t *p_this)
{
intf_thread_t *p_intf = ( intf_thread_t* ) p_this;
intf_sys_t *p_sys = calloc( 1, sizeof( intf_sys_t ) );
intf_thread_t *p_intf = (intf_thread_t*) p_this;
intf_sys_t *p_sys = calloc(1, sizeof(intf_sys_t));
if( !p_sys )
if (!p_sys)
return VLC_ENOMEM;
p_intf->p_sys = p_sys;
vlc_mutex_init( &p_sys->lock );
vlc_cond_init( &p_sys->wait );
vlc_mutex_init(&p_sys->lock);
vlc_cond_init(&p_sys->wait);
var_AddCallback( pl_Get( p_intf ), "item-current", ItemChange, p_intf );
var_AddCallback(pl_Get(p_intf), "item-current", ItemChange, p_intf);
p_intf->pf_run = Run;
......@@ -453,35 +429,35 @@ static int Open( vlc_object_t *p_this )
/*****************************************************************************
* Close: destroy interface stuff
*****************************************************************************/
static void Close( vlc_object_t *p_this )
static void Close(vlc_object_t *p_this)
{
playlist_t *p_playlist = pl_Get( p_this );
playlist_t *p_playlist = pl_Get(p_this);
input_thread_t *p_input;
intf_thread_t *p_intf = ( intf_thread_t* ) p_this;
intf_thread_t *p_intf = (intf_thread_t*) p_this;
intf_sys_t *p_sys = p_intf->p_sys;
var_DelCallback( p_playlist, "item-current", ItemChange, p_intf );
var_DelCallback(p_playlist, "item-current", ItemChange, p_intf);
p_input = playlist_CurrentInput( p_playlist );
if ( p_input )
p_input = playlist_CurrentInput(p_playlist);
if (p_input)
{
if( p_sys->b_state_cb )
var_DelCallback( p_input, "intf-event", PlayingChange, p_intf );
vlc_object_release( p_input );
if (p_sys->b_state_cb)
var_DelCallback(p_input, "intf-event", PlayingChange, p_intf);
vlc_object_release(p_input);
}
int i;
for( i = 0; i < p_sys->i_songs; i++ )
DeleteSong( &p_sys->p_queue[i] );
free( p_sys->psz_submit_host );
free( p_sys->psz_submit_file );
for (i = 0; i < p_sys->i_songs; i++)
DeleteSong(&p_sys->p_queue[i]);
free(p_sys->psz_submit_host);
free(p_sys->psz_submit_file);
#if 0 //NOT USED
free( p_sys->psz_nowp_host );
free( p_sys->psz_nowp_file );
free(p_sys->psz_nowp_host);
free(p_sys->psz_nowp_file);
#endif
vlc_cond_destroy( &p_sys->wait );
vlc_mutex_destroy( &p_sys->lock );
free( p_sys );
vlc_cond_destroy(&p_sys->wait);
vlc_mutex_destroy(&p_sys->lock);
free(p_sys);
}
......@@ -499,59 +475,58 @@ static void Close( vlc_object_t *p_this )
* VLC_EGENERIC Invalid url provided
* VLC_SUCCESS Success
*****************************************************************************/
static int ParseURL( char *psz_url, char **psz_host, char **psz_file,
int *i_port )
static int ParseURL(char *psz_url, char **psz_host, char **psz_file,
int *i_port)
{
int i_pos;
int i_len = strlen( psz_url );
size_t i_pos;
size_t i_len = strlen(psz_url);
bool b_no_port = false;
FREENULL( *psz_host );
FREENULL( *psz_file );
FREENULL(*psz_host);
FREENULL(*psz_file);
i_pos = strcspn( psz_url, ":" );
if( i_pos == i_len )
i_pos = strcspn(psz_url, ":");
if (i_pos == i_len)
{
*i_port = 80;
i_pos = strcspn( psz_url, "/" );
i_pos = strcspn(psz_url, "/");
b_no_port = true;
}
*psz_host = strndup( psz_url, i_pos );
if( !*psz_host )
*psz_host = strndup(psz_url, i_pos);
if (!*psz_host)
return VLC_ENOMEM;
if( !b_no_port )
if (!b_no_port)
{
i_pos++; /* skip the ':' */
*i_port = atoi( psz_url + i_pos );
if( *i_port <= 0 )
*i_port = atoi(psz_url + i_pos);
if (*i_port <= 0)
{
FREENULL( *psz_host );
FREENULL(*psz_host);
return VLC_EGENERIC;
}
i_pos = strcspn( psz_url, "/" );
i_pos = strcspn(psz_url, "/");