annotate pidgin-audacious.c @ 10:7c9624c8a109

added /song command which sends name of currently playing song.

/*
 * Pidgin-Audacious plugin.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */
#define PURPLE_PLUGINS 1

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <glib.h>

#include "gtkplugin.h"
#include "util.h"
#include "debug.h"
#include "connection.h"
#include "version.h"
#include "cmds.h"
#include <audacious/audctrl.h>
#include <audacious/dbus.h>

extern gchar *botch_utf(const gchar *msg, gsize len, gsize *newlen) __attribute__ ((weak));

#define PIDGINAUD_PLUGIN_ID	"pidgin_audacious"

#define OPT_PIDGINAUD 		"/plugins/pidgin_audacious"
#define OPT_PROCESS_STATUS	OPT_PIDGINAUD "/process_status"
#define OPT_PROCESS_USERINFO	OPT_PIDGINAUD "/process_userinfo"
#define OPT_PROCESS_ALIAS	OPT_PIDGINAUD "/process_alias"

#define SONG_TOKEN		"%song"
#define NO_SONG_MESSAGE "No song being played."

#define BUDDY_ALIAS_MAXLEN 387

#define aud_debug(fmt, ...)	purple_debug(PURPLE_DEBUG_INFO, "Pidgin-Audacious", \
					fmt, ## __VA_ARGS__);
#define aud_error(fmt, ...)	purple_debug(PURPLE_DEBUG_ERROR, "Pidgin-Audacious", \
					fmt, ## __VA_ARGS__);

static gint timeout_tag = 0;

GHashTable *seed_status;
GHashTable *seed_userinfo;
GHashTable *seed_alias;

GHashTable *pushed_status;
GHashTable *pushed_userinfo;
GHashTable *pushed_alias;

DBusGProxy *session = NULL;

static PurpleCmdId cmdid_paste_current_song;

static void aud_process(gchar *aud_info);

static DBusGProxy *get_dbus_proxy(void)
{
    DBusGConnection *connection = NULL;
    DBusGProxy *session = NULL;
    GError *error = NULL;
    connection = dbus_g_bus_get(DBUS_BUS_SESSION, &error);
    g_clear_error(&error);

    session = dbus_g_proxy_new_for_name(connection, AUDACIOUS_DBUS_SERVICE,
                                        AUDACIOUS_DBUS_PATH,
                                        AUDACIOUS_DBUS_INTERFACE);

    g_clear_error(&error);
    return session;
}

static gboolean
watchdog_func(void)
{
	gint playpos = 0;
	gchar *song = NULL, *tmp = NULL;

	gboolean rv = TRUE;
	size_t dummy;

    aud_debug("session = %p\n", session);

    aud_debug("is_playing = %d\n", audacious_remote_is_playing(session));

    if(!audacious_remote_is_playing(session)) {	/* audacious isn't playing */
        aud_process(NULL);
        return rv;
    }

    playpos = audacious_remote_get_playlist_pos(session);
    tmp = audacious_remote_get_playlist_title(session, playpos);
    if(tmp) {
        if(botch_utf) // function exists
            song = (gchar *) botch_utf(tmp, strlen(tmp), &dummy);
        else
            song = g_strdup(tmp);
    }
    g_free(tmp);
    tmp = NULL;

    aud_process(song);
    g_free(song);
    song = NULL;
	return rv;
}

