vendor/shopware/core/Content/Media/Subscriber/MediaDeletionSubscriber.php line 61

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Media\Subscriber;
  5. use Doctrine\DBAL\ArrayParameterType;
  6. use Doctrine\DBAL\Connection;
  7. use League\Flysystem\Visibility;
  8. use Shopware\Core\Content\Media\Aggregate\MediaFolder\MediaFolderDefinition;
  9. use Shopware\Core\Content\Media\Aggregate\MediaThumbnail\MediaThumbnailCollection;
  10. use Shopware\Core\Content\Media\Aggregate\MediaThumbnail\MediaThumbnailDefinition;
  11. use Shopware\Core\Content\Media\Event\MediaThumbnailDeletedEvent;
  12. use Shopware\Core\Content\Media\MediaDefinition;
  13. use Shopware\Core\Content\Media\MediaEntity;
  14. use Shopware\Core\Content\Media\Message\DeleteFileHandler;
  15. use Shopware\Core\Content\Media\Message\DeleteFileMessage;
  16. use Shopware\Core\Content\Media\Pathname\UrlGeneratorInterface;
  17. use Shopware\Core\Framework\Context;
  18. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  19. use Shopware\Core\Framework\DataAbstractionLayer\Event\BeforeDeleteEvent;
  20. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntitySearchedEvent;
  21. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  22. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsAnyFilter;
  23. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  24. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\MultiFilter;
  25. use Shopware\Core\Framework\Log\Package;
  26. use Shopware\Core\Framework\Uuid\Uuid;
  27. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  28. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  29. use Symfony\Component\Messenger\MessageBusInterface;
  31. /**
  32.  * @internal
  33.  */
  34. #[Package('content')]
  35. class MediaDeletionSubscriber implements EventSubscriberInterface
  36. {
  37.     final public const SYNCHRONE_FILE_DELETE = 'synchrone-file-delete';
  39.     /**
  40.      * @internal
  41.      */
  42.     public function __construct(
  43.         private readonly UrlGeneratorInterface $urlGenerator,
  44.         private readonly EventDispatcherInterface $dispatcher,
  45.         private readonly EntityRepository $thumbnailRepository,
  46.         private readonly MessageBusInterface $messageBus,
  47.         private readonly DeleteFileHandler $deleteFileHandler,
  48.         private readonly Connection $connection,
  49.         private readonly EntityRepository $mediaRepository
  50.     ) {
  51.     }
  53.     public static function getSubscribedEvents(): array
  54.     {
  55.         return [
  56.             BeforeDeleteEvent::class => 'beforeDelete',
  57.             EntitySearchedEvent::class => 'securePrivateFolders',
  58.         ];
  59.     }
  61.     public function securePrivateFolders(EntitySearchedEvent $event): void
  62.     {
  63.         if ($event->getContext()->getScope() === Context::SYSTEM_SCOPE) {
  64.             return;
  65.         }
  67.         if ($event->getDefinition()->getEntityName() === MediaFolderDefinition::ENTITY_NAME) {
  68.             $event->getCriteria()->addFilter(
  69.                 new MultiFilter('OR', [
  70.                     new EqualsFilter('media_folder.configuration.private', false),
  71.                     new EqualsFilter('media_folder.configuration.private', null),
  72.                 ])
  73.             );
  75.             return;
  76.         }
  78.         if ($event->getDefinition()->getEntityName() === MediaDefinition::ENTITY_NAME) {
  79.             $event->getCriteria()->addFilter(
  80.                 new MultiFilter('OR', [
  81.                     new EqualsFilter('private', false),
  82.                     new MultiFilter('AND', [
  83.                         new EqualsFilter('private', true),
  84.                         new EqualsFilter('mediaFolder.defaultFolder.entity', 'product_download'),
  85.                     ]),
  86.                 ])
  87.             );
  88.         }
  89.     }
  91.     public function beforeDelete(BeforeDeleteEvent $event): void
  92.     {
  93.         $affected = array_values($event->getIds(MediaThumbnailDefinition::ENTITY_NAME));
  94.         if (!empty($affected)) {
  95.             $this->handleThumbnailDeletion($event, $affected, $event->getContext());
  96.         }
  98.         $affected = array_values($event->getIds(MediaFolderDefinition::ENTITY_NAME));
  99.         if (!empty($affected)) {
  100.             $this->handleFolderDeletion($affected, $event->getContext());
  101.         }
  103.         $affected = array_values($event->getIds(MediaDefinition::ENTITY_NAME));
  104.         if (!empty($affected)) {
  105.             $this->handleMediaDeletion($affected, $event->getContext());
  106.         }
  107.     }
  109.     /**
  110.      * @param list<string> $affected
  111.      */
  112.     private function handleMediaDeletion(array $affected, Context $context): void
  113.     {
  114.         $media = $context->scope(Context::SYSTEM_SCOPE, fn (Context $context) => $this->mediaRepository->search(new Criteria($affected), $context));
  116.         $privatePaths = [];
  117.         $publicPaths = [];
  118.         $thumbnails = [];
  120.         /** @var MediaEntity $mediaEntity */
  121.         foreach ($media as $mediaEntity) {
  122.             if (!$mediaEntity->hasFile()) {
  123.                 continue;
  124.             }
  126.             if ($mediaEntity->isPrivate()) {
  127.                 $privatePaths[] = $this->urlGenerator->getRelativeMediaUrl($mediaEntity);
  128.             } else {
  129.                 $publicPaths[] = $this->urlGenerator->getRelativeMediaUrl($mediaEntity);
  130.             }
  132.             if (!$mediaEntity->getThumbnails()) {
  133.                 continue;
  134.             }
  136.             foreach ($mediaEntity->getThumbnails()->getIds() as $id) {
  137.                 $thumbnails[] = ['id' => $id];
  138.             }
  139.         }
  141.         $this->performFileDelete($context, $publicPaths, Visibility::PUBLIC);
  142.         $this->performFileDelete($context, $privatePaths, Visibility::PRIVATE);
  144.         $this->thumbnailRepository->delete($thumbnails, $context);
  145.     }
  147.     /**
  148.      * @param list<string> $affected
  149.      */
  150.     private function handleFolderDeletion(array $affected, Context $context): void
  151.     {
  152.         $ids = $this->fetchChildrenIds($affected);
  154.         if (empty($ids)) {
  155.             return;
  156.         }
  158.         $media = $this->connection->fetchAllAssociative(
  159.             'SELECT LOWER(HEX(id)) as id FROM media WHERE media_folder_id IN (:ids)',
  160.             ['ids' => Uuid::fromHexToBytesList($ids)],
  161.             ['ids' => ArrayParameterType::STRING]
  162.         );
  164.         if (empty($media)) {
  165.             return;
  166.         }
  168.         $this->mediaRepository->delete($media, $context);
  169.     }
  171.     /**
  172.      * @param list<string> $ids
  173.      *
  174.      * @return list<string>
  175.      */
  176.     private function fetchChildrenIds(array $ids): array
  177.     {
  178.         $children = $this->connection->fetchFirstColumn(
  179.             'SELECT LOWER(HEX(id)) FROM media_folder WHERE parent_id IN (:ids)',
  180.             ['ids' => Uuid::fromHexToBytesList($ids)],
  181.             ['ids' => ArrayParameterType::STRING]
  182.         );
  184.         if (empty($children)) {
  185.             return \array_merge($ids, $children);
  186.         }
  188.         $nested = $this->fetchChildrenIds($children);
  190.         $children = [...$children, ...$nested];
  192.         return [...$ids, ...$children, ...$nested];
  193.     }
  195.     /**
  196.      * @param list<string> $affected
  197.      */
  198.     private function handleThumbnailDeletion(BeforeDeleteEvent $event, array $affected, Context $context): void
  199.     {
  200.         $privatePaths = [];
  201.         $publicPaths = [];
  203.         $thumbnails = $this->getThumbnails($affected, $context);
  205.         foreach ($thumbnails as $thumbnail) {
  206.             if ($thumbnail->getMedia() === null) {
  207.                 continue;
  208.             }
  210.             if ($thumbnail->getMedia()->isPrivate()) {
  211.                 $privatePaths[] = $this->urlGenerator->getRelativeThumbnailUrl($thumbnail->getMedia(), $thumbnail);
  212.             } else {
  213.                 $publicPaths[] = $this->urlGenerator->getRelativeThumbnailUrl($thumbnail->getMedia(), $thumbnail);
  214.             }
  215.         }
  217.         $this->performFileDelete($context, $privatePaths, Visibility::PRIVATE);
  218.         $this->performFileDelete($context, $publicPaths, Visibility::PUBLIC);
  220.         $event->addSuccess(function () use ($thumbnails, $context): void {
  221.             $this->dispatcher->dispatch(new MediaThumbnailDeletedEvent($thumbnails, $context), MediaThumbnailDeletedEvent::EVENT_NAME);
  222.         });
  223.     }
  225.     /**
  226.      * @param list<string> $ids
  227.      */
  228.     private function getThumbnails(array $ids, Context $context): MediaThumbnailCollection
  229.     {
  230.         $criteria = new Criteria();
  231.         $criteria->addAssociation('media');
  232.         $criteria->addFilter(new EqualsAnyFilter('media_thumbnail.id', $ids));
  234.         $thumbnailsSearch = $this->thumbnailRepository->search($criteria, $context);
  236.         /** @var MediaThumbnailCollection $thumbnails */
  237.         $thumbnails = $thumbnailsSearch->getEntities();
  239.         return $thumbnails;
  240.     }
  242.     /**
  243.      * @param list<string> $paths
  244.      */
  245.     private function performFileDelete(Context $context, array $paths, string $visibility): void
  246.     {
  247.         if (\count($paths) <= 0) {
  248.             return;
  249.         }
  251.         if ($context->hasState(self::SYNCHRONE_FILE_DELETE)) {
  252.             $this->deleteFileHandler->__invoke(new DeleteFileMessage($paths, $visibility));
  254.             return;
  255.         }
  257.         $this->messageBus->dispatch(new DeleteFileMessage($paths, $visibility));
  258.     }
  259. }