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