static void
aud_process_status(PurpleConnection *gc, gchar *aud_info)
{
	gchar *new = NULL, *key = NULL;
	const gchar *current, *seed, *pushed, *proto;
	PurpleAccount *account;
	PurplePresence *presence;
	PurplePlugin *prpl;
	PurplePluginProtocolInfo *prpl_info;
	PurpleStatus *status;

	account = purple_connection_get_account(gc);
	presence = purple_account_get_presence(account);

	proto = purple_account_get_protocol_id(account);
	prpl = purple_find_prpl(proto);
	g_return_if_fail(prpl != NULL);

	prpl_info = PURPLE_PLUGIN_PROTOCOL_INFO(prpl);
	g_return_if_fail(prpl_info != NULL && prpl_info->set_status != NULL);

	status = purple_presence_get_active_status(presence);
	g_return_if_fail(status != NULL);

	/* generate key for hash table */
	key = g_strdup_printf("%s %s", account->username, account->protocol_id);

    /* retrieve current user status */
	current = purple_status_get_attr_string(status, "message");
    aud_debug("status current = %s\n", current);

    /* invalidate pushded status on auto away etc. */
	if(current == NULL || strlen(current) == 0) {
		g_hash_table_replace(pushed_status, g_strdup(key), g_strdup(""));
        g_free(key);
        return;
    }

    /* pop pushed_status */
    pushed = (gchar *)g_hash_table_lookup(pushed_status, key);

    /* if current status differs from pushed_status or contains token, replace hashes with current. */
    if( (pushed && g_ascii_strcasecmp(current, pushed)) || strstr(current, SONG_TOKEN) ) {
		g_hash_table_replace(seed_status, g_strdup(key), g_strdup(current));
        g_hash_table_replace(pushed_status, g_strdup(key), g_strdup(current));
    }

	/* construct new status message */
	seed = (gchar *)g_hash_table_lookup(seed_status, key);
	g_return_if_fail(seed != NULL);
	aud_debug("status seed = %s\n", seed);

    if(strstr(seed, SONG_TOKEN)) {
        if(aud_info){
            new = purple_strreplace(seed, SONG_TOKEN, aud_info);
        }
        else {
            new = g_strdup(NO_SONG_MESSAGE);
        }
    }
	g_return_if_fail(new != NULL);

	/* set status message only if text has been changed */
	pushed = (gchar *)g_hash_table_lookup(pushed_status, key);
	aud_debug("status pushed = %s\n", pushed);

	if (!pushed || g_ascii_strcasecmp(pushed, new)) {
		g_hash_table_replace(pushed_status, g_strdup(key), g_strdup(new));
		purple_status_set_attr_string(status, "message", new);
		prpl_info->set_status(account, status);
	}
	g_free(key);
	g_free(new);
}


static void
aud_process_userinfo(PurpleConnection *gc, gchar *aud_info)
{
	gchar *new = NULL, *key = NULL;
	const gchar *current, *seed, *pushed, *proto;
	PurpleAccount *account;
	PurplePlugin *prpl;
	PurplePluginProtocolInfo *prpl_info;

	account = purple_connection_get_account(gc);

	proto = purple_account_get_protocol_id(account);
	prpl = purple_find_prpl(proto);
	g_return_if_fail(prpl != NULL);

	prpl_info = PURPLE_PLUGIN_PROTOCOL_INFO(prpl);
	g_return_if_fail(prpl_info != NULL && prpl_info->set_info != NULL);

	/* generate key for hash table*/
	key = g_strdup_printf("%s %s", account->username, account->protocol_id);

	/* retrieve current user info */
	current = purple_account_get_user_info(account);		/* it's always from account.xml! */
    aud_debug("userinfo current = %s\n", current);

    /* invalidate pushded status on auto away etc. */
	if(current == NULL || strlen(current) == 0) {
		g_hash_table_replace(pushed_userinfo, g_strdup(key), g_strdup(""));
        g_free(key);
        return;
    }

    /* pop pushed_userinfo */
    pushed = g_hash_table_lookup(pushed_userinfo, key);

    /* if current alias differs from pushed_alias or contains token, replace seed with this. */
    if( (pushed && g_ascii_strcasecmp(current, pushed)) || strstr(current, SONG_TOKEN) ) {
		g_hash_table_replace(seed_userinfo, g_strdup(key), g_strdup(current));
		g_hash_table_replace(pushed_userinfo, g_strdup(key), g_strdup(current));
    }

	/* construct new status message */
	seed = (gchar *)g_hash_table_lookup(seed_userinfo, key);
	g_return_if_fail(seed != NULL);
	aud_debug("userinfo seed = %s\n", seed);

    if(strstr(seed, SONG_TOKEN)) {
        if(aud_info){
            new = purple_strreplace(seed, SONG_TOKEN, aud_info);
        }
        else {
            new = g_strdup(NO_SONG_MESSAGE);
        }
    }
	g_return_if_fail(new != NULL);

	/* set user info only if text has been changed */
	pushed = (gchar *)g_hash_table_lookup(pushed_userinfo, key);
	aud_debug("userinfo pushed = %s\n", pushed);

	if (!pushed || g_ascii_strcasecmp(pushed, new) != 0) {
		g_hash_table_replace(pushed_userinfo, g_strdup(key), g_strdup(new));
		prpl_info->set_info(gc, new);
	}
	g_free(key);
	g_free(new);
}

