Unlock button and dialog

config/api/routes/changes.php

@@ -34,4 +34,13 @@
 			);
 		}
 	],
+	[
+		'pattern' => '(:all)/changes/unlock',
+		'method'  => 'POST',
+		'action'  => function (string $path) {
+			return Changes::unlock(
+				model: Find::parent($path),
+			);
+		}
+	]
 ];

i18n/translations/en.json

@@ -99,6 +99,8 @@
 	"error.content.lock.replace": "The version is locked and cannot be replaced",
 	"error.content.lock.update": "The version is locked and cannot be updated",
 
+	"error.content.unlock.invalidVersion": "Only the changes version can be unlocked",
+
 	"error.entries.max.plural": "You must not add more than {max} entries",
 	"error.entries.max.singular": "You must not add more than one entry",
 	"error.entries.min.plural": "You must add at least {min} entries",
@@ -140,6 +142,7 @@
 	"error.file.type.forbidden": "You are not allowed to upload {type} files",
 	"error.file.type.invalid": "Invalid file type: {type}",
 	"error.file.undefined": "The file cannot be found",
+	"error.file.unlock.permission": "You are not allowed to unlock the content of the file",
 
 	"error.form.incomplete": "Please fix all form errors…",
 	"error.form.notSaved": "The form could not be saved",
@@ -199,6 +202,7 @@
 	"error.page.sort.permission": "The page \"{slug}\" cannot be sorted",
 	"error.page.status.invalid": "Please set a valid page status",
 	"error.page.undefined": "The page cannot be found",
+	"error.page.unlock.permission": "You are not allowed to unlock the content for the page",
 	"error.page.update.permission": "You are not allowed to update \"{slug}\"",
 
 	"error.section.files.max.plural": "You must not add more than {max} files to the \"{section}\" section",
@@ -216,6 +220,7 @@
 
 	"error.site.changeTitle.empty": "The title must not be empty",
 	"error.site.changeTitle.permission": "You are not allowed to change the title of the site",
+	"error.site.unlock.permission": "You are not allowed to unlock the content of the site",
 	"error.site.update.permission": "You are not allowed to update the site",
 
 	"error.structure.validation": "There's an error on the \"{field}\" field in row {index}",
@@ -247,6 +252,7 @@
 	"error.user.password.wrong": "Wrong password",
 	"error.user.role.invalid": "Please enter a valid role",
 	"error.user.undefined": "The user cannot be found",
+	"error.user.unlock.permission": "You are not allowed to unlock the content of the user",
 	"error.user.update.permission": "You are not allowed to update the user \"{name}\"",
 
 	"error.validation.accepted": "Please confirm",
@@ -508,6 +514,7 @@
 	"lock.unsaved.users": "Unsaved accounts",
 	"lock.isLocked": "Unsaved changes by {email}",
 	"lock.unlock": "Unlock",
+	"lock.unlock.confirm": "You will take over the changes from <strong>{{ email }}</strong>. They will then be unable to edit the content.",
 	"lock.unlock.submit": "Unlock and overwrite unsaved changes by <strong>{email}</strong>",
 	"lock.isUnlocked": "Was unlocked by another user",
 

panel/src/components/Forms/FormControls.vue

@@ -47,6 +47,12 @@
 					{{ $t("form.preview") }}
 				</k-dropdown-item>
 			</template>
+			<template v-if="isLocked && isUnlockable">
+				<hr />
+				<k-dropdown-item icon="lock" @click="unlock">
+					{{ $t("lock.unlock") }}
+				</k-dropdown-item>
+			</template>
 		</k-dropdown-content>
 	</div>
 </template>
