9.5/_page_provider_8php_source.html

<?php

declare(strict_types = 1);

namespace ‪TYPO3\CMS\Backend\ContextMenu\ItemProviders;


/*

 * 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!

 */


use ‪TYPO3\CMS\Backend\Routing\UriBuilder;

use ‪TYPO3\CMS\Backend\Utility\BackendUtility;

use ‪TYPO3\CMS\Core\Type\Bitmask\Permission;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;


class ‪PageProvider extends ‪RecordProvider

{

    protected ‪$table = 'pages';


    protected ‪$itemsConfiguration = [

        'view' => [

            'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.view',

            'iconIdentifier' => 'actions-view-page',

            'callbackAction' => 'viewRecord'

        ],

        'edit' => [

            'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.edit',

            'iconIdentifier' => 'actions-page-open',

            'callbackAction' => 'editRecord'

        ],

        'new' => [

            'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.new',

            'iconIdentifier' => 'actions-page-new',

            'callbackAction' => 'newRecord'

        ],

        'info' => [

            'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.info',

            'iconIdentifier' => 'actions-document-info',

            'callbackAction' => 'openInfoPopUp'

        ],

        'divider1' => [

            'type' => 'divider'

        ],

        'copy' => [

            'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.copy',

            'iconIdentifier' => 'actions-edit-copy',

            'callbackAction' => 'copy'

        ],

        'copyRelease' => [

            'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.copy',

            'iconIdentifier' => 'actions-edit-copy-release',

            'callbackAction' => 'clipboardRelease'

        ],

        'cut' => [

            'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.cut',

            'iconIdentifier' => 'actions-edit-cut',

            'callbackAction' => 'cut'

        ],

        'cutRelease' => [

            'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.cutrelease',

            'iconIdentifier' => 'actions-edit-cut-release',

            'callbackAction' => 'clipboardRelease'

        ],

        'pasteAfter' => [

            'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.pasteafter',

            'iconIdentifier' => 'actions-document-paste-after',

            'callbackAction' => 'pasteAfter'

        ],

        'pasteInto' => [

            'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.pasteinto',

            'iconIdentifier' => 'actions-document-paste-into',

            'callbackAction' => 'pasteInto'

        ],

        'divider2' => [

            'type' => 'divider'

        ],

        'more' => [

            'type' => 'submenu',

            'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.more',

            'iconIdentifier' => '',

            'callbackAction' => 'openSubmenu',

            'childItems' => [

                'newWizard' => [

                    'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_misc.xlf:CM_newWizard',

                    'iconIdentifier' => 'actions-page-new',

                    'callbackAction' => 'newPageWizard',

                ],

                'pagesSort' => [

                    'label' => 'LLL:EXT:backend/Resources/Private/Language/locallang_pages_sort.xlf:title',

                    'iconIdentifier' => 'actions-page-move',

                    'callbackAction' => 'pagesSort',

                ],

                'pagesNewMultiple' => [

                    'label' => 'LLL:EXT:backend/Resources/Private/Language/locallang_pages_new.xlf:title',

                    'iconIdentifier' => 'apps-pagetree-drag-move-between',

                    'callbackAction' => 'pagesNewMultiple',

                ],

                'openListModule' => [

                    'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_misc.xlf:CM_db_list',

                    'iconIdentifier' => 'actions-system-list-open',

                    'callbackAction' => 'openListModule',

                ],

                'mountAsTreeRoot' => [

                    'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.tempMountPoint',

                    'iconIdentifier' => 'actions-pagetree-mountroot',

                    'callbackAction' => 'mountAsTreeRoot',

                ],

            ],

        ],

        'divider3' => [

            'type' => 'divider'

        ],

        'enable' => [

            'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_common.xlf:enable',

            'iconIdentifier' => 'actions-edit-unhide',

            'callbackAction' => 'enableRecord',

        ],

        'disable' => [

            'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_common.xlf:disable',

            'iconIdentifier' => 'actions-edit-hide',

            'callbackAction' => 'disableRecord',

        ],

        'delete' => [

            'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.delete',

            'iconIdentifier' => 'actions-edit-delete',

            'callbackAction' => 'deleteRecord',

        ],

        'history' => [

            'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_misc.xlf:CM_history',

            'iconIdentifier' => 'actions-document-history-open',

            'callbackAction' => 'openHistoryPopUp',

        ],

        'clearCache' => [

            'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.clear_cache',

            'iconIdentifier' => 'actions-system-cache-clear',

            'callbackAction' => 'clearCache',

        ],

    ];


