Skip to content

magento/magento2#33031: Add product images import mode for CSV gallery replace #41088

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
swnsma wants to merge 4 commits into
base: 2.4-develop
Choose a base branch
from
+3,322 −26
Open

magento/magento2#33031: Add product images import mode for CSV gallery replace #41088

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
00f2797
magento/magento2#33031: Add product images import mode for CSV galler…
swnsma Aug 5, 2026
5f24e0d
magento/magento2#33031: Extract media gallery replace coordinator
swnsma Aug 6, 2026
49d1d85
magento/magento2#33031: Add optional unused image file deletion for r…
swnsma Aug 7, 2026
ef4f6e9
magento/magento2#33031: Harden media gallery cleanup path handling
swnsma Aug 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 24 additions & 9 deletions app/code/Magento/CatalogGraphQl/Observer/AfterImportDataObserver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
use Magento\GraphQlResolverCache\Model\Resolver\Result\Type as GraphQlResolverCache;

/**
* Clean media gallery resolver cache for product SKUs after importing data to database
* Clean media gallery resolver cache after product import
*/
class AfterImportDataObserver implements ObserverInterface
{
Expand Down Expand Up @@ -58,10 +58,12 @@ public function execute(Observer $observer)
$mediaGalleryEntriesChanged = (array) $observer->getEvent()->getMediaGallery();
$mediaGalleryLabelsChanged = (array) $observer->getEvent()->getMediaGalleryLabels();
$productIdsToDelete = (array) $observer->getEvent()->getIdsToDelete();
$mediaGalleryRemovedSkus = (array) $observer->getEvent()->getMediaGalleryRemovedSkus();

if (empty($mediaGalleryEntriesChanged) &&
empty($mediaGalleryLabelsChanged) &&
empty($productIdsToDelete)
empty($productIdsToDelete) &&
empty($mediaGalleryRemovedSkus)
) {
return;
}
Expand All @@ -76,16 +78,29 @@ public function execute(Observer $observer)
$productSkusToInvalidate[] = [$label['imageData']['sku']];
}

$productSkusToInvalidate = array_unique(array_merge(...$productSkusToInvalidate));
$products = $this->productRepository->getList(
$this->criteriaBuilder->addFilter('sku', $productSkusToInvalidate, 'in')->create()
)->getItems();
if (!empty($mediaGalleryRemovedSkus)) {
$productSkusToInvalidate[] = array_values($mediaGalleryRemovedSkus);
}

$productSkusToInvalidate = $productSkusToInvalidate
? array_unique(array_merge(...$productSkusToInvalidate))
: [];

$productIds = [];
if (!empty($productSkusToInvalidate)) {
$products = $this->productRepository->getList(
$this->criteriaBuilder->addFilter('sku', $productSkusToInvalidate, 'in')->create()
)->getItems();

$productIds = array_map(function ($product) {
return $product->getId();
}, $products);
$productIds = array_map(function ($product) {
return (int) $product->getId();
}, $products);
}

$productIdsToInvalidate = array_unique(array_merge($productIds, $productIdsToDelete));
if (empty($productIdsToInvalidate)) {
return;
}

