portal.py 97 KB

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