nextcloud / server

lib/public/Files.php

Indentation +110 added lines, -110 removed lines

@@ -19,123 +19,123 @@
  * @deprecated 14.0.0
  */
 class Files {
-	/**
-	 * Recursive deletion of folders
-	 *
-	 * @param string $dir path to the folder
-	 * @param bool $deleteSelf if set to false only the content of the folder will be deleted
-	 * @return bool
-	 * @since 5.0.0
-	 * @since 32.0.0 added the $deleteSelf parameter
-	 * @deprecated 14.0.0
-	 */
-	public static function rmdirr($dir, bool $deleteSelf = true) {
-		if (is_dir($dir)) {
-			$files = new \RecursiveIteratorIterator(
-				new \RecursiveDirectoryIterator($dir, \RecursiveDirectoryIterator::SKIP_DOTS),
-				\RecursiveIteratorIterator::CHILD_FIRST
-			);
+    /**
+     * Recursive deletion of folders
+     *
+     * @param string $dir path to the folder
+     * @param bool $deleteSelf if set to false only the content of the folder will be deleted
+     * @return bool
+     * @since 5.0.0
+     * @since 32.0.0 added the $deleteSelf parameter
+     * @deprecated 14.0.0
+     */
+    public static function rmdirr($dir, bool $deleteSelf = true) {
+        if (is_dir($dir)) {
+            $files = new \RecursiveIteratorIterator(
+                new \RecursiveDirectoryIterator($dir, \RecursiveDirectoryIterator::SKIP_DOTS),
+                \RecursiveIteratorIterator::CHILD_FIRST
+            );
 
-			foreach ($files as $fileInfo) {
-				/** @var \SplFileInfo $fileInfo */
-				if ($fileInfo->isLink()) {
-					unlink($fileInfo->getPathname());
-				} elseif ($fileInfo->isDir()) {
-					rmdir($fileInfo->getRealPath());
-				} else {
-					unlink($fileInfo->getRealPath());
-				}
-			}
-			if ($deleteSelf) {
-				rmdir($dir);
-			}
-		} elseif (file_exists($dir)) {
-			if ($deleteSelf) {
-				unlink($dir);
-			}
-		}
-		if (!$deleteSelf) {
-			return true;
-		}
+            foreach ($files as $fileInfo) {
+                /** @var \SplFileInfo $fileInfo */
+                if ($fileInfo->isLink()) {
+                    unlink($fileInfo->getPathname());
+                } elseif ($fileInfo->isDir()) {
+                    rmdir($fileInfo->getRealPath());
+                } else {
+                    unlink($fileInfo->getRealPath());
+                }
+            }
+            if ($deleteSelf) {
+                rmdir($dir);
+            }
+        } elseif (file_exists($dir)) {
+            if ($deleteSelf) {
+                unlink($dir);
+            }
+        }
+        if (!$deleteSelf) {
+            return true;
+        }
 
-		return !file_exists($dir);
-	}
+        return !file_exists($dir);
+    }
 
-	/**
-	 * Get the mimetype form a local file
-	 * @param string $path
-	 * @return string
-	 *                does NOT work for ownClouds filesystem, use OC_FileSystem::getMimeType instead
-	 * @since 5.0.0
-	 * @deprecated 14.0.0
-	 */
-	public static function getMimeType($path) {
-		return Server::get(IMimeTypeDetector::class)->detect($path);
-	}
+    /**
+     * Get the mimetype form a local file
+     * @param string $path
+     * @return string
+     *                does NOT work for ownClouds filesystem, use OC_FileSystem::getMimeType instead
+     * @since 5.0.0
+     * @deprecated 14.0.0
+     */
+    public static function getMimeType($path) {
+        return Server::get(IMimeTypeDetector::class)->detect($path);
+    }
 
-	/**
-	 * Search for files by mimetype
-	 * @param string $mimetype
-	 * @return array
-	 * @since 6.0.0
-	 * @deprecated 14.0.0
-	 */
-	public static function searchByMime($mimetype) {
-		return \OC\Files\Filesystem::searchByMime($mimetype);
-	}
+    /**
+     * Search for files by mimetype
+     * @param string $mimetype
+     * @return array
+     * @since 6.0.0
+     * @deprecated 14.0.0
+     */
+    public static function searchByMime($mimetype) {
+        return \OC\Files\Filesystem::searchByMime($mimetype);
+    }
 
-	/**
-	 * Copy the contents of one stream to another
-	 *
-	 * @template T of null|true
-	 * @param resource $source
-	 * @param resource $target
-	 * @param T $includeResult
-	 * @return int|array
-	 * @psalm-return (T is true ? array{0: int, 1: bool} : int)
-	 * @since 5.0.0
-	 * @since 32.0.0 added $includeResult parameter
-	 * @deprecated 14.0.0
-	 */
-	public static function streamCopy($source, $target, ?bool $includeResult = null) {
-		if (!$source || !$target) {
-			return $includeResult ? [0, false] : 0;
-		}
+    /**
+     * Copy the contents of one stream to another
+     *
+     * @template T of null|true
+     * @param resource $source
+     * @param resource $target
+     * @param T $includeResult
+     * @return int|array
+     * @psalm-return (T is true ? array{0: int, 1: bool} : int)
+     * @since 5.0.0
+     * @since 32.0.0 added $includeResult parameter
+     * @deprecated 14.0.0
+     */
+    public static function streamCopy($source, $target, ?bool $includeResult = null) {
+        if (!$source || !$target) {
+            return $includeResult ? [0, false] : 0;
+        }
 
-		$bufSize = 8192;
-		$count = 0;
-		$result = true;
-		while (!feof($source)) {
-			$buf = fread($source, $bufSize);
-			if ($buf === false) {
-				$result = false;
-				break;
-			}
+        $bufSize = 8192;
+        $count = 0;
+        $result = true;
+        while (!feof($source)) {
+            $buf = fread($source, $bufSize);
+            if ($buf === false) {
+                $result = false;
+                break;
+            }
 
-			$bytesWritten = fwrite($target, $buf);
-			if ($bytesWritten !== false) {
-				$count += $bytesWritten;
-			}
+            $bytesWritten = fwrite($target, $buf);
+            if ($bytesWritten !== false) {
+                $count += $bytesWritten;
+            }
 
-			if ($bytesWritten === false
-				|| ($bytesWritten < $bufSize && $bytesWritten < strlen($buf))
-			) {
-				$result = false;
-				break;
-			}
-		}
-		return $includeResult ? [$count, $result] : $count;
-	}
+            if ($bytesWritten === false
+                || ($bytesWritten < $bufSize && $bytesWritten < strlen($buf))
+            ) {
+                $result = false;
+                break;
+            }
+        }
+        return $includeResult ? [$count, $result] : $count;
+    }
 
-	/**
-	 * Adds a suffix to the name in case the file exists
-	 * @param string $path
-	 * @param string $filename
-	 * @return string
-	 * @since 5.0.0
-	 * @deprecated 14.0.0 use getNonExistingName of the OCP\Files\Folder object
-	 */
-	public static function buildNotExistingFileName($path, $filename) {
-		return \OC_Helper::buildNotExistingFileName($path, $filename);
-	}
+    /**
+     * Adds a suffix to the name in case the file exists
+     * @param string $path
+     * @param string $filename
+     * @return string
+     * @since 5.0.0
+     * @deprecated 14.0.0 use getNonExistingName of the OCP\Files\Folder object
+     */
+    public static function buildNotExistingFileName($path, $filename) {
+        return \OC_Helper::buildNotExistingFileName($path, $filename);
+    }
 }

lib/public/Util.php

Indentation +637 added lines, -637 removed lines

