dimp 1.0.2__tar.gz → 2.0.0__tar.gz

{dimp-1.0.2 → dimp-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dimp
-Version: 1.0.2
+Version: 2.0.0
 Summary: Decentralized Instant Messaging Protocol
 Home-page: https://github.com/dimchat/core-py
 Author: Albert Moky

{dimp-1.0.2 → dimp-2.0.0}/dimp/barrack.py

@@ -85,7 +85,7 @@ class Barrack(EntityDelegate, UserDataSource, GroupDataSource, ABC):
         return finger >> 1
 
     @abstractmethod  # protected
-    def create_user(self, identifier: ID) -> Optional[User]:
+    async def create_user(self, identifier: ID) -> Optional[User]:
         """
         Create user when visa.key exists
 
@@ -95,7 +95,7 @@ class Barrack(EntityDelegate, UserDataSource, GroupDataSource, ABC):
         raise NotImplemented
 
     @abstractmethod  # protected
-    def create_group(self, identifier: ID) -> Optional[Group]:
+    async def create_group(self, identifier: ID) -> Optional[Group]:
         """
         Create group when members exist
 
@@ -105,25 +105,25 @@ class Barrack(EntityDelegate, UserDataSource, GroupDataSource, ABC):
         raise NotImplemented
 
     # protected
-    def visa_key(self, identifier: ID) -> Optional[EncryptKey]:
-        visa = self.visa(identifier=identifier)
+    async def get_visa_key(self, identifier: ID) -> Optional[EncryptKey]:
+        visa = await self.get_visa(identifier=identifier)
         if visa is not None:  # and visa.valid:
             return visa.public_key
 
     # protected
-    def meta_key(self, identifier: ID) -> Optional[VerifyKey]:
-        meta = self.meta(identifier=identifier)
+    async def get_meta_key(self, identifier: ID) -> Optional[VerifyKey]:
+        meta = await self.get_meta(identifier=identifier)
         if meta is not None:  # and meta.valid:
             return meta.public_key
 
-    def visa(self, identifier: ID) -> Optional[Visa]:
+    async def get_visa(self, identifier: ID) -> Optional[Visa]:
         """ Get last visa document """
-        documents = self.documents(identifier=identifier)
+        documents = await self.get_documents(identifier=identifier)
         return DocumentHelper.last_visa(documents=documents)
 
-    def bulletin(self, identifier: ID) -> Optional[Bulletin]:
+    async def get_bulletin(self, identifier: ID) -> Optional[Bulletin]:
         """ get last bulletin document """
-        documents = self.documents(identifier=identifier)
+        documents = await self.get_documents(identifier=identifier)
         return DocumentHelper.last_bulletin(documents=documents)
 
     #
@@ -131,23 +131,23 @@ class Barrack(EntityDelegate, UserDataSource, GroupDataSource, ABC):
     #
 
     # Override
-    def user(self, identifier: ID) -> Optional[User]:
+    async def get_user(self, identifier: ID) -> Optional[User]:
         # 1. get from user cache
         usr = self.__users.get(identifier)
         if usr is None:
             # 2. create and cache it
-            usr = self.create_user(identifier=identifier)
+            usr = await self.create_user(identifier=identifier)
             if usr is not None:
                 self.cache_user(user=usr)
         return usr
 
     # Override
-    def group(self, identifier: ID) -> Optional[Group]:
+    async def get_group(self, identifier: ID) -> Optional[Group]:
         # 1. get from group cache
         grp = self.__groups.get(identifier)
         if grp is None:
             # 2. create and cache it
-            grp = self.create_group(identifier=identifier)
+            grp = await self.create_group(identifier=identifier)
             if grp is not None:
                 self.cache_group(group=grp)
         return grp
@@ -157,30 +157,30 @@ class Barrack(EntityDelegate, UserDataSource, GroupDataSource, ABC):
     #
 
     # Override
-    def public_key_for_encryption(self, identifier: ID) -> Optional[EncryptKey]:
+    async def public_key_for_encryption(self, identifier: ID) -> Optional[EncryptKey]:
         # 1. get key from visa
-        key = self.visa_key(identifier=identifier)
+        key = await self.get_visa_key(identifier=identifier)
         if key is not None:
             # if visa.key exists, use it for encryption
             return key
         # 2. get key from meta
-        key = self.meta_key(identifier=identifier)
+        key = await self.get_meta_key(identifier=identifier)
         if isinstance(key, EncryptKey):
             # if visa.key not exists and meta.key is encrypt key,
             # use it for encryption
             return key
 
     # Override
-    def public_keys_for_verification(self, identifier: ID) -> List[VerifyKey]:
+    async def public_keys_for_verification(self, identifier: ID) -> List[VerifyKey]:
         keys = []
         # 1. get key from meta
-        key = self.meta_key(identifier=identifier)
+        key = await self.get_meta_key(identifier=identifier)
         if key is not None:
             # the sender may use identity key to sign message.data,
             # try to verify it with meta.key
             keys.append(key)
         # 2. get key from visa
-        key = self.visa_key(identifier=identifier)
+        key = await self.get_visa_key(identifier=identifier)
         if isinstance(key, VerifyKey):
             # the sender may use communication key to sign message.data,
             # so try to verify it with visa.key here
@@ -193,19 +193,19 @@ class Barrack(EntityDelegate, UserDataSource, GroupDataSource, ABC):
     #
 
     # Override
-    def founder(self, identifier: ID) -> Optional[ID]:
+    async def get_founder(self, identifier: ID) -> Optional[ID]:
         # check for broadcast
         if identifier.is_broadcast:
             # founder of broadcast group
             return BroadcastHelper.broadcast_founder(group=identifier)
         # get from document
-        doc = self.bulletin(identifier=identifier)
+        doc = await self.get_bulletin(identifier=identifier)
         if doc is not None:  # and doc.valid:
             return doc.founder
         # TODO: load founder from database
 
     # Override
-    def owner(self, identifier: ID) -> Optional[ID]:
+    async def get_owner(self, identifier: ID) -> Optional[ID]:
         # check for broadcast
         if identifier.is_broadcast:
             # owner of broadcast group
@@ -213,11 +213,11 @@ class Barrack(EntityDelegate, UserDataSource, GroupDataSource, ABC):
         # check group type
         if identifier.type == EntityType.GROUP:
             # Polylogue's owner is its founder
-            return self.founder(identifier=identifier)
+            return await self.get_founder(identifier=identifier)
         # TODO: load owner from database
 
     # Override
-    def members(self, identifier: ID) -> List[ID]:
+    async def get_members(self, identifier: ID) -> List[ID]:
         # check for broadcast
         if identifier.is_broadcast:
             # members of broadcast group
@@ -226,8 +226,8 @@ class Barrack(EntityDelegate, UserDataSource, GroupDataSource, ABC):
         return []
 
     # Override
-    def assistants(self, identifier: ID) -> List[ID]:
-        doc = self.bulletin(identifier=identifier)
+    async def get_assistants(self, identifier: ID) -> List[ID]:
+        doc = await self.get_bulletin(identifier=identifier)
         if doc is not None:  # and doc.valid:
             bots = doc.assistants
             if bots is not None:

{dimp-1.0.2 → dimp-2.0.0}/dimp/dkd/commands.py

@@ -38,6 +38,7 @@
 
 from typing import Optional, Any, Dict
 
+from mkm.types import DateTime
 from mkm import ID, Meta, Document
 
 from ..protocol import MetaCommand, DocumentCommand
@@ -123,23 +124,25 @@ class BaseDocumentCommand(BaseMetaCommand, DocumentCommand):
                  identifier: ID = None,
                  meta: Optional[Meta] = None,
                  document: Optional[Document] = None,
-                 signature: Optional[str] = None):
+                 last_time: Optional[DateTime] = None):
         if content is None:
             # 1. new command with ID, meta, document & signature
             if identifier is None:
