vendor/shopware/core/Framework/Script/Execution/ScriptExecutor.php line 60

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\Script\Execution;
  5. use Psr\Log\LoggerInterface;
  6. use Shopware\Core\DevOps\Environment\EnvironmentHelper;
  7. use Shopware\Core\Framework\Adapter\Twig\Extension\PcreExtension;
  8. use Shopware\Core\Framework\Adapter\Twig\Extension\PhpSyntaxExtension;
  9. use Shopware\Core\Framework\Adapter\Twig\Filter\ReplaceRecursiveFilter;
  10. use Shopware\Core\Framework\Adapter\Twig\SecurityExtension;
  11. use Shopware\Core\Framework\Adapter\Twig\TwigEnvironment;
  12. use Shopware\Core\Framework\App\Event\Hooks\AppLifecycleHook;
  13. use Shopware\Core\Framework\Log\Package;
  14. use Shopware\Core\Framework\Script\Debugging\Debug;
  15. use Shopware\Core\Framework\Script\Debugging\ScriptTraces;
  16. use Shopware\Core\Framework\Script\Exception\NoHookServiceFactoryException;
  17. use Shopware\Core\Framework\Script\Exception\ScriptExecutionFailedException;
  18. use Shopware\Core\Framework\Script\Execution\Awareness\AppSpecificHook;
  19. use Shopware\Core\Framework\Script\Execution\Awareness\HookServiceFactory;
  20. use Shopware\Core\Framework\Script\Execution\Awareness\StoppableHook;
  21. use Shopware\Core\Framework\Script\ServiceStubs;
  22. use Shopware\Core\Framework\Struct\ArrayStruct;
  23. use Symfony\Bridge\Twig\Extension\TranslationExtension;
  24. use Symfony\Component\DependencyInjection\ContainerInterface;
  25. use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
  26. use Twig\Environment;
  27. use Twig\Extension\DebugExtension;
  29. #[Package('core')]
  30. class ScriptExecutor
  31. {
  32.     public static bool $isInScriptExecutionContext = false;
  34.     /**
  35.      * @internal
  36.      */
  37.     public function __construct(
  38.         private readonly ScriptLoader $loader,
  39.         private readonly LoggerInterface $logger,
  40.         private readonly ScriptTraces $traces,
  41.         private readonly ContainerInterface $container,
  42.         private readonly TranslationExtension $translationExtension,
  43.         private readonly string $shopwareVersion,
  44.     ) {
  45.     }
  47.     public function execute(Hook $hook): void
  48.     {
  49.         if (EnvironmentHelper::getVariable('DISABLE_EXTENSIONS', false)) {
  50.             return;
  51.         }
  53.         if ($hook instanceof InterfaceHook) {
  54.             throw new \RuntimeException(sprintf(
  55.                 'Tried to execute InterfaceHook "%s", butInterfaceHooks should not be executed, execute the functions of the hook instead',
  56.                 $hook::class
  57.             ));
  58.         }
  60.         $scripts = $this->loader->get($hook->getName());
  61.         $this->traces->initHook($hook);
  63.         foreach ($scripts as $script) {
  64.             $scriptAppInfo = $script->getScriptAppInformation();
  65.             if ($scriptAppInfo && $hook instanceof AppSpecificHook && $hook->getAppId() !== $scriptAppInfo->getAppId()) {
  66.                 // only execute scripts from the app the hook specifies
  67.                 continue;
  68.             }
  70.             if (!$hook instanceof AppLifecycleHook && !$script->isActive()) {
  71.                 continue;
  72.             }
  74.             try {
  75.                 static::$isInScriptExecutionContext = true;
  76.                 $this->render($hook, $script);
  77.             } catch (\Throwable $e) {
  78.                 $scriptException = new ScriptExecutionFailedException($hook->getName(), $script->getName(), $e);
  79.                 $this->logger->error($scriptException->getMessage(), ['exception' => $e]);
  81.                 throw $scriptException;
  82.             } finally {
  83.                 static::$isInScriptExecutionContext = false;
  84.             }
  86.             if ($hook instanceof StoppableHook && $hook->isPropagationStopped()) {
  87.                 break;
  88.             }
  89.         }
  90.     }
  92.     private function render(Hook $hook, Script $script): void
  93.     {
  94.         $twig = $this->initEnv($script);
  96.         $services = $this->initServices($hook, $script);
  98.         $twig->addGlobal('services', $services);
  100.         $this->traces->trace($hook, $script, function (Debug $debug) use ($twig, $script, $hook): void {
  101.             $twig->addGlobal('debug', $debug);
  103.             if ($hook instanceof DeprecatedHook) {
  104.                 ScriptTraces::addDeprecationNotice($hook->getDeprecationNotice());
  105.             }
  107.             $template = $twig->load($script->getName());
  109.             if (!$hook instanceof FunctionHook) {
  110.                 $template->render(['hook' => $hook]);
  112.                 return;
  113.             }
  115.             $blockName = $hook->getFunctionName();
  116.             if ($template->hasBlock($blockName)) {
  117.                 $template->renderBlock($blockName, ['hook' => $hook]);
  119.                 return;
  120.             }
  122.             if (!$hook instanceof OptionalFunctionHook) {
  123.                 throw new \RuntimeException(sprintf(
  124.                     'Required function "%s" missing in script "%s", please make sure you add the required block in your script.',
  125.                     $hook->getFunctionName(),
  126.                     $script->getName()
  127.                 ));
  128.             }
  130.             $requiredFromVersion = $hook->willBeRequiredInVersion();
  131.             if ($requiredFromVersion) {
  132.                 ScriptTraces::addDeprecationNotice(sprintf(
  133.                     'Function "%s" will be required from %s onward, but is not implemented in script "%s", please make sure you add the block in your script.',
  134.                     $hook->getFunctionName(),
  135.                     $requiredFromVersion,
  136.                     $script->getName()
  137.                 ));
  138.             }
  139.         });
  141.         $this->callAfter($services, $hook, $script);
  142.     }
  144.     private function initEnv(Script $script): Environment
  145.     {
  146.         $twig = new TwigEnvironment(
  147.             new ScriptTwigLoader($script),
  148.             $script->getTwigOptions()
  149.         );
  151.         $twig->addExtension(new PhpSyntaxExtension());
  152.         $twig->addExtension($this->translationExtension);
  153.         $twig->addExtension(new SecurityExtension([]));
  154.         $twig->addExtension(new PcreExtension());
  155.         $twig->addExtension(new ReplaceRecursiveFilter());
  157.         if ($script->getTwigOptions()['debug'] ?? false) {
  158.             $twig->addExtension(new DebugExtension());
  159.         }
  161.         $twig->addGlobal('shopware', new ArrayStruct([
  162.             'version' => $this->shopwareVersion,
  163.         ]));
  165.         return $twig;
  166.     }
  168.     private function initServices(Hook $hook, Script $script): ServiceStubs
  169.     {
  170.         $services = new ServiceStubs($hook->getName());
  171.         $deprecatedServices = $hook->getDeprecatedServices();
  172.         foreach ($hook->getServiceIds() as $serviceId) {
  173.             if (!$this->container->has($serviceId)) {
  174.                 throw new ServiceNotFoundException($serviceId, 'Hook: ' . $hook->getName());
  175.             }
  177.             $service = $this->container->get($serviceId);
  178.             if (!$service instanceof HookServiceFactory) {
  179.                 throw new NoHookServiceFactoryException($serviceId);
  180.             }
  182.             $services->add($service->getName(), $service->factory($hook, $script), $deprecatedServices[$serviceId] ?? null);
  183.         }
  185.         return $services;
  186.     }
  188.     private function callAfter(ServiceStubs $services, Hook $hook, Script $script): void
  189.     {
  190.         foreach ($hook->getServiceIds() as $serviceId) {
  191.             if (!$this->container->has($serviceId)) {
  192.                 throw new ServiceNotFoundException($serviceId, 'Hook: ' . $hook->getName());
  193.             }
  195.             $factory = $this->container->get($serviceId);
  196.             if (!$factory instanceof HookServiceFactory) {
  197.                 throw new NoHookServiceFactoryException($serviceId);
  198.             }
  200.             $service = $services->get($factory->getName());
  202.             $factory->after($service, $hook, $script);
  203.         }
  204.     }
  205. }