<?php

/**
 * @package     Joomla.Administrator
 * @subpackage  com_templates
 *
 * @copyright   (C) 2009 Open Source Matters, Inc. <https://www.joomla.org>
 * @license     GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\Component\Templates\Administrator\Model;

use Joomla\CMS\Component\ComponentHelper;
use Joomla\CMS\Factory;
use Joomla\CMS\MVC\Factory\MVCFactoryInterface;
use Joomla\CMS\MVC\Model\ListModel;
use Joomla\Database\ParameterType;
use Joomla\String\StringHelper;

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

/**
 * Methods supporting a list of template style records.
 *
 * @since  1.6
 */
class StylesModel extends ListModel
{
    /**
     * Constructor.
     *
     * @param   array                $config   An optional associative array of configuration settings.
     * @param   MVCFactoryInterface  $factory  The factory.
     *
     * @see     \Joomla\CMS\MVC\Model\BaseDatabaseModel
     * @since   3.2
     */
    public function __construct($config = [], MVCFactoryInterface $factory = null)
    {
        if (empty($config['filter_fields'])) {
            $config['filter_fields'] = [
                'id', 'a.id',
                'title', 'a.title',
                'template', 'a.template',
                'home', 'a.home',
                'menuitem',
            ];
        }

        parent::__construct($config, $factory);
    }

    /**
     * Method to auto-populate the model state.
     *
     * Note. Calling getState in this method will result in recursion.
     *
     * @param   string  $ordering   An optional ordering field.
     * @param   string  $direction  An optional direction (asc|desc).
     *
     * @return  void
     *
     * @since   1.6
     */
    protected function populateState($ordering = 'a.template', $direction = 'asc')
    {
        $app = Factory::getApplication();

        if (!$app->isClient('api')) {
            // Load the filter state.
            $this->setState('filter.search', $this->getUserStateFromRequest($this->context . '.filter.search', 'filter_search', '', 'string'));
            $this->setState('filter.template', $this->getUserStateFromRequest($this->context . '.filter.template', 'filter_template', '', 'string'));
            $this->setState('filter.menuitem', $this->getUserStateFromRequest($this->context . '.filter.menuitem', 'filter_menuitem', '', 'cmd'));

            // Special case for the client id.
            $clientId = (int) $this->getUserStateFromRequest($this->context . '.client_id', 'client_id', 0, 'int');
            $clientId = !\in_array($clientId, [0, 1]) ? 0 : $clientId;
            $this->setState('client_id', $clientId);
        }

        // Load the parameters.
        $params = ComponentHelper::getParams('com_templates');
        $this->setState('params', $params);

        // List state information.
        parent::populateState($ordering, $direction);
    }

    /**
     * Method to get a store id based on model configuration state.
     *
     * This is necessary because the model is used by the component and
     * different modules that might need different sets of data or different
     * ordering requirements.
     *
     * @param   string  $id  A prefix for the store id.
     *
     * @return  string  A store id.
     */
    protected function getStoreId($id = '')
    {
        // Compile the store id.
        $id .= ':' . $this->getState('client_id');
        $id .= ':' . $this->getState('filter.search');
        $id .= ':' . $this->getState('filter.template');
        $id .= ':' . $this->getState('filter.menuitem');

        return parent::getStoreId($id);
    }

