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];
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 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: */
66 message
= purple_markup_strip_html(buffer
);
67 //printf("\nHarvie received: %s: %s\n", who, message); //debug
68 //purple_conv_im_send(purple_conversation_get_im_data(conv), ":-*"); //debug
70 /* Here are prototypes of some functions interesting to implement github feature request #3
73 const char* purple_account_get_alias ( const PurpleAccount * account )
74 const gchar* purple_account_get_name_for_display ( const PurpleAccount * account )
76 const char * purple_contact_get_alias (PurpleContact *contact)
77 const char * purple_buddy_get_name (const PurpleBuddy *buddy)
78 const char * purple_buddy_get_alias_only (PurpleBuddy *buddy)
79 const char * purple_buddy_get_server_alias (PurpleBuddy *buddy)
80 const char * purple_buddy_get_contact_alias (PurpleBuddy *buddy)
81 const char * purple_buddy_get_local_alias (PurpleBuddy *buddy)
82 const char * purple_buddy_get_alias (PurpleBuddy *buddy)
83 PurpleGroup * purple_buddy_get_group (PurpleBuddy *buddy)
84 const char * purple_group_get_name (PurpleGroup *group)
88 const char *protocol_id
= purple_account_get_protocol_id(account
);
89 if(!strncmp(protocol_id
,PROTOCOL_PREFIX
,strlen(PROTOCOL_PREFIX
))) protocol_id
+= strlen(PROTOCOL_PREFIX
); //trim out protocol prefix (eg.: "prpl-irc" => "irc")
92 PurpleStatus
*status
= purple_account_get_active_status(account
);
93 PurpleStatusType
*type
= purple_status_get_type(status
);
96 const char *status_id
= NULL
;
97 status_id
= purple_primitive_get_id_from_type(purple_status_type_get_primitive(type
));
100 const char *status_msg
= NULL
;
101 if (purple_status_type_get_attr(type
, "message") != NULL
) {
102 status_msg
= purple_status_get_attr_string(status
, "message");
104 status_msg
= (char *) purple_savedstatus_get_message(purple_savedstatus_get_current());
107 //Export variables to environment
108 setenv(ENV_PREFIX
"MSG", message
, 1);
109 setenv(ENV_PREFIX
"FROM", who
, 1);
110 setenv(ENV_PREFIX
"PROTOCOL", protocol_id
, 1);
111 setenv(ENV_PREFIX
"STATUS", status_id
, 1);
112 setenv(ENV_PREFIX
"STATUS_MSG", status_msg
, 1);
114 //Launch job on background
115 answerscripts_job
*job
= (answerscripts_job
*) malloc(sizeof(answerscripts_job
));
116 job
->pipe
= popen(hook_script
, "r");
120 int fflags
= fcntl(fileno(job
->pipe
), F_GETFL
, 0);
121 fcntl(fileno(job
->pipe
), F_SETFL
, fflags
| O_NONBLOCK
);
123 //WARNING! Somehow implement FILE_FLAG_OVERLAPPED & FILE_FLAG_NO_BUFFERING support on windows
126 purple_timeout_add(ANSWERSCRIPTS_TIMEOUT_INTERVAL
, (GSourceFunc
) answerscripts_process_message_cb
, (gpointer
) job
);
129 static gboolean
plugin_load(PurplePlugin
* plugin
) {
130 asprintf(&hook_script
,"%s/%s",purple_user_dir(),ANSWERSCRIPT
);
131 void *conv_handle
= purple_conversations_get_handle();
132 purple_signal_connect(conv_handle
, "received-im-msg", plugin
, PURPLE_CALLBACK(received_im_msg_cb
), NULL
);
136 static gboolean
plugin_unload(PurplePlugin
* plugin
) {
141 static PurplePluginInfo info
= {
143 PURPLE_MAJOR_VERSION
,
144 PURPLE_MINOR_VERSION
,
145 PURPLE_PLUGIN_STANDARD
,
149 PURPLE_PRIORITY_DEFAULT
,
151 "core-answerscripts",
154 "Framework for hooking scripts to process received messages for libpurple clients",
155 "\nThis plugin will execute script \"~/.purple/" ANSWERSCRIPT
"\" "
156 "(or any other executable called \"" ANSWERSCRIPT
"\" and found in purple_user_dir()) "
157 "each time when instant message is received.\n"
158 "\n- Any text printed to STDOUT by this script will be sent back as answer to received message."
159 "\n- Following environment values will be set, so script can use them for responding:\n"
162 "\t- ANSW_PROTOCOL\n"
164 "\t- ANSW_STATUS_MSG\n"
165 "\nPlease see sample scripts, documentation, website and source code for more informations...\n"
167 "Tomas Mudrunka <harvie@email.cz>",
168 "http://github.com/harvie/libpurple-core-answerscripts",
183 static void init_plugin(PurplePlugin
* plugin
) {
187 PURPLE_INIT_PLUGIN(autoanswer
, init_plugin
, info
)