9.5/_backend_layout_icon_update_wizard_8php_source.html

<?php

declare(strict_types = 1);

namespace ‪TYPO3\CMS\Install\Updates;


use Doctrine\DBAL\DBALException;

use Psr\Log\LoggerAwareInterface;

use Psr\Log\LoggerAwareTrait;

use Symfony\Component\Console\Output\OutputInterface;

use ‪TYPO3\CMS\Core\Core\Environment;

use ‪TYPO3\CMS\Core\Database\ConnectionPool;

use ‪TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder;

use ‪TYPO3\CMS\Core\Resource\File;

use ‪TYPO3\CMS\Core\Resource\ResourceStorage;

use ‪TYPO3\CMS\Core\Resource\StorageRepository;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;

use ‪TYPO3\CMS\Core\Utility\PathUtility;


class ‪BackendLayoutIconUpdateWizard implements ‪UpgradeWizardInterface, ‪ChattyInterface, LoggerAwareInterface

{

    use LoggerAwareTrait;


    protected ‪$output;


    protected ‪$storage;


    protected ‪$table = 'backend_layout';


    protected ‪$fieldToMigrate = 'icon';


    protected ‪$sourcePath = 'uploads/media/';


    protected ‪$targetPath = '_migrated/backend_layouts/';


    public function ‪getIdentifier(): string

    {

        return 'backendLayoutIcons';

    }


    public function ‪getTitle(): string

    {

        return 'Migrate all file relations from backend_layout.icon to sys_file_references';

    }


    public function ‪getDescription(): string

    {

        return 'This update wizard goes through all files that are referenced in the'

            . ' backend_layout.icon field and adds the files to the FAL File Index.'

            . ' It also moves the files from uploads/ to the fileadmin/_migrated/ path.';

    }


    public function ‪updateNecessary(): bool

    {

        return !empty($this->‪getRecordsFromTable());

    }


    public function ‪getPrerequisites(): array

    {

        return [

            DatabaseUpdatedPrerequisite::class

        ];

    }


    public function ‪setOutput(OutputInterface ‪$output): void

    {

        $this->output = ‪$output;

    }


    public function ‪executeUpdate(): bool

    {

        $result = true;

        try {

            $storages = GeneralUtility::makeInstance(StorageRepository::class)->findAll();

            $this->storage = $storages[0];

            $records = $this->‪getRecordsFromTable();

            foreach ($records as $record) {

                $this->‪migrateField($record);

            }

        } catch (\‪Exception $e) {

            // If something goes wrong, migrateField() logs an error

            $result = false;

        }

        return $result;

    }


    protected function ‪getRecordsFromTable()

    {

        $connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);

        $queryBuilder = $connectionPool->getQueryBuilderForTable($this->table);

        $queryBuilder->getRestrictions()->removeAll();

