Merge pull request #47662 from nextcloud/fix/notification/validate-ri…

…ch-object-key-value-types
nextcloud · Sep 10, 2024 · 979cc87 · 979cc87
2 parents a7eaed7 + a3da745
commit 979cc87
Show file tree

Hide file tree

Showing 7 changed files with 43 additions and 10 deletions.
diff --git a/apps/files_sharing/lib/Notification/Notifier.php b/apps/files_sharing/lib/Notification/Notifier.php
@@ -126,9 +126,9 @@ protected function parseShareExpiration(IShare $share, INotification $notificati
 				[
 					'node' => [
 						'type' => 'file',
-						'id' => $node->getId(),
+						'id' => (string)$node->getId(),
 						'name' => $node->getName(),
-						'path' => $path,
+						'path' => (string)$path,
 					],
 				]
 			);

diff --git a/lib/private/Activity/Event.php b/lib/private/Activity/Event.php
@@ -259,7 +259,7 @@ public function getRichSubject(): string {
 	}
 
 	/**
-	 * @return array[]
+	 * @return array<string, array<string, string>>
 	 * @since 11.0.0
 	 */
 	public function getRichSubjectParameters(): array {
@@ -335,7 +335,7 @@ public function getRichMessage(): string {
 	}
 
 	/**
-	 * @return array[]
+	 * @return array<string, array<string, string>>
 	 * @since 11.0.0
 	 */
 	public function getRichMessageParameters(): array {

diff --git a/lib/private/RichObjectStrings/Validator.php b/lib/private/RichObjectStrings/Validator.php
@@ -78,6 +78,15 @@ protected function validateParameter(array $parameter) {
 		if (!empty($missingKeys)) {
 			throw new InvalidObjectExeption('Object is invalid, missing keys:'.json_encode($missingKeys));
 		}
+
+		foreach ($parameter as $key => $value) {
+			if (!is_string($key)) {
+				throw new InvalidObjectExeption('Object is invalid, key ' . $key . ' is not a string');
+			}
+			if (!is_string($value)) {
+				throw new InvalidObjectExeption('Object is invalid, value ' . $value . ' is not a string');
+			}
+		}
 	}
 
 	/**

diff --git a/lib/public/Activity/IEvent.php b/lib/public/Activity/IEvent.php
@@ -121,7 +121,7 @@ public function getParsedSubject(): string;
 	 * See https://github.com/nextcloud/server/issues/1706 for more information.
 	 *
 	 * @param string $subject
-	 * @param array $parameters
+	 * @param array<string, array<string, string>> $parameters
 	 * @return $this
 	 * @throws InvalidValueException if the subject or parameters are invalid
 	 * @since 11.0.0
@@ -136,7 +136,7 @@ public function setRichSubject(string $subject, array $parameters = []): self;
 	public function getRichSubject(): string;
 
 	/**
-	 * @return array[]
+	 * @return array<string, array<string, string>>
 	 * @since 11.0.0
 	 */
 	public function getRichSubjectParameters(): array;
@@ -187,7 +187,7 @@ public function getParsedMessage(): string;
 	 * See https://github.com/nextcloud/server/issues/1706 for more information.
 	 *
 	 * @param string $message
-	 * @param array $parameters
+	 * @param array<string, array<string, string>> $parameters
 	 * @return $this
 	 * @throws \InvalidArgumentException if the message or parameters are invalid
 	 * @since 11.0.0
@@ -202,7 +202,7 @@ public function setRichMessage(string $message, array $parameters = []): self;
 	public function getRichMessage(): string;
 
 	/**
-	 * @return array[]
+	 * @return array<string, array<string, string>>
 	 * @since 11.0.0
 	 */
 	public function getRichMessageParameters(): array;

diff --git a/lib/public/Notification/INotification.php b/lib/public/Notification/INotification.php
@@ -137,7 +137,7 @@ public function getParsedSubject(): string;
 	 * See https://github.com/nextcloud/server/issues/1706 for more information.
 	 *
 	 * @param string $subject
-	 * @param array $parameters
+	 * @param array<string, array<string, string>> $parameters
 	 * @return $this
 	 * @throws InvalidValueException if the subject or parameters are invalid
 	 * @since 11.0.0
@@ -213,7 +213,7 @@ public function getParsedMessage(): string;
 	 * See https://github.com/nextcloud/server/issues/1706 for more information.
 	 *
 	 * @param string $message
-	 * @param array $parameters
+	 * @param array<string, array<string, string>> $parameters
 	 * @return $this
 	 * @throws InvalidValueException if the message or parameters are invalid
 	 * @since 11.0.0

diff --git a/lib/public/SetupCheck/SetupResult.php b/lib/public/SetupCheck/SetupResult.php
@@ -45,6 +45,7 @@ class SetupResult implements \JsonSerializable {
 	/**
 	 * @brief Private constructor, use success()/info()/warning()/error() instead
 	 * @param self::SUCCESS|self::INFO|self::WARNING|self::ERROR $severity
+	 * @param array<string, array<string, string>> $descriptionParameters
 	 * @throws \OCP\RichObjectStrings\InvalidObjectExeption
 	 * @since 28.0.0
 	 * @since 28.0.2 Optional parameter ?array $descriptionParameters

diff --git a/tests/lib/RichObjectStrings/ValidatorTest.php b/tests/lib/RichObjectStrings/ValidatorTest.php
@@ -8,6 +8,7 @@
 
 use OC\RichObjectStrings\Validator;
 use OCP\RichObjectStrings\Definitions;
+use OCP\RichObjectStrings\InvalidObjectExeption;
 use Test\TestCase;
 
 class ValidatorTest extends TestCase {
@@ -33,5 +34,27 @@ public function test() {
 			],
 		]);
 		$this->addToAssertionCount(2);
+
+		$this->expectException(InvalidObjectExeption::class);
+
+		$this->expectExceptionMessage('Object is invalid, value 123 is not a string');
+		$v->validate('test {string1} test.', [
+			'string1' => [
+				'type' => 'user',
+				'id' => 'johndoe',
+				'name' => 'John Doe',
+				'key' => 123,
+			],
+		]);
+
+		$this->expectExceptionMessage('Object is invalid, key 456 is not a string');
+		$v->validate('test {string1} test.', [
+			'string1' => [
+				'type' => 'user',
+				'id' => 'johndoe',
+				'name' => 'John Doe',
+				456 => 'value',
+			],
+		]);
 	}
 }