nextcloud / server

apps/files_external/lib/Config/UserPlaceholderHandler.php

Indentation +14 added lines, -14 removed lines

@@ -25,19 +25,19 @@
 namespace OCA\Files_External\Config;
 
 class UserPlaceholderHandler extends UserContext implements IConfigHandler {
-	use SimpleSubstitutionTrait;
+    use SimpleSubstitutionTrait;
 
-	/**
-	 * @param mixed $optionValue
-	 * @return mixed the same type as $optionValue
-	 * @since 16.0.0
-	 */
-	public function handle($optionValue) {
-		$this->placeholder = 'user';
-		$uid = $this->getUserId();
-		if ($uid === null) {
-			return $optionValue;
-		}
-		return $this->processInput($optionValue, $uid);
-	}
+    /**
+     * @param mixed $optionValue
+     * @return mixed the same type as $optionValue
+     * @since 16.0.0
+     */
+    public function handle($optionValue) {
+        $this->placeholder = 'user';
+        $uid = $this->getUserId();
+        if ($uid === null) {
+            return $optionValue;
+        }
+        return $this->processInput($optionValue, $uid);
+    }
 }

apps/files_external/lib/Config/SimpleSubstitutionTrait.php

Indentation +49 added lines, -49 removed lines

@@ -31,57 +31,57 @@
  * @since 16.0.0
  */
 trait SimpleSubstitutionTrait {
-	/**
-	 * @var string the placeholder without $ prefix
-	 * @since 16.0.0
-	 */
-	protected $placeholder;
+    /**
+     * @var string the placeholder without $ prefix
+     * @since 16.0.0
+     */
+    protected $placeholder;
 
-	/** @var string */
-	protected $sanitizedPlaceholder;
+    /** @var string */
+    protected $sanitizedPlaceholder;
 
-	/**
-	 * @param mixed $optionValue
-	 * @param string $replacement
-	 * @return mixed
-	 * @since 16.0.0
-	 */
-	private function processInput($optionValue, string $replacement) {
-		$this->checkPlaceholder();
-		if (is_array($optionValue)) {
-			foreach ($optionValue as &$value) {
-				$value = $this->substituteIfString($value, $replacement);
-			}
-		} else {
-			$optionValue = $this->substituteIfString($optionValue, $replacement);
-		}
-		return $optionValue;
-	}
+    /**
+     * @param mixed $optionValue
+     * @param string $replacement
+     * @return mixed
+     * @since 16.0.0
+     */
+    private function processInput($optionValue, string $replacement) {
+        $this->checkPlaceholder();
+        if (is_array($optionValue)) {
+            foreach ($optionValue as &$value) {
+                $value = $this->substituteIfString($value, $replacement);
+            }
+        } else {
+            $optionValue = $this->substituteIfString($optionValue, $replacement);
+        }
+        return $optionValue;
+    }
 
-	/**
-	 * @throws \RuntimeException
-	 */
-	protected function checkPlaceholder(): void {
-		$this->sanitizedPlaceholder = trim(strtolower($this->placeholder));
-		if (!(bool)\preg_match('/^[a-z0-9]*$/', $this->sanitizedPlaceholder)) {
-			throw new \RuntimeException(sprintf(
-				'Invalid placeholder %s, only [a-z0-9] are allowed', $this->sanitizedPlaceholder
-			));
-		}
-		if ($this->sanitizedPlaceholder === '') {
-			throw new \RuntimeException('Invalid empty placeholder');
-		}
-	}
+    /**
+     * @throws \RuntimeException
+     */
+    protected function checkPlaceholder(): void {
+        $this->sanitizedPlaceholder = trim(strtolower($this->placeholder));
+        if (!(bool)\preg_match('/^[a-z0-9]*$/', $this->sanitizedPlaceholder)) {
+            throw new \RuntimeException(sprintf(
+                'Invalid placeholder %s, only [a-z0-9] are allowed', $this->sanitizedPlaceholder
+            ));
+        }
+        if ($this->sanitizedPlaceholder === '') {
+            throw new \RuntimeException('Invalid empty placeholder');
+        }
+    }
 
-	/**
-	 * @param mixed $value
-	 * @param string $replacement
-	 * @return mixed
-	 */
-	protected function substituteIfString($value, string $replacement) {
-		if (is_string($value)) {
-			return str_ireplace('$' . $this->sanitizedPlaceholder, $replacement, $value);
-		}
-		return $value;
-	}
+    /**
+     * @param mixed $value
+     * @param string $replacement
+     * @return mixed
+     */
+    protected function substituteIfString($value, string $replacement) {
+        if (is_string($value)) {
+            return str_ireplace('$' . $this->sanitizedPlaceholder, $replacement, $value);
+        }
+        return $value;
+    }
 }

Spacing +2 added lines, -2 removed lines