    protected ‪$languageAccess = false;


    public function ‪canHandle(): bool

    {

        return $this->table === 'pages';

    }


    public function ‪getPriority(): int

    {

        return 100;

    }


    protected function ‪canRender(string $itemName, string $type): bool

    {

        if (in_array($type, ['divider', 'submenu'], true)) {

            return true;

        }

        if (in_array($itemName, $this->disabledItems, true)) {

            return false;

        }

        $canRender = false;

        switch ($itemName) {

            case 'view':

                $canRender = $this->‪canBeViewed();

                break;

            case 'edit':

                $canRender = $this->‪canBeEdited();

                break;

            case 'new':

            case 'newWizard':

            case 'pagesNewMultiple':

                $canRender = $this->‪canBeCreated();

                break;

            case 'info':

                $canRender = $this->‪canShowInfo();

                break;

            case 'enable':

                $canRender = $this->‪canBeEnabled();

                break;

            case 'disable':

                $canRender = $this->‪canBeDisabled();

                break;

            case 'delete':

                $canRender = $this->‪canBeDeleted();

                break;

            case 'history':

                $canRender = $this->‪canShowHistory();

                break;

            case 'openListModule':

                $canRender = $this->‪canOpenListModule();

                break;

            case 'pagesSort':

                $canRender = $this->‪canBeSorted();

                break;

            case 'mountAsTreeRoot':

                $canRender = !$this->‪isRoot();

                break;

            case 'copy':

                $canRender = $this->‪canBeCopied();

                break;

            case 'copyRelease':

                $canRender = $this->‪isRecordInClipboard('copy');

                break;

            case 'cut':

                $canRender = $this->‪canBeCut() && !$this->‪isRecordInClipboard('cut');

                break;

            case 'cutRelease':

                $canRender = $this->‪isRecordInClipboard('cut');

                break;

            case 'pasteAfter':

                $canRender = $this->‪canBePastedAfter();

                break;

            case 'pasteInto':

                $canRender = $this->‪canBePastedInto();

                break;

            case 'clearCache':

                $canRender = $this->‪canClearCache();

                break;

        }

        return $canRender;

    }


    protected function ‪initPermissions()

    {

        $this->pagePermissions = $this->backendUser->calcPerms($this->record);

        $this->languageAccess = $this->‪hasLanguageAccess();

    }


    protected function ‪canBeCreated(): bool

    {

        if (!$this->backendUser->checkLanguageAccess(0)) {

            return false;

        }

        return $this->‪hasPagePermission(‪Permission::PAGE_NEW);

    }


    protected function ‪canBeEdited(): bool

    {

        if (!$this->languageAccess) {

            return false;

        }

        if ($this->‪isRoot()) {

            return false;

        }

        if (isset(‪$GLOBALS['TCA'][$this->table]['ctrl']['readOnly']) && ‪$GLOBALS['TCA'][$this->table]['ctrl']['readOnly']) {

            return false;

        }

        if ($this->backendUser->isAdmin()) {

            return true;

        }

        if (isset(‪$GLOBALS['TCA'][$this->table]['ctrl']['adminOnly']) && ‪$GLOBALS['TCA'][$this->table]['ctrl']['adminOnly']) {

            return false;

        }

        return !$this->‪isRecordLocked() && $this->‪hasPagePermission(‪Permission::PAGE_EDIT);

    }


    protected function ‪isRecordLocked(): bool

    {

        return (bool)$this->record['editlock'];

    }


    protected function ‪canBeCut(): bool

    {

        if (!$this->languageAccess) {

            return false;

        }

        if (isset(‪$GLOBALS['TCA'][$this->table]['ctrl']['languageField'])

            && !in_array($this->record[‪$GLOBALS['TCA'][$this->table]['ctrl']['languageField']], [0, -1])

        ) {

            return false;

        }

        return !$this->‪isWebMount()

            && $this->‪canBeEdited()

            && !$this->‪isDeletePlaceholder();

    }


    protected function ‪canBeCopied(): bool

    {

        if (!$this->languageAccess) {

            return false;

        }

        if (isset(‪$GLOBALS['TCA'][$this->table]['ctrl']['languageField'])

            && !in_array($this->record[‪$GLOBALS['TCA'][$this->table]['ctrl']['languageField']], [0, -1])

        ) {

            return false;

        }

        return !$this->‪isRoot()

            && !$this->‪isWebMount()

            && !$this->‪isRecordInClipboard('copy')

            && $this->‪hasPagePermission(‪Permission::PAGE_SHOW)

            && !$this->‪isDeletePlaceholder();

    }


