portal.py 106 KB

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