[mirrors/libpurple-core-answerscripts.git] / answerscripts.c

//#define __WIN32__
#ifndef __WIN32__
	#define ANSWERSCRIPT_EXT ""
#else
	#define ANSWERSCRIPT_EXT ".exe"
#endif
#define ANSWERSCRIPT "answerscripts" ANSWERSCRIPT_EXT
#define ANSWERSCRIPTS_TIMEOUT_INTERVAL 250
#define ANSWERSCRIPTS_LINE_LENGTH 4096
#define ENV_PREFIX "ANSW_"
#define PROTOCOL_PREFIX "prpl-"

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

#ifndef __WIN32__
	#include <fcntl.h>
#else
	#include <windows.h>
#endif

/* Purple plugin */
#define PURPLE_PLUGINS
#include <libpurple/debug.h>
#include <libpurple/version.h>
#include <libpurple/conversation.h>
#include <libpurple/plugin.h>
#include <libpurple/signals.h>
#include <libpurple/util.h>

char *message = NULL;
char *hook_script = NULL;

typedef struct {
  FILE *pipe;
  PurpleConversation *conv;
} answerscripts_job;

int answerscripts_process_message_cb(answerscripts_job *job) {
	int i;
	char response[ANSWERSCRIPTS_LINE_LENGTH+1]; response[0]='\0';
	FILE *pipe = job->pipe;
	PurpleConversation *conv = job->conv;

	if (pipe && !feof(pipe)) {
		if(!fgets(response, ANSWERSCRIPTS_LINE_LENGTH, pipe)
			&& (errno == EWOULDBLOCK || errno == EAGAIN) //WARNING! Not compatible with windows :-(
		) return 1;

		for(i=0;response[i];i++) if(response[i]=='\n') response[i]=0;
		if(response[0]!='\0') purple_conv_im_send(purple_conversation_get_im_data(conv), response);

		if(!feof(pipe)) return 1;
	}
	pclose(pipe);
	free(job);
	return 0;
}

static void received_im_msg_cb(PurpleAccount *account, char *who, char *buffer, PurpleConversation *conv, PurpleMessageFlags flags, void *data) {
	if (conv == NULL) conv = purple_conversation_new(PURPLE_CONV_TYPE_IM, account, who); //* A workaround to avoid skipping of the first message as a result on NULL-conv: */
	PurpleBuddy *buddy = purple_find_buddy(account, who);

	//Get message
	message = purple_markup_strip_html(buffer);

	//LOCAL USER:
	const char* local_alias = purple_account_get_alias(account);
	const char* local_name = (char *) purple_account_get_name_for_display(account);

	//REMOTE USER (Buddy):

	//Get buddy alias
	const char* remote_alias = purple_buddy_get_alias(buddy);
	if(remote_alias == NULL) remote_alias = "";

	//Get buddy group
	PurpleGroup *group = purple_buddy_get_group(buddy);
	const char *from_group = group != NULL ? purple_group_get_name(group) : ""; //return empty string if not in group

	//Get protocol ID
	const char *protocol_id = purple_account_get_protocol_id(account);
	if(!strncmp(protocol_id,PROTOCOL_PREFIX,strlen(PROTOCOL_PREFIX))) protocol_id += strlen(PROTOCOL_PREFIX); //trim out PROTOCOL_PREFIX (eg.: "prpl-irc" => "irc")

	//Get status
	PurpleStatus *status = purple_account_get_active_status(account);
	PurpleStatusType *type = purple_status_get_type(status);

	//Get status id
	const char *status_id = NULL;
	status_id = purple_primitive_get_id_from_type(purple_status_type_get_primitive(type));

	//Get status message
	const char *status_msg = NULL;
	if (purple_status_type_get_attr(type, "message") != NULL) {
		status_msg = purple_status_get_attr_string(status, "message");
	} else {
		status_msg = (char *) purple_savedstatus_get_message(purple_savedstatus_get_current());
	}

	//Export variables to environment
	setenv(ENV_PREFIX "ACTION", "IM", 1);	//what happend: im, chat, show setting dialog, event, etc...
	setenv(ENV_PREFIX "MSG", message, 1);	//text of the message
	setenv(ENV_PREFIX "PROTOCOL", protocol_id, 1);	//protocol used to deliver the message. eg.: xmpp, irc,...
	setenv(ENV_PREFIX "R_NAME", who, 1);	//ID of remote user - "buddy"
	setenv(ENV_PREFIX "R_GROUP", from_group, 1);	//group which contains that buddy OR empty string
	setenv(ENV_PREFIX "R_ALIAS", remote_alias, 1);	//buddy's alias, server alias, contact alias, username OR empty string
	setenv(ENV_PREFIX "L_NAME", local_name, 1);	//ID of local user
	setenv(ENV_PREFIX "L_ALIAS", local_alias, 1);	//Alias of local user OR empty string
	setenv(ENV_PREFIX "L_STATUS", status_id, 1);	//unique ID of local user's status. eg.: available, away,...
	setenv(ENV_PREFIX "L_STATUS_MSG", status_msg, 1);	//status message set by local user

	//Launch job on background
	answerscripts_job *job = (answerscripts_job*) malloc(sizeof(answerscripts_job));
	job->pipe = popen(hook_script, "r");
	if(job->pipe == NULL) {
		fprintf(stderr,"Can't execute %s\n", hook_script);
		return;
	}
	job->conv = conv;

	#ifndef __WIN32__
		int fflags = fcntl(fileno(job->pipe), F_GETFL, 0);
		fcntl(fileno(job->pipe), F_SETFL, fflags | O_NONBLOCK);
	#else
		//WARNING! Somehow implement FILE_FLAG_OVERLAPPED & FILE_FLAG_NO_BUFFERING support on windows
	#endif

	purple_timeout_add(ANSWERSCRIPTS_TIMEOUT_INTERVAL, (GSourceFunc) answerscripts_process_message_cb, (gpointer) job);
}

