vendor/shopware/core/Content/ImportExport/DataAbstractionLayer/Serializer/Entity/MediaSerializer.php line 142

Open in your IDE?
  1. <?php declare(strict_types=1);
  2. namespace Shopware\Core\Content\ImportExport\DataAbstractionLayer\Serializer\Entity;
  3. use Shopware\Core\Content\ImportExport\Exception\InvalidMediaUrlException;
  4. use Shopware\Core\Content\ImportExport\Exception\MediaDownloadException;
  5. use Shopware\Core\Content\ImportExport\Struct\Config;
  6. use Shopware\Core\Content\Media\Aggregate\MediaFolder\MediaFolderEntity;
  7. use Shopware\Core\Content\Media\File\FileSaver;
  8. use Shopware\Core\Content\Media\File\MediaFile;
  9. use Shopware\Core\Content\Media\MediaEvents;
  10. use Shopware\Core\Content\Media\MediaService;
  11. use Shopware\Core\Framework\Context;
  12. use Shopware\Core\Framework\DataAbstractionLayer\EntityDefinition;
  13. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityWrittenEvent;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  17. use Shopware\Core\Framework\Log\Package;
  18. use Shopware\Core\Framework\Uuid\Uuid;
  19. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  20. use Symfony\Component\HttpFoundation\Request;
  21. use Symfony\Contracts\Service\ResetInterface;
  22. /**
  23.  * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  24.  */
  25. #[Package('core')]
  26. class MediaSerializer extends EntitySerializer implements EventSubscriberInterfaceResetInterface
  27. {
  28.     private FileSaver $fileSaver;
  29.     private MediaService $mediaService;
  30.     private EntityRepositoryInterface $mediaFolderRepository;
  31.     private EntityRepositoryInterface $mediaRepository;
  32.     /**
  33.      * @var array<string, array{media: MediaFile, destination: string}>
  34.      */
  35.     private array $cacheMediaFiles = [];
  36.     /**
  37.      * @internal
  38.      */
  39.     public function __construct(
  40.         MediaService $mediaService,
  41.         FileSaver $fileSaver,
  42.         EntityRepositoryInterface $mediaFolderRepository,
  43.         EntityRepositoryInterface $mediaRepository
  44.     ) {
  45.         $this->mediaService $mediaService;
  46.         $this->fileSaver $fileSaver;
  47.         $this->mediaFolderRepository $mediaFolderRepository;
  48.         $this->mediaRepository $mediaRepository;
  49.     }
  50.     /**
  51.      * @param array<mixed>|\Traversable<mixed> $entity
  52.      *
  53.      * @return array<mixed>|\Traversable<mixed>
  54.      */
  55.     public function deserialize(Config $configEntityDefinition $definition$entity)
  56.     {
  57.         $entity = \is_array($entity) ? $entity iterator_to_array($entity);
  58.         $deserialized parent::deserialize($config$definition$entity);
  59.         $deserialized = \is_array($deserialized) ? $deserialized iterator_to_array($deserialized);
  60.         $url $entity['url'] ?? null;
  61.         if (empty($url)) {
  62.             return $deserialized;
  63.         }
  64.         if (!filter_var($url, \FILTER_VALIDATE_URL)) {
  65.             $deserialized['_error'] = new InvalidMediaUrlException($url);
  66.             return $deserialized;
  67.         }
  68.         $media null;
  69.         if (isset($deserialized['id'])) {
  70.             $media $this->mediaRepository->search(new Criteria([$deserialized['id']]), Context::createDefaultContext())->first();
  71.         }
  72.         $isNew $media === null;
  73.         if ($isNew || $media->getUrl() !== $url) {
  74.             $entityName $config->get('sourceEntity') ?? $definition->getEntityName();
  75.             $deserialized['mediaFolderId'] = $deserialized['mediaFolderId']
  76.                 ?? $this->getMediaFolderId($deserialized['id'] ?? null$entityName);
  77.             $deserialized['id'] = $deserialized['id'] ?? Uuid::randomHex();
  78.             $parsed parse_url($url);
  79.             if (!$parsed) {
  80.                 throw new \RuntimeException('Error parsing media URL: ' $url);
  81.             }
  82.             $pathInfo pathinfo($parsed['path'] ?? '');
  83.             $media $this->fetchFileFromURL((string) $url$pathInfo['extension'] ?? '');
  84.             if ($media === null) {
  85.                 $deserialized['_error'] = new MediaDownloadException($url);
  86.                 return $deserialized;
  87.             }
  88.             if ($isNew && $media->getHash()) {
  89.                 $deserialized $this->fetchExistingMediaByHash($deserialized$media->getHash());
  90.             }
  91.             $this->cacheMediaFiles[(string) $deserialized['id']] = [
  92.                 'media' => $media,
  93.                 'destination' => $pathInfo['filename'],
  94.             ];
  95.         }
  96.         return $deserialized;
  97.     }
  98.     public function supports(string $entity): bool
  99.     {
  100.         return $entity === 'media';
  101.     }
  102.     /**
  103.      * @return array<string, string|array{0: string, 1: int}|list<array{0: string, 1?: int}>>
  104.      */
  105.     public static function getSubscribedEvents()
  106.     {
  107.         return [
  108.             MediaEvents::MEDIA_WRITTEN_EVENT => 'persistMedia',
  109.         ];
  110.     }
  111.     /**
  112.      * @internal
  113.      */
  114.     public function persistMedia(EntityWrittenEvent $event): void
  115.     {
  116.         if (empty($this->cacheMediaFiles)) {
  117.             return;
  118.         }
  119.         $mediaFiles $this->cacheMediaFiles;
  120.         // prevent recursion
  121.         $this->cacheMediaFiles = [];
  122.         foreach ($event->getIds() as $id) {
  123.             if (!isset($mediaFiles[$id])) {
  124.                 continue;
  125.             }
  126.             $mediaFile $mediaFiles[$id];
  127.             $this->fileSaver->persistFileToMedia(
  128.                 $mediaFile['media'],
  129.                 $mediaFile['destination'],
  130.                 $id,
  131.                 $event->getContext()
  132.             );
  133.         }
  134.     }
  135.     public function reset(): void
  136.     {
  137.         $this->cacheMediaFiles = [];
  138.     }
  139.     private function getMediaFolderId(?string $idstring $entity): string
  140.     {
  141.         if ($id !== null) {
  142.             /** @var MediaFolderEntity|null $folder */
  143.             $folder $this->mediaFolderRepository->search(new Criteria([$id]), Context::createDefaultContext())->first();
  144.             if ($folder !== null) {
  145.                 return $folder->getId();
  146.             }
  147.         }
  148.         $criteria = new Criteria();
  149.         $criteria->addFilter(new EqualsFilter('media_folder.defaultFolder.entity'$entity));
  150.         $criteria->addAssociation('defaultFolder');
  151.         /** @var MediaFolderEntity|null $default */
  152.         $default $this->mediaFolderRepository->search($criteriaContext::createDefaultContext())->first();
  153.         if ($default !== null) {
  154.             return $default->getId();
  155.         }
  156.         $criteria = new Criteria();
  157.         $criteria->addFilter(new EqualsFilter('media_folder.defaultFolder.entity''import_export_profile'));
  158.         $criteria->addAssociation('defaultFolder');
  159.         /** @var MediaFolderEntity|null $fallback */
  160.         $fallback $this->mediaFolderRepository->search($criteriaContext::createDefaultContext())->first();
  161.         if ($fallback === null) {
  162.             throw new \RuntimeException('Failed to find default media folder for import_export_profile');
  163.         }
  164.         return $fallback->getId();
  165.     }
  166.     private function fetchFileFromURL(string $urlstring $extension): ?MediaFile
  167.     {
  168.         $request = new Request();
  169.         $request->query->set('url'$url);
  170.         $request->query->set('extension'$extension);
  171.         $request->request->set('url'$url);
  172.         $request->request->set('extension'$extension);
  173.         $request->headers->set('content-type''application/json');
  174.         try {
  175.             $file $this->mediaService->fetchFile($request);
  176.             if ($file !== null && $file->getFileSize() > 0) {
  177.                 return $file;
  178.             }
  179.         } catch (\Throwable $throwable) {
  180.         }
  181.         return null;
  182.     }
  183.     /**
  184.      * @param array<string, mixed> $deserialized
  185.      *
  186.      * @return array<string, mixed>
  187.      */
  188.     private function fetchExistingMediaByHash(array $deserializedstring $hash): array
  189.     {
  190.         $criteria = new Criteria();
  191.         $criteria->addFilter(new EqualsFilter('metaData.hash'$hash));
  192.         $media $this->mediaRepository->search($criteriaContext::createDefaultContext())->first();
  193.         if ($media) {
  194.             $deserialized['id'] = $media->getId();
  195.         }
  196.         return $deserialized;
  197.     }
  198. }