-
-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #46774 from nextcloud/backport/46767/stable29
- Loading branch information
Showing
8 changed files
with
211 additions
and
198 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,226 +1,157 @@ | ||
<!-- | ||
- @copyright Copyright (c) 2024 Ferdinand Thiessen <opensource@fthiessen.de> | ||
- | ||
- @author Ferdinand Thiessen <opensource@fthiessen.de> | ||
- | ||
- @license AGPL-3.0-or-later | ||
- | ||
- This program is free software: you can redistribute it and/or modify | ||
- it under the terms of the GNU Affero General Public License as | ||
- published by the Free Software Foundation, either version 3 of the | ||
- License, or (at your option) any later version. | ||
- | ||
- This program is distributed in the hope that it will be useful, | ||
- but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
- GNU Affero General Public License for more details. | ||
- | ||
- You should have received a copy of the GNU Affero General Public License | ||
- along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
- | ||
--> | ||
- SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors | ||
- SPDX-License-Identifier: AGPL-3.0-or-later | ||
--> | ||
<template> | ||
<NcDialog :name="name" | ||
<NcDialog data-cy-files-new-node-dialog | ||
:name="name" | ||
:open="open" | ||
close-on-click-outside | ||
out-transition | ||
@update:open="onClose"> | ||
@update:open="emit('close', null)"> | ||
<template #actions> | ||
<NcButton type="primary" | ||
:disabled="!isUniqueName" | ||
@click="onCreate"> | ||
<NcButton data-cy-files-new-node-dialog-submit | ||
type="primary" | ||
:disabled="validity !== ''" | ||
@click="submit"> | ||
{{ t('files', 'Create') }} | ||
</NcButton> | ||
</template> | ||
<form @submit.prevent="onCreate"> | ||
<NcTextField ref="input" | ||
class="dialog__input" | ||
:error="!isUniqueName" | ||
:helper-text="errorMessage" | ||
<form ref="formElement" | ||
class="new-node-dialog__form" | ||
@submit.prevent="emit('close', localDefaultName)"> | ||
<NcTextField ref="nameInput" | ||
data-cy-files-new-node-dialog-input | ||
:error="validity !== ''" | ||
:helper-text="validity" | ||
:label="label" | ||
:value.sync="localDefaultName" | ||
@keyup="checkInputValidity" /> | ||
:value.sync="localDefaultName" /> | ||
</form> | ||
</NcDialog> | ||
</template> | ||
|
||
<script lang="ts"> | ||
import type { PropType } from 'vue' | ||
import { defineComponent } from 'vue' | ||
import { translate as t } from '@nextcloud/l10n' | ||
<script setup lang="ts"> | ||
import type { ComponentPublicInstance, PropType } from 'vue' | ||
import { getUniqueName } from '@nextcloud/files' | ||
import { loadState } from '@nextcloud/initial-state' | ||
import { t } from '@nextcloud/l10n' | ||
import { extname } from 'path' | ||
import { nextTick, onMounted, ref, watch, watchEffect } from 'vue' | ||
import { getFilenameValidity } from '../utils/filenameValidity.ts' | ||
import NcButton from '@nextcloud/vue/dist/Components/NcButton.js' | ||
import NcDialog from '@nextcloud/vue/dist/Components/NcDialog.js' | ||
import NcTextField from '@nextcloud/vue/dist/Components/NcTextField.js' | ||
import logger from '../logger.js' | ||
interface ICanFocus { | ||
focus: () => void | ||
} | ||
const forbiddenCharacters = loadState<string>('files', 'forbiddenCharacters', '').split('') | ||
export default defineComponent({ | ||
name: 'NewNodeDialog', | ||
components: { | ||
NcButton, | ||
NcDialog, | ||
NcTextField, | ||
const props = defineProps({ | ||
/** | ||
* The name to be used by default | ||
*/ | ||
defaultName: { | ||
type: String, | ||
default: t('files', 'New folder'), | ||
}, | ||
props: { | ||
/** | ||
* The name to be used by default | ||
*/ | ||
defaultName: { | ||
type: String, | ||
default: t('files', 'New folder'), | ||
}, | ||
/** | ||
* Other files that are in the current directory | ||
*/ | ||
otherNames: { | ||
type: Array as PropType<string[]>, | ||
default: () => [], | ||
}, | ||
/** | ||
* Open state of the dialog | ||
*/ | ||
open: { | ||
type: Boolean, | ||
default: true, | ||
}, | ||
/** | ||
* Dialog name | ||
*/ | ||
name: { | ||
type: String, | ||
default: t('files', 'Create new folder'), | ||
}, | ||
/** | ||
* Input label | ||
*/ | ||
label: { | ||
type: String, | ||
default: t('files', 'Folder name'), | ||
}, | ||
/** | ||
* Other files that are in the current directory | ||
*/ | ||
otherNames: { | ||
type: Array as PropType<string[]>, | ||
default: () => [], | ||
}, | ||
emits: { | ||
close: (name: string|null) => name === null || name, | ||
/** | ||
* Open state of the dialog | ||
*/ | ||
open: { | ||
type: Boolean, | ||
default: true, | ||
}, | ||
data() { | ||
return { | ||
localDefaultName: this.defaultName || t('files', 'New folder'), | ||
} | ||
/** | ||
* Dialog name | ||
*/ | ||
name: { | ||
type: String, | ||
default: t('files', 'Create new folder'), | ||
}, | ||
computed: { | ||
errorMessage() { | ||
if (this.isUniqueName) { | ||
return '' | ||
} else { | ||
return t('files', 'A file or folder with that name already exists.') | ||
} | ||
}, | ||
uniqueName() { | ||
return getUniqueName(this.localDefaultName, this.otherNames) | ||
}, | ||
isUniqueName() { | ||
return this.localDefaultName === this.uniqueName | ||
}, | ||
/** | ||
* Input label | ||
*/ | ||
label: { | ||
type: String, | ||
default: t('files', 'Folder name'), | ||
}, | ||
watch: { | ||
defaultName() { | ||
this.localDefaultName = this.defaultName || t('files', 'New folder') | ||
}, | ||
}) | ||
/** | ||
* Ensure the input is focussed even if the dialog is already mounted but not open | ||
*/ | ||
open() { | ||
this.$nextTick(() => this.focusInput()) | ||
}, | ||
}, | ||
mounted() { | ||
// on mounted lets use the unique name | ||
this.localDefaultName = this.uniqueName | ||
this.$nextTick(() => this.focusInput()) | ||
}, | ||
methods: { | ||
t, | ||
const emit = defineEmits<{ | ||
(event: 'close', name: string | null): void | ||
}>() | ||
const localDefaultName = ref<string>(props.defaultName) | ||
const nameInput = ref<ComponentPublicInstance>() | ||
const formElement = ref<HTMLFormElement>() | ||
const validity = ref('') | ||
/** | ||
* Focus the filename input field | ||
*/ | ||
function focusInput() { | ||
nextTick(() => { | ||
// get the input element | ||
const input = nameInput.value?.$el.querySelector('input') | ||
if (!props.open || !input) { | ||
return | ||
} | ||
/** | ||
* Focus the filename input field | ||
*/ | ||
focusInput() { | ||
if (this.open) { | ||
this.$nextTick(() => (this.$refs.input as unknown as ICanFocus)?.focus?.()) | ||
} | ||
}, | ||
// length of the basename | ||
const length = localDefaultName.value.length - extname(localDefaultName.value).length | ||
// focus the input | ||
input.focus() | ||
// and set the selection to the basename (name without extension) | ||
input.setSelectionRange(0, length) | ||
}) | ||
} | ||
onCreate() { | ||
this.$emit('close', this.localDefaultName) | ||
}, | ||
onClose(state: boolean) { | ||
if (!state) { | ||
this.$emit('close', null) | ||
} | ||
}, | ||
/** | ||
* Trigger submit on the form | ||
*/ | ||
function submit() { | ||
formElement.value?.requestSubmit() | ||
} | ||
/** | ||
* Check if the file name is valid and update the | ||
* input validity using browser's native validation. | ||
* @param event the keyup event | ||
*/ | ||
checkInputValidity(event: KeyboardEvent) { | ||
const input = event.target as HTMLInputElement | ||
const newName = this.localDefaultName.trim?.() || '' | ||
logger.debug('Checking input validity', { newName }) | ||
try { | ||
this.isFileNameValid(newName) | ||
input.setCustomValidity('') | ||
input.title = '' | ||
} catch (e) { | ||
if (e instanceof Error) { | ||
input.setCustomValidity(e.message) | ||
input.title = e.message | ||
} else { | ||
input.setCustomValidity(t('files', 'Invalid file name')) | ||
} | ||
} finally { | ||
input.reportValidity() | ||
} | ||
}, | ||
// Reset local name on props change | ||
watch(() => props.defaultName, () => { | ||
localDefaultName.value = getUniqueName(props.defaultName, props.otherNames) | ||
}) | ||
isFileNameValid(name: string) { | ||
const trimmedName = name.trim() | ||
const char = trimmedName.indexOf('/') !== -1 | ||
? '/' | ||
: forbiddenCharacters.find((char) => trimmedName.includes(char)) | ||
// Validate the local name | ||
watchEffect(() => { | ||
if (props.otherNames.includes(localDefaultName.value)) { | ||
validity.value = t('files', 'This name is already in use.') | ||
} else { | ||
validity.value = getFilenameValidity(localDefaultName.value) | ||
} | ||
const input = nameInput.value?.$el.querySelector('input') | ||
if (input) { | ||
input.setCustomValidity(validity.value) | ||
input.reportValidity() | ||
} | ||
}) | ||
if (trimmedName === '.' || trimmedName === '..') { | ||
throw new Error(t('files', '"{name}" is an invalid file name.', { name })) | ||
} else if (trimmedName.length === 0) { | ||
throw new Error(t('files', 'File name cannot be empty.')) | ||
} else if (char) { | ||
throw new Error(t('files', '"{char}" is not allowed inside a file name.', { char })) | ||
} else if (trimmedName.match(window.OC.config.blacklist_files_regex)) { | ||
throw new Error(t('files', '"{name}" is not an allowed filetype.', { name })) | ||
} | ||
// Ensure the input is focussed even if the dialog is already mounted but not open | ||
watch(() => props.open, () => { | ||
nextTick(() => { | ||
focusInput() | ||
}) | ||
}) | ||
return true | ||
}, | ||
}, | ||
onMounted(() => { | ||
// on mounted lets use the unique name | ||
localDefaultName.value = getUniqueName(localDefaultName.value, props.otherNames) | ||
nextTick(() => focusInput()) | ||
}) | ||
</script> | ||
|
||
<style lang="scss" scoped> | ||
.dialog__input { | ||
:deep(input:invalid) { | ||
// Show red border on invalid input | ||
border-color: var(--color-error); | ||
color: red; | ||
} | ||
<style scoped> | ||
.new-node-dialog__form { | ||
/* Ensure the dialog does not jump when there is a validity error */ | ||
min-height: calc(3 * var(--default-clickable-area)); | ||
} | ||
</style> |
Oops, something went wrong.