src/Core/Framework/Script/Execution/ScriptExecutor.php line 51

  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\PhpSyntaxExtension;
  8. use Shopware\Core\Framework\Adapter\Twig\SecurityExtension;
  9. use Shopware\Core\Framework\Adapter\Twig\TwigEnvironment;
  10. use Shopware\Core\Framework\App\Event\Hooks\AppLifecycleHook;
  11. use Shopware\Core\Framework\Log\Package;
  12. use Shopware\Core\Framework\Script\Debugging\Debug;
  13. use Shopware\Core\Framework\Script\Debugging\ScriptTraces;
  14. use Shopware\Core\Framework\Script\Exception\NoHookServiceFactoryException;
  15. use Shopware\Core\Framework\Script\Exception\ScriptExecutionFailedException;
  16. use Shopware\Core\Framework\Script\Execution\Awareness\AppSpecificHook;
  17. use Shopware\Core\Framework\Script\Execution\Awareness\HookServiceFactory;
  18. use Shopware\Core\Framework\Script\Execution\Awareness\StoppableHook;
  19. use Shopware\Core\Framework\Script\ServiceStubs;
  20. use Symfony\Bridge\Twig\Extension\TranslationExtension;
  21. use Symfony\Component\DependencyInjection\ContainerInterface;
  22. use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
  23. use Twig\Environment;
  24. use Twig\Extension\DebugExtension;
  26. #[Package('core')]
  27. class ScriptExecutor
  28. {
  29.     public static bool $isInScriptExecutionContext = false;
  31.     /**
  32.      * @internal
  33.      */
  34.     public function __construct(private readonly ScriptLoader $loader, private readonly LoggerInterface $logger, private readonly ScriptTraces $traces, private readonly ContainerInterface $container, private readonly TranslationExtension $translationExtension)
  35.     {
  36.     }
  38.     public function execute(Hook $hook): void
  39.     {
  40.         if (EnvironmentHelper::getVariable('DISABLE_EXTENSIONS', false)) {
  41.             return;
  42.         }
  44.         if ($hook instanceof InterfaceHook) {
  45.             throw new \RuntimeException(sprintf(
  46.                 'Tried to execute InterfaceHook "%s", butInterfaceHooks should not be executed, execute the functions of the hook instead',
  47.                 $hook::class
  48.             ));
  49.         }
  51.         $scripts = $this->loader->get($hook->getName());
  52.         $this->traces->initHook($hook);
  54.         foreach ($scripts as $script) {
  55.             $scriptAppInfo = $script->getScriptAppInformation();
  56.             if ($scriptAppInfo && $hook instanceof AppSpecificHook && $hook->getAppId() !== $scriptAppInfo->getAppId()) {
  57.                 // only execute scripts from the app the hook specifies
  58.                 continue;
  59.             }
  61.             if (!$hook instanceof AppLifecycleHook && !$script->isActive()) {
  62.                 continue;
  63.             }
  65.             try {
  66.                 static::$isInScriptExecutionContext = true;
  67.                 $this->render($hook, $script);
  68.             } catch (\Throwable $e) {
  69.                 $scriptException = new ScriptExecutionFailedException($hook->getName(), $script->getName(), $e);
  70.                 $this->logger->error($scriptException->getMessage(), ['exception' => $e]);
  72.                 throw $scriptException;
  73.             } finally {
  74.                 static::$isInScriptExecutionContext = false;
  75.             }
  77.             if ($hook instanceof StoppableHook && $hook->isPropagationStopped()) {
  78.                 break;
  79.             }
  80.         }
  81.     }
  83.     private function render(Hook $hook, Script $script): void
  84.     {
  85.         $twig = $this->initEnv($script);
  87.         $services = $this->initServices($hook, $script);
  89.         $twig->addGlobal('services', $services);
  91.         $this->traces->trace($hook, $script, function (Debug $debug) use ($twig, $script, $hook): void {
  92.             $twig->addGlobal('debug', $debug);
  94.             if ($hook instanceof DeprecatedHook) {
  95.                 ScriptTraces::addDeprecationNotice($hook->getDeprecationNotice());
  96.             }
  98.             $template = $twig->load($script->getName());
  100.             if (!$hook instanceof FunctionHook) {
  101.                 $template->render(['hook' => $hook]);
  103.                 return;
  104.             }
  106.             $blockName = $hook->getFunctionName();
  107.             if ($template->hasBlock($blockName)) {
  108.                 $template->renderBlock($blockName, ['hook' => $hook]);
  110.                 return;
  111.             }
  113.             if (!$hook instanceof OptionalFunctionHook) {
  114.                 throw new \RuntimeException(sprintf(
  115.                     'Required function "%s" missing in script "%s", please make sure you add the required block in your script.',
  116.                     $hook->getFunctionName(),
  117.                     $script->getName()
  118.                 ));
  119.             }
  121.             $requiredFromVersion = $hook->willBeRequiredInVersion();
  122.             if ($requiredFromVersion) {
  123.                 ScriptTraces::addDeprecationNotice(sprintf(
  124.                     '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.',
  125.                     $hook->getFunctionName(),
  126.                     $requiredFromVersion,
  127.                     $script->getName()
  128.                 ));
  129.             }
  130.         });
  132.         $this->callAfter($services, $hook, $script);
  133.     }
  135.     private function initEnv(Script $script): Environment
  136.     {
  137.         $twig = new TwigEnvironment(
  138.             new ScriptTwigLoader($script),
  139.             $script->getTwigOptions()
  140.         );
  142.         $twig->addExtension(new PhpSyntaxExtension());
  143.         $twig->addExtension($this->translationExtension);
  144.         $twig->addExtension(new SecurityExtension([]));
  146.         if ($script->getTwigOptions()['debug'] ?? false) {
  147.             $twig->addExtension(new DebugExtension());
  148.         }
  150.         return $twig;
  151.     }
  153.     private function initServices(Hook $hook, Script $script): ServiceStubs
  154.     {
  155.         $services = new ServiceStubs($hook->getName());
  156.         $deprecatedServices = $hook->getDeprecatedServices();
  157.         foreach ($hook->getServiceIds() as $serviceId) {
  158.             if (!$this->container->has($serviceId)) {
  159.                 throw new ServiceNotFoundException($serviceId, 'Hook: ' . $hook->getName());
  160.             }
  162.             $service = $this->container->get($serviceId);
  163.             if (!$service instanceof HookServiceFactory) {
  164.                 throw new NoHookServiceFactoryException($serviceId);
  165.             }
  167.             $services->add($service->getName(), $service->factory($hook, $script), $deprecatedServices[$serviceId] ?? null);
  168.         }
  170.         return $services;
  171.     }
  173.     private function callAfter(ServiceStubs $services, Hook $hook, Script $script): void
  174.     {
  175.         foreach ($hook->getServiceIds() as $serviceId) {
  176.             if (!$this->container->has($serviceId)) {
  177.                 throw new ServiceNotFoundException($serviceId, 'Hook: ' . $hook->getName());
  178.             }
  180.             $factory = $this->container->get($serviceId);
  181.             if (!$factory instanceof HookServiceFactory) {
  182.                 throw new NoHookServiceFactoryException($serviceId);
  183.             }
  185.             $service = $services->get($factory->getName());
  187.             $factory->after($service, $hook, $script);
  188.         }
  189.     }
  190. }