shahradelahi / easy-http

examples/websocket/anonymous-callable.php

Indentation +5 added lines, -5 removed lines

@@ -4,17 +4,17 @@
 $SocketClient = new \EasyHttp\WebSocket();
 
 $SocketClient->onOpen = function (\EasyHttp\WebSocket $socket) {
-	echo "Connected to server<br>";
-	$socket->send("Hello World");
+    echo "Connected to server<br>";
+    $socket->send("Hello World");
 };
 
 $SocketClient->onMessage = function (\EasyHttp\WebSocket $socket, $message) {
-	echo $message . "<br>";
-	$socket->close();
+    echo $message . "<br>";
+    $socket->close();
 };
 
 $SocketClient->onClose = function (\EasyHttp\WebSocket $socket, int $closeStatus) {
-	echo "Disconnected with status: $closeStatus<br>";
+    echo "Disconnected with status: $closeStatus<br>";
 };
 
 $SocketClient->connect('wss://socket.litehex.com/', new \EasyHttp\WebSocketConfig());
\ No newline at end of file

src/Contracts/CommonsContract.php

Indentation +47 added lines, -47 removed lines

@@ -12,58 +12,58 @@
 interface CommonsContract
 {
 
-	// DADA types
-	public const EVENT_TYPE_PING = 'ping';
-	public const EVENT_TYPE_PONG = 'pong';
-	public const EVENT_TYPE_TEXT = 'text';
-	public const EVENT_TYPE_CLOSE = 'close';
-	public const EVENT_TYPE_BINARY = 'binary';
-	public const EVENT_TYPE_CONTINUATION = 'continuation';
+    // DADA types
+    public const EVENT_TYPE_PING = 'ping';
+    public const EVENT_TYPE_PONG = 'pong';
+    public const EVENT_TYPE_TEXT = 'text';
+    public const EVENT_TYPE_CLOSE = 'close';
+    public const EVENT_TYPE_BINARY = 'binary';
+    public const EVENT_TYPE_CONTINUATION = 'continuation';
 
-	public const MAP_EVENT_TYPE_TO_METHODS = [
-		self::EVENT_TYPE_TEXT => 'onMessage',
-		self::EVENT_TYPE_PING => 'onPing',
-		self::EVENT_TYPE_PONG => 'onPong',
-	];
+    public const MAP_EVENT_TYPE_TO_METHODS = [
+        self::EVENT_TYPE_TEXT => 'onMessage',
+        self::EVENT_TYPE_PING => 'onPing',
+        self::EVENT_TYPE_PONG => 'onPong',
+    ];
 
-	// DECODE FRAMES
-	public const DECODE_TEXT = 1;
-	public const DECODE_BINARY = 2;
-	public const DECODE_CLOSE = 8;
-	public const DECODE_PING = 9;
-	public const DECODE_PONG = 10;
+    // DECODE FRAMES
+    public const DECODE_TEXT = 1;
+    public const DECODE_BINARY = 2;
+    public const DECODE_CLOSE = 8;
+    public const DECODE_PING = 9;
+    public const DECODE_PONG = 10;
 
-	// ENCODE FRAMES
-	public const ENCODE_TEXT = 129;
-	public const ENCODE_CLOSE = 136;
-	public const ENCODE_PING = 137;
-	public const ENCODE_PONG = 138;
+    // ENCODE FRAMES
+    public const ENCODE_TEXT = 129;
+    public const ENCODE_CLOSE = 136;
+    public const ENCODE_PING = 137;
+    public const ENCODE_PONG = 138;
 
-	// MASKS
-	public const MASK_125 = 125;
-	public const MASK_126 = 126;
-	public const MASK_127 = 127;
-	public const MASK_128 = 128;
-	public const MASK_254 = 254;
-	public const MASK_255 = 255;
+    // MASKS
+    public const MASK_125 = 125;
+    public const MASK_126 = 126;
+    public const MASK_127 = 127;
+    public const MASK_128 = 128;
+    public const MASK_254 = 254;
+    public const MASK_255 = 255;
 
-	// PAYLOADS
-	public const PAYLOAD_CHUNK = 8;
-	public const PAYLOAD_MAX_BITS = 65535;
+    // PAYLOADS
+    public const PAYLOAD_CHUNK = 8;
+    public const PAYLOAD_MAX_BITS = 65535;
 
-	// transfer protocol-level errors
-	public const SERVER_COULD_NOT_BIND_TO_SOCKET = 101;
-	public const SERVER_SELECT_ERROR = 102;
-	public const SERVER_HEADERS_NOT_SET = 103;
-	public const CLIENT_COULD_NOT_OPEN_SOCKET = 104;
-	public const CLIENT_INCORRECT_SCHEME = 105;
-	public const CLIENT_INVALID_UPGRADE_RESPONSE = 106;
-	public const CLIENT_INVALID_STREAM_CONTEXT = 107;
-	public const CLIENT_BAD_OPCODE = 108;
-	public const CLIENT_COULD_ONLY_WRITE_LESS = 109;
-	public const CLIENT_BROKEN_FRAME = 110;
-	public const CLIENT_EMPTY_READ = 111;
-	public const SERVER_INVALID_STREAM_CONTEXT = 112;
-	public const CLIENT_CONNECTION_NOT_ESTABLISHED = 113;
+    // transfer protocol-level errors
+    public const SERVER_COULD_NOT_BIND_TO_SOCKET = 101;
+    public const SERVER_SELECT_ERROR = 102;
+    public const SERVER_HEADERS_NOT_SET = 103;
+    public const CLIENT_COULD_NOT_OPEN_SOCKET = 104;
+    public const CLIENT_INCORRECT_SCHEME = 105;
+    public const CLIENT_INVALID_UPGRADE_RESPONSE = 106;
+    public const CLIENT_INVALID_STREAM_CONTEXT = 107;
+    public const CLIENT_BAD_OPCODE = 108;
+    public const CLIENT_COULD_ONLY_WRITE_LESS = 109;
+    public const CLIENT_BROKEN_FRAME = 110;
+    public const CLIENT_EMPTY_READ = 111;
+    public const SERVER_INVALID_STREAM_CONTEXT = 112;
+    public const CLIENT_CONNECTION_NOT_ESTABLISHED = 113;
 
 }
\ No newline at end of file

src/Contracts/WscCommonsContract.php

Indentation +17 added lines, -17 removed lines

@@ -12,25 +12,25 @@
 interface WscCommonsContract
 {
 
-	public const TCP_SCHEME = 'tcp://';
+    public const TCP_SCHEME = 'tcp://';
 
-	public const MAX_BYTES_READ = 65535;
-	public const DEFAULT_TIMEOUT = 5;
-	public const DEFAULT_FRAGMENT_SIZE = 4096;
-	public const DEFAULT_RESPONSE_HEADER = 8192;
-	public const SEC_WEBSOCKET_ACCEPT_PTTRN = '/Sec-WebSocket-Accept:\s(.*)$/mUi';
-	public const SERVER_KEY_ACCEPT = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11';
-	public const PROXY_MATCH_RESP = '/^HTTP\/\d\.\d 200/';
+    public const MAX_BYTES_READ = 65535;
+    public const DEFAULT_TIMEOUT = 5;
+    public const DEFAULT_FRAGMENT_SIZE = 4096;
+    public const DEFAULT_RESPONSE_HEADER = 8192;
+    public const SEC_WEBSOCKET_ACCEPT_PTTRN = '/Sec-WebSocket-Accept:\s(.*)$/mUi';
+    public const SERVER_KEY_ACCEPT = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11';
+    public const PROXY_MATCH_RESP = '/^HTTP\/\d\.\d 200/';
 
-	// MASKS
-	public const MASK_125 = 125;
-	public const MASK_126 = 126;
-	public const MASK_127 = 127;
-	public const MASK_128 = 128;
-	public const MASK_254 = 254;
-	public const MASK_255 = 255;
+    // MASKS
+    public const MASK_125 = 125;
+    public const MASK_126 = 126;
+    public const MASK_127 = 127;
+    public const MASK_128 = 128;
+    public const MASK_254 = 254;
+    public const MASK_255 = 255;
 
-	public const KEY_GEN_LENGTH = 16;
-	public const DEFAULT_PING_INTERVAL = 5;
+    public const KEY_GEN_LENGTH = 16;
+    public const DEFAULT_PING_INTERVAL = 5;
 
 }

src/Contracts/MessageContract.php

Indentation +6 added lines, -6 removed lines

