XTAINJoomlaBundle.php

<?php
/**
 * This file is part of the XTAIN Joomla package.
 *
 * (c) Maximilian Ruta <mr@xtain.net>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace XTAIN\Bundle\JoomlaBundle;

use Doctrine\ORM\EntityManager;
use Symfony\Bundle\SecurityBundle\DependencyInjection\SecurityExtension;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\HttpKernel\Bundle\Bundle;
use XTAIN\Bundle\JoomlaBundle\Debug\ErrorHandler;
use XTAIN\Bundle\JoomlaBundle\DependencyInjection\Pass\AdminMenuCompilerPass;
use XTAIN\Bundle\JoomlaBundle\DependencyInjection\Pass\DoctrineCompilerPass;
use XTAIN\Bundle\JoomlaBundle\DependencyInjection\Pass\ModuleCompilerPass;
use XTAIN\Bundle\JoomlaBundle\DependencyInjection\Pass\OverrideCompilerPass;
use XTAIN\Bundle\JoomlaBundle\DependencyInjection\Pass\RoutingCompilerPass;
use XTAIN\Bundle\JoomlaBundle\Joomla\OverrideUtils;
use XTAIN\Bundle\JoomlaBundle\Library\Loader;
use XTAIN\Bundle\JoomlaBundle\Security\Factory\JoomlaFactory;

/**
 * Class XTAINJoomlaBundle
 *
 * @author  Maximilian Ruta <mr@xtain.net>
 * @package XTAIN\Bundle\JoomlaBundle
 */
class XTAINJoomlaBundle extends Bundle
{
    /**
     * @var string
     */
    const STOPWATCH_CATEGORY_NAME = 'joomla';

    /**
     * @var string
     */
    const STOPWATCH_PREFIX = 'joomla ';

    /**
     * @param ContainerBuilder $container
     *
     * @return void
     * @author Maximilian Ruta <mr@xtain.net>
     */
    public function build(ContainerBuilder $container)
    {
        parent::build($container);

        /** @var SecurityExtension $extension */
        $extension = $container->getExtension('security');
        $extension->addSecurityListenerFactory(new JoomlaFactory());

        $container->addCompilerPass(new DoctrineCompilerPass());
        $container->addCompilerPass(new OverrideCompilerPass());
        $container->addCompilerPass(new RoutingCompilerPass());
        $container->addCompilerPass(new ModuleCompilerPass());
        $container->addCompilerPass(new AdminMenuCompilerPass());
    }

    /**
     * @return void
     * @author Maximilian Ruta <mr@xtain.net>
     */
    protected function defineConstants()
    {
        // Defines.
        if (!defined('_JEXEC')) {
            define('_JEXEC', 1);
        }

        if (!defined('JSYMFONY')) {
            define('JSYMFONY', 1);
        }

        if (!defined('JPATH_ROOT')) {
            define('JPATH_ROOT', $this->container->getParameter('joomla.root_dir'));
        }

        if (!defined('JPATH_SITE')) {
            define('JPATH_SITE', JPATH_ROOT);
        }

        if (!defined('JPATH_CONFIGURATION')) {
            define('JPATH_CONFIGURATION', $this->container->getParameter('joomla.config_dir'));
        }

        if (!defined('JPATH_ADMINISTRATOR')) {
            define('JPATH_ADMINISTRATOR', JPATH_ROOT . DIRECTORY_SEPARATOR . 'administrator');
        }

        if (!defined('JPATH_LIBRARIES')) {
            define('JPATH_LIBRARIES', JPATH_ROOT . DIRECTORY_SEPARATOR . 'libraries');
        }

        if (!defined('JPATH_PLUGINS')) {
            define('JPATH_PLUGINS', JPATH_ROOT . DIRECTORY_SEPARATOR . 'plugins');
        }

        if (!defined('JPATH_INSTALLATION')) {
            define('JPATH_INSTALLATION', JPATH_ROOT . DIRECTORY_SEPARATOR . 'installation');
        }

        if (!defined('JPATH_MANIFESTS')) {
            define('JPATH_MANIFESTS', JPATH_ADMINISTRATOR . DIRECTORY_SEPARATOR . 'manifests');
        }

        if (!defined('JPATH_PLATFORM')) {
            define('JPATH_PLATFORM', JPATH_LIBRARIES);
        }
    }

    /**
     * @return void
     * @author Maximilian Ruta <mr@xtain.net>
     */
    protected function registerAutoloader()
    {
        $loader = $this->container->get('joomla.loader');
        $loader->setup();
    }

