src/Storefront/Theme/ThemeService.php line 179

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Theme;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Framework\Context;
  7. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Exception\InconsistentCriteriaIdsException;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearchResult;
  11. use Shopware\Core\Framework\Log\Package;
  12. use Shopware\Core\Framework\Uuid\Uuid;
  13. use Shopware\Storefront\Theme\ConfigLoader\AbstractConfigLoader;
  14. use Shopware\Storefront\Theme\Event\ThemeAssignedEvent;
  15. use Shopware\Storefront\Theme\Event\ThemeConfigChangedEvent;
  16. use Shopware\Storefront\Theme\Event\ThemeConfigResetEvent;
  17. use Shopware\Storefront\Theme\Exception\InvalidThemeConfigException;
  18. use Shopware\Storefront\Theme\Exception\InvalidThemeException;
  19. use Shopware\Storefront\Theme\StorefrontPluginConfiguration\StorefrontPluginConfigurationCollection;
  20. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  22. #[Package('storefront')]
  23. class ThemeService
  24. {
  25.     /**
  26.      * @internal
  27.      */
  28.     public function __construct(private readonly StorefrontPluginRegistryInterface $extensionRegistry, private readonly EntityRepository $themeRepository, private readonly EntityRepository $themeSalesChannelRepository, private readonly ThemeCompilerInterface $themeCompiler, private readonly EventDispatcherInterface $dispatcher, private readonly AbstractConfigLoader $configLoader, private readonly Connection $connection)
  29.     {
  30.     }
  32.     /**
  33.      * Only compiles a single theme/saleschannel combination.
  34.      * Use `compileThemeById` to compile all dependend saleschannels
  35.      */
  36.     public function compileTheme(
  37.         string $salesChannelId,
  38.         string $themeId,
  39.         Context $context,
  40.         ?StorefrontPluginConfigurationCollection $configurationCollection = null,
  41.         bool $withAssets = true
  42.     ): void {
  43.         $this->themeCompiler->compileTheme(
  44.             $salesChannelId,
  45.             $themeId,
  46.             $this->configLoader->load($themeId, $context),
  47.             $configurationCollection ?? $this->extensionRegistry->getConfigurations(),
  48.             $withAssets,
  49.             $context
  50.         );
  51.     }
  53.     /**
  54.      * Compiles all dependend saleschannel/Theme combinations
  55.      *
  56.      * @return array<int, string>
  57.      */
  58.     public function compileThemeById(
  59.         string $themeId,
  60.         Context $context,
  61.         ?StorefrontPluginConfigurationCollection $configurationCollection = null,
  62.         bool $withAssets = true
  63.     ): array {
  64.         $mappings = $this->getThemeDependencyMapping($themeId);
  66.         $compiledThemeIds = [];
  67.         /** @var ThemeSalesChannel $mapping */
  68.         foreach ($mappings as $mapping) {
  69.             $this->themeCompiler->compileTheme(
  70.                 $mapping->getSalesChannelId(),
  71.                 $mapping->getThemeId(),
  72.                 $this->configLoader->load($mapping->getThemeId(), $context),
  73.                 $configurationCollection ?? $this->extensionRegistry->getConfigurations(),
  74.                 $withAssets,
  75.                 $context
  76.             );
  78.             $compiledThemeIds[] = $mapping->getThemeId();
  79.         }
  81.         return $compiledThemeIds;
  82.     }
  84.     /**
  85.      * @param array<string, mixed>|null $config
  86.      */
  87.     public function updateTheme(string $themeId, ?array $config, ?string $parentThemeId, Context $context): void
  88.     {
  89.         $criteria = new Criteria([$themeId]);
  90.         $criteria->addAssociation('salesChannels');
  91.         /** @var ThemeEntity|null $theme */
  92.         $theme = $this->themeRepository->search($criteria, $context)->get($themeId);
  94.         if (!$theme) {
  95.             throw new InvalidThemeException($themeId);
  96.         }
  98.         $data = ['id' => $themeId];
  99.         if ($config) {
  100.             foreach ($config as $key => $value) {
  101.                 $data['configValues'][$key] = $value;
  102.             }
  103.         }
  105.         if ($parentThemeId) {
  106.             $data['parentThemeId'] = $parentThemeId;
  107.         }
  109.         if (\array_key_exists('configValues', $data)) {
  110.             $this->dispatcher->dispatch(new ThemeConfigChangedEvent($themeId, $data['configValues']));
  111.         }
  113.         if (\array_key_exists('configValues', $data) && $theme->getConfigValues()) {
  114.             $submittedChanges = $data['configValues'];
  115.             $currentConfig = $theme->getConfigValues();
  116.             $data['configValues'] = array_replace_recursive($currentConfig, $data['configValues']);
  118.             foreach ($submittedChanges as $key => $changes) {
  119.                 if (isset($changes['value']) && \is_array($changes['value']) && isset($currentConfig[(string) $key]) && \is_array($currentConfig[(string) $key])) {
  120.                     $data['configValues'][$key]['value'] = array_unique($changes['value']);
  121.                 }
  122.             }
  123.         }
  125.         $this->themeRepository->update([$data], $context);
  127.         if ($theme->getSalesChannels() === null) {
  128.             return;
  129.         }
  131.         $this->compileThemeById($themeId, $context, null, false);
  132.     }
  134.     public function assignTheme(string $themeId, string $salesChannelId, Context $context, bool $skipCompile = false): bool
  135.     {
  136.         if (!$skipCompile) {
  137.             $this->compileTheme($salesChannelId, $themeId, $context);
  138.         }
  140.         $this->themeSalesChannelRepository->upsert([[
  141.             'themeId' => $themeId,
  142.             'salesChannelId' => $salesChannelId,
  143.         ]], $context);
  145.         $this->dispatcher->dispatch(new ThemeAssignedEvent($themeId, $salesChannelId));
  147.         return true;
  148.     }
  150.     public function resetTheme(string $themeId, Context $context): void
  151.     {
  152.         $criteria = new Criteria([$themeId]);
  153.         $theme = $this->themeRepository->search($criteria, $context)->get($themeId);
  155.         if (!$theme) {
  156.             throw new InvalidThemeException($themeId);
  157.         }
  159.         $data = ['id' => $themeId];
  160.         $data['configValues'] = null;
  162.         $this->dispatcher->dispatch(new ThemeConfigResetEvent($themeId));
  164.         $this->themeRepository->update([$data], $context);
  165.     }
  167.     /**
  168.      * @throws InvalidThemeConfigException
  169.      * @throws InvalidThemeException
  170.      * @throws InconsistentCriteriaIdsException
  171.      *
  172.      * @return array<string, mixed>
  173.      */
  174.     public function getThemeConfiguration(string $themeId, bool $translate, Context $context): array
  175.     {
  176.         $criteria = new Criteria();
  177.         $criteria->setTitle('theme-service::load-config');
  179.         $themes = $this->themeRepository->search($criteria, $context);
  181.         $theme = $themes->get($themeId);
  183.         /** @var ThemeEntity|null $theme */
  184.         if (!$theme) {
  185.             throw new InvalidThemeException($themeId);
  186.         }
  188.         /** @var ThemeEntity $baseTheme */
  189.         $baseTheme = $themes->filter(fn (ThemeEntity $themeEntry) => $themeEntry->getTechnicalName() === StorefrontPluginRegistry::BASE_THEME_NAME)->first();
  191.         $baseThemeConfig = $this->mergeStaticConfig($baseTheme);
  193.         $themeConfigFieldFactory = new ThemeConfigFieldFactory();
  194.         $configFields = [];
  195.         $labels = array_replace_recursive($baseTheme->getLabels() ?? [], $theme->getLabels() ?? []);
  197.         if ($theme->getParentThemeId()) {
  198.             $parentThemes = $this->getParentThemeIds($themes, $theme);
  200.             foreach ($parentThemes as $parentTheme) {
  201.                 $configuredParentTheme = $this->mergeStaticConfig($parentTheme);
  202.                 $baseThemeConfig = array_replace_recursive($baseThemeConfig, $configuredParentTheme);
  203.                 $labels = array_replace_recursive($labels, $parentTheme->getLabels() ?? []);
  204.             }
  205.         }
  207.         $configuredTheme = $this->mergeStaticConfig($theme);
  208.         $themeConfig = array_replace_recursive($baseThemeConfig, $configuredTheme);
  210.         foreach ($themeConfig['fields'] ?? [] as $name => &$item) {
  211.             $configFields[$name] = $themeConfigFieldFactory->create($name, $item);
  212.             if (
  213.                 isset($item['value'])
  214.                 && isset($configuredTheme['fields'])
  215.                 && \is_array($item['value'])
  216.                 && \array_key_exists($name, $configuredTheme['fields'])
  217.             ) {
  218.                 $configFields[$name]->setValue($configuredTheme['fields'][$name]['value']);
  219.             }
  220.         }
  222.         $configFields = json_decode((string) json_encode($configFields, \JSON_THROW_ON_ERROR), true, 512, \JSON_THROW_ON_ERROR);
  224.         if ($translate && !empty($labels)) {
  225.             $configFields = $this->translateLabels($configFields, $labels);
  226.         }
  228.         $helpTexts = array_replace_recursive($baseTheme->getHelpTexts() ?? [], $theme->getHelpTexts() ?? []);
  229.         if ($translate && !empty($helpTexts)) {
  230.             $configFields = $this->translateHelpTexts($configFields, $helpTexts);
  231.         }
  233.         $themeConfig['fields'] = $configFields;
  234.         $themeConfig['currentFields'] = [];
  235.         $themeConfig['baseThemeFields'] = [];
  237.         foreach ($themeConfig['fields'] as $field => $fieldItem) {
  238.             $isInherited = $this->fieldIsInherited($field, $configuredTheme);
  239.             $themeConfig['currentFields'][$field]['isInherited'] = $isInherited;
  241.             if ($isInherited) {
  242.                 $themeConfig['currentFields'][$field]['value'] = null;
  243.             } elseif (\array_key_exists('value', $fieldItem)) {
  244.                 $themeConfig['currentFields'][$field]['value'] = $fieldItem['value'];
  245.             }
  247.             $isInherited = $this->fieldIsInherited($field, $baseThemeConfig);
  248.             $themeConfig['baseThemeFields'][$field]['isInherited'] = $isInherited;
  250.             if ($isInherited) {
  251.                 $themeConfig['baseThemeFields'][$field]['value'] = null;
  252.             } elseif (\array_key_exists('value', $fieldItem) && isset($baseThemeConfig['fields'][$field]['value'])) {
  253.                 $themeConfig['baseThemeFields'][$field]['value'] = $baseThemeConfig['fields'][$field]['value'];
  254.             }
  255.         }
  257.         return $themeConfig;
  258.     }
  260.     /**
  261.      * @return array<string, mixed>
  262.      */
  263.     public function getThemeConfigurationStructuredFields(string $themeId, bool $translate, Context $context): array
  264.     {
  265.         $mergedConfig = $this->getThemeConfiguration($themeId, $translate, $context)['fields'];
  267.         $translations = [];
  268.         if ($translate) {
  269.             $translations = $this->getTranslations($themeId, $context);
  270.             $mergedConfig = $this->translateLabels($mergedConfig, $translations);
  271.         }
  273.         $outputStructure = [];
  275.         foreach ($mergedConfig as $fieldName => $fieldConfig) {
  276.             $tab = $this->getTab($fieldConfig);
  277.             $tabLabel = $this->getTabLabel($tab, $translations);
  278.             $block = $this->getBlock($fieldConfig);
  279.             $blockLabel = $this->getBlockLabel($block, $translations);
  280.             $section = $this->getSection($fieldConfig);
  281.             $sectionLabel = $this->getSectionLabel($section, $translations);
  283.             // set default tab
  284.             $outputStructure['tabs']['default']['label'] = '';
  286.             // set labels
  287.             $outputStructure['tabs'][$tab]['label'] = $tabLabel;
  288.             $outputStructure['tabs'][$tab]['blocks'][$block]['label'] = $blockLabel;
  289.             $outputStructure['tabs'][$tab]['blocks'][$block]['sections'][$section]['label'] = $sectionLabel;
  291.             // add fields to sections
  292.             $outputStructure['tabs'][$tab]['blocks'][$block]['sections'][$section]['fields'][$fieldName] = [
  293.                 'label' => $fieldConfig['label'],
  294.                 'helpText' => $fieldConfig['helpText'] ?? null,
  295.                 'type' => $fieldConfig['type'],
  296.                 'custom' => $fieldConfig['custom'],
  297.                 'fullWidth' => $fieldConfig['fullWidth'],
  298.             ];
  299.         }
  301.         return $outputStructure;
  302.     }
  304.     public function getThemeDependencyMapping(string $themeId): ThemeSalesChannelCollection
  305.     {
  306.         $mappings = new ThemeSalesChannelCollection();
  307.         $themeData = $this->connection->fetchAllAssociative(
  308.             'SELECT LOWER(HEX(theme.id)) as id, LOWER(HEX(childTheme.id)) as dependentId,
  309.             LOWER(HEX(tsc.sales_channel_id)) as saleschannelId,
  310.             LOWER(HEX(dtsc.sales_channel_id)) as dsaleschannelId
  311.             FROM theme
  312.             LEFT JOIN theme as childTheme ON childTheme.parent_theme_id = theme.id
  313.             LEFT JOIN theme_sales_channel as tsc ON theme.id = tsc.theme_id
  314.             LEFT JOIN theme_sales_channel as dtsc ON childTheme.id = dtsc.theme_id
  315.             WHERE theme.id = :id',
  316.             ['id' => Uuid::fromHexToBytes($themeId)]
  317.         );
  319.         foreach ($themeData as $data) {
  320.             if (isset($data['id']) && isset($data['saleschannelId']) && $data['id'] === $themeId) {
  321.                 $mappings->add(new ThemeSalesChannel($data['id'], $data['saleschannelId']));
  322.             }
  323.             if (isset($data['dependentId']) && isset($data['dsaleschannelId'])) {
  324.                 $mappings->add(new ThemeSalesChannel($data['dependentId'], $data['dsaleschannelId']));
  325.             }
  326.         }
  328.         return $mappings;
  329.     }
  331.     /**
  332.      * @param array<string, mixed> $parentThemes
  333.      *
  334.      * @return array<string, mixed>
  335.      */
  336.     private function getParentThemeIds(EntitySearchResult $themes, ThemeEntity $mainTheme, array $parentThemes = []): array
  337.     {
  338.         foreach ($this->getConfigInheritance($mainTheme) as $parentThemeName) {
  339.             $parentTheme = $themes->filter(fn (ThemeEntity $themeEntry) => $themeEntry->getTechnicalName() === str_replace('@', '', (string) $parentThemeName))->first();
  341.             if ($parentTheme instanceof ThemeEntity && !\array_key_exists($parentTheme->getId(), $parentThemes)) {
  342.                 $parentThemes[$parentTheme->getId()] = $parentTheme;
  344.                 if ($parentTheme->getParentThemeId()) {
  345.                     $parentThemes = $this->getParentThemeIds($themes, $mainTheme, $parentThemes);
  346.                 }
  347.             }
  348.         }
  350.         if ($mainTheme->getParentThemeId()) {
  351.             $parentTheme = $themes->filter(fn (ThemeEntity $themeEntry) => $themeEntry->getId() === $mainTheme->getParentThemeId())->first();
  353.             if ($parentTheme instanceof ThemeEntity && !\array_key_exists($parentTheme->getId(), $parentThemes)) {
  354.                 $parentThemes[$parentTheme->getId()] = $parentTheme;
  355.                 if ($parentTheme->getParentThemeId()) {
  356.                     $parentThemes = $this->getParentThemeIds($themes, $mainTheme, $parentThemes);
  357.                 }
  358.             }
  359.         }
  361.         return $parentThemes;
  362.     }
  364.     /**
  365.      * @return array<string, mixed>
  366.      */
  367.     private function getConfigInheritance(ThemeEntity $mainTheme): array
  368.     {
  369.         if (\is_array($mainTheme->getBaseConfig())
  370.             && \array_key_exists('configInheritance', $mainTheme->getBaseConfig())
  371.             && \is_array($mainTheme->getBaseConfig()['configInheritance'])
  372.             && !empty($mainTheme->getBaseConfig()['configInheritance'])
  373.         ) {
  374.             return $mainTheme->getBaseConfig()['configInheritance'];
  375.         }
  377.         return [];
  378.     }
  380.     /**
  381.      * @return array<string, mixed>
  382.      */
  383.     private function mergeStaticConfig(ThemeEntity $theme): array
  384.     {
  385.         $configuredTheme = [];
  387.         $pluginConfig = null;
  388.         if ($theme->getTechnicalName()) {
  389.             $pluginConfig = $this->extensionRegistry->getConfigurations()->getByTechnicalName($theme->getTechnicalName());
  390.         }
  392.         if ($pluginConfig !== null) {
  393.             $configuredTheme = $pluginConfig->getThemeConfig();
  394.         }
  396.         if ($theme->getBaseConfig() !== null) {
  397.             $configuredTheme = array_replace_recursive($configuredTheme ?? [], $theme->getBaseConfig());
  398.         }
  400.         if ($theme->getConfigValues() !== null) {
  401.             foreach ($theme->getConfigValues() as $fieldName => $configValue) {
  402.                 if (\array_key_exists('value', $configValue)) {
  403.                     $configuredTheme['fields'][$fieldName]['value'] = $configValue['value'];
  404.                 }
  405.             }
  406.         }
  408.         return $configuredTheme ?: [];
  409.     }
  411.     /**
  412.      * @param array<string, mixed> $fieldConfig
  413.      */
  414.     private function getTab(array $fieldConfig): string
  415.     {
  416.         $tab = 'default';
  418.         if (isset($fieldConfig['tab'])) {
  419.             $tab = $fieldConfig['tab'];
  420.         }
  422.         return $tab;
  423.     }
  425.     /**
  426.      * @param array<string, mixed> $fieldConfig
  427.      */
  428.     private function getBlock(array $fieldConfig): string
  429.     {
  430.         $block = 'default';
  432.         if (isset($fieldConfig['block'])) {
  433.             $block = $fieldConfig['block'];
  434.         }
  436.         return $block;
  437.     }
  439.     /**
  440.      * @param array<string, mixed> $fieldConfig
  441.      */
  442.     private function getSection(array $fieldConfig): string
  443.     {
  444.         $section = 'default';
  446.         if (isset($fieldConfig['section'])) {
  447.             $section = $fieldConfig['section'];
  448.         }
  450.         return $section;
  451.     }
  453.     /**
  454.      * @param array<string, mixed> $translations
  455.      */
  456.     private function getTabLabel(string $tabName, array $translations): string
  457.     {
  458.         if ($tabName === 'default') {
  459.             return '';
  460.         }
  462.         return $translations['tabs.' . $tabName] ?? $tabName;
  463.     }
  465.     /**
  466.      * @param array<string, mixed> $translations
  467.      */
  468.     private function getBlockLabel(string $blockName, array $translations): string
  469.     {
  470.         if ($blockName === 'default') {
  471.             return '';
  472.         }
  474.         return $translations['blocks.' . $blockName] ?? $blockName;
  475.     }
  477.     /**
  478.      * @param array<string, mixed> $translations
  479.      */
  480.     private function getSectionLabel(string $sectionName, array $translations): string
  481.     {
  482.         if ($sectionName === 'default') {
  483.             return '';
  484.         }
  486.         return $translations['sections.' . $sectionName] ?? $sectionName;
  487.     }
  489.     /**
  490.      * @param array<string, mixed> $themeConfiguration
  491.      * @param array<string, mixed> $translations
  492.      *
  493.      * @return array<string, mixed>
  494.      */
  495.     private function translateLabels(array $themeConfiguration, array $translations): array
  496.     {
  497.         foreach ($themeConfiguration as $key => &$value) {
  498.             $value['label'] = $translations['fields.' . $key] ?? $key;
  499.         }
  501.         return $themeConfiguration;
  502.     }
  504.     /**
  505.      * @param array<string, mixed> $themeConfiguration
  506.      * @param array<string, mixed> $translations
  507.      *
  508.      * @return array<string, mixed>
  509.      */
  510.     private function translateHelpTexts(array $themeConfiguration, array $translations): array
  511.     {
  512.         foreach ($themeConfiguration as $key => &$value) {
  513.             $value['helpText'] = $translations['fields.' . $key] ?? null;
  514.         }
  516.         return $themeConfiguration;
  517.     }
  519.     /**
  520.      * @return array<string, mixed>
  521.      */
  522.     private function getTranslations(string $themeId, Context $context): array
  523.     {
  524.         /** @var ThemeEntity $theme */
  525.         $theme = $this->themeRepository->search(new Criteria([$themeId]), $context)->get($themeId);
  526.         $translations = $theme->getLabels() ?: [];
  528.         if ($theme->getParentThemeId()) {
  529.             $criteria = new Criteria();
  530.             $criteria->setTitle('theme-service::load-translations');
  532.             $themes = $this->themeRepository->search($criteria, $context);
  533.             $parentThemes = $this->getParentThemeIds($themes, $theme);
  535.             foreach ($parentThemes as $parentTheme) {
  536.                 $parentTranslations = $parentTheme->getLabels() ?: [];
  537.                 $translations = array_replace_recursive($parentTranslations, $translations);
  538.             }
  539.         }
  541.         return $translations;
  542.     }
  544.     /**
  545.      * @param array<string, mixed> $configuration
  546.      */
  547.     private function fieldIsInherited(string $fieldName, array $configuration): bool
  548.     {
  549.         if (!isset($configuration['fields'])) {
  550.             return true;
  551.         }
  553.         if (!\is_array($configuration['fields'])) {
  554.             return true;
  555.         }
  557.         if (!\array_key_exists($fieldName, $configuration['fields'])) {
  558.             return true;
  559.         }
  561.         return false;
  562.     }
  563. }