Skip to content

Populate the mention-notification with the actual message #12349

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
MorrisJobke merged 1 commit into from
Nov 8, 2018
Merged

Populate the mention-notification with the actual message #12349

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
127 changes: 86 additions & 41 deletions apps/comments/lib/Notification/Notifier.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,12 @@

namespace OCA\Comments\Notification;

use OCP\Comments\IComment;
use OCP\Comments\ICommentsManager;
use OCP\Comments\NotFoundException;
use OCP\Files\IRootFolder;
use OCP\IURLGenerator;
use OCP\IUser;
use OCP\IUserManager;
use OCP\L10N\IFactory;
use OCP\Notification\INotification;
Expand Down Expand Up @@ -83,14 +85,14 @@ public function prepare(INotification $notification, $languageCode) {
$l = $this->l10nFactory->get('comments', $languageCode);
$displayName = $comment->getActorId();
$isDeletedActor = $comment->getActorType() === ICommentsManager::DELETED_USER;
if($comment->getActorType() === 'users') {
if ($comment->getActorType() === 'users') {
$commenter = $this->userManager->get($comment->getActorId());
if(!is_null($commenter)) {
if ($commenter instanceof IUser) {
$displayName = $commenter->getDisplayName();
}
}

switch($notification->getSubject()) {
switch ($notification->getSubject()) {
case 'mention':
$parameters = $notification->getSubjectParameters();
if($parameters[0] !== 'files') {
Expand All @@ -103,47 +105,38 @@ public function prepare(INotification $notification, $languageCode) {
}
$node = $nodes[0];

$path = rtrim($node->getPath(), '/');
if (strpos($path, '/' . $notification->getUser() . '/files/') === 0) {
// Remove /user/files/...
$fullPath = $path;
list(,,, $path) = explode('/', $fullPath, 4);
}
$subjectParameters = [
'file' => [
'type' => 'file',
'id' => $comment->getObjectId(),
'name' => $node->getName(),
'path' => $path,
'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $comment->getObjectId()]),
],
];

if ($isDeletedActor) {
$notification->setParsedSubject($l->t(
'You were mentioned on “%s”, in a comment by a user that has since been deleted',
[$node->getName()]
))
->setRichSubject(
$l->t('You were mentioned on “{file}”, in a comment by a user that has since been deleted'),
[
'file' => [
'type' => 'file',
'id' => $comment->getObjectId(),
'name' => $node->getName(),
'path' => $node->getPath(),
'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $comment->getObjectId()]),
],
]
);
$subject = $l->t('You were mentioned on “{file}”, in a comment by a user that has since been deleted');
} else {
$notification->setParsedSubject($l->t(
'%1$s mentioned you in a comment on “%2$s”',
[$displayName, $node->getName()]
))
->setRichSubject(
$l->t('{user} mentioned you in a comment on “{file}”'),
[
'user' => [
'type' => 'user',
'id' => $comment->getActorId(),
'name' => $displayName,
],
'file' => [
'type' => 'file',
'id' => $comment->getObjectId(),
'name' => $node->getName(),
'path' => $node->getPath(),
'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $comment->getObjectId()]),
],
]
);
$subject = $l->t('{user} mentioned you in a comment on “{file}”');
$subjectParameters['user'] = [
'type' => 'user',
'id' => $comment->getActorId(),
'name' => $displayName,
];
}
$notification->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.svg')))
list($message, $messageParameters) = $this->commentToRichMessage($comment);
$notification->setRichSubject($subject, $subjectParameters)
->setParsedSubject($this->richToParsed($subject, $subjectParameters))
->setRichMessage($message, $messageParameters)
->setParsedMessage($this->richToParsed($message, $messageParameters))
->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.svg')))
->setLink($this->url->linkToRouteAbsolute(
'comments.Notifications.view',
['id' => $comment->getId()])
Expand All @@ -155,6 +148,58 @@ public function prepare(INotification $notification, $languageCode) {
default:
throw new \InvalidArgumentException('Invalid subject');
}
}

public function commentToRichMessage(IComment $comment): array {
$message = $comment->getMessage();
$messageParameters = [];
$mentionTypeCount = [];
$mentions = $comment->getMentions();
foreach ($mentions as $mention) {
if ($mention['type'] === 'user') {
$user = $this->userManager->get($mention['id']);
if (!$user instanceof IUser) {
continue;
}
}
if (!array_key_exists($mention['type'], $mentionTypeCount)) {
$mentionTypeCount[$mention['type']] = 0;
}
$mentionTypeCount[$mention['type']]++;
// To keep a limited character set in parameter IDs ([a-zA-Z0-9-])
// the mention parameter ID does not include the mention ID (which
// could contain characters like '@' for user IDs) but a one-based
// index of the mentions of that type.
$mentionParameterId = 'mention-' . $mention['type'] . $mentionTypeCount[$mention['type']];
$message = str_replace('@' . $mention['id'], '{' . $mentionParameterId . '}', $message);
try {
$displayName = $this->commentsManager->resolveDisplayName($mention['type'], $mention['id']);
} catch (\OutOfBoundsException $e) {
// There is no registered display name resolver for the mention
// type, so the client decides what to display.
$displayName = '';
}
$messageParameters[$mentionParameterId] = [
'type' => $mention['type'],
'id' => $mention['id'],
'name' => $displayName
];
}
return [$message, $messageParameters];
}

public function richToParsed(string $message, array $parameters): string {
$placeholders = $replacements = [];
foreach ($parameters as $placeholder => $parameter) {
$placeholders[] = '{' . $placeholder . '}';
if ($parameter['type'] === 'user') {
$replacements[] = '@' . $parameter['name'];
} else if ($parameter['type'] === 'file') {
$replacements[] = $parameter['path'];
} else {
$replacements[] = $parameter['name'];
}
}
return str_replace($placeholders, $replacements, $message);
}
}
79 changes: 71 additions & 8 deletions apps/comments/tests/Unit/Notification/NotifierTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,20 +93,26 @@ protected function setUp() {
public function testPrepareSuccess() {
$fileName = 'Gre\'thor.odp';
$displayName = 'Huraga';
$message = 'Huraga mentioned you in a comment on “Gre\'thor.odp”';
$message = '@Huraga mentioned you in a comment on “Gre\'thor.odp”';

/** @var IUser|\PHPUnit_Framework_MockObject_MockObject $user */
$user = $this->createMock(IUser::class);
$user->expects($this->once())
->method('getDisplayName')
->willReturn($displayName);
/** @var IUser|\PHPUnit_Framework_MockObject_MockObject $you */
$you = $this->createMock(IUser::class);

/** @var Node|\PHPUnit_Framework_MockObject_MockObject $node */
$node = $this->createMock(Node::class);
$node
->expects($this->atLeastOnce())
->method('getName')
->willReturn($fileName);
$node
->expects($this->atLeastOnce())
->method('getPath')
->willReturn('/you/files/' . $fileName);

$userFolder = $this->createMock(Folder::class);
$this->folder->expects($this->once())
Expand All @@ -118,7 +124,7 @@ public function testPrepareSuccess() {
->with('678')
->willReturn([$node]);

$this->notification->expects($this->once())
$this->notification->expects($this->exactly(2))
->method('getUser')
->willReturn('you');
$this->notification
Expand All @@ -143,6 +149,16 @@ public function testPrepareSuccess() {
->method('setRichSubject')
->with('{user} mentioned you in a comment on “{file}”', $this->anything())
->willReturnSelf();
$this->notification
->expects($this->once())
->method('setRichMessage')
->with('Hi {mention-user1}!', ['mention-user1' => ['type' => 'user', 'id' => 'you', 'name' => 'Your name']])
->willReturnSelf();
$this->notification
->expects($this->once())
->method('setParsedMessage')
->with('Hi @Your name!')
->willReturnSelf();
$this->notification
->expects($this->once())
->method('setIcon')
Expand Down Expand Up @@ -171,17 +187,32 @@ public function testPrepareSuccess() {
->expects($this->any())
->method('getActorType')
->willReturn('users');
$this->comment
->expects($this->any())
->method('getMessage')
->willReturn('Hi @you!');
$this->comment
->expects($this->any())
->method('getMentions')
->willReturn([['type' => 'user', 'id' => 'you']]);

$this->commentsManager
->expects($this->once())
->method('get')
->willReturn($this->comment);
$this->commentsManager
->expects($this->once())
->method('resolveDisplayName')
->with('user', 'you')
->willReturn('Your name');

$this->userManager
->expects($this->once())
->expects($this->exactly(2))
->method('get')
->with('huraga')
->willReturn($user);
->willReturnMap([
['huraga', $user],
['you', $you],
]);

$this->notifier->prepare($this->notification, $this->lc);
}
Expand All @@ -190,12 +221,19 @@ public function testPrepareSuccessDeletedUser() {
$fileName = 'Gre\'thor.odp';
$message = 'You were mentioned on “Gre\'thor.odp”, in a comment by a user that has since been deleted';

/** @var IUser|\PHPUnit_Framework_MockObject_MockObject $you */
$you = $this->createMock(IUser::class);

/** @var Node|\PHPUnit_Framework_MockObject_MockObject $node */
$node = $this->createMock(Node::class);
$node
->expects($this->atLeastOnce())
->method('getName')
->willReturn($fileName);
$node
->expects($this->atLeastOnce())
->method('getPath')
->willReturn('/you/files/' . $fileName);

$userFolder = $this->createMock(Folder::class);
$this->folder->expects($this->once())
Expand All @@ -207,7 +245,7 @@ public function testPrepareSuccessDeletedUser() {
->with('678')
->willReturn([$node]);

$this->notification->expects($this->once())
$this->notification->expects($this->exactly(2))
->method('getUser')
->willReturn('you');
$this->notification
Expand All @@ -232,6 +270,16 @@ public function testPrepareSuccessDeletedUser() {
->method('setRichSubject')
->with('You were mentioned on “{file}”, in a comment by a user that has since been deleted', $this->anything())
->willReturnSelf();
$this->notification
->expects($this->once())
->method('setRichMessage')
->with('Hi {mention-user1}!', ['mention-user1' => ['type' => 'user', 'id' => 'you', 'name' => 'Your name']])
->willReturnSelf();
$this->notification
->expects($this->once())
->method('setParsedMessage')
->with('Hi @Your name!')
->willReturnSelf();
$this->notification
->expects($this->once())
->method('setIcon')
Expand Down Expand Up @@ -260,15 +308,30 @@ public function testPrepareSuccessDeletedUser() {
->expects($this->any())
->method('getActorType')
->willReturn(ICommentsManager::DELETED_USER);
$this->comment
->expects($this->any())
->method('getMessage')
->willReturn('Hi @you!');
$this->comment
->expects($this->any())
->method('getMentions')
->willReturn([['type' => 'user', 'id' => 'you']]);

$this->commentsManager
->expects($this->once())
->method('get')
->willReturn($this->comment);
$this->commentsManager
->expects($this->once())
->method('resolveDisplayName')
->with('user', 'you')
->willReturn('Your name');

$this->userManager
->expects($this->never())
->method('get');
->expects($this->once())
->method('get')
->with('you')
->willReturn($you);

$this->notifier->prepare($this->notification, $this->lc);
}
Expand Down