2014-05-03 21:57:38 +02:00
< ? php
namespace MCTeam ;
use FML\Controls\Frame ;
use FML\Controls\Quads\Quad_BgsPlayerCard ;
use FML\ManiaLink ;
use FML\Script\Features\Paging ;
use ManiaControl\Callbacks\CallbackListener ;
use ManiaControl\Callbacks\Callbacks ;
use ManiaControl\Commands\CommandListener ;
use ManiaControl\ManiaControl ;
use ManiaControl\Manialinks\ManialinkManager ;
2014-05-03 23:49:58 +02:00
use ManiaControl\Maps\Map ;
2014-05-03 21:57:38 +02:00
use ManiaControl\Players\Player ;
use ManiaControl\Players\PlayerManager ;
use ManiaControl\Plugins\Plugin ;
use ManiaControl\Statistics\StatisticCollector ;
use ManiaControl\Statistics\StatisticManager ;
use Maniaplanet\DedicatedServer\Structures\AbstractStructure ;
/**
* ManiaControl ServerRanking Plugin
*
2014-05-03 23:49:58 +02:00
* @ author ManiaControl Team < mail @ maniacontrol . com >
* @ copyright 2014 ManiaControl Team
* @ license http :// www . gnu . org / licenses / GNU General Public License , Version 3
2014-05-03 21:57:38 +02:00
*/
class ServerRankingPlugin implements Plugin , CallbackListener , CommandListener {
/**
* Constants
*/
const PLUGIN_ID = 6 ;
const PLUGIN_VERSION = 0.1 ;
2014-05-03 23:49:58 +02:00
const PLUGIN_NAME = 'Server Ranking Plugin' ;
const PLUGIN_AUTHOR = 'MCTeam' ;
2014-05-03 21:57:38 +02:00
const TABLE_RANK = 'mc_rank' ;
const RANKING_TYPE_RECORDS = 'Records' ;
const RANKING_TYPE_RATIOS = 'Ratios' ;
const RANKING_TYPE_POINTS = 'Points' ;
const SETTING_MIN_RANKING_TYPE = 'ServerRankings Type Records/Points/Ratios' ;
const SETTING_MIN_HITS_RATIO_RANKING = 'Min Hits on Ratio Rankings' ;
const SETTING_MIN_HITS_POINTS_RANKING = 'Min Hits on Points Rankings' ;
const SETTING_MIN_REQUIRED_RECORDS = 'Minimum amount of records required on Records Ranking' ;
const SETTING_MAX_STORED_RECORDS = 'Maximum number of records per map for calculations' ;
const CB_RANK_BUILT = 'ServerRankingPlugin.RankBuilt' ;
/**
* Private Properties
*/
2014-05-03 23:49:58 +02:00
/** @var ManiaControl $maniaControl * */
2014-05-03 21:57:38 +02:00
private $maniaControl = null ;
private $recordCount = 0 ;
/**
2014-05-03 23:49:58 +02:00
* @ see \ManiaControl\Plugins\Plugin :: prepare ()
2014-05-03 21:57:38 +02:00
*/
public static function prepare ( ManiaControl $maniaControl ) {
}
/**
2014-05-03 23:49:58 +02:00
* @ see \ManiaControl\Plugins\Plugin :: getId ()
*/
public static function getId () {
return self :: PLUGIN_ID ;
}
/**
* @ see \ManiaControl\Plugins\Plugin :: getName ()
*/
public static function getName () {
return self :: PLUGIN_NAME ;
}
/**
* @ see \ManiaControl\Plugins\Plugin :: getVersion ()
*/
public static function getVersion () {
return self :: PLUGIN_VERSION ;
}
/**
* @ see \ManiaControl\Plugins\Plugin :: getAuthor ()
*/
public static function getAuthor () {
return self :: PLUGIN_AUTHOR ;
}
/**
* @ see \ManiaControl\Plugins\Plugin :: getDescription ()
*/
public static function getDescription () {
return " ServerRanking Plugin, ServerRanking by an avg build from the records, per count of points, or by a multiplication from Kill/Death Ratio and Laser accuracy " ;
}
/**
* @ see \ManiaControl\Plugins\Plugin :: load ()
2014-05-03 21:57:38 +02:00
*/
public function load ( ManiaControl $maniaControl ) {
$this -> maniaControl = $maniaControl ;
$this -> initTables ();
$maniaControl -> settingManager -> initSetting ( $this , self :: SETTING_MIN_HITS_RATIO_RANKING , 100 );
$maniaControl -> settingManager -> initSetting ( $this , self :: SETTING_MIN_HITS_POINTS_RANKING , 15 );
$maniaControl -> settingManager -> initSetting ( $this , self :: SETTING_MIN_REQUIRED_RECORDS , 3 );
$maniaControl -> settingManager -> initSetting ( $this , self :: SETTING_MAX_STORED_RECORDS , 50 );
$script = $this -> maniaControl -> client -> getScriptName ();
if ( $this -> maniaControl -> mapManager -> getCurrentMap () -> getGame () == 'tm' ) {
//TODO also add obstacle here as default
$maniaControl -> settingManager -> initSetting ( $this , self :: SETTING_MIN_RANKING_TYPE , self :: RANKING_TYPE_RECORDS );
} else if ( $script [ " CurrentValue " ] == " InstaDM.Script.txt " ) {
$maniaControl -> settingManager -> initSetting ( $this , self :: SETTING_MIN_RANKING_TYPE , self :: RANKING_TYPE_RATIOS );
} else {
$maniaControl -> settingManager -> initSetting ( $this , self :: SETTING_MIN_RANKING_TYPE , self :: RANKING_TYPE_POINTS );
}
//Check if the type is Correct
$type = $this -> maniaControl -> settingManager -> getSetting ( $this , self :: SETTING_MIN_RANKING_TYPE );
if ( $type != self :: RANKING_TYPE_RECORDS && $type != self :: RANKING_TYPE_POINTS && $type != self :: RANKING_TYPE_RATIOS ) {
$error = 'Ranking Type is not correct, possible values(' . self :: RANKING_TYPE_RATIOS . ', ' . self :: RANKING_TYPE_POINTS . ', ' . self :: RANKING_TYPE_POINTS . ')' ;
2014-05-09 17:31:29 +02:00
throw new \Exception ( $error );
2014-05-03 21:57:38 +02:00
}
//Register CallbackListeners
$this -> maniaControl -> callbackManager -> registerCallbackListener ( PlayerManager :: CB_PLAYERCONNECT , $this , 'handlePlayerConnect' );
$this -> maniaControl -> callbackManager -> registerCallbackListener ( Callbacks :: ENDMAP , $this , 'handleEndMap' );
//Register CommandListener
$this -> maniaControl -> commandManager -> registerCommandListener ( 'rank' , $this , 'command_showRank' , false , 'Shows your current serverrank.' );
$this -> maniaControl -> commandManager -> registerCommandListener ( 'nextrank' , $this , 'command_nextRank' , false , 'Shows the person in front of you in the serverranking.' );
$this -> maniaControl -> commandManager -> registerCommandListener ( array ( 'topranks' , 'top100' ), $this , 'command_topRanks' , false , 'Shows an overview of the best-ranked 100 players.' );
$this -> resetRanks (); //TODO only update records count
}
/**
* Create necessary database tables
*/
private function initTables () {
$mysqli = $this -> maniaControl -> database -> mysqli ;
$query = " CREATE TABLE IF NOT EXISTS ` " . self :: TABLE_RANK . " ` (
`PlayerIndex` mediumint ( 9 ) NOT NULL default 0 ,
`Rank` mediumint ( 9 ) NOT NULL default 0 ,
`Avg` float NOT NULL default 0 ,
KEY `PlayerIndex` ( `PlayerIndex` ),
UNIQUE `Rank` ( `Rank` )
) ENGINE = MyISAM DEFAULT CHARSET = utf8 COMMENT = 'Mania Control Serverranking' ; " ;
$mysqli -> query ( $query );
if ( $mysqli -> error ) {
trigger_error ( $mysqli -> error , E_USER_ERROR );
}
}
/**
* Resets and rebuilds the Ranking
*/
private function resetRanks () {
$mysqli = $this -> maniaControl -> database -> mysqli ;
// Erase old Average Data
$mysqli -> query ( 'TRUNCATE TABLE ' . self :: TABLE_RANK );
$type = $this -> maniaControl -> settingManager -> getSetting ( $this , self :: SETTING_MIN_RANKING_TYPE );
2014-05-03 23:49:58 +02:00
switch ( $type ) {
2014-05-03 21:57:38 +02:00
case self :: RANKING_TYPE_RATIOS :
$minHits = $this -> maniaControl -> settingManager -> getSetting ( $this , self :: SETTING_MIN_HITS_RATIO_RANKING );
$hits = $this -> maniaControl -> statisticManager -> getStatsRanking ( StatisticCollector :: STAT_ON_HIT , - 1 , $minHits );
$killDeathRatios = $this -> maniaControl -> statisticManager -> getStatsRanking ( StatisticManager :: SPECIAL_STAT_KD_RATIO );
$accuracies = $this -> maniaControl -> statisticManager -> getStatsRanking ( StatisticManager :: SPECIAL_STAT_LASER_ACC );
$ranks = array ();
2014-05-03 23:49:58 +02:00
foreach ( $hits as $player => $hitCount ) {
2014-05-03 21:57:38 +02:00
if ( ! isset ( $killDeathRatios [ $player ]) || ! isset ( $accuracies [ $player ])) {
continue ;
}
$ranks [ $player ] = $killDeathRatios [ $player ] * $accuracies [ $player ] * 1000 ;
}
arsort ( $ranks );
break ;
case self :: RANKING_TYPE_POINTS :
$minHits = $this -> maniaControl -> settingManager -> getSetting ( $this , self :: SETTING_MIN_HITS_POINTS_RANKING );
$ranks = $this -> maniaControl -> statisticManager -> getStatsRanking ( StatisticCollector :: STAT_ON_HIT , - 1 , $minHits );
break ;
case self :: RANKING_TYPE_RECORDS : //TODO verify workable status
if ( ! $this -> maniaControl -> pluginManager -> isPluginActive ( 'MCTeam\LocalRecordsPlugin' )) {
return ;
}
$requiredRecords = $this -> maniaControl -> settingManager -> getSetting ( $this , self :: SETTING_MIN_REQUIRED_RECORDS );
$maxRecords = $this -> maniaControl -> settingManager -> getSetting ( $this , self :: SETTING_MAX_STORED_RECORDS );
$query = ' SELECT playerIndex , COUNT ( * ) AS Cnt
FROM ' . \MCTeam\LocalRecordsPlugin::TABLE_RECORDS . '
GROUP BY PlayerIndex
HAVING Cnt >= ' . $requiredRecords ;
$result = $mysqli -> query ( $query );
$players = array ();
2014-05-03 23:49:58 +02:00
while ( $row = $result -> fetch_object ()) {
2014-05-03 21:57:38 +02:00
$players [ $row -> playerIndex ] = array ( 0 , 0 ); //sum, count
}
$result -> free_result ();
/** @var \MCTeam\LocalRecordsPlugin $localRecordsPlugin */
$localRecordsPlugin = $this -> maniaControl -> pluginManager -> getPlugin ( 'MCTeam\LocalRecordsPlugin' );
$maps = $this -> maniaControl -> mapManager -> getMaps ();
2014-05-03 23:49:58 +02:00
foreach ( $maps as $map ) {
2014-05-03 21:57:38 +02:00
$records = $localRecordsPlugin -> getLocalRecords ( $map , $maxRecords );
$i = 1 ;
2014-05-03 23:49:58 +02:00
foreach ( $records as $record ) {
2014-05-03 21:57:38 +02:00
if ( isset ( $players [ $record -> playerIndex ])) {
$players [ $record -> playerIndex ][ 0 ] += $i ;
$players [ $record -> playerIndex ][ 1 ] ++ ;
}
$i ++ ;
}
}
$mapCount = count ( $maps );
//compute each players new average score
$ranks = array ();
2014-05-03 23:49:58 +02:00
foreach ( $players as $player => $val ) {
2014-05-03 21:57:38 +02:00
$sum = $val [ 0 ];
$cnt = $val [ 1 ];
// ranked maps sum + $maxRecs rank for all remaining maps
$ranks [ $player ] = ( $sum + ( $mapCount - $cnt ) * $maxRecords ) / $mapCount ;
}
asort ( $ranks );
break ;
}
if ( empty ( $ranks )) {
return ;
}
$this -> recordCount = count ( $ranks );
//Compute each player's new average score
$query = " INSERT INTO " . self :: TABLE_RANK . " VALUES " ;
$i = 1 ;
2014-05-03 23:49:58 +02:00
foreach ( $ranks as $player => $rankValue ) {
2014-05-03 21:57:38 +02:00
$query .= '(' . $player . ',' . $i . ',' . $rankValue . '),' ;
$i ++ ;
}
$query = substr ( $query , 0 , strlen ( $query ) - 1 ); // strip trailing ','
$mysqli -> query ( $query );
}
2014-05-03 23:49:58 +02:00
/**
* @ see \ManiaControl\Plugins\Plugin :: unload ()
*/
public function unload () {
}
2014-05-03 21:57:38 +02:00
/**
* Handle PlayerConnect callback
*
* @ param Player $player
*/
public function handlePlayerConnect ( Player $player ) {
$this -> showRank ( $player );
$this -> showNextRank ( $player );
}
/**
* Shows the serverRank to a certain Player
*
* @ param Player $player
*/
public function showRank ( Player $player ) {
$rankObj = $this -> getRank ( $player );
$type = $this -> maniaControl -> settingManager -> getSetting ( $this , self :: SETTING_MIN_RANKING_TYPE );
$message = '' ;
if ( $rankObj ) {
2014-05-03 23:49:58 +02:00
switch ( $type ) {
2014-05-03 21:57:38 +02:00
case self :: RANKING_TYPE_RATIOS :
$kd = $this -> maniaControl -> statisticManager -> getStatisticData ( StatisticManager :: SPECIAL_STAT_KD_RATIO , $player -> index );
$acc = $this -> maniaControl -> statisticManager -> getStatisticData ( StatisticManager :: SPECIAL_STAT_LASER_ACC , $player -> index );
$message = '$0f3Your Server rank is $<$ff3' . $rankObj -> rank . '$> / $<$fff' . $this -> recordCount . '$> (K/D: $<$fff' . round ( $kd , 2 ) . '$> Acc: $<$fff' . round ( $acc * 100 ) . '%$>)' ;
break ;
case self :: RANKING_TYPE_POINTS :
$message = '$0f3Your Server rank is $<$ff3' . $rankObj -> rank . '$> / $<$fff' . $this -> recordCount . '$> Points: $fff' . $rankObj -> avg ;
break ;
case self :: RANKING_TYPE_RECORDS :
$message = '$0f3Your Server rank is $<$ff3' . $rankObj -> rank . '$> / $<$fff' . $this -> recordCount . '$> Avg: $fff' . round ( $rankObj -> avg , 2 );
}
} else {
2014-05-03 23:49:58 +02:00
switch ( $type ) {
2014-05-03 21:57:38 +02:00
case self :: RANKING_TYPE_RATIOS :
$minHits = $this -> maniaControl -> settingManager -> getSetting ( $this , self :: SETTING_MIN_HITS_RATIO_RANKING );
$message = '$0f3 You must make $<$fff' . $minHits . '$> Hits on this server before receiving a rank...' ;
break ;
case self :: RANKING_TYPE_POINTS :
$minHits = $this -> maniaControl -> settingManager -> getSetting ( $this , self :: SETTING_MIN_HITS_POINTS_RANKING );
$message = '$0f3 You must make $<$fff' . $minHits . '$> Hits on this server before receiving a rank...' ;
break ;
case self :: RANKING_TYPE_RECORDS :
$minHits = $this -> maniaControl -> settingManager -> getSetting ( $this , self :: SETTING_MIN_REQUIRED_RECORDS );
$message = '$0f3 You need $<$fff' . $minHits . '$> Records on this server before receiving a rank...' ;
}
}
$this -> maniaControl -> chat -> sendChat ( $message , $player -> login );
}
/**
* Gets A Rank As Object with properties Avg PlayerIndex and Rank
*
* @ param Player $player
* @ return Rank $rank
*/
private function getRank ( Player $player ) {
//TODO setting global from db or local
$mysqli = $this -> maniaControl -> database -> mysqli ;
$result = $mysqli -> query ( 'SELECT * FROM ' . self :: TABLE_RANK . ' WHERE PlayerIndex=' . $player -> index );
if ( $mysqli -> error ) {
trigger_error ( $mysqli -> error );
return null ;
}
if ( $result -> num_rows <= 0 ) {
$result -> free_result ();
return null ;
}
2014-05-03 23:49:58 +02:00
2014-05-03 21:57:38 +02:00
$row = $result -> fetch_array ();
$result -> free_result ();
return Rank :: fromArray ( $row );
}
2014-05-03 23:49:58 +02:00
/**
* Shows which Player is next ranked to you
*
* @ param Player $player
2014-05-09 17:31:29 +02:00
* @ return bool
2014-05-03 23:49:58 +02:00
*/
public function showNextRank ( Player $player ) {
$rankObject = $this -> getRank ( $player );
2014-05-09 17:31:29 +02:00
if ( ! $rankObject ) {
return false ;
}
2014-05-03 23:49:58 +02:00
2014-05-09 17:31:29 +02:00
if ( $rankObject -> rank > 1 ) {
$nextRank = $this -> getNextRank ( $player );
$nextPlayer = $this -> maniaControl -> playerManager -> getPlayerByIndex ( $nextRank -> playerIndex );
$message = '$0f3The next better ranked player is $fff' . $nextPlayer -> nickname ;
} else {
$message = '$0f3No better ranked player :-)' ;
2014-05-03 23:49:58 +02:00
}
2014-05-09 17:31:29 +02:00
$this -> maniaControl -> chat -> sendChat ( $message , $player -> login );
return true ;
2014-05-03 23:49:58 +02:00
}
2014-05-03 21:57:38 +02:00
/**
* Get the Next Ranked Player
*
* @ param Player $player
* @ return Rank
*/
private function getNextRank ( Player $player ) {
$mysqli = $this -> maniaControl -> database -> mysqli ;
$rankObject = $this -> getRank ( $player );
$nextRank = $rankObject -> rank - 1 ;
$result = $mysqli -> query ( 'SELECT * FROM ' . self :: TABLE_RANK . ' WHERE Rank=' . $nextRank );
if ( $result -> num_rows > 0 ) {
$row = $result -> fetch_array ();
$result -> free_result ();
return Rank :: fromArray ( $row );
} else {
$result -> free_result ();
return null ;
}
}
2014-05-03 23:49:58 +02:00
/**
* Shows Ranks on endMap
*
* @ param Map $map
*/
public function handleEndMap ( Map $map ) {
$this -> resetRanks ();
foreach ( $this -> maniaControl -> playerManager -> getPlayers () as $player ) {
/** @var Player $player */
if ( $player -> isFakePlayer ()) {
continue ;
}
$this -> showRank ( $player );
$this -> showNextRank ( $player );
}
// Trigger callback
$this -> maniaControl -> callbackManager -> triggerCallback ( self :: CB_RANK_BUILT );
}
2014-05-03 21:57:38 +02:00
/**
* Shows the current Server - Rank
*
* @ param array $chatCallback
* @ param Player $player
*/
public function command_showRank ( array $chatCallback , Player $player ) {
$this -> showRank ( $player );
}
/**
* Show the next better ranked player
*
* @ param array $chatCallback
* @ param Player $player
*/
public function command_nextRank ( array $chatCallback , Player $player ) {
if ( ! $this -> showNextRank ( $player )) {
$message = '$0f3You need to have a ServerRank first!' ;
$this -> maniaControl -> chat -> sendChat ( $message , $player -> login );
}
}
/**
* Handles / topranks | top100 command
*
* @ param array $chatCallback
* @ param Player $player
*/
public function command_topRanks ( array $chatCallback , Player $player ) {
$this -> showTopRanksList ( $player );
}
/**
2014-05-09 17:31:29 +02:00
* Provide a ManiaLink window with the top ranks to the player
2014-05-03 21:57:38 +02:00
*
* @ param Player $player
*/
private function showTopRanksList ( Player $player ) {
2014-05-03 23:49:58 +02:00
$query = " SELECT * FROM ` " . self :: TABLE_RANK . " ` ORDER BY `Rank` ASC LIMIT 0, 100 " ;
2014-05-03 21:57:38 +02:00
$mysqli = $this -> maniaControl -> database -> mysqli ;
$result = $mysqli -> query ( $query );
if ( $mysqli -> error ) {
trigger_error ( $mysqli -> error );
2014-05-09 17:31:29 +02:00
return ;
2014-05-03 21:57:38 +02:00
}
$width = $this -> maniaControl -> manialinkManager -> styleManager -> getListWidgetsWidth ();
$height = $this -> maniaControl -> manialinkManager -> styleManager -> getListWidgetsHeight ();
// create manialink
$maniaLink = new ManiaLink ( ManialinkManager :: MAIN_MLID );
2014-05-03 23:49:58 +02:00
$script = $maniaLink -> getScript ();
$paging = new Paging ();
2014-05-03 21:57:38 +02:00
$script -> addFeature ( $paging );
// Main frame
$frame = $this -> maniaControl -> manialinkManager -> styleManager -> getDefaultListFrame ( $script , $paging );
$maniaLink -> add ( $frame );
// Start offsets
$x = - $width / 2 ;
$y = $height / 2 ;
//Predefine description Label
$descriptionLabel = $this -> maniaControl -> manialinkManager -> styleManager -> getDefaultDescriptionLabel ();
$frame -> add ( $descriptionLabel );
// Headline
$headFrame = new Frame ();
$frame -> add ( $headFrame );
$headFrame -> setY ( $y - 5 );
$array = array ( '$oRank' => $x + 5 , '$oNickname' => $x + 18 , '$oAverage' => $x + 70 );
$this -> maniaControl -> manialinkManager -> labelLine ( $headFrame , $array );
$i = 1 ;
$y = $y - 10 ;
$pageFrames = array ();
2014-05-03 23:49:58 +02:00
while ( $rankedPlayer = $result -> fetch_object ()) {
2014-05-03 21:57:38 +02:00
if ( ! isset ( $pageFrame )) {
$pageFrame = new Frame ();
$frame -> add ( $pageFrame );
if ( ! empty ( $pageFrames )) {
$pageFrame -> setVisible ( false );
}
array_push ( $pageFrames , $pageFrame );
$y = $height / 2 - 10 ;
$paging -> addPage ( $pageFrame );
}
$playerFrame = new Frame ();
$pageFrame -> add ( $playerFrame );
$playerFrame -> setY ( $y );
if ( $i % 2 != 0 ) {
$lineQuad = new Quad_BgsPlayerCard ();
$playerFrame -> add ( $lineQuad );
$lineQuad -> setSize ( $width , 4 );
$lineQuad -> setSubStyle ( $lineQuad :: SUBSTYLE_BgPlayerCardBig );
$lineQuad -> setZ ( 0.001 );
}
$playerObject = $this -> maniaControl -> playerManager -> getPlayerByIndex ( $rankedPlayer -> PlayerIndex );
2014-05-03 23:49:58 +02:00
$array = array ( $rankedPlayer -> Rank => $x + 5 , $playerObject -> nickname => $x + 18 , ( string ) round ( $rankedPlayer -> Avg , 2 ) => $x + 70 );
2014-05-03 21:57:38 +02:00
$this -> maniaControl -> manialinkManager -> labelLine ( $playerFrame , $array );
$y -= 4 ;
$i ++ ;
if (( $i - 1 ) % 15 == 0 ) {
unset ( $pageFrame );
}
}
// Render and display xml
$this -> maniaControl -> manialinkManager -> displayWidget ( $maniaLink , $player , 'TopRanks' );
}
}
/**
* Rank Structure
*/
class Rank extends AbstractStructure {
public $playerIndex ;
public $rank ;
public $avg ;
}