From eed17d6ced050f28165995cf36fdc1ce0602348f Mon Sep 17 00:00:00 2001
From: SantaSpeen <santaspeen@gmail.com>
Date: Sat, 15 Mar 2025 03:02:30 +0300
Subject: [PATCH] [!] Change semantic [!] Chane base class for support other
 connectors

---
 .../{WinConnectBase.py => _base_base.py}      | 71 +++++++------------
 .../{WinConnectClient.py => _base_client.py}  | 12 ++--
 .../{WinConnectServer.py => _base_server.py}  | 10 +--
 winConnect/connectors/named_pipe/__init__.py  |  4 +-
 .../{_WinConnectNamedPipe.py => _base.py}     | 16 +++--
 .../{WinConnectClient.py => client.py}        |  6 +-
 .../{WinConnectServer.py => server.py}        | 10 +--
 .../connectors/socket/WinConnectClient.py     |  6 --
 .../connectors/socket/WinConnectServer.py     |  6 --
 .../connectors/socket/_WinConnectTCPSocket.py |  5 --
 winConnect/connectors/socket/__init__.py      |  2 +
 winConnect/connectors/socket/_base.py         |  5 ++
 winConnect/connectors/socket/client.py        |  6 ++
 winConnect/connectors/socket/server.py        |  6 ++
 14 files changed, 75 insertions(+), 90 deletions(-)
 rename winConnect/connectors/{WinConnectBase.py => _base_base.py} (86%)
 rename winConnect/connectors/{WinConnectClient.py => _base_client.py} (80%)
 rename winConnect/connectors/{WinConnectServer.py => _base_server.py} (75%)
 rename winConnect/connectors/named_pipe/{_WinConnectNamedPipe.py => _base.py} (73%)
 rename winConnect/connectors/named_pipe/{WinConnectClient.py => client.py} (91%)
 rename winConnect/connectors/named_pipe/{WinConnectServer.py => server.py} (86%)
 delete mode 100644 winConnect/connectors/socket/WinConnectClient.py
 delete mode 100644 winConnect/connectors/socket/WinConnectServer.py
 delete mode 100644 winConnect/connectors/socket/_WinConnectTCPSocket.py
 create mode 100644 winConnect/connectors/socket/_base.py
 create mode 100644 winConnect/connectors/socket/client.py
 create mode 100644 winConnect/connectors/socket/server.py

diff --git a/winConnect/connectors/WinConnectBase.py b/winConnect/connectors/_base_base.py
similarity index 86%
rename from winConnect/connectors/WinConnectBase.py
rename to winConnect/connectors/_base_base.py
index 9a0b20b..4ac4476 100644
--- a/winConnect/connectors/WinConnectBase.py
+++ b/winConnect/connectors/_base_base.py
@@ -7,14 +7,13 @@ import zlib
 from typing import Any
 
 import ormsgpack
-import pywintypes
-import win32file
 
-from winConnect.crypto.WinConnectCrypto import WinConnectCrypto
-from winConnect.crypto.crypto_classes import WinConnectCryptoNone
-from winConnect.errors import WinConnectErrors, WinConnectError
-from winConnect import exceptions
-from winConnect.utils import SimpleConvertor
+from .. import exceptions
+from ..crypto.WinConnectCrypto import WinConnectCrypto
+from ..crypto.crypto_classes import WinConnectCryptoNone
+from ..errors import WinConnectErrors, WinConnectError
+from ..utils import SimpleConvertor
+
 
 # header: len(data) in struct.pack via header_format
 # data: action:data
@@ -30,23 +29,25 @@ class WinConnectBase:
 
     ormsgpack_options = ormsgpack.OPT_NON_STR_KEYS | ormsgpack.OPT_NAIVE_UTC | ormsgpack.OPT_PASSTHROUGH_TUPLE # ormsgpack options
 
-    def __init__(self, pipe_name: str):
-        self._log = logging.getLogger(f"WinConnect:{pipe_name}")
+    def __init__(self):
+        self._log = logging.getLogger(f"WinConnectBase")
+        self._log_prefix = "WinConnectBase"
         # versions:
         # 1 - 0.9.1
         # 2 - 0.9.2 (with crypto)
         # 3 - 0.9.3+ (with crypto+salt)
         self._version = 3
-        self._pipe_name = r'\\.\pipe\{}'.format(pipe_name)
-        self._pipe = None
+
+        self._sock = None
+
         self._opened = False
