Skip to content

Chore: Config - Replace Block Escaping with Escaper #37078

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

Closed
wants to merge 1 commit into from
Closed

Chore: Config - Replace Block Escaping with Escaper #37078

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 8 additions & 7 deletions app/code/Magento/Config/view/adminhtml/templates/system/config/edit.phtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

use Magento\Framework\Escaper;
use Magento\Framework\View\Helper\SecureHtmlRenderer;

/** @var Escaper $escaper */
/** @var SecureHtmlRenderer $secureRenderer */

/**
* @var \Magento\Framework\View\Helper\SecureHtmlRenderer $secureRenderer
*/
?>
<?php
/**
* @methods
* getTitle() - string
Expand All @@ -18,14 +20,13 @@
* getConfigSearchParamsJson() - string
*/
?>

<?= /* @noEscape */ $secureRenderer->renderTag(
'style',
[],
'.highlighted { background-color: #DFF7FF!important; }'
) ?>

<form action="<?= $block->escapeUrl($block->getSaveUrl()) ?>" method="post" id="config-edit-form"
<form action="<?= $escaper->escapeUrl($block->getSaveUrl()) ?>" method="post" id="config-edit-form"
enctype="multipart/form-data">
<?= $block->getBlockHtml('formkey') ?>
<div class="accordion">
Expand Down
53 changes: 28 additions & 25 deletions app/code/Magento/Config/view/adminhtml/templates/system/config/form/field/array.phtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,50 +3,53 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

/** @var \Magento\Framework\View\Helper\SecureHtmlRenderer $secureRenderer */
?>
use Magento\Framework\Escaper;
use Magento\Framework\View\Helper\SecureHtmlRenderer;

/** @var Escaper $escaper */
/** @var SecureHtmlRenderer $secureRenderer */

<?php
$_htmlId = $block->getHtmlId() ? $block->getHtmlId() : '_' . uniqid();
$_colspan = $block->isAddAfter() ? 2 : 1;
?>

<div class="design_theme_ua_regexp" id="grid<?= $block->escapeHtmlAttr($_htmlId) ?>">
<div class="design_theme_ua_regexp" id="grid<?= $escaper->escapeHtmlAttr($_htmlId) ?>">
<div class="admin__control-table-wrapper">
<table class="admin__control-table" id="<?= $block->escapeHtmlAttr($block->getElement()->getId()) ?>">
<table class="admin__control-table" id="<?= $escaper->escapeHtmlAttr($block->getElement()->getId()) ?>">
<thead>
<tr>
<?php foreach ($block->getColumns() as $columnName => $column): ?>
<th><?= $block->escapeHtml($column['label']) ?></th>
<th><?= $escaper->escapeHtml($column['label']) ?></th>
<?php endforeach; ?>
<th class="col-actions" colspan="<?= (int)$_colspan ?>"><?= $block->escapeHtml(__('Action')) ?></th>
<th class="col-actions" colspan="<?= (int)$_colspan ?>"><?= $escaper->escapeHtml(__('Action')) ?></th>
</tr>
</thead>
<tfoot>
<tr>
<td colspan="<?= count($block->getColumns())+$_colspan ?>" class="col-actions-add">
<button id="addToEndBtn<?= $block->escapeHtmlAttr($_htmlId) ?>"
<button id="addToEndBtn<?= $escaper->escapeHtmlAttr($_htmlId) ?>"
class="action-add"
title="<?= $block->escapeHtmlAttr(__('Add')) ?>"
title="<?= $escaper->escapeHtmlAttr(__('Add')) ?>"
type="button">
<span><?= $block->escapeHtml($block->getAddButtonLabel()) ?></span>
<span><?= $escaper->escapeHtml($block->getAddButtonLabel()) ?></span>
</button>
</td>
</tr>
</tfoot>
<tbody id="addRow<?= $block->escapeHtmlAttr($_htmlId) ?>"></tbody>
<tbody id="addRow<?= $escaper->escapeHtmlAttr($_htmlId) ?>"></tbody>
</table>
</div>
<input type="hidden" name="<?= $block->escapeHtmlAttr($block->getElement()->getName()) ?>[__empty]" value="" />
<input type="hidden" name="<?= $escaper->escapeHtmlAttr($block->getElement()->getName()) ?>[__empty]" value="" />

