500 lines
15 KiB
PHP
500 lines
15 KiB
PHP
<?php
|
|
|
|
namespace ManiaControl\Update;
|
|
|
|
use ManiaControl\Admin\AuthenticationManager;
|
|
use ManiaControl\Callbacks\CallbackListener;
|
|
use ManiaControl\Callbacks\TimerListener;
|
|
use ManiaControl\Commands\CommandListener;
|
|
use ManiaControl\Files\BackupUtil;
|
|
use ManiaControl\Files\FileUtil;
|
|
use ManiaControl\ManiaControl;
|
|
use ManiaControl\Players\Player;
|
|
use ManiaControl\Players\PlayerManager;
|
|
|
|
/**
|
|
* Manager checking for ManiaControl Core Updates
|
|
*
|
|
* @author ManiaControl Team <mail@maniacontrol.com>
|
|
* @copyright 2014 ManiaControl Team
|
|
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
|
|
*/
|
|
class UpdateManager implements CallbackListener, CommandListener, TimerListener {
|
|
/*
|
|
* Constants
|
|
*/
|
|
const SETTING_ENABLE_UPDATECHECK = 'Enable Automatic Core Update Check';
|
|
const SETTING_UPDATECHECK_INTERVAL = 'Core Update Check Interval (Hours)';
|
|
const SETTING_UPDATECHECK_CHANNEL = 'Core Update Channel (release, beta, nightly)';
|
|
const SETTING_PERFORM_BACKUPS = 'Perform Backup before Updating';
|
|
const SETTING_AUTO_UPDATE = 'Perform update automatically';
|
|
const SETTING_PERMISSION_UPDATE = 'Update Core';
|
|
const SETTING_PERMISSION_UPDATECHECK = 'Check Core Update';
|
|
const CHANNEL_RELEASE = 'release';
|
|
const CHANNEL_BETA = 'beta';
|
|
const CHANNEL_NIGHTLY = 'nightly';
|
|
|
|
/*
|
|
* Public properties
|
|
*/
|
|
/** @var PluginUpdateManager $pluginUpdateManager */
|
|
/** @deprecated see getPluginUpdateManager() */
|
|
public $pluginUpdateManager = null;
|
|
|
|
/*
|
|
* Private properties
|
|
*/
|
|
/** @var ManiaControl $maniaControl */
|
|
private $maniaControl = null;
|
|
private $currentBuildDate = null;
|
|
/** @var UpdateData $coreUpdateData */
|
|
private $coreUpdateData = null;
|
|
|
|
/**
|
|
* Construct a new update manager instance
|
|
*
|
|
* @param ManiaControl $maniaControl
|
|
*/
|
|
public function __construct(ManiaControl $maniaControl) {
|
|
$this->maniaControl = $maniaControl;
|
|
|
|
// Settings
|
|
$this->maniaControl->getSettingManager()->initSetting($this, self::SETTING_ENABLE_UPDATECHECK, true);
|
|
$this->maniaControl->getSettingManager()->initSetting($this, self::SETTING_AUTO_UPDATE, true);
|
|
$this->maniaControl->getSettingManager()->initSetting($this, self::SETTING_UPDATECHECK_INTERVAL, 1);
|
|
$this->maniaControl->getSettingManager()->initSetting($this, self::SETTING_UPDATECHECK_CHANNEL, $this->getUpdateChannels());
|
|
$this->maniaControl->getSettingManager()->initSetting($this, self::SETTING_PERFORM_BACKUPS, true);
|
|
|
|
// Callbacks
|
|
$updateInterval = $this->maniaControl->getSettingManager()->getSettingValue($this, self::SETTING_UPDATECHECK_INTERVAL);
|
|
$this->maniaControl->getTimerManager()->registerTimerListening($this, 'hourlyUpdateCheck', 1000 * 60 * 60 * $updateInterval);
|
|
$this->maniaControl->getCallbackManager()->registerCallbackListener(PlayerManager::CB_PLAYERCONNECT, $this, 'handlePlayerJoined');
|
|
$this->maniaControl->getCallbackManager()->registerCallbackListener(PlayerManager::CB_PLAYERDISCONNECT, $this, 'handlePlayerDisconnect');
|
|
|
|
// Permissions
|
|
$this->maniaControl->getAuthenticationManager()->definePermissionLevel(self::SETTING_PERMISSION_UPDATE, AuthenticationManager::AUTH_LEVEL_ADMIN);
|
|
$this->maniaControl->getAuthenticationManager()->definePermissionLevel(self::SETTING_PERMISSION_UPDATECHECK, AuthenticationManager::AUTH_LEVEL_MODERATOR);
|
|
|
|
// Chat commands
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('checkupdate', $this, 'handle_CheckUpdate', true, 'Checks if there is a core update.');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('coreupdate', $this, 'handle_CoreUpdate', true, 'Performs the core update.');
|
|
|
|
// Children
|
|
$this->pluginUpdateManager = new PluginUpdateManager($maniaControl);
|
|
}
|
|
|
|
/**
|
|
* Get the possible update channels
|
|
*
|
|
* @return string[]
|
|
*/
|
|
public function getUpdateChannels() {
|
|
// TODO: change default channel on release
|
|
return array(self::CHANNEL_BETA, self::CHANNEL_RELEASE, self::CHANNEL_NIGHTLY);
|
|
}
|
|
|
|
/**
|
|
* Return the plugin update manager
|
|
*
|
|
* @return PluginUpdateManager
|
|
*/
|
|
public function getPluginUpdateManager() {
|
|
return $this->pluginUpdateManager;
|
|
}
|
|
|
|
/**
|
|
* Perform Hourly Update Check
|
|
*/
|
|
public function hourlyUpdateCheck() {
|
|
$updateCheckEnabled = $this->maniaControl->getSettingManager()->getSettingValue($this, self::SETTING_ENABLE_UPDATECHECK);
|
|
if (!$updateCheckEnabled) {
|
|
$this->setCoreUpdateData();
|
|
} else {
|
|
$this->checkUpdate();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set Core Update Data
|
|
*
|
|
* @param UpdateData $coreUpdateData
|
|
*/
|
|
public function setCoreUpdateData(UpdateData $coreUpdateData = null) {
|
|
$this->coreUpdateData = $coreUpdateData;
|
|
}
|
|
|
|
/**
|
|
* Start an Update Check
|
|
*/
|
|
public function checkUpdate() {
|
|
$this->checkCoreUpdateAsync(array($this, 'handleUpdateCheck'));
|
|
}
|
|
|
|
/**
|
|
* Checks a Core Update asynchronously
|
|
*
|
|
* @param callable $function
|
|
*/
|
|
public function checkCoreUpdateAsync($function) {
|
|
$updateChannel = $this->getCurrentUpdateChannelSetting();
|
|
$url = ManiaControl::URL_WEBSERVICE . 'versions?current=1&channel=' . $updateChannel;
|
|
|
|
$this->maniaControl->getFileReader()->loadFile($url, function ($dataJson, $error) use (&$function) {
|
|
if ($error) {
|
|
$this->maniaControl->log('Error on UpdateCheck: ' . $error);
|
|
return;
|
|
}
|
|
$versions = json_decode($dataJson);
|
|
if (!$versions || !isset($versions[0])) {
|
|
call_user_func($function);
|
|
} else {
|
|
$updateData = new UpdateData($versions[0]);
|
|
call_user_func($function, $updateData);
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Retrieve the Update Channel Setting
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getCurrentUpdateChannelSetting() {
|
|
$updateChannel = $this->maniaControl->getSettingManager()->getSettingValue($this, self::SETTING_UPDATECHECK_CHANNEL);
|
|
$updateChannel = strtolower($updateChannel);
|
|
if (!in_array($updateChannel, $this->getUpdateChannels())) {
|
|
$updateChannel = self::CHANNEL_RELEASE;
|
|
}
|
|
return $updateChannel;
|
|
}
|
|
|
|
/**
|
|
* Handle the fetched Update Data of the hourly Check
|
|
*
|
|
* @param UpdateData $updateData
|
|
*/
|
|
public function handleUpdateCheck(UpdateData $updateData = null) {
|
|
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;
|
|
}
|
|
|
|
if ($this->coreUpdateData != $updateData) {
|
|
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 ManiaControl is running the Nightly Update Channel
|
|
*
|
|
* @param string $updateChannel
|
|
* @return bool
|
|
*/
|
|
public function isNightlyUpdateChannel($updateChannel = null) {
|
|
if (!$updateChannel) {
|
|
$updateChannel = $this->getCurrentUpdateChannelSetting();
|
|
}
|
|
return ($updateChannel === self::CHANNEL_NIGHTLY);
|
|
}
|
|
|
|
/**
|
|
* Get the Build Date of the local Nightly Build Version
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getNightlyBuildDate() {
|
|
if (!$this->currentBuildDate) {
|
|
$nightlyBuildDateFile = ManiaControlDir . 'core' . DIRECTORY_SEPARATOR . 'nightly_build.txt';
|
|
if (file_exists($nightlyBuildDateFile)) {
|
|
$this->currentBuildDate = file_get_contents($nightlyBuildDateFile);
|
|
}
|
|
}
|
|
return $this->currentBuildDate;
|
|
}
|
|
|
|
/**
|
|
* 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->getClient()->getVersion();
|
|
if ($updateData->minDedicatedBuild > $version->build) {
|
|
// Server not compatible
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Check if an automatic Update should be performed
|
|
*/
|
|
public function checkAutoUpdate() {
|
|
$autoUpdate = $this->maniaControl->getSettingManager()->getSettingValue($this, self::SETTING_AUTO_UPDATE);
|
|
if (!$autoUpdate) {
|
|
// Auto update turned off
|
|
return;
|
|
}
|
|
if (!$this->coreUpdateData) {
|
|
// No update available
|
|
return;
|
|
}
|
|
if ($this->maniaControl->getPlayerManager()->getPlayerCount(false) > 0) {
|
|
// Server not empty
|
|
return;
|
|
}
|
|
|
|
$this->performCoreUpdate();
|
|
}
|
|
|
|
/**
|
|
* Perform a Core Update
|
|
*
|
|
* @param Player $player
|
|
* @return bool
|
|
*/
|
|
public function performCoreUpdate(Player $player = null) {
|
|
if (!$this->coreUpdateData) {
|
|
$message = 'Update failed: No update Data available!';
|
|
if ($player) {
|
|
$this->maniaControl->getChat()->sendError($message, $player);
|
|
}
|
|
$this->maniaControl->log($message);
|
|
return false;
|
|
}
|
|
|
|
$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->getChat()->sendError($message, $player);
|
|
}
|
|
$this->maniaControl->log($message);
|
|
return false;
|
|
}
|
|
|
|
$performBackup = $this->maniaControl->getSettingManager()->getSettingValue($this, self::SETTING_PERFORM_BACKUPS);
|
|
if ($performBackup && !BackupUtil::performFullBackup()) {
|
|
$message = 'Creating Backup before Update failed!';
|
|
if ($player) {
|
|
$this->maniaControl->getChat()->sendError($message, $player);
|
|
}
|
|
$this->maniaControl->log($message);
|
|
}
|
|
|
|
$updateData = $this->coreUpdateData;
|
|
$this->maniaControl->getFileReader()->loadFile($updateData->url, function ($updateFileContent, $error) use (
|
|
$updateData, &$player
|
|
) {
|
|
if (!$updateFileContent || $error) {
|
|
$message = "Update failed: Couldn't load Update zip! {$error}";
|
|
if ($player) {
|
|
$this->maniaControl->getChat()->sendError($message, $player);
|
|
}
|
|
$this->maniaControl->log($message);
|
|
return;
|
|
}
|
|
|
|
$tempDir = FileUtil::getTempFolder();
|
|
$updateFileName = $tempDir . basename($updateData->url);
|
|
|
|
$bytes = file_put_contents($updateFileName, $updateFileContent);
|
|
if (!$bytes || $bytes <= 0) {
|
|
$message = "Update failed: Couldn't save Update zip!";
|
|
if ($player) {
|
|
$this->maniaControl->getChat()->sendError($message, $player);
|
|
}
|
|
$this->maniaControl->log($message);
|
|
return;
|
|
}
|
|
|
|
$zip = new \ZipArchive();
|
|
$result = $zip->open($updateFileName);
|
|
if ($result !== true) {
|
|
$message = "Update failed: Couldn't open Update Zip. ({$result})";
|
|
if ($player) {
|
|
$this->maniaControl->getChat()->sendError($message, $player);
|
|
}
|
|
$this->maniaControl->log($message);
|
|
return;
|
|
}
|
|
|
|
$zip->extractTo(ManiaControlDir);
|
|
$zip->close();
|
|
unlink($updateFileName);
|
|
FileUtil::deleteTempFolder();
|
|
|
|
// Set the Nightly Build Date
|
|
$this->setNightlyBuildDate($updateData->releaseDate);
|
|
|
|
$message = 'Update finished!';
|
|
if ($player) {
|
|
$this->maniaControl->getChat()->sendSuccess($message, $player);
|
|
}
|
|
$this->maniaControl->log($message);
|
|
|
|
$this->maniaControl->restart();
|
|
});
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Set the Build Date of the local Nightly Build Version
|
|
*
|
|
* @param string $date
|
|
* @return bool
|
|
*/
|
|
public function setNightlyBuildDate($date) {
|
|
$nightlyBuildDateFile = ManiaControlDir . 'core' . DIRECTORY_SEPARATOR . 'nightly_build.txt';
|
|
$success = (bool)file_put_contents($nightlyBuildDateFile, $date);
|
|
$this->currentBuildDate = $date;
|
|
return $success;
|
|
}
|
|
|
|
/**
|
|
* Handle ManiaControl PlayerJoined callback
|
|
*
|
|
* @param Player $player
|
|
*/
|
|
public function handlePlayerJoined(Player $player) {
|
|
if (!$this->coreUpdateData) {
|
|
return;
|
|
}
|
|
// Announce available update
|
|
if (!$this->maniaControl->getAuthenticationManager()->checkPermission($player, self::SETTING_PERMISSION_UPDATE)) {
|
|
return;
|
|
}
|
|
|
|
if ($this->isNightlyUpdateChannel()) {
|
|
$this->maniaControl->getChat()->sendSuccess('New Nightly Build (' . $this->coreUpdateData->releaseDate . ') available!', $player->login);
|
|
} else {
|
|
$this->maniaControl->getChat()->sendInformation('New ManiaControl Version ' . $this->coreUpdateData->version . ' available!', $player->login);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Handle Player Disconnect Callback
|
|
*
|
|
* @param Player $player
|
|
*/
|
|
public function handlePlayerDisconnect(Player $player) {
|
|
$this->checkAutoUpdate();
|
|
}
|
|
|
|
/**
|
|
* Handle //checkupdate command
|
|
*
|
|
* @param array $chatCallback
|
|
* @param Player $player
|
|
*/
|
|
public function handle_CheckUpdate(array $chatCallback, Player $player) {
|
|
if (!$this->maniaControl->getAuthenticationManager()->checkPermission($player, self::SETTING_PERMISSION_UPDATECHECK)) {
|
|
$this->maniaControl->getAuthenticationManager()->sendNotAllowed($player);
|
|
return;
|
|
}
|
|
|
|
$this->checkCoreUpdateAsync(function (UpdateData $updateData = null) use (&$player) {
|
|
if (!$this->checkUpdateData($updateData)) {
|
|
$this->maniaControl->getChat()->sendInformation('No Update available!', $player->login);
|
|
return;
|
|
}
|
|
|
|
if (!$this->checkUpdateDataBuildVersion($updateData)) {
|
|
$this->maniaControl->getChat()->sendError("Please update Your Server to '{$updateData->minDedicatedBuild}' in order to receive further Updates!", $player->login);
|
|
return;
|
|
}
|
|
|
|
$isNightly = $this->isNightlyUpdateChannel();
|
|
if ($isNightly) {
|
|
$buildDate = $this->getNightlyBuildDate();
|
|
if ($buildDate) {
|
|
if ($updateData->isNewerThan($buildDate)) {
|
|
$this->maniaControl->getChat()->sendInformation("No new Build available! (Current Build: '{$buildDate}')", $player->login);
|
|
return;
|
|
} else {
|
|
$this->maniaControl->getChat()->sendSuccess("New Nightly Build ({$updateData->releaseDate}) available! (Current Build: '{$buildDate}')", $player->login);
|
|
}
|
|
} else {
|
|
$this->maniaControl->getChat()->sendSuccess("New Nightly Build ('{$updateData->releaseDate}') available!", $player->login);
|
|
}
|
|
} else {
|
|
$this->maniaControl->getChat()->sendSuccess('Update for Version ' . $updateData->version . ' available!', $player->login);
|
|
}
|
|
|
|
$this->coreUpdateData = $updateData;
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Handle //coreupdate command
|
|
*
|
|
* @param array $chatCallback
|
|
* @param Player $player
|
|
*/
|
|
public function handle_CoreUpdate(array $chatCallback, Player $player) {
|
|
if (!$this->maniaControl->getAuthenticationManager()->checkPermission($player, self::SETTING_PERMISSION_UPDATE)) {
|
|
$this->maniaControl->getAuthenticationManager()->sendNotAllowed($player);
|
|
return;
|
|
}
|
|
|
|
$this->checkCoreUpdateAsync(function (UpdateData $updateData = null) use (&$player) {
|
|
if (!$updateData) {
|
|
$this->maniaControl->getChat()->sendError('Update is currently not possible!', $player);
|
|
return;
|
|
}
|
|
if (!$this->checkUpdateDataBuildVersion($updateData)) {
|
|
$this->maniaControl->getChat()->sendError("The Next ManiaControl Update requires a newer Dedicated Server Version!", $player);
|
|
return;
|
|
}
|
|
|
|
$this->coreUpdateData = $updateData;
|
|
|
|
$this->performCoreUpdate($player);
|
|
});
|
|
}
|
|
}
|