@@ -15,11 +15,11 @@
 interface MessageContract
 {
 
-	/**
-	 * @param WebSocket $socket
-	 * @param string $message
-	 * @return void
-	 */
-	public function onMessage(WebSocket $socket, string $message): void;
+    /**
+     * @param WebSocket $socket
+     * @param string $message
+     * @return void
+     */
+    public function onMessage(WebSocket $socket, string $message): void;
 
 }

src/Contracts/WebSocketContract.php

Indentation +17 added lines, -17 removed lines

@@ -15,24 +15,24 @@
 interface WebSocketContract
 {
 
-	/**
-	 * @param WebSocket $socket
-	 * @return void
-	 */
-	public function onOpen(WebSocket $socket): void;
+    /**
+     * @param WebSocket $socket
+     * @return void
+     */
+    public function onOpen(WebSocket $socket): void;
 
-	/**
-	 * @param WebSocket $socket
-	 * @param int $closeStatus
-	 * @return void
-	 */
-	public function onClose(WebSocket $socket, int $closeStatus): void;
+    /**
+     * @param WebSocket $socket
+     * @param int $closeStatus
+     * @return void
+     */
+    public function onClose(WebSocket $socket, int $closeStatus): void;
 
-	/**
-	 * @param WebSocket $socket
-	 * @param WebSocketException $exception
-	 * @return void
-	 */
-	public function onError(WebSocket $socket, WebSocketException $exception): void;
+    /**
+     * @param WebSocket $socket
+     * @param WebSocketException $exception
+     * @return void
+     */
+    public function onError(WebSocket $socket, WebSocketException $exception): void;
 
 }

src/WebSocketConfig.php

Indentation +331 added lines, -331 removed lines