<?php $scriptString = <<<script
require([
'mage/template',
'prototype'
], function (mageTemplate) {
// create row creator
window.arrayRow{$block->escapeJs($_htmlId)} = {
window.arrayRow{$escaper->escapeJs($_htmlId)} = {

// define row prototypeJS template
template: mageTemplate(
Expand All @@ -56,7 +59,7 @@ script;
$scriptString .= <<<script

+ '<td>'
+ '{$block->escapeJs($block->renderCellTemplate($columnName))}'
+ '{$escaper->escapeJs($block->renderCellTemplate($columnName))}'
+ '<\/td>'
script;
endforeach;
Expand All @@ -65,25 +68,25 @@ script;
$scriptString .= <<<script

+ '<td><button class="action-add" type="button" id="addAfterBtn<%- _id %>"><span>'
+ '{$block->escapeJs(__('Add after'))}'
+ '{$escaper->escapeJs(__('Add after'))}'
+ '<\/span><\/button><\/td>'
script;
endif;
$scriptString .= <<<script

+ '<td class="col-actions"><button '
+ 'class="action-delete" type="button">'
+ '<span>{$block->escapeJs(__('Delete'))}<\/span><\/button><\/td>'
+ '<span>{$escaper->escapeJs(__('Delete'))}<\/span><\/button><\/td>'
+ '<\/tr>'

script;
$scriptString1 = /* $noEscape */ $secureRenderer->renderEventListenerAsTag(
'onclick',
"arrayRow" . $block->escapeJs($_htmlId) . ".del('<%- _id %>')",
"arrayRow" . $escaper->escapeJs($_htmlId) . ".del('<%- _id %>')",
"tr#<%- _id %> button.action-delete"
);

$scriptString .= " + '" . $block->escapeJs($scriptString1) . "'" . PHP_EOL;
$scriptString .= " + '" . $escaper->escapeJs($scriptString1) . "'" . PHP_EOL;

$scriptString .= <<<script
),
Expand All @@ -102,7 +105,7 @@ script;
foreach ($block->getColumns() as $columnName => $column):
$scriptString .= <<<script

{$block->escapeJs($columnName)}: '',
{$escaper->escapeJs($columnName)}: '',
'option_extra_attrs': {},
script;
endforeach;
Expand All @@ -116,7 +119,7 @@ script;
if (insertAfterId) {
Element.insert($(insertAfterId), {after: this.template(templateValues)});
} else {
Element.insert($('addRow{$block->escapeJs($_htmlId)}'), {bottom: this.template(templateValues)});
Element.insert($('addRow{$escaper->escapeJs($_htmlId)}'), {bottom: this.template(templateValues)});
}

// Fill controls with data
Expand Down Expand Up @@ -149,10 +152,10 @@ script;
}

// bind add action to "Add" button in last row
Event.observe('addToEndBtn{$block->escapeJs($_htmlId)}',
Event.observe('addToEndBtn{$escaper->escapeJs($_htmlId)}',
'click',
arrayRow{$block->escapeJs($_htmlId)}.add.bind(
arrayRow{$block->escapeJs($_htmlId)}, false, false
arrayRow{$escaper->escapeJs($_htmlId)}.add.bind(
arrayRow{$escaper->escapeJs($_htmlId)}, false, false
)
);

Expand All @@ -161,7 +164,7 @@ script;
script;

foreach ($block->getArrayRows() as $_rowId => $_row) {
$scriptString .= /** @noEscape */ " arrayRow" .$block->escapeJs($_htmlId) .
$scriptString .= /** @noEscape */ " arrayRow" .$escaper->escapeJs($_htmlId) .
".add(" . /** @noEscape */ $_row->toJson() . ");\n";
}
$scriptString .= <<<script
Expand All @@ -171,7 +174,7 @@ script;
if ($block->getElement()->getDisabled()):
$scriptString .= <<<script

toggleValueElements({checked: true}, $('grid{$block->escapeJs($_htmlId)}').parentNode);
toggleValueElements({checked: true}, $('grid{$escaper->escapeJs($_htmlId)}').parentNode);
script;
endif;
$scriptString .= <<<script
Expand Down
17 changes: 10 additions & 7 deletions app/code/Magento/Config/view/adminhtml/templates/system/config/js.phtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,17 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

/**
* @var \Magento\Framework\View\Helper\SecureHtmlRenderer $secureRenderer
* @var \Magento\Config\ViewModel\CountryFilter $countryFilter
*/
?>
use Magento\Config\ViewModel\CountryFilter;
use Magento\Framework\Escaper;
use Magento\Framework\View\Helper\SecureHtmlRenderer;

/** @var Escaper $escaper */
/** @var SecureHtmlRenderer $secureRenderer */
/** @var CountryFilter $countryFilter */

<?php $scriptString = <<<script
$scriptString = <<<script
require([
'prototype'
], function () {
Expand Down Expand Up @@ -76,7 +79,7 @@ originModel.prototype = {
this.loader = new varienLoader(true);
script;

$scriptString .= 'this.regionsUrl = "' . $block->escapeJs($block->getUrl('directory/json/countryRegion')) . '";';
$scriptString .= 'this.regionsUrl = "' . $escaper->escapeJs($block->getUrl('directory/json/countryRegion')) . '";';
$countryFilter = $block->getData('countryFilter');
$euCountries = $countryFilter->getEuCountryList();
$scriptString .= 'this.euCountryList = Object.values(' . json_encode($euCountries) . ');';
Expand Down
28 changes: 17 additions & 11 deletions app/code/Magento/Config/view/adminhtml/templates/system/config/switcher.phtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,35 +3,41 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

/* @var $block \Magento\Backend\Block\Template */
/** @var \Magento\Framework\View\Helper\SecureHtmlRenderer $secureRenderer */
use Magento\Backend\Block\Template;
use Magento\Framework\Escaper;
use Magento\Framework\View\Helper\SecureHtmlRenderer;

/** @var Escaper $escaper */
/** @var Template $block */
/** @var SecureHtmlRenderer $secureRenderer */
?>
<div class="field field-store-switcher">
<label class="label" for="store_switcher"><?= $block->escapeHtml(__('Current Configuration Scope:')) ?></label>
<label class="label" for="store_switcher"><?= $escaper->escapeHtml(__('Current Configuration Scope:')) ?></label>
<div class="control">
<select id="store_switcher" class="system-config-store-switcher">
<?php foreach ($block->getStoreSelectOptions() as $_value => $_option): ?>
<?php if (isset($_option['is_group'])): ?>
<?php if ($_option['is_close']): ?>
</optgroup>
<?php else: ?>
<optgroup label="<?= $block->escapeHtmlAttr($_option['label']) ?>">
<optgroup label="<?= $escaper->escapeHtmlAttr($_option['label']) ?>">
<?= /* @noEscape */ $secureRenderer->renderStyleAsTag(
$_option['style'],
"optgroup[label='" . $block->escapeJs($_option['label']) . "']"
"optgroup[label='" . $escaper->escapeJs($_option['label']) . "']"
) ?>
<?php endif; ?>
<?php continue ?>
<?php endif; ?>
<option value="<?= $block->escapeHtmlAttr($_value) ?>"
url="<?= $block->escapeUrl($_option['url']) ?>"
<option value="<?= $escaper->escapeHtmlAttr($_value) ?>"
url="<?= $escaper->escapeUrl($_option['url']) ?>"
<?= $_option['selected'] ? 'selected="selected"' : '' ?>>
<?= $block->escapeHtml($_option['label']) ?>
<?= $escaper->escapeHtml($_option['label']) ?>
</option>
<?= /* @noEscape */ $secureRenderer->renderStyleAsTag(
$_option['style'],
"optgroup[url='" . $block->escapeJs($_option['url']) . "']"
"optgroup[url='" . $escaper->escapeJs($_option['url']) . "']"
) ?>
<?php endforeach ?>
</select>
Expand All @@ -44,8 +50,8 @@
<?= $block->getHintHtml() ?>
<?php if ($block->getAuthorization()->isAllowed('Magento_Backend::store')): ?>
<div class="actions">
<a href="<?= $block->escapeUrl($block->getUrl('*/system_store')) ?>">
<?= $block->escapeHtml(__('Stores')) ?>
<a href="<?= $escaper->escapeUrl($block->getUrl('*/system_store')) ?>">
<?= $escaper->escapeHtml(__('Stores')) ?>
</a>
</div>
<?php endif; ?>
Expand Down
22 changes: 13 additions & 9 deletions app/code/Magento/Config/view/adminhtml/templates/system/config/tabs.phtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,16 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

/** @var $block \Magento\Config\Block\System\Config\Tabs */
?>
use Magento\Config\Block\System\Config\Tabs;
use Magento\Framework\Escaper;

/** @var Escaper $escaper */
/** @var Tabs $block */
?>
<?php if ($block->getTabs()) : ?>
<div id="<?= $block->escapeHtmlAttr($block->getId()) ?>" class="config-nav">
<div id="<?= $escaper->escapeHtmlAttr($block->getId()) ?>" class="config-nav">
<?php
/** @var $_tab \Magento\Config\Model\Config\Structure\Element\Tab */
foreach ($block->getTabs() as $_tab) :
Expand All @@ -21,15 +25,15 @@

<div class="config-nav-block admin__page-nav _collapsed
<?php if ($_tab->getClass()) : ?>
<?= $block->escapeHtmlAttr($_tab->getClass()) ?>
<?= $escaper->escapeHtmlAttr($_tab->getClass()) ?>
<?php endif ?>"
data-mage-init='{"collapsible":{"active": "<?= $block->escapeHtmlAttr($activeCollapsible) ?>",
data-mage-init='{"collapsible":{"active": "<?= $escaper->escapeHtmlAttr($activeCollapsible) ?>",
"openedState": "_show",
"closedState": "_hide",
"collapsible": true,
"animate": 200}}'>
<div class="admin__page-nav-title title _collapsible" data-role="title">
<strong><?= $block->escapeHtml($_tab->getLabel()) ?></strong>
<strong><?= $escaper->escapeHtml($_tab->getLabel()) ?></strong>
</div>

<ul class="admin__page-nav-items items" data-role="content">
Expand All @@ -38,12 +42,12 @@
/** @var $_section \Magento\Config\Model\Config\Structure\Element\Section */
foreach ($_tab->getChildren() as $_section) : ?>
<li class="admin__page-nav-item item
<?= $block->escapeHtml($_section->getClass()) ?>
<?= $escaper->escapeHtml($_section->getClass()) ?>
<?php if ($block->isSectionActive($_section)) : ?> _active<?php endif ?>
<?= $_tab->getChildren()->isLast($_section) ? ' _last' : '' ?>">
<a href="<?= $block->escapeUrl($block->getSectionUrl($_section)) ?>"
<a href="<?= $escaper->escapeUrl($block->getSectionUrl($_section)) ?>"
class="admin__page-nav-link item-nav">
<span><?= $block->escapeHtml($_section->getLabel()) ?></span>
<span><?= $escaper->escapeHtml($_section->getLabel()) ?></span>
</a>
</li>
<?php $_iterator++; ?>
Expand Down