Backport of #9437

allow to specify a link to a legal notice

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>

fix tests

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>

fix undo for url-typed inputs

and minor adjustments

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>

Use link not address in labels for URLs

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>

this file does not belong here

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>

apps/theming/css/settings-admin.css

@@ -27,7 +27,7 @@
     visibility: hidden;
 }
 form.uploadButton {
-    width: 356px;
+    width: 411px;
 }
 #theming form .theme-undo,
 #theming .theme-remove-bg {
@@ -51,7 +51,7 @@ form.uploadButton {
 
 #theming label span {
     display: inline-block;
-    min-width: 120px;
+    min-width: 175px;
     padding: 8px 0px;
     vertical-align: top;
 }
@@ -91,7 +91,7 @@ form.uploadButton {
     background-size: cover;
     background-position: center center;
     text-align: center;
-    margin-left: 123px;
+    margin-left: 178px;
     margin-top: 10px;
     cursor: pointer;
 }
@@ -104,4 +104,4 @@ form.uploadButton {
 
 .theming-hints {
     margin-top: 20px;
-}
+}

apps/theming/js/settings-admin.js

@@ -95,7 +95,8 @@ function hideUndoButton(setting, value) {
 		url: 'https://nextcloud.com',
 		color: '#0082c9',
 		logoMime: '',
-		backgroundMime: ''
+		backgroundMime: '',
+		imprintUrl: ''
 	};
 
 	if (value === themingDefaults[setting] || value === '') {
@@ -195,6 +196,16 @@ $(document).ready(function () {
 		}
 	});
 
