Connection - Code Metrics - Inspection of "[WIP] Feature TravisCI + PSR2" - kakserpom/phpdaemon - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#234)

by Дмитрий

created 2016-05-10 20:48 UTC

Connection B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	425
Duplicated Lines	8.94 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	4
Bugs	1	Features	0

Metric	Value
dl	38
loc	425
rs	7.9487
c	4
b	1
f	0
wmc	52
lcom	1
cbo	5

18 Methods

Rating	Name	Duplication	Size	Complexity
A	getId()	0	5	1
A	onReady()	0	8	1
A	onFinish()	0	12	3
A	sendXML()	0	5	1
A	startXMLStream()	0	6	1
A	iqSet()	9	10	2
A	iqSetTo()	10	10	2
A	iqGet()	9	10	2
A	iqGetTo()	10	10	2
A	ping()	0	11	3
A	queryGet()	0	4	1
A	querySet()	0	4	1
A	querySetTo()	0	4	1
C	createXMLStream()	0	66	11
B	message()	0	22	4
F	presence()	0	40	9
B	getVCard()	0	27	5
A	onRead()	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\XMPP;

use PHPDaemon\Clients\XMPP\XMPPRoster;
use PHPDaemon\Core\Daemon;
use PHPDaemon\Core\Timer;
use PHPDaemon\Network\ClientConnection;
use PHPDaemon\Traits\EventHandlers;
use PHPDaemon\XMLStream\XMLStream;

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

    /**
     * @var boolean
     */
    public $use_encryption = false;
    
    /**
     * @var boolean
     */
    public $authorized;
    
    /**
     * @var integer
     */
    public $lastId = 0;
    
    /**
     * @var XMPPRoster
     */
    public $roster;
    
    /**
     * @var XMLStream
     */
    public $xml;
    
    /**
     * @var string
     */
    public $fulljid;
    
    /**
     * @var integer|string Timer ID
     */
    public $keepaliveTimer;

    /**
     * Get next ID
     * @return string
     */
    public function getId()
    {
        $id = ++$this->lastId;
        return dechex($id);
    }

    /**
     * Called when the connection is handshaked (at low-level), and peer is ready to recv. data
     * @return void
     */
    public function onReady()
    {
        $this->createXMLStream();
        $this->startXMLStream();
        $this->keepaliveTimer = setTimeout(function ($timer) {

            $this->ping();
        }, 1e6 * 30);
    }

    /**
     * Called when session finishes
     * @return void
     */
    public function onFinish()
    {
        parent::onFinish();
        $this->event('disconnect');
        if (isset($this->xml)) {
            $this->xml->finish();
        }
        unset($this->roster);
        if ($this->keepaliveTimer) {
            Timer::remove($this->keepaliveTimer);
        }
    }

    /**
     * @TODO DESCR

     * @param string $s
     */
    public function sendXML($s)
    {
        //Daemon::log(Debug::dump(['send', $s]));

        $this->write($s);
    }

    /**
     * @TODO DESCR

     */
    public function startXMLStream()
    {
        $this->sendXML('<?xml version="1.0"?>' .
                       '<stream:stream xmlns:stream="http://etherx.jabber.org/streams" version="1.0" xmlns="jabber:client" to="' . $this->host . '" xml:lang="en" xmlns:xml="http://www.w3.org/XML/1998/namespace">'

        );
    }

    /**
     * @TODO DESCR

     * @param  string   $xml
     * @param  callable $cb
     * @callback $cb ( )
     * @return boolean
     */
    public function iqSet($xml, $cb)

    {
        if (!isset($this->xml)) {
            return false;
        }
        $id = $this->getId();
        $this->xml->addIdHandler($id, $cb);
        $this->sendXML('<iq xmlns="jabber:client" type="set" id="' . $id . '">' . $xml . '</iq>');
        return true;
    }

    /**
     * @TODO DESCR

     * @param  string   $to
     * @param  string   $xml
     * @param  callable $cb
     * @callback $cb ( )
     * @return boolean
     */
    public function iqSetTo($to, $xml, $cb)

    {
        if (!isset($this->xml)) {
            return false;
        }
        $id = $this->getId();
        $this->xml->addIdHandler($id, $cb);
        $this->sendXML('<iq xmlns="jabber:client" type="set" id="' . $id . '" to="' . htmlspecialchars($to) . '">' . $xml . '</iq>');

        return true;
    }

    /**
     * @TODO DESCR

     * @param  string   $xml
     * @param  callable $cb
     * @callback $cb ( )
     * @return boolean
     */
    public function iqGet($xml, $cb)

    {
        if (!isset($this->xml)) {
            return false;
        }
        $id = $this->getId();
        $this->xml->addIdHandler($id, $cb);
        $this->sendXML('<iq xmlns="jabber:client" type="get" id="' . $id . '">' . $xml . '</iq>');
        return true;
    }

    /**
     * @TODO DESCR

     * @param  string   $to
     * @param  string   $xml
     * @param  callable $cb
     * @callback $cb ( )
     * @return boolean
     */
    public function iqGetTo($to, $xml, $cb)

    {
        if (!isset($this->xml)) {
            return false;
        }
        $id = $this->getId();
        $this->xml->addIdHandler($id, $cb);
        $this->sendXML('<iq xmlns="jabber:client" type="get" id="' . $id . '" to="' . htmlspecialchars($to) . '">' . $xml . '</iq>');

        return true;
    }

    /**
     * @TODO DESCR

     * @param  string   $to

     * @param  callable $cb

     * @callback $cb ( )
     * @return boolean
     */
    public function ping($to = null, $cb = null)
    {
        if (!isset($this->xml)) {
            return false;
        }
        if ($to === null) {
            $to = $this->host;
        }
        //Daemon::log('Sending ping to '.$to);

        return $this->iqGetTo($to, '<ping xmlns="urn:xmpp:ping"/>', $cb);

    }

    /**
     * @TODO DESCR

     * @param  string   $ns
     * @param  callable $cb
     * @callback $cb ( )
     * @return boolean
     */
    public function queryGet($ns, $cb)
    {
        return $this->iqGet('<query xmlns="' . $ns . '" />', $cb);
    }

    /**
     * @TODO DESCR

     * @param  string   $ns
     * @param  string   $xml
     * @param  callable $cb
     * @callback $cb ( )
     * @return boolean
     */
    public function querySet($ns, $xml, $cb)
    {
        return $this->iqSet('<query xmlns="' . $ns . '">' . $xml . '</query>', $cb);
    }

    /**
     * @TODO DESCR

     * @param  string   $to
     * @param  string   $ns
     * @param  string   $xml
     * @param  callable $cb
     * @callback $cb ( )
     * @return boolean
     */
    public function querySetTo($to, $ns, $xml, $cb)
    {
        return $this->iqSetTo($to, '<query xmlns="' . $ns . '">' . $xml . '</query>', $cb);
    }

    /**
     * @TODO DESCR

     */
    public function createXMLStream()
    {
        $this->xml = new XMLStream;
        $this->xml->setDefaultNS('jabber:client');
        $this->xml->addXPathHandler('{http://etherx.jabber.org/streams}features', function ($xml) {
            /** @var XMLStream $xml */
            if ($xml->hasSub('starttls') and $this->use_encryption) {
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
                $this->sendXML("<starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'><required /></starttls>");
            } elseif ($xml->hasSub('bind') and $this->authorized) {
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
                $id = $this->getId();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                $this->iqSet('<bind xmlns="urn:ietf:params:xml:ns:xmpp-bind"><resource>' . $this->path . '</resource></bind>', function ($xml) {

                    if ($xml->attrs['type'] === 'result') {
                        $this->fulljid = $xml->sub('bind')->sub('jid')->data;
                        $jidarray      = explode('/', $this->fulljid);
                        $this->jid     = $jidarray[0];
<?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->iqSet('<session xmlns="urn:ietf:params:xml:ns:xmpp-session" />', function ($xml) {

                        $this->roster = new XMPPRoster($this);
                        if ($this->onConnected) {
                            $this->connected = true;
                            $this->onConnected->executeAll($this);
                            $this->onConnected = null;
                        }
                        $this->event('connected');
                    });
                });
            } else {
                if (mb_orig_strlen($this->password)) {
                    $this->sendXML("<auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='PLAIN'>" . base64_encode("\x00" . $this->user . "\x00" . $this->password) . "</auth>");

                } else {
                    $this->sendXML("<auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='ANONYMOUS'/>");
                }
            }
        });
        $this->xml->addXPathHandler('{urn:ietf:params:xml:ns:xmpp-sasl}success', function ($xml) {

            $this->authorized = true;
            $this->xml->finish();
            $this->createXMLStream();
            $this->startXMLStream();
        });
        $this->xml->addXPathHandler('{urn:ietf:params:xml:ns:xmpp-sasl}failure', function ($xml) {

            if ($this->onConnected) {
                $this->connected = false;
                $func = $this->onConnected;
                $func($this);
                $this->onConnected = null;
            }
            $this->finish();
        });
        $this->xml->addXPathHandler('{urn:ietf:params:xml:ns:xmpp-tls}proceed', function ($xml) {

            Daemon::log("XMPPClient: TLS not supported.");
        });
        $this->xml->addXPathHandler('{jabber:client}message', function ($xml) {
            if (isset($xml->attrs['type'])) {
                $payload['type'] = $xml->attrs['type'];
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
            } else {
                $payload['type'] = 'chat';
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
            }
            $payload['xml']  = $xml;
            $payload['from'] = $xml->attrs['from'];
            if ($xml->hasSub('body')) {
                $payload['body'] = $xml->sub('body')->data;
                $this->event('message', $payload);
            }
        });
    }

    /**
     * Send XMPP Message
     * @param string $to
     * @param string $body
     * @param string $type
     * @param string $subject

     */
    public function message($to, $body, $type = 'chat', $subject = null, $payload = null)
    {
        if ($type === null) {
            $type = 'chat';
        }

        $to      = htmlspecialchars($to);
        $body    = htmlspecialchars($body);
        $subject = htmlspecialchars($subject);

        $out = '<message from="' . $this->fulljid . '" to="' . $to . '" type="' . $type . '">';
        if ($subject) {
            $out .= '<subject>' . $subject . '</subject>';
        }
        $out .= '<body>' . $body . '</body>';
        if ($payload) {
            $out .= $payload;
        }
        $out .= "</message>";

        $this->sendXML($out);
    }

    /**
     * Set Presence
     * @param string  $status

     * @param string  $show
     * @param string  $to

     * @param string  $type
     * @param integer $priority
     */
    public function presence($status = null, $show = 'available', $to = null, $type = 'available', $priority = 0)
    {
        if ($type === 'available') {
            $type = '';
        }
        $to     = htmlspecialchars($to);
        $status = htmlspecialchars($status);
        $show = htmlspecialchars($show);
        $type = htmlspecialchars($type);
        $priority = htmlspecialchars($priority);
        if ($show === 'unavailable') {
            $type = 'unavailable';
        }

        $out = "<presence";
        $out .= ' from="' . $this->fulljid . '"';
        if ($to) {
            $out .= ' to="' . $to . '"';
        }
        if ($type) {
            $out .= ' type="' . $type . '"';
        }
        $inner = '';
        if ($show !== 'available') {
            $inner .= "<show>$show</show>";
        }
        if ($status) {
            $inner .= "<status>$status</status>";
        }
        if ($priority) {
            $inner .= "<priority>$priority</priority>";
        }
        if ($inner === '') {
            $out .= "/>";
        } else {
            $out .= '>' . $inner . '</presence>';
        }

        $this->sendXML($out);
    }

    /**
     * @TODO DESCR

     * @param string   $jid

     * @param callable $cb
     * @callback $cb ( )
     */
    public function getVCard($jid = null, $cb)
    {
        $id = $this->getId();
        $this->xml->addIdHandler($id, function ($xml) use ($cb) {
            $vcard    = [];
            $vcardXML = $xml->sub('vcard');
            foreach ($vcardXML->subs as $sub) {
                if ($sub->subs) {
                    $vcard[$sub->name] = [];
                    foreach ($sub->subs as $sub_child) {
                        $vcard[$sub->name][$sub_child->name] = $sub_child->data;
                    }
                } else {
                    $vcard[$sub->name] = $sub->data;
                }
            }
            $vcard['from'] = $xml->attrs['from'];
            $cb($vcard);
        });
        $id = htmlspecialchars($id);
        $jid = htmlspecialchars($jid);
        if ($jid) {
            $this->send('<iq type="get" id="' . $id . '" to="' . $jid . '"><vCard xmlns="vcard-temp" /></iq>');
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        } else {
            $this->send('<iq type="get" id="' . $id . '"><vCard xmlns="vcard-temp" /></iq>');
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        }
    }

    /**
     * Called when new data received
     * @return void
     */
    public function onRead()
    {
        Timer::setTimeout($this->keepaliveTimer);
        if (isset($this->xml)) {
            $this->xml->feed($this->readUnlimited());
        }
    }
}


Pull Request — master (#234)

Connection B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

18 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Logical Operators are used for Control-Flow

Logical Operators are used for Control-Flow

kakserpom / phpdaemon

Pull Request — master (#234)

Connection B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

18 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Logical Operators are used for Control-Flow

Logical Operators are used for Control-Flow

Duplication Side-by-Side

Filter issues like