add update cli-command; add update-channel setting (stable|testing)

Signed-off-by: Michael Kaufmann <d00p@froxlor.org>
This commit is contained in:
Michael Kaufmann
2022-05-22 20:18:18 +02:00
parent 1de39ac39c
commit e02164049e
9 changed files with 438 additions and 150 deletions

View File

@@ -0,0 +1,176 @@
<?php
/**
* This file is part of the Froxlor project.
* Copyright (c) 2010 the Froxlor Team (see authors).
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you can also view it online at
* https://files.froxlor.org/misc/COPYING.txt
*
* @copyright the authors
* @author Froxlor team <team@froxlor.org>
* @license https://files.froxlor.org/misc/COPYING.txt GPLv2
*/
namespace Froxlor\Cli;
use Exception;
use Froxlor\Froxlor;
use Froxlor\Install\AutoUpdate;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ConfirmationQuestion;
final class UpdateCommand extends CliCommand
{
protected function configure()
{
$this->setName('froxlor:update');
$this->setDescription('Check for newer version and update froxlor');
$this->addOption('check-only', 'c', InputOption::VALUE_NONE, 'Only check for newer version and exit')
->addOption('yes-to-all', 'A', InputOption::VALUE_NONE, 'Do not ask for download, extract and database-update, just do it (if not --check-only is set)')
->addOption('integer-return', 'i', InputOption::VALUE_NONE, 'Return integer whether a new version is available or not (implies --check-only). Useful for programmatic use.');
}
protected function execute(InputInterface $input, OutputInterface $output)
{
$result = self::SUCCESS;
$result = $this->validateRequirements($input, $output);
require Froxlor::getInstallDir() . '/lib/functions.php';
// version check
$newversionavail = false;
if ($result == self::SUCCESS) {
try {
$aucheck = AutoUpdate::checkVersion();
if ($aucheck == 1) {
if ($input->getOption('integer-return')) {
$output->write(1);
return self::SUCCESS;
}
// there is a new version
$text = lng('admin.newerversionavailable') . ' ' . lng('admin.newerversiondetails', [AutoUpdate::getFromResult('version'), Froxlor::VERSION]);
$text = str_replace("<br/>", " ", $text);
$text = str_replace("<b>", "<info>", $text);
$text = str_replace("</b>", "</info>", $text);
$newversionavail = true;
$output->writeln('<comment>' . $text . '</>');
$result = self::SUCCESS;
} else if ($aucheck < 0 || $aucheck > 1) {
if ($input->getOption('integer-return')) {
$output->write(-1);
return self::INVALID;
}
// errors
if ($aucheck < 0) {
$output->writeln('<error>' . AutoUpdate::getLastError() . '</>');
} else {
$errmsg = 'error.autoupdate_' . $aucheck;
if ($aucheck == 3) {
$errmsg = 'error.customized_version';
}
$output->writeln('<error>' . lng($errmsg) . '</>');
}
$result = self::INVALID;
} else {
if ($input->getOption('integer-return')) {
$output->write(0);
return self::SUCCESS;
}
// no new version
$output->writeln('<info>' . lng('update.noupdatesavail') . '</>');
$result = self::SUCCESS;
}
} catch (Exception $e) {
if ($input->getOption('integer-return')) {
$output->write(-1);
return self::FAILURE;
}
$output->writeln('<error>' . $e->getMessage() . '</>');
$result = self::FAILURE;
}
}
// if there's a newer version, proceed
if ($result == self::SUCCESS && $newversionavail) {
// check whether we only wanted to check
if ($input->getOption('check-only')) {
//$output->writeln('<comment>Not proceeding as "check-only" is specified</>');
return $result;
} else {
$yestoall = $input->getOption('yes-to-all') !== false;
$helper = $this->getHelper('question');
// ask download
$question = new ConfirmationQuestion('Download newer version? [no] ', false, '/^(y|j)/i');
if ($yestoall || $helper->ask($input, $output, $question)) {
// do download
$output->writeln('Downloading...');
$audl = AutoUpdate::downloadZip(AutoUpdate::getFromResult('version'));
if (!is_numeric($audl)) {
// ask extract
$question = new ConfirmationQuestion('Extract downloaded archive? [no] ', false, '/^(y|j)/i');
if ($yestoall || $helper->ask($input, $output, $question)) {
// do extract
$output->writeln('Extracting...');
$auex = AutoUpdate::extractZip($audl);
if ($auex == 0) {
$output->writeln("<info>Froxlor files updated successfully.</>");
$result = self::SUCCCESS;
$question = new ConfirmationQuestion('Update database? [no] ', false, '/^(y|j)/i');
if ($yestoall || $helper->ask($input, $output, $question)) {
$result = $this->updateDatabase();
}
} else {
$errmsg = 'error.autoupdate_' . $auex;
$output->writeln('<error>' . lng($errmsg) . '</>');
$result = self::FAILURE;
}
}
} else {
$errmsg = 'error.autoupdate_' . $audl;
$output->writeln('<error>' . lng($errmsg) . '</>');
$result = self::FAILURE;
}
}
}
}
return $result;
}
private function updateDatabase()
{
include_once Froxlor::getInstallDir() . '/lib/tables.inc.php';
define('_CRON_UPDATE', 1);
ob_start([
'this',
'cleanUpdateOutput'
]);
include_once Froxlor::getInstallDir() . '/install/updatesql.php';
ob_end_flush();
return self::SUCCCESS;
}
private function cleanUpdateOutput($buffer)
{
return strip_tags(preg_replace("/<br\W*?\/>/", "\n", $buffer));
}
}

