Merge branch 'master' into magento2.4.x

thomas-kl1 · thomas-kl1 · commit 6b4e4fa968a7 · 2020-12-31T10:56:09.000+01:00
diff --git a/Api/ExportEntityManagementInterface.php b/Api/ExportEntityManagementInterface.php
@@ -8,6 +8,7 @@
 namespace Opengento\Gdpr\Api;
 
 use Magento\Framework\Exception\AlreadyExistsException;
+use Magento\Framework\Exception\CouldNotDeleteException;
 use Magento\Framework\Exception\CouldNotSaveException;
 use Magento\Framework\Exception\LocalizedException;
 use Opengento\Gdpr\Api\Data\ExportEntityInterface;
@@ -39,4 +40,16 @@ public function create(int $entityId, string $entityType, ?string $fileName = nu
      * @throws LocalizedException
      */
     public function export(ExportEntityInterface $exportEntity): ExportEntityInterface;
+
+    /**
+     * Invalidate the export entity and create a new one to process
+     *
+     * @param ExportEntityInterface $exportEntity
+     * @return ExportEntityInterface
+     * @throws AlreadyExistsException
+     * @throws CouldNotDeleteException
+     * @throws CouldNotSaveException
+     * @throws LocalizedException
+     */
+    public function invalidate(ExportEntityInterface $exportEntity): ExportEntityInterface;
 }
diff --git a/Block/Adminhtml/Action/Edit/BackButton.php b/Block/Adminhtml/Action/Edit/BackButton.php
@@ -30,7 +30,7 @@ public function getButtonData(): array
             'label' => new Phrase('Back'),
             'on_click' => 'location.href = "' . $this->urlBuilder->getUrl('*/*/') . '";',
             'class' => 'back',
-            'sort_order' => 10
+            'sort_order' => 10,
         ];
     }
 }
diff --git a/Block/Adminhtml/Action/Edit/ResetButton.php b/Block/Adminhtml/Action/Edit/ResetButton.php
@@ -18,7 +18,7 @@ public function getButtonData(): array
             'label' => new Phrase('Reset'),
             'class' => 'reset',
             'on_click' => 'location.reload();',
-            'sort_order' => 20
+            'sort_order' => 20,
         ];
     }
 }
diff --git a/Cron/EraseEntityScheduler.php b/Cron/EraseEntityScheduler.php
@@ -11,8 +11,11 @@
 use Exception;
 use Magento\Framework\Api\FilterBuilder;
 use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\Exception\CouldNotSaveException;
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Store\Model\ScopeInterface;
 use Opengento\Gdpr\Model\Config;
+use Opengento\Gdpr\Model\Entity\EntityTypeList;
 use Opengento\Gdpr\Model\Erase\EraseEntityScheduler as EraseEntitySchedulerService;
 use Psr\Log\LoggerInterface;
 
@@ -49,40 +52,50 @@ final class EraseEntityScheduler
     private $filterBuilder;
 
     /**
-     * @var string[]
+     * @var EntityTypeList
      */
-    private $entityTypes;
+    private $entityTypeList;
 
     public function __construct(
         LoggerInterface $logger,
         ScopeConfigInterface $scopeConfig,
         Config $config,
         EraseEntitySchedulerService $eraseEntityScheduler,
         FilterBuilder $filterBuilder,
-        array $entityTypes
+        EntityTypeList $entityTypeList
     ) {
         $this->logger = $logger;
         $this->scopeConfig = $scopeConfig;
         $this->config = $config;
         $this->eraseEntityScheduler = $eraseEntityScheduler;
         $this->filterBuilder = $filterBuilder;
-        $this->entityTypes = $entityTypes;
+        $this->entityTypeList = $entityTypeList;
     }
 
     public function execute(): void
     {
         if ($this->config->isModuleEnabled() && $this->config->isErasureEnabled()) {
             try {
-                $this->filterBuilder->setField('created_at');
-                $this->filterBuilder->setValue(new DateTime('-' . $this->resolveErasureMaxAge() . 'days'));
-                $this->filterBuilder->setConditionType('lteq');
-                $this->eraseEntityScheduler->schedule($this->entityTypes, $this->filterBuilder->create());
+                $this->scheduleEntitiesErasure();
             } catch (Exception $e) {
                 $this->logger->error($e->getMessage(), $e->getTrace());
             }
         }
     }
 
+    /**
+     * @throws CouldNotSaveException
+     * @throws LocalizedException
+     * @throws Exception
+     */
+    private function scheduleEntitiesErasure(): void
+    {
+        $this->filterBuilder->setField('created_at');
+        $this->filterBuilder->setValue(new DateTime('-' . $this->resolveErasureMaxAge() . 'days'));
+        $this->filterBuilder->setConditionType('lteq');
+        $this->eraseEntityScheduler->schedule($this->entityTypeList->getEntityTypes(), $this->filterBuilder->create());
+    }
+
     private function resolveErasureMaxAge(): int
     {
         return (int) $this->scopeConfig->getValue(self::CONFIG_PATH_ERASURE_MAX_AGE, ScopeInterface::SCOPE_STORE);
diff --git a/Model/Action/Erase/CancelAction.php b/Model/Action/Erase/CancelAction.php
@@ -48,7 +48,7 @@ public function execute(ActionContextInterface $actionContext): ActionResultInte
         return $this->createActionResult(
             [
                 ArgumentReader::ERASE_ENTITY => $this->resolveEntity(...$arguments),
-                'canceled' => $this->eraseManagement->cancel(...$arguments)
+                'canceled' => $this->eraseManagement->cancel(...$arguments),
             ]
         );
     }
