nextcloud / server

apps/files/lib/Command/SanitizeFilenames.php

Indentation +138 added lines, -138 removed lines

@@ -26,143 +26,143 @@
 
 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();
-
-		$forbiddenCharacter = $this->filenameValidator->getForbiddenCharacters();
-		$charReplacement = array_diff([' ', '_', '-'], $forbiddenCharacter);
-		$charReplacement = reset($charReplacement) ?: '';
-
-		$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)',
-				default: $charReplacement,
-			);
+    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();
+
+        $forbiddenCharacter = $this->filenameValidator->getForbiddenCharacters();
+        $charReplacement = array_diff([' ', '_', '-'], $forbiddenCharacter);
+        $charReplacement = reset($charReplacement) ?: '';
+
+        $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)',
+                default: $charReplacement,
+            );
 			
-	}
-
-	protected function execute(InputInterface $input, OutputInterface $output): int {
-		$this->charReplacement = $input->getOption('char-replacement');
-		if ($this->charReplacement === '' || mb_strlen($this->charReplacement) > 1) {
-			$output->writeln('<error>No 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();
-				if (!$this->filenameValidator->isFilenameValid($oldName)) {
-					$newName = $this->sanitizeName($oldName);
-					$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);
-			}
-		}
-	}
-
-	private function sanitizeName(string $name): string {
-		$l10n = $this->l10nFactory->get('files');
-
-		foreach ($this->filenameValidator->getForbiddenExtensions() as $extension) {
-			if (str_ends_with($name, $extension)) {
-				$name = substr($name, 0, strlen($name) - strlen($extension));
-			}
-		}
-
-		$basename = substr($name, 0, strpos($name, '.', 1) ?: null);
-		if (in_array($basename, $this->filenameValidator->getForbiddenBasenames())) {
-			$name = str_replace($basename, $l10n->t('%1$s (renamed)', [$basename]), $name);
-		}
-
-		if ($name === '') {
-			$name = $l10n->t('renamed file');
-		}
-
-		$forbiddenCharacter = $this->filenameValidator->getForbiddenCharacters();
-		$name = str_replace($forbiddenCharacter, $this->charReplacement, $name);
-
-		return $name;
-	}
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int {
+        $this->charReplacement = $input->getOption('char-replacement');
+        if ($this->charReplacement === '' || mb_strlen($this->charReplacement) > 1) {
+            $output->writeln('<error>No 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();
+                if (!$this->filenameValidator->isFilenameValid($oldName)) {
+                    $newName = $this->sanitizeName($oldName);
+                    $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);
+            }
+        }
+    }
+
+    private function sanitizeName(string $name): string {
+        $l10n = $this->l10nFactory->get('files');
+
+        foreach ($this->filenameValidator->getForbiddenExtensions() as $extension) {
+            if (str_ends_with($name, $extension)) {
+                $name = substr($name, 0, strlen($name) - strlen($extension));
+            }
+        }
+
+        $basename = substr($name, 0, strpos($name, '.', 1) ?: null);
+        if (in_array($basename, $this->filenameValidator->getForbiddenBasenames())) {
+            $name = str_replace($basename, $l10n->t('%1$s (renamed)', [$basename]), $name);
+        }
+
+        if ($name === '') {
+            $name = $l10n->t('renamed file');
+        }
+
+        $forbiddenCharacter = $this->filenameValidator->getForbiddenCharacters();
+        $name = str_replace($forbiddenCharacter, $this->charReplacement, $name);
+
+        return $name;
+    }
 }

apps/files/lib/Command/WindowsCompatibleFilenames.php

Indentation +34 added lines, -34 removed lines

