portal.py 107 KB

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