Refactor WebSocket Server/Client (#5867)

* optimize websocket continue frame (#5855)

* refactor websocket

* fix

* fix 2

* fix 3

* fix 4

* fix 5

* fix 6

* fix 7 --filter=[unit]

* optimize websocket continue frame (#5861)

* optimize websocket continue frame

* optimize code

* add test

* send close frame and close connection

* fix code

* optimize code

* optimize code

* Optimize websocket namespace

* Optimize websocket namespace [2]

* Optimize websocket namespace [3]

---------

Co-authored-by: MARiA so cute <[email protected]>

Author: matyhtf

core-tests/include/test_server.h

@@ -5,10 +5,10 @@
 
 #define SERVER_THIS ((swoole::test::Server *) serv->private_data_2)
 
-#define ON_START_PARAMS swServer *serv
-#define ON_WORKER_START_PARAMS swServer *serv, swoole::Worker *worker
-#define ON_PACKET_PARAMS swServer *serv, swRecvData *req
-#define ON_RECEIVE_PARAMS swServer *serv, swRecvData *req
+#define ON_START_PARAMS swoole::Server *serv
+#define ON_WORKER_START_PARAMS swoole::Server *serv, swoole::Worker *worker
+#define ON_PACKET_PARAMS swoole::Server *serv, swoole::RecvData *req
+#define ON_RECEIVE_PARAMS swoole::Server *serv, swoole::RecvData *req
 
 namespace swoole {
 namespace test {

core-tests/src/core/base.cpp

@@ -366,8 +366,8 @@ TEST(base, only_dump) {
     // just dump something
     std::string data = "hello world";
     swoole_dump_ascii(data.c_str(), data.length());
-    swoole_dump_bin(data.c_str(), 'C', data.length());
-    swoole_dump_hex(data.c_str(), data.length());
+    swoole_dump_bin((uchar *) data.c_str(), 'C', data.length());
+    swoole_dump_hex((uchar *) data.c_str(), data.length());
     ASSERT_TRUE(true);
 }
 

core-tests/src/server/http_server.cpp

@@ -1847,7 +1847,7 @@ TEST(http_server, get_package_length) {
     // websocket
     sw_tg_buffer()->clear();
     conn.websocket_status = websocket::STATUS_HANDSHAKE;
-    ASSERT_EQ(http_server::get_package_length_size(&fake_sock), SW_WEBSOCKET_MESSAGE_HEADER_SIZE);
+    ASSERT_EQ(http_server::get_package_length_size(&fake_sock), SW_WEBSOCKET_FRAME_HEADER_SIZE);
     ASSERT_TRUE(websocket::encode(sw_tg_buffer(), SW_STRL(TEST_STR), websocket::OPCODE_TEXT, websocket::FLAG_FIN));
     pl.buf = sw_tg_buffer()->str;
     pl.buf_size = sw_tg_buffer()->length;

ext-src/php_swoole.cc

@@ -930,7 +930,6 @@ PHP_MSHUTDOWN_FUNCTION(swoole) {
     zend::known_strings_dtor();
 
     php_swoole_runtime_mshutdown();
-    php_swoole_websocket_server_mshutdown();
 #ifdef SW_USE_PGSQL
     php_swoole_pgsql_mshutdown();
 #endif
@@ -1129,7 +1128,7 @@ static void *_sw_zend_string_realloc(void *address, size_t size) {
 }
 
 static void _sw_zend_string_free(void *address) {
-    zend_string_free(zend::fetch_zend_string_by_val(address));
+	zend_string_release_ex(zend::fetch_zend_string_by_val(address), 0);
 }
 
 static swoole::Allocator php_allocator{
@@ -1240,7 +1239,6 @@ PHP_RINIT_FUNCTION(swoole) {
     swoole_add_hook(SW_GLOBAL_HOOK_AFTER_FORK, sw_after_fork, 0);
 
     php_swoole_http_server_rinit();
-    php_swoole_websocket_server_rinit();
     php_swoole_coroutine_rinit();
     php_swoole_runtime_rinit();
 #ifdef SW_USE_ORACLE
@@ -1266,7 +1264,6 @@ PHP_RSHUTDOWN_FUNCTION(swoole) {
 
     php_swoole_server_rshutdown();
     php_swoole_http_server_rshutdown();
-    php_swoole_websocket_server_rshutdown();
     php_swoole_async_coro_rshutdown();
     php_swoole_redis_server_rshutdown();
     php_swoole_coroutine_rshutdown();

ext-src/php_swoole_cxx.h

@@ -165,24 +165,6 @@ SW_API zend_long php_swoole_parse_to_size(zval *zv);
 SW_API zend_string *php_swoole_serialize(zval *zdata);
 SW_API bool php_swoole_unserialize(zend_string *data, zval *zv);
 
-#ifdef SW_HAVE_ZLIB
-#define php_swoole_websocket_frame_pack php_swoole_websocket_frame_pack_ex
-#define php_swoole_websocket_frame_object_pack php_swoole_websocket_frame_object_pack_ex
-#else
-#define php_swoole_websocket_frame_pack(buffer, zdata, opcode, flags, mask, allow_compress)                            \
-    php_swoole_websocket_frame_pack_ex(buffer, zdata, opcode, flags, mask, 0)
-#define php_swoole_websocket_frame_object_pack(buffer, zdata, mask, allow_compress)                                    \
-    php_swoole_websocket_frame_object_pack_ex(buffer, zdata, mask, 0)
-#endif
-int php_swoole_websocket_frame_pack_ex(
-    swoole::String *buffer, zval *zdata, zend_long opcode, uint8_t flags, zend_bool mask, zend_bool allow_compress);
-int php_swoole_websocket_frame_object_pack_ex(swoole::String *buffer,
-                                              zval *zdata,
-                                              zend_bool mask,
-                                              zend_bool allow_compress);
-void php_swoole_websocket_frame_unpack(swoole::String *data, zval *zframe);
-void php_swoole_websocket_frame_unpack_ex(swoole::String *data, zval *zframe, uchar allow_uncompress);
-
 #ifdef SW_HAVE_ZLIB
 int php_swoole_zlib_decompress(z_stream *stream, swoole::String *buffer, char *body, int length);
 #endif

ext-src/php_swoole_http.h

@@ -21,6 +21,8 @@
 #include "swoole_http.h"
 #include "swoole_http2.h"
 #include "swoole_llhttp.h"
+#include "swoole_websocket.h"
+
 #include "thirdparty/multipart_parser.h"
 
 #include <unordered_map>
@@ -74,13 +76,13 @@ enum swHttpErrorStatusCode {
 namespace swoole {
 class Server;
 class Coroutine;
+
 namespace http2 {
 class Stream;
 class Session;
 }  // namespace http2
 
 namespace http {
-
 struct Request {
     int version;
     char *path;
@@ -146,9 +148,7 @@ struct Context {
     uchar send_trailer_ : 1;
     uchar keepalive : 1;
     uchar websocket : 1;
-#ifdef SW_HAVE_ZLIB
     uchar websocket_compression : 1;
-#endif
     uchar upgrade : 1;
     uchar detached : 1;
     uchar parse_cookie : 1;
@@ -168,6 +168,9 @@ struct Context {
     std::shared_ptr<String> zlib_buffer;
 #endif
 
+    std::shared_ptr<String> frame_buffer;
+    WebSocketSettings websocket_settings;
+
     Request request;
     Response response;
 
@@ -227,6 +230,7 @@ struct Context {
     bool compress(const char *data, size_t length);
 #endif
 
+    void recv_websocket_frame(zval *return_value, double timeout);
     void http2_end(zval *zdata, zval *return_value);
     void http2_write(zval *zdata, zval *return_value);
     bool http2_send_file(const char *file, uint32_t l_file, off_t offset, size_t length);

ext-src/php_swoole_http_server.h

@@ -21,10 +21,7 @@
 #include "php_swoole_server.h"
 #include "php_swoole_http.h"
 
-#include "swoole_http.h"
-#include "swoole_websocket.h"
 #include "swoole_mime_type.h"
-#include "swoole_http2.h"
 
 bool swoole_http_server_onBeforeRequest(swoole::http::Context *ctx);
 void swoole_http_server_onAfterResponse(swoole::http::Context *ctx);

ext-src/php_swoole_private.h

@@ -317,7 +317,6 @@ void php_swoole_stdext_minit(int module_number);
  * ==============================================================
  */
 void php_swoole_http_server_rinit();
-void php_swoole_websocket_server_rinit();
 void php_swoole_coroutine_rinit();
 void php_swoole_runtime_rinit();
 #ifdef SW_USE_ORACLE
@@ -330,7 +329,6 @@ void php_swoole_thread_rinit();
  * ==============================================================
  */
 void php_swoole_http_server_rshutdown();
-void php_swoole_websocket_server_rshutdown();
 void php_swoole_async_coro_rshutdown();
 void php_swoole_redis_server_rshutdown();
 void php_swoole_coroutine_rshutdown();
@@ -362,7 +360,6 @@ void php_swoole_event_exit();
  * ==============================================================
  */
 void php_swoole_runtime_mshutdown();
-void php_swoole_websocket_server_mshutdown();
 #ifdef SW_USE_PGSQL
 void php_swoole_pgsql_mshutdown();
 #endif
@@ -373,10 +370,6 @@ void php_swoole_oracle_mshutdown();
 void php_swoole_sqlite_mshutdown();
 #endif
 
-static sw_inline zend_bool php_swoole_websocket_frame_is_object(zval *zdata) {
-    return Z_TYPE_P(zdata) == IS_OBJECT && instanceof_function(Z_OBJCE_P(zdata), swoole_websocket_frame_ce);
-}
-
 static sw_inline size_t php_swoole_get_send_data(zval *zdata, char **str) {
     convert_to_string(zdata);
     *str = Z_STRVAL_P(zdata);
@@ -454,6 +447,10 @@ static sw_inline zend_bool ZVAL_IS_STRING(const zval *v) {
     return Z_TYPE_P(v) == IS_STRING;
 }
 
+static sw_inline zend_bool ZVAL_IS_EMPTY_STRING(const zval *v) {
+	return Z_TYPE_P(v) == IS_STRING && Z_STRLEN_P(v) == 0;
+}
+
 static sw_inline zend_bool Z_BVAL_P(const zval *v) {
     return Z_TYPE_P(v) == IS_TRUE;
 }

ext-src/php_swoole_server.h

@@ -142,20 +142,20 @@ void php_swoole_server_register_callbacks(swServer *serv);
 zend::Callable *php_swoole_server_get_callback(swServer *serv, int server_fd, int event_type);
 int php_swoole_create_dir(const char *path, size_t length);
 void php_swoole_server_before_start(swServer *serv, zval *zobject);
-bool php_swoole_server_isset_callback(swServer *serv, swListenPort *port, int event_type);
+bool php_swoole_server_isset_callback(swServer *serv, swoole::ListenPort *port, int event_type);
 void php_swoole_server_send_yield(swServer *serv, swoole::SessionId sesion_id, zval *zdata, zval *return_value);
-void php_swoole_get_recv_data(swServer *serv, zval *zdata, swRecvData *req);
-void php_swoole_server_onConnect(swServer *, swDataHead *);
-int php_swoole_server_onReceive(swServer *, swRecvData *);
-int php_swoole_http_server_onReceive(swServer *, swRecvData *);
-void php_swoole_http_server_onClose(swServer *serv, swDataHead *info);
-int php_swoole_redis_server_onReceive(swServer *serv, swRecvData *req);
-int php_swoole_server_onPacket(swServer *, swRecvData *);
-void php_swoole_server_onClose(swServer *, swDataHead *);
-void php_swoole_server_onBufferFull(swServer *, swDataHead *);
-void php_swoole_server_onBufferEmpty(swServer *, swDataHead *);
+void php_swoole_get_recv_data(swServer *serv, zval *zdata, swoole::RecvData *req);
+void php_swoole_server_onConnect(swServer *, swoole::DataHead *);
+int php_swoole_server_onReceive(swServer *, swoole::RecvData *);
+int php_swoole_http_server_onReceive(swServer *, swoole::RecvData *);
+void php_swoole_http_server_onClose(swServer *serv, swoole::DataHead *info);
+int php_swoole_redis_server_onReceive(swServer *serv, swoole::RecvData *req);
+int php_swoole_server_onPacket(swServer *, swoole::RecvData *);
+void php_swoole_server_onClose(swServer *, swoole::DataHead *);
+void php_swoole_server_onBufferFull(swServer *, swoole::DataHead *);
+void php_swoole_server_onBufferEmpty(swServer *, swoole::DataHead *);
 
 swServer *php_swoole_server_get_and_check_server(zval *zobject);
 void php_swoole_server_port_deref(zend_object *object);
+void php_swoole_server_set_websocket_option(swoole::ListenPort *port, zend_array *vht);
 swoole::ServerObject *php_swoole_server_get_zend_object(swoole::Server *serv);
-

ext-src/php_swoole_websocket.h

@@ -0,0 +1,62 @@
+/*
+ +----------------------------------------------------------------------+
+ | Swoole                                                               |
+ +----------------------------------------------------------------------+
+ | Copyright (c) 2012-2015 The Swoole Group                             |
+ +----------------------------------------------------------------------+
+ | This source file is subject to version 2.0 of the Apache license,    |
+ | that is bundled with this package in the file LICENSE, and is        |
+ | available through the world-wide-web at the following url:           |
+ | http://www.apache.org/licenses/LICENSE-2.0.html                      |
+ | If you did not receive a copy of the Apache2.0 license and are unable|
+ | to obtain it through the world-wide-web, please send a note to       |
+ | [email protected] so we can mail you a copy immediately.            |
+ +----------------------------------------------------------------------+
+ | Author: Tianfeng Han  <[email protected]>                             |
+ +----------------------------------------------------------------------+
+ */
+
+#pragma once
+
+#include "php_swoole_cxx.h"
+
+#include "swoole_websocket.h"
+
+#define SW_WEBSOCKET_DEFAULT_BUFFER 4096
+
+namespace swoole {
+namespace websocket {
+void apply_setting(WebSocketSettings &settings, zend_array *vht, bool in_server);
+void recv_frame(const WebSocketSettings &settings,
+                std::shared_ptr<String> &frame_buffer,
+                coroutine::Socket *sock,
+                zval *return_value,
+                double timeout);
+ssize_t send_frame(const WebSocketSettings &settings,
+                   coroutine::Socket *sock,
+                   uchar opcode,
+                   uchar flags,
+                   const char *payload,
+                   size_t payload_length);
+void construct_frame(zval *zframe, zend_long opcode, zval *zpayload, uint8_t flags);
+
+#ifdef SW_HAVE_ZLIB
+bool message_compress(String *buffer, const char *data, size_t length, int level);
+bool message_uncompress(String *buffer, const char *in, size_t in_len);
+#endif
+
+struct FrameObject {
+    uint8_t opcode;
+    uint8_t flags;
+    uint16_t code;
+    zval *data;
+
+    FrameObject(zval *data, zend_long _opcode = 0, zend_long _flags = 0, zend_long _code = 0);
+    size_t get_data_size() {
+        return (data && ZVAL_IS_STRING(data)) ? Z_STRLEN_P(data) : 0;
+    }
+    bool pack(String *buffer);
+    static bool uncompress(zval *zpayload, const char *data, size_t length);
+};
+}  // namespace websocket
+}  // namespace swoole