maniaControl = $maniaControl; // Init settings $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_NIGHTLY); $this->maniaControl->settingManager->initSetting($this, self::SETTING_PERFORM_BACKUPS, true); // Register for callbacks $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'); //define Permissions $this->maniaControl->authenticationManager->definePermissionLevel(self::SETTING_PERMISSION_UPDATE, AuthenticationManager::AUTH_LEVEL_ADMIN); $this->maniaControl->authenticationManager->definePermissionLevel(self::SETTING_PERMISSION_UPDATECHECK, AuthenticationManager::AUTH_LEVEL_MODERATOR); // Register for chat commands $this->maniaControl->commandManager->registerCommandListener('checkupdate', $this, 'handle_CheckUpdate', true); $this->maniaControl->commandManager->registerCommandListener('coreupdate', $this, 'handle_CoreUpdate', true); $this->currentBuildDate = $this->getNightlyBuildDate(); } /** * Perform Hourly Update Check * * @param $time */ 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; } 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); } /** * Handle ManiaControl PlayerJoined callback * * @param Player $player */ public function handlePlayerJoined(Player $player) { if (!$this->coreUpdateData) { return; } // Announce available update if (!$this->maniaControl->authenticationManager->checkPermission($player, self::SETTING_PERMISSION_UPDATE)) { 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); } } } /** * Perform automatic update as soon as a the Server is empty (also every hour got checked when its empty) * * @param mixed $callback */ public function autoUpdate($callback) { $autoUpdate = $this->maniaControl->settingManager->getSetting($this, self::SETTING_AUTO_UPDATE); if (!$autoUpdate) { return; } if (count($this->maniaControl->playerManager->getPlayers()) > 0) { return; } if (!$this->coreUpdateData) { 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); } /** * Handle //checkupdate command * * @param array $chatCallback * @param Player $player */ public function handle_CheckUpdate(array $chatCallback, Player $player) { if (!$this->maniaControl->authenticationManager->checkPermission($player, self::SETTING_PERMISSION_UPDATECHECK)) { $this->maniaControl->authenticationManager->sendNotAllowed($player); return; } $updateChannel = $this->maniaControl->settingManager->getSetting($this, self::SETTING_UPDATECHECK_CHANNEL); if ($updateChannel != self::CHANNEL_NIGHTLY) { // Check update and send result message $this->checkCoreUpdateAsync(function (UpdateData $updateData) use (&$player) { if (!$updateData) { $this->maniaControl->chat->sendInformation('No Update available!', $player->login); return; } $version = $this->maniaControl->client->getVersion(); if($updateData->minDedicatedBuild > $version->build){ $this->maniaControl->chat->sendError("No new Build for this Server-version available!", $player->login); return; } $this->maniaControl->chat->sendSuccess('Update for Version ' . $updateData->version . ' available!', $player->login); }); } else { // Special nightly channel updating $this->checkCoreUpdateAsync(function (UpdateData $updateData) use (&$player) { if (!$updateData) { $this->maniaControl->chat->sendInformation('No Update available!', $player->login); return; } $version = $this->maniaControl->client->getVersion(); if($updateData->minDedicatedBuild > $version->build){ $this->maniaControl->chat->sendError("No new Build for this Server-version available!", $player->login); return; } $buildTime = strtotime($this->currentBuildDate); $releaseTime = strtotime($updateData->releaseDate); if ($buildTime != '') { if ($buildTime >= $releaseTime) { $this->maniaControl->chat->sendInformation('No new Build available, current build: ' . date("Y-m-d", $buildTime) . '!', $player->login); return; } $this->maniaControl->chat->sendSuccess('New Nightly Build (' . $updateData->releaseDate . ') available, current build: ' . $this->currentBuildDate . '!', $player->login); } else { $this->maniaControl->chat->sendSuccess('New Nightly Build (' . $updateData->releaseDate . ') available!', $player->login); } }, 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() { return $this->currentBuildDate; } /** * Set the Build Date of the local Nightly Build Version * * @param $date * @return mixed */ private function setNightlyBuildDate($date) { $nightlyBuildDateFile = ManiaControlDir . '/core/nightly_build.txt'; $success = file_put_contents($nightlyBuildDateFile, $date); $this->currentBuildDate = $date; return $success; } /** * Handle //coreupdate command * * @param array $chatCallback * @param Player $player */ public function handle_CoreUpdate(array $chatCallback, Player $player) { if (!$this->maniaControl->authenticationManager->checkPermission($player, self::SETTING_PERMISSION_UPDATE)) { $this->maniaControl->authenticationManager->sendNotAllowed($player); return; } $this->checkCoreUpdateAsync(function (UpdateData $updateData) use (&$player) { if (!$updateData) { $this->maniaControl->chat->sendError('Update is currently not possible!', $player->login); return; } $version = $this->maniaControl->client->getVersion(); if($updateData->minDedicatedBuild > $version->build){ $this->maniaControl->chat->sendError("ManiaControl update version requires a newer Dedicated Server version!", $player->login); return; } $this->maniaControl->chat->sendInformation("Starting Update to Version v{$updateData->version}...", $player->login); $this->maniaControl->log("Starting Update to Version v{$updateData->version}..."); $performBackup = $this->maniaControl->settingManager->getSetting($this, self::SETTING_PERFORM_BACKUPS); if ($performBackup && !$this->performBackup()) { $this->maniaControl->chat->sendError('Creating backup failed.', $player->login); $this->maniaControl->log("Creating backup failed."); } $this->performCoreUpdate($updateData, $player); }, true); } /** * Checks if there are outdated plugins active. */ public function checkPluginsUpdate() { $this->maniaControl->log('[UPDATE] Checking plugins for newer versions ...'); $outdatedPlugins = array(); foreach($this->maniaControl->pluginManager->getPluginClasses() as $pluginClass) { $pluginData = $this->checkPluginUpdate($pluginClass); if($pluginData != false) { $outdatedPlugins[] = $pluginData; $this->maniaControl->log('[UPDATE] '.$pluginClass.': There is a newer version available: '.$pluginData->currentVersion->version.'!'); } } if(count($outdatedPlugins) > 0) { $this->maniaControl->log('[UPDATE] Checking plugins: COMPLETE, there are '.count($outdatedPlugins).' outdated plugins, now updating ...'); $this->performPluginsBackup(); foreach($outdatedPlugins as $plugin) { $this->updatePlugin($plugin); } } else { $this->maniaControl->log('[UPDATE] Checking plugins: COMPLETE, all plugins are up-to-date!'); } } /** * Check given Plugin Class for Update * * @param string $pluginClass * @return mixed */ public function checkPluginUpdate($pluginClass) { if (is_object($pluginClass)) { $pluginClass = get_class($pluginClass); } /** @var Plugin $pluginClass */ $pluginId = $pluginClass::getId(); $url = ManiaControl::URL_WEBSERVICE . 'plugins?id=' . $pluginId; $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; } private function updatePlugin($pluginData) { $this->maniaControl->fileReader->loadFile($pluginData->currentVersion->url, function ($updateFileContent, $error) use (&$updateData, &$player, &$pluginData) { $this->maniaControl->log('[UPDATE] Now updating '.$pluginData->name.' ...'); $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) { $this->maniaControl->chat->sendError('Update failed: Couldn\'t save plugin zip!', $player->login); } return false; } $zip = new \ZipArchive(); $result = $zip->open($updateFileName); if ($result !== true) { trigger_error("Couldn't open plugin Zip. ({$result})"); if ($player) { $this->maniaControl->chat->sendError('Update failed: Couldn\'t open plugin zip!', $player->login); } return false; } $zip->extractTo(ManiaControlDir.'/plugins'); $zip->close(); unlink($updateFileName); @rmdir($tempDir); $this->maniaControl->log('[UPDATE] Successfully updated '.$pluginData->name.'!'); }); } /** * 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) { $updateChannel = $this->getCurrentUpdateChannelSetting(); $url = ManiaControl::URL_WEBSERVICE . 'versions?update=1¤t=1&channel=' . $updateChannel; $this->maniaControl->fileReader->loadFile($url, function ($dataJson, $error) use (&$function, $ignoreVersion) { $versions = json_decode($dataJson); if (!$versions || !isset($versions[0])) { return; } $updateData = new UpdateData($versions[0]); if (!$ignoreVersion && $updateData->version <= ManiaControl::VERSION) { return; } 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 * @return bool */ private function performCoreUpdate(UpdateData $updateData, Player $player = null) { if (!$this->checkPermissions()) { if ($player) { $this->maniaControl->chat->sendError('Update failed: Incorrect file system permissions!', $player->login); } $this->maniaControl->log('Update failed!'); return false; } if (!isset($updateData->url) && !isset($updateData->releaseDate)) { if ($player) { $this->maniaControl->chat->sendError('Update failed: No update Data available!', $player->login); } $this->maniaControl->log('Update failed: No update Data available!'); return false; } $this->maniaControl->fileReader->loadFile($updateData->url, function ($updateFileContent, $error) use (&$updateData, &$player) { $tempDir = ManiaControlDir . '/temp/'; if (!is_dir($tempDir)) { mkdir($tempDir); } $updateFileName = $tempDir . basename($updateData->url); $bytes = file_put_contents($updateFileName, $updateFileContent); if (!$bytes || $bytes <= 0) { trigger_error("Couldn't save Update Zip."); if ($player) { $this->maniaControl->chat->sendError('Update failed: Couldn\'t save Update zip!', $player->login); } return false; } $zip = new \ZipArchive(); $result = $zip->open($updateFileName); if ($result !== true) { trigger_error("Couldn't open Update Zip. ({$result})"); if ($player) { $this->maniaControl->chat->sendError('Update failed: Couldn\'t open Update zip!', $player->login); } return false; } $zip->extractTo(ManiaControlDir); $zip->close(); unlink($updateFileName); @rmdir($tempDir); //Set the Nightly Build Date $this->setNightlyBuildDate($updateData->releaseDate); if ($player) { $this->maniaControl->chat->sendSuccess('Update finished!', $player->login); } $this->maniaControl->log("Update finished!"); $this->maniaControl->restart(); return true; }); return true; } /** * Function checks if ManiaControl has sufficient access to files to update them. * * @return bool */ 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; } } } } return true; } /** * Retrieve the Update Channel Setting * * @return string */ private function getCurrentUpdateChannelSetting() { $updateChannel = $this->maniaControl->settingManager->getSetting($this, self::SETTING_UPDATECHECK_CHANNEL); $updateChannel = strtolower($updateChannel); if (!in_array($updateChannel, array(self::CHANNEL_RELEASE, self::CHANNEL_BETA, self::CHANNEL_NIGHTLY))) { $updateChannel = self::CHANNEL_RELEASE; } return $updateChannel; } }