TemplateAnalyzerModuleFunctionController::modMenu() - Code Metrics - Inspection of "[TASK] Render TS and pageTS snippets with CodeMirr..." - TYPO3/TYPO3.CMS - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 3e02b0...e0a47f )

unknown

created 2021-05-20 13:58 UTC

u() A

↳ Parent: TemplateAnalyzerModuleFunctionController::main()

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	7
nc	1
nop	0
dl	0
loc	9
rs	10
c	0
b	0
f	0

<?php

/*
 * 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\Tstemplate\Controller;

use Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Core\Page\PageRenderer;
use TYPO3\CMS\Core\TypoScript\ExtendedTemplateService;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\RootlineUtility;
use TYPO3\CMS\Fluid\View\StandaloneView;

/**
 * TypoScript template analyzer
 * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
 */
class TemplateAnalyzerModuleFunctionController
{

    /**
     * @var TypoScriptTemplateModuleController
     */
    protected $pObj;

    /**
     * The currently selected sys_template record
     * @var array|null
     */
    protected $templateRow;

    /**
     * @var ExtendedTemplateService
     */
    protected $templateService;

    /**
     * @var ServerRequestInterface
     */
    protected $request;

    /**
     * Init, called from parent object
     *
     * @param TypoScriptTemplateModuleController $pObj
     * @param ServerRequestInterface $request
     */
    public function init($pObj, ServerRequestInterface $request)
    {
        $this->pObj = $pObj;
        $this->request = $request;
    }

    /**
     * Main, called from parent object
     *
     * @return string
     */
    public function main()
    {
        // The page id TypoScript tree should be show for
        $pageUid = (int)($this->request->getParsedBody()['id'] ?? $this->request->getQueryParams()['id'] ?? 0);
        // Set if user clicked on one template to show content of this specific one
        $selectedTemplate = ($this->request->getQueryParams()['template'] ?? '');
        // The template object browser shows info boxes with parser errors and links to template analyzer to highlight
        // affected line. Increased by one if set to avoid an off-by-one error.
        $highlightLine = (int)($this->request->getQueryParams()['highlightLine'] ?? 0);
        // 'const' or 'setup' or not set
        $highlightType = (string)($this->request->getQueryParams()['highlightType'] ?? '');

        $assigns = [
            'pageUid' => $pageUid,
        ];

        $templateUid = 0;
        $assigns['manyTemplatesMenu'] = $this->pObj->templateMenu($this->request);
        if ($assigns['manyTemplatesMenu']) {
            $templateUid = (int)$this->pObj->MOD_SETTINGS['templatesOnPage'];
        }

        $assigns['existTemplate'] = $this->initializeTemplates($pageUid, $templateUid);
        if ($assigns['existTemplate']) {
            $assigns['templateRecord'] = $this->templateRow;
            $assigns['linkWrappedTemplateTitle'] = $this->pObj->linkWrapTemplateTitle($this->templateRow['title']);
        }

        $this->templateService->clearList_const_temp = array_flip($this->templateService->clearList_const);
        $this->templateService->clearList_setup_temp = array_flip($this->templateService->clearList_setup);
        $pointer = count($this->templateService->hierarchyInfo);
        $hierarchyInfo = $this->templateService->ext_process_hierarchyInfo([], $pointer);
        $assigns['hierarchy'] = implode('', array_reverse($this->templateService->ext_getTemplateHierarchyArr(
            $hierarchyInfo,
            '',
            [],
            1
        )));

        $assigns['constants'] =  $this->renderTemplates($this->templateService->constants, $selectedTemplate, $highlightType === 'const', $highlightLine);
        $assigns['setups'] =  $this->renderTemplates($this->templateService->config, $selectedTemplate, $highlightType === 'setup', $highlightLine);

        if (ExtensionManagementUtility::isLoaded('t3editor')) {
            // @todo: Let EXT:t3editor add the deps via events in the render-loops above
            $pageRenderer = GeneralUtility::makeInstance(PageRenderer::class);
            $pageRenderer->addCssFile('EXT:t3editor/Resources/Public/JavaScript/Contrib/codemirror/lib/codemirror.css');
            $pageRenderer->addCssFile('EXT:t3editor/Resources/Public/Css/t3editor.css');
            $pageRenderer->loadRequireJsModule('TYPO3/CMS/T3editor/Element/CodeMirrorElement');
        }

        $view = GeneralUtility::makeInstance(StandaloneView::class);
        $view->setTemplatePathAndFilename('EXT:tstemplate/Resources/Private/Templates/TemplateAnalyzerModuleFunction.html');
        $view->assignMultiple($assigns);
        return $view->render();
    }

