eZ\Bundle\EzPublishCoreBundle\Command\ReindexCommand

Complexity

Total Complexity

24

Size/Duplication

Total Lines	215
Duplicated Lines	3.26 %

Coupling/Cohesion

Components	2
Dependencies	10

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	initialize()	0	10	2
A	configure()	0	21	1
B	execute()	0	33	5
A	executeParallel()	0	14	2
A	getStatementContentSince()	0	16	1
A	getStatementContentAll()	0	14	1
A	fetchIteration()	7	15	4
A	getPhpProcess()	0	13	2
B	getNumberOfCPUCores()	0	28	6

<?php

/**
 * This file is part of the eZ Publish Kernel package.
 *
 * @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 eZ\Publish\Core\Search\Common\IterativelyIndexer;
use eZ\Publish\SPI\Persistence\Content\ContentInfo;
use eZ\Publish\Core\Search\Common\Indexer;
use Doctrine\DBAL\Driver\Statement;
use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Process\Process;
use Symfony\Component\Process\PhpExecutableFinder;
use RuntimeException;
use DateTime;
use PDO;

class ReindexCommand extends ContainerAwareCommand
{
    /**
     * @var \eZ\Publish\Core\Search\Common\Indexer
     */
    private $searchIndexer;

    /**
     * Initialize objects required by {@see execute()}.
     *
     * @param InputInterface $input
     * @param OutputInterface $output
     */
    public function initialize(InputInterface $input, OutputInterface $output)
    {
        parent::initialize($input, $output);
        $this->searchIndexer = $this->getContainer()->get('ezpublish.spi.search.indexer');
        if (!$this->searchIndexer instanceof Indexer) {
            throw new RuntimeException(
                sprintf('Expected to find Search Engine Indexer but found "%s" instead', get_parent_class($this->searchIndexer))
            );
        }
    }

    /**
     * {@inheritdoc}
     */
    protected function configure()
    {
        $this
            ->setName('ezplatform:reindex')
            ->setDescription('Recreate or Refresh search engine index')
            ->addOption('iteration-count', 'c', InputOption::VALUE_OPTIONAL, 'Number of objects to be indexed in a single iteration, for avoiding using to much memory', 20)
            ->addOption('no-commit', null, InputOption::VALUE_NONE, 'Do not commit after each iteration')
            ->addOption('no-purge', null, InputOption::VALUE_NONE, 'Do not purge before indexing. BC NOTE: Should this be default as of 2.0?')
            ->addOption('since', null, InputOption::VALUE_NONE, 'Index changes since a given time, any format understood by DateTime. Implies "no-purge", can not be combined with "content-ids".')
            ->addOption('content-ids', null, InputOption::VALUE_NONE, 'Comma separated list of content id\'s to refresh (deleted or updated/added). Implies "no-purge", can not be combined with "since".')
            ->addOption('processes', null, InputOption::VALUE_NONE, 'Number of sub processes to spawn in parallel, by default: (number of cpu cores)-1, disable by setting to "0"', $this->getNumberOfCPUCores() -1)
            ->setHelp(
                <<<EOT
The command <info>%command.name%</info> indexes current configured database in configured search engine index.


TODO: ADD EXAMPLES OF ADVANCE USAGE!

EOT
            );
    }

    /**
     * {@inheritdoc}
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $noCommit = $input->getOption('no-commit');
        $iterationCount = $input->getOption('iteration-count');
        if (!is_numeric($iterationCount) || (int) $iterationCount < 1) {
            throw new RuntimeException("'--iteration-count' option should be > 0, got '{$iterationCount}'");
        }


        if (!$this->searchIndexer instanceof IterativelyIndexer) {
            $output->writeln( <<<EOT
DEPRECATED:
Running indexing against an Indexer that has not been updated to use IterativelyIndexer abstract.

Options that won't be taken into account:
- since
- content-ids
- processes
- no-purge
EOT
            );
            $this->searchIndexer->createSearchIndex($output, (int) $iterationCount, empty($noCommit));

            return 0;
        }

        // If content-ids are specified we assume we are in a sub process or that it's not needed
        if ($contentIds = $input->getOption('content-ids')) {
            $this->searchIndexer->updateSearchIndex($contentIds);
        }

        return $this->executeParallel($input, $output, (int) $iterationCount, (bool) $noCommit);
    }


    private function executeParallel(InputInterface $input, OutputInterface $output, $iterationCount, $noCommit)

The parameter $output is not used and could be removed.

The parameter $iterationCount is not used and could be removed.

The parameter $noCommit is not used and could be removed.

    {
        $since = $input->getOption('since');
        $processes = $input->getOption('processes');

$processes is not used, you could remove the assignment.

        $noPurge = $input->getOption('no-purge');

$noPurge is not used, you could remove the assignment.

        if ($since) {
            $stmt = $this->getStatementContentSince(new DateTime($since));

$stmt is not used, you could remove the assignment.

        } else {
            $stmt = $this->getStatementContentAll();

$stmt is not used, you could remove the assignment.

        }


    }

    /**
     * @param DateTime $since
     *
     * @return \Doctrine\DBAL\Driver\Statement
     */
    private function getStatementContentSince(DateTime $since)
    {
        /**
         * @var \Doctrine\DBAL\Connection $connection
         */
        $connection = $this->getContainer()->get('ezpublish.api.storage_engine.legacy.connection');
        $q = $connection->createQueryBuilder()
            ->select('c.id')
            ->from('ezcontentobject', 'c')
            ->where('c.status = :status')->andWhere('c.modified >= :since')
            ->orderBy('c.modified', true)
            ->setParameter('status', ContentInfo::STATUS_PUBLISHED, PDO::PARAM_INT)
            ->setParameter('since', $since->getTimestamp(), PDO::PARAM_INT);

        return $q->execute();
    }

    /**
     * @return \Doctrine\DBAL\Driver\Statement
     */
    private function getStatementContentAll()
    {
        /**
         * @var \Doctrine\DBAL\Connection $connection
         */
        $connection = $this->getContainer()->get('ezpublish.api.storage_engine.legacy.connection');
        $q = $connection->createQueryBuilder()
            ->select('c.id')
            ->from('ezcontentobject', 'c')
            ->where('c.status = :status')
            ->setParameter('status', ContentInfo::STATUS_PUBLISHED, PDO::PARAM_INT);

        return $q->execute();

The expression $q->execute(); of type Doctrine\DBAL\Driver\Statement|integer adds the type integer to the return on line 164 which is incompatible with the return type documented by eZ\Bundle\EzPublishCoreBundle\Command\ReindexCommand::getStatementContentAll of type Doctrine\DBAL\Driver\Statement.

    }

    /**
     * @param \Doctrine\DBAL\Driver\Statement $stmt
     * @param int $iterationCount
     *
     * @return int[][] Return an array of arrays, each array contains content id's of $iterationCount.
     */
    private function fetchIteration(Statement $stmt, $iterationCount)
    {
        do {
            $contentIds = [];
            for ($i = 0; $i < $iterationCount; ++$i) {

This code seems to be duplicated across your project.

                if ($contentId = $stmt->fetch(PDO::FETCH_COLUMN)) {
                    $contentIds[] = $contentId;
                } else {
                    break;
                }
            }

            yield $contentIds;
        } while ($contentId);

The variable $contentId does not seem to be defined for all execution paths leading up to this point.

    }

    /**
     * @param string $consoleDir
     *
     * @return Process
     */
    private static function getPhpProcess($consoleDir = 'app')

