nextcloud / server

apps/theming/lib/Service/BackgroundService.php

Indentation +192 added lines, -192 removed lines

@@ -43,196 +43,196 @@
 use OCP\PreConditionNotMetException;
 
 class BackgroundService {
-	// true when the background is bright and need dark icons
-	public const THEMING_MODE_DARK = 'dark';
-	public const DEFAULT_COLOR = '#0082c9';
-	public const DEFAULT_ACCESSIBLE_COLOR = '#006aa3';
-
-	public const BACKGROUND_SHIPPED = 'shipped';
-	public const BACKGROUND_CUSTOM = 'custom';
-	public const BACKGROUND_DEFAULT = 'default';
-	public const BACKGROUND_DISABLED = 'disabled';
-
-	public const DEFAULT_BACKGROUND_IMAGE = 'kamil-porembinski-clouds.jpg';
-	public const SHIPPED_BACKGROUNDS = [
-		'anatoly-mikhaltsov-butterfly-wing-scale.jpg' => [
-			'attribution' => 'Butterfly wing scale (Anatoly Mikhaltsov, CC BY-SA)',
-			'attribution_url' => 'https://commons.wikimedia.org/wiki/File:%D0%A7%D0%B5%D1%88%D1%83%D0%B9%D0%BA%D0%B8_%D0%BA%D1%80%D1%8B%D0%BB%D0%B0_%D0%B1%D0%B0%D0%B1%D0%BE%D1%87%D0%BA%D0%B8.jpg',
-			'primary_color' => '#a53c17',
-		],
-		'bernie-cetonia-aurata-take-off-composition.jpg' => [
-			'attribution' => 'Cetonia aurata take off composition (Bernie, Public Domain)',
-			'attribution_url' => 'https://commons.wikimedia.org/wiki/File:Cetonia_aurata_take_off_composition_05172009.jpg',
-			'theming' => self::THEMING_MODE_DARK,
-			'primary_color' => '#56633d',
-		],
-		'dejan-krsmanovic-ribbed-red-metal.jpg' => [
-			'attribution' => 'Ribbed red metal (Dejan Krsmanovic, CC BY)',
-			'attribution_url' => 'https://www.flickr.com/photos/dejankrsmanovic/42971456774/',
-			'primary_color' => '#9c4236',
-		],
-		'eduardo-neves-pedra-azul.jpg' => [
-			'attribution' => 'Pedra azul milky way (Eduardo Neves, CC BY-SA)',
-			'attribution_url' => 'https://commons.wikimedia.org/wiki/File:Pedra_Azul_Milky_Way.jpg',
-			'primary_color' => '#4f6071',
-		],
-		'european-space-agency-barents-bloom.jpg' => [
-			'attribution' => 'Barents bloom (European Space Agency, CC BY-SA)',
-			'attribution_url' => 'https://www.esa.int/ESA_Multimedia/Images/2016/08/Barents_bloom',
-			'primary_color' => '#396475',
-		],
-		'hannes-fritz-flippity-floppity.jpg' => [
-			'attribution' => 'Flippity floppity (Hannes Fritz, CC BY-SA)',
-			'attribution_url' => 'http://hannes.photos/flippity-floppity',
-			'primary_color' => '#98415a',
-		],
-		'hannes-fritz-roulette.jpg' => [
-			'attribution' => 'Roulette (Hannes Fritz, CC BY-SA)',
-			'attribution_url' => 'http://hannes.photos/roulette',
-			'primary_color' => '#845334',
-		],
-		'hannes-fritz-sea-spray.jpg' => [
-			'attribution' => 'Sea spray (Hannes Fritz, CC BY-SA)',
-			'attribution_url' => 'http://hannes.photos/sea-spray',
-			'primary_color' => '#4f6071',
-		],
-		'kamil-porembinski-clouds.jpg' => [
-			'attribution' => 'Clouds (Kamil Porembiński, CC BY-SA)',
-			'attribution_url' => 'https://www.flickr.com/photos/paszczak000/8715851521/',
-			'primary_color' => self::DEFAULT_COLOR,
-		],
-		'bernard-spragg-new-zealand-fern.jpg' => [
-			'attribution' => 'New zealand fern (Bernard Spragg, CC0)',
-			'attribution_url' => 'https://commons.wikimedia.org/wiki/File:NZ_Fern.(Blechnum_chambersii)_(11263534936).jpg',
-			'primary_color' => '#316b26',
-		],
-		'rawpixel-pink-tapioca-bubbles.jpg' => [
-			'attribution' => 'Pink tapioca bubbles (Rawpixel, CC BY)',
-			'attribution_url' => 'https://www.flickr.com/photos/byrawpixel/27665140298/in/photostream/',
-			'theming' => self::THEMING_MODE_DARK,
-			'primary_color' => '#7b4e7e',
-		],
-		'nasa-waxing-crescent-moon.jpg' => [
-			'attribution' => 'Waxing crescent moon (NASA, Public Domain)',
-			'attribution_url' => 'https://www.nasa.gov/image-feature/a-waxing-crescent-moon',
-			'primary_color' => '#005ac1',
-		],
-		'tommy-chau-already.jpg' => [
-			'attribution' => 'Cityscape (Tommy Chau, CC BY)',
-			'attribution_url' => 'https://www.flickr.com/photos/90975693@N05/16910999368',
-			'primary_color' => '#6a2af4',
-		],
-		'tommy-chau-lion-rock-hill.jpg' => [
-			'attribution' => 'Lion rock hill (Tommy Chau, CC BY)',
-			'attribution_url' => 'https://www.flickr.com/photos/90975693@N05/17136440246',
-			'theming' => self::THEMING_MODE_DARK,
-			'primary_color' => '#7f4f70',
-		],
-		'lali-masriera-yellow-bricks.jpg' => [
-			'attribution' => 'Yellow bricks (Lali Masriera, CC BY)',
-			'attribution_url' => 'https://www.flickr.com/photos/visualpanic/3982464447',
-			'theming' => self::THEMING_MODE_DARK,
-			'primary_color' => '#7f5700',
-		],
-	];
-
-	private IRootFolder $rootFolder;
-	private IAppData $appData;
-	private IConfig $config;
-	private string $userId;
-	private ThemingDefaults $themingDefaults;
-
-	public function __construct(IRootFolder $rootFolder,
-								IAppData $appData,
-								IConfig $config,
-								?string $userId,
-								ThemingDefaults $themingDefaults) {
-		if ($userId === null) {
-			return;
-		}
-
-		$this->rootFolder = $rootFolder;
-		$this->config = $config;
-		$this->userId = $userId;
-		$this->appData = $appData;
-		$this->themingDefaults = $themingDefaults;
-	}
-
-	public function setDefaultBackground(): void {
-		$this->config->deleteUserValue($this->userId, Application::APP_ID, 'background_image');
-		$this->config->setUserValue($this->userId, Application::APP_ID, 'background_color', $this->themingDefaults->getDefaultColorPrimary());
-	}
-
-	/**
-	 * @param $path
-	 * @throws NotFoundException
-	 * @throws NotPermittedException
-	 * @throws LockedException
-	 * @throws PreConditionNotMetException
-	 * @throws NoUserException
-	 */
-	public function setFileBackground($path): void {
-		$this->config->setUserValue($this->userId, Application::APP_ID, 'background_image', self::BACKGROUND_CUSTOM);
-		$userFolder = $this->rootFolder->getUserFolder($this->userId);
-
-		/** @var File $file */
-		$file = $userFolder->get($path);
-		$image = new \OCP\Image();
-
-		if ($image->loadFromFileHandle($file->fopen('r')) === false) {
-			throw new InvalidArgumentException('Invalid image file');
-		}
-
-		$this->getAppDataFolder()->newFile('background.jpg', $file->fopen('r'));
-	}
-
-	public function setShippedBackground($fileName): void {
-		if (!array_key_exists($fileName, self::SHIPPED_BACKGROUNDS)) {
-			throw new InvalidArgumentException('The given file name is invalid');
-		}
-		$this->config->setUserValue($this->userId, Application::APP_ID, 'background_image', $fileName);
-		$this->setColorBackground(self::SHIPPED_BACKGROUNDS[$fileName]['primary_color']);
-	}
-
-	public function setColorBackground(string $color): void {
-		if (!preg_match('/^#([0-9a-f]{3}|[0-9a-f]{6})$/i', $color)) {
-			throw new InvalidArgumentException('The given color is invalid');
-		}
-		$this->config->setUserValue($this->userId, Application::APP_ID, 'background_color', $color);
-	}
-
-	public function deleteBackgroundImage(): void {
-		$this->config->setUserValue($this->userId, Application::APP_ID, 'background_image', self::BACKGROUND_DISABLED);
-	}
-
-	public function getBackground(): ?ISimpleFile {
-		$background = $this->config->getUserValue($this->userId, Application::APP_ID, 'background_image', self::BACKGROUND_DEFAULT);
-		if ($background === self::BACKGROUND_CUSTOM) {
-			try {
-				return $this->getAppDataFolder()->getFile('background.jpg');
-			} catch (NotFoundException | NotPermittedException $e) {
-				return null;
-			}
-		}
-		return null;
-	}
-
-	/**
-	 * Storing the data in appdata/theming/users/USERID
-	 *
-	 * @return ISimpleFolder
-	 * @throws NotPermittedException
-	 */
-	private function getAppDataFolder(): ISimpleFolder {
-		try {
-			$rootFolder = $this->appData->getFolder('users');
-		} catch (NotFoundException $e) {
-			$rootFolder = $this->appData->newFolder('users');
-		}
-		try {
-			return $rootFolder->getFolder($this->userId);
-		} catch (NotFoundException $e) {
-			return $rootFolder->newFolder($this->userId);
-		}
-	}
+    // true when the background is bright and need dark icons
+    public const THEMING_MODE_DARK = 'dark';
+    public const DEFAULT_COLOR = '#0082c9';
+    public const DEFAULT_ACCESSIBLE_COLOR = '#006aa3';
+
+    public const BACKGROUND_SHIPPED = 'shipped';
+    public const BACKGROUND_CUSTOM = 'custom';
+    public const BACKGROUND_DEFAULT = 'default';
+    public const BACKGROUND_DISABLED = 'disabled';
+
+    public const DEFAULT_BACKGROUND_IMAGE = 'kamil-porembinski-clouds.jpg';
+    public const SHIPPED_BACKGROUNDS = [
+        'anatoly-mikhaltsov-butterfly-wing-scale.jpg' => [
+            'attribution' => 'Butterfly wing scale (Anatoly Mikhaltsov, CC BY-SA)',
+            'attribution_url' => 'https://commons.wikimedia.org/wiki/File:%D0%A7%D0%B5%D1%88%D1%83%D0%B9%D0%BA%D0%B8_%D0%BA%D1%80%D1%8B%D0%BB%D0%B0_%D0%B1%D0%B0%D0%B1%D0%BE%D1%87%D0%BA%D0%B8.jpg',
+            'primary_color' => '#a53c17',
+        ],
+        'bernie-cetonia-aurata-take-off-composition.jpg' => [
+            'attribution' => 'Cetonia aurata take off composition (Bernie, Public Domain)',
+            'attribution_url' => 'https://commons.wikimedia.org/wiki/File:Cetonia_aurata_take_off_composition_05172009.jpg',
+            'theming' => self::THEMING_MODE_DARK,
+            'primary_color' => '#56633d',
+        ],
+        'dejan-krsmanovic-ribbed-red-metal.jpg' => [
+            'attribution' => 'Ribbed red metal (Dejan Krsmanovic, CC BY)',
+            'attribution_url' => 'https://www.flickr.com/photos/dejankrsmanovic/42971456774/',
+            'primary_color' => '#9c4236',
+        ],
+        'eduardo-neves-pedra-azul.jpg' => [
+            'attribution' => 'Pedra azul milky way (Eduardo Neves, CC BY-SA)',
+            'attribution_url' => 'https://commons.wikimedia.org/wiki/File:Pedra_Azul_Milky_Way.jpg',
+            'primary_color' => '#4f6071',
+        ],
+        'european-space-agency-barents-bloom.jpg' => [
+            'attribution' => 'Barents bloom (European Space Agency, CC BY-SA)',
+            'attribution_url' => 'https://www.esa.int/ESA_Multimedia/Images/2016/08/Barents_bloom',
+            'primary_color' => '#396475',
+        ],
+        'hannes-fritz-flippity-floppity.jpg' => [
+            'attribution' => 'Flippity floppity (Hannes Fritz, CC BY-SA)',
+            'attribution_url' => 'http://hannes.photos/flippity-floppity',
+            'primary_color' => '#98415a',
+        ],
+        'hannes-fritz-roulette.jpg' => [
+            'attribution' => 'Roulette (Hannes Fritz, CC BY-SA)',
+            'attribution_url' => 'http://hannes.photos/roulette',
+            'primary_color' => '#845334',
+        ],
+        'hannes-fritz-sea-spray.jpg' => [
+            'attribution' => 'Sea spray (Hannes Fritz, CC BY-SA)',
+            'attribution_url' => 'http://hannes.photos/sea-spray',
+            'primary_color' => '#4f6071',
+        ],
+        'kamil-porembinski-clouds.jpg' => [
+            'attribution' => 'Clouds (Kamil Porembiński, CC BY-SA)',
+            'attribution_url' => 'https://www.flickr.com/photos/paszczak000/8715851521/',
+            'primary_color' => self::DEFAULT_COLOR,
+        ],
+        'bernard-spragg-new-zealand-fern.jpg' => [
+            'attribution' => 'New zealand fern (Bernard Spragg, CC0)',
+            'attribution_url' => 'https://commons.wikimedia.org/wiki/File:NZ_Fern.(Blechnum_chambersii)_(11263534936).jpg',
+            'primary_color' => '#316b26',
+        ],
+        'rawpixel-pink-tapioca-bubbles.jpg' => [
+            'attribution' => 'Pink tapioca bubbles (Rawpixel, CC BY)',
+            'attribution_url' => 'https://www.flickr.com/photos/byrawpixel/27665140298/in/photostream/',
+            'theming' => self::THEMING_MODE_DARK,
+            'primary_color' => '#7b4e7e',
+        ],
+        'nasa-waxing-crescent-moon.jpg' => [
+            'attribution' => 'Waxing crescent moon (NASA, Public Domain)',
+            'attribution_url' => 'https://www.nasa.gov/image-feature/a-waxing-crescent-moon',
+            'primary_color' => '#005ac1',
+        ],
+        'tommy-chau-already.jpg' => [
+            'attribution' => 'Cityscape (Tommy Chau, CC BY)',
+            'attribution_url' => 'https://www.flickr.com/photos/90975693@N05/16910999368',
+            'primary_color' => '#6a2af4',
+        ],
+        'tommy-chau-lion-rock-hill.jpg' => [
+            'attribution' => 'Lion rock hill (Tommy Chau, CC BY)',
+            'attribution_url' => 'https://www.flickr.com/photos/90975693@N05/17136440246',
+            'theming' => self::THEMING_MODE_DARK,
+            'primary_color' => '#7f4f70',
+        ],
+        'lali-masriera-yellow-bricks.jpg' => [
+            'attribution' => 'Yellow bricks (Lali Masriera, CC BY)',
+            'attribution_url' => 'https://www.flickr.com/photos/visualpanic/3982464447',
+            'theming' => self::THEMING_MODE_DARK,
+            'primary_color' => '#7f5700',
+        ],
+    ];
+
+    private IRootFolder $rootFolder;
+    private IAppData $appData;
+    private IConfig $config;
+    private string $userId;
+    private ThemingDefaults $themingDefaults;
+
+    public function __construct(IRootFolder $rootFolder,
+                                IAppData $appData,
+                                IConfig $config,
+                                ?string $userId,
+                                ThemingDefaults $themingDefaults) {
+        if ($userId === null) {
+            return;
+        }
+
+        $this->rootFolder = $rootFolder;
+        $this->config = $config;
+        $this->userId = $userId;
+        $this->appData = $appData;
+        $this->themingDefaults = $themingDefaults;
+    }
+
+    public function setDefaultBackground(): void {
+        $this->config->deleteUserValue($this->userId, Application::APP_ID, 'background_image');
+        $this->config->setUserValue($this->userId, Application::APP_ID, 'background_color', $this->themingDefaults->getDefaultColorPrimary());
+    }
+
+    /**
+     * @param $path
+     * @throws NotFoundException
+     * @throws NotPermittedException
+     * @throws LockedException
+     * @throws PreConditionNotMetException
+     * @throws NoUserException
+     */
+    public function setFileBackground($path): void {
+        $this->config->setUserValue($this->userId, Application::APP_ID, 'background_image', self::BACKGROUND_CUSTOM);
+        $userFolder = $this->rootFolder->getUserFolder($this->userId);
+
+        /** @var File $file */
+        $file = $userFolder->get($path);
+        $image = new \OCP\Image();
+
+        if ($image->loadFromFileHandle($file->fopen('r')) === false) {
+            throw new InvalidArgumentException('Invalid image file');
+        }
+
+        $this->getAppDataFolder()->newFile('background.jpg', $file->fopen('r'));
+    }
+
+    public function setShippedBackground($fileName): void {
+        if (!array_key_exists($fileName, self::SHIPPED_BACKGROUNDS)) {
+            throw new InvalidArgumentException('The given file name is invalid');
+        }
+        $this->config->setUserValue($this->userId, Application::APP_ID, 'background_image', $fileName);
+        $this->setColorBackground(self::SHIPPED_BACKGROUNDS[$fileName]['primary_color']);
+    }
+
+    public function setColorBackground(string $color): void {
+        if (!preg_match('/^#([0-9a-f]{3}|[0-9a-f]{6})$/i', $color)) {
+            throw new InvalidArgumentException('The given color is invalid');
+        }
+        $this->config->setUserValue($this->userId, Application::APP_ID, 'background_color', $color);
+    }
+
+    public function deleteBackgroundImage(): void {
+        $this->config->setUserValue($this->userId, Application::APP_ID, 'background_image', self::BACKGROUND_DISABLED);
+    }
+
+    public function getBackground(): ?ISimpleFile {
+        $background = $this->config->getUserValue($this->userId, Application::APP_ID, 'background_image', self::BACKGROUND_DEFAULT);
+        if ($background === self::BACKGROUND_CUSTOM) {
+            try {
+                return $this->getAppDataFolder()->getFile('background.jpg');
+            } catch (NotFoundException | NotPermittedException $e) {
+                return null;
+            }
+        }
+        return null;
+    }
+
+    /**
+     * Storing the data in appdata/theming/users/USERID
+     *
+     * @return ISimpleFolder
+     * @throws NotPermittedException
+     */
+    private function getAppDataFolder(): ISimpleFolder {
+        try {
+            $rootFolder = $this->appData->getFolder('users');
+        } catch (NotFoundException $e) {
+            $rootFolder = $this->appData->newFolder('users');
+        }
+        try {
+            return $rootFolder->getFolder($this->userId);
+        } catch (NotFoundException $e) {
+            return $rootFolder->newFolder($this->userId);
+        }
+    }
 }

