EZP-29451: As an Administrator I want to have a CLI command for database cleanup

eZ/Bundle/EzPublishCoreBundle/Command/CleanupVersionsCommand.php

@@ -0,0 +1,263 @@
+<?php
+
+/**
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+namespace eZ\Bundle\EzPublishCoreBundle\Command;
+
+use Doctrine\DBAL\Connection;
+use Exception;
+use eZ\Bundle\EzPublishCoreBundle\ApiLoader\RepositoryConfigurationProvider;
+use eZ\Publish\API\Repository\Repository;
+use eZ\Publish\API\Repository\Values\Content\VersionInfo;
+use eZ\Publish\Core\Base\Exceptions\InvalidArgumentException;
+use PDO;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\Output;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class CleanupVersionsCommand extends Command
+{
+    const DEFAULT_REPOSITORY_USER = 'admin';
+
+    const VERSION_DRAFT = 'draft';
+    const VERSION_ARCHIVED = 'archived';
+    const VERSION_PUBLISHED = 'published';
+    const VERSION_ALL = 'all';
+
+    const VERSION_STATUS = [
+        self::VERSION_DRAFT => VersionInfo::STATUS_DRAFT,
+        self::VERSION_ARCHIVED => VersionInfo::STATUS_ARCHIVED,
+        self::VERSION_PUBLISHED => VersionInfo::STATUS_PUBLISHED,
+    ];
+
+    /**
+     * @var \eZ\Publish\API\Repository\Repository
+     */
+    private $repository;
+
+    /**
+     * @var \eZ\Publish\API\Repository\UserService
+     */
+    private $userService;
+
+    /**
+     * @var \eZ\Publish\API\Repository\ContentService
+     */
+    private $contentService;
+
+    /**
+     * @var \eZ\Publish\API\Repository\PermissionResolver
+     */
+    private $permissionResolver;
+
+    /**
+     * @var \eZ\Bundle\EzPublishCoreBundle\ApiLoader\RepositoryConfigurationProvider
+     */
+    private $repositoryConfigurationProvider;
+
+    /**
+     * @var \Doctrine\DBAL\Driver\Connection
+     */
+    private $connection;
+
+    public function __construct(
+        Repository $repository,
+        RepositoryConfigurationProvider $repositoryConfigurationProvider,
+        Connection $connection
+    ) {
+        $this->repository = $repository;
+        $this->repositoryConfigurationProvider = $repositoryConfigurationProvider;
+        $this->connection = $connection;
+
+        parent::__construct();
+    }
+
+    protected function initialize(InputInterface $input, OutputInterface $output)
+    {
+        parent::initialize($input, $output);
+
+        $this->userService = $this->repository->getUserService();
+        $this->contentService = $this->repository->getContentService();
+        $this->permissionResolver = $this->repository->getPermissionResolver();
+
+        $this->permissionResolver->setCurrentUserReference(
+            $this->userService->loadUserByLogin($input->getOption('user'))
+        );
+    }
+
+    protected function configure()
+    {
+        $config = $this->repositoryConfigurationProvider->getRepositoryConfig();
+
+        $this
+            ->setName('ezplatform:content:cleanup-versions')
+            ->setDescription('Remove unwanted content versions. It keeps published version untouched. By default, it keeps also the last archived/draft version.')
+            ->addOption(
+                'status',
+                't',
+                InputOption::VALUE_OPTIONAL,
+                sprintf(
+                    "Select which version types should be removed: '%s', '%s', '%s'.",
+                    self::VERSION_DRAFT,
+                    self::VERSION_ARCHIVED,
+                    self::VERSION_ALL
+                ),
+                self::VERSION_ALL
+            )
+            ->addOption(
+                'keep',
+                'k',
+                InputOption::VALUE_OPTIONAL,
+                "Sets number of the most recent versions (both drafts and archived) which won't be removed.",
+                $config['options']['default_version_archive_limit']
+            )
+            ->addOption(
+                'user',
+                'u',
+                InputOption::VALUE_OPTIONAL,
+                'eZ Platform username (with Role containing at least Content policies: remove, read, versionread)',
+                self::DEFAULT_REPOSITORY_USER
+            );
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        if (($keep = (int) $input->getOption('keep')) < 0) {
+            throw new InvalidArgumentException(
+                'status',
+                'Keep value can not be negative.'
+            );
+        }
+
+        $status = $input->getOption('status');
+
+        $contentIds = $this->getObjectsIds($keep, $status);
+        $contentIdsCount = count($contentIds);
+
+        if ($contentIdsCount === 0) {
+            $output->writeln('<info>There is no Content matching given criteria.</info>');
+
+            return;
+        }
+
+        $output->writeln(sprintf(
+            '<info>Found %d Content IDs matching given criteria.</info>',
+            $contentIdsCount
+        ));
+
+        $removedVersionsCounter = 0;
+
+        $removeAll = $status === self::VERSION_ALL;
+        $removeDrafts = $status === self::VERSION_DRAFT;
+        $removeArchived = $status === self::VERSION_ARCHIVED;
+
+        foreach ($contentIds as $contentId) {
+            try {
+                $contentInfo = $this->contentService->loadContentInfo((int) $contentId);
+                $versions = $this->contentService->loadVersions($contentInfo);
+                $versionsCount = count($versions);
+
+                $output->writeln(sprintf(
+                    '<info>Content %d has %d version(s)</info>',
+                    (int) $contentId,
+                    $versionsCount
+                ), Output::VERBOSITY_VERBOSE);
+
+                $versions = array_slice(
+                    array_filter($versions, function ($version) use ($removeAll, $removeDrafts, $removeArchived) {
+                        if (
+                            ($removeAll && $version->status !== VersionInfo::STATUS_PUBLISHED) ||
+                            ($removeDrafts && $version->status === VersionInfo::STATUS_DRAFT) ||
+                            ($removeArchived && $version->status === VersionInfo::STATUS_ARCHIVED)
+                        ) {
+                            return $version;
+                        }
+                    }), 0, -$keep);
+
+                $output->writeln(sprintf(
+                    "Found %d content's (%d) version(s) to remove.",
+                    count($versions),
+                    (int) $contentId
+                ), Output::VERBOSITY_VERBOSE);
+
+                /** @var \eZ\Publish\API\Repository\Values\Content\VersionInfo $version */
+                foreach ($versions as $version) {
+                    $this->contentService->deleteVersion($version);
+                    ++$removedVersionsCounter;
+                    $output->writeln(sprintf(
+                        "Content's (%d) version (%d) has been deleted.",
+                        $contentInfo->id,
+                        $version->id
+                    ), Output::VERBOSITY_VERBOSE);
+                }
+            } catch (Exception $e) {
+                $output->writeln(sprintf(
+                    '<error>%s</error>',
+                    $e->getMessage()
+                ));
+            }
+        }
+
+        $output->writeln(sprintf(
+            '<info>Removed %d unwanted contents version(s).</info>',
+            $removedVersionsCounter
+        ));
+    }
+
+    /**
+     * @param int $keep
+     * @param string $status
+     *
+     * @return array
+     *
+     * @throws \eZ\Publish\Core\Base\Exceptions\InvalidArgumentException
+     */
+    protected function getObjectsIds($keep, $status)
+    {
+        $query = $this->connection->createQueryBuilder()
+                ->select('c.id')
+                ->from('ezcontentobject', 'c')
+                ->join('c', 'ezcontentobject_version', 'v', 'v.contentobject_id = c.id')
+                ->groupBy('c.id', 'v.status')
+                ->having('count(c.id) > :keep');
+        $query->setParameter('keep', $keep);
+
+        if ($status !== self::VERSION_ALL) {
+            $query->where('v.status = :status');
+            $query->setParameter('status', $this->mapStatusToVersionInfoStatus($status));
+        } else {
+            $query->andWhere('v.status != :status');
+            $query->setParameter('status', $this->mapStatusToVersionInfoStatus(self::VERSION_PUBLISHED));
+        }
+
+        $stmt = $query->execute();
+
+        return $stmt->fetchAll(PDO::FETCH_COLUMN);
+    }
+
+    /**
+     * @param string $status
+     *
+     * @return int
+     *
+     * @throws \eZ\Publish\Core\Base\Exceptions\InvalidArgumentException
+     */
+    private function mapStatusToVersionInfoStatus($status)
+    {
+        if (array_key_exists($status, self::VERSION_STATUS)) {
+            return self::VERSION_STATUS[$status];
+        }
+
+        throw new InvalidArgumentException(
+            'status',
+            sprintf(
+                "Status %s can't be mapped to VersionInfo status.",
+                $status
+            )
+        );
+    }
+}

eZ/Bundle/EzPublishCoreBundle/Resources/config/services.yml

@@ -230,3 +230,12 @@ services:
         class: eZ\Publish\Core\MVC\Symfony\Translation\ValidationErrorFileVisitor
         tags:
             - { name: jms_translation.file_visitor, alias: ez_validation_error }
+
+    ezplatform.core.command.cleanup_versions:
+        class: eZ\Bundle\EzPublishCoreBundle\Command\CleanupVersionsCommand
+        arguments:
+            - "@ezpublish.signalslot.repository"
+            - "@ezpublish.api.repository_configuration_provider"
+            - "@ezpublish.persistence.connection"
+        tags:
+            - { name: console.command }