first commit

typo3/sysext/extbase/Classes/Mvc/View/AbstractView.php

@@ -0,0 +1,95 @@
+<?php
+namespace TYPO3\CMS\Extbase\Mvc\View;
+
+/*
+ * 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!
+ */
+
+/**
+ * An abstract View
+ */
+abstract class AbstractView implements \TYPO3\CMS\Extbase\Mvc\View\ViewInterface
+{
+    /**
+     * @var \TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext
+     */
+    protected $controllerContext;
+
+    /**
+     * View variables and their values
+     *
+     * @var array
+     * @see assign()
+     */
+    protected $variables = [];
+
+    /**
+     * Sets the current controller context
+     *
+     * @param \TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext
+     */
+    public function setControllerContext(\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext)
+    {
+        $this->controllerContext = $controllerContext;
+    }
+
+    /**
+     * Add a variable to $this->viewData.
+     * Can be chained, so $this->view->assign(..., ...)->assign(..., ...); is possible
+     *
+     * @param string $key Key of variable
+     * @param mixed $value Value of object
+     * @return \TYPO3\CMS\Extbase\Mvc\View\AbstractView an instance of $this, to enable chaining
+     */
+    public function assign($key, $value)
+    {
+        $this->variables[$key] = $value;
+        return $this;
+    }
+
+    /**
+     * Add multiple variables to $this->viewData.
+     *
+     * @param array $values array in the format array(key1 => value1, key2 => value2).
+     * @return \TYPO3\CMS\Extbase\Mvc\View\AbstractView an instance of $this, to enable chaining
+     */
+    public function assignMultiple(array $values)
+    {
+        foreach ($values as $key => $value) {
+            $this->assign($key, $value);
+        }
+        return $this;
+    }
+
+    /**
+     * Tells if the view implementation can render the view for the given context.
+     *
+     * By default we assume that the view implementation can handle all kinds of
+     * contexts. Override this method if that is not the case.
+     *
+     * @param \TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext
+     * @return bool TRUE if the view has something useful to display, otherwise FALSE
+     */
+    public function canRender(\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext)
+    {
+        return true;
+    }
+
+    /**
+     * Initializes this view.
+     *
+     * Override this method for initializing your concrete view implementation.
+     */
+    public function initializeView()
+    {
+    }
+}

typo3/sysext/extbase/Classes/Mvc/View/EmptyView.php

@@ -0,0 +1,99 @@
+<?php
+namespace TYPO3\CMS\Extbase\Mvc\View;
+
+/*
+ * 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!
+ */
+
+/**
+ * An empty view - a special case.
+ */
+class EmptyView implements \TYPO3\CMS\Extbase\Mvc\View\ViewInterface
+{
+    /**
+     * Dummy method to satisfy the ViewInterface
+     *
+     * @param \TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext
+     * @internal
+     */
+    public function setControllerContext(\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext)
+    {
+    }
+
+    /**
+     * Dummy method to satisfy the ViewInterface
+     *
+     * @param string $key
+     * @param mixed $value
+     * @return \TYPO3\CMS\Extbase\Mvc\View\EmptyView instance of $this to allow chaining
+     */
+    public function assign($key, $value)
+    {
+        return $this;
+    }
+
+    /**
+     * Dummy method to satisfy the ViewInterface
+     *
+     * @param array $values
+     * @return \TYPO3\CMS\Extbase\Mvc\View\EmptyView instance of $this to allow chaining
+     */
+    public function assignMultiple(array $values)
+    {
+        return $this;
+    }
+
+    /**
+     * This view can be used in any case.
+     *
+     * @param \TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext
+     * @return bool TRUE
+     */
+    public function canRender(\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext)
+    {
+        return true;
+    }
+
+    /**
+     * Renders the empty view
+     *
+     * @return string An empty string
+     */
+    public function render()
+    {
+        return '<!-- This is the output of the Empty View. An appropriate View was not found. -->';
+    }
+
+    /**
+     * A magic call method.
+     *
+     * Because this empty view is used as a Special Case in situations when no matching
+     * view is available, it must be able to handle method calls which originally were
+     * directed to another type of view. This magic method should prevent PHP from issuing
+     * a fatal error.
+     *
+     * @param string $methodName
+     * @param array $arguments
+     */
+    public function __call($methodName, array $arguments)
+    {
+    }
+
+    /**
+     * Initializes this view.
+     *
+     * Override this method for initializing your concrete view implementation.
+     */
+    public function initializeView()
+    {
+    }
+}

