portal.py 86 KB

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