<?php

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

namespace Joomla\CMS\MVC\Controller;

use Joomla\Application\AbstractApplication;
use Joomla\CMS\Application\CMSApplicationInterface;
use Joomla\CMS\Application\CMSWebApplicationInterface;
use Joomla\CMS\Cache\Exception\CacheExceptionInterface;
use Joomla\CMS\Document\DocumentAwareInterface;
use Joomla\CMS\Factory;
use Joomla\CMS\Filter\InputFilter;
use Joomla\CMS\Language\LanguageAwareInterface;
use Joomla\CMS\Language\Text;
use Joomla\CMS\Log\Log;
use Joomla\CMS\MVC\Factory\LegacyFactory;
use Joomla\CMS\MVC\Factory\MVCFactoryInterface;
use Joomla\CMS\MVC\Model\BaseDatabaseModel;
use Joomla\CMS\MVC\Model\BaseModel;
use Joomla\CMS\MVC\View\ViewInterface;
use Joomla\CMS\Session\Session;
use Joomla\CMS\Uri\Uri;
use Joomla\CMS\User\CurrentUserInterface;
use Joomla\Event\DispatcherAwareInterface;
use Joomla\Event\DispatcherAwareTrait;
use Joomla\Event\DispatcherInterface;
use Joomla\Filesystem\Path;
use Joomla\Input\Input;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * Base class for a Joomla Controller
 *
 * Controller (Controllers are where you put all the actual code.) Provides basic
 * functionality, such as rendering views (aka displaying templates).
 *
 * @since  2.5.5
 */
class BaseController implements ControllerInterface, DispatcherAwareInterface, LoggerAwareInterface
{
    use LoggerAwareTrait;
    use DispatcherAwareTrait;

    /**
     * The base path of the controller
     *
     * @var    string
     * @since  3.0
     */
    protected $basePath;

    /**
     * The default view for the display method.
     *
     * @var    string
     * @since  3.0
     */
    protected $default_view;

    /**
     * The mapped task that was performed.
     *
     * @var    string
     * @since  3.0
     */
    protected $doTask;

    /**
     * Redirect message.
     *
     * @var    string
     * @since  3.0
     */
    protected $message;

    /**
     * Redirect message type.
     *
     * @var    string
     * @since  3.0
     */
    protected $messageType;

    /**
     * Array of class methods
     *
     * @var    array
     * @since  3.0
     */
    protected $methods;

    /**
     * The name of the controller
     *
     * @var    string
     * @since  3.0
     */
    protected $name;

    /**
     * The prefix of the models
     *
     * @var    string
     * @since  3.0
     */
    protected $model_prefix;

    /**
     * The set of search directories for resources (views).
     *
     * @var    array
     * @since  3.0
     */
    protected $paths;

    /**
     * URL for redirection.
     *
     * @var    string
     * @since  3.0
     */
    protected $redirect;

    /**
     * Current or most recently performed task.
     *
     * @var    string
     * @since  3.0
     */
    protected $task;

    /**
     * Array of class methods to call for a given task.
     *
     * @var    array
     * @since  3.0
     */
    protected $taskMap;

    /**
     * Hold a JInput object for easier access to the input variables.
     *
     * @var    Input
     * @since  3.0
     */
    protected $input;

    /**
     * The factory.
     *
     * @var    MVCFactoryInterface
     * @since  3.10.0
     */
    protected $factory;

    /**
     * Instance container.
     *
     * @var    static
     * @since  3.0
     */
    protected static $instance;

    /**
     * Instance container containing the views.
     *
     * @var    ViewInterface[]
     * @since  3.4
     */
    protected static $views;

    /**
     * The Application
     *
     * @var    CMSApplicationInterface
     * @since  4.0.0
     */
    protected $app;

    /**
     * Adds to the stack of model paths in LIFO order.
     *
     * @param   mixed   $path    The directory (string), or list of directories (array) to add.
     * @param   string  $prefix  A prefix for models
     *
     * @return  void
     *
     * @since   3.0
     *
     * @deprecated  4.3 will be removed in 6.0
     *              Will be removed without replacement. Get the model through the MVCFactory instead
     */
    public static function addModelPath($path, $prefix = '')
    {
        BaseModel::addIncludePath($path, $prefix);
    }