static void
aud_process_alias(PurpleConnection *gc, gchar *aud_info)
{
	gchar *new = NULL, *key = NULL;
	const gchar *current, *seed, *pushed, *proto;
	PurpleAccount *account;
	PurplePlugin *prpl;
	PurplePluginProtocolInfo *prpl_info;

	glong bytes;

	account = purple_connection_get_account(gc);

	proto = purple_account_get_protocol_id(account);
	prpl = purple_find_prpl(proto);
	g_return_if_fail(prpl != NULL);

	prpl_info = PURPLE_PLUGIN_PROTOCOL_INFO(prpl);
	g_return_if_fail(prpl_info != NULL);

	/* generate key for hash table*/
	key = g_strdup_printf("%s %s", account->username, account->protocol_id);

	/* retrieve current alias */
	current = purple_account_get_alias(account);
	if(current == NULL || strlen(current) == 0) {
		aud_error("couldn't get current alias\n");
        g_free(key);
		return;
	}
	aud_debug("current alias = %s\n", current);

    /* pop pushed_alias */
    pushed = g_hash_table_lookup(pushed_alias, key);

    /* if current alias differs from pushed_alias or contains token, replace seed with current. */
    if( (pushed && g_ascii_strcasecmp(current, pushed)) || strstr(current, SONG_TOKEN) ) {
		g_hash_table_replace(seed_alias, g_strdup(key), g_strdup(current));
    }

	/* construct new status message */
	seed = g_hash_table_lookup(seed_alias, key);
	g_return_if_fail(seed != NULL);
	aud_debug("alias: seed = %s\n", (gchar *)seed);

    bytes = strlen(seed);
    bytes -= strlen(SONG_TOKEN);
    aud_debug("alias: bytes = %ld", bytes);

	if(aud_info){
        gchar *tmp = g_malloc0(BUDDY_ALIAS_MAXLEN);
        glong utflen = g_utf8_strlen(aud_info, BUDDY_ALIAS_MAXLEN/3 - bytes - 1);
        g_utf8_strncpy(tmp, aud_info, utflen);
		new = purple_strreplace(seed, SONG_TOKEN, tmp);
        g_free(tmp);
	}
	else {
		new = purple_strreplace(seed, SONG_TOKEN, NO_SONG_MESSAGE);
	}
	g_return_if_fail(new != NULL);

	/* set user info only if text has been changed */
	pushed = g_hash_table_lookup(pushed_alias, key);
	aud_debug("alias pushed = %s\n", (gchar *)pushed);

	if (!pushed || g_ascii_strcasecmp(pushed, new) != 0) {
        gboolean ok = FALSE;
        PurplePlugin *msn_plugin = NULL;
        msn_plugin = purple_plugins_find_with_id("prpl-msn");
        aud_debug("msn_plugin = %p\n", msn_plugin);

		g_hash_table_replace(pushed_alias, g_strdup(key), g_strdup(new));
        purple_plugin_ipc_call(msn_plugin, "msn_set_friendly_name", &ok, gc, new);
        aud_debug("ipc %d\n", ok);
	}
	g_free(key);
	g_free(new);
}

