dimples 1.0.0__tar.gz → 1.0.2__tar.gz

{dimples-1.0.0 → dimples-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dimples
-Version: 1.0.0
+Version: 1.0.2
 Summary: DIMP Library for Edges and Stations
 Home-page: https://github.com/dimchat/demo-py
 Author: Albert Moky

{dimples-1.0.0 → dimples-1.0.2}/dimples/conn/__init__.py

@@ -63,6 +63,7 @@ from .protocol import WebSocket, NetMsg, NetMsgHead, NetMsgSeq
 from .ws import WSArrival, WSDeparture, WSDocker
 from .mars import MarsStreamArrival, MarsStreamDeparture, MarsStreamDocker
 from .mtp import MTPStreamArrival, MTPStreamDeparture, MTPStreamDocker
+from .flexible import FlexibleDocker
 from .gate import CommonGate, TCPServerGate, TCPClientGate, UDPServerGate, UDPClientGate
 # from .gatekeeper import GateKeeper
 from .queue import MessageWrapper, MessageQueue
@@ -107,6 +108,7 @@ __all__ = [
     'WSArrival', 'WSDeparture', 'WSDocker',
     'MarsStreamArrival', 'MarsStreamDeparture', 'MarsStreamDocker',
     'MTPStreamArrival', 'MTPStreamDeparture', 'MTPStreamDocker',
+    'FlexibleDocker',
     'CommonGate', 'TCPServerGate', 'TCPClientGate', 'UDPServerGate', 'UDPClientGate',
     # 'GateKeeper',
     'MessageWrapper', 'MessageQueue',

dimples-1.0.2/dimples/conn/flexible.py

@@ -0,0 +1,168 @@
+# -*- coding: utf-8 -*-
+#
+#   Star Gate: Interfaces for network connection
+#
+#                                Written in 2024 by Moky <albert.moky@gmail.com>
+#
+# ==============================================================================
+# MIT License
+#
+# Copyright (c) 2024 Albert Moky
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+# ==============================================================================
+
+from typing import Optional, Union, List
+
+from startrek.types import SocketAddress
+from startrek.fsm import Runner
+from startrek import Connection
+from startrek import Arrival, Departure
+from startrek import StarDocker
+
+from .protocol import DeparturePacker
+
+from .ws import WSDocker
+from .mtp import MTPStreamDocker, TransactionID, MTPHelper
+from .mars import MarsStreamDocker, MarsHelper
+
+
+class FlexibleDocker(StarDocker, DeparturePacker):
+
+    def __init__(self, remote: SocketAddress, local: Optional[SocketAddress]):
+        super().__init__(remote=remote, local=local)
+        self.__docker: Optional[StarDocker] = None
+
+    def _get_docker(self, data: bytes) -> Optional[StarDocker]:
+        docker = self.__docker
+        if docker is not None or len(data) == 0:
+            return docker
+        # check data for packer
+        if WSDocker.check(data=data):
+            docker = WSDocker(remote=self.remote_address, local=self.local_address)
+        elif MTPStreamDocker.check(data=data):
+            docker = MTPStreamDocker(remote=self.remote_address, local=self.local_address)
+        elif MarsStreamDocker.check(data=data):
+            docker = MarsStreamDocker(remote=self.remote_address, local=self.local_address)
+        else:
+            print('[FlexibleDocker] unsupported data format: %s' % data)
+            return None
+        # OK
+        docker.delegate = self.delegate
+        Runner.async_run(coroutine=docker.set_connection(conn=self.connection))
+        self.__docker = docker
+        return docker
+
+    # Override
+    async def set_connection(self, conn: Optional[Connection]):
+        await super().set_connection(conn=conn)
+        docker = self.__docker
+        if docker is not None:
+            await docker.set_connection(conn=conn)
+
+    # Override
+    async def send_ship(self, ship: Departure) -> bool:
+        docker = self.__docker
+        if docker is not None:
+            return await docker.send_ship(ship=ship)
+
+    # Override
+    async def process_received(self, data: bytes):
+        docker = self._get_docker(data=data)
+        if docker is not None:
+            return await docker.process_received(data=data)
+
+    # Override
+    def _get_arrivals(self, data: bytes) -> List[Arrival]:
+        raise AssertionError('should not happen')
+
+    # Override
+    async def _check_arrival(self, ship: Arrival) -> Optional[Arrival]:
+        raise AssertionError('should not happen')
+
+    # Override
+    async def _check_response(self, ship: Arrival) -> Optional[Departure]:
+        raise AssertionError('should not happen')
+
+    # Override
+    def _assemble_arrival(self, ship: Arrival) -> Optional[Arrival]:
+        raise AssertionError('should not happen')
+
+    # Override
+    def _next_departure(self, now: float) -> Optional[Departure]:
+        raise AssertionError('should not happen')
+
+    # Override
+    def purge(self, now: float = 0) -> int:
+        cnt = super().purge(now=now)
+        docker = self.__docker
+        if docker is not None:
+            cnt += docker.purge(now=now)
+        return cnt
+
+    # Override
+    async def close(self):
+        await self.set_connection(conn=None)
+        docker = self.__docker
+        if docker is not None:
+            self.__docker = None
+            await docker.close()
+
+    # Override
+    async def process(self) -> bool:
+        docker = self.__docker
+        if docker is not None:
+            return await docker.process()
+
+    # Override
+    async def send_data(self, payload: Union[bytes, bytearray]) -> bool:
+        docker = self.__docker
+        if docker is None:
+            # docker not ready
+            return False
+        elif isinstance(docker, WSDocker):
+            ship = docker.pack(payload=payload)
+            return await docker.send_ship(ship=ship)
+        elif isinstance(docker, MTPStreamDocker):
+            # sn = TransactionID.from_data(data=ship.sn)
+            sn = TransactionID.generate()
+            pack = MTPHelper.create_message(body=payload, sn=sn)
+            return await docker.send_package(pack=pack)
+        elif isinstance(docker, MarsStreamDocker):
+            mars = MarsHelper.create_push(payload=payload)
+            ship = MarsStreamDocker.create_departure(mars=mars)
+            return await docker.send_ship(ship=ship)
+        else:
+            # error
+            return await docker.send_data(payload=payload)
+
+    # Override
+    async def heartbeat(self):
+        docker = self.__docker
+        if docker is not None:
+            await docker.heartbeat()
+
+    # Override
+    def pack(self, payload: bytes, priority: int = 0) -> Optional[Departure]:
+        docker = self.__docker
+        if docker is None:
+            return None
+        else:
+            assert isinstance(docker, DeparturePacker), 'docker error: %s' % docker
+        return docker.pack(payload=payload, priority=priority)

{dimples-1.0.0 → dimples-1.0.2}/dimples/conn/gate.py

@@ -45,6 +45,7 @@ from ..utils import Logging
 from .mtp import TransactionID, MTPStreamDocker, MTPHelper
 from .mars import MarsStreamArrival, MarsStreamDocker, MarsHelper
 from .ws import WSDocker
+from .flexible import FlexibleDocker
 
 
 H = TypeVar('H')
@@ -112,7 +113,9 @@ class CommonGate(StarGate, Logging, Generic[H], ABC):
     async def send_response(self, payload: bytes, ship: Arrival,
                             remote: SocketAddress, local: Optional[SocketAddress]) -> bool:
         worker = self._get_docker(remote=remote, local=local)
-        if isinstance(worker, MTPStreamDocker):
+        if isinstance(worker, FlexibleDocker):
+            return await worker.send_data(payload=payload)
+        elif isinstance(worker, MTPStreamDocker):
             # sn = TransactionID.from_data(data=ship.sn)
             sn = TransactionID.generate()
             pack = MTPHelper.create_message(body=payload, sn=sn)
@@ -204,16 +207,11 @@ class TCPServerGate(CommonGate, Generic[H]):
     def _create_docker(self, parties: List[bytes],
                        remote: SocketAddress, local: Optional[SocketAddress]) -> Docker:
         count = len(parties)
-        if count == 0:
-            # return MTPStreamDocker(remote=remote, local=local, gate=self)
-            assert False, 'data empty'
-        data = parties[0]
-        for i in range(1, count):
-            data = data + parties[i]
-        if len(data) == 0:
-            assert False, 'data empty'
+        data = b'' if count == 0 else parties[count - 1]
         # check data format before creating docker
-        if MTPStreamDocker.check(data=data):
+        if len(data) == 0:
+            docker = FlexibleDocker(remote=remote, local=local)
+        elif MTPStreamDocker.check(data=data):
             docker = MTPStreamDocker(remote=remote, local=local)
         elif MarsStreamDocker.check(data=data):
             docker = MarsStreamDocker(remote=remote, local=local)
@@ -233,7 +231,7 @@ class UDPServerGate(CommonGate, Generic[H]):
         count = len(parties)
         if count == 0:
             # return MTPStreamDocker(remote=remote, local=local, gate=self)
-            assert False, 'data empty'
+            assert False, 'data empty: %s -> %s' % (remote, local)
         data = parties[count - 1]
         # check data format before creating docker
         if MTPStreamDocker.check(data=data):

{dimples-1.0.0 → dimples-1.0.2}/dimples/conn/gatekeeper.py

@@ -276,7 +276,7 @@ class GateKeeper(Runner, DockerDelegate, Logging):
             self.error(msg='gate error, failed to send data')
         return ok
 
-    async def _docker_pack(self, payload: bytes, priority: int = 0) -> Departure:
+    async def _docker_pack(self, payload: bytes, priority: int = 0) -> Optional[Departure]:
         docker = await self.gate.fetch_docker([], remote=self.remote_address, local=None)
         assert isinstance(docker, DeparturePacker), 'departure packer error: %s' % docker
         return docker.pack(payload=payload, priority=priority)

{dimples-1.0.0 → dimples-1.0.2}/dimples/conn/mars.py

@@ -292,7 +292,7 @@ class MarsStreamDocker(PlainDocker, DeparturePacker):
         pass
 
     # Override
-    def pack(self, payload: bytes, priority: int = 0) -> Departure:
+    def pack(self, payload: bytes, priority: int = 0) -> Optional[Departure]:
         mars = MarsHelper.create_push(payload=payload)
         return self.create_departure(mars=mars, priority=priority)
 

{dimples-1.0.0 → dimples-1.0.2}/dimples/conn/mtp.py

@@ -197,7 +197,7 @@ class MTPStreamDocker(PackageDocker, DeparturePacker):
         return MTPHelper.respond_message(sn=sn, pages=pages, index=index, body=OK)
 
     # Override
-    def pack(self, payload: bytes, priority: int = 0) -> Departure:
+    def pack(self, payload: bytes, priority: int = 0) -> Optional[Departure]:
         pkg = MTPHelper.create_message(body=payload)
         return self._create_departure(pack=pkg, priority=priority)
 

{dimples-1.0.0 → dimples-1.0.2}/dimples/conn/protocol/__init__.py

@@ -28,7 +28,8 @@
 # SOFTWARE.
 # ==============================================================================
 
-from abc import ABC
+from abc import ABC, abstractmethod
+from typing import Optional
 
 from startrek import Departure
 
@@ -38,7 +39,8 @@ from .mars import NetMsg, NetMsgHead, NetMsgSeq
 
 class DeparturePacker(ABC):
 
-    def pack(self, payload: bytes, priority: int = 0) -> Departure:
+    @abstractmethod
+    def pack(self, payload: bytes, priority: int = 0) -> Optional[Departure]:
         raise NotImplemented
 
 

{dimples-1.0.0 → dimples-1.0.2}/dimples/conn/protocol/ws.py

@@ -172,7 +172,7 @@ class WebSocket:
                 mask = None
             # 4. get payload
             if stream_len < pos + msg_len:
-                Log.info(msg='incomplete ws package for payload: %d' % stream_len)
+                Log.info(msg='incomplete ws package for payload: %d, msg len: %d' % (stream_len, msg_len))
                 return None, stream
             payload = stream[pos:pos+msg_len]
             pos += msg_len

{dimples-1.0.0 → dimples-1.0.2}/dimples/conn/session.py

@@ -87,7 +87,8 @@ class BaseSession(GateKeeper, Session, ABC):
     # Override
     async def queue_message_package(self, msg: ReliableMessage, data: bytes, priority: int = 0) -> bool:
         ship = await self._docker_pack(payload=data, priority=priority)
-        return self._queue_append(msg=msg, ship=ship)
+        if ship is not None:
+            return self._queue_append(msg=msg, ship=ship)
 
     #
     #   Transmitter

{dimples-1.0.0 → dimples-1.0.2}/dimples/conn/ws.py

@@ -217,7 +217,7 @@ class WSDocker(PlainDocker, DeparturePacker):
         pass
 
     # Override
-    def pack(self, payload: bytes, priority: int = 0) -> Departure:
+    def pack(self, payload: bytes, priority: int = 0) -> Optional[Departure]:
         req_pack = WebSocket.pack(payload=payload)
         return WSDeparture(package=req_pack, payload=payload, priority=priority)
 

{dimples-1.0.0 → dimples-1.0.2}/dimples/database/dos/base.py

@@ -23,12 +23,12 @@
 # SOFTWARE.
 # ==============================================================================
 
-import os
 from typing import Optional, Union
 
 from ...utils import template_replace
 from ...utils import Log
-from ...utils import File, TextFile, JSONFile
+from ...utils import Path
+from ...utils import TextFile, JSONFile
 
 
 """
@@ -69,7 +69,7 @@ class Storage:
             return template
         else:
             # relative path
-            return os.path.join(self._public, template)
+            return Path.join(self._public, template)
 
     def private_path(self, template: str):
         """ replace '{PRIVATE}' with private directory """
@@ -82,11 +82,7 @@ class Storage:
             return template
         else:
             # relative path
-            return os.path.join(self._public, template)
-
-    @classmethod
-    def exists(cls, path: str) -> bool:
-        return File(path=path).exists(path=path)
+            return Path.join(self._public, template)
 
     @classmethod
     def read_text(cls, path: str) -> Optional[str]:
@@ -123,13 +119,6 @@ class Storage:
         except Exception as error:
             Log.error(msg='Storage >\t%s' % error)
 
-    @classmethod
-    def remove(cls, path: str) -> bool:
-        try:
-            return File(path=path).remove()
-        except Exception as error:
-            Log.error(msg='Storage >\t%s' % error)
-
     #
     #  Logging
     #

{dimples-1.0.0 → dimples-1.0.2}/dimples/edge/octopus.py

@@ -380,10 +380,15 @@ def create_messenger(facebook: ClientFacebook, database: MessageDBI,
 def create_terminal(messenger: OctopusMessenger) -> Terminal:
     terminal = Terminal(messenger=messenger)
     messenger.terminal = terminal
-    Runner.async_run(coroutine=terminal.start())
+    thr = threading.Thread(target=_start_terminal, args=(terminal,))
+    thr.start()
     return terminal
 
 
+def _start_terminal(terminal: Terminal):
+    Runner.sync_run(main=terminal.start())
+
+
 async def update_station(station: Station, database: SessionDBI):
     Log.info(msg='update station: %s' % station)
     # SP ID

{dimples-1.0.0 → dimples-1.0.2}/dimples/edge/shared.py

@@ -31,10 +31,10 @@ from typing import Optional, Tuple
 from dimsdk import ID, Station
 
 from ..utils import Singleton, Config
+from ..utils import Path
 from ..common import AccountDBI, MessageDBI, SessionDBI
 from ..common import ProviderInfo
 from ..database import AccountDatabase, MessageDatabase, SessionDatabase
-from ..database import Storage
 from ..client import ClientSession, ClientFacebook, ClientArchivist
 
 
@@ -85,7 +85,7 @@ def create_config(app_name: str, default_config: str) -> Config:
     # check config filepath
     if ini_file is None:
         ini_file = default_config
-    if not Storage.exists(path=ini_file):
+    if not Path.exists(path=ini_file):
         show_help(cmd=cmd, app_name=app_name, default_config=default_config)
         print('')
         print('!!! config file not exists: %s' % ini_file)

{dimples-1.0.0 → dimples-1.0.2}/dimples/register/run.py

@@ -37,8 +37,8 @@ path = os.path.dirname(path)
 sys.path.insert(0, path)
 
 from dimples.utils import Log, Config
+from dimples.utils import Path
 from dimples.utils import Runner
-from dimples.database import Storage
 
 from dimples.register.shared import GlobalVariable
 from dimples.register.shared import create_database
@@ -93,7 +93,7 @@ async def main():
     # check config filepath
     if ini_file is None:
         ini_file = DEFAULT_CONFIG
-    if not Storage.exists(path=ini_file):
+    if not Path.exists(path=ini_file):
         show_help()
         print('')
         print('!!! config file not exists: %s' % ini_file)

{dimples-1.0.0 → dimples-1.0.2}/dimples/server/session.py

@@ -37,7 +37,6 @@
 
 import socket
 import traceback
-import weakref
 from typing import Optional, List, Tuple
 
 from dimsdk import ID, EntityType
@@ -45,7 +44,6 @@ from dimsdk import ReliableMessage
 
 from startrek import Docker, DockerStatus
 from startrek import Arrival, Departure
-from startrek.net.channel import is_closed
 
 from ..utils import Log, Runner
 from ..utils import hex_encode, random_bytes
@@ -85,7 +83,6 @@ class ServerSession(BaseSession):
 
     def __init__(self, remote: Tuple[str, int], sock: socket.socket, database: SessionDBI):
         super().__init__(remote=remote, sock=sock, database=database)
-        self.__sock = weakref.ref(sock)
         self.__key = generate_session_key()
 
     @property
@@ -109,15 +106,6 @@ class ServerSession(BaseSession):
             Runner.async_run(coroutine=load_cached_messages(session=self))
             return True
 
-    @property  # Override
-    def running(self) -> bool:
-        if super().running:
-            # gate = self.gate
-            # conn = gate.get_channel(remote=self.remote_address, local=None)
-            # return not (conn is None or conn.closed)
-            sock = self.__sock()
-            return not (sock is None or is_closed(sock=sock))
-
     # Override
     async def start(self):
         await super().start()

{dimples-1.0.0 → dimples-1.0.2}/dimples/station/shared.py

@@ -31,12 +31,12 @@ from typing import Optional, Tuple
 from dimsdk import ID
 
 from ..utils import Singleton, Config
+from ..utils import Path
 from ..common import AddressNameServer, ANSFactory
 from ..common import CommonFacebook, CommonMessenger
 from ..common import AccountDBI, MessageDBI, SessionDBI
 from ..common import ProviderInfo
 from ..database import AccountDatabase, MessageDatabase, SessionDatabase
-from ..database import Storage
 from ..server import ServerArchivist
 from ..server import ServerSession
 from ..server import ServerMessenger
@@ -93,7 +93,7 @@ def create_config(app_name: str, default_config: str) -> Config:
     # check config filepath
     if ini_file is None:
         ini_file = default_config
-    if not Storage.exists(path=ini_file):
+    if not Path.exists(path=ini_file):
         show_help(cmd=cmd, app_name=app_name, default_config=default_config)
         print('')
         print('!!! config file not exists: %s' % ini_file)

{dimples-1.0.0 → dimples-1.0.2}/dimples/utils/__init__.py

@@ -50,12 +50,12 @@ from dimsdk import DocumentHelper
 
 from dimplugins.crypto.aes import random_bytes
 
+from startrek.fsm import Singleton
 from startrek.fsm import Runnable, Runner, Daemon, DaemonRunner
 from startrek.fsm import Delegate as StateDelegate
 from startrek.net.channel import get_remote_address, get_local_address
 
 
-from .singleton import Singleton
 from .log import Log, Logging
 from .dos import Path, File, TextFile, JSONFile
 from .cache import CachePool, CacheHolder, CacheManager

{dimples-1.0.0 → dimples-1.0.2}/dimples/utils/cache.py

@@ -31,11 +31,10 @@
 
 from typing import TypeVar, Generic, Optional, Dict, Set, Tuple
 
+from startrek.fsm import Singleton
 from startrek.fsm import Runnable, Runner, Daemon
 from dimsdk import DateTime
 
-from .singleton import Singleton
-
 
 K = TypeVar('K')
 V = TypeVar('V')