nextcloud / server

lib/public/Files/IFilenameValidator.php

Indentation +33 added lines, -33 removed lines

@@ -13,40 +13,40 @@
  */
 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.
+     *
+     * @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;
+    /**
+     * 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;
 
-	/**
-	 * Sanitize a give filename to comply with admin setup naming constrains.
-	 *
-	 * If no sanitizing is needed the same name is returned.
-	 *
-	 * @param string $name The filename to sanitize
-	 * @param null|string $charReplacement Character to use for replacing forbidden ones - by default space, dash or underscore is used if allowed.
-	 * @throws \InvalidArgumentException if no character replacement was given (and the default could not be applied) or the replacement is not valid.
-	 * @since 32.0.0
-	 */
-	public function sanitizeFilename(string $name, ?string $charReplacement = null): string;
+    /**
+     * Sanitize a give filename to comply with admin setup naming constrains.
+     *
+     * If no sanitizing is needed the same name is returned.
+     *
+     * @param string $name The filename to sanitize
+     * @param null|string $charReplacement Character to use for replacing forbidden ones - by default space, dash or underscore is used if allowed.
+     * @throws \InvalidArgumentException if no character replacement was given (and the default could not be applied) or the replacement is not valid.
+     * @since 32.0.0
+     */
+    public function sanitizeFilename(string $name, ?string $charReplacement = null): string;
 
 }

lib/private/Files/FilenameValidator.php

Indentation +303 added lines, -303 removed lines

