BackendAdminController::changeClientAction() - Code Metrics - Inspection of "Moving a document from one client into another." - kitodo/kitodo-publication - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#209)

unknown
created 2021-06-09 12:45 UTC
BackendAdminController::changeClientAction() B

↳ Parent: BackendAdminController
Complexity

Conditions	7
Paths	4
Size

Total Lines	94
Code Lines	60
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	60
c	1
b	0
f	0
dl	0
loc	94
rs	7.9393
cc	7
nc	4
nop	4
How to fix Long Method

<?php
namespace EWW\Dpf\Controller;

/*
 * 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 EWW\Dpf\Domain\Model\Bookmark;
use EWW\Dpf\Domain\Model\Client;
use EWW\Dpf\Domain\Model\Document;
use EWW\Dpf\Domain\Model\DocumentType;
use EWW\Dpf\Domain\Workflow\DocumentWorkflow;
use EWW\Dpf\Helper\DocumentMapper;
use EWW\Dpf\Helper\InternalFormat;
use EWW\Dpf\Services\ElasticSearch\ElasticSearch;
use EWW\Dpf\Services\ProcessNumber\ProcessNumberGenerator;
use TYPO3\CMS\Backend\View\BackendTemplateView;
use TYPO3\CMS\Core\Messaging\AbstractMessage;
use TYPO3\CMS\Extbase\Mvc\View\ViewInterface;
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;

/**
* Backend module user/group action controller
*/
class BackendAdminController extends ActionController
{
    /**
     * documentRepository
     *
     * @var \EWW\Dpf\Domain\Repository\DocumentRepository
     * @TYPO3\CMS\Extbase\Annotation\Inject
     */
    protected $documentRepository = null;

    /**
     * fileRepository
     *
     * @var \EWW\Dpf\Domain\Repository\FileRepository
     * @TYPO3\CMS\Extbase\Annotation\Inject
     */
    protected $fileRepository = null;

    /**
     * documentTypeRepository
     *
     * @var \EWW\Dpf\Domain\Repository\DocumentTypeRepository
     * @TYPO3\CMS\Extbase\Annotation\Inject
     */
    protected $documentTypeRepository = null;

    /**
     * bookmarkRepository
     *
     * @var \EWW\Dpf\Domain\Repository\BookmarkRepository
     * @TYPO3\CMS\Extbase\Annotation\Inject
     */
    protected $bookmarkRepository = null;

    /**
     * frontendUserRepository
     *
     * @var \EWW\Dpf\Domain\Repository\FrontendUserRepository
     * @TYPO3\CMS\Extbase\Annotation\Inject
     */
    protected $frontendUserRepository = null;

    /**
     * clientRepository
     *
     * @var \EWW\Dpf\Domain\Repository\ClientRepository
     * @TYPO3\CMS\Extbase\Annotation\Inject
     */
    protected $clientRepository = null;

    /**
    * Backend Template Container
    *
    * @var string
    */
    protected $defaultViewObjectName = BackendTemplateView::class;

    /**
     * Set up the doc header properly here
     *
     * @param ViewInterface $view
     * @return void
     */
    protected function initializeView(ViewInterface $view)
    {
        /** @var BackendTemplateView $view */
        parent::initializeView($view);
        if ($this->actionMethodName == 'indexAction'
            || $this->actionMethodName == 'onlineAction'
            || $this->actionMethodName == 'compareAction') {
            $this->generateMenu();
                   generateMenu();
            $this->registerDocheaderButtons();
                   registerDocheaderButtons();
            $view->getModuleTemplate()->setFlashMessageQueue($this->controllerContext->getFlashMessageQueue());
        }
        if ($view instanceof BackendTemplateView) {

            $view->getModuleTemplate()->getPageRenderer()->loadRequireJsModule('TYPO3/CMS/Backend/Modal');
        }
    }

    /**
     * @param string $identifier
     */
    public function searchDocumentAction(string $identifier = '')
    {
        $identifier = trim($identifier);
        $this->view->assign('identifier', $identifier);

        if ($identifier) {

            $this->documentRepository->crossClient(true);

            /** @var Document $document */
            $document = $this->documentRepository->findByIdentifier($identifier);

            if ($document) {

                /** @var Client $client */
                $client = $this->clientRepository->findAllByPid($document->getPid())->current();
                $this->view->assign('document', $document);
                $this->view->assign('clientName', $client->getClient());
            } else {
                $this->flashMessage(
                    'nothing_found',
                    'nothing_found_message',
                    AbstractMessage::ERROR,
                    [],
                    [$identifier]
                );
            }
        }
    }

    /**
     * @param Document $document
     * @param string $identifier
     */
    public function chooseNewClientAction(Document $document, string $identifier)
    {
        if ($document) {

            if ($this->canChangeClient($document)) {
                /** @var Client $currentClient */
                $currentClient = $this->clientRepository->findAllByPid($document->getPid())->current();

                $allClients = $this->clientRepository->crossClientFindAll(false);

                $documentTypes = [];
                $clients = [];

                /** @var Client $client */
                foreach ($allClients as $client) {
                    if ($client->getUid() != $currentClient->getUid()) {
                        $clients[] = $client;
                        $this->documentTypeRepository->crossClient(true);
                        $documentTypes[$client->getPid()] = $this->documentTypeRepository->findByPid($client->getPid());
                        $documentTypes[$client->getPid()] = $this->documentTypeRepository->findByPid($client->getPid());
                    }
                }

                $this->view->assign('canMoveDocument', $this->canChangeClient($document));
                $this->view->assign('document', $document);
                $this->view->assign('clients', $clients);
                $this->view->assign('documentTypes', $documentTypes);
                $this->view->assign('currentClient', $currentClient);
                $this->view->assign('identifier', $identifier);
            } else {
                $this->flashMessage(
                    'change_client_forbidden',
                    'change_client_forbidden_message',
                    AbstractMessage::ERROR,
                    [],
                    [$identifier]
                );

                $this->forward(
                    'searchDocument',
                    null,
                    null,
                    [
                        'identifier' => $identifier
                    ]
                );
            }
        }
    }