    protected function initializeTemplates(int $pageId, int $templateUid = 0): bool
    {
        // Initializes the module. Done in this function because we may need to re-initialize if data is submitted!
        $this->templateService = GeneralUtility::makeInstance(ExtendedTemplateService::class);

        // Gets the rootLine
        $rootlineUtility = GeneralUtility::makeInstance(RootlineUtility::class, $pageId);
        $rootLine = $rootlineUtility->get();

        // This generates the constants/config + hierarchy info for the template.
        $this->templateService->runThroughTemplates($rootLine, $templateUid);

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

    /**
     * Render constants or setup templates using t3editor or plain textarea
     *
     * @param array $templates
     * @param string $selectedTemplate
     * @param bool $highlight
     * @param int $highlightLine
     * @return array Modified assign array
     */
    protected function renderTemplates(array $templates, string $selectedTemplate, bool $highlight, int $highlightLine): array
    {
        $templatesMarkup = [];
        $totalLines = 0;
        foreach ($templates as $templateNumber => $templateContent) {
            $totalLines += 1 + count(explode(LF, $templateContent));
        }
        $thisLineOffset = $nextLineOffset = 0;
        foreach ($templates as $templateNumber => $templateContent) {
            $templateId = $this->templateService->hierarchyInfo[$templateNumber]['templateID'];
            $templateTitle = $this->templateService->hierarchyInfo[$templateNumber]['title'] ?? 'Template';
            // Prefix content with '[GLOBAL]' even for empty strings, the TemplateService does that, too.
            // Not replicating this leads to shifted line numbers when parser errors are reported in FE and object browser.
            // @todo: Locate where TemplateService hard prefixes this for empty strings and drop it.
            $templateContent = '[GLOBAL]' . LF . (string)$templateContent;
            $linesInTemplate = count(explode(LF, $templateContent));
            $nextLineOffset += $linesInTemplate;
            if ($selectedTemplate === 'all'
                || $templateId === $selectedTemplate
                || $highlight && $highlightLine && $highlightLine > $thisLineOffset && $highlightLine <= $nextLineOffset
            ) {
                if (ExtensionManagementUtility::isLoaded('t3editor')) {
                    // @todo: Fire event and let EXT:t3editor fill the markup
                    $templatesMarkup[] = $this->getCodeMirrorMarkup(
                        $templateTitle,
                        $thisLineOffset,
                        $linesInTemplate,
                        $totalLines,
                        $highlight ? $highlightLine : 0,
                        $templateContent
                    );
                } else {
                    $templatesMarkup[] = $this->getTextareaMarkup(
                        $templateTitle,
                        $linesInTemplate,
                        $templateContent
                    );
                }
            }
            $thisLineOffset = $nextLineOffset;
        }
        return $templatesMarkup;
    }

    protected function getCodeMirrorMarkup(
        string $label,
        int $lineOffset,
        int $lines,
        int $totalLines,
        int $highlightLine,
        string $content
    ): string {
        $codeMirrorConfig = [
            'label' => $label,
            'panel' => 'top',
            'mode' => 'TYPO3/CMS/T3editor/Mode/typoscript/typoscript',
            'autoheight' => 'true',
            'nolazyload' => 'true',
            'linedigits' => (string)strlen((string)$totalLines),
            'options' => GeneralUtility::jsonEncodeForHtmlAttribute([
                'readOnly' => true,
                'format' => 'typoscript',
                'rows' => 'auto',
                'firstLineNumber' => $lineOffset + 1,
            ], false),
        ];
        $textareaAttributes = [
            'rows' => (string)$lines,
            'readonly' => 'readonly',
        ];

        // If we want to highlight
        if ($highlightLine && $highlightLine >= $lineOffset && $highlightLine <= ($lineOffset + $lines)) {
            // Scroll to affected line and highlight line if requested
            $targetLineInTemplate = $highlightLine - $lineOffset;
            $codeMirrorConfig['scrollto'] = (string)$targetLineInTemplate;
            $codeMirrorConfig['marktext'] = GeneralUtility::jsonEncodeForHtmlAttribute([
                [
                    'from' => [
                        'line' => $targetLineInTemplate - 1,
                        'ch' => 0,
                    ],
                    'to' => [
                        'line' => $targetLineInTemplate - 1,
                        // Arbitrary high value to match full line
                        'ch' => 10000,
                    ]
                ]
            ], false);
        }

        $code = '<typo3-t3editor-codemirror ' . GeneralUtility::implodeAttributes($codeMirrorConfig, true) . '>';
        $code .= '<textarea ' . GeneralUtility::implodeAttributes($textareaAttributes, true) . '>' . htmlspecialchars($content) . '</textarea>';
        $code .= '</typo3-t3editor-codemirror>';

        return $code;
    }

    protected function getTextareaMarkup(string $title, int $linesInTemplate, string $content): string
    {
        return htmlspecialchars($title)
            . '<textarea class="form-control" rows="' . ($linesInTemplate + 1) . '" disabled>'
            . htmlspecialchars($content)
            . '</textarea>';
    }
}


1			<?php
2
3			/*
4			* This file is part of the TYPO3 CMS project.
5			*
6			* It is free software; you can redistribute it and/or modify it under
7			* the terms of the GNU General Public License, either version 2
8			* of the License, or any later version.
9			*
10			* For the full copyright and license information, please read the
11			* LICENSE.txt file that was distributed with this source code.
12			*
13			* The TYPO3 project - inspiring people to share!
14			*/
15
16			namespace TYPO3\CMS\Tstemplate\Controller;
17
18			use Psr\Http\Message\ServerRequestInterface;
19			use TYPO3\CMS\Core\Page\PageRenderer;
20			use TYPO3\CMS\Core\TypoScript\ExtendedTemplateService;
21			use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
22			use TYPO3\CMS\Core\Utility\GeneralUtility;
23			use TYPO3\CMS\Core\Utility\RootlineUtility;
24			use TYPO3\CMS\Fluid\View\StandaloneView;
25
26			/**
27			* TypoScript template analyzer
28			* @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
29			*/
30			class TemplateAnalyzerModuleFunctionController
31			{
32
33			/**
34			* @var TypoScriptTemplateModuleController
35			*/
36			protected $pObj;
37
38			/**
39			* The currently selected sys_template record
40			* @var array\|null
41			*/
42			protected $templateRow;
43
44			/**
45			* @var ExtendedTemplateService
46			*/
47			protected $templateService;
48
49			/**
50			* @var ServerRequestInterface
51			*/
52			protected $request;
53
54			/**
55			* Init, called from parent object
56			*
57			* @param TypoScriptTemplateModuleController $pObj
58			* @param ServerRequestInterface $request
59			*/
60			public function init($pObj, ServerRequestInterface $request)
61			{
62			$this->pObj = $pObj;
63			$this->request = $request;
64			}
65
66			/**
67			* Main, called from parent object
68			*
69			* @return string
70			*/
71			public function main()
72			{
73			// The page id TypoScript tree should be show for
74			$pageUid = (int)($this->request->getParsedBody()['id'] ?? $this->request->getQueryParams()['id'] ?? 0);
75			// Set if user clicked on one template to show content of this specific one
76			$selectedTemplate = ($this->request->getQueryParams()['template'] ?? '');
77			// The template object browser shows info boxes with parser errors and links to template analyzer to highlight
78			// affected line. Increased by one if set to avoid an off-by-one error.
79			$highlightLine = (int)($this->request->getQueryParams()['highlightLine'] ?? 0);
80			// 'const' or 'setup' or not set
81			$highlightType = (string)($this->request->getQueryParams()['highlightType'] ?? '');
82
83			$assigns = [
84			'pageUid' => $pageUid,
85			];
86
87			$templateUid = 0;
88			$assigns['manyTemplatesMenu'] = $this->pObj->templateMenu($this->request);
89			if ($assigns['manyTemplatesMenu']) {
90			$templateUid = (int)$this->pObj->MOD_SETTINGS['templatesOnPage'];
91			}
92
93			$assigns['existTemplate'] = $this->initializeTemplates($pageUid, $templateUid);
94			if ($assigns['existTemplate']) {
95			$assigns['templateRecord'] = $this->templateRow;
96			$assigns['linkWrappedTemplateTitle'] = $this->pObj->linkWrapTemplateTitle($this->templateRow['title']);
97			}
98
99			$this->templateService->clearList_const_temp = array_flip($this->templateService->clearList_const);
100			$this->templateService->clearList_setup_temp = array_flip($this->templateService->clearList_setup);
101			$pointer = count($this->templateService->hierarchyInfo);
102			$hierarchyInfo = $this->templateService->ext_process_hierarchyInfo([], $pointer);
103			$assigns['hierarchy'] = implode('', array_reverse($this->templateService->ext_getTemplateHierarchyArr(
104			$hierarchyInfo,
105			'',
106			[],
107			1
108			)));
109
110			$assigns['constants'] = $this->renderTemplates($this->templateService->constants, $selectedTemplate, $highlightType === 'const', $highlightLine);
111			$assigns['setups'] = $this->renderTemplates($this->templateService->config, $selectedTemplate, $highlightType === 'setup', $highlightLine);
112
113			if (ExtensionManagementUtility::isLoaded('t3editor')) {
114			// @todo: Let EXT:t3editor add the deps via events in the render-loops above
115			$pageRenderer = GeneralUtility::makeInstance(PageRenderer::class);
116			$pageRenderer->addCssFile('EXT:t3editor/Resources/Public/JavaScript/Contrib/codemirror/lib/codemirror.css');
117			$pageRenderer->addCssFile('EXT:t3editor/Resources/Public/Css/t3editor.css');
118			$pageRenderer->loadRequireJsModule('TYPO3/CMS/T3editor/Element/CodeMirrorElement');
119			}
120
121			$view = GeneralUtility::makeInstance(StandaloneView::class);
122			$view->setTemplatePathAndFilename('EXT:tstemplate/Resources/Private/Templates/TemplateAnalyzerModuleFunction.html');
123			$view->assignMultiple($assigns);
124			return $view->render();
125			}
126
127			protected function initializeTemplates(int $pageId, int $templateUid = 0): bool
128			{
129			// Initializes the module. Done in this function because we may need to re-initialize if data is submitted!
130			$this->templateService = GeneralUtility::makeInstance(ExtendedTemplateService::class);
131
132			// Gets the rootLine
133			$rootlineUtility = GeneralUtility::makeInstance(RootlineUtility::class, $pageId);
134			$rootLine = $rootlineUtility->get();
135
136			// This generates the constants/config + hierarchy info for the template.
137			$this->templateService->runThroughTemplates($rootLine, $templateUid);
138
139			// Get the row of the first VISIBLE template of the page. where clause like the frontend.
140			$this->templateRow = $this->templateService->ext_getFirstTemplate($pageId, $templateUid);
141			return is_array($this->templateRow);
142			}
143
144			/**
145			* Render constants or setup templates using t3editor or plain textarea
146			*
147			* @param array $templates
148			* @param string $selectedTemplate
149			* @param bool $highlight
150			* @param int $highlightLine
151			* @return array Modified assign array
152			*/
153			protected function renderTemplates(array $templates, string $selectedTemplate, bool $highlight, int $highlightLine): array
154			{
155			$templatesMarkup = [];
156			$totalLines = 0;
157			foreach ($templates as $templateNumber => $templateContent) {
158			$totalLines += 1 + count(explode(LF, $templateContent));
159			}
160			$thisLineOffset = $nextLineOffset = 0;
161			foreach ($templates as $templateNumber => $templateContent) {
162			$templateId = $this->templateService->hierarchyInfo[$templateNumber]['templateID'];
163			$templateTitle = $this->templateService->hierarchyInfo[$templateNumber]['title'] ?? 'Template';
164			// Prefix content with '[GLOBAL]' even for empty strings, the TemplateService does that, too.
165			// Not replicating this leads to shifted line numbers when parser errors are reported in FE and object browser.
166			// @todo: Locate where TemplateService hard prefixes this for empty strings and drop it.
167			$templateContent = '[GLOBAL]' . LF . (string)$templateContent;
168			$linesInTemplate = count(explode(LF, $templateContent));
169			$nextLineOffset += $linesInTemplate;
170			if ($selectedTemplate === 'all'
171			\|\| $templateId === $selectedTemplate
172			\|\| $highlight && $highlightLine && $highlightLine > $thisLineOffset && $highlightLine <= $nextLineOffset
173			) {
174			if (ExtensionManagementUtility::isLoaded('t3editor')) {
175			// @todo: Fire event and let EXT:t3editor fill the markup
176			$templatesMarkup[] = $this->getCodeMirrorMarkup(
177			$templateTitle,
178			$thisLineOffset,
179			$linesInTemplate,
180			$totalLines,
181			$highlight ? $highlightLine : 0,
182			$templateContent
183			);
184			} else {
185			$templatesMarkup[] = $this->getTextareaMarkup(
186			$templateTitle,
187			$linesInTemplate,
188			$templateContent
189			);
190			}
191			}
192			$thisLineOffset = $nextLineOffset;
193			}
194			return $templatesMarkup;
195			}
196
197			protected function getCodeMirrorMarkup(
198			string $label,
199			int $lineOffset,
200			int $lines,
201			int $totalLines,
202			int $highlightLine,
203			string $content
204			): string {
205			$codeMirrorConfig = [
206			'label' => $label,
207			'panel' => 'top',
208			'mode' => 'TYPO3/CMS/T3editor/Mode/typoscript/typoscript',
209			'autoheight' => 'true',
210			'nolazyload' => 'true',
211			'linedigits' => (string)strlen((string)$totalLines),
212			'options' => GeneralUtility::jsonEncodeForHtmlAttribute([
213			'readOnly' => true,
214			'format' => 'typoscript',
215			'rows' => 'auto',
216			'firstLineNumber' => $lineOffset + 1,
217			], false),
218			];
219			$textareaAttributes = [
220			'rows' => (string)$lines,
221			'readonly' => 'readonly',
222			];
223
224			// If we want to highlight
225			if ($highlightLine && $highlightLine >= $lineOffset && $highlightLine <= ($lineOffset + $lines)) {
226			// Scroll to affected line and highlight line if requested
227			$targetLineInTemplate = $highlightLine - $lineOffset;
228			$codeMirrorConfig['scrollto'] = (string)$targetLineInTemplate;
229			$codeMirrorConfig['marktext'] = GeneralUtility::jsonEncodeForHtmlAttribute([
230			[
231			'from' => [
232			'line' => $targetLineInTemplate - 1,
233			'ch' => 0,
234			],
235			'to' => [
236			'line' => $targetLineInTemplate - 1,
237			// Arbitrary high value to match full line
238			'ch' => 10000,
239			]
240			]
241			], false);
242			}
243
244			$code = '<typo3-t3editor-codemirror ' . GeneralUtility::implodeAttributes($codeMirrorConfig, true) . '>';
245			$code .= '<textarea ' . GeneralUtility::implodeAttributes($textareaAttributes, true) . '>' . htmlspecialchars($content) . '</textarea>';
246			$code .= '</typo3-t3editor-codemirror>';
247
248			return $code;
249			}
250
251			protected function getTextareaMarkup(string $title, int $linesInTemplate, string $content): string
252			{
253			return htmlspecialchars($title)
254			. '<textarea class="form-control" rows="' . ($linesInTemplate + 1) . '" disabled>'
255			. htmlspecialchars($content)
256			. '</textarea>';
257			}
258			}
259

TYPO3 / TYPO3.CMS

Push — master ( 3e02b0...e0a47f )

u() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like