Get rid of all useless calls to setParsedSubject now that setRichSubj…

…ect is able to do it Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
nextcloud · Nov 29, 2022 · d9151ff · d9151ff
1 parent db995d4
commit d9151ff
Show file tree

Hide file tree

Showing 15 changed files with 87 additions and 339 deletions.
diff --git a/apps/comments/lib/Activity/Provider.php b/apps/comments/lib/Activity/Provider.php
@@ -31,12 +31,10 @@
 use OCP\Comments\NotFoundException;
 use OCP\IL10N;
 use OCP\IURLGenerator;
-use OCP\IUser;
 use OCP\IUserManager;
 use OCP\L10N\IFactory;
 
 class Provider implements IProvider {
-
 	protected IFactory $languageFactory;
 	protected ?IL10N $l = null;
 	protected IUrlGenerator $url;
@@ -97,14 +95,12 @@ protected function parseShortVersion(IEvent $event): IEvent {
 
 		if ($event->getSubject() === 'add_comment_subject') {
 			if ($subjectParameters['actor'] === $this->activityManager->getCurrentUserId()) {
-				$event->setParsedSubject($this->l->t('You commented'))
-					->setRichSubject($this->l->t('You commented'), []);
+				$event->setRichSubject($this->l->t('You commented'), []);
 			} else {
 				$author = $this->generateUserParameter($subjectParameters['actor']);
-				$event->setParsedSubject($this->l->t('%1$s commented', [$author['name']]))
-					->setRichSubject($this->l->t('{author} commented'), [
-						'author' => $author,
-					]);
+				$event->setRichSubject($this->l->t('{author} commented'), [
+					'author' => $author,
+				]);
 			}
 		} else {
 			throw new \InvalidArgumentException();

diff --git a/apps/comments/lib/Notification/Notifier.php b/apps/comments/lib/Notification/Notifier.php
@@ -29,15 +29,13 @@
 use OCP\Comments\NotFoundException;
 use OCP\Files\IRootFolder;
 use OCP\IURLGenerator;
-use OCP\IUser;
 use OCP\IUserManager;
 use OCP\L10N\IFactory;
 use OCP\Notification\AlreadyProcessedException;
 use OCP\Notification\INotification;
 use OCP\Notification\INotifier;
 
 class Notifier implements INotifier {
-
 	protected IFactory $l10nFactory;
 	protected IRootFolder $rootFolder;
 	protected ICommentsManager $commentsManager;
@@ -147,9 +145,7 @@ public function prepare(INotification $notification, string $languageCode): INot
 				}
 				[$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',
@@ -205,19 +201,4 @@ public function commentToRichMessage(IComment $comment): array {
 		}
 		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'];
-			} elseif ($parameter['type'] === 'file') {
-				$replacements[] = $parameter['path'];
-			} else {
-				$replacements[] = $parameter['name'];
-			}
-		}
-		return str_replace($placeholders, $replacements, $message);
-	}
 }
diff --git a/apps/dav/lib/CalDAV/Activity/Provider/Base.php b/apps/dav/lib/CalDAV/Activity/Provider/Base.php
@@ -30,11 +30,9 @@
 use OCP\IGroupManager;
 use OCP\IL10N;
 use OCP\IURLGenerator;
