Skip to content
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

Correctly escape custom product image attributes #26959

Merged
merged 8 commits into from
Mar 15, 2020
Merged

Correctly escape custom product image attributes #26959

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6a8a103
Do not escape custom attributes
alexander-aleman Feb 21, 2020
4d3a05d
Custom attributes can not be escaped in the current form
alexander-aleman Feb 21, 2020
b0ccd4f
correctly handle escaping
alexander-aleman Feb 21, 2020
79025f8
Filter custom attributes and add changes to unit test
alexander-aleman Feb 21, 2020
5e84595
Remove empty lines
alexander-aleman Feb 21, 2020
afac7ea
Update expectation for return type of getCustomAttributes
alexander-aleman Feb 22, 2020
c9ad76f
Merge branch '2.4-develop' into issue-25219-custom-image-attributes
alexander-aleman Feb 27, 2020
9fa7ece
Merge branch '2.4-develop' into issue-25219-custom-image-attributes
alexander-aleman Mar 6, 2020
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
2 changes: 1 addition & 1 deletion app/code/Magento/Catalog/Block/Product/Image.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* @method string getHeight()
* @method string getLabel()
* @method float getRatio()
* @method string getCustomAttributes()
* @method array getCustomAttributes()
* @method string getClass()
* @since 100.0.2
*/
Expand Down
19 changes: 8 additions & 11 deletions app/code/Magento/Catalog/Block/Product/ImageFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,20 +68,17 @@ public function __construct(
}

/**
* Retrieve image custom attributes for HTML element
* Remove class from custom attributes
*
* @param array $attributes
* @return string
* @return array
*/
private function getStringCustomAttributes(array $attributes): string
private function filterCustomAttributes(array $attributes): array
{
$result = [];
foreach ($attributes as $name => $value) {
if ($name != 'class') {
$result[] = $name . '="' . $value . '"';
}
if (isset($attributes['class'])) {
unset($attributes['class']);
}
return !empty($result) ? implode(' ', $result) : '';
return $attributes;
}

/**
Expand Down Expand Up @@ -161,7 +158,7 @@ public function create(Product $product, string $imageId, array $attributes = nu
}

$attributes = $attributes === null ? [] : $attributes;

$data = [
'data' => [
'template' => 'Magento_Catalog::product/image_with_borders.phtml',
Expand All @@ -170,7 +167,7 @@ public function create(Product $product, string $imageId, array $attributes = nu
'height' => $imageMiscParams['image_height'],
'label' => $this->getLabel($product, $imageMiscParams['image_type']),
'ratio' => $this->getRatio($imageMiscParams['image_width'], $imageMiscParams['image_height']),
'custom_attributes' => $this->getStringCustomAttributes($attributes),
'custom_attributes' => $this->filterCustomAttributes($attributes),
'class' => $this->getClass($attributes),
'product_id' => $product->getId()
],
Expand Down
7 changes: 5 additions & 2 deletions app/code/Magento/Catalog/Test/Unit/Block/Product/ImageFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ private function getTestDataWithoutAttributes(): array
'height' => 100,
'label' => 'test_image_label',
'ratio' => 1,
'custom_attributes' => '',
'custom_attributes' => [],
'product_id' => null,
'class' => 'product-image-photo'
],
Expand Down Expand Up @@ -202,7 +202,10 @@ private function getTestDataWithAttributes(): array
'height' => 50,
'label' => 'test_product_name',
'ratio' => 0.5, // <==
'custom_attributes' => 'name_1="value_1" name_2="value_2"',
'custom_attributes' => [
'name_1' => 'value_1',
'name_2' => 'value_2',
],
'product_id' => null,
'class' => 'my-class'
],
Expand Down
4 changes: 3 additions & 1 deletion app/code/Magento/Catalog/view/frontend/templates/product/image.phtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@
<?php /** @var $block \Magento\Catalog\Block\Product\Image */ ?>

<img class="photo image <?= $block->escapeHtmlAttr($block->getClass()) ?>"
<?= $block->escapeHtml($block->getCustomAttributes()) ?>
<?php foreach ($block->getCustomAttributes() as $name => $value): ?>
<?= $block->escapeHtmlAttr($name) ?>="<?= $block->escapeHtmlAttr($value) ?>"
<?php endforeach; ?>
src="<?= $block->escapeUrl($block->getImageUrl()) ?>"
width="<?= $block->escapeHtmlAttr($block->getWidth()) ?>"
height="<?= $block->escapeHtmlAttr($block->getHeight()) ?>"
Expand Down
4 changes: 3 additions & 1 deletion app/code/Magento/Catalog/view/frontend/templates/product/image_with_borders.phtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@
<span class="product-image-wrapper"
style="padding-bottom: <?= ($block->getRatio() * 100) ?>%;">
<img class="<?= $block->escapeHtmlAttr($block->getClass()) ?>"
<?= $block->escapeHtmlAttr($block->getCustomAttributes()) ?>
<?php foreach ($block->getCustomAttributes() as $name => $value): ?>
<?= $block->escapeHtmlAttr($name) ?>="<?= $block->escapeHtmlAttr($value) ?>"
<?php endforeach; ?>
src="<?= $block->escapeUrl($block->getImageUrl()) ?>"
max-width="<?= $block->escapeHtmlAttr($block->getWidth()) ?>"
max-height="<?= $block->escapeHtmlAttr($block->getHeight()) ?>"
Expand Down
2 changes: 1 addition & 1 deletion dev/tests/integration/testsuite/Magento/Swatches/Block/Product/ListProductTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ private function assertProductImage(array $images, string $area, array $expectat
$this->updateProductImages($images);
$productImage = $this->listingBlock->getImage($this->productRepository->get('configurable'), $area);
$this->assertInstanceOf(Image::class, $productImage);
$this->assertEquals($productImage->getCustomAttributes(), '');
$this->assertEquals($productImage->getCustomAttributes(), []);
$this->assertEquals($productImage->getClass(), 'product-image-photo');
$this->assertEquals($productImage->getRatio(), 1.25);
$this->assertEquals($productImage->getLabel(), $expectation['label']);
Expand Down