portal.py 101 KB

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