nextcloud / server

apps/theming/lib/ThemingDefaults.php

Indentation +334 added lines, -334 removed lines

@@ -33,338 +33,338 @@
 
 class ThemingDefaults extends \OC_Defaults {
 
-	/** @var IConfig */
-	private $config;
-	/** @var IL10N */
-	private $l;
-	/** @var IURLGenerator */
-	private $urlGenerator;
-	/** @var IAppData */
-	private $appData;
-	/** @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 IURLGenerator $urlGenerator
-	 * @param \OC_Defaults $defaults
-	 * @param IAppData $appData
-	 * @param ICacheFactory $cacheFactory
-	 * @param Util $util
-	 * @param IAppManager $appManager
-	 */
-	public function __construct(IConfig $config,
-								IL10N $l,
-								IURLGenerator $urlGenerator,
-								IAppData $appData,
-								ICacheFactory $cacheFactory,
-								Util $util,
-								IAppManager $appManager
-	) {
-		parent::__construct();
-		$this->config = $config;
-		$this->l = $l;
-		$this->urlGenerator = $urlGenerator;
-		$this->appData = $appData;
-		$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 getShortFooter() {
-		$slogan = $this->getSlogan();
-		$footer = '<a href="'. $this->getBaseUrl() . '" target="_blank"' .
-			' rel="noreferrer">' .$this->getEntity() . '</a>'.
-			($slogan !== '' ? ' – ' . $slogan : '');
-
-		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) {
-		$logo = $this->config->getAppValue('theming', 'logoMime', false);
-
-		$logoExists = true;
-		try {
-			$this->appData->getFolder('images')->getFile('logo');
-		} 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.getLogo') . '?v=' . $cacheBusterCounter;
-	}
-
-	/**
-	 * Themed background image url
-	 *
-	 * @return string
-	 */
-	public function getBackground() {
-		$backgroundLogo = $this->config->getAppValue('theming', 'backgroundMime',false);
-
-		$backgroundExists = true;
-		try {
-			$this->appData->getFolder('images')->getFile('background');
-		} catch (\Exception $e) {
-			$backgroundExists = false;
-		}
-
-		$cacheBusterCounter = $this->config->getAppValue('theming', 'cachebuster', '0');
-
-		if(!$backgroundLogo || !$backgroundExists) {
-			return $this->urlGenerator->imagePath('core','background.png') . '?v=' . $cacheBusterCounter;
-		}
-
-		return $this->urlGenerator->linkToRoute('theming.Theming.getLoginBackground') . '?v=' . $cacheBusterCounter;
-	}
-
-	/**
-	 * @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->create('theming');
-		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', '') . "'"
-		];
-
-		$variables['image-logo'] = "'".$this->urlGenerator->getAbsoluteURL($this->getLogo())."'";
-		$variables['image-login-background'] = "'".$this->urlGenerator->getAbsoluteURL($this->getBackground())."'";
-		$variables['image-login-plain'] = 'false';
-
-		if ($this->config->getAppValue('theming', 'color', null) !== null) {
-			if ($this->util->invertTextColor($this->getColorPrimary())) {
-				$colorPrimaryText = '#000000';
-			} else {
-				$colorPrimaryText = '#ffffff';
-			}
-			$variables['color-primary'] = $this->getColorPrimary();
-			$variables['color-primary-text'] = $colorPrimaryText;
-			$variables['color-primary-element'] = $this->util->elementColor($this->getColorPrimary());
-		}
-
-		if ($this->config->getAppValue('theming', 'backgroundMime', null) === 'backgroundColor') {
-			$variables['image-login-plain'] = '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 = 'core';
-		}
-		$cacheBusterValue = $this->config->getAppValue('theming', 'cachebuster', '0');
-
-		if ($image === 'favicon.ico' && $this->shouldReplaceIcons()) {
-			return $this->urlGenerator->linkToRoute('theming.Icon.getFavicon', ['app' => $app]) . '?v=' . $cacheBusterValue;
-		}
-		if ($image === 'favicon-touch.png' && $this->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;
-	}
-
-	/**
-	 * 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->create('theming');
-		if($value = $cache->get('shouldReplaceIcons')) {
-			return (bool)$value;
-		}
-		$value = false;
-		if(extension_loaded('imagick')) {
-			$checkImagick = new \Imagick();
-			if (count($checkImagick->queryFormats('SVG')) >= 1) {
-				$value = true;
-			}
-			$checkImagick->clear();
-		}
-		$cache->set('shouldReplaceIcons', $value);
-		return $value;
-	}
-
-	/**
-	 * 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->create('theming')->clear('getScssVariables');
-	}
-
-	/**
-	 * 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;
-	}
+    /** @var IConfig */
+    private $config;
+    /** @var IL10N */
+    private $l;
+    /** @var IURLGenerator */
+    private $urlGenerator;
+    /** @var IAppData */
+    private $appData;
+    /** @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 IURLGenerator $urlGenerator
+     * @param \OC_Defaults $defaults
+     * @param IAppData $appData
+     * @param ICacheFactory $cacheFactory
+     * @param Util $util
+     * @param IAppManager $appManager
+     */
+    public function __construct(IConfig $config,
+                                IL10N $l,
+                                IURLGenerator $urlGenerator,
+                                IAppData $appData,
+                                ICacheFactory $cacheFactory,
+                                Util $util,
+                                IAppManager $appManager
+    ) {
+        parent::__construct();
+        $this->config = $config;
+        $this->l = $l;
+        $this->urlGenerator = $urlGenerator;
+        $this->appData = $appData;
+        $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 getShortFooter() {
+        $slogan = $this->getSlogan();
+        $footer = '<a href="'. $this->getBaseUrl() . '" target="_blank"' .
+            ' rel="noreferrer">' .$this->getEntity() . '</a>'.
+            ($slogan !== '' ? ' – ' . $slogan : '');
+
+        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) {
+        $logo = $this->config->getAppValue('theming', 'logoMime', false);
+
+        $logoExists = true;
+        try {
+            $this->appData->getFolder('images')->getFile('logo');
+        } 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.getLogo') . '?v=' . $cacheBusterCounter;
+    }
+
+    /**
+     * Themed background image url
+     *
+     * @return string
+     */
+    public function getBackground() {
+        $backgroundLogo = $this->config->getAppValue('theming', 'backgroundMime',false);
+
+        $backgroundExists = true;
+        try {
+            $this->appData->getFolder('images')->getFile('background');
+        } catch (\Exception $e) {
+            $backgroundExists = false;
+        }
+
+        $cacheBusterCounter = $this->config->getAppValue('theming', 'cachebuster', '0');
+
+        if(!$backgroundLogo || !$backgroundExists) {
+            return $this->urlGenerator->imagePath('core','background.png') . '?v=' . $cacheBusterCounter;
+        }
+
+        return $this->urlGenerator->linkToRoute('theming.Theming.getLoginBackground') . '?v=' . $cacheBusterCounter;
+    }
+
+    /**
+     * @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->create('theming');
+        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', '') . "'"
+        ];
+
+        $variables['image-logo'] = "'".$this->urlGenerator->getAbsoluteURL($this->getLogo())."'";
+        $variables['image-login-background'] = "'".$this->urlGenerator->getAbsoluteURL($this->getBackground())."'";
+        $variables['image-login-plain'] = 'false';
+
+        if ($this->config->getAppValue('theming', 'color', null) !== null) {
+            if ($this->util->invertTextColor($this->getColorPrimary())) {
+                $colorPrimaryText = '#000000';
+            } else {
+                $colorPrimaryText = '#ffffff';
+            }
+            $variables['color-primary'] = $this->getColorPrimary();
+            $variables['color-primary-text'] = $colorPrimaryText;
+            $variables['color-primary-element'] = $this->util->elementColor($this->getColorPrimary());
+        }
+
+        if ($this->config->getAppValue('theming', 'backgroundMime', null) === 'backgroundColor') {
+            $variables['image-login-plain'] = '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 = 'core';
+        }
+        $cacheBusterValue = $this->config->getAppValue('theming', 'cachebuster', '0');
+
+        if ($image === 'favicon.ico' && $this->shouldReplaceIcons()) {
+            return $this->urlGenerator->linkToRoute('theming.Icon.getFavicon', ['app' => $app]) . '?v=' . $cacheBusterValue;
+        }
+        if ($image === 'favicon-touch.png' && $this->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;
+    }
+
+    /**
+     * 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->create('theming');
+        if($value = $cache->get('shouldReplaceIcons')) {
+            return (bool)$value;
+        }
+        $value = false;
+        if(extension_loaded('imagick')) {
+            $checkImagick = new \Imagick();
+            if (count($checkImagick->queryFormats('SVG')) >= 1) {
+                $value = true;
+            }
+            $checkImagick->clear();
+        }
+        $cache->set('shouldReplaceIcons', $value);
+        return $value;
+    }
+
+    /**
+     * 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->create('theming')->clear('getScssVariables');
+    }
+
+    /**
+     * 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;
+    }
 }