[Feature]: Automaticaly set imported element userModification (#418)

* Add userOwner to Queue * Updated Admin namespace and added comment about userOwner * Removed unnecessary escape characters in QueueService Co-authored-by: Matthias Schuhmayer <[email protected]> * Updated latest migration class in Installer --------- Co-authored-by: Matthias Schuhmayer <[email protected]>
pimcore · Aug 26, 2024 · 8ed5742 · 8ed5742
1 parent c69c94d
commit 8ed5742
Show file tree

Hide file tree

Showing 6 changed files with 84 additions and 12 deletions.
diff --git a/doc/04_Import_Execution_Details.md b/doc/04_Import_Execution_Details.md
@@ -47,6 +47,7 @@ The actual processing is the same for both types and consists of following steps
 - Update published state of element based on publish strategy.
 - Process mappings and transformation pipelines for each mapping.
 - Assign transformation result to data element based on data target definition.
+- Assign userModification to data element if possible.
 
 Cleanup jobs are simpler and consist of following steps: 
 - Look for existing data element based on loading strategy.

diff --git a/src/DataSource/Interpreter/AbstractInterpreter.php b/src/DataSource/Interpreter/AbstractInterpreter.php
@@ -23,6 +23,8 @@
 use Pimcore\Log\ApplicationLogger;
 use Pimcore\Log\FileObject;
 use Pimcore\Model\Tool\TmpStore;
+use Pimcore\Tool;
+use Pimcore\Tool\Admin;
 use Psr\Log\LoggerAwareTrait;
 
 abstract class AbstractInterpreter implements InterpreterInterface
@@ -212,10 +214,13 @@ protected function processImportRow(array $data)
             $createQueueItem = $this->deltaChecker->hasChanged($this->configName, $this->idDataIndex, $data);
         }
 
+        // If there is no user logged in, we use the system user (ID 0) as userOwner
+        $userOwner = Admin::getCurrentUser()?->getId() ?? 0;
+
         //create queue item
         if ($createQueueItem) {
             $this->logger->debug(sprintf('Adding item `%s` of `%s` to processing queue.', ($data[$this->idDataIndex] ?? null), $this->configName));
-            $this->queueService->addItemToQueue($this->configName, $this->executionType, ImportProcessingService::JOB_TYPE_PROCESS, json_encode($data));
+            $this->queueService->addItemToQueue($this->configName, $this->executionType, ImportProcessingService::JOB_TYPE_PROCESS, json_encode($data), $userOwner);
         } else {
             $message = sprintf("Import data of item `%s` of `%s` didn't change, not adding to queue.", ($data[$this->idDataIndex] ?? null), $this->configName);
             $this->logger->debug($message);

diff --git a/src/Installer.php b/src/Installer.php
@@ -15,7 +15,7 @@
 
 namespace Pimcore\Bundle\DataImporterBundle;
 
-use Pimcore\Bundle\DataImporterBundle\Migrations\Version20220304130000;
+use Pimcore\Bundle\DataImporterBundle\Migrations\Version20240715160305;
 use Pimcore\Extension\Bundle\Installer\SettingsStoreAwareInstaller;
 use Pimcore\Model\User\Permission;
 
@@ -57,6 +57,6 @@ public function install(): void
 
     public function getLastMigrationVersionClassName(): ?string
     {
-        return Version20220304130000::class;
+        return Version20240715160305::class;
     }
 }
diff --git a/src/Migrations/Version20240715160305.php b/src/Migrations/Version20240715160305.php
@@ -0,0 +1,59 @@
+<?php
+
+/**
+ * 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
+ */
+
+/**
+ * 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\DataImporterBundle\Migrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Pimcore\Bundle\DataImporterBundle\Queue\QueueService;
+use Pimcore\Migrations\BundleAwareMigration;
+
+class Version20240715160305 extends BundleAwareMigration
+{
+    public function up(Schema $schema): void
+    {
+        if ($schema->hasTable(QueueService::QUEUE_TABLE_NAME)) {
+            $queueTable = $schema->getTable(QueueService::QUEUE_TABLE_NAME);
+            $queueTable->addColumn('userOwner', 'integer', ['notnull' => true, 'default' => 0])->setUnsigned(true);
+            $queueTable->addIndex(['userOwner'], 'bundle_index_queue_executiontype_userOwner');
+        }
+    }
+
+    public function down(Schema $schema): void
+    {
+        if ($schema->hasTable(QueueService::QUEUE_TABLE_NAME)) {
+            $queueTable = $schema->getTable(QueueService::QUEUE_TABLE_NAME);
+            $queueTable->dropColumn('userOwner');
+            $queueTable->dropIndex('bundle_index_queue_executiontype_userOwner');
+        }
+    }
+
+    protected function getBundleName(): string
+    {
+        return 'PimcoreDataImporterBundle';
+    }
+}
diff --git a/src/Processing/ImportProcessingService.php b/src/Processing/ImportProcessingService.php
@@ -125,6 +125,7 @@ public function processQueueItem(int $id)
             if (empty($queueItem)) {
                 return;
             }
+            $userOwner = $queueItem['userOwner'];
 
             //get config
             $configName = $queueItem['configName'];
@@ -144,7 +145,7 @@ public function processQueueItem(int $id)
             //process element
             if ($queueItem['jobType'] === self::JOB_TYPE_PROCESS) {
                 $data = json_decode($queueItem['data'], true);
-                $this->processElement($configName, $data, $resolver, $mapping);
+                $this->processElement($configName, $data, $resolver, $mapping, $userOwner);
             } elseif ($queueItem['jobType'] === self::JOB_TYPE_CLEANUP) {
                 $this->cleanupElement($configName, $queueItem['data'], $resolver, $config['processingConfig']['cleanup'] ?? []);
             } else {
@@ -179,7 +180,7 @@ private function flattenArray(array $arr): array
      * @param Resolver $resolver
      * @param MappingConfiguration[] $mapping
      */
