ConsoleApplication.php

<?php
/**
 * Joomla! Content Management System
 *
 * @copyright  (C) 2017 Open Source Matters, Inc. <https://www.joomla.org>
 * @license    GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\CMS\Application;

\defined('JPATH_PLATFORM') or die;

use Joomla\CMS\Console;
use Joomla\CMS\Extension\ExtensionManagerTrait;
use Joomla\CMS\Language\Language;
use Joomla\CMS\Plugin\PluginHelper;
use Joomla\CMS\Version;
use Joomla\Console\Application;
use Joomla\DI\Container;
use Joomla\DI\ContainerAwareTrait;
use Joomla\Event\DispatcherAwareInterface;
use Joomla\Event\DispatcherAwareTrait;
use Joomla\Event\DispatcherInterface;
use Joomla\Input\Input;
use Joomla\Registry\Registry;
use Joomla\Session\SessionInterface;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;

/**
 * The Joomla! CMS Console Application
 *
 * @since  4.0.0
 */
class ConsoleApplication extends Application implements DispatcherAwareInterface, CMSApplicationInterface
{
	use DispatcherAwareTrait, EventAware, IdentityAware, ContainerAwareTrait, ExtensionManagerTrait, ExtensionNamespaceMapper;

	/**
	 * The input.
	 *
	 * @var    Input
	 * @since  4.0.0
	 */
	protected $input = null;

	/**
	 * The name of the application.
	 *
	 * @var    string
	 * @since  4.0.0
	 */
	protected $name = null;

	/**
	 * The application language object.
	 *
	 * @var    Language
	 * @since  4.0.0
	 */
	protected $language;

	/**
	 * The application message queue.
	 *
	 * @var    array
	 * @since  4.0.0
	 */
	private $messages = [];

	/**
	 * The application session object.
	 *
	 * @var    SessionInterface
	 * @since  4.0.0
	 */
	private $session;

	/**
	 * Class constructor.
	 *
	 * @param   Registry              $config      An optional argument to provide dependency injection for the application's config object. If the
	 *                                             argument is a Registry object that object will become the application's config object,
	 *                                             otherwise a default config object is created.
	 * @param   DispatcherInterface   $dispatcher  An optional argument to provide dependency injection for the application's event dispatcher. If the
	 *                                             argument is a DispatcherInterface object that object will become the application's event dispatcher,
	 *                                             if it is null then the default event dispatcher will be created based on the application's
	 *                                             loadDispatcher() method.
	 * @param   Container             $container   Dependency injection container.
	 * @param   Language              $language    The language object provisioned for the application.
	 * @param   InputInterface|null   $input       An optional argument to provide dependency injection for the application's input object. If the
	 *                                             argument is an InputInterface object that object will become the application's input object,
	 *                                             otherwise a default input object is created.
	 * @param   OutputInterface|null  $output      An optional argument to provide dependency injection for the application's output object. If the
	 *                                             argument is an OutputInterface object that object will become the application's output object,
	 *                                             otherwise a default output object is created.
	 *
	 * @since   4.0.0
	 */
	public function __construct(
		Registry $config,
		DispatcherInterface $dispatcher,
		Container $container,
		Language $language,
		?InputInterface $input = null,
		?OutputInterface $output = null
	)
	{
		// Close the application if it is not executed from the command line.
		if (!\defined('STDOUT') || !\defined('STDIN') || !isset($_SERVER['argv']))
		{
			$this->close();
		}

		// Set up a Input object for Controllers etc to use
		$this->input    = new \Joomla\CMS\Input\Cli;
		$this->language = $language;

		parent::__construct($input, $output, $config);

		$this->setVersion(JVERSION);

		// Register the client name as cli
		$this->name = 'cli';

		$this->setContainer($container);
		$this->setDispatcher($dispatcher);

		// Set the execution datetime and timestamp;
		$this->set('execution.datetime', gmdate('Y-m-d H:i:s'));
		$this->set('execution.timestamp', time());
		$this->set('execution.microtimestamp', microtime(true));

		// Set the current directory.
		$this->set('cwd', getcwd());

		// Set up the environment
		$this->input->set('format', 'cli');
	}

	/**
	 * Magic method to access properties of the application.
	 *
	 * @param   string  $name  The name of the property.
	 *
	 * @return  mixed   A value if the property name is valid, null otherwise.
	 *
	 * @since       4.0.0
	 * @deprecated  5.0  This is a B/C proxy for deprecated read accesses
	 */
	public function __get($name)
	{
		switch ($name)
		{
			case 'input':
				@trigger_error(
					'Accessing the input property of the application is deprecated, use the getInput() method instead.',
					E_USER_DEPRECATED
				);

				return $this->getInput();

			default:
				$trace = debug_backtrace();
				trigger_error(
					sprintf(
						'Undefined property via __get(): %1$s in %2$s on line %3$s',
						$name,
						$trace[0]['file'],
						$trace[0]['line']
					),
					E_USER_NOTICE
				);
		}
	}

