$field->toResolvedUrls()

getkirby · Nov 21, 2023 · c1ba8b1 · c1ba8b1
1 parent c9ebccc
commit c1ba8b1
Show file tree

Hide file tree

Showing 4 changed files with 129 additions and 11 deletions.
diff --git a/config/methods.php b/config/methods.php
@@ -19,9 +19,12 @@
 use Kirby\Exception\InvalidArgumentException;
 use Kirby\Exception\NotFoundException;
 use Kirby\Image\QrCode;
+use Kirby\Toolkit\A;
+use Kirby\Toolkit\Dom;
 use Kirby\Toolkit\Str;
 use Kirby\Toolkit\V;
 use Kirby\Toolkit\Xml;
+use Kirby\Uuid\Uuid;
 
 /**
  * Field method setup
@@ -247,6 +250,34 @@
 			return $field->isNotEmpty() ? new QrCode($field->value) : null;
 		},
 
+		/**
+		 * Parses the field value as DOM and replaces
+		 * any permalinks in href/src attributes with
+		 * the regular url
+		 */
+		'toResolvedUrls' => function (Field $field): Field {
+			if ($field->isNotEmpty() === true) {
+				$dom        = new Dom($field->value);
+				$attributes = ['href', 'src'];
+				$elements   = $dom->query('//*[' . implode(' | ', A::map($attributes, fn ($attribute) => '@' . $attribute)) . ']');
+
+				foreach ($elements as $element) {
+					foreach ($attributes as $attribute) {
+						if ($url = $element->getAttribute($attribute)) {
+							if ($uuid = Uuid::for($url)) {
+								$url = $uuid->model()->url();
+								$element->setAttribute($attribute, $url);
+							}
+						}
+					}
+				}
+
+				$field->value = $dom->toString();
+			}
+
+			return $field;
+		},
+
 		/**
 		 * Converts a yaml field to a Structure object
 		 */

diff --git a/src/Uuid/Uuid.php b/src/Uuid/Uuid.php
@@ -162,16 +162,30 @@ final public static function for(
 
 		// for UUID string
 		if (is_string($seed) === true) {
-			return match (Str::before($seed, '://')) {
-				'page'   => new PageUuid(uuid: $seed, context: $context),
-				'file'   => new FileUuid(uuid: $seed, context: $context),
-				'site'   => new SiteUuid(uuid: $seed, context: $context),
-				'user'   => new UserUuid(uuid: $seed, context: $context),
-				// TODO: activate for uuid-block-structure-support
-				// 'block'  => new BlockUuid(uuid: $seed, context: $context),
-				// 'struct' => new StructureUuid(uuid: $seed, context: $context),
-				default  => throw new InvalidArgumentException('Invalid UUID URI: ' . $seed)
-			};
+			if ($uri = Str::before($seed, '://')) {
+				return match ($uri) {
+					'page'   => new PageUuid(uuid: $seed, context: $context),
+					'file'   => new FileUuid(uuid: $seed, context: $context),
+					'site'   => new SiteUuid(uuid: $seed, context: $context),
+					'user'   => new UserUuid(uuid: $seed, context: $context),
+					// TODO: activate for uuid-block-structure-support
+					// 'block'  => new BlockUuid(uuid: $seed, context: $context),
+					// 'struct' => new StructureUuid(uuid: $seed, context: $context),
+					default  => throw new InvalidArgumentException('Invalid UUID URI: ' . $seed)
+				};
+			}
+
+			// permalinks
+			if ($url = Str::after($seed, '/@/')) {
+				$parts = explode('/', $url);
+
+				return static::for(
+					$parts[0] . '://' . $parts[1],
+					$context
+				);
+			}
+
+			throw new InvalidArgumentException('Invalid UUID string: ' . $seed);
 		}
 
 		// for model object

diff --git a/tests/Content/FieldMethodsTest.php b/tests/Content/FieldMethodsTest.php
@@ -389,6 +389,39 @@ public function testToQrCode()
 		$this->assertNull($this->field()->toQrCode());
 	}
 
+	public function testToResolvedUrls()
+	{
+		$app = new App([
+			'roots' => [
+				'index' => $this->tmp
+			],
+			'site' => [
+				'children' => [
+					[
+						'slug' => 'a',
+						'content' => [
+							'uuid' => 'my-page'
+						],
+						'files' => [
+							[
+								'filename' => 'test.jpg',
+								'content' => [
+									'uuid'  => 'my-file',
+								]
+							]
+						]
+					],
+				]
+			]
+		]);
+
+		$field  = $this->field('<p>This is a <a href="/@/page/my-page">test</a><img src="/@/file/my-file"></p>');
+		$result = $field->toResolvedUrls();
+		$hash   = $app->file('a/test.jpg')->mediaHash();
+
+		$this->assertSame('<p>This is a <a href="/a">test</a><img src="/media/pages/a/' . $hash . '/test.jpg"></p>', (string)$result);
+	}
+
 	public function testToStructure()
 	{
 		$data = [
@@ -440,7 +473,7 @@ public function testToDefaultUrl()
 		$this->assertSame($expected, $field->toUrl());
 	}
 
-	public function testToCustomUrl()
+	public function testToUrlCustom()
 	{
 		$app = new App([
 			'roots' => [

diff --git a/tests/Uuid/UuidTest.php b/tests/Uuid/UuidTest.php
@@ -3,6 +3,7 @@
 namespace Kirby\Uuid;
 
 use Generator;
+use Kirby\Exception\InvalidArgumentException;
 use Kirby\Exception\LogicException;
 use Kirby\Toolkit\Str;
 
@@ -161,6 +162,45 @@ public function testForUuidString()
 		// $this->assertInstanceOf(StructureUuid::class, Uuid::for('struct://my-id'));
 	}
 
+	/**
+	 * @covers ::for
+	 */
+	public function testForUuidStringInvalid()
+	{
+		$this->expectException(InvalidArgumentException::class);
+		$this->expectExceptionMessage('Invalid UUID URI: foo://my-id');
+		Uuid::for('foo://my-id');
+	}
+
+	/**
+	 * @covers ::for
+	 */
+	public function testForPermalinkString()
+	{
+		$this->assertInstanceOf(PageUuid::class, Uuid::for('/@/page/my-id'));
+		$this->assertInstanceOf(FileUuid::class, Uuid::for('/@/file/my-id'));
+	}
+
+	/**
+	 * @covers ::for
+	 */
+	public function testForPermalinkStringInvalid()
+	{
+		$this->expectException(InvalidArgumentException::class);
+		$this->expectExceptionMessage('Invalid UUID URI: foo://my-id');
+		Uuid::for('/@/foo/my-id');
+	}
+
+	/**
+	 * @covers ::for
+	 */
+	public function testForStringInvalid()
+	{
+		$this->expectException(InvalidArgumentException::class);
+		$this->expectExceptionMessage('Invalid UUID string: foo˜bar');
+		Uuid::for('foo˜bar');
+	}
+
 	/**
 	 * @covers ::for
 	 */