apps/theming/lib/Command/UpdateConfig.php

Indentation +102 added lines, -102 removed lines

@@ -32,106 +32,106 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 class UpdateConfig extends Command {
-	public const SUPPORTED_KEYS = [
-		'name', 'url', 'imprintUrl', 'privacyUrl', 'slogan', 'color', 'disable-user-theming'
-	];
-
-	private $themingDefaults;
-	private $imageManager;
-	private $config;
-
-	public function __construct(ThemingDefaults $themingDefaults, ImageManager $imageManager, IConfig $config) {
-		parent::__construct();
-
-		$this->themingDefaults = $themingDefaults;
-		$this->imageManager = $imageManager;
-		$this->config = $config;
-	}
-
-	protected function configure() {
-		$this
-			->setName('theming:config')
-			->setDescription('Set theming app config values')
-			->addArgument(
-				'key',
-				InputArgument::OPTIONAL,
-				'Key to update the theming app configuration (leave empty to get a list of all configured values)' . PHP_EOL .
-				'One of: ' . implode(', ', self::SUPPORTED_KEYS)
-			)
-			->addArgument(
-				'value',
-				InputArgument::OPTIONAL,
-				'Value to set (leave empty to obtain the current value)'
-			)
-			->addOption(
-				'reset',
-				'r',
-				InputOption::VALUE_NONE,
-				'Reset the given config key to default'
-			);
-	}
-
-
-	protected function execute(InputInterface $input, OutputInterface $output): int {
-		$key = $input->getArgument('key');
-		$value = $input->getArgument('value');
-		assert(is_string($value) || $value === null, 'At most one value should be provided.');
-
-		if ($key === null) {
-			$output->writeln('Current theming config:');
-			foreach (self::SUPPORTED_KEYS as $key) {
-				$value = $this->config->getAppValue('theming', $key, '');
-				$output->writeln('- ' . $key . ': ' . $value . '');
-			}
-			foreach (ImageManager::SUPPORTED_IMAGE_KEYS as $key) {
-				$value = $this->config->getAppValue('theming', $key . 'Mime', '');
-				$output->writeln('- ' . $key . ': ' . $value . '');
-			}
-			return 0;
-		}
-
-		if (!in_array($key, self::SUPPORTED_KEYS, true) && !in_array($key, ImageManager::SUPPORTED_IMAGE_KEYS, true)) {
-			$output->writeln('<error>Invalid config key provided</error>');
-			return 1;
-		}
-
-		if ($input->getOption('reset')) {
-			$defaultValue = $this->themingDefaults->undo($key);
-			$output->writeln('<info>Reset ' . $key . ' to ' . $defaultValue . '</info>');
-			return 0;
-		}
-
-		if ($value === null) {
-			$value = $this->config->getAppValue('theming', $key, '');
-			if ($value !== '') {
-				$output->writeln('<info>' . $key . ' is currently set to ' . $value . '</info>');
-			} else {
-				$output->writeln('<info>' . $key . ' is currently not set</info>');
-			}
-			return 0;
-		}
-
-		if (in_array($key, ImageManager::SUPPORTED_IMAGE_KEYS, true)) {
-			if (strpos($value, '/') !== 0) {
-				$output->writeln('<error>The image file needs to be provided as an absolute path: ' . $value . '.</error>');
-				return 1;
-			}
-			if (!file_exists($value)) {
-				$output->writeln('<error>File could not be found: ' . $value . '.</error>');
-				return 1;
-			}
-			$value = $this->imageManager->updateImage($key, $value);
-			$key = $key . 'Mime';
-		}
-
-		if ($key === 'color' && !preg_match('/^\#([0-9a-f]{3}|[0-9a-f]{6})$/i', $value)) {
-			$output->writeln('<error>The given color is invalid: ' . $value . '</error>');
-			return 1;
-		}
-
-		$this->themingDefaults->set($key, $value);
-		$output->writeln('<info>Updated ' . $key . ' to ' . $value . '</info>');
-
-		return 0;
-	}
+    public const SUPPORTED_KEYS = [
+        'name', 'url', 'imprintUrl', 'privacyUrl', 'slogan', 'color', 'disable-user-theming'
+    ];
+
+    private $themingDefaults;
+    private $imageManager;
+    private $config;
+
+    public function __construct(ThemingDefaults $themingDefaults, ImageManager $imageManager, IConfig $config) {
+        parent::__construct();
+
+        $this->themingDefaults = $themingDefaults;
+        $this->imageManager = $imageManager;
+        $this->config = $config;
+    }
+
+    protected function configure() {
+        $this
+            ->setName('theming:config')
+            ->setDescription('Set theming app config values')
+            ->addArgument(
+                'key',
+                InputArgument::OPTIONAL,
+                'Key to update the theming app configuration (leave empty to get a list of all configured values)' . PHP_EOL .
+                'One of: ' . implode(', ', self::SUPPORTED_KEYS)
+            )
+            ->addArgument(
+                'value',
+                InputArgument::OPTIONAL,
+                'Value to set (leave empty to obtain the current value)'
+            )
+            ->addOption(
+                'reset',
+                'r',
+                InputOption::VALUE_NONE,
+                'Reset the given config key to default'
+            );
+    }
+
+
+    protected function execute(InputInterface $input, OutputInterface $output): int {
+        $key = $input->getArgument('key');
+        $value = $input->getArgument('value');
+        assert(is_string($value) || $value === null, 'At most one value should be provided.');
+
+        if ($key === null) {
+            $output->writeln('Current theming config:');
+            foreach (self::SUPPORTED_KEYS as $key) {
+                $value = $this->config->getAppValue('theming', $key, '');
+                $output->writeln('- ' . $key . ': ' . $value . '');
+            }
+            foreach (ImageManager::SUPPORTED_IMAGE_KEYS as $key) {
+                $value = $this->config->getAppValue('theming', $key . 'Mime', '');
+                $output->writeln('- ' . $key . ': ' . $value . '');
+            }
+            return 0;
+        }
+
+        if (!in_array($key, self::SUPPORTED_KEYS, true) && !in_array($key, ImageManager::SUPPORTED_IMAGE_KEYS, true)) {
+            $output->writeln('<error>Invalid config key provided</error>');
+            return 1;
+        }
+
+        if ($input->getOption('reset')) {
+            $defaultValue = $this->themingDefaults->undo($key);
+            $output->writeln('<info>Reset ' . $key . ' to ' . $defaultValue . '</info>');
+            return 0;
+        }
+
+        if ($value === null) {
+            $value = $this->config->getAppValue('theming', $key, '');
+            if ($value !== '') {
+                $output->writeln('<info>' . $key . ' is currently set to ' . $value . '</info>');
+            } else {
+                $output->writeln('<info>' . $key . ' is currently not set</info>');
+            }
+            return 0;
+        }
+
+        if (in_array($key, ImageManager::SUPPORTED_IMAGE_KEYS, true)) {
+            if (strpos($value, '/') !== 0) {
+                $output->writeln('<error>The image file needs to be provided as an absolute path: ' . $value . '.</error>');
+                return 1;
+            }
+            if (!file_exists($value)) {
+                $output->writeln('<error>File could not be found: ' . $value . '.</error>');
+                return 1;
+            }
+            $value = $this->imageManager->updateImage($key, $value);
+            $key = $key . 'Mime';
+        }
+
+        if ($key === 'color' && !preg_match('/^\#([0-9a-f]{3}|[0-9a-f]{6})$/i', $value)) {
+            $output->writeln('<error>The given color is invalid: ' . $value . '</error>');
+            return 1;
+        }
+
+        $this->themingDefaults->set($key, $value);
+        $output->writeln('<info>Updated ' . $key . ' to ' . $value . '</info>');
+
+        return 0;
+    }
 }

Spacing +13 added lines, -13 removed lines

@@ -55,8 +55,8 @@ 
 			->addArgument(
 				'key',
 				InputArgument::OPTIONAL,
-				'Key to update the theming app configuration (leave empty to get a list of all configured values)' . PHP_EOL .
-				'One of: ' . implode(', ', self::SUPPORTED_KEYS)
+				'Key to update the theming app configuration (leave empty to get a list of all configured values)'.PHP_EOL.
+				'One of: '.implode(', ', self::SUPPORTED_KEYS)
 			)
 			->addArgument(
 				'value',
@@ -81,11 +81,11 @@ 
 			$output->writeln('Current theming config:');
 			foreach (self::SUPPORTED_KEYS as $key) {
 				$value = $this->config->getAppValue('theming', $key, '');
-				$output->writeln('- ' . $key . ': ' . $value . '');
+				$output->writeln('- '.$key.': '.$value.'');
 			}
 			foreach (ImageManager::SUPPORTED_IMAGE_KEYS as $key) {
-				$value = $this->config->getAppValue('theming', $key . 'Mime', '');
-				$output->writeln('- ' . $key . ': ' . $value . '');
+				$value = $this->config->getAppValue('theming', $key.'Mime', '');
+				$output->writeln('- '.$key.': '.$value.'');
 			}
 			return 0;
 		}
@@ -97,40 +97,40 @@ 
 
 		if ($input->getOption('reset')) {
 			$defaultValue = $this->themingDefaults->undo($key);
-			$output->writeln('<info>Reset ' . $key . ' to ' . $defaultValue . '</info>');
+			$output->writeln('<info>Reset '.$key.' to '.$defaultValue.'</info>');
 			return 0;
 		}
 
 		if ($value === null) {
 			$value = $this->config->getAppValue('theming', $key, '');
 			if ($value !== '') {
-				$output->writeln('<info>' . $key . ' is currently set to ' . $value . '</info>');
+				$output->writeln('<info>'.$key.' is currently set to '.$value.'</info>');
 			} else {
-				$output->writeln('<info>' . $key . ' is currently not set</info>');
+				$output->writeln('<info>'.$key.' is currently not set</info>');
 			}
 			return 0;
 		}
 
 		if (in_array($key, ImageManager::SUPPORTED_IMAGE_KEYS, true)) {
 			if (strpos($value, '/') !== 0) {
-				$output->writeln('<error>The image file needs to be provided as an absolute path: ' . $value . '.</error>');
+				$output->writeln('<error>The image file needs to be provided as an absolute path: '.$value.'.</error>');
 				return 1;
 			}
 			if (!file_exists($value)) {
-				$output->writeln('<error>File could not be found: ' . $value . '.</error>');
+				$output->writeln('<error>File could not be found: '.$value.'.</error>');
 				return 1;
 			}
 			$value = $this->imageManager->updateImage($key, $value);
-			$key = $key . 'Mime';
+			$key = $key.'Mime';
 		}
 
 		if ($key === 'color' && !preg_match('/^\#([0-9a-f]{3}|[0-9a-f]{6})$/i', $value)) {
-			$output->writeln('<error>The given color is invalid: ' . $value . '</error>');
+			$output->writeln('<error>The given color is invalid: '.$value.'</error>');
 			return 1;
 		}
 
 		$this->themingDefaults->set($key, $value);