    /**
     * @param Document $document
     * @param Client $client
     * @param string $identifier
     * @param DocumentType $documentType
     */
    public function changeClientAction(Document $document, Client $client, string $identifier, DocumentType $documentType = null)
    {
        if ($documentType instanceof DocumentType) {
            if ($this->canChangeClient($document)) {

                /** @var Client $currentClient */
                $currentClient = $this->clientRepository->findAllByPid($document->getPid())->current();

                // Move the document to the target client
                // Fixme: How should the creator be dealt with?
                // $document->setCreator();
                $document->setPid($client->getPid());
                $document->setDocumentType($documentType);
                $documentMapper = $this->objectManager->get(DocumentMapper::class);
                $documentMapper->setClientPid($client->getPid());
                $documentForm = $documentMapper->getDocumentForm($document);
                $document = $documentMapper->getDocument($documentForm);
                $internalFormat = new InternalFormat($document->getXmlData(), $client->getPid());
                $internalFormat->setDocumentType($documentType->getName());
                $document->setXmlData($internalFormat->getXml());

                if ($client->getOwnerId()) {
                    /** @var ProcessNumberGenerator $processNumberGenerator */
                    $processNumberGenerator = $this->objectManager->get(ProcessNumberGenerator::class);
                    $processNumber = $processNumberGenerator->getProcessNumber($client->getOwnerId());
                    $document->setProcessNumber($processNumber);
                } else {
                    throw new \Exception('Missing client configuration: "owner id"');
                }

                $this->documentRepository->update($document);

                // Move files to the target client
                $files = $document->getFile();
                foreach ($files as $file) {
                    $file->setPid($client->getPid());
                    $this->fileRepository->update($file);
                }

                // If there are bookmarks, they have to be adjusted, depending on the existence of the related user
                // inside the target client, and either deleted or moved to the target client.
                $this->bookmarkRepository->crossClient(true);
                $bookmarks = $this->bookmarkRepository->findDocumentBookmarks($document);
                /** @var Bookmark $bookmark */
                foreach ($bookmarks as $bookmark) {
                    if ($this->frontendUserRepository->isUserInClient($bookmark->getFeUserUid(), $client->getPid())) {
                        $bookmark->setPid($client->getPid());
                        $this->bookmarkRepository->update($bookmark);
                    } else {
                        $this->bookmarkRepository->remove($bookmark);
                    }
                }

                // Move document into the target search index.
                $elasticSearch = new ElasticSearch($currentClient->getPid());
                $elasticSearch->delete($document->getDocumentIdentifier());
                $targetElasticSearch = new ElasticSearch($client->getPid());
                $targetElasticSearch->index($document);

                $this->flashMessage(
                   'client_changed',
                   'client_changed_message',
                   AbstractMessage::OK,
                   [],
                   [$identifier]
                );
           } else {
               $this->flashMessage(
                   'change_client_forbidden',
                   'change_client_forbidden_message',
                   AbstractMessage::ERROR,
                   [],
                   [$identifier]
               );
           }

           $this->view->assign('currentClient', $client);
           $this->view->assign('document', $document);
       } else {
            $this->flashMessage(
                'missing_document_type',
                'missing_document_type_message',
                AbstractMessage::ERROR,
                [],
                [$identifier]
            );

            $this->forward(
              'chooseNewClient',
              null,
              null,
              [
                  'document' => $document,
                  'identifier' => $identifier
              ]
            );
       }
    }

    /**
     * @param Document $document
     */
    protected function canChangeClient(Document $document)
    {
        return (
            in_array(
             $document->getState(),
             [
                 DocumentWorkflow::STATE_REGISTERED_NONE,
                 DocumentWorkflow::STATE_IN_PROGRESS_NONE,
                 DocumentWorkflow::STATE_POSTPONED_NONE,
                 DocumentWorkflow::STATE_DISCARDED_NONE
             ]
            )
        );
    }

    /**
     * flashMessage
     *
     * @param string $headerKey
     * @param string $bodyKey
     * @param array $headerArguments
     * @param array $bodyArguments
     * @param int $severity
     * @param bool $storeInSession
     */
    protected function flashMessage(
        string $headerKey,
        string $bodyKey,
        int $severity = AbstractMessage::INFO,
        array $headerArguments,
        array $bodyArguments,
        bool $storeInSession = false
    )
    {
        $messageHeader = LocalizationUtility::translate(
            'LLL:EXT:dpf/Resources/Private/Language/locallang_mod.xlf:admin_module.'.$headerKey,
            'dpf',
            $headerArguments
        );

        $messageBody = LocalizationUtility::translate(
            'LLL:EXT:dpf/Resources/Private/Language/locallang_mod.xlf:admin_module.'.$bodyKey,
            'dpf',
            $bodyArguments
        );

        $this->addFlashMessage($messageBody, $messageHeader, $severity, $storeInSession);
    }

}

kitodo / kitodo-publication

Pull Request — master (#209)

BackendAdminController::changeClientAction() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like