@@ -15,38 +15,38 @@
 
 class WindowsCompatibleFilenames extends Base {
 
-	public function __construct(
-		private SettingsService $service,
-	) {
-		parent::__construct();
-	}
-
-	protected function configure(): void {
-		parent::configure();
-
-		$this
-			->setName('files:windows-compatible-filenames')
-			->setDescription('Enforce naming constraints for windows compatible filenames')
-			->addOption('enable', description: 'Enable windows naming constraints')
-			->addOption('disable', description: 'Disable windows naming constraints');
-	}
-
-	protected function execute(InputInterface $input, OutputInterface $output): int {
-		if ($input->getOption('enable')) {
-			if ($this->service->hasFilesWindowsSupport()) {
-				$output->writeln('<error>Windows compatible filenames already enforced.</error>', OutputInterface::VERBOSITY_VERBOSE);
-			}
-			$this->service->setFilesWindowsSupport(true);
-			$output->writeln('Windows compatible filenames enforced.');
-		} elseif ($input->getOption('disable')) {
-			if (!$this->service->hasFilesWindowsSupport()) {
-				$output->writeln('<error>Windows compatible filenames already disabled.</error>', OutputInterface::VERBOSITY_VERBOSE);
-			}
-			$this->service->setFilesWindowsSupport(false);
-			$output->writeln('Windows compatible filename constraints removed.');
-		} else {
-			$output->writeln('Windows compatible filenames are ' . ($this->service->hasFilesWindowsSupport() ? 'enforced' : 'disabled'));
-		}
-		return self::SUCCESS;
-	}
+    public function __construct(
+        private SettingsService $service,
+    ) {
+        parent::__construct();
+    }
+
+    protected function configure(): void {
+        parent::configure();
+
+        $this
+            ->setName('files:windows-compatible-filenames')
+            ->setDescription('Enforce naming constraints for windows compatible filenames')
+            ->addOption('enable', description: 'Enable windows naming constraints')
+            ->addOption('disable', description: 'Disable windows naming constraints');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int {
+        if ($input->getOption('enable')) {
+            if ($this->service->hasFilesWindowsSupport()) {
+                $output->writeln('<error>Windows compatible filenames already enforced.</error>', OutputInterface::VERBOSITY_VERBOSE);
+            }
+            $this->service->setFilesWindowsSupport(true);
+            $output->writeln('Windows compatible filenames enforced.');
+        } elseif ($input->getOption('disable')) {
+            if (!$this->service->hasFilesWindowsSupport()) {
+                $output->writeln('<error>Windows compatible filenames already disabled.</error>', OutputInterface::VERBOSITY_VERBOSE);
+            }
+            $this->service->setFilesWindowsSupport(false);
+            $output->writeln('Windows compatible filename constraints removed.');
+        } else {
+            $output->writeln('Windows compatible filenames are ' . ($this->service->hasFilesWindowsSupport() ? 'enforced' : 'disabled'));
+        }
+        return self::SUCCESS;
+    }
 }

apps/files/lib/Settings/DeclarativeAdminSettings.php

Indentation +44 added lines, -44 removed lines

@@ -16,52 +16,52 @@
 
 class DeclarativeAdminSettings implements IDeclarativeSettingsFormWithHandlers {
 
-	public function __construct(
-		private IL10N $l,
-		private SettingsService $service,
-		private IURLGenerator $urlGenerator,
-	) {
-	}
+    public function __construct(
+        private IL10N $l,
+        private SettingsService $service,
+        private IURLGenerator $urlGenerator,
+    ) {
+    }
 
-	public function getValue(string $fieldId, IUser $user): mixed {
-		return match($fieldId) {
-			'windows_support' => $this->service->hasFilesWindowsSupport(),
-			default => throw new \InvalidArgumentException('Unexpected field id ' . $fieldId),
-		};
-	}
+    public function getValue(string $fieldId, IUser $user): mixed {
+        return match($fieldId) {
+            'windows_support' => $this->service->hasFilesWindowsSupport(),
+            default => throw new \InvalidArgumentException('Unexpected field id ' . $fieldId),
+        };
+    }
 
-	public function setValue(string $fieldId, mixed $value, IUser $user): void {
-		switch ($fieldId) {
-			case 'windows_support':
-				$this->service->setFilesWindowsSupport((bool)$value);
-				break;
-		}
-	}
+    public function setValue(string $fieldId, mixed $value, IUser $user): void {
+        switch ($fieldId) {
+            case 'windows_support':
+                $this->service->setFilesWindowsSupport((bool)$value);
+                break;
+        }
+    }
 
-	public function getSchema(): array {
-		return [
-			'id' => 'files-filename-support',
-			'priority' => 10,
-			'section_type' => DeclarativeSettingsTypes::SECTION_TYPE_ADMIN,
-			'section_id' => 'server',
-			'storage_type' => DeclarativeSettingsTypes::STORAGE_TYPE_EXTERNAL,
-			'title' => $this->l->t('Files compatibility'),
-			'doc_url' => $this->urlGenerator->linkToDocs('admin-windows-compatible-filenames'),
-			'description' => (
-				$this->l->t('Allow to restrict filenames to ensure files can be synced with all clients. By default all filenames valid on POSIX (e.g. Linux or macOS) are allowed.')
-				. "\n" . $this->l->t('After enabling the windows compatible filenames, existing files cannot be modified anymore but can be renamed to valid new names by their owner.')
-				. "\n" . $this->l->t('It is also possible to migrate files automatically after enabling this setting, please refer to the documentation about the occ command.')
-			),
+    public function getSchema(): array {
+        return [
+            'id' => 'files-filename-support',
+            'priority' => 10,
+            'section_type' => DeclarativeSettingsTypes::SECTION_TYPE_ADMIN,
+            'section_id' => 'server',
+            'storage_type' => DeclarativeSettingsTypes::STORAGE_TYPE_EXTERNAL,
+            'title' => $this->l->t('Files compatibility'),
+            'doc_url' => $this->urlGenerator->linkToDocs('admin-windows-compatible-filenames'),
+            'description' => (
+                $this->l->t('Allow to restrict filenames to ensure files can be synced with all clients. By default all filenames valid on POSIX (e.g. Linux or macOS) are allowed.')
+                . "\n" . $this->l->t('After enabling the windows compatible filenames, existing files cannot be modified anymore but can be renamed to valid new names by their owner.')
+                . "\n" . $this->l->t('It is also possible to migrate files automatically after enabling this setting, please refer to the documentation about the occ command.')
+            ),
 
-			'fields' => [
-				[
-					'id' => 'windows_support',
-					'title' => $this->l->t('Enforce Windows compatibility'),
-					'description' => $this->l->t('This will block filenames not valid on Windows systems, like using reserved names or special characters. But this will not enforce compatibility of case sensitivity.'),
-					'type' => DeclarativeSettingsTypes::CHECKBOX,
-					'default' => false,
-				],
-			],
-		];
-	}
+            'fields' => [
+                [
+                    'id' => 'windows_support',
+                    'title' => $this->l->t('Enforce Windows compatibility'),
+                    'description' => $this->l->t('This will block filenames not valid on Windows systems, like using reserved names or special characters. But this will not enforce compatibility of case sensitivity.'),
+                    'type' => DeclarativeSettingsTypes::CHECKBOX,
+                    'default' => false,
+                ],
+            ],
+        ];
+    }
 }