2016-09-18 21:15:06 +03:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* @copyright Copyright (c) 2016 Julius Härtl <jus@bitgrid.net>
|
|
|
|
*
|
2017-11-06 17:56:42 +03:00
|
|
|
* @author Julius Haertl <jus@bitgrid.net>
|
2016-09-18 21:15:06 +03:00
|
|
|
*
|
|
|
|
* @license GNU AGPL version 3 or any later version
|
|
|
|
*
|
2017-11-06 17:56:42 +03:00
|
|
|
* This program is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU Affero General Public License as
|
|
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
|
|
* License, or (at your option) any later version.
|
2016-09-18 21:15:06 +03:00
|
|
|
*
|
2017-11-06 17:56:42 +03:00
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU Affero General Public License for more details.
|
2016-09-18 21:15:06 +03:00
|
|
|
*
|
2017-11-06 17:56:42 +03:00
|
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
2016-09-18 21:15:06 +03:00
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
namespace OCA\Theming;
|
|
|
|
|
2018-02-26 15:54:00 +03:00
|
|
|
use OCP\Files\SimpleFS\ISimpleFile;
|
2018-03-28 13:24:32 +03:00
|
|
|
use OCP\Files\SimpleFS\ISimpleFolder;
|
2018-04-20 17:21:11 +03:00
|
|
|
use OCP\ICacheFactory;
|
2016-09-18 21:15:06 +03:00
|
|
|
use OCP\IConfig;
|
|
|
|
use OCP\Files\IAppData;
|
|
|
|
use OCP\Files\NotFoundException;
|
|
|
|
use OCP\Files\NotPermittedException;
|
2018-06-14 17:55:44 +03:00
|
|
|
use OCP\ILogger;
|
2018-02-26 15:54:00 +03:00
|
|
|
use OCP\IURLGenerator;
|
2016-09-18 21:15:06 +03:00
|
|
|
|
|
|
|
class ImageManager {
|
|
|
|
|
|
|
|
/** @var IConfig */
|
|
|
|
private $config;
|
|
|
|
/** @var IAppData */
|
|
|
|
private $appData;
|
2018-04-20 17:21:11 +03:00
|
|
|
/** @var IURLGenerator */
|
|
|
|
private $urlGenerator;
|
2018-02-26 15:54:00 +03:00
|
|
|
/** @var array */
|
|
|
|
private $supportedImageKeys = ['background', 'logo', 'logoheader', 'favicon'];
|
2018-04-20 17:21:11 +03:00
|
|
|
/** @var ICacheFactory */
|
|
|
|
private $cacheFactory;
|
2018-06-14 17:55:44 +03:00
|
|
|
/** @var ILogger */
|
|
|
|
private $logger;
|
2018-02-26 15:54:00 +03:00
|
|
|
|
2016-09-18 21:15:06 +03:00
|
|
|
/**
|
|
|
|
* ImageManager constructor.
|
|
|
|
*
|
|
|
|
* @param IConfig $config
|
|
|
|
* @param IAppData $appData
|
2018-02-26 15:54:00 +03:00
|
|
|
* @param IURLGenerator $urlGenerator
|
2018-05-08 13:40:20 +03:00
|
|
|
* @param ICacheFactory $cacheFactory
|
2018-06-14 17:55:44 +03:00
|
|
|
* @param ILogger $logger
|
2016-09-18 21:15:06 +03:00
|
|
|
*/
|
|
|
|
public function __construct(IConfig $config,
|
2018-02-26 15:54:00 +03:00
|
|
|
IAppData $appData,
|
2018-04-20 17:21:11 +03:00
|
|
|
IURLGenerator $urlGenerator,
|
2018-06-14 17:55:44 +03:00
|
|
|
ICacheFactory $cacheFactory,
|
|
|
|
ILogger $logger
|
2016-09-18 21:15:06 +03:00
|
|
|
) {
|
|
|
|
$this->config = $config;
|
|
|
|
$this->appData = $appData;
|
2018-02-26 15:54:00 +03:00
|
|
|
$this->urlGenerator = $urlGenerator;
|
2018-04-20 17:21:11 +03:00
|
|
|
$this->cacheFactory = $cacheFactory;
|
2018-06-14 17:55:44 +03:00
|
|
|
$this->logger = $logger;
|
2018-02-26 15:54:00 +03:00
|
|
|
}
|
|
|
|
|
2018-05-08 14:06:31 +03:00
|
|
|
public function getImageUrl(string $key, bool $useSvg = true): string {
|
2018-02-26 15:54:00 +03:00
|
|
|
$cacheBusterCounter = $this->config->getAppValue('theming', 'cachebuster', '0');
|
|
|
|
try {
|
2018-05-08 14:06:31 +03:00
|
|
|
$image = $this->getImage($key, $useSvg);
|
2018-02-26 15:54:00 +03:00
|
|
|
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.png') . '?v=' . $cacheBusterCounter;
|
2018-08-28 13:01:32 +03:00
|
|
|
case 'logo-blue':
|
|
|
|
return $this->urlGenerator->imagePath('core', 'logo-blue.png') . '?v=' . $cacheBusterCounter;
|
2018-02-26 15:54:00 +03:00
|
|
|
case 'background':
|
|
|
|
return $this->urlGenerator->imagePath('core', 'background.png') . '?v=' . $cacheBusterCounter;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-05-08 14:06:31 +03:00
|
|
|
public function getImageUrlAbsolute(string $key, bool $useSvg = true): string {
|
|
|
|
return $this->urlGenerator->getAbsoluteURL($this->getImageUrl($key, $useSvg));
|
2018-02-26 15:54:00 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2018-05-08 14:06:31 +03:00
|
|
|
* @param string $key
|
|
|
|
* @param bool $useSvg
|
2018-02-26 15:54:00 +03:00
|
|
|
* @return ISimpleFile
|
|
|
|
* @throws NotFoundException
|
2018-05-08 14:06:31 +03:00
|
|
|
* @throws NotPermittedException
|
2018-02-26 15:54:00 +03:00
|
|
|
*/
|
2018-05-08 14:06:31 +03:00
|
|
|
public function getImage(string $key, bool $useSvg = true): ISimpleFile {
|
2018-06-14 17:55:44 +03:00
|
|
|
$pngFile = null;
|
2018-02-26 15:54:00 +03:00
|
|
|
$logo = $this->config->getAppValue('theming', $key . 'Mime', false);
|
2018-05-08 13:40:20 +03:00
|
|
|
$folder = $this->appData->getFolder('images');
|
|
|
|
if ($logo === false || !$folder->fileExists($key)) {
|
2018-02-26 15:54:00 +03:00
|
|
|
throw new NotFoundException();
|
|
|
|
}
|
2018-04-20 17:21:11 +03:00
|
|
|
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());
|
|
|
|
} catch (\ImagickException $e) {
|
2018-06-14 17:55:44 +03:00
|
|
|
$this->logger->info('The image was requested to be no SVG file, but converting it to PNG failed.', $e->getMessage());
|
|
|
|
$pngFile = null;
|
2018-04-20 17:21:11 +03:00
|
|
|
}
|
|
|
|
} else {
|
|
|
|
$pngFile = $folder->getFile($key . '.png');
|
|
|
|
}
|
2018-06-14 17:55:44 +03:00
|
|
|
}
|
|
|
|
if ($pngFile !== null) {
|
2018-04-20 17:21:11 +03:00
|
|
|
return $pngFile;
|
|
|
|
}
|
2018-02-26 15:54:00 +03:00
|
|
|
return $folder->getFile($key);
|
|
|
|
}
|
|
|
|
|
|
|
|
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;
|
2016-09-18 21:15:06 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get folder for current theming files
|
|
|
|
*
|
2018-02-26 15:54:00 +03:00
|
|
|
* @return ISimpleFolder
|
2016-09-18 21:15:06 +03:00
|
|
|
* @throws NotPermittedException
|
|
|
|
*/
|
2018-02-26 15:54:00 +03:00
|
|
|
public function getCacheFolder(): ISimpleFolder {
|
2016-09-18 21:15:06 +03:00
|
|
|
$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
|
2016-10-17 17:31:07 +03:00
|
|
|
* @throws NotFoundException
|
|
|
|
* @return \OCP\Files\SimpleFS\ISimpleFile
|
2018-02-26 15:54:00 +03:00
|
|
|
* @throws NotPermittedException
|
2016-09-18 21:15:06 +03:00
|
|
|
*/
|
2018-03-28 13:24:32 +03:00
|
|
|
public function getCachedImage(string $filename): ISimpleFile {
|
2016-09-18 21:15:06 +03:00
|
|
|
$currentFolder = $this->getCacheFolder();
|
2016-10-17 17:31:07 +03:00
|
|
|
return $currentFolder->getFile($filename);
|
2016-09-18 21:15:06 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Store a file for theming in AppData
|
|
|
|
*
|
|
|
|
* @param string $filename
|
|
|
|
* @param string $data
|
|
|
|
* @return \OCP\Files\SimpleFS\ISimpleFile
|
2018-02-26 15:54:00 +03:00
|
|
|
* @throws NotFoundException
|
|
|
|
* @throws NotPermittedException
|
2016-09-18 21:15:06 +03:00
|
|
|
*/
|
2018-03-28 13:24:32 +03:00
|
|
|
public function setCachedImage(string $filename, string $data): ISimpleFile {
|
2016-09-18 21:15:06 +03:00
|
|
|
$currentFolder = $this->getCacheFolder();
|
|
|
|
if ($currentFolder->fileExists($filename)) {
|
|
|
|
$file = $currentFolder->getFile($filename);
|
|
|
|
} else {
|
|
|
|
$file = $currentFolder->newFile($filename);
|
|
|
|
}
|
|
|
|
$file->putContent($data);
|
|
|
|
return $file;
|
|
|
|
}
|
|
|
|
|
2018-03-28 15:56:31 +03:00
|
|
|
public function delete(string $key) {
|
2018-06-05 17:59:05 +03:00
|
|
|
/* ignore exceptions, since we don't want to fail hard if something goes wrong during cleanup */
|
2018-03-28 15:56:31 +03:00
|
|
|
try {
|
|
|
|
$file = $this->appData->getFolder('images')->getFile($key);
|
|
|
|
$file->delete();
|
|
|
|
} catch (NotFoundException $e) {
|
|
|
|
} catch (NotPermittedException $e) {
|
|
|
|
}
|
2018-04-20 17:21:11 +03:00
|
|
|
try {
|
|
|
|
$file = $this->appData->getFolder('images')->getFile($key . '.png');
|
|
|
|
$file->delete();
|
|
|
|
} catch (NotFoundException $e) {
|
|
|
|
} catch (NotPermittedException $e) {
|
|
|
|
}
|
2018-03-28 15:56:31 +03:00
|
|
|
}
|
|
|
|
|
2016-09-18 21:15:06 +03:00
|
|
|
/**
|
|
|
|
* remove cached files that are not required any longer
|
2018-03-28 15:56:31 +03:00
|
|
|
*
|
|
|
|
* @throws NotPermittedException
|
|
|
|
* @throws NotFoundException
|
2016-09-18 21:15:06 +03:00
|
|
|
*/
|
|
|
|
public function cleanup() {
|
|
|
|
$currentFolder = $this->getCacheFolder();
|
|
|
|
$folders = $this->appData->getDirectoryListing();
|
|
|
|
foreach ($folders as $folder) {
|
2017-02-09 12:55:28 +03:00
|
|
|
if ($folder->getName() !== 'images' && $folder->getName() !== $currentFolder->getName()) {
|
2016-09-18 21:15:06 +03:00
|
|
|
$folder->delete();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2018-04-20 17:21:11 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 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;
|
|
|
|
}
|
2016-09-18 21:15:06 +03:00
|
|
|
}
|