Connection::encode() - Code Metrics - Inspection of "#27. Add broadCast to Connection object to provide..." - arthurkushman/php-wss - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bf368b...88d0e2 )

by Arthur

created 2018-09-04 19:02 UTC

Connection::encode() C

↳ Parent: Connection

Complexity

Conditions	12
Paths	40

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	55
rs	6.9666
c	0
b	0
f	0
cc	12
nc	40
nop	3

How to fix Long Method Complexity

<?php

namespace WSSC\Components;

use WSSC\Contracts\CommonsContract;
use WSSC\Contracts\ConnectionContract;
use WSSC\Contracts\WebSocketServerContract;

class Connection implements ConnectionContract, CommonsContract
{

    private $socketConnection;
    private $clients;

    /**
     * Connection constructor.
     *
     * @param $sockConn
     * @param array $clients
     */
    public function __construct($sockConn, array $clients = [])
    {
        $this->socketConnection = $sockConn;
        $this->clients = $clients;
    }

    /**
     * Closes clients socket stream
     *
     * @throws \Exception
     */
    public function close()
    {
        if (is_resource($this->socketConnection)) {
            fwrite($this->socketConnection, $this->encode('', self::EVENT_TYPE_CLOSE));
            fclose($this->socketConnection);
        }
    }

    /**
     * This method is invoked when user implementation call $conn->send($data)
     * writes data to the clients stream socket
     *
     * @param string $data pure decoded data from server
     * @throws \Exception
     */
    public function send(string $data)
    {
        fwrite($this->socketConnection, $this->encode($data));
    }

    /**
     * @param string $data data to send to clients
     * @throws \Exception
     */
    public function broadCast(string $data)
    {
        foreach ($this->clients as $client) {
            if (is_resource($client)) { // check if not yet closed/broken etc
                fwrite($client, $this->encode($data));
            }
        }
    }

    /**
     * Encodes data before writing to the client socket stream
     *
     * @param string $payload
     * @param string $type
     * @param boolean $masked
     * @return mixed
     * @throws \Exception
     */
    private function encode($payload, string $type = self::EVENT_TYPE_TEXT, bool $masked = false)
    {
        $frameHead = [];
        $payloadLength = strlen($payload);

        switch ($type) {
            case self::EVENT_TYPE_TEXT:
                // first byte indicates FIN, Text-Frame (10000001):
                $frameHead[0] = self::ENCODE_TEXT;
                break;

            case self::EVENT_TYPE_CLOSE:
                // first byte indicates FIN, Close Frame(10001000):
                $frameHead[0] = self::ENCODE_CLOSE;
                break;

            case self::EVENT_TYPE_PING:
                // first byte indicates FIN, Ping frame (10001001):
                $frameHead[0] = self::ENCODE_PING;
                break;

            case self::EVENT_TYPE_PONG:
                // first byte indicates FIN, Pong frame (10001010):
                $frameHead[0] = self::ENCODE_PONG;
                break;
        }

        // set mask and payload length (using 1, 3 or 9 bytes)
        if ($payloadLength > self::PAYLOAD_MAX_BITS) {
            $payloadLengthBin = str_split(sprintf('%064b', $payloadLength), self::PAYLOAD_CHUNK);
            $frameHead[1] = ($masked === true) ? self::MASK_255 : self::MASK_127;

            for ($i = 0; $i < 8; $i++) {
                $frameHead[$i + 2] = bindec($payloadLengthBin[$i]);
            }

            // most significant bit MUST be 0
            if ($frameHead[2] > self::MASK_127) {
                return [
                    'type'    => $type,
                    'payload' => $payload,
                    'error'   => WebSocketServerContract::ERR_FRAME_TOO_LARGE,
                ];
            }
        } elseif ($payloadLength > self::MASK_125) {
            $payloadLengthBin = str_split(sprintf('%016b', $payloadLength), self::PAYLOAD_CHUNK);
            $frameHead[1] = ($masked === true) ? self::MASK_254 : self::MASK_126;
            $frameHead[2] = bindec($payloadLengthBin[0]);
            $frameHead[3] = bindec($payloadLengthBin[1]);
        } else {
            $frameHead[1] = ($masked === true) ? $payloadLength + self::MASK_128 : $payloadLength;
        }

        return $this->getComposedFrame($frameHead, $payload, $payloadLength, $masked);
    }

    private function getComposedFrame(array $frameHead, string $payload, int $payloadLength, bool $masked)
    {
        // convert frame-head to string:
        foreach (array_keys($frameHead) as $i) {
            $frameHead[$i] = chr($frameHead[$i]);
        }

        // generate a random mask:
        $mask = [];
        if ($masked === true) {
            for ($i = 0; $i < 4; $i++) {

                $mask[$i] = chr(random_int(0, self::MASK_255));
            }

            $frameHead = array_merge($frameHead, $mask);
        }
        $frame = implode('', $frameHead);

        // append payload to frame:
        for ($i = 0; $i < $payloadLength; $i++) {

            $frame .= ($masked === true) ? $payload[$i] ^ $mask[$i % 4] : $payload[$i];
        }

        return $frame;
    }

    /**
     * Gets unique socket id from resource
     *
     * @return int
     */
    public function getUniqueSocketId(): int
    {
        return (int)$this->socketConnection;
    }

    /**
     *  Gets client socket address host/port or UNIX path
     *
     * @return string
     */
    public function getPeerName(): string
    {
        return stream_socket_get_name($this->socketConnection, true);
    }
}