typo3/sysext/extbase/Classes/Mvc/View/JsonView.php

@@ -0,0 +1,341 @@
+<?php
+declare(strict_types = 1);
+
+namespace TYPO3\CMS\Extbase\Mvc\View;
+
+/*
+ * 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\Extbase\Mvc\Web\Response as WebResponse;
+use TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface;
+use TYPO3\CMS\Extbase\Reflection\ObjectAccess;
+use TYPO3\CMS\Extbase\Reflection\ReflectionService;
+use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
+
+/**
+ * A JSON view
+ */
+class JsonView extends AbstractView
+{
+    /**
+     * Definition for the class name exposure configuration,
+     * that is, if the class name of an object should also be
+     * part of the output JSON, if configured.
+     *
+     * Setting this value, the object's class name is fully
+     * put out, including the namespace.
+     */
+    const EXPOSE_CLASSNAME_FULLY_QUALIFIED = 1;
+
+    /**
+     * Puts out only the actual class name without namespace.
+     * See EXPOSE_CLASSNAME_FULL for the meaning of the constant at all.
+     */
+    const EXPOSE_CLASSNAME_UNQUALIFIED = 2;
+
+    /**
+     * @var ReflectionService
+     */
+    protected $reflectionService;
+
+    /**
+     * @var \TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext
+     */
+    protected $controllerContext;
+
+    /**
+     * Only variables whose name is contained in this array will be rendered
+     *
+     * @var string[]
+     */
+    protected $variablesToRender = ['value'];
+
+    /**
+     * The rendering configuration for this JSON view which
+     * determines which properties of each variable to render.
+     *
+     * The configuration array must have the following structure:
+     *
+     * Example 1:
+     *
+     * [
+     *      'variable1' => [
+     *          '_only' => ['property1', 'property2', ...]
+     *      ],
+     *      'variable2' => [
+     *          '_exclude' => ['property3', 'property4, ...]
+     *      ],
+     *      'variable3' => [
+     *          '_exclude' => ['secretTitle'],
+     *          '_descend' => [
+     *              'customer' => [
+     *                  '_only' => [array(]'firstName', 'lastName']
+     *              ]
+     *          ]
+     *      ],
+     *      'somearrayvalue' => [
+     *          '_descendAll' => [
+     *              '_only' => ['property1']
+     *          ]
+     *      ]
+     * ]
+     *
+     * Of variable1 only property1 and property2 will be included.
+     * Of variable2 all properties except property3 and property4
+     * are used.
+     * Of variable3 all properties except secretTitle are included.
+     *
+     * If a property value is an array or object, it is not included
+     * by default. If, however, such a property is listed in a "_descend"
+     * section, the renderer will descend into this sub structure and
+     * include all its properties (of the next level).
+     *
+     * The configuration of each property in "_descend" has the same syntax
+     * like at the top level. Therefore - theoretically - infinitely nested
+     * structures can be configured.
+     *
+     * To export indexed arrays the "_descendAll" section can be used to
+     * include all array keys for the output. The configuration inside a
+     * "_descendAll" will be applied to each array element.
+     *
+     *
+     * Example 2: exposing object identifier
+     *
+     * [
+     *      'variableFoo' => [
+     *          '_exclude' => ['secretTitle'],
+     *          '_descend' => [
+     *              'customer' => [    // consider 'customer' being a persisted entity
+     *                  '_only' => ['firstName'],
+     *                  '_exposeObjectIdentifier' => TRUE,
+     *                  '_exposedObjectIdentifierKey' => 'guid'
+     *              ]
+     *          ]
+     *      ]
+     * ]
+     *
+     * Note for entity objects you are able to expose the object's identifier
+     * also, just add an "_exposeObjectIdentifier" directive set to TRUE and
+     * an additional property '__identity' will appear keeping the persistence
+     * identifier. Renaming that property name instead of '__identity' is also
+     * possible with the directive "_exposedObjectIdentifierKey".
+     * Example 2 above would output (summarized):
+     * {"customer":{"firstName":"John","guid":"892693e4-b570-46fe-af71-1ad32918fb64"}}
+     *
+     *
+     * Example 3: exposing object's class name
+     *
+     * [
+     *      'variableFoo' => [
+     *          '_exclude' => ['secretTitle'],
+     *          '_descend' => [
+     *              'customer' => [    // consider 'customer' being an object
+     *                  '_only' => ['firstName'],
+     *                  '_exposeClassName' => \TYPO3\CMS\Extbase\Mvc\View\JsonView::EXPOSE_CLASSNAME_FULLY_QUALIFIED
+     *              ]
+     *          ]
+     *      ]
+     * ]
+     *
+     * The ``_exposeClassName`` is similar to the objectIdentifier one, but the class name is added to the
+     * JSON object output, for example (summarized):
+     * {"customer":{"firstName":"John","__class":"Acme\Foo\Domain\Model\Customer"}}
+     *
+     * The other option is EXPOSE_CLASSNAME_UNQUALIFIED which only will give the last part of the class
+     * without the namespace, for example (summarized):
+     * {"customer":{"firstName":"John","__class":"Customer"}}
+     * This might be of interest to not provide information about the package or domain structure behind.
+     *
+     * @var array
+     */
+    protected $configuration = [];
+
+    /**
+     * @var PersistenceManagerInterface
+     */
+    protected $persistenceManager;
+
+    /**
+     * @param PersistenceManagerInterface $persistenceManager
+     * @internal
+     */
+    public function injectPersistenceManager(PersistenceManagerInterface $persistenceManager): void
+    {
+        $this->persistenceManager = $persistenceManager;
+    }
+
+    /**
+     * @param ReflectionService $reflectionService
+     * @internal
+     */
+    public function injectReflectionService(ReflectionService $reflectionService): void
+    {
+        $this->reflectionService = $reflectionService;
+    }
+
+    /**
+     * Specifies which variables this JsonView should render
+     * By default only the variable 'value' will be rendered
+     *
+     * @param array $variablesToRender
+     */
+    public function setVariablesToRender(array $variablesToRender): void
+    {
+        $this->variablesToRender = $variablesToRender;
+    }
+
+    /**
+     * @param array $configuration The rendering configuration for this JSON view
+     */
+    public function setConfiguration(array $configuration): void
+    {
+        $this->configuration = $configuration;
+    }
+
+    /**
+     * Transforms the value view variable to a serializable
+     * array representation using a YAML view configuration and JSON encodes
+     * the result.
+     *
+     * @return string The JSON encoded variables
+     */
+    public function render(): string
+    {
+        $response = $this->controllerContext->getResponse();
+        if ($response instanceof WebResponse) {
+            // @todo Ticket: #63643 This should be solved differently once request/response model is available for TSFE.
+            if (!empty($GLOBALS['TSFE']) && $GLOBALS['TSFE'] instanceof TypoScriptFrontendController) {
+                /** @var TypoScriptFrontendController $typoScriptFrontendController */
+                $typoScriptFrontendController = $GLOBALS['TSFE'];
+                if (empty($typoScriptFrontendController->config['config']['disableCharsetHeader'])) {
+                    // If the charset header is *not* disabled in configuration,
+                    // TypoScriptFrontendController will send the header later with the Content-Type which we set here.
+                    $typoScriptFrontendController->setContentType('application/json');
+                } else {
+                    // Although the charset header is disabled in configuration, we *must* send a Content-Type header here.
+                    // Content-Type headers optionally carry charset information at the same time.
+                    // Since we have the information about the charset, there is no reason to not include the charset information although disabled in TypoScript.
+                    $response->setHeader('Content-Type', 'application/json; charset=' . trim($typoScriptFrontendController->metaCharset));
+                }
+            } else {
+                $response->setHeader('Content-Type', 'application/json');
+            }
+        }
+        $propertiesToRender = $this->renderArray();
+        return json_encode($propertiesToRender, JSON_UNESCAPED_UNICODE);
+    }
+
+    /**
+     * Loads the configuration and transforms the value to a serializable
+     * array.
+     *
+     * @return mixed
+     */
+    protected function renderArray()
+    {
+        if (count($this->variablesToRender) === 1) {
+            $variableName = current($this->variablesToRender);
+            $valueToRender = $this->variables[$variableName] ?? null;
+            $configuration = $this->configuration[$variableName] ?? [];
+        } else {
+            $valueToRender = [];
+            foreach ($this->variablesToRender as $variableName) {
+                $valueToRender[$variableName] = $this->variables[$variableName] ?? null;
+            }
+            $configuration = $this->configuration;
+        }
+        return $this->transformValue($valueToRender, $configuration);
+    }
+
+    /**
+     * Transforms a value depending on type recursively using the
+     * supplied configuration.
+     *
+     * @param mixed $value The value to transform
+     * @param array $configuration Configuration for transforming the value
+     * @return mixed The transformed value
+     */
+    protected function transformValue($value, array $configuration)
+    {
+        if (is_array($value) || $value instanceof \ArrayAccess) {
+            $array = [];
+            foreach ($value as $key => $element) {
+                if (isset($configuration['_descendAll']) && is_array($configuration['_descendAll'])) {
+                    $array[$key] = $this->transformValue($element, $configuration['_descendAll']);
+                } else {
+                    if (isset($configuration['_only']) && is_array($configuration['_only']) && !in_array($key, $configuration['_only'], true)) {
+                        continue;
+                    }
+                    if (isset($configuration['_exclude']) && is_array($configuration['_exclude']) && in_array($key, $configuration['_exclude'], true)) {
+                        continue;
+                    }
+                    $array[$key] = $this->transformValue($element, $configuration[$key] ?? []);
+                }
+            }
+            return $array;
+        }
+        if (is_object($value)) {
+            return $this->transformObject($value, $configuration);
+        }
+        return $value;
+    }
+
+    /**
+     * Traverses the given object structure in order to transform it into an
+     * array structure.
+     *
+     * @param object $object Object to traverse
+     * @param array $configuration Configuration for transforming the given object or NULL
+     * @return array|string Object structure as an array or as a rendered string (for a DateTime instance)
+     */
+    protected function transformObject(object $object, array $configuration)
+    {
+        if ($object instanceof \DateTime) {
+            return $object->format(\DateTime::ATOM);
+        }
+        $propertyNames = ObjectAccess::getGettablePropertyNames($object);
+
+        $propertiesToRender = [];
+        foreach ($propertyNames as $propertyName) {
+            if (isset($configuration['_only']) && is_array($configuration['_only']) && !in_array($propertyName, $configuration['_only'], true)) {
+                continue;
+            }
+            if (isset($configuration['_exclude']) && is_array($configuration['_exclude']) && in_array($propertyName, $configuration['_exclude'], true)) {
+                continue;
+            }
+
+            $propertyValue = ObjectAccess::getProperty($object, $propertyName);
+
+            if (!is_array($propertyValue) && !is_object($propertyValue)) {
+                $propertiesToRender[$propertyName] = $propertyValue;
+            } elseif (isset($configuration['_descend']) && array_key_exists($propertyName, $configuration['_descend'])) {
+                $propertiesToRender[$propertyName] = $this->transformValue($propertyValue, $configuration['_descend'][$propertyName]);
+            }
+        }
+        if (isset($configuration['_exposeObjectIdentifier']) && $configuration['_exposeObjectIdentifier'] === true) {
+            if (isset($configuration['_exposedObjectIdentifierKey']) && strlen($configuration['_exposedObjectIdentifierKey']) > 0) {
+                $identityKey = $configuration['_exposedObjectIdentifierKey'];
+            } else {
+                $identityKey = '__identity';
+            }
+            $propertiesToRender[$identityKey] = $this->persistenceManager->getIdentifierByObject($object);
+        }
+        if (isset($configuration['_exposeClassName']) && ($configuration['_exposeClassName'] === self::EXPOSE_CLASSNAME_FULLY_QUALIFIED || $configuration['_exposeClassName'] === self::EXPOSE_CLASSNAME_UNQUALIFIED)) {
+            $className = get_class($object);
+            $classNameParts = explode('\\', $className);
+            $propertiesToRender['__class'] = ($configuration['_exposeClassName'] === self::EXPOSE_CLASSNAME_FULLY_QUALIFIED ? $className : array_pop($classNameParts));
+        }
+
+        return $propertiesToRender;
+    }
+}

