src/Core/System/SystemConfig/SystemConfigService.php line 327

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\System\SystemConfig;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Framework\Bundle;
  7. use Shopware\Core\Framework\Context;
  8. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Field\ConfigJsonField;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsAnyFilter;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  13. use Shopware\Core\Framework\Log\Package;
  14. use Shopware\Core\Framework\Util\XmlReader;
  15. use Shopware\Core\Framework\Uuid\Exception\InvalidUuidException;
  16. use Shopware\Core\Framework\Uuid\Uuid;
  17. use Shopware\Core\System\SystemConfig\Event\BeforeSystemConfigChangedEvent;
  18. use Shopware\Core\System\SystemConfig\Event\SystemConfigChangedEvent;
  19. use Shopware\Core\System\SystemConfig\Event\SystemConfigDomainLoadedEvent;
  20. use Shopware\Core\System\SystemConfig\Exception\BundleConfigNotFoundException;
  21. use Shopware\Core\System\SystemConfig\Exception\InvalidDomainException;
  22. use Shopware\Core\System\SystemConfig\Exception\InvalidKeyException;
  23. use Shopware\Core\System\SystemConfig\Exception\InvalidSettingValueException;
  24. use Shopware\Core\System\SystemConfig\Util\ConfigReader;
  25. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  26. use function json_decode;
  28. #[Package('system-settings')]
  29. class SystemConfigService
  30. {
  31.     /**
  32.      * @var array<string, bool>
  33.      */
  34.     private array $keys = ['all' => true];
  36.     /**
  37.      * @var array<mixed>
  38.      */
  39.     private array $traces = [];
  41.     /**
  42.      * @internal
  43.      */
  44.     public function __construct(private readonly Connection $connection, private readonly EntityRepository $systemConfigRepository, private readonly ConfigReader $configReader, private readonly AbstractSystemConfigLoader $loader, private readonly EventDispatcherInterface $eventDispatcher)
  45.     {
  46.     }
  48.     public static function buildName(string $key): string
  49.     {
  50.         return 'config.' . $key;
  51.     }
  53.     /**
  54.      * @return array<mixed>|bool|float|int|string|null
  55.      */
  56.     public function get(string $key, ?string $salesChannelId = null)
  57.     {
  58.         foreach (array_keys($this->keys) as $trace) {
  59.             $this->traces[$trace][self::buildName($key)] = true;
  60.         }
  62.         $config = $this->loader->load($salesChannelId);
  64.         $parts = explode('.', $key);
  66.         $pointer = $config;
  68.         foreach ($parts as $part) {
  69.             if (!\is_array($pointer)) {
  70.                 return null;
  71.             }
  73.             if (\array_key_exists($part, $pointer)) {
  74.                 $pointer = $pointer[$part];
  76.                 continue;
  77.             }
  79.             return null;
  80.         }
  82.         return $pointer;
  83.     }
  85.     public function getString(string $key, ?string $salesChannelId = null): string
  86.     {
  87.         $value = $this->get($key, $salesChannelId);
  88.         if (!\is_array($value)) {
  89.             return (string) $value;
  90.         }
  92.         throw new InvalidSettingValueException($key, 'string', \gettype($value));
  93.     }
  95.     public function getInt(string $key, ?string $salesChannelId = null): int
  96.     {
  97.         $value = $this->get($key, $salesChannelId);
  98.         if (!\is_array($value)) {
  99.             return (int) $value;
  100.         }
  102.         throw new InvalidSettingValueException($key, 'int', \gettype($value));
  103.     }
  105.     public function getFloat(string $key, ?string $salesChannelId = null): float
  106.     {
  107.         $value = $this->get($key, $salesChannelId);
  108.         if (!\is_array($value)) {
  109.             return (float) $value;
  110.         }
  112.         throw new InvalidSettingValueException($key, 'float', \gettype($value));
  113.     }
  115.     public function getBool(string $key, ?string $salesChannelId = null): bool
  116.     {
  117.         return (bool) $this->get($key, $salesChannelId);
  118.     }
  120.     /**
  121.      * @internal should not be used in storefront or store api. The cache layer caches all accessed config keys and use them as cache tag.
  122.      *
  123.      * gets all available shop configs and returns them as an array
  124.      *
  125.      * @return array<mixed>
  126.      */
  127.     public function all(?string $salesChannelId = null): array
  128.     {
  129.         return $this->loader->load($salesChannelId);
  130.     }
  132.     /**
  133.      * @internal should not be used in storefront or store api. The cache layer caches all accessed config keys and use them as cache tag.
  134.      *
  135.      * @throws InvalidDomainException
  136.      *
  137.      * @return array<mixed>
  138.      */
  139.     public function getDomain(string $domain, ?string $salesChannelId = null, bool $inherit = false): array
  140.     {
  141.         $domain = trim($domain);
  142.         if ($domain === '') {
  143.             throw new InvalidDomainException('Empty domain');
  144.         }
  146.         $queryBuilder = $this->connection->createQueryBuilder()
  147.             ->select(['configuration_key', 'configuration_value'])
  148.             ->from('system_config');
  150.         if ($inherit) {
  151.             $queryBuilder->where('sales_channel_id IS NULL OR sales_channel_id = :salesChannelId');
  152.         } elseif ($salesChannelId === null) {
  153.             $queryBuilder->where('sales_channel_id IS NULL');
  154.         } else {
  155.             $queryBuilder->where('sales_channel_id = :salesChannelId');
  156.         }
  158.         $domain = rtrim($domain, '.') . '.';
  159.         $escapedDomain = str_replace('%', '\\%', $domain);
  161.         $salesChannelId = $salesChannelId ? Uuid::fromHexToBytes($salesChannelId) : null;
  163.         $queryBuilder->andWhere('configuration_key LIKE :prefix')
  164.             ->addOrderBy('sales_channel_id', 'ASC')
  165.             ->setParameter('prefix', $escapedDomain . '%')
  166.             ->setParameter('salesChannelId', $salesChannelId);
  168.         $configs = $queryBuilder->executeQuery()->fetchAllNumeric();
  170.         if ($configs === []) {
  171.             return [];
  172.         }
  174.         $merged = [];
  176.         foreach ($configs as [$key, $value]) {
  177.             if ($value !== null) {
  178.                 $value = json_decode((string) $value, true, 512, \JSON_THROW_ON_ERROR);
  180.                 if ($value === false || !isset($value[ConfigJsonField::STORAGE_KEY])) {
  181.                     $value = null;
  182.                 } else {
  183.                     $value = $value[ConfigJsonField::STORAGE_KEY];
  184.                 }
  185.             }
  187.             $inheritedValuePresent = \array_key_exists($key, $merged);
  188.             $valueConsideredEmpty = !\is_bool($value) && empty($value);
  190.             if ($inheritedValuePresent && $valueConsideredEmpty) {
  191.                 continue;
  192.             }
  194.             $merged[$key] = $value;
  195.         }
  197.         $event = new SystemConfigDomainLoadedEvent($domain, $merged, $inherit, $salesChannelId);
  198.         $this->eventDispatcher->dispatch($event);
  200.         return $event->getConfig();
  201.     }
  203.     /**
  204.      * @param array<mixed>|bool|float|int|string|null $value
  205.      */
  206.     public function set(string $key, $value, ?string $salesChannelId = null): void
  207.     {
  208.         $key = trim($key);
  209.         $this->validate($key, $salesChannelId);
  211.         $event = new BeforeSystemConfigChangedEvent($key, $value, $salesChannelId);
  212.         $this->eventDispatcher->dispatch($event);
  214.         $id = $this->getId($key, $salesChannelId);
  215.         if ($value === null) {
  216.             if ($id) {
  217.                 $this->systemConfigRepository->delete([['id' => $id]], Context::createDefaultContext());
  218.             }
  220.             $this->eventDispatcher->dispatch(new SystemConfigChangedEvent($key, $value, $salesChannelId));
  222.             return;
  223.         }
  225.         $data = [
  226.             'id' => $id ?? Uuid::randomHex(),
  227.             'configurationKey' => $key,
  228.             'configurationValue' => $event->getValue(),
  229.             'salesChannelId' => $salesChannelId,
  230.         ];
  231.         $this->systemConfigRepository->upsert([$data], Context::createDefaultContext());
  232.         $this->eventDispatcher->dispatch(new SystemConfigChangedEvent($key, $event->getValue(), $salesChannelId));
  233.     }
  235.     public function delete(string $key, ?string $salesChannel = null): void
  236.     {
  237.         $this->set($key, null, $salesChannel);
  238.     }
  240.     /**
  241.      * Fetches default values from bundle configuration and saves it to database
  242.      */
  243.     public function savePluginConfiguration(Bundle $bundle, bool $override = false): void
  244.     {
  245.         try {
  246.             $config = $this->configReader->getConfigFromBundle($bundle);
  247.         } catch (BundleConfigNotFoundException) {
  248.             return;
  249.         }
  251.         $prefix = $bundle->getName() . '.config.';
  253.         $this->saveConfig($config, $prefix, $override);
  254.     }
  256.     /**
  257.      * @param array<mixed> $config
  258.      */
  259.     public function saveConfig(array $config, string $prefix, bool $override): void
  260.     {
  261.         $relevantSettings = $this->getDomain($prefix);
  263.         foreach ($config as $card) {
  264.             foreach ($card['elements'] as $element) {
  265.                 $key = $prefix . $element['name'];
  266.                 if (!isset($element['defaultValue'])) {
  267.                     continue;
  268.                 }
  270.                 $value = XmlReader::phpize($element['defaultValue']);
  271.                 if ($override || !isset($relevantSettings[$key]) || $relevantSettings[$key] === null) {
  272.                     $this->set($key, $value);
  273.                 }
  274.             }
  275.         }
  276.     }
  278.     public function deletePluginConfiguration(Bundle $bundle): void
  279.     {
  280.         try {
  281.             $config = $this->configReader->getConfigFromBundle($bundle);
  282.         } catch (BundleConfigNotFoundException) {
  283.             return;
  284.         }
  286.         $this->deleteExtensionConfiguration($bundle->getName(), $config);
  287.     }
  289.     /**
  290.      * @param array<mixed> $config
  291.      */
  292.     public function deleteExtensionConfiguration(string $extensionName, array $config): void
  293.     {
  294.         $prefix = $extensionName . '.config.';
  296.         $configKeys = [];
  297.         foreach ($config as $card) {
  298.             foreach ($card['elements'] as $element) {
  299.                 $configKeys[] = $prefix . $element['name'];
  300.             }
  301.         }
  303.         if (empty($configKeys)) {
  304.             return;
  305.         }
  307.         $criteria = new Criteria();
  308.         $criteria->addFilter(new EqualsAnyFilter('configurationKey', $configKeys));
  309.         $systemConfigIds = $this->systemConfigRepository->searchIds($criteria, Context::createDefaultContext())->getIds();
  310.         if (empty($systemConfigIds)) {
  311.             return;
  312.         }
  314.         $ids = array_map(static fn ($id) => ['id' => $id], $systemConfigIds);
  316.         $this->systemConfigRepository->delete($ids, Context::createDefaultContext());
  317.     }
  319.     /**
  320.      * @return mixed|null All kind of data could be cached
  321.      */
  322.     public function trace(string $key, \Closure $param)
  323.     {
  324.         $this->traces[$key] = [];
  325.         $this->keys[$key] = true;
  327.         $result = $param();
  329.         unset($this->keys[$key]);
  331.         return $result;
  332.     }
  334.     /**
  335.      * @return array<mixed>
  336.      */
  337.     public function getTrace(string $key): array
  338.     {
  339.         $trace = isset($this->traces[$key]) ? array_keys($this->traces[$key]) : [];
  340.         unset($this->traces[$key]);
  342.         return $trace;
  343.     }
  345.     /**
  346.      * @throws InvalidKeyException
  347.      * @throws InvalidUuidException
  348.      */
  349.     private function validate(string $key, ?string $salesChannelId): void
  350.     {
  351.         $key = trim($key);
  352.         if ($key === '') {
  353.             throw new InvalidKeyException('key may not be empty');
  354.         }
  355.         if ($salesChannelId && !Uuid::isValid($salesChannelId)) {
  356.             throw new InvalidUuidException($salesChannelId);
  357.         }
  358.     }
  360.     private function getId(string $key, ?string $salesChannelId = null): ?string
  361.     {
  362.         $criteria = new Criteria();
  363.         $criteria->addFilter(
  364.             new EqualsFilter('configurationKey', $key),
  365.             new EqualsFilter('salesChannelId', $salesChannelId)
  366.         );
  368.         /** @var array<string> $ids */
  369.         $ids = $this->systemConfigRepository->searchIds($criteria, Context::createDefaultContext())->getIds();
  371.         /** @var string|null $id */
  372.         $id = array_shift($ids);
  374.         return $id;
  375.     }
  376. }