Skip to content

feat(comments): Support mentioning emails #48760

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
nickvergessen merged 3 commits into from
Oct 18, 2024
Merged

feat(comments): Support mentioning emails #48760

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
9d6c0af
feat(comments): Support mentioning emails
nickvergessen Oct 17, 2024
b61a8cf
fix(comments): Document supported types and provide psalm typing
nickvergessen Oct 17, 2024
882f916
fix(comments): Add test for email mention
nickvergessen Oct 18, 2024
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
46 changes: 26 additions & 20 deletions lib/private/Comments/Comment.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,24 +185,15 @@ public function setMessage($message, $maxLength = self::MAX_MESSAGE_LENGTH): ICo
* returns an array containing mentions that are included in the comment
*
* @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 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
*
* The return array looks like:
* [
* [
* 'type' => 'user',
* 'id' => 'citizen4'
* ],
* [
* 'type' => 'group',
* 'id' => 'media'
* ],
* …
* ]
*
*/
public function getMentions(): array {
$ok = preg_match_all("/\B(?<![^a-z0-9_\-@\.\'\s])@(\"guest\/[a-f0-9]+\"|\"(?:federated_)?(?:group|team|user){1}\/[a-z0-9_\-@\.\' \/:]+\"|\"[a-z0-9_\-@\.\' ]+\"|[a-z0-9_\-@\.\']+)/i", $this->getMessage(), $mentions);
$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);
if (!$ok || !isset($mentions[0])) {
return [];
}
Expand All @@ -213,20 +204,35 @@ public function getMentions(): array {
$result = [];
foreach ($mentionIds as $mentionId) {
// Cut-off the @ and remove wrapping double-quotes
/** @var non-empty-lowercase-string $cleanId */
$cleanId = trim(substr($mentionId, 1), '"');

if (str_starts_with($cleanId, 'guest/')) {
$result[] = ['type' => 'guest', 'id' => $cleanId];
} elseif (str_starts_with($cleanId, 'email/')) {
/** @var non-empty-lowercase-string $cleanId */
$cleanId = substr($cleanId, 6);
$result[] = ['type' => 'email', 'id' => $cleanId];
} elseif (str_starts_with($cleanId, 'federated_group/')) {
$result[] = ['type' => 'federated_group', 'id' => substr($cleanId, 16)];
/** @var non-empty-lowercase-string $cleanId */
$cleanId = substr($cleanId, 16);
$result[] = ['type' => 'federated_group', 'id' => $cleanId];
} elseif (str_starts_with($cleanId, 'group/')) {
$result[] = ['type' => 'group', 'id' => substr($cleanId, 6)];
/** @var non-empty-lowercase-string $cleanId */
$cleanId = substr($cleanId, 6);
$result[] = ['type' => 'group', 'id' => $cleanId];
} elseif (str_starts_with($cleanId, 'federated_team/')) {
$result[] = ['type' => 'federated_team', 'id' => substr($cleanId, 15)];
/** @var non-empty-lowercase-string $cleanId */
$cleanId = substr($cleanId, 15);
$result[] = ['type' => 'federated_team', 'id' => $cleanId];
} elseif (str_starts_with($cleanId, 'team/')) {
$result[] = ['type' => 'team', 'id' => substr($cleanId, 5)];
/** @var non-empty-lowercase-string $cleanId */
$cleanId = substr($cleanId, 5);
$result[] = ['type' => 'team', 'id' => $cleanId];
} elseif (str_starts_with($cleanId, 'federated_user/')) {
$result[] = ['type' => 'federated_user', 'id' => substr($cleanId, 15)];
/** @var non-empty-lowercase-string $cleanId */
$cleanId = substr($cleanId, 15);
$result[] = ['type' => 'federated_user', 'id' => $cleanId];
} else {
$result[] = ['type' => 'user', 'id' => $cleanId];
}
Expand Down
19 changes: 5 additions & 14 deletions lib/public/Comments/IComment.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,21 +124,12 @@ public function setMessage($message, $maxLength = self::MAX_MESSAGE_LENGTH);
* returns an array containing mentions that are included in the comment
*
* @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 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
*
* The return array looks like:
* [
* [
* 'type' => 'user',
* 'id' => 'citizen4'
* ],
* [
* 'type' => 'group',
* 'id' => 'media'
* ],
* …
* ]
*
*/
public function getMentions();

Expand Down
6 changes: 6 additions & 0 deletions tests/lib/Comments/CommentTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,12 @@ public function mentionsProvider(): array {
['type' => 'federated_team', 'id' => 'Former Cirle'],
],
],
[
'Emails are supported since 30.0.2 right? @"email/aa23d315de327cfc330f0401ea061005b2b0cdd45ec8346f12664dd1f34cb886"',
[
['type' => 'email', 'id' => 'aa23d315de327cfc330f0401ea061005b2b0cdd45ec8346f12664dd1f34cb886'],
],
],
];
}

Expand Down