Added notes for future porting to windows

[mirrors/libpurple-core-answerscripts.git] / answerscripts.c

diff --git a/answerscripts.c b/answerscripts.c
index 9bbdf05e1a6b9de34959e79ad204364527777053..f84dcc6c00352f760948234b4080a2ab5abe9b24 100755 (executable)
--- a/answerscripts.c
+++ b/answerscripts.c
@@ -7,14 +7,18 @@
 #define ANSWERSCRIPT "answerscripts" ANSWERSCRIPT_EXT
 #define ANSWERSCRIPTS_TIMEOUT_INTERVAL 250
 #define ANSWERSCRIPTS_LINE_LENGTH 4096
-#define ENV_PREFIX "PURPLE_"
+#define ENV_PREFIX "ANSW_"
+#define PROTOCOL_PREFIX "prpl-"
 
 #include <stdio.h>
 #include <stdlib.h>
 #include <errno.h>
+#include <string.h>
 
 #ifndef __WIN32__
        #include <fcntl.h>
+#else
+       #include <windows.h>
 #endif
 
 /* Purple plugin */
@@ -42,7 +46,7 @@ int answerscripts_process_message_cb(answerscripts_job *job) {
 
        if (pipe && !feof(pipe)) {
                if(!fgets(response, ANSWERSCRIPTS_LINE_LENGTH, pipe)
-                       && (errno == EWOULDBLOCK || errno == EAGAIN)
+                       && (errno == EWOULDBLOCK || errno == EAGAIN) //WARNING! Not compatible with windows :-(
                ) return 1;
 
                for(i=0;response[i];i++) if(response[i]=='\n') response[i]=0;
@@ -63,6 +67,10 @@ static void received_im_msg_cb(PurpleAccount *account, char *who, char *buffer,
        //printf("\nHarvie received: %s: %s\n", who, message); //debug
        //purple_conv_im_send(purple_conversation_get_im_data(conv), ":-*"); //debug
 
+       //Get protocol ID
+       const char *protocol_id = purple_account_get_protocol_id(account);
+       if(!strncmp(protocol_id,PROTOCOL_PREFIX,strlen(PROTOCOL_PREFIX))) protocol_id += strlen(PROTOCOL_PREFIX); //trim out protocol prefix (eg.: "prpl-irc" => "irc")
+
        //Get status
        PurpleStatus *status = purple_account_get_active_status(account);
        PurpleStatusType *type = purple_status_get_type(status);
@@ -80,8 +88,9 @@ static void received_im_msg_cb(PurpleAccount *account, char *who, char *buffer,
        }
 
        //Export variables to environment
-       setenv(ENV_PREFIX "FROM", who, 1);
        setenv(ENV_PREFIX "MSG", message, 1);
+       setenv(ENV_PREFIX "FROM", who, 1);
+       setenv(ENV_PREFIX "PROTOCOL", protocol_id, 1);
        setenv(ENV_PREFIX "STATUS", status_id, 1);
        setenv(ENV_PREFIX "STATUS_MSG", status_msg, 1);
 
@@ -93,6 +102,8 @@ static void received_im_msg_cb(PurpleAccount *account, char *who, char *buffer,
        #ifndef __WIN32__
                int fflags = fcntl(fileno(job->pipe), F_GETFL, 0);
                fcntl(fileno(job->pipe), F_SETFL, fflags | O_NONBLOCK);
+       #else
+               //WARNING! Somehow implement FILE_FLAG_OVERLAPPED & FILE_FLAG_NO_BUFFERING support on windows
        #endif
 
        purple_timeout_add(ANSWERSCRIPTS_TIMEOUT_INTERVAL, (GSourceFunc) answerscripts_process_message_cb, (gpointer) job);
@@ -122,16 +133,21 @@ static PurplePluginInfo info = {
 
        "core-answerscripts",
        "AnswerScripts",
-       "0.2.2",
+       "0.3.1",
        "Framework for hooking scripts to process received messages for libpurple clients",
-       "This plugin will execute script ~/.purple/" ANSWERSCRIPT " "
-               "or any other executable called  " ANSWERSCRIPT " and found in purple_user_dir() "
-               "for each single instant message received.\n"
-               "\n- Envinronment values PURPLE_MSG and PURPLE_FROM will be set to carry "
-               "informations about message text and sender so script can respond to that message."
-               "\n- Any text printed to STDOUT by the script will be sent back as answer to message."
-               "\n\nPlease see example scripts, documentation or source code for more informations...",
-       "Harvie <harvie@email.cz>",
+       "\nThis plugin will execute script \"~/.purple/" ANSWERSCRIPT "\" "
+               "(or any other executable called \"" ANSWERSCRIPT "\" and found in purple_user_dir()) "
+               "each time when instant message is received.\n"
+               "\n- Any text printed to STDOUT by this script will be sent back as answer to received message."
+               "\n- Following environment values will be set, so script can use them for responding:\n"
+               "\t- ANSW_MSG\n"
+               "\t- ANSW_FROM\n"
+               "\t- ANSW_PROTOCOL\n"
+               "\t- ANSW_STATUS\n"
+               "\t- ANSW_STATUS_MSG\n"
+               "\nPlease see sample scripts, documentation, website and source code for more informations...\n"
+               "\n(-; Peace ;-)\n",
+       "Tomas Mudrunka <harvie@email.cz>",
        "http://github.com/harvie/libpurple-core-answerscripts",
 
        plugin_load,