425 lines
15 KiB
PHP
425 lines
15 KiB
PHP
<?php
|
|
|
|
namespace ManiaControl\Plugins;
|
|
|
|
use FML\Components\CheckBox;
|
|
use FML\Components\ValuePicker;
|
|
use FML\Controls\Entry;
|
|
use FML\Controls\Frame;
|
|
use FML\Controls\Label;
|
|
use FML\Controls\Labels\Label_Button;
|
|
use FML\Controls\Labels\Label_Text;
|
|
use FML\Controls\Quad;
|
|
use FML\Controls\Quads\Quad_Icons128x128_1;
|
|
use FML\Controls\Quads\Quad_Icons128x32_1;
|
|
use FML\Controls\Quads\Quad_Icons64x64_1;
|
|
use FML\Script\Features\Paging;
|
|
use FML\Script\Script;
|
|
use ManiaControl\Admin\AuthenticationManager;
|
|
use ManiaControl\Callbacks\CallbackListener;
|
|
use ManiaControl\Callbacks\CallbackManager;
|
|
use ManiaControl\Configurator\ConfiguratorMenu;
|
|
use ManiaControl\ManiaControl;
|
|
use ManiaControl\Manialinks\ManialinkPageAnswerListener;
|
|
use ManiaControl\Players\Player;
|
|
use ManiaControl\Settings\Setting;
|
|
|
|
/**
|
|
* Configurator for enabling and disabling Plugins
|
|
*
|
|
* @author ManiaControl Team <mail@maniacontrol.com>
|
|
* @copyright 2014 ManiaControl Team
|
|
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
|
|
*/
|
|
class PluginMenu implements CallbackListener, ConfiguratorMenu, ManialinkPageAnswerListener {
|
|
/*
|
|
* Constants
|
|
*/
|
|
const ACTION_PREFIX_ENABLEPLUGIN = 'PluginMenu.Enable.';
|
|
const ACTION_PREFIX_DISABLEPLUGIN = 'PluginMenu.Disable.';
|
|
const ACTION_PREFIX_SETTINGS = 'PluginMenu.Settings.';
|
|
const ACTION_PREFIX_SETTING = 'PluginMenuSetting.';
|
|
const ACTION_BACK_TO_PLUGINS = 'PluginMenu.BackToPlugins';
|
|
const ACTION_PREFIX_UPDATEPLUGIN = 'PluginMenu.Update.';
|
|
const ACTION_UPDATEPLUGINS = 'PluginMenu.Update.All';
|
|
const SETTING_PERMISSION_CHANGE_PLUGIN_SETTINGS = 'Change Plugin Settings';
|
|
const CACHE_SETTING_CLASS = 'PluginMenuCache.SettingClass';
|
|
|
|
/*
|
|
* Private properties
|
|
*/
|
|
/** @var ManiaControl $maniaControl */
|
|
private $maniaControl = null;
|
|
|
|
/**
|
|
* Create a new plugin menu instance
|
|
*
|
|
* @param ManiaControl $maniaControl
|
|
*/
|
|
public function __construct(ManiaControl $maniaControl) {
|
|
$this->maniaControl = $maniaControl;
|
|
|
|
$this->maniaControl->manialinkManager->registerManialinkPageAnswerListener(self::ACTION_BACK_TO_PLUGINS, $this, 'backToPlugins');
|
|
$this->maniaControl->callbackManager->registerCallbackListener(CallbackManager::CB_MP_PLAYERMANIALINKPAGEANSWER, $this, 'handleManialinkPageAnswer');
|
|
$this->maniaControl->authenticationManager->definePermissionLevel(self::SETTING_PERMISSION_CHANGE_PLUGIN_SETTINGS, AuthenticationManager::AUTH_LEVEL_SUPERADMIN);
|
|
}
|
|
|
|
/**
|
|
* @see \ManiaControl\Configurators\ConfiguratorMenu::getTitle()
|
|
*/
|
|
public static function getTitle() {
|
|
return 'Plugins';
|
|
}
|
|
|
|
/**
|
|
* Return back to the plugins overview page
|
|
*
|
|
* @param array $callback
|
|
* @param Player $player
|
|
*/
|
|
public function backToPlugins($callback, Player $player) {
|
|
$player->destroyCache($this, self::CACHE_SETTING_CLASS);
|
|
$this->maniaControl->configurator->showMenu($player, $this);
|
|
}
|
|
|
|
/**
|
|
* @see \ManiaControl\Configurators\ConfiguratorMenu::getMenu()
|
|
*/
|
|
public function getMenu($width, $height, Script $script, Player $player) {
|
|
$paging = new Paging();
|
|
$script->addFeature($paging);
|
|
$frame = new Frame();
|
|
|
|
$pluginClasses = $this->maniaControl->pluginManager->getPluginClasses();
|
|
|
|
// Config
|
|
$pagerSize = 9.;
|
|
$entryHeight = 5.;
|
|
$pageMaxCount = 10;
|
|
|
|
// Pagers
|
|
$pagerPrev = new Quad_Icons64x64_1();
|
|
$frame->add($pagerPrev);
|
|
$pagerPrev->setPosition($width * 0.39, $height * -0.44, 2);
|
|
$pagerPrev->setSize($pagerSize, $pagerSize);
|
|
$pagerPrev->setSubStyle(Quad_Icons64x64_1::SUBSTYLE_ArrowPrev);
|
|
|
|
$pagerNext = new Quad_Icons64x64_1();
|
|
$frame->add($pagerNext);
|
|
$pagerNext->setPosition($width * 0.45, $height * -0.44, 2);
|
|
$pagerNext->setSize($pagerSize, $pagerSize);
|
|
$pagerNext->setSubStyle(Quad_Icons64x64_1::SUBSTYLE_ArrowNext);
|
|
|
|
$paging->addButton($pagerNext);
|
|
$paging->addButton($pagerPrev);
|
|
|
|
$pageCountLabel = new Label_Text();
|
|
$frame->add($pageCountLabel);
|
|
$pageCountLabel->setHAlign($pageCountLabel::RIGHT);
|
|
$pageCountLabel->setPosition($width * 0.35, $height * -0.44, 1);
|
|
$pageCountLabel->setStyle($pageCountLabel::STYLE_TextTitle1);
|
|
$pageCountLabel->setTextSize(2);
|
|
|
|
$paging->setLabel($pageCountLabel);
|
|
|
|
$settingClass = $player->getCache($this, self::CACHE_SETTING_CLASS);
|
|
if ($settingClass) {
|
|
// Show Settings Menu
|
|
return $this->getPluginSettingsMenu($frame, $width, $height, $paging, $player, $settingClass);
|
|
}
|
|
|
|
// Display normal Plugin List
|
|
// Plugin pages
|
|
$posY = 0.;
|
|
$pluginUpdates = $this->maniaControl->updateManager->pluginUpdateManager->getPluginsUpdates();
|
|
|
|
usort($pluginClasses, function ($pluginClassA, $pluginClassB) {
|
|
/** @var Plugin $pluginClassA */
|
|
/** @var Plugin $pluginClassB */
|
|
return strcmp($pluginClassA::getName(), $pluginClassB::getName());
|
|
});
|
|
|
|
$pageFrame = null;
|
|
foreach ($pluginClasses as $index => $pluginClass) {
|
|
/** @var Plugin $pluginClass */
|
|
if ($index % $pageMaxCount === 0) {
|
|
$pageFrame = new Frame();
|
|
$frame->add($pageFrame);
|
|
$paging->addPage($pageFrame);
|
|
$posY = $height * 0.41;
|
|
}
|
|
|
|
$active = $this->maniaControl->pluginManager->isPluginActive($pluginClass);
|
|
|
|
$pluginFrame = new Frame();
|
|
$pageFrame->add($pluginFrame);
|
|
$pluginFrame->setY($posY);
|
|
|
|
$activeQuad = new Quad_Icons64x64_1();
|
|
$pluginFrame->add($activeQuad);
|
|
$activeQuad->setPosition($width * -0.45, -0.1, 1);
|
|
$activeQuad->setSize($entryHeight * 0.9, $entryHeight * 0.9);
|
|
if ($active) {
|
|
$activeQuad->setSubStyle($activeQuad::SUBSTYLE_LvlGreen);
|
|
} else {
|
|
$activeQuad->setSubStyle($activeQuad::SUBSTYLE_LvlRed);
|
|
}
|
|
|
|
$nameLabel = new Label_Text();
|
|
$pluginFrame->add($nameLabel);
|
|
$nameLabel->setHAlign($nameLabel::LEFT);
|
|
$nameLabel->setX($width * -0.4);
|
|
$nameLabel->setSize($width * 0.5, $entryHeight);
|
|
$nameLabel->setStyle($nameLabel::STYLE_TextCardSmall);
|
|
$nameLabel->setTextSize(2);
|
|
$nameLabel->setText($pluginClass::getName());
|
|
|
|
$descriptionLabel = new Label();
|
|
$pageFrame->add($descriptionLabel);
|
|
$descriptionLabel->setAlign($descriptionLabel::LEFT, $descriptionLabel::TOP);
|
|
$descriptionLabel->setPosition($width * -0.45, $height * -0.22);
|
|
$descriptionLabel->setSize($width * 0.7, $entryHeight);
|
|
$descriptionLabel->setTextSize(2);
|
|
$descriptionLabel->setTranslate(true);
|
|
$descriptionLabel->setVisible(false);
|
|
$descriptionLabel->setAutoNewLine(true);
|
|
$descriptionLabel->setMaxLines(5);
|
|
$description = "Author: {$pluginClass::getAuthor()}\nVersion: {$pluginClass::getVersion()}\nDesc: {$pluginClass::getDescription()}";
|
|
$descriptionLabel->setText($description);
|
|
$nameLabel->addTooltipFeature($descriptionLabel);
|
|
|
|
$quad = new Quad_Icons128x32_1();
|
|
$pluginFrame->add($quad);
|
|
$quad->setSubStyle($quad::SUBSTYLE_Settings);
|
|
$quad->setX(15);
|
|
$quad->setZ(1);
|
|
$quad->setSize(5, 5);
|
|
$quad->setAction(self::ACTION_PREFIX_SETTINGS . $pluginClass);
|
|
|
|
$statusChangeButton = new Label_Button();
|
|
$pluginFrame->add($statusChangeButton);
|
|
$statusChangeButton->setHAlign($statusChangeButton::RIGHT);
|
|
$statusChangeButton->setX($width * 0.45);
|
|
$statusChangeButton->setStyle($statusChangeButton::STYLE_CardButtonSmall);
|
|
if ($active) {
|
|
$statusChangeButton->setTextPrefix('$f00');
|
|
$statusChangeButton->setText('Deactivate');
|
|
$statusChangeButton->setAction(self::ACTION_PREFIX_DISABLEPLUGIN . $pluginClass);
|
|
} else {
|
|
$statusChangeButton->setTextPrefix('a');
|
|
$statusChangeButton->setText('Activate');
|
|
$statusChangeButton->setAction(self::ACTION_PREFIX_ENABLEPLUGIN . $pluginClass);
|
|
}
|
|
|
|
if ($pluginUpdates && array_key_exists($pluginClass::getId(), $pluginUpdates)) {
|
|
$quadUpdate = new Quad_Icons128x128_1();
|
|
$pluginFrame->add($quadUpdate);
|
|
$quadUpdate->setSubStyle($quadUpdate::SUBSTYLE_ProfileVehicle);
|
|
$quadUpdate->setX(56);
|
|
$quadUpdate->setZ(2);
|
|
$quadUpdate->setSize(5, 5);
|
|
$quadUpdate->setAction(self::ACTION_PREFIX_UPDATEPLUGIN . $pluginClass);
|
|
}
|
|
|
|
$posY -= $entryHeight;
|
|
}
|
|
|
|
if ($pluginUpdates) {
|
|
$updatePluginsButton = new Label_Button();
|
|
$frame->add($updatePluginsButton);
|
|
$updatePluginsButton->setHAlign($updatePluginsButton::RIGHT);
|
|
$updatePluginsButton->setPosition($width * 0.5, -29, 2);
|
|
$updatePluginsButton->setWidth(10);
|
|
$updatePluginsButton->setStyle($updatePluginsButton::STYLE_CardButtonSmallS);
|
|
$updatePluginsButton->setText(count($pluginUpdates) . ' update(s)');
|
|
$updatePluginsButton->setAction(self::ACTION_UPDATEPLUGINS);
|
|
}
|
|
|
|
return $frame;
|
|
}
|
|
|
|
/**
|
|
* Get the Frame with the Plugin Settings
|
|
*
|
|
* @param Frame $frame
|
|
* @param float $width
|
|
* @param float $height
|
|
* @param Paging $paging
|
|
* @param Player $player
|
|
* @param string $settingClass
|
|
* @return Frame
|
|
*/
|
|
private function getPluginSettingsMenu(Frame $frame, $width, $height, Paging $paging, Player $player, $settingClass) {
|
|
// TODO: centralize menu code to use by mc settings and plugin settings
|
|
$settings = $this->maniaControl->settingManager->getSettingsByClass($settingClass);
|
|
|
|
$pageSettingsMaxCount = 11;
|
|
$posY = 0;
|
|
$index = 0;
|
|
$settingHeight = 5.;
|
|
$pageFrame = null;
|
|
|
|
//Headline Label
|
|
$headLabel = new Label_Text();
|
|
$frame->add($headLabel);
|
|
$headLabel->setHAlign($headLabel::LEFT);
|
|
$headLabel->setPosition($width * -0.46, $height * 0.41);
|
|
$headLabel->setSize($width * 0.6, $settingHeight);
|
|
$headLabel->setStyle($headLabel::STYLE_TextCardSmall);
|
|
$headLabel->setTextSize(3);
|
|
$headLabel->setText($settingClass);
|
|
$headLabel->setTextColor('ff0');
|
|
|
|
foreach ($settings as $setting) {
|
|
if ($index % $pageSettingsMaxCount === 0) {
|
|
$pageFrame = new Frame();
|
|
$frame->add($pageFrame);
|
|
$paging->addPage($pageFrame);
|
|
$posY = $height * 0.41 - $settingHeight * 1.5;
|
|
}
|
|
|
|
$settingFrame = new Frame();
|
|
$pageFrame->add($settingFrame);
|
|
$settingFrame->setY($posY);
|
|
|
|
$nameLabel = new Label_Text();
|
|
$settingFrame->add($nameLabel);
|
|
$nameLabel->setHAlign($nameLabel::LEFT);
|
|
$nameLabel->setX($width * -0.46);
|
|
$nameLabel->setSize($width * 0.6, $settingHeight);
|
|
$nameLabel->setStyle($nameLabel::STYLE_TextCardSmall);
|
|
$nameLabel->setTextSize(2);
|
|
$nameLabel->setText($setting->setting);
|
|
$nameLabel->setTextColor('fff');
|
|
|
|
if ($setting->type === Setting::TYPE_BOOL) {
|
|
// Boolean checkbox
|
|
$quad = new Quad();
|
|
$quad->setPosition($width * 0.33, 0, -0.01);
|
|
$quad->setSize(4, 4);
|
|
$checkBox = new CheckBox(self::ACTION_PREFIX_SETTING . $setting->index, $setting->value, $quad);
|
|
$settingFrame->add($checkBox);
|
|
} else if ($setting->type === Setting::TYPE_SET) {
|
|
// SET value picker
|
|
$label = new Label_Text();
|
|
$label->setX($width * 0.33);
|
|
$label->setSize($width * 0.3, $settingHeight * 0.9);
|
|
$label->setStyle($label::STYLE_TextValueSmall);
|
|
$label->setTextSize(1);
|
|
$valuePicker = new ValuePicker(self::ACTION_PREFIX_SETTING . $setting->index, $setting->set, $setting->value, $label);
|
|
$settingFrame->add($valuePicker);
|
|
} else {
|
|
// Value entry
|
|
$entry = new Entry();
|
|
$settingFrame->add($entry);
|
|
$entry->setX($width * 0.33);
|
|
$entry->setSize($width * 0.3, $settingHeight * 0.9);
|
|
$entry->setTextSize(1);
|
|
$entry->setStyle(Label_Text::STYLE_TextValueSmall);
|
|
$entry->setName(self::ACTION_PREFIX_SETTING . $setting->index);
|
|
$entry->setDefault($setting->value);
|
|
}
|
|
|
|
$posY -= $settingHeight;
|
|
|
|
$index++;
|
|
}
|
|
|
|
$backButton = new Label_Button();
|
|
$frame->add($backButton);
|
|
$backButton->setStyle($backButton::STYLE_CardMain_Quit);
|
|
$backButton->setHAlign($backButton::LEFT);
|
|
$backButton->setScale(0.75);
|
|
$backButton->setText('Back');
|
|
$backButton->setPosition(-$width / 2 + 7, -$height / 2 + 7);
|
|
$backButton->setAction(self::ACTION_BACK_TO_PLUGINS);
|
|
|
|
return $frame;
|
|
}
|
|
|
|
/**
|
|
* Handle PlayerManialinkPageAnswer callback
|
|
*
|
|
* @param array $callback
|
|
*/
|
|
public function handleManialinkPageAnswer(array $callback) {
|
|
$login = $callback[1][1];
|
|
$player = $this->maniaControl->playerManager->getPlayer($login);
|
|
if (!$player) {
|
|
return;
|
|
}
|
|
|
|
$actionId = $callback[1][2];
|
|
$enable = (strpos($actionId, self::ACTION_PREFIX_ENABLEPLUGIN) === 0);
|
|
$disable = (strpos($actionId, self::ACTION_PREFIX_DISABLEPLUGIN) === 0);
|
|
$settings = (strpos($actionId, self::ACTION_PREFIX_SETTINGS) === 0);
|
|
if (!$enable && !$disable && !$settings) {
|
|
return;
|
|
}
|
|
|
|
if ($enable) {
|
|
$pluginClass = substr($actionId, strlen(self::ACTION_PREFIX_ENABLEPLUGIN));
|
|
/** @var Plugin $pluginClass */
|
|
$activated = $this->maniaControl->pluginManager->activatePlugin($pluginClass, $player->login);
|
|
if ($activated) {
|
|
$this->maniaControl->chat->sendSuccess($pluginClass::getName() . ' activated!', $player);
|
|
$this->maniaControl->log("{$player->login} activated '{$pluginClass}'!", true);
|
|
} else {
|
|
$this->maniaControl->chat->sendError('Error activating ' . $pluginClass::getName() . '!', $player);
|
|
}
|
|
} else if ($disable) {
|
|
$pluginClass = substr($actionId, strlen(self::ACTION_PREFIX_DISABLEPLUGIN));
|
|
/** @var Plugin $pluginClass */
|
|
$deactivated = $this->maniaControl->pluginManager->deactivatePlugin($pluginClass);
|
|
if ($deactivated) {
|
|
$this->maniaControl->chat->sendSuccess($pluginClass::getName() . ' deactivated!', $player);
|
|
$this->maniaControl->log("{$player->login} deactivated '{$pluginClass}'!", true);
|
|
} else {
|
|
$this->maniaControl->chat->sendError('Error deactivating ' . $pluginClass::getName() . '!', $player);
|
|
}
|
|
} else if ($settings) {
|
|
// Open Settings Menu
|
|
$pluginClass = substr($actionId, strlen(self::ACTION_PREFIX_SETTINGS));
|
|
$player->setCache($this, self::CACHE_SETTING_CLASS, $pluginClass);
|
|
}
|
|
|
|
// Reopen the Menu
|
|
$this->maniaControl->configurator->showMenu($player, $this);
|
|
}
|
|
|
|
/**
|
|
* @see \ManiaControl\Configurators\ConfiguratorMenu::saveConfigData()
|
|
*/
|
|
public function saveConfigData(array $configData, Player $player) {
|
|
if (!$this->maniaControl->authenticationManager->checkPermission($player, self::SETTING_PERMISSION_CHANGE_PLUGIN_SETTINGS)) {
|
|
$this->maniaControl->authenticationManager->sendNotAllowed($player);
|
|
return;
|
|
}
|
|
if (!$configData[3] || strpos($configData[3][0]['Name'], self::ACTION_PREFIX_SETTING) !== 0) {
|
|
return;
|
|
}
|
|
|
|
$prefixLength = strlen(self::ACTION_PREFIX_SETTING);
|
|
|
|
foreach ($configData[3] as $settingData) {
|
|
$settingIndex = (int)substr($settingData['Name'], $prefixLength);
|
|
$settingObject = $this->maniaControl->settingManager->getSettingObjectByIndex($settingIndex);
|
|
if (!$settingObject) {
|
|
continue;
|
|
}
|
|
|
|
if (!$settingData || $settingData['Value'] == $settingObject->value) {
|
|
continue;
|
|
}
|
|
|
|
$settingObject->value = $settingData['Value'];
|
|
$this->maniaControl->settingManager->saveSetting($settingObject);
|
|
}
|
|
|
|
$this->maniaControl->chat->sendSuccess('Plugin Settings saved!', $player);
|
|
|
|
// Reopen the Menu
|
|
$this->maniaControl->configurator->showMenu($player, $this);
|
|
}
|
|
}
|