Connection - Code Metrics - kakserpom/phpdaemon - Measure and Improve Code Quality continuously with Scrutinizer

Connection F
last analyzed 2021-06-02 17:17 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	451
Duplicated Lines	8.2 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

Metric	Value
dl	37
loc	451
rs	2
c	0
b	0
f	0
wmc	91
lcom	1
cbo	5

14 Methods

Rating	Name	Duplication	Size	Complexity
A	onReady()	0	14	3
B	command()	10	20	6
B	commandArr()	9	23	8
A	join()	0	9	3
A	part()	0	4	1
A	onFinish()	0	8	2
A	ping()	0	5	1
A	message()	0	4	1
A	addMode()	0	10	3
A	removeMode()	0	7	2
F	onCommand()	7	143	46
B	onRead()	11	40	11
A	channel()	0	7	2
A	channelIfExists()	0	7	2

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Connection often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Connection, and based on these observations, apply Extract Interface, too.

<?php
namespace PHPDaemon\Clients\IRC;

use PHPDaemon\Core\Daemon;
use PHPDaemon\Network\ClientConnection;
use PHPDaemon\Utils\IRC;

/**
 * @package    NetworkClients
 * @subpackage IRCClient
 * @author     Vasily Zorin <[email protected]>
 */
class Connection extends ClientConnection
{

    /**
     * @var string Username
     */
    protected $user = 'Guest';

    /**
     * @var string Password
     */
    protected $password = '';

    /**
     * @var string
     */
    public $EOL = "\r\n";

    /**
     * @var string
     */
    public $nick;

    /**
     * @var string
     */
    public $realname;

    /**
     * @var string
     */
    public $mode = '';

    /**
     * @var array
     */
    public $buffers = [];

    /**
     * @var string
     */
    public $servername;

    /**
     * @var array
     */
    public $channels = [];

    /**
     * @var integer
     */
    public $latency;

    /**
     * @var integer
     */
    public $lastPingTS;

    /**
     * @var int
     */
    public $timeout = 300;

    /**
     * @var bool To get local port number
     */
    protected $bevConnectEnabled = false;

    /**
     * Called when the connection is handshaked (at low-level), and peer is ready to recv. data
     * @return void
     */
    public function onReady()
    {
        if ($this->pool->identd) {
            /** @noinspection PhpParamsInspection */
            $this->getSocketName();

            $this->pool->identd->registerPair($this->locAddr, $this->locPort, ['UNIX', $this->user]);
        }
        list($this->nick, $this->realname) = explode('/', $this->path . '/John Doe');
        $this->command('USER', $this->user, 0, '*', $this->realname);
        $this->command('NICK', $this->nick);
        if (mb_orig_strlen($this->password)) {
            $this->message('NickServ', 'IDENTIFY ' . $this->password);
        }
    }

    /**
     * @TODO DESCR
     * @param  string $cmd
     * @param  mixed ...$args Arguments
     */
    public function command($cmd)
    {
        if (ctype_digit($cmd)) {
            $cmd = IRC::getCommandByCode((int)$cmd);
        }
        $line = $cmd;
        for ($i = 1, $s = func_num_args(); $i < $s; ++$i) {

            $arg = func_get_arg($i);
            if (($i + 1 === $s) && (mb_orig_strpos($arg, "\x20") !== false)) {
                $line .= ' :';
            } else {
                $line .= ' ';
            }
            $line .= $arg;
        }
        $this->writeln($line);
        if ($this->pool->protologging) {
            Daemon::log('->->->-> ' . $line);
        }
    }

    /**
     * @TODO DESCR
     * @param  integer|string $cmd
     * @param  array $args
     * @return bool
     */
    public function commandArr($cmd, $args = [])
    {
        if (!is_array($args)) {
            return false;
        }
        if (ctype_digit($cmd)) {
            $cmd = IRC::getCommandByCode((int)$cmd);
        }
        $line = $cmd;
        for ($i = 0, $s = sizeof($args); $i < $s; ++$i) {

            if (($i + 1 === $s) && (mb_orig_strpos($args[$i], "\x20") !== false)) {
                $line .= ' :';
            } else {
                $line .= ' ';
            }
            $line .= $args[$i];
        }
        $this->writeln($line);
        if ($this->pool->protologging && $cmd !== 'PONG') {
            Daemon::log('->->->-> ' . $line);
        }
        return true;
    }

    /**
     * @TODO DESCR
     * @param array $channels
     */
    public function join($channels)
    {
        if (!is_array($channels)) {
            $channels = array_map('trim', explode(',', $channels));
        }
        foreach ($channels as $chan) {
            $this->command('JOIN', $chan);
        }
    }

    /**
     * @TODO DESCR
     * @param array $channels
     * @param mixed $msg
     */
    public function part($channels, $msg = null)
    {
        $this->command('PART', $channels, $msg);
    }