    /**
     * Create the filename for a resource.
     *
     * @param   string  $type   The resource type to create the filename for.
     * @param   array   $parts  An associative array of filename information. Optional.
     *
     * @return  string  The filename.
     *
     * @since   3.0
     */
    public static function createFileName($type, $parts = [])
    {
        $filename = '';

        switch ($type) {
            case 'controller':
                if (!empty($parts['format'])) {
                    if ($parts['format'] === 'html') {
                        $parts['format'] = '';
                    } else {
                        $parts['format'] = '.' . $parts['format'];
                    }
                } else {
                    $parts['format'] = '';
                }

                $filename = strtolower($parts['name'] . $parts['format'] . '.php');
                break;

            case 'view':
                if (!empty($parts['type'])) {
                    $parts['type'] = '.' . $parts['type'];
                } else {
                    $parts['type'] = '';
                }

                $filename = strtolower($parts['name'] . '/view' . $parts['type'] . '.php');
                break;
        }

        return $filename;
    }

    /**
     * Method to get a singleton controller instance.
     *
     * @param   string  $prefix  The prefix for the controller.
     * @param   array   $config  An array of optional constructor options.
     *
     * @return  static
     *
     * @since       3.0
     *
     * @deprecated  4.3 will be removed in 6.0
     *              Get the controller through the MVCFactory instead
     *              Example: Factory::getApplication()->bootComponent($option)->getMVCFactory()->createController(...);
     *
     * @throws      \Exception if the controller cannot be loaded.
     */
    public static function getInstance($prefix, $config = [])
    {
        if (\is_object(self::$instance)) {
            return self::$instance;
        }

        @trigger_error(
            \sprintf(
                '%1$s::getInstance() is deprecated. Load it through the MVC factory.',
                self::class
            ),
            E_USER_DEPRECATED
        );

        $app   = Factory::getApplication();
        $input = $app->getInput();

        // Get the environment configuration.
        $basePath = \array_key_exists('base_path', $config) ? $config['base_path'] : JPATH_COMPONENT;
        $format   = $input->getWord('format');
        $command  = $input->get('task', 'display');

        // Check for array format.
        $filter = InputFilter::getInstance();

        if (\is_array($command)) {
            $keys    = array_keys($command);
            $command = $filter->clean(array_pop($keys), 'cmd');
        } else {
            $command = $filter->clean($command, 'cmd');
        }

        // Check for a controller.task command.
        if (strpos($command, '.') !== false) {
            // Explode the controller.task command.
            list($type, $task) = explode('.', $command);

            // Define the controller filename and path.
            $file       = self::createFileName('controller', ['name' => $type, 'format' => $format]);
            $path       = $basePath . '/controllers/' . $file;
            $backuppath = $basePath . '/controller/' . $file;

            // Reset the task without the controller context.
            $input->set('task', $task);
        } else {
            // Base controller.
            $type = '';

            // Define the controller filename and path.
            $file       = self::createFileName('controller', ['name' => 'controller', 'format' => $format]);
            $path       = $basePath . '/' . $file;
            $backupfile = self::createFileName('controller', ['name' => 'controller']);
            $backuppath = $basePath . '/' . $backupfile;
        }

        // Get the controller class name.
        $class = ucfirst($prefix) . 'Controller' . ucfirst($type);

        // Include the class if not present.
        if (!class_exists($class)) {
            // If the controller file path exists, include it.
            if (is_file($path)) {
                require_once $path;
            } elseif (isset($backuppath) && is_file($backuppath)) {
                require_once $backuppath;
            } else {
                throw new \InvalidArgumentException(Text::sprintf('JLIB_APPLICATION_ERROR_INVALID_CONTROLLER', $type, $format));
            }
        }

        // Instantiate the class.
        if (!class_exists($class)) {
            throw new \InvalidArgumentException(Text::sprintf('JLIB_APPLICATION_ERROR_INVALID_CONTROLLER_CLASS', $class));
        }

        // Check for a possible service from the container otherwise manually instantiate the class
        if (Factory::getContainer()->has($class)) {
            self::$instance = Factory::getContainer()->get($class);
        } else {
            self::$instance = new $class($config, null, $app, $input);
        }

        return self::$instance;
    }

