StandardContentPreviewRenderer.php

Go to the documentation of this file.

<?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\Backend\Preview;
 
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use ‪TYPO3\CMS\Backend\Routing\UriBuilder;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumnItem;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Imaging\IconFactory;
use TYPO3\CMS\Core\Imaging\IconSize;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\Service\FlexFormService;
use ‪TYPO3\CMS\Core\Type\Bitmask\Permission;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Fluid\View\StandaloneView;
 
class ‪StandardContentPreviewRenderer implements ‪PreviewRendererInterface, LoggerAwareInterface
{
    use LoggerAwareTrait;
 
    private const ‪MENU_CONTENT_TYPES = [
        'menu_abstract',
        'menu_categorized_content',
        'menu_categorized_pages',
        'menu_pages',
        'menu_recently_updated',
        'menu_related_pages',
        'menu_section',
        'menu_section_pages',
        'menu_sitemap',
        'menu_sitemap_pages',
        'menu_subpages',
    ];
 
    public function ‪renderPageModulePreviewHeader(‪GridColumnItem $item): string
    {
        ‪$record = $item->‪getRecord();
        $itemLabels = $item->‪getContext()->getItemLabels();
 
        $outHeader = '';
        $outHeader .= ‪$record['header_layout'] == 100
            ? '<div class="element-preview-header-status">' . htmlspecialchars($this->‪getLanguageService()->sL('LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:header_layout.I.6')) . '</div>'
            : '';
        $outHeader .= ‪$record['date']
            ? '<div class="element-preview-header-date">' . htmlspecialchars($itemLabels['date'] . ' ' . BackendUtility::date(‪$record['date'])) . ' </div>'
            : '';
        $outHeader .= ‪$record['header']
            ? '<div class="element-preview-header-header">' . $this->‪linkEditContent($this->‪renderText(‪$record['header']), ‪$record) . '</div>'
            : '';
        $outHeader .= ‪$record['subheader']
            ? '<div class="element-preview-header-subheader">' . $this->‪linkEditContent($this->‪renderText(‪$record['subheader']), ‪$record) . '</div>'
            : '';
 
        return $outHeader;
    }
 
