Environment.php

<?php
declare(strict_types=1);

/**
 * MIT License
 * For full license information, please view the LICENSE file that was distributed with this source code.
 */

namespace Migrations\Migration;

use Cake\Console\ConsoleIo;
use Cake\Datasource\ConnectionManager;
use Migrations\Db\Adapter\AdapterFactory;
use Migrations\Db\Adapter\AdapterInterface;
use Migrations\DirectionalMigrationInterface;
use Migrations\MigrationInterface;
use Migrations\ReversibleMigrationInterface;
use Migrations\SeedInterface;
use RuntimeException;

class Environment
{
    protected string $name;

    /**
     * @var array<string, mixed>
     */
    protected array $options;

    protected ?ConsoleIo $io = null;

    protected int $currentVersion;

    protected string $schemaTableName = 'phinxlog';

    protected AdapterInterface $adapter;

    /**
     * @param string $name Environment Name
     * @param array<string, mixed> $options Options
     */
    public function __construct(string $name, array $options)
    {
        $this->name = $name;
        $this->options = $options;
    }

    /**
     * Executes the specified migration on this environment.
     *
     * @param \Migrations\MigrationInterface $migration Migration
     * @param string $direction Direction
     * @param bool $fake flag that if true, we just record running the migration, but not actually do the migration
     * @return void
     */
    public function executeMigration(MigrationInterface $migration, string $direction = MigrationInterface::UP, bool $fake = false): void
    {
        $direction = $direction === MigrationInterface::UP ? MigrationInterface::UP : MigrationInterface::DOWN;
        $migration->setMigratingUp($direction === MigrationInterface::UP);

        $startTime = time();

        $adapter = $this->getAdapter();
        $migration->setAdapter($adapter);

        $migration->preFlightCheck();

        if (method_exists($migration, MigrationInterface::INIT)) {
            $migration->{MigrationInterface::INIT}();
        }

        $atomic = $migration->useTransactions();
        // begin the transaction if the adapter supports it
        if ($atomic) {
            $adapter->beginTransaction();
        }

        if (!$fake) {
            // Run the migration. Dispatch order: capability interfaces first
            // (statically narrowable for IDEs and static analysis), then a
            // method_exists fallback for migrations that haven't yet adopted
            // either ReversibleMigrationInterface or DirectionalMigrationInterface.
            $isReversible = $migration instanceof ReversibleMigrationInterface
                || (!$migration instanceof DirectionalMigrationInterface
                    && method_exists($migration, MigrationInterface::CHANGE));

            if ($isReversible) {
                if ($direction === MigrationInterface::DOWN) {
                    // Create an instance of the RecordingAdapter so we can record all
                    // of the migration commands for reverse playback

                    /** @var \Migrations\Db\Adapter\RecordingAdapter $recordAdapter */
                    $recordAdapter = AdapterFactory::instance()
                        ->getWrapper('record', $adapter);

                    // Wrap the adapter with a phinx shim to maintain contain
                    $migration->setAdapter($recordAdapter);

                    $migration->{MigrationInterface::CHANGE}();
                    $recordAdapter->executeInvertedCommands();

                    $migration->setAdapter($this->getAdapter());
                } else {
                    $migration->{MigrationInterface::CHANGE}();
                }
            } elseif ($migration instanceof DirectionalMigrationInterface) {
                $direction === MigrationInterface::UP ? $migration->up() : $migration->down();
            } elseif (method_exists($migration, $direction)) {
                $migration->{$direction}();
            }
        }

        // Record it in the database
        $adapter->migrated($migration, $direction, date('Y-m-d H:i:s', $startTime), date('Y-m-d H:i:s', time()));

        // commit the transaction if the adapter supports it
        if ($atomic) {
            $adapter->commitTransaction();
        }

        $migration->postFlightCheck();
    }

    /**
     * Executes the specified seeder on this environment.
     *
     * @param \Migrations\SeedInterface $seed Seed
     * @return void
     */
    public function executeSeed(SeedInterface $seed): void
    {
        $adapter = $this->getAdapter();
        $seed->setAdapter($adapter);
        if (method_exists($seed, SeedInterface::INIT)) {
            $seed->{SeedInterface::INIT}();
        }
        // begin the transaction if the adapter supports it
        $atomic = $adapter->hasTransactions();
        if ($atomic) {
            $adapter->beginTransaction();
        }

        // Run the seeder
        $seed->{SeedInterface::RUN}();

        // Record the seed execution
        // For idempotent seeds, remove old record first to update the timestamp
        if ($seed->isIdempotent()) {
            $adapter->removeSeedFromLog($seed);
        }
        $executedTime = date('Y-m-d H:i:s');
        $adapter->seedExecuted($seed, $executedTime);

        // commit the transaction if the adapter supports it
        if ($atomic) {
            $adapter->commitTransaction();
        }
    }