@@ -63,7 +63,7 @@ 
 	 */
 	protected function checkPlaceholder(): void {
 		$this->sanitizedPlaceholder = trim(strtolower($this->placeholder));
-		if (!(bool)\preg_match('/^[a-z0-9]*$/', $this->sanitizedPlaceholder)) {
+		if (!(bool) \preg_match('/^[a-z0-9]*$/', $this->sanitizedPlaceholder)) {
 			throw new \RuntimeException(sprintf(
 				'Invalid placeholder %s, only [a-z0-9] are allowed', $this->sanitizedPlaceholder
 			));
@@ -80,7 +80,7 @@ 
 	 */
 	protected function substituteIfString($value, string $replacement) {
 		if (is_string($value)) {
-			return str_ireplace('$' . $this->sanitizedPlaceholder, $replacement, $value);
+			return str_ireplace('$'.$this->sanitizedPlaceholder, $replacement, $value);
 		}
 		return $value;
 	}

apps/files_external/lib/Service/BackendService.php

Spacing +4 added lines, -4 removed lines

@@ -216,7 +216,7 @@ 
 	 * @return Backend[]
 	 */
 	public function getAvailableBackends() {
-		return array_filter($this->getBackends(), function ($backend) {
+		return array_filter($this->getBackends(), function($backend) {
 			return !$backend->checkDependencies();
 		});
 	}
@@ -255,7 +255,7 @@ 
 	 * @return AuthMechanism[]
 	 */
 	public function getAuthMechanismsByScheme(array $schemes) {
-		return array_filter($this->getAuthMechanisms(), function ($authMech) use ($schemes) {
+		return array_filter($this->getAuthMechanisms(), function($authMech) use ($schemes) {
 			return in_array($authMech->getScheme(), $schemes, true);
 		});
 	}
@@ -322,7 +322,7 @@ 
 	 */
 	public function registerConfigHandler(string $placeholder, callable $configHandlerLoader) {
 		$placeholder = trim(strtolower($placeholder));
-		if (!(bool)\preg_match('/^[a-z0-9]*$/', $placeholder)) {
+		if (!(bool) \preg_match('/^[a-z0-9]*$/', $placeholder)) {
 			throw new \RuntimeException(sprintf(
 				'Invalid placeholder %s, only [a-z0-9] are allowed', $placeholder
 			));
@@ -353,7 +353,7 @@ 
 		if ($newLoaded) {
 			// ensure those with longest placeholders come first,
 			// to avoid substring matches
-			uksort($this->configHandlers, function ($phA, $phB) {
+			uksort($this->configHandlers, function($phA, $phB) {
 				return strlen($phB) <=> strlen($phA);
 			});
 		}

Indentation +321 added lines, -321 removed lines

@@ -22,325 +22,325 @@
  */
 class BackendService {
 
-	/** Visibility constants for VisibilityTrait */
-	public const VISIBILITY_NONE = 0;
-	public const VISIBILITY_PERSONAL = 1;
-	public const VISIBILITY_ADMIN = 2;
-	//const VISIBILITY_ALIENS = 4;
-
-	public const VISIBILITY_DEFAULT = 3; // PERSONAL | ADMIN
-
-	/** Priority constants for PriorityTrait */
-	public const PRIORITY_DEFAULT = 100;
-
-	/** @var bool */
-	private $userMountingAllowed = true;
-
-	/** @var string[] */
-	private $userMountingBackends = [];
-
-	/** @var Backend[] */
-	private $backends = [];
-
-	/** @var IBackendProvider[] */
-	private $backendProviders = [];
-
-	/** @var AuthMechanism[] */
-	private $authMechanisms = [];
-
-	/** @var IAuthMechanismProvider[] */
-	private $authMechanismProviders = [];
-
-	/** @var callable[] */
-	private $configHandlerLoaders = [];
-
-	private $configHandlers = [];
-
-	/**
-	 * @param IConfig $config
-	 */
-	public function __construct(
-		protected IConfig $config,
-	) {
-		// Load config values
-		if ($this->config->getAppValue('files_external', 'allow_user_mounting', 'yes') !== 'yes') {
-			$this->userMountingAllowed = false;
-		}
-		$this->userMountingBackends = explode(',',
-			$this->config->getAppValue('files_external', 'user_mounting_backends', '')
-		);
-
-		// if no backend is in the list an empty string is in the array and user mounting is disabled
-		if ($this->userMountingBackends === ['']) {
-			$this->userMountingAllowed = false;
-		}
-	}
-
-	/**
-	 * Register a backend provider
-	 *
-	 * @since 9.1.0
-	 * @param IBackendProvider $provider
-	 */
-	public function registerBackendProvider(IBackendProvider $provider) {
-		$this->backendProviders[] = $provider;
-	}
-
-	private function callForRegistrations() {
-		static $eventSent = false;
-		if (!$eventSent) {
-			Server::get(IEventDispatcher::class)->dispatch(
-				'OCA\\Files_External::loadAdditionalBackends',
-				new GenericEvent()
-			);
-			$eventSent = true;
-		}
-	}
-
-	private function loadBackendProviders() {
-		$this->callForRegistrations();
-		foreach ($this->backendProviders as $provider) {
-			$this->registerBackends($provider->getBackends());
-		}
-		$this->backendProviders = [];
-	}
-
-	/**
-	 * Register an auth mechanism provider
-	 *
-	 * @since 9.1.0
-	 * @param IAuthMechanismProvider $provider
-	 */
-	public function registerAuthMechanismProvider(IAuthMechanismProvider $provider) {
-		$this->authMechanismProviders[] = $provider;
-	}
-
-	private function loadAuthMechanismProviders() {
-		$this->callForRegistrations();
-		foreach ($this->authMechanismProviders as $provider) {
-			$this->registerAuthMechanisms($provider->getAuthMechanisms());
-		}
-		$this->authMechanismProviders = [];
-	}
-
-	/**
-	 * Register a backend
-	 *
-	 * @deprecated 9.1.0 use registerBackendProvider()
-	 * @param Backend $backend
-	 */
-	public function registerBackend(Backend $backend) {
-		if (!$this->isAllowedUserBackend($backend)) {
-			$backend->removeVisibility(BackendService::VISIBILITY_PERSONAL);
-		}
-		foreach ($backend->getIdentifierAliases() as $alias) {
-			$this->backends[$alias] = $backend;
-		}
-	}
-
-	/**
-	 * @deprecated 9.1.0 use registerBackendProvider()
-	 * @param Backend[] $backends
-	 */
-	public function registerBackends(array $backends) {
-		foreach ($backends as $backend) {
-			$this->registerBackend($backend);
-		}
-	}
-	/**
-	 * Register an authentication mechanism
-	 *
-	 * @deprecated 9.1.0 use registerAuthMechanismProvider()
-	 * @param AuthMechanism $authMech
-	 */
-	public function registerAuthMechanism(AuthMechanism $authMech) {
-		if (!$this->isAllowedAuthMechanism($authMech)) {
-			$authMech->removeVisibility(BackendService::VISIBILITY_PERSONAL);
-		}
-		foreach ($authMech->getIdentifierAliases() as $alias) {
-			$this->authMechanisms[$alias] = $authMech;
-		}
-	}
-
-	/**
-	 * @deprecated 9.1.0 use registerAuthMechanismProvider()
-	 * @param AuthMechanism[] $mechanisms
-	 */
-	public function registerAuthMechanisms(array $mechanisms) {
-		foreach ($mechanisms as $mechanism) {
-			$this->registerAuthMechanism($mechanism);
-		}
-	}
-
-	/**
-	 * Get all backends
-	 *
-	 * @return Backend[]
-	 */
-	public function getBackends() {
-		$this->loadBackendProviders();
-		// only return real identifiers, no aliases
-		$backends = [];
-		foreach ($this->backends as $backend) {
-			$backends[$backend->getIdentifier()] = $backend;
-		}
-		return $backends;
-	}
-
-	/**
-	 * Get all available backends
-	 *
-	 * @return Backend[]
-	 */
-	public function getAvailableBackends() {
-		return array_filter($this->getBackends(), function ($backend) {
-			return !$backend->checkDependencies();
-		});
-	}
-
-	/**
-	 * @param string $identifier
-	 * @return Backend|null
-	 */
-	public function getBackend($identifier) {
-		$this->loadBackendProviders();
-		if (isset($this->backends[$identifier])) {
-			return $this->backends[$identifier];
-		}
-		return null;
-	}
-
-	/**
-	 * Get all authentication mechanisms
-	 *
-	 * @return AuthMechanism[]
-	 */
-	public function getAuthMechanisms() {
-		$this->loadAuthMechanismProviders();
-		// only return real identifiers, no aliases
-		$mechanisms = [];
-		foreach ($this->authMechanisms as $mechanism) {
-			$mechanisms[$mechanism->getIdentifier()] = $mechanism;
-		}
-		return $mechanisms;
-	}
-
-	/**
-	 * Get all authentication mechanisms for schemes
-	 *
-	 * @param string[] $schemes
-	 * @return AuthMechanism[]
-	 */
-	public function getAuthMechanismsByScheme(array $schemes) {
-		return array_filter($this->getAuthMechanisms(), function ($authMech) use ($schemes) {
-			return in_array($authMech->getScheme(), $schemes, true);
-		});
-	}
-
-	/**
-	 * @param string $identifier
-	 * @return AuthMechanism|null
-	 */
-	public function getAuthMechanism($identifier) {
-		$this->loadAuthMechanismProviders();
-		if (isset($this->authMechanisms[$identifier])) {
-			return $this->authMechanisms[$identifier];
-		}
-		return null;
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isUserMountingAllowed() {
-		return $this->userMountingAllowed;
-	}
-
-	/**
-	 * Check a backend if a user is allowed to mount it
-	 *
-	 * @param Backend $backend
-	 * @return bool
-	 */
-	protected function isAllowedUserBackend(Backend $backend) {
-		if ($this->userMountingAllowed &&
-			array_intersect($backend->getIdentifierAliases(), $this->userMountingBackends)
-		) {
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * Check an authentication mechanism if a user is allowed to use it
-	 *
-	 * @param AuthMechanism $authMechanism
-	 * @return bool
-	 */
-	protected function isAllowedAuthMechanism(AuthMechanism $authMechanism) {
-		return true; // not implemented
-	}
-
-	/**
-	 * registers a configuration handler
-	 *
-	 * The function of the provided $placeholder is mostly to act a sorting
-	 * criteria, so longer placeholders are replaced first. This avoids
-	 * "$user" overwriting parts of "$userMail" and "$userLang", for example.
-	 * The provided value should not contain the $ prefix, only a-z0-9 are
-	 * allowed. Upper case letters are lower cased, the replacement is case-
-	 * insensitive.
-	 *
-	 * The configHandlerLoader should just instantiate the handler on demand.
-	 * For now all handlers are instantiated when a mount is loaded, independent
-	 * of whether the placeholder is present or not. This may change in future.
-	 *
-	 * @since 16.0.0
-	 */
-	public function registerConfigHandler(string $placeholder, callable $configHandlerLoader) {
-		$placeholder = trim(strtolower($placeholder));
-		if (!(bool)\preg_match('/^[a-z0-9]*$/', $placeholder)) {
-			throw new \RuntimeException(sprintf(
-				'Invalid placeholder %s, only [a-z0-9] are allowed', $placeholder
-			));
-		}
-		if ($placeholder === '') {
-			throw new \RuntimeException('Invalid empty placeholder');
-		}
-		if (isset($this->configHandlerLoaders[$placeholder]) || isset($this->configHandlers[$placeholder])) {
-			throw new \RuntimeException(sprintf('A handler is already registered for %s', $placeholder));
-		}
-		$this->configHandlerLoaders[$placeholder] = $configHandlerLoader;
-	}
-
-	protected function loadConfigHandlers():void {
-		$this->callForRegistrations();
-		$newLoaded = false;
-		foreach ($this->configHandlerLoaders as $placeholder => $loader) {
-			$handler = $loader();
-			if (!$handler instanceof IConfigHandler) {
-				throw new \RuntimeException(sprintf(
-					'Handler for %s is not an instance of IConfigHandler', $placeholder
-				));
-			}
-			$this->configHandlers[$placeholder] = $handler;
-			$newLoaded = true;
-		}
-		$this->configHandlerLoaders = [];
-		if ($newLoaded) {
-			// ensure those with longest placeholders come first,
-			// to avoid substring matches
-			uksort($this->configHandlers, function ($phA, $phB) {
-				return strlen($phB) <=> strlen($phA);
-			});
-		}
-	}
-
-	/**
-	 * @since 16.0.0
-	 */
-	public function getConfigHandlers() {
-		$this->loadConfigHandlers();
-		return $this->configHandlers;
-	}
+    /** Visibility constants for VisibilityTrait */
+    public const VISIBILITY_NONE = 0;
+    public const VISIBILITY_PERSONAL = 1;
+    public const VISIBILITY_ADMIN = 2;
+    //const VISIBILITY_ALIENS = 4;
+
+    public const VISIBILITY_DEFAULT = 3; // PERSONAL | ADMIN
+
+    /** Priority constants for PriorityTrait */
+    public const PRIORITY_DEFAULT = 100;
+
+    /** @var bool */
+    private $userMountingAllowed = true;
+
+    /** @var string[] */
+    private $userMountingBackends = [];
+
+    /** @var Backend[] */
+    private $backends = [];
+
+    /** @var IBackendProvider[] */
+    private $backendProviders = [];
+
+    /** @var AuthMechanism[] */
+    private $authMechanisms = [];
+
+    /** @var IAuthMechanismProvider[] */
+    private $authMechanismProviders = [];
+
+    /** @var callable[] */
+    private $configHandlerLoaders = [];
+
+    private $configHandlers = [];
+
+    /**
+     * @param IConfig $config
+     */
+    public function __construct(
+        protected IConfig $config,
+    ) {
+        // Load config values
+        if ($this->config->getAppValue('files_external', 'allow_user_mounting', 'yes') !== 'yes') {
+            $this->userMountingAllowed = false;
+        }
+        $this->userMountingBackends = explode(',',
+            $this->config->getAppValue('files_external', 'user_mounting_backends', '')
+        );
+
+        // if no backend is in the list an empty string is in the array and user mounting is disabled
+        if ($this->userMountingBackends === ['']) {
+            $this->userMountingAllowed = false;
+        }
+    }
+
+    /**
+     * Register a backend provider
+     *
+     * @since 9.1.0
+     * @param IBackendProvider $provider
+     */
+    public function registerBackendProvider(IBackendProvider $provider) {
+        $this->backendProviders[] = $provider;
+    }
+
+    private function callForRegistrations() {
+        static $eventSent = false;
+        if (!$eventSent) {
+            Server::get(IEventDispatcher::class)->dispatch(
+                'OCA\\Files_External::loadAdditionalBackends',
+                new GenericEvent()
+            );
+            $eventSent = true;
+        }
+    }
+
+    private function loadBackendProviders() {
+        $this->callForRegistrations();
+        foreach ($this->backendProviders as $provider) {
+            $this->registerBackends($provider->getBackends());
+        }
+        $this->backendProviders = [];
+    }
+
+    /**
+     * Register an auth mechanism provider
+     *
+     * @since 9.1.0
+     * @param IAuthMechanismProvider $provider
+     */
+    public function registerAuthMechanismProvider(IAuthMechanismProvider $provider) {
+        $this->authMechanismProviders[] = $provider;
+    }
+
+    private function loadAuthMechanismProviders() {
+        $this->callForRegistrations();
+        foreach ($this->authMechanismProviders as $provider) {
+            $this->registerAuthMechanisms($provider->getAuthMechanisms());
+        }
+        $this->authMechanismProviders = [];
+    }
+
+    /**
+     * Register a backend
+     *
+     * @deprecated 9.1.0 use registerBackendProvider()
+     * @param Backend $backend
+     */
+    public function registerBackend(Backend $backend) {
+        if (!$this->isAllowedUserBackend($backend)) {
+            $backend->removeVisibility(BackendService::VISIBILITY_PERSONAL);
+        }
+        foreach ($backend->getIdentifierAliases() as $alias) {
+            $this->backends[$alias] = $backend;
+        }
+    }
+
+    /**
+     * @deprecated 9.1.0 use registerBackendProvider()
+     * @param Backend[] $backends
+     */
+    public function registerBackends(array $backends) {
+        foreach ($backends as $backend) {
+            $this->registerBackend($backend);
+        }
+    }
+    /**
+     * Register an authentication mechanism
+     *
+     * @deprecated 9.1.0 use registerAuthMechanismProvider()
+     * @param AuthMechanism $authMech
+     */
+    public function registerAuthMechanism(AuthMechanism $authMech) {
+        if (!$this->isAllowedAuthMechanism($authMech)) {
+            $authMech->removeVisibility(BackendService::VISIBILITY_PERSONAL);
+        }
+        foreach ($authMech->getIdentifierAliases() as $alias) {
+            $this->authMechanisms[$alias] = $authMech;
+        }
+    }
+
+    /**
+     * @deprecated 9.1.0 use registerAuthMechanismProvider()
+     * @param AuthMechanism[] $mechanisms
+     */
+    public function registerAuthMechanisms(array $mechanisms) {
+        foreach ($mechanisms as $mechanism) {
+            $this->registerAuthMechanism($mechanism);
+        }
+    }
+
+    /**
+     * Get all backends
+     *
+     * @return Backend[]
+     */
+    public function getBackends() {
+        $this->loadBackendProviders();
+        // only return real identifiers, no aliases
+        $backends = [];
+        foreach ($this->backends as $backend) {
+            $backends[$backend->getIdentifier()] = $backend;
+        }
+        return $backends;
+    }
+
+    /**
+     * Get all available backends
+     *
+     * @return Backend[]
+     */
+    public function getAvailableBackends() {
+        return array_filter($this->getBackends(), function ($backend) {
+            return !$backend->checkDependencies();
+        });
+    }
+
+    /**
+     * @param string $identifier
+     * @return Backend|null
+     */
+    public function getBackend($identifier) {
+        $this->loadBackendProviders();
+        if (isset($this->backends[$identifier])) {
+            return $this->backends[$identifier];
+        }
+        return null;
+    }
+
+    /**
+     * Get all authentication mechanisms
+     *
+     * @return AuthMechanism[]
+     */
+    public function getAuthMechanisms() {
+        $this->loadAuthMechanismProviders();
+        // only return real identifiers, no aliases
+        $mechanisms = [];
+        foreach ($this->authMechanisms as $mechanism) {
+            $mechanisms[$mechanism->getIdentifier()] = $mechanism;
+        }
+        return $mechanisms;
+    }
+
+    /**
+     * Get all authentication mechanisms for schemes
+     *
+     * @param string[] $schemes
+     * @return AuthMechanism[]
+     */
+    public function getAuthMechanismsByScheme(array $schemes) {
+        return array_filter($this->getAuthMechanisms(), function ($authMech) use ($schemes) {
+            return in_array($authMech->getScheme(), $schemes, true);
+        });
+    }
+
+    /**
+     * @param string $identifier
+     * @return AuthMechanism|null
+     */
+    public function getAuthMechanism($identifier) {
+        $this->loadAuthMechanismProviders();
+        if (isset($this->authMechanisms[$identifier])) {
+            return $this->authMechanisms[$identifier];
+        }
+        return null;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isUserMountingAllowed() {
+        return $this->userMountingAllowed;
+    }
+
+    /**
+     * Check a backend if a user is allowed to mount it
+     *
+     * @param Backend $backend
+     * @return bool
+     */
+    protected function isAllowedUserBackend(Backend $backend) {
+        if ($this->userMountingAllowed &&
+            array_intersect($backend->getIdentifierAliases(), $this->userMountingBackends)
+        ) {
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Check an authentication mechanism if a user is allowed to use it
+     *
+     * @param AuthMechanism $authMechanism
+     * @return bool
+     */
+    protected function isAllowedAuthMechanism(AuthMechanism $authMechanism) {
+        return true; // not implemented
+    }
+
+    /**
+     * registers a configuration handler
+     *
+     * The function of the provided $placeholder is mostly to act a sorting
+     * criteria, so longer placeholders are replaced first. This avoids
+     * "$user" overwriting parts of "$userMail" and "$userLang", for example.
+     * The provided value should not contain the $ prefix, only a-z0-9 are
+     * allowed. Upper case letters are lower cased, the replacement is case-
+     * insensitive.
+     *
+     * The configHandlerLoader should just instantiate the handler on demand.
+     * For now all handlers are instantiated when a mount is loaded, independent
+     * of whether the placeholder is present or not. This may change in future.
+     *
+     * @since 16.0.0
+     */
+    public function registerConfigHandler(string $placeholder, callable $configHandlerLoader) {
+        $placeholder = trim(strtolower($placeholder));
+        if (!(bool)\preg_match('/^[a-z0-9]*$/', $placeholder)) {
+            throw new \RuntimeException(sprintf(
+                'Invalid placeholder %s, only [a-z0-9] are allowed', $placeholder
+            ));
+        }
+        if ($placeholder === '') {
+            throw new \RuntimeException('Invalid empty placeholder');
+        }
+        if (isset($this->configHandlerLoaders[$placeholder]) || isset($this->configHandlers[$placeholder])) {
+            throw new \RuntimeException(sprintf('A handler is already registered for %s', $placeholder));
+        }
+        $this->configHandlerLoaders[$placeholder] = $configHandlerLoader;
+    }
+
+    protected function loadConfigHandlers():void {
+        $this->callForRegistrations();
+        $newLoaded = false;
+        foreach ($this->configHandlerLoaders as $placeholder => $loader) {
+            $handler = $loader();
+            if (!$handler instanceof IConfigHandler) {
+                throw new \RuntimeException(sprintf(
+                    'Handler for %s is not an instance of IConfigHandler', $placeholder
+                ));
+            }
+            $this->configHandlers[$placeholder] = $handler;
+            $newLoaded = true;
+        }
+        $this->configHandlerLoaders = [];
+        if ($newLoaded) {
+            // ensure those with longest placeholders come first,
+            // to avoid substring matches
+            uksort($this->configHandlers, function ($phA, $phB) {
+                return strlen($phB) <=> strlen($phA);
+            });
+        }
+    }
+
+    /**
+     * @since 16.0.0
+     */
+    public function getConfigHandlers() {
+        $this->loadConfigHandlers();
+        return $this->configHandlers;
+    }
 }

apps/comments/lib/Collaboration/CommentersSorter.php

Spacing +2 added lines, -2 removed lines

@@ -60,11 +60,11 @@
 			// at least on PHP 5.6 usort turned out to be not stable. So we add
 			// the current index to the value and compare it on a draw
 			$i = 0;
-			$workArray = array_map(function ($element) use (&$i) {
+			$workArray = array_map(function($element) use (&$i) {
 				return [$i++, $element];
 			}, $byType);
 
-			usort($workArray, function ($a, $b) use ($commenters, $type) {
+			usort($workArray, function($a, $b) use ($commenters, $type) {
 				$r = $this->compare($a[1], $b[1], $commenters[$type]);
 				if ($r === 0) {
 					$r = $a[0] - $b[0];

Indentation +68 added lines, -68 removed lines

@@ -9,83 +9,83 @@
 use OCP\Comments\ICommentsManager;
 
 class CommentersSorter implements ISorter {
-	public function __construct(
-		private ICommentsManager $commentsManager,
-	) {
-	}
+    public function __construct(
+        private ICommentsManager $commentsManager,
+    ) {
+    }
 
-	public function getId(): string {
-		return 'commenters';
-	}
+    public function getId(): string {
+        return 'commenters';
+    }
 
-	/**
-	 * Sorts people who commented on the given item atop (descelating) of the
-	 * others
-	 *
-	 * @param array &$sortArray
-	 * @param array $context
-	 */
-	public function sort(array &$sortArray, array $context): void {
-		$commenters = $this->retrieveCommentsInformation($context['itemType'], $context['itemId']);
-		if (count($commenters) === 0) {
-			return;
-		}
+    /**
+     * Sorts people who commented on the given item atop (descelating) of the
+     * others
+     *
+     * @param array &$sortArray
+     * @param array $context
+     */
+    public function sort(array &$sortArray, array $context): void {
+        $commenters = $this->retrieveCommentsInformation($context['itemType'], $context['itemId']);
+        if (count($commenters) === 0) {
+            return;
+        }
 
-		foreach ($sortArray as $type => &$byType) {
-			if (!isset($commenters[$type])) {
-				continue;
-			}
+        foreach ($sortArray as $type => &$byType) {
+            if (!isset($commenters[$type])) {
+                continue;
+            }
 
-			// at least on PHP 5.6 usort turned out to be not stable. So we add
-			// the current index to the value and compare it on a draw
-			$i = 0;
-			$workArray = array_map(function ($element) use (&$i) {
-				return [$i++, $element];
-			}, $byType);
+            // at least on PHP 5.6 usort turned out to be not stable. So we add
+            // the current index to the value and compare it on a draw
+            $i = 0;
+            $workArray = array_map(function ($element) use (&$i) {
+                return [$i++, $element];
+            }, $byType);
 
-			usort($workArray, function ($a, $b) use ($commenters, $type) {
-				$r = $this->compare($a[1], $b[1], $commenters[$type]);
-				if ($r === 0) {
-					$r = $a[0] - $b[0];
-				}
-				return $r;
-			});
+            usort($workArray, function ($a, $b) use ($commenters, $type) {
+                $r = $this->compare($a[1], $b[1], $commenters[$type]);
+                if ($r === 0) {
+                    $r = $a[0] - $b[0];
+                }
+                return $r;
+            });
 
-			// and remove the index values again
-			$byType = array_column($workArray, 1);
-		}
-	}
+            // and remove the index values again
+            $byType = array_column($workArray, 1);
+        }
+    }
 
-	/**
-	 * @return array<string, array<string, int>>
-	 */
-	protected function retrieveCommentsInformation(string $type, string $id): array {
-		$comments = $this->commentsManager->getForObject($type, $id);
-		if (count($comments) === 0) {
-			return [];
-		}
+    /**
+     * @return array<string, array<string, int>>
+     */
+    protected function retrieveCommentsInformation(string $type, string $id): array {
+        $comments = $this->commentsManager->getForObject($type, $id);
+        if (count($comments) === 0) {
+            return [];
+        }
 
-		$actors = [];
-		foreach ($comments as $comment) {
-			if (!isset($actors[$comment->getActorType()])) {
-				$actors[$comment->getActorType()] = [];
-			}
-			if (!isset($actors[$comment->getActorType()][$comment->getActorId()])) {
-				$actors[$comment->getActorType()][$comment->getActorId()] = 1;
-			} else {
-				$actors[$comment->getActorType()][$comment->getActorId()]++;
-			}
-		}
-		return $actors;
-	}
+        $actors = [];
+        foreach ($comments as $comment) {
+            if (!isset($actors[$comment->getActorType()])) {
+                $actors[$comment->getActorType()] = [];
+            }
+            if (!isset($actors[$comment->getActorType()][$comment->getActorId()])) {
+                $actors[$comment->getActorType()][$comment->getActorId()] = 1;
+            } else {
+                $actors[$comment->getActorType()][$comment->getActorId()]++;
+            }
+        }
+        return $actors;
+    }
 
-	protected function compare(array $a, array $b, array $commenters): int {
-		$a = $a['value']['shareWith'];
-		$b = $b['value']['shareWith'];
+    protected function compare(array $a, array $b, array $commenters): int {
+        $a = $a['value']['shareWith'];
+        $b = $b['value']['shareWith'];
 
-		$valueA = $commenters[$a] ?? 0;
-		$valueB = $commenters[$b] ?? 0;
+        $valueA = $commenters[$a] ?? 0;
+        $valueB = $commenters[$b] ?? 0;
 
-		return $valueB - $valueA;
-	}
+        return $valueB - $valueA;
+    }
 }

core/templates/404.php

Spacing +1 added lines, -1 removed lines

@@ -7,7 +7,7 @@
 	require_once '../../lib/base.php';
 
 	$urlGenerator = \OC::$server->getURLGenerator();
-	header('Location: ' . $urlGenerator->getAbsoluteURL('/'));
+	header('Location: '.$urlGenerator->getAbsoluteURL('/'));
 	exit;
 }
 // @codeCoverageIgnoreEnd

Indentation +4 added lines, -4 removed lines

@@ -4,11 +4,11 @@
 /** @var \OCP\Defaults $theme */
 // @codeCoverageIgnoreStart
 if (!isset($_)) {//standalone  page is not supported anymore - redirect to /
-	require_once '../../lib/base.php';
+    require_once '../../lib/base.php';
 
-	$urlGenerator = \OC::$server->getURLGenerator();
-	header('Location: ' . $urlGenerator->getAbsoluteURL('/'));
-	exit;
+    $urlGenerator = \OC::$server->getURLGenerator();
+    header('Location: ' . $urlGenerator->getAbsoluteURL('/'));
+    exit;
 }
 // @codeCoverageIgnoreEnd
 ?>

Braces +5 added lines, -2 removed lines

@@ -14,10 +14,13 @@
 ?>
 <?php if (isset($_['content'])): ?>
 	<?php print_unescaped($_['content']) ?>
-<?php else: ?>
+<?php else {
+    : ?>
 	<div class="body-login-container update">
 		<div class="icon-big icon-search"></div>
-		<h2><?php p($l->t('Page not found')); ?></h2>
+		<h2><?php p($l->t('Page not found'));
+}
+?></h2>
 		<p class="infogroup"><?php p($l->t('The page could not be found on the server or you may not be allowed to view it.')); ?></p>
 		<p><a class="button primary" href="<?php p(\OC::$server->getURLGenerator()->linkTo('', 'index.php')) ?>">
 			<?php p($l->t('Back to %s', [$theme->getName()])); ?>

core/templates/loginflow/authpicker.php

Spacing +1 added lines, -1 removed lines

@@ -30,7 +30,7 @@
 	<h2><?php p($l->t('Connect to your account')) ?></h2>
 	<p class="info">
 		<?php print_unescaped($l->t('Please log in before granting %1$s access to your %2$s account.', [
-			'<strong>' . \OCP\Util::sanitizeHTML($_['client']) . '</strong>',
+			'<strong>'.\OCP\Util::sanitizeHTML($_['client']).'</strong>',
 			\OCP\Util::sanitizeHTML($_['instanceName'])
 		])) ?>
 	</p>

Indentation +3 added lines, -3 removed lines

@@ -31,9 +31,9 @@
 	<h2><?php p($l->t('Connect to your account')) ?></h2>
 	<p class="info">
 		<?php print_unescaped($l->t('Please log in before granting %1$s access to your %2$s account.', [
-			'<strong>' . \OCP\Util::sanitizeHTML($_['client']) . '</strong>',
-			\OCP\Util::sanitizeHTML($_['instanceName'])
-		])) ?>
+            '<strong>' . \OCP\Util::sanitizeHTML($_['client']) . '</strong>',
+            \OCP\Util::sanitizeHTML($_['instanceName'])
+        ])) ?>
 	</p>
 
 	<div class="notecard warning">

core/templates/error.php

Spacing +1 added lines, -1 removed lines

@@ -6,7 +6,7 @@
 			<p><?php p($error['error']) ?></p>
 			<?php if (isset($error['hint']) && $error['hint']): ?>
 				<p class='hint'><?php p($error['hint']) ?></p>
-			<?php endif;?>
+			<?php endif; ?>
 		</li>
 	<?php endforeach ?>
 	</ul>

core/templates/twofactorselectchallenge.php

Braces +13 added lines, -5 removed lines

@@ -27,11 +27,15 @@ 
 					<?php p($l->t('Set up two-factor authentication')) ?>
 				</a>
 			<?php } ?>
-		<?php else: ?>
+		<?php else {
+    : ?>
 			<strong><?php p($l->t('Two-factor authentication is enforced but has not been configured on your account. Use one of your backup codes to log in or contact your admin for assistance.')) ?></strong>
-		<?php endif; ?>
+		<?php endif;
+}
+?>
 	</p>
-	<?php else: ?>
+	<?php else {
+    : ?>
 	<ul>
 	<?php foreach ($_['providers'] as $provider): ?>
 		<li>
@@ -45,6 +49,7 @@ 
 				<?php
 				if ($provider instanceof \OCP\Authentication\TwoFactorAuth\IProvidesIcons) {
 					$icon = $provider->getLightIcon();
+}
 				} else {
 					$icon = image_path('core', 'actions/password-white.svg');
 				}
@@ -61,7 +66,8 @@ 
 	<?php endif ?>
 	<?php if (!is_null($_['backupProvider'])): ?>
 	<p>
-		<a class="<?php if ($noProviders): ?>button primary two-factor-primary<?php else: ?>two-factor-secondary<?php endif ?>" href="<?php p(\OC::$server->getURLGenerator()->linkToRoute('core.TwoFactorChallenge.showChallenge',
+		<a class="<?php if ($noProviders): ?>button primary two-factor-primary<?php else {
+    : ?>two-factor-secondary<?php endif ?>" href="<?php p(\OC::$server->getURLGenerator()->linkToRoute('core.TwoFactorChallenge.showChallenge',
 			[
 				'challengeProviderId' => $_['backupProvider']->getId(),
 				'redirect_url' => $_['redirect_url'],
@@ -70,7 +76,9 @@ 
 			<?php p($l->t('Use backup code')) ?>
 		</a>
 	</p>
-	<?php endif; ?>
+	<?php endif;
+}
+?>
 	<p><a class="two-factor-secondary" href="<?php print_unescaped($_['logout_url']); ?>">
 		<?php p($l->t('Cancel login')) ?>
 	</a></p>

Indentation +20 added lines, -20 removed lines

@@ -20,10 +20,10 @@ 
 			<?php } else { ?>
 				<strong><?php p($l->t('Two-factor authentication is enforced but has not been configured on your account. Please continue to setup two-factor authentication.')) ?></strong>
 				<a class="button primary two-factor-primary" href="<?php p(\OC::$server->getURLGenerator()->linkToRoute('core.TwoFactorChallenge.setupProviders',
-					[
-						'redirect_url' => $_['redirect_url'],
-					]
-				)) ?>">
+                    [
+                        'redirect_url' => $_['redirect_url'],
+                    ]
+                )) ?>">
 					<?php p($l->t('Set up two-factor authentication')) ?>
 				</a>
 			<?php } ?>
@@ -37,18 +37,18 @@ 
 		<li>
 			<a class="two-factor-provider"
 			   href="<?php p(\OC::$server->getURLGenerator()->linkToRoute('core.TwoFactorChallenge.showChallenge',
-			   	[
-			   		'challengeProviderId' => $provider->getId(),
-			   		'redirect_url' => $_['redirect_url'],
-			   	]
-			   )) ?>">
+                    [
+                        'challengeProviderId' => $provider->getId(),
+                        'redirect_url' => $_['redirect_url'],
+                    ]
+                )) ?>">
 				<?php
-				if ($provider instanceof \OCP\Authentication\TwoFactorAuth\IProvidesIcons) {
-					$icon = $provider->getLightIcon();
-				} else {
-					$icon = image_path('core', 'actions/password-white.svg');
-				}
-		?>
+                if ($provider instanceof \OCP\Authentication\TwoFactorAuth\IProvidesIcons) {
+                    $icon = $provider->getLightIcon();
+                } else {
+                    $icon = image_path('core', 'actions/password-white.svg');
+                }
+        ?>
 				<img src="<?php p($icon) ?>" alt="" />
 				<div>
 					<h3><?php p($provider->getDisplayName()) ?></h3>
@@ -62,11 +62,11 @@ 
 	<?php if (!is_null($_['backupProvider'])): ?>
 	<p>
 		<a class="<?php if ($noProviders): ?>button primary two-factor-primary<?php else: ?>two-factor-secondary<?php endif ?>" href="<?php p(\OC::$server->getURLGenerator()->linkToRoute('core.TwoFactorChallenge.showChallenge',
-			[
-				'challengeProviderId' => $_['backupProvider']->getId(),
-				'redirect_url' => $_['redirect_url'],
-			]
-		)) ?>">
+            [
+                'challengeProviderId' => $_['backupProvider']->getId(),
+                'redirect_url' => $_['redirect_url'],
+            ]
+        )) ?>">
 			<?php p($l->t('Use backup code')) ?>
 		</a>
 	</p>

core/Command/Encryption/ChangeKeyStorageRoot.php

Spacing +8 added lines, -8 removed lines

@@ -142,7 +142,7 @@ 
 		}
 
 		$result = $this->rootView->file_put_contents(
-			$newRoot . '/' . Storage::KEY_STORAGE_MARKER,
+			$newRoot.'/'.Storage::KEY_STORAGE_MARKER,
 			'Nextcloud will detect this folder as key storage root only if this file exists'
 		);
 
@@ -160,10 +160,10 @@ 
 	 */
 	protected function moveSystemKeys($oldRoot, $newRoot) {
 		if (
-			$this->rootView->is_dir($oldRoot . '/files_encryption') &&
-			$this->targetExists($newRoot . '/files_encryption') === false
+			$this->rootView->is_dir($oldRoot.'/files_encryption') &&
+			$this->targetExists($newRoot.'/files_encryption') === false
 		) {
-			$this->rootView->rename($oldRoot . '/files_encryption', $newRoot . '/files_encryption');
+			$this->rootView->rename($oldRoot.'/files_encryption', $newRoot.'/files_encryption');
 		}
 	}
 
@@ -217,13 +217,13 @@ 
 	 */
 	protected function moveUserEncryptionFolder($user, $oldRoot, $newRoot) {
 		if ($this->userManager->userExists($user)) {
-			$source = $oldRoot . '/' . $user . '/files_encryption';
-			$target = $newRoot . '/' . $user . '/files_encryption';
+			$source = $oldRoot.'/'.$user.'/files_encryption';
+			$target = $newRoot.'/'.$user.'/files_encryption';
 			if (
 				$this->rootView->is_dir($source) &&
 				$this->targetExists($target) === false
 			) {
-				$this->prepareParentFolder($newRoot . '/' . $user);
+				$this->prepareParentFolder($newRoot.'/'.$user);
 				$this->rootView->rename($source, $target);
 			}
 		}
@@ -241,7 +241,7 @@ 
 			$sub_dirs = explode('/', ltrim($path, '/'));
 			$dir = '';
 			foreach ($sub_dirs as $sub_dir) {
-				$dir .= '/' . $sub_dir;
+				$dir .= '/'.$sub_dir;
 				if ($this->rootView->file_exists($dir) === false) {
 					$this->rootView->mkdir($dir);
 				}

Indentation +204 added lines, -204 removed lines

@@ -22,208 +22,208 @@
 use Symfony\Component\Console\Question\ConfirmationQuestion;
 
 class ChangeKeyStorageRoot extends Command {
-	public function __construct(
-		protected View $rootView,
-		protected IUserManager $userManager,
-		protected IConfig $config,
-		protected Util $util,
-		protected QuestionHelper $questionHelper,
-	) {
-		parent::__construct();
-	}
-
-	protected function configure() {
-		parent::configure();
-		$this
-			->setName('encryption:change-key-storage-root')
-			->setDescription('Change key storage root')
-			->addArgument(
-				'newRoot',
-				InputArgument::OPTIONAL,
-				'new root of the key storage relative to the data folder'
-			);
-	}
-
-	protected function execute(InputInterface $input, OutputInterface $output): int {
-		$oldRoot = $this->util->getKeyStorageRoot();
-		$newRoot = $input->getArgument('newRoot');
-
-		if ($newRoot === null) {
-			$question = new ConfirmationQuestion('No storage root given, do you want to reset the key storage root to the default location? (y/n) ', false);
-			if (!$this->questionHelper->ask($input, $output, $question)) {
-				return 1;
-			}
-			$newRoot = '';
-		}
-
-		$oldRootDescription = $oldRoot !== '' ? $oldRoot : 'default storage location';
-		$newRootDescription = $newRoot !== '' ? $newRoot : 'default storage location';
-		$output->writeln("Change key storage root from <info>$oldRootDescription</info> to <info>$newRootDescription</info>");
-		$success = $this->moveAllKeys($oldRoot, $newRoot, $output);
-		if ($success) {
-			$this->util->setKeyStorageRoot($newRoot);
-			$output->writeln('');
-			$output->writeln("Key storage root successfully changed to <info>$newRootDescription</info>");
-			return 0;
-		}
-		return 1;
-	}
-
-	/**
-	 * move keys to new key storage root
-	 *
-	 * @param string $oldRoot
-	 * @param string $newRoot
-	 * @param OutputInterface $output
-	 * @return bool
-	 * @throws \Exception
-	 */
-	protected function moveAllKeys($oldRoot, $newRoot, OutputInterface $output) {
-		$output->writeln('Start to move keys:');
-
-		if ($this->rootView->is_dir($oldRoot) === false) {
-			$output->writeln('No old keys found: Nothing needs to be moved');
-			return false;
-		}
-
-		$this->prepareNewRoot($newRoot);
-		$this->moveSystemKeys($oldRoot, $newRoot);
-		$this->moveUserKeys($oldRoot, $newRoot, $output);
-
-		return true;
-	}
-
-	/**
-	 * prepare new key storage
-	 *
-	 * @param string $newRoot
-	 * @throws \Exception
-	 */
-	protected function prepareNewRoot($newRoot) {
-		if ($this->rootView->is_dir($newRoot) === false) {
-			throw new \Exception("New root folder doesn't exist. Please create the folder or check the permissions and try again.");
-		}
-
-		$result = $this->rootView->file_put_contents(
-			$newRoot . '/' . Storage::KEY_STORAGE_MARKER,
-			'Nextcloud will detect this folder as key storage root only if this file exists'
-		);
-
-		if (!$result) {
-			throw new \Exception("Can't access the new root folder. Please check the permissions and make sure that the folder is in your data folder");
-		}
-	}
-
-
-	/**
-	 * move system key folder
-	 *
-	 * @param string $oldRoot
-	 * @param string $newRoot
-	 */
-	protected function moveSystemKeys($oldRoot, $newRoot) {
-		if (
-			$this->rootView->is_dir($oldRoot . '/files_encryption') &&
-			$this->targetExists($newRoot . '/files_encryption') === false
-		) {
-			$this->rootView->rename($oldRoot . '/files_encryption', $newRoot . '/files_encryption');
-		}
-	}
-
-
-	/**
-	 * setup file system for the given user
-	 *
-	 * @param string $uid
-	 */
-	protected function setupUserFS($uid) {
-		\OC_Util::tearDownFS();
-		\OC_Util::setupFS($uid);
-	}
-
-
-	/**
-	 * iterate over each user and move the keys to the new storage
-	 *
-	 * @param string $oldRoot
-	 * @param string $newRoot
-	 * @param OutputInterface $output
-	 */
-	protected function moveUserKeys($oldRoot, $newRoot, OutputInterface $output) {
-		$progress = new ProgressBar($output);
-		$progress->start();
-
-
-		foreach ($this->userManager->getBackends() as $backend) {
-			$limit = 500;
-			$offset = 0;
-			do {
-				$users = $backend->getUsers('', $limit, $offset);
-				foreach ($users as $user) {
-					$progress->advance();
-					$this->setupUserFS($user);
-					$this->moveUserEncryptionFolder($user, $oldRoot, $newRoot);
-				}
-				$offset += $limit;
-			} while (count($users) >= $limit);
-		}
-		$progress->finish();
-	}
-
-	/**
-	 * move user encryption folder to new root folder
-	 *
-	 * @param string $user
-	 * @param string $oldRoot
-	 * @param string $newRoot
-	 * @throws \Exception
-	 */
-	protected function moveUserEncryptionFolder($user, $oldRoot, $newRoot) {
-		if ($this->userManager->userExists($user)) {
-			$source = $oldRoot . '/' . $user . '/files_encryption';
-			$target = $newRoot . '/' . $user . '/files_encryption';
-			if (
-				$this->rootView->is_dir($source) &&
-				$this->targetExists($target) === false
-			) {
-				$this->prepareParentFolder($newRoot . '/' . $user);
-				$this->rootView->rename($source, $target);
-			}
-		}
-	}
-
-	/**
-	 * Make preparations to filesystem for saving a key file
-	 *
-	 * @param string $path relative to data/
-	 */
-	protected function prepareParentFolder($path) {
-		$path = Filesystem::normalizePath($path);
-		// If the file resides within a subdirectory, create it
-		if ($this->rootView->file_exists($path) === false) {
-			$sub_dirs = explode('/', ltrim($path, '/'));
-			$dir = '';
-			foreach ($sub_dirs as $sub_dir) {
-				$dir .= '/' . $sub_dir;
-				if ($this->rootView->file_exists($dir) === false) {
-					$this->rootView->mkdir($dir);
-				}
-			}
-		}
-	}
-
-	/**
-	 * check if target already exists
-	 *
-	 * @param $path
-	 * @return bool
-	 * @throws \Exception
-	 */
-	protected function targetExists($path) {
-		if ($this->rootView->file_exists($path)) {
-			throw new \Exception("new folder '$path' already exists");
-		}
-
-		return false;
-	}
+    public function __construct(
+        protected View $rootView,
+        protected IUserManager $userManager,
+        protected IConfig $config,
+        protected Util $util,
+        protected QuestionHelper $questionHelper,
+    ) {
+        parent::__construct();
+    }
+
+    protected function configure() {
+        parent::configure();
+        $this
+            ->setName('encryption:change-key-storage-root')
+            ->setDescription('Change key storage root')
+            ->addArgument(
+                'newRoot',
+                InputArgument::OPTIONAL,
+                'new root of the key storage relative to the data folder'
+            );
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int {
+        $oldRoot = $this->util->getKeyStorageRoot();
+        $newRoot = $input->getArgument('newRoot');
+
+        if ($newRoot === null) {
+            $question = new ConfirmationQuestion('No storage root given, do you want to reset the key storage root to the default location? (y/n) ', false);
+            if (!$this->questionHelper->ask($input, $output, $question)) {
+                return 1;
+            }
+            $newRoot = '';
+        }
+
+        $oldRootDescription = $oldRoot !== '' ? $oldRoot : 'default storage location';
+        $newRootDescription = $newRoot !== '' ? $newRoot : 'default storage location';
+        $output->writeln("Change key storage root from <info>$oldRootDescription</info> to <info>$newRootDescription</info>");
+        $success = $this->moveAllKeys($oldRoot, $newRoot, $output);
+        if ($success) {
+            $this->util->setKeyStorageRoot($newRoot);
+            $output->writeln('');
+            $output->writeln("Key storage root successfully changed to <info>$newRootDescription</info>");
+            return 0;
+        }
+        return 1;
+    }
+
+    /**
+     * move keys to new key storage root
+     *
+     * @param string $oldRoot
+     * @param string $newRoot
+     * @param OutputInterface $output
+     * @return bool
+     * @throws \Exception
+     */
+    protected function moveAllKeys($oldRoot, $newRoot, OutputInterface $output) {
+        $output->writeln('Start to move keys:');
+
+        if ($this->rootView->is_dir($oldRoot) === false) {
+            $output->writeln('No old keys found: Nothing needs to be moved');
+            return false;
+        }
+
+        $this->prepareNewRoot($newRoot);
+        $this->moveSystemKeys($oldRoot, $newRoot);
+        $this->moveUserKeys($oldRoot, $newRoot, $output);
+
+        return true;
+    }
+
+    /**
+     * prepare new key storage
+     *
+     * @param string $newRoot
+     * @throws \Exception
+     */
+    protected function prepareNewRoot($newRoot) {
+        if ($this->rootView->is_dir($newRoot) === false) {
+            throw new \Exception("New root folder doesn't exist. Please create the folder or check the permissions and try again.");
+        }
+
+        $result = $this->rootView->file_put_contents(
+            $newRoot . '/' . Storage::KEY_STORAGE_MARKER,
+            'Nextcloud will detect this folder as key storage root only if this file exists'
+        );
+
+        if (!$result) {
+            throw new \Exception("Can't access the new root folder. Please check the permissions and make sure that the folder is in your data folder");
+        }
+    }
+
+
+    /**
+     * move system key folder
+     *
+     * @param string $oldRoot
+     * @param string $newRoot
+     */
+    protected function moveSystemKeys($oldRoot, $newRoot) {
+        if (
+            $this->rootView->is_dir($oldRoot . '/files_encryption') &&
+            $this->targetExists($newRoot . '/files_encryption') === false
+        ) {
+            $this->rootView->rename($oldRoot . '/files_encryption', $newRoot . '/files_encryption');
+        }
+    }
+
+
+    /**
+     * setup file system for the given user
+     *
+     * @param string $uid
+     */
+    protected function setupUserFS($uid) {
+        \OC_Util::tearDownFS();
+        \OC_Util::setupFS($uid);
+    }
+
+
+    /**
+     * iterate over each user and move the keys to the new storage
+     *
+     * @param string $oldRoot
+     * @param string $newRoot
+     * @param OutputInterface $output
+     */
+    protected function moveUserKeys($oldRoot, $newRoot, OutputInterface $output) {
+        $progress = new ProgressBar($output);
+        $progress->start();
+
+
+        foreach ($this->userManager->getBackends() as $backend) {
+            $limit = 500;
+            $offset = 0;
+            do {
+                $users = $backend->getUsers('', $limit, $offset);
+                foreach ($users as $user) {
+                    $progress->advance();
+                    $this->setupUserFS($user);
+                    $this->moveUserEncryptionFolder($user, $oldRoot, $newRoot);
+                }
+                $offset += $limit;
+            } while (count($users) >= $limit);
+        }
+        $progress->finish();
+    }
+
+    /**
+     * move user encryption folder to new root folder
+     *
+     * @param string $user
+     * @param string $oldRoot
+     * @param string $newRoot
+     * @throws \Exception
+     */
+    protected function moveUserEncryptionFolder($user, $oldRoot, $newRoot) {
+        if ($this->userManager->userExists($user)) {
+            $source = $oldRoot . '/' . $user . '/files_encryption';
+            $target = $newRoot . '/' . $user . '/files_encryption';
+            if (
+                $this->rootView->is_dir($source) &&
+                $this->targetExists($target) === false
+            ) {
+                $this->prepareParentFolder($newRoot . '/' . $user);
+                $this->rootView->rename($source, $target);
+            }
+        }
+    }
+
+    /**
+     * Make preparations to filesystem for saving a key file
+     *
+     * @param string $path relative to data/
+     */
+    protected function prepareParentFolder($path) {
+        $path = Filesystem::normalizePath($path);
+        // If the file resides within a subdirectory, create it
+        if ($this->rootView->file_exists($path) === false) {
+            $sub_dirs = explode('/', ltrim($path, '/'));
+            $dir = '';
+            foreach ($sub_dirs as $sub_dir) {
+                $dir .= '/' . $sub_dir;
+                if ($this->rootView->file_exists($dir) === false) {
+                    $this->rootView->mkdir($dir);
+                }
+            }
+        }
+    }
+
+    /**
+     * check if target already exists
+     *
+     * @param $path
+     * @return bool
+     * @throws \Exception
+     */
+    protected function targetExists($path) {
+        if ($this->rootView->file_exists($path)) {
+            throw new \Exception("new folder '$path' already exists");
+        }
+
+        return false;
+    }
 }