[RELEASE] Version 9.2.0 with env vars, internal_type file_reference and config debug

Author: vertexvaar

CHANGELOG.md

@@ -1,5 +1,23 @@
 # In2publish Core Change Log
 
+9.2.0:
+
+- [META] Set the branch alias version number to 9.1.x-dev
+- [META] Set the EM conf version number to 9.2.0
+- [BUGFIX] Use provided editRecord VH and fix RecordHistory VH return URL
+- [FEATURE] Debug provider specific config in "show config" and sysinfo export
+- [FEATURE] Support the use of env vars in the yaml config
+- [BUGFIX] Allow empty database password (e.g. for local development)
+- [DOCS] Add a security notice about public yaml config files
+- [DOCS] Update the example configuration to encourage the use of env vars
+- [DOCS] Add the guide about configuration post processing
+- [FEATURE] Support the use of env vars in the yaml config
+- [DOCS] Update installation for new core version
+- [FEATURE] Support TCA type group internal_type file_reference
+- [FEATURE] Support internal type file_reference
+- [BIGFIX] Log "unauthorized" if no backend user is yet logged in
+- [RELEASE] Version 9.1.0 with translated record handling and support info
+
 9.1.0:
 
 - [META] Set the branch alias version number to 9.1.x-dev

Classes/Config/ConfigContainer.php

@@ -32,6 +32,7 @@
 use In2code\In2publishCore\Config\Definer\DefinerInterface;
 use In2code\In2publishCore\Config\Node\Node;
 use In2code\In2publishCore\Config\Node\NodeCollection;
+use In2code\In2publishCore\Config\PostProcessor\PostProcessorInterface;
 use In2code\In2publishCore\Config\Provider\ContextualProvider;
 use In2code\In2publishCore\Config\Provider\ProviderInterface;
 use In2code\In2publishCore\Service\Context\ContextService;
@@ -40,6 +41,8 @@
 use TYPO3\CMS\Core\SingletonInterface;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
+use function array_combine;
+use function array_fill;
 use function array_keys;
 use function asort;
 
@@ -58,6 +61,11 @@ class ConfigContainer implements SingletonInterface
      */
     protected $definers = [];
 
+    /**
+     * @var PostProcessorInterface[]
+     */
+    protected $postProcessors = [];
+
     /**
      * @var array|null
      */
@@ -169,6 +177,16 @@ protected function processConfig(array $priority): array
             $config = ConfigurationUtility::mergeConfiguration($config, $providerConfig);
         }
 
+        foreach ($this->postProcessors as $class => $object) {
+            if (null === $object) {
+                $object = GeneralUtility::makeInstance($class);
+                $this->postProcessors[$class] = $object;
+            }
+            if ($object instanceof PostProcessorInterface) {
+                $config = $object->process($config);
+            }
+        }
+
         if (GeneralUtility::makeInstance(ContextService::class)->isLocal()) {
             $config = $this->getLocalDefinition()->cast($config);
         } else {
@@ -244,4 +262,51 @@ public function registerDefiner($definer)
     {
         $this->definers[$definer] = null;
     }
+
+    /**
+     * All post processors must be registered in ext_localconf.php!
+     * PostProcessors must implement the PostProcessorInterface or they won't be called.
+     *
+     * @param string $postProcessor
+     */
+    public function registerPostProcessor(string $postProcessor): void
+    {
+        $this->postProcessors[$postProcessor] = null;
+    }
+
+    /**
+     * Returns the information about all registered classes which are responsible for the resulting configuration.
+     *
+     * @return array
+     */
+    public function dump(): array
+    {
+        // Clone this instance and reset it
+        $cloned = clone $this;
+        $cloned->config = null;
+        $cloned->providers = array_combine(array_keys($this->providers), array_fill(0, count($this->providers), null));
+        $cloned->definers = array_combine(array_keys($this->definers), array_fill(0, count($this->definers), null));
+        $cloned->postProcessors = array_combine(array_keys($this->postProcessors), array_fill(0, count($this->postProcessors), null));
+        $fullConfig = $cloned->get();
+
+        $priority = [];
+        foreach ($cloned->providers as $class => $config) {
+            $provider = GeneralUtility::makeInstance($class);
+            $priority[$class] = $provider->getPriority();
+        }
+
+        asort($priority);
+
+        $orderedProviderConfig = [];
+        foreach (array_keys($priority) as $class) {
+            $orderedProviderConfig[$class] = $cloned->providers[$class];
+        }
+
+        return [
+            'fullConfig' => $fullConfig,
+            'providers' => $orderedProviderConfig,
+            'definers' => array_keys($cloned->definers),
+            'postProcessors' => array_keys($cloned->postProcessors),
+        ];
+    }
 }

Classes/Config/Definer/In2publishCoreDefiner.php

@@ -164,7 +164,7 @@ public function getLocalDefinition()
                                      Builder::start()
                                             ->addString('name', 'database_123')
                                             ->addString('username', 'username_123')
-                                            ->addString('password', 'Password_123')
+                                            ->addOptionalString('password', 'Password_123')
                                             ->addString('hostname', '127.0.0.1')
                                             ->addInteger('port', 3306, [IPv4PortValidator::class])
                                  )

