elitosgon / change-mibew

Mibew files that were changer to be compatible with Bot Framework

Mibew Bot Framework Core Change

This repository contains the modified files of the Mibew core, in order to use the Bot Framework plugin, you need to replace these files or modify the originals as you wish.

Config files

1. config.yml Add plugins configs to "plugins" structure in "<Mibew root>/configs/config.yml". If the "plugins" stucture looks like plugins: [] it will become:

   plugins:
       "TaisaPlus:Bot": # Plugin's configurations are described below
           ...

2. database_schema.yml Add the following lines to the end of the Thread table:

   # Contains info about chat threads
   thread:
    fields:
        # ID of the thread.
        threadid: "int NOT NULL auto_increment PRIMARY KEY"
        ...
        # ID of the conversatión bot ID, to client rest 
        conversationid: "varchar(255)"
        # Date or ID of send messages to client rest 
        lastbotmessage: "varchar(255)"

Libs files

1. libs/classes/Mibew/Thread.php Add the following lines as appropriate:

   <?php 
    /*
     * This file is a part of Mibew Messenger.
     *
     ...
   
    class Thread
    {
        /**
         * User in the users queue
         */
        const STATE_QUEUE = 0;
        ...
         /**
         * Content of ID "Conversation-id" bot conversation id.
         * @var string
         */
    	public $conversationId;
    
        /**
         * Content of ID last message show from bot conversation.
         * @var string
         */
    	public $lastBotMessage;
        /**
         * Create thread object from database info.
         ...
         
    public function __construct()
    {
        // Set the defaults
        ...
        $this->conversationId = "0";
        $this->lastBotMessage = "0";
    }
   
    public function save($update_revision = true)
    {
        ...
   
        $db = Database::getInstance();
        if (!$this->id) {
            $db->query(
                ('INSERT INTO {thread} ('
                   ...
                    . 'shownmessageid, useragent, messagecount, groupid, conversationid, lastbotmessage'
                . ') VALUES ('
                   ... 
                    . ':shown_message_id, :user_agent, :message_count, :group_id , :conversation_id , :last_bot_message'
                . ')'),
                array(
                    ...
                    ':conversation_id' => $this->conversationId,
                    ':last_bot_message' => $this->lastBotMessage,
                )
            );
            
            ...
   
            $db->query(
                ('UPDATE {thread} SET '
                    ...
                    . 'conversationid = :conversation_id, '
                    . 'lastbotmessage = :last_bot_message '
                . 'WHERE threadid = :thread_id'),
                array(
                    ...
                    ':conversation_id' => $this->conversationId,
                    ':last_bot_message' => $this->lastBotMessage,
                )
            );
   
            ...
    ...
   
    protected function populateFromDbFields($db_fields)
    {
        ...
        $this->conversationId = $db_fields['conversationid'];
        $this->lastBotMessage = $db_fields['lastbotmessage'];
    }
   
    ...
   

2. libs/classes/Mibew/RequestProcessor/UserProcessor.php Add the following lines as appropriate:

   <?php
    ...
    ...
    protected function apiUpdateThreads($args)
    {
       ....
            // Code for state bot
            $threadState = null;
            $threadMessage = null;
            if($thread->conversationId == '1'){
                $threadState = "Desactivado";
                $threadMessage = "Agente atendiendo";
            }elseif ($thread->conversationId == '-1') {
                $threadState = "BloqueadoA";
                $threadMessage = "Esperando atención:\n Bot no comprende";
            }elseif ($thread->conversationId == '-2'){
                $threadState = "BloqueadoB";
                $threadMessage = "Esperando atención:\n Bot no conoce respuesta";
            }elseif ($thread->conversationId == '-3'){
                $threadState = "BloqueadoC";
                $threadMessage = "Esperando atención:\n Bot no encuentra información";
            }elseif ($thread->conversationId == '-4') {
                $threadState = "BloqueadoD";
                $threadMessage = "Esperando atención:\n Bot no tiene acceso a datos";
            }else{
                $threadState = "Activado";
                $threadMessage = "Bot atendiendo";
            }
            // Code for state bot
            $threads[] = array(
                ...
                'threadState' => $threadState,
                'threadMessage' => $threadMessage,
            );
   
            ...
        }
   
        ...
    }
   
    ...
   

Handlebars files

Review files in repository:

1. styles/pages/default/templates_src/client_side/users/threads_collection.handlebars

2. styles/pages/default/templates_src/client_side/users/queued_thread.handlebars

3. styles/pages/default/templates_src/server_side/users.handlebars

   To make changes in Mibew effective they must be rebuilt from the source

Build from sources

There are several actions one should do before use the latest version of Mibew from the repository:

1. Obtain a copy of the repository using git clone, download button, or another way.
2. Install node.js and npm.
3. Install Gulp.
4. Install npm dependencies using npm install.
5. Run Gulp to build the sources using gulp default.

Finally .tar.gz and .zip archives of the ready-to-use Plugin will be available in release directory.