vendor/shopware/core/Framework/Update/Api/UpdateController.php line 107

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\Update\Api;
  5. use Shopware\Core\Framework\Api\Context\AdminApiSource;
  6. use Shopware\Core\Framework\Api\Context\Exception\InvalidContextSourceException;
  7. use Shopware\Core\Framework\Api\Context\Exception\InvalidContextSourceUserException;
  8. use Shopware\Core\Framework\Context;
  9. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  11. use Shopware\Core\Framework\Log\Package;
  12. use Shopware\Core\Framework\Plugin\KernelPluginLoader\StaticKernelPluginLoader;
  13. use Shopware\Core\Framework\Routing\Annotation\Acl;
  14. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  15. use Shopware\Core\Framework\Routing\Annotation\Since;
  16. use Shopware\Core\Framework\Store\Services\AbstractExtensionLifecycle;
  17. use Shopware\Core\Framework\Update\Event\UpdatePostFinishEvent;
  18. use Shopware\Core\Framework\Update\Event\UpdatePostPrepareEvent;
  19. use Shopware\Core\Framework\Update\Event\UpdatePreFinishEvent;
  20. use Shopware\Core\Framework\Update\Event\UpdatePrePrepareEvent;
  21. use Shopware\Core\Framework\Update\Exception\UpdateFailedException;
  22. use Shopware\Core\Framework\Update\Services\ApiClient;
  23. use Shopware\Core\Framework\Update\Services\PluginCompatibility;
  24. use Shopware\Core\Framework\Update\Services\RequirementsValidator;
  25. use Shopware\Core\Framework\Update\Steps\DeactivateExtensionsStep;
  26. use Shopware\Core\Framework\Update\Steps\DownloadStep;
  27. use Shopware\Core\Framework\Update\Steps\FinishResult;
  28. use Shopware\Core\Framework\Update\Steps\UnpackStep;
  29. use Shopware\Core\Framework\Update\Steps\ValidResult;
  30. use Shopware\Core\Framework\Update\Struct\Version;
  31. use Shopware\Core\Framework\Update\VersionFactory;
  32. use Shopware\Core\Framework\Uuid\Uuid;
  33. use Shopware\Core\Kernel;
  34. use Shopware\Core\System\SystemConfig\SystemConfigService;
  35. use Shopware\Core\System\User\UserEntity;
  36. use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
  37. use Symfony\Component\DependencyInjection\ContainerInterface;
  38. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  39. use Symfony\Component\Filesystem\Filesystem;
  40. use Symfony\Component\HttpFoundation\JsonResponse;
  41. use Symfony\Component\HttpFoundation\Request;
  42. use Symfony\Component\HttpFoundation\Response;
  43. use Symfony\Component\Routing\Annotation\Route;
  44. use Symfony\Component\Routing\Exception\RouteNotFoundException;
  46. /**
  47.  * @deprecated tag:v6.5.0 - reason:becomes-internal - will be considered internal
  48.  * @Route(defaults={"_routeScope"={"api"}})
  49.  */
  50. #[Package('system-settings')]
  51. class UpdateController extends AbstractController
  52. {
  53.     public const UPDATE_TOKEN_KEY = 'core.update.token';
  54.     public const UPDATE_PREVIOUS_VERSION_KEY = 'core.update.previousVersion';
  56.     private ApiClient $apiClient;
  58.     private string $rootDir;
  60.     private RequirementsValidator $requirementsValidator;
  62.     private PluginCompatibility $pluginCompatibility;
  64.     private EventDispatcherInterface $eventDispatcher;
  66.     private SystemConfigService $systemConfig;
  68.     private string $shopwareVersion;
  70.     private bool $isUpdateTest;
  72.     private EntityRepositoryInterface $userRepository;
  74.     private AbstractExtensionLifecycle $extensionLifecycleService;
  76.     /**
  77.      * @internal
  78.      */
  79.     public function __construct(
  80.         string $rootDir,
  81.         ApiClient $apiClient,
  82.         RequirementsValidator $requirementsValidator,
  83.         PluginCompatibility $pluginCompatibility,
  84.         EventDispatcherInterface $eventDispatcher,
  85.         SystemConfigService $systemConfig,
  86.         AbstractExtensionLifecycle $extensionLifecycleService,
  87.         EntityRepositoryInterface $userRepository,
  88.         string $shopwareVersion,
  89.         bool $isUpdateTest = false
  90.     ) {
  91.         $this->rootDir = $rootDir;
  92.         $this->apiClient = $apiClient;
  93.         $this->requirementsValidator = $requirementsValidator;
  94.         $this->pluginCompatibility = $pluginCompatibility;
  95.         $this->eventDispatcher = $eventDispatcher;
  96.         $this->systemConfig = $systemConfig;
  97.         $this->shopwareVersion = $shopwareVersion;
  98.         $this->isUpdateTest = $isUpdateTest;
  99.         $this->userRepository = $userRepository;
  100.         $this->extensionLifecycleService = $extensionLifecycleService;
  101.     }
  103.     /**
  104.      * @Since("6.0.0.0")
  105.      * @Route("/api/_action/update/check", name="api.custom.updateapi.check", methods={"GET"}, defaults={"_acl"={"system:core:update"}})
  106.      */
  107.     public function updateApiCheck(): JsonResponse
  108.     {
  109.         if ($this->isUpdateTest) {
  110.             $version = VersionFactory::createTestVersion();
  112.             return new JsonResponse($version);
  113.         }
  115.         try {
  116.             $updates = $this->apiClient->checkForUpdates();
  118.             if (!$updates->isNewer) {
  119.                 return new JsonResponse();
  120.             }
  122.             return new JsonResponse($updates);
  123.         } catch (\Throwable $e) {
  124.             return new JsonResponse([
  125.                 '__class' => \get_class($e),
  126.                 '__message' => $e->getMessage(),
  127.             ]);
  128.         }
  129.     }
  131.     /**
  132.      * @Since("6.0.0.0")
  133.      * @Route("/api/_action/update/check-requirements", name="api.custom.update.check_requirements", methods={"GET"}, defaults={"_acl"={"system:core:update"}})
  134.      */
  135.     public function checkRequirements(): JsonResponse
  136.     {
  137.         $update = $this->apiClient->checkForUpdates($this->shopwareVersion === Kernel::SHOPWARE_FALLBACK_VERSION);
  139.         return new JsonResponse($this->requirementsValidator->validate($update));
  140.     }
  142.     /**
  143.      * @Since("6.0.0.0")
  144.      * @Route("/api/_action/update/plugin-compatibility", name="api.custom.updateapi.plugin_compatibility", methods={"GET"}, defaults={"_acl"={"system:core:update", "system_config:read"}})
  145.      */
  146.     public function pluginCompatibility(Context $context): JsonResponse
  147.     {
  148.         $update = $this->apiClient->checkForUpdates($this->shopwareVersion === Kernel::SHOPWARE_FALLBACK_VERSION);
  150.         return new JsonResponse($this->pluginCompatibility->getExtensionCompatibilities($update, $context));
  151.     }
  153.     /**
  154.      * @Since("6.0.0.0")
  155.      * @Route("/api/_action/update/download-latest-update", name="api.custom.updateapi.download_latest_update", methods={"GET"}, defaults={"_acl"={"system:core:update", "system_config:read"}})
  156.      */
  157.     public function downloadLatestUpdate(Request $request): JsonResponse
  158.     {
  159.         $update = $this->apiClient->checkForUpdates($this->shopwareVersion === Kernel::SHOPWARE_FALLBACK_VERSION);
  160.         $offset = $request->query->getInt('offset');
  162.         $destination = $this->createDestinationFromVersion($update);
  164.         if ($offset === 0 && file_exists($destination)) {
  165.             unlink($destination);
  166.         }
  168.         $result = (new DownloadStep(
  169.             $update,
  170.             $destination,
  171.             $this->shopwareVersion === Kernel::SHOPWARE_FALLBACK_VERSION
  172.         ))->run($offset);
  174.         return $this->toJson($result);
  175.     }
  177.     /**
  178.      * @Since("6.0.0.0")
  179.      * @Route("/api/_action/update/unpack", name="api.custom.updateapi.unpack", methods={"GET"}, defaults={"_acl"={"system:core:update", "system_config:read"}})
  180.      */
  181.     public function unpack(Request $request, Context $context): JsonResponse
  182.     {
  183.         $update = $this->apiClient->checkForUpdates($this->shopwareVersion === Kernel::SHOPWARE_FALLBACK_VERSION);
  185.         $source = $this->createDestinationFromVersion($update);
  186.         $offset = $request->query->getInt('offset');
  188.         $fs = new Filesystem();
  190.         $updateDir = $this->rootDir . '/files/update/';
  191.         $fileDir = $this->rootDir . '/files/update/files';
  193.         $unpackStep = new UnpackStep($source, $fileDir, $this->shopwareVersion === Kernel::SHOPWARE_FALLBACK_VERSION);
  195.         if ($offset === 0) {
  196.             $fs->remove($updateDir);
  197.         }
  199.         $result = $unpackStep->run($offset);
  201.         // Test Mode
  202.         if ($result instanceof FinishResult && $this->shopwareVersion === Kernel::SHOPWARE_FALLBACK_VERSION) {
  203.             $updateToken = Uuid::randomHex();
  204.             $this->systemConfig->set(self::UPDATE_TOKEN_KEY, $updateToken);
  206.             return new JsonResponse([
  207.                 'redirectTo' => $request->getBaseUrl() . '/api/_action/update/finish/' . $updateToken,
  208.             ]);
  209.         }
  211.         if ($result instanceof FinishResult) {
  212.             $fs->rename($fileDir . '/update-assets/', $updateDir . '/update-assets/');
  213.             $this->replaceRecoveryFiles($fileDir);
  215.             $payload = [
  216.                 'clientIp' => $request->getClientIp(),
  217.                 'version' => $update->version,
  218.                 'locale' => $this->getUpdateLocale($context),
  219.             ];
  221.             $updateFilePath = $this->rootDir . '/files/update/update.json';
  223.             if (!file_put_contents($updateFilePath, json_encode($payload))) {
  224.                 throw new UpdateFailedException(sprintf('Could not write file %s', $updateFilePath));
  225.             }
  227.             $this->systemConfig->set(self::UPDATE_PREVIOUS_VERSION_KEY, $update->version);
  229.             return new JsonResponse([
  230.                 'redirectTo' => $request->getBaseUrl() . '/recovery/update/index.php',
  231.             ]);
  232.         }
  234.         return $this->toJson($result);
  235.     }
  237.     /**
  238.      * @Since("6.1.0.0")
  239.      * @Route("/api/_action/update/deactivate-plugins", name="api.custom.updateapi.deactivate-plugins", methods={"GET"}, defaults={"_acl"={"system:core:update", "system_config:read"}})
  240.      */
  241.     public function deactivatePlugins(Request $request, Context $context): JsonResponse
  242.     {
  243.         $update = $this->apiClient->checkForUpdates($this->shopwareVersion === Kernel::SHOPWARE_FALLBACK_VERSION);
  245.         $offset = $request->query->getInt('offset');
  247.         if ($offset === 0) {
  248.             // plugins can subscribe to this events, check compatibility and throw exceptions to prevent the update
  249.             $this->eventDispatcher->dispatch(
  250.                 new UpdatePrePrepareEvent($context, $this->shopwareVersion, $update->version)
  251.             );
  252.         }
  254.         // disable plugins - save active plugins
  255.         $deactivationFilter = (string) $request->query->get(
  256.             'deactivationFilter',
  257.             PluginCompatibility::PLUGIN_DEACTIVATION_FILTER_NOT_COMPATIBLE
  258.         );
  260.         $deactivatePluginStep = new DeactivateExtensionsStep(
  261.             $update,
  262.             $deactivationFilter,
  263.             $this->pluginCompatibility,
  264.             $this->extensionLifecycleService,
  265.             $this->systemConfig,
  266.             $context
  267.         );
  269.         $result = $deactivatePluginStep->run($offset);
  271.         if ($result instanceof FinishResult) {
  272.             $containerWithoutPlugins = $this->rebootKernelWithoutPlugins();
  274.             // @internal plugins are deactivated
  275.             $containerWithoutPlugins->get('event_dispatcher')->dispatch(
  276.                 new UpdatePostPrepareEvent($context, $this->shopwareVersion, $update->version)
  277.             );
  278.         }
  280.         return $this->toJson($result);
  281.     }
  283.     /**
  284.      * @Since("6.0.0.0")
  285.      * @Route("/api/_action/update/finish/{token}", defaults={"auth_required"=false, "_acl"={"system:core:update", "system_config:read"}}, name="api.custom.updateapi.finish", methods={"GET"})
  286.      */
  287.     public function finish(string $token, Request $request, Context $context): Response
  288.     {
  289.         $offset = $request->query->getInt('offset');
  290.         $oldVersion = $this->systemConfig->getString(self::UPDATE_PREVIOUS_VERSION_KEY);
  291.         if ($offset === 0) {
  292.             if (!$token) {
  293.                 return $this->getFinishResponse();
  294.             }
  296.             $dbUpdateToken = $this->systemConfig->getString(self::UPDATE_TOKEN_KEY);
  297.             if (!$dbUpdateToken || $token !== $dbUpdateToken) {
  298.                 return $this->getFinishResponse();
  299.             }
  301.             $_unusedPreviousSetting = ignore_user_abort(true);
  303.             $this->eventDispatcher->dispatch(new UpdatePreFinishEvent($context, $oldVersion, $this->shopwareVersion));
  304.         }
  306.         // TODO: NEXT-8271 - The kernel should be rebooted with the plugins reactivated. This does not happen to save some time, because plugins were not reactivated anyway.
  307.         $this->eventDispatcher->dispatch(
  308.             new UpdatePostFinishEvent($context, $oldVersion, $this->shopwareVersion)
  309.         );
  311.         return $this->getFinishResponse();
  312.     }
  314.     private function getUpdateLocale(Context $context): string
  315.     {
  316.         $contextSource = $context->getSource();
  317.         if (!($contextSource instanceof AdminApiSource)) {
  318.             throw new InvalidContextSourceException(AdminApiSource::class, \get_class($contextSource));
  319.         }
  321.         $userId = $contextSource->getUserId();
  322.         if ($userId === null) {
  323.             throw new InvalidContextSourceUserException(\get_class($contextSource));
  324.         }
  326.         $criteria = new Criteria([$userId]);
  327.         $criteria->getAssociation('locale');
  329.         /** @var UserEntity|null $user */
  330.         $user = $this->userRepository->search($criteria, $context)->first();
  332.         if ($user && $user->getLocale()) {
  333.             $code = $user->getLocale()->getCode();
  335.             return mb_strtolower(explode('-', $code)[0]);
  336.         }
  338.         return 'en';
  339.     }
  341.     private function rebootKernelWithoutPlugins(): ContainerInterface
  342.     {
  343.         /** @var Kernel $kernel */
  344.         $kernel = $this->container->get('kernel');
  346.         $classLoad = $kernel->getPluginLoader()->getClassLoader();
  347.         $kernel->reboot(null, new StaticKernelPluginLoader($classLoad));
  349.         return $kernel->getContainer();
  350.     }
  352.     /**
  353.      * @param ValidResult|FinishResult $result
  354.      */
  355.     private function toJson(ValidResult $result): JsonResponse
  356.     {
  357.         if ($result instanceof FinishResult) {
  358.             return new JsonResponse([
  359.                 'valid' => false,
  360.                 'offset' => $result->getOffset(),
  361.                 'total' => $result->getTotal(),
  362.                 'success' => true,
  363.                 '_class' => \get_class($result),
  364.             ]);
  365.         }
  367.         return new JsonResponse([
  368.             'valid' => true,
  369.             'offset' => $result->getOffset(),
  370.             'total' => $result->getTotal(),
  371.             'success' => true,
  372.             '_class' => \get_class($result),
  373.         ]);
  374.     }
  376.     private function replaceRecoveryFiles(string $fileDir): void
  377.     {
  378.         $recoveryDir = $fileDir . '/vendor/shopware/recovery';
  379.         if (!is_dir($recoveryDir)) {
  380.             return;
  381.         }
  383.         $iterator = $this->createRecursiveFileIterator($recoveryDir);
  385.         $fs = new Filesystem();
  387.         /** @var \SplFileInfo $file */
  388.         foreach ($iterator as $file) {
  389.             $sourceFile = $file->getPathname();
  390.             $destinationFile = $this->rootDir . '/' . str_replace($fileDir, '', $file->getPathname());
  392.             $destinationDirectory = \dirname($destinationFile);
  393.             $fs->mkdir($destinationDirectory);
  394.             $fs->rename($sourceFile, $destinationFile, true);
  395.         }
  396.     }
  398.     private function createRecursiveFileIterator(string $path): \RecursiveIteratorIterator
  399.     {
  400.         $directoryIterator = new \RecursiveDirectoryIterator(
  401.             $path,
  402.             \RecursiveDirectoryIterator::SKIP_DOTS
  403.         );
  405.         return new \RecursiveIteratorIterator(
  406.             $directoryIterator,
  407.             \RecursiveIteratorIterator::LEAVES_ONLY
  408.         );
  409.     }
  411.     private function createDestinationFromVersion(Version $version): string
  412.     {
  413.         $filename = 'update_' . $version->sha1 . '.zip';
  415.         return $this->rootDir . '/' . $filename;
  416.     }
  418.     private function getFinishResponse(): Response
  419.     {
  420.         try {
  421.             return $this->redirectToRoute('administration.index');
  422.         } catch (RouteNotFoundException $e) {
  423.             return new Response('', Response::HTTP_NO_CONTENT);
  424.         }
  425.     }
  426. }