dimp 2.3.1__tar.gz → 2.3.3__tar.gz

{dimp-2.3.1 → dimp-2.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dimp
-Version: 2.3.1
+Version: 2.3.3
 Summary: Decentralized Instant Messaging Protocol
 Home-page: https://github.com/dimchat/core-py
 Author: Albert Moky
@@ -45,8 +45,9 @@ License-File: LICENSE
   3. (S-C) handshake success
 
 ```python
+from abc import ABC, abstractmethod
 from enum import IntEnum
-from typing import Optional, Any, Dict
+from typing import Optional, Dict
 
 from dimp import Command, BaseCommand
 
@@ -58,7 +59,20 @@ class HandshakeState(IntEnum):
     Success = 3  # S -> C, handshake accepted
 
 
-class HandshakeCommand(BaseCommand):
+def handshake_state(title: str, session: str = None) -> HandshakeState:
+    # Server -> Client
+    if title == 'DIM!':  # or title == 'OK!':
+        return HandshakeState.Success
+    if title == 'DIM?':
+        return HandshakeState.Again
+    # Client -> Server: "Hello world!"
+    if session is None or len(session) == 0:
+        return HandshakeState.Start
+    else:
+        return HandshakeState.Restart
+
+
+class HandshakeCommand(Command, ABC):
     """
         Handshake Command
         ~~~~~~~~~~~~~~~~~
@@ -74,37 +88,24 @@ class HandshakeCommand(BaseCommand):
     """
     HANDSHAKE = 'handshake'
 
-    def __init__(self, content: Dict[str, Any] = None, title: str = None, session: str = None):
-        if content is None:
-            # 1. new command with title & session key
-            assert title is not None, 'handshake command error: %s' % session
-            cmd = self.HANDSHAKE
-            super().__init__(cmd=cmd)
-            self['title'] = title
-            self['message'] = title  # TODO: remove after all clients upgraded
-            if session is not None:
-                self['session'] = session
-        else:
-            # 2. command info from network
-            assert title is None and session is None, 'params error: %s, %s, %s' % (content, title, session)
-            super().__init__(content)
-
     @property
+    @abstractmethod
     def title(self) -> str:
-        # TODO: modify after all clients upgraded
-        text = self.get_str(key='title', default=None)
-        if text is None:
-            # compatible with v1.0
-            text = self.get_str(key='message', default='')
-        return text
+        raise NotImplemented
 
     @property
+    @abstractmethod
     def session(self) -> Optional[str]:
-        return self.get_str(key='session', default=None)
+        raise NotImplemented
 
     @property
+    @abstractmethod
     def state(self) -> HandshakeState:
-        return handshake_state(title=self.title, session=self.session)
+        raise NotImplemented
+
+    #
+    #   Factories
+    #
 
     @classmethod
     def offer(cls, session: str = None) -> Command:
@@ -114,7 +115,7 @@ class HandshakeCommand(BaseCommand):
         :param session: Old session key
         :return: HandshakeCommand object
         """
-        return HandshakeCommand(title='Hello world!', session=session)
+        return BaseHandshakeCommand(title='Hello world!', session=session)
 
     @classmethod
     def ask(cls, session: str) -> Command:
@@ -124,7 +125,7 @@ class HandshakeCommand(BaseCommand):
         :param session: New session key
         :return: HandshakeCommand object
         """
-        return HandshakeCommand(title='DIM?', session=session)
+        return BaseHandshakeCommand(title='DIM?', session=session)
 
     @classmethod
     def accepted(cls, session: str = None) -> Command:
@@ -133,7 +134,7 @@ class HandshakeCommand(BaseCommand):
 
         :return: HandshakeCommand object
         """
-        return HandshakeCommand(title='DIM!', session=session)
+        return BaseHandshakeCommand(title='DIM!', session=session)
 
     start = offer       # (1. C->S) first handshake, without session
     again = ask         # (2. S->C) ask client to handshake with new session key
@@ -141,17 +142,34 @@ class HandshakeCommand(BaseCommand):
     success = accepted  # (4. S->C) notice the client that handshake accepted
 
 
-def handshake_state(title: str, session: str = None) -> HandshakeState:
-    # Server -> Client
-    if title == 'DIM!':  # or title == 'OK!':
-        return HandshakeState.Success
-    if title == 'DIM?':
-        return HandshakeState.Again
-    # Client -> Server: "Hello world!"
-    if session is None or len(session) == 0:
-        return HandshakeState.Start
-    else:
-        return HandshakeState.Restart
+class BaseHandshakeCommand(BaseCommand, HandshakeCommand):
+
+    def __init__(self, content: Dict = None, title: str = None, session: str = None):
+        if content is None:
+            # 1. new command with title & session key
+            assert title is not None, 'handshake command error: %s' % session
+            cmd = self.HANDSHAKE
+            super().__init__(cmd=cmd)
+            self['title'] = title
+            self['message'] = title  # TODO: remove after all clients upgraded
+            if session is not None:
+                self['session'] = session
+        else:
+            # 2. command info from network
+            assert title is None and session is None, 'params error: %s, %s, %s' % (content, title, session)
+            super().__init__(content)
+
+    @property
+    def title(self) -> str:
+        return self.get_str(key='title', default='')
+
+    @property
+    def session(self) -> Optional[str]:
+        return self.get_str(key='session')
+
+    @property
+    def state(self) -> HandshakeState:
+        return handshake_state(title=self.title, session=self.session)
 ```
 
 ### extends Content
@@ -165,13 +183,13 @@ from dimp import Content
 from dimp import BaseContent
 
 
-class CustomizedContent(Content, ABC):
+class AppContent(Content, ABC):
     """
         Application Customized message
         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
         data format: {
-            type : 0xCC,
+            type : 0xA0,
             sn   : 123,
 
             app   : "{APP_ID}",  // application (e.g.: "chat.dim.sechat")
@@ -199,22 +217,25 @@ class CustomizedContent(Content, ABC):
         """ Action Name """
         raise NotImplemented
 
+    #
+    #   Factory
+    #
     @classmethod
     def create(cls, app: str, mod: str, act: str):
-        return AppCustomizedContent(app=app, mod=mod, act=act)
+        return ApplicationContent(app=app, mod=mod, act=act)
 
 
-class AppCustomizedContent(BaseContent, CustomizedContent):
+class ApplicationContent(BaseContent, AppContent):
 
     def __init__(self, content: Dict[str, Any] = None,
-                 msg_type: int = None,
+                 msg_type: str = None,
                  app: str = None, mod: str = None, act: str = None):
         if content is None:
             # 1. new content with type, application, module & action
             assert app is not None and mod is not None and act is not None, \
                 'customized content error: %s, %s, %s, %s' % (msg_type, app, mod, act)
             if msg_type is None:
-                msg_type = ContentType.CUSTOMIZED.value
+                msg_type = ContentType.APPLICATION
             super().__init__(None, msg_type)
             self['app'] = app
             self['mod'] = mod
@@ -244,5 +265,5 @@ class AppCustomizedContent(BaseContent, CustomizedContent):
 
 ----
 
-Copyright © 2018 Albert Moky
+Copyright © 2018-2025 Albert Moky
 [![Followers](https://img.shields.io/github/followers/moky)](https://github.com/moky?tab=followers)

{dimp-2.3.1 → dimp-2.3.3}/README.md

@@ -31,8 +31,9 @@
   3. (S-C) handshake success
 
 ```python
+from abc import ABC, abstractmethod
 from enum import IntEnum
-from typing import Optional, Any, Dict
+from typing import Optional, Dict
 
 from dimp import Command, BaseCommand
 
@@ -44,7 +45,20 @@ class HandshakeState(IntEnum):
     Success = 3  # S -> C, handshake accepted
 
 
-class HandshakeCommand(BaseCommand):
+def handshake_state(title: str, session: str = None) -> HandshakeState:
+    # Server -> Client
+    if title == 'DIM!':  # or title == 'OK!':
+        return HandshakeState.Success
+    if title == 'DIM?':
+        return HandshakeState.Again
+    # Client -> Server: "Hello world!"
+    if session is None or len(session) == 0:
+        return HandshakeState.Start
+    else:
+        return HandshakeState.Restart
+
+
+class HandshakeCommand(Command, ABC):
     """
         Handshake Command
         ~~~~~~~~~~~~~~~~~
@@ -60,37 +74,24 @@ class HandshakeCommand(BaseCommand):
     """
     HANDSHAKE = 'handshake'
 
-    def __init__(self, content: Dict[str, Any] = None, title: str = None, session: str = None):
-        if content is None:
-            # 1. new command with title & session key
-            assert title is not None, 'handshake command error: %s' % session
-            cmd = self.HANDSHAKE
-            super().__init__(cmd=cmd)
-            self['title'] = title
-            self['message'] = title  # TODO: remove after all clients upgraded
-            if session is not None:
-                self['session'] = session
-        else:
-            # 2. command info from network
-            assert title is None and session is None, 'params error: %s, %s, %s' % (content, title, session)
-            super().__init__(content)
-
     @property
+    @abstractmethod
     def title(self) -> str:
-        # TODO: modify after all clients upgraded
-        text = self.get_str(key='title', default=None)
-        if text is None:
-            # compatible with v1.0
-            text = self.get_str(key='message', default='')
-        return text
+        raise NotImplemented
 
     @property
+    @abstractmethod
     def session(self) -> Optional[str]:
-        return self.get_str(key='session', default=None)
+        raise NotImplemented
 
     @property
+    @abstractmethod
     def state(self) -> HandshakeState:
-        return handshake_state(title=self.title, session=self.session)
+        raise NotImplemented
+
+    #
+    #   Factories
+    #
 
     @classmethod
     def offer(cls, session: str = None) -> Command:
@@ -100,7 +101,7 @@ class HandshakeCommand(BaseCommand):
         :param session: Old session key
         :return: HandshakeCommand object
         """
-        return HandshakeCommand(title='Hello world!', session=session)
+        return BaseHandshakeCommand(title='Hello world!', session=session)
 
     @classmethod
     def ask(cls, session: str) -> Command:
@@ -110,7 +111,7 @@ class HandshakeCommand(BaseCommand):
         :param session: New session key
         :return: HandshakeCommand object
         """
-        return HandshakeCommand(title='DIM?', session=session)
+        return BaseHandshakeCommand(title='DIM?', session=session)
 
     @classmethod
     def accepted(cls, session: str = None) -> Command:
@@ -119,7 +120,7 @@ class HandshakeCommand(BaseCommand):
 
         :return: HandshakeCommand object
         """
-        return HandshakeCommand(title='DIM!', session=session)
+        return BaseHandshakeCommand(title='DIM!', session=session)
 
     start = offer       # (1. C->S) first handshake, without session
     again = ask         # (2. S->C) ask client to handshake with new session key
@@ -127,17 +128,34 @@ class HandshakeCommand(BaseCommand):
     success = accepted  # (4. S->C) notice the client that handshake accepted
 
 
-def handshake_state(title: str, session: str = None) -> HandshakeState:
-    # Server -> Client
-    if title == 'DIM!':  # or title == 'OK!':
-        return HandshakeState.Success
-    if title == 'DIM?':
-        return HandshakeState.Again
-    # Client -> Server: "Hello world!"
-    if session is None or len(session) == 0:
-        return HandshakeState.Start
-    else:
-        return HandshakeState.Restart
+class BaseHandshakeCommand(BaseCommand, HandshakeCommand):
+
+    def __init__(self, content: Dict = None, title: str = None, session: str = None):
+        if content is None:
+            # 1. new command with title & session key
+            assert title is not None, 'handshake command error: %s' % session
+            cmd = self.HANDSHAKE
+            super().__init__(cmd=cmd)
+            self['title'] = title
+            self['message'] = title  # TODO: remove after all clients upgraded
+            if session is not None:
+                self['session'] = session
+        else:
+            # 2. command info from network
+            assert title is None and session is None, 'params error: %s, %s, %s' % (content, title, session)
+            super().__init__(content)
+
+    @property
+    def title(self) -> str:
+        return self.get_str(key='title', default='')
+
+    @property
+    def session(self) -> Optional[str]:
+        return self.get_str(key='session')
+
+    @property
+    def state(self) -> HandshakeState:
+        return handshake_state(title=self.title, session=self.session)
 ```
 
 ### extends Content
@@ -151,13 +169,13 @@ from dimp import Content
 from dimp import BaseContent
 
 
-class CustomizedContent(Content, ABC):
+class AppContent(Content, ABC):
     """
         Application Customized message
         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
         data format: {
-            type : 0xCC,
+            type : 0xA0,
             sn   : 123,
 
             app   : "{APP_ID}",  // application (e.g.: "chat.dim.sechat")
@@ -185,22 +203,25 @@ class CustomizedContent(Content, ABC):
         """ Action Name """
         raise NotImplemented
 
+    #
+    #   Factory
+    #
     @classmethod
     def create(cls, app: str, mod: str, act: str):
-        return AppCustomizedContent(app=app, mod=mod, act=act)
+        return ApplicationContent(app=app, mod=mod, act=act)
 
 
-class AppCustomizedContent(BaseContent, CustomizedContent):
+class ApplicationContent(BaseContent, AppContent):
 
     def __init__(self, content: Dict[str, Any] = None,
-                 msg_type: int = None,
+                 msg_type: str = None,
                  app: str = None, mod: str = None, act: str = None):
         if content is None:
             # 1. new content with type, application, module & action
             assert app is not None and mod is not None and act is not None, \
                 'customized content error: %s, %s, %s, %s' % (msg_type, app, mod, act)
             if msg_type is None:
-                msg_type = ContentType.CUSTOMIZED.value
+                msg_type = ContentType.APPLICATION
             super().__init__(None, msg_type)
             self['app'] = app
             self['mod'] = mod
@@ -230,5 +251,5 @@ class AppCustomizedContent(BaseContent, CustomizedContent):
 
 ----
 
-Copyright © 2018 Albert Moky
+Copyright © 2018-2025 Albert Moky
 [![Followers](https://img.shields.io/github/followers/moky)](https://github.com/moky?tab=followers)

{dimp-2.3.1 → dimp-2.3.3}/dimp/__init__.py

@@ -34,7 +34,7 @@ from mkm.crypto import *
 from mkm import *
 from dkd import *
 
-from .protocol.commands import CommandFactory
+from .protocol.base import CommandFactory
 from .protocol import *
 from .crypto import *
 from .mkm import *
@@ -119,6 +119,8 @@ __all__ = [
     'Meta',
     'Document', 'Visa', 'Bulletin',
 
+    'MetaType', 'DocumentType',
+
     'AddressFactory',
     'IDFactory',
     'MetaFactory',
@@ -132,8 +134,6 @@ __all__ = [
     'BaseMeta',
     'BaseDocument', 'BaseVisa', 'BaseBulletin',
 
-    'MetaType', 'DocumentType',
-
     #
     #   DaoKeDao
     #
@@ -145,11 +145,12 @@ __all__ = [
     'InstantMessage', 'SecureMessage', 'ReliableMessage',
 
     # contents
-    'TextContent', 'ArrayContent', 'ForwardContent',
-    'PageContent', 'NameCard',
+    'TextContent', 'PageContent', 'NameCard',
+    'ForwardContent', 'CombineContent', 'ArrayContent',
     'FileContent', 'ImageContent', 'AudioContent', 'VideoContent',
     'MoneyContent', 'TransferContent',
-    'QuoteContent', 'CombineContent',
+    'QuoteContent',
+    'CustomizedContent',
 
     # commands
     'Command',
@@ -163,11 +164,12 @@ __all__ = [
 
     # extend contents
     'BaseContent',
-    'BaseTextContent', 'ListContent', 'SecretContent',
-    'WebPageContent', 'NameCardContent',
+    'BaseTextContent', 'WebPageContent', 'NameCardContent',
+    'SecretContent', 'CombineForwardContent', 'ListContent',
     'BaseFileContent', 'ImageFileContent', 'AudioFileContent', 'VideoFileContent',
     'BaseMoneyContent', 'TransferMoneyContent',
-    'BaseQuoteContent', 'CombineForwardContent',
+    'BaseQuoteContent',
+    'AppCustomizedContent',
 
     # extend commands
     'BaseCommand',

{dimp-2.3.1 → dimp-2.3.3}/dimp/crypto/keys.py

@@ -29,9 +29,9 @@
 # ==============================================================================
 
 from abc import ABC
-from typing import Any, Dict
+from typing import Dict
 
-from mkm.types import Dictionary
+from mkm.types import Mapper, Dictionary
 from mkm.crypto import CryptographyKey, EncryptKey, DecryptKey, SignKey, VerifyKey
 from mkm.crypto import SymmetricKey, AsymmetricKey, PublicKey, PrivateKey
 from mkm.plugins import SharedCryptoExtensions
@@ -46,7 +46,7 @@ from mkm.plugins import SharedCryptoExtensions
 # noinspection PyAbstractClass
 class BaseKey(Dictionary, CryptographyKey, ABC):
 
-    def __init__(self, key: Dict[str, Any]):
+    def __init__(self, key: Dict):
         super().__init__(dictionary=key)
 
     @property  # Override
@@ -58,9 +58,9 @@ class BaseKey(Dictionary, CryptographyKey, ABC):
     #
 
     @classmethod
-    def get_key_algorithm(cls, key: Dict[str, Any]) -> str:
+    def get_key_algorithm(cls, key: Dict) -> str:
         ext = SharedCryptoExtensions()
-        algorithm = ext.helper.get_key_algorithm(key=key, default=None)
+        algorithm = ext.helper.get_key_algorithm(key=key)
         return '' if algorithm is None else algorithm
 
     @classmethod
@@ -97,20 +97,32 @@ class BaseKey(Dictionary, CryptographyKey, ABC):
 # noinspection PyAbstractClass
 class BaseSymmetricKey(Dictionary, SymmetricKey, ABC):
 
-    def __init__(self, key: Dict[str, Any]):
+    def __init__(self, key: Dict):
         super().__init__(dictionary=key)
 
     # Override
     def __eq__(self, other) -> bool:
-        if isinstance(other, SymmetricKey):
-            return BaseKey.symmetric_keys_equal(other, self)
+        if isinstance(other, Mapper):
+            if self is other:
+                # same object
+                return True
+            elif isinstance(other, SymmetricKey):
+                return BaseKey.symmetric_keys_equal(other, self)
+            # compare with inner map
+            other = other.dictionary
+        return self.dictionary.__eq__(other)
 
     # Override
     def __ne__(self, other) -> bool:
-        if isinstance(other, SymmetricKey):
-            return not BaseKey.symmetric_keys_equal(other, self)
-        else:
-            return True
+        if isinstance(other, Mapper):
+            if self is other:
+                # same object
+                return False
+            elif isinstance(other, SymmetricKey):
+                return not BaseKey.symmetric_keys_equal(other, self)
+            # compare with inner map
+            other = other.dictionary
+        return self.dictionary.__ne__(other)
 
     @property  # Override
     def algorithm(self) -> str:
@@ -124,7 +136,7 @@ class BaseSymmetricKey(Dictionary, SymmetricKey, ABC):
 # noinspection PyAbstractClass
 class BaseAsymmetricKey(Dictionary, AsymmetricKey, ABC):
 
-    def __init__(self, key: Dict[str, Any]):
+    def __init__(self, key: Dict):
         super().__init__(dictionary=key)
 
     @property  # Override
@@ -135,7 +147,7 @@ class BaseAsymmetricKey(Dictionary, AsymmetricKey, ABC):
 # noinspection PyAbstractClass
 class BasePublicKey(Dictionary, PublicKey, ABC):
 
-    def __init__(self, key: Dict[str, Any]):
+    def __init__(self, key: Dict):
         super().__init__(dictionary=key)
 
     @property  # Override
@@ -150,20 +162,32 @@ class BasePublicKey(Dictionary, PublicKey, ABC):
 # noinspection PyAbstractClass
 class BasePrivateKey(Dictionary, PrivateKey, ABC):
 
-    def __init__(self, key: Dict[str, Any]):
+    def __init__(self, key: Dict):
         super().__init__(dictionary=key)
 
     # Override
     def __eq__(self, other) -> bool:
-        if isinstance(other, PrivateKey):
-            return BaseKey.private_keys_equal(other, self)
+        if isinstance(other, Mapper):
+            if self is other:
+                # same object
+                return True
+            elif isinstance(other, PrivateKey):
+                return BaseKey.private_keys_equal(other, self)
+            # compare with inner map
+            other = other.dictionary
+        return self.dictionary.__eq__(other)
 
     # Override
     def __ne__(self, other) -> bool:
-        if isinstance(other, PrivateKey):
-            return not BaseKey.private_keys_equal(other, self)
-        else:
-            return True
+        if isinstance(other, Mapper):
+            if self is other:
+                # same object
+                return False
+            elif isinstance(other, PrivateKey):
+                return not BaseKey.private_keys_equal(other, self)
+            # compare with inner map
+            other = other.dictionary
+        return self.dictionary.__ne__(other)
 
     @property  # Override
     def algorithm(self) -> str:

{dimp-2.3.1 → dimp-2.3.3}/dimp/crypto/pnf.py

@@ -28,7 +28,7 @@
 # SOFTWARE.
 # ==============================================================================
 
-from typing import Optional, Any, Dict
+from typing import Optional, Dict
 
 from mkm.format import TransportableData
 from mkm.types import URI
@@ -55,7 +55,7 @@ class BaseFileWrapper(Dictionary):
             }
     """
 
-    def __init__(self, dictionary: Dict[str, Any]):
+    def __init__(self, dictionary: Dict):
         super().__init__(dictionary=dictionary)
         # file data (not encrypted)
         self.__attachment: Optional[TransportableData] = None
@@ -100,7 +100,7 @@ class BaseFileWrapper(Dictionary):
 
     @property
     def filename(self) -> Optional[str]:
-        return self.get_str(key='filename', default=None)
+        return self.get_str(key='filename')
 
     @filename.setter
     def filename(self, name: Optional[str]):
@@ -115,11 +115,12 @@ class BaseFileWrapper(Dictionary):
 
     @property
     def url(self) -> Optional[URI]:
-        if self.__url is None:
-            remote = self.get_str(key='URL', default=None)
+        remote = self.__url
+        if remote is None:
+            remote = self.get_str(key='URL')
             # TODO: convert str to URI
             self.__url = remote
-        return self.__url
+        return remote
 
     @url.setter
     def url(self, remote: Optional[URI]):
@@ -136,10 +137,12 @@ class BaseFileWrapper(Dictionary):
 
     @property
     def password(self) -> Optional[DecryptKey]:
-        if self.__password is None:
+        key = self.__password
+        if key is None:
             info = self.get('key')
-            self.__password = SymmetricKey.parse(key=info)
-        return self.__password
+            key = SymmetricKey.parse(key=info)
+            self.__password = key
+        return key
 
     @password.setter
     def password(self, key: Optional[DecryptKey]):