-    protected function processElement(string $configName, array $importDataRow, Resolver $resolver, array $mapping)
+    protected function processElement(string $configName, array $importDataRow, Resolver $resolver, array $mapping, int $userOwner)
     {
         $element = null;
         $importDataRowString = implode(', ', $this->flattenArray($importDataRow));
@@ -227,7 +228,9 @@ protected function processElement(string $configName, array $importDataRow, Reso
                 $event = new PreSaveEvent($configName, $importDataRow, $element);
                 $this->eventDispatcher->dispatch($event);
 
-                $element->save();
+                $element
+                    ->setUserModification($userOwner)
+                    ->save();
 
                 $event = new PostSaveEvent($configName, $importDataRow, $element);
                 $this->eventDispatcher->dispatch($event);

diff --git a/src/Queue/QueueService.php b/src/Queue/QueueService.php
@@ -51,25 +51,26 @@ protected function getCurrentQueueTableOperationTime(): int
      *
      * @throws Exception
      */
-    public function addItemToQueue(string $configName, string $executionType, string $jobType, string $data): void
+    public function addItemToQueue(string $configName, string $executionType, string $jobType, string $data, int $userOwner = 0): void
     {
         $db = $this->getDb();
         try {
             $db->executeQuery(sprintf(
                 'INSERT INTO %s (%s) VALUES (%s) ON DUPLICATE KEY UPDATE timestamp = VALUES(timestamp)',
                 self::QUEUE_TABLE_NAME,
-                implode(',', ['timestamp', 'configName', 'data', 'executionType', 'jobType']),
+                implode(',', ['timestamp', 'configName', 'data', 'executionType', 'jobType', 'userOwner']),
                 implode(',', [
                     $this->getCurrentQueueTableOperationTime(),
                     $db->quote($configName),
                     $db->quote($data),
                     $db->quote($executionType),
-                    $db->quote($jobType)
+                    $db->quote($jobType),
+                    $userOwner
                 ])
             ));
         } catch (TableNotFoundException $exception) {
-            $this->createQueueTableIfNotExisting(function () use ($configName, $executionType, $jobType, $data) {
-                $this->addItemToQueue($configName, $executionType, $jobType, $data);
+            $this->createQueueTableIfNotExisting(function () use ($configName, $executionType, $jobType, $data, $userOwner) {
+                $this->addItemToQueue($configName, $executionType, $jobType, $data, $userOwner);
             });
         }
     }
@@ -86,6 +87,8 @@ protected function createQueueTableIfNotExisting(\Closure $callable = null)
         $this->getDb()->executeQuery(sprintf('CREATE TABLE IF NOT EXISTS %s (
             id bigint AUTO_INCREMENT,
             timestamp bigint NULL,
+            userOwner int unsigned NOT NULL DEFAULT 0,
+
             configName varchar(80) NULL,
             `data` TEXT null,
             executionType varchar(20) NULL,
@@ -95,7 +98,8 @@ protected function createQueueTableIfNotExisting(\Closure $callable = null)
             PRIMARY KEY (id),
             KEY `bundle_index_queue_configName_index` (`configName`),
             KEY `bundle_index_queue_executiontype_workerId` (`executionType`, `workerId`),
-            KEY `bundle_index_queue_configName_index_executionType` (`configName`, `executionType`))
+            KEY `bundle_index_queue_configName_index_executionType` (`configName`, `executionType`),
+            KEY `bundle_index_queue_executiontype_userOwner` (`userOwner`))
         ', self::QUEUE_TABLE_NAME));
 
         if ($callable) {