Skip to content

refactor: Make XML sanitization consistent #952

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
DenverCoder1 merged 3 commits into from
Oct 25, 2026
Merged

refactor: Make XML sanitization consistent #952

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cb521f4
refactor: Make XML sanitization consistent
DenverCoder1 Oct 25, 2026
4991cdc
Update RenderTest.php
DenverCoder1 Oct 25, 2026
32f4cee
Update card.php
DenverCoder1 Oct 25, 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
17 changes: 14 additions & 3 deletions src/card.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@

declare(strict_types=1);

/**
* Escape text for XML output.
*
* @param string $text The text to escape
* @return string The XML-escaped text
*/
function escapeXml(string $text): string
{
return htmlspecialchars($text, ENT_QUOTES | ENT_SUBSTITUTE | ENT_DISALLOWED | ENT_XML1, "UTF-8");
}

/**
* Convert date from Y-M-D to more human-readable format
*
Expand Down Expand Up @@ -50,7 +61,7 @@ function formatDate(string $dateString, string|null $format, string $locale): st
}
}
// sanitize and return formatted date
return htmlspecialchars($formatted);
return escapeXml($formatted);
}

/**
Expand Down Expand Up @@ -246,7 +257,7 @@ function splitLines(string $text, int $maxChars, int $line1Offset): string
$text = utf8WordWrap($text, $maxChars, "\n", true);
}
}
$text = htmlspecialchars($text);
$text = escapeXml($text);
return preg_replace(
"/^(.*)\n(.*)/",
"<tspan x='0' dy='{$line1Offset}'>$1</tspan><tspan x='0' dy='16'>$2</tspan>",
Expand Down Expand Up @@ -619,7 +630,7 @@ function generateCard(array $stats, ?array $params = null): string
function generateErrorCard(string $message, ?array $params = null): string
{
$params = $params ?? $_REQUEST;
$message = htmlspecialchars($message, ENT_QUOTES | ENT_SUBSTITUTE | ENT_XML1, "UTF-8");
$message = escapeXml($message);

// get requested theme, use $_REQUEST if no params array specified
$theme = getRequestedTheme($params);
Expand Down
13 changes: 12 additions & 1 deletion tests/RenderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,17 @@ final class RenderTest extends TestCase
"excludedDays" => [],
];

/**
* Test escapeXml function
*/
public function testEscapeXml(): void
{
$this->assertSame("&lt;&gt;&amp;&quot;&apos;", escapeXml("<>&\"'"));
$this->assertSame("&amp;lt;", escapeXml("&lt;"));
$this->assertSame("\u{00E9}", escapeXml("\u{00E9}"));
$this->assertSame("\u{FFFD}", escapeXml("\xFF"));
}

/**
* Test normal card render
*/
Expand Down Expand Up @@ -158,7 +169,7 @@ public function testExcludedDaysCannotInjectMarkup(): void
$this->testStats["excludedDays"] = [$day];
$render = generateOutput($this->testStats, $this->testParams)["body"];
$this->assertSafeSvg($render);
$this->assertStringContainsString(htmlspecialchars($day), $render);
$this->assertStringContainsString(escapeXml($day), $render);
}

/**
Expand Down
Loading