1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
|
# Copyright (c) 2022 Tulir Asokan
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
from typing import Dict, List, Optional, Pattern, Union
from html import escape
import re
from attr import dataclass
import attr
from ..primitive import JSON, ContentURI, EventID
from ..util import ExtensibleEnum, Obj, SerializableAttrs, deserializer, field
from .base import BaseRoomEvent, BaseUnsigned
# region Message types
class Format(ExtensibleEnum):
"""A message format. Currently only ``org.matrix.custom.html`` is available.
This will probably be deprecated when extensible events are implemented."""
HTML: "Format" = "org.matrix.custom.html"
TEXT_MESSAGE_TYPES = ("m.text", "m.emote", "m.notice")
MEDIA_MESSAGE_TYPES = ("m.image", "m.sticker", "m.video", "m.audio", "m.file")
class MessageType(ExtensibleEnum):
"""A message type."""
TEXT: "MessageType" = "m.text"
EMOTE: "MessageType" = "m.emote"
NOTICE: "MessageType" = "m.notice"
IMAGE: "MessageType" = "m.image"
STICKER: "MessageType" = "m.sticker"
VIDEO: "MessageType" = "m.video"
AUDIO: "MessageType" = "m.audio"
FILE: "MessageType" = "m.file"
LOCATION: "MessageType" = "m.location"
@property
def is_text(self) -> bool:
return self.value in TEXT_MESSAGE_TYPES
@property
def is_media(self) -> bool:
return self.value in MEDIA_MESSAGE_TYPES
# endregion
# region Relations
@dataclass
class InReplyTo(SerializableAttrs):
event_id: EventID
class RelationType(ExtensibleEnum):
ANNOTATION: "RelationType" = "m.annotation"
REFERENCE: "RelationType" = "m.reference"
REPLACE: "RelationType" = "m.replace"
THREAD: "RelationType" = "m.thread"
@dataclass
class RelatesTo(SerializableAttrs):
"""Message relations. Used for reactions, edits and replies."""
rel_type: RelationType = None
event_id: Optional[EventID] = None
key: Optional[str] = None
is_falling_back: Optional[bool] = None
in_reply_to: Optional[InReplyTo] = field(default=None, json="m.in_reply_to")
def __bool__(self) -> bool:
return (bool(self.rel_type) and bool(self.event_id)) or bool(self.in_reply_to)
def serialize(self) -> JSON:
if not self:
return attr.NOTHING
return super().serialize()
# endregion
# region Base event content
class BaseMessageEventContentFuncs:
"""Base class for the contents of all message-type events (currently m.room.message and
m.sticker). Contains relation helpers."""
body: str
_relates_to: Optional[RelatesTo]
def set_reply(self, reply_to: Union[EventID, "MessageEvent"], **kwargs) -> None:
self.relates_to.in_reply_to = InReplyTo(
event_id=reply_to if isinstance(reply_to, str) else reply_to.event_id
)
def set_thread_parent(
self,
thread_parent: Union[EventID, "MessageEvent"],
last_event_in_thread: Union[EventID, "MessageEvent", None] = None,
disable_reply_fallback: bool = False,
**kwargs,
) -> None:
self.relates_to.rel_type = RelationType.THREAD
self.relates_to.event_id = (
thread_parent if isinstance(thread_parent, str) else thread_parent.event_id
)
if isinstance(thread_parent, MessageEvent) and isinstance(
thread_parent.content, BaseMessageEventContentFuncs
):
self.relates_to.event_id = (
thread_parent.content.get_thread_parent() or self.relates_to.event_id
)
if not disable_reply_fallback:
self.set_reply(last_event_in_thread or thread_parent, **kwargs)
self.relates_to.is_falling_back = True
def set_edit(self, edits: Union[EventID, "MessageEvent"]) -> None:
self.relates_to.rel_type = RelationType.REPLACE
self.relates_to.event_id = edits if isinstance(edits, str) else edits.event_id
# Library consumers may create message content by setting a reply first,
# then later marking it as an edit. As edits can't change the reply, just remove
# the reply metadata when marking as a reply.
if self.relates_to.in_reply_to:
self.relates_to.in_reply_to = None
self.relates_to.is_falling_back = None
def serialize(self) -> JSON:
data = SerializableAttrs.serialize(self)
evt = self.get_edit()
if evt:
new_content = {**data}
del new_content["m.relates_to"]
data["m.new_content"] = new_content
if "body" in data:
data["body"] = f"* {data['body']}"
if "formatted_body" in data:
data["formatted_body"] = f"* {data['formatted_body']}"
return data
@property
def relates_to(self) -> RelatesTo:
if self._relates_to is None:
self._relates_to = RelatesTo()
return self._relates_to
@relates_to.setter
def relates_to(self, relates_to: RelatesTo) -> None:
self._relates_to = relates_to
def get_reply_to(self) -> Optional[EventID]:
if self._relates_to and self._relates_to.in_reply_to:
return self._relates_to.in_reply_to.event_id
return None
def get_edit(self) -> Optional[EventID]:
if self._relates_to and self._relates_to.rel_type == RelationType.REPLACE:
return self._relates_to.event_id
return None
def get_thread_parent(self) -> Optional[EventID]:
if self._relates_to and self._relates_to.rel_type == RelationType.THREAD:
return self._relates_to.event_id
return None
def trim_reply_fallback(self) -> None:
pass
@dataclass
class BaseMessageEventContent(BaseMessageEventContentFuncs):
"""Base event content for all m.room.message-type events."""
msgtype: MessageType = None
body: str = ""
external_url: str = None
_relates_to: Optional[RelatesTo] = attr.ib(default=None, metadata={"json": "m.relates_to"})
# endregion
# region Media info
@dataclass
class JSONWebKey(SerializableAttrs):
key: str = attr.ib(metadata={"json": "k"})
algorithm: str = attr.ib(default="A256CTR", metadata={"json": "alg"})
extractable: bool = attr.ib(default=True, metadata={"json": "ext"})
key_type: str = attr.ib(default="oct", metadata={"json": "kty"})
key_ops: List[str] = attr.ib(factory=lambda: ["encrypt", "decrypt"])
@dataclass
class EncryptedFile(SerializableAttrs):
key: JSONWebKey
iv: str
hashes: Dict[str, str]
url: Optional[ContentURI] = None
version: str = attr.ib(default="v2", metadata={"json": "v"})
@dataclass
class BaseFileInfo(SerializableAttrs):
mimetype: str = None
size: int = None
@dataclass
class ThumbnailInfo(BaseFileInfo, SerializableAttrs):
"""Information about the thumbnail for a document, video, image or location."""
height: int = attr.ib(default=None, metadata={"json": "h"})
width: int = attr.ib(default=None, metadata={"json": "w"})
orientation: int = None
@dataclass
class FileInfo(BaseFileInfo, SerializableAttrs):
"""Information about a document message."""
thumbnail_info: Optional[ThumbnailInfo] = None
thumbnail_file: Optional[EncryptedFile] = None
thumbnail_url: Optional[ContentURI] = None
@dataclass
class ImageInfo(FileInfo, SerializableAttrs):
"""Information about an image message."""
height: int = attr.ib(default=None, metadata={"json": "h"})
width: int = attr.ib(default=None, metadata={"json": "w"})
orientation: int = None
@dataclass
class VideoInfo(ImageInfo, SerializableAttrs):
"""Information about a video message."""
duration: int = None
orientation: int = None
@dataclass
class AudioInfo(BaseFileInfo, SerializableAttrs):
"""Information about an audio message."""
duration: int = None
MediaInfo = Union[ImageInfo, VideoInfo, AudioInfo, FileInfo, Obj]
@dataclass
class LocationInfo(SerializableAttrs):
"""Information about a location message."""
thumbnail_url: Optional[ContentURI] = None
thumbnail_info: Optional[ThumbnailInfo] = None
thumbnail_file: Optional[EncryptedFile] = None
# endregion
# region Event content
@dataclass
class LocationMessageEventContent(BaseMessageEventContent, SerializableAttrs):
geo_uri: str = None
info: LocationInfo = None
html_reply_fallback_regex: Pattern = re.compile(r"^<mx-reply>[\s\S]+</mx-reply>")
@dataclass
class TextMessageEventContent(BaseMessageEventContent, SerializableAttrs):
"""The content of a text message event (m.text, m.notice, m.emote)"""
format: Format = None
formatted_body: str = None
def ensure_has_html(self) -> None:
if not self.formatted_body or self.format != Format.HTML:
self.format = Format.HTML
self.formatted_body = escape(self.body).replace("\n", "<br/>")
def formatted(self, format: Format) -> Optional[str]:
if self.format == format:
return self.formatted_body
return None
def trim_reply_fallback(self) -> None:
if self.get_reply_to() and not getattr(self, "__reply_fallback_trimmed", False):
self._trim_reply_fallback_text()
self._trim_reply_fallback_html()
setattr(self, "__reply_fallback_trimmed", True)
def _trim_reply_fallback_text(self) -> None:
if (
not self.body.startswith("> <") and not self.body.startswith("> * <")
) or "\n" not in self.body:
return
lines = self.body.split("\n")
while len(lines) > 0 and lines[0].startswith("> "):
lines.pop(0)
self.body = "\n".join(lines).strip()
def _trim_reply_fallback_html(self) -> None:
if self.formatted_body and self.format == Format.HTML:
self.formatted_body = html_reply_fallback_regex.sub("", self.formatted_body)
@dataclass
class MediaMessageEventContent(TextMessageEventContent, SerializableAttrs):
"""The content of a media message event (m.image, m.audio, m.video, m.file)"""
url: Optional[ContentURI] = None
info: Optional[MediaInfo] = None
file: Optional[EncryptedFile] = None
filename: Optional[str] = None
@staticmethod
@deserializer(MediaInfo)
@deserializer(Optional[MediaInfo])
def deserialize_info(data: JSON) -> MediaInfo:
if not isinstance(data, dict):
return Obj()
msgtype = data.pop("__mautrix_msgtype", None)
if msgtype == "m.image" or msgtype == "m.sticker":
return ImageInfo.deserialize(data)
elif msgtype == "m.video":
return VideoInfo.deserialize(data)
elif msgtype == "m.audio":
return AudioInfo.deserialize(data)
elif msgtype == "m.file":
return FileInfo.deserialize(data)
else:
return Obj(**data)
MessageEventContent = Union[
TextMessageEventContent, MediaMessageEventContent, LocationMessageEventContent, Obj
]
# endregion
@dataclass
class MessageUnsigned(BaseUnsigned, SerializableAttrs):
"""Unsigned information sent with message events."""
transaction_id: str = None
html_reply_fallback_format = (
"<mx-reply><blockquote>"
"<a href='https://matrix.to/#/{room_id}/{event_id}'>In reply to</a> "
"<a href='https://matrix.to/#/{sender}'>{displayname}</a><br/>"
"{content}"
"</blockquote></mx-reply>"
)
media_reply_fallback_body_map = {
MessageType.IMAGE: "an image",
MessageType.STICKER: "a sticker",
MessageType.AUDIO: "audio",
MessageType.VIDEO: "a video",
MessageType.FILE: "a file",
MessageType.LOCATION: "a location",
}
@dataclass
class MessageEvent(BaseRoomEvent, SerializableAttrs):
"""An m.room.message event"""
content: MessageEventContent
unsigned: Optional[MessageUnsigned] = field(factory=lambda: MessageUnsigned())
@staticmethod
@deserializer(MessageEventContent)
def deserialize_content(data: JSON) -> MessageEventContent:
if not isinstance(data, dict):
return Obj()
rel = data.get("m.relates_to", None) or {}
if rel.get("rel_type", None) == RelationType.REPLACE.value:
data = data.get("m.new_content", data)
data["m.relates_to"] = rel
msgtype = data.get("msgtype", None)
if msgtype in TEXT_MESSAGE_TYPES:
return TextMessageEventContent.deserialize(data)
elif msgtype in MEDIA_MESSAGE_TYPES:
data.get("info", {})["__mautrix_msgtype"] = msgtype
return MediaMessageEventContent.deserialize(data)
elif msgtype == "m.location":
return LocationMessageEventContent.deserialize(data)
else:
return Obj(**data)
|