dimples 0.5.5__tar.gz → 0.5.7__tar.gz

{dimples-0.5.5 → dimples-0.5.7}/PKG-INFO

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

{dimples-0.5.5 → dimples-0.5.7}/dimples/client/network/state.py

@@ -136,12 +136,15 @@ class SessionState(BaseState[StateMachine, StateTransition]):
     def enter_time(self) -> float:
         return self.__time
 
+    # Override
     def __str__(self) -> str:
         return self.__name
 
+    # Override
     def __repr__(self) -> str:
         return self.__name
 
+    # Override
     def __eq__(self, other) -> bool:
         if isinstance(other, SessionState):
             if self is other:
@@ -156,6 +159,7 @@ class SessionState(BaseState[StateMachine, StateTransition]):
         else:
             return False
 
+    # Override
     def __ne__(self, other) -> bool:
         if isinstance(other, SessionState):
             if self is other:

{dimples-0.5.5 → dimples-0.5.7}/dimples/common/dbi/session.py

@@ -63,10 +63,12 @@ class ProviderInfo:
         self.identifier = identifier
         self.chosen = chosen
 
+    # Override
     def __str__(self) -> str:
         clazz = self.__class__.__name__
         return '<%s ID="%s" chosen=%d />' % (clazz, self.identifier, self.chosen)
 
+    # Override
     def __repr__(self) -> str:
         clazz = self.__class__.__name__
         return '<%s ID="%s" chosen=%d />' % (clazz, self.identifier, self.chosen)
@@ -94,11 +96,13 @@ class StationInfo:
         self.provider = provider
         self.chosen = chosen
 
+    # Override
     def __str__(self) -> str:
         clazz = self.__class__.__name__
         return '<%s host="%s" port=%d ID="%s" SP="%s" chosen=%d />' % (clazz, self.host, self.port, self.identifier,
                                                                        self.provider, self.chosen)
 
