settingManager->initSetting(get_class(), self::SETTING_MX_KARMA_ACTIVATED, true); $maniaControl->settingManager->initSetting(get_class(), self::SETTING_MX_KARMA_IMPORTING, true); $servers = $maniaControl->server->getAllServers(); foreach($servers as $server) { $maniaControl->settingManager->initSetting(get_class(), '$l[http://karma.mania-exchange.com/auth/getapikey?server=' . $server->login . ']MX Karma Code for ' . $server->login . '$l', ''); } } /** * @see \ManiaControl\Plugins\Plugin::load() */ public function load(ManiaControl $maniaControl) { $this->maniaControl = $maniaControl; // Init database $this->initTables(); // Init settings $this->maniaControl->settingManager->initSetting($this, self::SETTING_AVAILABLE_VOTES, '-2,2'); $this->maniaControl->settingManager->initSetting($this, self::SETTING_WIDGET_TITLE, 'Map-Karma'); $this->maniaControl->settingManager->initSetting($this, self::SETTING_WIDGET_POSX, 160 - 27.5); $this->maniaControl->settingManager->initSetting($this, self::SETTING_WIDGET_POSY, 90 - 10 - 6); $this->maniaControl->settingManager->initSetting($this, self::SETTING_WIDGET_WIDTH, 25.); $this->maniaControl->settingManager->initSetting($this, self::SETTING_WIDGET_HEIGHT, 12.); // Register for callbacks $this->maniaControl->timerManager->registerTimerListening($this, 'handle1Second', 1000); $this->maniaControl->callbackManager->registerCallbackListener(MapManager::CB_BEGINMAP, $this, 'handleBeginMap'); $this->maniaControl->callbackManager->registerCallbackListener(MapManager::CB_BEGINMAP, $this, 'importMxKarmaVotes'); $this->maniaControl->callbackManager->registerCallbackListener(MapManager::CB_ENDMAP, $this, 'sendMxKarmaVotes'); $this->maniaControl->callbackManager->registerCallbackListener(CallbackManager::CB_MP_PLAYERCONNECT, $this, 'handlePlayerConnect'); $this->maniaControl->callbackManager->registerCallbackListener(CallbackManager::CB_MP_PLAYERCHAT, $this, 'handlePlayerChat'); // Define player stats $this->maniaControl->statisticManager->defineStatMetaData(self::STAT_PLAYER_MAPVOTES); // Register Stat in Simple StatsList $this->maniaControl->statisticManager->simpleStatsList->registerStat(self::STAT_PLAYER_MAPVOTES, 100, "VM"); $this->updateManialink = true; $this->mxKarmaOpenSession(); return true; } /** * @see \ManiaControl\Plugins\Plugin::unload() */ public function unload() { $emptyManialink = new ManiaLink(self::MLID_KARMA); $manialinkText = $emptyManialink->render()->saveXML(); $this->maniaControl->manialinkManager->sendManialink($manialinkText); $this->maniaControl->callbackManager->unregisterCallbackListener($this); $this->maniaControl->timerManager->unregisterTimerListenings($this); unset($this->maniaControl); } /** * @see \ManiaControl\Plugins\Plugin::getId() */ public static function getId() { return self::ID; } /** * @see \ManiaControl\Plugins\Plugin::getName() */ public static function getName() { return 'Karma Plugin'; } /** * @see \ManiaControl\Plugins\Plugin::getVersion() */ public static function getVersion() { return self::VERSION; } /** * @see \ManiaControl\Plugins\Plugin::getAuthor() */ public static function getAuthor() { return 'steeffeen and kremsy'; } /** * @see \ManiaControl\Plugins\Plugin::getDescription() */ public static function getDescription() { return 'Plugin offering Karma Voting for Maps.'; } /** * Handle ManiaControl 1 Second callback * * @param $time */ public function handle1Second($time) { if (!$this->updateManialink) { return; } // Get players $players = $this->updateManialink; if ($players === true) { $players = $this->maniaControl->playerManager->getPlayers(); } $this->updateManialink = false; // Get map karma $map = $this->maniaControl->mapManager->getCurrentMap(); $karma = $this->getMapKarma($map); $votes = $this->getMapVotes($map); // Build karma manialink $this->buildManialink(); // Update karma gauge & label $karmaGauge = $this->manialink->karmaGauge; $karmaLabel = $this->manialink->karmaLabel; if (is_numeric($karma)) { $karma = floatval($karma); $karmaGauge->setRatio($karma + 0.15 - $karma * 0.15); $karmaColor = ColorUtil::floatToStatusColor($karma); $karmaGauge->setColor($karmaColor . '7'); $karmaLabel->setText(' ' . round($karma * 100.) . '% (' . $votes['count'] . ')'); } else { $karma = 0.; $karmaGauge->setRatio(0.); $karmaGauge->setColor('00fb'); $karmaLabel->setText('-'); } // Loop players foreach($players as $login => $player) { // Get player vote $vote = $this->getPlayerVote($player, $map); //TODO what is this for, vote nowhere used? // Adjust manialink for player's vote $votesFrame = $this->manialink->votesFrame; $votesFrame->removeChildren(); // Send manialink $manialinkText = $this->manialink->render()->saveXML(); $this->maniaControl->manialinkManager->sendManialink($manialinkText, $login); } } /** * Handle BeginMap ManiaControl callback * * @param Map $map */ public function handleBeginMap(Map $map) { unset($this->mxKarma['votes']); $this->updateManialink = true; } /** * Handle PlayerConnect callback * * @param array $callback */ public function handlePlayerConnect(array $callback) { $login = $callback[1][0]; $player = $this->maniaControl->playerManager->getPlayer($login); if (!$player) { return; } $this->queryManialinkUpdateFor($player); } /** * Handle PlayerChat callback * * @param array $chatCallback */ public function handlePlayerChat(array $chatCallback) { $login = $chatCallback[1][1]; $player = $this->maniaControl->playerManager->getPlayer($login); if (!$player) { return; } $message = $chatCallback[1][2]; if ($chatCallback[1][3]) { $message = substr($message, 1); } if (preg_match('/[^+-]/', $message)) { return; } $countPositive = substr_count($message, '+'); $countNegative = substr_count($message, '-'); if ($countPositive <= 0 && $countNegative <= 0) { return; } $vote = $countPositive - $countNegative; $success = $this->handleVote($player, $vote); if (!$success) { $this->maniaControl->chat->sendError('Error occurred.', $player->login); return; } $this->maniaControl->chat->sendSuccess('Vote updated!', $player->login); } /** * Handle a vote done by a player * * @param Player $player * @param int $vote * @return bool */ private function handleVote(Player $player, $vote) { // Check vote $votesSetting = $this->maniaControl->settingManager->getSetting($this, self::SETTING_AVAILABLE_VOTES); $votes = explode(',', $votesSetting); $voteLow = intval($votes[0]); $voteHigh = $voteLow + 2; if (isset($votes[1])) { $voteHigh = intval($votes[1]); } if ($vote < $voteLow || $vote > $voteHigh) { return false; } // Calculate actual voting $vote -= $voteLow; $voteHigh -= $voteLow; $vote /= $voteHigh; // Save vote $map = $this->maniaControl->mapManager->getCurrentMap(); $voted = $this->getPlayerVote($player, $map); if (!$voted) { $this->maniaControl->statisticManager->incrementStat(self::STAT_PLAYER_MAPVOTES, $player, $this->maniaControl->server->index); } $success = $this->savePlayerVote($player, $map, $vote); if (!$success) { return false; } $this->updateManialink = true; return true; } /** * Query the player to update the manialink * * @param Player $player */ private function queryManialinkUpdateFor(Player $player) { if ($this->updateManialink === true) { return; } if (!is_array($this->updateManialink)) { $this->updateManialink = array(); } $this->updateManialink[$player->login] = $player; } /** * Create necessary database tables */ private function initTables() { $mysqli = $this->maniaControl->database->mysqli; $query = "CREATE TABLE IF NOT EXISTS `" . self::TABLE_KARMA . "` ( `index` int(11) NOT NULL AUTO_INCREMENT, `mapIndex` int(11) NOT NULL, `playerIndex` int(11) NOT NULL, `vote` float NOT NULL DEFAULT '-1', `changed` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, PRIMARY KEY (`index`), UNIQUE KEY `player_map_vote` (`mapIndex`, `playerIndex`) ) ENGINE=MyISAM DEFAULT CHARSET=utf8 COMMENT='Save players map votes' AUTO_INCREMENT=1;"; $mysqli->query($query); if ($mysqli->error) { trigger_error($mysqli->error, E_USER_ERROR); } if (!$this->maniaControl->settingManager->getSetting($this, self::SETTING_MX_KARMA_ACTIVATED)) { return; } $query = "CREATE TABLE IF NOT EXISTS `" . self::MX_IMPORT_TABLE . "` ( `index` int(11) NOT NULL AUTO_INCREMENT, `mapIndex` int(11) NOT NULL, `mapImported` tinyint(1) NOT NULL, `time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, PRIMARY KEY (`index`), UNIQUE KEY `mapIndex` (`mapIndex`) ) ENGINE=MyISAM DEFAULT CHARSET=utf8 COMMENT='MX Karma Import Table' AUTO_INCREMENT=1;"; $mysqli->query($query); if ($mysqli->error) { trigger_error($mysqli->error, E_USER_ERROR); } } /** * Save the vote of the player for the map * * @param Player $player * @param Map $map * @param float $vote * @return bool */ private function savePlayerVote(Player $player, Map $map, $vote) { $mysqli = $this->maniaControl->database->mysqli; $query = "INSERT INTO `" . self::TABLE_KARMA . "` ( `mapIndex`, `playerIndex`, `vote` ) VALUES ( {$map->index}, {$player->index}, {$vote} ) ON DUPLICATE KEY UPDATE `vote` = VALUES(`vote`);"; $result = $mysqli->query($query); if ($mysqli->error) { trigger_error($mysqli->error); return false; } //Update vote in MX karma array if ($this->maniaControl->settingManager->getSetting($this, self::SETTING_MX_KARMA_ACTIVATED)) { $this->mxKarma["votes"][$player->login] = $vote * 100; } return $result; } /** * Get the current vote of the player for the map * * @param Player $player * @param Map $map * @return int */ private function getPlayerVote(Player $player, Map $map) { $mysqli = $this->maniaControl->database->mysqli; $query = "SELECT * FROM `" . self::TABLE_KARMA . "` WHERE `playerIndex` = {$player->index} AND `mapIndex` = {$map->index} AND `vote` >= 0;"; $result = $mysqli->query($query); if ($mysqli->error) { trigger_error($mysqli->error); return false; } if ($result->num_rows <= 0) { $result->free(); return false; } $item = $result->fetch_object(); $result->free(); $vote = $item->vote; return floatval($vote); } /** * Get the current karma of the map * * @param Map $map * @return float | bool */ public function getMapKarma(Map $map) { $mysqli = $this->maniaControl->database->mysqli; $query = "SELECT AVG(`vote`) AS `karma` FROM `" . self::TABLE_KARMA . "` WHERE `mapIndex` = {$map->index} AND `vote` >= 0;"; $result = $mysqli->query($query); if ($mysqli->error) { trigger_error($mysqli->error); return false; } if ($result->num_rows <= 0) { $result->free(); return false; } $item = $result->fetch_object(); $result->free(); $karma = $item->karma; if ($karma === null) { return false; } return floatval($karma); } /** * Get the current Votes for the Map * * @param Map $map * @return array */ public function getMapVotes(Map $map) { $mysqli = $this->maniaControl->database->mysqli; $query = "SELECT `vote`, COUNT(`vote`) AS `count` FROM `" . self::TABLE_KARMA . "` WHERE `mapIndex` = {$map->index} AND `vote` >= 0 GROUP BY `vote`;"; $result = $mysqli->query($query); if ($mysqli->error) { trigger_error($mysqli->error); return false; } $votes = array(); $count = 0; while($vote = $result->fetch_object()) { $votes[$vote->vote] = $vote; $count += $vote->count; } $votes['count'] = $count; $result->free(); return $votes; } /** * Build karma voting manialink if necessary * * @param bool $forceBuild */ private function buildManialink($forceBuild = false) { if (is_object($this->manialink) && !$forceBuild) { return; } $title = $this->maniaControl->settingManager->getSetting($this, self::SETTING_WIDGET_TITLE); $pos_x = $this->maniaControl->settingManager->getSetting($this, self::SETTING_WIDGET_POSX); $pos_y = $this->maniaControl->settingManager->getSetting($this, self::SETTING_WIDGET_POSY); $width = $this->maniaControl->settingManager->getSetting($this, self::SETTING_WIDGET_WIDTH); $height = $this->maniaControl->settingManager->getSetting($this, self::SETTING_WIDGET_HEIGHT); $labelStyle = $this->maniaControl->manialinkManager->styleManager->getDefaultLabelStyle(); $quadStyle = $this->maniaControl->manialinkManager->styleManager->getDefaultQuadStyle(); $quadSubstyle = $this->maniaControl->manialinkManager->styleManager->getDefaultQuadSubstyle(); $manialink = new ManiaLink(self::MLID_KARMA); $frame = new Frame(); $manialink->add($frame); $frame->setPosition($pos_x, $pos_y); $backgroundQuad = new Quad(); $frame->add($backgroundQuad); $backgroundQuad->setY($height * 0.15); $backgroundQuad->setSize($width, $height); $backgroundQuad->setStyles($quadStyle, $quadSubstyle); $titleLabel = new Label(); $frame->add($titleLabel); $titleLabel->setY($height * 0.36); $titleLabel->setWidth($width * 0.85); $titleLabel->setStyle($labelStyle); $titleLabel->setTranslate(true); $titleLabel->setTextSize(1); $titleLabel->setScale(0.90); $titleLabel->setText($title); $karmaGauge = new Gauge(); $frame->add($karmaGauge); $karmaGauge->setSize($width * 0.95, $height * 0.92); $karmaGauge->setDrawBg(false); $manialink->karmaGauge = $karmaGauge; $karmaLabel = new Label(); $frame->add($karmaLabel); $karmaLabel->setPosition(0, -0.4, 1); $karmaLabel->setSize($width * 0.9, $height * 0.9); $karmaLabel->setStyle($labelStyle); $karmaLabel->setTextSize(1); $manialink->karmaLabel = $karmaLabel; $votesFrame = new Frame(); $frame->add($votesFrame); $manialink->votesFrame = $votesFrame; $this->manialink = $manialink; } /** * Open a Mx Karma Session */ private function mxKarmaOpenSession() { if (!$this->maniaControl->settingManager->getSetting($this, self::SETTING_MX_KARMA_ACTIVATED)) { return; } $serverLogin = $this->maniaControl->server->login; $mxKarmaCode = $this->maniaControl->settingManager->getSetting($this, '$l[http://karma.mania-exchange.com/auth/getapikey?server=' . $serverLogin . ']MX Karma Code for ' . $serverLogin . '$l'); if ($mxKarmaCode == '') { return; } $applicationIdentifier = 'ManiaControl v' . ManiaControl::VERSION; $testMode = 'true'; $query = self::MX_KARMA_URL . self::MX_KARMA_STARTSESSION; $query .= '?serverLogin=' . $serverLogin; $query .= '&applicationIdentifier=' . urlencode($applicationIdentifier); $query .= '&game=sm'; $query .= '&testMode=' . $testMode; $this->maniaControl->fileReader->loadFile($query, function ($data, $error) use ($mxKarmaCode) { if (!$error) { $data = json_decode($data); if ($data->success) { $this->mxKarma['session'] = $data->data; $this->activateSession($mxKarmaCode); } else { $this->maniaControl->log("Error while authenticating on Mania-Exchange Karma"); //TODO remove temp trigger $this->maniaControl->errorHandler->triggerDebugNotice("Error while authenticating on Mania-Exchange Karma " . $data->data->message); } } else { $this->maniaControl->log($error); } }, "application/json", 1000); } /** * Activates the MX-Karma Session * * @param $mxKarmaCode */ private function activateSession($mxKarmaCode) { $hash = $this->buildActivationHash($this->mxKarma['session']->sessionSeed, $mxKarmaCode); $query = self::MX_KARMA_URL . self::MX_KARMA_ACTIVATESESSION; $query .= '?sessionKey=' . urlencode($this->mxKarma['session']->sessionKey); $query .= '&activationHash=' . urlencode($hash); $this->maniaControl->fileReader->loadFile($query, function ($data, $error) { if (!$error) { $data = json_decode($data); if ($data->success && $data->data->activated) { $this->maniaControl->log("Successfully authenticated on Mania-Exchange Karma"); } else { $this->maniaControl->log("Error while authenticating on Mania-Exchange Karma " . $data->data->message); //TODO remove temp trigger $this->maniaControl->errorHandler->triggerDebugNotice("Error while authenticating on Mania-Exchange Karma " . $data->data->message); } } else { $this->maniaControl->log($error); } }, "application/json", 1000); } /** * Import old Karma votes to Mania-Exchange Karma * * @param Map $map */ public function importMxKarmaVotes(Map $map) { if (!$this->maniaControl->settingManager->getSetting($this, self::SETTING_MX_KARMA_ACTIVATED)) { return; } if (!$this->maniaControl->settingManager->getSetting($this, self::SETTING_MX_KARMA_IMPORTING)) { return; } if (!isset($this->mxKarma['session'])) { $this->mxKarmaOpenSession(); return; } $mysqli = $this->maniaControl->database->mysqli; $query = "SELECT mapImported FROM `" . self::MX_IMPORT_TABLE . "` WHERE `mapIndex` = {$map->index};"; $result = $mysqli->query($query); if ($mysqli->error) { trigger_error($mysqli->error); return; } $vote = $result->fetch_object(); if ($result->field_count == 0 || !$vote) { $query = "SELECT vote, login, nickname FROM `" . self::TABLE_KARMA . "` k LEFT JOIN `" . PlayerManager::TABLE_PLAYERS . "` p ON (k.playerIndex=p.index) WHERE mapIndex = {$map->index}"; $result2 = $mysqli->query($query); if ($mysqli->error) { trigger_error($mysqli->error); return; } $votes = array(); while($row = $result2->fetch_object()) { array_push($votes, array("login" => $row->login, "nickname" => $row->nickname, "vote" => $row->vote * 100)); } $this->postKarmaVotes($map, $votes, true); //Flag Map as Imported in database if it is a import $query = "INSERT INTO `" . self::MX_IMPORT_TABLE . "` (`mapIndex`,`mapImported`) VALUES ({$map->index},true) ON DUPLICATE KEY UPDATE `mapImported` = true;"; $mysqli->query($query); if ($mysqli->error) { trigger_error($mysqli->error); } $result2->free(); } $result->free_result(); return; } /** * Save Mx Karma Votes at Mapend */ public function sendMxKarmaVotes(Map $map) { if (!$this->maniaControl->settingManager->getSetting($this, self::SETTING_MX_KARMA_ACTIVATED)) { return; } if (!isset($this->mxKarma['session'])) { $this->mxKarmaOpenSession(); return; } if (!isset($this->mxKarma['votes']) || count($this->mxKarma['votes']) == 0) { return; } $votes = array(); foreach($this->mxKarma['votes'] as $login => $value) { $player = $this->maniaControl->playerManager->getPlayer($login); array_push($votes, array("login" => $login, "nickname" => $player->rawNickname, "vote" => $value)); } $this->postKarmaVotes($map, $votes); } /** * Post the Karma votes to MX-Karma * * @param Map $map * @param array $votes * @param bool $import */ private function postKarmaVotes(Map $map, array $votes, $import = false) { $gameMode = $this->maniaControl->server->getGameMode(true); if(count($votes) == 0) return; $properties = array(); if ($gameMode == 'Script') { $scriptName = $this->maniaControl->client->getScriptName(); $properties['gamemode'] = $scriptName["CurrentValue"]; } else { $properties['gamemode'] = $gameMode; } $properties['votes'] = $votes; $properties['titleid'] = $this->maniaControl->server->titleId; $properties['mapname'] = $map->rawName; $properties['mapuid'] = $map->uid; $properties['mapauthor'] = $map->authorLogin; $properties['isimport'] = $import; $content = json_encode($properties); $this->maniaControl->fileReader->postData(self::MX_KARMA_URL . self::MX_KARMA_SAVEVOTES . "?sessionKey=" . urlencode($this->mxKarma['session']->sessionKey), function ($data, $error) { if (!$error) { $data = json_decode($data); if ($data->success) { $this->maniaControl->log("Votes successfully permitted"); } else { $this->maniaControl->log("Error while updating votes: " . $data->data->message); //TODO remove temp trigger $this->maniaControl->errorHandler->triggerDebugNotice("Error while updating votes: " . $data->data->message); } } else { $this->maniaControl->log($error); } }, $content, false, 'application/json'); } /** * Builds a sha512 activation Hash for the MX-Karma * * @param $sessionSeed * @param $mxKey * @return string */ private function buildActivationHash($sessionSeed, $mxKey) { return hash('sha512', $mxKey . $sessionSeed); } }