Cleaned up comments a bit
[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];
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 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* purple_account_get_alias ( const PurpleAccount * account )
73 const gchar* purple_account_get_name_for_display ( const PurpleAccount * account )
74 REMOTE USER (Buddy):
75 const char * purple_contact_get_alias (PurpleContact *contact)
76 const char * purple_buddy_get_name (const PurpleBuddy *buddy)
77 const char * purple_buddy_get_alias_only (PurpleBuddy *buddy)
78 const char * purple_buddy_get_server_alias (PurpleBuddy *buddy)
79 const char * purple_buddy_get_contact_alias (PurpleBuddy *buddy)
80 const char * purple_buddy_get_local_alias (PurpleBuddy *buddy)
81 const char * purple_buddy_get_alias (PurpleBuddy *buddy)
82 PurpleGroup * purple_buddy_get_group (PurpleBuddy *buddy)
83 const char * purple_group_get_name (PurpleGroup *group)
84 */
85
86 //Get buddy group
87 const char *from_group = purple_group_get_name(purple_buddy_get_group(buddy));
88
89 //Get protocol ID
90 const char *protocol_id = purple_account_get_protocol_id(account);
91 if(!strncmp(protocol_id,PROTOCOL_PREFIX,strlen(PROTOCOL_PREFIX))) protocol_id += strlen(PROTOCOL_PREFIX); //trim out PROTOCOL_PREFIX (eg.: "prpl-irc" => "irc")
92
93 //Get status
94 PurpleStatus *status = purple_account_get_active_status(account);
95 PurpleStatusType *type = purple_status_get_type(status);
96
97 //Get status id
98 const char *status_id = NULL;
99 status_id = purple_primitive_get_id_from_type(purple_status_type_get_primitive(type));
100
101 //Get status message
102 const char *status_msg = NULL;
103 if (purple_status_type_get_attr(type, "message") != NULL) {
104 status_msg = purple_status_get_attr_string(status, "message");
105 } else {
106 status_msg = (char *) purple_savedstatus_get_message(purple_savedstatus_get_current());
107 }
108
109 //Export variables to environment
110 setenv(ENV_PREFIX "MSG", message, 1);
111 setenv(ENV_PREFIX "FROM", who, 1);
112 setenv(ENV_PREFIX "FROM_GROUP", from_group, 1);
113 setenv(ENV_PREFIX "PROTOCOL", protocol_id, 1);
114 setenv(ENV_PREFIX "STATUS", status_id, 1);
115 setenv(ENV_PREFIX "STATUS_MSG", status_msg, 1);
116
117 //Launch job on background
118 answerscripts_job *job = (answerscripts_job*) malloc(sizeof(answerscripts_job));
119 job->pipe = popen(hook_script, "r");
120 job->conv = conv;
121
122 #ifndef __WIN32__
123 int fflags = fcntl(fileno(job->pipe), F_GETFL, 0);
124 fcntl(fileno(job->pipe), F_SETFL, fflags | O_NONBLOCK);
125 #else
126 //WARNING! Somehow implement FILE_FLAG_OVERLAPPED & FILE_FLAG_NO_BUFFERING support on windows
127 #endif
128
129 purple_timeout_add(ANSWERSCRIPTS_TIMEOUT_INTERVAL, (GSourceFunc) answerscripts_process_message_cb, (gpointer) job);
130 }
131
132 static gboolean plugin_load(PurplePlugin * plugin) {
133 asprintf(&hook_script,"%s/%s",purple_user_dir(),ANSWERSCRIPT);
134 void *conv_handle = purple_conversations_get_handle();
135 purple_signal_connect(conv_handle, "received-im-msg", plugin, PURPLE_CALLBACK(received_im_msg_cb), NULL);
136 return TRUE;
137 }
138
139 static gboolean plugin_unload(PurplePlugin * plugin) {
140 free(hook_script);
141 return TRUE;
142 }
143
144 static PurplePluginInfo info = {
145 PURPLE_PLUGIN_MAGIC,
146 PURPLE_MAJOR_VERSION,
147 PURPLE_MINOR_VERSION,
148 PURPLE_PLUGIN_STANDARD,
149 NULL,
150 0,
151 NULL,
152 PURPLE_PRIORITY_DEFAULT,
153
154 "core-answerscripts",
155 "AnswerScripts",
156 "0.3.1",
157 "Framework for hooking scripts to process received messages for libpurple clients",
158 "\nThis plugin will execute script \"~/.purple/" ANSWERSCRIPT "\" "
159 "(or any other executable called \"" ANSWERSCRIPT "\" and found in purple_user_dir()) "
160 "each time when instant message is received.\n"
161 "\n- Any text printed to STDOUT by this script will be sent back as answer to received message."
162 "\n- Following environment values will be set, so script can use them for responding:\n"
163 "\t- ANSW_MSG\n"
164 "\t- ANSW_FROM\n"
165 "\t- ANSW_PROTOCOL\n"
166 "\t- ANSW_STATUS\n"
167 "\t- ANSW_STATUS_MSG\n"
168 "\nPlease see sample scripts, documentation, website and source code for more informations...\n"
169 "\n(-; Peace ;-)\n",
170 "Tomas Mudrunka <harvie@email.cz>",
171 "http://github.com/harvie/libpurple-core-answerscripts",
172
173 plugin_load,
174 plugin_unload,
175 NULL,
176 NULL,
177 NULL,
178 NULL,
179 NULL,
180 NULL,
181 NULL,
182 NULL,
183 NULL
184 };
185
186 static void init_plugin(PurplePlugin * plugin) {
187
188 }
189
190 PURPLE_INIT_PLUGIN(autoanswer, init_plugin, info)
This page took 0.311521 seconds and 5 git commands to generate.