[2280] | 1 | /* |
---|
| 2 | * ORXONOX - the hottest 3D action shooter ever to exist |
---|
| 3 | * > www.orxonox.net < |
---|
| 4 | * |
---|
| 5 | * |
---|
| 6 | * License notice: |
---|
| 7 | * |
---|
| 8 | * This program is free software; you can redistribute it and/or |
---|
| 9 | * modify it under the terms of the GNU General Public License |
---|
| 10 | * as published by the Free Software Foundation; either version 2 |
---|
| 11 | * of the License, or (at your option) any later version. |
---|
| 12 | * |
---|
| 13 | * This program is distributed in the hope that it will be useful, |
---|
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 16 | * GNU General Public License for more details. |
---|
| 17 | * |
---|
| 18 | * You should have received a copy of the GNU General Public License |
---|
| 19 | * along with this program; if not, write to the Free Software |
---|
| 20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
---|
| 21 | * |
---|
| 22 | * Author: |
---|
| 23 | * Damian 'Mozork' Frick |
---|
| 24 | * Co-authors: |
---|
| 25 | * ... |
---|
| 26 | * |
---|
| 27 | */ |
---|
| 28 | |
---|
[2911] | 29 | /** |
---|
[7403] | 30 | @file NotificationManager.cc |
---|
[2911] | 31 | @brief Implementation of the NotificationManager class. |
---|
| 32 | */ |
---|
| 33 | |
---|
[2280] | 34 | #include "NotificationManager.h" |
---|
| 35 | |
---|
[7403] | 36 | #include "core/command/ConsoleCommand.h" |
---|
| 37 | #include "core/CoreIncludes.h" |
---|
| 38 | #include "core/GUIManager.h" |
---|
| 39 | #include "core/LuaState.h" |
---|
[7474] | 40 | #include "network/Host.h" |
---|
| 41 | #include "network/NetworkFunction.h" |
---|
[7403] | 42 | #include "util/ScopedSingletonManager.h" |
---|
[2911] | 43 | |
---|
[5619] | 44 | #include "interfaces/NotificationListener.h" |
---|
[2280] | 45 | |
---|
[7403] | 46 | #include "Notification.h" |
---|
| 47 | #include "NotificationQueue.h" |
---|
| 48 | |
---|
| 49 | #include "ToluaBindNotifications.h" |
---|
| 50 | |
---|
[2435] | 51 | namespace orxonox |
---|
| 52 | { |
---|
[2280] | 53 | |
---|
[6417] | 54 | const std::string NotificationManager::ALL("all"); |
---|
| 55 | const std::string NotificationManager::NONE("none"); |
---|
[2911] | 56 | |
---|
[7403] | 57 | // Register tolua_open function when loading the library. |
---|
| 58 | DeclareToluaInterface(Notifications); |
---|
[2911] | 59 | |
---|
[7488] | 60 | ManageScopedSingleton(NotificationManager, ScopeID::Root, false); |
---|
[7403] | 61 | |
---|
[7484] | 62 | // Setting console command to enter the edit mode. |
---|
[7403] | 63 | SetConsoleCommand("enterEditMode", &NotificationManager::enterEditMode); |
---|
| 64 | |
---|
[7474] | 65 | registerStaticNetworkFunction(NotificationManager::sendNotification); |
---|
| 66 | |
---|
[2911] | 67 | /** |
---|
| 68 | @brief |
---|
| 69 | Constructor. Registers the Object. |
---|
| 70 | */ |
---|
| 71 | NotificationManager::NotificationManager() |
---|
[2280] | 72 | { |
---|
[2911] | 73 | RegisterRootObject(NotificationManager); |
---|
| 74 | |
---|
| 75 | this->highestIndex_ = 0; |
---|
[7403] | 76 | |
---|
| 77 | ModifyConsoleCommand("enterEditMode").setObject(this); |
---|
| 78 | |
---|
| 79 | COUT(3) << "NotificatioManager created." << std::endl; |
---|
[2280] | 80 | } |
---|
| 81 | |
---|
[2911] | 82 | /** |
---|
| 83 | @brief |
---|
| 84 | Destructor. |
---|
| 85 | */ |
---|
[2280] | 86 | NotificationManager::~NotificationManager() |
---|
| 87 | { |
---|
[7403] | 88 | ModifyConsoleCommand("enterEditMode").setObject(NULL); |
---|
[7163] | 89 | |
---|
[7488] | 90 | // Destroys all Notifications. |
---|
| 91 | for(std::multimap<std::time_t, Notification*>::iterator it = this->allNotificationsList_.begin(); it!= this->allNotificationsList_.end(); it++) |
---|
| 92 | it->second->destroy(); |
---|
| 93 | this->allNotificationsList_.clear(); |
---|
| 94 | |
---|
[7403] | 95 | COUT(3) << "NotificationManager destroyed." << std::endl; |
---|
[2280] | 96 | } |
---|
[2501] | 97 | |
---|
[2911] | 98 | /** |
---|
| 99 | @brief |
---|
[7403] | 100 | Is called before the object is destroyed. |
---|
| 101 | */ |
---|
| 102 | void NotificationManager::preDestroy(void) |
---|
| 103 | { |
---|
| 104 | // Destroys all NotificationQueues that have been registered with the NotificationManager. |
---|
[7488] | 105 | for(std::map<const std::string, NotificationQueue*>::iterator it = this->queues_.begin(); it != this->queues_.end(); it++) |
---|
| 106 | it->second->destroy(true); |
---|
[7489] | 107 | |
---|
[7403] | 108 | this->queues_.clear(); |
---|
| 109 | } |
---|
| 110 | |
---|
[7484] | 111 | /** |
---|
| 112 | @brief |
---|
| 113 | Sends a Notification with the specified message to the specified client from the specified sender. |
---|
| 114 | @param message |
---|
| 115 | The message that should be sent. |
---|
| 116 | @param clientId |
---|
| 117 | The id of the client the notification should be sent to. |
---|
| 118 | @param sender |
---|
| 119 | The sender that sent the notification. |
---|
[7486] | 120 | @param isLocal |
---|
| 121 | If this is set to true (false is default), then the Notification is sent to the client where this function is executed, meaning the Notification is sent locally. |
---|
[7484] | 122 | */ |
---|
[7486] | 123 | /*static*/ void NotificationManager::sendNotification(const std::string& message, unsigned int clientId, const std::string& sender, bool isLocal) |
---|
[7474] | 124 | { |
---|
[7484] | 125 | // If we're in standalone mode or we're already no the right client we create and send the Notification. |
---|
[7486] | 126 | if(GameMode::isStandalone() || isLocal || Host::getPlayerID() == clientId) |
---|
[7474] | 127 | { |
---|
[7488] | 128 | Notification* notification = new Notification(message, sender); |
---|
| 129 | if(NotificationManager::getInstance().registerNotification(notification)) |
---|
| 130 | COUT(3) << "Notification \"" << notification->getMessage() << "\" sent." << std::endl; |
---|
[7474] | 131 | } |
---|
[7484] | 132 | // If we're on the server (and the server is not the intended recipient of the Notification) we send it over the network. |
---|
[7474] | 133 | else if(GameMode::isServer()) |
---|
| 134 | { |
---|
| 135 | callStaticNetworkFunction(NotificationManager::sendNotification, clientId, message, clientId, sender); |
---|
| 136 | } |
---|
| 137 | } |
---|
| 138 | |
---|
[7403] | 139 | /** |
---|
| 140 | @brief |
---|
[5619] | 141 | Registers a Notification within the NotificationManager and makes sure that the Notification is sent to all the NotificationListeners associated with its sender. |
---|
[2911] | 142 | @param notification |
---|
| 143 | The Notification to be registered. |
---|
| 144 | @return |
---|
| 145 | Returns true if successful. |
---|
| 146 | */ |
---|
| 147 | bool NotificationManager::registerNotification(Notification* notification) |
---|
| 148 | { |
---|
[7403] | 149 | assert(notification); |
---|
[5619] | 150 | |
---|
[7552] | 151 | std::time_t time = std::time(0); // Get current time. |
---|
[5619] | 152 | |
---|
[7403] | 153 | // Add the Notification to the list that holds all Notifications. |
---|
| 154 | this->allNotificationsList_.insert(std::pair<std::time_t, Notification*>(time, notification)); |
---|
[5619] | 155 | |
---|
[7403] | 156 | if(notification->getSender() == NotificationManager::NONE) // If the sender has no specific name, then the Notification is only added to the list of all Notifications. |
---|
[2911] | 157 | return true; |
---|
[5619] | 158 | |
---|
[2911] | 159 | bool all = false; |
---|
[7403] | 160 | if(notification->getSender() == NotificationManager::ALL) // If all are the sender, then the Notifications is added to every NotificationListener. |
---|
[2911] | 161 | all = true; |
---|
[5619] | 162 | |
---|
[7403] | 163 | // Insert the Notification in all NotificationListeners that have its sender as target. |
---|
| 164 | for(std::map<NotificationListener*, unsigned int>::iterator it = this->listenerList_.begin(); it != this->listenerList_.end(); it++) // Iterate through all NotificationListeners. |
---|
[2435] | 165 | { |
---|
[7417] | 166 | const std::set<std::string>& set = it->first->getTargetsSet(); |
---|
[7403] | 167 | bool bAll = set.find(NotificationManager::ALL) != set.end(); |
---|
| 168 | // If either the Notification has as sender 'all', the NotificationListener displays all Notifications or the NotificationListener has the sender of the Notification as target. |
---|
| 169 | if(all || bAll || set.find(notification->getSender()) != set.end()) |
---|
[2280] | 170 | { |
---|
[7403] | 171 | if(!bAll) |
---|
| 172 | this->notificationLists_[it->second]->insert(std::pair<std::time_t, Notification*>(time, notification)); // Insert the Notification in the notifications list of the current NotificationListener. |
---|
| 173 | it->first->update(notification, time); // Update the NotificationListener. |
---|
[2435] | 174 | } |
---|
| 175 | } |
---|
[5619] | 176 | |
---|
[7403] | 177 | COUT(4) << "Notification (&" << notification << ") registered with the NotificationManager." << std::endl; |
---|
[5619] | 178 | |
---|
[2280] | 179 | return true; |
---|
| 180 | } |
---|
[5619] | 181 | |
---|
[2911] | 182 | /** |
---|
| 183 | @brief |
---|
[7403] | 184 | Unregisters a Notification within the NotificationManager for a given NotificationListener. |
---|
[7163] | 185 | @param notification |
---|
| 186 | A pointer to the Notification to be unregistered. |
---|
| 187 | @param listener |
---|
| 188 | A pointer to the NotificationListener the Notification is unregistered for. |
---|
| 189 | */ |
---|
| 190 | void NotificationManager::unregisterNotification(Notification* notification, NotificationListener* listener) |
---|
| 191 | { |
---|
| 192 | assert(notification); |
---|
| 193 | assert(listener); |
---|
| 194 | |
---|
[7403] | 195 | // Remove the Notification from the list of Notifications of the input NotificationListener. |
---|
| 196 | this->removeNotification(notification, *(this->notificationLists_.find(this->listenerList_.find(listener)->second)->second)); |
---|
[7163] | 197 | |
---|
[7403] | 198 | COUT(4) << "Notification (&" << notification << ") unregistered with the NotificationManager from listener (&" << listener << ")" << std::endl; |
---|
[7163] | 199 | } |
---|
| 200 | |
---|
| 201 | /** |
---|
| 202 | @brief |
---|
[7403] | 203 | Helper method that removes an input Notification form an input map. |
---|
[7163] | 204 | @param notification |
---|
[7403] | 205 | A pointer to the Notification to be removed. |
---|
[7163] | 206 | @param map |
---|
[7403] | 207 | The map the Notification should be removed from. |
---|
[7163] | 208 | @return |
---|
| 209 | Returns true if successful. |
---|
| 210 | */ |
---|
| 211 | bool NotificationManager::removeNotification(Notification* notification, std::multimap<std::time_t, Notification*>& map) |
---|
| 212 | { |
---|
| 213 | // Iterates through all items in the map until the Notification is found. |
---|
| 214 | //TODO: Do more efficiently? |
---|
| 215 | for(std::multimap<std::time_t, Notification*>::iterator it = map.begin(); it != map.end(); it++) |
---|
| 216 | { |
---|
| 217 | if(it->second == notification) |
---|
| 218 | { |
---|
| 219 | map.erase(it); |
---|
| 220 | return true; |
---|
| 221 | } |
---|
| 222 | } |
---|
| 223 | return false; |
---|
| 224 | } |
---|
| 225 | |
---|
| 226 | /** |
---|
| 227 | @brief |
---|
[5619] | 228 | Registers a NotificationListener within the NotificationManager. |
---|
| 229 | @param listener |
---|
| 230 | The NotificationListener to be registered. |
---|
[2911] | 231 | @return |
---|
[7403] | 232 | Returns true if successful. Fales if the NotificationListener is already registered. |
---|
[2911] | 233 | */ |
---|
[5619] | 234 | bool NotificationManager::registerListener(NotificationListener* listener) |
---|
[2280] | 235 | { |
---|
[7403] | 236 | assert(listener); |
---|
| 237 | |
---|
| 238 | // If the NotificationListener is already registered. |
---|
| 239 | if(this->listenerList_.find(listener) != this->listenerList_.end()) |
---|
| 240 | return false; |
---|
| 241 | |
---|
[2911] | 242 | this->highestIndex_ += 1; |
---|
[7403] | 243 | unsigned int index = this->highestIndex_; // An identifier that identifies each registered NotificationListener uniquely. |
---|
[5619] | 244 | |
---|
[7403] | 245 | this->listenerList_[listener] = index; // Add the NotificationListener to the list of NotificationListeners. |
---|
[5619] | 246 | |
---|
[7417] | 247 | const std::set<std::string>& set = listener->getTargetsSet(); |
---|
[5619] | 248 | |
---|
[7403] | 249 | // If all senders are the target of the NotificationListener, then the list of Notifications for that specific NotificationListener is the same as the list of all Notifications. |
---|
| 250 | bool bAll = set.find(NotificationManager::ALL) != set.end(); |
---|
[7504] | 251 | std::multimap<std::time_t, Notification*>* map = NULL; |
---|
[7403] | 252 | if(bAll) |
---|
| 253 | this->notificationLists_[index] = &this->allNotificationsList_; |
---|
| 254 | // Else a new list (resp. multimap) is created and added to the list of Notification lists for NotificationListeners. |
---|
| 255 | else |
---|
[2284] | 256 | { |
---|
[7403] | 257 | this->notificationLists_[index] = new std::multimap<std::time_t, Notification*>; |
---|
| 258 | map = this->notificationLists_[index]; |
---|
[2284] | 259 | } |
---|
[5619] | 260 | |
---|
[7403] | 261 | // Iterate through all Notifications to determine whether any of them should belong to the newly registered NotificationListener. |
---|
| 262 | for(std::multimap<std::time_t, Notification*>::iterator it = this->allNotificationsList_.begin(); it != this->allNotificationsList_.end(); it++) |
---|
[2911] | 263 | { |
---|
[7403] | 264 | if(!bAll && set.find(it->second->getSender()) != set.end()) // Checks whether the listener has the sender of the current Notification as target. |
---|
| 265 | map->insert(std::pair<std::time_t, Notification*>(it->first, it->second)); |
---|
[2911] | 266 | } |
---|
[2501] | 267 | |
---|
[7403] | 268 | listener->update(); // Update the listener. |
---|
[5619] | 269 | |
---|
[7163] | 270 | COUT(4) << "NotificationListener registered with the NotificationManager." << std::endl; |
---|
[5619] | 271 | |
---|
[2911] | 272 | return true; |
---|
[2280] | 273 | } |
---|
[5619] | 274 | |
---|
[2911] | 275 | /** |
---|
| 276 | @brief |
---|
[7403] | 277 | Unregisters a NotificationListener within the NotificationManager. |
---|
| 278 | @param listener |
---|
| 279 | The NotificationListener to be unregistered. |
---|
[7163] | 280 | */ |
---|
| 281 | void NotificationManager::unregisterListener(NotificationListener* listener) |
---|
| 282 | { |
---|
| 283 | assert(listener); |
---|
| 284 | |
---|
[7403] | 285 | unsigned int identifier = this->listenerList_.find(listener)->second; |
---|
[7163] | 286 | std::multimap<std::time_t, Notification*>* map = this->notificationLists_.find(identifier)->second; |
---|
| 287 | |
---|
[7403] | 288 | // If the map is not the map of all Notifications, make sure all Notifications are unregistered. |
---|
[7163] | 289 | std::multimap<std::time_t, Notification*>::iterator it = map->begin(); |
---|
[7403] | 290 | if(map != &this->allNotificationsList_) |
---|
[7163] | 291 | { |
---|
[7403] | 292 | while(it != map->end()) |
---|
| 293 | { |
---|
| 294 | this->unregisterNotification(it->second, listener); |
---|
| 295 | it = map->begin(); |
---|
| 296 | } |
---|
| 297 | delete map; |
---|
[7163] | 298 | } |
---|
| 299 | |
---|
[7403] | 300 | // Remove the NotificationListener from the list of NotificationListeners. |
---|
[7163] | 301 | this->listenerList_.erase(listener); |
---|
[7403] | 302 | // Remove the Notifications list that was associated with the input NotificationListener. |
---|
[7163] | 303 | this->notificationLists_.erase(identifier); |
---|
| 304 | |
---|
| 305 | COUT(4) << "NotificationListener unregistered with the NotificationManager." << std::endl; |
---|
| 306 | } |
---|
| 307 | |
---|
| 308 | /** |
---|
| 309 | @brief |
---|
[7403] | 310 | Fetches the Notifications for a specific NotificationListener in a specified timeframe and stores them in the input map. |
---|
[5619] | 311 | @param listener |
---|
| 312 | The NotificationListener the Notifications are fetched for. |
---|
[2911] | 313 | @param map |
---|
[7403] | 314 | A pointer to a multimap, in which the notifications are stored. The map needs to have been allocated. |
---|
[2911] | 315 | @param timeFrameStart |
---|
| 316 | The start time of the timeframe. |
---|
| 317 | @param timeFrameEnd |
---|
| 318 | The end time of the timeframe. |
---|
| 319 | @return |
---|
| 320 | Returns true if successful. |
---|
| 321 | */ |
---|
[7403] | 322 | void NotificationManager::getNotifications(NotificationListener* listener, std::multimap<std::time_t,Notification*>* map, const std::time_t & timeFrameStart, const std::time_t & timeFrameEnd) |
---|
[2346] | 323 | { |
---|
[7403] | 324 | assert(listener); |
---|
| 325 | assert(map); |
---|
[2501] | 326 | |
---|
[7403] | 327 | std::multimap<std::time_t, Notification*>* notifications = this->notificationLists_[this->listenerList_[listener]]; // All the Notifications for the input NotificationListener. |
---|
[5619] | 328 | |
---|
[2911] | 329 | std::multimap<std::time_t,Notification*>::iterator it, itLowest, itHighest; |
---|
[7403] | 330 | // Iterators pointing to the bounds specified by the specified start and end times of the time frame. |
---|
[2911] | 331 | itLowest = notifications->lower_bound(timeFrameStart); |
---|
[7403] | 332 | itHighest = notifications->upper_bound(timeFrameEnd); |
---|
[5619] | 333 | |
---|
[7403] | 334 | for(it = itLowest; it != itHighest; it++) // Iterate through the Notifications from the start of the time frame to the end of it. |
---|
| 335 | map->insert(std::pair<std::time_t, Notification*>(it->first, it->second)); // Add the found Notifications to the map. |
---|
| 336 | } |
---|
[5619] | 337 | |
---|
[7403] | 338 | /** |
---|
| 339 | @brief |
---|
| 340 | Enters the edit mode of the NotificationLayer. |
---|
| 341 | */ |
---|
| 342 | void NotificationManager::enterEditMode(void) |
---|
| 343 | { |
---|
[7489] | 344 | if(GameMode::showsGraphics()) |
---|
| 345 | { |
---|
| 346 | GUIManager::getInstance().hideGUI("NotificationLayer"); |
---|
| 347 | GUIManager::getInstance().showGUI("NotificationLayer", false, false); |
---|
| 348 | GUIManager::getInstance().getLuaState()->doString("NotificationLayer.enterEditMode()"); |
---|
| 349 | } |
---|
[2346] | 350 | } |
---|
[2280] | 351 | |
---|
[7403] | 352 | /** |
---|
| 353 | @brief |
---|
| 354 | Registers a NotificationQueue. |
---|
| 355 | This makes sure that the NotificationQueue can be attained through lua by name. It also makes sure that the NotificationQueue is destroyed upon destruction of the NotificationManager. |
---|
| 356 | @param queue |
---|
| 357 | A pointer to the NotificationQueue to be registered. |
---|
| 358 | @return |
---|
| 359 | Returns true if successful. If e.g. the a NotificationQueue with that name already exists this returns false. |
---|
| 360 | */ |
---|
| 361 | bool NotificationManager::registerQueue(NotificationQueue* queue) |
---|
| 362 | { |
---|
| 363 | return this->queues_.insert(std::pair<const std::string, NotificationQueue*>(queue->getName(), queue)).second; |
---|
| 364 | } |
---|
| 365 | |
---|
| 366 | /** |
---|
| 367 | @brief |
---|
| 368 | Unregisters a NotificationQueue. |
---|
| 369 | @param queue |
---|
| 370 | A pointer to the NotificationQueue to be unregistered. |
---|
| 371 | */ |
---|
| 372 | void NotificationManager::unregisterQueue(NotificationQueue* queue) |
---|
| 373 | { |
---|
| 374 | this->queues_.erase(queue->getName()); |
---|
| 375 | } |
---|
| 376 | |
---|
| 377 | /** |
---|
| 378 | @brief |
---|
| 379 | Loads all the NotificationQueues that should exist. |
---|
| 380 | */ |
---|
| 381 | void NotificationManager::loadQueues(void) |
---|
| 382 | { |
---|
| 383 | new NotificationQueue("all"); |
---|
| 384 | } |
---|
| 385 | |
---|
| 386 | /** |
---|
| 387 | @brief |
---|
| 388 | Creates a new NotificationQueue. |
---|
| 389 | This is used in lua. |
---|
| 390 | @param name |
---|
| 391 | The name of the new NotificationQueue. |
---|
| 392 | */ |
---|
| 393 | void NotificationManager::createQueue(const std::string& name) |
---|
| 394 | { |
---|
| 395 | new NotificationQueue(name); |
---|
| 396 | } |
---|
| 397 | |
---|
| 398 | /** |
---|
| 399 | @brief |
---|
| 400 | Get the NotificationQueue with the input name. |
---|
| 401 | @param name |
---|
| 402 | The name of the NotificationQueue. |
---|
| 403 | @return |
---|
| 404 | Returns a pointer to the NotificationQueue with the input name. Returns NULL if no NotificationQueue with such a name exists. |
---|
| 405 | */ |
---|
| 406 | NotificationQueue* NotificationManager::getQueue(const std::string & name) |
---|
| 407 | { |
---|
| 408 | std::map<const std::string, NotificationQueue*>::iterator it = this->queues_.find(name); |
---|
| 409 | // Returns NULL if no such NotificationQueue exists. |
---|
| 410 | if(it == this->queues_.end()) |
---|
| 411 | return NULL; |
---|
| 412 | |
---|
| 413 | return (*it).second; |
---|
| 414 | } |
---|
| 415 | |
---|
[2280] | 416 | } |
---|