[Task]: Remove system/admin settings remnants (#37)

* fix: create separate service for default key bindings * fix: service name * Remove legacy code and implement fallback in helper * Set default user to null --------- Co-authored-by: mattamon <matthias.schuhmayer@pimcore.com>
pimcore · Apr 21, 2023 · f3d6556 · f3d6556
1 parent 0448842
commit f3d6556
Show file tree

Hide file tree

Showing 4 changed files with 71 additions and 5 deletions.
diff --git a/config/services.yaml b/config/services.yaml
@@ -56,6 +56,11 @@ services:
 
     Pimcore\Bundle\AdminBundle\Helper\GridHelperService: ~
 
+    #
+    # User Helper Service
+    #
+
+    Pimcore\Bundle\AdminBundle\Helper\User: ~
 
     #
     # Default Preview Generator

diff --git a/src/Controller/Admin/UserController.php b/src/Controller/Admin/UserController.php
@@ -18,6 +18,7 @@
 
 use Pimcore\Bundle\AdminBundle\Controller\AdminController;
 use Pimcore\Bundle\AdminBundle\HttpFoundation\JsonResponse;
+use Pimcore\Bundle\AdminBundle\Helper\User as UserHelper;
 use Pimcore\Controller\KernelControllerEventInterface;
 use Pimcore\Logger;
 use Pimcore\Model\Asset;
@@ -367,7 +368,6 @@ public function updateAction(Request $request): JsonResponse
                 $tmpArray[] = json_decode($item, true);
             }
             $tmpArray = array_values(array_filter($tmpArray));
-            $tmpArray = User::strictKeybinds($tmpArray);
             $tmpArray = json_encode($tmpArray);
 
             $user->setKeyBindings($tmpArray);
@@ -637,7 +637,7 @@ public function getCurrentUserAction(Request $request): Response
         $userData = $user->getObjectVars();
         $contentLanguages = Tool\Admin::reorderWebsiteLanguages($user, Tool::getValidLanguages());
         $userData['contentLanguages'] = $contentLanguages;
-        $userData['keyBindings'] = $user->getKeyBindings();
+        $userData['keyBindings'] = UserHelper::getDefaultKeyBindings($user);
 
         unset($userData['password']);
         $userData['twoFactorAuthentication'] = $user->getTwoFactorAuthentication();
@@ -1120,9 +1120,7 @@ public function getRolesAction(Request $request): JsonResponse
      */
     public function getDefaultKeyBindingsAction(Request $request): JsonResponse
     {
-        $data = User::getDefaultKeyBindings();
-
-        return $this->adminJson(['success' => true, 'data' => $data]);
+        return $this->adminJson(['success' => true, 'data' => UserHelper::getDefaultKeyBindings()]);
     }
 
     /**

diff --git a/src/DependencyInjection/PimcoreAdminExtension.php b/src/DependencyInjection/PimcoreAdminExtension.php
@@ -66,6 +66,7 @@ public function load(array $configs, ContainerBuilder $container): void
         $container->setParameter('pimcore_admin.admin_languages', $config['admin_languages']);
         $container->setParameter('pimcore_admin.custom_admin_path_identifier', $config['custom_admin_path_identifier']);
         $container->setParameter('pimcore_admin.custom_admin_route_name', $config['custom_admin_route_name']);
+        $container->setParameter('pimcore_admin.user', $config['user']);
 
         $container->setParameter('pimcore_admin.config', $config);
 

diff --git a/src/Helper/User.php b/src/Helper/User.php
@@ -0,0 +1,62 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+namespace Pimcore\Bundle\AdminBundle\Helper;
+
+use Pimcore;
+use Pimcore\Bundle\AdminBundle\Security\User\User as UserProxy;
+
+/**
+ * @internal
+ */
+final class User
+{
+    protected const DEFAULT_KEY_BINDINGS = 'default_key_bindings';
+
+    /**
+     * @internal
+     *
+     * @return string
+     */
+    public static function getDefaultKeyBindings(Pimcore\Model\User|UserProxy|null $user = null): string
+    {
+        if(method_exists($user, 'getKeyBindings') && $user->getKeyBindings()) {
+            return $user->getKeyBindings();
+        }
+
+        $defaultKeyBindings = [];
+        $container = Pimcore::getContainer();
+        $userConfig = $container->getParameter('pimcore_admin.user');
+        // make sure the default key binding node is in the config
+        if (is_array($userConfig) && array_key_exists(self::DEFAULT_KEY_BINDINGS, $userConfig)) {
+            $defaultKeyBindingsConfig = $userConfig[self::DEFAULT_KEY_BINDINGS];
+            if (!empty($defaultKeyBindingsConfig)) {
+                foreach ($defaultKeyBindingsConfig as $keys) {
+                    $defaultKeyBinding = [];
+                    // we do not check if the keys are empty because key is required
+                    foreach ($keys as $index => $value) {
+                        if ($index === 'key') {
+                            $value = ord($value);
+                        }
+                        $defaultKeyBinding[$index] = $value;
+                    }
+                    $defaultKeyBindings[] = $defaultKeyBinding;
+                }
+            }
+        }
+        return json_encode($defaultKeyBindings);
+    }
+}