dimples 1.3.3__tar.gz → 1.3.5__tar.gz

{dimples-1.3.3 → dimples-1.3.5}/PKG-INFO

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

{dimples-1.3.3 → dimples-1.3.5}/dimples/client/checker.py

@@ -71,7 +71,7 @@ class ClientChecker(EntityChecker, Logging):
             return False
         elif not self.is_meta_query_expired(identifier=identifier):
             # query not expired yet
-            self.info(msg='meta query not expired yet: %s' % identifier)
+            self.debug(msg='meta query not expired yet: %s' % identifier)
             return False
         self.info(msg='querying meta for: %s' % identifier)
         content = MetaCommand.query(identifier=identifier)
@@ -86,7 +86,7 @@ class ClientChecker(EntityChecker, Logging):
             return False
         elif not self.is_document_query_expired(identifier=identifier):
             # query not expired yet
-            self.info(msg='document query not expired yet: %s' % identifier)
+            self.debug(msg='document query not expired yet: %s' % identifier)
             return False
         last_time = self.get_last_document_time(identifier=identifier, documents=documents)
         self.info(msg='querying document for: %s, last time: %s' % (identifier, last_time))
@@ -103,7 +103,7 @@ class ClientChecker(EntityChecker, Logging):
             return False
         elif not self.is_members_query_expired(identifier=group):
             # query not expired yet
-            self.info('members query not expired yet: %s' % group)
+            self.debug('members query not expired yet: %s' % group)
             return False
         user = await facebook.current_user
         if user is None:

{dimples-1.3.3 → dimples-1.3.5}/dimples/client/terminal.py

@@ -240,14 +240,25 @@ class Terminal(Runner, DeviceMixin, Logging, StateDelegate, ABC):
     async def enter_state(self, state: SessionState, ctx: StateMachine, now: float):
         # called before state changed
         session = self.session
-        station = session.station
-        self.info(msg='enter state: %s, %s => %s' % (state, session.identifier, station.identifier))
+        if session is None:
+            sess_id = None
+            srv_id = None
+        else:
+            sess_id = session.identifier
+            station = session.station
+            if station is None:
+                srv_id = None
+            else:
+                srv_id = station.identifier
+        self.info(msg='enter state: %s, %s => %s' % (state, sess_id, srv_id))
 
     # Override
     async def exit_state(self, state: SessionState, ctx: StateMachine, now: float):
         # called after state changed
         current = ctx.current_state
-        self.info(msg='server state changed: %s -> %s, %s' % (state, current, self.session.station))
+        session = self.session
+        remote = None if session is None else session.remote_address
+        self.info(msg='server state changed: %s -> %s, %s' % (state, current, remote))
         index = current.index if isinstance(current, SessionState) else -1
         if index == -1 or index == StateOrder.ERROR:
             self.__last_time = 0
@@ -259,8 +270,6 @@ class Terminal(Runner, DeviceMixin, Logging, StateDelegate, ABC):
                 self.warning(msg='current user not set')
                 return
             self.info(msg='connect for user: %s' % user)
-            session = self.session
-            remote = None if session is None else session.remote_address
             if remote is None:
                 self.warning(msg='failed to get remote address: %s' % session)
                 return

{dimples-1.3.3 → dimples-1.3.5}/dimples/common/compat/__init__.py

@@ -41,10 +41,7 @@ from .meta import CompatibleMetaFactory
 from .loader import CommonLoader
 from .loader import CommonPluginLoader
 
