portal.py 96 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346
  1. # mautrix-signal - A Matrix-Signal puppeting bridge
  2. # Copyright (C) 2022 Tulir Asokan
  3. #
  4. # This program is free software: you can redistribute it and/or modify
  5. # it under the terms of the GNU Affero General Public License as published by
  6. # the Free Software Foundation, either version 3 of the License, or
  7. # (at your option) any later version.
  8. #
  9. # This program is distributed in the hope that it will be useful,
  10. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. # GNU Affero General Public License for more details.
  13. #
  14. # You should have received a copy of the GNU Affero General Public License
  15. # along with this program. If not, see <https://www.gnu.org/licenses/>.
  16. from __future__ import annotations
  17. from typing import TYPE_CHECKING, Any, AsyncGenerator, Awaitable, Callable, Union, cast
  18. from collections import deque
  19. from uuid import UUID, uuid4
  20. import asyncio
  21. import hashlib
  22. import mimetypes
  23. import os
  24. import os.path
  25. import pathlib
  26. import time
  27. from mausignald.errors import (
  28. AttachmentTooLargeError,
  29. NotConnected,
  30. ProfileUnavailableError,
  31. RPCError,
  32. )
  33. from mausignald.types import (
  34. AccessControlMode,
  35. Address,
  36. AnnouncementsMode,
  37. Attachment,
  38. Group,
  39. GroupAccessControl,
  40. GroupChange,
  41. GroupID,
  42. GroupMember,
  43. GroupMemberRole,
  44. GroupV2,
  45. GroupV2ID,
  46. LinkPreview,
  47. Mention,
  48. MessageData,
  49. Profile,
  50. Quote,
  51. QuotedAttachment,
  52. Reaction,
  53. SharedContact,
  54. Sticker,
  55. )
  56. from mautrix.appservice import AppService, IntentAPI
  57. from mautrix.bridge import BasePortal, RejectMatrixInvite, async_getter_lock
  58. from mautrix.errors import IntentError, MatrixError, MBadState, MForbidden
  59. from mautrix.types import (
  60. AudioInfo,
  61. BeeperMessageStatusEventContent,
  62. ContentURI,
  63. EncryptedEvent,
  64. EncryptedFile,
  65. EventID,
  66. EventType,
  67. FileInfo,
  68. ImageInfo,
  69. JoinRule,
  70. MediaMessageEventContent,
  71. Membership,
  72. MessageEvent,
  73. MessageEventContent,
  74. MessageStatus,
  75. MessageStatusReason,
  76. MessageType,
  77. PowerLevelStateEventContent,
  78. RelatesTo,
  79. RelationType,
  80. RoomID,
  81. TextMessageEventContent,
  82. UserID,
  83. VideoInfo,
  84. )
  85. from mautrix.util import ffmpeg, variation_selector
  86. from mautrix.util.format_duration import format_duration
  87. from mautrix.util.message_send_checkpoint import MessageSendCheckpointStatus
  88. from . import matrix as m, puppet as p, signal as s, user as u
  89. from .config import Config
  90. from .db import (
  91. DisappearingMessage,
  92. Message as DBMessage,
  93. Portal as DBPortal,
  94. Reaction as DBReaction,
  95. )
  96. from .formatter import matrix_to_signal, signal_to_matrix
  97. from .util import id_to_str
  98. if TYPE_CHECKING:
  99. from .__main__ import SignalBridge
  100. try:
  101. from mautrix.crypto.attachments import decrypt_attachment, encrypt_attachment
  102. except ImportError:
  103. encrypt_attachment = decrypt_attachment = None
  104. try:
  105. from signalstickers_client import StickersClient
  106. from signalstickers_client.models import StickerPack
  107. except ImportError:
  108. StickersClient = StickerPack = None
  109. try:
  110. from mautrix.util import magic
  111. except ImportError:
  112. magic = None
  113. StateBridge = EventType.find("m.bridge", EventType.Class.STATE)
  114. StateHalfShotBridge = EventType.find("uk.half-shot.bridge", EventType.Class.STATE)
  115. ChatInfo = Union[Group, GroupV2, GroupV2ID, Profile, Address]
  116. MAX_MATRIX_MESSAGE_SIZE = 30000
  117. BEEPER_LINK_PREVIEWS_KEY = "com.beeper.linkpreviews"
  118. BEEPER_IMAGE_ENCRYPTION_KEY = "beeper:image:encryption"
  119. class UnknownReactionTarget(Exception):
  120. pass
  121. class Portal(DBPortal, BasePortal):
  122. by_mxid: dict[RoomID, Portal] = {}
  123. by_chat_id: dict[tuple[str, str], Portal] = {}
  124. _sticker_meta_cache: dict[str, StickerPack] = {}
  125. disappearing_msg_class = DisappearingMessage
  126. config: Config
  127. matrix: m.MatrixHandler
  128. signal: s.SignalHandler
  129. az: AppService
  130. private_chat_portal_meta: bool
  131. expiration_time: int | None
  132. _main_intent: IntentAPI | None
  133. _create_room_lock: asyncio.Lock
  134. _msgts_dedup: deque[tuple[Address, int]]
  135. _reaction_dedup: deque[tuple[Address, int, str, Address, bool]]
  136. _reaction_lock: asyncio.Lock
  137. _pending_members: set[UUID] | None
  138. _expiration_lock: asyncio.Lock
  139. def __init__(
  140. self,
  141. chat_id: GroupID | Address,
  142. receiver: str,
  143. mxid: RoomID | None = None,
  144. name: str | None = None,
  145. topic: str | None = None,
  146. avatar_hash: str | None = None,
  147. avatar_url: ContentURI | None = None,
  148. name_set: bool = False,
  149. avatar_set: bool = False,
  150. revision: int = 0,
  151. encrypted: bool = False,
  152. relay_user_id: UserID | None = None,
  153. expiration_time: int | None = None,
  154. ) -> None:
  155. super().__init__(
  156. chat_id=chat_id,
  157. receiver=receiver,
  158. mxid=mxid,
  159. name=name,
  160. topic=topic,
  161. avatar_hash=avatar_hash,
  162. avatar_url=avatar_url,
  163. name_set=name_set,
  164. avatar_set=avatar_set,
  165. revision=revision,
  166. encrypted=encrypted,
  167. relay_user_id=relay_user_id,
  168. expiration_time=expiration_time,
  169. )
  170. BasePortal.__init__(self)
  171. self._create_room_lock = asyncio.Lock()
  172. self.log = self.log.getChild(self.chat_id_str)
  173. self._main_intent = None
  174. self._msgts_dedup = deque(maxlen=100)
  175. self._reaction_dedup = deque(maxlen=100)
  176. self._last_participant_update = set()
  177. self._reaction_lock = asyncio.Lock()
  178. self._pending_members = None
  179. self._relay_user = None
  180. self._expiration_lock = asyncio.Lock()
  181. @property
  182. def main_intent(self) -> IntentAPI:
  183. if not self._main_intent:
  184. raise ValueError("Portal must be postinit()ed before main_intent can be used")
  185. return self._main_intent
  186. @property
  187. def is_direct(self) -> bool:
  188. return isinstance(self.chat_id, Address)
  189. @property
  190. def disappearing_enabled(self) -> bool:
  191. return self.is_direct or self.config["signal.enable_disappearing_messages_in_groups"]
  192. def handle_uuid_receive(self, uuid: UUID) -> None:
  193. if not self.is_direct or self.chat_id.uuid:
  194. raise ValueError(
  195. "handle_uuid_receive can only be used for private chat portals with a phone "
  196. "number chat_id"
  197. )
  198. del self.by_chat_id[(self.chat_id_str, self.receiver)]
  199. self.chat_id = Address(uuid=uuid)
  200. self.by_chat_id[(self.chat_id_str, self.receiver)] = self
  201. @classmethod
  202. def init_cls(cls, bridge: "SignalBridge") -> None:
  203. cls.config = bridge.config
  204. cls.matrix = bridge.matrix
  205. cls.signal = bridge.signal
  206. cls.az = bridge.az
  207. cls.loop = bridge.loop
  208. BasePortal.bridge = bridge
  209. cls.private_chat_portal_meta = cls.config["bridge.private_chat_portal_meta"]
  210. # region Misc
  211. async def _send_delivery_receipt(self, event_id: EventID) -> None:
  212. if event_id and self.config["bridge.delivery_receipts"]:
  213. try:
  214. await self.az.intent.mark_read(self.mxid, event_id)
  215. except Exception:
  216. self.log.exception("Failed to send delivery receipt for %s", event_id)
  217. async def _upsert_reaction(
  218. self,
  219. existing: DBReaction,
  220. intent: IntentAPI,
  221. mxid: EventID,
  222. sender: p.Puppet | u.User,
  223. message: DBMessage,
  224. emoji: str,
  225. ) -> None:
  226. if existing:
  227. self.log.debug(
  228. f"_upsert_reaction redacting {existing.mxid} and inserting {mxid}"
  229. f" (message: {message.mxid})"
  230. )
  231. try:
  232. await intent.redact(existing.mx_room, existing.mxid)
  233. except MForbidden:
  234. self.log.debug("Unexpected MForbidden redacting reaction", exc_info=True)
  235. await existing.edit(emoji=emoji, mxid=mxid, mx_room=message.mx_room)
  236. else:
  237. self.log.debug(f"_upsert_reaction inserting {mxid} (message: {message.mxid})")
  238. await DBReaction(
  239. mxid=mxid,
  240. mx_room=message.mx_room,
  241. emoji=emoji,
  242. signal_chat_id=self.chat_id,
  243. signal_receiver=self.receiver,
  244. msg_author=message.sender,
  245. msg_timestamp=message.timestamp,
  246. author=sender.address,
  247. ).insert()
  248. # endregion
  249. # region Matrix event handling
  250. @staticmethod
  251. async def _make_attachment(message: MediaMessageEventContent, path: str) -> Attachment:
  252. outgoing_filename = path
  253. if message.msgtype == MessageType.AUDIO:
  254. outgoing_filename = await ffmpeg.convert_path(
  255. path, ".m4a", output_args=("-c:a", "aac"), remove_input=True
  256. )
  257. message.info.mimetype = "audio/mp4"
  258. attachment = Attachment(
  259. custom_filename=message.body,
  260. content_type=message.info.mimetype,
  261. outgoing_filename=str(outgoing_filename),
  262. )
  263. info = message.info
  264. attachment.width = info.get("w", info.get("width", 0))
  265. attachment.height = info.get("h", info.get("height", 0))
  266. attachment.voice_note = message.msgtype == MessageType.AUDIO
  267. return attachment
  268. def _write_outgoing_file(self, data: bytes) -> str:
  269. dir = pathlib.Path(self.config["signal.outgoing_attachment_dir"])
  270. path = dir.joinpath(f"mautrix-signal-{str(uuid4())}")
  271. try:
  272. with open(path, "wb") as file:
  273. file.write(data)
  274. except FileNotFoundError:
  275. dir.mkdir(mode=0o755, parents=True, exist_ok=True)
  276. with open(path, "wb") as file:
  277. file.write(data)
  278. return str(path)
  279. async def _download_matrix_media(self, message: MediaMessageEventContent) -> str:
  280. # Signal limits files to 100 MB
  281. if message.info and message.info.size and message.info.size > 100 * 10**6:
  282. raise AttachmentTooLargeError({"filename": message.body})
  283. if message.file:
  284. data = await self.main_intent.download_media(message.file.url)
  285. data = decrypt_attachment(
  286. data, message.file.key.key, message.file.hashes.get("sha256"), message.file.iv
  287. )
  288. else:
  289. data = await self.main_intent.download_media(message.url)
  290. return self._write_outgoing_file(data)
  291. async def handle_matrix_message(
  292. self, sender: u.User, message: MessageEventContent, event_id: EventID
  293. ) -> None:
  294. try:
  295. await self._handle_matrix_message(sender, message, event_id)
  296. except Exception as e:
  297. self.log.exception(f"Failed to handle Matrix message {event_id}")
  298. status = (
  299. MessageSendCheckpointStatus.UNSUPPORTED
  300. if isinstance(e, AttachmentTooLargeError)
  301. else MessageSendCheckpointStatus.PERM_FAILURE
  302. )
  303. sender.send_remote_checkpoint(
  304. status, event_id, self.mxid, EventType.ROOM_MESSAGE, message.msgtype, error=e
  305. )
  306. await sender.handle_auth_failure(e)
  307. await self._send_error_notice("message", e)
  308. asyncio.create_task(self._send_message_status(event_id, e))
  309. async def _send_error_notice(self, type_name: str, err: Exception) -> None:
  310. if not self.config["bridge.delivery_error_reports"]:
  311. return
  312. message = f"{type(err).__name__}: {err}"
  313. if isinstance(err, NotConnected):
  314. message = "There was an error connecting to signald."
  315. elif isinstance(err, UnknownReactionTarget):
  316. message = "Could not find message to react to on Signal."
  317. await self._send_message(
  318. self.main_intent,
  319. TextMessageEventContent(
  320. msgtype=MessageType.NOTICE,
  321. body=f"\u26a0 Your {type_name} was not bridged: {message}",
  322. ),
  323. )
  324. async def _send_message_status(self, event_id: EventID, err: Exception | None) -> None:
  325. if not self.config["bridge.message_status_events"]:
  326. return
  327. intent = self.az.intent if self.encrypted else self.main_intent
  328. status = BeeperMessageStatusEventContent(
  329. network=self.bridge_info_state_key,
  330. relates_to=RelatesTo(
  331. rel_type=RelationType.REFERENCE,
  332. event_id=event_id,
  333. ),
  334. )
  335. if err:
  336. status.reason = MessageStatusReason.GENERIC_ERROR
  337. status.error = str(err)
  338. if isinstance(err, AttachmentTooLargeError):
  339. status.reason = MessageStatusReason.UNSUPPORTED
  340. status.status = MessageStatus.FAIL
  341. status.message = "too large file (maximum is 100MB)"
  342. elif isinstance(err, UnknownReactionTarget):
  343. status.status = MessageStatus.FAIL
  344. else:
  345. status.status = MessageStatus.RETRIABLE
  346. else:
  347. status.status = MessageStatus.SUCCESS
  348. status.fill_legacy_booleans()
  349. await intent.send_message_event(
  350. room_id=self.mxid,
  351. event_type=EventType.BEEPER_MESSAGE_STATUS,
  352. content=status,
  353. )
  354. async def _beeper_link_preview_to_signal(
  355. self, beeper_link_preview: dict[str, Any]
  356. ) -> LinkPreview | None:
  357. link_preview = LinkPreview(
  358. url=beeper_link_preview["matched_url"],
  359. title=beeper_link_preview.get("og:title", ""),
  360. description=beeper_link_preview.get("og:description", ""),
  361. )
  362. if BEEPER_IMAGE_ENCRYPTION_KEY in beeper_link_preview or "og:image" in beeper_link_preview:
  363. if BEEPER_IMAGE_ENCRYPTION_KEY in beeper_link_preview:
  364. file = EncryptedFile.deserialize(beeper_link_preview[BEEPER_IMAGE_ENCRYPTION_KEY])
  365. data = await self.main_intent.download_media(file.url)
  366. data = decrypt_attachment(data, file.key.key, file.hashes.get("sha256"), file.iv)
  367. else:
  368. data = await self.main_intent.download_media(beeper_link_preview["og:image"])
  369. attachment_path = self._write_outgoing_file(data)
  370. link_preview.attachment = Attachment(
  371. content_type=beeper_link_preview.get("og:image:type"),
  372. outgoing_filename=attachment_path,
  373. width=beeper_link_preview.get("og:image:width", 0),
  374. height=beeper_link_preview.get("og:image:height", 0),
  375. size=beeper_link_preview.get("matrix:image:size", 0),
  376. )
  377. return link_preview
  378. async def _handle_matrix_message(
  379. self, sender: u.User, message: MessageEventContent, event_id: EventID
  380. ) -> None:
  381. orig_sender = sender
  382. sender, is_relay = await self.get_relay_sender(sender, f"message {event_id}")
  383. if not sender:
  384. orig_sender.send_remote_checkpoint(
  385. status=MessageSendCheckpointStatus.PERM_FAILURE,
  386. event_id=event_id,
  387. room_id=self.mxid,
  388. event_type=EventType.ROOM_MESSAGE,
  389. message_type=message.msgtype,
  390. error="user is not logged in",
  391. )
  392. return
  393. elif is_relay:
  394. await self.apply_relay_message_format(orig_sender, message)
  395. request_id = int(time.time() * 1000)
  396. self._msgts_dedup.appendleft((sender.address, request_id))
  397. quote = None
  398. if message.get_reply_to():
  399. reply = await DBMessage.get_by_mxid(message.get_reply_to(), self.mxid)
  400. # TODO include actual text? either store in db or fetch event from homeserver
  401. if reply is not None:
  402. quote = Quote(id=reply.timestamp, author=reply.sender, text="")
  403. # TODO only send this when it's actually a reply to an attachment?
  404. # Neither Signal Android nor iOS seem to care though, so this works too
  405. quote.attachments = [QuotedAttachment("", "")]
  406. attachments: list[Attachment] | None = None
  407. attachment_path: str | None = None
  408. mentions: list[Mention] | None = None
  409. link_previews: list[LinkPreview] | None = None
  410. if message.msgtype.is_text:
  411. text, mentions = await matrix_to_signal(message)
  412. message_previews = message.get(BEEPER_LINK_PREVIEWS_KEY, [])
  413. potential_link_previews = await asyncio.gather(
  414. *(self._beeper_link_preview_to_signal(m) for m in message_previews)
  415. )
  416. link_previews = [p for p in potential_link_previews if p is not None]
  417. elif message.msgtype.is_media:
  418. attachment_path = await self._download_matrix_media(message)
  419. attachment = await self._make_attachment(message, attachment_path)
  420. attachments = [attachment]
  421. text = message.body if is_relay else None
  422. self.log.trace("Formed outgoing attachment %s", attachment)
  423. else:
  424. self.log.debug(f"Unknown msgtype {message.msgtype} in Matrix message {event_id}")
  425. return
  426. self.log.debug(f"Sending Matrix message {event_id} to Signal with timestamp {request_id}")
  427. retry_count = await self._signal_send_with_retries(
  428. sender,
  429. event_id,
  430. message_type=message.msgtype,
  431. send_fn=lambda *args, **kwargs: self.signal.send(**kwargs),
  432. event_type=EventType.ROOM_MESSAGE,
  433. username=sender.username,
  434. recipient=self.chat_id,
  435. body=text,
  436. mentions=mentions,
  437. previews=link_previews,
  438. quote=quote,
  439. attachments=attachments,
  440. timestamp=request_id,
  441. )
  442. msg = DBMessage(
  443. mxid=event_id,
  444. mx_room=self.mxid,
  445. sender=sender.address,
  446. timestamp=request_id,
  447. signal_chat_id=self.chat_id,
  448. signal_receiver=self.receiver,
  449. )
  450. await msg.insert()
  451. self.log.debug(f"Handled Matrix message {event_id} -> {request_id}")
  452. if attachment_path and self.config["signal.remove_file_after_handling"]:
  453. try:
  454. os.remove(attachment_path)
  455. except FileNotFoundError:
  456. pass
  457. # Handle disappearing messages
  458. if self.expiration_time and self.disappearing_enabled:
  459. dm = DisappearingMessage(self.mxid, event_id, self.expiration_time)
  460. dm.start_timer()
  461. await dm.insert()
  462. asyncio.create_task(self._disappear_event(dm))
  463. sender.send_remote_checkpoint(
  464. MessageSendCheckpointStatus.SUCCESS,
  465. event_id,
  466. self.mxid,
  467. EventType.ROOM_MESSAGE,
  468. message.msgtype,
  469. retry_num=retry_count,
  470. )
  471. await self._send_delivery_receipt(event_id)
  472. asyncio.create_task(self._send_message_status(event_id, err=None))
  473. async def _signal_send_with_retries(
  474. self,
  475. sender: u.User,
  476. event_id: EventID,
  477. send_fn: Callable,
  478. event_type: EventType,
  479. message_type: MessageType | None = None,
  480. **send_args,
  481. ) -> int:
  482. retry_count = 4
  483. last_error_type = NotConnected
  484. for retry_num in range(retry_count):
  485. try:
  486. req_id = uuid4()
  487. self.log.info(
  488. f"Send attempt {retry_num}. Attempting to send {event_id} with {req_id}"
  489. )
  490. await send_fn(sender, event_id, req_id=req_id, **send_args)
  491. return retry_num
  492. except (NotConnected, UnknownReactionTarget) as e:
  493. if retry_num >= retry_count - 1:
  494. break
  495. last_error_type = type(e)
  496. # Only handle NotConnected and UnknownReactionTarget exceptions so that other
  497. # exceptions actually continue to error.
  498. sleep_seconds = retry_num * 2 + 1
  499. msg = (
  500. f"Not connected to signald. Going to sleep for {sleep_seconds}s. Error: {e}"
  501. if isinstance(e, NotConnected)
  502. else f"UnknownReactionTarget: Going to sleep for {sleep_seconds}s. Error: {e}"
  503. )
  504. self.log.exception(msg)
  505. sender.send_remote_checkpoint(
  506. MessageSendCheckpointStatus.WILL_RETRY,
  507. event_id,
  508. self.mxid,
  509. event_type,
  510. message_type=message_type,
  511. error=msg,
  512. retry_num=retry_num,
  513. )
  514. await asyncio.sleep(sleep_seconds)
  515. except Exception as e:
  516. await sender.handle_auth_failure(e)
  517. raise
  518. event_type_name = {
  519. EventType.ROOM_MESSAGE: "message",
  520. EventType.REACTION: "reaction",
  521. }.get(event_type, str(event_type))
  522. raise last_error_type(f"Failed to send {event_type_name} after {retry_count} retries.")
  523. async def handle_matrix_reaction(
  524. self, sender: u.User, event_id: EventID, reacting_to: EventID, emoji: str
  525. ) -> None:
  526. if not await sender.is_logged_in():
  527. self.log.trace(f"Ignoring reaction by non-logged-in user {sender.mxid}")
  528. return
  529. # Signal doesn't seem to use variation selectors at all
  530. emoji = variation_selector.remove(emoji)
  531. try:
  532. retry_count = await self._signal_send_with_retries(
  533. sender,
  534. event_id,
  535. send_fn=self._handle_matrix_reaction,
  536. event_type=EventType.REACTION,
  537. reacting_to=reacting_to,
  538. emoji=emoji,
  539. )
  540. except Exception as e:
  541. self.log.exception(f"Failed to handle Matrix reaction {event_id} to {reacting_to}")
  542. sender.send_remote_checkpoint(
  543. MessageSendCheckpointStatus.PERM_FAILURE,
  544. event_id,
  545. self.mxid,
  546. EventType.REACTION,
  547. error=e,
  548. )
  549. await self._send_error_notice("reaction", e)
  550. await sender.handle_auth_failure(e)
  551. asyncio.create_task(self._send_message_status(event_id, e))
  552. else:
  553. sender.send_remote_checkpoint(
  554. MessageSendCheckpointStatus.SUCCESS,
  555. event_id,
  556. self.mxid,
  557. EventType.REACTION,
  558. retry_num=retry_count,
  559. )
  560. await self._send_delivery_receipt(event_id)
  561. asyncio.create_task(self._send_message_status(event_id, err=None))
  562. async def _handle_matrix_reaction(
  563. self,
  564. sender: u.User,
  565. event_id: EventID,
  566. reacting_to: EventID,
  567. emoji: str,
  568. req_id: UUID | None = None,
  569. ) -> None:
  570. message = await DBMessage.get_by_mxid(reacting_to, self.mxid)
  571. if not message:
  572. self.log.debug(f"Ignoring reaction to unknown event {reacting_to}")
  573. raise UnknownReactionTarget(f"Ignoring reaction to unknown event {reacting_to}")
  574. async with self._reaction_lock:
  575. existing = await DBReaction.get_by_signal_id(
  576. self.chat_id, self.receiver, message.sender, message.timestamp, sender.address
  577. )
  578. if existing and existing.emoji == emoji:
  579. return
  580. dedup_id = (message.sender, message.timestamp, emoji, sender.address, False)
  581. self._reaction_dedup.appendleft(dedup_id)
  582. reaction = Reaction(
  583. emoji=emoji,
  584. remove=False,
  585. target_author=message.sender,
  586. target_sent_timestamp=message.timestamp,
  587. )
  588. self.log.trace(f"{sender.mxid} reacted to {message.timestamp} with {emoji}")
  589. await self.signal.react(
  590. sender.username, recipient=self.chat_id, reaction=reaction, req_id=req_id
  591. )
  592. await self._upsert_reaction(
  593. existing, self.main_intent, event_id, sender, message, emoji
  594. )
  595. async def handle_matrix_redaction(
  596. self, sender: u.User, event_id: EventID, redaction_event_id: EventID
  597. ) -> None:
  598. if not await sender.is_logged_in():
  599. return
  600. message = await DBMessage.get_by_mxid(event_id, self.mxid)
  601. if message:
  602. try:
  603. await message.delete()
  604. await self.signal.remote_delete(
  605. sender.username, recipient=self.chat_id, timestamp=message.timestamp
  606. )
  607. except Exception as e:
  608. self.log.exception(
  609. f"Failed to handle Matrix redaction {redaction_event_id} of "
  610. f"message {event_id} ({message.timestamp})"
  611. )
  612. sender.send_remote_checkpoint(
  613. MessageSendCheckpointStatus.PERM_FAILURE,
  614. redaction_event_id,
  615. self.mxid,
  616. EventType.ROOM_REDACTION,
  617. error=e,
  618. )
  619. await sender.handle_auth_failure(e)
  620. asyncio.create_task(self._send_error_notice("message deletion", e))
  621. asyncio.create_task(self._send_message_status(event_id, e))
  622. else:
  623. self.log.trace(f"Removed {message} after Matrix redaction")
  624. sender.send_remote_checkpoint(
  625. MessageSendCheckpointStatus.SUCCESS,
  626. redaction_event_id,
  627. self.mxid,
  628. EventType.ROOM_REDACTION,
  629. )
  630. await self._send_delivery_receipt(redaction_event_id)
  631. asyncio.create_task(self._send_message_status(redaction_event_id, err=None))
  632. return
  633. reaction = await DBReaction.get_by_mxid(event_id, self.mxid)
  634. if reaction:
  635. try:
  636. await reaction.delete()
  637. remove_reaction = Reaction(
  638. emoji=reaction.emoji,
  639. remove=True,
  640. target_author=reaction.msg_author,
  641. target_sent_timestamp=reaction.msg_timestamp,
  642. )
  643. await self.signal.react(
  644. username=sender.username, recipient=self.chat_id, reaction=remove_reaction
  645. )
  646. except Exception as e:
  647. self.log.exception(
  648. f"Failed to handle Matrix redaction {redaction_event_id} of "
  649. f"reaction {event_id} to {reaction.msg_timestamp}"
  650. )
  651. sender.send_remote_checkpoint(
  652. MessageSendCheckpointStatus.PERM_FAILURE,
  653. redaction_event_id,
  654. self.mxid,
  655. EventType.ROOM_REDACTION,
  656. error=e,
  657. )
  658. await sender.handle_auth_failure(e)
  659. asyncio.create_task(self._send_error_notice("reaction deletion", e))
  660. asyncio.create_task(self._send_message_status(event_id, e))
  661. else:
  662. self.log.trace(f"Removed {reaction} after Matrix redaction")
  663. sender.send_remote_checkpoint(
  664. MessageSendCheckpointStatus.SUCCESS,
  665. redaction_event_id,
  666. self.mxid,
  667. EventType.ROOM_REDACTION,
  668. )
  669. await self._send_delivery_receipt(redaction_event_id)
  670. asyncio.create_task(self._send_message_status(redaction_event_id, err=None))
  671. return
  672. sender.send_remote_checkpoint(
  673. MessageSendCheckpointStatus.PERM_FAILURE,
  674. redaction_event_id,
  675. self.mxid,
  676. EventType.ROOM_REDACTION,
  677. error="No message or reaction found for redaction",
  678. )
  679. status_err = UnknownReactionTarget("No message or reaction found for redaction")
  680. asyncio.create_task(self._send_message_status(redaction_event_id, err=status_err))
  681. async def handle_matrix_join(self, user: u.User) -> None:
  682. if self.is_direct or not await user.is_logged_in():
  683. return
  684. if self._pending_members is None:
  685. self.log.debug(
  686. f"{user.mxid} ({user.uuid}) joined room, but pending_members is None,"
  687. " updating chat info"
  688. )
  689. await self.update_info(user, GroupV2ID(id=self.chat_id))
  690. if self._pending_members is None:
  691. self.log.warning(
  692. f"Didn't get pending member list after info update, {user.mxid} ({user.uuid}) may"
  693. "not be in the group on Signal."
  694. )
  695. elif user.uuid in self._pending_members:
  696. self.log.debug(f"{user.mxid} ({user.uuid}) joined room, accepting invite on Signal")
  697. try:
  698. resp = await self.signal.accept_invitation(user.username, self.chat_id)
  699. self._pending_members.remove(user.uuid)
  700. except RPCError as e:
  701. await self.main_intent.send_notice(
  702. self.mxid, f"\u26a0 Failed to accept invite on Signal: {e}"
  703. )
  704. await user.handle_auth_failure(e)
  705. else:
  706. await self.update_info(user, resp)
  707. async def handle_matrix_leave(self, user: u.User) -> None:
  708. if not await user.is_logged_in():
  709. return
  710. if self.is_direct:
  711. self.log.info(f"{user.mxid} left private chat portal with {self.chat_id}")
  712. if user.username == self.receiver:
  713. self.log.info(
  714. f"{user.mxid} was the recipient of this portal. Cleaning up and deleting..."
  715. )
  716. await self.cleanup_and_delete()
  717. else:
  718. self.log.debug(f"{user.mxid} left portal to {self.chat_id}")
  719. if self.config["bridge.bridge_matrix_leave"]:
  720. await self.signal.leave_group(user.username, self.chat_id)
  721. # TODO cleanup if empty
  722. async def kick_matrix(self, user: u.User | p.Puppet, source: u.User) -> None:
  723. try:
  724. await self.signal.update_group(
  725. source.username, self.chat_id, remove_members=[user.address]
  726. )
  727. except Exception as e:
  728. self.log.exception(f"Failed to kick Signal user: {e}")
  729. info = await self.signal.get_group(source.username, self.chat_id)
  730. if user.address in info.members:
  731. await self.main_intent.invite_user(
  732. self.mxid,
  733. user.mxid,
  734. check_cache=True,
  735. reason=f"Failed to kick Signal user: {e}",
  736. )
  737. await user.intent_for(self).ensure_joined(self.mxid)
  738. async def ban_matrix(self, user: u.User | p.Puppet, source: u.User) -> None:
  739. try:
  740. await self.signal.ban_user(source.username, self.chat_id, users=[user.address])
  741. except Exception as e:
  742. self.log.exception(f"Failed to ban Signal user: {e}")
  743. info = await self.signal.get_group(source.username, self.chat_id)
  744. is_banned = False
  745. if info.banned_members:
  746. for member in info.banned_members:
  747. is_banned = user.address.uuid == member.uuid or is_banned
  748. if not is_banned:
  749. await self.main_intent.unban_user(
  750. self.mxid, user.mxid, reason=f"Failed to ban Signal user: {e}"
  751. )
  752. if user.address in info.members:
  753. await self.main_intent.invite_user(
  754. self.mxid,
  755. user.mxid,
  756. check_cache=True,
  757. )
  758. await user.intent_for(self).ensure_joined(self.mxid)
  759. async def unban_matrix(self, user: u.User | p.Puppet, source: u.User) -> None:
  760. try:
  761. await self.signal.unban_user(source.username, self.chat_id, users=[user.address])
  762. except Exception as e:
  763. self.log.exception(f"Failed to unban Signal user: {e}")
  764. info = await self.signal.get_group(source.username, self.chat_id)
  765. if info.banned_members:
  766. for member in info.banned_members:
  767. if member.uuid == user.address.uuid:
  768. await self.main_intent.ban_user(
  769. self.mxid, user.mxid, reason=f"Failed to unban Signal user: {e}"
  770. )
  771. return
  772. async def handle_matrix_invite(self, invited_by: u.User, user: u.User | p.Puppet) -> None:
  773. if self.is_direct:
  774. raise RejectMatrixInvite("You can't invite additional users to private chats.")
  775. try:
  776. await self.signal.update_group(
  777. invited_by.username, self.chat_id, add_members=[user.address]
  778. )
  779. except RPCError as e:
  780. raise RejectMatrixInvite(str(e)) from e
  781. power_levels = await self.main_intent.get_power_levels(self.mxid)
  782. invitee_pl = power_levels.get_user_level(user.mxid)
  783. if invitee_pl >= 50:
  784. group_member = GroupMember(uuid=user.uuid, role=GroupMemberRole.ADMINISTRATOR)
  785. try:
  786. update_meta = await self.signal.update_group(
  787. invited_by.username, self.chat_id, update_role=group_member
  788. )
  789. self.revision = update_meta.revision
  790. except Exception as e:
  791. self.log.exception(f"Failed to update Signal member role: {e}")
  792. await self._update_power_levels(
  793. await self.signal.get_group(invited_by.username, self.chat_id)
  794. )
  795. async def handle_matrix_name(self, user: u.User, name: str) -> None:
  796. if self.name == name or self.is_direct or not name:
  797. return
  798. sender, is_relay = await self.get_relay_sender(user, "name change")
  799. if not sender:
  800. return
  801. self.name = name
  802. self.log.debug(
  803. f"{user.mxid} changed the group name, sending to Signal through {sender.username}"
  804. )
  805. try:
  806. await self.signal.update_group(sender.username, self.chat_id, title=name)
  807. except Exception as e:
  808. self.log.exception("Failed to update Signal group name")
  809. await user.handle_auth_failure(e)
  810. self.name = None
  811. async def handle_matrix_topic(self, user: u.User, topic: str) -> None:
  812. if self.topic == topic or self.is_direct or not topic:
  813. return
  814. sender, is_relay = await self.get_relay_sender(user, "topic change")
  815. if not sender:
  816. return
  817. self.topic = topic
  818. self.log.debug(
  819. f"{user.mxid} changed the group topic, sending to Signal through {sender.username}"
  820. )
  821. try:
  822. await self.signal.update_group(sender.username, self.chat_id, description=topic)
  823. except Exception:
  824. self.log.exception("Failed to update Signal group description")
  825. self.name = None
  826. async def handle_matrix_avatar(self, user: u.User, url: ContentURI) -> None:
  827. if self.is_direct or not url:
  828. return
  829. sender, is_relay = await self.get_relay_sender(user, "avatar change")
  830. if not sender:
  831. return
  832. data = await self.main_intent.download_media(url)
  833. new_hash = hashlib.sha256(data).hexdigest()
  834. if new_hash == self.avatar_hash and self.avatar_set:
  835. self.log.debug(f"New avatar from Matrix set by {user.mxid} is same as current one")
  836. return
  837. self.avatar_url = url
  838. self.avatar_hash = new_hash
  839. path = self._write_outgoing_file(data)
  840. self.log.debug(
  841. f"{user.mxid} changed the group avatar, sending to Signal through {sender.username}"
  842. )
  843. try:
  844. await self.signal.update_group(sender.username, self.chat_id, avatar_path=path)
  845. self.avatar_set = True
  846. except Exception as e:
  847. self.log.exception("Failed to update Signal group avatar")
  848. await user.handle_auth_failure(e)
  849. self.avatar_set = False
  850. if self.config["signal.remove_file_after_handling"]:
  851. try:
  852. os.remove(path)
  853. except FileNotFoundError:
  854. pass
  855. async def handle_matrix_power_level(
  856. self,
  857. sender: u.User,
  858. levels: PowerLevelStateEventContent,
  859. prev_content: PowerLevelStateEventContent | None = None,
  860. ) -> None:
  861. old_users = prev_content.users if prev_content else None
  862. new_users = levels.users
  863. changes = {}
  864. sender, is_relay = await self.get_relay_sender(sender, "power level change")
  865. if not sender:
  866. return
  867. if not old_users:
  868. changes = new_users
  869. else:
  870. for user, level in new_users.items():
  871. if (
  872. user
  873. and user != self.main_intent.mxid
  874. and (user not in old_users or level != old_users[user])
  875. ):
  876. changes[user] = level
  877. for user, level in old_users.items():
  878. if user and user != self.main_intent.mxid and user not in new_users:
  879. changes[user] = levels.users_default
  880. if changes:
  881. for user, level in changes.items():
  882. address = p.Puppet.get_id_from_mxid(user)
  883. if not address:
  884. mx_user = await u.User.get_by_mxid(user, create=False)
  885. if not mx_user or not mx_user.is_logged_in:
  886. continue
  887. address = mx_user.address
  888. if not address or not address.uuid:
  889. continue
  890. signal_role = (
  891. GroupMemberRole.DEFAULT if level < 50 else GroupMemberRole.ADMINISTRATOR
  892. )
  893. group_member = GroupMember(uuid=address.uuid, role=signal_role)
  894. try:
  895. update_meta = await self.signal.update_group(
  896. sender.username, self.chat_id, update_role=group_member
  897. )
  898. self.revision = update_meta.revision
  899. except Exception as e:
  900. self.log.exception(f"Failed to update Signal member role: {e}")
  901. await self._update_power_levels(
  902. await self.signal.get_group(sender.username, self.chat_id)
  903. )
  904. return
  905. if not prev_content or levels.invite != prev_content.invite:
  906. try:
  907. update_meta = await self.signal.update_group(
  908. username=sender.username,
  909. group_id=self.chat_id,
  910. update_access_control=GroupAccessControl(
  911. members=(
  912. AccessControlMode.MEMBER
  913. if levels.invite == 0
  914. else AccessControlMode.ADMINISTRATOR
  915. ),
  916. attributes=None,
  917. link=None,
  918. ),
  919. )
  920. self.revision = update_meta.revision
  921. except Exception as e:
  922. self.log.exception(f"Failed to update Signal member add permission: {e}")
  923. await self._update_power_levels(
  924. await self.signal.get_group(sender.username, self.chat_id)
  925. )
  926. return
  927. if not prev_content or levels.state_default != prev_content.state_default:
  928. try:
  929. update_meta = await self.signal.update_group(
  930. username=sender.username,
  931. group_id=self.chat_id,
  932. update_access_control=GroupAccessControl(
  933. attributes=(
  934. AccessControlMode.MEMBER
  935. if levels.state_default == 0
  936. else AccessControlMode.ADMINISTRATOR
  937. ),
  938. members=None,
  939. link=None,
  940. ),
  941. )
  942. self.revision = update_meta.revision
  943. except Exception as e:
  944. self.log.exception(f"Failed to update Signal metadata change permission: {e}")
  945. await self._update_power_levels(
  946. await self.signal.get_group(sender.username, self.chat_id)
  947. )
  948. # endregion
  949. # region Signal event handling
  950. @staticmethod
  951. async def _resolve_address(address: Address) -> Address:
  952. puppet = await p.Puppet.get_by_address(address, create=False)
  953. return puppet.address
  954. async def _find_quote_event_id(self, quote: Quote | None) -> MessageEvent | EventID | None:
  955. if not quote:
  956. return None
  957. author_address = await self._resolve_address(quote.author)
  958. reply_msg = await DBMessage.get_by_signal_id(
  959. author_address, quote.id, self.chat_id, self.receiver
  960. )
  961. if not reply_msg:
  962. return None
  963. try:
  964. evt = await self.main_intent.get_event(self.mxid, reply_msg.mxid)
  965. if isinstance(evt, EncryptedEvent):
  966. return await self.matrix.e2ee.decrypt(evt, wait_session_timeout=0)
  967. return evt
  968. except MatrixError:
  969. return reply_msg.mxid
  970. async def _signal_link_preview_to_beeper(
  971. self, link_preview: LinkPreview, intent: IntentAPI
  972. ) -> dict[str, Any]:
  973. beeper_link_preview: dict[str, Any] = {
  974. "matched_url": link_preview.url,
  975. "og:title": link_preview.title,
  976. "og:url": link_preview.url,
  977. "og:description": link_preview.description,
  978. }
  979. # Upload an image corresponding to the link preview if it exists.
  980. if link_preview.attachment and link_preview.attachment.incoming_filename:
  981. beeper_link_preview["og:image:type"] = link_preview.attachment.content_type
  982. beeper_link_preview["og:image:height"] = link_preview.attachment.height
  983. beeper_link_preview["og:image:width"] = link_preview.attachment.width
  984. beeper_link_preview["matrix:image:size"] = link_preview.attachment.size
  985. with open(link_preview.attachment.incoming_filename, "rb") as file:
  986. data = file.read()
  987. if self.config["signal.remove_file_after_handling"]:
  988. os.remove(link_preview.attachment.incoming_filename)
  989. upload_mime_type = link_preview.attachment.content_type
  990. if self.encrypted and encrypt_attachment:
  991. data, beeper_link_preview[BEEPER_IMAGE_ENCRYPTION_KEY] = encrypt_attachment(data)
  992. upload_mime_type = "application/octet-stream"
  993. upload_uri = await intent.upload_media(
  994. data,
  995. mime_type=upload_mime_type,
  996. filename=link_preview.attachment.id,
  997. async_upload=self.config["homeserver.async_media"],
  998. )
  999. if BEEPER_IMAGE_ENCRYPTION_KEY in beeper_link_preview:
  1000. beeper_link_preview[BEEPER_IMAGE_ENCRYPTION_KEY].url = upload_uri
  1001. beeper_link_preview[BEEPER_IMAGE_ENCRYPTION_KEY] = beeper_link_preview[
  1002. BEEPER_IMAGE_ENCRYPTION_KEY
  1003. ].serialize()
  1004. else:
  1005. beeper_link_preview["og:image"] = upload_uri
  1006. return beeper_link_preview
  1007. async def handle_signal_message(
  1008. self, source: u.User, sender: p.Puppet, message: MessageData
  1009. ) -> None:
  1010. if (sender.address, message.timestamp) in self._msgts_dedup:
  1011. self.log.debug(
  1012. f"Ignoring message {message.timestamp} by {sender.uuid} as it was already handled "
  1013. "(message.timestamp in dedup queue)"
  1014. )
  1015. await self.signal.send_receipt(
  1016. source.username, sender.address, timestamps=[message.timestamp]
  1017. )
  1018. return
  1019. self._msgts_dedup.appendleft((sender.address, message.timestamp))
  1020. old_message = await DBMessage.get_by_signal_id(
  1021. sender.address, message.timestamp, self.chat_id, self.receiver
  1022. )
  1023. if old_message is not None:
  1024. self.log.debug(
  1025. f"Ignoring message {message.timestamp} by {sender.uuid} as it was already handled "
  1026. "(message.id found in database)"
  1027. )
  1028. await self.signal.send_receipt(
  1029. source.username, sender.address, timestamps=[message.timestamp]
  1030. )
  1031. return
  1032. self.log.debug(f"Started handling message {message.timestamp} by {sender.uuid}")
  1033. self.log.trace(f"Message content: {message}")
  1034. intent = sender.intent_for(self)
  1035. await intent.set_typing(self.mxid, False)
  1036. event_id = None
  1037. reply_to = await self._find_quote_event_id(message.quote)
  1038. if message.sticker:
  1039. if message.sticker.attachment.incoming_filename:
  1040. content = await self._handle_signal_attachment(
  1041. intent, message.sticker.attachment, sticker=True
  1042. )
  1043. elif StickersClient:
  1044. content = await self._handle_signal_sticker(intent, message.sticker)
  1045. else:
  1046. self.log.debug(
  1047. f"Not handling sticker in {message.timestamp}: no incoming_filename and "
  1048. "signalstickers-client not installed."
  1049. )
  1050. return
  1051. if content:
  1052. if message.sticker.attachment.blurhash:
  1053. content.info["blurhash"] = message.sticker.attachment.blurhash
  1054. content.info["xyz.amorgan.blurhash"] = message.sticker.attachment.blurhash
  1055. await self._add_sticker_meta(message.sticker, content)
  1056. if reply_to and not message.body:
  1057. content.set_reply(reply_to)
  1058. reply_to = None
  1059. content.msgtype = None
  1060. event_id = await self._send_message(
  1061. intent, content, timestamp=message.timestamp, event_type=EventType.STICKER
  1062. )
  1063. for contact in message.contacts:
  1064. content = await self._handle_signal_contact(contact)
  1065. if reply_to and not message.body:
  1066. content.set_reply(reply_to)
  1067. reply_to = None
  1068. event_id = await self._send_message(intent, content, timestamp=message.timestamp)
  1069. is_first_text = True
  1070. for attachment in message.attachments:
  1071. if not attachment.incoming_filename:
  1072. self.log.warning(
  1073. "Failed to bridge attachment, no incoming filename: %s", attachment
  1074. )
  1075. continue
  1076. as_text = (
  1077. is_first_text
  1078. and attachment.content_type == "text/x-signal-plain"
  1079. and attachment.size < MAX_MATRIX_MESSAGE_SIZE
  1080. )
  1081. file_size = attachment.size or os.path.getsize(attachment.incoming_filename)
  1082. if file_size > self.matrix.media_config.upload_size:
  1083. self.log.warning(
  1084. "Failed to bridge attachment %s in %s: file too large",
  1085. attachment.id,
  1086. message.timestamp,
  1087. )
  1088. continue
  1089. content = await self._handle_signal_attachment(intent, attachment, text=as_text)
  1090. if as_text:
  1091. is_first_text = False
  1092. message.body = ""
  1093. if reply_to and not message.body:
  1094. # If there's no text, set the first image as the reply
  1095. content.set_reply(reply_to)
  1096. reply_to = None
  1097. event_id = await self._send_message(intent, content, timestamp=message.timestamp)
  1098. if message.body:
  1099. content = await signal_to_matrix(message)
  1100. if message.previews:
  1101. content[BEEPER_LINK_PREVIEWS_KEY] = await asyncio.gather(
  1102. *(self._signal_link_preview_to_beeper(p, intent) for p in message.previews)
  1103. )
  1104. if reply_to:
  1105. content.set_reply(reply_to)
  1106. event_id = await self._send_message(intent, content, timestamp=message.timestamp)
  1107. if event_id:
  1108. msg = DBMessage(
  1109. mxid=event_id,
  1110. mx_room=self.mxid,
  1111. sender=sender.address,
  1112. timestamp=message.timestamp,
  1113. signal_chat_id=self.chat_id,
  1114. signal_receiver=self.receiver,
  1115. )
  1116. await msg.insert()
  1117. await self.signal.send_receipt(
  1118. source.username, sender.address, timestamps=[message.timestamp]
  1119. )
  1120. await self._send_delivery_receipt(event_id)
  1121. self.log.debug(f"Handled Signal message {message.timestamp} -> {event_id}")
  1122. if message.expires_in_seconds and self.disappearing_enabled:
  1123. await DisappearingMessage(self.mxid, event_id, message.expires_in_seconds).insert()
  1124. self.log.debug(
  1125. f"{event_id} set to be redacted {message.expires_in_seconds} seconds after "
  1126. "room is read"
  1127. )
  1128. else:
  1129. self.log.debug(f"Didn't get event ID for {message.timestamp}")
  1130. async def handle_signal_kicked(self, user: u.User, sender: p.Puppet) -> None:
  1131. self.log.debug(f"{user.mxid} was kicked by {sender.number} from {self.mxid}")
  1132. await self._kick_with_puppet(user, sender)
  1133. async def handle_signal_group_change(self, group_change: GroupChange, source: u.User) -> None:
  1134. if self.revision < group_change.revision:
  1135. self.revision = group_change.revision
  1136. else:
  1137. return
  1138. editor = await p.Puppet.get_by_address(group_change.editor)
  1139. editor_intent = editor.intent_for(self)
  1140. if (
  1141. group_change.delete_members
  1142. or group_change.delete_pending_members
  1143. or group_change.delete_requesting_members
  1144. ):
  1145. for address in (
  1146. (group_change.delete_members or [])
  1147. + (group_change.delete_pending_members or [])
  1148. + (group_change.delete_requesting_members or [])
  1149. ):
  1150. users = [
  1151. await p.Puppet.get_by_address(address),
  1152. await u.User.get_by_address(address),
  1153. ]
  1154. for user in users:
  1155. if not user:
  1156. continue
  1157. if user == editor:
  1158. await editor_intent.leave_room(self.mxid)
  1159. else:
  1160. await self._kick_with_puppet(user, editor)
  1161. if group_change.modify_member_roles:
  1162. levels = await editor.intent_for(self).get_power_levels(self.mxid)
  1163. for group_member in group_change.modify_member_roles:
  1164. users = [
  1165. await p.Puppet.get_by_address(Address(uuid=group_member.uuid)),
  1166. await u.User.get_by_uuid(group_member.uuid),
  1167. ]
  1168. for user in users:
  1169. if not user:
  1170. continue
  1171. if group_member.role == GroupMemberRole.ADMINISTRATOR:
  1172. new_pl = 50
  1173. else:
  1174. new_pl = 0
  1175. levels.users[user.mxid] = new_pl
  1176. await self._try_with_puppet(
  1177. lambda i: i.set_power_levels(self.mxid, levels), puppet=editor
  1178. )
  1179. if group_change.new_banned_members:
  1180. for banned_member in group_change.new_banned_members:
  1181. users = [
  1182. await p.Puppet.get_by_address(Address(uuid=banned_member.uuid)),
  1183. await u.User.get_by_uuid(banned_member.uuid),
  1184. ]
  1185. for user in users:
  1186. if not user:
  1187. continue
  1188. try:
  1189. await editor_intent.ban_user(self.mxid, user.mxid)
  1190. except MForbidden:
  1191. try:
  1192. await self.main_intent.ban_user(
  1193. self.mxid, user.mxid, reason=f"banned by {editor.name}"
  1194. )
  1195. except MForbidden as e:
  1196. self.log.debug(f"Could not ban {user.mxid}: {e}")
  1197. except MBadState as e:
  1198. self.log.debug(f"Could not ban {user.mxid}: {e}")
  1199. if group_change.new_unbanned_members:
  1200. for banned_member in group_change.new_unbanned_members:
  1201. users = [
  1202. await p.Puppet.get_by_address(Address(uuid=banned_member.uuid)),
  1203. await u.User.get_by_uuid(banned_member.uuid),
  1204. ]
  1205. for user in users:
  1206. if not user:
  1207. continue
  1208. try:
  1209. await editor_intent.unban_user(self.mxid, user.mxid)
  1210. except MForbidden:
  1211. try:
  1212. await self.main_intent.unban_user(
  1213. self.mxid, user.mxid, reason=f"unbanned by {editor.name}"
  1214. )
  1215. except MForbidden as e:
  1216. self.log.debug(f"Could not unban {user.mxid}: {e}")
  1217. except MBadState as e:
  1218. self.log.debug(f"Could not unban {user.mxid}: {e}")
  1219. if (
  1220. group_change.new_members
  1221. or group_change.new_pending_members
  1222. or group_change.promote_requesting_members
  1223. ):
  1224. banned_users = await self.az.intent.get_room_members(self.mxid, (Membership.BAN,))
  1225. for group_member in (
  1226. (group_change.new_members or [])
  1227. + (group_change.new_pending_members or [])
  1228. + (group_change.promote_requesting_members or [])
  1229. ):
  1230. puppet = await p.Puppet.get_by_address(Address(uuid=group_member.uuid))
  1231. try:
  1232. await source.sync_contact(Address(uuid=group_member.uuid))
  1233. except ProfileUnavailableError:
  1234. self.log.debug(
  1235. f"Profile of puppet with uuid {group_member.uuid} is unavailable"
  1236. )
  1237. users = [puppet, await u.User.get_by_uuid(group_member.uuid)]
  1238. for user in users:
  1239. if not user:
  1240. continue
  1241. if user.mxid in banned_users:
  1242. await self._try_with_puppet(
  1243. lambda i: i.unban_user(self.mxid, user.mxid), puppet=editor
  1244. )
  1245. try:
  1246. await editor_intent.invite_user(self.mxid, user.mxid, check_cache=True)
  1247. except (MForbidden, IntentError):
  1248. try:
  1249. await self.main_intent.invite_user(
  1250. self.mxid,
  1251. user.mxid,
  1252. reason=f"invited by {editor.name}",
  1253. check_cache=True,
  1254. )
  1255. except (MForbidden, IntentError) as e:
  1256. self.log.debug(f"{editor.name} could not invite {user.mxid}: {e}")
  1257. except MBadState as e:
  1258. self.log.debug(f"{editor.name} could not invite {user.mxid}: {e}")
  1259. if group_member in (group_change.new_members or []) + (
  1260. group_change.promote_requesting_members or []
  1261. ) and isinstance(user, p.Puppet):
  1262. try:
  1263. await user.intent_for(self).ensure_joined(self.mxid)
  1264. except IntentError as e:
  1265. self.log.debug(f"{user.name} could not join group: {e}")
  1266. if group_change.promote_pending_members:
  1267. for member in group_change.promote_pending_members:
  1268. try:
  1269. await source.sync_contact(Address(uuid=group_member.uuid))
  1270. except ProfileUnavailableError:
  1271. self.log.debug(
  1272. f"Profile of puppet with uuid {group_member.uuid} is unavailable"
  1273. )
  1274. user = await p.Puppet.get_by_address(address)
  1275. if not user:
  1276. continue
  1277. try:
  1278. await user.intent_for(self).ensure_joined(self.mxid)
  1279. except IntentError as e:
  1280. self.log.debug(f"{user.name} could not join group: {e}")
  1281. if group_change.new_requesting_members:
  1282. for member in group_change.new_requesting_members:
  1283. try:
  1284. await source.sync_contact(Address(uuid=group_member.uuid))
  1285. except ProfileUnavailableError:
  1286. self.log.debug(
  1287. f"Profile of puppet with uuid {group_member.uuid} is unavailable"
  1288. )
  1289. user = await p.Puppet.get_by_address(Address(uuid=member.uuid))
  1290. try:
  1291. await user.intent_for(self).knock(self.mxid, reason="via invite link")
  1292. except (MForbidden, MBadState) as e:
  1293. self.log.debug(f"{user.name} failed knock: {e}")
  1294. if group_change.new_access_control:
  1295. ac = group_change.new_access_control
  1296. if ac.attributes or ac.members:
  1297. levels = await editor.intent_for(self).get_power_levels(self.mxid)
  1298. if ac.attributes:
  1299. meta_edit_level = 50 if ac.attributes == AccessControlMode.ADMINISTRATOR else 0
  1300. levels.events[EventType.ROOM_NAME] = meta_edit_level
  1301. levels.events[EventType.ROOM_AVATAR] = meta_edit_level
  1302. levels.events[EventType.ROOM_TOPIC] = meta_edit_level
  1303. if ac.members:
  1304. levels.invite = 50 if ac.members == AccessControlMode.ADMINISTRATOR else 0
  1305. await self._try_with_puppet(
  1306. lambda i: i.set_power_levels(self.mxid, levels), puppet=editor
  1307. )
  1308. if ac.link:
  1309. join_rule = JoinRule.INVITE
  1310. if ac.link == AccessControlMode.ANY and self.config["bridge.public_portals"]:
  1311. join_rule = JoinRule.PUBLIC
  1312. elif ac.link == AccessControlMode.ADMINISTRATOR:
  1313. join_rule = JoinRule.KNOCK
  1314. await self._try_with_puppet(
  1315. lambda i: i.set_join_rule(self.mxid, join_rule), puppet=editor
  1316. )
  1317. if group_change.new_is_announcement_group:
  1318. levels = await editor.intent_for(self).get_power_levels(self.mxid)
  1319. if group_change.new_is_announcement_group == AnnouncementsMode.ENABLED:
  1320. levels.events_default = 50
  1321. elif group_change.new_is_announcement_group == AnnouncementsMode.DISABLED:
  1322. levels.events_default = 0
  1323. await self._try_with_puppet(
  1324. lambda i: i.set_power_levels(self.mxid, levels), puppet=editor
  1325. )
  1326. changed = False
  1327. if group_change.new_description:
  1328. changed = await self._update_topic(group_change.new_description, editor)
  1329. if group_change.new_title:
  1330. changed = await self._update_name(group_change.new_title, editor) or changed
  1331. if group_change.new_avatar:
  1332. changed = (
  1333. await self._update_avatar(
  1334. await self.signal.get_group(
  1335. source.username, self.chat_id, group_change.revision
  1336. ),
  1337. editor,
  1338. )
  1339. or changed
  1340. )
  1341. if changed:
  1342. await self.update_bridge_info()
  1343. await self.update()
  1344. @staticmethod
  1345. async def _make_media_content(
  1346. attachment: Attachment, data: bytes
  1347. ) -> tuple[MediaMessageEventContent, bytes]:
  1348. if attachment.content_type.startswith("image/"):
  1349. msgtype = MessageType.IMAGE
  1350. info = ImageInfo(
  1351. mimetype=attachment.content_type, width=attachment.width, height=attachment.height
  1352. )
  1353. elif attachment.content_type.startswith("video/"):
  1354. msgtype = MessageType.VIDEO
  1355. info = VideoInfo(
  1356. mimetype=attachment.content_type, width=attachment.width, height=attachment.height
  1357. )
  1358. elif attachment.voice_note or attachment.content_type.startswith("audio/"):
  1359. msgtype = MessageType.AUDIO
  1360. info = AudioInfo(
  1361. mimetype=attachment.content_type if not attachment.voice_note else "audio/ogg"
  1362. )
  1363. else:
  1364. msgtype = MessageType.FILE
  1365. info = FileInfo(mimetype=attachment.content_type)
  1366. info.size = attachment.size or len(data)
  1367. if not attachment.custom_filename:
  1368. ext = mimetypes.guess_extension(info.mimetype) or ""
  1369. attachment.custom_filename = attachment.id + ext
  1370. else:
  1371. for ext in mimetypes.guess_all_extensions(info.mimetype):
  1372. if attachment.custom_filename.endswith(ext):
  1373. break
  1374. else:
  1375. attachment.custom_filename += mimetypes.guess_extension(info.mimetype) or ""
  1376. if attachment.blurhash:
  1377. info["blurhash"] = attachment.blurhash
  1378. info["xyz.amorgan.blurhash"] = attachment.blurhash
  1379. content = MediaMessageEventContent(
  1380. msgtype=msgtype, info=info, body=attachment.custom_filename
  1381. )
  1382. # If this is a voice note, add the additional voice message metadata and convert to OGG.
  1383. if attachment.voice_note:
  1384. content["org.matrix.msc1767.file"] = {
  1385. "url": content.url,
  1386. "name": content.body,
  1387. **(content.file.serialize() if content.file else {}),
  1388. **(content.info.serialize() if content.info else {}),
  1389. }
  1390. content["org.matrix.msc3245.voice"] = {}
  1391. data = await ffmpeg.convert_bytes(
  1392. data, ".ogg", output_args=("-c:a", "libopus"), input_mime=attachment.content_type
  1393. )
  1394. info.size = len(data)
  1395. return content, data
  1396. async def _handle_signal_attachment(
  1397. self, intent: IntentAPI, attachment: Attachment, sticker: bool = False, text: bool = False
  1398. ) -> MediaMessageEventContent | TextMessageEventContent:
  1399. self.log.trace(f"Reuploading attachment {attachment}")
  1400. if not attachment.content_type:
  1401. attachment.content_type = (
  1402. magic.mimetype(attachment.incoming_filename)
  1403. if magic is not None
  1404. else "application/octet-stream"
  1405. )
  1406. with open(attachment.incoming_filename, "rb") as file:
  1407. data = file.read()
  1408. if self.config["signal.remove_file_after_handling"]:
  1409. os.remove(attachment.incoming_filename)
  1410. if text:
  1411. assert attachment.content_type == "text/x-signal-plain"
  1412. assert attachment.size < MAX_MATRIX_MESSAGE_SIZE
  1413. content = TextMessageEventContent(msgtype=MessageType.TEXT, body=data.decode("utf-8"))
  1414. return content
  1415. content, data = await self._make_media_content(attachment, data)
  1416. if sticker:
  1417. self._adjust_sticker_size(content.info)
  1418. await self._upload_attachment(intent, content, data, attachment.id)
  1419. return content
  1420. @staticmethod
  1421. async def _handle_signal_contact(contact: SharedContact) -> TextMessageEventContent:
  1422. msg = f"Shared contact: {contact.name!s}"
  1423. if contact.phone:
  1424. msg += "\n"
  1425. for phone in contact.phone:
  1426. msg += f"\nPhone: {phone.value} ({phone.type_or_label})"
  1427. if contact.email:
  1428. msg += "\n"
  1429. for email in contact.email:
  1430. msg += f"\nEmail: {email.value} ({email.type_or_label})"
  1431. content = TextMessageEventContent(msgtype=MessageType.TEXT, body=msg)
  1432. content["fi.mau.signal.contact"] = contact.serialize()
  1433. return content
  1434. async def _add_sticker_meta(self, sticker: Sticker, content: MediaMessageEventContent) -> None:
  1435. try:
  1436. pack = self._sticker_meta_cache[sticker.pack_id]
  1437. except KeyError:
  1438. self.log.debug(f"Fetching sticker pack metadata for {sticker.pack_id}")
  1439. try:
  1440. async with StickersClient() as client:
  1441. pack = await client.get_pack_metadata(sticker.pack_id, sticker.pack_key)
  1442. self._sticker_meta_cache[sticker.pack_id] = pack
  1443. except Exception:
  1444. self.log.warning(
  1445. f"Failed to fetch pack metadata for {sticker.pack_id}", exc_info=True
  1446. )
  1447. pack = None
  1448. if not pack:
  1449. content.info["fi.mau.signal.sticker"] = {
  1450. "id": sticker.sticker_id,
  1451. "pack": {
  1452. "id": sticker.pack_id,
  1453. "key": sticker.pack_key,
  1454. },
  1455. }
  1456. return
  1457. sticker_meta = pack.stickers[sticker.sticker_id]
  1458. content.body = sticker_meta.emoji
  1459. content.info["fi.mau.signal.sticker"] = {
  1460. "id": sticker.sticker_id,
  1461. "emoji": sticker_meta.emoji,
  1462. "pack": {
  1463. "id": pack.id,
  1464. "key": pack.key,
  1465. "title": pack.title,
  1466. "author": pack.author,
  1467. },
  1468. }
  1469. @staticmethod
  1470. def _adjust_sticker_size(info: ImageInfo) -> None:
  1471. if info.width > 256 or info.height > 256:
  1472. if info.width == info.height:
  1473. info.width = info.height = 256
  1474. elif info.width > info.height:
  1475. info.height = int(info.height / (info.width / 256))
  1476. info.width = 256
  1477. else:
  1478. info.width = int(info.width / (info.height / 256))
  1479. info.height = 256
  1480. async def _handle_signal_sticker(
  1481. self, intent: IntentAPI, sticker: Sticker
  1482. ) -> MediaMessageEventContent | None:
  1483. try:
  1484. self.log.debug(f"Fetching sticker {sticker.pack_id}#{sticker.sticker_id}")
  1485. async with StickersClient() as client:
  1486. data = await client.download_sticker(
  1487. sticker.sticker_id, sticker.pack_id, sticker.pack_key
  1488. )
  1489. except Exception:
  1490. self.log.warning(f"Failed to download sticker {sticker.sticker_id}", exc_info=True)
  1491. return None
  1492. info = ImageInfo(
  1493. mimetype=sticker.attachment.content_type,
  1494. size=len(data),
  1495. width=sticker.attachment.width,
  1496. height=sticker.attachment.height,
  1497. )
  1498. self._adjust_sticker_size(info)
  1499. if magic:
  1500. info.mimetype = magic.mimetype(data)
  1501. ext = mimetypes.guess_extension(info.mimetype)
  1502. if not ext and info.mimetype == "image/webp":
  1503. ext = ".webp"
  1504. content = MediaMessageEventContent(
  1505. msgtype=MessageType.IMAGE, info=info, body=f"sticker{ext}"
  1506. )
  1507. await self._upload_attachment(intent, content, data, sticker.attachment.id)
  1508. return content
  1509. async def _upload_attachment(
  1510. self, intent: IntentAPI, content: MediaMessageEventContent, data: bytes, id: str
  1511. ) -> None:
  1512. upload_mime_type = content.info.mimetype
  1513. if self.encrypted and encrypt_attachment:
  1514. data, content.file = encrypt_attachment(data)
  1515. upload_mime_type = "application/octet-stream"
  1516. content.url = await intent.upload_media(
  1517. data,
  1518. mime_type=upload_mime_type,
  1519. filename=id,
  1520. async_upload=self.config["homeserver.async_media"],
  1521. )
  1522. if content.file:
  1523. content.file.url = content.url
  1524. content.url = None
  1525. # This is a hack for bad clients like Element iOS that require a thumbnail
  1526. if content.info.mimetype.startswith("image/"):
  1527. if content.file:
  1528. content.info.thumbnail_file = content.file
  1529. elif content.url:
  1530. content.info.thumbnail_url = content.url
  1531. async def handle_signal_reaction(
  1532. self, sender: p.Puppet, reaction: Reaction, timestamp: int
  1533. ) -> None:
  1534. author_address = await self._resolve_address(reaction.target_author)
  1535. target_id = reaction.target_sent_timestamp
  1536. async with self._reaction_lock:
  1537. dedup_id = (author_address, target_id, reaction.emoji, sender.address, reaction.remove)
  1538. if dedup_id in self._reaction_dedup:
  1539. return
  1540. self._reaction_dedup.appendleft(dedup_id)
  1541. existing = await DBReaction.get_by_signal_id(
  1542. self.chat_id, self.receiver, author_address, target_id, sender.address
  1543. )
  1544. if reaction.remove:
  1545. if existing:
  1546. try:
  1547. await sender.intent_for(self).redact(existing.mx_room, existing.mxid)
  1548. except IntentError:
  1549. await self.main_intent.redact(existing.mx_room, existing.mxid)
  1550. await existing.delete()
  1551. self.log.trace(f"Removed {existing} after Signal removal")
  1552. return
  1553. elif existing and existing.emoji == reaction.emoji:
  1554. return
  1555. message = await DBMessage.get_by_signal_id(
  1556. author_address, target_id, self.chat_id, self.receiver
  1557. )
  1558. if not message:
  1559. self.log.debug(f"Ignoring reaction to unknown message {target_id}")
  1560. return
  1561. intent = sender.intent_for(self)
  1562. matrix_emoji = variation_selector.add(reaction.emoji)
  1563. mxid = await intent.react(message.mx_room, message.mxid, matrix_emoji, timestamp=timestamp)
  1564. self.log.debug(f"{sender.address} reacted to {message.mxid} -> {mxid}")
  1565. await self._upsert_reaction(existing, intent, mxid, sender, message, reaction.emoji)
  1566. async def handle_signal_delete(self, sender: p.Puppet, message_ts: int) -> None:
  1567. message = await DBMessage.get_by_signal_id(
  1568. sender.address, message_ts, self.chat_id, self.receiver
  1569. )
  1570. if not message:
  1571. return
  1572. await message.delete()
  1573. try:
  1574. await sender.intent_for(self).redact(message.mx_room, message.mxid)
  1575. except MForbidden:
  1576. await self.main_intent.redact(message.mx_room, message.mxid)
  1577. # endregion
  1578. # region Matrix -> Signal metadata
  1579. async def create_signal_group(
  1580. self, source: u.User, levels: PowerLevelStateEventContent
  1581. ) -> None:
  1582. user_mxids = await self.az.intent.get_room_members(
  1583. self.mxid, (Membership.JOIN, Membership.INVITE)
  1584. )
  1585. invitee_addresses = []
  1586. for mxid in user_mxids:
  1587. mx_user = await u.User.get_by_mxid(mxid, create=False)
  1588. if mx_user and mx_user.address and mx_user.username != source.username:
  1589. invitee_addresses.append(mx_user.address)
  1590. puppet = await p.Puppet.get_by_mxid(mxid, create=False)
  1591. if puppet:
  1592. invitee_addresses.append(puppet.address)
  1593. avatar_path: str | None = None
  1594. if self.avatar_url:
  1595. avatar_data = await self.az.intent.download_media(self.avatar_url)
  1596. self.avatar_hash = hashlib.sha256(avatar_data).hexdigest()
  1597. avatar_path = self._write_outgoing_file(avatar_data)
  1598. signal_chat = await self.signal.create_group(
  1599. source.username, title=self.name, members=invitee_addresses, avatar_path=avatar_path
  1600. )
  1601. self.name_set = bool(self.name and signal_chat.title)
  1602. self.avatar_set = bool(self.avatar_url and self.avatar_hash and signal_chat.avatar)
  1603. self.chat_id = signal_chat.id
  1604. await self._postinit()
  1605. await self.insert()
  1606. if avatar_path and self.config["signal.remove_file_after_handling"]:
  1607. try:
  1608. os.remove(avatar_path)
  1609. except FileNotFoundError:
  1610. pass
  1611. if self.topic:
  1612. await self.signal.update_group(source.username, self.chat_id, description=self.topic)
  1613. await self.handle_matrix_power_level(source, levels)
  1614. await self.update()
  1615. await self.update_bridge_info()
  1616. # endregion
  1617. # region Updating portal info
  1618. async def update_info(self, source: u.User, info: ChatInfo) -> None:
  1619. if self.is_direct:
  1620. if not isinstance(info, (Profile, Address)):
  1621. raise ValueError(f"Unexpected type for direct chat update_info: {type(info)}")
  1622. if not self.name:
  1623. puppet = await self.get_dm_puppet()
  1624. if not puppet.name:
  1625. await puppet.update_info(info, source)
  1626. self.name = puppet.name
  1627. return
  1628. if isinstance(info, GroupV2ID):
  1629. try:
  1630. info = await self.signal.get_group(source.username, info.id, info.revision or -1)
  1631. except Exception as e:
  1632. await source.handle_auth_failure(e)
  1633. raise
  1634. if not info:
  1635. self.log.debug(
  1636. f"Failed to get full group v2 info through {source.username}, "
  1637. "cancelling update"
  1638. )
  1639. return
  1640. changed = False
  1641. if isinstance(info, Group):
  1642. changed = await self._update_name(info.name) or changed
  1643. elif isinstance(info, GroupV2):
  1644. if self.revision < info.revision:
  1645. self.revision = info.revision
  1646. changed = True
  1647. elif self.revision > info.revision:
  1648. self.log.warning(
  1649. f"Got outdated info when syncing through {source.username} "
  1650. f"({info.revision} < {self.revision}), ignoring..."
  1651. )
  1652. return
  1653. changed = await self._update_name(info.title) or changed
  1654. changed = await self._update_topic(info.description) or changed
  1655. elif isinstance(info, GroupV2ID):
  1656. return
  1657. else:
  1658. raise ValueError(f"Unexpected type for group update_info: {type(info)}")
  1659. changed = await self._update_avatar(info) or changed
  1660. await self._update_participants(source, info)
  1661. try:
  1662. await self._update_power_levels(info)
  1663. except Exception:
  1664. self.log.warning("Error updating power levels", exc_info=True)
  1665. if changed:
  1666. await self.update_bridge_info()
  1667. await self.update()
  1668. async def update_expires_in_seconds(self, sender: p.Puppet, expires_in_seconds: int) -> None:
  1669. if expires_in_seconds == 0:
  1670. expires_in_seconds = None
  1671. if self.expiration_time == expires_in_seconds:
  1672. return
  1673. assert self.mxid
  1674. self.expiration_time = expires_in_seconds
  1675. await self.update()
  1676. time_str = "Off" if expires_in_seconds is None else format_duration(expires_in_seconds)
  1677. body = f"Set the disappearing message timer to {time_str}"
  1678. content = TextMessageEventContent(msgtype=MessageType.NOTICE, body=body)
  1679. await self._send_message(sender.intent_for(self), content)
  1680. async def get_dm_puppet(self) -> p.Puppet | None:
  1681. if not self.is_direct:
  1682. return None
  1683. return await p.Puppet.get_by_address(self.chat_id)
  1684. async def update_info_from_puppet(self, puppet: p.Puppet | None = None) -> None:
  1685. if not self.is_direct:
  1686. return
  1687. if not puppet:
  1688. puppet = await self.get_dm_puppet()
  1689. await self.update_puppet_name(puppet.name, save=False)
  1690. await self.update_puppet_avatar(puppet.avatar_hash, puppet.avatar_url, save=False)
  1691. async def update_puppet_avatar(
  1692. self, new_hash: str, avatar_url: ContentURI, save: bool = True
  1693. ) -> None:
  1694. if not self.encrypted and not self.private_chat_portal_meta:
  1695. return
  1696. if self.avatar_hash != new_hash or not self.avatar_set:
  1697. self.avatar_hash = new_hash
  1698. self.avatar_url = avatar_url
  1699. if self.mxid:
  1700. try:
  1701. await self.main_intent.set_room_avatar(self.mxid, avatar_url)
  1702. self.avatar_set = True
  1703. except Exception:
  1704. self.log.exception("Error setting avatar")
  1705. self.avatar_set = False
  1706. if save:
  1707. await self.update_bridge_info()
  1708. await self.update()
  1709. async def update_puppet_name(self, name: str, save: bool = True) -> None:
  1710. if not self.encrypted and not self.private_chat_portal_meta:
  1711. return
  1712. changed = await self._update_name(name)
  1713. if changed and save:
  1714. await self.update_bridge_info()
  1715. await self.update()
  1716. async def _update_name(self, name: str, sender: p.Puppet | None = None) -> bool:
  1717. if self.name != name or not self.name_set:
  1718. self.name = name
  1719. if self.mxid:
  1720. try:
  1721. await self._try_with_puppet(
  1722. lambda i: i.set_room_name(self.mxid, self.name), puppet=sender
  1723. )
  1724. self.name_set = True
  1725. except Exception:
  1726. self.log.exception("Error setting name")
  1727. self.name_set = False
  1728. return True
  1729. return False
  1730. async def _update_topic(self, topic: str, sender: p.Puppet | None = None) -> bool:
  1731. if self.topic != topic:
  1732. self.topic = topic
  1733. if self.mxid:
  1734. try:
  1735. await self._try_with_puppet(
  1736. lambda i: i.set_room_topic(self.mxid, self.topic), puppet=sender
  1737. )
  1738. except Exception:
  1739. self.log.exception("Error setting topic")
  1740. self.topic = None
  1741. return True
  1742. return False
  1743. async def _try_with_puppet(
  1744. self, action: Callable[[IntentAPI], Awaitable[Any]], puppet: p.Puppet | None = None
  1745. ) -> None:
  1746. if puppet:
  1747. try:
  1748. await action(puppet.intent_for(self))
  1749. except (MForbidden, IntentError):
  1750. await action(self.main_intent)
  1751. else:
  1752. await action(self.main_intent)
  1753. async def _update_avatar(self, info: ChatInfo, sender: p.Puppet | None = None) -> bool:
  1754. path = None
  1755. if isinstance(info, GroupV2):
  1756. path = info.avatar
  1757. elif isinstance(info, Group):
  1758. path = f"group-{self.chat_id}"
  1759. res = await p.Puppet.upload_avatar(self, path, self.main_intent)
  1760. if res is False:
  1761. return False
  1762. self.avatar_hash, self.avatar_url = res
  1763. if not self.mxid:
  1764. return True
  1765. try:
  1766. await self._try_with_puppet(
  1767. lambda i: i.set_room_avatar(self.mxid, self.avatar_url), puppet=sender
  1768. )
  1769. self.avatar_set = True
  1770. except Exception:
  1771. self.log.exception("Error setting avatar")
  1772. self.avatar_set = False
  1773. return True
  1774. async def _update_participants(self, source: u.User, info: ChatInfo) -> None:
  1775. if not self.mxid or not isinstance(info, (Group, GroupV2)):
  1776. return
  1777. member_events = await self.main_intent.get_members(self.mxid)
  1778. remove_users: set[UserID] = {
  1779. UserID(evt.state_key)
  1780. for evt in member_events
  1781. if evt.content.membership == Membership.JOIN and evt.state_key != self.az.bot_mxid
  1782. }
  1783. pending_members = info.pending_members if isinstance(info, GroupV2) else []
  1784. self._pending_members = {addr.uuid for addr in pending_members}
  1785. for address in info.members + pending_members:
  1786. user = await u.User.get_by_address(address)
  1787. if user:
  1788. remove_users.discard(user.mxid)
  1789. try:
  1790. await self.main_intent.invite_user(self.mxid, user.mxid, check_cache=True)
  1791. except (MForbidden, IntentError, MBadState) as e:
  1792. self.log.debug(f"could not invite {user.mxid}: {e}")
  1793. puppet = await p.Puppet.get_by_address(address)
  1794. try:
  1795. await source.sync_contact(address)
  1796. except ProfileUnavailableError:
  1797. self.log.debug(f"Profile of puppet with {address} is unavailable")
  1798. try:
  1799. await self.main_intent.invite_user(
  1800. self.mxid, puppet.intent_for(self).mxid, check_cache=True
  1801. )
  1802. except (MForbidden, IntentError, MBadState) as e:
  1803. self.log.debug(f"could not invite {user.mxid}: {e}")
  1804. if not address.uuid in self._pending_members:
  1805. await puppet.intent_for(self).ensure_joined(self.mxid)
  1806. remove_users.discard(puppet.default_mxid)
  1807. for mxid in remove_users:
  1808. user = await u.User.get_by_mxid(mxid, create=False)
  1809. if user and await user.is_logged_in():
  1810. try:
  1811. await self.main_intent.kick_user(
  1812. self.mxid, user.mxid, reason="not a member of this Signal group"
  1813. )
  1814. except (MForbidden, MBadState) as e:
  1815. self.log.debug(f"could not kick {user.mxid}: {e}")
  1816. puppet = await p.Puppet.get_by_mxid(mxid, create=False)
  1817. if puppet:
  1818. try:
  1819. await self.main_intent.kick_user(
  1820. self.mxid,
  1821. puppet.intent_for(self).mxid,
  1822. reason="not a member of this Signal group",
  1823. )
  1824. except (MForbidden, MBadState) as e:
  1825. self.log.debug(f"could not kick {user.mxid}: {e}")
  1826. async def _kick_with_puppet(self, user: p.Puppet | u.User, sender: p.Puppet) -> None:
  1827. try:
  1828. await sender.intent_for(self).kick_user(self.mxid, user.mxid)
  1829. except MForbidden:
  1830. try:
  1831. await self.main_intent.kick_user(
  1832. self.mxid, user.mxid, reason=f"removed by {sender.name}"
  1833. )
  1834. except MForbidden as e:
  1835. self.log.debug(f"Could not remove {user.mxid}: {e}")
  1836. except MBadState as e:
  1837. self.log.debug(f"Could not remove {user.mxid}: {e}")
  1838. async def _update_power_levels(self, info: ChatInfo) -> None:
  1839. if not self.mxid:
  1840. return
  1841. power_levels = await self.main_intent.get_power_levels(self.mxid)
  1842. power_levels = await self._get_power_levels(power_levels, info=info, is_initial=False)
  1843. await self.main_intent.set_power_levels(self.mxid, power_levels)
  1844. # endregion
  1845. # region Bridge info state event
  1846. @property
  1847. def bridge_info_state_key(self) -> str:
  1848. return f"net.maunium.signal://signal/{self.chat_id_str}"
  1849. @property
  1850. def bridge_info(self) -> dict[str, Any]:
  1851. return {
  1852. "bridgebot": self.az.bot_mxid,
  1853. "creator": self.main_intent.mxid,
  1854. "protocol": {
  1855. "id": "signal",
  1856. "displayname": "Signal",
  1857. "avatar_url": self.config["appservice.bot_avatar"],
  1858. },
  1859. "channel": {
  1860. "id": self.chat_id_str,
  1861. "displayname": self.name,
  1862. "avatar_url": self.avatar_url,
  1863. },
  1864. }
  1865. async def update_bridge_info(self) -> None:
  1866. if not self.mxid:
  1867. self.log.debug("Not updating bridge info: no Matrix room created")
  1868. return
  1869. try:
  1870. self.log.debug("Updating bridge info...")
  1871. await self.main_intent.send_state_event(
  1872. self.mxid, StateBridge, self.bridge_info, self.bridge_info_state_key
  1873. )
  1874. # TODO remove this once https://github.com/matrix-org/matrix-doc/pull/2346 is in spec
  1875. await self.main_intent.send_state_event(
  1876. self.mxid, StateHalfShotBridge, self.bridge_info, self.bridge_info_state_key
  1877. )
  1878. except Exception:
  1879. self.log.warning("Failed to update bridge info", exc_info=True)
  1880. # endregion
  1881. # region Creating Matrix rooms
  1882. async def update_matrix_room(self, source: u.User, info: ChatInfo) -> None:
  1883. if not self.is_direct and not isinstance(info, (Group, GroupV2, GroupV2ID)):
  1884. raise ValueError(f"Unexpected type for updating group portal: {type(info)}")
  1885. elif self.is_direct and not isinstance(info, (Profile, Address)):
  1886. raise ValueError(f"Unexpected type for updating direct chat portal: {type(info)}")
  1887. try:
  1888. await self._update_matrix_room(source, info)
  1889. except Exception:
  1890. self.log.exception("Failed to update portal")
  1891. async def create_matrix_room(self, source: u.User, info: ChatInfo) -> RoomID | None:
  1892. if not self.is_direct and not isinstance(info, (Group, GroupV2, GroupV2ID)):
  1893. raise ValueError(f"Unexpected type for creating group portal: {type(info)}")
  1894. elif self.is_direct and not isinstance(info, (Profile, Address)):
  1895. raise ValueError(f"Unexpected type for creating direct chat portal: {type(info)}")
  1896. if isinstance(info, Group) and not info.members:
  1897. try:
  1898. groups = await self.signal.list_groups(source.username)
  1899. except Exception as e:
  1900. await source.handle_auth_failure(e)
  1901. raise
  1902. info = next(
  1903. (g for g in groups if isinstance(g, Group) and g.group_id == info.group_id), info
  1904. )
  1905. elif isinstance(info, GroupV2ID) and not isinstance(info, GroupV2):
  1906. self.log.debug(
  1907. f"create_matrix_room() called with {info}, fetching full info from signald"
  1908. )
  1909. try:
  1910. info = await self.signal.get_group(source.username, info.id, info.revision or -1)
  1911. except Exception as e:
  1912. await source.handle_auth_failure(e)
  1913. raise
  1914. if not info:
  1915. self.log.warning(f"Full info not found, canceling room creation")
  1916. return None
  1917. else:
  1918. self.log.trace("get_group() returned full info: %s", info)
  1919. if self.mxid:
  1920. await self.update_matrix_room(source, info)
  1921. return self.mxid
  1922. async with self._create_room_lock:
  1923. return await self._create_matrix_room(source, info)
  1924. def _get_invite_content(self, double_puppet: p.Puppet | None) -> dict[str, Any]:
  1925. invite_content = {}
  1926. if double_puppet:
  1927. invite_content["fi.mau.will_auto_accept"] = True
  1928. if self.is_direct:
  1929. invite_content["is_direct"] = True
  1930. return invite_content
  1931. async def _update_matrix_room(self, source: u.User, info: ChatInfo) -> None:
  1932. puppet = await p.Puppet.get_by_custom_mxid(source.mxid)
  1933. await self.main_intent.invite_user(
  1934. self.mxid,
  1935. source.mxid,
  1936. check_cache=True,
  1937. extra_content=self._get_invite_content(puppet),
  1938. )
  1939. if puppet:
  1940. did_join = await puppet.intent.ensure_joined(self.mxid)
  1941. if did_join and self.is_direct:
  1942. await source.update_direct_chats({self.main_intent.mxid: [self.mxid]})
  1943. await self.update_info(source, info)
  1944. async def _get_power_levels(
  1945. self,
  1946. levels: PowerLevelStateEventContent | None = None,
  1947. info: ChatInfo | None = None,
  1948. is_initial: bool = False,
  1949. ) -> PowerLevelStateEventContent:
  1950. levels = levels or PowerLevelStateEventContent()
  1951. bot_pl = levels.get_user_level(self.az.bot_mxid)
  1952. levels.events_default = 0
  1953. if self.is_direct:
  1954. levels.ban = 99
  1955. levels.kick = 99
  1956. levels.invite = 99
  1957. levels.state_default = 0
  1958. meta_edit_level = 0
  1959. else:
  1960. if isinstance(info, GroupV2):
  1961. ac = info.access_control
  1962. for detail in info.member_detail + info.pending_member_detail:
  1963. puppet = await p.Puppet.get_by_address(Address(uuid=detail.uuid))
  1964. puppet_mxid = puppet.intent_for(self).mxid
  1965. current_level = levels.get_user_level(puppet_mxid)
  1966. if bot_pl > current_level and bot_pl >= 50:
  1967. level = current_level
  1968. if puppet.is_real_user:
  1969. if current_level >= 50 and detail.role == GroupMemberRole.DEFAULT:
  1970. level = 0
  1971. elif (
  1972. current_level < 50 and detail.role == GroupMemberRole.ADMINISTRATOR
  1973. ):
  1974. level = 50
  1975. else:
  1976. level = 50 if detail.role == GroupMemberRole.ADMINISTRATOR else 0
  1977. levels.users[puppet_mxid] = level
  1978. announcements = info.announcements
  1979. else:
  1980. ac = GroupAccessControl()
  1981. announcements = AnnouncementsMode.UNKNOWN
  1982. levels.ban = 50
  1983. levels.kick = 50
  1984. levels.invite = 50 if ac.members == AccessControlMode.ADMINISTRATOR else 0
  1985. levels.state_default = 50
  1986. meta_edit_level = 50 if ac.attributes == AccessControlMode.ADMINISTRATOR else 0
  1987. if announcements == AnnouncementsMode.ENABLED:
  1988. levels.events_default = 50
  1989. levels.events[EventType.REACTION] = 0
  1990. levels.events[EventType.ROOM_NAME] = meta_edit_level
  1991. levels.events[EventType.ROOM_AVATAR] = meta_edit_level
  1992. levels.events[EventType.ROOM_TOPIC] = meta_edit_level
  1993. levels.events[EventType.ROOM_ENCRYPTION] = 50 if self.matrix.e2ee else 99
  1994. levels.events[EventType.ROOM_TOMBSTONE] = 99
  1995. levels.users_default = 0
  1996. # Remote delete is only for your own messages
  1997. levels.redact = 99
  1998. if self.main_intent.mxid not in levels.users:
  1999. levels.users[self.main_intent.mxid] = 9001 if is_initial else 100
  2000. return levels
  2001. async def _create_matrix_room(self, source: u.User, info: ChatInfo) -> RoomID | None:
  2002. if self.mxid:
  2003. await self._update_matrix_room(source, info)
  2004. return self.mxid
  2005. await self.update_info(source, info)
  2006. self.log.debug("Creating Matrix room")
  2007. name: str | None = None
  2008. power_levels = await self._get_power_levels(info=info, is_initial=True)
  2009. initial_state = [
  2010. {
  2011. "type": str(StateBridge),
  2012. "state_key": self.bridge_info_state_key,
  2013. "content": self.bridge_info,
  2014. },
  2015. {
  2016. # TODO remove this once https://github.com/matrix-org/matrix-doc/pull/2346 is in spec
  2017. "type": str(StateHalfShotBridge),
  2018. "state_key": self.bridge_info_state_key,
  2019. "content": self.bridge_info,
  2020. },
  2021. {
  2022. "type": str(EventType.ROOM_POWER_LEVELS),
  2023. "content": power_levels.serialize(),
  2024. },
  2025. ]
  2026. invites = []
  2027. if self.config["bridge.encryption.default"] and self.matrix.e2ee:
  2028. self.encrypted = True
  2029. initial_state.append(
  2030. {
  2031. "type": str(EventType.ROOM_ENCRYPTION),
  2032. "content": self.get_encryption_state_event_json(),
  2033. }
  2034. )
  2035. if self.is_direct:
  2036. invites.append(self.az.bot_mxid)
  2037. if self.is_direct and source.address == self.chat_id:
  2038. name = self.name = "Signal Note to Self"
  2039. elif self.encrypted or self.private_chat_portal_meta or not self.is_direct:
  2040. name = self.name
  2041. if self.avatar_url:
  2042. initial_state.append(
  2043. {
  2044. "type": str(EventType.ROOM_AVATAR),
  2045. "content": {"url": self.avatar_url},
  2046. }
  2047. )
  2048. creation_content = {}
  2049. if not self.config["bridge.federate_rooms"]:
  2050. creation_content["m.federate"] = False
  2051. self.mxid = await self.main_intent.create_room(
  2052. name=name,
  2053. topic=self.topic,
  2054. is_direct=self.is_direct,
  2055. initial_state=initial_state,
  2056. invitees=invites,
  2057. creation_content=creation_content,
  2058. # Make sure the power level event in initial_state is allowed
  2059. # even if the server sends a default power level event before it.
  2060. # TODO remove this if the spec is changed to require servers to
  2061. # use the power level event in initial_state
  2062. power_level_override={"users": {self.main_intent.mxid: 9001}},
  2063. )
  2064. if not self.mxid:
  2065. raise Exception("Failed to create room: no mxid returned")
  2066. self.name_set = bool(name)
  2067. self.avatar_set = bool(self.avatar_url)
  2068. if self.encrypted and self.matrix.e2ee and self.is_direct:
  2069. try:
  2070. await self.az.intent.ensure_joined(self.mxid)
  2071. except Exception:
  2072. self.log.warning("Failed to add bridge bot to new private chat {self.mxid}")
  2073. puppet = await p.Puppet.get_by_custom_mxid(source.mxid)
  2074. await self.main_intent.invite_user(
  2075. self.mxid, source.mxid, extra_content=self._get_invite_content(puppet)
  2076. )
  2077. if puppet:
  2078. try:
  2079. await source.update_direct_chats({self.main_intent.mxid: [self.mxid]})
  2080. await puppet.intent.join_room_by_id(self.mxid)
  2081. except MatrixError:
  2082. self.log.debug(
  2083. "Failed to join custom puppet into newly created portal", exc_info=True
  2084. )
  2085. await self.update()
  2086. self.log.debug(f"Matrix room created: {self.mxid}")
  2087. self.by_mxid[self.mxid] = self
  2088. if not self.is_direct:
  2089. await self._update_participants(source, info)
  2090. return self.mxid
  2091. # endregion
  2092. # region Database getters
  2093. async def _postinit(self) -> None:
  2094. self.by_chat_id[(self.chat_id_str, self.receiver)] = self
  2095. if self.mxid:
  2096. self.by_mxid[self.mxid] = self
  2097. if self.is_direct:
  2098. puppet = await self.get_dm_puppet()
  2099. self._main_intent = puppet.default_mxid_intent
  2100. elif not self.is_direct:
  2101. self._main_intent = self.az.intent
  2102. async def delete(self) -> None:
  2103. await DBMessage.delete_all(self.mxid)
  2104. self.by_mxid.pop(self.mxid, None)
  2105. self.mxid = None
  2106. self.name_set = False
  2107. self.avatar_set = False
  2108. self.relay_user_id = None
  2109. self.topic = None
  2110. self.encrypted = False
  2111. await self.update()
  2112. async def save(self) -> None:
  2113. await self.update()
  2114. @classmethod
  2115. def all_with_room(cls) -> AsyncGenerator[Portal, None]:
  2116. return cls._db_to_portals(super().all_with_room())
  2117. @classmethod
  2118. def find_private_chats_with(cls, other_user: Address) -> AsyncGenerator[Portal, None]:
  2119. return cls._db_to_portals(super().find_private_chats_with(other_user))
  2120. @classmethod
  2121. async def _db_to_portals(cls, query: Awaitable[list[Portal]]) -> AsyncGenerator[Portal, None]:
  2122. portals = await query
  2123. for index, portal in enumerate(portals):
  2124. try:
  2125. yield cls.by_chat_id[(portal.chat_id_str, portal.receiver)]
  2126. except KeyError:
  2127. await portal._postinit()
  2128. yield portal
  2129. @classmethod
  2130. @async_getter_lock
  2131. async def get_by_mxid(cls, mxid: RoomID) -> Portal | None:
  2132. try:
  2133. return cls.by_mxid[mxid]
  2134. except KeyError:
  2135. pass
  2136. portal = cast(cls, await super().get_by_mxid(mxid))
  2137. if portal is not None:
  2138. await portal._postinit()
  2139. return portal
  2140. return None
  2141. @classmethod
  2142. async def get_by_chat_id(
  2143. cls, chat_id: GroupID | Address, *, receiver: str = "", create: bool = False
  2144. ) -> Portal | None:
  2145. if isinstance(chat_id, str):
  2146. receiver = ""
  2147. elif not isinstance(chat_id, Address):
  2148. raise ValueError(f"Invalid chat ID type {type(chat_id)}")
  2149. elif not receiver:
  2150. raise ValueError("Direct chats must have a receiver")
  2151. best_id = id_to_str(chat_id)
  2152. portal = await cls._get_by_chat_id(best_id, receiver, create=create, chat_id=chat_id)
  2153. if portal:
  2154. portal.log.debug(f"get_by_chat_id({chat_id}, {receiver}) -> {hex(id(portal))}")
  2155. return portal
  2156. @classmethod
  2157. @async_getter_lock
  2158. async def _get_by_chat_id(
  2159. cls, best_id: str, receiver: str, *, create: bool, chat_id: GroupID | Address
  2160. ) -> Portal | None:
  2161. try:
  2162. return cls.by_chat_id[(best_id, receiver)]
  2163. except KeyError:
  2164. pass
  2165. portal = cast(cls, await super().get_by_chat_id(chat_id, receiver))
  2166. if portal is not None:
  2167. await portal._postinit()
  2168. return portal
  2169. if create:
  2170. portal = cls(chat_id, receiver)
  2171. await portal.insert()
  2172. await portal._postinit()
  2173. return portal
  2174. return None
  2175. # endregion