eXpansion\Core\Plugins\GuiHandler

Complexity

Total Complexity

37

Size/Duplication

Total Lines	244
Duplicated Lines	12.7 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

100%

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	addToDisplay()	3	10	2
A	addToHide()	6	14	3
B	displayManialinks()	0	25	5
A	executeMultiCall()	0	9	2
D	getManialinksToDisplay()	0	34	11
A	onPostLoop()	0	4	1
A	onPreLoop()	0	3	1
A	onEverySecond()	0	3	1
A	onExpansionGroupAddUser()	11	11	3
A	onExpansionGroupRemoveUser()	11	11	3
A	onExpansionGroupDestroy()	0	6	2
A	getDisplayeds()	0	4	1
A	setCharLimit()	0	4	1

<?php

namespace eXpansion\Core\Plugins;

use eXpansion\Core\DataProviders\Listener\TimerDataListenerInterface;
use eXpansion\Core\DataProviders\Listener\UserGroupDataListenerInterface;
use eXpansion\Core\Model\Gui\ManialinkInerface;
use eXpansion\Core\Model\UserGroups\Group;
use eXpansion\Core\Services\Console;
use Maniaplanet\DedicatedServer\Connection;
use Maniaplanet\DedicatedServer\Xmlrpc\GbxRemote;
use Monolog\Logger;
use oliverde8\AssociativeArraySimplified\AssociativeArray;

/**
 * Class GuiHandler will send manialinks to player as needed.
 *
 * @package eXpansion\Core\Plugins\Gui
 * @author Oliver de Cramer
 */
class GuiHandler implements TimerDataListenerInterface, UserGroupDataListenerInterface
{
    /** @var Connection */
    protected $connection;

    /** @var Logger */
    protected $logger;

    /** @var Console */
    protected $console;

    /** @var int */
    protected $charLimit;

    /** @var ManialinkInerface[][] */
    protected $displayQueu = [];

    /** @var ManialinkInerface[][] */
    protected $individualQueu = [];

    /** @var ManialinkInerface[][] */
    protected $displayeds = [];

    /** @var ManialinkInerface[][] */
    protected $hideQueu = [];

    /** @var String[][] */
    protected $hideIndividualQueu = [];

    /**
     * GuiHandler constructor.
     *
     * @param Connection $connection
     */
    public function __construct(Connection $connection, Logger $logger, Console $console, $charLimit = 262144)
    {
        $this->connection = $connection;

        $this->connection->sendHideManialinkPage(null);

        $this->logger = $logger;
        $this->console = $console;
        $this->charLimit = $charLimit;
    }


    /**
     * Add a manialink to the diplay queue.
     *
     * @param ManialinkInerface $manialink
     */
    public function addToDisplay(ManialinkInerface $manialink)
    {
        $userGroup = $manialink->getUserGroup()->getName();

        if (AssociativeArray::getFromKey($this->hideQueu, [$userGroup, $manialink->getId()])) {

This code seems to be duplicated across your project.

            unset($this->hideQueu[$userGroup][$manialink->getId()]);
        }

        $this->displayQueu[$userGroup][$manialink->getId()] = $manialink;
    }

    /**
     * Add a manialink to the destruction queue.
     *
     * @param ManialinkInerface $manialink
     */
    public function addToHide(ManialinkInerface $manialink)
    {
        $userGroup = $manialink->getUserGroup()->getName();

        if (AssociativeArray::getFromKey($this->displayQueu, [$userGroup, $manialink->getId()])) {

This code seems to be duplicated across your project.

            unset($this->displayQueu[$userGroup][$manialink->getId()]);
        }

        if (AssociativeArray::getFromKey($this->displayeds, [$userGroup, $manialink->getId()])) {

This code seems to be duplicated across your project.

            unset($this->displayeds[$userGroup][$manialink->getId()]);
        }

        $this->hideQueu[$userGroup][$manialink->getId()] = $manialink;
    }