+	$('#theming-imprintUrl').change(function(e) {
+		var el = $(this);
+		$.when(el.focusout()).then(function () {
+			setThemingValue('imprintUrl', $(this).val());
+		});
+		if (e.keyCode == 13) {
+			setThemingValue('imprintUrl', $(this).val());
+		}
+	});
+
 	$('#theming-slogan').change(function(e) {
 		var el = $(this);
 		$.when(el.focusout()).then(function() {

apps/theming/lib/Controller/ThemingController.php

@@ -157,6 +157,16 @@ class ThemingController extends Controller {
 					]);
 				}
 				break;
+			case 'imprintUrl':
+				if (strlen($value) > 500) {
+					return new DataResponse([
+						'data' => [
+							'message' => $this->l10n->t('The given legal notice address is too long'),
+						],
+						'status' => 'error'
+					]);
+				}
+				break;
 			case 'slogan':
 				if (strlen($value) > 500) {
 					return new DataResponse([
@@ -459,6 +469,7 @@ class ThemingController extends Controller {
 		url: ' . json_encode($this->themingDefaults->getBaseUrl()) . ',
 		slogan: ' . json_encode($this->themingDefaults->getSlogan()) . ',
 		color: ' . json_encode($this->themingDefaults->getColorPrimary()) . ',
+		imprintUrl: ' . json_encode($this->themingDefaults->getImprintUrl()) . ',
 		inverted: ' . json_encode($this->util->invertTextColor($this->themingDefaults->getColorPrimary())) . ',
 		cacheBuster: ' . json_encode($cacheBusterValue) . '
 	};

apps/theming/lib/Settings/Admin.php

@@ -83,7 +83,8 @@ class Admin implements ISettings {
 			'backgroundMime'  => $this->config->getAppValue('theming', 'backgroundMime', ''),
 			'uploadLogoRoute' => $path,
 			'canThemeIcons'   => $this->themingDefaults->shouldReplaceIcons(),
-			'iconDocs'        => $this->urlGenerator->linkToDocs('admin-theming-icons')
+			'iconDocs'        => $this->urlGenerator->linkToDocs('admin-theming-icons'),
+			'imprintUrl'      => $this->themingDefaults->getImprintUrl(),
 		];
 
 		return new TemplateResponse('theming', 'settings-admin', $parameters, '');

apps/theming/lib/ThemingDefaults.php

@@ -142,12 +142,26 @@ class ThemingDefaults extends \OC_Defaults {
 		return \OCP\Util::sanitizeHTML($this->config->getAppValue('theming', 'slogan', $this->slogan));
 	}
 
+	public function getImprintUrl() {
+		return $this->config->getAppValue('theming', 'imprintUrl', '');
+	}
+
 	public function getShortFooter() {
 		$slogan = $this->getSlogan();
 		$footer = '<a href="'. $this->getBaseUrl() . '" target="_blank"' .
 			' rel="noreferrer noopener">' .$this->getEntity() . '</a>'.
 			($slogan !== '' ? ' – ' . $slogan : '');
 
+		$imprintUrl = (string)$this->getImprintUrl();
+		if($imprintUrl !== ''
+			&& filter_var($imprintUrl, FILTER_VALIDATE_URL, [
+				'flags' => FILTER_FLAG_SCHEME_REQUIRED | FILTER_FLAG_HOST_REQUIRED
+			])
+		) {
+			$footer .= '<br/><a href="' . $imprintUrl . '" class="legal" target="_blank"' .
+				' rel="noreferrer noopener">' . $this->l->t('Legal notice') . '</a>';
+		}
+
 		return $footer;
 	}
 

apps/theming/templates/settings-admin.php

@@ -47,7 +47,7 @@ style('theming', 'settings-admin');
 	</div>
 	<div>
 		<label>
-			<span><?php p($l->t('Web address')) ?></span>
+			<span><?php p($l->t('Web link')) ?></span>
 			<input id="theming-url" type="text" placeholder="<?php p($l->t('Web address https://…')); ?>" value="<?php p($_['url']) ?>" maxlength="500" />
 			<div data-setting="url" data-toggle="tooltip" data-original-title="<?php p($l->t('Reset to default')); ?>" class="theme-undo icon icon-history"></div>
 		</label>
@@ -88,6 +88,13 @@ style('theming', 'settings-admin');
 	<div id="theming-preview">
 		<img src="<?php p($_['logo']); ?>" id="theming-preview-logo" />
 	</div>
+	<div>
+		<label>
+				<span><?php p($l->t('Legal notice link')) ?></span>
+				<input id="theming-imprintUrl" type="text" placeholder="<?php p($l->t('https://…')); ?>" value="<?php p($_['imprintUrl']) ?>" maxlength="500" />
+			<div data-setting="imprintUrl" data-toggle="tooltip" data-original-title="<?php p($l->t('Reset to default')); ?>" class="theme-undo icon icon-history"></div>
+		</label>
+	</div>
 	<div class="theming-hints">
 		<?php if (!$_['canThemeIcons']) { ?>
 			<p class="info">

apps/theming/tests/Controller/ThemingControllerTest.php

@@ -876,6 +876,7 @@ class ThemingControllerTest extends TestCase {
 		url: "",
 		slogan: "",
 		color: "#000",
+		imprintUrl: null,
 		inverted: false,
 		cacheBuster: null
 	};
@@ -910,6 +911,7 @@ class ThemingControllerTest extends TestCase {
 		url: "nextcloudurl",
 		slogan: "awesome",
 		color: "#ffffff",
+		imprintUrl: null,
 		inverted: true,
 		cacheBuster: null
 	};

apps/theming/tests/Settings/AdminTest.php

@@ -76,6 +76,10 @@ class AdminTest extends TestCase {
 			->expects($this->once())
 			->method('getBaseUrl')
 			->willReturn('https://example.com');
+		$this->themingDefaults
+			->expects($this->once())
+			->method('getImprintUrl')
+			->willReturn('');
 		$this->themingDefaults
 			->expects($this->once())
 			->method('getSlogan')
@@ -103,6 +107,7 @@ class AdminTest extends TestCase {
 			'backgroundMime' => null,
 			'canThemeIcons' => null,
 			'iconDocs' => null,
+			'imprintUrl' => '',
 		];
 
 		$expected = new TemplateResponse('theming', 'settings-admin', $params, '');
@@ -128,6 +133,10 @@ class AdminTest extends TestCase {
 			->expects($this->once())
 			->method('getBaseUrl')
 			->willReturn('https://example.com');
+		$this->themingDefaults
+			->expects($this->once())
+			->method('getImprintUrl')
+			->willReturn('');
 		$this->themingDefaults
 			->expects($this->once())
 			->method('getSlogan')
@@ -155,6 +164,7 @@ class AdminTest extends TestCase {
 			'backgroundMime' => null,
 			'canThemeIcons' => null,
 			'iconDocs' => null,
+			'imprintUrl' => '',
 		];
 
 		$expected = new TemplateResponse('theming', 'settings-admin', $params, '');

apps/theming/tests/ThemingDefaultsTest.php

@@ -193,6 +193,27 @@ class ThemingDefaultsTest extends TestCase {
 		$this->assertEquals('https://example.com/', $this->template->getBaseUrl());
 	}
 
+	public function imprintUrlProvider() {
+		return [
+			[ '' ],
+			[ 'https://example.com/imprint.html']
+		];
+	}
+
+	/**
+	 * @param $imprintUrl
+	 * @dataProvider imprintUrlProvider
+	 */
+	public function testGetImprintURL($imprintUrl) {
+		$this->config
+			->expects($this->once())
+			->method('getAppValue')
+			->with('theming', 'imprintUrl', '')
+			->willReturn($imprintUrl);
+
+		$this->assertEquals($imprintUrl, $this->template->getImprintUrl());
+	}
+
 	public function testGetSloganWithDefault() {
 		$this->config
 			->expects($this->once())
@@ -215,12 +236,13 @@ class ThemingDefaultsTest extends TestCase {
 
 	public function testGetShortFooter() {
 		$this->config
-			->expects($this->exactly(3))
+			->expects($this->exactly(4))
 			->method('getAppValue')
 			->willReturnMap([
 				['theming', 'url', $this->defaults->getBaseUrl(), 'url'],
 				['theming', 'name', 'Nextcloud', 'Name'],
 				['theming', 'slogan', $this->defaults->getSlogan(), 'Slogan'],
+				['theming', 'imprintUrl', '', ''],
 			]);
 
 		$this->assertEquals('<a href="url" target="_blank" rel="noreferrer noopener">Name</a> – Slogan', $this->template->getShortFooter());
@@ -228,17 +250,62 @@ class ThemingDefaultsTest extends TestCase {
 
 	public function testGetShortFooterEmptySlogan() {
 		$this->config
-			->expects($this->exactly(3))
+			->expects($this->exactly(4))
 			->method('getAppValue')
 			->willReturnMap([
 				['theming', 'url', $this->defaults->getBaseUrl(), 'url'],
 				['theming', 'name', 'Nextcloud', 'Name'],
 				['theming', 'slogan', $this->defaults->getSlogan(), ''],
+				['theming', 'imprintUrl', '', ''],
 			]);
 
 		$this->assertEquals('<a href="url" target="_blank" rel="noreferrer noopener">Name</a>', $this->template->getShortFooter());
 	}
 
+	public function testGetShortFooterImprint() {
+		$this->config
+			->expects($this->exactly(4))
+			->method('getAppValue')
+			->willReturnMap([
+				['theming', 'url', $this->defaults->getBaseUrl(), 'url'],
+				['theming', 'name', 'Nextcloud', 'Name'],
+				['theming', 'slogan', $this->defaults->getSlogan(), 'Slogan'],
+				['theming', 'imprintUrl', '', 'https://example.com/imprint'],
+			]);
+
+		$this->l10n
+			->expects($this->any())
+			->method('t')
+			->willReturnArgument(0);
+
+		$this->assertEquals('<a href="url" target="_blank" rel="noreferrer noopener">Name</a> – Slogan<br/><a href="https://example.com/imprint" class="legal" target="_blank" rel="noreferrer noopener">Legal notice</a>', $this->template->getShortFooter());
+	}
+
+	public function invalidImprintUrlProvider() {
+		return [
+			['example.com/imprint'],  # missing scheme
+			['https:///imprint'],     # missing host
+		];
+	}
+
+	/**
+	 * @param $invalidImprintUrl
+	 * @dataProvider invalidImprintUrlProvider
+	 */
+	public function testGetShortFooterInvalidImprint($invalidImprintUrl) {
+		$this->config
+			->expects($this->exactly(4))
+			->method('getAppValue')
+			->willReturnMap([
+				['theming', 'url', $this->defaults->getBaseUrl(), 'url'],
+				['theming', 'name', 'Nextcloud', 'Name'],
+				['theming', 'slogan', $this->defaults->getSlogan(), 'Slogan'],
+				['theming', 'imprintUrl', '', $invalidImprintUrl],
+			]);
+
+		$this->assertEquals('<a href="url" target="_blank" rel="noreferrer noopener">Name</a> – Slogan', $this->template->getShortFooter());
+	}
+
 	public function testgetColorPrimaryWithDefault() {
 		$this->config
 			->expects($this->once())

core/css/guest.css

@@ -741,6 +741,10 @@ footer .info a {
 	overflow: hidden;
 }
 
+a.legal {
+	font-size: smaller;
+}
+
 /* for low-res screens, use Regular font-weight instead of Light */
 @media (-webkit-max-device-pixel-ratio: 1.3), (max-resolution: 124.8dpi) {
 	@font-face {