-		$output->writeln('<info>Updated ' . $key . ' to ' . $value . '</info>');
+		$output->writeln('<info>Updated '.$key.' to '.$value.'</info>');
 
 		return 0;
 	}

apps/theming/lib/Themes/CommonThemeTrait.php

Indentation +132 added lines, -132 removed lines

@@ -30,136 +30,136 @@
 use OCA\Theming\Util;
 
 trait CommonThemeTrait {
-	public Util $util;
-
-	/**
-	 * Generate primary-related variables
-	 * This is shared between multiple themes because colorMainBackground and colorMainText
-	 * will change in between.
-	 */
-	protected function generatePrimaryVariables(string $colorMainBackground, string $colorMainText): array {
-		$colorPrimaryLight = $this->util->mix($this->primaryColor, $colorMainBackground, -80);
-		$colorPrimaryElement = $this->util->elementColor($this->primaryColor);
-		$colorPrimaryElementDefault = $this->util->elementColor($this->defaultPrimaryColor);
-		$colorPrimaryElementLight = $this->util->mix($colorPrimaryElement, $colorMainBackground, -80);
-
-		// primary related colours
-		return [
-			// invert filter if primary is too bright
-			// to be used for legacy reasons only. Use inline
-			// svg with proper css variable instead or material
-			// design icons.
-			// ⚠️ Using 'no' as a value to make sure we specify an
-			// invalid one with no fallback. 'unset' could here fallback to some
-			// other theme with media queries
-			'--primary-invert-if-bright' => $this->util->invertTextColor($this->primaryColor) ? 'invert(100%)' : 'no',
-
-			'--color-primary' => $this->primaryColor,
-			'--color-primary-default' => $this->defaultPrimaryColor,
-			'--color-primary-text' => $this->util->invertTextColor($this->primaryColor) ? '#000000' : '#ffffff',
-			'--color-primary-hover' => $this->util->mix($this->primaryColor, $colorMainBackground, 60),
-			'--color-primary-light' => $colorPrimaryLight,
-			'--color-primary-light-text' => $this->util->mix($this->primaryColor, $this->util->invertTextColor($colorPrimaryLight) ? '#000000' : '#ffffff', -20),
-			'--color-primary-light-hover' => $this->util->mix($colorPrimaryLight, $colorMainText, 90),
-			'--color-primary-text-dark' => $this->util->darken($this->util->invertTextColor($this->primaryColor) ? '#000000' : '#ffffff', 7),
-
-			// used for buttons, inputs...
-			'--color-primary-element' => $colorPrimaryElement,
-			'--color-primary-element-default-hover' => $this->util->mix($colorPrimaryElementDefault, $colorMainBackground, 60),
-			'--color-primary-element-text' => $this->util->invertTextColor($colorPrimaryElement) ? '#000000' : '#ffffff',
-			'--color-primary-element-hover' => $this->util->mix($colorPrimaryElement, $colorMainBackground, 60),
-			'--color-primary-element-light' => $colorPrimaryElementLight,
-			'--color-primary-element-light-text' => $this->util->mix($colorPrimaryElement, $this->util->invertTextColor($colorPrimaryElementLight) ? '#000000' : '#ffffff', -20),
-			'--color-primary-element-light-hover' => $this->util->mix($colorPrimaryElementLight, $colorMainText, 90),
-			'--color-primary-element-text-dark' => $this->util->darken($this->util->invertTextColor($colorPrimaryElement) ? '#000000' : '#ffffff', 7),
-
-			// to use like this: background-image: var(--gradient-primary-background);
-			'--gradient-primary-background' => 'linear-gradient(40deg, var(--color-primary) 0%, var(--color-primary-hover) 100%)',
-		];
-	}
-
-	/**
-	 * Generate admin theming background-related variables
-	 */
-	protected function generateGlobalBackgroundVariables(): array {
-		$user = $this->userSession->getUser();
-		$backgroundDeleted = $this->config->getAppValue(Application::APP_ID, 'backgroundMime', '') === 'backgroundColor';
-		$hasCustomLogoHeader = $this->util->isLogoThemed();
-
-		$variables = [];
-
-		// Default last fallback values
-		$variables['--image-background-default'] = "url('" . $this->themingDefaults->getBackground() . "')";
-		$variables['--color-background-plain'] = $this->defaultPrimaryColor;
-
-		// If primary as background has been request or if we have a custom primary colour
-		// let's not define the background image
-		if ($backgroundDeleted) {
-			$variables['--color-background-plain'] = $this->themingDefaults->getColorPrimary();
-			$variables['--image-background-plain'] = 'yes';
-		}
-
-		// Register image variables only if custom-defined
-		foreach (ImageManager::SUPPORTED_IMAGE_KEYS as $image) {
-			if ($this->imageManager->hasImage($image)) {
-				$imageUrl = $this->imageManager->getImageUrl($image);
-				if ($image === 'background') {
-					// If background deleted is set, ignoring variable
-					if ($backgroundDeleted) {
-						continue;
-					}
-					$variables['--image-background-size'] = 'cover';
-				}
-				// --image-background is overridden by user theming
-				$variables["--image-$image"] = "url('" . $imageUrl . "')";
-			}
-		}
-
-		if ($hasCustomLogoHeader) {
-			$variables["--image-logoheader-custom"] = 'true';
-		}
-
-		return $variables;
-	}
-
-	/**
-	 * Generate user theming background-related variables
-	 */
-	protected function generateUserBackgroundVariables(): array {
-		$user = $this->userSession->getUser();
-		if ($user !== null
-			&& !$this->themingDefaults->isUserThemingDisabled()
-			&& $this->appManager->isEnabledForUser(Application::APP_ID)) {
-			$backgroundImage = $this->config->getUserValue($user->getUID(), Application::APP_ID, 'background_image', BackgroundService::BACKGROUND_DEFAULT);
-			$currentVersion = (int)$this->config->getUserValue($user->getUID(), Application::APP_ID, 'userCacheBuster', '0');
-
-			// The user removed the background
-			if ($backgroundImage === BackgroundService::BACKGROUND_DISABLED) {
-				return [
-					'--image-background' => 'no',
-					'--color-background-plain' => $this->themingDefaults->getColorPrimary(),
-				];
-			}
-
-			// The user uploaded a custom background
-			if ($backgroundImage === BackgroundService::BACKGROUND_CUSTOM) {
-				$cacheBuster = substr(sha1($user->getUID() . '_' . $currentVersion), 0, 8);
-				return [
-					'--image-background' => "url('" . $this->urlGenerator->linkToRouteAbsolute('theming.userTheme.getBackground') . "?v=$cacheBuster')",
-					'--color-background-plain' => $this->themingDefaults->getColorPrimary(),
-				];
-			}
-
-			// The user picked a shipped background
-			if (isset(BackgroundService::SHIPPED_BACKGROUNDS[$backgroundImage])) {
-				return [
-					'--image-background' => "url('" . $this->urlGenerator->linkTo(Application::APP_ID, "img/background/$backgroundImage") . "')",
-					'--color-background-plain' => $this->themingDefaults->getColorPrimary(),
-					'--background-image-invert-if-bright' => BackgroundService::SHIPPED_BACKGROUNDS[$backgroundImage]['theming'] ?? null === BackgroundService::THEMING_MODE_DARK ? 'invert(100%)' : 'no',
-				];
-			}
-		}
-
-		return [];
-	}
+    public Util $util;
+
+    /**
+     * Generate primary-related variables
+     * This is shared between multiple themes because colorMainBackground and colorMainText
+     * will change in between.
+     */
+    protected function generatePrimaryVariables(string $colorMainBackground, string $colorMainText): array {
+        $colorPrimaryLight = $this->util->mix($this->primaryColor, $colorMainBackground, -80);
+        $colorPrimaryElement = $this->util->elementColor($this->primaryColor);
+        $colorPrimaryElementDefault = $this->util->elementColor($this->defaultPrimaryColor);
+        $colorPrimaryElementLight = $this->util->mix($colorPrimaryElement, $colorMainBackground, -80);
+
+        // primary related colours
+        return [
+            // invert filter if primary is too bright
+            // to be used for legacy reasons only. Use inline
+            // svg with proper css variable instead or material
+            // design icons.
+            // ⚠️ Using 'no' as a value to make sure we specify an
+            // invalid one with no fallback. 'unset' could here fallback to some
+            // other theme with media queries
+            '--primary-invert-if-bright' => $this->util->invertTextColor($this->primaryColor) ? 'invert(100%)' : 'no',
+
+            '--color-primary' => $this->primaryColor,
+            '--color-primary-default' => $this->defaultPrimaryColor,
+            '--color-primary-text' => $this->util->invertTextColor($this->primaryColor) ? '#000000' : '#ffffff',
+            '--color-primary-hover' => $this->util->mix($this->primaryColor, $colorMainBackground, 60),
+            '--color-primary-light' => $colorPrimaryLight,
+            '--color-primary-light-text' => $this->util->mix($this->primaryColor, $this->util->invertTextColor($colorPrimaryLight) ? '#000000' : '#ffffff', -20),
+            '--color-primary-light-hover' => $this->util->mix($colorPrimaryLight, $colorMainText, 90),
+            '--color-primary-text-dark' => $this->util->darken($this->util->invertTextColor($this->primaryColor) ? '#000000' : '#ffffff', 7),
+
+            // used for buttons, inputs...
+            '--color-primary-element' => $colorPrimaryElement,
+            '--color-primary-element-default-hover' => $this->util->mix($colorPrimaryElementDefault, $colorMainBackground, 60),
+            '--color-primary-element-text' => $this->util->invertTextColor($colorPrimaryElement) ? '#000000' : '#ffffff',
+            '--color-primary-element-hover' => $this->util->mix($colorPrimaryElement, $colorMainBackground, 60),
+            '--color-primary-element-light' => $colorPrimaryElementLight,
+            '--color-primary-element-light-text' => $this->util->mix($colorPrimaryElement, $this->util->invertTextColor($colorPrimaryElementLight) ? '#000000' : '#ffffff', -20),
+            '--color-primary-element-light-hover' => $this->util->mix($colorPrimaryElementLight, $colorMainText, 90),
+            '--color-primary-element-text-dark' => $this->util->darken($this->util->invertTextColor($colorPrimaryElement) ? '#000000' : '#ffffff', 7),
+
+            // to use like this: background-image: var(--gradient-primary-background);
+            '--gradient-primary-background' => 'linear-gradient(40deg, var(--color-primary) 0%, var(--color-primary-hover) 100%)',
+        ];
+    }
+
+    /**
+     * Generate admin theming background-related variables
+     */
+    protected function generateGlobalBackgroundVariables(): array {
+        $user = $this->userSession->getUser();
+        $backgroundDeleted = $this->config->getAppValue(Application::APP_ID, 'backgroundMime', '') === 'backgroundColor';
+        $hasCustomLogoHeader = $this->util->isLogoThemed();
+
+        $variables = [];
+
+        // Default last fallback values
+        $variables['--image-background-default'] = "url('" . $this->themingDefaults->getBackground() . "')";
+        $variables['--color-background-plain'] = $this->defaultPrimaryColor;
+
+        // If primary as background has been request or if we have a custom primary colour
+        // let's not define the background image
+        if ($backgroundDeleted) {
+            $variables['--color-background-plain'] = $this->themingDefaults->getColorPrimary();
+            $variables['--image-background-plain'] = 'yes';
+        }
+
+        // Register image variables only if custom-defined
+        foreach (ImageManager::SUPPORTED_IMAGE_KEYS as $image) {
+            if ($this->imageManager->hasImage($image)) {
+                $imageUrl = $this->imageManager->getImageUrl($image);
+                if ($image === 'background') {
+                    // If background deleted is set, ignoring variable
+                    if ($backgroundDeleted) {
+                        continue;
+                    }
+                    $variables['--image-background-size'] = 'cover';
+                }
+                // --image-background is overridden by user theming
+                $variables["--image-$image"] = "url('" . $imageUrl . "')";
+            }
+        }
+
+        if ($hasCustomLogoHeader) {
+            $variables["--image-logoheader-custom"] = 'true';
+        }
+
+        return $variables;
+    }
+
+    /**
+     * Generate user theming background-related variables
+     */
+    protected function generateUserBackgroundVariables(): array {
+        $user = $this->userSession->getUser();
+        if ($user !== null
+            && !$this->themingDefaults->isUserThemingDisabled()
+            && $this->appManager->isEnabledForUser(Application::APP_ID)) {
+            $backgroundImage = $this->config->getUserValue($user->getUID(), Application::APP_ID, 'background_image', BackgroundService::BACKGROUND_DEFAULT);
+            $currentVersion = (int)$this->config->getUserValue($user->getUID(), Application::APP_ID, 'userCacheBuster', '0');
+
+            // The user removed the background
+            if ($backgroundImage === BackgroundService::BACKGROUND_DISABLED) {
+                return [
+                    '--image-background' => 'no',
+                    '--color-background-plain' => $this->themingDefaults->getColorPrimary(),
+                ];
+            }
+
+            // The user uploaded a custom background
+            if ($backgroundImage === BackgroundService::BACKGROUND_CUSTOM) {
+                $cacheBuster = substr(sha1($user->getUID() . '_' . $currentVersion), 0, 8);
+                return [
+                    '--image-background' => "url('" . $this->urlGenerator->linkToRouteAbsolute('theming.userTheme.getBackground') . "?v=$cacheBuster')",
+                    '--color-background-plain' => $this->themingDefaults->getColorPrimary(),
+                ];
+            }
+
+            // The user picked a shipped background
+            if (isset(BackgroundService::SHIPPED_BACKGROUNDS[$backgroundImage])) {
+                return [
+                    '--image-background' => "url('" . $this->urlGenerator->linkTo(Application::APP_ID, "img/background/$backgroundImage") . "')",
+                    '--color-background-plain' => $this->themingDefaults->getColorPrimary(),
+                    '--background-image-invert-if-bright' => BackgroundService::SHIPPED_BACKGROUNDS[$backgroundImage]['theming'] ?? null === BackgroundService::THEMING_MODE_DARK ? 'invert(100%)' : 'no',
+                ];
+            }
+        }
+
+        return [];
+    }
 }

Spacing +6 added lines, -6 removed lines

@@ -89,7 +89,7 @@ 
 		$variables = [];
 
 		// Default last fallback values
-		$variables['--image-background-default'] = "url('" . $this->themingDefaults->getBackground() . "')";
+		$variables['--image-background-default'] = "url('".$this->themingDefaults->getBackground()."')";
 		$variables['--color-background-plain'] = $this->defaultPrimaryColor;
 
 		// If primary as background has been request or if we have a custom primary colour
@@ -111,7 +111,7 @@ 
 					$variables['--image-background-size'] = 'cover';
 				}
 				// --image-background is overridden by user theming
-				$variables["--image-$image"] = "url('" . $imageUrl . "')";
+				$variables["--image-$image"] = "url('".$imageUrl."')";
 			}
 		}
 
