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