nextcloud/core/Command/Config/ListConfigs.php

165 lines
4.1 KiB
PHP

<?php
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Joas Schilling <coding@schilljs.com>
*
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OC\Core\Command\Config;
use OC\Core\Command\Base;
use OC\SystemConfig;
use OCP\IAppConfig;
use Stecman\Component\Symfony\Console\BashCompletion\CompletionContext;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
class ListConfigs extends Base {
protected $defaultOutputFormat = self::OUTPUT_FORMAT_JSON_PRETTY;
/** * @var SystemConfig */
protected $systemConfig;
/** @var IAppConfig */
protected $appConfig;
/**
* @param SystemConfig $systemConfig
* @param IAppConfig $appConfig
*/
public function __construct(SystemConfig $systemConfig, IAppConfig $appConfig) {
parent::__construct();
$this->systemConfig = $systemConfig;
$this->appConfig = $appConfig;
}
protected function configure() {
parent::configure();
$this
->setName('config:list')
->setDescription('List all configs')
->addArgument(
'app',
InputArgument::OPTIONAL,
'Name of the app ("system" to get the config.php values, "all" for all apps and system)',
'all'
)
->addOption(
'private',
null,
InputOption::VALUE_NONE,
'Use this option when you want to include sensitive configs like passwords, salts, ...'
)
;
}
protected function execute(InputInterface $input, OutputInterface $output): int {
$app = $input->getArgument('app');
$noSensitiveValues = !$input->getOption('private');
if (!is_string($app)) {
$output->writeln('<error>Invalid app value given</error>');
return 1;
}
switch ($app) {
case 'system':
$configs = [
'system' => $this->getSystemConfigs($noSensitiveValues),
];
break;
case 'all':
$apps = $this->appConfig->getApps();
$configs = [
'system' => $this->getSystemConfigs($noSensitiveValues),
'apps' => [],
];
foreach ($apps as $appName) {
$configs['apps'][$appName] = $this->getAppConfigs($appName, $noSensitiveValues);
}
break;
default:
$configs = [
'apps' => [
$app => $this->getAppConfigs($app, $noSensitiveValues),
],
];
}
$this->writeArrayInOutputFormat($input, $output, $configs);
return 0;
}
/**
* Get the system configs
*
* @param bool $noSensitiveValues
* @return array
*/
protected function getSystemConfigs($noSensitiveValues) {
$keys = $this->systemConfig->getKeys();
$configs = [];
foreach ($keys as $key) {
if ($noSensitiveValues) {
$value = $this->systemConfig->getFilteredValue($key, serialize(null));
} else {
$value = $this->systemConfig->getValue($key, serialize(null));
}
if ($value !== 'N;') {
$configs[$key] = $value;
}
}
return $configs;
}
/**
* Get the app configs
*
* @param string $app
* @param bool $noSensitiveValues
* @return array
*/
protected function getAppConfigs($app, $noSensitiveValues) {
if ($noSensitiveValues) {
return $this->appConfig->getFilteredValues($app, false);
} else {
return $this->appConfig->getValues($app, false);
}
}
/**
* @param string $argumentName
* @param CompletionContext $context
* @return string[]
*/
public function completeArgumentValues($argumentName, CompletionContext $context) {
if ($argumentName === 'app') {
return array_merge(['all', 'system'], \OC_App::getAllApps());
}
return [];
}
}