Skip to content

fix: a data attribute is escaped like everything else the theme renders #927

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

Merged
blaipr merged 1 commit into from
Sep 17, 2026
Merged

fix: a data attribute is escaped like everything else the theme renders #927

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
4 changes: 2 additions & 2 deletions public/themes/material-blue/views/_partials/fixed-header.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ use function SP\__;
<a id="btn-<?php echo $action->getId(); ?>"
class="btn-menu mdl-navigation__link"
<?php foreach ($action->getData() as $dataName => $dataValue): ?>
<?php echo 'data-', $dataName, '="', $dataValue, '"'; ?>
<?php echo 'data-', $dataName, '="', $_e($dataValue), '"'; ?>
<?php endforeach; ?>>
<i class="material-icons"><?php echo $action->getIcon()->getIcon(); ?></i>
</a>
Expand Down Expand Up @@ -102,7 +102,7 @@ use function SP\__;
<a id="btn-drawer-<?php echo $action->getId(); ?>"
class="btn-menu mdl-navigation__link"
<?php foreach ($action->getData() as $dataName => $dataValue): ?>
<?php echo 'data-', $dataName, '="', $dataValue, '"'; ?>
<?php echo 'data-', $dataName, '="', $_e($dataValue), '"'; ?>
<?php endforeach; ?>>
<i class="material-icons"><?php echo $action->getIcon()->getIcon(); ?></i>
<?php echo $_e($action->getTitle()); ?>
Expand Down
10 changes: 8 additions & 2 deletions public/themes/material-blue/views/account/search-rows.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,8 +421,14 @@ $favoriteRouteOff = $_getvar('favoriteRouteOff');
data-parent-id="<?php
echo $accountSearchData->getParentId(); ?>"
<?php
// A data attribute is escaped like every other value the theme
// renders. These loops emit whatever a grid action was given, and
// what reaches them today is routes and integer ids — but nothing
// here constrains that, and the escaping guard cannot see a bare
// `$dataValue` the way it sees a named getter. One `addData()` call
// carrying a name or a note would break out of the attribute.
foreach ($action->getData() as $dataName => $dataValue):
printf('data-%s="%s"', $dataName, $dataValue);
printf('data-%s="%s"', $dataName, $_e($dataValue));
endforeach; ?>>
<?php
echo $action->getIcon()->getIcon(); ?></i>
Expand Down Expand Up @@ -459,7 +465,7 @@ $favoriteRouteOff = $_getvar('favoriteRouteOff');
echo $accountSearchData->getParentId(); ?>"
<?php
foreach ($actionMenu->getData() as $dataName => $dataValue):
printf('data-%s="%s"', $dataName, $dataValue);
printf('data-%s="%s"', $dataName, $_e($dataValue));
endforeach; ?>>
<i class="material-icons <?php
echo $actionMenu->getIcon()->getClass(); ?>"
Expand Down
6 changes: 3 additions & 3 deletions public/themes/material-blue/views/grid/datagrid-grid.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ $index = $index ?? 0;
<?php
foreach (
$action->getData() as $dataName => $dataValue
): echo 'data-', $dataName, '=', '"', $dataValue, '"'; endforeach; ?>>
): echo 'data-', $dataName, '=', '"', $_e($dataValue), '"'; endforeach; ?>>
<i class="material-icons"><?php
echo $action->getIcon()->getIcon(); ?></i>
</button>
Expand All @@ -90,7 +90,7 @@ $index = $index ?? 0;
<?php
foreach (
$action->getData() as $dataName => $dataValue
): echo 'data-', $dataName, '=', '"', $dataValue, '"'; endforeach; ?>>
): echo 'data-', $dataName, '=', '"', $_e($dataValue), '"'; endforeach; ?>>

