ExtDirectApi.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\ExtDirect;

/*
 * 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\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;

class ExtDirectApi
{
    protected $settings = [];

    public function __construct()
    {
        if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ExtDirect']) && is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ExtDirect'])) {
            $this->settings = $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ExtDirect'];
        }
    }

    public function getAPI(ServerRequestInterface $request, ResponseInterface $response)
    {
        $response->getBody()->write(json_encode([]));
        return $response;
    }

    public function getApiPhp(array $filterNamespaces)
    {
        $javascriptNamespaces = $this->getExtDirectApi($filterNamespaces);
        // Return the generated javascript API configuration
        if (!empty($javascriptNamespaces)) {
            return '
                if (!Ext.isObject(Ext.app.ExtDirectAPI)) {
                    Ext.app.ExtDirectAPI = {};
                }
                Ext.apply(Ext.app.ExtDirectAPI, ' . json_encode($javascriptNamespaces) . ');
            ';
        } else {
            $errorMessage = $this->getNamespaceError($filterNamespaces);
            throw new \InvalidArgumentException($errorMessage, 1297645190);
        }
    }

    protected function generateAPI(array $filterNamespaces)
    {
        $javascriptNamespaces = [];
        if (is_array($this->settings)) {
            foreach ($this->settings as $javascriptName => $configuration) {
                $splittedJavascriptName = explode('.', $javascriptName);
                $javascriptObjectName = array_pop($splittedJavascriptName);
                $javascriptNamespace = implode('.', $splittedJavascriptName);
                // Only items inside the wanted namespace
                if (!$this->findNamespace($javascriptNamespace, $filterNamespaces)) {
                    continue;
                }
                if (!isset($javascriptNamespaces[$javascriptNamespace])) {
                    $javascriptNamespaces[$javascriptNamespace] = [
                        'url' => $this->getRoutingUrl($javascriptNamespace),
                        'type' => 'remoting',
                        'actions' => [],
                        'namespace' => $javascriptNamespace
                    ];
                }
                if (is_array($configuration)) {
                    $className = $configuration['callbackClass'];
                    $serverObject = GeneralUtility::getUserObj($className);
                    $javascriptNamespaces[$javascriptNamespace]['actions'][$javascriptObjectName] = [];
                    foreach (get_class_methods($serverObject) as $methodName) {
                        $reflectionMethod = new \ReflectionMethod($serverObject, $methodName);
                        $numberOfParameters = $reflectionMethod->getNumberOfParameters();
                        $docHeader = $reflectionMethod->getDocComment();
                        $formHandler = strpos($docHeader, '@formHandler') !== false;
                        $javascriptNamespaces[$javascriptNamespace]['actions'][$javascriptObjectName][] = [
                            'name' => $methodName,
                            'len' => $numberOfParameters,
                            'formHandler' => $formHandler
                        ];
                    }
                }
            }
        }
        return $javascriptNamespaces;
    }

    public function getRoutingUrl($namespace)
    {
        if (TYPO3_MODE === 'FE') {
            $url = GeneralUtility::locationHeaderUrl('?eID=ExtDirect&action=route&namespace=' . rawurlencode($namespace));
        } else {
            $url = BackendUtility::getAjaxUrl('ext_direct_route', ['namespace' => $namespace]);
        }
        return $url;
    }

    protected function getExtDirectApi(array $filterNamespaces)
    {
        $noCache = (bool)GeneralUtility::_GET('no_cache');
        // Look up into the cache
        $cacheIdentifier = 'ExtDirectApi';
        $cacheHash = md5($cacheIdentifier . implode(',', $filterNamespaces) . GeneralUtility::getIndpEnv('TYPO3_SSL') . serialize($this->settings) . TYPO3_MODE . GeneralUtility::getIndpEnv('HTTP_HOST'));
        // With no_cache always generate the javascript content
        // Generate the javascript content if it wasn't found inside the cache and cache it!
        if ($noCache || !is_array(($javascriptNamespaces = \TYPO3\CMS\Frontend\Page\PageRepository::getHash($cacheHash)))) {
            $javascriptNamespaces = $this->generateAPI($filterNamespaces);
            if (!empty($javascriptNamespaces)) {
                \TYPO3\CMS\Frontend\Page\PageRepository::storeHash($cacheHash, $javascriptNamespaces, $cacheIdentifier);
            }
        }
        return $javascriptNamespaces;
    }

    protected function getNamespaceError(array $filterNamespaces)
    {
        if (!empty($filterNamespaces)) {
            // Namespace error
            $errorMessage = sprintf($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:ExtDirect.namespaceError'), __CLASS__, implode(',', $filterNamespaces));
        } else {
            // No namespace given
            $errorMessage = sprintf($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:ExtDirect.noNamespace'), __CLASS__);
        }
        return $errorMessage;
    }

    protected function findNamespace($namespace, array $filterNamespaces)
    {
        if ($filterNamespaces === ['TYPO3']) {
            return true;
        }
        $found = false;
        foreach ($filterNamespaces as $filter) {
            if (GeneralUtility::isFirstPartOfStr($filter, $namespace)) {
                $found = true;
                break;
            }
        }
        return $found;
    }
}