typo3/sysext/extbase/Classes/Mvc/View/NotFoundView.php

@@ -0,0 +1,74 @@
+<?php
+namespace TYPO3\CMS\Extbase\Mvc\View;
+
+/*
+ * 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!
+ */
+
+/**
+ * The not found view - a special case.
+ * @internal only to be used within Extbase, not part of TYPO3 Core API.
+ */
+class NotFoundView extends \TYPO3\CMS\Extbase\Mvc\View\AbstractView
+{
+    /**
+     * @var array
+     */
+    protected $variablesMarker = ['errorMessage' => 'ERROR_MESSAGE'];
+
+    /**
+     * Renders the not found view
+     *
+     * @return string The rendered view
+     * @throws \TYPO3\CMS\Extbase\Mvc\Exception if no request has been set
+     */
+    public function render()
+    {
+        if (!is_object($this->controllerContext->getRequest())) {
+            throw new \TYPO3\CMS\Extbase\Mvc\Exception('Can\'t render view without request object.', 1192450280);
+        }
+        $template = file_get_contents($this->getTemplatePathAndFilename());
+        if ($this->controllerContext->getRequest() instanceof \TYPO3\CMS\Extbase\Mvc\Web\Request) {
+            $template = str_replace('###BASEURI###', \TYPO3\CMS\Core\Utility\GeneralUtility::getIndpEnv('TYPO3_SITE_URL'), $template);
+        }
+        foreach ($this->variablesMarker as $variableName => $marker) {
+            $variableValue = $this->variables[$variableName] ?? '';
+            $template = str_replace('###' . $marker . '###', $variableValue, $template);
+        }
+        return $template;
+    }
+
+    /**
+     * Retrieves path and filename of the not-found-template
+     *
+     * @return string path and filename of the not-found-template
+     */
+    protected function getTemplatePathAndFilename()
+    {
+        return \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath('extbase') . 'Resources/Private/MVC/NotFoundView_Template.html';
+    }
+
+    /**
+     * A magic call method.
+     *
+     * Because this not found view is used as a Special Case in situations when no matching
+     * view is available, it must be able to handle method calls which originally were
+     * directed to another type of view. This magic method should prevent PHP from issuing
+     * a fatal error.
+     *
+     * @param string $methodName
+     * @param array $arguments
+     */
+    public function __call($methodName, array $arguments)
+    {
+    }
+}

