<?php

declare(strict_types=1);

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

namespace TYPO3\CMS\Core\Database\Query\Restriction;

use TYPO3\CMS\Core\Context\Context;
use TYPO3\CMS\Core\Database\Query\Expression\CompositeExpression;
use TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * A collection of restrictions to be used in frontend context.
 * This is a replacement for PageRepository::enableFields()
 */
class FrontendRestrictionContainer extends AbstractRestrictionContainer
{
    /**
     * @var string[]
     */
    protected array $defaultRestrictionTypes = [
        DeletedRestriction::class,
        WorkspaceRestriction::class,
        HiddenRestriction::class,
        StartTimeRestriction::class,
        EndTimeRestriction::class,
        FrontendGroupRestriction::class,
    ];

    /**
     * @var Context
     */
    protected $context;

    /**
     * FrontendRestrictionContainer constructor.
     * Initializes the default restrictions for frontend requests
     */
    public function __construct(Context $context = null)
    {
        $this->context = $context ?? GeneralUtility::makeInstance(Context::class);
        foreach ($this->defaultRestrictionTypes as $restrictionType) {
            $this->add($this->createRestriction($restrictionType));
        }
    }

    /**
     * Main method to build expressions for given tables
     * Iterates over all registered restrictions and removes the hidden restriction if preview is requested
     *
     * @param array $queriedTables Array of tables, where array key is table alias and value is a table name
     * @param ExpressionBuilder $expressionBuilder Expression builder instance to add restrictions with
     * @return CompositeExpression The result of query builder expression(s)
     */
    public function buildExpression(array $queriedTables, ExpressionBuilder $expressionBuilder): CompositeExpression
    {
        $constraints = [];
        foreach ($this->restrictions as $restriction) {
            foreach ($queriedTables as $tableAlias => $tableName) {
                $disableRestriction = false;
                if ($restriction instanceof HiddenRestriction || $restriction instanceof StartTimeRestriction || $restriction instanceof EndTimeRestriction) {
                    $visibilityAspect = $this->context->getAspect('visibility');
                    if ($restriction instanceof HiddenRestriction) {
                        // If display of hidden records is requested, we must disable the hidden restriction.
                        if ($tableName === 'pages') {
                            $disableRestriction = $visibilityAspect->includeHiddenPages();
                        } else {
                            $disableRestriction = $visibilityAspect->includeHiddenContent();
                        }
                    }
                    if ($restriction instanceof StartTimeRestriction || $restriction instanceof EndTimeRestriction) {
                        $disableRestriction = $visibilityAspect->includeScheduledRecords();
                    }
                }
                if (!$disableRestriction) {
                    $constraints[] = $restriction->buildExpression([$tableAlias => $tableName], $expressionBuilder);
                }
            }
        }
        return $expressionBuilder->and(...$constraints);
    }

    protected function createRestriction($restrictionClass): QueryRestrictionInterface
    {
        if ($restrictionClass === WorkspaceRestriction::class) {
            return GeneralUtility::makeInstance($restrictionClass, (int)$this->context->getPropertyFromAspect('workspace', 'id', 0));
        }
        return parent::createRestriction($restrictionClass);
    }
}
