Doc update
[mirrors/libpurple-core-answerscripts.git] / answerscripts.c
index 071ef97c1152a60b07cda64a67a4e5929b7bfc0d..d24e58f9ad1104465d35fafd1be9c22721fe4b05 100755 (executable)
@@ -59,38 +59,53 @@ int answerscripts_process_message_cb(answerscripts_job *job) {
        return 0;
 }
 
-static void received_im_msg_cb(PurpleAccount *account, char *who, char *buffer, PurpleConversation *conv, PurpleMessageFlags flags, void *data) {
+static void received_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);
+       PurplePresence *presence = purple_buddy_get_presence(buddy);
 
        //Get message
        message = purple_markup_strip_html(buffer);
 
-       //Here are prototypes of some functions interesting to implement github feature request #3
+       //Get conversation type
+       const char *action, *roomname;
+       switch(purple_conversation_get_type(conv)) {
+               case PURPLE_CONV_TYPE_IM:
+                       action = "IM";
+                       roomname = "";
+                       break;
+               case PURPLE_CONV_TYPE_CHAT:
+                       action = "CHAT";
+                       roomname = purple_conversation_get_name(conv);
+                       //PurpleConvChat *chat = purple_conversation_get_chat_data(conv);
+                       break;
+               default:
+                       action = "UNKNOWN";
+       }
 
        //LOCAL USER:
-       const char* local_alias = purple_account_get_alias(account);
        const char* local_name = (char *) purple_account_get_name_for_display(account);
-       setenv(ENV_PREFIX "LOCAL_NAME", local_name, 1); //Name of local user - untested
-       setenv(ENV_PREFIX "LOCAL_ALIAS", local_alias, 1);       //Alias of local user - untested
+       const char* local_alias = purple_account_get_alias(account);
+       if(local_alias == NULL) local_alias = local_name;
+
+       //Was my nick said?
+       char *highlighted;
+       if(flags & PURPLE_MESSAGE_NICK || purple_utf8_has_word(buffer, local_name))
+               highlighted = "true";
+       else
+               highlighted = "false";
 
        //REMOTE USER (Buddy):
-       //const char *  purple_contact_get_alias (PurpleContact *contact)
-       const char* remote_name = purple_buddy_get_name(buddy);
-       const char* remote_alias_only = purple_buddy_get_alias_only(buddy);
-       const char* remote_server_alias = purple_buddy_get_server_alias(buddy);
-       const char* remote_contact_alias = purple_buddy_get_contact_alias(buddy);
-       const char* remote_local_alias = purple_buddy_get_local_alias(buddy);
+
+       //Get buddy alias
        const char* remote_alias = purple_buddy_get_alias(buddy);
-       setenv(ENV_PREFIX "REMOTE_NAME", remote_name, 1);       //???
-       setenv(ENV_PREFIX "REMOTE_ALIAS_ONLY", remote_alias_only, 1);   //buggy
-       setenv(ENV_PREFIX "REMOTE_SERVER_ALIAS", remote_server_alias, 1);       //buggy
-       setenv(ENV_PREFIX "REMOTE_CONTACT_ALIAS", remote_contact_alias, 1);     //buggy
-       setenv(ENV_PREFIX "REMOTE_LOCAL_ALIAS", remote_local_alias, 1); //???
-       setenv(ENV_PREFIX "REMOTE_ALIAS", remote_alias, 1);     //???
+       if(remote_alias == NULL) remote_alias = who;
+       //if(remote_alias == NULL) remote_alias = "";
 
        //Get buddy group
-       const char *from_group = purple_group_get_name(purple_buddy_get_group(buddy)); //FIXME: purple_group_get_name() returns "\x18" (or random data!) when user does not belong to some group
+       PurpleGroup *group = purple_buddy_get_group(buddy);
+       const char *from_group = group != NULL ? purple_group_get_name(group) : ""; //return empty string if not in group
 
        //Get protocol ID
        const char *protocol_id = purple_account_get_protocol_id(account);