@@ -131,7 +131,7 @@ 
 			&& !$this->themingDefaults->isUserThemingDisabled()
 			&& $this->appManager->isEnabledForUser(Application::APP_ID)) {
 			$backgroundImage = $this->config->getUserValue($user->getUID(), Application::APP_ID, 'background_image', BackgroundService::BACKGROUND_DEFAULT);
-			$currentVersion = (int)$this->config->getUserValue($user->getUID(), Application::APP_ID, 'userCacheBuster', '0');
+			$currentVersion = (int) $this->config->getUserValue($user->getUID(), Application::APP_ID, 'userCacheBuster', '0');
 
 			// The user removed the background
 			if ($backgroundImage === BackgroundService::BACKGROUND_DISABLED) {
@@ -143,9 +143,9 @@ 
 
 			// The user uploaded a custom background
 			if ($backgroundImage === BackgroundService::BACKGROUND_CUSTOM) {
-				$cacheBuster = substr(sha1($user->getUID() . '_' . $currentVersion), 0, 8);
+				$cacheBuster = substr(sha1($user->getUID().'_'.$currentVersion), 0, 8);
 				return [
-					'--image-background' => "url('" . $this->urlGenerator->linkToRouteAbsolute('theming.userTheme.getBackground') . "?v=$cacheBuster')",
+					'--image-background' => "url('".$this->urlGenerator->linkToRouteAbsolute('theming.userTheme.getBackground')."?v=$cacheBuster')",
 					'--color-background-plain' => $this->themingDefaults->getColorPrimary(),
 				];
 			}
@@ -153,7 +153,7 @@ 
 			// The user picked a shipped background
 			if (isset(BackgroundService::SHIPPED_BACKGROUNDS[$backgroundImage])) {
 				return [
-					'--image-background' => "url('" . $this->urlGenerator->linkTo(Application::APP_ID, "img/background/$backgroundImage") . "')",
+					'--image-background' => "url('".$this->urlGenerator->linkTo(Application::APP_ID, "img/background/$backgroundImage")."')",
 					'--color-background-plain' => $this->themingDefaults->getColorPrimary(),
 					'--background-image-invert-if-bright' => BackgroundService::SHIPPED_BACKGROUNDS[$backgroundImage]['theming'] ?? null === BackgroundService::THEMING_MODE_DARK ? 'invert(100%)' : 'no',
 				];

apps/theming/lib/Themes/DefaultTheme.php

Indentation +167 added lines, -167 removed lines

@@ -36,171 +36,171 @@
 use OCP\IUserSession;
 
 class DefaultTheme implements ITheme {
-	use CommonThemeTrait;
-
-	public Util $util;
-	public ThemingDefaults $themingDefaults;
-	public IUserSession $userSession;
-	public IURLGenerator $urlGenerator;
-	public ImageManager $imageManager;
-	public IConfig $config;
-	public IL10N $l;
-	public IAppManager $appManager;
-
-	public string $defaultPrimaryColor;
-	public string $primaryColor;
-
-	public function __construct(Util $util,
-								ThemingDefaults $themingDefaults,
-								IUserSession $userSession,
-								IURLGenerator $urlGenerator,
-								ImageManager $imageManager,
-								IConfig $config,
-								IL10N $l,
-								IAppManager $appManager) {
-		$this->util = $util;
-		$this->themingDefaults = $themingDefaults;
-		$this->userSession = $userSession;
-		$this->urlGenerator = $urlGenerator;
-		$this->imageManager = $imageManager;
-		$this->config = $config;
-		$this->l = $l;
-		$this->appManager = $appManager;
-
-		$this->defaultPrimaryColor = $this->themingDefaults->getDefaultColorPrimary();
-		$this->primaryColor = $this->themingDefaults->getColorPrimary();
-
-		// Override default defaultPrimaryColor if set to improve accessibility
-		if ($this->primaryColor === BackgroundService::DEFAULT_COLOR) {
-			$this->primaryColor = BackgroundService::DEFAULT_ACCESSIBLE_COLOR;
-		}
-	}
-
-	public function getId(): string {
-		return 'default';
-	}
-
-	public function getType(): int {
-		return ITheme::TYPE_THEME;
-	}
-
-	public function getTitle(): string {
-		return $this->l->t('System default theme');
-	}
-
-	public function getEnableLabel(): string {
-		return $this->l->t('Enable the system default');
-	}
-
-	public function getDescription(): string {
-		return $this->l->t('Using the default system appearance.');
-	}
-
-	public function getMediaQuery(): string {
-		return '';
-	}
-
-	public function getCSSVariables(): array {
-		$colorMainText = '#222222';
-		$colorMainTextRgb = join(',', $this->util->hexToRGB($colorMainText));
-		$colorTextMaxcontrast = $this->util->lighten($colorMainText, 33);
-		$colorMainBackground = '#ffffff';
-		$colorMainBackgroundRGB = join(',', $this->util->hexToRGB($colorMainBackground));
-		$colorBoxShadow = $this->util->darken($colorMainBackground, 70);
-		$colorBoxShadowRGB = join(',', $this->util->hexToRGB($colorBoxShadow));
-
-		$variables = [
-			'--color-main-background' => $colorMainBackground,
-			'--color-main-background-rgb' => $colorMainBackgroundRGB,
-			'--color-main-background-translucent' => 'rgba(var(--color-main-background-rgb), .97)',
-			'--color-main-background-blur' => 'rgba(var(--color-main-background-rgb), .8)',
-			'--filter-background-blur' => 'blur(25px)',
-
-			// to use like this: background-image: linear-gradient(0, var('--gradient-main-background));
-			'--gradient-main-background' => 'var(--color-main-background) 0%, var(--color-main-background-translucent) 85%, transparent 100%',
-
-			// used for different active/hover/focus/disabled states
-			'--color-background-hover' => $this->util->darken($colorMainBackground, 4),
-			'--color-background-dark' => $this->util->darken($colorMainBackground, 7),
-			'--color-background-darker' => $this->util->darken($colorMainBackground, 14),
-
-			'--color-placeholder-light' => $this->util->darken($colorMainBackground, 10),
-			'--color-placeholder-dark' => $this->util->darken($colorMainBackground, 20),
-
-			// max contrast for WCAG compliance
-			'--color-main-text' => $colorMainText,
-			'--color-text-maxcontrast' => $colorTextMaxcontrast,
-			'--color-text-maxcontrast-default' => $colorTextMaxcontrast,
-			'--color-text-maxcontrast-background-blur' => $this->util->darken($colorTextMaxcontrast, 7),
-			'--color-text-light' => $colorMainText,
-			'--color-text-lighter' => $this->util->lighten($colorMainText, 33),
-
-			'--color-scrollbar' => 'rgba(' . $colorMainTextRgb . ', .15)',
-
-			// info/warning/success feedback colours
-			'--color-error' => '#e9322d',
-			'--color-error-rgb' => join(',', $this->util->hexToRGB('#e9322d')),
-			'--color-error-hover' => $this->util->mix('#e9322d', $colorMainBackground, 60),
-			'--color-warning' => '#eca700',
-			'--color-warning-rgb' => join(',', $this->util->hexToRGB('#eca700')),
-			'--color-warning-hover' => $this->util->mix('#eca700', $colorMainBackground, 60),
-			'--color-success' => '#46ba61',
-			'--color-success-rgb' => join(',', $this->util->hexToRGB('#46ba61')),
-			'--color-success-hover' => $this->util->mix('#46ba61', $colorMainBackground, 60),
-
-			// used for the icon loading animation
-			'--color-loading-light' => '#cccccc',
-			'--color-loading-dark' => '#444444',
-
-			'--color-box-shadow-rgb' => $colorBoxShadowRGB,
-			'--color-box-shadow' => "rgba(var(--color-box-shadow-rgb), 0.5)",
-
-			'--color-border' => $this->util->darken($colorMainBackground, 42),
-			'--color-border-dark' => $this->util->darken($colorMainBackground, 50),
-
-			'--font-face' => "-apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen-Sans, Cantarell, Ubuntu, 'Helvetica Neue', Arial, sans-serif, 'Noto Color Emoji', 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'",
-			'--default-font-size' => '15px',
-
-			// TODO: support "(prefers-reduced-motion)"
-			'--animation-quick' => '100ms',
-			'--animation-slow' => '300ms',
-
-			// Default variables --------------------------------------------
-			'--border-radius' => '3px',
-			'--border-radius-large' => '10px',
-			// pill-style button, value is large so big buttons also have correct roundness
-			'--border-radius-pill' => '100px',
-
-			'--default-clickable-area' => '44px',
-			'--default-line-height' => '24px',
-			'--default-grid-baseline' => '4px',
-
-			// various structure data
-			'--header-height' => '50px',
-			'--navigation-width' => '300px',
-			'--sidebar-min-width' => '300px',
-			'--sidebar-max-width' => '500px',
-			'--list-min-width' => '200px',
-			'--list-max-width' => '300px',
-			'--header-menu-item-height' => '44px',
-			'--header-menu-profile-item-height' => '66px',
-
-			// mobile. Keep in sync with core/js/js.js
-			'--breakpoint-mobile' => '1024px',
-			'--background-invert-if-dark' => 'no',
-			'--background-invert-if-bright' => 'invert(100%)',
-			'--background-image-invert-if-bright' => 'no',
-		];
-
-		// Primary variables
-		$variables = array_merge($variables, $this->generatePrimaryVariables($colorMainBackground, $colorMainText));
-		$variables = array_merge($variables, $this->generateGlobalBackgroundVariables());
-		$variables = array_merge($variables, $this->generateUserBackgroundVariables());
-
-		return $variables;
-	}
-
-	public function getCustomCss(): string {
-		return '';
-	}
+    use CommonThemeTrait;
+
+    public Util $util;
+    public ThemingDefaults $themingDefaults;
+    public IUserSession $userSession;
+    public IURLGenerator $urlGenerator;
+    public ImageManager $imageManager;
+    public IConfig $config;
+    public IL10N $l;
+    public IAppManager $appManager;
+
+    public string $defaultPrimaryColor;
+    public string $primaryColor;
+
+    public function __construct(Util $util,
+                                ThemingDefaults $themingDefaults,
+                                IUserSession $userSession,
+                                IURLGenerator $urlGenerator,
+                                ImageManager $imageManager,
+                                IConfig $config,
+                                IL10N $l,
+                                IAppManager $appManager) {
+        $this->util = $util;
+        $this->themingDefaults = $themingDefaults;
+        $this->userSession = $userSession;
+        $this->urlGenerator = $urlGenerator;
+        $this->imageManager = $imageManager;
+        $this->config = $config;
+        $this->l = $l;
+        $this->appManager = $appManager;
+
+        $this->defaultPrimaryColor = $this->themingDefaults->getDefaultColorPrimary();
+        $this->primaryColor = $this->themingDefaults->getColorPrimary();
+
+        // Override default defaultPrimaryColor if set to improve accessibility
+        if ($this->primaryColor === BackgroundService::DEFAULT_COLOR) {
+            $this->primaryColor = BackgroundService::DEFAULT_ACCESSIBLE_COLOR;
+        }
+    }
+
+    public function getId(): string {
+        return 'default';
+    }
+
+    public function getType(): int {
+        return ITheme::TYPE_THEME;
+    }
+
+    public function getTitle(): string {
+        return $this->l->t('System default theme');
+    }
+
+    public function getEnableLabel(): string {
+        return $this->l->t('Enable the system default');
+    }
+
+    public function getDescription(): string {
+        return $this->l->t('Using the default system appearance.');
+    }
+
+    public function getMediaQuery(): string {
+        return '';
+    }
+
+    public function getCSSVariables(): array {
+        $colorMainText = '#222222';
+        $colorMainTextRgb = join(',', $this->util->hexToRGB($colorMainText));
+        $colorTextMaxcontrast = $this->util->lighten($colorMainText, 33);
+        $colorMainBackground = '#ffffff';
+        $colorMainBackgroundRGB = join(',', $this->util->hexToRGB($colorMainBackground));
+        $colorBoxShadow = $this->util->darken($colorMainBackground, 70);
+        $colorBoxShadowRGB = join(',', $this->util->hexToRGB($colorBoxShadow));
+
+        $variables = [
+            '--color-main-background' => $colorMainBackground,
+            '--color-main-background-rgb' => $colorMainBackgroundRGB,
+            '--color-main-background-translucent' => 'rgba(var(--color-main-background-rgb), .97)',
+            '--color-main-background-blur' => 'rgba(var(--color-main-background-rgb), .8)',
+            '--filter-background-blur' => 'blur(25px)',
+
+            // to use like this: background-image: linear-gradient(0, var('--gradient-main-background));
+            '--gradient-main-background' => 'var(--color-main-background) 0%, var(--color-main-background-translucent) 85%, transparent 100%',
+
+            // used for different active/hover/focus/disabled states
+            '--color-background-hover' => $this->util->darken($colorMainBackground, 4),
+            '--color-background-dark' => $this->util->darken($colorMainBackground, 7),
+            '--color-background-darker' => $this->util->darken($colorMainBackground, 14),
+
+            '--color-placeholder-light' => $this->util->darken($colorMainBackground, 10),
+            '--color-placeholder-dark' => $this->util->darken($colorMainBackground, 20),
+
+            // max contrast for WCAG compliance
+            '--color-main-text' => $colorMainText,
+            '--color-text-maxcontrast' => $colorTextMaxcontrast,
+            '--color-text-maxcontrast-default' => $colorTextMaxcontrast,
+            '--color-text-maxcontrast-background-blur' => $this->util->darken($colorTextMaxcontrast, 7),
+            '--color-text-light' => $colorMainText,
+            '--color-text-lighter' => $this->util->lighten($colorMainText, 33),
+
+            '--color-scrollbar' => 'rgba(' . $colorMainTextRgb . ', .15)',
+
+            // info/warning/success feedback colours
+            '--color-error' => '#e9322d',
+            '--color-error-rgb' => join(',', $this->util->hexToRGB('#e9322d')),
+            '--color-error-hover' => $this->util->mix('#e9322d', $colorMainBackground, 60),
+            '--color-warning' => '#eca700',
+            '--color-warning-rgb' => join(',', $this->util->hexToRGB('#eca700')),
+            '--color-warning-hover' => $this->util->mix('#eca700', $colorMainBackground, 60),
+            '--color-success' => '#46ba61',
+            '--color-success-rgb' => join(',', $this->util->hexToRGB('#46ba61')),
+            '--color-success-hover' => $this->util->mix('#46ba61', $colorMainBackground, 60),
+
+            // used for the icon loading animation
+            '--color-loading-light' => '#cccccc',
+            '--color-loading-dark' => '#444444',
+
+            '--color-box-shadow-rgb' => $colorBoxShadowRGB,
+            '--color-box-shadow' => "rgba(var(--color-box-shadow-rgb), 0.5)",
+
+            '--color-border' => $this->util->darken($colorMainBackground, 42),
+            '--color-border-dark' => $this->util->darken($colorMainBackground, 50),
+
+            '--font-face' => "-apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen-Sans, Cantarell, Ubuntu, 'Helvetica Neue', Arial, sans-serif, 'Noto Color Emoji', 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'",
+            '--default-font-size' => '15px',
+
+            // TODO: support "(prefers-reduced-motion)"
+            '--animation-quick' => '100ms',
+            '--animation-slow' => '300ms',
+
+            // Default variables --------------------------------------------
+            '--border-radius' => '3px',
+            '--border-radius-large' => '10px',
+            // pill-style button, value is large so big buttons also have correct roundness
+            '--border-radius-pill' => '100px',
+
+            '--default-clickable-area' => '44px',
+            '--default-line-height' => '24px',
+            '--default-grid-baseline' => '4px',
+
+            // various structure data
+            '--header-height' => '50px',
+            '--navigation-width' => '300px',
+            '--sidebar-min-width' => '300px',
+            '--sidebar-max-width' => '500px',
+            '--list-min-width' => '200px',
+            '--list-max-width' => '300px',
+            '--header-menu-item-height' => '44px',
+            '--header-menu-profile-item-height' => '66px',
+
+            // mobile. Keep in sync with core/js/js.js
+            '--breakpoint-mobile' => '1024px',
+            '--background-invert-if-dark' => 'no',
+            '--background-invert-if-bright' => 'invert(100%)',
+            '--background-image-invert-if-bright' => 'no',
+        ];
+
+        // Primary variables
+        $variables = array_merge($variables, $this->generatePrimaryVariables($colorMainBackground, $colorMainText));
+        $variables = array_merge($variables, $this->generateGlobalBackgroundVariables());
+        $variables = array_merge($variables, $this->generateUserBackgroundVariables());
+
+        return $variables;
+    }
+
+    public function getCustomCss(): string {
+        return '';
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -135,7 +135,7 @@
 			'--color-text-light' => $colorMainText,
 			'--color-text-lighter' => $this->util->lighten($colorMainText, 33),
 
-			'--color-scrollbar' => 'rgba(' . $colorMainTextRgb . ', .15)',
+			'--color-scrollbar' => 'rgba('.$colorMainTextRgb.', .15)',
 
 			// info/warning/success feedback colours
 			'--color-error' => '#e9322d',

apps/theming/lib/Listener/BeforeTemplateRenderedListener.php

Indentation +79 added lines, -79 removed lines

@@ -40,83 +40,83 @@
 
 class BeforeTemplateRenderedListener implements IEventListener {
 
-	private IInitialState $initialState;
-	private ContainerInterface $container;
-	private ThemeInjectionService $themeInjectionService;
-	private IUserSession $userSession;
-	private IConfig $config;
-
-	public function __construct(
-		IInitialState $initialState,
-		ContainerInterface $container,
-		ThemeInjectionService $themeInjectionService,
-		IUserSession $userSession,
-		IConfig $config
-	) {
-		$this->initialState = $initialState;
-		$this->container = $container;
-		$this->themeInjectionService = $themeInjectionService;
-		$this->userSession = $userSession;
-		$this->config = $config;
-	}
-
-	public function handle(Event $event): void {
-		$this->initialState->provideLazyInitialState(
-			'data',
-			fn () => $this->container->get(JSDataService::class),
-		);
-
-		/** @var BeforeTemplateRenderedEvent $event */
-		if ($event->getResponse()->getRenderAs() === TemplateResponse::RENDER_AS_USER) {
-			$this->initialState->provideLazyInitialState('shortcutsDisabled', function () {
-				if ($this->userSession->getUser()) {
-					$uid = $this->userSession->getUser()->getUID();
-					return $this->config->getUserValue($uid, Application::APP_ID, 'shortcuts_disabled', 'no') === 'yes';
-				}
-				return false;
-			});
-		}
-
-		$this->themeInjectionService->injectHeaders();
-
-		$user = $this->userSession->getUser();
-
-		if (!empty($user)) {
-			$userId = $user->getUID();
-
-			/** User background */
-			$this->initialState->provideInitialState(
-				'backgroundImage',
-				$this->config->getUserValue($userId, Application::APP_ID, 'background_image', BackgroundService::BACKGROUND_DEFAULT),
-			);
-
-			/** User color */
-			$this->initialState->provideInitialState(
-				'backgroundColor',
-				$this->config->getUserValue($userId, Application::APP_ID, 'background_color', BackgroundService::DEFAULT_COLOR),
-			);
-
-			/** 
-			 * Admin background. `backgroundColor` if disabled,
-			 * mime type if defined and empty by default
-			 */
-			$this->initialState->provideInitialState(
-				'themingDefaultBackground',
-				 $this->config->getAppValue('theming', 'backgroundMime', ''),
-			);
-			$this->initialState->provideInitialState(
-				'defaultShippedBackground',
-				 BackgroundService::DEFAULT_BACKGROUND_IMAGE,
-			);
-
-			/** List of all shipped backgrounds */
-			$this->initialState->provideInitialState(
-				'shippedBackgrounds',
-				 BackgroundService::SHIPPED_BACKGROUNDS,
-			);
-		}
-
-		// Making sure to inject just after core
-		\OCP\Util::addScript('theming', 'theming', 'core');
-	}
+    private IInitialState $initialState;
+    private ContainerInterface $container;
+    private ThemeInjectionService $themeInjectionService;
+    private IUserSession $userSession;
+    private IConfig $config;
+
+    public function __construct(
+        IInitialState $initialState,
+        ContainerInterface $container,
+        ThemeInjectionService $themeInjectionService,
+        IUserSession $userSession,
+        IConfig $config
+    ) {
+        $this->initialState = $initialState;
+        $this->container = $container;
+        $this->themeInjectionService = $themeInjectionService;
+        $this->userSession = $userSession;
+        $this->config = $config;
+    }
+
+    public function handle(Event $event): void {
+        $this->initialState->provideLazyInitialState(
+            'data',
+            fn () => $this->container->get(JSDataService::class),
+        );
+
+        /** @var BeforeTemplateRenderedEvent $event */
+        if ($event->getResponse()->getRenderAs() === TemplateResponse::RENDER_AS_USER) {
+            $this->initialState->provideLazyInitialState('shortcutsDisabled', function () {
+                if ($this->userSession->getUser()) {
+                    $uid = $this->userSession->getUser()->getUID();
+                    return $this->config->getUserValue($uid, Application::APP_ID, 'shortcuts_disabled', 'no') === 'yes';
+                }
+                return false;
+            });
+        }
+
+        $this->themeInjectionService->injectHeaders();
+
+        $user = $this->userSession->getUser();
+
+        if (!empty($user)) {
+            $userId = $user->getUID();
+
+            /** User background */
+            $this->initialState->provideInitialState(
+                'backgroundImage',
+                $this->config->getUserValue($userId, Application::APP_ID, 'background_image', BackgroundService::BACKGROUND_DEFAULT),
+            );
+
+            /** User color */
+            $this->initialState->provideInitialState(
+                'backgroundColor',
+                $this->config->getUserValue($userId, Application::APP_ID, 'background_color', BackgroundService::DEFAULT_COLOR),
+            );
+
+            /** 
+             * Admin background. `backgroundColor` if disabled,
+             * mime type if defined and empty by default
+             */
+            $this->initialState->provideInitialState(
+                'themingDefaultBackground',
+                    $this->config->getAppValue('theming', 'backgroundMime', ''),
+            );
+            $this->initialState->provideInitialState(
+                'defaultShippedBackground',
+                    BackgroundService::DEFAULT_BACKGROUND_IMAGE,
+            );
+
+            /** List of all shipped backgrounds */
+            $this->initialState->provideInitialState(
+                'shippedBackgrounds',
+                    BackgroundService::SHIPPED_BACKGROUNDS,
+            );
+        }
+
+        // Making sure to inject just after core
+        \OCP\Util::addScript('theming', 'theming', 'core');
+    }
 }

apps/theming/lib/ImageManager.php

Indentation +289 added lines, -289 removed lines

@@ -47,293 +47,293 @@
 use OCP\IURLGenerator;
 
 class ImageManager {
-	public const SUPPORTED_IMAGE_KEYS = ['background', 'logo', 'logoheader', 'favicon'];
-
-	/** @var IConfig */
-	private $config;
-	/** @var IAppData */
-	private $appData;
-	/** @var IURLGenerator */
-	private $urlGenerator;
-	/** @var ICacheFactory */
-	private $cacheFactory;
-	/** @var ILogger */
-	private $logger;
-	/** @var ITempManager */
-	private $tempManager;
-
-	public function __construct(IConfig $config,
-								IAppData $appData,
-								IURLGenerator $urlGenerator,
-								ICacheFactory $cacheFactory,
-								ILogger $logger,
-								ITempManager $tempManager) {
-		$this->config = $config;
-		$this->urlGenerator = $urlGenerator;
-		$this->cacheFactory = $cacheFactory;
-		$this->logger = $logger;
-		$this->tempManager = $tempManager;
-		$this->appData = $appData;
-	}
-
-	/**
-	 * Get a globally defined image (admin theming settings)
-	 *
-	 * @param string $key the image key
-	 * @return string the image url
-	 */
-	public function getImageUrl(string $key): string {
-		$cacheBusterCounter = $this->config->getAppValue(Application::APP_ID, 'cachebuster', '0');
-		if ($this->hasImage($key)) {
-			return $this->urlGenerator->linkToRoute('theming.Theming.getImage', [ 'key' => $key ]) . '?v=' . $cacheBusterCounter;
-		}
-
-		switch ($key) {
-			case 'logo':
-			case 'logoheader':
-			case 'favicon':
-				return $this->urlGenerator->imagePath('core', 'logo/logo.png') . '?v=' . $cacheBusterCounter;
-			case 'background':
-				return $this->urlGenerator->linkTo(Application::APP_ID, 'img/background/' . BackgroundService::DEFAULT_BACKGROUND_IMAGE);
-		}
-		return '';
-	}
-
-	/**
-	 * Get the absolute url. See getImageUrl
-	 */
-	public function getImageUrlAbsolute(string $key): string {
-		return $this->urlGenerator->getAbsoluteURL($this->getImageUrl($key));
-	}
-
-	/**
-	 * @param string $key
-	 * @param bool $useSvg
-	 * @return ISimpleFile
-	 * @throws NotFoundException
-	 * @throws NotPermittedException
-	 */
-	public function getImage(string $key, bool $useSvg = true): ISimpleFile {
-		$logo = $this->config->getAppValue('theming', $key . 'Mime', '');
-		$folder = $this->getRootFolder()->getFolder('images');
-
-		if ($logo === '' || !$folder->fileExists($key)) {
-			throw new NotFoundException();
-		}
-
-		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());
-					return $pngFile;
-				} catch (\ImagickException $e) {
-					$this->logger->info('The image was requested to be no SVG file, but converting it to PNG failed: ' . $e->getMessage());
-				}
-			} else {
-				return $folder->getFile($key . '.png');
-			}
-		}
-
-		return $folder->getFile($key);
-	}
-
-	public function hasImage(string $key): bool {
-		$mimeSetting = $this->config->getAppValue('theming', $key . 'Mime', '');
-		return $mimeSetting !== '';
-	}
-
-	/**
-	 * @return array<string, array{mime: string, url: string}>
-	 */
-	public function getCustomImages(): array {
-		$images = [];
-		foreach (self::SUPPORTED_IMAGE_KEYS as $key) {
-			$images[$key] = [
-				'mime' => $this->config->getAppValue('theming', $key . 'Mime', ''),
-				'url' => $this->getImageUrl($key),
-			];
-		}
-		return $images;
-	}
-
-	/**
-	 * Get folder for current theming files
-	 *
-	 * @return ISimpleFolder
-	 * @throws NotPermittedException
-	 */
-	public function getCacheFolder(): ISimpleFolder {
-		$cacheBusterValue = $this->config->getAppValue('theming', 'cachebuster', '0');
-		try {
-			$folder = $this->getRootFolder()->getFolder($cacheBusterValue);
-		} catch (NotFoundException $e) {
-			$folder = $this->getRootFolder()->newFolder($cacheBusterValue);
-			$this->cleanup();
-		}
-		return $folder;
-	}
-
-	/**
-	 * Get a file from AppData
-	 *
-	 * @param string $filename
-	 * @throws NotFoundException
-	 * @return \OCP\Files\SimpleFS\ISimpleFile
-	 * @throws NotPermittedException
-	 */
-	public function getCachedImage(string $filename): ISimpleFile {
-		$currentFolder = $this->getCacheFolder();
-		return $currentFolder->getFile($filename);
-	}
-
-	/**
-	 * Store a file for theming in AppData
-	 *
-	 * @param string $filename
-	 * @param string $data
-	 * @return \OCP\Files\SimpleFS\ISimpleFile
-	 * @throws NotFoundException
-	 * @throws NotPermittedException
-	 */
-	public function setCachedImage(string $filename, string $data): ISimpleFile {
-		$currentFolder = $this->getCacheFolder();
-		if ($currentFolder->fileExists($filename)) {
-			$file = $currentFolder->getFile($filename);
-		} else {
-			$file = $currentFolder->newFile($filename);
-		}
-		$file->putContent($data);
-		return $file;
-	}
-
-	public function delete(string $key): void {
-		/* ignore exceptions, since we don't want to fail hard if something goes wrong during cleanup */
-		try {
-			$file = $this->getRootFolder()->getFolder('images')->getFile($key);
-			$file->delete();
-		} catch (NotFoundException $e) {
-		} catch (NotPermittedException $e) {
-		}
-		try {
-			$file = $this->getRootFolder()->getFolder('images')->getFile($key . '.png');
-			$file->delete();
-		} catch (NotFoundException $e) {
-		} catch (NotPermittedException $e) {
-		}
-	}
-
-	public function updateImage(string $key, string $tmpFile): string {
-		$this->delete($key);
-
-		try {
-			$folder = $this->getRootFolder()->getFolder('images');
-		} catch (NotFoundException $e) {
-			$folder = $this->getRootFolder()->newFolder('images');
-		}
-
-		$target = $folder->newFile($key);
-		$supportedFormats = $this->getSupportedUploadImageFormats($key);
-		$detectedMimeType = mime_content_type($tmpFile);
-		if (!in_array($detectedMimeType, $supportedFormats, true)) {
-			throw new \Exception('Unsupported image type');
-		}
-
-		if ($key === 'background' && strpos($detectedMimeType, 'image/svg') === false && strpos($detectedMimeType, 'image/gif') === false) {
-			// Optimize the image since some people may upload images that will be
-			// either to big or are not progressive rendering.
-			$newImage = @imagecreatefromstring(file_get_contents($tmpFile));
-
-			// Preserve transparency
-			imagesavealpha($newImage, true);
-			imagealphablending($newImage, true);
-
-			$tmpFile = $this->tempManager->getTemporaryFile();
-			$newWidth = (int)(imagesx($newImage) < 4096 ? imagesx($newImage) : 4096);
-			$newHeight = (int)(imagesy($newImage) / (imagesx($newImage) / $newWidth));
-			$outputImage = imagescale($newImage, $newWidth, $newHeight);
-
-			imageinterlace($outputImage, 1);
-			imagepng($outputImage, $tmpFile, 8);
-			imagedestroy($outputImage);
-
-			$target->putContent(file_get_contents($tmpFile));
-		} else {
-			$target->putContent(file_get_contents($tmpFile));
-		}
-
-		return $detectedMimeType;
-	}
-
-	/**
-	 * Returns a list of supported mime types for image uploads.
-	 * "favicon" images are only allowed to be SVG when imagemagick with SVG support is available.
-	 *
-	 * @param string $key The image key, e.g. "favicon"
-	 * @return string[]
-	 */
-	private function getSupportedUploadImageFormats(string $key): array {
-		$supportedFormats = ['image/jpeg', 'image/png', 'image/gif', 'image/webp'];
-
-		if ($key !== 'favicon' || $this->shouldReplaceIcons() === true) {
-			$supportedFormats[] = 'image/svg+xml';
-			$supportedFormats[] = 'image/svg';
-		}
-
-		if ($key === 'favicon') {
-			$supportedFormats[] = 'image/x-icon';
-			$supportedFormats[] = 'image/vnd.microsoft.icon';
-		}
-
-		return $supportedFormats;
-	}
-
-	/**
-	 * remove cached files that are not required any longer
-	 *
-	 * @throws NotPermittedException
-	 * @throws NotFoundException
-	 */
-	public function cleanup() {
-		$currentFolder = $this->getCacheFolder();
-		$folders = $this->getRootFolder()->getDirectoryListing();
-		foreach ($folders as $folder) {
-			if ($folder->getName() !== 'images' && $folder->getName() !== $currentFolder->getName()) {
-				$folder->delete();
-			}
-		}
-	}
-
-	/**
-	 * 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;
-	}
-
-	private function getRootFolder(): ISimpleFolder {
-		try {
-			return $this->appData->getFolder('global');
-		} catch (NotFoundException $e) {
-			return $this->appData->newFolder('global');
-		}
-	}
+    public const SUPPORTED_IMAGE_KEYS = ['background', 'logo', 'logoheader', 'favicon'];
+
+    /** @var IConfig */
+    private $config;
+    /** @var IAppData */
+    private $appData;
+    /** @var IURLGenerator */
+    private $urlGenerator;
+    /** @var ICacheFactory */
+    private $cacheFactory;
+    /** @var ILogger */
+    private $logger;
+    /** @var ITempManager */
+    private $tempManager;
+
+    public function __construct(IConfig $config,
+                                IAppData $appData,
+                                IURLGenerator $urlGenerator,
+                                ICacheFactory $cacheFactory,
+                                ILogger $logger,
+                                ITempManager $tempManager) {
+        $this->config = $config;
+        $this->urlGenerator = $urlGenerator;
+        $this->cacheFactory = $cacheFactory;
+        $this->logger = $logger;
+        $this->tempManager = $tempManager;
+        $this->appData = $appData;
+    }
+
+    /**
+     * Get a globally defined image (admin theming settings)
+     *
+     * @param string $key the image key
+     * @return string the image url
+     */
+    public function getImageUrl(string $key): string {
+        $cacheBusterCounter = $this->config->getAppValue(Application::APP_ID, 'cachebuster', '0');
+        if ($this->hasImage($key)) {
+            return $this->urlGenerator->linkToRoute('theming.Theming.getImage', [ 'key' => $key ]) . '?v=' . $cacheBusterCounter;
+        }
+
+        switch ($key) {
+            case 'logo':
+            case 'logoheader':
+            case 'favicon':
+                return $this->urlGenerator->imagePath('core', 'logo/logo.png') . '?v=' . $cacheBusterCounter;
+            case 'background':
+                return $this->urlGenerator->linkTo(Application::APP_ID, 'img/background/' . BackgroundService::DEFAULT_BACKGROUND_IMAGE);
+        }
+        return '';
+    }
+
+    /**
+     * Get the absolute url. See getImageUrl
+     */
+    public function getImageUrlAbsolute(string $key): string {
+        return $this->urlGenerator->getAbsoluteURL($this->getImageUrl($key));
+    }
+
+    /**
+     * @param string $key
+     * @param bool $useSvg
+     * @return ISimpleFile
+     * @throws NotFoundException
+     * @throws NotPermittedException
+     */
+    public function getImage(string $key, bool $useSvg = true): ISimpleFile {
+        $logo = $this->config->getAppValue('theming', $key . 'Mime', '');
+        $folder = $this->getRootFolder()->getFolder('images');
+
+        if ($logo === '' || !$folder->fileExists($key)) {
+            throw new NotFoundException();
+        }
+
+        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());
+                    return $pngFile;
+                } catch (\ImagickException $e) {
+                    $this->logger->info('The image was requested to be no SVG file, but converting it to PNG failed: ' . $e->getMessage());
+                }
+            } else {
+                return $folder->getFile($key . '.png');
+            }
+        }
+
+        return $folder->getFile($key);
+    }
+
+    public function hasImage(string $key): bool {
+        $mimeSetting = $this->config->getAppValue('theming', $key . 'Mime', '');
+        return $mimeSetting !== '';
+    }
+
+    /**
+     * @return array<string, array{mime: string, url: string}>
+     */
+    public function getCustomImages(): array {
+        $images = [];
+        foreach (self::SUPPORTED_IMAGE_KEYS as $key) {
+            $images[$key] = [
+                'mime' => $this->config->getAppValue('theming', $key . 'Mime', ''),
+                'url' => $this->getImageUrl($key),
+            ];
+        }
+        return $images;
+    }
+
+    /**
+     * Get folder for current theming files
+     *
+     * @return ISimpleFolder
+     * @throws NotPermittedException
+     */
+    public function getCacheFolder(): ISimpleFolder {
+        $cacheBusterValue = $this->config->getAppValue('theming', 'cachebuster', '0');
+        try {
+            $folder = $this->getRootFolder()->getFolder($cacheBusterValue);
+        } catch (NotFoundException $e) {
+            $folder = $this->getRootFolder()->newFolder($cacheBusterValue);
+            $this->cleanup();
+        }
+        return $folder;
+    }
+
+    /**
+     * Get a file from AppData
+     *
+     * @param string $filename
+     * @throws NotFoundException
+     * @return \OCP\Files\SimpleFS\ISimpleFile
+     * @throws NotPermittedException
+     */
+    public function getCachedImage(string $filename): ISimpleFile {
+        $currentFolder = $this->getCacheFolder();
+        return $currentFolder->getFile($filename);
+    }
+
+    /**
+     * Store a file for theming in AppData
+     *
+     * @param string $filename
+     * @param string $data
+     * @return \OCP\Files\SimpleFS\ISimpleFile
+     * @throws NotFoundException
+     * @throws NotPermittedException
+     */
+    public function setCachedImage(string $filename, string $data): ISimpleFile {
+        $currentFolder = $this->getCacheFolder();
+        if ($currentFolder->fileExists($filename)) {
+            $file = $currentFolder->getFile($filename);
+        } else {
+            $file = $currentFolder->newFile($filename);
+        }
+        $file->putContent($data);
+        return $file;
+    }
+
+    public function delete(string $key): void {
+        /* ignore exceptions, since we don't want to fail hard if something goes wrong during cleanup */
+        try {
+            $file = $this->getRootFolder()->getFolder('images')->getFile($key);
+            $file->delete();
+        } catch (NotFoundException $e) {
+        } catch (NotPermittedException $e) {
+        }
+        try {
+            $file = $this->getRootFolder()->getFolder('images')->getFile($key . '.png');
+            $file->delete();
+        } catch (NotFoundException $e) {
+        } catch (NotPermittedException $e) {
+        }
+    }
+
+    public function updateImage(string $key, string $tmpFile): string {
+        $this->delete($key);
+
+        try {
+            $folder = $this->getRootFolder()->getFolder('images');
+        } catch (NotFoundException $e) {
+            $folder = $this->getRootFolder()->newFolder('images');
+        }
+
+        $target = $folder->newFile($key);
+        $supportedFormats = $this->getSupportedUploadImageFormats($key);
+        $detectedMimeType = mime_content_type($tmpFile);
+        if (!in_array($detectedMimeType, $supportedFormats, true)) {
+            throw new \Exception('Unsupported image type');
+        }
+
+        if ($key === 'background' && strpos($detectedMimeType, 'image/svg') === false && strpos($detectedMimeType, 'image/gif') === false) {
+            // Optimize the image since some people may upload images that will be
+            // either to big or are not progressive rendering.
+            $newImage = @imagecreatefromstring(file_get_contents($tmpFile));
+
+            // Preserve transparency
+            imagesavealpha($newImage, true);
+            imagealphablending($newImage, true);
+
+            $tmpFile = $this->tempManager->getTemporaryFile();
+            $newWidth = (int)(imagesx($newImage) < 4096 ? imagesx($newImage) : 4096);
+            $newHeight = (int)(imagesy($newImage) / (imagesx($newImage) / $newWidth));
+            $outputImage = imagescale($newImage, $newWidth, $newHeight);
+
+            imageinterlace($outputImage, 1);
+            imagepng($outputImage, $tmpFile, 8);
+            imagedestroy($outputImage);
+
+            $target->putContent(file_get_contents($tmpFile));
+        } else {
+            $target->putContent(file_get_contents($tmpFile));
+        }
+
+        return $detectedMimeType;
+    }
+
+    /**
+     * Returns a list of supported mime types for image uploads.
+     * "favicon" images are only allowed to be SVG when imagemagick with SVG support is available.
+     *
+     * @param string $key The image key, e.g. "favicon"
+     * @return string[]
+     */
+    private function getSupportedUploadImageFormats(string $key): array {
+        $supportedFormats = ['image/jpeg', 'image/png', 'image/gif', 'image/webp'];
+
+        if ($key !== 'favicon' || $this->shouldReplaceIcons() === true) {
+            $supportedFormats[] = 'image/svg+xml';
+            $supportedFormats[] = 'image/svg';
+        }
+
+        if ($key === 'favicon') {
+            $supportedFormats[] = 'image/x-icon';
+            $supportedFormats[] = 'image/vnd.microsoft.icon';
+        }
+
+        return $supportedFormats;
+    }
+
+    /**
+     * remove cached files that are not required any longer
+     *
+     * @throws NotPermittedException
+     * @throws NotFoundException
+     */
+    public function cleanup() {
+        $currentFolder = $this->getCacheFolder();
+        $folders = $this->getRootFolder()->getDirectoryListing();
+        foreach ($folders as $folder) {
+            if ($folder->getName() !== 'images' && $folder->getName() !== $currentFolder->getName()) {
+                $folder->delete();
+            }
+        }
+    }
+
+    /**
+     * 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;
+    }
+
+    private function getRootFolder(): ISimpleFolder {
+        try {
+            return $this->appData->getFolder('global');
+        } catch (NotFoundException $e) {
+            return $this->appData->newFolder('global');
+        }
+    }
 }

Spacing +15 added lines, -15 removed lines

@@ -85,16 +85,16 @@ 
 	public function getImageUrl(string $key): string {
 		$cacheBusterCounter = $this->config->getAppValue(Application::APP_ID, 'cachebuster', '0');
 		if ($this->hasImage($key)) {
-			return $this->urlGenerator->linkToRoute('theming.Theming.getImage', [ 'key' => $key ]) . '?v=' . $cacheBusterCounter;
+			return $this->urlGenerator->linkToRoute('theming.Theming.getImage', ['key' => $key]).'?v='.$cacheBusterCounter;
 		}
 
 		switch ($key) {
 			case 'logo':
 			case 'logoheader':
 			case 'favicon':
-				return $this->urlGenerator->imagePath('core', 'logo/logo.png') . '?v=' . $cacheBusterCounter;
+				return $this->urlGenerator->imagePath('core', 'logo/logo.png').'?v='.$cacheBusterCounter;
 			case 'background':
-				return $this->urlGenerator->linkTo(Application::APP_ID, 'img/background/' . BackgroundService::DEFAULT_BACKGROUND_IMAGE);
+				return $this->urlGenerator->linkTo(Application::APP_ID, 'img/background/'.BackgroundService::DEFAULT_BACKGROUND_IMAGE);
 		}
 		return '';
 	}
@@ -114,7 +114,7 @@ 
 	 * @throws NotPermittedException
 	 */
 	public function getImage(string $key, bool $useSvg = true): ISimpleFile {
-		$logo = $this->config->getAppValue('theming', $key . 'Mime', '');
+		$logo = $this->config->getAppValue('theming', $key.'Mime', '');
 		$folder = $this->getRootFolder()->getFolder('images');
 
 		if ($logo === '' || !$folder->fileExists($key)) {
@@ -122,20 +122,20 @@ 
 		}
 
 		if (!$useSvg && $this->shouldReplaceIcons()) {
-			if (!$folder->fileExists($key . '.png')) {
+			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 = $folder->newFile($key.'.png');
 					$pngFile->putContent($finalIconFile->getImageBlob());
 					return $pngFile;
 				} catch (\ImagickException $e) {
-					$this->logger->info('The image was requested to be no SVG file, but converting it to PNG failed: ' . $e->getMessage());
+					$this->logger->info('The image was requested to be no SVG file, but converting it to PNG failed: '.$e->getMessage());
 				}
 			} else {
-				return $folder->getFile($key . '.png');
+				return $folder->getFile($key.'.png');
 			}
 		}
 