<div class="mdl-textfield mdl-js-textfield mdl-textfield--expandable">
<label class="mdl-button mdl-js-button mdl-button--icon"
Expand Down Expand Up @@ -194,7 +194,7 @@ $index = $index ?? 0;
<?php
foreach (
$action->getData() as $dataName => $dataValue
): echo 'data-', $dataName, '=', '"', $dataValue, '"'; endforeach; ?>>
): echo 'data-', $dataName, '=', '"', $_e($dataValue), '"'; endforeach; ?>>
<i class="material-icons <?php
echo $action->getIcon()->getClass(); ?>"><?php
echo $action->getIcon()->getIcon(); ?></i>
Expand Down
8 changes: 6 additions & 2 deletions public/themes/material-blue/views/grid/datagrid-rows.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,14 @@ if ($dataGridData->getDataCount() > 0):
data-item-id="<?php
echo $itemId; ?>"
data-onclick="<?php
echo $action->getOnClick(); ?>"
echo $_e($action->getOnClick()); ?>"
<?php
// Escaped like every other value the theme renders. What
// reaches these today is routes and integer ids, but nothing
// here constrains that, and the escaping guard cannot see a
// bare `$dataValue` the way it sees a named getter.
foreach ($nodeData as $dataName => $dataValue):
echo 'data-', $dataName, '=', '"', $dataValue, '"';
echo 'data-', $dataName, '=', '"', $_e($dataValue), '"';
endforeach; ?>><?php
echo $action->getIcon()->getIcon(); ?></i>
<span
Expand Down
56 changes: 56 additions & 0 deletions tests/Unit/Infrastructure/Adapter/In/Web/View/ThemeEscapesWhatItRendersTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,62 @@ public function aTemplateEscapesTheTextItRenders(string $template): void
self::assertSame([], $unescaped, "unescaped text in template:\n" . implode("\n", $unescaped));
}

/**
* A `data-*` attribute built from a caller-supplied map escapes what it emits.
*
* The rule above is per *expression*, and it recognises what carries text by the getter's name
* or by `$_getvar(`. Three loops in the theme emit `data-<name>="<value>"` out of
* `DataGridAction::getData()` / `getRuntimeData()`, where the value is a bare `$dataValue` —
* invisible to that rule, and unescaped. What reaches them today is routes and integer ids, so
* nothing was leaking; but nothing in the templates or in `DataGridActionBase` constrains it,
* and a single `addData()` call carrying a name, a login or a note would break straight out of
* the attribute.
*
* This is narrower than the rule above on purpose: it looks only at the loops whose attribute
* *name* is itself a variable, which are exactly the ones taking an arbitrary map from a
* caller. A fixed `data-item-id="<?php echo $id; ?>"` is an id by construction and is left to
* the rule above.
*/
#[Test]
#[DataProvider('templates')]
public function aDataAttributeMapIsEscaped(string $template): void
{
$source = (string)file_get_contents($template);

$unescaped = [];

// printf('data-%s="%s"', $name, $value) and echo 'data-', $name, '=', '"', $value, '"'
// The quote characters are matched with `.` rather than written into the class, which
// keeps this pattern readable inside a single-quoted PHP string.
$patterns = [
'/printf\(\s*.data-%s="%s".\s*,(?P<args>[^;]*?)\);/s',
'/echo\s+.data-.\s*,(?P<args>[^;]*?);/s',
];

foreach ($patterns as $pattern) {
preg_match_all($pattern, $source, $matches, PREG_OFFSET_CAPTURE);

foreach ($matches['args'] as [$args, $offset]) {
if (str_contains($args, '$_e(')) {
continue;
}

$unescaped[] = sprintf(
'%s:%d %s',
basename($template),
substr_count(substr($source, 0, $offset), "\n") + 1,
trim(preg_replace('/\s+/', ' ', $args))
);
}
}

self::assertSame(
[],
$unescaped,
"a data attribute built from a caller-supplied map went out unescaped:\n" . implode("\n", $unescaped)
);
}

/**
* Inside a `<script>` element the rule is different, and `$_e()` is the wrong answer.
*
Expand Down