src/Core/Content/Media/Subscriber/MediaDeletionSubscriber.php line 90

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