typo3/sysext/extbase/Classes/Mvc/View/ViewInterface.php

@@ -0,0 +1,67 @@
+<?php
+namespace TYPO3\CMS\Extbase\Mvc\View;
+
+/*
+ * 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!
+ */
+
+/**
+ * Interface of a view
+ */
+interface ViewInterface
+{
+    /**
+     * Sets the current controller context
+     *
+     * @param \TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext
+     * @internal
+     */
+    public function setControllerContext(\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext);
+
+    /**
+     * Add a variable to the view data collection.
+     * Can be chained, so $this->view->assign(..., ...)->assign(..., ...); is possible
+     *
+     * @param string $key Key of variable
+     * @param mixed $value Value of object
+     * @return \TYPO3\CMS\Extbase\Mvc\View\ViewInterface an instance of $this, to enable chaining
+     */
+    public function assign($key, $value);
+
+    /**
+     * Add multiple variables to the view data collection
+     *
+     * @param array $values array in the format array(key1 => value1, key2 => value2)
+     * @return \TYPO3\CMS\Extbase\Mvc\View\ViewInterface an instance of $this, to enable chaining
+     */
+    public function assignMultiple(array $values);
+
+    /**
+     * Tells if the view implementation can render the view for the given context.
+     *
+     * @param \TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext
+     * @return bool TRUE if the view has something useful to display, otherwise FALSE
+     */
+    public function canRender(\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext);
+
+    /**
+     * Renders the view
+     *
+     * @return string The rendered view
+     */
+    public function render();
+
+    /**
+     * Initializes this view.
+     */
+    public function initializeView();
+}