Skip to content

[stable33] fix(comments): Don't return mentions in markdown code (by default) #58981

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
AndyScherzinger merged 1 commit into from
Mar 17, 2026
+54 −5
Merged

[stable33] fix(comments): Don't return mentions in markdown code (by default) #58981

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
13 changes: 11 additions & 2 deletions lib/private/Comments/Comment.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,16 +184,25 @@ public function setMessage($message, $maxLength = self::MAX_MESSAGE_LENGTH): ICo
/**
* returns an array containing mentions that are included in the comment
*
* @param bool $supportMarkdown
* @return array each mention provides a 'type' and an 'id', see example below
* @psalm-return list<array{type: 'guest'|'email'|'federated_group'|'group'|'federated_team'|'team'|'federated_user'|'user', id: non-empty-lowercase-string}>
* @since 33.0.1 Parameter $supportMarkdown was added to decide if mentions inside markdown code blocks should be ignored (default to true)
* @since 30.0.2 Type 'email' is supported
* @since 29.0.0 Types 'federated_group', 'federated_team', 'team' and 'federated_user' are supported
* @since 23.0.0 Type 'group' is supported
* @since 17.0.0 Type 'guest' is supported
* @since 11.0.0
*/
public function getMentions(): array {
$ok = preg_match_all("/\B(?<![^a-z0-9_\-@\.\'\s])@(\"(guest|email)\/[a-f0-9]+\"|\"(?:federated_)?(?:group|team|user){1}\/[a-z0-9_\-@\.\' \/:]+\"|\"[a-z0-9_\-@\.\' ]+\"|[a-z0-9_\-@\.\']+)/i", $this->getMessage(), $mentions);
public function getMentions(bool $supportMarkdown = true): array {
$message = $this->getMessage();
if ($supportMarkdown) {
// Strip fenced code blocks and inline code so mentions inside them are ignored
$message = preg_replace('/^```.*?^```|^~~~.*?^~~~/sm', '', $message);
$message = preg_replace('/`[^`\n]*`/', '', $message);
}

$ok = preg_match_all("/\B(?<![^a-z0-9_\-@\.\'\s])@(\"(guest|email)\/[a-f0-9]+\"|\"(?:federated_)?(?:group|team|user){1}\/[a-z0-9_\-@\.\' \/:]+\"|\"[a-z0-9_\-@\.\' ]+\"|[a-z0-9_\-@\.\']+)/i", $message, $mentions);
if (!$ok || !isset($mentions[0])) {
return [];
}
Expand Down
4 changes: 3 additions & 1 deletion lib/public/Comments/IComment.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,15 +123,17 @@ public function setMessage($message, $maxLength = self::MAX_MESSAGE_LENGTH);
/**
* returns an array containing mentions that are included in the comment
*
* @param bool $supportMarkdown
* @return array each mention provides a 'type' and an 'id', see example below
* @psalm-return list<array{type: 'guest'|'email'|'federated_group'|'group'|'federated_team'|'team'|'federated_user'|'user', id: non-empty-lowercase-string}>
* @since 33.0.1 Parameter $supportMarkdown was added to decide if mentions inside markdown code blocks should be ignored (default to true)
* @since 30.0.2 Type 'email' is supported
* @since 29.0.0 Types 'federated_group', 'federated_team', 'team' and 'federated_user' are supported
* @since 23.0.0 Type 'group' is supported
* @since 17.0.0 Type 'guest' is supported
* @since 11.0.0
*/
public function getMentions();
public function getMentions(bool $supportMarkdown = true);

/**
* returns the verb of the comment
Expand Down
42 changes: 40 additions & 2 deletions tests/lib/Comments/CommentTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,17 +202,55 @@ public static function mentionsProvider(): array {
['type' => 'email', 'id' => 'aa23d315de327cfc330f0401ea061005b2b0cdd45ec8346f12664dd1f34cb886'],
],
],
[
'Mention @alice but not `@bob` inside inline code',
[['type' => 'user', 'id' => 'alice']],
],
[
'Mention @alice but not `Hello @bob there` inside inline code',
[['type' => 'user', 'id' => 'alice']],
],
[
"Mention ` user @alice\nAs it's just 2 ` accents",
[['type' => 'user', 'id' => 'alice']],
],
[
'Mention @alice and @bob but not `Hello @bob there` inside inline code',
[['type' => 'user', 'id' => 'alice'], ['type' => 'user', 'id' => 'bob']],
],
[
"Mention @alice but not in fenced code block\n```\n@bob @charlie\n```\nend",
[['type' => 'user', 'id' => 'alice']],
],
[
"Mention @alice but not in tilde code block\n~~~\n@bob\n~~~\nend",
[['type' => 'user', 'id' => 'alice']],
],
[
'No mentions at all in `@alice` and `@bob`',
[],
],
[
"@alice\n```\n@bob\n```\n@charlie",
[['type' => 'user', 'id' => 'charlie'], ['type' => 'user', 'id' => 'alice']],
],
[
"@alice\n```\n@bob\n```\n@charlie",
[['type' => 'user', 'id' => 'charlie'], ['type' => 'user', 'id' => 'alice'], ['type' => 'user', 'id' => 'bob']],
null,
false,
],
];
}

#[DataProvider(methodName: 'mentionsProvider')]
public function testMentions(string $message, array $expectedMentions, ?string $author = null): void {
public function testMentions(string $message, array $expectedMentions, ?string $author = null, bool $markdown = true): void {
$comment = new Comment();
$comment->setMessage($message);
if (!is_null($author)) {
$comment->setActor('user', $author);
}
$mentions = $comment->getMentions();
$mentions = $comment->getMentions($markdown);
$this->assertSame($expectedMentions, $mentions);
}
}
Loading