Classes/Config/PostProcessor/DynamicValueProvider/DynamicValueProviderInterface.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace In2code\In2publishCore\Config\PostProcessor\DynamicValueProvider;
+
+/*
+ * Copyright notice
+ *
+ * (c) 2020 in2code.de and the following authors:
+ * Oliver Eglseder <[email protected]>
+ *
+ * All rights reserved
+ *
+ * This script is part of the TYPO3 project. The TYPO3 project is
+ * free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * The GNU General Public License can be found at
+ * http://www.gnu.org/copyleft/gpl.html.
+ *
+ * This script is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * This copyright notice MUST APPEAR in all copies of the script!
+ */
+
+interface DynamicValueProviderInterface
+{
+    /**
+     * @param string $string The configuration string from between the round brackets
+     * @return mixed The scalar value which replaces the dynamic configuration reference.
+     */
+    public function getValueFor(string $string);
+}

Classes/Config/PostProcessor/DynamicValueProvider/DynamicValueProviderRegistry.php

@@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types=1);
+
+namespace In2code\In2publishCore\Config\PostProcessor\DynamicValueProvider;
+
+/*
+ * Copyright notice
+ *
+ * (c) 2020 in2code.de and the following authors:
+ * Oliver Eglseder <[email protected]>
+ *
+ * All rights reserved
+ *
+ * This script is part of the TYPO3 project. The TYPO3 project is
+ * free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * The GNU General Public License can be found at
+ * http://www.gnu.org/copyleft/gpl.html.
+ *
+ * This script is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * This copyright notice MUST APPEAR in all copies of the script!
+ */
+
+use In2code\In2publishCore\Config\PostProcessor\DynamicValueProvider\Exception\InvalidDynamicValueProviderKeyException;
+use TYPO3\CMS\Core\SingletonInterface;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+
+class DynamicValueProviderRegistry implements SingletonInterface
+{
+    /**
+     * @var string[]
+     */
+    protected $classes = [];
+
+    /**
+     * @var DynamicValueProviderInterface[]
+     */
+    protected $objects = [];
+
+    /**
+     * @param string $key The key which will be used in the configuration to call the registered provider
+     * @param string $class The FQCN of the provider. Must implement `DynamicValueProviderInterface`.
+     */
+    public function registerDynamicValue(string $key, string $class): void
+    {
+        $this->classes[$key] = $class;
+    }
+
+    public function getRegisteredClasses(): array
+    {
+        return $this->classes;
+    }
+
+    public function hasDynamicValueProviderForKey(string $key): bool
+    {
+        return isset($this->classes[$key]);
+    }
+
+    public function getDynamicValueProviderByKey(string $key): DynamicValueProviderInterface
+    {
+        if (!$this->hasDynamicValueProviderForKey($key)) {
+            throw InvalidDynamicValueProviderKeyException::forProviderKey($key);
+        }
+        if (!isset($this->objects[$key])) {
+            $this->objects[$key] = GeneralUtility::makeInstance($this->classes[$key]);
+        }
+        return $this->objects[$key];
+    }
+}

Classes/ViewHelpers/Link/EditRecordViewHelper.php renamed to Classes/Config/PostProcessor/DynamicValueProvider/EnvVarProvider.php

@@ -2,12 +2,12 @@
 
 declare(strict_types=1);
 
-namespace In2code\In2publishCore\ViewHelpers\Link;
+namespace In2code\In2publishCore\Config\PostProcessor\DynamicValueProvider;
 
 /*
  * Copyright notice
  *
- * (c) 2017 in2code.de and the following authors:
+ * (c) 2020 in2code.de and the following authors:
  * Oliver Eglseder <[email protected]>
  *
  * All rights reserved
@@ -29,25 +29,15 @@
  * This copyright notice MUST APPEAR in all copies of the script!
  */
 
-use In2code\In2publishCore\Utility\BackendUtility;
-use TYPO3\CMS\Backend\Routing\Exception\RouteNotFoundException;
+use function getenv;
 
 /**
- * Class EditRecordViewHelper
+ * Replaces configurations values like %env(MYSQL_PASSWORD)% with the env var value of MYSQL_PASSWORD.
  */
-class EditRecordViewHelper extends AbstractRecordActionLinkViewHelper
+class EnvVarProvider implements DynamicValueProviderInterface
 {
-    /**
-     * @param string $table
-     * @param int $identifier
-     *
-     * @return string
-     *
-     * @SuppressWarnings(PHPMD.StaticAccess)
-     * @throws RouteNotFoundException
-     */
-    protected function buildUri(string $table, int $identifier): string
+    public function getValueFor(string $string)
     {
-        return BackendUtility::buildEditUri($table, $identifier);
+        return getenv($string);
     }
 }

Classes/Config/PostProcessor/DynamicValueProvider/Exception/InvalidDynamicValueProviderKeyException.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace In2code\In2publishCore\Config\PostProcessor\DynamicValueProvider\Exception;
+
+/*
+ * Copyright notice
+ *
+ * (c) 2020 in2code.de and the following authors:
+ * Oliver Eglseder <[email protected]>
+ *
+ * All rights reserved
+ *
+ * This script is part of the TYPO3 project. The TYPO3 project is
+ * free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * The GNU General Public License can be found at
+ * http://www.gnu.org/copyleft/gpl.html.
+ *
+ * This script is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * This copyright notice MUST APPEAR in all copies of the script!
+ */
+
+use In2code\In2publishCore\In2publishCoreException;
+
+class InvalidDynamicValueProviderKeyException extends In2publishCoreException
+{
+    const MESSAGE = 'A dynamic value provider for key "%s" was not registered';
+    const CODE = 1595409903;
+
+    public static function forProviderKey(string $providerKey): InvalidDynamicValueProviderKeyException
+    {
+        return new self(sprintf(self::MESSAGE, $providerKey), self::CODE);
+    }
+}