portal.py 107 KB

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