        try {

            return $queryBuilder

                ->select('uid', 'pid', $this->fieldToMigrate)

                ->from($this->table)

                ->where(

                    $queryBuilder->expr()->isNotNull($this->fieldToMigrate),

                    $queryBuilder->expr()->neq(

                        $this->fieldToMigrate,

                        $queryBuilder->createNamedParameter('', \PDO::PARAM_STR)

                    ),

                    $queryBuilder->expr()->comparison(

                        'CAST(CAST(' . $queryBuilder->quoteIdentifier($this->fieldToMigrate) . ' AS DECIMAL) AS CHAR)',

                        ‪ExpressionBuilder::NEQ,

                        'CAST(' . $queryBuilder->quoteIdentifier($this->fieldToMigrate) . ' AS CHAR)'

                    )

                )

                ->orderBy('uid')

                ->execute()

                ->fetchAll();

        } catch (DBALException $e) {

            throw new \RuntimeException(

                'Database query failed. Error was: ' . $e->getPrevious()->getMessage(),

                1511950673

            );

        }

    }


    protected function ‪migrateField($row)

    {

        $fieldItems = GeneralUtility::trimExplode(',', $row[$this->fieldToMigrate], true);

        if (empty($fieldItems) || is_numeric($row[$this->fieldToMigrate])) {

            return;

        }

        $fileadminDirectory = rtrim(‪$GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'], '/') . '/';

        $i = 0;


        $storageUid = (int)$this->storage->getUid();

        $connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);


        foreach ($fieldItems as $item) {

            $fileUid = null;

            ‪$sourcePath = ‪Environment::getPublicPath() . '/' . $this->sourcePath . $item;

            $targetDirectory = ‪Environment::getPublicPath() . '/' . $fileadminDirectory . ‪$this->targetPath;

            ‪$targetPath = $targetDirectory . ‪PathUtility::basenameDuringBootstrap($item);


            // maybe the file was already moved, so check if the original file still exists

            if (file_exists(‪$sourcePath)) {

                if (!is_dir($targetDirectory)) {

                    GeneralUtility::mkdir_deep($targetDirectory);

                }


                // see if the file already exists in the storage

                $fileSha1 = sha1_file(‪$sourcePath);


                $queryBuilder = $connectionPool->getQueryBuilderForTable('sys_file');

                $queryBuilder->getRestrictions()->removeAll();

                $existingFileRecord = $queryBuilder->select('uid')->from('sys_file')->where(

                    $queryBuilder->expr()->eq(

                        'sha1',

                        $queryBuilder->createNamedParameter($fileSha1, \PDO::PARAM_STR)

                    ),

                    $queryBuilder->expr()->eq(

                        'storage',

                        $queryBuilder->createNamedParameter($storageUid, \PDO::PARAM_INT)

                    )

                )->execute()->fetch();


                // the file exists, the file does not have to be moved again

                if (is_array($existingFileRecord)) {

                    $fileUid = $existingFileRecord['uid'];

                } else {

                    // just move the file (no duplicate)

                    rename(‪$sourcePath, ‪$targetPath);

                }

            }


            if ($fileUid === null) {

                // get the File object if it hasn't been fetched before

                try {

                    // if the source file does not exist, we should just continue, but leave a message in the docs;

                    // ideally, the user would be informed after the update as well.

                    $file = $this->storage->getFile($this->targetPath . $item);

                    $fileUid = $file->getUid();

                } catch (\InvalidArgumentException $e) {

                    // no file found, no reference can be set

                    $this->logger->notice(

                        'File ' . $this->sourcePath . $item . ' does not exist. Reference was not migrated.',

                        [

                            'table' => $this->table,

                            'record' => $row,

                            'field' => $this->fieldToMigrate,

                        ]

                    );

                    $format = 'File \'%s\' does not exist. Referencing field: %s.%d.%s. The reference was not migrated.';

                    $this->output->writeln(sprintf(

                        $format,

                        $this->sourcePath . $item,

                        $this->table,

                        $row['uid'],

                        $this->fieldToMigrate

                    ));

                    continue;

                }

            }


            if ($fileUid > 0) {

                ‪$fields = [

                    'fieldname' => ‪$this->fieldToMigrate,

                    'table_local' => 'sys_file',

                    'pid' => $this->table === 'pages' ? $row['uid'] : $row['pid'],

                    'uid_foreign' => $row['uid'],

                    'uid_local' => $fileUid,

                    'tablenames' => ‪$this->table,

                    'crdate' => time(),

                    'tstamp' => time(),

                    'sorting' => $i + 256,

                    'sorting_foreign' => $i,

                ];


                $queryBuilder = $connectionPool->getQueryBuilderForTable('sys_file_reference');

                $queryBuilder->insert('sys_file_reference')->values(‪$fields)->execute();

                ++$i;

            }

        }


        // Update referencing table's original field to now contain the count of references,

        // but only if all new references could be set

        if ($i === count($fieldItems)) {

            $queryBuilder = $connectionPool->getQueryBuilderForTable($this->table);

            $queryBuilder->update($this->table)->where(

                $queryBuilder->expr()->eq(

                    'uid',

                    $queryBuilder->createNamedParameter($row['uid'], \PDO::PARAM_INT)

                )

            )->set($this->fieldToMigrate, $i)->execute();

        }

    }

}