1		<?php
2
3		namespace WSSC\Components;
4
5		use WSSC\Contracts\CommonsContract;
6		use WSSC\Contracts\ConnectionContract;
7		use WSSC\Contracts\WebSocketServerContract;
8
9		class Connection implements ConnectionContract, CommonsContract
10		{
11
12		private $socketConnection;
13		private $clients;
14
15		/**
16		* Connection constructor.
17		*
18		* @param $sockConn
19		* @param array $clients
20		*/
21		public function __construct($sockConn, array $clients = [])
22		{
23		$this->socketConnection = $sockConn;
24		$this->clients = $clients;
25		}
26
27		/**
28		* Closes clients socket stream
29		*
30		* @throws \Exception
31		*/
32		public function close()
33		{
34		if (is_resource($this->socketConnection)) {
35		fwrite($this->socketConnection, $this->encode('', self::EVENT_TYPE_CLOSE));
36		fclose($this->socketConnection);
37		}
38		}
39
40		/**
41		* This method is invoked when user implementation call $conn->send($data)
42		* writes data to the clients stream socket
43		*
44		* @param string $data pure decoded data from server
45		* @throws \Exception
46		*/
47		public function send(string $data)
48		{
49		fwrite($this->socketConnection, $this->encode($data));
50		}
51
52		/**
53		* @param string $data data to send to clients
54		* @throws \Exception
55		*/
56		public function broadCast(string $data)
57		{
58		foreach ($this->clients as $client) {
59		if (is_resource($client)) { // check if not yet closed/broken etc
60		fwrite($client, $this->encode($data));
61		}
62		}
63		}
64
65		/**
66		* Encodes data before writing to the client socket stream
67		*
68		* @param string $payload
69		* @param string $type
70		* @param boolean $masked
71		* @return mixed
72		* @throws \Exception
73		*/
74		private function encode($payload, string $type = self::EVENT_TYPE_TEXT, bool $masked = false)
75		{
76		$frameHead = [];
77		$payloadLength = strlen($payload);
78
79		switch ($type) {
80		case self::EVENT_TYPE_TEXT:
81		// first byte indicates FIN, Text-Frame (10000001):
82		$frameHead[0] = self::ENCODE_TEXT;
83		break;
84
85		case self::EVENT_TYPE_CLOSE:
86		// first byte indicates FIN, Close Frame(10001000):
87		$frameHead[0] = self::ENCODE_CLOSE;
88		break;
89
90		case self::EVENT_TYPE_PING:
91		// first byte indicates FIN, Ping frame (10001001):
92		$frameHead[0] = self::ENCODE_PING;
93		break;
94
95		case self::EVENT_TYPE_PONG:
96		// first byte indicates FIN, Pong frame (10001010):
97		$frameHead[0] = self::ENCODE_PONG;
98		break;
99		}
100
101		// set mask and payload length (using 1, 3 or 9 bytes)
102		if ($payloadLength > self::PAYLOAD_MAX_BITS) {
103		$payloadLengthBin = str_split(sprintf('%064b', $payloadLength), self::PAYLOAD_CHUNK);
104		$frameHead[1] = ($masked === true) ? self::MASK_255 : self::MASK_127;
105
106		for ($i = 0; $i < 8; $i++) {
107		$frameHead[$i + 2] = bindec($payloadLengthBin[$i]);
108		}
109
110		// most significant bit MUST be 0
111		if ($frameHead[2] > self::MASK_127) {
112		return [
113		'type' => $type,
114		'payload' => $payload,
115		'error' => WebSocketServerContract::ERR_FRAME_TOO_LARGE,
116		];
117		}
118		} elseif ($payloadLength > self::MASK_125) {
119		$payloadLengthBin = str_split(sprintf('%016b', $payloadLength), self::PAYLOAD_CHUNK);
120		$frameHead[1] = ($masked === true) ? self::MASK_254 : self::MASK_126;
121		$frameHead[2] = bindec($payloadLengthBin[0]);
122		$frameHead[3] = bindec($payloadLengthBin[1]);
123		} else {
124		$frameHead[1] = ($masked === true) ? $payloadLength + self::MASK_128 : $payloadLength;
125		}
126
127		return $this->getComposedFrame($frameHead, $payload, $payloadLength, $masked);
128		}
129
130		private function getComposedFrame(array $frameHead, string $payload, int $payloadLength, bool $masked)
131		{
132		// convert frame-head to string:
133		foreach (array_keys($frameHead) as $i) {
134		$frameHead[$i] = chr($frameHead[$i]);
135		}
136
137		// generate a random mask:
138		$mask = [];
139		if ($masked === true) {
140	View Code Duplication	for ($i = 0; $i < 4; $i++) {
		0 ignored issues – show Duplication introduced 2018-02-09 20:42 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
141		$mask[$i] = chr(random_int(0, self::MASK_255));
142		}
143
144		$frameHead = array_merge($frameHead, $mask);
145		}
146		$frame = implode('', $frameHead);
147
148		// append payload to frame:
149	View Code Duplication	for ($i = 0; $i < $payloadLength; $i++) {
		0 ignored issues – show Duplication introduced 2018-02-09 20:42 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
150		$frame .= ($masked === true) ? $payload[$i] ^ $mask[$i % 4] : $payload[$i];
151		}
152
153		return $frame;
154		}
155
156		/**
157		* Gets unique socket id from resource
158		*
159		* @return int
160		*/
161		public function getUniqueSocketId(): int
162		{
163		return (int)$this->socketConnection;
164		}
165
166		/**
167		* Gets client socket address host/port or UNIX path
168		*
169		* @return string
170		*/
171		public function getPeerName(): string
172		{
173		return stream_socket_get_name($this->socketConnection, true);
174		}
175		}
176

arthurkushman / php-wss

Push — master ( bf368b...88d0e2 )

Connection::encode() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like