-use OCP\IUser;
 use OCP\IUserManager;
 
 abstract class Base implements IProvider {
-
 	/** @var IUserManager */
 	protected $userManager;
 
@@ -58,20 +56,8 @@ public function __construct(IUserManager $userManager, IGroupManager $groupManag
 		$this->url = $urlGenerator;
 	}
 
-	/**
-	 * @param IEvent $event
-	 * @param string $subject
-	 * @param array $parameters
-	 */
-	protected function setSubjects(IEvent $event, $subject, array $parameters) {
-		$placeholders = $replacements = [];
-		foreach ($parameters as $placeholder => $parameter) {
-			$placeholders[] = '{' . $placeholder . '}';
-			$replacements[] = $parameter['name'];
-		}
-
-		$event->setParsedSubject(str_replace($placeholders, $replacements, $subject))
-			->setRichSubject($subject, $parameters);
+	protected function setSubjects(IEvent $event, string $subject, array $parameters): void {
+		$event->setRichSubject($subject, $parameters);
 	}
 
 	/**

diff --git a/apps/dav/lib/CardDAV/Activity/Provider/Base.php b/apps/dav/lib/CardDAV/Activity/Provider/Base.php
@@ -32,11 +32,9 @@
 use OCP\IGroupManager;
 use OCP\IL10N;
 use OCP\IURLGenerator;
-use OCP\IUser;
 use OCP\IUserManager;
 
 abstract class Base implements IProvider {
-
 	/** @var IUserManager */
 	protected $userManager;
 
@@ -60,20 +58,8 @@ public function __construct(IUserManager $userManager,
 		$this->url = $urlGenerator;
 	}
 
-	/**
-	 * @param IEvent $event
-	 * @param string $subject
-	 * @param array $parameters
-	 */
 	protected function setSubjects(IEvent $event, string $subject, array $parameters): void {
-		$placeholders = $replacements = [];
-		foreach ($parameters as $placeholder => $parameter) {
-			$placeholders[] = '{' . $placeholder . '}';
-			$replacements[] = $parameter['name'];
-		}
-
-		$event->setParsedSubject(str_replace($placeholders, $replacements, $subject))
-			->setRichSubject($subject, $parameters);
+		$event->setRichSubject($subject, $parameters);
 	}
 
 	/**

diff --git a/apps/federatedfilesharing/lib/Notifier.php b/apps/federatedfilesharing/lib/Notifier.php
@@ -108,10 +108,6 @@ public function prepare(INotification $notification, string $languageCode): INot
 					$params[3] = $remoteInitiator['name'] . '@' . $remoteInitiator['server'];
 					$params[4] = $remoteOwner['name'] . '@' . $remoteOwner['server'];
 
-					$notification->setParsedSubject(
-						$l->t('You received "%3$s" as a remote share from %4$s (%1$s) (on behalf of %5$s (%2$s))', $params)
-					);
-
 					$notification->setRichSubject(
 						$l->t('You received {share} as a remote share from {user} (on behalf of {behalf})'),
 						[
@@ -128,11 +124,6 @@ public function prepare(INotification $notification, string $languageCode): INot
 					$remoteOwner = $this->createRemoteUser($params[0]);
 					$params[3] = $remoteOwner['name'] . '@' . $remoteOwner['server'];
 
-					$notification->setParsedSubject(
-						$l->t('You received "%3$s" as a remote share from %4$s (%1$s)', $params)
-					);
-
-
 					$notification->setRichSubject(
 						$l->t('You received {share} as a remote share from {user}'),
 						[

diff --git a/apps/files/lib/Activity/FavoriteProvider.php b/apps/files/lib/Activity/FavoriteProvider.php
@@ -172,7 +172,6 @@ protected function setSubjects(IEvent $event, $subject) {
 			'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $subjectParams['id']]),
 		];
 
-		$event->setParsedSubject(str_replace('{file}', $parameter['path'], $subject))
-			->setRichSubject($subject, ['file' => $parameter]);
+		$event->setRichSubject($subject, ['file' => $parameter]);
 	}
 }
diff --git a/apps/files/lib/Activity/Provider.php b/apps/files/lib/Activity/Provider.php
@@ -38,12 +38,10 @@
 use OCP\Files\NotFoundException;
 use OCP\IL10N;
 use OCP\IURLGenerator;
-use OCP\IUser;
 use OCP\IUserManager;
 use OCP\L10N\IFactory;
 
 class Provider implements IProvider {
-
 	/** @var IFactory */
 	protected $languageFactory;
 
@@ -306,19 +304,8 @@ private function isHiddenFile(string $filename): bool {
 		return strlen($filename) > 0 && $filename[0] === '.';
 	}
 
-	protected function setSubjects(IEvent $event, $subject, array $parameters) {
-		$placeholders = $replacements = [];
-		foreach ($parameters as $placeholder => $parameter) {
-			$placeholders[] = '{' . $placeholder . '}';
-			if ($parameter['type'] === 'file') {
-				$replacements[] = $parameter['path'];
-			} else {
-				$replacements[] = $parameter['name'];
-			}
-		}
-
-		$event->setParsedSubject(str_replace($placeholders, $replacements, $subject))
-			->setRichSubject($subject, $parameters);
+	protected function setSubjects(IEvent $event, string $subject, array $parameters): void {
+		$event->setRichSubject($subject, $parameters);
 	}
 
 	/**

diff --git a/apps/files/lib/Notification/Notifier.php b/apps/files/lib/Notification/Notifier.php
@@ -41,7 +41,6 @@
 use OCP\Notification\INotifier;
 
 class Notifier implements INotifier, IDismissableNotifier {
-
 	/** @var IFactory */
 	protected $l10nFactory;
 
@@ -151,7 +150,6 @@ public function handleTransferownershipRequest(INotification $notification, stri
 						'name' => $sourceUser->getDisplayName(),
 					],
 				])
-			->setParsedSubject(str_replace('{user}', $sourceUser->getDisplayName(), $l->t('Incoming ownership transfer from {user}')))
 			->setRichMessage(
 				$l->t("Do you want to accept {path}?\n\nNote: The transfer process after accepting may take up to 1 hour."),
 				[
@@ -160,20 +158,17 @@ public function handleTransferownershipRequest(INotification $notification, stri
 						'id' => $param['targetUser'] . '::' . $param['nodeName'],
 						'name' => $param['nodeName'],
 					]
-				])
-			->setParsedMessage(str_replace('{path}', $param['nodeName'], $l->t("Do you want to accept {path}?\n\nNote: The transfer process after accepting may take up to 1 hour.")));
+				]);
 
 		return $notification;
 	}
 
