custom/plugins/P2LabProductVideo/src/Subscriber/MediaSubscriber.php line 363

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace P2Lab\ProductVideo\Subscriber;
  5. use Monolog\Logger;
  6. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityWrittenEvent;
  7. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityDeletedEvent;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Search\Aggregation\Metric\CountAggregation;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  10. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  11. use Shopware\Core\Content\Media\MediaEvents;
  12. use Shopware\Core\Content\Product\ProductEvents;
  13. use Doctrine\DBAL\Connection;
  14. use Doctrine\DBAL\Query\QueryBuilder;
  15. use P2Lab\ProductVideo\Helper\EmbedVideoHelper;
  16. use Shopware\Core\Content\Media\File\FileFetcher;
  17. use Shopware\Core\Content\Media\File\FileSaver;
  18. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  19. use Shopware\Core\Content\Product\ProductCollection;
  20. use Shopware\Core\Content\Product\ProductEntity;
  21. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  22. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
  23. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  24. use Shopware\Core\System\SystemConfig\SystemConfigService;
  25. use Symfony\Component\HttpKernel\KernelEvents;
  26. use Symfony\Component\HttpFoundation\Request;
  27. use Symfony\Component\HttpKernel\Event\RequestEvent;
  28. use Shopware\Core\Framework\DataAbstractionLayer\Search\AggregationResult\Metric\CountResult;
  29. use Psr\Log\LoggerInterface;
  30. use Shopware\Core\Content\Product\Aggregate\ProductMedia\ProductMediaEntity;
  31. use Shopware\Core\Framework\Uuid\Uuid;
  33. class MediaSubscriber implements EventSubscriberInterface
  34. {
  36.     private Connection $connection;
  38.     private EntityRepositoryInterface $productRepository;
  40.     /** @var EntityRepositoryInterface */
  41.     private $mediaRepository;
  43.     /** @var EntityRepositoryInterface */
  44.     private EntityRepositoryInterface $productMediaRepository;
  46.     /** @var FileFetcher */
  47.     private FileFetcher $fileFetcher;
  49.     /** @var FileSaver */
  50.     private FileSaver $fileSaver;
  52.     /** @var EventDispatcherInterface */
  53.     private EventDispatcherInterface $eventDispatcher;
  55.     /** @var SystemConfigService */
  56.     private SystemConfigService $systemConfigService;
  58.     /** @var LoggerInterface */
  59.     private $logger;
  61.     /** @var bool */
  62.     private bool $isBulkApiEnabled = false;
  64.     /** @var array */
  65.     private static $productPayloads = [];
  67.     /** @var bool */
  68.     private static bool $isActiveEventOnProductWritten = true;
  70.     private array $logStats = [
  71.         'detected' => [],
  72.         'found' => [],
  73.         'skipped' => [],
  74.         'added' => [],
  75.         'notRecognized' => 0,
  76.         'ambiguous' => 0,
  77.     ];
  79.     /**
  80.      * @internal
  81.      */
  82.     public function __construct(
  83.         Connection $connection,
  84.         EntityRepositoryInterface $productRepository,
  85.         $mediaRepository,
  86.         EntityRepositoryInterface $productMediaRepository,
  87.         FileFetcher $fileFetcher,
  88.         FileSaver $fileSaver,
  89.         EventDispatcherInterface $eventDispatcher,
  90.         SystemConfigService $systemConfigService,
  91.         LoggerInterface $logger
  92.     )
  93.     {
  94.         $this->connection = $connection;
  95.         $this->productRepository = $productRepository;
  96.         $this->mediaRepository = $mediaRepository;
  97.         $this->productMediaRepository = $productMediaRepository;
  98.         $this->fileFetcher = $fileFetcher;
  99.         $this->fileSaver = $fileSaver;
  100.         $this->eventDispatcher = $eventDispatcher;
  101.         $this->systemConfigService = $systemConfigService;
  102.         $this->logger = $logger;
  104.         $this->isBulkApiEnabled = (bool) $this->systemConfigService->get('P2LabProductVideo.config.bulkApiEnabled');
  105.     }
  107.     /**
  108.      * @return array
  109.      */
  110.     public static function getSubscribedEvents(): array
  111.     {
  112.         return [
  113.             KernelEvents::REQUEST => 'onKernelRequest',
  114.             MediaEvents::MEDIA_DELETED_EVENT => 'onMediaDeleted',
  115.             ProductEvents::PRODUCT_WRITTEN_EVENT => 'onProductWritten',
  116.         ];
  117.     }
  118.     
  119.     /**
  120.      * @param array<mixed> $array
  121.      */
  122.     private function isCollection(array $array): bool
  123.     {
  124.         return array_keys($array) === range(0, \count($array) - 1);
  125.     }
  127.     /**
  128.      * @param RequestEvent $event
  129.      */
  130.     public function onKernelRequest(RequestEvent $event): void
  131.     {
  132.         if (! $this->isBulkApiEnabled) return;
  134.         /** @var Request $request */
  135.         $request = $event->getRequest();
  137.         if ($request->getPathInfo() !== '/api/_action/sync' || ! $request->isMethod('POST')) return;
  139.         /** @var array $operation */
  140.         foreach ($request->request->all() as $operation) {
  141.             if (
  142.                 is_array($operation)
  143.                     &&
  144.                 isset($operation['action'])
  145.                     &&
  146.                 $operation['action'] === 'upsert'
  147.                     &&
  148.                 isset($operation['entity'])
  149.                     &&
  150.                 $operation['entity'] === 'product'
  151.                     &&
  152.                 isset($operation['payload'])
  153.                     &&
  154.                 is_array($operation['payload'])
  155.             ) {
  156.                 /** @var array $payload */
  157.                 foreach ($operation['payload'] as $payload) {
  158.                     if ( 
  159.                         is_array($payload) 
  160.                             &&
  161.                         isset($payload['p2labProductVideo'])
  162.                             &&
  163.                         is_array($payload['p2labProductVideo'])
  164.                     ) {
  165.                         /** @var array $p2labProductVideo */
  166.                         $p2labProductVideo = [];
  168.                         if ($this->isCollection($payload['p2labProductVideo'])) {
  169.                             $p2labProductVideo = $payload['p2labProductVideo'];
  170.                         } else {
  171.                             $p2labProductVideo[] = $payload['p2labProductVideo'];
  172.                         }
  173.                         
  174.                         $p2labProductVideo = array_filter($p2labProductVideo, function($video){
  175.                             return is_array($video) && isset($video['url']);
  176.                         });
  178.                         if ($p2labProductVideo) {
  179.                             /** @var array $productPayload */
  180.                             $productPayload = [
  181.                                 'uuid' => Uuid::randomHex(),
  182.                                 'productData' => [],
  183.                                 'videoData' => [
  184.                                     'p2labProductVideo' => $p2labProductVideo,
  185.                                 ],
  186.                             ];
  188.                             if (isset($payload['id'])) {
  189.                                 $productPayload['videoData']['id'] = $payload['id'];
  190.                             }
  192.                             if (!empty($payload['productNumber'])) {
  193.                                 $productPayload['productData']['productNumber'] = md5($payload['productNumber']);
  194.                             }
  196.                             if (!empty($payload['name'])) {
  197.                                 $productPayload['productData']['name'] = md5($payload['name']);
  198.                             }
  199.                             
  200.                             $this->addLogStats('detected', $productPayload['uuid'], count($p2labProductVideo));
  202.                             self::$productPayloads[] = $productPayload;
  203.                         }
  204.                     }
  205.                 }
  206.             }
  207.         }
  208.     }
  210.     private function findProductPayloadByData(array $productData, bool $notUsed = true): array
  211.     {
  212.         /** @var array $foundKeys */
  213.         $foundKeys = [];
  215.         /** @var array $payload */
  216.         foreach (self::$productPayloads as $key => $payload) {
  217.             if (!isset($payload['productData'])) continue;
  218.             if ($notUsed && !empty($payload['used'])) continue;
  220.             /** @var int $theSame */
  221.             $theSame = 0;
  223.             foreach ($payload['productData'] as $dataKey => $dataValue) {
  224.                 if (
  225.                     isset($productData[$dataKey])
  226.                         &&
  227.                     $productData[$dataKey] === $dataValue
  228.                 ) {
  229.                     $theSame++;
  230.                 }
  231.             }
  233.             if ($theSame > 0 && $theSame === count($productData)) {
  234.                 $foundKeys[] = $key;
  235.             }
  236.         }
  238.         return $foundKeys;
  239.     }
  241.     /**
  242.      * @param ProductEntity $product
  243.      * @return array
  244.      */
  245.     private function findProductPayloadUuids($product): array {
  246.         /** @var array $productPayloadKeys */
  247.         if (null === ($productPayloadKeys = $this->findProductPayloadKeys($product, false))) {
  248.             return [];
  249.         }
  251.         /** @var array $uuids */
  252.         $uuids = [];
  254.         /** @var int $key */
  255.         foreach ($productPayloadKeys as $key) {
  256.             $uuids[] = self::$productPayloads[$key]['uuid'];
  257.         }
  259.         return $uuids;
  260.     }
  262.     /**
  263.      * @param ProductEntity $product
  264.      * @return int|null
  265.      */
  266.     private function findProductPayloadKey($product, bool $notUsed = true): ?int {
  267.         /** @var array $foundKeys */
  268.         $foundKeys = $this->findProductPayloadKeys($product, $notUsed);
  270.         if (!$foundKeys) return null;
  272.         if (count($foundKeys) > 1) {
  273.             $this->logStats['ambiguous']++;
  275.             return null;
  276.         }
  278.         return $foundKeys[0];
  279.     }
  281.     /**
  282.      * @param ProductEntity $product
  283.      * @return array
  284.      */
  285.     private function findProductPayloadKeys($product, bool $notUsed = true): array {
  286.         /** @var array $foundKeys */
  287.         $foundKeys = [];
  289.         /** @var array $payload */
  290.         foreach (self::$productPayloads as $key => $payload) {
  291.             if (
  292.                 isset($payload['videoData']['id'])
  293.                     &&
  294.                 $payload['videoData']['id'] === $product->getId()
  295.             ) {
  296.                 if ($notUsed && !empty($payload['used'])) continue;
  298.                 $foundKeys[] = $key;
  299.             }
  300.         }
  302.         if (!$foundKeys) {
  303.             $foundKeys = $this->findProductPayloadByData([
  304.                 'productNumber' => md5($product->getProductNumber()),
  305.             ], $notUsed);
  307.             if (!$foundKeys || count($foundKeys) > 1) {
  308.                 $foundKeys = $this->findProductPayloadByData([
  309.                     'productNumber' => md5($product->getProductNumber()),
  310.                     'name' => md5($product->getName()),
  311.                 ], $notUsed);
  312.             }
  313.         }
  314.         
  315.         return $foundKeys;
  316.     }
  318.     /**
  319.      * @param array $productIds
  320.      * @return array
  321.      */
  322.     private function getProductsMediaUrls(array $productIds): array
  323.     {
  324.         if (! $productIds) return [];
  326.         /** @var QueryBuilder $query */
  327.         $query = new QueryBuilder($this->connection);
  328.         
  329.         $query
  330.             ->select('product_media.*')
  331.             ->from('product_media')
  332.             ->where('product_media.product_id IN (:productIds)')
  333.             ->andWhere("JSON_EXTRACT(`product_media`.`custom_fields`, '$.\"p2labProductVideo\"') IS NOT NULL")
  334.             ->setParameter('productIds', array_map(function($id){
  335.                 return hex2bin($id);
  336.             }, $productIds), Connection::PARAM_STR_ARRAY);
  338.         /** @var array $productMediaUrls */
  339.         $productMediaUrls = [];
  341.         /** @var array $rows */
  342.         $rows = $query->execute()->fetchAllAssociative();
  344.         /** @var array $row */
  345.         foreach ($rows as $row) {
  346.             /** @var array $customFields */
  347.             $customFields = json_decode( $row['custom_fields'], true );
  349.             /** @var array $p2labProductVideo */
  350.             $p2labProductVideo = $customFields['p2labProductVideo'];
  352.             if (! empty($p2labProductVideo['url'])) {
  353.                 $productMediaUrls[bin2hex($row['product_id'])][] = $p2labProductVideo['url'];
  354.             }
  355.         }
  357.         return $productMediaUrls;
  358.     }
  360.     /**
  361.      * @param EntityWrittenEvent $event
  362.      */
  363.     public function onProductWritten(EntityWrittenEvent $event): void
  364.     {
  365.         if (! $this->isBulkApiEnabled) return;
  366.         
  367.         /** @var array $productIds */
  368.         if (null == ($productIds = $event->getIds())) return;
  369.         
  370.         if (! self::$isActiveEventOnProductWritten) return;
  372.         self::$isActiveEventOnProductWritten = false;
  373.         
  374.         /** @var ProductCollection $products */
  375.         $products = $this->productRepository->search(new Criteria($productIds), $event->getContext())->getEntities();
  377.         /** @var array $productsMediaUrls */
  378.         $productsMediaUrls = $this->getProductsMediaUrls($productIds);
  380.         /** @var ProductEntity $product */
  381.         foreach ($products as $product) {
  382.             /** @var array $payloadKeys */
  383.             if (null != ($payloadKeys = $this->findProductPayloadKeys($product))) {
  384.                 /** @var array $p2labProductVideos */
  385.                 $p2labProductVideos = [];
  387.                 /** @var array $uuids */
  388.                 $uuids = [];
  390.                 /** @var int $payloadKey */
  391.                 foreach ($payloadKeys as $payloadKey) {
  392.                     /** @var array $payload */
  393.                     $payload = & self::$productPayloads[$payloadKey];
  395.                     if (!empty($payload['used'])) continue;
  397.                     /** @var string $uuid */
  398.                     $uuid = $payload['uuid'];
  400.                     $p2labProductVideos[$uuid] = $payload['videoData']['p2labProductVideo'];
  402.                     $payload['used'] = true;
  404.                     $uuids[] = $uuid;
  406.                     $this->addLogStats('found', $uuid, count($payload['videoData']['p2labProductVideo']));
  407.                 }
  409.                 /** @var array $video */
  410.                 foreach ($p2labProductVideos as $uuid => $videos) {
  411.                     /** @var array $video */
  412.                     foreach ($videos as $video) {
  413.                         if (empty($video['autoThumbnail'])) {
  414.                             if (empty($video['mediaId'])) {
  415.                                 $this->logger->error(sprintf(
  416.                                     "The product with ID '%s' has no 'p2labProductVideo.mediaId' or 'p2labProductVideo.autoThumbnail'.", $product->getId())
  417.                                 );
  419.                                 $this->addLogStats('skipped', $uuid);
  421.                                 continue;
  422.                             }
  423.                         }
  425.                         if (empty($video['url'])) {
  426.                             $this->logger->error(sprintf(
  427.                                 "The product with ID '%s' has no 'p2labProductVideo.url'.", $product->getId())
  428.                             );
  430.                             $this->addLogStats('skipped', $uuid);
  432.                             continue;
  433.                         }
  434.                             
  435.                         if (!EmbedVideoHelper::recognizeEmbedVideoType($video['url'])) {
  436.                             $this->logger->error(sprintf(
  437.                                 "The video source for the product with ID '%s' of '%s' is not recognized.", $product->getId(), $video['url'])
  438.                             );
  440.                             $this->addLogStats('skipped', $uuid);
  441.                             
  442.                             continue;
  443.                         }
  445.                         if (isset($productsMediaUrls[$product->getId()])) {
  446.                             /** @var string $url */
  447.                             $url = EmbedVideoHelper::normalizeEmbedVideoUrl($video['url']);
  449.                             if (in_array($url, $productsMediaUrls[$product->getId()])) {
  450.                                 $this->logger->debug(sprintf(
  451.                                     'The video source "%s" already exists in the product with ID "%s" and has been skipped.', 
  452.                                     $url, 
  453.                                     $product->getId()
  454.                                 ));
  456.                                 $this->addLogStats('skipped', $uuid);
  458.                                 continue;
  459.                             }
  460.                         }
  462.                         /** @var array $data */
  463.                         $data = EmbedVideoHelper::upload(
  464.                             $this->mediaRepository,
  465.                             $this->fileFetcher,
  466.                             $this->fileSaver,
  467.                             $this->eventDispatcher,
  468.                             [
  469.                                 'productId' => $product->getId(),
  470.                                 'mediaId' => empty($video['mediaId']) ? null : $video['mediaId'],
  471.                                 'customFields' => [
  472.                                     'p2labProductVideo' => [
  473.                                         'url' => $video['url'],
  474.                                     ],
  475.                                 ],                    
  476.                             ], 
  477.                             $event->getContext(),
  478.                             null,
  479.                             $this->logger
  480.                         );
  481.                         
  482.                         if (empty($data['mediaId'])) {
  483.                             $this->addLogStats('skipped', $uuid);
  485.                             continue;
  486.                         }
  488.                         /** @var Criteria $criteria */
  489.                         $criteria = new Criteria();
  490.                         $criteria->addFilter(new EqualsFilter('productId', $product->getId()));
  491.                         $criteria->addAggregation(new CountAggregation('product-media-count', 'id'));
  493.                         /** @var CountResult $productMediaCount */
  494.                         $productMediaCount = $this->productMediaRepository->search($criteria, $event->getContext())
  495.                             ->getAggregations()->get('product-media-count');
  497.                         $data['position'] = $productMediaCount->getCount();
  499.                         $this->productMediaRepository->create([
  500.                             $data
  501.                         ], $event->getContext());
  503.                         $this->addLogStats('added', $uuid);
  505.                         // Set coverId if added media is the first one
  506.                         if (! $data['position']) {
  507.                             /** @var Criteria $criteria */
  508.                             $criteria = new Criteria();
  509.                             $criteria->addFilter(new EqualsFilter('productId', $product->getId()));
  510.                             $criteria->setLimit(1);
  512.                             /** @var ProductMediaEntity $productMedia */
  513.                             if (null != ($productMedia = $this->productMediaRepository->search($criteria, $event->getContext())->first())) {
  514.                                 $this->productRepository->update([
  515.                                     [
  516.                                         'id' => $product->getId(),
  517.                                         'coverId' => $productMedia->getId(),
  518.                                     ]
  519.                                 ], $event->getContext());
  520.                             }
  521.                         }
  522.                     }
  523.                 }
  524.             } else {
  525.                 $this->logStats['notRecognized']++;
  526.             }
  527.         }
  529.         if ($this->systemConfigService->get('P2LabProductVideo.config.apiDebugMode')) {
  530.             /** @var ProductEntity $product */
  531.             foreach ($products as $product) {
  532.                 /** @var array $uuids */
  533.                 $uuids = $this->findProductPayloadUuids($product);
  535.                 if (! $uuids) continue;
  537.                 /** @var int $detected */
  538.                 $detected = 0;
  540.                 /** @var int $found */
  541.                 $found = 0;
  543.                 /** @var int $added */
  544.                 $added = 0;
  546.                 /** @var int $skipped */
  547.                 $skipped = 0;
  549.                 /** @var string $uuid */
  550.                 foreach ($uuids as $uuid) {
  551.                     $detected += $this->logStats['detected'][$uuid] ?? 0;
  552.                     $found += $this->logStats['found'][$uuid] ?? 0;
  553.                     $added += $this->logStats['added'][$uuid] ?? 0;
  554.                     $skipped += $this->logStats['skipped'][$uuid] ?? 0;
  555.                 }
  557.                 $this->logger->debug(sprintf(
  558.                     'In the product with ID "%s" has %d video(s) detected, %d video(s) found, %d video(s) added and %d video(s) skipped.', 
  559.                     $product->getId(), 
  560.                     $detected,
  561.                     $found,
  562.                     $added,
  563.                     $skipped
  564.                 ));
  565.             }
  567.             if ($this->logStats['notRecognized']) {
  568.                 $this->logger->debug(sprintf(
  569.                     'There are not recognized %d video(s) without product ID.',
  570.                     $this->logStats['notRecognized']
  571.                 ));
  572.             }
  574.             if ($this->logStats['ambiguous']) {
  575.                 $this->logger->debug(sprintf(
  576.                     'There are found %d ambiguous product(s) with the same product number or name. The video(s) will not be added.',
  577.                     $this->logStats['ambiguous']
  578.                 ));
  579.             }
  580.         }
  582.         self::$isActiveEventOnProductWritten = true;
  583.     }
  585.     private function addLogStats($type, $uuid, $count = 1) {
  586.         if (!isset($this->logStats[$type][$uuid])) {
  587.             $this->logStats[$type][$uuid] = 0;
  588.         }
  590.         $this->logStats[$type][$uuid] += $count;
  591.     }
  593.     /**
  594.      * @param array $mediaIds
  595.      */
  596.     public function deleteRelatedMedia(array $mediaIds): void
  597.     {
  598.         $this->connection->executeStatement('
  599.             DELETE FROM 
  600.                 `product_media`
  601.             WHERE 
  602.                 JSON_EXTRACT(`custom_fields`, "$.p2labProductVideo.mediaId") IN (:mediaIds)
  603.             ',
  604.             ['mediaIds' => $mediaIds],
  605.             ['mediaIds' => Connection::PARAM_STR_ARRAY]
  606.         );
  607.     }
  609.     /**
  610.      * @param array $mediaIds
  611.      */
  612.     public function deleteRelatedTranslations(array $mediaIds): void
  613.     {
  614.         /** @var array $conditions */
  615.         $conditions = array_map(function($mediaId){
  616.             return "JSON_SEARCH(`custom_fields`, 'one', " . $this->connection->quote($mediaId) . ", NULL, \"$.p2labProductVideo.translation.*\") IS NOT NULL";
  617.         }, $mediaIds);
  619.         /** @var string $sql */
  620.         $sql = sprintf('
  621.             SELECT 
  622.                 *
  623.             FROM
  624.                 `product_media`
  625.             WHERE 
  626.                 %s
  627.         ', implode(' OR ', $conditions));
  629.         /** @var array $rows */
  630.         $rows = $this->connection->fetchAllAssociative($sql);
  632.         /** @var array $row */
  633.         foreach ($rows as $row) {
  634.             /** @var array $customFields */
  635.             $customFields = json_decode( $row['custom_fields'], true );
  637.             $customFields['p2labProductVideo']['translation'] = array_filter($customFields['p2labProductVideo']['translation'], function($mediaId) use($mediaIds){
  638.                 return ! in_array($mediaId, $mediaIds);
  639.             });
  641.             $this->connection->update('product_media', [
  642.                 'custom_fields' => json_encode($customFields),
  643.             ], [
  644.                 'id' => $row['id'],
  645.             ]);
  646.         }
  647.     }
  649.     /**
  650.      * @param EntityDeletedEvent $event
  651.      * @return bool
  652.      */
  653.     public function onMediaDeleted(EntityDeletedEvent $event): bool
  654.     {
  655.         /** @var array $mediaIds */
  656.         $mediaIds = $event->getIds();
  658.         $this->deleteRelatedMedia($mediaIds);
  659.         $this->deleteRelatedTranslations($mediaIds);
  661.         return true;
  662.     }
  663. }