friendica/src/Console/Cache.php

211 lines
5.1 KiB
PHP
Raw Normal View History

2018-09-25 22:59:22 -04:00
<?php
2020-02-09 09:45:36 -05:00
/**
2022-01-02 02:27:47 -05:00
* @copyright Copyright (C) 2010-2022, the Friendica project
2020-02-09 09:45:36 -05:00
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
2018-09-25 22:59:22 -04:00
2019-05-02 17:17:35 -04:00
namespace Friendica\Console;
2018-09-25 22:59:22 -04:00
use Asika\SimpleConsole\CommandArgsException;
use Friendica\App;
use Friendica\Core\Cache\Enum\Duration;
2021-10-26 15:44:29 -04:00
use Friendica\Core\Cache\Capability\ICanCache;
2018-09-25 22:59:22 -04:00
use RuntimeException;
/**
2020-01-19 01:05:23 -05:00
* tool to access the cache from the CLI
2018-09-25 22:59:22 -04:00
*
* With this script you can access the cache of your node from the CLI.
* You can read current values stored in the cache and set new values
* in cache keys.
*/
class Cache extends \Asika\SimpleConsole\Console
{
protected $helpOptions = ['h', 'help', '?'];
/**
* @var App\Mode
*/
private $appMode;
/**
2021-10-26 15:44:29 -04:00
* @var ICanCache
*/
private $cache;
2018-09-25 22:59:22 -04:00
protected function getHelp()
{
$help = <<<HELP
console cache - Manage node cache
Synopsis
bin/console cache list [-h|--help|-?] [-v]
bin/console cache get <key> [-h|--help|-?] [-v]
bin/console cache set <key> <value> [-h|--help|-?] [-v]
bin/console cache flush [-h|--help|-?] [-v]
bin/console cache clear [-h|--help|-?] [-v]
Description
bin/console cache list [<prefix>]
List all cache keys, optionally filtered by a prefix
bin/console cache get <key>
Shows the value of the provided cache key
bin/console cache set <key> <value> [<ttl>]
Sets the value of the provided cache key, optionally with the provided TTL (time to live) with a default of five minutes.
bin/console cache flush
Clears expired cache keys
bin/console cache clear
Clears all cache keys
Options
-h|--help|-? Show help information
-v Show more debug information.
HELP;
return $help;
}
2021-10-26 15:44:29 -04:00
public function __construct(App\Mode $appMode, ICanCache $cache, array $argv = null)
2018-09-25 22:59:22 -04:00
{
parent::__construct($argv);
$this->appMode = $appMode;
$this->cache = $cache;
}
2018-09-25 22:59:22 -04:00
protected function doExecute()
{
2018-09-25 22:59:22 -04:00
if ($this->getOption('v')) {
$this->out('Executable: ' . $this->executable);
$this->out('Class: ' . __CLASS__);
$this->out('Arguments: ' . var_export($this->args, true));
$this->out('Options: ' . var_export($this->options, true));
}
if (!$this->appMode->has(App\Mode::DBCONFIGAVAILABLE)) {
2018-09-25 22:59:22 -04:00
$this->out('Database isn\'t ready or populated yet, database cache won\'t be available');
}
if ($this->getOption('v')) {
2019-08-04 10:13:53 -04:00
$this->out('Cache Driver Name: ' . $this->cache->getName());
$this->out('Cache Driver Class: ' . get_class($this->cache));
2018-09-25 22:59:22 -04:00
}
switch ($this->getArgument(0)) {
case 'list':
$this->executeList();
break;
case 'get':
$this->executeGet();
break;
case 'set':
$this->executeSet();
break;
case 'flush':
$this->executeFlush();
break;
case 'clear':
$this->executeClear();
break;
}
if (count($this->args) == 0) {
$this->out($this->getHelp());
return 0;
}
return 0;
}
private function executeList()
{
$prefix = $this->getArgument(1);
$keys = $this->cache->getAllKeys($prefix);
2018-09-25 22:59:22 -04:00
if (empty($prefix)) {
$this->out('Listing all cache keys:');
} else {
$this->out('Listing all cache keys starting with "' . $prefix . '":');
}
$count = 0;
foreach ($keys as $key) {
$this->out($key);
2018-10-07 16:14:05 -04:00
$count++;
2018-09-25 22:59:22 -04:00
}
$this->out($count . ' keys found');
}
private function executeGet()
{
if (count($this->args) >= 2) {
$key = $this->getArgument(1);
$value = $this->cache->get($key);
2018-09-25 22:59:22 -04:00
$this->out("{$key} => " . var_export($value, true));
} else {
throw new CommandArgsException('Too few arguments for get');
}
}
private function executeSet()
{
if (count($this->args) >= 3) {
$key = $this->getArgument(1);
$value = $this->getArgument(2);
$duration = intval($this->getArgument(3, Duration::FIVE_MINUTES));
2018-09-25 22:59:22 -04:00
if (is_array($this->cache->get($key))) {
2018-09-25 22:59:22 -04:00
throw new RuntimeException("$key is an array and can't be set using this command.");
}
$result = $this->cache->set($key, $value, $duration);
2018-09-25 22:59:22 -04:00
if ($result) {
$this->out("{$key} <= " . $this->cache->get($key));
2018-09-25 22:59:22 -04:00
} else {
$this->out("Unable to set {$key}");
}
} else {
throw new CommandArgsException('Too few arguments for set');
}
}
private function executeFlush()
{
$result = $this->cache->clear();
2018-09-25 22:59:22 -04:00
if ($result) {
$this->out('Cache successfully flushed');
} else {
$this->out('Unable to flush the cache');
}
}
private function executeClear()
{
$result = $this->cache->clear(false);
2018-09-25 22:59:22 -04:00
if ($result) {
$this->out('Cache successfully cleared');
} else {
$this->out('Unable to flush the cache');
}
}
}