+        self._connected = False
+        self._inited = False
 
         self._header_format = self.init_header_format
         self._header_size = struct.calcsize(self._header_format)  # bytes
         self._calc_body_max_size()
 
-        self._connected = False
-        self._inited = False
         self._session_encoding = self.init_encoding
 
         self._crypto = WinConnectCrypto()
@@ -64,7 +65,7 @@ class WinConnectBase:
             raise exceptions.WinConnectCryptoException("Crypto failed test")
 
     def set_logger(self, logger):
-        logger.debug(f"[{self._pipe_name}] Update logger")
+        logger.debug(f"[{self._log_prefix}] Update logger")
         self._log = logger
         self._crypto.set_logger(logger)
 
@@ -87,10 +88,6 @@ class WinConnectBase:
         except struct.error as e:
             raise exceptions.WinConnectStructFormatException(f"Error in struct format. ({e})")
 
-    @property
-    def pipe_name(self):
-        return self._pipe_name
-
     @property
     def encoding(self):
         if not self._inited:
@@ -111,7 +108,7 @@ class WinConnectBase:
     def __parse_message(message: bytes):
         return message.split(b":", 1)
 
-    def _open_pipe(self): ...
+    def _open_sock(self): ...
 
     def _wait_connect(self): ...
 
@@ -139,17 +136,7 @@ class WinConnectBase:
                 raise exceptions.WinConnectBadDataTypeException('Is client using correct lib? Unknown data type')
         return action, ready_data
 
-    def __raw_read(self, size):
-        with self._pipe_lock:
-            try:
-                _, data = win32file.ReadFile(self._pipe, size)
-                return data
-            except pywintypes.error as e:
-                if e.winerror == 109:
-                    exc = exceptions.WinConnectConnectionClosedException("Connection closed")
-                    exc.real_exc = e
-                    raise exc
-                raise e
+    def __raw_read(self, size) -> bytes: ...
 
     def __read_and_decrypt(self, size):
         data = self.__raw_read(size)
@@ -177,14 +164,10 @@ class WinConnectBase:
             # Read body
             data = self.__read_and_decrypt(message_size)
             action, data = self.__handle_receive_data_type(data)
-            self._log.debug(f"[{self._pipe_name}] Received message: {action=} {data=}")
+            self._log.debug(f"[{self._log_prefix}] Received message: {action=} {data=}")
             return action, data
 
-    def __raw_write(self, packet):
-        with self._pipe_lock:
-            if self.closed:
-                raise exceptions.WinConnectSessionClosedException("Session is closed")
-            win32file.WriteFile(self._pipe, packet)
+    def __raw_write(self, packet): ...
 
     def _send_message(self, action: str, data: Any):
         with self._write_lock:
@@ -197,7 +180,7 @@ class WinConnectBase:
             if message_size > self._body_max_size:
                 raise exceptions.WinConnectBaseException('Message is too big')
 
-            self._log.debug(f"[{self._pipe_name}] Sending message: {action=} {data=}; {message_size} {packed_data=}")
+            self._log.debug(f"[{self._log_prefix}] Sending message: {action=} {data=}; {message_size} {packed_data=}")
             # Send header
             self.__raw_write(struct.pack(self.__header_settings[0], message_size))
             # Send body
@@ -208,7 +191,7 @@ class WinConnectBase:
         self._send_message("err", e)
 
     def __read_chunked_message(self, data_info: bytes):
-        self._log.debug(f"[{self._pipe_name}] Receive long message. Reading in chunks...")
+        self._log.debug(f"[{self._log_prefix}] Receive long message. Reading in chunks...")
         chunk_size = self._body_max_size - 32
         cdata_sha256, cdata_len = data_info[:32], int(data_info[32:])
         if cdata_len > self.read_max_buffer:
@@ -226,7 +209,7 @@ class WinConnectBase:
         return zlib.decompress(_buffer)
 
     def __send_chunked_message(self, data: bytes):
-        self._log.debug(f"[{self._pipe_name}] Long message. Sending in chunks...")
+        self._log.debug(f"[{self._log_prefix}] Long message. Sending in chunks...")
         chunk_size = self._body_max_size - 32
         cdata = zlib.compress(data)
 
@@ -269,7 +252,7 @@ class WinConnectBase:
         command, data = self.__parse_message(data)
         match command:
             case b'get_session_settings':
