Merge pull request #48137 from nextcloud/enh/add-rich-object-formatter

feat: Add OCP interface to format richtext into string
nextcloud · Sep 18, 2024 · 989d708 · 989d708
2 parents 33928fc + b926df4
commit 989d708
Show file tree

Hide file tree

Showing 13 changed files with 129 additions and 125 deletions.
diff --git a/core/Command/SetupChecks.php b/core/Command/SetupChecks.php
@@ -9,13 +9,15 @@
 
 namespace OC\Core\Command;
 
+use OCP\RichObjectStrings\IRichTextFormatter;
 use OCP\SetupCheck\ISetupCheckManager;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
 class SetupChecks extends Base {
 	public function __construct(
 		private ISetupCheckManager $setupCheckManager,
+		private IRichTextFormatter $richTextFormatter,
 	) {
 		parent::__construct();
 	}
@@ -29,29 +31,6 @@ protected function configure(): void {
 		;
 	}
 
-	/**
-	 * @TODO move this method to a common service used by notifications, activity and this command
-	 * @throws \InvalidArgumentException if a parameter has no name or no type
-	 */
-	private function richToParsed(string $message, array $parameters): string {
-		$placeholders = [];
-		$replacements = [];
-		foreach ($parameters as $placeholder => $parameter) {
-			$placeholders[] = '{' . $placeholder . '}';
-			foreach (['name','type'] as $requiredField) {
-				if (!isset($parameter[$requiredField]) || !is_string($parameter[$requiredField])) {
-					throw new \InvalidArgumentException("Invalid rich object, {$requiredField} field is missing");
-				}
-			}
-			$replacements[] = match($parameter['type']) {
-				'user' => '@' . $parameter['name'],
-				'file' => $parameter['path'] ?? $parameter['name'],
-				default => $parameter['name'],
-			};
-		}
-		return str_replace($placeholders, $replacements, $message);
-	}
-
 	protected function execute(InputInterface $input, OutputInterface $output): int {
 		$results = $this->setupCheckManager->runAll();
 		switch ($input->getOption('output')) {
@@ -79,7 +58,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 						$description = $check->getDescription();
 						$descriptionParameters = $check->getDescriptionParameters();
 						if ($description !== null && $descriptionParameters !== null) {
-							$description = $this->richToParsed($description, $descriptionParameters);
+							$description = $this->richTextFormatter->richToParsed($description, $descriptionParameters);
 						}
 						$output->writeln(
 							"\t\t".

diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php
@@ -646,6 +646,7 @@
     'OCP\\Remote\\IInstanceFactory' => $baseDir . '/lib/public/Remote/IInstanceFactory.php',
     'OCP\\Remote\\IUser' => $baseDir . '/lib/public/Remote/IUser.php',
     'OCP\\RichObjectStrings\\Definitions' => $baseDir . '/lib/public/RichObjectStrings/Definitions.php',
+    'OCP\\RichObjectStrings\\IRichTextFormatter' => $baseDir . '/lib/public/RichObjectStrings/IRichTextFormatter.php',
     'OCP\\RichObjectStrings\\IValidator' => $baseDir . '/lib/public/RichObjectStrings/IValidator.php',
     'OCP\\RichObjectStrings\\InvalidObjectExeption' => $baseDir . '/lib/public/RichObjectStrings/InvalidObjectExeption.php',
     'OCP\\Route\\IRoute' => $baseDir . '/lib/public/Route/IRoute.php',
@@ -1839,6 +1840,7 @@
     'OC\\Repair\\RepairInvalidShares' => $baseDir . '/lib/private/Repair/RepairInvalidShares.php',
     'OC\\Repair\\RepairLogoDimension' => $baseDir . '/lib/private/Repair/RepairLogoDimension.php',
     'OC\\Repair\\RepairMimeTypes' => $baseDir . '/lib/private/Repair/RepairMimeTypes.php',
+    'OC\\RichObjectStrings\\RichTextFormatter' => $baseDir . '/lib/private/RichObjectStrings/RichTextFormatter.php',
     'OC\\RichObjectStrings\\Validator' => $baseDir . '/lib/private/RichObjectStrings/Validator.php',
     'OC\\Route\\CachingRouter' => $baseDir . '/lib/private/Route/CachingRouter.php',
     'OC\\Route\\Route' => $baseDir . '/lib/private/Route/Route.php',

diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php
@@ -679,6 +679,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OCP\\Remote\\IInstanceFactory' => __DIR__ . '/../../..' . '/lib/public/Remote/IInstanceFactory.php',
         'OCP\\Remote\\IUser' => __DIR__ . '/../../..' . '/lib/public/Remote/IUser.php',
         'OCP\\RichObjectStrings\\Definitions' => __DIR__ . '/../../..' . '/lib/public/RichObjectStrings/Definitions.php',
+        'OCP\\RichObjectStrings\\IRichTextFormatter' => __DIR__ . '/../../..' . '/lib/public/RichObjectStrings/IRichTextFormatter.php',
         'OCP\\RichObjectStrings\\IValidator' => __DIR__ . '/../../..' . '/lib/public/RichObjectStrings/IValidator.php',
         'OCP\\RichObjectStrings\\InvalidObjectExeption' => __DIR__ . '/../../..' . '/lib/public/RichObjectStrings/InvalidObjectExeption.php',
         'OCP\\Route\\IRoute' => __DIR__ . '/../../..' . '/lib/public/Route/IRoute.php',
@@ -1872,6 +1873,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OC\\Repair\\RepairInvalidShares' => __DIR__ . '/../../..' . '/lib/private/Repair/RepairInvalidShares.php',
         'OC\\Repair\\RepairLogoDimension' => __DIR__ . '/../../..' . '/lib/private/Repair/RepairLogoDimension.php',
         'OC\\Repair\\RepairMimeTypes' => __DIR__ . '/../../..' . '/lib/private/Repair/RepairMimeTypes.php',
+        'OC\\RichObjectStrings\\RichTextFormatter' => __DIR__ . '/../../..' . '/lib/private/RichObjectStrings/RichTextFormatter.php',
         'OC\\RichObjectStrings\\Validator' => __DIR__ . '/../../..' . '/lib/private/RichObjectStrings/Validator.php',
         'OC\\Route\\CachingRouter' => __DIR__ . '/../../..' . '/lib/private/Route/CachingRouter.php',
         'OC\\Route\\Route' => __DIR__ . '/../../..' . '/lib/private/Route/Route.php',

diff --git a/lib/private/Activity/Event.php b/lib/private/Activity/Event.php
@@ -12,6 +12,7 @@
 use OCP\Activity\Exceptions\InvalidValueException;
 use OCP\Activity\IEvent;
 use OCP\RichObjectStrings\InvalidObjectExeption;
+use OCP\RichObjectStrings\IRichTextFormatter;
 use OCP\RichObjectStrings\IValidator;
 
 class Event implements IEvent {
@@ -60,14 +61,11 @@ class Event implements IEvent {
 
 	/** @var IEvent|null */
 	protected $child;
-	/** @var IValidator */
-	protected $richValidator;
 
-	/**
-	 * @param IValidator $richValidator
-	 */
-	public function __construct(IValidator $richValidator) {
-		$this->richValidator = $richValidator;
+	public function __construct(
+		protected IValidator $richValidator,
+		protected IRichTextFormatter $richTextFormatter,
+	) {
 	}
 
 	/**
@@ -217,7 +215,7 @@ public function setRichSubject(string $subject, array $parameters = []): IEvent
 
 		if ($this->subjectParsed === '') {
 			try {
-				$this->subjectParsed = $this->richToParsed($subject, $parameters);
+				$this->subjectParsed = $this->richTextFormatter->richToParsed($subject, $parameters);
 			} catch (\InvalidArgumentException $e) {
 				throw new InvalidValueException('richSubjectParameters', $e);
 			}
@@ -226,30 +224,6 @@ public function setRichSubject(string $subject, array $parameters = []): IEvent
 		return $this;
 	}
 
-	/**
-	 * @throws \InvalidArgumentException if a parameter has no name or no type
-	 */
-	private function richToParsed(string $message, array $parameters): string {
-		$placeholders = [];
-		$replacements = [];
-		foreach ($parameters as $placeholder => $parameter) {
-			$placeholders[] = '{' . $placeholder . '}';
-			foreach (['name','type'] as $requiredField) {
-				if (!isset($parameter[$requiredField]) || !is_string($parameter[$requiredField])) {
-					throw new \InvalidArgumentException("Invalid rich object, {$requiredField} field is missing");
-				}
-			}
-			if ($parameter['type'] === 'user') {
-				$replacements[] = '@' . $parameter['name'];
-			} elseif ($parameter['type'] === 'file') {
-				$replacements[] = $parameter['path'] ?? $parameter['name'];
-			} else {
-				$replacements[] = $parameter['name'];
-			}
-		}
-		return str_replace($placeholders, $replacements, $message);
-	}
-
 	/**
 	 * @return string
 	 * @since 11.0.0
@@ -317,7 +291,7 @@ public function setRichMessage(string $message, array $parameters = []): IEvent
 
 		if ($this->messageParsed === '') {
 			try {
-				$this->messageParsed = $this->richToParsed($message, $parameters);
+				$this->messageParsed = $this->richTextFormatter->richToParsed($message, $parameters);
 			} catch (\InvalidArgumentException $e) {
 				throw new InvalidValueException('richMessageParameters', $e);
 			}

diff --git a/lib/private/Activity/Manager.php b/lib/private/Activity/Manager.php
@@ -21,20 +21,10 @@
 use OCP\IRequest;
 use OCP\IUser;
 use OCP\IUserSession;
+use OCP\RichObjectStrings\IRichTextFormatter;
 use OCP\RichObjectStrings\IValidator;
 
 class Manager implements IManager {
-	/** @var IRequest */
-	protected $request;
-
-	/** @var IUserSession */
-	protected $session;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var IValidator */
-	protected $validator;
 
 	/** @var string */
 	protected $formattingObjectType;
@@ -48,20 +38,14 @@ class Manager implements IManager {
 	/** @var string */
 	protected $currentUserId;
 
-	protected $l10n;
-
 	public function __construct(
-		IRequest $request,
-		IUserSession $session,
-		IConfig $config,
-		IValidator $validator,
-		IL10N $l10n
+		protected IRequest $request,
+		protected IUserSession $session,
+		protected IConfig $config,
+		protected IValidator $validator,
+		protected IRichTextFormatter $richTextFormatter,
+		protected IL10N $l10n,
 	) {
-		$this->request = $request;
-		$this->session = $session;
-		$this->config = $config;
-		$this->validator = $validator;
-		$this->l10n = $l10n;
 	}
 
 	/** @var \Closure[] */
@@ -104,7 +88,7 @@ protected function getConsumers(): array {
 	 * @return IEvent
 	 */
 	public function generateEvent(): IEvent {
-		return new Event($this->validator);
+		return new Event($this->validator, $this->richTextFormatter);
 	}
 
 	/**

diff --git a/lib/private/Notification/Manager.php b/lib/private/Notification/Manager.php
@@ -22,6 +22,7 @@
 use OCP\Notification\INotification;
 use OCP\Notification\INotifier;
 use OCP\Notification\UnknownNotificationException;
+use OCP\RichObjectStrings\IRichTextFormatter;
 use OCP\RichObjectStrings\IValidator;
 use OCP\Support\Subscription\IRegistry;
 use Psr\Container\ContainerExceptionInterface;
@@ -55,6 +56,7 @@ public function __construct(
 		protected IRegistry $subscription,
 		protected LoggerInterface $logger,
 		private Coordinator $coordinator,
+		private IRichTextFormatter $richTextFormatter,
 	) {
 		$this->cache = $cacheFactory->createDistributed('notifications');
 
@@ -199,7 +201,7 @@ public function getNotifiers(): array {
 	 * @since 8.2.0
 	 */
 	public function createNotification(): INotification {
-		return new Notification($this->validator);
+		return new Notification($this->validator, $this->richTextFormatter);
 	}
 
 	/**

diff --git a/lib/private/Notification/Notification.php b/lib/private/Notification/Notification.php
@@ -12,6 +12,7 @@
 use OCP\Notification\INotification;
 use OCP\Notification\InvalidValueException;
 use OCP\RichObjectStrings\InvalidObjectExeption;
+use OCP\RichObjectStrings\IRichTextFormatter;
 use OCP\RichObjectStrings\IValidator;
 
 class Notification implements INotification {
@@ -39,6 +40,7 @@ class Notification implements INotification {
 
 	public function __construct(
 		protected IValidator $richValidator,
+		protected IRichTextFormatter $richTextFormatter,
 	) {
 		$this->dateTime = new \DateTime();
 		$this->dateTime->setTimestamp(0);
@@ -187,7 +189,7 @@ public function setRichSubject(string $subject, array $parameters = []): INotifi
 
 		if ($this->subjectParsed === '') {
 			try {
-				$this->subjectParsed = $this->richToParsed($subject, $parameters);
+				$this->subjectParsed = $this->richTextFormatter->richToParsed($subject, $parameters);
 			} catch (\InvalidArgumentException $e) {
 				throw new InvalidValueException('richSubjectParameters', $e);
 			}
@@ -196,30 +198,6 @@ public function setRichSubject(string $subject, array $parameters = []): INotifi
 		return $this;
 	}
 
-	/**
-	 * @throws \InvalidArgumentException if a parameter has no name or no type
-	 */
-	private function richToParsed(string $message, array $parameters): string {
-		$placeholders = [];
-		$replacements = [];
-		foreach ($parameters as $placeholder => $parameter) {
-			$placeholders[] = '{' . $placeholder . '}';
-			foreach (['name','type'] as $requiredField) {
-				if (!isset($parameter[$requiredField]) || !is_string($parameter[$requiredField])) {
-					throw new \InvalidArgumentException("Invalid rich object, {$requiredField} field is missing");
-				}
-			}
-			if ($parameter['type'] === 'user') {
-				$replacements[] = '@' . $parameter['name'];
-			} elseif ($parameter['type'] === 'file') {
-				$replacements[] = $parameter['path'] ?? $parameter['name'];
-			} else {
-				$replacements[] = $parameter['name'];
-			}
-		}
-		return str_replace($placeholders, $replacements, $message);
-	}
-
 	/**
 	 * {@inheritDoc}
 	 */
@@ -293,7 +271,7 @@ public function setRichMessage(string $message, array $parameters = []): INotifi
 
 		if ($this->messageParsed === '') {
 			try {
-				$this->messageParsed = $this->richToParsed($message, $parameters);
+				$this->messageParsed = $this->richTextFormatter->richToParsed($message, $parameters);
 			} catch (\InvalidArgumentException $e) {
 				throw new InvalidValueException('richMessageParameters', $e);
 			}

diff --git a/lib/private/RichObjectStrings/RichTextFormatter.php b/lib/private/RichObjectStrings/RichTextFormatter.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OC\RichObjectStrings;
+
+use OCP\RichObjectStrings\IRichTextFormatter;
+
+class RichTextFormatter implements IRichTextFormatter {
+	/**
+	 * @throws \InvalidArgumentException if a parameter has no name or no type
+	 */
+	public function richToParsed(string $message, array $parameters): string {
+		$placeholders = [];
+		$replacements = [];
+		foreach ($parameters as $placeholder => $parameter) {
+			$placeholders[] = '{' . $placeholder . '}';
+			foreach (['name','type'] as $requiredField) {
+				if (!isset($parameter[$requiredField]) || !is_string($parameter[$requiredField])) {
+					throw new \InvalidArgumentException("Invalid rich object, {$requiredField} field is missing");
+				}
+			}
+			$replacements[] = match($parameter['type']) {
+				'user' => '@' . $parameter['name'],
+				'file' => $parameter['path'] ?? $parameter['name'],
+				default => $parameter['name'],
+			};
+		}
+		return str_replace($placeholders, $replacements, $message);
+	}
+}
diff --git a/lib/private/Server.php b/lib/private/Server.php
@@ -204,6 +204,7 @@
 use OCP\Profiler\IProfiler;
 use OCP\Remote\Api\IApiFactory;
 use OCP\Remote\IInstanceFactory;
+use OCP\RichObjectStrings\IRichTextFormatter;
 use OCP\RichObjectStrings\IValidator;
 use OCP\Route\IRouter;
 use OCP\Security\Bruteforce\IThrottler;
@@ -648,6 +649,7 @@ public function __construct($webRoot, \OC\Config $config) {
 				$c->get(IUserSession::class),
 				$c->get(\OCP\IConfig::class),
 				$c->get(IValidator::class),
+				$c->get(IRichTextFormatter::class),
 				$l10n
 			);
 		});
@@ -1285,6 +1287,8 @@ public function __construct($webRoot, \OC\Config $config) {
 
 		$this->registerAlias(\OCP\Security\Ip\IFactory::class, \OC\Security\Ip\Factory::class);
 
+		$this->registerAlias(IRichTextFormatter::class, \OC\RichObjectStrings\RichTextFormatter::class);
+
 		$this->connectDispatcher();
 	}
 

diff --git a/lib/public/RichObjectStrings/IRichTextFormatter.php b/lib/public/RichObjectStrings/IRichTextFormatter.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\RichObjectStrings;
+
+/**
+ * Parse rich text and format it with the richobjects
+ *
+ * @since 31.0.0
+ */
+interface IRichTextFormatter {
+	/**
+	 * @since 31.0.0
+	 * @param string $message
+	 * @param array<string,array<string,string>> $parameters
+	 * @throws \InvalidArgumentException if a parameter has no name or no type
+	 */
+	public function richToParsed(string $message, array $parameters): string;
+}