<?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\MVC\Factory;

use Joomla\CMS\Application\CMSApplicationInterface;
use Joomla\CMS\Cache\CacheControllerFactoryAwareInterface;
use Joomla\CMS\Cache\CacheControllerFactoryAwareTrait;
use Joomla\CMS\Factory;
use Joomla\CMS\Form\FormFactoryAwareInterface;
use Joomla\CMS\Form\FormFactoryAwareTrait;
use Joomla\CMS\Mail\MailerFactoryAwareInterface;
use Joomla\CMS\Mail\MailerFactoryAwareTrait;
use Joomla\CMS\MVC\Model\ModelInterface;
use Joomla\CMS\Router\SiteRouterAwareInterface;
use Joomla\CMS\Router\SiteRouterAwareTrait;
use Joomla\CMS\User\UserFactoryAwareInterface;
use Joomla\CMS\User\UserFactoryAwareTrait;
use Joomla\Database\DatabaseAwareInterface;
use Joomla\Database\DatabaseAwareTrait;
use Joomla\Database\DatabaseInterface;
use Joomla\Database\Exception\DatabaseNotFoundException;
use Joomla\Event\DispatcherAwareInterface;
use Joomla\Event\DispatcherAwareTrait;
use Joomla\Input\Input;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;

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

/**
 * Factory to create MVC objects based on a namespace.
 *
 * @since  3.10.0
 */
class MVCFactory implements MVCFactoryInterface, FormFactoryAwareInterface, SiteRouterAwareInterface, UserFactoryAwareInterface, MailerFactoryAwareInterface
{
    use FormFactoryAwareTrait;
    use DispatcherAwareTrait;
    use DatabaseAwareTrait;
    use SiteRouterAwareTrait;
    use CacheControllerFactoryAwareTrait;
    use UserFactoryAwareTrait;
    use MailerFactoryAwareTrait;

    /**
     * The namespace to create the objects from.
     *
     * @var    string
     * @since  4.0.0
     */
    private $namespace;

    /**
     * The namespace to create the objects from.
     *
     * @var    LoggerInterface
     * @since  4.0.0
     */
    private $logger;

    /**
     * The namespace must be like:
     * Joomla\Component\Content
     *
     * @param   string            $namespace  The namespace
     * @param   ?LoggerInterface  $logger     A logging instance to inject into the controller if required
     *
     * @since   4.0.0
     */
    public function __construct($namespace, ?LoggerInterface $logger = null)
    {
        $this->namespace = $namespace;
        $this->logger    = $logger;
    }

    /**
     * Method to load and return a controller object.
     *
     * @param   string                   $name    The name of the controller
     * @param   string                   $prefix  The controller prefix
     * @param   array                    $config  The configuration array for the controller
     * @param   CMSApplicationInterface  $app     The app
     * @param   Input                    $input   The input
     *
     * @return  \Joomla\CMS\MVC\Controller\ControllerInterface|null
     *
     * @since   3.10.0
     * @throws  \Exception
     */
    public function createController($name, $prefix, array $config, CMSApplicationInterface $app, Input $input)
    {
        // Clean the parameters
        $name   = preg_replace('/[^A-Z0-9_]/i', '', $name);
        $prefix = preg_replace('/[^A-Z0-9_]/i', '', $prefix);

        $className = $this->getClassName('Controller\\' . ucfirst($name) . 'Controller', $prefix);

        if (!$className) {
            return null;
        }

        $controller = new $className($config, $this, $app, $input);
        $this->setFormFactoryOnObject($controller);
        $this->setDispatcherOnObject($controller);
        $this->setRouterOnObject($controller);
        $this->setCacheControllerOnObject($controller);
        $this->setUserFactoryOnObject($controller);
        $this->setMailerFactoryOnObject($controller);

        if ($controller instanceof LoggerAwareInterface && $this->logger !== null) {
            $controller->setLogger($this->logger);
        }

        return $controller;
    }