static void
aud_process(gchar *aud_info)
{
	GList *l;
	PurpleConnection *gc;

	for (l = purple_connections_get_all(); l != NULL; l = l->next) {
		gc = (PurpleConnection *) l->data;

		/* make sure we're connected */
		if (purple_connection_get_state(gc) != PURPLE_CONNECTED) {
			continue;
		}

		if (purple_prefs_get_bool(OPT_PROCESS_USERINFO)) {
			aud_process_userinfo(gc, aud_info);
		}

		if (purple_prefs_get_bool(OPT_PROCESS_STATUS)) {
			aud_process_status(gc, aud_info);
		}

		if (purple_prefs_get_bool(OPT_PROCESS_ALIAS)) {
			aud_process_alias(gc, aud_info);
		}

	}
}
static void
removekey(gpointer data)
{
	g_free(data);
}

static void
removeval(gpointer data)
{
	g_free(data);
}

static gboolean
restore_alias(PurpleConnection *gc, gpointer data)
{
	PurpleAccount *account;
	gpointer val = NULL;
	gchar *key = NULL;

	aud_debug("********** restore_alias called **********\n");
	account = purple_connection_get_account(gc);

	key = g_strdup_printf("%s %s", account->username, account->protocol_id);
	val = g_hash_table_lookup(seed_alias, key);
	g_return_val_if_fail(val != NULL, FALSE);

	aud_debug("write back alias %s\n", (char *)val);
	purple_account_set_alias(account, val); //oct16

	g_free(key);

	return TRUE;
}

static PurpleCmdRet
paste_current_song(PurpleConversation *conv, const gchar *cmd, gchar **args, gchar **error, void *data)
{
	gint playpos = 0;
	gchar *song = NULL, *tmp = NULL;
    PurpleConversationType type = purple_conversation_get_type(conv);
	size_t dummy;

    if(!audacious_remote_is_playing(session)) {	/* audacious isn't playing */
        return PURPLE_CMD_RET_OK;
    }

    playpos = audacious_remote_get_playlist_pos(session);
    tmp = audacious_remote_get_playlist_title(session, playpos);

    if(tmp) {
        if(botch_utf) // function exists
            song = (gchar *) botch_utf(tmp, strlen(tmp), &dummy);
        else
            song = g_strdup(tmp);
    }
    g_free(tmp);
    tmp = NULL;

    if(type == PURPLE_CONV_TYPE_CHAT) {
        PurpleConvChat *chat = purple_conversation_get_chat_data(conv);
        if (chat && song)
            purple_conv_chat_send(chat, song);
    }
    else if(type == PURPLE_CONV_TYPE_IM) {
        PurpleConvIm *im = purple_conversation_get_im_data(conv);
        if(im && song)
            purple_conv_im_send(im, song);
    }

    g_free(song);
    return PURPLE_CMD_RET_OK;
}

static gboolean
load_plugin(PurplePlugin *plugin)
{
	seed_status = g_hash_table_new_full(g_str_hash, g_str_equal, removekey, removeval);
	seed_alias = g_hash_table_new_full(g_str_hash, g_str_equal, removekey, removeval);
	seed_userinfo = g_hash_table_new_full(g_str_hash, g_str_equal, removekey, removeval);

	pushed_status = g_hash_table_new_full(g_str_hash, g_str_equal, removekey, removeval);
	pushed_alias = g_hash_table_new_full(g_str_hash, g_str_equal, removekey, removeval);
	pushed_userinfo = g_hash_table_new_full(g_str_hash, g_str_equal, removekey, removeval);

	timeout_tag = g_timeout_add(15*1000, (gpointer)watchdog_func, NULL);

	/* connect to signing-off signal */
	purple_signal_connect(purple_connections_get_handle(), "signing-off", plugin,
						PURPLE_CALLBACK(restore_alias), NULL);

    cmdid_paste_current_song =
        purple_cmd_register("song", "", PURPLE_CMD_P_DEFAULT,
                            PURPLE_CMD_FLAG_IM | PURPLE_CMD_FLAG_CHAT,
                            NULL, paste_current_song,
                            "song: Paste currently plaing song", NULL);

	return TRUE;
}

