From 9dccfd0bf5e93a7245c80cc735d32081a3b86e06 Mon Sep 17 00:00:00 2001 From: mkm <727897186@qq.com> Date: Tue, 12 Sep 2023 15:20:31 +0800 Subject: [PATCH] =?UTF-8?q?=E8=AE=AF=E9=A3=9E=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- app/api/controller/XunFeiController.php | 89 +- composer.json | 3 +- composer.lock | 129 +- .../IFlytek/Xfyun/Core/Traits/SignTrait.php | 2 +- extend/IFlytek/Xfyun/Speech/ChatClient.php | 90 + .../Xfyun/Speech/Constants/ChatConstants.php | 30 + extend/IFlytek/Xfyun/Speech/TcClient.php | 2 +- vendor/composer/autoload_psr4.php | 3 + vendor/composer/autoload_static.php | 15 + vendor/composer/installed.json | 136 ++ vendor/composer/installed.php | 31 +- vendor/phrity/net-uri/composer.json | 30 + vendor/phrity/net-uri/src/Uri.php | 486 +++++ vendor/phrity/net-uri/src/UriFactory.php | 31 + .../.github/workflows/acceptance.yml | 128 ++ vendor/phrity/util-errorhandler/.gitignore | 6 + vendor/phrity/util-errorhandler/Makefile | 41 + vendor/phrity/util-errorhandler/README.md | 146 ++ vendor/phrity/util-errorhandler/composer.json | 33 + .../phrity/util-errorhandler/phpunit.xml.dist | 15 + .../src/Phrity/Util/ErrorHandler.php | 119 ++ .../tests/ErrorHandlerTest.php | 311 +++ vendor/services.php | 2 +- .../.github/ISSUE_TEMPLATE/bug_report.md | 21 + .../.github/ISSUE_TEMPLATE/feature_request.md | 14 + .../.github/ISSUE_TEMPLATE/other-issue.md | 10 + .../.github/workflows/acceptance.yml | 97 + vendor/textalk/websocket/.gitignore | 6 + vendor/textalk/websocket/COPYING.md | 16 + vendor/textalk/websocket/Makefile | 32 + vendor/textalk/websocket/README.md | 67 + vendor/textalk/websocket/composer.json | 36 + vendor/textalk/websocket/docs/Changelog.md | 167 ++ vendor/textalk/websocket/docs/Client.md | 137 ++ vendor/textalk/websocket/docs/Contributing.md | 51 + vendor/textalk/websocket/docs/Examples.md | 101 + vendor/textalk/websocket/docs/Message.md | 60 + vendor/textalk/websocket/docs/Server.md | 136 ++ .../textalk/websocket/examples/echoserver.php | 87 + .../websocket/examples/random_client.php | 94 + .../websocket/examples/random_server.php | 93 + vendor/textalk/websocket/examples/send.php | 51 + .../websocket/lib/BadOpcodeException.php | 14 + .../textalk/websocket/lib/BadUriException.php | 7 + vendor/textalk/websocket/lib/Client.php | 490 +++++ vendor/textalk/websocket/lib/Connection.php | 518 +++++ .../websocket/lib/ConnectionException.php | 33 + vendor/textalk/websocket/lib/Exception.php | 7 + .../textalk/websocket/lib/Message/Binary.php | 15 + .../textalk/websocket/lib/Message/Close.php | 15 + .../textalk/websocket/lib/Message/Factory.php | 32 + .../textalk/websocket/lib/Message/Message.php | 74 + vendor/textalk/websocket/lib/Message/Ping.php | 15 + vendor/textalk/websocket/lib/Message/Pong.php | 15 + vendor/textalk/websocket/lib/Message/Text.php | 15 + vendor/textalk/websocket/lib/OpcodeTrait.php | 22 + vendor/textalk/websocket/lib/Server.php | 470 +++++ .../websocket/lib/TimeoutException.php | 14 + vendor/textalk/websocket/phpunit.xml.dist | 13 + vendor/textalk/websocket/tests/ClientTest.php | 568 ++++++ .../textalk/websocket/tests/ExceptionTest.php | 51 + .../textalk/websocket/tests/MessageTest.php | 60 + vendor/textalk/websocket/tests/README.md | 28 + vendor/textalk/websocket/tests/ServerTest.php | 511 +++++ vendor/textalk/websocket/tests/bootstrap.php | 6 + .../textalk/websocket/tests/mock/EchoLog.php | 34 + .../websocket/tests/mock/MockSocket.php | 81 + .../websocket/tests/mock/mock-socket.php | 83 + .../websocket/tests/mock/payload.128.txt | 5 + .../websocket/tests/mock/payload.65536.txt | 1682 +++++++++++++++++ .../websocket/tests/scripts/client.close.json | 62 + .../tests/scripts/client.connect-authed.json | 58 + .../scripts/client.connect-bad-context.json | 7 + .../scripts/client.connect-bad-stream.json | 26 + .../tests/scripts/client.connect-context.json | 58 + .../client.connect-default-port-ws.json | 59 + .../client.connect-default-port-wss.json | 59 + .../tests/scripts/client.connect-error.json | 23 + .../scripts/client.connect-extended.json | 59 + .../tests/scripts/client.connect-failed.json | 19 + .../client.connect-handshake-error.json | 86 + .../client.connect-handshake-failure.json | 50 + .../tests/scripts/client.connect-headers.json | 67 + .../scripts/client.connect-invalid-key.json | 49 + .../client.connect-invalid-upgrade.json | 49 + .../client.connect-persistent-failure.json | 34 + .../scripts/client.connect-persistent.json | 80 + .../tests/scripts/client.connect-root.json | 59 + .../tests/scripts/client.connect-timeout.json | 58 + .../tests/scripts/client.connect.json | 60 + .../tests/scripts/client.destruct.json | 16 + .../tests/scripts/client.reconnect.json | 99 + .../websocket/tests/scripts/close-remote.json | 48 + .../tests/scripts/config-timeout.json | 24 + .../websocket/tests/scripts/ping-pong.json | 143 ++ .../tests/scripts/receive-bad-opcode.json | 18 + .../tests/scripts/receive-broken-read.json | 58 + .../tests/scripts/receive-client-timeout.json | 43 + .../tests/scripts/receive-empty-read.json | 58 + .../tests/scripts/receive-fragmentation.json | 126 ++ .../tests/scripts/send-bad-opcode.json | 9 + .../tests/scripts/send-broken-write.json | 43 + .../tests/scripts/send-convenicance.json | 86 + .../tests/scripts/send-failed-write.json | 43 + .../tests/scripts/send-receive-128.json | 50 + .../tests/scripts/send-receive-65536.json | 113 ++ .../scripts/send-receive-multi-fragment.json | 112 ++ .../websocket/tests/scripts/send-receive.json | 50 + .../tests/scripts/server.accept-destruct.json | 315 +++ .../scripts/server.accept-error-connect.json | 18 + .../scripts/server.accept-failed-connect.json | 14 + .../server.accept-failed-handshake.json | 32 + .../scripts/server.accept-failed-http.json | 265 +++ .../scripts/server.accept-failed-ws-key.json | 265 +++ .../tests/scripts/server.accept-timeout.json | 289 +++ .../tests/scripts/server.accept.json | 287 +++ .../websocket/tests/scripts/server.close.json | 56 + .../server.construct-error-socket-server.json | 28 + ...server.construct-failed-socket-server.json | 20 + .../tests/scripts/server.construct.json | 11 + .../tests/scripts/server.disconnect.json | 24 + 121 files changed, 11798 insertions(+), 19 deletions(-) create mode 100644 extend/IFlytek/Xfyun/Speech/ChatClient.php create mode 100644 extend/IFlytek/Xfyun/Speech/Constants/ChatConstants.php create mode 100644 vendor/phrity/net-uri/composer.json create mode 100644 vendor/phrity/net-uri/src/Uri.php create mode 100644 vendor/phrity/net-uri/src/UriFactory.php create mode 100644 vendor/phrity/util-errorhandler/.github/workflows/acceptance.yml create mode 100644 vendor/phrity/util-errorhandler/.gitignore create mode 100644 vendor/phrity/util-errorhandler/Makefile create mode 100644 vendor/phrity/util-errorhandler/README.md create mode 100644 vendor/phrity/util-errorhandler/composer.json create mode 100644 vendor/phrity/util-errorhandler/phpunit.xml.dist create mode 100644 vendor/phrity/util-errorhandler/src/Phrity/Util/ErrorHandler.php create mode 100644 vendor/phrity/util-errorhandler/tests/ErrorHandlerTest.php create mode 100644 vendor/textalk/websocket/.github/ISSUE_TEMPLATE/bug_report.md create mode 100644 vendor/textalk/websocket/.github/ISSUE_TEMPLATE/feature_request.md create mode 100644 vendor/textalk/websocket/.github/ISSUE_TEMPLATE/other-issue.md create mode 100644 vendor/textalk/websocket/.github/workflows/acceptance.yml create mode 100644 vendor/textalk/websocket/.gitignore create mode 100644 vendor/textalk/websocket/COPYING.md create mode 100644 vendor/textalk/websocket/Makefile create mode 100644 vendor/textalk/websocket/README.md create mode 100644 vendor/textalk/websocket/composer.json create mode 100644 vendor/textalk/websocket/docs/Changelog.md create mode 100644 vendor/textalk/websocket/docs/Client.md create mode 100644 vendor/textalk/websocket/docs/Contributing.md create mode 100644 vendor/textalk/websocket/docs/Examples.md create mode 100644 vendor/textalk/websocket/docs/Message.md create mode 100644 vendor/textalk/websocket/docs/Server.md create mode 100644 vendor/textalk/websocket/examples/echoserver.php create mode 100644 vendor/textalk/websocket/examples/random_client.php create mode 100644 vendor/textalk/websocket/examples/random_server.php create mode 100644 vendor/textalk/websocket/examples/send.php create mode 100644 vendor/textalk/websocket/lib/BadOpcodeException.php create mode 100644 vendor/textalk/websocket/lib/BadUriException.php create mode 100644 vendor/textalk/websocket/lib/Client.php create mode 100644 vendor/textalk/websocket/lib/Connection.php create mode 100644 vendor/textalk/websocket/lib/ConnectionException.php create mode 100644 vendor/textalk/websocket/lib/Exception.php create mode 100644 vendor/textalk/websocket/lib/Message/Binary.php create mode 100644 vendor/textalk/websocket/lib/Message/Close.php create mode 100644 vendor/textalk/websocket/lib/Message/Factory.php create mode 100644 vendor/textalk/websocket/lib/Message/Message.php create mode 100644 vendor/textalk/websocket/lib/Message/Ping.php create mode 100644 vendor/textalk/websocket/lib/Message/Pong.php create mode 100644 vendor/textalk/websocket/lib/Message/Text.php create mode 100644 vendor/textalk/websocket/lib/OpcodeTrait.php create mode 100644 vendor/textalk/websocket/lib/Server.php create mode 100644 vendor/textalk/websocket/lib/TimeoutException.php create mode 100644 vendor/textalk/websocket/phpunit.xml.dist create mode 100644 vendor/textalk/websocket/tests/ClientTest.php create mode 100644 vendor/textalk/websocket/tests/ExceptionTest.php create mode 100644 vendor/textalk/websocket/tests/MessageTest.php create mode 100644 vendor/textalk/websocket/tests/README.md create mode 100644 vendor/textalk/websocket/tests/ServerTest.php create mode 100644 vendor/textalk/websocket/tests/bootstrap.php create mode 100644 vendor/textalk/websocket/tests/mock/EchoLog.php create mode 100644 vendor/textalk/websocket/tests/mock/MockSocket.php create mode 100644 vendor/textalk/websocket/tests/mock/mock-socket.php create mode 100644 vendor/textalk/websocket/tests/mock/payload.128.txt create mode 100644 vendor/textalk/websocket/tests/mock/payload.65536.txt create mode 100644 vendor/textalk/websocket/tests/scripts/client.close.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.connect-authed.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.connect-bad-context.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.connect-bad-stream.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.connect-context.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.connect-default-port-ws.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.connect-default-port-wss.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.connect-error.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.connect-extended.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.connect-failed.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.connect-handshake-error.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.connect-handshake-failure.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.connect-headers.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.connect-invalid-key.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.connect-invalid-upgrade.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.connect-persistent-failure.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.connect-persistent.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.connect-root.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.connect-timeout.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.connect.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.destruct.json create mode 100644 vendor/textalk/websocket/tests/scripts/client.reconnect.json create mode 100644 vendor/textalk/websocket/tests/scripts/close-remote.json create mode 100644 vendor/textalk/websocket/tests/scripts/config-timeout.json create mode 100644 vendor/textalk/websocket/tests/scripts/ping-pong.json create mode 100644 vendor/textalk/websocket/tests/scripts/receive-bad-opcode.json create mode 100644 vendor/textalk/websocket/tests/scripts/receive-broken-read.json create mode 100644 vendor/textalk/websocket/tests/scripts/receive-client-timeout.json create mode 100644 vendor/textalk/websocket/tests/scripts/receive-empty-read.json create mode 100644 vendor/textalk/websocket/tests/scripts/receive-fragmentation.json create mode 100644 vendor/textalk/websocket/tests/scripts/send-bad-opcode.json create mode 100644 vendor/textalk/websocket/tests/scripts/send-broken-write.json create mode 100644 vendor/textalk/websocket/tests/scripts/send-convenicance.json create mode 100644 vendor/textalk/websocket/tests/scripts/send-failed-write.json create mode 100644 vendor/textalk/websocket/tests/scripts/send-receive-128.json create mode 100644 vendor/textalk/websocket/tests/scripts/send-receive-65536.json create mode 100644 vendor/textalk/websocket/tests/scripts/send-receive-multi-fragment.json create mode 100644 vendor/textalk/websocket/tests/scripts/send-receive.json create mode 100644 vendor/textalk/websocket/tests/scripts/server.accept-destruct.json create mode 100644 vendor/textalk/websocket/tests/scripts/server.accept-error-connect.json create mode 100644 vendor/textalk/websocket/tests/scripts/server.accept-failed-connect.json create mode 100644 vendor/textalk/websocket/tests/scripts/server.accept-failed-handshake.json create mode 100644 vendor/textalk/websocket/tests/scripts/server.accept-failed-http.json create mode 100644 vendor/textalk/websocket/tests/scripts/server.accept-failed-ws-key.json create mode 100644 vendor/textalk/websocket/tests/scripts/server.accept-timeout.json create mode 100644 vendor/textalk/websocket/tests/scripts/server.accept.json create mode 100644 vendor/textalk/websocket/tests/scripts/server.close.json create mode 100644 vendor/textalk/websocket/tests/scripts/server.construct-error-socket-server.json create mode 100644 vendor/textalk/websocket/tests/scripts/server.construct-failed-socket-server.json create mode 100644 vendor/textalk/websocket/tests/scripts/server.construct.json create mode 100644 vendor/textalk/websocket/tests/scripts/server.disconnect.json diff --git a/app/api/controller/XunFeiController.php b/app/api/controller/XunFeiController.php index 597dfa09e..729820cc9 100644 --- a/app/api/controller/XunFeiController.php +++ b/app/api/controller/XunFeiController.php @@ -14,7 +14,8 @@ namespace app\api\controller; -use IFlytek\Xfyun\Speech\TcClient; +use IFlytek\Xfyun\Speech\ChatClient; +use WebSocket\Client; /** * 讯飞 @@ -26,20 +27,84 @@ class XunFeiController extends BaseApiController private $app_id='2eda6c2e'; - private $api_key='MDEyMzE5YTc5YmQ5NjMwOTU1MWY4N2Y2'; + private $api_key='12ec1f9d113932575fc4b114a2f60ffd'; - private $api_secret='12ec1f9d113932575fc4b114a2f60ffd'; + private $api_secret='MDEyMzE5YTc5YmQ5NjMwOTU1MWY4N2Y2'; - public function ceshi() + public function chat() { - // 这里的$app_id、$api_key、$api_secret是在开放平台控制台获得 - $client = new TcClient($this->app_id, $this->api_key, $this->api_secret); + $chat=new ChatClient($this->app_id,$this->api_key,$this->api_secret); + $client = new Client($chat->assembleAuthUrl('wss://spark-api.xf-yun.com/v2.1/chat')); + // 连接到 WebSocket 服务器 + if ($client) { + // 发送数据到 WebSocket 服务器 + $data = $this->getBody($this->app_id,"你是谁？"); - // 文本纠错请求，返回格式为json字符串 - $content = $client->request('历史上有很多注明的人物，其中唐太宗李世民就是一位。')->getBody()->getContents(); -halt($content); - // 黑白名单上传请求，成功返回true，失败返回false（失败请检查uid、res_id是否设置） - // $client = new TcClient($this->app_id, $this->api_key, $api_secret, $uid, $res_id); - // $client->listUpload($white_list, $black_list); + $client->send($data); + // 从 WebSocket 服务器接收数据 + $answer = ""; + while(true){ + $response = $client->receive(); + $resp = json_decode($response,true); + $code = $resp["header"]["code"]; + echo "从服务器接收到的数据： " . $response; + if(0 == $code){ + $status = $resp["header"]["status"]; + if($status != 2){ + $content = $resp['payload']['choices']['text'][0]['content']; + $answer .= $content; + }else{ + $content = $resp['payload']['choices']['text'][0]['content']; + $answer .= $content; + $total_tokens = $resp['payload']['usage']['text']['total_tokens']; + print("\n本次消耗token用量：\n"); + print($total_tokens); + break; + } + }else{ + echo "服务返回报错".$response; + break; + } + } + + print("\n返回结果为：\n"); + print($answer); + } else { + echo "无法连接到 WebSocket 服务器"; + } } + + //构造参数体 + function getBody($appid,$question){ + $header = array( + "app_id" => $appid, + "uid" => "1" + ); + + $parameter = array( + "chat" => array( + "domain" => "generalv2", + "temperature" => 0.5, + "max_tokens" => 1024 + ) + ); + + $payload = array( + "message" => array( + "text" => array( + array("role" => "user", "content" => $question) + ) + ) + ); + + $json_string = json_encode(array( + "header" => $header, + "parameter" => $parameter, + "payload" => $payload + )); + + return $json_string; + + } + } diff --git a/composer.json b/composer.json index ed1534b12..74b2c1b24 100755 --- a/composer.json +++ b/composer.json @@ -37,7 +37,8 @@ "yunwuxin/think-cron": "^3.0", "topthink/think-queue": "^3.0", "firebase/php-jwt": "^6.8", - "guzzlehttp/guzzle": "^7.8" + "guzzlehttp/guzzle": "^7.8", + "textalk/websocket": "^1.6" }, "require-dev": { "symfony/var-dumper": "^4.2", diff --git a/composer.lock b/composer.lock index 9b32a9bab..715d6a41a 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "24f0a1ed76959703117054b6cb06afd8", + "content-hash": "a4417a460f7b9e7f5f161c5064f27b02", "packages": [ { "name": "adbario/php-dot-notation", @@ -1934,6 +1934,92 @@ }, "time": "2023-02-25T12:24:49+00:00" }, + { + "name": "phrity/net-uri", + "version": "1.3.0", + "dist": { + "type": "zip", + "url": "https://mirrors.cloud.tencent.com/repository/composer/phrity/net-uri/1.3.0/phrity-net-uri-1.3.0.zip", + "reference": "3f458e0c4d1ddc0e218d7a5b9420127c63925f43", + "shasum": "" + }, + "require": { + "php": "^7.4 | ^8.0", + "psr/http-factory": "^1.0", + "psr/http-message": "^1.0 | ^2.0" + }, + "require-dev": { + "php-coveralls/php-coveralls": "^2.0", + "phpunit/phpunit": "^9.0 | ^10.0", + "squizlabs/php_codesniffer": "^3.0" + }, + "type": "library", + "autoload": { + "psr-4": { + "Phrity\\Net\\": "src/" + } + }, + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Sören Jensen", + "email": "sirn@sirn.se", + "homepage": "https://phrity.sirn.se" + } + ], + "description": "PSR-7 Uri and PSR-17 UriFactory implementation", + "homepage": "https://phrity.sirn.se/net-uri", + "keywords": [ + "psr-17", + "psr-7", + "uri", + "uri factory" + ], + "time": "2023-08-21T10:33:06+00:00" + }, + { + "name": "phrity/util-errorhandler", + "version": "1.0.1", + "dist": { + "type": "zip", + "url": "https://mirrors.cloud.tencent.com/repository/composer/phrity/util-errorhandler/1.0.1/phrity-util-errorhandler-1.0.1.zip", + "reference": "dc9ac8fb70d733c48a9d9d1eb50f7022172da6bc", + "shasum": "" + }, + "require": { + "php": "^7.2|^8.0" + }, + "require-dev": { + "php-coveralls/php-coveralls": "^2.0", + "phpunit/phpunit": "^8.0|^9.0", + "squizlabs/php_codesniffer": "^3.5" + }, + "type": "library", + "autoload": { + "psr-4": { + "": "src/" + } + }, + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Sören Jensen", + "email": "sirn@sirn.se", + "homepage": "https://phrity.sirn.se" + } + ], + "description": "Inline error handler; catch and resolve errors for code block.", + "homepage": "https://phrity.sirn.se/util-errorhandler", + "keywords": [ + "error", + "warning" + ], + "time": "2022-10-27T12:14:42+00:00" + }, { "name": "psr/cache", "version": "2.0.0", @@ -4394,6 +4480,47 @@ }, "time": "2023-08-09T00:06:15+00:00" }, + { + "name": "textalk/websocket", + "version": "1.6.3", + "dist": { + "type": "zip", + "url": "https://mirrors.cloud.tencent.com/repository/composer/textalk/websocket/1.6.3/textalk-websocket-1.6.3.zip", + "reference": "67de79745b1a357caf812bfc44e0abf481cee012", + "shasum": "" + }, + "require": { + "php": "^7.4 | ^8.0", + "phrity/net-uri": "^1.0", + "phrity/util-errorhandler": "^1.0", + "psr/http-message": "^1.0", + "psr/log": "^1.0 | ^2.0 | ^3.0" + }, + "require-dev": { + "php-coveralls/php-coveralls": "^2.0", + "phpunit/phpunit": "^9.0", + "squizlabs/php_codesniffer": "^3.5" + }, + "type": "library", + "autoload": { + "psr-4": { + "WebSocket\\": "lib" + } + }, + "license": [ + "ISC" + ], + "authors": [ + { + "name": "Fredrik Liljegren" + }, + { + "name": "Sören Jensen" + } + ], + "description": "WebSocket client and server", + "time": "2022-11-07T18:59:33+00:00" + }, { "name": "thenorthmemory/xml", "version": "1.1.1", diff --git a/extend/IFlytek/Xfyun/Core/Traits/SignTrait.php b/extend/IFlytek/Xfyun/Core/Traits/SignTrait.php index a14aecc0b..7f7b37db8 100644 --- a/extend/IFlytek/Xfyun/Core/Traits/SignTrait.php +++ b/extend/IFlytek/Xfyun/Core/Traits/SignTrait.php @@ -39,7 +39,7 @@ trait SignTrait $apiSecret = $secret['apiSecret']; $host = $secret['host']; $request_line = $secret['requestLine']; - $date = empty($secret['date']) ? date ('D, d M Y H:i:s \G\M\T', time()) : $secret['date']; + $date = empty($secret['date']) ? gmdate ('D, d M Y H:i:s \G\M\T', time()) : $secret['date']; $signature_origin = "host: $host\ndate: $date\n$request_line"; $signature_sha = hash_hmac('sha256', $signature_origin, $apiSecret, true); $signature = base64_encode($signature_sha); diff --git a/extend/IFlytek/Xfyun/Speech/ChatClient.php b/extend/IFlytek/Xfyun/Speech/ChatClient.php new file mode 100644 index 000000000..acb6632c9 --- /dev/null +++ b/extend/IFlytek/Xfyun/Speech/ChatClient.php @@ -0,0 +1,90 @@ +appId = $appId; + $this->apiKey = $apiKey; + $this->apiSecret = $apiSecret; + $this->uid = $uid; + $this->resId = $resId; + $this->client = new HttpClient([]); + } + + function assembleAuthUrl($addr,$method='GET') { + $apiKey=$this->apiKey; + $apiSecret=$this->apiSecret; + if ($apiKey == "" && $apiSecret == "") { // 不鉴权 + return $addr; + } + + $ul = parse_url($addr); // 解析地址 + if ($ul === false) { // 地址不对，也不鉴权 + return $addr; + } + // // $date = date(DATE_RFC1123); // 获取当前时间并格式化为RFC1123格式的字符串 + $timestamp = time(); + $rfc1123_format = gmdate("D, d M Y H:i:s \G\M\T", $timestamp); + // $rfc1123_format = "Mon, 31 Jul 2023 08:24:03 GMT"; + + // 参与签名的字段 host, date, request-line + $signString = array("host: " . $ul["host"], "date: " . $rfc1123_format, $method . " " . $ul["path"] . " HTTP/1.1"); + // 对签名字符串进行排序，确保顺序一致 + // ksort($signString); + // 将签名字符串拼接成一个字符串 + $sgin = implode("\n", $signString); + + // 对签名字符串进行HMAC-SHA256加密，得到签名结果 + $sha = hash_hmac('sha256', $sgin, $apiSecret,true); + + $signature_sha_base64 = base64_encode($sha); + + // 将API密钥、算法、头部信息和签名结果拼接成一个授权URL + $authUrl = "api_key=\"$apiKey\",algorithm=\"hmac-sha256\",headers=\"host date request-line\",signature=\"$signature_sha_base64\""; + // 对授权URL进行Base64编码，并添加到原始地址后面作为查询参数 + $authAddr = $addr . '?' . http_build_query(array( + 'host' => $ul['host'], + 'date' => $rfc1123_format, + 'authorization' => base64_encode($authUrl), + )); + return $authAddr; + } +} diff --git a/extend/IFlytek/Xfyun/Speech/Constants/ChatConstants.php b/extend/IFlytek/Xfyun/Speech/Constants/ChatConstants.php new file mode 100644 index 000000000..fa9709912 --- /dev/null +++ b/extend/IFlytek/Xfyun/Speech/Constants/ChatConstants.php @@ -0,0 +1,30 @@ + $this->apiKey, 'apiSecret' => $this->apiSecret, - 'host' => 'ceshi-worker-task.lihaink.cn', + 'host' => TcConstants::HOST, 'requestLine' => TcConstants::REQUEST_LINE ]); $body = self::generateInput($text, $this->appId, $this->uid, $this->resId, $this->requestConfig->toArray()); diff --git a/vendor/composer/autoload_psr4.php b/vendor/composer/autoload_psr4.php index 3ddb09ab3..a0471bfec 100644 --- a/vendor/composer/autoload_psr4.php +++ b/vendor/composer/autoload_psr4.php @@ -16,6 +16,7 @@ return array( 'ZipStream\\' => array($vendorDir . '/maennchen/zipstream-php/src'), 'WpOrg\\Requests\\' => array($vendorDir . '/rmccue/requests/src'), 'Webmozart\\Assert\\' => array($vendorDir . '/webmozart/assert/src'), + 'WebSocket\\' => array($vendorDir . '/textalk/websocket/lib'), 'TheNorthMemory\\Xml\\' => array($vendorDir . '/thenorthmemory/xml/src'), 'TencentCloud\\' => array($vendorDir . '/tencentcloud/tencentcloud-sdk-php/src/TencentCloud'), 'Symfony\\Polyfill\\Php81\\' => array($vendorDir . '/symfony/polyfill-php81'), @@ -46,6 +47,7 @@ return array( 'Psr\\Http\\Client\\' => array($vendorDir . '/psr/http-client/src'), 'Psr\\Container\\' => array($vendorDir . '/psr/container/src'), 'Psr\\Cache\\' => array($vendorDir . '/psr/cache/src'), + 'Phrity\\Net\\' => array($vendorDir . '/phrity/net-uri/src'), 'PhpOffice\\PhpSpreadsheet\\' => array($vendorDir . '/phpoffice/phpspreadsheet/src/PhpSpreadsheet'), 'Overtrue\\Socialite\\' => array($vendorDir . '/overtrue/socialite/src'), 'OSS\\' => array($vendorDir . '/aliyuncs/oss-sdk-php/src/OSS'), @@ -68,4 +70,5 @@ return array( 'Carbon\\' => array($vendorDir . '/nesbot/carbon/src/Carbon'), 'AlibabaCloud\\Client\\' => array($vendorDir . '/alibabacloud/client/src'), 'Adbar\\' => array($vendorDir . '/adbario/php-dot-notation/src'), + '' => array($vendorDir . '/phrity/util-errorhandler/src'), ); diff --git a/vendor/composer/autoload_static.php b/vendor/composer/autoload_static.php index db2fbe74c..79af2b50b 100644 --- a/vendor/composer/autoload_static.php +++ b/vendor/composer/autoload_static.php @@ -62,6 +62,7 @@ class ComposerStaticInit7f3b0f886ea5f6310a43341d4e2b8ffb array ( 'WpOrg\\Requests\\' => 15, 'Webmozart\\Assert\\' => 17, + 'WebSocket\\' => 10, ), 'T' => array ( @@ -104,6 +105,7 @@ class ComposerStaticInit7f3b0f886ea5f6310a43341d4e2b8ffb 'Psr\\Http\\Client\\' => 16, 'Psr\\Container\\' => 14, 'Psr\\Cache\\' => 10, + 'Phrity\\Net\\' => 11, 'PhpOffice\\PhpSpreadsheet\\' => 25, ), 'O' => @@ -201,6 +203,10 @@ class ComposerStaticInit7f3b0f886ea5f6310a43341d4e2b8ffb array ( 0 => __DIR__ . '/..' . '/webmozart/assert/src', ), + 'WebSocket\\' => + array ( + 0 => __DIR__ . '/..' . '/textalk/websocket/lib', + ), 'TheNorthMemory\\Xml\\' => array ( 0 => __DIR__ . '/..' . '/thenorthmemory/xml/src', @@ -322,6 +328,10 @@ class ComposerStaticInit7f3b0f886ea5f6310a43341d4e2b8ffb array ( 0 => __DIR__ . '/..' . '/psr/cache/src', ), + 'Phrity\\Net\\' => + array ( + 0 => __DIR__ . '/..' . '/phrity/net-uri/src', + ), 'PhpOffice\\PhpSpreadsheet\\' => array ( 0 => __DIR__ . '/..' . '/phpoffice/phpspreadsheet/src/PhpSpreadsheet', @@ -412,6 +422,10 @@ class ComposerStaticInit7f3b0f886ea5f6310a43341d4e2b8ffb ), ); + public static $fallbackDirsPsr4 = array ( + 0 => __DIR__ . '/..' . '/phrity/util-errorhandler/src', + ); + public static $prefixesPsr0 = array ( 'H' => array ( @@ -445,6 +459,7 @@ class ComposerStaticInit7f3b0f886ea5f6310a43341d4e2b8ffb return \Closure::bind(function () use ($loader) { $loader->prefixLengthsPsr4 = ComposerStaticInit7f3b0f886ea5f6310a43341d4e2b8ffb::$prefixLengthsPsr4; $loader->prefixDirsPsr4 = ComposerStaticInit7f3b0f886ea5f6310a43341d4e2b8ffb::$prefixDirsPsr4; + $loader->fallbackDirsPsr4 = ComposerStaticInit7f3b0f886ea5f6310a43341d4e2b8ffb::$fallbackDirsPsr4; $loader->prefixesPsr0 = ComposerStaticInit7f3b0f886ea5f6310a43341d4e2b8ffb::$prefixesPsr0; $loader->fallbackDirsPsr0 = ComposerStaticInit7f3b0f886ea5f6310a43341d4e2b8ffb::$fallbackDirsPsr0; $loader->classMap = ComposerStaticInit7f3b0f886ea5f6310a43341d4e2b8ffb::$classMap; diff --git a/vendor/composer/installed.json b/vendor/composer/installed.json index 733c20fd4..8f52e46fc 100644 --- a/vendor/composer/installed.json +++ b/vendor/composer/installed.json @@ -2000,6 +2000,98 @@ }, "install-path": "../phpoffice/phpspreadsheet" }, + { + "name": "phrity/net-uri", + "version": "1.3.0", + "version_normalized": "1.3.0.0", + "dist": { + "type": "zip", + "url": "https://mirrors.cloud.tencent.com/repository/composer/phrity/net-uri/1.3.0/phrity-net-uri-1.3.0.zip", + "reference": "3f458e0c4d1ddc0e218d7a5b9420127c63925f43", + "shasum": "" + }, + "require": { + "php": "^7.4 | ^8.0", + "psr/http-factory": "^1.0", + "psr/http-message": "^1.0 | ^2.0" + }, + "require-dev": { + "php-coveralls/php-coveralls": "^2.0", + "phpunit/phpunit": "^9.0 | ^10.0", + "squizlabs/php_codesniffer": "^3.0" + }, + "time": "2023-08-21T10:33:06+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "Phrity\\Net\\": "src/" + } + }, + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Sören Jensen", + "email": "sirn@sirn.se", + "homepage": "https://phrity.sirn.se" + } + ], + "description": "PSR-7 Uri and PSR-17 UriFactory implementation", + "homepage": "https://phrity.sirn.se/net-uri", + "keywords": [ + "psr-17", + "psr-7", + "uri", + "uri factory" + ], + "install-path": "../phrity/net-uri" + }, + { + "name": "phrity/util-errorhandler", + "version": "1.0.1", + "version_normalized": "1.0.1.0", + "dist": { + "type": "zip", + "url": "https://mirrors.cloud.tencent.com/repository/composer/phrity/util-errorhandler/1.0.1/phrity-util-errorhandler-1.0.1.zip", + "reference": "dc9ac8fb70d733c48a9d9d1eb50f7022172da6bc", + "shasum": "" + }, + "require": { + "php": "^7.2|^8.0" + }, + "require-dev": { + "php-coveralls/php-coveralls": "^2.0", + "phpunit/phpunit": "^8.0|^9.0", + "squizlabs/php_codesniffer": "^3.5" + }, + "time": "2022-10-27T12:14:42+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "": "src/" + } + }, + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Sören Jensen", + "email": "sirn@sirn.se", + "homepage": "https://phrity.sirn.se" + } + ], + "description": "Inline error handler; catch and resolve errors for code block.", + "homepage": "https://phrity.sirn.se/util-errorhandler", + "keywords": [ + "error", + "warning" + ], + "install-path": "../phrity/util-errorhandler" + }, { "name": "psr/cache", "version": "2.0.0", @@ -4654,6 +4746,50 @@ }, "install-path": "../tencentcloud/tencentcloud-sdk-php" }, + { + "name": "textalk/websocket", + "version": "1.6.3", + "version_normalized": "1.6.3.0", + "dist": { + "type": "zip", + "url": "https://mirrors.cloud.tencent.com/repository/composer/textalk/websocket/1.6.3/textalk-websocket-1.6.3.zip", + "reference": "67de79745b1a357caf812bfc44e0abf481cee012", + "shasum": "" + }, + "require": { + "php": "^7.4 | ^8.0", + "phrity/net-uri": "^1.0", + "phrity/util-errorhandler": "^1.0", + "psr/http-message": "^1.0", + "psr/log": "^1.0 | ^2.0 | ^3.0" + }, + "require-dev": { + "php-coveralls/php-coveralls": "^2.0", + "phpunit/phpunit": "^9.0", + "squizlabs/php_codesniffer": "^3.5" + }, + "time": "2022-11-07T18:59:33+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "WebSocket\\": "lib" + } + }, + "license": [ + "ISC" + ], + "authors": [ + { + "name": "Fredrik Liljegren" + }, + { + "name": "Sören Jensen" + } + ], + "description": "WebSocket client and server", + "install-path": "../textalk/websocket" + }, { "name": "thenorthmemory/xml", "version": "1.1.1", diff --git a/vendor/composer/installed.php b/vendor/composer/installed.php index 25254649f..109576517 100644 --- a/vendor/composer/installed.php +++ b/vendor/composer/installed.php @@ -3,7 +3,7 @@ 'name' => 'topthink/think', 'pretty_version' => 'dev-master', 'version' => 'dev-master', - 'reference' => 'c4b518e85efaed9caf7ac607e18217dfeb717f8b', + 'reference' => 'f2bce7816ff04f0c51eae55aa98246f5cd8fa888', 'type' => 'project', 'install_path' => __DIR__ . '/../../', 'aliases' => array(), @@ -250,6 +250,24 @@ 'aliases' => array(), 'dev_requirement' => false, ), + 'phrity/net-uri' => array( + 'pretty_version' => '1.3.0', + 'version' => '1.3.0.0', + 'reference' => '3f458e0c4d1ddc0e218d7a5b9420127c63925f43', + 'type' => 'library', + 'install_path' => __DIR__ . '/../phrity/net-uri', + 'aliases' => array(), + 'dev_requirement' => false, + ), + 'phrity/util-errorhandler' => array( + 'pretty_version' => '1.0.1', + 'version' => '1.0.1.0', + 'reference' => 'dc9ac8fb70d733c48a9d9d1eb50f7022172da6bc', + 'type' => 'library', + 'install_path' => __DIR__ . '/../phrity/util-errorhandler', + 'aliases' => array(), + 'dev_requirement' => false, + ), 'psr/cache' => array( 'pretty_version' => '2.0.0', 'version' => '2.0.0.0', @@ -601,6 +619,15 @@ 'aliases' => array(), 'dev_requirement' => false, ), + 'textalk/websocket' => array( + 'pretty_version' => '1.6.3', + 'version' => '1.6.3.0', + 'reference' => '67de79745b1a357caf812bfc44e0abf481cee012', + 'type' => 'library', + 'install_path' => __DIR__ . '/../textalk/websocket', + 'aliases' => array(), + 'dev_requirement' => false, + ), 'thenorthmemory/xml' => array( 'pretty_version' => '1.1.1', 'version' => '1.1.1.0', @@ -622,7 +649,7 @@ 'topthink/think' => array( 'pretty_version' => 'dev-master', 'version' => 'dev-master', - 'reference' => 'c4b518e85efaed9caf7ac607e18217dfeb717f8b', + 'reference' => 'f2bce7816ff04f0c51eae55aa98246f5cd8fa888', 'type' => 'project', 'install_path' => __DIR__ . '/../../', 'aliases' => array(), diff --git a/vendor/phrity/net-uri/composer.json b/vendor/phrity/net-uri/composer.json new file mode 100644 index 000000000..8f87a3a7f --- /dev/null +++ b/vendor/phrity/net-uri/composer.json @@ -0,0 +1,30 @@ +{ + "name": "phrity/net-uri", + "type": "library", + "description": "PSR-7 Uri and PSR-17 UriFactory implementation", + "homepage": "https://phrity.sirn.se/net-uri", + "keywords": ["uri", "uri factory", "PSR-7", "PSR-17"], + "license": "MIT", + "authors": [ + { + "name": "Sören Jensen", + "email": "sirn@sirn.se", + "homepage": "https://phrity.sirn.se" + } + ], + "autoload": { + "psr-4": { + "Phrity\\Net\\": "src/" + } + }, + "require": { + "php": "^7.4 | ^8.0", + "psr/http-factory": "^1.0", + "psr/http-message": "^1.0 | ^2.0" + }, + "require-dev": { + "phpunit/phpunit": "^9.0 | ^10.0", + "php-coveralls/php-coveralls": "^2.0", + "squizlabs/php_codesniffer": "^3.0" + } +} diff --git a/vendor/phrity/net-uri/src/Uri.php b/vendor/phrity/net-uri/src/Uri.php new file mode 100644 index 000000000..4e0ba65aa --- /dev/null +++ b/vendor/phrity/net-uri/src/Uri.php @@ -0,0 +1,486 @@ + Net > Uri + * @see https://www.rfc-editor.org/rfc/rfc3986 + * @see https://www.php-fig.org/psr/psr-7/#35-psrhttpmessageuriinterface + */ + +namespace Phrity\Net; + +use InvalidArgumentException; +use Psr\Http\Message\UriInterface; + +/** + * Net\Uri class. + */ +class Uri implements UriInterface +{ + public const REQUIRE_PORT = 1; // Always include port, explicit or default + public const ABSOLUTE_PATH = 2; // Enforce absolute path + public const NORMALIZE_PATH = 4; // Normalize path + public const IDNA = 8; // IDNA-convert host + + private const RE_MAIN = '!^(?P(?P[^:/?#]+):)?(?P//(?P[^/?#]*))?' + . '(?P[^?#]*)(?P\?(?P[^#]*))?(?P#(?P.*))?$!'; + private const RE_AUTH = '!^(?P(?P[^:/?#]+)(?P:(?P[^:/?#]+))?@)?' + . '(?P[^:/?#]*|\[[^/?#]*\])(?P:(?P[0-9]*))?$!'; + + private static $port_defaults = [ + 'acap' => 674, + 'afp' => 548, + 'dict' => 2628, + 'dns' => 53, + 'ftp' => 21, + 'git' => 9418, + 'gopher' => 70, + 'http' => 80, + 'https' => 443, + 'imap' => 143, + 'ipp' => 631, + 'ipps' => 631, + 'irc' => 194, + 'ircs' => 6697, + 'ldap' => 389, + 'ldaps' => 636, + 'mms' => 1755, + 'msrp' => 2855, + 'mtqp' => 1038, + 'nfs' => 111, + 'nntp' => 119, + 'nntps' => 563, + 'pop' => 110, + 'prospero' => 1525, + 'redis' => 6379, + 'rsync' => 873, + 'rtsp' => 554, + 'rtsps' => 322, + 'rtspu' => 5005, + 'sftp' => 22, + 'smb' => 445, + 'snmp' => 161, + 'ssh' => 22, + 'svn' => 3690, + 'telnet' => 23, + 'ventrilo' => 3784, + 'vnc' => 5900, + 'wais' => 210, + 'ws' => 80, + 'wss' => 443, + ]; + + private $scheme; + private $authority; + private $host; + private $port; + private $user; + private $pass; + private $path; + private $query; + private $fragment; + + /** + * Create new URI instance using a string + * @param string $uri_string URI as string + * @throws \InvalidArgumentException If the given URI cannot be parsed + */ + public function __construct(string $uri_string = '', int $flags = 0) + { + $this->parse($uri_string); + } + + + // ---------- PSR-7 getters --------------------------------------------------------------------------------------- + + /** + * Retrieve the scheme component of the URI. + * @return string The URI scheme + */ + public function getScheme(int $flags = 0): string + { + return $this->getComponent('scheme') ?? ''; + } + + /** + * Retrieve the authority component of the URI. + * @return string The URI authority, in "[user-info@]host[:port]" format + */ + public function getAuthority(int $flags = 0): string + { + $host = $this->formatComponent($this->getHost($flags)); + if ($this->isEmpty($host)) { + return ''; + } + $userinfo = $this->formatComponent($this->getUserInfo(), '', '@'); + $port = $this->formatComponent($this->getPort($flags), ':'); + return "{$userinfo}{$host}{$port}"; + } + + /** + * Retrieve the user information component of the URI. + * @return string The URI user information, in "username[:password]" format + */ + public function getUserInfo(int $flags = 0): string + { + $user = $this->formatComponent($this->getComponent('user')); + $pass = $this->formatComponent($this->getComponent('pass'), ':'); + return $this->isEmpty($user) ? '' : "{$user}{$pass}"; + } + + /** + * Retrieve the host component of the URI. + * @return string The URI host + */ + public function getHost(int $flags = 0): string + { + $host = $this->getComponent('host') ?? ''; + if ($flags & self::IDNA) { + $host = $this->idna($host); + } + return $host; + } + + /** + * Retrieve the port component of the URI. + * @return null|int The URI port + */ + public function getPort(int $flags = 0): ?int + { + $port = $this->getComponent('port'); + $scheme = $this->getComponent('scheme'); + $default = isset(self::$port_defaults[$scheme]) ? self::$port_defaults[$scheme] : null; + if ($flags & self::REQUIRE_PORT) { + return !$this->isEmpty($port) ? $port : $default; + } + return $this->isEmpty($port) || $port === $default ? null : $port; + } + + /** + * Retrieve the path component of the URI. + * @return string The URI path + */ + public function getPath(int $flags = 0): string + { + $path = $this->getComponent('path') ?? ''; + if ($flags & self::NORMALIZE_PATH) { + $path = $this->normalizePath($path); + } + if ($flags & self::ABSOLUTE_PATH && substr($path, 0, 1) !== '/') { + $path = "/{$path}"; + } + return $path; + } + + /** + * Retrieve the query string of the URI. + * @return string The URI query string + */ + public function getQuery(int $flags = 0): string + { + return $this->getComponent('query') ?? ''; + } + + /** + * Retrieve the fragment component of the URI. + * @return string The URI fragment + */ + public function getFragment(int $flags = 0): string + { + return $this->getComponent('fragment') ?? ''; + } + + + // ---------- PSR-7 setters --------------------------------------------------------------------------------------- + + /** + * Return an instance with the specified scheme. + * @param string $scheme The scheme to use with the new instance + * @return static A new instance with the specified scheme + * @throws \InvalidArgumentException for invalid schemes + * @throws \InvalidArgumentException for unsupported schemes + */ + public function withScheme($scheme, int $flags = 0): UriInterface + { + $clone = clone $this; + if ($flags & self::REQUIRE_PORT) { + $clone->setComponent('port', $this->getPort(self::REQUIRE_PORT)); + $default = isset(self::$port_defaults[$scheme]) ? self::$port_defaults[$scheme] : null; + } + $clone->setComponent('scheme', $scheme); + return $clone; + } + + /** + * Return an instance with the specified user information. + * @param string $user The user name to use for authority + * @param null|string $password The password associated with $user + * @return static A new instance with the specified user information + */ + public function withUserInfo($user, $password = null, int $flags = 0): UriInterface + { + $clone = clone $this; + $clone->setComponent('user', $user); + $clone->setComponent('pass', $password); + return $clone; + } + + /** + * Return an instance with the specified host. + * @param string $host The hostname to use with the new instance + * @return static A new instance with the specified host + * @throws \InvalidArgumentException for invalid hostnames + */ + public function withHost($host, int $flags = 0): UriInterface + { + $clone = clone $this; + if ($flags & self::IDNA) { + $host = $this->idna($host); + } + $clone->setComponent('host', $host); + return $clone; + } + + /** + * Return an instance with the specified port. + * @param null|int $port The port to use with the new instance + * @return static A new instance with the specified port + * @throws \InvalidArgumentException for invalid ports + */ + public function withPort($port, int $flags = 0): UriInterface + { + $clone = clone $this; + $clone->setComponent('port', $port); + return $clone; + } + + /** + * Return an instance with the specified path. + * @param string $path The path to use with the new instance + * @return static A new instance with the specified path + * @throws \InvalidArgumentException for invalid paths + */ + public function withPath($path, int $flags = 0): UriInterface + { + $clone = clone $this; + if ($flags & self::NORMALIZE_PATH) { + $path = $this->normalizePath($path); + } + if ($flags & self::ABSOLUTE_PATH && substr($path, 0, 1) !== '/') { + $path = "/{$path}"; + } + $clone->setComponent('path', $path); + return $clone; + } + + /** + * Return an instance with the specified query string. + * @param string $query The query string to use with the new instance + * @return static A new instance with the specified query string + * @throws \InvalidArgumentException for invalid query strings + */ + public function withQuery($query, int $flags = 0): UriInterface + { + $clone = clone $this; + $clone->setComponent('query', $query); + return $clone; + } + + /** + * Return an instance with the specified URI fragment. + * @param string $fragment The fragment to use with the new instance + * @return static A new instance with the specified fragment + */ + public function withFragment($fragment, int $flags = 0): UriInterface + { + $clone = clone $this; + $clone->setComponent('fragment', $fragment); + return $clone; + } + + + // ---------- PSR-7 string ---------------------------------------------------------------------------------------- + + /** + * Return the string representation as a URI reference. + * @return string + */ + public function __toString(): string + { + return $this->toString(); + } + + + // ---------- Extensions ------------------------------------------------------------------------------------------ + + /** + * Return the string representation as a URI reference. + * @return string + */ + public function toString(int $flags = 0): string + { + $scheme = $this->formatComponent($this->getComponent('scheme'), '', ':'); + $authority = $this->authority ? "//{$this->formatComponent($this->getAuthority($flags))}" : ''; + $path_flags = ($this->authority && $this->path ? self::ABSOLUTE_PATH : 0) | $flags; + $path = $this->formatComponent($this->getPath($path_flags)); + $query = $this->formatComponent($this->getComponent('query'), '?'); + $fragment = $this->formatComponent($this->getComponent('fragment'), '#'); + return "{$scheme}{$authority}{$path}{$query}{$fragment}"; + } + + + // ---------- Private helper methods ------------------------------------------------------------------------------ + + private function parse(string $uri_string = ''): void + { + if ($uri_string === '') { + return; + } + preg_match(self::RE_MAIN, $uri_string, $main); + $this->authority = !empty($main['authorityc']); + $this->setComponent('scheme', isset($main['schemec']) ? $main['scheme'] : ''); + $this->setComponent('path', isset($main['path']) ? $main['path'] : ''); + $this->setComponent('query', isset($main['queryc']) ? $main['query'] : ''); + $this->setComponent('fragment', isset($main['fragmentc']) ? $main['fragment'] : ''); + if ($this->authority) { + preg_match(self::RE_AUTH, $main['authority'], $auth); + if (empty($auth) && $main['authority'] !== '') { + throw new InvalidArgumentException("Invalid 'authority'."); + } + if ($this->isEmpty($auth['host']) && !$this->isEmpty($auth['user'])) { + throw new InvalidArgumentException("Invalid 'authority'."); + } + $this->setComponent('user', isset($auth['user']) ? $auth['user'] : ''); + $this->setComponent('pass', isset($auth['passc']) ? $auth['pass'] : ''); + $this->setComponent('host', isset($auth['host']) ? $auth['host'] : ''); + $this->setComponent('port', isset($auth['portc']) ? $auth['port'] : ''); + } + } + + private function encode(string $source, string $keep = ''): string + { + $exclude = "[^%\/:=&!\$'()*+,;@{$keep}]+"; + $exp = "/(%{$exclude})|({$exclude})/"; + return preg_replace_callback($exp, function ($matches) { + if ($e = preg_match('/^(%[0-9a-fA-F]{2})/', $matches[0], $m)) { + return substr($matches[0], 0, 3) . rawurlencode(substr($matches[0], 3)); + } else { + return rawurlencode($matches[0]); + } + }, $source); + } + + private function setComponent(string $component, $value): void + { + $value = $this->parseCompontent($component, $value); + $this->$component = $value; + } + + private function parseCompontent(string $component, $value) + { + if ($this->isEmpty($value)) { + return null; + } + switch ($component) { + case 'scheme': + $this->assertString($component, $value); + $this->assertpattern($component, $value, '/^[a-z][a-z0-9-+.]*$/i'); + return mb_strtolower($value); + case 'host': // IP-literal / IPv4address / reg-name + $this->assertString($component, $value); + $this->authority = $this->authority || !$this->isEmpty($value); + return mb_strtolower($value); + case 'port': + $this->assertInteger($component, $value); + if ($value < 0 || $value > 65535) { + throw new InvalidArgumentException("Invalid port number"); + } + return (int)$value; + case 'path': + $this->assertString($component, $value); + $value = $this->encode($value); + return $value; + case 'user': + case 'pass': + case 'query': + case 'fragment': + $this->assertString($component, $value); + $value = $this->encode($value, '?'); + return $value; + } + } + + private function getComponent(string $component) + { + return isset($this->$component) ? $this->$component : null; + } + + private function formatComponent($value, string $before = '', string $after = ''): string + { + return $this->isEmpty($value) ? '' : "{$before}{$value}{$after}"; + } + + private function isEmpty($value): bool + { + return is_null($value) || $value === ''; + } + + private function assertString(string $component, $value): void + { + if (!is_string($value)) { + throw new InvalidArgumentException("Invalid '{$component}': Should be a string"); + } + } + + private function assertInteger(string $component, $value): void + { + if (!is_numeric($value) || intval($value) != $value) { + throw new InvalidArgumentException("Invalid '{$component}': Should be an integer"); + } + } + + private function assertPattern(string $component, string $value, string $pattern): void + { + if (preg_match($pattern, $value) == 0) { + throw new InvalidArgumentException("Invalid '{$component}': Should match {$pattern}"); + } + } + + private function normalizePath(string $path): string + { + $result = []; + preg_match_all('!([^/]*/|[^/]*$)!', $path, $items); + foreach ($items[0] as $item) { + switch ($item) { + case '': + case './': + case '.': + break; // just skip + case '/': + if (empty($result)) { + array_push($result, $item); // add + } + break; + case '..': + case '../': + if (empty($result) || end($result) == '../') { + array_push($result, $item); // add + } else { + array_pop($result); // remove previous + } + break; + default: + array_push($result, $item); // add + } + } + return implode('', $result); + } + + private function idna(string $value): string + { + if ($value === '' || !is_callable('idn_to_ascii')) { + return $value; // Can't convert, but don't cause exception + } + return idn_to_ascii($value, IDNA_NONTRANSITIONAL_TO_ASCII, INTL_IDNA_VARIANT_UTS46); + } +} diff --git a/vendor/phrity/net-uri/src/UriFactory.php b/vendor/phrity/net-uri/src/UriFactory.php new file mode 100644 index 000000000..f100dd0a5 --- /dev/null +++ b/vendor/phrity/net-uri/src/UriFactory.php @@ -0,0 +1,31 @@ + Net > Uri + * @see https://www.rfc-editor.org/rfc/rfc3986 + * @see https://www.php-fig.org/psr/psr-17/#26-urifactoryinterface + */ + +namespace Phrity\Net; + +use Psr\Http\Message\{ + UriFactoryInterface, + UriInterface +}; + +/** + * Net\UriFactory class. + */ +class UriFactory implements UriFactoryInterface +{ + /** + * Create a new URI. + * @param string $uri The URI to parse. + * @throws \InvalidArgumentException If the given URI cannot be parsed + */ + public function createUri(string $uri = ''): UriInterface + { + return new Uri($uri); + } +} diff --git a/vendor/phrity/util-errorhandler/.github/workflows/acceptance.yml b/vendor/phrity/util-errorhandler/.github/workflows/acceptance.yml new file mode 100644 index 000000000..9c9638234 --- /dev/null +++ b/vendor/phrity/util-errorhandler/.github/workflows/acceptance.yml @@ -0,0 +1,128 @@ +name: Acceptance + +on: [push, pull_request] + +jobs: + test-7-2: + runs-on: ubuntu-latest + name: Test PHP 7.2 + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Set up PHP 7.2 + uses: shivammathur/setup-php@v2 + with: + php-version: '7.2' + - name: Composer + run: make deps-install + - name: Test + run: make test + + test-7-3: + runs-on: ubuntu-latest + name: Test PHP 7.3 + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Set up PHP 7.3 + uses: shivammathur/setup-php@v2 + with: + php-version: '7.3' + - name: Composer + run: make deps-install + - name: Test + run: make test + + test-7-4: + runs-on: ubuntu-latest + name: Test PHP 7.4 + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Set up PHP 7.4 + uses: shivammathur/setup-php@v2 + with: + php-version: '7.4' + - name: Composer + run: make deps-install + - name: Test + run: make test + + test-8-0: + runs-on: ubuntu-latest + name: Test PHP 8.0 + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Set up PHP 8.0 + uses: shivammathur/setup-php@v2 + with: + php-version: '8.0' + - name: Composer + run: make deps-install + - name: Test + run: make test + + test-8-1: + runs-on: ubuntu-latest + name: Test PHP 8.1 + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Set up PHP 8.1 + uses: shivammathur/setup-php@v2 + with: + php-version: '8.1' + extensions: pdo, pdo-sqlite + - name: Composer + run: make deps-install + - name: Test + run: make test + + test-8-2: + runs-on: ubuntu-latest + name: Test PHP 8.2 + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Set up PHP 8.2 + uses: shivammathur/setup-php@v2 + with: + php-version: '8.2' + - name: Composer + run: make deps-install + - name: Test + run: make test + + cs-check: + runs-on: ubuntu-latest + name: Code standard + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Set up PHP 8.0 + uses: shivammathur/setup-php@v2 + with: + php-version: '8.0' + - name: Composer + run: make deps-install + - name: Code standard + run: make cs-check + + coverage: + runs-on: ubuntu-latest + name: Code coverage + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Set up PHP 8.0 + uses: shivammathur/setup-php@v2 + with: + php-version: '8.0' + extensions: xdebug + - name: Composer + run: make deps-install + - name: Code coverage + env: + COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: make coverage diff --git a/vendor/phrity/util-errorhandler/.gitignore b/vendor/phrity/util-errorhandler/.gitignore new file mode 100644 index 000000000..379ab4b40 --- /dev/null +++ b/vendor/phrity/util-errorhandler/.gitignore @@ -0,0 +1,6 @@ +.DS_Store +.phpunit.result.cache +build/ +composer.lock +composer.phar +vendor/ \ No newline at end of file diff --git a/vendor/phrity/util-errorhandler/Makefile b/vendor/phrity/util-errorhandler/Makefile new file mode 100644 index 000000000..b97dcbdf3 --- /dev/null +++ b/vendor/phrity/util-errorhandler/Makefile @@ -0,0 +1,41 @@ +# Default +all: deps-install + + +# DEPENDENCY MANAGEMENT + +# Updates dependencies according to lock file +deps-install: composer.phar + ./composer.phar --no-interaction install + +# Updates dependencies according to json file +deps-update: composer.phar + ./composer.phar self-update + ./composer.phar --no-interaction update + + +# TESTS AND REPORTS + +# Code standard check +cs-check: composer.lock + ./vendor/bin/phpcs --standard=PSR1,PSR12 --encoding=UTF-8 --report=full --colors src tests + +# Run tests +test: composer.lock + ./vendor/bin/phpunit + +# Run tests with clover coverage report +coverage: composer.lock + XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-clover build/logs/clover.xml + ./vendor/bin/php-coveralls -v + + +# INITIAL INSTALL + +# Ensures composer is installed +composer.phar: + curl -sS https://getcomposer.org/installer | php + +# Ensures composer is installed and dependencies loaded +composer.lock: composer.phar + ./composer.phar --no-interaction install \ No newline at end of file diff --git a/vendor/phrity/util-errorhandler/README.md b/vendor/phrity/util-errorhandler/README.md new file mode 100644 index 000000000..69fad5fbe --- /dev/null +++ b/vendor/phrity/util-errorhandler/README.md @@ -0,0 +1,146 @@ +[![Build Status](https://github.com/sirn-se/phrity-util-errorhandler/actions/workflows/acceptance.yml/badge.svg)](https://github.com/sirn-se/phrity-util-errorhandler/actions) +[![Coverage Status](https://coveralls.io/repos/github/sirn-se/phrity-util-errorhandler/badge.svg?branch=main)](https://coveralls.io/github/sirn-se/phrity-util-errorhandler?branch=main) + +# Error Handler utility + +The PHP [error handling](https://www.php.net/manual/en/book.errorfunc.php) can be somewhat of a headache. +Typically an application uses a system level [error handler](https://www.php.net/manual/en/function.set-error-handler.php) and/or suppressing errors using the `@` prefix. +But those cases when your code need to act on triggered errors are more tricky. + +This library provides two convenience methods to handle errors on code blocks, either by throwing exceptions or running callback code when an error occurs. + +Current version supports PHP `^7.2|^8.0`. + +## Installation + +Install with [Composer](https://getcomposer.org/); +``` +composer require phrity/util-errorhandler +``` + +## The Error Handler + +The class provides two main methods; `with()` and `withAll()`. +The difference is that `with()` will act immediately on an error and abort further code execution, while `withAll()` will attempt to execute the entire code block before acting on errors that occurred. + +### Throwing ErrorException + +```php +use Phrity\Util\ErrorHandler; + +$handler = new ErrorHandler(); +$result = $handler->with(function () { + // Code to execute + return $success_result; +}); +$result = $handler->withAll(function () { + // Code to execute + return $success_result; +}); +``` +The examples above will run the callback code, but if an error occurs it will throw an [ErrorException](https://www.php.net/manual/en/class.errorexception.php). +Error message and severity will be that of the triggering error. +* `with()` will throw immediately when occured +* `withAll()` will throw when code is complete; if more than one error occurred, the first will be thrown + +### Throwing specified Throwable + +```php +use Phrity\Util\ErrorHandler; + +$handler = new ErrorHandler(); +$result = $handler->with(function () { + // Code to execute + return $success_result; +}, new RuntimeException('A specified error')); +$result = $handler->withAll(function () { + // Code to execute + return $success_result; +}, new RuntimeException('A specified error')); +``` +The examples above will run the callback code, but if an error occurs it will throw provided Throwable. +The thrown Throwable will have an [ErrorException](https://www.php.net/manual/en/class.errorexception.php) attached as `$previous`. +* `with()` will throw immediately when occured +* `withAll()` will throw when code is complete; if more than one error occurred, the first will be thrown + +### Using callback + +```php +use Phrity\Util\ErrorHandler; + +$handler = new ErrorHandler(); +$result = $handler->with(function () { + // Code to execute + return $success_result; +}, function (ErrorException $error) { + // Code to handle error + return $error_result; +}); +$result = $handler->withAll(function () { + // Code to execute + return $success_result; +}, function (array $errors, $success_result) { + // Code to handle errors + return $error_result; +}); +``` +The examples above will run the callback code, but if an error occurs it will call the error callback as well. +* `with()` will run the error callback immediately when error occured; error callback expects an ErrorException instance +* `withAll()` will run the error callback when code is complete; error callback expects an array of ErrorException and the returned result of code callback + +### Filtering error types + +Both `with()` and `withAll()` accepts error level(s) as last parameter. +```php +use Phrity\Util\ErrorHandler; + +$handler = new ErrorHandler(); +$result = $handler->with(function () { + // Code to execute + return $success_result; +}, null, E_USER_ERROR); +$result = $handler->withAll(function () { + // Code to execute + return $success_result; +}, null, E_USER_ERROR & E_USER_WARNING); +``` +Any value or combination of values accepted by [set_error_handler](https://www.php.net/manual/en/function.set-error-handler.php) is usable. +Default is `E_ALL`. [List of constants](https://www.php.net/manual/en/errorfunc.constants.php). + +### The global error handler + +The class also has global `set()` and `restore()` methods. + +```php +use Phrity\Util\ErrorHandler; + +$handler = new ErrorHandler(); +$handler->set(); // Throws ErrorException on error +$handler->set(new RuntimeException('A specified error')); // Throws provided Throwable on error +$handler->set(function (ErrorException $error) { + // Code to handle errors + return $error_result; +}); // Runs callback on error +$handler->restore(); // Restores error handler +``` + +### Class synopsis + +```php +Phrity\Util\ErrorHandler { + + /* Methods */ + public __construct() + + public with(callable $callback, mixed $handling = null, int $levels = E_ALL) : mixed + public withAll(callable $callback, mixed $handling = null, int $levels = E_ALL) : mixed + public set($handling = null, int $levels = E_ALL) : mixed + public restore() : bool +} +``` + +## Versions + +| Version | PHP | | +| --- | --- | --- | +| `1.0` | `^7.2\|^8.0` | Initial version | diff --git a/vendor/phrity/util-errorhandler/composer.json b/vendor/phrity/util-errorhandler/composer.json new file mode 100644 index 000000000..f7c00bc1e --- /dev/null +++ b/vendor/phrity/util-errorhandler/composer.json @@ -0,0 +1,33 @@ +{ + "name": "phrity/util-errorhandler", + "type": "library", + "description": "Inline error handler; catch and resolve errors for code block.", + "homepage": "https://phrity.sirn.se/util-errorhandler", + "keywords": ["error", "warning"], + "license": "MIT", + "authors": [ + { + "name": "Sören Jensen", + "email": "sirn@sirn.se", + "homepage": "https://phrity.sirn.se" + } + ], + "autoload": { + "psr-4": { + "": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "": "tests/" + } + }, + "require": { + "php": "^7.2|^8.0" + }, + "require-dev": { + "phpunit/phpunit": "^8.0|^9.0", + "php-coveralls/php-coveralls": "^2.0", + "squizlabs/php_codesniffer": "^3.5" + } +} diff --git a/vendor/phrity/util-errorhandler/phpunit.xml.dist b/vendor/phrity/util-errorhandler/phpunit.xml.dist new file mode 100644 index 000000000..8d0b5f2c3 --- /dev/null +++ b/vendor/phrity/util-errorhandler/phpunit.xml.dist @@ -0,0 +1,15 @@ + + + + + + ./tests/ + + + + + + ./src/ + + + \ No newline at end of file diff --git a/vendor/phrity/util-errorhandler/src/Phrity/Util/ErrorHandler.php b/vendor/phrity/util-errorhandler/src/Phrity/Util/ErrorHandler.php new file mode 100644 index 000000000..7eb42bbef --- /dev/null +++ b/vendor/phrity/util-errorhandler/src/Phrity/Util/ErrorHandler.php @@ -0,0 +1,119 @@ + Util > ErrorHandler + */ + +namespace Phrity\Util; + +use ErrorException; +use Throwable; + +/** + * ErrorHandler utility class. + * Allows catching and resolving errors inline. + */ +class ErrorHandler +{ + /* ----------------- Public methods ---------------------------------------------- */ + + /** + * Set error handler to run until removed. + * @param mixed $handling + * - If null, handler will throw ErrorException + * - If Throwable $t, throw $t with ErrorException attached as previous + * - If callable, will invoke callback with ErrorException as argument + * @param int $levels Error levels to catch, all errors by default + * @return mixed Previously registered error handler, if any + */ + public function set($handling = null, int $levels = E_ALL) + { + return set_error_handler($this->getHandler($handling), $levels); + } + + /** + * Remove error handler. + * @return bool True if removed + */ + public function restore(): bool + { + return restore_error_handler(); + } + + /** + * Run code with error handling, breaks on first encountered error. + * @param callable $callback The code to run + * @param mixed $handling + * - If null, handler will throw ErrorException + * - If Throwable $t, throw $t with ErrorException attached as previous + * - If callable, will invoke callback with ErrorException as argument + * @param int $levels Error levels to catch, all errors by default + * @return mixed Return what $callback returns, or what $handling retuns on error + */ + public function with(callable $callback, $handling = null, int $levels = E_ALL) + { + $error = null; + $result = null; + try { + $this->set(null, $levels); + $result = $callback(); + } catch (ErrorException $e) { + $error = $this->handle($handling, $e); + } + $this->restore(); + return $error ?: $result; + } + + /** + * Run code with error handling, comletes code before handling errors + * @param callable $callback The code to run + * @param mixed $handling + * - If null, handler will throw ErrorException + * - If Throwable $t, throw $t with ErrorException attached as previous + * - If callable, will invoke callback with ErrorException as argument + * @param int $levels Error levels to catch, all errors by default + * @return mixed Return what $callback returns, or what $handling retuns on error + */ + public function withAll(callable $callback, $handling = null, int $levels = E_ALL) + { + $errors = []; + $this->set(function (ErrorException $e) use (&$errors) { + $errors[] = $e; + }, $levels); + $result = $callback(); + $error = empty($errors) ? null : $this->handle($handling, $errors, $result); + $this->restore(); + return $error ?: $result; + } + + /* ----------------- Private helpers --------------------------------------------- */ + + // Get handler function + private function getHandler($handling) + { + return function ($severity, $message, $file, $line) use ($handling) { + $error = new ErrorException($message, 0, $severity, $file, $line); + $this->handle($handling, $error); + }; + } + + // Handle error according to $handlig type + private function handle($handling, $error, $result = null) + { + if (is_callable($handling)) { + return $handling($error, $result); + } + if (is_array($error)) { + $error = array_shift($error); + } + if ($handling instanceof Throwable) { + try { + throw $error; + } finally { + throw $handling; + } + } + throw $error; + } +} diff --git a/vendor/phrity/util-errorhandler/tests/ErrorHandlerTest.php b/vendor/phrity/util-errorhandler/tests/ErrorHandlerTest.php new file mode 100644 index 000000000..66e251568 --- /dev/null +++ b/vendor/phrity/util-errorhandler/tests/ErrorHandlerTest.php @@ -0,0 +1,311 @@ + Util > ErrorHandler + */ + +declare(strict_types=1); + +namespace Phrity\Util; + +use ErrorException; +use RuntimeException; +use Phrity\Util\ErrorHandler; +use PHPUnit\Framework\TestCase; + +/** + * ErrorHandler test class. + */ +class ErrorHandlerTest extends TestCase +{ + /** + * Set up for all tests + */ + public function setUp(): void + { + error_reporting(-1); + } + + public function testSetNull(): void + { + $handler = new ErrorHandler(); + $handler->set(); + + // Verify exception + try { + trigger_error('An error'); + } catch (ErrorException $e) { + $this->assertEquals('An error', $e->getMessage()); + $this->assertEquals(0, $e->getCode()); + $this->assertEquals(E_USER_NOTICE, $e->getSeverity()); + $this->assertNull($e->getPrevious()); + } + + // Verify that exception is thrown + $this->expectException('ErrorException'); + trigger_error('Another error'); + + // Restore handler + $this->assertTrue($handler->restore()); + } + + public function testSetThrowable(): void + { + $handler = new ErrorHandler(); + $handler->set(new RuntimeException('A provided exception', 23)); + + // Verify exception + try { + trigger_error('An error'); + } catch (RuntimeException $e) { + $this->assertEquals('A provided exception', $e->getMessage()); + $this->assertEquals(23, $e->getCode()); + $this->assertNotNull($e->getPrevious()); + $prev = $e->getPrevious(); + $this->assertEquals('An error', $prev->getMessage()); + $this->assertEquals(0, $prev->getCode()); + $this->assertEquals(E_USER_NOTICE, $prev->getSeverity()); + $this->assertNull($prev->getPrevious()); + } + + // Verify that exception is thrown + $this->expectException('RuntimeException'); + trigger_error('Another error'); + + // Restore handler + $this->assertTrue($handler->restore()); + } + + public function testSetCallback(): void + { + $handler = new ErrorHandler(); + $result = null; + $handler->set(function ($error) use (&$result) { + $result = [ + 'message' => $error->getMessage(), + 'code' => $error->getCode(), + 'severity' => $error->getSeverity(), + ]; + }); + + // Verify exception + trigger_error('An error'); + $this->assertEquals([ + 'message' => 'An error', + 'code' => 0, + 'severity' => E_USER_NOTICE, + ], $result); + + // Restore handler + $this->assertTrue($handler->restore()); + } + + public function testWithNull(): void + { + $handler = new ErrorHandler(); + $check = false; + + // No exception + $result = $handler->with(function () { + return 'Code success'; + }); + $this->assertEquals('Code success', $result); + + // Verify exception + try { + $result = $handler->with(function () use (&$check) { + trigger_error('An error'); + $check = true; + return 'Code success'; + }); + } catch (ErrorException $e) { + $this->assertEquals('An error', $e->getMessage()); + $this->assertEquals(0, $e->getCode()); + $this->assertEquals(E_USER_NOTICE, $e->getSeverity()); + $this->assertNull($e->getPrevious()); + } + $this->assertFalse($check); + + // Verify that exception is thrown + $this->expectException('ErrorException'); + $result = $handler->with(function () { + trigger_error('An error'); + return 'Code success'; + }); + } + + public function testWithThrowable(): void + { + $handler = new ErrorHandler(); + $check = false; + + // No exception + $result = $handler->with(function () { + return 'Code success'; + }); + $this->assertEquals('Code success', $result); + + // Verify exception + try { + $result = $handler->with(function () use (&$check) { + trigger_error('An error'); + $check = true; + return 'Code success'; + }, new RuntimeException('A provided exception', 23)); + } catch (RuntimeException $e) { + $this->assertEquals('A provided exception', $e->getMessage()); + $this->assertEquals(23, $e->getCode()); + $this->assertNotNull($e->getPrevious()); + $prev = $e->getPrevious(); + $this->assertEquals('An error', $prev->getMessage()); + $this->assertEquals(0, $prev->getCode()); + $this->assertEquals(E_USER_NOTICE, $prev->getSeverity()); + $this->assertNull($prev->getPrevious()); + } + $this->assertFalse($check); + + // Verify that exception is thrown + $this->expectException('RuntimeException'); + $result = $handler->with(function () { + trigger_error('An error'); + return 'Code success'; + }, new RuntimeException('A provided exception', 23)); + } + + public function testWithCallback(): void + { + $handler = new ErrorHandler(); + $check = false; + + // No error invoked + $result = $handler->with(function () { + return 'Code success'; + }, function ($error) { + return $error; + }); + $this->assertEquals('Code success', $result); + + // An error is invoked + $result = $handler->with(function () use (&$check) { + trigger_error('An error'); + $check = true; + return 'Code success'; + }, function ($error) { + return $error; + }); + $this->assertFalse($check); + + $this->assertEquals('An error', $result->getMessage()); + $this->assertEquals(0, $result->getCode()); + $this->assertEquals(E_USER_NOTICE, $result->getSeverity()); + $this->assertNull($result->getPrevious()); + } + + public function testWithAllNull(): void + { + $handler = new ErrorHandler(); + $check = false; + + // No error invoked + $result = $handler->withAll(function () { + return 'Code success'; + }); + $this->assertEquals('Code success', $result); + + // Verify exception + try { + $result = $handler->withAll(function () use (&$check) { + trigger_error('An error'); + $check = true; + return 'Code success'; + }); + } catch (ErrorException $e) { + $this->assertEquals('An error', $e->getMessage()); + $this->assertEquals(0, $e->getCode()); + $this->assertEquals(E_USER_NOTICE, $e->getSeverity()); + $this->assertNull($e->getPrevious()); + } + $this->assertTrue($check); + + // Verify that exception is thrown + $this->expectException('ErrorException'); + $result = $handler->withAll(function () { + trigger_error('An error'); + return 'Code success'; + }); + } + + public function testWithAllThrowable(): void + { + $handler = new ErrorHandler(); + $check = false; + + // No exception + $result = $handler->withAll(function () { + return 'Code success'; + }); + $this->assertEquals('Code success', $result); + + // Verify exception + try { + $result = $handler->withAll(function () use (&$check) { + trigger_error('An error'); + $check = true; + return 'Code success'; + }, new RuntimeException('A provided exception', 23)); + } catch (RuntimeException $e) { + $this->assertEquals('A provided exception', $e->getMessage()); + $this->assertEquals(23, $e->getCode()); + $this->assertNotNull($e->getPrevious()); + $prev = $e->getPrevious(); + $this->assertEquals('An error', $prev->getMessage()); + $this->assertEquals(0, $prev->getCode()); + $this->assertEquals(E_USER_NOTICE, $prev->getSeverity()); + $this->assertNull($prev->getPrevious()); + } + $this->assertTrue($check); + + // Verify that exception is thrown + $this->expectException('RuntimeException'); + $result = $handler->withAll(function () { + trigger_error('An error'); + return 'Code success'; + }, new RuntimeException('A provided exception', 23)); + } + + public function testWithAllCallback(): void + { + $handler = new ErrorHandler(); + $check = false; + + // No error invoked + $result = $handler->withAll(function () { + return 'Code success'; + }, function ($error, $result) { + return $error; + }); + $this->assertEquals('Code success', $result); + + // An error is invoked + $result = $handler->withAll(function () use (&$check) { + trigger_error('An error'); + trigger_error('Another error', E_USER_WARNING); + $check = true; + return 'Code success'; + }, function ($errors, $result) { + return ['errors' => $errors, 'result' => $result]; + }); + $this->assertTrue($check); + + $this->assertEquals('Code success', $result['result']); + $this->assertEquals('An error', $result['errors'][0]->getMessage()); + $this->assertEquals(0, $result['errors'][0]->getCode()); + $this->assertEquals(E_USER_NOTICE, $result['errors'][0]->getSeverity()); + $this->assertNull($result['errors'][0]->getPrevious()); + $this->assertEquals('Another error', $result['errors'][1]->getMessage()); + $this->assertEquals(0, $result['errors'][1]->getCode()); + $this->assertEquals(E_USER_WARNING, $result['errors'][1]->getSeverity()); + $this->assertNull($result['errors'][1]->getPrevious()); + } +} diff --git a/vendor/services.php b/vendor/services.php index a718f984e..1d23a0e2a 100644 --- a/vendor/services.php +++ b/vendor/services.php @@ -1,5 +1,5 @@ 'think\\app\\Service', diff --git a/vendor/textalk/websocket/.github/ISSUE_TEMPLATE/bug_report.md b/vendor/textalk/websocket/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..d402046b9 --- /dev/null +++ b/vendor/textalk/websocket/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,21 @@ +--- +name: Bug report +about: Use this if you believe there is a bug in this repo +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +Please provide a clear and concise description of the suspected issue. + +**How to reproduce** +If possible, provide information - possibly including code snippets - on how to reproduce the issue. + +**Logs** +If possible, provide logs that indicate the issue. See https://github.com/Textalk/websocket-php/blob/master/docs/Examples.md#echo-logger on how to use the EchoLog. + +**Versions** +* Version of this library +* PHP version diff --git a/vendor/textalk/websocket/.github/ISSUE_TEMPLATE/feature_request.md b/vendor/textalk/websocket/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..ce777f6d0 --- /dev/null +++ b/vendor/textalk/websocket/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,14 @@ +--- +name: Feature request +about: Suggest an idea for this library +title: '' +labels: feature request +assignees: '' + +--- + +**Is it within the scope of this library?** +Consider and describe why the feature would be beneficial in this library, and not implemented as a separate project using this as a dependency. + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. diff --git a/vendor/textalk/websocket/.github/ISSUE_TEMPLATE/other-issue.md b/vendor/textalk/websocket/.github/ISSUE_TEMPLATE/other-issue.md new file mode 100644 index 000000000..fe5cc8df8 --- /dev/null +++ b/vendor/textalk/websocket/.github/ISSUE_TEMPLATE/other-issue.md @@ -0,0 +1,10 @@ +--- +name: Other issue +about: Use this for other issues +title: '' +labels: '' +assignees: '' + +--- + +**Describe your issue** diff --git a/vendor/textalk/websocket/.github/workflows/acceptance.yml b/vendor/textalk/websocket/.github/workflows/acceptance.yml new file mode 100644 index 000000000..a55f2a75f --- /dev/null +++ b/vendor/textalk/websocket/.github/workflows/acceptance.yml @@ -0,0 +1,97 @@ +name: Acceptance + +on: [push, pull_request] + +jobs: + test-7-4: + runs-on: ubuntu-latest + name: Test PHP 7.4 + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Set up PHP 7.4 + uses: shivammathur/setup-php@v2 + with: + php-version: '7.4' + - name: Composer + run: make install + - name: Test + run: make test + + test-8-0: + runs-on: ubuntu-latest + name: Test PHP 8.0 + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Set up PHP 8.0 + uses: shivammathur/setup-php@v2 + with: + php-version: '8.0' + - name: Composer + run: make install + - name: Test + run: make test + + test-8-1: + runs-on: ubuntu-latest + name: Test PHP 8.1 + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Set up PHP 8.1 + uses: shivammathur/setup-php@v2 + with: + php-version: '8.1' + - name: Composer + run: make install + - name: Test + run: make test + + test-8-2: + runs-on: ubuntu-latest + name: Test PHP 8.2 + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Set up PHP 8.2 + uses: shivammathur/setup-php@v2 + with: + php-version: '8.2' + - name: Composer + run: make install + - name: Test + run: make test + + cs-check: + runs-on: ubuntu-latest + name: Code standard + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Set up PHP 8.0 + uses: shivammathur/setup-php@v2 + with: + php-version: '8.0' + - name: Composer + run: make install + - name: Code standard + run: make cs-check + + coverage: + runs-on: ubuntu-latest + name: Code coverage + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Set up PHP 8.0 + uses: shivammathur/setup-php@v2 + with: + php-version: '8.0' + extensions: xdebug + - name: Composer + run: make install + - name: Code coverage + env: + COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: make coverage diff --git a/vendor/textalk/websocket/.gitignore b/vendor/textalk/websocket/.gitignore new file mode 100644 index 000000000..379ab4b40 --- /dev/null +++ b/vendor/textalk/websocket/.gitignore @@ -0,0 +1,6 @@ +.DS_Store +.phpunit.result.cache +build/ +composer.lock +composer.phar +vendor/ \ No newline at end of file diff --git a/vendor/textalk/websocket/COPYING.md b/vendor/textalk/websocket/COPYING.md new file mode 100644 index 000000000..ba9648033 --- /dev/null +++ b/vendor/textalk/websocket/COPYING.md @@ -0,0 +1,16 @@ +# Websocket: License + +Websocket PHP is free software released under the following license: + +[ISC License](http://en.wikipedia.org/wiki/ISC_license) + +Permission to use, copy, modify, and/or distribute this software for any purpose with or without +fee is hereby granted, provided that the above copyright notice and this permission notice appear +in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS +SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE +AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, +NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF +THIS SOFTWARE. diff --git a/vendor/textalk/websocket/Makefile b/vendor/textalk/websocket/Makefile new file mode 100644 index 000000000..54d507e8b --- /dev/null +++ b/vendor/textalk/websocket/Makefile @@ -0,0 +1,32 @@ +install: composer.phar + ./composer.phar install + +update: composer.phar + ./composer.phar self-update + ./composer.phar update + +test: composer.lock + ./vendor/bin/phpunit + +cs-check: composer.lock + ./vendor/bin/phpcs --standard=PSR1,PSR12 --encoding=UTF-8 --report=full --colors lib tests examples + +coverage: composer.lock build + XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-clover build/logs/clover.xml + ./vendor/bin/php-coveralls -v + +composer.phar: + curl -s http://getcomposer.org/installer | php + +composer.lock: composer.phar + ./composer.phar --no-interaction install + +vendor/bin/phpunit: install + +build: + mkdir build + +clean: + rm composer.phar + rm -r vendor + rm -r build diff --git a/vendor/textalk/websocket/README.md b/vendor/textalk/websocket/README.md new file mode 100644 index 000000000..f4a41a07c --- /dev/null +++ b/vendor/textalk/websocket/README.md @@ -0,0 +1,67 @@ +# Websocket Client and Server for PHP + +[![Build Status](https://github.com/Textalk/websocket-php/actions/workflows/acceptance.yml/badge.svg)](https://github.com/Textalk/websocket-php/actions) +[![Coverage Status](https://coveralls.io/repos/github/Textalk/websocket-php/badge.svg?branch=master)](https://coveralls.io/github/Textalk/websocket-php) + +This library contains WebSocket client and server for PHP. + +The client and server provides methods for reading and writing to WebSocket streams. +It does not include convenience operations such as listeners and implicit error handling. + +## Documentation + +- [Client](docs/Client.md) +- [Server](docs/Server.md) +- [Examples](docs/Examples.md) +- [Changelog](docs/Changelog.md) +- [Contributing](docs/Contributing.md) + +## Installing + +Preferred way to install is with [Composer](https://getcomposer.org/). +``` +composer require textalk/websocket +``` + +* Current version support PHP versions `^7.4|^8.0`. +* For PHP `7.2` and `7.3` support use version [`1.5`](https://github.com/Textalk/websocket-php/tree/1.5.0). +* For PHP `7.1` support use version [`1.4`](https://github.com/Textalk/websocket-php/tree/1.4.0). +* For PHP `^5.4` and `7.0` support use version [`1.3`](https://github.com/Textalk/websocket-php/tree/1.3.0). + +## Client + +The [client](docs/Client.md) can read and write on a WebSocket stream. +It internally supports Upgrade handshake and implicit close and ping/pong operations. + +```php +$client = new WebSocket\Client("ws://echo.websocket.org/"); +$client->text("Hello WebSocket.org!"); +echo $client->receive(); +$client->close(); +``` + +## Server + +The library contains a rudimentary single stream/single thread [server](docs/Server.md). +It internally supports Upgrade handshake and implicit close and ping/pong operations. + +Note that it does **not** support threading or automatic association ot continuous client requests. +If you require this kind of server behavior, you need to build it on top of provided server implementation. + +```php +$server = new WebSocket\Server(); +$server->accept(); +$message = $server->receive(); +$server->text($message); +$server->close(); +``` + +### License and Contributors + +[ISC License](COPYING.md) + +Fredrik Liljegren, Armen Baghumian Sankbarani, Ruslan Bekenev, +Joshua Thijssen, Simon Lipp, Quentin Bellus, Patrick McCarren, swmcdonnell, +Ignas Bernotas, Mark Herhold, Andreas Palm, Sören Jensen, pmaasz, Alexey Stavrov, +Michael Slezak, Pierre Seznec, rmeisler, Nickolay V. Shmyrev, Christoph Kempen, +Marc Roberts, Antonio Mora, Simon Podlipsky, etrinh. diff --git a/vendor/textalk/websocket/composer.json b/vendor/textalk/websocket/composer.json new file mode 100644 index 000000000..23018eeb2 --- /dev/null +++ b/vendor/textalk/websocket/composer.json @@ -0,0 +1,36 @@ +{ + "name": "textalk/websocket", + "description": "WebSocket client and server", + "license": "ISC", + "type": "library", + "authors": [ + { + "name": "Fredrik Liljegren" + }, + { + "name": "Sören Jensen" + } + ], + "autoload": { + "psr-4": { + "WebSocket\\": "lib" + } + }, + "autoload-dev": { + "psr-4": { + "WebSocket\\": "tests/mock" + } + }, + "require": { + "php": "^7.4 | ^8.0", + "phrity/net-uri": "^1.0", + "phrity/util-errorhandler": "^1.0", + "psr/log": "^1.0 | ^2.0 | ^3.0", + "psr/http-message": "^1.0" + }, + "require-dev": { + "phpunit/phpunit": "^9.0", + "php-coveralls/php-coveralls": "^2.0", + "squizlabs/php_codesniffer": "^3.5" + } +} diff --git a/vendor/textalk/websocket/docs/Changelog.md b/vendor/textalk/websocket/docs/Changelog.md new file mode 100644 index 000000000..38f264ee0 --- /dev/null +++ b/vendor/textalk/websocket/docs/Changelog.md @@ -0,0 +1,167 @@ +[Client](Client.md) • [Server](Server.md) • [Message](Message.md) • [Examples](Examples.md) • Changelog • [Contributing](Contributing.md) + +# Websocket: Changelog + +## `v1.6` + + > PHP version `^7.4|^8.0` + +### `1.6.3` + + * Fix issue with implicit default ports (@etrinh, @sirn-se) + +### `1.6.2` + + * Fix issue where port was missing in socket uri (@sirn-se) + +### `1.6.1` + + * Fix client path for http request (@simPod, @sirn-se) + +### `1.6.0` + * Connection separate from Client and Server (@sirn-se) + * getPier() deprecated, replaced by getRemoteName() (@sirn-se) + * Client accepts `Psr\Http\Message\UriInterface` as input for URI:s (@sirn-se) + * Bad URI throws exception when Client is instanciated, previously when used (@sirn-se) + * Preparations for multiple conection and listeners (@sirn-se) + * Major internal refactoring (@sirn-se) + +## `v1.5` + + > PHP version `^7.2|^8.0` + +### `1.5.8` + + * Handle read error during handshake (@sirn-se) + +### `1.5.7` + + * Large header block fix (@sirn-se) + +### `1.5.6` + + * Add test for PHP 8.1 (@sirn-se) + * Code standard (@sirn-se) + +### `1.5.5` + + * Support for psr/log v2 and v3 (@simPod) + * GitHub Actions replaces Travis (@sirn-se) + +### `1.5.4` + + * Keep open connection on read timeout (@marcroberts) + +### `1.5.3` + + * Fix for persistent connection (@sirn-se) + +### `1.5.2` + + * Fix for getName() method (@sirn-se) + +### `1.5.1` + + * Fix for persistent connections (@rmeisler) + +### `1.5.0` + + * Convenience send methods; text(), binary(), ping(), pong() (@sirn-se) + * Optional Message instance as receive() method return (@sirn-se) + * Opcode filter for receive() method (@sirn-se) + * Added PHP `8.0` support (@webpatser) + * Dropped PHP `7.1` support (@sirn-se) + * Fix for unordered fragmented messages (@sirn-se) + * Improved error handling on stream calls (@sirn-se) + * Various code re-write (@sirn-se) + +## `v1.4` + + > PHP version `^7.1` + +#### `1.4.3` + + * Solve stream closure/get meta conflict (@sirn-se) + * Examples and documentation overhaul (@sirn-se) + +#### `1.4.2` + + * Force stream close on read error (@sirn-se) + * Authorization headers line feed (@sirn-se) + * Documentation (@matias-pool, @sirn-se) + +#### `1.4.1` + + * Ping/Pong, handled internally to avoid breaking fragmented messages (@nshmyrev, @sirn-se) + * Fix for persistent connections (@rmeisler) + * Fix opcode bitmask (@peterjah) + +#### `1.4.0` + + * Dropped support of old PHP versions (@sirn-se) + * Added PSR-3 Logging support (@sirn-se) + * Persistent connection option (@slezakattack) + * TimeoutException on connection time out (@slezakattack) + +## `v1.3` + + > PHP version `^5.4` and `^7.0` + +#### `1.3.1` + + * Allow control messages without payload (@Logioniz) + * Error code in ConnectionException (@sirn-se) + +#### `1.3.0` + + * Implements ping/pong frames (@pmccarren @Logioniz) + * Close behaviour (@sirn-se) + * Various fixes concerning connection handling (@sirn-se) + * Overhaul of Composer, Travis and Coveralls setup, PSR code standard and unit tests (@sirn-se) + +## `v1.2` + + > PHP version `^5.4` and `^7.0` + +#### `1.2.0` + + * Adding stream context options (to set e.g. SSL `allow_self_signed`). + +## `v1.1` + + > PHP version `^5.4` and `^7.0` + +#### `1.1.2` + + * Fixed error message on broken frame. + +#### `1.1.1` + + * Adding license information. + +#### `1.1.0` + + * Supporting huge payloads. + +## `v1.0` + + > PHP version `^5.4` and `^7.0` + +#### `1.0.3` + + * Bugfix: Correcting address in error-message + +#### `1.0.2` + + * Bugfix: Add port in request-header. + +#### `1.0.1` + + * Fixing a bug from empty payloads. + +#### `1.0.0` + + * Release as production ready. + * Adding option to set/override headers. + * Supporting basic authentication from user:pass in URL. + diff --git a/vendor/textalk/websocket/docs/Client.md b/vendor/textalk/websocket/docs/Client.md new file mode 100644 index 000000000..be8d2852c --- /dev/null +++ b/vendor/textalk/websocket/docs/Client.md @@ -0,0 +1,137 @@ +Client • [Server](Server.md) • [Message](Message.md) • [Examples](Examples.md) • [Changelog](Changelog.md) • [Contributing](Contributing.md) + +# Websocket: Client + +The client can read and write on a WebSocket stream. +It internally supports Upgrade handshake and implicit close and ping/pong operations. + +## Class synopsis + +```php +WebSocket\Client { + + public __construct(UriInterface|string $uri, array $options = []); + public __destruct(); + public __toString() : string; + + public text(string $payload) : void; + public binary(string $payload) : void; + public ping(string $payload = '') : void; + public pong(string $payload = '') : void; + public send(Message|string $payload, string $opcode = 'text', bool $masked = true) : void; + public close(int $status = 1000, mixed $message = 'ttfn') : void; + public receive() : Message|string|null; + + public getName() : string|null; + public getRemoteName() : string|null; + public getLastOpcode() : string; + public getCloseStatus() : int; + public isConnected() : bool; + public setTimeout(int $seconds) : void; + public setFragmentSize(int $fragment_size) : self; + public getFragmentSize() : int; + public setLogger(Psr\Log\LoggerInterface $logger = null) : void; +} +``` + +## Examples + +### Simple send-receive operation + +This example send a single message to a server, and output the response. + +```php +$client = new WebSocket\Client("ws://echo.websocket.org/"); +$client->text("Hello WebSocket.org!"); +echo $client->receive(); +$client->close(); +``` + +### Listening to a server + +To continuously listen to incoming messages, you need to put the receive operation within a loop. +Note that these functions **always** throw exception on any failure, including recoverable failures such as connection time out. +By consuming exceptions, the code will re-connect the socket in next loop iteration. + +```php +$client = new WebSocket\Client("ws://echo.websocket.org/"); +while (true) { + try { + $message = $client->receive(); + // Act on received message + // Break while loop to stop listening + } catch (\WebSocket\ConnectionException $e) { + // Possibly log errors + } +} +$client->close(); +``` + +### Filtering received messages + +By default the `receive()` method return messages of 'text' and 'binary' opcode. +The filter option allows you to specify which message types to return. + +```php +$client = new WebSocket\Client("ws://echo.websocket.org/", ['filter' => ['text']]); +$client->receive(); // Only return 'text' messages + +$client = new WebSocket\Client("ws://echo.websocket.org/", ['filter' => ['text', 'binary', 'ping', 'pong', 'close']]); +$client->receive(); // Return all messages +``` + +### Sending messages + +There are convenience methods to send messages with different opcodes. +```php +$client = new WebSocket\Client("ws://echo.websocket.org/"); + +// Convenience methods +$client->text('A plain text message'); // Send an opcode=text message +$client->binary($binary_string); // Send an opcode=binary message +$client->ping(); // Send an opcode=ping frame +$client->pong(); // Send an unsolicited opcode=pong frame + +// Generic send method +$client->send($payload); // Sent as masked opcode=text +$client->send($payload, 'binary'); // Sent as masked opcode=binary +$client->send($payload, 'binary', false); // Sent as unmasked opcode=binary +``` + +## Constructor options + +The `$options` parameter in constructor accepts an associative array of options. + +* `context` - A stream context created using [stream_context_create](https://www.php.net/manual/en/function.stream-context-create). +* `filter` - Array of opcodes to return on receive, default `['text', 'binary']` +* `fragment_size` - Maximum payload size. Default 4096 chars. +* `headers` - Additional headers as associative array name => content. +* `logger` - A [PSR-3](https://www.php-fig.org/psr/psr-3/) compatible logger. +* `persistent` - Connection is re-used between requests until time out is reached. Default false. +* `return_obj` - Return a [Message](Message.md) instance on receive, default false +* `timeout` - Time out in seconds. Default 5 seconds. + +```php +$context = stream_context_create(); +stream_context_set_option($context, 'ssl', 'verify_peer', false); +stream_context_set_option($context, 'ssl', 'verify_peer_name', false); + +$client = new WebSocket\Client("ws://echo.websocket.org/", [ + 'context' => $context, // Attach stream context created above + 'filter' => ['text', 'binary', 'ping'], // Specify message types for receive() to return + 'headers' => [ // Additional headers, used to specify subprotocol + 'Sec-WebSocket-Protocol' => 'soap', + 'origin' => 'localhost', + ], + 'logger' => $my_psr3_logger, // Attach a PSR3 compatible logger + 'return_obj' => true, // Return Message instance rather than just text + 'timeout' => 60, // 1 minute time out +]); +``` + +## Exceptions + +* `WebSocket\BadOpcodeException` - Thrown if provided opcode is invalid. +* `WebSocket\BadUriException` - Thrown if provided URI is invalid. +* `WebSocket\ConnectionException` - Thrown on any socket I/O failure. +* `WebSocket\TimeoutException` - Thrown when the socket experiences a time out. diff --git a/vendor/textalk/websocket/docs/Contributing.md b/vendor/textalk/websocket/docs/Contributing.md new file mode 100644 index 000000000..c68ab83c3 --- /dev/null +++ b/vendor/textalk/websocket/docs/Contributing.md @@ -0,0 +1,51 @@ +[Client](Client.md) • [Server](Server.md) • [Message](Message.md) • [Examples](Examples.md) • [Changelog](Changelog.md) • Contributing + +# Websocket: Contributing + +Everyone is welcome to help out! +But to keep this project sustainable, please ensure your contribution respects the requirements below. + +## PR Requirements + +Requirements on pull requests; +* All tests **MUST** pass. +* Code coverage **MUST** remain at 100%. +* Code **MUST** adhere to PSR-1 and PSR-12 code standards. + +Base your patch on corresponding version branch, and target that version branch in your pull request. + +* `v1.6-master` current version +* `v1.5-master` previous version, bug fixes only +* Older versions should not be target of pull requests + + +## Dependency management + +Install or update dependencies using [Composer](https://getcomposer.org/). + +``` +# Install dependencies +make install + +# Update dependencies +make update +``` + +## Code standard + +This project uses [PSR-1](https://www.php-fig.org/psr/psr-1/) and [PSR-12](https://www.php-fig.org/psr/psr-12/) code standards. +``` +# Check code standard adherence +make cs-check +``` + +## Unit testing + +Unit tests with [PHPUnit](https://phpunit.readthedocs.io/), coverage with [Coveralls](https://github.com/php-coveralls/php-coveralls) +``` +# Run unit tests +make test + +# Create coverage +make coverage +``` diff --git a/vendor/textalk/websocket/docs/Examples.md b/vendor/textalk/websocket/docs/Examples.md new file mode 100644 index 000000000..399e0cc01 --- /dev/null +++ b/vendor/textalk/websocket/docs/Examples.md @@ -0,0 +1,101 @@ +[Client](Client.md) • [Server](Server.md) • [Message](Message.md) • Examples • [Changelog](Changelog.md) • [Contributing](Contributing.md) + +# Websocket: Examples + +Here are some examples on how to use the WebSocket library. + +## Echo logger + +In dev environment (as in having run composer to include dev dependencies) you have +access to a simple echo logger that print out information synchronously. + +This is usable for debugging. For production, use a proper logger. + +```php +namespace WebSocket; + +$logger = new EchoLogger(); + +$client = new Client('ws://echo.websocket.org/'); +$client->setLogger($logger); + +$server = new Server(); +$server->setLogger($logger); +``` + +An example of server output; +``` +info | Server listening to port 8000 [] +debug | Wrote 129 of 129 bytes. [] +info | Server connected to port 8000 [] +info | Received 'text' message [] +debug | Wrote 9 of 9 bytes. [] +info | Sent 'text' message [] +debug | Received 'close', status: 1000. [] +debug | Wrote 32 of 32 bytes. [] +info | Sent 'close' message [] +info | Received 'close' message [] +``` + +## The `send` client + +Source: [examples/send.php](../examples/send.php) + +A simple, single send/receive client. + +Example use: +``` +php examples/send.php --opcode text "A text message" // Send a text message to localhost +php examples/send.php --opcode ping "ping it" // Send a ping message to localhost +php examples/send.php --uri ws://echo.websocket.org "A text message" // Send a text message to echo.websocket.org +php examples/send.php --opcode text --debug "A text message" // Use runtime debugging +``` + +## The `echoserver` server + +Source: [examples/echoserver.php](../examples/echoserver.php) + +A simple server that responds to recevied commands. + +Example use: +``` +php examples/echoserver.php // Run with default settings +php examples/echoserver.php --port 8080 // Listen on port 8080 +php examples/echoserver.php --debug // Use runtime debugging +``` + +These strings can be sent as message to trigger server to perform actions; +* `auth` - Server will respond with auth header if provided by client +* `close` - Server will close current connection +* `exit` - Server will close all active connections +* `headers` - Server will respond with all headers provided by client +* `ping` - Server will send a ping message +* `pong` - Server will send a pong message +* `stop` - Server will stop listening +* For other sent strings, server will respond with the same strings + +## The `random` client + +Source: [examples/random_client.php](../examples/random_client.php) + +The random client will use random options and continuously send/receive random messages. + +Example use: +``` +php examples/random_client.php --uri ws://echo.websocket.org // Connect to echo.websocket.org +php examples/random_client.php --timeout 5 --fragment_size 16 // Specify settings +php examples/random_client.php --debug // Use runtime debugging +``` + +## The `random` server + +Source: [examples/random_server.php](../examples/random_server.php) + +The random server will use random options and continuously send/receive random messages. + +Example use: +``` +php examples/random_server.php --port 8080 // // Listen on port 8080 +php examples/random_server.php --timeout 5 --fragment_size 16 // Specify settings +php examples/random_server.php --debug // Use runtime debugging +``` diff --git a/vendor/textalk/websocket/docs/Message.md b/vendor/textalk/websocket/docs/Message.md new file mode 100644 index 000000000..80df04a89 --- /dev/null +++ b/vendor/textalk/websocket/docs/Message.md @@ -0,0 +1,60 @@ +[Client](Client.md) • [Server](Server.md) • Message • [Examples](Examples.md) • [Changelog](Changelog.md) • [Contributing](Contributing.md) + +# Websocket: Messages + +If option `return_obj` is set to `true` on [client](Client.md) or [server](Server.md), +the `receive()` method will return a Message instance instead of a string. + +Available classes correspond to opcode; +* WebSocket\Message\Text +* WebSocket\Message\Binary +* WebSocket\Message\Ping +* WebSocket\Message\Pong +* WebSocket\Message\Close + +Additionally; +* WebSocket\Message\Message - abstract base class for all messages above +* WebSocket\Message\Factory - Factory class to create Message instances + +## Message abstract class synopsis + +```php +WebSocket\Message\Message { + + public __construct(string $payload = ''); + public __toString() : string; + + public getOpcode() : string; + public getLength() : int; + public getTimestamp() : DateTime; + public getContent() : string; + public setContent(string $payload = '') : void; + public hasContent() : bool; +} +``` + +## Factory class synopsis + +```php +WebSocket\Message\Factory { + + public create(string $opcode, string $payload = '') : Message; +} +``` + +## Example + +Receving a Message and echo some methods. + +```php +$client = new WebSocket\Client('ws://echo.websocket.org/', ['return_obj' => true]); +$client->text('Hello WebSocket.org!'); +// Echo return same message as sent +$message = $client->receive(); +echo $message->getOpcode(); // -> "text" +echo $message->getLength(); // -> 20 +echo $message->getContent(); // -> "Hello WebSocket.org!" +echo $message->hasContent(); // -> true +echo $message->getTimestamp()->format('H:i:s'); // -> 19:37:18 +$client->close(); +``` diff --git a/vendor/textalk/websocket/docs/Server.md b/vendor/textalk/websocket/docs/Server.md new file mode 100644 index 000000000..9e12e0749 --- /dev/null +++ b/vendor/textalk/websocket/docs/Server.md @@ -0,0 +1,136 @@ +[Client](Client.md) • Server • [Message](Message.md) • [Examples](Examples.md) • [Changelog](Changelog.md) • [Contributing](Contributing.md) + +# Websocket: Server + +The library contains a rudimentary single stream/single thread server. +It internally supports Upgrade handshake and implicit close and ping/pong operations. + +Note that it does **not** support threading or automatic association ot continuous client requests. +If you require this kind of server behavior, you need to build it on top of provided server implementation. + +## Class synopsis + +```php +WebSocket\Server { + + public __construct(array $options = []); + public __destruct(); + public __toString() : string; + + public accept() : bool; + public text(string $payload) : void; + public binary(string $payload) : void; + public ping(string $payload = '') : void; + public pong(string $payload = '') : void; + public send(Message|string $payload, string $opcode = 'text', bool $masked = true) : void; + public close(int $status = 1000, mixed $message = 'ttfn') : void; + public receive() : Message|string|null; + + public getPort() : int; + public getPath() : string; + public getRequest() : array; + public getHeader(string $header_name) : string|null; + + public getName() : string|null; + public getRemoteName() : string|null; + public getLastOpcode() : string; + public getCloseStatus() : int; + public isConnected() : bool; + public setTimeout(int $seconds) : void; + public setFragmentSize(int $fragment_size) : self; + public getFragmentSize() : int; + public setLogger(Psr\Log\LoggerInterface $logger = null) : void; +} +``` + +## Examples + +### Simple receive-send operation + +This example reads a single message from a client, and respond with the same message. + +```php +$server = new WebSocket\Server(); +$server->accept(); +$message = $server->receive(); +$server->text($message); +$server->close(); +``` + +### Listening to clients + +To continuously listen to incoming messages, you need to put the receive operation within a loop. +Note that these functions **always** throw exception on any failure, including recoverable failures such as connection time out. +By consuming exceptions, the code will re-connect the socket in next loop iteration. + +```php +$server = new WebSocket\Server(); +while ($server->accept()) { + try { + $message = $server->receive(); + // Act on received message + // Break while loop to stop listening + } catch (\WebSocket\ConnectionException $e) { + // Possibly log errors + } +} +$server->close(); +``` + +### Filtering received messages + +By default the `receive()` method return messages of 'text' and 'binary' opcode. +The filter option allows you to specify which message types to return. + +```php +$server = new WebSocket\Server(['filter' => ['text']]); +$server->receive(); // only return 'text' messages + +$server = new WebSocket\Server(['filter' => ['text', 'binary', 'ping', 'pong', 'close']]); +$server->receive(); // return all messages +``` + +### Sending messages + +There are convenience methods to send messages with different opcodes. +```php +$server = new WebSocket\Server(); + +// Convenience methods +$server->text('A plain text message'); // Send an opcode=text message +$server->binary($binary_string); // Send an opcode=binary message +$server->ping(); // Send an opcode=ping frame +$server->pong(); // Send an unsolicited opcode=pong frame + +// Generic send method +$server->send($payload); // Sent as masked opcode=text +$server->send($payload, 'binary'); // Sent as masked opcode=binary +$server->send($payload, 'binary', false); // Sent as unmasked opcode=binary +``` + +## Constructor options + +The `$options` parameter in constructor accepts an associative array of options. + +* `filter` - Array of opcodes to return on receive, default `['text', 'binary']` +* `fragment_size` - Maximum payload size. Default 4096 chars. +* `logger` - A [PSR-3](https://www.php-fig.org/psr/psr-3/) compatible logger. +* `port` - The server port to listen to. Default 8000. +* `return_obj` - Return a [Message](Message.md) instance on receive, default false +* `timeout` - Time out in seconds. Default 5 seconds. + +```php +$server = new WebSocket\Server([ + 'filter' => ['text', 'binary', 'ping'], // Specify message types for receive() to return + 'logger' => $my_psr3_logger, // Attach a PSR3 compatible logger + 'port' => 9000, // Listening port + 'return_obj' => true, // Return Message instance rather than just text + 'timeout' => 60, // 1 minute time out +]); +``` + +## Exceptions + +* `WebSocket\BadOpcodeException` - Thrown if provided opcode is invalid. +* `WebSocket\ConnectionException` - Thrown on any socket I/O failure. +* `WebSocket\TimeoutException` - Thrown when the socket experiences a time out. diff --git a/vendor/textalk/websocket/examples/echoserver.php b/vendor/textalk/websocket/examples/echoserver.php new file mode 100644 index 000000000..a85e56403 --- /dev/null +++ b/vendor/textalk/websocket/examples/echoserver.php @@ -0,0 +1,87 @@ + : The port to listen to, default 8000 + * --timeout : Timeout in seconds, default 200 seconds + * --debug : Output log data (if logger is available) + */ + +namespace WebSocket; + +require __DIR__ . '/../vendor/autoload.php'; + +error_reporting(-1); + +echo "> Echo server\n"; + +// Server options specified or random +$options = array_merge([ + 'port' => 8000, + 'timeout' => 200, + 'filter' => ['text', 'binary', 'ping', 'pong', 'close'], +], getopt('', ['port:', 'timeout:', 'debug'])); + +// If debug mode and logger is available +if (isset($options['debug']) && class_exists('WebSocket\EchoLog')) { + $logger = new EchoLog(); + $options['logger'] = $logger; + echo "> Using logger\n"; +} + +// Initiate server. +try { + $server = new Server($options); +} catch (ConnectionException $e) { + echo "> ERROR: {$e->getMessage()}\n"; + die(); +} + +echo "> Listening to port {$server->getPort()}\n"; + +// Force quit to close server +while (true) { + try { + while ($server->accept()) { + echo "> Accepted on port {$server->getPort()}\n"; + while (true) { + $message = $server->receive(); + $opcode = $server->getLastOpcode(); + if (is_null($message)) { + echo "> Closing connection\n"; + continue 2; + } + echo "> Got '{$message}' [opcode: {$opcode}]\n"; + if (in_array($opcode, ['ping', 'pong'])) { + $server->send($message); + continue; + } + // Allow certain string to trigger server action + switch ($message) { + case 'exit': + echo "> Client told me to quit. Bye bye.\n"; + $server->close(); + echo "> Close status: {$server->getCloseStatus()}\n"; + exit; + case 'headers': + $server->text(implode("\r\n", $server->getRequest())); + break; + case 'ping': + $server->ping($message); + break; + case 'auth': + $auth = $server->getHeader('Authorization'); + $server->text("{$auth} - {$message}"); + break; + default: + $server->text($message); + } + } + } + } catch (ConnectionException $e) { + echo "> ERROR: {$e->getMessage()}\n"; + } +} diff --git a/vendor/textalk/websocket/examples/random_client.php b/vendor/textalk/websocket/examples/random_client.php new file mode 100644 index 000000000..b23bd6b4d --- /dev/null +++ b/vendor/textalk/websocket/examples/random_client.php @@ -0,0 +1,94 @@ + : The URI to connect to, default ws://localhost:8000 + * --timeout : Timeout in seconds, random default + * --fragment_size : Fragment size as bytes, random default + * --debug : Output log data (if logger is available) + */ + +namespace WebSocket; + +require __DIR__ . '/../vendor/autoload.php'; + +error_reporting(-1); + +$randStr = function (int $maxlength = 4096) { + $string = ''; + $length = rand(1, $maxlength); + for ($i = 0; $i < $length; $i++) { + $string .= chr(rand(33, 126)); + } + return $string; +}; + +echo "> Random client\n"; + +// Server options specified or random +$options = array_merge([ + 'uri' => 'ws://localhost:8000', + 'timeout' => rand(1, 60), + 'fragment_size' => rand(1, 4096) * 8, +], getopt('', ['uri:', 'timeout:', 'fragment_size:', 'debug'])); + +// If debug mode and logger is available +if (isset($options['debug']) && class_exists('WebSocket\EchoLog')) { + $logger = new EchoLog(); + $options['logger'] = $logger; + echo "> Using logger\n"; +} + +// Main loop +while (true) { + try { + $client = new Client($options['uri'], $options); + $info = json_encode([ + 'uri' => $options['uri'], + 'timeout' => $options['timeout'], + 'framgemt_size' => $client->getFragmentSize(), + ]); + echo "> Creating client {$info}\n"; + + try { + while (true) { + // Random actions + switch (rand(1, 10)) { + case 1: + echo "> Sending text\n"; + $client->text("Text message {$randStr()}"); + break; + case 2: + echo "> Sending binary\n"; + $client->binary("Binary message {$randStr()}"); + break; + case 3: + echo "> Sending close\n"; + $client->close(rand(1000, 2000), "Close message {$randStr(8)}"); + break; + case 4: + echo "> Sending ping\n"; + $client->ping("Ping message {$randStr(8)}"); + break; + case 5: + echo "> Sending pong\n"; + $client->pong("Pong message {$randStr(8)}"); + break; + default: + echo "> Receiving\n"; + $received = $client->receive(); + echo "> Received {$client->getLastOpcode()}: {$received}\n"; + } + sleep(rand(1, 5)); + } + } catch (\Throwable $e) { + echo "ERROR I/O: {$e->getMessage()} [{$e->getCode()}]\n"; + } + } catch (\Throwable $e) { + echo "ERROR: {$e->getMessage()} [{$e->getCode()}]\n"; + } + sleep(rand(1, 5)); +} diff --git a/vendor/textalk/websocket/examples/random_server.php b/vendor/textalk/websocket/examples/random_server.php new file mode 100644 index 000000000..0b0849cbc --- /dev/null +++ b/vendor/textalk/websocket/examples/random_server.php @@ -0,0 +1,93 @@ + : The port to listen to, default 8000 + * --timeout : Timeout in seconds, random default + * --fragment_size : Fragment size as bytes, random default + * --debug : Output log data (if logger is available) + */ + +namespace WebSocket; + +require __DIR__ . '/../vendor/autoload.php'; + +error_reporting(-1); + +$randStr = function (int $maxlength = 4096) { + $string = ''; + $length = rand(1, $maxlength); + for ($i = 0; $i < $length; $i++) { + $string .= chr(rand(33, 126)); + } + return $string; +}; + +echo "> Random server\n"; + +// Server options specified or random +$options = array_merge([ + 'port' => 8000, + 'timeout' => rand(1, 60), + 'fragment_size' => rand(1, 4096) * 8, +], getopt('', ['port:', 'timeout:', 'fragment_size:', 'debug'])); + +// If debug mode and logger is available +if (isset($options['debug']) && class_exists('WebSocket\EchoLog')) { + $logger = new EchoLog(); + $options['logger'] = $logger; + echo "> Using logger\n"; +} + +// Force quit to close server +while (true) { + try { + // Setup server + $server = new Server($options); + $info = json_encode([ + 'port' => $server->getPort(), + 'timeout' => $options['timeout'], + 'framgemt_size' => $server->getFragmentSize(), + ]); + echo "> Creating server {$info}\n"; + + while ($server->accept()) { + while (true) { + // Random actions + switch (rand(1, 10)) { + case 1: + echo "> Sending text\n"; + $server->text("Text message {$randStr()}"); + break; + case 2: + echo "> Sending binary\n"; + $server->binary("Binary message {$randStr()}"); + break; + case 3: + echo "> Sending close\n"; + $server->close(rand(1000, 2000), "Close message {$randStr(8)}"); + break; + case 4: + echo "> Sending ping\n"; + $server->ping("Ping message {$randStr(8)}"); + break; + case 5: + echo "> Sending pong\n"; + $server->pong("Pong message {$randStr(8)}"); + break; + default: + echo "> Receiving\n"; + $received = $server->receive(); + echo "> Received {$server->getLastOpcode()}: {$received}\n"; + } + sleep(rand(1, 5)); + } + } + } catch (\Throwable $e) { + echo "ERROR: {$e->getMessage()} [{$e->getCode()}]\n"; + } + sleep(rand(1, 5)); +} diff --git a/vendor/textalk/websocket/examples/send.php b/vendor/textalk/websocket/examples/send.php new file mode 100644 index 000000000..30e48e0c4 --- /dev/null +++ b/vendor/textalk/websocket/examples/send.php @@ -0,0 +1,51 @@ + + * + * Console options: + * --uri : The URI to connect to, default ws://localhost:8000 + * --opcode : Opcode to send, default 'text' + * --debug : Output log data (if logger is available) + */ + +namespace WebSocket; + +require __DIR__ . '/../vendor/autoload.php'; + +error_reporting(-1); + +echo "> Send client\n"; + +// Server options specified or random +$options = array_merge([ + 'uri' => 'ws://localhost:8000', + 'opcode' => 'text', +], getopt('', ['uri:', 'opcode:', 'debug'])); +$message = array_pop($argv); + +// If debug mode and logger is available +if (isset($options['debug']) && class_exists('WebSocket\EchoLog')) { + $logger = new EchoLog(); + $options['logger'] = $logger; + echo "> Using logger\n"; +} + +try { + // Create client, send and recevie + $client = new Client($options['uri'], $options); + $client->send($message, $options['opcode']); + echo "> Sent '{$message}' [opcode: {$options['opcode']}]\n"; + if (in_array($options['opcode'], ['text', 'binary'])) { + $message = $client->receive(); + $opcode = $client->getLastOpcode(); + if (!is_null($message)) { + echo "> Got '{$message}' [opcode: {$opcode}]\n"; + } + } + $client->close(); + echo "> Closing client\n"; +} catch (\Throwable $e) { + echo "ERROR: {$e->getMessage()} [{$e->getCode()}]\n"; +} diff --git a/vendor/textalk/websocket/lib/BadOpcodeException.php b/vendor/textalk/websocket/lib/BadOpcodeException.php new file mode 100644 index 000000000..260a97726 --- /dev/null +++ b/vendor/textalk/websocket/lib/BadOpcodeException.php @@ -0,0 +1,14 @@ + null, + 'filter' => ['text', 'binary'], + 'fragment_size' => 4096, + 'headers' => null, + 'logger' => null, + 'origin' => null, // @deprecated + 'persistent' => false, + 'return_obj' => false, + 'timeout' => 5, + ]; + + private $socket_uri; + private $connection; + private $options = []; + private $listen = false; + private $last_opcode = null; + + + /* ---------- Magic methods ------------------------------------------------------ */ + + /** + * @param UriInterface|string $uri A ws/wss-URI + * @param array $options + * Associative array containing: + * - context: Set the stream context. Default: empty context + * - timeout: Set the socket timeout in seconds. Default: 5 + * - fragment_size: Set framgemnt size. Default: 4096 + * - headers: Associative array of headers to set/override. + */ + public function __construct($uri, array $options = []) + { + $this->socket_uri = $this->parseUri($uri); + $this->options = array_merge(self::$default_options, [ + 'logger' => new NullLogger(), + ], $options); + $this->setLogger($this->options['logger']); + } + + /** + * Get string representation of instance. + * @return string String representation. + */ + public function __toString(): string + { + return sprintf( + "%s(%s)", + get_class($this), + $this->getName() ?: 'closed' + ); + } + + + /* ---------- Client option functions -------------------------------------------- */ + + /** + * Set timeout. + * @param int $timeout Timeout in seconds. + */ + public function setTimeout(int $timeout): void + { + $this->options['timeout'] = $timeout; + if (!$this->isConnected()) { + return; + } + $this->connection->setTimeout($timeout); + $this->connection->setOptions($this->options); + } + + /** + * Set fragmentation size. + * @param int $fragment_size Fragment size in bytes. + * @return self. + */ + public function setFragmentSize(int $fragment_size): self + { + $this->options['fragment_size'] = $fragment_size; + $this->connection->setOptions($this->options); + return $this; + } + + /** + * Get fragmentation size. + * @return int $fragment_size Fragment size in bytes. + */ + public function getFragmentSize(): int + { + return $this->options['fragment_size']; + } + + + /* ---------- Connection operations ---------------------------------------------- */ + + /** + * Send text message. + * @param string $payload Content as string. + */ + public function text(string $payload): void + { + $this->send($payload); + } + + /** + * Send binary message. + * @param string $payload Content as binary string. + */ + public function binary(string $payload): void + { + $this->send($payload, 'binary'); + } + + /** + * Send ping. + * @param string $payload Optional text as string. + */ + public function ping(string $payload = ''): void + { + $this->send($payload, 'ping'); + } + + /** + * Send unsolicited pong. + * @param string $payload Optional text as string. + */ + public function pong(string $payload = ''): void + { + $this->send($payload, 'pong'); + } + + /** + * Send message. + * @param string $payload Message to send. + * @param string $opcode Opcode to use, default: 'text'. + * @param bool $masked If message should be masked default: true. + */ + public function send(string $payload, string $opcode = 'text', bool $masked = true): void + { + if (!$this->isConnected()) { + $this->connect(); + } + + if (!in_array($opcode, array_keys(self::$opcodes))) { + $warning = "Bad opcode '{$opcode}'. Try 'text' or 'binary'."; + $this->logger->warning($warning); + throw new BadOpcodeException($warning); + } + + $factory = new Factory(); + $message = $factory->create($opcode, $payload); + $this->connection->pushMessage($message, $masked); + } + + /** + * 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. + */ + public function close(int $status = 1000, string $message = 'ttfn'): void + { + if (!$this->isConnected()) { + return; + } + $this->connection->close($status, $message); + } + + /** + * Disconnect from server. + */ + public function disconnect(): void + { + if ($this->isConnected()) { + $this->connection->disconnect(); + } + } + + /** + * Receive message. + * Note that this operation will block reading. + * @return mixed Message, text or null depending on settings. + */ + public function receive() + { + $filter = $this->options['filter']; + $return_obj = $this->options['return_obj']; + + if (!$this->isConnected()) { + $this->connect(); + } + + while (true) { + $message = $this->connection->pullMessage(); + $opcode = $message->getOpcode(); + if (in_array($opcode, $filter)) { + $this->last_opcode = $opcode; + $return = $return_obj ? $message : $message->getContent(); + break; + } elseif ($opcode == 'close') { + $this->last_opcode = null; + $return = $return_obj ? $message : null; + break; + } + } + return $return; + } + + + /* ---------- Connection functions ----------------------------------------------- */ + + /** + * Get last received opcode. + * @return string|null Opcode. + */ + public function getLastOpcode(): ?string + { + return $this->last_opcode; + } + + /** + * Get close status on connection. + * @return int|null Close status. + */ + public function getCloseStatus(): ?int + { + return $this->connection ? $this->connection->getCloseStatus() : null; + } + + /** + * If Client has active connection. + * @return bool True if active connection. + */ + public function isConnected(): bool + { + return $this->connection && $this->connection->isConnected(); + } + + /** + * Get name of local socket, or null if not connected. + * @return string|null + */ + public function getName(): ?string + { + return $this->isConnected() ? $this->connection->getName() : null; + } + + /** + * Get name of remote socket, or null if not connected. + * @return string|null + */ + public function getRemoteName(): ?string + { + return $this->isConnected() ? $this->connection->getRemoteName() : null; + } + + /** + * Get name of remote socket, or null if not connected. + * @return string|null + * @deprecated Will be removed in future version, use getPeer() instead. + */ + public function getPier(): ?string + { + trigger_error( + 'getPier() is deprecated and will be removed in future version. Use getRemoteName() instead.', + E_USER_DEPRECATED + ); + return $this->getRemoteName(); + } + + + /* ---------- Helper functions --------------------------------------------------- */ + + /** + * Perform WebSocket handshake + */ + protected function connect(): void + { + $this->connection = null; + + $host_uri = $this->socket_uri + ->withScheme($this->socket_uri->getScheme() == 'wss' ? 'ssl' : 'tcp') + ->withPort($this->socket_uri->getPort() ?? ($this->socket_uri->getScheme() == 'wss' ? 443 : 80)) + ->withPath('') + ->withQuery('') + ->withFragment('') + ->withUserInfo(''); + + // Path must be absolute + $http_path = $this->socket_uri->getPath(); + if ($http_path === '' || $http_path[0] !== '/') { + $http_path = "/{$http_path}"; + } + + $http_uri = (new Uri()) + ->withPath($http_path) + ->withQuery($this->socket_uri->getQuery()); + + // Set the stream context options if they're already set in the config + if (isset($this->options['context'])) { + // Suppress the error since we'll catch it below + if (@get_resource_type($this->options['context']) === 'stream-context') { + $context = $this->options['context']; + } else { + $error = "Stream context in \$options['context'] isn't a valid context."; + $this->logger->error($error); + throw new \InvalidArgumentException($error); + } + } else { + $context = stream_context_create(); + } + + $persistent = $this->options['persistent'] === true; + $flags = STREAM_CLIENT_CONNECT; + $flags = $persistent ? $flags | STREAM_CLIENT_PERSISTENT : $flags; + $socket = null; + + try { + $handler = new ErrorHandler(); + $socket = $handler->with(function () use ($host_uri, $flags, $context) { + $error = $errno = $errstr = null; + // Open the socket. + return stream_socket_client( + $host_uri, + $errno, + $errstr, + $this->options['timeout'], + $flags, + $context + ); + }); + if (!$socket) { + throw new ErrorException('No socket'); + } + } catch (ErrorException $e) { + $error = "Could not open socket to \"{$host_uri->getAuthority()}\": {$e->getMessage()} ({$e->getCode()})."; + $this->logger->error($error, ['severity' => $e->getSeverity()]); + throw new ConnectionException($error, 0, [], $e); + } + + $this->connection = new Connection($socket, $this->options); + $this->connection->setLogger($this->logger); + if (!$this->isConnected()) { + $error = "Invalid stream on \"{$host_uri->getAuthority()}\"."; + $this->logger->error($error); + throw new ConnectionException($error); + } + + if (!$persistent || $this->connection->tell() == 0) { + // Set timeout on the stream as well. + $this->connection->setTimeout($this->options['timeout']); + + // Generate the WebSocket key. + $key = self::generateKey(); + + // Default headers + $headers = [ + 'Host' => $host_uri->getAuthority(), + 'User-Agent' => 'websocket-client-php', + 'Connection' => 'Upgrade', + 'Upgrade' => 'websocket', + 'Sec-WebSocket-Key' => $key, + 'Sec-WebSocket-Version' => '13', + ]; + + // Handle basic authentication. + if ($userinfo = $this->socket_uri->getUserInfo()) { + $headers['authorization'] = 'Basic ' . base64_encode($userinfo); + } + + // Deprecated way of adding origin (use headers instead). + if (isset($this->options['origin'])) { + $headers['origin'] = $this->options['origin']; + } + + // Add and override with headers from options. + if (isset($this->options['headers'])) { + $headers = array_merge($headers, $this->options['headers']); + } + + $header = "GET {$http_uri} HTTP/1.1\r\n" . implode( + "\r\n", + array_map( + function ($key, $value) { + return "$key: $value"; + }, + array_keys($headers), + $headers + ) + ) . "\r\n\r\n"; + + // Send headers. + $this->connection->write($header); + + // Get server response header (terminated with double CR+LF). + $response = ''; + try { + do { + $buffer = $this->connection->gets(1024); + $response .= $buffer; + } while (substr_count($response, "\r\n\r\n") == 0); + } catch (Exception $e) { + throw new ConnectionException('Client handshake error', $e->getCode(), $e->getData(), $e); + } + + // Validate response. + if (!preg_match('#Sec-WebSocket-Accept:\s(.*)$#mUi', $response, $matches)) { + $error = sprintf( + "Connection to '%s' failed: Server sent invalid upgrade response: %s", + (string)$this->socket_uri, + (string)$response + ); + $this->logger->error($error); + throw new ConnectionException($error); + } + + $keyAccept = trim($matches[1]); + $expectedResonse = base64_encode( + pack('H*', sha1($key . '258EAFA5-E914-47DA-95CA-C5AB0DC85B11')) + ); + + if ($keyAccept !== $expectedResonse) { + $error = 'Server sent bad upgrade response.'; + $this->logger->error($error); + throw new ConnectionException($error); + } + } + + $this->logger->info("Client connected to {$this->socket_uri}"); + } + + /** + * Generate a random string for WebSocket key. + * @return string Random string + */ + protected static function generateKey(): string + { + $key = ''; + for ($i = 0; $i < 16; $i++) { + $key .= chr(rand(33, 126)); + } + return base64_encode($key); + } + + protected function parseUri($uri): UriInterface + { + if ($uri instanceof UriInterface) { + $uri = $uri; + } elseif (is_string($uri)) { + try { + $uri = new Uri($uri); + } catch (InvalidArgumentException $e) { + throw new BadUriException("Invalid URI '{$uri}' provided.", 0, $e); + } + } else { + throw new BadUriException("Provided URI must be a UriInterface or string."); + } + if (!in_array($uri->getScheme(), ['ws', 'wss'])) { + throw new BadUriException("Invalid URI scheme, must be 'ws' or 'wss'."); + } + return $uri; + } +} diff --git a/vendor/textalk/websocket/lib/Connection.php b/vendor/textalk/websocket/lib/Connection.php new file mode 100644 index 000000000..d5aa48b34 --- /dev/null +++ b/vendor/textalk/websocket/lib/Connection.php @@ -0,0 +1,518 @@ +stream = $stream; + $this->setOptions($options); + $this->setLogger(new NullLogger()); + $this->msg_factory = new Factory(); + } + + public function __destruct() + { + if ($this->getType() === 'stream') { + fclose($this->stream); + } + } + + public function setOptions(array $options = []): void + { + $this->options = array_merge($this->options, $options); + } + + public function getCloseStatus(): ?int + { + return $this->close_status; + } + + /** + * 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. + */ + public function close(int $status = 1000, string $message = 'ttfn'): void + { + if (!$this->isConnected()) { + return; + } + $status_binstr = sprintf('%016b', $status); + $status_str = ''; + foreach (str_split($status_binstr, 8) as $binstr) { + $status_str .= chr(bindec($binstr)); + } + $message = $this->msg_factory->create('close', $status_str . $message); + $this->pushMessage($message, true); + + $this->logger->debug("Closing with status: {$status}."); + + $this->is_closing = true; + while (true) { + $message = $this->pullMessage(); + if ($message->getOpcode() == 'close') { + break; + } + } + } + + + /* ---------- Message methods ---------------------------------------------------- */ + + // Push a message to stream + public function pushMessage(Message $message, bool $masked = true): void + { + $frames = $message->getFrames($masked, $this->options['fragment_size']); + foreach ($frames as $frame) { + $this->pushFrame($frame); + } + $this->logger->info("[connection] Pushed {$message}", [ + 'opcode' => $message->getOpcode(), + 'content-length' => $message->getLength(), + 'frames' => count($frames), + ]); + } + + // Pull a message from stream + public function pullMessage(): Message + { + do { + $frame = $this->pullFrame(); + $frame = $this->autoRespond($frame); + list ($final, $payload, $opcode, $masked) = $frame; + + if ($opcode == 'close') { + $this->close(); + } + + // Continuation and factual opcode + $continuation = $opcode == 'continuation'; + $payload_opcode = $continuation ? $this->read_buffer['opcode'] : $opcode; + + // First continuation frame, create buffer + if (!$final && !$continuation) { + $this->read_buffer = ['opcode' => $opcode, 'payload' => $payload, 'frames' => 1]; + continue; // Continue reading + } + + // Subsequent continuation frames, add to buffer + if ($continuation) { + $this->read_buffer['payload'] .= $payload; + $this->read_buffer['frames']++; + } + } while (!$final); + + // Final, return payload + $frames = 1; + if ($continuation) { + $payload = $this->read_buffer['payload']; + $frames = $this->read_buffer['frames']; + $this->read_buffer = null; + } + + $message = $this->msg_factory->create($payload_opcode, $payload); + + $this->logger->info("[connection] Pulled {$message}", [ + 'opcode' => $payload_opcode, + 'content-length' => strlen($payload), + 'frames' => $frames, + ]); + + return $message; + } + + + /* ---------- Frame I/O methods -------------------------------------------------- */ + + // Pull frame from stream + private function pullFrame(): array + { + // Read the fragment "header" first, two bytes. + $data = $this->read(2); + list ($byte_1, $byte_2) = array_values(unpack('C*', $data)); + $final = (bool)($byte_1 & 0b10000000); // Final fragment marker. + $rsv = $byte_1 & 0b01110000; // Unused bits, ignore + + // Parse opcode + $opcode_int = $byte_1 & 0b00001111; + $opcode_ints = array_flip(self::$opcodes); + if (!array_key_exists($opcode_int, $opcode_ints)) { + $warning = "Bad opcode in websocket frame: {$opcode_int}"; + $this->logger->warning($warning); + throw new ConnectionException($warning, ConnectionException::BAD_OPCODE); + } + $opcode = $opcode_ints[$opcode_int]; + + // Masking bit + $masked = (bool)($byte_2 & 0b10000000); + + $payload = ''; + + // Payload length + $payload_length = $byte_2 & 0b01111111; + + if ($payload_length > 125) { + if ($payload_length === 126) { + $data = $this->read(2); // 126: Payload is a 16-bit unsigned int + $payload_length = current(unpack('n', $data)); + } else { + $data = $this->read(8); // 127: Payload is a 64-bit unsigned int + $payload_length = current(unpack('J', $data)); + } + } + + // Get masking key. + if ($masked) { + $masking_key = $this->read(4); + } + + // Get the actual payload, if any (might not be for e.g. close frames. + if ($payload_length > 0) { + $data = $this->read($payload_length); + + if ($masked) { + // Unmask payload. + for ($i = 0; $i < $payload_length; $i++) { + $payload .= ($data[$i] ^ $masking_key[$i % 4]); + } + } else { + $payload = $data; + } + } + + $this->logger->debug("[connection] Pulled '{opcode}' frame", [ + 'opcode' => $opcode, + 'final' => $final, + 'content-length' => strlen($payload), + ]); + return [$final, $payload, $opcode, $masked]; + } + + // Push frame to stream + private function pushFrame(array $frame): void + { + list ($final, $payload, $opcode, $masked) = $frame; + $data = ''; + $byte_1 = $final ? 0b10000000 : 0b00000000; // Final fragment marker. + $byte_1 |= self::$opcodes[$opcode]; // Set opcode. + $data .= pack('C', $byte_1); + + $byte_2 = $masked ? 0b10000000 : 0b00000000; // Masking bit marker. + + // 7 bits of payload length... + $payload_length = strlen($payload); + if ($payload_length > 65535) { + $data .= pack('C', $byte_2 | 0b01111111); + $data .= pack('J', $payload_length); + } elseif ($payload_length > 125) { + $data .= pack('C', $byte_2 | 0b01111110); + $data .= pack('n', $payload_length); + } else { + $data .= pack('C', $byte_2 | $payload_length); + } + + // Handle masking + if ($masked) { + // generate a random mask: + $mask = ''; + for ($i = 0; $i < 4; $i++) { + $mask .= chr(rand(0, 255)); + } + $data .= $mask; + + // Append payload to frame: + for ($i = 0; $i < $payload_length; $i++) { + $data .= $payload[$i] ^ $mask[$i % 4]; + } + } else { + $data .= $payload; + } + + $this->write($data); + + $this->logger->debug("[connection] Pushed '{$opcode}' frame", [ + 'opcode' => $opcode, + 'final' => $final, + 'content-length' => strlen($payload), + ]); + } + + // Trigger auto response for frame + private function autoRespond(array $frame) + { + list ($final, $payload, $opcode, $masked) = $frame; + $payload_length = strlen($payload); + + switch ($opcode) { + case 'ping': + // If we received a ping, respond with a pong + $this->logger->debug("[connection] Received 'ping', sending 'pong'."); + $message = $this->msg_factory->create('pong', $payload); + $this->pushMessage($message, $masked); + return [$final, $payload, $opcode, $masked]; + case 'close': + // If we received close, possibly acknowledge and close connection + $status_bin = ''; + $status = ''; + if ($payload_length > 0) { + $status_bin = $payload[0] . $payload[1]; + $status = current(unpack('n', $payload)); + $this->close_status = $status; + } + // Get additional close message + if ($payload_length >= 2) { + $payload = substr($payload, 2); + } + + $this->logger->debug("[connection] Received 'close', status: {$status}."); + if (!$this->is_closing) { + $ack = "{$status_bin}Close acknowledged: {$status}"; + $message = $this->msg_factory->create('close', $ack); + $this->pushMessage($message, $masked); + } else { + $this->is_closing = false; // A close response, all done. + } + $this->disconnect(); + return [$final, $payload, $opcode, $masked]; + default: + return [$final, $payload, $opcode, $masked]; + } + } + + + /* ---------- Stream I/O methods ------------------------------------------------- */ + + /** + * Close connection stream. + * @return bool + */ + public function disconnect(): bool + { + $this->logger->debug('Closing connection'); + return fclose($this->stream); + } + + /** + * If connected to stream. + * @return bool + */ + public function isConnected(): bool + { + return in_array($this->getType(), ['stream', 'persistent stream']); + } + + /** + * Return type of connection. + * @return string|null Type of connection or null if invalid type. + */ + public function getType(): ?string + { + return get_resource_type($this->stream); + } + + /** + * Get name of local socket, or null if not connected. + * @return string|null + */ + public function getName(): ?string + { + return stream_socket_get_name($this->stream, false); + } + + /** + * Get name of remote socket, or null if not connected. + * @return string|null + */ + public function getRemoteName(): ?string + { + return stream_socket_get_name($this->stream, true); + } + + /** + * Get meta data for connection. + * @return array + */ + public function getMeta(): array + { + return stream_get_meta_data($this->stream); + } + + /** + * Returns current position of stream pointer. + * @return int + * @throws ConnectionException + */ + public function tell(): int + { + $tell = ftell($this->stream); + if ($tell === false) { + $this->throwException('Could not resolve stream pointer position'); + } + return $tell; + } + + /** + * If stream pointer is at end of file. + * @return bool + */ + public function eof(): int + { + return feof($this->stream); + } + + + /* ---------- Stream option methods ---------------------------------------------- */ + + /** + * Set time out on connection. + * @param int $seconds Timeout part in seconds + * @param int $microseconds Timeout part in microseconds + * @return bool + */ + public function setTimeout(int $seconds, int $microseconds = 0): bool + { + $this->logger->debug("Setting timeout {$seconds}:{$microseconds} seconds"); + return stream_set_timeout($this->stream, $seconds, $microseconds); + } + + + /* ---------- Stream read/write methods ------------------------------------------ */ + + /** + * Read line from stream. + * @param int $length Maximum number of bytes to read + * @param string $ending Line delimiter + * @return string Read data + */ + public function getLine(int $length, string $ending): string + { + $line = stream_get_line($this->stream, $length, $ending); + if ($line === false) { + $this->throwException('Could not read from stream'); + } + $read = strlen($line); + $this->logger->debug("Read {$read} bytes of line."); + return $line; + } + + /** + * Read line from stream. + * @param int $length Maximum number of bytes to read + * @return string Read data + */ + public function gets(int $length): string + { + $line = fgets($this->stream, $length); + if ($line === false) { + $this->throwException('Could not read from stream'); + } + $read = strlen($line); + $this->logger->debug("Read {$read} bytes of line."); + return $line; + } + + /** + * Read characters from stream. + * @param int $length Maximum number of bytes to read + * @return string Read data + */ + public function read(string $length): string + { + $data = ''; + while (strlen($data) < $length) { + $buffer = fread($this->stream, $length - strlen($data)); + if (!$buffer) { + $meta = stream_get_meta_data($this->stream); + if (!empty($meta['timed_out'])) { + $message = 'Client read timeout'; + $this->logger->error($message, $meta); + throw new TimeoutException($message, ConnectionException::TIMED_OUT, $meta); + } + } + if ($buffer === false) { + $read = strlen($data); + $this->throwException("Broken frame, read {$read} of stated {$length} bytes."); + } + if ($buffer === '') { + $this->throwException("Empty read; connection dead?"); + } + $data .= $buffer; + $read = strlen($data); + $this->logger->debug("Read {$read} of {$length} bytes."); + } + return $data; + } + + /** + * Write characters to stream. + * @param string $data Data to read + */ + public function write(string $data): void + { + $length = strlen($data); + $written = fwrite($this->stream, $data); + if ($written === false) { + $this->throwException("Failed to write {$length} bytes."); + } + if ($written < strlen($data)) { + $this->throwException("Could only write {$written} out of {$length} bytes."); + } + $this->logger->debug("Wrote {$written} of {$length} bytes."); + } + + + /* ---------- Internal helper methods -------------------------------------------- */ + + private function throwException(string $message, int $code = 0): void + { + $meta = ['closed' => true]; + if ($this->isConnected()) { + $meta = $this->getMeta(); + $this->disconnect(); + if (!empty($meta['timed_out'])) { + $this->logger->error($message, $meta); + throw new TimeoutException($message, ConnectionException::TIMED_OUT, $meta); + } + if (!empty($meta['eof'])) { + $code = ConnectionException::EOF; + } + } + $this->logger->error($message, $meta); + throw new ConnectionException($message, $code, $meta); + } +} diff --git a/vendor/textalk/websocket/lib/ConnectionException.php b/vendor/textalk/websocket/lib/ConnectionException.php new file mode 100644 index 000000000..aa1d7f4f7 --- /dev/null +++ b/vendor/textalk/websocket/lib/ConnectionException.php @@ -0,0 +1,33 @@ +data = $data; + } + + public function getData(): array + { + return $this->data; + } +} diff --git a/vendor/textalk/websocket/lib/Exception.php b/vendor/textalk/websocket/lib/Exception.php new file mode 100644 index 000000000..6482b7eae --- /dev/null +++ b/vendor/textalk/websocket/lib/Exception.php @@ -0,0 +1,7 @@ +payload = $payload; + $this->timestamp = new DateTime(); + } + + public function getOpcode(): string + { + return $this->opcode; + } + + public function getLength(): int + { + return strlen($this->payload); + } + + public function getTimestamp(): DateTime + { + return $this->timestamp; + } + + public function getContent(): string + { + return $this->payload; + } + + public function setContent(string $payload = ''): void + { + $this->payload = $payload; + } + + public function hasContent(): bool + { + return $this->payload != ''; + } + + public function __toString(): string + { + return get_class($this); + } + + // Split messages into frames + public function getFrames(bool $masked = true, int $framesize = 4096): array + { + + $frames = []; + $split = str_split($this->getContent(), $framesize) ?: ['']; + foreach ($split as $payload) { + $frames[] = [false, $payload, 'continuation', $masked]; + } + $frames[0][2] = $this->opcode; + $frames[array_key_last($frames)][0] = true; + return $frames; + } +} diff --git a/vendor/textalk/websocket/lib/Message/Ping.php b/vendor/textalk/websocket/lib/Message/Ping.php new file mode 100644 index 000000000..f9bb65237 --- /dev/null +++ b/vendor/textalk/websocket/lib/Message/Ping.php @@ -0,0 +1,15 @@ + 0, + 'text' => 1, + 'binary' => 2, + 'close' => 8, + 'ping' => 9, + 'pong' => 10, + ]; +} diff --git a/vendor/textalk/websocket/lib/Server.php b/vendor/textalk/websocket/lib/Server.php new file mode 100644 index 000000000..15215884a --- /dev/null +++ b/vendor/textalk/websocket/lib/Server.php @@ -0,0 +1,470 @@ + ['text', 'binary'], + 'fragment_size' => 4096, + 'logger' => null, + 'port' => 8000, + 'return_obj' => false, + 'timeout' => null, + ]; + + protected $port; + protected $listening; + protected $request; + protected $request_path; + private $connections = []; + private $options = []; + private $listen = false; + private $last_opcode; + + + /* ---------- Magic methods ------------------------------------------------------ */ + + /** + * @param array $options + * Associative array containing: + * - filter: Array of opcodes to handle. Default: ['text', 'binary']. + * - fragment_size: Set framgemnt size. Default: 4096 + * - logger: PSR-3 compatible logger. Default NullLogger. + * - port: Chose port for listening. Default 8000. + * - return_obj: If receive() function return Message instance. Default false. + * - timeout: Set the socket timeout in seconds. + */ + public function __construct(array $options = []) + { + $this->options = array_merge(self::$default_options, [ + 'logger' => new NullLogger(), + ], $options); + $this->port = $this->options['port']; + $this->setLogger($this->options['logger']); + + $error = $errno = $errstr = null; + set_error_handler(function (int $severity, string $message, string $file, int $line) use (&$error) { + $this->logger->warning($message, ['severity' => $severity]); + $error = $message; + }, E_ALL); + + do { + $this->listening = stream_socket_server("tcp://0.0.0.0:$this->port", $errno, $errstr); + } while ($this->listening === false && $this->port++ < 10000); + + restore_error_handler(); + + if (!$this->listening) { + $error = "Could not open listening socket: {$errstr} ({$errno}) {$error}"; + $this->logger->error($error); + throw new ConnectionException($error, (int)$errno); + } + + $this->logger->info("Server listening to port {$this->port}"); + } + + /** + * Get string representation of instance. + * @return string String representation. + */ + public function __toString(): string + { + return sprintf( + "%s(%s)", + get_class($this), + $this->getName() ?: 'closed' + ); + } + + + /* ---------- Server operations -------------------------------------------------- */ + + /** + * Accept a single incoming request. + * Note that this operation will block accepting additional requests. + * @return bool True if listening. + */ + public function accept(): bool + { + $this->disconnect(); + return (bool)$this->listening; + } + + + /* ---------- Server option functions -------------------------------------------- */ + + /** + * Get current port. + * @return int port. + */ + public function getPort(): int + { + return $this->port; + } + + /** + * Set timeout. + * @param int $timeout Timeout in seconds. + */ + public function setTimeout(int $timeout): void + { + $this->options['timeout'] = $timeout; + if (!$this->isConnected()) { + return; + } + foreach ($this->connections as $connection) { + $connection->setTimeout($timeout); + $connection->setOptions($this->options); + } + } + + /** + * Set fragmentation size. + * @param int $fragment_size Fragment size in bytes. + * @return self. + */ + public function setFragmentSize(int $fragment_size): self + { + $this->options['fragment_size'] = $fragment_size; + foreach ($this->connections as $connection) { + $connection->setOptions($this->options); + } + return $this; + } + + /** + * Get fragmentation size. + * @return int $fragment_size Fragment size in bytes. + */ + public function getFragmentSize(): int + { + return $this->options['fragment_size']; + } + + + /* ---------- Connection broadcast operations ------------------------------------ */ + + /** + * Broadcast text message to all conenctions. + * @param string $payload Content as string. + */ + public function text(string $payload): void + { + $this->send($payload); + } + + /** + * Broadcast binary message to all conenctions. + * @param string $payload Content as binary string. + */ + public function binary(string $payload): void + { + $this->send($payload, 'binary'); + } + + /** + * Broadcast ping message to all conenctions. + * @param string $payload Optional text as string. + */ + public function ping(string $payload = ''): void + { + $this->send($payload, 'ping'); + } + + /** + * Broadcast pong message to all conenctions. + * @param string $payload Optional text as string. + */ + public function pong(string $payload = ''): void + { + $this->send($payload, 'pong'); + } + + /** + * Send message on all connections. + * @param string $payload Message to send. + * @param string $opcode Opcode to use, default: 'text'. + * @param bool $masked If message should be masked default: true. + */ + public function send(string $payload, string $opcode = 'text', bool $masked = true): void + { + if (!$this->isConnected()) { + $this->connect(); + } + if (!in_array($opcode, array_keys(self::$opcodes))) { + $warning = "Bad opcode '{$opcode}'. Try 'text' or 'binary'."; + $this->logger->warning($warning); + throw new BadOpcodeException($warning); + } + + $factory = new Factory(); + $message = $factory->create($opcode, $payload); + + foreach ($this->connections as $connection) { + $connection->pushMessage($message, $masked); + } + } + + /** + * Close all connections. + * @param int $status Close status, default: 1000. + * @param string $message Close message, default: 'ttfn'. + */ + public function close(int $status = 1000, string $message = 'ttfn'): void + { + foreach ($this->connections as $connection) { + if ($connection->isConnected()) { + $connection->close($status, $message); + } + } + } + + /** + * Disconnect all connections. + */ + public function disconnect(): void + { + foreach ($this->connections as $connection) { + if ($connection->isConnected()) { + $connection->disconnect(); + } + } + $this->connections = []; + } + + /** + * Receive message from single connection. + * Note that this operation will block reading and only read from first available connection. + * @return mixed Message, text or null depending on settings. + */ + public function receive() + { + $filter = $this->options['filter']; + $return_obj = $this->options['return_obj']; + + if (!$this->isConnected()) { + $this->connect(); + } + $connection = current($this->connections); + + while (true) { + $message = $connection->pullMessage(); + $opcode = $message->getOpcode(); + if (in_array($opcode, $filter)) { + $this->last_opcode = $opcode; + $return = $return_obj ? $message : $message->getContent(); + break; + } elseif ($opcode == 'close') { + $this->last_opcode = null; + $return = $return_obj ? $message : null; + break; + } + } + return $return; + } + + + /* ---------- Connection functions ----------------------------------------------- */ + + /** + * Get requested path from last connection. + * @return string Path. + */ + public function getPath(): string + { + return $this->request_path; + } + + /** + * Get request from last connection. + * @return array Request. + */ + public function getRequest(): array + { + return $this->request; + } + + /** + * Get headers from last connection. + * @return string|null Headers. + */ + public function getHeader($header): ?string + { + foreach ($this->request as $row) { + if (stripos($row, $header) !== false) { + list($headername, $headervalue) = explode(":", $row); + return trim($headervalue); + } + } + return null; + } + + /** + * Get last received opcode. + * @return string|null Opcode. + */ + public function getLastOpcode(): ?string + { + return $this->last_opcode; + } + + /** + * Get close status from single connection. + * @return int|null Close status. + */ + public function getCloseStatus(): ?int + { + return $this->connections ? current($this->connections)->getCloseStatus() : null; + } + + /** + * If Server has active connections. + * @return bool True if active connection. + */ + public function isConnected(): bool + { + foreach ($this->connections as $connection) { + if ($connection->isConnected()) { + return true; + } + } + return false; + } + + /** + * Get name of local socket from single connection. + * @return string|null Name of local socket. + */ + public function getName(): ?string + { + return $this->isConnected() ? current($this->connections)->getName() : null; + } + + /** + * Get name of remote socket from single connection. + * @return string|null Name of remote socket. + */ + public function getRemoteName(): ?string + { + return $this->isConnected() ? current($this->connections)->getRemoteName() : null; + } + + /** + * @deprecated Will be removed in future version. + */ + public function getPier(): ?string + { + trigger_error( + 'getPier() is deprecated and will be removed in future version. Use getRemoteName() instead.', + E_USER_DEPRECATED + ); + return $this->getRemoteName(); + } + + + /* ---------- Helper functions --------------------------------------------------- */ + + // Connect when read/write operation is performed. + private function connect(): void + { + try { + $handler = new ErrorHandler(); + $socket = $handler->with(function () { + if (isset($this->options['timeout'])) { + $socket = stream_socket_accept($this->listening, $this->options['timeout']); + } else { + $socket = stream_socket_accept($this->listening); + } + if (!$socket) { + throw new ErrorException('No socket'); + } + return $socket; + }); + } catch (ErrorException $e) { + $error = "Server failed to connect. {$e->getMessage()}"; + $this->logger->error($error, ['severity' => $e->getSeverity()]); + throw new ConnectionException($error, 0, [], $e); + } + + $connection = new Connection($socket, $this->options); + $connection->setLogger($this->logger); + + if (isset($this->options['timeout'])) { + $connection->setTimeout($this->options['timeout']); + } + + $this->logger->info("Client has connected to port {port}", [ + 'port' => $this->port, + 'peer' => $connection->getRemoteName(), + ]); + $this->performHandshake($connection); + $this->connections = ['*' => $connection]; + } + + // Perform upgrade handshake on new connections. + private function performHandshake(Connection $connection): void + { + $request = ''; + do { + $buffer = $connection->getLine(1024, "\r\n"); + $request .= $buffer . "\n"; + $metadata = $connection->getMeta(); + } while (!$connection->eof() && $metadata['unread_bytes'] > 0); + + if (!preg_match('/GET (.*) HTTP\//mUi', $request, $matches)) { + $error = "No GET in request: {$request}"; + $this->logger->error($error); + throw new ConnectionException($error); + } + $get_uri = trim($matches[1]); + $uri_parts = parse_url($get_uri); + + $this->request = explode("\n", $request); + $this->request_path = $uri_parts['path']; + /// @todo Get query and fragment as well. + + if (!preg_match('#Sec-WebSocket-Key:\s(.*)$#mUi', $request, $matches)) { + $error = "Client had no Key in upgrade request: {$request}"; + $this->logger->error($error); + throw new ConnectionException($error); + } + + $key = trim($matches[1]); + + /// @todo Validate key length and base 64... + $response_key = base64_encode(pack('H*', sha1($key . '258EAFA5-E914-47DA-95CA-C5AB0DC85B11'))); + + $header = "HTTP/1.1 101 Switching Protocols\r\n" + . "Upgrade: websocket\r\n" + . "Connection: Upgrade\r\n" + . "Sec-WebSocket-Accept: $response_key\r\n" + . "\r\n"; + + $connection->write($header); + $this->logger->debug("Handshake on {$get_uri}"); + } +} diff --git a/vendor/textalk/websocket/lib/TimeoutException.php b/vendor/textalk/websocket/lib/TimeoutException.php new file mode 100644 index 000000000..727655682 --- /dev/null +++ b/vendor/textalk/websocket/lib/TimeoutException.php @@ -0,0 +1,14 @@ + + + + + lib/ + + + + + tests + + + diff --git a/vendor/textalk/websocket/tests/ClientTest.php b/vendor/textalk/websocket/tests/ClientTest.php new file mode 100644 index 000000000..df23d7557 --- /dev/null +++ b/vendor/textalk/websocket/tests/ClientTest.php @@ -0,0 +1,568 @@ +send('Connect'); + $this->assertTrue(MockSocket::isEmpty()); + $this->assertEquals(4096, $client->getFragmentSize()); + + MockSocket::initialize('send-receive', $this); + $client->send('Sending a message'); + $message = $client->receive(); + $this->assertTrue(MockSocket::isEmpty()); + $this->assertEquals('text', $client->getLastOpcode()); + + MockSocket::initialize('client.close', $this); + $this->assertTrue($client->isConnected()); + $this->assertNull($client->getCloseStatus()); + + $client->close(); + $this->assertFalse($client->isConnected()); + $this->assertEquals(1000, $client->getCloseStatus()); + + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testDestruct(): void + { + MockSocket::initialize('client.connect', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $client->send('Connect'); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('client.destruct', $this); + } + + public function testClienExtendedUrl(): void + { + MockSocket::initialize('client.connect-extended', $this); + $client = new Client('ws://localhost:8000/my/mock/path?my_query=yes#my_fragment'); + $client->send('Connect'); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testClientNoPath(): void + { + MockSocket::initialize('client.connect-root', $this); + $client = new Client('ws://localhost:8000'); + $client->send('Connect'); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testClientRelativePath(): void + { + MockSocket::initialize('client.connect', $this); + $uri = new Uri('ws://localhost:8000'); + $uri = $uri->withPath('my/mock/path'); + $client = new Client($uri); + $client->send('Connect'); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testClientWsDefaultPort(): void + { + MockSocket::initialize('client.connect-default-port-ws', $this); + $uri = new Uri('ws://localhost'); + $uri = $uri->withPath('my/mock/path'); + $client = new Client($uri); + $client->send('Connect'); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testClientWssDefaultPort(): void + { + MockSocket::initialize('client.connect-default-port-wss', $this); + $uri = new Uri('wss://localhost'); + $uri = $uri->withPath('my/mock/path'); + $client = new Client($uri); + $client->send('Connect'); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testClientWithTimeout(): void + { + MockSocket::initialize('client.connect-timeout', $this); + $client = new Client('ws://localhost:8000/my/mock/path', ['timeout' => 300]); + $client->send('Connect'); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testClientWithContext(): void + { + MockSocket::initialize('client.connect-context', $this); + $client = new Client('ws://localhost:8000/my/mock/path', ['context' => '@mock-stream-context']); + $client->send('Connect'); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testClientAuthed(): void + { + MockSocket::initialize('client.connect-authed', $this); + $client = new Client('wss://usename:password@localhost:8000/my/mock/path'); + $client->send('Connect'); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testWithHeaders(): void + { + MockSocket::initialize('client.connect-headers', $this); + $client = new Client('ws://localhost:8000/my/mock/path', [ + 'origin' => 'Origin header', + 'headers' => ['Generic header' => 'Generic content'], + ]); + $client->send('Connect'); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testPayload128(): void + { + MockSocket::initialize('client.connect', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $client->send('Connect'); + $this->assertTrue(MockSocket::isEmpty()); + + $payload = file_get_contents(__DIR__ . '/mock/payload.128.txt'); + + MockSocket::initialize('send-receive-128', $this); + $client->send($payload, 'text', false); + $message = $client->receive(); + $this->assertEquals($payload, $message); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testPayload65536(): void + { + MockSocket::initialize('client.connect', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $client->send('Connect'); + $this->assertTrue(MockSocket::isEmpty()); + + $payload = file_get_contents(__DIR__ . '/mock/payload.65536.txt'); + $client->setFragmentSize(65540); + + MockSocket::initialize('send-receive-65536', $this); + $client->send($payload, 'text', false); + $message = $client->receive(); + $this->assertEquals($payload, $message); + $this->assertTrue(MockSocket::isEmpty()); + $this->assertEquals(65540, $client->getFragmentSize()); + } + + public function testMultiFragment(): void + { + MockSocket::initialize('client.connect', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $client->send('Connect'); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('send-receive-multi-fragment', $this); + $client->setFragmentSize(8); + $client->send('Multi fragment test'); + $message = $client->receive(); + $this->assertEquals('Multi fragment test', $message); + $this->assertTrue(MockSocket::isEmpty()); + $this->assertEquals(8, $client->getFragmentSize()); + } + + public function testPingPong(): void + { + MockSocket::initialize('client.connect', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $client->send('Connect'); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('ping-pong', $this); + $client->send('Server ping', 'ping'); + $client->send('', 'ping'); + $message = $client->receive(); + $this->assertEquals('Receiving a message', $message); + $this->assertEquals('text', $client->getLastOpcode()); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testRemoteClose(): void + { + MockSocket::initialize('client.connect', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $client->send('Connect'); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('close-remote', $this); + + $message = $client->receive(); + $this->assertNull($message); + + $this->assertFalse($client->isConnected()); + $this->assertEquals(17260, $client->getCloseStatus()); + $this->assertNull($client->getLastOpcode()); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testSetTimeout(): void + { + MockSocket::initialize('client.connect', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $client->send('Connect'); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('config-timeout', $this); + $client->setTimeout(300); + $this->assertTrue($client->isConnected()); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testReconnect(): void + { + MockSocket::initialize('client.connect', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $client->send('Connect'); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('client.close', $this); + $this->assertTrue($client->isConnected()); + $this->assertNull($client->getCloseStatus()); + $client->close(); + $this->assertFalse($client->isConnected()); + $this->assertEquals(1000, $client->getCloseStatus()); + $this->assertNull($client->getLastOpcode()); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('client.reconnect', $this); + $message = $client->receive(); + $this->assertTrue($client->isConnected()); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testPersistentConnection(): void + { + MockSocket::initialize('client.connect-persistent', $this); + $client = new Client('ws://localhost:8000/my/mock/path', ['persistent' => true]); + $client->send('Connect'); + $client->disconnect(); + $this->assertFalse($client->isConnected()); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testFailedPersistentConnection(): void + { + MockSocket::initialize('client.connect-persistent-failure', $this); + $client = new Client('ws://localhost:8000/my/mock/path', ['persistent' => true]); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionMessage('Could not resolve stream pointer position'); + $client->send('Connect'); + } + + public function testBadScheme(): void + { + MockSocket::initialize('client.connect', $this); + $this->expectException('WebSocket\BadUriException'); + $this->expectExceptionMessage("Invalid URI scheme, must be 'ws' or 'wss'."); + $client = new Client('bad://localhost:8000/my/mock/path'); + } + + public function testBadUri(): void + { + MockSocket::initialize('client.connect', $this); + $this->expectException('WebSocket\BadUriException'); + $this->expectExceptionMessage("Invalid URI '--:this is not an uri:--' provided."); + $client = new Client('--:this is not an uri:--'); + } + + public function testInvalidUriType(): void + { + MockSocket::initialize('client.connect', $this); + $this->expectException('WebSocket\BadUriException'); + $this->expectExceptionMessage("Provided URI must be a UriInterface or string."); + $client = new Client([]); + } + + public function testUriInterface(): void + { + MockSocket::initialize('client.connect', $this); + $uri = new Uri('ws://localhost:8000/my/mock/path'); + $client = new Client($uri); + $client->send('Connect'); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testBadStreamContext(): void + { + MockSocket::initialize('client.connect-bad-context', $this); + $client = new Client('ws://localhost:8000/my/mock/path', ['context' => 'BAD']); + $this->expectException('InvalidArgumentException'); + $this->expectExceptionMessage('Stream context in $options[\'context\'] isn\'t a valid context'); + $client->send('Connect'); + } + + public function testFailedConnection(): void + { + MockSocket::initialize('client.connect-failed', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(0); + $this->expectExceptionMessage('Could not open socket to "localhost:8000"'); + $client->send('Connect'); + } + + public function testFailedConnectionWithError(): void + { + MockSocket::initialize('client.connect-error', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(0); + $this->expectExceptionMessage('Could not open socket to "localhost:8000"'); + $client->send('Connect'); + } + + public function testBadStreamConnection(): void + { + MockSocket::initialize('client.connect-bad-stream', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(0); + $this->expectExceptionMessage('Invalid stream on "localhost:8000"'); + $client->send('Connect'); + } + + public function testHandshakeFailure(): void + { + MockSocket::initialize('client.connect-handshake-failure', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(0); + $this->expectExceptionMessage('Client handshake error'); + $client->send('Connect'); + } + + public function testInvalidUpgrade(): void + { + MockSocket::initialize('client.connect-invalid-upgrade', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(0); + $this->expectExceptionMessage('Connection to \'ws://localhost:8000/my/mock/path\' failed'); + $client->send('Connect'); + } + + public function testInvalidKey(): void + { + MockSocket::initialize('client.connect-invalid-key', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(0); + $this->expectExceptionMessage('Server sent bad upgrade response'); + $client->send('Connect'); + } + + public function testSendBadOpcode(): void + { + MockSocket::initialize('client.connect', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $client->send('Connect'); + + MockSocket::initialize('send-bad-opcode', $this); + $this->expectException('WebSocket\BadOpcodeException'); + $this->expectExceptionMessage('Bad opcode \'bad\'. Try \'text\' or \'binary\'.'); + $client->send('Bad Opcode', 'bad'); + } + + public function testRecieveBadOpcode(): void + { + MockSocket::initialize('client.connect', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $client->send('Connect'); + MockSocket::initialize('receive-bad-opcode', $this); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(1026); + $this->expectExceptionMessage('Bad opcode in websocket frame: 12'); + $message = $client->receive(); + } + + public function testBrokenWrite(): void + { + MockSocket::initialize('client.connect', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $client->send('Connect'); + MockSocket::initialize('send-broken-write', $this); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(1025); + $this->expectExceptionMessage('Could only write 18 out of 22 bytes.'); + $client->send('Failing to write'); + } + + public function testFailedWrite(): void + { + MockSocket::initialize('client.connect', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $client->send('Connect'); + MockSocket::initialize('send-failed-write', $this); + $this->expectException('WebSocket\TimeoutException'); + $this->expectExceptionCode(1024); + $this->expectExceptionMessage('Failed to write 22 bytes.'); + $client->send('Failing to write'); + } + + public function testBrokenRead(): void + { + MockSocket::initialize('client.connect', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $client->send('Connect'); + MockSocket::initialize('receive-broken-read', $this); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(1025); + $this->expectExceptionMessage('Broken frame, read 0 of stated 2 bytes.'); + $client->receive(); + } + + public function testHandshakeError(): void + { + MockSocket::initialize('client.connect-handshake-error', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(1024); + $this->expectExceptionMessage('Client handshake error'); + $client->send('Connect'); + } + + public function testReadTimeout(): void + { + MockSocket::initialize('client.connect', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $client->send('Connect'); + MockSocket::initialize('receive-client-timeout', $this); + $this->expectException('WebSocket\TimeoutException'); + $this->expectExceptionCode(1024); + $this->expectExceptionMessage('Client read timeout'); + $client->receive(); + } + + public function testEmptyRead(): void + { + MockSocket::initialize('client.connect', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $client->send('Connect'); + MockSocket::initialize('receive-empty-read', $this); + $this->expectException('WebSocket\TimeoutException'); + $this->expectExceptionCode(1024); + $this->expectExceptionMessage('Empty read; connection dead?'); + $client->receive(); + } + + public function testFrameFragmentation(): void + { + MockSocket::initialize('client.connect', $this); + $client = new Client( + 'ws://localhost:8000/my/mock/path', + ['filter' => ['text', 'binary', 'pong', 'close']] + ); + $client->send('Connect'); + MockSocket::initialize('receive-fragmentation', $this); + $message = $client->receive(); + $this->assertEquals('Server ping', $message); + $this->assertEquals('pong', $client->getLastOpcode()); + $message = $client->receive(); + $this->assertEquals('Multi fragment test', $message); + $this->assertEquals('text', $client->getLastOpcode()); + $this->assertTrue(MockSocket::isEmpty()); + MockSocket::initialize('close-remote', $this); + $message = $client->receive(); + $this->assertEquals('Closing', $message); + $this->assertTrue(MockSocket::isEmpty()); + $this->assertFalse($client->isConnected()); + $this->assertEquals(17260, $client->getCloseStatus()); + $this->assertEquals('close', $client->getLastOpcode()); + } + + public function testMessageFragmentation(): void + { + MockSocket::initialize('client.connect', $this); + $client = new Client( + 'ws://localhost:8000/my/mock/path', + ['filter' => ['text', 'binary', 'pong', 'close'], 'return_obj' => true] + ); + $client->send('Connect'); + MockSocket::initialize('receive-fragmentation', $this); + $message = $client->receive(); + $this->assertInstanceOf('WebSocket\Message\Message', $message); + $this->assertInstanceOf('WebSocket\Message\Pong', $message); + $this->assertEquals('Server ping', $message->getContent()); + $this->assertEquals('pong', $message->getOpcode()); + $message = $client->receive(); + $this->assertInstanceOf('WebSocket\Message\Message', $message); + $this->assertInstanceOf('WebSocket\Message\Text', $message); + $this->assertEquals('Multi fragment test', $message->getContent()); + $this->assertEquals('text', $message->getOpcode()); + $this->assertTrue(MockSocket::isEmpty()); + MockSocket::initialize('close-remote', $this); + $message = $client->receive(); + $this->assertInstanceOf('WebSocket\Message\Message', $message); + $this->assertInstanceOf('WebSocket\Message\Close', $message); + $this->assertEquals('Closing', $message->getContent()); + $this->assertEquals('close', $message->getOpcode()); + } + + public function testConvenicanceMethods(): void + { + MockSocket::initialize('client.connect', $this); + $client = new Client('ws://localhost:8000/my/mock/path'); + $this->assertNull($client->getName()); + $this->assertNull($client->getRemoteName()); + $this->assertEquals('WebSocket\Client(closed)', "{$client}"); + $client->text('Connect'); + MockSocket::initialize('send-convenicance', $this); + $client->binary(base64_encode('Binary content')); + $client->ping(); + $client->pong(); + $this->assertEquals('127.0.0.1:12345', $client->getName()); + $this->assertEquals('127.0.0.1:8000', $client->getRemoteName()); + $this->assertEquals('WebSocket\Client(127.0.0.1:12345)', "{$client}"); + } + + public function testUnconnectedClient(): void + { + $client = new Client('ws://localhost:8000/my/mock/path'); + $this->assertFalse($client->isConnected()); + $client->setTimeout(30); + $client->close(); + $this->assertFalse($client->isConnected()); + $this->assertNull($client->getName()); + $this->assertNull($client->getRemoteName()); + $this->assertNull($client->getCloseStatus()); + } + + public function testDeprecated(): void + { + $client = new Client('ws://localhost:8000/my/mock/path'); + (new ErrorHandler())->withAll(function () use ($client) { + $this->assertNull($client->getPier()); + }, function ($exceptions, $result) { + $this->assertEquals( + 'getPier() is deprecated and will be removed in future version. Use getRemoteName() instead.', + $exceptions[0]->getMessage() + ); + }, E_USER_DEPRECATED); + } +} diff --git a/vendor/textalk/websocket/tests/ExceptionTest.php b/vendor/textalk/websocket/tests/ExceptionTest.php new file mode 100644 index 000000000..2083e709c --- /dev/null +++ b/vendor/textalk/websocket/tests/ExceptionTest.php @@ -0,0 +1,51 @@ + 'with data'], + new TimeoutException( + 'Nested exception', + ConnectionException::TIMED_OUT + ) + ); + } catch (Throwable $e) { + } + + $this->assertInstanceOf('WebSocket\ConnectionException', $e); + $this->assertInstanceOf('WebSocket\Exception', $e); + $this->assertInstanceOf('Exception', $e); + $this->assertInstanceOf('Throwable', $e); + $this->assertEquals('An error message', $e->getMessage()); + $this->assertEquals(1025, $e->getCode()); + $this->assertEquals(['test' => 'with data'], $e->getData()); + + $p = $e->getPrevious(); + $this->assertInstanceOf('WebSocket\TimeoutException', $p); + $this->assertInstanceOf('WebSocket\ConnectionException', $p); + $this->assertEquals('Nested exception', $p->getMessage()); + $this->assertEquals(1024, $p->getCode()); + $this->assertEquals([], $p->getData()); + } +} diff --git a/vendor/textalk/websocket/tests/MessageTest.php b/vendor/textalk/websocket/tests/MessageTest.php new file mode 100644 index 000000000..bade4359f --- /dev/null +++ b/vendor/textalk/websocket/tests/MessageTest.php @@ -0,0 +1,60 @@ +create('text', 'Some content'); + $this->assertInstanceOf('WebSocket\Message\Text', $message); + $message = $factory->create('binary', 'Some content'); + $this->assertInstanceOf('WebSocket\Message\Binary', $message); + $message = $factory->create('ping', 'Some content'); + $this->assertInstanceOf('WebSocket\Message\Ping', $message); + $message = $factory->create('pong', 'Some content'); + $this->assertInstanceOf('WebSocket\Message\Pong', $message); + $message = $factory->create('close', 'Some content'); + $this->assertInstanceOf('WebSocket\Message\Close', $message); + } + + public function testMessage() + { + $message = new Text('Some content'); + $this->assertInstanceOf('WebSocket\Message\Message', $message); + $this->assertInstanceOf('WebSocket\Message\Text', $message); + $this->assertEquals('Some content', $message->getContent()); + $this->assertEquals('text', $message->getOpcode()); + $this->assertEquals(12, $message->getLength()); + $this->assertTrue($message->hasContent()); + $this->assertInstanceOf('DateTime', $message->getTimestamp()); + $message->setContent(''); + $this->assertEquals(0, $message->getLength()); + $this->assertFalse($message->hasContent()); + $this->assertEquals('WebSocket\Message\Text', "{$message}"); + } + + public function testBadOpcode() + { + $factory = new Factory(); + $this->expectException('WebSocket\BadOpcodeException'); + $this->expectExceptionMessage("Invalid opcode 'invalid' provided"); + $message = $factory->create('invalid', 'Some content'); + } +} diff --git a/vendor/textalk/websocket/tests/README.md b/vendor/textalk/websocket/tests/README.md new file mode 100644 index 000000000..0af2997db --- /dev/null +++ b/vendor/textalk/websocket/tests/README.md @@ -0,0 +1,28 @@ +# Testing + +Unit tests with [PHPUnit](https://phpunit.readthedocs.io/). + + +## How to run + +To run all test, run in console. + +``` +make test +``` + + +## Continuous integration + +GitHub Actions are run on PHP versions `7.4`, `8.0`, `8.1` and `8.2`. + +Code coverage by [Coveralls](https://coveralls.io/github/Textalk/websocket-php). + + +## Test strategy + +Test set up overloads various stream and socket functions, +and use "scripts" to define and mock input/output of these functions. + +This set up negates the dependency on running servers, +and allow testing various errors that might occur. diff --git a/vendor/textalk/websocket/tests/ServerTest.php b/vendor/textalk/websocket/tests/ServerTest.php new file mode 100644 index 000000000..033895fd1 --- /dev/null +++ b/vendor/textalk/websocket/tests/ServerTest.php @@ -0,0 +1,511 @@ +assertTrue(MockSocket::isEmpty()); + MockSocket::initialize('server.accept', $this); + $server->accept(); + $server->send('Connect'); + $this->assertEquals(8000, $server->getPort()); + $this->assertEquals('/my/mock/path', $server->getPath()); + $this->assertTrue($server->isConnected()); + $this->assertEquals(4096, $server->getFragmentSize()); + $this->assertNull($server->getCloseStatus()); + $this->assertEquals([ + 'GET /my/mock/path HTTP/1.1', + 'host: localhost:8000', + 'user-agent: websocket-client-php', + 'connection: Upgrade', + 'upgrade: websocket', + 'sec-websocket-key: cktLWXhUdDQ2OXF0ZCFqOQ==', + 'sec-websocket-version: 13', + '', + '', + ], $server->getRequest()); + $this->assertEquals('websocket-client-php', $server->getHeader('USER-AGENT')); + $this->assertNull($server->getHeader('no such header')); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('send-receive', $this); + $server->send('Sending a message'); + $message = $server->receive(); + $this->assertEquals('Receiving a message', $message); + $this->assertTrue(MockSocket::isEmpty()); + $this->assertNull($server->getCloseStatus()); + $this->assertEquals('text', $server->getLastOpcode()); + + MockSocket::initialize('server.close', $this); + $server->close(); + $this->assertFalse($server->isConnected()); + $this->assertEquals(1000, $server->getCloseStatus()); + $this->assertTrue(MockSocket::isEmpty()); + + $server->close(); // Already closed + } + + public function testDestruct(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + + MockSocket::initialize('server.accept-destruct', $this); + $server->accept(); + $message = $server->receive(); + } + + public function testServerWithTimeout(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(['timeout' => 300]); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('server.accept-timeout', $this); + $server->accept(); + $server->send('Connect'); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testPayload128(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('server.accept', $this); + $server->accept(); + $server->send('Connect'); + $this->assertTrue($server->isConnected()); + $this->assertTrue(MockSocket::isEmpty()); + + $payload = file_get_contents(__DIR__ . '/mock/payload.128.txt'); + + MockSocket::initialize('send-receive-128', $this); + $server->send($payload, 'text', false); + $message = $server->receive(); + $this->assertEquals($payload, $message); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testPayload65536(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('server.accept', $this); + $server->accept(); + $server->send('Connect'); + $this->assertTrue($server->isConnected()); + $this->assertTrue(MockSocket::isEmpty()); + + $payload = file_get_contents(__DIR__ . '/mock/payload.65536.txt'); + $server->setFragmentSize(65540); + + MockSocket::initialize('send-receive-65536', $this); + $server->send($payload, 'text', false); + $message = $server->receive(); + $this->assertEquals($payload, $message); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testMultiFragment(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('server.accept', $this); + $server->accept(); + $server->send('Connect'); + $this->assertTrue($server->isConnected()); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('send-receive-multi-fragment', $this); + $server->setFragmentSize(8); + $server->send('Multi fragment test'); + $message = $server->receive(); + $this->assertEquals('Multi fragment test', $message); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testPingPong(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('server.accept', $this); + $server->accept(); + $server->send('Connect'); + $this->assertTrue($server->isConnected()); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('ping-pong', $this); + $server->send('Server ping', 'ping'); + $server->send('', 'ping'); + $message = $server->receive(); + $this->assertEquals('Receiving a message', $message); + $this->assertEquals('text', $server->getLastOpcode()); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testRemoteClose(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('server.accept', $this); + $server->accept(); + $server->send('Connect'); + $this->assertTrue($server->isConnected()); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('close-remote', $this); + + $message = $server->receive(); + $this->assertEquals('', $message); + + $this->assertTrue(MockSocket::isEmpty()); + $this->assertFalse($server->isConnected()); + $this->assertEquals(17260, $server->getCloseStatus()); + $this->assertNull($server->getLastOpcode()); + } + + public function testSetTimeout(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('server.accept', $this); + $server->accept(); + $server->send('Connect'); + $this->assertTrue($server->isConnected()); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('config-timeout', $this); + $server->setTimeout(300); + $this->assertTrue($server->isConnected()); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testFailedSocketServer(): void + { + MockSocket::initialize('server.construct-failed-socket-server', $this); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(0); + $this->expectExceptionMessage('Could not open listening socket:'); + $server = new Server(['port' => 9999]); + } + + public function testFailedSocketServerWithError(): void + { + MockSocket::initialize('server.construct-error-socket-server', $this); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(0); + $this->expectExceptionMessage('Could not open listening socket:'); + $server = new Server(['port' => 9999]); + } + + public function testFailedConnect(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + + MockSocket::initialize('server.accept-failed-connect', $this); + $server->accept(); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(0); + $this->expectExceptionMessage('Server failed to connect'); + $server->send('Connect'); + } + + public function testFailedConnectWithError(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + + MockSocket::initialize('server.accept-error-connect', $this); + $server->accept(); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(0); + $this->expectExceptionMessage('Server failed to connect'); + $server->send('Connect'); + } + + public function testFailedConnectTimeout(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(['timeout' => 300]); + + MockSocket::initialize('server.accept-failed-connect', $this); + $server->accept(); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(0); + $this->expectExceptionMessage('Server failed to connect'); + $server->send('Connect'); + } + + public function testFailedHttp(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + MockSocket::initialize('server.accept-failed-http', $this); + $server->accept(); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(0); + $this->expectExceptionMessage('No GET in request'); + $server->send('Connect'); + } + + public function testFailedWsKey(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + MockSocket::initialize('server.accept-failed-ws-key', $this); + $server->accept(); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(0); + $this->expectExceptionMessage('Client had no Key in upgrade request'); + $server->send('Connect'); + } + + public function testSendBadOpcode(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + MockSocket::initialize('server.accept', $this); + $server->accept(); + $server->send('Connect'); + $this->expectException('WebSocket\BadOpcodeException'); + $this->expectExceptionCode(0); + $this->expectExceptionMessage('Bad opcode \'bad\'. Try \'text\' or \'binary\'.'); + $server->send('Bad Opcode', 'bad'); + } + + public function testRecieveBadOpcode(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + MockSocket::initialize('server.accept', $this); + $server->accept(); + $server->send('Connect'); + MockSocket::initialize('receive-bad-opcode', $this); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(1026); + $this->expectExceptionMessage('Bad opcode in websocket frame: 12'); + $message = $server->receive(); + } + + public function testBrokenWrite(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + MockSocket::initialize('server.accept', $this); + $server->accept(); + $server->send('Connect'); + MockSocket::initialize('send-broken-write', $this); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(1025); + $this->expectExceptionMessage('Could only write 18 out of 22 bytes.'); + $server->send('Failing to write'); + } + + public function testFailedWrite(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + MockSocket::initialize('server.accept', $this); + $server->accept(); + $server->send('Connect'); + MockSocket::initialize('send-failed-write', $this); + $this->expectException('WebSocket\TimeoutException'); + $this->expectExceptionCode(1024); + $this->expectExceptionMessage('Failed to write 22 bytes.'); + $server->send('Failing to write'); + } + + public function testBrokenRead(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + MockSocket::initialize('server.accept', $this); + $server->accept(); + $server->send('Connect'); + MockSocket::initialize('receive-broken-read', $this); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(1025); + $this->expectExceptionMessage('Broken frame, read 0 of stated 2 bytes.'); + $server->receive(); + } + + public function testEmptyRead(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + MockSocket::initialize('server.accept', $this); + $server->accept(); + $server->send('Connect'); + MockSocket::initialize('receive-empty-read', $this); + $this->expectException('WebSocket\TimeoutException'); + $this->expectExceptionCode(1024); + $this->expectExceptionMessage('Empty read; connection dead?'); + $server->receive(); + } + + public function testFrameFragmentation(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(['filter' => ['text', 'binary', 'pong', 'close']]); + MockSocket::initialize('server.accept', $this); + $server->accept(); + $server->send('Connect'); + MockSocket::initialize('receive-fragmentation', $this); + $message = $server->receive(); + $this->assertEquals('Server ping', $message); + $this->assertEquals('pong', $server->getLastOpcode()); + $message = $server->receive(); + $this->assertEquals('Multi fragment test', $message); + $this->assertEquals('text', $server->getLastOpcode()); + $this->assertTrue(MockSocket::isEmpty()); + MockSocket::initialize('close-remote', $this); + $message = $server->receive(); + $this->assertEquals('Closing', $message); + $this->assertTrue(MockSocket::isEmpty()); + $this->assertFalse($server->isConnected()); + $this->assertEquals(17260, $server->getCloseStatus()); + $this->assertEquals('close', $server->getLastOpcode()); + } + + public function testMessageFragmentation(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(['filter' => ['text', 'binary', 'pong', 'close'], 'return_obj' => true]); + MockSocket::initialize('server.accept', $this); + $server->accept(); + $server->send('Connect'); + MockSocket::initialize('receive-fragmentation', $this); + $message = $server->receive(); + $this->assertInstanceOf('WebSocket\Message\Message', $message); + $this->assertInstanceOf('WebSocket\Message\Pong', $message); + $this->assertEquals('Server ping', $message->getContent()); + $this->assertEquals('pong', $message->getOpcode()); + $message = $server->receive(); + $this->assertInstanceOf('WebSocket\Message\Message', $message); + $this->assertInstanceOf('WebSocket\Message\Text', $message); + $this->assertEquals('Multi fragment test', $message->getContent()); + $this->assertEquals('text', $message->getOpcode()); + $this->assertTrue(MockSocket::isEmpty()); + MockSocket::initialize('close-remote', $this); + $message = $server->receive(); + $this->assertInstanceOf('WebSocket\Message\Message', $message); + $this->assertInstanceOf('WebSocket\Message\Close', $message); + $this->assertEquals('Closing', $message->getContent()); + $this->assertEquals('close', $message->getOpcode()); + } + + public function testConvenicanceMethods(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + $this->assertNull($server->getName()); + $this->assertNull($server->getRemoteName()); + $this->assertEquals('WebSocket\Server(closed)', "{$server}"); + MockSocket::initialize('server.accept', $this); + $server->accept(); + $server->text('Connect'); + MockSocket::initialize('send-convenicance', $this); + $server->binary(base64_encode('Binary content')); + $server->ping(); + $server->pong(); + $this->assertEquals('127.0.0.1:12345', $server->getName()); + $this->assertEquals('127.0.0.1:8000', $server->getRemoteName()); + $this->assertEquals('WebSocket\Server(127.0.0.1:12345)', "{$server}"); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testUnconnectedServer(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + $this->assertFalse($server->isConnected()); + $server->setTimeout(30); + $server->close(); + $this->assertFalse($server->isConnected()); + $this->assertNull($server->getName()); + $this->assertNull($server->getRemoteName()); + $this->assertNull($server->getCloseStatus()); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testFailedHandshake(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('server.accept-failed-handshake', $this); + $server->accept(); + $this->expectException('WebSocket\ConnectionException'); + $this->expectExceptionCode(0); + $this->expectExceptionMessage('Could not read from stream'); + $server->send('Connect'); + $this->assertFalse($server->isConnected()); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testServerDisconnect(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + $this->assertTrue(MockSocket::isEmpty()); + MockSocket::initialize('server.accept', $this); + $server->accept(); + $server->send('Connect'); + $this->assertTrue($server->isConnected()); + $this->assertTrue(MockSocket::isEmpty()); + + MockSocket::initialize('server.disconnect', $this); + $server->disconnect(); + $this->assertFalse($server->isConnected()); + $this->assertTrue(MockSocket::isEmpty()); + } + + public function testDeprecated(): void + { + MockSocket::initialize('server.construct', $this); + $server = new Server(); + $this->assertTrue(MockSocket::isEmpty()); + (new ErrorHandler())->withAll(function () use ($server) { + $this->assertNull($server->getPier()); + }, function ($exceptions, $result) { + $this->assertEquals( + 'getPier() is deprecated and will be removed in future version. Use getRemoteName() instead.', + $exceptions[0]->getMessage() + ); + }, E_USER_DEPRECATED); + } +} diff --git a/vendor/textalk/websocket/tests/bootstrap.php b/vendor/textalk/websocket/tests/bootstrap.php new file mode 100644 index 000000000..5d6bdd074 --- /dev/null +++ b/vendor/textalk/websocket/tests/bootstrap.php @@ -0,0 +1,6 @@ +interpolate($message, $context); + $context_string = empty($context) ? '' : json_encode($context); + echo str_pad($level, 8) . " | {$message} {$context_string}\n"; + } + + public function interpolate($message, array $context = []) + { + // Build a replacement array with braces around the context keys + $replace = []; + foreach ($context as $key => $val) { + // Check that the value can be cast to string + if (!is_array($val) && (!is_object($val) || method_exists($val, '__toString'))) { + $replace['{' . $key . '}'] = $val; + } + } + + // Interpolate replacement values into the message and return + return strtr($message, $replace); + } +} diff --git a/vendor/textalk/websocket/tests/mock/MockSocket.php b/vendor/textalk/websocket/tests/mock/MockSocket.php new file mode 100644 index 000000000..e96806b56 --- /dev/null +++ b/vendor/textalk/websocket/tests/mock/MockSocket.php @@ -0,0 +1,81 @@ +assertEquals($current['function'], $function); + foreach ($current['params'] as $index => $param) { + if (isset($current['input-op'])) { + $param = self::op($current['input-op'], $params, $param); + } + self::$asserter->assertEquals($param, $params[$index], json_encode([$current, $params])); + } + if (isset($current['error'])) { + $map = array_merge(['msg' => 'Error', 'type' => E_USER_NOTICE], (array)$current['error']); + trigger_error($map['msg'], $map['type']); + } + if (isset($current['return-op'])) { + return self::op($current['return-op'], $params, $current['return']); + } + if (isset($current['return'])) { + return $current['return']; + } + return call_user_func_array($function, $params); + } + + // Check if all expected calls are performed + public static function isEmpty(): bool + { + return empty(self::$queue); + } + + // Initialize call queue + public static function initialize($op_file, $asserter): void + { + $file = dirname(__DIR__) . "/scripts/{$op_file}.json"; + self::$queue = json_decode(file_get_contents($file), true); + self::$asserter = $asserter; + } + + // Special output handling + private static function op($op, $params, $data) + { + switch ($op) { + case 'chr-array': + // Convert int array to string + $out = ''; + foreach ($data as $val) { + $out .= chr($val); + } + return $out; + case 'file': + $content = file_get_contents(__DIR__ . "/{$data[0]}"); + return substr($content, $data[1], $data[2]); + case 'key-save': + preg_match('#Sec-WebSocket-Key:\s(.*)$#mUi', $params[1], $matches); + self::$stored['sec-websocket-key'] = trim($matches[1]); + return str_replace('{key}', self::$stored['sec-websocket-key'], $data); + case 'key-respond': + $key = self::$stored['sec-websocket-key'] . '258EAFA5-E914-47DA-95CA-C5AB0DC85B11'; + $encoded = base64_encode(pack('H*', sha1($key))); + return str_replace('{key}', $encoded, $data); + } + return $data; + } +} diff --git a/vendor/textalk/websocket/tests/mock/mock-socket.php b/vendor/textalk/websocket/tests/mock/mock-socket.php new file mode 100644 index 000000000..a03893344 --- /dev/null +++ b/vendor/textalk/websocket/tests/mock/mock-socket.php @@ -0,0 +1,83 @@ +