diff --git a/Model/Action/Erase/CreateAction.php b/Model/Action/Erase/CreateAction.php
@@ -37,7 +37,7 @@ public function execute(ActionContextInterface $actionContext): ActionResultInte
             [
                 ArgumentReader::ERASE_ENTITY => $this->eraseManagement->create(
                     ...$this->getArguments($actionContext)
-                )
+                ),
             ]
         );
     }
diff --git a/Model/Action/Export/CreateAction.php b/Model/Action/Export/CreateAction.php
@@ -37,7 +37,7 @@ public function execute(ActionContextInterface $actionContext): ActionResultInte
             [
                 ArgumentReader::EXPORT_ENTITY => $this->exporter->create(
                     ...$this->getArguments($actionContext)
-                )
+                ),
             ]
         );
     }
diff --git a/Model/Action/Export/CreateOrExportAction.php b/Model/Action/Export/CreateOrExportAction.php
@@ -38,7 +38,7 @@ public function execute(ActionContextInterface $actionContext): ActionResultInte
             [
                 ExportArgumentReader::EXPORT_ENTITY => $this->exportEntityData->export(
                     ...$this->getArguments($actionContext)
-                )
+                ),
             ]
         );
     }
diff --git a/Model/Action/PerformedBy/AdminUser.php b/Model/Action/PerformedBy/AdminUser.php
@@ -34,8 +34,11 @@ public function __construct(
 
     public function get(): string
     {
-        return self::PERFORMED_BY . ($this->authSession->getUser()
-            ? $this->authSession->getUser()->getData($this->attributeName)
-            : '');
+        return self::PERFORMED_BY . $this->resolveUserName();
+    }
+
+    private function resolveUserName(): string
+    {
+        return $this->authSession->getUser() ? $this->authSession->getUser()->getData($this->attributeName) : 'Unknown';
     }
 }
diff --git a/Model/Config/PrivacyMessage.php b/Model/Config/PrivacyMessage.php
@@ -50,13 +50,7 @@ public function __construct(
 
     public function getDisclosureInformationHtml(): string
     {
-        return $this->blockHtml ?? $this->blockHtml = $this->blockFactory->createBlock(
-            Block::class,
-            ['data' => ['block_id' => (string) $this->scopeConfig->getValue(
-                self::CONFIG_PATH_COOKIE_INFORMATION_BLOCK,
-                ScopeInterface::SCOPE_STORE
-            )]]
-        )->toHtml();
+        return $this->blockHtml ?? $this->blockHtml = $this->createDisclosureInformationBlockHtml();
     }
 
     public function getLearnMoreUrl(): string
@@ -66,4 +60,19 @@ public function getLearnMoreUrl(): string
             ScopeInterface::SCOPE_STORE
         )) ?? '#';
     }
+
+    private function createDisclosureInformationBlockHtml(): string
+    {
+        return $this->blockFactory->createBlock(
+            Block::class,
+            [
+                'data' => [
+                    'block_id' => (string) $this->scopeConfig->getValue(
+                        self::CONFIG_PATH_COOKIE_INFORMATION_BLOCK,
+                        ScopeInterface::SCOPE_STORE
+                    ),
+                ],
+            ]
+        )->toHtml();
+    }
 }
diff --git a/Model/Config/Source/EraseComponents.php b/Model/Config/Source/EraseComponents.php
@@ -64,7 +64,7 @@ private function retrieveDelegateProcessors(): array
             $delegateProcessors[] = $this->retrieveArgument($resolver, 'processors');
         }
 
