wbrawner/server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #14066 from nextcloud/feature/noid/casted-system-values

Browse source 
Get typed system values
This commit is contained in:
Joas Schilling 2019-02-22 11:54:20 +01:00 committed by GitHub
commit 2cc4118629
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
19 changed files with 92 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
apps/dav/lib/Connector/Sabre/MaintenancePlugin.php
View file

@ -78,7 +78,7 @@ class MaintenancePlugin extends ServerPlugin {
* @return bool
*/
public function checkMaintenanceMode() {
if ($this->config->getSystemValue('maintenance', false)) {
if ($this->config->getSystemValueBool('maintenance')) {
throw new ServiceUnavailable('System in maintenance mode.');
}
if (Util::needUpgrade()) {

3
apps/dav/tests/unit/Connector/Sabre/MaintenancePluginTest.php
View file

@ -53,7 +53,8 @@ class MaintenancePluginTest extends TestCase {
public function testMaintenanceMode() {
$this->config
->expects($this->exactly(1))
->method('getSystemValue')
->method('getSystemValueBool')
->with('maintenance')
->will($this->returnValue(true));
$this->maintenancePlugin->checkMaintenanceMode();

2
apps/encryption/lib/AppInfo/Application.php
View file

@ -75,7 +75,7 @@ class Application extends \OCP\AppFramework\App {
* register hooks
*/
public function registerHooks() {
if (!$this->config->getSystemValue('maintenance', false)) {
if (!$this->config->getSystemValueBool('maintenance')) {
$container = $this->getContainer();
$server = $container->getServer();

2
core/Command/Encryption/DecryptAll.php
View file

@ -89,7 +89,7 @@ class DecryptAll extends Command {
*/
protected function forceMaintenanceAndTrashbin() {
$this->wasTrashbinEnabled = $this->appManager->isEnabledForUser('files_trashbin');
$this->wasMaintenanceModeEnabled = $this->config->getSystemValue('maintenance', false);
$this->wasMaintenanceModeEnabled = $this->config->getSystemValueBool('maintenance');
$this->config->setSystemValue('maintenance', true);
$this->appManager->disableApp('files_trashbin');
}

2
core/Command/Encryption/EncryptAll.php
View file

@ -78,7 +78,7 @@ class EncryptAll extends Command {
*/
protected function forceMaintenanceAndTrashbin() {
$this->wasTrashbinEnabled = $this->appManager->isEnabledForUser('files_trashbin');
$this->wasMaintenanceModeEnabled = $this->config->getSystemValue('maintenance', false);
$this->wasMaintenanceModeEnabled = $this->config->getSystemValueBool('maintenance');
$this->config->setSystemValue('maintenance', true);
$this->appManager->disableApp('files_trashbin');
}

2
core/Command/Maintenance/Mode.php
View file

@ -59,7 +59,7 @@ class Mode extends Command {
}
protected function execute(InputInterface $input, OutputInterface $output) {
$maintenanceMode = $this->config->getSystemValue('maintenance', false);
$maintenanceMode = $this->config->getSystemValueBool('maintenance');
if ($input->getOption('on')) {
if ($maintenanceMode === false) {
$this->config->setSystemValue('maintenance', true);

2
core/Command/Maintenance/Repair.php
View file

@ -106,7 +106,7 @@ class Repair extends Command {
}
}
$maintenanceMode = $this->config->getSystemValue('maintenance', false);
$maintenanceMode = $this->config->getSystemValueBool('maintenance');
$this->config->setSystemValue('maintenance', true);
$this->progress = new ProgressBar($output);

2
core/Command/Upgrade.php
View file

@ -264,7 +264,7 @@ class Upgrade extends Command {
}
return self::ERROR_SUCCESS;
} else if($this->config->getSystemValue('maintenance', false)) {
} else if($this->config->getSystemValueBool('maintenance')) {
//Possible scenario: Nextcloud core is updated but an app failed
$output->writeln('<warning>Nextcloud is in maintenance mode</warning>');
$output->write('<comment>Maybe an upgrade is already in process. Please check the '

2
cron.php
View file

@ -44,7 +44,7 @@ try {
\OC::$server->getLogger()->debug('Update required, skipping cron', ['app' => 'cron']);
exit;
}
if (\OC::$server->getSystemConfig()->getValue('maintenance', false)) {
if ((bool) \OC::$server->getSystemConfig()->getValue('maintenance', false)) {
\OC::$server->getLogger()->debug('We are in maintenance mode, skipping cron', ['app' => 'cron']);
exit;
}

8
lib/base.php
View file

@ -285,7 +285,7 @@ class OC {
public static function checkMaintenanceMode() {
// Allow ajax update script to execute without being stopped
if (\OC::$server->getSystemConfig()->getValue('maintenance', false) && OC::$SUBURI != '/core/ajax/update.php') {
if (((bool) \OC::$server->getSystemConfig()->getValue('maintenance', false)) && OC::$SUBURI != '/core/ajax/update.php') {
// send http status 503
http_response_code(503);
header('Retry-After: 120');
@ -938,7 +938,7 @@ class OC {
if (function_exists('opcache_reset')) {
opcache_reset();
}
if (!$systemConfig->getValue('maintenance', false)) {
if (!((bool) $systemConfig->getValue('maintenance', false))) {
self::printUpgradePage($systemConfig);
exit();
}
@ -966,7 +966,7 @@ class OC {
// Load minimum set of apps
if (!\OCP\Util::needUpgrade()
&& !$systemConfig->getValue('maintenance', false)) {
&& !((bool) $systemConfig->getValue('maintenance', false))) {
// For logged-in users: Load everything
if(\OC::$server->getUserSession()->isLoggedIn()) {
OC_App::loadApps();
@ -979,7 +979,7 @@ class OC {
if (!self::$CLI) {
try {
if (!$systemConfig->getValue('maintenance', false) && !\OCP\Util::needUpgrade()) {
if (!((bool) $systemConfig->getValue('maintenance', false)) && !\OCP\Util::needUpgrade()) {
OC_App::loadApps(array('filesystem', 'logging'));
OC_App::loadApps();
}

36
lib/private/AllConfig.php
View file

@ -125,6 +125,42 @@ class AllConfig implements \OCP\IConfig {
return $this->systemConfig->getValue($key, $default);
}
/**
* Looks up a boolean system wide defined value
*
* @param string $key the key of the value, under which it was saved
* @param mixed $default the default value to be returned if the value isn't set
* @return mixed the value or $default
* @since 16.0.0
*/
public function getSystemValueBool(string $key, bool $default = false): bool {
return (bool) $this->getSystemValue($key, $default);
}
/**
* Looks up an integer system wide defined value
*
* @param string $key the key of the value, under which it was saved
* @param mixed $default the default value to be returned if the value isn't set
* @return mixed the value or $default
* @since 16.0.0
*/
public function getSystemValueInt(string $key, int $default = 0): int {
return (int) $this->getSystemValue($key, $default);
}
/**
* Looks up a string system wide defined value
*
* @param string $key the key of the value, under which it was saved
* @param mixed $default the default value to be returned if the value isn't set
* @return mixed the value or $default
* @since 16.0.0
*/
public function getSystemValueString(string $key, string $default = ''): string {
return (string) $this->getSystemValue($key, $default);
}
/**
* Looks up a system wide defined value and filters out sensitive data
*

2
lib/private/Console/Application.php
View file

@ -119,7 +119,7 @@ class Application {
if ($this->config->getSystemValue('installed', false)) {
if (\OCP\Util::needUpgrade()) {
throw new NeedsUpdateException();
} elseif ($this->config->getSystemValue('maintenance', false)) {
} elseif ($this->config->getSystemValueBool('maintenance')) {
$this->writeMaintenanceModeInfo($input, $output);
} else {
OC_App::loadApps();

2
lib/private/Route/Router.php
View file

@ -260,7 +260,7 @@ class Router implements IRouter {
$this->loadRoutes($app);
} else if (substr($url, 0, 6) === '/core/' or substr($url, 0, 10) === '/settings/') {
\OC::$REQUESTEDAPP = $url;
if (!\OC::$server->getConfig()->getSystemValue('maintenance', false) && !Util::needUpgrade()) {
if (!\OC::$server->getConfig()->getSystemValueBool('maintenance') && !Util::needUpgrade()) {
\OC_App::loadApps();
}
$this->loadRoutes('core');

3
lib/private/Updater.php
View file

@ -104,7 +104,7 @@ class Updater extends BasicEmitter {
$this->emit('\OC\Updater', 'setDebugLogLevel', [ $logLevel, $this->logLevelNames[$logLevel] ]);
$this->config->setSystemValue('loglevel', ILogger::DEBUG);
$wasMaintenanceModeEnabled = $this->config->getSystemValue('maintenance', false);
$wasMaintenanceModeEnabled = $this->config->getSystemValueBool('maintenance');
if(!$wasMaintenanceModeEnabled) {
$this->config->setSystemValue('maintenance', true);
@ -614,4 +614,3 @@ class Updater extends BasicEmitter {
}
}

2
lib/private/legacy/app.php
View file

@ -106,7 +106,7 @@ class OC_App {
* if $types is set to non-empty array, only apps of those types will be loaded
*/
public static function loadApps(array $types = []): bool {
if (\OC::$server->getSystemConfig()->getValue('maintenance', false)) {
if ((bool) \OC::$server->getSystemConfig()->getValue('maintenance', false)) {
return false;
}
// Load the enabled apps here

30
lib/public/IConfig.php
View file

@ -74,6 +74,36 @@ interface IConfig {
*/
public function getSystemValue($key, $default = '');
/**
* Looks up a boolean system wide defined value
*
* @param string $key the key of the value, under which it was saved
* @param bool $default the default value to be returned if the value isn't set
* @return bool the value or $default
* @since 16.0.0
*/
public function getSystemValueBool(string $key, bool $default = false): bool;
/**
* Looks up an integer system wide defined value
*
* @param string $key the key of the value, under which it was saved
* @param int $default the default value to be returned if the value isn't set
* @return int the value or $default
* @since 16.0.0
*/
public function getSystemValueInt(string $key, int $default = 0): int;
/**
* Looks up a string system wide defined value
*
* @param string $key the key of the value, under which it was saved
* @param string $default the default value to be returned if the value isn't set
* @return string the value or $default
* @since 16.0.0
*/
public function getSystemValueString(string $key, string $default = ''): string;
/**
* Looks up a system wide defined value and filters out sensitive data
*

3
ocs/v1.php
View file

@ -33,7 +33,7 @@ require_once __DIR__ . '/../lib/versioncheck.php';
require_once __DIR__ . '/../lib/base.php';
if (\OCP\Util::needUpgrade()
|| \OC::$server->getSystemConfig()->getValue('maintenance', false)) {
|| \OC::$server->getConfig()->getSystemValueBool('maintenance')) {
// since the behavior of apps or remotes are unpredictable during
// an upgrade, return a 503 directly
http_response_code(503);
@ -103,4 +103,3 @@ try {
.' http://www.freedesktop.org/wiki/Specifications/open-collaboration-services.'."\n";
OC_API::respond(new \OC\OCS\Result(null, \OCP\API::RESPOND_NOT_FOUND, $txt), $format);
}

2
tests/Core/Command/Encryption/EncryptAllTest.php
View file

@ -91,7 +91,7 @@ class EncryptAllTest extends TestCase {
$this->appManager->expects($this->once())->method('disableApp')->with('files_trashbin');
// enable single user mode to avoid that other user login during encryption
// destructor should disable the single user mode again
$this->config->expects($this->once())->method('getSystemValue')->with('maintenance', false)->willReturn(false);
$this->config->expects($this->once())->method('getSystemValueBool')->with('maintenance', false)->willReturn(false);
$this->config->expects($this->at(1))->method('setSystemValue')->with('maintenance', true);
$this->config->expects($this->at(2))->method('setSystemValue')->with('maintenance', false);

2
tests/Core/Command/Maintenance/ModeTest.php
View file

@ -123,7 +123,7 @@ class ModeTest extends TestCase {
string $expectedOutput
) {
$this->config->expects($this->any())
->method('getSystemValue')
->method('getSystemValueBool')
->willReturn($currentMaintenanceState);
if ($expectedMaintenanceState !== null) {