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

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