static gboolean plugin_load(PurplePlugin * plugin) {
	asprintf(&hook_script,"%s/%s",purple_user_dir(),ANSWERSCRIPT);
	void *conv_handle = purple_conversations_get_handle();
	purple_signal_connect(conv_handle, "received-im-msg", plugin, PURPLE_CALLBACK(received_im_msg_cb), NULL);
	return TRUE;
}

static gboolean plugin_unload(PurplePlugin * plugin) {
	free(hook_script);
	return TRUE;
}

static PurplePluginInfo info = {
	PURPLE_PLUGIN_MAGIC,
	PURPLE_MAJOR_VERSION,
	PURPLE_MINOR_VERSION,
	PURPLE_PLUGIN_STANDARD,
	NULL,
	0,
	NULL,
	PURPLE_PRIORITY_DEFAULT,

	"core-answerscripts",
	"AnswerScripts",
	"0.4.0",
	"Framework for hooking scripts to process received messages for libpurple clients",
	"\nThis plugin will execute script \"~/.purple/" ANSWERSCRIPT "\" "
		"(or any other executable called \"" ANSWERSCRIPT "\" and found in purple_user_dir()) "
		"each time when instant message is received.\n"
		"\n- Any text printed to STDOUT by this script will be sent back as answer to received message."
		"\n- Following environment values will be set, so script can use them for responding:\n"
		"\t- " ENV_PREFIX "* (see documentation or env for more)\n"
		"\nPlease see sample scripts, documentation, website and source code for more informations...\n"
		"\n(-; Peace ;-)\n",
	"Tomas Mudrunka <harvie@email.cz>",
	"http://github.com/harvie/libpurple-core-answerscripts",

	plugin_load,
	plugin_unload,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL
};

static void init_plugin(PurplePlugin * plugin) {
	//Export static environment variables
	setenv(ENV_PREFIX "L_AGENT", (char *) purple_core_get_ui(), 1);	//ID of IM client used with answerscripts
	setenv(ENV_PREFIX "L_AGENT_VERSION", (char *) purple_core_get_version(), 1);	//Version of client
}