@@ -14,336 +14,336 @@
 class WebSocketConfig
 {
 
-	/**
-	 * @var string
-	 */
-	private string $scheme;
-
-	/**
-	 * @var string
-	 */
-	private string $host;
-
-	/**
-	 * @var string
-	 */
-	private string $user;
-
-	/**
-	 * @var string
-	 */
-	private string $password;
-
-	/**
-	 * @var string
-	 */
-	private string $port;
-
-	/**
-	 * @var int
-	 */
-	private int $timeout = WscCommonsContract::DEFAULT_TIMEOUT;
-
-	/**
-	 * @var array
-	 */
-	private array $headers = [];
-
-	/**
-	 * @var int
-	 */
-	private int $fragmentSize = WscCommonsContract::DEFAULT_FRAGMENT_SIZE;
-
-	/**
-	 * @var null|resource
-	 */
-	private $context;
-
-	/**
-	 * @var bool
-	 */
-	private bool $hasProxy = false;
-
-	/**
-	 * @var string
-	 */
-	private string $proxyIp;
-
-	/**
-	 * @var string
-	 */
-	private string $proxyPort;
-
-	/**
-	 * @var string|null
-	 */
-	private ?string $proxyAuth;
-
-	/**
-	 * @var array
-	 */
-	private array $contextOptions = [];
-
-	/**
-	 * @var int
-	 */
-	private int $pingInterval = WscCommonsContract::DEFAULT_PING_INTERVAL;
-
-	/**
-	 * @return int
-	 */
-	public function getTimeout(): int
-	{
-		return $this->timeout;
-	}
-
-	/**
-	 * @param int $timeout
-	 * @return WebSocketConfig
-	 */
-	public function setTimeout(int $timeout): WebSocketConfig
-	{
-		$this->timeout = $timeout;
-		return $this;
-	}
-
-	/**
-	 * @param int $int
-	 * @return $this
-	 */
-	public function setPingInterval(int $int): WebSocketConfig
-	{
-		$this->pingInterval = $int;
-		return $this;
-	}
-
-	/**
-	 * @return int
-	 */
-	public function getPingInterval(): int
-	{
-		return $this->pingInterval;
-	}
-
-	/**
-	 * @return array
-	 */
-	public function getHeaders(): array
-	{
-		return $this->headers;
-	}
-
-	/**
-	 * @param array $headers
-	 * @return WebSocketConfig
-	 */
-	public function setHeaders(array $headers): WebSocketConfig
-	{
-		$this->headers = $headers;
-		return $this;
-	}
-
-	/**
-	 * @return int
-	 */
-	public function getFragmentSize(): int
-	{
-		return $this->fragmentSize;
-	}
-
-	/**
-	 * @param int $fragmentSize
-	 * @return WebSocketConfig
-	 */
-	public function setFragmentSize(int $fragmentSize): WebSocketConfig
-	{
-		$this->fragmentSize = $fragmentSize;
-		return $this;
-	}
-
-	/**
-	 * @return mixed
-	 */
-	public function getContext(): mixed
-	{
-		return $this->context;
-	}
-
-	/**
-	 * @param mixed $context
-	 * @return WebSocketConfig
-	 */
-	public function setContext(mixed $context): WebSocketConfig
-	{
-		$this->context = $context;
-		return $this;
-	}
-
-	/**
-	 * @return mixed
-	 */
-	public function getScheme(): string
-	{
-		return $this->scheme;
-	}
-
-	/**
-	 * @param string $scheme
-	 * @return WebSocketConfig
-	 */
-	public function setScheme(string $scheme): WebSocketConfig
-	{
-		$this->scheme = $scheme;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getHost(): string
-	{
-		return $this->host;
-	}
-
-	/**
-	 * @param string $host
-	 * @return WebSocketConfig
-	 */
-	public function setHost(string $host): WebSocketConfig
-	{
-		$this->host = $host;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getUser(): string
-	{
-		return $this->user;
-	}
-
-	/**
-	 * @param array $urlParts
-	 * @return WebSocketConfig
-	 */
-	public function setUser(array $urlParts): WebSocketConfig
-	{
-		$this->user = $urlParts['user'] ?? '';
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getPassword(): string
-	{
-		return $this->password;
-	}
-
-	/**
-	 * @param array $urlParts
-	 * @return WebSocketConfig
-	 */
-	public function setPassword(array $urlParts): WebSocketConfig
-	{
-		$this->password = $urlParts['pass'] ?? '';
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getPort(): string
-	{
-		return $this->port;
-	}
-
-	/**
-	 * @param array $urlParts
-	 * @return WebSocketConfig
-	 */
-	public function setPort(array $urlParts): WebSocketConfig
-	{
-		$this->port = $urlParts['port'] ?? ($this->scheme === 'wss' ? '443' : '80');
-		return $this;
-	}
-
-	/**
-	 * @return array
-	 */
-	public function getContextOptions(): array
-	{
-		return $this->contextOptions;
-	}
-
-	/**
-	 * @param array $contextOptions
-	 * @return WebSocketConfig
-	 */
-	public function setContextOptions(array $contextOptions): WebSocketConfig
-	{
-		$this->contextOptions = $contextOptions;
-		return $this;
-	}
-
-	/**
-	 * @param string $ip
-	 * @param string $port
-	 * @return WebSocketConfig
-	 */
-	public function setProxy(string $ip, string $port): WebSocketConfig
-	{
-		$this->hasProxy = true;
-		$this->proxyIp = $ip;
-		$this->proxyPort = $port;
-
-		return $this;
-	}
-
-	/**
-	 * Sets auth for proxy
-	 *
-	 * @param string $userName
-	 * @param string $password
-	 * @return WebSocketConfig
-	 */
-	public function setProxyAuth(string $userName, string $password): WebSocketConfig
-	{
-		$this->proxyAuth = (empty($userName) === false && empty($password) === false) ? base64_encode($userName . ':' . $password) : null;
-		return $this;
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function hasProxy(): bool
-	{
-		return $this->hasProxy;
-	}
-
-	/**
-	 * @return string|null
-	 */
-	public function getProxyIp(): ?string
-	{
-		return $this->proxyIp;
-	}
-
-	/**
-	 * @return string|null
-	 */
-	public function getProxyPort(): ?string
-	{
-		return $this->proxyPort;
-	}
-
-	/**
-	 * @return string|null
-	 */
-	public function getProxyAuth(): ?string
-	{
-		return $this->proxyAuth;
-	}
+    /**
+     * @var string
+     */
+    private string $scheme;
+
+    /**
+     * @var string
+     */
+    private string $host;
+
+    /**
+     * @var string
+     */
+    private string $user;
+
+    /**
+     * @var string
+     */
+    private string $password;
+
+    /**
+     * @var string
+     */
+    private string $port;
+
+    /**
+     * @var int
+     */
+    private int $timeout = WscCommonsContract::DEFAULT_TIMEOUT;
+
+    /**
+     * @var array
+     */
+    private array $headers = [];
+
+    /**
+     * @var int
+     */
+    private int $fragmentSize = WscCommonsContract::DEFAULT_FRAGMENT_SIZE;
+
+    /**
+     * @var null|resource
+     */
+    private $context;
+
+    /**
+     * @var bool
+     */
+    private bool $hasProxy = false;
+
+    /**
+     * @var string
+     */
+    private string $proxyIp;
+
+    /**
+     * @var string
+     */
+    private string $proxyPort;
+
+    /**
+     * @var string|null
+     */
+    private ?string $proxyAuth;
+
+    /**
+     * @var array
+     */
+    private array $contextOptions = [];
+
+    /**
+     * @var int
+     */
+    private int $pingInterval = WscCommonsContract::DEFAULT_PING_INTERVAL;
+
+    /**
+     * @return int
+     */
+    public function getTimeout(): int
+    {
+        return $this->timeout;
+    }
+
+    /**
+     * @param int $timeout
+     * @return WebSocketConfig
+     */
+    public function setTimeout(int $timeout): WebSocketConfig
+    {
+        $this->timeout = $timeout;
+        return $this;
+    }
+
+    /**
+     * @param int $int
+     * @return $this
+     */
+    public function setPingInterval(int $int): WebSocketConfig
+    {
+        $this->pingInterval = $int;
+        return $this;
+    }
+
+    /**
+     * @return int
+     */
+    public function getPingInterval(): int
+    {
+        return $this->pingInterval;
+    }
+
+    /**
+     * @return array
+     */
+    public function getHeaders(): array
+    {
+        return $this->headers;
+    }
+
+    /**
+     * @param array $headers
+     * @return WebSocketConfig
+     */
+    public function setHeaders(array $headers): WebSocketConfig
+    {
+        $this->headers = $headers;
+        return $this;
+    }
+
+    /**
+     * @return int
+     */
+    public function getFragmentSize(): int
+    {
+        return $this->fragmentSize;
+    }
+
+    /**
+     * @param int $fragmentSize
+     * @return WebSocketConfig
+     */
+    public function setFragmentSize(int $fragmentSize): WebSocketConfig
+    {
+        $this->fragmentSize = $fragmentSize;
+        return $this;
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getContext(): mixed
+    {
+        return $this->context;
+    }
+
+    /**
+     * @param mixed $context
+     * @return WebSocketConfig
+     */
+    public function setContext(mixed $context): WebSocketConfig
+    {
+        $this->context = $context;
+        return $this;
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getScheme(): string
+    {
+        return $this->scheme;
+    }
+
+    /**
+     * @param string $scheme
+     * @return WebSocketConfig
+     */
+    public function setScheme(string $scheme): WebSocketConfig
+    {
+        $this->scheme = $scheme;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getHost(): string
+    {
+        return $this->host;
+    }
+
+    /**
+     * @param string $host
+     * @return WebSocketConfig
+     */
+    public function setHost(string $host): WebSocketConfig
+    {
+        $this->host = $host;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getUser(): string
+    {
+        return $this->user;
+    }
+
+    /**
+     * @param array $urlParts
+     * @return WebSocketConfig
+     */
+    public function setUser(array $urlParts): WebSocketConfig
+    {
+        $this->user = $urlParts['user'] ?? '';
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getPassword(): string
+    {
+        return $this->password;
+    }
+
+    /**
+     * @param array $urlParts
+     * @return WebSocketConfig
+     */
+    public function setPassword(array $urlParts): WebSocketConfig
+    {
+        $this->password = $urlParts['pass'] ?? '';
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getPort(): string
+    {
+        return $this->port;
+    }
+
+    /**
+     * @param array $urlParts
+     * @return WebSocketConfig
+     */
+    public function setPort(array $urlParts): WebSocketConfig
+    {
+        $this->port = $urlParts['port'] ?? ($this->scheme === 'wss' ? '443' : '80');
+        return $this;
+    }
+
+    /**
+     * @return array
+     */
+    public function getContextOptions(): array
+    {
+        return $this->contextOptions;
+    }
+
+    /**
+     * @param array $contextOptions
+     * @return WebSocketConfig
+     */
+    public function setContextOptions(array $contextOptions): WebSocketConfig
+    {
+        $this->contextOptions = $contextOptions;
+        return $this;
+    }
+
+    /**
+     * @param string $ip
+     * @param string $port
+     * @return WebSocketConfig
+     */
+    public function setProxy(string $ip, string $port): WebSocketConfig
+    {
+        $this->hasProxy = true;
+        $this->proxyIp = $ip;
+        $this->proxyPort = $port;
+
+        return $this;
+    }
+
+    /**
+     * Sets auth for proxy
+     *
+     * @param string $userName
+     * @param string $password
+     * @return WebSocketConfig
+     */
+    public function setProxyAuth(string $userName, string $password): WebSocketConfig
+    {
+        $this->proxyAuth = (empty($userName) === false && empty($password) === false) ? base64_encode($userName . ':' . $password) : null;
+        return $this;
+    }
+
+    /**
+     * @return bool
+     */
+    public function hasProxy(): bool
+    {
+        return $this->hasProxy;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getProxyIp(): ?string
+    {
+        return $this->proxyIp;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getProxyPort(): ?string
+    {
+        return $this->proxyPort;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getProxyAuth(): ?string
+    {
+        return $this->proxyAuth;
+    }
 
 }

src/Middleware.php

Indentation +187 added lines, -187 removed lines

@@ -17,192 +17,192 @@
 class Middleware
 {
 
-	/**
-	 * Create curl handler.
-	 *
-	 * @param ?string $method
-	 * @param string $uri
-	 * @param array|HttpOptions $options
-	 *
-	 * @return \CurlHandle|false
-	 */
-	public static function create_curl_handler(?string $method, string $uri, array|HttpOptions $options = []): \CurlHandle|false
-	{
-		$handler = curl_init();
-		if (is_resource($handler) || !$handler) {
-			return false;
-		}
-
-		if (gettype($options) === 'array') {
-			$options = new HttpOptions($options);
-		}
-
-		if (count($options->getQuery()) > 0) {
-			if (!str_contains($uri, '?')) {
-				$uri .= '?';
-			}
-			$uri .= $options->getQueryString();
-		}
-
-		curl_setopt($handler, CURLOPT_URL, $uri);
-
-		self::set_curl_options($method, $handler, $options);
-
-		return $handler;
-	}
-
-	/**
-	 * Setup curl options based on the given method and our options.
-	 *
-	 * @param \CurlHandle $cHandler
-	 * @param ?string $method
-	 * @param HttpOptions $options
-	 *
-	 * @return void
-	 */
-	public static function set_curl_options(?string $method, \CurlHandle $cHandler, HttpOptions $options): void
-	{
-		curl_setopt($cHandler, CURLOPT_HEADER, true);
-		curl_setopt($cHandler, CURLOPT_CUSTOMREQUEST, $method ?? 'GET');
-
-		# Fetch the header
-		$fetchedHeaders = [];
-		foreach ($options->getHeaders() as $header => $value) {
-			$fetchedHeaders[] = $header . ': ' . $value;
-		}
-
-		# Set headers
-		curl_setopt($cHandler, CURLOPT_HTTPHEADER, $fetchedHeaders ?? []);
-
-		# Add body if we have one.
-		if ($options->getBody()) {
-			curl_setopt($cHandler, CURLOPT_CUSTOMREQUEST, $method ?? 'POST');
-			curl_setopt($cHandler, CURLOPT_POSTFIELDS, $options->getBody());
-			curl_setopt($cHandler, CURLOPT_POST, true);
-		}
-
-		# Check for a proxy
-		if ($options->getProxy() != null) {
-			curl_setopt($cHandler, CURLOPT_PROXY, $options->getProxy()->getHost());
-			curl_setopt($cHandler, CURLOPT_PROXYUSERPWD, $options->getProxy()->getAuth());
-			if ($options->getProxy()->type !== null) {
-				curl_setopt($cHandler, CURLOPT_PROXYTYPE, $options->getProxy()->type);
-			}
-		}
-
-		curl_setopt($cHandler, CURLOPT_RETURNTRANSFER, true);
-		curl_setopt($cHandler, CURLOPT_FOLLOWLOCATION, true);
-
-		# Add and override the custom curl options.
-		foreach ($options->getCurlOptions() as $option => $value) {
-			curl_setopt($cHandler, $option, $value);
-		}
-
-		# if we have a timeout, set it.
-		curl_setopt($cHandler, CURLOPT_TIMEOUT, $options->getTimeout());
-
-		# If self-signed certs are allowed, set it.
-		if ((bool)getenv('HAS_SELF_SIGNED_CERT') === true) {
-			curl_setopt($cHandler, CURLOPT_SSL_VERIFYPEER, false);
-			curl_setopt($cHandler, CURLOPT_SSL_VERIFYHOST, false);
-		}
-
-		(new Middleware())->handle_media($cHandler, $options);
-	}
-
-	/**
-	 * Handle the media
-	 *
-	 * @param \CurlHandle $handler
-	 * @param HttpOptions $options
-	 * @return void
-	 */
-	private function handle_media(\CurlHandle $handler, HttpOptions $options): void
-	{
-		if (count($options->getMultipart()) > 0) {
-			curl_setopt($handler, CURLOPT_POST, true);
-			curl_setopt($handler, CURLOPT_CUSTOMREQUEST, 'POST');
-
-			$form_data = new FormData();
-			foreach ($options->getMultipart() as $key => $value) {
-				$form_data->addFile($key, $value);
-			}
-
-			$headers = [];
-			foreach ($options->getHeaders() as $header => $value) {
-				if (Toolkit::insensitiveString($header, 'content-type')) continue;
-				$headers[] = $header . ': ' . $value;
-			}
-			$headers[] = 'Content-Type: multipart/form-data';
-
-			curl_setopt($handler, CURLOPT_HTTPHEADER, $headers);
-			curl_setopt($handler, CURLOPT_POSTFIELDS, $form_data->getFiles());
-		}
-	}
-
-	/**
-	 * @param mixed $socket
-	 * @param int $len
-	 * @return string|null
-	 * @throws ConnectionException
-	 */
-	public static function stream_read(mixed $socket, int $len): string|null
-	{
-		if (!is_resource($socket)) {
-			throw new ConnectionException(sprintf(
-				'%s is not a valid resource. Datatype: %s', $socket, gettype($socket)
-			));
-		}
-
-		$data = '';
-		while (($dataLen = strlen($data)) < $len) {
-			$buff = fread($socket, $len - $dataLen);
-
-			if ($buff === false) {
-				return null;
-			}
-
-			if ($buff === '') {
-				$metadata = stream_get_meta_data($socket);
-				throw new ConnectionException(
-					sprintf('Empty read; connection dead?  Stream state: %s', json_encode($metadata)),
-					CommonsContract::CLIENT_EMPTY_READ
-				);
-			}
-			$data .= $buff;
-		}
-
-		return $data;
-	}
-
-	/**
-	 * @param mixed $socket
-	 * @param string $data
-	 * @return bool
-	 * @throws ConnectionException
-	 */
-	public static function stream_write(mixed $socket, string $data): bool
-	{
-		if (!is_resource($socket)) {
-			throw new ConnectionException(sprintf(
-				'%s is not a valid resource. Datatype: %s', $socket, gettype($socket)
-			));
-		}
-
-		$written = fwrite($socket, $data);
-
-		if ($written < strlen($data)) {
-			throw new ConnectionException(
-				sprintf('Could only write %s out of %s bytes.', $written, strlen($data)),
-				CommonsContract::CLIENT_COULD_ONLY_WRITE_LESS
-			);
-		}
-
-		return true;
-	}
-
-	/**
-	 * Stream connect
-	 */
+    /**
+     * Create curl handler.
+     *
+     * @param ?string $method
+     * @param string $uri
+     * @param array|HttpOptions $options
+     *
+     * @return \CurlHandle|false
+     */
+    public static function create_curl_handler(?string $method, string $uri, array|HttpOptions $options = []): \CurlHandle|false
+    {
+        $handler = curl_init();
+        if (is_resource($handler) || !$handler) {
+            return false;
+        }
+
+        if (gettype($options) === 'array') {
+            $options = new HttpOptions($options);
+        }
+
+        if (count($options->getQuery()) > 0) {
+            if (!str_contains($uri, '?')) {
+                $uri .= '?';
+            }
+            $uri .= $options->getQueryString();
+        }
+
+        curl_setopt($handler, CURLOPT_URL, $uri);
+
+        self::set_curl_options($method, $handler, $options);
+
+        return $handler;
+    }
+
+    /**
+     * Setup curl options based on the given method and our options.
+     *
+     * @param \CurlHandle $cHandler
+     * @param ?string $method
+     * @param HttpOptions $options
+     *
+     * @return void
+     */
+    public static function set_curl_options(?string $method, \CurlHandle $cHandler, HttpOptions $options): void
+    {
+        curl_setopt($cHandler, CURLOPT_HEADER, true);
+        curl_setopt($cHandler, CURLOPT_CUSTOMREQUEST, $method ?? 'GET');
+
+        # Fetch the header
+        $fetchedHeaders = [];
+        foreach ($options->getHeaders() as $header => $value) {
+            $fetchedHeaders[] = $header . ': ' . $value;
+        }
+
+        # Set headers
+        curl_setopt($cHandler, CURLOPT_HTTPHEADER, $fetchedHeaders ?? []);
+
+        # Add body if we have one.
+        if ($options->getBody()) {
+            curl_setopt($cHandler, CURLOPT_CUSTOMREQUEST, $method ?? 'POST');
+            curl_setopt($cHandler, CURLOPT_POSTFIELDS, $options->getBody());
+            curl_setopt($cHandler, CURLOPT_POST, true);
+        }
+
+        # Check for a proxy
+        if ($options->getProxy() != null) {
+            curl_setopt($cHandler, CURLOPT_PROXY, $options->getProxy()->getHost());
+            curl_setopt($cHandler, CURLOPT_PROXYUSERPWD, $options->getProxy()->getAuth());
+            if ($options->getProxy()->type !== null) {
+                curl_setopt($cHandler, CURLOPT_PROXYTYPE, $options->getProxy()->type);
+            }
+        }
+
+        curl_setopt($cHandler, CURLOPT_RETURNTRANSFER, true);
+        curl_setopt($cHandler, CURLOPT_FOLLOWLOCATION, true);
+
+        # Add and override the custom curl options.
+        foreach ($options->getCurlOptions() as $option => $value) {
+            curl_setopt($cHandler, $option, $value);
+        }
+
+        # if we have a timeout, set it.
+        curl_setopt($cHandler, CURLOPT_TIMEOUT, $options->getTimeout());
+
+        # If self-signed certs are allowed, set it.
+        if ((bool)getenv('HAS_SELF_SIGNED_CERT') === true) {
+            curl_setopt($cHandler, CURLOPT_SSL_VERIFYPEER, false);
+            curl_setopt($cHandler, CURLOPT_SSL_VERIFYHOST, false);
+        }
+
+        (new Middleware())->handle_media($cHandler, $options);
+    }
+
+    /**
+     * Handle the media
+     *
+     * @param \CurlHandle $handler
+     * @param HttpOptions $options
+     * @return void
+     */
+    private function handle_media(\CurlHandle $handler, HttpOptions $options): void
+    {
+        if (count($options->getMultipart()) > 0) {
+            curl_setopt($handler, CURLOPT_POST, true);
+            curl_setopt($handler, CURLOPT_CUSTOMREQUEST, 'POST');
+
+            $form_data = new FormData();
+            foreach ($options->getMultipart() as $key => $value) {
+                $form_data->addFile($key, $value);
+            }
+
+            $headers = [];
+            foreach ($options->getHeaders() as $header => $value) {
+                if (Toolkit::insensitiveString($header, 'content-type')) continue;
+                $headers[] = $header . ': ' . $value;
+            }
+            $headers[] = 'Content-Type: multipart/form-data';
+
+            curl_setopt($handler, CURLOPT_HTTPHEADER, $headers);
+            curl_setopt($handler, CURLOPT_POSTFIELDS, $form_data->getFiles());
+        }
+    }
+
+    /**
+     * @param mixed $socket
+     * @param int $len
+     * @return string|null
+     * @throws ConnectionException
+     */
+    public static function stream_read(mixed $socket, int $len): string|null
+    {
+        if (!is_resource($socket)) {
+            throw new ConnectionException(sprintf(
+                '%s is not a valid resource. Datatype: %s', $socket, gettype($socket)
+            ));
+        }
+
+        $data = '';
+        while (($dataLen = strlen($data)) < $len) {
+            $buff = fread($socket, $len - $dataLen);
+
+            if ($buff === false) {
+                return null;
+            }
+
+            if ($buff === '') {
+                $metadata = stream_get_meta_data($socket);
+                throw new ConnectionException(
+                    sprintf('Empty read; connection dead?  Stream state: %s', json_encode($metadata)),
+                    CommonsContract::CLIENT_EMPTY_READ
+                );
+            }
+            $data .= $buff;
+        }
+
+        return $data;
+    }
+
+    /**
+     * @param mixed $socket
+     * @param string $data
+     * @return bool
+     * @throws ConnectionException
+     */
+    public static function stream_write(mixed $socket, string $data): bool
+    {
+        if (!is_resource($socket)) {
+            throw new ConnectionException(sprintf(
+                '%s is not a valid resource. Datatype: %s', $socket, gettype($socket)
+            ));
+        }
+
+        $written = fwrite($socket, $data);
+
+        if ($written < strlen($data)) {
+            throw new ConnectionException(
+                sprintf('Could only write %s out of %s bytes.', $written, strlen($data)),
+                CommonsContract::CLIENT_COULD_ONLY_WRITE_LESS
+            );
+        }
+
+        return true;
+    }
+
+    /**
+     * Stream connect
+     */
 
 }
\ No newline at end of file

src/Traits/WSClientTrait.php

Indentation +266 added lines, -266 removed lines

@@ -19,271 +19,271 @@
 trait WSClientTrait
 {
 
-	/**
-	 * Validates whether server sent valid upgrade response
-	 *
-	 * @param WebSocketConfig $config
-	 * @param string $pathWithQuery
-	 * @param string $key
-	 * @throws ConnectionException
-	 */
-	private function validateResponse(WebSocketConfig $config, string $pathWithQuery, string $key): void
-	{
-		$response = stream_get_line($this->socket, self::DEFAULT_RESPONSE_HEADER, "\r\n\r\n");
-		if (!preg_match(self::SEC_WEBSOCKET_ACCEPT_PTTRN, $response, $matches)) {
-			$address = $config->getScheme() . '://' . $config->getHost() . ':' . $config->getPort() . $pathWithQuery;
-			throw new ConnectionException(
-				"Connection to '{$address}' failed: Server sent invalid upgrade response:\n"
-				. $response, CommonsContract::CLIENT_INVALID_UPGRADE_RESPONSE
-			);
-		}
-
-		$keyAccept = trim($matches[1]);
-		$expectedResponse = base64_encode(pack('H*', sha1($key . self::SERVER_KEY_ACCEPT)));
-		if ($keyAccept !== $expectedResponse) {
-			throw new ConnectionException(
-				'Server sent bad upgrade response.',
-				CommonsContract::CLIENT_INVALID_UPGRADE_RESPONSE
-			);
-		}
-	}
-
-	/**
-	 *  Gets host uri based on protocol
-	 *
-	 * @param WebSocketConfig $config
-	 * @return string
-	 * @throws BadUriException
-	 */
-	private function getHostUri(WebSocketConfig $config): string
-	{
-		if (in_array($config->getScheme(), ['ws', 'wss'], true) === false) {
-			throw new BadUriException(
-				"Url should have scheme ws or wss, not '{$config->getScheme()}' from URI '$this->socketUrl' .",
-				CommonsContract::CLIENT_INCORRECT_SCHEME
-			);
-		}
-
-		return ($config->getScheme() === 'wss' ? 'ssl' : 'tcp') . '://' . $config->getHost();
-	}
-
-	/**
-	 * @param string $data
-	 * @return float|int
-	 * @throws ConnectionException
-	 */
-	private function getPayloadLength(string $data): float|int
-	{
-		$payloadLength = (int)ord($data[1]) & self::MASK_127; // Bits 1-7 in byte 1
-		if ($payloadLength > self::MASK_125) {
-			if ($payloadLength === self::MASK_126) {
-				$data = $this->read(2); // 126: Payload is a 16-bit unsigned int
-			} else {
-				$data = $this->read(8); // 127: Payload is a 64-bit unsigned int
-			}
-			$payloadLength = bindec(Toolkit::sprintB($data));
-		}
-
-		return $payloadLength;
-	}
-
-	/**
-	 * @param string $data
-	 * @param int $payloadLength
-	 * @return string
-	 * @throws ConnectionException
-	 */
-	private function getPayloadData(string $data, int $payloadLength): string
-	{
-		// Masking?
-		$mask = (bool)(ord($data[1]) >> 7);  // Bit 0 in byte 1
-		$payload = '';
-		$maskingKey = '';
-
-		// Get masking key.
-		if ($mask) {
-			$maskingKey = $this->read(4);
-		}
-
-		// Get the actual payload, if any (might not be for e.g. close frames.
-		if ($payloadLength > 0) {
-			$data = $this->read($payloadLength);
-
-			if ($mask) {
-				// Unmask payload.
-				for ($i = 0; $i < $payloadLength; $i++) {
-					$payload .= ($data[$i] ^ $maskingKey[$i % 4]);
-				}
-			} else {
-				$payload = $data;
-			}
-		}
-
-		return $payload;
-	}
-
-	/**
-	 * @return string|null
-	 * @throws \Exception
-	 */
-	protected function receiveFragment(): string|null
-	{
-		$data = $this->read(2);
-		if (is_string($data) === false) {
-			return null;
-		}
-
-		$final = (bool)(ord($data[0]) & 1 << 7);
-
-		$opcodeInt = ord($data[0]) & 31;
-		$opcodeInts = array_flip(self::$opcodes);
-		if (!array_key_exists($opcodeInt, $opcodeInts)) {
-			throw new ConnectionException(
-				"Bad opcode in websocket frame: $opcodeInt",
-				CommonsContract::CLIENT_BAD_OPCODE
-			);
-		}
-
-		$opcode = $opcodeInts[$opcodeInt];
-
-		if ($opcode !== 'continuation') {
-			$this->lastOpcode = $opcode;
-		}
-
-		$payloadLength = $this->getPayloadLength($data);
-		$payload = $this->getPayloadData($data, $payloadLength);
-
-		if ($opcode === CommonsContract::EVENT_TYPE_CLOSE) {
-			if ($payloadLength >= 2) {
-				$statusBin = $payload[0] . $payload[1];
-				$status = bindec(sprintf('%08b%08b', ord($payload[0]), ord($payload[1])));
-				$this->closeStatus = $status;
-				$payload = substr($payload, 2);
-
-				if (!$this->isClosing) {
-					$this->send($statusBin . 'Close acknowledged: ' . $status,
-						CommonsContract::EVENT_TYPE_CLOSE); // Respond.
-				}
-			}
-
-			if ($this->isClosing) {
-				$this->isClosing = false; // A close response, all done.
-			}
-
-			fclose($this->socket);
-			$this->isConnected = false;
-		}
-
-		if (!$final) {
-			$this->hugePayload .= $payload;
-
-			return null;
-		}
-
-		if ($this->hugePayload) {
-			$payload = $this->hugePayload .= $payload;
-			$this->hugePayload = null;
-		}
-
-		return $payload;
-	}
-
-	/**
-	 * @param $final
-	 * @param $payload
-	 * @param $opcode
-	 * @param $masked
-	 * @throws \Exception
-	 */
-	protected function sendFragment($final, $payload, $opcode, $masked): void
-	{
-		// Binary string for header.
-		$frameHeadBin = '';
-		// Write FIN, final fragment bit.
-		$frameHeadBin .= (bool)$final ? '1' : '0';
-		// RSV 1, 2, & 3 false and unused.
-		$frameHeadBin .= '000';
-		// Opcode rest of the byte.
-		$frameHeadBin .= sprintf('%04b', self::$opcodes[$opcode]);
-		// Use masking?
-		$frameHeadBin .= $masked ? '1' : '0';
-
-		// 7 bits of payload length...
-		$payloadLen = strlen($payload);
-		if ($payloadLen > self::MAX_BYTES_READ) {
-			$frameHeadBin .= decbin(self::MASK_127);
-			$frameHeadBin .= sprintf('%064b', $payloadLen);
-		} else if ($payloadLen > self::MASK_125) {
-			$frameHeadBin .= decbin(self::MASK_126);
-			$frameHeadBin .= sprintf('%016b', $payloadLen);
-		} else {
-			$frameHeadBin .= sprintf('%07b', $payloadLen);
-		}
-
-		$frame = '';
-
-		// Write frame head to frame.
-		foreach (str_split($frameHeadBin, 8) as $binstr) {
-			$frame .= chr(bindec($binstr));
-		}
-		// Handle masking
-		if ($masked) {
-			// generate a random mask:
-			$mask = '';
-			for ($i = 0; $i < 4; $i++) {
-				$mask .= chr(random_int(0, 255));
-			}
-			$frame .= $mask;
-		}
-
-		// Append payload to frame:
-		for ($i = 0; $i < $payloadLen; $i++) {
-			$frame .= ($masked === true) ? $payload[$i] ^ $mask[$i % 4] : $payload[$i];
-		}
-
-		$this->write($frame);
-	}
-
-	/**
-	 * Sec-WebSocket-Key generator
-	 *
-	 * @return string   the 16 character length key
-	 * @throws \Exception
-	 */
-	private function generateKey(): string
-	{
-		$chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"$&/()=[]{}0123456789';
-		$key = '';
-		$chLen = strlen($chars);
-		for ($i = 0; $i < self::KEY_GEN_LENGTH; $i++) {
-			$key .= $chars[random_int(0, $chLen - 1)];
-		}
-
-		return base64_encode($key);
-	}
-
-	/**
-	 * @param int $len
-	 * @return string|null
-	 * @throws ConnectionException
-	 */
-	protected function read(int $len): string|null
-	{
-		if ($this->socket && $this->isConnected()) {
-			return Middleware::stream_read($this->socket, $len);
-		}
-
-		return null;
-	}
-
-	/**
-	 * @param string $data
-	 * @return void
-	 * @throws ConnectionException
-	 */
-	protected function write(string $data): void
-	{
-		Middleware::stream_write($this->socket, $data);
-	}
+    /**
+     * Validates whether server sent valid upgrade response
+     *
+     * @param WebSocketConfig $config
+     * @param string $pathWithQuery
+     * @param string $key
+     * @throws ConnectionException
+     */
+    private function validateResponse(WebSocketConfig $config, string $pathWithQuery, string $key): void
+    {
+        $response = stream_get_line($this->socket, self::DEFAULT_RESPONSE_HEADER, "\r\n\r\n");
+        if (!preg_match(self::SEC_WEBSOCKET_ACCEPT_PTTRN, $response, $matches)) {
+            $address = $config->getScheme() . '://' . $config->getHost() . ':' . $config->getPort() . $pathWithQuery;
+            throw new ConnectionException(
+                "Connection to '{$address}' failed: Server sent invalid upgrade response:\n"
+                . $response, CommonsContract::CLIENT_INVALID_UPGRADE_RESPONSE
+            );
+        }
+
+        $keyAccept = trim($matches[1]);
+        $expectedResponse = base64_encode(pack('H*', sha1($key . self::SERVER_KEY_ACCEPT)));
+        if ($keyAccept !== $expectedResponse) {
+            throw new ConnectionException(
+                'Server sent bad upgrade response.',
+                CommonsContract::CLIENT_INVALID_UPGRADE_RESPONSE
+            );
+        }
+    }
+
+    /**
+     *  Gets host uri based on protocol
+     *
+     * @param WebSocketConfig $config
+     * @return string
+     * @throws BadUriException
+     */
+    private function getHostUri(WebSocketConfig $config): string
+    {
+        if (in_array($config->getScheme(), ['ws', 'wss'], true) === false) {
+            throw new BadUriException(
+                "Url should have scheme ws or wss, not '{$config->getScheme()}' from URI '$this->socketUrl' .",
+                CommonsContract::CLIENT_INCORRECT_SCHEME
+            );
+        }
+
+        return ($config->getScheme() === 'wss' ? 'ssl' : 'tcp') . '://' . $config->getHost();
+    }
+
+    /**
+     * @param string $data
+     * @return float|int
+     * @throws ConnectionException
+     */
+    private function getPayloadLength(string $data): float|int
+    {
+        $payloadLength = (int)ord($data[1]) & self::MASK_127; // Bits 1-7 in byte 1
+        if ($payloadLength > self::MASK_125) {
+            if ($payloadLength === self::MASK_126) {
+                $data = $this->read(2); // 126: Payload is a 16-bit unsigned int
+            } else {
+                $data = $this->read(8); // 127: Payload is a 64-bit unsigned int
+            }
+            $payloadLength = bindec(Toolkit::sprintB($data));
+        }
+
+        return $payloadLength;
+    }
+
+    /**
+     * @param string $data
+     * @param int $payloadLength
+     * @return string
+     * @throws ConnectionException
+     */
+    private function getPayloadData(string $data, int $payloadLength): string
+    {
+        // Masking?
+        $mask = (bool)(ord($data[1]) >> 7);  // Bit 0 in byte 1
+        $payload = '';
+        $maskingKey = '';
+
+        // Get masking key.
+        if ($mask) {
+            $maskingKey = $this->read(4);
+        }
+
+        // Get the actual payload, if any (might not be for e.g. close frames.
+        if ($payloadLength > 0) {
+            $data = $this->read($payloadLength);
+
+            if ($mask) {
+                // Unmask payload.
+                for ($i = 0; $i < $payloadLength; $i++) {
+                    $payload .= ($data[$i] ^ $maskingKey[$i % 4]);
+                }
+            } else {
+                $payload = $data;
+            }
+        }
+
+        return $payload;
+    }
+
+    /**
+     * @return string|null
+     * @throws \Exception
+     */
+    protected function receiveFragment(): string|null
+    {
+        $data = $this->read(2);
+        if (is_string($data) === false) {
+            return null;
+        }
+
+        $final = (bool)(ord($data[0]) & 1 << 7);
+
+        $opcodeInt = ord($data[0]) & 31;
+        $opcodeInts = array_flip(self::$opcodes);
+        if (!array_key_exists($opcodeInt, $opcodeInts)) {
+            throw new ConnectionException(
+                "Bad opcode in websocket frame: $opcodeInt",
+                CommonsContract::CLIENT_BAD_OPCODE
+            );
+        }
+
+        $opcode = $opcodeInts[$opcodeInt];
+
+        if ($opcode !== 'continuation') {
+            $this->lastOpcode = $opcode;
+        }
+
+        $payloadLength = $this->getPayloadLength($data);
+        $payload = $this->getPayloadData($data, $payloadLength);
+
+        if ($opcode === CommonsContract::EVENT_TYPE_CLOSE) {
+            if ($payloadLength >= 2) {
+                $statusBin = $payload[0] . $payload[1];
+                $status = bindec(sprintf('%08b%08b', ord($payload[0]), ord($payload[1])));
+                $this->closeStatus = $status;
+                $payload = substr($payload, 2);
+
+                if (!$this->isClosing) {
+                    $this->send($statusBin . 'Close acknowledged: ' . $status,
+                        CommonsContract::EVENT_TYPE_CLOSE); // Respond.
+                }
+            }
+
+            if ($this->isClosing) {
+                $this->isClosing = false; // A close response, all done.
+            }
+
+            fclose($this->socket);
+            $this->isConnected = false;
+        }
+
+        if (!$final) {
+            $this->hugePayload .= $payload;
+
+            return null;
+        }
+
+        if ($this->hugePayload) {
+            $payload = $this->hugePayload .= $payload;
+            $this->hugePayload = null;
+        }
+
+        return $payload;
+    }
+
+    /**
+     * @param $final
+     * @param $payload
+     * @param $opcode
+     * @param $masked
+     * @throws \Exception
+     */
+    protected function sendFragment($final, $payload, $opcode, $masked): void
+    {
+        // Binary string for header.
+        $frameHeadBin = '';
+        // Write FIN, final fragment bit.
+        $frameHeadBin .= (bool)$final ? '1' : '0';
+        // RSV 1, 2, & 3 false and unused.
+        $frameHeadBin .= '000';
+        // Opcode rest of the byte.
+        $frameHeadBin .= sprintf('%04b', self::$opcodes[$opcode]);
+        // Use masking?
+        $frameHeadBin .= $masked ? '1' : '0';
+
+        // 7 bits of payload length...
+        $payloadLen = strlen($payload);
+        if ($payloadLen > self::MAX_BYTES_READ) {
+            $frameHeadBin .= decbin(self::MASK_127);
+            $frameHeadBin .= sprintf('%064b', $payloadLen);
+        } else if ($payloadLen > self::MASK_125) {
+            $frameHeadBin .= decbin(self::MASK_126);
+            $frameHeadBin .= sprintf('%016b', $payloadLen);
+        } else {
+            $frameHeadBin .= sprintf('%07b', $payloadLen);
+        }
+
+        $frame = '';
+
+        // Write frame head to frame.
+        foreach (str_split($frameHeadBin, 8) as $binstr) {
+            $frame .= chr(bindec($binstr));
+        }
+        // Handle masking
+        if ($masked) {
+            // generate a random mask:
+            $mask = '';
+            for ($i = 0; $i < 4; $i++) {
+                $mask .= chr(random_int(0, 255));
+            }
+            $frame .= $mask;
+        }
+
+        // Append payload to frame:
+        for ($i = 0; $i < $payloadLen; $i++) {
+            $frame .= ($masked === true) ? $payload[$i] ^ $mask[$i % 4] : $payload[$i];
+        }
+
+        $this->write($frame);
+    }
+
+    /**
+     * Sec-WebSocket-Key generator
+     *
+     * @return string   the 16 character length key
+     * @throws \Exception
+     */
+    private function generateKey(): string
+    {
+        $chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"$&/()=[]{}0123456789';
+        $key = '';
+        $chLen = strlen($chars);
+        for ($i = 0; $i < self::KEY_GEN_LENGTH; $i++) {
+            $key .= $chars[random_int(0, $chLen - 1)];
+        }
+
+        return base64_encode($key);
+    }
+
+    /**
+     * @param int $len
+     * @return string|null
+     * @throws ConnectionException
+     */
+    protected function read(int $len): string|null
+    {
+        if ($this->socket && $this->isConnected()) {
+            return Middleware::stream_read($this->socket, $len);
+        }
+
+        return null;
+    }
+
+    /**
+     * @param string $data
+     * @return void
+     * @throws ConnectionException
+     */
+    protected function write(string $data): void
+    {
+        Middleware::stream_write($this->socket, $data);
+    }
 
 }
\ No newline at end of file

src/Traits/WSConnectionTrait.php

Indentation +246 added lines, -246 removed lines

@@ -18,251 +18,251 @@
 trait WSConnectionTrait
 {
 
-	/**
-	 * @var callable|null
-	 */
-	public $onOpen = null;
-
-	/**
-	 * @var callable|null
-	 */
-	public $onClose = null;
-
-	/**
-	 * @var callable|null
-	 */
-	public $onError = null;
-
-	/**
-	 * @var callable|null
-	 */
-	public $onMessage = null;
-
-	/**
-	 * @var callable|null
-	 */
-	public $onWhile = null;
-
-	/**
-	 * @var bool
-	 */
-	private bool $isConnected = false;
-
-	/**
-	 * @var bool
-	 */
-	private bool $isClosing = false;
-
-	/**
-	 * Default headers
-	 *
-	 * @var array
-	 */
-	private array $defaultHeaders = [
-		'Connection' => 'Upgrade',
-		'Upgrade' => 'WebSocket',
-		'Sec-Websocket-Version' => '13',
-	];
-
-	/**
-	 * @param string $socketUrl string that represents the URL of the Web Socket server. e.g. ws://localhost:1337 or wss://localhost:1337
-	 * @param ?WebSocketConfig $config The configuration for the Web Socket client
-	 */
-	public function connect(string $socketUrl, ?WebSocketConfig $config = null): void
-	{
-		try {
-			$this->config = $config ?? new WebSocketConfig();
-			$this->socketUrl = $socketUrl;
-			$urlParts = parse_url($this->socketUrl);
-
-			$this->config->setScheme($urlParts['scheme']);
-			$this->config->setHost($urlParts['host']);
-			$this->config->setUser($urlParts);
-			$this->config->setPassword($urlParts);
-			$this->config->setPort($urlParts);
-
-			$pathWithQuery = $this->getPathWithQuery($urlParts);
-			$hostUri = $this->getHostUri($this->config);
-
-			$context = $this->getStreamContext();
-			if ($this->config->hasProxy()) {
-				$this->socket = $this->proxy();
-			} else {
-				$this->socket = @stream_socket_client(
-					$hostUri . ':' . $this->config->getPort(),
-					$errno,
-					$errstr,
-					$this->config->getTimeout(),
-					STREAM_CLIENT_CONNECT,
-					$context
-				);
-			}
-
-			if ($this->socket === false) {
-				throw new ConnectionException(
-					"Could not open socket to \"{$this->config->getHost()}:{$this->config->getPort()}\": $errstr ($errno).",
-					CommonsContract::CLIENT_COULD_NOT_OPEN_SOCKET
-				);
-			}
-
-			stream_set_timeout($this->socket, $this->config->getTimeout());
-
-			$key = $this->generateKey();
-			$headers = array_merge($this->defaultHeaders, [
-				'Host' => $this->config->getHost() . ':' . $this->config->getPort(),
-				'User-Agent' => 'Easy-Http/' . self::VERSION . ' (PHP/' . PHP_VERSION . ')',
-				'Sec-WebSocket-Key' => $key,
-			]);
-
-			if ($this->config->getUser() || $this->config->getPassword()) {
-				$headers['authorization'] = 'Basic ' . base64_encode($this->config->getUser() . ':' . $this->config->getPassword()) . "\r\n";
-			}
-
-			if (!empty($this->config->getHeaders())) {
-				$headers = array_merge($headers, $this->config->getHeaders());
-			}
-
-			$header = $this->getHeaders($pathWithQuery, $headers);
-
-			$this->write($header);
-
-			$this->validateResponse($this->config, $pathWithQuery, $key);
-			$this->isConnected = true;
-			$this->whileIsConnected();
-
-		} catch (\Exception $e) {
-			$this->safeCall($this->onError, $this, new WebSocketException(
-				$e->getMessage(),
-				$e->getCode(),
-				$e->getPrevious()
-			));
-		}
-	}
-
-	/**
-	 * Reconnect to the Web Socket server
-	 *
-	 * @return void
-	 * @throws \Exception
-	 */
-	public function reconnect(): void
-	{
-		if ($this->isConnected) {
-			$this->close();
-		}
-
-		$this->connect($this->socketUrl, $this->config);
-	}
-
-	/**
-	 * @return void
-	 * @throws WebSocketException|\Exception
-	 */
-	private function whileIsConnected(): void
-	{
-		$this->safeCall($this->onOpen, $this);
-
-		while ($this->isConnected()) {
-			$this->safeCall($this->onWhile, $this);
-
-			if (is_string(($message = $this->receive()))) {
-				$this->safeCall($this->onMessage, $this, $message);
-			}
-		}
-
-		$this->safeCall($this->onClose, $this, $this->closeStatus);
-	}
-
-	/**
-	 * Execute events with safety of exceptions
-	 *
-	 * @param callable|null $callback
-	 * @param mixed ...$args
-	 * @return void
-	 */
-	private function safeCall(?callable $callback, ...$args): void
-	{
-		if (is_callable($callback) && $callback) {
-			call_user_func($callback, ...$args);
-		}
-	}
-
-	/**
-	 * Sends message to opened socket connection client->server
-	 *
-	 * @param $payload
-	 * @param string $opcode
-	 * @throws \Exception
-	 */
-	public function send($payload, string $opcode = CommonsContract::EVENT_TYPE_TEXT): void
-	{
-		if (!$this->isConnected) {
-			throw new \Exception(
-				"Can't send message. Connection is not established.",
-				CommonsContract::CLIENT_CONNECTION_NOT_ESTABLISHED
-			);
-		}
-
-		if (array_key_exists($opcode, self::$opcodes) === false) {
-			throw new BadOpcodeException(
-				sprintf("Bad opcode '%s'.  Try 'text' or 'binary'.", $opcode),
-				CommonsContract::CLIENT_BAD_OPCODE
-			);
-		}
-
-		$payloadLength = strlen($payload);
-		$fragmentCursor = 0;
-
-		while ($payloadLength > $fragmentCursor) {
-			$subPayload = substr($payload, $fragmentCursor, $this->config->getFragmentSize());
-			$fragmentCursor += $this->config->getFragmentSize();
-			$final = $payloadLength <= $fragmentCursor;
-			$this->sendFragment($final, $subPayload, $opcode, true);
-			$opcode = 'continuation';
-		}
-	}
-
-	/**
-	 * Receives message client<-server
-	 *
-	 * @return string|null
-	 * @throws \Exception
-	 */
-	public function receive(): string|null
-	{
-		if (!$this->isConnected && $this->isClosing === false) {
-			throw new WebSocketException(
-				"Your unexpectedly disconnected from the server",
-				CommonsContract::CLIENT_CONNECTION_NOT_ESTABLISHED
-			);
-		}
-
-		$this->hugePayload = '';
-
-		return $this->receiveFragment();
-	}
-
-	/**
-	 * Tell the socket to close.
-	 *
-	 * @param integer $status http://tools.ietf.org/html/rfc6455#section-7.4
-	 * @param string $message A closing message, max 125 bytes.
-	 * @return bool|null|string
-	 * @throws \Exception
-	 */
-	public function close(int $status = 1000, string $message = 'ttfn'): bool|null|string
-	{
-		$statusBin = sprintf('%016b', $status);
-		$statusStr = '';
-
-		foreach (str_split($statusBin, 8) as $binstr) {
-			$statusStr .= chr(bindec($binstr));
-		}
-
-		$this->send($statusStr . $message, CommonsContract::EVENT_TYPE_CLOSE);
-		$this->isClosing = true;
-
-		return $this->receive(); // Receiving a close frame will close the socket now.
-	}
+    /**
+     * @var callable|null
+     */
+    public $onOpen = null;
+
+    /**
+     * @var callable|null
+     */
+    public $onClose = null;
+
+    /**
+     * @var callable|null
+     */
+    public $onError = null;
+
+    /**
+     * @var callable|null
+     */
+    public $onMessage = null;
+
+    /**
+     * @var callable|null
+     */
+    public $onWhile = null;
+
+    /**
+     * @var bool
+     */
+    private bool $isConnected = false;
+
+    /**
+     * @var bool
+     */
+    private bool $isClosing = false;
+
+    /**
+     * Default headers
+     *
+     * @var array
+     */
+    private array $defaultHeaders = [
+        'Connection' => 'Upgrade',
+        'Upgrade' => 'WebSocket',
+        'Sec-Websocket-Version' => '13',
+    ];
+
+    /**
+     * @param string $socketUrl string that represents the URL of the Web Socket server. e.g. ws://localhost:1337 or wss://localhost:1337
+     * @param ?WebSocketConfig $config The configuration for the Web Socket client
+     */
+    public function connect(string $socketUrl, ?WebSocketConfig $config = null): void
+    {
+        try {
+            $this->config = $config ?? new WebSocketConfig();
+            $this->socketUrl = $socketUrl;
+            $urlParts = parse_url($this->socketUrl);
+
+            $this->config->setScheme($urlParts['scheme']);
+            $this->config->setHost($urlParts['host']);
+            $this->config->setUser($urlParts);
+            $this->config->setPassword($urlParts);
+            $this->config->setPort($urlParts);
+
+            $pathWithQuery = $this->getPathWithQuery($urlParts);
+            $hostUri = $this->getHostUri($this->config);
+
+            $context = $this->getStreamContext();
+            if ($this->config->hasProxy()) {
+                $this->socket = $this->proxy();
+            } else {
+                $this->socket = @stream_socket_client(
+                    $hostUri . ':' . $this->config->getPort(),
+                    $errno,
+                    $errstr,
+                    $this->config->getTimeout(),
+                    STREAM_CLIENT_CONNECT,
+                    $context
+                );
+            }
+
+            if ($this->socket === false) {
+                throw new ConnectionException(
+                    "Could not open socket to \"{$this->config->getHost()}:{$this->config->getPort()}\": $errstr ($errno).",
+                    CommonsContract::CLIENT_COULD_NOT_OPEN_SOCKET
+                );
+            }
+
+            stream_set_timeout($this->socket, $this->config->getTimeout());
+
+            $key = $this->generateKey();
+            $headers = array_merge($this->defaultHeaders, [
+                'Host' => $this->config->getHost() . ':' . $this->config->getPort(),
+                'User-Agent' => 'Easy-Http/' . self::VERSION . ' (PHP/' . PHP_VERSION . ')',
+                'Sec-WebSocket-Key' => $key,
+            ]);
+
+            if ($this->config->getUser() || $this->config->getPassword()) {
+                $headers['authorization'] = 'Basic ' . base64_encode($this->config->getUser() . ':' . $this->config->getPassword()) . "\r\n";
+            }
+
+            if (!empty($this->config->getHeaders())) {
+                $headers = array_merge($headers, $this->config->getHeaders());
+            }
+
+            $header = $this->getHeaders($pathWithQuery, $headers);
+
+            $this->write($header);
+
+            $this->validateResponse($this->config, $pathWithQuery, $key);
+            $this->isConnected = true;
+            $this->whileIsConnected();
+
+        } catch (\Exception $e) {
+            $this->safeCall($this->onError, $this, new WebSocketException(
+                $e->getMessage(),
+                $e->getCode(),
+                $e->getPrevious()
+            ));
+        }
+    }
+
+    /**
+     * Reconnect to the Web Socket server
+     *
+     * @return void
+     * @throws \Exception
+     */
+    public function reconnect(): void
+    {
+        if ($this->isConnected) {
+            $this->close();
+        }
+
+        $this->connect($this->socketUrl, $this->config);
+    }
+
+    /**
+     * @return void
+     * @throws WebSocketException|\Exception
+     */
+    private function whileIsConnected(): void
+    {
+        $this->safeCall($this->onOpen, $this);
+
+        while ($this->isConnected()) {
+            $this->safeCall($this->onWhile, $this);
+
+            if (is_string(($message = $this->receive()))) {
+                $this->safeCall($this->onMessage, $this, $message);
+            }
+        }
+
+        $this->safeCall($this->onClose, $this, $this->closeStatus);
+    }
+
+    /**
+     * Execute events with safety of exceptions
+     *
+     * @param callable|null $callback
+     * @param mixed ...$args
+     * @return void
+     */
+    private function safeCall(?callable $callback, ...$args): void
+    {
+        if (is_callable($callback) && $callback) {
+            call_user_func($callback, ...$args);
+        }
+    }
+
+    /**
+     * Sends message to opened socket connection client->server
+     *
+     * @param $payload
+     * @param string $opcode
+     * @throws \Exception
+     */
+    public function send($payload, string $opcode = CommonsContract::EVENT_TYPE_TEXT): void
+    {
+        if (!$this->isConnected) {
+            throw new \Exception(
+                "Can't send message. Connection is not established.",
+                CommonsContract::CLIENT_CONNECTION_NOT_ESTABLISHED
+            );
+        }
+
+        if (array_key_exists($opcode, self::$opcodes) === false) {
+            throw new BadOpcodeException(
+                sprintf("Bad opcode '%s'.  Try 'text' or 'binary'.", $opcode),
+                CommonsContract::CLIENT_BAD_OPCODE
+            );
+        }
+
+        $payloadLength = strlen($payload);
+        $fragmentCursor = 0;
+
+        while ($payloadLength > $fragmentCursor) {
+            $subPayload = substr($payload, $fragmentCursor, $this->config->getFragmentSize());
+            $fragmentCursor += $this->config->getFragmentSize();
+            $final = $payloadLength <= $fragmentCursor;
+            $this->sendFragment($final, $subPayload, $opcode, true);
+            $opcode = 'continuation';
+        }
+    }
+
+    /**
+     * Receives message client<-server
+     *
+     * @return string|null
+     * @throws \Exception
+     */
+    public function receive(): string|null
+    {
+        if (!$this->isConnected && $this->isClosing === false) {
+            throw new WebSocketException(
+                "Your unexpectedly disconnected from the server",
+                CommonsContract::CLIENT_CONNECTION_NOT_ESTABLISHED
+            );
+        }
+
+        $this->hugePayload = '';
+
+        return $this->receiveFragment();
+    }
+
+    /**
+     * Tell the socket to close.
+     *
+     * @param integer $status http://tools.ietf.org/html/rfc6455#section-7.4
+     * @param string $message A closing message, max 125 bytes.
+     * @return bool|null|string
+     * @throws \Exception
+     */
+    public function close(int $status = 1000, string $message = 'ttfn'): bool|null|string
+    {
+        $statusBin = sprintf('%016b', $status);
+        $statusStr = '';
+
+        foreach (str_split($statusBin, 8) as $binstr) {
+            $statusStr .= chr(bindec($binstr));
+        }
+
+        $this->send($statusStr . $message, CommonsContract::EVENT_TYPE_CLOSE);
+        $this->isClosing = true;
+
+        return $this->receive(); // Receiving a close frame will close the socket now.
+    }
 
 }
\ No newline at end of file