-                self._log.debug(f"[{self._pipe_name}] Received get_session_settings from {data}")
+                self._log.debug(f"[{self._log_prefix}] Received get_session_settings from {data}")
                 _blank_settings['version'] = self._version
                 _blank_settings['encoding'] = self._session_encoding
                 _blank_settings['header_size'] = self._header_size
@@ -280,7 +263,7 @@ class WinConnectBase:
                 self._send_message("cmd", session_settings)
                 return True
             case b'set_session_settings':
-                self._log.debug(f"[{self._pipe_name}] Received session settings.")
+                self._log.debug(f"[{self._log_prefix}] Received session settings.")
                 len_salt, data_salt = self.__parse_message(data)
                 len_salt = int(len_salt)
                 if len_salt > 0:
@@ -289,7 +272,7 @@ class WinConnectBase:
                     data, salt = data_salt, b''
 
                 if salt != self._crypto.crypt_salt:
-                    self._log.debug(f"[{self._pipe_name}] Updating salt")
+                    self._log.debug(f"[{self._log_prefix}] Updating salt")
                     self._crypto.set_salt(salt)
 
                 try:
@@ -353,8 +336,8 @@ class WinConnectBase:
             self._opened = False
             self._connected = False
             self._inited = False
-            self._pipe = None
-            self._log.debug(f"[{self._pipe_name}] Session closed")
+            self._sock = None
+            self._log.debug(f"[{self._log_prefix}] Session closed")
 
     def _read(self) -> Any:
         if self.closed:
diff --git a/winConnect/connectors/WinConnectClient.py b/winConnect/connectors/_base_client.py
similarity index 80%
rename from winConnect/connectors/WinConnectClient.py
rename to winConnect/connectors/_base_client.py
index 039d0e7..912aed2 100644
--- a/winConnect/connectors/WinConnectClient.py
+++ b/winConnect/connectors/_base_client.py
@@ -1,4 +1,4 @@
-from winConnect.connectors.WinConnectBase import WinConnectBase
+from ._base_base import WinConnectBase
 
 
 class WinConnectClient(WinConnectBase):
@@ -15,14 +15,14 @@ class WinConnectClient(WinConnectBase):
         if not self.closed:
             self._send_message("cmd", b"close:")
 
-    def __check_pipe(self):
+    def __check_sock(self):
         if not self._opened:
-            self._open_pipe()
+            self._open_sock()
         if not self._inited:
             self._init()
 
     def __enter__(self):
-        self.__check_pipe()
+        self.__check_sock()
         return self
 
     def __exit__(self, exc_type, exc_val, exc_tb):
@@ -30,10 +30,10 @@ class WinConnectClient(WinConnectBase):
 
     def connect(self, program_name: str="NoName"):
         """Connect to server and initialize session"""
-        self._open_pipe()
+        self._open_sock()
         self._init(program_name)
         return self
 
     def read_pipe(self):
-        self.__check_pipe()
+        self.__check_sock()
         return self._read()
diff --git a/winConnect/connectors/WinConnectServer.py b/winConnect/connectors/_base_server.py
similarity index 75%
rename from winConnect/connectors/WinConnectServer.py
rename to winConnect/connectors/_base_server.py
index c77dc76..98cb41c 100644
--- a/winConnect/connectors/WinConnectServer.py
+++ b/winConnect/connectors/_base_server.py
@@ -1,6 +1,6 @@
 import win32pipe
 
-from winConnect.connectors.WinConnectBase import WinConnectBase
+from ._base_base import WinConnectBase
 
 
 class WinConnectServer(WinConnectBase):
@@ -9,19 +9,15 @@ class WinConnectServer(WinConnectBase):
         super().__init__(pipe_name)
         self.run = True
 
-    def _open_pipe(self): ...
-
-    def _wait_connect(self): ...
-
     def _close_session(self):
         self.run = False
 
     def wait_client(self):
         if not self._opened:
-            self._open_pipe()
+            self._open_sock()
         self._wait_connect()
         self._connected = True
-        self._log.debug(f"[{self._pipe_name}] Client connected")
+        self._log.debug(f"[{self._log_prefix}] Client connected")
 
     def read_pipe(self):
         if not self._connected:
