aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files/src/utils/filenameValidity.ts
blob: 2666d530052ff3419eacd1cacf0830c9445f596e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
/*!
 * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
import { InvalidFilenameError, InvalidFilenameErrorReason, validateFilename } from '@nextcloud/files'
import { t } from '@nextcloud/l10n'

/**
 * Get the validity of a filename (empty if valid).
 * This can be used for `setCustomValidity` on input elements
 * @param name The filename
 * @param escape Escape the matched string in the error (only set when used in HTML)
 */
export function getFilenameValidity(name: string, escape = false): string {
	if (name.trim() === '') {
		return t('files', 'Filename must not be empty.')
	}

	try {
		validateFilename(name)
		return ''
	} catch (error) {
		if (!(error instanceof InvalidFilenameError)) {
			throw error
		}

		switch (error.reason) {
		case InvalidFilenameErrorReason.Character:
			return t('files', '"{char}" is not allowed inside a filename.', { char: error.segment }, undefined, { escape })
		case InvalidFilenameErrorReason.ReservedName:
			return t('files', '"{segment}" is a reserved name and not allowed for filenames.', { segment: error.segment }, undefined, { escape: false })
		case InvalidFilenameErrorReason.Extension:
			if (error.segment.match(/\.[a-z]/i)) {
				return t('files', '"{extension}" is not an allowed filetype.', { extension: error.segment }, undefined, { escape: false })
			}
			return t('files', 'Filenames must not end with "{extension}".', { extension: error.segment }, undefined, { escape: false })
		default:
			return t('files', 'Invalid filename.')
		}
	}
}