Merge pull request #6646 from getkirby/v5/fix/language-buttons

Language view buttons (incl. permission check)

config/areas/languages/buttons.php

@@ -1,35 +1,21 @@
 <?php
 
 use Kirby\Cms\Language;
+use Kirby\Panel\Ui\Buttons\LanguageCreateButton;
+use Kirby\Panel\Ui\Buttons\LanguageDeleteButton;
+use Kirby\Panel\Ui\Buttons\LanguageSettingsButton;
 use Kirby\Panel\Ui\Buttons\PreviewButton;
-use Kirby\Panel\Ui\Buttons\ViewButton;
-use Kirby\Toolkit\I18n;
 
 return [
-	'languages.add' => function () {
-		return new ViewButton(
-			dialog: 'languages/create',
-			icon: 'add',
-			text: I18n::translate('language.create'),
-		);
-	},
-	'language.preview' => function (Language $language) {
-		return new PreviewButton(link: $language->url());
-	},
-	'language.settings' => function (Language $language) {
-		return new ViewButton(
-			dialog: 'languages/' . $language->id() . '/update',
-			icon: 'cog',
-			title: I18n::translate('settings'),
-		);
-	},
-	'language.remove' => function (Language $language) {
+	'languages.create' => fn () =>
+		new LanguageCreateButton(),
+	'language.preview' => fn (Language $language) =>
+		new PreviewButton(link: $language->url()),
+	'language.settings' => fn (Language $language) =>
+		new LanguageSettingsButton($language),
+	'language.delete' => function (Language $language) {
 		if ($language->isDeletable() === true) {
-			return new ViewButton(
-				dialog: 'languages/' . $language->id() . '/delete',
-				icon: 'trash',
-				title: I18n::translate('delete'),
-			);
+			return new LanguageDeleteButton($language);
 		}
 	}
 ];

config/areas/languages/views.php

@@ -20,8 +20,8 @@
 			$foundation   = $kirby->defaultLanguage()->translations();
 			$translations = $language->translations();
 
-			// TODO: update following line and adapt for update and delete options
-			// when new `languageVariables.*` permissions available
+			// TODO: update following line and adapt for update and
+			// delete options when `languageVariables.*` permissions available
 			$canUpdate = $kirby->user()?->role()->permissions()->for('languages', 'update') === true;
 
 			ksort($foundation);
@@ -76,7 +76,7 @@
 				'props'      => [
 					'buttons' => fn () =>
 						ViewButtons::view('language')
-							->defaults('preview', 'settings', 'remove')
+							->defaults('preview', 'settings', 'delete')
 							->bind(['language' => $language])
 							->render(),
 					'deletable'    => $language->isDeletable(),
@@ -121,7 +121,7 @@
 				'props'     => [
 					'buttons' => fn () =>
 						ViewButtons::view('languages')
-							->defaults('add')
+							->defaults('create')
 							->render(),
 					'languages' => $kirby->languages()->values(fn ($language) => [
 						'deletable' => $language->isDeletable(),

config/areas/site/buttons.php

@@ -2,7 +2,7 @@
 
 use Kirby\Cms\Page;
 use Kirby\Cms\Site;
-use Kirby\Panel\Ui\Buttons\LanguagesButton;
+use Kirby\Panel\Ui\Buttons\LanguagesDropdown;
 use Kirby\Panel\Ui\Buttons\PageStatusButton;
 use Kirby\Panel\Ui\Buttons\PreviewButton;
 use Kirby\Panel\Ui\Buttons\SettingsButton;
@@ -25,7 +25,7 @@
 	// `languages` button needs to be in site area, as languages area itself
 	// is only loaded when in multilang setup
 	'languages' => function () {
-		return new LanguagesButton();
+		return new LanguagesDropdown();
 	},
 
 	// file buttons

config/areas/users/buttons.php

@@ -6,7 +6,7 @@
 use Kirby\Toolkit\I18n;
 
 return [
-	'users.add' => function (User $user, string|null $role = null) {
+	'users.create' => function (User $user, string|null $role = null) {
 		return new ViewButton(
 			dialog: 'users/create?role=' . $role,
 			disabled: $user->role()->permissions()->for('users', 'create') !== true,

config/areas/users/views.php

@@ -21,7 +21,7 @@
 				'props'     => [
 					'buttons' => fn () =>
 						ViewButtons::view('users')
-							->defaults('add')
+							->defaults('create')
 							->bind(['role' => $role])
 							->render(),
 					'role' => function () use ($roles, $role) {

panel/src/components/View/Buttons/index.js

@@ -1,4 +1,4 @@
-import Languages from "./LanguagesButton.vue";
+import LanguagesDropdown from "./LanguagesDropdown.vue";
 import Settings from "./SettingsButton.vue";
 import Status from "./StatusButton.vue";
 import Theme from "./ThemeButton.vue";
@@ -8,15 +8,12 @@ import Buttons from "./Buttons.vue";
 
 export default {
 	install(app) {
-		app.component("k-languages-view-button", Languages);
+		app.component("k-languages-dropdown", LanguagesDropdown);
 		app.component("k-settings-view-button", Settings);
 		app.component("k-status-view-button", Status);
 		app.component("k-theme-view-button", Theme);
 
 		app.component("k-view-button", Button);
 		app.component("k-view-buttons", Buttons);
-
-		// @deprecated
-		app.component("k-languages-dropdown", Languages);
 	}
 };

src/Panel/Ui/Buttons/LanguageCreateButton.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Kirby\Panel\Ui\Buttons;
+
+use Kirby\Cms\App;
+use Kirby\Toolkit\I18n;
+
+/**
+ * View button to create a new language
+ *
+ * @package   Kirby Panel
+ * @author    Nico Hoffmann <[email protected]>
+ * @link      https://getkirby.com
+ * @copyright Bastian Allgeier
+ * @license   https://getkirby.com/license
+ * @since     5.0.0
+ * @internal
+ */
+class LanguageCreateButton extends ViewButton
+{
+	public function __construct()
+	{
+		$user       = App::instance()->user();
+		$permission = $user?->role()->permissions()->for('languages', 'create');
+
+		parent::__construct(
+			dialog: 'languages/create',
+			disabled: $permission !== true,
+			icon: 'add',
+			text: I18n::translate('language.create'),
+		);
+	}
+}

src/Panel/Ui/Buttons/LanguageDeleteButton.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Kirby\Panel\Ui\Buttons;
+
+use Kirby\Cms\App;
+use Kirby\Cms\Language;
+use Kirby\Toolkit\I18n;
+
+/**
+ * View button to delete a language
+ *
+ * @package   Kirby Panel
+ * @author    Nico Hoffmann <[email protected]>
+ * @link      https://getkirby.com
+ * @copyright Bastian Allgeier
+ * @license   https://getkirby.com/license
+ * @since     5.0.0
+ * @internal
+ */
+class LanguageDeleteButton extends ViewButton
+{
+	public function __construct(Language $language)
+	{
+		$user       = App::instance()->user();
+		$permission = $user?->role()->permissions()->for('languages', 'delete');
+
+		parent::__construct(
+			dialog: 'languages/' . $language->id() . '/delete',
+			disabled: $permission !== true,
+			icon: 'trash',
+			title: I18n::translate('delete'),
+		);
+	}
+}

src/Panel/Ui/Buttons/LanguageSettingsButton.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Kirby\Panel\Ui\Buttons;
+
+use Kirby\Cms\App;
+use Kirby\Cms\Language;
+use Kirby\Toolkit\I18n;
+
+/**
+ * View button to update settings of a language
+ *
+ * @package   Kirby Panel
+ * @author    Nico Hoffmann <[email protected]>
+ * @link      https://getkirby.com
+ * @copyright Bastian Allgeier
+ * @license   https://getkirby.com/license
+ * @since     5.0.0
+ * @internal
+ */
+class LanguageSettingsButton extends ViewButton
+{
+	public function __construct(Language $language)
+	{
+		$user       = App::instance()->user();
+		$permission = $user?->role()->permissions()->for('languages', 'update');
+
+		parent::__construct(
+			dialog: 'languages/' . $language->id() . '/update',
+			disabled: $permission !== true,
+			icon: 'cog',
+			title: I18n::translate('settings'),
+		);
+	}
+}

src/Panel/Ui/Buttons/LanguagesButton.php → src/Panel/Ui/Buttons/LanguagesDropdown.php

@@ -17,7 +17,7 @@
  * @since     5.0.0
  * @internal
  */
-class LanguagesButton extends ViewButton
+class LanguagesDropdown extends ViewButton
 {
 	protected App $kirby;
 
@@ -26,8 +26,8 @@ public function __construct(
 		$this->kirby = App::instance();
 
 		parent::__construct(
-			component: 'k-languages-view-button',
-			class: 'k-languages-view-button',
+			component: 'k-languages-dropdown',
+			class: 'k-languages-dropdown',
 			icon: 'translate',
 			options: $this->options(),
 			responsive: 'text',

tests/Panel/Ui/Buttons/LanguageCreateButtonTest.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace Kirby\Panel\Ui\Buttons;
+
+use Kirby\Cms\App;
+use Kirby\TestCase;
+
+/**
+ * @coversDefaultClass \Kirby\Panel\Ui\Buttons\LanguageCreateButton
+ */
+class LanguageCreateButtonTest extends TestCase
+{
+	/**
+	 * @covers ::__construct
+	 */
+	public function testButton()
+	{
+		$button = new LanguageCreateButton();
+
+		$this->assertSame('languages/create', $button->dialog);
+		$this->assertSame('Add a new language', $button->text);
+	}
+
+	/**
+	 * @covers ::__construct
+	 */
+	public function testDisabled()
+	{
+		$app = new App([
+			'blueprints' => [
+				'users/editor' => [
+					'name' => 'editor',
+					'permissions' => [
+						'languages' => [
+							'create' => true
+						]
+					]
+				],
+				'users/user' => [
+					'name' => 'user',
+					'permissions' => [
+						'languages' => [
+							'create' => false
+						]
+					]
+				],
+			],
+			'users' => [
+				['email' => '[email protected]', 'role' => 'editor'],
+				['email' => '[email protected]', 'role' => 'user']
+			]
+		]);
+
+		// not authenticated
+		$button = new LanguageCreateButton();
+		$this->assertTrue($button->disabled);
+
+		// with permission
+		$app->impersonate('[email protected]', function () {
+			$button = new LanguageCreateButton();
+			$this->assertFalse($button->disabled);
+		});
+
+		// without permission
+		$app->impersonate('[email protected]', function () {
+			$button = new LanguageCreateButton();
+			$this->assertTrue($button->disabled);
+		});
+	}
+}