-	public function handleTransferOwnershipFailedSource(INotification $notification,  string $languageCode): INotification {
+	public function handleTransferOwnershipFailedSource(INotification $notification, string $languageCode): INotification {
 		$l = $this->l10nFactory->get('files', $languageCode);
 		$param = $notification->getSubjectParameters();
 
 		$targetUser = $this->getUser($param['targetUser']);
 		$notification->setRichSubject($l->t('Ownership transfer failed'))
-			->setParsedSubject($l->t('Ownership transfer failed'))
-
 			->setRichMessage(
 				$l->t('Your ownership transfer of {path} to {user} failed.'),
 				[
@@ -187,19 +182,16 @@ public function handleTransferOwnershipFailedSource(INotification $notification,
 						'id' => $targetUser->getUID(),
 						'name' => $targetUser->getDisplayName(),
 					],
-				])
-			->setParsedMessage(str_replace(['{path}', '{user}'], [$param['nodeName'], $targetUser->getDisplayName()], $l->t('Your ownership transfer of {path} to {user} failed.')));
+				]);
 		return $notification;
 	}
 
-	public function handleTransferOwnershipFailedTarget(INotification $notification,  string $languageCode): INotification {
+	public function handleTransferOwnershipFailedTarget(INotification $notification, string $languageCode): INotification {
 		$l = $this->l10nFactory->get('files', $languageCode);
 		$param = $notification->getSubjectParameters();
 
 		$sourceUser = $this->getUser($param['sourceUser']);
 		$notification->setRichSubject($l->t('Ownership transfer failed'))
-			->setParsedSubject($l->t('Ownership transfer failed'))
-
 			->setRichMessage(
 				$l->t('The ownership transfer of {path} from {user} failed.'),
 				[
@@ -213,20 +205,17 @@ public function handleTransferOwnershipFailedTarget(INotification $notification,
 						'id' => $sourceUser->getUID(),
 						'name' => $sourceUser->getDisplayName(),
 					],
-				])
-			->setParsedMessage(str_replace(['{path}', '{user}'], [$param['nodeName'], $sourceUser->getDisplayName()], $l->t('The ownership transfer of {path} from {user} failed.')));
+				]);
 
 		return $notification;
 	}
 
-	public function handleTransferOwnershipDoneSource(INotification $notification,  string $languageCode): INotification {
+	public function handleTransferOwnershipDoneSource(INotification $notification, string $languageCode): INotification {
 		$l = $this->l10nFactory->get('files', $languageCode);
 		$param = $notification->getSubjectParameters();
 
 		$targetUser = $this->getUser($param['targetUser']);
 		$notification->setRichSubject($l->t('Ownership transfer done'))
-			->setParsedSubject($l->t('Ownership transfer done'))
-
 			->setRichMessage(
 				$l->t('Your ownership transfer of {path} to {user} has completed.'),
 				[
@@ -240,20 +229,17 @@ public function handleTransferOwnershipDoneSource(INotification $notification,
 						'id' => $targetUser->getUID(),
 						'name' => $targetUser->getDisplayName(),
 					],
-				])
-			->setParsedMessage(str_replace(['{path}', '{user}'], [$param['nodeName'], $targetUser->getDisplayName()], $l->t('Your ownership transfer of {path} to {user} has completed.')));
+				]);
 
 		return $notification;
 	}
 