    /**
     * Constructor.
     *
     * @param   array                     $config   An optional associative array of configuration settings.
     *                                              Recognized key values include 'name', 'default_task',
     *                                              'model_path', and 'view_path' (this list is not meant to be
     *                                              comprehensive).
     * @param   ?MVCFactoryInterface      $factory  The factory.
     * @param   ?CMSApplicationInterface  $app      The Application for the dispatcher
     * @param   ?Input                    $input    Input
     *
     * @since   3.0
     */
    public function __construct($config = [], ?MVCFactoryInterface $factory = null, ?CMSApplicationInterface $app = null, ?Input $input = null)
    {
        $this->methods     = [];
        $this->message     = null;
        $this->messageType = 'message';
        $this->paths       = [];
        $this->redirect    = null;
        $this->taskMap     = [];

        $this->app   = $app ?: Factory::getApplication();
        $this->input = $input ?: $this->app->getInput();

        /**
         * @deprecated This is to maintain b/c with the J4.0 implementation of BaseController. In Joomla 6.0 this will be
         *             removed and instead the logger should be injected by the MVCFactory using
         *             BaseController::setLogger()
         */
        if ($this->app instanceof AbstractApplication) {
            $this->setLogger($this->app->getLogger());
        }

        if (\defined('JDEBUG') && JDEBUG) {
            Log::addLogger(['text_file' => 'jcontroller.log.php'], Log::ALL, ['controller']);
        }

        // Determine the methods to exclude from the base class.
        $xMethods = get_class_methods('\\Joomla\\CMS\\MVC\\Controller\\BaseController');

        // Get the public methods in this class using reflection.
        $r        = new \ReflectionClass($this);
        $rMethods = $r->getMethods(\ReflectionMethod::IS_PUBLIC);

        foreach ($rMethods as $rMethod) {
            $mName = $rMethod->getName();

            // Add default display method if not explicitly declared.
            if ($mName === 'display' || !\in_array($mName, $xMethods)) {
                $this->methods[] = strtolower($mName);

                // Auto register the methods as tasks.
                $this->taskMap[strtolower($mName)] = $mName;
            }
        }

        // Set the view name
        if (empty($this->name)) {
            if (\array_key_exists('name', $config)) {
                $this->name = $config['name'];
            } else {
                $this->name = $this->getName();
            }
        }

        // Set a base path for use by the controller
        if (\array_key_exists('base_path', $config)) {
            $this->basePath = $config['base_path'];
        } else {
            $this->basePath = JPATH_COMPONENT;
        }

        // If the default task is set, register it as such
        if (\array_key_exists('default_task', $config)) {
            $this->registerDefaultTask($config['default_task']);
        } else {
            $this->registerDefaultTask('display');
        }

        // Set the models prefix
        if (empty($this->model_prefix)) {
            if (\array_key_exists('model_prefix', $config)) {
                // User-defined prefix
                $this->model_prefix = $config['model_prefix'];
            } else {
                $this->model_prefix = ucfirst($this->name) . 'Model';
            }
        }

        // Set the default model search path
        if (\array_key_exists('model_path', $config)) {
            // User-defined dirs
            static::addModelPath($config['model_path'], $this->model_prefix);
        } else {
            static::addModelPath($this->basePath . '/models', $this->model_prefix);
        }

        // Set the default view search path
        if (\array_key_exists('view_path', $config)) {
            // User-defined dirs
            $this->setPath('view', $config['view_path']);
        } else {
            $this->setPath('view', $this->basePath . '/views');
        }

        // Set the default view.
        if (\array_key_exists('default_view', $config)) {
            $this->default_view = $config['default_view'];
        } elseif (empty($this->default_view)) {
            $this->default_view = $this->getName();
        }

        $this->factory = $factory ?: new LegacyFactory();
    }

