nextcloud / server

apps/theming/lib/ImageManager.php

Indentation +242 added lines, -242 removed lines

@@ -46,271 +46,271 @@
 
 class ImageManager {
 
-	/** @var IConfig */
-	private $config;
-	/** @var IAppData */
-	private $appData;
-	/** @var IURLGenerator */
-	private $urlGenerator;
-	/** @var array */
-	private $supportedImageKeys = ['background', 'logo', 'logoheader', 'favicon'];
-	/** @var ICacheFactory */
-	private $cacheFactory;
-	/** @var ILogger */
-	private $logger;
-	/** @var ITempManager */
-	private $tempManager;
+    /** @var IConfig */
+    private $config;
+    /** @var IAppData */
+    private $appData;
+    /** @var IURLGenerator */
+    private $urlGenerator;
+    /** @var array */
+    private $supportedImageKeys = ['background', 'logo', 'logoheader', 'favicon'];
+    /** @var ICacheFactory */
+    private $cacheFactory;
+    /** @var ILogger */
+    private $logger;
+    /** @var ITempManager */
+    private $tempManager;
 
-	public function __construct(IConfig $config,
-								IAppData $appData,
-								IURLGenerator $urlGenerator,
-								ICacheFactory $cacheFactory,
-								ILogger $logger,
-								ITempManager $tempManager
-	) {
-		$this->config = $config;
-		$this->appData = $appData;
-		$this->urlGenerator = $urlGenerator;
-		$this->cacheFactory = $cacheFactory;
-		$this->logger = $logger;
-		$this->tempManager = $tempManager;
-	}
+    public function __construct(IConfig $config,
+                                IAppData $appData,
+                                IURLGenerator $urlGenerator,
+                                ICacheFactory $cacheFactory,
+                                ILogger $logger,
+                                ITempManager $tempManager
+    ) {
+        $this->config = $config;
+        $this->appData = $appData;
+        $this->urlGenerator = $urlGenerator;
+        $this->cacheFactory = $cacheFactory;
+        $this->logger = $logger;
+        $this->tempManager = $tempManager;
+    }
 
-	public function getImageUrl(string $key, bool $useSvg = true): string {
-		$cacheBusterCounter = $this->config->getAppValue('theming', 'cachebuster', '0');
-		try {
-			$image = $this->getImage($key, $useSvg);
-			return $this->urlGenerator->linkToRoute('theming.Theming.getImage', [ 'key' => $key ]) . '?v=' . $cacheBusterCounter;
-		} catch (NotFoundException $e) {
-		}
+    public function getImageUrl(string $key, bool $useSvg = true): string {
+        $cacheBusterCounter = $this->config->getAppValue('theming', 'cachebuster', '0');
+        try {
+            $image = $this->getImage($key, $useSvg);
+            return $this->urlGenerator->linkToRoute('theming.Theming.getImage', [ 'key' => $key ]) . '?v=' . $cacheBusterCounter;
+        } catch (NotFoundException $e) {
+        }
 
-		switch ($key) {
-			case 'logo':
-			case 'logoheader':
-			case 'favicon':
-				return $this->urlGenerator->imagePath('core', 'logo/logo.png') . '?v=' . $cacheBusterCounter;
-			case 'background':
-				return $this->urlGenerator->imagePath('core', 'background.png') . '?v=' . $cacheBusterCounter;
-		}
-		return '';
-	}
+        switch ($key) {
+            case 'logo':
+            case 'logoheader':
+            case 'favicon':
+                return $this->urlGenerator->imagePath('core', 'logo/logo.png') . '?v=' . $cacheBusterCounter;
+            case 'background':
+                return $this->urlGenerator->imagePath('core', 'background.png') . '?v=' . $cacheBusterCounter;
+        }
+        return '';
+    }
 
-	public function getImageUrlAbsolute(string $key, bool $useSvg = true): string {
-		return $this->urlGenerator->getAbsoluteURL($this->getImageUrl($key, $useSvg));
-	}
+    public function getImageUrlAbsolute(string $key, bool $useSvg = true): string {
+        return $this->urlGenerator->getAbsoluteURL($this->getImageUrl($key, $useSvg));
+    }
 
-	/**
-	 * @param string $key
-	 * @param bool $useSvg
-	 * @return ISimpleFile
-	 * @throws NotFoundException
-	 * @throws NotPermittedException
-	 */
-	public function getImage(string $key, bool $useSvg = true): ISimpleFile {
-		$logo = $this->config->getAppValue('theming', $key . 'Mime', '');
-		$folder = $this->appData->getFolder('images');
-		if ($logo === '' || !$folder->fileExists($key)) {
-			throw new NotFoundException();
-		}
-		if (!$useSvg && $this->shouldReplaceIcons()) {
-			if (!$folder->fileExists($key . '.png')) {
-				try {
-					$finalIconFile = new \Imagick();
-					$finalIconFile->setBackgroundColor('none');
-					$finalIconFile->readImageBlob($folder->getFile($key)->getContent());
-					$finalIconFile->setImageFormat('png32');
-					$pngFile = $folder->newFile($key . '.png');
-					$pngFile->putContent($finalIconFile->getImageBlob());
-					return $pngFile;
-				} catch (\ImagickException $e) {
-					$this->logger->info('The image was requested to be no SVG file, but converting it to PNG failed: ' . $e->getMessage());
-				}
-			} else {
-				return $folder->getFile($key . '.png');
-			}
-		}
-		return $folder->getFile($key);
-	}
+    /**
+     * @param string $key
+     * @param bool $useSvg
+     * @return ISimpleFile
+     * @throws NotFoundException
+     * @throws NotPermittedException
+     */
+    public function getImage(string $key, bool $useSvg = true): ISimpleFile {
+        $logo = $this->config->getAppValue('theming', $key . 'Mime', '');
+        $folder = $this->appData->getFolder('images');
+        if ($logo === '' || !$folder->fileExists($key)) {
+            throw new NotFoundException();
+        }
+        if (!$useSvg && $this->shouldReplaceIcons()) {
+            if (!$folder->fileExists($key . '.png')) {
+                try {
+                    $finalIconFile = new \Imagick();
+                    $finalIconFile->setBackgroundColor('none');
+                    $finalIconFile->readImageBlob($folder->getFile($key)->getContent());
+                    $finalIconFile->setImageFormat('png32');
+                    $pngFile = $folder->newFile($key . '.png');
+                    $pngFile->putContent($finalIconFile->getImageBlob());
+                    return $pngFile;
+                } catch (\ImagickException $e) {
+                    $this->logger->info('The image was requested to be no SVG file, but converting it to PNG failed: ' . $e->getMessage());
+                }
+            } else {
+                return $folder->getFile($key . '.png');
+            }
+        }
+        return $folder->getFile($key);
+    }
 
-	/**
-	 * @return array<string, array{mime: string, url: string}>
-	 */
-	public function getCustomImages(): array {
-		$images = [];
-		foreach ($this->supportedImageKeys as $key) {
-			$images[$key] = [
-				'mime' => $this->config->getAppValue('theming', $key . 'Mime', ''),
-				'url' => $this->getImageUrl($key),
-			];
-		}
-		return $images;
-	}
+    /**
+     * @return array<string, array{mime: string, url: string}>
+     */
+    public function getCustomImages(): array {
+        $images = [];
+        foreach ($this->supportedImageKeys as $key) {
+            $images[$key] = [
+                'mime' => $this->config->getAppValue('theming', $key . 'Mime', ''),
+                'url' => $this->getImageUrl($key),
+            ];
+        }
+        return $images;
+    }
 
-	/**
-	 * Get folder for current theming files
-	 *
-	 * @return ISimpleFolder
-	 * @throws NotPermittedException
-	 */
-	public function getCacheFolder(): ISimpleFolder {
-		$cacheBusterValue = $this->config->getAppValue('theming', 'cachebuster', '0');
-		try {
-			$folder = $this->appData->getFolder($cacheBusterValue);
-		} catch (NotFoundException $e) {
-			$folder = $this->appData->newFolder($cacheBusterValue);
-			$this->cleanup();
-		}
-		return $folder;
-	}
+    /**
+     * Get folder for current theming files
+     *
+     * @return ISimpleFolder
+     * @throws NotPermittedException
+     */
+    public function getCacheFolder(): ISimpleFolder {
+        $cacheBusterValue = $this->config->getAppValue('theming', 'cachebuster', '0');
+        try {
+            $folder = $this->appData->getFolder($cacheBusterValue);
+        } catch (NotFoundException $e) {
+            $folder = $this->appData->newFolder($cacheBusterValue);
+            $this->cleanup();
+        }
+        return $folder;
+    }
 
-	/**
-	 * Get a file from AppData
-	 *
-	 * @param string $filename
-	 * @throws NotFoundException
-	 * @return \OCP\Files\SimpleFS\ISimpleFile
-	 * @throws NotPermittedException
-	 */
-	public function getCachedImage(string $filename): ISimpleFile {
-		$currentFolder = $this->getCacheFolder();
-		return $currentFolder->getFile($filename);
-	}
+    /**
+     * Get a file from AppData
+     *
+     * @param string $filename
+     * @throws NotFoundException
+     * @return \OCP\Files\SimpleFS\ISimpleFile
+     * @throws NotPermittedException
+     */
+    public function getCachedImage(string $filename): ISimpleFile {
+        $currentFolder = $this->getCacheFolder();
+        return $currentFolder->getFile($filename);
+    }
 
-	/**
-	 * Store a file for theming in AppData
-	 *
-	 * @param string $filename
-	 * @param string $data
-	 * @return \OCP\Files\SimpleFS\ISimpleFile
-	 * @throws NotFoundException
-	 * @throws NotPermittedException
-	 */
-	public function setCachedImage(string $filename, string $data): ISimpleFile {
-		$currentFolder = $this->getCacheFolder();
-		if ($currentFolder->fileExists($filename)) {
-			$file = $currentFolder->getFile($filename);
-		} else {
-			$file = $currentFolder->newFile($filename);
-		}
-		$file->putContent($data);
-		return $file;
-	}
+    /**
+     * Store a file for theming in AppData
+     *
+     * @param string $filename
+     * @param string $data
+     * @return \OCP\Files\SimpleFS\ISimpleFile
+     * @throws NotFoundException
+     * @throws NotPermittedException
+     */
+    public function setCachedImage(string $filename, string $data): ISimpleFile {
+        $currentFolder = $this->getCacheFolder();
+        if ($currentFolder->fileExists($filename)) {
+            $file = $currentFolder->getFile($filename);
+        } else {
+            $file = $currentFolder->newFile($filename);
+        }
+        $file->putContent($data);
+        return $file;
+    }
 
-	public function delete(string $key): void {
-		/* ignore exceptions, since we don't want to fail hard if something goes wrong during cleanup */
-		try {
-			$file = $this->appData->getFolder('images')->getFile($key);
-			$file->delete();
-		} catch (NotFoundException $e) {
-		} catch (NotPermittedException $e) {
-		}
-		try {
-			$file = $this->appData->getFolder('images')->getFile($key . '.png');
-			$file->delete();
-		} catch (NotFoundException $e) {
-		} catch (NotPermittedException $e) {
-		}
-	}
+    public function delete(string $key): void {
+        /* ignore exceptions, since we don't want to fail hard if something goes wrong during cleanup */
+        try {
+            $file = $this->appData->getFolder('images')->getFile($key);
+            $file->delete();
+        } catch (NotFoundException $e) {
+        } catch (NotPermittedException $e) {
+        }
+        try {
+            $file = $this->appData->getFolder('images')->getFile($key . '.png');
+            $file->delete();
+        } catch (NotFoundException $e) {
+        } catch (NotPermittedException $e) {
+        }
+    }
 
-	public function updateImage(string $key, string $tmpFile): string {
-		$this->delete($key);
+    public function updateImage(string $key, string $tmpFile): string {
+        $this->delete($key);
 
-		try {
-			$folder = $this->appData->getFolder('images');
-		} catch (NotFoundException $e) {
-			$folder = $this->appData->newFolder('images');
-		}
+        try {
+            $folder = $this->appData->getFolder('images');
+        } catch (NotFoundException $e) {
+            $folder = $this->appData->newFolder('images');
+        }
 
-		$target = $folder->newFile($key);
-		$supportedFormats = $this->getSupportedUploadImageFormats($key);
-		$detectedMimeType = mime_content_type($tmpFile);
-		if (!in_array($detectedMimeType, $supportedFormats, true)) {
-			throw new \Exception('Unsupported image type');
-		}
+        $target = $folder->newFile($key);
+        $supportedFormats = $this->getSupportedUploadImageFormats($key);
+        $detectedMimeType = mime_content_type($tmpFile);
+        if (!in_array($detectedMimeType, $supportedFormats, true)) {
+            throw new \Exception('Unsupported image type');
+        }
 
-		if ($key === 'background' && strpos($detectedMimeType, 'image/svg') === false && strpos($detectedMimeType, 'image/gif') === false) {
-			// Optimize the image since some people may upload images that will be
-			// either to big or are not progressive rendering.
-			$newImage = @imagecreatefromstring(file_get_contents($tmpFile));
+        if ($key === 'background' && strpos($detectedMimeType, 'image/svg') === false && strpos($detectedMimeType, 'image/gif') === false) {
+            // Optimize the image since some people may upload images that will be
+            // either to big or are not progressive rendering.
+            $newImage = @imagecreatefromstring(file_get_contents($tmpFile));
 
-			// Preserve transparency
-			imagesavealpha($newImage, true);
-			imagealphablending($newImage, true);
+            // Preserve transparency
+            imagesavealpha($newImage, true);
+            imagealphablending($newImage, true);
 
-			$tmpFile = $this->tempManager->getTemporaryFile();
-			$newWidth = (int)(imagesx($newImage) < 4096 ? imagesx($newImage) : 4096);
-			$newHeight = (int)(imagesy($newImage) / (imagesx($newImage) / $newWidth));
-			$outputImage = imagescale($newImage, $newWidth, $newHeight);
+            $tmpFile = $this->tempManager->getTemporaryFile();
+            $newWidth = (int)(imagesx($newImage) < 4096 ? imagesx($newImage) : 4096);
+            $newHeight = (int)(imagesy($newImage) / (imagesx($newImage) / $newWidth));
+            $outputImage = imagescale($newImage, $newWidth, $newHeight);
 
-			imageinterlace($outputImage, 1);
-			imagepng($outputImage, $tmpFile, 8);
-			imagedestroy($outputImage);
+            imageinterlace($outputImage, 1);
+            imagepng($outputImage, $tmpFile, 8);
+            imagedestroy($outputImage);
 
-			$target->putContent(file_get_contents($tmpFile));
-		} else {
-			$target->putContent(file_get_contents($tmpFile));
-		}
+            $target->putContent(file_get_contents($tmpFile));
+        } else {
+            $target->putContent(file_get_contents($tmpFile));
+        }
 
-		return $detectedMimeType;
-	}
+        return $detectedMimeType;
+    }
 
-	/**
-	 * Returns a list of supported mime types for image uploads.
-	 * "favicon" images are only allowed to be SVG when imagemagick with SVG support is available.
-	 *
-	 * @param string $key The image key, e.g. "favicon"
-	 * @return string[]
-	 */
-	private function getSupportedUploadImageFormats(string $key): array {
-		$supportedFormats = ['image/jpeg', 'image/png', 'image/gif', 'image/webp'];
+    /**
+     * Returns a list of supported mime types for image uploads.
+     * "favicon" images are only allowed to be SVG when imagemagick with SVG support is available.
+     *
+     * @param string $key The image key, e.g. "favicon"
+     * @return string[]
+     */
+    private function getSupportedUploadImageFormats(string $key): array {
+        $supportedFormats = ['image/jpeg', 'image/png', 'image/gif', 'image/webp'];
 
-		if ($key !== 'favicon' || $this->shouldReplaceIcons() === true) {
-			$supportedFormats[] = 'image/svg+xml';
-			$supportedFormats[] = 'image/svg';
-		}
+        if ($key !== 'favicon' || $this->shouldReplaceIcons() === true) {
+            $supportedFormats[] = 'image/svg+xml';
+            $supportedFormats[] = 'image/svg';
+        }
 
-		if ($key === 'favicon') {
-			$supportedFormats[] = 'image/x-icon';
-			$supportedFormats[] = 'image/vnd.microsoft.icon';
-		}
+        if ($key === 'favicon') {
+            $supportedFormats[] = 'image/x-icon';
+            $supportedFormats[] = 'image/vnd.microsoft.icon';
+        }
 
-		return $supportedFormats;
-	}
+        return $supportedFormats;
+    }
 
-	/**
-	 * remove cached files that are not required any longer
-	 *
-	 * @throws NotPermittedException
-	 * @throws NotFoundException
-	 */
-	public function cleanup() {
-		$currentFolder = $this->getCacheFolder();
-		$folders = $this->appData->getDirectoryListing();
-		foreach ($folders as $folder) {
-			if ($folder->getName() !== 'images' && $folder->getName() !== $currentFolder->getName()) {
-				$folder->delete();
-			}
-		}
-	}
+    /**
+     * remove cached files that are not required any longer
+     *
+     * @throws NotPermittedException
+     * @throws NotFoundException
+     */
+    public function cleanup() {
+        $currentFolder = $this->getCacheFolder();
+        $folders = $this->appData->getDirectoryListing();
+        foreach ($folders as $folder) {
+            if ($folder->getName() !== 'images' && $folder->getName() !== $currentFolder->getName()) {
+                $folder->delete();
+            }
+        }
+    }
 
-	/**
-	 * Check if Imagemagick is enabled and if SVG is supported
-	 * otherwise we can't render custom icons
-	 *
-	 * @return bool
-	 */
-	public function shouldReplaceIcons() {
-		$cache = $this->cacheFactory->createDistributed('theming-' . $this->urlGenerator->getBaseUrl());
-		if ($value = $cache->get('shouldReplaceIcons')) {
-			return (bool)$value;
-		}
-		$value = false;
-		if (extension_loaded('imagick')) {
-			if (count(\Imagick::queryFormats('SVG')) >= 1) {
-				$value = true;
-			}
-		}
-		$cache->set('shouldReplaceIcons', $value);
-		return $value;
-	}
+    /**
+     * Check if Imagemagick is enabled and if SVG is supported
+     * otherwise we can't render custom icons
+     *
+     * @return bool
+     */
+    public function shouldReplaceIcons() {
+        $cache = $this->cacheFactory->createDistributed('theming-' . $this->urlGenerator->getBaseUrl());
+        if ($value = $cache->get('shouldReplaceIcons')) {
+            return (bool)$value;
+        }
+        $value = false;
+        if (extension_loaded('imagick')) {
+            if (count(\Imagick::queryFormats('SVG')) >= 1) {
+                $value = true;
+            }
+        }
+        $cache->set('shouldReplaceIcons', $value);
+        return $value;
+    }
 }

Spacing +14 added lines, -14 removed lines

@@ -80,7 +80,7 @@ 
 		$cacheBusterCounter = $this->config->getAppValue('theming', 'cachebuster', '0');
 		try {
 			$image = $this->getImage($key, $useSvg);
-			return $this->urlGenerator->linkToRoute('theming.Theming.getImage', [ 'key' => $key ]) . '?v=' . $cacheBusterCounter;
+			return $this->urlGenerator->linkToRoute('theming.Theming.getImage', ['key' => $key]).'?v='.$cacheBusterCounter;
 		} catch (NotFoundException $e) {
 		}
 
@@ -88,9 +88,9 @@ 
 			case 'logo':
 			case 'logoheader':
 			case 'favicon':
-				return $this->urlGenerator->imagePath('core', 'logo/logo.png') . '?v=' . $cacheBusterCounter;
+				return $this->urlGenerator->imagePath('core', 'logo/logo.png').'?v='.$cacheBusterCounter;
 			case 'background':
-				return $this->urlGenerator->imagePath('core', 'background.png') . '?v=' . $cacheBusterCounter;
+				return $this->urlGenerator->imagePath('core', 'background.png').'?v='.$cacheBusterCounter;
 		}
 		return '';
 	}