@@ -25,311 +25,311 @@
  */
 class FilenameValidator implements IFilenameValidator {
 
-	public const INVALID_FILE_TYPE = 100;
-
-	private IL10N $l10n;
-
-	/**
-	 * @var list<string>
-	 */
-	private array $forbiddenNames = [];
-
-	/**
-	 * @var list<string>
-	 */
-	private array $forbiddenBasenames = [];
-	/**
-	 * @var list<string>
-	 */
-	private array $forbiddenCharacters = [];
-
-	/**
-	 * @var list<string>
-	 */
-	private array $forbiddenExtensions = [];
-
-	public function __construct(
-		IFactory $l10nFactory,
-		private IDBConnection $database,
-		private IConfig $config,
-		private LoggerInterface $logger,
-	) {
-		$this->l10n = $l10nFactory->get('core');
-	}
-
-	/**
-	 * Get a list of reserved filenames that must not be used
-	 * This list should be checked case-insensitive, all names are returned lowercase.
-	 * @return list<string>
-	 * @since 30.0.0
-	 */
-	public function getForbiddenExtensions(): array {
-		if (empty($this->forbiddenExtensions)) {
-			$forbiddenExtensions = $this->getConfigValue('forbidden_filename_extensions', ['.filepart']);
-
-			// Always forbid .part files as they are used internally
-			$forbiddenExtensions[] = '.part';
-
-			$this->forbiddenExtensions = array_values($forbiddenExtensions);
-		}
-		return $this->forbiddenExtensions;
-	}
-
-	/**
-	 * Get a list of forbidden filename extensions that must not be used
-	 * This list should be checked case-insensitive, all names are returned lowercase.
-	 * @return list<string>
-	 * @since 30.0.0
-	 */
-	public function getForbiddenFilenames(): array {
-		if (empty($this->forbiddenNames)) {
-			$forbiddenNames = $this->getConfigValue('forbidden_filenames', ['.htaccess']);
-
-			// Handle legacy config option
-			// TODO: Drop with Nextcloud 34
-			$legacyForbiddenNames = $this->getConfigValue('blacklisted_files', []);
-			if (!empty($legacyForbiddenNames)) {
-				$this->logger->warning('System config option "blacklisted_files" is deprecated and will be removed in Nextcloud 34, use "forbidden_filenames" instead.');
-			}
-			$forbiddenNames = array_merge($legacyForbiddenNames, $forbiddenNames);
-
-			// Ensure we are having a proper string list
-			$this->forbiddenNames = array_values($forbiddenNames);
-		}
-		return $this->forbiddenNames;
-	}
-
-	/**
-	 * Get a list of forbidden file basenames that must not be used
-	 * This list should be checked case-insensitive, all names are returned lowercase.
-	 * @return list<string>
-	 * @since 30.0.0
-	 */
-	public function getForbiddenBasenames(): array {
-		if (empty($this->forbiddenBasenames)) {
-			$forbiddenBasenames = $this->getConfigValue('forbidden_filename_basenames', []);
-			// Ensure we are having a proper string list
-			$this->forbiddenBasenames = array_values($forbiddenBasenames);
-		}
-		return $this->forbiddenBasenames;
-	}
-
-	/**
-	 * Get a list of characters forbidden in filenames
-	 *
-	 * Note: Characters in the range [0-31] are always forbidden,
-	 * even if not inside this list (see OCP\Files\Storage\IStorage::verifyPath).
-	 *
-	 * @return list<string>
-	 * @since 30.0.0
-	 */
-	public function getForbiddenCharacters(): array {
-		if (empty($this->forbiddenCharacters)) {
-			// Get always forbidden characters
-			$forbiddenCharacters = str_split(\OCP\Constants::FILENAME_INVALID_CHARS);
-
-			// Get admin defined invalid characters
-			$additionalChars = $this->config->getSystemValue('forbidden_filename_characters', []);
-			if (!is_array($additionalChars)) {
-				$this->logger->error('Invalid system config value for "forbidden_filename_characters" is ignored.');
-				$additionalChars = [];
-			}
-			$forbiddenCharacters = array_merge($forbiddenCharacters, $additionalChars);
-
-			// Handle legacy config option
-			// TODO: Drop with Nextcloud 34
-			$legacyForbiddenCharacters = $this->config->getSystemValue('forbidden_chars', []);
-			if (!is_array($legacyForbiddenCharacters)) {
-				$this->logger->error('Invalid system config value for "forbidden_chars" is ignored.');
-				$legacyForbiddenCharacters = [];
-			}
-			if (!empty($legacyForbiddenCharacters)) {
-				$this->logger->warning('System config option "forbidden_chars" is deprecated and will be removed in Nextcloud 34, use "forbidden_filename_characters" instead.');
-			}
-			$forbiddenCharacters = array_merge($legacyForbiddenCharacters, $forbiddenCharacters);
-
-			$this->forbiddenCharacters = array_values($forbiddenCharacters);
-		}
-		return $this->forbiddenCharacters;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function isFilenameValid(string $filename): bool {
-		try {
-			$this->validateFilename($filename);
-		} catch (\OCP\Files\InvalidPathException) {
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function validateFilename(string $filename): void {
-		$trimmed = trim($filename);
-		if ($trimmed === '') {
-			throw new EmptyFileNameException();
-		}
-
-		// the special directories . and .. would cause never ending recursion
-		// we check the trimmed name here to ensure unexpected trimming will not cause severe issues
-		if ($trimmed === '.' || $trimmed === '..') {
-			throw new InvalidDirectoryException($this->l10n->t('Dot files are not allowed'));
-		}
-
-		// 255 characters is the limit on common file systems (ext/xfs)
-		// oc_filecache has a 250 char length limit for the filename
-		if (isset($filename[250])) {
-			throw new FileNameTooLongException();
-		}
-
-		if (!$this->database->supports4ByteText()) {
-			// verify database - e.g. mysql only 3-byte chars
-			if (preg_match('%(?:
+    public const INVALID_FILE_TYPE = 100;
+
+    private IL10N $l10n;
+
+    /**
+     * @var list<string>
+     */
+    private array $forbiddenNames = [];
+
+    /**
+     * @var list<string>
+     */
+    private array $forbiddenBasenames = [];
+    /**
+     * @var list<string>
+     */
+    private array $forbiddenCharacters = [];
+
+    /**
+     * @var list<string>
+     */
+    private array $forbiddenExtensions = [];
+
+    public function __construct(
+        IFactory $l10nFactory,
+        private IDBConnection $database,
+        private IConfig $config,
+        private LoggerInterface $logger,
+    ) {
+        $this->l10n = $l10nFactory->get('core');
+    }
+
+    /**
+     * Get a list of reserved filenames that must not be used
+     * This list should be checked case-insensitive, all names are returned lowercase.
+     * @return list<string>
+     * @since 30.0.0
+     */
+    public function getForbiddenExtensions(): array {
+        if (empty($this->forbiddenExtensions)) {
+            $forbiddenExtensions = $this->getConfigValue('forbidden_filename_extensions', ['.filepart']);
+
+            // Always forbid .part files as they are used internally
+            $forbiddenExtensions[] = '.part';
+
+            $this->forbiddenExtensions = array_values($forbiddenExtensions);
+        }
+        return $this->forbiddenExtensions;
+    }
+
+    /**
+     * Get a list of forbidden filename extensions that must not be used
+     * This list should be checked case-insensitive, all names are returned lowercase.
+     * @return list<string>
+     * @since 30.0.0
+     */
+    public function getForbiddenFilenames(): array {
+        if (empty($this->forbiddenNames)) {
+            $forbiddenNames = $this->getConfigValue('forbidden_filenames', ['.htaccess']);
+
+            // Handle legacy config option
+            // TODO: Drop with Nextcloud 34
+            $legacyForbiddenNames = $this->getConfigValue('blacklisted_files', []);
+            if (!empty($legacyForbiddenNames)) {
+                $this->logger->warning('System config option "blacklisted_files" is deprecated and will be removed in Nextcloud 34, use "forbidden_filenames" instead.');
+            }
+            $forbiddenNames = array_merge($legacyForbiddenNames, $forbiddenNames);
+
+            // Ensure we are having a proper string list
+            $this->forbiddenNames = array_values($forbiddenNames);
+        }
+        return $this->forbiddenNames;
+    }
+
+    /**
+     * Get a list of forbidden file basenames that must not be used
+     * This list should be checked case-insensitive, all names are returned lowercase.
+     * @return list<string>
+     * @since 30.0.0
+     */
+    public function getForbiddenBasenames(): array {
+        if (empty($this->forbiddenBasenames)) {
+            $forbiddenBasenames = $this->getConfigValue('forbidden_filename_basenames', []);
+            // Ensure we are having a proper string list
+            $this->forbiddenBasenames = array_values($forbiddenBasenames);
+        }
+        return $this->forbiddenBasenames;
+    }
+
+    /**
+     * Get a list of characters forbidden in filenames
+     *
+     * Note: Characters in the range [0-31] are always forbidden,
+     * even if not inside this list (see OCP\Files\Storage\IStorage::verifyPath).
+     *
+     * @return list<string>
+     * @since 30.0.0
+     */
+    public function getForbiddenCharacters(): array {
+        if (empty($this->forbiddenCharacters)) {
+            // Get always forbidden characters
+            $forbiddenCharacters = str_split(\OCP\Constants::FILENAME_INVALID_CHARS);
+
+            // Get admin defined invalid characters
+            $additionalChars = $this->config->getSystemValue('forbidden_filename_characters', []);
+            if (!is_array($additionalChars)) {
+                $this->logger->error('Invalid system config value for "forbidden_filename_characters" is ignored.');
+                $additionalChars = [];
+            }
+            $forbiddenCharacters = array_merge($forbiddenCharacters, $additionalChars);
+
+            // Handle legacy config option
+            // TODO: Drop with Nextcloud 34
+            $legacyForbiddenCharacters = $this->config->getSystemValue('forbidden_chars', []);
+            if (!is_array($legacyForbiddenCharacters)) {
+                $this->logger->error('Invalid system config value for "forbidden_chars" is ignored.');
+                $legacyForbiddenCharacters = [];
+            }
+            if (!empty($legacyForbiddenCharacters)) {
+                $this->logger->warning('System config option "forbidden_chars" is deprecated and will be removed in Nextcloud 34, use "forbidden_filename_characters" instead.');
+            }
+            $forbiddenCharacters = array_merge($legacyForbiddenCharacters, $forbiddenCharacters);
+
+            $this->forbiddenCharacters = array_values($forbiddenCharacters);
+        }
+        return $this->forbiddenCharacters;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function isFilenameValid(string $filename): bool {
+        try {
+            $this->validateFilename($filename);
+        } catch (\OCP\Files\InvalidPathException) {
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function validateFilename(string $filename): void {
+        $trimmed = trim($filename);
+        if ($trimmed === '') {
+            throw new EmptyFileNameException();
+        }
+
+        // the special directories . and .. would cause never ending recursion
+        // we check the trimmed name here to ensure unexpected trimming will not cause severe issues
+        if ($trimmed === '.' || $trimmed === '..') {
+            throw new InvalidDirectoryException($this->l10n->t('Dot files are not allowed'));
+        }
+
+        // 255 characters is the limit on common file systems (ext/xfs)
+        // oc_filecache has a 250 char length limit for the filename
+        if (isset($filename[250])) {
+            throw new FileNameTooLongException();
+        }
+
+        if (!$this->database->supports4ByteText()) {
+            // verify database - e.g. mysql only 3-byte chars
+            if (preg_match('%(?:
       \xF0[\x90-\xBF][\x80-\xBF]{2}      # planes 1-3
     | [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
     | \xF4[\x80-\x8F][\x80-\xBF]{2}      # plane 16
 )%xs', $filename)) {
-				throw new InvalidCharacterInPathException();
-			}
-		}
-
-		$this->checkForbiddenName($filename);
-
-		$this->checkForbiddenExtension($filename);
-
-		$this->checkForbiddenCharacters($filename);
-	}
-
-	/**
-	 * Check if the filename is forbidden
-	 * @param string $path Path to check the filename
-	 * @return bool True if invalid name, False otherwise
-	 */
-	public function isForbidden(string $path): bool {
-		// We support paths here as this function is also used in some storage internals
-		$filename = basename($path);
-		$filename = mb_strtolower($filename);
-
-		if ($filename === '') {
-			return false;
-		}
-
-		// Check for forbidden filenames
-		$forbiddenNames = $this->getForbiddenFilenames();
-		if (in_array($filename, $forbiddenNames)) {
-			return true;
-		}
-
-		// Filename is not forbidden
-		return false;
-	}
-
-	public function sanitizeFilename(string $name, ?string $charReplacement = null): string {
-		$forbiddenCharacters = $this->getForbiddenCharacters();
-
-		if ($charReplacement === null) {
-			$charReplacement = array_diff([' ', '_', '-'], $forbiddenCharacters);
-			$charReplacement = reset($charReplacement) ?: '';
-		}
-		if (mb_strlen($charReplacement) !== 1) {
-			throw new \InvalidArgumentException('No or invalid character replacement given');
-		}
-
-		$nameLowercase = mb_strtolower($name);
-		foreach ($this->getForbiddenExtensions() as $extension) {
-			if (str_ends_with($nameLowercase, $extension)) {
-				$name = substr($name, 0, strlen($name) - strlen($extension));
-			}
-		}
-
-		$basename = strlen($name) > 1
-			? substr($name, 0, strpos($name, '.', 1) ?: null)
-			: $name;
-		if (in_array(mb_strtolower($basename), $this->getForbiddenBasenames())) {
-			$name = str_replace($basename, $this->l10n->t('%1$s (renamed)', [$basename]), $name);
-		}
-
-		if ($name === '') {
-			$name = $this->l10n->t('renamed file');
-		}
-
-		if (in_array(mb_strtolower($name), $this->getForbiddenFilenames())) {
-			$name = $this->l10n->t('%1$s (renamed)', [$name]);
-		}
-
-		$name = str_replace($forbiddenCharacters, $charReplacement, $name);
-		return $name;
-	}
-
-	protected function checkForbiddenName(string $filename): void {
-		$filename = mb_strtolower($filename);
-		if ($this->isForbidden($filename)) {
-			throw new ReservedWordException($this->l10n->t('"%1$s" is a forbidden file or folder name.', [$filename]));
-		}
-
-		// Check for forbidden basenames - basenames are the part of the file until the first dot
-		// (except if the dot is the first character as this is then part of the basename "hidden files")
-		$basename = substr($filename, 0, strpos($filename, '.', 1) ?: null);
-		$forbiddenNames = $this->getForbiddenBasenames();
-		if (in_array($basename, $forbiddenNames)) {
-			throw new ReservedWordException($this->l10n->t('"%1$s" is a forbidden prefix for file or folder names.', [$filename]));
-		}
-	}
-
-
-	/**
-	 * Check if a filename contains any of the forbidden characters
-	 * @param string $filename
-	 * @throws InvalidCharacterInPathException
-	 */
-	protected function checkForbiddenCharacters(string $filename): void {
-		$sanitizedFileName = filter_var($filename, FILTER_UNSAFE_RAW, FILTER_FLAG_STRIP_LOW);
-		if ($sanitizedFileName !== $filename) {
-			throw new InvalidCharacterInPathException();
-		}
-
-		foreach ($this->getForbiddenCharacters() as $char) {
-			if (str_contains($filename, $char)) {
-				throw new InvalidCharacterInPathException($this->l10n->t('"%1$s" is not allowed inside a file or folder name.', [$char]));
-			}
-		}
-	}
-
-	/**
-	 * Check if a filename has a forbidden filename extension
-	 * @param string $filename The filename to validate
-	 * @throws InvalidPathException
-	 */
-	protected function checkForbiddenExtension(string $filename): void {
-		$filename = mb_strtolower($filename);
-		// Check for forbidden filename extensions
-		$forbiddenExtensions = $this->getForbiddenExtensions();
-		foreach ($forbiddenExtensions as $extension) {
-			if (str_ends_with($filename, $extension)) {
-				if (str_starts_with($extension, '.')) {
-					throw new InvalidPathException($this->l10n->t('"%1$s" is a forbidden file type.', [$extension]), self::INVALID_FILE_TYPE);
-				} else {
-					throw new InvalidPathException($this->l10n->t('Filenames must not end with "%1$s".', [$extension]));
-				}
-			}
-		}
-	}
-
-	/**
-	 * Helper to get lower case list from config with validation
-	 * @return string[]
-	 */
-	private function getConfigValue(string $key, array $fallback): array {
-		$values = $this->config->getSystemValue($key, $fallback);
-		if (!is_array($values)) {
-			$this->logger->error('Invalid system config value for "' . $key . '" is ignored.');
-			$values = $fallback;
-		}
-
-		return array_map(mb_strtolower(...), $values);
-	}
+                throw new InvalidCharacterInPathException();
+            }
+        }
+
+        $this->checkForbiddenName($filename);
+
+        $this->checkForbiddenExtension($filename);
+
+        $this->checkForbiddenCharacters($filename);
+    }
+
+    /**
+     * Check if the filename is forbidden
+     * @param string $path Path to check the filename
+     * @return bool True if invalid name, False otherwise
+     */
+    public function isForbidden(string $path): bool {
+        // We support paths here as this function is also used in some storage internals
+        $filename = basename($path);
+        $filename = mb_strtolower($filename);
+
+        if ($filename === '') {
+            return false;
+        }
+
+        // Check for forbidden filenames
+        $forbiddenNames = $this->getForbiddenFilenames();
+        if (in_array($filename, $forbiddenNames)) {
+            return true;
+        }
+
+        // Filename is not forbidden
+        return false;
+    }
+
+    public function sanitizeFilename(string $name, ?string $charReplacement = null): string {
+        $forbiddenCharacters = $this->getForbiddenCharacters();
+
+        if ($charReplacement === null) {
+            $charReplacement = array_diff([' ', '_', '-'], $forbiddenCharacters);
+            $charReplacement = reset($charReplacement) ?: '';
+        }
+        if (mb_strlen($charReplacement) !== 1) {
+            throw new \InvalidArgumentException('No or invalid character replacement given');
+        }
+
+        $nameLowercase = mb_strtolower($name);
+        foreach ($this->getForbiddenExtensions() as $extension) {
+            if (str_ends_with($nameLowercase, $extension)) {
+                $name = substr($name, 0, strlen($name) - strlen($extension));
+            }
+        }
+
+        $basename = strlen($name) > 1
+            ? substr($name, 0, strpos($name, '.', 1) ?: null)
+            : $name;
+        if (in_array(mb_strtolower($basename), $this->getForbiddenBasenames())) {
+            $name = str_replace($basename, $this->l10n->t('%1$s (renamed)', [$basename]), $name);
+        }
+
+        if ($name === '') {
+            $name = $this->l10n->t('renamed file');
+        }
+
+        if (in_array(mb_strtolower($name), $this->getForbiddenFilenames())) {
+            $name = $this->l10n->t('%1$s (renamed)', [$name]);
+        }
+
+        $name = str_replace($forbiddenCharacters, $charReplacement, $name);
+        return $name;
+    }
+
+    protected function checkForbiddenName(string $filename): void {
+        $filename = mb_strtolower($filename);
+        if ($this->isForbidden($filename)) {
+            throw new ReservedWordException($this->l10n->t('"%1$s" is a forbidden file or folder name.', [$filename]));
+        }
+
+        // Check for forbidden basenames - basenames are the part of the file until the first dot
+        // (except if the dot is the first character as this is then part of the basename "hidden files")
+        $basename = substr($filename, 0, strpos($filename, '.', 1) ?: null);
+        $forbiddenNames = $this->getForbiddenBasenames();
+        if (in_array($basename, $forbiddenNames)) {
+            throw new ReservedWordException($this->l10n->t('"%1$s" is a forbidden prefix for file or folder names.', [$filename]));
+        }
+    }
+
+
+    /**
+     * Check if a filename contains any of the forbidden characters
+     * @param string $filename
+     * @throws InvalidCharacterInPathException
+     */
+    protected function checkForbiddenCharacters(string $filename): void {
+        $sanitizedFileName = filter_var($filename, FILTER_UNSAFE_RAW, FILTER_FLAG_STRIP_LOW);
+        if ($sanitizedFileName !== $filename) {
+            throw new InvalidCharacterInPathException();
+        }
+
+        foreach ($this->getForbiddenCharacters() as $char) {
+            if (str_contains($filename, $char)) {
+                throw new InvalidCharacterInPathException($this->l10n->t('"%1$s" is not allowed inside a file or folder name.', [$char]));
+            }
+        }
+    }
+
+    /**
+     * Check if a filename has a forbidden filename extension
+     * @param string $filename The filename to validate
+     * @throws InvalidPathException
+     */
+    protected function checkForbiddenExtension(string $filename): void {
+        $filename = mb_strtolower($filename);
+        // Check for forbidden filename extensions
+        $forbiddenExtensions = $this->getForbiddenExtensions();
+        foreach ($forbiddenExtensions as $extension) {
+            if (str_ends_with($filename, $extension)) {
+                if (str_starts_with($extension, '.')) {
+                    throw new InvalidPathException($this->l10n->t('"%1$s" is a forbidden file type.', [$extension]), self::INVALID_FILE_TYPE);
+                } else {
+                    throw new InvalidPathException($this->l10n->t('Filenames must not end with "%1$s".', [$extension]));
+                }
+            }
+        }
+    }
+
+    /**
+     * Helper to get lower case list from config with validation
+     * @return string[]
+     */
+    private function getConfigValue(string $key, array $fallback): array {
+        $values = $this->config->getSystemValue($key, $fallback);
+        if (!is_array($values)) {
+            $this->logger->error('Invalid system config value for "' . $key . '" is ignored.');
+            $values = $fallback;
+        }
+
+        return array_map(mb_strtolower(...), $values);
+    }
 };

apps/files/lib/Command/SanitizeFilenames.php

Indentation +119 added lines, -119 removed lines

@@ -26,125 +26,125 @@
 
 class SanitizeFilenames extends Base {
 
-	private OutputInterface $output;
-	private ?string $charReplacement;
-	private bool $dryRun;
-
-	public function __construct(
-		private IUserManager $userManager,
-		private IRootFolder $rootFolder,
-		private IUserSession $session,
-		private IFactory $l10nFactory,
-		private FilenameValidator $filenameValidator,
-	) {
-		parent::__construct();
-	}
-
-	protected function configure(): void {
-		parent::configure();
-
-		$this
-			->setName('files:sanitize-filenames')
-			->setDescription('Renames files to match naming constraints')
-			->addArgument(
-				'user_id',
-				InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
-				'will only rename files the given user(s) have access to'
-			)
-			->addOption(
-				'dry-run',
-				mode: InputOption::VALUE_NONE,
-				description: 'Do not actually rename any files but just check filenames.',
-			)
-			->addOption(
-				'char-replacement',
-				'c',
-				mode: InputOption::VALUE_REQUIRED,
-				description: 'Replacement for invalid character (by default space, underscore or dash is used)',
-			);
+    private OutputInterface $output;
+    private ?string $charReplacement;
+    private bool $dryRun;
+
+    public function __construct(
+        private IUserManager $userManager,
+        private IRootFolder $rootFolder,
+        private IUserSession $session,
+        private IFactory $l10nFactory,
+        private FilenameValidator $filenameValidator,
+    ) {
+        parent::__construct();
+    }
+
+    protected function configure(): void {
+        parent::configure();
+
+        $this
+            ->setName('files:sanitize-filenames')
+            ->setDescription('Renames files to match naming constraints')
+            ->addArgument(
+                'user_id',
+                InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
+                'will only rename files the given user(s) have access to'
+            )
+            ->addOption(
+                'dry-run',
+                mode: InputOption::VALUE_NONE,
+                description: 'Do not actually rename any files but just check filenames.',
+            )
+            ->addOption(
+                'char-replacement',
+                'c',
+                mode: InputOption::VALUE_REQUIRED,
+                description: 'Replacement for invalid character (by default space, underscore or dash is used)',
+            );
 			
-	}
-
-	protected function execute(InputInterface $input, OutputInterface $output): int {
-		$this->charReplacement = $input->getOption('char-replacement');
-		// check if replacement is needed
-		$c = $this->filenameValidator->getForbiddenCharacters();
-		if (count($c) > 0) {
-			try {
-				$this->filenameValidator->sanitizeFilename($c[0], $this->charReplacement);
-			} catch (\InvalidArgumentException) {
-				if ($this->charReplacement === null) {
-					$output->writeln('<error>Character replacement required</error>');
-				} else {
-					$output->writeln('<error>Invalid character replacement given</error>');
-				}
-				return 1;
-			}
-		}
-
-		$this->dryRun = $input->getOption('dry-run');
-		if ($this->dryRun) {
-			$output->writeln('<info>Dry run is enabled, no actual renaming will be applied.</>');
-		}
-
-		$this->output = $output;
-		$users = $input->getArgument('user_id');
-		if (!empty($users)) {
-			foreach ($users as $userId) {
-				$user = $this->userManager->get($userId);
-				if ($user === null) {
-					$output->writeln("<error>User '$userId' does not exist - skipping</>");
-					continue;
-				}
-				$this->sanitizeUserFiles($user);
-			}
-		} else {
-			$this->userManager->callForSeenUsers($this->sanitizeUserFiles(...));
-		}
-		return self::SUCCESS;
-	}
-
-	private function sanitizeUserFiles(IUser $user): void {
-		// Set an active user so that event listeners can correctly work (e.g. files versions)
-		$this->session->setVolatileActiveUser($user);
-
-		$this->output->writeln('<info>Analyzing files of ' . $user->getUID() . '</>');
-
-		$folder = $this->rootFolder->getUserFolder($user->getUID());
-		$this->sanitizeFiles($folder);
-	}
-
-	private function sanitizeFiles(Folder $folder): void {
-		foreach ($folder->getDirectoryListing() as $node) {
-			$this->output->writeln('scanning: ' . $node->getPath(), OutputInterface::VERBOSITY_VERBOSE);
-
-			try {
-				$oldName = $node->getName();
-				$newName = $this->filenameValidator->sanitizeFilename($oldName, $this->charReplacement);
-				if ($oldName !== $newName) {
-					$newName = $folder->getNonExistingName($newName);
-					$path = rtrim(dirname($node->getPath()), '/');
-
-					if (!$this->dryRun) {
-						$node->move("$path/$newName");
-					} elseif (!$folder->isCreatable()) {
-						// simulate error for dry run
-						throw new NotPermittedException();
-					}
-					$this->output->writeln('renamed: "' . $oldName . '" to "' . $newName . '"');
-				}
-			} catch (LockedException) {
-				$this->output->writeln('<comment>skipping: ' . $node->getPath() . ' (file is locked)</>');
-			} catch (NotPermittedException) {
-				$this->output->writeln('<comment>skipping: ' . $node->getPath() . ' (no permissions)</>');
-			} catch (Exception) {
-				$this->output->writeln('<error>failed: ' . $node->getPath() . '</>');
-			}
-
-			if ($node instanceof Folder) {
-				$this->sanitizeFiles($node);
-			}
-		}
-	}
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int {
+        $this->charReplacement = $input->getOption('char-replacement');
+        // check if replacement is needed
+        $c = $this->filenameValidator->getForbiddenCharacters();
+        if (count($c) > 0) {
+            try {
+                $this->filenameValidator->sanitizeFilename($c[0], $this->charReplacement);
+            } catch (\InvalidArgumentException) {
+                if ($this->charReplacement === null) {
+                    $output->writeln('<error>Character replacement required</error>');
+                } else {
+                    $output->writeln('<error>Invalid character replacement given</error>');
+                }
+                return 1;
+            }
+        }
+
+        $this->dryRun = $input->getOption('dry-run');
+        if ($this->dryRun) {
+            $output->writeln('<info>Dry run is enabled, no actual renaming will be applied.</>');
+        }
+
+        $this->output = $output;
+        $users = $input->getArgument('user_id');
+        if (!empty($users)) {
+            foreach ($users as $userId) {
+                $user = $this->userManager->get($userId);
+                if ($user === null) {
+                    $output->writeln("<error>User '$userId' does not exist - skipping</>");
+                    continue;
+                }
+                $this->sanitizeUserFiles($user);
+            }
+        } else {
+            $this->userManager->callForSeenUsers($this->sanitizeUserFiles(...));
+        }
+        return self::SUCCESS;
+    }
+
+    private function sanitizeUserFiles(IUser $user): void {
+        // Set an active user so that event listeners can correctly work (e.g. files versions)
+        $this->session->setVolatileActiveUser($user);
+
+        $this->output->writeln('<info>Analyzing files of ' . $user->getUID() . '</>');
+
+        $folder = $this->rootFolder->getUserFolder($user->getUID());
+        $this->sanitizeFiles($folder);
+    }
+
+    private function sanitizeFiles(Folder $folder): void {
+        foreach ($folder->getDirectoryListing() as $node) {
+            $this->output->writeln('scanning: ' . $node->getPath(), OutputInterface::VERBOSITY_VERBOSE);
+
+            try {
+                $oldName = $node->getName();
+                $newName = $this->filenameValidator->sanitizeFilename($oldName, $this->charReplacement);
+                if ($oldName !== $newName) {
+                    $newName = $folder->getNonExistingName($newName);
+                    $path = rtrim(dirname($node->getPath()), '/');
+
+                    if (!$this->dryRun) {
+                        $node->move("$path/$newName");
+                    } elseif (!$folder->isCreatable()) {
+                        // simulate error for dry run
+                        throw new NotPermittedException();
+                    }
+                    $this->output->writeln('renamed: "' . $oldName . '" to "' . $newName . '"');
+                }
+            } catch (LockedException) {
+                $this->output->writeln('<comment>skipping: ' . $node->getPath() . ' (file is locked)</>');
+            } catch (NotPermittedException) {
+                $this->output->writeln('<comment>skipping: ' . $node->getPath() . ' (no permissions)</>');
+            } catch (Exception) {
+                $this->output->writeln('<error>failed: ' . $node->getPath() . '</>');
+            }
+
+            if ($node instanceof Folder) {
+                $this->sanitizeFiles($node);
+            }
+        }
+    }
 
 }

tests/lib/Files/FilenameValidatorTest.php

Indentation +482 added lines, -482 removed lines

@@ -26,486 +26,486 @@
 
 class FilenameValidatorTest extends TestCase {
 
-	protected IFactory&MockObject $l10n;
-	protected IConfig&MockObject $config;
-	protected IDBConnection&MockObject $database;
-	protected LoggerInterface&MockObject $logger;
-
-	protected function setUp(): void {
-		parent::setUp();
-		$l10n = $this->createMock(IL10N::class);
-		$l10n->method('t')
-			->willReturnCallback(fn ($string, $params) => sprintf($string, ...$params));
-		$this->l10n = $this->createMock(IFactory::class);
-		$this->l10n
-			->method('get')
-			->with('core')
-			->willReturn($l10n);
-
-		$this->config = $this->createMock(IConfig::class);
-		$this->logger = $this->createMock(LoggerInterface::class);
-		$this->database = $this->createMock(IDBConnection::class);
-		$this->database->method('supports4ByteText')->willReturn(true);
-	}
-
-	/**
-	 * @dataProvider dataValidateFilename
-	 */
-	public function testValidateFilename(
-		string $filename,
-		array $forbiddenNames,
-		array $forbiddenBasenames,
-		array $forbiddenExtensions,
-		array $forbiddenCharacters,
-		?string $exception,
-	): void {
-		/** @var FilenameValidator&MockObject */
-		$validator = $this->getMockBuilder(FilenameValidator::class)
-			->onlyMethods([
-				'getForbiddenBasenames',
-				'getForbiddenCharacters',
-				'getForbiddenExtensions',
-				'getForbiddenFilenames',
-			])
-			->setConstructorArgs([$this->l10n, $this->database, $this->config, $this->logger])
-			->getMock();
-
-		$validator->method('getForbiddenBasenames')
-			->willReturn($forbiddenBasenames);
-		$validator->method('getForbiddenCharacters')
-			->willReturn($forbiddenCharacters);
-		$validator->method('getForbiddenExtensions')
-			->willReturn($forbiddenExtensions);
-		$validator->method('getForbiddenFilenames')
-			->willReturn($forbiddenNames);
-
-		if ($exception !== null) {
-			$this->expectException($exception);
-		} else {
-			$this->expectNotToPerformAssertions();
-		}
-		$validator->validateFilename($filename);
-	}
-
-	/**
-	 * @dataProvider dataValidateFilename
-	 */
-	public function testIsFilenameValid(
-		string $filename,
-		array $forbiddenNames,
-		array $forbiddenBasenames,
-		array $forbiddenExtensions,
-		array $forbiddenCharacters,
-		?string $exception,
-	): void {
-		/** @var FilenameValidator&MockObject */
-		$validator = $this->getMockBuilder(FilenameValidator::class)
-			->onlyMethods([
-				'getForbiddenBasenames',
-				'getForbiddenExtensions',
-				'getForbiddenFilenames',
-				'getForbiddenCharacters',
-			])
-			->setConstructorArgs([$this->l10n, $this->database, $this->config, $this->logger])
-			->getMock();
-
-		$validator->method('getForbiddenBasenames')
-			->willReturn($forbiddenBasenames);
-		$validator->method('getForbiddenCharacters')
-			->willReturn($forbiddenCharacters);
-		$validator->method('getForbiddenExtensions')
-			->willReturn($forbiddenExtensions);
-		$validator->method('getForbiddenFilenames')
-			->willReturn($forbiddenNames);
-
-
-		$this->assertEquals($exception === null, $validator->isFilenameValid($filename));
-	}
-
-	public function dataValidateFilename(): array {
-		return [
-			'valid name' => [
-				'a: b.txt', ['.htaccess'], [], [], [], null
-			],
-			'forbidden name in the middle is ok' => [
-				'a.htaccess.txt', ['.htaccess'], [], [], [], null
-			],
-			'valid name with some more parameters' => [
-				'a: b.txt', ['.htaccess'], [], ['exe'], ['~'], null
-			],
-			'valid name checks only the full name' => [
-				'.htaccess.sample', ['.htaccess'], [], [], [], null
-			],
-			'forbidden name' => [
-				'.htaccess', ['.htaccess'], [], [], [], ReservedWordException::class
-			],
-			'forbidden name - name is case insensitive' => [
-				'COM1', ['.htaccess', 'com1'], [], [], [], ReservedWordException::class
-			],
-			'forbidden basename' => [
-				// needed for Windows namespaces
-				'com1.suffix', ['.htaccess'], ['com1'], [], [], ReservedWordException::class
-			],
-			'forbidden basename case insensitive' => [
-				// needed for Windows namespaces
-				'COM1.suffix', ['.htaccess'], ['com1'], [], [], ReservedWordException::class
-			],
-			'forbidden basename for hidden files' => [
-				// needed for Windows namespaces
-				'.thumbs.db', ['.htaccess'], ['.thumbs'], [], [], ReservedWordException::class
-			],
-			'invalid character' => [
-				'a: b.txt', ['.htaccess'], [], [], [':'], InvalidCharacterInPathException::class
-			],
-			'invalid path' => [
-				'../../foo.bar', ['.htaccess'], [], [], ['/', '\\'], InvalidCharacterInPathException::class,
-			],
-			'invalid extension' => [
-				'a: b.txt', ['.htaccess'], [], ['.txt'], [], InvalidPathException::class
-			],
-			'invalid extension case insensitive' => [
-				'a: b.TXT', ['.htaccess'], [], ['.txt'], [], InvalidPathException::class
-			],
-			'empty filename' => [
-				'', [], [], [], [], EmptyFileNameException::class
-			],
-			'reserved unix name "."' => [
-				'.', [], [], [], [], InvalidDirectoryException::class
-			],
-			'reserved unix name ".."' => [
-				'..', [], [], [], [], InvalidDirectoryException::class
-			],
-			'weird but valid tripple dot name' => [
-				'...', [], [], [], [], null // is valid
-			],
-			'too long filename "."' => [
-				str_repeat('a', 251), [], [], [], [], FileNameTooLongException::class
-			],
-			// make sure to not split the list entries as they migh contain Unicode sequences
-			// in this example the "face in clouds" emoji contains the clouds emoji so only having clouds is ok
-			['