DatabaseIntegrityCheck.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Integrity;

/*
 * 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\Backend\Utility\BackendUtility;

class DatabaseIntegrityCheck
{
    public $genTree_includeDeleted = true;

    public $genTree_includeVersions = true;

    public $genTree_includeRecords = false;

    public $perms_clause = '';

    public $page_idArray = [];

    public $rec_idArray = [];

    public $checkFileRefs = [];

    public $checkSelectDBRefs = [];

    public $checkGroupDBRefs = [];

    public $recStats = [
        'allValid' => [],
        'published_versions' => [],
        'deleted' => []
    ];

    public $lRecords = [];

    public $lostPagesList = '';

    public function genTree($theID, $depthData = '', $versions = false)
    {
        if ($versions) {
            $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid,title,doktype,deleted,t3ver_wsid,t3ver_id,t3ver_count,hidden', 'pages', 'pid=-1 AND t3ver_oid=' . (int)$theID . ' ' . (!$this->genTree_includeDeleted ? 'AND deleted=0' : '') . $this->perms_clause, '', 'sorting');
        } else {
            $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid,title,doktype,deleted,hidden', 'pages', 'pid=' . (int)$theID . ' ' . (!$this->genTree_includeDeleted ? 'AND deleted=0' : '') . $this->perms_clause, '', 'sorting');
        }
        // Traverse the records selected:
        $a = 0;
        while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
            $a++;
            $newID = $row['uid'];
            // Register various data for this item:
            $this->page_idArray[$newID] = $row;
            $this->recStats['all_valid']['pages'][$newID] = $newID;
            if ($row['deleted']) {
                $this->recStats['deleted']['pages'][$newID] = $newID;
            }
            if ($versions && $row['t3ver_count'] >= 1) {
                $this->recStats['published_versions']['pages'][$newID] = $newID;
            }
            if ($row['deleted']) {
                $this->recStats['deleted']++;
            }
            if ($row['hidden']) {
                $this->recStats['hidden']++;
            }
            $this->recStats['doktype'][$row['doktype']]++;
            // If all records should be shown, do so:
            if ($this->genTree_includeRecords) {
                foreach ($GLOBALS['TCA'] as $tableName => $cfg) {
                    if ($tableName != 'pages') {
                        $this->genTree_records($newID, '', $tableName);
                    }
                }
            }
            // Add sub pages:
            $this->genTree($newID);
            // If versions are included in the tree, add those now:
            if ($this->genTree_includeVersions) {
                $this->genTree($newID, '', true);
            }
        }
        $GLOBALS['TYPO3_DB']->sql_free_result($res);
    }

    public function genTree_records($theID, $_ = '', $table = '', $versions = false)
    {
        if ($versions) {
            // Select all records from table pointing to this page:
            $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
                BackendUtility::getCommonSelectFields($table),
                $table,
                'pid=-1 AND t3ver_oid=' . (int)$theID . (!$this->genTree_includeDeleted ? BackendUtility::deleteClause($table) : '')
            );
        } else {
            // Select all records from table pointing to this page:
            $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
                BackendUtility::getCommonSelectFields($table),
                $table,
                'pid=' . (int)$theID . (!$this->genTree_includeDeleted ? BackendUtility::deleteClause($table) : '')
            );
        }
        // Traverse selected:
        $a = 0;
        while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
            $a++;
            $newID = $row['uid'];
            // Register various data for this item:
            $this->rec_idArray[$table][$newID] = $row;
            $this->recStats['all_valid'][$table][$newID] = $newID;
            if ($row['deleted']) {
                $this->recStats['deleted'][$table][$newID] = $newID;
            }
            if ($versions && $row['t3ver_count'] >= 1 && $row['t3ver_wsid'] == 0) {
                $this->recStats['published_versions'][$table][$newID] = $newID;
            }
            // Select all versions of this record:
            if ($this->genTree_includeVersions && $GLOBALS['TCA'][$table]['ctrl']['versioningWS']) {
                $this->genTree_records($newID, '', $table, true);
            }
        }
        $GLOBALS['TYPO3_DB']->sql_free_result($res);
    }

    public function lostRecords($pid_list)
    {
        $this->lostPagesList = '';
        if ($pid_list) {
            foreach ($GLOBALS['TCA'] as $table => $tableConf) {
                $pid_list_tmp = $pid_list;
                if (!isset($GLOBALS['TCA'][$table]['ctrl']['versioningWS']) || !$GLOBALS['TCA'][$table]['ctrl']['versioningWS']) {
                    // Remove preceding "-1," for non-versioned tables
                    $pid_list_tmp = preg_replace('/^\\-1,/', '', $pid_list_tmp);
                }
                $garbage = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid,pid,' . $GLOBALS['TCA'][$table]['ctrl']['label'], $table, 'pid NOT IN (' . $pid_list_tmp . ')');
                $lostIdList = [];
                while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($garbage)) {
                    $this->lRecords[$table][$row['uid']] = [
                        'uid' => $row['uid'],
                        'pid' => $row['pid'],
                        'title' => strip_tags(BackendUtility::getRecordTitle($table, $row))
                    ];
                    $lostIdList[] = $row['uid'];
                }
                $GLOBALS['TYPO3_DB']->sql_free_result($garbage);
                if ($table == 'pages') {
                    $this->lostPagesList = implode(',', $lostIdList);
                }
            }
        }
    }

    public function fixLostRecord($table, $uid)
    {
        if ($table && $GLOBALS['TCA'][$table] && $uid && is_array($this->lRecords[$table][$uid]) && $GLOBALS['BE_USER']->user['admin']) {
            $updateFields = [];
            $updateFields['pid'] = 0;
            // If possible a lost record restored is hidden as default
            if ($GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['disabled']) {
                $updateFields[$GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['disabled']] = 1;
            }
            $GLOBALS['TYPO3_DB']->exec_UPDATEquery($table, 'uid=' . (int)$uid, $updateFields);
            return true;
        } else {
            return false;
        }
    }

    public function countRecords($pid_list)
    {
        $list = [];
        $list_n = [];
        if ($pid_list) {
            foreach ($GLOBALS['TCA'] as $table => $tableConf) {
                $pid_list_tmp = $pid_list;
                if (!isset($GLOBALS['TCA'][$table]['ctrl']['versioningWS']) || !$GLOBALS['TCA'][$table]['ctrl']['versioningWS']) {
                    // Remove preceding "-1," for non-versioned tables
                    $pid_list_tmp = preg_replace('/^\\-1,/', '', $pid_list_tmp);
                }
                $count = $GLOBALS['TYPO3_DB']->exec_SELECTcountRows('uid', $table, 'pid IN (' . $pid_list_tmp . ')');
                if ($count) {
                    $list[$table] = $count;
                }
                $count = $GLOBALS['TYPO3_DB']->exec_SELECTcountRows('uid', $table, 'pid IN (' . $pid_list_tmp . ')' . BackendUtility::deleteClause($table));
                if ($count) {
                    $list_n[$table] = $count;
                }
            }
        }
        return ['all' => $list, 'non_deleted' => $list_n];
    }

    public function getGroupFields($mode)
    {
        $result = [];
        foreach ($GLOBALS['TCA'] as $table => $tableConf) {
            $cols = $GLOBALS['TCA'][$table]['columns'];
            foreach ($cols as $field => $config) {
                if ($config['config']['type'] == 'group') {
                    if ((!$mode || $mode == 'file') && $config['config']['internal_type'] == 'file' || (!$mode || $mode == 'db') && $config['config']['internal_type'] == 'db') {
                        $result[$table][] = $field;
                    }
                }
                if ((!$mode || $mode == 'db') && $config['config']['type'] == 'select' && $config['config']['foreign_table']) {
                    $result[$table][] = $field;
                }
            }
            if ($result[$table]) {
                $result[$table] = implode(',', $result[$table]);
            }
        }
        return $result;
    }

    public function getFileFields($uploadfolder)
    {
        $result = [];
        foreach ($GLOBALS['TCA'] as $table => $tableConf) {
            $cols = $GLOBALS['TCA'][$table]['columns'];
            foreach ($cols as $field => $config) {
                if ($config['config']['type'] == 'group' && $config['config']['internal_type'] == 'file' && $config['config']['uploadfolder'] == $uploadfolder) {
                    $result[] = [$table, $field];
                }
            }
        }
        return $result;
    }

    public function getDBFields($theSearchTable)
    {
        $result = [];
        foreach ($GLOBALS['TCA'] as $table => $tableConf) {
            $cols = $GLOBALS['TCA'][$table]['columns'];
            foreach ($cols as $field => $config) {
                if ($config['config']['type'] == 'group' && $config['config']['internal_type'] == 'db') {
                    if (trim($config['config']['allowed']) == '*' || strstr($config['config']['allowed'], $theSearchTable)) {
                        $result[] = [$table, $field];
                    }
                } elseif ($config['config']['type'] == 'select' && $config['config']['foreign_table'] == $theSearchTable) {
                    $result[] = [$table, $field];
                }
            }
        }
        return $result;
    }

    public function selectNonEmptyRecordsWithFkeys($fkey_arrays)
    {
        if (is_array($fkey_arrays)) {
            foreach ($fkey_arrays as $table => $field_list) {
                if ($GLOBALS['TCA'][$table] && trim($field_list)) {
                    $fieldArr = explode(',', $field_list);
                    if (\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::isLoaded('dbal')) {
                        $fields = $GLOBALS['TYPO3_DB']->admin_get_fields($table);
                        $field = array_shift($fieldArr);
                        $cl_fl = $GLOBALS['TYPO3_DB']->MetaType($fields[$field]['type'], $table) == 'I' || $GLOBALS['TYPO3_DB']->MetaType($fields[$field]['type'], $table) == 'N' || $GLOBALS['TYPO3_DB']->MetaType($fields[$field]['type'], $table) == 'R' ? $field . '<>0' : $field . '<>\'\'';
                        foreach ($fieldArr as $field) {
                            $cl_fl .= $GLOBALS['TYPO3_DB']->MetaType($fields[$field]['type'], $table) == 'I' || $GLOBALS['TYPO3_DB']->MetaType($fields[$field]['type'], $table) == 'N' || $GLOBALS['TYPO3_DB']->MetaType($fields[$field]['type'], $table) == 'R' ? ' OR ' . $field . '<>0' : ' OR ' . $field . '<>\'\'';
                        }
                        unset($fields);
                    } else {
                        $cl_fl = implode('<>\'\' OR ', $fieldArr) . '<>\'\'';
                    }
                    $mres = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid,' . $field_list, $table, $cl_fl);
                    while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($mres)) {
                        foreach ($fieldArr as $field) {
                            if (trim($row[$field])) {
                                $fieldConf = $GLOBALS['TCA'][$table]['columns'][$field]['config'];
                                if ($fieldConf['type'] == 'group') {
                                    if ($fieldConf['internal_type'] == 'file') {
                                        // Files...
                                        if ($fieldConf['MM']) {
                                            $tempArr = [];
                                            $dbAnalysis = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Core\Database\RelationHandler::class);
                                            $dbAnalysis->start('', 'files', $fieldConf['MM'], $row['uid']);
                                            foreach ($dbAnalysis->itemArray as $somekey => $someval) {
                                                if ($someval['id']) {
                                                    $tempArr[] = $someval['id'];
                                                }
                                            }
                                        } else {
                                            $tempArr = explode(',', trim($row[$field]));
                                        }
                                        foreach ($tempArr as $file) {
                                            $file = trim($file);
                                            if ($file) {
                                                $this->checkFileRefs[$fieldConf['uploadfolder']][$file] += 1;
                                            }
                                        }
                                    }
                                    if ($fieldConf['internal_type'] == 'db') {
                                        $dbAnalysis = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Core\Database\RelationHandler::class);
                                        $dbAnalysis->start($row[$field], $fieldConf['allowed'], $fieldConf['MM'], $row['uid'], $table, $fieldConf);
                                        foreach ($dbAnalysis->itemArray as $tempArr) {
                                            $this->checkGroupDBRefs[$tempArr['table']][$tempArr['id']] += 1;
                                        }
                                    }
                                }
                                if ($fieldConf['type'] == 'select' && $fieldConf['foreign_table']) {
                                    $dbAnalysis = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Core\Database\RelationHandler::class);
                                    $dbAnalysis->start($row[$field], $fieldConf['foreign_table'], $fieldConf['MM'], $row['uid'], $table, $fieldConf);
                                    foreach ($dbAnalysis->itemArray as $tempArr) {
                                        if ($tempArr['id'] > 0) {
                                            $this->checkGroupDBRefs[$fieldConf['foreign_table']][$tempArr['id']] += 1;
                                        }
                                    }
                                }
                            }
                        }
                    }
                    $GLOBALS['TYPO3_DB']->sql_free_result($mres);
                }
            }
        }
    }

    public function testFileRefs()
    {
        $output = [];
        // Handle direct references with upload folder setting (workaround)
        $newCheckFileRefs = [];
        foreach ($this->checkFileRefs as $folder => $files) {
            // Only direct references without a folder setting
            if ($folder !== '') {
                $newCheckFileRefs[$folder] = $files;
                continue;
            }
            foreach ($files as $file => $references) {
                // Direct file references have often many references (removes occurrences in the moreReferences section of the result array)
                if ($references > 1) {
                    $references = 1;
                }
                // The directory must be empty (prevents checking of the root directory)
                $directory = dirname($file);
                if ($directory !== '') {
                    $newCheckFileRefs[$directory][basename($file)] = $references;
                }
            }
        }
        $this->checkFileRefs = $newCheckFileRefs;
        foreach ($this->checkFileRefs as $folder => $fileArr) {
            $path = PATH_site . $folder;
            if (@is_dir($path) && @is_readable($path)) {
                $d = dir($path);
                while ($entry = $d->read()) {
                    if (@is_file(($path . '/' . $entry))) {
                        if (isset($fileArr[$entry])) {
                            if ($fileArr[$entry] > 1) {
                                $temp = $this->whereIsFileReferenced($folder, $entry);
                                $tempList = '';
                                foreach ($temp as $inf) {
                                    $tempList .= '[' . $inf['table'] . '][' . $inf['uid'] . '][' . $inf['field'] . '] (pid:' . $inf['pid'] . ') - ';
                                }
                                $output['moreReferences'][] = [$path, $entry, $fileArr[$entry], $tempList];
                            }
                            unset($fileArr[$entry]);
                        } else {
                            // Contains workaround for direct references
                            if (!strstr($entry, 'index.htm') && !preg_match(('/^' . preg_quote($GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'], '/') . '/'), $folder)) {
                                $output['noReferences'][] = [$path, $entry];
                            }
                        }
                    }
                }
                $d->close();
                $tempCounter = 0;
                foreach ($fileArr as $file => $value) {
                    // Workaround for direct file references
                    if (preg_match('/^' . preg_quote($GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'], '/') . '/', $folder)) {
                        $file = $folder . '/' . $file;
                        $folder = '';
                        $path = substr(PATH_site, 0, -1);
                    }
                    $temp = $this->whereIsFileReferenced($folder, $file);
                    $tempList = '';
                    foreach ($temp as $inf) {
                        $tempList .= '[' . $inf['table'] . '][' . $inf['uid'] . '][' . $inf['field'] . '] (pid:' . $inf['pid'] . ') - ';
                    }
                    $tempCounter++;
                    $output['noFile'][substr($path, -3) . '_' . substr($file, 0, 3) . '_' . $tempCounter] = [$path, $file, $tempList];
                }
            } else {
                $output['error'][] = [$path];
            }
        }
        return $output;
    }

    public function testDBRefs($theArray)
    {
        $result = '';
        foreach ($theArray as $table => $dbArr) {
            if ($GLOBALS['TCA'][$table]) {
                $idlist = array_keys($dbArr);
                $theList = implode(',', $idlist);
                if ($theList) {
                    $mres = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid', $table, 'uid IN (' . $theList . ')' . BackendUtility::deleteClause($table));
                    while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($mres)) {
                        if (isset($dbArr[$row['uid']])) {
                            unset($dbArr[$row['uid']]);
                        } else {
                            $result .= 'Strange Error. ...<br />';
                        }
                    }
                    $GLOBALS['TYPO3_DB']->sql_free_result($mres);
                    foreach ($dbArr as $theId => $theC) {
                        $result .= 'There are ' . $theC . ' records pointing to this missing or deleted record; [' . $table . '][' . $theId . ']<br />';
                    }
                }
            } else {
                $result .= 'Codeerror. Table is not a table...<br />';
            }
        }
        return $result;
    }

    public function whereIsRecordReferenced($searchTable, $id)
    {
        // Gets tables / Fields that reference to files
        $fileFields = $this->getDBFields($searchTable);
        $theRecordList = [];
        foreach ($fileFields as $info) {
            $table = $info[0];
            $field = $info[1];
            $mres = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid,pid,' . $GLOBALS['TCA'][$table]['ctrl']['label'] . ',' . $field, $table, $field . ' LIKE \'%' . $GLOBALS['TYPO3_DB']->quoteStr($id, $table) . '%\'');
            while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($mres)) {
                // Now this is the field, where the reference COULD come from. But we're not garanteed, so we must carefully examine the data.
                $fieldConf = $GLOBALS['TCA'][$table]['columns'][$field]['config'];
                $allowedTables = $fieldConf['type'] == 'group' ? $fieldConf['allowed'] : $fieldConf['foreign_table'];
                $dbAnalysis = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Core\Database\RelationHandler::class);
                $dbAnalysis->start($row[$field], $allowedTables, $fieldConf['MM'], $row['uid'], $table, $fieldConf);
                foreach ($dbAnalysis->itemArray as $tempArr) {
                    if ($tempArr['table'] == $searchTable && $tempArr['id'] == $id) {
                        $theRecordList[] = ['table' => $table, 'uid' => $row['uid'], 'field' => $field, 'pid' => $row['pid']];
                    }
                }
            }
            $GLOBALS['TYPO3_DB']->sql_free_result($mres);
        }
        return $theRecordList;
    }

    public function whereIsFileReferenced($uploadfolder, $filename)
    {
        // Gets tables / Fields that reference to files
        $fileFields = $this->getFileFields($uploadfolder);
        $theRecordList = [];
        foreach ($fileFields as $info) {
            $table = $info[0];
            $field = $info[1];
            $mres = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid,pid,' . $GLOBALS['TCA'][$table]['ctrl']['label'] . ',' . $field, $table, $field . ' LIKE \'%' . $GLOBALS['TYPO3_DB']->quoteStr($filename, $table) . '%\'');
            while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($mres)) {
                // Now this is the field, where the reference COULD come from.
                // But we're not guaranteed, so we must carefully examine the data.
                $tempArr = explode(',', trim($row[$field]));
                foreach ($tempArr as $file) {
                    $file = trim($file);
                    if ($file == $filename) {
                        $theRecordList[] = ['table' => $table, 'uid' => $row['uid'], 'field' => $field, 'pid' => $row['pid']];
                    }
                }
            }
            $GLOBALS['TYPO3_DB']->sql_free_result($mres);
        }
        return $theRecordList;
    }
}