ImageCropUpdater.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);
namespace TYPO3\CMS\Install\Updates\RowUpdater;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Imaging\ImageManipulation\Area;
use TYPO3\CMS\Core\Resource\Exception\FileDoesNotExistException;
use TYPO3\CMS\Core\Resource\ResourceFactory;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\MathUtility;

class ImageCropUpdater implements RowUpdaterInterface
{
    protected $payload = [];

    public function getTitle(): string
    {
        return 'Migrate values in sys_file_reference crop field';
    }

    public function hasPotentialUpdateForTable(string $tableName): bool
    {
        $result = false;
        $payload = $this->getPayloadForTable($tableName);
        if (count($payload) !== 0) {
            $this->payload[$tableName] = $payload;
            $result = true;
        }
        return $result;
    }

    public function updateTableRow(string $tableName, array $inputRow): array
    {
        $tablePayload = $this->payload[$tableName];

        foreach ($tablePayload['fields'] as $field) {
            if (strpos($inputRow[$field], '{"x":') === 0) {
                $cropArray = json_decode($inputRow[$field], true);
                if (is_array($cropArray)) {
                    $file = $this->getFile($inputRow, $tablePayload['fileReferenceField'] ?: 'uid_local');
                    if (null === $file) {
                        continue;
                    }

                    $cropArea = Area::createFromConfiguration(json_decode($inputRow[$field], true));
                    $cropVariantCollectionConfig = [
                        'default' => [
                            'cropArea' => $cropArea->makeRelativeBasedOnFile($file)->asArray(),
                        ]
                    ];
                    $inputRow[$field] = json_encode($cropVariantCollectionConfig);
                }
            }
        }

        return $inputRow;
    }

    protected function getPayloadForTable(string $tableName): array
    {
        if (!is_array($GLOBALS['TCA'][$tableName])) {
            throw new \RuntimeException(
                'Globals TCA of given table name must exist',
                1485386982
            );
        }
        $tableDefinition = $GLOBALS['TCA'][$tableName];

        if (
            empty($tableDefinition['columns'])
            || !is_array($tableDefinition['columns'])
        ) {
            return [];
        }

        $fields = [];
        $fileReferenceField = null;
        foreach ($tableDefinition['columns'] as $fieldName => $fieldConfiguration) {
            if (
                !empty($fieldConfiguration['config']['type'])
                && $fieldConfiguration['config']['type'] === 'group'
                && !empty($fieldConfiguration['config']['internal_type'])
                && $fieldConfiguration['config']['internal_type'] === 'db'
                && !empty($fieldConfiguration['config']['allowed'])
                && $fieldConfiguration['config']['allowed'] === 'sys_file'
            ) {
                $fileReferenceField = $fieldName;
            }
            if (
                !empty($fieldConfiguration['config']['type'])
                && $fieldConfiguration['config']['type'] === 'imageManipulation'
            ) {
                $fields[] = $fieldName;
            }
        }

        if (empty($fields)) {
            return [];
        }

        $payload = [];
        $connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);

        foreach ($fields as $fieldName) {
            $queryBuilder = $connectionPool->getQueryBuilderForTable($tableName);
            $queryBuilder->getRestrictions()->removeAll();

            $query = $queryBuilder
                ->from($tableName)
                ->count($fieldName)
                ->where(
                    $queryBuilder->expr()->like(
                        $fieldName,
                        $queryBuilder->createNamedParameter('{"x":%', \PDO::PARAM_STR)
                    )
                );
            if ((int)$query->execute()->fetchColumn(0) > 0) {
                $payload['fields'][] = $fieldName;
                if (isset($fileReferenceField)) {
                    $payload['fileReferenceField'] = $fileReferenceField;
                } else {
                    $payload['fileReferenceField'] = null;
                }
            }
        }
        return $payload;
    }

    private function getFile(array $row, $fieldName)
    {
        $file = null;
        $fileUid = !empty($row[$fieldName]) ? $row[$fieldName] : null;
        if (is_array($fileUid) && isset($fileUid[0]['uid'])) {
            $fileUid = $fileUid[0]['uid'];
        }
        if (MathUtility::canBeInterpretedAsInteger($fileUid)) {
            try {
                $file = ResourceFactory::getInstance()->getFileObject((int)$fileUid);
            } catch (FileDoesNotExistException $e) {
            } catch (\InvalidArgumentException $e) {
            }
        }
        return $file;
    }
}