    protected function ‪canBePastedInto(): bool

    {

        if (!$this->languageAccess) {

            return false;

        }

        $clipboardElementCount = count($this->clipboard->elFromTable($this->table));


        return $clipboardElementCount

            && $this->‪canBeCreated()

            && !$this->‪isDeletePlaceholder();

    }


    protected function ‪canBePastedAfter(): bool

    {

        if (!$this->languageAccess) {

            return false;

        }

        $clipboardElementCount = count($this->clipboard->elFromTable($this->table));

        return $clipboardElementCount

            && $this->‪canBeCreated()

            && !$this->‪isDeletePlaceholder();

    }


    protected function ‪canBeSorted(): bool

    {

        if (!$this->languageAccess) {

            return false;

        }

        return $this->backendUser->check('tables_modify', $this->table)

            && $this->‪hasPagePermission(‪Permission::CONTENT_EDIT)

            && !$this->‪isDeletePlaceholder()

            && $this->backendUser->workspace === 0;

    }


    protected function ‪canBeDeleted(): bool

    {

        if (!$this->languageAccess) {

            return false;

        }

        return !$this->‪isDeletePlaceholder()

            && !$this->‪isRecordLocked()

            && !$this->‪isDeletionDisabledInTS()

            && $this->‪hasPagePermission(‪Permission::PAGE_DELETE);

    }


    protected function ‪canBeViewed(): bool

    {

        return !$this->‪isRoot() && !$this->‪isDeleted();

    }


    protected function ‪canShowInfo(): bool

    {

        return !$this->‪isRoot();

    }


    protected function ‪canClearCache(): bool

    {

        return !$this->‪isRoot()

            && ($this->backendUser->isAdmin() || $this->backendUser->getTSConfig()['options.']['clearCache.']['pages'] ?? false);

    }


    protected function ‪isDeleted(): bool

    {

        return !empty($this->record['deleted']) || $this->‪isDeletePlaceholder();

    }


    protected function ‪isRoot()

    {

        return (int)$this->identifier === 0;

    }


    protected function ‪isWebMount()

    {

        return in_array($this->identifier, $this->backendUser->returnWebmounts());

    }


    protected function ‪getAdditionalAttributes(string $itemName): array

    {

        $attributes = [];

        if ($itemName === 'view') {

            $attributes += $this->‪getViewAdditionalAttributes();

        }

        if ($itemName === 'enable' || $itemName === 'disable') {

            $attributes += $this->‪getEnableDisableAdditionalAttributes();

        }

        if ($itemName === 'delete') {

            $attributes += $this->‪getDeleteAdditionalAttributes();

        }

        if ($itemName === 'pasteInto') {

            $attributes += $this->‪getPasteAdditionalAttributes('into');

        }

        if ($itemName === 'pasteAfter') {

            $attributes += $this->‪getPasteAdditionalAttributes('after');

        }

        if ($itemName === 'pagesSort') {

            $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);

            $attributes += [

                'data-pages-sort-url' => (string)$uriBuilder->buildUriFromRoute('pages_sort', ['id' => $this->record['uid']]),

            ];

        }

        if ($itemName === 'pagesNewMultiple') {

            $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);

            $attributes += [

                'data-pages-new-multiple-url' => (string)$uriBuilder->buildUriFromRoute('pages_new', ['id' => $this->record['uid']]),

            ];

        }

        if ($itemName === 'edit') {

            $attributes = [

                'data-pages-language-uid' => $this->record['sys_language_uid']

            ];

        }

        return $attributes;

    }


    protected function ‪getPreviewPid(): int

    {

        return (int)$this->record['sys_language_uid'] === 0 ? (int)$this->record['uid'] : (int)$this->record['l10n_parent'];

    }


    protected function ‪getViewLink(): string

    {

        $language = (int)$this->record['sys_language_uid'];

        $additionalParams = ($language > 0) ? '&L=' . $language : '';

        return ‪BackendUtility::getPreviewUrl(

            $this->‪getPreviewPid(),

            '',

            null,

            '',

            '',

            $additionalParams

        );

    }


    protected function ‪hasLanguageAccess(): bool

    {

        if ($this->backendUser->isAdmin()) {

            return true;

        }

        $languageField = ‪$GLOBALS['TCA'][‪$this->table]['ctrl']['languageField'] ?? '';

        if ($languageField !== '' && isset($this->record[$languageField])) {

            return $this->backendUser->checkLanguageAccess((int)$this->record[$languageField]);

        }

        return true;

    }

}