New command for log retention

Author: magentix

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.2.2
+
+- New command for log retention
+
 ## 1.2.1
 
 - Country added in logs grid

README.md

@@ -57,7 +57,9 @@ Display Audit Trails under the menu: *Advanced settings > Sucuri Logs*
 
 - **Refresh:** Add the logs for the current day
 
-### CLI
+## CLI
+
+### Refresh Logs
 
 ```shell
 ./bin/console sucuri:log-refresh
@@ -67,4 +69,23 @@ It's recommended to refresh the logs hourly using a CRON job.
 
 ```php
 0 * * * * /path/to/prestashop/bin/console sucuri:log-refresh
+```
+
+### Clean Logs
+
+```shell
+./bin/console sucuri:log-clean {retention_period}
+```
+
+Keep logs for the specified number of days in command argument. Default period is 60 days.
+
+```shell
+./bin/console sucuri:log-clean 30
+158 logs purged for a 30-day retention period
+```
+
+It's recommended to clean the logs hourly using a CRON job.
+
+```php
+0 * * * * /path/to/prestashop/bin/console sucuri:log-clean 60
 ```

config/services.yml

@@ -113,3 +113,12 @@ services:
       $translator: '@translator'
     tags:
       - { name: 'console.command' }
+
+  pixel.sucuri.log.clean:
+    class: Pixel\Module\Sucuri\Command\LogClean
+    public: true
+    arguments:
+      $api: '@pixel.sucuri.api'
+      $translator: '@translator'
+    tags:
+      - { name: 'console.command' }

pixel_sucuri.php

@@ -17,7 +17,7 @@ class Pixel_sucuri extends Module
     public function __construct()
     {
         $this->name = 'pixel_sucuri';
-        $this->version = '1.2.1';
+        $this->version = '1.2.2';
         $this->author = 'Pixel Open';
         $this->tab = 'administration';
         $this->need_instance = 0;

src/Command/LogClean.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Pixel\Module\Sucuri\Command;
+
+use Exception;
+use Pixel\Module\Sucuri\Model\Api;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Translation\TranslatorInterface;
+
+class LogClean extends Command
+{
+    private Api $api;
+
+    private TranslatorInterface $translator;
+
+    public function __construct(
+        Api $api,
+        TranslatorInterface $translator,
+        string $name = null
+    ) {
+        $this->api = $api;
+        $this->translator = $translator;
+
+        parent::__construct($name);
+    }
+
+    protected function configure()
+    {
+        $this->setName('sucuri:log-clean')
+            ->setDescription('Clean Sucuri logs')
+            ->addArgument('retention', InputArgument::OPTIONAL, 'Log retention (days)', 60);
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        try {
+            $retention = (int)$input->getArgument('retention');
+            if ($retention) {
+                $total = $this->api->cleanLog($retention);
+                $output->writeln(
+                    $this->translator->trans('%s logs purged for a %s-day retention period', [$total, $retention], 'Modules.Pixelsucuri.Admin')
+                );
+            }
+        } catch (Exception $exception) {
+            $output->writeln(
+                $this->translator->trans('Unable to clean the logs: %s', [$exception->getMessage()], 'Modules.Pixelsucuri.Admin')
+            );
+        }
+    }
+}

src/Model/Api.php

@@ -8,6 +8,7 @@
 
 namespace Pixel\Module\Sucuri\Model;
 
+use Doctrine\Common\Collections\Criteria;
 use Exception;
 use Pixel\Module\Sucuri\Helper\Cache;
 use Pixel\Module\Sucuri\Helper\Config;
@@ -236,6 +237,28 @@ protected function doRefreshLog(int $offset = 0): int
         return $total;
     }
 
+    /**
+     * Clean logs
+     *
+     * @param int $retentionPeriod
+     * @return void
+     * @throws Exception
+     */
+    public function cleanLog(int $retentionPeriod = 60): int
+    {
+        $toDate = date('Y-m-d H:i:s', strtotime('-' . $retentionPeriod . ' days'));
+
+        $criteria = Criteria::create()->where(Criteria::expr()->lt('fullDate', $toDate));
+
+        $logs = $this->logRepository->matching($criteria);
+
+        foreach ($logs as $log) {
+            $this->logRepository->delete($log->getId());
+        }
+
+        return count($logs);
+    }
+
     /**
      * Is option editable
      *

src/Repository/SucuriLog.php

@@ -8,6 +8,7 @@
 
 namespace Pixel\Module\Sucuri\Repository;
 
+use Doctrine\Common\Collections\Criteria;
 use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\OptimisticLockException;
@@ -169,6 +170,17 @@ public function findAll(array $criteria, ?array $orderBy = null): array
         return $repository->findBy($criteria, $orderBy);
     }
 
+    /**
+     * @param Criteria $criteria
+     * @return array
+     */
+    public function matching(Criteria $criteria): array
+    {
+        $repository = $this->entityManager->getRepository(Entity::class);
+
+        return $repository->matching($criteria)->getValues();
+    }
+
     /**
      * @throws Exception
      */