Skip to content

Commit

Permalink
feat: add command to send raw commands to redis
Browse files Browse the repository at this point in the history
Signed-off-by: Robin Appelman <[email protected]>
  • Loading branch information
icewind1991 authored and blizzz committed Jun 14, 2024
1 parent 54bf26a commit 67b1da5
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 0 deletions.
59 changes: 59 additions & 0 deletions core/Command/Memcache/RedisCommand.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
<?php

declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2024 Robin Appelman <[email protected]>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/

namespace OC\Core\Command\Memcache;

use OC\Core\Command\Base;
use OC\RedisFactory;
use OCP\ICertificateManager;
use OCP\IL10N;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class RedisCommand extends Base {
protected IL10N $l;

Check notice

Code scanning / Psalm

PropertyNotSetInConstructor Note

Property OC\Core\Command\Memcache\RedisCommand::$l is not defined in constructor of OC\Core\Command\Memcache\RedisCommand or in any methods called in the constructor

public function __construct(
protected ICertificateManager $certificateManager,
protected RedisFactory $redisFactory,
) {
parent::__construct();
}

protected function configure() {

Check notice

Code scanning / Psalm

MissingReturnType Note

Method OC\Core\Command\Memcache\RedisCommand::configure does not have a return type, expecting void
$this
->setName('memcache:redis:command')
->setDescription('Send raw redis command to the configured redis server')
->addArgument('redis-command', InputArgument::REQUIRED | InputArgument::IS_ARRAY, 'The command to run');
parent::configure();
}

protected function execute(InputInterface $input, OutputInterface $output): int {
$command = $input->getArgument('redis-command');
if (!$this->redisFactory->isAvailable()) {
$output->writeln("<error>No redis server configured</error>");
return 1;
}
try {
$redis = $this->redisFactory->getInstance();
} catch (\Exception $e) {
$output->writeln('Failed to connect to redis: ' . $e->getMessage());
return 1;
}

$redis->setOption(\Redis::OPT_REPLY_LITERAL, true);
$result = $redis->rawCommand(...$command);
if ($result === false) {
$output->writeln("<error>Redis command failed</error>");
return 1;
}
$output->writeln($result);
return 0;
}
}
2 changes: 2 additions & 0 deletions core/register_command.php
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,8 @@
$application->add(Server::get(Command\Security\BruteforceResetAttempts::class));
$application->add(Server::get(Command\SetupChecks::class));
$application->add(Server::get(Command\FilesMetadata\Get::class));

$application->add(Server::get(Command\Memcache\RedisCommand::class));
} else {
$application->add(Server::get(Command\Maintenance\Install::class));
}
1 change: 1 addition & 0 deletions lib/composer/composer/autoload_classmap.php
Original file line number Diff line number Diff line change
Expand Up @@ -1148,6 +1148,7 @@
'OC\\Core\\Command\\Maintenance\\RepairShareOwnership' => $baseDir . '/core/Command/Maintenance/RepairShareOwnership.php',
'OC\\Core\\Command\\Maintenance\\UpdateHtaccess' => $baseDir . '/core/Command/Maintenance/UpdateHtaccess.php',
'OC\\Core\\Command\\Maintenance\\UpdateTheme' => $baseDir . '/core/Command/Maintenance/UpdateTheme.php',
'OC\\Core\\Command\\Memcache\\RedisCommand' => $baseDir . '/core/Command/Memcache/RedisCommand.php',
'OC\\Core\\Command\\Preview\\Generate' => $baseDir . '/core/Command/Preview/Generate.php',
'OC\\Core\\Command\\Preview\\Repair' => $baseDir . '/core/Command/Preview/Repair.php',
'OC\\Core\\Command\\Preview\\ResetRenderedTexts' => $baseDir . '/core/Command/Preview/ResetRenderedTexts.php',
Expand Down
1 change: 1 addition & 0 deletions lib/composer/composer/autoload_static.php
Original file line number Diff line number Diff line change
Expand Up @@ -1181,6 +1181,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
'OC\\Core\\Command\\Maintenance\\RepairShareOwnership' => __DIR__ . '/../../..' . '/core/Command/Maintenance/RepairShareOwnership.php',
'OC\\Core\\Command\\Maintenance\\UpdateHtaccess' => __DIR__ . '/../../..' . '/core/Command/Maintenance/UpdateHtaccess.php',
'OC\\Core\\Command\\Maintenance\\UpdateTheme' => __DIR__ . '/../../..' . '/core/Command/Maintenance/UpdateTheme.php',
'OC\\Core\\Command\\Memcache\\RedisCommand' => __DIR__ . '/../../..' . '/core/Command/Memcache/RedisCommand.php',
'OC\\Core\\Command\\Preview\\Generate' => __DIR__ . '/../../..' . '/core/Command/Preview/Generate.php',
'OC\\Core\\Command\\Preview\\Repair' => __DIR__ . '/../../..' . '/core/Command/Preview/Repair.php',
'OC\\Core\\Command\\Preview\\ResetRenderedTexts' => __DIR__ . '/../../..' . '/core/Command/Preview/ResetRenderedTexts.php',
Expand Down

0 comments on commit 67b1da5

Please sign in to comment.