    /**
     * 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  Optional configuration array for the model.
     *
     * @return  ModelInterface  The model object
     *
     * @since   3.10.0
     * @throws  \Exception
     */
    public function createModel($name, $prefix = '', array $config = [])
    {
        // Clean the parameters
        $name   = preg_replace('/[^A-Z0-9_]/i', '', $name);
        $prefix = preg_replace('/[^A-Z0-9_]/i', '', $prefix);

        if (!$prefix) {
            @trigger_error(
                \sprintf(
                    'Calling %s() without a prefix is deprecated.',
                    __METHOD__
                ),
                E_USER_DEPRECATED
            );

            $prefix = Factory::getApplication()->getName();
        }

        $className = $this->getClassName('Model\\' . ucfirst($name) . 'Model', $prefix);

        if (!$className) {
            return null;
        }

        $model = new $className($config, $this);
        $this->setFormFactoryOnObject($model);
        $this->setDispatcherOnObject($model);
        $this->setRouterOnObject($model);
        $this->setCacheControllerOnObject($model);
        $this->setUserFactoryOnObject($model);
        $this->setMailerFactoryOnObject($model);

        if ($model instanceof DatabaseAwareInterface) {
            try {
                $model->setDatabase($this->getDatabase());
            } catch (DatabaseNotFoundException $e) {
                @trigger_error(\sprintf('Database must be set, this will not be caught anymore in 5.0.'), E_USER_DEPRECATED);
                $model->setDatabase(Factory::getContainer()->get(DatabaseInterface::class));
            }
        }

        return $model;
    }

    /**
     * Method to load and return a view object.
     *
     * @param   string  $name    The name of the view.
     * @param   string  $prefix  Optional view prefix.
     * @param   string  $type    Optional type of view.
     * @param   array   $config  Optional configuration array for the view.
     *
     * @return  \Joomla\CMS\MVC\View\ViewInterface  The view object
     *
     * @since   3.10.0
     * @throws  \Exception
     */
    public function createView($name, $prefix = '', $type = '', array $config = [])
    {
        // Clean the parameters
        $name   = preg_replace('/[^A-Z0-9_]/i', '', $name);
        $prefix = preg_replace('/[^A-Z0-9_]/i', '', $prefix);
        $type   = preg_replace('/[^A-Z0-9_]/i', '', $type);

        if (!$prefix) {
            @trigger_error(
                \sprintf(
                    'Calling %s() without a prefix is deprecated.',
                    __METHOD__
                ),
                E_USER_DEPRECATED
            );

            $prefix = Factory::getApplication()->getName();
        }

        $className = $this->getClassName('View\\' . ucfirst($name) . '\\' . ucfirst($type) . 'View', $prefix);

        if (!$className) {
            return null;
        }

        $view = new $className($config);
        $this->setFormFactoryOnObject($view);
        $this->setDispatcherOnObject($view);
        $this->setRouterOnObject($view);
        $this->setCacheControllerOnObject($view);
        $this->setUserFactoryOnObject($view);

        return $view;
    }

    /**
     * Method to load and return a table object.
     *
     * @param   string  $name    The name of the table.
     * @param   string  $prefix  Optional table prefix.
     * @param   array   $config  Optional configuration array for the table.
     *
     * @return  \Joomla\CMS\Table\Table  The table object
     *
     * @since   3.10.0
     * @throws  \Exception
     */
    public function createTable($name, $prefix = '', array $config = [])
    {
        // Clean the parameters
        $name   = preg_replace('/[^A-Z0-9_]/i', '', $name);
        $prefix = preg_replace('/[^A-Z0-9_]/i', '', $prefix);

        if (!$prefix) {
            @trigger_error(
                \sprintf(
                    'Calling %s() without a prefix is deprecated.',
                    __METHOD__
                ),
                E_USER_DEPRECATED
            );

            $prefix = Factory::getApplication()->getName();
        }

        $className = $this->getClassName('Table\\' . ucfirst($name) . 'Table', $prefix)
            ?: $this->getClassName('Table\\' . ucfirst($name) . 'Table', 'Administrator');

        if (!$className) {
            return null;
        }

        try {
            $db = \array_key_exists('dbo', $config) ? $config['dbo'] : $this->getDatabase();
        } catch (DatabaseNotFoundException $e) {
            @trigger_error(\sprintf('Database must be set, this will not be caught anymore in 5.0.'), E_USER_DEPRECATED);
            $db = Factory::getContainer()->get(DatabaseInterface::class);
        }

        $table = new $className($db);

        $this->setUserFactoryOnObject($table);

        return $table;
    }

