Merge pull request #46371 from nextcloud/feat/filename-validator

feat: Add `IFilenameValidator` to have one consistent place for filename validation

1 files changed, 39 insertions, 0 deletions

diff --git a/lib/public/Files/IFilenameValidator.php b/lib/public/Files/IFilenameValidator.php
new file mode 100644
index 00000000000..2bd3bb945dc
--- /dev/null
+++ b/lib/public/Files/IFilenameValidator.php
@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Files;
+
+/**
+ * @since 30.0.0
+ */
+interface IFilenameValidator {
+
+	/**
+	 * It is recommended to use `\OCP\Files\Storage\IStorage::isFileValid` instead as this
+	 * only checks if the filename is valid in general but not for a specific storage
+	 * which might have additional naming rules.
+	 *
+	 * @param string $filename The filename to check for validity
+	 * @return bool
+	 * @since 30.0.0
+	 */
+	public function isFilenameValid(string $filename): bool;
+
+	/**
+	 * It is recommended to use `\OCP\Files\Storage\IStorage::isFileValid` instead as this
+	 * only checks if the filename is valid in general but not for a specific storage
+	 * which might have additional naming rules.
+	 *
+	 * This will validate a filename and throw an exception with details on error.
+	 *
+	 * @param string $filename The filename to check for validity
+	 * @throws \OCP\Files\InvalidPathException or one of its child classes in case of an error
+	 * @since 30.0.0
+	 */
+	public function validateFilename(string $filename): void;
+}