Connection::getComposedFrame() - Code Metrics - Inspection of "2.0 transition (#54)" - arthurkushman/php-wss - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6ae2ec...32167a )

by Arthur

created 2021-03-07 13:11 UTC

Connection::getComposedFrame() B

↳ Parent: Project

Complexity

Conditions	6
Paths	12

Size

Total Lines

Duplication

Lines	6
Ratio	24 %

Importance

Changes

Metric	Value
dl	6
loc	25
rs	8.8977
c	0
b	0
f	0
cc	6
nc	12
nop	4

<?php

namespace WSSC\Components;

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

/**
 * Class Connection
 * @package WSSC\Components
 */
class Connection implements ConnectionContract, CommonsContract
{
    /**
     * @var false|resource
     */
    private $socketConnection;

    /**
     * @var array
     */
    private array $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(): void
    {
        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): void
    {
        fwrite($this->socketConnection, $this->encode($data));
    }

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

    /**
     * Broadcasting many messages with delay
     *
     * @param array $data An array of messages (strings) sent to many clients
     * @param int $delay Time in seconds to delay between messages
     * @throws \Exception
     */
    public function broadCastMany(array $data, int $delay = 0): void
    {
        foreach ($data as $message) {
            foreach ($this->clients as $client) {
                if (is_resource($client)) { // check if not yet closed/broken etc
                    fwrite($client, $this->encode($message));
                }
            }

            if ($delay > 0) {
                sleep($delay);
            }
        }
    }

    /**
     * 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 = $this->getOpType($type);
        $payloadLength = strlen($payload);

        // 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);
    }

    /**
     * Gets frame-head based on type of operation
     *
     * @param string $type Types of operation encode-frames
     * @return array
     */
    private function getOpType(string $type): array
    {
        $frameHead = [];

        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;
        }

