Skip to content

Shortcut to avoid file system setup when generating the logo URL #23889

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
MorrisJobke merged 1 commit into from
Nov 9, 2020
+14 −11
Merged

Shortcut to avoid file system setup when generating the logo URL #23889

Show file tree
Hide file tree
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
19 changes: 14 additions & 5 deletions apps/theming/lib/ThemingDefaults.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,11 +225,20 @@ public function getColorPrimary() {
public function getLogo($useSvg = true): string {
$logo = $this->config->getAppValue('theming', 'logoMime', false);

$logoExists = true;
try {
$this->imageManager->getImage('logo', $useSvg);
} catch (\Exception $e) {
$logoExists = false;
// 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) {
Copy link
Member

@rullzer rullzer Nov 6, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So this only works if your logo is an SVG logo?

Copy link
Member Author

@MorrisJobke MorrisJobke Nov 6, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, because in the other case it also tries to create the file on the fly. See the code in getImage. But for the capabilities SVG is used and that was the main driver for this here.

$logoExists = true;
} else {
try {
$this->imageManager->getImage('logo', $useSvg);
$logoExists = true;
} catch (\Exception $e) {
$logoExists = false;
}
}

$cacheBusterCounter = $this->config->getAppValue('theming', 'cachebuster', '0');
Expand Down
6 changes: 0 additions & 6 deletions apps/theming/tests/ThemingDefaultsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@
use OCP\App\IAppManager;
use OCP\Files\IAppData;
use OCP\Files\NotFoundException;
use OCP\Files\SimpleFS\ISimpleFile;
use OCP\ICache;
use OCP\ICacheFactory;
use OCP\IConfig;
Expand Down Expand Up @@ -617,11 +616,6 @@ public function testGetLogoDefaultWithoutSvg() {
}

public function testGetLogoCustom() {
$file = $this->createMock(ISimpleFile::class);
$this->imageManager->expects($this->once())
->method('getImage')
->with('logo')
->willReturn($file);
$this->config
->expects($this->at(0))
->method('getAppValue')
Expand Down