@@ -25,641 +25,641 @@
  * @since 4.0.0
  */
 class Util {
-	private static ?IManager $shareManager = null;
-
-	private static array $scriptsInit = [];
-	private static array $scripts = [];
-	private static array $scriptDeps = [];
-
-	/**
-	 * get the current installed version of Nextcloud
-	 * @return array
-	 * @since 4.0.0
-	 * @deprecated 31.0.0 Use \OCP\ServerVersion::getVersion
-	 */
-	public static function getVersion() {
-		return Server::get(ServerVersion::class)->getVersion();
-	}
-
-	/**
-	 * @since 17.0.0
-	 */
-	public static function hasExtendedSupport(): bool {
-		try {
-			/** @var \OCP\Support\Subscription\IRegistry */
-			$subscriptionRegistry = Server::get(\OCP\Support\Subscription\IRegistry::class);
-			return $subscriptionRegistry->delegateHasExtendedSupport();
-		} catch (ContainerExceptionInterface $e) {
-		}
-		return \OCP\Server::get(IConfig::class)->getSystemValueBool('extendedSupport', false);
-	}
-
-	/**
-	 * Set current update channel
-	 * @param string $channel
-	 * @since 8.1.0
-	 */
-	public static function setChannel($channel) {
-		\OCP\Server::get(IConfig::class)->setSystemValue('updater.release.channel', $channel);
-	}
-
-	/**
-	 * Get current update channel
-	 * @return string
-	 * @since 8.1.0
-	 * @deprecated 31.0.0 Use \OCP\ServerVersion::getChannel
-	 */
-	public static function getChannel() {
-		return \OCP\Server::get(ServerVersion::class)->getChannel();
-	}
-
-	/**
-	 * check if sharing is disabled for the current user
-	 *
-	 * @return boolean
-	 * @since 7.0.0
-	 * @deprecated 9.1.0 Use Server::get(\OCP\Share\IManager::class)->sharingDisabledForUser
-	 */
-	public static function isSharingDisabledForUser() {
-		if (self::$shareManager === null) {
-			self::$shareManager = Server::get(IManager::class);
-		}
-
-		$user = Server::get(\OCP\IUserSession::class)->getUser();
-
-		return self::$shareManager->sharingDisabledForUser($user?->getUID());
-	}
-
-	/**
-	 * get l10n object
-	 * @since 6.0.0 - parameter $language was added in 8.0.0
-	 */
-	public static function getL10N(string $application, ?string $language = null): IL10N {
-		return Server::get(\OCP\L10N\IFactory::class)->get($application, $language);
-	}
-
-	/**
-	 * Add a css file
-	 *
-	 * @param string $application application id
-	 * @param ?string $file filename
-	 * @param bool $prepend prepend the style to the beginning of the list
-	 * @since 4.0.0
-	 */
-	public static function addStyle(string $application, ?string $file = null, bool $prepend = false): void {
-		\OC_Util::addStyle($application, $file, $prepend);
-	}
-
-	/**
-	 * Add a standalone init js file that is loaded for initialization
-	 *
-	 * Be careful loading scripts using this method as they are loaded early
-	 * and block the initial page rendering. They should not have dependencies
-	 * on any other scripts than core-common and core-main.
-	 *
-	 * @since 28.0.0
-	 */
-	public static function addInitScript(string $application, string $file): void {
-		if (!empty($application)) {
-			$path = "$application/js/$file";
-		} else {
-			$path = "js/$file";
-		}
-
-		// We need to handle the translation BEFORE the init script
-		// is loaded, as the init script might use translations
-		if ($application !== 'core' && !str_contains($file, 'l10n')) {
-			self::addTranslations($application, null, true);
-		}
-
-		self::$scriptsInit[] = $path;
-	}
-
-	/**
-	 * add a javascript file
-	 *
-	 * @param string $application
-	 * @param string|null $file
-	 * @param string $afterAppId
-	 * @param bool $prepend
-	 * @since 4.0.0
-	 */
-	public static function addScript(string $application, ?string $file = null, string $afterAppId = 'core', bool $prepend = false): void {
-		if (!empty($application)) {
-			$path = "$application/js/$file";
-		} else {
-			$path = "js/$file";
-		}
-
-		// Inject js translations if we load a script for
-		// a specific app that is not core, as those js files
-		// need separate handling
-		if ($application !== 'core'
-			&& $file !== null
-			&& !str_contains($file, 'l10n')) {
-			self::addTranslations($application);
-		}
-
-		// store app in dependency list
-		if (!array_key_exists($application, self::$scriptDeps)) {
-			self::$scriptDeps[$application] = new AppScriptDependency($application, [$afterAppId]);
-		} else {
-			self::$scriptDeps[$application]->addDep($afterAppId);
-		}
-
-		if ($prepend) {
-			array_unshift(self::$scripts[$application], $path);
-		} else {
-			self::$scripts[$application][] = $path;
-		}
-	}
-
-	/**
-	 * Return the list of scripts injected to the page
-	 *
-	 * @return array
-	 * @since 24.0.0
-	 */
-	public static function getScripts(): array {
-		// Sort scriptDeps into sortedScriptDeps
-		$scriptSort = \OCP\Server::get(AppScriptSort::class);
-		$sortedScripts = $scriptSort->sort(self::$scripts, self::$scriptDeps);
-
-		// Flatten array and remove duplicates
-		$sortedScripts = array_merge([self::$scriptsInit], $sortedScripts);
-		$sortedScripts = array_merge(...array_values($sortedScripts));
-
-		// Override core-common and core-main order
-		if (in_array('core/js/main', $sortedScripts)) {
-			array_unshift($sortedScripts, 'core/js/main');
-		}
-		if (in_array('core/js/common', $sortedScripts)) {
-			array_unshift($sortedScripts, 'core/js/common');
-		}
-
-		return array_unique($sortedScripts);
-	}
-
-	/**
-	 * Add a translation JS file
-	 * @param string $application application id
-	 * @param string $languageCode language code, defaults to the current locale
-	 * @param bool $init whether the translations should be loaded early or not
-	 * @since 8.0.0
-	 */
-	public static function addTranslations($application, $languageCode = null, $init = false) {
-		if (is_null($languageCode)) {
-			$languageCode = \OCP\Server::get(IFactory::class)->findLanguage($application);
-		}
-		if (!empty($application)) {
-			$path = "$application/l10n/$languageCode";
-		} else {
-			$path = "l10n/$languageCode";
-		}
-
-		if ($init) {
-			self::$scriptsInit[] = $path;
-		} else {
-			self::$scripts[$application][] = $path;
-		}
-	}
-
-	/**
-	 * Add a custom element to the header
-	 * If $text is null then the element will be written as empty element.
-	 * So use "" to get a closing tag.
-	 * @param string $tag tag name of the element
-	 * @param array $attributes array of attributes for the element
-	 * @param string $text the text content for the element
-	 * @since 4.0.0
-	 */
-	public static function addHeader($tag, $attributes, $text = null) {
-		\OC_Util::addHeader($tag, $attributes, $text);
-	}
-
-	/**
-	 * Creates an absolute url to the given app and file.
-	 * @param string $app app
-	 * @param string $file file
-	 * @param array $args array with param=>value, will be appended to the returned url
-	 *                    The value of $args will be urlencoded
-	 * @return string the url
-	 * @since 4.0.0 - parameter $args was added in 4.5.0
-	 */
-	public static function linkToAbsolute($app, $file, $args = []) {
-		$urlGenerator = \OCP\Server::get(IURLGenerator::class);
-		return $urlGenerator->getAbsoluteURL(
-			$urlGenerator->linkTo($app, $file, $args)
-		);
-	}
-
-	/**
-	 * Creates an absolute url for remote use.
-	 * @param string $service id
-	 * @return string the url
-	 * @since 4.0.0
-	 */
-	public static function linkToRemote($service) {
-		$urlGenerator = \OCP\Server::get(IURLGenerator::class);
-		$remoteBase = $urlGenerator->linkTo('', 'remote.php') . '/' . $service;
-		return $urlGenerator->getAbsoluteURL(
-			$remoteBase . (($service[strlen($service) - 1] != '/') ? '/' : '')
-		);
-	}
-
-	/**
-	 * Returns the server host name without an eventual port number
-	 * @return string the server hostname
-	 * @since 5.0.0
-	 */
-	public static function getServerHostName() {
-		$host_name = \OCP\Server::get(IRequest::class)->getServerHost();
-		// strip away port number (if existing)
-		$colon_pos = strpos($host_name, ':');
-		if ($colon_pos != false) {
-			$host_name = substr($host_name, 0, $colon_pos);
-		}
-		return $host_name;
-	}
-
-	/**
-	 * Returns the default email address
-	 * @param string $user_part the user part of the address
-	 * @return string the default email address
-	 *
-	 * Assembles a default email address (using the server hostname
-	 * and the given user part, and returns it
-	 * Example: when given lostpassword-noreply as $user_part param,
-	 *     and is currently accessed via http(s)://example.com/,
-	 *     it would return 'lostpassword-noreply@example.com'
-	 *
-	 * If the configuration value 'mail_from_address' is set in
-	 * config.php, this value will override the $user_part that
-	 * is passed to this function
-	 * @since 5.0.0
-	 */
-	public static function getDefaultEmailAddress(string $user_part): string {
-		$config = \OCP\Server::get(IConfig::class);
-		$user_part = $config->getSystemValueString('mail_from_address', $user_part);
-		$host_name = self::getServerHostName();
-		$host_name = $config->getSystemValueString('mail_domain', $host_name);
-		$defaultEmailAddress = $user_part . '@' . $host_name;
-
-		$mailer = \OCP\Server::get(IMailer::class);
-		if ($mailer->validateMailAddress($defaultEmailAddress)) {
-			return $defaultEmailAddress;
-		}
-
-		// in case we cannot build a valid email address from the hostname let's fallback to 'localhost.localdomain'
-		return $user_part . '@localhost.localdomain';
-	}
-
-	/**
-	 * Converts string to int of float depending on if it fits an int
-	 * @param numeric-string|float|int $number numeric string
-	 * @return int|float int if it fits, float if it is too big
-	 * @since 26.0.0
-	 */
-	public static function numericToNumber(string|float|int $number): int|float {
-		/* This is a hack to cast to (int|float) */
-		return 0 + (string)$number;
-	}
-
-	/**
-	 * Make a human file size (2048 to 2 kB)
-	 * @param int|float $bytes file size in bytes
-	 * @return string a human readable file size
-	 * @since 4.0.0
-	 */
-	public static function humanFileSize(int|float $bytes): string {
-		if ($bytes < 0) {
-			return '?';
-		}
-		if ($bytes < 1024) {
-			return "$bytes B";
-		}
-		$bytes = round($bytes / 1024, 0);
-		if ($bytes < 1024) {
-			return "$bytes KB";
-		}
-		$bytes = round($bytes / 1024, 1);
-		if ($bytes < 1024) {
-			return "$bytes MB";
-		}
-		$bytes = round($bytes / 1024, 1);
-		if ($bytes < 1024) {
-			return "$bytes GB";
-		}
-		$bytes = round($bytes / 1024, 1);
-		if ($bytes < 1024) {
-			return "$bytes TB";
-		}
-
-		$bytes = round($bytes / 1024, 1);
-		return "$bytes PB";
-	}
-
-	/**
-	 * Make a computer file size (2 kB to 2048)
-	 * Inspired by: https://www.php.net/manual/en/function.filesize.php#92418
-	 *
-	 * @param string $str file size in a fancy format
-	 * @return false|int|float a file size in bytes
-	 * @since 4.0.0
-	 */
-	public static function computerFileSize(string $str): false|int|float {
-		$str = strtolower($str);
-		if (is_numeric($str)) {
-			return Util::numericToNumber($str);
-		}
-
-		$bytes_array = [
-			'b' => 1,
-			'k' => 1024,
-			'kb' => 1024,
-			'mb' => 1024 * 1024,
-			'm' => 1024 * 1024,
-			'gb' => 1024 * 1024 * 1024,
-			'g' => 1024 * 1024 * 1024,
-			'tb' => 1024 * 1024 * 1024 * 1024,
-			't' => 1024 * 1024 * 1024 * 1024,
-			'pb' => 1024 * 1024 * 1024 * 1024 * 1024,
-			'p' => 1024 * 1024 * 1024 * 1024 * 1024,
-		];
-
-		$bytes = (float)$str;
-
-		if (preg_match('#([kmgtp]?b?)$#si', $str, $matches) && isset($bytes_array[$matches[1]])) {
-			$bytes *= $bytes_array[$matches[1]];
-		} else {
-			return false;
-		}
-
-		return Util::numericToNumber(round($bytes));
-	}
-
-	/**
-	 * connects a function to a hook
-	 *
-	 * @param string $signalClass class name of emitter
-	 * @param string $signalName name of signal
-	 * @param string|object $slotClass class name of slot
-	 * @param string $slotName name of slot
-	 * @return bool
-	 *
-	 * This function makes it very easy to connect to use hooks.
-	 *
-	 * TODO: write example
-	 * @since 4.0.0
-	 * @deprecated 21.0.0 use \OCP\EventDispatcher\IEventDispatcher::addListener
-	 */
-	public static function connectHook($signalClass, $signalName, $slotClass, $slotName) {
-		return \OC_Hook::connect($signalClass, $signalName, $slotClass, $slotName);
-	}
-
-	/**
-	 * Emits a signal. To get data from the slot use references!
-	 * @param string $signalclass class name of emitter
-	 * @param string $signalname name of signal
-	 * @param array $params default: array() array with additional data
-	 * @return bool true if slots exists or false if not
-	 *
-	 * TODO: write example
-	 * @since 4.0.0
-	 * @deprecated 21.0.0 use \OCP\EventDispatcher\IEventDispatcher::dispatchTypedEvent
-	 */
-	public static function emitHook($signalclass, $signalname, $params = []) {
-		return \OC_Hook::emit($signalclass, $signalname, $params);
-	}
-
-	/**
-	 * Cached encrypted CSRF token. Some static unit-tests of ownCloud compare
-	 * multiple Template elements which invoke `callRegister`. If the value
-	 * would not be cached these unit-tests would fail.
-	 * @var string
-	 */
-	private static $token = '';
-
-	/**
-	 * Register an get/post call. This is important to prevent CSRF attacks
-	 * @since 4.5.0
-	 * @deprecated 32.0.0 directly use CsrfTokenManager instead
-	 */
-	public static function callRegister() {
-		if (self::$token === '') {
-			self::$token = \OCP\Server::get(CsrfTokenManager::class)->getToken()->getEncryptedValue();
-		}
-		return self::$token;
-	}
-
-	/**
-	 * Used to sanitize HTML
-	 *
-	 * This function is used to sanitize HTML and should be applied on any
-	 * string or array of strings before displaying it on a web page.
-	 *
-	 * @param string|string[] $value
-	 * @return ($value is array ? string[] : string) an array of sanitized strings or a single sanitized string, depends on the input parameter.
-	 * @since 4.5.0
-	 */
-	public static function sanitizeHTML($value) {
-		return \OC_Util::sanitizeHTML($value);
-	}
-
-	/**
-	 * Public function to encode url parameters
-	 *
-	 * This function is used to encode path to file before output.
-	 * Encoding is done according to RFC 3986 with one exception:
-	 * Character '/' is preserved as is.
-	 *
-	 * @param string $component part of URI to encode
-	 * @return string
-	 * @since 6.0.0
-	 */
-	public static function encodePath($component) {
-		return \OC_Util::encodePath($component);
-	}
-
-	/**
-	 * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
-	 *
-	 * @param array $input The array to work on
-	 * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
-	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
-	 * @return array
-	 * @since 4.5.0
-	 */
-	public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
-		$case = ($case != MB_CASE_UPPER) ? MB_CASE_LOWER : MB_CASE_UPPER;
-		$ret = [];
-		foreach ($input as $k => $v) {
-			$ret[mb_convert_case($k, $case, $encoding)] = $v;
-		}
-		return $ret;
-	}
-
-	/**
-	 * performs a search in a nested array
-	 *
-	 * @param array $haystack the array to be searched
-	 * @param string $needle the search string
-	 * @param mixed $index optional, only search this key name
-	 * @return mixed the key of the matching field, otherwise false
-	 * @since 4.5.0
-	 * @deprecated 15.0.0
-	 */
-	public static function recursiveArraySearch($haystack, $needle, $index = null) {
-		$aIt = new \RecursiveArrayIterator($haystack);
-		$it = new \RecursiveIteratorIterator($aIt);
-
-		while ($it->valid()) {
-			if (((isset($index) && ($it->key() == $index)) || !isset($index)) && ($it->current() == $needle)) {
-				return $aIt->key();
-			}
-
-			$it->next();
-		}
-
-		return false;
-	}
-
-	/**
-	 * calculates the maximum upload size respecting system settings, free space and user quota
-	 *
-	 * @param string $dir the current folder where the user currently operates
-	 * @param int|float|null $free the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
-	 * @return int|float number of bytes representing
-	 * @since 5.0.0
-	 */
-	public static function maxUploadFilesize(string $dir, int|float|null $free = null): int|float {
-		if (is_null($free) || $free < 0) {
-			$free = self::freeSpace($dir);
-		}
-		return min($free, self::uploadLimit());
-	}
-
-	/**
-	 * Calculate free space left within user quota
-	 * @param string $dir the current folder where the user currently operates
-	 * @return int|float number of bytes representing
-	 * @since 7.0.0
-	 */
-	public static function freeSpace(string $dir): int|float {
-		$freeSpace = \OC\Files\Filesystem::free_space($dir);
-		if ($freeSpace < \OCP\Files\FileInfo::SPACE_UNLIMITED) {
-			$freeSpace = max($freeSpace, 0);
-			return $freeSpace;
-		} else {
-			return (INF > 0)? INF: PHP_INT_MAX; // work around https://bugs.php.net/bug.php?id=69188
-		}
-	}
-
-	/**
-	 * Calculate PHP upload limit
-	 *
-	 * @return int|float number of bytes representing
-	 * @since 7.0.0
-	 */
-	public static function uploadLimit(): int|float {
-		$ini = Server::get(IniGetWrapper::class);
-		$upload_max_filesize = self::computerFileSize($ini->get('upload_max_filesize')) ?: 0;
-		$post_max_size = self::computerFileSize($ini->get('post_max_size')) ?: 0;
-		if ($upload_max_filesize === 0 && $post_max_size === 0) {
-			return INF;
-		} elseif ($upload_max_filesize === 0 || $post_max_size === 0) {
-			return max($upload_max_filesize, $post_max_size); //only the non 0 value counts
-		} else {
-			return min($upload_max_filesize, $post_max_size);
-		}
-	}
-
-	/**
-	 * Compare two strings to provide a natural sort
-	 * @param string $a first string to compare
-	 * @param string $b second string to compare
-	 * @return int -1 if $b comes before $a, 1 if $a comes before $b
-	 *             or 0 if the strings are identical
-	 * @since 7.0.0
-	 */
-	public static function naturalSortCompare($a, $b) {
-		return \OC\NaturalSort::getInstance()->compare($a, $b);
-	}
-
-	/**
-	 * Check if a password is required for each public link
-	 *
-	 * @param bool $checkGroupMembership Check group membership exclusion
-	 * @return boolean
-	 * @since 7.0.0
-	 */
-	public static function isPublicLinkPasswordRequired(bool $checkGroupMembership = true) {
-		return \OC_Util::isPublicLinkPasswordRequired($checkGroupMembership);
-	}
-
-	/**
-	 * check if share API enforces a default expire date
-	 * @return boolean
-	 * @since 8.0.0
-	 */
-	public static function isDefaultExpireDateEnforced() {
-		return \OC_Util::isDefaultExpireDateEnforced();
-	}
-
-	protected static $needUpgradeCache = null;
-
-	/**
-	 * Checks whether the current version needs upgrade.
-	 *
-	 * @return bool true if upgrade is needed, false otherwise
-	 * @since 7.0.0
-	 */
-	public static function needUpgrade() {
-		if (!isset(self::$needUpgradeCache)) {
-			self::$needUpgradeCache = \OC_Util::needUpgrade(\OCP\Server::get(\OC\SystemConfig::class));
-		}
-		return self::$needUpgradeCache;
-	}
-
-	/**
-	 * Sometimes a string has to be shortened to fit within a certain maximum
-	 * data length in bytes. substr() you may break multibyte characters,
-	 * because it operates on single byte level. mb_substr() operates on
-	 * characters, so does not ensure that the shortened string satisfies the
-	 * max length in bytes.
-	 *
-	 * For example, json_encode is messing with multibyte characters a lot,
-	 * replacing them with something along "\u1234".
-	 *
-	 * This function shortens the string with by $accuracy (-5) from
-	 * $dataLength characters, until it fits within $dataLength bytes.
-	 *
-	 * @since 23.0.0
-	 */
-	public static function shortenMultibyteString(string $subject, int $dataLength, int $accuracy = 5): string {
-		$temp = mb_substr($subject, 0, $dataLength);
-		// json encodes encapsulates the string in double quotes, they need to be substracted
-		while ((strlen(json_encode($temp)) - 2) > $dataLength) {
-			$temp = mb_substr($temp, 0, -$accuracy);
-		}
-		return $temp;
-	}
-
-	/**
-	 * Check if a function is enabled in the php configuration
-	 *
-	 * @since 25.0.0
-	 */
-	public static function isFunctionEnabled(string $functionName): bool {
-		if (!function_exists($functionName)) {
-			return false;
-		}
-		$ini = Server::get(IniGetWrapper::class);
-		$disabled = explode(',', $ini->get('disable_functions') ?: '');
-		$disabled = array_map('trim', $disabled);
-		if (in_array($functionName, $disabled)) {
-			return false;
-		}
-		return true;
-	}
+    private static ?IManager $shareManager = null;
+
+    private static array $scriptsInit = [];
+    private static array $scripts = [];
+    private static array $scriptDeps = [];
+
+    /**
+     * get the current installed version of Nextcloud
+     * @return array
+     * @since 4.0.0
+     * @deprecated 31.0.0 Use \OCP\ServerVersion::getVersion
+     */
+    public static function getVersion() {
+        return Server::get(ServerVersion::class)->getVersion();
+    }
+
+    /**
+     * @since 17.0.0
+     */
+    public static function hasExtendedSupport(): bool {
+        try {
+            /** @var \OCP\Support\Subscription\IRegistry */
+            $subscriptionRegistry = Server::get(\OCP\Support\Subscription\IRegistry::class);
+            return $subscriptionRegistry->delegateHasExtendedSupport();
+        } catch (ContainerExceptionInterface $e) {
+        }
+        return \OCP\Server::get(IConfig::class)->getSystemValueBool('extendedSupport', false);
+    }
+
+    /**
+     * Set current update channel
+     * @param string $channel
+     * @since 8.1.0
+     */
+    public static function setChannel($channel) {
+        \OCP\Server::get(IConfig::class)->setSystemValue('updater.release.channel', $channel);
+    }
+
+    /**
+     * Get current update channel
+     * @return string
+     * @since 8.1.0
+     * @deprecated 31.0.0 Use \OCP\ServerVersion::getChannel
+     */
+    public static function getChannel() {
+        return \OCP\Server::get(ServerVersion::class)->getChannel();
+    }
+
+    /**
+     * check if sharing is disabled for the current user
+     *
+     * @return boolean
+     * @since 7.0.0
+     * @deprecated 9.1.0 Use Server::get(\OCP\Share\IManager::class)->sharingDisabledForUser
+     */
+    public static function isSharingDisabledForUser() {
+        if (self::$shareManager === null) {
+            self::$shareManager = Server::get(IManager::class);
+        }
+
+        $user = Server::get(\OCP\IUserSession::class)->getUser();
+
+        return self::$shareManager->sharingDisabledForUser($user?->getUID());
+    }
+
+    /**
+     * get l10n object
+     * @since 6.0.0 - parameter $language was added in 8.0.0
+     */
+    public static function getL10N(string $application, ?string $language = null): IL10N {
+        return Server::get(\OCP\L10N\IFactory::class)->get($application, $language);
+    }
+
+    /**
+     * Add a css file
+     *
+     * @param string $application application id
+     * @param ?string $file filename
+     * @param bool $prepend prepend the style to the beginning of the list
+     * @since 4.0.0
+     */
+    public static function addStyle(string $application, ?string $file = null, bool $prepend = false): void {
+        \OC_Util::addStyle($application, $file, $prepend);
+    }
+
+    /**
+     * Add a standalone init js file that is loaded for initialization
+     *
+     * Be careful loading scripts using this method as they are loaded early
+     * and block the initial page rendering. They should not have dependencies
+     * on any other scripts than core-common and core-main.
+     *
+     * @since 28.0.0
+     */
+    public static function addInitScript(string $application, string $file): void {
+        if (!empty($application)) {
+            $path = "$application/js/$file";
+        } else {
+            $path = "js/$file";
+        }
+
+        // We need to handle the translation BEFORE the init script
+        // is loaded, as the init script might use translations
+        if ($application !== 'core' && !str_contains($file, 'l10n')) {
+            self::addTranslations($application, null, true);
+        }
+
+        self::$scriptsInit[] = $path;
+    }
+
+    /**
+     * add a javascript file
+     *
+     * @param string $application
+     * @param string|null $file
+     * @param string $afterAppId
+     * @param bool $prepend
+     * @since 4.0.0
+     */
+    public static function addScript(string $application, ?string $file = null, string $afterAppId = 'core', bool $prepend = false): void {
+        if (!empty($application)) {
+            $path = "$application/js/$file";
+        } else {
+            $path = "js/$file";
+        }
+
+        // Inject js translations if we load a script for
+        // a specific app that is not core, as those js files
+        // need separate handling
+        if ($application !== 'core'
+            && $file !== null
+            && !str_contains($file, 'l10n')) {
+            self::addTranslations($application);
+        }
+
+        // store app in dependency list
+        if (!array_key_exists($application, self::$scriptDeps)) {
+            self::$scriptDeps[$application] = new AppScriptDependency($application, [$afterAppId]);
+        } else {
+            self::$scriptDeps[$application]->addDep($afterAppId);
+        }
+
+        if ($prepend) {
+            array_unshift(self::$scripts[$application], $path);
+        } else {
+            self::$scripts[$application][] = $path;
+        }
+    }
+
+    /**
+     * Return the list of scripts injected to the page
+     *
+     * @return array
+     * @since 24.0.0
+     */
+    public static function getScripts(): array {
+        // Sort scriptDeps into sortedScriptDeps
+        $scriptSort = \OCP\Server::get(AppScriptSort::class);
+        $sortedScripts = $scriptSort->sort(self::$scripts, self::$scriptDeps);
+
+        // Flatten array and remove duplicates
+        $sortedScripts = array_merge([self::$scriptsInit], $sortedScripts);
+        $sortedScripts = array_merge(...array_values($sortedScripts));
+
+        // Override core-common and core-main order
+        if (in_array('core/js/main', $sortedScripts)) {
+            array_unshift($sortedScripts, 'core/js/main');
+        }
+        if (in_array('core/js/common', $sortedScripts)) {
+            array_unshift($sortedScripts, 'core/js/common');
+        }
+
+        return array_unique($sortedScripts);
+    }
+
+    /**
+     * Add a translation JS file
+     * @param string $application application id
+     * @param string $languageCode language code, defaults to the current locale
+     * @param bool $init whether the translations should be loaded early or not
+     * @since 8.0.0
+     */
+    public static function addTranslations($application, $languageCode = null, $init = false) {
+        if (is_null($languageCode)) {
+            $languageCode = \OCP\Server::get(IFactory::class)->findLanguage($application);
+        }
+        if (!empty($application)) {
+            $path = "$application/l10n/$languageCode";
+        } else {
+            $path = "l10n/$languageCode";
+        }
+
+        if ($init) {
+            self::$scriptsInit[] = $path;
+        } else {
+            self::$scripts[$application][] = $path;
+        }
+    }
+
+    /**
+     * Add a custom element to the header
+     * If $text is null then the element will be written as empty element.
+     * So use "" to get a closing tag.
+     * @param string $tag tag name of the element
+     * @param array $attributes array of attributes for the element
+     * @param string $text the text content for the element
+     * @since 4.0.0
+     */
+    public static function addHeader($tag, $attributes, $text = null) {
+        \OC_Util::addHeader($tag, $attributes, $text);
+    }
+
+    /**
+     * Creates an absolute url to the given app and file.
+     * @param string $app app
+     * @param string $file file
+     * @param array $args array with param=>value, will be appended to the returned url
+     *                    The value of $args will be urlencoded
+     * @return string the url
+     * @since 4.0.0 - parameter $args was added in 4.5.0
+     */
+    public static function linkToAbsolute($app, $file, $args = []) {
+        $urlGenerator = \OCP\Server::get(IURLGenerator::class);
+        return $urlGenerator->getAbsoluteURL(
+            $urlGenerator->linkTo($app, $file, $args)
+        );
+    }
+
+    /**
+     * Creates an absolute url for remote use.
+     * @param string $service id
+     * @return string the url
+     * @since 4.0.0
+     */
+    public static function linkToRemote($service) {
+        $urlGenerator = \OCP\Server::get(IURLGenerator::class);
+        $remoteBase = $urlGenerator->linkTo('', 'remote.php') . '/' . $service;
+        return $urlGenerator->getAbsoluteURL(
+            $remoteBase . (($service[strlen($service) - 1] != '/') ? '/' : '')
+        );
+    }
+
+    /**
+     * Returns the server host name without an eventual port number
+     * @return string the server hostname
+     * @since 5.0.0
+     */
+    public static function getServerHostName() {
+        $host_name = \OCP\Server::get(IRequest::class)->getServerHost();
+        // strip away port number (if existing)
+        $colon_pos = strpos($host_name, ':');
+        if ($colon_pos != false) {
+            $host_name = substr($host_name, 0, $colon_pos);
+        }
+        return $host_name;
+    }
+
+    /**
+     * Returns the default email address
+     * @param string $user_part the user part of the address
+     * @return string the default email address
+     *
+     * Assembles a default email address (using the server hostname
+     * and the given user part, and returns it
+     * Example: when given lostpassword-noreply as $user_part param,
+     *     and is currently accessed via http(s)://example.com/,
+     *     it would return 'lostpassword-noreply@example.com'
+     *
+     * If the configuration value 'mail_from_address' is set in
+     * config.php, this value will override the $user_part that
+     * is passed to this function
+     * @since 5.0.0
+     */
+    public static function getDefaultEmailAddress(string $user_part): string {
+        $config = \OCP\Server::get(IConfig::class);
+        $user_part = $config->getSystemValueString('mail_from_address', $user_part);
+        $host_name = self::getServerHostName();
+        $host_name = $config->getSystemValueString('mail_domain', $host_name);
+        $defaultEmailAddress = $user_part . '@' . $host_name;
+
+        $mailer = \OCP\Server::get(IMailer::class);
+        if ($mailer->validateMailAddress($defaultEmailAddress)) {
+            return $defaultEmailAddress;
+        }
+
+        // in case we cannot build a valid email address from the hostname let's fallback to 'localhost.localdomain'
+        return $user_part . '@localhost.localdomain';
+    }
+
+    /**
+     * Converts string to int of float depending on if it fits an int
+     * @param numeric-string|float|int $number numeric string
+     * @return int|float int if it fits, float if it is too big
+     * @since 26.0.0
+     */
+    public static function numericToNumber(string|float|int $number): int|float {
+        /* This is a hack to cast to (int|float) */
+        return 0 + (string)$number;
+    }
+
+    /**
+     * Make a human file size (2048 to 2 kB)
+     * @param int|float $bytes file size in bytes
+     * @return string a human readable file size
+     * @since 4.0.0
+     */
+    public static function humanFileSize(int|float $bytes): string {
+        if ($bytes < 0) {
+            return '?';
+        }
+        if ($bytes < 1024) {
+            return "$bytes B";
+        }
+        $bytes = round($bytes / 1024, 0);
+        if ($bytes < 1024) {
+            return "$bytes KB";
+        }
+        $bytes = round($bytes / 1024, 1);
+        if ($bytes < 1024) {
+            return "$bytes MB";
+        }
+        $bytes = round($bytes / 1024, 1);
+        if ($bytes < 1024) {
+            return "$bytes GB";
+        }
+        $bytes = round($bytes / 1024, 1);
+        if ($bytes < 1024) {
+            return "$bytes TB";
+        }
+
+        $bytes = round($bytes / 1024, 1);
+        return "$bytes PB";
+    }
+
+    /**
+     * Make a computer file size (2 kB to 2048)
+     * Inspired by: https://www.php.net/manual/en/function.filesize.php#92418
+     *
+     * @param string $str file size in a fancy format
+     * @return false|int|float a file size in bytes
+     * @since 4.0.0
+     */
+    public static function computerFileSize(string $str): false|int|float {
+        $str = strtolower($str);
+        if (is_numeric($str)) {
+            return Util::numericToNumber($str);
+        }
+
+        $bytes_array = [
+            'b' => 1,
+            'k' => 1024,
+            'kb' => 1024,
+            'mb' => 1024 * 1024,
+            'm' => 1024 * 1024,
+            'gb' => 1024 * 1024 * 1024,
+            'g' => 1024 * 1024 * 1024,
+            'tb' => 1024 * 1024 * 1024 * 1024,
+            't' => 1024 * 1024 * 1024 * 1024,
+            'pb' => 1024 * 1024 * 1024 * 1024 * 1024,
+            'p' => 1024 * 1024 * 1024 * 1024 * 1024,
+        ];
+
+        $bytes = (float)$str;
+
+        if (preg_match('#([kmgtp]?b?)$#si', $str, $matches) && isset($bytes_array[$matches[1]])) {
+            $bytes *= $bytes_array[$matches[1]];
+        } else {
+            return false;
+        }
+
+        return Util::numericToNumber(round($bytes));
+    }
+
+    /**
+     * connects a function to a hook
+     *
+     * @param string $signalClass class name of emitter
+     * @param string $signalName name of signal
+     * @param string|object $slotClass class name of slot
+     * @param string $slotName name of slot
+     * @return bool
+     *
+     * This function makes it very easy to connect to use hooks.
+     *
+     * TODO: write example
+     * @since 4.0.0
+     * @deprecated 21.0.0 use \OCP\EventDispatcher\IEventDispatcher::addListener
+     */
+    public static function connectHook($signalClass, $signalName, $slotClass, $slotName) {
+        return \OC_Hook::connect($signalClass, $signalName, $slotClass, $slotName);
+    }
+
+    /**
+     * Emits a signal. To get data from the slot use references!
+     * @param string $signalclass class name of emitter
+     * @param string $signalname name of signal
+     * @param array $params default: array() array with additional data
+     * @return bool true if slots exists or false if not
+     *
+     * TODO: write example
+     * @since 4.0.0
+     * @deprecated 21.0.0 use \OCP\EventDispatcher\IEventDispatcher::dispatchTypedEvent
+     */
+    public static function emitHook($signalclass, $signalname, $params = []) {
+        return \OC_Hook::emit($signalclass, $signalname, $params);
+    }
+
+    /**
+     * Cached encrypted CSRF token. Some static unit-tests of ownCloud compare
+     * multiple Template elements which invoke `callRegister`. If the value
+     * would not be cached these unit-tests would fail.
+     * @var string
+     */
+    private static $token = '';
+
+    /**
+     * Register an get/post call. This is important to prevent CSRF attacks
+     * @since 4.5.0
+     * @deprecated 32.0.0 directly use CsrfTokenManager instead
+     */
+    public static function callRegister() {
+        if (self::$token === '') {
+            self::$token = \OCP\Server::get(CsrfTokenManager::class)->getToken()->getEncryptedValue();
+        }
+        return self::$token;
+    }
+
+    /**
+     * Used to sanitize HTML
+     *
+     * This function is used to sanitize HTML and should be applied on any
+     * string or array of strings before displaying it on a web page.
+     *
+     * @param string|string[] $value
+     * @return ($value is array ? string[] : string) an array of sanitized strings or a single sanitized string, depends on the input parameter.
+     * @since 4.5.0
+     */
+    public static function sanitizeHTML($value) {
+        return \OC_Util::sanitizeHTML($value);
+    }
+
+    /**
+     * Public function to encode url parameters
+     *
+     * This function is used to encode path to file before output.
+     * Encoding is done according to RFC 3986 with one exception:
+     * Character '/' is preserved as is.
+     *
+     * @param string $component part of URI to encode
+     * @return string
+     * @since 6.0.0
+     */
+    public static function encodePath($component) {
+        return \OC_Util::encodePath($component);
+    }
+
+    /**
+     * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
+     *
+     * @param array $input The array to work on
+     * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
+     * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
+     * @return array
+     * @since 4.5.0
+     */
+    public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
+        $case = ($case != MB_CASE_UPPER) ? MB_CASE_LOWER : MB_CASE_UPPER;
+        $ret = [];
+        foreach ($input as $k => $v) {
+            $ret[mb_convert_case($k, $case, $encoding)] = $v;
+        }
+        return $ret;
+    }
+
+    /**
+     * performs a search in a nested array
+     *
+     * @param array $haystack the array to be searched
+     * @param string $needle the search string
+     * @param mixed $index optional, only search this key name
+     * @return mixed the key of the matching field, otherwise false
+     * @since 4.5.0
+     * @deprecated 15.0.0
+     */
+    public static function recursiveArraySearch($haystack, $needle, $index = null) {
+        $aIt = new \RecursiveArrayIterator($haystack);
+        $it = new \RecursiveIteratorIterator($aIt);
+
+        while ($it->valid()) {
+            if (((isset($index) && ($it->key() == $index)) || !isset($index)) && ($it->current() == $needle)) {
+                return $aIt->key();
+            }
+
+            $it->next();
+        }
+
+        return false;
+    }
+
+    /**
+     * calculates the maximum upload size respecting system settings, free space and user quota
+     *
+     * @param string $dir the current folder where the user currently operates
+     * @param int|float|null $free the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
+     * @return int|float number of bytes representing
+     * @since 5.0.0
+     */
+    public static function maxUploadFilesize(string $dir, int|float|null $free = null): int|float {
+        if (is_null($free) || $free < 0) {
+            $free = self::freeSpace($dir);
+        }
+        return min($free, self::uploadLimit());
+    }
+
+    /**
+     * Calculate free space left within user quota
+     * @param string $dir the current folder where the user currently operates
+     * @return int|float number of bytes representing
+     * @since 7.0.0
+     */
+    public static function freeSpace(string $dir): int|float {
+        $freeSpace = \OC\Files\Filesystem::free_space($dir);
+        if ($freeSpace < \OCP\Files\FileInfo::SPACE_UNLIMITED) {
+            $freeSpace = max($freeSpace, 0);
+            return $freeSpace;
+        } else {
+            return (INF > 0)? INF: PHP_INT_MAX; // work around https://bugs.php.net/bug.php?id=69188
+        }
+    }
+
+    /**
+     * Calculate PHP upload limit
+     *
+     * @return int|float number of bytes representing
+     * @since 7.0.0
+     */
+    public static function uploadLimit(): int|float {
+        $ini = Server::get(IniGetWrapper::class);
+        $upload_max_filesize = self::computerFileSize($ini->get('upload_max_filesize')) ?: 0;
+        $post_max_size = self::computerFileSize($ini->get('post_max_size')) ?: 0;
+        if ($upload_max_filesize === 0 && $post_max_size === 0) {
+            return INF;
+        } elseif ($upload_max_filesize === 0 || $post_max_size === 0) {
+            return max($upload_max_filesize, $post_max_size); //only the non 0 value counts
+        } else {
+            return min($upload_max_filesize, $post_max_size);
+        }
+    }
+
+    /**
+     * Compare two strings to provide a natural sort
+     * @param string $a first string to compare
+     * @param string $b second string to compare
+     * @return int -1 if $b comes before $a, 1 if $a comes before $b
+     *             or 0 if the strings are identical
+     * @since 7.0.0
+     */
+    public static function naturalSortCompare($a, $b) {
+        return \OC\NaturalSort::getInstance()->compare($a, $b);
+    }
+
+    /**
+     * Check if a password is required for each public link
+     *
+     * @param bool $checkGroupMembership Check group membership exclusion
+     * @return boolean
+     * @since 7.0.0
+     */
+    public static function isPublicLinkPasswordRequired(bool $checkGroupMembership = true) {
+        return \OC_Util::isPublicLinkPasswordRequired($checkGroupMembership);
+    }
+
+    /**
+     * check if share API enforces a default expire date
+     * @return boolean
+     * @since 8.0.0
+     */
+    public static function isDefaultExpireDateEnforced() {
+        return \OC_Util::isDefaultExpireDateEnforced();
+    }
+
+    protected static $needUpgradeCache = null;
+
+    /**
+     * Checks whether the current version needs upgrade.
+     *
+     * @return bool true if upgrade is needed, false otherwise
+     * @since 7.0.0
+     */
+    public static function needUpgrade() {
+        if (!isset(self::$needUpgradeCache)) {
+            self::$needUpgradeCache = \OC_Util::needUpgrade(\OCP\Server::get(\OC\SystemConfig::class));
+        }
+        return self::$needUpgradeCache;
+    }
+
+    /**
+     * Sometimes a string has to be shortened to fit within a certain maximum
+     * data length in bytes. substr() you may break multibyte characters,
+     * because it operates on single byte level. mb_substr() operates on
+     * characters, so does not ensure that the shortened string satisfies the
+     * max length in bytes.
+     *
+     * For example, json_encode is messing with multibyte characters a lot,
+     * replacing them with something along "\u1234".
+     *
+     * This function shortens the string with by $accuracy (-5) from
+     * $dataLength characters, until it fits within $dataLength bytes.
+     *
+     * @since 23.0.0
+     */
+    public static function shortenMultibyteString(string $subject, int $dataLength, int $accuracy = 5): string {
+        $temp = mb_substr($subject, 0, $dataLength);
+        // json encodes encapsulates the string in double quotes, they need to be substracted
+        while ((strlen(json_encode($temp)) - 2) > $dataLength) {
+            $temp = mb_substr($temp, 0, -$accuracy);
+        }
+        return $temp;
+    }
+
+    /**
+     * Check if a function is enabled in the php configuration
+     *
+     * @since 25.0.0
+     */
+    public static function isFunctionEnabled(string $functionName): bool {
+        if (!function_exists($functionName)) {
+            return false;
+        }
+        $ini = Server::get(IniGetWrapper::class);
+        $disabled = explode(',', $ini->get('disable_functions') ?: '');
+        $disabled = array_map('trim', $disabled);
+        if (in_array($functionName, $disabled)) {
+            return false;
+        }
+        return true;
+    }
 }