@@ -107,26 +107,26 @@ 
 	 * @throws NotPermittedException
 	 */
 	public function getImage(string $key, bool $useSvg = true): ISimpleFile {
-		$logo = $this->config->getAppValue('theming', $key . 'Mime', '');
+		$logo = $this->config->getAppValue('theming', $key.'Mime', '');
 		$folder = $this->appData->getFolder('images');
 		if ($logo === '' || !$folder->fileExists($key)) {
 			throw new NotFoundException();
 		}
 		if (!$useSvg && $this->shouldReplaceIcons()) {
-			if (!$folder->fileExists($key . '.png')) {
+			if (!$folder->fileExists($key.'.png')) {
 				try {
 					$finalIconFile = new \Imagick();
 					$finalIconFile->setBackgroundColor('none');
 					$finalIconFile->readImageBlob($folder->getFile($key)->getContent());
 					$finalIconFile->setImageFormat('png32');
-					$pngFile = $folder->newFile($key . '.png');
+					$pngFile = $folder->newFile($key.'.png');
 					$pngFile->putContent($finalIconFile->getImageBlob());
 					return $pngFile;
 				} catch (\ImagickException $e) {
-					$this->logger->info('The image was requested to be no SVG file, but converting it to PNG failed: ' . $e->getMessage());
+					$this->logger->info('The image was requested to be no SVG file, but converting it to PNG failed: '.$e->getMessage());
 				}
 			} else {
-				return $folder->getFile($key . '.png');
+				return $folder->getFile($key.'.png');
 			}
 		}
 		return $folder->getFile($key);
@@ -139,7 +139,7 @@ 
 		$images = [];
 		foreach ($this->supportedImageKeys as $key) {
 			$images[$key] = [
-				'mime' => $this->config->getAppValue('theming', $key . 'Mime', ''),
+				'mime' => $this->config->getAppValue('theming', $key.'Mime', ''),
 				'url' => $this->getImageUrl($key),
 			];
 		}
@@ -205,7 +205,7 @@ 
 		} catch (NotPermittedException $e) {
 		}
 		try {
-			$file = $this->appData->getFolder('images')->getFile($key . '.png');
+			$file = $this->appData->getFolder('images')->getFile($key.'.png');
 			$file->delete();
 		} catch (NotFoundException $e) {
 		} catch (NotPermittedException $e) {
@@ -238,8 +238,8 @@ 
 			imagealphablending($newImage, true);
 
 			$tmpFile = $this->tempManager->getTemporaryFile();
-			$newWidth = (int)(imagesx($newImage) < 4096 ? imagesx($newImage) : 4096);
-			$newHeight = (int)(imagesy($newImage) / (imagesx($newImage) / $newWidth));
+			$newWidth = (int) (imagesx($newImage) < 4096 ? imagesx($newImage) : 4096);
+			$newHeight = (int) (imagesy($newImage) / (imagesx($newImage) / $newWidth));
 			$outputImage = imagescale($newImage, $newWidth, $newHeight);
 
 			imageinterlace($outputImage, 1);
@@ -300,9 +300,9 @@ 
 	 * @return bool
 	 */
 	public function shouldReplaceIcons() {
-		$cache = $this->cacheFactory->createDistributed('theming-' . $this->urlGenerator->getBaseUrl());
+		$cache = $this->cacheFactory->createDistributed('theming-'.$this->urlGenerator->getBaseUrl());
 		if ($value = $cache->get('shouldReplaceIcons')) {
-			return (bool)$value;
+			return (bool) $value;
 		}
 		$value = false;
 		if (extension_loaded('imagick')) {

apps/theming/lib/Controller/IconController.php

Indentation +128 added lines, -128 removed lines

@@ -41,137 +41,137 @@
 use OCP\IRequest;
 
 class IconController extends Controller {
-	/** @var ThemingDefaults */
-	private $themingDefaults;
-	/** @var IconBuilder */
-	private $iconBuilder;
-	/** @var ImageManager */
-	private $imageManager;
-	/** @var FileAccessHelper */
-	private $fileAccessHelper;
+    /** @var ThemingDefaults */
+    private $themingDefaults;
+    /** @var IconBuilder */
+    private $iconBuilder;
+    /** @var ImageManager */
+    private $imageManager;
+    /** @var FileAccessHelper */
+    private $fileAccessHelper;
 
-	/**
-	 * IconController constructor.
-	 *
-	 * @param string $appName
-	 * @param IRequest $request
-	 * @param ThemingDefaults $themingDefaults
-	 * @param IconBuilder $iconBuilder
-	 * @param ImageManager $imageManager
-	 * @param FileAccessHelper $fileAccessHelper
-	 */
-	public function __construct(
-		$appName,
-		IRequest $request,
-		ThemingDefaults $themingDefaults,
-		IconBuilder $iconBuilder,
-		ImageManager $imageManager,
-		FileAccessHelper $fileAccessHelper
-	) {
-		parent::__construct($appName, $request);
+    /**
+     * IconController constructor.
+     *
+     * @param string $appName
+     * @param IRequest $request
+     * @param ThemingDefaults $themingDefaults
+     * @param IconBuilder $iconBuilder
+     * @param ImageManager $imageManager
+     * @param FileAccessHelper $fileAccessHelper
+     */
+    public function __construct(
+        $appName,
+        IRequest $request,
+        ThemingDefaults $themingDefaults,
+        IconBuilder $iconBuilder,
+        ImageManager $imageManager,
+        FileAccessHelper $fileAccessHelper
+    ) {
+        parent::__construct($appName, $request);
 
-		$this->themingDefaults = $themingDefaults;
-		$this->iconBuilder = $iconBuilder;
-		$this->imageManager = $imageManager;
-		$this->fileAccessHelper = $fileAccessHelper;
-	}
+        $this->themingDefaults = $themingDefaults;
+        $this->iconBuilder = $iconBuilder;
+        $this->imageManager = $imageManager;
+        $this->fileAccessHelper = $fileAccessHelper;
+    }
 
-	/**
-	 * @PublicPage
-	 * @NoCSRFRequired
-	 *
-	 * @param $app string app name
-	 * @param $image string image file name (svg required)
-	 * @return FileDisplayResponse|NotFoundResponse
-	 * @throws \Exception
-	 */
-	public function getThemedIcon(string $app, string $image): Response {
-		try {
-			$iconFile = $this->imageManager->getCachedImage('icon-' . $app . '-' . str_replace('/', '_',$image));
-		} catch (NotFoundException $exception) {
-			$icon = $this->iconBuilder->colorSvg($app, $image);
-			if ($icon === false || $icon === '') {
-				return new NotFoundResponse();
-			}
-			$iconFile = $this->imageManager->setCachedImage('icon-' . $app . '-' . str_replace('/', '_',$image), $icon);
-		}
-		$response = new FileDisplayResponse($iconFile, Http::STATUS_OK, ['Content-Type' => 'image/svg+xml']);
-		$response->cacheFor(86400);
-		return $response;
-	}
+    /**
+     * @PublicPage
+     * @NoCSRFRequired
+     *
+     * @param $app string app name
+     * @param $image string image file name (svg required)
+     * @return FileDisplayResponse|NotFoundResponse
+     * @throws \Exception
+     */
+    public function getThemedIcon(string $app, string $image): Response {
+        try {
+            $iconFile = $this->imageManager->getCachedImage('icon-' . $app . '-' . str_replace('/', '_',$image));
+        } catch (NotFoundException $exception) {
+            $icon = $this->iconBuilder->colorSvg($app, $image);
+            if ($icon === false || $icon === '') {
+                return new NotFoundResponse();
+            }
+            $iconFile = $this->imageManager->setCachedImage('icon-' . $app . '-' . str_replace('/', '_',$image), $icon);
+        }
+        $response = new FileDisplayResponse($iconFile, Http::STATUS_OK, ['Content-Type' => 'image/svg+xml']);
+        $response->cacheFor(86400);
+        return $response;
+    }
 
-	/**
-	 * Return a 32x32 favicon as png
-	 *
-	 * @PublicPage
-	 * @NoCSRFRequired
-	 *
-	 * @param $app string app name
-	 * @return FileDisplayResponse|DataDisplayResponse|NotFoundResponse
-	 * @throws \Exception
-	 */
-	public function getFavicon(string $app = 'core'): Response {
-		$response = null;
-		$iconFile = null;
-		try {
-			$iconFile = $this->imageManager->getImage('favicon', false);
-			$response = new FileDisplayResponse($iconFile, Http::STATUS_OK, ['Content-Type' => 'image/x-icon']);
-		} catch (NotFoundException $e) {
-		}
-		if ($iconFile === null && $this->imageManager->shouldReplaceIcons()) {
-			try {
-				$iconFile = $this->imageManager->getCachedImage('favIcon-' . $app);
-			} catch (NotFoundException $exception) {
-				$icon = $this->iconBuilder->getFavicon($app);
-				if ($icon === false || $icon === '') {
-					return new NotFoundResponse();
-				}
-				$iconFile = $this->imageManager->setCachedImage('favIcon-' . $app, $icon);
-			}
-			$response = new FileDisplayResponse($iconFile, Http::STATUS_OK, ['Content-Type' => 'image/x-icon']);
-		}
-		if ($response === null) {
-			$fallbackLogo = \OC::$SERVERROOT . '/core/img/favicon.png';
-			$response = new DataDisplayResponse($this->fileAccessHelper->file_get_contents($fallbackLogo), Http::STATUS_OK, ['Content-Type' => 'image/x-icon']);
-		}
-		$response->cacheFor(86400);
-		return $response;
-	}
+    /**
+     * Return a 32x32 favicon as png
+     *
+     * @PublicPage
+     * @NoCSRFRequired
+     *
+     * @param $app string app name
+     * @return FileDisplayResponse|DataDisplayResponse|NotFoundResponse
+     * @throws \Exception
+     */
+    public function getFavicon(string $app = 'core'): Response {
+        $response = null;
+        $iconFile = null;
+        try {
+            $iconFile = $this->imageManager->getImage('favicon', false);
+            $response = new FileDisplayResponse($iconFile, Http::STATUS_OK, ['Content-Type' => 'image/x-icon']);
+        } catch (NotFoundException $e) {
+        }
+        if ($iconFile === null && $this->imageManager->shouldReplaceIcons()) {
+            try {
+                $iconFile = $this->imageManager->getCachedImage('favIcon-' . $app);
+            } catch (NotFoundException $exception) {
+                $icon = $this->iconBuilder->getFavicon($app);
+                if ($icon === false || $icon === '') {
+                    return new NotFoundResponse();
+                }
+                $iconFile = $this->imageManager->setCachedImage('favIcon-' . $app, $icon);
+            }
+            $response = new FileDisplayResponse($iconFile, Http::STATUS_OK, ['Content-Type' => 'image/x-icon']);
+        }
+        if ($response === null) {
+            $fallbackLogo = \OC::$SERVERROOT . '/core/img/favicon.png';
+            $response = new DataDisplayResponse($this->fileAccessHelper->file_get_contents($fallbackLogo), Http::STATUS_OK, ['Content-Type' => 'image/x-icon']);
+        }
+        $response->cacheFor(86400);
+        return $response;
+    }
 
-	/**
-	 * Return a 512x512 icon for touch devices
-	 *
-	 * @PublicPage
-	 * @NoCSRFRequired
-	 *
-	 * @param $app string app name
-	 * @return DataDisplayResponse|FileDisplayResponse|NotFoundResponse
-	 * @throws \Exception
-	 */
-	public function getTouchIcon(string $app = 'core'): Response {
-		$response = null;
-		try {
-			$iconFile = $this->imageManager->getImage('favicon');
-			$response = new FileDisplayResponse($iconFile, Http::STATUS_OK, ['Content-Type' => 'image/x-icon']);
-		} catch (NotFoundException $e) {
-		}
-		if ($this->imageManager->shouldReplaceIcons()) {
-			try {
-				$iconFile = $this->imageManager->getCachedImage('touchIcon-' . $app);
-			} catch (NotFoundException $exception) {
-				$icon = $this->iconBuilder->getTouchIcon($app);
-				if ($icon === false || $icon === '') {
-					return new NotFoundResponse();
-				}
-				$iconFile = $this->imageManager->setCachedImage('touchIcon-' . $app, $icon);
-			}
-			$response = new FileDisplayResponse($iconFile, Http::STATUS_OK, ['Content-Type' => 'image/png']);
-		}
-		if ($response === null) {
-			$fallbackLogo = \OC::$SERVERROOT . '/core/img/favicon-touch.png';
-			$response = new DataDisplayResponse($this->fileAccessHelper->file_get_contents($fallbackLogo), Http::STATUS_OK, ['Content-Type' => 'image/png']);
-		}
-		$response->cacheFor(86400);
-		return $response;
-	}
+    /**
+     * Return a 512x512 icon for touch devices
+     *
+     * @PublicPage
+     * @NoCSRFRequired
+     *
+     * @param $app string app name
+     * @return DataDisplayResponse|FileDisplayResponse|NotFoundResponse
+     * @throws \Exception
+     */
+    public function getTouchIcon(string $app = 'core'): Response {
+        $response = null;
+        try {
+            $iconFile = $this->imageManager->getImage('favicon');
+            $response = new FileDisplayResponse($iconFile, Http::STATUS_OK, ['Content-Type' => 'image/x-icon']);
+        } catch (NotFoundException $e) {
+        }
+        if ($this->imageManager->shouldReplaceIcons()) {
+            try {
+                $iconFile = $this->imageManager->getCachedImage('touchIcon-' . $app);
+            } catch (NotFoundException $exception) {
+                $icon = $this->iconBuilder->getTouchIcon($app);
+                if ($icon === false || $icon === '') {
+                    return new NotFoundResponse();
+                }
+                $iconFile = $this->imageManager->setCachedImage('touchIcon-' . $app, $icon);
+            }
+            $response = new FileDisplayResponse($iconFile, Http::STATUS_OK, ['Content-Type' => 'image/png']);
+        }
+        if ($response === null) {
+            $fallbackLogo = \OC::$SERVERROOT . '/core/img/favicon-touch.png';
+            $response = new DataDisplayResponse($this->fileAccessHelper->file_get_contents($fallbackLogo), Http::STATUS_OK, ['Content-Type' => 'image/png']);
+        }
+        $response->cacheFor(86400);
+        return $response;
+    }
 }

Spacing +8 added lines, -8 removed lines

@@ -87,13 +87,13 @@ 
 	 */
 	public function getThemedIcon(string $app, string $image): Response {
 		try {
-			$iconFile = $this->imageManager->getCachedImage('icon-' . $app . '-' . str_replace('/', '_',$image));
+			$iconFile = $this->imageManager->getCachedImage('icon-'.$app.'-'.str_replace('/', '_', $image));
 		} catch (NotFoundException $exception) {
 			$icon = $this->iconBuilder->colorSvg($app, $image);
 			if ($icon === false || $icon === '') {
 				return new NotFoundResponse();
 			}
-			$iconFile = $this->imageManager->setCachedImage('icon-' . $app . '-' . str_replace('/', '_',$image), $icon);
+			$iconFile = $this->imageManager->setCachedImage('icon-'.$app.'-'.str_replace('/', '_', $image), $icon);
 		}
 		$response = new FileDisplayResponse($iconFile, Http::STATUS_OK, ['Content-Type' => 'image/svg+xml']);
 		$response->cacheFor(86400);
@@ -120,18 +120,18 @@ 
 		}
 		if ($iconFile === null && $this->imageManager->shouldReplaceIcons()) {
 			try {
-				$iconFile = $this->imageManager->getCachedImage('favIcon-' . $app);
+				$iconFile = $this->imageManager->getCachedImage('favIcon-'.$app);
 			} catch (NotFoundException $exception) {
 				$icon = $this->iconBuilder->getFavicon($app);
 				if ($icon === false || $icon === '') {
 					return new NotFoundResponse();
 				}
-				$iconFile = $this->imageManager->setCachedImage('favIcon-' . $app, $icon);
+				$iconFile = $this->imageManager->setCachedImage('favIcon-'.$app, $icon);
 			}
 			$response = new FileDisplayResponse($iconFile, Http::STATUS_OK, ['Content-Type' => 'image/x-icon']);
 		}
 		if ($response === null) {
-			$fallbackLogo = \OC::$SERVERROOT . '/core/img/favicon.png';
+			$fallbackLogo = \OC::$SERVERROOT.'/core/img/favicon.png';
 			$response = new DataDisplayResponse($this->fileAccessHelper->file_get_contents($fallbackLogo), Http::STATUS_OK, ['Content-Type' => 'image/x-icon']);
 		}
 		$response->cacheFor(86400);
@@ -157,18 +157,18 @@ 
 		}
 		if ($this->imageManager->shouldReplaceIcons()) {
 			try {
-				$iconFile = $this->imageManager->getCachedImage('touchIcon-' . $app);
+				$iconFile = $this->imageManager->getCachedImage('touchIcon-'.$app);
 			} catch (NotFoundException $exception) {
 				$icon = $this->iconBuilder->getTouchIcon($app);
 				if ($icon === false || $icon === '') {
 					return new NotFoundResponse();
 				}
-				$iconFile = $this->imageManager->setCachedImage('touchIcon-' . $app, $icon);
+				$iconFile = $this->imageManager->setCachedImage('touchIcon-'.$app, $icon);
 			}
 			$response = new FileDisplayResponse($iconFile, Http::STATUS_OK, ['Content-Type' => 'image/png']);
 		}
 		if ($response === null) {
-			$fallbackLogo = \OC::$SERVERROOT . '/core/img/favicon-touch.png';
+			$fallbackLogo = \OC::$SERVERROOT.'/core/img/favicon-touch.png';
 			$response = new DataDisplayResponse($this->fileAccessHelper->file_get_contents($fallbackLogo), Http::STATUS_OK, ['Content-Type' => 'image/png']);
 		}
 		$response->cacheFor(86400);

apps/theming/lib/Util.php

Indentation +224 added lines, -224 removed lines

@@ -37,254 +37,254 @@
 
 class Util {
 
-	/** @var IConfig */
-	private $config;
+    /** @var IConfig */
+    private $config;
 
-	/** @var IAppManager */
-	private $appManager;
+    /** @var IAppManager */
+    private $appManager;
 
-	/** @var IAppData */
-	private $appData;
+    /** @var IAppData */
+    private $appData;
 
-	/**
-	 * Util constructor.
-	 *
-	 * @param IConfig $config
-	 * @param IAppManager $appManager
-	 * @param IAppData $appData
-	 */
-	public function __construct(IConfig $config, IAppManager $appManager, IAppData $appData) {
-		$this->config = $config;
-		$this->appManager = $appManager;
-		$this->appData = $appData;
-	}
+    /**
+     * Util constructor.
+     *
+     * @param IConfig $config
+     * @param IAppManager $appManager
+     * @param IAppData $appData
+     */
+    public function __construct(IConfig $config, IAppManager $appManager, IAppData $appData) {
+        $this->config = $config;
+        $this->appManager = $appManager;
+        $this->appData = $appData;
+    }
 
-	/**
-	 * @param string $color rgb color value
-	 * @return bool
-	 */
-	public function invertTextColor($color) {
-		$l = $this->calculateLuma($color);
-		if ($l > 0.6) {
-			return true;
-		} else {
-			return false;
-		}
-	}
+    /**
+     * @param string $color rgb color value
+     * @return bool
+     */
+    public function invertTextColor($color) {
+        $l = $this->calculateLuma($color);
+        if ($l > 0.6) {
+            return true;
+        } else {
+            return false;
+        }
+    }
 
-	/**
-	 * get color for on-page elements:
-	 * theme color by default, grey if theme color is to bright
-	 * @param string $color
-	 * @param bool $brightBackground
-	 * @return string
-	 */
-	public function elementColor($color, bool $brightBackground = true) {
-		$luminance = $this->calculateLuminance($color);
+    /**
+     * get color for on-page elements:
+     * theme color by default, grey if theme color is to bright
+     * @param string $color
+     * @param bool $brightBackground
+     * @return string
+     */
+    public function elementColor($color, bool $brightBackground = true) {
+        $luminance = $this->calculateLuminance($color);
 
-		if ($brightBackground && $luminance > 0.8) {
-			// If the color is too bright in bright mode, we fall back to a darker gray
-			return '#aaaaaa';
-		}
+        if ($brightBackground && $luminance > 0.8) {
+            // If the color is too bright in bright mode, we fall back to a darker gray
+            return '#aaaaaa';
+        }
 
-		if (!$brightBackground && $luminance < 0.2) {
-			// If the color is too dark in dark mode, we fall back to a brighter gray
-			return '#555555';
-		}
+        if (!$brightBackground && $luminance < 0.2) {
+            // If the color is too dark in dark mode, we fall back to a brighter gray
+            return '#555555';
+        }
 
-		return $color;
-	}
+        return $color;
+    }
 
-	/**
-	 * Convert RGB to HSL
-	 *
-	 * Copied from cssphp, copyright Leaf Corcoran, licensed under MIT
-	 *
-	 * @param integer $red
-	 * @param integer $green
-	 * @param integer $blue
-	 *
-	 * @return array
-	 */
-	public function toHSL($red, $green, $blue) {
-		$min = min($red, $green, $blue);
-		$max = max($red, $green, $blue);
-		$l = $min + $max;
-		$d = $max - $min;
+    /**
+     * Convert RGB to HSL
+     *
+     * Copied from cssphp, copyright Leaf Corcoran, licensed under MIT
+     *
+     * @param integer $red
+     * @param integer $green
+     * @param integer $blue
+     *
+     * @return array
+     */
+    public function toHSL($red, $green, $blue) {
+        $min = min($red, $green, $blue);
+        $max = max($red, $green, $blue);
+        $l = $min + $max;
+        $d = $max - $min;
 
-		if ((int) $d === 0) {
-			$h = $s = 0;
-		} else {
-			if ($l < 255) {
-				$s = $d / $l;
-			} else {
-				$s = $d / (510 - $l);
-			}
+        if ((int) $d === 0) {
+            $h = $s = 0;
+        } else {
+            if ($l < 255) {
+                $s = $d / $l;
+            } else {
+                $s = $d / (510 - $l);
+            }
 
-			if ($red == $max) {
-				$h = 60 * ($green - $blue) / $d;
-			} elseif ($green == $max) {
-				$h = 60 * ($blue - $red) / $d + 120;
-			} else {
-				$h = 60 * ($red - $green) / $d + 240;
-			}
-		}
+            if ($red == $max) {
+                $h = 60 * ($green - $blue) / $d;
+            } elseif ($green == $max) {
+                $h = 60 * ($blue - $red) / $d + 120;
+            } else {
+                $h = 60 * ($red - $green) / $d + 240;
+            }
+        }
 
-		return [fmod($h, 360), $s * 100, $l / 5.1];
-	}
+        return [fmod($h, 360), $s * 100, $l / 5.1];
+    }
 
-	/**
-	 * @param string $color rgb color value
-	 * @return float
-	 */
-	public function calculateLuminance($color) {
-		[$red, $green, $blue] = $this->hexToRGB($color);
-		$hsl = $this->toHSL($red, $green, $blue);
-		return $hsl[2] / 100;
-	}
+    /**
+     * @param string $color rgb color value
+     * @return float
+     */
+    public function calculateLuminance($color) {
+        [$red, $green, $blue] = $this->hexToRGB($color);
+        $hsl = $this->toHSL($red, $green, $blue);
+        return $hsl[2] / 100;
+    }
 
-	/**
-	 * @param string $color rgb color value
-	 * @return float
-	 */
-	public function calculateLuma($color) {
-		[$red, $green, $blue] = $this->hexToRGB($color);
-		return (0.2126 * $red + 0.7152 * $green + 0.0722 * $blue) / 255;
-	}
+    /**
+     * @param string $color rgb color value
+     * @return float
+     */
+    public function calculateLuma($color) {
+        [$red, $green, $blue] = $this->hexToRGB($color);
+        return (0.2126 * $red + 0.7152 * $green + 0.0722 * $blue) / 255;
+    }
 
-	/**
-	 * @param string $color rgb color value
-	 * @return int[]
-	 * @psalm-return array{0: int, 1: int, 2: int}
-	 */
-	public function hexToRGB($color) {
-		$hex = preg_replace("/[^0-9A-Fa-f]/", '', $color);
-		if (strlen($hex) === 3) {
-			$hex = $hex[0] . $hex[0] . $hex[1] . $hex[1] . $hex[2] . $hex[2];
-		}
-		if (strlen($hex) !== 6) {
-			return [0, 0, 0];
-		}
-		return [
-			hexdec(substr($hex, 0, 2)),
-			hexdec(substr($hex, 2, 2)),
-			hexdec(substr($hex, 4, 2))
-		];
-	}
+    /**
+     * @param string $color rgb color value
+     * @return int[]
+     * @psalm-return array{0: int, 1: int, 2: int}
+     */
+    public function hexToRGB($color) {
+        $hex = preg_replace("/[^0-9A-Fa-f]/", '', $color);
+        if (strlen($hex) === 3) {
+            $hex = $hex[0] . $hex[0] . $hex[1] . $hex[1] . $hex[2] . $hex[2];
+        }
+        if (strlen($hex) !== 6) {
+            return [0, 0, 0];
+        }
+        return [
+            hexdec(substr($hex, 0, 2)),
+            hexdec(substr($hex, 2, 2)),
+            hexdec(substr($hex, 4, 2))
+        ];
+    }
 
-	/**
-	 * @param $color
-	 * @return string base64 encoded radio button svg
-	 */
-	public function generateRadioButton($color) {
-		$radioButtonIcon = '<svg xmlns="http://www.w3.org/2000/svg" height="16" width="16">' .
-			'<path d="M8 1a7 7 0 0 0-7 7 7 7 0 0 0 7 7 7 7 0 0 0 7-7 7 7 0 0 0-7-7zm0 1a6 6 0 0 1 6 6 6 6 0 0 1-6 6 6 6 0 0 1-6-6 6 6 0 0 1 6-6zm0 2a4 4 0 1 0 0 8 4 4 0 0 0 0-8z" fill="'.$color.'"/></svg>';
-		return base64_encode($radioButtonIcon);
-	}
+    /**
+     * @param $color
+     * @return string base64 encoded radio button svg
+     */
+    public function generateRadioButton($color) {
+        $radioButtonIcon = '<svg xmlns="http://www.w3.org/2000/svg" height="16" width="16">' .
+            '<path d="M8 1a7 7 0 0 0-7 7 7 7 0 0 0 7 7 7 7 0 0 0 7-7 7 7 0 0 0-7-7zm0 1a6 6 0 0 1 6 6 6 6 0 0 1-6 6 6 6 0 0 1-6-6 6 6 0 0 1 6-6zm0 2a4 4 0 1 0 0 8 4 4 0 0 0 0-8z" fill="'.$color.'"/></svg>';
+        return base64_encode($radioButtonIcon);
+    }
 
 
-	/**
-	 * @param $app string app name
-	 * @return string|ISimpleFile path to app icon / file of logo
-	 */
-	public function getAppIcon($app) {
-		$app = str_replace(['\0', '/', '\\', '..'], '', $app);
-		try {
-			$appPath = $this->appManager->getAppPath($app);
-			$icon = $appPath . '/img/' . $app . '.svg';
-			if (file_exists($icon)) {
-				return $icon;
-			}
-			$icon = $appPath . '/img/app.svg';
-			if (file_exists($icon)) {
-				return $icon;
-			}
-		} catch (AppPathNotFoundException $e) {
-		}
+    /**
+     * @param $app string app name
+     * @return string|ISimpleFile path to app icon / file of logo
+     */
+    public function getAppIcon($app) {
+        $app = str_replace(['\0', '/', '\\', '..'], '', $app);
+        try {
+            $appPath = $this->appManager->getAppPath($app);
+            $icon = $appPath . '/img/' . $app . '.svg';
+            if (file_exists($icon)) {
+                return $icon;
+            }
+            $icon = $appPath . '/img/app.svg';
+            if (file_exists($icon)) {
+                return $icon;
+            }
+        } catch (AppPathNotFoundException $e) {
+        }
 
-		if ($this->config->getAppValue('theming', 'logoMime', '') !== '') {
-			$logoFile = null;
-			try {
-				$folder = $this->appData->getFolder('images');
-				return $folder->getFile('logo');
-			} catch (NotFoundException $e) {
-			}
-		}
-		return \OC::$SERVERROOT . '/core/img/logo/logo.svg';
-	}
+        if ($this->config->getAppValue('theming', 'logoMime', '') !== '') {
+            $logoFile = null;
+            try {
+                $folder = $this->appData->getFolder('images');
+                return $folder->getFile('logo');
+            } catch (NotFoundException $e) {
+            }
+        }
+        return \OC::$SERVERROOT . '/core/img/logo/logo.svg';
+    }
 
-	/**
-	 * @param $app string app name
-	 * @param $image string relative path to image in app folder
-	 * @return string|false absolute path to image
-	 */
-	public function getAppImage($app, $image) {
-		$app = str_replace(['\0', '/', '\\', '..'], '', $app);
-		$image = str_replace(['\0', '\\', '..'], '', $image);
-		if ($app === "core") {
-			$icon = \OC::$SERVERROOT . '/core/img/' . $image;
-			if (file_exists($icon)) {
-				return $icon;
-			}
-		}
+    /**
+     * @param $app string app name
+     * @param $image string relative path to image in app folder
+     * @return string|false absolute path to image
+     */
+    public function getAppImage($app, $image) {
+        $app = str_replace(['\0', '/', '\\', '..'], '', $app);
+        $image = str_replace(['\0', '\\', '..'], '', $image);
+        if ($app === "core") {
+            $icon = \OC::$SERVERROOT . '/core/img/' . $image;
+            if (file_exists($icon)) {
+                return $icon;
+            }
+        }
 
-		try {
-			$appPath = $this->appManager->getAppPath($app);
-		} catch (AppPathNotFoundException $e) {
-			return false;
-		}
+        try {
+            $appPath = $this->appManager->getAppPath($app);
+        } catch (AppPathNotFoundException $e) {
+            return false;
+        }
 
-		$icon = $appPath . '/img/' . $image;
-		if (file_exists($icon)) {
-			return $icon;
-		}
-		$icon = $appPath . '/img/' . $image . '.svg';
-		if (file_exists($icon)) {
-			return $icon;
-		}
-		$icon = $appPath . '/img/' . $image . '.png';
-		if (file_exists($icon)) {
-			return $icon;
-		}
-		$icon = $appPath . '/img/' . $image . '.gif';
-		if (file_exists($icon)) {
-			return $icon;
-		}
-		$icon = $appPath . '/img/' . $image . '.jpg';
-		if (file_exists($icon)) {
-			return $icon;
-		}
+        $icon = $appPath . '/img/' . $image;
+        if (file_exists($icon)) {
+            return $icon;
+        }
+        $icon = $appPath . '/img/' . $image . '.svg';
+        if (file_exists($icon)) {
+            return $icon;
+        }
+        $icon = $appPath . '/img/' . $image . '.png';
+        if (file_exists($icon)) {
+            return $icon;
+        }
+        $icon = $appPath . '/img/' . $image . '.gif';
+        if (file_exists($icon)) {
+            return $icon;
+        }
+        $icon = $appPath . '/img/' . $image . '.jpg';
+        if (file_exists($icon)) {
+            return $icon;
+        }
 
-		return false;
-	}
+        return false;
+    }
 
-	/**
-	 * replace default color with a custom one
-	 *
-	 * @param $svg string content of a svg file
-	 * @param $color string color to match
-	 * @return string
-	 */
-	public function colorizeSvg($svg, $color) {
-		$svg = preg_replace('/#0082c9/i', $color, $svg);
-		return $svg;
-	}
+    /**
+     * replace default color with a custom one
+     *
+     * @param $svg string content of a svg file
+     * @param $color string color to match
+     * @return string
+     */
+    public function colorizeSvg($svg, $color) {
+        $svg = preg_replace('/#0082c9/i', $color, $svg);
+        return $svg;
+    }
 
-	/**
-	 * Check if a custom theme is set in the server configuration
-	 *
-	 * @return bool
-	 */
-	public function isAlreadyThemed() {
-		$theme = $this->config->getSystemValue('theme', '');
-		if ($theme !== '') {
-			return true;
-		}
-		return false;
-	}
+    /**
+     * Check if a custom theme is set in the server configuration
+     *
+     * @return bool
+     */
+    public function isAlreadyThemed() {
+        $theme = $this->config->getSystemValue('theme', '');
+        if ($theme !== '') {
+            return true;
+        }
+        return false;
+    }
 
-	public function isBackgroundThemed() {
-		$backgroundLogo = $this->config->getAppValue('theming', 'backgroundMime', '');
-		return $backgroundLogo !== '' && $backgroundLogo !== 'backgroundColor';
-	}
+    public function isBackgroundThemed() {
+        $backgroundLogo = $this->config->getAppValue('theming', 'backgroundMime', '');
+        return $backgroundLogo !== '' && $backgroundLogo !== 'backgroundColor';
+    }
 }

Spacing +11 added lines, -11 removed lines

@@ -160,7 +160,7 @@ 
 	public function hexToRGB($color) {
 		$hex = preg_replace("/[^0-9A-Fa-f]/", '', $color);
 		if (strlen($hex) === 3) {
-			$hex = $hex[0] . $hex[0] . $hex[1] . $hex[1] . $hex[2] . $hex[2];
+			$hex = $hex[0].$hex[0].$hex[1].$hex[1].$hex[2].$hex[2];
 		}
 		if (strlen($hex) !== 6) {
 			return [0, 0, 0];
@@ -177,7 +177,7 @@ 
 	 * @return string base64 encoded radio button svg
 	 */
 	public function generateRadioButton($color) {
-		$radioButtonIcon = '<svg xmlns="http://www.w3.org/2000/svg" height="16" width="16">' .
+		$radioButtonIcon = '<svg xmlns="http://www.w3.org/2000/svg" height="16" width="16">'.
 			'<path d="M8 1a7 7 0 0 0-7 7 7 7 0 0 0 7 7 7 7 0 0 0 7-7 7 7 0 0 0-7-7zm0 1a6 6 0 0 1 6 6 6 6 0 0 1-6 6 6 6 0 0 1-6-6 6 6 0 0 1 6-6zm0 2a4 4 0 1 0 0 8 4 4 0 0 0 0-8z" fill="'.$color.'"/></svg>';
 		return base64_encode($radioButtonIcon);
 	}
@@ -191,11 +191,11 @@ 
 		$app = str_replace(['\0', '/', '\\', '..'], '', $app);
 		try {
 			$appPath = $this->appManager->getAppPath($app);
-			$icon = $appPath . '/img/' . $app . '.svg';
+			$icon = $appPath.'/img/'.$app.'.svg';
 			if (file_exists($icon)) {
 				return $icon;
 			}
-			$icon = $appPath . '/img/app.svg';
+			$icon = $appPath.'/img/app.svg';
 			if (file_exists($icon)) {
 				return $icon;
 			}
@@ -210,7 +210,7 @@ 
 			} catch (NotFoundException $e) {
 			}
 		}
-		return \OC::$SERVERROOT . '/core/img/logo/logo.svg';
+		return \OC::$SERVERROOT.'/core/img/logo/logo.svg';
 	}
 
 	/**
@@ -222,7 +222,7 @@ 
 		$app = str_replace(['\0', '/', '\\', '..'], '', $app);
 		$image = str_replace(['\0', '\\', '..'], '', $image);
 		if ($app === "core") {
-			$icon = \OC::$SERVERROOT . '/core/img/' . $image;
+			$icon = \OC::$SERVERROOT.'/core/img/'.$image;
 			if (file_exists($icon)) {
 				return $icon;
 			}
@@ -234,23 +234,23 @@ 
 			return false;
 		}
 
-		$icon = $appPath . '/img/' . $image;
+		$icon = $appPath.'/img/'.$image;
 		if (file_exists($icon)) {
 			return $icon;
 		}
-		$icon = $appPath . '/img/' . $image . '.svg';
+		$icon = $appPath.'/img/'.$image.'.svg';
 		if (file_exists($icon)) {
 			return $icon;
 		}
-		$icon = $appPath . '/img/' . $image . '.png';
+		$icon = $appPath.'/img/'.$image.'.png';
 		if (file_exists($icon)) {
 			return $icon;
 		}
-		$icon = $appPath . '/img/' . $image . '.gif';
+		$icon = $appPath.'/img/'.$image.'.gif';
 		if (file_exists($icon)) {
 			return $icon;
 		}
-		$icon = $appPath . '/img/' . $image . '.jpg';
+		$icon = $appPath.'/img/'.$image.'.jpg';
 		if (file_exists($icon)) {
 			return $icon;
 		}

apps/theming/lib/ThemingDefaults.php

Indentation +417 added lines, -417 removed lines

@@ -52,421 +52,421 @@
 
 class ThemingDefaults extends \OC_Defaults {
 
-	/** @var IConfig */
-	private $config;
-	/** @var IL10N */
-	private $l;
-	/** @var ImageManager */
-	private $imageManager;
-	/** @var IURLGenerator */
-	private $urlGenerator;
-	/** @var ICacheFactory */
-	private $cacheFactory;
-	/** @var Util */
-	private $util;
-	/** @var IAppManager */
-	private $appManager;
-	/** @var INavigationManager */
-	private $navigationManager;
-
-	/** @var string */
-	private $name;
-	/** @var string */
-	private $title;
-	/** @var string */
-	private $entity;
-	/** @var string */
-	private $productName;
-	/** @var string */
-	private $url;
-	/** @var string */
-	private $color;
-
-	/** @var string */
-	private $iTunesAppId;
-	/** @var string */
-	private $iOSClientUrl;
-	/** @var string */
-	private $AndroidClientUrl;
-	/** @var string */
-	private $FDroidClientUrl;
-
-	/**
-	 * ThemingDefaults constructor.
-	 *
-	 * @param IConfig $config
-	 * @param IL10N $l
-	 * @param ImageManager $imageManager
-	 * @param IURLGenerator $urlGenerator
-	 * @param ICacheFactory $cacheFactory
-	 * @param Util $util
-	 * @param IAppManager $appManager
-	 */
-	public function __construct(IConfig $config,
-								IL10N $l,
-								IURLGenerator $urlGenerator,
-								ICacheFactory $cacheFactory,
-								Util $util,
-								ImageManager $imageManager,
-								IAppManager $appManager,
-								INavigationManager $navigationManager
-	) {
-		parent::__construct();
-		$this->config = $config;
-		$this->l = $l;
-		$this->imageManager = $imageManager;
-		$this->urlGenerator = $urlGenerator;
-		$this->cacheFactory = $cacheFactory;
-		$this->util = $util;
-		$this->appManager = $appManager;
-		$this->navigationManager = $navigationManager;
-
-		$this->name = parent::getName();
-		$this->title = parent::getTitle();
-		$this->entity = parent::getEntity();
-		$this->productName = parent::getProductName();
-		$this->url = parent::getBaseUrl();
-		$this->color = parent::getColorPrimary();
-		$this->iTunesAppId = parent::getiTunesAppId();
-		$this->iOSClientUrl = parent::getiOSClientUrl();
-		$this->AndroidClientUrl = parent::getAndroidClientUrl();
-		$this->FDroidClientUrl = parent::getFDroidClientUrl();
-	}
-
-	public function getName() {
-		return strip_tags($this->config->getAppValue('theming', 'name', $this->name));
-	}
-
-	public function getHTMLName() {
-		return $this->config->getAppValue('theming', 'name', $this->name);
-	}
-
-	public function getTitle() {
-		return strip_tags($this->config->getAppValue('theming', 'name', $this->title));
-	}
-
-	public function getEntity() {
-		return strip_tags($this->config->getAppValue('theming', 'name', $this->entity));
-	}
-
-	public function getProductName() {
-		return strip_tags($this->config->getAppValue('theming', 'productName', $this->productName));
-	}
-
-	public function getBaseUrl() {
-		return $this->config->getAppValue('theming', 'url', $this->url);
-	}
-
-	/**
-	 * We pass a string and sanitizeHTML will return a string too in that case
-	 * @psalm-suppress InvalidReturnStatement
-	 * @psalm-suppress InvalidReturnType
-	 */
-	public function getSlogan(?string $lang = null) {
-		return \OCP\Util::sanitizeHTML($this->config->getAppValue('theming', 'slogan', parent::getSlogan($lang)));
-	}
-
-	public function getImprintUrl() {
-		return (string)$this->config->getAppValue('theming', 'imprintUrl', '');
-	}
-
-	public function getPrivacyUrl() {
-		return (string)$this->config->getAppValue('theming', 'privacyUrl', '');
-	}
-
-	public function getShortFooter() {
-		$slogan = $this->getSlogan();
-		$baseUrl = $this->getBaseUrl();
-		if ($baseUrl !== '') {
-			$footer = '<a href="' . $baseUrl . '" target="_blank"' .
-				' rel="noreferrer noopener" class="entity-name">' . $this->getEntity() . '</a>';
-		} else {
-			$footer = '<span class="entity-name">' .$this->getEntity() . '</span>';
-		}
-		$footer .= ($slogan !== '' ? ' – ' . $slogan : '');
-
-		$links = [
-			[
-				'text' => $this->l->t('Legal notice'),
-				'url' => (string)$this->getImprintUrl()
-			],
-			[
-				'text' => $this->l->t('Privacy policy'),
-				'url' => (string)$this->getPrivacyUrl()
-			],
-		];
-
-		$navigation = $this->navigationManager->getAll(INavigationManager::TYPE_GUEST);
-		$guestNavigation = array_map(function ($nav) {
-			return [
-				'text' => $nav['name'],
-				'url' => $nav['href']
-			];
-		}, $navigation);
-		$links = array_merge($links, $guestNavigation);
-
-		$legalLinks = '';
-		$divider = '';
-		foreach ($links as $link) {
-			if ($link['url'] !== ''
-				&& filter_var($link['url'], FILTER_VALIDATE_URL)
-			) {
-				$legalLinks .= $divider . '<a href="' . $link['url'] . '" class="legal" target="_blank"' .
-					' rel="noreferrer noopener">' . $link['text'] . '</a>';
-				$divider = ' · ';
-			}
-		}
-		if ($legalLinks !== '') {
-			$footer .= '<br/>' . $legalLinks;
-		}
-
-		return $footer;
-	}
-
-	/**
-	 * Color that is used for the header as well as for mail headers
-	 *
-	 * @return string
-	 */
-	public function getColorPrimary() {
-		$color = $this->config->getAppValue('theming', 'color', $this->color);
-		if (!preg_match('/^\#([0-9a-f]{3}|[0-9a-f]{6})$/i', $color)) {
-			$color = '#0082c9';
-		}
-		return $color;
-	}
-
-	/**
-	 * Themed logo url
-	 *
-	 * @param bool $useSvg Whether to point to the SVG image or a fallback
-	 * @return string
-	 */
-	public function getLogo($useSvg = true): string {
-		$logo = $this->config->getAppValue('theming', 'logoMime', '');
-
-		// short cut to avoid setting up the filesystem just to check if the logo is there
-		//
-		// explanation: if an SVG is requested and the app config value for logoMime is set then the logo is there.
-		// otherwise we need to check it and maybe also generate a PNG from the SVG (that's done in getImage() which
-		// needs to be called then)
-		if ($useSvg === true && $logo !== false) {
-			$logoExists = true;
-		} else {
-			try {
-				$this->imageManager->getImage('logo', $useSvg);
-				$logoExists = true;
-			} catch (\Exception $e) {
-				$logoExists = false;
-			}
-		}
-
-		$cacheBusterCounter = $this->config->getAppValue('theming', 'cachebuster', '0');
-
-		if (!$logo || !$logoExists) {
-			if ($useSvg) {
-				$logo = $this->urlGenerator->imagePath('core', 'logo/logo.svg');
-			} else {
-				$logo = $this->urlGenerator->imagePath('core', 'logo/logo.png');
-			}
-			return $logo . '?v=' . $cacheBusterCounter;
-		}
-
-		return $this->urlGenerator->linkToRoute('theming.Theming.getImage', [ 'key' => 'logo', 'useSvg' => $useSvg, 'v' => $cacheBusterCounter ]);
-	}
-
-	/**
-	 * Themed background image url
-	 *
-	 * @return string
-	 */
-	public function getBackground(): string {
-		return $this->imageManager->getImageUrl('background');
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getiTunesAppId() {
-		return $this->config->getAppValue('theming', 'iTunesAppId', $this->iTunesAppId);
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getiOSClientUrl() {
-		return $this->config->getAppValue('theming', 'iOSClientUrl', $this->iOSClientUrl);
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getAndroidClientUrl() {
-		return $this->config->getAppValue('theming', 'AndroidClientUrl', $this->AndroidClientUrl);
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getFDroidClientUrl() {
-		return $this->config->getAppValue('theming', 'FDroidClientUrl', $this->FDroidClientUrl);
-	}
-
-	/**
-	 * @return array scss variables to overwrite
-	 */
-	public function getScssVariables() {
-		$cacheBuster = $this->config->getAppValue('theming', 'cachebuster', '0');
-		$cache = $this->cacheFactory->createDistributed('theming-' . $cacheBuster . '-' . $this->urlGenerator->getBaseUrl());
-		if ($value = $cache->get('getScssVariables')) {
-			return $value;
-		}
-
-		$variables = [
-			'theming-cachebuster' => "'" . $cacheBuster . "'",
-			'theming-logo-mime' => "'" . $this->config->getAppValue('theming', 'logoMime') . "'",
-			'theming-background-mime' => "'" . $this->config->getAppValue('theming', 'backgroundMime') . "'",
-			'theming-logoheader-mime' => "'" . $this->config->getAppValue('theming', 'logoheaderMime') . "'",
-			'theming-favicon-mime' => "'" . $this->config->getAppValue('theming', 'faviconMime') . "'"
-		];
-
-		$variables['image-logo'] = "url('".$this->imageManager->getImageUrl('logo')."')";
-		$variables['image-logoheader'] = "url('".$this->imageManager->getImageUrl('logoheader')."')";
-		$variables['image-favicon'] = "url('".$this->imageManager->getImageUrl('favicon')."')";
-		$variables['image-login-background'] = "url('".$this->imageManager->getImageUrl('background')."')";
-		$variables['image-login-plain'] = 'false';
-
-		if ($this->config->getAppValue('theming', 'color', '') !== '') {
-			$variables['color-primary'] = $this->getColorPrimary();
-			$variables['color-primary-text'] = $this->getTextColorPrimary();
-			$variables['color-primary-element'] = $this->util->elementColor($this->getColorPrimary());
-		}
-
-		if ($this->config->getAppValue('theming', 'backgroundMime', '') === 'backgroundColor') {
-			$variables['image-login-plain'] = 'true';
-		}
-
-		$variables['has-legal-links'] = 'false';
-		if ($this->getImprintUrl() !== '' || $this->getPrivacyUrl() !== '') {
-			$variables['has-legal-links'] = 'true';
-		}
-
-		$cache->set('getScssVariables', $variables);
-		return $variables;
-	}
-
-	/**
-	 * Check if the image should be replaced by the theming app
-	 * and return the new image location then
-	 *
-	 * @param string $app name of the app
-	 * @param string $image filename of the image
-	 * @return bool|string false if image should not replaced, otherwise the location of the image
-	 */
-	public function replaceImagePath($app, $image) {
-		if ($app === '' || $app === 'files_sharing') {
-			$app = 'core';
-		}
-		$cacheBusterValue = $this->config->getAppValue('theming', 'cachebuster', '0');
-
-		$route = false;
-		if ($image === 'favicon.ico' && ($this->imageManager->shouldReplaceIcons() || $this->getCustomFavicon() !== null)) {
-			$route = $this->urlGenerator->linkToRoute('theming.Icon.getFavicon', ['app' => $app]);
-		}
-		if (($image === 'favicon-touch.png' || $image === 'favicon-fb.png') && ($this->imageManager->shouldReplaceIcons() || $this->getCustomFavicon() !== null)) {
-			$route = $this->urlGenerator->linkToRoute('theming.Icon.getTouchIcon', ['app' => $app]);
-		}
-		if ($image === 'manifest.json') {
-			try {
-				$appPath = $this->appManager->getAppPath($app);
-				if (file_exists($appPath . '/img/manifest.json')) {
-					return false;
-				}
-			} catch (AppPathNotFoundException $e) {
-			}
-			$route = $this->urlGenerator->linkToRoute('theming.Theming.getManifest', ['app' => $app ]);
-		}
-		if (strpos($image, 'filetypes/') === 0 && file_exists(\OC::$SERVERROOT . '/core/img/' . $image)) {
-			$route = $this->urlGenerator->linkToRoute('theming.Icon.getThemedIcon', ['app' => $app, 'image' => $image]);
-		}
-
-		if ($route) {
-			return $route . '?v=' . $cacheBusterValue;
-		}
-
-		return false;
-	}
-
-	protected function getCustomFavicon(): ?ISimpleFile {
-		try {
-			return $this->imageManager->getImage('favicon');
-		} catch (NotFoundException $e) {
-			return null;
-		}
-	}
-
-	/**
-	 * Increases the cache buster key
-	 */
-	private function increaseCacheBuster(): void {
-		$cacheBusterKey = (int)$this->config->getAppValue('theming', 'cachebuster', '0');
-		$this->config->setAppValue('theming', 'cachebuster', (string)($cacheBusterKey + 1));
-		$this->cacheFactory->createDistributed('theming-')->clear();
-		$this->cacheFactory->createDistributed('imagePath')->clear();
-	}
-
-	/**
-	 * Update setting in the database
-	 *
-	 * @param string $setting
-	 * @param string $value
-	 */
-	public function set($setting, $value) {
-		$this->config->setAppValue('theming', $setting, $value);
-		$this->increaseCacheBuster();
-	}
-
-	/**
-	 * Revert settings to the default value
-	 *
-	 * @param string $setting setting which should be reverted
-	 * @return string default value
-	 */
-	public function undo($setting) {
-		$this->config->deleteAppValue('theming', $setting);
-		$this->increaseCacheBuster();
-
-		$returnValue = '';
-		switch ($setting) {
-			case 'name':
-				$returnValue = $this->getEntity();
-				break;
-			case 'url':
-				$returnValue = $this->getBaseUrl();
-				break;
-			case 'slogan':
-				$returnValue = $this->getSlogan();
-				break;
-			case 'color':
-				$returnValue = $this->getColorPrimary();
-				break;
-			case 'logo':
-			case 'logoheader':
-			case 'background':
-			case 'favicon':
-				$this->imageManager->delete($setting);
-				break;
-		}
-
-		return $returnValue;
-	}
-
-	/**
-	 * Color of text in the header and primary buttons
-	 *
-	 * @return string
-	 */
-	public function getTextColorPrimary() {
-		return $this->util->invertTextColor($this->getColorPrimary()) ? '#000000' : '#ffffff';
-	}
+    /** @var IConfig */
+    private $config;
+    /** @var IL10N */
+    private $l;
+    /** @var ImageManager */
+    private $imageManager;
+    /** @var IURLGenerator */
+    private $urlGenerator;
+    /** @var ICacheFactory */
+    private $cacheFactory;
+    /** @var Util */
+    private $util;
+    /** @var IAppManager */
+    private $appManager;
+    /** @var INavigationManager */
+    private $navigationManager;
+
+    /** @var string */
+    private $name;
+    /** @var string */
+    private $title;
+    /** @var string */
+    private $entity;
+    /** @var string */
+    private $productName;
+    /** @var string */
+    private $url;
+    /** @var string */
+    private $color;
+
+    /** @var string */
+    private $iTunesAppId;
+    /** @var string */
+    private $iOSClientUrl;
+    /** @var string */
+    private $AndroidClientUrl;
+    /** @var string */
+    private $FDroidClientUrl;
+
+    /**
+     * ThemingDefaults constructor.
+     *
+     * @param IConfig $config
+     * @param IL10N $l
+     * @param ImageManager $imageManager
+     * @param IURLGenerator $urlGenerator
+     * @param ICacheFactory $cacheFactory
+     * @param Util $util
+     * @param IAppManager $appManager
+     */
+    public function __construct(IConfig $config,
+                                IL10N $l,
+                                IURLGenerator $urlGenerator,
+                                ICacheFactory $cacheFactory,
+                                Util $util,
+                                ImageManager $imageManager,
+                                IAppManager $appManager,
+                                INavigationManager $navigationManager
+    ) {
+        parent::__construct();
+        $this->config = $config;
+        $this->l = $l;
+        $this->imageManager = $imageManager;
+        $this->urlGenerator = $urlGenerator;
+        $this->cacheFactory = $cacheFactory;
+        $this->util = $util;
+        $this->appManager = $appManager;
+        $this->navigationManager = $navigationManager;
+
+        $this->name = parent::getName();
+        $this->title = parent::getTitle();
+        $this->entity = parent::getEntity();
+        $this->productName = parent::getProductName();
+        $this->url = parent::getBaseUrl();
+        $this->color = parent::getColorPrimary();
+        $this->iTunesAppId = parent::getiTunesAppId();
+        $this->iOSClientUrl = parent::getiOSClientUrl();
+        $this->AndroidClientUrl = parent::getAndroidClientUrl();
+        $this->FDroidClientUrl = parent::getFDroidClientUrl();
+    }
+
+    public function getName() {
+        return strip_tags($this->config->getAppValue('theming', 'name', $this->name));
+    }
+
+    public function getHTMLName() {
+        return $this->config->getAppValue('theming', 'name', $this->name);
+    }
+
+    public function getTitle() {
+        return strip_tags($this->config->getAppValue('theming', 'name', $this->title));
+    }
+
+    public function getEntity() {
+        return strip_tags($this->config->getAppValue('theming', 'name', $this->entity));
+    }
+
+    public function getProductName() {
+        return strip_tags($this->config->getAppValue('theming', 'productName', $this->productName));
+    }
+
+    public function getBaseUrl() {
+        return $this->config->getAppValue('theming', 'url', $this->url);
+    }
+
+    /**
+     * We pass a string and sanitizeHTML will return a string too in that case
+     * @psalm-suppress InvalidReturnStatement
+     * @psalm-suppress InvalidReturnType
+     */
+    public function getSlogan(?string $lang = null) {
+        return \OCP\Util::sanitizeHTML($this->config->getAppValue('theming', 'slogan', parent::getSlogan($lang)));
+    }
+
+    public function getImprintUrl() {
+        return (string)$this->config->getAppValue('theming', 'imprintUrl', '');
+    }
+
+    public function getPrivacyUrl() {
+        return (string)$this->config->getAppValue('theming', 'privacyUrl', '');
+    }
+
+    public function getShortFooter() {
+        $slogan = $this->getSlogan();
+        $baseUrl = $this->getBaseUrl();
+        if ($baseUrl !== '') {
+            $footer = '<a href="' . $baseUrl . '" target="_blank"' .
+                ' rel="noreferrer noopener" class="entity-name">' . $this->getEntity() . '</a>';
+        } else {
+            $footer = '<span class="entity-name">' .$this->getEntity() . '</span>';
+        }
+        $footer .= ($slogan !== '' ? ' – ' . $slogan : '');
+
+        $links = [
+            [
+                'text' => $this->l->t('Legal notice'),
+                'url' => (string)$this->getImprintUrl()
+            ],
+            [
+                'text' => $this->l->t('Privacy policy'),
+                'url' => (string)$this->getPrivacyUrl()
+            ],
+        ];
+
+        $navigation = $this->navigationManager->getAll(INavigationManager::TYPE_GUEST);
+        $guestNavigation = array_map(function ($nav) {
+            return [
+                'text' => $nav['name'],
+                'url' => $nav['href']
+            ];
+        }, $navigation);
+        $links = array_merge($links, $guestNavigation);
+
+        $legalLinks = '';
+        $divider = '';
+        foreach ($links as $link) {
+            if ($link['url'] !== ''
+                && filter_var($link['url'], FILTER_VALIDATE_URL)
+            ) {
+                $legalLinks .= $divider . '<a href="' . $link['url'] . '" class="legal" target="_blank"' .
+                    ' rel="noreferrer noopener">' . $link['text'] . '</a>';
+                $divider = ' · ';
+            }
+        }
+        if ($legalLinks !== '') {
+            $footer .= '<br/>' . $legalLinks;
+        }
+
+        return $footer;
+    }
+
+    /**
+     * Color that is used for the header as well as for mail headers
+     *
+     * @return string
+     */
+    public function getColorPrimary() {
+        $color = $this->config->getAppValue('theming', 'color', $this->color);
+        if (!preg_match('/^\#([0-9a-f]{3}|[0-9a-f]{6})$/i', $color)) {
+            $color = '#0082c9';
+        }
+        return $color;
+    }
+
+    /**
+     * Themed logo url
+     *
+     * @param bool $useSvg Whether to point to the SVG image or a fallback
+     * @return string
+     */
+    public function getLogo($useSvg = true): string {
+        $logo = $this->config->getAppValue('theming', 'logoMime', '');
+
+        // short cut to avoid setting up the filesystem just to check if the logo is there
+        //
+        // explanation: if an SVG is requested and the app config value for logoMime is set then the logo is there.
+        // otherwise we need to check it and maybe also generate a PNG from the SVG (that's done in getImage() which
+        // needs to be called then)
+        if ($useSvg === true && $logo !== false) {
+            $logoExists = true;
+        } else {
+            try {
+                $this->imageManager->getImage('logo', $useSvg);
+                $logoExists = true;
+            } catch (\Exception $e) {
+                $logoExists = false;
+            }
+        }
+
+        $cacheBusterCounter = $this->config->getAppValue('theming', 'cachebuster', '0');
+
+        if (!$logo || !$logoExists) {
+            if ($useSvg) {
+                $logo = $this->urlGenerator->imagePath('core', 'logo/logo.svg');
+            } else {
+                $logo = $this->urlGenerator->imagePath('core', 'logo/logo.png');
+            }
+            return $logo . '?v=' . $cacheBusterCounter;
+        }
+
+        return $this->urlGenerator->linkToRoute('theming.Theming.getImage', [ 'key' => 'logo', 'useSvg' => $useSvg, 'v' => $cacheBusterCounter ]);
+    }
+
+    /**
+     * Themed background image url
+     *
+     * @return string
+     */
+    public function getBackground(): string {
+        return $this->imageManager->getImageUrl('background');
+    }
+
+    /**
+     * @return string
+     */
+    public function getiTunesAppId() {
+        return $this->config->getAppValue('theming', 'iTunesAppId', $this->iTunesAppId);
+    }
+
+    /**
+     * @return string
+     */
+    public function getiOSClientUrl() {
+        return $this->config->getAppValue('theming', 'iOSClientUrl', $this->iOSClientUrl);
+    }
+
+    /**
+     * @return string
+     */
+    public function getAndroidClientUrl() {
+        return $this->config->getAppValue('theming', 'AndroidClientUrl', $this->AndroidClientUrl);
+    }
+
+    /**
+     * @return string
+     */
+    public function getFDroidClientUrl() {
+        return $this->config->getAppValue('theming', 'FDroidClientUrl', $this->FDroidClientUrl);
+    }
+
+    /**
+     * @return array scss variables to overwrite
+     */
+    public function getScssVariables() {
+        $cacheBuster = $this->config->getAppValue('theming', 'cachebuster', '0');
+        $cache = $this->cacheFactory->createDistributed('theming-' . $cacheBuster . '-' . $this->urlGenerator->getBaseUrl());
+        if ($value = $cache->get('getScssVariables')) {
+            return $value;
+        }
+
+        $variables = [
+            'theming-cachebuster' => "'" . $cacheBuster . "'",
+            'theming-logo-mime' => "'" . $this->config->getAppValue('theming', 'logoMime') . "'",
+            'theming-background-mime' => "'" . $this->config->getAppValue('theming', 'backgroundMime') . "'",
+            'theming-logoheader-mime' => "'" . $this->config->getAppValue('theming', 'logoheaderMime') . "'",
+            'theming-favicon-mime' => "'" . $this->config->getAppValue('theming', 'faviconMime') . "'"
+        ];
+
+        $variables['image-logo'] = "url('".$this->imageManager->getImageUrl('logo')."')";
+        $variables['image-logoheader'] = "url('".$this->imageManager->getImageUrl('logoheader')."')";
+        $variables['image-favicon'] = "url('".$this->imageManager->getImageUrl('favicon')."')";
+        $variables['image-login-background'] = "url('".$this->imageManager->getImageUrl('background')."')";
+        $variables['image-login-plain'] = 'false';
+
+        if ($this->config->getAppValue('theming', 'color', '') !== '') {
+            $variables['color-primary'] = $this->getColorPrimary();
+            $variables['color-primary-text'] = $this->getTextColorPrimary();
+            $variables['color-primary-element'] = $this->util->elementColor($this->getColorPrimary());
+        }
+
+        if ($this->config->getAppValue('theming', 'backgroundMime', '') === 'backgroundColor') {
+            $variables['image-login-plain'] = 'true';
+        }
+
+        $variables['has-legal-links'] = 'false';
+        if ($this->getImprintUrl() !== '' || $this->getPrivacyUrl() !== '') {
+            $variables['has-legal-links'] = 'true';
+        }
+
+        $cache->set('getScssVariables', $variables);
+        return $variables;
+    }
+
+    /**
+     * Check if the image should be replaced by the theming app
+     * and return the new image location then
+     *
+     * @param string $app name of the app
+     * @param string $image filename of the image
+     * @return bool|string false if image should not replaced, otherwise the location of the image
+     */
+    public function replaceImagePath($app, $image) {
+        if ($app === '' || $app === 'files_sharing') {
+            $app = 'core';
+        }
+        $cacheBusterValue = $this->config->getAppValue('theming', 'cachebuster', '0');
+
+        $route = false;
+        if ($image === 'favicon.ico' && ($this->imageManager->shouldReplaceIcons() || $this->getCustomFavicon() !== null)) {
+            $route = $this->urlGenerator->linkToRoute('theming.Icon.getFavicon', ['app' => $app]);
+        }
+        if (($image === 'favicon-touch.png' || $image === 'favicon-fb.png') && ($this->imageManager->shouldReplaceIcons() || $this->getCustomFavicon() !== null)) {
+            $route = $this->urlGenerator->linkToRoute('theming.Icon.getTouchIcon', ['app' => $app]);
+        }
+        if ($image === 'manifest.json') {
+            try {
+                $appPath = $this->appManager->getAppPath($app);
+                if (file_exists($appPath . '/img/manifest.json')) {
+                    return false;
+                }
+            } catch (AppPathNotFoundException $e) {
+            }
+            $route = $this->urlGenerator->linkToRoute('theming.Theming.getManifest', ['app' => $app ]);
+        }
+        if (strpos($image, 'filetypes/') === 0 && file_exists(\OC::$SERVERROOT . '/core/img/' . $image)) {
+            $route = $this->urlGenerator->linkToRoute('theming.Icon.getThemedIcon', ['app' => $app, 'image' => $image]);
+        }
+
+        if ($route) {
+            return $route . '?v=' . $cacheBusterValue;
+        }
+
+        return false;
+    }
+
+    protected function getCustomFavicon(): ?ISimpleFile {
+        try {
+            return $this->imageManager->getImage('favicon');
+        } catch (NotFoundException $e) {
+            return null;
+        }
+    }
+
+    /**
+     * Increases the cache buster key
+     */
+    private function increaseCacheBuster(): void {
+        $cacheBusterKey = (int)$this->config->getAppValue('theming', 'cachebuster', '0');
+        $this->config->setAppValue('theming', 'cachebuster', (string)($cacheBusterKey + 1));
+        $this->cacheFactory->createDistributed('theming-')->clear();
+        $this->cacheFactory->createDistributed('imagePath')->clear();
+    }
+
+    /**
+     * Update setting in the database
+     *
+     * @param string $setting
+     * @param string $value
+     */
+    public function set($setting, $value) {
+        $this->config->setAppValue('theming', $setting, $value);
+        $this->increaseCacheBuster();
+    }
+
+    /**
+     * Revert settings to the default value
+     *
+     * @param string $setting setting which should be reverted
+     * @return string default value
+     */
+    public function undo($setting) {
+        $this->config->deleteAppValue('theming', $setting);
+        $this->increaseCacheBuster();
+
+        $returnValue = '';
+        switch ($setting) {
+            case 'name':
+                $returnValue = $this->getEntity();
+                break;
+            case 'url':
+                $returnValue = $this->getBaseUrl();
+                break;
+            case 'slogan':
+                $returnValue = $this->getSlogan();
+                break;
+            case 'color':
+                $returnValue = $this->getColorPrimary();
+                break;
+            case 'logo':
+            case 'logoheader':
+            case 'background':
+            case 'favicon':
+                $this->imageManager->delete($setting);
+                break;
+        }
+
+        return $returnValue;
+    }
+
+    /**
+     * Color of text in the header and primary buttons
+     *
+     * @return string
+     */
+    public function getTextColorPrimary() {
+        return $this->util->invertTextColor($this->getColorPrimary()) ? '#000000' : '#ffffff';
+    }
 }

Spacing +26 added lines, -26 removed lines

@@ -167,37 +167,37 @@ 
 	}
 
 	public function getImprintUrl() {
-		return (string)$this->config->getAppValue('theming', 'imprintUrl', '');
+		return (string) $this->config->getAppValue('theming', 'imprintUrl', '');
 	}
 
 	public function getPrivacyUrl() {
-		return (string)$this->config->getAppValue('theming', 'privacyUrl', '');
+		return (string) $this->config->getAppValue('theming', 'privacyUrl', '');
 	}
 
 	public function getShortFooter() {
 		$slogan = $this->getSlogan();
 		$baseUrl = $this->getBaseUrl();
 		if ($baseUrl !== '') {
-			$footer = '<a href="' . $baseUrl . '" target="_blank"' .
-				' rel="noreferrer noopener" class="entity-name">' . $this->getEntity() . '</a>';
+			$footer = '<a href="'.$baseUrl.'" target="_blank"'.
+				' rel="noreferrer noopener" class="entity-name">'.$this->getEntity().'</a>';
 		} else {
-			$footer = '<span class="entity-name">' .$this->getEntity() . '</span>';
+			$footer = '<span class="entity-name">'.$this->getEntity().'</span>';
 		}
-		$footer .= ($slogan !== '' ? ' – ' . $slogan : '');
+		$footer .= ($slogan !== '' ? ' – '.$slogan : '');
 
 		$links = [
 			[
 				'text' => $this->l->t('Legal notice'),
-				'url' => (string)$this->getImprintUrl()
+				'url' => (string) $this->getImprintUrl()
 			],
 			[
 				'text' => $this->l->t('Privacy policy'),
-				'url' => (string)$this->getPrivacyUrl()
+				'url' => (string) $this->getPrivacyUrl()
 			],
 		];
 
 		$navigation = $this->navigationManager->getAll(INavigationManager::TYPE_GUEST);
-		$guestNavigation = array_map(function ($nav) {
+		$guestNavigation = array_map(function($nav) {
 			return [
 				'text' => $nav['name'],
 				'url' => $nav['href']
@@ -211,13 +211,13 @@ 
 			if ($link['url'] !== ''
 				&& filter_var($link['url'], FILTER_VALIDATE_URL)
 			) {
-				$legalLinks .= $divider . '<a href="' . $link['url'] . '" class="legal" target="_blank"' .
-					' rel="noreferrer noopener">' . $link['text'] . '</a>';
+				$legalLinks .= $divider.'<a href="'.$link['url'].'" class="legal" target="_blank"'.
+					' rel="noreferrer noopener">'.$link['text'].'</a>';
 				$divider = ' · ';
 			}
 		}
 		if ($legalLinks !== '') {
-			$footer .= '<br/>' . $legalLinks;
+			$footer .= '<br/>'.$legalLinks;
 		}
 
 		return $footer;
@@ -269,10 +269,10 @@ 
 			} else {
 				$logo = $this->urlGenerator->imagePath('core', 'logo/logo.png');
 			}
-			return $logo . '?v=' . $cacheBusterCounter;
+			return $logo.'?v='.$cacheBusterCounter;
 		}
 
-		return $this->urlGenerator->linkToRoute('theming.Theming.getImage', [ 'key' => 'logo', 'useSvg' => $useSvg, 'v' => $cacheBusterCounter ]);
+		return $this->urlGenerator->linkToRoute('theming.Theming.getImage', ['key' => 'logo', 'useSvg' => $useSvg, 'v' => $cacheBusterCounter]);
 	}
 
 	/**
@@ -317,17 +317,17 @@ 
 	 */
 	public function getScssVariables() {
 		$cacheBuster = $this->config->getAppValue('theming', 'cachebuster', '0');
-		$cache = $this->cacheFactory->createDistributed('theming-' . $cacheBuster . '-' . $this->urlGenerator->getBaseUrl());
+		$cache = $this->cacheFactory->createDistributed('theming-'.$cacheBuster.'-'.$this->urlGenerator->getBaseUrl());
 		if ($value = $cache->get('getScssVariables')) {
 			return $value;
 		}
 
 		$variables = [
-			'theming-cachebuster' => "'" . $cacheBuster . "'",
-			'theming-logo-mime' => "'" . $this->config->getAppValue('theming', 'logoMime') . "'",
-			'theming-background-mime' => "'" . $this->config->getAppValue('theming', 'backgroundMime') . "'",
-			'theming-logoheader-mime' => "'" . $this->config->getAppValue('theming', 'logoheaderMime') . "'",
-			'theming-favicon-mime' => "'" . $this->config->getAppValue('theming', 'faviconMime') . "'"
+			'theming-cachebuster' => "'".$cacheBuster."'",
+			'theming-logo-mime' => "'".$this->config->getAppValue('theming', 'logoMime')."'",
+			'theming-background-mime' => "'".$this->config->getAppValue('theming', 'backgroundMime')."'",
+			'theming-logoheader-mime' => "'".$this->config->getAppValue('theming', 'logoheaderMime')."'",
+			'theming-favicon-mime' => "'".$this->config->getAppValue('theming', 'faviconMime')."'"
 		];
 
 		$variables['image-logo'] = "url('".$this->imageManager->getImageUrl('logo')."')";
@@ -379,19 +379,19 @@ 
 		if ($image === 'manifest.json') {
 			try {
 				$appPath = $this->appManager->getAppPath($app);
-				if (file_exists($appPath . '/img/manifest.json')) {
+				if (file_exists($appPath.'/img/manifest.json')) {
 					return false;
 				}
 			} catch (AppPathNotFoundException $e) {
 			}
-			$route = $this->urlGenerator->linkToRoute('theming.Theming.getManifest', ['app' => $app ]);
+			$route = $this->urlGenerator->linkToRoute('theming.Theming.getManifest', ['app' => $app]);
 		}
-		if (strpos($image, 'filetypes/') === 0 && file_exists(\OC::$SERVERROOT . '/core/img/' . $image)) {
+		if (strpos($image, 'filetypes/') === 0 && file_exists(\OC::$SERVERROOT.'/core/img/'.$image)) {
 			$route = $this->urlGenerator->linkToRoute('theming.Icon.getThemedIcon', ['app' => $app, 'image' => $image]);
 		}
 
 		if ($route) {
-			return $route . '?v=' . $cacheBusterValue;
+			return $route.'?v='.$cacheBusterValue;
 		}
 
 		return false;
@@ -409,8 +409,8 @@ 
 	 * Increases the cache buster key
 	 */
 	private function increaseCacheBuster(): void {
-		$cacheBusterKey = (int)$this->config->getAppValue('theming', 'cachebuster', '0');
-		$this->config->setAppValue('theming', 'cachebuster', (string)($cacheBusterKey + 1));
+		$cacheBusterKey = (int) $this->config->getAppValue('theming', 'cachebuster', '0');
+		$this->config->setAppValue('theming', 'cachebuster', (string) ($cacheBusterKey + 1));
 		$this->cacheFactory->createDistributed('theming-')->clear();
 		$this->cacheFactory->createDistributed('imagePath')->clear();
 	}

apps/theming/lib/Command/UpdateConfig.php

Indentation +106 added lines, -106 removed lines

@@ -32,110 +32,110 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 class UpdateConfig extends Command {
-	public const SUPPORTED_KEYS = [
-		'name', 'url', 'imprintUrl', 'privacyUrl', 'slogan', 'color'
-	];
-
-	public const SUPPORTED_IMAGE_KEYS = [
-		'background', 'logo', 'favicon', 'logoheader'
-	];
-
-	private $themingDefaults;
-	private $imageManager;
-	private $config;
-
-	public function __construct(ThemingDefaults $themingDefaults, ImageManager $imageManager, IConfig $config) {
-		parent::__construct();
-
-		$this->themingDefaults = $themingDefaults;
-		$this->imageManager = $imageManager;
-		$this->config = $config;
-	}
-
-	protected function configure() {
-		$this
-			->setName('theming:config')
-			->setDescription('Set theming app config values')
-			->addArgument(
-				'key',
-				InputArgument::OPTIONAL,
-				'Key to update the theming app configuration (leave empty to get a list of all configured values)' . PHP_EOL .
-				'One of: ' . implode(', ', self::SUPPORTED_KEYS)
-			)
-			->addArgument(
-				'value',
-				InputArgument::OPTIONAL,
-				'Value to set (leave empty to obtain the current value)'
-			)
-			->addOption(
-				'reset',
-				'r',
-				InputOption::VALUE_NONE,
-				'Reset the given config key to default'
-			);
-	}
-
-
-	protected function execute(InputInterface $input, OutputInterface $output): int {
-		$key = $input->getArgument('key');
-		$value = $input->getArgument('value');
-		assert(is_string($value) || $value === null, 'At most one value should be provided.');
-
-		if ($key === null) {
-			$output->writeln('Current theming config:');
-			foreach (self::SUPPORTED_KEYS as $key) {
-				$value = $this->config->getAppValue('theming', $key, '');
-				$output->writeln('- ' . $key . ': ' . $value . '');
-			}
-			foreach (self::SUPPORTED_IMAGE_KEYS as $key) {
-				$value = $this->config->getAppValue('theming', $key . 'Mime', '');
-				$output->writeln('- ' . $key . ': ' . $value . '');
-			}
-			return 0;
-		}
-
-		if (!in_array($key, self::SUPPORTED_KEYS, true) && !in_array($key, self::SUPPORTED_IMAGE_KEYS, true)) {
-			$output->writeln('<error>Invalid config key provided</error>');
-			return 1;
-		}
-
-		if ($input->getOption('reset')) {
-			$defaultValue = $this->themingDefaults->undo($key);
-			$output->writeln('<info>Reset ' . $key . ' to ' . $defaultValue . '</info>');
-			return 0;
-		}
-
-		if ($value === null) {
-			$value = $this->config->getAppValue('theming', $key, '');
-			if ($value !== '') {
-				$output->writeln('<info>' . $key . ' is currently set to ' . $value . '</info>');
-			} else {
-				$output->writeln('<info>' . $key . ' is currently not set</info>');
-			}
-			return 0;
-		}
-
-		if (in_array($key, self::SUPPORTED_IMAGE_KEYS, true)) {
-			if (strpos($value, '/') !== 0) {
-				$output->writeln('<error>The image file needs to be provided as an absolute path: ' . $value . '.</error>');
-				return 1;
-			}
-			if (!file_exists($value)) {
-				$output->writeln('<error>File could not be found: ' . $value . '.</error>');
-				return 1;
-			}
-			$value = $this->imageManager->updateImage($key, $value);
-			$key = $key . 'Mime';
-		}
-
-		if ($key === 'color' && !preg_match('/^\#([0-9a-f]{3}|[0-9a-f]{6})$/i', $value)) {
-			$output->writeln('<error>The given color is invalid: ' . $value . '</error>');
-			return 1;
-		}
-
-		$this->themingDefaults->set($key, $value);
-		$output->writeln('<info>Updated ' . $key . ' to ' . $value . '</info>');
-
-		return 0;
-	}
+    public const SUPPORTED_KEYS = [
+        'name', 'url', 'imprintUrl', 'privacyUrl', 'slogan', 'color'
+    ];
+
+    public const SUPPORTED_IMAGE_KEYS = [
+        'background', 'logo', 'favicon', 'logoheader'
+    ];
+
+    private $themingDefaults;
+    private $imageManager;
+    private $config;
+
+    public function __construct(ThemingDefaults $themingDefaults, ImageManager $imageManager, IConfig $config) {
+        parent::__construct();
+
+        $this->themingDefaults = $themingDefaults;
+        $this->imageManager = $imageManager;
+        $this->config = $config;
+    }
+
+    protected function configure() {
+        $this
+            ->setName('theming:config')
+            ->setDescription('Set theming app config values')
+            ->addArgument(
+                'key',
+                InputArgument::OPTIONAL,
+                'Key to update the theming app configuration (leave empty to get a list of all configured values)' . PHP_EOL .
+                'One of: ' . implode(', ', self::SUPPORTED_KEYS)
+            )
+            ->addArgument(
+                'value',
+                InputArgument::OPTIONAL,
+                'Value to set (leave empty to obtain the current value)'
+            )
+            ->addOption(
+                'reset',
+                'r',
+                InputOption::VALUE_NONE,
+                'Reset the given config key to default'
+            );
+    }
+
+
+    protected function execute(InputInterface $input, OutputInterface $output): int {
+        $key = $input->getArgument('key');
+        $value = $input->getArgument('value');
+        assert(is_string($value) || $value === null, 'At most one value should be provided.');
+
+        if ($key === null) {
+            $output->writeln('Current theming config:');
+            foreach (self::SUPPORTED_KEYS as $key) {
+                $value = $this->config->getAppValue('theming', $key, '');
+                $output->writeln('- ' . $key . ': ' . $value . '');
+            }
+            foreach (self::SUPPORTED_IMAGE_KEYS as $key) {
+                $value = $this->config->getAppValue('theming', $key . 'Mime', '');
+                $output->writeln('- ' . $key . ': ' . $value . '');
+            }
+            return 0;
+        }
+
+        if (!in_array($key, self::SUPPORTED_KEYS, true) && !in_array($key, self::SUPPORTED_IMAGE_KEYS, true)) {
+            $output->writeln('<error>Invalid config key provided</error>');
+            return 1;
+        }
+
+        if ($input->getOption('reset')) {
+            $defaultValue = $this->themingDefaults->undo($key);
+            $output->writeln('<info>Reset ' . $key . ' to ' . $defaultValue . '</info>');
+            return 0;
+        }
+
+        if ($value === null) {
+            $value = $this->config->getAppValue('theming', $key, '');
+            if ($value !== '') {
+                $output->writeln('<info>' . $key . ' is currently set to ' . $value . '</info>');
+            } else {
+                $output->writeln('<info>' . $key . ' is currently not set</info>');
+            }
+            return 0;
+        }
+
+        if (in_array($key, self::SUPPORTED_IMAGE_KEYS, true)) {
+            if (strpos($value, '/') !== 0) {
+                $output->writeln('<error>The image file needs to be provided as an absolute path: ' . $value . '.</error>');
+                return 1;
+            }
+            if (!file_exists($value)) {
+                $output->writeln('<error>File could not be found: ' . $value . '.</error>');
+                return 1;
+            }
+            $value = $this->imageManager->updateImage($key, $value);
+            $key = $key . 'Mime';
+        }
+
+        if ($key === 'color' && !preg_match('/^\#([0-9a-f]{3}|[0-9a-f]{6})$/i', $value)) {
+            $output->writeln('<error>The given color is invalid: ' . $value . '</error>');
+            return 1;
+        }
+
+        $this->themingDefaults->set($key, $value);
+        $output->writeln('<info>Updated ' . $key . ' to ' . $value . '</info>');
+
+        return 0;
+    }
 }

apps/testing/lib/Controller/LockingController.php

Indentation +179 added lines, -179 removed lines

@@ -39,183 +39,183 @@
 
 class LockingController extends OCSController {
 
-	/** @var ILockingProvider */
-	protected $lockingProvider;
-
-	/** @var FakeDBLockingProvider */
-	protected $fakeDBLockingProvider;
-
-	/** @var IDBConnection */
-	protected $connection;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var IRootFolder */
-	protected $rootFolder;
-
-	/**
-	 * @param string $appName
-	 * @param IRequest $request
-	 * @param ILockingProvider $lockingProvider
-	 * @param FakeDBLockingProvider $fakeDBLockingProvider
-	 * @param IDBConnection $connection
-	 * @param IConfig $config
-	 * @param IRootFolder $rootFolder
-	 */
-	public function __construct($appName,
-								IRequest $request,
-								ILockingProvider $lockingProvider,
-								FakeDBLockingProvider $fakeDBLockingProvider,
-								IDBConnection $connection,
-								IConfig $config,
-								IRootFolder $rootFolder) {
-		parent::__construct($appName, $request);
-
-		$this->lockingProvider = $lockingProvider;
-		$this->fakeDBLockingProvider = $fakeDBLockingProvider;
-		$this->connection = $connection;
-		$this->config = $config;
-		$this->rootFolder = $rootFolder;
-	}
-
-	/**
-	 * @throws \RuntimeException
-	 */
-	protected function getLockingProvider(): ILockingProvider {
-		if ($this->lockingProvider instanceof DBLockingProvider) {
-			return $this->fakeDBLockingProvider;
-		}
-		throw new \RuntimeException('Lock provisioning is only possible using the DBLockingProvider');
-	}
-
-	/**
-	 * @throws NotFoundException
-	 */
-	protected function getPath(string $user, string $path): string {
-		$node = $this->rootFolder->getUserFolder($user)->get($path);
-		return 'files/' . md5($node->getStorage()->getId() . '::' . trim($node->getInternalPath(), '/'));
-	}
-
-	/**
-	 * @throws OCSException
-	 */
-	public function isLockingEnabled(): DataResponse {
-		try {
-			$this->getLockingProvider();
-			return new DataResponse();
-		} catch (\RuntimeException $e) {
-			throw new OCSException($e->getMessage(), Http::STATUS_NOT_IMPLEMENTED, $e);
-		}
-	}
-
-	/**
-	 * @throws OCSException
-	 */
-	public function acquireLock(int $type, string $user, string $path): DataResponse {
-		try {
-			$path = $this->getPath($user, $path);
-		} catch (NoUserException $e) {
-			throw new OCSException('User not found', Http::STATUS_NOT_FOUND, $e);
-		} catch (NotFoundException $e) {
-			throw new OCSException('Path not found', Http::STATUS_NOT_FOUND, $e);
-		}
-
-		$lockingProvider = $this->getLockingProvider();
-
-		try {
-			$lockingProvider->acquireLock($path, $type);
-			$this->config->setAppValue('testing', 'locking_' . $path, (string)$type);
-			return new DataResponse();
-		} catch (LockedException $e) {
-			throw new OCSException('', Http::STATUS_LOCKED, $e);
-		}
-	}
-
-	/**
-	 * @throws OCSException
-	 */
-	public function changeLock(int $type, string $user, string $path): DataResponse {
-		try {
-			$path = $this->getPath($user, $path);
-		} catch (NoUserException $e) {
-			throw new OCSException('User not found', Http::STATUS_NOT_FOUND, $e);
-		} catch (NotFoundException $e) {
-			throw new OCSException('Path not found', Http::STATUS_NOT_FOUND, $e);
-		}
-
-		$lockingProvider = $this->getLockingProvider();
-
-		try {
-			$lockingProvider->changeLock($path, $type);
-			$this->config->setAppValue('testing', 'locking_' . $path, (string)$type);
-			return new DataResponse();
-		} catch (LockedException $e) {
-			throw new OCSException('', Http::STATUS_LOCKED, $e);
-		}
-	}
-
-	/**
-	 * @throws OCSException
-	 */
-	public function releaseLock(int $type, string $user, string $path): DataResponse {
-		try {
-			$path = $this->getPath($user, $path);
-		} catch (NoUserException $e) {
-			throw new OCSException('User not found', Http::STATUS_NOT_FOUND, $e);
-		} catch (NotFoundException $e) {
-			throw new OCSException('Path not found', Http::STATUS_NOT_FOUND, $e);
-		}
-
-		$lockingProvider = $this->getLockingProvider();
-
-		try {
-			$lockingProvider->releaseLock($path, $type);
-			$this->config->deleteAppValue('testing', 'locking_' . $path);
-			return new DataResponse();
-		} catch (LockedException $e) {
-			throw new OCSException('', Http::STATUS_LOCKED, $e);
-		}
-	}
-
-	/**
-	 * @throws OCSException
-	 */
-	public function isLocked(int $type, string $user, string $path): DataResponse {
-		try {
-			$path = $this->getPath($user, $path);
-		} catch (NoUserException $e) {
-			throw new OCSException('User not found', Http::STATUS_NOT_FOUND, $e);
-		} catch (NotFoundException $e) {
-			throw new OCSException('Path not found', Http::STATUS_NOT_FOUND, $e);
-		}
-
-		$lockingProvider = $this->getLockingProvider();
-
-		if ($lockingProvider->isLocked($path, $type)) {
-			return new DataResponse();
-		}
-
-		throw new OCSException('', Http::STATUS_LOCKED);
-	}
-
-	public function releaseAll(int $type = null): DataResponse {
-		$lockingProvider = $this->getLockingProvider();
-
-		foreach ($this->config->getAppKeys('testing') as $lock) {
-			if (strpos($lock, 'locking_') === 0) {
-				$path = substr($lock, strlen('locking_'));
-
-				if ($type === ILockingProvider::LOCK_EXCLUSIVE && (int)$this->config->getAppValue('testing', $lock) === ILockingProvider::LOCK_EXCLUSIVE) {
-					$lockingProvider->releaseLock($path, (int)$this->config->getAppValue('testing', $lock));
-				} elseif ($type === ILockingProvider::LOCK_SHARED && (int)$this->config->getAppValue('testing', $lock) === ILockingProvider::LOCK_SHARED) {
-					$lockingProvider->releaseLock($path, (int)$this->config->getAppValue('testing', $lock));
-				} else {
-					$lockingProvider->releaseLock($path, (int)$this->config->getAppValue('testing', $lock));
-				}
-			}
-		}
-
-		return new DataResponse();
-	}
+    /** @var ILockingProvider */
+    protected $lockingProvider;
+
+    /** @var FakeDBLockingProvider */
+    protected $fakeDBLockingProvider;
+
+    /** @var IDBConnection */
+    protected $connection;
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var IRootFolder */
+    protected $rootFolder;
+
+    /**
+     * @param string $appName
+     * @param IRequest $request
+     * @param ILockingProvider $lockingProvider
+     * @param FakeDBLockingProvider $fakeDBLockingProvider
+     * @param IDBConnection $connection
+     * @param IConfig $config
+     * @param IRootFolder $rootFolder
+     */
+    public function __construct($appName,
+                                IRequest $request,
+                                ILockingProvider $lockingProvider,
+                                FakeDBLockingProvider $fakeDBLockingProvider,
+                                IDBConnection $connection,
+                                IConfig $config,
+                                IRootFolder $rootFolder) {
+        parent::__construct($appName, $request);
+
+        $this->lockingProvider = $lockingProvider;
+        $this->fakeDBLockingProvider = $fakeDBLockingProvider;
+        $this->connection = $connection;
+        $this->config = $config;
+        $this->rootFolder = $rootFolder;
+    }
+
+    /**
+     * @throws \RuntimeException
+     */
+    protected function getLockingProvider(): ILockingProvider {
+        if ($this->lockingProvider instanceof DBLockingProvider) {
+            return $this->fakeDBLockingProvider;
+        }
+        throw new \RuntimeException('Lock provisioning is only possible using the DBLockingProvider');
+    }
+
+    /**
+     * @throws NotFoundException
+     */
+    protected function getPath(string $user, string $path): string {
+        $node = $this->rootFolder->getUserFolder($user)->get($path);
+        return 'files/' . md5($node->getStorage()->getId() . '::' . trim($node->getInternalPath(), '/'));
+    }
+
+    /**
+     * @throws OCSException
+     */
+    public function isLockingEnabled(): DataResponse {
+        try {
+            $this->getLockingProvider();
+            return new DataResponse();
+        } catch (\RuntimeException $e) {
+            throw new OCSException($e->getMessage(), Http::STATUS_NOT_IMPLEMENTED, $e);
+        }
+    }
+
+    /**
+     * @throws OCSException
+     */
+    public function acquireLock(int $type, string $user, string $path): DataResponse {
+        try {
+            $path = $this->getPath($user, $path);
+        } catch (NoUserException $e) {
+            throw new OCSException('User not found', Http::STATUS_NOT_FOUND, $e);
+        } catch (NotFoundException $e) {
+            throw new OCSException('Path not found', Http::STATUS_NOT_FOUND, $e);
+        }
+
+        $lockingProvider = $this->getLockingProvider();
+
+        try {
+            $lockingProvider->acquireLock($path, $type);
+            $this->config->setAppValue('testing', 'locking_' . $path, (string)$type);
+            return new DataResponse();
+        } catch (LockedException $e) {
+            throw new OCSException('', Http::STATUS_LOCKED, $e);
+        }
+    }
+
+    /**
+     * @throws OCSException
+     */
+    public function changeLock(int $type, string $user, string $path): DataResponse {
+        try {
+            $path = $this->getPath($user, $path);
+        } catch (NoUserException $e) {
+            throw new OCSException('User not found', Http::STATUS_NOT_FOUND, $e);
+        } catch (NotFoundException $e) {
+            throw new OCSException('Path not found', Http::STATUS_NOT_FOUND, $e);
+        }
+
+        $lockingProvider = $this->getLockingProvider();
+
+        try {
+            $lockingProvider->changeLock($path, $type);
+            $this->config->setAppValue('testing', 'locking_' . $path, (string)$type);
+            return new DataResponse();
+        } catch (LockedException $e) {
+            throw new OCSException('', Http::STATUS_LOCKED, $e);
+        }
+    }
+
+    /**
+     * @throws OCSException
+     */
+    public function releaseLock(int $type, string $user, string $path): DataResponse {
+        try {
+            $path = $this->getPath($user, $path);
+        } catch (NoUserException $e) {
+            throw new OCSException('User not found', Http::STATUS_NOT_FOUND, $e);
+        } catch (NotFoundException $e) {
+            throw new OCSException('Path not found', Http::STATUS_NOT_FOUND, $e);
+        }
+
+        $lockingProvider = $this->getLockingProvider();
+
+        try {
+            $lockingProvider->releaseLock($path, $type);
+            $this->config->deleteAppValue('testing', 'locking_' . $path);
+            return new DataResponse();
+        } catch (LockedException $e) {
+            throw new OCSException('', Http::STATUS_LOCKED, $e);
+        }
+    }
+
+    /**
+     * @throws OCSException
+     */
+    public function isLocked(int $type, string $user, string $path): DataResponse {
+        try {
+            $path = $this->getPath($user, $path);
+        } catch (NoUserException $e) {
+            throw new OCSException('User not found', Http::STATUS_NOT_FOUND, $e);
+        } catch (NotFoundException $e) {
+            throw new OCSException('Path not found', Http::STATUS_NOT_FOUND, $e);
+        }
+
+        $lockingProvider = $this->getLockingProvider();
+
+        if ($lockingProvider->isLocked($path, $type)) {
+            return new DataResponse();
+        }
+
+        throw new OCSException('', Http::STATUS_LOCKED);
+    }
+
+    public function releaseAll(int $type = null): DataResponse {
+        $lockingProvider = $this->getLockingProvider();
+
+        foreach ($this->config->getAppKeys('testing') as $lock) {
+            if (strpos($lock, 'locking_') === 0) {
+                $path = substr($lock, strlen('locking_'));
+
+                if ($type === ILockingProvider::LOCK_EXCLUSIVE && (int)$this->config->getAppValue('testing', $lock) === ILockingProvider::LOCK_EXCLUSIVE) {
+                    $lockingProvider->releaseLock($path, (int)$this->config->getAppValue('testing', $lock));
+                } elseif ($type === ILockingProvider::LOCK_SHARED && (int)$this->config->getAppValue('testing', $lock) === ILockingProvider::LOCK_SHARED) {
+                    $lockingProvider->releaseLock($path, (int)$this->config->getAppValue('testing', $lock));
+                } else {
+                    $lockingProvider->releaseLock($path, (int)$this->config->getAppValue('testing', $lock));
+                }
+            }
+        }
+
+        return new DataResponse();
+    }
 }

Spacing +9 added lines, -9 removed lines

@@ -94,7 +94,7 @@ 
 	 */
 	protected function getPath(string $user, string $path): string {
 		$node = $this->rootFolder->getUserFolder($user)->get($path);
-		return 'files/' . md5($node->getStorage()->getId() . '::' . trim($node->getInternalPath(), '/'));
+		return 'files/'.md5($node->getStorage()->getId().'::'.trim($node->getInternalPath(), '/'));
 	}
 
 	/**
@@ -125,7 +125,7 @@ 
 
 		try {
 			$lockingProvider->acquireLock($path, $type);
-			$this->config->setAppValue('testing', 'locking_' . $path, (string)$type);
+			$this->config->setAppValue('testing', 'locking_'.$path, (string) $type);
 			return new DataResponse();
 		} catch (LockedException $e) {
 			throw new OCSException('', Http::STATUS_LOCKED, $e);
@@ -148,7 +148,7 @@ 
 
 		try {
 			$lockingProvider->changeLock($path, $type);
-			$this->config->setAppValue('testing', 'locking_' . $path, (string)$type);
+			$this->config->setAppValue('testing', 'locking_'.$path, (string) $type);
 			return new DataResponse();
 		} catch (LockedException $e) {
 			throw new OCSException('', Http::STATUS_LOCKED, $e);
@@ -171,7 +171,7 @@ 
 
 		try {
 			$lockingProvider->releaseLock($path, $type);
-			$this->config->deleteAppValue('testing', 'locking_' . $path);
+			$this->config->deleteAppValue('testing', 'locking_'.$path);
 			return new DataResponse();
 		} catch (LockedException $e) {
 			throw new OCSException('', Http::STATUS_LOCKED, $e);
@@ -206,12 +206,12 @@ 
 			if (strpos($lock, 'locking_') === 0) {
 				$path = substr($lock, strlen('locking_'));
 
-				if ($type === ILockingProvider::LOCK_EXCLUSIVE && (int)$this->config->getAppValue('testing', $lock) === ILockingProvider::LOCK_EXCLUSIVE) {
-					$lockingProvider->releaseLock($path, (int)$this->config->getAppValue('testing', $lock));
-				} elseif ($type === ILockingProvider::LOCK_SHARED && (int)$this->config->getAppValue('testing', $lock) === ILockingProvider::LOCK_SHARED) {
-					$lockingProvider->releaseLock($path, (int)$this->config->getAppValue('testing', $lock));
+				if ($type === ILockingProvider::LOCK_EXCLUSIVE && (int) $this->config->getAppValue('testing', $lock) === ILockingProvider::LOCK_EXCLUSIVE) {
+					$lockingProvider->releaseLock($path, (int) $this->config->getAppValue('testing', $lock));
+				} elseif ($type === ILockingProvider::LOCK_SHARED && (int) $this->config->getAppValue('testing', $lock) === ILockingProvider::LOCK_SHARED) {
+					$lockingProvider->releaseLock($path, (int) $this->config->getAppValue('testing', $lock));
 				} else {
-					$lockingProvider->releaseLock($path, (int)$this->config->getAppValue('testing', $lock));
+					$lockingProvider->releaseLock($path, (int) $this->config->getAppValue('testing', $lock));
 				}
 			}
 		}

lib/private/legacy/OC_Util.php

Indentation +1366 added lines, -1366 removed lines

@@ -77,1375 +77,1375 @@
 use Psr\Log\LoggerInterface;
 
 class OC_Util {
-	public static $scripts = [];
-	public static $styles = [];
-	public static $headers = [];
-	private static $rootMounted = false;
-	private static $fsSetup = false;
-
-	/** @var array Local cache of version.php */
-	private static $versionCache = null;
-
-	protected static function getAppManager() {
-		return \OC::$server->getAppManager();
-	}
-
-	private static function initLocalStorageRootFS() {
-		// mount local file backend as root
-		$configDataDirectory = \OC::$server->getSystemConfig()->getValue("datadirectory", OC::$SERVERROOT . "/data");
-		//first set up the local "root" storage
-		\OC\Files\Filesystem::initMountManager();
-		if (!self::$rootMounted) {
-			\OC\Files\Filesystem::mount(LocalRootStorage::class, ['datadir' => $configDataDirectory], '/');
-			self::$rootMounted = true;
-		}
-	}
-
-	/**
-	 * mounting an object storage as the root fs will in essence remove the
-	 * necessity of a data folder being present.
-	 * TODO make home storage aware of this and use the object storage instead of local disk access
-	 *
-	 * @param array $config containing 'class' and optional 'arguments'
-	 * @suppress PhanDeprecatedFunction
-	 */
-	private static function initObjectStoreRootFS($config) {
-		// check misconfiguration
-		if (empty($config['class'])) {
-			\OCP\Util::writeLog('files', 'No class given for objectstore', ILogger::ERROR);
-		}
-		if (!isset($config['arguments'])) {
-			$config['arguments'] = [];
-		}
-
-		// instantiate object store implementation
-		$name = $config['class'];
-		if (strpos($name, 'OCA\\') === 0 && substr_count($name, '\\') >= 2) {
-			$segments = explode('\\', $name);
-			OC_App::loadApp(strtolower($segments[1]));
-		}
-		$config['arguments']['objectstore'] = new $config['class']($config['arguments']);
-		// mount with plain / root object store implementation
-		$config['class'] = '\OC\Files\ObjectStore\ObjectStoreStorage';
-
-		// mount object storage as root
-		\OC\Files\Filesystem::initMountManager();
-		if (!self::$rootMounted) {
-			\OC\Files\Filesystem::mount($config['class'], $config['arguments'], '/');
-			self::$rootMounted = true;
-		}
-	}
-
-	/**
-	 * mounting an object storage as the root fs will in essence remove the
-	 * necessity of a data folder being present.
-	 *
-	 * @param array $config containing 'class' and optional 'arguments'
-	 * @suppress PhanDeprecatedFunction
-	 */
-	private static function initObjectStoreMultibucketRootFS($config) {
-		// check misconfiguration
-		if (empty($config['class'])) {
-			\OCP\Util::writeLog('files', 'No class given for objectstore', ILogger::ERROR);
-		}
-		if (!isset($config['arguments'])) {
-			$config['arguments'] = [];
-		}
-
-		// instantiate object store implementation
-		$name = $config['class'];
-		if (strpos($name, 'OCA\\') === 0 && substr_count($name, '\\') >= 2) {
-			$segments = explode('\\', $name);
-			OC_App::loadApp(strtolower($segments[1]));
-		}
-
-		if (!isset($config['arguments']['bucket'])) {
-			$config['arguments']['bucket'] = '';
-		}
-		// put the root FS always in first bucket for multibucket configuration
-		$config['arguments']['bucket'] .= '0';
-
-		$config['arguments']['objectstore'] = new $config['class']($config['arguments']);
-		// mount with plain / root object store implementation
-		$config['class'] = '\OC\Files\ObjectStore\ObjectStoreStorage';
-
-		// mount object storage as root
-		\OC\Files\Filesystem::initMountManager();
-		if (!self::$rootMounted) {
-			\OC\Files\Filesystem::mount($config['class'], $config['arguments'], '/');
-			self::$rootMounted = true;
-		}
-	}
-
-	/**
-	 * Can be set up
-	 *
-	 * @param string $user
-	 * @return boolean
-	 * @description configure the initial filesystem based on the configuration
-	 * @suppress PhanDeprecatedFunction
-	 * @suppress PhanAccessMethodInternal
-	 */
-	public static function setupFS($user = '') {
-		//setting up the filesystem twice can only lead to trouble
-		if (self::$fsSetup) {
-			return false;
-		}
-
-		\OC::$server->getEventLogger()->start('setup_fs', 'Setup filesystem');
-
-		// If we are not forced to load a specific user we load the one that is logged in
-		if ($user === null) {
-			$user = '';
-		} elseif ($user == "" && \OC::$server->getUserSession()->isLoggedIn()) {
-			$user = OC_User::getUser();
-		}
-
-		// load all filesystem apps before, so no setup-hook gets lost
-		OC_App::loadApps(['filesystem']);
-
-		// the filesystem will finish when $user is not empty,
-		// mark fs setup here to avoid doing the setup from loading
-		// OC_Filesystem
-		if ($user != '') {
-			self::$fsSetup = true;
-		}
-
-		\OC\Files\Filesystem::initMountManager();
-
-		$prevLogging = \OC\Files\Filesystem::logWarningWhenAddingStorageWrapper(false);
-		\OC\Files\Filesystem::addStorageWrapper('mount_options', function ($mountPoint, \OCP\Files\Storage $storage, \OCP\Files\Mount\IMountPoint $mount) {
-			if ($storage->instanceOfStorage('\OC\Files\Storage\Common')) {
-				/** @var \OC\Files\Storage\Common $storage */
-				$storage->setMountOptions($mount->getOptions());
-			}
-			return $storage;
-		});
-
-		\OC\Files\Filesystem::addStorageWrapper('enable_sharing', function ($mountPoint, \OCP\Files\Storage\IStorage $storage, \OCP\Files\Mount\IMountPoint $mount) {
-			if (!$mount->getOption('enable_sharing', true)) {
-				return new \OC\Files\Storage\Wrapper\PermissionsMask([
-					'storage' => $storage,
-					'mask' => \OCP\Constants::PERMISSION_ALL - \OCP\Constants::PERMISSION_SHARE
-				]);
-			}
-			return $storage;
-		});
-
-		// install storage availability wrapper, before most other wrappers
-		\OC\Files\Filesystem::addStorageWrapper('oc_availability', function ($mountPoint, \OCP\Files\Storage\IStorage $storage) {
-			if (!$storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage') && !$storage->isLocal()) {
-				return new \OC\Files\Storage\Wrapper\Availability(['storage' => $storage]);
-			}
-			return $storage;
-		});
-
-		\OC\Files\Filesystem::addStorageWrapper('oc_encoding', function ($mountPoint, \OCP\Files\Storage $storage, \OCP\Files\Mount\IMountPoint $mount) {
-			if ($mount->getOption('encoding_compatibility', false) && !$storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage') && !$storage->isLocal()) {
-				return new \OC\Files\Storage\Wrapper\Encoding(['storage' => $storage]);
-			}
-			return $storage;
-		});
-
-		\OC\Files\Filesystem::addStorageWrapper('oc_quota', function ($mountPoint, $storage) {
-			// set up quota for home storages, even for other users
-			// which can happen when using sharing
-
-			/**
-			 * @var \OC\Files\Storage\Storage $storage
-			 */
-			if ($storage->instanceOfStorage('\OC\Files\Storage\Home')
-				|| $storage->instanceOfStorage('\OC\Files\ObjectStore\HomeObjectStoreStorage')
-			) {
-				/** @var \OC\Files\Storage\Home $storage */
-				if (is_object($storage->getUser())) {
-					$quota = OC_Util::getUserQuota($storage->getUser());
-					if ($quota !== \OCP\Files\FileInfo::SPACE_UNLIMITED) {
-						return new \OC\Files\Storage\Wrapper\Quota(['storage' => $storage, 'quota' => $quota, 'root' => 'files']);
-					}
-				}
-			}
-
-			return $storage;
-		});
-
-		\OC\Files\Filesystem::addStorageWrapper('readonly', function ($mountPoint, \OCP\Files\Storage\IStorage $storage, \OCP\Files\Mount\IMountPoint $mount) {
-			/*
+    public static $scripts = [];
+    public static $styles = [];
+    public static $headers = [];
+    private static $rootMounted = false;
+    private static $fsSetup = false;
+
+    /** @var array Local cache of version.php */
+    private static $versionCache = null;
+
+    protected static function getAppManager() {
+        return \OC::$server->getAppManager();
+    }
+
+    private static function initLocalStorageRootFS() {
+        // mount local file backend as root
+        $configDataDirectory = \OC::$server->getSystemConfig()->getValue("datadirectory", OC::$SERVERROOT . "/data");
+        //first set up the local "root" storage
+        \OC\Files\Filesystem::initMountManager();
+        if (!self::$rootMounted) {
+            \OC\Files\Filesystem::mount(LocalRootStorage::class, ['datadir' => $configDataDirectory], '/');
+            self::$rootMounted = true;
+        }
+    }
+
+    /**
+     * mounting an object storage as the root fs will in essence remove the
+     * necessity of a data folder being present.
+     * TODO make home storage aware of this and use the object storage instead of local disk access
+     *
+     * @param array $config containing 'class' and optional 'arguments'
+     * @suppress PhanDeprecatedFunction
+     */
+    private static function initObjectStoreRootFS($config) {
+        // check misconfiguration
+        if (empty($config['class'])) {
+            \OCP\Util::writeLog('files', 'No class given for objectstore', ILogger::ERROR);
+        }
+        if (!isset($config['arguments'])) {
+            $config['arguments'] = [];
+        }
+
+        // instantiate object store implementation
+        $name = $config['class'];
+        if (strpos($name, 'OCA\\') === 0 && substr_count($name, '\\') >= 2) {
+            $segments = explode('\\', $name);
+            OC_App::loadApp(strtolower($segments[1]));
+        }
+        $config['arguments']['objectstore'] = new $config['class']($config['arguments']);
+        // mount with plain / root object store implementation
+        $config['class'] = '\OC\Files\ObjectStore\ObjectStoreStorage';
+
+        // mount object storage as root
+        \OC\Files\Filesystem::initMountManager();
+        if (!self::$rootMounted) {
+            \OC\Files\Filesystem::mount($config['class'], $config['arguments'], '/');
+            self::$rootMounted = true;
+        }
+    }
+
+    /**
+     * mounting an object storage as the root fs will in essence remove the
+     * necessity of a data folder being present.
+     *
+     * @param array $config containing 'class' and optional 'arguments'
+     * @suppress PhanDeprecatedFunction
+     */
+    private static function initObjectStoreMultibucketRootFS($config) {
+        // check misconfiguration
+        if (empty($config['class'])) {
+            \OCP\Util::writeLog('files', 'No class given for objectstore', ILogger::ERROR);
+        }
+        if (!isset($config['arguments'])) {
+            $config['arguments'] = [];
+        }
+
+        // instantiate object store implementation
+        $name = $config['class'];
+        if (strpos($name, 'OCA\\') === 0 && substr_count($name, '\\') >= 2) {
+            $segments = explode('\\', $name);
+            OC_App::loadApp(strtolower($segments[1]));
+        }
+
+        if (!isset($config['arguments']['bucket'])) {
+            $config['arguments']['bucket'] = '';
+        }
+        // put the root FS always in first bucket for multibucket configuration
+        $config['arguments']['bucket'] .= '0';
+
+        $config['arguments']['objectstore'] = new $config['class']($config['arguments']);
+        // mount with plain / root object store implementation
+        $config['class'] = '\OC\Files\ObjectStore\ObjectStoreStorage';
+
+        // mount object storage as root
+        \OC\Files\Filesystem::initMountManager();
+        if (!self::$rootMounted) {
+            \OC\Files\Filesystem::mount($config['class'], $config['arguments'], '/');
+            self::$rootMounted = true;
+        }
+    }
+
+    /**
+     * Can be set up
+     *
+     * @param string $user
+     * @return boolean
+     * @description configure the initial filesystem based on the configuration
+     * @suppress PhanDeprecatedFunction
+     * @suppress PhanAccessMethodInternal
+     */
+    public static function setupFS($user = '') {
+        //setting up the filesystem twice can only lead to trouble
+        if (self::$fsSetup) {
+            return false;
+        }
+
+        \OC::$server->getEventLogger()->start('setup_fs', 'Setup filesystem');
+
+        // If we are not forced to load a specific user we load the one that is logged in
+        if ($user === null) {
+            $user = '';
+        } elseif ($user == "" && \OC::$server->getUserSession()->isLoggedIn()) {
+            $user = OC_User::getUser();
+        }
+
+        // load all filesystem apps before, so no setup-hook gets lost
+        OC_App::loadApps(['filesystem']);
+
+        // the filesystem will finish when $user is not empty,
+        // mark fs setup here to avoid doing the setup from loading
+        // OC_Filesystem
+        if ($user != '') {
+            self::$fsSetup = true;
+        }
+
+        \OC\Files\Filesystem::initMountManager();
+
+        $prevLogging = \OC\Files\Filesystem::logWarningWhenAddingStorageWrapper(false);
+        \OC\Files\Filesystem::addStorageWrapper('mount_options', function ($mountPoint, \OCP\Files\Storage $storage, \OCP\Files\Mount\IMountPoint $mount) {
+            if ($storage->instanceOfStorage('\OC\Files\Storage\Common')) {
+                /** @var \OC\Files\Storage\Common $storage */
+                $storage->setMountOptions($mount->getOptions());
+            }
+            return $storage;
+        });
+
+        \OC\Files\Filesystem::addStorageWrapper('enable_sharing', function ($mountPoint, \OCP\Files\Storage\IStorage $storage, \OCP\Files\Mount\IMountPoint $mount) {
+            if (!$mount->getOption('enable_sharing', true)) {
+                return new \OC\Files\Storage\Wrapper\PermissionsMask([
+                    'storage' => $storage,
+                    'mask' => \OCP\Constants::PERMISSION_ALL - \OCP\Constants::PERMISSION_SHARE
+                ]);
+            }
+            return $storage;
+        });
+
+        // install storage availability wrapper, before most other wrappers
+        \OC\Files\Filesystem::addStorageWrapper('oc_availability', function ($mountPoint, \OCP\Files\Storage\IStorage $storage) {
+            if (!$storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage') && !$storage->isLocal()) {
+                return new \OC\Files\Storage\Wrapper\Availability(['storage' => $storage]);
+            }
+            return $storage;
+        });
+
+        \OC\Files\Filesystem::addStorageWrapper('oc_encoding', function ($mountPoint, \OCP\Files\Storage $storage, \OCP\Files\Mount\IMountPoint $mount) {
+            if ($mount->getOption('encoding_compatibility', false) && !$storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage') && !$storage->isLocal()) {
+                return new \OC\Files\Storage\Wrapper\Encoding(['storage' => $storage]);
+            }
+            return $storage;
+        });
+
+        \OC\Files\Filesystem::addStorageWrapper('oc_quota', function ($mountPoint, $storage) {
+            // set up quota for home storages, even for other users
+            // which can happen when using sharing
+
+            /**
+             * @var \OC\Files\Storage\Storage $storage
+             */
+            if ($storage->instanceOfStorage('\OC\Files\Storage\Home')
+                || $storage->instanceOfStorage('\OC\Files\ObjectStore\HomeObjectStoreStorage')
+            ) {
+                /** @var \OC\Files\Storage\Home $storage */
+                if (is_object($storage->getUser())) {
+                    $quota = OC_Util::getUserQuota($storage->getUser());
+                    if ($quota !== \OCP\Files\FileInfo::SPACE_UNLIMITED) {
+                        return new \OC\Files\Storage\Wrapper\Quota(['storage' => $storage, 'quota' => $quota, 'root' => 'files']);
+                    }
+                }
+            }
+
+            return $storage;
+        });
+
+        \OC\Files\Filesystem::addStorageWrapper('readonly', function ($mountPoint, \OCP\Files\Storage\IStorage $storage, \OCP\Files\Mount\IMountPoint $mount) {
+            /*
 			 * Do not allow any operations that modify the storage
 			 */
-			if ($mount->getOption('readonly', false)) {
-				return new \OC\Files\Storage\Wrapper\PermissionsMask([
-					'storage' => $storage,
-					'mask' => \OCP\Constants::PERMISSION_ALL & ~(
-						\OCP\Constants::PERMISSION_UPDATE |
-						\OCP\Constants::PERMISSION_CREATE |
-						\OCP\Constants::PERMISSION_DELETE
-					),
-				]);
-			}
-			return $storage;
-		});
-
-		OC_Hook::emit('OC_Filesystem', 'preSetup', ['user' => $user]);
-
-		\OC\Files\Filesystem::logWarningWhenAddingStorageWrapper($prevLogging);
-
-		//check if we are using an object storage
-		$objectStore = \OC::$server->getSystemConfig()->getValue('objectstore', null);
-		$objectStoreMultibucket = \OC::$server->getSystemConfig()->getValue('objectstore_multibucket', null);
-
-		// use the same order as in ObjectHomeMountProvider
-		if (isset($objectStoreMultibucket)) {
-			self::initObjectStoreMultibucketRootFS($objectStoreMultibucket);
-		} elseif (isset($objectStore)) {
-			self::initObjectStoreRootFS($objectStore);
-		} else {
-			self::initLocalStorageRootFS();
-		}
-
-		/** @var \OCP\Files\Config\IMountProviderCollection $mountProviderCollection */
-		$mountProviderCollection = \OC::$server->query(\OCP\Files\Config\IMountProviderCollection::class);
-		$rootMountProviders = $mountProviderCollection->getRootMounts();
-
-		/** @var \OC\Files\Mount\Manager $mountManager */
-		$mountManager = \OC\Files\Filesystem::getMountManager();
-		foreach ($rootMountProviders as $rootMountProvider) {
-			$mountManager->addMount($rootMountProvider);
-		}
-
-		if ($user != '' && !\OC::$server->getUserManager()->userExists($user)) {
-			\OC::$server->getEventLogger()->end('setup_fs');
-			return false;
-		}
-
-		//if we aren't logged in, there is no use to set up the filesystem
-		if ($user != "") {
-			$userDir = '/' . $user . '/files';
-
-			//jail the user into his "home" directory
-			\OC\Files\Filesystem::init($user, $userDir);
-
-			OC_Hook::emit('OC_Filesystem', 'setup', ['user' => $user, 'user_dir' => $userDir]);
-		}
-		\OC::$server->getEventLogger()->end('setup_fs');
-		return true;
-	}
-
-	/**
-	 * check if a password is required for each public link
-	 *
-	 * @return boolean
-	 * @suppress PhanDeprecatedFunction
-	 */
-	public static function isPublicLinkPasswordRequired() {
-		/** @var IManager $shareManager */
-		$shareManager = \OC::$server->get(IManager::class);
-		return $shareManager->shareApiLinkEnforcePassword();
-	}
-
-	/**
-	 * check if sharing is disabled for the current user
-	 * @param IConfig $config
-	 * @param IGroupManager $groupManager
-	 * @param IUser|null $user
-	 * @return bool
-	 */
-	public static function isSharingDisabledForUser(IConfig $config, IGroupManager $groupManager, $user) {
-		/** @var IManager $shareManager */
-		$shareManager = \OC::$server->get(IManager::class);
-		$userId = $user ? $user->getUID() : null;
-		return $shareManager->sharingDisabledForUser($userId);
-	}
-
-	/**
-	 * check if share API enforces a default expire date
-	 *
-	 * @return boolean
-	 * @suppress PhanDeprecatedFunction
-	 */
-	public static function isDefaultExpireDateEnforced() {
-		/** @var IManager $shareManager */
-		$shareManager = \OC::$server->get(IManager::class);
-		return $shareManager->shareApiLinkDefaultExpireDateEnforced();
-	}
-
-	/**
-	 * Get the quota of a user
-	 *
-	 * @param IUser|null $user
-	 * @return float Quota bytes
-	 */
-	public static function getUserQuota(?IUser $user) {
-		if (is_null($user)) {
-			return \OCP\Files\FileInfo::SPACE_UNLIMITED;
-		}
-		$userQuota = $user->getQuota();
-		if ($userQuota === 'none') {
-			return \OCP\Files\FileInfo::SPACE_UNLIMITED;
-		}
-		return OC_Helper::computerFileSize($userQuota);
-	}
-
-	/**
-	 * copies the skeleton to the users /files
-	 *
-	 * @param string $userId
-	 * @param \OCP\Files\Folder $userDirectory
-	 * @throws \OCP\Files\NotFoundException
-	 * @throws \OCP\Files\NotPermittedException
-	 * @suppress PhanDeprecatedFunction
-	 */
-	public static function copySkeleton($userId, \OCP\Files\Folder $userDirectory) {
-		/** @var LoggerInterface $logger */
-		$logger = \OC::$server->get(LoggerInterface::class);
-
-		$plainSkeletonDirectory = \OC::$server->getConfig()->getSystemValue('skeletondirectory', \OC::$SERVERROOT . '/core/skeleton');
-		$userLang = \OC::$server->getL10NFactory()->findLanguage();
-		$skeletonDirectory = str_replace('{lang}', $userLang, $plainSkeletonDirectory);
-
-		if (!file_exists($skeletonDirectory)) {
-			$dialectStart = strpos($userLang, '_');
-			if ($dialectStart !== false) {
-				$skeletonDirectory = str_replace('{lang}', substr($userLang, 0, $dialectStart), $plainSkeletonDirectory);
-			}
-			if ($dialectStart === false || !file_exists($skeletonDirectory)) {
-				$skeletonDirectory = str_replace('{lang}', 'default', $plainSkeletonDirectory);
-			}
-			if (!file_exists($skeletonDirectory)) {
-				$skeletonDirectory = '';
-			}
-		}
-
-		$instanceId = \OC::$server->getConfig()->getSystemValue('instanceid', '');
-
-		if ($instanceId === null) {
-			throw new \RuntimeException('no instance id!');
-		}
-		$appdata = 'appdata_' . $instanceId;
-		if ($userId === $appdata) {
-			throw new \RuntimeException('username is reserved name: ' . $appdata);
-		}
-
-		if (!empty($skeletonDirectory)) {
-			$logger->debug('copying skeleton for '.$userId.' from '.$skeletonDirectory.' to '.$userDirectory->getFullPath('/'), ['app' => 'files_skeleton']);
-			self::copyr($skeletonDirectory, $userDirectory);
-			// update the file cache
-			$userDirectory->getStorage()->getScanner()->scan('', \OC\Files\Cache\Scanner::SCAN_RECURSIVE);
-
-			/** @var ITemplateManager $templateManager */
-			$templateManager = \OC::$server->get(ITemplateManager::class);
-			$templateManager->initializeTemplateDirectory(null, $userId);
-		}
-	}
-
-	/**
-	 * copies a directory recursively by using streams
-	 *
-	 * @param string $source
-	 * @param \OCP\Files\Folder $target
-	 * @return void
-	 */
-	public static function copyr($source, \OCP\Files\Folder $target) {
-		$logger = \OC::$server->getLogger();
-
-		// Verify if folder exists
-		$dir = opendir($source);
-		if ($dir === false) {
-			$logger->error(sprintf('Could not opendir "%s"', $source), ['app' => 'core']);
-			return;
-		}
-
-		// Copy the files
-		while (false !== ($file = readdir($dir))) {
-			if (!\OC\Files\Filesystem::isIgnoredDir($file)) {
-				if (is_dir($source . '/' . $file)) {
-					$child = $target->newFolder($file);
-					self::copyr($source . '/' . $file, $child);
-				} else {
-					$child = $target->newFile($file);
-					$sourceStream = fopen($source . '/' . $file, 'r');
-					if ($sourceStream === false) {
-						$logger->error(sprintf('Could not fopen "%s"', $source . '/' . $file), ['app' => 'core']);
-						closedir($dir);
-						return;
-					}
-					stream_copy_to_stream($sourceStream, $child->fopen('w'));
-				}
-			}
-		}
-		closedir($dir);
-	}
-
-	/**
-	 * @return void
-	 * @suppress PhanUndeclaredMethod
-	 */
-	public static function tearDownFS() {
-		\OC\Files\Filesystem::tearDown();
-		\OC::$server->getRootFolder()->clearCache();
-		self::$fsSetup = false;
-		self::$rootMounted = false;
-	}
-
-	/**
-	 * get the current installed version of ownCloud
-	 *
-	 * @return array
-	 */
-	public static function getVersion() {
-		OC_Util::loadVersion();
-		return self::$versionCache['OC_Version'];
-	}
-
-	/**
-	 * get the current installed version string of ownCloud
-	 *
-	 * @return string
-	 */
-	public static function getVersionString() {
-		OC_Util::loadVersion();
-		return self::$versionCache['OC_VersionString'];
-	}
-
-	/**
-	 * @deprecated the value is of no use anymore
-	 * @return string
-	 */
-	public static function getEditionString() {
-		return '';
-	}
-
-	/**
-	 * @description get the update channel of the current installed of ownCloud.
-	 * @return string
-	 */
-	public static function getChannel() {
-		OC_Util::loadVersion();
-		return \OC::$server->getConfig()->getSystemValue('updater.release.channel', self::$versionCache['OC_Channel']);
-	}
-
-	/**
-	 * @description get the build number of the current installed of ownCloud.
-	 * @return string
-	 */
-	public static function getBuild() {
-		OC_Util::loadVersion();
-		return self::$versionCache['OC_Build'];
-	}
-
-	/**
-	 * @description load the version.php into the session as cache
-	 * @suppress PhanUndeclaredVariable
-	 */
-	private static function loadVersion() {
-		if (self::$versionCache !== null) {
-			return;
-		}
-
-		$timestamp = filemtime(OC::$SERVERROOT . '/version.php');
-		require OC::$SERVERROOT . '/version.php';
-		/** @var int $timestamp */
-		self::$versionCache['OC_Version_Timestamp'] = $timestamp;
-		/** @var string $OC_Version */
-		self::$versionCache['OC_Version'] = $OC_Version;
-		/** @var string $OC_VersionString */
-		self::$versionCache['OC_VersionString'] = $OC_VersionString;
-		/** @var string $OC_Build */
-		self::$versionCache['OC_Build'] = $OC_Build;
-
-		/** @var string $OC_Channel */
-		self::$versionCache['OC_Channel'] = $OC_Channel;
-	}
-
-	/**
-	 * generates a path for JS/CSS files. If no application is provided it will create the path for core.
-	 *
-	 * @param string $application application to get the files from
-	 * @param string $directory directory within this application (css, js, vendor, etc)
-	 * @param string $file the file inside of the above folder
-	 * @return string the path
-	 */
-	private static function generatePath($application, $directory, $file) {
-		if (is_null($file)) {
-			$file = $application;
-			$application = "";
-		}
-		if (!empty($application)) {
-			return "$application/$directory/$file";
-		} else {
-			return "$directory/$file";
-		}
-	}
-
-	/**
-	 * add a javascript file
-	 *
-	 * @deprecated 24.0.0 - Use \OCP\Util::addScript
-	 *
-	 * @param string $application application id
-	 * @param string|null $file filename
-	 * @param bool $prepend prepend the Script to the beginning of the list
-	 * @return void
-	 */
-	public static function addScript($application, $file = null, $prepend = false) {
-		$path = OC_Util::generatePath($application, 'js', $file);
-
-		// core js files need separate handling
-		if ($application !== 'core' && $file !== null) {
-			self::addTranslations($application);
-		}
-		self::addExternalResource($application, $prepend, $path, "script");
-	}
-
-	/**
-	 * add a javascript file from the vendor sub folder
-	 *
-	 * @param string $application application id
-	 * @param string|null $file filename
-	 * @param bool $prepend prepend the Script to the beginning of the list
-	 * @return void
-	 */
-	public static function addVendorScript($application, $file = null, $prepend = false) {
-		$path = OC_Util::generatePath($application, 'vendor', $file);
-		self::addExternalResource($application, $prepend, $path, "script");
-	}
-
-	/**
-	 * add a translation JS file
-	 *
-	 * @deprecated 24.0.0
-	 *
-	 * @param string $application application id
-	 * @param string|null $languageCode language code, defaults to the current language
-	 * @param bool|null $prepend prepend the Script to the beginning of the list
-	 */
-	public static function addTranslations($application, $languageCode = null, $prepend = false) {
-		if (is_null($languageCode)) {
-			$languageCode = \OC::$server->getL10NFactory()->findLanguage($application);
-		}
-		if (!empty($application)) {
-			$path = "$application/l10n/$languageCode";
-		} else {
-			$path = "l10n/$languageCode";
-		}
-		self::addExternalResource($application, $prepend, $path, "script");
-	}
-
-	/**
-	 * add a css file
-	 *
-	 * @param string $application application id
-	 * @param string|null $file filename
-	 * @param bool $prepend prepend the Style to the beginning of the list
-	 * @return void
-	 */
-	public static function addStyle($application, $file = null, $prepend = false) {
-		$path = OC_Util::generatePath($application, 'css', $file);
-		self::addExternalResource($application, $prepend, $path, "style");
-	}
-
-	/**
-	 * add a css file from the vendor sub folder
-	 *
-	 * @param string $application application id
-	 * @param string|null $file filename
-	 * @param bool $prepend prepend the Style to the beginning of the list
-	 * @return void
-	 */
-	public static function addVendorStyle($application, $file = null, $prepend = false) {
-		$path = OC_Util::generatePath($application, 'vendor', $file);
-		self::addExternalResource($application, $prepend, $path, "style");
-	}
-
-	/**
-	 * add an external resource css/js file
-	 *
-	 * @param string $application application id
-	 * @param bool $prepend prepend the file to the beginning of the list
-	 * @param string $path
-	 * @param string $type (script or style)
-	 * @return void
-	 */
-	private static function addExternalResource($application, $prepend, $path, $type = "script") {
-		if ($type === "style") {
-			if (!in_array($path, self::$styles)) {
-				if ($prepend === true) {
-					array_unshift(self::$styles, $path);
-				} else {
-					self::$styles[] = $path;
-				}
-			}
-		} elseif ($type === "script") {
-			if (!in_array($path, self::$scripts)) {
-				if ($prepend === true) {
-					array_unshift(self::$scripts, $path);
-				} else {
-					self::$scripts [] = $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
-	 * @param bool $prepend prepend the header to the beginning of the list
-	 */
-	public static function addHeader($tag, $attributes, $text = null, $prepend = false) {
-		$header = [
-			'tag' => $tag,
-			'attributes' => $attributes,
-			'text' => $text
-		];
-		if ($prepend === true) {
-			array_unshift(self::$headers, $header);
-		} else {
-			self::$headers[] = $header;
-		}
-	}
-
-	/**
-	 * check if the current server configuration is suitable for ownCloud
-	 *
-	 * @param \OC\SystemConfig $config
-	 * @return array arrays with error messages and hints
-	 */
-	public static function checkServer(\OC\SystemConfig $config) {
-		$l = \OC::$server->getL10N('lib');
-		$errors = [];
-		$CONFIG_DATADIRECTORY = $config->getValue('datadirectory', OC::$SERVERROOT . '/data');
-
-		if (!self::needUpgrade($config) && $config->getValue('installed', false)) {
-			// this check needs to be done every time
-			$errors = self::checkDataDirectoryValidity($CONFIG_DATADIRECTORY);
-		}
-
-		// Assume that if checkServer() succeeded before in this session, then all is fine.
-		if (\OC::$server->getSession()->exists('checkServer_succeeded') && \OC::$server->getSession()->get('checkServer_succeeded')) {
-			return $errors;
-		}
-
-		$webServerRestart = false;
-		$setup = new \OC\Setup(
-			$config,
-			\OC::$server->get(IniGetWrapper::class),
-			\OC::$server->getL10N('lib'),
-			\OC::$server->get(\OCP\Defaults::class),
-			\OC::$server->get(LoggerInterface::class),
-			\OC::$server->getSecureRandom(),
-			\OC::$server->get(\OC\Installer::class)
-		);
-
-		$urlGenerator = \OC::$server->getURLGenerator();
-
-		$availableDatabases = $setup->getSupportedDatabases();
-		if (empty($availableDatabases)) {
-			$errors[] = [
-				'error' => $l->t('No database drivers (sqlite, mysql, or postgresql) installed.'),
-				'hint' => '' //TODO: sane hint
-			];
-			$webServerRestart = true;
-		}
-
-		// Check if config folder is writable.
-		if (!OC_Helper::isReadOnlyConfigEnabled()) {
-			if (!is_writable(OC::$configDir) or !is_readable(OC::$configDir)) {
-				$errors[] = [
-					'error' => $l->t('Cannot write into "config" directory.'),
-					'hint' => $l->t('This can usually be fixed by giving the web server write access to the config directory. See %s',
-						[ $urlGenerator->linkToDocs('admin-dir_permissions') ]) . '. '
-						. $l->t('Or, if you prefer to keep config.php file read only, set the option "config_is_read_only" to true in it. See %s',
-						[ $urlGenerator->linkToDocs('admin-config') ])
-				];
-			}
-		}
-
-		// Check if there is a writable install folder.
-		if ($config->getValue('appstoreenabled', true)) {
-			if (OC_App::getInstallPath() === null
-				|| !is_writable(OC_App::getInstallPath())
-				|| !is_readable(OC_App::getInstallPath())
-			) {
-				$errors[] = [
-					'error' => $l->t('Cannot write into "apps" directory.'),
-					'hint' => $l->t('This can usually be fixed by giving the web server write access to the apps directory'
-						. ' or disabling the App Store in the config file.')
-				];
-			}
-		}
-		// Create root dir.
-		if ($config->getValue('installed', false)) {
-			if (!is_dir($CONFIG_DATADIRECTORY)) {
-				$success = @mkdir($CONFIG_DATADIRECTORY);
-				if ($success) {
-					$errors = array_merge($errors, self::checkDataDirectoryPermissions($CONFIG_DATADIRECTORY));
-				} else {
-					$errors[] = [
-						'error' => $l->t('Cannot create "data" directory.'),
-						'hint' => $l->t('This can usually be fixed by giving the web server write access to the root directory. See %s',
-							[$urlGenerator->linkToDocs('admin-dir_permissions')])
-					];
-				}
-			} elseif (!is_writable($CONFIG_DATADIRECTORY) or !is_readable($CONFIG_DATADIRECTORY)) {
-				// is_writable doesn't work for NFS mounts, so try to write a file and check if it exists.
-				$testFile = sprintf('%s/%s.tmp', $CONFIG_DATADIRECTORY, uniqid('data_dir_writability_test_'));
-				$handle = fopen($testFile, 'w');
-				if (!$handle || fwrite($handle, 'Test write operation') === false) {
-					$permissionsHint = $l->t('Permissions can usually be fixed by giving the web server write access to the root directory. See %s.',
-						[$urlGenerator->linkToDocs('admin-dir_permissions')]);
-					$errors[] = [
-						'error' => $l->t('Your data directory is not writable.'),
-						'hint' => $permissionsHint
-					];
-				} else {
-					fclose($handle);
-					unlink($testFile);
-				}
-			} else {
-				$errors = array_merge($errors, self::checkDataDirectoryPermissions($CONFIG_DATADIRECTORY));
-			}
-		}
-
-		if (!OC_Util::isSetLocaleWorking()) {
-			$errors[] = [
-				'error' => $l->t('Setting locale to %s failed.',
-					['en_US.UTF-8/fr_FR.UTF-8/es_ES.UTF-8/de_DE.UTF-8/ru_RU.UTF-8/'
-						. 'pt_BR.UTF-8/it_IT.UTF-8/ja_JP.UTF-8/zh_CN.UTF-8']),
-				'hint' => $l->t('Please install one of these locales on your system and restart your web server.')
-			];
-		}
-
-		// Contains the dependencies that should be checked against
-		// classes = class_exists
-		// functions = function_exists
-		// defined = defined
-		// ini = ini_get
-		// If the dependency is not found the missing module name is shown to the EndUser
-		// When adding new checks always verify that they pass on Travis as well
-		// for ini settings, see https://github.com/owncloud/administration/blob/master/travis-ci/custom.ini
-		$dependencies = [
-			'classes' => [
-				'ZipArchive' => 'zip',
-				'DOMDocument' => 'dom',
-				'XMLWriter' => 'XMLWriter',
-				'XMLReader' => 'XMLReader',
-			],
-			'functions' => [
-				'xml_parser_create' => 'libxml',
-				'mb_strcut' => 'mbstring',
-				'ctype_digit' => 'ctype',
-				'json_encode' => 'JSON',
-				'gd_info' => 'GD',
-				'gzencode' => 'zlib',
-				'simplexml_load_string' => 'SimpleXML',
-				'hash' => 'HASH Message Digest Framework',
-				'curl_init' => 'cURL',
-				'openssl_verify' => 'OpenSSL',
-			],
-			'defined' => [
-				'PDO::ATTR_DRIVER_NAME' => 'PDO'
-			],
-			'ini' => [
-				'default_charset' => 'UTF-8',
-			],
-		];
-		$missingDependencies = [];
-		$invalidIniSettings = [];
-
-		$iniWrapper = \OC::$server->get(IniGetWrapper::class);
-		foreach ($dependencies['classes'] as $class => $module) {
-			if (!class_exists($class)) {
-				$missingDependencies[] = $module;
-			}
-		}
-		foreach ($dependencies['functions'] as $function => $module) {
-			if (!function_exists($function)) {
-				$missingDependencies[] = $module;
-			}
-		}
-		foreach ($dependencies['defined'] as $defined => $module) {
-			if (!defined($defined)) {
-				$missingDependencies[] = $module;
-			}
-		}
-		foreach ($dependencies['ini'] as $setting => $expected) {
-			if (is_bool($expected)) {
-				if ($iniWrapper->getBool($setting) !== $expected) {
-					$invalidIniSettings[] = [$setting, $expected];
-				}
-			}
-			if (is_int($expected)) {
-				if ($iniWrapper->getNumeric($setting) !== $expected) {
-					$invalidIniSettings[] = [$setting, $expected];
-				}
-			}
-			if (is_string($expected)) {
-				if (strtolower($iniWrapper->getString($setting)) !== strtolower($expected)) {
-					$invalidIniSettings[] = [$setting, $expected];
-				}
-			}
-		}
-
-		foreach ($missingDependencies as $missingDependency) {
-			$errors[] = [
-				'error' => $l->t('PHP module %s not installed.', [$missingDependency]),
-				'hint' => $l->t('Please ask your server administrator to install the module.'),
-			];
-			$webServerRestart = true;
-		}
-		foreach ($invalidIniSettings as $setting) {
-			if (is_bool($setting[1])) {
-				$setting[1] = $setting[1] ? 'on' : 'off';
-			}
-			$errors[] = [
-				'error' => $l->t('PHP setting "%s" is not set to "%s".', [$setting[0], var_export($setting[1], true)]),
-				'hint' => $l->t('Adjusting this setting in php.ini will make Nextcloud run again')
-			];
-			$webServerRestart = true;
-		}
-
-		/**
-		 * The mbstring.func_overload check can only be performed if the mbstring
-		 * module is installed as it will return null if the checking setting is
-		 * not available and thus a check on the boolean value fails.
-		 *
-		 * TODO: Should probably be implemented in the above generic dependency
-		 *       check somehow in the long-term.
-		 */
-		if ($iniWrapper->getBool('mbstring.func_overload') !== null &&
-			$iniWrapper->getBool('mbstring.func_overload') === true) {
-			$errors[] = [
-				'error' => $l->t('<code>mbstring.func_overload</code> is set to <code>%s</code> instead of the expected value <code>0</code>.', [$iniWrapper->getString('mbstring.func_overload')]),
-				'hint' => $l->t('To fix this issue set <code>mbstring.func_overload</code> to <code>0</code> in your php.ini.')
-			];
-		}
-
-		if (function_exists('xml_parser_create') &&
-			LIBXML_LOADED_VERSION < 20700) {
-			$version = LIBXML_LOADED_VERSION;
-			$major = floor($version / 10000);
-			$version -= ($major * 10000);
-			$minor = floor($version / 100);
-			$version -= ($minor * 100);
-			$patch = $version;
-			$errors[] = [
-				'error' => $l->t('libxml2 2.7.0 is at least required. Currently %s is installed.', [$major . '.' . $minor . '.' . $patch]),
-				'hint' => $l->t('To fix this issue update your libxml2 version and restart your web server.')
-			];
-		}
-
-		if (!self::isAnnotationsWorking()) {
-			$errors[] = [
-				'error' => $l->t('PHP is apparently set up to strip inline doc blocks. This will make several core apps inaccessible.'),
-				'hint' => $l->t('This is probably caused by a cache/accelerator such as Zend OPcache or eAccelerator.')
-			];
-		}
-
-		if (!\OC::$CLI && $webServerRestart) {
-			$errors[] = [
-				'error' => $l->t('PHP modules have been installed, but they are still listed as missing?'),
-				'hint' => $l->t('Please ask your server administrator to restart the web server.')
-			];
-		}
-
-		$errors = array_merge($errors, self::checkDatabaseVersion());
-
-		// Cache the result of this function
-		\OC::$server->getSession()->set('checkServer_succeeded', count($errors) == 0);
-
-		return $errors;
-	}
-
-	/**
-	 * Check the database version
-	 *
-	 * @return array errors array
-	 */
-	public static function checkDatabaseVersion() {
-		$l = \OC::$server->getL10N('lib');
-		$errors = [];
-		$dbType = \OC::$server->getSystemConfig()->getValue('dbtype', 'sqlite');
-		if ($dbType === 'pgsql') {
-			// check PostgreSQL version
-			try {
-				$result = \OC_DB::executeAudited('SHOW SERVER_VERSION');
-				$data = $result->fetchRow();
-				$result->closeCursor();
-				if (isset($data['server_version'])) {
-					$version = $data['server_version'];
-					if (version_compare($version, '9.0.0', '<')) {
-						$errors[] = [
-							'error' => $l->t('PostgreSQL >= 9 required.'),
-							'hint' => $l->t('Please upgrade your database version.')
-						];
-					}
-				}
-			} catch (\Doctrine\DBAL\Exception $e) {
-				$logger = \OC::$server->getLogger();
-				$logger->warning('Error occurred while checking PostgreSQL version, assuming >= 9');
-				$logger->logException($e);
-			}
-		}
-		return $errors;
-	}
-
-	/**
-	 * Check for correct file permissions of data directory
-	 *
-	 * @param string $dataDirectory
-	 * @return array arrays with error messages and hints
-	 */
-	public static function checkDataDirectoryPermissions($dataDirectory) {
-		if (\OC::$server->getConfig()->getSystemValue('check_data_directory_permissions', true) === false) {
-			return  [];
-		}
-
-		$perms = substr(decoct(@fileperms($dataDirectory)), -3);
-		if (substr($perms, -1) !== '0') {
-			chmod($dataDirectory, 0770);
-			clearstatcache();
-			$perms = substr(decoct(@fileperms($dataDirectory)), -3);
-			if ($perms[2] !== '0') {
-				$l = \OC::$server->getL10N('lib');
-				return [[
-					'error' => $l->t('Your data directory is readable by other users.'),
-					'hint' => $l->t('Please change the permissions to 0770 so that the directory cannot be listed by other users.'),
-				]];
-			}
-		}
-		return [];
-	}
-
-	/**
-	 * Check that the data directory exists and is valid by
-	 * checking the existence of the ".ocdata" file.
-	 *
-	 * @param string $dataDirectory data directory path
-	 * @return array errors found
-	 */
-	public static function checkDataDirectoryValidity($dataDirectory) {
-		$l = \OC::$server->getL10N('lib');
-		$errors = [];
-		if ($dataDirectory[0] !== '/') {
-			$errors[] = [
-				'error' => $l->t('Your data directory must be an absolute path.'),
-				'hint' => $l->t('Check the value of "datadirectory" in your configuration.')
-			];
-		}
-		if (!file_exists($dataDirectory . '/.ocdata')) {
-			$errors[] = [
-				'error' => $l->t('Your data directory is invalid.'),
-				'hint' => $l->t('Ensure there is a file called ".ocdata"' .
-					' in the root of the data directory.')
-			];
-		}
-		return $errors;
-	}
-
-	/**
-	 * Check if the user is logged in, redirects to home if not. With
-	 * redirect URL parameter to the request URI.
-	 *
-	 * @return void
-	 */
-	public static function checkLoggedIn() {
-		// Check if we are a user
-		if (!\OC::$server->getUserSession()->isLoggedIn()) {
-			header('Location: ' . \OC::$server->getURLGenerator()->linkToRoute(
-						'core.login.showLoginForm',
-						[
-							'redirect_url' => \OC::$server->getRequest()->getRequestUri(),
-						]
-					)
-			);
-			exit();
-		}
-		// Redirect to 2FA challenge selection if 2FA challenge was not solved yet
-		if (\OC::$server->getTwoFactorAuthManager()->needsSecondFactor(\OC::$server->getUserSession()->getUser())) {
-			header('Location: ' . \OC::$server->getURLGenerator()->linkToRoute('core.TwoFactorChallenge.selectChallenge'));
-			exit();
-		}
-	}
-
-	/**
-	 * Check if the user is a admin, redirects to home if not
-	 *
-	 * @return void
-	 */
-	public static function checkAdminUser() {
-		OC_Util::checkLoggedIn();
-		if (!OC_User::isAdminUser(OC_User::getUser())) {
-			header('Location: ' . \OCP\Util::linkToAbsolute('', 'index.php'));
-			exit();
-		}
-	}
-
-	/**
-	 * Returns the URL of the default page
-	 * based on the system configuration and
-	 * the apps visible for the current user
-	 *
-	 * @return string URL
-	 * @suppress PhanDeprecatedFunction
-	 */
-	public static function getDefaultPageUrl() {
-		/** @var IURLGenerator $urlGenerator */
-		$urlGenerator = \OC::$server->get(IURLGenerator::class);
-		return $urlGenerator->linkToDefaultPageUrl();
-	}
-
-	/**
-	 * Redirect to the user default page
-	 *
-	 * @return void
-	 */
-	public static function redirectToDefaultPage() {
-		$location = self::getDefaultPageUrl();
-		header('Location: ' . $location);
-		exit();
-	}
-
-	/**
-	 * get an id unique for this instance
-	 *
-	 * @return string
-	 */
-	public static function getInstanceId() {
-		$id = \OC::$server->getSystemConfig()->getValue('instanceid', null);
-		if (is_null($id)) {
-			// We need to guarantee at least one letter in instanceid so it can be used as the session_name
-			$id = 'oc' . \OC::$server->getSecureRandom()->generate(10, \OCP\Security\ISecureRandom::CHAR_LOWER.\OCP\Security\ISecureRandom::CHAR_DIGITS);
-			\OC::$server->getSystemConfig()->setValue('instanceid', $id);
-		}
-		return $id;
-	}
-
-	/**
-	 * Public function 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 string|string[] an array of sanitized strings or a single sanitized string, depends on the input parameter.
-	 */
-	public static function sanitizeHTML($value) {
-		if (is_array($value)) {
-			/** @var string[] $value */
-			$value = array_map(function ($value) {
-				return self::sanitizeHTML($value);
-			}, $value);
-		} else {
-			// Specify encoding for PHP<5.4
-			$value = htmlspecialchars((string)$value, ENT_QUOTES, 'UTF-8');
-		}
-		return $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
-	 */
-	public static function encodePath($component) {
-		$encoded = rawurlencode($component);
-		$encoded = str_replace('%2F', '/', $encoded);
-		return $encoded;
-	}
-
-
-	public function createHtaccessTestFile(\OCP\IConfig $config) {
-		// php dev server does not support htaccess
-		if (php_sapi_name() === 'cli-server') {
-			return false;
-		}
-
-		// testdata
-		$fileName = '/htaccesstest.txt';
-		$testContent = 'This is used for testing whether htaccess is properly enabled to disallow access from the outside. This file can be safely removed.';
-
-		// creating a test file
-		$testFile = $config->getSystemValue('datadirectory', OC::$SERVERROOT . '/data') . '/' . $fileName;
-
-		if (file_exists($testFile)) {// already running this test, possible recursive call
-			return false;
-		}
-
-		$fp = @fopen($testFile, 'w');
-		if (!$fp) {
-			throw new \OCP\HintException('Can\'t create test file to check for working .htaccess file.',
-				'Make sure it is possible for the web server to write to ' . $testFile);
-		}
-		fwrite($fp, $testContent);
-		fclose($fp);
-
-		return $testContent;
-	}
-
-	/**
-	 * Check if the .htaccess file is working
-	 *
-	 * @param \OCP\IConfig $config
-	 * @return bool
-	 * @throws Exception
-	 * @throws \OCP\HintException If the test file can't get written.
-	 */
-	public function isHtaccessWorking(\OCP\IConfig $config) {
-		if (\OC::$CLI || !$config->getSystemValue('check_for_working_htaccess', true)) {
-			return true;
-		}
-
-		$testContent = $this->createHtaccessTestFile($config);
-		if ($testContent === false) {
-			return false;
-		}
-
-		$fileName = '/htaccesstest.txt';
-		$testFile = $config->getSystemValue('datadirectory', OC::$SERVERROOT . '/data') . '/' . $fileName;
-
-		// accessing the file via http
-		$url = \OC::$server->getURLGenerator()->getAbsoluteURL(OC::$WEBROOT . '/data' . $fileName);
-		try {
-			$content = \OC::$server->getHTTPClientService()->newClient()->get($url)->getBody();
-		} catch (\Exception $e) {
-			$content = false;
-		}
-
-		if (strpos($url, 'https:') === 0) {
-			$url = 'http:' . substr($url, 6);
-		} else {
-			$url = 'https:' . substr($url, 5);
-		}
-
-		try {
-			$fallbackContent = \OC::$server->getHTTPClientService()->newClient()->get($url)->getBody();
-		} catch (\Exception $e) {
-			$fallbackContent = false;
-		}
-
-		// cleanup
-		@unlink($testFile);
-
-		/*
+            if ($mount->getOption('readonly', false)) {
+                return new \OC\Files\Storage\Wrapper\PermissionsMask([
+                    'storage' => $storage,
+                    'mask' => \OCP\Constants::PERMISSION_ALL & ~(
+                        \OCP\Constants::PERMISSION_UPDATE |
+                        \OCP\Constants::PERMISSION_CREATE |
+                        \OCP\Constants::PERMISSION_DELETE
+                    ),
+                ]);
+            }
+            return $storage;
+        });
+
+        OC_Hook::emit('OC_Filesystem', 'preSetup', ['user' => $user]);
+
+        \OC\Files\Filesystem::logWarningWhenAddingStorageWrapper($prevLogging);
+
+        //check if we are using an object storage
+        $objectStore = \OC::$server->getSystemConfig()->getValue('objectstore', null);
+        $objectStoreMultibucket = \OC::$server->getSystemConfig()->getValue('objectstore_multibucket', null);
+
+        // use the same order as in ObjectHomeMountProvider
+        if (isset($objectStoreMultibucket)) {
+            self::initObjectStoreMultibucketRootFS($objectStoreMultibucket);
+        } elseif (isset($objectStore)) {
+            self::initObjectStoreRootFS($objectStore);
+        } else {
+            self::initLocalStorageRootFS();
+        }
+
+        /** @var \OCP\Files\Config\IMountProviderCollection $mountProviderCollection */
+        $mountProviderCollection = \OC::$server->query(\OCP\Files\Config\IMountProviderCollection::class);
+        $rootMountProviders = $mountProviderCollection->getRootMounts();
+
+        /** @var \OC\Files\Mount\Manager $mountManager */
+        $mountManager = \OC\Files\Filesystem::getMountManager();
+        foreach ($rootMountProviders as $rootMountProvider) {
+            $mountManager->addMount($rootMountProvider);
+        }
+
+        if ($user != '' && !\OC::$server->getUserManager()->userExists($user)) {
+            \OC::$server->getEventLogger()->end('setup_fs');
+            return false;
+        }
+
+        //if we aren't logged in, there is no use to set up the filesystem
+        if ($user != "") {
+            $userDir = '/' . $user . '/files';
+
+            //jail the user into his "home" directory
+            \OC\Files\Filesystem::init($user, $userDir);
+
+            OC_Hook::emit('OC_Filesystem', 'setup', ['user' => $user, 'user_dir' => $userDir]);
+        }
+        \OC::$server->getEventLogger()->end('setup_fs');
+        return true;
+    }
+
+    /**
+     * check if a password is required for each public link
+     *
+     * @return boolean
+     * @suppress PhanDeprecatedFunction
+     */
+    public static function isPublicLinkPasswordRequired() {
+        /** @var IManager $shareManager */
+        $shareManager = \OC::$server->get(IManager::class);
+        return $shareManager->shareApiLinkEnforcePassword();
+    }
+
+    /**
+     * check if sharing is disabled for the current user
+     * @param IConfig $config
+     * @param IGroupManager $groupManager
+     * @param IUser|null $user
+     * @return bool
+     */
+    public static function isSharingDisabledForUser(IConfig $config, IGroupManager $groupManager, $user) {
+        /** @var IManager $shareManager */
+        $shareManager = \OC::$server->get(IManager::class);
+        $userId = $user ? $user->getUID() : null;
+        return $shareManager->sharingDisabledForUser($userId);
+    }
+
+    /**
+     * check if share API enforces a default expire date
+     *
+     * @return boolean
+     * @suppress PhanDeprecatedFunction
+     */
+    public static function isDefaultExpireDateEnforced() {
+        /** @var IManager $shareManager */
+        $shareManager = \OC::$server->get(IManager::class);
+        return $shareManager->shareApiLinkDefaultExpireDateEnforced();
+    }
+
+    /**
+     * Get the quota of a user
+     *
+     * @param IUser|null $user
+     * @return float Quota bytes
+     */
+    public static function getUserQuota(?IUser $user) {
+        if (is_null($user)) {
+            return \OCP\Files\FileInfo::SPACE_UNLIMITED;
+        }
+        $userQuota = $user->getQuota();
+        if ($userQuota === 'none') {
+            return \OCP\Files\FileInfo::SPACE_UNLIMITED;
+        }
+        return OC_Helper::computerFileSize($userQuota);
+    }
+
+    /**
+     * copies the skeleton to the users /files
+     *
+     * @param string $userId
+     * @param \OCP\Files\Folder $userDirectory
+     * @throws \OCP\Files\NotFoundException
+     * @throws \OCP\Files\NotPermittedException
+     * @suppress PhanDeprecatedFunction
+     */
+    public static function copySkeleton($userId, \OCP\Files\Folder $userDirectory) {
+        /** @var LoggerInterface $logger */
+        $logger = \OC::$server->get(LoggerInterface::class);
+
+        $plainSkeletonDirectory = \OC::$server->getConfig()->getSystemValue('skeletondirectory', \OC::$SERVERROOT . '/core/skeleton');
+        $userLang = \OC::$server->getL10NFactory()->findLanguage();
+        $skeletonDirectory = str_replace('{lang}', $userLang, $plainSkeletonDirectory);
+
+        if (!file_exists($skeletonDirectory)) {
+            $dialectStart = strpos($userLang, '_');
+            if ($dialectStart !== false) {
+                $skeletonDirectory = str_replace('{lang}', substr($userLang, 0, $dialectStart), $plainSkeletonDirectory);
+            }
+            if ($dialectStart === false || !file_exists($skeletonDirectory)) {
+                $skeletonDirectory = str_replace('{lang}', 'default', $plainSkeletonDirectory);
+            }
+            if (!file_exists($skeletonDirectory)) {
+                $skeletonDirectory = '';
+            }
+        }
+
+        $instanceId = \OC::$server->getConfig()->getSystemValue('instanceid', '');
+
+        if ($instanceId === null) {
+            throw new \RuntimeException('no instance id!');
+        }
+        $appdata = 'appdata_' . $instanceId;
+        if ($userId === $appdata) {
+            throw new \RuntimeException('username is reserved name: ' . $appdata);
+        }
+
+        if (!empty($skeletonDirectory)) {
+            $logger->debug('copying skeleton for '.$userId.' from '.$skeletonDirectory.' to '.$userDirectory->getFullPath('/'), ['app' => 'files_skeleton']);
+            self::copyr($skeletonDirectory, $userDirectory);
+            // update the file cache
+            $userDirectory->getStorage()->getScanner()->scan('', \OC\Files\Cache\Scanner::SCAN_RECURSIVE);
+
+            /** @var ITemplateManager $templateManager */
+            $templateManager = \OC::$server->get(ITemplateManager::class);
+            $templateManager->initializeTemplateDirectory(null, $userId);
+        }
+    }
+
+    /**
+     * copies a directory recursively by using streams
+     *
+     * @param string $source
+     * @param \OCP\Files\Folder $target
+     * @return void
+     */
+    public static function copyr($source, \OCP\Files\Folder $target) {
+        $logger = \OC::$server->getLogger();
+
+        // Verify if folder exists
+        $dir = opendir($source);
+        if ($dir === false) {
+            $logger->error(sprintf('Could not opendir "%s"', $source), ['app' => 'core']);
+            return;
+        }
+
+        // Copy the files
+        while (false !== ($file = readdir($dir))) {
+            if (!\OC\Files\Filesystem::isIgnoredDir($file)) {
+                if (is_dir($source . '/' . $file)) {
+                    $child = $target->newFolder($file);
+                    self::copyr($source . '/' . $file, $child);
+                } else {
+                    $child = $target->newFile($file);
+                    $sourceStream = fopen($source . '/' . $file, 'r');
+                    if ($sourceStream === false) {
+                        $logger->error(sprintf('Could not fopen "%s"', $source . '/' . $file), ['app' => 'core']);
+                        closedir($dir);
+                        return;
+                    }
+                    stream_copy_to_stream($sourceStream, $child->fopen('w'));
+                }
+            }
+        }
+        closedir($dir);
+    }
+
+    /**
+     * @return void
+     * @suppress PhanUndeclaredMethod
+     */
+    public static function tearDownFS() {
+        \OC\Files\Filesystem::tearDown();
+        \OC::$server->getRootFolder()->clearCache();
+        self::$fsSetup = false;
+        self::$rootMounted = false;
+    }
+
+    /**
+     * get the current installed version of ownCloud
+     *
+     * @return array
+     */
+    public static function getVersion() {
+        OC_Util::loadVersion();
+        return self::$versionCache['OC_Version'];
+    }
+
+    /**
+     * get the current installed version string of ownCloud
+     *
+     * @return string
+     */
+    public static function getVersionString() {
+        OC_Util::loadVersion();
+        return self::$versionCache['OC_VersionString'];
+    }
+
+    /**
+     * @deprecated the value is of no use anymore
+     * @return string
+     */
+    public static function getEditionString() {
+        return '';
+    }
+
+    /**
+     * @description get the update channel of the current installed of ownCloud.
+     * @return string
+     */
+    public static function getChannel() {
+        OC_Util::loadVersion();
+        return \OC::$server->getConfig()->getSystemValue('updater.release.channel', self::$versionCache['OC_Channel']);
+    }
+
+    /**
+     * @description get the build number of the current installed of ownCloud.
+     * @return string
+     */
+    public static function getBuild() {
+        OC_Util::loadVersion();
+        return self::$versionCache['OC_Build'];
+    }
+
+    /**
+     * @description load the version.php into the session as cache
+     * @suppress PhanUndeclaredVariable
+     */
+    private static function loadVersion() {
+        if (self::$versionCache !== null) {
+            return;
+        }
+
+        $timestamp = filemtime(OC::$SERVERROOT . '/version.php');
+        require OC::$SERVERROOT . '/version.php';
+        /** @var int $timestamp */
+        self::$versionCache['OC_Version_Timestamp'] = $timestamp;
+        /** @var string $OC_Version */
+        self::$versionCache['OC_Version'] = $OC_Version;
+        /** @var string $OC_VersionString */
+        self::$versionCache['OC_VersionString'] = $OC_VersionString;
+        /** @var string $OC_Build */
+        self::$versionCache['OC_Build'] = $OC_Build;
+
+        /** @var string $OC_Channel */
+        self::$versionCache['OC_Channel'] = $OC_Channel;
+    }
+
+    /**
+     * generates a path for JS/CSS files. If no application is provided it will create the path for core.
+     *
+     * @param string $application application to get the files from
+     * @param string $directory directory within this application (css, js, vendor, etc)
+     * @param string $file the file inside of the above folder
+     * @return string the path
+     */
+    private static function generatePath($application, $directory, $file) {
+        if (is_null($file)) {
+            $file = $application;
+            $application = "";
+        }
+        if (!empty($application)) {
+            return "$application/$directory/$file";
+        } else {
+            return "$directory/$file";
+        }
+    }
+
+    /**
+     * add a javascript file
+     *
+     * @deprecated 24.0.0 - Use \OCP\Util::addScript
+     *
+     * @param string $application application id
+     * @param string|null $file filename
+     * @param bool $prepend prepend the Script to the beginning of the list
+     * @return void
+     */
+    public static function addScript($application, $file = null, $prepend = false) {
+        $path = OC_Util::generatePath($application, 'js', $file);
+
+        // core js files need separate handling
+        if ($application !== 'core' && $file !== null) {
+            self::addTranslations($application);
+        }
+        self::addExternalResource($application, $prepend, $path, "script");
+    }
+
+    /**
+     * add a javascript file from the vendor sub folder
+     *
+     * @param string $application application id
+     * @param string|null $file filename
+     * @param bool $prepend prepend the Script to the beginning of the list
+     * @return void
+     */
+    public static function addVendorScript($application, $file = null, $prepend = false) {
+        $path = OC_Util::generatePath($application, 'vendor', $file);
+        self::addExternalResource($application, $prepend, $path, "script");
+    }
+
+    /**
+     * add a translation JS file
+     *
+     * @deprecated 24.0.0
+     *
+     * @param string $application application id
+     * @param string|null $languageCode language code, defaults to the current language
+     * @param bool|null $prepend prepend the Script to the beginning of the list
+     */
+    public static function addTranslations($application, $languageCode = null, $prepend = false) {
+        if (is_null($languageCode)) {
+            $languageCode = \OC::$server->getL10NFactory()->findLanguage($application);
+        }
+        if (!empty($application)) {
+            $path = "$application/l10n/$languageCode";
+        } else {
+            $path = "l10n/$languageCode";
+        }
+        self::addExternalResource($application, $prepend, $path, "script");
+    }
+
+    /**
+     * add a css file
+     *
+     * @param string $application application id
+     * @param string|null $file filename
+     * @param bool $prepend prepend the Style to the beginning of the list
+     * @return void
+     */
+    public static function addStyle($application, $file = null, $prepend = false) {
+        $path = OC_Util::generatePath($application, 'css', $file);
+        self::addExternalResource($application, $prepend, $path, "style");
+    }
+
+    /**
+     * add a css file from the vendor sub folder
+     *
+     * @param string $application application id
+     * @param string|null $file filename
+     * @param bool $prepend prepend the Style to the beginning of the list
+     * @return void
+     */
+    public static function addVendorStyle($application, $file = null, $prepend = false) {
+        $path = OC_Util::generatePath($application, 'vendor', $file);
+        self::addExternalResource($application, $prepend, $path, "style");
+    }
+
+    /**
+     * add an external resource css/js file
+     *
+     * @param string $application application id
+     * @param bool $prepend prepend the file to the beginning of the list
+     * @param string $path
+     * @param string $type (script or style)
+     * @return void
+     */
+    private static function addExternalResource($application, $prepend, $path, $type = "script") {
+        if ($type === "style") {
+            if (!in_array($path, self::$styles)) {
+                if ($prepend === true) {
+                    array_unshift(self::$styles, $path);
+                } else {
+                    self::$styles[] = $path;
+                }
+            }
+        } elseif ($type === "script") {
+            if (!in_array($path, self::$scripts)) {
+                if ($prepend === true) {
+                    array_unshift(self::$scripts, $path);
+                } else {
+                    self::$scripts [] = $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
+     * @param bool $prepend prepend the header to the beginning of the list
+     */
+    public static function addHeader($tag, $attributes, $text = null, $prepend = false) {
+        $header = [
+            'tag' => $tag,
+            'attributes' => $attributes,
+            'text' => $text
+        ];
+        if ($prepend === true) {
+            array_unshift(self::$headers, $header);
+        } else {
+            self::$headers[] = $header;
+        }
+    }
+
+    /**
+     * check if the current server configuration is suitable for ownCloud
+     *
+     * @param \OC\SystemConfig $config
+     * @return array arrays with error messages and hints
+     */
+    public static function checkServer(\OC\SystemConfig $config) {
+        $l = \OC::$server->getL10N('lib');
+        $errors = [];
+        $CONFIG_DATADIRECTORY = $config->getValue('datadirectory', OC::$SERVERROOT . '/data');
+
+        if (!self::needUpgrade($config) && $config->getValue('installed', false)) {
+            // this check needs to be done every time
+            $errors = self::checkDataDirectoryValidity($CONFIG_DATADIRECTORY);
+        }
+
+        // Assume that if checkServer() succeeded before in this session, then all is fine.
+        if (\OC::$server->getSession()->exists('checkServer_succeeded') && \OC::$server->getSession()->get('checkServer_succeeded')) {
+            return $errors;
+        }
+
+        $webServerRestart = false;
+        $setup = new \OC\Setup(
+            $config,
+            \OC::$server->get(IniGetWrapper::class),
+            \OC::$server->getL10N('lib'),
+            \OC::$server->get(\OCP\Defaults::class),
+            \OC::$server->get(LoggerInterface::class),
+            \OC::$server->getSecureRandom(),
+            \OC::$server->get(\OC\Installer::class)
+        );
+
+        $urlGenerator = \OC::$server->getURLGenerator();
+
+        $availableDatabases = $setup->getSupportedDatabases();
+        if (empty($availableDatabases)) {
+            $errors[] = [
+                'error' => $l->t('No database drivers (sqlite, mysql, or postgresql) installed.'),
+                'hint' => '' //TODO: sane hint
+            ];
+            $webServerRestart = true;
+        }
+
+        // Check if config folder is writable.
+        if (!OC_Helper::isReadOnlyConfigEnabled()) {
+            if (!is_writable(OC::$configDir) or !is_readable(OC::$configDir)) {
+                $errors[] = [
+                    'error' => $l->t('Cannot write into "config" directory.'),
+                    'hint' => $l->t('This can usually be fixed by giving the web server write access to the config directory. See %s',
+                        [ $urlGenerator->linkToDocs('admin-dir_permissions') ]) . '. '
+                        . $l->t('Or, if you prefer to keep config.php file read only, set the option "config_is_read_only" to true in it. See %s',
+                        [ $urlGenerator->linkToDocs('admin-config') ])
+                ];
+            }
+        }
+
+        // Check if there is a writable install folder.
+        if ($config->getValue('appstoreenabled', true)) {
+            if (OC_App::getInstallPath() === null
+                || !is_writable(OC_App::getInstallPath())
+                || !is_readable(OC_App::getInstallPath())
+            ) {
+                $errors[] = [
+                    'error' => $l->t('Cannot write into "apps" directory.'),
+                    'hint' => $l->t('This can usually be fixed by giving the web server write access to the apps directory'
+                        . ' or disabling the App Store in the config file.')
+                ];
+            }
+        }
+        // Create root dir.
+        if ($config->getValue('installed', false)) {
+            if (!is_dir($CONFIG_DATADIRECTORY)) {
+                $success = @mkdir($CONFIG_DATADIRECTORY);
+                if ($success) {
+                    $errors = array_merge($errors, self::checkDataDirectoryPermissions($CONFIG_DATADIRECTORY));
+                } else {
+                    $errors[] = [
+                        'error' => $l->t('Cannot create "data" directory.'),
+                        'hint' => $l->t('This can usually be fixed by giving the web server write access to the root directory. See %s',
+                            [$urlGenerator->linkToDocs('admin-dir_permissions')])
+                    ];
+                }
+            } elseif (!is_writable($CONFIG_DATADIRECTORY) or !is_readable($CONFIG_DATADIRECTORY)) {
+                // is_writable doesn't work for NFS mounts, so try to write a file and check if it exists.
+                $testFile = sprintf('%s/%s.tmp', $CONFIG_DATADIRECTORY, uniqid('data_dir_writability_test_'));
+                $handle = fopen($testFile, 'w');
+                if (!$handle || fwrite($handle, 'Test write operation') === false) {
+                    $permissionsHint = $l->t('Permissions can usually be fixed by giving the web server write access to the root directory. See %s.',
+                        [$urlGenerator->linkToDocs('admin-dir_permissions')]);
+                    $errors[] = [
+                        'error' => $l->t('Your data directory is not writable.'),
+                        'hint' => $permissionsHint
+                    ];
+                } else {
+                    fclose($handle);
+                    unlink($testFile);
+                }
+            } else {
+                $errors = array_merge($errors, self::checkDataDirectoryPermissions($CONFIG_DATADIRECTORY));
+            }
+        }
+
+        if (!OC_Util::isSetLocaleWorking()) {
+            $errors[] = [
+                'error' => $l->t('Setting locale to %s failed.',
+                    ['en_US.UTF-8/fr_FR.UTF-8/es_ES.UTF-8/de_DE.UTF-8/ru_RU.UTF-8/'
+                        . 'pt_BR.UTF-8/it_IT.UTF-8/ja_JP.UTF-8/zh_CN.UTF-8']),
+                'hint' => $l->t('Please install one of these locales on your system and restart your web server.')
+            ];
+        }
+
+        // Contains the dependencies that should be checked against
+        // classes = class_exists
+        // functions = function_exists
+        // defined = defined
+        // ini = ini_get
+        // If the dependency is not found the missing module name is shown to the EndUser
+        // When adding new checks always verify that they pass on Travis as well
+        // for ini settings, see https://github.com/owncloud/administration/blob/master/travis-ci/custom.ini
+        $dependencies = [
+            'classes' => [
+                'ZipArchive' => 'zip',
+                'DOMDocument' => 'dom',
+                'XMLWriter' => 'XMLWriter',
+                'XMLReader' => 'XMLReader',
+            ],
+            'functions' => [
+                'xml_parser_create' => 'libxml',
+                'mb_strcut' => 'mbstring',
+                'ctype_digit' => 'ctype',
+                'json_encode' => 'JSON',
+                'gd_info' => 'GD',
+                'gzencode' => 'zlib',
+                'simplexml_load_string' => 'SimpleXML',
+                'hash' => 'HASH Message Digest Framework',
+                'curl_init' => 'cURL',
+                'openssl_verify' => 'OpenSSL',
+            ],
+            'defined' => [
+                'PDO::ATTR_DRIVER_NAME' => 'PDO'
+            ],
+            'ini' => [
+                'default_charset' => 'UTF-8',
+            ],
+        ];
+        $missingDependencies = [];
+        $invalidIniSettings = [];
+
+        $iniWrapper = \OC::$server->get(IniGetWrapper::class);
+        foreach ($dependencies['classes'] as $class => $module) {
+            if (!class_exists($class)) {
+                $missingDependencies[] = $module;
+            }
+        }
+        foreach ($dependencies['functions'] as $function => $module) {
+            if (!function_exists($function)) {
+                $missingDependencies[] = $module;
+            }
+        }
+        foreach ($dependencies['defined'] as $defined => $module) {
+            if (!defined($defined)) {
+                $missingDependencies[] = $module;
+            }
+        }
+        foreach ($dependencies['ini'] as $setting => $expected) {
+            if (is_bool($expected)) {
+                if ($iniWrapper->getBool($setting) !== $expected) {
+                    $invalidIniSettings[] = [$setting, $expected];
+                }
+            }
+            if (is_int($expected)) {
+                if ($iniWrapper->getNumeric($setting) !== $expected) {
+                    $invalidIniSettings[] = [$setting, $expected];
+                }
+            }
+            if (is_string($expected)) {
+                if (strtolower($iniWrapper->getString($setting)) !== strtolower($expected)) {
+                    $invalidIniSettings[] = [$setting, $expected];
+                }
+            }
+        }
+
+        foreach ($missingDependencies as $missingDependency) {
+            $errors[] = [
+                'error' => $l->t('PHP module %s not installed.', [$missingDependency]),
+                'hint' => $l->t('Please ask your server administrator to install the module.'),
+            ];
+            $webServerRestart = true;
+        }
+        foreach ($invalidIniSettings as $setting) {
+            if (is_bool($setting[1])) {
+                $setting[1] = $setting[1] ? 'on' : 'off';
+            }
+            $errors[] = [
+                'error' => $l->t('PHP setting "%s" is not set to "%s".', [$setting[0], var_export($setting[1], true)]),
+                'hint' => $l->t('Adjusting this setting in php.ini will make Nextcloud run again')
+            ];
+            $webServerRestart = true;
+        }
+
+        /**
+         * The mbstring.func_overload check can only be performed if the mbstring
+         * module is installed as it will return null if the checking setting is
+         * not available and thus a check on the boolean value fails.
+         *
+         * TODO: Should probably be implemented in the above generic dependency
+         *       check somehow in the long-term.
+         */
+        if ($iniWrapper->getBool('mbstring.func_overload') !== null &&
+            $iniWrapper->getBool('mbstring.func_overload') === true) {
+            $errors[] = [
+                'error' => $l->t('<code>mbstring.func_overload</code> is set to <code>%s</code> instead of the expected value <code>0</code>.', [$iniWrapper->getString('mbstring.func_overload')]),
+                'hint' => $l->t('To fix this issue set <code>mbstring.func_overload</code> to <code>0</code> in your php.ini.')
+            ];
+        }
+
+        if (function_exists('xml_parser_create') &&
+            LIBXML_LOADED_VERSION < 20700) {
+            $version = LIBXML_LOADED_VERSION;
+            $major = floor($version / 10000);
+            $version -= ($major * 10000);
+            $minor = floor($version / 100);
+            $version -= ($minor * 100);
+            $patch = $version;
+            $errors[] = [
+                'error' => $l->t('libxml2 2.7.0 is at least required. Currently %s is installed.', [$major . '.' . $minor . '.' . $patch]),
+                'hint' => $l->t('To fix this issue update your libxml2 version and restart your web server.')
+            ];
+        }
+
+        if (!self::isAnnotationsWorking()) {
+            $errors[] = [
+                'error' => $l->t('PHP is apparently set up to strip inline doc blocks. This will make several core apps inaccessible.'),
+                'hint' => $l->t('This is probably caused by a cache/accelerator such as Zend OPcache or eAccelerator.')
+            ];
+        }
+
+        if (!\OC::$CLI && $webServerRestart) {
+            $errors[] = [
+                'error' => $l->t('PHP modules have been installed, but they are still listed as missing?'),
+                'hint' => $l->t('Please ask your server administrator to restart the web server.')
+            ];
+        }
+
+        $errors = array_merge($errors, self::checkDatabaseVersion());
+
+        // Cache the result of this function
+        \OC::$server->getSession()->set('checkServer_succeeded', count($errors) == 0);
+
+        return $errors;
+    }
+
+    /**
+     * Check the database version
+     *
+     * @return array errors array
+     */
+    public static function checkDatabaseVersion() {
+        $l = \OC::$server->getL10N('lib');
+        $errors = [];
+        $dbType = \OC::$server->getSystemConfig()->getValue('dbtype', 'sqlite');
+        if ($dbType === 'pgsql') {
+            // check PostgreSQL version
+            try {
+                $result = \OC_DB::executeAudited('SHOW SERVER_VERSION');
+                $data = $result->fetchRow();
+                $result->closeCursor();
+                if (isset($data['server_version'])) {
+                    $version = $data['server_version'];
+                    if (version_compare($version, '9.0.0', '<')) {
+                        $errors[] = [
+                            'error' => $l->t('PostgreSQL >= 9 required.'),
+                            'hint' => $l->t('Please upgrade your database version.')
+                        ];
+                    }
+                }
+            } catch (\Doctrine\DBAL\Exception $e) {
+                $logger = \OC::$server->getLogger();
+                $logger->warning('Error occurred while checking PostgreSQL version, assuming >= 9');
+                $logger->logException($e);
+            }
+        }
+        return $errors;
+    }
+
+    /**
+     * Check for correct file permissions of data directory
+     *
+     * @param string $dataDirectory
+     * @return array arrays with error messages and hints
+     */
+    public static function checkDataDirectoryPermissions($dataDirectory) {
+        if (\OC::$server->getConfig()->getSystemValue('check_data_directory_permissions', true) === false) {
+            return  [];
+        }
+
+        $perms = substr(decoct(@fileperms($dataDirectory)), -3);
+        if (substr($perms, -1) !== '0') {
+            chmod($dataDirectory, 0770);
+            clearstatcache();
+            $perms = substr(decoct(@fileperms($dataDirectory)), -3);
+            if ($perms[2] !== '0') {
+                $l = \OC::$server->getL10N('lib');
+                return [[
+                    'error' => $l->t('Your data directory is readable by other users.'),
+                    'hint' => $l->t('Please change the permissions to 0770 so that the directory cannot be listed by other users.'),
+                ]];
+            }
+        }
+        return [];
+    }
+
+    /**
+     * Check that the data directory exists and is valid by
+     * checking the existence of the ".ocdata" file.
+     *
+     * @param string $dataDirectory data directory path
+     * @return array errors found
+     */
+    public static function checkDataDirectoryValidity($dataDirectory) {
+        $l = \OC::$server->getL10N('lib');
+        $errors = [];
+        if ($dataDirectory[0] !== '/') {
+            $errors[] = [
+                'error' => $l->t('Your data directory must be an absolute path.'),
+                'hint' => $l->t('Check the value of "datadirectory" in your configuration.')
+            ];
+        }
+        if (!file_exists($dataDirectory . '/.ocdata')) {
+            $errors[] = [
+                'error' => $l->t('Your data directory is invalid.'),
+                'hint' => $l->t('Ensure there is a file called ".ocdata"' .
+                    ' in the root of the data directory.')
+            ];
+        }
+        return $errors;
+    }
+
+    /**
+     * Check if the user is logged in, redirects to home if not. With
+     * redirect URL parameter to the request URI.
+     *
+     * @return void
+     */
+    public static function checkLoggedIn() {
+        // Check if we are a user
+        if (!\OC::$server->getUserSession()->isLoggedIn()) {
+            header('Location: ' . \OC::$server->getURLGenerator()->linkToRoute(
+                        'core.login.showLoginForm',
+                        [
+                            'redirect_url' => \OC::$server->getRequest()->getRequestUri(),
+                        ]
+                    )
+            );
+            exit();
+        }
+        // Redirect to 2FA challenge selection if 2FA challenge was not solved yet
+        if (\OC::$server->getTwoFactorAuthManager()->needsSecondFactor(\OC::$server->getUserSession()->getUser())) {
+            header('Location: ' . \OC::$server->getURLGenerator()->linkToRoute('core.TwoFactorChallenge.selectChallenge'));
+            exit();
+        }
+    }
+
+    /**
+     * Check if the user is a admin, redirects to home if not
+     *
+     * @return void
+     */
+    public static function checkAdminUser() {
+        OC_Util::checkLoggedIn();
+        if (!OC_User::isAdminUser(OC_User::getUser())) {
+            header('Location: ' . \OCP\Util::linkToAbsolute('', 'index.php'));
+            exit();
+        }
+    }
+
+    /**
+     * Returns the URL of the default page
+     * based on the system configuration and
+     * the apps visible for the current user
+     *
+     * @return string URL
+     * @suppress PhanDeprecatedFunction
+     */
+    public static function getDefaultPageUrl() {
+        /** @var IURLGenerator $urlGenerator */
+        $urlGenerator = \OC::$server->get(IURLGenerator::class);
+        return $urlGenerator->linkToDefaultPageUrl();
+    }
+
+    /**
+     * Redirect to the user default page
+     *
+     * @return void
+     */
+    public static function redirectToDefaultPage() {
+        $location = self::getDefaultPageUrl();
+        header('Location: ' . $location);
+        exit();
+    }
+
+    /**
+     * get an id unique for this instance
+     *
+     * @return string
+     */
+    public static function getInstanceId() {
+        $id = \OC::$server->getSystemConfig()->getValue('instanceid', null);
+        if (is_null($id)) {
+            // We need to guarantee at least one letter in instanceid so it can be used as the session_name
+            $id = 'oc' . \OC::$server->getSecureRandom()->generate(10, \OCP\Security\ISecureRandom::CHAR_LOWER.\OCP\Security\ISecureRandom::CHAR_DIGITS);
+            \OC::$server->getSystemConfig()->setValue('instanceid', $id);
+        }
+        return $id;
+    }
+
+    /**
+     * Public function 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 string|string[] an array of sanitized strings or a single sanitized string, depends on the input parameter.
+     */
+    public static function sanitizeHTML($value) {
+        if (is_array($value)) {
+            /** @var string[] $value */
+            $value = array_map(function ($value) {
+                return self::sanitizeHTML($value);
+            }, $value);
+        } else {
+            // Specify encoding for PHP<5.4
+            $value = htmlspecialchars((string)$value, ENT_QUOTES, 'UTF-8');
+        }
+        return $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
+     */
+    public static function encodePath($component) {
+        $encoded = rawurlencode($component);
+        $encoded = str_replace('%2F', '/', $encoded);
+        return $encoded;
+    }
+
+
+    public function createHtaccessTestFile(\OCP\IConfig $config) {
+        // php dev server does not support htaccess
+        if (php_sapi_name() === 'cli-server') {
+            return false;
+        }
+
+        // testdata
+        $fileName = '/htaccesstest.txt';
+        $testContent = 'This is used for testing whether htaccess is properly enabled to disallow access from the outside. This file can be safely removed.';
+
+        // creating a test file
+        $testFile = $config->getSystemValue('datadirectory', OC::$SERVERROOT . '/data') . '/' . $fileName;
+
+        if (file_exists($testFile)) {// already running this test, possible recursive call
+            return false;
+        }
+
+        $fp = @fopen($testFile, 'w');
+        if (!$fp) {
+            throw new \OCP\HintException('Can\'t create test file to check for working .htaccess file.',
+                'Make sure it is possible for the web server to write to ' . $testFile);
+        }
+        fwrite($fp, $testContent);
+        fclose($fp);
+
+        return $testContent;
+    }
+
+    /**
+     * Check if the .htaccess file is working
+     *
+     * @param \OCP\IConfig $config
+     * @return bool
+     * @throws Exception
+     * @throws \OCP\HintException If the test file can't get written.
+     */
+    public function isHtaccessWorking(\OCP\IConfig $config) {
+        if (\OC::$CLI || !$config->getSystemValue('check_for_working_htaccess', true)) {
+            return true;
+        }
+
+        $testContent = $this->createHtaccessTestFile($config);
+        if ($testContent === false) {
+            return false;
+        }
+
+        $fileName = '/htaccesstest.txt';
+        $testFile = $config->getSystemValue('datadirectory', OC::$SERVERROOT . '/data') . '/' . $fileName;
+
+        // accessing the file via http
+        $url = \OC::$server->getURLGenerator()->getAbsoluteURL(OC::$WEBROOT . '/data' . $fileName);
+        try {
+            $content = \OC::$server->getHTTPClientService()->newClient()->get($url)->getBody();
+        } catch (\Exception $e) {
+            $content = false;
+        }
+
+        if (strpos($url, 'https:') === 0) {
+            $url = 'http:' . substr($url, 6);
+        } else {
+            $url = 'https:' . substr($url, 5);
+        }
+
+        try {
+            $fallbackContent = \OC::$server->getHTTPClientService()->newClient()->get($url)->getBody();
+        } catch (\Exception $e) {
+            $fallbackContent = false;
+        }
+
+        // cleanup
+        @unlink($testFile);
+
+        /*
 		 * If the content is not equal to test content our .htaccess
 		 * is working as required
 		 */
-		return $content !== $testContent && $fallbackContent !== $testContent;
-	}
-
-	/**
-	 * Check if current locale is non-UTF8
-	 *
-	 * @return bool
-	 */
-	private static function isNonUTF8Locale() {
-		if (function_exists('escapeshellcmd')) {
-			return '' === escapeshellcmd('§');
-		} elseif (function_exists('escapeshellarg')) {
-			return '\'\'' === escapeshellarg('§');
-		} else {
-			return 0 === preg_match('/utf-?8/i', setlocale(LC_CTYPE, 0));
-		}
-	}
-
-	/**
-	 * Check if the setlocale call does not work. This can happen if the right
-	 * local packages are not available on the server.
-	 *
-	 * @return bool
-	 */
-	public static function isSetLocaleWorking() {
-		if (self::isNonUTF8Locale()) {
-			// Borrowed from \Patchwork\Utf8\Bootup::initLocale
-			setlocale(LC_ALL, 'C.UTF-8', 'C');
-			setlocale(LC_CTYPE, 'en_US.UTF-8', 'fr_FR.UTF-8', 'es_ES.UTF-8', 'de_DE.UTF-8', 'ru_RU.UTF-8', 'pt_BR.UTF-8', 'it_IT.UTF-8', 'ja_JP.UTF-8', 'zh_CN.UTF-8', '0');
-
-			// Check again
-			if (self::isNonUTF8Locale()) {
-				return false;
-			}
-		}
-
-		return true;
-	}
-
-	/**
-	 * Check if it's possible to get the inline annotations
-	 *
-	 * @return bool
-	 */
-	public static function isAnnotationsWorking() {
-		$reflection = new \ReflectionMethod(__METHOD__);
-		$docs = $reflection->getDocComment();
-
-		return (is_string($docs) && strlen($docs) > 50);
-	}
-
-	/**
-	 * Check if the PHP module fileinfo is loaded.
-	 *
-	 * @return bool
-	 */
-	public static function fileInfoLoaded() {
-		return function_exists('finfo_open');
-	}
-
-	/**
-	 * clear all levels of output buffering
-	 *
-	 * @return void
-	 */
-	public static function obEnd() {
-		while (ob_get_level()) {
-			ob_end_clean();
-		}
-	}
-
-	/**
-	 * Checks whether the server is running on Mac OS X
-	 *
-	 * @return bool true if running on Mac OS X, false otherwise
-	 */
-	public static function runningOnMac() {
-		return (strtoupper(substr(PHP_OS, 0, 6)) === 'DARWIN');
-	}
-
-	/**
-	 * Handles the case that there may not be a theme, then check if a "default"
-	 * theme exists and take that one
-	 *
-	 * @return string the theme
-	 */
-	public static function getTheme() {
-		$theme = \OC::$server->getSystemConfig()->getValue("theme", '');
-
-		if ($theme === '') {
-			if (is_dir(OC::$SERVERROOT . '/themes/default')) {
-				$theme = 'default';
-			}
-		}
-
-		return $theme;
-	}
-
-	/**
-	 * Normalize a unicode string
-	 *
-	 * @param string $value a not normalized string
-	 * @return bool|string
-	 */
-	public static function normalizeUnicode($value) {
-		if (Normalizer::isNormalized($value)) {
-			return $value;
-		}
-
-		$normalizedValue = Normalizer::normalize($value);
-		if ($normalizedValue === null || $normalizedValue === false) {
-			\OC::$server->getLogger()->warning('normalizing failed for "' . $value . '"', ['app' => 'core']);
-			return $value;
-		}
-
-		return $normalizedValue;
-	}
-
-	/**
-	 * A human readable string is generated based on version and build number
-	 *
-	 * @return string
-	 */
-	public static function getHumanVersion() {
-		$version = OC_Util::getVersionString();
-		$build = OC_Util::getBuild();
-		if (!empty($build) and OC_Util::getChannel() === 'daily') {
-			$version .= ' Build:' . $build;
-		}
-		return $version;
-	}
-
-	/**
-	 * Returns whether the given file name is valid
-	 *
-	 * @param string $file file name to check
-	 * @return bool true if the file name is valid, false otherwise
-	 * @deprecated use \OC\Files\View::verifyPath()
-	 */
-	public static function isValidFileName($file) {
-		$trimmed = trim($file);
-		if ($trimmed === '') {
-			return false;
-		}
-		if (\OC\Files\Filesystem::isIgnoredDir($trimmed)) {
-			return false;
-		}
-
-		// detect part files
-		if (preg_match('/' . \OCP\Files\FileInfo::BLACKLIST_FILES_REGEX . '/', $trimmed) !== 0) {
-			return false;
-		}
-
-		foreach (str_split($trimmed) as $char) {
-			if (strpos(\OCP\Constants::FILENAME_INVALID_CHARS, $char) !== false) {
-				return false;
-			}
-		}
-		return true;
-	}
-
-	/**
-	 * Check whether the instance needs to perform an upgrade,
-	 * either when the core version is higher or any app requires
-	 * an upgrade.
-	 *
-	 * @param \OC\SystemConfig $config
-	 * @return bool whether the core or any app needs an upgrade
-	 * @throws \OCP\HintException When the upgrade from the given version is not allowed
-	 */
-	public static function needUpgrade(\OC\SystemConfig $config) {
-		if ($config->getValue('installed', false)) {
-			$installedVersion = $config->getValue('version', '0.0.0');
-			$currentVersion = implode('.', \OCP\Util::getVersion());
-			$versionDiff = version_compare($currentVersion, $installedVersion);
-			if ($versionDiff > 0) {
-				return true;
-			} elseif ($config->getValue('debug', false) && $versionDiff < 0) {
-				// downgrade with debug
-				$installedMajor = explode('.', $installedVersion);
-				$installedMajor = $installedMajor[0] . '.' . $installedMajor[1];
-				$currentMajor = explode('.', $currentVersion);
-				$currentMajor = $currentMajor[0] . '.' . $currentMajor[1];
-				if ($installedMajor === $currentMajor) {
-					// Same major, allow downgrade for developers
-					return true;
-				} else {
-					// downgrade attempt, throw exception
-					throw new \OCP\HintException('Downgrading is not supported and is likely to cause unpredictable issues (from ' . $installedVersion . ' to ' . $currentVersion . ')');
-				}
-			} elseif ($versionDiff < 0) {
-				// downgrade attempt, throw exception
-				throw new \OCP\HintException('Downgrading is not supported and is likely to cause unpredictable issues (from ' . $installedVersion . ' to ' . $currentVersion . ')');
-			}
-
-			// also check for upgrades for apps (independently from the user)
-			$apps = \OC_App::getEnabledApps(false, true);
-			$shouldUpgrade = false;
-			foreach ($apps as $app) {
-				if (\OC_App::shouldUpgrade($app)) {
-					$shouldUpgrade = true;
-					break;
-				}
-			}
-			return $shouldUpgrade;
-		} else {
-			return false;
-		}
-	}
+        return $content !== $testContent && $fallbackContent !== $testContent;
+    }
+
+    /**
+     * Check if current locale is non-UTF8
+     *
+     * @return bool
+     */
+    private static function isNonUTF8Locale() {
+        if (function_exists('escapeshellcmd')) {
+            return '' === escapeshellcmd('§');
+        } elseif (function_exists('escapeshellarg')) {
+            return '\'\'' === escapeshellarg('§');
+        } else {
+            return 0 === preg_match('/utf-?8/i', setlocale(LC_CTYPE, 0));
+        }
+    }
+
+    /**
+     * Check if the setlocale call does not work. This can happen if the right
+     * local packages are not available on the server.
+     *
+     * @return bool
+     */
+    public static function isSetLocaleWorking() {
+        if (self::isNonUTF8Locale()) {
+            // Borrowed from \Patchwork\Utf8\Bootup::initLocale
+            setlocale(LC_ALL, 'C.UTF-8', 'C');
+            setlocale(LC_CTYPE, 'en_US.UTF-8', 'fr_FR.UTF-8', 'es_ES.UTF-8', 'de_DE.UTF-8', 'ru_RU.UTF-8', 'pt_BR.UTF-8', 'it_IT.UTF-8', 'ja_JP.UTF-8', 'zh_CN.UTF-8', '0');
+
+            // Check again
+            if (self::isNonUTF8Locale()) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Check if it's possible to get the inline annotations
+     *
+     * @return bool
+     */
+    public static function isAnnotationsWorking() {
+        $reflection = new \ReflectionMethod(__METHOD__);
+        $docs = $reflection->getDocComment();
+
+        return (is_string($docs) && strlen($docs) > 50);
+    }
+
+    /**
+     * Check if the PHP module fileinfo is loaded.
+     *
+     * @return bool
+     */
+    public static function fileInfoLoaded() {
+        return function_exists('finfo_open');
+    }
+
+    /**
+     * clear all levels of output buffering
+     *
+     * @return void
+     */
+    public static function obEnd() {
+        while (ob_get_level()) {
+            ob_end_clean();
+        }
+    }
+
+    /**
+     * Checks whether the server is running on Mac OS X
+     *
+     * @return bool true if running on Mac OS X, false otherwise
+     */
+    public static function runningOnMac() {
+        return (strtoupper(substr(PHP_OS, 0, 6)) === 'DARWIN');
+    }
+
+    /**
+     * Handles the case that there may not be a theme, then check if a "default"
+     * theme exists and take that one
+     *
+     * @return string the theme
+     */
+    public static function getTheme() {
+        $theme = \OC::$server->getSystemConfig()->getValue("theme", '');
+
+        if ($theme === '') {
+            if (is_dir(OC::$SERVERROOT . '/themes/default')) {
+                $theme = 'default';
+            }
+        }
+
+        return $theme;
+    }
+
+    /**
+     * Normalize a unicode string
+     *
+     * @param string $value a not normalized string
+     * @return bool|string
+     */
+    public static function normalizeUnicode($value) {
+        if (Normalizer::isNormalized($value)) {
+            return $value;
+        }
+
+        $normalizedValue = Normalizer::normalize($value);
+        if ($normalizedValue === null || $normalizedValue === false) {
+            \OC::$server->getLogger()->warning('normalizing failed for "' . $value . '"', ['app' => 'core']);
+            return $value;
+        }
+
+        return $normalizedValue;
+    }
+
+    /**
+     * A human readable string is generated based on version and build number
+     *
+     * @return string
+     */
+    public static function getHumanVersion() {
+        $version = OC_Util::getVersionString();
+        $build = OC_Util::getBuild();
+        if (!empty($build) and OC_Util::getChannel() === 'daily') {
+            $version .= ' Build:' . $build;
+        }
+        return $version;
+    }
+
+    /**
+     * Returns whether the given file name is valid
+     *
+     * @param string $file file name to check
+     * @return bool true if the file name is valid, false otherwise
+     * @deprecated use \OC\Files\View::verifyPath()
+     */
+    public static function isValidFileName($file) {
+        $trimmed = trim($file);
+        if ($trimmed === '') {
+            return false;
+        }
+        if (\OC\Files\Filesystem::isIgnoredDir($trimmed)) {
+            return false;
+        }
+
+        // detect part files
+        if (preg_match('/' . \OCP\Files\FileInfo::BLACKLIST_FILES_REGEX . '/', $trimmed) !== 0) {
+            return false;
+        }
+
+        foreach (str_split($trimmed) as $char) {
+            if (strpos(\OCP\Constants::FILENAME_INVALID_CHARS, $char) !== false) {
+                return false;
+            }
+        }
+        return true;
+    }
+
+    /**
+     * Check whether the instance needs to perform an upgrade,
+     * either when the core version is higher or any app requires
+     * an upgrade.
+     *
+     * @param \OC\SystemConfig $config
+     * @return bool whether the core or any app needs an upgrade
+     * @throws \OCP\HintException When the upgrade from the given version is not allowed
+     */
+    public static function needUpgrade(\OC\SystemConfig $config) {
+        if ($config->getValue('installed', false)) {
+            $installedVersion = $config->getValue('version', '0.0.0');
+            $currentVersion = implode('.', \OCP\Util::getVersion());
+            $versionDiff = version_compare($currentVersion, $installedVersion);
+            if ($versionDiff > 0) {
+                return true;
+            } elseif ($config->getValue('debug', false) && $versionDiff < 0) {
+                // downgrade with debug
+                $installedMajor = explode('.', $installedVersion);
+                $installedMajor = $installedMajor[0] . '.' . $installedMajor[1];
+                $currentMajor = explode('.', $currentVersion);
+                $currentMajor = $currentMajor[0] . '.' . $currentMajor[1];
+                if ($installedMajor === $currentMajor) {
+                    // Same major, allow downgrade for developers
+                    return true;
+                } else {
+                    // downgrade attempt, throw exception
+                    throw new \OCP\HintException('Downgrading is not supported and is likely to cause unpredictable issues (from ' . $installedVersion . ' to ' . $currentVersion . ')');
+                }
+            } elseif ($versionDiff < 0) {
+                // downgrade attempt, throw exception
+                throw new \OCP\HintException('Downgrading is not supported and is likely to cause unpredictable issues (from ' . $installedVersion . ' to ' . $currentVersion . ')');
+            }
+
+            // also check for upgrades for apps (independently from the user)
+            $apps = \OC_App::getEnabledApps(false, true);
+            $shouldUpgrade = false;
+            foreach ($apps as $app) {
+                if (\OC_App::shouldUpgrade($app)) {
+                    $shouldUpgrade = true;
+                    break;
+                }
+            }
+            return $shouldUpgrade;
+        } else {
+            return false;
+        }
+    }
 }

Spacing +44 added lines, -44 removed lines

@@ -92,7 +92,7 @@ 
 
 	private static function initLocalStorageRootFS() {
 		// mount local file backend as root
-		$configDataDirectory = \OC::$server->getSystemConfig()->getValue("datadirectory", OC::$SERVERROOT . "/data");
+		$configDataDirectory = \OC::$server->getSystemConfig()->getValue("datadirectory", OC::$SERVERROOT."/data");
 		//first set up the local "root" storage
 		\OC\Files\Filesystem::initMountManager();
 		if (!self::$rootMounted) {
@@ -214,7 +214,7 @@ 
 		\OC\Files\Filesystem::initMountManager();
 
 		$prevLogging = \OC\Files\Filesystem::logWarningWhenAddingStorageWrapper(false);
-		\OC\Files\Filesystem::addStorageWrapper('mount_options', function ($mountPoint, \OCP\Files\Storage $storage, \OCP\Files\Mount\IMountPoint $mount) {
+		\OC\Files\Filesystem::addStorageWrapper('mount_options', function($mountPoint, \OCP\Files\Storage $storage, \OCP\Files\Mount\IMountPoint $mount) {
 			if ($storage->instanceOfStorage('\OC\Files\Storage\Common')) {
 				/** @var \OC\Files\Storage\Common $storage */
 				$storage->setMountOptions($mount->getOptions());
@@ -222,7 +222,7 @@ 
 			return $storage;
 		});
 
-		\OC\Files\Filesystem::addStorageWrapper('enable_sharing', function ($mountPoint, \OCP\Files\Storage\IStorage $storage, \OCP\Files\Mount\IMountPoint $mount) {
+		\OC\Files\Filesystem::addStorageWrapper('enable_sharing', function($mountPoint, \OCP\Files\Storage\IStorage $storage, \OCP\Files\Mount\IMountPoint $mount) {
 			if (!$mount->getOption('enable_sharing', true)) {
 				return new \OC\Files\Storage\Wrapper\PermissionsMask([
 					'storage' => $storage,
@@ -233,21 +233,21 @@ 
 		});
 
 		// install storage availability wrapper, before most other wrappers
-		\OC\Files\Filesystem::addStorageWrapper('oc_availability', function ($mountPoint, \OCP\Files\Storage\IStorage $storage) {
+		\OC\Files\Filesystem::addStorageWrapper('oc_availability', function($mountPoint, \OCP\Files\Storage\IStorage $storage) {
 			if (!$storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage') && !$storage->isLocal()) {
 				return new \OC\Files\Storage\Wrapper\Availability(['storage' => $storage]);
 			}
 			return $storage;
 		});
 
-		\OC\Files\Filesystem::addStorageWrapper('oc_encoding', function ($mountPoint, \OCP\Files\Storage $storage, \OCP\Files\Mount\IMountPoint $mount) {
+		\OC\Files\Filesystem::addStorageWrapper('oc_encoding', function($mountPoint, \OCP\Files\Storage $storage, \OCP\Files\Mount\IMountPoint $mount) {
 			if ($mount->getOption('encoding_compatibility', false) && !$storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage') && !$storage->isLocal()) {
 				return new \OC\Files\Storage\Wrapper\Encoding(['storage' => $storage]);
 			}
 			return $storage;
 		});
 
-		\OC\Files\Filesystem::addStorageWrapper('oc_quota', function ($mountPoint, $storage) {
+		\OC\Files\Filesystem::addStorageWrapper('oc_quota', function($mountPoint, $storage) {
 			// set up quota for home storages, even for other users
 			// which can happen when using sharing
 
@@ -269,7 +269,7 @@ 
 			return $storage;
 		});
 
-		\OC\Files\Filesystem::addStorageWrapper('readonly', function ($mountPoint, \OCP\Files\Storage\IStorage $storage, \OCP\Files\Mount\IMountPoint $mount) {
+		\OC\Files\Filesystem::addStorageWrapper('readonly', function($mountPoint, \OCP\Files\Storage\IStorage $storage, \OCP\Files\Mount\IMountPoint $mount) {
 			/*
 			 * Do not allow any operations that modify the storage
 			 */
@@ -320,7 +320,7 @@ 
 
 		//if we aren't logged in, there is no use to set up the filesystem
 		if ($user != "") {
-			$userDir = '/' . $user . '/files';
+			$userDir = '/'.$user.'/files';
 
 			//jail the user into his "home" directory
 			\OC\Files\Filesystem::init($user, $userDir);
@@ -399,7 +399,7 @@ 
 		/** @var LoggerInterface $logger */
 		$logger = \OC::$server->get(LoggerInterface::class);
 
-		$plainSkeletonDirectory = \OC::$server->getConfig()->getSystemValue('skeletondirectory', \OC::$SERVERROOT . '/core/skeleton');
+		$plainSkeletonDirectory = \OC::$server->getConfig()->getSystemValue('skeletondirectory', \OC::$SERVERROOT.'/core/skeleton');
 		$userLang = \OC::$server->getL10NFactory()->findLanguage();
 		$skeletonDirectory = str_replace('{lang}', $userLang, $plainSkeletonDirectory);
 
@@ -421,9 +421,9 @@ 
 		if ($instanceId === null) {
 			throw new \RuntimeException('no instance id!');
 		}
-		$appdata = 'appdata_' . $instanceId;
+		$appdata = 'appdata_'.$instanceId;
 		if ($userId === $appdata) {
-			throw new \RuntimeException('username is reserved name: ' . $appdata);
+			throw new \RuntimeException('username is reserved name: '.$appdata);
 		}
 
 		if (!empty($skeletonDirectory)) {
@@ -458,14 +458,14 @@ 
 		// Copy the files
 		while (false !== ($file = readdir($dir))) {
 			if (!\OC\Files\Filesystem::isIgnoredDir($file)) {
-				if (is_dir($source . '/' . $file)) {
+				if (is_dir($source.'/'.$file)) {
 					$child = $target->newFolder($file);
-					self::copyr($source . '/' . $file, $child);
+					self::copyr($source.'/'.$file, $child);
 				} else {
 					$child = $target->newFile($file);
-					$sourceStream = fopen($source . '/' . $file, 'r');
+					$sourceStream = fopen($source.'/'.$file, 'r');
 					if ($sourceStream === false) {
-						$logger->error(sprintf('Could not fopen "%s"', $source . '/' . $file), ['app' => 'core']);
+						$logger->error(sprintf('Could not fopen "%s"', $source.'/'.$file), ['app' => 'core']);
 						closedir($dir);
 						return;
 					}
@@ -542,8 +542,8 @@ 
 			return;
 		}
 
-		$timestamp = filemtime(OC::$SERVERROOT . '/version.php');
-		require OC::$SERVERROOT . '/version.php';
+		$timestamp = filemtime(OC::$SERVERROOT.'/version.php');
+		require OC::$SERVERROOT.'/version.php';
 		/** @var int $timestamp */
 		self::$versionCache['OC_Version_Timestamp'] = $timestamp;
 		/** @var string $OC_Version */
@@ -717,7 +717,7 @@ 
 	public static function checkServer(\OC\SystemConfig $config) {
 		$l = \OC::$server->getL10N('lib');
 		$errors = [];
-		$CONFIG_DATADIRECTORY = $config->getValue('datadirectory', OC::$SERVERROOT . '/data');
+		$CONFIG_DATADIRECTORY = $config->getValue('datadirectory', OC::$SERVERROOT.'/data');
 
 		if (!self::needUpgrade($config) && $config->getValue('installed', false)) {
 			// this check needs to be done every time
@@ -757,9 +757,9 @@ 
 				$errors[] = [
 					'error' => $l->t('Cannot write into "config" directory.'),
 					'hint' => $l->t('This can usually be fixed by giving the web server write access to the config directory. See %s',
-						[ $urlGenerator->linkToDocs('admin-dir_permissions') ]) . '. '
+						[$urlGenerator->linkToDocs('admin-dir_permissions')]).'. '
 						. $l->t('Or, if you prefer to keep config.php file read only, set the option "config_is_read_only" to true in it. See %s',
-						[ $urlGenerator->linkToDocs('admin-config') ])
+						[$urlGenerator->linkToDocs('admin-config')])
 				];
 			}
 		}
@@ -933,7 +933,7 @@ 
 			$version -= ($minor * 100);
 			$patch = $version;
 			$errors[] = [
-				'error' => $l->t('libxml2 2.7.0 is at least required. Currently %s is installed.', [$major . '.' . $minor . '.' . $patch]),
+				'error' => $l->t('libxml2 2.7.0 is at least required. Currently %s is installed.', [$major.'.'.$minor.'.'.$patch]),
 				'hint' => $l->t('To fix this issue update your libxml2 version and restart your web server.')
 			];
 		}
@@ -1036,10 +1036,10 @@ 
 				'hint' => $l->t('Check the value of "datadirectory" in your configuration.')
 			];
 		}
-		if (!file_exists($dataDirectory . '/.ocdata')) {
+		if (!file_exists($dataDirectory.'/.ocdata')) {
 			$errors[] = [
 				'error' => $l->t('Your data directory is invalid.'),
-				'hint' => $l->t('Ensure there is a file called ".ocdata"' .
+				'hint' => $l->t('Ensure there is a file called ".ocdata"'.
 					' in the root of the data directory.')
 			];
 		}
@@ -1055,7 +1055,7 @@ 
 	public static function checkLoggedIn() {
 		// Check if we are a user
 		if (!\OC::$server->getUserSession()->isLoggedIn()) {
-			header('Location: ' . \OC::$server->getURLGenerator()->linkToRoute(
+			header('Location: '.\OC::$server->getURLGenerator()->linkToRoute(
 						'core.login.showLoginForm',
 						[
 							'redirect_url' => \OC::$server->getRequest()->getRequestUri(),
@@ -1066,7 +1066,7 @@ 
 		}
 		// Redirect to 2FA challenge selection if 2FA challenge was not solved yet
 		if (\OC::$server->getTwoFactorAuthManager()->needsSecondFactor(\OC::$server->getUserSession()->getUser())) {
-			header('Location: ' . \OC::$server->getURLGenerator()->linkToRoute('core.TwoFactorChallenge.selectChallenge'));
+			header('Location: '.\OC::$server->getURLGenerator()->linkToRoute('core.TwoFactorChallenge.selectChallenge'));
 			exit();
 		}
 	}
@@ -1079,7 +1079,7 @@ 
 	public static function checkAdminUser() {
 		OC_Util::checkLoggedIn();
 		if (!OC_User::isAdminUser(OC_User::getUser())) {
-			header('Location: ' . \OCP\Util::linkToAbsolute('', 'index.php'));
+			header('Location: '.\OCP\Util::linkToAbsolute('', 'index.php'));
 			exit();
 		}
 	}
@@ -1105,7 +1105,7 @@ 
 	 */
 	public static function redirectToDefaultPage() {
 		$location = self::getDefaultPageUrl();
-		header('Location: ' . $location);
+		header('Location: '.$location);
 		exit();
 	}
 
@@ -1118,7 +1118,7 @@ 
 		$id = \OC::$server->getSystemConfig()->getValue('instanceid', null);
 		if (is_null($id)) {
 			// We need to guarantee at least one letter in instanceid so it can be used as the session_name
-			$id = 'oc' . \OC::$server->getSecureRandom()->generate(10, \OCP\Security\ISecureRandom::CHAR_LOWER.\OCP\Security\ISecureRandom::CHAR_DIGITS);
+			$id = 'oc'.\OC::$server->getSecureRandom()->generate(10, \OCP\Security\ISecureRandom::CHAR_LOWER.\OCP\Security\ISecureRandom::CHAR_DIGITS);
 			\OC::$server->getSystemConfig()->setValue('instanceid', $id);
 		}
 		return $id;
@@ -1136,12 +1136,12 @@ 
 	public static function sanitizeHTML($value) {
 		if (is_array($value)) {
 			/** @var string[] $value */
-			$value = array_map(function ($value) {
+			$value = array_map(function($value) {
 				return self::sanitizeHTML($value);
 			}, $value);
 		} else {
 			// Specify encoding for PHP<5.4
-			$value = htmlspecialchars((string)$value, ENT_QUOTES, 'UTF-8');
+			$value = htmlspecialchars((string) $value, ENT_QUOTES, 'UTF-8');
 		}
 		return $value;
 	}
@@ -1174,7 +1174,7 @@ 
 		$testContent = 'This is used for testing whether htaccess is properly enabled to disallow access from the outside. This file can be safely removed.';
 
 		// creating a test file
-		$testFile = $config->getSystemValue('datadirectory', OC::$SERVERROOT . '/data') . '/' . $fileName;
+		$testFile = $config->getSystemValue('datadirectory', OC::$SERVERROOT.'/data').'/'.$fileName;
 
 		if (file_exists($testFile)) {// already running this test, possible recursive call
 			return false;
@@ -1183,7 +1183,7 @@ 
 		$fp = @fopen($testFile, 'w');
 		if (!$fp) {
 			throw new \OCP\HintException('Can\'t create test file to check for working .htaccess file.',
-				'Make sure it is possible for the web server to write to ' . $testFile);
+				'Make sure it is possible for the web server to write to '.$testFile);
 		}
 		fwrite($fp, $testContent);
 		fclose($fp);
@@ -1210,10 +1210,10 @@ 
 		}
 
 		$fileName = '/htaccesstest.txt';
-		$testFile = $config->getSystemValue('datadirectory', OC::$SERVERROOT . '/data') . '/' . $fileName;
+		$testFile = $config->getSystemValue('datadirectory', OC::$SERVERROOT.'/data').'/'.$fileName;
 
 		// accessing the file via http
-		$url = \OC::$server->getURLGenerator()->getAbsoluteURL(OC::$WEBROOT . '/data' . $fileName);
+		$url = \OC::$server->getURLGenerator()->getAbsoluteURL(OC::$WEBROOT.'/data'.$fileName);
 		try {
 			$content = \OC::$server->getHTTPClientService()->newClient()->get($url)->getBody();
 		} catch (\Exception $e) {
@@ -1221,9 +1221,9 @@ 
 		}
 
 		if (strpos($url, 'https:') === 0) {
-			$url = 'http:' . substr($url, 6);
+			$url = 'http:'.substr($url, 6);
 		} else {
-			$url = 'https:' . substr($url, 5);
+			$url = 'https:'.substr($url, 5);
 		}
 
 		try {
@@ -1329,7 +1329,7 @@ 
 		$theme = \OC::$server->getSystemConfig()->getValue("theme", '');
 
 		if ($theme === '') {
-			if (is_dir(OC::$SERVERROOT . '/themes/default')) {
+			if (is_dir(OC::$SERVERROOT.'/themes/default')) {
 				$theme = 'default';
 			}
 		}
@@ -1350,7 +1350,7 @@ 
 
 		$normalizedValue = Normalizer::normalize($value);
 		if ($normalizedValue === null || $normalizedValue === false) {
-			\OC::$server->getLogger()->warning('normalizing failed for "' . $value . '"', ['app' => 'core']);
+			\OC::$server->getLogger()->warning('normalizing failed for "'.$value.'"', ['app' => 'core']);
 			return $value;
 		}
 
@@ -1366,7 +1366,7 @@ 
 		$version = OC_Util::getVersionString();
 		$build = OC_Util::getBuild();
 		if (!empty($build) and OC_Util::getChannel() === 'daily') {
-			$version .= ' Build:' . $build;
+			$version .= ' Build:'.$build;
 		}
 		return $version;
 	}
@@ -1388,7 +1388,7 @@ 
 		}
 
 		// detect part files
-		if (preg_match('/' . \OCP\Files\FileInfo::BLACKLIST_FILES_REGEX . '/', $trimmed) !== 0) {
+		if (preg_match('/'.\OCP\Files\FileInfo::BLACKLIST_FILES_REGEX.'/', $trimmed) !== 0) {
 			return false;
 		}
 
@@ -1419,19 +1419,19 @@ 
 			} elseif ($config->getValue('debug', false) && $versionDiff < 0) {
 				// downgrade with debug
 				$installedMajor = explode('.', $installedVersion);
-				$installedMajor = $installedMajor[0] . '.' . $installedMajor[1];
+				$installedMajor = $installedMajor[0].'.'.$installedMajor[1];
 				$currentMajor = explode('.', $currentVersion);
-				$currentMajor = $currentMajor[0] . '.' . $currentMajor[1];
+				$currentMajor = $currentMajor[0].'.'.$currentMajor[1];
 				if ($installedMajor === $currentMajor) {
 					// Same major, allow downgrade for developers
 					return true;
 				} else {
 					// downgrade attempt, throw exception
-					throw new \OCP\HintException('Downgrading is not supported and is likely to cause unpredictable issues (from ' . $installedVersion . ' to ' . $currentVersion . ')');
+					throw new \OCP\HintException('Downgrading is not supported and is likely to cause unpredictable issues (from '.$installedVersion.' to '.$currentVersion.')');
 				}
 			} elseif ($versionDiff < 0) {
 				// downgrade attempt, throw exception
-				throw new \OCP\HintException('Downgrading is not supported and is likely to cause unpredictable issues (from ' . $installedVersion . ' to ' . $currentVersion . ')');
+				throw new \OCP\HintException('Downgrading is not supported and is likely to cause unpredictable issues (from '.$installedVersion.' to '.$currentVersion.')');
 			}
 
 			// also check for upgrades for apps (independently from the user)

lib/private/Memcache/Memcached.php

Indentation +176 added lines, -176 removed lines

@@ -35,180 +35,180 @@
 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 and 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);
-		}
-		if ($result !== true) {
-			$this->verifyReturnCode();
-		}
-		return $result;
-	}
-
-	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);
-		if (self::$cache->getResultCode() !== \Memcached::RES_NOTFOUND) {
-			$this->verifyReturnCode();
-		}
-		return $result;
-	}
-
-	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
-	 * @throws \Exception
-	 */
-	public function add($key, $value, $ttl = 0) {
-		$result = self::$cache->add($this->getPrefix() . $key, $value, $ttl);
-		if (self::$cache->getResultCode() !== \Memcached::RES_NOTSTORED) {
-			$this->verifyReturnCode();
-		}
-		return $result;
-	}
-
-	/**
-	 * 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() {
-		return extension_loaded('memcached');
-	}
-
-	/**
-	 * @throws \Exception
-	 */
-	private function verifyReturnCode() {
-		$code = self::$cache->getResultCode();
-		if ($code === \Memcached::RES_SUCCESS) {
-			return;
-		}
-		$message = self::$cache->getResultMessage();
-		throw new \Exception("Error $code interacting with memcached : $message");
-	}
+    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 and 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);
+        }
+        if ($result !== true) {
+            $this->verifyReturnCode();
+        }
+        return $result;
+    }
+
+    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);
+        if (self::$cache->getResultCode() !== \Memcached::RES_NOTFOUND) {
+            $this->verifyReturnCode();
+        }
+        return $result;
+    }
+
+    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
+     * @throws \Exception
+     */
+    public function add($key, $value, $ttl = 0) {
+        $result = self::$cache->add($this->getPrefix() . $key, $value, $ttl);
+        if (self::$cache->getResultCode() !== \Memcached::RES_NOTSTORED) {
+            $this->verifyReturnCode();
+        }
+        return $result;
+    }
+
+    /**
+     * 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() {
+        return extension_loaded('memcached');
+    }
+
+    /**
+     * @throws \Exception
+     */
+    private function verifyReturnCode() {
+        $code = self::$cache->getResultCode();
+        if ($code === \Memcached::RES_SUCCESS) {
+            return;
+        }
+        $message = self::$cache->getResultMessage();
+        throw new \Exception("Error $code interacting with memcached : $message");
+    }
 }

lib/public/AppFramework/Bootstrap/IRegistrationContext.php

Indentation +200 added lines, -200 removed lines

@@ -47,221 +47,221 @@
  */
 interface IRegistrationContext {
 
-	/**
-	 * @param string $capability
-	 * @psalm-param class-string<ICapability> $capability
-	 * @see IAppContainer::registerCapability
-	 *
-	 * @since 20.0.0
-	 */
-	public function registerCapability(string $capability): void;
+    /**
+     * @param string $capability
+     * @psalm-param class-string<ICapability> $capability
+     * @see IAppContainer::registerCapability
+     *
+     * @since 20.0.0
+     */
+    public function registerCapability(string $capability): void;
 
-	/**
-	 * Register an implementation of \OCP\Support\CrashReport\IReporter that
-	 * will receive unhandled exceptions and throwables
-	 *
-	 * @param string $reporterClass
-	 * @psalm-param class-string<\OCP\Support\CrashReport\IReporter> $reporterClass
-	 * @return void
-	 * @since 20.0.0
-	 */
-	public function registerCrashReporter(string $reporterClass): void;
+    /**
+     * Register an implementation of \OCP\Support\CrashReport\IReporter that
+     * will receive unhandled exceptions and throwables
+     *
+     * @param string $reporterClass
+     * @psalm-param class-string<\OCP\Support\CrashReport\IReporter> $reporterClass
+     * @return void
+     * @since 20.0.0
+     */
+    public function registerCrashReporter(string $reporterClass): void;
 
-	/**
-	 * Register an implementation of \OCP\Dashboard\IWidget that
-	 * will handle the implementation of a dashboard widget
-	 *
-	 * @param string $widgetClass
-	 * @psalm-param class-string<\OCP\Dashboard\IWidget> $widgetClass
-	 * @return void
-	 * @since 20.0.0
-	 */
-	public function registerDashboardWidget(string $widgetClass): void;
+    /**
+     * Register an implementation of \OCP\Dashboard\IWidget that
+     * will handle the implementation of a dashboard widget
+     *
+     * @param string $widgetClass
+     * @psalm-param class-string<\OCP\Dashboard\IWidget> $widgetClass
+     * @return void
+     * @since 20.0.0
+     */
+    public function registerDashboardWidget(string $widgetClass): void;
 
-	/**
-	 * Register a service
-	 *
-	 * @param string $name
-	 * @param callable $factory
-	 * @psalm-param callable(\Psr\Container\ContainerInterface): mixed $factory
-	 * @param bool $shared
-	 *
-	 * @return void
-	 * @see IContainer::registerService()
-	 *
-	 * @since 20.0.0
-	 */
-	public function registerService(string $name, callable $factory, bool $shared = true): void;
+    /**
+     * Register a service
+     *
+     * @param string $name
+     * @param callable $factory
+     * @psalm-param callable(\Psr\Container\ContainerInterface): mixed $factory
+     * @param bool $shared
+     *
+     * @return void
+     * @see IContainer::registerService()
+     *
+     * @since 20.0.0
+     */
+    public function registerService(string $name, callable $factory, bool $shared = true): void;
 
-	/**
-	 * @param string $alias
-	 * @psalm-param string|class-string $alias
-	 * @param string $target
-	 * @psalm-param string|class-string $target
-	 *
-	 * @return void
-	 * @see IContainer::registerAlias()
-	 *
-	 * @since 20.0.0
-	 */
-	public function registerServiceAlias(string $alias, string $target): void;
+    /**
+     * @param string $alias
+     * @psalm-param string|class-string $alias
+     * @param string $target
+     * @psalm-param string|class-string $target
+     *
+     * @return void
+     * @see IContainer::registerAlias()
+     *
+     * @since 20.0.0
+     */
+    public function registerServiceAlias(string $alias, string $target): void;
 
-	/**
-	 * @param string $name
-	 * @param mixed $value
-	 *
-	 * @return void
-	 * @see IContainer::registerParameter()
-	 *
-	 * @since 20.0.0
-	 */
-	public function registerParameter(string $name, $value): void;
+    /**
+     * @param string $name
+     * @param mixed $value
+     *
+     * @return void
+     * @see IContainer::registerParameter()
+     *
+     * @since 20.0.0
+     */
+    public function registerParameter(string $name, $value): void;
 
-	/**
-	 * Register a service listener
-	 *
-	 * This is equivalent to calling IEventDispatcher::addServiceListener
-	 *
-	 * @psalm-template T of \OCP\EventDispatcher\Event
-	 * @param string $event preferably the fully-qualified class name of the Event sub class to listen for
-	 * @psalm-param string|class-string<T> $event preferably the fully-qualified class name of the Event sub class to listen for
-	 * @param string $listener fully qualified class name (or ::class notation) of a \OCP\EventDispatcher\IEventListener that can be built by the DI container
-	 * @psalm-param class-string<\OCP\EventDispatcher\IEventListener> $listener fully qualified class name that can be built by the DI container
-	 * @param int $priority The higher this value, the earlier an event
-	 *                      listener will be triggered in the chain (defaults to 0)
-	 *
-	 * @see IEventDispatcher::addServiceListener()
-	 *
-	 * @since 20.0.0
-	 */
-	public function registerEventListener(string $event, string $listener, int $priority = 0): void;
+    /**
+     * Register a service listener
+     *
+     * This is equivalent to calling IEventDispatcher::addServiceListener
+     *
+     * @psalm-template T of \OCP\EventDispatcher\Event
+     * @param string $event preferably the fully-qualified class name of the Event sub class to listen for
+     * @psalm-param string|class-string<T> $event preferably the fully-qualified class name of the Event sub class to listen for
+     * @param string $listener fully qualified class name (or ::class notation) of a \OCP\EventDispatcher\IEventListener that can be built by the DI container
+     * @psalm-param class-string<\OCP\EventDispatcher\IEventListener> $listener fully qualified class name that can be built by the DI container
+     * @param int $priority The higher this value, the earlier an event
+     *                      listener will be triggered in the chain (defaults to 0)
+     *
+     * @see IEventDispatcher::addServiceListener()
+     *
+     * @since 20.0.0
+     */
+    public function registerEventListener(string $event, string $listener, int $priority = 0): void;
 
-	/**
-	 * @param string $class
-	 * @psalm-param class-string<\OCP\AppFramework\Middleware> $class
-	 *
-	 * @return void
-	 * @see IAppContainer::registerMiddleWare()
-	 *
-	 * @since 20.0.0
-	 */
-	public function registerMiddleware(string $class): void;
+    /**
+     * @param string $class
+     * @psalm-param class-string<\OCP\AppFramework\Middleware> $class
+     *
+     * @return void
+     * @see IAppContainer::registerMiddleWare()
+     *
+     * @since 20.0.0
+     */
+    public function registerMiddleware(string $class): void;
 
-	/**
-	 * Register a search provider for the unified search
-	 *
-	 * It is allowed to register more than one provider per app as the search
-	 * results can go into distinct sections, e.g. "Files" and "Files shared
-	 * with you" in the Files app.
-	 *
-	 * @param string $class
-	 * @psalm-param class-string<\OCP\Search\IProvider> $class
-	 *
-	 * @return void
-	 *
-	 * @since 20.0.0
-	 */
-	public function registerSearchProvider(string $class): void;
+    /**
+     * Register a search provider for the unified search
+     *
+     * It is allowed to register more than one provider per app as the search
+     * results can go into distinct sections, e.g. "Files" and "Files shared
+     * with you" in the Files app.
+     *
+     * @param string $class
+     * @psalm-param class-string<\OCP\Search\IProvider> $class
+     *
+     * @return void
+     *
+     * @since 20.0.0
+     */
+    public function registerSearchProvider(string $class): void;
 
-	/**
-	 * Register an alternative login option
-	 *
-	 * It is allowed to register more than one option per app.
-	 *
-	 * @param string $class
-	 * @psalm-param class-string<\OCP\Authentication\IAlternativeLogin> $class
-	 *
-	 * @return void
-	 *
-	 * @since 20.0.0
-	 */
-	public function registerAlternativeLogin(string $class): void;
+    /**
+     * Register an alternative login option
+     *
+     * It is allowed to register more than one option per app.
+     *
+     * @param string $class
+     * @psalm-param class-string<\OCP\Authentication\IAlternativeLogin> $class
+     *
+     * @return void
+     *
+     * @since 20.0.0
+     */
+    public function registerAlternativeLogin(string $class): void;
 
-	/**
-	 * Register an initialstate provider
-	 *
-	 * It is allowed to register more than one provider per app.
-	 *
-	 * @param string $class
-	 * @psalm-param class-string<\OCP\AppFramework\Services\InitialStateProvider> $class
-	 *
-	 * @return void
-	 *
-	 * @since 21.0.0
-	 */
-	public function registerInitialStateProvider(string $class): void;
+    /**
+     * Register an initialstate provider
+     *
+     * It is allowed to register more than one provider per app.
+     *
+     * @param string $class
+     * @psalm-param class-string<\OCP\AppFramework\Services\InitialStateProvider> $class
+     *
+     * @return void
+     *
+     * @since 21.0.0
+     */
+    public function registerInitialStateProvider(string $class): void;
 
-	/**
-	 * Register a well known protocol handler
-	 *
-	 * It is allowed to register more than one handler per app.
-	 *
-	 * @param string $class
-	 * @psalm-param class-string<\OCP\Http\WellKnown\IHandler> $class
-	 *
-	 * @return void
-	 *
-	 * @since 21.0.0
-	 */
-	public function registerWellKnownHandler(string $class): void;
+    /**
+     * Register a well known protocol handler
+     *
+     * It is allowed to register more than one handler per app.
+     *
+     * @param string $class
+     * @psalm-param class-string<\OCP\Http\WellKnown\IHandler> $class
+     *
+     * @return void
+     *
+     * @since 21.0.0
+     */
+    public function registerWellKnownHandler(string $class): void;
 
-	/**
-	 * Register a custom template provider class that is able to inject custom templates
-	 * in addition to the user defined ones
-	 *
-	 * @param string $providerClass
-	 * @psalm-param class-string<ICustomTemplateProvider> $providerClass
-	 * @since 21.0.0
-	 */
-	public function registerTemplateProvider(string $providerClass): void;
+    /**
+     * Register a custom template provider class that is able to inject custom templates
+     * in addition to the user defined ones
+     *
+     * @param string $providerClass
+     * @psalm-param class-string<ICustomTemplateProvider> $providerClass
+     * @since 21.0.0
+     */
+    public function registerTemplateProvider(string $providerClass): void;
 
-	/**
-	 * Register an INotifier class
-	 *
-	 * @param string $notifierClass
-	 * @psalm-param class-string<INotifier> $notifierClass
-	 * @since 22.0.0
-	 */
-	public function registerNotifierService(string $notifierClass): void;
+    /**
+     * Register an INotifier class
+     *
+     * @param string $notifierClass
+     * @psalm-param class-string<INotifier> $notifierClass
+     * @since 22.0.0
+     */
+    public function registerNotifierService(string $notifierClass): void;
 
-	/**
-	 * Register a two-factor provider
-	 *
-	 * @param string $twoFactorProviderClass
-	 * @psalm-param class-string<IProvider> $twoFactorProviderClass
-	 * @since 22.0.0
-	 */
-	public function registerTwoFactorProvider(string $twoFactorProviderClass): void;
+    /**
+     * Register a two-factor provider
+     *
+     * @param string $twoFactorProviderClass
+     * @psalm-param class-string<IProvider> $twoFactorProviderClass
+     * @since 22.0.0
+     */
+    public function registerTwoFactorProvider(string $twoFactorProviderClass): void;
 
-	/**
-	 * Register a preview provider
-	 *
-	 * It is allowed to register more than one provider per app.
-	 *
-	 * @param string $previewProviderClass
-	 * @param string $mimeTypeRegex
-	 * @psalm-param class-string<IProviderV2> $previewProviderClass
-	 * @since 23.0.0
-	 */
-	public function registerPreviewProvider(string $previewProviderClass, string $mimeTypeRegex): void;
+    /**
+     * Register a preview provider
+     *
+     * It is allowed to register more than one provider per app.
+     *
+     * @param string $previewProviderClass
+     * @param string $mimeTypeRegex
+     * @psalm-param class-string<IProviderV2> $previewProviderClass
+     * @since 23.0.0
+     */
+    public function registerPreviewProvider(string $previewProviderClass, string $mimeTypeRegex): void;
 
-	/**
-	 * Register a calendar provider
-	 *
-	 * @param string $class
-	 * @psalm-param class-string<ICalendarProvider> $class
-	 * @since 23.0.0
-	 */
-	public function registerCalendarProvider(string $class): void;
+    /**
+     * Register a calendar provider
+     *
+     * @param string $class
+     * @psalm-param class-string<ICalendarProvider> $class
+     * @since 23.0.0
+     */
+    public function registerCalendarProvider(string $class): void;
 
-	/**
-	 * Register an implementation of \OCP\Profile\ILinkAction that
-	 * will handle the implementation of a profile link action
-	 *
-	 * @param string $actionClass
-	 * @psalm-param class-string<\OCP\Profile\ILinkAction> $actionClass
-	 * @return void
-	 * @since 23.0.0
-	 */
-	public function registerProfileLinkAction(string $actionClass): void;
+    /**
+     * Register an implementation of \OCP\Profile\ILinkAction that
+     * will handle the implementation of a profile link action
+     *
+     * @param string $actionClass
+     * @psalm-param class-string<\OCP\Profile\ILinkAction> $actionClass
+     * @return void
+     * @since 23.0.0
+     */
+    public function registerProfileLinkAction(string $actionClass): void;
 }