-                assert document is not None, 'document command error: %s, %s' % (meta, signature)
+                assert document is not None, 'document command error: %s, %s' % (meta, last_time)
                 identifier = document.identifier
-            assert identifier is not None, 'document command error: %s, %s, %s' % (meta, document, signature)
+            assert identifier is not None, 'document command error: %s, %s, %s' % (meta, document, last_time)
             cmd = Command.DOCUMENT
             super().__init__(cmd=cmd, identifier=identifier, meta=meta)
+            # respond with document info
             if document is not None:
                 self['document'] = document.dictionary
-            if signature is not None:
-                self['signature'] = signature
+            # query with last document time
+            if last_time is not None:
+                self.set_datetime(key='last_time', value=last_time)
         else:
             # 2. command info from network
-            assert identifier is None and meta is None and document is None and signature is None, \
-                'params error: %s, %s, %s, %s, %s' % (content, identifier, meta, document, signature)
+            assert identifier is None and meta is None and document is None and last_time is None, \
+                'params error: %s, %s, %s, %s, %s' % (content, identifier, meta, document, last_time)
             super().__init__(content)
         # lazy load
         self.__doc = document
@@ -154,10 +157,5 @@ class BaseDocumentCommand(BaseMetaCommand, DocumentCommand):
         return self.__doc
 
     @property  # Override