    /**
     * Called when connection finishes
     * @return void
     */
    public function onFinish()
    {
        if ($this->pool->identd) {
            $this->pool->identd->unregisterPair($this->locPort, $this->port);
        }
        $this->event('disconnect');
        parent::onFinish();
    }

    /**
     * @TODO DESCR
     */
    public function ping()
    {
        $this->lastPingTS = microtime(true);
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        $this->writeln('PING :' . $this->servername);
    }

    /**
     * @TODO DESCR
     * @param string $to
     * @param string $msg
     */
    public function message($to, $msg)
    {
        $this->command('PRIVMSG', $to, $msg);
    }

    /**
     * @TODO DESCR
     * @param string $channel
     * @param string $target
     * @param string $mode
     */
    public function addMode($channel, $target, $mode)
    {
        if ($channel) {
            $this->channel($channel)->addMode($target, $mode);
        } else {
            if (mb_orig_strpos($this->mode, $mode) === false) {
                $this->mode .= $mode;
            }
        }
    }

    /**
     * @TODO DESCR
     * @param string $channel
     * @param string $target
     * @param string $mode
     */
    public function removeMode($channel, $target, $mode)
    {
        if ($channel) {
            $this->channel($channel)->removeMode($target, $mode);
        }
        $this->mode = str_replace($mode, '', $this->mode);
    }

    /**
     * @TODO DESCR
     * @param string $from
     * @param string $cmd
     * @param array $args
     */
    public function onCommand($from, $cmd, $args)
    {
        $this->event('command', $from, $cmd, $args);
        if ($cmd === 'RPL_WELCOME') {
            $this->servername = $from['orig'];
            if ($this->onConnected) {
                $this->connected = true;
                $this->onConnected->executeAll($this);
                $this->onConnected = null;
            }
        } elseif ($cmd === 'NOTICE') {
            list($target, $text) = $args;
            $this->event('notice', $target, $text);
        } elseif ($cmd === 'RPL_YOURHOST') {
        } elseif ($cmd === 'RPL_MOTDSTART') {
            $this->motd = $args[1];
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            return;
        } elseif ($cmd === 'RPL_MOTD') {
            $this->motd .= "\r\n" . $args[1];
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            return;
        } elseif ($cmd === 'RPL_ENDOFMOTD') {
            $this->motd .= "\r\n"; // . $args[1];
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->event('motd', $this->motd);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            return;
        } elseif ($cmd === 'JOIN') {
            list($channel) = $args;
            $chan = $this->channel($channel);
            ChannelParticipant::instance($chan, $from['nick'])->setUsermask($from);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } elseif ($cmd === 'NICK') {
            list($newNick) = $args;
            foreach ($this->channels as $channel) {
                if (isset($channel->nicknames[$from['nick']])) {
                    $channel->nicknames[$from['nick']]->setNick($newNick);
                }
            }
        } elseif ($cmd === 'QUIT') {
            $args[] = null;
            list($msg) = $args;
<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;
            foreach ($this->channels as $channel) {
                if (isset($channel->nicknames[$from['nick']])) {
                    $channel->nicknames[$from['nick']]->destroy();
                }
            }
        } elseif ($cmd === 'PART') {
            $args[] = null;
            list($channel, $msg) = $args;
            if ($chan = $this->channelIfExists($channel)) {
                $chan->onPart($from, $msg);

            }
        } elseif ($cmd === 'RPL_NAMREPLY') {
            $bufName = 'RPL_NAMREPLY';
            list(/*$myNick*/, $chanType, $channelName) = $args;
            $this->channel($channelName)->setChanType($chanType);
            if (!isset($this->buffers[$bufName])) {
                $this->buffers[$bufName] = [];
            }
            if (!isset($this->buffers[$bufName][$channelName])) {
                $this->buffers[$bufName][$channelName] = new \SplStack;
            }
            $this->buffers[$bufName][$channelName]->push($args);
        } elseif ($cmd === 'RPL_ENDOFNAMES') {
            $bufName = 'RPL_NAMREPLY';
            list(/*$nick*/, $channelName, /*$text*/) = $args;
            if (!isset($this->buffers[$bufName][$channelName])) {
                return;
            }
            $buf = $this->buffers[$bufName][$channelName];
            $chan = null;
            while (!$buf->isEmpty()) {
                $shift = $buf->shift();
                list($nick, $chantype, $channelName, $participants) = $shift;
<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;
                if (!$chan) {
                    $chan = $this->channel($channelName)->setType($chantype);
                    $chan->each('destroy');
                }
                preg_match_all('~([\+%@]?)(\S+)~', $participants, $matches, PREG_SET_ORDER);

                foreach ($matches as $m) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                    list(, $flag, $nickname) = $m;
                    ChannelParticipant::instance($chan, $nickname)->setFlag($flag);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                }
            }
        } elseif ($cmd === 'RPL_WHOREPLY') {
            if (sizeof($args) < 7) {
            }
            list(/*$myNick*/, $channelName, $user, /*$host*/, $server, $nick, $mode, $hopCountRealName) = $args;
            list($hopCount, $realName) = explode("\x20", $hopCountRealName);
<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;
            if ($channel = $this->channelIfExists($channelName)) {
                ChannelParticipant::instance($channel, $nick)
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    ->setUsermask($nick . '!' . $user . '@' . $server)
                    ->setFlag($mode);
            }
        } elseif ($cmd === 'RPL_TOPIC') {
            list(/*$myNick*/, $channelName, $text) = $args;
            if ($channel = $this->channelIfExists($channelName)) {
                $channel->setTopic($text);

            }
        } elseif ($cmd === 'RPL_ENDOFWHO') {
            /*list($myNick, $channelName, $text) = $args;*/
        } elseif ($cmd === 'MODE') {
            if (sizeof($args) === 3) {
                list($channel, $mode, $target) = $args;
            } else {
                $channel = null;
                list($target, $mode) = $args;
            }
            if (mb_orig_strlen($mode)) {
                if ($mode[0] === '+') {
                    $this->addMode($channel, $target, mb_orig_substr($mode, 1));
                } elseif ($mode[0] === '-') {
                    $this->removeMode($channel, $target, mb_orig_substr($mode, 1));
                }
            }
        } elseif ($cmd === 'RPL_CREATED') {
            list(/*$to*/, $this->created) = $args;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        } elseif ($cmd === 'RPL_MYINFO') {
            list(/*$to*/, $this->servername, $this->serverver, $this->availUserModes, $this->availChanModes) = $args;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        } elseif ($cmd === 'PRIVMSG') {
            list($target, $body) = $args;
            $msg = [
                'from' => $from,
                'to' => $target,
                'body' => $body,
                'private' => mb_orig_substr($target, 0, 1) !== '#',
            ];
            $this->event($msg['private'] ? 'privateMsg' : 'channelMsg', $msg);
            $this->event('msg', $msg);
            if (!$msg['private']) {
                $this->channel($target)->event('msg', $msg);
            }
        } elseif ($cmd === 'PING') {
            $this->writeln(isset($args[0]) ? 'PONG :' . $args[0] : 'PONG');
        } elseif ($cmd === 'PONG') {

            if ($this->lastPingTS) {
                $this->latency = microtime(true) - $this->lastPingTS;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
                $this->lastPingTS = null;
            }
            return;
        }
        if ($this->pool->protologging) {
            Daemon::$process->log('<-<-<-< ' . $cmd . ': ' . json_encode($args) . ' (' . json_encode($from['orig']) . ') (' . json_encode($this->lastLine) . ')');
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
    }