    /**
     * Adds to the search path for templates and resources.
     *
     * @param   string  $type  The path type (e.g. 'model', 'view').
     * @param   mixed   $path  The directory string  or stream array to search.
     *
     * @return  static  A BaseController object to support chaining.
     *
     * @since   3.0
     */
    protected function addPath($type, $path)
    {
        if (!isset($this->paths[$type])) {
            $this->paths[$type] = [];
        }

        // Loop through the path directories
        foreach ((array) $path as $dir) {
            // No surrounding spaces allowed!
            $dir = rtrim(Path::check($dir), '/') . '/';

            // Add to the top of the search dirs
            array_unshift($this->paths[$type], $dir);
        }

        return $this;
    }

    /**
     * Add one or more view paths to the controller's stack, in LIFO order.
     *
     * @param   mixed  $path  The directory (string) or list of directories (array) to add.
     *
     * @return  static  This object to support chaining.
     *
     * @since   3.0
     */
    public function addViewPath($path)
    {
        return $this->addPath('view', $path);
    }

    /**
     * Method to check whether an ID is in the edit list.
     *
     * @param   string   $context  The context for the session storage.
     * @param   integer  $id       The ID of the record to add to the edit list.
     *
     * @return  boolean  True if the ID is in the edit list.
     *
     * @since   3.0
     */
    protected function checkEditId($context, $id)
    {
        if (!($this->app instanceof CMSWebApplicationInterface)) {
            throw new \Exception(
                \sprintf(
                    'The %s method requires an instance of %s but instead %s was supplied',
                    __METHOD__,
                    CMSWebApplicationInterface::class,
                    \get_class($this->app)
                )
            );
        }

        if ($id) {
            $values = (array) $this->app->getUserState($context . '.id');

            $result = \in_array((int) $id, $values);

            if (\defined('JDEBUG') && JDEBUG) {
                $this->getLogger()->info(
                    \sprintf(
                        'Checking edit ID %s.%s: %d %s',
                        $context,
                        $id,
                        (int) $result,
                        str_replace("\n", ' ', print_r($values, 1))
                    ),
                    ['category' => 'controller']
                );
            }

            return $result;
        }

        // No id for a new item.
        return true;
    }

    /**
     * Method to load and return a model object.
     *
     * @param   string  $name    The name of the model.
     * @param   string  $prefix  Optional model prefix.
     * @param   array   $config  Configuration array for the model. Optional.
     *
     * @return  BaseDatabaseModel|boolean   Model object on success; otherwise false on failure.
     *
     * @since   3.0
     */
    protected function createModel($name, $prefix = '', $config = [])
    {
        $model = $this->factory->createModel($name, $prefix, $config);

        if ($model === null) {
            return false;
        }

        if ($model instanceof CurrentUserInterface && $this->app->getIdentity()) {
            $model->setCurrentUser($this->app->getIdentity());
        }

        return $model;
    }

    /**
     * Method to load and return a view object. This method first looks in the
     * current template directory for a match and, failing that, uses a default
     * set path to load the view class file.
     *
     * Note the "name, prefix, type" order of parameters, which differs from the
     * "name, type, prefix" order used in related public methods.
     *
     * @param   string  $name    The name of the view.
     * @param   string  $prefix  Optional prefix for the view class name.
     * @param   string  $type    The type of view.
     * @param   array   $config  Configuration array for the view. Optional.
     *
     * @return  ViewInterface|null  View object on success; null or error result on failure.
     *
     * @since   3.0
     * @throws  \Exception
     */
    protected function createView($name, $prefix = '', $type = '', $config = [])
    {
        $config['paths'] = $this->paths['view'];

        $view = $this->factory->createView($name, $prefix, $type, $config);

        if ($view instanceof CurrentUserInterface && $this->app->getIdentity()) {
            $view->setCurrentUser($this->app->getIdentity());
        }

        if ($view instanceof LanguageAwareInterface && $this->app->getLanguage()) {
            $view->setLanguage($this->app->getLanguage());
        }

        return $view;
    }

