main answerscript is now bit more resistant to IM floods
[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
66 //Get message
67 message = purple_markup_strip_html(buffer);
68
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);
74 setenv(ENV_PREFIX "LOCAL_NAME", local_name, 1); //Name of local user - untested
75 setenv(ENV_PREFIX "LOCAL_ALIAS", local_alias, 1); //Alias of local user - untested
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);
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); //???
91
92 //Get buddy group
93 PurpleGroup *group = purple_buddy_get_group(buddy);
94 const char *from_group = group != NULL ? purple_group_get_name(group) : ""; //return empty string if not in group
95
96 //Get protocol ID
97 const char *protocol_id = purple_account_get_protocol_id(account);
98 if(!strncmp(protocol_id,PROTOCOL_PREFIX,strlen(PROTOCOL_PREFIX))) protocol_id += strlen(PROTOCOL_PREFIX); //trim out PROTOCOL_PREFIX (eg.: "prpl-irc" => "irc")
99
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
116 //Export variables to environment
117 setenv(ENV_PREFIX "MSG", message, 1); //text of the message
118 setenv(ENV_PREFIX "FROM", who, 1); //who sent you the message
119 setenv(ENV_PREFIX "FROM_GROUP", from_group, 1); //group which contains that buddy
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
123
124 //Launch job on background
125 answerscripts_job *job = (answerscripts_job*) malloc(sizeof(answerscripts_job));
126 job->pipe = popen(hook_script, "r");
127 if(job->pipe == NULL) {
128 fprintf(stderr,"Can't execute %s\n", hook_script);
129 return;
130 }
131 job->conv = conv;
132
133 #ifndef __WIN32__
134 int fflags = fcntl(fileno(job->pipe), F_GETFL, 0);
135 fcntl(fileno(job->pipe), F_SETFL, fflags | O_NONBLOCK);
136 #else
137 //WARNING! Somehow implement FILE_FLAG_OVERLAPPED & FILE_FLAG_NO_BUFFERING support on windows
138 #endif
139
140 purple_timeout_add(ANSWERSCRIPTS_TIMEOUT_INTERVAL, (GSourceFunc) answerscripts_process_message_cb, (gpointer) job);
141 }
142
143 static gboolean plugin_load(PurplePlugin * plugin) {
144 asprintf(&hook_script,"%s/%s",purple_user_dir(),ANSWERSCRIPT);
145 void *conv_handle = purple_conversations_get_handle();
146 purple_signal_connect(conv_handle, "received-im-msg", plugin, PURPLE_CALLBACK(received_im_msg_cb), NULL);
147 return TRUE;
148 }
149
150 static gboolean plugin_unload(PurplePlugin * plugin) {
151 free(hook_script);
152 return TRUE;
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",
167 "0.3.1",
168 "Framework for hooking scripts to process received messages for libpurple clients",
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>",
182 "http://github.com/harvie/libpurple-core-answerscripts",
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) {
198 //Export static environment variables
199 setenv(ENV_PREFIX "AGENT", (char *) purple_core_get_ui(), 1); //ID of IM client used with answerscripts
200 setenv(ENV_PREFIX "AGENT_VERSION", (char *) purple_core_get_version(), 1); //Version of client
201 }
202
203 PURPLE_INIT_PLUGIN(autoanswer, init_plugin, info)
This page took 0.810547 seconds and 4 git commands to generate.