From 8ca6cc32b2c789a3149861159ad258f2cb9491e3 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Sun, 28 Apr 2024 14:39:39 +0200
Subject: Adding upstream version 2.11.4.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 .../application/clicommands/PreferencesCommand.php | 131 +++++++++++++++++++++
 1 file changed, 131 insertions(+)
 create mode 100644 modules/migrate/application/clicommands/PreferencesCommand.php

(limited to 'modules/migrate/application/clicommands/PreferencesCommand.php')

diff --git a/modules/migrate/application/clicommands/PreferencesCommand.php b/modules/migrate/application/clicommands/PreferencesCommand.php
new file mode 100644
index 0000000..11d1edb
--- /dev/null
+++ b/modules/migrate/application/clicommands/PreferencesCommand.php
@@ -0,0 +1,131 @@
+<?php
+/* Icinga Web 2 | (c) 2021 Icinga GmbH | GPLv2+ */
+
+namespace Icinga\Module\Migrate\Clicommands;
+
+use Icinga\Application\Config;
+use Icinga\Application\Logger;
+use Icinga\Cli\Command;
+use Icinga\Data\ConfigObject;
+use Icinga\Data\ResourceFactory;
+use Icinga\Exception\NotReadableError;
+use Icinga\Exception\NotWritableError;
+use Icinga\File\Ini\IniParser;
+use Icinga\User;
+use Icinga\User\Preferences\PreferencesStore;
+use Icinga\Util\DirectoryIterator;
+
+class PreferencesCommand extends Command
+{
+    /**
+     * Migrate local INI user preferences to a database
+     *
+     * USAGE
+     *
+     *  icingacli migrate preferences [options]
+     *
+     * OPTIONS:
+     *
+     *  --resource=<resource-name>  The resource to use, if no current database config backend is configured.
+     *  --no-set-config-backend     Do not set the given resource as config backend automatically
+     */
+    public function indexAction()
+    {
+        $resource = Config::app()->get('global', 'config_resource');
+        if (empty($resource)) {
+            $resource = $this->params->getRequired('resource');
+        }
+
+        $resourceConfig = ResourceFactory::getResourceConfig($resource);
+        if ($resourceConfig->db === 'mysql') {
+            $resourceConfig->charset = 'utf8mb4';
+        }
+
+        $connection = ResourceFactory::createResource($resourceConfig);
+
+        $preferencesPath = Config::resolvePath('preferences');
+        if (! file_exists($preferencesPath)) {
+            Logger::info('There are no local user preferences to migrate');
+            return;
+        }
+
+        $rc = 0;
+
+        $preferenceDirs = new DirectoryIterator($preferencesPath);
+        foreach ($preferenceDirs as $preferenceDir) {
+            if (! is_dir($preferenceDir)) {
+                continue;
+            }
+
+            $userName = basename($preferenceDir);
+
+            Logger::info('Migrating INI preferences for user "%s" to database...', $userName);
+
+            $dbStore = new PreferencesStore(new ConfigObject(['connection' => $connection]), new User($userName));
+
+            try {
+                $dbStore->load();
+                $dbStore->save(
+                    new User\Preferences(
+                        $this->loadIniFile($preferencesPath, (new User($userName))->getUsername())
+                    )
+                );
+            } catch (NotReadableError $e) {
+                if ($e->getPrevious() !== null) {
+                    Logger::error('%s: %s', $e->getMessage(), $e->getPrevious()->getMessage());
+                } else {
+                    Logger::error($e->getMessage());
+                }
+
+                $rc = 128;
+            } catch (NotWritableError $e) {
+                Logger::error('%s: %s', $e->getMessage(), $e->getPrevious()->getMessage());
+                $rc = 256;
+            }
+        }
+
+        if ($rc > 0) {
+            Logger::error('Failed to migrate some user preferences');
+            exit($rc);
+        }
+
+        if ($this->params->has('resource') && ! $this->params->has('no-set-config-backend')) {
+            $appConfig = Config::app();
+            $globalConfig = $appConfig->getSection('global');
+            $globalConfig['config_resource'] = $resource;
+
+            try {
+                $appConfig->saveIni();
+            } catch (NotWritableError $e) {
+                Logger::error('Failed to update general configuration: %s', $e->getMessage());
+                exit(256);
+            }
+        }
+
+        Logger::info('Successfully migrated all local user preferences to database');
+    }
+
+    private function loadIniFile(string $filePath, string $username): array
+    {
+        $preferences = [];
+        $preferencesFile = sprintf(
+            '%s/%s/config.ini',
+            $filePath,
+            strtolower($username)
+        );
+
+        if (file_exists($preferencesFile)) {
+            if (! is_readable($preferencesFile)) {
+                throw new NotReadableError(
+                    'Preferences INI file %s for user %s is not readable',
+                    $preferencesFile,
+                    $username
+                );
+            } else {
+                $preferences = IniParser::parseIniFile($preferencesFile)->toArray();
+            }
+        }
+
+        return $preferences;
+    }
+}
-- 
cgit v1.2.3