	/**
	 * Method to run the application routines.
	 *
	 * @return  integer  The exit code for the application
	 *
	 * @since   4.0.0
	 * @throws  \Throwable
	 */
	protected function doExecute(): int
	{
		$exitCode = parent::doExecute();

		$style = new SymfonyStyle($this->getConsoleInput(), $this->getConsoleOutput());

		$methodMap = [
			self::MSG_ALERT     => 'error',
			self::MSG_CRITICAL  => 'caution',
			self::MSG_DEBUG     => 'comment',
			self::MSG_EMERGENCY => 'caution',
			self::MSG_ERROR     => 'error',
			self::MSG_INFO      => 'note',
			self::MSG_NOTICE    => 'note',
			self::MSG_WARNING   => 'warning',
		];

		// Output any enqueued messages before the app exits
		foreach ($this->getMessageQueue() as $type => $messages)
		{
			$method = $methodMap[$type] ?? 'comment';

			$style->$method($messages);
		}

		return $exitCode;
	}

	/**
	 * Execute the application.
	 *
	 * @return  void
	 *
	 * @since   4.0.0
	 * @throws  \Throwable
	 */
	public function execute()
	{
		// Load extension namespaces
		$this->createExtensionNamespaceMap();

		// Import CMS plugin groups to be able to subscribe to events
		PluginHelper::importPlugin('system');
		PluginHelper::importPlugin('console');

		parent::execute();
	}

	/**
	 * Enqueue a system message.
	 *
	 * @param   string  $msg   The message to enqueue.
	 * @param   string  $type  The message type.
	 *
	 * @return  void
	 *
	 * @since   4.0.0
	 */
	public function enqueueMessage($msg, $type = self::MSG_INFO)
	{
		if (!array_key_exists($type, $this->messages))
		{
			$this->messages[$type] = [];
		}

		$this->messages[$type][] = $msg;
	}

	/**
	 * Gets the name of the current running application.
	 *
	 * @return  string  The name of the application.
	 *
	 * @since   4.0.0
	 */
	public function getName(): string
	{
		return $this->name;
	}

	/**
	 * Get the commands which should be registered by default to the application.
	 *
	 * @return  \Joomla\Console\Command\AbstractCommand[]
	 *
	 * @since   4.0.0
	 */
	protected function getDefaultCommands(): array
	{
		return array_merge(
			parent::getDefaultCommands(),
			[
				new Console\CleanCacheCommand,
				new Console\CheckUpdatesCommand,
				new Console\RemoveOldFilesCommand,
				new Console\AddUserCommand,
				new Console\AddUserToGroupCommand,
				new Console\RemoveUserFromGroupCommand,
				new Console\DeleteUserCommand,
				new Console\ChangeUserPasswordCommand,
				new Console\ListUserCommand,
			]
		);
	}

	/**
	 * Retrieve the application configuration object.
	 *
	 * @return  Registry
	 *
	 * @since   4.0.0
	 */
	public function getConfig()
	{
		return $this->config;
	}

	/**
	 * Method to get the application input object.
	 *
	 * @return  Input
	 *
	 * @since   4.0.0
	 */
	public function getInput(): Input
	{
		return $this->input;
	}

	/**
	 * Method to get the application language object.
	 *
	 * @return  Language  The language object
	 *
	 * @since   4.0.0
	 */
	public function getLanguage()
	{
		return $this->language;
	}

	/**
	 * Get the system message queue.
	 *
	 * @return  array  The system message queue.
	 *
	 * @since   4.0.0
	 */
	public function getMessageQueue()
	{
		return $this->messages;
	}

	/**
	 * Method to get the application session object.
	 *
	 * @return  SessionInterface  The session object
	 *
	 * @since   4.0.0
	 */
	public function getSession()
	{
		return $this->session;
	}

	/**
	 * Check the client interface by name.
	 *
	 * @param   string  $identifier  String identifier for the application interface
	 *
	 * @return  boolean  True if this application is of the given type client interface.
	 *
	 * @since   4.0.0
	 */
	public function isClient($identifier)
	{
		return $this->getName() === $identifier;
	}

	/**
	 * Flag if the application instance is a CLI or web based application.
	 *
	 * Helper function, you should use the native PHP functions to detect if it is a CLI application.
	 *
	 * @return  boolean
	 *
	 * @since       4.0.0
	 * @deprecated  5.0  Will be removed without replacements
	 */
	public function isCli()
	{
		return true;
	}

	/**
	 * Sets the session for the application to use, if required.
	 *
	 * @param   SessionInterface  $session  A session object.
	 *
	 * @return  $this
	 *
	 * @since   4.0.0
	 */
	public function setSession(SessionInterface $session): self
	{
		$this->session = $session;

		return $this;
	}

	/**
	 * Flush the media version to refresh versionable assets
	 *
	 * @return  void
	 *
	 * @since   4.0.0
	 */
	public function flushAssets()
	{
		(new Version)->refreshMediaVersion();
	}

	/**
	 * Get the long version string for the application.
	 *
	 * Overrides the parent method due to conflicting use of the getName method between the console application and
	 * the CMS application interface.
	 *
	 * @return  string
	 *
	 * @since   4.0.0
	 */
	public function getLongVersion(): string
	{
		return sprintf('Joomla! <info>%s</info> (debug: %s)', (new Version)->getShortVersion(), (\defined('JDEBUG') && JDEBUG ? 'Yes' : 'No'));
	}

	/**
	 * Set the name of the application.
	 *
	 * @param   string  $name  The new application name.
	 *
	 * @return  void
	 *
	 * @since   4.0.0
	 * @throws  \RuntimeException because the application name cannot be changed
	 */
	public function setName(string $name): void
	{
		throw new \RuntimeException('The console application name cannot be changed');
	}
}