This method is not used, and could be removed.

    {
        $phpFinder = new PhpExecutableFinder();
        if (!$phpPath = $phpFinder->find()) {
            throw new \RuntimeException('The php executable could not be found, add it to your PATH environment variable and try again');
        }

        $cmd = 'ezplatform:reindex';
        $php = escapeshellarg($phpFinder);
        $console = escapeshellarg($consoleDir.'/console');

        return new Process($php.' '.$console.' '.$cmd, null, null, null, null);
    }

    /**
     * @return int
     */
    private function getNumberOfCPUCores()
    {
        $cores = 1;
        if (is_file('/proc/cpuinfo')) {
            // Linux (and potentially Windows with linux sub systems)
            $cpuinfo = file_get_contents('/proc/cpuinfo');
            preg_match_all('/^processor/m', $cpuinfo, $matches);
            $cores = count($matches[0]);
        } else if (DIRECTORY_SEPARATOR === '\\') {
            // Windows
            if (($process = @popen('wmic cpu get NumberOfCores', 'rb')) !== false) {
                fgets($process);
                $cores = (int) fgets($process);
                pclose($process);
            }
        } else {
            // *nix (Linux, BSD and Mac)
            if (($process = @popen('sysctl -a', 'rb')) !== false) {
                $output = stream_get_contents($process);
                if (preg_match('/hw.ncpu: (\d+)/', $output, $matches)) {
                    $cores = (int) $matches[1][0];
                }
                pclose($process);
            }
        }

        return $cores;
    }
}