portal.py 101 KB

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