lib/private/PreviewManager.php

Indentation +431 added lines, -431 removed lines

@@ -28,435 +28,435 @@
 use function array_key_exists;
 
 class PreviewManager implements IPreview {
-	protected IConfig $config;
-	protected IRootFolder $rootFolder;
-	protected IAppData $appData;
-	protected IEventDispatcher $eventDispatcher;
-	private ?Generator $generator = null;
-	private GeneratorHelper $helper;
-	protected bool $providerListDirty = false;
-	protected bool $registeredCoreProviders = false;
-	protected array $providers = [];
-
-	/** @var array mime type => support status */
-	protected array $mimeTypeSupportMap = [];
-	protected ?array $defaultProviders = null;
-	protected ?string $userId;
-	private Coordinator $bootstrapCoordinator;
-
-	/**
-	 * Hash map (without value) of loaded bootstrap providers
-	 * @psalm-var array<string, null>
-	 */
-	private array $loadedBootstrapProviders = [];
-	private ContainerInterface $container;
-	private IBinaryFinder $binaryFinder;
-	private IMagickSupport $imagickSupport;
-	private bool $enablePreviews;
-
-	public function __construct(
-		IConfig $config,
-		IRootFolder $rootFolder,
-		IAppData $appData,
-		IEventDispatcher $eventDispatcher,
-		GeneratorHelper $helper,
-		?string $userId,
-		Coordinator $bootstrapCoordinator,
-		ContainerInterface $container,
-		IBinaryFinder $binaryFinder,
-		IMagickSupport $imagickSupport,
-	) {
-		$this->config = $config;
-		$this->rootFolder = $rootFolder;
-		$this->appData = $appData;
-		$this->eventDispatcher = $eventDispatcher;
-		$this->helper = $helper;
-		$this->userId = $userId;
-		$this->bootstrapCoordinator = $bootstrapCoordinator;
-		$this->container = $container;
-		$this->binaryFinder = $binaryFinder;
-		$this->imagickSupport = $imagickSupport;
-		$this->enablePreviews = $config->getSystemValueBool('enable_previews', true);
-	}
-
-	/**
-	 * In order to improve lazy loading a closure can be registered which will be
-	 * called in case preview providers are actually requested
-	 *
-	 * $callable has to return an instance of \OCP\Preview\IProvider or \OCP\Preview\IProviderV2
-	 *
-	 * @param string $mimeTypeRegex Regex with the mime types that are supported by this provider
-	 * @param \Closure $callable
-	 * @return void
-	 */
-	public function registerProvider($mimeTypeRegex, \Closure $callable): void {
-		if (!$this->enablePreviews) {
-			return;
-		}
-
-		if (!isset($this->providers[$mimeTypeRegex])) {
-			$this->providers[$mimeTypeRegex] = [];
-		}
-		$this->providers[$mimeTypeRegex][] = $callable;
-		$this->providerListDirty = true;
-	}
-
-	/**
-	 * Get all providers
-	 */
-	public function getProviders(): array {
-		if (!$this->enablePreviews) {
-			return [];
-		}
-
-		$this->registerCoreProviders();
-		$this->registerBootstrapProviders();
-		if ($this->providerListDirty) {
-			$keys = array_map('strlen', array_keys($this->providers));
-			array_multisort($keys, SORT_DESC, $this->providers);
-			$this->providerListDirty = false;
-		}
-
-		return $this->providers;
-	}
-
-	/**
-	 * Does the manager have any providers
-	 */
-	public function hasProviders(): bool {
-		$this->registerCoreProviders();
-		return !empty($this->providers);
-	}
-
-	private function getGenerator(): Generator {
-		if ($this->generator === null) {
-			$this->generator = new Generator(
-				$this->config,
-				$this,
-				$this->appData,
-				new GeneratorHelper(
-					$this->rootFolder,
-					$this->config
-				),
-				$this->eventDispatcher,
-				$this->container->get(LoggerInterface::class),
-			);
-		}
-		return $this->generator;
-	}
-
-	public function getPreview(
-		File $file,
-		$width = -1,
-		$height = -1,
-		$crop = false,
-		$mode = IPreview::MODE_FILL,
-		$mimeType = null,
-		bool $cacheResult = true,
-	): ISimpleFile {
-		$this->throwIfPreviewsDisabled($file, $mimeType);
-		$previewConcurrency = $this->getGenerator()->getNumConcurrentPreviews('preview_concurrency_all');
-		$sem = Generator::guardWithSemaphore(Generator::SEMAPHORE_ID_ALL, $previewConcurrency);
-		try {
-			$preview = $this->getGenerator()->getPreview($file, $width, $height, $crop, $mode, $mimeType, $cacheResult);
-		} finally {
-			Generator::unguardWithSemaphore($sem);
-		}
-
-		return $preview;
-	}
-
-	/**
-	 * Generates previews of a file
-	 *
-	 * @param File $file
-	 * @param array $specifications
-	 * @param string $mimeType
-	 * @return ISimpleFile the last preview that was generated
-	 * @throws NotFoundException
-	 * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
-	 * @since 19.0.0
-	 */
-	public function generatePreviews(File $file, array $specifications, $mimeType = null) {
-		$this->throwIfPreviewsDisabled($file, $mimeType);
-		return $this->getGenerator()->generatePreviews($file, $specifications, $mimeType);
-	}
-
-	/**
-	 * returns true if the passed mime type is supported
-	 *
-	 * @param string $mimeType
-	 * @return boolean
-	 */
-	public function isMimeSupported($mimeType = '*') {
-		if (!$this->enablePreviews) {
-			return false;
-		}
-
-		if (isset($this->mimeTypeSupportMap[$mimeType])) {
-			return $this->mimeTypeSupportMap[$mimeType];
-		}
-
-		$this->registerCoreProviders();
-		$this->registerBootstrapProviders();
-		$providerMimeTypes = array_keys($this->providers);
-		foreach ($providerMimeTypes as $supportedMimeType) {
-			if (preg_match($supportedMimeType, $mimeType)) {
-				$this->mimeTypeSupportMap[$mimeType] = true;
-				return true;
-			}
-		}
-		$this->mimeTypeSupportMap[$mimeType] = false;
-		return false;
-	}
-
-	/**
-	 * Check if a preview can be generated for a file
-	 */
-	public function isAvailable(\OCP\Files\FileInfo $file, ?string $mimeType = null): bool {
-		if (!$this->enablePreviews) {
-			return false;
-		}
-
-		$fileMimeType = $mimeType ?? $file->getMimeType();
-
-		$this->registerCoreProviders();
-		if (!$this->isMimeSupported($fileMimeType)) {
-			return false;
-		}
-
-		$mount = $file->getMountPoint();
-		if ($mount && !$mount->getOption('previews', true)) {
-			return false;
-		}
-
-		foreach ($this->providers as $supportedMimeType => $providers) {
-			if (preg_match($supportedMimeType, $fileMimeType)) {
-				foreach ($providers as $providerClosure) {
-					$provider = $this->helper->getProvider($providerClosure);
-					if (!($provider instanceof IProviderV2)) {
-						continue;
-					}
-
-					if ($provider->isAvailable($file)) {
-						return true;
-					}
-				}
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * List of enabled default providers
-	 *
-	 * The following providers are enabled by default:
-	 *  - OC\Preview\PNG
-	 *  - OC\Preview\JPEG
-	 *  - OC\Preview\GIF
-	 *  - OC\Preview\BMP
-	 *  - OC\Preview\XBitmap
-	 *  - OC\Preview\MarkDown
-	 *  - OC\Preview\MP3
-	 *  - OC\Preview\TXT
-	 *
-	 * The following providers are disabled by default due to performance or privacy concerns:
-	 *  - OC\Preview\Font
-	 *  - OC\Preview\HEIC
-	 *  - OC\Preview\Illustrator
-	 *  - OC\Preview\Movie
-	 *  - OC\Preview\MSOfficeDoc
-	 *  - OC\Preview\MSOffice2003
-	 *  - OC\Preview\MSOffice2007
-	 *  - OC\Preview\OpenDocument
-	 *  - OC\Preview\PDF
-	 *  - OC\Preview\Photoshop
-	 *  - OC\Preview\Postscript
-	 *  - OC\Preview\StarOffice
-	 *  - OC\Preview\SVG
-	 *  - OC\Preview\TIFF
-	 *
-	 * @return array
-	 */
-	protected function getEnabledDefaultProvider() {
-		if ($this->defaultProviders !== null) {
-			return $this->defaultProviders;
-		}
-
-		$imageProviders = [
-			Preview\PNG::class,
-			Preview\JPEG::class,
-			Preview\GIF::class,
-			Preview\BMP::class,
-			Preview\XBitmap::class,
-			Preview\Krita::class,
-			Preview\WebP::class,
-		];
-
-		$this->defaultProviders = $this->config->getSystemValue('enabledPreviewProviders', array_merge([
-			Preview\MarkDown::class,
-			Preview\MP3::class,
-			Preview\TXT::class,
-			Preview\OpenDocument::class,
-		], $imageProviders));
-
-		if (in_array(Preview\Image::class, $this->defaultProviders)) {
-			$this->defaultProviders = array_merge($this->defaultProviders, $imageProviders);
-		}
-		$this->defaultProviders = array_unique($this->defaultProviders);
-		return $this->defaultProviders;
-	}
-
-	/**
-	 * Register the default providers (if enabled)
-	 *
-	 * @param string $class
-	 * @param string $mimeType
-	 */
-	protected function registerCoreProvider($class, $mimeType, $options = []) {
-		if (in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) {
-			$this->registerProvider($mimeType, function () use ($class, $options) {
-				return new $class($options);
-			});
-		}
-	}
-
-	/**
-	 * Register the default providers (if enabled)
-	 */
-	protected function registerCoreProviders() {
-		if ($this->registeredCoreProviders) {
-			return;
-		}
-		$this->registeredCoreProviders = true;
-
-		$this->registerCoreProvider(Preview\TXT::class, '/text\/plain/');
-		$this->registerCoreProvider(Preview\MarkDown::class, '/text\/(x-)?markdown/');
-		$this->registerCoreProvider(Preview\PNG::class, '/image\/png/');
-		$this->registerCoreProvider(Preview\JPEG::class, '/image\/jpeg/');
-		$this->registerCoreProvider(Preview\GIF::class, '/image\/gif/');
-		$this->registerCoreProvider(Preview\BMP::class, '/image\/bmp/');
-		$this->registerCoreProvider(Preview\XBitmap::class, '/image\/x-xbitmap/');
-		$this->registerCoreProvider(Preview\WebP::class, '/image\/webp/');
-		$this->registerCoreProvider(Preview\Krita::class, '/application\/x-krita/');
-		$this->registerCoreProvider(Preview\MP3::class, '/audio\/mpeg$/');
-		$this->registerCoreProvider(Preview\OpenDocument::class, '/application\/vnd.oasis.opendocument.*/');
-		$this->registerCoreProvider(Preview\Imaginary::class, Preview\Imaginary::supportedMimeTypes());
-		$this->registerCoreProvider(Preview\ImaginaryPDF::class, Preview\ImaginaryPDF::supportedMimeTypes());
-
-		// SVG and Bitmap require imagick
-		if ($this->imagickSupport->hasExtension()) {
-			$imagickProviders = [
-				'SVG' => ['mimetype' => '/image\/svg\+xml/', 'class' => Preview\SVG::class],
-				'TIFF' => ['mimetype' => '/image\/tiff/', 'class' => Preview\TIFF::class],
-				'PDF' => ['mimetype' => '/application\/pdf/', 'class' => Preview\PDF::class],
-				'AI' => ['mimetype' => '/application\/illustrator/', 'class' => Preview\Illustrator::class],
-				'PSD' => ['mimetype' => '/application\/x-photoshop/', 'class' => Preview\Photoshop::class],
-				'EPS' => ['mimetype' => '/application\/postscript/', 'class' => Preview\Postscript::class],
-				'TTF' => ['mimetype' => '/application\/(?:font-sfnt|x-font$)/', 'class' => Preview\Font::class],
-				'HEIC' => ['mimetype' => '/image\/(x-)?hei(f|c)/', 'class' => Preview\HEIC::class],
-				'TGA' => ['mimetype' => '/image\/(x-)?t(ar)?ga/', 'class' => Preview\TGA::class],
-				'SGI' => ['mimetype' => '/image\/(x-)?sgi/', 'class' => Preview\SGI::class],
-			];
-
-			foreach ($imagickProviders as $queryFormat => $provider) {
-				$class = $provider['class'];
-				if (!in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) {
-					continue;
-				}
-
-				if ($this->imagickSupport->supportsFormat($queryFormat)) {
-					$this->registerCoreProvider($class, $provider['mimetype']);
-				}
-			}
-		}
-
-		$this->registerCoreProvidersOffice();
-
-		// Video requires ffmpeg
-		if (in_array(Preview\Movie::class, $this->getEnabledDefaultProvider())) {
-			$movieBinary = $this->config->getSystemValue('preview_ffmpeg_path', null);
-			if (!is_string($movieBinary)) {
-				$movieBinary = $this->binaryFinder->findBinaryPath('ffmpeg');
-			}
-
-
-			if (is_string($movieBinary)) {
-				$this->registerCoreProvider(Preview\Movie::class, '/video\/.*/', ['movieBinary' => $movieBinary]);
-			}
-		}
-	}
-
-	private function registerCoreProvidersOffice(): void {
-		$officeProviders = [
-			['mimetype' => '/application\/msword/', 'class' => Preview\MSOfficeDoc::class],
-			['mimetype' => '/application\/vnd.ms-.*/', 'class' => Preview\MSOffice2003::class],
-			['mimetype' => '/application\/vnd.openxmlformats-officedocument.*/', 'class' => Preview\MSOffice2007::class],
-			['mimetype' => '/application\/vnd.oasis.opendocument.*/', 'class' => Preview\OpenDocument::class],
-			['mimetype' => '/application\/vnd.sun.xml.*/', 'class' => Preview\StarOffice::class],
-			['mimetype' => '/image\/emf/', 'class' => Preview\EMF::class],
-		];
-
-		$findBinary = true;
-		$officeBinary = false;
-
-		foreach ($officeProviders as $provider) {
-			$class = $provider['class'];
-			if (!in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) {
-				continue;
-			}
-
-			if ($findBinary) {
-				// Office requires openoffice or libreoffice
-				$officeBinary = $this->config->getSystemValue('preview_libreoffice_path', false);
-				if ($officeBinary === false) {
-					$officeBinary = $this->binaryFinder->findBinaryPath('libreoffice');
-				}
-				if ($officeBinary === false) {
-					$officeBinary = $this->binaryFinder->findBinaryPath('openoffice');
-				}
-				$findBinary = false;
-			}
-
-			if ($officeBinary) {
-				$this->registerCoreProvider($class, $provider['mimetype'], ['officeBinary' => $officeBinary]);
-			}
-		}
-	}
-
-	private function registerBootstrapProviders(): void {
-		$context = $this->bootstrapCoordinator->getRegistrationContext();
-
-		if ($context === null) {
-			// Just ignore for now
-			return;
-		}
-
-		$providers = $context->getPreviewProviders();
-		foreach ($providers as $provider) {
-			$key = $provider->getMimeTypeRegex() . '-' . $provider->getService();
-			if (array_key_exists($key, $this->loadedBootstrapProviders)) {
-				// Do not load the provider more than once
-				continue;
-			}
-			$this->loadedBootstrapProviders[$key] = null;
-
-			$this->registerProvider($provider->getMimeTypeRegex(), function () use ($provider) {
-				try {
-					return $this->container->get($provider->getService());
-				} catch (QueryException $e) {
-					return null;
-				}
-			});
-		}
-	}
-
-	/**
-	 * @throws NotFoundException if preview generation is disabled
-	 */
-	private function throwIfPreviewsDisabled(File $file, ?string $mimeType = null): void {
-		if (!$this->isAvailable($file, $mimeType)) {
-			throw new NotFoundException('Previews disabled');
-		}
-	}
+    protected IConfig $config;
+    protected IRootFolder $rootFolder;
+    protected IAppData $appData;
+    protected IEventDispatcher $eventDispatcher;
+    private ?Generator $generator = null;
+    private GeneratorHelper $helper;
+    protected bool $providerListDirty = false;
+    protected bool $registeredCoreProviders = false;
+    protected array $providers = [];
+
+    /** @var array mime type => support status */
+    protected array $mimeTypeSupportMap = [];
+    protected ?array $defaultProviders = null;
+    protected ?string $userId;
+    private Coordinator $bootstrapCoordinator;
+
+    /**
+     * Hash map (without value) of loaded bootstrap providers
+     * @psalm-var array<string, null>
+     */
+    private array $loadedBootstrapProviders = [];
+    private ContainerInterface $container;
+    private IBinaryFinder $binaryFinder;
+    private IMagickSupport $imagickSupport;
+    private bool $enablePreviews;
+
+    public function __construct(
+        IConfig $config,
+        IRootFolder $rootFolder,
+        IAppData $appData,
+        IEventDispatcher $eventDispatcher,
+        GeneratorHelper $helper,
+        ?string $userId,
+        Coordinator $bootstrapCoordinator,
+        ContainerInterface $container,
+        IBinaryFinder $binaryFinder,
+        IMagickSupport $imagickSupport,
+    ) {
+        $this->config = $config;
+        $this->rootFolder = $rootFolder;
+        $this->appData = $appData;
+        $this->eventDispatcher = $eventDispatcher;
+        $this->helper = $helper;
+        $this->userId = $userId;
+        $this->bootstrapCoordinator = $bootstrapCoordinator;
+        $this->container = $container;
+        $this->binaryFinder = $binaryFinder;
+        $this->imagickSupport = $imagickSupport;
+        $this->enablePreviews = $config->getSystemValueBool('enable_previews', true);
+    }
+
+    /**
+     * In order to improve lazy loading a closure can be registered which will be
+     * called in case preview providers are actually requested
+     *
+     * $callable has to return an instance of \OCP\Preview\IProvider or \OCP\Preview\IProviderV2
+     *
+     * @param string $mimeTypeRegex Regex with the mime types that are supported by this provider
+     * @param \Closure $callable
+     * @return void
+     */
+    public function registerProvider($mimeTypeRegex, \Closure $callable): void {
+        if (!$this->enablePreviews) {
+            return;
+        }
+
+        if (!isset($this->providers[$mimeTypeRegex])) {
+            $this->providers[$mimeTypeRegex] = [];
+        }
+        $this->providers[$mimeTypeRegex][] = $callable;
+        $this->providerListDirty = true;
+    }
+
+    /**
+     * Get all providers
+     */
+    public function getProviders(): array {
+        if (!$this->enablePreviews) {
+            return [];
+        }
+
+        $this->registerCoreProviders();
+        $this->registerBootstrapProviders();
+        if ($this->providerListDirty) {
+            $keys = array_map('strlen', array_keys($this->providers));
+            array_multisort($keys, SORT_DESC, $this->providers);
+            $this->providerListDirty = false;
+        }
+
+        return $this->providers;
+    }
+
+    /**
+     * Does the manager have any providers
+     */
+    public function hasProviders(): bool {
+        $this->registerCoreProviders();
+        return !empty($this->providers);
+    }
+
+    private function getGenerator(): Generator {
+        if ($this->generator === null) {
+            $this->generator = new Generator(
+                $this->config,
+                $this,
+                $this->appData,
+                new GeneratorHelper(
+                    $this->rootFolder,
+                    $this->config
+                ),
+                $this->eventDispatcher,
+                $this->container->get(LoggerInterface::class),
+            );
+        }
+        return $this->generator;
+    }
+
+    public function getPreview(
+        File $file,
+        $width = -1,
+        $height = -1,
+        $crop = false,
+        $mode = IPreview::MODE_FILL,
+        $mimeType = null,
+        bool $cacheResult = true,
+    ): ISimpleFile {
+        $this->throwIfPreviewsDisabled($file, $mimeType);
+        $previewConcurrency = $this->getGenerator()->getNumConcurrentPreviews('preview_concurrency_all');
+        $sem = Generator::guardWithSemaphore(Generator::SEMAPHORE_ID_ALL, $previewConcurrency);
+        try {
+            $preview = $this->getGenerator()->getPreview($file, $width, $height, $crop, $mode, $mimeType, $cacheResult);
+        } finally {
+            Generator::unguardWithSemaphore($sem);
+        }
+
+        return $preview;
+    }
+
+    /**
+     * Generates previews of a file
+     *
+     * @param File $file
+     * @param array $specifications
+     * @param string $mimeType
+     * @return ISimpleFile the last preview that was generated
+     * @throws NotFoundException
+     * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
+     * @since 19.0.0
+     */
+    public function generatePreviews(File $file, array $specifications, $mimeType = null) {
+        $this->throwIfPreviewsDisabled($file, $mimeType);
+        return $this->getGenerator()->generatePreviews($file, $specifications, $mimeType);
+    }
+
+    /**
+     * returns true if the passed mime type is supported
+     *
+     * @param string $mimeType
+     * @return boolean
+     */
+    public function isMimeSupported($mimeType = '*') {
+        if (!$this->enablePreviews) {
+            return false;
+        }
+
+        if (isset($this->mimeTypeSupportMap[$mimeType])) {
+            return $this->mimeTypeSupportMap[$mimeType];
+        }
+
+        $this->registerCoreProviders();
+        $this->registerBootstrapProviders();
+        $providerMimeTypes = array_keys($this->providers);
+        foreach ($providerMimeTypes as $supportedMimeType) {
+            if (preg_match($supportedMimeType, $mimeType)) {
+                $this->mimeTypeSupportMap[$mimeType] = true;
+                return true;
+            }
+        }
+        $this->mimeTypeSupportMap[$mimeType] = false;
+        return false;
+    }
+
+    /**
+     * Check if a preview can be generated for a file
+     */
+    public function isAvailable(\OCP\Files\FileInfo $file, ?string $mimeType = null): bool {
+        if (!$this->enablePreviews) {
+            return false;
+        }
+
+        $fileMimeType = $mimeType ?? $file->getMimeType();
+
+        $this->registerCoreProviders();
+        if (!$this->isMimeSupported($fileMimeType)) {
+            return false;
+        }
+
+        $mount = $file->getMountPoint();
+        if ($mount && !$mount->getOption('previews', true)) {
+            return false;
+        }
+
+        foreach ($this->providers as $supportedMimeType => $providers) {
+            if (preg_match($supportedMimeType, $fileMimeType)) {
+                foreach ($providers as $providerClosure) {
+                    $provider = $this->helper->getProvider($providerClosure);
+                    if (!($provider instanceof IProviderV2)) {
+                        continue;
+                    }
+
+                    if ($provider->isAvailable($file)) {
+                        return true;
+                    }
+                }
+            }
+        }
+        return false;
+    }
+
+    /**
+     * List of enabled default providers
+     *
+     * The following providers are enabled by default:
+     *  - OC\Preview\PNG
+     *  - OC\Preview\JPEG
+     *  - OC\Preview\GIF
+     *  - OC\Preview\BMP
+     *  - OC\Preview\XBitmap
+     *  - OC\Preview\MarkDown
+     *  - OC\Preview\MP3
+     *  - OC\Preview\TXT
+     *
+     * The following providers are disabled by default due to performance or privacy concerns:
+     *  - OC\Preview\Font
+     *  - OC\Preview\HEIC
+     *  - OC\Preview\Illustrator
+     *  - OC\Preview\Movie
+     *  - OC\Preview\MSOfficeDoc
+     *  - OC\Preview\MSOffice2003
+     *  - OC\Preview\MSOffice2007
+     *  - OC\Preview\OpenDocument
+     *  - OC\Preview\PDF
+     *  - OC\Preview\Photoshop
+     *  - OC\Preview\Postscript
+     *  - OC\Preview\StarOffice
+     *  - OC\Preview\SVG
+     *  - OC\Preview\TIFF
+     *
+     * @return array
+     */
+    protected function getEnabledDefaultProvider() {
+        if ($this->defaultProviders !== null) {
+            return $this->defaultProviders;
+        }
+
+        $imageProviders = [
+            Preview\PNG::class,
+            Preview\JPEG::class,
+            Preview\GIF::class,
+            Preview\BMP::class,
+            Preview\XBitmap::class,
+            Preview\Krita::class,
+            Preview\WebP::class,
+        ];
+
+        $this->defaultProviders = $this->config->getSystemValue('enabledPreviewProviders', array_merge([
+            Preview\MarkDown::class,
+            Preview\MP3::class,
+            Preview\TXT::class,
+            Preview\OpenDocument::class,
+        ], $imageProviders));
+
+        if (in_array(Preview\Image::class, $this->defaultProviders)) {
+            $this->defaultProviders = array_merge($this->defaultProviders, $imageProviders);
+        }
+        $this->defaultProviders = array_unique($this->defaultProviders);
+        return $this->defaultProviders;
+    }
+
+    /**
+     * Register the default providers (if enabled)
+     *
+     * @param string $class
+     * @param string $mimeType
+     */
+    protected function registerCoreProvider($class, $mimeType, $options = []) {
+        if (in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) {
+            $this->registerProvider($mimeType, function () use ($class, $options) {
+                return new $class($options);
+            });
+        }
+    }
+
+    /**
+     * Register the default providers (if enabled)
+     */
+    protected function registerCoreProviders() {
+        if ($this->registeredCoreProviders) {
+            return;
+        }
+        $this->registeredCoreProviders = true;
+
+        $this->registerCoreProvider(Preview\TXT::class, '/text\/plain/');
+        $this->registerCoreProvider(Preview\MarkDown::class, '/text\/(x-)?markdown/');
+        $this->registerCoreProvider(Preview\PNG::class, '/image\/png/');
+        $this->registerCoreProvider(Preview\JPEG::class, '/image\/jpeg/');
+        $this->registerCoreProvider(Preview\GIF::class, '/image\/gif/');
+        $this->registerCoreProvider(Preview\BMP::class, '/image\/bmp/');
+        $this->registerCoreProvider(Preview\XBitmap::class, '/image\/x-xbitmap/');
+        $this->registerCoreProvider(Preview\WebP::class, '/image\/webp/');
+        $this->registerCoreProvider(Preview\Krita::class, '/application\/x-krita/');
+        $this->registerCoreProvider(Preview\MP3::class, '/audio\/mpeg$/');
+        $this->registerCoreProvider(Preview\OpenDocument::class, '/application\/vnd.oasis.opendocument.*/');
+        $this->registerCoreProvider(Preview\Imaginary::class, Preview\Imaginary::supportedMimeTypes());
+        $this->registerCoreProvider(Preview\ImaginaryPDF::class, Preview\ImaginaryPDF::supportedMimeTypes());
+
+        // SVG and Bitmap require imagick
+        if ($this->imagickSupport->hasExtension()) {
+            $imagickProviders = [
+                'SVG' => ['mimetype' => '/image\/svg\+xml/', 'class' => Preview\SVG::class],
+                'TIFF' => ['mimetype' => '/image\/tiff/', 'class' => Preview\TIFF::class],
+                'PDF' => ['mimetype' => '/application\/pdf/', 'class' => Preview\PDF::class],
+                'AI' => ['mimetype' => '/application\/illustrator/', 'class' => Preview\Illustrator::class],
+                'PSD' => ['mimetype' => '/application\/x-photoshop/', 'class' => Preview\Photoshop::class],
+                'EPS' => ['mimetype' => '/application\/postscript/', 'class' => Preview\Postscript::class],
+                'TTF' => ['mimetype' => '/application\/(?:font-sfnt|x-font$)/', 'class' => Preview\Font::class],
+                'HEIC' => ['mimetype' => '/image\/(x-)?hei(f|c)/', 'class' => Preview\HEIC::class],
+                'TGA' => ['mimetype' => '/image\/(x-)?t(ar)?ga/', 'class' => Preview\TGA::class],
+                'SGI' => ['mimetype' => '/image\/(x-)?sgi/', 'class' => Preview\SGI::class],
+            ];
+
+            foreach ($imagickProviders as $queryFormat => $provider) {
+                $class = $provider['class'];
+                if (!in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) {
+                    continue;
+                }
+
+                if ($this->imagickSupport->supportsFormat($queryFormat)) {
+                    $this->registerCoreProvider($class, $provider['mimetype']);
+                }
+            }
+        }
+
+        $this->registerCoreProvidersOffice();
+
+        // Video requires ffmpeg
+        if (in_array(Preview\Movie::class, $this->getEnabledDefaultProvider())) {
+            $movieBinary = $this->config->getSystemValue('preview_ffmpeg_path', null);
+            if (!is_string($movieBinary)) {
+                $movieBinary = $this->binaryFinder->findBinaryPath('ffmpeg');
+            }
+
+
+            if (is_string($movieBinary)) {
+                $this->registerCoreProvider(Preview\Movie::class, '/video\/.*/', ['movieBinary' => $movieBinary]);
+            }
+        }
+    }
+
+    private function registerCoreProvidersOffice(): void {
+        $officeProviders = [
+            ['mimetype' => '/application\/msword/', 'class' => Preview\MSOfficeDoc::class],
+            ['mimetype' => '/application\/vnd.ms-.*/', 'class' => Preview\MSOffice2003::class],
+            ['mimetype' => '/application\/vnd.openxmlformats-officedocument.*/', 'class' => Preview\MSOffice2007::class],
+            ['mimetype' => '/application\/vnd.oasis.opendocument.*/', 'class' => Preview\OpenDocument::class],
+            ['mimetype' => '/application\/vnd.sun.xml.*/', 'class' => Preview\StarOffice::class],
+            ['mimetype' => '/image\/emf/', 'class' => Preview\EMF::class],
+        ];
+
+        $findBinary = true;
+        $officeBinary = false;
+
+        foreach ($officeProviders as $provider) {
+            $class = $provider['class'];
+            if (!in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) {
+                continue;
+            }
+
+            if ($findBinary) {
+                // Office requires openoffice or libreoffice
+                $officeBinary = $this->config->getSystemValue('preview_libreoffice_path', false);
+                if ($officeBinary === false) {
+                    $officeBinary = $this->binaryFinder->findBinaryPath('libreoffice');
+                }
+                if ($officeBinary === false) {
+                    $officeBinary = $this->binaryFinder->findBinaryPath('openoffice');
+                }
+                $findBinary = false;
+            }
+
+            if ($officeBinary) {
+                $this->registerCoreProvider($class, $provider['mimetype'], ['officeBinary' => $officeBinary]);
+            }
+        }
+    }
+
+    private function registerBootstrapProviders(): void {
+        $context = $this->bootstrapCoordinator->getRegistrationContext();
+
+        if ($context === null) {
+            // Just ignore for now
+            return;
+        }
+
+        $providers = $context->getPreviewProviders();
+        foreach ($providers as $provider) {
+            $key = $provider->getMimeTypeRegex() . '-' . $provider->getService();
+            if (array_key_exists($key, $this->loadedBootstrapProviders)) {
+                // Do not load the provider more than once
+                continue;
+            }
+            $this->loadedBootstrapProviders[$key] = null;
+
+            $this->registerProvider($provider->getMimeTypeRegex(), function () use ($provider) {
+                try {
+                    return $this->container->get($provider->getService());
+                } catch (QueryException $e) {
+                    return null;
+                }
+            });
+        }
+    }
+
+    /**
+     * @throws NotFoundException if preview generation is disabled
+     */
+    private function throwIfPreviewsDisabled(File $file, ?string $mimeType = null): void {
+        if (!$this->isAvailable($file, $mimeType)) {
+            throw new NotFoundException('Previews disabled');
+        }
+    }
 }

lib/private/IntegrityCheck/Checker.php

Indentation +518 added lines, -518 removed lines

@@ -35,522 +35,522 @@
  * @package OC\IntegrityCheck
  */
 class Checker {
-	public const CACHE_KEY = 'oc.integritycheck.checker';
-
-	private ICache $cache;
-
-	public function __construct(
-		private ServerVersion $serverVersion,
-		private EnvironmentHelper $environmentHelper,
-		private FileAccessHelper $fileAccessHelper,
-		private ?IConfig $config,
-		private ?IAppConfig $appConfig,
-		ICacheFactory $cacheFactory,
-		private IAppManager $appManager,
-		private IMimeTypeDetector $mimeTypeDetector,
-	) {
-		$this->cache = $cacheFactory->createDistributed(self::CACHE_KEY);
-	}
-
-	/**
-	 * Whether code signing is enforced or not.
-	 *
-	 * @return bool
-	 */
-	public function isCodeCheckEnforced(): bool {
-		$notSignedChannels = [ '', 'git'];
-		if (\in_array($this->serverVersion->getChannel(), $notSignedChannels, true)) {
-			return false;
-		}
-
-		/**
-		 * This config option is undocumented and supposed to be so, it's only
-		 * applicable for very specific scenarios and we should not advertise it
-		 * too prominent. So please do not add it to config.sample.php.
-		 */
-		return !($this->config?->getSystemValueBool('integrity.check.disabled', false) ?? false);
-	}
-
-	/**
-	 * Enumerates all files belonging to the folder. Sensible defaults are excluded.
-	 *
-	 * @param string $folderToIterate
-	 * @param string $root
-	 * @return \RecursiveIteratorIterator
-	 * @throws \Exception
-	 */
-	private function getFolderIterator(string $folderToIterate, string $root = ''): \RecursiveIteratorIterator {
-		$dirItr = new \RecursiveDirectoryIterator(
-			$folderToIterate,
-			\RecursiveDirectoryIterator::SKIP_DOTS
-		);
-		if ($root === '') {
-			$root = \OC::$SERVERROOT;
-		}
-		$root = rtrim($root, '/');
-
-		$excludeGenericFilesIterator = new ExcludeFileByNameFilterIterator($dirItr);
-		$excludeFoldersIterator = new ExcludeFoldersByPathFilterIterator($excludeGenericFilesIterator, $root);
-
-		return new \RecursiveIteratorIterator(
-			$excludeFoldersIterator,
-			\RecursiveIteratorIterator::SELF_FIRST
-		);
-	}
-
-	/**
-	 * Returns an array of ['filename' => 'SHA512-hash-of-file'] for all files found
-	 * in the iterator.
-	 *
-	 * @param \RecursiveIteratorIterator $iterator
-	 * @param string $path
-	 * @return array Array of hashes.
-	 */
-	private function generateHashes(\RecursiveIteratorIterator $iterator,
-		string $path): array {
-		$hashes = [];
-
-		$baseDirectoryLength = \strlen($path);
-		foreach ($iterator as $filename => $data) {
-			/** @var \DirectoryIterator $data */
-			if ($data->isDir()) {
-				continue;
-			}
-
-			$relativeFileName = substr($filename, $baseDirectoryLength);
-			$relativeFileName = ltrim($relativeFileName, '/');
-
-			// Exclude signature.json files in the appinfo and root folder
-			if ($relativeFileName === 'appinfo/signature.json') {
-				continue;
-			}
-			// Exclude signature.json files in the appinfo and core folder
-			if ($relativeFileName === 'core/signature.json') {
-				continue;
-			}
-
-			// The .htaccess file in the root folder of ownCloud can contain
-			// custom content after the installation due to the fact that dynamic
-			// content is written into it at installation time as well. This
-			// includes for example the 404 and 403 instructions.
-			// Thus we ignore everything below the first occurrence of
-			// "#### DO NOT CHANGE ANYTHING ABOVE THIS LINE ####" and have the
-			// hash generated based on this.
-			if ($filename === $this->environmentHelper->getServerRoot() . '/.htaccess') {
-				$fileContent = file_get_contents($filename);
-				$explodedArray = explode('#### DO NOT CHANGE ANYTHING ABOVE THIS LINE ####', $fileContent);
-				if (\count($explodedArray) === 2) {
-					$hashes[$relativeFileName] = hash('sha512', $explodedArray[0]);
-					continue;
-				}
-			}
-			if ($filename === $this->environmentHelper->getServerRoot() . '/core/js/mimetypelist.js') {
-				$oldMimetypeList = new GenerateMimetypeFileBuilder();
-				$newFile = $oldMimetypeList->generateFile($this->mimeTypeDetector->getAllAliases(), $this->mimeTypeDetector->getAllNamings());
-				$oldFile = $this->fileAccessHelper->file_get_contents($filename);
-				if ($newFile === $oldFile) {
-					$hashes[$relativeFileName] = hash('sha512', $oldMimetypeList->generateFile($this->mimeTypeDetector->getOnlyDefaultAliases(), $this->mimeTypeDetector->getAllNamings()));
-					continue;
-				}
-			}
-
-			$hashes[$relativeFileName] = hash_file('sha512', $filename);
-		}
-
-		return $hashes;
-	}
-
-	/**
-	 * Creates the signature data
-	 *
-	 * @param array $hashes
-	 * @param X509 $certificate
-	 * @param RSA $privateKey
-	 * @return array
-	 */
-	private function createSignatureData(array $hashes,
-		X509 $certificate,
-		RSA $privateKey): array {
-		ksort($hashes);
-
-		$privateKey->setSignatureMode(RSA::SIGNATURE_PSS);
-		$privateKey->setMGFHash('sha512');
-		// See https://tools.ietf.org/html/rfc3447#page-38
-		$privateKey->setSaltLength(0);
-		$signature = $privateKey->sign(json_encode($hashes));
-
-		return [
-			'hashes' => $hashes,
-			'signature' => base64_encode($signature),
-			'certificate' => $certificate->saveX509($certificate->currentCert),
-		];
-	}
-
-	/**
-	 * Write the signature of the app in the specified folder
-	 *
-	 * @param string $path
-	 * @param X509 $certificate
-	 * @param RSA $privateKey
-	 * @throws \Exception
-	 */
-	public function writeAppSignature($path,
-		X509 $certificate,
-		RSA $privateKey) {
-		$appInfoDir = $path . '/appinfo';
-		try {
-			$this->fileAccessHelper->assertDirectoryExists($appInfoDir);
-
-			$iterator = $this->getFolderIterator($path);
-			$hashes = $this->generateHashes($iterator, $path);
-			$signature = $this->createSignatureData($hashes, $certificate, $privateKey);
-			$this->fileAccessHelper->file_put_contents(
-				$appInfoDir . '/signature.json',
-				json_encode($signature, JSON_PRETTY_PRINT)
-			);
-		} catch (\Exception $e) {
-			if (!$this->fileAccessHelper->is_writable($appInfoDir)) {
-				throw new \Exception($appInfoDir . ' is not writable');
-			}
-			throw $e;
-		}
-	}
-
-	/**
-	 * Write the signature of core
-	 *
-	 * @param X509 $certificate
-	 * @param RSA $rsa
-	 * @param string $path
-	 * @throws \Exception
-	 */
-	public function writeCoreSignature(X509 $certificate,
-		RSA $rsa,
-		$path) {
-		$coreDir = $path . '/core';
-		try {
-			$this->fileAccessHelper->assertDirectoryExists($coreDir);
-			$iterator = $this->getFolderIterator($path, $path);
-			$hashes = $this->generateHashes($iterator, $path);
-			$signatureData = $this->createSignatureData($hashes, $certificate, $rsa);
-			$this->fileAccessHelper->file_put_contents(
-				$coreDir . '/signature.json',
-				json_encode($signatureData, JSON_PRETTY_PRINT)
-			);
-		} catch (\Exception $e) {
-			if (!$this->fileAccessHelper->is_writable($coreDir)) {
-				throw new \Exception($coreDir . ' is not writable');
-			}
-			throw $e;
-		}
-	}
-
-	/**
-	 * Split the certificate file in individual certs
-	 *
-	 * @param string $cert
-	 * @return string[]
-	 */
-	private function splitCerts(string $cert): array {
-		preg_match_all('([\-]{3,}[\S\ ]+?[\-]{3,}[\S\s]+?[\-]{3,}[\S\ ]+?[\-]{3,})', $cert, $matches);
-
-		return $matches[0];
-	}
-
-	/**
-	 * Verifies the signature for the specified path.
-	 *
-	 * @param string $signaturePath
-	 * @param string $basePath
-	 * @param string $certificateCN
-	 * @param bool $forceVerify
-	 * @return array
-	 * @throws InvalidSignatureException
-	 * @throws \Exception
-	 */
-	private function verify(string $signaturePath, string $basePath, string $certificateCN, bool $forceVerify = false): array {
-		if (!$forceVerify && !$this->isCodeCheckEnforced()) {
-			return [];
-		}
-
-		$content = $this->fileAccessHelper->file_get_contents($signaturePath);
-		$signatureData = null;
-
-		if (\is_string($content)) {
-			$signatureData = json_decode($content, true);
-		}
-		if (!\is_array($signatureData)) {
-			throw new InvalidSignatureException('Signature data not found.');
-		}
-
-		$expectedHashes = $signatureData['hashes'];
-		ksort($expectedHashes);
-		$signature = base64_decode($signatureData['signature']);
-		$certificate = $signatureData['certificate'];
-
-		// Check if certificate is signed by Nextcloud Root Authority
-		$x509 = new \phpseclib\File\X509();
-		$rootCertificatePublicKey = $this->fileAccessHelper->file_get_contents($this->environmentHelper->getServerRoot() . '/resources/codesigning/root.crt');
-
-		$rootCerts = $this->splitCerts($rootCertificatePublicKey);
-		foreach ($rootCerts as $rootCert) {
-			$x509->loadCA($rootCert);
-		}
-		$x509->loadX509($certificate);
-		if (!$x509->validateSignature()) {
-			throw new InvalidSignatureException('Certificate is not valid.');
-		}
-		// Verify if certificate has proper CN. "core" CN is always trusted.
-		if ($x509->getDN(X509::DN_OPENSSL)['CN'] !== $certificateCN && $x509->getDN(X509::DN_OPENSSL)['CN'] !== 'core') {
-			throw new InvalidSignatureException(
-				sprintf('Certificate is not valid for required scope. (Requested: %s, current: CN=%s)', $certificateCN, $x509->getDN(true)['CN'])
-			);
-		}
-
-		// Check if the signature of the files is valid
-		$rsa = new \phpseclib\Crypt\RSA();
-		$rsa->loadKey($x509->currentCert['tbsCertificate']['subjectPublicKeyInfo']['subjectPublicKey']);
-		$rsa->setSignatureMode(RSA::SIGNATURE_PSS);
-		$rsa->setMGFHash('sha512');
-		// See https://tools.ietf.org/html/rfc3447#page-38
-		$rsa->setSaltLength(0);
-		if (!$rsa->verify(json_encode($expectedHashes), $signature)) {
-			throw new InvalidSignatureException('Signature could not get verified.');
-		}
-
-		// Fixes for the updater as shipped with ownCloud 9.0.x: The updater is
-		// replaced after the code integrity check is performed.
-		//
-		// Due to this reason we exclude the whole updater/ folder from the code
-		// integrity check.
-		if ($basePath === $this->environmentHelper->getServerRoot()) {
-			foreach ($expectedHashes as $fileName => $hash) {
-				if (str_starts_with($fileName, 'updater/')) {
-					unset($expectedHashes[$fileName]);
-				}
-			}
-		}
-
-		// Compare the list of files which are not identical
-		$currentInstanceHashes = $this->generateHashes($this->getFolderIterator($basePath), $basePath);
-		$differencesA = array_diff_assoc($expectedHashes, $currentInstanceHashes);
-		$differencesB = array_diff_assoc($currentInstanceHashes, $expectedHashes);
-		$differences = array_unique(array_merge($differencesA, $differencesB));
-		$differenceArray = [];
-		foreach ($differences as $filename => $hash) {
-			// Check if file should not exist in the new signature table
-			if (!array_key_exists($filename, $expectedHashes)) {
-				$differenceArray['EXTRA_FILE'][$filename]['expected'] = '';
-				$differenceArray['EXTRA_FILE'][$filename]['current'] = $hash;
-				continue;
-			}
-
-			// Check if file is missing
-			if (!array_key_exists($filename, $currentInstanceHashes)) {
-				$differenceArray['FILE_MISSING'][$filename]['expected'] = $expectedHashes[$filename];
-				$differenceArray['FILE_MISSING'][$filename]['current'] = '';
-				continue;
-			}
-
-			// Check if hash does mismatch
-			if ($expectedHashes[$filename] !== $currentInstanceHashes[$filename]) {
-				$differenceArray['INVALID_HASH'][$filename]['expected'] = $expectedHashes[$filename];
-				$differenceArray['INVALID_HASH'][$filename]['current'] = $currentInstanceHashes[$filename];
-				continue;
-			}
-
-			// Should never happen.
-			throw new \Exception('Invalid behaviour in file hash comparison experienced. Please report this error to the developers.');
-		}
-
-		return $differenceArray;
-	}
-
-	/**
-	 * Whether the code integrity check has passed successful or not
-	 *
-	 * @return bool
-	 */
-	public function hasPassedCheck(): bool {
-		$results = $this->getResults();
-		if ($results !== null && empty($results)) {
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * @return array|null Either the results or null if no results available
-	 */
-	public function getResults(): ?array {
-		$cachedResults = $this->cache->get(self::CACHE_KEY);
-		if (!\is_null($cachedResults) && $cachedResults !== false) {
-			return json_decode($cachedResults, true);
-		}
-
-		if ($this->appConfig?->hasKey('core', self::CACHE_KEY, lazy: true)) {
-			return $this->appConfig->getValueArray('core', self::CACHE_KEY, lazy: true);
-		}
-
-		// No results available
-		return null;
-	}
-
-	/**
-	 * Stores the results in the app config as well as cache
-	 *
-	 * @param string $scope
-	 * @param array $result
-	 */
-	private function storeResults(string $scope, array $result) {
-		$resultArray = $this->getResults() ?? [];
-		unset($resultArray[$scope]);
-		if (!empty($result)) {
-			$resultArray[$scope] = $result;
-		}
-		$this->appConfig?->setValueArray('core', self::CACHE_KEY, $resultArray, lazy: true);
-		$this->cache->set(self::CACHE_KEY, json_encode($resultArray));
-	}
-
-	/**
-	 *
-	 * Clean previous results for a proper rescanning. Otherwise
-	 */
-	private function cleanResults() {
-		$this->appConfig->deleteKey('core', self::CACHE_KEY);
-		$this->cache->remove(self::CACHE_KEY);
-	}
-
-	/**
-	 * Verify the signature of $appId. Returns an array with the following content:
-	 * [
-	 * 	'FILE_MISSING' =>
-	 * 	[
-	 * 		'filename' => [
-	 * 			'expected' => 'expectedSHA512',
-	 * 			'current' => 'currentSHA512',
-	 * 		],
-	 * 	],
-	 * 	'EXTRA_FILE' =>
-	 * 	[
-	 * 		'filename' => [
-	 * 			'expected' => 'expectedSHA512',
-	 * 			'current' => 'currentSHA512',
-	 * 		],
-	 * 	],
-	 * 	'INVALID_HASH' =>
-	 * 	[
-	 * 		'filename' => [
-	 * 			'expected' => 'expectedSHA512',
-	 * 			'current' => 'currentSHA512',
-	 * 		],
-	 * 	],
-	 * ]
-	 *
-	 * Array may be empty in case no problems have been found.
-	 *
-	 * @param string $appId
-	 * @param string $path Optional path. If none is given it will be guessed.
-	 * @param bool $forceVerify
-	 * @return array
-	 */
-	public function verifyAppSignature(string $appId, string $path = '', bool $forceVerify = false): array {
-		try {
-			if ($path === '') {
-				$path = $this->appManager->getAppPath($appId);
-			}
-			$result = $this->verify(
-				$path . '/appinfo/signature.json',
-				$path,
-				$appId,
-				$forceVerify
-			);
-		} catch (\Exception $e) {
-			$result = [
-				'EXCEPTION' => [
-					'class' => \get_class($e),
-					'message' => $e->getMessage(),
-				],
-			];
-		}
-		$this->storeResults($appId, $result);
-
-		return $result;
-	}
-
-	/**
-	 * Verify the signature of core. Returns an array with the following content:
-	 * [
-	 * 	'FILE_MISSING' =>
-	 * 	[
-	 * 		'filename' => [
-	 * 			'expected' => 'expectedSHA512',
-	 * 			'current' => 'currentSHA512',
-	 * 		],
-	 * 	],
-	 * 	'EXTRA_FILE' =>
-	 * 	[
-	 * 		'filename' => [
-	 * 			'expected' => 'expectedSHA512',
-	 * 			'current' => 'currentSHA512',
-	 * 		],
-	 * 	],
-	 * 	'INVALID_HASH' =>
-	 * 	[
-	 * 		'filename' => [
-	 * 			'expected' => 'expectedSHA512',
-	 * 			'current' => 'currentSHA512',
-	 * 		],
-	 * 	],
-	 * ]
-	 *
-	 * Array may be empty in case no problems have been found.
-	 *
-	 * @return array
-	 */
-	public function verifyCoreSignature(): array {
-		try {
-			$result = $this->verify(
-				$this->environmentHelper->getServerRoot() . '/core/signature.json',
-				$this->environmentHelper->getServerRoot(),
-				'core'
-			);
-		} catch (\Exception $e) {
-			$result = [
-				'EXCEPTION' => [
-					'class' => \get_class($e),
-					'message' => $e->getMessage(),
-				],
-			];
-		}
-		$this->storeResults('core', $result);
-
-		return $result;
-	}
-
-	/**
-	 * Verify the core code of the instance as well as all applicable applications
-	 * and store the results.
-	 */
-	public function runInstanceVerification() {
-		$this->cleanResults();
-		$this->verifyCoreSignature();
-		$appIds = $this->appManager->getAllAppsInAppsFolders();
-		foreach ($appIds as $appId) {
-			// If an application is shipped a valid signature is required
-			$isShipped = $this->appManager->isShipped($appId);
-			$appNeedsToBeChecked = false;
-			if ($isShipped) {
-				$appNeedsToBeChecked = true;
-			} elseif ($this->fileAccessHelper->file_exists($this->appManager->getAppPath($appId) . '/appinfo/signature.json')) {
-				// Otherwise only if the application explicitly ships a signature.json file
-				$appNeedsToBeChecked = true;
-			}
-
-			if ($appNeedsToBeChecked) {
-				$this->verifyAppSignature($appId);
-			}
-		}
-	}
+    public const CACHE_KEY = 'oc.integritycheck.checker';
+
+    private ICache $cache;
+
+    public function __construct(
+        private ServerVersion $serverVersion,
+        private EnvironmentHelper $environmentHelper,
+        private FileAccessHelper $fileAccessHelper,
+        private ?IConfig $config,
+        private ?IAppConfig $appConfig,
+        ICacheFactory $cacheFactory,
+        private IAppManager $appManager,
+        private IMimeTypeDetector $mimeTypeDetector,
+    ) {
+        $this->cache = $cacheFactory->createDistributed(self::CACHE_KEY);
+    }
+
+    /**
+     * Whether code signing is enforced or not.
+     *
+     * @return bool
+     */
+    public function isCodeCheckEnforced(): bool {
+        $notSignedChannels = [ '', 'git'];
+        if (\in_array($this->serverVersion->getChannel(), $notSignedChannels, true)) {
+            return false;
+        }
+
+        /**
+         * This config option is undocumented and supposed to be so, it's only
+         * applicable for very specific scenarios and we should not advertise it
+         * too prominent. So please do not add it to config.sample.php.
+         */
+        return !($this->config?->getSystemValueBool('integrity.check.disabled', false) ?? false);
+    }
+
+    /**
+     * Enumerates all files belonging to the folder. Sensible defaults are excluded.
+     *
+     * @param string $folderToIterate
+     * @param string $root
+     * @return \RecursiveIteratorIterator
+     * @throws \Exception
+     */
+    private function getFolderIterator(string $folderToIterate, string $root = ''): \RecursiveIteratorIterator {
+        $dirItr = new \RecursiveDirectoryIterator(
+            $folderToIterate,
+            \RecursiveDirectoryIterator::SKIP_DOTS
+        );
+        if ($root === '') {
+            $root = \OC::$SERVERROOT;
+        }
+        $root = rtrim($root, '/');
+
+        $excludeGenericFilesIterator = new ExcludeFileByNameFilterIterator($dirItr);
+        $excludeFoldersIterator = new ExcludeFoldersByPathFilterIterator($excludeGenericFilesIterator, $root);
+
+        return new \RecursiveIteratorIterator(
+            $excludeFoldersIterator,
+            \RecursiveIteratorIterator::SELF_FIRST
+        );
+    }
+
+    /**
+     * Returns an array of ['filename' => 'SHA512-hash-of-file'] for all files found
+     * in the iterator.
+     *
+     * @param \RecursiveIteratorIterator $iterator
+     * @param string $path
+     * @return array Array of hashes.
+     */
+    private function generateHashes(\RecursiveIteratorIterator $iterator,
+        string $path): array {
+        $hashes = [];
+
+        $baseDirectoryLength = \strlen($path);
+        foreach ($iterator as $filename => $data) {
+            /** @var \DirectoryIterator $data */
+            if ($data->isDir()) {
+                continue;
+            }
+
+            $relativeFileName = substr($filename, $baseDirectoryLength);
+            $relativeFileName = ltrim($relativeFileName, '/');
+
+            // Exclude signature.json files in the appinfo and root folder
+            if ($relativeFileName === 'appinfo/signature.json') {
+                continue;
+            }
+            // Exclude signature.json files in the appinfo and core folder
+            if ($relativeFileName === 'core/signature.json') {
+                continue;
+            }
+
+            // The .htaccess file in the root folder of ownCloud can contain
+            // custom content after the installation due to the fact that dynamic
+            // content is written into it at installation time as well. This
+            // includes for example the 404 and 403 instructions.
+            // Thus we ignore everything below the first occurrence of
+            // "#### DO NOT CHANGE ANYTHING ABOVE THIS LINE ####" and have the
+            // hash generated based on this.
+            if ($filename === $this->environmentHelper->getServerRoot() . '/.htaccess') {
+                $fileContent = file_get_contents($filename);
+                $explodedArray = explode('#### DO NOT CHANGE ANYTHING ABOVE THIS LINE ####', $fileContent);
+                if (\count($explodedArray) === 2) {
+                    $hashes[$relativeFileName] = hash('sha512', $explodedArray[0]);
+                    continue;
+                }
+            }
+            if ($filename === $this->environmentHelper->getServerRoot() . '/core/js/mimetypelist.js') {
+                $oldMimetypeList = new GenerateMimetypeFileBuilder();
+                $newFile = $oldMimetypeList->generateFile($this->mimeTypeDetector->getAllAliases(), $this->mimeTypeDetector->getAllNamings());
+                $oldFile = $this->fileAccessHelper->file_get_contents($filename);
+                if ($newFile === $oldFile) {
+                    $hashes[$relativeFileName] = hash('sha512', $oldMimetypeList->generateFile($this->mimeTypeDetector->getOnlyDefaultAliases(), $this->mimeTypeDetector->getAllNamings()));
+                    continue;
+                }
+            }
+
+            $hashes[$relativeFileName] = hash_file('sha512', $filename);
+        }
+
+        return $hashes;
+    }
+
+    /**
+     * Creates the signature data
+     *
+     * @param array $hashes
+     * @param X509 $certificate
+     * @param RSA $privateKey
+     * @return array
+     */
+    private function createSignatureData(array $hashes,
+        X509 $certificate,
+        RSA $privateKey): array {
+        ksort($hashes);
+
+        $privateKey->setSignatureMode(RSA::SIGNATURE_PSS);
+        $privateKey->setMGFHash('sha512');
+        // See https://tools.ietf.org/html/rfc3447#page-38
+        $privateKey->setSaltLength(0);
+        $signature = $privateKey->sign(json_encode($hashes));
+
+        return [
+            'hashes' => $hashes,
+            'signature' => base64_encode($signature),
+            'certificate' => $certificate->saveX509($certificate->currentCert),
+        ];
+    }
+
+    /**
+     * Write the signature of the app in the specified folder
+     *
+     * @param string $path
+     * @param X509 $certificate
+     * @param RSA $privateKey
+     * @throws \Exception
+     */
+    public function writeAppSignature($path,
+        X509 $certificate,
+        RSA $privateKey) {
+        $appInfoDir = $path . '/appinfo';
+        try {
+            $this->fileAccessHelper->assertDirectoryExists($appInfoDir);
+
+            $iterator = $this->getFolderIterator($path);
+            $hashes = $this->generateHashes($iterator, $path);
+            $signature = $this->createSignatureData($hashes, $certificate, $privateKey);
+            $this->fileAccessHelper->file_put_contents(
+                $appInfoDir . '/signature.json',
+                json_encode($signature, JSON_PRETTY_PRINT)
+            );
+        } catch (\Exception $e) {
+            if (!$this->fileAccessHelper->is_writable($appInfoDir)) {
+                throw new \Exception($appInfoDir . ' is not writable');
+            }
+            throw $e;
+        }
+    }
+
+    /**
+     * Write the signature of core
+     *
+     * @param X509 $certificate
+     * @param RSA $rsa
+     * @param string $path
+     * @throws \Exception
+     */
+    public function writeCoreSignature(X509 $certificate,
+        RSA $rsa,
+        $path) {
+        $coreDir = $path . '/core';
+        try {
+            $this->fileAccessHelper->assertDirectoryExists($coreDir);
+            $iterator = $this->getFolderIterator($path, $path);
+            $hashes = $this->generateHashes($iterator, $path);
+            $signatureData = $this->createSignatureData($hashes, $certificate, $rsa);
+            $this->fileAccessHelper->file_put_contents(
+                $coreDir . '/signature.json',
+                json_encode($signatureData, JSON_PRETTY_PRINT)
+            );
+        } catch (\Exception $e) {
+            if (!$this->fileAccessHelper->is_writable($coreDir)) {
+                throw new \Exception($coreDir . ' is not writable');
+            }
+            throw $e;
+        }
+    }
+
+    /**
+     * Split the certificate file in individual certs
+     *
+     * @param string $cert
+     * @return string[]
+     */
+    private function splitCerts(string $cert): array {
+        preg_match_all('([\-]{3,}[\S\ ]+?[\-]{3,}[\S\s]+?[\-]{3,}[\S\ ]+?[\-]{3,})', $cert, $matches);
+
+        return $matches[0];
+    }
+
+    /**
+     * Verifies the signature for the specified path.
+     *
+     * @param string $signaturePath
+     * @param string $basePath
+     * @param string $certificateCN
+     * @param bool $forceVerify
+     * @return array
+     * @throws InvalidSignatureException
+     * @throws \Exception
+     */
+    private function verify(string $signaturePath, string $basePath, string $certificateCN, bool $forceVerify = false): array {
+        if (!$forceVerify && !$this->isCodeCheckEnforced()) {
+            return [];
+        }
+
+        $content = $this->fileAccessHelper->file_get_contents($signaturePath);
+        $signatureData = null;
+
+        if (\is_string($content)) {
+            $signatureData = json_decode($content, true);
+        }
+        if (!\is_array($signatureData)) {
+            throw new InvalidSignatureException('Signature data not found.');
+        }
+
+        $expectedHashes = $signatureData['hashes'];
+        ksort($expectedHashes);
+        $signature = base64_decode($signatureData['signature']);
+        $certificate = $signatureData['certificate'];
+
+        // Check if certificate is signed by Nextcloud Root Authority
+        $x509 = new \phpseclib\File\X509();
+        $rootCertificatePublicKey = $this->fileAccessHelper->file_get_contents($this->environmentHelper->getServerRoot() . '/resources/codesigning/root.crt');
+
+        $rootCerts = $this->splitCerts($rootCertificatePublicKey);
+        foreach ($rootCerts as $rootCert) {
+            $x509->loadCA($rootCert);
+        }
+        $x509->loadX509($certificate);
+        if (!$x509->validateSignature()) {
+            throw new InvalidSignatureException('Certificate is not valid.');
+        }
+        // Verify if certificate has proper CN. "core" CN is always trusted.
+        if ($x509->getDN(X509::DN_OPENSSL)['CN'] !== $certificateCN && $x509->getDN(X509::DN_OPENSSL)['CN'] !== 'core') {
+            throw new InvalidSignatureException(
+                sprintf('Certificate is not valid for required scope. (Requested: %s, current: CN=%s)', $certificateCN, $x509->getDN(true)['CN'])
+            );
+        }
+
+        // Check if the signature of the files is valid
+        $rsa = new \phpseclib\Crypt\RSA();
+        $rsa->loadKey($x509->currentCert['tbsCertificate']['subjectPublicKeyInfo']['subjectPublicKey']);
+        $rsa->setSignatureMode(RSA::SIGNATURE_PSS);
+        $rsa->setMGFHash('sha512');
+        // See https://tools.ietf.org/html/rfc3447#page-38
+        $rsa->setSaltLength(0);
+        if (!$rsa->verify(json_encode($expectedHashes), $signature)) {
+            throw new InvalidSignatureException('Signature could not get verified.');
+        }
+
+        // Fixes for the updater as shipped with ownCloud 9.0.x: The updater is
+        // replaced after the code integrity check is performed.
+        //
+        // Due to this reason we exclude the whole updater/ folder from the code
+        // integrity check.
+        if ($basePath === $this->environmentHelper->getServerRoot()) {
+            foreach ($expectedHashes as $fileName => $hash) {
+                if (str_starts_with($fileName, 'updater/')) {
+                    unset($expectedHashes[$fileName]);
+                }
+            }
+        }
+
+        // Compare the list of files which are not identical
+        $currentInstanceHashes = $this->generateHashes($this->getFolderIterator($basePath), $basePath);
+        $differencesA = array_diff_assoc($expectedHashes, $currentInstanceHashes);
+        $differencesB = array_diff_assoc($currentInstanceHashes, $expectedHashes);
+        $differences = array_unique(array_merge($differencesA, $differencesB));
+        $differenceArray = [];
+        foreach ($differences as $filename => $hash) {
+            // Check if file should not exist in the new signature table
+            if (!array_key_exists($filename, $expectedHashes)) {
+                $differenceArray['EXTRA_FILE'][$filename]['expected'] = '';
+                $differenceArray['EXTRA_FILE'][$filename]['current'] = $hash;
+                continue;
+            }
+
+            // Check if file is missing
+            if (!array_key_exists($filename, $currentInstanceHashes)) {
+                $differenceArray['FILE_MISSING'][$filename]['expected'] = $expectedHashes[$filename];
+                $differenceArray['FILE_MISSING'][$filename]['current'] = '';
+                continue;
+            }
+
+            // Check if hash does mismatch
+            if ($expectedHashes[$filename] !== $currentInstanceHashes[$filename]) {
+                $differenceArray['INVALID_HASH'][$filename]['expected'] = $expectedHashes[$filename];
+                $differenceArray['INVALID_HASH'][$filename]['current'] = $currentInstanceHashes[$filename];
+                continue;
+            }
+
+            // Should never happen.
+            throw new \Exception('Invalid behaviour in file hash comparison experienced. Please report this error to the developers.');
+        }
+
+        return $differenceArray;
+    }
+
+    /**
+     * Whether the code integrity check has passed successful or not
+     *
+     * @return bool
+     */
+    public function hasPassedCheck(): bool {
+        $results = $this->getResults();
+        if ($results !== null && empty($results)) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * @return array|null Either the results or null if no results available
+     */
+    public function getResults(): ?array {
+        $cachedResults = $this->cache->get(self::CACHE_KEY);
+        if (!\is_null($cachedResults) && $cachedResults !== false) {
+            return json_decode($cachedResults, true);
+        }
+
+        if ($this->appConfig?->hasKey('core', self::CACHE_KEY, lazy: true)) {
+            return $this->appConfig->getValueArray('core', self::CACHE_KEY, lazy: true);
+        }
+
+        // No results available
+        return null;
+    }
+
+    /**
+     * Stores the results in the app config as well as cache
+     *
+     * @param string $scope
+     * @param array $result
+     */
+    private function storeResults(string $scope, array $result) {
+        $resultArray = $this->getResults() ?? [];
+        unset($resultArray[$scope]);
+        if (!empty($result)) {
+            $resultArray[$scope] = $result;
+        }
+        $this->appConfig?->setValueArray('core', self::CACHE_KEY, $resultArray, lazy: true);
+        $this->cache->set(self::CACHE_KEY, json_encode($resultArray));
+    }
+
+    /**
+     *
+     * Clean previous results for a proper rescanning. Otherwise
+     */
+    private function cleanResults() {
+        $this->appConfig->deleteKey('core', self::CACHE_KEY);
+        $this->cache->remove(self::CACHE_KEY);
+    }
+
+    /**
+     * Verify the signature of $appId. Returns an array with the following content:
+     * [
+     * 	'FILE_MISSING' =>
+     * 	[
+     * 		'filename' => [
+     * 			'expected' => 'expectedSHA512',
+     * 			'current' => 'currentSHA512',
+     * 		],
+     * 	],
+     * 	'EXTRA_FILE' =>
+     * 	[
+     * 		'filename' => [
+     * 			'expected' => 'expectedSHA512',
+     * 			'current' => 'currentSHA512',
+     * 		],
+     * 	],
+     * 	'INVALID_HASH' =>
+     * 	[
+     * 		'filename' => [
+     * 			'expected' => 'expectedSHA512',
+     * 			'current' => 'currentSHA512',
+     * 		],
+     * 	],
+     * ]
+     *
+     * Array may be empty in case no problems have been found.
+     *
+     * @param string $appId
+     * @param string $path Optional path. If none is given it will be guessed.
+     * @param bool $forceVerify
+     * @return array
+     */
+    public function verifyAppSignature(string $appId, string $path = '', bool $forceVerify = false): array {
+        try {
+            if ($path === '') {
+                $path = $this->appManager->getAppPath($appId);
+            }
+            $result = $this->verify(
+                $path . '/appinfo/signature.json',
+                $path,
+                $appId,
+                $forceVerify
+            );
+        } catch (\Exception $e) {
+            $result = [
+                'EXCEPTION' => [
+                    'class' => \get_class($e),
+                    'message' => $e->getMessage(),
+                ],
+            ];
+        }
+        $this->storeResults($appId, $result);
+
+        return $result;
+    }
+
+    /**
+     * Verify the signature of core. Returns an array with the following content:
+     * [
+     * 	'FILE_MISSING' =>
+     * 	[
+     * 		'filename' => [
+     * 			'expected' => 'expectedSHA512',
+     * 			'current' => 'currentSHA512',
+     * 		],
+     * 	],
+     * 	'EXTRA_FILE' =>
+     * 	[
+     * 		'filename' => [
+     * 			'expected' => 'expectedSHA512',
+     * 			'current' => 'currentSHA512',
+     * 		],
+     * 	],
+     * 	'INVALID_HASH' =>
+     * 	[
+     * 		'filename' => [
+     * 			'expected' => 'expectedSHA512',
+     * 			'current' => 'currentSHA512',
+     * 		],
+     * 	],
+     * ]
+     *
+     * Array may be empty in case no problems have been found.
+     *
+     * @return array
+     */
+    public function verifyCoreSignature(): array {
+        try {
+            $result = $this->verify(
+                $this->environmentHelper->getServerRoot() . '/core/signature.json',
+                $this->environmentHelper->getServerRoot(),
+                'core'
+            );
+        } catch (\Exception $e) {
+            $result = [
+                'EXCEPTION' => [
+                    'class' => \get_class($e),
+                    'message' => $e->getMessage(),
+                ],
+            ];
+        }
+        $this->storeResults('core', $result);
+
+        return $result;
+    }
+
+    /**
+     * Verify the core code of the instance as well as all applicable applications
+     * and store the results.
+     */
+    public function runInstanceVerification() {
+        $this->cleanResults();
+        $this->verifyCoreSignature();
+        $appIds = $this->appManager->getAllAppsInAppsFolders();
+        foreach ($appIds as $appId) {
+            // If an application is shipped a valid signature is required
+            $isShipped = $this->appManager->isShipped($appId);
+            $appNeedsToBeChecked = false;
+            if ($isShipped) {
+                $appNeedsToBeChecked = true;
+            } elseif ($this->fileAccessHelper->file_exists($this->appManager->getAppPath($appId) . '/appinfo/signature.json')) {
+                // Otherwise only if the application explicitly ships a signature.json file
+                $appNeedsToBeChecked = true;
+            }
+
+            if ($appNeedsToBeChecked) {
+                $this->verifyAppSignature($appId);
+            }
+        }
+    }
 }

lib/private/Hooks/EmitterTrait.php

Indentation +75 added lines, -75 removed lines

@@ -11,83 +11,83 @@
  * @deprecated 18.0.0 use events and the \OCP\EventDispatcher\IEventDispatcher service
  */
 trait EmitterTrait {
-	/**
-	 * @var callable[][] $listeners
-	 */
-	protected $listeners = [];
+    /**
+     * @var callable[][] $listeners
+     */
+    protected $listeners = [];
 
-	/**
-	 * @param string $scope
-	 * @param string $method
-	 * @param callable $callback
-	 * @deprecated 18.0.0 use \OCP\EventDispatcher\IEventDispatcher::addListener
-	 */
-	public function listen($scope, $method, callable $callback) {
-		$eventName = $scope . '::' . $method;
-		if (!isset($this->listeners[$eventName])) {
-			$this->listeners[$eventName] = [];
-		}
-		if (!in_array($callback, $this->listeners[$eventName], true)) {
-			$this->listeners[$eventName][] = $callback;
-		}
-	}
+    /**
+     * @param string $scope
+     * @param string $method
+     * @param callable $callback
+     * @deprecated 18.0.0 use \OCP\EventDispatcher\IEventDispatcher::addListener
+     */
+    public function listen($scope, $method, callable $callback) {
+        $eventName = $scope . '::' . $method;
+        if (!isset($this->listeners[$eventName])) {
+            $this->listeners[$eventName] = [];
+        }
+        if (!in_array($callback, $this->listeners[$eventName], true)) {
+            $this->listeners[$eventName][] = $callback;
+        }
+    }
 
-	/**
-	 * @param string $scope optional
-	 * @param string $method optional
-	 * @param callable $callback optional
-	 * @deprecated 18.0.0 use \OCP\EventDispatcher\IEventDispatcher::removeListener
-	 */
-	public function removeListener($scope = null, $method = null, ?callable $callback = null) {
-		$names = [];
-		$allNames = array_keys($this->listeners);
-		if ($scope && $method) {
-			$name = $scope . '::' . $method;
-			if (isset($this->listeners[$name])) {
-				$names[] = $name;
-			}
-		} elseif ($scope) {
-			foreach ($allNames as $name) {
-				$parts = explode('::', $name, 2);
-				if ($parts[0] == $scope) {
-					$names[] = $name;
-				}
-			}
-		} elseif ($method) {
-			foreach ($allNames as $name) {
-				$parts = explode('::', $name, 2);
-				if ($parts[1] == $method) {
-					$names[] = $name;
-				}
-			}
-		} else {
-			$names = $allNames;
-		}
+    /**
+     * @param string $scope optional
+     * @param string $method optional
+     * @param callable $callback optional
+     * @deprecated 18.0.0 use \OCP\EventDispatcher\IEventDispatcher::removeListener
+     */
+    public function removeListener($scope = null, $method = null, ?callable $callback = null) {
+        $names = [];
+        $allNames = array_keys($this->listeners);
+        if ($scope && $method) {
+            $name = $scope . '::' . $method;
+            if (isset($this->listeners[$name])) {
+                $names[] = $name;
+            }
+        } elseif ($scope) {
+            foreach ($allNames as $name) {
+                $parts = explode('::', $name, 2);
+                if ($parts[0] == $scope) {
+                    $names[] = $name;
+                }
+            }
+        } elseif ($method) {
+            foreach ($allNames as $name) {
+                $parts = explode('::', $name, 2);
+                if ($parts[1] == $method) {
+                    $names[] = $name;
+                }
+            }
+        } else {
+            $names = $allNames;
+        }
 
-		foreach ($names as $name) {
-			if ($callback) {
-				$index = array_search($callback, $this->listeners[$name], true);
-				if ($index !== false) {
-					unset($this->listeners[$name][$index]);
-				}
-			} else {
-				$this->listeners[$name] = [];
-			}
-		}
-	}
+        foreach ($names as $name) {
+            if ($callback) {
+                $index = array_search($callback, $this->listeners[$name], true);
+                if ($index !== false) {
+                    unset($this->listeners[$name][$index]);
+                }
+            } else {
+                $this->listeners[$name] = [];
+            }
+        }
+    }
 
-	/**
-	 * @param string $scope
-	 * @param string $method
-	 * @param array $arguments optional
-	 * @deprecated 18.0.0 use \OCP\EventDispatcher\IEventDispatcher::dispatchTyped
-	 */
-	protected function emit($scope, $method, array $arguments = []) {
-		$eventName = $scope . '::' . $method;
-		if (isset($this->listeners[$eventName])) {
-			foreach ($this->listeners[$eventName] as $callback) {
-				call_user_func_array($callback, $arguments);
-			}
-		}
-	}
+    /**
+     * @param string $scope
+     * @param string $method
+     * @param array $arguments optional
+     * @deprecated 18.0.0 use \OCP\EventDispatcher\IEventDispatcher::dispatchTyped
+     */
+    protected function emit($scope, $method, array $arguments = []) {
+        $eventName = $scope . '::' . $method;
+        if (isset($this->listeners[$eventName])) {
+            foreach ($this->listeners[$eventName] as $callback) {
+                call_user_func_array($callback, $arguments);
+            }
+        }
+    }
 }

Spacing +3 added lines, -3 removed lines

@@ -23,7 +23,7 @@ 
 	 * @deprecated 18.0.0 use \OCP\EventDispatcher\IEventDispatcher::addListener
 	 */
 	public function listen($scope, $method, callable $callback) {
-		$eventName = $scope . '::' . $method;
+		$eventName = $scope.'::'.$method;
 		if (!isset($this->listeners[$eventName])) {
 			$this->listeners[$eventName] = [];
 		}
@@ -42,7 +42,7 @@ 
 		$names = [];
 		$allNames = array_keys($this->listeners);
 		if ($scope && $method) {
-			$name = $scope . '::' . $method;
+			$name = $scope.'::'.$method;
 			if (isset($this->listeners[$name])) {
 				$names[] = $name;
 			}
@@ -83,7 +83,7 @@ 
 	 * @deprecated 18.0.0 use \OCP\EventDispatcher\IEventDispatcher::dispatchTyped
 	 */
 	protected function emit($scope, $method, array $arguments = []) {
-		$eventName = $scope . '::' . $method;
+		$eventName = $scope.'::'.$method;
 		if (isset($this->listeners[$eventName])) {
 			foreach ($this->listeners[$eventName] as $callback) {
 				call_user_func_array($callback, $arguments);

lib/private/Memcache/APCu.php

Indentation +99 added lines, -99 removed lines

@@ -11,114 +11,114 @@
 use OCP\IMemcache;
 
 class APCu extends Cache implements IMemcache {
-	use CASTrait {
-		cas as casEmulated;
-	}
+    use CASTrait {
+        cas as casEmulated;
+    }
 
-	use CADTrait;
+    use CADTrait;
 
-	public function get($key) {
-		$result = apcu_fetch($this->getPrefix() . $key, $success);
-		if (!$success) {
-			return null;
-		}
-		return $result;
-	}
+    public function get($key) {
+        $result = apcu_fetch($this->getPrefix() . $key, $success);
+        if (!$success) {
+            return null;
+        }
+        return $result;
+    }
 
-	public function set($key, $value, $ttl = 0) {
-		if ($ttl === 0) {
-			$ttl = self::DEFAULT_TTL;
-		}
-		return apcu_store($this->getPrefix() . $key, $value, $ttl);
-	}
+    public function set($key, $value, $ttl = 0) {
+        if ($ttl === 0) {
+            $ttl = self::DEFAULT_TTL;
+        }
+        return apcu_store($this->getPrefix() . $key, $value, $ttl);
+    }
 
-	public function hasKey($key) {
-		return apcu_exists($this->getPrefix() . $key);
-	}
+    public function hasKey($key) {
+        return apcu_exists($this->getPrefix() . $key);
+    }
 
-	public function remove($key) {
-		return apcu_delete($this->getPrefix() . $key);
-	}
+    public function remove($key) {
+        return apcu_delete($this->getPrefix() . $key);
+    }
 
-	public function clear($prefix = '') {
-		$ns = $this->getPrefix() . $prefix;
-		$ns = preg_quote($ns, '/');
-		if (class_exists('\APCIterator')) {
-			$iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY);
-		} else {
-			$iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY);
-		}
-		return apcu_delete($iter);
-	}
+    public function clear($prefix = '') {
+        $ns = $this->getPrefix() . $prefix;
+        $ns = preg_quote($ns, '/');
+        if (class_exists('\APCIterator')) {
+            $iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY);
+        } else {
+            $iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY);
+        }
+        return apcu_delete($iter);
+    }
 
-	/**
-	 * Set a value in the cache if it's not already stored
-	 *
-	 * @param string $key
-	 * @param mixed $value
-	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
-	 * @return bool
-	 */
-	public function add($key, $value, $ttl = 0) {
-		if ($ttl === 0) {
-			$ttl = self::DEFAULT_TTL;
-		}
-		return apcu_add($this->getPrefix() . $key, $value, $ttl);
-	}
+    /**
+     * Set a value in the cache if it's not already stored
+     *
+     * @param string $key
+     * @param mixed $value
+     * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
+     * @return bool
+     */
+    public function add($key, $value, $ttl = 0) {
+        if ($ttl === 0) {
+            $ttl = self::DEFAULT_TTL;
+        }
+        return apcu_add($this->getPrefix() . $key, $value, $ttl);
+    }
 
-	/**
-	 * Increase a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function inc($key, $step = 1) {
-		$success = null;
-		return apcu_inc($this->getPrefix() . $key, $step, $success, self::DEFAULT_TTL);
-	}
+    /**
+     * Increase a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function inc($key, $step = 1) {
+        $success = null;
+        return apcu_inc($this->getPrefix() . $key, $step, $success, self::DEFAULT_TTL);
+    }
 
-	/**
-	 * Decrease a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function dec($key, $step = 1) {
-		return apcu_exists($this->getPrefix() . $key)
-			? apcu_dec($this->getPrefix() . $key, $step)
-			: false;
-	}
+    /**
+     * Decrease a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function dec($key, $step = 1) {
+        return apcu_exists($this->getPrefix() . $key)
+            ? apcu_dec($this->getPrefix() . $key, $step)
+            : false;
+    }
 
-	/**
-	 * Compare and set
-	 *
-	 * @param string $key
-	 * @param mixed $old
-	 * @param mixed $new
-	 * @return bool
-	 */
-	public function cas($key, $old, $new) {
-		// apc only does cas for ints
-		if (is_int($old) && is_int($new)) {
-			return apcu_cas($this->getPrefix() . $key, $old, $new);
-		} else {
-			return $this->casEmulated($key, $old, $new);
-		}
-	}
+    /**
+     * Compare and set
+     *
+     * @param string $key
+     * @param mixed $old
+     * @param mixed $new
+     * @return bool
+     */
+    public function cas($key, $old, $new) {
+        // apc only does cas for ints
+        if (is_int($old) && is_int($new)) {
+            return apcu_cas($this->getPrefix() . $key, $old, $new);
+        } else {
+            return $this->casEmulated($key, $old, $new);
+        }
+    }
 
-	public static function isAvailable(): bool {
-		if (!extension_loaded('apcu')) {
-			return false;
-		} elseif (!\OC::$server->get(IniGetWrapper::class)->getBool('apc.enabled')) {
-			return false;
-		} elseif (!\OC::$server->get(IniGetWrapper::class)->getBool('apc.enable_cli') && \OC::$CLI) {
-			return false;
-		} elseif (version_compare(phpversion('apcu') ?: '0.0.0', '5.1.0') === -1) {
-			return false;
-		} else {
-			return true;
-		}
-	}
+    public static function isAvailable(): bool {
+        if (!extension_loaded('apcu')) {
+            return false;
+        } elseif (!\OC::$server->get(IniGetWrapper::class)->getBool('apc.enabled')) {
+            return false;
+        } elseif (!\OC::$server->get(IniGetWrapper::class)->getBool('apc.enable_cli') && \OC::$CLI) {
+            return false;
+        } elseif (version_compare(phpversion('apcu') ?: '0.0.0', '5.1.0') === -1) {
+            return false;
+        } else {
+            return true;
+        }
+    }
 }

Spacing +12 added lines, -12 removed lines

@@ -18,7 +18,7 @@ 
 	use CADTrait;
 
 	public function get($key) {
-		$result = apcu_fetch($this->getPrefix() . $key, $success);
+		$result = apcu_fetch($this->getPrefix().$key, $success);
 		if (!$success) {
 			return null;
 		}
@@ -29,24 +29,24 @@ 
 		if ($ttl === 0) {
 			$ttl = self::DEFAULT_TTL;
 		}
-		return apcu_store($this->getPrefix() . $key, $value, $ttl);
+		return apcu_store($this->getPrefix().$key, $value, $ttl);
 	}
 
 	public function hasKey($key) {
-		return apcu_exists($this->getPrefix() . $key);
+		return apcu_exists($this->getPrefix().$key);
 	}
 
 	public function remove($key) {
-		return apcu_delete($this->getPrefix() . $key);
+		return apcu_delete($this->getPrefix().$key);
 	}
 
 	public function clear($prefix = '') {
-		$ns = $this->getPrefix() . $prefix;
+		$ns = $this->getPrefix().$prefix;
 		$ns = preg_quote($ns, '/');
 		if (class_exists('\APCIterator')) {
-			$iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY);
+			$iter = new \APCIterator('user', '/^'.$ns.'/', APC_ITER_KEY);
 		} else {
-			$iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY);
+			$iter = new \APCUIterator('/^'.$ns.'/', APC_ITER_KEY);
 		}
 		return apcu_delete($iter);
 	}
@@ -63,7 +63,7 @@ 
 		if ($ttl === 0) {
 			$ttl = self::DEFAULT_TTL;
 		}
-		return apcu_add($this->getPrefix() . $key, $value, $ttl);
+		return apcu_add($this->getPrefix().$key, $value, $ttl);
 	}
 
 	/**
@@ -75,7 +75,7 @@ 
 	 */
 	public function inc($key, $step = 1) {
 		$success = null;
-		return apcu_inc($this->getPrefix() . $key, $step, $success, self::DEFAULT_TTL);
+		return apcu_inc($this->getPrefix().$key, $step, $success, self::DEFAULT_TTL);
 	}
 
 	/**
@@ -86,8 +86,8 @@ 
 	 * @return int | bool
 	 */
 	public function dec($key, $step = 1) {
-		return apcu_exists($this->getPrefix() . $key)
-			? apcu_dec($this->getPrefix() . $key, $step)
+		return apcu_exists($this->getPrefix().$key)
+			? apcu_dec($this->getPrefix().$key, $step)
 			: false;
 	}
 
@@ -102,7 +102,7 @@ 
 	public function cas($key, $old, $new) {
 		// apc only does cas for ints
 		if (is_int($old) && is_int($new)) {
-			return apcu_cas($this->getPrefix() . $key, $old, $new);
+			return apcu_cas($this->getPrefix().$key, $old, $new);
 		} else {
 			return $this->casEmulated($key, $old, $new);
 		}

lib/private/Memcache/Memcached.php

Indentation +158 added lines, -158 removed lines

@@ -11,162 +11,162 @@
 use OCP\IMemcache;
 
 class Memcached extends Cache implements IMemcache {
-	use CASTrait;
-
-	/**
-	 * @var \Memcached $cache
-	 */
-	private static $cache = null;
-
-	use CADTrait;
-
-	public function __construct($prefix = '') {
-		parent::__construct($prefix);
-		if (is_null(self::$cache)) {
-			self::$cache = new \Memcached();
-
-			$defaultOptions = [
-				\Memcached::OPT_CONNECT_TIMEOUT => 50,
-				\Memcached::OPT_RETRY_TIMEOUT => 50,
-				\Memcached::OPT_SEND_TIMEOUT => 50,
-				\Memcached::OPT_RECV_TIMEOUT => 50,
-				\Memcached::OPT_POLL_TIMEOUT => 50,
-
-				// Enable compression
-				\Memcached::OPT_COMPRESSION => true,
-
-				// Turn on consistent hashing
-				\Memcached::OPT_LIBKETAMA_COMPATIBLE => true,
-
-				// Enable Binary Protocol
-				\Memcached::OPT_BINARY_PROTOCOL => true,
-			];
-			/**
-			 * By default enable igbinary serializer if available
-			 *
-			 * Psalm checks depend on if igbinary is installed or not with memcached
-			 * @psalm-suppress RedundantCondition
-			 * @psalm-suppress TypeDoesNotContainType
-			 */
-			if (\Memcached::HAVE_IGBINARY) {
-				$defaultOptions[\Memcached::OPT_SERIALIZER]
-					= \Memcached::SERIALIZER_IGBINARY;
-			}
-			$options = \OC::$server->getConfig()->getSystemValue('memcached_options', []);
-			if (is_array($options)) {
-				$options = $options + $defaultOptions;
-				self::$cache->setOptions($options);
-			} else {
-				throw new HintException("Expected 'memcached_options' config to be an array, got $options");
-			}
-
-			$servers = \OC::$server->getSystemConfig()->getValue('memcached_servers');
-			if (!$servers) {
-				$server = \OC::$server->getSystemConfig()->getValue('memcached_server');
-				if ($server) {
-					$servers = [$server];
-				} else {
-					$servers = [['localhost', 11211]];
-				}
-			}
-			self::$cache->addServers($servers);
-		}
-	}
-
-	/**
-	 * entries in XCache gets namespaced to prevent collisions between owncloud instances and users
-	 */
-	protected function getNameSpace() {
-		return $this->prefix;
-	}
-
-	public function get($key) {
-		$result = self::$cache->get($this->getNameSpace() . $key);
-		if ($result === false && self::$cache->getResultCode() === \Memcached::RES_NOTFOUND) {
-			return null;
-		} else {
-			return $result;
-		}
-	}
-
-	public function set($key, $value, $ttl = 0) {
-		if ($ttl > 0) {
-			$result = self::$cache->set($this->getNameSpace() . $key, $value, $ttl);
-		} else {
-			$result = self::$cache->set($this->getNameSpace() . $key, $value);
-		}
-		return $result || $this->isSuccess();
-	}
-
-	public function hasKey($key) {
-		self::$cache->get($this->getNameSpace() . $key);
-		return self::$cache->getResultCode() === \Memcached::RES_SUCCESS;
-	}
-
-	public function remove($key) {
-		$result = self::$cache->delete($this->getNameSpace() . $key);
-		return $result || $this->isSuccess() || self::$cache->getResultCode() === \Memcached::RES_NOTFOUND;
-	}
-
-	public function clear($prefix = '') {
-		// Newer Memcached doesn't like getAllKeys(), flush everything
-		self::$cache->flush();
-		return true;
-	}
-
-	/**
-	 * Set a value in the cache if it's not already stored
-	 *
-	 * @param string $key
-	 * @param mixed $value
-	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
-	 * @return bool
-	 */
-	public function add($key, $value, $ttl = 0) {
-		$result = self::$cache->add($this->getPrefix() . $key, $value, $ttl);
-		return $result || $this->isSuccess();
-	}
-
-	/**
-	 * Increase a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function inc($key, $step = 1) {
-		$this->add($key, 0);
-		$result = self::$cache->increment($this->getPrefix() . $key, $step);
-
-		if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
-			return false;
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Decrease a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function dec($key, $step = 1) {
-		$result = self::$cache->decrement($this->getPrefix() . $key, $step);
-
-		if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
-			return false;
-		}
-
-		return $result;
-	}
-
-	public static function isAvailable(): bool {
-		return extension_loaded('memcached');
-	}
-
-	private function isSuccess(): bool {
-		return self::$cache->getResultCode() === \Memcached::RES_SUCCESS;
-	}
+    use CASTrait;
+
+    /**
+     * @var \Memcached $cache
+     */
+    private static $cache = null;
+
+    use CADTrait;
+
+    public function __construct($prefix = '') {
+        parent::__construct($prefix);
+        if (is_null(self::$cache)) {
+            self::$cache = new \Memcached();
+
+            $defaultOptions = [
+                \Memcached::OPT_CONNECT_TIMEOUT => 50,
+                \Memcached::OPT_RETRY_TIMEOUT => 50,
+                \Memcached::OPT_SEND_TIMEOUT => 50,
+                \Memcached::OPT_RECV_TIMEOUT => 50,
+                \Memcached::OPT_POLL_TIMEOUT => 50,
+
+                // Enable compression
+                \Memcached::OPT_COMPRESSION => true,
+
+                // Turn on consistent hashing
+                \Memcached::OPT_LIBKETAMA_COMPATIBLE => true,
+
+                // Enable Binary Protocol
+                \Memcached::OPT_BINARY_PROTOCOL => true,
+            ];
+            /**
+             * By default enable igbinary serializer if available
+             *
+             * Psalm checks depend on if igbinary is installed or not with memcached
+             * @psalm-suppress RedundantCondition
+             * @psalm-suppress TypeDoesNotContainType
+             */
+            if (\Memcached::HAVE_IGBINARY) {
+                $defaultOptions[\Memcached::OPT_SERIALIZER]
+                    = \Memcached::SERIALIZER_IGBINARY;
+            }
+            $options = \OC::$server->getConfig()->getSystemValue('memcached_options', []);
+            if (is_array($options)) {
+                $options = $options + $defaultOptions;
+                self::$cache->setOptions($options);
+            } else {
+                throw new HintException("Expected 'memcached_options' config to be an array, got $options");
+            }
+
+            $servers = \OC::$server->getSystemConfig()->getValue('memcached_servers');
+            if (!$servers) {
+                $server = \OC::$server->getSystemConfig()->getValue('memcached_server');
+                if ($server) {
+                    $servers = [$server];
+                } else {
+                    $servers = [['localhost', 11211]];
+                }
+            }
+            self::$cache->addServers($servers);
+        }
+    }
+
+    /**
+     * entries in XCache gets namespaced to prevent collisions between owncloud instances and users
+     */
+    protected function getNameSpace() {
+        return $this->prefix;
+    }
+
+    public function get($key) {
+        $result = self::$cache->get($this->getNameSpace() . $key);
+        if ($result === false && self::$cache->getResultCode() === \Memcached::RES_NOTFOUND) {
+            return null;
+        } else {
+            return $result;
+        }
+    }
+
+    public function set($key, $value, $ttl = 0) {
+        if ($ttl > 0) {
+            $result = self::$cache->set($this->getNameSpace() . $key, $value, $ttl);
+        } else {
+            $result = self::$cache->set($this->getNameSpace() . $key, $value);
+        }
+        return $result || $this->isSuccess();
+    }
+
+    public function hasKey($key) {
+        self::$cache->get($this->getNameSpace() . $key);
+        return self::$cache->getResultCode() === \Memcached::RES_SUCCESS;
+    }
+
+    public function remove($key) {
+        $result = self::$cache->delete($this->getNameSpace() . $key);
+        return $result || $this->isSuccess() || self::$cache->getResultCode() === \Memcached::RES_NOTFOUND;
+    }
+
+    public function clear($prefix = '') {
+        // Newer Memcached doesn't like getAllKeys(), flush everything
+        self::$cache->flush();
+        return true;
+    }
+
+    /**
+     * Set a value in the cache if it's not already stored
+     *
+     * @param string $key
+     * @param mixed $value
+     * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
+     * @return bool
+     */
+    public function add($key, $value, $ttl = 0) {
+        $result = self::$cache->add($this->getPrefix() . $key, $value, $ttl);
+        return $result || $this->isSuccess();
+    }
+
+    /**
+     * Increase a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function inc($key, $step = 1) {
+        $this->add($key, 0);
+        $result = self::$cache->increment($this->getPrefix() . $key, $step);
+
+        if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
+            return false;
+        }
+
+        return $result;
+    }
+
+    /**
+     * Decrease a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function dec($key, $step = 1) {
+        $result = self::$cache->decrement($this->getPrefix() . $key, $step);
+
+        if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
+            return false;
+        }
+
+        return $result;
+    }
+
+    public static function isAvailable(): bool {
+        return extension_loaded('memcached');
+    }
+
+    private function isSuccess(): bool {
+        return self::$cache->getResultCode() === \Memcached::RES_SUCCESS;
+    }
 }

Spacing +8 added lines, -8 removed lines

@@ -81,7 +81,7 @@ 
 	}
 
 	public function get($key) {
-		$result = self::$cache->get($this->getNameSpace() . $key);
+		$result = self::$cache->get($this->getNameSpace().$key);
 		if ($result === false && self::$cache->getResultCode() === \Memcached::RES_NOTFOUND) {
 			return null;
 		} else {
@@ -91,20 +91,20 @@ 
 
 	public function set($key, $value, $ttl = 0) {
 		if ($ttl > 0) {
-			$result = self::$cache->set($this->getNameSpace() . $key, $value, $ttl);
+			$result = self::$cache->set($this->getNameSpace().$key, $value, $ttl);
 		} else {
-			$result = self::$cache->set($this->getNameSpace() . $key, $value);
+			$result = self::$cache->set($this->getNameSpace().$key, $value);
 		}
 		return $result || $this->isSuccess();
 	}
 
 	public function hasKey($key) {
-		self::$cache->get($this->getNameSpace() . $key);
+		self::$cache->get($this->getNameSpace().$key);
 		return self::$cache->getResultCode() === \Memcached::RES_SUCCESS;
 	}
 
 	public function remove($key) {
-		$result = self::$cache->delete($this->getNameSpace() . $key);
+		$result = self::$cache->delete($this->getNameSpace().$key);
 		return $result || $this->isSuccess() || self::$cache->getResultCode() === \Memcached::RES_NOTFOUND;
 	}
 
@@ -123,7 +123,7 @@ 
 	 * @return bool
 	 */
 	public function add($key, $value, $ttl = 0) {
-		$result = self::$cache->add($this->getPrefix() . $key, $value, $ttl);
+		$result = self::$cache->add($this->getPrefix().$key, $value, $ttl);
 		return $result || $this->isSuccess();
 	}
 
@@ -136,7 +136,7 @@ 
 	 */
 	public function inc($key, $step = 1) {
 		$this->add($key, 0);
-		$result = self::$cache->increment($this->getPrefix() . $key, $step);
+		$result = self::$cache->increment($this->getPrefix().$key, $step);
 
 		if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
 			return false;
@@ -153,7 +153,7 @@ 
 	 * @return int | bool
 	 */
 	public function dec($key, $step = 1) {
-		$result = self::$cache->decrement($this->getPrefix() . $key, $step);
+		$result = self::$cache->decrement($this->getPrefix().$key, $step);
 
 		if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
 			return false;

lib/private/legacy/OC_Helper.php

Indentation +385 added lines, -385 removed lines

@@ -32,392 +32,392 @@
  * }
  */
 class OC_Helper {
-	private static $templateManager;
-	private static ?ICacheFactory $cacheFactory = null;
-	private static ?bool $quotaIncludeExternalStorage = null;
-
-	/**
-	 * Recursive copying of folders
-	 * @param string $src source folder
-	 * @param string $dest target folder
-	 * @return void
-	 * @deprecated 32.0.0 - use \OCP\Files\Folder::copy
-	 */
-	public static function copyr($src, $dest) {
-		if (!file_exists($src)) {
-			return;
-		}
-
-		if (is_dir($src)) {
-			if (!is_dir($dest)) {
-				mkdir($dest);
-			}
-			$files = scandir($src);
-			foreach ($files as $file) {
-				if ($file != '.' && $file != '..') {
-					self::copyr("$src/$file", "$dest/$file");
-				}
-			}
-		} else {
-			$validator = \OCP\Server::get(FilenameValidator::class);
-			if (!$validator->isForbidden($src)) {
-				copy($src, $dest);
-			}
-		}
-	}
-
-	/**
-	 * @deprecated 18.0.0
-	 * @return \OC\Files\Type\TemplateManager
-	 */
-	public static function getFileTemplateManager() {
-		if (!self::$templateManager) {
-			self::$templateManager = new \OC\Files\Type\TemplateManager();
-		}
-		return self::$templateManager;
-	}
-
-	/**
-	 * detect if a given program is found in the search PATH
-	 *
-	 * @param string $name
-	 * @param bool $path
-	 * @internal param string $program name
-	 * @internal param string $optional search path, defaults to $PATH
-	 * @return bool true if executable program found in path
-	 * @deprecated 32.0.0 use the \OCP\IBinaryFinder
-	 */
-	public static function canExecute($name, $path = false) {
-		// path defaults to PATH from environment if not set
-		if ($path === false) {
-			$path = getenv('PATH');
-		}
-		// we look for an executable file of that name
-		$exts = [''];
-		$check_fn = 'is_executable';
-		// Default check will be done with $path directories :
-		$dirs = explode(PATH_SEPARATOR, (string)$path);
-		// WARNING : We have to check if open_basedir is enabled :
-		$obd = OC::$server->get(IniGetWrapper::class)->getString('open_basedir');
-		if ($obd != 'none') {
-			$obd_values = explode(PATH_SEPARATOR, $obd);
-			if (count($obd_values) > 0 && $obd_values[0]) {
-				// open_basedir is in effect !
-				// We need to check if the program is in one of these dirs :
-				$dirs = $obd_values;
-			}
-		}
-		foreach ($dirs as $dir) {
-			foreach ($exts as $ext) {
-				if ($check_fn("$dir/$name" . $ext)) {
-					return true;
-				}
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * copy the contents of one stream to another
-	 *
-	 * @param resource $source
-	 * @param resource $target
-	 * @return array the number of bytes copied and result
-	 * @deprecated 5.0.0 - Use \OCP\Files::streamCopy
-	 */
-	public static function streamCopy($source, $target) {
-		return \OCP\Files::streamCopy($source, $target, true);
-	}
-
-	/**
-	 * Adds a suffix to the name in case the file exists
-	 *
-	 * @param string $path
-	 * @param string $filename
-	 * @return string
-	 */
-	public static function buildNotExistingFileName($path, $filename) {
-		$view = \OC\Files\Filesystem::getView();
-		return self::buildNotExistingFileNameForView($path, $filename, $view);
-	}
-
-	/**
-	 * Adds a suffix to the name in case the file exists
-	 *
-	 * @param string $path
-	 * @param string $filename
-	 * @return string
-	 */
-	public static function buildNotExistingFileNameForView($path, $filename, \OC\Files\View $view) {
-		if ($path === '/') {
-			$path = '';
-		}
-		if ($pos = strrpos($filename, '.')) {
-			$name = substr($filename, 0, $pos);
-			$ext = substr($filename, $pos);
-		} else {
-			$name = $filename;
-			$ext = '';
-		}
-
-		$newpath = $path . '/' . $filename;
-		if ($view->file_exists($newpath)) {
-			if (preg_match_all('/\((\d+)\)/', $name, $matches, PREG_OFFSET_CAPTURE)) {
-				//Replace the last "(number)" with "(number+1)"
-				$last_match = count($matches[0]) - 1;
-				$counter = $matches[1][$last_match][0] + 1;
-				$offset = $matches[0][$last_match][1];
-				$match_length = strlen($matches[0][$last_match][0]);
-			} else {
-				$counter = 2;
-				$match_length = 0;
-				$offset = false;
-			}
-			do {
-				if ($offset) {
-					//Replace the last "(number)" with "(number+1)"
-					$newname = substr_replace($name, '(' . $counter . ')', $offset, $match_length);
-				} else {
-					$newname = $name . ' (' . $counter . ')';
-				}
-				$newpath = $path . '/' . $newname . $ext;
-				$counter++;
-			} while ($view->file_exists($newpath));
-		}
-
-		return $newpath;
-	}
-
-	/**
-	 * Checks if a function is available
-	 *
-	 * @deprecated 25.0.0 use \OCP\Util::isFunctionEnabled instead
-	 */
-	public static function is_function_enabled(string $function_name): bool {
-		return Util::isFunctionEnabled($function_name);
-	}
-
-	/**
-	 * Try to find a program
-	 * @deprecated 25.0.0 Use \OCP\IBinaryFinder directly
-	 */
-	public static function findBinaryPath(string $program): ?string {
-		$result = Server::get(IBinaryFinder::class)->findBinaryPath($program);
-		return $result !== false ? $result : null;
-	}
-
-	/**
-	 * Calculate the disc space for the given path
-	 *
-	 * BEWARE: this requires that Util::setupFS() was called
-	 * already !
-	 *
-	 * @param string $path
-	 * @param \OCP\Files\FileInfo $rootInfo (optional)
-	 * @param bool $includeMountPoints whether to include mount points in the size calculation
-	 * @param bool $useCache whether to use the cached quota values
-	 * @psalm-suppress LessSpecificReturnStatement Legacy code outputs weird types - manually validated that they are correct
-	 * @return StorageInfo
-	 * @throws \OCP\Files\NotFoundException
-	 */
-	public static function getStorageInfo($path, $rootInfo = null, $includeMountPoints = true, $useCache = true) {
-		if (!self::$cacheFactory) {
-			self::$cacheFactory = Server::get(ICacheFactory::class);
-		}
-		$memcache = self::$cacheFactory->createLocal('storage_info');
-
-		// return storage info without adding mount points
-		if (self::$quotaIncludeExternalStorage === null) {
-			self::$quotaIncludeExternalStorage = \OC::$server->getSystemConfig()->getValue('quota_include_external_storage', false);
-		}
-
-		$view = Filesystem::getView();
-		if (!$view) {
-			throw new \OCP\Files\NotFoundException();
-		}
-		$fullPath = Filesystem::normalizePath($view->getAbsolutePath($path));
-
-		$cacheKey = $fullPath . '::' . ($includeMountPoints ? 'include' : 'exclude');
-		if ($useCache) {
-			$cached = $memcache->get($cacheKey);
-			if ($cached) {
-				return $cached;
-			}
-		}
-
-		if (!$rootInfo) {
-			$rootInfo = \OC\Files\Filesystem::getFileInfo($path, self::$quotaIncludeExternalStorage ? 'ext' : false);
-		}
-		if (!$rootInfo instanceof \OCP\Files\FileInfo) {
-			throw new \OCP\Files\NotFoundException('The root directory of the user\'s files is missing');
-		}
-		$used = $rootInfo->getSize($includeMountPoints);
-		if ($used < 0) {
-			$used = 0.0;
-		}
-		/** @var int|float $quota */
-		$quota = \OCP\Files\FileInfo::SPACE_UNLIMITED;
-		$mount = $rootInfo->getMountPoint();
-		$storage = $mount->getStorage();
-		$sourceStorage = $storage;
-		if ($storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage')) {
-			self::$quotaIncludeExternalStorage = false;
-		}
-		if (self::$quotaIncludeExternalStorage) {
-			if ($storage->instanceOfStorage('\OC\Files\Storage\Home')
-				|| $storage->instanceOfStorage('\OC\Files\ObjectStore\HomeObjectStoreStorage')
-			) {
-				/** @var \OC\Files\Storage\Home $storage */
-				$user = $storage->getUser();
-			} else {
-				$user = \OC::$server->getUserSession()->getUser();
-			}
-			$quota = $user?->getQuotaBytes() ?? \OCP\Files\FileInfo::SPACE_UNKNOWN;
-			if ($quota !== \OCP\Files\FileInfo::SPACE_UNLIMITED) {
-				// always get free space / total space from root + mount points
-				return self::getGlobalStorageInfo($quota, $user, $mount);
-			}
-		}
-
-		// TODO: need a better way to get total space from storage
-		if ($sourceStorage->instanceOfStorage('\OC\Files\Storage\Wrapper\Quota')) {
-			/** @var \OC\Files\Storage\Wrapper\Quota $storage */
-			$quota = $sourceStorage->getQuota();
-		}
-		try {
-			$free = $sourceStorage->free_space($rootInfo->getInternalPath());
-			if (is_bool($free)) {
-				$free = 0.0;
-			}
-		} catch (\Exception $e) {
-			if ($path === '') {
-				throw $e;
-			}
-			/** @var LoggerInterface $logger */
-			$logger = \OC::$server->get(LoggerInterface::class);
-			$logger->warning('Error while getting quota info, using root quota', ['exception' => $e]);
-			$rootInfo = self::getStorageInfo('');
-			$memcache->set($cacheKey, $rootInfo, 5 * 60);
-			return $rootInfo;
-		}
-		if ($free >= 0) {
-			$total = $free + $used;
-		} else {
-			$total = $free; //either unknown or unlimited
-		}
-		if ($total > 0) {
-			if ($quota > 0 && $total > $quota) {
-				$total = $quota;
-			}
-			// prevent division by zero or error codes (negative values)
-			$relative = round(($used / $total) * 10000) / 100;
-		} else {
-			$relative = 0;
-		}
-
-		/*
+    private static $templateManager;
+    private static ?ICacheFactory $cacheFactory = null;
+    private static ?bool $quotaIncludeExternalStorage = null;
+
+    /**
+     * Recursive copying of folders
+     * @param string $src source folder
+     * @param string $dest target folder
+     * @return void
+     * @deprecated 32.0.0 - use \OCP\Files\Folder::copy
+     */
+    public static function copyr($src, $dest) {
+        if (!file_exists($src)) {
+            return;
+        }
+
+        if (is_dir($src)) {
+            if (!is_dir($dest)) {
+                mkdir($dest);
+            }
+            $files = scandir($src);
+            foreach ($files as $file) {
+                if ($file != '.' && $file != '..') {
+                    self::copyr("$src/$file", "$dest/$file");
+                }
+            }
+        } else {
+            $validator = \OCP\Server::get(FilenameValidator::class);
+            if (!$validator->isForbidden($src)) {
+                copy($src, $dest);
+            }
+        }
+    }
+
+    /**
+     * @deprecated 18.0.0
+     * @return \OC\Files\Type\TemplateManager
+     */
+    public static function getFileTemplateManager() {
+        if (!self::$templateManager) {
+            self::$templateManager = new \OC\Files\Type\TemplateManager();
+        }
+        return self::$templateManager;
+    }
+
+    /**
+     * detect if a given program is found in the search PATH
+     *
+     * @param string $name
+     * @param bool $path
+     * @internal param string $program name
+     * @internal param string $optional search path, defaults to $PATH
+     * @return bool true if executable program found in path
+     * @deprecated 32.0.0 use the \OCP\IBinaryFinder
+     */
+    public static function canExecute($name, $path = false) {
+        // path defaults to PATH from environment if not set
+        if ($path === false) {
+            $path = getenv('PATH');
+        }
+        // we look for an executable file of that name
+        $exts = [''];
+        $check_fn = 'is_executable';
+        // Default check will be done with $path directories :
+        $dirs = explode(PATH_SEPARATOR, (string)$path);
+        // WARNING : We have to check if open_basedir is enabled :
+        $obd = OC::$server->get(IniGetWrapper::class)->getString('open_basedir');
+        if ($obd != 'none') {
+            $obd_values = explode(PATH_SEPARATOR, $obd);
+            if (count($obd_values) > 0 && $obd_values[0]) {
+                // open_basedir is in effect !
+                // We need to check if the program is in one of these dirs :
+                $dirs = $obd_values;
+            }
+        }
+        foreach ($dirs as $dir) {
+            foreach ($exts as $ext) {
+                if ($check_fn("$dir/$name" . $ext)) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+
+    /**
+     * copy the contents of one stream to another
+     *
+     * @param resource $source
+     * @param resource $target
+     * @return array the number of bytes copied and result
+     * @deprecated 5.0.0 - Use \OCP\Files::streamCopy
+     */
+    public static function streamCopy($source, $target) {
+        return \OCP\Files::streamCopy($source, $target, true);
+    }
+
+    /**
+     * Adds a suffix to the name in case the file exists
+     *
+     * @param string $path
+     * @param string $filename
+     * @return string
+     */
+    public static function buildNotExistingFileName($path, $filename) {
+        $view = \OC\Files\Filesystem::getView();
+        return self::buildNotExistingFileNameForView($path, $filename, $view);
+    }
+
+    /**
+     * Adds a suffix to the name in case the file exists
+     *
+     * @param string $path
+     * @param string $filename
+     * @return string
+     */
+    public static function buildNotExistingFileNameForView($path, $filename, \OC\Files\View $view) {
+        if ($path === '/') {
+            $path = '';
+        }
+        if ($pos = strrpos($filename, '.')) {
+            $name = substr($filename, 0, $pos);
+            $ext = substr($filename, $pos);
+        } else {
+            $name = $filename;
+            $ext = '';
+        }
+
+        $newpath = $path . '/' . $filename;
+        if ($view->file_exists($newpath)) {
+            if (preg_match_all('/\((\d+)\)/', $name, $matches, PREG_OFFSET_CAPTURE)) {
+                //Replace the last "(number)" with "(number+1)"
+                $last_match = count($matches[0]) - 1;
+                $counter = $matches[1][$last_match][0] + 1;
+                $offset = $matches[0][$last_match][1];
+                $match_length = strlen($matches[0][$last_match][0]);
+            } else {
+                $counter = 2;
+                $match_length = 0;
+                $offset = false;
+            }
+            do {
+                if ($offset) {
+                    //Replace the last "(number)" with "(number+1)"
+                    $newname = substr_replace($name, '(' . $counter . ')', $offset, $match_length);
+                } else {
+                    $newname = $name . ' (' . $counter . ')';
+                }
+                $newpath = $path . '/' . $newname . $ext;
+                $counter++;
+            } while ($view->file_exists($newpath));
+        }
+
+        return $newpath;
+    }
+
+    /**
+     * Checks if a function is available
+     *
+     * @deprecated 25.0.0 use \OCP\Util::isFunctionEnabled instead
+     */
+    public static function is_function_enabled(string $function_name): bool {
+        return Util::isFunctionEnabled($function_name);
+    }
+
+    /**
+     * Try to find a program
+     * @deprecated 25.0.0 Use \OCP\IBinaryFinder directly
+     */
+    public static function findBinaryPath(string $program): ?string {
+        $result = Server::get(IBinaryFinder::class)->findBinaryPath($program);
+        return $result !== false ? $result : null;
+    }
+
+    /**
+     * Calculate the disc space for the given path
+     *
+     * BEWARE: this requires that Util::setupFS() was called
+     * already !
+     *
+     * @param string $path
+     * @param \OCP\Files\FileInfo $rootInfo (optional)
+     * @param bool $includeMountPoints whether to include mount points in the size calculation
+     * @param bool $useCache whether to use the cached quota values
+     * @psalm-suppress LessSpecificReturnStatement Legacy code outputs weird types - manually validated that they are correct
+     * @return StorageInfo
+     * @throws \OCP\Files\NotFoundException
+     */
+    public static function getStorageInfo($path, $rootInfo = null, $includeMountPoints = true, $useCache = true) {
+        if (!self::$cacheFactory) {
+            self::$cacheFactory = Server::get(ICacheFactory::class);
+        }
+        $memcache = self::$cacheFactory->createLocal('storage_info');
+
+        // return storage info without adding mount points
+        if (self::$quotaIncludeExternalStorage === null) {
+            self::$quotaIncludeExternalStorage = \OC::$server->getSystemConfig()->getValue('quota_include_external_storage', false);
+        }
+
+        $view = Filesystem::getView();
+        if (!$view) {
+            throw new \OCP\Files\NotFoundException();
+        }
+        $fullPath = Filesystem::normalizePath($view->getAbsolutePath($path));
+
+        $cacheKey = $fullPath . '::' . ($includeMountPoints ? 'include' : 'exclude');
+        if ($useCache) {
+            $cached = $memcache->get($cacheKey);
+            if ($cached) {
+                return $cached;
+            }
+        }
+
+        if (!$rootInfo) {
+            $rootInfo = \OC\Files\Filesystem::getFileInfo($path, self::$quotaIncludeExternalStorage ? 'ext' : false);
+        }
+        if (!$rootInfo instanceof \OCP\Files\FileInfo) {
+            throw new \OCP\Files\NotFoundException('The root directory of the user\'s files is missing');
+        }
+        $used = $rootInfo->getSize($includeMountPoints);
+        if ($used < 0) {
+            $used = 0.0;
+        }
+        /** @var int|float $quota */
+        $quota = \OCP\Files\FileInfo::SPACE_UNLIMITED;
+        $mount = $rootInfo->getMountPoint();
+        $storage = $mount->getStorage();
+        $sourceStorage = $storage;
+        if ($storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage')) {
+            self::$quotaIncludeExternalStorage = false;
+        }
+        if (self::$quotaIncludeExternalStorage) {
+            if ($storage->instanceOfStorage('\OC\Files\Storage\Home')
+                || $storage->instanceOfStorage('\OC\Files\ObjectStore\HomeObjectStoreStorage')
+            ) {
+                /** @var \OC\Files\Storage\Home $storage */
+                $user = $storage->getUser();
+            } else {
+                $user = \OC::$server->getUserSession()->getUser();
+            }
+            $quota = $user?->getQuotaBytes() ?? \OCP\Files\FileInfo::SPACE_UNKNOWN;
+            if ($quota !== \OCP\Files\FileInfo::SPACE_UNLIMITED) {
+                // always get free space / total space from root + mount points
+                return self::getGlobalStorageInfo($quota, $user, $mount);
+            }
+        }
+
+        // TODO: need a better way to get total space from storage
+        if ($sourceStorage->instanceOfStorage('\OC\Files\Storage\Wrapper\Quota')) {
+            /** @var \OC\Files\Storage\Wrapper\Quota $storage */
+            $quota = $sourceStorage->getQuota();
+        }
+        try {
+            $free = $sourceStorage->free_space($rootInfo->getInternalPath());
+            if (is_bool($free)) {
+                $free = 0.0;
+            }
+        } catch (\Exception $e) {
+            if ($path === '') {
+                throw $e;
+            }
+            /** @var LoggerInterface $logger */
+            $logger = \OC::$server->get(LoggerInterface::class);
+            $logger->warning('Error while getting quota info, using root quota', ['exception' => $e]);
+            $rootInfo = self::getStorageInfo('');
+            $memcache->set($cacheKey, $rootInfo, 5 * 60);
+            return $rootInfo;
+        }
+        if ($free >= 0) {
+            $total = $free + $used;
+        } else {
+            $total = $free; //either unknown or unlimited
+        }
+        if ($total > 0) {
+            if ($quota > 0 && $total > $quota) {
+                $total = $quota;
+            }
+            // prevent division by zero or error codes (negative values)
+            $relative = round(($used / $total) * 10000) / 100;
+        } else {
+            $relative = 0;
+        }
+
+        /*
 		 * \OCA\Files_Sharing\External\Storage returns the cloud ID as the owner for the storage.
 		 * It is unnecessary to query the user manager for the display name, as it won't have this information.
 		 */
-		$isRemoteShare = $storage->instanceOfStorage(\OCA\Files_Sharing\External\Storage::class);
-
-		$ownerId = $storage->getOwner($path);
-		$ownerDisplayName = '';
-
-		if ($isRemoteShare === false && $ownerId !== false) {
-			$ownerDisplayName = \OC::$server->getUserManager()->getDisplayName($ownerId) ?? '';
-		}
-
-		if (substr_count($mount->getMountPoint(), '/') < 3) {
-			$mountPoint = '';
-		} else {
-			[,,,$mountPoint] = explode('/', $mount->getMountPoint(), 4);
-		}
-
-		$info = [
-			'free' => $free,
-			'used' => $used,
-			'quota' => $quota,
-			'total' => $total,
-			'relative' => $relative,
-			'owner' => $ownerId,
-			'ownerDisplayName' => $ownerDisplayName,
-			'mountType' => $mount->getMountType(),
-			'mountPoint' => trim($mountPoint, '/'),
-		];
-
-		if ($isRemoteShare === false && $ownerId !== false && $path === '/') {
-			// If path is root, store this as last known quota usage for this user
-			\OCP\Server::get(\OCP\IConfig::class)->setUserValue($ownerId, 'files', 'lastSeenQuotaUsage', (string)$relative);
-		}
-
-		$memcache->set($cacheKey, $info, 5 * 60);
-
-		return $info;
-	}
-
-	/**
-	 * Get storage info including all mount points and quota
-	 *
-	 * @psalm-suppress LessSpecificReturnStatement Legacy code outputs weird types - manually validated that they are correct
-	 * @return StorageInfo
-	 */
-	private static function getGlobalStorageInfo(int|float $quota, IUser $user, IMountPoint $mount): array {
-		$rootInfo = \OC\Files\Filesystem::getFileInfo('', 'ext');
-		/** @var int|float $used */
-		$used = $rootInfo['size'];
-		if ($used < 0) {
-			$used = 0.0;
-		}
-
-		$total = $quota;
-		/** @var int|float $free */
-		$free = $quota - $used;
-
-		if ($total > 0) {
-			if ($quota > 0 && $total > $quota) {
-				$total = $quota;
-			}
-			// prevent division by zero or error codes (negative values)
-			$relative = round(($used / $total) * 10000) / 100;
-		} else {
-			$relative = 0.0;
-		}
-
-		if (substr_count($mount->getMountPoint(), '/') < 3) {
-			$mountPoint = '';
-		} else {
-			[,,,$mountPoint] = explode('/', $mount->getMountPoint(), 4);
-		}
-
-		return [
-			'free' => $free,
-			'used' => $used,
-			'total' => $total,
-			'relative' => $relative,
-			'quota' => $quota,
-			'owner' => $user->getUID(),
-			'ownerDisplayName' => $user->getDisplayName(),
-			'mountType' => $mount->getMountType(),
-			'mountPoint' => trim($mountPoint, '/'),
-		];
-	}
-
-	public static function clearStorageInfo(string $absolutePath): void {
-		/** @var ICacheFactory $cacheFactory */
-		$cacheFactory = \OC::$server->get(ICacheFactory::class);
-		$memcache = $cacheFactory->createLocal('storage_info');
-		$cacheKeyPrefix = Filesystem::normalizePath($absolutePath) . '::';
-		$memcache->remove($cacheKeyPrefix . 'include');
-		$memcache->remove($cacheKeyPrefix . 'exclude');
-	}
-
-	/**
-	 * Returns whether the config file is set manually to read-only
-	 * @return bool
-	 * @deprecated 32.0.0 use the `config_is_read_only` system config directly
-	 */
-	public static function isReadOnlyConfigEnabled() {
-		return \OC::$server->getConfig()->getSystemValueBool('config_is_read_only', false);
-	}
+        $isRemoteShare = $storage->instanceOfStorage(\OCA\Files_Sharing\External\Storage::class);
+
+        $ownerId = $storage->getOwner($path);
+        $ownerDisplayName = '';
+
+        if ($isRemoteShare === false && $ownerId !== false) {
+            $ownerDisplayName = \OC::$server->getUserManager()->getDisplayName($ownerId) ?? '';
+        }
+
+        if (substr_count($mount->getMountPoint(), '/') < 3) {
+            $mountPoint = '';
+        } else {
+            [,,,$mountPoint] = explode('/', $mount->getMountPoint(), 4);
+        }
+
+        $info = [
+            'free' => $free,
+            'used' => $used,
+            'quota' => $quota,
+            'total' => $total,
+            'relative' => $relative,
+            'owner' => $ownerId,
+            'ownerDisplayName' => $ownerDisplayName,
+            'mountType' => $mount->getMountType(),
+            'mountPoint' => trim($mountPoint, '/'),
+        ];
+
+        if ($isRemoteShare === false && $ownerId !== false && $path === '/') {
+            // If path is root, store this as last known quota usage for this user
+            \OCP\Server::get(\OCP\IConfig::class)->setUserValue($ownerId, 'files', 'lastSeenQuotaUsage', (string)$relative);
+        }
+
+        $memcache->set($cacheKey, $info, 5 * 60);
+
+        return $info;
+    }
+
+    /**
+     * Get storage info including all mount points and quota
+     *
+     * @psalm-suppress LessSpecificReturnStatement Legacy code outputs weird types - manually validated that they are correct
+     * @return StorageInfo
+     */
+    private static function getGlobalStorageInfo(int|float $quota, IUser $user, IMountPoint $mount): array {
+        $rootInfo = \OC\Files\Filesystem::getFileInfo('', 'ext');
+        /** @var int|float $used */
+        $used = $rootInfo['size'];
+        if ($used < 0) {
+            $used = 0.0;
+        }
+
+        $total = $quota;
+        /** @var int|float $free */
+        $free = $quota - $used;
+
+        if ($total > 0) {
+            if ($quota > 0 && $total > $quota) {
+                $total = $quota;
+            }
+            // prevent division by zero or error codes (negative values)
+            $relative = round(($used / $total) * 10000) / 100;
+        } else {
+            $relative = 0.0;
+        }
+
+        if (substr_count($mount->getMountPoint(), '/') < 3) {
+            $mountPoint = '';
+        } else {
+            [,,,$mountPoint] = explode('/', $mount->getMountPoint(), 4);
+        }
+
+        return [
+            'free' => $free,
+            'used' => $used,
+            'total' => $total,
+            'relative' => $relative,
+            'quota' => $quota,
+            'owner' => $user->getUID(),
+            'ownerDisplayName' => $user->getDisplayName(),
+            'mountType' => $mount->getMountType(),
+            'mountPoint' => trim($mountPoint, '/'),
+        ];
+    }
+
+    public static function clearStorageInfo(string $absolutePath): void {
+        /** @var ICacheFactory $cacheFactory */
+        $cacheFactory = \OC::$server->get(ICacheFactory::class);
+        $memcache = $cacheFactory->createLocal('storage_info');
+        $cacheKeyPrefix = Filesystem::normalizePath($absolutePath) . '::';
+        $memcache->remove($cacheKeyPrefix . 'include');
+        $memcache->remove($cacheKeyPrefix . 'exclude');
+    }
+
+    /**
+     * Returns whether the config file is set manually to read-only
+     * @return bool
+     * @deprecated 32.0.0 use the `config_is_read_only` system config directly
+     */
+    public static function isReadOnlyConfigEnabled() {
+        return \OC::$server->getConfig()->getSystemValueBool('config_is_read_only', false);
+    }
 }

lib/private/legacy/OC_User.php

Indentation +362 added lines, -362 removed lines

@@ -40,366 +40,366 @@
  *   logout()
  */
 class OC_User {
-	private static $_setupedBackends = [];
-
-	// bool, stores if a user want to access a resource anonymously, e.g if they open a public link
-	private static $incognitoMode = false;
-
-	/**
-	 * Adds the backend to the list of used backends
-	 *
-	 * @param string|\OCP\UserInterface $backend default: database The backend to use for user management
-	 * @return bool
-	 * @deprecated 32.0.0 Use IUserManager::registerBackend instead
-	 *
-	 * Set the User Authentication Module
-	 */
-	public static function useBackend($backend = 'database') {
-		if ($backend instanceof \OCP\UserInterface) {
-			Server::get(IUserManager::class)->registerBackend($backend);
-		} else {
-			// You'll never know what happens
-			if ($backend === null || !is_string($backend)) {
-				$backend = 'database';
-			}
-
-			// Load backend
-			switch ($backend) {
-				case 'database':
-				case 'mysql':
-				case 'sqlite':
-					Server::get(LoggerInterface::class)->debug('Adding user backend ' . $backend . '.', ['app' => 'core']);
-					Server::get(IUserManager::class)->registerBackend(new \OC\User\Database());
-					break;
-				case 'dummy':
-					Server::get(IUserManager::class)->registerBackend(new \Test\Util\User\Dummy());
-					break;
-				default:
-					Server::get(LoggerInterface::class)->debug('Adding default user backend ' . $backend . '.', ['app' => 'core']);
-					$className = 'OC_USER_' . strtoupper($backend);
-					Server::get(IUserManager::class)->registerBackend(new $className());
-					break;
-			}
-		}
-		return true;
-	}
-
-	/**
-	 * remove all used backends
-	 * @deprecated 32.0.0 Use IUserManager::clearBackends instead
-	 */
-	public static function clearBackends() {
-		Server::get(IUserManager::class)->clearBackends();
-	}
-
-	/**
-	 * setup the configured backends in config.php
-	 * @suppress PhanDeprecatedFunction
-	 */
-	public static function setupBackends() {
-		OC_App::loadApps(['prelogin']);
-		$backends = \OC::$server->getSystemConfig()->getValue('user_backends', []);
-		if (isset($backends['default']) && !$backends['default']) {
-			// clear default backends
-			self::clearBackends();
-		}
-		foreach ($backends as $i => $config) {
-			if (!is_array($config)) {
-				continue;
-			}
-			$class = $config['class'];
-			$arguments = $config['arguments'];
-			if (class_exists($class)) {
-				if (!in_array($i, self::$_setupedBackends)) {
-					// make a reflection object
-					$reflectionObj = new ReflectionClass($class);
-
-					// use Reflection to create a new instance, using the $args
-					$backend = $reflectionObj->newInstanceArgs($arguments);
-					self::useBackend($backend);
-					self::$_setupedBackends[] = $i;
-				} else {
-					Server::get(LoggerInterface::class)->debug('User backend ' . $class . ' already initialized.', ['app' => 'core']);
-				}
-			} else {
-				Server::get(LoggerInterface::class)->error('User backend ' . $class . ' not found.', ['app' => 'core']);
-			}
-		}
-	}
-
-	/**
-	 * Try to login a user, assuming authentication
-	 * has already happened (e.g. via Single Sign On).
-	 *
-	 * Log in a user and regenerate a new session.
-	 *
-	 * @param \OCP\Authentication\IApacheBackend $backend
-	 * @return bool
-	 */
-	public static function loginWithApache(\OCP\Authentication\IApacheBackend $backend) {
-		$uid = $backend->getCurrentUserId();
-		$run = true;
-		OC_Hook::emit('OC_User', 'pre_login', ['run' => &$run, 'uid' => $uid, 'backend' => $backend]);
-
-		if ($uid) {
-			if (self::getUser() !== $uid) {
-				self::setUserId($uid);
-				$userSession = \OC::$server->getUserSession();
-
-				/** @var IEventDispatcher $dispatcher */
-				$dispatcher = \OC::$server->get(IEventDispatcher::class);
-
-				if ($userSession->getUser() && !$userSession->getUser()->isEnabled()) {
-					$message = \OC::$server->getL10N('lib')->t('Account disabled');
-					throw new DisabledUserException($message);
-				}
-				$userSession->setLoginName($uid);
-				$request = OC::$server->getRequest();
-				$password = null;
-				if ($backend instanceof \OCP\Authentication\IProvideUserSecretBackend) {
-					$password = $backend->getCurrentUserSecret();
-				}
-
-				/** @var IEventDispatcher $dispatcher */
-				$dispatcher->dispatchTyped(new BeforeUserLoggedInEvent($uid, $password, $backend));
-
-				$userSession->createSessionToken($request, $uid, $uid, $password);
-				$userSession->createRememberMeToken($userSession->getUser());
-
-				if (empty($password)) {
-					$tokenProvider = \OC::$server->get(IProvider::class);
-					try {
-						$token = $tokenProvider->getToken($userSession->getSession()->getId());
-						$token->setScope([
-							IToken::SCOPE_SKIP_PASSWORD_VALIDATION => true,
-							IToken::SCOPE_FILESYSTEM => true,
-						]);
-						$tokenProvider->updateToken($token);
-					} catch (InvalidTokenException|WipeTokenException|SessionNotAvailableException) {
-						// swallow the exceptions as we do not deal with them here
-						// simply skip updating the token when is it missing
-					}
-				}
-
-				// setup the filesystem
-				OC_Util::setupFS($uid);
-				// first call the post_login hooks, the login-process needs to be
-				// completed before we can safely create the users folder.
-				// For example encryption needs to initialize the users keys first
-				// before we can create the user folder with the skeleton files
-				OC_Hook::emit(
-					'OC_User',
-					'post_login',
-					[
-						'uid' => $uid,
-						'password' => $password,
-						'isTokenLogin' => false,
-					]
-				);
-				$dispatcher->dispatchTyped(new UserLoggedInEvent(
-					\OC::$server->get(IUserManager::class)->get($uid),
-					$uid,
-					null,
-					false)
-				);
-
-				//trigger creation of user home and /files folder
-				\OC::$server->getUserFolder($uid);
-			}
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * Verify with Apache whether user is authenticated.
-	 *
-	 * @return boolean|null
-	 *                      true: authenticated
-	 *                      false: not authenticated
-	 *                      null: not handled / no backend available
-	 */
-	public static function handleApacheAuth() {
-		$backend = self::findFirstActiveUsedBackend();
-		if ($backend) {
-			OC_App::loadApps();
-
-			//setup extra user backends
-			self::setupBackends();
-			\OC::$server->getUserSession()->unsetMagicInCookie();
-
-			return self::loginWithApache($backend);
-		}
-
-		return null;
-	}
-
-
-	/**
-	 * Sets user id for session and triggers emit
-	 *
-	 * @param string $uid
-	 */
-	public static function setUserId($uid) {
-		$userSession = \OC::$server->getUserSession();
-		$userManager = Server::get(IUserManager::class);
-		if ($user = $userManager->get($uid)) {
-			$userSession->setUser($user);
-		} else {
-			\OC::$server->getSession()->set('user_id', $uid);
-		}
-	}
-
-	/**
-	 * Check if the user is logged in, considers also the HTTP basic credentials
-	 *
-	 * @deprecated 12.0.0 use \OC::$server->getUserSession()->isLoggedIn()
-	 * @return bool
-	 */
-	public static function isLoggedIn() {
-		return \OC::$server->getUserSession()->isLoggedIn();
-	}
-
-	/**
-	 * set incognito mode, e.g. if a user wants to open a public link
-	 *
-	 * @param bool $status
-	 */
-	public static function setIncognitoMode($status) {
-		self::$incognitoMode = $status;
-	}
-
-	/**
-	 * get incognito mode status
-	 *
-	 * @return bool
-	 */
-	public static function isIncognitoMode() {
-		return self::$incognitoMode;
-	}
-
-	/**
-	 * Returns the current logout URL valid for the currently logged-in user
-	 *
-	 * @param \OCP\IURLGenerator $urlGenerator
-	 * @return string
-	 */
-	public static function getLogoutUrl(\OCP\IURLGenerator $urlGenerator) {
-		$backend = self::findFirstActiveUsedBackend();
-		if ($backend) {
-			return $backend->getLogoutUrl();
-		}
-
-		$user = \OC::$server->getUserSession()->getUser();
-		if ($user instanceof IUser) {
-			$backend = $user->getBackend();
-			if ($backend instanceof \OCP\User\Backend\ICustomLogout) {
-				return $backend->getLogoutUrl();
-			}
-		}
-
-		$logoutUrl = $urlGenerator->linkToRoute('core.login.logout');
-		$logoutUrl .= '?requesttoken=' . urlencode(\OCP\Util::callRegister());
-
-		return $logoutUrl;
-	}
-
-	/**
-	 * Check if the user is an admin user
-	 *
-	 * @param string $uid uid of the admin
-	 * @return bool
-	 */
-	public static function isAdminUser($uid) {
-		$user = Server::get(IUserManager::class)->get($uid);
-		$isAdmin = $user && Server::get(IGroupManager::class)->isAdmin($user->getUID());
-		return $isAdmin && self::$incognitoMode === false;
-	}
-
-
-	/**
-	 * get the user id of the user currently logged in.
-	 *
-	 * @return string|false uid or false
-	 */
-	public static function getUser() {
-		$uid = Server::get(ISession::class)?->get('user_id');
-		if (!is_null($uid) && self::$incognitoMode === false) {
-			return $uid;
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * Set password
-	 *
-	 * @param string $uid The username
-	 * @param string $password The new password
-	 * @param string $recoveryPassword for the encryption app to reset encryption keys
-	 * @return bool
-	 *
-	 * Change the password of a user
-	 */
-	public static function setPassword($uid, $password, $recoveryPassword = null) {
-		$user = Server::get(IUserManager::class)->get($uid);
-		if ($user) {
-			return $user->setPassword($password, $recoveryPassword);
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * @param string $uid The username
-	 * @return string
-	 *
-	 * returns the path to the users home directory
-	 * @deprecated 12.0.0 Use \OC::$server->getUserManager->getHome()
-	 */
-	public static function getHome($uid) {
-		$user = Server::get(IUserManager::class)->get($uid);
-		if ($user) {
-			return $user->getHome();
-		} else {
-			return \OC::$server->getSystemConfig()->getValue('datadirectory', OC::$SERVERROOT . '/data') . '/' . $uid;
-		}
-	}
-
-	/**
-	 * Get a list of all users display name
-	 *
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array associative array with all display names (value) and corresponding uids (key)
-	 *
-	 * Get a list of all display names and user ids.
-	 * @deprecated 12.0.0 Use \OC::$server->getUserManager->searchDisplayName($search, $limit, $offset) instead.
-	 */
-	public static function getDisplayNames($search = '', $limit = null, $offset = null) {
-		$displayNames = [];
-		$users = Server::get(IUserManager::class)->searchDisplayName($search, $limit, $offset);
-		foreach ($users as $user) {
-			$displayNames[$user->getUID()] = $user->getDisplayName();
-		}
-		return $displayNames;
-	}
-
-	/**
-	 * Returns the first active backend from self::$_usedBackends.
-	 *
-	 * @return OCP\Authentication\IApacheBackend|null if no backend active, otherwise OCP\Authentication\IApacheBackend
-	 */
-	private static function findFirstActiveUsedBackend() {
-		foreach (Server::get(IUserManager::class)->getBackends() as $backend) {
-			if ($backend instanceof OCP\Authentication\IApacheBackend) {
-				if ($backend->isSessionActive()) {
-					return $backend;
-				}
-			}
-		}
-
-		return null;
-	}
+    private static $_setupedBackends = [];
+
+    // bool, stores if a user want to access a resource anonymously, e.g if they open a public link
+    private static $incognitoMode = false;
+
+    /**
+     * Adds the backend to the list of used backends
+     *
+     * @param string|\OCP\UserInterface $backend default: database The backend to use for user management
+     * @return bool
+     * @deprecated 32.0.0 Use IUserManager::registerBackend instead
+     *
+     * Set the User Authentication Module
+     */
+    public static function useBackend($backend = 'database') {
+        if ($backend instanceof \OCP\UserInterface) {
+            Server::get(IUserManager::class)->registerBackend($backend);
+        } else {
+            // You'll never know what happens
+            if ($backend === null || !is_string($backend)) {
+                $backend = 'database';
+            }
+
+            // Load backend
+            switch ($backend) {
+                case 'database':
+                case 'mysql':
+                case 'sqlite':
+                    Server::get(LoggerInterface::class)->debug('Adding user backend ' . $backend . '.', ['app' => 'core']);
+                    Server::get(IUserManager::class)->registerBackend(new \OC\User\Database());
+                    break;
+                case 'dummy':
+                    Server::get(IUserManager::class)->registerBackend(new \Test\Util\User\Dummy());
+                    break;
+                default:
+                    Server::get(LoggerInterface::class)->debug('Adding default user backend ' . $backend . '.', ['app' => 'core']);
+                    $className = 'OC_USER_' . strtoupper($backend);
+                    Server::get(IUserManager::class)->registerBackend(new $className());
+                    break;
+            }
+        }
+        return true;
+    }
+
+    /**
+     * remove all used backends
+     * @deprecated 32.0.0 Use IUserManager::clearBackends instead
+     */
+    public static function clearBackends() {
+        Server::get(IUserManager::class)->clearBackends();
+    }
+
+    /**
+     * setup the configured backends in config.php
+     * @suppress PhanDeprecatedFunction
+     */
+    public static function setupBackends() {
+        OC_App::loadApps(['prelogin']);
+        $backends = \OC::$server->getSystemConfig()->getValue('user_backends', []);
+        if (isset($backends['default']) && !$backends['default']) {
+            // clear default backends
+            self::clearBackends();
+        }
+        foreach ($backends as $i => $config) {
+            if (!is_array($config)) {
+                continue;
+            }
+            $class = $config['class'];
+            $arguments = $config['arguments'];
+            if (class_exists($class)) {
+                if (!in_array($i, self::$_setupedBackends)) {
+                    // make a reflection object
+                    $reflectionObj = new ReflectionClass($class);
+
+                    // use Reflection to create a new instance, using the $args
+                    $backend = $reflectionObj->newInstanceArgs($arguments);
+                    self::useBackend($backend);
+                    self::$_setupedBackends[] = $i;
+                } else {
+                    Server::get(LoggerInterface::class)->debug('User backend ' . $class . ' already initialized.', ['app' => 'core']);
+                }
+            } else {
+                Server::get(LoggerInterface::class)->error('User backend ' . $class . ' not found.', ['app' => 'core']);
+            }
+        }
+    }
+
+    /**
+     * Try to login a user, assuming authentication
+     * has already happened (e.g. via Single Sign On).
+     *
+     * Log in a user and regenerate a new session.
+     *
+     * @param \OCP\Authentication\IApacheBackend $backend
+     * @return bool
+     */
+    public static function loginWithApache(\OCP\Authentication\IApacheBackend $backend) {
+        $uid = $backend->getCurrentUserId();
+        $run = true;
+        OC_Hook::emit('OC_User', 'pre_login', ['run' => &$run, 'uid' => $uid, 'backend' => $backend]);
+
+        if ($uid) {
+            if (self::getUser() !== $uid) {
+                self::setUserId($uid);
+                $userSession = \OC::$server->getUserSession();
+
+                /** @var IEventDispatcher $dispatcher */
+                $dispatcher = \OC::$server->get(IEventDispatcher::class);
+
+                if ($userSession->getUser() && !$userSession->getUser()->isEnabled()) {
+                    $message = \OC::$server->getL10N('lib')->t('Account disabled');
+                    throw new DisabledUserException($message);
+                }
+                $userSession->setLoginName($uid);
+                $request = OC::$server->getRequest();
+                $password = null;
+                if ($backend instanceof \OCP\Authentication\IProvideUserSecretBackend) {
+                    $password = $backend->getCurrentUserSecret();
+                }
+
+                /** @var IEventDispatcher $dispatcher */
+                $dispatcher->dispatchTyped(new BeforeUserLoggedInEvent($uid, $password, $backend));
+
+                $userSession->createSessionToken($request, $uid, $uid, $password);
+                $userSession->createRememberMeToken($userSession->getUser());
+
+                if (empty($password)) {
+                    $tokenProvider = \OC::$server->get(IProvider::class);
+                    try {
+                        $token = $tokenProvider->getToken($userSession->getSession()->getId());
+                        $token->setScope([
+                            IToken::SCOPE_SKIP_PASSWORD_VALIDATION => true,
+                            IToken::SCOPE_FILESYSTEM => true,
+                        ]);
+                        $tokenProvider->updateToken($token);
+                    } catch (InvalidTokenException|WipeTokenException|SessionNotAvailableException) {
+                        // swallow the exceptions as we do not deal with them here
+                        // simply skip updating the token when is it missing
+                    }
+                }
+
+                // setup the filesystem
+                OC_Util::setupFS($uid);
+                // first call the post_login hooks, the login-process needs to be
+                // completed before we can safely create the users folder.
+                // For example encryption needs to initialize the users keys first
+                // before we can create the user folder with the skeleton files
+                OC_Hook::emit(
+                    'OC_User',
+                    'post_login',
+                    [
+                        'uid' => $uid,
+                        'password' => $password,
+                        'isTokenLogin' => false,
+                    ]
+                );
+                $dispatcher->dispatchTyped(new UserLoggedInEvent(
+                    \OC::$server->get(IUserManager::class)->get($uid),
+                    $uid,
+                    null,
+                    false)
+                );
+
+                //trigger creation of user home and /files folder
+                \OC::$server->getUserFolder($uid);
+            }
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Verify with Apache whether user is authenticated.
+     *
+     * @return boolean|null
+     *                      true: authenticated
+     *                      false: not authenticated
+     *                      null: not handled / no backend available
+     */
+    public static function handleApacheAuth() {
+        $backend = self::findFirstActiveUsedBackend();
+        if ($backend) {
+            OC_App::loadApps();
+
+            //setup extra user backends
+            self::setupBackends();
+            \OC::$server->getUserSession()->unsetMagicInCookie();
+
+            return self::loginWithApache($backend);
+        }
+
+        return null;
+    }
+
+
+    /**
+     * Sets user id for session and triggers emit
+     *
+     * @param string $uid
+     */
+    public static function setUserId($uid) {
+        $userSession = \OC::$server->getUserSession();
+        $userManager = Server::get(IUserManager::class);
+        if ($user = $userManager->get($uid)) {
+            $userSession->setUser($user);
+        } else {
+            \OC::$server->getSession()->set('user_id', $uid);
+        }
+    }
+
+    /**
+     * Check if the user is logged in, considers also the HTTP basic credentials
+     *
+     * @deprecated 12.0.0 use \OC::$server->getUserSession()->isLoggedIn()
+     * @return bool
+     */
+    public static function isLoggedIn() {
+        return \OC::$server->getUserSession()->isLoggedIn();
+    }
+
+    /**
+     * set incognito mode, e.g. if a user wants to open a public link
+     *
+     * @param bool $status
+     */
+    public static function setIncognitoMode($status) {
+        self::$incognitoMode = $status;
+    }
+
+    /**
+     * get incognito mode status
+     *
+     * @return bool
+     */
+    public static function isIncognitoMode() {
+        return self::$incognitoMode;
+    }
+
+    /**
+     * Returns the current logout URL valid for the currently logged-in user
+     *
+     * @param \OCP\IURLGenerator $urlGenerator
+     * @return string
+     */
+    public static function getLogoutUrl(\OCP\IURLGenerator $urlGenerator) {
+        $backend = self::findFirstActiveUsedBackend();
+        if ($backend) {
+            return $backend->getLogoutUrl();
+        }
+
+        $user = \OC::$server->getUserSession()->getUser();
+        if ($user instanceof IUser) {
+            $backend = $user->getBackend();
+            if ($backend instanceof \OCP\User\Backend\ICustomLogout) {
+                return $backend->getLogoutUrl();
+            }
+        }
+
+        $logoutUrl = $urlGenerator->linkToRoute('core.login.logout');
+        $logoutUrl .= '?requesttoken=' . urlencode(\OCP\Util::callRegister());
+
+        return $logoutUrl;
+    }
+
+    /**
+     * Check if the user is an admin user
+     *
+     * @param string $uid uid of the admin
+     * @return bool
+     */
+    public static function isAdminUser($uid) {
+        $user = Server::get(IUserManager::class)->get($uid);
+        $isAdmin = $user && Server::get(IGroupManager::class)->isAdmin($user->getUID());
+        return $isAdmin && self::$incognitoMode === false;
+    }
+
+
+    /**
+     * get the user id of the user currently logged in.
+     *
+     * @return string|false uid or false
+     */
+    public static function getUser() {
+        $uid = Server::get(ISession::class)?->get('user_id');
+        if (!is_null($uid) && self::$incognitoMode === false) {
+            return $uid;
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * Set password
+     *
+     * @param string $uid The username
+     * @param string $password The new password
+     * @param string $recoveryPassword for the encryption app to reset encryption keys
+     * @return bool
+     *
+     * Change the password of a user
+     */
+    public static function setPassword($uid, $password, $recoveryPassword = null) {
+        $user = Server::get(IUserManager::class)->get($uid);
+        if ($user) {
+            return $user->setPassword($password, $recoveryPassword);
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * @param string $uid The username
+     * @return string
+     *
+     * returns the path to the users home directory
+     * @deprecated 12.0.0 Use \OC::$server->getUserManager->getHome()
+     */
+    public static function getHome($uid) {
+        $user = Server::get(IUserManager::class)->get($uid);
+        if ($user) {
+            return $user->getHome();
+        } else {
+            return \OC::$server->getSystemConfig()->getValue('datadirectory', OC::$SERVERROOT . '/data') . '/' . $uid;
+        }
+    }
+
+    /**
+     * Get a list of all users display name
+     *
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array associative array with all display names (value) and corresponding uids (key)
+     *
+     * Get a list of all display names and user ids.
+     * @deprecated 12.0.0 Use \OC::$server->getUserManager->searchDisplayName($search, $limit, $offset) instead.
+     */
+    public static function getDisplayNames($search = '', $limit = null, $offset = null) {
+        $displayNames = [];
+        $users = Server::get(IUserManager::class)->searchDisplayName($search, $limit, $offset);
+        foreach ($users as $user) {
+            $displayNames[$user->getUID()] = $user->getDisplayName();
+        }
+        return $displayNames;
+    }
+
+    /**
+     * Returns the first active backend from self::$_usedBackends.
+     *
+     * @return OCP\Authentication\IApacheBackend|null if no backend active, otherwise OCP\Authentication\IApacheBackend
+     */
+    private static function findFirstActiveUsedBackend() {
+        foreach (Server::get(IUserManager::class)->getBackends() as $backend) {
+            if ($backend instanceof OCP\Authentication\IApacheBackend) {
+                if ($backend->isSessionActive()) {
+                    return $backend;
+                }
+            }
+        }
+
+        return null;
+    }
 }