nextcloud /
server
| Total Complexity | 60 |
| Total Lines | 335 |
| Duplicated Lines | 0 % |
| Changes | 1 | ||
| Bugs | 1 | Features | 0 |
Complex classes like ImageManager often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use ImageManager, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 49 | class ImageManager { |
||
| 50 | public const SUPPORTED_IMAGE_KEYS = ['background', 'logo', 'logoheader', 'favicon']; |
||
| 51 | |||
| 52 | /** @var IConfig */ |
||
| 53 | private $config; |
||
| 54 | /** @var IAppData */ |
||
| 55 | private $appData; |
||
| 56 | /** @var IURLGenerator */ |
||
| 57 | private $urlGenerator; |
||
| 58 | /** @var ICacheFactory */ |
||
| 59 | private $cacheFactory; |
||
| 60 | /** @var ILogger */ |
||
| 61 | private $logger; |
||
| 62 | /** @var ITempManager */ |
||
| 63 | private $tempManager; |
||
| 64 | |||
| 65 | public function __construct(IConfig $config, |
||
| 66 | IAppData $appData, |
||
| 67 | IURLGenerator $urlGenerator, |
||
| 68 | ICacheFactory $cacheFactory, |
||
| 69 | ILogger $logger, |
||
| 70 | ITempManager $tempManager) { |
||
| 71 | $this->config = $config; |
||
| 72 | $this->urlGenerator = $urlGenerator; |
||
| 73 | $this->cacheFactory = $cacheFactory; |
||
| 74 | $this->logger = $logger; |
||
| 75 | $this->tempManager = $tempManager; |
||
| 76 | $this->appData = $appData; |
||
| 77 | } |
||
| 78 | |||
| 79 | /** |
||
| 80 | * Get a globally defined image (admin theming settings) |
||
| 81 | * |
||
| 82 | * @param string $key the image key |
||
| 83 | * @return string the image url |
||
| 84 | */ |
||
| 85 | public function getImageUrl(string $key): string { |
||
| 86 | $cacheBusterCounter = $this->config->getAppValue(Application::APP_ID, 'cachebuster', '0'); |
||
| 87 | if ($this->hasImage($key)) { |
||
| 88 | return $this->urlGenerator->linkToRoute('theming.Theming.getImage', [ 'key' => $key ]) . '?v=' . $cacheBusterCounter; |
||
| 89 | } |
||
| 90 | |||
| 91 | switch ($key) { |
||
| 92 | case 'logo': |
||
| 93 | case 'logoheader': |
||
| 94 | case 'favicon': |
||
| 95 | return $this->urlGenerator->imagePath('core', 'logo/logo.png') . '?v=' . $cacheBusterCounter; |
||
| 96 | case 'background': |
||
| 97 | return $this->urlGenerator->linkTo(Application::APP_ID, 'img/background/' . BackgroundService::DEFAULT_BACKGROUND_IMAGE); |
||
| 98 | } |
||
| 99 | return ''; |
||
| 100 | } |
||
| 101 | |||
| 102 | /** |
||
| 103 | * Get the absolute url. See getImageUrl |
||
| 104 | */ |
||
| 105 | public function getImageUrlAbsolute(string $key): string { |
||
| 106 | return $this->urlGenerator->getAbsoluteURL($this->getImageUrl($key)); |
||
| 107 | } |
||
| 108 | |||
| 109 | /** |
||
| 110 | * @param string $key |
||
| 111 | * @param bool $useSvg |
||
| 112 | * @return ISimpleFile |
||
| 113 | * @throws NotFoundException |
||
| 114 | * @throws NotPermittedException |
||
| 115 | */ |
||
| 116 | public function getImage(string $key, bool $useSvg = true): ISimpleFile { |
||
| 117 | $logo = $this->config->getAppValue('theming', $key . 'Mime', ''); |
||
| 118 | $folder = $this->getRootFolder()->getFolder('images'); |
||
| 119 | |||
| 120 | if ($logo === '' || !$folder->fileExists($key)) { |
||
| 121 | throw new NotFoundException(); |
||
| 122 | } |
||
| 123 | |||
| 124 | if (!$useSvg && $this->shouldReplaceIcons()) { |
||
| 125 | if (!$folder->fileExists($key . '.png')) { |
||
| 126 | try { |
||
| 127 | $finalIconFile = new \Imagick(); |
||
| 128 | $finalIconFile->setBackgroundColor('none'); |
||
| 129 | $finalIconFile->readImageBlob($folder->getFile($key)->getContent()); |
||
| 130 | $finalIconFile->setImageFormat('png32'); |
||
| 131 | $pngFile = $folder->newFile($key . '.png'); |
||
| 132 | $pngFile->putContent($finalIconFile->getImageBlob()); |
||
| 133 | return $pngFile; |
||
| 134 | } catch (\ImagickException $e) { |
||
| 135 | $this->logger->info('The image was requested to be no SVG file, but converting it to PNG failed: ' . $e->getMessage()); |
||
| 136 | } |
||
| 137 | } else { |
||
| 138 | return $folder->getFile($key . '.png'); |
||
| 139 | } |
||
| 140 | } |
||
| 141 | |||
| 142 | return $folder->getFile($key); |
||
| 143 | } |
||
| 144 | |||
| 145 | public function hasImage(string $key): bool { |
||
| 146 | $mimeSetting = $this->config->getAppValue('theming', $key . 'Mime', ''); |
||
| 147 | return $mimeSetting !== ''; |
||
| 148 | } |
||
| 149 | |||
| 150 | /** |
||
| 151 | * @return array<string, array{mime: string, url: string}> |
||
| 152 | */ |
||
| 153 | public function getCustomImages(): array { |
||
| 154 | $images = []; |
||
| 155 | foreach (self::SUPPORTED_IMAGE_KEYS as $key) { |
||
| 156 | $images[$key] = [ |
||
| 157 | 'mime' => $this->config->getAppValue('theming', $key . 'Mime', ''), |
||
| 158 | 'url' => $this->getImageUrl($key), |
||
| 159 | ]; |
||
| 160 | } |
||
| 161 | return $images; |
||
| 162 | } |
||
| 163 | |||
| 164 | /** |
||
| 165 | * Get folder for current theming files |
||
| 166 | * |
||
| 167 | * @return ISimpleFolder |
||
| 168 | * @throws NotPermittedException |
||
| 169 | */ |
||
| 170 | public function getCacheFolder(): ISimpleFolder { |
||
| 171 | $cacheBusterValue = $this->config->getAppValue('theming', 'cachebuster', '0'); |
||
| 172 | try { |
||
| 173 | $folder = $this->getRootFolder()->getFolder($cacheBusterValue); |
||
| 174 | } catch (NotFoundException $e) { |
||
| 175 | $folder = $this->getRootFolder()->newFolder($cacheBusterValue); |
||
| 176 | $this->cleanup(); |
||
| 177 | } |
||
| 178 | return $folder; |
||
| 179 | } |
||
| 180 | |||
| 181 | /** |
||
| 182 | * Get a file from AppData |
||
| 183 | * |
||
| 184 | * @param string $filename |
||
| 185 | * @throws NotFoundException |
||
| 186 | * @return \OCP\Files\SimpleFS\ISimpleFile |
||
| 187 | * @throws NotPermittedException |
||
| 188 | */ |
||
| 189 | public function getCachedImage(string $filename): ISimpleFile { |
||
| 190 | $currentFolder = $this->getCacheFolder(); |
||
| 191 | return $currentFolder->getFile($filename); |
||
| 192 | } |
||
| 193 | |||
| 194 | /** |
||
| 195 | * Store a file for theming in AppData |
||
| 196 | * |
||
| 197 | * @param string $filename |
||
| 198 | * @param string $data |
||
| 199 | * @return \OCP\Files\SimpleFS\ISimpleFile |
||
| 200 | * @throws NotFoundException |
||
| 201 | * @throws NotPermittedException |
||
| 202 | */ |
||
| 203 | public function setCachedImage(string $filename, string $data): ISimpleFile { |
||
| 204 | $currentFolder = $this->getCacheFolder(); |
||
| 205 | if ($currentFolder->fileExists($filename)) { |
||
| 206 | $file = $currentFolder->getFile($filename); |
||
| 207 | } else { |
||
| 208 | $file = $currentFolder->newFile($filename); |
||
| 209 | } |
||
| 210 | $file->putContent($data); |
||
| 211 | return $file; |
||
| 212 | } |
||
| 213 | |||
| 214 | public function delete(string $key): void { |
||
| 227 | } |
||
| 228 | } |
||
| 229 | |||
| 230 | public function updateImage(string $key, string $tmpFile): string { |
||
| 231 | $this->delete($key); |
||
| 232 | |||
| 233 | try { |
||
| 234 | $folder = $this->getRootFolder()->getFolder('images'); |
||
| 235 | } catch (NotFoundException $e) { |
||
| 236 | $folder = $this->getRootFolder()->newFolder('images'); |
||
| 237 | } |
||
| 238 | |||
| 239 | $target = $folder->newFile($key); |
||
| 240 | $supportedFormats = $this->getSupportedUploadImageFormats($key); |
||
| 241 | $detectedMimeType = mime_content_type($tmpFile); |
||
| 242 | if (!in_array($detectedMimeType, $supportedFormats, true)) { |
||
| 243 | throw new \Exception('Unsupported image type'); |
||
| 244 | } |
||
| 245 | |||
| 246 | if ($key === 'background' && $this->shouldOptimizeBackgroundImage($detectedMimeType, filesize($tmpFile))) { |
||
| 247 | try { |
||
| 248 | // Optimize the image since some people may upload images that will be |
||
| 249 | // either to big or are not progressive rendering. |
||
| 250 | $newImage = @imagecreatefromstring(file_get_contents($tmpFile)); |
||
| 251 | if ($newImage === false) { |
||
| 252 | throw new \Exception('Could not read background image, possibly corrupted.'); |
||
| 253 | } |
||
| 254 | |||
| 255 | // Preserve transparency |
||
| 256 | imagesavealpha($newImage, true); |
||
| 257 | imagealphablending($newImage, true); |
||
| 258 | |||
| 259 | $newWidth = (int)(imagesx($newImage) < 4096 ? imagesx($newImage) : 4096); |
||
| 260 | $newHeight = (int)(imagesy($newImage) / (imagesx($newImage) / $newWidth)); |
||
| 261 | $outputImage = imagescale($newImage, $newWidth, $newHeight); |
||
| 262 | if ($outputImage === false) { |
||
| 263 | throw new \Exception('Could not scale uploaded background image.'); |
||
| 264 | } |
||
| 265 | |||
| 266 | $newTmpFile = $this->tempManager->getTemporaryFile(); |
||
| 267 | imageinterlace($outputImage, 1); |
||
| 268 | // Keep jpeg images encoded as jpeg |
||
| 269 | if (strpos($detectedMimeType, 'image/jpeg') !== false) { |
||
| 270 | if (!imagejpeg($outputImage, $newTmpFile, 90)) { |
||
| 271 | throw new \Exception('Could not recompress background image as JPEG'); |
||
| 272 | } |
||
| 273 | } else { |
||
| 274 | if (!imagepng($outputImage, $newTmpFile, 8)) { |
||
| 275 | throw new \Exception('Could not recompress background image as PNG'); |
||
| 276 | } |
||
| 277 | } |
||
| 278 | $tmpFile = $newTmpFile; |
||
| 279 | imagedestroy($outputImage); |
||
| 280 | } catch (\Exception $e) { |
||
| 281 | if (is_resource($outputImage) || $outputImage instanceof \GdImage) { |
||
| 282 | imagedestroy($outputImage); |
||
| 283 | } |
||
| 284 | |||
| 285 | $this->logger->debug($e->getMessage()); |
||
| 286 | } |
||
| 287 | } |
||
| 288 | |||
| 289 | $target->putContent(file_get_contents($tmpFile)); |
||
| 290 | |||
| 291 | return $detectedMimeType; |
||
| 292 | } |
||
| 293 | |||
| 294 | /** |
||
| 295 | * Decide whether an image benefits from shrinking and reconverting |
||
| 296 | * |
||
| 297 | * @param string $mimeType the mime type of the image |
||
| 298 | * @param int $contentSize size of the image file |
||
| 299 | * @return bool |
||
| 300 | */ |
||
| 301 | private function shouldOptimizeBackgroundImage(string $mimeType, int $contentSize): bool { |
||
| 317 | } |
||
| 318 | |||
| 319 | /** |
||
| 320 | * Returns a list of supported mime types for image uploads. |
||
| 321 | * "favicon" images are only allowed to be SVG when imagemagick with SVG support is available. |
||
| 322 | * |
||
| 323 | * @param string $key The image key, e.g. "favicon" |
||
| 324 | * @return string[] |
||
| 325 | */ |
||
| 326 | private function getSupportedUploadImageFormats(string $key): array { |
||
| 327 | $supportedFormats = ['image/jpeg', 'image/png', 'image/gif', 'image/webp']; |
||
| 328 | |||
| 329 | if ($key !== 'favicon' || $this->shouldReplaceIcons() === true) { |
||
| 330 | $supportedFormats[] = 'image/svg+xml'; |
||
| 331 | $supportedFormats[] = 'image/svg'; |
||
| 332 | } |
||
| 333 | |||
| 334 | if ($key === 'favicon') { |
||
| 335 | $supportedFormats[] = 'image/x-icon'; |
||
| 336 | $supportedFormats[] = 'image/vnd.microsoft.icon'; |
||
| 337 | } |
||
| 338 | |||
| 339 | return $supportedFormats; |
||
| 340 | } |
||
| 341 | |||
| 342 | /** |
||
| 343 | * remove cached files that are not required any longer |
||
| 344 | * |
||
| 345 | * @throws NotPermittedException |
||
| 346 | * @throws NotFoundException |
||
| 347 | */ |
||
| 348 | public function cleanup() { |
||
| 349 | $currentFolder = $this->getCacheFolder(); |
||
| 350 | $folders = $this->getRootFolder()->getDirectoryListing(); |
||
| 351 | foreach ($folders as $folder) { |
||
| 352 | if ($folder->getName() !== 'images' && $folder->getName() !== $currentFolder->getName()) { |
||
| 353 | $folder->delete(); |
||
| 354 | } |
||
| 355 | } |
||
| 356 | } |
||
| 357 | |||
| 358 | /** |
||
| 359 | * Check if Imagemagick is enabled and if SVG is supported |
||
| 360 | * otherwise we can't render custom icons |
||
| 361 | * |
||
| 362 | * @return bool |
||
| 363 | */ |
||
| 364 | public function shouldReplaceIcons() { |
||
| 377 | } |
||
| 378 | |||
| 379 | private function getRootFolder(): ISimpleFolder { |
||
| 384 | } |
||
| 385 | } |
||
| 386 | } |
||
| 387 |
Loading history...