SqlReader.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);
namespace ‪TYPO3\CMS\Core\Database\Schema;
 
/*
 * 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\Core\Package\PackageManager;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\SignalSlot\Dispatcher;
 
class ‪SqlReader
{
    protected ‪$signalSlotDispatcher;
 
    protected ‪$packageManager;
 
    public function ‪__construct(‪Dispatcher ‪$signalSlotDispatcher = null, PackageManager ‪$packageManager = null)
    {
        $this->signalSlotDispatcher = ‪$signalSlotDispatcher ?: GeneralUtility::makeInstance(Dispatcher::class);
        $this->packageManager = ‪$packageManager ?? GeneralUtility::makeInstance(PackageManager::class);
    }
 
    public function ‪getTablesDefinitionString(bool $withStatic = false): string
    {
        $sqlString = [];
 
        // Find all ext_tables.sql of loaded extensions
        foreach ($this->packageManager->getActivePackages() as $package) {
            $packagePath = $package->getPackagePath();
            if (@file_exists($packagePath . 'ext_tables.sql')) {
                $sqlString[] = file_get_contents($packagePath . 'ext_tables.sql');
            }
            if ($withStatic && @file_exists($packagePath . 'ext_tables_static+adt.sql')) {
                $sqlString[] = file_get_contents($packagePath . 'ext_tables_static+adt.sql');
            }
        }
 
        $sqlString = $this->‪emitTablesDefinitionIsBeingBuiltSignal($sqlString);
 
        return implode(LF . LF, $sqlString);
    }
 
    public function ‪getStatementArray(string $dumpContent, string $queryRegex = null): array
    {
        $statementArray = [];
        $statementArrayPointer = 0;
        $isInMultilineComment = false;
        foreach (explode(LF, $dumpContent) as $lineContent) {
            $lineContent = trim($lineContent);
 
            // Skip empty lines and comments
            if ($lineContent === '' || $lineContent[0] === '#' || strpos($lineContent, '--') === 0 ||
                strpos($lineContent, '/*') === 0 || substr($lineContent, -2) === '*/' || $isInMultilineComment
            ) {
                // skip c style multiline comments
                if (strpos($lineContent, '/*') === 0 && substr($lineContent, -2) !== '*/') {
                    $isInMultilineComment = true;
                }
                if (substr($lineContent, -2) === '*/') {
                    $isInMultilineComment = false;
                }
                continue;
            }
 
            $statementArray[$statementArrayPointer] = ($statementArray[$statementArrayPointer] ?? '') . $lineContent;
 
            if (substr($lineContent, -1) === ';') {
                $statement = trim($statementArray[$statementArrayPointer]);
                if (!$statement || ($queryRegex && !preg_match('/' . $queryRegex . '/i', $statement))) {
                    unset($statementArray[$statementArrayPointer]);
                }
                $statementArrayPointer++;
            } else {
                $statementArray[$statementArrayPointer] .= ' ';
            }
        }
 
        return $statementArray;
    }
 
    public function ‪getInsertStatementArray(string $dumpContent): array
    {
        return $this->‪getStatementArray($dumpContent, '^INSERT');
    }
 
    public function ‪getCreateTableStatementArray(string $dumpContent): array
    {
        return $this->‪getStatementArray($dumpContent, '^CREATE TABLE');
    }
 
    protected function ‪emitTablesDefinitionIsBeingBuiltSignal(array $sqlString): array
    {
        // Using the old class name from the install tool here to keep backwards compatibility.
        $signalReturn = $this->signalSlotDispatcher->dispatch(
            'TYPO3\\CMS\\Install\\Service\\SqlExpectedSchemaService',
            'tablesDefinitionIsBeingBuilt',
            [$sqlString]
        );
 
        // This is important to support old associated returns
        $signalReturn = array_values($signalReturn);
        $sqlString = $signalReturn[0];
        if (!is_array($sqlString)) {
            throw new ‪Exception\UnexpectedSignalReturnValueTypeException(
                sprintf(
                    'The signal %s of class %s returned a value of type %s, but array was expected.',
                    'tablesDefinitionIsBeingBuilt',
                    __CLASS__,
                    gettype($sqlString)
                ),
                1382351456
            );
        }
 
        return $sqlString;
    }
}