123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527 |
- <?php
- namespace OCA\Theming;
- use OCA\Theming\AppInfo\Application;
- use OCA\Theming\Service\BackgroundService;
- use OCP\App\AppPathNotFoundException;
- use OCP\App\IAppManager;
- use OCP\Files\NotFoundException;
- use OCP\Files\SimpleFS\ISimpleFile;
- use OCP\IAppConfig;
- use OCP\ICacheFactory;
- use OCP\IConfig;
- use OCP\IL10N;
- use OCP\INavigationManager;
- use OCP\IURLGenerator;
- use OCP\IUserSession;
- class ThemingDefaults extends \OC_Defaults {
- private string $name;
- private string $title;
- private string $entity;
- private string $productName;
- private string $url;
- private string $backgroundColor;
- private string $primaryColor;
- private string $docBaseUrl;
- private string $iTunesAppId;
- private string $iOSClientUrl;
- private string $AndroidClientUrl;
- private string $FDroidClientUrl;
-
- public function __construct(
- private IConfig $config,
- private IAppConfig $appConfig,
- private IL10N $l,
- private IUserSession $userSession,
- private IURLGenerator $urlGenerator,
- private ICacheFactory $cacheFactory,
- private Util $util,
- private ImageManager $imageManager,
- private IAppManager $appManager,
- private INavigationManager $navigationManager,
- private BackgroundService $backgroundService,
- ) {
- parent::__construct();
- $this->name = parent::getName();
- $this->title = parent::getTitle();
- $this->entity = parent::getEntity();
- $this->productName = parent::getProductName();
- $this->url = parent::getBaseUrl();
- $this->primaryColor = parent::getColorPrimary();
- $this->backgroundColor = parent::getColorBackground();
- $this->iTunesAppId = parent::getiTunesAppId();
- $this->iOSClientUrl = parent::getiOSClientUrl();
- $this->AndroidClientUrl = parent::getAndroidClientUrl();
- $this->FDroidClientUrl = parent::getFDroidClientUrl();
- $this->docBaseUrl = parent::getDocBaseUrl();
- }
- 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 getProductName() {
- return strip_tags($this->config->getAppValue('theming', 'productName', $this->productName));
- }
- public function getBaseUrl() {
- return $this->config->getAppValue('theming', 'url', $this->url);
- }
-
- public function getSlogan(?string $lang = null) {
- return \OCP\Util::sanitizeHTML($this->config->getAppValue('theming', 'slogan', parent::getSlogan($lang)));
- }
- public function getImprintUrl() {
- return (string)$this->config->getAppValue('theming', 'imprintUrl', '');
- }
- public function getPrivacyUrl() {
- return (string)$this->config->getAppValue('theming', 'privacyUrl', '');
- }
- public function getDocBaseUrl() {
- return (string)$this->config->getAppValue('theming', 'docBaseUrl', $this->docBaseUrl);
- }
- public function getShortFooter() {
- $slogan = $this->getSlogan();
- $baseUrl = $this->getBaseUrl();
- $entity = $this->getEntity();
- $footer = '';
- if ($entity !== '') {
- if ($baseUrl !== '') {
- $footer = '<a href="' . $baseUrl . '" target="_blank"' .
- ' rel="noreferrer noopener" class="entity-name">' . $entity . '</a>';
- } else {
- $footer = '<span class="entity-name">' . $entity . '</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()
- ],
- ];
- $navigation = $this->navigationManager->getAll(INavigationManager::TYPE_GUEST);
- $guestNavigation = array_map(function ($nav) {
- return [
- 'text' => $nav['name'],
- 'url' => $nav['href']
- ];
- }, $navigation);
- $links = array_merge($links, $guestNavigation);
- $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/><span class="footer__legal-links">' . $legalLinks . '</span>';
- }
- return $footer;
- }
-
- public function getColorPrimary(): string {
- $user = $this->userSession->getUser();
-
- $defaultColor = $this->getDefaultColorPrimary();
- if ($this->isUserThemingDisabled()) {
- return $defaultColor;
- }
-
- if (!empty($user)) {
- $userPrimaryColor = $this->config->getUserValue($user->getUID(), Application::APP_ID, 'primary_color', '');
- if (preg_match('/^\#([0-9a-f]{3}|[0-9a-f]{6})$/i', $userPrimaryColor)) {
- return $userPrimaryColor;
- }
- }
-
- return $defaultColor;
- }
-
- public function getColorBackground(): string {
- $user = $this->userSession->getUser();
-
- $defaultColor = $this->getDefaultColorBackground();
- if ($this->isUserThemingDisabled()) {
- return $defaultColor;
- }
-
- if (!empty($user)) {
- $userBackgroundColor = $this->config->getUserValue($user->getUID(), Application::APP_ID, 'background_color', '');
- if (preg_match('/^\#([0-9a-f]{3}|[0-9a-f]{6})$/i', $userBackgroundColor)) {
- return $userBackgroundColor;
- }
- }
-
- return $defaultColor;
- }
-
- public function getDefaultColorPrimary(): string {
-
- $defaultColor = $this->appConfig->getValueString(Application::APP_ID, 'primary_color', '');
- if (preg_match('/^\#([0-9a-f]{3}|[0-9a-f]{6})$/i', $defaultColor)) {
- return $defaultColor;
- }
-
- return $this->primaryColor;
- }
-
- public function getDefaultColorBackground(): string {
- $defaultColor = $this->appConfig->getValueString(Application::APP_ID, 'background_color');
- if (preg_match('/^\#([0-9a-f]{3}|[0-9a-f]{6})$/i', $defaultColor)) {
- return $defaultColor;
- }
- return $this->backgroundColor;
- }
-
- public function getLogo($useSvg = true): string {
- $logo = $this->config->getAppValue('theming', 'logoMime', '');
-
-
-
-
-
- if ($useSvg === true && $logo !== false) {
- $logoExists = true;
- } else {
- try {
- $this->imageManager->getImage('logo', $useSvg);
- $logoExists = true;
- } catch (\Exception $e) {
- $logoExists = false;
- }
- }
- $cacheBusterCounter = $this->config->getAppValue('theming', 'cachebuster', '0');
- if (!$logo || !$logoExists) {
- if ($useSvg) {
- $logo = $this->urlGenerator->imagePath('core', 'logo/logo.svg');
- } else {
- $logo = $this->urlGenerator->imagePath('core', 'logo/logo.png');
- }
- return $logo . '?v=' . $cacheBusterCounter;
- }
- return $this->urlGenerator->linkToRoute('theming.Theming.getImage', [ 'key' => 'logo', 'useSvg' => $useSvg, 'v' => $cacheBusterCounter ]);
- }
-
- public function getBackground(bool $darkVariant = false): string {
- return $this->imageManager->getImageUrl('background' . ($darkVariant ? 'Dark' : ''));
- }
-
- public function getiTunesAppId() {
- return $this->config->getAppValue('theming', 'iTunesAppId', $this->iTunesAppId);
- }
-
- public function getiOSClientUrl() {
- return $this->config->getAppValue('theming', 'iOSClientUrl', $this->iOSClientUrl);
- }
-
- public function getAndroidClientUrl() {
- return $this->config->getAppValue('theming', 'AndroidClientUrl', $this->AndroidClientUrl);
- }
-
- public function getFDroidClientUrl() {
- return $this->config->getAppValue('theming', 'FDroidClientUrl', $this->FDroidClientUrl);
- }
-
- public function getScssVariables() {
- $cacheBuster = $this->config->getAppValue('theming', 'cachebuster', '0');
- $cache = $this->cacheFactory->createDistributed('theming-' . $cacheBuster . '-' . $this->urlGenerator->getBaseUrl());
- if ($value = $cache->get('getScssVariables')) {
- return $value;
- }
- $variables = [
- 'theming-cachebuster' => "'" . $cacheBuster . "'",
- '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->imageManager->getImageUrl('logo') . "')";
- $variables['image-logoheader'] = "url('" . $this->imageManager->getImageUrl('logoheader') . "')";
- $variables['image-favicon'] = "url('" . $this->imageManager->getImageUrl('favicon') . "')";
- $variables['image-login-background'] = "url('" . $this->imageManager->getImageUrl('background') . "')";
- $variables['image-login-plain'] = 'false';
- if ($this->appConfig->getValueString(Application::APP_ID, 'primary_color', '') !== '') {
- $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', '') === '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;
- }
-
- public function replaceImagePath($app, $image) {
- if ($app === '' || $app === 'files_sharing') {
- $app = 'core';
- }
- $cacheBusterValue = $this->config->getAppValue('theming', 'cachebuster', '0');
- $route = false;
- if ($image === 'favicon.ico' && ($this->imageManager->shouldReplaceIcons() || $this->getCustomFavicon() !== null)) {
- $route = $this->urlGenerator->linkToRoute('theming.Icon.getFavicon', ['app' => $app]);
- }
- if (($image === 'favicon-touch.png' || $image === 'favicon-fb.png') && ($this->imageManager->shouldReplaceIcons() || $this->getCustomFavicon() !== null)) {
- $route = $this->urlGenerator->linkToRoute('theming.Icon.getTouchIcon', ['app' => $app]);
- }
- if ($image === 'manifest.json') {
- try {
- $appPath = $this->appManager->getAppPath($app);
- if (file_exists($appPath . '/img/manifest.json')) {
- return false;
- }
- } catch (AppPathNotFoundException $e) {
- }
- $route = $this->urlGenerator->linkToRoute('theming.Theming.getManifest', ['app' => $app ]);
- }
- if (str_starts_with($image, 'filetypes/') && file_exists(\OC::$SERVERROOT . '/core/img/' . $image)) {
- $route = $this->urlGenerator->linkToRoute('theming.Icon.getThemedIcon', ['app' => $app, 'image' => $image]);
- }
- if ($route) {
- return $route . '?v=' . $this->util->getCacheBuster();
- }
- return false;
- }
- protected function getCustomFavicon(): ?ISimpleFile {
- try {
- return $this->imageManager->getImage('favicon');
- } catch (NotFoundException $e) {
- return null;
- }
- }
-
- public function increaseCacheBuster(): void {
- $cacheBusterKey = (int)$this->config->getAppValue('theming', 'cachebuster', '0');
- $this->config->setAppValue('theming', 'cachebuster', (string)($cacheBusterKey + 1));
- $this->cacheFactory->createDistributed('theming-')->clear();
- $this->cacheFactory->createDistributed('imagePath')->clear();
- }
-
- public function set($setting, $value): void {
- $this->config->setAppValue('theming', $setting, $value);
- $this->increaseCacheBuster();
- }
-
- public function undoAll(): void {
-
-
- $cacheBusterKey = $this->config->getAppValue('theming', 'cachebuster', '0');
- $this->config->deleteAppValues('theming');
- $this->config->setAppValue('theming', 'cachebuster', $cacheBusterKey);
- $this->increaseCacheBuster();
- }
-
- public function undo($setting): string {
- $this->config->deleteAppValue('theming', $setting);
- $this->increaseCacheBuster();
- $returnValue = '';
- switch ($setting) {
- case 'name':
- $returnValue = $this->getEntity();
- break;
- case 'url':
- $returnValue = $this->getBaseUrl();
- break;
- case 'slogan':
- $returnValue = $this->getSlogan();
- break;
- case 'primary_color':
- $returnValue = BackgroundService::DEFAULT_COLOR;
- break;
- case 'background_color':
-
- if ($this->imageManager->hasImage('background')) {
- $file = $this->imageManager->getImage('background');
- $returnValue = $this->backgroundService->setGlobalBackground($file->read()) ?? '';
- }
- break;
- case 'logo':
- case 'logoheader':
- case 'background':
- case 'favicon':
- $this->imageManager->delete($setting);
- $this->config->deleteAppValue('theming', $setting . 'Mime');
- break;
- }
- return $returnValue;
- }
-
- public function getTextColorBackground() {
- return $this->util->invertTextColor($this->getColorBackground()) ? '#000000' : '#ffffff';
- }
-
- public function getTextColorPrimary() {
- return $this->util->invertTextColor($this->getColorPrimary()) ? '#000000' : '#ffffff';
- }
-
- public function getDefaultTextColorPrimary() {
- return $this->util->invertTextColor($this->getDefaultColorPrimary()) ? '#000000' : '#ffffff';
- }
-
- public function isUserThemingDisabled(): bool {
- return $this->appConfig->getValueBool(Application::APP_ID, 'disable-user-theming');
- }
- }
|