    public function ‪renderPageModulePreviewContent(‪GridColumnItem $item): string
    {
        $out = '';
        ‪$record = $item->‪getRecord();
 
        $contentTypeLabels = $item->‪getContext()->getContentTypeLabels();
        $languageService = $this->‪getLanguageService();
 
        // Check if a Fluid-based preview template was defined for this CType
        // and render it via Fluid. Possible option:
        // mod.web_layout.tt_content.preview.media = EXT:site_mysite/Resources/Private/Templates/Preview/Media.html
        $infoArr = [];
        $this->‪getProcessedValue($item, 'header_position,header_layout,header_link', $infoArr);
        $tsConfig = BackendUtility::getPagesTSconfig(‪$record['pid'])['mod.']['web_layout.']['tt_content.']['preview.'] ?? [];
        if (!empty($tsConfig[‪$record['CType']]) || !empty($tsConfig[‪$record['CType'] . '.'])) {
            $fluidPreview = $this->‪renderContentElementPreviewFromFluidTemplate($record);
            if ($fluidPreview !== null) {
                return $fluidPreview;
            }
        }
 
        // Draw preview of the item depending on its CType
        switch (‪$record['CType']) {
            case 'header':
                break;
            case 'uploads':
                if (‪$record['media']) {
                    $out .= $this->‪linkEditContent($this->‪getThumbCodeUnlinked($record, 'tt_content', 'media'), ‪$record);
                }
                break;
            case 'shortcut':
                if (!empty(‪$record['records'])) {
                    $shortcutContent = '';
                    $recordList = explode(',', ‪$record['records']);
                    foreach ($recordList as $recordIdentifier) {
                        $split = BackendUtility::splitTable_Uid($recordIdentifier);
                        $tableName = empty($split[0]) ? 'tt_content' : $split[0];
                        $shortcutRecord = BackendUtility::getRecord($tableName, $split[1]);
                        if (is_array($shortcutRecord)) {
                            $shortcutRecord = $this->‪translateShortcutRecord($record, $shortcutRecord, $tableName, (int)$split[1]);
                            $icon = $this->‪getIconFactory()->getIconForRecord($tableName, $shortcutRecord, IconSize::SMALL)->render();
                            $icon = BackendUtility::wrapClickMenuOnIcon(
                                $icon,
                                $tableName,
                                $shortcutRecord['uid'],
                                '1'
                            );
                            $shortcutContent .= '<li class="list-group-item">' . $icon . ' ' . htmlspecialchars(BackendUtility::getRecordTitle($tableName, $shortcutRecord)) . '</li>';
                        }
                    }
                    $out .= $shortcutContent ? '<ul class="list-group">' . $shortcutContent . '</ul>' : '';
                }
                break;
            case 'list':
                if (!empty(‪$record['list_type'])) {
                    $label = BackendUtility::getLabelFromItemListMerged((int)‪$record['pid'], 'tt_content', 'list_type', ‪$record['list_type'], ‪$record);
                    if (!empty($label)) {
                        $out .= $this->‪linkEditContent('<strong>' . htmlspecialchars($languageService->sL($label)) . '</strong>', ‪$record);
                    } else {
                        $message = sprintf($languageService->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.noMatchingValue'), ‪$record['list_type']);
                        $out .= '<div class="alert alert-danger">' . htmlspecialchars($message) . '</div>';
                    }
                } else {
                    $out .= '<div class="alert alert-warning">' . htmlspecialchars($languageService->sL('LLL:EXT:backend/Resources/Private/Language/locallang_layout.xlf:noPluginSelected')) . '</div>';
                }
                break;
            default:
                $contentTypeLabel = (string)($contentTypeLabels[‪$record['CType']] ?? '');
                if ($contentTypeLabel === '') {
                    $message = sprintf(
                        $languageService->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.noMatchingValue'),
                        ‪$record['CType']
                    );
                    $out .= '<span class="badge badge-warning">' . htmlspecialchars($message) . '</span>';
                    break;
                }
                // Handle menu content types
                if (in_array(‪$record['CType'], self::MENU_CONTENT_TYPES, true)) {
                    if (‪$record['CType'] !== 'menu_sitemap' && ((‪$record['pages'] ?? false) || (‪$record['selected_categories'] ?? false))) {
                        // Show pages/categories if menu type is not "Sitemap"
                        $out .= $this->‪linkEditContent($this->‪generateListForMenuContentTypes($record), ‪$record);
                    }
                    break;
                }
                if (‪$record['bodytext']) {
                    $out .= $this->‪linkEditContent($this->‪renderText($record['bodytext']), ‪$record);
                }
                if (‪$record['image']) {
                    $out .= $this->‪linkEditContent($this->‪getThumbCodeUnlinked($record, 'tt_content', 'image'), ‪$record);
                }
        }
 
        return $out;
    }
 
    public function ‪renderPageModulePreviewFooter(‪GridColumnItem $item): string
    {
        $info = [];
        ‪$record = $item->‪getRecord();
        $this->‪getProcessedValue($item, 'starttime,endtime,fe_group,space_before_class,space_after_class', $info);
 
        if (!empty(‪$GLOBALS['TCA']['tt_content']['ctrl']['descriptionColumn']) && !empty(‪$record[‪$GLOBALS['TCA']['tt_content']['ctrl']['descriptionColumn']])) {
            $info[] = htmlspecialchars(‪$record[‪$GLOBALS['TCA']['tt_content']['ctrl']['descriptionColumn']]);
        }
 
        if (!empty($info)) {
            return implode('<br>', $info);
        }
        return '';
    }
 
    public function ‪wrapPageModulePreview(string $previewHeader, string $previewContent, ‪GridColumnItem $item): string
    {
        $previewHeader = $previewHeader ? '<div class="element-preview-header">' . $previewHeader . '</div>' : '';
        $previewContent = $previewContent ? '<div class="element-preview-content">' . $previewContent . '</div>' : '';
        $preview = $previewHeader || $previewContent ? '<div class="element-preview">' . $previewHeader . $previewContent . '</div>' : '';
 
        return $preview;
    }
 
    protected function ‪translateShortcutRecord(array $targetRecord, array $shortcutRecord, string $tableName, int ‪$uid): array
    {
        $targetLanguage = (int)($targetRecord['sys_language_uid'] ?? 0);
        if ($targetLanguage === 0 || !BackendUtility::isTableLocalizable($tableName)) {
            return $shortcutRecord;
        }
 
        $languageField = ‪$GLOBALS['TCA'][$tableName]['ctrl']['languageField'];
        $shortcutLanguage = (int)($shortcutRecord[$languageField] ?? 0);
        if ($targetLanguage === $shortcutLanguage) {
            return $shortcutRecord;
        }
 
        // record is localized - fetch the shortcut record translation, if available
        $shortcutRecordLocalization = BackendUtility::getRecordLocalization($tableName, ‪$uid, $targetLanguage);
        if (is_array($shortcutRecordLocalization) && !empty($shortcutRecordLocalization)) {
            $shortcutRecord = $shortcutRecordLocalization[0];
        }
 
        return $shortcutRecord;
    }
 
    protected function ‪getProcessedValue(‪GridColumnItem $item, string $fieldList, array &$info): void
    {
        $itemLabels = $item->‪getContext()->getItemLabels();
        ‪$record = $item->‪getRecord();
        $fieldArr = explode(',', $fieldList);
        foreach ($fieldArr as $field) {
            if (‪$record[$field]) {
                $fieldValue = BackendUtility::getProcessedValue('tt_content', $field, ‪$record[$field], 0, false, false, ‪$record['uid'] ?? 0, true, ‪$record['pid'] ?? 0) ?? '';
                $info[] = '<strong>' . htmlspecialchars((string)($itemLabels[$field] ?? '')) . '</strong> ' . htmlspecialchars($fieldValue);
            }
        }
    }
 
    protected function ‪renderContentElementPreviewFromFluidTemplate(array $row): ?string
    {
        $tsConfig = BackendUtility::getPagesTSconfig($row['pid'])['mod.']['web_layout.']['tt_content.']['preview.'] ?? [];
        $fluidTemplateFile = '';
 
        if ($row['CType'] === 'list' && !empty($row['list_type'])
            && !empty($tsConfig['list.'][$row['list_type']])
        ) {
            $fluidTemplateFile = $tsConfig['list.'][$row['list_type']];
        } elseif (!empty($tsConfig[$row['CType']])) {
            $fluidTemplateFile = $tsConfig[$row['CType']];
        }
 
        if ($fluidTemplateFile) {
            $fluidTemplateFile = GeneralUtility::getFileAbsFileName($fluidTemplateFile);
            if ($fluidTemplateFile) {
                try {
                    $view = GeneralUtility::makeInstance(StandaloneView::class);
                    $view->setTemplatePathAndFilename($fluidTemplateFile);
                    $view->assignMultiple($row);
                    if (!empty($row['pi_flexform'])) {
                        $flexFormService = GeneralUtility::makeInstance(FlexFormService::class);
                        $view->assign('pi_flexform_transformed', $flexFormService->convertFlexFormContentToArray($row['pi_flexform']));
                    }
                    return $view->render();
                } catch (\‪Exception $e) {
                    $this->logger->warning('The backend preview for content element {uid} can not be rendered using the Fluid template file "{file}"', [
                        'uid' => $row['uid'],
                        'file' => $fluidTemplateFile,
                        'exception' => $e,
                    ]);
 
                    if ($this->‪getBackendUser()->shallDisplayDebugInformation()) {
                        $view = GeneralUtility::makeInstance(StandaloneView::class);
                        $view->assign('error', [
                            'message' => str_replace(‪Environment::getProjectPath(), '', $e->getMessage()),
                            'title' => 'Error while rendering FluidTemplate preview using ' . str_replace(‪Environment::getProjectPath(), '', $fluidTemplateFile),
                        ]);
                        $view->setTemplateSource('<f:be.infobox title="{error.title}" state="2">{error.message}</f:be.infobox>');
                        return $view->render();
                    }
                }
            }
        }
        return null;
    }
 
    protected function ‪getThumbCodeUnlinked($row, $table, $field): string
    {
        return BackendUtility::thumbCode(row: $row, table: $table, field: $field, linkInfoPopup: false);
    }
 
    protected function ‪renderText(string $input): string
    {
        $input = strip_tags($input);
        $input = ‪GeneralUtility::fixed_lgd_cs($input, 1500);
        return nl2br(htmlspecialchars(trim($input), ENT_QUOTES, 'UTF-8', false));
    }
 
    protected function ‪generateListForMenuContentTypes(array ‪$record): string
    {
        $table = 'pages';
        $field = 'pages';
        // get categories instead of pages
        if (str_contains(‪$record['CType'], 'menu_categorized')) {
            $table = 'sys_category';
            $field = 'selected_categories';
        }
        if (trim(‪$record[$field] ?? '') === '') {
            return '';
        }
        $content = '';
        $uidList = explode(',', ‪$record[$field]);
        foreach ($uidList as ‪$uid) {
            ‪$uid = (int)‪$uid;
            $pageRecord = BackendUtility::getRecord($table, ‪$uid, 'title');
            if ($pageRecord) {
                $content .= '<li class="list-group-item">' . htmlspecialchars($pageRecord['title']) . ' <span class="text-body-secondary">[' . ‪$uid . ']</span></li>';
            }
        }
        return $content ? '<ul class="list-group">' . $content . '</ul>' : '';
    }
 
    protected function ‪linkEditContent(string $linkText, $row): string
    {
        if (empty($linkText)) {
            return $linkText;
        }
 
        $backendUser = $this->‪getBackendUser();
        if ($backendUser->check('tables_modify', 'tt_content')
            && $backendUser->recordEditAccessInternals('tt_content', $row)
            && (new ‪Permission($backendUser->calcPerms(BackendUtility::getRecord('pages', $row['pid']) ?? [])))->editContentPermissionIsGranted()
        ) {
            $urlParameters = [
                'edit' => [
                    'tt_content' => [
                        $row['uid'] => 'edit',
                    ],
                ],
                'returnUrl' => ‪$GLOBALS['TYPO3_REQUEST']->getAttribute('normalizedParams')->getRequestUri() . '#element-tt_content-' . $row['uid'],
            ];
            $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
            ‪$url = (string)$uriBuilder->buildUriFromRoute('record_edit', $urlParameters);
            return '<a href="' . htmlspecialchars(‪$url) . '" title="' . htmlspecialchars($this->‪getLanguageService()->sL('LLL:EXT:backend/Resources/Private/Language/locallang_layout.xlf:edit')) . '">' . $linkText . '</a>';
        }
        return $linkText;
    }
 
    protected function ‪getBackendUser(): ‪BackendUserAuthentication
    {
        return ‪$GLOBALS['BE_USER'];
    }
 
    protected function ‪getLanguageService(): ‪LanguageService
    {
        return ‪$GLOBALS['LANG'];
    }
 
    protected function ‪getIconFactory(): ‪IconFactory
    {
        return GeneralUtility::makeInstance(IconFactory::class);
    }
}