@@ -143,7 +143,7 @@ 
 	}
 
 	public function hasImage(string $key): bool {
-		$mimeSetting = $this->config->getAppValue('theming', $key . 'Mime', '');
+		$mimeSetting = $this->config->getAppValue('theming', $key.'Mime', '');
 		return $mimeSetting !== '';
 	}
 
@@ -154,7 +154,7 @@ 
 		$images = [];
 		foreach (self::SUPPORTED_IMAGE_KEYS as $key) {
 			$images[$key] = [
-				'mime' => $this->config->getAppValue('theming', $key . 'Mime', ''),
+				'mime' => $this->config->getAppValue('theming', $key.'Mime', ''),
 				'url' => $this->getImageUrl($key),
 			];
 		}
@@ -220,7 +220,7 @@ 
 		} catch (NotPermittedException $e) {
 		}
 		try {
-			$file = $this->getRootFolder()->getFolder('images')->getFile($key . '.png');
+			$file = $this->getRootFolder()->getFolder('images')->getFile($key.'.png');
 			$file->delete();
 		} catch (NotFoundException $e) {
 		} catch (NotPermittedException $e) {
@@ -253,8 +253,8 @@ 
 			imagealphablending($newImage, true);
 
 			$tmpFile = $this->tempManager->getTemporaryFile();
-			$newWidth = (int)(imagesx($newImage) < 4096 ? imagesx($newImage) : 4096);
-			$newHeight = (int)(imagesy($newImage) / (imagesx($newImage) / $newWidth));
+			$newWidth = (int) (imagesx($newImage) < 4096 ? imagesx($newImage) : 4096);
+			$newHeight = (int) (imagesy($newImage) / (imagesx($newImage) / $newWidth));
 			$outputImage = imagescale($newImage, $newWidth, $newHeight);
 
 			imageinterlace($outputImage, 1);
@@ -315,9 +315,9 @@ 
 	 * @return bool
 	 */
 	public function shouldReplaceIcons() {
-		$cache = $this->cacheFactory->createDistributed('theming-' . $this->urlGenerator->getBaseUrl());
+		$cache = $this->cacheFactory->createDistributed('theming-'.$this->urlGenerator->getBaseUrl());
 		if ($value = $cache->get('shouldReplaceIcons')) {
-			return (bool)$value;
+			return (bool) $value;
 		}
 		$value = false;
 		if (extension_loaded('imagick')) {

apps/theming/lib/ThemingDefaults.php

Indentation +439 added lines, -439 removed lines

@@ -55,443 +55,443 @@
 
 class ThemingDefaults extends \OC_Defaults {
 
-	private IConfig $config;
-	private IL10N $l;
-	private ImageManager $imageManager;
-	private IUserSession $userSession;
-	private IURLGenerator $urlGenerator;
-	private ICacheFactory $cacheFactory;
-	private Util $util;
-	private IAppManager $appManager;
-	private INavigationManager $navigationManager;
-
-	private string $name;
-	private string $title;
-	private string $entity;
-	private string $productName;
-	private string $url;
-	private string $color;
-
-	private string $iTunesAppId;
-	private string $iOSClientUrl;
-	private string $AndroidClientUrl;
-	private string $FDroidClientUrl;
-
-	/**
-	 * ThemingDefaults constructor.
-	 *
-	 * @param IConfig $config
-	 * @param IL10N $l
-	 * @param ImageManager $imageManager
-	 * @param IUserSession $userSession
-	 * @param IURLGenerator $urlGenerator
-	 * @param ICacheFactory $cacheFactory
-	 * @param Util $util
-	 * @param IAppManager $appManager
-	 */
-	public function __construct(IConfig $config,
-								IL10N $l,
-								IUserSession $userSession,
-								IURLGenerator $urlGenerator,
-								ICacheFactory $cacheFactory,
-								Util $util,
-								ImageManager $imageManager,
-								IAppManager $appManager,
-								INavigationManager $navigationManager
-	) {
-		parent::__construct();
-		$this->config = $config;
-		$this->l = $l;
-		$this->imageManager = $imageManager;
-		$this->userSession = $userSession;
-		$this->urlGenerator = $urlGenerator;
-		$this->cacheFactory = $cacheFactory;
-		$this->util = $util;
-		$this->appManager = $appManager;
-		$this->navigationManager = $navigationManager;
-
-		$this->name = parent::getName();
-		$this->title = parent::getTitle();
-		$this->entity = parent::getEntity();
-		$this->productName = parent::getProductName();
-		$this->url = parent::getBaseUrl();
-		$this->color = parent::getColorPrimary();
-		$this->iTunesAppId = parent::getiTunesAppId();
-		$this->iOSClientUrl = parent::getiOSClientUrl();
-		$this->AndroidClientUrl = parent::getAndroidClientUrl();
-		$this->FDroidClientUrl = parent::getFDroidClientUrl();
-	}
-
-	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);
-	}
-
-	/**
-	 * We pass a string and sanitizeHTML will return a string too in that case
-	 * @psalm-suppress InvalidReturnStatement
-	 * @psalm-suppress InvalidReturnType
-	 */
-	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 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()
-			],
-		];
-
-		$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/>' . $legalLinks;
-		}
-
-		return $footer;
-	}
-
-	/**
-	 * Color that is used for the header as well as for mail headers
-	 */
-	public function getColorPrimary(): string {
-		$user = $this->userSession->getUser();
-
-		// admin-defined primary color
-		$defaultColor = $this->getDefaultColorPrimary();
-
-		if ($this->isUserThemingDisabled()) {
-			return $defaultColor;
-		}
-
-		// user-defined primary color
-		if (!empty($user)) {
-			$themingBackgroundColor = $this->config->getUserValue($user->getUID(), Application::APP_ID, 'background_color', '');
-			// If the user selected a specific colour
-			if (preg_match('/^\#([0-9a-f]{3}|[0-9a-f]{6})$/i', $themingBackgroundColor)) {
-				return $themingBackgroundColor;
-			}
-		}
-
-		// If the default color is not valid, return the default background one
-		if (!preg_match('/^\#([0-9a-f]{3}|[0-9a-f]{6})$/i', $defaultColor)) {
-			return BackgroundService::DEFAULT_COLOR;
-		}
-
-		// Finally, return the system global primary color
-		return $defaultColor;
-	}
-
-	/**
-	 * Return the default color primary
-	 */
-	public function getDefaultColorPrimary(): string {
-		$color = $this->config->getAppValue(Application::APP_ID, 'color', '');
-		if (!preg_match('/^\#([0-9a-f]{3}|[0-9a-f]{6})$/i', $color)) {
-			$color = '#0082c9';
-		}
-		return $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', '');
-
-		// short cut to avoid setting up the filesystem just to check if the logo is there
-		//
-		// explanation: if an SVG is requested and the app config value for logoMime is set then the logo is there.
-		// otherwise we need to check it and maybe also generate a PNG from the SVG (that's done in getImage() which
-		// needs to be called then)
-		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 ]);
-	}
-
-	/**
-	 * 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 string
-	 */
-	public function getFDroidClientUrl() {
-		return $this->config->getAppValue('theming', 'FDroidClientUrl', $this->FDroidClientUrl);
-	}
-
-	/**
-	 * @return array scss variables to overwrite
-	 */
-	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->config->getAppValue('theming', '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;
-	}
-
-	/**
-	 * 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 === '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 (strpos($image, 'filetypes/') === 0 && 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;
-		}
-	}
-
-	/**
-	 * Increases the cache buster key
-	 */
-	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();
-	}
-
-	/**
-	 * 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();
-
-		$returnValue = '';
-		switch ($setting) {
-			case 'name':
-				$returnValue = $this->getEntity();
-				break;
-			case 'url':
-				$returnValue = $this->getBaseUrl();
-				break;
-			case 'slogan':
-				$returnValue = $this->getSlogan();
-				break;
-			case 'color':
-				$returnValue = $this->getDefaultColorPrimary();
-				break;
-			case 'logo':
-			case 'logoheader':
-			case 'background':
-			case 'favicon':
-				$this->imageManager->delete($setting);
-				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';
-	}
-
-	/**
-	 * Has the admin disabled user customization
-	 */
-	public function isUserThemingDisabled(): bool {
-		return $this->config->getAppValue('theming', 'disable-user-theming', 'no') === 'yes';
-	}
+    private IConfig $config;
+    private IL10N $l;
+    private ImageManager $imageManager;
+    private IUserSession $userSession;
+    private IURLGenerator $urlGenerator;
+    private ICacheFactory $cacheFactory;
+    private Util $util;
+    private IAppManager $appManager;
+    private INavigationManager $navigationManager;
+
+    private string $name;
+    private string $title;
+    private string $entity;
+    private string $productName;
+    private string $url;
+    private string $color;
+
+    private string $iTunesAppId;
+    private string $iOSClientUrl;
+    private string $AndroidClientUrl;
+    private string $FDroidClientUrl;
+
+    /**
+     * ThemingDefaults constructor.
+     *
+     * @param IConfig $config
+     * @param IL10N $l
+     * @param ImageManager $imageManager
+     * @param IUserSession $userSession
+     * @param IURLGenerator $urlGenerator
+     * @param ICacheFactory $cacheFactory
+     * @param Util $util
+     * @param IAppManager $appManager
+     */
+    public function __construct(IConfig $config,
+                                IL10N $l,
+                                IUserSession $userSession,
+                                IURLGenerator $urlGenerator,
+                                ICacheFactory $cacheFactory,
+                                Util $util,
+                                ImageManager $imageManager,
+                                IAppManager $appManager,
+                                INavigationManager $navigationManager
+    ) {
+        parent::__construct();
+        $this->config = $config;
+        $this->l = $l;
+        $this->imageManager = $imageManager;
+        $this->userSession = $userSession;
+        $this->urlGenerator = $urlGenerator;
+        $this->cacheFactory = $cacheFactory;
+        $this->util = $util;
+        $this->appManager = $appManager;
+        $this->navigationManager = $navigationManager;
+
+        $this->name = parent::getName();
+        $this->title = parent::getTitle();
+        $this->entity = parent::getEntity();
+        $this->productName = parent::getProductName();
+        $this->url = parent::getBaseUrl();
+        $this->color = parent::getColorPrimary();
+        $this->iTunesAppId = parent::getiTunesAppId();
+        $this->iOSClientUrl = parent::getiOSClientUrl();
+        $this->AndroidClientUrl = parent::getAndroidClientUrl();
+        $this->FDroidClientUrl = parent::getFDroidClientUrl();
+    }
+
+    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);
+    }
+
+    /**
+     * We pass a string and sanitizeHTML will return a string too in that case
+     * @psalm-suppress InvalidReturnStatement
+     * @psalm-suppress InvalidReturnType
+     */
+    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 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()
+            ],
+        ];
+
+        $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/>' . $legalLinks;
+        }
+
+        return $footer;
+    }
+
+    /**
+     * Color that is used for the header as well as for mail headers
+     */
+    public function getColorPrimary(): string {
+        $user = $this->userSession->getUser();
+
+        // admin-defined primary color
+        $defaultColor = $this->getDefaultColorPrimary();
+
+        if ($this->isUserThemingDisabled()) {
+            return $defaultColor;
+        }
+
+        // user-defined primary color
+        if (!empty($user)) {
+            $themingBackgroundColor = $this->config->getUserValue($user->getUID(), Application::APP_ID, 'background_color', '');
+            // If the user selected a specific colour
+            if (preg_match('/^\#([0-9a-f]{3}|[0-9a-f]{6})$/i', $themingBackgroundColor)) {
+                return $themingBackgroundColor;
+            }
+        }
+
+        // If the default color is not valid, return the default background one
+        if (!preg_match('/^\#([0-9a-f]{3}|[0-9a-f]{6})$/i', $defaultColor)) {
+            return BackgroundService::DEFAULT_COLOR;
+        }
+
+        // Finally, return the system global primary color
+        return $defaultColor;
+    }
+
+    /**
+     * Return the default color primary
+     */
+    public function getDefaultColorPrimary(): string {
+        $color = $this->config->getAppValue(Application::APP_ID, 'color', '');
+        if (!preg_match('/^\#([0-9a-f]{3}|[0-9a-f]{6})$/i', $color)) {
+            $color = '#0082c9';
+        }
+        return $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', '');
+
+        // short cut to avoid setting up the filesystem just to check if the logo is there
+        //
+        // explanation: if an SVG is requested and the app config value for logoMime is set then the logo is there.
+        // otherwise we need to check it and maybe also generate a PNG from the SVG (that's done in getImage() which
+        // needs to be called then)
+        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 ]);
+    }
+
+    /**
+     * 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 string
+     */
+    public function getFDroidClientUrl() {
+        return $this->config->getAppValue('theming', 'FDroidClientUrl', $this->FDroidClientUrl);
+    }
+
+    /**
+     * @return array scss variables to overwrite
+     */
+    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->config->getAppValue('theming', '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;
+    }
+
+    /**
+     * 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 === '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 (strpos($image, 'filetypes/') === 0 && 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;
+        }
+    }
+
+    /**
+     * Increases the cache buster key
+     */
+    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();
+    }
+
+    /**
+     * 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();
+
+        $returnValue = '';
+        switch ($setting) {
+            case 'name':
+                $returnValue = $this->getEntity();
+                break;
+            case 'url':
+                $returnValue = $this->getBaseUrl();
+                break;
+            case 'slogan':
+                $returnValue = $this->getSlogan();
+                break;
+            case 'color':
+                $returnValue = $this->getDefaultColorPrimary();
+                break;
+            case 'logo':
+            case 'logoheader':
+            case 'background':
+            case 'favicon':
+                $this->imageManager->delete($setting);
+                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';
+    }
+
+    /**
+     * Has the admin disabled user customization
+     */
+    public function isUserThemingDisabled(): bool {
+        return $this->config->getAppValue('theming', 'disable-user-theming', 'no') === 'yes';
+    }
 }

