[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);

	//Here are prototypes of some functions interesting to implement github feature request #3

	//LOCAL USER:
	const char* local_alias = purple_account_get_alias(account);
	const char* local_name = (char *) purple_account_get_name_for_display(account);
	setenv(ENV_PREFIX "LOCAL_NAME", local_name, 1);	//Name of local user - untested
	setenv(ENV_PREFIX "LOCAL_ALIAS", local_alias, 1);	//Alias of local user - untested

	//REMOTE USER (Buddy):
	//const char * 	purple_contact_get_alias (PurpleContact *contact)
	const char* remote_name = purple_buddy_get_name(buddy);
	const char* remote_alias_only = purple_buddy_get_alias_only(buddy);
	const char* remote_server_alias = purple_buddy_get_server_alias(buddy);
	const char* remote_contact_alias = purple_buddy_get_contact_alias(buddy);
	const char* remote_local_alias = purple_buddy_get_local_alias(buddy);
	const char* remote_alias = purple_buddy_get_alias(buddy);
	setenv(ENV_PREFIX "REMOTE_NAME", remote_name, 1);	//???
	setenv(ENV_PREFIX "REMOTE_ALIAS_ONLY", remote_alias_only, 1);	//buggy
	setenv(ENV_PREFIX "REMOTE_SERVER_ALIAS", remote_server_alias, 1);	//buggy
	setenv(ENV_PREFIX "REMOTE_CONTACT_ALIAS", remote_contact_alias, 1);	//buggy
	setenv(ENV_PREFIX "REMOTE_LOCAL_ALIAS", remote_local_alias, 1);	//???
	setenv(ENV_PREFIX "REMOTE_ALIAS", remote_alias, 1);	//???

	//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 "MSG", message, 1);	//text of the message
	setenv(ENV_PREFIX "FROM", who, 1);	//who sent you the message
	setenv(ENV_PREFIX "FROM_GROUP", from_group, 1);	//group which contains that buddy
	setenv(ENV_PREFIX "PROTOCOL", protocol_id, 1);	//protocol used to deliver the message. eg.: xmpp, irc,...
	setenv(ENV_PREFIX "STATUS", status_id, 1);	//unique ID of status. eg.: available, away,...
	setenv(ENV_PREFIX "STATUS_MSG", status_msg, 1);	//status message set by 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.3.1",
	"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- ANSW_MSG\n"
		"\t- ANSW_FROM\n"
		"\t- ANSW_PROTOCOL\n"
		"\t- ANSW_STATUS\n"
		"\t- ANSW_STATUS_MSG\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 "AGENT", (char *) purple_core_get_ui(), 1);	//ID of IM client used with answerscripts
	setenv(ENV_PREFIX "AGENT_VERSION", (char *) purple_core_get_version(), 1);	//Version of client
}

PURPLE_INIT_PLUGIN(autoanswer, init_plugin, info)
Commit	Line	Data
73f7c2ff	1	//#define __WIN32__
058e63ec H	2	#ifndef __WIN32__
	3	#define ANSWERSCRIPT_EXT ""
	4	#else
	5	#define ANSWERSCRIPT_EXT ".exe"
	6	#endif
	7	#define ANSWERSCRIPT "answerscripts" ANSWERSCRIPT_EXT
53478f8c H	8	#define ANSWERSCRIPTS_TIMEOUT_INTERVAL 250
53478f8c H	9	#define ANSWERSCRIPTS_LINE_LENGTH 4096
0636d441	10	#define ENV_PREFIX "ANSW_"
2bcad731	11	#define PROTOCOL_PREFIX "prpl-"
b44d7b66 H	12
	13	#include <stdio.h>
	14	#include <stdlib.h>
81749a99	15	#include <errno.h>
2bcad731	16	#include <string.h>
b44d7b66	17
81749a99 H	18	#ifndef __WIN32__
81749a99 H	19	#include <fcntl.h>
b86255fd H	20	#else
b86255fd H	21	#include <windows.h>
81749a99 H	22	#endif
81749a99 H	23
53478f8c H	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>
73f7c2ff	32
ca489436	33	char *message = NULL;
b44d7b66	34	char *hook_script = NULL;
b44d7b66	35
6ec3c19f H	36	typedef struct {
	37	FILE *pipe;
	38	PurpleConversation *conv;
	39	} answerscripts_job;
	40
