/**
* Perform necessary database schema migrations
*
* @param SchemaUpdateType[] $schemaUpdateTypes List of permitted schema update types
* @return SchemaUpdateResult Result of the schema update
*/
public function updateSchema(array $schemaUpdateTypes)
{
$expectedSchema = $this->expectedSchemaService->getExpectedDatabaseSchema();
$currentSchema = $this->schemaMigrationService->getFieldDefinitions_database();
$addCreateChange = $this->schemaMigrationService->getDatabaseExtra($expectedSchema, $currentSchema);
$dropRename = $this->schemaMigrationService->getDatabaseExtra($currentSchema, $expectedSchema);
$updateStatements = array();
ArrayUtility::mergeRecursiveWithOverrule($updateStatements, $this->schemaMigrationService->getUpdateSuggestions($addCreateChange));
ArrayUtility::mergeRecursiveWithOverrule($updateStatements, $this->schemaMigrationService->getUpdateSuggestions($dropRename, 'remove'));
$updateResult = new SchemaUpdateResult();
foreach ($schemaUpdateTypes as $schemaUpdateType) {
$statementTypes = $this->getStatementTypes($schemaUpdateType);
foreach ($statementTypes as $statementType) {
if (isset($updateStatements[$statementType])) {
$statements = $updateStatements[$statementType];
$result = $this->schemaMigrationService->performUpdateQueries($statements, array_combine(array_keys($statements), array_fill(0, count($statements), TRUE)));
if ($result === TRUE) {
$updateResult->addPerformedUpdates($schemaUpdateType, count($statements));
} elseif (is_array($result)) {
$updateResult->addErrors($schemaUpdateType, $result);
}
}
}
}
return $updateResult;
}
/**
* Determine all create table statements which create the sys_file* tables
*
* @return array
*/
protected function getRequiredUpdates()
{
$requiredUpdates = array();
$fileContent = \TYPO3\CMS\Core\Utility\GeneralUtility::getUrl(\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath('core') . 'ext_tables.sql');
$FDfile = $this->installerSql->getFieldDefinitions_fileContent($fileContent);
$FDdb = $this->installerSql->getFieldDefinitions_database(TYPO3_db);
$diff = $this->installerSql->getDatabaseExtra($FDfile, $FDdb);
$update_statements = $this->installerSql->getUpdateSuggestions($diff);
foreach ((array) $update_statements['create_table'] as $string) {
if (preg_match('/^CREATE TABLE sys_file($|_)?/', $string)) {
$requiredUpdates[] = $string;
}
}
return $requiredUpdates;
}
/**
* Gets all create, add and change queries from core/ext_tables.sql
*
* @return array
*/
protected function getUpdateStatements()
{
$updateStatements = array();
// Get all necessary statements for ext_tables.sql file
$rawDefinitions = \TYPO3\CMS\Core\Utility\GeneralUtility::getUrl(\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath('core') . '/ext_tables.sql');
$fieldDefinitionsFromFile = $this->installToolSqlParser->getFieldDefinitions_fileContent($rawDefinitions);
if (count($fieldDefinitionsFromFile)) {
$fieldDefinitionsFromCurrentDatabase = $this->installToolSqlParser->getFieldDefinitions_database();
$diff = $this->installToolSqlParser->getDatabaseExtra($fieldDefinitionsFromFile, $fieldDefinitionsFromCurrentDatabase);
$updateStatements = $this->installToolSqlParser->getUpdateSuggestions($diff);
}
return $updateStatements;
}
/**
* @test
*/
public function columnAndKeyDeletionDoesNotReturnAnError()
{
// Get the current database fields.
$currentDatabaseSchema = $this->sqlSchemaMigrationService->getFieldDefinitions_database();
// Limit our scope to the be_users table:
$currentDatabaseSchemaForBeUsers = array();
$currentDatabaseSchemaForBeUsers['be_users'] = $currentDatabaseSchema['be_users'];
unset($currentDatabaseSchema);
// Create a key and a field that belongs to that key:
$expectedDatabaseSchemaForBeUsers = $currentDatabaseSchemaForBeUsers;
$expectedDatabaseSchemaForBeUsers['be_users']['fields']['functional_test_field_1'] = "tinyint(1) unsigned NOT NULL default '0'";
$expectedDatabaseSchemaForBeUsers['be_users']['keys']['functional_test_key_1'] = 'KEY functional_test_key_1 (functional_test_field_1)';
$createFieldDiff = $this->sqlSchemaMigrationService->getDatabaseExtra($expectedDatabaseSchemaForBeUsers, $currentDatabaseSchemaForBeUsers);
$createFieldDiff = $this->sqlSchemaMigrationService->getUpdateSuggestions($createFieldDiff);
$this->sqlSchemaMigrationService->performUpdateQueries($createFieldDiff['add'], $createFieldDiff['add']);
// Now remove the fields again (without the renaming step).
unset($currentDatabaseSchemaForBeUsers['be_users']['fields']['functional_test_field_1']);
unset($currentDatabaseSchemaForBeUsers['be_users']['keys']['functional_test_key_1']);
$this->sqlSchemaMigrationService->setDeletedPrefixKey('');
$removeFieldDiff = $this->sqlSchemaMigrationService->getDatabaseExtra($expectedDatabaseSchemaForBeUsers, $currentDatabaseSchemaForBeUsers);
$removeFieldDiff = $this->sqlSchemaMigrationService->getUpdateSuggestions($removeFieldDiff, 'remove');
$result = $this->sqlSchemaMigrationService->performUpdateQueries($removeFieldDiff['drop'], $removeFieldDiff['drop']);
$this->assertTrue($result, 'performUpdateQueries() did not return TRUE, this means an error occurred: ' . (is_array($result) ? array_pop($result) : ''));
}
/**
* Update database / process db updates from ext_tables
*
* @param string $rawDefinitions The raw SQL statements from ext_tables.sql
* @return void
*/
public function updateDbWithExtTablesSql($rawDefinitions)
{
$fieldDefinitionsFromFile = $this->installToolSqlParser->getFieldDefinitions_fileContent($rawDefinitions);
if (count($fieldDefinitionsFromFile)) {
$fieldDefinitionsFromCurrentDatabase = $this->installToolSqlParser->getFieldDefinitions_database();
$diff = $this->installToolSqlParser->getDatabaseExtra($fieldDefinitionsFromFile, $fieldDefinitionsFromCurrentDatabase);
$updateStatements = $this->installToolSqlParser->getUpdateSuggestions($diff);
$db = $this->getDatabaseConnection();
foreach ((array) $updateStatements['add'] as $string) {
$db->admin_query($string);
}
foreach ((array) $updateStatements['change'] as $string) {
$db->admin_query($string);
}
foreach ((array) $updateStatements['create_table'] as $string) {
$db->admin_query($string);
}
}
}
/**
* Executes the database structure updates.
*
* @param array $arguments Optional arguemtns passed to this action
* @param boolean $allowKeyModifications Whether to allow key modifications
* @return string
*/
protected function executeUpdateStructure(array $arguments, $isRemovalEnabled, $allowKeyModifications = FALSE)
{
$result = '';
$isExcuteEnabled = isset($arguments['--execute']) || isset($arguments['-e']);
$isRemovalEnabled = isset($arguments['--remove']) || isset($arguments['-r']);
$isVerboseEnabled = isset($arguments['--verbose']) || isset($arguments['-v']);
$database = isset($arguments['--database']) && $arguments['--database'] ? $arguments['--database'] : TYPO3_db;
$changes = $this->install->getUpdateSuggestions($this->getStructureDifferencesForUpdate($database, $allowKeyModifications));
if ($isRemovalEnabled) {
// Disable the delete prefix, thus tables and fields can be removed directly:
$this->install->setDeletedPrefixKey('');
// Add types considered for removal:
$this->addConsideredTypes($this->getRemoveTypes());
// Merge update suggestions:
$removals = $this->install->getUpdateSuggestions($this->getStructureDifferencesForRemoval($database, $allowKeyModifications), 'remove');
$changes = array_merge($changes, $removals);
}
if ($isExcuteEnabled || $isVerboseEnabled) {
$statements = array();
// Concatenates all statements:
foreach ($this->consideredTypes as $consideredType) {
if (isset($changes[$consideredType]) && is_array($changes[$consideredType])) {
$statements += $changes[$consideredType];
}
}
if ($isExcuteEnabled) {
foreach ($statements as $statement) {
$GLOBALS['TYPO3_DB']->admin_query($statement);
}
}
if ($isVerboseEnabled) {
$result = implode(PHP_EOL, $statements);
}
}
return $result;
}