diff --git a/winConnect/connectors/named_pipe/__init__.py b/winConnect/connectors/named_pipe/__init__.py
index 6dbbfcc..d3822bb 100644
--- a/winConnect/connectors/named_pipe/__init__.py
+++ b/winConnect/connectors/named_pipe/__init__.py
@@ -1,2 +1,2 @@
-from .WinConnectClient import WinConnectPipeClient
-from .WinConnectServer import WinConnectPipeServer
+from .client import WinConnectPipeClient
+from .server import WinConnectPipeServer
diff --git a/winConnect/connectors/named_pipe/_WinConnectNamedPipe.py b/winConnect/connectors/named_pipe/_base.py
similarity index 73%
rename from winConnect/connectors/named_pipe/_WinConnectNamedPipe.py
rename to winConnect/connectors/named_pipe/_base.py
index 5a6c821..46bb282 100644
--- a/winConnect/connectors/named_pipe/_WinConnectNamedPipe.py
+++ b/winConnect/connectors/named_pipe/_base.py
@@ -4,20 +4,24 @@ import pywintypes
 import win32file
 
 from winConnect import exceptions
-from winConnect.connectors.WinConnectBase import WinConnectBase
+from .._base_base import WinConnectBase
 
 
 class WinConnectNamedPipe(WinConnectBase):
     def __init__(self, pipe_name: str):
-        super().__init__(pipe_name)
+        super().__init__()
         self._log = logging.getLogger(f"WinConnectNamedPipe:{pipe_name}")
         self._pipe_name = r'\\.\pipe\{}'.format(pipe_name)
-        self._pipe = None
+        self._sock = None
+
+    @property
+    def pipe_path(self):
+        return self._pipe_name
 
     def __raw_read(self, size):
         with self._pipe_lock:
             try:
-                _, data = win32file.ReadFile(self._pipe, size)
+                _, data = win32file.ReadFile(self._sock, size)
                 return data
             except pywintypes.error as e:
                 if e.winerror == 109:
@@ -30,7 +34,7 @@ class WinConnectNamedPipe(WinConnectBase):
         with self._pipe_lock:
             if self.closed:
                 raise exceptions.WinConnectSessionClosedException("Session is closed")
-            win32file.WriteFile(self._pipe, packet)
+            win32file.WriteFile(self._sock, packet)
 
     def _close_pipe(self):
-        win32file.CloseHandle(self._pipe)
+        win32file.CloseHandle(self._sock)
diff --git a/winConnect/connectors/named_pipe/WinConnectClient.py b/winConnect/connectors/named_pipe/client.py
similarity index 91%
rename from winConnect/connectors/named_pipe/WinConnectClient.py
rename to winConnect/connectors/named_pipe/client.py
index ba7f39f..e9894dd 100644
--- a/winConnect/connectors/named_pipe/WinConnectClient.py
+++ b/winConnect/connectors/named_pipe/client.py
@@ -2,8 +2,8 @@ import pywintypes
 import win32file
 
 from winConnect.exceptions import WinConnectConnectionNoPipeException
-from ._WinConnectNamedPipe import WinConnectNamedPipe
-from ..WinConnectClient import WinConnectClient
+from ._base import WinConnectNamedPipe
+from .._base_client import WinConnectClient
 
 
 class WinConnectPipeClient(WinConnectNamedPipe, WinConnectClient):
@@ -18,7 +18,7 @@ class WinConnectPipeClient(WinConnectNamedPipe, WinConnectClient):
     def __init__(self, pipe_name: str):
         super().__init__(pipe_name)
 