-    def signature(self) -> Optional[str]:
-        """
-        signature for checking new document
-
-        :return: part of signature in current document (base64)
-        """
-        return self.get_str(key='signature', default=None)
+    def last_time(self) -> Optional[DateTime]:
+        return self.get_datetime(key='last_time', default=None)

{dimp-1.0.2 → dimp-2.0.0}/dimp/dkd/contents.py

@@ -30,7 +30,7 @@
 
 from typing import Optional, Any, Dict, List
 
-from mkm.format import TransportableData, PortableNetworkFile
+from mkm.format import PortableNetworkFile
 from mkm.types import URI
 from mkm import ID
 from dkd import ContentType, Content
@@ -184,44 +184,45 @@ class WebPageContent(BaseContent, PageContent):
             type : 0x20,
             sn   : 123,
 
-            URL   : "https://github.com/moky/dimp",  // Page URL
-            icon  : "...",                           // base64_encode(icon)
-            title : "...",
-            desc  : "..."
+            title : "...",                // Web title
+            icon  : "...",                // base64_encode(icon)
+            desc  : "...",
+
+            URL   : "https://github.com/moky/dimp",
+
+            HTML      : "...",            // Web content
+            mime_type : "text/html",      // Content-Type
+            encoding  : "utf8",
+            base      : "about:blank"     // Base URL
         }
     """
 
     def __init__(self, content: Dict[str, Any] = None,
-                 url: URI = None, title: str = None,
-                 desc: Optional[str] = None, icon: Optional[TransportableData] = None):
+                 url: URI = None, html: str = None, title: str = None,
+                 desc: Optional[str] = None, icon: Optional[URI] = None):
         if content is None:
             # 1. new content with url, title, desc & icon
             assert url is not None and title is not None, 'page info error: %s, %s, %s, %s' % (url, title, desc, icon)
             msg_type = ContentType.PAGE.value
             super().__init__(None, msg_type)
-            self['URL'] = url
-            self['title'] = title
-            if desc is not None:
-                self['desc'] = desc
-            if icon is not None:
-                self.set_icon(icon)
         else:
             # 2. content info from network
-            assert url is None and title is None and desc is None and icon is None, \
-                'params error: %s, %s, %s, %s, %s' % (content, url, title, desc, icon)
             super().__init__(content)
-        # lazy
-        self.__icon = icon
-
-    @property  # Override
-    def url(self) -> URI:
-        # TODO: convert str to URI
-        return self.get_str(key='URL', default=None)
+        # URL or HTML
+        if url is not None:
+            self.url = url
+        if html is not None:
+            self.html = html
+        # title, icon, description
+        self.title = title
+        if desc is not None:
+            self.desc = desc
+        if icon is not None:
+            self.icon = icon
 
-    @url.setter  # Override
-    def url(self, string: URI):
-        # TODO: convert URI to str
-        self['URL'] = string
+    #
+    #   Web Title
+    #
 
     @property  # Override
     def title(self) -> str:
@@ -231,40 +232,63 @@ class WebPageContent(BaseContent, PageContent):
     def title(self, string: str):
         self['title'] = string
 
+    #
+    #   Fav Icon
+    #
+
+    @property  # Override
+    def icon(self) -> Optional[URI]:
+        base64 = self.get_str(key='icon', default=None)
+        # TODO: convert 'data:' URI
+        return base64
+
+    @icon.setter  # Override
+    def icon(self, base64: URI):
+        self['icon'] = base64
+
+    #
+    #   Description
+    #
+
     @property  # Override
     def desc(self) -> Optional[str]:
         return self.get_str(key='desc', default=None)
 
     @desc.setter  # Override
-    def desc(self, string: Optional[str]):
-        if string is None:
+    def desc(self, text: Optional[str]):
+        if text is None:
             self.pop('desc', None)
         else:
-            self['desc'] = string
+            self['desc'] = text
+
+    #
+    #   Page URL
+    #
 
     @property  # Override
-    def icon(self) -> Optional[bytes]:
-        ted = self.__icon
-        if ted is None:
-            base64 = self.get('icon')
-            self.__icon = ted = TransportableData.parse(base64)
-        if ted is not None:
-            return ted.data
-
-    @icon.setter
-    def icon(self, image: Optional[bytes]):
-        if image is None or len(image) == 0:
-            ted = None
-        else:
-            ted = TransportableData.create(data=image)
-        self.set_icon(ted)
+    def url(self) -> URI:
+        # TODO: convert str to URI
+        return self.get_str(key='URL', default=None)
 
-    def set_icon(self, ted: Optional[TransportableData]):
-        if ted is None:
-            self.pop('icon')
+    @url.setter  # Override
+    def url(self, locator: URI):
+        # TODO: convert URI to str
+        self['URL'] = locator
+
+    #
+    #   Page content
+    #
+
+    @property  # Override
+    def html(self) -> Optional[str]:
+        return self.get_str(key='desc', default=None)
+
+    @html.setter  # Override
+    def html(self, content: Optional[str]):
+        if content is None:
+            self.pop('HTML', None)
         else:
-            self['icon'] = ted.object
-        self.__icon = ted
+            self['HTML'] = content
 
 
 class NameCardContent(BaseContent, NameCard):

{dimp-1.0.2 → dimp-2.0.0}/dimp/dkd/files.py

@@ -43,19 +43,7 @@ from .contents import BaseContent
 
 
 class BaseFileContent(BaseContent, FileContent):
-    """
-        File Message Content
-        ~~~~~~~~~~~~~~~~~~~~
-
-        data format: {
-            type : 0x10,
-            sn   : 123,
-
-            URL      : "http://", // upload to CDN
-            data     : "...",     // if (!URL) base64_encode(fileContent)
-            filename : "..."
-        }
-    """
+    """ File Message Content """
 
     def __init__(self, content: Dict[str, Any] = None,
                  msg_type: int = None,
@@ -120,64 +108,27 @@ class BaseFileContent(BaseContent, FileContent):
 
 
 class ImageFileContent(BaseFileContent, ImageContent):
-    """
-        Image Message Content
-        ~~~~~~~~~~~~~~~~~~~~~
-
-        data format: {
-            type : 0x12,
-            sn   : 123,
-
-            URL       : "http://", // upload to CDN
-            data      : "...",     // if (!URL) base64_encode(image)
-            thumbnail : "...",     // base64_encode(smallImage)
-            filename  : "..."
-        }
-    """
+    """ Image Message Content """
 
     def __init__(self, content: Dict[str, Any] = None,
                  data: Optional[TransportableData] = None, filename: Optional[str] = None,
                  url: Optional[URI] = None, password: Optional[DecryptKey] = None):
         msg_type = ContentType.IMAGE.value if content is None else None
         super().__init__(content, msg_type, data=data, filename=filename, url=url, password=password)
-        # lazy load
-        self.__thumbnail: Optional[TransportableData] = None
 
     @property  # Override
-    def thumbnail(self) -> Optional[bytes]:
-        ted = self.__thumbnail
-        if ted is None:
-            base64 = self.get('thumbnail')
-            self.__thumbnail = ted = TransportableData.parse(base64)
-        if ted is not None:
-            return ted.data
+    def thumbnail(self) -> Optional[URI]:
+        base64 = self.get_str(key='thumbnail', default=None)
+        # TODO: convert 'data:' URI
+        return base64
 
     @thumbnail.setter  # Override
-    def thumbnail(self, image: bytes):
-        if image is None:  # or len(image) == 0:
-            self.pop('thumbnail', None)
-            ted = None
-        else:
-            ted = TransportableData.create(data=image)
-            self['thumbnail'] = ted.object
-        self.__thumbnail = ted
+    def thumbnail(self, base64: URI):
+        self['thumbnail'] = base64
 
 
 class AudioFileContent(BaseFileContent, AudioContent):
-    """
-        Audio Message Content
-        ~~~~~~~~~~~~~~~~~~~~~
-
-        data format: {
-            type : 0x14,
-            sn   : 123,
-
-            URL      : "http://", // upload to CDN
-            data     : "...",     // if (!URL) base64_encode(audio)
-            text     : "...",     // Automatic Speech Recognition
-            filename : "..."
-        }
-    """
+    """ Audio Message Content """
 
     def __init__(self, content: Dict[str, Any] = None,
                  data: Optional[TransportableData] = None, filename: Optional[str] = None,
@@ -195,44 +146,20 @@ class AudioFileContent(BaseFileContent, AudioContent):
 
 
 class VideoFileContent(BaseFileContent, VideoContent):
-    """
-        Video Message Content
-        ~~~~~~~~~~~~~~~~~~~~~
-
-        data format: {
-            type : 0x16,
-            sn   : 123,
-
-            URL      : "http://", // upload to CDN
-            data     : "...",     // if (!URL) base64_encode(video)
-            snapshot : "...",     // base64_encode(smallImage)
-            filename : "..."
-        }
-    """
+    """ Video Message Content """
 
     def __init__(self, content: Dict[str, Any] = None,
                  data: Optional[TransportableData] = None, filename: Optional[str] = None,
                  url: Optional[URI] = None, password: Optional[DecryptKey] = None):
         msg_type = ContentType.VIDEO.value if content is None else None
         super().__init__(content, msg_type, data=data, filename=filename, url=url, password=password)
-        # lazy load
-        self.__snapshot: Optional[TransportableData] = None
 
     @property  # Override
-    def snapshot(self) -> Optional[bytes]:
-        ted = self.__snapshot
-        if ted is None:
-            base64 = self.get('snapshot')
-            self.__snapshot = ted = TransportableData.parse(base64)
-        if ted is not None:
-            return ted.data
+    def snapshot(self) -> Optional[URI]:
+        base64 = self.get_str(key='thumbnail', default=None)
+        # TODO: convert 'data:' URI
+        return base64
 
     @snapshot.setter  # Override
-    def snapshot(self, image: bytes):
-        if image is None:  # or len(image) == 0:
-            self.pop('snapshot', None)
-            ted = None
-        else:
-            ted = TransportableData.create(data=image)
-            self['snapshot'] = ted.object
-        self.__snapshot = ted
+    def snapshot(self, base64: URI):
+        self['snapshot'] = base64

{dimp-1.0.2 → dimp-2.0.0}/dimp/dkd/groups.py

@@ -39,8 +39,9 @@
 
 from typing import Optional, Any, Dict, List
 
-from dkd import ContentType
+from mkm.types import DateTime
 from mkm import ID
+from dkd import ContentType
 
 from ..protocol import HistoryCommand, GroupCommand
 from ..protocol import InviteCommand, ExpelCommand, JoinCommand, QuitCommand, QueryCommand, ResetCommand
@@ -200,7 +201,7 @@ class QuitGroupCommand(BaseGroupCommand, QuitCommand):
 
 class QueryGroupCommand(BaseGroupCommand, QueryCommand):
 
-    def __init__(self, content: Dict[str, Any] = None, group: ID = None):
+    def __init__(self, content: Dict[str, Any] = None, group: ID = None, last_time: DateTime = None):
         """
         Create query group members command (not history command)
 
