primo commit

libraries/fof40/Cli/Joomla4.php

@@ -0,0 +1,196 @@
+<?php
+/**
+ * @package   FOF
+ * @copyright Copyright (c)2010-2022 Nicholas K. Dionysopoulos / Akeeba Ltd
+ * @license   GNU General Public License version 3, or later
+ */
+
+// Do not put the JEXEC or die check on this file
+
+use FOF40\Cli\Traits\CGIModeAware;
+use FOF40\Cli\Traits\CustomOptionsAware;
+use FOF40\Cli\Traits\JoomlaConfigAware;
+use FOF40\Cli\Traits\MemStatsAware;
+use FOF40\Cli\Traits\TimeAgoAware;
+use Joomla\CMS\Application\CliApplication;
+use Joomla\CMS\Application\ExtensionNamespaceMapper;
+use Joomla\CMS\Factory;
+use Joomla\Event\Dispatcher;
+use Joomla\Registry\Registry;
+use Joomla\Session\SessionInterface;
+
+/**
+ * Load the legacy Joomla! include files
+ *
+ * Despite Joomla complaining about it with an E_DEPRECATED notice, if you use bootstrap.php instead of
+ * import.legacy.php you get an HTML error page (yes, under CLI!) which is kinda daft.
+ */
+if (function_exists('error_reporting'))
+{
+	$oldErrorReporting = @error_reporting(E_ERROR | E_NOTICE | E_DEPRECATED);
+}
+
+include_once JPATH_LIBRARIES . '/import.legacy.php';
+
+if (function_exists('error_reporting'))
+{
+	@error_reporting($oldErrorReporting);
+}
+
+// Load the Framework (J4 beta 1 and later) or CMS import file (J4 a12 and lower)
+$cmsImportFilePath = JPATH_BASE . '/includes/framework.php';
+$cmsImportFilePathOld = JPATH_LIBRARIES . '/cms.php';
+
+if (@file_exists($cmsImportFilePath))
+{
+	@include_once $cmsImportFilePath;
+
+	// Boot the DI container
+	$container = \Joomla\CMS\Factory::getContainer();
+
+	/*
+	 * Alias the session service keys to the CLI session service as that is the primary session backend for this application
+	 *
+	 * In addition to aliasing "common" service keys, we also create aliases for the PHP classes to ensure autowiring objects
+	 * is supported.  This includes aliases for aliased class names, and the keys for aliased class names should be considered
+	 * deprecated to be removed when the class name alias is removed as well.
+	 */
+	$container->alias('session', 'session.cli')
+		->alias('JSession', 'session.cli')
+		->alias(\Joomla\CMS\Session\Session::class, 'session.cli')
+		->alias(\Joomla\Session\Session::class, 'session.cli')
+		->alias(\Joomla\Session\SessionInterface::class, 'session.cli');
+}
+elseif (@file_exists($cmsImportFilePathOld))
+{
+	@include_once $cmsImportFilePathOld;
+}
+
+/**
+ * Base class for a Joomla! command line application. Adapted from JCli / JApplicationCli
+ */
+abstract class FOFCliApplicationJoomla4 extends CliApplication
+{
+	use CGIModeAware, CustomOptionsAware, JoomlaConfigAware, MemStatsAware, TimeAgoAware, ExtensionNamespaceMapper;
+
+	private $allowedToClose = false;
+
+	public static function getInstance($name = null)
+	{
+		$instance = parent::getInstance($name);
+
+		Factory::$application = $instance;
+
+		/**
+		 * Load FOF.
+		 *
+		 * In Joomla 4 this must happen after we have set up the application in the factory because Factory::getLanguage
+		 * goes through the application object to retrieve the configuration.
+		 */
+		if (!defined('FOF40_INCLUDED') && !@include_once(JPATH_LIBRARIES . '/fof40/include.php'))
+		{
+			throw new RuntimeException('Cannot load FOF', 500);
+		}
+
+		return $instance;
+	}
+
+	public function __construct(\Joomla\Input\Input $input = null, Registry $config = null, \Joomla\CMS\Application\CLI\CliOutput $output = null, \Joomla\CMS\Application\CLI\CliInput $cliInput = null, \Joomla\Event\DispatcherInterface $dispatcher = null, \Joomla\DI\Container $container = null)
+	{
+		// Some servers only provide a CGI executable. While not ideal for running CLI applications we can make do.
+		$this->detectAndWorkAroundCGIMode();
+
+		// We need to tell Joomla to register its default namespace conventions
+		$this->createExtensionNamespaceMap();
+
+		// Initialize custom options handling which is a bit more straightforward than Input\Cli.
+		$this->initialiseCustomOptions();
+
+		// Default configuration: Joomla Global Configuration
+		if (empty($config))
+		{
+			$config = new Registry($this->fetchConfigurationData());
+		}
+
+		if (empty($dispatcher))
+		{
+			$dispatcher = new Dispatcher();
+		}
+
+		parent::__construct($input, $config, $output, $cliInput, $dispatcher, $container);
+
+		/**
+		 * Allow the application to close.
+		 *
+		 * This is required to allow CliApplication to execute under CGI mode. The checks performed in the parent
+		 * constructor will call close() if the application does not run pure CLI mode. However, some hosts only provide
+		 * the PHP CGI binary for executing CLI scripts. While wrong it will work in most cases. By default close() will
+		 * do nothing, thereby allowing the parent constructor to call it without a problem. Finally, we set this flag
+		 * to true to allow doExecute() to call close() and actually close the application properly. Yeehaw!
+		 */
+		$this->allowedToClose = true;
+	}
+
+	/**
+	 * Method to close the application.
+	 *
+	 * See the constructor for details on why it works the way it works.
+	 *
+	 * @param   integer  $code  The exit code (optional; default is 0).
+	 *
+	 * @return  void
+	 *
+	 * @codeCoverageIgnore
+	 * @since   1.0
+	 */
+	public function close($code = 0)
+	{
+		// See the constructor for details
+		if (!$this->allowedToClose)
+		{
+			return;
+		}
+
+		exit($code);
+	}
+
+	/**
+	 * Gets the name of the current running application.
+	 *
+	 * @return  string  The name of the application.
+	 *
+	 * @since   4.0.0
+	 */
+	public function getName()
+	{
+		return get_class($this);
+	}
+
+	/**
+	 * Get the menu object.
+	 *
+	 * @param   string  $name     The application name for the menu
+	 * @param   array   $options  An array of options to initialise the menu with
+	 *
+	 * @return  \Joomla\CMS\Menu\AbstractMenu|null  A AbstractMenu object or null if not set.
+	 *
+	 * @since   4.0.0
+	 */
+	public function getMenu($name = null, $options = [])
+	{
+		return null;
+	}
+
+	/**
+	 * Method to get the application session object.
+	 *
+	 * @return  SessionInterface  The session object
+	 *
+	 * @since   4.0.0
+	 */
+	public function getSession()
+	{
+		return $this->getContainer()->get('session.cli');
+	}
+
+}