TrackManiaControl/application/plugins/Donations.php

379 lines
12 KiB
PHP
Raw Normal View History

<?php
2014-01-02 18:06:27 +01:00
use FML\Controls\Frame;
use FML\Controls\Quad;
use FML\Controls\Quads\Quad_Icons128x128_1;
use FML\ManiaLink;
use FML\Script\Script;
use ManiaControl\Admin\AuthenticationManager;
use ManiaControl\Callbacks\CallbackListener;
use ManiaControl\Callbacks\CallbackManager;
use ManiaControl\Commands\CommandListener;
2014-01-02 17:31:58 +01:00
use ManiaControl\ManiaControl;
use ManiaControl\Players\Player;
2014-01-02 18:06:54 +01:00
use ManiaControl\Players\PlayerManager;
use ManiaControl\Plugins\Plugin;
/**
* Donation plugin
*
2014-01-02 18:06:27 +01:00
* @author steeffeen and Lukas
*/
class DonationPlugin implements CallbackListener, CommandListener, Plugin {
/**
* Constants
*/
2014-01-02 17:31:58 +01:00
const ID = 3;
const VERSION = 0.1;
const SETTING_ANNOUNCE_SERVERDONATION = 'Enable Server-Donation Announcements';
2014-01-03 18:37:51 +01:00
const STAT_PLAYER_DONATIONS = 'Donated Planets';
2014-01-02 17:31:58 +01:00
2014-01-02 18:06:27 +01:00
// DonateWidget Properties
const MLID_DONATE_WIDGET = 'DonationPlugin.DonateWidget';
const SETTING_DONATE_WIDGET_ACTIVATED = 'Donate-Widget Activated';
const SETTING_DONATE_WIDGET_POSX = 'Donate-Widget-Position: X';
const SETTING_DONATE_WIDGET_POSY = 'Donate-Widget-Position: Y';
const SETTING_DONATE_WIDGET_WIDTH = 'Donate-Widget-Size: Width';
const SETTING_DONATE_WIDGET_HEIGHT = 'Donate-Widget-Size: Height';
/**
* Private properties
*/
2014-01-02 17:31:58 +01:00
/** @var maniaControl $maniaControl */
2013-12-14 23:29:17 +01:00
private $maniaControl = null;
private $openBills = array();
/**
*
2013-12-14 23:29:17 +01:00
* @see \ManiaControl\Plugins\Plugin::load()
*/
2013-12-14 23:29:17 +01:00
public function load(ManiaControl $maniaControl) {
$this->maniaControl = $maniaControl;
2014-01-02 17:31:58 +01:00
// Register for commands
$this->maniaControl->commandManager->registerCommandListener('donate', $this, 'command_Donate');
2013-12-14 23:29:17 +01:00
$this->maniaControl->commandManager->registerCommandListener('pay', $this, 'command_Pay', true);
$this->maniaControl->commandManager->registerCommandListener('getplanets', $this, 'command_GetPlanets', true);
2014-01-02 17:31:58 +01:00
// Register for callbacks
$this->maniaControl->callbackManager->registerCallbackListener(CallbackManager::CB_MP_BILLUPDATED, $this, 'handleBillUpdated');
2014-01-02 18:06:27 +01:00
$this->maniaControl->callbackManager->registerCallbackListener(CallbackManager::CB_MC_ONINIT, $this, 'handleOnInit');
$this->maniaControl->callbackManager->registerCallbackListener(PlayerManager::CB_PLAYERJOINED, $this, 'handlePlayerConnect');
2014-01-02 17:31:58 +01:00
// Define player stats
$this->maniaControl->statisticManager->defineStatMetaData(self::STAT_PLAYER_DONATIONS);
2014-01-02 18:06:27 +01:00
$this->maniaControl->settingManager->initSetting($this, self::SETTING_DONATE_WIDGET_ACTIVATED, true);
$this->maniaControl->settingManager->initSetting($this, self::SETTING_DONATE_WIDGET_POSX, 156.);
$this->maniaControl->settingManager->initSetting($this, self::SETTING_DONATE_WIDGET_POSY, -51.4);
$this->maniaControl->settingManager->initSetting($this, self::SETTING_DONATE_WIDGET_WIDTH, 6);
$this->maniaControl->settingManager->initSetting($this, self::SETTING_DONATE_WIDGET_HEIGHT, 6);
2013-12-14 23:29:17 +01:00
return true;
}
/**
*
* @see \ManiaControl\Plugins\Plugin::unload()
*/
public function unload() {
$this->maniaControl->callbackManager->unregisterCallbackListener($this);
$this->maniaControl->commandManager->unregisterCommandListener($this);
unset($this->maniaControl);
}
2013-12-09 10:04:22 +01:00
/**
*
* @see \ManiaControl\Plugins\Plugin::getId()
*/
public static function getId() {
return self::ID;
}
/**
*
* @see \ManiaControl\Plugins\Plugin::getName()
*/
public static function getName() {
2013-12-09 10:04:22 +01:00
return 'Donations Plugin';
}
/**
*
* @see \ManiaControl\Plugins\Plugin::getVersion()
*/
public static function getVersion() {
return self::VERSION;
}
/**
*
* @see \ManiaControl\Plugins\Plugin::getAuthor()
*/
public static function getAuthor() {
return 'steeffeen';
}
/**
*
* @see \ManiaControl\Plugins\Plugin::getDescription()
*/
public static function getDescription() {
2013-12-09 10:04:22 +01:00
return 'Plugin offering commands like /donate, /pay and /getplanets and a donation widget.';
}
2014-01-02 18:06:27 +01:00
/**
* Handle ManiaControl OnInit callback
*
* @param array $callback
*/
public function handleOnInit(array $callback) {
if($this->maniaControl->settingManager->getSetting($this, self::SETTING_DONATE_WIDGET_ACTIVATED)) {
$this->displayDonateWidget();
}
}
/**
* Handle PlayerConnect callback
*
* @param array $callback
*/
public function handlePlayerConnect(array $callback) {
$player = $callback[1];
// Display Map Widget
if($this->maniaControl->settingManager->getSetting($this, self::SETTING_DONATE_WIDGET_ACTIVATED)) {
$this->displayDonateWidget($player->login);
}
}
/**
* Displays the Donate Widget
*
* @param bool $login
*/
public function displayDonateWidget($login = false) {
$posX = $this->maniaControl->settingManager->getSetting($this, self::SETTING_DONATE_WIDGET_POSX);
$posY = $this->maniaControl->settingManager->getSetting($this, self::SETTING_DONATE_WIDGET_POSY);
$width = $this->maniaControl->settingManager->getSetting($this, self::SETTING_DONATE_WIDGET_WIDTH);
$height = $this->maniaControl->settingManager->getSetting($this, self::SETTING_DONATE_WIDGET_HEIGHT);
$quadStyle = $this->maniaControl->manialinkManager->styleManager->getDefaultQuadStyle();
$quadSubstyle = $this->maniaControl->manialinkManager->styleManager->getDefaultQuadSubstyle();
$itemMarginFactorX = 1.3;
$itemMarginFactorY = 1.2;
$itemSize = $width;
$maniaLink = new ManiaLink(self::MLID_DONATE_WIDGET);
$script = new Script();
$maniaLink->setScript($script);
//Donate Menu Icon Frame
$frame = new Frame();
$maniaLink->add($frame);
$frame->setPosition($posX, $posY);
$backgroundQuad = new Quad();
$frame->add($backgroundQuad);
$backgroundQuad->setSize($width * $itemMarginFactorX, $height * $itemMarginFactorY);
$backgroundQuad->setStyles($quadStyle, $quadSubstyle);
$iconFrame = new Frame();
$frame->add($iconFrame);
$iconFrame->setSize($itemSize, $itemSize);
$itemQuad = new Quad_Icons128x128_1();
$itemQuad->setSubStyle($itemQuad::SUBSTYLE_Coppers);
$itemQuad->setSize($itemSize, $itemSize);
$iconFrame->add($itemQuad);
// Send manialink
$manialinkText = $maniaLink->render()->saveXML();
$this->maniaControl->manialinkManager->sendManialink($manialinkText, $login);
}
/**
* Handle /donate command
*
2014-01-02 17:31:58 +01:00
* @param array $chatCallback
* @param Player $player
* @return bool
*/
public function command_Donate(array $chatCallback, Player $player) {
2014-01-02 17:31:58 +01:00
$text = $chatCallback[1][2];
$params = explode(' ', $text);
2014-01-02 17:31:58 +01:00
if(count($params) < 2) {
$this->sendDonateUsageExample($player);
return false;
}
2014-01-02 17:31:58 +01:00
$amount = (int)$params[1];
if(!$amount || $amount <= 0) {
$this->sendDonateUsageExample($player);
return false;
}
2014-01-02 17:31:58 +01:00
if(count($params) >= 3) {
$receiver = $params[2];
$receiverPlayer = $this->maniaControl->playerManager->getPlayer($receiver);
2014-01-02 17:31:58 +01:00
$receiverName = ($receiverPlayer ? $receiverPlayer['NickName'] : $receiver);
} else {
$receiver = '';
$receiverName = $this->maniaControl->server->getName();
}
$message = 'Donate ' . $amount . ' Planets to $<' . $receiverName . '$>?';
2014-01-02 17:31:58 +01:00
if(!$this->maniaControl->client->query('SendBill', $player->login, $amount, $message, $receiver)) {
trigger_error("Couldn't create donation of {$amount} planets from '{$player->login}' for '{$receiver}'. " . $this->maniaControl->getClientErrorText());
$this->maniaControl->chat->sendError("Creating donation failed.", $player->login);
return false;
}
2014-01-02 17:31:58 +01:00
$bill = $this->maniaControl->client->getResponse();
$this->openBills[$bill] = array(true, $player->login, $receiver, $amount, time());
return true;
}
/**
* Handle //pay command
*
2014-01-02 17:31:58 +01:00
* @param array $chatCallback
* @param Player $player
* @return bool
*/
public function command_Pay(array $chatCallback, Player $player) {
2014-01-02 17:31:58 +01:00
if(!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_SUPERADMIN)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player);
return false;
}
2014-01-02 17:31:58 +01:00
$text = $chatCallback[1][2];
$params = explode(' ', $text);
2014-01-02 17:31:58 +01:00
if(count($params) < 2) {
$this->sendPayUsageExample($player);
return false;
}
2014-01-02 17:31:58 +01:00
$amount = (int)$params[1];
if(!$amount || $amount <= 0) {
$this->sendPayUsageExample($player);
return false;
}
2014-01-02 17:31:58 +01:00
if(count($params) >= 3) {
$receiver = $params[2];
2014-01-02 17:31:58 +01:00
} else {
$receiver = $player->login;
}
$message = 'Payout from $<' . $this->maniaControl->server->getName() . '$>.';
2014-01-02 17:31:58 +01:00
if(!$this->maniaControl->client->query('Pay', $receiver, $amount, $message)) {
trigger_error("Couldn't create payout of {$amount} planets by '{$player->login}' for '{$receiver}'. " . $this->maniaControl->getClientErrorText());
$this->maniaControl->chat->sendError("Creating payout failed.", $player->login);
return false;
}
2014-01-02 17:31:58 +01:00
$bill = $this->maniaControl->client->getResponse();
$this->openBills[$bill] = array(false, $player->login, $receiver, $amount, time());
return true;
}
/**
* Handle //getplanets command
*
2014-01-02 17:31:58 +01:00
* @param array $chatCallback
* @param Player $player
* @return bool
*/
public function command_GetPlanets(array $chatCallback, Player $player) {
2014-01-02 17:31:58 +01:00
if(!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_ADMIN)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player);
return false;
}
2014-01-02 17:31:58 +01:00
if(!$this->maniaControl->client->query('GetServerPlanets')) {
trigger_error("Couldn't retrieve server planets. " . $this->maniaControl->getClientErrorText());
return false;
}
$planets = $this->maniaControl->client->getResponse();
$message = "This Server has {$planets} Planets!";
return $this->maniaControl->chat->sendInformation($message, $player->login);
}
/**
* Handle bill updated callback
*
2014-01-02 17:31:58 +01:00
* @param array $callback
* @return bool
*/
public function handleBillUpdated(array $callback) {
$billId = $callback[1][0];
2014-01-02 17:31:58 +01:00
if(!array_key_exists($billId, $this->openBills)) {
return false;
}
$billData = $this->openBills[$billId];
2014-01-02 17:31:58 +01:00
$login = $billData[1];
$receiver = $billData[2];
2014-01-02 17:31:58 +01:00
switch($callback[1][1]) {
case 4:
2014-01-02 17:31:58 +01:00
{
// Payed
$donation = $billData[0];
$amount = $billData[3];
if($donation) {
2014-01-02 17:37:18 +01:00
$player = $this->maniaControl->playerManager->getPlayer($login);
2014-01-02 18:06:27 +01:00
2014-01-02 17:31:58 +01:00
// Donation
if(strlen($receiver) > 0) {
// To player
$message = "Successfully donated {$amount} to '{$receiver}'!";
$this->maniaControl->chat->sendSuccess($message, $login);
} else {
// To server
if($this->maniaControl->settingManager->getSetting($this, self::SETTING_ANNOUNCE_SERVERDONATION, true)) {
2014-01-02 17:37:18 +01:00
$message = '$<' . $player->nickname . '$> donated ' . $amount . ' Planets! Thanks.';
2014-01-02 17:31:58 +01:00
} else {
$message = 'Donation successful! Thanks.';
}
$this->maniaControl->chat->sendSuccess($message, $login);
2014-01-02 17:31:58 +01:00
$this->maniaControl->statisticManager->insertStat(self::STAT_PLAYER_DONATIONS, $player, $this->maniaControl->server->getLogin(), $amount);
}
2014-01-02 17:31:58 +01:00
} else {
// Payout
$message = "Successfully payed out {$amount} to '{$receiver}'!";
$this->maniaControl->chat->sendSuccess($message, $login);
}
2014-01-02 17:31:58 +01:00
unset($this->openBills[$billId]);
break;
}
case 5:
2014-01-02 17:31:58 +01:00
{
// Refused
$message = 'Transaction cancelled.';
$this->maniaControl->chat->sendError($message, $login);
unset($this->openBills[$billId]);
break;
}
case 6:
2014-01-02 17:31:58 +01:00
{
// Error
$this->maniaControl->chat->sendError($callback[1][2], $login);
unset($this->openBills[$billId]);
break;
}
}
return true;
}
/**
* Send an usage example for /donate to the player
*
2014-01-02 17:31:58 +01:00
* @param Player $player
* @return boolean
*/
private function sendDonateUsageExample(Player $player) {
$message = "Usage Example: '/donate 100'";
return $this->maniaControl->chat->sendChat($message, $player->login);
}
/**
* Send an usage example for /pay to the player
*
2014-01-02 17:31:58 +01:00
* @param Player $player
* @return boolean
*/
private function sendPayUsageExample(Player $player) {
$message = "Usage Example: '/pay 100 login'";
return $this->maniaControl->chat->sendChat($message, $player->login);
}
}