Your IP : 216.73.216.43
<?php
/**
* @package panopticon
* @copyright Copyright (c)2023-2024 Nicholas K. Dionysopoulos / Akeeba Ltd
* @license https://www.gnu.org/licenses/agpl-3.0.txt GNU Affero General Public License, version 3 or later
*/
namespace Akeeba\Panopticon\CliCommand;
use Akeeba\Panopticon\Application\BootstrapUtilities;
use Akeeba\Panopticon\CliCommand\Attribute\AppHeader;
use Akeeba\Panopticon\CliCommand\Attribute\ConfigAssertion;
use Akeeba\Panopticon\Factory;
use Awf\Container\Container;
use Awf\Container\ContainerAwareInterface;
use Awf\Container\ContainerAwareTrait;
use Awf\Text\Language;
use Awf\Text\LanguageAwareInterface;
use Awf\Text\LanguageAwareTrait;
use Awf\Text\Text;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Formatter\OutputFormatterStyle;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
defined('AKEEBA') || die;
abstract class AbstractCommand extends Command implements ContainerAwareInterface, LanguageAwareInterface
{
use ContainerAwareTrait;
use LanguageAwareTrait;
protected SymfonyStyle $ioStyle;
protected InputInterface $cliInput;
public function getContainer(): Container
{
return Factory::getContainer();
}
public function getLanguage(): Language
{
return $this->getContainer()->language;
}
protected function initialize(InputInterface $input, OutputInterface $output)
{
// Initialise the I/O early
$this->configureSymfonyIO($input, $output);
$output->getFormatter()->setStyle('debug', new OutputFormatterStyle('gray'));
$output->getFormatter()->setStyle('loginfo', new OutputFormatterStyle('bright-blue'));
$output->getFormatter()->setStyle('logwarning', new OutputFormatterStyle('yellow', null, ['bold']));
$output->getFormatter()->setStyle('lognotice', new OutputFormatterStyle('yellow'));
// Make sure Panopticon is configured (unless explicitly asked to do otherwise)
$this->assertConfigured();
parent::initialize($input, $output);
// Conditionally emit header
$this->header($input);
}
protected function header(InputInterface $input)
{
// No header in quiet mode
if ($this->ioStyle->isQuiet())
{
return;
}
// No header when using a special output format
if ($input->hasOption('format') && !in_array($input->getOption('format'), [null, 'table', 'txt', 'text', 'human']))
{
return;
}
// Check the command class' attributes
$showHeader = true;
$cliApp = $this->getApplication();
$refObj = new \ReflectionObject($this);
$attributes = $refObj->getAttributes(AppHeader::class);
if (count($attributes) > 0)
{
$showHeader = $attributes[0]->getArguments()[0];
}
// Forced to never emit a header? Go away.
if (!$showHeader)
{
return;
}
// If I am still here I need to emit the header.
$this->ioStyle->writeln($cliApp->getName() . ' <info>' . $cliApp->getVersion() . '</info>');
$year = gmdate('Y');
$this->ioStyle->writeln([
"Copyright (c) 2023-$year Akeeba Ltd",
"",
"<debug>Distributed under the terms of the GNU General Public License as published",
"by the Free Software Foundation, either version 3 of the License, or (at your",
"option) any later version. See LICENSE.txt.</debug>",
]);
$this->ioStyle->title($this->getDescription());
}
protected function configureSymfonyIO(InputInterface $input, OutputInterface $output)
{
$this->cliInput = $input;
$this->ioStyle = new SymfonyStyle($input, $output);
}
protected function assertConfigured(): void
{
// Check for the #[ConfigAssertion(false)] attribute
$needsAssertion = true;
$refObj = new \ReflectionObject($this);
$attributes = $refObj->getAttributes(ConfigAssertion::class);
if (count($attributes) > 0)
{
$needsAssertion = $attributes[0]->getArguments()[0];
}
if (!$needsAssertion)
{
return;
}
$container = Factory::getContainer();
if (!BootstrapUtilities::hasConfiguration())
{
throw new \RuntimeException('You need to configure Akeeba Panopticon before running this command.', 125);
}
$container->appConfig->loadConfiguration();
}
}