PURPLE_INIT_PLUGIN(autoanswer, init_plugin, info)
Commit	Line	Data
	1	//#define __WIN32__
	2	#ifndef __WIN32__
	3	#define ANSWERSCRIPT_EXT ""
	4	#else
	5	#define ANSWERSCRIPT_EXT ".exe"
	6	#endif
	7	#define ANSWERSCRIPT "answerscripts" ANSWERSCRIPT_EXT
	8	#define ANSWERSCRIPTS_TIMEOUT_INTERVAL 250
	9	#define ANSWERSCRIPTS_LINE_LENGTH 4096
	10	#define ENV_PREFIX "ANSW_"
	11	#define PROTOCOL_PREFIX "prpl-"
	12
	13	#include <stdio.h>
	14	#include <stdlib.h>
	15	#include <errno.h>
	16	#include <string.h>
	17
	18	#ifndef __WIN32__
	19	#include <fcntl.h>
	20	#else
	21	#include <windows.h>
	22	#endif
	23
	24	/* Purple plugin */
	25	#define PURPLE_PLUGINS
	26	#include <libpurple/debug.h>
	27	#include <libpurple/version.h>
	28	#include <libpurple/conversation.h>
	29	#include <libpurple/plugin.h>
	30	#include <libpurple/signals.h>
	31	#include <libpurple/util.h>
	32
	33	char *message = NULL;
	34	char *hook_script = NULL;
	35
	36	typedef struct {
	37	FILE *pipe;
	38	PurpleConversation *conv;
	39	} answerscripts_job;
	40
	41	int answerscripts_process_message_cb(answerscripts_job *job) {
	42	int i;
	43	char response[ANSWERSCRIPTS_LINE_LENGTH+1]; response[0]='\0';
	44	FILE *pipe = job->pipe;
	45	PurpleConversation *conv = job->conv;
	46
	47	if (pipe && !feof(pipe)) {
	48	if(!fgets(response, ANSWERSCRIPTS_LINE_LENGTH, pipe)
	49	&& (errno == EWOULDBLOCK \|\| errno == EAGAIN) //WARNING! Not compatible with windows :-(
	50	) return 1;
	51
	52	for(i=0;response[i];i++) if(response[i]=='\n') response[i]=0;
	53	if(response[0]!='\0') purple_conv_im_send(purple_conversation_get_im_data(conv), response);
	54
	55	if(!feof(pipe)) return 1;
	56	}
	57	pclose(pipe);
	58	free(job);
	59	return 0;
	60	}
	61
	62	static void received_im_msg_cb(PurpleAccount account, char who, char buffer, PurpleConversation conv, PurpleMessageFlags flags, void *data) {
	63	if (conv == NULL) conv = purple_conversation_new(PURPLE_CONV_TYPE_IM, account, who); //* A workaround to avoid skipping of the first message as a result on NULL-conv: */
	64	PurpleBuddy *buddy = purple_find_buddy(account, who);
	65
	66	//Get message
	67	message = purple_markup_strip_html(buffer);
	68
	69	//LOCAL USER:
	70	const char* local_alias = purple_account_get_alias(account);
	71	const char* local_name = (char *) purple_account_get_name_for_display(account);
	72
	73	//REMOTE USER (Buddy):
	74
	75	//Get buddy alias
	76	const char* remote_alias = purple_buddy_get_alias(buddy);
	77	if(remote_alias == NULL) remote_alias = "";
	78
	79	//Get buddy group
	80	PurpleGroup *group = purple_buddy_get_group(buddy);
	81	const char *from_group = group != NULL ? purple_group_get_name(group) : ""; //return empty string if not in group
	82
	83	//Get protocol ID
	84	const char *protocol_id = purple_account_get_protocol_id(account);
	85	if(!strncmp(protocol_id,PROTOCOL_PREFIX,strlen(PROTOCOL_PREFIX))) protocol_id += strlen(PROTOCOL_PREFIX); //trim out PROTOCOL_PREFIX (eg.: "prpl-irc" => "irc")
	86
	87	//Get status
	88	PurpleStatus *status = purple_account_get_active_status(account);
	89	PurpleStatusType *type = purple_status_get_type(status);
	90
	91	//Get status id
	92	const char *status_id = NULL;
	93	status_id = purple_primitive_get_id_from_type(purple_status_type_get_primitive(type));
	94
	95	//Get status message
	96	const char *status_msg = NULL;
	97	if (purple_status_type_get_attr(type, "message") != NULL) {
	98	status_msg = purple_status_get_attr_string(status, "message");
	99	} else {
	100	status_msg = (char *) purple_savedstatus_get_message(purple_savedstatus_get_current());
	101	}
	102
	103	//Export variables to environment
	104	setenv(ENV_PREFIX "ACTION", "IM", 1); //what happend: im, chat, show setting dialog, event, etc...
	105	setenv(ENV_PREFIX "MSG", message, 1); //text of the message
	106	setenv(ENV_PREFIX "PROTOCOL", protocol_id, 1); //protocol used to deliver the message. eg.: xmpp, irc,...
	107	setenv(ENV_PREFIX "R_NAME", who, 1); //ID of remote user - "buddy"
	108	setenv(ENV_PREFIX "R_GROUP", from_group, 1); //group which contains that buddy OR empty string
	109	setenv(ENV_PREFIX "R_ALIAS", remote_alias, 1); //buddy's alias, server alias, contact alias, username OR empty string
	110	setenv(ENV_PREFIX "L_NAME", local_name, 1); //ID of local user
	111	setenv(ENV_PREFIX "L_ALIAS", local_alias, 1); //Alias of local user OR empty string
	112	setenv(ENV_PREFIX "L_STATUS", status_id, 1); //unique ID of local user's status. eg.: available, away,...
	113	setenv(ENV_PREFIX "L_STATUS_MSG", status_msg, 1); //status message set by local user
	114
	115	//Launch job on background
	116	answerscripts_job job = (answerscripts_job) malloc(sizeof(answerscripts_job));
	117	job->pipe = popen(hook_script, "r");
	118	if(job->pipe == NULL) {
	119	fprintf(stderr,"Can't execute %s\n", hook_script);
	120	return;
	121	}
	122	job->conv = conv;
	123
	124	#ifndef __WIN32__
	125	int fflags = fcntl(fileno(job->pipe), F_GETFL, 0);
	126	fcntl(fileno(job->pipe), F_SETFL, fflags \| O_NONBLOCK);
	127	#else
	128	//WARNING! Somehow implement FILE_FLAG_OVERLAPPED & FILE_FLAG_NO_BUFFERING support on windows
	129	#endif
	130
	131	purple_timeout_add(ANSWERSCRIPTS_TIMEOUT_INTERVAL, (GSourceFunc) answerscripts_process_message_cb, (gpointer) job);
	132	}
	133
	134	static gboolean plugin_load(PurplePlugin * plugin) {
	135	asprintf(&hook_script,"%s/%s",purple_user_dir(),ANSWERSCRIPT);
	136	void *conv_handle = purple_conversations_get_handle();
	137	purple_signal_connect(conv_handle, "received-im-msg", plugin, PURPLE_CALLBACK(received_im_msg_cb), NULL);
	138	return TRUE;
	139	}
	140
	141	static gboolean plugin_unload(PurplePlugin * plugin) {
	142	free(hook_script);
	143	return TRUE;
	144	}
	145
	146	static PurplePluginInfo info = {
	147	PURPLE_PLUGIN_MAGIC,
	148	PURPLE_MAJOR_VERSION,
	149	PURPLE_MINOR_VERSION,
	150	PURPLE_PLUGIN_STANDARD,
	151	NULL,
	152	0,
	153	NULL,
	154	PURPLE_PRIORITY_DEFAULT,
	155
	156	"core-answerscripts",
	157	"AnswerScripts",
	158	"0.4.0",
	159	"Framework for hooking scripts to process received messages for libpurple clients",
	160	"\nThis plugin will execute script \"~/.purple/" ANSWERSCRIPT "\" "
	161	"(or any other executable called \"" ANSWERSCRIPT "\" and found in purple_user_dir()) "
	162	"each time when instant message is received.\n"
	163	"\n- Any text printed to STDOUT by this script will be sent back as answer to received message."
	164	"\n- Following environment values will be set, so script can use them for responding:\n"
	165	"\t- " ENV_PREFIX "* (see documentation or env for more)\n"
	166	"\nPlease see sample scripts, documentation, website and source code for more informations...\n"
	167	"\n(-; Peace ;-)\n",
	168	"Tomas Mudrunka <harvie@email.cz>",
	169	"http://github.com/harvie/libpurple-core-answerscripts",
	170
	171	plugin_load,
	172	plugin_unload,
	173	NULL,
	174	NULL,
	175	NULL,
	176	NULL,
	177	NULL,
	178	NULL,
	179	NULL,
	180	NULL,
	181	NULL
	182	};
	183
	184	static void init_plugin(PurplePlugin * plugin) {
	185	//Export static environment variables
	186	setenv(ENV_PREFIX "L_AGENT", (char *) purple_core_get_ui(), 1); //ID of IM client used with answerscripts
	187	setenv(ENV_PREFIX "L_AGENT_VERSION", (char *) purple_core_get_version(), 1); //Version of client
	188	}
	189
	190	PURPLE_INIT_PLUGIN(autoanswer, init_plugin, info)