Merge pull request #54641 from nextcloud/backport/52880/stable31
[stable31] Add commands to set/get/delete/clear the distributed memcachebackport/53752/stable31
yemkareems
GitHub
commit
5c281401a6
@ -0,0 +1,76 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
/**
|
||||
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
|
||||
* SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
*/
|
||||
|
||||
namespace OC\Core\Command\Config\System;
|
||||
|
||||
class CastHelper {
|
||||
/**
|
||||
* @return array{value: mixed, readable-value: string}
|
||||
*/
|
||||
public function castValue(?string $value, string $type): array {
|
||||
switch ($type) {
|
||||
case 'integer':
|
||||
case 'int':
|
||||
if (!is_numeric($value)) {
|
||||
throw new \InvalidArgumentException('Non-numeric value specified');
|
||||
}
|
||||
return [
|
||||
'value' => (int)$value,
|
||||
'readable-value' => 'integer ' . (int)$value,
|
||||
];
|
||||
|
||||
case 'double':
|
||||
case 'float':
|
||||
if (!is_numeric($value)) {
|
||||
throw new \InvalidArgumentException('Non-numeric value specified');
|
||||
}
|
||||
return [
|
||||
'value' => (float)$value,
|
||||
'readable-value' => 'double ' . (float)$value,
|
||||
];
|
||||
|
||||
case 'boolean':
|
||||
case 'bool':
|
||||
$value = strtolower($value);
|
||||
return match ($value) {
|
||||
'true' => [
|
||||
'value' => true,
|
||||
'readable-value' => 'boolean ' . $value,
|
||||
],
|
||||
'false' => [
|
||||
'value' => false,
|
||||
'readable-value' => 'boolean ' . $value,
|
||||
],
|
||||
default => throw new \InvalidArgumentException('Unable to parse value as boolean'),
|
||||
};
|
||||
|
||||
case 'null':
|
||||
return [
|
||||
'value' => null,
|
||||
'readable-value' => 'null',
|
||||
];
|
||||
|
||||
case 'string':
|
||||
$value = (string)$value;
|
||||
return [
|
||||
'value' => $value,
|
||||
'readable-value' => ($value === '') ? 'empty string' : 'string ' . $value,
|
||||
];
|
||||
|
||||
case 'json':
|
||||
$value = json_decode($value, true);
|
||||
return [
|
||||
'value' => $value,
|
||||
'readable-value' => 'json ' . json_encode($value),
|
||||
];
|
||||
|
||||
default:
|
||||
throw new \InvalidArgumentException('Invalid type');
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,47 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
/**
|
||||
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
|
||||
* SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
*/
|
||||
|
||||
namespace OC\Core\Command\Memcache;
|
||||
|
||||
use OC\Core\Command\Base;
|
||||
use OCP\ICacheFactory;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Input\InputOption;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
|
||||
class DistributedClear extends Base {
|
||||
public function __construct(
|
||||
protected ICacheFactory $cacheFactory,
|
||||
) {
|
||||
parent::__construct();
|
||||
}
|
||||
|
||||
protected function configure(): void {
|
||||
$this
|
||||
->setName('memcache:distributed:clear')
|
||||
->setDescription('Clear values from the distributed memcache')
|
||||
->addOption('prefix', null, InputOption::VALUE_REQUIRED, 'Only remove keys matching the prefix');
|
||||
parent::configure();
|
||||
}
|
||||
|
||||
protected function execute(InputInterface $input, OutputInterface $output): int {
|
||||
$cache = $this->cacheFactory->createDistributed();
|
||||
$prefix = $input->getOption('prefix');
|
||||
if ($cache->clear($prefix)) {
|
||||
if ($prefix) {
|
||||
$output->writeln('<info>Distributed cache matching prefix ' . $prefix . ' cleared</info>');
|
||||
} else {
|
||||
$output->writeln('<info>Distributed cache cleared</info>');
|
||||
}
|
||||
return 0;
|
||||
} else {
|
||||
$output->writeln('<error>Failed to clear cache</error>');
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,43 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
/**
|
||||
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
|
||||
* SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
*/
|
||||
|
||||
namespace OC\Core\Command\Memcache;
|
||||
|
||||
use OC\Core\Command\Base;
|
||||
use OCP\ICacheFactory;
|
||||
use Symfony\Component\Console\Input\InputArgument;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
|
||||
class DistributedDelete extends Base {
|
||||
public function __construct(
|
||||
protected ICacheFactory $cacheFactory,
|
||||
) {
|
||||
parent::__construct();
|
||||
}
|
||||
|
||||
protected function configure(): void {
|
||||
$this
|
||||
->setName('memcache:distributed:delete')
|
||||
->setDescription('Delete a value in the distributed memcache')
|
||||
->addArgument('key', InputArgument::REQUIRED, 'The key to delete');
|
||||
parent::configure();
|
||||
}
|
||||
|
||||
protected function execute(InputInterface $input, OutputInterface $output): int {
|
||||
$cache = $this->cacheFactory->createDistributed();
|
||||
$key = $input->getArgument('key');
|
||||
if ($cache->remove($key)) {
|
||||
$output->writeln('<info>Distributed cache key <info>' . $key . '</info> deleted</info>');
|
||||
return 0;
|
||||
} else {
|
||||
$output->writeln('<error>Failed to delete cache key ' . $key . '</error>');
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,40 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
/**
|
||||
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
|
||||
* SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
*/
|
||||
|
||||
namespace OC\Core\Command\Memcache;
|
||||
|
||||
use OC\Core\Command\Base;
|
||||
use OCP\ICacheFactory;
|
||||
use Symfony\Component\Console\Input\InputArgument;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
|
||||
class DistributedGet extends Base {
|
||||
public function __construct(
|
||||
protected ICacheFactory $cacheFactory,
|
||||
) {
|
||||
parent::__construct();
|
||||
}
|
||||
|
||||
protected function configure(): void {
|
||||
$this
|
||||
->setName('memcache:distributed:get')
|
||||
->setDescription('Get a value from the distributed memcache')
|
||||
->addArgument('key', InputArgument::REQUIRED, 'The key to retrieve');
|
||||
parent::configure();
|
||||
}
|
||||
|
||||
protected function execute(InputInterface $input, OutputInterface $output): int {
|
||||
$cache = $this->cacheFactory->createDistributed();
|
||||
$key = $input->getArgument('key');
|
||||
|
||||
$value = $cache->get($key);
|
||||
$this->writeMixedInOutputFormat($input, $output, $value);
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,57 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
/**
|
||||
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
|
||||
* SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
*/
|
||||
|
||||
namespace OC\Core\Command\Memcache;
|
||||
|
||||
use OC\Core\Command\Base;
|
||||
use OC\Core\Command\Config\System\CastHelper;
|
||||
use OCP\ICacheFactory;
|
||||
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 DistributedSet extends Base {
|
||||
public function __construct(
|
||||
protected ICacheFactory $cacheFactory,
|
||||
private CastHelper $castHelper,
|
||||
) {
|
||||
parent::__construct();
|
||||
}
|
||||
|
||||
protected function configure(): void {
|
||||
$this
|
||||
->setName('memcache:distributed:set')
|
||||
->setDescription('Set a value in the distributed memcache')
|
||||
->addArgument('key', InputArgument::REQUIRED, 'The key to set')
|
||||
->addArgument('value', InputArgument::REQUIRED, 'The value to set')
|
||||
->addOption(
|
||||
'type',
|
||||
null,
|
||||
InputOption::VALUE_REQUIRED,
|
||||
'Value type [string, integer, float, boolean, json, null]',
|
||||
'string'
|
||||
);
|
||||
parent::configure();
|
||||
}
|
||||
|
||||
protected function execute(InputInterface $input, OutputInterface $output): int {
|
||||
$cache = $this->cacheFactory->createDistributed();
|
||||
$key = $input->getArgument('key');
|
||||
$value = $input->getArgument('value');
|
||||
$type = $input->getOption('type');
|
||||
['value' => $value, 'readable-value' => $readable] = $this->castHelper->castValue($value, $type);
|
||||
if ($cache->set($key, $value)) {
|
||||
$output->writeln('Distributed cache key <info>' . $key . '</info> set to <info>' . $readable . '</info>');
|
||||
return 0;
|
||||
} else {
|
||||
$output->writeln('<error>Failed to set cache key ' . $key . '</error>');
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,69 @@
|
||||
<?php
|
||||
/**
|
||||
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
|
||||
* SPDX-License-Identifier: AGPL-3.0-only
|
||||
*/
|
||||
|
||||
namespace Core\Command\Config\System;
|
||||
|
||||
use OC\Core\Command\Config\System\CastHelper;
|
||||
use Test\TestCase;
|
||||
|
||||
class CastHelperTest extends TestCase {
|
||||
private CastHelper $castHelper;
|
||||
|
||||
protected function setUp(): void {
|
||||
parent::setUp();
|
||||
$this->castHelper = new CastHelper();
|
||||
}
|
||||
|
||||
public static function castValueProvider(): array {
|
||||
return [
|
||||
[null, 'string', ['value' => '', 'readable-value' => 'empty string']],
|
||||
|
||||
['abc', 'string', ['value' => 'abc', 'readable-value' => 'string abc']],
|
||||
|
||||
['123', 'integer', ['value' => 123, 'readable-value' => 'integer 123']],
|
||||
['456', 'int', ['value' => 456, 'readable-value' => 'integer 456']],
|
||||
|
||||
['2.25', 'double', ['value' => 2.25, 'readable-value' => 'double 2.25']],
|
||||
['0.5', 'float', ['value' => 0.5, 'readable-value' => 'double 0.5']],
|
||||
|
||||
['', 'null', ['value' => null, 'readable-value' => 'null']],
|
||||
|
||||
['true', 'boolean', ['value' => true, 'readable-value' => 'boolean true']],
|
||||
['false', 'bool', ['value' => false, 'readable-value' => 'boolean false']],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider castValueProvider
|
||||
*/
|
||||
public function testCastValue($value, $type, $expectedValue): void {
|
||||
$this->assertSame(
|
||||
$expectedValue,
|
||||
$this->castHelper->castValue($value, $type)
|
||||
);
|
||||
}
|
||||
|
||||
public static function castValueInvalidProvider(): array {
|
||||
return [
|
||||
['123', 'foobar'],
|
||||
|
||||
[null, 'integer'],
|
||||
['abc', 'integer'],
|
||||
['76ggg', 'double'],
|
||||
['true', 'float'],
|
||||
['foobar', 'boolean'],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider castValueInvalidProvider
|
||||
*/
|
||||
public function testCastValueInvalid($value, $type): void {
|
||||
$this->expectException(\InvalidArgumentException::class);
|
||||
|
||||
$this->castHelper->castValue($value, $type);
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue