2015-04-09 11:45:07 +02:00
|
|
|
<?php
|
2024-05-24 19:43:47 +02:00
|
|
|
|
2015-04-09 11:45:07 +02:00
|
|
|
/**
|
2024-05-24 19:43:47 +02:00
|
|
|
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
|
|
|
|
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
|
|
|
|
* SPDX-License-Identifier: AGPL-3.0-only
|
2015-04-09 11:45:07 +02:00
|
|
|
*/
|
|
|
|
namespace OC\Core\Command;
|
|
|
|
|
2018-07-09 14:22:10 +02:00
|
|
|
use OC\Core\Command\User\ListCommand;
|
2022-06-27 15:20:16 +02:00
|
|
|
use Stecman\Component\Symfony\Console\BashCompletion\Completion\CompletionAwareInterface;
|
2023-11-23 10:22:34 +01:00
|
|
|
use Stecman\Component\Symfony\Console\BashCompletion\CompletionContext;
|
2015-04-09 11:45:07 +02:00
|
|
|
use Symfony\Component\Console\Command\Command;
|
2022-06-27 15:20:16 +02:00
|
|
|
use Symfony\Component\Console\Helper\Table;
|
2015-04-09 11:45:07 +02:00
|
|
|
use Symfony\Component\Console\Input\InputInterface;
|
|
|
|
use Symfony\Component\Console\Input\InputOption;
|
|
|
|
use Symfony\Component\Console\Output\OutputInterface;
|
|
|
|
|
2016-09-21 00:47:45 +02:00
|
|
|
class Base extends Command implements CompletionAwareInterface {
|
2020-04-10 16:54:27 +02:00
|
|
|
public const OUTPUT_FORMAT_PLAIN = 'plain';
|
|
|
|
public const OUTPUT_FORMAT_JSON = 'json';
|
|
|
|
public const OUTPUT_FORMAT_JSON_PRETTY = 'json_pretty';
|
2015-07-17 09:25:19 +02:00
|
|
|
|
2022-04-12 17:55:01 +02:00
|
|
|
protected string $defaultOutputFormat = self::OUTPUT_FORMAT_PLAIN;
|
|
|
|
private bool $php_pcntl_signal = false;
|
|
|
|
private bool $interrupted = false;
|
2016-01-29 15:59:57 +01:00
|
|
|
|
2015-04-09 11:45:07 +02:00
|
|
|
protected function configure() {
|
|
|
|
$this
|
|
|
|
->addOption(
|
|
|
|
'output',
|
|
|
|
null,
|
|
|
|
InputOption::VALUE_OPTIONAL,
|
2015-04-09 14:42:44 +02:00
|
|
|
'Output format (plain, json or json_pretty, default is plain)',
|
2015-07-16 17:51:33 +02:00
|
|
|
$this->defaultOutputFormat
|
2015-04-09 11:45:07 +02:00
|
|
|
)
|
|
|
|
;
|
|
|
|
}
|
|
|
|
|
2022-06-27 15:20:16 +02:00
|
|
|
protected function writeArrayInOutputFormat(InputInterface $input, OutputInterface $output, array $items, string $prefix = ' - '): void {
|
2015-04-09 14:42:44 +02:00
|
|
|
switch ($input->getOption('output')) {
|
2015-07-17 09:25:19 +02:00
|
|
|
case self::OUTPUT_FORMAT_JSON:
|
2015-04-09 14:42:44 +02:00
|
|
|
$output->writeln(json_encode($items));
|
|
|
|
break;
|
2015-07-17 09:25:19 +02:00
|
|
|
case self::OUTPUT_FORMAT_JSON_PRETTY:
|
2015-04-09 14:42:44 +02:00
|
|
|
$output->writeln(json_encode($items, JSON_PRETTY_PRINT));
|
2015-04-09 11:45:07 +02:00
|
|
|
break;
|
|
|
|
default:
|
|
|
|
foreach ($items as $key => $item) {
|
2015-04-30 15:42:18 +02:00
|
|
|
if (is_array($item)) {
|
|
|
|
$output->writeln($prefix . $key . ':');
|
|
|
|
$this->writeArrayInOutputFormat($input, $output, $item, ' ' . $prefix);
|
|
|
|
continue;
|
|
|
|
}
|
2024-03-28 16:13:19 +01:00
|
|
|
if (!is_int($key) || get_class($this) === ListCommand::class) {
|
2015-04-20 16:31:43 +02:00
|
|
|
$value = $this->valueToString($item);
|
|
|
|
if (!is_null($value)) {
|
2015-04-30 15:42:18 +02:00
|
|
|
$output->writeln($prefix . $key . ': ' . $value);
|
2015-04-20 16:31:43 +02:00
|
|
|
} else {
|
2015-04-30 15:42:18 +02:00
|
|
|
$output->writeln($prefix . $key);
|
2015-04-20 16:31:43 +02:00
|
|
|
}
|
|
|
|
} else {
|
2015-04-30 15:42:18 +02:00
|
|
|
$output->writeln($prefix . $this->valueToString($item));
|
2015-04-20 16:31:43 +02:00
|
|
|
}
|
2015-04-09 11:45:07 +02:00
|
|
|
}
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
2015-04-20 16:31:43 +02:00
|
|
|
|
2022-06-27 15:20:16 +02:00
|
|
|
protected function writeTableInOutputFormat(InputInterface $input, OutputInterface $output, array $items): void {
|
|
|
|
switch ($input->getOption('output')) {
|
|
|
|
case self::OUTPUT_FORMAT_JSON:
|
|
|
|
$output->writeln(json_encode($items));
|
|
|
|
break;
|
|
|
|
case self::OUTPUT_FORMAT_JSON_PRETTY:
|
|
|
|
$output->writeln(json_encode($items, JSON_PRETTY_PRINT));
|
|
|
|
break;
|
|
|
|
default:
|
|
|
|
$table = new Table($output);
|
|
|
|
$table->setRows($items);
|
|
|
|
if (!empty($items) && is_string(array_key_first(reset($items)))) {
|
|
|
|
$table->setHeaders(array_keys(reset($items)));
|
|
|
|
}
|
|
|
|
$table->render();
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2015-05-08 17:13:46 +02:00
|
|
|
/**
|
|
|
|
* @param mixed $item
|
|
|
|
*/
|
|
|
|
protected function writeMixedInOutputFormat(InputInterface $input, OutputInterface $output, $item) {
|
|
|
|
if (is_array($item)) {
|
|
|
|
$this->writeArrayInOutputFormat($input, $output, $item, '');
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
switch ($input->getOption('output')) {
|
2015-07-17 09:25:19 +02:00
|
|
|
case self::OUTPUT_FORMAT_JSON:
|
2015-05-08 17:13:46 +02:00
|
|
|
$output->writeln(json_encode($item));
|
|
|
|
break;
|
2015-07-17 09:25:19 +02:00
|
|
|
case self::OUTPUT_FORMAT_JSON_PRETTY:
|
2015-05-08 17:13:46 +02:00
|
|
|
$output->writeln(json_encode($item, JSON_PRETTY_PRINT));
|
|
|
|
break;
|
|
|
|
default:
|
|
|
|
$output->writeln($this->valueToString($item, false));
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-04-12 17:55:01 +02:00
|
|
|
protected function valueToString($value, bool $returnNull = true): ?string {
|
2015-04-20 16:31:43 +02:00
|
|
|
if ($value === false) {
|
|
|
|
return 'false';
|
2020-04-10 10:35:09 +02:00
|
|
|
} elseif ($value === true) {
|
2015-04-20 16:31:43 +02:00
|
|
|
return 'true';
|
2020-04-10 10:35:09 +02:00
|
|
|
} elseif ($value === null) {
|
2018-01-26 23:46:40 +01:00
|
|
|
return $returnNull ? null : 'null';
|
2015-04-20 16:31:43 +02:00
|
|
|
} else {
|
|
|
|
return $value;
|
|
|
|
}
|
|
|
|
}
|
2016-01-29 15:59:57 +01:00
|
|
|
|
|
|
|
/**
|
2018-10-07 18:12:38 +02:00
|
|
|
* Throw InterruptedException when interrupted by user
|
|
|
|
*
|
|
|
|
* @throws InterruptedException
|
2016-01-29 15:59:57 +01:00
|
|
|
*/
|
2018-10-08 13:05:00 +02:00
|
|
|
protected function abortIfInterrupted() {
|
2018-10-07 18:12:38 +02:00
|
|
|
if ($this->php_pcntl_signal === false) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
pcntl_signal_dispatch();
|
|
|
|
|
|
|
|
if ($this->interrupted === true) {
|
|
|
|
throw new InterruptedException('Command interrupted by user');
|
2016-01-29 15:59:57 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Changes the status of the command to "interrupted" if ctrl-c has been pressed
|
|
|
|
*
|
|
|
|
* Gives a chance to the command to properly terminate what it's doing
|
|
|
|
*/
|
2023-08-27 17:29:26 +02:00
|
|
|
public function cancelOperation(): void {
|
2016-01-29 15:59:57 +01:00
|
|
|
$this->interrupted = true;
|
|
|
|
}
|
|
|
|
|
2016-02-09 15:52:19 +01:00
|
|
|
public function run(InputInterface $input, OutputInterface $output) {
|
|
|
|
// check if the php pcntl_signal functions are accessible
|
|
|
|
$this->php_pcntl_signal = function_exists('pcntl_signal');
|
|
|
|
if ($this->php_pcntl_signal) {
|
|
|
|
// Collect interrupts and notify the running command
|
|
|
|
pcntl_signal(SIGTERM, [$this, 'cancelOperation']);
|
|
|
|
pcntl_signal(SIGINT, [$this, 'cancelOperation']);
|
|
|
|
}
|
|
|
|
|
|
|
|
return parent::run($input, $output);
|
|
|
|
}
|
2016-09-21 00:47:45 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @param string $optionName
|
|
|
|
* @param CompletionContext $context
|
|
|
|
* @return string[]
|
|
|
|
*/
|
|
|
|
public function completeOptionValues($optionName, CompletionContext $context) {
|
2016-09-21 14:03:09 +02:00
|
|
|
if ($optionName === 'output') {
|
|
|
|
return ['plain', 'json', 'json_pretty'];
|
|
|
|
}
|
2016-09-21 00:47:45 +02:00
|
|
|
return [];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param string $argumentName
|
|
|
|
* @param CompletionContext $context
|
|
|
|
* @return string[]
|
|
|
|
*/
|
|
|
|
public function completeArgumentValues($argumentName, CompletionContext $context) {
|
|
|
|
return [];
|
|
|
|
}
|
2015-04-09 11:45:07 +02:00
|
|
|
}
|