dimp 2.1.0__tar.gz → 2.2.2__tar.gz

dimp-2.2.2/PKG-INFO

@@ -0,0 +1,248 @@
+Metadata-Version: 2.1
+Name: dimp
+Version: 2.2.2
+Summary: Decentralized Instant Messaging Protocol
+Home-page: https://github.com/dimchat/core-py
+Author: Albert Moky
+Author-email: albert.moky@gmail.com
+License: MIT
+Description: # Decentralized Instant Messaging Protocol (Python)
+        
+        [![License](https://img.shields.io/github/license/dimchat/core-py)](https://github.com/dimchat/core-py/blob/master/LICENSE)
+        [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/dimchat/core-py/pulls)
+        [![Platform](https://img.shields.io/badge/Platform-Python%203-brightgreen.svg)](https://github.com/dimchat/core-py/wiki)
+        [![Issues](https://img.shields.io/github/issues/dimchat/core-py)](https://github.com/dimchat/core-py/issues)
+        [![Repo Size](https://img.shields.io/github/repo-size/dimchat/core-py)](https://github.com/dimchat/core-py/archive/refs/heads/main.zip)
+        [![Tags](https://img.shields.io/github/tag/dimchat/core-py)](https://github.com/dimchat/core-py/tags)
+        [![Version](https://img.shields.io/pypi/v/dimp)](https://pypi.org/project/dimp)
+        
+        [![Watchers](https://img.shields.io/github/watchers/dimchat/core-py)](https://github.com/dimchat/core-py/watchers)
+        [![Forks](https://img.shields.io/github/forks/dimchat/core-py)](https://github.com/dimchat/core-py/forks)
+        [![Stars](https://img.shields.io/github/stars/dimchat/core-py)](https://github.com/dimchat/core-py/stargazers)
+        [![Followers](https://img.shields.io/github/followers/dimchat)](https://github.com/orgs/dimchat/followers)
+        
+        ## Dependencies
+        
+        | Name | Version | Description |
+        |------|---------|-------------|
+        | [Ming Ke Ming (名可名)](https://github.com/dimchat/mkm-py) | [![Version](https://img.shields.io/pypi/v/mkm)](https://pypi.org/project/mkm) | Decentralized User Identity Authentication |
+        | [Dao Ke Dao (道可道)](https://github.com/dimchat/dkd-py) | [![Version](https://img.shields.io/pypi/v/dkd)](https://pypi.org/project/dkd) | Universal Message Module |
+        
+        ## Examples
+        
+        ### extends Command
+        
+        * _Handshake Command Protocol_
+          0. (C-S) handshake start
+          1. (S-C) handshake again with new session
+          2. (C-S) handshake restart with new session
+          3. (S-C) handshake success
+        
+        ```python
+        from enum import IntEnum
+        from typing import Optional, Any, Dict
+        
+        from dimp import Command, BaseCommand
+        
+        
+        class HandshakeState(IntEnum):
+            Start = 0    # C -> S, without session key(or session expired)
+            Again = 1    # S -> C, with new session key
+            Restart = 2  # C -> S, with new session key
+            Success = 3  # S -> C, handshake accepted
+        
+        
+        class HandshakeCommand(BaseCommand):
+            """
+                Handshake Command
+                ~~~~~~~~~~~~~~~~~
+        
+                data format: {
+                    type : 0x88,
+                    sn   : 123,
+        
+                    command : "handshake",    // command name
+                    title   : "Hello world!", // "DIM?", "DIM!"
+                    session : "{SESSION_ID}", // session key
+                }
+            """
+            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
+            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
+        
+            @property
+            def session(self) -> Optional[str]:
+                return self.get_str(key='session', default=None)
+        
+            @property
+            def state(self) -> HandshakeState:
+                return handshake_state(title=self.title, session=self.session)
+        
+            @classmethod
+            def offer(cls, session: str = None) -> Command:
+                """
+                Create client-station handshake offer
+        
+                :param session: Old session key
+                :return: HandshakeCommand object
+                """
+                return HandshakeCommand(title='Hello world!', session=session)
+        
+            @classmethod
+            def ask(cls, session: str) -> Command:
+                """
+                Create station-client handshake again with new session
+        
+                :param session: New session key
+                :return: HandshakeCommand object
+                """
+                return HandshakeCommand(title='DIM?', session=session)
+        
+            @classmethod
+            def accepted(cls, session: str = None) -> Command:
+                """
+                Create station-client handshake success notice
+        
+                :return: HandshakeCommand object
+                """
+                return HandshakeCommand(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
+            restart = offer     # (3. C->S) handshake with new session key
+            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
+        ```
+        
+        ### extends Content
+        
+        ```python
+        from abc import ABC, abstractmethod
+        from typing import Any, Dict
+        
+        from dimp import ContentType
+        from dimp import Content
+        from dimp import BaseContent
+        
+        
+        class CustomizedContent(Content, ABC):
+            """
+                Application Customized message
+                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+        
+                data format: {
+                    type : 0xCC,
+                    sn   : 123,
+        
+                    app   : "{APP_ID}",  // application (e.g.: "chat.dim.sechat")
+                    mod   : "{MODULE}",  // module name (e.g.: "drift_bottle")
+                    act   : "{ACTION}",  // action name (e.g.: "throw")
+                    extra : info         // action parameters
+                }
+            """
+        
+            @property
+            @abstractmethod
+            def application(self) -> str:
+                """ App ID """
+                raise NotImplemented
+        
+            @property
+            @abstractmethod
+            def module(self) -> str:
+                """ Module Name """
+                raise NotImplemented
+        
+            @property
+            @abstractmethod
+            def action(self) -> str:
+                """ Action Name """
+                raise NotImplemented
+        
+            @classmethod
+            def create(cls, app: str, mod: str, act: str):
+                return AppCustomizedContent(app=app, mod=mod, act=act)
+        
+        
+        class AppCustomizedContent(BaseContent, CustomizedContent):
+        
+            def __init__(self, content: Dict[str, Any] = None,
+                         msg_type: int = 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
+                    super().__init__(None, msg_type)
+                    self['app'] = app
+                    self['mod'] = mod
+                    self['act'] = act
+                else:
+                    # 2. content info from network
+                    assert msg_type is None and app is None and mod is None and act is None, \
+                        'params error: %s, %s, %s, %s, %s' % (content, msg_type, app, mod, act)
+                    super().__init__(content)
+        
+            @property  # Override
+            def application(self) -> str:
+                return self.get_str(key='app', default='')
+        
+            @property  # Override
+            def module(self) -> str:
+                return self.get_str(key='mod', default='')
+        
+            @property  # Override
+            def action(self) -> str:
+                return self.get_str(key='act', default='')
+        ```
+        
+        ### extends ID Address
+        
+        * Examples in [dim plugins](https://pypi.org/project/dimplugins)
+        
+        ----
+        
+        Copyright © 2018 Albert Moky
+        [![Followers](https://img.shields.io/github/followers/moky)](https://github.com/moky?tab=followers)
+        
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown

dimp-2.2.2/README.md

@@ -0,0 +1,234 @@
+# Decentralized Instant Messaging Protocol (Python)
+
+[![License](https://img.shields.io/github/license/dimchat/core-py)](https://github.com/dimchat/core-py/blob/master/LICENSE)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/dimchat/core-py/pulls)
+[![Platform](https://img.shields.io/badge/Platform-Python%203-brightgreen.svg)](https://github.com/dimchat/core-py/wiki)
+[![Issues](https://img.shields.io/github/issues/dimchat/core-py)](https://github.com/dimchat/core-py/issues)
+[![Repo Size](https://img.shields.io/github/repo-size/dimchat/core-py)](https://github.com/dimchat/core-py/archive/refs/heads/main.zip)
+[![Tags](https://img.shields.io/github/tag/dimchat/core-py)](https://github.com/dimchat/core-py/tags)
+[![Version](https://img.shields.io/pypi/v/dimp)](https://pypi.org/project/dimp)
+
+[![Watchers](https://img.shields.io/github/watchers/dimchat/core-py)](https://github.com/dimchat/core-py/watchers)
+[![Forks](https://img.shields.io/github/forks/dimchat/core-py)](https://github.com/dimchat/core-py/forks)
+[![Stars](https://img.shields.io/github/stars/dimchat/core-py)](https://github.com/dimchat/core-py/stargazers)
+[![Followers](https://img.shields.io/github/followers/dimchat)](https://github.com/orgs/dimchat/followers)
+
+## Dependencies
+
+| Name | Version | Description |
+|------|---------|-------------|
+| [Ming Ke Ming (名可名)](https://github.com/dimchat/mkm-py) | [![Version](https://img.shields.io/pypi/v/mkm)](https://pypi.org/project/mkm) | Decentralized User Identity Authentication |
+| [Dao Ke Dao (道可道)](https://github.com/dimchat/dkd-py) | [![Version](https://img.shields.io/pypi/v/dkd)](https://pypi.org/project/dkd) | Universal Message Module |
+
+## Examples
+
+### extends Command
+
+* _Handshake Command Protocol_
+  0. (C-S) handshake start
+  1. (S-C) handshake again with new session
+  2. (C-S) handshake restart with new session
+  3. (S-C) handshake success
+
+```python
+from enum import IntEnum
+from typing import Optional, Any, Dict
+
+from dimp import Command, BaseCommand
+
+
+class HandshakeState(IntEnum):
+    Start = 0    # C -> S, without session key(or session expired)
+    Again = 1    # S -> C, with new session key
+    Restart = 2  # C -> S, with new session key
+    Success = 3  # S -> C, handshake accepted
+
+
+class HandshakeCommand(BaseCommand):
+    """
+        Handshake Command
+        ~~~~~~~~~~~~~~~~~
+
+        data format: {
+            type : 0x88,
+            sn   : 123,
+
+            command : "handshake",    // command name
+            title   : "Hello world!", // "DIM?", "DIM!"
+            session : "{SESSION_ID}", // session key
+        }
+    """
+    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
+    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
+
+    @property
+    def session(self) -> Optional[str]:
+        return self.get_str(key='session', default=None)
+
+    @property
+    def state(self) -> HandshakeState:
+        return handshake_state(title=self.title, session=self.session)
+
+    @classmethod
+    def offer(cls, session: str = None) -> Command:
+        """
+        Create client-station handshake offer
+
+        :param session: Old session key
+        :return: HandshakeCommand object
+        """
+        return HandshakeCommand(title='Hello world!', session=session)
+
+    @classmethod
+    def ask(cls, session: str) -> Command:
+        """
+        Create station-client handshake again with new session
+
+        :param session: New session key
+        :return: HandshakeCommand object
+        """
+        return HandshakeCommand(title='DIM?', session=session)
+
+    @classmethod
+    def accepted(cls, session: str = None) -> Command:
+        """
+        Create station-client handshake success notice
+
+        :return: HandshakeCommand object
+        """
+        return HandshakeCommand(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
+    restart = offer     # (3. C->S) handshake with new session key
+    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
+```
+
+### extends Content
+
+```python
+from abc import ABC, abstractmethod
+from typing import Any, Dict
+
+from dimp import ContentType
+from dimp import Content
+from dimp import BaseContent
+
+
+class CustomizedContent(Content, ABC):
+    """
+        Application Customized message
+        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+        data format: {
+            type : 0xCC,
+            sn   : 123,
+
+            app   : "{APP_ID}",  // application (e.g.: "chat.dim.sechat")
+            mod   : "{MODULE}",  // module name (e.g.: "drift_bottle")
+            act   : "{ACTION}",  // action name (e.g.: "throw")
+            extra : info         // action parameters
+        }
+    """
+
+    @property
+    @abstractmethod
+    def application(self) -> str:
+        """ App ID """
+        raise NotImplemented
+
+    @property
+    @abstractmethod
+    def module(self) -> str:
+        """ Module Name """
+        raise NotImplemented
+
+    @property
+    @abstractmethod
+    def action(self) -> str:
+        """ Action Name """
+        raise NotImplemented
+
+    @classmethod
+    def create(cls, app: str, mod: str, act: str):
+        return AppCustomizedContent(app=app, mod=mod, act=act)
+
+
+class AppCustomizedContent(BaseContent, CustomizedContent):
+
+    def __init__(self, content: Dict[str, Any] = None,
+                 msg_type: int = 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
+            super().__init__(None, msg_type)
+            self['app'] = app
+            self['mod'] = mod
+            self['act'] = act
+        else:
+            # 2. content info from network
+            assert msg_type is None and app is None and mod is None and act is None, \
+                'params error: %s, %s, %s, %s, %s' % (content, msg_type, app, mod, act)
+            super().__init__(content)
+
+    @property  # Override
+    def application(self) -> str:
+        return self.get_str(key='app', default='')
+
+    @property  # Override
+    def module(self) -> str:
+        return self.get_str(key='mod', default='')
+
+    @property  # Override
+    def action(self) -> str:
+        return self.get_str(key='act', default='')
+```
+
+### extends ID Address
+
+* Examples in [dim plugins](https://pypi.org/project/dimplugins)
+
+----
+
+Copyright © 2018 Albert Moky
+[![Followers](https://img.shields.io/github/followers/moky)](https://github.com/moky?tab=followers)

{dimp-2.1.0 → dimp-2.2.2}/dimp/__init__.py

@@ -28,16 +28,19 @@
 # SOFTWARE.
 # ==============================================================================
 
+from mkm.types import *
+from mkm.format import *
+from mkm.crypto import *
+from mkm import *
+from dkd import *
+
+from .protocol.commands import CommandFactory
 from .protocol import *
 from .crypto import *
 from .mkm import *
 from .dkd import *
 from .msg import *
 
-from .barrack import Barrack
-from .transceiver import Transceiver
-from .packer import Packer
-from .processor import Processor
 
 name = "DIMP"
 
@@ -45,19 +48,53 @@ __author__ = 'Albert Moky'
 
 __all__ = [
 
+    'Singleton',
+
     'URI', 'DateTime',
-    'TransportableData', 'PortableNetworkFile',
+
+    'Converter', 'Copier',
+    'Wrapper', 'Stringer', 'Mapper',
+    'ConstantString',  # 'String',
+    'Dictionary',
+
+    #
+    #   Format
+    #
+
+    'DataCoder', 'Hex', 'Base58', 'Base64',
+    'ObjectCoder', 'JSON',
+    'MapCoder', 'JSONMap',
+    'ListCoder', 'JSONList',
+    'StringCoder', 'UTF8',
+
+    'hex_encode', 'hex_decode',
+    'base58_encode', 'base58_decode',
+    'base64_encode', 'base64_decode',
+    'json_encode', 'json_decode',
+    'utf8_encode', 'utf8_decode',
+
+    'TransportableData', 'TransportableDataFactory',
+    'PortableNetworkFile', 'PortableNetworkFileFactory',
+
+    #
+    #   Digest
+    #
+
+    'DataDigester',
+    'MD5', 'SHA1', 'SHA256', 'KECCAK256', 'RIPEMD160',
+
+    'md5', 'sha1', 'sha256', 'keccak256', 'ripemd160',
 
     #
     #   Crypto
     #
 
-    'CryptographyKey', 'EncryptKey', 'DecryptKey',
-    'AsymmetricKey', 'SignKey', 'VerifyKey',
-    'SymmetricKey', 'SymmetricKeyFactory',
-    'PublicKey', 'PublicKeyFactory',
-    'PrivateKey', 'PrivateKeyFactory',
-    'CryptographyKeyGeneralFactory', 'CryptographyKeyFactoryManager',
+    'CryptographyKey',
+    'EncryptKey', 'DecryptKey', 'SignKey', 'VerifyKey',
+    'SymmetricKey', 'AsymmetricKey',
+    'PrivateKey', 'PublicKey',
+
+    'SymmetricKeyFactory', 'PrivateKeyFactory', 'PublicKeyFactory',
 
     'BaseKey', 'BaseSymmetricKey',
     'BaseAsymmetricKey', 'BasePublicKey', 'BasePrivateKey',
@@ -69,79 +106,82 @@ __all__ = [
     #   MingKeMing
     #
 
-    'EntityType', 'MetaType',
-    'Address', 'AddressFactory',
-    'ID', 'IDFactory',
-    'Meta', 'MetaFactory',
-    'Document', 'DocumentFactory',
-    'Visa', 'Bulletin',
+    'EntityType',
+    'Address',
+    'ID',
+    'Meta',
+    'Document', 'Visa', 'Bulletin',
 
-    'BroadcastAddress',
-    'Identifier',
-    'AccountGeneralFactory', 'AccountFactoryManager',
-    'ANYWHERE', 'EVERYWHERE', 'ANYONE', 'EVERYONE', 'FOUNDER',
-    'BaseMeta', 'MetaHelper',
-    'BaseDocument', 'BaseVisa', 'BaseBulletin',
+    'AddressFactory',
+    'IDFactory',
+    'MetaFactory',
+    'DocumentFactory',
 
-    'EntityDelegate',
-    'Entity', 'EntityDataSource', 'BaseEntity',
-    'User', 'UserDataSource', 'BaseUser',
-    'Group', 'GroupDataSource', 'BaseGroup',
+    'Identifier',
+    'ANYONE', 'EVERYONE', 'FOUNDER',
+    'ANYWHERE', 'EVERYWHERE',
+    # 'BroadcastAddress',
 
-    'DocumentHelper', 'BroadcastHelper',  # 'thanos',
+    'BaseMeta',
+    'BaseDocument', 'BaseVisa', 'BaseBulletin',
 
     #
     #   DaoKeDao
     #
 
-    'ContentType', 'Content', 'ContentFactory',
-    'Envelope', 'EnvelopeFactory',
+    'ContentType',
+    'Content',
+    'Envelope',
     'Message',
-    'InstantMessage', 'InstantMessageFactory',
-    'SecureMessage', 'SecureMessageFactory',
-    'ReliableMessage', 'ReliableMessageFactory',
-
-    'InstantMessageDelegate', 'SecureMessageDelegate', 'ReliableMessageDelegate',
-    'MessageGeneralFactory', 'MessageFactoryManager',
+    'InstantMessage', 'SecureMessage', 'ReliableMessage',
 
+    # contents
     'TextContent', 'ArrayContent', 'ForwardContent',
     'PageContent', 'NameCard',
     'FileContent', 'ImageContent', 'AudioContent', 'VideoContent',
     'MoneyContent', 'TransferContent',
-    'CustomizedContent',
+    'QuoteContent', 'CombineContent',
 
-    'Command', 'CommandFactory',
+    # commands
+    'Command',
     'MetaCommand', 'DocumentCommand',
     'ReceiptCommand',
 
+    # group history
     'HistoryCommand', 'GroupCommand',
     'InviteCommand', 'ExpelCommand', 'JoinCommand', 'QuitCommand', 'QueryCommand', 'ResetCommand',
     'HireCommand', 'FireCommand', 'ResignCommand',
 
+    # extend contents
     'BaseContent',
     'BaseTextContent', 'ListContent', 'SecretContent',
     'WebPageContent', 'NameCardContent',
     'BaseFileContent', 'ImageFileContent', 'AudioFileContent', 'VideoFileContent',
     'BaseMoneyContent', 'TransferMoneyContent',
-    'AppCustomizedContent',
+    'BaseQuoteContent', 'CombineForwardContent',
 
+    # extend commands
     'BaseCommand',
     'BaseMetaCommand', 'BaseDocumentCommand',
     'BaseReceiptCommand',
 
+    # extend group history
     'BaseHistoryCommand', 'BaseGroupCommand',
     'InviteGroupCommand', 'ExpelGroupCommand', 'JoinGroupCommand',
     'QuitGroupCommand', 'QueryGroupCommand', 'ResetGroupCommand',
     'HireGroupCommand', 'FireGroupCommand', 'ResignGroupCommand',
 
-    'CommandGeneralFactory', 'CommandFactoryManager',
+    #
+    #   Message
+    #
 
-    'MessageEnvelope', 'BaseMessage',
+    'MessageEnvelope',
+    'BaseMessage',
     'PlainMessage', 'EncryptedMessage', 'NetworkMessage',
 
-    #
-    #   Core
-    #
-    'Barrack', 'Transceiver', 'Packer', 'Processor',
+    # factories
+    'ContentFactory', 'CommandFactory',
+    'EnvelopeFactory',
+    'InstantMessageFactory', 'SecureMessageFactory', 'ReliableMessageFactory',
 
 ]