FileTableSplittingUpdate.php

Go to the documentation of this file.

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

class FileTableSplittingUpdate extends AbstractUpdate {

    protected $metaDataTable = 'sys_file_metadata';

    protected $title = 'Migrate file metadata from sys_file to an external metadata table';

    public function checkForUpdate(&$description) {
        $result = FALSE;

        $description = 'In TYPO3 CMS 6.2 LTS the metadata has been split off to an external table. This wizard will migrate the data. If you have extended the sys_file table manually your custom data will be included, too, if you create TCA and columns in sys_file_metadata before running this wizard.';

        if (!array_key_exists($this->metaDataTable, $GLOBALS['TYPO3_DB']->admin_get_tables())) {
            $result = TRUE;
        } else {
            $fields = $GLOBALS['TYPO3_DB']->admin_get_fields('sys_file');
            // Check if the field exists on sys_file if not there is no data to migrate (TYPO3 < 6.0 or >= 6.2)
            if (isset($fields['width']) && isset($fields['height'])) {
                // Check if the 1:1 integrity is ok, if not we need to migrate the metadata.
                $sysFileCount = $GLOBALS['TYPO3_DB']->exec_SELECTcountRows('uid', 'sys_file');
                $sysFileMetaDataCount = $GLOBALS['TYPO3_DB']->exec_SELECTcountRows('uid', $this->metaDataTable);
                $result = $sysFileCount > $sysFileMetaDataCount;
            }
        }

        return $result;
    }

    public function performUpdate(array &$dbQueries, &$customMessages) {

        if (!array_key_exists($this->metaDataTable, $GLOBALS['TYPO3_DB']->admin_get_tables())) {
            $customMessages = 'ERROR! Make sure you already created the table. If you added custom metadata to sys_file table add TCA ' .
                'configuration as well as SQL definitions to sys_file_metadata, too.';
            return FALSE;
        }

        $fieldsToMigrate = $this->detectFieldsToMigrate();
        if (empty($fieldsToMigrate)) {
            return TRUE;
        }
        $fieldsToWrite = $fieldsToMigrate;
        $fieldsToWrite[] = 'file';
        $fieldsToSelect = $fieldsToMigrate;
        $fieldsToSelect[] = 'uid AS file';

        $resultObject = $GLOBALS['TYPO3_DB']->sql_query(
                'INSERT INTO ' . $this->metaDataTable . ' (' . implode(',', $fieldsToWrite) . ')' .
                ' SELECT ' . implode(',', $fieldsToSelect) .
                ' FROM sys_file' .
                ' WHERE uid NOT IN (SELECT file FROM ' . $this->metaDataTable . ')');

        return $resultObject !== FALSE;
    }

    protected function detectFieldsToMigrate() {
        $fieldsBlackListed = array('uid', 'deleted', 'sys_language_uid');
        $fieldsInSysFile = array_keys($GLOBALS['TYPO3_DB']->admin_get_fields('sys_file'));
        $fieldsInSysFileMetaData = array_keys($GLOBALS['TYPO3_DB']->admin_get_fields($this->metaDataTable));

        $commonFields = array_intersect($fieldsInSysFileMetaData, $fieldsInSysFile);
        $commonFields = array_diff($commonFields, $fieldsBlackListed);

        return $commonFields;

    }
}