RteMagicImagesUpdateWizard.php

Go to the documentation of this file.

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

class RteMagicImagesUpdateWizard extends AbstractUpdate {

    protected $title = 'Migrate all RTE magic images from uploads/RTEmagicC_* to fileadmin/_migrated/RTE/';

    protected $db;

    protected $storage;

    protected $oldPrefix = NULL;

    protected $logger;

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

        // Set it to uploads/RTEmagicC_*
        if (!empty($GLOBALS['TYPO3_CONF_VARS']['BE']['RTE_imageStorageDir'])) {
            $this->oldPrefix = $GLOBALS['TYPO3_CONF_VARS']['BE']['RTE_imageStorageDir'] . 'RTEmagicC_';
        }
    }

    public function init() {
        $storageRepository = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Resource\\StorageRepository');
        $storages = $storageRepository->findAll();
        $this->storage = $storages[0];
    }

    public function checkForUpdate(&$description) {
        $description = 'This update wizard goes through all magic images, located in "' . htmlspecialchars($this->oldPrefix) . '", and moves the files to fileadmin/_migrated/RTE/.';
        $description .= '<br />It also moves the files from uploads/ to the fileadmin/_migrated/ path.';
        // Issue warning about sys_refindex needing to be up to date
        $message = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(
            'TYPO3\\CMS\\Core\\Messaging\\FlashMessage',
            'This script bases itself on the references contained in the general reference index (sys_refindex). It is strongly advised to update it before running this wizard.',
            'Updating the reference index',
            \TYPO3\CMS\Core\Messaging\FlashMessage::WARNING
        );
        $description .= $message->render();

        // Wizard is only available if oldPrefix set
        if ($this->oldPrefix) {
            $oldRecords = $this->findMagicImagesInOldLocation();
            if (count($oldRecords) > 0) {
                $description .= '<br />There are currently <strong>' . count($oldRecords) . '</strong> magic images in the old directory.<br />';
                return TRUE;
            }
        }

        // Disable the update wizard if there are no old RTE magic images
        return FALSE;
    }

    public function performUpdate(array &$dbQueries, &$customMessages) {
        $this->init();

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

        $fileadminDirectory = rtrim($GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'], '/');
        $targetDirectory = '/_migrated/RTE/';
        $fullTargetDirectory = PATH_site . $fileadminDirectory . $targetDirectory;

        // Create the directory, if necessary
        if (!is_dir($fullTargetDirectory)) {
            \TYPO3\CMS\Core\Utility\GeneralUtility::mkdir_deep($fullTargetDirectory);
        }


        $oldRecords = $this->findMagicImagesInOldLocation();
        foreach ($oldRecords as $refRecord) {

            // Is usually uploads/RTE_magicC_123423324.png.png
            $sourceFileName     = $refRecord['ref_string'];
            // Absolute path/filename
            $fullSourceFileName = PATH_site . $refRecord['ref_string'];
            $targetFileName     = $targetDirectory . \TYPO3\CMS\Core\Utility\PathUtility::basename($refRecord['ref_string']);
            // Full directory
            $fullTargetFileName = $fullTargetDirectory . \TYPO3\CMS\Core\Utility\PathUtility::basename($refRecord['ref_string']);

            // maybe the file has been moved previously
            if (!file_exists($fullTargetFileName)) {
                // 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.
                if (!file_exists(PATH_site . $sourceFileName)) {
                    $this->logger->notice('File ' . $sourceFileName . ' does not exist. Reference was not migrated.', array());

                    $format = 'File \'%s\' does not exist. Referencing field: %s.%d.%s. The reference was not migrated.';
                    $message = sprintf($format, $sourceFileName, $refRecord['tablename'], $refRecord['recuid'], $refRecord['field']);
                    $customMessages .= PHP_EOL . $message;

                    continue;
                }

                rename($fullSourceFileName, $fullTargetFileName);
            }

            // Get the File object
            $file = $this->storage->getFile($targetFileName);
            if ($file instanceof \TYPO3\CMS\Core\Resource\File) {
                // And now update the referencing field
                $targetFieldName = $refRecord['field'];
                $targetRecord = $this->db->exec_SELECTgetSingleRow(
                    'uid, ' . $targetFieldName,
                    $refRecord['tablename'],
                    'uid=' . (int)$refRecord['recuid']
                );
                if ($targetRecord) {
                    // Replace the old filename with the new one, and add data-* attributes used by the RTE
                    $searchString = 'src="' . $sourceFileName . '"';
                    $replacementString = 'src="' . $fileadminDirectory . $targetFileName . '"';
                    $replacementString .= ' data-htmlarea-file-uid="' . $file->getUid() . '"';
                    $replacementString .= ' data-htmlarea-file-table="sys_file"';
                    $targetRecord[$targetFieldName] = str_replace(
                        $searchString,
                        $replacementString,
                        $targetRecord[$targetFieldName]
                    );
                    // Update the record
                    $this->db->exec_UPDATEquery(
                        $refRecord['tablename'],
                        'uid=' . (int)$refRecord['recuid'],
                        array($targetFieldName => $targetRecord[$targetFieldName])
                    );
                    $queries[] = str_replace(LF, ' ', $this->db->debug_lastBuiltQuery);

                    // Finally, update the sys_refindex table as well
                    $this->db->exec_UPDATEquery(
                        'sys_refindex',
                        'hash=' . $this->db->fullQuoteStr($refRecord['hash'], 'sys_refindex'),
                        array(
                            'ref_table'  => 'sys_file',
                            'softref_key' => 'rtehtmlarea_images',
                            'ref_uid'    => $file->getUid(),
                            'ref_string' => $fileadminDirectory . $targetFileName
                        )
                    );
                    $queries[] = str_replace(LF, ' ', $this->db->debug_lastBuiltQuery);
                }

            }
        }

        return TRUE;
    }

    protected function findMagicImagesInOldLocation() {
        $records = $this->db->exec_SELECTgetRows(
            'hash, tablename, recuid, field, ref_table, ref_uid, ref_string',
            'sys_refindex',
            'ref_string LIKE ' . $this->db->fullQuoteStr($this->db->escapeStrForLike($this->oldPrefix, 'sys_refindex') . '%', 'sys_refindex'),
            '',
            'ref_string ASC'
        );
        return $records;
    }

}