        return $frameHead;
    }

    /**
     * @param array $frameHead
     * @param string $payload
     * @param int $payloadLength
     * @param bool $masked
     * @return string
     * @throws \Exception
     */
    private function getComposedFrame(array $frameHead, string $payload, int $payloadLength, bool $masked): string
    {
        // 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			/**
10			* Class Connection
11			* @package WSSC\Components
12			*/
13			class Connection implements ConnectionContract, CommonsContract
14			{
15			/**
16			* @var false\|resource
17			*/
18			private $socketConnection;
19
20			/**
21			* @var array
22			*/
23			private array $clients;
			0 ignored issues – show Bug introduced 2021-03-06 07:11 UTC by Report Bug Copy Issue Report This code did not parse for me. Apparently, there is an error somewhere around this line: Syntax error, unexpected T_ARRAY, expecting T_FUNCTION or T_CONST Loading history...
24
25			/**
26			* Connection constructor.
27			*
28			* @param $sockConn
29			* @param array $clients
30			*/
31			public function __construct($sockConn, array $clients = [])
32			{
33			$this->socketConnection = $sockConn;
34			$this->clients = $clients;
35			}
36
37			/**
38			* Closes clients socket stream
39			*
40			* @throws \Exception
41			*/
42			public function close(): void
43			{
44			if (is_resource($this->socketConnection)) {
45			fwrite($this->socketConnection, $this->encode('', self::EVENT_TYPE_CLOSE));
46			fclose($this->socketConnection);
47			}
48			}
49
50			/**
51			* This method is invoked when user implementation call $conn->send($data)
52			* writes data to the clients stream socket
53			*
54			* @param string $data pure decoded data from server
55			* @throws \Exception
56			*/
57			public function send(string $data): void
58			{
59			fwrite($this->socketConnection, $this->encode($data));
60			}
61
62			/**
63			* @param string $data data to send to clients
64			* @throws \Exception
65			*/
66			public function broadCast(string $data): void
67			{
68			foreach ($this->clients as $client) {
69			if (is_resource($client)) { // check if not yet closed/broken etc
70			fwrite($client, $this->encode($data));
71			}
72			}
73			}
74
75			/**
76			* Broadcasting many messages with delay
77			*
78			* @param array $data An array of messages (strings) sent to many clients
79			* @param int $delay Time in seconds to delay between messages
80			* @throws \Exception
81			*/
82			public function broadCastMany(array $data, int $delay = 0): void
83			{
84			foreach ($data as $message) {
85			foreach ($this->clients as $client) {
86			if (is_resource($client)) { // check if not yet closed/broken etc
87			fwrite($client, $this->encode($message));
88			}
89			}
90
91			if ($delay > 0) {
92			sleep($delay);
93			}
94			}
95			}
96
97			/**
98			* Encodes data before writing to the client socket stream
99			*
100			* @param string $payload
101			* @param string $type
102			* @param boolean $masked
103			* @return mixed
104			* @throws \Exception
105			*/
106			private function encode($payload, string $type = self::EVENT_TYPE_TEXT, bool $masked = false)
107			{
108			$frameHead = $this->getOpType($type);
109			$payloadLength = strlen($payload);
110
111			// set mask and payload length (using 1, 3 or 9 bytes)
112			if ($payloadLength > self::PAYLOAD_MAX_BITS) {
113			$payloadLengthBin = str_split(sprintf('%064b', $payloadLength), self::PAYLOAD_CHUNK);
114			$frameHead[1] = ($masked === true) ? self::MASK_255 : self::MASK_127;
115
116			for ($i = 0; $i < 8; $i++) {
117			$frameHead[$i + 2] = bindec($payloadLengthBin[$i]);
118			}
119
120			// most significant bit MUST be 0
121			if ($frameHead[2] > self::MASK_127) {
122			return [
123			'type' => $type,
124			'payload' => $payload,
125			'error' => WebSocketServerContract::ERR_FRAME_TOO_LARGE,
126			];
127			}
128			} elseif ($payloadLength > self::MASK_125) {
129			$payloadLengthBin = str_split(sprintf('%016b', $payloadLength), self::PAYLOAD_CHUNK);
130			$frameHead[1] = ($masked === true) ? self::MASK_254 : self::MASK_126;
131			$frameHead[2] = bindec($payloadLengthBin[0]);
132			$frameHead[3] = bindec($payloadLengthBin[1]);
133			} else {
134			$frameHead[1] = ($masked === true) ? $payloadLength + self::MASK_128 : $payloadLength;
135			}
136
137			return $this->getComposedFrame($frameHead, $payload, $payloadLength, $masked);
138			}
139
140			/**
141			* Gets frame-head based on type of operation
142			*
143			* @param string $type Types of operation encode-frames
144			* @return array
145			*/
146			private function getOpType(string $type): array
147			{
148			$frameHead = [];
149
150			switch ($type) {
151			case self::EVENT_TYPE_TEXT:
152			// first byte indicates FIN, Text-Frame (10000001):
153			$frameHead[0] = self::ENCODE_TEXT;
154			break;
155
156			case self::EVENT_TYPE_CLOSE:
157			// first byte indicates FIN, Close Frame(10001000):
158			$frameHead[0] = self::ENCODE_CLOSE;
159			break;
160
161			case self::EVENT_TYPE_PING:
162			// first byte indicates FIN, Ping frame (10001001):
163			$frameHead[0] = self::ENCODE_PING;
164			break;
165
166			case self::EVENT_TYPE_PONG:
167			// first byte indicates FIN, Pong frame (10001010):
168			$frameHead[0] = self::ENCODE_PONG;
169			break;
170			}
171
172			return $frameHead;
173			}
174
175			/**
176			* @param array $frameHead
177			* @param string $payload
178			* @param int $payloadLength
179			* @param bool $masked
180			* @return string
181			* @throws \Exception
182			*/
183			private function getComposedFrame(array $frameHead, string $payload, int $payloadLength, bool $masked): string
184			{
185			// convert frame-head to string:
186			foreach (array_keys($frameHead) as $i) {
187			$frameHead[$i] = chr($frameHead[$i]);
188			}
189
190			// generate a random mask:
191			$mask = [];
192			if ($masked === true) {
193			for ($i = 0; $i < 4; $i++) {
194			$mask[$i] = chr(random_int(0, self::MASK_255));
195			}
196
197			$frameHead = array_merge($frameHead, $mask);
198			}
199			$frame = implode('', $frameHead);
200
201			// append payload to frame:
202			for ($i = 0; $i < $payloadLength; $i++) {
203			$frame .= ($masked === true) ? $payload[$i] ^ $mask[$i % 4] : $payload[$i];
204			}
205
206			return $frame;
207			}
208
209			/**
210			* Gets unique socket id from resource
211			*
212			* @return int
213			*/
214			public function getUniqueSocketId(): int
215			{
216			return (int)$this->socketConnection;
217			}
218
219			/**
220			* Gets client socket address host/port or UNIX path
221			*
222			* @return string
223			*/
224			public function getPeerName(): string
225			{
226			return stream_socket_get_name($this->socketConnection, true);
227			}
228			}
229

arthurkushman / php-wss

Push — master ( 6ae2ec...32167a )

Connection::getComposedFrame() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like