typo3/sysext/install/Classes/Updates/DatabaseRowsUpdateWizard.php

   1 <?php
   2 declare(strict_types=1);
   3 namespace TYPO3\CMS\Install\Updates;
   4
   5 /*
   6  * This file is part of the TYPO3 CMS project.
   7  *
   8  * It is free software; you can redistribute it and/or modify it under
   9  * the terms of the GNU General Public License, either version 2
  10  * of the License, or any later version.
  11  *
  12  * For the full copyright and license information, please read the
  13  * LICENSE.txt file that was distributed with this source code.
  14  *
  15  * The TYPO3 project - inspiring people to share!
  16  */
  17 use TYPO3\CMS\Core\Database\ConnectionPool;
  18 use TYPO3\CMS\Core\Registry;
  19 use TYPO3\CMS\Core\Utility\GeneralUtility;
  20 use TYPO3\CMS\Install\Updates\RowUpdater\L10nModeUpdater;
  21 use TYPO3\CMS\Install\Updates\RowUpdater\RowUpdaterInterface;
  22
  23 /**
  24  * This is a generic updater to migrate content of TCA rows.
  25  *
  26  * Multiple classes implementing interface "RowUpdateInterface" can be
  27  * registered here, each for a specific update purpose.
  28  *
  29  * The updater fetches each row of all TCA registered tables and
  30  * visits the client classes who may modify the row content.
  31  *
  32  * The updater remembers for each class if it run through, so the updater
  33  * will be shown again if a new updater class is registered that has not
  34  * been run yet.
  35  *
  36  * A start position pointer is stored in the registry that is updated during
  37  * the run process, so if for instance the PHP process runs into a timeout,
  38  * the job can restart at the position it stopped.
  39  */
  40 class DatabaseRowsUpdateWizard extends AbstractUpdate
  41 {
  42     /**
  43      * @var string Title of this updater
  44      */
  45     protected $title = 'Execute database migrations on single rows';
  46
  47     /**
  48      * @var array Single classes that may update rows
  49      */
  50     protected $rowUpdater = [
  51         L10nModeUpdater::class,
  52     ];
  53
  54     /**
  55      * Checks if an update is needed by looking up in registry if all
  56      * registered update row classes are marked as done or not.
  57      *
  58      * @param string &$description The description for the update
  59      * @return bool Whether an update is needed (TRUE) or not (FALSE)
  60      */
  61     public function checkForUpdate(&$description)
  62     {
  63         $updateNeeded = false;
  64         $rowUpdaterNotExecuted = $this->getRowUpdatersToExecute();
  65         if (!empty($rowUpdaterNotExecuted)) {
  66             $updateNeeded = true;
  67         }
  68         if (!$updateNeeded) {
  69             return false;
  70         }
  71
  72         $description = 'Some row updaters have not been executed:';
  73         foreach ($rowUpdaterNotExecuted as $rowUpdateClassName) {
  74             $rowUpdater = GeneralUtility::makeInstance($rowUpdateClassName);
  75             if (!$rowUpdater instanceof RowUpdaterInterface) {
  76                 throw new \RuntimeException(
  77                     'Row updater must implement RowUpdaterInterface',
  78                     1484066647
  79                 );
  80             }
  81             $description .= '<br />' . htmlspecialchars($rowUpdater->getTitle());
  82         }
  83
  84         return $updateNeeded;
  85     }
  86
  87     /**
  88      * Performs the configuration update.
  89      *
  90      * @param array &$databaseQueries Queries done in this update - not filled for this updater
  91      * @param mixed &$customMessages Custom messages
  92      * @return bool
  93      * @throws \Doctrine\DBAL\ConnectionException
  94      * @throws \Exception
  95      */
  96     public function performUpdate(array &$databaseQueries, &$customMessages)
  97     {
  98         $registry = GeneralUtility::makeInstance(Registry::class);
  99
 100         // If rows from the target table that is updated and the sys_registry table are on the
 101         // same connection, the row update statement and sys_registry position update will be
 102         // handled in a transaction to have an atomic operation in case of errors during execution.
 103         $connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);
 104         $connectionForSysRegistry = $connectionPool->getConnectionForTable('sys_registry');
 105
 106         /** @var RowUpdaterInterface[] $rowUpdaterInstances */
 107         $rowUpdaterInstances = [];
 108         // Single row updater instances are created only once for this method giving
 109         // them a chance to set up local properties during hasPotentialUpdateForTable()
 110         // and using that in updateTableRow()
 111         foreach ($this->getRowUpdatersToExecute() as $rowUpdater) {
 112             $rowUpdaterInstance = GeneralUtility::makeInstance($rowUpdater);
 113             if (!$rowUpdaterInstance instanceof RowUpdaterInterface) {
 114                 throw new \RuntimeException(
 115                     'Row updater must implement RowUpdaterInterface',
 116                     1484071612
 117                 );
 118             }
 119             $rowUpdaterInstances[] = $rowUpdaterInstance;
 120         }
 121
 122         // Scope of the row updater is to update all rows that have TCA,
 123         // our list of tables is just the list of loaded TCA tables.
 124         $listOfAllTables = array_keys($GLOBALS['TCA']);
 125
 126         // In case the PHP ended for whatever reason, fetch the last position from registry
 127         // and throw away all tables before that start point.
 128         sort($listOfAllTables);
 129         reset($listOfAllTables);
 130         $firstTable = current($listOfAllTables);
 131         $startPosition = $this->getStartPosition($firstTable);
 132         foreach ($listOfAllTables as $table) {
 133             if ($table === $startPosition['table']) {
 134                 break;
 135             } else {
 136                 unset($listOfAllTables[$table]);
 137             }
 138         }
 139
 140         // Ask each row updater if it potentially has field updates for rows of a table
 141         $tableToUpdaterList = [];
 142         foreach ($listOfAllTables as $table) {
 143             foreach ($rowUpdaterInstances as $updater) {
 144                 if ($updater->hasPotentialUpdateForTable($table)) {
 145                     if (!is_array($tableToUpdaterList[$table])) {
 146                         $tableToUpdaterList[$table] = [];
 147                     }
 148                     $tableToUpdaterList[$table][] = $updater;
 149                 }
 150             }
 151         }
 152
 153         // Iterate through all rows of all tables that have potential row updaters attached,
 154         // feed each single row to each updater and finally update each row in database if
 155         // a row updater changed a fields
 156         foreach ($tableToUpdaterList as $table => $updaters) {
 157             /** @var RowUpdaterInterface[] $updaters */
 158             $connectionForTable = $connectionPool->getConnectionForTable($table);
 159             $queryBuilder = $connectionPool->getQueryBuilderForTable($table);
 160             $queryBuilder->getRestrictions()->removeAll();
 161             $queryBuilder->select('*')
 162                 ->from($table)
 163                 ->orderBy('uid');
 164             if ($table === $startPosition['table']) {
 165                 $queryBuilder->where(
 166                     $queryBuilder->expr()->gt('uid', $queryBuilder->createNamedParameter($startPosition['uid']))
 167                 );
 168             }
 169             $statement = $queryBuilder->execute();
 170             $rowCountWithoutUpdate = 0;
 171             while ($row = $rowBefore = $statement->fetch()) {
 172                 foreach ($updaters as $updater) {
 173                     $row = $updater->updateTableRow($table, $row);
 174                 }
 175                 $updatedFields = array_diff_assoc($row, $rowBefore);
 176                 if (empty($updatedFields)) {
 177                     // Updaters changed no field of that row
 178                     $rowCountWithoutUpdate ++;
 179                     if ($rowCountWithoutUpdate >= 200) {
 180                         // Update startPosition if there were many rows without data change
 181                         $startPosition = [
 182                             'table' => $table,
 183                             'uid' => $row['uid'],
 184                         ];
 185                         $registry->set('installUpdateRows', 'rowUpdatePosition', $startPosition);
 186                         $rowCountWithoutUpdate = 0;
 187                     }
 188                 } else {
 189                     $rowCountWithoutUpdate = 0;
 190                     $startPosition = [
 191                         'table' => $table,
 192                         'uid' => $rowBefore['uid'],
 193                     ];
 194                     if ($connectionForSysRegistry === $connectionForTable) {
 195                         // Target table and sys_registry table are on the same connection, use a transaction
 196                         $connectionForTable->beginTransaction();
 197                         try {
 198                             $connectionForTable->update(
 199                                 $table,
 200                                 $updatedFields,
 201                                 [
 202                                     'uid' => $rowBefore['uid'],
 203                                 ]
 204                             );
 205                             $connectionForTable->update(
 206                                 'sys_registry',
 207                                 [
 208                                     'entry_value' => serialize($startPosition),
 209                                 ],
 210                                 [
 211                                     'entry_namespace' => 'installUpdateRows',
 212                                     'entry_key' => 'rowUpdatePosition',
 213                                 ]
 214                             );
 215                             $connectionForTable->commit();
 216                         } catch (\Exception $up) {
 217                             $connectionForTable->rollBack();
 218                             throw $up;
 219                         }
 220                     } else {
 221                         // Different connections for table and sys_registry -> execute two
 222                         // distinct queries and hope for the best.
 223                         $connectionForTable->update(
 224                             $table,
 225                             $updatedFields,
 226                             [
 227                                 'uid' => $rowBefore['uid'],
 228                             ]
 229                         );
 230                         $connectionForSysRegistry->update(
 231                             'sys_registry',
 232                             [
 233                                 'entry_value' => serialize($startPosition),
 234                             ],
 235                             [
 236                                 'entry_namespace' => 'installUpdateRows',
 237                                 'entry_key' => 'rowUpdatePosition',
 238                             ]
 239                         );
 240                     }
 241                 }
 242             }
 243         }
 244
 245         // Ready with updates, remove position information from sys_registry
 246         $registry->remove('installUpdateRows', 'rowUpdatePosition');
 247         // Mark row updaters that were executed as done
 248         foreach ($rowUpdaterInstances as $updater) {
 249             $this->setRowUpdaterExecuted($updater);
 250         }
 251
 252         return true;
 253     }
 254
 255     /**
 256      * Return an array of class names that are not yet marked as done.
 257      *
 258      * @return array Class names
 259      */
 260     protected function getRowUpdatersToExecute(): array
 261     {
 262         $doneRowUpdater = GeneralUtility::makeInstance(Registry::class)->get('installUpdateRows', 'rowUpdatersDone', []);
 263         return array_diff($this->rowUpdater, $doneRowUpdater);
 264     }
 265
 266     /**
 267      * Mark a single updater as done
 268      *
 269      * @param RowUpdaterInterface $updater
 270      */
 271     protected function setRowUpdaterExecuted(RowUpdaterInterface $updater)
 272     {
 273         $registry = GeneralUtility::makeInstance(Registry::class);
 274         $doneRowUpdater = $registry->get('installUpdateRows', 'rowUpdatersDone', []);
 275         $doneRowUpdater[] = get_class($updater);
 276         $registry->set('installUpdateRows', 'rowUpdatersDone', $doneRowUpdater);
 277     }
 278
 279     /**
 280      * Return an array with table / uid combination that specifies the start position the
 281      * update row process should start with.
 282      *
 283      * @param string $firstTable Table name of the first TCA in case the start position needs to be initialized
 284      * @return array New start position
 285      */
 286     protected function getStartPosition(string $firstTable): array
 287     {
 288         $registry = GeneralUtility::makeInstance(Registry::class);
 289         $startPosition = $registry->get('installUpdateRows', 'rowUpdaterPosition', []);
 290         if (empty($startPosition)) {
 291             $startPosition = [
 292                 'table' => $firstTable,
 293                 'uid' => 0,
 294             ];
 295             $registry->set('installUpdateRows', 'rowUpdatePosition', $startPosition);
 296         }
 297         return $startPosition;
 298     }
 299 }