TrackManiaControl/application/core/Maps/Jukebox.php

188 lines
5.1 KiB
PHP
Raw Normal View History

2013-12-28 19:48:06 +01:00
<?php
namespace ManiaControl\Maps;
2013-12-28 22:43:57 +01:00
use ManiaControl\Callbacks\CallbackListener;
use ManiaControl\Callbacks\CallbackManager;
2013-12-29 12:01:13 +01:00
use ManiaControl\Commands\CommandListener;
use ManiaControl\Formatter;
2013-12-28 19:48:06 +01:00
use ManiaControl\ManiaControl;
2013-12-29 12:01:13 +01:00
use ManiaControl\Players\Player;
2013-12-28 19:48:06 +01:00
/**
* Jukebox Class
*
* @author steeffeen & kremsy
*/
2013-12-29 12:01:13 +01:00
class Jukebox implements CallbackListener, CommandListener {
2013-12-28 19:48:06 +01:00
/**
* Constants
*/
const CB_JUKEBOX_CHANGED = 'Jukebox.JukeBoxChanged';
2013-12-30 11:23:00 +01:00
2013-12-29 10:17:10 +01:00
const SETTING_SKIP_MAP_ON_LEAVE = 'Skip Map when the requester leaves';
const SETTING_SKIP_JUKED_ADMIN = 'Skip Map when admin leaves';
2013-12-28 19:48:06 +01:00
2013-12-29 12:01:13 +01:00
const ADMIN_COMMAND_CLEAR_JUKEBOX = 'clearjukebox';
2013-12-28 19:48:06 +01:00
/**
* Private properties
*/
private $maniaControl = null;
private $jukedMaps = array();
2013-12-30 11:23:00 +01:00
private $nextMap = null;
2013-12-28 19:48:06 +01:00
/**
* Create a new server jukebox
*
* @param ManiaControl $maniaControl
*/
public function __construct(ManiaControl $maniaControl) {
$this->maniaControl = $maniaControl;
2013-12-28 22:43:57 +01:00
$this->maniaControl->callbackManager->registerCallbackListener(CallbackManager::CB_MC_ENDMAP, $this,'endMap');
2013-12-28 19:48:06 +01:00
2013-12-29 10:17:10 +01:00
// Init settings
$this->maniaControl->settingManager->initSetting($this, self::SETTING_SKIP_MAP_ON_LEAVE, true);
$this->maniaControl->settingManager->initSetting($this, self::SETTING_SKIP_JUKED_ADMIN, false);
2013-12-29 12:01:13 +01:00
//Register Admin Commands
$this->maniaControl->commandManager->registerCommandListener(self::ADMIN_COMMAND_CLEAR_JUKEBOX, $this, 'command_ClearJukebox', true);
}
/**
* Clears the jukebox via admin command clearjukebox
* @param array $chat
* @param Player $player
*/
public function command_ClearJukebox(array $chat, Player $admin){
$title = $this->maniaControl->authenticationManager->getAuthLevelName($admin->authLevel);
//Destroy jukebox list
$this->jukedMaps = array();
$this->maniaControl->chat->sendInformation($title . ' $<' . $admin->nickname . '$> cleared the Jukebox!');
$this->maniaControl->log($title .' ' . Formatter::stripCodes($admin->nickname) . ' cleared the Jukebox');
// Trigger callback
$this->maniaControl->callbackManager->triggerCallback(self::CB_JUKEBOX_CHANGED, array('clear'));
2013-12-28 19:48:06 +01:00
}
2013-12-28 22:43:57 +01:00
/**
* Adds a Map to the jukebox
* @param $login
* @param $uid
*/
public function addMapToJukebox($login, $uid){
2013-12-29 12:01:13 +01:00
$player = $this->maniaControl->playerManager->getPlayer($login);
2013-12-28 19:48:06 +01:00
//Check if the map is already juked
if(array_key_exists($uid, $this->jukedMaps)){
2013-12-29 14:50:31 +01:00
$this->maniaControl->chat->sendError('Map is already in the Jukebox', $login);
2013-12-28 19:48:06 +01:00
return;
}
//TODO recently maps not able to add to jukebox setting, and management
2013-12-29 12:01:13 +01:00
$map = $this->maniaControl->mapManager->getMapByUid($uid);
2013-12-29 10:17:10 +01:00
2013-12-29 12:01:13 +01:00
$this->jukedMaps[$uid] = array($player, $map);
2013-12-28 19:48:06 +01:00
2013-12-29 12:01:13 +01:00
$this->maniaControl->chat->sendInformation('$<' . $player->nickname . '$> added $<' . $map->name . '$> to the Jukebox!');
2013-12-28 19:48:06 +01:00
// Trigger callback
$this->maniaControl->callbackManager->triggerCallback(self::CB_JUKEBOX_CHANGED, array('add', $this->jukedMaps[$uid]));
2013-12-28 22:43:57 +01:00
}
/**
* Revmoes a Map from the jukebox
* @param $login
* @param $uid
*/
public function removeFromJukebox($login, $uid){
unset($this->jukedMaps[$uid]);
}
2013-12-29 10:17:10 +01:00
/**
* Called on endmap
* @param array $callback
*/
public function endMap(array $callback){
2013-12-30 11:23:00 +01:00
$this->nextMap = null;
2013-12-29 10:17:10 +01:00
if($this->maniaControl->settingManager->getSetting($this, self::SETTING_SKIP_MAP_ON_LEAVE) == TRUE){
2013-12-29 12:01:13 +01:00
2013-12-29 10:17:10 +01:00
//Skip Map if requester has left
2013-12-29 12:01:13 +01:00
foreach($this->jukedMaps as $jukedMap){
$player = $jukedMap[0];
2013-12-28 22:43:57 +01:00
2013-12-29 10:17:10 +01:00
//found player, so play this map
2013-12-29 12:01:13 +01:00
if($this->maniaControl->playerManager->getPlayer($player->login) != null){
2013-12-29 10:17:10 +01:00
break;
}
2013-12-28 22:43:57 +01:00
2013-12-29 10:17:10 +01:00
if($this->maniaControl->settingManager->getSetting($this, self::SETTING_SKIP_JUKED_ADMIN) == FALSE){
2013-12-29 12:01:13 +01:00
//Check if the juker is a admin
if($player->authLevel > 0){
break;
}
2013-12-29 10:17:10 +01:00
}
2013-12-28 22:43:57 +01:00
2013-12-29 10:17:10 +01:00
// Trigger callback
$this->maniaControl->callbackManager->triggerCallback(self::CB_JUKEBOX_CHANGED, array('skip', $jukedMap[0]));
2013-12-28 22:43:57 +01:00
2013-12-29 10:17:10 +01:00
//Player not found, so remove the map from the jukebox
array_shift($this->jukedMaps);
2013-12-29 12:01:13 +01:00
$this->maniaControl->chat->sendInformation('Juked Map skipped because $<' . $player->nickname . '$> left!');
2013-12-29 10:17:10 +01:00
}
}
2013-12-29 12:01:13 +01:00
2013-12-30 11:23:00 +01:00
$this->nextMap = array_shift($this->jukedMaps);
2013-12-28 22:43:57 +01:00
//Check if Jukebox is empty
2013-12-30 11:23:00 +01:00
if($this->nextMap == null)
2013-12-28 22:43:57 +01:00
return;
2013-12-30 11:23:00 +01:00
$map = $this->nextMap[1];
2013-12-28 22:43:57 +01:00
2013-12-30 11:23:00 +01:00
$success = $this->maniaControl->client->query('ChooseNextMap', $map->fileName);
2013-12-28 23:24:54 +01:00
if (!$success) {
trigger_error('[' . $this->maniaControl->client->getErrorCode() . '] ChooseNextMap - ' . $this->maniaControl->client->getErrorCode(), E_USER_WARNING);
return;
}
2013-12-28 19:48:06 +01:00
}
2013-12-28 22:43:57 +01:00
2013-12-30 11:23:00 +01:00
/**
* Returns the next Map if the next map is a juked map or null if it's not
* @return null
*/
public function getNextMap(){
return $this->nextMap;
}
/**
* Returns a list with the indexes of the juked maps
* @return array
*/
public function getJukeBoxRanking(){
$i = 1;
$jukedMaps = array();
foreach($this->jukedMaps as $map){
$map = $map[1];
$jukedMaps[$map->uid] = $i;
$i++;
}
return $jukedMaps;
}
2013-12-28 23:35:40 +01:00
2013-12-29 10:17:10 +01:00
/**
* Dummy Function for testing
*/
2013-12-28 22:43:57 +01:00
public function printAllMaps(){
foreach($this->jukedMaps as $map){
$map = $map[1];
var_dump($map->name);
}
}
2013-12-28 19:48:06 +01:00
}