Merge branch '5.x' into 6.x

Author: angrybrad

CHANGELOG.md

@@ -2,12 +2,14 @@
 
 ## Unreleased
 
+- Added a `Process::EVENT_COMPARE_CONTENT` to give plugins a chance to manipulate feed data before any content comparison is done. ([#1623](https://github.com/craftcms/feed-me/pull/1623))
 - Fixed an error that could occur when running a feed with nothing to process. ([#1611](https://github.com/craftcms/feed-me/pull/1611))
 - Fixed a bug where duplicate users could get created when importing entry authors with a matching email address. ([#1612](https://github.com/craftcms/feed-me/pull/1612))
 - Fixed a bug where importing into a Matrix field with “Use default value” selected, subfields could use the default value in certain scenarios. ([#1613](https://github.com/craftcms/feed-me/pull/1613))
 - Fixed a bug that could occur on PostgreSQL when using the `setEmptyValues` feed setting. ([#1620](https://github.com/craftcms/feed-me/pull/1620))
 - Fixed a bug that could occur when saving empty ("") values if `compareContent` and “Set Empty Values” were both enabled. ([#1621](https://github.com/craftcms/feed-me/pull/1621))
 - Fixed a bug that could occur when importing into a Matrix field with no blocks. ([#1622](https://github.com/craftcms/feed-me/pull/1622))
+- Fixed a regression that happened in 5.3.0 where imports into relational field would not remove existing relations if it was required. ([#1623](https://github.com/craftcms/feed-me/pull/1623))
 
 ## 6.8.0 - 2025-03-14
 - 

src/events/CompareContentEvent.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace craft\feedme\events;
+
+use craft\base\ElementInterface;
+use yii\base\Event;
+
+/**
+ * Compare content event class.
+ *
+ * @author Pixel & Tonic, Inc. <support@pixelandtonic.com>
+ * @since 5.12.0
+ */
+class CompareContentEvent extends Event
+{
+    // Properties
+    // =========================================================================
+
+    /**
+     * @var array
+     */
+    public array $content;
+
+    /**
+     * @var ElementInterface
+     */
+    public ElementInterface $element;
+
+    /**
+     * @var string
+     */
+    public string $handle;
+
+    /**
+     * @var mixed
+     */
+    public mixed $existingValue;
+
+    /**
+     * @var mixed
+     */
+    public mixed $newValue;
+}

src/helpers/DataHelper.php

@@ -264,13 +264,7 @@ public static function compareElementContent($content, $element): ?bool
         foreach ($content as $key => $newValue) {
             $existingValue = Hash::get($fields, $key);
 
-            [$existingValue, $newValue] = self::prepDatesForComparison($existingValue, $newValue);
-
-            // If array key & values are already within the existing array
-            if (is_array($newValue) && is_array($existingValue) && Hash::contains($existingValue,$newValue)) {
-                unset($trackedChanges[$key]);
-                continue;
-            }
+            [$existingValue, $newValue] = Plugin::$plugin->process->onCompareContent($content, $element, $key, $existingValue, $newValue);
 
             // Check for simple fields first
             if (self::_compareSimpleValues($fields, $key, $existingValue, $newValue)) {

src/services/Process.php

@@ -5,9 +5,11 @@
 use Cake\Utility\Hash;
 use Craft;
 use craft\base\Component;
+use craft\base\ElementInterface as CraftElementInterface;
 use craft\elements\User;
 use craft\errors\ShellCommandException;
 use craft\feedme\base\ElementInterface;
+use craft\feedme\events\CompareContentEvent;
 use craft\feedme\events\FeedProcessEvent;
 use craft\feedme\helpers\DataHelper;
 use craft\feedme\helpers\DuplicateHelper;
@@ -31,6 +33,12 @@ class Process extends Component
     public const EVENT_STEP_AFTER_ELEMENT_SAVE = 'onStepElementSave';
     public const EVENT_AFTER_PROCESS_FEED = 'onAfterProcessFeed';
 
+    /**
+     * @event CompareContentEvent The event that is triggered before content is compared to check for changes.
+     * @since 5.12.0
+     */
+    public const EVENT_COMPARE_CONTENT = 'onCompareContent';
+
 
     // Properties
     // =========================================================================
@@ -618,6 +626,40 @@ public function debugFeed($feed, $limit, $offset, $processedElementIds): void
         }
     }
 
+    /**
+     * Prepare data for content comparison and allow plugins to do so via an event.
+     *
+     * @param array $content
+     * @param CraftElementInterface $element
+     * @param string $key
+     * @param mixed $existingValue
+     * @param mixed $newValue
+     * @return mixed
+     * @since 5.12.0
+     */
+    public function onCompareContent(array $content, CraftElementInterface $element, string $key, mixed $existingValue, mixed $newValue): mixed
+    {
+        [$existingValue, $newValue] = DataHelper::prepDatesForComparison($existingValue, $newValue);
+
+        if ($this->hasEventHandlers(self::EVENT_COMPARE_CONTENT)) {
+            $event = new CompareContentEvent([
+                'content' => $content,
+                'element' => $element,
+                'handle' => $key,
+                'existingValue' => $existingValue,
+                'newValue' => $newValue,
+            ]);
+
+            $this->trigger(self::EVENT_COMPARE_CONTENT, $event);
+
+            // Allow event to overwrite existing and new value to be used for comparison
+            return [$event->existingValue, $event->newValue];
+        }
+
+        // Allow event to overwrite existing and new value to be used for comparison
+        return [$existingValue, $newValue];
+    }
+
 
 
     // Private Methods