beu/TrackManiaControl
1
0
Fork 0
Code Issues 7 Pull Requests Releases Wiki Activity

autoupdate setting

Browse Source
This commit is contained in:
kremsy
2014-01-20 21:54:58 +01:00
committed by Steffen Schröder
parent a17037c3cb
commit 64946bf3a1
1 changed files with 122 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

184
application/core/UpdateManager.php
View File

@@ -18,14 +18,14 @@ class UpdateManager implements CallbackListener, CommandListener {
/* /*
* Constants * Constants
*/ */
const SETTING_ENABLEUPDATECHECK = 'Enable Automatic Core Update Check'; const SETTING_ENABLEUPDATECHECK = 'Enable Automatic Core Update Check';
const SETTING_UPDATECHECK_INTERVAL = 'Core Update Check Interval (Hours)'; const SETTING_UPDATECHECK_INTERVAL = 'Core Update Check Interval (Hours)';
const SETTING_UPDATECHECK_CHANNEL = 'Core Update Channel (release, beta, nightly)'; const SETTING_UPDATECHECK_CHANNEL = 'Core Update Channel (release, beta, nightly)';
const SETTING_PERFORM_BACKUPS = 'Perform Backup before Updating'; const SETTING_PERFORM_BACKUPS = 'Perform Backup before Updating';
const URL_WEBSERVICE = 'http://ws.maniacontrol.com/'; const URL_WEBSERVICE = 'http://ws.maniacontrol.com/';
const CHANNEL_RELEASE = 'release'; const CHANNEL_RELEASE = 'release';
const CHANNEL_BETA = 'beta'; const CHANNEL_BETA = 'beta';
const CHANNEL_NIGHTLY = 'nightly'; const CHANNEL_NIGHTLY = 'nightly';
/* /*
* Private Properties * Private Properties
@@ -51,6 +51,7 @@ class UpdateManager implements CallbackListener, CommandListener {
// Register for callbacks // Register for callbacks
$this->maniaControl->callbackManager->registerCallbackListener(CallbackManager::CB_MC_1_MINUTE, $this, 'handle1Minute'); $this->maniaControl->callbackManager->registerCallbackListener(CallbackManager::CB_MC_1_MINUTE, $this, 'handle1Minute');
$this->maniaControl->callbackManager->registerCallbackListener(PlayerManager::CB_PLAYERJOINED, $this, 'handlePlayerJoined'); $this->maniaControl->callbackManager->registerCallbackListener(PlayerManager::CB_PLAYERJOINED, $this, 'handlePlayerJoined');
$this->maniaControl->callbackManager->registerCallbackListener(PlayerManager::CB_PLAYERDISCONNECTED, $this, 'handlePlayerDisconnected');
// Register for chat commands // Register for chat commands
$this->maniaControl->commandManager->registerCommandListener('checkupdate', $this, 'handle_CheckUpdate', true); $this->maniaControl->commandManager->registerCommandListener('checkupdate', $this, 'handle_CheckUpdate', true);
@@ -64,17 +65,23 @@ class UpdateManager implements CallbackListener, CommandListener {
*/ */
public function handle1Minute(array $callback) { public function handle1Minute(array $callback) {
$updateCheckEnabled = $this->maniaControl->settingManager->getSetting($this, self::SETTING_ENABLEUPDATECHECK); $updateCheckEnabled = $this->maniaControl->settingManager->getSetting($this, self::SETTING_ENABLEUPDATECHECK);
if (!$updateCheckEnabled) { if(!$updateCheckEnabled) {
// Automatic update check disabled // Automatic update check disabled
if ($this->coreUpdateData) $this->coreUpdateData = null; if($this->coreUpdateData) {
$this->coreUpdateData = null;
}
return; return;
} }
// Only check once per hour // Only check once per hour
$updateInterval = $this->maniaControl->settingManager->getSetting($this, self::SETTING_UPDATECHECK_INTERVAL); $updateInterval = $this->maniaControl->settingManager->getSetting($this, self::SETTING_UPDATECHECK_INTERVAL);
if ($this->lastUpdateCheck > time() - $updateInterval * 3600.) return; if($this->lastUpdateCheck > time() - $updateInterval * 3600.) {
return;
}
$this->lastUpdateCheck = time(); $this->lastUpdateCheck = time();
$updateData = $this->checkCoreUpdate(); $updateData = $this->checkCoreUpdate();
if (!$updateData) return; if(!$updateData) {
return;
}
$this->maniaControl->log('New ManiaControl Version ' . $updateData->version . ' available!'); $this->maniaControl->log('New ManiaControl Version ' . $updateData->version . ' available!');
$this->coreUpdateData = $updateData; $this->coreUpdateData = $updateData;
} }
@@ -85,42 +92,75 @@ class UpdateManager implements CallbackListener, CommandListener {
* @param array $callback * @param array $callback
*/ */
public function handlePlayerJoined(array $callback) { public function handlePlayerJoined(array $callback) {
if (!$this->coreUpdateData) return; if(!$this->coreUpdateData) {
return;
}
// Announce available update // Announce available update
$player = $callback[1]; $player = $callback[1];
if (!AuthenticationManager::checkRight($player, AuthenticationManager::AUTH_LEVEL_SUPERADMIN)) return; if(!AuthenticationManager::checkRight($player, AuthenticationManager::AUTH_LEVEL_SUPERADMIN)) {
return;
}
$this->maniaControl->chat->sendInformation('New ManiaControl Version ' . $this->coreUpdateData->version . ' available!', $player->login); $this->maniaControl->chat->sendInformation('New ManiaControl Version ' . $this->coreUpdateData->version . ' available!', $player->login);
} }
/**
* Perform automatic update as soon as a the Server is empty
*
* @param array $callback
*/
public function handlePlayerDisconnected(array $callback) {
//TODO Setting for autoupdate
if(count($this->maniaControl->playerManager->getPlayers()) > 0) {
return;
}
$updateData = $this->checkCoreUpdate(true);
if(!$updateData) {
return;
}
$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->log("Creating Backup failed!");
}
if(!$this->performCoreUpdate($updateData)) {
$this->maniaControl->log("Update failed!");
return;
}
$this->maniaControl->log("Update finished!");
$this->maniaControl->restart();
}
/** /**
* Handle //checkupdate command * Handle //checkupdate command
* *
* @param array $chatCallback * @param array $chatCallback
* @param Player $player * @param Player $player
*/ */
public function handle_CheckUpdate(array $chatCallback, Player $player) { public function handle_CheckUpdate(array $chatCallback, Player $player) {
if (!AuthenticationManager::checkRight($player, AuthenticationManager::AUTH_LEVEL_SUPERADMIN)) { if(!AuthenticationManager::checkRight($player, AuthenticationManager::AUTH_LEVEL_SUPERADMIN)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player); $this->maniaControl->authenticationManager->sendNotAllowed($player);
return; return;
} }
$updateChannel = $this->maniaControl->settingManager->getSetting($this, self::SETTING_UPDATECHECK_CHANNEL); $updateChannel = $this->maniaControl->settingManager->getSetting($this, self::SETTING_UPDATECHECK_CHANNEL);
if ($updateChannel != self::CHANNEL_NIGHTLY) { if($updateChannel != self::CHANNEL_NIGHTLY) {
// Check update and send result message // Check update and send result message
$updateData = $this->checkCoreUpdate(); $updateData = $this->checkCoreUpdate();
if (!$updateData) { if(!$updateData) {
$this->maniaControl->chat->sendInformation('No Update available!', $player->login); $this->maniaControl->chat->sendInformation('No Update available!', $player->login);
return; return;
} }
$this->maniaControl->chat->sendSuccess('Update for Version ' . $updateData->version . ' available!', $player->login); $this->maniaControl->chat->sendSuccess('Update for Version ' . $updateData->version . ' available!', $player->login);
} } else {
else {
// Special nightly channel updating // Special nightly channel updating
$updateData = $this->checkCoreUpdate(true); $updateData = $this->checkCoreUpdate(true);
$buildDate = $this->getNightlyBuildDate(); $buildDate = $this->getNightlyBuildDate();
if ($buildDate) { if($buildDate) {
$buildTime = strtotime($buildDate); $buildTime = strtotime($buildDate);
$releaseTime = strtotime($updateData->release_date); $releaseTime = strtotime($updateData->release_date);
if ($buildTime >= $releaseTime) { if($buildTime >= $releaseTime) {
$this->maniaControl->chat->sendInformation('No new Build available!', $player->login); $this->maniaControl->chat->sendInformation('No new Build available!', $player->login);
return; return;
} }
@@ -136,7 +176,9 @@ class UpdateManager implements CallbackListener, CommandListener {
*/ */
private function getNightlyBuildDate() { private function getNightlyBuildDate() {
$nightlyBuildDateFile = ManiaControlDir . '/core/nightly_build.txt'; $nightlyBuildDateFile = ManiaControlDir . '/core/nightly_build.txt';
if (!file_exists($nightlyBuildDateFile)) return false; if(!file_exists($nightlyBuildDateFile)) {
return false;
}
$fileContent = file_get_contents($nightlyBuildDateFile); $fileContent = file_get_contents($nightlyBuildDateFile);
return $fileContent; return $fileContent;
} }
@@ -144,29 +186,33 @@ class UpdateManager implements CallbackListener, CommandListener {
/** /**
* Handle //coreupdate command * Handle //coreupdate command
* *
* @param array $chatCallback * @param array $chatCallback
* @param Player $player * @param Player $player
*/ */
public function handle_CoreUpdate(array $chatCallback, Player $player) { public function handle_CoreUpdate(array $chatCallback, Player $player) {
if (!AuthenticationManager::checkRight($player, AuthenticationManager::AUTH_LEVEL_MASTERADMIN)) { if(!AuthenticationManager::checkRight($player, AuthenticationManager::AUTH_LEVEL_ADMIN)) { //TODO, define permission setting
$this->maniaControl->authenticationManager->sendNotAllowed($player); $this->maniaControl->authenticationManager->sendNotAllowed($player);
return; return;
} }
$updateData = $this->checkCoreUpdate(true); $updateData = $this->checkCoreUpdate(true);
if (!$updateData) { if(!$updateData) {
$this->maniaControl->chat->sendError('Update is currently not possible!', $player->login); $this->maniaControl->chat->sendError('Update is currently not possible!', $player->login);
return; return;
} }
$this->maniaControl->chat->sendInformation("Starting Update to Version v{$updateData->version}...", $player->login); $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); $performBackup = $this->maniaControl->settingManager->getSetting($this, self::SETTING_PERFORM_BACKUPS);
if ($performBackup && !$this->performBackup()) { if($performBackup && !$this->performBackup()) {
$this->maniaControl->chat->sendError('Creating backup failed.', $player->login); $this->maniaControl->chat->sendError('Creating backup failed.', $player->login);
$this->maniaControl->log("Creating backup failed.");
} }
if (!$this->performCoreUpdate($updateData)) { if(!$this->performCoreUpdate($updateData)) {
$this->maniaControl->chat->sendError('Update failed!', $player->login); $this->maniaControl->chat->sendError('Update failed!', $player->login);
return; return;
} }
$this->maniaControl->chat->sendSuccess('Update finished!', $player->login); $this->maniaControl->chat->sendSuccess('Update finished!', $player->login);
$this->maniaControl->restart();
} }
/** /**
@@ -176,19 +222,19 @@ class UpdateManager implements CallbackListener, CommandListener {
* @return mixed * @return mixed
*/ */
public function checkPluginUpdate($pluginClass) { public function checkPluginUpdate($pluginClass) {
if (is_object($pluginClass)) { if(is_object($pluginClass)) {
$pluginClass = get_class($pluginClass); $pluginClass = get_class($pluginClass);
} }
$pluginId = $pluginClass::getId(); $pluginId = $pluginClass::getId();
$url = self::URL_WEBSERVICE . 'plugins?id=' . $pluginId; $url = self::URL_WEBSERVICE . 'plugins?id=' . $pluginId;
$dataJson = file_get_contents($url); $dataJson = file_get_contents($url);
$pluginVersions = json_decode($dataJson); $pluginVersions = json_decode($dataJson);
if (!$pluginVersions || !isset($pluginVersions[0])) { if(!$pluginVersions || !isset($pluginVersions[0])) {
return false; return false;
} }
$pluginData = $pluginVersions[0]; $pluginData = $pluginVersions[0];
$pluginVersion = $pluginClass::getVersion(); $pluginVersion = $pluginClass::getVersion();
if ($pluginData->version <= $pluginVersion) { if($pluginData->version <= $pluginVersion) {
return false; return false;
} }
return $pluginData; return $pluginData;
@@ -201,14 +247,14 @@ class UpdateManager implements CallbackListener, CommandListener {
*/ */
private function checkCoreUpdate($ignoreVersion = false) { private function checkCoreUpdate($ignoreVersion = false) {
$updateChannel = $this->getCurrentUpdateChannelSetting(); $updateChannel = $this->getCurrentUpdateChannelSetting();
$url = self::URL_WEBSERVICE . 'versions?update=1&current=1&channel=' . $updateChannel; $url = self::URL_WEBSERVICE . 'versions?update=1&current=1&channel=' . $updateChannel;
$dataJson = file_get_contents($url); $dataJson = file_get_contents($url);
$versions = json_decode($dataJson); $versions = json_decode($dataJson);
if (!$versions || !isset($versions[0])) { if(!$versions || !isset($versions[0])) {
return false; return false;
} }
$updateData = $versions[0]; $updateData = $versions[0];
if (!$ignoreVersion && $updateData->version <= ManiaControl::VERSION) { if(!$ignoreVersion && $updateData->version <= ManiaControl::VERSION) {
return false; return false;
} }
return $updateData; return $updateData;
@@ -221,17 +267,19 @@ class UpdateManager implements CallbackListener, CommandListener {
*/ */
private function performBackup() { private function performBackup() {
$backupFolder = ManiaControlDir . '/backup/'; $backupFolder = ManiaControlDir . '/backup/';
if (!is_dir($backupFolder)) mkdir($backupFolder); if(!is_dir($backupFolder)) {
mkdir($backupFolder);
}
$backupFileName = $backupFolder . 'backup_' . ManiaControl::VERSION . '_' . date('y-m-d') . '_' . time() . '.zip'; $backupFileName = $backupFolder . 'backup_' . ManiaControl::VERSION . '_' . date('y-m-d') . '_' . time() . '.zip';
$backupZip = new \ZipArchive(); $backupZip = new \ZipArchive();
if ($backupZip->open($backupFileName, \ZipArchive::CREATE) !== TRUE) { if($backupZip->open($backupFileName, \ZipArchive::CREATE) !== TRUE) {
trigger_error("Couldn't create Backup Zip!"); trigger_error("Couldn't create Backup Zip!");
return false; return false;
} }
$excludes = array('.', '..', 'backup', 'logs', 'ManiaControl.log'); $excludes = array('.', '..', 'backup', 'logs', 'ManiaControl.log');
$pathInfo = pathInfo(ManiaControlDir); $pathInfo = pathInfo(ManiaControlDir);
$parentPath = $pathInfo['dirname'] . '/'; $parentPath = $pathInfo['dirname'] . '/';
$dirName = $pathInfo['basename']; $dirName = $pathInfo['basename'];
$backupZip->addEmptyDir($dirName); $backupZip->addEmptyDir($dirName);
$this->zipDirectory($backupZip, ManiaControlDir, strlen($parentPath), $excludes); $this->zipDirectory($backupZip, ManiaControlDir, strlen($parentPath), $excludes);
$backupZip->close(); $backupZip->close();
@@ -242,26 +290,28 @@ class UpdateManager implements CallbackListener, CommandListener {
* Add a complete Directory to the ZipArchive * Add a complete Directory to the ZipArchive
* *
* @param \ZipArchive $zipArchive * @param \ZipArchive $zipArchive
* @param string $folderName * @param string $folderName
* @param int $prefixLength * @param int $prefixLength
* @param array $excludes * @param array $excludes
* @return bool * @return bool
*/ */
private function zipDirectory(\ZipArchive &$zipArchive, $folderName, $prefixLength, array $excludes = array()) { private function zipDirectory(\ZipArchive &$zipArchive, $folderName, $prefixLength, array $excludes = array()) {
$folderHandle = opendir($folderName); $folderHandle = opendir($folderName);
if (!$folderHandle) { if(!$folderHandle) {
trigger_error("Couldn't open Folder '{$folderName}' for Backup!"); trigger_error("Couldn't open Folder '{$folderName}' for Backup!");
return false; return false;
} }
while (false !== ($file = readdir($folderHandle))) { while(false !== ($file = readdir($folderHandle))) {
if (in_array($file, $excludes)) continue; if(in_array($file, $excludes)) {
$filePath = $folderName . '/' . $file; continue;
}
$filePath = $folderName . '/' . $file;
$localPath = substr($filePath, $prefixLength); $localPath = substr($filePath, $prefixLength);
if (is_file($filePath)) { if(is_file($filePath)) {
$zipArchive->addFile($filePath, $localPath); $zipArchive->addFile($filePath, $localPath);
continue; continue;
} }
if (is_dir($filePath)) { if(is_dir($filePath)) {
$zipArchive->addEmptyDir($localPath); $zipArchive->addEmptyDir($localPath);
$this->zipDirectory($zipArchive, $filePath, $prefixLength, $excludes); $this->zipDirectory($zipArchive, $filePath, $prefixLength, $excludes);
continue; continue;
@@ -278,24 +328,26 @@ class UpdateManager implements CallbackListener, CommandListener {
* @return bool * @return bool
*/ */
private function performCoreUpdate($updateData = null) { private function performCoreUpdate($updateData = null) {
if (!$updateData) { if(!$updateData) {
$updateData = $this->checkCoreUpdate(); $updateData = $this->checkCoreUpdate();
if (!$updateData) { if(!$updateData) {
return false; return false;
} }
} }
$updateFileContent = file_get_contents($updateData->url); $updateFileContent = file_get_contents($updateData->url);
$tempDir = ManiaControlDir . '/temp/'; $tempDir = ManiaControlDir . '/temp/';
if (!is_dir($tempDir)) mkdir($tempDir); if(!is_dir($tempDir)) {
mkdir($tempDir);
}
$updateFileName = $tempDir . basename($updateData->url); $updateFileName = $tempDir . basename($updateData->url);
$bytes = file_put_contents($updateFileName, $updateFileContent); $bytes = file_put_contents($updateFileName, $updateFileContent);
if (!$bytes || $bytes <= 0) { if(!$bytes || $bytes <= 0) {
trigger_error("Couldn't save Update Zip."); trigger_error("Couldn't save Update Zip.");
return false; return false;
} }
$zip = new \ZipArchive(); $zip = new \ZipArchive();
$result = $zip->open($updateFileName); $result = $zip->open($updateFileName);
if ($result !== true) { if($result !== true) {
trigger_error("Couldn't open Update Zip. ({$result})"); trigger_error("Couldn't open Update Zip. ({$result})");
return false; return false;
} }
@@ -314,7 +366,7 @@ class UpdateManager implements CallbackListener, CommandListener {
private function getCurrentUpdateChannelSetting() { private function getCurrentUpdateChannelSetting() {
$updateChannel = $this->maniaControl->settingManager->getSetting($this, self::SETTING_UPDATECHECK_CHANNEL); $updateChannel = $this->maniaControl->settingManager->getSetting($this, self::SETTING_UPDATECHECK_CHANNEL);
$updateChannel = strtolower($updateChannel); $updateChannel = strtolower($updateChannel);
if (!in_array($updateChannel, array(self::CHANNEL_RELEASE, self::CHANNEL_BETA, self::CHANNEL_NIGHTLY))) { if(!in_array($updateChannel, array(self::CHANNEL_RELEASE, self::CHANNEL_BETA, self::CHANNEL_NIGHTLY))) {
$updateChannel = self::CHANNEL_RELEASE; $updateChannel = self::CHANNEL_RELEASE;
} }
return $updateChannel; return $updateChannel;