-	public function handleTransferOwnershipDoneTarget(INotification $notification,  string $languageCode): INotification {
+	public function handleTransferOwnershipDoneTarget(INotification $notification, string $languageCode): INotification {
 		$l = $this->l10nFactory->get('files', $languageCode);
 		$param = $notification->getSubjectParameters();
 
 		$sourceUser = $this->getUser($param['sourceUser']);
 		$notification->setRichSubject($l->t('Ownership transfer done'))
-			->setParsedSubject($l->t('Ownership transfer done'))
-
 			->setRichMessage(
 				$l->t('The ownership transfer of {path} from {user} has completed.'),
 				[
@@ -267,8 +253,7 @@ public function handleTransferOwnershipDoneTarget(INotification $notification,
 						'id' => $sourceUser->getUID(),
 						'name' => $sourceUser->getDisplayName(),
 					],
-				])
-			->setParsedMessage(str_replace(['{path}', '{user}'], [$param['nodeName'], $sourceUser->getDisplayName()], $l->t('The ownership transfer of {path} from {user} has completed.')));
+				]);
 
 		return $notification;
 	}

diff --git a/apps/files_sharing/lib/Activity/Providers/Base.php b/apps/files_sharing/lib/Activity/Providers/Base.php
@@ -31,12 +31,10 @@
 use OCP\Federation\ICloudIdManager;
 use OCP\IL10N;
 use OCP\IURLGenerator;
-use OCP\IUser;
 use OCP\IUserManager;
 use OCP\L10N\IFactory;
 
 abstract class Base implements IProvider {
-
 	/** @var IFactory */
 	protected $languageFactory;
 
@@ -124,24 +122,10 @@ abstract protected function parseShortVersion(IEvent $event);
 	abstract protected function parseLongVersion(IEvent $event, IEvent $previousEvent = null);
 
 	/**
-	 * @param IEvent $event
-	 * @param string $subject
-	 * @param array $parameters
 	 * @throws \InvalidArgumentException
 	 */
-	protected function setSubjects(IEvent $event, $subject, array $parameters) {
-		$placeholders = $replacements = [];
-		foreach ($parameters as $placeholder => $parameter) {
-			$placeholders[] = '{' . $placeholder . '}';
-			if ($parameter['type'] === 'file') {
-				$replacements[] = $parameter['path'];
-			} else {
-				$replacements[] = $parameter['name'];
-			}
-		}
-
-		$event->setParsedSubject(str_replace($placeholders, $replacements, $subject))
-			->setRichSubject($subject, $parameters);
+	protected function setSubjects(IEvent $event, string $subject, array $parameters): void {
+		$event->setRichSubject($subject, $parameters);
 	}
 
 	/**

diff --git a/apps/files_sharing/lib/Notification/Notifier.php b/apps/files_sharing/lib/Notification/Notifier.php
@@ -132,7 +132,6 @@ protected function parseShareExpiration(IShare $share, INotification $notificati
 
 		$notification
 			->setParsedSubject($l->t('Share will expire tomorrow'))
-			->setParsedMessage($l->t('One or more of your shares will expire tomorrow'))
 			->setRichMessage(
 				$l->t('Your share of {node} will expire tomorrow'),
 				[
@@ -232,14 +231,7 @@ protected function parseShareInvitation(IShare $share, INotification $notificati
 				throw new \InvalidArgumentException('Invalid subject');
 		}
 
-		$placeholders = $replacements = [];
-		foreach ($subjectParameters as $placeholder => $parameter) {
-			$placeholders[] = '{' . $placeholder . '}';
-			$replacements[] = $parameter['name'];
-		}
-
-		$notification->setParsedSubject(str_replace($placeholders, $replacements, $subject))
-			->setRichSubject($subject, $subjectParameters)
+		$notification->setRichSubject($subject, $subjectParameters)
 			->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/share.svg')));
 
 		$acceptAction = $notification->createAction();