@@ -210,6 +211,12 @@ class QueryGroupCommand(BaseGroupCommand, QueryCommand):
         """
         cmd = GroupCommand.QUERY if content is None else None
         super().__init__(content, cmd=cmd, group=group)
+        if last_time is not None:
+            self.set_datetime(key='last_time', value=last_time)
+
+    @property  # Override
+    def last_time(self) -> Optional[DateTime]:
+        return self.get_datetime(key='last_time', default=None)
 
 
 class ResetGroupCommand(BaseGroupCommand, ResetCommand):

{dimp-1.0.2 → dimp-2.0.0}/dimp/mkm/delegate.py

@@ -41,7 +41,7 @@ from .group import Group
 class EntityDelegate(ABC):
 
     @abstractmethod
-    def user(self, identifier: ID) -> Optional[User]:
+    async def get_user(self, identifier: ID) -> Optional[User]:
         """
         Create user with ID
 
@@ -51,7 +51,7 @@ class EntityDelegate(ABC):
         raise NotImplemented
 
     @abstractmethod
-    def group(self, identifier: ID) -> Optional[Group]:
+    async def get_group(self, identifier: ID) -> Optional[Group]:
         """
         Create group with ID
 

{dimp-1.0.2 → dimp-2.0.0}/dimp/mkm/entity.py

@@ -48,7 +48,7 @@ class EntityDataSource(ABC):
     """
 
     @abstractmethod
