2018-09-26 04:59:22 +02:00
|
|
|
<?php
|
2020-02-09 15:45:36 +01:00
|
|
|
/**
|
|
|
|
* @copyright Copyright (C) 2020, Friendica
|
|
|
|
*
|
|
|
|
* @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-26 04:59:22 +02:00
|
|
|
|
2019-05-02 23:17:35 +02:00
|
|
|
namespace Friendica\Console;
|
2018-09-26 04:59:22 +02:00
|
|
|
|
|
|
|
use Asika\SimpleConsole\CommandArgsException;
|
|
|
|
use Friendica\App;
|
2020-01-18 15:41:19 +01:00
|
|
|
use Friendica\Core\Cache\Duration;
|
2019-08-04 10:26:53 +02:00
|
|
|
use Friendica\Core\Cache\ICache;
|
2018-09-26 04:59:22 +02:00
|
|
|
use RuntimeException;
|
|
|
|
|
|
|
|
/**
|
2020-01-19 07:05:23 +01:00
|
|
|
* tool to access the cache from the CLI
|
2018-09-26 04:59:22 +02: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', '?'];
|
|
|
|
|
2019-07-28 22:06:33 +02:00
|
|
|
/**
|
|
|
|
* @var App\Mode
|
|
|
|
*/
|
|
|
|
private $appMode;
|
|
|
|
|
2019-08-03 20:48:56 +02:00
|
|
|
/**
|
2019-08-04 10:26:53 +02:00
|
|
|
* @var ICache
|
2019-08-03 20:48:56 +02:00
|
|
|
*/
|
|
|
|
private $cache;
|
|
|
|
|
2018-09-26 04:59:22 +02: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;
|
|
|
|
}
|
|
|
|
|
2019-08-04 15:42:39 +02:00
|
|
|
public function __construct(App\Mode $appMode, ICache $cache, array $argv = null)
|
2018-09-26 04:59:22 +02:00
|
|
|
{
|
2019-07-28 22:06:33 +02:00
|
|
|
parent::__construct($argv);
|
|
|
|
|
|
|
|
$this->appMode = $appMode;
|
2019-08-04 15:42:39 +02:00
|
|
|
$this->cache = $cache;
|
2019-07-28 22:06:33 +02:00
|
|
|
}
|
2018-09-26 04:59:22 +02:00
|
|
|
|
2019-07-28 22:06:33 +02:00
|
|
|
protected function doExecute()
|
|
|
|
{
|
2018-09-26 04:59:22 +02: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));
|
|
|
|
}
|
|
|
|
|
2019-07-28 22:06:33 +02:00
|
|
|
if (!$this->appMode->has(App\Mode::DBCONFIGAVAILABLE)) {
|
2018-09-26 04:59:22 +02:00
|
|
|
$this->out('Database isn\'t ready or populated yet, database cache won\'t be available');
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($this->getOption('v')) {
|
2019-08-04 16:13:53 +02:00
|
|
|
$this->out('Cache Driver Name: ' . $this->cache->getName());
|
2019-08-03 20:48:56 +02:00
|
|
|
$this->out('Cache Driver Class: ' . get_class($this->cache));
|
2018-09-26 04:59:22 +02: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);
|
2019-08-04 15:42:39 +02:00
|
|
|
$keys = $this->cache->getAllKeys($prefix);
|
2018-09-26 04:59:22 +02: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) {
|
2018-10-07 10:35:37 +02:00
|
|
|
$this->out($key);
|
2018-10-07 22:14:05 +02:00
|
|
|
$count++;
|
2018-09-26 04:59:22 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
$this->out($count . ' keys found');
|
|
|
|
}
|
|
|
|
|
|
|
|
private function executeGet()
|
|
|
|
{
|
|
|
|
if (count($this->args) >= 2) {
|
2019-08-04 15:42:39 +02:00
|
|
|
$key = $this->getArgument(1);
|
2019-08-03 20:48:56 +02:00
|
|
|
$value = $this->cache->get($key);
|
2018-09-26 04:59:22 +02: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) {
|
2019-08-04 15:42:39 +02:00
|
|
|
$key = $this->getArgument(1);
|
|
|
|
$value = $this->getArgument(2);
|
2020-01-18 15:41:19 +01:00
|
|
|
$duration = intval($this->getArgument(3, Duration::FIVE_MINUTES));
|
2018-09-26 04:59:22 +02:00
|
|
|
|
2019-08-03 20:48:56 +02:00
|
|
|
if (is_array($this->cache->get($key))) {
|
2018-09-26 04:59:22 +02:00
|
|
|
throw new RuntimeException("$key is an array and can't be set using this command.");
|
|
|
|
}
|
|
|
|
|
2019-08-03 20:48:56 +02:00
|
|
|
$result = $this->cache->set($key, $value, $duration);
|
2018-09-26 04:59:22 +02:00
|
|
|
if ($result) {
|
2019-08-03 20:48:56 +02:00
|
|
|
$this->out("{$key} <= " . $this->cache->get($key));
|
2018-09-26 04:59:22 +02:00
|
|
|
} else {
|
|
|
|
$this->out("Unable to set {$key}");
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
throw new CommandArgsException('Too few arguments for set');
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
private function executeFlush()
|
|
|
|
{
|
2019-08-03 20:48:56 +02:00
|
|
|
$result = $this->cache->clear();
|
2018-09-26 04:59:22 +02:00
|
|
|
if ($result) {
|
|
|
|
$this->out('Cache successfully flushed');
|
|
|
|
} else {
|
|
|
|
$this->out('Unable to flush the cache');
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
private function executeClear()
|
|
|
|
{
|
2019-08-03 20:48:56 +02:00
|
|
|
$result = $this->cache->clear(false);
|
2018-09-26 04:59:22 +02:00
|
|
|
if ($result) {
|
|
|
|
$this->out('Cache successfully cleared');
|
|
|
|
} else {
|
|
|
|
$this->out('Unable to flush the cache');
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|