Skip to content

refactor(theming): Reduce duplicated code in BackgroundService #48440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
susnux merged 1 commit into from
Oct 3, 2024
Merged

refactor(theming): Reduce duplicated code in BackgroundService #48440

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 28 additions & 34 deletions apps/theming/lib/Service/BackgroundService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,10 +206,7 @@ public function __construct(
}

public function setDefaultBackground(?string $userId = null): void {
$userId = $userId ?? $this->userId;
if ($userId === null) {
throw new RuntimeException('No currently logged-in user');
}
$userId = $userId ?? $this->getUserId();

$this->config->deleteUserValue($userId, Application::APP_ID, 'background_image');
$this->config->deleteUserValue($userId, Application::APP_ID, 'background_color');
Expand All @@ -224,11 +221,9 @@ public function setDefaultBackground(?string $userId = null): void {
* @throws PreConditionNotMetException
* @throws NoUserException
*/
public function setFileBackground($path): void {
if ($this->userId === null) {
throw new RuntimeException('No currently logged-in user');
}
$userFolder = $this->rootFolder->getUserFolder($this->userId);
public function setFileBackground(string $path, ?string $userId = null): void {
$userId = $userId ?? $this->getUserId();
$userFolder = $this->rootFolder->getUserFolder($userId);

/** @var File $file */
$file = $userFolder->get($path);
Expand All @@ -242,10 +237,7 @@ public function setFileBackground($path): void {
}

public function recalculateMeanColor(?string $userId = null): void {
$userId = $userId ?? $this->userId;
if ($userId === null) {
throw new RuntimeException('No currently logged-in user');
}
$userId = $userId ?? $this->getUserId();

$image = new \OCP\Image();
$handle = $this->getAppDataFolder($userId)->getFile('background.jpg')->read();
Expand All @@ -268,10 +260,8 @@ public function recalculateMeanColor(?string $userId = null): void {
* @throws InvalidArgumentException If the specified filename does not match any shipped background
*/
public function setShippedBackground(string $filename, ?string $userId = null): void {
$userId = $userId ?? $this->userId;
if ($userId === null) {
throw new RuntimeException('No currently logged-in user');
}
$userId = $userId ?? $this->getUserId();

if (!array_key_exists($filename, self::SHIPPED_BACKGROUNDS)) {
throw new InvalidArgumentException('The given file name is invalid');
}
Expand All @@ -285,26 +275,23 @@ public function setShippedBackground(string $filename, ?string $userId = null):
* @param string|null $userId The user to set the color - default to current logged-in user
*/
public function setColorBackground(string $color, ?string $userId = null): void {
$userId = $userId ?? $this->userId;
if ($userId === null) {
throw new RuntimeException('No currently logged-in user');
}
$userId = $userId ?? $this->getUserId();

if (!preg_match('/^#([0-9a-f]{3}|[0-9a-f]{6})$/i', $color)) {
throw new InvalidArgumentException('The given color is invalid');
}
$this->config->setUserValue($userId, Application::APP_ID, 'background_color', $color);
$this->config->setUserValue($userId, Application::APP_ID, 'background_image', self::BACKGROUND_COLOR);
}

public function deleteBackgroundImage(): void {
if ($this->userId === null) {
throw new RuntimeException('No currently logged-in user');
}
$this->config->setUserValue($this->userId, Application::APP_ID, 'background_image', self::BACKGROUND_COLOR);
public function deleteBackgroundImage(?string $userId = null): void {
$userId = $userId ?? $this->getUserId();
$this->config->setUserValue($userId, Application::APP_ID, 'background_image', self::BACKGROUND_COLOR);
}

public function getBackground(): ?ISimpleFile {
$background = $this->config->getUserValue($this->userId, Application::APP_ID, 'background_image', self::BACKGROUND_DEFAULT);
public function getBackground(?string $userId = null): ?ISimpleFile {
$userId = $userId ?? $this->getUserId();
$background = $this->config->getUserValue($userId, Application::APP_ID, 'background_image', self::BACKGROUND_DEFAULT);
if ($background === self::BACKGROUND_CUSTOM) {
try {
return $this->getAppDataFolder()->getFile('background.jpg');
Expand Down Expand Up @@ -398,20 +385,27 @@ function toHex(int $channel): string {
* @throws NotPermittedException
*/
private function getAppDataFolder(?string $userId = null): ISimpleFolder {
$userId = $userId ?? $this->userId;
if ($userId === null) {
throw new RuntimeException('No currently logged-in user');
}
$userId = $userId ?? $this->getUserId();

try {
$rootFolder = $this->appData->getFolder('users');
} catch (NotFoundException $e) {
} catch (NotFoundException) {
$rootFolder = $this->appData->newFolder('users');
}
try {
return $rootFolder->getFolder($userId);
} catch (NotFoundException $e) {
} catch (NotFoundException) {
return $rootFolder->newFolder($userId);
}
}

/**
* @throws RuntimeException Thrown if a method that needs a user is called without any logged-in user
*/
private function getUserId(): string {
if ($this->userId === null) {
throw new RuntimeException('No currently logged-in user');
}
return $this->userId;
}
}