    /**
     * @return void
     * @author Maximilian Ruta <mr@xtain.net>
     */
    protected function bootstrapCms()
    {
        global $_PROFILER;

        Loader::addImportIgnore('phputf8.');

        // Register the library base path for CMS libraries.
        \JLoader::registerPrefix('J', JPATH_PLATFORM . '/cms', false, true);

        // Register the class aliases for Framework classes that have replaced their Platform equivilents
        require_once JPATH_LIBRARIES . '/classmap.php';

        // Define the Joomla version if not already defined.
        if (!defined('JVERSION')) {
            $jversion = new \JVersion;
            define('JVERSION', $jversion->getShortVersion());
        }

        // Ensure FOF autoloader included
        // needed for things like content versioning where we need to get an FOFTable Instance
        if (!class_exists('FOFAutoloaderFof')) {
            include_once JPATH_LIBRARIES . '/fof/include.php';
        }

        // Register a handler for uncaught exceptions that shows a pretty error page when possible
        set_exception_handler(['JErrorPage', 'render']);

        // Set up the message queue logger for web requests
        if (array_key_exists('REQUEST_METHOD', $_SERVER)) {
            \JLog::addLogger(['logger' => 'messagequeue'], \JLog::ALL, ['jerror']);
        }

        // Register JArrayHelper due to JRegistry moved to composer's vendor folder
        \JLoader::register('JArrayHelper', JPATH_PLATFORM . '/joomla/utilities/arrayhelper.php');

        // Register classes where the names have been changed to fit the autoloader rules
        // @deprecated  4.0
        \JLoader::register('JToolBar', JPATH_PLATFORM . '/cms/toolbar/toolbar.php');
        \JLoader::register('JButton', JPATH_PLATFORM . '/cms/toolbar/button.php');
        \JLoader::register('JInstallerComponent', JPATH_PLATFORM . '/cms/installer/adapter/component.php');
        \JLoader::register('JInstallerFile', JPATH_PLATFORM . '/cms/installer/adapter/file.php');
        \JLoader::register('JInstallerLanguage', JPATH_PLATFORM . '/cms/installer/adapter/language.php');
        \JLoader::register('JInstallerLibrary', JPATH_PLATFORM . '/cms/installer/adapter/library.php');
        \JLoader::register('JInstallerModule', JPATH_PLATFORM . '/cms/installer/adapter/module.php');
        \JLoader::register('JInstallerPackage', JPATH_PLATFORM . '/cms/installer/adapter/package.php');
        \JLoader::register('JInstallerPlugin', JPATH_PLATFORM . '/cms/installer/adapter/plugin.php');
        \JLoader::register('JInstallerTemplate', JPATH_PLATFORM . '/cms/installer/adapter/template.php');
        \JLoader::register('JExtension', JPATH_PLATFORM . '/cms/installer/extension.php');
        \JLoader::registerAlias('JAdministrator', 'JApplicationAdministrator');
        \JLoader::registerAlias('JSite', 'JApplicationSite');


        // Import filesystem and utilities classes since they aren't autoloaded
        jimport('joomla.filesystem.file');
        jimport('joomla.filesystem.folder');
        jimport('joomla.filesystem.path');
        jimport('joomla.utilities.arrayhelper');

        class_exists(\XTAIN\Bundle\JoomlaBundle\Library\CMS\Module\Helper::class);
    }

    /**
     * @return void
     * @author Maximilian Ruta <mr@xtain.net>
     */
    protected function bootstrapFramework()
    {
        // Joomla system checks.
        @ini_set('magic_quotes_runtime', 0);

        // System includes
        require_once JPATH_LIBRARIES . '/import.legacy.php';

        // Set system error handling
        \JError::setErrorHandling(E_NOTICE, 'message');
        \JError::setErrorHandling(E_WARNING, 'message');
        \JError::setErrorHandling(E_ERROR, 'callback', ['JError', 'customErrorPage']);

        // Bootstrap the CMS libraries.
        $this->bootstrapCms();

        // System profiler
        if (JDEBUG) {
            $_PROFILER = $this->container->get('joomla.profiler');
        }
    }

    /**
     * @return void
     * @author Maximilian Ruta <mr@xtain.net>
     */
    protected function registerAlias()
    {
    }

    /**
     * @return mixed|null
     * @author Maximilian Ruta <mr@xtain.net>
     */
    protected function getCurrentErrorHandler()
    {
        $handler = set_error_handler('var_dump', 0);
        restore_error_handler();

        return $handler;
    }

    /**
     * @return mixed|null
     * @author Maximilian Ruta <mr@xtain.net>
     */
    protected function getCurrentExceptionHandler()
    {
        $handler = set_exception_handler('var_dump');
        restore_exception_handler();

        return $handler;
    }

    /**
     * @return void
     * @author Maximilian Ruta <mr@xtain.net>
     */
    public function boot()
    {
        if (defined('JDEBUG')) {
            // dont boot bundle twice
            return;
        }

        if (!defined('JOMMLA_ERROR_LEVEL')) {
            define('JOMMLA_ERROR_LEVEL', E_ALL - E_DEPRECATED - E_USER_DEPRECATED - E_STRICT - E_NOTICE - E_WARNING);
        }

        $config = $this->container->get('joomla.config');
        define('JDEBUG', $config->debug);

        if ($this->container->has('debug.stopwatch')) {
            $stopwatch = $this->container->get('debug.stopwatch');
            $stopwatch->start(self::STOPWATCH_PREFIX . 'bootstrap', self::STOPWATCH_CATEGORY_NAME);
        }

        $errorHandler = $this->getCurrentErrorHandler();
        $exceptionHandler = $this->getCurrentExceptionHandler();

        $this->defineConstants();
        $this->registerAutoloader();

        \XTAIN\Bundle\JoomlaBundle\Library\Loader::injectStaticDependencies(ErrorHandler::class);

        $this->registerAlias();
        $this->bootstrapFramework();

        $this->container->get('joomla.database.driver.doctrine');

        // restore the symfony error handler
        if ($errorHandler !== null) {
            set_error_handler($errorHandler);
        }
        if ($exceptionHandler !== null) {
            set_exception_handler($exceptionHandler);
        }

        if ($this->container->has('debug.stopwatch')) {
            $stopwatch = $this->container->get('debug.stopwatch');
            $stopwatch->stop(self::STOPWATCH_PREFIX . 'bootstrap', self::STOPWATCH_CATEGORY_NAME);
        }
    }
}