From 08d52f1a18929ec5e71d39351c6553c658d9a106 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Steffen=20Schro=CC=88der?= Date: Fri, 2 May 2014 04:03:33 +0200 Subject: [PATCH] removed code of plugins update manager refactored & improved other code --- application/core/Update/UpdateData.php | 40 +- application/core/Update/UpdateManager.php | 845 ++++++---------------- 2 files changed, 241 insertions(+), 644 deletions(-) diff --git a/application/core/Update/UpdateData.php b/application/core/Update/UpdateData.php index b7a33ca8..99b0ee04 100644 --- a/application/core/Update/UpdateData.php +++ b/application/core/Update/UpdateData.php @@ -3,9 +3,9 @@ namespace ManiaControl\Update; /** - * UpdateStructure - * - * @author steeffeen & kremsy + * Update Data Structure + * + * @author ManiaControl Team * @copyright ManiaControl Copyright © 2014 ManiaControl Team * @license http://www.gnu.org/licenses/ GNU General Public License, Version 3 */ @@ -13,21 +13,37 @@ class UpdateData { /* * Public Properties */ - public $version = 0; - public $channel = ""; - public $url = ""; - public $releaseDate = ""; - public $minDedicatedBuild = ""; + public $version = null; + public $channel = null; + public $url = null; + public $releaseDate = null; + public $minDedicatedBuild = null; + /** * Construct new Update Data * - * @param Object $updateData + * @param object $updateData */ public function __construct($updateData) { - $this->version = $updateData->version; - $this->channel = $updateData->channel; - $this->url = $updateData->url; + $this->version = $updateData->version; + $this->channel = $updateData->channel; + $this->url = $updateData->url; $this->releaseDate = $updateData->release_date; $this->minDedicatedBuild = $updateData->min_dedicated_build; } + + /** + * Check if the Update Data is newer than the given Date + * + * @param string $compareDate + * @return bool + */ + public function isNewerThan($compareDate) { + if (!$compareDate) { + return true; + } + $compareTime = strtotime($compareDate); + $releaseTime = strtotime($this->releaseDate); + return ($releaseTime > $compareTime); + } } diff --git a/application/core/Update/UpdateManager.php b/application/core/Update/UpdateManager.php index 5ac7b4c0..84407bb1 100644 --- a/application/core/Update/UpdateManager.php +++ b/application/core/Update/UpdateManager.php @@ -15,11 +15,12 @@ use ManiaControl\Plugins\Plugin; use ManiaControl\Plugins\PluginInstallMenu; use ManiaControl\Plugins\PluginMenu; use ManiaControl\Plugins\PluginManager; +use ManiaControl\Files\BackupUtil; /** - * Manager checking for ManiaControl Core and Plugin Updates + * Manager checking for ManiaControl Core Updates * - * @author steeffeen & kremsy + * @author ManiaControl Team * @copyright ManiaControl Copyright © 2014 ManiaControl Team * @license http://www.gnu.org/licenses/ GNU General Public License, Version 3 */ @@ -38,6 +39,11 @@ class UpdateManager implements CallbackListener, CommandListener, TimerListener const CHANNEL_BETA = 'beta'; const CHANNEL_NIGHTLY = 'nightly'; + /* + * Public Properties + */ + public $pluginUpdateManager = null; + /* * Private Properties */ @@ -47,7 +53,7 @@ class UpdateManager implements CallbackListener, CommandListener, TimerListener * @var UpdateData $coreUpdateData */ private $coreUpdateData = null; - private $currentBuildDate = ""; + private $currentBuildDate = null; /** * Create a new Update Manager @@ -61,7 +67,6 @@ class UpdateManager implements CallbackListener, CommandListener, TimerListener $this->maniaControl->settingManager->initSetting($this, self::SETTING_ENABLEUPDATECHECK, true); $this->maniaControl->settingManager->initSetting($this, self::SETTING_AUTO_UPDATE, true); $this->maniaControl->settingManager->initSetting($this, self::SETTING_UPDATECHECK_INTERVAL, 1); - // TODO: 'nightly' only during dev $this->maniaControl->settingManager->initSetting($this, self::SETTING_UPDATECHECK_CHANNEL, self::CHANNEL_BETA); $this->maniaControl->settingManager->initSetting($this, self::SETTING_PERFORM_BACKUPS, true); @@ -69,8 +74,7 @@ class UpdateManager implements CallbackListener, CommandListener, TimerListener $updateInterval = $this->maniaControl->settingManager->getSetting($this, self::SETTING_UPDATECHECK_INTERVAL); $this->maniaControl->timerManager->registerTimerListening($this, 'hourlyUpdateCheck', 1000 * 60 * 60 * $updateInterval); $this->maniaControl->callbackManager->registerCallbackListener(PlayerManager::CB_PLAYERCONNECT, $this, 'handlePlayerJoined'); - $this->maniaControl->callbackManager->registerCallbackListener(PlayerManager::CB_PLAYERDISCONNECT, $this, 'autoUpdate'); - $this->maniaControl->callbackManager->registerCallbackListener(CallbackManager::CB_MP_PLAYERMANIALINKPAGEANSWER, $this, 'handleManialinkPageAnswer'); + $this->maniaControl->callbackManager->registerCallbackListener(PlayerManager::CB_PLAYERDISCONNECT, $this, 'handlePlayerDisconnect'); // define Permissions $this->maniaControl->authenticationManager->definePermissionLevel(self::SETTING_PERMISSION_UPDATE, AuthenticationManager::AUTH_LEVEL_ADMIN); @@ -79,9 +83,16 @@ class UpdateManager implements CallbackListener, CommandListener, TimerListener // Register for chat commands $this->maniaControl->commandManager->registerCommandListener('checkupdate', $this, 'handle_CheckUpdate', true, 'Checks if there is a core update.'); $this->maniaControl->commandManager->registerCommandListener('coreupdate', $this, 'handle_CoreUpdate', true, 'Performs the core update.'); - $this->maniaControl->commandManager->registerCommandListener('pluginupdate', $this, 'handle_PluginUpdate', true, 'Performs the plugin updates.'); - $this->currentBuildDate = $this->getNightlyBuildDate(); + // Plugin update manager + $this->pluginUpdateManager = new PluginUpdateManager($maniaControl); + } + + /** + * Start an Update Check + */ + public function checkUpdate() { + $this->checkCoreUpdateAsync(array($this, 'handleUpdateCheck')); } /** @@ -92,31 +103,89 @@ class UpdateManager implements CallbackListener, CommandListener, TimerListener public function hourlyUpdateCheck($time) { $updateCheckEnabled = $this->maniaControl->settingManager->getSetting($this, self::SETTING_ENABLEUPDATECHECK); if (!$updateCheckEnabled) { - // Automatic update check disabled - if ($this->coreUpdateData) { - $this->coreUpdateData = null; - } + $this->setCoreUpdateData(); + return; + } + $this->checkUpdate(); + } + + /** + * Handle the fetched Update Data + * + * @param UpdateData $updateData + */ + public function handleUpdateCheck(UpdateData $updateData) { + if (!$this->checkUpdateData($updateData)) { + // No new update available + return; + } + if (!$this->checkUpdateDataBuildVersion($updateData)) { + // Server incompatible + $this->maniaControl->log("Please update Your Server to '{$updateData->minDedicatedBuild}' in order to receive further Updates!"); return; } - // Check if a new Core Update is Available - $self = $this; - $maniaControl = $this->maniaControl; - $this->checkCoreUpdateAsync(function (UpdateData $updateData) use($self, $maniaControl, $time) { - $buildDate = strtotime($self->getCurrentBuildDate()); - $releaseTime = strtotime($updateData->releaseDate); - if ($buildDate < $releaseTime) { - $updateChannel = $maniaControl->settingManager->getSetting($self, UpdateManager::SETTING_UPDATECHECK_CHANNEL); - if ($updateChannel != UpdateManager::CHANNEL_NIGHTLY) { - $maniaControl->log('New ManiaControl Version ' . $updateData->version . ' available!'); - } - else { - $maniaControl->log('New Nightly Build (' . $updateData->releaseDate . ') available!'); - } - $self->setCoreUpdateData($updateData); - $self->autoUpdate($time); - } - }, true); + if ($this->isNightlyUpdateChannel()) { + $this->maniaControl->log("New Nightly Build ({$updateData->releaseDate}) available!"); + } + else { + $this->maniaControl->log("New ManiaControl Version {$updateData->version} available!"); + } + $this->setCoreUpdateData($updateData); + + $this->checkAutoUpdate(); + } + + /** + * Check if the given Update Data has a new Version and fits for the Server + * + * @param UpdateData $updateData + * @return bool + */ + public function checkUpdateData(UpdateData $updateData = null) { + if (!$updateData || !$updateData->url) { + // Data corrupted + return false; + } + + $isNightly = $this->isNightlyUpdateChannel(); + $buildDate = $this->getNightlyBuildDate(); + + if ($isNightly || $buildDate) { + return $updateData->isNewerThan($buildDate); + } + + return ($updateData->version > ManiaControl::VERSION); + } + + /** + * Check if the Update Data is compatible with the Server + * + * @param UpdateData $updateData + * @return bool + */ + public function checkUpdateDataBuildVersion(UpdateData $updateData = null) { + if (!$updateData) { + // Data corrupted + return false; + } + + $version = $this->maniaControl->client->getVersion(); + if ($updateData->minDedicatedBuild > $version->build) { + // Server not compatible + return false; + } + + return true; + } + + /** + * Set Core Update Data + * + * @param UpdateData $coreUpdateData + */ + public function setCoreUpdateData(UpdateData $coreUpdateData = null) { + $this->coreUpdateData = $coreUpdateData; } /** @@ -133,55 +202,42 @@ class UpdateManager implements CallbackListener, CommandListener, TimerListener return; } - $buildDate = strtotime($this->currentBuildDate); - $releaseTime = strtotime($this->coreUpdateData->releaseDate); - if ($buildDate < $releaseTime) { - $updateChannel = $this->maniaControl->settingManager->getSetting($this, self::SETTING_UPDATECHECK_CHANNEL); - if ($updateChannel != self::CHANNEL_NIGHTLY) { - $this->maniaControl->chat->sendInformation('New ManiaControl Version ' . $this->coreUpdateData->version . ' available!', $player->login); - } - else { - $this->maniaControl->chat->sendSuccess('New Nightly Build (' . $this->coreUpdateData->releaseDate . ') available!', $player->login); - } + if ($this->isNightlyUpdateChannel()) { + $this->maniaControl->chat->sendSuccess('New Nightly Build (' . $this->coreUpdateData->releaseDate . ') available!', $player->login); + } + else { + $this->maniaControl->chat->sendInformation('New ManiaControl Version ' . $this->coreUpdateData->version . ' available!', $player->login); } } /** - * Perform automatic update as soon as a the Server is empty (also every hour got checked when its empty) + * Handle Player Disconnect Callback * - * @param mixed $callback + * @param Player $player */ - public function autoUpdate($callback) { + public function handlePlayerDisconnect(Player $player) { + $this->checkAutoUpdate(); + } + + /** + * Check if an automatic Update should be performed + */ + public function checkAutoUpdate() { $autoUpdate = $this->maniaControl->settingManager->getSetting($this, self::SETTING_AUTO_UPDATE); if (!$autoUpdate) { + // Auto update turned off return; } - - if (count($this->maniaControl->playerManager->getPlayers()) > 0) { - return; - } - if (!$this->coreUpdateData) { + // No update available + return; + } + if (count($this->maniaControl->playerManager->getPlayers()) > 0) { + // Server not empty return; } - $version = $this->maniaControl->client->getVersion(); - if ($this->coreUpdateData->minDedicatedBuild > $version->build) { - return; - } - - $buildDate = strtotime($this->currentBuildDate); - $releaseTime = strtotime($this->coreUpdateData->releaseDate); - if ($buildDate && $buildDate >= $releaseTime) { - return; - } - - $this->maniaControl->log("Starting Update to Version v{$this->coreUpdateData->version}..."); - $performBackup = $this->maniaControl->settingManager->getSetting($this, self::SETTING_PERFORM_BACKUPS); - if ($performBackup && !$this->performBackup()) { - $this->maniaControl->log("Creating Backup failed!"); - } - $this->performCoreUpdate($this->coreUpdateData); + $this->performCoreUpdate(); } /** @@ -195,130 +251,64 @@ class UpdateManager implements CallbackListener, CommandListener, TimerListener $this->maniaControl->authenticationManager->sendNotAllowed($player); return; } - $updateChannel = $this->maniaControl->settingManager->getSetting($this, self::SETTING_UPDATECHECK_CHANNEL); - if ($updateChannel === self::CHANNEL_NIGHTLY) { - // Special nightly channel updating - $self = $this; - $this->checkCoreUpdateAsync(function ($updateData) use(&$self, &$player) { - if (!$updateData) { - $self->maniaControl->chat->sendInformation('No Update available!', $player->login); - return; - } - - $version = $self->maniaControl->client->getVersion(); - if ($updateData->minDedicatedBuild > $version->build) { - $self->maniaControl->chat->sendError("No new Build for this Server-version available!", $player->login); - return; - } - - $buildTime = strtotime($self->currentBuildDate); - $releaseTime = strtotime($updateData->releaseDate); - if ($buildTime != '') { - if ($buildTime >= $releaseTime) { - $self->maniaControl->chat->sendInformation('No new Build available, current build: ' . date("Y-m-d", $buildTime) . '!', $player->login); - return; + + $self = $this; + $this->checkCoreUpdateAsync(function (UpdateData $updateData = null) use(&$self, &$player) { + if (!$self->checkUpdateData($updateData)) { + $self->maniaControl->chat->sendInformation('No Update available!', $player->login); + return; + } + + if (!$self->checkUpdateDataBuildVersion($updateData)) { + $self->maniaControl->chat->sendError("Please update Your Server to '{$updateData->minDedicatedBuild}' in order to receive further Updates!", $player->login); + return; + } + + $isNightly = $self->isNightlyUpdateChannel(); + if ($isNightly) { + $buildDate = $self->getNightlyBuildDate(); + if ($buildDate) { + if ($updateData->isNewerThan($buildDate)) { + $self->maniaControl->chat->sendInformation("No new Build available! (Current Build: '{$buildDate}')", $player->login); + } + else { + $self->maniaControl->chat->sendSuccess("New Nightly Build ({$updateData->releaseDate}) available! (Current Build: '{$buildDate}')", $player->login); } - $self->maniaControl->chat->sendSuccess('New Nightly Build (' . $updateData->releaseDate . ') available, current build: ' . $self->currentBuildDate . '!', $player->login); } else { - $self->maniaControl->chat->sendSuccess('New Nightly Build (' . $updateData->releaseDate . ') available!', $player->login); + $self->maniaControl->chat->sendSuccess("New Nightly Build ('{$updateData->releaseDate}') available!", $player->login); } - }, true); - } - else { - // Check update and send result message - $self = $this; - $this->checkCoreUpdateAsync(function ($updateData) use(&$self, &$player) { - - if (!$updateData) { - $self->maniaControl->chat->sendInformation('No Update available!', $player->login); - return; - } - - $version = $self->maniaControl->client->getVersion(); - - if ($updateData->minDedicatedBuild > $version->build) { - $self->maniaControl->chat->sendError("No new Build for this Server-version available!", $player->login); - return; - } - - $self->maniaControl->chat->sendSuccess('Update for Version ' . $updateData->version . ' available!', $player->login); - }); - } - } - - /** - * Handle PlayerManialinkPageAnswer callback - * - * @param array $callback - */ - public function handleManialinkPageAnswer(array $callback) { - $actionId = $callback[1][2]; - $update = (strpos($actionId, PluginMenu::ACTION_PREFIX_UPDATEPLUGIN) === 0); - $install = (strpos($actionId, PluginInstallMenu::ACTION_PREFIX_INSTALLPLUGIN) === 0); - - $login = $callback[1][1]; - $player = $this->maniaControl->playerManager->getPlayer($login); - - if ($update) { - $pluginClass = substr($actionId, strlen(PluginMenu::ACTION_PREFIX_UPDATEPLUGIN)); - if ($pluginClass == 'All') { - $this->checkPluginsUpdate($player); } else { - $newUpdate = $this->checkPluginUpdate($pluginClass); - if ($newUpdate != false) { - $newUpdate->pluginClass = $pluginClass; - $this->updatePlugin($newUpdate, $player, true); - } + $self->maniaControl->chat->sendSuccess('Update for Version ' . $updateData->version . ' available!', $player->login); } - } - - if ($install) { - $pluginId = substr($actionId, strlen(PluginInstallMenu::ACTION_PREFIX_INSTALLPLUGIN)); - - $url = ManiaControl::URL_WEBSERVICE . 'plugins?id=' . $pluginId; - $dataJson = FileUtil::loadFile($url); - $pluginVersions = json_decode($dataJson); - if ($pluginVersions && isset($pluginVersions[0])) { - $pluginData = $pluginVersions[0]; - $this->installPlugin($pluginData, $player, true); - } - } + }); } /** * Get the Build Date of the local Nightly Build Version * - * @return String $buildTime - */ - private function getNightlyBuildDate() { - $nightlyBuildDateFile = ManiaControlDir . '/core/nightly_build.txt'; - if (!file_exists($nightlyBuildDateFile)) { - return ''; - } - $fileContent = file_get_contents($nightlyBuildDateFile); - return $fileContent; - } - - /** - * Get the CurrentBuildDate - * * @return string */ - public function getCurrentBuildDate() { + public function getNightlyBuildDate() { + if (!$this->currentBuildDate) { + $nightlyBuildDateFile = ManiaControlDir . '/core/nightly_build.txt'; + if (file_exists($nightlyBuildDateFile)) { + $this->currentBuildDate = file_get_contents($nightlyBuildDateFile); + } + } return $this->currentBuildDate; } /** * Set the Build Date of the local Nightly Build Version * - * @param $date - * @return mixed + * @param string $date + * @return bool */ private function setNightlyBuildDate($date) { $nightlyBuildDateFile = ManiaControlDir . '/core/nightly_build.txt'; - $success = file_put_contents($nightlyBuildDateFile, $date); + $success = (bool) file_put_contents($nightlyBuildDateFile, $date); $this->currentBuildDate = $date; return $success; } @@ -336,553 +326,144 @@ class UpdateManager implements CallbackListener, CommandListener, TimerListener } $self = $this; - $this->checkCoreUpdateAsync(function (UpdateData $updateData) use(&$self, &$player) { + $this->checkCoreUpdateAsync(function (UpdateData $updateData = null) use(&$self, &$player) { if (!$updateData) { $self->maniaControl->chat->sendError('Update is currently not possible!', $player->login); return; } - $version = $self->maniaControl->client->getVersion(); - if ($updateData->minDedicatedBuild > $version->build) { - $self->maniaControl->chat->sendError("ManiaControl update version requires a newer Dedicated Server version!", $player->login); + if (!$self->checkUpdateDataBuildVersion($updateData)) { + $self->maniaControl->chat->sendError("The Next ManiaControl Update requires a newer Dedicated Server Version!", $player->login); return; } - $self->maniaControl->chat->sendInformation("Starting Update to Version v{$updateData->version}...", $player->login); - $self->maniaControl->log("Starting Update to Version v{$updateData->version}..."); + $message = "Starting Update to Version v{$updateData->version}..."; + $self->maniaControl->chat->sendInformation($message, $player->login); + $self->maniaControl->log($message); + $performBackup = $self->maniaControl->settingManager->getSetting($self, UpdateManager::SETTING_PERFORM_BACKUPS); - if ($performBackup && !$self->performBackup()) { - $self->maniaControl->chat->sendError('Creating backup failed.', $player->login); - $self->maniaControl->log("Creating backup failed."); + if ($performBackup && !BackupUtil::performFullBackup()) { + $message = 'Creating Backup failed!'; + $self->maniaControl->chat->sendError($message, $player->login); + $self->maniaControl->log($message); } - $self->performCoreUpdate($updateData, $player); - }, true); - } - - /** - * Handle //pluginupdate command - * - * @param array $chatCallback - * @param Player $player - */ - public function handle_PluginUpdate(array $chatCallback, Player $player) { - if (!$this->maniaControl->authenticationManager->checkPermission($player, self::SETTING_PERMISSION_UPDATE)) { - $this->maniaControl->authenticationManager->sendNotAllowed($player); - return; - } - - $this->checkPluginsUpdate($player); - } - - /** - * Checks if there are outdated plugins active. - * - * @param Player $player - */ - public function checkPluginsUpdate(Player $player = null) { - $this->maniaControl->log('[UPDATE] Checking plugins for newer versions ...'); - - $self = $this; - $this->maniaControl->pluginManager->fetchPluginList(function ($data, $error) use(&$self, &$player) { - $outdatedPlugins = array(); - - if (!$data || $error) { - $self->maniaControl->log('[UPDATE] Error while checking plugins for newer version'); - return; - } - - $pluginClasses = $self->maniaControl->pluginManager->getPluginClasses(); - - foreach ($data as $plugin) { - foreach ($pluginClasses as $pluginClass) { - $id = $pluginClass::getId(); - if ($plugin->id == $id) { - if ($plugin->currentVersion->version > $pluginClass::getVersion()) { - $outdatedPlugins[] = $plugin; - $self->maniaControl->log('[UPDATE] ' . $pluginClass . ': There is a newer version available: ' . $plugin->currentVersion->version . '!'); - } - } - } - } - - if (count($outdatedPlugins) > 0) { - $self->maniaControl->log('[UPDATE] Checking plugins: COMPLETE, there are ' . count($outdatedPlugins) . ' outdated plugins, now updating ...'); - if ($player) { - $self->maniaControl->chat->sendInformation('Checking plugins: COMPLETE, there are ' . count($outdatedPlugins) . ' outdated plugins, now updating ...', $player->login); - } - $self->performPluginsBackup(); - foreach ($outdatedPlugins as $plugin) { - $self->updatePlugin($plugin, $player); - } - } - else { - $self->maniaControl->log('[UPDATE] Checking plugins: COMPLETE, all plugins are up-to-date!'); - if ($player) { - $self->maniaControl->chat->sendInformation('Checking plugins: COMPLETE, all plugins are up-to-date!', $player->login); - } - } + $self->performCoreUpdate($player); }); } /** - * Check given Plugin Class for Update + * Checks a Core Update asynchronously * - * @param string $pluginClass - * @return mixed + * @param callable $function */ - public function checkPluginUpdate($pluginClass) { - $pluginClass = PluginManager::getPluginClass($pluginClass); - /** - * - * @var Plugin $pluginClass - */ - $pluginId = $pluginClass::getId(); - $url = ManiaControl::URL_WEBSERVICE . 'plugins?id=' . $pluginId; - // TODO: asynchronous loading - $dataJson = FileUtil::loadFile($url); - $pluginVersions = json_decode($dataJson); - if (!$pluginVersions || !isset($pluginVersions[0])) { - return false; - } - $pluginData = $pluginVersions[0]; - $pluginVersion = $pluginClass::getVersion(); - if ($pluginData->currentVersion->version <= $pluginVersion) { - return false; - } - return $pluginData; - } - - /** - * Check for updates - * - * @return mixed - */ - public function getPluginsUpdates() { - $pluginUpdates = array(); - $pluginsWS = array(); - - $url = ManiaControl::URL_WEBSERVICE . 'plugins'; - $dataJson = FileUtil::loadFile($url); - $pluginVersions = json_decode($dataJson); - if (!$pluginVersions || !isset($pluginVersions[0])) { - return false; - } - - foreach ($pluginVersions as $plugin) { - $pluginsWS[$plugin->id] = $plugin; - } - - /** - * - * @var Plugin $pluginClass - */ - foreach ($this->maniaControl->pluginManager->getPluginClasses() as $pluginClass) { - $pluginId = $pluginClass::getId(); - if (array_key_exists($pluginId, $pluginsWS)) { - if ($pluginsWS[$pluginId]->currentVersion->version > $pluginClass::getVersion()) { - $pluginUpdates[$pluginId] = $pluginsWS[$pluginId]; - } - } - } - - if (empty($pluginUpdates)) { - return false; - } - return $pluginUpdates; - } - - /** - * Update pluginfile - * - * @param $pluginData - * @param Player $player - * @param bool $reopen - */ - private function updatePlugin($pluginData, Player $player = null, $reopen = false) { - $self = $this; - $this->maniaControl->fileReader->loadFile($pluginData->currentVersion->url, function ($updateFileContent, $error) use(&$self, &$updateData, &$player, &$pluginData, &$reopen) { - $self->maniaControl->log('[UPDATE] Now updating ' . $pluginData->name . ' ...'); - if ($player) { - $self->maniaControl->chat->sendInformation('Now updating ' . $pluginData->name . ' ...', $player->login); - } - $tempDir = ManiaControlDir . '/temp/'; - if (!is_dir($tempDir)) { - mkdir($tempDir); - } - $updateFileName = $tempDir . $pluginData->currentVersion->zipfile; - - $bytes = file_put_contents($updateFileName, $updateFileContent); - if (!$bytes || $bytes <= 0) { - trigger_error("Couldn't save plugin Zip."); - if ($player) { - $self->maniaControl->chat->sendError("Update failed: Couldn't save plugin zip!", $player->login); - } - return; - } - $zip = new \ZipArchive(); - $result = $zip->open($updateFileName); - if ($result !== true) { - trigger_error("Couldn't open plugin Zip. ({$result})"); - if ($player) { - $self->maniaControl->chat->sendError("Update failed: Couldn't open plugin zip!", $player->login); - } - return; - } - - $zip->extractTo(ManiaControlDir . '/plugins'); - $zip->close(); - unlink($updateFileName); - @rmdir($tempDir); - - $self->maniaControl->log('[UPDATE] Successfully updated ' . $pluginData->name . '!'); - if ($player) { - $self->maniaControl->chat->sendSuccess('Successfully updated ' . $pluginData->name . '!', $player->login); - // FIXME: the property $pluginData->pluginClass doesn't exist - // TODO: to update a plugin you need to restart maniacontrol, otherwise the new file isn't loaded by php - $self->maniaControl->pluginManager->deactivatePlugin($pluginData->pluginClass); - $self->maniaControl->pluginManager->activatePlugin($pluginData->pluginClass); - - if ($reopen) { - $menuId = $self->maniaControl->configurator->getMenuId('Plugins'); - $self->maniaControl->configurator->reopenMenu($player, $menuId); - } - } - }); - } - - /** - * Install pluginfile - * - * @param $pluginData - * @param Player $player - * @param bool $reopen - */ - private function installPlugin($pluginData, Player $player, $reopen = false) { - $self = $this; - $this->maniaControl->fileReader->loadFile($pluginData->currentVersion->url, function ($installFileContent, $error) use(&$self, &$updateData, &$player, &$pluginData, &$reopen) { - $pluginsDirectory = ManiaControlDir . '/plugins/'; - $pluginFiles = $this->scanDirectory($pluginsDirectory); - - $self->maniaControl->log('[UPDATE] Now installing ' . $pluginData->name . ' ...'); - $self->maniaControl->chat->sendInformation('Now installing ' . $pluginData->name . ' ...', $player->login); - - $tempDir = ManiaControlDir . '/temp/'; - if (!is_dir($tempDir)) { - mkdir($tempDir); - } - $installFileName = $tempDir . $pluginData->currentVersion->zipfile; - - $bytes = file_put_contents($installFileName, $installFileContent); - if (!$bytes || $bytes <= 0) { - trigger_error("Couldn't save plugin Zip."); - $self->maniaControl->chat->sendError("Install failed: Couldn't save plugin zip!", $player->login); - return; - } - $zip = new \ZipArchive(); - $result = $zip->open($installFileName); - if ($result !== true) { - trigger_error("Couldn't open plugin Zip. ({$result})"); - $self->maniaControl->chat->sendError("Install failed: Couldn't open plugin zip!", $player->login); - return; - } - - $zip->extractTo(ManiaControlDir . '/plugins'); - $zip->close(); - unlink($installFileName); - @rmdir($tempDir); - - $pluginFilesAfter = $this->scanDirectory($pluginsDirectory); - $newFiles = array_diff($pluginFilesAfter, $pluginFiles); - - $classesBefore = get_declared_classes(); - foreach ($newFiles as $newFile) { - $filePath = $pluginsDirectory . $newFile; - - if (is_file($filePath) && strstr($filePath, '.php')) { - $success = include_once $filePath; - if (!$success) { - trigger_error("Error loading File '{$filePath}'!"); - } - continue; - } - - $dirPath = $pluginsDirectory . $newFile; - if (is_dir($dirPath)) { - $self->maniaControl->pluginManager->loadPluginFiles($dirPath); - continue; - } - } - $classesAfter = get_declared_classes(); - - $newClasses = array_diff($classesAfter, $classesBefore); - foreach ($newClasses as $className) { - if (!$self->maniaControl->pluginManager->isPluginClass($className)) { - continue; - } - - /** - * - * @var Plugin $className - */ - $self->maniaControl->pluginManager->addPluginClass($className); - $className::prepare($self->maniaControl); - - if ($self->maniaControl->pluginManager->isPluginActive($className)) { - continue; - } - if (!$self->maniaControl->pluginManager->getSavedPluginStatus($className)) { - continue; - } - } - - $self->maniaControl->log('[UPDATE] Successfully installed ' . $pluginData->name . '!'); - $self->maniaControl->chat->sendSuccess('Successfully installed ' . $pluginData->name . '!', $player->login); - - if ($reopen) { - $menuId = $self->maniaControl->configurator->getMenuId('Install Plugins'); - $self->maniaControl->configurator->reopenMenu($player, $menuId); - } - }); - } - - /** - * Scans the plugindirectory recursively. - * - * @param $dir - * @return array - */ - function scanDirectory($dir) { - $result = array(); - - $cdir = scandir($dir); - foreach($cdir as $key => $value) { - if(!in_array($value,array(".",".."))) { - if(is_dir($dir . DIRECTORY_SEPARATOR . $value)) { - foreach($this->scanDirectory($dir . DIRECTORY_SEPARATOR . $value) as $dirValue) { - $result[] = $value.DIRECTORY_SEPARATOR.$dirValue; - } - } else { - $result[] = $value; - } - } - } - - return $result; - } - - /** - * Set Core Update Data - * - * @param UpdateData $coreUpdateData - */ - public function setCoreUpdateData(UpdateData $coreUpdateData = null) { - $this->coreUpdateData = $coreUpdateData; - } - - /** - * Checks a core update Asynchronously - * - * @param $function - * @param bool $ignoreVersion - */ - private function checkCoreUpdateAsync($function, $ignoreVersion = false) { + private function checkCoreUpdateAsync($function) { $updateChannel = $this->getCurrentUpdateChannelSetting(); $url = ManiaControl::URL_WEBSERVICE . 'versions?current=1&channel=' . $updateChannel; - $this->maniaControl->fileReader->loadFile($url, function ($dataJson, $error) use(&$function, $ignoreVersion) { + $this->maniaControl->fileReader->loadFile($url, function ($dataJson, $error) use(&$function) { $versions = json_decode($dataJson); if (!$versions || !isset($versions[0])) { - return; - } - $updateData = new UpdateData($versions[0]); - if (!$ignoreVersion && $updateData->version <= ManiaControl::VERSION) { call_user_func($function, null); } else { + $updateData = new UpdateData($versions[0]); call_user_func($function, $updateData); } }); } - /** - * Perform a Backup of ManiaControl - * - * @return bool - */ - private function performBackup() { - $backupFolder = ManiaControlDir . '/backup/'; - if (!is_dir($backupFolder)) { - mkdir($backupFolder); - } - $backupFileName = $backupFolder . 'backup_' . ManiaControl::VERSION . '_' . date('y-m-d') . '_' . time() . '.zip'; - $backupZip = new \ZipArchive(); - if ($backupZip->open($backupFileName, \ZipArchive::CREATE) !== TRUE) { - trigger_error("Couldn't create Backup Zip!"); - return false; - } - $excludes = array('.', '..', 'backup', 'logs', 'ManiaControl.log'); - $pathInfo = pathInfo(ManiaControlDir); - $parentPath = $pathInfo['dirname'] . '/'; - $dirName = $pathInfo['basename']; - $backupZip->addEmptyDir($dirName); - $this->zipDirectory($backupZip, ManiaControlDir, strlen($parentPath), $excludes); - $backupZip->close(); - return true; - } - - /** - * Perform a Backup of the plugins - * - * @return bool - */ - private function performPluginsBackup() { - $backupFolder = ManiaControlDir . '/backup/'; - if (!is_dir($backupFolder)) { - mkdir($backupFolder); - } - $backupFileName = $backupFolder . 'backup_plugins_' . date('y-m-d') . '_' . time() . '.zip'; - $backupZip = new \ZipArchive(); - if ($backupZip->open($backupFileName, \ZipArchive::CREATE) !== TRUE) { - trigger_error("Couldn't create Backup Zip!"); - return false; - } - $excludes = array('.', '..'); - $pathInfo = pathInfo(ManiaControlDir . '/plugins'); - $parentPath = $pathInfo['dirname'] . '/'; - $dirName = $pathInfo['basename']; - $backupZip->addEmptyDir($dirName); - $this->zipDirectory($backupZip, ManiaControlDir . '/plugins', strlen($parentPath), $excludes); - $backupZip->close(); - return true; - } - - /** - * Add a complete Directory to the ZipArchive - * - * @param \ZipArchive $zipArchive - * @param string $folderName - * @param int $prefixLength - * @param array $excludes - * @return bool - */ - private function zipDirectory(\ZipArchive &$zipArchive, $folderName, $prefixLength, array $excludes = array()) { - $folderHandle = opendir($folderName); - if (!$folderHandle) { - trigger_error("Couldn't open Folder '{$folderName}' for Backup!"); - return false; - } - while (false !== ($file = readdir($folderHandle))) { - if (in_array($file, $excludes)) { - continue; - } - $filePath = $folderName . '/' . $file; - $localPath = substr($filePath, $prefixLength); - if (is_file($filePath)) { - $zipArchive->addFile($filePath, $localPath); - continue; - } - if (is_dir($filePath)) { - $zipArchive->addEmptyDir($localPath); - $this->zipDirectory($zipArchive, $filePath, $prefixLength, $excludes); - continue; - } - } - closedir($folderHandle); - return true; - } - /** * Perform a Core Update * - * @param object $updateData - * @param $player + * @param Player $player * @return bool */ - private function performCoreUpdate(UpdateData $updateData, Player $player = null) { - if (!$this->checkPermissions()) { + private function performCoreUpdate(Player $player = null) { + if (!$this->coreUpdateData) { + $message = 'Update failed: No update Data available!'; if ($player) { - $this->maniaControl->chat->sendError('Update failed: Incorrect file system permissions!', $player->login); + $this->maniaControl->chat->sendError($message, $player); } - $this->maniaControl->log('Update failed!'); + $this->maniaControl->log($message); return false; } - if (!isset($updateData->url) && !isset($updateData->releaseDate)) { + $this->maniaControl->log("Starting Update to Version v{$this->coreUpdateData->version}..."); + + $directories = array('/core/', '/plugins/'); + if (!FileUtil::checkWritePermissions($directories)) { + $message = 'Update not possible: Incorrect File System Permissions!'; if ($player) { - $this->maniaControl->chat->sendError('Update failed: No update Data available!', $player->login); + $this->maniaControl->chat->sendError($message, $player); } - $this->maniaControl->log('Update failed: No update Data available!'); + $this->maniaControl->log($message); return false; } + $performBackup = $this->maniaControl->settingManager->getSetting($this, self::SETTING_PERFORM_BACKUPS); + if ($performBackup && !BackupUtil::performFullBackup()) { + $message = 'Creating Backup before Update failed!'; + if ($player) { + $this->maniaControl->chat->sendError($message, $player); + } + $this->maniaControl->log($message); + } + $self = $this; $this->maniaControl->fileReader->loadFile($updateData->url, function ($updateFileContent, $error) use(&$self, &$updateData, &$player) { - $tempDir = ManiaControlDir . '/temp/'; - if (!is_dir($tempDir)) { - mkdir($tempDir); - } + $tempDir = FileUtil::getTempFolder(); $updateFileName = $tempDir . basename($updateData->url); $bytes = file_put_contents($updateFileName, $updateFileContent); if (!$bytes || $bytes <= 0) { - trigger_error("Couldn't save Update Zip."); + $message = "Update failed: Couldn't save Update zip!"; if ($player) { - $self->maniaControl->chat->sendError("Update failed: Couldn't save Update zip!", $player->login); + $self->maniaControl->chat->sendError($message, $player); } - return false; + logMessage($message); + return; } + $zip = new \ZipArchive(); $result = $zip->open($updateFileName); if ($result !== true) { trigger_error("Couldn't open Update Zip. ({$result})"); if ($player) { - $self->maniaControl->chat->sendError("Update failed: Couldn't open Update zip!", $player->login); + $self->maniaControl->chat->sendError("Update failed: Couldn't open Update zip!", $player); } - return false; + return; } $zip->extractTo(ManiaControlDir); $zip->close(); unlink($updateFileName); - @rmdir($tempDir); + FileUtil::removeTempFolder(); // Set the Nightly Build Date $self->setNightlyBuildDate($updateData->releaseDate); + $message = 'Update finished!'; if ($player) { - $self->maniaControl->chat->sendSuccess('Update finished!', $player->login); + $self->maniaControl->chat->sendSuccess($message, $player); } - $self->maniaControl->log("Update finished!"); + $self->maniaControl->log($message); $self->maniaControl->restart(); - - return true; }); return true; } /** - * Function checks if ManiaControl has sufficient access to files to update them. + * Check if ManiaControl is running the Nightly Update Channel * - * @return bool + * @param string $updateChannel */ - private function checkPermissions() { - $writableDirectories = array('/core/', '/plugins/'); - $path = ManiaControlDir; - - foreach ($writableDirectories as $writableDirecotry) { - $dir = new \RecursiveDirectoryIterator($path . $writableDirecotry); - foreach (new \RecursiveIteratorIterator($dir) as $filename => $file) { - if (substr($filename, -1) != '.' && substr($filename, -2) != '..') { - if (!is_writable($filename)) { - $this->maniaControl->log('Cannot update: the file/directory "' . $filename . '" is not writable!'); - return false; - } - } - } + public function isNightlyUpdateChannel($updateChannel = null) { + if (!$updateChannel) { + $updateChannel = $this->getCurrentUpdateChannelSetting(); } - return true; + return ($updateChannel === self::CHANNEL_NIGHTLY); } /**