static gboolean
unload_plugin(PurplePlugin *plugin)
{
	aud_debug("pidgin-audacious unload called\n");

	g_source_remove(timeout_tag);

	g_hash_table_destroy(seed_status);
	g_hash_table_destroy(seed_alias);
	g_hash_table_destroy(seed_userinfo);

	g_hash_table_destroy(pushed_status);
	g_hash_table_destroy(pushed_alias);
	g_hash_table_destroy(pushed_userinfo);

    purple_cmd_unregister(cmdid_paste_current_song);

	return TRUE;
}

static PurplePluginPrefFrame *
get_plugin_pref_frame(PurplePlugin *plugin)
{
	PurplePluginPref *pref;
	PurplePluginPrefFrame *frame = purple_plugin_pref_frame_new();

	/* create gtk elements for the plugin preferences */
	pref = purple_plugin_pref_new_with_label("Pidgin-Audacious Configuration");
	purple_plugin_pref_frame_add(frame, pref);

	pref = purple_plugin_pref_new_with_name_and_label(OPT_PROCESS_STATUS,
			"Expand " SONG_TOKEN " to song info in the status message");
	purple_plugin_pref_frame_add(frame, pref);

	pref = purple_plugin_pref_new_with_name_and_label(OPT_PROCESS_USERINFO,
			"Expand " SONG_TOKEN " to song info in the user info");
	purple_plugin_pref_frame_add(frame, pref);

	pref = purple_plugin_pref_new_with_name_and_label(OPT_PROCESS_ALIAS,
			"Expand " SONG_TOKEN " to song info in the alias");
	purple_plugin_pref_frame_add(frame, pref);

	return frame;
}

static PurplePluginUiInfo pref_info =
{
	get_plugin_pref_frame
};

static PurplePluginInfo info =
{
	PURPLE_PLUGIN_MAGIC,
	PURPLE_MAJOR_VERSION,
	PURPLE_MINOR_VERSION,
	PURPLE_PLUGIN_STANDARD,		/**< type	*/
    NULL,				        /**< ui_req	*/
	0,						    /**< flags	*/
	NULL,						/**< deps	*/
	PURPLE_PRIORITY_DEFAULT,	/**< priority	*/
	PIDGINAUD_PLUGIN_ID,		/**< id		*/
	"Pidgin-Audacious",			/**< name	*/
	"2.1.0d1",					/**< version	*/
	"Automatically updates your Pidgin status info	with the currently "
			"playing music in Audacious.", /**  summary	*/
	"Automatically updates your Pidgin status info with the currently "
			"playing music in Audacious.", /**  desc	*/
	"Yoshiki Yazawa ([e-mail])", /**< author	*/
	"http://www.honeyplanet.jp",	/**< homepage	*/
	load_plugin,					/**< load	*/
	unload_plugin,					/**< unload	*/
	NULL,						/**< destroy	*/
	NULL,						/**< ui_info	*/
	NULL,						/**< extra_info	*/
	&pref_info,					/**< pref info	*/
	NULL
};

static void
init_plugin(PurplePlugin *plugin)
{
	g_type_init();

	/* add plugin preferences */
	purple_prefs_add_none(OPT_PIDGINAUD);
	purple_prefs_add_bool(OPT_PROCESS_STATUS, TRUE);
	purple_prefs_add_bool(OPT_PROCESS_USERINFO, TRUE);
	purple_prefs_add_bool(OPT_PROCESS_ALIAS, TRUE);

    session = get_dbus_proxy();
}

PURPLE_INIT_PLUGIN(pidgin_audacious, init_plugin, info)