ReferenceIntegrityUpdateWizard.php

Go to the documentation of this file.

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

class ReferenceIntegrityUpdateWizard extends AbstractUpdate {

    protected $title = 'Ensures the database integrity for File Abstraction records';

    public function checkForUpdate(&$description) {
        $description = 'Checks if there are file references that are on the root level. ' .
            'This could have happened due to a misconfigured previous migration. ' .
            'This migration will also remove references to tables that no longer exist.';
        return count($this->getRequiredUpdates()) > 0;
    }

    public function performUpdate(array &$dbQueries, &$customMessages) {
        $updates = $this->getRequiredUpdates();
        if (isset($updates['referenceToMissingTables'])) {
            foreach ($updates['referenceToMissingTables'] as $missingTable) {
                $deleteQuery = $GLOBALS['TYPO3_DB']->DELETEquery(
                    'sys_file_reference',
                    'tablenames=' . $GLOBALS['TYPO3_DB']->fullQuoteStr($missingTable, 'sys_file_reference')
                );
                $GLOBALS['TYPO3_DB']->sql_query($deleteQuery);
                $dbQueries[] = $deleteQuery;
            }
        }
        if (isset($updates['improperConnectedFileReferences'])) {
            foreach ($updates['improperConnectedFileReferences'] as $fileReferenceRecord) {
                if ($fileReferenceRecord['newpid'] > 0) {
                    $updateQuery = $GLOBALS['TYPO3_DB']->UPDATEquery(
                        'sys_file_reference',
                        'uid=' . (int)$fileReferenceRecord['uid'],
                        array('pid' => $fileReferenceRecord['newpid'])
                    );
                    $GLOBALS['TYPO3_DB']->sql_query($updateQuery);
                    $dbQueries[] = $updateQuery;
                }
            }
        }
        return TRUE;
    }

    protected function getRequiredUpdates() {
        $requiredUpdates = array();
        $referenceToMissingTables = $this->getFileReferencesPointingToMissingTables();
        if (count($referenceToMissingTables) > 0) {
            $requiredUpdates['referenceToMissingTables'] = $referenceToMissingTables;
        }
        $improperConnectedFileReferences = $this->getImproperConnectedFileReferences($referenceToMissingTables);
        if (count($improperConnectedFileReferences) > 0) {
            $requiredUpdates['improperConnectedFileReferences'] = $improperConnectedFileReferences;
        }
        return $requiredUpdates;
    }

    protected function getFileReferencesPointingToMissingTables() {
        $existingTables = array_flip(array_keys($GLOBALS['TYPO3_DB']->admin_get_tables()));
        $missingTables = array();
        $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('DISTINCT tablenames', 'sys_file_reference', '');
        while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
            $thisTablename = $row['tablenames'];
            if (!isset($existingTables[$thisTablename])) {
                $missingTables[] = $thisTablename;
            }
        }
        return $missingTables;
    }

    protected function getFileReferencesOnRootlevel() {
        $fileReferences = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows(
            'uid, pid, uid_local AS fileuid, uid_foreign AS targetuid, tablenames AS targettable',
            'sys_file_reference',
            'pid=0 AND deleted=0'
        );
        if (!is_array($fileReferences)) {
            // An SQL error occurred, most likely because the sys_file_reference table is not there.
            // We ignore this here to avoid a warning when initially showing the upgrade wizard (see #65159).
            return array();
        }
        return $fileReferences;
    }

    protected function getImproperConnectedFileReferences(array $skipTables = array()) {
        $improperConnectedReferences = array();
        // fetch all references on root level
        $sysFileReferences = $this->getFileReferencesOnRootlevel();
        foreach ($sysFileReferences as $fileReferenceRecord) {
            $tableName = $fileReferenceRecord['targettable'];
            if (in_array($tableName, $skipTables)) {
                continue;
            }
            // if the target table is pages (e.g. when adding a file reference to the pages->media
            // record, then the
            $whereClause = 'uid=' . (int)$fileReferenceRecord['targetuid'];
            if ($fileReferenceRecord['targettable'] === 'pages') {
                $isPageReference = TRUE;
            } else {
                $isPageReference = FALSE;
                $whereClause .= ' AND pid<>0';
            }
            // check the target table, if the target record is NOT on the rootlevel
            $targetRecord = $GLOBALS['TYPO3_DB']->exec_SELECTgetSingleRow(
                'uid, pid',
                $tableName,
                $whereClause
            );
            // only add the file reference if the target record is not on PID=0
            if ($targetRecord !== NULL) {
                $fileReferenceRecord['newpid'] = ($isPageReference ? $targetRecord['uid'] : $targetRecord['pid']);
                $improperConnectedReferences[] = $fileReferenceRecord;
            }
        }
        return $improperConnectedReferences;
    }
}