    /**
     * Typical view method for MVC based architecture
     *
     * This function is provide as a default implementation, in most cases
     * you will need to override it in your own controllers.
     *
     * @param   boolean  $cachable   If true, the view output will be cached
     * @param   array    $urlparams  An array of safe url parameters and their variable types.
     *                   @see        \Joomla\CMS\Filter\InputFilter::clean() for valid values.
     *
     * @return  static  A \JControllerLegacy object to support chaining.
     *
     * @since   3.0
     * @throws  \Exception
     */
    public function display($cachable = false, $urlparams = [])
    {
        if (!($this->app instanceof CMSWebApplicationInterface)) {
            throw new \Exception(
                \sprintf(
                    'The %s method requires an instance of %s but instead %s was supplied',
                    __METHOD__,
                    CMSWebApplicationInterface::class,
                    \get_class($this->app)
                )
            );
        }

        $document   = $this->app->getDocument();
        $viewType   = $document->getType();
        $viewName   = $this->input->get('view', $this->default_view);
        $viewLayout = $this->input->get('layout', 'default', 'string');

        $view = $this->getView($viewName, $viewType, '', ['base_path' => $this->basePath, 'layout' => $viewLayout]);

        // Set models for the View
        $this->prepareViewModel($view);

        if ($view instanceof DocumentAwareInterface && $document) {
            $view->setDocument($this->app->getDocument());
        } else {
            @trigger_error(
                'View should implement document aware interface.',
                E_USER_DEPRECATED
            );
            $view->document = $document;
        }

        // Display the view
        if ($cachable && $viewType !== 'feed' && $this->app->get('caching') >= 1) {
            $option = $this->input->get('option');

            if (\is_array($urlparams)) {
                if (!empty($this->app->registeredurlparams)) {
                    $registeredurlparams = $this->app->registeredurlparams;
                } else {
                    $registeredurlparams = new \stdClass();
                }

                foreach ($urlparams as $key => $value) {
                    // Add your safe URL parameters with variable type as value {@see InputFilter::clean()}.
                    $registeredurlparams->$key = $value;
                }

                $this->app->registeredurlparams = $registeredurlparams;
            }

            try {
                /** @var \Joomla\CMS\Cache\Controller\ViewController $cache */
                $cache = Factory::getCache($option, 'view');
                $cache->get($view, 'display');
            } catch (CacheExceptionInterface $exception) {
                $view->display();
            }
        } else {
            $view->display();
        }

        return $this;
    }

    /**
     * Execute a task by triggering a method in the derived class.
     *
     * @param   string  $task  The task to perform. If no matching task is found, the '__default' task is executed, if defined.
     *
     * @return  mixed   The value returned by the called method.
     *
     * @since   3.0
     * @throws  \Exception
     */
    public function execute($task)
    {
        $this->task = $task;

        $task = strtolower((string) $task);

        if (isset($this->taskMap[$task])) {
            $doTask = $this->taskMap[$task];
        } elseif (isset($this->taskMap['__default'])) {
            $doTask = $this->taskMap['__default'];
        } else {
            throw new \Exception(Text::sprintf('JLIB_APPLICATION_ERROR_TASK_NOT_FOUND', $task), 404);
        }

        // Record the actual task being fired
        $this->doTask = $doTask;

        return $this->$doTask();
    }

    /**
     * Method to get a model object, loading it if required.
     *
     * @param   string  $name    The model name. Optional.
     * @param   string  $prefix  The class prefix. Optional.
     * @param   array   $config  Configuration array for model. Optional.
     *
     * @return  BaseDatabaseModel|boolean  Model object on success; otherwise false on failure.
     *
     * @since   3.0
     */
    public function getModel($name = '', $prefix = '', $config = [])
    {
        if (empty($name)) {
            $name = $this->getName();
        }

        if (!$prefix) {
            if ($this->factory instanceof LegacyFactory) {
                $prefix = $this->model_prefix;
            } elseif (!empty($config['base_path']) && strpos(Path::clean($config['base_path']), JPATH_ADMINISTRATOR) === 0) {
                // When the frontend uses an administrator model
                $prefix = 'Administrator';
            } else {
                $prefix = $this->app->getName();
            }
        }

        if ($model = $this->createModel($name, $prefix, $config)) {
            // Task is a reserved state
            $model->setState('task', $this->task);

            // We don't have the concept on a menu tree in the api app, so skip setting it's information and
            // return early
            if ($this->app->isClient('api')) {
                return $model;
            }

            if ($this->app instanceof CMSWebApplicationInterface) {
                // Let's get the application object and set menu information if it's available
                $menu = $this->app->getMenu();

                if (\is_object($menu) && $item = $menu->getActive()) {
                    // Let's get the application object and set menu information if it's available
                    $menu = $this->app->getMenu();

                    if (\is_object($menu) && $item = $menu->getActive()) {
                        $params = $menu->getParams($item->id);

                        // Set default state data
                        $model->setState('parameters.menu', $params);
                    }
                }
            }
        }

        return $model;
    }

