TceformsUpdateWizard.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Install\Updates;

use TYPO3\CMS\Core\Database\DatabaseConnection;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Domain\Model\File;

class TceformsUpdateWizard extends AbstractUpdate {

    const RECORDS_PER_QUERY = 1000;

    protected $title = 'Migrate all file relations from tt_content.image and pages.media';

    protected $storage;

    protected $logger;

    protected $database;

    protected $tables = array(
        'tt_content' => array(
            'image' => array(
                'sourcePath' => 'uploads/pics/',
                // Relative to fileadmin
                'targetPath' => '_migrated/pics/',
                'titleTexts' => 'titleText',
                'captions' => 'imagecaption',
                'links' => 'image_link',
                'alternativeTexts' => 'altText'
            )
        ),
        'pages' => array(
            'media' => array(
                'sourcePath' => 'uploads/media/',
                // Relative to fileadmin
                'targetPath' => '_migrated/media/'
            )
        ),
        'pages_language_overlay' => array(
            'media' => array(
                'sourcePath' => 'uploads/media/',
                // Relative to fileadmin
                'targetPath' => '_migrated/media/'
            )
        )
    );

    protected $registry;

    protected $registryNamespace = 'TceformsUpdateWizard';

    protected $recordOffset = array();

    public function __construct() {
        $logManager = GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Log\\LogManager');
        $this->logger = $logManager->getLogger(__CLASS__);
        $this->database = $GLOBALS['TYPO3_DB'];
    }

    public function init() {
        $storageRepository = GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Resource\\StorageRepository');
        $storages = $storageRepository->findAll();
        $this->storage = $storages[0];
        $this->registry = GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Registry');
        $this->recordOffset = $this->registry->get($this->registryNamespace, 'recordOffset', array());
    }

    public function checkForUpdate(&$description) {
        $description = 'This update wizard goes through all files that are referenced in the tt_content.image and '
            . 'pages.media / pages_language_overlay.media field and adds the files to the new File Index.<br />'
            . 'It also moves the files from uploads/ to the fileadmin/_migrated/ path.<br /><br />'
            . 'This update wizard can be called multiple times in case it didn\'t finish after running once.';

        if ($this->versionNumber < 6000000) {
            // Nothing to do
            return FALSE;
        }

        $finishedFields = $this->getFinishedFields();
        if (count($finishedFields) === 0) {
            // Nothing done yet, so there's plenty of work left
            return TRUE;
        }

        $numberOfFieldsToMigrate = 0;
        foreach ($this->tables as $table => $tableConfiguration) {
            // find all additional fields we should get from the database
            foreach (array_keys($tableConfiguration) as $fieldToMigrate) {
                $fieldKey = $table . ':' . $fieldToMigrate;
                if (!in_array($fieldKey, $finishedFields)) {
                    $numberOfFieldsToMigrate++;
                }
            }
        }
        return $numberOfFieldsToMigrate > 0;
    }

    public function performUpdate(array &$dbQueries, &$customMessages) {
        if ($this->versionNumber < 6000000) {
            // Nothing to do
            return TRUE;
        }
        try {
            $this->init();
            $finishedFields = $this->getFinishedFields();
            foreach ($this->tables as $table => $tableConfiguration) {
                // find all additional fields we should get from the database
                foreach ($tableConfiguration as $fieldToMigrate => $fieldConfiguration) {
                    $fieldKey = $table . ':' . $fieldToMigrate;
                    if (in_array($fieldKey, $finishedFields)) {
                        // this field was already migrated
                        continue;
                    }
                    $fieldsToGet = array($fieldToMigrate);
                    if (isset($fieldConfiguration['titleTexts'])) {
                        $fieldsToGet[] = $fieldConfiguration['titleTexts'];
                    }
                    if (isset($fieldConfiguration['alternativeTexts'])) {
                        $fieldsToGet[] = $fieldConfiguration['alternativeTexts'];
                    }
                    if (isset($fieldConfiguration['captions'])) {
                        $fieldsToGet[] = $fieldConfiguration['captions'];
                    }
                    if (isset($fieldConfiguration['links'])) {
                        $fieldsToGet[] = $fieldConfiguration['links'];
                    }

                    if (!isset($this->recordOffset[$table])) {
                        $this->recordOffset[$table] = 0;
                    }

                    do {
                        $limit = $this->recordOffset[$table] . ',' . self::RECORDS_PER_QUERY;
                        $records = $this->getRecordsFromTable($table, $fieldToMigrate, $fieldsToGet, $limit);
                        foreach ($records as $record) {
                            $this->migrateField($table, $record, $fieldToMigrate, $fieldConfiguration, $customMessages);
                        }
                        $this->registry->set($this->registryNamespace, 'recordOffset', $this->recordOffset);
                    } while (count($records) === self::RECORDS_PER_QUERY);

                    // add the field to the "finished fields" if things didn't fail above
                    if (is_array($records)) {
                        $finishedFields[] = $fieldKey;
                    }
                }
            }
            $this->markWizardAsDone(implode(',', $finishedFields));
            $this->registry->remove($this->registryNamespace, 'recordOffset');
        } catch (\Exception $e) {
            $customMessages .= PHP_EOL . $e->getMessage();
        }
        return empty($customMessages);
    }

