From c1e0bd26bbd23ba4ee0cd3d3714e07182992eb90 Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Fri, 29 Mar 2019 11:39:02 +0100 Subject: [PATCH 01/75] do not force reload after save --- Model/Archive/Zip.php | 2 +- Model/EraseCustomerRepository.php | 4 +++- Model/ResourceModel/EraseCustomer/Collection.php | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/Model/Archive/Zip.php b/Model/Archive/Zip.php index bb57500..21362e0 100644 --- a/Model/Archive/Zip.php +++ b/Model/Archive/Zip.php @@ -15,7 +15,7 @@ * Zip compressed file archive with local file name. * @api */ -class Zip implements ArchiveInterface +final class Zip implements ArchiveInterface { /** * @var \Magento\Framework\Filesystem diff --git a/Model/EraseCustomerRepository.php b/Model/EraseCustomerRepository.php index 606b261..90b9e8c 100644 --- a/Model/EraseCustomerRepository.php +++ b/Model/EraseCustomerRepository.php @@ -89,7 +89,9 @@ public function save(EraseCustomerInterface $entity): EraseCustomerInterface { try { $this->eraseCustomerResource->save($entity); - $entity = $this->getById($entity->getEntityId(), true); + + $this->instances[$entity->getEntityId()] = $entity; + $this->instancesByCustomer[$entity->getCustomerId()] = $entity; } catch (\Exception $e) { throw new CouldNotSaveException(new Phrase('Could not save the entity.'), $e); } diff --git a/Model/ResourceModel/EraseCustomer/Collection.php b/Model/ResourceModel/EraseCustomer/Collection.php index 295d282..d7176b7 100755 --- a/Model/ResourceModel/EraseCustomer/Collection.php +++ b/Model/ResourceModel/EraseCustomer/Collection.php @@ -15,7 +15,7 @@ /** * Erase Customer Scheduler Collection */ -class Collection extends AbstractCollection +final class Collection extends AbstractCollection { /** * {@inheritdoc} From 0c42f8c73bf836fb2c695a05cb4f24bd1bd35ee0 Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Fri, 29 Mar 2019 18:17:52 +0100 Subject: [PATCH 02/75] WIP entity value processor --- Model/Entity/EntityIterator.php | 48 +++++++++++++++++ Model/Entity/EntityIteratorInterface.php | 22 ++++++++ .../EntityValue/CustomAttributesProcessor.php | 54 +++++++++++++++++++ Model/Entity/EntityValue/DefaultProcessor.php | 38 +++++++++++++ .../EntityValue/ExtensibleDataProcessor.php | 53 ++++++++++++++++++ .../Entity/EntityValue/StrategyProcessor.php | 40 ++++++++++++++ .../Entity/EntityValueProcessorInterface.php | 24 +++++++++ Service/Anonymize/ConfigInterface.php | 21 ++++++++ .../EntityValue/VirtualProcessor.php | 41 ++++++++++++++ Service/Anonymize/VirtualConfig.php | 54 +++++++++++++++++++ Service/Export/ConfigInterface.php | 21 ++++++++ .../EntityValue/VirtualProcessor.php | 41 ++++++++++++++ .../Utils/CompositeDataFilterProcessor.php | 45 ---------------- .../Utils/CustomAttributesFilterProcessor.php | 40 -------------- .../Processor/Utils/DataFilterProcessor.php | 26 --------- .../Utils/DataFilterProcessorInterface.php | 24 --------- .../Utils/ExtensibleDataFilterProcessor.php | 40 -------------- Service/Export/VirtualConfig.php | 54 +++++++++++++++++++ etc/di.xml | 15 ------ 19 files changed, 511 insertions(+), 190 deletions(-) create mode 100644 Model/Entity/EntityIterator.php create mode 100644 Model/Entity/EntityIteratorInterface.php create mode 100644 Model/Entity/EntityValue/CustomAttributesProcessor.php create mode 100644 Model/Entity/EntityValue/DefaultProcessor.php create mode 100644 Model/Entity/EntityValue/ExtensibleDataProcessor.php create mode 100644 Model/Entity/EntityValue/StrategyProcessor.php create mode 100644 Model/Entity/EntityValueProcessorInterface.php create mode 100644 Service/Anonymize/ConfigInterface.php create mode 100644 Service/Anonymize/Processor/EntityValue/VirtualProcessor.php create mode 100644 Service/Anonymize/VirtualConfig.php create mode 100644 Service/Export/ConfigInterface.php create mode 100644 Service/Export/Processor/EntityValue/VirtualProcessor.php delete mode 100644 Service/Export/Processor/Utils/CompositeDataFilterProcessor.php delete mode 100644 Service/Export/Processor/Utils/CustomAttributesFilterProcessor.php delete mode 100644 Service/Export/Processor/Utils/DataFilterProcessor.php delete mode 100644 Service/Export/Processor/Utils/DataFilterProcessorInterface.php delete mode 100644 Service/Export/Processor/Utils/ExtensibleDataFilterProcessor.php create mode 100644 Service/Export/VirtualConfig.php diff --git a/Model/Entity/EntityIterator.php b/Model/Entity/EntityIterator.php new file mode 100644 index 0000000..525d8b7 --- /dev/null +++ b/Model/Entity/EntityIterator.php @@ -0,0 +1,48 @@ +hydrator = $hydrator; + $this->processor = $processor; + } + + /** + * {@inheritdoc} + */ + public function iterate($entity): void + { + foreach ($this->hydrator->extract($entity) as $key => $value) { + $this->processor->process($entity, $key, $value); + } + } +} diff --git a/Model/Entity/EntityIteratorInterface.php b/Model/Entity/EntityIteratorInterface.php new file mode 100644 index 0000000..2096397 --- /dev/null +++ b/Model/Entity/EntityIteratorInterface.php @@ -0,0 +1,22 @@ +processor = $processor; + } + + /** + * {@inheritdoc} + */ + public function process($entity, string $key, $value): void + { + if ($this->isValid($entity, $key)) { + $this->processor->process($entity, $key, $value); + } + } + + /** + * Check wether the entity object and the value key are valid + * + * @param object $entity + * @param string $key + * @return bool + */ + private function isValid($entity, string $key): bool + { + return $entity instanceof CustomAttributesDataInterface && + $key === CustomAttributesDataInterface::CUSTOM_ATTRIBUTES; + } +} diff --git a/Model/Entity/EntityValue/DefaultProcessor.php b/Model/Entity/EntityValue/DefaultProcessor.php new file mode 100644 index 0000000..e4854f6 --- /dev/null +++ b/Model/Entity/EntityValue/DefaultProcessor.php @@ -0,0 +1,38 @@ +processor = $processor; + } + + /** + * {@inheritdoc} + */ + public function process($entity, string $key, $value): void + { + $this->processor->process($entity, $key, $value); + } +} diff --git a/Model/Entity/EntityValue/ExtensibleDataProcessor.php b/Model/Entity/EntityValue/ExtensibleDataProcessor.php new file mode 100644 index 0000000..1eb2753 --- /dev/null +++ b/Model/Entity/EntityValue/ExtensibleDataProcessor.php @@ -0,0 +1,53 @@ +processor = $processor; + } + + /** + * {@inheritdoc} + */ + public function process($entity, string $key, $value): void + { + if ($this->isValid($entity, $key)) { + $this->processor->process($entity, $key, $value); + } + } + + /** + * Check wether the entity object and the value key are valid + * + * @param object $entity + * @param string $key + * @return bool + */ + private function isValid($entity, string $key): bool + { + return $entity instanceof ExtensibleDataInterface && $key === ExtensibleDataInterface::EXTENSION_ATTRIBUTES_KEY; + } +} diff --git a/Model/Entity/EntityValue/StrategyProcessor.php b/Model/Entity/EntityValue/StrategyProcessor.php new file mode 100644 index 0000000..9bbb0aa --- /dev/null +++ b/Model/Entity/EntityValue/StrategyProcessor.php @@ -0,0 +1,40 @@ +processors = (static function (EntityValueProcessorInterface ...$processors): array { + return $processors; + })(...$processors); + } + + /** + * {@inheritdoc} + */ + public function process($entity, string $key, $value): void + { + ($this->processors[$key] ?? $this->processors['default'])->process($entity, $key, $value); + } +} diff --git a/Model/Entity/EntityValueProcessorInterface.php b/Model/Entity/EntityValueProcessorInterface.php new file mode 100644 index 0000000..ba2914c --- /dev/null +++ b/Model/Entity/EntityValueProcessorInterface.php @@ -0,0 +1,24 @@ +config = $config; + } + + /** + * {@inheritdoc} + */ + public function process($entity, string $key, $value): void + { + if (\in_array($key, $this->config->getAttributes())) { + // todo anonymize value and push it in the entity object + } + } +} diff --git a/Service/Anonymize/VirtualConfig.php b/Service/Anonymize/VirtualConfig.php new file mode 100644 index 0000000..a67ae11 --- /dev/null +++ b/Service/Anonymize/VirtualConfig.php @@ -0,0 +1,54 @@ +scopeConfig = $scopeConfig; + $this->configPath = $configPath; + $this->scopeType = $scopeType; + } + + /** + * {@inheritdoc} + */ + public function getAttributes(?string $scopeCode = null): array + { + return \explode(',', $this->scopeConfig->getValue($this->configPath, $this->scopeType, $scopeCode) ?? ''); + } +} diff --git a/Service/Export/ConfigInterface.php b/Service/Export/ConfigInterface.php new file mode 100644 index 0000000..86b39eb --- /dev/null +++ b/Service/Export/ConfigInterface.php @@ -0,0 +1,21 @@ +config = $config; + } + + /** + * {@inheritdoc} + */ + public function process($entity, string $key, $value): void + { + if (\in_array($key, $this->config->getAttributes())) { + // todo Add value to the Container of DocumentInterface from the export service + } + } +} diff --git a/Service/Export/Processor/Utils/CompositeDataFilterProcessor.php b/Service/Export/Processor/Utils/CompositeDataFilterProcessor.php deleted file mode 100644 index 1898437..0000000 --- a/Service/Export/Processor/Utils/CompositeDataFilterProcessor.php +++ /dev/null @@ -1,45 +0,0 @@ -processorPool = $processorPool; - } - - /** - * {@inheritdoc} - */ - public function execute(array $scheme, array $data): array - { - $result = []; - - /** @var \Opengento\Gdpr\Service\Export\Processor\Utils\DataFilterProcessorInterface $processor */ - foreach ($this->processorPool->getIterator() as $processor) { - $result[] = $processor->execute($scheme, $data); - } - - return \array_merge(...$result); - } -} diff --git a/Service/Export/Processor/Utils/CustomAttributesFilterProcessor.php b/Service/Export/Processor/Utils/CustomAttributesFilterProcessor.php deleted file mode 100644 index bd5b6c0..0000000 --- a/Service/Export/Processor/Utils/CustomAttributesFilterProcessor.php +++ /dev/null @@ -1,40 +0,0 @@ -dataFilterProcessor = $dataFilterProcessor; - } - - /** - * {@inheritdoc} - */ - public function execute(array $scheme, array $data = []): array - { - return isset($data[CustomAttributesDataInterface::CUSTOM_ATTRIBUTES]) - ? $this->dataFilterProcessor->execute($scheme, $data[CustomAttributesDataInterface::CUSTOM_ATTRIBUTES]) - : []; - } -} diff --git a/Service/Export/Processor/Utils/DataFilterProcessor.php b/Service/Export/Processor/Utils/DataFilterProcessor.php deleted file mode 100644 index 344f7c6..0000000 --- a/Service/Export/Processor/Utils/DataFilterProcessor.php +++ /dev/null @@ -1,26 +0,0 @@ -dataFilterProcessor = $dataFilterProcessor; - } - - /** - * {@inheritdoc} - */ - public function execute(array $scheme, array $data = []): array - { - return $data[ExtensibleDataInterface::EXTENSION_ATTRIBUTES_KEY] - ? $this->dataFilterProcessor->execute($scheme, $data[ExtensibleDataInterface::EXTENSION_ATTRIBUTES_KEY]) - : []; - } -} diff --git a/Service/Export/VirtualConfig.php b/Service/Export/VirtualConfig.php new file mode 100644 index 0000000..e41fd94 --- /dev/null +++ b/Service/Export/VirtualConfig.php @@ -0,0 +1,54 @@ +scopeConfig = $scopeConfig; + $this->configPath = $configPath; + $this->scopeType = $scopeType; + } + + /** + * {@inheritdoc} + */ + public function getAttributes(?string $scopeCode = null): array + { + return \explode(',', $this->scopeConfig->getValue($this->configPath, $this->scopeType, $scopeCode) ?? ''); + } +} diff --git a/etc/di.xml b/etc/di.xml index 6c57bb3..293d8ff 100644 --- a/etc/di.xml +++ b/etc/di.xml @@ -55,21 +55,6 @@ - - - Opengento\Gdpr\Service\Export\Processor\Utils\DataFilterProcessorInterface - - Opengento\Gdpr\Service\Export\Processor\Utils\DataFilterProcessor - Opengento\Gdpr\Service\Export\Processor\Utils\CustomAttributesFilterProcessor - Opengento\Gdpr\Service\Export\Processor\Utils\ExtensibleDataFilterProcessor - - - - - - Opengento\Gdpr\Service\Export\Processor\Utils\ProcessorPool - - Opengento\Gdpr\Service\Export\ProcessorInterface From f8e1883b1bb83a50d4b9d50937ca03206319a5fc Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Thu, 18 Apr 2019 17:56:37 +0200 Subject: [PATCH 03/75] implement export entity iterator --- Model/Config.php | 22 - .../Entity/EntityValue/StrategyProcessor.php | 4 +- Service/Anonymize/AccountBlocker.php | 2 + .../Processor/Entity/Config.php} | 6 +- .../Processor/Entity}/ConfigInterface.php | 2 +- .../EntityValue/Processor.php} | 14 +- Service/AnonymizeManagement.php | 1 + Service/DeleteManagement.php | 1 + .../CustomerAddressDataProcessor.php | 51 +-- .../Processor/CustomerDataProcessor.php | 43 +- .../Processor/Entity/Config.php} | 6 +- .../Processor/Entity}/ConfigInterface.php | 2 +- .../Export/Processor/Entity/DataCollector.php | 48 +++ .../Entity/DataCollectorInterface.php | 22 + Service/Export/Processor/Entity/Document.php | 54 +++ .../Processor/Entity/DocumentInterface.php | 38 ++ .../Entity/EntityValue/Processor.php | 50 +++ .../EntityValue/VirtualProcessor.php | 41 -- .../Export/Processor/OrderDataProcessor.php | 31 +- .../Export/Processor/QuoteDataProcessor.php | 31 +- .../Processor/SubscriberDataProcessor.php | 13 +- Service/ExportManagement.php | 1 + etc/di.xml | 375 ++++++++++++++++++ view/frontend/templates/messages/popup.phtml | 2 +- 24 files changed, 654 insertions(+), 206 deletions(-) rename Service/{Export/VirtualConfig.php => Anonymize/Processor/Entity/Config.php} (90%) rename Service/{Export => Anonymize/Processor/Entity}/ConfigInterface.php (84%) rename Service/Anonymize/Processor/{EntityValue/VirtualProcessor.php => Entity/EntityValue/Processor.php} (55%) rename Service/{Anonymize/VirtualConfig.php => Export/Processor/Entity/Config.php} (90%) rename Service/{Anonymize => Export/Processor/Entity}/ConfigInterface.php (85%) create mode 100644 Service/Export/Processor/Entity/DataCollector.php create mode 100644 Service/Export/Processor/Entity/DataCollectorInterface.php create mode 100644 Service/Export/Processor/Entity/Document.php create mode 100644 Service/Export/Processor/Entity/DocumentInterface.php create mode 100644 Service/Export/Processor/Entity/EntityValue/Processor.php delete mode 100644 Service/Export/Processor/EntityValue/VirtualProcessor.php diff --git a/Model/Config.php b/Model/Config.php index 3f579c8..c2956c8 100644 --- a/Model/Config.php +++ b/Model/Config.php @@ -31,8 +31,6 @@ final class Config public const CONFIG_PATH_EXPORT_ENABLED = 'gdpr/export/enabled'; public const CONFIG_PATH_EXPORT_INFORMATION_BLOCK = 'gdpr/export/block_id'; public const CONFIG_PATH_EXPORT_RENDERER = 'gdpr/export/renderer'; - public const CONFIG_PATH_EXPORT_CUSTOMER_ATTRIBUTES = 'gdpr/export/customer_attributes'; - public const CONFIG_PATH_EXPORT_CUSTOMER_ADDRESS_ATTRIBUTES = 'gdpr/export/customer_address_attributes'; public const CONFIG_PATH_COOKIE_DISCLOSURE_ENABLED = 'gdpr/cookie/enabled'; public const CONFIG_PATH_COOKIE_INFORMATION_BLOCK = 'gdpr/cookie/block_id'; /**#@-*/ @@ -181,26 +179,6 @@ public function getExportRendererCode(): string return $this->getValueString(self::CONFIG_PATH_EXPORT_RENDERER, ScopeInterface::SCOPE_STORE); } - /** - * Retrieve the export customer attributes codes - * - * @return array - */ - public function getExportCustomerAttributes(): array - { - return $this->getValueArray(self::CONFIG_PATH_EXPORT_CUSTOMER_ATTRIBUTES, ScopeInterface::SCOPE_STORE); - } - - /** - * Retrieve the export customer address attributes codes - * - * @return array - */ - public function getExportCustomerAddressAttributes(): array - { - return $this->getValueArray(self::CONFIG_PATH_EXPORT_CUSTOMER_ADDRESS_ATTRIBUTES, ScopeInterface::SCOPE_STORE); - } - /** * Check if the cookie disclosure is enabled * diff --git a/Model/Entity/EntityValue/StrategyProcessor.php b/Model/Entity/EntityValue/StrategyProcessor.php index 9bbb0aa..28fe920 100644 --- a/Model/Entity/EntityValue/StrategyProcessor.php +++ b/Model/Entity/EntityValue/StrategyProcessor.php @@ -27,7 +27,9 @@ public function __construct( ) { $this->processors = (static function (EntityValueProcessorInterface ...$processors): array { return $processors; - })(...$processors); + })(...\array_values($processors)); + + $this->processors = \array_combine(\array_keys($processors), $this->processors); } /** diff --git a/Service/Anonymize/AccountBlocker.php b/Service/Anonymize/AccountBlocker.php index e441d97..61690fd 100644 --- a/Service/Anonymize/AccountBlocker.php +++ b/Service/Anonymize/AccountBlocker.php @@ -91,6 +91,7 @@ public function __construct( * @param int $customerId * @return bool * @throws \Magento\Framework\Exception\NoSuchEntityException + * @throws \Magento\Framework\Exception\LocalizedException */ public function invalid(int $customerId): bool { @@ -103,6 +104,7 @@ public function invalid(int $customerId): bool * @param int $customerId * @return bool * @throws \Magento\Framework\Exception\NoSuchEntityException + * @throws \Magento\Framework\Exception\LocalizedException */ private function resetPassword(int $customerId): bool { diff --git a/Service/Export/VirtualConfig.php b/Service/Anonymize/Processor/Entity/Config.php similarity index 90% rename from Service/Export/VirtualConfig.php rename to Service/Anonymize/Processor/Entity/Config.php index e41fd94..9ef9cc7 100644 --- a/Service/Export/VirtualConfig.php +++ b/Service/Anonymize/Processor/Entity/Config.php @@ -5,14 +5,14 @@ */ declare(strict_types=1); -namespace Opengento\Gdpr\Service\Export; +namespace Opengento\Gdpr\Service\Anonymize\Processor\Entity; use Magento\Framework\App\Config\ScopeConfigInterface; /** - * Class VirtualConfig + * Class Config */ -class VirtualConfig implements ConfigInterface +final class Config implements ConfigInterface { /** * @var \Magento\Framework\App\Config\ScopeConfigInterface diff --git a/Service/Export/ConfigInterface.php b/Service/Anonymize/Processor/Entity/ConfigInterface.php similarity index 84% rename from Service/Export/ConfigInterface.php rename to Service/Anonymize/Processor/Entity/ConfigInterface.php index 86b39eb..6af5cf7 100644 --- a/Service/Export/ConfigInterface.php +++ b/Service/Anonymize/Processor/Entity/ConfigInterface.php @@ -4,7 +4,7 @@ * See LICENSE bundled with this library for license details. */ -namespace Opengento\Gdpr\Service\Export; +namespace Opengento\Gdpr\Service\Anonymize\Processor\Entity; /** * Interface ConfigInterface diff --git a/Service/Anonymize/Processor/EntityValue/VirtualProcessor.php b/Service/Anonymize/Processor/Entity/EntityValue/Processor.php similarity index 55% rename from Service/Anonymize/Processor/EntityValue/VirtualProcessor.php rename to Service/Anonymize/Processor/Entity/EntityValue/Processor.php index a77f41f..af5aa60 100644 --- a/Service/Anonymize/Processor/EntityValue/VirtualProcessor.php +++ b/Service/Anonymize/Processor/Entity/EntityValue/Processor.php @@ -5,23 +5,23 @@ */ declare(strict_types=1); -namespace Opengento\Gdpr\Service\Anonymize\Processor\EntityValue; +namespace Opengento\Gdpr\Service\Anonymize\Processor\Entity\EntityValue; use Opengento\Gdpr\Model\Entity\EntityValueProcessorInterface; -use Opengento\Gdpr\Service\Anonymize\ConfigInterface; +use Opengento\Gdpr\Service\Anonymize\Processor\Entity\ConfigInterface; /** - * Class VirtualProcessor + * Class Processor */ -class VirtualProcessor implements EntityValueProcessorInterface +final class Processor implements EntityValueProcessorInterface { /** - * @var \Opengento\Gdpr\Service\Anonymize\ConfigInterface + * @var \Opengento\Gdpr\Service\Anonymize\Processor\Entity\ConfigInterface */ private $config; /** - * @param \Opengento\Gdpr\Service\Anonymize\ConfigInterface $config + * @param \Opengento\Gdpr\Service\Anonymize\Processor\Entity\ConfigInterface $config */ public function __construct( ConfigInterface $config @@ -34,7 +34,7 @@ public function __construct( */ public function process($entity, string $key, $value): void { - if (\in_array($key, $this->config->getAttributes())) { + if (\in_array($key, $this->config->getAttributes(), true)) { // todo anonymize value and push it in the entity object } } diff --git a/Service/AnonymizeManagement.php b/Service/AnonymizeManagement.php index 20f2758..4c5addd 100644 --- a/Service/AnonymizeManagement.php +++ b/Service/AnonymizeManagement.php @@ -62,6 +62,7 @@ public function executeProcessor(string $processorName, int $customerId): bool /** @var \Opengento\Gdpr\Service\Anonymize\ProcessorInterface $processor */ $processor = $this->processorPool->offsetGet($processorName); + return $processor->execute($customerId); } } diff --git a/Service/DeleteManagement.php b/Service/DeleteManagement.php index ec604b9..1d80db5 100644 --- a/Service/DeleteManagement.php +++ b/Service/DeleteManagement.php @@ -62,6 +62,7 @@ public function executeProcessor(string $processorName, int $customerId): bool /** @var \Opengento\Gdpr\Service\Delete\ProcessorInterface $processor */ $processor = $this->processorPool->offsetGet($processorName); + return $processor->execute($customerId); } } diff --git a/Service/Export/Processor/CustomerAddressDataProcessor.php b/Service/Export/Processor/CustomerAddressDataProcessor.php index adc2ea8..5281899 100644 --- a/Service/Export/Processor/CustomerAddressDataProcessor.php +++ b/Service/Export/Processor/CustomerAddressDataProcessor.php @@ -9,9 +9,7 @@ use Magento\Customer\Api\AddressRepositoryInterface; use Magento\Framework\Api\SearchCriteriaBuilder; -use Magento\Framework\Api\SearchResultsInterface; -use Magento\Framework\EntityManager\Hydrator; -use Opengento\Gdpr\Model\Config; +use Opengento\Gdpr\Service\Export\Processor\Entity\DataCollectorInterface; use Opengento\Gdpr\Service\Export\ProcessorInterface; /** @@ -30,31 +28,23 @@ final class CustomerAddressDataProcessor implements ProcessorInterface private $searchCriteriaBuilder; /** - * @var \Magento\Framework\EntityManager\Hydrator + * @var \Opengento\Gdpr\Service\Export\Processor\Entity\DataCollectorInterface */ - private $hydrator; - - /** - * @var \Opengento\Gdpr\Model\Config - */ - private $config; + private $dataCollector; /** * @param \Magento\Customer\Api\AddressRepositoryInterface $addressRepository * @param \Magento\Framework\Api\SearchCriteriaBuilder $searchCriteriaBuilder - * @param \Magento\Framework\EntityManager\Hydrator $hydrator - * @param \Opengento\Gdpr\Model\Config $config + * @param \Opengento\Gdpr\Service\Export\Processor\Entity\DataCollectorInterface $dataCollector */ public function __construct( AddressRepositoryInterface $addressRepository, SearchCriteriaBuilder $searchCriteriaBuilder, - Hydrator $hydrator, - Config $config + DataCollectorInterface $dataCollector ) { $this->addressRepository = $addressRepository; $this->searchCriteriaBuilder = $searchCriteriaBuilder; - $this->hydrator = $hydrator; - $this->config = $config; + $this->dataCollector = $dataCollector; } /** @@ -65,35 +55,12 @@ public function execute(int $customerId, array $data): array { $this->searchCriteriaBuilder->addFilter('parent_id', $customerId); $addressList = $this->addressRepository->getList($this->searchCriteriaBuilder->create()); - $data['customer_addresses'] = $this->generateArray($addressList); - - return $data; - } - - /** - * Collect the customer addresses data to export - * - * @param \Magento\Framework\Api\SearchResultsInterface $searchResults - * @return array - */ - private function generateArray(SearchResultsInterface $searchResults): array - { - $result = []; /** @var \Magento\Customer\Api\Data\AddressInterface $entity */ - foreach ($searchResults->getItems() as $entity) { - $data = []; - $entityData = $this->hydrator->extract($entity); - - foreach ($this->config->getExportCustomerAddressAttributes() as $attributeCode) { - if (isset($entityData[$attributeCode])) { - $data[$attributeCode] = $entityData[$attributeCode]; - } - } - - $result['customer_address_id_' . $entity->getId()] = $data; + foreach ($addressList->getItems() as $entity) { + $data['customer_addresses']['customer_address_id_' . $entity->getId()] = $this->dataCollector->collect($entity); } - return $result; + return $data; } } diff --git a/Service/Export/Processor/CustomerDataProcessor.php b/Service/Export/Processor/CustomerDataProcessor.php index a0f1bc8..a2ae8fa 100644 --- a/Service/Export/Processor/CustomerDataProcessor.php +++ b/Service/Export/Processor/CustomerDataProcessor.php @@ -8,8 +8,7 @@ namespace Opengento\Gdpr\Service\Export\Processor; use Magento\Customer\Api\CustomerRepositoryInterface; -use Magento\Framework\EntityManager\Hydrator; -use Opengento\Gdpr\Model\Config; +use Opengento\Gdpr\Service\Export\Processor\Entity\DataCollectorInterface; use Opengento\Gdpr\Service\Export\ProcessorInterface; /** @@ -23,28 +22,20 @@ final class CustomerDataProcessor implements ProcessorInterface private $customerRepository; /** - * @var \Magento\Framework\EntityManager\Hydrator + * @var \Opengento\Gdpr\Service\Export\Processor\Entity\DataCollectorInterface */ - private $hydrator; - - /** - * @var \Opengento\Gdpr\Model\Config - */ - private $config; + private $dataCollector; /** * @param \Magento\Customer\Api\CustomerRepositoryInterface $customerRepository - * @param \Magento\Framework\EntityManager\Hydrator $hydrator - * @param \Opengento\Gdpr\Model\Config $config + * @param \Opengento\Gdpr\Service\Export\Processor\Entity\DataCollectorInterface $dataCollector */ public function __construct( CustomerRepositoryInterface $customerRepository, - Hydrator $hydrator, - Config $config + DataCollectorInterface $dataCollector ) { $this->customerRepository = $customerRepository; - $this->hydrator = $hydrator; - $this->config = $config; + $this->dataCollector = $dataCollector; } /** @@ -54,27 +45,7 @@ public function __construct( */ public function execute(int $customerId, array $data): array { - $customerData = $this->hydrator->extract($this->customerRepository->getById($customerId)); - $data['customer'] = $this->generateArray($customerData); - - return $data; - } - - /** - * Collect the customer data to export - * - * @param array $customerData - * @return array - */ - private function generateArray(array $customerData): array - { - $data = []; - - foreach ($this->config->getExportCustomerAttributes() as $attributeCode) { - if (isset($customerData[$attributeCode])) { - $data[$attributeCode] = $customerData[$attributeCode]; - } - } + $data['customer'] = $this->dataCollector->collect($this->customerRepository->getById($customerId)); return $data; } diff --git a/Service/Anonymize/VirtualConfig.php b/Service/Export/Processor/Entity/Config.php similarity index 90% rename from Service/Anonymize/VirtualConfig.php rename to Service/Export/Processor/Entity/Config.php index a67ae11..cea9f9c 100644 --- a/Service/Anonymize/VirtualConfig.php +++ b/Service/Export/Processor/Entity/Config.php @@ -5,14 +5,14 @@ */ declare(strict_types=1); -namespace Opengento\Gdpr\Service\Anonymize; +namespace Opengento\Gdpr\Service\Export\Processor\Entity; use Magento\Framework\App\Config\ScopeConfigInterface; /** - * Class VirtualConfig + * Class Config */ -class VirtualConfig implements ConfigInterface +final class Config implements ConfigInterface { /** * @var \Magento\Framework\App\Config\ScopeConfigInterface diff --git a/Service/Anonymize/ConfigInterface.php b/Service/Export/Processor/Entity/ConfigInterface.php similarity index 85% rename from Service/Anonymize/ConfigInterface.php rename to Service/Export/Processor/Entity/ConfigInterface.php index 36ac94a..878a4ff 100644 --- a/Service/Anonymize/ConfigInterface.php +++ b/Service/Export/Processor/Entity/ConfigInterface.php @@ -4,7 +4,7 @@ * See LICENSE bundled with this library for license details. */ -namespace Opengento\Gdpr\Service\Anonymize; +namespace Opengento\Gdpr\Service\Export\Processor\Entity; /** * Interface ConfigInterface diff --git a/Service/Export/Processor/Entity/DataCollector.php b/Service/Export/Processor/Entity/DataCollector.php new file mode 100644 index 0000000..0dbe661 --- /dev/null +++ b/Service/Export/Processor/Entity/DataCollector.php @@ -0,0 +1,48 @@ +entityIterator = $entityIterator; + $this->document = $document; + } + + /** + * {@inheritdoc} + */ + public function collect($entity): array + { + $this->entityIterator->iterate($entity); + + return $this->document->getData(); + } +} diff --git a/Service/Export/Processor/Entity/DataCollectorInterface.php b/Service/Export/Processor/Entity/DataCollectorInterface.php new file mode 100644 index 0000000..d3d1cbf --- /dev/null +++ b/Service/Export/Processor/Entity/DataCollectorInterface.php @@ -0,0 +1,22 @@ +data = $data; + } + + /** + * {@inheritdoc} + */ + public function setData(array $data): void + { + $this->data = $data; + } + + /** + * {@inheritdoc} + */ + public function addData(string $key, $value): void + { + $this->data[$key] = $value; + } + + /** + * {@inheritdoc} + */ + public function getData(): array + { + $data = $this->data; + $this->data = []; + + return $data; + } +} diff --git a/Service/Export/Processor/Entity/DocumentInterface.php b/Service/Export/Processor/Entity/DocumentInterface.php new file mode 100644 index 0000000..67d26cc --- /dev/null +++ b/Service/Export/Processor/Entity/DocumentInterface.php @@ -0,0 +1,38 @@ +document = $document; + $this->config = $config; + } + + /** + * {@inheritdoc} + */ + public function process($entity, string $key, $value): void + { + if (\in_array($key, $this->config->getAttributes(), true)) { + $this->document->addData($key, $value); + } + } +} diff --git a/Service/Export/Processor/EntityValue/VirtualProcessor.php b/Service/Export/Processor/EntityValue/VirtualProcessor.php deleted file mode 100644 index fbf1a10..0000000 --- a/Service/Export/Processor/EntityValue/VirtualProcessor.php +++ /dev/null @@ -1,41 +0,0 @@ -config = $config; - } - - /** - * {@inheritdoc} - */ - public function process($entity, string $key, $value): void - { - if (\in_array($key, $this->config->getAttributes())) { - // todo Add value to the Container of DocumentInterface from the export service - } - } -} diff --git a/Service/Export/Processor/OrderDataProcessor.php b/Service/Export/Processor/OrderDataProcessor.php index 3a3cee6..7bc5a7d 100644 --- a/Service/Export/Processor/OrderDataProcessor.php +++ b/Service/Export/Processor/OrderDataProcessor.php @@ -8,10 +8,9 @@ namespace Opengento\Gdpr\Service\Export\Processor; use Magento\Framework\Api\SearchCriteriaBuilder; -use Magento\Framework\Api\SearchResultsInterface; -use Magento\Framework\EntityManager\Hydrator; use Magento\Sales\Api\Data\OrderInterface; use Magento\Sales\Api\OrderRepositoryInterface; +use Opengento\Gdpr\Service\Export\Processor\Entity\DataCollectorInterface; use Opengento\Gdpr\Service\Export\ProcessorInterface; /** @@ -30,23 +29,23 @@ final class OrderDataProcessor implements ProcessorInterface private $searchCriteriaBuilder; /** - * @var \Magento\Framework\EntityManager\Hydrator + * @var \Opengento\Gdpr\Service\Export\Processor\Entity\DataCollectorInterface */ - private $hydrator; + private $dataCollector; /** * @param \Magento\Sales\Api\OrderRepositoryInterface $orderRepository * @param \Magento\Framework\Api\SearchCriteriaBuilder $searchCriteriaBuilder - * @param \Magento\Framework\EntityManager\Hydrator $hydrator + * @param \Opengento\Gdpr\Service\Export\Processor\Entity\DataCollectorInterface $dataCollector */ public function __construct( OrderRepositoryInterface $orderRepository, SearchCriteriaBuilder $searchCriteriaBuilder, - Hydrator $hydrator + DataCollectorInterface $dataCollector ) { $this->orderRepository = $orderRepository; $this->searchCriteriaBuilder = $searchCriteriaBuilder; - $this->hydrator = $hydrator; + $this->dataCollector = $dataCollector; } /** @@ -56,24 +55,10 @@ public function execute(int $customerId, array $data): array { $searchCriteria = $this->searchCriteriaBuilder->addFilter(OrderInterface::CUSTOMER_ID, $customerId); $orderList = $this->orderRepository->getList($searchCriteria->create()); - $data['orders'] = $this->generateArray($orderList); - - return $data; - } - - /** - * Collect the customer orders data to export - * - * @param \Magento\Framework\Api\SearchResultsInterface $searchResults - * @return array - */ - private function generateArray(SearchResultsInterface $searchResults): array - { - $data = []; /** @var \Magento\Sales\Api\Data\OrderInterface $entity */ - foreach ($searchResults->getItems() as $entity) { - $data['order_id_' . $entity->getEntityId()] = $this->hydrator->extract($entity); + foreach ($orderList->getItems() as $entity) { + $data['orders']['order_id_' . $entity->getEntityId()] = $this->dataCollector->collect($entity); } return $data; diff --git a/Service/Export/Processor/QuoteDataProcessor.php b/Service/Export/Processor/QuoteDataProcessor.php index a1b2819..b88bc69 100644 --- a/Service/Export/Processor/QuoteDataProcessor.php +++ b/Service/Export/Processor/QuoteDataProcessor.php @@ -8,9 +8,8 @@ namespace Opengento\Gdpr\Service\Export\Processor; use Magento\Framework\Api\SearchCriteriaBuilder; -use Magento\Framework\Api\SearchResultsInterface; -use Magento\Framework\EntityManager\Hydrator; use Magento\Quote\Api\CartRepositoryInterface; +use Opengento\Gdpr\Service\Export\Processor\Entity\DataCollectorInterface; use Opengento\Gdpr\Service\Export\ProcessorInterface; /** @@ -29,23 +28,23 @@ final class QuoteDataProcessor implements ProcessorInterface private $searchCriteriaBuilder; /** - * @var \Magento\Framework\EntityManager\Hydrator + * @var \Opengento\Gdpr\Service\Export\Processor\Entity\DataCollectorInterface */ - private $hydrator; + private $dataCollector; /** * @param \Magento\Quote\Api\CartRepositoryInterface $quoteRepository * @param \Magento\Framework\Api\SearchCriteriaBuilder $searchCriteriaBuilder - * @param \Magento\Framework\EntityManager\Hydrator $hydrator + * @param \Opengento\Gdpr\Service\Export\Processor\Entity\DataCollectorInterface $dataCollector */ public function __construct( CartRepositoryInterface $quoteRepository, SearchCriteriaBuilder $searchCriteriaBuilder, - Hydrator $hydrator + DataCollectorInterface $dataCollector ) { $this->quoteRepository = $quoteRepository; $this->searchCriteriaBuilder = $searchCriteriaBuilder; - $this->hydrator = $hydrator; + $this->dataCollector = $dataCollector; } /** @@ -55,24 +54,10 @@ public function execute(int $customerId, array $data): array { $searchCriteria = $this->searchCriteriaBuilder->addFilter('customer_id', $customerId); $quoteList = $this->quoteRepository->getList($searchCriteria->create()); - $data['quotes'] = $this->generateArray($quoteList); - - return $data; - } - - /** - * Collect the customer quotes data to export - * - * @param \Magento\Framework\Api\SearchResultsInterface $searchResults - * @return array - */ - private function generateArray(SearchResultsInterface $searchResults): array - { - $data = []; /** @var \Magento\Quote\Api\Data\CartInterface $entity */ - foreach ($searchResults->getItems() as $entity) { - $data['quote_id_' . $entity->getId()] = $this->hydrator->extract($entity); + foreach ($quoteList->getItems() as $entity) { + $data['quotes']['quote_id_' . $entity->getId()] = $this->dataCollector->collect($entity); } return $data; diff --git a/Service/Export/Processor/SubscriberDataProcessor.php b/Service/Export/Processor/SubscriberDataProcessor.php index 65d96fd..2115152 100644 --- a/Service/Export/Processor/SubscriberDataProcessor.php +++ b/Service/Export/Processor/SubscriberDataProcessor.php @@ -8,6 +8,7 @@ namespace Opengento\Gdpr\Service\Export\Processor; use Magento\Newsletter\Model\SubscriberFactory; +use Opengento\Gdpr\Service\Export\Processor\Entity\DataCollectorInterface; use Opengento\Gdpr\Service\Export\ProcessorInterface; /** @@ -20,13 +21,21 @@ final class SubscriberDataProcessor implements ProcessorInterface */ private $subscriberFactory; + /** + * @var \Opengento\Gdpr\Service\Export\Processor\Entity\DataCollectorInterface + */ + private $dataCollector; + /** * @param \Magento\Newsletter\Model\SubscriberFactory $subscriberFactory + * @param \Opengento\Gdpr\Service\Export\Processor\Entity\DataCollectorInterface $dataCollector */ public function __construct( - SubscriberFactory $subscriberFactory + SubscriberFactory $subscriberFactory, + DataCollectorInterface $dataCollector ) { $this->subscriberFactory = $subscriberFactory; + $this->dataCollector = $dataCollector; } /** @@ -37,7 +46,7 @@ public function execute(int $customerId, array $data): array /** @var \Magento\Newsletter\Model\Subscriber $subscriber */ $subscriber = $this->subscriberFactory->create(); $subscriber->loadByCustomerId($customerId); - $data['subscribers'] = $subscriber->toArray(); + $data['subscriber'] = $this->dataCollector->collect($subscriber); return $data; } diff --git a/Service/ExportManagement.php b/Service/ExportManagement.php index a6adfec..3643c16 100644 --- a/Service/ExportManagement.php +++ b/Service/ExportManagement.php @@ -62,6 +62,7 @@ public function executeProcessor(string $processorName, int $customerId): array /** @var \Opengento\Gdpr\Service\Export\ProcessorInterface $processor */ $processor = $this->processorPool->offsetGet($processorName); + return $processor->execute($customerId, []); } } diff --git a/etc/di.xml b/etc/di.xml index 293d8ff..c2d4b13 100644 --- a/etc/di.xml +++ b/etc/di.xml @@ -72,6 +72,381 @@ Opengento\Gdpr\Service\Export\ProcessorPool + + + + + gdpr/export/customer_attributes + + + + + gdpr/export/customer_custom_attributes + + + + + gdpr/export/customer_extensible_data + + + + + Opengento\Gdpr\Service\Export\Processor\Customer\Document + Opengento\Gdpr\Service\Export\Processor\Customer\Config\AttributesConfig + + + + + Opengento\Gdpr\Service\Export\Processor\Customer\Document + Opengento\Gdpr\Service\Export\Processor\Customer\Config\CustomAttributesConfig + + + + + Opengento\Gdpr\Service\Export\Processor\Customer\Document + Opengento\Gdpr\Service\Export\Processor\Customer\Config\ExtensibleDataConfig + + + + + Opengento\Gdpr\Service\Export\Processor\Customer\EntityValue\AttributesProcessor + + + + + Opengento\Gdpr\Service\Export\Processor\Customer\EntityValue\CustomAttributesProcessor + + + + + Opengento\Gdpr\Service\Export\Processor\Customer\EntityValue\ExtensibleDataProcessor + + + + + + Opengento\Gdpr\Service\Export\Processor\Customer\AttributesProcessor + Opengento\Gdpr\Service\Export\Processor\Customer\CustomAttributesProcessor + Opengento\Gdpr\Service\Export\Processor\Customer\ExtensibleDataProcessor + + + + + + Opengento\Gdpr\Service\Export\Processor\Customer\StrategyProcessor + + + + + Opengento\Gdpr\Service\Export\Processor\Customer\EntityIterator + Opengento\Gdpr\Service\Export\Processor\Customer\Document + + + + + Opengento\Gdpr\Service\Export\Processor\Customer\DataCollector + + + + + + + gdpr/export/customer_address_attributes + + + + + gdpr/export/customer_address_custom_attributes + + + + + gdpr/export/customer_address_extensible_data + + + + + Opengento\Gdpr\Service\Export\Processor\CustomerAddress\Document + Opengento\Gdpr\Service\Export\Processor\CustomerAddress\Config\AttributesConfig + + + + + Opengento\Gdpr\Service\Export\Processor\CustomerAddress\Document + Opengento\Gdpr\Service\Export\Processor\CustomerAddress\Config\CustomAttributesConfig + + + + + Opengento\Gdpr\Service\Export\Processor\CustomerAddress\Document + Opengento\Gdpr\Service\Export\Processor\CustomerAddress\Config\ExtensibleDataConfig + + + + + Opengento\Gdpr\Service\Export\Processor\CustomerAddress\EntityValue\AttributesProcessor + + + + + Opengento\Gdpr\Service\Export\Processor\CustomerAddress\EntityValue\CustomAttributesProcessor + + + + + Opengento\Gdpr\Service\Export\Processor\CustomerAddress\EntityValue\ExtensibleDataProcessor + + + + + + Opengento\Gdpr\Service\Export\Processor\CustomerAddress\AttributesProcessor + Opengento\Gdpr\Service\Export\Processor\CustomerAddress\CustomAttributesProcessor + Opengento\Gdpr\Service\Export\Processor\CustomerAddress\ExtensibleDataProcessor + + + + + + Opengento\Gdpr\Service\Export\Processor\CustomerAddress\StrategyProcessor + + + + + Opengento\Gdpr\Service\Export\Processor\CustomerAddress\EntityIterator + Opengento\Gdpr\Service\Export\Processor\CustomerAddress\Document + + + + + Opengento\Gdpr\Service\Export\Processor\CustomerAddress\DataCollector + + + + + + + gdpr/export/quote_attributes + + + + + gdpr/export/quote_custom_attributes + + + + + gdpr/export/quote_extensible_data + + + + + Opengento\Gdpr\Service\Export\Processor\Quote\Document + Opengento\Gdpr\Service\Export\Processor\Quote\Config\AttributesConfig + + + + + Opengento\Gdpr\Service\Export\Processor\Quote\Document + Opengento\Gdpr\Service\Export\Processor\Quote\Config\CustomAttributesConfig + + + + + Opengento\Gdpr\Service\Export\Processor\Quote\Document + Opengento\Gdpr\Service\Export\Processor\Quote\Config\ExtensibleDataConfig + + + + + Opengento\Gdpr\Service\Export\Processor\Quote\EntityValue\AttributesProcessor + + + + + Opengento\Gdpr\Service\Export\Processor\Quote\EntityValue\CustomAttributesProcessor + + + + + Opengento\Gdpr\Service\Export\Processor\Quote\EntityValue\ExtensibleDataProcessor + + + + + + Opengento\Gdpr\Service\Export\Processor\Quote\AttributesProcessor + Opengento\Gdpr\Service\Export\Processor\Quote\CustomAttributesProcessor + Opengento\Gdpr\Service\Export\Processor\Quote\ExtensibleDataProcessor + + + + + + Opengento\Gdpr\Service\Export\Processor\Quote\StrategyProcessor + + + + + Opengento\Gdpr\Service\Export\Processor\Quote\EntityIterator + Opengento\Gdpr\Service\Export\Processor\Quote\Document + + + + + Opengento\Gdpr\Service\Export\Processor\Quote\DataCollector + + + + + + + gdpr/export/order_attributes + + + + + gdpr/export/order_custom_attributes + + + + + gdpr/export/order_extensible_data + + + + + Opengento\Gdpr\Service\Export\Processor\Order\Document + Opengento\Gdpr\Service\Export\Processor\Order\Config\AttributesConfig + + + + + Opengento\Gdpr\Service\Export\Processor\Order\Document + Opengento\Gdpr\Service\Export\Processor\Order\Config\CustomAttributesConfig + + + + + Opengento\Gdpr\Service\Export\Processor\Order\Document + Opengento\Gdpr\Service\Export\Processor\Order\Config\ExtensibleDataConfig + + + + + Opengento\Gdpr\Service\Export\Processor\Order\EntityValue\AttributesProcessor + + + + + Opengento\Gdpr\Service\Export\Processor\Order\EntityValue\CustomAttributesProcessor + + + + + Opengento\Gdpr\Service\Export\Processor\Order\EntityValue\ExtensibleDataProcessor + + + + + + Opengento\Gdpr\Service\Export\Processor\Order\AttributesProcessor + Opengento\Gdpr\Service\Export\Processor\Order\CustomAttributesProcessor + Opengento\Gdpr\Service\Export\Processor\Order\ExtensibleDataProcessor + + + + + + Opengento\Gdpr\Service\Export\Processor\Order\StrategyProcessor + + + + + Opengento\Gdpr\Service\Export\Processor\Order\EntityIterator + Opengento\Gdpr\Service\Export\Processor\Order\Document + + + + + Opengento\Gdpr\Service\Export\Processor\Order\DataCollector + + + + + + + gdpr/export/subscriber_attributes + + + + + gdpr/export/subscriber_custom_attributes + + + + + gdpr/export/subscriber_extensible_data + + + + + Opengento\Gdpr\Service\Export\Processor\Subscriber\Document + Opengento\Gdpr\Service\Export\Processor\Subscriber\Config\AttributesConfig + + + + + Opengento\Gdpr\Service\Export\Processor\Subscriber\Document + Opengento\Gdpr\Service\Export\Processor\Subscriber\Config\CustomAttributesConfig + + + + + Opengento\Gdpr\Service\Export\Processor\Subscriber\Document + Opengento\Gdpr\Service\Export\Processor\Subscriber\Config\ExtensibleDataConfig + + + + + Opengento\Gdpr\Service\Export\Processor\Subscriber\EntityValue\AttributesProcessor + + + + + Opengento\Gdpr\Service\Export\Processor\Subscriber\EntityValue\CustomAttributesProcessor + + + + + Opengento\Gdpr\Service\Export\Processor\Subscriber\EntityValue\ExtensibleDataProcessor + + + + + + Opengento\Gdpr\Service\Export\Processor\Subscriber\AttributesProcessor + Opengento\Gdpr\Service\Export\Processor\Subscriber\CustomAttributesProcessor + Opengento\Gdpr\Service\Export\Processor\Subscriber\ExtensibleDataProcessor + + + + + + Opengento\Gdpr\Service\Export\Processor\Subscriber\StrategyProcessor + + + + + Opengento\Gdpr\Service\Export\Processor\Subscriber\EntityIterator + Opengento\Gdpr\Service\Export\Processor\Subscriber\Document + + + + + Opengento\Gdpr\Service\Export\Processor\Subscriber\DataCollector + + diff --git a/view/frontend/templates/messages/popup.phtml b/view/frontend/templates/messages/popup.phtml index 4947e5e..822b098 100644 --- a/view/frontend/templates/messages/popup.phtml +++ b/view/frontend/templates/messages/popup.phtml @@ -11,7 +11,7 @@ From 902840d852d707fe3ae53cc4e3895afff195bd19 Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Fri, 26 Apr 2019 18:02:33 +0200 Subject: [PATCH 04/75] phpcsfix + split html renderer --- Cron/Erasure.php | 6 +- Model/Config.php | 8 +- Model/Config/ErasureComponentStrategy.php | 2 +- Model/Config/Source/ExportRenderer.php | 2 +- Model/EraseCustomerRepository.php | 3 +- Service/Export/Renderer/HtmlRenderer.php | 118 +-------------- .../Renderer/HtmlRenderer/LayoutInitiator.php | 143 ++++++++++++++++++ .../HtmlRenderer/LayoutInitiatorInterface.php | 23 +++ etc/di.xml | 8 +- 9 files changed, 190 insertions(+), 123 deletions(-) create mode 100644 Service/Export/Renderer/HtmlRenderer/LayoutInitiator.php create mode 100644 Service/Export/Renderer/HtmlRenderer/LayoutInitiatorInterface.php diff --git a/Cron/Erasure.php b/Cron/Erasure.php index 0a97516..0355134 100755 --- a/Cron/Erasure.php +++ b/Cron/Erasure.php @@ -54,7 +54,7 @@ final class Erasure private $searchCriteriaBuilder; /** - * @var \Magento\Framework\Stdlib\DateTime\DateTime + * @var \Magento\Framework\Stdlib\DateTime\DateTime */ private $dateTime; @@ -117,8 +117,8 @@ public function execute(): void private function retrieveEraseCustomerList(): SearchResultsInterface { $this->searchCriteriaBuilder->addFilter( - EraseCustomerInterface::SCHEDULED_AT, - $this->dateTime->date(), + EraseCustomerInterface::SCHEDULED_AT, + $this->dateTime->date(), 'lteq' ); $this->searchCriteriaBuilder->addFilter( diff --git a/Model/Config.php b/Model/Config.php index c2956c8..6ba4594 100644 --- a/Model/Config.php +++ b/Model/Config.php @@ -211,8 +211,7 @@ private function getValueString( string $path, string $scopeType = ScopeConfigInterface::SCOPE_TYPE_DEFAULT, string $scopeCode = '' - ): string - { + ): string { return (string) $this->scopeConfig->getValue($path, $scopeType, $scopeCode ?: null); } @@ -228,10 +227,9 @@ private function getValueArray( string $path, string $scopeType = ScopeConfigInterface::SCOPE_TYPE_DEFAULT, string $scopeCode = '' - ): array - { + ): array { $value = $this->scopeConfig->getValue($path, $scopeType, $scopeCode ?: null); - return $value ? \explode(',', $value) : []; + return $value ? \explode(',', $value) : []; } } diff --git a/Model/Config/ErasureComponentStrategy.php b/Model/Config/ErasureComponentStrategy.php index d915640..6ee2c39 100644 --- a/Model/Config/ErasureComponentStrategy.php +++ b/Model/Config/ErasureComponentStrategy.php @@ -86,7 +86,7 @@ public function getAnonymizeComponentsNames(): array /** * Retrieve the delete components names - * + * * @return string[] */ public function getDeleteComponentsNames(): array diff --git a/Model/Config/Source/ExportRenderer.php b/Model/Config/Source/ExportRenderer.php index 05bc550..5d2f31d 100644 --- a/Model/Config/Source/ExportRenderer.php +++ b/Model/Config/Source/ExportRenderer.php @@ -41,7 +41,7 @@ public function __construct( public function toOptionArray(): array { if (!$this->options) { - foreach ($this->retrieveRenderers() as $rendererName => $renderer) { + foreach (\array_keys($this->retrieveRenderers()) as $rendererName) { $this->options[] = ['label' => new Phrase($rendererName), 'value' => $rendererName]; } } diff --git a/Model/EraseCustomerRepository.php b/Model/EraseCustomerRepository.php index 90b9e8c..2a93298 100644 --- a/Model/EraseCustomerRepository.php +++ b/Model/EraseCustomerRepository.php @@ -177,7 +177,8 @@ public function delete(EraseCustomerInterface $entity): bool $this->eraseCustomerResource->delete($entity); } catch (\Exception $e) { throw new CouldNotDeleteException( - new Phrase('Could not delete entity with id "%1".', [$entity->getEntityId()]), $e + new Phrase('Could not delete entity with id "%1".', [$entity->getEntityId()]), + $e ); } diff --git a/Service/Export/Renderer/HtmlRenderer.php b/Service/Export/Renderer/HtmlRenderer.php index 2aac5dc..ba4bf5a 100644 --- a/Service/Export/Renderer/HtmlRenderer.php +++ b/Service/Export/Renderer/HtmlRenderer.php @@ -8,57 +8,23 @@ namespace Opengento\Gdpr\Service\Export\Renderer; use Magento\Framework\DataObject; -use Magento\Framework\Exception\LocalizedException; use Magento\Framework\Filesystem; -use Magento\Framework\Phrase; use Magento\Framework\Translate\InlineInterface; use Magento\Framework\View\FileSystem as ViewFileSystem; -use Magento\Framework\View\Layout\BuilderFactory; -use Magento\Framework\View\Layout\GeneratorPool; -use Magento\Framework\View\Layout\ReaderPool; -use Magento\Framework\View\LayoutFactory; -use Magento\Framework\View\LayoutInterface; use Magento\Framework\View\Page\Config; use Magento\Framework\View\Page\Config\RendererFactory; -use Magento\Framework\View\Page\Layout\Reader; use Opengento\Gdpr\Service\Export\AbstractRenderer; +use Opengento\Gdpr\Service\Export\Renderer\HtmlRenderer\LayoutInitiatorInterface; /** * Class HtmlRenderer */ final class HtmlRenderer extends AbstractRenderer { - private const DEFAULT_LAYOUT_HANDLE = 'customer_privacy_export_personal_data'; - - /** - * @var \Magento\Framework\View\LayoutFactory - */ - private $layoutFactory; - - /** - * @var \Magento\Framework\View\Layout\BuilderFactory - */ - private $layoutBuilderFactory; - - /** - * @var \Magento\Framework\View\Layout\ReaderPool - */ - private $layoutReaderPool; - /** - * @var \Magento\Framework\View\Layout\GeneratorPool + * @var \Opengento\Gdpr\Service\Export\Renderer\HtmlRenderer\LayoutInitiatorInterface */ - private $layoutGeneratorPool; - - /** - * @var \Magento\Framework\View\Page\Layout\Reader - */ - private $pageLayoutReader; - - /** - * @var \Magento\Framework\View\Page\Config - */ - private $pageConfig; + private $layoutInitiator; /** * @var \Magento\Framework\View\Page\Config\Renderer @@ -82,11 +48,7 @@ final class HtmlRenderer extends AbstractRenderer /** * @param \Magento\Framework\Filesystem $filesystem - * @param \Magento\Framework\View\LayoutFactory $layoutFactory - * @param \Magento\Framework\View\Layout\BuilderFactory $layoutBuilderFactory - * @param \Magento\Framework\View\Layout\ReaderPool $layoutReaderPool - * @param \Magento\Framework\View\Layout\GeneratorPool $layoutGeneratorPool - * @param \Magento\Framework\View\Page\Layout\Reader $pageLayoutReader + * @param \Opengento\Gdpr\Service\Export\Renderer\HtmlRenderer\LayoutInitiatorInterface $layoutInitiator * @param \Magento\Framework\View\Page\Config $pageConfig * @param \Magento\Framework\View\Page\Config\RendererFactory $pageConfigRendererFactory * @param \Magento\Framework\Translate\InlineInterface $translateInline @@ -95,23 +57,14 @@ final class HtmlRenderer extends AbstractRenderer */ public function __construct( Filesystem $filesystem, - LayoutFactory $layoutFactory, - BuilderFactory $layoutBuilderFactory, - ReaderPool $layoutReaderPool, - GeneratorPool $layoutGeneratorPool, - Reader $pageLayoutReader, + LayoutInitiatorInterface $layoutInitiator, Config $pageConfig, RendererFactory $pageConfigRendererFactory, InlineInterface $translateInline, ViewFileSystem $viewFileSystem, string $template ) { - $this->layoutFactory = $layoutFactory; - $this->layoutBuilderFactory = $layoutBuilderFactory; - $this->layoutReaderPool = $layoutReaderPool; - $this->layoutGeneratorPool = $layoutGeneratorPool; - $this->pageLayoutReader = $pageLayoutReader; - $this->pageConfig = $pageConfig; + $this->layoutInitiator = $layoutInitiator; $this->pageConfigRenderer = $pageConfigRendererFactory->create(['pageConfig' => $pageConfig]); $this->translateInline = $translateInline; $this->viewFileSystem = $viewFileSystem; @@ -125,7 +78,7 @@ public function __construct( */ public function render(array $data): string { - $layout = $this->initLayout(); + $layout = $this->layoutInitiator->createLayout(); $addBlock = $layout->getBlock('head.additional'); $requireJs = $layout->getBlock('require.js'); @@ -173,61 +126,4 @@ private function renderPage(array $viewVars): string return \ob_get_clean(); } - - /** - * Add the default configuration to the page layout - * - * @param \Magento\Framework\View\LayoutInterface $layout - * @return \Magento\Framework\View\LayoutInterface - * @throws \Magento\Framework\Exception\LocalizedException - */ - private function addConfigLayout(LayoutInterface $layout): LayoutInterface - { - $this->layoutBuilderFactory->create( - BuilderFactory::TYPE_PAGE, - [ - 'layout' => $layout, - 'pageConfig' => $this->pageConfig, - 'pageLayoutReader' => $this->pageLayoutReader, - ] - )->build(); - - /** @var \Magento\Framework\View\Model\Layout\Merge $update */ - $update = $layout->getUpdate(); - $pageLayout = $this->pageConfig->getPageLayout() ?: $update->getPageLayout(); - - if (!$pageLayout) { - throw new LocalizedException(new Phrase('Page layout is missing.')); - } - - $this->pageConfig->addBodyClass(\str_replace('_', '-', self::DEFAULT_LAYOUT_HANDLE)); - $this->pageConfig->addBodyClass('page-layout-' . $pageLayout); - - return $layout; - } - - /** - * Init the page layout instructions - * - * @return \Magento\Framework\View\LayoutInterface - * @throws \Magento\Framework\Exception\LocalizedException - */ - private function initLayout(): LayoutInterface - { - $layout = $this->layoutFactory->create([ - 'cacheable' => false, - 'reader' => $this->layoutReaderPool, - 'generatorPool' => $this->layoutGeneratorPool, - ]); - - $layout->getUpdate()->addHandle('default'); - $layout->getUpdate()->addHandle(self::DEFAULT_LAYOUT_HANDLE); - /** @var \Magento\Framework\View\Model\Layout\Merge $update */ - $update = $layout->getUpdate(); - if ($update->isLayoutDefined()) { - $update->removeHandle('default'); - } - - return $this->addConfigLayout($layout); - } } diff --git a/Service/Export/Renderer/HtmlRenderer/LayoutInitiator.php b/Service/Export/Renderer/HtmlRenderer/LayoutInitiator.php new file mode 100644 index 0000000..62bb066 --- /dev/null +++ b/Service/Export/Renderer/HtmlRenderer/LayoutInitiator.php @@ -0,0 +1,143 @@ +layoutFactory = $layoutFactory; + $this->layoutBuilderFactory = $layoutBuilderFactory; + $this->layoutReaderPool = $layoutReaderPool; + $this->layoutGeneratorPool = $layoutGeneratorPool; + $this->pageLayoutReader = $pageLayoutReader; + $this->pageConfig = $pageConfig; + $this->defaultLayoutHandle = $defaultLayoutHandle; + } + + /** + * Create and initialize the page layout instructions + * + * @return \Magento\Framework\View\LayoutInterface + * @throws \Magento\Framework\Exception\LocalizedException + */ + public function createLayout(): LayoutInterface + { + $layout = $this->layoutFactory->create([ + 'cacheable' => false, + 'reader' => $this->layoutReaderPool, + 'generatorPool' => $this->layoutGeneratorPool, + ]); + + $layout->getUpdate()->addHandle('default'); + $layout->getUpdate()->addHandle($this->defaultLayoutHandle); + /** @var \Magento\Framework\View\Model\Layout\Merge $update */ + $update = $layout->getUpdate(); + if ($update->isLayoutDefined()) { + $update->removeHandle('default'); + } + + return $this->addConfigLayout($layout); + } + + /** + * Add the default configuration to the page layout + * + * @param \Magento\Framework\View\LayoutInterface $layout + * @return \Magento\Framework\View\LayoutInterface + * @throws \Magento\Framework\Exception\LocalizedException + */ + private function addConfigLayout(LayoutInterface $layout): LayoutInterface + { + $this->layoutBuilderFactory->create( + BuilderFactory::TYPE_PAGE, + [ + 'layout' => $layout, + 'pageConfig' => $this->pageConfig, + 'pageLayoutReader' => $this->pageLayoutReader, + ] + )->build(); + + /** @var \Magento\Framework\View\Model\Layout\Merge $update */ + $update = $layout->getUpdate(); + $pageLayout = $this->pageConfig->getPageLayout() ?: $update->getPageLayout(); + + if (!$pageLayout) { + throw new LocalizedException(new Phrase('Page layout is missing.')); + } + + $this->pageConfig->addBodyClass(\str_replace('_', '-', $this->defaultLayoutHandle)); + $this->pageConfig->addBodyClass('page-layout-' . $pageLayout); + + return $layout; + } +} diff --git a/Service/Export/Renderer/HtmlRenderer/LayoutInitiatorInterface.php b/Service/Export/Renderer/HtmlRenderer/LayoutInitiatorInterface.php new file mode 100644 index 0000000..0d961e1 --- /dev/null +++ b/Service/Export/Renderer/HtmlRenderer/LayoutInitiatorInterface.php @@ -0,0 +1,23 @@ + - + pageConfigRenderPool pageLayoutGeneratorPool + customer_privacy_export_personal_data + + + + + Opengento\Gdpr\Service\Export\Renderer\HtmlRenderer\LayoutInitiator Magento_Theme::root.phtml From d30ad208401afba96e4b28848646482e617e7740 Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Fri, 26 Apr 2019 18:03:37 +0200 Subject: [PATCH 05/75] rwrite inheritdoc phpdoc --- Block/Messages/PrivacyMessagePopup.php | 4 +-- Console/Command/EraseCommand.php | 4 +-- Console/Command/ExportCommand.php | 4 +-- Controller/Privacy/Delete.php | 2 +- Controller/Privacy/DeletePost.php | 2 +- Controller/Privacy/Export.php | 2 +- Controller/Privacy/Settings.php | 2 +- Controller/Privacy/UndoDelete.php | 2 +- Model/Archive/Zip.php | 4 +-- Model/Config/Source/EraseStrategy.php | 2 +- Model/Config/Source/ErasureComponents.php | 2 +- Model/Config/Source/ExportRenderer.php | 2 +- .../Source/VirtualCustomerAttributes.php | 2 +- Model/Entity/EntityIterator.php | 2 +- .../EntityValue/CustomAttributesProcessor.php | 2 +- Model/Entity/EntityValue/DefaultProcessor.php | 2 +- .../EntityValue/ExtensibleDataProcessor.php | 2 +- .../Entity/EntityValue/StrategyProcessor.php | 2 +- Model/EraseCustomer.php | 26 +++++++++---------- Model/EraseCustomerManagement.php | 12 ++++----- Model/EraseCustomerRepository.php | 12 ++++----- Model/ResourceModel/EraseCustomer.php | 2 +- .../EraseCustomer/Collection.php | 2 +- .../CustomerAddressDataProcessor.php | 2 +- .../Processor/CustomerDataProcessor.php | 2 +- Service/Anonymize/Processor/Entity/Config.php | 2 +- .../Entity/EntityValue/Processor.php | 2 +- .../Processor/OrderDataProcessor.php | 2 +- .../Processor/QuoteDataProcessor.php | 2 +- .../Processor/SubscriberDataProcessor.php | 2 +- .../CustomerAddressDataProcessor.php | 2 +- .../Processor/CustomerDataProcessor.php | 2 +- .../Delete/Processor/OrderDataProcessor.php | 2 +- .../Delete/Processor/QuoteDataProcessor.php | 2 +- .../Processor/SubscriberDataProcessor.php | 2 +- Service/Export/AbstractRenderer.php | 2 +- .../CustomerAddressDataProcessor.php | 2 +- .../Processor/CustomerDataProcessor.php | 2 +- Service/Export/Processor/Entity/Config.php | 2 +- .../Export/Processor/Entity/DataCollector.php | 2 +- Service/Export/Processor/Entity/Document.php | 6 ++--- .../Entity/EntityValue/Processor.php | 2 +- .../Export/Processor/OrderDataProcessor.php | 2 +- .../Export/Processor/QuoteDataProcessor.php | 2 +- .../Processor/SubscriberDataProcessor.php | 2 +- Service/Export/Renderer/CsvRenderer.php | 2 +- Service/Export/Renderer/HtmlRenderer.php | 2 +- Service/Export/Renderer/JsonRenderer.php | 2 +- Service/Export/Renderer/PdfRenderer.php | 2 +- Service/Export/Renderer/XmlRenderer.php | 2 +- Service/ExportStrategy.php | 4 +-- Setup/InstallSchema.php | 2 +- Setup/Uninstall.php | 2 +- 53 files changed, 82 insertions(+), 82 deletions(-) diff --git a/Block/Messages/PrivacyMessagePopup.php b/Block/Messages/PrivacyMessagePopup.php index d730c01..e0d0fe5 100644 --- a/Block/Messages/PrivacyMessagePopup.php +++ b/Block/Messages/PrivacyMessagePopup.php @@ -60,7 +60,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function getJsLayout(): string { @@ -74,7 +74,7 @@ public function getJsLayout(): string } /** - * {@inheritdoc} + * @inheritdoc */ protected function _toHtml(): string { diff --git a/Console/Command/EraseCommand.php b/Console/Command/EraseCommand.php index bf8e338..463861c 100644 --- a/Console/Command/EraseCommand.php +++ b/Console/Command/EraseCommand.php @@ -62,7 +62,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ protected function configure(): void { @@ -79,7 +79,7 @@ protected function configure(): void } /** - * {@inheritdoc} + * @inheritdoc */ protected function execute(InputInterface $input, OutputInterface $output): int { diff --git a/Console/Command/ExportCommand.php b/Console/Command/ExportCommand.php index d1f8190..366f015 100644 --- a/Console/Command/ExportCommand.php +++ b/Console/Command/ExportCommand.php @@ -65,7 +65,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ protected function configure(): void { @@ -89,7 +89,7 @@ protected function configure(): void } /** - * {@inheritdoc} + * @inheritdoc */ protected function execute(InputInterface $input, OutputInterface $output): int { diff --git a/Controller/Privacy/Delete.php b/Controller/Privacy/Delete.php index 8235c19..8ddf4d3 100755 --- a/Controller/Privacy/Delete.php +++ b/Controller/Privacy/Delete.php @@ -45,7 +45,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function execute() { diff --git a/Controller/Privacy/DeletePost.php b/Controller/Privacy/DeletePost.php index d2d2abc..1dfb9be 100755 --- a/Controller/Privacy/DeletePost.php +++ b/Controller/Privacy/DeletePost.php @@ -66,7 +66,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function execute() { diff --git a/Controller/Privacy/Export.php b/Controller/Privacy/Export.php index 9e893d6..b60a252 100755 --- a/Controller/Privacy/Export.php +++ b/Controller/Privacy/Export.php @@ -93,7 +93,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function execute() { diff --git a/Controller/Privacy/Settings.php b/Controller/Privacy/Settings.php index 8311c0b..d55d243 100755 --- a/Controller/Privacy/Settings.php +++ b/Controller/Privacy/Settings.php @@ -16,7 +16,7 @@ class Settings extends AbstractPrivacy { /** - * {@inheritdoc} + * @inheritdoc */ public function execute() { diff --git a/Controller/Privacy/UndoDelete.php b/Controller/Privacy/UndoDelete.php index 96e1e93..0ebabdb 100755 --- a/Controller/Privacy/UndoDelete.php +++ b/Controller/Privacy/UndoDelete.php @@ -45,7 +45,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function execute() { diff --git a/Model/Archive/Zip.php b/Model/Archive/Zip.php index 21362e0..6ae2d06 100644 --- a/Model/Archive/Zip.php +++ b/Model/Archive/Zip.php @@ -40,7 +40,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function pack($source, $destination): string { @@ -55,7 +55,7 @@ public function pack($source, $destination): string } /** - * {@inheritdoc} + * @inheritdoc */ public function unpack($source, $destination): string { diff --git a/Model/Config/Source/EraseStrategy.php b/Model/Config/Source/EraseStrategy.php index 5508974..df5b27d 100644 --- a/Model/Config/Source/EraseStrategy.php +++ b/Model/Config/Source/EraseStrategy.php @@ -17,7 +17,7 @@ class EraseStrategy implements OptionSourceInterface { /** - * {@inheritdoc} + * @inheritdoc */ public function toOptionArray(): array { diff --git a/Model/Config/Source/ErasureComponents.php b/Model/Config/Source/ErasureComponents.php index e8b9539..a07ed76 100644 --- a/Model/Config/Source/ErasureComponents.php +++ b/Model/Config/Source/ErasureComponents.php @@ -36,7 +36,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function toOptionArray(): array { diff --git a/Model/Config/Source/ExportRenderer.php b/Model/Config/Source/ExportRenderer.php index 5d2f31d..fd4bbf8 100644 --- a/Model/Config/Source/ExportRenderer.php +++ b/Model/Config/Source/ExportRenderer.php @@ -36,7 +36,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function toOptionArray(): array { diff --git a/Model/Config/Source/VirtualCustomerAttributes.php b/Model/Config/Source/VirtualCustomerAttributes.php index b81cfc1..a5b0802 100644 --- a/Model/Config/Source/VirtualCustomerAttributes.php +++ b/Model/Config/Source/VirtualCustomerAttributes.php @@ -39,7 +39,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function toOptionArray(): array { diff --git a/Model/Entity/EntityIterator.php b/Model/Entity/EntityIterator.php index 525d8b7..492681a 100644 --- a/Model/Entity/EntityIterator.php +++ b/Model/Entity/EntityIterator.php @@ -37,7 +37,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function iterate($entity): void { diff --git a/Model/Entity/EntityValue/CustomAttributesProcessor.php b/Model/Entity/EntityValue/CustomAttributesProcessor.php index 797895d..d0f9e41 100644 --- a/Model/Entity/EntityValue/CustomAttributesProcessor.php +++ b/Model/Entity/EntityValue/CustomAttributesProcessor.php @@ -30,7 +30,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function process($entity, string $key, $value): void { diff --git a/Model/Entity/EntityValue/DefaultProcessor.php b/Model/Entity/EntityValue/DefaultProcessor.php index e4854f6..627acea 100644 --- a/Model/Entity/EntityValue/DefaultProcessor.php +++ b/Model/Entity/EntityValue/DefaultProcessor.php @@ -29,7 +29,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function process($entity, string $key, $value): void { diff --git a/Model/Entity/EntityValue/ExtensibleDataProcessor.php b/Model/Entity/EntityValue/ExtensibleDataProcessor.php index 1eb2753..162faed 100644 --- a/Model/Entity/EntityValue/ExtensibleDataProcessor.php +++ b/Model/Entity/EntityValue/ExtensibleDataProcessor.php @@ -30,7 +30,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function process($entity, string $key, $value): void { diff --git a/Model/Entity/EntityValue/StrategyProcessor.php b/Model/Entity/EntityValue/StrategyProcessor.php index 28fe920..0e3a23a 100644 --- a/Model/Entity/EntityValue/StrategyProcessor.php +++ b/Model/Entity/EntityValue/StrategyProcessor.php @@ -33,7 +33,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function process($entity, string $key, $value): void { diff --git a/Model/EraseCustomer.php b/Model/EraseCustomer.php index 371ae79..abca122 100755 --- a/Model/EraseCustomer.php +++ b/Model/EraseCustomer.php @@ -17,7 +17,7 @@ final class EraseCustomer extends AbstractExtensibleModel implements EraseCustomerInterface { /** - * {@inheritdoc} + * @inheritdoc */ protected function _construct(): void { @@ -25,7 +25,7 @@ protected function _construct(): void } /** - * {@inheritdoc} + * @inheritdoc */ public function getEntityId(): int { @@ -33,7 +33,7 @@ public function getEntityId(): int } /** - * {@inheritdoc} + * @inheritdoc */ public function setEntityId($entityId): EraseCustomerInterface { @@ -43,7 +43,7 @@ public function setEntityId($entityId): EraseCustomerInterface } /** - * {@inheritdoc} + * @inheritdoc */ public function getCustomerId(): int { @@ -51,7 +51,7 @@ public function getCustomerId(): int } /** - * {@inheritdoc} + * @inheritdoc */ public function setCustomerId(int $customerId): EraseCustomerInterface { @@ -59,7 +59,7 @@ public function setCustomerId(int $customerId): EraseCustomerInterface } /** - * {@inheritdoc} + * @inheritdoc */ public function getScheduledAt(): string { @@ -67,7 +67,7 @@ public function getScheduledAt(): string } /** - * {@inheritdoc} + * @inheritdoc */ public function setScheduledAt(string $scheduledAt): EraseCustomerInterface { @@ -75,7 +75,7 @@ public function setScheduledAt(string $scheduledAt): EraseCustomerInterface } /** - * {@inheritdoc} + * @inheritdoc */ public function getState(): string { @@ -83,7 +83,7 @@ public function getState(): string } /** - * {@inheritdoc} + * @inheritdoc */ public function setState(string $state): EraseCustomerInterface { @@ -91,7 +91,7 @@ public function setState(string $state): EraseCustomerInterface } /** - * {@inheritdoc} + * @inheritdoc */ public function getStatus(): string { @@ -99,7 +99,7 @@ public function getStatus(): string } /** - * {@inheritdoc} + * @inheritdoc */ public function setStatus(string $status): EraseCustomerInterface { @@ -107,7 +107,7 @@ public function setStatus(string $status): EraseCustomerInterface } /** - * {@inheritdoc} + * @inheritdoc */ public function getErasedAt(): string { @@ -115,7 +115,7 @@ public function getErasedAt(): string } /** - * {@inheritdoc} + * @inheritdoc */ public function setErasedAt(string $erasedAt): EraseCustomerInterface { diff --git a/Model/EraseCustomerManagement.php b/Model/EraseCustomerManagement.php index 3a0e173..8601d49 100644 --- a/Model/EraseCustomerManagement.php +++ b/Model/EraseCustomerManagement.php @@ -71,7 +71,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function create(int $customerId): EraseCustomerInterface { @@ -90,7 +90,7 @@ public function create(int $customerId): EraseCustomerInterface } /** - * {@inheritdoc} + * @inheritdoc */ public function cancel(int $customerId): bool { @@ -106,7 +106,7 @@ public function cancel(int $customerId): bool } /** - * {@inheritdoc} + * @inheritdoc */ public function process(EraseCustomerInterface $entity): EraseCustomerInterface { @@ -134,7 +134,7 @@ public function process(EraseCustomerInterface $entity): EraseCustomerInterface } /** - * {@inheritdoc} + * @inheritdoc */ public function exists(int $customerId): bool { @@ -147,7 +147,7 @@ public function exists(int $customerId): bool } /** - * {@inheritdoc} + * @inheritdoc */ public function canBeCanceled(EraseCustomerInterface $entity): bool { @@ -156,7 +156,7 @@ public function canBeCanceled(EraseCustomerInterface $entity): bool } /** - * {@inheritdoc} + * @inheritdoc */ public function canBeProcessed(EraseCustomerInterface $entity): bool { diff --git a/Model/EraseCustomerRepository.php b/Model/EraseCustomerRepository.php index 2a93298..6459ab7 100644 --- a/Model/EraseCustomerRepository.php +++ b/Model/EraseCustomerRepository.php @@ -83,7 +83,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function save(EraseCustomerInterface $entity): EraseCustomerInterface { @@ -100,7 +100,7 @@ public function save(EraseCustomerInterface $entity): EraseCustomerInterface } /** - * {@inheritdoc} + * @inheritdoc */ public function getById(int $entityId, bool $forceReload = false): EraseCustomerInterface { @@ -121,7 +121,7 @@ public function getById(int $entityId, bool $forceReload = false): EraseCustomer } /** - * {@inheritdoc} + * @inheritdoc */ public function getByCustomerId(int $entityId, bool $forceReload = false): EraseCustomerInterface { @@ -144,7 +144,7 @@ public function getByCustomerId(int $entityId, bool $forceReload = false): Erase } /** - * {@inheritdoc} + * @inheritdoc */ public function getList(SearchCriteriaInterface $searchCriteria): SearchResultsInterface { @@ -163,7 +163,7 @@ public function getList(SearchCriteriaInterface $searchCriteria): SearchResultsI } /** - * {@inheritdoc} + * @inheritdoc */ public function delete(EraseCustomerInterface $entity): bool { @@ -186,7 +186,7 @@ public function delete(EraseCustomerInterface $entity): bool } /** - * {@inheritdoc} + * @inheritdoc */ public function deleteById(int $entityId): bool { diff --git a/Model/ResourceModel/EraseCustomer.php b/Model/ResourceModel/EraseCustomer.php index ce26cde..0704e94 100755 --- a/Model/ResourceModel/EraseCustomer.php +++ b/Model/ResourceModel/EraseCustomer.php @@ -18,7 +18,7 @@ final class EraseCustomer extends AbstractDb public const TABLE = 'opengento_gdpr_erase_customer'; /** - * {@inheritdoc} + * @inheritdoc */ protected function _construct(): void { diff --git a/Model/ResourceModel/EraseCustomer/Collection.php b/Model/ResourceModel/EraseCustomer/Collection.php index d7176b7..5500af7 100755 --- a/Model/ResourceModel/EraseCustomer/Collection.php +++ b/Model/ResourceModel/EraseCustomer/Collection.php @@ -18,7 +18,7 @@ final class Collection extends AbstractCollection { /** - * {@inheritdoc} + * @inheritdoc */ protected function _construct(): void { diff --git a/Service/Anonymize/Processor/CustomerAddressDataProcessor.php b/Service/Anonymize/Processor/CustomerAddressDataProcessor.php index 04eccc2..afdaf96 100644 --- a/Service/Anonymize/Processor/CustomerAddressDataProcessor.php +++ b/Service/Anonymize/Processor/CustomerAddressDataProcessor.php @@ -48,7 +48,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc * @throws \Magento\Framework\Exception\LocalizedException */ public function execute(int $customerId): bool diff --git a/Service/Anonymize/Processor/CustomerDataProcessor.php b/Service/Anonymize/Processor/CustomerDataProcessor.php index 18a3398..d9417e9 100644 --- a/Service/Anonymize/Processor/CustomerDataProcessor.php +++ b/Service/Anonymize/Processor/CustomerDataProcessor.php @@ -77,7 +77,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc * @throws \Magento\Framework\Exception\LocalizedException */ public function execute(int $customerId): bool diff --git a/Service/Anonymize/Processor/Entity/Config.php b/Service/Anonymize/Processor/Entity/Config.php index 9ef9cc7..2c776ec 100644 --- a/Service/Anonymize/Processor/Entity/Config.php +++ b/Service/Anonymize/Processor/Entity/Config.php @@ -45,7 +45,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function getAttributes(?string $scopeCode = null): array { diff --git a/Service/Anonymize/Processor/Entity/EntityValue/Processor.php b/Service/Anonymize/Processor/Entity/EntityValue/Processor.php index af5aa60..a2cb35c 100644 --- a/Service/Anonymize/Processor/Entity/EntityValue/Processor.php +++ b/Service/Anonymize/Processor/Entity/EntityValue/Processor.php @@ -30,7 +30,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function process($entity, string $key, $value): void { diff --git a/Service/Anonymize/Processor/OrderDataProcessor.php b/Service/Anonymize/Processor/OrderDataProcessor.php index def7059..e38a2f4 100644 --- a/Service/Anonymize/Processor/OrderDataProcessor.php +++ b/Service/Anonymize/Processor/OrderDataProcessor.php @@ -59,7 +59,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc * @throws \Magento\Framework\Exception\LocalizedException */ public function execute(int $customerId): bool diff --git a/Service/Anonymize/Processor/QuoteDataProcessor.php b/Service/Anonymize/Processor/QuoteDataProcessor.php index 4feadff..7b49dd8 100644 --- a/Service/Anonymize/Processor/QuoteDataProcessor.php +++ b/Service/Anonymize/Processor/QuoteDataProcessor.php @@ -58,7 +58,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc * @throws \Exception */ public function execute(int $customerId): bool diff --git a/Service/Anonymize/Processor/SubscriberDataProcessor.php b/Service/Anonymize/Processor/SubscriberDataProcessor.php index 1b20963..dd1794d 100644 --- a/Service/Anonymize/Processor/SubscriberDataProcessor.php +++ b/Service/Anonymize/Processor/SubscriberDataProcessor.php @@ -48,7 +48,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc * @throws \Exception */ public function execute(int $customerId): bool diff --git a/Service/Delete/Processor/CustomerAddressDataProcessor.php b/Service/Delete/Processor/CustomerAddressDataProcessor.php index 6a6a5a5..760910a 100644 --- a/Service/Delete/Processor/CustomerAddressDataProcessor.php +++ b/Service/Delete/Processor/CustomerAddressDataProcessor.php @@ -39,7 +39,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc * @throws \Magento\Framework\Exception\LocalizedException */ public function execute(int $customerId): bool diff --git a/Service/Delete/Processor/CustomerDataProcessor.php b/Service/Delete/Processor/CustomerDataProcessor.php index 737d239..65db866 100644 --- a/Service/Delete/Processor/CustomerDataProcessor.php +++ b/Service/Delete/Processor/CustomerDataProcessor.php @@ -31,7 +31,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc * @throws \Magento\Framework\Exception\LocalizedException */ public function execute(int $customerId): bool diff --git a/Service/Delete/Processor/OrderDataProcessor.php b/Service/Delete/Processor/OrderDataProcessor.php index 6e41b87..ce3fd00 100644 --- a/Service/Delete/Processor/OrderDataProcessor.php +++ b/Service/Delete/Processor/OrderDataProcessor.php @@ -40,7 +40,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function execute(int $customerId): bool { diff --git a/Service/Delete/Processor/QuoteDataProcessor.php b/Service/Delete/Processor/QuoteDataProcessor.php index b0f07c4..7fdf7c3 100644 --- a/Service/Delete/Processor/QuoteDataProcessor.php +++ b/Service/Delete/Processor/QuoteDataProcessor.php @@ -39,7 +39,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function execute(int $customerId): bool { diff --git a/Service/Delete/Processor/SubscriberDataProcessor.php b/Service/Delete/Processor/SubscriberDataProcessor.php index ff20375..21077ab 100644 --- a/Service/Delete/Processor/SubscriberDataProcessor.php +++ b/Service/Delete/Processor/SubscriberDataProcessor.php @@ -39,7 +39,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc * @throws \Exception */ public function execute(int $customerId): bool diff --git a/Service/Export/AbstractRenderer.php b/Service/Export/AbstractRenderer.php index 0914365..a696946 100644 --- a/Service/Export/AbstractRenderer.php +++ b/Service/Export/AbstractRenderer.php @@ -38,7 +38,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc * @throws \Magento\Framework\Exception\FileSystemException */ public function saveData(string $fileName, array $data): string diff --git a/Service/Export/Processor/CustomerAddressDataProcessor.php b/Service/Export/Processor/CustomerAddressDataProcessor.php index 5281899..fa0e900 100644 --- a/Service/Export/Processor/CustomerAddressDataProcessor.php +++ b/Service/Export/Processor/CustomerAddressDataProcessor.php @@ -48,7 +48,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc * @throws \Magento\Framework\Exception\LocalizedException */ public function execute(int $customerId, array $data): array diff --git a/Service/Export/Processor/CustomerDataProcessor.php b/Service/Export/Processor/CustomerDataProcessor.php index a2ae8fa..ecdf681 100644 --- a/Service/Export/Processor/CustomerDataProcessor.php +++ b/Service/Export/Processor/CustomerDataProcessor.php @@ -39,7 +39,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc * @throws \Magento\Framework\Exception\NoSuchEntityException * @throws \Magento\Framework\Exception\LocalizedException */ diff --git a/Service/Export/Processor/Entity/Config.php b/Service/Export/Processor/Entity/Config.php index cea9f9c..d3687e0 100644 --- a/Service/Export/Processor/Entity/Config.php +++ b/Service/Export/Processor/Entity/Config.php @@ -45,7 +45,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function getAttributes(?string $scopeCode = null): array { diff --git a/Service/Export/Processor/Entity/DataCollector.php b/Service/Export/Processor/Entity/DataCollector.php index 0dbe661..293b68b 100644 --- a/Service/Export/Processor/Entity/DataCollector.php +++ b/Service/Export/Processor/Entity/DataCollector.php @@ -37,7 +37,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function collect($entity): array { diff --git a/Service/Export/Processor/Entity/Document.php b/Service/Export/Processor/Entity/Document.php index de3b7df..751d1d4 100644 --- a/Service/Export/Processor/Entity/Document.php +++ b/Service/Export/Processor/Entity/Document.php @@ -26,7 +26,7 @@ public function __construct(array $data = []) } /** - * {@inheritdoc} + * @inheritdoc */ public function setData(array $data): void { @@ -34,7 +34,7 @@ public function setData(array $data): void } /** - * {@inheritdoc} + * @inheritdoc */ public function addData(string $key, $value): void { @@ -42,7 +42,7 @@ public function addData(string $key, $value): void } /** - * {@inheritdoc} + * @inheritdoc */ public function getData(): array { diff --git a/Service/Export/Processor/Entity/EntityValue/Processor.php b/Service/Export/Processor/Entity/EntityValue/Processor.php index c9ae77d..4cfdc97 100644 --- a/Service/Export/Processor/Entity/EntityValue/Processor.php +++ b/Service/Export/Processor/Entity/EntityValue/Processor.php @@ -39,7 +39,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function process($entity, string $key, $value): void { diff --git a/Service/Export/Processor/OrderDataProcessor.php b/Service/Export/Processor/OrderDataProcessor.php index 7bc5a7d..289b02d 100644 --- a/Service/Export/Processor/OrderDataProcessor.php +++ b/Service/Export/Processor/OrderDataProcessor.php @@ -49,7 +49,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function execute(int $customerId, array $data): array { diff --git a/Service/Export/Processor/QuoteDataProcessor.php b/Service/Export/Processor/QuoteDataProcessor.php index b88bc69..7403e7e 100644 --- a/Service/Export/Processor/QuoteDataProcessor.php +++ b/Service/Export/Processor/QuoteDataProcessor.php @@ -48,7 +48,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function execute(int $customerId, array $data): array { diff --git a/Service/Export/Processor/SubscriberDataProcessor.php b/Service/Export/Processor/SubscriberDataProcessor.php index 2115152..3c66fe3 100644 --- a/Service/Export/Processor/SubscriberDataProcessor.php +++ b/Service/Export/Processor/SubscriberDataProcessor.php @@ -39,7 +39,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function execute(int $customerId, array $data): array { diff --git a/Service/Export/Renderer/CsvRenderer.php b/Service/Export/Renderer/CsvRenderer.php index 6e3cfe6..92fc985 100644 --- a/Service/Export/Renderer/CsvRenderer.php +++ b/Service/Export/Renderer/CsvRenderer.php @@ -25,7 +25,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function render(array $data): string { diff --git a/Service/Export/Renderer/HtmlRenderer.php b/Service/Export/Renderer/HtmlRenderer.php index ba4bf5a..103597e 100644 --- a/Service/Export/Renderer/HtmlRenderer.php +++ b/Service/Export/Renderer/HtmlRenderer.php @@ -73,7 +73,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc * @throws \Exception */ public function render(array $data): string diff --git a/Service/Export/Renderer/JsonRenderer.php b/Service/Export/Renderer/JsonRenderer.php index c49ea33..b79021d 100644 --- a/Service/Export/Renderer/JsonRenderer.php +++ b/Service/Export/Renderer/JsonRenderer.php @@ -34,7 +34,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function render(array $data): string { diff --git a/Service/Export/Renderer/PdfRenderer.php b/Service/Export/Renderer/PdfRenderer.php index 2a6402c..77818f7 100644 --- a/Service/Export/Renderer/PdfRenderer.php +++ b/Service/Export/Renderer/PdfRenderer.php @@ -42,7 +42,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc * @throws \Exception */ public function render(array $data): string diff --git a/Service/Export/Renderer/XmlRenderer.php b/Service/Export/Renderer/XmlRenderer.php index 4dcc4b3..6fe24d6 100644 --- a/Service/Export/Renderer/XmlRenderer.php +++ b/Service/Export/Renderer/XmlRenderer.php @@ -34,7 +34,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc * @throws \Magento\Framework\Exception\LocalizedException */ public function render(array $data): string diff --git a/Service/ExportStrategy.php b/Service/ExportStrategy.php index 01aabb1..8acca7b 100644 --- a/Service/ExportStrategy.php +++ b/Service/ExportStrategy.php @@ -45,7 +45,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ public function render(array $data): string { @@ -53,7 +53,7 @@ public function render(array $data): string } /** - * {@inheritdoc} + * @inheritdoc */ public function saveData(string $fileName, array $data): string { diff --git a/Setup/InstallSchema.php b/Setup/InstallSchema.php index f2350b8..a20e356 100755 --- a/Setup/InstallSchema.php +++ b/Setup/InstallSchema.php @@ -21,7 +21,7 @@ final class InstallSchema implements InstallSchemaInterface { /** - * {@inheritdoc} + * @inheritdoc * @throws \Zend_Db_Exception */ public function install(SchemaSetupInterface $setup, ModuleContextInterface $context): void diff --git a/Setup/Uninstall.php b/Setup/Uninstall.php index 38732b6..d39fe29 100644 --- a/Setup/Uninstall.php +++ b/Setup/Uninstall.php @@ -19,7 +19,7 @@ final class Uninstall implements UninstallInterface { /** - * {@inheritdoc} + * @inheritdoc */ public function uninstall(SchemaSetupInterface $setup, ModuleContextInterface $context): void { From 08410dd88bfaf3bddc94988c58ad47d335107fab Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Thu, 2 May 2019 18:00:12 +0200 Subject: [PATCH 06/75] replace hydrator by pool --- Model/Entity/EntityIterator.php | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/Model/Entity/EntityIterator.php b/Model/Entity/EntityIterator.php index 492681a..49583e0 100644 --- a/Model/Entity/EntityIterator.php +++ b/Model/Entity/EntityIterator.php @@ -7,7 +7,7 @@ namespace Opengento\Gdpr\Model\Entity; -use Magento\Framework\EntityManager\HydratorInterface; +use Magento\Framework\EntityManager\HydratorPool; /** * Class EntityIterator @@ -15,9 +15,9 @@ class EntityIterator implements EntityIteratorInterface { /** - * @var \Magento\Framework\EntityManager\HydratorInterface + * @var \Magento\Framework\EntityManager\HydratorPool */ - private $hydrator; + private $hydratorPool; /** * @var \Opengento\Gdpr\Model\Entity\EntityValueProcessorInterface @@ -25,14 +25,14 @@ class EntityIterator implements EntityIteratorInterface private $processor; /** - * @param \Magento\Framework\EntityManager\HydratorInterface $hydrator + * @param \Magento\Framework\EntityManager\HydratorPool $hydratorPool * @param \Opengento\Gdpr\Model\Entity\EntityValueProcessorInterface $processor */ public function __construct( - HydratorInterface $hydrator, + HydratorPool $hydratorPool, EntityValueProcessorInterface $processor ) { - $this->hydrator = $hydrator; + $this->hydratorPool = $hydratorPool; $this->processor = $processor; } @@ -41,7 +41,7 @@ public function __construct( */ public function iterate($entity): void { - foreach ($this->hydrator->extract($entity) as $key => $value) { + foreach ($this->hydratorPool->getHydrator($entity)->extract($entity) as $key => $value) { $this->processor->process($entity, $key, $value); } } From 7d7394a8a0afc26897038d762187cf21eccb7c9b Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Thu, 2 May 2019 18:01:04 +0200 Subject: [PATCH 07/75] add attributes config --- etc/adminhtml/system/export.xml | 90 ++++++++++++++++++++++++--------- 1 file changed, 66 insertions(+), 24 deletions(-) diff --git a/etc/adminhtml/system/export.xml b/etc/adminhtml/system/export.xml index df97af2..41bda6b 100644 --- a/etc/adminhtml/system/export.xml +++ b/etc/adminhtml/system/export.xml @@ -6,17 +6,17 @@ */ --> - + 1 - + Magento\Config\Model\Config\Source\Enabledisable gdpr/export/enabled - + Magento\Cms\Model\Config\Source\Block @@ -24,7 +24,7 @@ gdpr/export/block_id - + Opengento\Gdpr\Model\Config\Source\ExportRenderer @@ -32,25 +32,67 @@ gdpr/export/renderer - - - This attributes list will be exported when processed. - Opengento\Gdpr\Model\Config\Source\CustomerAttributes - 1 - - 1 - - gdpr/export/customer_attributes - - - - This address attributes list will be exported when processed. - Opengento\Gdpr\Model\Config\Source\CustomerAddressAttributes - 1 - - 1 - - gdpr/export/customer_address_attributes - + + + + + This attributes list will be exported when processed. + Opengento\Gdpr\Model\Config\Source\CustomerAttributes + 1 + + 1 + + gdpr/export/customer_attributes + + + + + + + This address attributes list will be exported when processed. + Opengento\Gdpr\Model\Config\Source\CustomerAddressAttributes + 1 + + 1 + + gdpr/export/customer_address_attributes + + + + + + + Attributes must be separated with comma. + 1 + + 1 + + gdpr/export/quote_attributes + + + + + + + Attributes must be separated with comma. + 1 + + 1 + + gdpr/export/order_attributes + + + + + + + Attributes must be separated with comma. + 1 + + 1 + + gdpr/export/subscriber_attributes + + From 95020e8680a0f406c8881c3bc43f61f105082695 Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Fri, 3 May 2019 10:44:41 +0200 Subject: [PATCH 08/75] fix issue #11 - cookie popin does not show --- Block/Messages/PrivacyMessagePopup.php | 4 +--- view/frontend/layout/default.xml | 1 + view/frontend/templates/messages/popup.phtml | 4 ++-- view/frontend/web/css/source/_module.less | 4 ++++ 4 files changed, 8 insertions(+), 5 deletions(-) diff --git a/Block/Messages/PrivacyMessagePopup.php b/Block/Messages/PrivacyMessagePopup.php index e0d0fe5..d961f2d 100644 --- a/Block/Messages/PrivacyMessagePopup.php +++ b/Block/Messages/PrivacyMessagePopup.php @@ -49,9 +49,7 @@ public function __construct( Config $config, HelperPage $helperPage, Json $jsonSerializer, - array $data = [ - 'template' => 'Opengento_Gdpr::messages/popup.phtml', - ] + array $data = [] ) { $this->config = $config; $this->helperPage = $helperPage; diff --git a/view/frontend/layout/default.xml b/view/frontend/layout/default.xml index ff65e66..c26837c 100644 --- a/view/frontend/layout/default.xml +++ b/view/frontend/layout/default.xml @@ -10,6 +10,7 @@ + Opengento_Gdpr::messages/popup.phtml diff --git a/view/frontend/templates/messages/popup.phtml b/view/frontend/templates/messages/popup.phtml index 822b098..a440e03 100644 --- a/view/frontend/templates/messages/popup.phtml +++ b/view/frontend/templates/messages/popup.phtml @@ -5,12 +5,12 @@ */ /** @var \Opengento\Gdpr\Block\Messages\PrivacyMessagePopup $block */ ?> -
+
diff --git a/view/frontend/templates/order/info/erase.phtml b/view/frontend/templates/order/info/erase.phtml new file mode 100644 index 0000000..6bf0559 --- /dev/null +++ b/view/frontend/templates/order/info/erase.phtml @@ -0,0 +1,21 @@ +getData('eraseDataProvider'); +?> +
+
+ escapeHtml(__('Right to be forgotten')) ?> +
+
+
+ getErasureInformation() ?> +
+
+
diff --git a/view/frontend/templates/order/info/export.phtml b/view/frontend/templates/order/info/export.phtml new file mode 100644 index 0000000..b500de3 --- /dev/null +++ b/view/frontend/templates/order/info/export.phtml @@ -0,0 +1,21 @@ +getData('exportDataProvider'); +?> +
+
+ escapeHtml(__('Export Personal Data')) ?> +
+
+
+ getExportInformation() ?> +
+
+
diff --git a/view/frontend/web/css/source/_module.less b/view/frontend/web/css/source/_module.less index 46cce78..a263f15 100644 --- a/view/frontend/web/css/source/_module.less +++ b/view/frontend/web/css/source/_module.less @@ -1,3 +1,28 @@ +/** + * Copyright © OpenGento, All rights reserved. + * See LICENSE bundled with this library for license details. + */ + +@color-red: #ff0101; +@color-red2: #b30000; +@color-gray-light01: #f4f4f4; +@screen__m: 768px; + +&.action { + &.action-danger { + color: @color-red9; + } + &.primary.primary-danger { + background: @color-red9; + border: 1px solid @color-red9; + + &:hover { + background: @color-red11; + border: 1px solid @color-red11; + } + } +} + /** * This file is part of the Flurrybox EnhancedPrivacy package. * @@ -13,21 +38,6 @@ * file that was distributed with this source code. */ -@color-red: #ff0101; -@color-red2: #b30000; -@color-gray-light01: #f4f4f4; -@screen__m: 768px; - -&.action.primary.primary-danger { - background: @color-red9; - border: 1px solid @color-red9; - - &:hover { - background: @color-red11; - border: 1px solid @color-red11; - } -} - .enhanced-privacy-popup { position: absolute; right: 0; From a2896b78486f0c5385cf544d82978fe5b25267fc Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Fri, 14 Jun 2019 18:06:20 +0200 Subject: [PATCH 52/75] #12 WIP erase guest personal data --- Api/EraseGuestInterface.php | 25 +++++++ Api/EraseInterface.php | 2 +- Controller/AbstractGuest.php | 73 ++++++++++++++++++ Controller/Guest/Erase.php | 74 +++++++++++++++++++ Controller/Guest/Export.php | 23 +----- Controller/Privacy/ErasePost.php | 2 +- Service/EraseGuestManagement.php | 44 +++++++++++ ViewModel/Privacy/EraseGuestDataProvider.php | 1 + etc/di.xml | 1 + etc/frontend/di.xml | 6 +- view/frontend/templates/account/erase.phtml | 16 ++-- .../templates/order/info/buttons/erase.phtml | 5 ++ 12 files changed, 241 insertions(+), 31 deletions(-) create mode 100644 Api/EraseGuestInterface.php create mode 100644 Controller/AbstractGuest.php create mode 100644 Controller/Guest/Erase.php create mode 100644 Service/EraseGuestManagement.php diff --git a/Api/EraseGuestInterface.php b/Api/EraseGuestInterface.php new file mode 100644 index 0000000..a34c568 --- /dev/null +++ b/Api/EraseGuestInterface.php @@ -0,0 +1,25 @@ +orderLoader = $orderLoader; + $this->registry = $registry; + parent::__construct($context, $config); + } + + /** + * @inheritdoc + */ + public function execute() + { + if (($result = $this->orderLoader->load($this->getRequest())) instanceof ResultInterface) { + return $result; + } + if (!($this->registry->registry('current_order') instanceof OrderInterface)) { + return $this->forwardNoRoute(); + } + + return parent::execute(); + } + + /** + * Retrieve the current guest order + * + * @return \Magento\Sales\Api\Data\OrderInterface + */ + protected function retrieveOrder(): OrderInterface + { + return $this->registry->registry('current_order'); + } +} diff --git a/Controller/Guest/Erase.php b/Controller/Guest/Erase.php new file mode 100644 index 0000000..7525f6b --- /dev/null +++ b/Controller/Guest/Erase.php @@ -0,0 +1,74 @@ +eraseGuest = $eraseGuest; + parent::__construct($context, $config, $orderLoader, $registry); + } + + /** + * @inheritdoc + */ + protected function isAllowed(): bool + { + return parent::isAllowed() && $this->config->isErasureEnabled(); + } + + /** + * @inheritdoc + */ + protected function executeAction() + { + /** @var \Magento\Framework\Controller\Result\Redirect $resultRedirect */ + $resultRedirect = $this->resultFactory->create(ResultFactory::TYPE_REDIRECT); + $resultRedirect->setRefererOrBaseUrl(); + + try { + //todo refactor with eraseCustomer accepting guest? + $this->eraseGuest->erase($this->retrieveOrder()); + $this->messageManager->addWarningMessage(new Phrase('Your personal data is being removed.')); + } catch (LocalizedException $e) { + $this->messageManager->addErrorMessage($e->getMessage()); + } catch (\Exception $e) { + $this->messageManager->addExceptionMessage($e, new Phrase('Something went wrong, please try again later!')); + } + + return $resultRedirect; + } +} diff --git a/Controller/Guest/Export.php b/Controller/Guest/Export.php index dd168d4..578f53c 100755 --- a/Controller/Guest/Export.php +++ b/Controller/Guest/Export.php @@ -11,20 +11,19 @@ use Magento\Framework\App\Filesystem\DirectoryList; use Magento\Framework\App\Response\Http\FileFactory; use Magento\Framework\Controller\ResultFactory; -use Magento\Framework\Controller\ResultInterface; use Magento\Framework\Exception\LocalizedException; use Magento\Framework\Phrase; use Magento\Framework\Registry; use Magento\Sales\Controller\AbstractController\OrderLoaderInterface; use Opengento\Gdpr\Api\ExportGuestInterface; -use Opengento\Gdpr\Controller\AbstractAction; +use Opengento\Gdpr\Controller\AbstractGuest; use Opengento\Gdpr\Model\Archive\MoveToArchive; use Opengento\Gdpr\Model\Config; /** * Class Export */ -class Export extends AbstractAction +class Export extends AbstractGuest { /** * @var \Magento\Framework\App\Response\Http\FileFactory @@ -41,16 +40,6 @@ class Export extends AbstractAction */ private $exportManagement; - /** - * @var \Magento\Sales\Controller\AbstractController\OrderLoaderInterface - */ - private $orderLoader; - - /** - * @var \Magento\Framework\Registry - */ - private $registry; - /** * @param \Magento\Framework\App\Action\Context $context * @param \Opengento\Gdpr\Model\Config $config @@ -72,9 +61,7 @@ public function __construct( $this->fileFactory = $fileFactory; $this->moveToArchive = $moveToArchive; $this->exportManagement = $exportManagement; - $this->orderLoader = $orderLoader; - $this->registry = $registry; - parent::__construct($context, $config); + parent::__construct($context, $config, $orderLoader, $registry); } /** @@ -90,10 +77,6 @@ protected function isAllowed(): bool */ protected function executeAction() { - if (($result = $this->orderLoader->load($this->getRequest())) instanceof ResultInterface) { - return $result; - } - try { /** @var \Magento\Sales\Api\Data\OrderInterface $order */ $order = $this->registry->registry('current_order'); diff --git a/Controller/Privacy/ErasePost.php b/Controller/Privacy/ErasePost.php index 0313f06..69e1465 100755 --- a/Controller/Privacy/ErasePost.php +++ b/Controller/Privacy/ErasePost.php @@ -85,7 +85,7 @@ protected function executeAction() $customerId = (int) $this->session->getCustomerId(); $this->authentication->authenticate($customerId, $this->getRequest()->getParam('password')); $this->eraseCustomerManagement->create($customerId); - $this->messageManager->addWarningMessage(new Phrase('Your account is being removed.')); + $this->messageManager->addWarningMessage(new Phrase('Your personal data is being removed.')); } catch (InvalidEmailOrPasswordException $e) { $this->messageManager->addErrorMessage($e->getMessage()); $resultRedirect->setRefererOrBaseUrl(); diff --git a/Service/EraseGuestManagement.php b/Service/EraseGuestManagement.php new file mode 100644 index 0000000..5a4e764 --- /dev/null +++ b/Service/EraseGuestManagement.php @@ -0,0 +1,44 @@ +eraseComponents = $eraseComponents; + } + + /** + * @inheritdoc + */ + public function erase(OrderInterface $order): bool + { + foreach (\array_column($this->eraseComponents->toOptionArray(), 'value') as $component) { + //todo process component + } + + return true; + } +} diff --git a/ViewModel/Privacy/EraseGuestDataProvider.php b/ViewModel/Privacy/EraseGuestDataProvider.php index 0ed09e1..3e36771 100644 --- a/ViewModel/Privacy/EraseGuestDataProvider.php +++ b/ViewModel/Privacy/EraseGuestDataProvider.php @@ -47,6 +47,7 @@ public function __construct( * Check if the guest order can erase its personal data * * @return bool + * @todo move code to dedicated service */ public function canErase(): bool { diff --git a/etc/di.xml b/etc/di.xml index 6ed6898..36a7673 100644 --- a/etc/di.xml +++ b/etc/di.xml @@ -13,6 +13,7 @@ + diff --git a/etc/frontend/di.xml b/etc/frontend/di.xml index b0d5668..e1fbf13 100644 --- a/etc/frontend/di.xml +++ b/etc/frontend/di.xml @@ -19,10 +19,14 @@ Opengento\Gdpr\Model\Archive\MoveToZip + + + Magento\Sales\Controller\Guest\OrderLoader + + Opengento\Gdpr\Model\Archive\MoveToZip - Magento\Sales\Controller\Guest\OrderLoader diff --git a/view/frontend/templates/account/erase.phtml b/view/frontend/templates/account/erase.phtml index 7d0f1d0..dc7d4a1 100755 --- a/view/frontend/templates/account/erase.phtml +++ b/view/frontend/templates/account/erase.phtml @@ -48,19 +48,19 @@ $urlsDataProvider = $block->getData('urlsDataProvider'); + + +canCancel()): ?> + + escapeHtml(__('Undo Erase Personal Data')) ?> + + From 40351aa2369b51b008b5629da2492c42646fb441 Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Mon, 1 Jul 2019 18:21:48 +0200 Subject: [PATCH 62/75] WIP #13 enable guest action in admin ui --- Api/Data/ExportEntityInterface.php | 36 +++++++ ...hp => ExportEntityManagementInterface.php} | 12 +-- Console/Command/ExportCommand.php | 13 ++- Controller/Adminhtml/Guest/Erase.php | 63 ++++++++++++ Controller/Adminhtml/Guest/Export.php | 99 +++++++++++++++++++ Controller/Adminhtml/Privacy/Export.php | 19 +++- Controller/Adminhtml/Privacy/MassExport.php | 19 +++- Controller/Guest/Export.php | 19 +++- Controller/Privacy/Export.php | 19 +++- Model/Customer/CustomerChecker.php | 2 +- Model/Customer/Export/ExportCustomer.php | 26 +++++ Model/Entity/EntityCheckerInterface.php | 2 +- Model/EraseEntityChecker.php | 4 +- .../Export/AbstractExportEntityDecorator.php | 54 ++++++++++ Model/Export/ExportEntityFactory.php | 58 +++++++++++ Model/Export/ExportPersonalData.php | 24 +++++ Model/ExportEntity.php | 70 +++++++++++++ ...agement.php => ExportEntityManagement.php} | 16 +-- Model/Order/Export/ExportOrder.php | 26 +++++ Model/Order/OrderChecker.php | 4 +- TODO.md | 8 ++ etc/acl.xml | 10 ++ etc/adminhtml/di.xml | 8 ++ etc/adminhtml/routes.xml | 3 + etc/di.xml | 29 ++++-- etc/frontend/di.xml | 2 + 26 files changed, 596 insertions(+), 49 deletions(-) create mode 100644 Api/Data/ExportEntityInterface.php rename Api/{ExportInterface.php => ExportEntityManagementInterface.php} (51%) create mode 100644 Controller/Adminhtml/Guest/Erase.php create mode 100644 Controller/Adminhtml/Guest/Export.php create mode 100644 Model/Customer/Export/ExportCustomer.php create mode 100644 Model/Export/AbstractExportEntityDecorator.php create mode 100644 Model/Export/ExportEntityFactory.php create mode 100644 Model/Export/ExportPersonalData.php create mode 100644 Model/ExportEntity.php rename Model/{ExportManagement.php => ExportEntityManagement.php} (64%) create mode 100644 Model/Order/Export/ExportOrder.php diff --git a/Api/Data/ExportEntityInterface.php b/Api/Data/ExportEntityInterface.php new file mode 100644 index 0000000..8ccffbc --- /dev/null +++ b/Api/Data/ExportEntityInterface.php @@ -0,0 +1,36 @@ +appState = $appState; @@ -99,7 +100,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int try { foreach ($entityIds as $entityId) { - $out = $this->exportManagement->exportToFile((int) $entityId, $entityType, $fileName . '_' . $entityId); + $out = $this->exportManagement->export( + new ExportEntity((int) $entityId, $entityType, $fileName . '_' . $entityId) + ); $output->writeln('Entity\'s related data have been exported to: ' . $out . '.'); } } catch (\Exception $e) { diff --git a/Controller/Adminhtml/Guest/Erase.php b/Controller/Adminhtml/Guest/Erase.php new file mode 100644 index 0000000..ace4ddf --- /dev/null +++ b/Controller/Adminhtml/Guest/Erase.php @@ -0,0 +1,63 @@ +eraseEntityManagement = $eraseEntityManagement; + parent::__construct($context); + } + + /** + * @inheritdoc + */ + public function execute() + { + try { + $this->eraseEntityManagement->process( + $this->eraseEntityManagement->create((int) $this->getRequest()->getParam('id'), 'order') + ); + $this->messageManager->addSuccessMessage(new Phrase('You erased the order.')); + } catch (LocalizedException $e) { + $this->messageManager->addErrorMessage($e->getMessage()); + } catch (\Exception $e) { + $this->messageManager->addExceptionMessage($e, new Phrase('An error occurred on the server.')); + } + + /** @var \Magento\Backend\Model\View\Result\Redirect $resultRedirect */ + $resultRedirect = $this->resultFactory->create(ResultFactory::TYPE_REDIRECT); + + return $resultRedirect->setPath('sales/order/index'); + } +} diff --git a/Controller/Adminhtml/Guest/Export.php b/Controller/Adminhtml/Guest/Export.php new file mode 100644 index 0000000..3af30c2 --- /dev/null +++ b/Controller/Adminhtml/Guest/Export.php @@ -0,0 +1,99 @@ +fileFactory = $fileFactory; + $this->moveToArchive = $moveToArchive; + $this->exportManagement = $exportManagement; + $this->exportEntityFactory = $exportEntityFactory; + parent::__construct($context); + } + + /** + * @inheritdoc + */ + public function execute() + { + try { + $entityId = (int) $this->getRequest()->getParam('id'); + $fileName = $this->exportManagement->export($this->exportEntityFactory->create($entityId)); + $archiveFileName = 'guest_privacy_data_' . $entityId . '.zip'; + + return $this->fileFactory->create( + $archiveFileName, + [ + 'type' => 'filename', + 'value' => $this->moveToArchive->prepareArchive($fileName, $archiveFileName), + 'rm' => true, + ], + DirectoryList::TMP + ); + } catch (LocalizedException $e) { + $this->messageManager->addErrorMessage($e->getMessage()); + } catch (\Exception $e) { + $this->messageManager->addExceptionMessage($e, new Phrase('An error occurred on the server.')); + } + + /** @var \Magento\Backend\Model\View\Result\Redirect $resultRedirect */ + $resultRedirect = $this->resultFactory->create(ResultFactory::TYPE_REDIRECT); + + return $resultRedirect->setRefererOrBaseUrl(); + } +} diff --git a/Controller/Adminhtml/Privacy/Export.php b/Controller/Adminhtml/Privacy/Export.php index 35b3c87..3366cb7 100644 --- a/Controller/Adminhtml/Privacy/Export.php +++ b/Controller/Adminhtml/Privacy/Export.php @@ -14,8 +14,9 @@ use Magento\Framework\Controller\ResultFactory; use Magento\Framework\Exception\LocalizedException; use Magento\Framework\Phrase; -use Opengento\Gdpr\Api\ExportInterface; +use Opengento\Gdpr\Api\ExportEntityManagementInterface; use Opengento\Gdpr\Model\Archive\MoveToArchive; +use Opengento\Gdpr\Model\Export\ExportEntityFactory; /** * Class Export @@ -35,25 +36,33 @@ class Export extends Action private $moveToArchive; /** - * @var \Opengento\Gdpr\Api\ExportInterface + * @var \Opengento\Gdpr\Api\ExportEntityManagementInterface */ private $exportManagement; + /** + * @var \Opengento\Gdpr\Model\Export\ExportEntityFactory + */ + private $exportEntityFactory; + /** * @param \Magento\Backend\App\Action\Context $context * @param \Magento\Framework\App\Response\Http\FileFactory $fileFactory * @param \Opengento\Gdpr\Model\Archive\MoveToArchive $moveToArchive - * @param \Opengento\Gdpr\Api\ExportInterface $exportManagement + * @param \Opengento\Gdpr\Api\ExportEntityManagementInterface $exportManagement + * @param \Opengento\Gdpr\Model\Export\ExportEntityFactory $exportEntityFactory */ public function __construct( Context $context, FileFactory $fileFactory, MoveToArchive $moveToArchive, - ExportInterface $exportManagement + ExportEntityManagementInterface $exportManagement, + ExportEntityFactory $exportEntityFactory ) { $this->fileFactory = $fileFactory; $this->moveToArchive = $moveToArchive; $this->exportManagement = $exportManagement; + $this->exportEntityFactory = $exportEntityFactory; parent::__construct($context); } @@ -64,7 +73,7 @@ public function execute() { try { $customerId = (int) $this->getRequest()->getParam('id'); - $fileName = $this->exportManagement->exportToFile($customerId, 'personal_data', 'customer'); + $fileName = $this->exportManagement->export($this->exportEntityFactory->create($customerId)); $archiveFileName = 'customer_privacy_data_' . $customerId . '.zip'; return $this->fileFactory->create( diff --git a/Controller/Adminhtml/Privacy/MassExport.php b/Controller/Adminhtml/Privacy/MassExport.php index 80ea9a5..a1db7df 100644 --- a/Controller/Adminhtml/Privacy/MassExport.php +++ b/Controller/Adminhtml/Privacy/MassExport.php @@ -17,8 +17,9 @@ use Magento\Framework\Exception\LocalizedException; use Magento\Framework\Phrase; use Magento\Ui\Component\MassAction\Filter; -use Opengento\Gdpr\Api\ExportInterface; +use Opengento\Gdpr\Api\ExportEntityManagementInterface; use Opengento\Gdpr\Model\Archive\MoveToArchive; +use Opengento\Gdpr\Model\Export\ExportEntityFactory; /** * Class MassExport @@ -38,17 +39,23 @@ class MassExport extends AbstractMassAction private $moveToArchive; /** - * @var \Opengento\Gdpr\Api\ExportInterface + * @var \Opengento\Gdpr\Api\ExportEntityManagementInterface */ private $exportManagement; + /** + * @var \Opengento\Gdpr\Model\Export\ExportEntityFactory + */ + private $exportEntityFactory; + /** * @param \Magento\Backend\App\Action\Context $context * @param \Magento\Ui\Component\MassAction\Filter $filter * @param \Magento\Customer\Model\ResourceModel\Customer\CollectionFactory $collectionFactory * @param \Magento\Framework\App\Response\Http\FileFactory $fileFactory * @param \Opengento\Gdpr\Model\Archive\MoveToArchive $moveToArchive - * @param \Opengento\Gdpr\Api\ExportInterface $exportManagement + * @param \Opengento\Gdpr\Api\ExportEntityManagementInterface $exportManagement + * @param \Opengento\Gdpr\Model\Export\ExportEntityFactory $exportEntityFactory */ public function __construct( Context $context, @@ -56,11 +63,13 @@ public function __construct( CollectionFactory $collectionFactory, FileFactory $fileFactory, MoveToArchive $moveToArchive, - ExportInterface $exportManagement + ExportEntityManagementInterface $exportManagement, + ExportEntityFactory $exportEntityFactory ) { $this->fileFactory = $fileFactory; $this->moveToArchive = $moveToArchive; $this->exportManagement = $exportManagement; + $this->exportEntityFactory = $exportEntityFactory; parent::__construct($context, $filter, $collectionFactory); } @@ -75,7 +84,7 @@ protected function massAction(AbstractCollection $collection) foreach ($collection->getAllIds() as $customerId) { $this->moveToArchive->prepareArchive( $this->moveToArchive->prepareArchive( - $this->exportManagement->exportToFile((int) $customerId, 'personal_data', 'customer'), + $this->exportManagement->export($this->exportEntityFactory->create((int) $customerId)), 'customer_privacy_data_' . $customerId . '.zip' ), $archiveFileName diff --git a/Controller/Guest/Export.php b/Controller/Guest/Export.php index 29c9ef5..a1de941 100755 --- a/Controller/Guest/Export.php +++ b/Controller/Guest/Export.php @@ -15,10 +15,11 @@ use Magento\Framework\Phrase; use Magento\Framework\Registry; use Magento\Sales\Controller\AbstractController\OrderLoaderInterface; -use Opengento\Gdpr\Api\ExportInterface; +use Opengento\Gdpr\Api\ExportEntityManagementInterface; use Opengento\Gdpr\Controller\AbstractGuest; use Opengento\Gdpr\Model\Archive\MoveToArchive; use Opengento\Gdpr\Model\Config; +use Opengento\Gdpr\Model\Export\ExportEntityFactory; /** * Class Export @@ -36,16 +37,22 @@ class Export extends AbstractGuest private $moveToArchive; /** - * @var \Opengento\Gdpr\Api\ExportInterface + * @var \Opengento\Gdpr\Api\ExportEntityManagementInterface */ private $exportManagement; + /** + * @var \Opengento\Gdpr\Model\Export\ExportEntityFactory + */ + private $exportEntityFactory; + /** * @param \Magento\Framework\App\Action\Context $context * @param \Opengento\Gdpr\Model\Config $config * @param \Magento\Framework\App\Response\Http\FileFactory $fileFactory * @param \Opengento\Gdpr\Model\Archive\MoveToArchive $moveToArchive - * @param \Opengento\Gdpr\Api\ExportInterface $exportManagement + * @param \Opengento\Gdpr\Api\ExportEntityManagementInterface $exportManagement + * @param \Opengento\Gdpr\Model\Export\ExportEntityFactory $exportEntityFactory * @param \Magento\Sales\Controller\AbstractController\OrderLoaderInterface $orderLoader * @param \Magento\Framework\Registry $registry */ @@ -54,13 +61,15 @@ public function __construct( Config $config, FileFactory $fileFactory, MoveToArchive $moveToArchive, - ExportInterface $exportManagement, + ExportEntityManagementInterface $exportManagement, + ExportEntityFactory $exportEntityFactory, OrderLoaderInterface $orderLoader, Registry $registry ) { $this->fileFactory = $fileFactory; $this->moveToArchive = $moveToArchive; $this->exportManagement = $exportManagement; + $this->exportEntityFactory = $exportEntityFactory; parent::__construct($context, $config, $orderLoader, $registry); } @@ -80,7 +89,7 @@ protected function executeAction() try { /** @var \Magento\Sales\Api\Data\OrderInterface $order */ $order = $this->registry->registry('current_order'); - $fileName = $this->exportManagement->exportToFile($this->retrieveOrderId(), 'order', 'personal_data'); + $fileName = $this->exportManagement->export($this->exportEntityFactory->create($this->retrieveOrderId())); $archiveFileName = 'customer_privacy_data_' . $order->getCustomerLastname() . '.zip'; return $this->fileFactory->create( diff --git a/Controller/Privacy/Export.php b/Controller/Privacy/Export.php index 9e54423..d2e2d94 100755 --- a/Controller/Privacy/Export.php +++ b/Controller/Privacy/Export.php @@ -14,10 +14,11 @@ use Magento\Framework\Controller\ResultFactory; use Magento\Framework\Exception\LocalizedException; use Magento\Framework\Phrase; -use Opengento\Gdpr\Api\ExportInterface; +use Opengento\Gdpr\Api\ExportEntityManagementInterface; use Opengento\Gdpr\Controller\AbstractPrivacy; use Opengento\Gdpr\Model\Archive\MoveToArchive; use Opengento\Gdpr\Model\Config; +use Opengento\Gdpr\Model\Export\ExportEntityFactory; /** * Action Export Export @@ -35,10 +36,15 @@ class Export extends AbstractPrivacy private $moveToArchive; /** - * @var \Opengento\Gdpr\Api\ExportInterface + * @var \Opengento\Gdpr\Api\ExportEntityManagementInterface */ private $exportManagement; + /** + * @var \Opengento\Gdpr\Model\Export\ExportEntityFactory + */ + private $exportEntityFactory; + /** * @var \Magento\Customer\Model\Session */ @@ -49,7 +55,8 @@ class Export extends AbstractPrivacy * @param \Opengento\Gdpr\Model\Config $config * @param \Magento\Framework\App\Response\Http\FileFactory $fileFactory * @param \Opengento\Gdpr\Model\Archive\MoveToArchive $moveToArchive - * @param \Opengento\Gdpr\Api\ExportInterface $exportManagement + * @param \Opengento\Gdpr\Api\ExportEntityManagementInterface $exportManagement + * @param \Opengento\Gdpr\Model\Export\ExportEntityFactory $exportEntityFactory * @param \Magento\Customer\Model\Session $customerSession */ public function __construct( @@ -57,12 +64,14 @@ public function __construct( Config $config, FileFactory $fileFactory, MoveToArchive $moveToArchive, - ExportInterface $exportManagement, + ExportEntityManagementInterface $exportManagement, + ExportEntityFactory $exportEntityFactory, Session $customerSession ) { $this->fileFactory = $fileFactory; $this->moveToArchive = $moveToArchive; $this->exportManagement = $exportManagement; + $this->exportEntityFactory = $exportEntityFactory; $this->customerSession = $customerSession; parent::__construct($context, $config); } @@ -82,7 +91,7 @@ protected function executeAction() { try { $customerId = (int) $this->customerSession->getCustomerId(); - $fileName = $this->exportManagement->exportToFile($customerId, 'customer', 'personal_data'); + $fileName = $this->exportManagement->export($this->exportEntityFactory->create($customerId)); $archiveFileName = 'customer_privacy_data_' . $customerId . '.zip'; return $this->fileFactory->create( diff --git a/Model/Customer/CustomerChecker.php b/Model/Customer/CustomerChecker.php index 363bbf3..0a6d056 100644 --- a/Model/Customer/CustomerChecker.php +++ b/Model/Customer/CustomerChecker.php @@ -57,7 +57,7 @@ public function __construct( /** * @inheritdoc */ - public function hasPendingOrders(int $customerId, bool $forceReload = false): bool + public function canErase(int $customerId, bool $forceReload = false): bool { if ($forceReload || !isset($this->cache[$customerId])) { $this->searchCriteriaBuilder->addFilter(OrderInterface::STATE, $this->config->getAllowedStatesToErase(), 'nin'); diff --git a/Model/Customer/Export/ExportCustomer.php b/Model/Customer/Export/ExportCustomer.php new file mode 100644 index 0000000..ce0a951 --- /dev/null +++ b/Model/Customer/Export/ExportCustomer.php @@ -0,0 +1,26 @@ +entityCheckerFactory->get($entityType); - return !$this->exists($entityId, $entityType) && !$entityChecker->hasPendingOrders($entityId); + return !$this->exists($entityId, $entityType) && $entityChecker->canErase($entityId); } /** @@ -93,6 +93,6 @@ public function canProcess(int $entityId, string $entityType): bool && $entity->getStatus() === EraseEntityInterface::STATUS_READY) || ($entity->getState() === EraseEntityInterface::STATE_PROCESSING && $entity->getStatus() === EraseEntityInterface::STATUS_FAILED)) - && !$entityChecker->hasPendingOrders($entityId); + && $entityChecker->canErase($entityId); } } diff --git a/Model/Export/AbstractExportEntityDecorator.php b/Model/Export/AbstractExportEntityDecorator.php new file mode 100644 index 0000000..bdb42d5 --- /dev/null +++ b/Model/Export/AbstractExportEntityDecorator.php @@ -0,0 +1,54 @@ +exportEntity = $exportEntity; + } + + /** + * @inheritdoc + */ + public function getEntityId(): int + { + return $this->exportEntity->getEntityId(); + } + + /** + * @inheritdoc + */ + public function getEntityType(): string + { + return $this->exportEntity->getEntityType(); + } + + /** + * @inheritdoc + */ + public function getFileName(): string + { + return $this->exportEntity->getFileName(); + } +} diff --git a/Model/Export/ExportEntityFactory.php b/Model/Export/ExportEntityFactory.php new file mode 100644 index 0000000..7756aba --- /dev/null +++ b/Model/Export/ExportEntityFactory.php @@ -0,0 +1,58 @@ +exportEntityList = $exportEntityList; + $this->objectManager = $objectManager; + } + + /** + * Create export entity information + * + * @param int $entityId + * @return \Opengento\Gdpr\Api\Data\ExportEntityInterface + */ + public function create(int $entityId): ExportEntityInterface + { + $exportEntity = new ExportEntity($entityId); + + foreach ($this->exportEntityList as $exportEntityItem) { + $exportEntity = $this->objectManager->create($exportEntityItem, ['exportEntity' => $exportEntity]); + } + + return $exportEntity; + } +} diff --git a/Model/Export/ExportPersonalData.php b/Model/Export/ExportPersonalData.php new file mode 100644 index 0000000..bd68cd4 --- /dev/null +++ b/Model/Export/ExportPersonalData.php @@ -0,0 +1,24 @@ +entityId = $entityId; + $this->entityType = $entityType; + $this->fileName = $fileName; + } + + /** + * @inheritdoc + */ + public function getEntityId(): int + { + return $this->entityId; + } + + /** + * @inheritdoc + */ + public function getEntityType(): string + { + return $this->entityType; + } + + /** + * @inheritdoc + */ + public function getFileName(): string + { + return $this->fileName; + } +} diff --git a/Model/ExportManagement.php b/Model/ExportEntityManagement.php similarity index 64% rename from Model/ExportManagement.php rename to Model/ExportEntityManagement.php index c111bca..944382f 100644 --- a/Model/ExportManagement.php +++ b/Model/ExportEntityManagement.php @@ -7,14 +7,15 @@ namespace Opengento\Gdpr\Model; -use Opengento\Gdpr\Api\ExportInterface; +use Opengento\Gdpr\Api\Data\ExportEntityInterface; +use Opengento\Gdpr\Api\ExportEntityManagementInterface; use Opengento\Gdpr\Service\Export\ProcessorFactory; use Opengento\Gdpr\Service\Export\RendererInterface; /** - * Class ExportManagement + * Class ExportEntityManagement */ -final class ExportManagement implements ExportInterface +final class ExportEntityManagement implements ExportEntityManagementInterface { /** * @var \Opengento\Gdpr\Service\Export\ProcessorFactory @@ -41,10 +42,13 @@ public function __construct( /** * @inheritdoc */ - public function exportToFile(int $entityId, string $entityType, string $fileName): string + public function export(ExportEntityInterface $exportEntity): string { - $exporter = $this->exportProcessorFactory->get($entityType); + $exporter = $this->exportProcessorFactory->get($exportEntity->getEntityType()); - return $this->exportRenderer->saveData($fileName, $exporter->execute($entityId, [])); + return $this->exportRenderer->saveData( + $exportEntity->getFileName(), + $exporter->execute($exportEntity->getEntityId(), []) + ); } } diff --git a/Model/Order/Export/ExportOrder.php b/Model/Order/Export/ExportOrder.php new file mode 100644 index 0000000..2dabe98 --- /dev/null +++ b/Model/Order/Export/ExportOrder.php @@ -0,0 +1,26 @@ +orderRepository->get($orderId); - return \in_array($order->getState(), $this->config->getAllowedStatesToErase(), true); + return !$order->getCustomerId() && \in_array($order->getState(), $this->config->getAllowedStatesToErase(), true); } } diff --git a/TODO.md b/TODO.md index 2017423..20ab3fd 100644 --- a/TODO.md +++ b/TODO.md @@ -75,6 +75,14 @@ GDPR facade for customer actions - Frontend UI (OK) - Console (OK) +## Notification + +notify customer from its requests + +## Admin + +enable action for guests (guest orders) + ## yu https://github.com/magento/architecture/pull/145/files diff --git a/etc/acl.xml b/etc/acl.xml index 8a20234..d657f60 100755 --- a/etc/acl.xml +++ b/etc/acl.xml @@ -17,6 +17,16 @@ + + + + + + + + + + diff --git a/etc/adminhtml/di.xml b/etc/adminhtml/di.xml index 2688a81..a44c64b 100644 --- a/etc/adminhtml/di.xml +++ b/etc/adminhtml/di.xml @@ -14,11 +14,19 @@ Opengento\Gdpr\Model\Archive\MoveToZip + Opengento\Gdpr\Model\Customer\Export\ExportCustomerFactory Opengento\Gdpr\Model\Archive\MoveToZip + Opengento\Gdpr\Model\Customer\Export\ExportCustomerFactory + + + + + Opengento\Gdpr\Model\Archive\MoveToZip + Opengento\Gdpr\Model\Order\Export\ExportOrderFactory diff --git a/etc/adminhtml/routes.xml b/etc/adminhtml/routes.xml index 296cf02..81c6c76 100644 --- a/etc/adminhtml/routes.xml +++ b/etc/adminhtml/routes.xml @@ -10,5 +10,8 @@ + + + diff --git a/etc/di.xml b/etc/di.xml index 95c9bd6..6f7527e 100644 --- a/etc/di.xml +++ b/etc/di.xml @@ -7,12 +7,13 @@ --> - - - - - - + + + + + + + @@ -731,6 +732,14 @@ + + + + Opengento\Gdpr\Model\Customer\Export\ExportCustomer + Opengento\Gdpr\Model\Export\ExportPersonalData + + + @@ -741,6 +750,14 @@ + + + + Opengento\Gdpr\Model\Order\Export\ExportOrder + Opengento\Gdpr\Model\Export\ExportPersonalData + + + diff --git a/etc/frontend/di.xml b/etc/frontend/di.xml index e1fbf13..a05c8d3 100644 --- a/etc/frontend/di.xml +++ b/etc/frontend/di.xml @@ -17,6 +17,7 @@ Opengento\Gdpr\Model\Archive\MoveToZip + Opengento\Gdpr\Model\Customer\Export\ExportCustomerFactory @@ -27,6 +28,7 @@ Opengento\Gdpr\Model\Archive\MoveToZip + Opengento\Gdpr\Model\Order\Export\ExportOrderFactory From 0cc3afc10caa4b0ac8d015304f3e5f4b599b42e4 Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Thu, 4 Jul 2019 17:21:15 +0200 Subject: [PATCH 63/75] fix #13 add guest action in admin ui --- Block/Adminhtml/Customer/Edit/EraseButton.php | 18 ++++- .../Adminhtml/Customer/Edit/ExportButton.php | 26 +++++- Block/Adminhtml/Order/Edit/EraseButton.php | 69 ++++++++++++++++ Block/Adminhtml/Order/Edit/ExportButton.php | 59 ++++++++++++++ Controller/Adminhtml/AbstractAction.php | 80 +++++++++++++++++++ Controller/Adminhtml/Guest/Erase.php | 11 ++- Controller/Adminhtml/Guest/Export.php | 11 ++- Controller/Adminhtml/Privacy/Erase.php | 11 ++- Controller/Adminhtml/Privacy/Export.php | 11 ++- etc/adminhtml/system/cookie.xml | 1 + etc/adminhtml/system/erasure.xml | 3 +- etc/adminhtml/system/export.xml | 3 +- etc/adminhtml/system/general.xml | 1 + view/adminhtml/layout/sales_order_view.xml | 15 ++++ view/frontend/templates/account/erase.phtml | 2 +- .../templates/account/privacy/erase.phtml | 2 +- 16 files changed, 298 insertions(+), 25 deletions(-) create mode 100644 Block/Adminhtml/Order/Edit/EraseButton.php create mode 100644 Block/Adminhtml/Order/Edit/ExportButton.php create mode 100644 Controller/Adminhtml/AbstractAction.php create mode 100644 view/adminhtml/layout/sales_order_view.xml diff --git a/Block/Adminhtml/Customer/Edit/EraseButton.php b/Block/Adminhtml/Customer/Edit/EraseButton.php index b68423b..088f7bc 100644 --- a/Block/Adminhtml/Customer/Edit/EraseButton.php +++ b/Block/Adminhtml/Customer/Edit/EraseButton.php @@ -13,6 +13,7 @@ use Magento\Framework\Registry; use Magento\Framework\View\Element\UiComponent\Control\ButtonProviderInterface; use Opengento\Gdpr\Api\EraseEntityCheckerInterface; +use Opengento\Gdpr\Model\Config; /** * Class EraseButton @@ -24,17 +25,25 @@ final class EraseButton extends GenericButton implements ButtonProviderInterface */ private $eraseCustomerChecker; + /** + * @var \Opengento\Gdpr\Model\Config + */ + private $config; + /** * @param \Magento\Backend\Block\Widget\Context $context * @param \Magento\Framework\Registry $registry * @param \Opengento\Gdpr\Api\EraseEntityCheckerInterface $eraseCustomerChecker + * @param \Opengento\Gdpr\Model\Config $config */ public function __construct( Context $context, Registry $registry, - EraseEntityCheckerInterface $eraseCustomerChecker + EraseEntityCheckerInterface $eraseCustomerChecker, + Config $config ) { $this->eraseCustomerChecker = $eraseCustomerChecker; + $this->config = $config; parent::__construct($context, $registry); } @@ -46,9 +55,12 @@ public function getButtonData(): array $customerId = $this->getCustomerId(); $buttonData = []; - if ($customerId && $this->eraseCustomerChecker->canCreate($customerId, 'customer')) { + if ($customerId && + $this->config->isModuleEnabled() && + $this->eraseCustomerChecker->canCreate($customerId, 'customer') + ) { $buttonData = [ - 'label' => new Phrase('Erase Customer'), + 'label' => new Phrase('Erase Personal Data'), 'class' => 'erase', 'id' => 'customer-edit-erase-button', 'on_click' => 'deleteConfirm("' . new Phrase('Are you sure you want to do this?') . '", ' diff --git a/Block/Adminhtml/Customer/Edit/ExportButton.php b/Block/Adminhtml/Customer/Edit/ExportButton.php index 71b58ef..09b4d5a 100644 --- a/Block/Adminhtml/Customer/Edit/ExportButton.php +++ b/Block/Adminhtml/Customer/Edit/ExportButton.php @@ -7,15 +7,37 @@ namespace Opengento\Gdpr\Block\Adminhtml\Customer\Edit; +use Magento\Backend\Block\Widget\Context; use Magento\Customer\Block\Adminhtml\Edit\GenericButton; use Magento\Framework\Phrase; +use Magento\Framework\Registry; use Magento\Framework\View\Element\UiComponent\Control\ButtonProviderInterface; +use Opengento\Gdpr\Model\Config; /** * Class ExportButton */ final class ExportButton extends GenericButton implements ButtonProviderInterface { + /** + * @var \Opengento\Gdpr\Model\Config + */ + private $config; + + /** + * @param \Magento\Backend\Block\Widget\Context $context + * @param \Magento\Framework\Registry $registry + * @param \Opengento\Gdpr\Model\Config $config + */ + public function __construct( + Context $context, + Registry $registry, + Config $config + ) { + $this->config = $config; + parent::__construct($context, $registry); + } + /** * @inheritdoc */ @@ -24,9 +46,9 @@ public function getButtonData(): array $customerId = $this->getCustomerId(); $buttonData = []; - if ($customerId) { + if ($customerId && $this->config->isModuleEnabled()) { $buttonData = [ - 'label' => new Phrase('Export Customer'), + 'label' => new Phrase('Export Personal Data'), 'class' => 'Export', 'id' => 'customer-edit-export-button', 'on_click' => 'deleteConfirm("' . new Phrase('Are you sure you want to do this?') . '", ' diff --git a/Block/Adminhtml/Order/Edit/EraseButton.php b/Block/Adminhtml/Order/Edit/EraseButton.php new file mode 100644 index 0000000..73a781e --- /dev/null +++ b/Block/Adminhtml/Order/Edit/EraseButton.php @@ -0,0 +1,69 @@ +_authorization = $context->getAuthorization(); + $this->eraseEntityChecker = $eraseEntityChecker; + parent::__construct($context, $data); + } + + /** + * @inheritdoc + * @throws \Magento\Framework\Exception\LocalizedException + */ + protected function _construct(): void + { + parent::_construct(); + + /** @var \Magento\Sales\Block\Adminhtml\Order\View $orderView */ + $orderView = $this->getLayout()->getBlock('sales_order_edit'); + $orderId = (int) $orderView->getOrderId(); + + if ($this->_authorization->isAllowed('Opengento_Gdpr::order_erase') && + $this->eraseEntityChecker->canCreate($orderId, 'order') + ) { + $confirmMessage = new Phrase('Are you sure you want to do this?'); + $eraseUrl = $this->getUrl('sales/guest/erase', ['id' => $orderId]); + + $orderView->addButton( + 'order-view-erase-button', + [ + 'label' => new Phrase('Erase Personal Data'), + 'class' => 'action-secondary erase', + 'onclick' => 'deleteConfirm("' . $confirmMessage . '", "' . $eraseUrl . '", {"data":{}})', + ], + 1 + ); + } + } +} diff --git a/Block/Adminhtml/Order/Edit/ExportButton.php b/Block/Adminhtml/Order/Edit/ExportButton.php new file mode 100644 index 0000000..b3da898 --- /dev/null +++ b/Block/Adminhtml/Order/Edit/ExportButton.php @@ -0,0 +1,59 @@ +_authorization = $context->getAuthorization(); + parent::__construct($context, $data); + } + + /** + * @inheritdoc + * @throws \Magento\Framework\Exception\LocalizedException + */ + protected function _construct(): void + { + parent::_construct(); + + /** @var \Magento\Sales\Block\Adminhtml\Order\View $orderView */ + $orderView = $this->getLayout()->getBlock('sales_order_edit'); + $orderId = (int) $orderView->getOrderId(); + + if ($this->_authorization->isAllowed('Opengento_Gdpr::order_export')) { + $orderView->addButton( + 'order-view-export-button', + [ + 'label' => new Phrase('Export Personal Data'), + 'class' => 'export', + 'onclick' => 'setLocation("' . $this->getUrl('sales/guest/export', ['id' => $orderId]) . '")', + ] + ); + } + } +} diff --git a/Controller/Adminhtml/AbstractAction.php b/Controller/Adminhtml/AbstractAction.php new file mode 100644 index 0000000..42e1015 --- /dev/null +++ b/Controller/Adminhtml/AbstractAction.php @@ -0,0 +1,80 @@ +config = $config; + parent::__construct($context); + } + + /** + * @inheritdoc + */ + public function execute() + { + if ($this->isAllowed()) { + return $this->executeAction(); + } + + return $this->forwardNoRoute(); + } + + /** + * Execute action based on request and return result + * + * @return \Magento\Framework\Controller\ResultInterface|\Magento\Framework\App\ResponseInterface + * @throws \Magento\Framework\Exception\NotFoundException + */ + abstract protected function executeAction(); + + /** + * Check if the execution of the action is allowed + * + * @return bool + */ + protected function isAllowed(): bool + { + return $this->config->isModuleEnabled(); + } + + /** + * Create a result forward to 404 + * + * @return \Magento\Framework\Controller\ResultInterface + */ + protected function forwardNoRoute(): ResultInterface + { + /** @var \Magento\Backend\Model\View\Result\Forward $resultForward */ + $resultForward = $this->resultFactory->create(ResultFactory::TYPE_FORWARD); + + return $resultForward->forward('no_route'); + } +} diff --git a/Controller/Adminhtml/Guest/Erase.php b/Controller/Adminhtml/Guest/Erase.php index ace4ddf..29a084a 100644 --- a/Controller/Adminhtml/Guest/Erase.php +++ b/Controller/Adminhtml/Guest/Erase.php @@ -7,18 +7,19 @@ namespace Opengento\Gdpr\Controller\Adminhtml\Guest; -use Magento\Backend\App\Action; use Magento\Backend\App\Action\Context; use Magento\Framework\App\Action\HttpPostActionInterface; use Magento\Framework\Controller\ResultFactory; use Magento\Framework\Exception\LocalizedException; use Magento\Framework\Phrase; use Opengento\Gdpr\Api\EraseEntityManagementInterface; +use Opengento\Gdpr\Controller\Adminhtml\AbstractAction; +use Opengento\Gdpr\Model\Config; /** * Class Erase */ -class Erase extends Action implements HttpPostActionInterface +class Erase extends AbstractAction implements HttpPostActionInterface { public const ADMIN_RESOURCE = 'Opengento_Gdpr::order_erase'; @@ -29,20 +30,22 @@ class Erase extends Action implements HttpPostActionInterface /** * @param \Magento\Backend\App\Action\Context $context + * @param \Opengento\Gdpr\Model\Config $config * @param \Opengento\Gdpr\Api\EraseEntityManagementInterface $eraseEntityManagement */ public function __construct( Context $context, + Config $config, EraseEntityManagementInterface $eraseEntityManagement ) { $this->eraseEntityManagement = $eraseEntityManagement; - parent::__construct($context); + parent::__construct($context, $config); } /** * @inheritdoc */ - public function execute() + protected function executeAction() { try { $this->eraseEntityManagement->process( diff --git a/Controller/Adminhtml/Guest/Export.php b/Controller/Adminhtml/Guest/Export.php index 3af30c2..168110e 100644 --- a/Controller/Adminhtml/Guest/Export.php +++ b/Controller/Adminhtml/Guest/Export.php @@ -7,7 +7,6 @@ namespace Opengento\Gdpr\Controller\Adminhtml\Guest; -use Magento\Backend\App\Action; use Magento\Backend\App\Action\Context; use Magento\Framework\App\Filesystem\DirectoryList; use Magento\Framework\App\Response\Http\FileFactory; @@ -15,13 +14,15 @@ use Magento\Framework\Exception\LocalizedException; use Magento\Framework\Phrase; use Opengento\Gdpr\Api\ExportEntityManagementInterface; +use Opengento\Gdpr\Controller\Adminhtml\AbstractAction; use Opengento\Gdpr\Model\Archive\MoveToArchive; +use Opengento\Gdpr\Model\Config; use Opengento\Gdpr\Model\Export\ExportEntityFactory; /** * Class Export */ -class Export extends Action +class Export extends AbstractAction { public const ADMIN_RESOURCE = 'Opengento_Gdpr::order_export'; @@ -47,6 +48,7 @@ class Export extends Action /** * @param \Magento\Backend\App\Action\Context $context + * @param \Opengento\Gdpr\Model\Config $config * @param \Magento\Framework\App\Response\Http\FileFactory $fileFactory * @param \Opengento\Gdpr\Model\Archive\MoveToArchive $moveToArchive * @param \Opengento\Gdpr\Api\ExportEntityManagementInterface $exportManagement @@ -54,6 +56,7 @@ class Export extends Action */ public function __construct( Context $context, + Config $config, FileFactory $fileFactory, MoveToArchive $moveToArchive, ExportEntityManagementInterface $exportManagement, @@ -63,13 +66,13 @@ public function __construct( $this->moveToArchive = $moveToArchive; $this->exportManagement = $exportManagement; $this->exportEntityFactory = $exportEntityFactory; - parent::__construct($context); + parent::__construct($context, $config); } /** * @inheritdoc */ - public function execute() + protected function executeAction() { try { $entityId = (int) $this->getRequest()->getParam('id'); diff --git a/Controller/Adminhtml/Privacy/Erase.php b/Controller/Adminhtml/Privacy/Erase.php index 3955897..bdabb7b 100644 --- a/Controller/Adminhtml/Privacy/Erase.php +++ b/Controller/Adminhtml/Privacy/Erase.php @@ -7,18 +7,19 @@ namespace Opengento\Gdpr\Controller\Adminhtml\Privacy; -use Magento\Backend\App\Action; use Magento\Backend\App\Action\Context; use Magento\Framework\App\Action\HttpPostActionInterface; use Magento\Framework\Controller\ResultFactory; use Magento\Framework\Exception\LocalizedException; use Magento\Framework\Phrase; use Opengento\Gdpr\Api\EraseEntityManagementInterface; +use Opengento\Gdpr\Controller\Adminhtml\AbstractAction; +use Opengento\Gdpr\Model\Config; /** * Class Erase */ -class Erase extends Action implements HttpPostActionInterface +class Erase extends AbstractAction implements HttpPostActionInterface { public const ADMIN_RESOURCE = 'Opengento_Gdpr::customer_erase'; @@ -29,20 +30,22 @@ class Erase extends Action implements HttpPostActionInterface /** * @param \Magento\Backend\App\Action\Context $context + * @param \Opengento\Gdpr\Model\Config $config * @param \Opengento\Gdpr\Api\EraseEntityManagementInterface $eraseEntityManagement */ public function __construct( Context $context, + Config $config, EraseEntityManagementInterface $eraseEntityManagement ) { $this->eraseEntityManagement = $eraseEntityManagement; - parent::__construct($context); + parent::__construct($context, $config); } /** * @inheritdoc */ - public function execute() + protected function executeAction() { try { $this->eraseEntityManagement->process( diff --git a/Controller/Adminhtml/Privacy/Export.php b/Controller/Adminhtml/Privacy/Export.php index 3366cb7..216637e 100644 --- a/Controller/Adminhtml/Privacy/Export.php +++ b/Controller/Adminhtml/Privacy/Export.php @@ -7,7 +7,6 @@ namespace Opengento\Gdpr\Controller\Adminhtml\Privacy; -use Magento\Backend\App\Action; use Magento\Backend\App\Action\Context; use Magento\Framework\App\Filesystem\DirectoryList; use Magento\Framework\App\Response\Http\FileFactory; @@ -15,13 +14,15 @@ use Magento\Framework\Exception\LocalizedException; use Magento\Framework\Phrase; use Opengento\Gdpr\Api\ExportEntityManagementInterface; +use Opengento\Gdpr\Controller\Adminhtml\AbstractAction; use Opengento\Gdpr\Model\Archive\MoveToArchive; +use Opengento\Gdpr\Model\Config; use Opengento\Gdpr\Model\Export\ExportEntityFactory; /** * Class Export */ -class Export extends Action +class Export extends AbstractAction { public const ADMIN_RESOURCE = 'Opengento_Gdpr::customer_export'; @@ -47,6 +48,7 @@ class Export extends Action /** * @param \Magento\Backend\App\Action\Context $context + * @param \Opengento\Gdpr\Model\Config $config * @param \Magento\Framework\App\Response\Http\FileFactory $fileFactory * @param \Opengento\Gdpr\Model\Archive\MoveToArchive $moveToArchive * @param \Opengento\Gdpr\Api\ExportEntityManagementInterface $exportManagement @@ -54,6 +56,7 @@ class Export extends Action */ public function __construct( Context $context, + Config $config, FileFactory $fileFactory, MoveToArchive $moveToArchive, ExportEntityManagementInterface $exportManagement, @@ -63,13 +66,13 @@ public function __construct( $this->moveToArchive = $moveToArchive; $this->exportManagement = $exportManagement; $this->exportEntityFactory = $exportEntityFactory; - parent::__construct($context); + parent::__construct($context, $config); } /** * @inheritdoc */ - public function execute() + protected function executeAction() { try { $customerId = (int) $this->getRequest()->getParam('id'); diff --git a/etc/adminhtml/system/cookie.xml b/etc/adminhtml/system/cookie.xml index 0864803..9b00426 100644 --- a/etc/adminhtml/system/cookie.xml +++ b/etc/adminhtml/system/cookie.xml @@ -15,6 +15,7 @@ Magento\Config\Model\Config\Source\Enabledisable gdpr/cookie/enabled + It will enable the cookie disclosure popin to the storefront. diff --git a/etc/adminhtml/system/erasure.xml b/etc/adminhtml/system/erasure.xml index c04a4df..31041f2 100644 --- a/etc/adminhtml/system/erasure.xml +++ b/etc/adminhtml/system/erasure.xml @@ -11,10 +11,11 @@ 1 - + Magento\Config\Model\Config\Source\Enabledisable gdpr/erasure/enabled + It will enable the erase action to the storefront. diff --git a/etc/adminhtml/system/export.xml b/etc/adminhtml/system/export.xml index 4758931..e0855da 100644 --- a/etc/adminhtml/system/export.xml +++ b/etc/adminhtml/system/export.xml @@ -11,10 +11,11 @@ 1 - + Magento\Config\Model\Config\Source\Enabledisable gdpr/export/enabled + It will enable the export action to the storefront. diff --git a/etc/adminhtml/system/general.xml b/etc/adminhtml/system/general.xml index 017fb7b..b6b741e 100644 --- a/etc/adminhtml/system/general.xml +++ b/etc/adminhtml/system/general.xml @@ -12,6 +12,7 @@ Magento\Config\Model\Config\Source\Yesno gdpr/general/enabled + It will enable the module features in the admin and frontend ui. diff --git a/view/adminhtml/layout/sales_order_view.xml b/view/adminhtml/layout/sales_order_view.xml new file mode 100644 index 0000000..17478eb --- /dev/null +++ b/view/adminhtml/layout/sales_order_view.xml @@ -0,0 +1,15 @@ + + + + + + + + + + diff --git a/view/frontend/templates/account/erase.phtml b/view/frontend/templates/account/erase.phtml index dc7d4a1..eeab2a7 100755 --- a/view/frontend/templates/account/erase.phtml +++ b/view/frontend/templates/account/erase.phtml @@ -34,7 +34,7 @@ $urlsDataProvider = $block->getData('urlsDataProvider');
diff --git a/view/frontend/templates/account/privacy/erase.phtml b/view/frontend/templates/account/privacy/erase.phtml index 00b1b63..a677e6e 100755 --- a/view/frontend/templates/account/privacy/erase.phtml +++ b/view/frontend/templates/account/privacy/erase.phtml @@ -39,7 +39,7 @@ $urlsDataProvider = $block->getData('urlsDataProvider');
- escapeHtml(__('Erase Account')) ?> + escapeHtml(__('Erase Personal Data')) ?>
From b300d4c9574223e4fdae5d9bb9ce3fcb2c417794 Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Thu, 4 Jul 2019 17:57:36 +0200 Subject: [PATCH 64/75] move file location and rename --- Cron/{Erasure.php => EraseEntity.php} | 16 ++++++++-------- .../Customer}/Anonymize/AccountBlocker.php | 2 +- .../Processor/CustomerDataProcessor.php | 6 +++--- etc/crontab.xml | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) rename Cron/{Erasure.php => EraseEntity.php} (91%) rename {Service => Model/Customer}/Anonymize/AccountBlocker.php (98%) diff --git a/Cron/Erasure.php b/Cron/EraseEntity.php similarity index 91% rename from Cron/Erasure.php rename to Cron/EraseEntity.php index 9b8a05c..fe02346 100755 --- a/Cron/Erasure.php +++ b/Cron/EraseEntity.php @@ -19,9 +19,9 @@ use Psr\Log\LoggerInterface; /** - * Scheduler to clean accounts marked to be deleted or anonymize + * Class EraseEntity */ -final class Erasure +final class EraseEntity { /** * @var \Psr\Log\LoggerInterface @@ -86,7 +86,7 @@ public function __construct( } /** - * Process all scheduled erase customer + * Process erase of all scheduled entities * * @return void */ @@ -96,10 +96,10 @@ public function execute(): void $oldValue = $this->registry->registry('isSecureArea'); $this->registry->register('isSecureArea', true, true); - /** @var \Opengento\Gdpr\Api\Data\EraseEntityInterface $eraseCustomer */ - foreach ($this->retrieveEraseCustomerList()->getItems() as $eraseCustomer) { + /** @var \Opengento\Gdpr\Api\Data\EraseEntityInterface $eraseEntity */ + foreach ($this->retrieveEraseEntityList()->getItems() as $eraseEntity) { try { - $this->eraseEntityManagement->process($eraseCustomer); + $this->eraseEntityManagement->process($eraseEntity); } catch (\Exception $e) { $this->logger->error($e->getMessage()); } @@ -110,11 +110,11 @@ public function execute(): void } /** - * Retrieve erase customer scheduler list + * Retrieve erase entity scheduler list * * @return \Magento\Framework\Api\SearchResultsInterface */ - private function retrieveEraseCustomerList(): SearchResultsInterface + private function retrieveEraseEntityList(): SearchResultsInterface { $this->searchCriteriaBuilder->addFilter( EraseEntityInterface::SCHEDULED_AT, diff --git a/Service/Anonymize/AccountBlocker.php b/Model/Customer/Anonymize/AccountBlocker.php similarity index 98% rename from Service/Anonymize/AccountBlocker.php rename to Model/Customer/Anonymize/AccountBlocker.php index 61690fd..ae259b2 100644 --- a/Service/Anonymize/AccountBlocker.php +++ b/Model/Customer/Anonymize/AccountBlocker.php @@ -5,7 +5,7 @@ */ declare(strict_types=1); -namespace Opengento\Gdpr\Service\Anonymize; +namespace Opengento\Gdpr\Model\Customer\Anonymize; use Magento\Customer\Model\CustomerRegistry; use Magento\Customer\Model\ResourceModel\Visitor\CollectionFactory as VisitorCollectionFactory; diff --git a/Model/Customer/Anonymize/Processor/CustomerDataProcessor.php b/Model/Customer/Anonymize/Processor/CustomerDataProcessor.php index 8782990..1aef2cc 100644 --- a/Model/Customer/Anonymize/Processor/CustomerDataProcessor.php +++ b/Model/Customer/Anonymize/Processor/CustomerDataProcessor.php @@ -13,7 +13,7 @@ use Magento\Sales\Api\Data\OrderInterface; use Magento\Sales\Api\OrderRepositoryInterface; use Opengento\Gdpr\Model\Config; -use Opengento\Gdpr\Service\Anonymize\AccountBlocker; +use Opengento\Gdpr\Model\Customer\Anonymize\AccountBlocker; use Opengento\Gdpr\Service\Anonymize\AnonymizerInterface; use Opengento\Gdpr\Service\Erase\ProcessorInterface; @@ -28,7 +28,7 @@ final class CustomerDataProcessor implements ProcessorInterface private $anonymizer; /** - * @var \Opengento\Gdpr\Service\Anonymize\AccountBlocker + * @var \Opengento\Gdpr\Model\Customer\Anonymize\AccountBlocker */ private $accountBlocker; @@ -54,7 +54,7 @@ final class CustomerDataProcessor implements ProcessorInterface /** * @param \Opengento\Gdpr\Service\Anonymize\AnonymizerInterface $anonymizer - * @param \Opengento\Gdpr\Service\Anonymize\AccountBlocker $accountBlocker + * @param \Opengento\Gdpr\Model\Customer\Anonymize\AccountBlocker $accountBlocker * @param \Magento\Customer\Api\CustomerRepositoryInterface $customerRepository * @param \Magento\Sales\Api\OrderRepositoryInterface $orderRepository * @param \Magento\Framework\Api\SearchCriteriaBuilder $searchCriteriaBuilder diff --git a/etc/crontab.xml b/etc/crontab.xml index a216b10..edccf94 100755 --- a/etc/crontab.xml +++ b/etc/crontab.xml @@ -7,7 +7,7 @@ --> - + gdpr/erasure/schedule From ce9e3c25bdcdcfff46abeeb58641c687a777395f Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Fri, 5 Jul 2019 17:39:14 +0200 Subject: [PATCH 65/75] update todos --- Block/Adminhtml/Order/Edit/EraseButton.php | 4 ++++ Block/Adminhtml/Order/Edit/ExportButton.php | 4 ++++ TODO.md | 8 -------- etc/crontab.xml | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/Block/Adminhtml/Order/Edit/EraseButton.php b/Block/Adminhtml/Order/Edit/EraseButton.php index 73a781e..8c25748 100644 --- a/Block/Adminhtml/Order/Edit/EraseButton.php +++ b/Block/Adminhtml/Order/Edit/EraseButton.php @@ -32,6 +32,10 @@ public function __construct( EraseEntityCheckerInterface $eraseEntityChecker, array $data = [] ) { + /** + * @todo remove this line + * @link https://github.com/magento/magento2/pull/23576/ + */ $this->_authorization = $context->getAuthorization(); $this->eraseEntityChecker = $eraseEntityChecker; parent::__construct($context, $data); diff --git a/Block/Adminhtml/Order/Edit/ExportButton.php b/Block/Adminhtml/Order/Edit/ExportButton.php index b3da898..75ce175 100644 --- a/Block/Adminhtml/Order/Edit/ExportButton.php +++ b/Block/Adminhtml/Order/Edit/ExportButton.php @@ -29,6 +29,10 @@ public function __construct( Context $context, array $data = [] ) { + /** + * @todo remove this line + * @link https://github.com/magento/magento2/pull/23576/ + */ $this->_authorization = $context->getAuthorization(); parent::__construct($context, $data); } diff --git a/TODO.md b/TODO.md index 20ab3fd..eb8a4ca 100644 --- a/TODO.md +++ b/TODO.md @@ -37,10 +37,6 @@ Area: - Complete developer guide - Attributes, Custom Attributes, Extensible Data -## Facade - -GDPR facade for customer actions - ## Split - API (OK) @@ -79,10 +75,6 @@ GDPR facade for customer actions notify customer from its requests -## Admin - -enable action for guests (guest orders) - ## yu https://github.com/magento/architecture/pull/145/files diff --git a/etc/crontab.xml b/etc/crontab.xml index edccf94..0b11673 100755 --- a/etc/crontab.xml +++ b/etc/crontab.xml @@ -7,7 +7,7 @@ --> - + gdpr/erasure/schedule From c4871c52a82de0a003cf4089e48453591bf5e6b7 Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Mon, 15 Jul 2019 17:14:01 +0200 Subject: [PATCH 66/75] implements #17 auto erase old entities --- Cron/EraseEntityScheduler.php | 84 +++++++++++++++++++ Model/Config.php | 14 ++++ Model/Entity/EntityCheckerFactory.php | 2 +- .../Entity/SourceProvider/FilterModifier.php | 53 ++++++++++++ .../SourceProvider/ModifierComposite.php | 44 ++++++++++ .../Entity/SourceProvider/ModifierFactory.php | 50 +++++++++++ .../SourceProvider/ModifierInterface.php | 27 ++++++ Model/Entity/SourceProviderFactory.php | 55 ++++++++++++ Model/Erase/EraseEntityScheduler.php | 83 ++++++++++++++++++ etc/adminhtml/system/erasure.xml | 30 +++++-- etc/config.xml | 6 +- etc/crontab.xml | 7 +- etc/di.xml | 65 ++++++++++++++ 13 files changed, 509 insertions(+), 11 deletions(-) create mode 100644 Cron/EraseEntityScheduler.php create mode 100644 Model/Entity/SourceProvider/FilterModifier.php create mode 100644 Model/Entity/SourceProvider/ModifierComposite.php create mode 100644 Model/Entity/SourceProvider/ModifierFactory.php create mode 100644 Model/Entity/SourceProvider/ModifierInterface.php create mode 100644 Model/Entity/SourceProviderFactory.php create mode 100644 Model/Erase/EraseEntityScheduler.php diff --git a/Cron/EraseEntityScheduler.php b/Cron/EraseEntityScheduler.php new file mode 100644 index 0000000..8cad13a --- /dev/null +++ b/Cron/EraseEntityScheduler.php @@ -0,0 +1,84 @@ +logger = $logger; + $this->config = $config; + $this->eraseEntityScheduler = $eraseEntityScheduler; + $this->filterBuilder = $filterBuilder; + $this->entityTypes = $entityTypes; + } + + /** + * Schedule entities to erase + * + * @return void + */ + public function execute(): void + { + if ($this->config->isModuleEnabled() && $this->config->isErasureEnabled()) { + try { + $this->filterBuilder->setField('created_at'); + $this->filterBuilder->setValue(new \DateTime('-' . $this->config->getErasureMaxAge() . 'days')); + $this->filterBuilder->setConditionType('lteq'); + $this->eraseEntityScheduler->schedule($this->entityTypes, $this->filterBuilder->create()); + } catch (\Exception $e) { + $this->logger->error($e->getMessage()); + } + } + } +} diff --git a/Model/Config.php b/Model/Config.php index 36d3bcb..0257656 100644 --- a/Model/Config.php +++ b/Model/Config.php @@ -23,6 +23,7 @@ final class Config public const CONFIG_PATH_GENERAL_INFORMATION_BLOCK = 'gdpr/general/block_id'; public const CONFIG_PATH_ERASURE_ENABLED = 'gdpr/erasure/enabled'; public const CONFIG_PATH_ERASURE_DELAY = 'gdpr/erasure/delay'; + public const CONFIG_PATH_ERASURE_MAX_AGE = 'gdpr/erasure/entity_max_age'; public const CONFIG_PATH_ERASURE_ALLOWED_STATES = 'gdpr/erasure/allowed_states'; public const CONFIG_PATH_ERASURE_INFORMATION_BLOCK = 'gdpr/erasure/block_id'; public const CONFIG_PATH_ERASURE_REMOVE_CUSTOMER = 'gdpr/erasure/remove_customer'; @@ -126,6 +127,19 @@ public function getErasureDelay(): int ); } + /** + * Retrieve the maximum age for the entities before the erasure + * + * @return int + */ + public function getErasureMaxAge(): int + { + return (int) $this->scopeConfig->getValue( + self::CONFIG_PATH_ERASURE_MAX_AGE, + ScopeInterface::SCOPE_STORE + ); + } + /** * Retrieve the allowed order states to erase * diff --git a/Model/Entity/EntityCheckerFactory.php b/Model/Entity/EntityCheckerFactory.php index bcb2fa6..ceaab46 100644 --- a/Model/Entity/EntityCheckerFactory.php +++ b/Model/Entity/EntityCheckerFactory.php @@ -38,7 +38,7 @@ public function __construct( } /** - * Create a new export processor + * Retrieve the export processor by entity type * * @param string $entityType * @return \Opengento\Gdpr\Model\Entity\EntityCheckerInterface diff --git a/Model/Entity/SourceProvider/FilterModifier.php b/Model/Entity/SourceProvider/FilterModifier.php new file mode 100644 index 0000000..5bcf79f --- /dev/null +++ b/Model/Entity/SourceProvider/FilterModifier.php @@ -0,0 +1,53 @@ +filterIdentifier = $filterIdentifier; + $this->fieldToFilter = $fieldToFilter; + } + + /** + * @inheritdoc + * @throws \Magento\Framework\Exception\LocalizedException + */ + public function apply(Collection $collection, Filter $filter): void + { + if ($filter->getField() === $this->filterIdentifier) { + $collection->addFieldToFilter( + $this->fieldToFilter, + [$filter->getConditionType() => $filter->getValue()] + ); + } + } +} diff --git a/Model/Entity/SourceProvider/ModifierComposite.php b/Model/Entity/SourceProvider/ModifierComposite.php new file mode 100644 index 0000000..5c77204 --- /dev/null +++ b/Model/Entity/SourceProvider/ModifierComposite.php @@ -0,0 +1,44 @@ +modifiers = (static function (ModifierInterface ...$modifiers): array { + return $modifiers; + })(...\array_values($modifiers)); + } + + /** + * @inheritdoc + */ + public function apply(Collection $collection, Filter $filter): void + { + foreach ($this->modifiers as $modifier) { + $modifier->apply($collection, $filter); + } + } +} diff --git a/Model/Entity/SourceProvider/ModifierFactory.php b/Model/Entity/SourceProvider/ModifierFactory.php new file mode 100644 index 0000000..293a981 --- /dev/null +++ b/Model/Entity/SourceProvider/ModifierFactory.php @@ -0,0 +1,50 @@ +modifiers = $modifiers; + $this->objectManager = $objectManager; + } + + /** + * Retrieve the source provider modifier by entity type + * + * @param string $entityType + * @return \Opengento\Gdpr\Model\Entity\SourceProvider\ModifierInterface + */ + public function get(string $entityType): ModifierInterface + { + return $this->objectManager->get($this->modifiers[$entityType] ?? $this->modifiers['default']); + } +} diff --git a/Model/Entity/SourceProvider/ModifierInterface.php b/Model/Entity/SourceProvider/ModifierInterface.php new file mode 100644 index 0000000..35cfe07 --- /dev/null +++ b/Model/Entity/SourceProvider/ModifierInterface.php @@ -0,0 +1,27 @@ +sourceProviders = $sourceProviders; + $this->objectManager = $objectManager; + } + + /** + * Create a new source provider by entity type + * + * @param string $entityType + * @return \Magento\Framework\Data\Collection + */ + public function create(string $entityType): Collection + { + if (!isset($this->sourceProviders[$entityType])) { + throw new \InvalidArgumentException(\sprintf('Unknown source provider for entity type "%s".', $entityType)); + } + + return $this->objectManager->create($this->sourceProviders[$entityType]); + } +} diff --git a/Model/Erase/EraseEntityScheduler.php b/Model/Erase/EraseEntityScheduler.php new file mode 100644 index 0000000..8b4c7fd --- /dev/null +++ b/Model/Erase/EraseEntityScheduler.php @@ -0,0 +1,83 @@ +sourceProviderFactory = $sourceProviderFactory; + $this->sourceProviderModifierFactory = $sourceProviderModifierFactory; + $this->eraseEntityManagement = $eraseEntityManagement; + } + + /** + * Schedule filtered entities to erase + * + * @param string[] $entityTypes + * @param \Magento\Framework\Api\Filter $filter + * @throws \Magento\Framework\Exception\CouldNotSaveException + * @throws \Magento\Framework\Exception\LocalizedException + */ + public function schedule(array $entityTypes, Filter $filter): void + { + foreach ($this->collectEntityIds($entityTypes, $filter) as $entityType => $entityIds) { + foreach ($entityIds as $entityId) { + $this->eraseEntityManagement->create((int) $entityId, $entityType); + } + } + } + + /** + * Collect available entity ids by entity type + * + * @param string[] $entityTypes + * @param \Magento\Framework\Api\Filter $filter + * @return \Generator + */ + private function collectEntityIds(array $entityTypes, Filter $filter): \Generator + { + foreach ($entityTypes as $entityType) { + $source = $this->sourceProviderFactory->create($entityType); + $this->sourceProviderModifierFactory->get($entityType)->apply($source, $filter); + + yield $entityType => $source->getAllIds(); + } + } +} diff --git a/etc/adminhtml/system/erasure.xml b/etc/adminhtml/system/erasure.xml index 31041f2..a402b8b 100644 --- a/etc/adminhtml/system/erasure.xml +++ b/etc/adminhtml/system/erasure.xml @@ -34,14 +34,30 @@ gdpr/erasure/delay - - + + 1 - gdpr/erasure/schedule + gdpr/erasure/entity_schedule - + + + The time is in days. + validate-number validate-number-range number-range-0-1095 + + 1 + + gdpr/erasure/entity_max_age + + + + + 1 + + gdpr/erasure/entity_max_age_schedule + + Opengento\Gdpr\Model\Config\Source\OrderPendingStates @@ -50,7 +66,7 @@ 0 gdpr/erasure/allowed_states - + Defines the components erasure strategy with the component/erase processor mapper for the customers. Opengento\Gdpr\Block\Adminhtml\Config\Form\Field\EraseComponentsProcessors @@ -61,7 +77,7 @@ 1 gdpr/erasure/customer_components_processors - + Defines the components erasure strategy with the component/erase processor mapper for the guests. Opengento\Gdpr\Block\Adminhtml\Config\Form\Field\EraseComponentsProcessors @@ -72,7 +88,7 @@ 1 gdpr/erasure/guest_components_processors - + 1 diff --git a/etc/config.xml b/etc/config.xml index b2f250d..6323d62 100755 --- a/etc/config.xml +++ b/etc/config.xml @@ -120,7 +120,11 @@ 0 3600 - * * * * * + * * * * * + + 30 + + * * * * * canceled,closed,complete 1 diff --git a/etc/crontab.xml b/etc/crontab.xml index 0b11673..436ced6 100755 --- a/etc/crontab.xml +++ b/etc/crontab.xml @@ -7,8 +7,11 @@ --> - - gdpr/erasure/schedule + + gdpr/erasure/entity_schedule + + + gdpr/erasure/entity_max_age_schedule diff --git a/etc/di.xml b/etc/di.xml index 6f7527e..09670d8 100644 --- a/etc/di.xml +++ b/etc/di.xml @@ -662,6 +662,19 @@ Opengento\Gdpr\Model\Config\Source\Customer\EraseComponents + + + created_at + Magento\Customer\Api\Data\CustomerInterface::CREATED_AT + + + + + + Opengento\Gdpr\Model\Customer\SourceProvider\FilterModifier + + + @@ -703,6 +716,19 @@ Opengento\Gdpr\Model\Config\Source\Order\EraseComponents + + + created_at + Magento\Sales\Api\Data\OrderInterface::CREATED_AT + + + + + + Opengento\Gdpr\Model\Order\SourceProvider\FilterModifier + + + @@ -720,6 +746,45 @@ + + + created_at + created_at + + + + + + Opengento\Gdpr\Model\Entity\SourceProvider\DefaultFilterModifier + + + + + + + Opengento\Gdpr\Model\Entity\SourceProvider\DefaultModifierComposite + Opengento\Gdpr\Model\Customer\SourceProvider\ModifierComposite + Opengento\Gdpr\Model\Order\SourceProvider\ModifierComposite + + + + + + + Magento\Customer\Model\ResourceModel\Customer\Collection + Magento\Sales\Model\ResourceModel\Order\Collection + + + + + + + + customer + order + + + From e898d04b4158d43a6b67dcdac618bf4aadd95a64 Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Mon, 15 Jul 2019 17:44:14 +0200 Subject: [PATCH 67/75] add issues templates --- .github/BUG_REPORT.md | 41 ++++++++++++++++++++++++++++++++++++++ .github/FEATURE_REQUEST.md | 26 ++++++++++++++++++++++++ etc/config.xml | 6 ++---- 3 files changed, 69 insertions(+), 4 deletions(-) create mode 100644 .github/BUG_REPORT.md create mode 100644 .github/FEATURE_REQUEST.md diff --git a/.github/BUG_REPORT.md b/.github/BUG_REPORT.md new file mode 100644 index 0000000..b776be7 --- /dev/null +++ b/.github/BUG_REPORT.md @@ -0,0 +1,41 @@ +## Description +A clear and concise description of what the bug is. + +## Prerequisites + +**PHP Version:** + - [e.g. 7.2.19] + +**Magento Version:** + - [e.g. 2.3.2] + +**Module Version:** + - [e.g. 1.0.0] + +**Desktop (if applicable):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (if applicable):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +## Issue Details + +**Steps to reproduce the behavior** +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/FEATURE_REQUEST.md b/.github/FEATURE_REQUEST.md new file mode 100644 index 0000000..05ecf6f --- /dev/null +++ b/.github/FEATURE_REQUEST.md @@ -0,0 +1,26 @@ +## Description + + - [ ] It's related to an existing issue: #[issueId] + + - [ ] It requires major modifications. + + Priority of the change: + - [ ] High + - [ ] Medium + - [ ] Low + +**Which problem the feature would fix?** +A clear and concise description of what the problem is. + +**Describe the solution as simple as possible** +A clear and concise description of how it should works. + +**List the alternative solutions** +Curated list of the alternative solutions. + +**Additional context** +Add any other context or screenshots about the feature request here. + +## Contributing + + - [ ] Would you want to contribute and to be assigned to this enhancement? diff --git a/etc/config.xml b/etc/config.xml index 6323d62..09fd29e 100755 --- a/etc/config.xml +++ b/etc/config.xml @@ -121,10 +121,8 @@ 0 3600 * * * * * - - 30 - - * * * * * + 1095 + 0 1 * * * canceled,closed,complete 1 From 5e57d350b352ef16e5c9f7f5e02878e073f1a513 Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Mon, 15 Jul 2019 17:47:27 +0200 Subject: [PATCH 68/75] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 50 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 35 ++++++++++++++++ 2 files changed, 85 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..47fe7f8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,50 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: bug +assignees: thomas-kl1 + +--- + +## Description +A clear and concise description of what the bug is. + +## Prerequisites + +**PHP Version:** + - [e.g. 7.2.19] + +**Magento Version:** + - [e.g. 2.3.2] + +**Module Version:** + - [e.g. 1.0.0] + +**Desktop (if applicable):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (if applicable):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +## Issue Details + +**Steps to reproduce the behavior** +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..b6e99b3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,35 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[ENHANCEMENT]" +labels: enhancement +assignees: thomas-kl1 + +--- + +## Description + + - [ ] It's related to an existing issue: #[issueId] + + - [ ] It requires major modifications. + + Priority of the change: + - [ ] High + - [ ] Medium + - [ ] Low + +**Which problem the feature would fix?** +A clear and concise description of what the problem is. + +**Describe the solution as simple as possible** +A clear and concise description of how it should works. + +**List the alternative solutions** +Curated list of the alternative solutions. + +**Additional context** +Add any other context or screenshots about the feature request here. + +## Contributing + + - [ ] Would you want to contribute and to be assigned to this enhancement? From ea86a9de0693758859c4783011c3d5e1558ef521 Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Mon, 15 Jul 2019 17:48:48 +0200 Subject: [PATCH 69/75] remove duplicated files --- .github/BUG_REPORT.md | 41 -------------------------------------- .github/FEATURE_REQUEST.md | 26 ------------------------ 2 files changed, 67 deletions(-) delete mode 100644 .github/BUG_REPORT.md delete mode 100644 .github/FEATURE_REQUEST.md diff --git a/.github/BUG_REPORT.md b/.github/BUG_REPORT.md deleted file mode 100644 index b776be7..0000000 --- a/.github/BUG_REPORT.md +++ /dev/null @@ -1,41 +0,0 @@ -## Description -A clear and concise description of what the bug is. - -## Prerequisites - -**PHP Version:** - - [e.g. 7.2.19] - -**Magento Version:** - - [e.g. 2.3.2] - -**Module Version:** - - [e.g. 1.0.0] - -**Desktop (if applicable):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (if applicable):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -## Issue Details - -**Steps to reproduce the behavior** -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Additional context** -Add any other context about the problem here. diff --git a/.github/FEATURE_REQUEST.md b/.github/FEATURE_REQUEST.md deleted file mode 100644 index 05ecf6f..0000000 --- a/.github/FEATURE_REQUEST.md +++ /dev/null @@ -1,26 +0,0 @@ -## Description - - - [ ] It's related to an existing issue: #[issueId] - - - [ ] It requires major modifications. - - Priority of the change: - - [ ] High - - [ ] Medium - - [ ] Low - -**Which problem the feature would fix?** -A clear and concise description of what the problem is. - -**Describe the solution as simple as possible** -A clear and concise description of how it should works. - -**List the alternative solutions** -Curated list of the alternative solutions. - -**Additional context** -Add any other context or screenshots about the feature request here. - -## Contributing - - - [ ] Would you want to contribute and to be assigned to this enhancement? From 671e9eff85b638e203f4ba892413d21113f4e181 Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Tue, 16 Jul 2019 10:34:02 +0200 Subject: [PATCH 70/75] #17 #12 fix order guest condition --- Model/Order/OrderChecker.php | 4 +- Model/Order/SourceProvider/GuestModifier.php | 44 ++++++++++++++++++++ TODO.md | 4 ++ etc/di.xml | 1 + 4 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 Model/Order/SourceProvider/GuestModifier.php diff --git a/Model/Order/OrderChecker.php b/Model/Order/OrderChecker.php index 490e96e..7ba6a66 100644 --- a/Model/Order/OrderChecker.php +++ b/Model/Order/OrderChecker.php @@ -45,6 +45,8 @@ public function canErase(int $orderId, bool $forceReload = false): bool { $order = $this->orderRepository->get($orderId); - return !$order->getCustomerId() && \in_array($order->getState(), $this->config->getAllowedStatesToErase(), true); + return !$order->getCustomerId() && + $order->getCustomerIsGuest() && + \in_array($order->getState(), $this->config->getAllowedStatesToErase(), true); } } diff --git a/Model/Order/SourceProvider/GuestModifier.php b/Model/Order/SourceProvider/GuestModifier.php new file mode 100644 index 0000000..1ece6d2 --- /dev/null +++ b/Model/Order/SourceProvider/GuestModifier.php @@ -0,0 +1,44 @@ +config = $config; + } + + /** + * @inheritdoc + * @throws \Magento\Framework\Exception\LocalizedException + */ + public function apply(Collection $collection, Filter $filter): void + { + $collection->addFieldToFilter(OrderInterface::CUSTOMER_ID, ['null' => true]); + $collection->addFieldToFilter(OrderInterface::CUSTOMER_IS_GUEST, ['eq' => 1]); + $collection->addFieldToFilter(OrderInterface::STATE, ['in' => $this->config->getAllowedStatesToErase()]); + } +} diff --git a/TODO.md b/TODO.md index eb8a4ca..49635cf 100644 --- a/TODO.md +++ b/TODO.md @@ -78,3 +78,7 @@ notify customer from its requests ## yu https://github.com/magento/architecture/pull/145/files + +## Improvements + +Disable checks and validators on mass actions (including cron) diff --git a/etc/di.xml b/etc/di.xml index 09670d8..f117680 100644 --- a/etc/di.xml +++ b/etc/di.xml @@ -725,6 +725,7 @@ + Opengento\Gdpr\Model\Order\SourceProvider\GuestModifier Opengento\Gdpr\Model\Order\SourceProvider\FilterModifier From eeb37feb5695494d805489e727ead2bc65172615 Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Wed, 17 Jul 2019 10:19:07 +0200 Subject: [PATCH 71/75] fix #19 #17 #12 bug + sales information lifetime --- Console/Command/EraseCommand.php | 1 + Controller/Adminhtml/Privacy/MassErase.php | 1 + Cron/EraseEntity.php | 1 + Cron/EraseEntityScheduler.php | 1 + Model/Config.php | 14 ++++ .../Processor/OrderDataProcessor.php | 47 ++++++++--- .../Processor/QuoteDataProcessor.php | 4 +- Model/Customer/CustomerChecker.php | 1 + .../Delete/Processor/OrderDataProcessor.php | 23 +++++- .../Delete/Processor/QuoteDataProcessor.php | 4 +- .../Export/Processor/OrderDataProcessor.php | 4 +- .../Export/Processor/QuoteDataProcessor.php | 4 +- .../SourceProvider/FilterModifier.php | 54 +++++++++++++ Model/Erase/EraseSalesInformation.php | 81 +++++++++++++++++++ .../Erase/EraseSalesInformationInterface.php | 35 ++++++++ .../Processor/OrderDataProcessor.php | 40 ++++----- .../Processor/QuoteDataProcessor.php | 33 ++++---- .../Processor/SubscriberDataProcessor.php | 15 +++- .../Delete/Processor/OrderDataProcessor.php | 23 +++++- Model/Order/OrderChecker.php | 6 +- Service/Export/Renderer/XmlRenderer.php | 2 +- etc/adminhtml/system/erasure.xml | 17 +++- etc/config.xml | 1 + etc/di.xml | 9 +-- 24 files changed, 346 insertions(+), 75 deletions(-) create mode 100644 Model/Customer/SourceProvider/FilterModifier.php create mode 100644 Model/Erase/EraseSalesInformation.php create mode 100644 Model/Erase/EraseSalesInformationInterface.php diff --git a/Console/Command/EraseCommand.php b/Console/Command/EraseCommand.php index 070bb87..6639225 100644 --- a/Console/Command/EraseCommand.php +++ b/Console/Command/EraseCommand.php @@ -102,6 +102,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int try { foreach ($entityIds as $entityId) { + // todo disable individual check: use mass validator $this->eraseEntityManagement->process( $this->eraseEntityManagement->create((int) $entityId, $entityType) ); diff --git a/Controller/Adminhtml/Privacy/MassErase.php b/Controller/Adminhtml/Privacy/MassErase.php index 84856ae..73a46a9 100644 --- a/Controller/Adminhtml/Privacy/MassErase.php +++ b/Controller/Adminhtml/Privacy/MassErase.php @@ -54,6 +54,7 @@ protected function massAction(AbstractCollection $collection) foreach ($collection->getAllIds() as $customerId) { try { + // todo disable individual check: use mass validator $this->eraseEntityManagement->process($this->eraseEntityManagement->create((int) $customerId, 'customer')); $customerErased++; } catch (LocalizedException $e) { diff --git a/Cron/EraseEntity.php b/Cron/EraseEntity.php index fe02346..609009b 100755 --- a/Cron/EraseEntity.php +++ b/Cron/EraseEntity.php @@ -99,6 +99,7 @@ public function execute(): void /** @var \Opengento\Gdpr\Api\Data\EraseEntityInterface $eraseEntity */ foreach ($this->retrieveEraseEntityList()->getItems() as $eraseEntity) { try { + // todo disable individual check: use mass validator $this->eraseEntityManagement->process($eraseEntity); } catch (\Exception $e) { $this->logger->error($e->getMessage()); diff --git a/Cron/EraseEntityScheduler.php b/Cron/EraseEntityScheduler.php index 8cad13a..30810e5 100644 --- a/Cron/EraseEntityScheduler.php +++ b/Cron/EraseEntityScheduler.php @@ -75,6 +75,7 @@ public function execute(): void $this->filterBuilder->setField('created_at'); $this->filterBuilder->setValue(new \DateTime('-' . $this->config->getErasureMaxAge() . 'days')); $this->filterBuilder->setConditionType('lteq'); + // todo disable individual check: use mass validator $this->eraseEntityScheduler->schedule($this->entityTypes, $this->filterBuilder->create()); } catch (\Exception $e) { $this->logger->error($e->getMessage()); diff --git a/Model/Config.php b/Model/Config.php index 0257656..9b2902d 100644 --- a/Model/Config.php +++ b/Model/Config.php @@ -24,6 +24,7 @@ final class Config public const CONFIG_PATH_ERASURE_ENABLED = 'gdpr/erasure/enabled'; public const CONFIG_PATH_ERASURE_DELAY = 'gdpr/erasure/delay'; public const CONFIG_PATH_ERASURE_MAX_AGE = 'gdpr/erasure/entity_max_age'; + public const CONFIG_PATH_ERASURE_SALES_MAX_AGE = 'gdpr/erasure/sales_max_age'; public const CONFIG_PATH_ERASURE_ALLOWED_STATES = 'gdpr/erasure/allowed_states'; public const CONFIG_PATH_ERASURE_INFORMATION_BLOCK = 'gdpr/erasure/block_id'; public const CONFIG_PATH_ERASURE_REMOVE_CUSTOMER = 'gdpr/erasure/remove_customer'; @@ -140,6 +141,19 @@ public function getErasureMaxAge(): int ); } + /** + * Retrieve the maximum age for the sales information before the erasure + * + * @return int + */ + public function getErasureSalesMaxAge(): int + { + return (int) $this->scopeConfig->getValue( + self::CONFIG_PATH_ERASURE_SALES_MAX_AGE, + ScopeInterface::SCOPE_STORE + ); + } + /** * Retrieve the allowed order states to erase * diff --git a/Model/Customer/Anonymize/Processor/OrderDataProcessor.php b/Model/Customer/Anonymize/Processor/OrderDataProcessor.php index 80ccd04..e78a0fa 100644 --- a/Model/Customer/Anonymize/Processor/OrderDataProcessor.php +++ b/Model/Customer/Anonymize/Processor/OrderDataProcessor.php @@ -11,6 +11,8 @@ use Magento\Sales\Api\Data\OrderInterface; use Magento\Sales\Api\OrderAddressRepositoryInterface; use Magento\Sales\Api\OrderRepositoryInterface; +use Magento\Sales\Model\Order; +use Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface; use Opengento\Gdpr\Service\Anonymize\AnonymizerInterface; use Opengento\Gdpr\Service\Erase\ProcessorInterface; @@ -39,44 +41,69 @@ final class OrderDataProcessor implements ProcessorInterface */ private $searchCriteriaBuilder; + /** + * @var \Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface + */ + private $eraseSalesInformation; + /** * @param \Opengento\Gdpr\Service\Anonymize\AnonymizerInterface $anonymizer * @param \Magento\Sales\Api\OrderRepositoryInterface $orderRepository * @param \Magento\Sales\Api\OrderAddressRepositoryInterface $orderAddressRepository * @param \Magento\Framework\Api\SearchCriteriaBuilder $searchCriteriaBuilder + * @param \Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface $eraseSalesInformation */ public function __construct( AnonymizerInterface $anonymizer, OrderRepositoryInterface $orderRepository, OrderAddressRepositoryInterface $orderAddressRepository, - SearchCriteriaBuilder $searchCriteriaBuilder + SearchCriteriaBuilder $searchCriteriaBuilder, + EraseSalesInformationInterface $eraseSalesInformation ) { $this->anonymizer = $anonymizer; $this->orderRepository = $orderRepository; $this->orderAddressRepository = $orderAddressRepository; $this->searchCriteriaBuilder = $searchCriteriaBuilder; + $this->eraseSalesInformation = $eraseSalesInformation; } /** * @inheritdoc + * @throws \Exception */ public function execute(int $customerId): bool { - $searchCriteria = $this->searchCriteriaBuilder->addFilter(OrderInterface::CUSTOMER_ID, $customerId); - $orderList = $this->orderRepository->getList($searchCriteria->create()); + $this->searchCriteriaBuilder->addFilter(OrderInterface::CUSTOMER_ID, $customerId); + $orderList = $this->orderRepository->getList($this->searchCriteriaBuilder->create()); /** @var \Magento\Sales\Model\Order $order */ foreach ($orderList->getItems() as $order) { - $this->orderRepository->save($this->anonymizer->anonymize($order)); - - /** @var \Magento\Sales\Api\Data\OrderAddressInterface|null $orderAddress */ - foreach ([$order->getBillingAddress(), $order->getShippingAddress()] as $orderAddress) { - if ($orderAddress) { - $this->orderAddressRepository->save($this->anonymizer->anonymize($orderAddress)); - } + $lastActive = new \DateTime($order->getUpdatedAt()); + if ($this->eraseSalesInformation->isAlive($lastActive)) { + $this->eraseSalesInformation->scheduleEraseEntity((int) $order->getEntityId(), 'order', $lastActive); + } else { + $this->anonymize($order); } } return true; } + + /** + * Anonymize the order entity + * + * @param \Magento\Sales\Model\Order $order + * @return void + */ + private function anonymize(Order $order): void + { + $this->orderRepository->save($this->anonymizer->anonymize($order)); + + /** @var \Magento\Sales\Api\Data\OrderAddressInterface|null $orderAddress */ + foreach ([$order->getBillingAddress(), $order->getShippingAddress()] as $orderAddress) { + if ($orderAddress) { + $this->orderAddressRepository->save($this->anonymizer->anonymize($orderAddress)); + } + } + } } diff --git a/Model/Customer/Anonymize/Processor/QuoteDataProcessor.php b/Model/Customer/Anonymize/Processor/QuoteDataProcessor.php index 0555a69..efe05f9 100644 --- a/Model/Customer/Anonymize/Processor/QuoteDataProcessor.php +++ b/Model/Customer/Anonymize/Processor/QuoteDataProcessor.php @@ -62,8 +62,8 @@ public function __construct( */ public function execute(int $customerId): bool { - $searchCriteria = $this->searchCriteriaBuilder->addFilter('customer_id', $customerId); - $quoteList = $this->quoteRepository->getList($searchCriteria->create()); + $this->searchCriteriaBuilder->addFilter('customer_id', $customerId); + $quoteList = $this->quoteRepository->getList($this->searchCriteriaBuilder->create()); /** @var \Magento\Quote\Model\Quote $quote */ foreach ($quoteList->getItems() as $quote) { diff --git a/Model/Customer/CustomerChecker.php b/Model/Customer/CustomerChecker.php index 0a6d056..3696521 100644 --- a/Model/Customer/CustomerChecker.php +++ b/Model/Customer/CustomerChecker.php @@ -56,6 +56,7 @@ public function __construct( /** * @inheritdoc + * @param bool $forceReload [optional] Flush the cache. */ public function canErase(int $customerId, bool $forceReload = false): bool { diff --git a/Model/Customer/Delete/Processor/OrderDataProcessor.php b/Model/Customer/Delete/Processor/OrderDataProcessor.php index 320d6a9..05d0668 100644 --- a/Model/Customer/Delete/Processor/OrderDataProcessor.php +++ b/Model/Customer/Delete/Processor/OrderDataProcessor.php @@ -10,6 +10,7 @@ use Magento\Framework\Api\SearchCriteriaBuilder; use Magento\Sales\Api\Data\OrderInterface; use Magento\Sales\Api\OrderRepositoryInterface; +use Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface; use Opengento\Gdpr\Service\Erase\ProcessorInterface; /** @@ -27,28 +28,42 @@ final class OrderDataProcessor implements ProcessorInterface */ private $searchCriteriaBuilder; + /** + * @var \Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface + */ + private $eraseSalesInformation; + /** * @param \Magento\Sales\Api\OrderRepositoryInterface $orderRepository * @param \Magento\Framework\Api\SearchCriteriaBuilder $searchCriteriaBuilder + * @param \Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface $eraseSalesInformation */ public function __construct( OrderRepositoryInterface $orderRepository, - SearchCriteriaBuilder $searchCriteriaBuilder + SearchCriteriaBuilder $searchCriteriaBuilder, + EraseSalesInformationInterface $eraseSalesInformation ) { $this->orderRepository = $orderRepository; $this->searchCriteriaBuilder = $searchCriteriaBuilder; + $this->eraseSalesInformation = $eraseSalesInformation; } /** * @inheritdoc + * @throws \Exception */ public function execute(int $customerId): bool { - $searchCriteria = $this->searchCriteriaBuilder->addFilter(OrderInterface::CUSTOMER_ID, $customerId); - $orderList = $this->orderRepository->getList($searchCriteria->create()); + $this->searchCriteriaBuilder->addFilter(OrderInterface::CUSTOMER_ID, $customerId); + $orderList = $this->orderRepository->getList($this->searchCriteriaBuilder->create()); foreach ($orderList->getItems() as $order) { - $this->orderRepository->delete($order); + $lastActive = new \DateTime($order->getUpdatedAt()); + if ($this->eraseSalesInformation->isAlive($lastActive)) { + $this->eraseSalesInformation->scheduleEraseEntity((int) $order->getEntityId(), 'order', $lastActive); + } else { + $this->orderRepository->delete($order); + } } return true; diff --git a/Model/Customer/Delete/Processor/QuoteDataProcessor.php b/Model/Customer/Delete/Processor/QuoteDataProcessor.php index 9ace695..366c65d 100644 --- a/Model/Customer/Delete/Processor/QuoteDataProcessor.php +++ b/Model/Customer/Delete/Processor/QuoteDataProcessor.php @@ -43,8 +43,8 @@ public function __construct( */ public function execute(int $customerId): bool { - $searchCriteria = $this->searchCriteriaBuilder->addFilter('customer_id', $customerId); - $quoteList = $this->quoteRepository->getList($searchCriteria->create()); + $this->searchCriteriaBuilder->addFilter('customer_id', $customerId); + $quoteList = $this->quoteRepository->getList($this->searchCriteriaBuilder->create()); foreach ($quoteList->getItems() as $quote) { $this->quoteRepository->delete($quote); diff --git a/Model/Customer/Export/Processor/OrderDataProcessor.php b/Model/Customer/Export/Processor/OrderDataProcessor.php index 5505c6c..37ffb3e 100644 --- a/Model/Customer/Export/Processor/OrderDataProcessor.php +++ b/Model/Customer/Export/Processor/OrderDataProcessor.php @@ -48,8 +48,8 @@ public function __construct( */ public function execute(int $customerId, array $data): array { - $searchCriteria = $this->searchCriteriaBuilder->addFilter(OrderInterface::CUSTOMER_ID, $customerId); - $orderList = $this->orderRepository->getList($searchCriteria->create()); + $this->searchCriteriaBuilder->addFilter(OrderInterface::CUSTOMER_ID, $customerId); + $orderList = $this->orderRepository->getList($this->searchCriteriaBuilder->create()); /** @var \Magento\Sales\Model\Order $order */ foreach ($orderList->getItems() as $order) { diff --git a/Model/Customer/Export/Processor/QuoteDataProcessor.php b/Model/Customer/Export/Processor/QuoteDataProcessor.php index 79d0593..2f8c381 100644 --- a/Model/Customer/Export/Processor/QuoteDataProcessor.php +++ b/Model/Customer/Export/Processor/QuoteDataProcessor.php @@ -47,8 +47,8 @@ public function __construct( */ public function execute(int $customerId, array $data): array { - $searchCriteria = $this->searchCriteriaBuilder->addFilter('customer_id', $customerId); - $quoteList = $this->quoteRepository->getList($searchCriteria->create()); + $this->searchCriteriaBuilder->addFilter('customer_id', $customerId); + $quoteList = $this->quoteRepository->getList($this->searchCriteriaBuilder->create()); /** @var \Magento\Quote\Model\Quote $quote */ foreach ($quoteList->getItems() as $quote) { diff --git a/Model/Customer/SourceProvider/FilterModifier.php b/Model/Customer/SourceProvider/FilterModifier.php new file mode 100644 index 0000000..5ae0082 --- /dev/null +++ b/Model/Customer/SourceProvider/FilterModifier.php @@ -0,0 +1,54 @@ +getField() === 'created_at') { + $connection = $collection->getConnection(); + + $customerVisitorSelect = $connection->select() + ->from($connection->getTableName('customer_visitor')) + ->columns(['customer_id' => 'customer_id', 'last_visit_at' => 'MAX(last_visit_at)']) + ->group(['customer_id']); + + $collection->getSelect()->joinLeft( + ['cv' => $customerVisitorSelect], + 'main_table.entity_id=cl.customer_id', + null + ); + $collection->getSelect()->joinLeft( + ['cl' => $connection->getTableName('customer_log')], + 'main_table.entity_id=cl.customer_id', + null + ); + $collection->getSelect()->columns( + [ + 'last_visit_at' => 'IFNULL(' . + 'cv.last_visit_at,'. + 'GREATEST(IFNULL(cl.last_login_at, e.created_at), IFNULL(cl.last_logout_at, e.updated_at))' . + ')', + ] + ); + $collection->addFieldToFilter('last_visit_at', [$filter->getConditionType() => $filter->getValue()]); + } + } +} diff --git a/Model/Erase/EraseSalesInformation.php b/Model/Erase/EraseSalesInformation.php new file mode 100644 index 0000000..53d5faf --- /dev/null +++ b/Model/Erase/EraseSalesInformation.php @@ -0,0 +1,81 @@ +eraseEntityFactory = $eraseEntityFactory; + $this->eraseEntityRepository = $eraseEntityRepository; + $this->config = $config; + } + + /** + * @inheritdoc + * @throws \Magento\Framework\Exception\CouldNotSaveException + */ + public function scheduleEraseEntity(int $entityId, string $entityType, \DateTime $lastActive): EraseEntityInterface + { + $dateTime = \DateTimeImmutable::createFromMutable($lastActive); + $scheduleAt = $dateTime->modify('+' . $this->config->getErasureSalesMaxAge() . + 'days'); + + /** @var \Opengento\Gdpr\Api\Data\EraseEntityInterface $eraseEntity */ + $eraseEntity = $this->eraseEntityFactory->create(); + $eraseEntity->setEntityId($entityId); + $eraseEntity->setEntityType($entityType); + $eraseEntity->setState(EraseEntityInterface::STATE_PENDING); + $eraseEntity->setStatus(EraseEntityInterface::STATUS_READY); + $eraseEntity->setScheduledAt($scheduleAt->format(DateTime::DATETIME_PHP_FORMAT)); + + $this->eraseEntityRepository->save($eraseEntity); + + return $eraseEntity; + } + + /** + * @inheritdoc + * @throws \Exception + */ + public function isAlive(\DateTime $dateTime): bool + { + return $dateTime > new \DateTime('-' . $this->config->getErasureSalesMaxAge() . 'days'); + } +} diff --git a/Model/Erase/EraseSalesInformationInterface.php b/Model/Erase/EraseSalesInformationInterface.php new file mode 100644 index 0000000..7ab3763 --- /dev/null +++ b/Model/Erase/EraseSalesInformationInterface.php @@ -0,0 +1,35 @@ +anonymizer = $anonymizer; $this->orderRepository = $orderRepository; $this->orderAddressRepository = $orderAddressRepository; - $this->searchCriteriaBuilder = $searchCriteriaBuilder; + $this->eraseSalesInformation = $eraseSalesInformation; } /** * @inheritdoc + * @throws \Exception */ - public function execute(int $customerId): bool + public function execute(int $orderId): bool { - $searchCriteria = $this->searchCriteriaBuilder->addFilter(OrderInterface::CUSTOMER_ID, $customerId); - $orderList = $this->orderRepository->getList($searchCriteria->create()); - /** @var \Magento\Sales\Model\Order $order */ - foreach ($orderList->getItems() as $order) { - $this->orderRepository->save($this->anonymizer->anonymize($order)); + $order = $this->orderRepository->get($orderId); + $lastActive = new \DateTime($order->getUpdatedAt()); + + if ($this->eraseSalesInformation->isAlive($lastActive)) { + $this->eraseSalesInformation->scheduleEraseEntity((int) $order->getEntityId(), 'order', $lastActive); + + return true; + } + + $this->orderRepository->save($this->anonymizer->anonymize($order)); - /** @var \Magento\Sales\Api\Data\OrderAddressInterface|null $orderAddress */ - foreach ([$order->getBillingAddress(), $order->getShippingAddress()] as $orderAddress) { - if ($orderAddress) { - $this->orderAddressRepository->save($this->anonymizer->anonymize($orderAddress)); - } + /** @var \Magento\Sales\Api\Data\OrderAddressInterface|null $orderAddress */ + foreach ([$order->getBillingAddress(), $order->getShippingAddress()] as $orderAddress) { + if ($orderAddress) { + $this->orderAddressRepository->save($this->anonymizer->anonymize($orderAddress)); } } diff --git a/Model/Order/Anonymize/Processor/QuoteDataProcessor.php b/Model/Order/Anonymize/Processor/QuoteDataProcessor.php index de5b55a..9dafd89 100644 --- a/Model/Order/Anonymize/Processor/QuoteDataProcessor.php +++ b/Model/Order/Anonymize/Processor/QuoteDataProcessor.php @@ -7,9 +7,10 @@ namespace Opengento\Gdpr\Model\Order\Anonymize\Processor; -use Magento\Framework\Api\SearchCriteriaBuilder; +use Magento\Framework\Exception\NoSuchEntityException; use Magento\Quote\Api\CartRepositoryInterface; use Magento\Quote\Model\ResourceModel\Quote\Address; +use Magento\Sales\Api\OrderRepositoryInterface; use Opengento\Gdpr\Service\Anonymize\AnonymizerInterface; use Opengento\Gdpr\Service\Erase\ProcessorInterface; @@ -23,6 +24,11 @@ final class QuoteDataProcessor implements ProcessorInterface */ private $anonymizer; + /** + * @var \Magento\Sales\Api\OrderRepositoryInterface + */ + private $orderRepository; + /** * @var \Magento\Quote\Api\CartRepositoryInterface */ @@ -33,40 +39,35 @@ final class QuoteDataProcessor implements ProcessorInterface */ private $quoteAddressResourceModel; - /** - * @var \Magento\Framework\Api\SearchCriteriaBuilder - */ - private $searchCriteriaBuilder; - /** * @param \Opengento\Gdpr\Service\Anonymize\AnonymizerInterface $anonymizer + * @param \Magento\Sales\Api\OrderRepositoryInterface $orderRepository * @param \Magento\Quote\Api\CartRepositoryInterface $quoteRepository * @param \Magento\Quote\Model\ResourceModel\Quote\Address $quoteAddressResourceModel - * @param \Magento\Framework\Api\SearchCriteriaBuilder $searchCriteriaBuilder */ public function __construct( AnonymizerInterface $anonymizer, + OrderRepositoryInterface $orderRepository, CartRepositoryInterface $quoteRepository, - Address $quoteAddressResourceModel, - SearchCriteriaBuilder $searchCriteriaBuilder + Address $quoteAddressResourceModel ) { $this->anonymizer = $anonymizer; + $this->orderRepository = $orderRepository; $this->quoteRepository = $quoteRepository; $this->quoteAddressResourceModel = $quoteAddressResourceModel; - $this->searchCriteriaBuilder = $searchCriteriaBuilder; } /** * @inheritdoc * @throws \Exception */ - public function execute(int $customerId): bool + public function execute(int $orderId): bool { - $searchCriteria = $this->searchCriteriaBuilder->addFilter('customer_id', $customerId); - $quoteList = $this->quoteRepository->getList($searchCriteria->create()); + try { + $order = $this->orderRepository->get($orderId); - /** @var \Magento\Quote\Model\Quote $quote */ - foreach ($quoteList->getItems() as $quote) { + /** @var \Magento\Quote\Model\Quote $quote */ + $quote = $this->quoteRepository->get($order->getQuoteId()); $this->quoteRepository->save($this->anonymizer->anonymize($quote)); /** @var \Magento\Quote\Model\Quote\Address|null $quoteAddress */ @@ -75,6 +76,8 @@ public function execute(int $customerId): bool $this->quoteAddressResourceModel->save($this->anonymizer->anonymize($quoteAddress)); } } + } catch (NoSuchEntityException $e) { + /** Silence is golden */ } return true; diff --git a/Model/Order/Anonymize/Processor/SubscriberDataProcessor.php b/Model/Order/Anonymize/Processor/SubscriberDataProcessor.php index a84f8db..e6892e9 100644 --- a/Model/Order/Anonymize/Processor/SubscriberDataProcessor.php +++ b/Model/Order/Anonymize/Processor/SubscriberDataProcessor.php @@ -8,6 +8,7 @@ namespace Opengento\Gdpr\Model\Order\Anonymize\Processor; use Magento\Newsletter\Model\ResourceModel\Subscriber as ResourceSubscriber; +use Magento\Sales\Api\OrderRepositoryInterface; use Opengento\Gdpr\Model\Newsletter\SubscriberFactory; use Opengento\Gdpr\Service\Anonymize\AnonymizerInterface; use Opengento\Gdpr\Service\Erase\ProcessorInterface; @@ -22,6 +23,11 @@ final class SubscriberDataProcessor implements ProcessorInterface */ private $anonymizer; + /** + * @var \Magento\Sales\Api\OrderRepositoryInterface + */ + private $orderRepository; + /** * @var \Opengento\Gdpr\Model\Newsletter\SubscriberFactory */ @@ -34,15 +40,18 @@ final class SubscriberDataProcessor implements ProcessorInterface /** * @param \Opengento\Gdpr\Service\Anonymize\AnonymizerInterface $anonymizer + * @param \Magento\Sales\Api\OrderRepositoryInterface $orderRepository * @param \Opengento\Gdpr\Model\Newsletter\SubscriberFactory $subscriberFactory * @param \Magento\Newsletter\Model\ResourceModel\Subscriber $subscriberResourceModel */ public function __construct( AnonymizerInterface $anonymizer, + OrderRepositoryInterface $orderRepository, SubscriberFactory $subscriberFactory, ResourceSubscriber $subscriberResourceModel ) { $this->anonymizer = $anonymizer; + $this->orderRepository = $orderRepository; $this->subscriberFactory = $subscriberFactory; $this->subscriberResourceModel = $subscriberResourceModel; } @@ -51,11 +60,13 @@ public function __construct( * @inheritdoc * @throws \Exception */ - public function execute(int $customerId): bool + public function execute(int $orderId): bool { + $order = $this->orderRepository->get($orderId); + /** @var \Opengento\Gdpr\Model\Newsletter\Subscriber $subscriber */ $subscriber = $this->subscriberFactory->create(); - $subscriber->loadByCustomerId($customerId); + $subscriber->loadByEmail($order->getCustomerEmail()); $this->anonymizer->anonymize($subscriber); $this->subscriberResourceModel->save($subscriber->getRealSubscriber()); diff --git a/Model/Order/Delete/Processor/OrderDataProcessor.php b/Model/Order/Delete/Processor/OrderDataProcessor.php index a11ddbb..043eaa6 100644 --- a/Model/Order/Delete/Processor/OrderDataProcessor.php +++ b/Model/Order/Delete/Processor/OrderDataProcessor.php @@ -8,6 +8,7 @@ namespace Opengento\Gdpr\Model\Order\Delete\Processor; use Magento\Sales\Api\OrderRepositoryInterface; +use Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface; use Opengento\Gdpr\Service\Erase\ProcessorInterface; /** @@ -20,20 +21,38 @@ final class OrderDataProcessor implements ProcessorInterface */ private $orderRepository; + /** + * @var \Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface + */ + private $eraseSalesInformation; + /** * @param \Magento\Sales\Api\OrderRepositoryInterface $orderRepository + * @param \Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface $eraseSalesInformation */ public function __construct( - OrderRepositoryInterface $orderRepository + OrderRepositoryInterface $orderRepository, + EraseSalesInformationInterface $eraseSalesInformation ) { $this->orderRepository = $orderRepository; + $this->eraseSalesInformation = $eraseSalesInformation; } /** * @inheritdoc + * @throws \Exception */ public function execute(int $orderId): bool { - return $this->orderRepository->delete($this->orderRepository->get($orderId)); + $order = $this->orderRepository->get($orderId); + $lastActive = new \DateTime($order->getUpdatedAt()); + + if ($this->eraseSalesInformation->isAlive($lastActive)) { + $this->eraseSalesInformation->scheduleEraseEntity((int) $order->getEntityId(), 'order', $lastActive); + + return true; + } + + return $this->orderRepository->delete($order); } } diff --git a/Model/Order/OrderChecker.php b/Model/Order/OrderChecker.php index 7ba6a66..47099a3 100644 --- a/Model/Order/OrderChecker.php +++ b/Model/Order/OrderChecker.php @@ -41,12 +41,10 @@ public function __construct( /** * @inheritdoc */ - public function canErase(int $orderId, bool $forceReload = false): bool + public function canErase(int $orderId): bool { $order = $this->orderRepository->get($orderId); - return !$order->getCustomerId() && - $order->getCustomerIsGuest() && - \in_array($order->getState(), $this->config->getAllowedStatesToErase(), true); + return \in_array($order->getState(), $this->config->getAllowedStatesToErase(), true); } } diff --git a/Service/Export/Renderer/XmlRenderer.php b/Service/Export/Renderer/XmlRenderer.php index 932fce7..e4495a8 100644 --- a/Service/Export/Renderer/XmlRenderer.php +++ b/Service/Export/Renderer/XmlRenderer.php @@ -38,6 +38,6 @@ public function __construct( */ public function render(array $data): string { - return $this->convertArray->assocToXml($data)->__toString(); + return (string) $this->convertArray->assocToXml($data); } } diff --git a/etc/adminhtml/system/erasure.xml b/etc/adminhtml/system/erasure.xml index a402b8b..d737185 100644 --- a/etc/adminhtml/system/erasure.xml +++ b/etc/adminhtml/system/erasure.xml @@ -57,7 +57,16 @@ gdpr/erasure/entity_max_age_schedule - + + + The time is in days. + validate-number validate-number-range number-range-0-3650 + + 1 + + gdpr/erasure/sales_max_age + + Opengento\Gdpr\Model\Config\Source\OrderPendingStates @@ -66,7 +75,7 @@ 0 gdpr/erasure/allowed_states - + Defines the components erasure strategy with the component/erase processor mapper for the customers. Opengento\Gdpr\Block\Adminhtml\Config\Form\Field\EraseComponentsProcessors @@ -77,7 +86,7 @@ 1 gdpr/erasure/customer_components_processors - + Defines the components erasure strategy with the component/erase processor mapper for the guests. Opengento\Gdpr\Block\Adminhtml\Config\Form\Field\EraseComponentsProcessors @@ -88,7 +97,7 @@ 1 gdpr/erasure/guest_components_processors - + 1 diff --git a/etc/config.xml b/etc/config.xml index 09fd29e..84e7b70 100755 --- a/etc/config.xml +++ b/etc/config.xml @@ -123,6 +123,7 @@ * * * * * 1095 0 1 * * * + 3650 canceled,closed,complete 1 diff --git a/etc/di.xml b/etc/di.xml index f117680..9e70b9e 100644 --- a/etc/di.xml +++ b/etc/di.xml @@ -662,12 +662,6 @@ Opengento\Gdpr\Model\Config\Source\Customer\EraseComponents - - - created_at - Magento\Customer\Api\Data\CustomerInterface::CREATED_AT - - @@ -719,7 +713,7 @@ created_at - Magento\Sales\Api\Data\OrderInterface::CREATED_AT + Magento\Sales\Api\Data\OrderInterface::UPDATED_AT @@ -731,6 +725,7 @@ + From 12535fac262f7d910efe690f0073755c9ca9716b Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Wed, 17 Jul 2019 10:25:27 +0200 Subject: [PATCH 72/75] #19 move sales information interface as public api --- {Model/Erase => Api}/EraseSalesInformationInterface.php | 2 +- Model/Customer/Anonymize/Processor/OrderDataProcessor.php | 6 +++--- Model/Customer/Delete/Processor/OrderDataProcessor.php | 6 +++--- Model/Erase/EraseSalesInformation.php | 1 + Model/Order/Anonymize/Processor/OrderDataProcessor.php | 6 +++--- Model/Order/Delete/Processor/OrderDataProcessor.php | 6 +++--- etc/di.xml | 2 +- 7 files changed, 15 insertions(+), 14 deletions(-) rename {Model/Erase => Api}/EraseSalesInformationInterface.php (95%) diff --git a/Model/Erase/EraseSalesInformationInterface.php b/Api/EraseSalesInformationInterface.php similarity index 95% rename from Model/Erase/EraseSalesInformationInterface.php rename to Api/EraseSalesInformationInterface.php index 7ab3763..dd8f307 100644 --- a/Model/Erase/EraseSalesInformationInterface.php +++ b/Api/EraseSalesInformationInterface.php @@ -5,7 +5,7 @@ */ declare(strict_types=1); -namespace Opengento\Gdpr\Model\Erase; +namespace Opengento\Gdpr\Api; use Opengento\Gdpr\Api\Data\EraseEntityInterface; diff --git a/Model/Customer/Anonymize/Processor/OrderDataProcessor.php b/Model/Customer/Anonymize/Processor/OrderDataProcessor.php index e78a0fa..ccbf964 100644 --- a/Model/Customer/Anonymize/Processor/OrderDataProcessor.php +++ b/Model/Customer/Anonymize/Processor/OrderDataProcessor.php @@ -12,7 +12,7 @@ use Magento\Sales\Api\OrderAddressRepositoryInterface; use Magento\Sales\Api\OrderRepositoryInterface; use Magento\Sales\Model\Order; -use Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface; +use Opengento\Gdpr\Api\EraseSalesInformationInterface; use Opengento\Gdpr\Service\Anonymize\AnonymizerInterface; use Opengento\Gdpr\Service\Erase\ProcessorInterface; @@ -42,7 +42,7 @@ final class OrderDataProcessor implements ProcessorInterface private $searchCriteriaBuilder; /** - * @var \Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface + * @var \Opengento\Gdpr\Api\EraseSalesInformationInterface */ private $eraseSalesInformation; @@ -51,7 +51,7 @@ final class OrderDataProcessor implements ProcessorInterface * @param \Magento\Sales\Api\OrderRepositoryInterface $orderRepository * @param \Magento\Sales\Api\OrderAddressRepositoryInterface $orderAddressRepository * @param \Magento\Framework\Api\SearchCriteriaBuilder $searchCriteriaBuilder - * @param \Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface $eraseSalesInformation + * @param \Opengento\Gdpr\Api\EraseSalesInformationInterface $eraseSalesInformation */ public function __construct( AnonymizerInterface $anonymizer, diff --git a/Model/Customer/Delete/Processor/OrderDataProcessor.php b/Model/Customer/Delete/Processor/OrderDataProcessor.php index 05d0668..94916b6 100644 --- a/Model/Customer/Delete/Processor/OrderDataProcessor.php +++ b/Model/Customer/Delete/Processor/OrderDataProcessor.php @@ -10,7 +10,7 @@ use Magento\Framework\Api\SearchCriteriaBuilder; use Magento\Sales\Api\Data\OrderInterface; use Magento\Sales\Api\OrderRepositoryInterface; -use Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface; +use Opengento\Gdpr\Api\EraseSalesInformationInterface; use Opengento\Gdpr\Service\Erase\ProcessorInterface; /** @@ -29,14 +29,14 @@ final class OrderDataProcessor implements ProcessorInterface private $searchCriteriaBuilder; /** - * @var \Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface + * @var \Opengento\Gdpr\Api\EraseSalesInformationInterface */ private $eraseSalesInformation; /** * @param \Magento\Sales\Api\OrderRepositoryInterface $orderRepository * @param \Magento\Framework\Api\SearchCriteriaBuilder $searchCriteriaBuilder - * @param \Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface $eraseSalesInformation + * @param \Opengento\Gdpr\Api\EraseSalesInformationInterface $eraseSalesInformation */ public function __construct( OrderRepositoryInterface $orderRepository, diff --git a/Model/Erase/EraseSalesInformation.php b/Model/Erase/EraseSalesInformation.php index 53d5faf..a6ab7ac 100644 --- a/Model/Erase/EraseSalesInformation.php +++ b/Model/Erase/EraseSalesInformation.php @@ -11,6 +11,7 @@ use Opengento\Gdpr\Api\Data\EraseEntityInterface; use Opengento\Gdpr\Api\Data\EraseEntityInterfaceFactory; use Opengento\Gdpr\Api\EraseEntityRepositoryInterface; +use Opengento\Gdpr\Api\EraseSalesInformationInterface; use Opengento\Gdpr\Model\Config; /** diff --git a/Model/Order/Anonymize/Processor/OrderDataProcessor.php b/Model/Order/Anonymize/Processor/OrderDataProcessor.php index a6f7eea..64738a8 100644 --- a/Model/Order/Anonymize/Processor/OrderDataProcessor.php +++ b/Model/Order/Anonymize/Processor/OrderDataProcessor.php @@ -9,7 +9,7 @@ use Magento\Sales\Api\OrderAddressRepositoryInterface; use Magento\Sales\Api\OrderRepositoryInterface; -use Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface; +use Opengento\Gdpr\Api\EraseSalesInformationInterface; use Opengento\Gdpr\Service\Anonymize\AnonymizerInterface; use Opengento\Gdpr\Service\Erase\ProcessorInterface; @@ -34,7 +34,7 @@ final class OrderDataProcessor implements ProcessorInterface private $orderAddressRepository; /** - * @var \Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface + * @var \Opengento\Gdpr\Api\EraseSalesInformationInterface */ private $eraseSalesInformation; @@ -42,7 +42,7 @@ final class OrderDataProcessor implements ProcessorInterface * @param \Opengento\Gdpr\Service\Anonymize\AnonymizerInterface $anonymizer * @param \Magento\Sales\Api\OrderRepositoryInterface $orderRepository * @param \Magento\Sales\Api\OrderAddressRepositoryInterface $orderAddressRepository - * @param \Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface $eraseSalesInformation + * @param \Opengento\Gdpr\Api\EraseSalesInformationInterface $eraseSalesInformation */ public function __construct( AnonymizerInterface $anonymizer, diff --git a/Model/Order/Delete/Processor/OrderDataProcessor.php b/Model/Order/Delete/Processor/OrderDataProcessor.php index 043eaa6..b50d331 100644 --- a/Model/Order/Delete/Processor/OrderDataProcessor.php +++ b/Model/Order/Delete/Processor/OrderDataProcessor.php @@ -8,7 +8,7 @@ namespace Opengento\Gdpr\Model\Order\Delete\Processor; use Magento\Sales\Api\OrderRepositoryInterface; -use Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface; +use Opengento\Gdpr\Api\EraseSalesInformationInterface; use Opengento\Gdpr\Service\Erase\ProcessorInterface; /** @@ -22,13 +22,13 @@ final class OrderDataProcessor implements ProcessorInterface private $orderRepository; /** - * @var \Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface + * @var \Opengento\Gdpr\Api\EraseSalesInformationInterface */ private $eraseSalesInformation; /** * @param \Magento\Sales\Api\OrderRepositoryInterface $orderRepository - * @param \Opengento\Gdpr\Model\Erase\EraseSalesInformationInterface $eraseSalesInformation + * @param \Opengento\Gdpr\Api\EraseSalesInformationInterface $eraseSalesInformation */ public function __construct( OrderRepositoryInterface $orderRepository, diff --git a/etc/di.xml b/etc/di.xml index 9e70b9e..1ad4424 100644 --- a/etc/di.xml +++ b/etc/di.xml @@ -13,6 +13,7 @@ + @@ -725,7 +726,6 @@ - From 8652b723d4ebfa2d77d2518d83a23e97f8dc90d7 Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Wed, 17 Jul 2019 10:51:06 +0200 Subject: [PATCH 73/75] update readme --- README.md | 37 ++++++++++++++++++++++++------------- TODO.md | 1 - 2 files changed, 24 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index fd3350b..56dccaa 100755 --- a/README.md +++ b/README.md @@ -5,11 +5,11 @@ [![Packagist](https://img.shields.io/packagist/dt/opengento/module-gdpr.svg?style=flat-square)](https://packagist.org/packages/opengento/module-gdpr) [![Packagist](https://img.shields.io/packagist/dm/opengento/module-gdpr.svg?style=flat-square)](https://packagist.org/packages/opengento/module-gdpr) -This extension allows customers to delete, anonymize, and export their personal data. +This extension allows users to delete, anonymize, and export their personal data. - [Setup](#setup) - - [Get the package](#get-the-package) - - [Install the module](#install-the-module) + - [Composer installation](#composer-installation) + - [Setup the module](#setup-the-module) - [Usage](#usage) - [Settings](#settings) - [Developers](#developers) @@ -26,21 +26,19 @@ Magento 2 Open Source or Commerce edition is required. This module does not support Magento `2.0.x` and `2.1.x`, as these versions ar not anymore maintained. -### Get the package +**The next stable release will break all previous versions, and will be published as the following tag: `100.0.0`** -**Zip Package:** +### Composer installation -Unzip the package in app/code/Opengento/Gdpr. - -**Composer Package:** +Run the following composer command: ``` composer require opengento/module-gdpr ``` -### Install the module +### Setup the module -Then, run the following magento command: +Run the following magento command: ``` bin/magento setup:upgrade @@ -51,14 +49,27 @@ bin/magento setup:upgrade ## Usage * **[Art. 17 GDPR](https://gdpr-info.eu/art-17-gdpr/)** - * Account deletion and anonymization can be done in 'My Account > Privacy Settings'. - * Customers can use their 'right to be forgotten'. The password is required to ensure the customer legibility. + * Customers can use their 'right to be forgotten'. Account deletion and anonymization can be done in 'My Account > Privacy Settings'. + The password is required to ensure the customer legibility. The account will be erased within 1 hour, or as specified in configuration. The customer can undo the action in this time span. + * Guest users can use their 'right to be forgotten'. Account deletion and anonymization can be done in the order view, + they must fill the guest form first to show their order. + The data will be erased within 1 hour, or as specified in the configuration. The guest can undo the action is this time spare. + * The customers and guests will be erased after a configurable idle time. + * The sales information are locked within a configurable time. These information are automatically erased after this period. * **[Art. 20 GDPR](https://gdpr-info.eu/art-20-gdpr/)** - * Personal data export can be done in 'My Account > Privacy Settings'. * Customers can export their data in `.zip` archive containing file, `.html` (many others are available), with personal data. + Personal data export can be done in 'My Account > Privacy Settings'. + * Guest users can export their data in `.zip` archive containing file, `.html` (many others are available), with personal data. + Personal data export can be done in the order view, they must fill the guest form first to show their order. * Cookie Policy in a disclosure popup are shown at the first time customer visit. +As a merchant you can easily manage which type of entity must to be delete or anonymize. In the last case, +the module allows to define which attribute must to be anonymize, and how it is. + +Times are configurable too, you can define the period of cancellation for the erasure, +the idle time for the users before they are erase, and the sales information lifetime. + ## Settings The configuration for this module is located in 'Stores > Configuration > Customers > Customer Configuration > Privacy (GDPR)'. diff --git a/TODO.md b/TODO.md index 49635cf..6747841 100644 --- a/TODO.md +++ b/TODO.md @@ -20,7 +20,6 @@ Area: - Payment Data - Invitation Data -- Multiple export in command line result in filename expanded at each iteration ## Anonymizer From aca5de45bba38658c7cbf8346b3769b32e980ec6 Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Thu, 18 Jul 2019 17:17:36 +0200 Subject: [PATCH 74/75] #20 update translations --- i18n/en_US.csv | 27 +++++++++++++++++++-------- i18n/fr_FR.csv | 27 +++++++++++++++++++-------- 2 files changed, 38 insertions(+), 16 deletions(-) diff --git a/i18n/en_US.csv b/i18n/en_US.csv index 9678069..bbaca7f 100644 --- a/i18n/en_US.csv +++ b/i18n/en_US.csv @@ -4,15 +4,17 @@ Anonymizer,Anonymizer Component,Component Processor,Processor "Add Component Erasure Strategy","Add Component Erasure Strategy" -"Erase Customer","Erase Customer" +"Erase Personal Data","Erase Personal Data" "Are you sure you want to do this?","Are you sure you want to do this?" -"Export Customer","Export Customer" -"You erased the customer.","You erased the customer." +"Export Personal Data","Export Personal Data" +"You erased the order.","You erased the order." "An error occurred on the server.","An error occurred on the server." +"You erased the customer.","You erased the customer." "Customer with id ""%1"": %2","Customer with id ""%1"": %2" "A total of %1 record(s) were erased.","A total of %1 record(s) were erased." "Your personal data is being removed soon.","Your personal data is being removed soon." "Something went wrong, please try again later!","Something went wrong, please try again later!" +"You canceled your personal data deletion.","You canceled your personal data deletion." "Your account is already being removed.","Your account is already being removed." "You did not sign in correctly or your account is temporarily disabled.","You did not sign in correctly or your account is temporarily disabled." "You canceled your account deletion.","You canceled your account deletion." @@ -35,25 +37,33 @@ Warning,Warning "Your account will be erased soon. You can undo this action.","Your account will be erased soon. You can undo this action." "Undo Action","Undo Action" "Your account cannot be erased while you have pending orders.","Your account cannot be erased while you have pending orders." -"Export Personal Data","Export Personal Data" Information,Information -"Erase Personal Data","Erase Personal Data" +"Undo Erase Personal Data","Undo Erase Personal Data" "Cookie Disclosure","Cookie Disclosure" "Read More","Read More" Accept,Accept "GDPR Compliance Erase Customer","GDPR Compliance Erase Customer" "GDPR Compliance Export Customer","GDPR Compliance Export Customer" +"GDPR Compliance Erase Guest Order","GDPR Compliance Erase Guest Order" +"GDPR Compliance Export Guest Order","GDPR Compliance Export Guest Order" "GDPR Compliance Section","GDPR Compliance Section" "GDPR Compliance","GDPR Compliance" "Cookie Settings","Cookie Settings" "Right To Erasure","Right To Erasure" Erasure,Erasure +"It will enable the erase action to the storefront.","It will enable the erase action to the storefront." "Erasure Delay","Erasure Delay" "Erasure delay in minute before the execution by the cron.","Erasure delay in minute before the execution by the cron." -"Cron Schedule","Cron Schedule" +"Erase Entity Cron Schedule","Erase Entity Cron Schedule" +"Entities Lifetime","Entities Lifetime" +"The time is in days.","The time is in days." +"Erase Old Entities Cron Schedule","Erase Old Entities Cron Schedule" +"Sales Information Lifetime","Sales Information Lifetime" "Allowed Order States to Erase","Allowed Order States to Erase" -"Component Erasure Strategy","Component Erasure Strategy" -"Defines the components erasure strategy with the component/erase processor mapper.","Defines the components erasure strategy with the component/erase processor mapper." +"Customer Component Erasure Strategy","Customer Component Erasure Strategy" +"Defines the components erasure strategy with the component/erase processor mapper for the customers.","Defines the components erasure strategy with the component/erase processor mapper for the customers." +"Guest Component Erasure Strategy","Guest Component Erasure Strategy" +"Defines the components erasure strategy with the component/erase processor mapper for the guests.","Defines the components erasure strategy with the component/erase processor mapper for the guests." Anonymization,Anonymization "Delete Customer if no Orders","Delete Customer if no Orders" "We will delete the customer if he has no orders. It's only applicable if the component ""customer"" use the ""anonymize"" processor.","We will delete the customer if he has no orders. It's only applicable if the component ""customer"" use the ""anonymize"" processor." @@ -78,6 +88,7 @@ Anonymization,Anonymization "Subscriber Attributes Anonymizers","Subscriber Attributes Anonymizers" "Export Settings","Export Settings" Export,Export +"It will enable the export action to the storefront.","It will enable the export action to the storefront." Renderer,Renderer Customer,Customer "Customer Attributes","Customer Attributes" diff --git a/i18n/fr_FR.csv b/i18n/fr_FR.csv index e2bc0b3..1c16b9e 100644 --- a/i18n/fr_FR.csv +++ b/i18n/fr_FR.csv @@ -4,15 +4,17 @@ Anonymizer,Anonymisation Component,Composant Processor,Processeur "Add Component Erasure Strategy","Ajouter une stratégie d'oublie pour un composant" -"Erase Customer","Oublier le client" +"Erase Personal Data","Oublier les données personnelles" "Are you sure you want to do this?","Êtes-vous sûr de vouloir faire cette action?" -"Export Customer","Exporter le client" -"You erased the customer.","Vous avez oublié le client." +"Export Personal Data","Exporter les données personnelles" +"You erased the order.","Vous avez oublié la commande." "An error occurred on the server.","Une erreur est survenue sur le serveur." +"You erased the customer.","Vous avez oublié le client." "Customer with id ""%1"": %2","Client avec l'id ""%1"": %2" "A total of %1 record(s) were erased.","Un total de %1 enregistrement(s) ont été oubliés." "Your personal data is being removed soon.","Vos données personnelles vont être bientôt supprimées." "Something went wrong, please try again later!","Quelque chose ne s'est pas bien passé, essayez à nouveau plus tard !" +"You canceled your personal data deletion.","Vous avez annulé la supression de vos données personelles." "Your account is already being removed.","Votre compte est déjà en cours de suppression." "You did not sign in correctly or your account is temporarily disabled.","Vous ne vous êtes pas correctement identifié ou votre compte a été temporairement désactivé." "You canceled your account deletion.","Vous avez annulé la suppression de votre compte." @@ -35,25 +37,33 @@ Warning,Attention "Your account will be erased soon. You can undo this action.","Votre compte sera oublié sous peu. Vous pouvez annuler cette action." "Undo Action","Annuler l'action" "Your account cannot be erased while you have pending orders.","Votre compte ne peut pas être oublié tant que vous avez des commandes en cours." -"Export Personal Data","Exporter les données personnelles" Information,Information -"Erase Personal Data","Oublier les données personnelles" +"Undo Erase Personal Data","Annuler l'oublie des données personnelles" "Cookie Disclosure","Divulgation de cookie" "Read More","Lire plus" Accept,Accepter "GDPR Compliance Erase Customer","Conformité RGPD: Oublier le client" "GDPR Compliance Export Customer","Conformité RGPD: Exporter le client" +"GDPR Compliance Erase Guest Order","Conformité RGPD: Oublier l'invité" +"GDPR Compliance Export Guest Order","Conformité RGPD: Exporter l'invité" "GDPR Compliance Section","Section sur la conformité RGPD" "GDPR Compliance","Conformité RGPD" "Cookie Settings","Paramètres sur les cookies" "Right To Erasure","Droit à l'oubli" Erasure,Oublier +"It will enable the erase action to the storefront.","L'action relative au droit d'oubli sera effective sur la vue client." "Erasure Delay","Délai avant l'oubli" "Erasure delay in minute before the execution by the cron.","Le délai pour l'oubli est exprimé en minutes avant l'éxécution par le cron." -"Cron Schedule","Planification du cron" +"Erase Entity Cron Schedule","Planification du cron pour l'oublie des entités" +"Entities Lifetime","Durée de vie des entités" +"The time is in days.","La durée est en jours." +"Erase Old Entities Cron Schedule","Planification du cron pour l'oublie des vielles entités" +"Sales Information Lifetime","Durée de vie des information de ventes" "Allowed Order States to Erase","État de commande autorisé pour le droit à l'oubli" -"Component Erasure Strategy","Stratégie d'oublie par composant" -"Defines the components erasure strategy with the component/erase processor mapper.","Permet de définir la stratégie d'oubli des composants à partir d'un mappage composant/processeur d'oubli." +"Customer Component Erasure Strategy","Stratégie d'oublie des entités pour les clients connectés" +"Defines the components erasure strategy with the component/erase processor mapper for the customers.","Permet de définir la stratégie d'oubli des composants à partir d'un mappage composant/processeur d'oubli pour les clients connectés." +"Guest Component Erasure Strategy","Stratégie d'oublie pour les invités" +"Defines the components erasure strategy with the component/erase processor mapper for the guests.","Permet de définir la stratégie d'oubli des composants à partir d'un mappage composant/processeur d'oubli pour les invités." Anonymization,Anonymisation "Delete Customer if no Orders","Supprimer le client s'il n'a pas de commande" "We will delete the customer if he has no orders. It's only applicable if the component ""customer"" use the ""anonymize"" processor.","Nous supprimerons le client s'il n'a pas passé de commande. Ce paramètre n'est applicable que si le composant ""client"" utilise le processus ""anonymize""." @@ -78,6 +88,7 @@ Anonymization,Anonymisation "Subscriber Attributes Anonymizers","Anonymiseurs des attributs souscripteur" "Export Settings","Paramètres d'export" Export,Export +"It will enable the export action to the storefront.","L'action relative à l'export sera effective sur la vue client." Renderer,Renderer Customer,Client "Customer Attributes","Attributs client" From 7e8777e3407fe0d73015ed571351bfc9c8c5496d Mon Sep 17 00:00:00 2001 From: Thomas Klein Date: Thu, 18 Jul 2019 17:18:08 +0200 Subject: [PATCH 75/75] fix repository cache layer --- Model/EraseEntityRepository.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Model/EraseEntityRepository.php b/Model/EraseEntityRepository.php index 44f8824..bdb6074 100644 --- a/Model/EraseEntityRepository.php +++ b/Model/EraseEntityRepository.php @@ -122,7 +122,7 @@ public function getById(int $entityId, bool $forceReload = false): EraseEntityIn */ public function getByEntity(int $entityId, string $entityType, bool $forceReload = false): EraseEntityInterface { - if ($forceReload || !isset($this->instancesByCustomer[$entityId])) { + if ($forceReload || !isset($this->instancesByEntity[$entityId])) { /** @var \Opengento\Gdpr\Api\Data\EraseEntityInterface $entity */ $entity = $this->eraseCustomerFactory->create(); $this->eraseCustomerResource->load(