-    def _open_pipe(self):
+    def _open_sock(self):
         try:
             self._pipe = win32file.CreateFile(
                 self._pipe_name,
diff --git a/winConnect/connectors/named_pipe/WinConnectServer.py b/winConnect/connectors/named_pipe/server.py
similarity index 86%
rename from winConnect/connectors/named_pipe/WinConnectServer.py
rename to winConnect/connectors/named_pipe/server.py
index 17ab0fd..f6bb8d8 100644
--- a/winConnect/connectors/named_pipe/WinConnectServer.py
+++ b/winConnect/connectors/named_pipe/server.py
@@ -1,7 +1,7 @@
 import win32pipe
 
-from ._WinConnectNamedPipe import WinConnectNamedPipe
-from ..WinConnectServer import WinConnectServer
+from ._base import WinConnectNamedPipe
+from .._base_server import WinConnectServer
 
 
 class WinConnectPipeServer(WinConnectNamedPipe, WinConnectServer):
@@ -16,12 +16,12 @@ class WinConnectPipeServer(WinConnectNamedPipe, WinConnectServer):
         super().__init__(pipe_name)
         self.run = True
 
-    def _open_pipe(self):
+    def _open_sock(self):
         pipe_nOutBufferSize, pipe_nInBufferSize = self._body_max_size+20, self._body_max_size+20
         self._log.debug(f"[{self._pipe_name}] Creating pipe. "
                         f"Settings: {self.pipe_openMode=}, {self.pipe_pipeMode=}, {self.pipe_nMaxInstances=}, "
                         f"{pipe_nOutBufferSize=}, {pipe_nInBufferSize=}, {self.pipe_nDefaultTimeOut=}, {self.pipe_sa=}")
-        self._pipe = win32pipe.CreateNamedPipe(
+        self._sock = win32pipe.CreateNamedPipe(
             self._pipe_name,
             self.pipe_openMode,
             self.pipe_pipeMode,
@@ -35,4 +35,4 @@ class WinConnectPipeServer(WinConnectNamedPipe, WinConnectServer):
         self._log.debug(f"[{self._pipe_name}] Pipe opened")
 
     def _wait_connect(self):
-        win32pipe.ConnectNamedPipe(self._pipe, None)
+        win32pipe.ConnectNamedPipe(self._sock, None)
diff --git a/winConnect/connectors/socket/WinConnectClient.py b/winConnect/connectors/socket/WinConnectClient.py
deleted file mode 100644
index 3c16dfe..0000000
--- a/winConnect/connectors/socket/WinConnectClient.py
+++ /dev/null
@@ -1,6 +0,0 @@
-from ._WinConnectTCPSocket import WinConnectTPC
-from ..WinConnectClient import WinConnectClient
-
-
-class WinConnectTPCClient(WinConnectTPC, WinConnectClient):
-    pass
diff --git a/winConnect/connectors/socket/WinConnectServer.py b/winConnect/connectors/socket/WinConnectServer.py
deleted file mode 100644
index 0699512..0000000
--- a/winConnect/connectors/socket/WinConnectServer.py
+++ /dev/null
@@ -1,6 +0,0 @@
-from ._WinConnectTCPSocket import WinConnectTPC
-from ..WinConnectServer import WinConnectServer
-
-
-class WinConnectPipeServer(WinConnectTPC, WinConnectServer):
-    pass
diff --git a/winConnect/connectors/socket/_WinConnectTCPSocket.py b/winConnect/connectors/socket/_WinConnectTCPSocket.py
deleted file mode 100644
index 7bc83bc..0000000
--- a/winConnect/connectors/socket/_WinConnectTCPSocket.py
+++ /dev/null
@@ -1,5 +0,0 @@
-from winConnect.connectors.WinConnectBase import WinConnectBase
-
-
-class WinConnectTPC(WinConnectBase):
-    pass
diff --git a/winConnect/connectors/socket/__init__.py b/winConnect/connectors/socket/__init__.py
index e69de29..6d91abb 100644
--- a/winConnect/connectors/socket/__init__.py
+++ b/winConnect/connectors/socket/__init__.py
@@ -0,0 +1,2 @@
+from .server import WinConnectTCPServer
+from .client import WinConnectTPCClient
diff --git a/winConnect/connectors/socket/_base.py b/winConnect/connectors/socket/_base.py
new file mode 100644
index 0000000..1afd29e
--- /dev/null
+++ b/winConnect/connectors/socket/_base.py
@@ -0,0 +1,5 @@
+from .._base_base import WinConnectBase
+
+
+class WinConnectTPC(WinConnectBase):
+    pass
diff --git a/winConnect/connectors/socket/client.py b/winConnect/connectors/socket/client.py
new file mode 100644
index 0000000..7233949
--- /dev/null
+++ b/winConnect/connectors/socket/client.py
@@ -0,0 +1,6 @@
+from ._base import WinConnectTPC
+from .._base_client import WinConnectClient
+
+
+class WinConnectTPCClient(WinConnectTPC, WinConnectClient):
+    pass
diff --git a/winConnect/connectors/socket/server.py b/winConnect/connectors/socket/server.py
new file mode 100644
index 0000000..41e4e69
--- /dev/null
+++ b/winConnect/connectors/socket/server.py
@@ -0,0 +1,6 @@
+from ._base import WinConnectTPC
+from .._base_server import WinConnectServer
+
+
+class WinConnectTCPServer(WinConnectTPC, WinConnectServer):
+    pass