    protected function getFinishedFields() {
        $className = 'TYPO3\\CMS\\Install\\Updates\\TceformsUpdateWizard';
        return isset($GLOBALS['TYPO3_CONF_VARS']['INSTALL']['wizardDone'][$className])
            ? explode(',', $GLOBALS['TYPO3_CONF_VARS']['INSTALL']['wizardDone'][$className])
            : array();
    }

    protected function getRecordsFromTable($table, $fieldToMigrate, $relationFields, $limit) {
        $fields = implode(',', array_merge($relationFields, array('uid', 'pid')));
        $deletedCheck = isset($GLOBALS['TCA'][$table]['ctrl']['delete'])
            ? ' AND ' . $GLOBALS['TCA'][$table]['ctrl']['delete'] . '=0'
            : '';
        $where = $fieldToMigrate . ' IS NOT NULL'
            . ' AND ' . $fieldToMigrate . ' != \'\''
            . ' AND CAST(CAST(' . $fieldToMigrate . ' AS DECIMAL) AS CHAR) <> CAST(' . $fieldToMigrate . ' AS CHAR)'
            . $deletedCheck;
        $result = $this->database->exec_SELECTgetRows($fields, $table, $where, '', 'uid', $limit);
        if ($result === NULL) {
            throw new \RuntimeException('Database query failed. Error was: ' . $this->database->sql_error());
        }
        return $result;
    }

    protected function migrateField($table, $row, $fieldname, $fieldConfiguration, &$customMessages) {
        $titleTextContents = array();
        $alternativeTextContents = array();
        $captionContents = array();
        $linkContents = array();

        $fieldItems = GeneralUtility::trimExplode(',', $row[$fieldname], TRUE);
        if (empty($fieldItems) || is_numeric($row[$fieldname])) {
            return array();
        }
        if (isset($fieldConfiguration['titleTexts'])) {
            $titleTextField = $fieldConfiguration['titleTexts'];
            $titleTextContents = explode(LF, $row[$titleTextField]);
        }

        if (isset($fieldConfiguration['alternativeTexts'])) {
            $alternativeTextField = $fieldConfiguration['alternativeTexts'];
            $alternativeTextContents = explode(LF, $row[$alternativeTextField]);
        }
        if (isset($fieldConfiguration['captions'])) {
            $captionField = $fieldConfiguration['captions'];
            $captionContents = explode(LF, $row[$captionField]);
        }
        if (isset($fieldConfiguration['links'])) {
            $linkField = $fieldConfiguration['links'];
            $linkContents = explode(LF, $row[$linkField]);
        }
        $fileadminDirectory = rtrim($GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'], '/') . '/';
        $queries = array();
        $i = 0;

        if (!PATH_site) {
            throw new \Exception('PATH_site was undefined.');
        }

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

        foreach ($fieldItems as $item) {
            $fileUid = NULL;
            $sourcePath = PATH_site . $fieldConfiguration['sourcePath'] . $item;
            $targetDirectory = PATH_site . $fileadminDirectory . $fieldConfiguration['targetPath'];
            $targetPath = $targetDirectory . basename($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);

                $existingFileRecord = $this->database->exec_SELECTgetSingleRow(
                    'uid',
                    'sys_file',
                    'sha1=' . $this->database->fullQuoteStr($fileSha1, 'sys_file') . ' AND storage=' . $storageUid
                );
                // 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($fieldConfiguration['targetPath'] . $item);
                    $fileUid = $file->getUid();

                } catch (\InvalidArgumentException $e) {

                    // no file found, no reference can be set
                    $this->logger->notice(
                        'File ' . $fieldConfiguration['sourcePath'] . $item . ' does not exist. Reference was not migrated.',
                        array('table' => $table, 'record' => $row, 'field' => $fieldname)
                    );

                    $format = 'File \'%s\' does not exist. Referencing field: %s.%d.%s. The reference was not migrated.';
                    $message = sprintf($format, $fieldConfiguration['sourcePath'] . $item, $table, $row['uid'], $fieldname);
                    $customMessages .= PHP_EOL . $message;

                    continue;
                }
            }

            if ($fileUid > 0) {
                $fields = array(
                    // TODO add sorting/sorting_foreign
                    'fieldname' => $fieldname,
                    'table_local' => 'sys_file',
                    // the sys_file_reference record should always placed on the same page
                    // as the record to link to, see issue #46497
                    'pid' => ($table === 'pages' ? $row['uid'] : $row['pid']),
                    'uid_foreign' => $row['uid'],
                    'uid_local' => $fileUid,
                    'tablenames' => $table,
                    'crdate' => time(),
                    'tstamp' => time(),
                    'sorting' => ($i + 256),
                    'sorting_foreign' => $i,
                );
                if (isset($titleTextField)) {
                    $fields['title'] = trim($titleTextContents[$i]);
                }
                if (isset($alternativeTextField)) {
                    $fields['alternative'] = trim($alternativeTextContents[$i]);
                }
                if (isset($captionField)) {
                    $fields['description'] = trim($captionContents[$i]);
                }
                if (isset($linkField)) {
                    $fields['link'] = trim($linkContents[$i]);
                }
                $this->database->exec_INSERTquery('sys_file_reference', $fields);
                $queries[] = str_replace(LF, ' ', $this->database->debug_lastBuiltQuery);
                ++$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)) {
            $this->database->exec_UPDATEquery($table, 'uid=' . $row['uid'], array($fieldname => $i));
            $queries[] = str_replace(LF, ' ', $this->database->debug_lastBuiltQuery);
        } else {
            $this->recordOffset[$table]++;
        }
        return $queries;
    }
}