dimples 1.4.2__tar.gz → 1.5.1__tar.gz

{dimples-1.4.2 → dimples-1.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dimples
-Version: 1.4.2
+Version: 1.5.1
 Summary: DIMP Library for Edges and Stations
 Home-page: https://github.com/dimchat/demo-py
 Author: Albert Moky
@@ -36,12 +36,12 @@ License-File: LICENSE
         # 'pycryptodome',  # 3.14.1
         # 'base58',  # 1.0.3
         # 'ecdsa',   # 0.16.1
-        'dimplugins>=2.2.2',
+        'dimplugins>=2.3.0',
 
-        'dimsdk>=2.2.2',
-        # 'dimp>=2.2.2',
-        # 'dkd>=2.2.2',
-        # 'mkm>=2.2.2',
+        'dimsdk>=2.3.0',
+        # 'dimp>=2.3.0',
+        # 'dkd>=2.3.0',
+        # 'mkm>=2.3.0',
 
         'startrek>=2.2.2',
         'tcp>=2.2.2',

{dimples-1.4.2 → dimples-1.5.1}/README.md

@@ -22,12 +22,12 @@
         # 'pycryptodome',  # 3.14.1
         # 'base58',  # 1.0.3
         # 'ecdsa',   # 0.16.1
-        'dimplugins>=2.2.2',
+        'dimplugins>=2.3.0',
 
-        'dimsdk>=2.2.2',
-        # 'dimp>=2.2.2',
-        # 'dkd>=2.2.2',
-        # 'mkm>=2.2.2',
+        'dimsdk>=2.3.0',
+        # 'dimp>=2.3.0',
+        # 'dkd>=2.3.0',
+        # 'mkm>=2.3.0',
 
         'startrek>=2.2.2',
         'tcp>=2.2.2',

{dimples-1.4.2 → dimples-1.5.1}/dimples/__init__.py

@@ -108,6 +108,12 @@ __all__ = [
     'BaseDataWrapper',
     'BaseFileWrapper',
 
+    #
+    #   Algorithm
+    #
+    'AsymmetricAlgorithms', 'SymmetricAlgorithms',
+    'EncodeAlgorithms',
+
     #
     #   MingKeMing
     #
@@ -118,6 +124,8 @@ __all__ = [
     'Meta',
     'Document', 'Visa', 'Bulletin',
 
+    'MetaType', 'DocumentType',
+
     'AddressFactory',
     'IDFactory',
     'MetaFactory',
@@ -211,7 +219,7 @@ __all__ = [
 
     'ServiceProvider', 'Station', 'Bot',
 
-    'MemberType',
+    # 'MemberType',
 
     'MetaUtils', 'DocumentUtils',
 
@@ -238,7 +246,7 @@ __all__ = [
     'TwinsHelper',
 
     'AddressNameService',
-    'Archivist',
+    # 'Archivist',
     'Facebook', 'Messenger',
     'MessageProcessor', 'MessagePacker',
 
@@ -322,7 +330,7 @@ __all__ = [
     #
     ####################################
 
-    'MetaType',
+    'MetaVersion',
     'Password',
     'BroadcastUtils',
 

{dimples-1.4.2 → dimples-1.5.1}/dimples/client/checker.py

@@ -246,6 +246,6 @@ class ClientChecker(EntityChecker, Logging):
             self.debug(msg='visa response not expired yet: %s' % receiver)
             return False
         self.info(msg='push visa document: %s => %s' % (me, receiver))
-        content = DocumentCommand.response(document=visa, identifier=me)
+        content = DocumentCommand.response(identifier=me, meta=None, documents=[visa])
         _, r_msg = await messenger.send_content(content=content, sender=me, receiver=receiver, priority=1)
         return r_msg is not None

{dimples-1.4.2 → dimples-1.5.1}/dimples/client/cpu/creator.py

@@ -28,7 +28,7 @@
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 """
 
-from typing import Optional, Union
+from typing import Optional
 
 from dimsdk import ContentType
 from dimsdk import Command, GroupCommand
@@ -55,18 +55,20 @@ from .customized import CustomizedContentProcessor
 class ClientContentProcessorCreator(BaseContentProcessorCreator):
 
     # Override
-    def create_content_processor(self, msg_type: Union[int, ContentType]) -> Optional[ContentProcessor]:
+    def create_content_processor(self, msg_type: str) -> Optional[ContentProcessor]:
         # application customized
-        if msg_type == ContentType.APPLICATION.value or msg_type == ContentType.CUSTOMIZED.value:
+        if msg_type == ContentType.APPLICATION or msg_type == 'application':
             return CustomizedContentProcessor(facebook=self.facebook, messenger=self.messenger)
-        # history
-        if msg_type == ContentType.HISTORY.value:
+        if msg_type == ContentType.CUSTOMIZED or msg_type == 'customized':
+            return CustomizedContentProcessor(facebook=self.facebook, messenger=self.messenger)
+        # history command
+        if msg_type == ContentType.HISTORY or msg_type == 'history':
             return HistoryCommandProcessor(facebook=self.facebook, messenger=self.messenger)
         # others
         return super().create_content_processor(msg_type=msg_type)
 
     # Override
-    def create_command_processor(self, msg_type: Union[int, ContentType], cmd: str) -> Optional[ContentProcessor]:
+    def create_command_processor(self, msg_type: str, cmd: str) -> Optional[ContentProcessor]:
         # receipt
         if cmd == Command.RECEIPT:
             return ReceiptCommandProcessor(facebook=self.facebook, messenger=self.messenger)

{dimples-1.4.2 → dimples-1.5.1}/dimples/client/cpu/group.py

@@ -169,10 +169,10 @@ class GroupCommandProcessor(HistoryCommandProcessor):
         if expired:
             text = 'Command expired.'
             errors = self._respond_receipt(text=text, content=content, envelope=r_msg.envelope, extra={
-                'template': 'Group command expired: ${cmd}, group: ${ID}.',
+                'template': 'Group command expired: ${cmd}, group: ${gid}.',
                 'replacements': {
                     'cmd': content.cmd,
-                    'ID': str(group),
+                    'gid': str(group),
                 }
             })
             group = None
@@ -189,9 +189,9 @@ class GroupCommandProcessor(HistoryCommandProcessor):
         if len(members) == 0:
             text = 'Command error.'
             errors = self._respond_receipt(text=text, content=content, envelope=r_msg.envelope, extra={
-                'template': 'Group members empty: ${ID}.',
+                'template': 'Group members empty: ${gid}.',
                 'replacements': {
-                    'ID': str(group),
+                    'gid': str(group),
                 }
             })
         else:
@@ -209,9 +209,9 @@ class GroupCommandProcessor(HistoryCommandProcessor):
             # TODO: query group members?
             text = 'Group empty.'
             errors = self._respond_receipt(text=text, content=content, envelope=r_msg.envelope, extra={
-                'template': 'Group empty: ${ID}.',
+                'template': 'Group empty: ${gid}.',
                 'replacements': {
-                    'ID': str(group),
+                    'gid': str(group),
                 }
             })
         else:

{dimples-1.4.2 → dimples-1.5.1}/dimples/client/cpu/grp_invite.py

@@ -83,9 +83,9 @@ class InviteCommandProcessor(GroupCommandProcessor):
         if not is_member:
             text = 'Permission denied.'
             return self._respond_receipt(text=text, content=content, envelope=r_msg.envelope, extra={
-                'template': 'Not allowed to invite member into group: ${ID}',
+                'template': 'Not allowed to invite member into group: ${gid}',
                 'replacements': {
-                    'ID': str(group),
+                    'gid': str(group),
                 }
             })
 
@@ -117,7 +117,7 @@ class InviteCommandProcessor(GroupCommandProcessor):
             #        if we received the 'invite' command here, maybe it was confused,
             #        anyway, we just append the new members directly.
             self.warning(msg='invited by administrator: %s, group: %s' % (sender, group))
-            content['added'] = ID.revert(added_list)
+            content['added'] = ID.revert(identifiers=added_list)
         else:
             # DB error?
             assert False, 'failed to save members for group: %s' % group

{dimples-1.4.2 → dimples-1.5.1}/dimples/client/cpu/grp_query.py

@@ -72,9 +72,9 @@ class QueryCommandProcessor(GroupCommandProcessor):
         if not can_query:
             text = 'Permission denied.'
             return self._respond_receipt(text=text, content=content, envelope=r_msg.envelope, extra={
-                'template': 'Not allowed to query members of group: ${ID}',
+                'template': 'Not allowed to query members of group: ${gid}',
                 'replacements': {
-                    'ID': str(group),
+                    'gid': str(group),
                 }
             })
 
@@ -90,9 +90,9 @@ class QueryCommandProcessor(GroupCommandProcessor):
                 # group history not updated
                 text = 'Group history not updated.'
                 return self._respond_receipt(text=text, content=content, envelope=r_msg.envelope, extra={
-                    'template': 'Group history not updated: ${ID}, last time: ${time}',
+                    'template': 'Group history not updated: ${gid}, last time: ${time}',
                     'replacements': {
-                        'ID': str(group),
+                        'gid': str(group),
                         'time': last_time.timestamp,
                     }
                 })

{dimples-1.4.2 → dimples-1.5.1}/dimples/client/cpu/grp_quit.py

@@ -72,17 +72,17 @@ class QuitCommandProcessor(GroupCommandProcessor):
         if is_owner:
             text = 'Permission denied.'
             return self._respond_receipt(text=text, content=content, envelope=r_msg.envelope, extra={
-                'template': 'Owner cannot quit from group: ${ID}',
+                'template': 'Owner cannot quit from group: ${gid}',
                 'replacements': {
-                    'ID': str(group),
+                    'gid': str(group),
                 }
             })
         if is_admin:
             text = 'Permission denied.'
             return self._respond_receipt(text=text, content=content, envelope=r_msg.envelope, extra={
-                'template': 'Administrator cannot quit from group: ${ID}',
+                'template': 'Administrator cannot quit from group: ${gid}',
                 'replacements': {
-                    'ID': str(group),
+                    'gid': str(group),
                 }
             })
         if is_member:

{dimples-1.4.2 → dimples-1.5.1}/dimples/client/cpu/grp_reset.py

@@ -77,18 +77,18 @@ class ResetCommandProcessor(GroupCommandProcessor):
         if not can_reset:
             text = 'Permission denied.'
             return self._respond_receipt(text=text, content=content, envelope=r_msg.envelope, extra={
-                'template': 'Not allowed to reset members of group: ${ID}',
+                'template': 'Not allowed to reset members of group: ${gid}',
                 'replacements': {
-                    'ID': str(group),
+                    'gid': str(group),
                 }
             })
         # 2.1. check owner
         if owner != new_members[0]:
             text = 'Permission denied.'
             return self._respond_receipt(text=text, content=content, envelope=r_msg.envelope, extra={
-                'template': 'Owner must be the first member of group: ${ID}',
+                'template': 'Owner must be the first member of group: ${gid}',
                 'replacements': {
-                    'ID': str(group),
+                    'gid': str(group),
                 }
             })
         # 2.2. check admins
@@ -100,9 +100,9 @@ class ResetCommandProcessor(GroupCommandProcessor):
         if expel_admin:
             text = 'Permission denied.'
             return self._respond_receipt(text=text, content=content, envelope=r_msg.envelope, extra={
-                'template': 'Not allowed to expel administrator of group: ${ID}',
+                'template': 'Not allowed to expel administrator of group: ${gid}',
                 'replacements': {
-                    'ID': str(group),
+                    'gid': str(group),
                 }
             })
 
@@ -118,9 +118,9 @@ class ResetCommandProcessor(GroupCommandProcessor):
         elif await self._save_members(members=new_members, group=group):
             self.info(msg='new members saved in group: %s' % group)
             if len(add_list) > 0:
-                content['added'] = ID.revert(add_list)
+                content['added'] = ID.revert(identifiers=add_list)
             if len(remove_list) > 0:
-                content['removed'] = ID.revert(remove_list)
+                content['removed'] = ID.revert(identifiers=remove_list)
         else:
             # DB error?
             assert False, 'failed to save members for group: %s' % group

{dimples-1.4.2 → dimples-1.5.1}/dimples/client/cpu/grp_resign.py

@@ -71,9 +71,9 @@ class ResignCommandProcessor(GroupCommandProcessor):
         if is_owner:
             text = 'Permission denied.'
             return self._respond_receipt(text=text, content=content, envelope=r_msg.envelope, extra={
-                'template': 'Owner cannot resign from group: ${ID}',
+                'template': 'Owner cannot resign from group: ${gid}',
                 'replacements': {
-                    'ID': str(group),
+                    'gid': str(group),
                 }
             })
         if is_admin:

{dimples-1.4.2 → dimples-1.5.1}/dimples/client/facebook.py

@@ -34,7 +34,7 @@ from typing import Optional, List
 
 from dimsdk import EntityType
 from dimsdk import ID, Document, Bulletin
-from dimsdk import User, Group
+from dimsdk import Group
 
 from ..utils import Runner
 from ..common import BroadcastUtils
@@ -45,31 +45,11 @@ from ..group import SharedGroupManager
 class ClientFacebook(CommonFacebook):
 
     # Override
-    def cache_group(self, group: Group):
-        group.data_source = SharedGroupManager()
-        super().cache_group(group=group)
-
-    # Override
-    async def select_user(self, receiver: ID) -> Optional[User]:
-        if receiver.is_user:
-            return await super().select_user(receiver=receiver)
-        # group message(recipient not designated)
-        assert receiver.is_group, 'receiver error: %s' % receiver
-        # the messenger will check group info before decrypting message,
-        # so we can trust that the group's meta & members MUST exist here.
-        users = await self.archivist.local_users
-        if users is None or len(users) == 0:
-            self.error(msg='local users should not be empty')
-            return None
-        elif receiver.is_broadcast:
-            # broadcast message can decrypt by anyone, so just return current user
-            return users[0]
-        members = await self.get_members(identifier=receiver)
-        # assert len(members) > 0, 'members not found: %s' % receiver
-        for item in users:
-            if item.identifier in members:
-                # DISCUSS: set this item to be current user?
-                return item
+    async def get_group(self, identifier: ID) -> Optional[Group]:
+        group = await super().get_group(identifier=identifier)
+        if group is not None:
+            group.data_source = SharedGroupManager()
+        return group
 
     # Override
     async def save_document(self, document: Document) -> bool:

{dimples-1.4.2 → dimples-1.5.1}/dimples/client/network/session.py

@@ -61,7 +61,7 @@ class ClientSession(BaseSession):
                 A random string generated by station.
                 It will be set after handshake success.
 
-        'ID' - Local User ID
+        'did' - Local User ID
                 It will be set before connecting to remote station.
                 When it's empty, the session state would be 'Default'.
 

{dimples-1.4.2 → dimples-1.5.1}/dimples/client/packer.py

@@ -90,7 +90,7 @@ class ClientMessagePacker(CommonMessagePacker):
         error = {
             'message': 'encrypt keys not found',
             'group': str(receiver),
-            'members': ID.revert(array=waiting),
+            'members': ID.revert(identifiers=waiting),
         }
         self.messenger.suspend_instant_message(msg=msg, error=error)
         # perhaps some members have already disappeared,

{dimples-1.4.2 → dimples-1.5.1}/dimples/common/__init__.py

@@ -34,6 +34,7 @@ from .dbi import *
 
 from .anonymous import Anonymous
 from .register import Register
+from .ans import AddressNameService
 from .ans import AddressNameServer, ANSFactory
 
 from .checker import EntityChecker
@@ -48,7 +49,7 @@ from .session import Transmitter, Session
 
 __all__ = [
 
-    'MetaType',
+    'MetaVersion',
     'Password',
     'BroadcastUtils',
 
@@ -91,7 +92,9 @@ __all__ = [
     #
 
     'Anonymous',
-    'AddressNameServer', 'ANSFactory',
+    'AddressNameService',
+    'AddressNameServer',
+    'ANSFactory',
 
     'EntityChecker',
     'CommonArchivist',

{dimples-1.4.2 → dimples-1.5.1}/dimples/common/ans.py

@@ -30,11 +30,68 @@
     A map for short name to ID, just like DNS
 """
 
+from abc import ABC, abstractmethod
 from typing import Optional, List, Dict
 
 from dimsdk import Address, ID, IDFactory
 from dimsdk import ANYONE, EVERYONE, FOUNDER
-from dimsdk import AddressNameService
+
+
+class AddressNameService(ABC):
+
+    #
+    #   Reserved names
+    #
+    KEYWORDS = [
+        "all", "everyone", "anyone", "owner", "founder",
+        # --------------------------------
+        "dkd", "mkm", "dimp", "dim", "dimt",
+        "rsa", "ecc", "aes", "des", "btc", "eth",
+        # --------------------------------
+        "crypto", "key", "symmetric", "asymmetric",
+        "public", "private", "secret", "password",
+        "id", "address", "meta",
+        "tai", "document", "profile", "visa", "bulletin",
+        "entity", "user", "group", "contact",
+        # --------------------------------
+        "member", "admin", "administrator", "assistant",
+        "main", "polylogue", "chatroom",
+        "social", "organization",
+        "company", "school", "government", "department",
+        "provider", "station", "thing", "bot", "robot",
+        # --------------------------------
+        "message", "instant", "secure", "reliable",
+        "envelope", "sender", "receiver", "time",
+        "content", "forward", "command", "history",
+        "keys", "data", "signature",
+        # --------------------------------
+        "type", "serial", "sn",
+        "text", "file", "image", "audio", "video", "page",
+        "handshake", "receipt", "block", "mute",
+        "register", "suicide", "found", "abdicate",
+        "invite", "expel", "join", "quit", "reset", "query",
+        "hire", "fire", "resign",
+        # --------------------------------
+        "server", "client", "terminal", "local", "remote",
+        "barrack", "cache", "transceiver",
+        "ans", "facebook", "store", "messenger",
+        "root", "supervisor",
+    ]
+
+    @abstractmethod
+    def is_reserved(self, name: str) -> bool:
+        # return name in self.KEYWORDS
+        raise NotImplemented
+
+    @abstractmethod
+    def identifier(self, name: str) -> Optional[ID]:
+        """ Get ID by short name """
+        raise NotImplemented
+
+    @abstractmethod
+    def names(self, identifier: ID) -> List[str]:
+        """ Get all short names mapping to the same ID """
+        raise NotImplemented
 
 
 class AddressNameServer(AddressNameService):

dimples-1.5.1/dimples/common/archivist.py

@@ -0,0 +1,106 @@
+# -*- coding: utf-8 -*-
+#
+#   DIM-SDK : Decentralized Instant Messaging Software Development Kit
+#
+#                                Written in 2023 by Moky <albert.moky@gmail.com>
+#
+# ==============================================================================
+# MIT License
+#
+# Copyright (c) 2023 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.
+# ==============================================================================
+
+import weakref
+from typing import List, Optional
+
+from dimsdk import ID
+from dimsdk import User, Group
+from dimsdk import Facebook
+from dimsdk import Barrack
+
+from ..utils import Logging
+from ..utils import ThanosCache
+
+from .dbi import AccountDBI
+
+
+class CommonArchivist(Barrack, Logging):
+
+    def __init__(self, facebook: Facebook, database: AccountDBI):
+        super().__init__()
+        self.__barrack = weakref.ref(facebook)
+        self.__database = database
+        # memory caches
+        self.__user_cache = ThanosCache()   # ID -> User
+        self.__group_cache = ThanosCache()  # ID -> Group
+
+    @property
+    def facebook(self) -> Optional[Facebook]:
+        return self.__barrack()
+
+    @property
+    def database(self) -> AccountDBI:
+        return self.__database
+
+    def reduce_memory(self):
+        cnt1 = self.__user_cache.reduce_memory()
+        cnt2 = self.__group_cache.reduce_memory()
+        return cnt1 + cnt2
+
+    #
+    #   Barrack
+    #
+
+    # Override
+    def cache_user(self, user: User):
+        if user.data_source is None:
+            user.data_source = self.facebook
+        self.__user_cache.put(key=user.identifier, value=user)
+
+    # Override
+    def cache_group(self, group: Group):
+        if group.data_source is None:
+            group.data_source = self.facebook
+        self.__group_cache.put(key=group.identifier, value=group)
+
+    # Override
+    def get_user(self, identifier: ID):
+        return self.__user_cache.get(key=identifier)
+
+    # Override
+    def get_group(self, identifier: ID):
+        return self.__group_cache.get(key=identifier)
+
+    @property  # Override
+    async def local_users(self) -> List[User]:
+        facebook = self.facebook
+        array = await self.database.get_local_users()
+        if facebook is None or array is None:
+            return []
+        all_users = []
+        for item in array:
+            # assert await facebook.private_key_for_signature(identifier=item) is not None
+            user = await facebook.get_user(identifier=item)
+            if user is not None:
+                all_users.append(user)
+            else:
+                assert False, 'failed to create user: %s' % item
+        return all_users

{dimples-1.4.2 → dimples-1.5.1}/dimples/common/compat/__init__.py

@@ -41,7 +41,7 @@ from .meta import CompatibleMetaFactory
 from .loader import CommonLoader
 from .loader import CommonPluginLoader
 
-from .compatible import Compatible
+from .compatible import Compatible, CompatibleIncoming, CompatibleOutgoing
 
 
 __all__ = [
@@ -59,6 +59,6 @@ __all__ = [
     'CommonLoader',
     'CommonPluginLoader',
 
-    'Compatible',
+    'Compatible', 'CompatibleIncoming', 'CompatibleOutgoing',
 
 ]

{dimples-1.4.2 → dimples-1.5.1}/dimples/common/compat/address.py

@@ -30,13 +30,14 @@
 
 from typing import Optional
 
-from dimsdk.core import thanos
 from dimsdk import ConstantString
 from dimsdk import EntityType
 from dimsdk import Address, ANYWHERE, EVERYWHERE
 from dimplugins import BTCAddress, ETHAddress
 from dimplugins import BaseAddressFactory
 
+from ...utils.thanos import thanos
+
 
 class CompatibleAddressFactory(BaseAddressFactory):