Skip to content

Chore: Admin Notification - Replace Block Escaping with Escaper #37093

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: Admin Notification - Replace Block Escaping with Escaper #37093

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
20 changes: 12 additions & 8 deletions app/code/Magento/AdminNotification/view/adminhtml/templates/notification/window.phtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,29 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

/**
* @see \Magento\AdminNotification\Block\Window
* @var \Magento\Framework\View\Helper\SecureHtmlRenderer $secureRenderer
*/
use Magento\AdminNotification\Block\Window;
use Magento\Framework\Escaper;
use Magento\Framework\View\Helper\SecureHtmlRenderer;

/** @var Window $block */
/** @var Escaper $escaper */
/** @var SecureHtmlRenderer $secureRenderer */
?>
<ul class="message-system-list"
data-mage-init='{
"Magento_Ui/js/modal/modal": {
"autoOpen": true,
"buttons": false,
"modalClass": "modal-system-messages",
"title": "<?= $block->escapeHtmlAttr($block->getHeaderText()) ?>"
"title": "<?= $escaper->escapeHtmlAttr($block->getHeaderText()) ?>"
}
}'>
<li class="message message-warning warning">
<?= $block->escapeHtml($block->getNoticeMessageText()) ?><br/>
<a href="<?= $block->escapeUrl($block->getNoticeMessageUrl()) ?>">
<?= $block->escapeHtml($block->getReadDetailsText()) ?>
<?= $escaper->escapeHtml($block->getNoticeMessageText()) ?><br/>
<a href="<?= $escaper->escapeUrl($block->getNoticeMessageUrl()) ?>">
<?= $escaper->escapeHtml($block->getReadDetailsText()) ?>
</a>
</li>
</ul>
Expand Down
25 changes: 17 additions & 8 deletions app/code/Magento/AdminNotification/view/adminhtml/templates/system/messages.phtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,43 +3,52 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

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

<?php $lastCritical = $block->getLastCritical();?>
/** @var Escaper $escaper */
/** @var Messages $block */
$lastCritical = $block->getLastCritical();
?>
<div id="system_messages"
class="message-system<?php if ($lastCritical) : ?>
message-system-unread<?php endif; ?>">
<div class="message-system-inner">
<?php if ($lastCritical) : ?>
<ul class="message-system-list">
<li class="message message-warning error">
<?= $block->escapeHtml($lastCritical->getText()) ?>
<?= $escaper->escapeHtml($lastCritical->getText()) ?>
</li>
</ul>
<?php endif; ?>
<div class="message-system-short">
<span class="message-system-short-label">
<?= $block->escapeHtml(__('System Messages:')) ?>
<?= $escaper->escapeHtml(__('System Messages:')) ?>
</span>

<?php if ($block->getCriticalCount()) : ?>
<div class="message message-warning error">
<a class="message-link" href="#" title="<?= $block->escapeHtml(__('Critical System Messages')) ?>">
<a class="message-link"
href="#"
title="<?= $escaper->escapeHtml(__('Critical System Messages')) ?>">
<?= (int) $block->getCriticalCount() ?>
</a>
</div>
<?php endif; ?>

<?php if ($block->getMajorCount()) : ?>
<div class="message message-warning warning">
<a class="message-link" href="#" title="<?= $block->escapeHtml(__('Major System Messages')) ?>">
<a class="message-link" href="#" title="<?= $escaper->escapeHtml(__('Major System Messages')) ?>">
<?= (int) $block->getMajorCount() ?>
</a>
</div>
<?php endif; ?>
</div>
<div id="message-system-all" title="<?= $block->escapeHtml(__('System messages')) ?>" data-mage-init='<?= $block->escapeHtml($block->getSystemMessageDialogJson()) ?>'></div>
<div id="message-system-all"
title="<?= $escaper->escapeHtml(__('System messages')) ?>"
data-mage-init='<?= $escaper->escapeHtml($block->getSystemMessageDialogJson()) ?>'>
</div>
</div>
</div>
17 changes: 11 additions & 6 deletions app/code/Magento/AdminNotification/view/adminhtml/templates/system/messages/popup.phtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,22 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

/** @var $block \Magento\AdminNotification\Block\System\Messages\UnreadMessagePopup */
/** @var \Magento\Framework\View\Helper\SecureHtmlRenderer $secureRenderer */
?>
use Magento\AdminNotification\Block\System\Messages\UnreadMessagePopup;
use Magento\Framework\Escaper;
use Magento\Framework\View\Helper\SecureHtmlRenderer;

/** @var UnreadMessagePopup $block */
/** @var Escaper $escaper */
/** @var SecureHtmlRenderer $secureRenderer */
?>
<div id="system_messages_list" data-role="system_messages_list"
title="<?= $block->escapeHtmlAttr($block->getPopupTitle()) ?>">
title="<?= $escaper->escapeHtmlAttr($block->getPopupTitle()) ?>">
<ul class="message-system-list messages">
<?php foreach ($block->getUnreadMessages() as $message): ?>
<li class="message message-warning <?= $block->escapeHtmlAttr($block->getItemClass($message)) ?>">
<?= $block->escapeHtml($message->getText()) ?>
<li class="message message-warning <?= $escaper->escapeHtmlAttr($block->getItemClass($message)) ?>">
<?= $escaper->escapeHtml($message->getText()) ?>
</li>
<?php endforeach;?>
</ul>
Expand Down
41 changes: 24 additions & 17 deletions app/code/Magento/AdminNotification/view/adminhtml/templates/toolbar_entry.phtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,78 +3,85 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

