<?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\ContentBlocks\Definition\Capability;

/**
 * @internal Not part of TYPO3's public API.
 */
final class TableDefinitionCapability implements SystemFieldPalettesInterface
{
    private RootLevelCapability $rootLevelCapability;
    private LabelCapability $labelCapability;
    private bool $languageAware = true;
    private bool $workspaceAware = true;
    private bool $disabledRestriction = true;
    private bool $startTimeRestriction = true;
    private bool $endTimeRestriction = true;
    private bool $userGroupRestriction = true;
    private bool $editLocking = true;
    private bool $softDelete = true;
    private bool $trackCreationDate = true;
    private bool $trackUpdateDate = true;
    private bool $sortable = true;
    private bool $internalDescription = false;
    /** @var list<array{identifier: string, order: string}> */
    private array $sortField = [];
    private bool $ignoreWebMountRestriction = false;
    private bool $ignorePageTypeRestriction = false;
    private bool $readOnly = false;
    private bool $adminOnly = false;
    private bool $hideAtCopy = false;
    private string $appendLabelAtCopy = '';
    private bool $hideInUi = false;

    public static function createFromArray(array $definition): TableDefinitionCapability
    {
        $capability = new TableDefinitionCapability();
        $capability->languageAware = (bool)($definition['languageAware'] ?? $capability->languageAware);
        $capability->workspaceAware = (bool)($definition['workspaceAware'] ?? $capability->workspaceAware);
        $capability->disabledRestriction = (bool)($definition['restriction']['disabled'] ?? $capability->disabledRestriction);
        $capability->startTimeRestriction = (bool)($definition['restriction']['startTime'] ?? $capability->startTimeRestriction);
        $capability->endTimeRestriction = (bool)($definition['restriction']['endTime'] ?? $capability->endTimeRestriction);
        $capability->userGroupRestriction = (bool)($definition['restriction']['userGroup'] ?? $capability->userGroupRestriction);
        $capability->editLocking = (bool)($definition['editLocking'] ?? $capability->editLocking);
        $capability->softDelete = (bool)($definition['softDelete'] ?? $capability->softDelete);
        $capability->trackCreationDate = (bool)($definition['trackCreationDate'] ?? $capability->trackCreationDate);
        $capability->trackUpdateDate = (bool)($definition['trackUpdateDate'] ?? $capability->trackUpdateDate);
        $capability->sortable = (bool)($definition['sortable'] ?? $capability->sortable);
        $capability->sortField = (array)($definition['sortField'] ?? $capability->sortField);
        $capability->internalDescription = (bool)($definition['internalDescription'] ?? $capability->internalDescription);
        $capability->ignoreWebMountRestriction = (bool)($definition['security']['ignoreWebMountRestriction'] ?? $capability->ignoreWebMountRestriction);
        $capability->ignorePageTypeRestriction = (bool)($definition['security']['ignorePageTypeRestriction'] ?? $capability->ignorePageTypeRestriction);
        $capability->readOnly = (bool)($definition['readOnly'] ?? $capability->readOnly);
        $capability->adminOnly = (bool)($definition['adminOnly'] ?? $capability->adminOnly);
        $capability->hideAtCopy = (bool)($definition['hideAtCopy'] ?? $capability->hideAtCopy);
        $capability->appendLabelAtCopy = (string)($definition['appendLabelAtCopy'] ?? $capability->appendLabelAtCopy);
        $capability->rootLevelCapability = RootLevelCapability::createFromArray($definition);
        $capability->labelCapability = LabelCapability::createFromArray($definition);
        $capability->hideInUi = (bool)($definition['hideInUi'] ?? $capability->hideInUi);

        return $capability;
    }

    public function isLanguageAware(): bool
    {
        return $this->languageAware;
    }

    public function isWorkspaceAware(): bool
    {
        return $this->workspaceAware;
    }

    public function hasDisabledRestriction(): bool
    {
        return $this->disabledRestriction;
    }

    public function hasStartTimeRestriction(): bool
    {
        return $this->startTimeRestriction;
    }

    public function hasEndTimeRestriction(): bool
    {
        return $this->endTimeRestriction;
    }

    public function hasUserGroupRestriction(): bool
    {
        return $this->userGroupRestriction;
    }

    public function isEditLockingEnabled(): bool
    {
        return $this->editLocking;
    }

    public function hasSoftDelete(): bool
    {
        return $this->softDelete;
    }