    /**
     * Method to get the controller name
     *
     * The dispatcher name is set by default parsed using the classname, or it can be set
     * by passing a $config['name'] in the class constructor
     *
     * @return  string  The name of the dispatcher
     *
     * @since   3.0
     * @throws  \Exception
     */
    public function getName()
    {
        if (empty($this->name)) {
            $r = null;

            if (!preg_match('/(.*)Controller/i', \get_class($this), $r)) {
                throw new \Exception(Text::sprintf('JLIB_APPLICATION_ERROR_GET_NAME', __METHOD__), 500);
            }

            $this->name = strtolower($r[1]);
        }

        return $this->name;
    }

    /**
     * Get the last task that is being performed or was most recently performed.
     *
     * @return  string  The task that is being performed or was most recently performed.
     *
     * @since   3.0
     */
    public function getTask()
    {
        return $this->task;
    }

    /**
     * Gets the available tasks in the controller.
     *
     * @return  array  Array[i] of task names.
     *
     * @since   3.0
     */
    public function getTasks()
    {
        return $this->methods;
    }

    /**
     * Method to get a reference to the current view and load it if necessary.
     *
     * @param   string  $name    The view name. Optional, defaults to the controller name.
     * @param   string  $type    The view type. Optional.
     * @param   string  $prefix  The class prefix. Optional.
     * @param   array   $config  Configuration array for view. Optional.
     *
     * @return  ViewInterface  Reference to the view or an error.
     *
     * @since   3.0
     * @throws  \Exception
     */
    public function getView($name = '', $type = '', $prefix = '', $config = [])
    {
        // @note We use self so we only access stuff in this class rather than in all classes.
        if (!isset(self::$views)) {
            self::$views = [];
        }

        if (empty($name)) {
            $name = $this->getName();
        }

        if (!$prefix) {
            if ($this->factory instanceof LegacyFactory) {
                $prefix = $this->getName() . 'View';
            } elseif (!empty($config['base_path']) && strpos(Path::clean($config['base_path']), JPATH_ADMINISTRATOR) === 0) {
                // When the front uses an administrator view
                $prefix = 'Administrator';
            } else {
                $prefix = $this->app->getName();
            }
        }

        if (empty(self::$views[$name][$type][$prefix])) {
            if ($view = $this->createView($name, $prefix, $type, $config)) {
                self::$views[$name][$type][$prefix] = &$view;
            } else {
                throw new \Exception(Text::sprintf('JLIB_APPLICATION_ERROR_VIEW_NOT_FOUND', $name, $type, $prefix), 404);
            }
        }

        return self::$views[$name][$type][$prefix];
    }

    /**
     * Method to add a record ID to the edit list.
     *
     * @param   string   $context  The context for the session storage.
     * @param   integer  $id       The ID of the record to add to the edit list.
     *
     * @return  void
     *
     * @since   3.0
     * @throws  \Exception
     */
    protected function holdEditId($context, $id)
    {
        if (!($this->app instanceof CMSWebApplicationInterface)) {
            throw new \Exception(
                \sprintf(
                    'The %s method requires an instance of %s but instead %s was supplied',
                    __METHOD__,
                    CMSWebApplicationInterface::class,
                    \get_class($this->app)
                )
            );
        }

        $values = (array) $this->app->getUserState($context . '.id');

        // Add the id to the list if non-zero.
        if (!empty($id)) {
            $values[] = (int) $id;
            $values   = array_unique($values);
            $this->app->setUserState($context . '.id', $values);

            if (\defined('JDEBUG') && JDEBUG) {
                $this->getLogger()->info(
                    \sprintf(
                        'Holding edit ID %s.%s %s',
                        $context,
                        $id,
                        str_replace("\n", ' ', print_r($values, 1))
                    ),
                    ['category' => 'controller']
                );
            }
        }
    }