-        return array_keys(array_merge(...$delegateProcessors));
+        return array_keys(array_merge([], ...$delegateProcessors));
     }
 
     /**
diff --git a/Model/Entity/EntityTypeList.php b/Model/Entity/EntityTypeList.php
@@ -0,0 +1,49 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+declare(strict_types=1);
+
+namespace Opengento\Gdpr\Model\Entity;
+
+use function array_keys;
+use function array_merge;
+
+/**
+ * @api
+ */
+final class EntityTypeList
+{
+    /**
+     * @var string[][]
+     */
+    private $list;
+
+    /**
+     * @var string[]|null
+     */
+    private $entityTypes;
+
+    public function __construct(
+        array $list
+    ) {
+        $this->list = $list;
+    }
+
+    public function getList(): array
+    {
+        return $this->list;
+    }
+
+    public function getEntityTypes(): array
+    {
+        $entityTypes = [];
+
+        foreach ($this->getList() as $types) {
+            $entityTypes[] = array_keys($types);
+        }
+
+        return $this->entityTypes ?? $this->entityTypes = array_merge([], ...$entityTypes);
+    }
+}
diff --git a/Model/Entity/EntityTypeResolver.php b/Model/Entity/EntityTypeResolver.php
@@ -0,0 +1,45 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+declare(strict_types=1);
+
+namespace Opengento\Gdpr\Model\Entity;
+
+use Exception;
+use Magento\Framework\EntityManager\TypeResolver;
+
+/**
+ * @api
+ */
+final class EntityTypeResolver
+{
+    /**
+     * @var TypeResolver
+     */
+    private $typeResolver;
+
+    /**
+     * @var EntityTypeList
+     */
+    private $entityTypeList;
+
+    public function __construct(
+        TypeResolver $typeResolver,
+        EntityTypeList $entityTypeList
+    ) {
+        $this->typeResolver = $typeResolver;
+        $this->entityTypeList = $entityTypeList;
+    }
+
+    /**
+     * @param object $entity
+     * @return string[]
+     * @throws Exception
+     */
+    public function resolve(object $entity): array
+    {
+        return $this->entityTypeList->getList()[$this->typeResolver->resolve($entity)] ?? [];
+    }
+}
diff --git a/Model/ExportEntityManagement.php b/Model/ExportEntityManagement.php
@@ -103,6 +103,13 @@ public function export(ExportEntityInterface $exportEntity): ExportEntityInterfa
         return $exportEntity;
     }
 
+    public function invalidate(ExportEntityInterface $exportEntity): ExportEntityInterface
+    {
+        $this->exportRepository->delete($exportEntity);
+
+        return $this->create($exportEntity->getEntityId(), $exportEntity->getEntityType(), $exportEntity->getFileName());
+    }
+
     private function resolveDefaultFileName(): string
     {
         return (string) $this->scopeConfig->getValue(self::CONFIG_PATH_EXPORT_FILE_NAME, ScopeInterface::SCOPE_STORE);
diff --git a/Observer/InvalidateExport.php b/Observer/InvalidateExport.php
diff --git a/Plugin/SessionChecker.php b/Plugin/SessionChecker.php
diff --git a/TODO.md b/TODO.md
diff --git a/etc/di.xml b/etc/di.xml
diff --git a/etc/events.xml b/etc/events.xml

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public function getButtonData(): array`
`30`	`30`	`'label' => new Phrase('Back'),`
`31`	`31`	`'on_click' => 'location.href = "' . $this->urlBuilder->getUrl('//') . '";',`
`32`	`32`	`'class' => 'back',`
`33`		`- 'sort_order' => 10`
	`33`	`+ 'sort_order' => 10,`
`34`	`34`	`];`
`35`	`35`	`}`
`36`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ public function getButtonData(): array`
`18`	`18`	`'label' => new Phrase('Reset'),`
`19`	`19`	`'class' => 'reset',`
`20`	`20`	`'on_click' => 'location.reload();',`
`21`		`- 'sort_order' => 20`
	`21`	`+ 'sort_order' => 20,`
`22`	`22`	`];`
`23`	`23`	`}`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public function execute(ActionContextInterface $actionContext): ActionResultInte`
`48`	`48`	`return $this->createActionResult(`
`49`	`49`	`[`
`50`	`50`	`ArgumentReader::ERASE_ENTITY => $this->resolveEntity(...$arguments),`
`51`		`- 'canceled' => $this->eraseManagement->cancel(...$arguments)`
	`51`	`+ 'canceled' => $this->eraseManagement->cancel(...$arguments),`
`52`	`52`	`]`
`53`	`53`	`);`
`54`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public function execute(ActionContextInterface $actionContext): ActionResultInte`
`37`	`37`	`[`
`38`	`38`	`ArgumentReader::ERASE_ENTITY => $this->eraseManagement->create(`
`39`	`39`	`...$this->getArguments($actionContext)`
`40`		`- )`
	`40`	`+ ),`
`41`	`41`	`]`
`42`	`42`	`);`
`43`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ public function execute(ActionContextInterface $actionContext): ActionResultInte`
`38`	`38`	`[`
`39`	`39`	`ExportArgumentReader::EXPORT_ENTITY => $this->exportEntityData->export(`
`40`	`40`	`...$this->getArguments($actionContext)`
`41`		`- )`
	`41`	`+ ),`
`42`	`42`	`]`
`43`	`43`	`);`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,8 +34,11 @@ public function __construct(`
`34`	`34`
`35`	`35`	`public function get(): string`
`36`	`36`	`{`
`37`		`- return self::PERFORMED_BY . ($this->authSession->getUser()`
`38`		`- ? $this->authSession->getUser()->getData($this->attributeName)`
`39`		`- : '');`
	`37`	`+ return self::PERFORMED_BY . $this->resolveUserName();`
	`38`	`+ }`
	`39`	`+`
	`40`	`+ private function resolveUserName(): string`
	`41`	`+ {`
	`42`	`+ return $this->authSession->getUser() ? $this->authSession->getUser()->getData($this->attributeName) : 'Unknown';`
`40`	`43`	`}`
`41`	`44`	`}`