imbot-sdk-python 0.1.0__py3-none-any.whl

imbot_sdk/messages/contents.py

@@ -0,0 +1,463 @@
+"""Concrete message content models.
+
+Each class serializes to a stable JSON shape, so messages sent from this SDK
+are interchangeable with the other JuggleIM client SDKs.
+"""
+
+import json
+from typing import Dict, List, Optional
+
+from ..models import (
+    Conversation,
+    UserInfo,
+    DEFAULT_MESSAGE_FLAGS,
+    MESSAGE_CONTENT_TYPE_UNKNOWN,
+)
+from .base import (
+    MessageContent,
+    _json_bytes,
+    MESSAGE_CONTENT_TYPE_TEXT,
+    MESSAGE_CONTENT_TYPE_IMAGE,
+    MESSAGE_CONTENT_TYPE_FILE,
+    MESSAGE_CONTENT_TYPE_VIDEO,
+    MESSAGE_CONTENT_TYPE_VOICE,
+    MESSAGE_CONTENT_TYPE_STREAM_TEXT,
+    MESSAGE_CONTENT_TYPE_RECALL_INFO,
+    MESSAGE_CONTENT_TYPE_MERGE,
+    MESSAGE_CONTENT_TYPE_THUMBNAIL_PACKED_IMAGE,
+    MESSAGE_CONTENT_TYPE_SNAPSHOT_PACKED_VIDEO,
+)
+
+
+class TextMessage(MessageContent):
+    CONTENT_TYPE = MESSAGE_CONTENT_TYPE_TEXT
+
+    def __init__(self, content: str = "", extra: str = "") -> None:
+        self.content = content
+        self.extra = extra
+
+    def encode(self) -> bytes:
+        obj = {}
+        if self.content:
+            obj["content"] = self.content
+        if self.extra:
+            obj["extra"] = self.extra
+        return _json_bytes(obj)
+
+    def decode(self, data: bytes) -> None:
+        obj = json.loads(data or b"{}")
+        self.content = obj.get("content", "")
+        self.extra = obj.get("extra", "")
+
+    def conversation_digest(self) -> str:
+        return self.content
+
+    def get_search_content(self) -> str:
+        return self.content
+
+
+class ImageMessage(MessageContent):
+    CONTENT_TYPE = MESSAGE_CONTENT_TYPE_IMAGE
+
+    def __init__(self) -> None:
+        self.url = ""
+        self.local_path = ""
+        self.thumbnail_url = ""
+        self.thumbnail_local_path = ""
+        self.height = 0
+        self.width = 0
+        self.extra = ""
+        self.size = 0
+
+    def encode(self) -> bytes:
+        obj = {"height": self.height, "width": self.width, "size": self.size}
+        if self.url:
+            obj["url"] = self.url
+        if self.local_path:
+            obj["local"] = self.local_path
+        if self.thumbnail_url:
+            obj["thumbnail"] = self.thumbnail_url
+        if self.thumbnail_local_path:
+            obj["thumbnailLocalPath"] = self.thumbnail_local_path
+        if self.extra:
+            obj["extra"] = self.extra
+        return _json_bytes(obj)
+
+    def decode(self, data: bytes) -> None:
+        obj = json.loads(data or b"{}")
+        self.url = obj.get("url", "")
+        self.local_path = obj.get("local", "")
+        self.thumbnail_url = obj.get("thumbnail", "")
+        self.thumbnail_local_path = obj.get("thumbnailLocalPath", "")
+        self.height = obj.get("height", 0)
+        self.width = obj.get("width", 0)
+        self.extra = obj.get("extra", "")
+        self.size = obj.get("size", 0)
+
+    def conversation_digest(self) -> str:
+        return "[Image]"
+
+
+class FileMessage(MessageContent):
+    CONTENT_TYPE = MESSAGE_CONTENT_TYPE_FILE
+
+    def __init__(self) -> None:
+        self.name = ""
+        self.url = ""
+        self.local_path = ""
+        self.size = 0
+        self.type = ""
+        self.extra = ""
+
+    def encode(self) -> bytes:
+        obj = {"size": self.size}
+        if self.name:
+            obj["name"] = self.name
+        if self.url:
+            obj["url"] = self.url
+        if self.local_path:
+            obj["local"] = self.local_path
+        if self.type:
+            obj["type"] = self.type
+        if self.extra:
+            obj["extra"] = self.extra
+        return _json_bytes(obj)
+
+    def decode(self, data: bytes) -> None:
+        obj = json.loads(data or b"{}")
+        self.name = obj.get("name", "")
+        self.url = obj.get("url", "")
+        self.local_path = obj.get("local", "")
+        self.size = obj.get("size", 0)
+        self.type = obj.get("type", "")
+        self.extra = obj.get("extra", "")
+
+    def conversation_digest(self) -> str:
+        return "[File]"
+
+    def get_search_content(self) -> str:
+        return self.name
+
+
+class VideoMessage(MessageContent):
+    CONTENT_TYPE = MESSAGE_CONTENT_TYPE_VIDEO
+
+    def __init__(self) -> None:
+        self.url = ""
+        self.local_path = ""
+        self.snapshot_url = ""
+        self.snapshot_local_path = ""
+        self.height = 0
+        self.width = 0
+        self.size = 0
+        self.duration = 0
+        self.extra = ""
+
+    def encode(self) -> bytes:
+        obj = {
+            "height": self.height,
+            "width": self.width,
+            "size": self.size,
+            "duration": self.duration,
+        }
+        if self.url:
+            obj["url"] = self.url
+        if self.local_path:
+            obj["local"] = self.local_path
+        if self.snapshot_url:
+            obj["poster"] = self.snapshot_url
+        if self.snapshot_local_path:
+            obj["snapshotLocalPath"] = self.snapshot_local_path
+        if self.extra:
+            obj["extra"] = self.extra
+        return _json_bytes(obj)
+
+    def decode(self, data: bytes) -> None:
+        obj = json.loads(data or b"{}")
+        self.url = obj.get("url", "")
+        self.local_path = obj.get("local", "")
+        self.snapshot_url = obj.get("poster", "")
+        self.snapshot_local_path = obj.get("snapshotLocalPath", "")
+        self.height = obj.get("height", 0)
+        self.width = obj.get("width", 0)
+        self.size = obj.get("size", 0)
+        self.duration = obj.get("duration", 0)
+        self.extra = obj.get("extra", "")
+
+    def conversation_digest(self) -> str:
+        return "[Video]"
+
+
+class VoiceMessage(MessageContent):
+    CONTENT_TYPE = MESSAGE_CONTENT_TYPE_VOICE
+
+    def __init__(self) -> None:
+        self.url = ""
+        self.local_path = ""
+        self.duration = 0
+        self.extra = ""
+
+    def encode(self) -> bytes:
+        obj = {"duration": self.duration}
+        if self.url:
+            obj["url"] = self.url
+        if self.local_path:
+            obj["local"] = self.local_path
+        if self.extra:
+            obj["extra"] = self.extra
+        return _json_bytes(obj)
+
+    def decode(self, data: bytes) -> None:
+        obj = json.loads(data or b"{}")
+        self.url = obj.get("url", "")
+        self.local_path = obj.get("local", "")
+        self.duration = obj.get("duration", 0)
+        self.extra = obj.get("extra", "")
+
+    def conversation_digest(self) -> str:
+        return "[Voice]"
+
+
+class StreamTextMessage(MessageContent):
+    CONTENT_TYPE = MESSAGE_CONTENT_TYPE_STREAM_TEXT
+
+    def __init__(self) -> None:
+        self.content = ""
+        self.is_finished = False
+        self.seq = 0
+
+    def encode(self) -> bytes:
+        obj = {"is_finished": self.is_finished, "seq": self.seq}
+        if self.content:
+            obj["content"] = self.content
+        return _json_bytes(obj)
+
+    def decode(self, data: bytes) -> None:
+        obj = json.loads(data or b"{}")
+        self.content = obj.get("content", "")
+        self.is_finished = obj.get("is_finished", False)
+        self.seq = obj.get("seq", 0)
+
+    def conversation_digest(self) -> str:
+        return self.content
+
+    def get_search_content(self) -> str:
+        return self.content
+
+
+class RecallInfoMessage(MessageContent):
+    CONTENT_TYPE = MESSAGE_CONTENT_TYPE_RECALL_INFO
+
+    def __init__(self) -> None:
+        self.extra: Dict[str, str] = {}
+
+    def encode(self) -> bytes:
+        obj = {}
+        if self.extra:
+            obj["exts"] = self.extra
+        return _json_bytes(obj)
+
+    def decode(self, data: bytes) -> None:
+        obj = json.loads(data or b"{}")
+        self.extra = obj.get("exts", {}) or {}
+
+
+class MergeMessagePreviewUnit:
+    def __init__(self, preview_content: str = "", sender: Optional[UserInfo] = None) -> None:
+        self.preview_content = preview_content
+        self.sender = sender
+
+
+class MergeMessage(MessageContent):
+    CONTENT_TYPE = MESSAGE_CONTENT_TYPE_MERGE
+
+    def __init__(
+        self,
+        title: str = "",
+        conversation: Optional[Conversation] = None,
+        message_id_list: Optional[List[str]] = None,
+        preview_list: Optional[List[MergeMessagePreviewUnit]] = None,
+    ) -> None:
+        message_id_list = list(message_id_list or [])
+        preview_list = list(preview_list or [])
+        if len(message_id_list) > 100:
+            message_id_list = message_id_list[:100]
+        if len(preview_list) > 10:
+            preview_list = preview_list[:10]
+        self.title = title
+        self.container_msg_id = ""
+        self.conversation = conversation
+        self.message_id_list = message_id_list
+        self.preview_list = preview_list
+        self.extra = ""
+
+    def encode(self) -> bytes:
+        dto: Dict[str, object] = {}
+        if self.title:
+            dto["title"] = self.title
+        if self.container_msg_id:
+            dto["containerMsgId"] = self.container_msg_id
+        if self.conversation is not None:
+            if self.conversation.conversation:
+                dto["conversationId"] = self.conversation.conversation
+            if self.conversation.conversation_type:
+                dto["conversationType"] = int(self.conversation.conversation_type)
+            if self.conversation.sub_channel:
+                dto["sub_channel"] = self.conversation.sub_channel
+        if self.message_id_list:
+            dto["messageIdList"] = self.message_id_list
+        previews = []
+        for preview in self.preview_list:
+            unit: Dict[str, str] = {}
+            if preview.preview_content:
+                unit["content"] = preview.preview_content
+            if preview.sender is not None:
+                if preview.sender.user_id:
+                    unit["userId"] = preview.sender.user_id
+                if preview.sender.user_name:
+                    unit["userName"] = preview.sender.user_name
+                if preview.sender.user_portrait:
+                    unit["portrait"] = preview.sender.user_portrait
+            previews.append(unit)
+        if previews:
+            dto["previewList"] = previews
+        if self.extra:
+            dto["extra"] = self.extra
+        return _json_bytes(dto)
+
+    def decode(self, data: bytes) -> None:
+        dto = json.loads(data or b"{}")
+        self.title = dto.get("title", "")
+        self.container_msg_id = dto.get("containerMsgId", "")
+        self.message_id_list = dto.get("messageIdList", []) or []
+        self.extra = dto.get("extra", "")
+        conv_id = dto.get("conversationId", "")
+        if conv_id:
+            self.conversation = Conversation(
+                conversation=conv_id,
+                conversation_type=dto.get("conversationType", 0),
+                sub_channel=dto.get("sub_channel", ""),
+            )
+        self.preview_list = []
+        for unit in dto.get("previewList", []) or []:
+            self.preview_list.append(
+                MergeMessagePreviewUnit(
+                    preview_content=unit.get("content", ""),
+                    sender=UserInfo(
+                        user_id=unit.get("userId", ""),
+                        user_name=unit.get("userName", ""),
+                        user_portrait=unit.get("portrait", ""),
+                    ),
+                )
+            )
+
+    def conversation_digest(self) -> str:
+        return "[Merge]"
+
+
+class ThumbnailPackedImageMessage(MessageContent):
+    CONTENT_TYPE = MESSAGE_CONTENT_TYPE_THUMBNAIL_PACKED_IMAGE
+
+    def __init__(self) -> None:
+        self.image_uri = ""
+        self.local_path = ""
+        self.content = ""
+        self.height = 0
+        self.width = 0
+        self.extra = ""
+        self.size = 0
+
+    def encode(self) -> bytes:
+        obj = {"height": self.height, "width": self.width, "size": self.size}
+        if self.image_uri:
+            obj["imageUri"] = self.image_uri
+        if self.local_path:
+            obj["local"] = self.local_path
+        if self.content:
+            obj["content"] = self.content
+        if self.extra:
+            obj["extra"] = self.extra
+        return _json_bytes(obj)
+
+    def decode(self, data: bytes) -> None:
+        obj = json.loads(data or b"{}")
+        self.image_uri = obj.get("imageUri", "")
+        self.local_path = obj.get("local", "")
+        self.content = obj.get("content", "")
+        self.height = obj.get("height", 0)
+        self.width = obj.get("width", 0)
+        self.extra = obj.get("extra", "")
+        self.size = obj.get("size", 0)
+
+    def conversation_digest(self) -> str:
+        return "[Image]"
+
+
+class SnapshotPackedVideoMessage(MessageContent):
+    CONTENT_TYPE = MESSAGE_CONTENT_TYPE_SNAPSHOT_PACKED_VIDEO
+
+    def __init__(self) -> None:
+        self.sight_url = ""
+        self.local_path = ""
+        self.content = ""
+        self.height = 0
+        self.width = 0
+        self.size = 0
+        self.duration = 0
+        self.name = ""
+        self.extra = ""
+
+    def encode(self) -> bytes:
+        obj = {
+            "height": self.height,
+            "width": self.width,
+            "size": self.size,
+            "duration": self.duration,
+        }
+        if self.sight_url:
+            obj["sightUrl"] = self.sight_url
+        if self.local_path:
+            obj["local"] = self.local_path
+        if self.content:
+            obj["content"] = self.content
+        if self.name:
+            obj["name"] = self.name
+        if self.extra:
+            obj["extra"] = self.extra
+        return _json_bytes(obj)
+
+    def decode(self, data: bytes) -> None:
+        obj = json.loads(data or b"{}")
+        self.sight_url = obj.get("sightUrl", "")
+        self.local_path = obj.get("local", "")
+        self.content = obj.get("content", "")
+        self.height = obj.get("height", 0)
+        self.width = obj.get("width", 0)
+        self.size = obj.get("size", 0)
+        self.duration = obj.get("duration", 0)
+        self.name = obj.get("name", "")
+        self.extra = obj.get("extra", "")
+
+    def conversation_digest(self) -> str:
+        return "[Video]"
+
+
+class UnknownMessage(MessageContent):
+    """Fallback for content types the SDK does not model."""
+
+    def __init__(self, message_type: str = "") -> None:
+        self.message_type = message_type
+        self.content = ""
+        self.flags = 0
+
+    def encode(self) -> bytes:
+        return self.content.encode("utf-8") if isinstance(self.content, str) else bytes(self.content)
+
+    def decode(self, data: bytes) -> None:
+        self.content = data.decode("utf-8", errors="replace") if isinstance(data, (bytes, bytearray)) else str(data)
+
+    def get_content_type(self) -> str:
+        return self.message_type or MESSAGE_CONTENT_TYPE_UNKNOWN
+
+    def get_flags(self) -> int:
+        return self.flags

