[BUGFIX] Do not use named parameter for list of orphan records ids
[Packages/TYPO3.CMS.git] / typo3 / sysext / lowlevel / Classes / Command / OrphanRecordsCommand.php
1 <?php
2 declare(strict_types = 1);
3 namespace TYPO3\CMS\Lowlevel\Command;
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
18 use Symfony\Component\Console\Command\Command;
19 use Symfony\Component\Console\Input\InputInterface;
20 use Symfony\Component\Console\Input\InputOption;
21 use Symfony\Component\Console\Output\OutputInterface;
22 use Symfony\Component\Console\Style\SymfonyStyle;
23 use TYPO3\CMS\Backend\Utility\BackendUtility;
24 use TYPO3\CMS\Core\Core\Bootstrap;
25 use TYPO3\CMS\Core\Database\Connection;
26 use TYPO3\CMS\Core\Database\ConnectionPool;
27 use TYPO3\CMS\Core\DataHandling\DataHandler;
28 use TYPO3\CMS\Core\Utility\GeneralUtility;
29
30 /**
31 * Finds (and fixes) all records that have an invalid / deleted page ID
32 */
33 class OrphanRecordsCommand extends Command
34 {
35
36 /**
37 * Configure the command by defining the name, options and arguments
38 */
39 public function configure()
40 {
41 $this
42 ->setDescription('Find and delete records that have lost their connection with the page tree.')
43 ->setHelp('Assumption: All actively used records on the website from TCA configured tables are located in the page tree exclusively.
44
45 All records managed by TYPO3 via the TCA array configuration has to belong to a page in the page tree, either directly or indirectly as a version of another record.
46 VERY TIME, CPU and MEMORY intensive operation since the full page tree is looked up!
47
48 Automatic Repair of Errors:
49 - Silently deleting the orphaned records. In theory they should not be used anywhere in the system, but there could be references. See below for more details on this matter.
50
51 Manual repair suggestions:
52 - Possibly re-connect orphaned records to page tree by setting their "pid" field to a valid page id. A lookup in the sys_refindex table can reveal if there are references to a orphaned record. If there are such references (from records that are not themselves orphans) you might consider to re-connect the record to the page tree, otherwise it should be safe to delete it.
53
54 If you want to get more detailed information, use the --verbose option.')
55 ->addOption(
56 'dry-run',
57 null,
58 InputOption::VALUE_NONE,
59 'If this option is set, the records will not actually be deleted, but just the output which records would be deleted are shown'
60 );
61 }
62
63 /**
64 * Executes the command to find records not attached to the pagetree
65 * and permanently delete these records
66 *
67 * @param InputInterface $input
68 * @param OutputInterface $output
69 */
70 protected function execute(InputInterface $input, OutputInterface $output)
71 {
72 // Make sure the _cli_ user is loaded
73 Bootstrap::initializeBackendAuthentication();
74
75 $io = new SymfonyStyle($input, $output);
76 $io->title($this->getDescription());
77
78 if ($io->isVerbose()) {
79 $io->section('Searching the database now for orphaned records.');
80 }
81
82 // type unsafe comparison and explicit boolean setting on purpose
83 $dryRun = $input->hasOption('dry-run') && $input->getOption('dry-run') != false ? true : false;
84
85 // find all records that should be deleted
86 $allRecords = $this->findAllConnectedRecordsInPage(0, 10000);
87
88 // Find orphans
89 $orphans = [];
90 foreach (array_keys($GLOBALS['TCA']) as $tableName) {
91 $idList = [0];
92 if (is_array($allRecords[$tableName]) && !empty($allRecords[$tableName])) {
93 $idList = $allRecords[$tableName];
94 }
95 // Select all records that are NOT connected
96 $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
97 ->getQueryBuilderForTable($tableName);
98
99 $result = $queryBuilder
100 ->select('uid')
101 ->from($tableName)
102 ->where(
103 $queryBuilder->expr()->notIn(
104 'uid',
105 // do not use named parameter here as the list can get too long
106 array_map('intval', $idList)
107 )
108 )
109 ->orderBy('uid')
110 ->execute();
111
112 $totalOrphans = 0;
113 $rowCount = $queryBuilder->count('uid')->execute()->fetchColumn(0);
114 if ($rowCount) {
115 $orphans[$tableName] = [];
116 while ($orphanRecord = $result->fetch()) {
117 $orphans[$tableName][$orphanRecord['uid']] = $orphanRecord['uid'];
118 }
119 $totalOrphans += count($orphans[$tableName]);
120
121 if ($io->isVeryVerbose() && count($orphans[$tableName])) {
122 $io->writeln('Found ' . count($orphans[$tableName]) . ' orphan records in table "' . $tableName . '".');
123 }
124 }
125 if (!$io->isQuiet() && $totalOrphans) {
126 $io->note('Found ' . $totalOrphans . ' records in ' . count($orphans) . ' database tables.');
127 }
128 }
129
130 if (count($orphans)) {
131 $io->section('Deletion process starting now.' . ($dryRun ? ' (Not deleting now, just a dry run)' : ''));
132
133 // Actually permanently delete them
134 $this->deleteRecords($orphans, $dryRun, $io);
135
136 $io->success('All done!');
137 } else {
138 $io->success('No orphan records found.');
139 }
140 }
141
142 /**
143 * Recursive traversal of page tree to fetch all records marekd as "deleted",
144 * via option $GLOBALS[TCA][$tableName][ctrl][delete]
145 * This also takes deleted versioned records into account.
146 *
147 * @param int $pageId the uid of the pages record (can also be 0)
148 * @param int $depth The current depth of levels to go down
149 * @param array $allRecords the records that are already marked as deleted (used when going recursive)
150 *
151 * @return array the modified $deletedRecords array
152 */
153 protected function findAllConnectedRecordsInPage(int $pageId, int $depth, array $allRecords = []): array
154 {
155 // Register page
156 if ($pageId > 0) {
157 $allRecords['pages'][$pageId] = $pageId;
158 }
159 // Traverse tables of records that belongs to page
160 foreach (array_keys($GLOBALS['TCA']) as $tableName) {
161 if ($tableName !== 'pages') {
162 // Select all records belonging to page:
163 $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
164 ->getQueryBuilderForTable($tableName);
165
166 $queryBuilder->getRestrictions()->removeAll();
167
168 $result = $queryBuilder
169 ->select('uid')
170 ->from($tableName)
171 ->where(
172 $queryBuilder->expr()->eq(
173 'pid',
174 $queryBuilder->createNamedParameter($pageId, \PDO::PARAM_INT)
175 )
176 )
177 ->execute();
178
179 while ($rowSub = $result->fetch()) {
180 $allRecords[$tableName][$rowSub['uid']] = $rowSub['uid'];
181 // Add any versions of those records:
182 $versions = BackendUtility::selectVersionsOfRecord($tableName, $rowSub['uid'], 'uid,t3ver_wsid,t3ver_count', null, true);
183 if (is_array($versions)) {
184 foreach ($versions as $verRec) {
185 if (!$verRec['_CURRENT_VERSION']) {
186 $allRecords[$tableName][$verRec['uid']] = $verRec['uid'];
187 }
188 }
189 }
190 }
191 }
192 }
193 // Find subpages to root ID and traverse (only when rootID is not a version or is a branch-version):
194 if ($depth > 0) {
195 $depth--;
196 $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
197 ->getQueryBuilderForTable('pages');
198
199 $queryBuilder->getRestrictions()->removeAll();
200
201 $result = $queryBuilder
202 ->select('uid')
203 ->from('pages')
204 ->where(
205 $queryBuilder->expr()->eq(
206 'pid',
207 $queryBuilder->createNamedParameter($pageId, \PDO::PARAM_INT)
208 )
209 )
210 ->orderBy('sorting')
211 ->execute();
212
213 while ($row = $result->fetch()) {
214 $allRecords = $this->findAllConnectedRecordsInPage($row['uid'], $depth, $allRecords);
215 }
216 }
217
218 // Add any versions of pages
219 if ($pageId > 0) {
220 $versions = BackendUtility::selectVersionsOfRecord('pages', $pageId, 'uid,t3ver_oid,t3ver_wsid,t3ver_count', null, true);
221 if (is_array($versions)) {
222 foreach ($versions as $verRec) {
223 if (!$verRec['_CURRENT_VERSION']) {
224 $allRecords = $this->findAllConnectedRecordsInPage($verRec['uid'], $depth, $allRecords);
225 }
226 }
227 }
228 }
229 return $allRecords;
230 }
231
232 /**
233 * Deletes records via DataHandler
234 *
235 * @param array $orphanedRecords two level array with tables and uids
236 * @param bool $dryRun check if the records should NOT be deleted (use --dry-run to avoid)
237 * @param SymfonyStyle $io
238 */
239 protected function deleteRecords(array $orphanedRecords, bool $dryRun, SymfonyStyle $io)
240 {
241 // Putting "pages" table in the bottom
242 if (isset($orphanedRecords['pages'])) {
243 $_pages = $orphanedRecords['pages'];
244 unset($orphanedRecords['pages']);
245 // To delete sub pages first assuming they are accumulated from top of page tree.
246 $orphanedRecords['pages'] = array_reverse($_pages);
247 }
248
249 // set up the data handler instance
250 $dataHandler = GeneralUtility::makeInstance(DataHandler::class);
251 $dataHandler->start([], []);
252
253 // Loop through all tables and their records
254 foreach ($orphanedRecords as $table => $list) {
255 if ($io->isVerbose()) {
256 $io->writeln('Flushing ' . count($list) . ' orphaned records from table "' . $table . '"');
257 }
258 foreach ($list as $uid) {
259 if ($io->isVeryVerbose()) {
260 $io->writeln('Flushing record "' . $table . ':' . $uid . '"');
261 }
262 if (!$dryRun) {
263 // Notice, we are deleting pages with no regard to subpages/subrecords - we do this since they
264 // should also be included in the set of deleted pages of course (no un-deleted record can exist
265 // under a deleted page...)
266 $dataHandler->deleteRecord($table, $uid, true, true);
267 // Return errors if any:
268 if (!empty($dataHandler->errorLog)) {
269 $errorMessage = array_merge(['DataHandler reported an error'], $dataHandler->errorLog);
270 $io->error($errorMessage);
271 } elseif (!$io->isQuiet()) {
272 $io->writeln('Permanently deleted orphaned record "' . $table . ':' . $uid . '".');
273 }
274 }
275 }
276 }
277 }
278 }