    /**
     * Redirects the browser or returns false if no redirect is set.
     *
     * @return  boolean  False if no redirect exists.
     *
     * @since   3.0
     * @throws  \Exception
     */
    public function redirect()
    {
        if (!($this->app instanceof CMSWebApplicationInterface)) {
            throw new \Exception(
                \sprintf(
                    'The %s method requires an instance of %s but instead %s was supplied',
                    __METHOD__,
                    CMSWebApplicationInterface::class,
                    \get_class($this->app)
                )
            );
        }

        if ($this->redirect) {
            // Enqueue the redirect message
            $this->app->enqueueMessage($this->message, $this->messageType);

            // Execute the redirect
            $this->app->redirect($this->redirect);
        }

        return false;
    }

    /**
     * Register the default task to perform if a mapping is not found.
     *
     * @param   string  $method  The name of the method in the derived class to perform if a named task is not found.
     *
     * @return  static  A \JControllerLegacy object to support chaining.
     *
     * @since   3.0
     */
    public function registerDefaultTask($method)
    {
        $this->registerTask('__default', $method);

        return $this;
    }

    /**
     * Register (map) a task to a method in the class.
     *
     * @param   string  $task    The task.
     * @param   string  $method  The name of the method in the derived class to perform for this task.
     *
     * @return  static  A \JControllerLegacy object to support chaining.
     *
     * @since   3.0
     */
    public function registerTask($task, $method)
    {
        if (\in_array(strtolower($method), $this->methods)) {
            $this->taskMap[strtolower($task)] = $method;
        }

        return $this;
    }

    /**
     * Unregister (unmap) a task in the class.
     *
     * @param   string  $task  The task.
     *
     * @return  static  This object to support chaining.
     *
     * @since   3.0
     */
    public function unregisterTask($task)
    {
        unset($this->taskMap[strtolower($task)]);

        return $this;
    }

    /**
     * Method to check whether an ID is in the edit list.
     *
     * @param   string   $context  The context for the session storage.
     * @param   integer  $id       The ID of the record to add to the edit list.
     *
     * @return  void
     *
     * @since   3.0
     * @throws  \Exception
     */
    protected function releaseEditId($context, $id)
    {
        if (!($this->app instanceof CMSWebApplicationInterface)) {
            throw new \Exception(
                \sprintf(
                    'The %s method requires an instance of %s but instead %s was supplied',
                    __METHOD__,
                    CMSWebApplicationInterface::class,
                    \get_class($this->app)
                )
            );
        }

        $values = (array) $this->app->getUserState($context . '.id');

        // Do a strict search of the edit list values.
        $index = array_search((int) $id, $values, true);

        if (\is_int($index)) {
            unset($values[$index]);
            $this->app->setUserState($context . '.id', $values);

            if (\defined('JDEBUG') && JDEBUG) {
                $this->getLogger()->info(
                    \sprintf(
                        'Releasing edit ID %s.%s %s',
                        $context,
                        $id,
                        str_replace("\n", ' ', print_r($values, 1))
                    ),
                    ['category' => 'controller']
                );
            }
        }
    }

    /**
     * Get the logger.
     *
     * @return  LoggerInterface
     *
     * @since   5.0.0
     */
    protected function getLogger()
    {
        // If a logger hasn't been set, use NullLogger
        if (!($this->logger instanceof LoggerInterface)) {
            $this->setLogger(new NullLogger());
        }

        return $this->logger;
    }

    /**
     * Sets the internal message that is passed with a redirect
     *
     * @param   string  $text  Message to display on redirect.
     * @param   string  $type  Message type. Optional, defaults to 'message'.
     *
     * @return  string  Previous message
     *
     * @since   3.0
     */
    public function setMessage($text, $type = 'message')
    {
        $previous          = $this->message;
        $this->message     = $text;
        $this->messageType = $type;

        return $previous;
    }

