[!!!][TASK] Migrate Lowlevel "missing_relations" command to Symfony Console 55/50555/4
authorBenni Mack <benni@typo3.org>
Wed, 9 Nov 2016 14:26:01 +0000 (15:26 +0100)
committerAnja Leichsenring <aleichsenring@ab-softlab.de>
Thu, 10 Nov 2016 09:02:03 +0000 (10:02 +0100)
The CLI command to detect and (as far as possible) remove
relations to non-existing records, and offline version versions as
well as listing deleted records is migrated to Symfony Console
to better structure the CLI command and get rid of dependencies
of the old CLI command line tools (non-extbase).

The command was previously available under
./typo3/cli_dispatch lowlevel_cleaner missing_relations

and is now called via
./typo3/sysext/core/bin/typo3 cleanup:missingrelations

and allows the following options:
--dry-run - do not delete the references, but just print them
--update-refindex - update the reference index, do not ask the user

Resolves: #78623
Releases: master
Change-Id: Ia81a250deb0b238ed4e4dd09667b381f5cb53cfb
Reviewed-on: https://review.typo3.org/50555
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Oliver Hader <oliver.hader@typo3.org>
Tested-by: Oliver Hader <oliver.hader@typo3.org>
Reviewed-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Tested-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
typo3/sysext/core/Documentation/Changelog/master/Breaking-78623-LowlevelMissingRelationsCommandParametersChanged.rst [new file with mode: 0644]
typo3/sysext/lowlevel/Classes/Command/MissingRelationsCommand.php [new file with mode: 0644]
typo3/sysext/lowlevel/Classes/MissingFilesCommand.php [deleted file]
typo3/sysext/lowlevel/Classes/MissingRelationsCommand.php [deleted file]
typo3/sysext/lowlevel/Configuration/Commands.php
typo3/sysext/lowlevel/ext_localconf.php

diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-78623-LowlevelMissingRelationsCommandParametersChanged.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-78623-LowlevelMissingRelationsCommandParametersChanged.rst
new file mode 100644 (file)
index 0000000..62166c9
--- /dev/null
@@ -0,0 +1,42 @@
+.. include:: ../../Includes.txt
+
+======================================================================
+Breaking: #78623 - Lowlevel MissingRelationsCommand parameters changed
+======================================================================
+
+See :issue:`78623`
+
+Description
+===========
+
+The existing CLI command within EXT:lowlevel for showing relations and soft-references to non-existing records,
+offline versions and records marked as deleted has been migrated to a Symfony Console command.
+
+The previously command available via `./typo3/cli_dispatch.phpsh lowlevel_cleaner missing_relations` is now available
+via `./typo3/sysext/core/bin/typo3 cleanup:missingrelations` and allows the following CLI options to be set:
+
+`--update-refindex` - updates the reference index before scanning for missing files. If not set, the user is asked if the task should be run
+`--dry-run` - do not delete the references but only list the references that are missing but connected to the TYPO3 system
+
+The PHP class of the old CLI command `TYPO3\CMS\Lowlevel\MissingRelationsCommand` has been removed.
+
+
+Impact
+======
+
+Calling the old CLI command `./typo3/cli_dispatch.phpsh lowlevel_cleaner missing_relations` will result in an error message.
+
+
+Affected Installations
+======================
+
+Any TYPO3 instances using the lowlevel cleaner for finding relations pointing to deleted, offline versions or
+non-existing records.
+
+
+Migration
+=========
+
+Update the CLI call on your servers to the new command line and available options as shown above.
+
+.. index:: CLI
diff --git a/typo3/sysext/lowlevel/Classes/Command/MissingRelationsCommand.php b/typo3/sysext/lowlevel/Classes/Command/MissingRelationsCommand.php
new file mode 100644 (file)
index 0000000..8abedc6
--- /dev/null
@@ -0,0 +1,356 @@
+<?php
+declare(strict_types=1);
+namespace TYPO3\CMS\Lowlevel\Command;
+
+/*
+ * 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 Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+use TYPO3\CMS\Backend\Utility\BackendUtility;
+use TYPO3\CMS\Core\Database\ConnectionPool;
+use TYPO3\CMS\Core\Database\ReferenceIndex;
+use TYPO3\CMS\Core\Utility\ArrayUtility;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+
+/**
+ * Finds references and soft-references to
+ * - records which are marked as deleted (e.g. still in the system as reminder)
+ * - offline versions (references should never point to offline versions)
+ * - non-existing records (records which have been deleted not via DataHandler)
+ *
+ * The later (non-soft-reference variants) can be automatically fixed by simply removing
+ * the references from the refindex.
+ */
+class MissingRelationsCommand extends Command
+{
+
+    /**
+     * Configure the command by defining the name, options and arguments
+     */
+    public function configure()
+    {
+        $this
+            ->setDescription('Find all record references pointing to a non-existing record')
+            ->setHelp('
+Assumptions:
+- a perfect integrity of the reference index table (always update the reference index table before using this tool!)
+- all database references to check are integers greater than zero
+- does not check if a referenced record is inside an offline branch, another workspace etc. which could make the reference useless in reality or otherwise question integrity
+Records may be missing for these reasons (except software bugs):
+- someone deleted the record which is technically not an error although it might be a mistake that someone did so.
+- after flushing published versions and/or deleted-flagged records a number of new missing references might appear; those were pointing to records just flushed.
+
+An automatic repair is only possible for managed references are (not for soft references), for
+offline versions records and non-existing records. If you just want to list them, use the --dry-run option.
+The references in this case are removed.
+
+If the option "--dry-run" is not set, all managed files (TCA/FlexForm attachments) will silently remove the references
+to non-existing and offline version records.
+All soft references with relations to non-existing records, offline versions and deleted records
+require manual fix if you consider it an error.
+
+Manual repair suggestions:
+- For soft references you should investigate each case and edit the content accordingly.
+- References to deleted records can theoretically be removed since a deleted record cannot be selected and hence
+your website should not be affected by removal of the reference. On the other hand it does not hurt to ignore it
+for now. To have this automatically fixed you must first flush the deleted records after which remaining
+references will appear as pointing to Non Existing Records and can now be removed with the automatic fix.
+
+If you want to get more detailed information, use the --verbose option.')
+            ->addOption(
+                'dry-run',
+                null,
+                InputOption::VALUE_NONE,
+                'If this option is set, the references will not be removed, but just the output which references would be deleted are shown'
+            )
+            ->addOption(
+                'update-refindex',
+                null,
+                InputOption::VALUE_NONE,
+                'Setting this option automatically updates the reference index and does not ask on command line. Alternatively, use -n to avoid the interactive mode'
+            );
+    }
+
+    /**
+     * Executes the command to
+     * - optionally update the reference index (to have clean data)
+     * - find data in sys_refindex (softrefs and regular references) where the reference points to a non-existing record or offline version
+     * - remove these files if --dry-run is not set (not possible for refindexes)
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     *
+     * @return void
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $io = new SymfonyStyle($input, $output);
+        $io->title($this->getDescription());
+
+        $dryRun = $input->hasOption('dry-run') && $input->getOption('dry-run') != false ? true : false;
+
+        // Update the reference index
+        $this->updateReferenceIndex($input, $io);
+
+        $results = $this->findRelationsToNonExistingRecords();
+
+        // Display soft references to non-existing records
+        if ($io->isVerbose() && count($results['nonExistingRecordsInSoftReferenceRelations'])) {
+            $io->note([
+                'Found ' . count($results['nonExistingRecordsInSoftReferenceRelations']) . ' non-existing records that are still being soft-referenced in the following locations.',
+                'These relations cannot be removed automatically and need manual repair.'
+            ]);
+            $io->listing($results['nonExistingRecordsInSoftReferenceRelations']);
+        }
+
+        // Display soft references to offline version records
+        // These records are offline versions having a pid=-1 and references should never occur directly to their uids.
+        if ($io->isVerbose() && count($results['offlineVersionRecordsInSoftReferenceRelations'])) {
+            $io->note([
+                'Found ' . count($results['offlineVersionRecordsInSoftReferenceRelations']) . ' soft-references pointing to offline versions, which should never be referenced directly.',
+                'These relations cannot be removed automatically and need manual repair.'
+            ]);
+            $io->listing($results['offlineVersionRecordsInSoftReferenceRelations']);
+        }
+
+        // Display references to deleted records
+        // These records are deleted with a flag but references are still pointing at them.
+        // Keeping the references is useful if you undelete the referenced records later, otherwise the references
+        // are lost completely when the deleted records are flushed at some point. Notice that if those records listed
+        // are themselves deleted (marked with "DELETED") it is not a problem.
+        if ($io->isVerbose() && count($results['deletedRecords'])) {
+            $io->note([
+                'Found ' . count($results['deletedRecords']) . ' references pointing to deleted records.',
+                'Keeping the references is useful if you undelete the referenced records later, otherwise the references' .
+                'are lost completely when the deleted records are flushed at some point. Notice that if those records listed' .
+                'are themselves deleted (marked with "DELETED") it is not a problem.',
+            ]);
+            $io->listing($results['deletedRecords']);
+        }
+
+        // soft references which link to deleted records
+        if ($io->isVerbose() && count($results['deletedRecordsInSoftReferenceRelations'])) {
+            $io->note([
+                'Found ' . count($results['deletedRecordsInSoftReferenceRelations']) . ' soft references pointing  to deleted records.',
+                'Keeping the references is useful if you undelete the referenced records later, otherwise the references' .
+                'are lost completely when the deleted records are flushed at some point. Notice that if those records listed' .
+                'are themselves deleted (marked with "DELETED") it is not a problem.',
+            ]);
+            $io->listing($results['deletedRecordsInSoftReferenceRelations']);
+        }
+
+        // Find missing references
+        if (count($results['offlineVersionRecords']) || count($results['nonExistingRecords'])) {
+            $io->note([
+                'Found ' . count($results['nonExistingRecords']) . ' references to non-existing records ' .
+                'and ' . count($results['offlineVersionRecords']) . ' references directly linked to offline versions.'
+            ]);
+
+            $this->removeReferencesToMissingRecords(
+                $results['offlineVersionRecords'],
+                $results['nonExistingRecords'],
+                $dryRun, $io);
+            $io->success('All references were updated accordingly.');
+        } else {
+            $io->success('Nothing to do, no missing relations found. Everything is in place.');
+        }
+    }
+
+    /**
+     * Function to update the reference index
+     * - if the option --update-refindex is set, do it
+     * - otherwise, if in interactive mode (not having -n set), ask the user
+     * - otherwise assume everything is fine
+     *
+     * @param InputInterface $input holds information about entered parameters
+     * @param SymfonyStyle $io necessary for outputting information
+     * @return void
+     */
+    protected function updateReferenceIndex(InputInterface $input, SymfonyStyle $io)
+    {
+        // Check for reference index to update
+        $io->note('Finding missing records referenced by TYPO3 requires a clean reference index (sys_refindex)');
+        if ($input->hasOption('update-refindex') && $input->getOption('update-refindex')) {
+            $updateReferenceIndex = true;
+        } elseif ($input->isInteractive()) {
+            $updateReferenceIndex = $io->confirm('Should the reference index be updated right now?', false);
+        } else {
+            $updateReferenceIndex = false;
+        }
+
+        // Update the reference index
+        if ($updateReferenceIndex) {
+            $referenceIndex = GeneralUtility::makeInstance(ReferenceIndex::class);
+            $referenceIndex->updateIndex(false, !$io->isQuiet());
+        } else {
+            $io->writeln('Reference index is assumed to be up to date, continuing.');
+        }
+    }
+
+    /**
+     * Find relations pointing to non-existing records (in managed references or soft-references)
+     *
+     * @return array an array of records within sys_refindex
+     */
+    protected function findRelationsToNonExistingRecords(): array
+    {
+        $deletedRecords = [];
+        $deletedRecordsInSoftReferenceRelations = [];
+        $nonExistingRecords = [];
+        $nonExistingRecordsInSoftReferenceRelations = [];
+        $offlineVersionRecords = [];
+        $offlineVersionRecordsInSoftReferenceRelations = [];
+
+        // Select DB relations from reference table
+        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('sys_refindex');
+        $rowIterator = $queryBuilder
+            ->select('ref_uid', 'ref_table', 'softref_key', 'hash', 'tablename', 'recuid', 'field', 'flexpointer', 'deleted')
+            ->from('sys_refindex')
+            ->where(
+                $queryBuilder->expr()->neq('ref_table', $queryBuilder->createNamedParameter('_FILE', \PDO::PARAM_STR)),
+                $queryBuilder->expr()->gt('ref_uid', $queryBuilder->createNamedParameter(0, \PDO::PARAM_INT))
+            )
+            ->execute();
+
+        $existingRecords = [];
+        while ($rec = $rowIterator->fetch()) {
+            $isSoftReference = !empty($rec['softref_key']);
+            $idx = $rec['ref_table'] . ':' . $rec['ref_uid'];
+            // Get referenced record:
+            if (!isset($existingRecords[$idx])) {
+                $existingRecords[$idx] = BackendUtility::getRecordRaw(
+                    $rec['ref_table'],
+                    'uid=' . (int)$rec['ref_uid'],
+                    'uid,pid' . (isset($GLOBALS['TCA'][$rec['ref_table']]['ctrl']['delete']) ? ',' . $GLOBALS['TCA'][$rec['ref_table']]['ctrl']['delete'] : '')
+                );
+            }
+            // Compile info string for location of reference:
+            $infoString = $this->formatReferenceIndexEntryToString($rec);
+            // Handle missing file:
+            if ($existingRecords[$idx]['uid']) {
+                // Record exists, but is a reference to an offline version
+                if ((int)$existingRecords[$idx]['pid'] === -1) {
+                    if ($isSoftReference) {
+                        $offlineVersionRecordsInSoftReferenceRelations[] = $infoString;
+                    } else {
+                        $offlineVersionRecords[$idx][$rec['hash']] = $infoString;
+                    }
+                    // reference to a deleted record
+                } elseif (isset($GLOBALS['TCA'][$rec['ref_table']]['ctrl']['delete']) && $existingRecords[$idx][$GLOBALS['TCA'][$rec['ref_table']]['ctrl']['delete']]) {
+                    if ($isSoftReference) {
+                        $deletedRecordsInSoftReferenceRelations[] = $infoString;
+                    } else {
+                        $deletedRecords[] = $infoString;
+                    }
+                }
+            } else {
+                if ($isSoftReference) {
+                    $nonExistingRecordsInSoftReferenceRelations[] = $infoString;
+                } else {
+                    $nonExistingRecords[$idx][$rec['hash']] = $infoString;
+                }
+            }
+        }
+
+        return [
+            // Non-existing records to which there are references (managed)
+            // These references can safely be removed since there is no record found in the database at all.
+            'nonExistingRecords' => ArrayUtility::sortByKeyRecursive($nonExistingRecords),
+            // Non-existing records to which there are references (softref)
+            'nonExistingRecordsInSoftReferenceRelations' => ArrayUtility::sortByKeyRecursive($nonExistingRecordsInSoftReferenceRelations),
+            // Offline version records (managed)
+            // These records are offline versions having a pid=-1 and references should never occur directly to their uids.
+            'offlineVersionRecords' => ArrayUtility::sortByKeyRecursive($offlineVersionRecords),
+            // Offline version records (softref)
+            'offlineVersionRecordsInSoftReferenceRelations' => ArrayUtility::sortByKeyRecursive($offlineVersionRecordsInSoftReferenceRelations),
+            // Deleted-flagged records (managed)
+            // These records are deleted with a flag but references are still pointing at them.
+            // Keeping the references is useful if you undelete the referenced records later, otherwise the references
+            // are lost completely when the deleted records are flushed at some point. Notice that if those records listed
+            // are themselves deleted (marked with "DELETED") it is not a problem.
+            'deletedRecords' => ArrayUtility::sortByKeyRecursive($deletedRecords),
+            // Deleted-flagged records (softref)
+            'deletedRecordsInSoftReferenceRelations' => ArrayUtility::sortByKeyRecursive($deletedRecordsInSoftReferenceRelations),
+        ];
+    }
+
+    /**
+     * Removes all references to non-existing records or offline versions
+     *
+     * @param array $offlineVersionRecords Contains the records of offline versions of sys_refindex which need to be removed
+     * @param array $nonExistingRecords Contains the records non-existing records of sys_refindex which need to be removed
+     * @param bool $dryRun if set, the references are just displayed, but not removed
+     * @param SymfonyStyle $io the IO object for output
+     * @return void
+     */
+    protected function removeReferencesToMissingRecords(
+        array $offlineVersionRecords,
+        array $nonExistingRecords,
+        bool $dryRun,
+        SymfonyStyle $io
+    ) {
+        // Remove references to offline records
+        foreach ($offlineVersionRecords as $fileName => $references) {
+            if ($io->isVeryVerbose()) {
+                $io->writeln('Removing references in offline versions which there are references pointing towards.');
+            }
+            foreach ($references as $hash => $recordReference) {
+                $io->writeln('Removing reference in record "' . $recordReference . '" (Hash: ' . $hash . ')');
+                if (!$dryRun) {
+                    $sysRefObj = GeneralUtility::makeInstance(ReferenceIndex::class);
+                    $error = $sysRefObj->setReferenceValue($hash, null);
+                    if ($error) {
+                        $io->error('ReferenceIndex::setReferenceValue() reported "' . $error . '"');
+                    }
+                }
+            }
+        }
+
+        // Remove references to non-existing records
+        foreach ($nonExistingRecords as $fileName => $references) {
+            if ($io->isVeryVerbose()) {
+                $io->writeln('Removing references to non-existing records.');
+            }
+            foreach ($references as $hash => $recordReference) {
+                $io->writeln('Removing reference in record "' . $recordReference . '" (Hash: ' . $hash . ')');
+                if (!$dryRun) {
+                    $sysRefObj = GeneralUtility::makeInstance(ReferenceIndex::class);
+                    $error = $sysRefObj->setReferenceValue($hash, null);
+                    if ($error) {
+                        $io->error('ReferenceIndex::setReferenceValue() reported "' . $error . '"');
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * Formats a sys_refindex entry to something readable
+     *
+     * @param array $record
+     * @return string
+     */
+    protected function formatReferenceIndexEntryToString(array $record): string
+    {
+        return $record['tablename']
+            . ':' . $record['recuid']
+            . ':' . $record['field']
+            . ($record['flexpointer'] ? ':' . $record['flexpointer'] : '')
+            . ($record['softref_key'] ? ':' . $record['softref_key'] . ' (Soft Reference) ' : '')
+            . ($record['deleted'] ? ' (DELETED)' : '');
+    }
+}
diff --git a/typo3/sysext/lowlevel/Classes/MissingFilesCommand.php b/typo3/sysext/lowlevel/Classes/MissingFilesCommand.php
deleted file mode 100644 (file)
index 0e43e80..0000000
+++ /dev/null
@@ -1,142 +0,0 @@
-<?php
-namespace TYPO3\CMS\Lowlevel;
-
-/*
- * 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\Database\ConnectionPool;
-use TYPO3\CMS\Core\Database\ReferenceIndex;
-use TYPO3\CMS\Core\Utility\GeneralUtility;
-
-/**
- * Looking for missing files.
- */
-class MissingFilesCommand extends CleanerCommand
-{
-    /**
-     * @var bool
-     */
-    public $checkRefIndex = true;
-
-    /**
-     * Constructor
-     */
-    public function __construct()
-    {
-        parent::__construct();
-        // Setting up help:
-        $this->cli_help['name'] = 'missing_files -- Find all file references from records pointing to a missing (non-existing) file.';
-        $this->cli_help['description'] = trim('
-Assumptions:
-- a perfect integrity of the reference index table (always update the reference index table before using this tool!)
-- relevant soft reference parsers applied everywhere file references are used inline
-
-Files may be missing for these reasons (except software bugs):
-- someone manually deleted the file inside fileadmin/ or another user maintained folder. If the reference was a soft reference (opposite to a DataHandler managed file relation from "group" type fields), technically it is not an error although it might be a mistake that someone did so.
-- someone manually deleted the file inside the uploads/ folder (typically containing managed files) which is an error since no user interaction should take place there.
-
-Automatic Repair of Errors:
-- Managed files (TCA/FlexForm attachments): Will silently remove the reference from the record since the file is missing. For this reason you might prefer a manual approach instead.
-- Soft References: Requires manual fix if you consider it an error.
-
-Manual repair suggestions:
-- Managed files: You might be able to locate the file and re-insert it in the correct location. However, no automatic fix can do that for you.
-- Soft References: You should investigate each case and edit the content accordingly. A soft reference to a file could be in an HTML image tag (for example <img src="missing_file.jpg" />) and you would have to either remove the whole tag, change the filename or re-create the missing file.
-');
-        $this->cli_help['examples'] = '/.../cli_dispatch.phpsh lowlevel_cleaner missing_files -s -r
-This will show you missing files in the TYPO3 system and only report back if errors were found.';
-    }
-
-    /**
-     * Find file references that points to non-existing files in system
-     * Fix methods: API in \TYPO3\CMS\Core\Database\ReferenceIndex that allows to
-     * change the value of a reference (or remove it)
-     *
-     * @return array
-     */
-    public function main()
-    {
-        // Initialize result array:
-        $listExplain = ' Shows the relative filename of missing file as header and under a list of record fields in which the references are found. ' . $this->label_infoString;
-        $resultArray = [
-            'message' => $this->cli_help['name'] . LF . LF . $this->cli_help['description'],
-            'headers' => [
-                'managedFilesMissing' => ['List of missing files managed by DataHandler', $listExplain, 3],
-                'softrefFilesMissing' => ['List of missing files registered as a soft reference', $listExplain, 2]
-            ],
-            'managedFilesMissing' => [],
-            'softrefFilesMissing' => []
-        ];
-        // Select all files in the reference table
-        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
-            ->getQueryBuilderForTable('sys_refindex');
-
-        $result = $queryBuilder
-            ->select('*')
-            ->from('sys_refindex')
-            ->where(
-                $queryBuilder->expr()->eq('ref_table', $queryBuilder->createNamedParameter('_FILE', \PDO::PARAM_STR))
-            )
-            ->orderBy('sorting', 'DESC')
-            ->execute();
-        // Traverse the files and put into a large table:
-        while ($rec = $result->fetch()) {
-            // Compile info string for location of reference:
-            $infoString = $this->infoStr($rec);
-            // Handle missing file:
-            if (!@is_file((PATH_site . $rec['ref_string']))) {
-                if ((string)$rec['softref_key'] == '') {
-                    $resultArrayIndex = 'managedFilesMissing';
-                } else {
-                    $resultArrayIndex = 'softrefFilesMissing';
-                }
-                $resultArray[$resultArrayIndex][$rec['ref_string']][$rec['hash']] = $infoString;
-                ksort($resultArray[$resultArrayIndex][$rec['ref_string']]);
-            }
-        }
-
-        ksort($resultArray['managedFilesMissing']);
-        ksort($resultArray['softrefFilesMissing']);
-        return $resultArray;
-    }
-
-    /**
-     * Mandatory autofix function
-     * Will run auto-fix on the result array. Echos status during processing.
-     *
-     * @param array $resultArray Result array from main() function
-     * @return void
-     */
-    public function main_autoFix($resultArray)
-    {
-        foreach ($resultArray['managedFilesMissing'] as $key => $value) {
-            echo 'Processing file: ' . $key . LF;
-            foreach ($value as $hash => $recReference) {
-                echo ' Removing reference in record "' . $recReference . '": ';
-                if ($bypass = $this->cli_noExecutionCheck($recReference)) {
-                    echo $bypass;
-                } else {
-                    $sysRefObj = GeneralUtility::makeInstance(ReferenceIndex::class);
-                    $error = $sysRefObj->setReferenceValue($hash, null);
-                    if ($error) {
-                        echo '         TYPO3\\CMS\\Core\\Database\\ReferenceIndex::setReferenceValue(): ' . $error . LF;
-                        echo 'missing_files: exit on error' . LF;
-                        die;
-                    } else {
-                        echo 'DONE';
-                    }
-                }
-                echo LF;
-            }
-        }
-    }
-}
diff --git a/typo3/sysext/lowlevel/Classes/MissingRelationsCommand.php b/typo3/sysext/lowlevel/Classes/MissingRelationsCommand.php
deleted file mode 100644 (file)
index 1f84050..0000000
+++ /dev/null
@@ -1,170 +0,0 @@
-<?php
-namespace TYPO3\CMS\Lowlevel;
-
-/*
- * 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;
-use TYPO3\CMS\Core\Database\ConnectionPool;
-use TYPO3\CMS\Core\Database\ReferenceIndex;
-use TYPO3\CMS\Core\Utility\GeneralUtility;
-
-/**
- * Looking for missing relations.
- */
-class MissingRelationsCommand extends CleanerCommand
-{
-    /**
-     * @var bool
-     */
-    public $checkRefIndex = true;
-
-    /**
-     * Constructor
-     */
-    public function __construct()
-    {
-        parent::__construct();
-        // Setting up help:
-        $this->cli_help['name'] = 'missing_relations -- Find all record references pointing to a non-existing record.';
-        $this->cli_help['description'] = trim('
-Assumptions:
-- a perfect integrity of the reference index table (always update the reference index table before using this tool!)
-- all database references to check are integers greater than zero
-- does not check if a referenced record is inside an offline branch, another workspace etc. which could make the reference useless in reality or otherwise question integrity
-Records may be missing for these reasons (except software bugs):
-- someone deleted the record which is technically not an error although it might be a mistake that someone did so.
-- after flushing published versions and/or deleted-flagged records a number of new missing references might appear; those were pointing to records just flushed.
-
-Automatic Repair of Errors:
-- Only managed references are repaired (TCA-configured).
-- Offline Version Records and Non Existing Records: Reference is removed
-
-Manual repair suggestions:
-- For soft references you should investigate each case and edit the content accordingly.
-- References to deleted records can theoretically be removed since a deleted record cannot be selected and hence your website should not be affected by removal of the reference. On the other hand it does not hurt to ignore it for now. To have this automatically fixed you must first flush the deleted records after which remaining references will appear as pointing to Non Existing Records and can now be removed with the automatic fix.
-
-NOTICE: Uses the Reference Index Table (sys_refindex) for analysis. Update it before use!
-');
-        $this->cli_help['examples'] = '/.../cli_dispatch.phpsh lowlevel_cleaner missing_relations -s -r
-Reports missing relations';
-    }
-
-    /**
-     * Find relations pointing to non-existing records
-     * Fix methods: API in \TYPO3\CMS\Core\Database\ReferenceIndex that allows to
-     * change the value of a reference (or remove it) [Only for managed relations!]
-     *
-     * @return array
-     */
-    public function main()
-    {
-        // Initialize result array:
-        $listExplain = ' Shows the missing record as header and underneath a list of record fields in which the references are found. ' . $this->label_infoString;
-        $resultArray = [
-            'message' => $this->cli_help['name'] . LF . LF . $this->cli_help['description'],
-            'headers' => [
-                'offlineVersionRecords_m' => ['Offline version records (managed)', 'These records are offline versions having a pid=-1 and references should never occur directly to their uids.' . $listExplain, 3],
-                'deletedRecords_m' => ['Deleted-flagged records (managed)', 'These records are deleted with a flag but references are still pointing at them. Keeping the references is useful if you undelete the referenced records later, otherwise the references are lost completely when the deleted records are flushed at some point. Notice that if those records listed are themselves deleted (marked with "DELETED") it is not a problem.' . $listExplain, 2],
-                'nonExistingRecords_m' => ['Non-existing records to which there are references (managed)', 'These references can safely be removed since there is no record found in the database at all.' . $listExplain, 3],
-                // 3 = error
-                'offlineVersionRecords_s' => ['Offline version records (softref)', 'See above.' . $listExplain, 2],
-                'deletedRecords_s' => ['Deleted-flagged records (softref)', 'See above.' . $listExplain, 2],
-                'nonExistingRecords_s' => ['Non-existing records to which there are references (softref)', 'See above.' . $listExplain, 2]
-            ],
-            'offlineVersionRecords_m' => [],
-            'deletedRecords_m' => [],
-            'nonExistingRecords_m' => [],
-            'offlineVersionRecords_s' => [],
-            'deletedRecords_s' => [],
-            'nonExistingRecords_s' => []
-        ];
-
-        // Select DB relations from reference table
-        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('sys_refindex');
-        $rowIterator = $queryBuilder
-            ->select('ref_uid', 'ref_table', 'softref_key', 'hash', 'tablename', 'recuid', 'field', 'flexpointer', 'deleted')
-            ->from('sys_refindex')
-            ->where(
-                $queryBuilder->expr()->neq('ref_table', $queryBuilder->createNamedParameter('_FILE', \PDO::PARAM_STR)),
-                $queryBuilder->expr()->gt('ref_uid', $queryBuilder->createNamedParameter(0, \PDO::PARAM_INT))
-            )
-            ->orderBy('sorting', 'DESC')
-            ->execute();
-
-        $tempExists = [];
-        while ($rec = $rowIterator->fetch()) {
-            $suffix = $rec['softref_key'] != '' ? '_s' : '_m';
-            $idx = $rec['ref_table'] . ':' . $rec['ref_uid'];
-            // Get referenced record:
-            if (!isset($tempExists[$idx])) {
-                $tempExists[$idx] = BackendUtility::getRecordRaw($rec['ref_table'], 'uid=' . (int)$rec['ref_uid'], 'uid,pid' . ($GLOBALS['TCA'][$rec['ref_table']]['ctrl']['delete'] ? ',' . $GLOBALS['TCA'][$rec['ref_table']]['ctrl']['delete'] : ''));
-            }
-            // Compile info string for location of reference:
-            $infoString = $this->infoStr($rec);
-            // Handle missing file:
-            if ($tempExists[$idx]['uid']) {
-                if ($tempExists[$idx]['pid'] == -1) {
-                    $resultArray['offlineVersionRecords' . $suffix][$idx][$rec['hash']] = $infoString;
-                    ksort($resultArray['offlineVersionRecords' . $suffix][$idx]);
-                } elseif ($GLOBALS['TCA'][$rec['ref_table']]['ctrl']['delete'] && $tempExists[$idx][$GLOBALS['TCA'][$rec['ref_table']]['ctrl']['delete']]) {
-                    $resultArray['deletedRecords' . $suffix][$idx][$rec['hash']] = $infoString;
-                    ksort($resultArray['deletedRecords' . $suffix][$idx]);
-                }
-            } else {
-                $resultArray['nonExistingRecords' . $suffix][$idx][$rec['hash']] = $infoString;
-                ksort($resultArray['nonExistingRecords' . $suffix][$idx]);
-            }
-        }
-
-        ksort($resultArray['offlineVersionRecords_m']);
-        ksort($resultArray['deletedRecords_m']);
-        ksort($resultArray['nonExistingRecords_m']);
-        ksort($resultArray['offlineVersionRecords_s']);
-        ksort($resultArray['deletedRecords_s']);
-        ksort($resultArray['nonExistingRecords_s']);
-        return $resultArray;
-    }
-
-    /**
-     * Mandatory autofix function
-     * Will run auto-fix on the result array. Echos status during processing.
-     *
-     * @param array $resultArray Result array from main() function
-     * @return void
-     */
-    public function main_autoFix($resultArray)
-    {
-        $trav = ['offlineVersionRecords_m', 'nonExistingRecords_m'];
-        foreach ($trav as $tk) {
-            echo 'Processing managed "' . $tk . '"...' . LF;
-            foreach ($resultArray[$tk] as $key => $value) {
-                foreach ($value as $hash => $recReference) {
-                    echo '     Removing reference to ' . $key . ' in record "' . $recReference . '": ';
-                    if ($bypass = $this->cli_noExecutionCheck($recReference)) {
-                        echo $bypass;
-                    } else {
-                        $sysRefObj = GeneralUtility::makeInstance(ReferenceIndex::class);
-                        $error = $sysRefObj->setReferenceValue($hash, null);
-                        if ($error) {
-                            echo '             TYPO3\\CMS\\Core\\Database\\ReferenceIndex::setReferenceValue(): ' . $error . LF;
-                        } else {
-                            echo 'DONE';
-                        }
-                    }
-                    echo LF;
-                }
-            }
-        }
-    }
-}
index 1b0ae33..c5b563d 100644 (file)
@@ -20,6 +20,11 @@ return [
         // needed for updating the reference index (optional)
         'user' => '_cli_lowlevel'
     ],
+    'cleanup:missingrelations' => [
+        'class' => \TYPO3\CMS\Lowlevel\Command\MissingRelationsCommand::class,
+        // needed for updating the reference index (optional)
+        'user' => '_cli_lowlevel'
+    ],
     'cleanup:deletedrecords' => [
         'class' => \TYPO3\CMS\Lowlevel\Command\DeletedRecordsCommand::class,
         'user' => '_cli_lowlevel'
index 1f14199..204cf8e 100644 (file)
@@ -10,7 +10,6 @@ if (TYPO3_MODE === 'BE') {
         },
         '_CLI_lowlevel'
     ];
-    $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['lowlevel']['cleanerModules']['missing_relations'] = [\TYPO3\CMS\Lowlevel\MissingRelationsCommand::class];
     $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['lowlevel']['cleanerModules']['double_files'] = [\TYPO3\CMS\Lowlevel\DoubleFilesCommand::class];
     $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['lowlevel']['cleanerModules']['rte_images'] = [\TYPO3\CMS\Lowlevel\RteImagesCommand::class];
     $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['lowlevel']['cleanerModules']['versions'] = [\TYPO3\CMS\Lowlevel\VersionsCommand::class];