@@ -58,6 +64,7 @@ export const props = {
 		hasDiff: Boolean,
 		isLocked: Boolean,
 		isProcessing: Boolean,
+		isUnlockable: Boolean,
 		modified: [String, Date],
 		/**
 		 * Preview URL for changes
@@ -76,7 +83,7 @@ export const props = {
  */
 export default {
 	mixins: [props],
-	emits: ["discard", "submit"],
+	emits: ["discard", "submit", "unlock"],
 	computed: {
 		buttons() {
 			if (this.isLocked === true) {
@@ -138,6 +145,28 @@ export default {
 					}
 				}
 			});
+		},
+		unlock() {
+			this.$panel.dialog.open({
+				component: "k-text-dialog",
+				props: {
+					size: "small",
+					submitButton: {
+						icon: "lock",
+						theme: "negative",
+						text: this.$t("lock.unlock")
+					},
+					text: this.$t("lock.unlock.confirm", {
+						email: this.editor
+					})
+				},
+				on: {
+					submit: () => {
+						this.$panel.dialog.close();
+						this.$emit("unlock");
+					}
+				}
+			});
 		}
 	}
 };

panel/src/components/Views/Files/FileView.vue

@@ -23,9 +23,11 @@
 					:has-diff="hasDiff"
 					:is-locked="isLocked"
 					:is-processing="isSaving"
+					:is-unlockable="permissions.unlock"
 					:modified="modified"
 					@discard="onDiscard"
 					@submit="onSubmit"
+					@unlock="onUnlock"
 				/>
 			</template>
 		</k-header>

panel/src/components/Views/ModelView.vue

@@ -98,6 +98,14 @@ export default {
 
 			this.$panel.view.refresh();
 		},
+		async onUnlock() {
+			await this.$panel.content.unlock({
+				api: this.api,
+				language: this.$panel.language.code
+			});
+
+			this.$panel.view.refresh();
+		},
 		onInput(values) {
 			// update the content for the current view
 			// this will also refresh the content prop

panel/src/components/Views/Pages/PageView.vue

@@ -23,10 +23,12 @@
 					:has-diff="hasDiff"
 					:is-locked="isLocked"
 					:is-processing="isSaving"
+					:is-unlockable="permissions.unlock"
 					:modified="modified"
 					:preview="permissions.preview ? api + '/preview/changes' : false"
 					@discard="onDiscard"
 					@submit="onSubmit"
+					@unlock="onUnlock"
 				/>
 			</template>
 		</k-header>

panel/src/components/Views/Pages/SiteView.vue

@@ -27,10 +27,12 @@
 					:has-diff="hasDiff"
 					:is-locked="isLocked"
 					:is-processing="isSaving"
+					:is-unlockable="permissions.unlock"
 					:modified="modified"
 					:preview="permissions.preview ? api + '/preview/changes' : false"
 					@discard="onDiscard"
 					@submit="onSubmit"
+					@unlock="onUnlock"
 				/>
 			</template>
 		</k-header>

panel/src/components/Views/Users/UserView.vue

@@ -31,9 +31,11 @@
 					:has-diff="hasDiff"
 					:is-locked="isLocked"
 					:is-processing="isSaving"
+					:is-unlockable="permissions.unlock"
 					:modified="modified"
 					@discard="onDiscard"
 					@submit="onSubmit"
+					@unlock="onUnlock"
 				/>
 			</template>
 		</k-header>

panel/src/panel/content.js

@@ -323,6 +323,35 @@ export default (panel) => {
 		 */
 		saveAbortController: null,
 
+		/**
+		 * Unlocks the content for the current editor
+		 */
+		async unlock(env = {}) {
+			if (this.isProcessing === true) {
+				return;
+			}
+
+			// Only discard changes from the current view
+			if (this.isCurrent(env) === false) {
+				throw new Error("Cannot unlock content from another view");
+			}
+
+			// Check the lock state to determine if we can unlock
+			if (this.isLocked(env) === false) {
+				throw new Error("The content is not locked");
+			}
+
+			// Start processing the request
+			this.isProcessing = true;
+
+			try {
+				await this.request("unlock", {}, env);
+				this.emit("unlock", {}, env);
+			} finally {
+				this.isProcessing = false;
+			}
+		},
+
 		/**
 		 * Updates the form values of the current view
 		 */

src/Api/Controller/Changes.php

@@ -134,4 +134,16 @@ public static function save(ModelWithContent $model, array $input): array
 			'status' => 'ok'
 		];
 	}