81749a99	41	int answerscripts_process_message_cb(answerscripts_job *job) {
64ac1ebf	42	int i;
acd3f9c2	43	char response[ANSWERSCRIPTS_LINE_LENGTH+1]; response[0]='\0';
6ec3c19f H	44	FILE *pipe = job->pipe;
	45	PurpleConversation *conv = job->conv;
	46
81749a99 H	47	if (pipe && !feof(pipe)) {
81749a99 H	48	if(!fgets(response, ANSWERSCRIPTS_LINE_LENGTH, pipe)
b86255fd	49	&& (errno == EWOULDBLOCK \|\| errno == EAGAIN) //WARNING! Not compatible with windows :-(
81749a99 H	50	) return 1;
81749a99 H	51
d852a694	52	for(i=0;response[i];i++) if(response[i]=='\n') response[i]=0;
acd3f9c2	53	if(response[0]!='\0') purple_conv_im_send(purple_conversation_get_im_data(conv), response);
81749a99 H	54
81749a99 H	55	if(!feof(pipe)) return 1;
d852a694 H	56	}
d852a694 H	57	pclose(pipe);
6ec3c19f H	58	free(job);
6ec3c19f H	59	return 0;
d852a694 H	60	}
d852a694 H	61
73f7c2ff H	62	static void received_im_msg_cb(PurpleAccount account, char who, char buffer, PurpleConversation conv, PurpleMessageFlags flags, void *data) {
73f7c2ff H	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: */
6b8234e8	64	PurpleBuddy *buddy = purple_find_buddy(account, who);
b44d7b66	65
ca489436 H	66	//Get message
ca489436 H	67	message = purple_markup_strip_html(buffer);
b44d7b66	68
96150021 H	69	//Here are prototypes of some functions interesting to implement github feature request #3
	70
	71	//LOCAL USER:
	72	const char* local_alias = purple_account_get_alias(account);
	73	const char* local_name = (char *) purple_account_get_name_for_display(account);
7f54aeea H	74	setenv(ENV_PREFIX "LOCAL_NAME", local_name, 1); //Name of local user - untested
7f54aeea H	75	setenv(ENV_PREFIX "LOCAL_ALIAS", local_alias, 1); //Alias of local user - untested
96150021 H	76
	77	//REMOTE USER (Buddy):
	78	//const char * purple_contact_get_alias (PurpleContact *contact)
	79	const char* remote_name = purple_buddy_get_name(buddy);
	80	const char* remote_alias_only = purple_buddy_get_alias_only(buddy);
	81	const char* remote_server_alias = purple_buddy_get_server_alias(buddy);
	82	const char* remote_contact_alias = purple_buddy_get_contact_alias(buddy);
	83	const char* remote_local_alias = purple_buddy_get_local_alias(buddy);
	84	const char* remote_alias = purple_buddy_get_alias(buddy);
7f54aeea H	85	setenv(ENV_PREFIX "REMOTE_NAME", remote_name, 1); //???
	86	setenv(ENV_PREFIX "REMOTE_ALIAS_ONLY", remote_alias_only, 1); //buggy
	87	setenv(ENV_PREFIX "REMOTE_SERVER_ALIAS", remote_server_alias, 1); //buggy
	88	setenv(ENV_PREFIX "REMOTE_CONTACT_ALIAS", remote_contact_alias, 1); //buggy
	89	setenv(ENV_PREFIX "REMOTE_LOCAL_ALIAS", remote_local_alias, 1); //???
	90	setenv(ENV_PREFIX "REMOTE_ALIAS", remote_alias, 1); //???
c77055a9	91
6b8234e8	92	//Get buddy group
2c80caf3 H	93	PurpleGroup *group = purple_buddy_get_group(buddy);
2c80caf3 H	94	const char *from_group = group != NULL ? purple_group_get_name(group) : ""; //return empty string if not in group
6b8234e8	95
2bcad731 H	96	//Get protocol ID
2bcad731 H	97	const char *protocol_id = purple_account_get_protocol_id(account);
5b15396b	98	if(!strncmp(protocol_id,PROTOCOL_PREFIX,strlen(PROTOCOL_PREFIX))) protocol_id += strlen(PROTOCOL_PREFIX); //trim out PROTOCOL_PREFIX (eg.: "prpl-irc" => "irc")
2bcad731	99
7a45e05c H	100	//Get status
	101	PurpleStatus *status = purple_account_get_active_status(account);
	102	PurpleStatusType *type = purple_status_get_type(status);
	103
	104	//Get status id
	105	const char *status_id = NULL;
	106	status_id = purple_primitive_get_id_from_type(purple_status_type_get_primitive(type));
	107
	108	//Get status message
	109	const char *status_msg = NULL;
	110	if (purple_status_type_get_attr(type, "message") != NULL) {
	111	status_msg = purple_status_get_attr_string(status, "message");
	112	} else {
	113	status_msg = (char *) purple_savedstatus_get_message(purple_savedstatus_get_current());
	114	}
	115
ca489436	116	//Export variables to environment
7f54aeea H	117	setenv(ENV_PREFIX "MSG", message, 1); //text of the message
7f54aeea H	118	setenv(ENV_PREFIX "FROM", who, 1); //who sent you the message
2c80caf3	119	setenv(ENV_PREFIX "FROM_GROUP", from_group, 1); //group which contains that buddy
7f54aeea H	120	setenv(ENV_PREFIX "PROTOCOL", protocol_id, 1); //protocol used to deliver the message. eg.: xmpp, irc,...
	121	setenv(ENV_PREFIX "STATUS", status_id, 1); //unique ID of status. eg.: available, away,...
	122	setenv(ENV_PREFIX "STATUS_MSG", status_msg, 1); //status message set by user
6ec3c19f	123
ca489436	124	//Launch job on background
6ec3c19f H	125	answerscripts_job job = (answerscripts_job) malloc(sizeof(answerscripts_job));
6ec3c19f H	126	job->pipe = popen(hook_script, "r");
d94bfdb4 H	127	if(job->pipe == NULL) {
	128	fprintf(stderr,"Can't execute %s\n", hook_script);
	129	return;
	130	}
6ec3c19f H	131	job->conv = conv;
6ec3c19f H	132
81749a99 H	133	#ifndef __WIN32__
	134	int fflags = fcntl(fileno(job->pipe), F_GETFL, 0);
	135	fcntl(fileno(job->pipe), F_SETFL, fflags \| O_NONBLOCK);
b86255fd H	136	#else
b86255fd H	137	//WARNING! Somehow implement FILE_FLAG_OVERLAPPED & FILE_FLAG_NO_BUFFERING support on windows
81749a99 H	138	#endif
	139
	140	purple_timeout_add(ANSWERSCRIPTS_TIMEOUT_INTERVAL, (GSourceFunc) answerscripts_process_message_cb, (gpointer) job);
b44d7b66 H	141	}
b44d7b66 H	142
b44d7b66	143	static gboolean plugin_load(PurplePlugin * plugin) {
6ec3c19f	144	asprintf(&hook_script,"%s/%s",purple_user_dir(),ANSWERSCRIPT);
b44d7b66	145	void *conv_handle = purple_conversations_get_handle();
73f7c2ff	146	purple_signal_connect(conv_handle, "received-im-msg", plugin, PURPLE_CALLBACK(received_im_msg_cb), NULL);
53478f8c	147	return TRUE;
b44d7b66 H	148	}
	149
	150	static gboolean plugin_unload(PurplePlugin * plugin) {
	151	free(hook_script);
53478f8c	152	return TRUE;
b44d7b66 H	153	}
	154
	155	static PurplePluginInfo info = {
	156	PURPLE_PLUGIN_MAGIC,
	157	PURPLE_MAJOR_VERSION,
	158	PURPLE_MINOR_VERSION,
	159	PURPLE_PLUGIN_STANDARD,
	160	NULL,
	161	0,
	162	NULL,
	163	PURPLE_PRIORITY_DEFAULT,
	164
	165	"core-answerscripts",
	166	"AnswerScripts",
37436d76	167	"0.3.1",
53478f8c	168	"Framework for hooking scripts to process received messages for libpurple clients",
37436d76 H	169	"\nThis plugin will execute script \"~/.purple/" ANSWERSCRIPT "\" "
	170	"(or any other executable called \"" ANSWERSCRIPT "\" and found in purple_user_dir()) "
	171	"each time when instant message is received.\n"
	172	"\n- Any text printed to STDOUT by this script will be sent back as answer to received message."
	173	"\n- Following environment values will be set, so script can use them for responding:\n"
	174	"\t- ANSW_MSG\n"
	175	"\t- ANSW_FROM\n"
	176	"\t- ANSW_PROTOCOL\n"
	177	"\t- ANSW_STATUS\n"
	178	"\t- ANSW_STATUS_MSG\n"
	179	"\nPlease see sample scripts, documentation, website and source code for more informations...\n"
	180	"\n(-; Peace ;-)\n",
	181	"Tomas Mudrunka <harvie@email.cz>",
53478f8c	182	"http://github.com/harvie/libpurple-core-answerscripts",
b44d7b66 H	183
	184	plugin_load,
	185	plugin_unload,
	186	NULL,
	187	NULL,
	188	NULL,
	189	NULL,
	190	NULL,
	191	NULL,
	192	NULL,
	193	NULL,
	194	NULL
	195	};
	196
	197	static void init_plugin(PurplePlugin * plugin) {
b9de4161	198	//Export static environment variables
7f54aeea H	199	setenv(ENV_PREFIX "AGENT", (char *) purple_core_get_ui(), 1); //ID of IM client used with answerscripts
7f54aeea H	200	setenv(ENV_PREFIX "AGENT_VERSION", (char *) purple_core_get_version(), 1); //Version of client
b44d7b66 H	201	}
	202
	203	PURPLE_INIT_PLUGIN(autoanswer, init_plugin, info)