    /**
     * Sets the environment's name.
     *
     * @param string $name Environment Name
     * @return $this
     */
    public function setName(string $name)
    {
        $this->name = $name;

        return $this;
    }

    /**
     * Gets the environment name.
     *
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }

    /**
     * Sets the environment's options.
     *
     * @param array<string, mixed> $options Environment Options
     * @return $this
     */
    public function setOptions(array $options)
    {
        $this->options = $options;

        return $this;
    }

    /**
     * Gets the environment's options.
     *
     * @return array<string, mixed>
     */
    public function getOptions(): array
    {
        return $this->options;
    }

    /**
     * Sets the consoleio.
     *
     * @param \Cake\Console\ConsoleIo $io ConsoleIo
     * @return $this
     */
    public function setIo(ConsoleIo $io)
    {
        $this->io = $io;

        return $this;
    }

    /**
     * Get the io instance
     *
     * @return \Cake\Console\ConsoleIo $io The io instance to use
     */
    public function getIo(): ?ConsoleIo
    {
        return $this->io;
    }

    /**
     * Gets all migrated version numbers.
     *
     * @return array
     */
    public function getVersions(): array
    {
        return $this->getAdapter()->getVersions();
    }

    /**
     * Get all migration log entries, indexed by version creation time and sorted in ascending order by the configuration's
     * version_order option
     *
     * @return array
     */
    public function getVersionLog(): array
    {
        return $this->getAdapter()->getVersionLog();
    }

    /**
     * Sets the current version of the environment.
     *
     * @param int $version Environment Version
     * @return $this
     */
    public function setCurrentVersion(int $version)
    {
        $this->currentVersion = $version;

        return $this;
    }

    /**
     * Gets the current version of the environment.
     *
     * @return int
     */
    public function getCurrentVersion(): int
    {
        // We don't cache this code as the current version is pretty volatile.
        // that means they're no point in a setter then?
        // maybe we should cache and call a reset() method every time a migration is run
        $versions = $this->getVersions();
        $version = 0;

        if ($versions) {
            $version = end($versions);
        }

        $this->setCurrentVersion($version);

        return $this->currentVersion;
    }

    /**
     * Sets the database adapter.
     *
     * @param \Migrations\Db\Adapter\AdapterInterface $adapter Database Adapter
     * @return $this
     */
    public function setAdapter(AdapterInterface $adapter)
    {
        $this->adapter = $adapter;

        return $this;
    }

    /**
     * Gets the database adapter.
     *
     * @throws \RuntimeException
     * @return \Migrations\Db\Adapter\AdapterInterface
     */
    public function getAdapter(): AdapterInterface
    {
        if (isset($this->adapter)) {
            return $this->adapter;
        }

        $options = $this->getOptions();
        if (!isset($options['connection'])) {
            throw new RuntimeException('No connection defined');
        }
        $connection = ConnectionManager::get($options['connection']);
        $options['connection'] = $connection;

        // Get the driver classname as those are aligned with adapter names.
        $driver = $connection->getDriver();
        $driverClass = $driver::class;
        $driverName = strtolower(substr($driverClass, (int)strrpos($driverClass, '\\') + 1));
        $options['adapter'] = $driverName;

        $factory = AdapterFactory::instance();
        $adapter = $factory
            ->getAdapter($driverName, $options);

        // Automatically time the executed commands
        $adapter = $factory->getWrapper('timed', $adapter);

        if (isset($options['wrapper'])) {
            $adapter = $factory
                ->getWrapper($options['wrapper'], $adapter);
        }

        $io = $this->getIo();
        if ($io instanceof ConsoleIo) {
            $adapter->setIo($io);
        }
        $this->setAdapter($adapter);

        return $adapter;
    }

    /**
     * Sets the schema table name.
     *
     * @param string $schemaTableName Schema Table Name
     * @return $this
     */
    public function setSchemaTableName(string $schemaTableName)
    {
        $this->schemaTableName = $schemaTableName;

        return $this;
    }

    /**
     * Gets the schema table name.
     *
     * @return string
     */
    public function getSchemaTableName(): string
    {
        return $this->schemaTableName;
    }
}