    /**
     * Build an SQL query to load the list data.
     *
     * @return  \Joomla\Database\DatabaseQuery
     */
    protected function getListQuery()
    {
        $clientId = (int) $this->getState('client_id');

        // Create a new query object.
        $db    = $this->getDatabase();
        $query = $db->getQuery(true);

        // Select the required fields from the table.
        $query->select(
            $this->getState(
                'list.select',
                [
                    $db->quoteName('a.id'),
                    $db->quoteName('a.template'),
                    $db->quoteName('a.title'),
                    $db->quoteName('a.home'),
                    $db->quoteName('a.client_id'),
                    $db->quoteName('l.title', 'language_title'),
                    $db->quoteName('l.image'),
                    $db->quoteName('l.sef', 'language_sef'),
                ]
            )
        )
            ->select(
                [
                    'COUNT(' . $db->quoteName('m.template_style_id') . ') AS assigned',
                    $db->quoteName('extension_id', 'e_id'),
                ]
            )
            ->from($db->quoteName('#__template_styles', 'a'))
            ->where($db->quoteName('a.client_id') . ' = :clientid')
            ->bind(':clientid', $clientId, ParameterType::INTEGER);

        // Join on menus.
        $query->join('LEFT', $db->quoteName('#__menu', 'm'), $db->quoteName('m.template_style_id') . ' = ' . $db->quoteName('a.id'))
            ->group(
                [
                    $db->quoteName('a.id'),
                    $db->quoteName('a.template'),
                    $db->quoteName('a.title'),
                    $db->quoteName('a.home'),
                    $db->quoteName('a.client_id'),
                    $db->quoteName('l.title'),
                    $db->quoteName('l.image'),
                    $db->quoteName('l.sef'),
                    $db->quoteName('e.extension_id'),
                ]
            );

        // Join over the language.
        $query->join('LEFT', $db->quoteName('#__languages', 'l'), $db->quoteName('l.lang_code') . ' = ' . $db->quoteName('a.home'));

        // Filter by extension enabled.
        $query->join(
            'LEFT',
            $db->quoteName('#__extensions', 'e'),
            $db->quoteName('e.element') . ' = ' . $db->quoteName('a.template')
                . ' AND ' . $db->quoteName('e.client_id') . ' = ' . $db->quoteName('a.client_id')
        )
            ->where(
                [
                    $db->quoteName('e.enabled') . ' = 1',
                    $db->quoteName('e.type') . ' = ' . $db->quote('template'),
                ]
            );

        // Filter by template.
        if ($template = $this->getState('filter.template')) {
            $query->where($db->quoteName('a.template') . ' = :template')
                ->bind(':template', $template);
        }

        // Filter by menuitem.
        $menuItemId = $this->getState('filter.menuitem');

        if ($clientId === 0 && is_numeric($menuItemId)) {
            // If user selected the templates styles that are not assigned to any page.
            if ((int) $menuItemId === -1) {
                // Only custom template styles overrides not assigned to any menu item.
                $query->where(
                    [
                        $db->quoteName('a.home') . ' = ' . $db->quote('0'),
                        $db->quoteName('m.id') . ' IS NULL',
                    ]
                );
            } else {
                // If user selected the templates styles assigned to particular pages.
                // Subquery to get the language of the selected menu item.
                $menuItemId               = (int) $menuItemId;
                $menuItemLanguageSubQuery = $db->getQuery(true);
                $menuItemLanguageSubQuery->select($db->quoteName('language'))
                    ->from($db->quoteName('#__menu'))
                    ->where($db->quoteName('id') . ' = :menuitemid');
                $query->bind(':menuitemid', $menuItemId, ParameterType::INTEGER);

                // Subquery to get the language of the selected menu item.
                $templateStylesMenuItemsSubQuery = $db->getQuery(true);
                $templateStylesMenuItemsSubQuery->select($db->quoteName('id'))
                    ->from($db->quoteName('#__menu'))
                    ->where($db->quoteName('template_style_id') . ' = ' . $db->quoteName('a.id'));

                // Main query where clause.
                $query->where('(' .
                    // Default template style (fallback template style to all menu items).
                    $db->quoteName('a.home') . ' = ' . $db->quote('1') . ' OR ' .
                    // Default template style for specific language (fallback template style to the selected menu item language).
                    $db->quoteName('a.home') . ' IN (' . $menuItemLanguageSubQuery . ') OR ' .
                    // Custom template styles override (only if assigned to the selected menu item).
                    '(' . $db->quoteName('a.home') . ' = ' . $db->quote('0') . ' AND ' . $menuItemId . ' IN (' . $templateStylesMenuItemsSubQuery . '))' .
                    ')');
            }
        }

        // Filter by search in title.
        if ($search = $this->getState('filter.search')) {
            if (stripos($search, 'id:') === 0) {
                $ids = (int) substr($search, 3);
                $query->where($db->quoteName('a.id') . ' = :id');
                $query->bind(':id', $ids, ParameterType::INTEGER);
            } else {
                $search = '%' . StringHelper::strtolower($search) . '%';
                $query->extendWhere(
                    'AND',
                    [
                        'LOWER(' . $db->quoteName('a.template') . ') LIKE :templatesearch',
                        'LOWER(' . $db->quoteName('a.title') . ') LIKE :title',
                    ],
                    'OR'
                )
                    ->bind(':templatesearch', $search)
                    ->bind(':title', $search);
            }
        }

        // Add the list ordering clause.
        $query->order($db->escape($this->getState('list.ordering', 'a.template')) . ' ' . $db->escape($this->getState('list.direction', 'ASC')));

        return $query;
    }
}