$tags = array_map(function ($productId) {
return sprintf('%s_%s', ResolverCacheIdentity::CACHE_TAG, $productId);
Expand Down
164 changes: 163 additions & 1 deletion app/code/Magento/CatalogImportExport/Model/Import/Product.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
use Magento\CatalogImportExport\Model\Import\Product\ImageTypeProcessor;
use Magento\CatalogImportExport\Model\Import\Product\LinkProcessor;
use Magento\CatalogImportExport\Model\Import\Product\MediaGalleryProcessor;
use Magento\CatalogImportExport\Model\Import\Product\MediaGalleryReplaceCoordinator;
use Magento\CatalogImportExport\Model\Import\Product\RowValidatorInterface as ValidatorInterface;
use Magento\CatalogImportExport\Model\Import\Product\Skip;
use Magento\CatalogImportExport\Model\Import\Product\SkuStorage;
Expand Down Expand Up @@ -764,6 +765,11 @@ class Product extends AbstractEntity
*/
private $productRepository;

/**
* @var MediaGalleryReplaceCoordinator
*/
private $mediaGalleryReplace;

/**
* @var StatusProcessor
*/
Expand Down Expand Up @@ -850,6 +856,7 @@ class Product extends AbstractEntity
* @param StockItemProcessorInterface|null $stockItemProcessor
* @param SkuStorage|null $skuStorage
* @param DomainValidator|null $domainValidator
* @param MediaGalleryReplaceCoordinator|null $mediaGalleryReplace
* @throws LocalizedException
* @throws \Magento\Framework\Exception\FileSystemException
* @SuppressWarnings(PHPMD.ExcessiveParameterList)
Expand Down Expand Up @@ -907,7 +914,8 @@ public function __construct(
?File $fileDriver = null,
?StockItemProcessorInterface $stockItemProcessor = null,
?SkuStorage $skuStorage = null,
?DomainValidator $domainValidator = null
?DomainValidator $domainValidator = null,
?MediaGalleryReplaceCoordinator $mediaGalleryReplace = null
) {
$this->_eventManager = $eventManager;
$this->stockRegistry = $stockRegistry;
Expand Down Expand Up @@ -941,6 +949,8 @@ public function __construct(
$this->catalogConfig = $catalogConfig ?: ObjectManager::getInstance()->get(CatalogConfig::class);
$this->imageTypeProcessor = $imageTypeProcessor ?: ObjectManager::getInstance()->get(ImageTypeProcessor::class);
$this->mediaProcessor = $mediaProcessor ?: ObjectManager::getInstance()->get(MediaGalleryProcessor::class);
$this->mediaGalleryReplace = $mediaGalleryReplace
?: ObjectManager::getInstance()->get(MediaGalleryReplaceCoordinator::class);
$this->stockItemImporter = $stockItemImporter ?: ObjectManager::getInstance()
->get(StockItemImporterInterface::class);
$this->statusProcessor = $statusProcessor ?: ObjectManager::getInstance()
Expand Down Expand Up @@ -1677,6 +1687,10 @@ protected function _saveProducts()
$previousType = null;
$prevAttributeSet = null;
$productMediaPath = $this->getProductMediaPath();
$this->mediaGalleryReplace->configure(
$this->isImageReplaceMode(),
$this->getMediaImageRoleAttributeCodes()
);
while ($bunch = $this->_dataSourceModel->getNextUniqueBunch($this->getIds())) {
$entityRowsIn = [];
$entityRowsUp = [];
Expand All @@ -1688,6 +1702,10 @@ protected function _saveProducts()
$imagesForChangeVisibility = [];
$uploadedImages = [];
$existingImages = $this->getExistingImages($bunch);
$this->mediaGalleryReplace->planRoleAssignments(
$this->extractImageRoleAssignmentsFromBunch($bunch)
);
$this->mediaGalleryReplace->warmRolesCache(array_column($bunch, self::COL_SKU));
$attributes = [];
foreach ($bunch as $rowNum => $rowData) {
try {
Expand Down Expand Up @@ -1776,11 +1794,68 @@ protected function _saveProducts()
'bunch' => $bunch,
'media_gallery' => $mediaGallery,
'media_gallery_labels' => $labelsForUpdate,
'media_gallery_removed_skus' => [],
]
);
}
$this->applyDeferredMediaGalleryReplaceRemovals();
return $this;
}

/**
* Apply deferred replace-mode gallery unlinks.
*
* @return void
*/
private function applyDeferredMediaGalleryReplaceRemovals(): void
{
if (!$this->mediaGalleryReplace->hasRegisteredProducts()) {
return;
}
$existingImages = $this->getExistingImages(
array_map(
static function (string $sku): array {
return [self::COL_SKU => $sku];
},
$this->mediaGalleryReplace->getRegisteredSkus()
)
);
foreach ($this->mediaGalleryReplace->getSkusWithSkippedRemovals() as $sku) {
$this->addRowError(
'productImageReplaceSkippedDueToUploadFailure',
null,
null,
(string)__(
'Gallery replace was skipped for SKU "%1" because one or more images could not be loaded. '
. 'Existing images were kept. Fix the files and import again.',
$sku
),
ProcessingError::ERROR_LEVEL_NOT_CRITICAL
);
}
[$imagesToRemove, $mediaGalleryRemovedSkus] = $this->mediaGalleryReplace->collectRemovals(
$existingImages
);
if ($imagesToRemove) {
$this->mediaProcessor->removeProductImages(
$imagesToRemove,
$this->shouldDeleteUnusedImageFiles()
);
}
if ($mediaGalleryRemovedSkus === []) {
return;
}
$this->_eventManager->dispatch(
'catalog_product_import_bunch_save_after',
[
'adapter' => $this,
'bunch' => [],
'media_gallery' => [],
'media_gallery_labels' => [],
'media_gallery_removed_skus' => $mediaGalleryRemovedSkus,
]
);
}
//phpcs:enable Generic.Metrics.NestingLevel

// phpcs:enable
Expand Down Expand Up @@ -1959,8 +2034,10 @@ private function saveProductMediaGalleryPhase(
$rowImages[self::COL_MEDIA_IMAGE][] = $image;
}
}
$this->mediaGalleryReplace->registerProduct($rowSku, $rowData, $storeId);
$rowData[self::COL_MEDIA_IMAGE] = [];
list($rowImages, $rowData) = $this->clearNoSelectionImages($rowImages, $rowData);

/*
* Note: to avoid problems with undefined sorting, the value of media gallery items positions
* must be unique in scope of one product.
Expand Down Expand Up @@ -1990,6 +2067,7 @@ private function saveProductMediaGalleryPhase(
$uploadedImages[$columnImage] = $uploadedFile;
} else {
unset($rowData[$column]);
$this->mediaGalleryReplace->markUploadFailed((string)$rowSku);
$this->addRowError(
ValidatorInterface::ERROR_MEDIA_URL_NOT_ACCESSIBLE,
$rowNum,
Expand All @@ -2012,6 +2090,7 @@ private function saveProductMediaGalleryPhase(
continue;
}
$uploadedFileNormalized = ltrim($uploadedFile, '/\\');
$this->mediaGalleryReplace->keepPath($rowSku, $uploadedFileNormalized);
if (isset($rowExistingImages[$uploadedFileNormalized])) {
$currentFileData = $rowExistingImages[$uploadedFileNormalized];
$currentFileData['store_id'] = $storeId;
Expand Down Expand Up @@ -2062,6 +2141,89 @@ private function saveProductMediaGalleryPhase(
}
}

/**
* Check if product image replace mode is active.
*
* @return bool
*/
private function isImageReplaceMode(): bool
{
$mode = $this->_parameters[Import::FIELD_NAME_PRODUCT_IMAGE_IMPORT_MODE]
?? Import::PRODUCT_IMAGE_IMPORT_MODE_ADD;

return $mode === Import::PRODUCT_IMAGE_IMPORT_MODE_REPLACE
&& $this->getBehavior() === Import::BEHAVIOR_APPEND;
}

/**
* Check if unused media files should be deleted after replace.
*
* @return bool
*/
private function shouldDeleteUnusedImageFiles(): bool
{
if (!$this->isImageReplaceMode()) {
return false;
}
$flag = $this->_parameters[Import::FIELD_NAME_PRODUCT_IMAGE_DELETE_UNUSED] ?? false;

return $flag === true
|| $flag === 1
|| $flag === '1'
|| $flag === 'true'
|| $flag === 'on';
}

/**
* Get media image role attribute codes.
*
* @return string[]
*/
private function getMediaImageRoleAttributeCodes(): array
{
return array_values(
array_filter(
$this->_imagesArrayKeys,
static function (string $code): bool {
return $code !== self::COL_MEDIA_IMAGE;
}
)
);
}

/**
* Collect image-role column values from all store rows in the bunch.
*
* Used so replace-mode protection reflects multi-store role reassignments in
* the same import batch, not only pre-import DB values.
*
* @param array $bunch
* @return array<string, array<int, array<string, mixed>>> lowercase sku => store_id => code => value
*/
private function extractImageRoleAssignmentsFromBunch(array $bunch): array
{
$roleCodes = $this->getMediaImageRoleAttributeCodes();
if ($roleCodes === []) {
return [];
}
$assignments = [];
foreach ($bunch as $rowData) {
if (empty($rowData[self::COL_SKU])) {
continue;
}
$skuKey = mb_strtolower((string)$rowData[self::COL_SKU]);
$storeId = !empty($rowData[self::COL_STORE])
? (int)$this->getStoreIdByCode($rowData[self::COL_STORE])
: Store::DEFAULT_STORE_ID;
foreach ($roleCodes as $code) {
if (array_key_exists($code, $rowData)) {
$assignments[$skuKey][$storeId][$code] = $rowData[$code];
}
}
}
return $assignments;
}

/**
* In _saveProducts loop, save product's attributes
*
Expand Down
Loading