Fab\Media\Command\DuplicateRecordsCommandController

Complexity

Total Complexity

20

Size/Duplication

Total Lines	191
Duplicated Lines	100 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
B	analyseCommand()	51	51	7
A	printOut()	5	5	1
A	sendReport()	22	22	3
A	hasReport()	4	4	1
A	getTo()	14	14	2
A	getFrom()	13	13	2
A	getStorageRepository()	4	4	1
A	getMailMessage()	7	7	2
A	getIndexAnalyser()	4	4	1

<?php
namespace Fab\Media\Command;

/*
 * This file is part of the Fab/Media project under GPLv2 or later.
 *
 * For the full copyright and license information, please read the
 * LICENSE.md file that was distributed with this source code.
 */

use TYPO3\CMS\Core\Resource\StorageRepository;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Mvc\Controller\CommandController;

/**
 * Command Controller which handles actions related to File Index.
 */
class DuplicateRecordsCommandController extends CommandController

This class seems to be duplicated in your project.

{

    /**
     * @var array
     */
    protected $message = [];

    /**
     * @var array
     */
    protected $duplicateRecords = [];

    /**
     * @var \TYPO3\CMS\Core\Mail\MailMessage
     */
    protected $mailMessage;

    /**
     * Check whether the Index is Ok. In case not, display a message on the console.
     *
     * @return void
     */
    public function analyseCommand()
    {

        foreach ($this->getStorageRepository()->findAll() as $storage) {

            // For the CLI cause.
            $storage->setEvaluatePermissions(false);

            $this->printOut();
            $this->printOut(sprintf('%s (%s)', $storage->getName(), $storage->getUid()));
            $this->printOut('--------------------------------------------');

            if ($storage->isOnline()) {

                $duplicateRecords = $this->getIndexAnalyser()->searchForDuplicateIdentifiers($storage);

                // Duplicate file object
                if (empty($duplicateRecords)) {
                    $this->printOut();
                    $this->printOut('Looks good, no duplicate records!');
                } else {
                    $this->printOut();
                    $this->printOut('Duplicated identifiers detected:');
                    $this->duplicateRecords[$storage->getUid()] = $duplicateRecords; // Store duplicate files.

                    foreach ($duplicateRecords as $identifier => $duplicate) {

                        // build temporary array
                        $uids = [];
                        foreach ($duplicate as $value) {
                            $uids[] = $value['uid'];
                        }

                        $message = sprintf('* uids "%s" having same identifier %s',
                            implode(',', $uids),
                            $identifier
                        );
                        $this->printOut($message);

                    }
                }
            } else {
                $this->outputLine('Storage is offline!');
            }
        }

        $to = $this->getTo();
        if (!empty($to)) {
            $this->sendReport();
        }
    }

    /**
     * Print a message and store its content in a variable for the email report.
     *
     * @param string $message
     * @return void
     */
    protected function printOut($message = '')
    {
        $this->message[] = $message;
        $this->outputLine($message);
    }

    /**
     * Send a possible report to an admin.
     *
     * @throws \Exception
     * @return void
     */
    protected function sendReport()
    {
        if ($this->hasReport()) {

            // Prepare email.
            $this->getMailMessage()->setTo($this->getTo())
                ->setFrom($this->getFrom())
                ->setSubject('Duplicate records detected!')
                ->setBody(implode("\n", $this->message));

            $isSent = $this->getMailMessage()->send();

            if (!$isSent) {
                throw new \Exception('I could not send a message', 1408343882);
            }

            $to = $this->getTo();
            $this->outputLine();
            $message = sprintf('Report was sent to %s', key($to));
            $this->outputLine($message);
        }
    }

    /**
     * Send a report
     *
     * @return bool
     */
    protected function hasReport()
    {
        return !empty($this->duplicateRecords);
    }

    /**
     * @return array
     */
    protected function getTo()
    {

        $to = [];

        // @todo make me more flexible!
        if (!empty($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'])) {
            $emailAddress = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
            $name = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
            $to[$emailAddress] = $name;

        }
        return $to;
    }

    /**
     * @return array
     */
    protected function getFrom()
    {

        $from = [];

        // @todo make me more flexible!
        if (!empty($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'])) {
            $emailAddress = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
            $name = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
            $from[$emailAddress] = $name;
        }
        return $from;
    }

    /**
     * @return StorageRepository|object
     */
    protected function getStorageRepository()
    {
        return GeneralUtility::makeInstance(\TYPO3\CMS\Core\Resource\StorageRepository::class);
    }

    /**
     * @return \TYPO3\CMS\Core\Mail\MailMessage|object
     */
    public function getMailMessage()
    {
        if (is_null($this->mailMessage)) {
            $this->mailMessage = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Mail\MailMessage::class);
        }
        return $this->mailMessage;
    }

    /**
     * Return a pointer to the database.
     *
     * @return \Fab\Media\Index\IndexAnalyser|object
     */
    protected function getIndexAnalyser()
    {
        return GeneralUtility::makeInstance(\Fab\Media\Index\IndexAnalyser::class);
    }

}