sunnysideup / silverstripe-migration-task

src/Tasks/MigrateDataTaskBase.php

<?php

namespace Sunnysideup\MigrateData\Tasks;

use Exception;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Environment;
use SilverStripe\Dev\BuildTask;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\DB;
use Sunnysideup\Flush\FlushNow;
use Sunnysideup\MigrateData\Traits\HelperMethods;

abstract class MigrateDataTaskBase extends BuildTask
{
    use FlushNow;
    use HelperMethods;

The trait Sunnysideup\MigrateData\Traits\HelperMethods requires some properties which are not provided by Sunnysideup\MigrateData\Tasks\MigrateDataTaskBase: $ID, $ClassName

    protected $title = 'Abstract Migration Class';

    protected $description = 'Please extend this class';

    protected $enabled = false;

    protected $_schema;

    protected $_schemaForDataObject;

    private $_cacheTableExists = [];

    private $_cacheFieldExists = [];

    public function run($request)
    {
        $this->flushNowLine();
        $this->flushNow('THE START - look out for THE END ...');
        $this->flushNowLine();
        $this->flushNow(
            '
            <link href="/resources/vendor/silverstripe/framework/client/styles/debug.css" rel="stylesheet">
            <ul class="build">
            ',
            '',
            false
        );
        DataObject::Config()->set('validation_enabled', false);
        ini_set('memory_limit', '1024M');
        Environment::increaseMemoryLimitTo();
        Environment::increaseTimeLimitTo(7200);

        $this->performMigration();

        $this->flushNow('</ul>', '', false);
        $this->flushNow('');
        $this->flushNow('');
        $this->flushNow('');
        $this->flushNowLine();
        $this->flushNow('THE END');
        $this->flushNowLine();
        $this->flushNow('');
    }

    /**
     * Queries the config for Migrate definitions, and runs migrations
     * if you extend this task then overwrite it this method.
     */
    abstract protected function performMigration();

    /**
     * data needs to be in this format:
     *      [
     *          'include_inserts' => true|false, #assumed true if not provided
     *          'old_table' => 'foo',
     *          'new_table' => 'bar' (can be the same!).
     *
     *          'simple_move_fields' => ['A', 'B', 'C']
     *          OR
     *          'complex_move_fields' => ['A' => 'Anew', 'B' => 'BBew', 'C2' => 'Cnew']
     *      ]
     * list of data that is going to be moved
     */
    protected function runMoveData(array $data)
    {
        if ([] !== $data) {
            $this->flushNow('<h3>Migrating data - Core Migration</h3>');
            foreach ($data as $dataItem) {
                if (! isset($dataItem['include_inserts'])) {
                    $dataItem['include_inserts'] = true;
                }
                if (! isset($dataItem['leftJoin'])) {
                    $dataItem['leftJoin'] = [];
                }
                if (! isset($dataItem['where'])) {
                    $dataItem['where'] = '';
                }
                if (! isset($dataItem['include_inserts'])) {
                    $dataItem['include_inserts'] = true;
                }
                if (! isset($dataItem['new_table'])) {
                    $dataItem['new_table'] = $dataItem['old_table'];
                }
                $dataItem['old_fields'] = [];
                $dataItem['new_fields'] = [];

                if (isset($dataItem['simple_move_fields'])) {
                    $dataItem['old_fields'] = $dataItem['simple_move_fields'];
                    $dataItem['new_fields'] = $dataItem['simple_move_fields'];
                } elseif (isset($dataItem['complex_move_fields'])) {
                    $dataItem['old_fields'] = array_keys($dataItem['complex_move_fields']);
                    $dataItem['new_fields'] = array_values($dataItem['complex_move_fields']);
                } else {
                    $this->flushNow('Could not find simple_move_fields or complex_move_fields.');
                }

                if (count($dataItem['new_fields']) !== count($dataItem['old_fields'])) {
                    user_error('Count of new fields does not match old fields');
                    foreach ($dataItem['old_fields'] as $value) {
                        if ((int) $value === $value) {
                            $this->flushNow('Potential error in fields: ' . print_r($dataItem['old_fields'], 1), 'error');

Are you sure print_r($dataItem['old_fields'], 1) of type string|true can be used in concatenation?

                        }
                    }
                    foreach ($dataItem['new_fields'] as $value) {
                        if ((int) $value === $value) {
                            $this->flushNow('Potential error in fields: ' . print_r($dataItem['new_fields'], 1), 'error');

Are you sure print_r($dataItem['new_fields'], 1) of type string|true can be used in concatenation?

                        }
                    }
                }
                $this->flushNow('<h6>Migrating data ' . $dataItem['old_table'] . ' to ' . $dataItem['new_table'] . '</h6>');
                $this->migrateSimple(
                    $dataItem['include_inserts'],
                    $dataItem['old_table'],
                    $dataItem['new_table'],
                    $dataItem['old_fields'],
                    $dataItem['new_fields'],
                    $dataItem['leftJoin'],
                    $dataItem['where']
                );
            }
        }
    }

