Doc update
[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
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
55 if(!feof(pipe)) return 1;
d852a694
H
56 }
57 pclose(pipe);
6ec3c19f
H
58 free(job);
59 return 0;
d852a694
H
60}
61
15117484 62static void received_msg_cb(PurpleAccount *account, char *who, char *buffer, PurpleConversation *conv, PurpleMessageFlags flags, void *data) {
73f7c2ff 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: */
15117484 64
6b8234e8 65 PurpleBuddy *buddy = purple_find_buddy(account, who);
e2bf984e 66 PurplePresence *presence = purple_buddy_get_presence(buddy);
b44d7b66 67
ca489436
H
68 //Get message
69 message = purple_markup_strip_html(buffer);
b44d7b66 70
15117484
TM
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
96150021 87 //LOCAL USER:
96150021 88 const char* local_name = (char *) purple_account_get_name_for_display(account);
15117484
TM
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";
96150021
H
98
99 //REMOTE USER (Buddy):
b1866b8c
H
100
101 //Get buddy alias
102 const char* remote_alias = purple_buddy_get_alias(buddy);
15117484
TM
103 if(remote_alias == NULL) remote_alias = who;
104 //if(remote_alias == NULL) remote_alias = "";
c77055a9 105
6b8234e8 106 //Get buddy group
2c80caf3
H
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
6b8234e8 109
2bcad731
H
110 //Get protocol ID
111 const char *protocol_id = purple_account_get_protocol_id(account);
5b15396b 112 if(!strncmp(protocol_id,PROTOCOL_PREFIX,strlen(PROTOCOL_PREFIX))) protocol_id += strlen(PROTOCOL_PREFIX); //trim out PROTOCOL_PREFIX (eg.: "prpl-irc" => "irc")
2bcad731 113
7a45e05c
H
114 //Get status
115 PurpleStatus *status = purple_account_get_active_status(account);
116 PurpleStatusType *type = purple_status_get_type(status);
973a91a2
H
117 //remote
118 PurpleStatus *r_status = purple_presence_get_active_status(presence);
119 PurpleStatusType *r_status_type = purple_status_get_type(r_status);
7a45e05c
H
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));
973a91a2
H
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));
7a45e05c
H
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 }
973a91a2
H
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 }
7a45e05c 142
ca489436 143 //Export variables to environment
15117484 144 setenv(ENV_PREFIX "ACTION", action, 1); //what happend: IM/CHAT/UNKNOWN, show setting dialog, event, etc...
7f54aeea 145 setenv(ENV_PREFIX "MSG", message, 1); //text of the message
15117484 146 setenv(ENV_PREFIX "MSG_HIGHLIGHTED", highlighted, 1); //was my nick mentioned in message? true/false
7f54aeea 147 setenv(ENV_PREFIX "PROTOCOL", protocol_id, 1); //protocol used to deliver the message. eg.: xmpp, irc,...
b1866b8c
H
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
15117484 150 setenv(ENV_PREFIX "R_ALIAS", remote_alias, 1); //buddy's OPTIONAL alias, server alias, contact alias, username OR empty string
973a91a2 151 setenv(ENV_PREFIX "R_STATUS", r_status_id, 1); //unique ID of remote user's status. eg.: available, away,...
15117484 152 setenv(ENV_PREFIX "R_ROOM_NAME", roomname, 1); //Chatroom name
973a91a2 153 setenv(ENV_PREFIX "R_STATUS_MSG", r_status_msg, 1); //status message set by your buddy
b1866b8c 154 setenv(ENV_PREFIX "L_NAME", local_name, 1); //ID of local user
15117484 155 setenv(ENV_PREFIX "L_ALIAS", local_alias, 1); //OPTIONAL alias of local user OR empty string
b1866b8c
H
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
6ec3c19f 158
ca489436 159 //Launch job on background
6ec3c19f
H
160 answerscripts_job *job = (answerscripts_job*) malloc(sizeof(answerscripts_job));
161 job->pipe = popen(hook_script, "r");
d94bfdb4
H
162 if(job->pipe == NULL) {
163 fprintf(stderr,"Can't execute %s\n", hook_script);
164 return;
165 }
6ec3c19f
H
166 job->conv = conv;
167
81749a99
H
168 #ifndef __WIN32__
169 int fflags = fcntl(fileno(job->pipe), F_GETFL, 0);
170 fcntl(fileno(job->pipe), F_SETFL, fflags | O_NONBLOCK);
b86255fd
H
171 #else
172 //WARNING! Somehow implement FILE_FLAG_OVERLAPPED & FILE_FLAG_NO_BUFFERING support on windows
81749a99
H
173 #endif
174
175 purple_timeout_add(ANSWERSCRIPTS_TIMEOUT_INTERVAL, (GSourceFunc) answerscripts_process_message_cb, (gpointer) job);
b44d7b66
H
176}
177
b44d7b66 178static gboolean plugin_load(PurplePlugin * plugin) {
6ec3c19f 179 asprintf(&hook_script,"%s/%s",purple_user_dir(),ANSWERSCRIPT);
b44d7b66 180 void *conv_handle = purple_conversations_get_handle();
15117484
TM
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);
53478f8c 183 return TRUE;
b44d7b66
H
184}
185
186static gboolean plugin_unload(PurplePlugin * plugin) {
187 free(hook_script);
53478f8c 188 return TRUE;
b44d7b66
H
189}
190
191static 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
15117484
TM
201 "core-answerscripts",
202 "AnswerScripts",
203 "0.5.2",
53478f8c 204 "Framework for hooking scripts to process received messages for libpurple clients",
37436d76
H
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"
b1866b8c 210 "\t- " ENV_PREFIX "* (see documentation or env for more)\n"
37436d76
H
211 "\nPlease see sample scripts, documentation, website and source code for more informations...\n"
212 "\n(-; Peace ;-)\n",
15117484 213 "Tomas Mudrunka <harviecz@gmail.cz>",
53478f8c 214 "http://github.com/harvie/libpurple-core-answerscripts",
b44d7b66
H
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
229static void init_plugin(PurplePlugin * plugin) {
b9de4161 230 //Export static environment variables
15117484 231 #ifndef __x86_64__ //Workaround for x86_64 (where this causes problems for unknown reason)
544840fd
H
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
b44d7b66
H
237}
238
239PURPLE_INIT_PLUGIN(autoanswer, init_plugin, info)
This page took 0.471598 seconds and 4 git commands to generate.