    /**
     * Returns a standard classname, if the class doesn't exist null is returned.
     *
     * @param   string  $suffix  The suffix
     * @param   string  $prefix  The prefix
     *
     * @return  string|null  The class name
     *
     * @since   3.10.0
     */
    protected function getClassName(string $suffix, string $prefix)
    {
        if (!$prefix) {
            $prefix = Factory::getApplication();
        }

        $className = trim($this->namespace, '\\') . '\\' . ucfirst($prefix) . '\\' . $suffix;

        if (!class_exists($className)) {
            return null;
        }

        return $className;
    }

    /**
     * Sets the internal form factory on the given object.
     *
     * @param   object  $object  The object
     *
     * @return  void
     *
     * @since   4.0.0
     */
    private function setFormFactoryOnObject($object)
    {
        if (!$object instanceof FormFactoryAwareInterface) {
            return;
        }

        try {
            $object->setFormFactory($this->getFormFactory());
        } catch (\UnexpectedValueException $e) {
            // Ignore it
        }
    }

    /**
     * Sets the internal event dispatcher on the given object.
     *
     * @param   object  $object  The object
     *
     * @return  void
     *
     * @since   4.2.0
     */
    private function setDispatcherOnObject($object)
    {
        if (!$object instanceof DispatcherAwareInterface) {
            return;
        }

        try {
            $object->setDispatcher($this->getDispatcher());
        } catch (\UnexpectedValueException $e) {
            // Ignore it
        }
    }

    /**
     * Sets the internal router on the given object.
     *
     * @param   object  $object  The object
     *
     * @return  void
     *
     * @since   4.2.0
     */
    private function setRouterOnObject($object): void
    {
        if (!$object instanceof SiteRouterAwareInterface) {
            return;
        }

        try {
            $object->setSiteRouter($this->getSiteRouter());
        } catch (\UnexpectedValueException $e) {
            // Ignore it
        }
    }

    /**
     * Sets the internal cache controller on the given object.
     *
     * @param   object  $object  The object
     *
     * @return  void
     *
     * @since   4.2.0
     */
    private function setCacheControllerOnObject($object): void
    {
        if (!$object instanceof CacheControllerFactoryAwareInterface) {
            return;
        }

        try {
            $object->setCacheControllerFactory($this->getCacheControllerFactory());
        } catch (\UnexpectedValueException $e) {
            // Ignore it
        }
    }

    /**
     * Sets the internal user factory on the given object.
     *
     * @param   object  $object  The object
     *
     * @return  void
     *
     * @since   4.4.0
     */
    private function setUserFactoryOnObject($object): void
    {
        if (!$object instanceof UserFactoryAwareInterface) {
            return;
        }

        try {
            $object->setUserFactory($this->getUserFactory());
        } catch (\UnexpectedValueException $e) {
            // Ignore it
        }
    }

    /**
     * Sets the internal mailer factory on the given object.
     *
     * @param   object  $object  The object
     *
     * @return  void
     *
     * @since   4.4.0
     */
    private function setMailerFactoryOnObject($object): void
    {
        if (!$object instanceof MailerFactoryAwareInterface) {
            return;
        }

        try {
            $object->setMailerFactory($this->getMailerFactory());
        } catch (\UnexpectedValueException $e) {
            // Ignore it
        }
    }
}