    /**
     * Display & hide all manialinks.
     */
    protected function displayManialinks()
    {
        $size = 0;
        foreach ($this->getManialinksToDisplay() as $mlData) {
            $currentSize = $size;
            $size += strlen($mlData['ml']);

            if ($currentSize != 0 && $size > $this->charLimit) {
                $this->executeMultiCall();
                $size = strlen($mlData['ml']);
            }

            $this->connection->sendDisplayManialinkPage($mlData['logins'], $mlData['ml'], 0, false, true);
        }

        if ($size > 0) {
            $this->executeMultiCall();
        }

        // Reset the queues.
        $this->displayQueu = [];
        $this->individualQueu = [];
        $this->hideQueu = [];
        $this->hideIndividualQueu = [];
    }

    /**
     * Execute multicall & handle error.
     */
    protected function executeMultiCall()
    {
        try {
            $this->connection->executeMulticall();
        } catch (\Exception $e) {
            $this->logger->addError("Couldn't deliver all manialinks : " . $e->getMessage(), ['exception' => $e]);
            $this->console->writeln('$F00ERROR - Couldn\'t deliver all manialinks : ' . $e->getMessage());
        }
    }

    /**
     * Get list of all manialinks that needs to be displayed
     *
     * @return \Generator
     */
    protected function getManialinksToDisplay()
    {
        foreach ($this->displayQueu as $groupName => $manialinks) {
            foreach ($manialinks as $id => $manialink) {
                $logins = $manialink->getUserGroup()->getLogins();
                if (!empty($logins)) {
                    yield ['logins' => $logins, 'ml' => $manialink->getXml()];
                    $this->displayeds[$groupName][$id] = $manialink;
                }
            }
        }

        foreach ($this->individualQueu as $login => $manialinks) {
            foreach ($manialinks as $id => $manialink) {
                $xml = $manialink->getXml();
                yield ['logins' => $login, 'ml' => $xml];
            }
        }

        foreach ($this->hideQueu as $manialinks) {
            foreach ($manialinks as $id => $manialink) {
                $logins = $manialink->getUserGroup()->getLogins();
                if (!empty($logins)) {
                    yield ['logins' => $logins, 'ml' => '<manialink id="' . $id . '" />'];
                }
            }
        }

        foreach ($this->hideIndividualQueu as $login => $manialinks) {
            foreach ($manialinks as $id => $manialink) {
                yield ['logins' => $login, 'ml' => '<manialink id="' . $id . '" />'];
            }
        }
    }

    /**
     * @inheritdoc
     */
    public function onPostLoop()
    {
        $this->displayManialinks();
    }

    /**
     * @inheritdoc
     */
    public function onPreLoop()
    {
    }

    /**
     * @inheritdoc
     */
    public function onEverySecond()
    {
    }

    /**
     * @inheritdoc
     */
    public function onExpansionGroupAddUser(Group $group, $loginAdded)

This method seems to be duplicated in your project.

    {
        $group = $group->getName();

        // User was added to group, need to display all manialinks of the group to this user
        if (isset($this->displayeds[$group])) {
            foreach ($this->displayeds[$group] as $mlId => $manialink) {
                $this->individualQueu[$loginAdded][$mlId] = $manialink;
            }
        }
    }

    /**
     * @inheritdoc
     */
    public function onExpansionGroupRemoveUser(Group $group, $loginRemoved)

This method seems to be duplicated in your project.

    {
        $group = $group->getName();

        // User was added to group, need to hide all manialinks of the group to this user
        if (isset($this->displayeds[$group])) {
            foreach ($this->displayeds[$group] as $mlId => $manialink) {
                $this->hideIndividualQueu[$loginRemoved][$mlId] = $manialink;
            }
        }
    }

    /**
     * @inheritdoc
     */
    public function onExpansionGroupDestroy(Group $group, $lastLogin)
    {
       if (isset($this->displayeds[$group->getName()])) {
           unset($this->displayeds[$group->getName()]);
       }
    }

    /**
     * List of all manialinks that are currentyl displayed.
     *
     * @return \eXpansion\Core\Model\Gui\ManialinkInerface[][]
     */
    public function getDisplayeds()
    {
        return $this->displayeds;
    }

    /**
     * @param int $charLimit
     */
    public function setCharLimit($charLimit)
    {
        $this->charLimit = $charLimit;
    }
}