* * @author Bjoern Schiessle * @author Christoph Wurst * @author Daniel Calviño Sánchez * @author Joas Schilling * @author John Molakvoæ * @author Julius Haertl * @author Julius Härtl * @author Kyle Fazzari * @author Lukas Reschke * @author Michael Weimann * @author rakekniven * @author Roeland Jago Douma * * @license GNU AGPL version 3 or any later version * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see . * */ namespace OCA\Theming\Tests\Controller; use OC\L10N\L10N; use OC\Template\SCSSCacher; use OCA\Theming\Controller\ThemingController; use OCA\Theming\ImageManager; use OCA\Theming\ThemingDefaults; use OCP\App\IAppManager; use OCP\AppFramework\Http; use OCP\AppFramework\Http\DataResponse; use OCP\AppFramework\Utility\ITimeFactory; use OCP\Files\IAppData; use OCP\Files\NotFoundException; use OCP\Files\SimpleFS\ISimpleFile; use OCP\IConfig; use OCP\IL10N; use OCP\IRequest; use OCP\ITempManager; use OCP\IURLGenerator; use PHPUnit\Framework\MockObject\MockObject; use Test\TestCase; class ThemingControllerTest extends TestCase { /** @var IRequest|MockObject */ private $request; /** @var IConfig|MockObject */ private $config; /** @var ThemingDefaults|MockObject */ private $themingDefaults; /** @var IL10N|MockObject */ private $l10n; /** @var ThemingController */ private $themingController; /** @var ITempManager */ private $tempManager; /** @var IAppManager|MockObject */ private $appManager; /** @var IAppData|MockObject */ private $appData; /** @var ImageManager|MockObject */ private $imageManager; /** @var SCSSCacher */ private $scssCacher; /** @var IURLGenerator */ private $urlGenerator; protected function setUp(): void { $this->request = $this->createMock(IRequest::class); $this->config = $this->createMock(IConfig::class); $this->themingDefaults = $this->createMock(ThemingDefaults::class); $this->l10n = $this->createMock(L10N::class); $this->appData = $this->createMock(IAppData::class); $this->appManager = $this->createMock(IAppManager::class); $this->tempManager = \OC::$server->getTempManager(); $this->scssCacher = $this->createMock(SCSSCacher::class); $this->urlGenerator = $this->createMock(IURLGenerator::class); $this->imageManager = $this->createMock(ImageManager::class); $timeFactory = $this->createMock(ITimeFactory::class); $timeFactory->expects($this->any()) ->method('getTime') ->willReturn(123); $this->overwriteService(ITimeFactory::class, $timeFactory); $this->themingController = new ThemingController( 'theming', $this->request, $this->config, $this->themingDefaults, $this->l10n, $this->tempManager, $this->appData, $this->scssCacher, $this->urlGenerator, $this->appManager, $this->imageManager ); parent::setUp(); } public function dataUpdateStylesheetSuccess() { return [ ['name', str_repeat('a', 250), 'Saved'], ['url', 'https://nextcloud.com/' . str_repeat('a', 478), 'Saved'], ['slogan', str_repeat('a', 500), 'Saved'], ['color', '#0082c9', 'Saved'], ['color', '#0082C9', 'Saved'], ['color', '#0082C9', 'Saved'], ['imprintUrl', 'https://nextcloud.com/' . str_repeat('a', 478), 'Saved'], ['privacyUrl', 'https://nextcloud.com/' . str_repeat('a', 478), 'Saved'], ]; } /** * @dataProvider dataUpdateStylesheetSuccess * * @param string $setting * @param string $value * @param string $message */ public function testUpdateStylesheetSuccess($setting, $value, $message) { $this->themingDefaults ->expects($this->once()) ->method('set') ->with($setting, $value); $this->l10n ->expects($this->once()) ->method('t') ->willReturnCallback(function ($str) { return $str; }); $this->scssCacher ->expects($this->once()) ->method('getCachedSCSS') ->with('core', '/core/css/css-variables.scss') ->willReturn('/core/css/someHash-css-variables.scss'); $this->urlGenerator ->expects($this->once()) ->method('linkTo') ->with('', '/core/css/someHash-css-variables.scss') ->willReturn('/nextcloudWebroot/core/css/someHash-css-variables.scss'); $expected = new DataResponse( [ 'data' => [ 'message' => $message, 'serverCssUrl' => '/nextcloudWebroot/core/css/someHash-css-variables.scss', ], 'status' => 'success', ] ); $this->assertEquals($expected, $this->themingController->updateStylesheet($setting, $value)); } public function dataUpdateStylesheetError() { return [ ['name', str_repeat('a', 251), 'The given name is too long'], ['url', 'http://example.com/' . str_repeat('a', 501), 'The given web address is too long'], ['url', str_repeat('a', 501), 'The given web address is not a valid URL'], ['url', 'javascript:alert(1)', 'The given web address is not a valid URL'], ['slogan', str_repeat('a', 501), 'The given slogan is too long'], ['color', '0082C9', 'The given color is invalid'], ['color', '#0082Z9', 'The given color is invalid'], ['color', 'Nextcloud', 'The given color is invalid'], ['imprintUrl', '0082C9', 'The given legal notice address is not a valid URL'], ['imprintUrl', '0082C9', 'The given legal notice address is not a valid URL'], ['imprintUrl', 'javascript:foo', 'The given legal notice address is not a valid URL'], ['privacyUrl', '#0082Z9', 'The given privacy policy address is not a valid URL'], ]; } /** * @dataProvider dataUpdateStylesheetError * * @param string $setting * @param string $value * @param string $message */ public function testUpdateStylesheetError($setting, $value, $message) { $this->themingDefaults ->expects($this->never()) ->method('set') ->with($setting, $value); $this->l10n ->expects($this->any()) ->method('t') ->willReturnCallback(function ($str) { return $str; }); $expected = new DataResponse( [ 'data' => [ 'message' => $message, ], 'status' => 'error', ], Http::STATUS_BAD_REQUEST ); $this->assertEquals($expected, $this->themingController->updateStylesheet($setting, $value)); } public function testUpdateLogoNoData() { $this->request ->expects($this->at(0)) ->method('getParam') ->with('key') ->willReturn('logo'); $this->request ->expects($this->at(1)) ->method('getUploadedFile') ->with('image') ->willReturn(null); $this->l10n ->expects($this->any()) ->method('t') ->willReturnCallback(function ($str) { return $str; }); $expected = new DataResponse( [ 'data' => [ 'message' => 'No file uploaded', ], 'status' => 'failure', ], Http::STATUS_UNPROCESSABLE_ENTITY ); $this->assertEquals($expected, $this->themingController->uploadImage()); } /** * Checks that trying to upload an SVG favicon without imagemagick * results in an unsupported media type response. * * @test * @return void */ public function testUploadSVGFaviconWithoutImagemagick() { $this->imageManager ->method('shouldReplaceIcons') ->willReturn(false); $this->request ->expects($this->at(0)) ->method('getParam') ->with('key') ->willReturn('favicon'); $this->request ->expects($this->at(1)) ->method('getUploadedFile') ->with('image') ->willReturn([ 'tmp_name' => __DIR__ . '/../../../../tests/data/testimagelarge.svg', 'type' => 'image/svg', 'name' => 'testimagelarge.svg', 'error' => 0, ]); $this->l10n ->expects($this->any()) ->method('t') ->willReturnCallback(function ($str) { return $str; }); $this->imageManager->expects($this->once()) ->method('updateImage') ->willThrowException(new \Exception('Unsupported image type')); $expected = new DataResponse( [ 'data' => [ 'message' => 'Unsupported image type', ], 'status' => 'failure' ], Http::STATUS_UNPROCESSABLE_ENTITY ); $this->assertEquals($expected, $this->themingController->uploadImage()); } public function testUpdateLogoInvalidMimeType() { $this->request ->expects($this->at(0)) ->method('getParam') ->with('key') ->willReturn('logo'); $this->request ->expects($this->at(1)) ->method('getUploadedFile') ->with('image') ->willReturn([ 'tmp_name' => __DIR__ . '/../../../../tests/data/lorem.txt', 'type' => 'application/pdf', 'name' => 'logo.pdf', 'error' => 0, ]); $this->l10n ->expects($this->any()) ->method('t') ->willReturnCallback(function ($str) { return $str; }); $this->imageManager->expects($this->once()) ->method('updateImage') ->willThrowException(new \Exception('Unsupported image type')); $expected = new DataResponse( [ 'data' => [ 'message' => 'Unsupported image type', ], 'status' => 'failure' ], Http::STATUS_UNPROCESSABLE_ENTITY ); $this->assertEquals($expected, $this->themingController->uploadImage()); } public function dataUpdateImages() { return [ ['image/jpeg', false], ['image/jpeg', true], ['image/gif'], ['image/png'], ['image/svg+xml'], ['image/svg'] ]; } /** @dataProvider dataUpdateImages */ public function testUpdateLogoNormalLogoUpload($mimeType, $folderExists = true) { $tmpLogo = \OC::$server->getTempManager()->getTemporaryFolder() . '/logo.svg'; $destination = \OC::$server->getTempManager()->getTemporaryFolder(); touch($tmpLogo); copy(__DIR__ . '/../../../../tests/data/testimage.png', $tmpLogo); $this->request ->expects($this->at(0)) ->method('getParam') ->with('key') ->willReturn('logo'); $this->request ->expects($this->at(1)) ->method('getUploadedFile') ->with('image') ->willReturn([ 'tmp_name' => $tmpLogo, 'type' => $mimeType, 'name' => 'logo.svg', 'error' => 0, ]); $this->l10n ->expects($this->any()) ->method('t') ->willReturnCallback(function ($str) { return $str; }); $this->urlGenerator->expects($this->once()) ->method('linkTo') ->willReturn('serverCss'); $this->imageManager->expects($this->once()) ->method('getImageUrl') ->with('logo') ->willReturn('imageUrl'); $this->imageManager->expects($this->once()) ->method('updateImage'); $expected = new DataResponse( [ 'data' => [ 'name' => 'logo.svg', 'message' => 'Saved', 'url' => 'imageUrl', 'serverCssUrl' => 'serverCss' ], 'status' => 'success' ] ); $this->assertEquals($expected, $this->themingController->uploadImage()); } /** @dataProvider dataUpdateImages */ public function testUpdateLogoLoginScreenUpload($folderExists) { $tmpLogo = \OC::$server->getTempManager()->getTemporaryFolder() . 'logo.png'; touch($tmpLogo); copy(__DIR__ . '/../../../../tests/data/desktopapp.png', $tmpLogo); $this->request ->expects($this->at(0)) ->method('getParam') ->with('key') ->willReturn('background'); $this->request ->expects($this->at(1)) ->method('getUploadedFile') ->with('image') ->willReturn([ 'tmp_name' => $tmpLogo, 'type' => 'image/svg+xml', 'name' => 'logo.svg', 'error' => 0, ]); $this->l10n ->expects($this->any()) ->method('t') ->willReturnCallback(function ($str) { return $str; }); $this->imageManager->expects($this->once()) ->method('updateImage'); $this->urlGenerator->expects($this->once()) ->method('linkTo') ->willReturn('serverCss'); $this->imageManager->expects($this->once()) ->method('getImageUrl') ->with('background') ->willReturn('imageUrl'); $expected = new DataResponse( [ 'data' => [ 'name' => 'logo.svg', 'message' => 'Saved', 'url' => 'imageUrl', 'serverCssUrl' => 'serverCss' ], 'status' => 'success' ] ); $this->assertEquals($expected, $this->themingController->uploadImage()); } public function testUpdateLogoLoginScreenUploadWithInvalidImage() { $tmpLogo = \OC::$server->getTempManager()->getTemporaryFolder() . '/logo.svg'; touch($tmpLogo); file_put_contents($tmpLogo, file_get_contents(__DIR__ . '/../../../../tests/data/data.zip')); $this->request ->expects($this->at(0)) ->method('getParam') ->with('key') ->willReturn('logo'); $this->request ->expects($this->at(1)) ->method('getUploadedFile') ->with('image') ->willReturn([ 'tmp_name' => $tmpLogo, 'type' => 'foobar', 'name' => 'logo.svg', 'error' => 0, ]); $this->l10n ->expects($this->any()) ->method('t') ->willReturnCallback(function ($str) { return $str; }); $this->imageManager->expects($this->once()) ->method('updateImage') ->willThrowException(new \Exception('Unsupported image type')); $expected = new DataResponse( [ 'data' => [ 'message' => 'Unsupported image type', ], 'status' => 'failure' ], Http::STATUS_UNPROCESSABLE_ENTITY ); $this->assertEquals($expected, $this->themingController->uploadImage()); } public function dataPhpUploadErrors() { return [ [UPLOAD_ERR_INI_SIZE, 'The uploaded file exceeds the upload_max_filesize directive in php.ini'], [UPLOAD_ERR_FORM_SIZE, 'The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form'], [UPLOAD_ERR_PARTIAL, 'The file was only partially uploaded'], [UPLOAD_ERR_NO_FILE, 'No file was uploaded'], [UPLOAD_ERR_NO_TMP_DIR, 'Missing a temporary folder'], [UPLOAD_ERR_CANT_WRITE, 'Could not write file to disk'], [UPLOAD_ERR_EXTENSION, 'A PHP extension stopped the file upload'], ]; } /** * @dataProvider dataPhpUploadErrors */ public function testUpdateLogoLoginScreenUploadWithInvalidImageUpload($error, $expectedErrorMessage) { $this->request ->expects($this->at(0)) ->method('getParam') ->with('key') ->willReturn('background'); $this->request ->expects($this->at(1)) ->method('getUploadedFile') ->with('image') ->willReturn([ 'tmp_name' => '', 'type' => 'image/svg+xml', 'name' => 'logo.svg', 'error' => $error, ]); $this->l10n ->expects($this->any()) ->method('t') ->willReturnCallback(function ($str) { return $str; }); $expected = new DataResponse( [ 'data' => [ 'message' => $expectedErrorMessage, ], 'status' => 'failure' ], Http::STATUS_UNPROCESSABLE_ENTITY ); $this->assertEquals($expected, $this->themingController->uploadImage()); } /** * @dataProvider dataPhpUploadErrors */ public function testUpdateLogoUploadWithInvalidImageUpload($error, $expectedErrorMessage) { $this->request ->expects($this->at(0)) ->method('getParam') ->with('key') ->willReturn('background'); $this->request ->expects($this->at(1)) ->method('getUploadedFile') ->with('image') ->willReturn([ 'tmp_name' => '', 'type' => 'text/svg', 'name' => 'logo.svg', 'error' => $error, ]); $this->l10n ->expects($this->any()) ->method('t') ->willReturnCallback(function ($str) { return $str; }); $expected = new DataResponse( [ 'data' => [ 'message' => $expectedErrorMessage ], 'status' => 'failure' ], Http::STATUS_UNPROCESSABLE_ENTITY ); $this->assertEquals($expected, $this->themingController->uploadImage()); } public function testUndo() { $this->l10n ->expects($this->once()) ->method('t') ->with('Saved') ->willReturn('Saved'); $this->themingDefaults ->expects($this->once()) ->method('undo') ->with('MySetting') ->willReturn('MyValue'); $this->scssCacher ->expects($this->once()) ->method('getCachedSCSS') ->with('core', '/core/css/css-variables.scss') ->willReturn('/core/css/someHash-css-variables.scss'); $this->urlGenerator ->expects($this->once()) ->method('linkTo') ->with('', '/core/css/someHash-css-variables.scss') ->willReturn('/nextcloudWebroot/core/css/someHash-css-variables.scss'); $expected = new DataResponse( [ 'data' => [ 'value' => 'MyValue', 'message' => 'Saved', 'serverCssUrl' => '/nextcloudWebroot/core/css/someHash-css-variables.scss', ], 'status' => 'success' ] ); $this->assertEquals($expected, $this->themingController->undo('MySetting')); } public function dataUndoDelete() { return [ [ 'backgroundMime', 'background' ], [ 'logoMime', 'logo' ] ]; } /** @dataProvider dataUndoDelete */ public function testUndoDelete($value, $filename) { $this->l10n ->expects($this->once()) ->method('t') ->with('Saved') ->willReturn('Saved'); $this->themingDefaults ->expects($this->once()) ->method('undo') ->with($value) ->willReturn($value); $this->scssCacher ->expects($this->once()) ->method('getCachedSCSS') ->with('core', '/core/css/css-variables.scss') ->willReturn('/core/css/someHash-css-variables.scss'); $this->urlGenerator ->expects($this->once()) ->method('linkTo') ->with('', '/core/css/someHash-css-variables.scss') ->willReturn('/nextcloudWebroot/core/css/someHash-css-variables.scss'); $expected = new DataResponse( [ 'data' => [ 'value' => $value, 'message' => 'Saved', 'serverCssUrl' => '/nextcloudWebroot/core/css/someHash-css-variables.scss', ], 'status' => 'success' ] ); $this->assertEquals($expected, $this->themingController->undo($value)); } public function testGetLogoNotExistent() { $this->imageManager->method('getImage') ->with($this->equalTo('logo')) ->willThrowException(new NotFoundException()); $expected = new Http\NotFoundResponse(); $this->assertEquals($expected, $this->themingController->getImage('logo')); } public function testGetLogo() { $file = $this->createMock(ISimpleFile::class); $file->method('getName')->willReturn('logo.svg'); $file->method('getMTime')->willReturn(42); $this->imageManager->expects($this->once()) ->method('getImage') ->willReturn($file); $this->config ->expects($this->any()) ->method('getAppValue') ->with('theming', 'logoMime', '') ->willReturn('text/svg'); @$expected = new Http\FileDisplayResponse($file); $expected->cacheFor(3600); $expected->addHeader('Content-Type', 'text/svg'); $expected->addHeader('Content-Disposition', 'attachment; filename="logo"'); $csp = new Http\ContentSecurityPolicy(); $csp->allowInlineStyle(); $expected->setContentSecurityPolicy($csp); @$this->assertEquals($expected, $this->themingController->getImage('logo')); } public function testGetLoginBackgroundNotExistent() { $this->imageManager->method('getImage') ->with($this->equalTo('background')) ->willThrowException(new NotFoundException()); $expected = new Http\NotFoundResponse(); $this->assertEquals($expected, $this->themingController->getImage('background')); } public function testGetLoginBackground() { $file = $this->createMock(ISimpleFile::class); $file->method('getName')->willReturn('background.png'); $file->method('getMTime')->willReturn(42); $this->imageManager->expects($this->once()) ->method('getImage') ->willReturn($file); $this->config ->expects($this->any()) ->method('getAppValue') ->with('theming', 'backgroundMime', '') ->willReturn('image/png'); @$expected = new Http\FileDisplayResponse($file); $expected->cacheFor(3600); $expected->addHeader('Content-Type', 'image/png'); $expected->addHeader('Content-Disposition', 'attachment; filename="background"'); $csp = new Http\ContentSecurityPolicy(); $csp->allowInlineStyle(); $expected->setContentSecurityPolicy($csp); @$this->assertEquals($expected, $this->themingController->getImage('background')); } public function testGetStylesheet() { $this->appManager->expects($this->once())->method('getAppPath')->with('theming')->willReturn(\OC::$SERVERROOT . '/theming'); $file = $this->createMock(ISimpleFile::class); $file->expects($this->any())->method('getName')->willReturn('theming.css'); $file->expects($this->any())->method('getMTime')->willReturn(42); $file->expects($this->any())->method('getContent')->willReturn('compiled'); $this->scssCacher->expects($this->once())->method('process')->willReturn(true); $this->scssCacher->expects($this->once())->method('getCachedCSS')->willReturn($file); $response = new Http\FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => 'text/css']); $response->cacheFor(86400); $actual = $this->themingController->getStylesheet(); $this->assertEquals($response, $actual); } public function testGetStylesheetFails() { $this->appManager->expects($this->once())->method('getAppPath')->with('theming')->willReturn(\OC::$SERVERROOT . '/theming'); $file = $this->createMock(ISimpleFile::class); $file->expects($this->any())->method('getName')->willReturn('theming.css'); $file->expects($this->any())->method('getMTime')->willReturn(42); $file->expects($this->any())->method('getContent')->willReturn('compiled'); $this->scssCacher->expects($this->once())->method('process')->willReturn(true); $this->scssCacher->expects($this->once())->method('getCachedCSS')->willThrowException(new NotFoundException()); $response = new Http\NotFoundResponse(); $actual = $this->themingController->getStylesheet(); $this->assertEquals($response, $actual); } public function testGetStylesheetOutsideServerroot() { $this->appManager->expects($this->once())->method('getAppPath')->with('theming')->willReturn('/outside/serverroot/theming'); $file = $this->createMock(ISimpleFile::class); $file->expects($this->any())->method('getName')->willReturn('theming.css'); $file->expects($this->any())->method('getMTime')->willReturn(42); $file->expects($this->any())->method('getContent')->willReturn('compiled'); $this->scssCacher->expects($this->once())->method('process')->with('/outside/serverroot/theming', 'css/theming.scss', 'theming')->willReturn(true); $this->scssCacher->expects($this->once())->method('getCachedCSS')->willReturn($file); $response = new Http\FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => 'text/css']); $response->cacheFor(86400); $actual = $this->themingController->getStylesheet(); $this->assertEquals($response, $actual); } public function testGetManifest() { $this->config ->expects($this->once()) ->method('getAppValue') ->with('theming', 'cachebuster', '0') ->willReturn('0'); $this->themingDefaults ->expects($this->any()) ->method('getName') ->willReturn('Nextcloud'); $this->urlGenerator ->expects($this->at(0)) ->method('getBaseUrl') ->willReturn('localhost'); $this->urlGenerator ->expects($this->at(1)) ->method('linkToRoute') ->with('theming.Icon.getTouchIcon', ['app' => 'core']) ->willReturn('touchicon'); $this->urlGenerator ->expects($this->at(2)) ->method('linkToRoute') ->with('theming.Icon.getFavicon', ['app' => 'core']) ->willReturn('favicon'); $response = new Http\JSONResponse([ 'name' => 'Nextcloud', 'start_url' => 'localhost', 'icons' => [ [ 'src' => 'touchicon?v=0', 'type' => 'image/png', 'sizes' => '512x512' ], [ 'src' => 'favicon?v=0', 'type' => 'image/svg+xml', 'sizes' => '16x16' ] ], 'display' => 'standalone', 'short_name' => 'Nextcloud', 'theme_color' => null, 'background_color' => null, 'description' => null ]); $response->cacheFor(3600); $this->assertEquals($response, $this->themingController->getManifest('core')); } }