420 lines
12 KiB
PHP
420 lines
12 KiB
PHP
<?php
|
||
/**
|
||
* @copyright Copyright (c) 2016 Bjoern Schiessle <bjoern@schiessle.org>
|
||
* @copyright Copyright (c) 2017 Lukas Reschke <lukas@statuscode.ch>
|
||
*
|
||
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
|
||
* @author Bjoern Schiessle <bjoern@schiessle.org>
|
||
* @author Jan-Christoph Borchardt <hey@jancborchardt.net>
|
||
* @author Joachim Bauch <bauch@struktur.de>
|
||
* @author Joas Schilling <coding@schilljs.com>
|
||
* @author Julius Haertl <jus@bitgrid.net>
|
||
* @author Julius Härtl <jus@bitgrid.net>
|
||
* @author Lukas Reschke <lukas@statuscode.ch>
|
||
* @author Morris Jobke <hey@morrisjobke.de>
|
||
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
||
*
|
||
* @license GNU AGPL version 3 or any later version
|
||
*
|
||
* 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.
|
||
*
|
||
* 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.
|
||
*
|
||
* 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/>.
|
||
*
|
||
*/
|
||
|
||
namespace OCA\Theming;
|
||
|
||
|
||
use OCP\App\AppPathNotFoundException;
|
||
use OCP\App\IAppManager;
|
||
use OCP\Files\NotFoundException;
|
||
use OCP\ICacheFactory;
|
||
use OCP\IConfig;
|
||
use OCP\IL10N;
|
||
use OCP\IURLGenerator;
|
||
|
||
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 string */
|
||
private $name;
|
||
/** @var string */
|
||
private $title;
|
||
/** @var string */
|
||
private $entity;
|
||
/** @var string */
|
||
private $url;
|
||
/** @var string */
|
||
private $slogan;
|
||
/** @var string */
|
||
private $color;
|
||
|
||
/** @var string */
|
||
private $iTunesAppId;
|
||
/** @var string */
|
||
private $iOSClientUrl;
|
||
/** @var string */
|
||
private $AndroidClientUrl;
|
||
|
||
/**
|
||
* 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
|
||
) {
|
||
parent::__construct();
|
||
$this->config = $config;
|
||
$this->l = $l;
|
||
$this->imageManager = $imageManager;
|
||
$this->urlGenerator = $urlGenerator;
|
||
$this->cacheFactory = $cacheFactory;
|
||
$this->util = $util;
|
||
$this->appManager = $appManager;
|
||
|
||
$this->name = parent::getName();
|
||
$this->title = parent::getTitle();
|
||
$this->entity = parent::getEntity();
|
||
$this->url = parent::getBaseUrl();
|
||
$this->slogan = parent::getSlogan();
|
||
$this->color = parent::getColorPrimary();
|
||
$this->iTunesAppId = parent::getiTunesAppId();
|
||
$this->iOSClientUrl = parent::getiOSClientUrl();
|
||
$this->AndroidClientUrl = parent::getAndroidClientUrl();
|
||
}
|
||
|
||
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 getBaseUrl() {
|
||
return $this->config->getAppValue('theming', 'url', $this->url);
|
||
}
|
||
|
||
public function getSlogan() {
|
||
return \OCP\Util::sanitizeHTML($this->config->getAppValue('theming', 'slogan', $this->slogan));
|
||
}
|
||
|
||
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()
|
||
],
|
||
];
|
||
|
||
$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() {
|
||
return $this->config->getAppValue('theming', 'color', $this->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', false);
|
||
|
||
$logoExists = true;
|
||
try {
|
||
$this->imageManager->getImage('logo', $useSvg);
|
||
} catch (\Exception $e) {
|
||
$logoExists = false;
|
||
}
|
||
|
||
$cacheBusterCounter = $this->config->getAppValue('theming', 'cachebuster', '0');
|
||
|
||
if(!$logo || !$logoExists) {
|
||
if($useSvg) {
|
||
$logo = $this->urlGenerator->imagePath('core', 'logo.svg');
|
||
} else {
|
||
$logo = $this->urlGenerator->imagePath('core', '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 array scss variables to overwrite
|
||
*/
|
||
public function getScssVariables() {
|
||
$cache = $this->cacheFactory->createDistributed('theming-' . $this->urlGenerator->getBaseUrl());
|
||
if ($value = $cache->get('getScssVariables')) {
|
||
return $value;
|
||
}
|
||
|
||
$variables = [
|
||
'theming-cachebuster' => "'" . $this->config->getAppValue('theming', 'cachebuster', '0') . "'",
|
||
'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->getLogoUrl() ."')";
|
||
$variables['image-logoheader'] = "'".$this->imageManager->getImageUrl('logoheader')."'";
|
||
$variables['image-favicon'] = "'".$this->imageManager->getImageUrl('favicon')."'";
|
||
$variables['image-login-background'] = "url('".$this->imageManager->getImageUrl('background')."')";
|
||
$variables['image-login-plain'] = 'false';
|
||
|
||
if ($this->config->getAppValue('theming', 'color', null) !== null) {
|
||
$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', null) === '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;
|
||
}
|
||
|
||
/**
|
||
* Returns the logo url.
|
||
* If there is a custom logo, it just returns it.
|
||
* For the default logo it returns the white or blue one depending on the color luminance.
|
||
*
|
||
* @return string
|
||
*/
|
||
private function getLogoUrl() {
|
||
$logoMime = $this->config->getAppValue('theming', 'logoMime');
|
||
$primaryColor = $this->getColorPrimary();
|
||
$luminance = $this->util->calculateLuminance($primaryColor);
|
||
if ($logoMime === '' & $luminance > 0.8) {
|
||
return $this->imageManager->getImageUrl('logo-blue');
|
||
} else {
|
||
return $this->imageManager->getImageUrl('logo');
|
||
}
|
||
}
|
||
|
||
/**
|
||
* 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 = 'core';
|
||
}
|
||
$cacheBusterValue = $this->config->getAppValue('theming', 'cachebuster', '0');
|
||
|
||
try {
|
||
$customFavicon = $this->imageManager->getImage('favicon');
|
||
} catch (NotFoundException $e) {
|
||
$customFavicon = null;
|
||
}
|
||
|
||
if ($image === 'favicon.ico' && ($customFavicon !== null || $this->imageManager->shouldReplaceIcons())) {
|
||
return $this->urlGenerator->linkToRoute('theming.Icon.getFavicon', ['app' => $app]) . '?v=' . $cacheBusterValue;
|
||
}
|
||
if ($image === 'favicon-touch.png' && ($customFavicon !== null || $this->imageManager->shouldReplaceIcons())) {
|
||
return $this->urlGenerator->linkToRoute('theming.Icon.getTouchIcon', ['app' => $app]) . '?v=' . $cacheBusterValue;
|
||
}
|
||
if ($image === 'manifest.json') {
|
||
try {
|
||
$appPath = $this->appManager->getAppPath($app);
|
||
if (file_exists($appPath . '/img/manifest.json')) {
|
||
return false;
|
||
}
|
||
} catch (AppPathNotFoundException $e) {}
|
||
return $this->urlGenerator->linkToRoute('theming.Theming.getManifest') . '?v=' . $cacheBusterValue;
|
||
}
|
||
return false;
|
||
}
|
||
|
||
/**
|
||
* Increases the cache buster key
|
||
*/
|
||
private function increaseCacheBuster() {
|
||
$cacheBusterKey = $this->config->getAppValue('theming', 'cachebuster', '0');
|
||
$this->config->setAppValue('theming', 'cachebuster', (int)$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();
|
||
|
||
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;
|
||
default:
|
||
$returnValue = '';
|
||
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';
|
||
}
|
||
}
|