<?php
declare(strict_types=1);

/**
 * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 * @link          https://cakephp.org CakePHP(tm) Project
 * @license       https://www.opensource.org/licenses/mit-license.php MIT License
 */
namespace Migrations\Command;

use Cake\Console\Arguments;
use Cake\Console\ConsoleIo;
use Cake\Core\Configure;

/**
 * Trait needed for all "snapshot" type of bake operations.
 * Snapshot type operations are : baking a snapshot and baking a diff.
 */
trait SnapshotTrait
{
    /**
     * @inheritDoc
     */
    protected function createFile(string $path, string $contents, Arguments $args, ConsoleIo $io): bool
    {
        $createFile = parent::createFile($path, $contents, $args, $io);

        if ($createFile) {
            $this->markSnapshotApplied($path, $args, $io);

            if (!$args->getOption('no-lock')) {
                $this->refreshDump($args, $io);
            }
        }

        return $createFile;
    }

    /**
     * @internal
     * @return bool Whether the builtin backend is active.
     */
    protected function useBuiltinBackend(): bool
    {
        return Configure::read('Migrations.backend', 'builtin') === 'builtin';
    }

    /**
     * Will mark a snapshot created, the snapshot being identified by its
     * full file path.
     *
     * @param string $path Path to the newly created snapshot
     * @param \Cake\Console\Arguments $args The command arguments.
     * @param \Cake\Console\ConsoleIo $io The console io
     * @return void
     */
    protected function markSnapshotApplied(string $path, Arguments $args, ConsoleIo $io): void
    {
        $fileName = pathinfo($path, PATHINFO_FILENAME);
        [$version, ] = explode('_', $fileName, 2);

        $newArgs = [];
        $newArgs[] = '-t';
        $newArgs[] = $version;
        $newArgs[] = '-o';

        $newArgs = array_merge($newArgs, $this->parseOptions($args));

        $io->out('Marking the migration ' . $fileName . ' as migrated...');
        if ($this->useBuiltinBackend()) {
            $this->executeCommand(MarkMigratedCommand::class, $newArgs, $io);
        } else {
            $this->executeCommand(MigrationsMarkMigratedCommand::class, $newArgs, $io);
        }
    }

    /**
     * After a file has been successfully created, we refresh the dump of the database
     * to be able to generate a new diff afterward.
     *
     * @param \Cake\Console\Arguments $args The command arguments.
     * @param \Cake\Console\ConsoleIo $io The console io
     * @return void
     */
    protected function refreshDump(Arguments $args, ConsoleIo $io): void
    {
        $newArgs = $this->parseOptions($args);

        $io->out('Creating a dump of the new database state...');
        if ($this->useBuiltinBackend()) {
            $this->executeCommand(DumpCommand::class, $newArgs, $io);
        } else {
            $this->executeCommand(MigrationsDumpCommand::class, $newArgs, $io);
        }
    }

    /**
     * Will parse 'connection', 'plugin' and 'source' options into a new Array
     *
     * @param \Cake\Console\Arguments $args The command arguments.
     * @return array Array containing the short for the option followed by its value
     */
    protected function parseOptions(Arguments $args): array
    {
        $newArgs = [];
        if ($args->getOption('connection')) {
            $newArgs[] = '-c';
            $newArgs[] = $args->getOption('connection');
        }

        if ($args->getOption('plugin')) {
            $newArgs[] = '-p';
            $newArgs[] = $args->getOption('plugin');
        }

        if ($args->getOption('source')) {
            $newArgs[] = '-s';
            $newArgs[] = $args->getOption('source');
        }

        return $newArgs;
    }
}