-    def meta(self, identifier: ID) -> Optional[Meta]:
+    async def get_meta(self, identifier: ID) -> Optional[Meta]:
         """
         Get meta for entity
 
@@ -58,7 +58,7 @@ class EntityDataSource(ABC):
         raise NotImplemented
 
     @abstractmethod
-    def documents(self, identifier: ID) -> List[Document]:
+    async def get_documents(self, identifier: ID) -> List[Document]:
         """
         Get documents for entity ID
 
@@ -104,13 +104,13 @@ class Entity(ABC):
 
     @property
     @abstractmethod
-    def meta(self) -> Meta:
+    async def meta(self) -> Meta:
         """ Get meta """
         raise NotImplemented
 
     @property
     @abstractmethod
-    def documents(self) -> List[Document]:
+    async def documents(self) -> List[Document]:
         """ Get documents """
         raise NotImplemented
 
@@ -176,13 +176,13 @@ class BaseEntity(Entity):
         return self.__id.type
 
     @property  # Override
-    def meta(self) -> Meta:
+    async def meta(self) -> Meta:
         delegate = self.data_source
         # assert delegate is not None, 'entity delegate not set yet'
-        return delegate.meta(identifier=self.__id)
+        return await delegate.get_meta(identifier=self.__id)
 
     @property  # Override
-    def documents(self) -> List[Document]:
+    async def documents(self) -> List[Document]:
         delegate = self.data_source
         # assert delegate is not None, 'entity delegate not set yet'
-        return delegate.documents(identifier=self.__id)
+        return await delegate.get_documents(identifier=self.__id)