    /**
     * Called when new data received
     * @return void
     */
    public function onRead()
    {
        while (($line = $this->readline()) !== null) {
            if ($line === '') {
                continue;
            }
            if (mb_orig_strlen($line) > 512) {
                Daemon::$process->log('IRCClientConnection error: buffer overflow.');
                $this->finish();
                return;
            }
            $line = mb_orig_substr($line, 0, -mb_orig_strlen($this->EOL));
            $p = mb_orig_strpos($line, ' :', 1);
            $max = $p !== false ? substr_count($line, "\x20", 0, $p + 1) + 1 : 18;
            $e = explode("\x20", $line, $max);
            $i = 0;
            $from = IRC::parseUsermask($e[$i][0] === ':' ? mb_orig_substr($e[$i++], 1) : null);
            $cmd = $e[$i++];
            $args = [];

            for ($s = min(sizeof($e), 14); $i < $s; ++$i) {

                if ($e[$i][0] === ':') {
                    $args[] = mb_orig_substr($e[$i], 1);
                    break;
                }
                $args[] = $e[$i];
            }

            if (ctype_digit($cmd)) {

                $code = (int)$cmd;
                $cmd = isset(IRC::$codes[$code]) ? IRC::$codes[$code] : $code;
            }
            $this->lastLine = $line;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->onCommand($from, $cmd, $args);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
        if (mb_orig_strlen($this->buf) > 512) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            Daemon::$process->log('IRCClientConnection error: buffer overflow.');
            $this->finish();
        }
    }

    /**
     * @TODO DESCR
     * @param  string $chan
     * @return Channel
     */
    public function channel($chan)
    {
        if (isset($this->channels[$chan])) {
            return $this->channels[$chan];
        }
        return $this->channels[$chan] = new Channel($this, $chan);
    }

    /**
     * @TODO DESCR
     * @param  string $chan
     * @return bool
     */
    public function channelIfExists($chan)
    {
        if (isset($this->channels[$chan])) {
            return $this->channels[$chan];
        }
        return false;
    }
}


kakserpom / phpdaemon

Connection F last analyzed 2021-06-02 17:17 UTC