DictionaryToRow: new property modifier

fixes #2555
Icinga · Jun 24, 2022 · ef80b6b · ef80b6b
1 parent 9a0279b
commit ef80b6b
Show file tree

Hide file tree

Showing 3 changed files with 99 additions and 0 deletions.
diff --git a/doc/82-Changelog.md b/doc/82-Changelog.md
@@ -14,6 +14,9 @@ v1.10.0 (unreleased)
 ### User Interface
 * FIX: links from Service Previews (Icinga DSL) to templates (#2554)
 
+### Import and Sync
+* FEATURE: clone a row for nested Dictionary/Hash entries (#2555)
+
 ### REST API
 * FIX: addressing service templates by name has been fixed (#2487)
 

diff --git a/library/Director/PropertyModifier/PropertyModifierDictionaryToRow.php b/library/Director/PropertyModifier/PropertyModifierDictionaryToRow.php
@@ -0,0 +1,94 @@
+<?php
+
+namespace Icinga\Module\Director\PropertyModifier;
+
+use Icinga\Module\Director\Data\InvalidDataException;
+use Icinga\Module\Director\Hook\PropertyModifierHook;
+use Icinga\Module\Director\Web\Form\QuickForm;
+use InvalidArgumentException;
+use ipl\Html\Error;
+
+class PropertyModifierDictionaryToRow extends PropertyModifierHook
+{
+    public function getName()
+    {
+        return 'Clone the row for every entry of a nested Dictionary/Hash structure';
+    }
+
+    public static function addSettingsFormFields(QuickForm $form)
+    {
+        $form->addElement('text', 'key_column', [
+            'label' => $form->translate('Key Property Name'),
+            'description' => $form->translate(
+                'Every Dictionary entry has a key, its value will be provided in this column'
+            )
+        ]);
+        $form->addElement('select', 'on_empty', [
+            'label'        => $form->translate('When empty'),
+            'description'  => $form->translate('What should we do in case the given value is empty?'),
+            'multiOptions' => $form->optionalEnum([
+                'reject' => $form->translate('Drop the current row'),
+                'fail'   => $form->translate('Let the whole import run fail'),
+                'keep'   => $form->translate('Keep the row, set the column value to null'),
+            ]),
+            'value'    => 'reject',
+            'required' => true,
+        ]);
+    }
+
+    public function requiresRow()
+    {
+        return true;
+    }
+
+    public function hasArraySupport()
+    {
+        return true;
+    }
+
+    public function expandsRows()
+    {
+        return true;
+    }
+
+    public function transform($value)
+    {
+        if (empty($value)) {
+            $onDuplicate = $this->getSetting('on_empty', 'reject');
+            switch ($onDuplicate) {
+                case 'reject':
+                    return [];
+                case 'keep':
+                    return [null];
+                case 'fail':
+                    throw new InvalidArgumentException('Failed to clone row, value is empty');
+                default:
+                    throw new InvalidArgumentException(
+                        "'$onDuplicate' is not a valid 'on_duplicate' setting"
+                    );
+            }
+        }
+
+        $keyColumn = $this->getSetting('key_column');
+
+        if (! \is_object($value)) {
+            throw new InvalidArgumentException(
+                "Object required to clone this row, got " . Error::getPhpTypeName($value)
+            );
+        }
+        $result = [];
+        foreach ($value as $key => $properties) {
+            if (! is_object($properties)) {
+                throw new InvalidDataException(
+                    sprintf('Nested "%s" dictionary', $key),
+                    $properties
+                );
+            }
+
+            $properties->$keyColumn = $key;
+            $result[] = $properties;
+        }
+
+        return $result;
+    }
+}
diff --git a/register-hooks.php b/register-hooks.php
@@ -24,6 +24,7 @@
 use Icinga\Module\Director\PropertyModifier\PropertyModifierArrayUnique;
 use Icinga\Module\Director\PropertyModifier\PropertyModifierBitmask;
 use Icinga\Module\Director\PropertyModifier\PropertyModifierCombine;
+use Icinga\Module\Director\PropertyModifier\PropertyModifierDictionaryToRow;
 use Icinga\Module\Director\PropertyModifier\PropertyModifierDnsRecords;
 use Icinga\Module\Director\PropertyModifier\PropertyModifierExtractFromDN;
 use Icinga\Module\Director\PropertyModifier\PropertyModifierFromAdSid;
@@ -98,6 +99,7 @@
         PropertyModifierArrayUnique::class,
         PropertyModifierBitmask::class,
         PropertyModifierCombine::class,
+        PropertyModifierDictionaryToRow::class,
         PropertyModifierDnsRecords::class,
         PropertyModifierExtractFromDN::class,
         PropertyModifierFromAdSid::class,