Fixed crash (NULL pointer dereference)
[mirrors/libpurple-core-answerscripts.git] / answerscripts.c
index 32fdabc..54b7576 100755 (executable)
@@ -1,32 +1,37 @@
 //#define __WIN32__
-#define PURPLE_PLUGINS
-
-/* Purple headers */
-#include <libpurple/debug.h>
-#include <libpurple/version.h>
-#include <libpurple/conversation.h>
-//#include <libpurple/log.h>
-#include <libpurple/plugin.h>
-//#include <libpurple/signals.h>
-#include <libpurple/util.h>
-#include <libpurple/notify.h>
+#ifndef __WIN32__
+       #define ANSWERSCRIPT_EXT ""
+#else
+       #define ANSWERSCRIPT_EXT ".exe"
+#endif
+#define ANSWERSCRIPT "answerscripts" ANSWERSCRIPT_EXT
+#define ANSWERSCRIPTS_TIMEOUT_INTERVAL 250
+#define ANSWERSCRIPTS_LINE_LENGTH 4096
+#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
 
-#define ANSWERSCRIPT "answerscripts.exe"
-#define ANSWERSCRIPTS_TIMEOUT_INTERVAL 250
-#define ANSWERSCRIPTS_LINE_LENGTH 4096
+/* Purple plugin */
+#define PURPLE_PLUGINS
+#include <libpurple/debug.h>
+#include <libpurple/version.h>
+#include <libpurple/conversation.h>
+#include <libpurple/plugin.h>
+#include <libpurple/signals.h>
+#include <libpurple/util.h>
 
-char *buff = NULL;
+char *message = NULL;
 char *hook_script = NULL;
-char response[ANSWERSCRIPTS_LINE_LENGTH+1];
-int i;
 
 typedef struct {
   FILE *pipe;
@@ -34,16 +39,18 @@ typedef struct {
 } answerscripts_job;
 
 int answerscripts_process_message_cb(answerscripts_job *job) {
+       int i;
+       char response[ANSWERSCRIPTS_LINE_LENGTH+1]; response[0]='\0';
        FILE *pipe = job->pipe;
        PurpleConversation *conv = job->conv;
 
        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;
-               purple_conv_im_send(purple_conversation_get_im_data(conv), response);
+               if(response[0]!='\0') purple_conv_im_send(purple_conversation_get_im_data(conv), response);
 
                if(!feof(pipe)) return 1;
        }
@@ -54,38 +61,88 @@ int answerscripts_process_message_cb(answerscripts_job *job) {
 
 static void received_im_msg_cb(PurpleAccount *account, char *who, char *buffer, PurpleConversation *conv, PurpleMessageFlags flags, void *data) {
        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: */
+       PurpleBuddy *buddy = purple_find_buddy(account, who);
+
+       //Get message
+       message = purple_markup_strip_html(buffer);
+
+       /* Here are prototypes of some functions interesting to implement github feature request #3
+
+       LOCAL USER:
+       const char* purple_account_get_alias    (       const PurpleAccount *            account         )
+       const gchar* purple_account_get_name_for_display        (       const PurpleAccount *            account         )
+       REMOTE USER (Buddy):
+       const char *    purple_contact_get_alias (PurpleContact *contact)
+       const char *    purple_buddy_get_name (const PurpleBuddy *buddy)
+       const char *    purple_buddy_get_alias_only (PurpleBuddy *buddy)
+       const char *    purple_buddy_get_server_alias (PurpleBuddy *buddy)
+       const char *    purple_buddy_get_contact_alias (PurpleBuddy *buddy)
+       const char *    purple_buddy_get_local_alias (PurpleBuddy *buddy)
+       const char *    purple_buddy_get_alias (PurpleBuddy *buddy)
+       PurpleGroup *   purple_buddy_get_group (PurpleBuddy *buddy)
+       const char *    purple_group_get_name (PurpleGroup *group)
+       */
+
+       //Get buddy group
+       const char *from_group = purple_group_get_name(purple_buddy_get_group(buddy)); //FIXME: returns "\x18" when user does not belong to some group
+
+       //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);
+
+       //Get status id
+       const char *status_id = NULL;
+       status_id = purple_primitive_get_id_from_type(purple_status_type_get_primitive(type));
+
+       //Get status message
+       const char *status_msg = NULL;
+       if (purple_status_type_get_attr(type, "message") != NULL) {
+               status_msg = purple_status_get_attr_string(status, "message");
+       } else {
+               status_msg = (char *) purple_savedstatus_get_message(purple_savedstatus_get_current());
+       }
 
-       buff = purple_markup_strip_html(buffer);
-       //printf("\nHarvie received: %s: %s\n", who, buff); //debug
-       //purple_conv_im_send(purple_conversation_get_im_data(conv), ":-*"); //debug
-
-       setenv("PURPLE_FROM", who, 1);
-       setenv("PURPLE_MSG", buff, 1);
-
+       //Export variables to environment
+       setenv(ENV_PREFIX "MSG", message, 1);
+       setenv(ENV_PREFIX "FROM", who, 1);
+       setenv(ENV_PREFIX "FROM_GROUP", from_group, 1);
+       setenv(ENV_PREFIX "PROTOCOL", protocol_id, 1);
+       setenv(ENV_PREFIX "STATUS", status_id, 1);
+       setenv(ENV_PREFIX "STATUS_MSG", status_msg, 1);
 
+       //Launch job on background
        answerscripts_job *job = (answerscripts_job*) malloc(sizeof(answerscripts_job));
        job->pipe = popen(hook_script, "r");
+       if(job->pipe == NULL) {
+               fprintf(stderr,"Can't execute %s\n", hook_script);
+               return;
+       }
        job->conv = conv;
 
        #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);
 }
 
-
 static gboolean plugin_load(PurplePlugin * plugin) {
        asprintf(&hook_script,"%s/%s",purple_user_dir(),ANSWERSCRIPT);
        void *conv_handle = purple_conversations_get_handle();
        purple_signal_connect(conv_handle, "received-im-msg", plugin, PURPLE_CALLBACK(received_im_msg_cb), NULL);
-       return 0;
+       return TRUE;
 }
 
 static gboolean plugin_unload(PurplePlugin * plugin) {
        free(hook_script);
-       return 0;
+       return TRUE;
 }
 
 static PurplePluginInfo info = {
@@ -100,16 +157,22 @@ static PurplePluginInfo info = {
 
        "core-answerscripts",
        "AnswerScripts",
-       "0.2",
-       "Framework for hooking scripts to received messages for various libpurple clients",
-       "This plugin will call ~/.purple/" ANSWERSCRIPT " (or wherever purple_user_dir() points) "
-               "script (or any executable) for each single message called."
-               "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. "
-               "Any text printed to STDOUT by the script will be sent back as answer to message. "
-               "Please see example scripts for more informations...",
-       "Harvie <harvie@email.cz>",
-       "http://github.com/harvie",
+       "0.3.1",
+       "Framework for hooking scripts to process received messages for libpurple clients",
+       "\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,
        plugin_unload,
This page took 0.162559 seconds and 4 git commands to generate.