-from .compatible import fix_meta_attachment, fix_meta_version
-from .compatible import fix_file_content
-from .compatible import fix_cmd, fix_command
-from .compatible import fix_receipt_command, fix_document_command, fix_report_command
+from .compatible import Compatible
 
 
 __all__ = [
@@ -62,9 +59,6 @@ __all__ = [
     'CommonLoader',
     'CommonPluginLoader',
 
-    'fix_meta_version', 'fix_meta_attachment',
-    'fix_file_content',
-    'fix_cmd', 'fix_command',
-    'fix_receipt_command', 'fix_document_command', 'fix_report_command',
+    'Compatible',
 
 ]

{dimples-1.3.3 → dimples-1.3.5}/dimples/common/compat/compatible.py

@@ -41,15 +41,32 @@ from ..protocol import MetaType
 #
 #  Compatible with old versions
 #
+class Compatible:
 
+    @classmethod
+    def fix_meta_attachment(cls, msg: ReliableMessage):
+        return _fix_meta_attachment(msg=msg)
 
-def fix_meta_attachment(msg: ReliableMessage):
+    @classmethod
+    def fix_meta_version(cls, meta: dict):
+        return _fix_meta_version(meta=meta)
+
+    @classmethod
+    def fix_file_content(cls, content: FileContent):
+        return _fix_file_content(content=content)
+
+    @classmethod
+    def fix_command(cls, content: Command) -> Command:
+        return _fix_command(content=content)
+
+
+def _fix_meta_attachment(msg: ReliableMessage):
     meta = msg.get('meta')
     if meta is not None:
-        fix_meta_version(meta=meta)
+        return _fix_meta_version(meta=meta)
 
 
-def fix_meta_version(meta: dict):
+def _fix_meta_version(meta: dict):
     version = meta.get('type')
     if version is None:
         version = meta.get('version')  # compatible with MKM 0.9.*
@@ -65,7 +82,7 @@ def fix_meta_version(meta: dict):
     return meta
 
 
-def fix_file_content(content: FileContent):
+def _fix_file_content(content: FileContent):
     pwd = content.get('key')
     if pwd is not None:
         # Tarsier version > 1.3.7
@@ -80,21 +97,29 @@ def fix_file_content(content: FileContent):
     return content
 
 
-def fix_command(content: Command) -> Command:
+def _fix_command(content: Command) -> Command:
     # 1. fix 'cmd'
-    content = fix_cmd(content=content)
+    content = _fix_cmd(content=content)
     # 2. fix other commands
     if isinstance(content, ReceiptCommand):
-        fix_receipt_command(content=content)
+        # receipt
+        _fix_receipt_command(content=content)
+    elif isinstance(content, ReportCommand):
+        # report
+        _fix_report_command(content=content)
+    elif isinstance(content, DocumentCommand):
+        # document
+        _fix_document_command(content=content)
     elif isinstance(content, MetaCommand):
+        # meta
         meta = content.get('meta')
         if meta is not None:
-            fix_meta_version(meta=meta)
+            _fix_meta_version(meta=meta)
     # OK
     return content
 
 
-def fix_cmd(content: Command):
+def _fix_cmd(content: Command):
     cmd = content.get('cmd')
     if cmd is None:
         cmd = content.get('command')
@@ -105,7 +130,7 @@ def fix_cmd(content: Command):
     return content
 
 
-def copy_receipt_values(content: ReceiptCommand, env: dict):
+def _copy_receipt_values(content: ReceiptCommand, env: dict):
     for key in ['sender', 'receiver', 'sn', 'signature']:
         value = env.get(key)
         if value is not None:
@@ -113,14 +138,14 @@ def copy_receipt_values(content: ReceiptCommand, env: dict):
 
 
 # TODO: remove after all server/client upgraded
-def fix_receipt_command(content: ReceiptCommand):
+def _fix_receipt_command(content: ReceiptCommand):
     origin = content.get('origin')
     if origin is not None:
         # (v2.0)
         # compatible with v1.0
         content['envelope'] = origin
         # compatible with older version
-        copy_receipt_values(content=content, env=origin)
+        _copy_receipt_values(content=content, env=origin)
         return content
     # check for old version
     env = content.get('envelope')
@@ -129,7 +154,7 @@ def fix_receipt_command(content: ReceiptCommand):
         # compatible with v2.0
         content['origin'] = env
         # compatible with older version
-        copy_receipt_values(content=content, env=env)
+        _copy_receipt_values(content=content, env=env)
         return content
     # check for older version
     if 'sender' in content:  # and 'receiver' in content:
@@ -147,7 +172,7 @@ def fix_receipt_command(content: ReceiptCommand):
 
 
 # TODO: remove after all server/client upgraded
-def fix_document_command(content: DocumentCommand):
+def _fix_document_command(content: DocumentCommand):
     info = content.get('document')
     if info is not None:
         # (v2.0)
@@ -186,7 +211,7 @@ def fix_document_command(content: DocumentCommand):
     return content
 
 
-def fix_report_command(content: ReportCommand):
+def _fix_report_command(content: ReportCommand):
     # check state for oldest version
     state = content.get('state')
     if state == 'background':

{dimples-1.3.3 → dimples-1.3.5}/dimples/common/messenger.py

@@ -53,7 +53,7 @@ from .dbi import MessageDBI
 from .facebook import CommonFacebook
 from .session import Transmitter, Session
 
-from .compat import fix_command, fix_file_content
+from .compat import Compatible
 
 
 class CommonMessenger(Messenger, Transmitter, Logging, ABC):
@@ -136,18 +136,18 @@ class CommonMessenger(Messenger, Transmitter, Logging, ABC):
     # Override
     async def serialize_content(self, content: Content, key: SymmetricKey, msg: InstantMessage) -> bytes:
         if isinstance(content, Command):
-            content = fix_command(content=content)
+            content = Compatible.fix_command(content=content)
         elif isinstance(content, FileContent):
-            content = fix_file_content(content=content)
+            content = Compatible.fix_file_content(content=content)
         return await super().serialize_content(content=content, key=key, msg=msg)
 
     # Override
     async def deserialize_content(self, data: bytes, key: SymmetricKey, msg: SecureMessage) -> Optional[Content]:
         content = await super().deserialize_content(data=data, key=key, msg=msg)
         if isinstance(content, Command):
-            content = fix_command(content=content)
+            content = Compatible.fix_command(content=content)
         elif isinstance(content, FileContent):
-            content = fix_file_content(content=content)
+            content = Compatible.fix_file_content(content=content)
         return content
 
     #

{dimples-1.3.3 → dimples-1.3.5}/dimples/common/packer.py

@@ -28,16 +28,13 @@ from typing import Optional, Dict
 
 from dimsdk import EncryptKey
 from dimsdk import ID
-from dimsdk import ReceiptCommand, DocumentCommand
 from dimsdk import InstantMessage, SecureMessage, ReliableMessage
 from dimsdk import MessagePacker
 from dimsdk import MessageUtils
 
 from ..utils import Logging
 
-from .compat import fix_meta_attachment
-from .compat import fix_receipt_command
-from .compat import fix_document_command
+from .compat import Compatible
 
 
 class CommonMessagePacker(MessagePacker, Logging, ABC):
@@ -135,25 +132,8 @@ class CommonMessagePacker(MessagePacker, Logging, ABC):
         else:
             self.warning(msg='receiver not ready: %s' % msg.receiver)
             return None
-        content = msg.content
-        if isinstance(content, ReceiptCommand):
-            # compatible with v1.0
-            fix_receipt_command(content=content)
         return await super().encrypt_message(msg=msg)
 
-    # Override
-    async def decrypt_message(self, msg: SecureMessage) -> Optional[InstantMessage]:
-        i_msg = await super().decrypt_message(msg=msg)
-        if i_msg is not None:
-            content = i_msg.content
-            if isinstance(content, ReceiptCommand):
-                # compatible with v1.0
-                fix_receipt_command(content=content)
-            elif isinstance(content, DocumentCommand):
-                # compatible with v1.0
-                fix_document_command(content=content)
-        return i_msg
-
     # Override
     async def verify_message(self, msg: ReliableMessage) -> Optional[SecureMessage]:
         # 1. check receiver/group with local user
@@ -183,10 +163,10 @@ class CommonMessagePacker(MessagePacker, Logging, ABC):
         #     return None
         msg = await super().deserialize_message(data=data)
         if msg is not None:
-            fix_meta_attachment(msg=msg)
+            Compatible.fix_meta_attachment(msg=msg)
         return msg
 
     # Override
     async def serialize_message(self, msg: ReliableMessage) -> bytes:
-        fix_meta_attachment(msg=msg)
+        Compatible.fix_meta_attachment(msg=msg)
         return await super().serialize_message(msg=msg)

{dimples-1.3.3 → dimples-1.3.5}/dimples/conn/gatekeeper.py

@@ -130,7 +130,7 @@ def reset_send_buffer_size(conn: Connection = None, sock: socket.socket = None)
             return False
         channel = conn.channel
         if not isinstance(channel, BaseChannel):
-            print('[SOCKET] channel error: %s, %s' % (channel, conn))
+            print('[SOCKET] channel error: %s, %s' % (channel, conn.remote_address))
             return False
         sock = channel.sock
         if sock is None:

{dimples-1.3.3 → dimples-1.3.5}/dimples/conn/protocol/ws.py

@@ -172,7 +172,7 @@ class WebSocket:
                 mask = None
             # 4. get payload
             if stream_len < pos + msg_len:
-                Log.info(msg='incomplete ws package for payload: %d, msg len: %d' % (stream_len, msg_len))
+                # Log.info(msg='incomplete ws package for payload: %d, msg len: %d' % (stream_len, msg_len))
                 return None, stream
             payload = stream[pos:pos+msg_len]
             pos += msg_len
@@ -212,7 +212,7 @@ class WebSocket:
                 # cut the received package(s) and return the remaining
                 stream = stream[pos:]
                 break
-        Log.info(msg='received ws payload len: %d, left: %d' % (len(data), len(stream)))
+        # Log.info(msg='received ws payload len: %d, left: %d' % (len(data), len(stream)))
         return data, stream
 
     @classmethod

{dimples-1.3.3 → dimples-1.3.5}/dimples/database/dos/document.py

@@ -26,15 +26,14 @@
 from typing import Optional, List
 
 from dimsdk import TransportableData
-from dimsdk import ID, Document, DocumentUtils
+from dimsdk import ID, Document
 
 from ...utils import template_replace
-from ...common import DocumentDBI
 
 from .base import Storage
 
 
-class DocumentStorage(Storage, DocumentDBI):
+class DocumentStorage(Storage):
     """
         Document for Entities (User/Group)
         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -72,40 +71,11 @@ class DocumentStorage(Storage, DocumentDBI):
         documents = []
         for info in array:
             doc = parse_document(dictionary=info, identifier=identifier)
-            assert doc is not None, 'document error: %s, %s' % (identifier, info)
-            documents.append(doc)
+            if doc is not None:
+                documents.append(doc)
         self.info(msg='Loaded %d documents from: %s' % (len(documents), path))
         return documents
 
-    #
-    #   Document DBI
-    #
-
-    # Override
-    async def save_document(self, document: Document) -> bool:
-        """ save document into file """
-        identifier = document.identifier
-        doc_type = document.type
-        # check old documents
-        all_documents = await self.get_documents(identifier=identifier)
-        old = DocumentUtils.last_document(all_documents, doc_type)
-        if old is None and doc_type == Document.VISA:
-            old = DocumentUtils.last_document(all_documents, 'profile')
-        if old is not None:
-            if DocumentUtils.is_expired(document, old):
-                self.warning(msg='drop expired document: %s' % identifier)
-                return False
-            all_documents.remove(old)
-        # append it
-        all_documents.append(document)
-        return await self.save_documents(documents=all_documents, identifier=identifier)
-
-    # Override
-    async def get_documents(self, identifier: ID) -> List[Document]:
-        """ load documents from file """
-        docs = await self.load_documents(identifier=identifier)
-        return [] if docs is None else docs
-
 
 def parse_document(dictionary: dict, identifier: ID = None, doc_type: str = '*') -> Optional[Document]:
     # check document ID

{dimples-1.3.3 → dimples-1.3.5}/dimples/database/dos/group_history.py

@@ -23,20 +23,18 @@
 # SOFTWARE.
 # ==============================================================================
 
-from typing import Optional, Tuple, List
+from typing import Tuple, List
 
 from dimsdk import ID
 from dimsdk import ReliableMessage
 from dimsdk import Command, GroupCommand
-from dimsdk import ResetCommand, ResignCommand
 
 from ...utils import template_replace
-from ...common import GroupHistoryDBI
 
 from .base import Storage
 
 
-class GroupHistoryStorage(Storage, GroupHistoryDBI):
+class GroupHistoryStorage(Storage):
     """
         Group History Command Storage
         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -89,69 +87,3 @@ class GroupHistoryStorage(Storage, GroupHistoryDBI):
         path = self.__history_path(group=group)
         self.info(msg='Saving %d group history(ies) into: %s' % (len(histories), path))
         return await self.write_json(container=array, path=path)
-
-    #
-    #   Group History DBI
-    #
-
-    # Override
-    async def save_group_history(self, group: ID, content: GroupCommand, message: ReliableMessage) -> bool:
-        histories = await self.load_group_histories(group=group)
-        item = (content, message)
-        histories.append(item)
-        return await self.save_group_histories(group=group, histories=histories)
-
-    # Override
-    async def get_group_histories(self, group: ID) -> List[Tuple[GroupCommand, ReliableMessage]]:
-        return await self.load_group_histories(group=group)
-
-    # Override
-    async def get_reset_command_message(self, group: ID) -> Tuple[Optional[ResetCommand], Optional[ReliableMessage]]:
-        histories = await self.load_group_histories(group=group)
-        pos = len(histories)
-        while pos > 0:
-            pos -= 1
-            his = histories[pos]
-            cmd = his[0]
-            msg = his[1]
-            if isinstance(cmd, ResetCommand):
-                return cmd, msg
-        return None, None
-
-    # Override
-    async def clear_group_member_histories(self, group: ID) -> bool:
-        histories = await self.load_group_histories(group=group)
-        if len(histories) == 0:
-            # history empty
-            return True
-        array = []
-        removed = 0
-        for his in histories:
-            if isinstance(his[0], ResignCommand):
-                # keep 'resign' command messages
-                array.append(his)
-            else:
-                # remove other command messages
-                removed += 1
-        # if nothing changed, return True
-        # else, save new histories
-        return removed == 0 or await self.save_group_histories(group=group, histories=array)
-
-    # Override
-    async def clear_group_admin_histories(self, group: ID) -> bool:
-        histories = await self.load_group_histories(group=group)
-        if len(histories) == 0:
-            # history empty
-            return True
-        array = []
-        removed = 0
-        for his in histories:
-            if isinstance(his[0], ResignCommand):
-                # remove 'resign' command messages
-                removed += 1
-            else:
-                # keep other command messages
-                array.append(his)
-        # if nothing changed, return True
-        # else, save new histories
-        return removed == 0 or await self.save_group_histories(group=group, histories=array)

{dimples-1.3.3 → dimples-1.3.5}/dimples/database/dos/meta.py

@@ -28,12 +28,14 @@ from typing import Optional
 from dimsdk import ID, Meta
 
 from ...utils import template_replace
+from ...utils import Logging
+from ...common.compat import Compatible
 from ...common import MetaDBI
 
 from .base import Storage
 
 
-class MetaStorage(Storage, MetaDBI):
+class MetaStorage(Storage, Logging, MetaDBI):
     """
         Meta for Entities (User/Group)
         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -69,5 +71,10 @@ class MetaStorage(Storage, MetaDBI):
         if info is None:
             # file not found
             self.warning(msg='meta file not found: %s' % path)
+            return None
         else:
+            Compatible.fix_meta_version(meta=info)
+        try:
             return Meta.parse(meta=info)
+        except Exception as error:
+            self.error(msg='meta error: %s, %s' % (error, info))

{dimples-1.3.3 → dimples-1.3.5}/dimples/database/redis/document.py

@@ -56,7 +56,17 @@ class DocumentCache(Cache):
     def __cache_name(self, identifier: ID) -> str:
         return '%s.%s.%s' % (self.db_name, self.tbl_name, identifier)
 
-    async def get_documents(self, identifier: ID) -> Optional[List[Document]]:
+    async def save_documents(self, documents: List[Document], identifier: ID) -> bool:
+        array = []
+        for doc in documents:
+            assert doc.identifier == identifier, 'document ID not matched: %s, %s' % (identifier, doc)
+            array.append(doc.dictionary)
+        js = json_encode(obj=array)
+        value = utf8_encode(string=js)
+        name = self.__cache_name(identifier=identifier)
+        return await self.set(name=name, value=value, expires=self.EXPIRES)
+
+    async def load_documents(self, identifier: ID) -> Optional[List[Document]]:
         name = self.__cache_name(identifier=identifier)
         value = await self.get(name=name)
         if value is None:
@@ -79,13 +89,3 @@ class DocumentCache(Cache):
         else:
             assert info is None, 'document error: %s' % value
         return array
-
-    async def save_documents(self, documents: List[Document], identifier: ID) -> bool:
-        array = []
-        for doc in documents:
-            assert doc.identifier == identifier, 'document ID not matched: %s, %s' % (identifier, doc)
-            array.append(doc.dictionary)
-        js = json_encode(obj=array)
-        value = utf8_encode(string=js)
-        name = self.__cache_name(identifier=identifier)
-        return await self.set(name=name, value=value, expires=self.EXPIRES)

{dimples-1.3.3 → dimples-1.3.5}/dimples/database/redis/meta.py

@@ -28,11 +28,13 @@ from typing import Optional
 from dimsdk import ID, Meta
 
 from ...utils import json_encode, json_decode, utf8_encode, utf8_decode
+from ...utils import Logging
+from ...common.compat import Compatible
 
 from .base import Cache
 
 
-class MetaCache(Cache):
+class MetaCache(Cache, Logging):
 
     # meta cached in Redis will be removed after 10 hours, after that
     # it will be reloaded from local storage if it's still need.
@@ -58,12 +60,19 @@ class MetaCache(Cache):
     async def get_meta(self, identifier: ID) -> Optional[Meta]:
         key = self.__cache_name(identifier=identifier)
         value = await self.get(name=key)
-        if value is not None:
+        if value is None:
+            # cache not found
+            return None
+        else:
             js = utf8_decode(data=value)
             assert js is not None, 'failed to decode string: %s' % value
             info = json_decode(string=js)
             assert info is not None, 'meta error: %s' % value
+            Compatible.fix_meta_version(meta=info)
+        try:
             return Meta.parse(meta=info)
+        except Exception as error:
+            self.error(msg='meta error: %s, %s' % (error, info))
 
     async def save_meta(self, meta: Meta, identifier: ID) -> bool:
         dictionary = meta.dictionary

{dimples-1.3.3 → dimples-1.3.5}/dimples/database/t_document.py

@@ -63,7 +63,7 @@ class DocTask(DbTask):
     async def _load_redis_cache(self) -> Optional[List[Document]]:
         # 1. the redis server will return None when cache not found
         # 2. when redis server return an empty array, no need to check local storage again
-        return await self._redis.get_documents(identifier=self._identifier)
+        return await self._redis.load_documents(identifier=self._identifier)
 
     # Override
     async def _save_redis_cache(self, value: List[Document]) -> bool:
@@ -73,7 +73,7 @@ class DocTask(DbTask):
     async def _load_local_storage(self) -> Optional[List[Document]]:
         # 1. the local storage will return an empty array, when no document for this id
         # 2. return empty array as a placeholder for the memory cache
-        return await self._dos.get_documents(identifier=self._identifier)
+        return await self._dos.load_documents(identifier=self._identifier)
 
     # Override
     async def _save_local_storage(self, value: List[Document]) -> bool: