TypoScriptTemplateInformationModuleFunctionController.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Tstemplate\Controller;

/*
 * 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\Module\AbstractFunctionModule;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\DataHandling\DataHandler;
use TYPO3\CMS\Core\TypoScript\ExtendedTemplateService;
use TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\HttpUtility;
use TYPO3\CMS\Fluid\View\StandaloneView;
use TYPO3\CMS\Lang\LanguageService;

class TypoScriptTemplateInformationModuleFunctionController extends AbstractFunctionModule
{
    public $tce_processed = false;

    public $pObj;

    protected $templateRow;

    protected $templateService;

    public function tableRowData($label, $data, $field, $id)
    {
        if ($field === 'config' || $field === 'constants') {
            $urlParameters = [
                'id' => $this->pObj->id,
                'e' => [
                    $field => 1
                ]
            ];
            $url = BackendUtility::getModuleUrl('web_ts', $urlParameters);
        } else {
            $urlParameters = [
                'edit' => [
                    'sys_template' => [
                        $id => 'edit'
                    ]
                ],
                'columnsOnly' => $field,
                'createExtension' => 0,
                'returnUrl' => GeneralUtility::getIndpEnv('REQUEST_URI')
            ];
            $url = BackendUtility::getModuleUrl('record_edit', $urlParameters);
        }
        $row = [];
        $row['url'] = $url;
        $row['data'] = $data;
        $row['label'] = $label;
        return $row;
    }

    public function initialize_editor($pageId, $template_uid = 0)
    {
        $this->templateService = GeneralUtility::makeInstance(ExtendedTemplateService::class);
        $this->templateService->init();

        // Get the row of the first VISIBLE template of the page. where clause like the frontend.
        $this->templateRow = $this->templateService->ext_getFirstTemplate($pageId, $template_uid);
        if (is_array($this->templateRow)) {
            $this->templateRow = $this->processTemplateRowAfterLoading($this->templateRow);
            return true;
        }
        return false;
    }

    public function processTemplateRowAfterLoading(array $tplRow)
    {
        if ($this->pObj->MOD_SETTINGS['includeTypoScriptFileContent']) {
            // Let the recursion detection counter start at 91, so that only 10 recursive calls will be resolved
            // Otherwise the editor will be bloated with way to many lines making it hard the break the cyclic recursion.
            $tplRow['config'] = TypoScriptParser::checkIncludeLines($tplRow['config'], 91);
            $tplRow['constants'] = TypoScriptParser::checkIncludeLines($tplRow['constants'], 91);
        }
        return $tplRow;
    }

    public function processTemplateRowBeforeSaving(array $tplRow)
    {
        if ($this->pObj->MOD_SETTINGS['includeTypoScriptFileContent']) {
            $tplRow = TypoScriptParser::extractIncludes_array($tplRow);
        }
        return $tplRow;
    }

    protected function getLanguageService()
    {
        return $GLOBALS['LANG'];
    }

    public function main()
    {
        $this->pObj->MOD_MENU['includeTypoScriptFileContent'] = true;
        $e = $this->pObj->e;
        // Checking for more than one template an if, set a menu...
        $manyTemplatesMenu = $this->pObj->templateMenu();
        $template_uid = 0;
        if ($manyTemplatesMenu) {
            $template_uid = $this->pObj->MOD_SETTINGS['templatesOnPage'];
        }
        // Initialize
        $existTemplate = $this->initialize_editor($this->pObj->id, $template_uid);
        $saveId = 0;
        if ($existTemplate) {
            $saveId = $this->templateRow['_ORIG_uid'] ? : $this->templateRow['uid'];
        }
        // Create extension template
        $newId = $this->pObj->createTemplate($this->pObj->id, $saveId);
        if ($newId) {
            // Switch to new template
            $urlParameters = [
                'id' => $this->pObj->id,
                'SET[templatesOnPage]' => $newId
            ];
            $url = BackendUtility::getModuleUrl('web_ts', $urlParameters);
            HttpUtility::redirect($url);
        }
        $tce = null;
        if ($existTemplate) {
            $lang = $this->getLanguageService();
            $lang->includeLLFile('EXT:tstemplate/Resources/Private/Language/locallang_info.xlf');
            $assigns = [];
            $assigns['LLPrefix'] = 'LLL:EXT:tstemplate/Resources/Private/Language/locallang_info.xlf:';
            // Update template ?
            $POST = GeneralUtility::_POST();
            if (
                isset($POST['_savedok'])
                || isset($POST['_saveandclosedok'])
            ) {
                // Set the data to be saved
                $recData = [];
                $alternativeFileName = [];
                if (is_array($POST['data'])) {
                    foreach ($POST['data'] as $field => $val) {
                        switch ($field) {
                            case 'constants':
                            case 'config':
                                $recData['sys_template'][$saveId][$field] = $val;
                            break;
                        }
                    }
                }
                if (!empty($recData)) {
                    $recData['sys_template'][$saveId] = $this->processTemplateRowBeforeSaving($recData['sys_template'][$saveId]);
                    // Create new  tce-object
                    $tce = GeneralUtility::makeInstance(DataHandler::class);
                    $tce->alternativeFileName = $alternativeFileName;
                    // Initialize
                    $tce->start($recData, []);
                    // Saved the stuff
                    $tce->process_datamap();
                    // Clear the cache (note: currently only admin-users can clear the cache in tce_main.php)
                    $tce->clear_cacheCmd('all');
                    // tce were processed successfully
                    $this->tce_processed = true;
                    // re-read the template ...
                    $this->initialize_editor($this->pObj->id, $template_uid);
                    // reload template menu
                    $manyTemplatesMenu = $this->pObj->templateMenu();
                }
            }
            // Hook post updating template/TCE processing
            if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/tstemplate_info/class.tx_tstemplateinfo.php']['postTCEProcessingHook'])) {
                $postTCEProcessingHook = &$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/tstemplate_info/class.tx_tstemplateinfo.php']['postTCEProcessingHook'];
                if (is_array($postTCEProcessingHook)) {
                    $hookParameters = [
                        'POST' => $POST,
                        'tce' => $tce
                    ];
                    foreach ($postTCEProcessingHook as $hookFunction) {
                        GeneralUtility::callUserFunction($hookFunction, $hookParameters, $this);
                    }
                }
            }
            $assigns['title'] = trim($this->templateRow['title']);
            $assigns['siteTitle'] = trim($this->templateRow['sitetitle']);
            $assigns['templateRecord'] = $this->templateRow;
            if ($manyTemplatesMenu) {
                $assigns['manyTemplatesMenu'] = $manyTemplatesMenu;
            }
            $numberOfRows = 35;
            $assigns['numberOfRows'] = $numberOfRows;
            // If abort pressed, nothing should be edited:
            if (isset($POST['_saveandclosedok'])) {
                unset($e);
            }
            if (isset($e['constants'])) {
                $assigns['showConstantsEditor'] = true;
                $assigns['constants'] = $this->templateRow['constants'];
                $assigns['constantsLabel'] = BackendUtility::getFuncCheck($this->pObj->id, 'SET[includeTypoScriptFileContent]', $this->pObj->MOD_SETTINGS['includeTypoScriptFileContent'], '', '&e[constants]=1', 'id="checkIncludeTypoScriptFileContent"');
            }
            if (isset($e['config'])) {
                $assigns['showConfigEditor'] = true;
                $assigns['config'] = $this->templateRow['config'];
                $assigns['configLabel'] = BackendUtility::getFuncCheck($this->pObj->id, 'SET[includeTypoScriptFileContent]', $this->pObj->MOD_SETTINGS['includeTypoScriptFileContent'], '', '&e[config]=1', 'id="checkIncludeTypoScriptFileContent"');
            }

            // Processing:
            $tableRows = [];
            $tableRows[] = $this->tableRowData($lang->getLL('title'), $this->templateRow['title'], 'title', $this->templateRow['uid']);
            $tableRows[] = $this->tableRowData($lang->getLL('sitetitle'), $this->templateRow['sitetitle'], 'sitetitle', $this->templateRow['uid']);
            $tableRows[] = $this->tableRowData($lang->getLL('description'), $this->templateRow['description'], 'description', $this->templateRow['uid']);
            $tableRows[] = $this->tableRowData($lang->getLL('constants'), sprintf($lang->getLL('editToView'), trim($this->templateRow['constants']) ? count(explode(LF, $this->templateRow['constants'])) : 0), 'constants', $this->templateRow['uid']);
            $tableRows[] = $this->tableRowData($lang->getLL('setup'), sprintf($lang->getLL('editToView'), trim($this->templateRow['config']) ? count(explode(LF, $this->templateRow['config'])) : 0), 'config', $this->templateRow['uid']);
            $assigns['tableRows'] = $tableRows;

            // Edit all icon:
            $urlParameters = [
                'edit' => [
                    'sys_template' => [
                        $this->templateRow['uid'] => 'edit'
                    ]
                ],
                'createExtension' => 0,
                'returnUrl' => GeneralUtility::getIndpEnv('REQUEST_URI')
            ];
            $assigns['editAllUrl'] = BackendUtility::getModuleUrl('record_edit', $urlParameters);

            // Rendering of the output via fluid
            $view = GeneralUtility::makeInstance(StandaloneView::class);
            $view->setTemplatePathAndFilename(GeneralUtility::getFileAbsFileName(
                'EXT:tstemplate/Resources/Private/Templates/InformationModule.html'
            ));
            $view->assignMultiple($assigns);
            $theOutput = $view->render();

            // hook after compiling the output
            if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/tstemplate_info/class.tx_tstemplateinfo.php']['postOutputProcessingHook'])) {
                $postOutputProcessingHook = &$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/tstemplate_info/class.tx_tstemplateinfo.php']['postOutputProcessingHook'];
                if (is_array($postOutputProcessingHook)) {
                    $hookParameters = [
                        'theOutput' => &$theOutput,
                        'POST' => $POST,
                        'e' => $e,
                        'tplRow' => $this->templateRow,
                        'numberOfRows' => $numberOfRows
                    ];
                    foreach ($postOutputProcessingHook as $hookFunction) {
                        GeneralUtility::callUserFunction($hookFunction, $hookParameters, $this);
                    }
                }
            }
        } else {
            $theOutput = $this->pObj->noTemplate(1);
        }
        return $theOutput;
    }
}