From 7f3e1229003a16c66f30f0d5df66566c41eff977 Mon Sep 17 00:00:00 2001
From: Ferdinand Thiessen <opensource@fthiessen.de>
Date: Fri, 3 Apr 2026 21:12:35 +0200
Subject: [PATCH] refactor(files): modernize transfer ownership settings

- related to https://github.com/nextcloud/server/issues/57008

Modernize the personal files settings for ownership transfer.
- Use the new `NcForm*` components.
- Use `NcSettingsSection` as root component
- Migrate to Typescript
- Migrate to script-setup

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
---
 .../files/src/components/PersonalSettings.vue |  22 +-
 .../components/TransferOwnershipDialogue.vue  | 408 ++++++++----------
 apps/files_sharing/lib/Capabilities.php       |   2 +
 3 files changed, 197 insertions(+), 235 deletions(-)

diff --git a/apps/files/src/components/PersonalSettings.vue b/apps/files/src/components/PersonalSettings.vue
index b076b0c1e3df8..0a5043686359f 100644
--- a/apps/files/src/components/PersonalSettings.vue
+++ b/apps/files/src/components/PersonalSettings.vue
@@ -3,20 +3,14 @@
   - SPDX-License-Identifier: AGPL-3.0-or-later
 -->
 
+<script setup lang="ts">
+import { t } from '@nextcloud/l10n'
+import { NcSettingsSection } from '@nextcloud/vue'
+import TransferOwnershipDialogue from './TransferOwnershipDialogue.vue'
+</script>
+
 <template>
-	<div id="files-personal-settings" class="section">
-		<h2>{{ t('files', 'Files') }}</h2>
+	<NcSettingsSection :name="t('files', 'Files')">
 		<TransferOwnershipDialogue />
-	</div>
+	</NcSettingsSection>
 </template>
-
-<script>
-import TransferOwnershipDialogue from './TransferOwnershipDialogue.vue'
-
-export default {
-	name: 'PersonalSettings',
-	components: {
-		TransferOwnershipDialogue,
-	},
-}
-</script>
diff --git a/apps/files/src/components/TransferOwnershipDialogue.vue b/apps/files/src/components/TransferOwnershipDialogue.vue
index f915c44373c55..c474187c38b76 100644
--- a/apps/files/src/components/TransferOwnershipDialogue.vue
+++ b/apps/files/src/components/TransferOwnershipDialogue.vue
@@ -3,245 +3,211 @@
   - SPDX-License-Identifier: AGPL-3.0-or-later
 -->
 
-<template>
-	<div>
-		<h3>{{ t('files', 'Transfer ownership of a file or folder') }} </h3>
-		<form @submit.prevent="submit">
-			<p class="transfer-select-row">
-				<span>{{ readableDirectory }}</span>
-				<NcButton
-					v-if="directory === undefined"
-					class="transfer-select-row__choose_button"
-					@click.prevent="start">
-					{{ t('files', 'Choose file or folder to transfer') }}
-				</NcButton>
-				<NcButton v-else @click.prevent="start">
-					{{ t('files', 'Change') }}
-				</NcButton>
-			</p>
-			<p class="new-owner">
-				<label for="targetUser">
-					<span>{{ t('files', 'New owner') }}</span>
-				</label>
-				<NcSelect
-					v-model="selectedUser"
-					input-id="targetUser"
-					:options="formatedUserSuggestions"
-					:multiple="false"
-					:loading="loadingUsers"
-					:user-select="true"
-					@search="findUserDebounced" />
-			</p>
-			<p>
-				<NcButton
-					type="submit"
-					variant="primary"
-					:disabled="!canSubmit">
-					{{ submitButtonText }}
-				</NcButton>
-			</p>
-		</form>
-	</div>
-</template>
-
-<script>
-import axios from '@nextcloud/axios'
-import { getFilePickerBuilder, showError, showSuccess } from '@nextcloud/dialogs'
+<script setup lang="ts">
+import type { INode } from '@nextcloud/files'
+import type { OCSResponse } from '@nextcloud/typings/ocs'
+import type { NcSelectUsersModel } from '@nextcloud/vue/components/NcSelectUsers'
+
+import { mdiFolderOutline } from '@mdi/js'
+import { getCurrentUser } from '@nextcloud/auth'
+import axios, { isAxiosError } from '@nextcloud/axios'
+import { getCapabilities } from '@nextcloud/capabilities'
+import { FilePickerClosed, getFilePickerBuilder, showError, showSuccess } from '@nextcloud/dialogs'
+import { t } from '@nextcloud/l10n'
 import { generateOcsUrl } from '@nextcloud/router'
