portal.py 106 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590
  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. GroupPatchNotAcceptedError,
  30. NotConnected,
  31. ProfileUnavailableError,
  32. RPCError,
  33. )
  34. from mausignald.types import (
  35. AccessControlMode,
  36. Address,
  37. AnnouncementsMode,
  38. Attachment,
  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 background_task, 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[GroupV2, 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. background_task.create(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. background_task.create(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. background_task.create(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. background_task.create(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. background_task.create(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. background_task.create(self._send_error_notice("message deletion", e))
  638. background_task.create(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. background_task.create(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. background_task.create(self._send_error_notice("reaction deletion", e))
  677. background_task.create(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. background_task.create(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. background_task.create(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 GroupPatchNotAcceptedError as e:
  807. update_meta = await self.signal.get_group(invited_by.username, self.chat_id)
  808. if (
  809. user.address not in update_meta.members
  810. and user.address not in update_meta.pending_members
  811. ):
  812. raise RejectMatrixInvite(str(e)) from e
  813. except RPCError as e:
  814. raise RejectMatrixInvite(str(e)) from e
  815. if user.mxid == self.config["bridge.relay.relaybot"] != "@relaybot:example.com":
  816. await self._handle_relaybot_invited(user)
  817. power_levels = await self.main_intent.get_power_levels(self.mxid)
  818. invitee_pl = power_levels.get_user_level(user.mxid)
  819. if invitee_pl >= 50:
  820. group_member = GroupMember(uuid=user.uuid, role=GroupMemberRole.ADMINISTRATOR)
  821. try:
  822. update_meta = await self.signal.update_group(
  823. invited_by.username, self.chat_id, update_role=group_member
  824. )
  825. self.revision = update_meta.revision
  826. except Exception as e:
  827. self.log.exception(f"Failed to update Signal member role: {e}")
  828. await self._update_power_levels(
  829. await self.signal.get_group(invited_by.username, self.chat_id)
  830. )
  831. return update_meta
  832. async def _handle_relaybot_invited(self, user: u.User) -> None:
  833. if not self.config["bridge.relay.enabled"]:
  834. await self.main_intent.send_notice(
  835. self.mxid, "Relay mode is not enabled in this instance of the bridge."
  836. )
  837. else:
  838. await self.set_relay_user(user)
  839. await self.main_intent.send_notice(
  840. self.mxid,
  841. "Messages from non-logged-in users in this room will now be bridged "
  842. "through the relaybot's Signal account.",
  843. )
  844. async def handle_matrix_name(self, user: u.User, name: str) -> None:
  845. if self.name == name or self.is_direct or not name:
  846. return
  847. sender, is_relay = await self.get_relay_sender(user, "name change")
  848. if not sender:
  849. return
  850. self.name = name
  851. self.log.debug(
  852. f"{user.mxid} changed the group name, sending to Signal through {sender.username}"
  853. )
  854. try:
  855. await self.signal.update_group(sender.username, self.chat_id, title=name)
  856. except Exception as e:
  857. self.log.exception("Failed to update Signal group name")
  858. await user.handle_auth_failure(e)
  859. self.name = None
  860. async def handle_matrix_topic(self, user: u.User, topic: str) -> None:
  861. if self.topic == topic or self.is_direct or not topic:
  862. return
  863. sender, is_relay = await self.get_relay_sender(user, "topic change")
  864. if not sender:
  865. return
  866. self.topic = topic
  867. self.log.debug(
  868. f"{user.mxid} changed the group topic, sending to Signal through {sender.username}"
  869. )
  870. try:
  871. await self.signal.update_group(sender.username, self.chat_id, description=topic)
  872. except Exception:
  873. self.log.exception("Failed to update Signal group description")
  874. self.name = None
  875. async def handle_matrix_avatar(self, user: u.User, url: ContentURI) -> None:
  876. if self.is_direct or not url:
  877. return
  878. sender, is_relay = await self.get_relay_sender(user, "avatar change")
  879. if not sender:
  880. return
  881. data = await self.main_intent.download_media(url)
  882. new_hash = hashlib.sha256(data).hexdigest()
  883. if new_hash == self.avatar_hash and self.avatar_set:
  884. self.log.debug(f"New avatar from Matrix set by {user.mxid} is same as current one")
  885. return
  886. self.avatar_url = url
  887. self.avatar_hash = new_hash
  888. path = self._write_outgoing_file(data)
  889. self.log.debug(
  890. f"{user.mxid} changed the group avatar, sending to Signal through {sender.username}"
  891. )
  892. try:
  893. await self.signal.update_group(sender.username, self.chat_id, avatar_path=path)
  894. self.avatar_set = True
  895. except Exception as e:
  896. self.log.exception("Failed to update Signal group avatar")
  897. await user.handle_auth_failure(e)
  898. self.avatar_set = False
  899. if self.config["signal.remove_file_after_handling"]:
  900. try:
  901. os.remove(path)
  902. except FileNotFoundError:
  903. pass
  904. async def handle_matrix_power_level(
  905. self,
  906. sender: u.User,
  907. levels: PowerLevelStateEventContent,
  908. prev_content: PowerLevelStateEventContent | None = None,
  909. ) -> None:
  910. old_users = prev_content.users if prev_content else None
  911. new_users = levels.users
  912. changes = {}
  913. sender, is_relay = await self.get_relay_sender(sender, "power level change")
  914. if not sender:
  915. return
  916. if not old_users:
  917. changes = new_users
  918. else:
  919. for user, level in new_users.items():
  920. if (
  921. user
  922. and user != self.main_intent.mxid
  923. and (user not in old_users or level != old_users[user])
  924. ):
  925. changes[user] = level
  926. for user, level in old_users.items():
  927. if user and user != self.main_intent.mxid and user not in new_users:
  928. changes[user] = levels.users_default
  929. if changes:
  930. for user, level in changes.items():
  931. uuid = p.Puppet.get_id_from_mxid(user)
  932. if not uuid:
  933. mx_user = await u.User.get_by_mxid(user, create=False)
  934. if not mx_user or not mx_user.is_logged_in:
  935. continue
  936. uuid = mx_user.uuid
  937. if not uuid:
  938. continue
  939. signal_role = (
  940. GroupMemberRole.DEFAULT if level < 50 else GroupMemberRole.ADMINISTRATOR
  941. )
  942. group_member = GroupMember(uuid=uuid, role=signal_role)
  943. try:
  944. update_meta = await self.signal.update_group(
  945. sender.username, self.chat_id, update_role=group_member
  946. )
  947. self.revision = update_meta.revision
  948. except Exception as e:
  949. self.log.exception(f"Failed to update Signal member role: {e}")
  950. await self._update_power_levels(
  951. await self.signal.get_group(sender.username, self.chat_id)
  952. )
  953. return
  954. if not prev_content or levels.invite != prev_content.invite:
  955. try:
  956. update_meta = await self.signal.update_group(
  957. username=sender.username,
  958. group_id=self.chat_id,
  959. update_access_control=GroupAccessControl(
  960. members=(
  961. AccessControlMode.MEMBER
  962. if levels.invite == 0
  963. else AccessControlMode.ADMINISTRATOR
  964. ),
  965. attributes=None,
  966. link=None,
  967. ),
  968. )
  969. self.revision = update_meta.revision
  970. except Exception as e:
  971. self.log.exception(f"Failed to update Signal member add permission: {e}")
  972. await self._update_power_levels(
  973. await self.signal.get_group(sender.username, self.chat_id)
  974. )
  975. return
  976. if not prev_content or levels.state_default != prev_content.state_default:
  977. try:
  978. update_meta = await self.signal.update_group(
  979. username=sender.username,
  980. group_id=self.chat_id,
  981. update_access_control=GroupAccessControl(
  982. attributes=(
  983. AccessControlMode.MEMBER
  984. if levels.state_default == 0
  985. else AccessControlMode.ADMINISTRATOR
  986. ),
  987. members=None,
  988. link=None,
  989. ),
  990. )
  991. self.revision = update_meta.revision
  992. except Exception as e:
  993. self.log.exception(f"Failed to update Signal metadata change permission: {e}")
  994. await self._update_power_levels(
  995. await self.signal.get_group(sender.username, self.chat_id)
  996. )
  997. async def handle_matrix_join_rules(self, sender: u.User, join_rule: JoinRule) -> None:
  998. if join_rule == JoinRule.PUBLIC:
  999. link_access = AccessControlMode.ANY
  1000. elif join_rule == JoinRule.INVITE:
  1001. link_access = AccessControlMode.UNSATISFIABLE
  1002. else:
  1003. link_access = AccessControlMode.ADMINISTRATOR
  1004. sender, is_relay = await self.get_relay_sender(sender, "join_rule change")
  1005. if not sender:
  1006. return
  1007. try:
  1008. update_meta = await self.signal.update_group(
  1009. sender.username,
  1010. self.chat_id,
  1011. update_access_control=GroupAccessControl(
  1012. attributes=None, members=None, link=link_access
  1013. ),
  1014. )
  1015. self.revision = update_meta.revision
  1016. except Exception as e:
  1017. self.log.exception(f"Failed to update Signal link access control: {e}")
  1018. await self._update_join_rules(
  1019. await self.signal.get_group(sender.username, self.chat_id)
  1020. )
  1021. async def matrix_accept_knock(self, sender: u.User, user: p.Puppet | u.User) -> None:
  1022. try:
  1023. await self.signal.approve_membership(
  1024. sender.username, self.chat_id, members=[user.address]
  1025. )
  1026. if isinstance(user, p.Puppet):
  1027. await user.intent_for(self).ensure_joined(self.mxid)
  1028. except RPCError as e:
  1029. info = await self.signal.get_group(sender.username, self.chat_id)
  1030. if user.address in info.requesting_members:
  1031. raise RejectMatrixInvite(str(e)) from e
  1032. power_levels = await self.main_intent.get_power_levels(self.mxid)
  1033. invitee_pl = power_levels.get_user_level(user.mxid)
  1034. if invitee_pl >= 50:
  1035. group_member = GroupMember(uuid=user.uuid, role=GroupMemberRole.ADMINISTRATOR)
  1036. try:
  1037. update_meta = await self.signal.update_group(
  1038. sender.username, self.chat_id, update_role=group_member
  1039. )
  1040. self.revision = update_meta.revision
  1041. except Exception as e:
  1042. self.log.exception(f"Failed to update Signal member role: {e}")
  1043. await self._update_power_levels(
  1044. await self.signal.get_group(sender.username, self.chat_id)
  1045. )
  1046. async def matrix_reject_knock(self, sender: u.User, user: p.Puppet | u.User) -> None:
  1047. try:
  1048. await self.signal.refuse_membership(
  1049. sender.username, self.chat_id, members=[user.address]
  1050. )
  1051. except RPCError as e:
  1052. info = await self.signal.get_group(sender.username, self.chat_id)
  1053. if user.address in info.requesting_members:
  1054. await user.intent_for(self).knock(
  1055. self.mxid,
  1056. reason=f"refusing membership failed: {e}",
  1057. servers=[self.config["homeserver.domain"]],
  1058. )
  1059. # endregion
  1060. # region Signal event handling
  1061. async def _find_quote_event_id(self, quote: Quote | None) -> MessageEvent | EventID | None:
  1062. if not quote:
  1063. return None
  1064. puppet = await p.Puppet.get_by_address(quote.author, create=False)
  1065. if not puppet:
  1066. return None
  1067. reply_msg = await DBMessage.get_by_signal_id(
  1068. puppet.uuid, quote.id, self.chat_id, self.receiver
  1069. )
  1070. if not reply_msg:
  1071. return None
  1072. try:
  1073. evt = await self.main_intent.get_event(self.mxid, reply_msg.mxid)
  1074. if isinstance(evt, EncryptedEvent):
  1075. return await self.matrix.e2ee.decrypt(evt, wait_session_timeout=0)
  1076. return evt
  1077. except MatrixError:
  1078. return reply_msg.mxid
  1079. async def _signal_link_preview_to_beeper(
  1080. self, link_preview: LinkPreview, intent: IntentAPI
  1081. ) -> dict[str, Any]:
  1082. beeper_link_preview: dict[str, Any] = {
  1083. "matched_url": link_preview.url,
  1084. "og:title": link_preview.title,
  1085. "og:url": link_preview.url,
  1086. "og:description": link_preview.description,
  1087. }
  1088. # Upload an image corresponding to the link preview if it exists.
  1089. if link_preview.attachment and link_preview.attachment.incoming_filename:
  1090. beeper_link_preview["og:image:type"] = link_preview.attachment.content_type
  1091. beeper_link_preview["og:image:height"] = link_preview.attachment.height
  1092. beeper_link_preview["og:image:width"] = link_preview.attachment.width
  1093. beeper_link_preview["matrix:image:size"] = link_preview.attachment.size
  1094. with open(link_preview.attachment.incoming_filename, "rb") as file:
  1095. data = file.read()
  1096. if self.config["signal.remove_file_after_handling"]:
  1097. os.remove(link_preview.attachment.incoming_filename)
  1098. upload_mime_type = link_preview.attachment.content_type
  1099. if self.encrypted and encrypt_attachment:
  1100. data, beeper_link_preview[BEEPER_IMAGE_ENCRYPTION_KEY] = encrypt_attachment(data)
  1101. upload_mime_type = "application/octet-stream"
  1102. upload_uri = await intent.upload_media(
  1103. data,
  1104. mime_type=upload_mime_type,
  1105. filename=link_preview.attachment.id,
  1106. async_upload=self.config["homeserver.async_media"],
  1107. )
  1108. if BEEPER_IMAGE_ENCRYPTION_KEY in beeper_link_preview:
  1109. beeper_link_preview[BEEPER_IMAGE_ENCRYPTION_KEY].url = upload_uri
  1110. beeper_link_preview[BEEPER_IMAGE_ENCRYPTION_KEY] = beeper_link_preview[
  1111. BEEPER_IMAGE_ENCRYPTION_KEY
  1112. ].serialize()
  1113. else:
  1114. beeper_link_preview["og:image"] = upload_uri
  1115. return beeper_link_preview
  1116. async def handle_signal_message(
  1117. self, source: u.User, sender: p.Puppet, message: MessageData
  1118. ) -> None:
  1119. if (sender.uuid, message.timestamp) in self._msgts_dedup:
  1120. self.log.debug(
  1121. f"Ignoring message {message.timestamp} by {sender.uuid} as it was already handled "
  1122. "(message.timestamp in dedup queue)"
  1123. )
  1124. await self.signal.send_receipt(
  1125. source.username, sender.address, timestamps=[message.timestamp]
  1126. )
  1127. return
  1128. self._msgts_dedup.appendleft((sender.uuid, message.timestamp))
  1129. old_message = await DBMessage.get_by_signal_id(
  1130. sender.uuid, message.timestamp, self.chat_id, self.receiver
  1131. )
  1132. if old_message is not None:
  1133. self.log.debug(
  1134. f"Ignoring message {message.timestamp} by {sender.uuid} as it was already handled "
  1135. "(message.id found in database)"
  1136. )
  1137. await self.signal.send_receipt(
  1138. source.username, sender.address, timestamps=[message.timestamp]
  1139. )
  1140. return
  1141. self.log.debug(f"Started handling message {message.timestamp} by {sender.uuid}")
  1142. self.log.trace(f"Message content: {message}")
  1143. intent = sender.intent_for(self)
  1144. await intent.set_typing(self.mxid, timeout=0)
  1145. event_id = None
  1146. reply_to = await self._find_quote_event_id(message.quote)
  1147. if message.sticker:
  1148. if message.sticker.attachment.incoming_filename:
  1149. content = await self._handle_signal_attachment(
  1150. intent, message.sticker.attachment, sticker=True
  1151. )
  1152. elif StickersClient:
  1153. content = await self._handle_signal_sticker(intent, message.sticker)
  1154. else:
  1155. self.log.debug(
  1156. f"Not handling sticker in {message.timestamp}: no incoming_filename and "
  1157. "signalstickers-client not installed."
  1158. )
  1159. return
  1160. if content:
  1161. if message.sticker.attachment.blurhash:
  1162. content.info["blurhash"] = message.sticker.attachment.blurhash
  1163. content.info["xyz.amorgan.blurhash"] = message.sticker.attachment.blurhash
  1164. await self._add_sticker_meta(message.sticker, content)
  1165. if reply_to and not message.body:
  1166. content.set_reply(reply_to)
  1167. reply_to = None
  1168. content.msgtype = None
  1169. event_id = await self._send_message(
  1170. intent, content, timestamp=message.timestamp, event_type=EventType.STICKER
  1171. )
  1172. for contact in message.contacts:
  1173. content = await self._handle_signal_contact(contact)
  1174. if reply_to and not message.body:
  1175. content.set_reply(reply_to)
  1176. reply_to = None
  1177. event_id = await self._send_message(intent, content, timestamp=message.timestamp)
  1178. is_first_text = True
  1179. for attachment in message.attachments:
  1180. as_text = (
  1181. is_first_text
  1182. and attachment.content_type == "text/x-signal-plain"
  1183. and attachment.size < MAX_MATRIX_MESSAGE_SIZE
  1184. )
  1185. content = await self._handle_signal_attachment(intent, attachment, text=as_text)
  1186. if as_text:
  1187. is_first_text = False
  1188. message.body = ""
  1189. if reply_to and not message.body:
  1190. # If there's no text, set the first image as the reply
  1191. content.set_reply(reply_to)
  1192. reply_to = None
  1193. event_id = await self._send_message(intent, content, timestamp=message.timestamp)
  1194. if message.body:
  1195. content = await signal_to_matrix(message)
  1196. if message.previews:
  1197. content[BEEPER_LINK_PREVIEWS_KEY] = await asyncio.gather(
  1198. *(self._signal_link_preview_to_beeper(p, intent) for p in message.previews)
  1199. )
  1200. if reply_to:
  1201. content.set_reply(reply_to)
  1202. event_id = await self._send_message(intent, content, timestamp=message.timestamp)
  1203. if event_id:
  1204. msg = DBMessage(
  1205. mxid=event_id,
  1206. mx_room=self.mxid,
  1207. sender=sender.uuid,
  1208. timestamp=message.timestamp,
  1209. signal_chat_id=self.chat_id,
  1210. signal_receiver=self.receiver,
  1211. )
  1212. await msg.insert()
  1213. await self.signal.send_receipt(
  1214. source.username, sender.address, timestamps=[message.timestamp]
  1215. )
  1216. await self._send_delivery_receipt(event_id)
  1217. self.log.debug(f"Handled Signal message {message.timestamp} -> {event_id}")
  1218. if message.expires_in_seconds and self.disappearing_enabled:
  1219. dm = DisappearingMessage(self.mxid, event_id, message.expires_in_seconds)
  1220. # Start the timer immediately for own messages
  1221. if sender.uuid == source.uuid:
  1222. dm.start_timer()
  1223. await dm.insert()
  1224. background_task.create(self._disappear_event(dm))
  1225. self.log.debug(
  1226. f"{event_id} set to be redacted in {message.expires_in_seconds} seconds"
  1227. )
  1228. else:
  1229. await dm.insert()
  1230. self.log.debug(
  1231. f"{event_id} set to be redacted {message.expires_in_seconds} seconds"
  1232. " after room is read"
  1233. )
  1234. else:
  1235. self.log.debug(f"Didn't get event ID for {message.timestamp}")
  1236. async def handle_signal_kicked(self, user: u.User, sender: p.Puppet) -> None:
  1237. self.log.debug(f"{user.mxid} was kicked by {sender.number} from {self.mxid}")
  1238. await self._kick_with_puppet(user, sender)
  1239. async def handle_signal_group_change(self, group_change: GroupChange, source: u.User) -> None:
  1240. if self.revision < group_change.revision:
  1241. self.revision = group_change.revision
  1242. else:
  1243. return
  1244. editor = await p.Puppet.get_by_address(group_change.editor)
  1245. if not editor:
  1246. self.log.warning(f"Didn't get puppet for group change editor {group_change.editor}")
  1247. return
  1248. editor_intent = editor.intent_for(self)
  1249. if (
  1250. group_change.delete_members
  1251. or group_change.delete_pending_members
  1252. or group_change.delete_requesting_members
  1253. ):
  1254. for address in (
  1255. (group_change.delete_members or [])
  1256. + (group_change.delete_pending_members or [])
  1257. + (group_change.delete_requesting_members or [])
  1258. ):
  1259. users = [
  1260. await p.Puppet.get_by_address(address),
  1261. await u.User.get_by_address(address),
  1262. ]
  1263. for user in users:
  1264. if not user:
  1265. continue
  1266. if user == editor:
  1267. await editor_intent.leave_room(self.mxid)
  1268. else:
  1269. await self._kick_with_puppet(user, editor)
  1270. if group_change.modify_member_roles:
  1271. levels = await editor.intent_for(self).get_power_levels(self.mxid)
  1272. for group_member in group_change.modify_member_roles:
  1273. users = [
  1274. await p.Puppet.get_by_uuid(group_member.uuid),
  1275. await u.User.get_by_uuid(group_member.uuid),
  1276. ]
  1277. for user in users:
  1278. if not user:
  1279. continue
  1280. if group_member.role == GroupMemberRole.ADMINISTRATOR:
  1281. if levels.users.get(user.mxid, 0) < 50:
  1282. levels.users[user.mxid] = 50
  1283. levels.users = {k: v for k, v in sorted(list(levels.users.items()))}
  1284. elif levels.users.get(user.mxid, 0) >= 50:
  1285. levels.users.pop(user.mxid, 0)
  1286. await self._try_with_puppet(
  1287. lambda i: i.set_power_levels(self.mxid, levels), puppet=editor
  1288. )
  1289. if group_change.new_banned_members:
  1290. for banned_member in group_change.new_banned_members:
  1291. users = [
  1292. await p.Puppet.get_by_uuid(banned_member.uuid),
  1293. await u.User.get_by_uuid(banned_member.uuid),
  1294. ]
  1295. for user in users:
  1296. if not user:
  1297. continue
  1298. try:
  1299. await editor_intent.ban_user(self.mxid, user.mxid)
  1300. except MForbidden:
  1301. try:
  1302. await self.main_intent.ban_user(
  1303. self.mxid, user.mxid, reason=f"banned by {editor.name}"
  1304. )
  1305. except MForbidden as e:
  1306. self.log.debug(f"Could not ban {user.mxid}: {e}")
  1307. except MBadState as e:
  1308. self.log.debug(f"Could not ban {user.mxid}: {e}")
  1309. if group_change.new_unbanned_members:
  1310. for banned_member in group_change.new_unbanned_members:
  1311. users = [
  1312. await p.Puppet.get_by_uuid(banned_member.uuid),
  1313. await u.User.get_by_uuid(banned_member.uuid),
  1314. ]
  1315. for user in users:
  1316. if not user:
  1317. continue
  1318. try:
  1319. await editor_intent.unban_user(self.mxid, user.mxid)
  1320. except MForbidden:
  1321. try:
  1322. await self.main_intent.unban_user(
  1323. self.mxid, user.mxid, reason=f"unbanned by {editor.name}"
  1324. )
  1325. except MForbidden as e:
  1326. self.log.debug(f"Could not unban {user.mxid}: {e}")
  1327. except MBadState as e:
  1328. self.log.debug(f"Could not unban {user.mxid}: {e}")
  1329. if (
  1330. group_change.new_members
  1331. or group_change.new_pending_members
  1332. or group_change.promote_requesting_members
  1333. ):
  1334. banned_users = await self.az.intent.get_room_members(self.mxid, (Membership.BAN,))
  1335. for group_member in (
  1336. (group_change.new_members or [])
  1337. + (group_change.new_pending_members or [])
  1338. + (group_change.promote_requesting_members or [])
  1339. ):
  1340. puppet = await p.Puppet.get_by_uuid(group_member.uuid)
  1341. await source.sync_contact(group_member.address)
  1342. users = [puppet, await u.User.get_by_uuid(group_member.uuid)]
  1343. for user in users:
  1344. if not user:
  1345. continue
  1346. if user.mxid in banned_users:
  1347. await self._try_with_puppet(
  1348. lambda i: i.unban_user(self.mxid, user.mxid), puppet=editor
  1349. )
  1350. try:
  1351. await editor_intent.invite_user(self.mxid, user.mxid, check_cache=True)
  1352. except (MForbidden, IntentError):
  1353. try:
  1354. await self.main_intent.invite_user(
  1355. self.mxid,
  1356. user.mxid,
  1357. reason=f"invited by {editor.name}",
  1358. check_cache=True,
  1359. )
  1360. except (MForbidden, IntentError) as e:
  1361. self.log.debug(f"{editor.name} could not invite {user.mxid}: {e}")
  1362. except MBadState as e:
  1363. self.log.debug(f"{editor.name} could not invite {user.mxid}: {e}")
  1364. if group_member in (group_change.new_members or []) + (
  1365. group_change.promote_requesting_members or []
  1366. ) and isinstance(user, p.Puppet):
  1367. try:
  1368. await user.intent_for(self).ensure_joined(self.mxid)
  1369. except IntentError as e:
  1370. self.log.debug(f"{user.name} could not join group: {e}")
  1371. if group_change.promote_pending_members:
  1372. for group_member in group_change.promote_pending_members:
  1373. await source.sync_contact(group_member.address)
  1374. user = await p.Puppet.get_by_uuid(group_member.uuid)
  1375. if not user:
  1376. continue
  1377. try:
  1378. await user.intent_for(self).ensure_joined(self.mxid)
  1379. except IntentError as e:
  1380. self.log.debug(f"{user.name} could not join group: {e}")
  1381. if group_change.new_requesting_members:
  1382. for group_member in group_change.new_requesting_members:
  1383. try:
  1384. await source.sync_contact(group_member.address)
  1385. except ProfileUnavailableError:
  1386. self.log.debug(
  1387. f"Profile of puppet with uuid {group_member.uuid} is unavailable"
  1388. )
  1389. user = await p.Puppet.get_by_uuid(group_member.uuid)
  1390. try:
  1391. await user.intent_for(self).knock_room(self.mxid, reason="via invite link")
  1392. except (MForbidden, MBadState) as e:
  1393. self.log.debug(f"{user.name} failed knock: {e}")
  1394. if group_change.new_access_control:
  1395. ac = group_change.new_access_control
  1396. if ac.attributes or ac.members:
  1397. levels = await editor.intent_for(self).get_power_levels(self.mxid)
  1398. if ac.attributes:
  1399. meta_edit_level = 50 if ac.attributes == AccessControlMode.ADMINISTRATOR else 0
  1400. levels.events[EventType.ROOM_NAME] = meta_edit_level
  1401. levels.events[EventType.ROOM_AVATAR] = meta_edit_level
  1402. levels.events[EventType.ROOM_TOPIC] = meta_edit_level
  1403. if ac.members:
  1404. levels.invite = 50 if ac.members == AccessControlMode.ADMINISTRATOR else 0
  1405. await self._try_with_puppet(
  1406. lambda i: i.set_power_levels(self.mxid, levels), puppet=editor
  1407. )
  1408. if ac.link:
  1409. new_join_rule = await self._get_new_join_rule(ac.link)
  1410. if new_join_rule:
  1411. await self._try_with_puppet(
  1412. lambda i: i.set_join_rule(self.mxid, new_join_rule), puppet=editor
  1413. )
  1414. if group_change.new_is_announcement_group:
  1415. levels = await editor.intent_for(self).get_power_levels(self.mxid)
  1416. if group_change.new_is_announcement_group == AnnouncementsMode.ENABLED:
  1417. levels.events_default = 50
  1418. elif group_change.new_is_announcement_group == AnnouncementsMode.DISABLED:
  1419. levels.events_default = 0
  1420. await self._try_with_puppet(
  1421. lambda i: i.set_power_levels(self.mxid, levels), puppet=editor
  1422. )
  1423. changed = False
  1424. if group_change.new_description:
  1425. changed = await self._update_topic(group_change.new_description, editor)
  1426. if group_change.new_title:
  1427. changed = await self._update_name(group_change.new_title, editor) or changed
  1428. if group_change.new_avatar:
  1429. changed = (
  1430. await self._update_avatar(
  1431. await self.signal.get_group(
  1432. source.username, self.chat_id, group_change.revision
  1433. ),
  1434. editor,
  1435. )
  1436. or changed
  1437. )
  1438. if group_change.new_timer:
  1439. changed = (
  1440. await self.update_expires_in_seconds(editor, group_change.new_timer) or changed
  1441. )
  1442. if changed:
  1443. await self.update_bridge_info()
  1444. await self.update()
  1445. @staticmethod
  1446. async def _make_media_content(
  1447. attachment: Attachment, data: bytes
  1448. ) -> tuple[MediaMessageEventContent, bytes]:
  1449. if attachment.content_type.startswith("image/"):
  1450. msgtype = MessageType.IMAGE
  1451. info = ImageInfo(
  1452. mimetype=attachment.content_type, width=attachment.width, height=attachment.height
  1453. )
  1454. elif attachment.content_type.startswith("video/"):
  1455. msgtype = MessageType.VIDEO
  1456. info = VideoInfo(
  1457. mimetype=attachment.content_type, width=attachment.width, height=attachment.height
  1458. )
  1459. elif attachment.voice_note or attachment.content_type.startswith("audio/"):
  1460. msgtype = MessageType.AUDIO
  1461. info = AudioInfo(
  1462. mimetype=attachment.content_type if not attachment.voice_note else "audio/ogg"
  1463. )
  1464. else:
  1465. msgtype = MessageType.FILE
  1466. info = FileInfo(mimetype=attachment.content_type)
  1467. info.size = attachment.size or len(data)
  1468. if not attachment.custom_filename:
  1469. ext = mimetypes.guess_extension(info.mimetype) or ""
  1470. attachment.custom_filename = attachment.id + ext
  1471. else:
  1472. for ext in mimetypes.guess_all_extensions(info.mimetype):
  1473. if attachment.custom_filename.endswith(ext):
  1474. break
  1475. else:
  1476. attachment.custom_filename += mimetypes.guess_extension(info.mimetype) or ""
  1477. if attachment.blurhash:
  1478. info["blurhash"] = attachment.blurhash
  1479. info["xyz.amorgan.blurhash"] = attachment.blurhash
  1480. content = MediaMessageEventContent(
  1481. msgtype=msgtype, info=info, body=attachment.custom_filename
  1482. )
  1483. # If this is a voice note, add the additional voice message metadata and convert to OGG.
  1484. if attachment.voice_note:
  1485. content["org.matrix.msc1767.file"] = {
  1486. "url": content.url,
  1487. "name": content.body,
  1488. **(content.file.serialize() if content.file else {}),
  1489. **(content.info.serialize() if content.info else {}),
  1490. }
  1491. content["org.matrix.msc3245.voice"] = {}
  1492. data = await ffmpeg.convert_bytes(
  1493. data, ".ogg", output_args=("-c:a", "libopus"), input_mime=attachment.content_type
  1494. )
  1495. info.size = len(data)
  1496. return content, data
  1497. async def _handle_signal_attachment(
  1498. self, intent: IntentAPI, attachment: Attachment, sticker: bool = False, text: bool = False
  1499. ) -> MediaMessageEventContent | TextMessageEventContent:
  1500. if not attachment.incoming_filename:
  1501. self.log.warning("Failed to bridge attachment, no incoming filename: %s", attachment)
  1502. return TextMessageEventContent(
  1503. msgtype=MessageType.NOTICE, body="Missing attachment data"
  1504. )
  1505. file_size = attachment.size or os.path.getsize(attachment.incoming_filename)
  1506. if file_size > self.matrix.media_config.upload_size:
  1507. self.log.warning(
  1508. f"Dropping attachment {attachment.id}: file too large "
  1509. f"({file_size} > {self.matrix.media_config.upload_size})"
  1510. )
  1511. return TextMessageEventContent(msgtype=MessageType.NOTICE, body="Attachment too large")
  1512. self.log.trace(f"Reuploading attachment {attachment}")
  1513. if not attachment.content_type:
  1514. attachment.content_type = (
  1515. magic.mimetype(attachment.incoming_filename)
  1516. if magic is not None
  1517. else "application/octet-stream"
  1518. )
  1519. with open(attachment.incoming_filename, "rb") as file:
  1520. data = file.read()
  1521. if self.config["signal.remove_file_after_handling"]:
  1522. os.remove(attachment.incoming_filename)
  1523. if text:
  1524. assert attachment.content_type == "text/x-signal-plain"
  1525. assert attachment.size < MAX_MATRIX_MESSAGE_SIZE
  1526. content = TextMessageEventContent(msgtype=MessageType.TEXT, body=data.decode("utf-8"))
  1527. return content
  1528. content, data = await self._make_media_content(attachment, data)
  1529. if sticker:
  1530. self._adjust_sticker_size(content.info)
  1531. await self._upload_attachment(intent, content, data, attachment.id)
  1532. return content
  1533. @staticmethod
  1534. async def _handle_signal_contact(contact: SharedContact) -> TextMessageEventContent:
  1535. msg = f"Shared contact: {contact.name!s}"
  1536. if contact.phone:
  1537. msg += "\n"
  1538. for phone in contact.phone:
  1539. msg += f"\nPhone: {phone.value} ({phone.type_or_label})"
  1540. if contact.email:
  1541. msg += "\n"
  1542. for email in contact.email:
  1543. msg += f"\nEmail: {email.value} ({email.type_or_label})"
  1544. content = TextMessageEventContent(msgtype=MessageType.TEXT, body=msg)
  1545. content["fi.mau.signal.contact"] = contact.serialize()
  1546. return content
  1547. async def _add_sticker_meta(self, sticker: Sticker, content: MediaMessageEventContent) -> None:
  1548. try:
  1549. pack = self._sticker_meta_cache[sticker.pack_id]
  1550. except KeyError:
  1551. self.log.debug(f"Fetching sticker pack metadata for {sticker.pack_id}")
  1552. try:
  1553. async with StickersClient() as client:
  1554. pack = await client.get_pack_metadata(sticker.pack_id, sticker.pack_key)
  1555. self._sticker_meta_cache[sticker.pack_id] = pack
  1556. except Exception:
  1557. self.log.warning(
  1558. f"Failed to fetch pack metadata for {sticker.pack_id}", exc_info=True
  1559. )
  1560. pack = None
  1561. if not pack:
  1562. content.info["fi.mau.signal.sticker"] = {
  1563. "id": sticker.sticker_id,
  1564. "pack": {
  1565. "id": sticker.pack_id,
  1566. "key": sticker.pack_key,
  1567. },
  1568. }
  1569. return
  1570. sticker_meta = pack.stickers[sticker.sticker_id]
  1571. content.body = sticker_meta.emoji
  1572. content.info["fi.mau.signal.sticker"] = {
  1573. "id": sticker.sticker_id,
  1574. "emoji": sticker_meta.emoji,
  1575. "pack": {
  1576. "id": pack.id,
  1577. "key": pack.key,
  1578. "title": pack.title,
  1579. "author": pack.author,
  1580. },
  1581. }
  1582. @staticmethod
  1583. def _adjust_sticker_size(info: ImageInfo) -> None:
  1584. if info.width > 256 or info.height > 256:
  1585. if info.width == info.height:
  1586. info.width = info.height = 256
  1587. elif info.width > info.height:
  1588. info.height = int(info.height / (info.width / 256))
  1589. info.width = 256
  1590. else:
  1591. info.width = int(info.width / (info.height / 256))
  1592. info.height = 256
  1593. async def _handle_signal_sticker(
  1594. self, intent: IntentAPI, sticker: Sticker
  1595. ) -> MediaMessageEventContent | None:
  1596. try:
  1597. self.log.debug(f"Fetching sticker {sticker.pack_id}#{sticker.sticker_id}")
  1598. async with StickersClient() as client:
  1599. data = await client.download_sticker(
  1600. sticker.sticker_id, sticker.pack_id, sticker.pack_key
  1601. )
  1602. except Exception:
  1603. self.log.warning(f"Failed to download sticker {sticker.sticker_id}", exc_info=True)
  1604. return None
  1605. info = ImageInfo(
  1606. mimetype=sticker.attachment.content_type,
  1607. size=len(data),
  1608. width=sticker.attachment.width,
  1609. height=sticker.attachment.height,
  1610. )
  1611. self._adjust_sticker_size(info)
  1612. if magic:
  1613. info.mimetype = magic.mimetype(data)
  1614. ext = mimetypes.guess_extension(info.mimetype)
  1615. if not ext and info.mimetype == "image/webp":
  1616. ext = ".webp"
  1617. content = MediaMessageEventContent(
  1618. msgtype=MessageType.IMAGE, info=info, body=f"sticker{ext}"
  1619. )
  1620. await self._upload_attachment(intent, content, data, sticker.attachment.id)
  1621. return content
  1622. async def _upload_attachment(
  1623. self, intent: IntentAPI, content: MediaMessageEventContent, data: bytes, id: str
  1624. ) -> None:
  1625. upload_mime_type = content.info.mimetype
  1626. if self.encrypted and encrypt_attachment:
  1627. data, content.file = encrypt_attachment(data)
  1628. upload_mime_type = "application/octet-stream"
  1629. content.url = await intent.upload_media(
  1630. data,
  1631. mime_type=upload_mime_type,
  1632. filename=id,
  1633. async_upload=self.config["homeserver.async_media"],
  1634. )
  1635. if content.file:
  1636. content.file.url = content.url
  1637. content.url = None
  1638. # This is a hack for bad clients like Element iOS that require a thumbnail
  1639. if content.info.mimetype.startswith("image/"):
  1640. if content.file:
  1641. content.info.thumbnail_file = content.file
  1642. elif content.url:
  1643. content.info.thumbnail_url = content.url
  1644. async def handle_signal_reaction(
  1645. self, sender: p.Puppet, reaction: Reaction, timestamp: int
  1646. ) -> None:
  1647. author_puppet = await p.Puppet.get_by_address(reaction.target_author, create=False)
  1648. if not author_puppet:
  1649. return None
  1650. target_id = reaction.target_sent_timestamp
  1651. async with self._reaction_lock:
  1652. dedup_id = (
  1653. author_puppet.uuid,
  1654. target_id,
  1655. reaction.emoji,
  1656. sender.uuid,
  1657. reaction.remove,
  1658. )
  1659. if dedup_id in self._reaction_dedup:
  1660. return
  1661. self._reaction_dedup.appendleft(dedup_id)
  1662. existing = await DBReaction.get_by_signal_id(
  1663. self.chat_id, self.receiver, author_puppet.uuid, target_id, sender.uuid
  1664. )
  1665. if reaction.remove:
  1666. if existing:
  1667. try:
  1668. await sender.intent_for(self).redact(existing.mx_room, existing.mxid)
  1669. except IntentError:
  1670. await self.main_intent.redact(existing.mx_room, existing.mxid)
  1671. await existing.delete()
  1672. self.log.trace(f"Removed {existing} after Signal removal")
  1673. return
  1674. elif existing and existing.emoji == reaction.emoji:
  1675. return
  1676. message = await DBMessage.get_by_signal_id(
  1677. author_puppet.uuid, target_id, self.chat_id, self.receiver
  1678. )
  1679. if not message:
  1680. self.log.debug(f"Ignoring reaction to unknown message {target_id}")
  1681. return
  1682. intent = sender.intent_for(self)
  1683. matrix_emoji = variation_selector.add(reaction.emoji)
  1684. mxid = await intent.react(message.mx_room, message.mxid, matrix_emoji, timestamp=timestamp)
  1685. self.log.debug(f"{sender.uuid} reacted to {message.mxid} -> {mxid}")
  1686. await self._upsert_reaction(existing, intent, mxid, sender, message, reaction.emoji)
  1687. async def handle_signal_delete(self, sender: p.Puppet, message_ts: int) -> None:
  1688. message = await DBMessage.get_by_signal_id(
  1689. sender.uuid, message_ts, self.chat_id, self.receiver
  1690. )
  1691. if not message:
  1692. return
  1693. await message.delete()
  1694. try:
  1695. await sender.intent_for(self).redact(message.mx_room, message.mxid)
  1696. except MForbidden:
  1697. await self.main_intent.redact(message.mx_room, message.mxid)
  1698. # endregion
  1699. # region Matrix -> Signal metadata
  1700. async def create_signal_group(
  1701. self, source: u.User, levels: PowerLevelStateEventContent, join_rule: JoinRule
  1702. ) -> None:
  1703. user_mxids = await self.az.intent.get_room_members(
  1704. self.mxid, (Membership.JOIN, Membership.INVITE)
  1705. )
  1706. invitee_addresses = []
  1707. relaybot_mxid = self.config["bridge.relay.relaybot"]
  1708. relaybot = None
  1709. for mxid in user_mxids:
  1710. mx_user = await u.User.get_by_mxid(mxid, create=False)
  1711. if mx_user and mx_user.address and mx_user.username != source.username:
  1712. invitee_addresses.append(mx_user.address)
  1713. if mxid == relaybot_mxid != "@relaybot:example.com":
  1714. relaybot = mx_user
  1715. puppet = await p.Puppet.get_by_mxid(mxid, create=False)
  1716. if puppet:
  1717. invitee_addresses.append(puppet.address)
  1718. avatar_path: str | None = None
  1719. if self.avatar_url:
  1720. avatar_data = await self.az.intent.download_media(self.avatar_url)
  1721. self.avatar_hash = hashlib.sha256(avatar_data).hexdigest()
  1722. avatar_path = self._write_outgoing_file(avatar_data)
  1723. signal_chat = await self.signal.create_group(
  1724. source.username, title=self.name, members=invitee_addresses, avatar_path=avatar_path
  1725. )
  1726. self.name_set = bool(self.name and signal_chat.title)
  1727. self.avatar_set = bool(self.avatar_url and self.avatar_hash and signal_chat.avatar)
  1728. self.chat_id = signal_chat.id
  1729. await self._postinit()
  1730. await self.insert()
  1731. if avatar_path and self.config["signal.remove_file_after_handling"]:
  1732. try:
  1733. os.remove(avatar_path)
  1734. except FileNotFoundError:
  1735. pass
  1736. if self.topic:
  1737. await self.signal.update_group(source.username, self.chat_id, description=self.topic)
  1738. await self.handle_matrix_power_level(source, levels)
  1739. await self.handle_matrix_join_rules(source, join_rule)
  1740. await self.update()
  1741. await self.update_bridge_info()
  1742. if relaybot:
  1743. await self._handle_relaybot_invited(relaybot)
  1744. await self.main_intent.send_notice(self.mxid, f"Signal group created. ID: {self.chat_id}")
  1745. async def bridge_signal_group(
  1746. self, source: u.User, levels: PowerLevelStateEventContent
  1747. ) -> None:
  1748. await self._postinit()
  1749. await self.insert()
  1750. await self.handle_matrix_power_level(source, levels)
  1751. await self.update()
  1752. await self.update_bridge_info()
  1753. # endregion
  1754. # region Updating portal info
  1755. async def update_info(self, source: u.User, info: ChatInfo | GroupV2ID) -> None:
  1756. if self.is_direct:
  1757. if not isinstance(info, (Profile, Address)):
  1758. raise ValueError(f"Unexpected type for direct chat update_info: {type(info)}")
  1759. if not self.name or not self.topic:
  1760. puppet = await self.get_dm_puppet()
  1761. if not puppet.name:
  1762. await puppet.update_info(info, source)
  1763. self.name = puppet.name
  1764. if puppet.number and not self.topic:
  1765. self.topic = puppet.fmt_phone(puppet.number)
  1766. if self.mxid:
  1767. # This is only for automatically updating the topic in existing portals
  1768. await self.update_puppet_number(self.topic)
  1769. return
  1770. if isinstance(info, GroupV2ID):
  1771. try:
  1772. info = await self.signal.get_group(source.username, info.id, info.revision or -1)
  1773. except Exception as e:
  1774. await source.handle_auth_failure(e)
  1775. raise
  1776. if not info:
  1777. self.log.debug(
  1778. f"Failed to get full group v2 info through {source.username}, "
  1779. "cancelling update"
  1780. )
  1781. return
  1782. changed = False
  1783. if self.revision < info.revision:
  1784. self.revision = info.revision
  1785. changed = True
  1786. elif self.revision > info.revision:
  1787. self.log.warning(
  1788. f"Got outdated info when syncing through {source.username} "
  1789. f"({info.revision} < {self.revision}), ignoring..."
  1790. )
  1791. return
  1792. changed = await self._update_name(info.title) or changed
  1793. changed = await self._update_topic(info.description) or changed
  1794. changed = await self._update_avatar(info) or changed
  1795. await self._update_participants(source, info)
  1796. try:
  1797. await self._update_power_levels(info)
  1798. except Exception:
  1799. self.log.warning("Error updating power levels", exc_info=True)
  1800. try:
  1801. await self._update_join_rules(info)
  1802. except:
  1803. self.log.warning("Error updating join rules", exc_info=True)
  1804. if changed:
  1805. await self.update_bridge_info()
  1806. await self.update()
  1807. async def update_expires_in_seconds(self, sender: p.Puppet, expires_in_seconds: int) -> bool:
  1808. if expires_in_seconds == 0:
  1809. expires_in_seconds = None
  1810. if self.expiration_time == expires_in_seconds:
  1811. return False
  1812. assert self.mxid
  1813. self.log.debug(f"Setting portal expiration time to {expires_in_seconds}")
  1814. self.expiration_time = expires_in_seconds
  1815. await self.update()
  1816. time_str = "Off" if expires_in_seconds is None else format_duration(expires_in_seconds)
  1817. body = f"Set the disappearing message timer to {time_str}"
  1818. content = TextMessageEventContent(msgtype=MessageType.NOTICE, body=body)
  1819. await self._send_message(sender.intent_for(self), content)
  1820. return True
  1821. async def get_dm_puppet(self) -> p.Puppet | None:
  1822. if not self.is_direct:
  1823. return None
  1824. return await p.Puppet.get_by_uuid(self.chat_id)
  1825. async def update_info_from_puppet(self, puppet: p.Puppet | None = None) -> None:
  1826. if not self.is_direct:
  1827. return
  1828. if not puppet:
  1829. puppet = await self.get_dm_puppet()
  1830. await self.update_puppet_name(puppet.name, save=False)
  1831. await self.update_puppet_avatar(puppet.avatar_hash, puppet.avatar_url, save=False)
  1832. if puppet.number:
  1833. await self.update_puppet_number(puppet.fmt_phone(puppet.number), save=False)
  1834. async def update_puppet_number(self, number: str, save: bool = True) -> None:
  1835. if not self.encrypted and not self.private_chat_portal_meta:
  1836. return
  1837. changed = await self._update_topic(number)
  1838. if changed and save:
  1839. await self.update_bridge_info()
  1840. await self.update()
  1841. async def update_puppet_avatar(
  1842. self, new_hash: str, avatar_url: ContentURI, save: bool = True
  1843. ) -> None:
  1844. if not self.encrypted and not self.private_chat_portal_meta:
  1845. return
  1846. if self.avatar_hash != new_hash or not self.avatar_set:
  1847. self.avatar_hash = new_hash
  1848. self.avatar_url = avatar_url
  1849. if self.mxid:
  1850. try:
  1851. await self.main_intent.set_room_avatar(self.mxid, avatar_url)
  1852. self.avatar_set = True
  1853. except Exception:
  1854. self.log.exception("Error setting avatar")
  1855. self.avatar_set = False
  1856. if save:
  1857. await self.update_bridge_info()
  1858. await self.update()
  1859. async def update_puppet_name(self, name: str, save: bool = True) -> None:
  1860. if not self.encrypted and not self.private_chat_portal_meta:
  1861. return
  1862. changed = await self._update_name(name)
  1863. if changed and save:
  1864. await self.update_bridge_info()
  1865. await self.update()
  1866. async def _update_name(self, name: str, sender: p.Puppet | None = None) -> bool:
  1867. if self.name != name or not self.name_set:
  1868. self.name = name
  1869. if self.mxid:
  1870. try:
  1871. await self._try_with_puppet(
  1872. lambda i: i.set_room_name(self.mxid, self.name), puppet=sender
  1873. )
  1874. self.name_set = True
  1875. except Exception:
  1876. self.log.exception("Error setting name")
  1877. self.name_set = False
  1878. return True
  1879. return False
  1880. async def _update_topic(self, topic: str, sender: p.Puppet | None = None) -> bool:
  1881. if self.topic != topic:
  1882. self.topic = topic
  1883. if self.mxid:
  1884. try:
  1885. await self._try_with_puppet(
  1886. lambda i: i.set_room_topic(self.mxid, self.topic), puppet=sender
  1887. )
  1888. except Exception:
  1889. self.log.exception("Error setting topic")
  1890. self.topic = None
  1891. return True
  1892. return False
  1893. async def _try_with_puppet(
  1894. self, action: Callable[[IntentAPI], Awaitable[Any]], puppet: p.Puppet | None = None
  1895. ) -> None:
  1896. if puppet:
  1897. try:
  1898. await action(puppet.intent_for(self))
  1899. except (MForbidden, IntentError):
  1900. await action(self.main_intent)
  1901. else:
  1902. await action(self.main_intent)
  1903. async def _update_avatar(self, info: GroupV2, sender: p.Puppet | None = None) -> bool:
  1904. path = None
  1905. if isinstance(info, GroupV2):
  1906. path = info.avatar
  1907. res = await p.Puppet.upload_avatar(self, path, self.main_intent)
  1908. if res is False:
  1909. return False
  1910. self.avatar_hash, self.avatar_url = res
  1911. if not self.mxid:
  1912. return True
  1913. try:
  1914. await self._try_with_puppet(
  1915. lambda i: i.set_room_avatar(self.mxid, self.avatar_url), puppet=sender
  1916. )
  1917. self.avatar_set = True
  1918. except Exception:
  1919. self.log.exception("Error setting avatar")
  1920. self.avatar_set = False
  1921. return True
  1922. async def _update_participants(self, source: u.User, info: GroupV2) -> None:
  1923. if not self.mxid:
  1924. return
  1925. member_events = await self.main_intent.get_members(self.mxid)
  1926. remove_users: set[UserID] = {
  1927. UserID(evt.state_key)
  1928. for evt in member_events
  1929. if (
  1930. evt.content.membership == Membership.JOIN
  1931. or evt.content.membership == Membership.INVITE
  1932. or evt.content.membership == Membership.KNOCK
  1933. )
  1934. and evt.state_key != self.az.bot_mxid
  1935. }
  1936. unban_users: set[UserID] = {
  1937. UserID(evt.state_key)
  1938. for evt in member_events
  1939. if evt.content.membership == Membership.BAN and evt.state_key != self.az.bot_mxid
  1940. }
  1941. self._pending_members = {addr.uuid for addr in info.pending_members}
  1942. for member in info.banned_members:
  1943. user = await u.User.get_by_uuid(member.uuid)
  1944. if user:
  1945. unban_users.discard(user.mxid)
  1946. remove_users.discard(user.mxid)
  1947. try:
  1948. await self.main_intent.ban_user(
  1949. self.mxid, user.mxid, reason="Banned on Signal"
  1950. )
  1951. except (MForbidden, MBadState) as e:
  1952. self.log.debug(f"Could not ban {user.mxid}: {e}")
  1953. puppet = await p.Puppet.get_by_address(Address(uuid=member.uuid))
  1954. unban_users.discard(puppet.mxid)
  1955. remove_users.discard(puppet.mxid)
  1956. try:
  1957. await self.main_intent.ban_user(self.mxid, puppet.mxid, reason="Banned on Signal")
  1958. except (MForbidden, MBadState) as e:
  1959. self.log.debug(f"Could not ban {puppet.mxid}: {e}")
  1960. for mxid in unban_users:
  1961. user = await u.User.get_by_mxid(mxid, create=False)
  1962. if user and await user.is_logged_in():
  1963. try:
  1964. await self.main_intent.unban_user(
  1965. self.mxid, user.mxid, reason="Unbanned on Signal"
  1966. )
  1967. except (MForbidden, MBadState) as e:
  1968. self.log.debug(f"Could not unban {user.mxid}: {e}")
  1969. puppet = await p.Puppet.get_by_mxid(mxid, create=False)
  1970. if puppet:
  1971. try:
  1972. await self.main_intent.unban_user(
  1973. self.mxid, puppet.mxid, reason="Unbanned on Signal"
  1974. )
  1975. except (MForbidden, MBadState) as e:
  1976. self.log.debug(f"Could not unban {puppet.mxid}: {e}")
  1977. for address in info.members + info.pending_members:
  1978. user = await u.User.get_by_address(address)
  1979. if user:
  1980. remove_users.discard(user.mxid)
  1981. try:
  1982. await self.main_intent.invite_user(self.mxid, user.mxid, check_cache=True)
  1983. except (MForbidden, IntentError, MBadState) as e:
  1984. self.log.debug(f"Failed to invite {user.mxid}: {e}")
  1985. puppet = await p.Puppet.get_by_address(address)
  1986. if not puppet:
  1987. self.log.warning(f"Didn't find puppet for member {address}")
  1988. continue
  1989. await source.sync_contact(address)
  1990. try:
  1991. await self.main_intent.invite_user(
  1992. self.mxid, puppet.intent_for(self).mxid, check_cache=True
  1993. )
  1994. except (MForbidden, IntentError, MBadState) as e:
  1995. self.log.debug(f"Could not invite {user.mxid}: {e}")
  1996. if address.uuid not in self._pending_members:
  1997. await puppet.intent_for(self).ensure_joined(self.mxid)
  1998. remove_users.discard(puppet.default_mxid)
  1999. for address in info.requesting_members:
  2000. puppet = await p.Puppet.get_by_address(address)
  2001. if puppet:
  2002. remove_users.discard(puppet.mxid)
  2003. try:
  2004. await puppet.intent_for(self).knock_room(
  2005. self.mxid,
  2006. reason="via invite link",
  2007. servers=[self.config["homeserver.domain"]],
  2008. )
  2009. except (MForbidden, IntentError) as e:
  2010. self.log.debug(f"Failed to bridge knock: {e}")
  2011. for mxid in remove_users:
  2012. user = await u.User.get_by_mxid(mxid, create=False)
  2013. if user and await user.is_logged_in():
  2014. try:
  2015. await self.main_intent.kick_user(
  2016. self.mxid, user.mxid, reason="not a member of this Signal group"
  2017. )
  2018. except (MForbidden, MBadState) as e:
  2019. self.log.debug(f"could not kick {user.mxid}: {e}")
  2020. puppet = await p.Puppet.get_by_mxid(mxid, create=False)
  2021. if puppet:
  2022. try:
  2023. await self.main_intent.kick_user(
  2024. self.mxid,
  2025. puppet.intent_for(self).mxid,
  2026. reason="not a member of this Signal group",
  2027. )
  2028. except (MForbidden, MBadState) as e:
  2029. self.log.debug(f"Could not kick {user.mxid}: {e}")
  2030. async def _kick_with_puppet(self, user: p.Puppet | u.User, sender: p.Puppet) -> None:
  2031. try:
  2032. await sender.intent_for(self).kick_user(self.mxid, user.mxid)
  2033. except MForbidden:
  2034. try:
  2035. await self.main_intent.kick_user(
  2036. self.mxid, user.mxid, reason=f"removed by {sender.name}"
  2037. )
  2038. except MForbidden as e:
  2039. self.log.debug(f"Could not remove {user.mxid}: {e}")
  2040. except MBadState as e:
  2041. self.log.debug(f"Could not remove {user.mxid}: {e}")
  2042. async def _update_power_levels(self, info: ChatInfo) -> None:
  2043. if not self.mxid or not info:
  2044. return
  2045. power_levels = await self.main_intent.get_power_levels(self.mxid)
  2046. power_levels = await self._get_power_levels(power_levels, info=info, is_initial=False)
  2047. await self.main_intent.set_power_levels(self.mxid, power_levels)
  2048. async def _get_new_join_rule(self, link_access: AccessControlMode) -> JoinRule | None:
  2049. if not self.mxid:
  2050. return None
  2051. old_join_rule = await self._get_join_rule()
  2052. if link_access == AccessControlMode.ANY:
  2053. # Default to invite since chat that don't require admin approval don't allow knocks
  2054. join_rule = (
  2055. JoinRule.PUBLIC if self.config["bridge.public_portals"] else JoinRule.INVITE
  2056. )
  2057. allowed_join_rules = (JoinRule.PUBLIC, JoinRule.INVITE)
  2058. elif link_access == AccessControlMode.ADMINISTRATOR:
  2059. join_rule = JoinRule.KNOCK
  2060. # TODO remove getattr once mautrix-python is updated
  2061. allowed_join_rules = (
  2062. JoinRule.KNOCK,
  2063. getattr(JoinRule, "KNOCK_RESTRICTED", "knock_restricted"),
  2064. )
  2065. else:
  2066. join_rule = JoinRule.INVITE
  2067. allowed_join_rules = (JoinRule.INVITE,)
  2068. if old_join_rule in allowed_join_rules:
  2069. return None
  2070. return join_rule
  2071. async def _update_join_rules(self, info: GroupV2) -> None:
  2072. if not self.mxid:
  2073. return
  2074. new_join_rule = await self._get_new_join_rule(info.access_control.link)
  2075. if new_join_rule:
  2076. await self.main_intent.set_join_rule(self.mxid, new_join_rule)
  2077. async def _get_join_rule(self) -> JoinRule | None:
  2078. evt = await self.main_intent.get_state_event(self.mxid, EventType.ROOM_JOIN_RULES)
  2079. return evt.join_rule if evt else None
  2080. # endregion
  2081. # region Bridge info state event
  2082. @property
  2083. def bridge_info_state_key(self) -> str:
  2084. return f"net.maunium.signal://signal/{self.chat_id!s}"
  2085. @property
  2086. def bridge_info(self) -> dict[str, Any]:
  2087. return {
  2088. "bridgebot": self.az.bot_mxid,
  2089. "creator": self.main_intent.mxid,
  2090. "protocol": {
  2091. "id": "signal",
  2092. "displayname": "Signal",
  2093. "avatar_url": self.config["appservice.bot_avatar"],
  2094. },
  2095. "channel": {
  2096. "id": str(self.chat_id),
  2097. "displayname": self.name,
  2098. "avatar_url": self.avatar_url,
  2099. },
  2100. }
  2101. async def update_bridge_info(self) -> None:
  2102. if not self.mxid:
  2103. self.log.debug("Not updating bridge info: no Matrix room created")
  2104. return
  2105. try:
  2106. self.log.debug("Updating bridge info...")
  2107. await self.main_intent.send_state_event(
  2108. self.mxid, StateBridge, self.bridge_info, self.bridge_info_state_key
  2109. )
  2110. # TODO remove this once https://github.com/matrix-org/matrix-doc/pull/2346 is in spec
  2111. await self.main_intent.send_state_event(
  2112. self.mxid, StateHalfShotBridge, self.bridge_info, self.bridge_info_state_key
  2113. )
  2114. except Exception:
  2115. self.log.warning("Failed to update bridge info", exc_info=True)
  2116. # endregion
  2117. # region Creating Matrix rooms
  2118. async def update_matrix_room(self, source: u.User, info: ChatInfo) -> None:
  2119. if not self.is_direct and not isinstance(info, GroupV2):
  2120. raise ValueError(f"Unexpected type for updating group portal: {type(info)}")
  2121. elif self.is_direct and not isinstance(info, (Profile, Address)):
  2122. raise ValueError(f"Unexpected type for updating direct chat portal: {type(info)}")
  2123. try:
  2124. await self._update_matrix_room(source, info)
  2125. except Exception:
  2126. self.log.exception("Failed to update portal")
  2127. async def create_matrix_room(
  2128. self, source: u.User, info: ChatInfo | GroupV2ID
  2129. ) -> RoomID | None:
  2130. if not self.is_direct and not isinstance(info, GroupV2ID):
  2131. raise ValueError(f"Unexpected type for creating group portal: {type(info)}")
  2132. elif self.is_direct and not isinstance(info, (Profile, Address)):
  2133. raise ValueError(f"Unexpected type for creating direct chat portal: {type(info)}")
  2134. if isinstance(info, GroupV2ID) and not isinstance(info, GroupV2):
  2135. self.log.debug(
  2136. f"create_matrix_room() called with {info}, fetching full info from signald"
  2137. )
  2138. try:
  2139. info = await self.signal.get_group(source.username, info.id, info.revision or -1)
  2140. except Exception as e:
  2141. await source.handle_auth_failure(e)
  2142. raise
  2143. if not info:
  2144. self.log.warning(f"Full info not found, canceling room creation")
  2145. return None
  2146. else:
  2147. self.log.trace("get_group() returned full info: %s", info)
  2148. if self.mxid:
  2149. await self.update_matrix_room(source, info)
  2150. return self.mxid
  2151. async with self._create_room_lock:
  2152. return await self._create_matrix_room(source, info)
  2153. def _get_invite_content(self, double_puppet: p.Puppet | None) -> dict[str, Any]:
  2154. invite_content = {}
  2155. if double_puppet:
  2156. invite_content["fi.mau.will_auto_accept"] = True
  2157. if self.is_direct:
  2158. invite_content["is_direct"] = True
  2159. return invite_content
  2160. async def _update_matrix_room(self, source: u.User, info: ChatInfo) -> None:
  2161. puppet = await p.Puppet.get_by_custom_mxid(source.mxid)
  2162. await self.main_intent.invite_user(
  2163. self.mxid,
  2164. source.mxid,
  2165. check_cache=True,
  2166. extra_content=self._get_invite_content(puppet),
  2167. )
  2168. if puppet:
  2169. did_join = await puppet.intent.ensure_joined(self.mxid)
  2170. if did_join and self.is_direct:
  2171. await source.update_direct_chats({self.main_intent.mxid: [self.mxid]})
  2172. await self.update_info(source, info)
  2173. async def _get_power_levels(
  2174. self,
  2175. levels: PowerLevelStateEventContent | None = None,
  2176. info: ChatInfo = None,
  2177. is_initial: bool = False,
  2178. ) -> PowerLevelStateEventContent:
  2179. levels = levels or PowerLevelStateEventContent()
  2180. bot_pl = levels.get_user_level(self.az.bot_mxid)
  2181. levels.events_default = 0
  2182. if self.is_direct:
  2183. levels.ban = 99
  2184. levels.kick = 99
  2185. levels.invite = 99
  2186. levels.state_default = 0
  2187. meta_edit_level = 0
  2188. else:
  2189. ac = info.access_control
  2190. for detail in info.member_detail + info.pending_member_detail:
  2191. puppet = await p.Puppet.get_by_uuid(detail.uuid)
  2192. puppet_mxid = puppet.intent_for(self).mxid
  2193. current_level = levels.get_user_level(puppet_mxid)
  2194. if bot_pl > current_level and bot_pl >= 50:
  2195. level = current_level
  2196. user = await u.User.get_by_uuid(detail.uuid)
  2197. if user:
  2198. if current_level >= 50 and detail.role == GroupMemberRole.DEFAULT:
  2199. level = 0
  2200. elif current_level < 50 and detail.role == GroupMemberRole.ADMINISTRATOR:
  2201. level = 50
  2202. if level == 0:
  2203. levels.users.pop(user.mxid, None)
  2204. else:
  2205. levels.users[user.mxid] = level
  2206. else:
  2207. level = 50 if detail.role == GroupMemberRole.ADMINISTRATOR else 0
  2208. if level == 0:
  2209. levels.users.pop(puppet_mxid, None)
  2210. else:
  2211. levels.users[puppet_mxid] = level
  2212. announcements = info.announcements
  2213. levels.ban = 50
  2214. levels.kick = 50
  2215. levels.invite = 50 if ac.members == AccessControlMode.ADMINISTRATOR else 0
  2216. levels.state_default = 50
  2217. meta_edit_level = 50 if ac.attributes == AccessControlMode.ADMINISTRATOR else 0
  2218. if announcements == AnnouncementsMode.ENABLED:
  2219. levels.events_default = 50
  2220. levels.events[EventType.REACTION] = 0
  2221. levels.events[EventType.ROOM_NAME] = meta_edit_level
  2222. levels.events[EventType.ROOM_AVATAR] = meta_edit_level
  2223. levels.events[EventType.ROOM_TOPIC] = meta_edit_level
  2224. levels.events[EventType.ROOM_ENCRYPTION] = 50 if self.matrix.e2ee else 99
  2225. levels.events[EventType.ROOM_TOMBSTONE] = 99
  2226. levels.users_default = 0
  2227. # Remote delete is only for your own messages
  2228. levels.redact = 99
  2229. if self.main_intent.mxid not in levels.users:
  2230. levels.users[self.main_intent.mxid] = 9001 if is_initial else 100
  2231. levels.users = {k: v for k, v in sorted(list(levels.users.items()))}
  2232. return levels
  2233. async def _create_matrix_room(self, source: u.User, info: ChatInfo) -> RoomID | None:
  2234. if self.mxid:
  2235. await self._update_matrix_room(source, info)
  2236. return self.mxid
  2237. await self.update_info(source, info)
  2238. self.log.debug("Creating Matrix room")
  2239. name: str | None = None
  2240. power_levels = await self._get_power_levels(info=info, is_initial=True)
  2241. initial_state = [
  2242. {
  2243. "type": str(StateBridge),
  2244. "state_key": self.bridge_info_state_key,
  2245. "content": self.bridge_info,
  2246. },
  2247. {
  2248. # TODO remove this once https://github.com/matrix-org/matrix-doc/pull/2346 is in spec
  2249. "type": str(StateHalfShotBridge),
  2250. "state_key": self.bridge_info_state_key,
  2251. "content": self.bridge_info,
  2252. },
  2253. {
  2254. "type": str(EventType.ROOM_POWER_LEVELS),
  2255. "content": power_levels.serialize(),
  2256. },
  2257. ]
  2258. invites = []
  2259. if self.config["bridge.encryption.default"] and self.matrix.e2ee:
  2260. self.encrypted = True
  2261. initial_state.append(
  2262. {
  2263. "type": str(EventType.ROOM_ENCRYPTION),
  2264. "content": self.get_encryption_state_event_json(),
  2265. }
  2266. )
  2267. if self.is_direct:
  2268. invites.append(self.az.bot_mxid)
  2269. if self.is_direct and source.uuid == self.chat_id:
  2270. name = self.name = "Signal Note to Self"
  2271. elif self.encrypted or self.private_chat_portal_meta or not self.is_direct:
  2272. name = self.name
  2273. if self.avatar_url:
  2274. initial_state.append(
  2275. {
  2276. "type": str(EventType.ROOM_AVATAR),
  2277. "content": {"url": self.avatar_url},
  2278. }
  2279. )
  2280. creation_content = {}
  2281. if not self.config["bridge.federate_rooms"]:
  2282. creation_content["m.federate"] = False
  2283. self.mxid = await self.main_intent.create_room(
  2284. name=name,
  2285. topic=self.topic,
  2286. is_direct=self.is_direct,
  2287. initial_state=initial_state,
  2288. invitees=invites,
  2289. creation_content=creation_content,
  2290. # Make sure the power level event in initial_state is allowed
  2291. # even if the server sends a default power level event before it.
  2292. # TODO remove this if the spec is changed to require servers to
  2293. # use the power level event in initial_state
  2294. power_level_override={"users": {self.main_intent.mxid: 9001}},
  2295. )
  2296. if not self.mxid:
  2297. raise Exception("Failed to create room: no mxid returned")
  2298. self.name_set = bool(name)
  2299. self.avatar_set = bool(self.avatar_url)
  2300. if self.encrypted and self.matrix.e2ee and self.is_direct:
  2301. try:
  2302. await self.az.intent.ensure_joined(self.mxid)
  2303. except Exception:
  2304. self.log.warning("Failed to add bridge bot to new private chat {self.mxid}")
  2305. puppet = await p.Puppet.get_by_custom_mxid(source.mxid)
  2306. await self.main_intent.invite_user(
  2307. self.mxid, source.mxid, extra_content=self._get_invite_content(puppet)
  2308. )
  2309. if puppet:
  2310. try:
  2311. await source.update_direct_chats({self.main_intent.mxid: [self.mxid]})
  2312. await puppet.intent.join_room_by_id(self.mxid)
  2313. except MatrixError:
  2314. self.log.debug(
  2315. "Failed to join custom puppet into newly created portal", exc_info=True
  2316. )
  2317. await self.update()
  2318. self.log.debug(f"Matrix room created: {self.mxid}")
  2319. self.by_mxid[self.mxid] = self
  2320. if not self.is_direct:
  2321. await self._update_participants(source, info)
  2322. return self.mxid
  2323. # endregion
  2324. # region Database getters
  2325. async def _postinit(self) -> None:
  2326. self.by_chat_id[(str(self.chat_id), self.receiver)] = self
  2327. if self.mxid:
  2328. self.by_mxid[self.mxid] = self
  2329. if self.is_direct:
  2330. puppet = await self.get_dm_puppet()
  2331. self._main_intent = puppet.default_mxid_intent
  2332. elif not self.is_direct:
  2333. self._main_intent = self.az.intent
  2334. async def delete(self) -> None:
  2335. await DBMessage.delete_all(self.mxid)
  2336. self.by_mxid.pop(self.mxid, None)
  2337. self.mxid = None
  2338. self.name_set = False
  2339. self.avatar_set = False
  2340. self.relay_user_id = None
  2341. self.topic = None
  2342. self.encrypted = False
  2343. await self.update()
  2344. async def save(self) -> None:
  2345. await self.update()
  2346. @classmethod
  2347. def all_with_room(cls) -> AsyncGenerator[Portal, None]:
  2348. return cls._db_to_portals(super().all_with_room())
  2349. @classmethod
  2350. def find_private_chats_with(cls, other_user: UUID) -> AsyncGenerator[Portal, None]:
  2351. return cls._db_to_portals(super().find_private_chats_with(other_user))
  2352. @classmethod
  2353. async def _db_to_portals(cls, query: Awaitable[list[Portal]]) -> AsyncGenerator[Portal, None]:
  2354. portals = await query
  2355. for index, portal in enumerate(portals):
  2356. try:
  2357. yield cls.by_chat_id[(str(portal.chat_id), portal.receiver)]
  2358. except KeyError:
  2359. await portal._postinit()
  2360. yield portal
  2361. @classmethod
  2362. @async_getter_lock
  2363. async def get_by_mxid(cls, mxid: RoomID, /) -> Portal | None:
  2364. try:
  2365. return cls.by_mxid[mxid]
  2366. except KeyError:
  2367. pass
  2368. portal = cast(cls, await super().get_by_mxid(mxid))
  2369. if portal is not None:
  2370. await portal._postinit()
  2371. return portal
  2372. return None
  2373. @classmethod
  2374. @async_getter_lock
  2375. async def get_by_chat_id(
  2376. cls, chat_id: GroupID | UUID, /, *, receiver: str = "", create: bool = False
  2377. ) -> Portal | None:
  2378. if isinstance(chat_id, str):
  2379. receiver = ""
  2380. elif not isinstance(chat_id, UUID):
  2381. raise ValueError(f"Invalid chat ID type {type(chat_id)}")
  2382. elif not receiver:
  2383. raise ValueError("Direct chats must have a receiver")
  2384. try:
  2385. return cls.by_chat_id[(str(chat_id), receiver)]
  2386. except KeyError:
  2387. pass
  2388. portal = cast(cls, await super().get_by_chat_id(chat_id, receiver))
  2389. if portal is not None:
  2390. await portal._postinit()
  2391. return portal
  2392. if create:
  2393. portal = cls(chat_id, receiver)
  2394. await portal.insert()
  2395. await portal._postinit()
  2396. return portal
  2397. return None
  2398. # endregion