[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_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);
	PurplePresence *presence = purple_buddy_get_presence(buddy);

	//Get message
	message = purple_markup_strip_html(buffer);

	//Get conversation type
	const char *action, *roomname;
	switch(purple_conversation_get_type(conv)) {
		case PURPLE_CONV_TYPE_IM:
			action = "IM";
			roomname = "";
			break;
		case PURPLE_CONV_TYPE_CHAT:
			action = "CHAT";
			roomname = purple_conversation_get_name(conv);
			//PurpleConvChat *chat = purple_conversation_get_chat_data(conv);
			break;
		default:
			action = "UNKNOWN";
	}

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

	//Was my nick said?
	char *highlighted;
	if(flags & PURPLE_MESSAGE_NICK || purple_utf8_has_word(buffer, local_name))
		highlighted = "true";
	else
		highlighted = "false";

	//REMOTE USER (Buddy):

	//Get buddy alias
	const char* remote_alias = purple_buddy_get_alias(buddy);
	if(remote_alias == NULL) remote_alias = who;
	//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);
	//remote
	PurpleStatus *r_status = purple_presence_get_active_status(presence);
	PurpleStatusType *r_status_type =	purple_status_get_type(r_status);

	//Get status id
	const char *status_id = NULL;
	status_id = purple_primitive_get_id_from_type(purple_status_type_get_primitive(type));
	//remote
	const char *r_status_id = NULL;
	r_status_id = purple_primitive_get_id_from_type(purple_status_type_get_primitive(r_status_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());
	}
	//remote
	const char *r_status_msg = NULL;
	if (purple_status_type_get_attr(r_status_type, "message") != NULL) {
		r_status_msg = purple_status_get_attr_string(r_status, "message");
	} else {
		r_status_msg = "";
	}

	//Export variables to environment
	setenv(ENV_PREFIX "ACTION", action, 1);	//what happend: IM/CHAT/UNKNOWN, show setting dialog, event, etc...
	setenv(ENV_PREFIX "MSG", message, 1);	//text of the message
	setenv(ENV_PREFIX "MSG_HIGHLIGHTED", highlighted, 1);	//was my nick mentioned in message? true/false
	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 OPTIONAL alias, server alias, contact alias, username OR empty string
	setenv(ENV_PREFIX "R_STATUS", r_status_id, 1);	//unique ID of remote user's status. eg.: available, away,...
	setenv(ENV_PREFIX "R_ROOM_NAME", roomname, 1);	//Chatroom name
	setenv(ENV_PREFIX "R_STATUS_MSG", r_status_msg, 1);	//status message set by your buddy
	setenv(ENV_PREFIX "L_NAME", local_name, 1);	//ID of local user
	setenv(ENV_PREFIX "L_ALIAS", local_alias, 1);	//OPTIONAL 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_msg_cb), NULL);
	purple_signal_connect(conv_handle, "received-chat-msg", plugin, PURPLE_CALLBACK(received_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.5.2",
	"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 <harviecz@gmail.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
	#ifndef __x86_64__ //Workaround for x86_64 (where this causes problems for unknown reason)
		const char * core_ui = purple_core_get_ui() != 0 ? (const char *) purple_core_get_ui() : "";
		const char * core_version = purple_core_get_version() != 0 ? (const char *) purple_core_get_version() : "";
		setenv(ENV_PREFIX "L_AGENT", (char *) core_ui, 1);	//ID of IM client used with answerscripts
		setenv(ENV_PREFIX "L_AGENT_VERSION", (char *) core_version, 1);	//Version of client
	#endif
}

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_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
	65	PurpleBuddy *buddy = purple_find_buddy(account, who);
	66	PurplePresence *presence = purple_buddy_get_presence(buddy);
	67
	68	//Get message
	69	message = purple_markup_strip_html(buffer);
	70
	71	//Get conversation type
	72	const char action, roomname;
	73	switch(purple_conversation_get_type(conv)) {
	74	case PURPLE_CONV_TYPE_IM:
	75	action = "IM";
	76	roomname = "";
	77	break;
	78	case PURPLE_CONV_TYPE_CHAT:
	79	action = "CHAT";
	80	roomname = purple_conversation_get_name(conv);
	81	//PurpleConvChat *chat = purple_conversation_get_chat_data(conv);
	82	break;
	83	default:
	84	action = "UNKNOWN";
	85	}
	86
	87	//LOCAL USER:
	88	const char* local_name = (char *) purple_account_get_name_for_display(account);
	89	const char* local_alias = purple_account_get_alias(account);
	90	if(local_alias == NULL) local_alias = local_name;
	91
	92	//Was my nick said?
	93	char *highlighted;
	94	if(flags & PURPLE_MESSAGE_NICK \|\| purple_utf8_has_word(buffer, local_name))
	95	highlighted = "true";
	96	else
	97	highlighted = "false";
	98
	99	//REMOTE USER (Buddy):
	100
	101	//Get buddy alias
	102	const char* remote_alias = purple_buddy_get_alias(buddy);
	103	if(remote_alias == NULL) remote_alias = who;
	104	//if(remote_alias == NULL) remote_alias = "";
	105
	106	//Get buddy group
	107	PurpleGroup *group = purple_buddy_get_group(buddy);
	108	const char *from_group = group != NULL ? purple_group_get_name(group) : ""; //return empty string if not in group
	109
	110	//Get protocol ID
	111	const char *protocol_id = purple_account_get_protocol_id(account);
	112	if(!strncmp(protocol_id,PROTOCOL_PREFIX,strlen(PROTOCOL_PREFIX))) protocol_id += strlen(PROTOCOL_PREFIX); //trim out PROTOCOL_PREFIX (eg.: "prpl-irc" => "irc")
	113
	114	//Get status
	115	PurpleStatus *status = purple_account_get_active_status(account);
	116	PurpleStatusType *type = purple_status_get_type(status);
	117	//remote
	118	PurpleStatus *r_status = purple_presence_get_active_status(presence);
	119	PurpleStatusType *r_status_type = purple_status_get_type(r_status);
	120
	121	//Get status id
	122	const char *status_id = NULL;
	123	status_id = purple_primitive_get_id_from_type(purple_status_type_get_primitive(type));
	124	//remote
	125	const char *r_status_id = NULL;
	126	r_status_id = purple_primitive_get_id_from_type(purple_status_type_get_primitive(r_status_type));
	127
	128	//Get status message
	129	const char *status_msg = NULL;
	130	if (purple_status_type_get_attr(type, "message") != NULL) {
	131	status_msg = purple_status_get_attr_string(status, "message");
	132	} else {
	133	status_msg = (char *) purple_savedstatus_get_message(purple_savedstatus_get_current());
	134	}
	135	//remote
	136	const char *r_status_msg = NULL;
	137	if (purple_status_type_get_attr(r_status_type, "message") != NULL) {
	138	r_status_msg = purple_status_get_attr_string(r_status, "message");
	139	} else {
	140	r_status_msg = "";
	141	}
	142
	143	//Export variables to environment
	144	setenv(ENV_PREFIX "ACTION", action, 1); //what happend: IM/CHAT/UNKNOWN, show setting dialog, event, etc...
	145	setenv(ENV_PREFIX "MSG", message, 1); //text of the message
	146	setenv(ENV_PREFIX "MSG_HIGHLIGHTED", highlighted, 1); //was my nick mentioned in message? true/false
	147	setenv(ENV_PREFIX "PROTOCOL", protocol_id, 1); //protocol used to deliver the message. eg.: xmpp, irc,...
	148	setenv(ENV_PREFIX "R_NAME", who, 1); //ID of remote user - "buddy"
	149	setenv(ENV_PREFIX "R_GROUP", from_group, 1); //group which contains that buddy OR empty string
	150	setenv(ENV_PREFIX "R_ALIAS", remote_alias, 1); //buddy's OPTIONAL alias, server alias, contact alias, username OR empty string
	151	setenv(ENV_PREFIX "R_STATUS", r_status_id, 1); //unique ID of remote user's status. eg.: available, away,...
	152	setenv(ENV_PREFIX "R_ROOM_NAME", roomname, 1); //Chatroom name
	153	setenv(ENV_PREFIX "R_STATUS_MSG", r_status_msg, 1); //status message set by your buddy
	154	setenv(ENV_PREFIX "L_NAME", local_name, 1); //ID of local user
	155	setenv(ENV_PREFIX "L_ALIAS", local_alias, 1); //OPTIONAL alias of local user OR empty string
	156	setenv(ENV_PREFIX "L_STATUS", status_id, 1); //unique ID of local user's status. eg.: available, away,...
	157	setenv(ENV_PREFIX "L_STATUS_MSG", status_msg, 1); //status message set by local user
	158
	159	//Launch job on background
	160	answerscripts_job job = (answerscripts_job) malloc(sizeof(answerscripts_job));
	161	job->pipe = popen(hook_script, "r");
	162	if(job->pipe == NULL) {
	163	fprintf(stderr,"Can't execute %s\n", hook_script);
	164	return;
	165	}
	166	job->conv = conv;
	167
	168	#ifndef __WIN32__
	169	int fflags = fcntl(fileno(job->pipe), F_GETFL, 0);
	170	fcntl(fileno(job->pipe), F_SETFL, fflags \| O_NONBLOCK);
	171	#else
	172	//WARNING! Somehow implement FILE_FLAG_OVERLAPPED & FILE_FLAG_NO_BUFFERING support on windows
	173	#endif
	174
	175	purple_timeout_add(ANSWERSCRIPTS_TIMEOUT_INTERVAL, (GSourceFunc) answerscripts_process_message_cb, (gpointer) job);
	176	}
	177
	178	static gboolean plugin_load(PurplePlugin * plugin) {
	179	asprintf(&hook_script,"%s/%s",purple_user_dir(),ANSWERSCRIPT);
	180	void *conv_handle = purple_conversations_get_handle();
	181	purple_signal_connect(conv_handle, "received-im-msg", plugin, PURPLE_CALLBACK(received_msg_cb), NULL);
	182	purple_signal_connect(conv_handle, "received-chat-msg", plugin, PURPLE_CALLBACK(received_msg_cb), NULL);
	183	return TRUE;
	184	}
	185
	186	static gboolean plugin_unload(PurplePlugin * plugin) {
	187	free(hook_script);
	188	return TRUE;
	189	}
	190
	191	static PurplePluginInfo info = {
	192	PURPLE_PLUGIN_MAGIC,
	193	PURPLE_MAJOR_VERSION,
	194	PURPLE_MINOR_VERSION,
	195	PURPLE_PLUGIN_STANDARD,
	196	NULL,
	197	0,
	198	NULL,
	199	PURPLE_PRIORITY_DEFAULT,
	200
	201	"core-answerscripts",
	202	"AnswerScripts",
	203	"0.5.2",
	204	"Framework for hooking scripts to process received messages for libpurple clients",
	205	"\nThis plugin will execute script \"~/.purple/" ANSWERSCRIPT "\" "
	206	"(or any other executable called \"" ANSWERSCRIPT "\" and found in purple_user_dir()) "
	207	"each time when instant message is received.\n"
	208	"\n- Any text printed to STDOUT by this script will be sent back as answer to received message."
	209	"\n- Following environment values will be set, so script can use them for responding:\n"
	210	"\t- " ENV_PREFIX "* (see documentation or env for more)\n"
	211	"\nPlease see sample scripts, documentation, website and source code for more informations...\n"
	212	"\n(-; Peace ;-)\n",
	213	"Tomas Mudrunka <harviecz@gmail.cz>",
	214	"http://github.com/harvie/libpurple-core-answerscripts",
	215
	216	plugin_load,
	217	plugin_unload,
	218	NULL,
	219	NULL,
	220	NULL,
	221	NULL,
	222	NULL,
	223	NULL,
	224	NULL,
	225	NULL,
	226	NULL
	227	};
	228
	229	static void init_plugin(PurplePlugin * plugin) {
	230	//Export static environment variables
	231	#ifndef __x86_64__ //Workaround for x86_64 (where this causes problems for unknown reason)
	232	const char * core_ui = purple_core_get_ui() != 0 ? (const char *) purple_core_get_ui() : "";
	233	const char * core_version = purple_core_get_version() != 0 ? (const char *) purple_core_get_version() : "";
	234	setenv(ENV_PREFIX "L_AGENT", (char *) core_ui, 1); //ID of IM client used with answerscripts
	235	setenv(ENV_PREFIX "L_AGENT_VERSION", (char *) core_version, 1); //Version of client
	236	#endif
	237	}
	238
	239	PURPLE_INIT_PLUGIN(autoanswer, init_plugin, info)