apps/theming/lib/Controller/UserThemeController.php

Indentation +158 added lines, -158 removed lines

@@ -50,162 +50,162 @@
 
 class UserThemeController extends OCSController {
 
-	protected string $userId;
-	private IConfig $config;
-	private IUserSession $userSession;
-	private ThemesService $themesService;
-	private ThemingDefaults $themingDefaults;
-	private BackgroundService $backgroundService;
-
-	/**
-	 * Config constructor.
-	 */
-	public function __construct(string $appName,
-								IRequest $request,
-								IConfig $config,
-								IUserSession $userSession,
-								ThemesService $themesService,
-								ThemingDefaults $themingDefaults,
-								BackgroundService $backgroundService) {
-		parent::__construct($appName, $request);
-		$this->config = $config;
-		$this->userSession = $userSession;
-		$this->themesService = $themesService;
-		$this->themingDefaults = $themingDefaults;
-		$this->backgroundService = $backgroundService;
-		$this->userId = $userSession->getUser()->getUID();
-	}
-
-	/**
-	 * @NoAdminRequired
-	 *
-	 * Enable theme
-	 *
-	 * @param string $themeId the theme ID
-	 * @return DataResponse
-	 * @throws OCSBadRequestException|PreConditionNotMetException
-	 */
-	public function enableTheme(string $themeId): DataResponse {
-		$theme = $this->validateTheme($themeId);
-
-		// Enable selected theme
-		$this->themesService->enableTheme($theme);
-		return new DataResponse();
-	}
-
-	/**
-	 * @NoAdminRequired
-	 *
-	 * Disable theme
-	 *
-	 * @param string $themeId the theme ID
-	 * @return DataResponse
-	 * @throws OCSBadRequestException|PreConditionNotMetException
-	 */
-	public function disableTheme(string $themeId): DataResponse {
-		$theme = $this->validateTheme($themeId);
-
-		// Enable selected theme
-		$this->themesService->disableTheme($theme);
-		return new DataResponse();
-	}
-
-	/**
-	 * Validate and return the matching ITheme
-	 *
-	 * Disable theme
-	 *
-	 * @param string $themeId the theme ID
-	 * @return ITheme
-	 * @throws OCSBadRequestException|PreConditionNotMetException
-	 */
-	private function validateTheme(string $themeId): ITheme {
-		if ($themeId === '' || !$themeId) {
-			throw new OCSBadRequestException('Invalid theme id: ' . $themeId);
-		}
-
-		$themes = $this->themesService->getThemes();
-		if (!isset($themes[$themeId])) {
-			throw new OCSBadRequestException('Invalid theme id: ' . $themeId);
-		}
-
-		// If trying to toggle another theme but this is enforced
-		if ($this->config->getSystemValueString('enforce_theme', '') !== ''
-			&& $themes[$themeId]->getType() === ITheme::TYPE_THEME) {
-			throw new OCSForbiddenException('Theme switching is disabled');
-		}
-
-		return $themes[$themeId];
-	}
-
-	/**
-	 * @NoAdminRequired
-	 * @NoCSRFRequired
-	 */
-	public function getBackground(): Http\Response {
-		$file = $this->backgroundService->getBackground();
-		if ($file !== null) {
-			$response = new FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => $file->getMimeType()]);
-			$response->cacheFor(24 * 60 * 60, false, true);
-			return $response;
-		}
-		return new NotFoundResponse();
-	}
-
-	/**
-	 * @NoAdminRequired
-	 */
-	public function deleteBackground(): JSONResponse {
-		$currentVersion = (int)$this->config->getUserValue($this->userId, Application::APP_ID, 'userCacheBuster', '0');
-		$this->backgroundService->deleteBackgroundImage();
-		return new JSONResponse([
-			'backgroundImage' => null,
-			'backgroundColor' => $this->themingDefaults->getColorPrimary(),
-			'version' => $currentVersion,
-		]);
-	}
-
-	/**
-	 * @NoAdminRequired
-	 */
-	public function setBackground(string $type = BackgroundService::BACKGROUND_DEFAULT, string $value = '', string $color = null): JSONResponse {
-		$currentVersion = (int)$this->config->getUserValue($this->userId, Application::APP_ID, 'userCacheBuster', '0');
-
-		// Set color if provided
-		if ($color) {
-			$this->backgroundService->setColorBackground($color);
-		}
-
-		// Set background image if provided
-		try {
-			switch ($type) {
-				case BackgroundService::BACKGROUND_SHIPPED:
-					$this->backgroundService->setShippedBackground($value);
-					break;
-				case BackgroundService::BACKGROUND_CUSTOM:
-					$this->backgroundService->setFileBackground($value);
-					break;
-				case BackgroundService::BACKGROUND_DEFAULT:
-					$this->backgroundService->setDefaultBackground();
-					break;
-				default:
-					if (!$color) {
-						return new JSONResponse(['error' => 'Invalid type provided'], Http::STATUS_BAD_REQUEST);
-					}
-			}
-		} catch (\InvalidArgumentException $e) {
-			return new JSONResponse(['error' => $e->getMessage()], Http::STATUS_BAD_REQUEST);
-		} catch (\Throwable $e) {
-			return new JSONResponse(['error' => $e->getMessage()], Http::STATUS_INTERNAL_SERVER_ERROR);
-		}
-
-		$currentVersion++;
-		$this->config->setUserValue($this->userId, Application::APP_ID, 'userCacheBuster', (string)$currentVersion);
-
-		return new JSONResponse([
-			'backgroundImage' => $this->config->getUserValue($this->userId, Application::APP_ID, 'background_image', BackgroundService::BACKGROUND_DEFAULT),
-			'backgroundColor' => $this->themingDefaults->getColorPrimary(),
-			'version' => $currentVersion,
-		]);
-	}
+    protected string $userId;
+    private IConfig $config;
+    private IUserSession $userSession;
+    private ThemesService $themesService;
+    private ThemingDefaults $themingDefaults;
+    private BackgroundService $backgroundService;
+
+    /**
+     * Config constructor.
+     */
+    public function __construct(string $appName,
+                                IRequest $request,
+                                IConfig $config,
+                                IUserSession $userSession,
+                                ThemesService $themesService,
+                                ThemingDefaults $themingDefaults,
+                                BackgroundService $backgroundService) {
+        parent::__construct($appName, $request);
+        $this->config = $config;
+        $this->userSession = $userSession;
+        $this->themesService = $themesService;
+        $this->themingDefaults = $themingDefaults;
+        $this->backgroundService = $backgroundService;
+        $this->userId = $userSession->getUser()->getUID();
+    }
+
+    /**
+     * @NoAdminRequired
+     *
+     * Enable theme
+     *
+     * @param string $themeId the theme ID
+     * @return DataResponse
+     * @throws OCSBadRequestException|PreConditionNotMetException
+     */
+    public function enableTheme(string $themeId): DataResponse {
+        $theme = $this->validateTheme($themeId);
+
+        // Enable selected theme
+        $this->themesService->enableTheme($theme);
+        return new DataResponse();
+    }
+
+    /**
+     * @NoAdminRequired
+     *
+     * Disable theme
+     *
+     * @param string $themeId the theme ID
+     * @return DataResponse
+     * @throws OCSBadRequestException|PreConditionNotMetException
+     */
+    public function disableTheme(string $themeId): DataResponse {
+        $theme = $this->validateTheme($themeId);
+
+        // Enable selected theme
+        $this->themesService->disableTheme($theme);
+        return new DataResponse();
+    }
+
+    /**
+     * Validate and return the matching ITheme
+     *
+     * Disable theme
+     *
+     * @param string $themeId the theme ID
+     * @return ITheme
+     * @throws OCSBadRequestException|PreConditionNotMetException
+     */
+    private function validateTheme(string $themeId): ITheme {
+        if ($themeId === '' || !$themeId) {
+            throw new OCSBadRequestException('Invalid theme id: ' . $themeId);
+        }
+
+        $themes = $this->themesService->getThemes();
+        if (!isset($themes[$themeId])) {
+            throw new OCSBadRequestException('Invalid theme id: ' . $themeId);
+        }
+
+        // If trying to toggle another theme but this is enforced
+        if ($this->config->getSystemValueString('enforce_theme', '') !== ''
+            && $themes[$themeId]->getType() === ITheme::TYPE_THEME) {
+            throw new OCSForbiddenException('Theme switching is disabled');
+        }
+
+        return $themes[$themeId];
+    }
+
+    /**
+     * @NoAdminRequired
+     * @NoCSRFRequired
+     */
+    public function getBackground(): Http\Response {
+        $file = $this->backgroundService->getBackground();
+        if ($file !== null) {
+            $response = new FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => $file->getMimeType()]);
+            $response->cacheFor(24 * 60 * 60, false, true);
+            return $response;
+        }
+        return new NotFoundResponse();
+    }
+
+    /**
+     * @NoAdminRequired
+     */
+    public function deleteBackground(): JSONResponse {
+        $currentVersion = (int)$this->config->getUserValue($this->userId, Application::APP_ID, 'userCacheBuster', '0');
+        $this->backgroundService->deleteBackgroundImage();
+        return new JSONResponse([
+            'backgroundImage' => null,
+            'backgroundColor' => $this->themingDefaults->getColorPrimary(),
+            'version' => $currentVersion,
+        ]);
+    }
+
+    /**
+     * @NoAdminRequired
+     */
+    public function setBackground(string $type = BackgroundService::BACKGROUND_DEFAULT, string $value = '', string $color = null): JSONResponse {
+        $currentVersion = (int)$this->config->getUserValue($this->userId, Application::APP_ID, 'userCacheBuster', '0');
+
+        // Set color if provided
+        if ($color) {
+            $this->backgroundService->setColorBackground($color);
+        }
+
+        // Set background image if provided
+        try {
+            switch ($type) {
+                case BackgroundService::BACKGROUND_SHIPPED:
+                    $this->backgroundService->setShippedBackground($value);
+                    break;
+                case BackgroundService::BACKGROUND_CUSTOM:
+                    $this->backgroundService->setFileBackground($value);
+                    break;
+                case BackgroundService::BACKGROUND_DEFAULT:
+                    $this->backgroundService->setDefaultBackground();
+                    break;
+                default:
+                    if (!$color) {
+                        return new JSONResponse(['error' => 'Invalid type provided'], Http::STATUS_BAD_REQUEST);
+                    }
+            }
+        } catch (\InvalidArgumentException $e) {
+            return new JSONResponse(['error' => $e->getMessage()], Http::STATUS_BAD_REQUEST);
+        } catch (\Throwable $e) {
+            return new JSONResponse(['error' => $e->getMessage()], Http::STATUS_INTERNAL_SERVER_ERROR);
+        }
+
+        $currentVersion++;
+        $this->config->setUserValue($this->userId, Application::APP_ID, 'userCacheBuster', (string)$currentVersion);
+
+        return new JSONResponse([
+            'backgroundImage' => $this->config->getUserValue($this->userId, Application::APP_ID, 'background_image', BackgroundService::BACKGROUND_DEFAULT),
+            'backgroundColor' => $this->themingDefaults->getColorPrimary(),
+            'version' => $currentVersion,
+        ]);
+    }
 }

