293 lines
9.2 KiB
PHP
293 lines
9.2 KiB
PHP
<?php
|
|
|
|
namespace ManiaControl\Commands;
|
|
|
|
use FML\Controls\Frame;
|
|
use FML\Controls\Quads\Quad_BgsPlayerCard;
|
|
use FML\Controls\Quads\Quad_UIConstruction_Buttons;
|
|
use FML\ManiaLink;
|
|
use FML\Script\Features\Paging;
|
|
use ManiaControl\Callbacks\CallbackListener;
|
|
use ManiaControl\Callbacks\Callbacks;
|
|
use ManiaControl\ManiaControl;
|
|
use ManiaControl\Manialinks\LabelLine;
|
|
use ManiaControl\Manialinks\ManialinkManager;
|
|
use ManiaControl\Manialinks\ManialinkPageAnswerListener;
|
|
use ManiaControl\Players\Player;
|
|
|
|
/**
|
|
* ManiaControl Help Manager Class
|
|
*
|
|
* @author ManiaControl Team <mail@maniacontrol.com>
|
|
* @copyright 2014-2020 ManiaControl Team
|
|
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
|
|
*/
|
|
class HelpManager implements CommandListener, CallbackListener, ManialinkPageAnswerListener {
|
|
|
|
const ACTION_OPEN_HELP_ALL = 'HelpManager.OpenHelpAll';
|
|
const ACTION_OPEN_ADMIN_HELP_ALL = 'HelpManager.OpenAdminHelpAll';
|
|
|
|
/*
|
|
* Private properties
|
|
*/
|
|
/** @var ManiaControl $maniaControl */
|
|
private $maniaControl = null;
|
|
private $playerCommands = array();
|
|
private $adminCommands = array();
|
|
|
|
/**
|
|
* Construct a new Commands Manager
|
|
*
|
|
* @param ManiaControl $maniaControl
|
|
*/
|
|
public function __construct(ManiaControl $maniaControl) {
|
|
$this->maniaControl = $maniaControl;
|
|
|
|
// Action Open StatsList
|
|
$this->maniaControl->getManialinkManager()->registerManialinkPageAnswerListener(self::ACTION_OPEN_HELP_ALL, $this, 'maniaLink_helpAll');
|
|
$this->maniaControl->getManialinkManager()->registerManialinkPageAnswerListener(self::ACTION_OPEN_ADMIN_HELP_ALL,$this,'maniaLink_adminHelpAll');
|
|
|
|
$itemQuad = new Quad_UIConstruction_Buttons();
|
|
$itemQuad->setSubStyle($itemQuad::SUBSTYLE_Help);
|
|
$itemQuad->setAction(self::ACTION_OPEN_HELP_ALL);
|
|
$this->maniaControl->getActionsMenu()->addMenuItem($itemQuad, true, 0, 'Available commands');
|
|
$itemQuad = clone $itemQuad;
|
|
$itemQuad->setAction(self::ACTION_OPEN_ADMIN_HELP_ALL);
|
|
$this->maniaControl->getActionsMenu()->addAdminMenuItem($itemQuad, 0, 'Available admin commands');
|
|
|
|
// Callbacks
|
|
$this->maniaControl->getCallbackManager()->registerCallbackListener(Callbacks::ONINIT, $this, 'handleOnInit');
|
|
}
|
|
|
|
/**
|
|
* Handle ManiaControl OnInit Callback
|
|
*/
|
|
public function handleOnInit() {
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('help', $this, 'command_playerHelp', false, 'Shows all commands in chat.');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('helpall', $this, 'command_playerHelpAll', false, 'Shows all commands in ManiaLink with description.');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('help', $this, 'command_adminHelp', true, 'Shows all admin commands in chat.');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('helpall', $this, 'command_adminHelpAll', true, 'Shows all admin commands in ManiaLink with description.');
|
|
}
|
|
|
|
/**
|
|
* Show a list of Admin Commands
|
|
*
|
|
* @param array $chatCallback
|
|
* @param Player $player
|
|
*/
|
|
public function command_adminHelp(array $chatCallback, Player $player) {
|
|
// Parse list from array
|
|
$message = $this->parseHelpList($this->adminCommands);
|
|
|
|
if ($message === null) {
|
|
$this->maniaControl->getChat()->sendError('No Admin Commands supported!', $player);
|
|
} else {
|
|
$message = $this->maniaControl->getChat()->formatMessage(
|
|
'Supported Admin Commands: %s',
|
|
$message
|
|
);
|
|
$this->maniaControl->getChat()->sendChat($message, $player);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Show a list of Player Commands
|
|
*
|
|
* @param array $chatCallback
|
|
* @param Player $player
|
|
*/
|
|
public function command_playerHelp(array $chatCallback, Player $player) {
|
|
// Parse list from array
|
|
$message = $this->parseHelpList($this->playerCommands);
|
|
|
|
if ($message === null) {
|
|
$this->maniaControl->getChat()->sendError('No Player Commands supported!', $player);
|
|
} else {
|
|
$message = $this->maniaControl->getChat()->formatMessage(
|
|
'Supported Player Commands: %s',
|
|
$message
|
|
);
|
|
$this->maniaControl->getChat()->sendChat($message, $player);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Show a ManiaLink list of Admin Commands
|
|
*
|
|
* @param array $chatCallback
|
|
* @param Player $player
|
|
*/
|
|
public function command_adminHelpAll(array $chatCallback, Player $player) {
|
|
$this->parseHelpList($this->adminCommands, true, $player);
|
|
}
|
|
|
|
/**
|
|
* Show a ManiaLink list of Player Commands
|
|
*
|
|
* @param array $chatCallback
|
|
* @param Player $player
|
|
*/
|
|
public function command_playerHelpAll(array $chatCallback, Player $player) {
|
|
$this->parseHelpList($this->playerCommands, true, $player);
|
|
}
|
|
|
|
/**
|
|
* Method for ManiaLink answer
|
|
*
|
|
* @param array $callback
|
|
* @param \ManiaControl\Players\Player $player
|
|
* @internal
|
|
*/
|
|
public function maniaLink_adminHelpAll(array $callback, Player $player){
|
|
$this->parseHelpList($this->adminCommands,true, $player);
|
|
}
|
|
|
|
/**
|
|
* Method for ManiaLink answer
|
|
*
|
|
* @param array $callback
|
|
* @param \ManiaControl\Players\Player $player
|
|
* @internal
|
|
*/
|
|
public function maniaLink_helpAll(array $callback, Player $player) {
|
|
$this->parseHelpList($this->playerCommands, true, $player);
|
|
}
|
|
|
|
/**
|
|
* Parse list with commands from array
|
|
*
|
|
* @param array $commands
|
|
* @param bool $isHelpAll
|
|
* @param Player $player
|
|
* @return string
|
|
*/
|
|
private function parseHelpList(array $commands, $isHelpAll = false, Player $player = null) {
|
|
$showCommands = array();
|
|
$registeredMethods = array();
|
|
$message = '';
|
|
foreach (array_reverse($commands) as $command) {
|
|
if (array_key_exists($command['Method'], $registeredMethods)) {
|
|
if ($showCommands[$registeredMethods[$command['Method']]]['Description'] === $command['Description']) {
|
|
$name = $registeredMethods[$command['Method']];
|
|
$showCommands[$name]['Name'] .= '|' . $command['Name'];
|
|
} else {
|
|
$showCommands[$command['Name']] = $command;
|
|
$registeredMethods[$command['Method']] = $command['Name'];
|
|
}
|
|
} else {
|
|
$showCommands[$command['Name']] = $command;
|
|
$registeredMethods[$command['Method']] = $command['Name'];
|
|
}
|
|
}
|
|
|
|
usort($showCommands, function ($commandA, $commandB) {
|
|
return strcmp($commandA['Name'], $commandB['Name']);
|
|
});
|
|
|
|
if (!$isHelpAll) {
|
|
foreach ($showCommands as $command) {
|
|
$message .= $command['Name'] . ',';
|
|
}
|
|
$message = substr($message, 0, -1);
|
|
} else {
|
|
if ($player != null) {
|
|
$this->showHelpAllList($showCommands, $player);
|
|
}
|
|
}
|
|
return $message;
|
|
}
|
|
|
|
/**
|
|
* Show the HelpAll list to the player.
|
|
*
|
|
* @param array $commands
|
|
* @param mixed $player
|
|
*/
|
|
public function showHelpAllList(array $commands, $player) {
|
|
$width = $this->maniaControl->getManialinkManager()->getStyleManager()->getListWidgetsWidth();
|
|
$height = $this->maniaControl->getManialinkManager()->getStyleManager()->getListWidgetsHeight();
|
|
|
|
// create manialink
|
|
$maniaLink = new ManiaLink(ManialinkManager::MAIN_MLID);
|
|
$script = $maniaLink->getScript();
|
|
$paging = new Paging();
|
|
$script->addFeature($paging);
|
|
|
|
// Main frame
|
|
$frame = $this->maniaControl->getManialinkManager()->getStyleManager()->getDefaultListFrame($script, $paging);
|
|
$maniaLink->addChild($frame);
|
|
|
|
// Start offsets
|
|
$posX = -$width / 2;
|
|
$posY = $height / 2;
|
|
|
|
//Predefine description Label
|
|
$descriptionLabel = $this->maniaControl->getManialinkManager()->getStyleManager()->getDefaultDescriptionLabel();
|
|
$frame->addChild($descriptionLabel);
|
|
|
|
// Headline
|
|
$headFrame = new Frame();
|
|
$frame->addChild($headFrame);
|
|
$headFrame->setY($posY - 5);
|
|
|
|
$labelLine = new LabelLine($headFrame);
|
|
$labelLine->addLabelEntryText('Command', $posX + 5);
|
|
$labelLine->addLabelEntryText('Description', $posX + 50);
|
|
$labelLine->render();
|
|
|
|
$index = 1;
|
|
$posY -= 10;
|
|
$pageFrame = null;
|
|
$pageMaxCount = floor($height * 0.80 / 4);
|
|
|
|
foreach ($commands as $command) {
|
|
if ($index % $pageMaxCount === 1) {
|
|
$pageFrame = new Frame();
|
|
$frame->addChild($pageFrame);
|
|
$posY = $height / 2 - 10;
|
|
$paging->addPageControl($pageFrame);
|
|
}
|
|
|
|
$playerFrame = new Frame();
|
|
$pageFrame->addChild($playerFrame);
|
|
$playerFrame->setY($posY);
|
|
|
|
if ($index % 2 !== 0) {
|
|
$lineQuad = new Quad_BgsPlayerCard();
|
|
$playerFrame->addChild($lineQuad);
|
|
$lineQuad->setSize($width, 4);
|
|
$lineQuad->setSubStyle($lineQuad::SUBSTYLE_BgPlayerCardBig);
|
|
$lineQuad->setZ(-0.1);
|
|
}
|
|
|
|
$labelLine = new LabelLine($playerFrame);
|
|
$labelLine->addLabelEntryText($command['Name'], $posX + 5, 45);
|
|
$labelLine->addLabelEntryText($command['Description'], $posX + 50, $width / 2 - $posX + 50);
|
|
$labelLine->render();
|
|
|
|
$posY -= 4;
|
|
$index++;
|
|
}
|
|
|
|
// Render and display xml
|
|
$this->maniaControl->getManialinkManager()->displayWidget($maniaLink, $player, 'HelpAllList');
|
|
}
|
|
|
|
/**
|
|
* Register a new Command
|
|
*
|
|
* @param string $name
|
|
* @param bool $adminCommand
|
|
* @param string $description
|
|
* @param string $method
|
|
*/
|
|
public function registerCommand($name, $adminCommand = false, $description = '', $method = '') {
|
|
// TODO replace with new class Command
|
|
if ($adminCommand) {
|
|
array_push($this->adminCommands, array("Name" => $name, "Description" => $description, "Method" => $method));
|
|
} else {
|
|
array_push($this->playerCommands, array("Name" => $name, "Description" => $description, "Method" => $method));
|
|
}
|
|
}
|
|
}
|