Skip to content

Do not add an extra % when escaping in SQLCommenter #631

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

Open
Westacular wants to merge 2 commits into
base: main
Choose a base branch
from
+4 −16
Open

Do not add an extra % when escaping in SQLCommenter #631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
445cf17
Do not add an extra % when escaping in SQLCommenter
Westacular Jun 23, 2026
95e8f7f
Update UtilsTest.php
Westacular Jun 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
14 changes: 1 addition & 13 deletions src/SqlCommenter/src/Utils.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,10 @@ public static function formatComments(array $comments): string
return '/*' . implode(
',',
array_map(
static fn (string $value, string $key) => Utils::customUrlEncode($key) . "='" . Utils::customUrlEncode($value) . "'",
static fn (string $value, string $key) => urlencode($key) . "='" . urlencode($value) . "'",
$comments,
array_keys($comments)
),
) . '*/';
}

private static function customUrlEncode(string $input): string
{
$encodedString = urlencode($input);

// Since SQL uses '%' as a keyword, '%' is a by-product of url quoting
// e.g. foo,bar --> foo%2Cbar
// thus in our quoting, we need to escape it too to finally give
// foo,bar --> foo%%2Cbar

return str_replace('%', '%%', $encodedString);
}
}
6 changes: 3 additions & 3 deletions src/SqlCommenter/tests/Unit/UtilsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@ public function testFormatCommentsWithoutKeys(): void

public function testFormatCommentsWithSpecialCharKeys(): void
{
$this->assertEquals("/*key1='value1%%40',key2='value2'*/", Utils::formatComments(['key1' => 'value1@', 'key2' => 'value2']));
$this->assertEquals("/*key1='value1%40',key2='value2'*/", Utils::formatComments(['key1' => 'value1@', 'key2' => 'value2']));
}

public function testFormatCommentsWithPlaceholder(): void
{
$this->assertEquals("/*key1='value1%%3F',key2='value2'*/", Utils::formatComments(['key1' => 'value1?', 'key2' => 'value2']));
$this->assertEquals("/*key1='value1%3F',key2='value2'*/", Utils::formatComments(['key1' => 'value1?', 'key2' => 'value2']));
}

public function testFormatCommentsWithNamedPlaceholder(): void
{
$this->assertEquals("/*key1='%%3Anamed',key2='value2'*/", Utils::formatComments(['key1' => ':named', 'key2' => 'value2']));
$this->assertEquals("/*key1='%3Anamed',key2='value2'*/", Utils::formatComments(['key1' => ':named', 'key2' => 'value2']));
}
}
Loading