    /**
     * Migrates data from one table to another.
     *
     * @param bool   $includeInserts - the db table where we are moving fields from
     * @param string $tableOld       - the db table where we are moving fields from
     * @param string $tableNew       - the db table where we are moving fields to
     * @param array  $fieldNamesOld  - The current field names
     * @param array  $fieldNamesNew  - The new field names (this may be the same as $fieldNameOld)
     * @param array  $leftJoin       -
     * @param string $where          -
     */
    protected function migrateSimple(
        bool $includeInserts,
        string $tableOld,
        string $tableNew,
        array $fieldNamesOld,
        array $fieldNamesNew,
        array $leftJoin = [],
        string $where = ''
    ) {
        if (! $this->tableExists($tableOld)) {
            $this->flushNow("{$tableOld} (old table) does not exist", 'error');
        }

        if (! $this->tableExists($tableNew)) {
            $this->flushNow("{$tableNew} (new table) does not exist", 'error');
        }

        try {
            $this->flushNow('getting new table IDs.');
            $newEntryIDs = $this->getListOfIDs($tableNew);

            $this->flushNow('getting old IDs.');
            $oldEntries = $this->getListAsIterableQuery($tableOld, $leftJoin, $where);
            $oldEntryIDs = [];

            //add a new line using the ID as identifier
            foreach ($oldEntries as $oldEntry) {
                if ($includeInserts) {
                    if (! in_array($oldEntry['ID'], $newEntryIDs, true)) {
                        $this->flushNow('Added row ' . $oldEntry['ID'] . ' to ' . $tableNew . '.');
                        $this->runUpdateQuery('INSERT INTO "' . $tableNew . '" ("ID") VALUES (' . $oldEntry['ID'] . ');');
                    }
                }

                $oldEntryIDs[] = $oldEntry['ID'];
            }

            //update fields
            if (count($oldEntryIDs) > 0) {
                //work out what option is shorter in terms of ID count:
                $this->flushNow('working out update SQL.');
                $allIDs = $this->getListOfIDs($tableNew);
                $allIDCount = count($allIDs);
                $oldIDCount = count($oldEntryIDs);
                if ($oldIDCount > ($allIDCount - $oldIDCount)) {
                    $excludeIDs = array_diff($allIDs, $oldEntryIDs);
                    if (0 === count($excludeIDs)) {
                        $excludeIDs = [0];
                    }
                    $wherePhrase = ' NOT IN (' . implode(', ', $excludeIDs) . ')';
                } else {
                    if (0 === count($oldEntryIDs)) {
                        $oldEntryIDs = [0];
                    }
                    $wherePhrase = ' IN (' . implode(', ', $oldEntryIDs) . ')';
                }

                //update the new table with the old values
                //for the rows that join with the ID and match the list of OLD ids.
                if (count($fieldNamesNew) > 0) {
                    $updateQuery = 'UPDATE "' . $tableNew . '" AS "tablenew" ';
                    $updateQuery .= 'INNER JOIN "' . $tableOld . '" AS "tableold" ON "tablenew"."ID" = "tableold"."ID" ';
                    if ('_versions' === substr((string) $tableNew, -9)) {
                        $updateQuery .= ' AND "tablenew"."RecordID" = "tableold"."RecordID" ';
                        // also link to RecordID ...
                    }
                    $updateQuery .= 'SET ';
                    $fieldNamesOldCount = count($fieldNamesOld);
                    $fieldNamesNewCount = count($fieldNamesNew);
                    for ($i = 0; $i < $fieldNamesNewCount && $i < $fieldNamesOldCount; ++$i) {
                        if ($i > 0) {
                            $updateQuery .= ', ';
                        }
                        $updateQuery .= '"tablenew"."' . $fieldNamesNew[$i] . '" = "tableold"."' . $fieldNamesOld[$i] . '" ';
                    }
                    $updateQuery .= 'WHERE "tablenew"."ID" ' . $wherePhrase . ';';
                    $this->flushNow(str_replace($wherePhrase, '........', $updateQuery));
                    $this->runUpdateQuery($updateQuery);
                }
            }
        } catch (Exception $exception) {
            $this->flushNow("Unable to migrate {$tableOld} to {$tableNew}.", 'error');
            $this->flushNow($exception->getMessage(), 'error');
        }
    }
}