source: code/trunk/src/modules/notifications/NotificationManager.cc @ 11819

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   This program is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU General Public License
 *   as published by the Free Software Foundation; either version 2
 *   of the License, or (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Damian 'Mozork' Frick
 *   Co-authors:
 *      ...
 *
 */

/**
    @file NotificationManager.cc
    @brief Implementation of the NotificationManager class.
*/

#include "NotificationManager.h"

#include "core/command/ConsoleCommand.h"
#include "core/CoreIncludes.h"
#include "core/LuaState.h"
#include "core/singleton/ScopedSingletonIncludes.h"

#include "interfaces/NotificationListener.h"

#include "NotificationQueue.h"
#include "NotificationQueueCEGUI.h"

namespace orxonox
{

    ManageScopedSingleton(NotificationManager, ScopeID::ROOT, false);

    RegisterAbstractClass(NotificationManager).inheritsFrom<NotificationListener>();

    /**
    @brief
        Constructor. Registers the Object.
    */
    NotificationManager::NotificationManager()
    {
        RegisterObject(NotificationManager);

        orxout(internal_info, context::notifications) << "NotificatioManager created." << endl;
    }

    /**
    @brief
        Destructor.
    */
    NotificationManager::~NotificationManager()
    {
        // Destroys all Notifications.
        for(const auto& mapEntry : this->allNotificationsList_)
            mapEntry.second->destroy();
        this->allNotificationsList_.clear();

        orxout(internal_info, context::notifications) << "NotificationManager destroyed." << endl;
    }

    /**
    @brief
        Is called before the object is destroyed.
    */
    void NotificationManager::preDestroy(void)
    {
        // Destroys all NotificationQueues that have been registered with the NotificationManager.
        std::map<const std::string, NotificationQueue*>::iterator it = this->queues_.begin();
        while(it != this->queues_.end())
        {
            it->second->destroy();
            it = this->queues_.begin();
        }

        this->queues_.clear();
    }

    /**
    @brief
        Creates and registers a Notification with the input message from the input sender.
        This is called by the NotificationListener, whenever a new notification arrives.
    @param message
        The message of the new Notification.
    @param sender
        The name of the entity (of the collective) that sent the new Notification.
    @param type
        The type of the new Notification.
    @return
        Returns true if successful.
    */
    bool NotificationManager::registerNotification(const std::string& message, const std::string& sender, NotificationMessageType type)
    {
        // TODO: Do something with the type.
        Notification* notification = new Notification(message, sender, type);
        return this->registerNotification(notification);
    }

    /**
    @brief
        Executes the input command from the input sender.
        This is called by the NotificationListener, whenever a new command arrives.
    @param command
        The command to be executed,
    @param sender
        The The name of the entity (of the collective) that sent the command.
    @return
        Returns true if the command was successfully executed.
    */
    bool NotificationManager::executeCommand(NotificationCommand command, const std::string& sender)
    {
        bool commandExecuted = false;
        if(command == NotificationCommand::clear)
        {
            if(this->commandClear(sender))
                commandExecuted = true;
        }

        if(commandExecuted)
            orxout(internal_info, context::notifications) << "Notification command \"" << NotificationListener::command2Str(command) << "\" executed." << endl;

        return commandExecuted;
    }

    /**
    @brief
        The clear command. Clears all NotificationQueues that have its sender as a target.
    @param sender
        The sender of the clear command.
    @return
        Returns true if the command was successfully executed by at least one NotificationQueue, false if it was not executed.
    */
    bool NotificationManager::commandClear(const std::string& sender)
    {
        bool all = (sender == NotificationListener::ALL);
        bool executed = false;
        // Clear all NotificationQueues that have the input sender as target.
        for(const auto& mapEntry : this->queues_) // Iterate through all NotificationQueues.
        {
            const std::set<std::string>& set = mapEntry.second->getTargetsSet();
            // If either the sender is 'all', the NotificationQueue has as target all or the NotificationQueue has the input sender as a target.
            if(all || set.find(NotificationListener::ALL) != set.end() || set.find(sender) != set.end())
                executed = mapEntry.second->tidy() || executed;
        }

        return executed;
    }
    
    /**
    @brief
        Registers a Notification within the NotificationManager and makes sure that the Notification is sent to all the NotificationQueues associated with its sender.
    @param notification
        The Notification to be registered.
    @return
        Returns true if successful.
    */
    bool NotificationManager::registerNotification(Notification* notification)
    {
        assert(notification);

        std::time_t time = std::time(0); // Get current time.

        // Add the Notification to the list that holds all Notifications.
        this->allNotificationsList_.insert(std::pair<std::time_t, Notification*>(time, notification));

        if(notification->getSender() == NotificationListener::NONE) // If the sender has no specific name, then the Notification is only added to the list of all Notifications.
            return true;

        // If all are the sender, then the Notifications is added to every NotificationQueue.
        bool all = (notification->getSender() == NotificationListener::ALL);

        // Insert the Notification in all NotificationQueues that have its sender as target.
        for(const auto& mapEntry : this->queues_) // Iterate through all NotificationQueues.
        {
            const std::set<std::string>& set = mapEntry.second->getTargetsSet();
            bool bAll = set.find(NotificationListener::ALL) != set.end();
            // If either the Notification has as sender 'all', the NotificationQueue displays all Notifications or the NotificationQueue has the sender of the Notification as target.
            if(all || bAll || set.find(notification->getSender()) != set.end())
            {
                if(!bAll)
                    this->notificationLists_[mapEntry.second->getName()]->insert(std::pair<std::time_t, Notification*>(time, notification)); // Insert the Notification in the notifications list of the current NotificationQueue.
                mapEntry.second->update(notification, time); // Update the NotificationQueue.
            }
        }

        orxout(verbose, context::notifications) << "Notification (&" << notification << ") registered with the NotificationManager." << endl;

        return true;
    }

    /**
    @brief
        Unregisters a Notification within the NotificationManager for a given NotificationQueue.
    @param notification
        A pointer to the Notification to be unregistered.
    @param queue
        A pointer to the NotificationQueue the Notification is unregistered for.
    */
    void NotificationManager::unregisterNotification(Notification* notification, NotificationQueue* queue)
    {
        assert(notification);
        assert(queue);

        // Remove the Notification from the list of Notifications of the input NotificationQueue.
        this->removeNotification(notification, *(this->notificationLists_.find(queue->getName())->second));

        orxout(verbose, context::notifications) << "Notification (&" << notification << ") unregistered with the NotificationManager from NotificationQueue " << queue->getName() << "." << endl;
    }

    /**
    @brief
        Helper method that removes an input Notification form an input map.
    @param notification
        A pointer to the Notification to be removed.
    @param map
        The map the Notification should be removed from.
    @return
        Returns true if successful.
    */
    bool NotificationManager::removeNotification(Notification* notification, std::multimap<std::time_t, Notification*>& map)
    {
        // Iterates through all items in the map until the Notification is found.
        //TODO: Do more efficiently?
        for(std::multimap<std::time_t, Notification*>::iterator it = map.begin(); it != map.end(); it++)
        {
            if(it->second == notification)
            {
                map.erase(it);
                return true;
            }
        }
        return false;
    }

    /**
    @brief
        Fetches the Notifications for a specific NotificationQueue in a specified timeframe and stores them in the input map.
    @param queue
        The NotificationQueue the Notifications are fetched for.
    @param map
        A pointer to a multimap, in which the notifications are stored. The map needs to have been allocated.
    @param timeFrameStart
        The start time of the timeframe.
    @param timeFrameEnd
        The end time of the timeframe.
    @return
        Returns true if successful.
    */
    void NotificationManager::getNotifications(NotificationQueue* queue, std::multimap<std::time_t,Notification*>* map, const std::time_t & timeFrameStart, const std::time_t & timeFrameEnd)
    {
        assert(queue);
        assert(map);

        std::multimap<std::time_t, Notification*>* notifications = this->notificationLists_[queue->getName()]; // All the Notifications for the input NotificationQueue.

        std::multimap<std::time_t,Notification*>::iterator it, itLowest, itHighest;
        // Iterators pointing to the bounds specified by the specified start and end times of the time frame.
        itLowest = notifications->lower_bound(timeFrameStart);
        itHighest = notifications->upper_bound(timeFrameEnd);

        for(it = itLowest; it != itHighest; it++) // Iterate through the Notifications from the start of the time frame to the end of it.
            map->insert(std::pair<std::time_t, Notification*>(it->first, it->second)); // Add the found Notifications to the map.
    }

    /**
    @brief
        Fetches the newest Notifications for a specific NotificationQueue and stores them in the input map.
    @param queue
        The NotificationQueue the Notifications are fetched for.
    @param map
        A pointer to a multimap, in which the notifications are stored. The map needs to have been allocated.
    @param numberOfNotifications
        The number of newest Notifications to be got.
    @return
        Returns true if successful.
    */
    void NotificationManager::getNewestNotifications(NotificationQueue* queue, std::multimap<std::time_t, Notification*>* map, int numberOfNotifications)
    {
        assert(queue);
        assert(map);

        std::multimap<std::time_t, Notification*>* notifications = this->notificationLists_[queue->getName()]; // All the Notifications for the input NotificationQueue.

        if(!notifications->empty()) // If the list of Notifications is not empty.
        {
            std::multimap<std::time_t,Notification*>::iterator it = notifications->end();
            for(int i = 0; i < numberOfNotifications; i++) // Iterate through the Notifications from the newest until we have the specified number of notifications.
            {
                it--;
                map->insert(std::pair<std::time_t, Notification*>(it->first, it->second)); // Add the found Notifications to the map.
                if(it == notifications->begin())
                    break;
            }
        }
    }

    /**
    @brief
        Registers a NotificationQueue.
        This makes sure that the NotificationQueue can be accessed through lua by name. It also makes sure that the NotificationQueue is destroyed upon destruction of the NotificationManager.
    @param queue
        A pointer to the NotificationQueue to be registered.
    @return
        Returns true if successful. If e.g. the a NotificationQueue with that name already exists this returns false.
    */
    bool NotificationManager::registerQueue(NotificationQueue* queue)
    {
        assert(queue);

        // If the NotificationQueue is already registered.
        if(this->queues_.find(queue->getName()) != this->queues_.end())
            return false;

        this->queues_.insert(std::pair<const std::string, NotificationQueue*>(queue->getName(), queue)); // Add the NotificationQueue to the list of NotificationQueues.

        const std::set<std::string>& set = queue->getTargetsSet();

        // If all senders are the target of the NotificationQueue, then the list of Notifications for that specific NotificationQueue is the same as the list of all Notifications.
        bool bAll = set.find(NotificationListener::ALL) != set.end();
        std::multimap<std::time_t, Notification*>* map = nullptr;
        if(bAll)
            this->notificationLists_[queue->getName()] = &this->allNotificationsList_;
        // Else a new list (resp. multimap) is created and added to the list of Notification lists for NotificationQueues.
        else
        {
            this->notificationLists_[queue->getName()] = new std::multimap<std::time_t, Notification*>;
            map = this->notificationLists_[queue->getName()];
        }

        // Iterate through all Notifications to determine whether any of them should belong to the newly registered NotificationQueue.
        for(const auto& mapEntry : this->allNotificationsList_)
        {
            if(!bAll && set.find(mapEntry.second->getSender()) != set.end()) // Checks whether the listener has the sender of the current Notification as target.
                map->insert(std::pair<std::time_t, Notification*>(mapEntry.first, mapEntry.second));
        }

        queue->update(); // Update the queue.
        
        orxout(verbose, context::notifications) << "NotificationQueue '" << queue->getName() << "' registered with the NotificationManager." << endl;
        return true;
    }

    /**
    @brief
        Unregisters a NotificationQueue.
    @param queue
        A pointer to the NotificationQueue to be unregistered.
    */
    void NotificationManager::unregisterQueue(NotificationQueue* queue)
    {
        assert(queue);

        std::multimap<std::time_t, Notification*>* map = this->notificationLists_.find(queue->getName())->second;

        // If the map is not the map of all Notifications, make sure all Notifications are unregistered.
        std::multimap<std::time_t, Notification*>::iterator it = map->begin();
        if(map != &this->allNotificationsList_)
        {
            while(it != map->end())
            {
                this->unregisterNotification(it->second, queue);
                it = map->begin();
            }
            delete map;
        }

        // Remove the NotificationQueue from the list of NotificationQueues.
        this->queues_.erase(queue->getName());
        // Remove the Notifications list that was associated with the input NotificationQueue.
        this->notificationLists_.erase(queue->getName());
        
        orxout(verbose, context::notifications) << "NotificationQueue '" << queue->getName() << "' unregistered with the NotificationManager." << endl;
    }

    /**
    @brief
        Get the NotificationQueue with the input name.
    @param name
        The name of the NotificationQueue.
    @return
        Returns a pointer to the NotificationQueue with the input name. Returns nullptr if no NotificationQueue with such a name exists.
    */
    NotificationQueue* NotificationManager::getQueue(const std::string & name)
    {
        std::map<const std::string, NotificationQueue*>::iterator it = this->queues_.find(name);
        // Returns nullptr if no such NotificationQueue exists.
        if(it == this->queues_.end())
            return nullptr;

        return (*it).second;
    }

    /**
    @brief
        Loads all the NotificationQueues that should exist.
    */
    void NotificationManager::loadQueues(void)
    {
        /*NotificationQueueCEGUI* allQueue = new NotificationQueueCEGUI("all");
        allQueue->setDisplaySize(Vector2(0.5, 0));
        allQueue->setPosition(Vector4(0.0, 10, 0.3, 0));

        NotificationQueueCEGUI* infoQueue = new NotificationQueueCEGUI("info", "gameinfo", 1, -1);
        infoQueue->setPosition(Vector4(0.2, 0, 0.8, 0));
        infoQueue->setFontSize(24);
        infoQueue->setFontColor(Vector4(1.0, 1.0, 0.0, 0.8));
        infoQueue->setAlignment("HorzCentred");
        infoQueue->setDisplaySize(Vector2(0.6, 0.0));*/
    }

    // Notification class

    /**
    @brief
        Constructor. Creates a Notification with the input message and sender.
    @param message
        The message of the Notification.
    @param sender
        The sender of the Notification.
    @param type

    */
    Notification::Notification(const std::string& message, const std::string& sender, NotificationMessageType type)
    {
        this->initialize();
        this->message_ = message;
        this->sender_ = sender;
        this->type_ = type;
    }

    /**
    @brief
        Destructor.
    */
    Notification::~Notification()
    {

    }

    /**
    @brief
        Registers the object and sets some default values.
    */
    void Notification::initialize(void)
    {
        this->message_.clear();
        this->sender_ = NotificationListener::NONE;
    }

}