+    # Override
     def __repr__(self) -> str:
         clazz = self.__class__.__name__
         return '<%s host="%s" port=%d ID="%s" SP="%s" chosen=%d />' % (clazz, self.host, self.port, self.identifier,

{dimples-0.5.5 → dimples-0.5.7}/dimples/common/session.py

@@ -114,10 +114,12 @@ class Session(Transmitter, ABC):
         """ Update active flag and return True on changed """
         raise NotImplemented
 
+    # Override
     def __str__(self) -> str:
         clazz = self.__class__.__name__
         return '<%s:%s %s|%s active=%s />' % (clazz, self.key, self.remote_address, self.identifier, self.active)
 
+    # Override
     def __repr__(self) -> str:
         clazz = self.__class__.__name__
         return '<%s:%s %s|%s active=%s />' % (clazz, self.key, self.remote_address, self.identifier, self.active)

{dimples-0.5.5 → dimples-0.5.7}/dimples/conn/protocol/mars.py

@@ -94,10 +94,12 @@ class NetMsgHead:
         self.__options = options
         self.__body_length = body_len
 
+    # Override
     def __str__(self) -> str:
         cname = self.__class__.__name__
         return '<%s: %d| cmd=%d, seq=%d, body_len=%d />' % (cname, self.version, self.cmd, self.seq, self.body_length)
 
+    # Override
     def __repr__(self) -> str:
         cname = self.__class__.__name__
         return '<%s: %d| cmd=%d, seq=%d, body_len=%d />' % (cname, self.version, self.cmd, self.seq, self.body_length)
@@ -198,11 +200,13 @@ class NetMsg:
         self.__head = head
         self.__body = body
 
+    # Override
     def __str__(self) -> str:
         mod = self.__module__
         cname = self.__class__.__name__
         return '<%s body_len=%d>%s</%s module="%s">' % (cname, self.body_length, self.head, cname, mod)
 
+    # Override
     def __repr__(self) -> str:
         mod = self.__module__
         cname = self.__class__.__name__

{dimples-0.5.5 → dimples-0.5.7}/dimples/conn/session.py

@@ -50,6 +50,16 @@ class BaseSession(GateKeeper, Session, ABC):
         self.__identifier: Optional[ID] = None
         self.__messenger: Optional[weakref.ReferenceType] = None
 
+    # Override
+    def __str__(self) -> str:
+        cname = self.__class__.__name__
+        return '<%s id="%s" remote="%s" key="%s" />' % (cname, self.identifier, self.remote_address, self.key)
+
+    # Override
+    def __repr__(self):
+        cname = self.__class__.__name__
+        return '<%s id="%s" remote="%s" key="%s" />' % (cname, self.identifier, self.remote_address, self.key)
+
     @property  # Override
     def database(self) -> SessionDBI:
         return self.__database

{dimples-0.5.5 → dimples-0.5.7}/dimples/edge/octopus.py

@@ -190,35 +190,64 @@ class Octopus(Runner, Logging):
 
     def income_message(self, msg: ReliableMessage, priority: int = 0) -> List[ReliableMessage]:
         """ redirect message from remote station """
+        sender = msg.sender
+        receiver = msg.receiver
         sig = get_msg_sig(msg=msg)
         messenger = self.inner_messenger
         if messenger.send_reliable_message(msg=msg, priority=priority):
-            self.info(msg='redirected msg (%s) for receiver (%s)' % (sig, msg.receiver))
+            self.info(msg='redirected msg (%s): %s -> %s' % (sig, sender, receiver))
         else:
-            self.error(msg='failed to redirect msg (%s) for receiver (%s)' % (sig, msg.receiver))
+            self.error(msg='failed to redirect msg (%s): %s -> %s' % (sig, sender, receiver))
         # no need to respond receipt for station
         return []
 
     def outgo_message(self, msg: ReliableMessage, priority: int = 0) -> List[ReliableMessage]:
         """ redirect message to remote station """
-        target = ID.parse(identifier=msg.get('neighbor'))
-        if target is None:
-            # target station not found
-            self.info(msg='cannot get target station for receiver (%s)' % msg.receiver)
-            return []
-        messenger = self.get_outer_messenger(identifier=target)
-        if messenger is None:
-            # target station not my neighbor
-            self.info(msg='receiver (%s) is targeted to (%s), but not my neighbor' % (msg.receiver, target))
-            return []
-        msg.pop('neighbor', None)
-        if messenger.send_reliable_message(msg=msg, priority=priority):
-            sig = get_msg_sig(msg=msg)
-            self.info(msg='redirected msg (%s) to target (%s) for receiver (%s)' % (sig, target, msg.receiver))
-            # no need to respond receipt for station
-            return []
+        receiver = msg.receiver
+        # get neighbor stations
+        neighbor = ID.parse(identifier=msg.get('neighbor'))
+        if neighbor is not None:
+            neighbors = set()
+            neighbors.add(neighbor)
+            msg.pop('neighbor', None)
+        else:
+            with self.__outer_lock:
+                neighbors = set(self.__outer_map.keys())
+        #
+        #  0. check recipients
+        #
+        new_recipients = set()
+        old_recipients = msg.get('recipients')
+        old_recipients = [] if old_recipients is None else ID.convert(old_recipients)
+        for item in neighbors:
+            if item not in old_recipients:
+                new_recipients.add(item)
+        all_recipients = []
+        for item in old_recipients:
+            all_recipients.append(item)
+        # avoid the new recipients redirect it to same targets
+        self.info(msg='append new recipients: %s, %s => %s' % (receiver, new_recipients, all_recipients))
+        for item in new_recipients:
+            all_recipients.append(item)
+        msg['recipients'] = ID.revert(all_recipients)
+        #
+        #  1. send to the new recipients (neighbor stations)
+        #
         sig = get_msg_sig(msg=msg)
-        self.error(msg='failed to redirect msg (%s) to target (%s) for receiver (%s)' % (sig, target, msg.receiver))
+        failed_neighbors = []
+        for target in new_recipients:
+            messenger = self.get_outer_messenger(identifier=target)
+            if messenger is None:
+                # target station not my neighbor
+                self.warning(msg='not my neighbor: %s (%s)' % (target, receiver))
+                failed_neighbors.append(target)
+            elif messenger.send_reliable_message(msg=msg, priority=priority):
+                self.info(msg='redirected msg (%s) to neighbor: %s (%s)' % (sig, target, receiver))
+            else:
+                self.error(msg='failed to send to neighbor: %s (%s)' % (target, receiver))
+                failed_neighbors.append(target)
+        if len(failed_neighbors) > 0:
+            self.error(msg='failed to redirect msg (%s) for receiver (%s): %s' % (sig, receiver, failed_neighbors))
         return []
 
 

{dimples-0.5.5 → dimples-0.5.7}/dimples/server/archivist.py

@@ -44,7 +44,6 @@ from ..common import CommonArchivist
 from ..common import CommonFacebook, CommonMessenger
 from ..common import StationInfo
 
-from .dispatcher import Dispatcher
 from .session_center import SessionCenter
 
 
@@ -62,6 +61,11 @@ def get_messenger(archivist: CommonArchivist):
     return messenger
 
 
+def get_dispatcher():
+    from .dispatcher import Dispatcher
+    return Dispatcher()
+
+
 class ServerArchivist(CommonArchivist, ABC):
 
     # each respond will be expired after 10 minutes
@@ -95,7 +99,7 @@ class ServerArchivist(CommonArchivist, ABC):
     @property
     def all_stations(self) -> List[StationInfo]:
         """ get stations from database """
-        dispatcher = Dispatcher()
+        dispatcher = get_dispatcher()
         db = dispatcher.sdb
         # TODO: get chosen provider
         providers = db.all_providers()
@@ -136,7 +140,7 @@ class ServerArchivist(CommonArchivist, ABC):
         s_msg = messenger.encrypt_message(msg=i_msg)
         r_msg = messenger.sign_message(msg=s_msg)
         # dispatch
-        dispatcher = Dispatcher()
+        dispatcher = get_dispatcher()
         neighbors = self.all_neighbors
         # avoid the new recipients redirect it to same targets
         r_msg['recipients'] = ID.revert(neighbors)

{dimples-0.5.5 → dimples-0.5.7}/dimples/server/dispatcher.py

@@ -32,13 +32,14 @@
 
 import threading
 from abc import ABC, abstractmethod
-from typing import Optional, List
+from typing import Optional, Set, List
 
-from dimsdk import EntityType, ID
+from dimsdk import EntityType, ID, EVERYONE
+from dimsdk import Station
 from dimsdk import Content, ReceiptCommand
 from dimsdk import ReliableMessage
 
-from ..utils import Singleton, Logging, Runner, Daemon
+from ..utils import Singleton, Log, Logging, Runner, Daemon
 from ..common import CommonFacebook
 from ..common import MessageDBI, SessionDBI
 from ..common import ReliableMessageDBI
@@ -46,6 +47,7 @@ from ..common import LoginCommand
 
 from .session_center import SessionCenter
 from .push import PushCenter
+from .archivist import ServerArchivist
 
 
 class MessageDeliver(ABC):
@@ -64,7 +66,7 @@ class MessageDeliver(ABC):
 
 
 @Singleton
-class Dispatcher(MessageDeliver):
+class Dispatcher(MessageDeliver, Logging):
 
     def __init__(self):
         super().__init__()
@@ -147,7 +149,11 @@ class Dispatcher(MessageDeliver):
     def deliver_message(self, msg: ReliableMessage, receiver: ID) -> List[Content]:
         """ Deliver message to destination """
         worker = self.deliver_worker
-        if receiver.type == EntityType.STATION:
+        if receiver.is_group:
+            # broadcast message to neighbor stations
+            # e.g.: 'stations@everywhere', 'everyone@everywhere'
+            return self.__deliver_group_message(msg=msg, receiver=receiver)
+        elif receiver.type == EntityType.STATION:
             # message to other stations
             # station won't roam to other station, so just push for it directly
             responses = worker.redirect_message(msg=msg, neighbor=receiver)
@@ -181,6 +187,66 @@ class Dispatcher(MessageDeliver):
             # message delivered
             return responses
 
+    def __deliver_group_message(self, msg: ReliableMessage, receiver: ID) -> List[Content]:
+        if receiver == Station.EVERY or receiver == EVERYONE:
+            # broadcast message to neighbor stations
+            # e.g.: 'stations@everywhere', 'everyone@everywhere'
+            archivist = self.facebook.archivist
+            assert isinstance(archivist, ServerArchivist)
+            candidates = archivist.all_neighbors
+            if len(candidates) == 0:
+                self.warning(msg='failed to get neighbors: %s' % receiver)
+                return []
+            self.info(msg='forward to neighbor stations: %s -> %s' % (receiver, candidates))
+            return self.__broadcast_message(msg=msg, receiver=receiver, neighbors=candidates)
+        else:
+            self.warning(msg='unknown group: %s' % receiver)
+            text = 'Group message not allow for this station'
+            res = ReceiptCommand.create(text=text, envelope=msg.envelope)
+            return [res]
+
+    def __broadcast_message(self, msg: ReliableMessage, receiver: ID, neighbors: Set[ID]) -> List[Content]:
+        #
+        #  0. check recipients
+        #
+        new_recipients = set()
+        old_recipients = msg.get('recipients')
+        old_recipients = [] if old_recipients is None else ID.convert(old_recipients)
+        for item in neighbors:
+            if item not in old_recipients:
+                new_recipients.add(item)
+        all_recipients = []
+        for item in old_recipients:
+            all_recipients.append(item)
+        # avoid the new recipients redirect it to same targets
+        self.info(msg='append new recipients: %s, %s => %s' % (receiver, new_recipients, all_recipients))
+        for item in new_recipients:
+            all_recipients.append(item)
+        msg['recipients'] = ID.revert(all_recipients)
+        #
+        #  1. push to neighbor stations directly
+        #
+        indirect_neighbors = set()
+        for target in new_recipients:
+            if session_push(msg=msg, receiver=target) == 0:
+                indirect_neighbors.add(target)
+        if len(indirect_neighbors) > 0:
+            for item in indirect_neighbors:
+                all_recipients.remove(item)
+            msg['recipients'] = ID.revert(all_recipients)
+        #
+        #  2. push to other neighbor stations via station bridge
+        #
+        worker = self.deliver_worker
+        worker.redirect_message(msg=msg, neighbor=None)
+        #
+        #  OK
+        #
+        text = 'Message forwarded.'
+        cmd = ReceiptCommand.create(text=text, envelope=msg.envelope)
+        cmd['recipients'] = ID.revert(new_recipients)
+        return [cmd]
+
     def __save_reliable_message(self, msg: ReliableMessage, receiver: ID) -> bool:
         if receiver.type == EntityType.STATION or msg.sender.type == EntityType.STATION:
             # no need to save station message
@@ -305,7 +371,7 @@ class DeliverWorker(Logging):
         # 3. redirect message to roaming station
         return self.redirect_message(msg=msg, neighbor=roaming)
 
-    def redirect_message(self, msg: ReliableMessage, neighbor: ID) -> Optional[List[Content]]:
+    def redirect_message(self, msg: ReliableMessage, neighbor: Optional[ID]) -> Optional[List[Content]]:
         """
         Redirect message to neighbor station
 
@@ -314,7 +380,7 @@ class DeliverWorker(Logging):
         :return: responses
         """
         """ Redirect message to neighbor station """
-        assert neighbor.type == EntityType.STATION, 'neighbor station ID error: %s' % neighbor
+        assert neighbor is None or neighbor.type == EntityType.STATION, 'neighbor station ID error: %s' % neighbor
         self.info(msg='redirect message %s => %s to neighbor station: %s' % (msg.sender, msg.receiver, neighbor))
         # 0. check current station
         current = self.facebook.current_user.identifier
@@ -325,7 +391,7 @@ class DeliverWorker(Logging):
             # return None to tell the push center to push notification for it.
             return None
         # 1. try to push message to neighbor station directly
-        if session_push(msg=msg, receiver=neighbor) > 0:
+        if neighbor is not None and session_push(msg=msg, receiver=neighbor) > 0:
             text = 'Message redirected.'
             cmd = ReceiptCommand.create(text=text, envelope=msg.envelope)
             cmd['neighbor'] = str(neighbor)
@@ -334,9 +400,10 @@ class DeliverWorker(Logging):
         return bridge_message(msg=msg, neighbor=neighbor, bridge=current)
 
 
-def bridge_message(msg: ReliableMessage, neighbor: ID, bridge: ID) -> Optional[List[Content]]:
+def bridge_message(msg: ReliableMessage, neighbor: Optional[ID], bridge: ID) -> List[Content]:
     """
     Redirect message to neighbor station via the station bridge
+    if neighbor is None, try to broadcast
 
     :param msg:      network message
     :param neighbor: roaming station
@@ -348,16 +415,25 @@ def bridge_message(msg: ReliableMessage, neighbor: ID, bridge: ID) -> Optional[L
     #       be changed to another value before pushing to the bridge.
     # clone = msg.copy_dictionary()
     # msg = ReliableMessage.parse(msg=clone)
-    msg['neighbor'] = str(neighbor)
-    if session_push(msg=msg, receiver=bridge) > 0:
-        text = 'Message redirected.'
-        cmd = ReceiptCommand.create(text=text, envelope=msg.envelope)
-        cmd['neighbor'] = str(neighbor)
-        return [cmd]
+    if neighbor is None:
+        # broadcast to all neighbor stations
+        # except that ones already in msg['recipients']
+        session_push(msg=msg, receiver=bridge)
+        # no need to respond receipt for this broadcast message
+        return []
     else:
+        assert neighbor != bridge, 'cannot bridge cycled message: %s' % neighbor
+        msg['neighbor'] = str(neighbor)
+    # push to the bridge
+    if session_push(msg=msg, receiver=bridge) == 0:
         # station bridge not found
-        # return an empty array to avoid calling push center
+        Log.warning(msg='failed to push message to bridge: %s, drop message: %s -> %s'
+                        % (bridge, msg.sender, msg.receiver))
         return []
+    text = 'Message redirected via station bridge.'
+    cmd = ReceiptCommand.create(text=text, envelope=msg.envelope)
+    cmd['neighbor'] = str(neighbor)
+    return [cmd]
 
 
 def session_push(msg: ReliableMessage, receiver: ID) -> int:

{dimples-0.5.5 → dimples-0.5.7}/dimples/server/processor.py

@@ -56,7 +56,6 @@ from .cpu import DocumentCommandProcessor
 
 from .packer import FilterManager
 from .dispatcher import Dispatcher
-from .archivist import ServerArchivist
 
 
 class ServerMessageProcessor(CommonMessageProcessor):
@@ -195,49 +194,18 @@ class ServerMessageProcessor(CommonMessageProcessor):
             if bot is None:
                 self.warning(msg='failed to get receiver: %s' % receiver)
                 return False
-            candidates = set()
-            candidates.add(bot)
-            self.info(msg='forward to station bot: %s -> %s' % (name, bot))
-        elif receiver == Station.EVERY or receiver == EVERYONE:
-            # broadcast message to neighbor stations
-            # e.g.: 'stations@everywhere', 'everyone@everywhere'
-            archivist = self.facebook.archivist
-            assert isinstance(archivist, ServerArchivist)
-            candidates = archivist.all_neighbors
-            if len(candidates) == 0:
-                self.warning(msg='failed to get neighbors: %s' % receiver)
+            elif bot == sender:
+                self.warning(msg='skip cycled message: %s -> %s' % (sender, receiver))
                 return False
-            self.info(msg='forward to neighbor stations: %s -> %s' % (receiver, candidates))
-        else:
-            self.warning(msg='unknown receiver: %s' % receiver)
-            return False
-        # check recipients
-        new_recipients = candidates.copy()
-        old_recipients = msg.get('recipients')
-        if old_recipients is None:
-            all_recipients = []
-        else:
-            all_recipients = ID.convert(old_recipients)
-            # check duplicated
-            self.info(msg='discard recipients: %s, new recipients: %s' % (old_recipients, new_recipients))
-            for item in all_recipients:
-                new_recipients.discard(item)
-            if len(new_recipients) == 0:
-                self.info(msg='new recipients empty: %s => %s' % (receiver, candidates))
+            elif bot == station:
+                self.warning(msg='skip current station: %s -> %s' % (sender, receiver))
                 return False
-        self.info(msg='append new recipients: %s, %s => %s' % (receiver, new_recipients, all_recipients))
-        for item in new_recipients:
-            all_recipients.append(item)
-        # avoid the new recipients redirect it to same targets
-        msg['recipients'] = ID.revert(all_recipients)
-        # dispatch
-        dispatcher = Dispatcher()
-        for target in new_recipients:
-            if target == sender or target == station:
-                self.info(msg='skip cycled message: %s -> %s, %s' % (sender, receiver, target))
             else:
-                dispatcher.deliver_message(msg=msg, receiver=target)
-        return True
+                self.info(msg='forward to bot: %s -> %s' % (name, bot))
+                receiver = bot
+        # deliver by dispatcher
+        dispatcher = Dispatcher()
+        dispatcher.deliver_message(msg=msg, receiver=receiver)
 
     def _split_group_message(self, msg: ReliableMessage, station: ID):
         """ redirect group message to assistant """

{dimples-0.5.5 → dimples-0.5.7}/dimples/utils/config.py

@@ -42,10 +42,12 @@ class Node(Dictionary):
         if port > 0:
             self['port'] = port
 
+    # Override
     def __str__(self) -> str:
         clazz = self.__class__.__name__
         return '<%s host="%s" port=%d name="%s" />' % (clazz, self.host, self.port, self.name)
 
+    # Override
     def __repr__(self) -> str:
         clazz = self.__class__.__name__
         return '<%s host="%s" port=%d name="%s" />' % (clazz, self.host, self.port, self.name)

{dimples-0.5.5 → dimples-0.5.7}/dimples.egg-info/PKG-INFO

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

{dimples-0.5.5 → dimples-0.5.7}/setup.py

@@ -14,7 +14,7 @@ import io
 
 from setuptools import setup, find_packages
 
-__version__ = '0.5.5'
+__version__ = '0.5.7'
 __author__ = 'Albert Moky'
 __contact__ = 'albert.moky@gmail.com'