-import debounce from 'debounce'
-import Vue from 'vue'
+import { NcFormBox, NcFormBoxButton, NcFormGroup, NcIconSvgWrapper, NcSelectUsers } from '@nextcloud/vue'
+import { useDebounceFn } from '@vueuse/core'
+import { computed, onBeforeMount, ref } from 'vue'
 import NcButton from '@nextcloud/vue/components/NcButton'
-import NcSelect from '@nextcloud/vue/components/NcSelect'
 import logger from '../logger.ts'
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const minSearchStringLength = (getCapabilities() as any).files_sharing.sharee.minSearchStringLength
 const picker = getFilePickerBuilder(t('files', 'Choose a file or folder to transfer'))
-	.setMultiSelect(false)
-	.setType(1)
 	.allowDirectories()
+	.setMultiSelect(false)
+	.setButtonFactory(([node]) => {
+		const canPick = !!node?.path && node.path !== '/' && node.owner === getCurrentUser()!.uid
+		return [{
+			label: canPick
+				? t('files', 'Transfer "{path}"', { path: node.displayname })
+				: t('files', 'Select file or folder'),
+			callback: () => {},
+			disabled: !canPick,
+			variant: 'primary',
+		}]
+	})
 	.build()
 
-export default {
-	name: 'TransferOwnershipDialogue',
-	components: {
-		NcSelect,
-		NcButton,
-	},
-
-	data() {
-		return {
-			directory: undefined,
-			directoryPickerError: undefined,
-			submitError: undefined,
-			loadingUsers: false,
-			selectedUser: null,
-			userSuggestions: {},
-			config: {
-				minSearchStringLength: parseInt(OC.config['sharing.minSearchStringLength'], 10) || 0,
-			},
+const nodeForTransfer = ref<INode>()
+const loadingUsers = ref(false)
+const selectedUser = ref<NcSelectUsersModel>()
+const userSuggestions = ref<NcSelectUsersModel[]>([])
+
+const canSubmit = computed(() => !!nodeForTransfer.value && !!selectedUser.value)
+
+const submitButtonText = computed(() => {
+	if (!nodeForTransfer.value || !selectedUser.value) {
+		return t('files', 'Transfer')
+	}
+	return t('files', 'Transfer {path} to {userid}', { path: nodeForTransfer.value!.displayname, userid: selectedUser.value!.displayName })
+})
+
+onBeforeMount(() => searchUsers(''))
+
+/**
+ * Open the file picker to choose a file or folder for which the ownership should be transferred.
+ */
+async function chooseNodeForTransfer() {
+	try {
+		const [node] = await picker.pickNodes()
+		nodeForTransfer.value = node
+	} catch (error) {
+		if (error instanceof FilePickerClosed) {
+			logger.debug('Selecting object for transfer aborted', { error })
+			return
 		}
-	},
-
-	computed: {
-		canSubmit() {
-			return !!this.directory && !!this.selectedUser
-		},
-
-		formatedUserSuggestions() {
-			return Object.keys(this.userSuggestions).map((uid) => {
-				const user = this.userSuggestions[uid]
-				return {
-					user: user.uid,
-					displayName: user.displayName,
-					icon: 'icon-user',
-					subname: user.shareWithDisplayNameUnique,
-				}
-			})
-		},
-
-		submitButtonText() {
-			if (!this.canSubmit) {
-				return t('files', 'Transfer')
-			}
-			const components = this.readableDirectory.split('/')
-			return t('files', 'Transfer {path} to {userid}', { path: components[components.length - 1], userid: this.selectedUser.displayName })
-		},
-
-		readableDirectory() {
-			if (!this.directory) {
-				return ''
-			}
-			return this.directory.substring(1)
-		},
-	},
-
-	created() {
-		this.findUserDebounced = debounce(this.findUser, 300)
-		this.findUser('')
-	},
-
-	methods: {
-		start() {
-			this.directoryPickerError = undefined
-
-			picker.pick()
-				.then((dir) => dir === '' ? '/' : dir)
-				.then((dir) => {
-					logger.debug(`path ${dir} selected for transferring ownership`)
-					if (!dir.startsWith('/')) {
-						throw new Error(t('files', 'Invalid path selected'))
-					}
-					// /ocs/v2.php/apps/files/api/v1/transferownership
-					// /ocs/v2.php/apps/files/api/v1/transferownership
-					this.directory = dir
-				}).catch((error) => {
-					logger.error(`Selecting object for transfer aborted: ${error.message || 'Unknown error'}`, { error })
-
-					this.directoryPickerError = error.message || t('files', 'Unknown error')
-					showError(this.directoryPickerError)
-				})
-		},
-
-		async findUser(query) {
-			this.query = query.trim()
-
-			if (query.length < this.config.minSearchStringLength) {
-				return
-			}
-
-			this.loadingUsers = true
-			try {
-				const response = await axios.get(generateOcsUrl('apps/files_sharing/api/v1/sharees'), {
-					params: {
-						format: 'json',
-						itemType: 'file',
-						search: query,
-						perPage: 20,
-						lookup: false,
-					},
-				})
-
-				this.userSuggestions = {}
-				response.data.ocs.data.exact.users.concat(response.data.ocs.data.users).forEach((user) => {
-					Vue.set(this.userSuggestions, user.value.shareWith, {
-						uid: user.value.shareWith,
-						displayName: user.label,
-						shareWithDisplayNameUnique: user.shareWithDisplayNameUnique,
-					})
-				})
-			} catch (error) {
-				logger.error('could not fetch users', { error })
-			} finally {
-				this.loadingUsers = false
-			}
-		},
-
-		submit() {
-			if (!this.canSubmit) {
-				logger.warn('ignoring form submit')
-			}
-
-			this.submitError = undefined
-			const data = {
-				path: this.directory,
-				recipient: this.selectedUser.user,
-			}
-			logger.debug('submit transfer ownership form', data)
-
-			const url = generateOcsUrl('apps/files/api/v1/transferownership')
-
-			axios.post(url, data)
-				.then((resp) => resp.data)
-				.then((data) => {
-					logger.info('Transfer ownership request sent', { data })
-
-					this.directory = undefined
-					this.selectedUser = null
-					showSuccess(t('files', 'Ownership transfer request sent'))
-				})
-				.catch((error) => {
-					logger.error('Could not send ownership transfer request', { error })
-
-					if (error?.response?.status === 403) {
-						this.submitError = t('files', 'Cannot transfer ownership of a file or folder you do not own')
-					} else {
-						this.submitError = error.message || t('files', 'Unknown error')
-					}
-					showError(this.submitError)
-				})
-		},
-	},
-}
-</script>
 
-<style scoped lang="scss">
-p {
-	margin-top: 12px;
-	margin-bottom: 12px;
+		nodeForTransfer.value = undefined
+		logger.error('Error while opening file picker for transfer ownership', { error })
+		showError(t('files', 'Error while opening file picker for transfer ownership'))
+		return
+	}
 }
 
-.new-owner {
-	display: flex;
-	flex-direction: column;
-	max-width: 400px;
-
-	label {
-		display: flex;
-		align-items: center;
-		margin-bottom: calc(var(--default-grid-baseline) * 2);
+const searchUsersDebounced = useDebounceFn(searchUsers, 500)
+
+/**
+ * Handle the user search input and fetch matching users from the server.
+ *
+ * @param query - The search string entered by the user
+ */
+async function searchUsers(query: string) {
+	query = query.trim()
+	if (query.length < minSearchStringLength) {
+		return
+	}
 
-		span {
-			margin-inline-end: 8px;
-		}
+	loadingUsers.value = true
+	try {
+		const response = await axios.get<OCSResponse>(generateOcsUrl('apps/files_sharing/api/v1/sharees'), {
+			params: {
+				format: 'json',
+				itemType: 'file',
+				search: query,
+				perPage: 20,
+				lookup: false,
+			},
+		})
+
+		const data = [...response.data.ocs.data.exact.users, ...response.data.ocs.data.users]
+		userSuggestions.value = data.map((user) => ({
+			displayName: user.label,
+			id: user.value.shareWith,
+			user: user.value.shareWith,
+			subname: user.shareWithDisplayNameUnique,
+		} as NcSelectUsersModel))
+	} catch (error) {
+		logger.error('could not fetch users', { error })
+		showError(t('files', 'Error while searching for users'))
+	} finally {
+		loadingUsers.value = false
 	}
 }
 
-.transfer-select-row {
-	span {
-		margin-inline-end: 8px;
+/**
+ * Handle submit of the ownership transfer.
+ */
+async function submit() {
+	if (!canSubmit.value) {
+		logger.warn('ignoring form submit')
 	}
 
-	&__choose_button {
-		width: min(100%, 400px) !important;
+	const requestParameters = {
+		path: nodeForTransfer.value?.path,
+		recipient: selectedUser.value?.user,
+	}
+	logger.debug('submit transfer ownership form', { requestParameters })
+
+	try {
+		const url = generateOcsUrl('apps/files/api/v1/transferownership')
+		const { data } = await axios.post(url, requestParameters)
+		logger.info('Transfer ownership request sent', { data })
+
+		nodeForTransfer.value = undefined
+		selectedUser.value = undefined
+		showSuccess(t('files', 'Ownership transfer request sent'))
+	} catch (error) {
+		logger.error('Could not send ownership transfer request', { error })
+
+		if (isAxiosError(error) && error.response?.status === 403) {
+			showError(t('files', 'Cannot transfer ownership of a file or folder you do not own'))
+		} else {
+			showError(t('files', 'Error while sending ownership transfer request'))
+		}
 	}
 }
+</script>
+
+<template>
+	<form @submit.prevent="submit">
+		<NcFormGroup
+			:class="$style.transferOwnership__group"
+			:label="t('files', 'Transfer ownership of a file or folder')">
+			<NcFormBox v-slot="{ itemClass }">
+				<NcFormBoxButton
+					invertedAccent
+					:label="t('files', 'File or folder to transfer')"
+					:description="nodeForTransfer?.displayname ?? t('files', 'No file or folder selected')"
+					@click="chooseNodeForTransfer">
+					<template #icon>
+						<NcIconSvgWrapper :path="mdiFolderOutline" />
+					</template>
+				</NcFormBoxButton>
+
+				<div :class="[itemClass, $style.transferOwnership__newOwner]">
+					<NcSelectUsers
+						v-model="selectedUser"
+						:class="$style.transferOwnership__newOwnerSelect"
+						:inputLabel="t('files', 'New owner')"
+						:loading="loadingUsers"
+						:options="userSuggestions"
+						@search="searchUsersDebounced" />
+				</div>
+
+				<NcButton
+					:disabled="!canSubmit"
+					type="submit"
+					variant="primary"
+					wide>
+					{{ submitButtonText }}
+				</NcButton>
+			</NcFormBox>
+
+			<p class="hidden-visually" aria-live="polite">
+				<span v-if="!nodeForTransfer">{{ t('files', 'You need to select a file or folder to transfer ownership.') }}</span>
+				<span v-if="!selectedUser">{{ t('files', 'You need to select a new owner for the file or folder.') }}</span>
+			</p>
+		</NcFormGroup>
+	</form>
+</template>
+
+<style module>
+.transferOwnership__group {
+	max-width: 512px;
+}
+
+.transferOwnership__newOwner {
+	background-color: var(--color-primary-element-light);
+	padding-block: var(--default-grid-baseline);
+	padding-inline: calc(var(--border-radius-element) + var(--default-grid-baseline));
+}
+
+.transferOwnership__newOwnerSelect {
+	width: 100%;
+}
+
+.transferOwnership__newOwner :global(.vs--open .vs__dropdown-toggle) {
+	background-color: var(--color-main-background);
+}
 </style>
diff --git a/apps/files_sharing/lib/Capabilities.php b/apps/files_sharing/lib/Capabilities.php
index 7b911cb74ddaf..ca29820430737 100644
--- a/apps/files_sharing/lib/Capabilities.php
+++ b/apps/files_sharing/lib/Capabilities.php
@@ -90,6 +90,7 @@ public function __construct(
 	 *             },
 	 *         },
 	 *         sharee: array{
+	 *             minSearchStringLength: int,
 	 *             query_lookup_default: bool,
 	 *             always_show_unique: bool,
 	 *         },
@@ -185,6 +186,7 @@ public function getCapabilities() {
 
 		// Sharee searches
 		$res['sharee'] = [
+			'minSearchStringLength' => $this->config->getSystemValueInt('sharing.minSearchStringLength', 0),
 			'query_lookup_default' => $this->config->getSystemValueBool('gs.enabled', false),
 			'always_show_unique' => $this->config->getAppValue('files_sharing', 'always_show_unique', 'yes') === 'yes',
 		];