use Magento\AdminNotification\Block\ToolbarEntry;
use Magento\Framework\Escaper;

// phpcs:disable Generic.Files.LineLength
/** @var $block \Magento\AdminNotification\Block\ToolbarEntry */
$notificationCount = $block->getUnreadNotificationCount();
$notificationCounterMax = $block->getNotificationCounterMax();

/** @var Escaper $escaper */
/** @var ToolbarEntry $block */
$notificationCount = $block->getUnreadNotificationCount();
$notificationCounterMax = $block->getNotificationCounterMax();
?>
<div
data-mage-init='{"toolbarEntry": {}}'
class="notifications-wrapper admin__action-dropdown-wrap"
data-notification-count="<?= (int)$notificationCount ?>">
<?php if ($notificationCount > 0): ?>
<a
href="<?= $block->escapeUrl($block->getUrl('adminhtml/notification/index')) ?>"
href="<?= $escaper->escapeUrl($block->getUrl('adminhtml/notification/index')) ?>"
class="notifications-action admin__action-dropdown"
data-mage-init='{"dropdown":{}}'
title="<?= $block->escapeHtmlAttr(__('Notifications')) ?>"
title="<?= $escaper->escapeHtmlAttr(__('Notifications')) ?>"
data-toggle="dropdown">
<span class="notifications-counter">
<?= /* @noEscape */ ($notificationCount > $notificationCounterMax) ? (int)$notificationCounterMax . '+' : (int)$notificationCount ?>
</span>
</a>
<ul
class="admin__action-dropdown-menu"
data-mark-as-read-url="<?= $block->escapeUrl($block->getUrl('adminhtml/notification/ajaxMarkAsRead')) ?>">
data-mark-as-read-url="<?= $escaper->escapeUrl($block->getUrl('adminhtml/notification/ajaxMarkAsRead')) ?>">
<?php foreach ($block->getLatestUnreadNotifications() as $notification): ?>
<?php /** @var $notification \Magento\AdminNotification\Model\Inbox */ ?>
<li class="notifications-entry<?php if ($notification->getSeverity() == 1): ?> notifications-critical<?php endif; ?>"
data-notification-id="<?= $block->escapeHtmlAttr($notification->getId()) ?>"
data-notification-id="<?= $escaper->escapeHtmlAttr($notification->getId()) ?>"
data-notification-severity="<?php if ($notification->getSeverity() == 1): ?>1<?php endif; ?>">
<?php
$notificationDescription = $notification->getDescription() ?? '';
$notificationDescriptionLength = $block->getNotificationDescriptionLength();
?>
<strong class="notifications-entry-title">
<?= $block->escapeHtml($notification->getTitle()) ?>
<?= $escaper->escapeHtml($notification->getTitle()) ?>
</strong>
<?php if (strlen($notificationDescription) > $notificationDescriptionLength): ?>
<p class="notifications-entry-description _cutted">
<span class="notifications-entry-description-start">
<?= $block->escapeHtml(substr($notificationDescription, 0, $notificationDescriptionLength)) ?>
<?= $escaper->escapeHtml(substr($notificationDescription, 0, $notificationDescriptionLength)) ?>
</span>
<span class="notifications-entry-description-end">
<?= $block->escapeHtml(substr($notificationDescription, $notificationDescriptionLength)) ?>
<?= $escaper->escapeHtml(substr($notificationDescription, $notificationDescriptionLength)) ?>
</span>
</p>
<?php else: ?>
<p class="notifications-entry-description">
<?= $block->escapeHtml($notificationDescription) ?>
<?= $escaper->escapeHtml($notificationDescription) ?>
</p>
<?php endif; ?>
<time class="notifications-entry-time">
<?= $block->escapeHtml($block->formatNotificationDate($notification->getDateAdded())) ?>
<?= $escaper->escapeHtml($block->formatNotificationDate($notification->getDateAdded())) ?>
</time>
<button
type="button"
class="notifications-close"
title="<?= $block->escapeHtmlAttr(__('Close')) ?>"
title="<?= $escaper->escapeHtmlAttr(__('Close')) ?>"
></button>
</li>
<?php endforeach; ?>
<li class="notifications-entry notifications-entry-last">
<a
href="<?= $block->escapeUrl($block->getUrl('adminhtml/notification/index')) ?>"
href="<?= $escaper->escapeUrl($block->getUrl('adminhtml/notification/index')) ?>"
class="action-tertiary action-more">
<?= $block->escapeHtml(__('See All (')) ?><span class="notifications-counter"><?= (int)$notificationCount ?></span><?= $block->escapeHtml(__(' unread)')) ?>
<?= $escaper->escapeHtml(__('See All (')) ?><span class="notifications-counter"><?= (int)$notificationCount ?></span><?= $escaper->escapeHtml(__(' unread)')) ?>
</a>
</li>
</ul>
<?php else: ?>
<a
class="notifications-action admin__action-dropdown"
href="<?= $block->escapeUrl($block->getUrl('adminhtml/notification/index')) ?>"
title="<?= $block->escapeHtmlAttr(__('Notifications')) ?>">
href="<?= $escaper->escapeUrl($block->getUrl('adminhtml/notification/index')) ?>"
title="<?= $escaper->escapeHtmlAttr(__('Notifications')) ?>">
</a>
<?php endif; ?>
</div>