Spacing +5 added lines, -5 removed lines

@@ -121,12 +121,12 @@ 
 	 */
 	private function validateTheme(string $themeId): ITheme {
 		if ($themeId === '' || !$themeId) {
-			throw new OCSBadRequestException('Invalid theme id: ' . $themeId);
+			throw new OCSBadRequestException('Invalid theme id: '.$themeId);
 		}
 
 		$themes = $this->themesService->getThemes();
 		if (!isset($themes[$themeId])) {
-			throw new OCSBadRequestException('Invalid theme id: ' . $themeId);
+			throw new OCSBadRequestException('Invalid theme id: '.$themeId);
 		}
 
 		// If trying to toggle another theme but this is enforced
@@ -156,7 +156,7 @@ 
 	 * @NoAdminRequired
 	 */
 	public function deleteBackground(): JSONResponse {
-		$currentVersion = (int)$this->config->getUserValue($this->userId, Application::APP_ID, 'userCacheBuster', '0');
+		$currentVersion = (int) $this->config->getUserValue($this->userId, Application::APP_ID, 'userCacheBuster', '0');
 		$this->backgroundService->deleteBackgroundImage();
 		return new JSONResponse([
 			'backgroundImage' => null,
@@ -169,7 +169,7 @@ 
 	 * @NoAdminRequired
 	 */
 	public function setBackground(string $type = BackgroundService::BACKGROUND_DEFAULT, string $value = '', string $color = null): JSONResponse {
-		$currentVersion = (int)$this->config->getUserValue($this->userId, Application::APP_ID, 'userCacheBuster', '0');
+		$currentVersion = (int) $this->config->getUserValue($this->userId, Application::APP_ID, 'userCacheBuster', '0');
 
 		// Set color if provided
 		if ($color) {
@@ -200,7 +200,7 @@ 
 		}
 
 		$currentVersion++;
-		$this->config->setUserValue($this->userId, Application::APP_ID, 'userCacheBuster', (string)$currentVersion);
+		$this->config->setUserValue($this->userId, Application::APP_ID, 'userCacheBuster', (string) $currentVersion);
 
 		return new JSONResponse([
 			'backgroundImage' => $this->config->getUserValue($this->userId, Application::APP_ID, 'background_image', BackgroundService::BACKGROUND_DEFAULT),

apps/theming/appinfo/routes.php

Indentation +78 added lines, -78 removed lines

@@ -28,82 +28,82 @@
  *
  */
 return [
-	'routes' => [
-		[
-			'name' => 'Theming#updateStylesheet',
-			'url' => '/ajax/updateStylesheet',
-			'verb' => 'POST'
-		],
-		[
-			'name' => 'Theming#undo',
-			'url' => '/ajax/undoChanges',
-			'verb' => 'POST'
-		],
-		[
-			'name' => 'Theming#uploadImage',
-			'url' => '/ajax/uploadImage',
-			'verb' => 'POST'
-		],
-		[
-			'name' => 'Theming#getThemeStylesheet',
-			'url' => '/theme/{themeId}.css',
-			'verb' => 'GET',
-		],
-		[
-			'name' => 'Theming#getImage',
-			'url' => '/image/{key}',
-			'verb' => 'GET',
-		],
-		[
-			'name' => 'Theming#getManifest',
-			'url' => '/manifest/{app}',
-			'verb' => 'GET',
-			'defaults' => ['app' => 'core']
-		],
-		[
-			'name' => 'Icon#getFavicon',
-			'url' => '/favicon/{app}',
-			'verb' => 'GET',
-			'defaults' => ['app' => 'core'],
-		],
-		[
-			'name' => 'Icon#getTouchIcon',
-			'url' => '/icon/{app}',
-			'verb' => 'GET',
-			'defaults' => ['app' => 'core'],
-		],
-		[
-			'name' => 'Icon#getThemedIcon',
-			'url' => '/img/{app}/{image}',
-			'verb' => 'GET',
-			'requirements' => ['image' => '.+']
-		],
-		[
-			'name' => 'userTheme#getBackground',
-			'url' => '/background',
-			'verb' => 'GET',
-		],
-		[
-			'name' => 'userTheme#setBackground',
-			'url' => '/background/{type}',
-			'verb' => 'POST',
-		],
-		[
-			'name' => 'userTheme#deleteBackground',
-			'url' => '/background/custom',
-			'verb' => 'DELETE',
-		],
-	],
-	'ocs' => [
-		[
-			'name' => 'userTheme#enableTheme',
-			'url' => '/api/v1/theme/{themeId}/enable',
-			'verb' => 'PUT',
-		],
-		[
-			'name' => 'userTheme#disableTheme',
-			'url' => '/api/v1/theme/{themeId}',
-			'verb' => 'DELETE',
-		],
-	]
+    'routes' => [
+        [
+            'name' => 'Theming#updateStylesheet',
+            'url' => '/ajax/updateStylesheet',
+            'verb' => 'POST'
+        ],
+        [
+            'name' => 'Theming#undo',
+            'url' => '/ajax/undoChanges',
+            'verb' => 'POST'
+        ],
+        [
+            'name' => 'Theming#uploadImage',
+            'url' => '/ajax/uploadImage',
+            'verb' => 'POST'
+        ],
+        [
+            'name' => 'Theming#getThemeStylesheet',
+            'url' => '/theme/{themeId}.css',
+            'verb' => 'GET',
+        ],
+        [
+            'name' => 'Theming#getImage',
+            'url' => '/image/{key}',
+            'verb' => 'GET',
+        ],
+        [
+            'name' => 'Theming#getManifest',
+            'url' => '/manifest/{app}',
+            'verb' => 'GET',
+            'defaults' => ['app' => 'core']
+        ],
+        [
+            'name' => 'Icon#getFavicon',
+            'url' => '/favicon/{app}',
+            'verb' => 'GET',
+            'defaults' => ['app' => 'core'],
+        ],
+        [
+            'name' => 'Icon#getTouchIcon',
+            'url' => '/icon/{app}',
+            'verb' => 'GET',
+            'defaults' => ['app' => 'core'],
+        ],
+        [
+            'name' => 'Icon#getThemedIcon',
+            'url' => '/img/{app}/{image}',
+            'verb' => 'GET',
+            'requirements' => ['image' => '.+']
+        ],
+        [
+            'name' => 'userTheme#getBackground',
+            'url' => '/background',
+            'verb' => 'GET',
+        ],
+        [
+            'name' => 'userTheme#setBackground',
+            'url' => '/background/{type}',
+            'verb' => 'POST',
+        ],
+        [
+            'name' => 'userTheme#deleteBackground',
+            'url' => '/background/custom',
+            'verb' => 'DELETE',
+        ],
+    ],
+    'ocs' => [
+        [
+            'name' => 'userTheme#enableTheme',
+            'url' => '/api/v1/theme/{themeId}/enable',
+            'verb' => 'PUT',
+        ],
+        [
+            'name' => 'userTheme#disableTheme',
+            'url' => '/api/v1/theme/{themeId}',
+            'verb' => 'DELETE',
+        ],
+    ]
 ];