3 #define ANSWERSCRIPT_EXT ""
5 #define ANSWERSCRIPT_EXT ".exe"
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-"
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>
34 char *hook_script
= NULL
;
38 PurpleConversation
*conv
;
41 int answerscripts_process_message_cb(answerscripts_job
*job
) {
43 char response
[ANSWERSCRIPTS_LINE_LENGTH
+1]; response
[0]='\0';
44 FILE *pipe
= job
->pipe
;
45 PurpleConversation
*conv
= job
->conv
;
47 if (pipe
&& !feof(pipe
)) {
48 if(!fgets(response
, ANSWERSCRIPTS_LINE_LENGTH
, pipe
)
49 && (errno
== EWOULDBLOCK
|| errno
== EAGAIN
) //WARNING! Not compatible with windows :-(
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
);
55 if(!feof(pipe
)) return 1;
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
);
67 message
= purple_markup_strip_html(buffer
);
70 const char* local_alias
= purple_account_get_alias(account
);
71 const char* local_name
= (char *) purple_account_get_name_for_display(account
);
73 //REMOTE USER (Buddy):
74 //Here are prototypes of some functions interesting to implement github feature request #3
75 //const char * purple_contact_get_alias (PurpleContact *contact)
77 const char* remote_name = purple_buddy_get_name(buddy); //correct name to display for a blist chat
78 const char* remote_alias_only = purple_buddy_get_alias_only(buddy); //NULL
79 const char* remote_server_alias = purple_buddy_get_server_alias(buddy); //NULL
80 const char* remote_contact_alias = purple_buddy_get_contact_alias(buddy); //NULL
81 const char* remote_local_alias = purple_buddy_get_local_alias(buddy); //buddy's alias; buddy's contact alias; buddy's user name.
84 setenv(ENV_PREFIX "REMOTE_NAME", remote_name, 1); //???
85 setenv(ENV_PREFIX "REMOTE_ALIAS_ONLY", remote_alias_only, 1); //buggy
86 setenv(ENV_PREFIX "REMOTE_SERVER_ALIAS", remote_server_alias, 1); //buggy
87 setenv(ENV_PREFIX "REMOTE_CONTACT_ALIAS", remote_contact_alias, 1); //buggy
88 setenv(ENV_PREFIX "REMOTE_LOCAL_ALIAS", remote_local_alias, 1); //???
92 const char* remote_alias
= purple_buddy_get_alias(buddy
);
93 if(remote_alias
== NULL
) remote_alias
= "";
96 PurpleGroup
*group
= purple_buddy_get_group(buddy
);
97 const char *from_group
= group
!= NULL
? purple_group_get_name(group
) : ""; //return empty string if not in group
100 const char *protocol_id
= purple_account_get_protocol_id(account
);
101 if(!strncmp(protocol_id
,PROTOCOL_PREFIX
,strlen(PROTOCOL_PREFIX
))) protocol_id
+= strlen(PROTOCOL_PREFIX
); //trim out PROTOCOL_PREFIX (eg.: "prpl-irc" => "irc")
104 PurpleStatus
*status
= purple_account_get_active_status(account
);
105 PurpleStatusType
*type
= purple_status_get_type(status
);
108 const char *status_id
= NULL
;
109 status_id
= purple_primitive_get_id_from_type(purple_status_type_get_primitive(type
));
112 const char *status_msg
= NULL
;
113 if (purple_status_type_get_attr(type
, "message") != NULL
) {
114 status_msg
= purple_status_get_attr_string(status
, "message");
116 status_msg
= (char *) purple_savedstatus_get_message(purple_savedstatus_get_current());
119 //Export variables to environment
120 setenv(ENV_PREFIX
"ACTION", "IM", 1); //what happend: im, chat, show setting dialog, event, etc...
121 setenv(ENV_PREFIX
"MSG", message
, 1); //text of the message
122 setenv(ENV_PREFIX
"PROTOCOL", protocol_id
, 1); //protocol used to deliver the message. eg.: xmpp, irc,...
123 setenv(ENV_PREFIX
"R_NAME", who
, 1); //ID of remote user - "buddy"
124 setenv(ENV_PREFIX
"R_GROUP", from_group
, 1); //group which contains that buddy OR empty string
125 setenv(ENV_PREFIX
"R_ALIAS", remote_alias
, 1); //buddy's alias, server alias, contact alias, username OR empty string
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
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
);
141 int fflags
= fcntl(fileno(job
->pipe
), F_GETFL
, 0);
142 fcntl(fileno(job
->pipe
), F_SETFL
, fflags
| O_NONBLOCK
);
144 //WARNING! Somehow implement FILE_FLAG_OVERLAPPED & FILE_FLAG_NO_BUFFERING support on windows
147 purple_timeout_add(ANSWERSCRIPTS_TIMEOUT_INTERVAL
, (GSourceFunc
) answerscripts_process_message_cb
, (gpointer
) job
);
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
);
157 static gboolean
plugin_unload(PurplePlugin
* plugin
) {
162 static PurplePluginInfo info
= {
164 PURPLE_MAJOR_VERSION
,
165 PURPLE_MINOR_VERSION
,
166 PURPLE_PLUGIN_STANDARD
,
170 PURPLE_PRIORITY_DEFAULT
,
172 "core-answerscripts",
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"
184 "Tomas Mudrunka <harvie@email.cz>",
185 "http://github.com/harvie/libpurple-core-answerscripts",
200 static void init_plugin(PurplePlugin
* plugin
) {
201 //Export static environment variables
202 setenv(ENV_PREFIX
"L_AGENT", (char *) purple_core_get_ui(), 1); //ID of IM client used with answerscripts
203 setenv(ENV_PREFIX
"L_AGENT_VERSION", (char *) purple_core_get_version(), 1); //Version of client
206 PURPLE_INIT_PLUGIN(autoanswer
, init_plugin
, info
)