Fix: Replace multiline_text fields when prefixed with #replace (#458)

* Fix: Replace multiline_text fields when prefixed with #replace

- If a new value for a multiline_text field starts with "#replace", the old value is completely replaced instead of being concatenated.
- The "#replace" tag is removed before storing the new value.
- Default behavior remains unchanged for other cases.

* Fix: Add multiline_value_replace field and update function setValueForItemtype()

* fix: use dedicated function for adding fields to the database
refactor: renamed multiline_value_replace to replace_multiline_value

* refactor: renamed multiline_value_replace to replace_multiline_value

* fix: remove whitespace

* update changelog for 2.15.0

* update: changelog

Author: JeremieMercier

CHANGELOG.md

@@ -12,6 +12,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Use `global`  configuration for injection links
 - Escape  data when check if already exist
 
+## [Unreleased]
+
+### Added
+
+- Add option to `replace` (instead of `append`)  the value of multiline text fields (e.g. `comment`)
+
 ## [2.14.1] - 2024-12-27
 
 ### Added

hook.php

@@ -67,6 +67,7 @@ function plugin_datainjection_install()
             plugin_datainjection_migration_251_252($migration);
             plugin_datainjection_migration_264_270($migration);
             plugin_datainjection_migration_2121_2122($migration);
+            plugin_datainjection_migration_2141_2150($migration);
             break;
 
         case 0:
@@ -91,6 +92,7 @@ function plugin_datainjection_install()
                      `float_format` tinyint NOT NULL DEFAULT '0',
                      `port_unicity` tinyint NOT NULL DEFAULT '0',
                      `step` int NOT NULL DEFAULT '0',
+                     `replace_multiline_value` tinyint NOT NULL DEFAULT '0',
                      PRIMARY KEY  (`id`)
                    ) ENGINE=InnoDB DEFAULT CHARSET={$default_charset} COLLATE={$default_collation} ROW_FORMAT=DYNAMIC;";
             $DB->doQueryOrDie($query, $DB->error());
@@ -196,6 +198,7 @@ function plugin_datainjection_install()
             plugin_datainjection_migration_264_270($migration);
             plugin_datainjection_migration_290_2100($migration);
             plugin_datainjection_migration_2121_2122($migration);
+            plugin_datainjection_migration_2141_2150($migration);
             break;
 
         default:
@@ -233,6 +236,19 @@ function plugin_datainjection_uninstall()
     return true;
 }
 
+function plugin_datainjection_migration_2141_2150(Migration $migration)
+{
+    $migration->setVersion('2.15.0');
+
+    $migration->addField(
+        'glpi_plugin_datainjection_models',
+        'replace_multiline_value',
+        'bool'
+    );
+
+    $migration->executeMigration();
+}
+
 function plugin_datainjection_migration_2121_2122(Migration $migration)
 {
 

inc/commoninjectionlib.class.php

@@ -139,7 +139,8 @@ public function setDefaultValues(): void
             'overwrite_notempty_fields' => false,
             'can_add'                   => false,
             'can_update'                => false,
-            'can_delete'                => false
+            'can_delete'                => false,
+            'replace_multiline_value'   => false,
         ];
 
        //Field format options
@@ -943,10 +944,14 @@ private function setValueForItemtype($itemtype, $field, $value, $fromdb = false)
             $option = self::findSearchOption($injectionClass->getOptions($itemtype), $field);
 
             if (isset($option['displaytype']) && $option['displaytype'] == 'multiline_text') {
-                if ($fromdb) {
-                    $this->values[$itemtype][$field] = $value . "\n" . $this->values[$itemtype][$field];
-                } else {
-                    $this->values[$itemtype][$field] = $this->values[$itemtype][$field] . "\n" . $value;
+                // If replace_multiline_value is true, the old value is replaced with the new value
+                // else, the new value is added to the old value
+                if (!$this->rights['replace_multiline_value']) {
+                    if ($fromdb) {
+                        $this->values[$itemtype][$field] = $value . "\n" . $this->values[$itemtype][$field];
+                    } else {
+                        $this->values[$itemtype][$field] = $this->values[$itemtype][$field] . "\n" . $value;
+                    }
                 }
             } else if (
                 ($fromdb && $value && !$this->rights['overwrite_notempty_fields'])

inc/engine.class.php

@@ -131,6 +131,7 @@ public function injectLine($line, $index)
        //Rights options
         $rights = ['add_dropdown'              => $this->getModel()->getCanAddDropdown(),
             'overwrite_notempty_fields' => $this->getModel()->getCanOverwriteIfNotEmpty(),
+            'replace_multiline_value'   => $this->getModel()->getReplaceMultilineValue(),
             'can_add'                   => $this->model->getBehaviorAdd(),
             'can_update'                => $this->model->getBehaviorUpdate(),
             'can_delete'                => false

inc/model.class.php

@@ -252,6 +252,13 @@ public function getPortUnicity()
     }
 
 
+    public function getReplaceMultilineValue()
+    {
+
+        return $this->fields["replace_multiline_value"];
+    }
+
+
     public function getNumberOfMappings()
     {
 
@@ -520,6 +527,14 @@ public function rawSearchOptions()
             'datatype'      => 'bool',
         ];
 
+        $tab[] = [
+            'id'            => 87,
+            'table'         => $this->getTable(),
+            'field'         => 'replace_multiline_value',
+            'name'          => __('Replacing the value of multiline text fields', 'datainjection'),
+            'datatype'      => 'bool',
+        ];
+
         return $tab;
     }
 
@@ -753,6 +768,11 @@ public function showAdvancedForm($ID, $options = [])
             PluginDatainjectionDropdown::portUnicityValues(),
             ['value' => $this->fields['port_unicity']]
         );
+        echo "</td>";
+        echo "<td>" . __('Replacing the value of multiline text fields', 'datainjection') . "</td>";
+        echo "<td>";
+        Dropdown::showYesNo("replace_multiline_value", $this->fields['replace_multiline_value']);
+        echo "</td>";
         echo "</td></tr>";
         if ($ID > 0) {
             $tmp = self::getInstance('csv');