    public function shallTrackCreationDate(): bool
    {
        return $this->trackCreationDate;
    }

    public function shallTrackUpdateDate(): bool
    {
        return $this->trackUpdateDate;
    }

    public function isSortable(): bool
    {
        return $this->sortable;
    }

    public function hasSortField(): bool
    {
        return $this->sortField !== [];
    }

    public function getSortField(): array
    {
        return $this->sortField;
    }

    public function getSortFieldAsString(): string
    {
        $parts = [];
        foreach ($this->sortField as $sortField) {
            $partString = $sortField['identifier'];
            if ($sortField['order'] !== '') {
                $partString .= ' ' . $sortField['order'];
            }
            $parts[] = $partString;
        }
        $sortFieldString = implode(',', $parts);
        return $sortFieldString;
    }

    public function hasInternalDescription(): bool
    {
        return $this->internalDescription;
    }

    public function getRootLevelCapability(): RootLevelCapability
    {
        return $this->rootLevelCapability;
    }

    public function getLabelCapability(): LabelCapability
    {
        return $this->labelCapability;
    }

    public function isIgnoreWebMountRestriction(): bool
    {
        return $this->ignoreWebMountRestriction;
    }

    public function isIgnorePageTypeRestriction(): bool
    {
        return $this->ignorePageTypeRestriction;
    }

    public function isReadOnly(): bool
    {
        return $this->readOnly;
    }

    public function isAdminOnly(): bool
    {
        return $this->adminOnly;
    }

    public function shallBeHiddenAtCopy(): bool
    {
        if (!$this->disabledRestriction) {
            return false;
        }
        return $this->hideAtCopy;
    }

    public function hasAppendLabelAtCopy(): bool
    {
        return $this->appendLabelAtCopy !== '';
    }

    public function getAppendLabelAtCopy(): string
    {
        return $this->appendLabelAtCopy;
    }

    public function isHiddenInUi(): bool
    {
        return $this->hideInUi;
    }

    public function withIgnorePageTypeRestriction(bool $ignorePageTypeRestriction): TableDefinitionCapability
    {
        $self = clone $this;
        $self->ignorePageTypeRestriction = $ignorePageTypeRestriction;
        return $self;
    }

    public function buildRestrictionsTca(): array
    {
        $restrictions = [];
        if ($this->hasDisabledRestriction()) {
            $restrictions['disabled'] = 'hidden';
        }
        if ($this->hasStartTimeRestriction()) {
            $restrictions['starttime'] = 'starttime';
        }
        if ($this->hasEndTimeRestriction()) {
            $restrictions['endtime'] = 'endtime';
        }
        if ($this->hasUserGroupRestriction()) {
            $restrictions['fe_group'] = 'fe_group';
        }
        return $restrictions;
    }

    public function buildAccessShowItemTca(): string
    {
        if (!$this->hasAccessPalette()) {
            return '';
        }
        $access = [];
        if ($this->hasStartTimeRestriction()) {
            $access[] = 'starttime;LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:starttime_formlabel';
        }
        if ($this->hasEndTimeRestriction()) {
            $access[] = 'endtime;LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:endtime_formlabel';
        }
        if ($this->hasStartTimeRestriction() || $this->hasEndTimeRestriction()) {
            $access[] = '--linebreak--';
        }
        if ($this->hasUserGroupRestriction()) {
            $access[] = 'fe_group;LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:fe_group_formlabel';
            $access[] = '--linebreak--';
        }
        if ($this->isEditLockingEnabled()) {
            $access[] = 'editlock';
        }
        $count = count($access);
        if ($count > 0) {
            $lastIndex = $count - 1;
            $lastItem = $access[$lastIndex];
            if ($lastItem === '--linebreak--') {
                array_pop($access);
            }
        }
        $accessTcaString = implode(',', $access);
        return $accessTcaString;
    }

    public function hasAccessPalette(): bool
    {
        return $this->hasStartTimeRestriction() || $this->hasEndTimeRestriction() || $this->hasUserGroupRestriction() || $this->isEditLockingEnabled();
    }

    public function buildLanguageShowItemTca(): string
    {
        return 'sys_language_uid,l10n_parent';
    }

    public function buildHiddenShowItemTca(): string
    {
        return 'hidden';
    }

    public function buildInternalDescriptionShowItemTca(): string
    {
        return '--div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:notes,internal_description';
    }
}