imbot_sdk/models.py

@@ -0,0 +1,99 @@
+"""High-level domain models exposed to SDK users.
+
+:class:`Conversation`, :class:`Message`, :class:`ConversationInfo`,
+:class:`UserInfo` and friends — plain data holders decoupled from the protobuf
+wire types.
+"""
+
+from dataclasses import dataclass, field
+from typing import Dict, List, Optional
+
+from .pb import appmessages_pb2 as pb
+
+# Message flag bits
+MESSAGE_FLAG_NONE = 0
+MESSAGE_FLAG_IS_CMD = 1
+MESSAGE_FLAG_IS_COUNTABLE = 2
+MESSAGE_FLAG_IS_STATUS = 4
+MESSAGE_FLAG_IS_SAVE = 8
+MESSAGE_FLAG_IS_MODIFIED = 16
+MESSAGE_FLAG_IS_MERGED = 32
+MESSAGE_FLAG_IS_MUTE = 64
+MESSAGE_FLAG_IS_BROADCAST = 128
+
+DEFAULT_MESSAGE_FLAGS = MESSAGE_FLAG_IS_COUNTABLE | MESSAGE_FLAG_IS_SAVE
+
+MESSAGE_CONTENT_TYPE_UNKNOWN = "jg:unknown"
+
+
+@dataclass
+class UserInfo:
+    user_id: str = ""
+    user_name: str = ""
+    user_portrait: str = ""
+    extras: Dict[str, str] = field(default_factory=dict)
+    updated_time: int = 0
+
+
+@dataclass
+class Conversation:
+    """Target conversation + channel type."""
+
+    conversation: str = ""
+    sub_channel: str = ""
+    conversation_type: int = pb.Unknown  # ChannelType enum value
+
+
+@dataclass
+class MessageMentionInfo:
+    mention_type: int = pb.MentionDefault
+    target_user_ids: List[str] = field(default_factory=list)
+
+
+@dataclass
+class Message:
+    conversation: Optional[Conversation] = None
+    msg_id: str = ""
+    has_read: bool = False
+    msg_time: int = 0
+    sender_id: str = ""
+    msg_type: str = ""
+    msg_content: object = None  # a messages.MessageContent subclass
+    group_id: str = ""
+    refered_message: Optional["Message"] = None
+    mention_info: Optional[MessageMentionInfo] = None
+
+
+@dataclass
+class ConversationMentionInfo:
+    sender_id: str = ""
+    msg_id: str = ""
+    msg_time: int = 0
+    mention_type: int = pb.MentionDefault
+
+
+@dataclass
+class ConversationInfo:
+    conversation: Optional[Conversation] = None
+    latest_message: Optional[Message] = None
+    unread_count: int = 0
+    sort_time: int = 0
+    is_top: bool = False
+    mute: bool = False
+    draft: str = ""
+    mention_info: Optional[ConversationMentionInfo] = None
+    display_name: str = ""
+    alias: str = ""
+    portrait: str = ""
+
+
+@dataclass
+class MessageReactionItem:
+    reaction_id: str = ""
+    user_info_list: List[UserInfo] = field(default_factory=list)
+
+
+@dataclass
+class MessageReaction:
+    message_id: str = ""
+    item_list: List[MessageReactionItem] = field(default_factory=list)