Yapeal\Console\Command\DatabaseUpdater

Complexity

Total Complexity

24

Size/Duplication

Total Lines	216
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	12
Bugs	2	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	addDatabaseProcedure()	0	11	1
A	configure()	0	22	1
A	dropDatabaseProcedure()	0	6	1
A	getLatestDatabaseVersion()	0	21	2
C	getUpdateFileList()	0	25	7
C	processSql()	0	40	8
B	updateDatabaseVersion()	0	27	3

<?php
/**
 * Contains DatabaseUpdater class.
 *
 * PHP version 5.5
 *
 * LICENSE:
 * This file is part of Yet Another Php Eve Api Library also know as Yapeal
 * which can be used to access the Eve Online API data and place it into a
 * database.
 * Copyright (C) 2014-2016 Michael Cummings
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * You should be able to find a copy of this license in the LICENSE.md file. A
 * copy of the GNU GPL should also be available in the GNU-GPL.md file.
 *
 * @copyright 2014-2016 Michael Cummings
 * @license   http://www.gnu.org/copyleft/lesser.html GNU LGPL
 * @author    Michael Cummings <mgcummings@yahoo.com>
 */
namespace Yapeal\Console\Command;

use Symfony\Component\Console\Output\OutputInterface;
use Yapeal\Container\ContainerInterface;
use Yapeal\Exception\YapealDatabaseException;

/**
 * Class DatabaseUpdater
 */
class DatabaseUpdater extends AbstractDatabaseCommon
{
    /**
     * @param string|null        $name
     * @param ContainerInterface $dic
     *
     * @throws \Symfony\Component\Console\Exception\InvalidArgumentException
     * @throws \Symfony\Component\Console\Exception\LogicException
     */
    public function __construct($name, ContainerInterface $dic)
    {
        $this->setDescription('Retrieves SQL from files and updates database');
        $this->setName($name);
        $this->setDic($dic);
        parent::__construct($name);
    }
    /**
     * @param OutputInterface $output
     *
     * @throws \InvalidArgumentException
     * @throws \LogicException
     * @throws \Symfony\Component\Console\Exception\LogicException
     * @throws \Yapeal\Exception\YapealDatabaseException
     */
    protected function addDatabaseProcedure(OutputInterface $output)
    {
        $name = 'DatabaseUpdater::addDatabaseProcedure';
        $csq = $this->getCsq();
        $this->executeSqlStatements(
            $csq->getDropAddOrModifyColumnProcedure() . PHP_EOL . $csq->getCreateAddOrModifyColumnProcedure(),
            $name,
            $output
        );
        $output->writeln('');
    }
    /**
     * Configures the current command.
     */
    protected function configure()
    {
        $help = <<<'HELP'
The <info>%command.full_name%</info> command is used to initialize (create) a new
 database and tables to be used by Yapeal. If you already have a
 config/yapeal.yaml file setup you can use the following:

    <info>php %command.full_name%</info>

EXAMPLES:
To use a configuration file in a different location:
    <info>%command.name% -c /my/very/special/config.yaml</info>

<info>NOTE:</info>
Only the Database section of the configuration file will be used.

You can also use the command before setting up a configuration file like so:
    <info>%command.name% -o "localhost" -d "yapeal" -u "YapealUser" -p "secret"

HELP;
        $this->addOptions($help);
    }
    /**
     * @param OutputInterface $output
     *
     * @throws \InvalidArgumentException
     * @throws \LogicException
     * @throws \Symfony\Component\Console\Exception\LogicException
     * @throws \Yapeal\Exception\YapealDatabaseException
     */
    protected function dropDatabaseProcedure(OutputInterface $output)
    {
        $name = 'DatabaseUpdater::dropDatabaseProcedure';
        $this->executeSqlStatements($this->getCsq()
                                         ->getDropAddOrModifyColumnProcedure(), $name, $output);
    }
    /**
     * @param OutputInterface $output
     *
     * @return string
     * @throws \LogicException
     * @throws \Yapeal\Exception\YapealDatabaseException
     */
    protected function getLatestDatabaseVersion(OutputInterface $output)
    {
        $sql = $this->getCsq()
                    ->getUtilLatestDatabaseVersion();
        try {
            $result = $this->getPdo()
                           ->query($sql, \PDO::FETCH_NUM);
            $version = sprintf('%018.3F', $result->fetchColumn());
            $result->closeCursor();
        } catch (\PDOException $exc) {
            $version = '19700101000001.000';
            $mess = sprintf('<error>Could NOT get latest database version using default %1$s</error>', $version);
            $output->writeln([$sql, $mess]);
            $mess = sprintf(
                '<info>Error message from database connection was %s</info>',
                $exc->getMessage()
            );
            $output->writeln($mess);
        }
        return $version;
    }
    /**
     * @param OutputInterface $output
     *
     * @return string[]
     * @throws \LogicException
     */
    protected function getUpdateFileList(OutputInterface $output)
    {
        $fileNames = [];
        $path = $this->getDic()['Yapeal.Sql.dir'] . 'updates/';
        if (!is_readable($path) || !is_dir($path)) {
            $mess = sprintf(
                '<info>Could NOT access update directory %1$s</info>',
                $path
            );
            $output->writeln($mess);
            return $fileNames;
        }
        foreach (new \DirectoryIterator($path) as $fileInfo) {
            if ($fileInfo->isDot() || $fileInfo->isDir()) {
                continue;
            }
            if ('sql' !== $fileInfo->getExtension()) {
                continue;
            }
            $fileNames[] = $this->getFpn()
                                ->normalizeFile($fileInfo->getPathname());
        }
        asort($fileNames);
        return $fileNames;
    }
    /**
     * @param OutputInterface $output
     *
     * @throws \InvalidArgumentException
     * @throws \LogicException
     * @throws \Symfony\Component\Console\Exception\LogicException
     * @throws \Yapeal\Exception\YapealDatabaseException
     */
    protected function processSql(OutputInterface $output)
    {
        $this->addDatabaseProcedure($output);
        foreach ($this->getUpdateFileList($output) as $fileName) {
            $latestVersion = $this->getLatestDatabaseVersion($output);
            if (!is_file($fileName)) {
                if ($output::VERBOSITY_QUIET !== $output->getVerbosity()) {
                    $mess = sprintf('<info>Could NOT find SQL file %1$s</info>', $fileName);
                    $output->writeln($mess);
                }
                continue;
            }
            $updateVersion = basename($fileName, '.sql');
            if ($updateVersion <= $latestVersion) {
                if ($output::VERBOSITY_QUIET !== $output->getVerbosity()) {
                    $mess = sprintf(
                        '<info>Skipping SQL file %1$s since its <= the latest database version %2$s</info>',
                        basename($fileName),
                        $latestVersion
                    );
                    $output->writeln($mess);
                }
                continue;
            }
            $sqlStatements = file_get_contents($fileName);
            if (false === $sqlStatements) {
                if ($output::VERBOSITY_QUIET !== $output->getVerbosity()) {
                    $mess = sprintf(
                        '<error>Could NOT get contents of SQL file %1$s</error>',
                        $fileName
                    );
                    $output->writeln($mess);
                }
                continue;
            }
            $this->executeSqlStatements($sqlStatements, $fileName, $output);
            $this->updateDatabaseVersion($updateVersion);
        }
        $this->dropDatabaseProcedure($output);
    }
    /**
     * @param string $updateVersion
     *
     * @return DatabaseUpdater
     * @throws \LogicException
     * @throws \Yapeal\Exception\YapealDatabaseException
     */
    protected function updateDatabaseVersion($updateVersion)
    {
        $pdo = $this->getPdo();
        $sql = $this->getCsq()
                    ->getUtilLatestDatabaseVersionUpdate();
        try {
            $pdo->beginTransaction();
            $pdo->prepare($sql)
                ->execute([$updateVersion]);
            $pdo->commit();
        } catch (\PDOException $exc) {
            $mess = $sql . PHP_EOL;
            $mess .= sprintf('Database error message was %s', $exc->getMessage()) . PHP_EOL;
            $mess .= sprintf(
                'Database "version" update failed for %1$s',
                $updateVersion
            );
            if ($this->getPdo()
                     ->inTransaction()
            ) {
                $this->getPdo()
                     ->rollBack();
            }
            throw new YapealDatabaseException($mess, 2);
        }
        return $this;
    }
}