nextcloud / server

apps/theming/lib/ImageManager.php

Indentation +244 added lines, -244 removed lines

@@ -46,274 +46,274 @@
 
 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');
-		if ($this->hasImage($key)) {
-			return $this->urlGenerator->linkToRoute('theming.Theming.getImage', [ 'key' => $key ]) . '?v=' . $cacheBusterCounter;
-		}
+    public function getImageUrl(string $key, bool $useSvg = true): string {
+        $cacheBusterCounter = $this->config->getAppValue('theming', 'cachebuster', '0');
+        if ($this->hasImage($key)) {
+            return $this->urlGenerator->linkToRoute('theming.Theming.getImage', [ 'key' => $key ]) . '?v=' . $cacheBusterCounter;
+        }
 
-		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);
+    }
 
-	public function hasImage(string $key): bool {
-		$mimeSetting = $this->config->getAppValue('theming', $key . 'Mime', '');
-		return $mimeSetting !== '';
-	}
+    public function hasImage(string $key): bool {
+        $mimeSetting = $this->config->getAppValue('theming', $key . 'Mime', '');
+        return $mimeSetting !== '';
+    }
 
-	/**
-	 * @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 +15 added lines, -15 removed lines

@@ -79,16 +79,16 @@ 
 	public function getImageUrl(string $key, bool $useSvg = true): string {
 		$cacheBusterCounter = $this->config->getAppValue('theming', 'cachebuster', '0');
 		if ($this->hasImage($key)) {
-			return $this->urlGenerator->linkToRoute('theming.Theming.getImage', [ 'key' => $key ]) . '?v=' . $cacheBusterCounter;
+			return $this->urlGenerator->linkToRoute('theming.Theming.getImage', ['key' => $key]).'?v='.$cacheBusterCounter;
 		}
 
 		switch ($key) {
 			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 '';
 	}
@@ -105,33 +105,33 @@ 
 	 * @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);
 	}
 
 	public function hasImage(string $key): bool {
-		$mimeSetting = $this->config->getAppValue('theming', $key . 'Mime', '');
+		$mimeSetting = $this->config->getAppValue('theming', $key.'Mime', '');
 		return $mimeSetting !== '';
 	}
 
@@ -142,7 +142,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),
 			];
 		}
@@ -208,7 +208,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) {
@@ -241,8 +241,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);
@@ -303,9 +303,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')) {