+
+	/**
+	 * Unlocks the content for the current user
+	 */
+	public static function unlock(ModelWithContent $model): array
+	{
+		$model->version('changes')->unlock();
+
+		return [
+			'status' => 'ok'
+		];
+	}
 }

src/Cms/FileBlueprint.php

@@ -42,6 +42,7 @@ public function __construct(array $props)
 				'read'       	 => null,
 				'replace'    	 => null,
 				'sort'           => null,
+				'unlock'         => null,
 				'update'     	 => null,
 			]
 		);

src/Cms/PageBlueprint.php

@@ -39,6 +39,7 @@ public function __construct(array $props)
 				'preview'        => null,
 				'read'           => null,
 				'sort'           => null,
+				'unlock'         => null,
 				'update'         => null,
 			],
 			// aliases (from v2)

src/Cms/Permissions.php

@@ -38,6 +38,7 @@ class Permissions
 			'read'           => true,
 			'replace'        => true,
 			'sort'           => true,
+			'unlock'         => true,
 			'update'         => true
 		],
 		'languages' => [
@@ -59,10 +60,12 @@ class Permissions
 			'preview'        => true,
 			'read'           => true,
 			'sort'           => true,
+			'unlock'         => true,
 			'update'         => true
 		],
 		'site' => [
 			'changeTitle' => true,
+			'unlock'      => true,
 			'update'      => true
 		],
 		'users' => [
@@ -73,6 +76,7 @@ class Permissions
 			'changeRole'     => true,
 			'create'         => true,
 			'delete'         => true,
+			'unlock'         => true,
 			'update'         => true
 		],
 		'user' => [
@@ -82,6 +86,7 @@ class Permissions
 			'changePassword' => true,
 			'changeRole'     => true,
 			'delete'         => true,
+			'unlock'         => true,
 			'update'         => true
 		]
 	];

src/Cms/SiteBlueprint.php

@@ -28,6 +28,7 @@ public function __construct(array $props)
 			// defaults
 			[
 				'changeTitle' => null,
+				'unlock'      => null,
 				'update'      => null,
 			],
 			// aliases

src/Cms/UserBlueprint.php

@@ -39,6 +39,7 @@ public function __construct(array $props)
 				'changePassword' => null,
 				'changeRole'     => null,
 				'delete'         => null,
+				'unlock'         => null,
 				'update'         => null,
 			]
 		);

src/Content/Version.php

@@ -684,4 +684,29 @@ protected function urlWithQueryParams(string $baseUrl, string $token): string
 
 		return $uri->toString();
 	}
+
+	/**
+	 * Unlocks the content for the current user
+	 */
+	public function unlock(Language|string $language = 'default'): void
+	{
+		$language = Language::ensure($language);
+
+		// check if unlocking is allowed
+		VersionRules::unlock($this, $language);
+
+		// get the previous state to not lose any changes
+		$fields = $this->read($language);
+
+		// update the version with the previous state
+		$this->model->storage()->update(
+			versionId: $this->id,
+			language: $language,
+			fields: $this->prepareFieldsBeforeWrite($fields, $language)
+		);
+
+		// remove the version from the cache to read
+		// a fresh version next time
+		VersionCache::remove($this, $language);
+	}
 }

src/Content/VersionRules.php

@@ -5,6 +5,7 @@
 use Kirby\Cms\Language;
 use Kirby\Exception\LogicException;
 use Kirby\Exception\NotFoundException;
+use Kirby\Exception\PermissionException;
 
 /**
  * The VersionRules class handles the validation for all
@@ -144,6 +145,25 @@ public static function touch(
 		static::ensure($version, $language);
 	}
 
+	public static function unlock(
+		Version $version,
+		Language $language
+	): void {
+		static::ensure($version, $language);
+
+		if ($version->id()->is('changes') === false) {
+			throw new LogicException(
+				key: 'content.unlock.invalidVersion'
+			);
+		}
+
+		if ($version->model()->permissions()->can('unlock') !== true) {
+			throw new PermissionException(
+				key: $version->model()::CLASS_ALIAS . '.unlock.permission',
+			);
+		}
+	}
+
 	public static function update(
 		Version $version,
 		array $fields,