feat: New kirby uuid:duplicates command

Author: bastianallgeier

commands/uuid/duplicates.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types = 1);
+
+use Kirby\CLI\Commands\UUID\Duplicates;
+
+return [
+	'description' => 'Find and optionally fix duplicate UUIDs',
+	'args' => [
+		'fix' => [
+			'description' => 'Fix duplicate UUIDs by generating new ones',
+			'noValue'     => true,
+		],
+	],
+	'command' => Duplicates::command(...)
+];

src/CLI/Commands/UUID/Duplicates.php

@@ -0,0 +1,90 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Kirby\CLI\Commands\UUID;
+
+use Kirby\CLI\CLI;
+use Kirby\Cms\ModelWithContent;
+use Kirby\Uuid\Uuid;
+
+class Duplicates
+{
+	protected static function check(CLI $cli, ModelWithContent $model, array &$uuids, array &$duplicates): void
+	{
+		$uuid = $model->content()->get('uuid');
+
+		if ($uuid->isEmpty() === true) {
+			return;
+		}
+
+		$uuid = $model->uuid()->toString();
+
+		// the UUID already exists for another model
+		if (isset($uuids[$uuid])) {
+			$duplicates[] = $uuid;
+
+			if ($cli->arg('fix') === true) {
+				$model->uuid()->clear();
+				$model->update([
+					'uuid' => Uuid::generate()
+				]);
+				$model->uuid()->populate(true);
+				$cli->print('✅ The duplicate UUID ' . $uuid . ' for ' . $model->id() . ' has been regenerated');
+			} else {
+				$cli->error('The UUID ' . $uuid . ' for ' . $model->id() . ' exists (' . $uuids[$uuid] . ')');
+			}
+		}
+
+		$uuids[$uuid] = $model->id();
+	}
+
+	public static function command(CLI $cli): void
+	{
+		$kirby = $cli->kirby();
+		$fix   = $cli->arg('fix');
+
+		if ($fix === true) {
+			$cli->confirmToContinue('Duplicate UUIDs will be removed and regenerated. This can break links in fields that use the UUID as reference. Do you want to continue?');
+		}
+
+		$uuids      = [];
+		$duplicates = [];
+		$site       = $kirby->site();
+
+		$kirby->impersonate('kirby');
+
+		// go through all site files
+		foreach ($site->files() as $file) {
+			static::check($cli, $file, $uuids, $duplicates);
+		}
+
+		// go through all pages
+		foreach ($site->index(drafts: true) as $page) {
+			static::check($cli, $page, $uuids, $duplicates);
+
+			// go through all files
+			foreach ($page->files() as $file) {
+				static::check($cli, $file, $uuids, $duplicates);
+			}
+		}
+
+		// go through all users
+		foreach ($cli->kirby()->users() as $user) {
+			static::check($cli, $user, $uuids, $duplicates);
+
+			// go through all files
+			foreach ($user->files() as $file) {
+				static::check($cli, $file, $uuids, $duplicates);
+			}
+		}
+
+		if (count($uuids) === 0) {
+			$cli->success('There are no UUID duplicates');
+		} elseif ($fix === true) {
+			$cli->success(count($duplicates) . ' duplicates have been fixed');
+		} else {
+			$cli->print(count($duplicates) . ' duplicates! You can fix them with kirby uuid:duplicates --fix');
+		}
+	}
+}