    /**
     * Sets an entire array of search paths for resources.
     *
     * @param   string  $type  The type of path to set, typically 'view' or 'model'.
     * @param   string  $path  The new set of search paths. If null or false, resets to the current directory only.
     *
     * @return  void
     *
     * @since   3.0
     */
    protected function setPath($type, $path)
    {
        // Clear out the prior search dirs
        $this->paths[$type] = [];

        // Actually add the user-specified directories
        $this->addPath($type, $path);
    }

    /**
     * Checks for a form token in the request.
     *
     * Use in conjunction with HTMLHelper::_('form.token') or Session::getFormToken.
     *
     * @param   string   $method    The request method in which to look for the token key.
     * @param   boolean  $redirect  Whether to implicitly redirect user to the referrer page on failure or simply return false.
     *
     * @return  boolean  True if found and valid, otherwise return false or redirect to referrer page.
     *
     * @since   3.7.0
     * @throws  \Exception
     * @see     Session::checkToken()
     */
    public function checkToken($method = 'post', $redirect = true)
    {
        if (!($this->app instanceof CMSWebApplicationInterface)) {
            throw new \Exception(
                \sprintf(
                    'The %s method requires an instance of %s but instead %s was supplied',
                    __METHOD__,
                    CMSWebApplicationInterface::class,
                    \get_class($this->app)
                )
            );
        }

        $valid = Session::checkToken($method);

        if (!$valid && $redirect) {
            $referrer = $this->input->server->getString('HTTP_REFERER');

            if (\is_null($referrer) || !Uri::isInternal($referrer)) {
                $referrer = 'index.php';
            }

            $this->app->enqueueMessage(Text::_('JINVALID_TOKEN_NOTICE'), CMSWebApplicationInterface::MSG_WARNING);
            $this->app->redirect($referrer);
        }

        return $valid;
    }

    /**
     * Set a URL for browser redirection.
     *
     * @param   string  $url   URL to redirect to.
     * @param   string  $msg   Message to display on redirect. Optional, defaults to value set internally by controller, if any.
     * @param   string  $type  Message type. Optional, defaults to 'message' or the type set by a previous call to setMessage.
     *
     * @return  static  This object to support chaining.
     *
     * @since   3.0
     */
    public function setRedirect($url, $msg = null, $type = null)
    {
        $this->redirect = $url;

        if ($msg !== null) {
            // Controller may have set this directly
            $this->message = $msg;
        }

        // Ensure the type is not overwritten by a previous call to setMessage.
        if (empty($type)) {
            if (empty($this->messageType)) {
                $this->messageType = 'message';
            }
        } else {
            // If the type is explicitly set, set it.
            $this->messageType = $type;
        }

        return $this;
    }

    /**
     * Method to set the View Models
     *
     * This function is provided as a default implementation,
     * and only set one Model in the view (that with the same prefix/sufix than the view).
     * In case you want to set several Models for your view,
     * you will need to override it in your DisplayController controller.
     *
     * @param   ViewInterface  $view  The view Object
     *
     * @return  void
     *
     * @since   5.0.0
     */
    protected function prepareViewModel(ViewInterface $view)
    {
        if (!method_exists($view, 'setModel')) {
            return;
        }

        $viewName = $view->getName();

        // Get/Create the model
        if ($model = $this->getModel($viewName, '', ['base_path' => $this->basePath])) {
            // Push the model into the view (as default)
            $view->setModel($model, true);
        }
    }

    /**
     * Get the event dispatcher.
     *
     * The override was made to keep a backward compatibility for legacy component.
     * TODO: Remove the override in 6.0
     *
     * @return  DispatcherInterface
     *
     * @since   4.4.0
     * @throws  \UnexpectedValueException May be thrown if the dispatcher has not been set.
     */
    public function getDispatcher()
    {
        if (!$this->dispatcher) {
            @trigger_error(
                \sprintf('Dispatcher for %s should be set through MVC factory. It will throw an exception in 6.0', __CLASS__),
                E_USER_DEPRECATED
            );

            return $this->app->getDispatcher();
        }

        return $this->dispatcher;
    }
}
