TrackManiaControl/application/core/Players/PlayerManager.php

499 lines
14 KiB
PHP
Raw Normal View History

2013-11-09 20:18:49 +01:00
<?php
namespace ManiaControl\Players;
use ManiaControl\Admin\AdminLists;
use ManiaControl\Callbacks\CallbackListener;
use ManiaControl\Callbacks\CallbackManager;
use ManiaControl\Callbacks\Callbacks;
2014-03-02 11:25:47 +01:00
use ManiaControl\Callbacks\TimerListener;
use ManiaControl\ManiaControl;
2014-01-03 19:14:07 +01:00
use ManiaControl\Statistics\StatisticManager;
use ManiaControl\Utils\Formatter;
use Maniaplanet\DedicatedServer\Xmlrpc\UnknownPlayerException;
2013-11-09 20:18:49 +01:00
/**
* Class managing Players
*
2014-05-02 17:50:30 +02:00
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014 ManiaControl Team
2014-04-20 19:59:01 +02:00
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
2013-11-09 20:18:49 +01:00
*/
2014-03-02 11:25:47 +01:00
class PlayerManager implements CallbackListener, TimerListener {
/*
* Constants
*/
2014-02-19 10:43:37 +01:00
const CB_PLAYERCONNECT = 'PlayerManagerCallback.PlayerConnect';
const CB_PLAYERDISCONNECT = 'PlayerManagerCallback.PlayerDisconnect';
2014-01-16 00:24:24 +01:00
const CB_PLAYERINFOCHANGED = 'PlayerManagerCallback.PlayerInfoChanged';
2014-05-04 16:45:59 +02:00
const CB_SERVER_EMPTY = 'PlayerManagerCallback.ServerEmpty';
2014-01-16 00:24:24 +01:00
const TABLE_PLAYERS = 'mc_players';
const SETTING_JOIN_LEAVE_MESSAGES = 'Enable Join & Leave Messages';
2014-01-16 00:24:24 +01:00
const STAT_JOIN_COUNT = 'Joins';
const STAT_SERVERTIME = 'Servertime';
/*
2014-01-01 18:53:19 +01:00
* Public Properties
*/
2014-01-01 18:53:19 +01:00
public $playerActions = null;
public $playerCommands = null;
2014-01-03 16:24:35 +01:00
public $playerDetailed = null;
public $playerList = null;
public $adminLists = null;
2014-05-27 22:44:22 +02:00
/** @var Player[] $players */
public $players = array();
2014-01-16 00:24:24 +01:00
/*
2014-01-01 18:53:19 +01:00
* Private Properties
2013-12-28 19:48:06 +01:00
*/
2014-01-01 18:53:19 +01:00
private $maniaControl = null;
2013-12-28 19:48:06 +01:00
/**
2014-01-01 18:53:19 +01:00
* Construct a new Player Manager
*
2014-05-04 16:45:59 +02:00
* @param ManiaControl $maniaControl
*/
public function __construct(ManiaControl $maniaControl) {
$this->maniaControl = $maniaControl;
$this->initTables();
2014-01-16 00:24:24 +01:00
$this->playerCommands = new PlayerCommands($maniaControl);
$this->playerActions = new PlayerActions($maniaControl);
$this->playerDetailed = new PlayerDetailed($maniaControl);
$this->playerDataManager = new PlayerDataManager($maniaControl);
$this->playerList = new PlayerList($maniaControl);
$this->adminLists = new AdminLists($maniaControl);
2014-01-16 00:24:24 +01:00
// Init settings
2013-12-08 22:38:20 +01:00
$this->maniaControl->settingManager->initSetting($this, self::SETTING_JOIN_LEAVE_MESSAGES, true);
2014-01-16 00:24:24 +01:00
// Register for callbacks
$this->maniaControl->callbackManager->registerCallbackListener(Callbacks::ONINIT, $this, 'onInit');
$this->maniaControl->callbackManager->registerCallbackListener(CallbackManager::CB_MP_PLAYERCONNECT, $this, 'playerConnect');
2014-01-02 13:35:52 +01:00
$this->maniaControl->callbackManager->registerCallbackListener(CallbackManager::CB_MP_PLAYERDISCONNECT, $this, 'playerDisconnect');
$this->maniaControl->callbackManager->registerCallbackListener(CallbackManager::CB_MP_PLAYERINFOCHANGED, $this, 'playerInfoChanged');
2014-01-16 00:24:24 +01:00
2014-01-01 18:53:19 +01:00
// Define player stats
$this->maniaControl->statisticManager->defineStatMetaData(self::STAT_JOIN_COUNT);
2014-01-03 21:11:13 +01:00
$this->maniaControl->statisticManager->defineStatMetaData(self::STAT_SERVERTIME, StatisticManager::STAT_TYPE_TIME);
}
2013-11-09 23:01:54 +01:00
/**
2014-05-04 16:45:59 +02:00
* Initialize necessary Database Tables
*
* @return bool
*/
private function initTables() {
2014-01-16 00:24:24 +01:00
$mysqli = $this->maniaControl->database->mysqli;
$playerTableQuery = "CREATE TABLE IF NOT EXISTS `" . self::TABLE_PLAYERS . "` (
`index` int(11) NOT NULL AUTO_INCREMENT,
`login` varchar(100) NOT NULL,
`nickname` varchar(150) NOT NULL,
`path` varchar(100) NOT NULL,
`authLevel` int(11) NOT NULL DEFAULT '0',
`changed` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
PRIMARY KEY (`index`),
UNIQUE KEY `login` (`login`)
2014-01-01 18:53:19 +01:00
) ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci COMMENT='Player Data' AUTO_INCREMENT=1;";
$playerTableStatement = $mysqli->prepare($playerTableQuery);
2014-01-28 17:12:23 +01:00
if ($mysqli->error) {
trigger_error($mysqli->error, E_USER_ERROR);
return false;
}
$playerTableStatement->execute();
2014-01-28 17:12:23 +01:00
if ($playerTableStatement->error) {
trigger_error($playerTableStatement->error, E_USER_ERROR);
2014-05-04 16:45:59 +02:00
$playerTableStatement->close();
return false;
}
$playerTableStatement->close();
return true;
}
2013-11-09 20:18:49 +01:00
/**
* Handle OnInit callback
*/
public function onInit() {
// Add all players
2014-01-16 18:08:32 +01:00
$players = $this->maniaControl->client->getPlayerList(300, 0, 2);
2014-05-02 17:50:30 +02:00
foreach ($players as $playerItem) {
2014-01-28 17:12:23 +01:00
if ($playerItem->playerId <= 0) {
continue;
}
2014-05-03 19:53:34 +02:00
$detailedPlayerInfo = $this->maniaControl->client->getDetailedPlayerInfo($playerItem->login);
2014-01-25 11:40:34 +01:00
2014-02-01 19:06:21 +01:00
//Check if the Player is in a Team, to notify if its a TeamMode or not
if ($playerItem->teamId >= 0) {
$this->maniaControl->server->setTeamMode(true);
2014-02-01 19:06:21 +01:00
}
2014-05-09 17:30:43 +02:00
$player = new Player($this->maniaControl, true);
2014-05-03 19:53:34 +02:00
$player->setInfo($playerItem);
$player->setDetailedInfo($detailedPlayerInfo);
2014-01-23 16:15:41 +01:00
$player->hasJoinedGame = true;
$this->addPlayer($player);
}
}
2013-11-09 20:18:49 +01:00
2014-05-02 17:50:30 +02:00
/**
* Add a player
*
* @param Player $player
* @return bool
*/
private function addPlayer(Player $player) {
$this->savePlayer($player);
$this->players[$player->login] = $player;
return true;
}
/**
* Save player in Database and fill up Object Properties
*
* @param Player $player
* @return bool
*/
private function savePlayer(Player &$player) {
$mysqli = $this->maniaControl->database->mysqli;
// Save player
$playerQuery = "INSERT INTO `" . self::TABLE_PLAYERS . "` (
`login`,
`nickname`,
`path`
) VALUES (
?, ?, ?
) ON DUPLICATE KEY UPDATE
`index` = LAST_INSERT_ID(`index`),
`nickname` = VALUES(`nickname`),
`path` = VALUES(`path`);";
$playerStatement = $mysqli->prepare($playerQuery);
if ($mysqli->error) {
trigger_error($mysqli->error);
return false;
}
$playerStatement->bind_param('sss', $player->login, $player->rawNickname, $player->path);
$playerStatement->execute();
if ($playerStatement->error) {
trigger_error($playerStatement->error);
$playerStatement->close();
return false;
}
$player->index = $playerStatement->insert_id;
$playerStatement->close();
// Get Player Auth Level from DB
$playerQuery = "SELECT `authLevel` FROM `" . self::TABLE_PLAYERS . "` WHERE `index` = ?;";
$playerStatement = $mysqli->prepare($playerQuery);
if ($mysqli->error) {
trigger_error($mysqli->error);
return false;
}
$playerStatement->bind_param('i', $player->index);
$playerStatement->execute();
if ($playerStatement->error) {
trigger_error($playerStatement->error);
$playerStatement->close();
return false;
}
$playerStatement->store_result();
$playerStatement->bind_result($player->authLevel);
$playerStatement->fetch();
$playerStatement->free_result();
$playerStatement->close();
return true;
}
/**
2014-05-04 16:45:59 +02:00
* Handle PlayerConnect Callback
*
2013-12-31 15:27:25 +01:00
* @param array $callback
*/
public function playerConnect(array $callback) {
2014-03-13 18:25:29 +01:00
$login = $callback[1][0];
try {
$playerInfo = $this->maniaControl->client->getDetailedPlayerInfo($login);
2014-05-09 17:30:43 +02:00
$player = new Player($this->maniaControl, true);
2014-05-03 19:53:34 +02:00
$player->setDetailedInfo($playerInfo);
2014-01-16 00:24:24 +01:00
2014-03-13 18:25:29 +01:00
$this->addPlayer($player);
} catch (UnknownPlayerException $e) {
2014-03-13 18:25:29 +01:00
}
}
2013-11-09 22:08:06 +01:00
/**
2014-05-04 16:45:59 +02:00
* Handle PlayerDisconnect callback
*
2013-12-31 15:27:25 +01:00
* @param array $callback
*/
public function playerDisconnect(array $callback) {
2014-01-16 00:24:24 +01:00
$login = $callback[1][0];
$player = $this->removePlayer($login);
2014-04-20 19:59:01 +02:00
if (!$player) {
return;
}
2014-05-04 16:45:59 +02:00
// Trigger own callbacks
$this->maniaControl->callbackManager->triggerCallback(self::CB_PLAYERDISCONNECT, $player);
2014-05-04 16:45:59 +02:00
if ($this->getPlayerCount(false) <= 0) {
$this->maniaControl->callbackManager->triggerCallback(self::CB_SERVER_EMPTY);
}
2014-01-16 00:24:24 +01:00
if ($player->isFakePlayer()) {
2014-04-20 19:59:01 +02:00
return;
}
2014-01-16 00:24:24 +01:00
$played = Formatter::formatTimeH(time() - $player->joinTime);
2014-01-01 18:53:19 +01:00
$logMessage = "Player left: {$player->login} / {$player->nickname} Playtime: {$played}";
$this->maniaControl->log(Formatter::stripCodes($logMessage));
2014-01-16 00:24:24 +01:00
2014-05-13 16:03:26 +02:00
if ($this->maniaControl->settingManager->getSettingValue($this, self::SETTING_JOIN_LEAVE_MESSAGES)) {
2014-04-28 18:25:45 +02:00
$this->maniaControl->chat->sendChat('$0f0$<$fff' . $player->nickname . '$> has left the game');
}
2014-04-22 22:42:34 +02:00
//Destroys stored PlayerData, after all Disconnect Callbacks got Handled
$this->playerDataManager->destroyPlayerData($player);
}
2013-11-09 22:08:06 +01:00
2014-05-02 17:50:30 +02:00
/**
* Remove a Player
*
* @param string $login
* @param bool $savePlayedTime
* @return Player $player
*/
private function removePlayer($login, $savePlayedTime = true) {
if (!isset($this->players[$login])) {
return null;
}
$player = $this->players[$login];
unset($this->players[$login]);
if ($savePlayedTime) {
$this->updatePlayedTime($player);
}
return $player;
}
/**
* Update total played time of the player
*
* @param Player $player
* @return bool
*/
private function updatePlayedTime(Player $player) {
if (!$player) {
return false;
}
$playedTime = time() - $player->joinTime;
return $this->maniaControl->statisticManager->insertStat(self::STAT_SERVERTIME, $player, $this->maniaControl->server->index, $playedTime);
}
2014-05-04 16:45:59 +02:00
/**
* Get the Count of all Player
*
* @param bool $withoutSpectators
* @return int
*/
public function getPlayerCount($withoutSpectators = true) {
2014-05-27 22:44:22 +02:00
if (!$withoutSpectators) {
return count($this->players);
}
2014-05-04 16:45:59 +02:00
$count = 0;
foreach ($this->players as $player) {
2014-05-27 22:44:22 +02:00
if (!$player->isSpectator) {
2014-05-04 16:45:59 +02:00
$count++;
}
}
return $count;
}
2013-12-19 21:59:10 +01:00
/**
* Update PlayerInfo
2013-12-31 15:27:25 +01:00
*
2013-12-19 21:59:10 +01:00
* @param array $callback
*/
2013-12-31 15:27:25 +01:00
public function playerInfoChanged(array $callback) {
2013-12-19 21:59:10 +01:00
$player = $this->getPlayer($callback[1][0]['Login']);
2014-04-22 22:42:34 +02:00
if (!$player) {
2014-04-20 19:59:01 +02:00
return;
2014-04-22 22:42:34 +02:00
}
2014-01-16 00:24:24 +01:00
2014-01-24 22:34:35 +01:00
$player->ladderRank = $callback[1][0]["LadderRanking"];
2014-02-01 19:06:21 +01:00
$player->teamId = $callback[1][0]["TeamId"];
//Check if the Player is in a Team, to notify if its a TeamMode or not
if ($player->teamId >= 0) {
$this->maniaControl->server->setTeamMode(true);
2014-02-01 19:06:21 +01:00
}
2014-01-16 00:24:24 +01:00
2014-01-23 16:15:41 +01:00
$prevJoinState = $player->hasJoinedGame;
$player->updatePlayerFlags($callback[1][0]["Flags"]);
$player->updateSpectatorStatus($callback[1][0]["SpectatorStatus"]);
//Check if Player finished joining the game
2014-03-02 14:18:10 +01:00
if ($player->hasJoinedGame && !$prevJoinState) {
2014-05-13 16:03:26 +02:00
if ($this->maniaControl->settingManager->getSettingValue($this, self::SETTING_JOIN_LEAVE_MESSAGES) && !$player->isFakePlayer()) {
2014-03-02 14:18:10 +01:00
$string = array(0 => '$0f0Player', 1 => '$0f0Moderator', 2 => '$0f0Admin', 3 => '$0f0SuperAdmin', 4 => '$0f0MasterAdmin');
2014-04-28 18:25:45 +02:00
$chatMessage = '$0f0' . $string[$player->authLevel] . ' $<$fff' . $player->nickname . '$> Nation: $<$fff' . $player->getCountry() . '$> joined!';
2014-03-02 14:18:10 +01:00
$this->maniaControl->chat->sendChat($chatMessage);
$this->maniaControl->chat->sendInformation('This server uses ManiaControl v' . ManiaControl::VERSION . '!', $player->login);
}
$logMessage = "Player joined: {$player->login} / " . Formatter::stripCodes($player->nickname) . " Nation: " . $player->getCountry() . " IP: {$player->ipAddress}";
$this->maniaControl->log($logMessage);
// Increment the Player Join Count
$this->maniaControl->statisticManager->incrementStat(self::STAT_JOIN_COUNT, $player, $this->maniaControl->server->index);
// Trigger own PlayerJoined callback
$this->maniaControl->callbackManager->triggerCallback(self::CB_PLAYERCONNECT, $player);
2014-01-23 16:15:41 +01:00
}
2014-01-24 15:32:34 +01:00
2013-12-19 21:59:10 +01:00
// Trigger own callback
$this->maniaControl->callbackManager->triggerCallback(self::CB_PLAYERINFOCHANGED, $player);
2013-12-19 21:59:10 +01:00
}
2014-05-02 17:50:30 +02:00
/**
* Get a Player by Login
*
2014-05-15 19:30:44 +02:00
* @param mixed $login
* @param bool $connectedPlayersOnly
2014-05-02 17:50:30 +02:00
* @return Player
*/
public function getPlayer($login, $connectedPlayersOnly = false) {
2014-05-15 19:30:44 +02:00
if ($login instanceof Player) {
return $login;
}
2014-05-02 17:50:30 +02:00
if (!isset($this->players[$login])) {
if ($connectedPlayersOnly) {
return null;
}
return $this->getPlayerFromDatabaseByLogin($login);
}
return $this->players[$login];
}
/**
* Get a Player from the Database
*
* @param string $playerLogin
* @return Player
*/
private function getPlayerFromDatabaseByLogin($playerLogin) {
$mysqli = $this->maniaControl->database->mysqli;
$query = "SELECT * FROM `" . self::TABLE_PLAYERS . "`
WHERE `login` LIKE '" . $mysqli->escape_string($playerLogin) . "';";
2014-05-02 17:50:30 +02:00
$result = $mysqli->query($query);
if (!$result) {
trigger_error($mysqli->error);
return null;
}
$row = $result->fetch_object();
$result->free();
2014-05-02 17:50:30 +02:00
if (!isset($row)) {
return null;
}
2014-05-09 17:30:43 +02:00
$player = new Player($this->maniaControl, false);
2014-05-02 17:50:30 +02:00
$player->index = $row->index;
$player->login = $row->login;
$player->rawNickname = $row->nickname;
$player->nickname = Formatter::stripDirtyCodes($player->rawNickname);
$player->path = $row->path;
$player->authLevel = $row->authLevel;
return $player;
}
2014-01-23 16:15:41 +01:00
/**
* Get all Players
*
2014-05-27 22:44:22 +02:00
* @return Player[]
*/
public function getPlayers() {
return $this->players;
}
2014-02-08 20:29:50 +01:00
/**
* Gets the Count of all Spectators
2014-02-15 23:08:51 +01:00
*
2014-02-08 20:29:50 +01:00
* @return int
*/
2014-02-15 23:08:51 +01:00
public function getSpectatorCount() {
2014-02-08 20:29:50 +01:00
$count = 0;
2014-05-02 17:50:30 +02:00
foreach ($this->players as $player) {
2014-02-15 23:08:51 +01:00
if ($player->isSpectator) {
2014-02-08 20:29:50 +01:00
$count++;
}
}
return $count;
}
2014-01-16 00:24:24 +01:00
/**
2014-05-27 22:44:22 +02:00
* Gets a Player by his Index
2014-01-16 00:24:24 +01:00
*
2014-05-04 16:45:59 +02:00
* @param int $index
2014-04-20 19:59:01 +02:00
* @param bool $connectedPlayersOnly
2014-05-27 22:44:22 +02:00
* @return Player
2014-01-16 00:24:24 +01:00
*/
2014-04-20 19:59:01 +02:00
public function getPlayerByIndex($index, $connectedPlayersOnly = false) {
2014-05-02 17:50:30 +02:00
foreach ($this->players as $player) {
if ($player->index === $index) {
2014-01-16 00:24:24 +01:00
return $player;
}
}
2014-04-20 19:59:01 +02:00
if ($connectedPlayersOnly) {
return null;
}
2014-01-21 21:58:39 +01:00
//Player is not online -> get Player from Database
return $this->getPlayerFromDatabaseByIndex($index);
2014-01-16 00:24:24 +01:00
}
2014-01-21 21:58:39 +01:00
/**
2014-05-04 16:45:59 +02:00
* Get a Player out of the database
2014-01-21 21:58:39 +01:00
*
2014-05-04 16:45:59 +02:00
* @param int $playerIndex
2014-01-21 21:58:39 +01:00
* @return Player $player
*/
private function getPlayerFromDatabaseByIndex($playerIndex) {
$mysqli = $this->maniaControl->database->mysqli;
2014-01-28 17:12:23 +01:00
if (!is_numeric($playerIndex)) {
2014-01-21 21:58:39 +01:00
return null;
}
$query = "SELECT * FROM `" . self::TABLE_PLAYERS . "` WHERE `index` = " . $playerIndex . ";";
$result = $mysqli->query($query);
2014-01-28 17:12:23 +01:00
if (!$result) {
2014-01-21 21:58:39 +01:00
trigger_error($mysqli->error);
return null;
}
$row = $result->fetch_object();
$result->free();
2014-01-21 21:58:39 +01:00
2014-01-31 14:19:39 +01:00
if (!isset($row)) {
return null;
}
2014-02-01 19:06:21 +01:00
2014-05-09 17:30:43 +02:00
$player = new Player($this->maniaControl, false);
2014-02-24 20:20:17 +01:00
$player->index = $playerIndex;
$player->login = $row->login;
$player->rawNickname = $row->nickname;
$player->nickname = Formatter::stripDirtyCodes($player->rawNickname);
$player->path = $row->path;
$player->authLevel = $row->authLevel;
2014-01-21 21:58:39 +01:00
return $player;
}
}