View File

@@ -0,0 +1,173 @@
<?php
/**
* This file is part of the Froxlor project.
* Copyright (c) 2010 the Froxlor Team (see authors).
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you can also view it online at
* https://files.froxlor.org/misc/COPYING.txt
*
* @copyright the authors
* @author Froxlor team <team@froxlor.org>
* @license https://files.froxlor.org/misc/COPYING.txt GPLv2
*/
namespace Froxlor\Install;
use Exception;
use Froxlor\Froxlor;
use Froxlor\Settings;
use Froxlor\Http\HttpClient;
class AutoUpdate
{
// define update-uri
const UPDATE_URI = "https://version.froxlor.org/froxlor/api2/";
const RELEASE_URI = "https://autoupdate.froxlor.org/froxlor-{version}.zip";
const CHECKSUM_URI = "https://autoupdate.froxlor.org/froxlor-{version}.zip.sha256";
const ERR_NOZIPEXT = 2;
const ERR_COULDNOTSTORE = 4;
const ERR_ZIPNOTFOUND = 7;
const ERR_COULDNOTEXTRACT = 8;
const ERR_CHKSUM_MISMATCH = 9;
const ERR_MINPHP = 10;
private static $latestversion = "";
private static $lasterror = "";
/**
* returns status about whether there is a newer version
*
* 0 = no new version available
* 1 = new version available
* -1 = remote error message
* >1 = local error message
*
* @return int
*/
public static function checkVersion(): int
{
$result = self::checkPrerequisites();
if ($result == 0) {
try {
$channel = '';
if (Settings::Get('system.update_channel') == 'testing') {
$channel = '/testing';
}
$latestversion = HttpClient::urlGet(self::UPDATE_URI . Froxlor::VERSION . $channel, true, 3);
} catch (Exception $e) {
throw new Exception("Version-check currently unavailable, please try again later", 504);
}
self::$latestversion = json_decode($latestversion, true);
if (self::$latestversion) {
if (!empty(self::$latestversion['error']) && self::$latestversion['error']) {
$result = -1;
self::$lasterror = self::$latestversion['message'];
} else if (isset(self::$latestversion['has_latest']) && self::$latestversion['has_latest'] == false) {
$result = 1;
}
}
}
return $result;
}
public static function downloadZip(string $newversion)
{
// define files to get
$toLoad = str_replace('{version}', $newversion, self::RELEASE_URI);
$toCheck = str_replace('{version}', $newversion, self::CHECKSUM_URI);
// check for local destination folder
if (!is_dir(Froxlor::getInstallDir() . '/updates/')) {
mkdir(Froxlor::getInstallDir() . '/updates/');
}
// name archive
$localArchive = Froxlor::getInstallDir() . '/updates/' . basename($toLoad);
// remove old archive
if (file_exists($localArchive)) {
@unlink($localArchive);
}
// get archive data
try {
HttpClient::fileGet($toLoad, $localArchive);
} catch (Exception $e) {
return self::ERR_COULDNOTSTORE;
}
// validate the integrity of the downloaded file
$_shouldsum = HttpClient::urlGet($toCheck);
if (!empty($_shouldsum)) {
$_t = explode(" ", $_shouldsum);
$shouldsum = $_t[0];
} else {
$shouldsum = null;
}
$filesum = hash_file('sha256', $localArchive);
if ($filesum != $shouldsum) {
return self::ERR_CHKSUM_MISMATCH;
}
return basename($localArchive);
}
public static function extractZip(string $localArchive): int
{
if (!file_exists($localArchive)) {
return self::ERR_ZIPNOTFOUND;
}
// decompress from zip
$zip = new ZipArchive();
$res = $zip->open($localArchive);
if ($res === true) {
$zip->extractTo(Froxlor::getInstallDir());
$zip->close();
// success - remove unused archive
@unlink($localArchive);
// wait a bit before we redirect to be sure
sleep(3);
return 0;
}
return self::ERR_COULDNOTEXTRACT;
}
private static function checkPrerequisites(): int
{
if (!extension_loaded('zip')) {
return self::ERR_NOZIPEXT;
}
if (version_compare("7.4.0", PHP_VERSION, ">=")) {
return self::ERR_MINPHP;
}
return 0;
}
public static function getLastError(): string
{
return self::$lasterror ?? "";
}
public static function getFromResult(string $index)
{
return self::$latestversion[$index] ?? "";
}
}