<?php
namespace TYPO3\CMS\T3editor;

/*
 * 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 Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Code completion for t3editor
 */
class CodeCompletion
{
    /**
     * @var \TYPO3\CMS\Core\Http\AjaxRequestHandler
     */
    protected $ajaxObj;

    /**
     * Default constructor
     */
    public function __construct()
    {
        $GLOBALS['LANG']->includeLLFile('EXT:t3editor/Resources/Private/Language/locallang.xlf');
    }

    /**
     * General processor for AJAX requests.
     * Called by AjaxRequestHandler
     *
     * @param ServerRequestInterface $request
     * @param ResponseInterface $response
     * @return ResponseInterface
     */
    public function processAjaxRequest(ServerRequestInterface $request, ResponseInterface $response)
    {
        $pageId = (int)(isset($request->getParsedBody()['pageId']) ? $request->getParsedBody()['pageId'] : $request->getQueryParams()['pageId']);
        return $this->loadTemplates($pageId);
    }

    /**
     * Loads all templates up to a given page id (walking the rootline) and
     * cleans parts that are not required for the t3editor codecompletion.
     *
     * @param int $pageId ID of the page
     * @return ResponseInterface
     */
    protected function loadTemplates($pageId)
    {
        /** @var \TYPO3\CMS\Core\Http\Response $response */
        $response = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Http\Response::class);

        // Check whether access is granted (only admin have access to sys_template records):
        if ($GLOBALS['BE_USER']->isAdmin()) {
            // Check whether there is a pageId given:
            if ($pageId) {
                $response->getBody()->write(json_encode($this->getMergedTemplates($pageId)));
            } else {
                $response->getBody()->write($GLOBALS['LANG']->getLL('pageIDInteger'));
                $response = $response->withStatus(500);
            }
        } else {
            $response->getBody()->write($GLOBALS['LANG']->getLL('noPermission'));
            $response = $response->withStatus(500);
        }
        return $response;
    }

    /**
     * Gets merged templates by walking the rootline to a given page id.
     *
     * @todo oliver@typo3.org: Refactor this method and comment what's going on there
     * @param int $pageId
     * @param int $templateId
     * @return array Setup part of merged template records
     */
    protected function getMergedTemplates($pageId, $templateId = 0)
    {
        /** @var $tsParser \TYPO3\CMS\Core\TypoScript\ExtendedTemplateService */
        $tsParser = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Core\TypoScript\ExtendedTemplateService::class);
        $tsParser->init();
        // Gets the rootLine
        $page = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Frontend\Page\PageRepository::class);
        $rootLine = $page->getRootLine($pageId);
        // This generates the constants/config + hierarchy info for the template.
        $tsParser->runThroughTemplates($rootLine);
        // ts-setup & ts-constants of the currently edited template should not be included
        // therefor we have to delete the last template from the stack
        array_pop($tsParser->config);
        array_pop($tsParser->constants);
        $tsParser->linkObjects = true;
        $tsParser->ext_regLinenumbers = false;
        $tsParser->generateConfig();
        $result = $this->treeWalkCleanup($tsParser->setup);
        return $result;
    }

    /**
     * Walks through a tree of TypoScript configuration an cleans it up.
     *
     * @TODO oliver@typo3.org: Define and comment why this is necessary and exactly happens below
     * @param array $treeBranch TypoScript configuration or sub branch of it
     * @return array Cleaned TypoScript branch
     */
    private function treeWalkCleanup(array $treeBranch)
    {
        $cleanedTreeBranch = array();
        foreach ($treeBranch as $key => $value) {
            $dotCount = substr_count($key, '.');
            //type definition or value-assignment
            if ($dotCount == 0) {
                if ($value != '') {
                    if (strlen($value) > 20) {
                        $value = substr($value, 0, 20);
                    }
                    if (!isset($cleanedTreeBranch[$key])) {
                        $cleanedTreeBranch[$key] = array();
                    }
                    $cleanedTreeBranch[$key]['v'] = $value;
                }
            } elseif ($dotCount == 1) {
                // subtree (definition of properties)
                $subBranch = $this->treeWalkCleanup($value);
                if ($subBranch) {
                    $key = str_replace('.', '', $key);
                    if (!isset($cleanedTreeBranch[$key])) {
                        $cleanedTreeBranch[$key] = array();
                    }
                    $cleanedTreeBranch[$key]['c'] = $subBranch;
                }
            }
        }
        return $cleanedTreeBranch;
    }
}