@@ -99,10 +114,16 @@ static void received_im_msg_cb(PurpleAccount *account, char *who, char *buffer,
        //Get status
        PurpleStatus *status = purple_account_get_active_status(account);
        PurpleStatusType *type = purple_status_get_type(status);
+       //remote
+       PurpleStatus *r_status = purple_presence_get_active_status(presence);
+       PurpleStatusType *r_status_type =       purple_status_get_type(r_status);
 
        //Get status id
        const char *status_id = NULL;
        status_id = purple_primitive_get_id_from_type(purple_status_type_get_primitive(type));
+       //remote
+       const char *r_status_id = NULL;
+       r_status_id = purple_primitive_get_id_from_type(purple_status_type_get_primitive(r_status_type));
 
        //Get status message
        const char *status_msg = NULL;
@@ -111,14 +132,29 @@ static void received_im_msg_cb(PurpleAccount *account, char *who, char *buffer,
        } else {
                status_msg = (char *) purple_savedstatus_get_message(purple_savedstatus_get_current());
        }
+       //remote
+       const char *r_status_msg = NULL;
+       if (purple_status_type_get_attr(r_status_type, "message") != NULL) {
+               r_status_msg = purple_status_get_attr_string(r_status, "message");
+       } else {
+               r_status_msg = "";
+       }
 
        //Export variables to environment
+       setenv(ENV_PREFIX "ACTION", action, 1); //what happend: IM/CHAT/UNKNOWN, show setting dialog, event, etc...
        setenv(ENV_PREFIX "MSG", message, 1);   //text of the message
-       setenv(ENV_PREFIX "FROM", who, 1);      //who sent you the message
-       setenv(ENV_PREFIX "FROM_GROUP", from_group, 1); //group which contains that buddy - buggy
+       setenv(ENV_PREFIX "MSG_HIGHLIGHTED", highlighted, 1);   //was my nick mentioned in message? true/false
        setenv(ENV_PREFIX "PROTOCOL", protocol_id, 1);  //protocol used to deliver the message. eg.: xmpp, irc,...
-       setenv(ENV_PREFIX "STATUS", status_id, 1);      //unique ID of status. eg.: available, away,...
-       setenv(ENV_PREFIX "STATUS_MSG", status_msg, 1); //status message set by user
+       setenv(ENV_PREFIX "R_NAME", who, 1);    //ID of remote user - "buddy"
+       setenv(ENV_PREFIX "R_GROUP", from_group, 1);    //group which contains that buddy OR empty string
+       setenv(ENV_PREFIX "R_ALIAS", remote_alias, 1);  //buddy's OPTIONAL alias, server alias, contact alias, username OR empty string
+       setenv(ENV_PREFIX "R_STATUS", r_status_id, 1);  //unique ID of remote user's status. eg.: available, away,...
+       setenv(ENV_PREFIX "R_ROOM_NAME", roomname, 1);  //Chatroom name
+       setenv(ENV_PREFIX "R_STATUS_MSG", r_status_msg, 1);     //status message set by your buddy
+       setenv(ENV_PREFIX "L_NAME", local_name, 1);     //ID of local user
+       setenv(ENV_PREFIX "L_ALIAS", local_alias, 1);   //OPTIONAL alias of local user OR empty string
+       setenv(ENV_PREFIX "L_STATUS", status_id, 1);    //unique ID of local user's status. eg.: available, away,...
+       setenv(ENV_PREFIX "L_STATUS_MSG", status_msg, 1);       //status message set by local user
 
        //Launch job on background
        answerscripts_job *job = (answerscripts_job*) malloc(sizeof(answerscripts_job));
@@ -142,7 +178,8 @@ static void received_im_msg_cb(PurpleAccount *account, char *who, char *buffer,
 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);
+       purple_signal_connect(conv_handle, "received-im-msg", plugin, PURPLE_CALLBACK(received_msg_cb), NULL);
+       purple_signal_connect(conv_handle, "received-chat-msg", plugin, PURPLE_CALLBACK(received_msg_cb), NULL);
        return TRUE;
 }
 
@@ -163,21 +200,17 @@ static PurplePluginInfo info = {
 
        "core-answerscripts",
        "AnswerScripts",
-       "0.3.1",
+       "0.5.2",
        "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"
+               "\t- " ENV_PREFIX "* (see documentation or env for more)\n"
                "\nPlease see sample scripts, documentation, website and source code for more informations...\n"
                "\n(-; Peace ;-)\n",
-       "Tomas Mudrunka <harvie@email.cz>",
+       "Tomas Mudrunka <harviecz@gmail.cz>",
        "http://github.com/harvie/libpurple-core-answerscripts",
 
        plugin_load,
@@ -195,8 +228,12 @@ static PurplePluginInfo info = {
 
 static void init_plugin(PurplePlugin * plugin) {
        //Export static environment variables
-       setenv(ENV_PREFIX "AGENT", (char *) purple_core_get_ui(), 1);   //ID of IM client used with answerscripts
-       setenv(ENV_PREFIX "AGENT_VERSION", (char *) purple_core_get_version(), 1);      //Version of client
+       #ifndef __x86_64__ //Workaround for x86_64 (where this causes problems for unknown reason)
+               const char * core_ui = purple_core_get_ui() != 0 ? (const char *) purple_core_get_ui() : "";
+               const char * core_version = purple_core_get_version() != 0 ? (const char *) purple_core_get_version() : "";
+               setenv(ENV_PREFIX "L_AGENT", (char *) core_ui, 1);      //ID of IM client used with answerscripts
+               setenv(ENV_PREFIX "L_AGENT_VERSION", (char *) core_version, 1); //Version of client
+       #endif
 }
 
 PURPLE_INIT_PLUGIN(autoanswer, init_plugin, info)
This page took 0.173806 seconds and 4 git commands to generate.