<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\console;
use Symfony\Component\Console\Input\InputDefinition;
use Symfony\Component\Console\Shell;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
class application extends \Symfony\Component\Console\Application
{
/**
* @var bool Indicates whether or not we are in a shell
*/
protected $in_shell = false;
/**
* @var \phpbb\config\config Config object
*/
protected $config;
/**
* @var \phpbb\language\language Language object
*/
protected $language;
/**
* @param string $name The name of the application
* @param string $version The version of the application
* @param \phpbb\language\language $language The user which runs the application (used for translation)
* @param \phpbb\config\config $config Config object
*/
public function __construct($name, $version, \phpbb\language\language $language, \phpbb\config\config $config)
{
$this->language = $language;
$this->config = $config;
parent::__construct($name, $version);
}
/**
* {@inheritdoc}
*/
protected function getDefaultInputDefinition()
{
$input_definition = parent::getDefaultInputDefinition();
$this->register_global_options($input_definition);
return $input_definition;
}
/**
* Gets the help message.
*
* It's a hack of the default help message to display the --shell
* option only for the application and not for all the commands.
*
* @return string A help message.
*/
public function getHelp()
{
// If we are already in a shell
// we do not want to have the --shell option available
if ($this->in_shell)
{
return parent::getHelp();
}
try
{
$definition = $this->getDefinition();
$definition->addOption(new InputOption(
'--shell',
'-s',
InputOption::VALUE_NONE,
$this->language->lang('CLI_DESCRIPTION_OPTION_SHELL')
));
}
catch (\LogicException $e)
{
// Do nothing
}
return parent::getHelp();
}
/**
* Register a set of commands from the container
*
* @param \phpbb\di\service_collection $command_collection The console service collection
*/
public function register_container_commands(\phpbb\di\service_collection $command_collection)
{
$commands_list = array_keys($command_collection->getArrayCopy());
foreach ($commands_list as $service_command)
{
// config_text DB table does not exist in phpBB prior to 3.1
// Hence skip cron tasks as they include reparser cron as it uses config_text table
if (phpbb_version_compare($this->config['version'], '3.1.0', '<') && strpos($service_command, 'cron') !== false)
{
continue;
}
$this->add($command_collection[$service_command]);
}
}
/**
* {@inheritdoc}
*/
public function doRun(InputInterface $input, OutputInterface $output)
{
// Run a shell if the --shell (or -s) option is set and if no command name is specified
// Also, we do not want to have the --shell option available if we are already in a shell
if (!$this->in_shell && $this->getCommandName($input) === null && $input->hasParameterOption(array('--shell', '-s')))
{
$shell = new Shell($this);
$this->in_shell = true;
$shell->run();
return 0;
}
return parent::doRun($input, $output);
}
/**
* Register global options
*
* @param InputDefinition $definition An InputDefinition instance
*/
protected function register_global_options(InputDefinition $definition)
{
try
{
$definition->addOption(new InputOption(
'safe-mode',
null,
InputOption::VALUE_NONE,
$this->language->lang('CLI_DESCRIPTION_OPTION_SAFE_MODE')
));
$definition->addOption(new InputOption(
'env',
'e',
InputOption::VALUE_REQUIRED,
$this->language->lang('CLI_DESCRIPTION_OPTION_ENV')
));
}
catch (\LogicException $e)
{
// Do nothing
}
}
}