portal.py 64 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644
  1. # mautrix-instagram - A Matrix-Instagram 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 io import BytesIO
  20. import asyncio
  21. import json
  22. import mimetypes
  23. import asyncpg
  24. import magic
  25. from mauigpapi.types import (
  26. AnimatedMediaItem,
  27. CommandResponse,
  28. ExpiredMediaItem,
  29. MediaShareItem,
  30. MediaType,
  31. MessageSyncMessage,
  32. Reaction,
  33. ReactionStatus,
  34. ReelMediaShareItem,
  35. ReelShareType,
  36. RegularMediaItem,
  37. Thread,
  38. ThreadItem,
  39. ThreadItemType,
  40. ThreadUser,
  41. ThreadUserLastSeenAt,
  42. TypingStatus,
  43. VoiceMediaItem,
  44. )
  45. from mautrix.appservice import AppService, IntentAPI
  46. from mautrix.bridge import BasePortal, NotificationDisabler, async_getter_lock
  47. from mautrix.errors import MatrixError, MForbidden, MNotFound, SessionNotFound
  48. from mautrix.types import (
  49. AudioInfo,
  50. ContentURI,
  51. EventID,
  52. EventType,
  53. Format,
  54. ImageInfo,
  55. LocationMessageEventContent,
  56. MediaMessageEventContent,
  57. MessageEventContent,
  58. MessageType,
  59. RoomID,
  60. TextMessageEventContent,
  61. UserID,
  62. VideoInfo,
  63. )
  64. from mautrix.util import ffmpeg
  65. from mautrix.util.message_send_checkpoint import MessageSendCheckpointStatus
  66. from mautrix.util.simple_lock import SimpleLock
  67. from . import matrix as m, puppet as p, user as u
  68. from .config import Config
  69. from .db import Message as DBMessage, Portal as DBPortal, Reaction as DBReaction
  70. if TYPE_CHECKING:
  71. from .__main__ import InstagramBridge
  72. try:
  73. from mautrix.crypto.attachments import decrypt_attachment, encrypt_attachment
  74. except ImportError:
  75. encrypt_attachment = decrypt_attachment = None
  76. try:
  77. from PIL import Image
  78. except ImportError:
  79. Image = None
  80. StateBridge = EventType.find("m.bridge", EventType.Class.STATE)
  81. StateHalfShotBridge = EventType.find("uk.half-shot.bridge", EventType.Class.STATE)
  82. MediaData = Union[
  83. AnimatedMediaItem,
  84. ExpiredMediaItem,
  85. MediaShareItem,
  86. ReelMediaShareItem,
  87. RegularMediaItem,
  88. VoiceMediaItem,
  89. ]
  90. MediaUploadFunc = Callable[["u.User", MediaData, IntentAPI], Awaitable[MediaMessageEventContent]]
  91. class Portal(DBPortal, BasePortal):
  92. by_mxid: dict[RoomID, Portal] = {}
  93. by_thread_id: dict[tuple[str, int], Portal] = {}
  94. config: Config
  95. matrix: m.MatrixHandler
  96. az: AppService
  97. private_chat_portal_meta: bool
  98. _main_intent: IntentAPI | None
  99. _create_room_lock: asyncio.Lock
  100. backfill_lock: SimpleLock
  101. _msgid_dedup: deque[str]
  102. _reqid_dedup: set[str]
  103. _reaction_dedup: deque[tuple[str, int, str]]
  104. _main_intent: IntentAPI
  105. _last_participant_update: set[int]
  106. _reaction_lock: asyncio.Lock
  107. _backfill_leave: set[IntentAPI] | None
  108. _typing: set[UserID]
  109. def __init__(
  110. self,
  111. thread_id: str,
  112. receiver: int,
  113. other_user_pk: int | None,
  114. mxid: RoomID | None = None,
  115. name: str | None = None,
  116. avatar_url: ContentURI | None = None,
  117. encrypted: bool = False,
  118. name_set: bool = False,
  119. avatar_set: bool = False,
  120. relay_user_id: UserID | None = None,
  121. ) -> None:
  122. super().__init__(
  123. thread_id,
  124. receiver,
  125. other_user_pk,
  126. mxid,
  127. name,
  128. avatar_url,
  129. encrypted,
  130. name_set,
  131. avatar_set,
  132. relay_user_id,
  133. )
  134. self._create_room_lock = asyncio.Lock()
  135. self.log = self.log.getChild(thread_id)
  136. self._msgid_dedup = deque(maxlen=100)
  137. self._reaction_dedup = deque(maxlen=100)
  138. self._reqid_dedup = set()
  139. self._last_participant_update = set()
  140. self.backfill_lock = SimpleLock(
  141. "Waiting for backfilling to finish before handling %s", log=self.log
  142. )
  143. self._backfill_leave = None
  144. self._main_intent = None
  145. self._reaction_lock = asyncio.Lock()
  146. self._typing = set()
  147. self._relay_user = None
  148. @property
  149. def is_direct(self) -> bool:
  150. return self.other_user_pk is not None
  151. @property
  152. def main_intent(self) -> IntentAPI:
  153. if not self._main_intent:
  154. raise ValueError("Portal must be postinit()ed before main_intent can be used")
  155. return self._main_intent
  156. @classmethod
  157. def init_cls(cls, bridge: "InstagramBridge") -> None:
  158. cls.config = bridge.config
  159. cls.matrix = bridge.matrix
  160. cls.az = bridge.az
  161. cls.loop = bridge.loop
  162. cls.bridge = bridge
  163. cls.private_chat_portal_meta = cls.config["bridge.private_chat_portal_meta"]
  164. NotificationDisabler.puppet_cls = p.Puppet
  165. NotificationDisabler.config_enabled = cls.config["bridge.backfill.disable_notifications"]
  166. # region Misc
  167. async def _send_delivery_receipt(self, event_id: EventID) -> None:
  168. if event_id and self.config["bridge.delivery_receipts"]:
  169. try:
  170. await self.az.intent.mark_read(self.mxid, event_id)
  171. except Exception:
  172. self.log.exception("Failed to send delivery receipt for %s", event_id)
  173. async def _send_bridge_error(
  174. self,
  175. sender: u.User,
  176. err: Exception | str,
  177. event_id: EventID,
  178. event_type: EventType,
  179. message_type: MessageType | None = None,
  180. msg: str | None = None,
  181. confirmed: bool = False,
  182. status: MessageSendCheckpointStatus = MessageSendCheckpointStatus.PERM_FAILURE,
  183. ) -> None:
  184. sender.send_remote_checkpoint(
  185. status,
  186. event_id,
  187. self.mxid,
  188. event_type,
  189. message_type=message_type,
  190. error=err,
  191. )
  192. if self.config["bridge.delivery_error_reports"]:
  193. event_type_str = {
  194. EventType.REACTION: "reaction",
  195. EventType.ROOM_REDACTION: "redaction",
  196. }.get(event_type, "message")
  197. error_type = "was not" if confirmed else "may not have been"
  198. await self._send_message(
  199. self.main_intent,
  200. TextMessageEventContent(
  201. msgtype=MessageType.NOTICE,
  202. body=f"\u26a0 Your {event_type_str} {error_type} bridged: {msg or str(err)}",
  203. ),
  204. )
  205. async def _upsert_reaction(
  206. self,
  207. existing: DBReaction | None,
  208. intent: IntentAPI,
  209. mxid: EventID,
  210. message: DBMessage,
  211. sender: u.User | p.Puppet,
  212. reaction: str,
  213. ) -> None:
  214. if existing:
  215. self.log.debug(
  216. f"_upsert_reaction redacting {existing.mxid} and inserting {mxid}"
  217. f" (message: {message.mxid})"
  218. )
  219. await intent.redact(existing.mx_room, existing.mxid)
  220. await existing.edit(reaction=reaction, mxid=mxid, mx_room=message.mx_room)
  221. else:
  222. self.log.debug(f"_upsert_reaction inserting {mxid} (message: {message.mxid})")
  223. await DBReaction(
  224. mxid=mxid,
  225. mx_room=message.mx_room,
  226. ig_item_id=message.item_id,
  227. ig_receiver=self.receiver,
  228. ig_sender=sender.igpk,
  229. reaction=reaction,
  230. ).insert()
  231. # endregion
  232. # region Matrix event handling
  233. @staticmethod
  234. def _status_from_exception(e: Exception) -> MessageSendCheckpointStatus:
  235. if isinstance(e, NotImplementedError):
  236. return MessageSendCheckpointStatus.UNSUPPORTED
  237. return MessageSendCheckpointStatus.PERM_FAILURE
  238. async def handle_matrix_message(
  239. self, sender: u.User, message: MessageEventContent, event_id: EventID
  240. ) -> None:
  241. try:
  242. await self._handle_matrix_message(sender, message, event_id)
  243. except Exception as e:
  244. self.log.exception(f"Fatal error handling Matrix event {event_id}: {e}")
  245. await self._send_bridge_error(
  246. sender,
  247. e,
  248. event_id,
  249. EventType.ROOM_MESSAGE,
  250. message_type=message.msgtype,
  251. status=self._status_from_exception(e),
  252. confirmed=True,
  253. )
  254. async def _handle_matrix_image(
  255. self,
  256. sender: u.User,
  257. event_id: EventID,
  258. request_id: str,
  259. data: bytes,
  260. mime_type: str,
  261. width: int | None = None,
  262. height: int | None = None,
  263. ) -> CommandResponse:
  264. if mime_type != "image/jpeg":
  265. with BytesIO(data) as inp, BytesIO() as out:
  266. img = Image.open(inp)
  267. img.convert("RGB").save(out, format="JPEG", quality=80)
  268. data = out.getvalue()
  269. mime_type = "image/jpeg"
  270. self.log.trace(f"Uploading photo from {event_id} (mime: {mime_type})")
  271. upload_resp = await sender.client.upload_photo(
  272. data, mime=mime_type, width=width, height=height
  273. )
  274. self.log.trace(f"Broadcasting uploaded photo with request ID {request_id}")
  275. return await sender.client.broadcast(
  276. self.thread_id,
  277. ThreadItemType.CONFIGURE_PHOTO,
  278. client_context=request_id,
  279. upload_id=upload_resp.upload_id,
  280. allow_full_aspect_ratio="true",
  281. )
  282. async def _handle_matrix_video(
  283. self,
  284. sender: u.User,
  285. event_id: EventID,
  286. request_id: str,
  287. data: bytes,
  288. mime_type: str,
  289. duration: int | None = None,
  290. width: int | None = None,
  291. height: int | None = None,
  292. ) -> CommandResponse:
  293. if mime_type != "video/mp4":
  294. data = await ffmpeg.convert_bytes(
  295. data,
  296. output_extension=".mp4",
  297. output_args=("-c:v", "libx264", "-c:a", "aac"),
  298. input_mime=mime_type,
  299. )
  300. self.log.trace(f"Uploading video from {event_id}")
  301. _, upload_id = await sender.client.upload_mp4(
  302. data, duration_ms=duration, width=width, height=height
  303. )
  304. self.log.trace(f"Broadcasting uploaded video with request ID {request_id}")
  305. return await sender.client.broadcast(
  306. self.thread_id,
  307. ThreadItemType.CONFIGURE_VIDEO,
  308. client_context=request_id,
  309. upload_id=upload_id,
  310. video_result="",
  311. )
  312. async def _handle_matrix_audio(
  313. self,
  314. sender: u.User,
  315. event_id: EventID,
  316. request_id: str,
  317. data: bytes,
  318. mime_type: str,
  319. waveform: list[int],
  320. duration: int | None = None,
  321. ) -> CommandResponse:
  322. if mime_type != "audio/mp4":
  323. data = await ffmpeg.convert_bytes(
  324. data, output_extension=".m4a", output_args=("-c:a", "aac"), input_mime=mime_type
  325. )
  326. self.log.trace(f"Uploading audio from {event_id}")
  327. _, upload_id = await sender.client.upload_mp4(data, audio=True, duration_ms=duration)
  328. self.log.trace(f"Broadcasting uploaded audio with request ID {request_id}")
  329. return await sender.client.broadcast_audio(
  330. self.thread_id,
  331. is_direct=self.is_direct,
  332. client_context=request_id,
  333. upload_id=upload_id,
  334. waveform=json.dumps([(part or 0) / 1024 for part in waveform], separators=(",", ":")),
  335. waveform_sampling_frequency_hz="10",
  336. )
  337. async def _handle_matrix_message(
  338. self, orig_sender: u.User, message: MessageEventContent, event_id: EventID
  339. ) -> None:
  340. sender, is_relay = await self.get_relay_sender(orig_sender, f"message {event_id}")
  341. assert sender, "user is not logged in"
  342. assert sender.is_connected, "You're not connected to Instagram"
  343. if is_relay:
  344. await self.apply_relay_message_format(orig_sender, message)
  345. reply_to = {}
  346. if message.get_reply_to():
  347. msg = await DBMessage.get_by_mxid(message.get_reply_to(), self.mxid)
  348. if msg and msg.client_context:
  349. reply_to = {
  350. "replied_to_item_id": msg.item_id,
  351. "replied_to_client_context": msg.client_context,
  352. }
  353. request_id = sender.state.gen_client_context()
  354. self._reqid_dedup.add(request_id)
  355. self.log.debug(
  356. f"Handling Matrix message {event_id} from {sender.mxid}/{sender.igpk} "
  357. f"with request ID {request_id}"
  358. )
  359. if message.msgtype in (MessageType.EMOTE, MessageType.TEXT, MessageType.NOTICE):
  360. text = message.body
  361. if message.msgtype == MessageType.EMOTE:
  362. text = f"/me {text}"
  363. self.log.trace(f"Sending Matrix text from {event_id} with request ID {request_id}")
  364. resp = await sender.mqtt.send_text(
  365. self.thread_id, text=text, client_context=request_id, **reply_to
  366. )
  367. elif message.msgtype.is_media:
  368. if message.file and decrypt_attachment:
  369. data = await self.main_intent.download_media(message.file.url)
  370. data = decrypt_attachment(
  371. data, message.file.key.key, message.file.hashes.get("sha256"), message.file.iv
  372. )
  373. else:
  374. data = await self.main_intent.download_media(message.url)
  375. mime_type = message.info.mimetype or magic.from_buffer(data, mime=True)
  376. if message.msgtype == MessageType.IMAGE:
  377. resp = await self._handle_matrix_image(
  378. sender,
  379. event_id,
  380. request_id,
  381. data,
  382. mime_type,
  383. width=message.info.width,
  384. height=message.info.height,
  385. )
  386. elif message.msgtype == MessageType.AUDIO:
  387. waveform = message.get("org.matrix.msc1767.audio", {}).get("waveform", [0] * 30)
  388. resp = await self._handle_matrix_audio(
  389. sender,
  390. event_id,
  391. request_id,
  392. data,
  393. mime_type,
  394. waveform,
  395. duration=message.info.duration,
  396. )
  397. elif message.msgtype == MessageType.VIDEO:
  398. resp = await self._handle_matrix_video(
  399. sender,
  400. event_id,
  401. request_id,
  402. data,
  403. mime_type,
  404. duration=message.info.duration,
  405. width=message.info.width,
  406. height=message.info.height,
  407. )
  408. else:
  409. raise NotImplementedError(
  410. "Non-image/video/audio files are currently not supported"
  411. )
  412. else:
  413. raise NotImplementedError(f"Unknown message type {message.msgtype}")
  414. self.log.trace(f"Got response to message send {request_id}: {resp}")
  415. if resp.status != "ok":
  416. self.log.warning(f"Failed to handle {event_id}: {resp}")
  417. raise Exception(f"Failed to handle event. Error: {resp.payload.message}")
  418. else:
  419. sender.send_remote_checkpoint(
  420. status=MessageSendCheckpointStatus.SUCCESS,
  421. event_id=event_id,
  422. room_id=self.mxid,
  423. event_type=EventType.ROOM_MESSAGE,
  424. message_type=message.msgtype,
  425. )
  426. await self._send_delivery_receipt(event_id)
  427. self._msgid_dedup.appendleft(resp.payload.item_id)
  428. try:
  429. await DBMessage(
  430. mxid=event_id,
  431. mx_room=self.mxid,
  432. item_id=resp.payload.item_id,
  433. client_context=resp.payload.client_context,
  434. receiver=self.receiver,
  435. sender=sender.igpk,
  436. ).insert()
  437. except asyncpg.UniqueViolationError as e:
  438. self.log.warning(
  439. f"Error while persisting {event_id} ({resp.payload.client_context}) "
  440. f"-> {resp.payload.item_id}: {e}"
  441. )
  442. self._reqid_dedup.remove(request_id)
  443. self.log.debug(
  444. f"Handled Matrix message {event_id} ({resp.payload.client_context}) "
  445. f"-> {resp.payload.item_id}"
  446. )
  447. async def handle_matrix_reaction(
  448. self, sender: u.User, event_id: EventID, reacting_to: EventID, emoji: str
  449. ) -> None:
  450. try:
  451. await self._handle_matrix_reaction(sender, event_id, reacting_to, emoji)
  452. except Exception as e:
  453. self.log.exception(f"Fatal error handling Matrix event {event_id}: {e}")
  454. await self._send_bridge_error(
  455. sender,
  456. e,
  457. event_id,
  458. EventType.REACTION,
  459. status=self._status_from_exception(e),
  460. confirmed=True,
  461. msg="Fatal error handling reaction (see logs for more details)",
  462. )
  463. async def _handle_matrix_reaction(
  464. self, sender: u.User, event_id: EventID, reacting_to: EventID, emoji: str
  465. ) -> None:
  466. message = await DBMessage.get_by_mxid(reacting_to, self.mxid)
  467. if not message or message.is_internal:
  468. self.log.debug(f"Ignoring reaction to unknown event {reacting_to}")
  469. return
  470. if not await sender.is_logged_in():
  471. self.log.debug(f"Ignoring reaction by non-logged-in user {sender.mxid}")
  472. return
  473. existing = await DBReaction.get_by_item_id(message.item_id, message.receiver, sender.igpk)
  474. if existing and existing.reaction == emoji:
  475. sender.send_remote_checkpoint(
  476. status=MessageSendCheckpointStatus.SUCCESS,
  477. event_id=event_id,
  478. room_id=self.mxid,
  479. event_type=EventType.REACTION,
  480. )
  481. return
  482. dedup_id = (message.item_id, sender.igpk, emoji)
  483. self._reaction_dedup.appendleft(dedup_id)
  484. async with self._reaction_lock:
  485. try:
  486. resp = await sender.mqtt.send_reaction(
  487. self.thread_id, item_id=message.item_id, emoji=emoji
  488. )
  489. if resp.status != "ok":
  490. raise Exception(f"Failed to react to {event_id}: {resp}")
  491. except Exception as e:
  492. self.log.exception(f"Failed to handle {event_id}: {e}")
  493. raise
  494. else:
  495. sender.send_remote_checkpoint(
  496. status=MessageSendCheckpointStatus.SUCCESS,
  497. event_id=event_id,
  498. room_id=self.mxid,
  499. event_type=EventType.REACTION,
  500. )
  501. await self._send_delivery_receipt(event_id)
  502. self.log.trace(f"{sender.mxid} reacted to {message.item_id} with {emoji}")
  503. await self._upsert_reaction(
  504. existing, self.main_intent, event_id, message, sender, emoji
  505. )
  506. async def handle_matrix_redaction(
  507. self, orig_sender: u.User, event_id: EventID, redaction_event_id: EventID
  508. ) -> None:
  509. sender = None
  510. try:
  511. sender, _ = await self.get_relay_sender(orig_sender, f"redaction {event_id}")
  512. if not sender:
  513. raise Exception("User is not logged in")
  514. await self._handle_matrix_redaction(sender, event_id, redaction_event_id)
  515. except Exception as e:
  516. self.log.exception(f"Fatal error handling Matrix event {event_id}: {e}")
  517. await self._send_bridge_error(
  518. sender or orig_sender,
  519. e,
  520. redaction_event_id,
  521. EventType.ROOM_REDACTION,
  522. status=self._status_from_exception(e),
  523. confirmed=True,
  524. )
  525. async def _handle_matrix_redaction(
  526. self, sender: u.User, event_id: EventID, redaction_event_id: EventID
  527. ) -> None:
  528. if not sender.is_connected:
  529. raise Exception("You're not connected to Instagram")
  530. reaction = await DBReaction.get_by_mxid(event_id, self.mxid)
  531. if reaction:
  532. try:
  533. await reaction.delete()
  534. await sender.mqtt.send_reaction(
  535. self.thread_id,
  536. item_id=reaction.ig_item_id,
  537. reaction_status=ReactionStatus.DELETED,
  538. emoji="",
  539. )
  540. except Exception as e:
  541. raise Exception(f"Removing reaction failed: {e}")
  542. else:
  543. sender.send_remote_checkpoint(
  544. status=MessageSendCheckpointStatus.SUCCESS,
  545. event_id=redaction_event_id,
  546. room_id=self.mxid,
  547. event_type=EventType.ROOM_REDACTION,
  548. )
  549. await self._send_delivery_receipt(redaction_event_id)
  550. self.log.trace(f"Removed {reaction} after Matrix redaction")
  551. return
  552. message = await DBMessage.get_by_mxid(event_id, self.mxid)
  553. if message and not message.is_internal:
  554. try:
  555. await message.delete()
  556. await sender.client.delete_item(self.thread_id, message.item_id)
  557. self.log.trace(f"Removed {message} after Matrix redaction")
  558. except Exception as e:
  559. raise Exception(f"Removing message failed: {e}")
  560. else:
  561. sender.send_remote_checkpoint(
  562. status=MessageSendCheckpointStatus.SUCCESS,
  563. event_id=redaction_event_id,
  564. room_id=self.mxid,
  565. event_type=EventType.ROOM_REDACTION,
  566. )
  567. await self._send_delivery_receipt(redaction_event_id)
  568. self.log.trace(f"Removed {reaction} after Matrix redaction")
  569. return
  570. raise Exception("No message or reaction found for redaction")
  571. async def handle_matrix_typing(self, users: set[UserID]) -> None:
  572. if users == self._typing:
  573. return
  574. old_typing = self._typing
  575. self._typing = users
  576. await self._handle_matrix_typing(old_typing - users, TypingStatus.OFF)
  577. await self._handle_matrix_typing(users - old_typing, TypingStatus.TEXT)
  578. async def _handle_matrix_typing(self, users: set[UserID], status: TypingStatus) -> None:
  579. for mxid in users:
  580. user = await u.User.get_by_mxid(mxid, create=False)
  581. if (
  582. not user
  583. or not await user.is_logged_in()
  584. or user.remote_typing_status == status
  585. or not user.is_connected
  586. ):
  587. continue
  588. user.remote_typing_status = None
  589. await user.mqtt.indicate_activity(self.thread_id, status)
  590. async def handle_matrix_leave(self, user: u.User) -> None:
  591. if not await user.is_logged_in():
  592. return
  593. if self.is_direct:
  594. self.log.info(f"{user.mxid} left private chat portal with {self.other_user_pk}")
  595. if user.igpk == self.receiver:
  596. self.log.info(
  597. f"{user.mxid} was the recipient of this portal. Cleaning up and deleting..."
  598. )
  599. await self.cleanup_and_delete()
  600. else:
  601. self.log.debug(f"{user.mxid} left portal to {self.thread_id}")
  602. # TODO cleanup if empty
  603. # endregion
  604. # region Instagram event handling
  605. async def _reupload_instagram_media(
  606. self, source: u.User, media: RegularMediaItem, intent: IntentAPI
  607. ) -> MediaMessageEventContent:
  608. if media.media_type == MediaType.IMAGE:
  609. image = media.best_image
  610. if not image:
  611. raise ValueError("Attachment not available: didn't find photo URL")
  612. url = image.url
  613. msgtype = MessageType.IMAGE
  614. info = ImageInfo(height=image.height, width=image.width)
  615. elif media.media_type == MediaType.VIDEO:
  616. video = media.best_video
  617. if not video:
  618. raise ValueError("Attachment not available: didn't find video URL")
  619. url = video.url
  620. msgtype = MessageType.VIDEO
  621. info = VideoInfo(height=video.height, width=video.width)
  622. elif media.media_type == MediaType.CAROUSEL:
  623. raise ValueError(
  624. "Carousel media is not currently supported, "
  625. "please view the post on Instagram via the link below"
  626. )
  627. else:
  628. raise ValueError(
  629. f"Attachment not available: unsupported media type {media.media_type.human_name}"
  630. )
  631. return await self._reupload_instagram_file(source, url, msgtype, info, intent)
  632. async def _reupload_instagram_animated(
  633. self, source: u.User, media: AnimatedMediaItem, intent: IntentAPI
  634. ) -> MediaMessageEventContent:
  635. url = media.images.fixed_height.webp
  636. info = ImageInfo(
  637. height=int(media.images.fixed_height.height),
  638. width=int(media.images.fixed_height.width),
  639. )
  640. return await self._reupload_instagram_file(source, url, MessageType.IMAGE, info, intent)
  641. async def _reupload_instagram_voice(
  642. self, source: u.User, media: VoiceMediaItem, intent: IntentAPI
  643. ) -> MediaMessageEventContent:
  644. async def convert_to_ogg(data, mimetype):
  645. converted = await ffmpeg.convert_bytes(
  646. data, ".ogg", output_args=("-c:a", "libopus"), input_mime=mimetype
  647. )
  648. return converted, "audio/ogg"
  649. url = media.media.audio.audio_src
  650. info = AudioInfo(duration=media.media.audio.duration)
  651. waveform = [int(p * 1024) for p in media.media.audio.waveform_data]
  652. content = await self._reupload_instagram_file(
  653. source, url, MessageType.AUDIO, info, intent, convert_to_ogg
  654. )
  655. content["org.matrix.msc1767.audio"] = {
  656. "duration": media.media.audio.duration,
  657. "waveform": waveform,
  658. }
  659. content["org.matrix.msc3245.voice"] = {}
  660. return content
  661. async def _reupload_instagram_file(
  662. self,
  663. source: u.User,
  664. url: str,
  665. msgtype: MessageType,
  666. info: ImageInfo | VideoInfo | AudioInfo,
  667. intent: IntentAPI,
  668. convert_fn: Callable[[bytes, str], Awaitable[tuple[bytes, str]]] | None = None,
  669. ) -> MediaMessageEventContent:
  670. async with source.client.raw_http_get(url) as resp:
  671. try:
  672. length = int(resp.headers["Content-Length"])
  673. except KeyError:
  674. # TODO can the download be short-circuited if there's too much data?
  675. self.log.warning(
  676. "Got file download response with no Content-Length header,"
  677. "reading data dangerously"
  678. )
  679. length = 0
  680. if length > self.matrix.media_config.upload_size:
  681. self.log.debug(
  682. f"{url} was too large ({length} > {self.matrix.media_config.upload_size})"
  683. )
  684. raise ValueError("Attachment not available: too large")
  685. data = await resp.read()
  686. info.mimetype = resp.headers["Content-Type"] or magic.from_buffer(data, mime=True)
  687. # Run the conversion function on the data.
  688. if convert_fn is not None:
  689. data, info.mimetype = await convert_fn(data, info.mimetype)
  690. info.size = len(data)
  691. extension = {
  692. "image/webp": ".webp",
  693. "image/jpeg": ".jpg",
  694. "video/mp4": ".mp4",
  695. "audio/mp4": ".m4a",
  696. "audio/ogg": ".ogg",
  697. }.get(info.mimetype)
  698. extension = extension or mimetypes.guess_extension(info.mimetype) or ""
  699. file_name = f"{msgtype.value[2:]}{extension}"
  700. upload_mime_type = info.mimetype
  701. upload_file_name = file_name
  702. decryption_info = None
  703. if self.encrypted and encrypt_attachment:
  704. data, decryption_info = encrypt_attachment(data)
  705. upload_mime_type = "application/octet-stream"
  706. upload_file_name = None
  707. mxc = await intent.upload_media(
  708. data, mime_type=upload_mime_type, filename=upload_file_name
  709. )
  710. if decryption_info:
  711. decryption_info.url = mxc
  712. mxc = None
  713. return MediaMessageEventContent(
  714. body=file_name,
  715. external_url=url,
  716. url=mxc,
  717. file=decryption_info,
  718. info=info,
  719. msgtype=msgtype,
  720. )
  721. def _get_instagram_media_info(self, item: ThreadItem) -> tuple[MediaUploadFunc, MediaData]:
  722. # TODO maybe use a dict and item.item_type instead of a ton of ifs
  723. method = self._reupload_instagram_media
  724. if item.media:
  725. media_data = item.media
  726. elif item.visual_media:
  727. media_data = item.visual_media.media
  728. elif item.animated_media:
  729. media_data = item.animated_media
  730. method = self._reupload_instagram_animated
  731. elif item.voice_media:
  732. media_data = item.voice_media
  733. method = self._reupload_instagram_voice
  734. elif item.reel_share:
  735. media_data = item.reel_share.media
  736. elif item.story_share:
  737. media_data = item.story_share.media
  738. elif item.clip:
  739. media_data = item.clip.clip
  740. elif item.felix_share and item.felix_share.video:
  741. media_data = item.felix_share.video
  742. elif item.media_share:
  743. media_data = item.media_share
  744. elif item.direct_media_share:
  745. media_data = item.direct_media_share.media
  746. else:
  747. self.log.debug(f"Unknown media type in {item}")
  748. raise ValueError("Attachment not available: unsupported media type")
  749. if not media_data:
  750. self.log.debug(f"Didn't get media_data in {item}")
  751. raise ValueError("Attachment not available: unsupported media type")
  752. elif isinstance(media_data, ExpiredMediaItem):
  753. self.log.debug(f"Expired media in item {item}")
  754. raise ValueError("Attachment not available: media expired")
  755. return method, media_data
  756. async def _handle_instagram_media(
  757. self, source: u.User, intent: IntentAPI, item: ThreadItem
  758. ) -> EventID | None:
  759. try:
  760. reupload_func, media_data = self._get_instagram_media_info(item)
  761. content = await reupload_func(source, media_data, intent)
  762. except ValueError as e:
  763. content = TextMessageEventContent(body=str(e), msgtype=MessageType.NOTICE)
  764. except Exception:
  765. self.log.warning("Failed to upload media", exc_info=True)
  766. content = TextMessageEventContent(
  767. body="Attachment not available: failed to copy file", msgtype=MessageType.NOTICE
  768. )
  769. await self._add_instagram_reply(content, item.replied_to_message)
  770. return await self._send_message(intent, content, timestamp=item.timestamp // 1000)
  771. async def _handle_instagram_media_share(
  772. self, source: u.User, intent: IntentAPI, item: ThreadItem
  773. ) -> EventID | None:
  774. item_type_name = None
  775. if item.media_share:
  776. share_item = item.media_share
  777. elif item.clip:
  778. share_item = item.clip.clip
  779. item_type_name = "clip"
  780. elif item.felix_share and item.felix_share.video:
  781. share_item = item.felix_share.video
  782. elif item.story_share:
  783. share_item = item.story_share.media
  784. item_type_name = "story"
  785. elif item.direct_media_share:
  786. share_item = item.direct_media_share.media
  787. else:
  788. return None
  789. item_type_name = item_type_name or share_item.media_type.human_name
  790. user_text = f"@{share_item.user.username}"
  791. user_link = (
  792. f'<a href="https://www.instagram.com/{share_item.user.username}/">{user_text}</a>'
  793. )
  794. prefix = TextMessageEventContent(
  795. msgtype=MessageType.NOTICE,
  796. format=Format.HTML,
  797. body=f"Sent {user_text}'s {item_type_name}",
  798. formatted_body=f"Sent {user_link}'s {item_type_name}",
  799. )
  800. if item.direct_media_share and item.direct_media_share.media_share_type == "tag":
  801. tagged_user_id = item.direct_media_share.tagged_user_id
  802. if tagged_user_id == source.igpk and share_item.user.pk == self.other_user_pk:
  803. prefix.body = prefix.formatted_body = "Tagged you in their post"
  804. elif share_item.user.pk == source.igpk and tagged_user_id == self.other_user_pk:
  805. prefix.body = prefix.formatted_body = "Tagged them in your post"
  806. await self._send_message(intent, prefix, timestamp=item.timestamp // 1000)
  807. event_id = await self._handle_instagram_media(source, intent, item)
  808. external_url = f"https://www.instagram.com/p/{share_item.code}/"
  809. if share_item.caption:
  810. caption_body = (
  811. f"> {share_item.caption.user.username}: {share_item.caption.text}\n\n"
  812. f"{external_url}"
  813. )
  814. caption_formatted_body = (
  815. f"<blockquote><strong>{share_item.caption.user.username}</strong>"
  816. f" {share_item.caption.text}</blockquote>"
  817. f'<a href="{external_url}">instagram.com/p/{share_item.code}</a>'
  818. )
  819. else:
  820. caption_body = external_url
  821. caption_formatted_body = (
  822. f'<a href="{external_url}">instagram.com/p/{share_item.code}</a>'
  823. )
  824. caption = TextMessageEventContent(
  825. msgtype=MessageType.TEXT,
  826. body=caption_body,
  827. formatted_body=caption_formatted_body,
  828. format=Format.HTML,
  829. external_url=external_url,
  830. )
  831. await self._send_message(intent, caption, timestamp=item.timestamp // 1000)
  832. return event_id
  833. async def _handle_instagram_reel_share(
  834. self, source: u.User, intent: IntentAPI, item: ThreadItem
  835. ) -> EventID | None:
  836. media = item.reel_share.media
  837. prefix_html = None
  838. if item.reel_share.type == ReelShareType.REPLY:
  839. if item.reel_share.reel_owner_id == source.igpk:
  840. prefix = "Replied to your story"
  841. else:
  842. username = media.user.username
  843. prefix = f"Sent @{username}'s story"
  844. user_link = f'<a href="https://www.instagram.com/{username}/">@{username}</a>'
  845. prefix_html = f"Sent {user_link}'s story"
  846. elif item.reel_share.type == ReelShareType.REACTION:
  847. prefix = "Reacted to your story"
  848. elif item.reel_share.type == ReelShareType.MENTION:
  849. if item.reel_share.mentioned_user_id == source.igpk:
  850. prefix = "Mentioned you in their story"
  851. else:
  852. prefix = "You mentioned them in your story"
  853. else:
  854. self.log.debug(f"Unsupported reel share type {item.reel_share.type}")
  855. return None
  856. prefix_content = TextMessageEventContent(msgtype=MessageType.NOTICE, body=prefix)
  857. if prefix_html:
  858. prefix_content.format = Format.HTML
  859. prefix_content.formatted_body = prefix_html
  860. content = TextMessageEventContent(msgtype=MessageType.TEXT, body=item.reel_share.text)
  861. if not content.body and isinstance(media, MediaShareItem):
  862. content.body = media.caption.text if media.caption else ""
  863. if not content.body:
  864. content.body = "<no caption>"
  865. await self._send_message(intent, prefix_content, timestamp=item.timestamp // 1000)
  866. if isinstance(media, ExpiredMediaItem):
  867. # TODO send message about expired story
  868. pass
  869. else:
  870. fake_item_id = f"fi.mau.instagram.reel_share.{item.user_id}.{media.pk}"
  871. existing = await DBMessage.get_by_item_id(fake_item_id, self.receiver)
  872. if existing:
  873. # If the user already reacted or replied to the same reel share item,
  874. # use a Matrix reply instead of reposting the image.
  875. content.set_reply(existing.mxid)
  876. else:
  877. media_event_id = await self._handle_instagram_media(source, intent, item)
  878. await DBMessage(
  879. mxid=media_event_id,
  880. mx_room=self.mxid,
  881. item_id=fake_item_id,
  882. client_context=None,
  883. receiver=self.receiver,
  884. sender=media.user.pk,
  885. ).insert()
  886. return await self._send_message(intent, content, timestamp=item.timestamp // 1000)
  887. async def _handle_instagram_text(
  888. self, intent: IntentAPI, item: ThreadItem, text: str
  889. ) -> EventID:
  890. content = TextMessageEventContent(msgtype=MessageType.TEXT, body=text)
  891. await self._add_instagram_reply(content, item.replied_to_message)
  892. return await self._send_message(intent, content, timestamp=item.timestamp // 1000)
  893. async def _send_instagram_unhandled(self, intent: IntentAPI, item: ThreadItem) -> EventID:
  894. content = TextMessageEventContent(
  895. msgtype=MessageType.NOTICE, body=f"Unsupported message type {item.item_type.value}"
  896. )
  897. await self._add_instagram_reply(content, item.replied_to_message)
  898. return await self._send_message(intent, content, timestamp=item.timestamp // 1000)
  899. async def _handle_instagram_location(
  900. self, intent: IntentAPI, item: ThreadItem
  901. ) -> EventID | None:
  902. loc = item.location
  903. if not loc.lng or not loc.lat:
  904. # TODO handle somehow
  905. return None
  906. long_char = "E" if loc.lng > 0 else "W"
  907. lat_char = "N" if loc.lat > 0 else "S"
  908. body = (
  909. f"{loc.name} - {round(abs(loc.lat), 4)}° {lat_char}, "
  910. f"{round(abs(loc.lng), 4)}° {long_char}"
  911. )
  912. url = f"https://www.openstreetmap.org/#map=15/{loc.lat}/{loc.lng}"
  913. external_url = None
  914. if loc.external_source == "facebook_places":
  915. external_url = f"https://www.facebook.com/{loc.short_name}-{loc.facebook_places_id}"
  916. content = LocationMessageEventContent(
  917. msgtype=MessageType.LOCATION,
  918. geo_uri=f"geo:{loc.lat},{loc.lng}",
  919. body=f"Location: {body}\n{url}",
  920. external_url=external_url,
  921. )
  922. content["format"] = str(Format.HTML)
  923. content["formatted_body"] = f"Location: <a href='{url}'>{body}</a>"
  924. await self._add_instagram_reply(content, item.replied_to_message)
  925. return await self._send_message(intent, content, timestamp=item.timestamp // 1000)
  926. async def _handle_instagram_profile(
  927. self, intent: IntentAPI, item: ThreadItem
  928. ) -> EventID | None:
  929. username = item.profile.username
  930. user_link = f'<a href="https://www.instagram.com/{username}/">@{username}</a>'
  931. text = f"Shared @{username}'s profile"
  932. html = f"Shared {user_link}'s profile"
  933. content = TextMessageEventContent(
  934. msgtype=MessageType.TEXT, format=Format.HTML, body=text, formatted_body=html
  935. )
  936. await self._add_instagram_reply(content, item.replied_to_message)
  937. return await self._send_message(intent, content, timestamp=item.timestamp // 1000)
  938. async def handle_instagram_item(
  939. self, source: u.User, sender: p.Puppet, item: ThreadItem, is_backfill: bool = False
  940. ) -> None:
  941. try:
  942. await self._handle_instagram_item(source, sender, item, is_backfill)
  943. except Exception:
  944. self.log.exception("Fatal error handling Instagram item")
  945. self.log.trace("Item content: %s", item.serialize())
  946. async def _add_instagram_reply(
  947. self, content: MessageEventContent, reply_to: ThreadItem | None
  948. ) -> None:
  949. if not reply_to:
  950. return
  951. message = await DBMessage.get_by_item_id(reply_to.item_id, self.receiver)
  952. if not message:
  953. return
  954. content.set_reply(message.mxid)
  955. if not isinstance(content, TextMessageEventContent):
  956. return
  957. try:
  958. evt = await self.main_intent.get_event(message.mx_room, message.mxid)
  959. except (MNotFound, MForbidden):
  960. evt = None
  961. if not evt:
  962. return
  963. if evt.type == EventType.ROOM_ENCRYPTED:
  964. try:
  965. evt = await self.matrix.e2ee.decrypt(evt, wait_session_timeout=0)
  966. except SessionNotFound:
  967. return
  968. if isinstance(evt.content, TextMessageEventContent):
  969. evt.content.trim_reply_fallback()
  970. content.set_reply(evt)
  971. async def _handle_instagram_item(
  972. self, source: u.User, sender: p.Puppet, item: ThreadItem, is_backfill: bool = False
  973. ) -> None:
  974. if not isinstance(item, ThreadItem):
  975. # Parsing these items failed, they should have been logged already
  976. return
  977. elif item.client_context in self._reqid_dedup:
  978. self.log.debug(
  979. f"Ignoring message {item.item_id} ({item.client_context}) by "
  980. f"{item.user_id} as it was sent by us (client_context in dedup queue)"
  981. )
  982. elif item.item_id in self._msgid_dedup:
  983. self.log.debug(
  984. f"Ignoring message {item.item_id} ({item.client_context}) by "
  985. f"{item.user_id} as it was already handled (message.id in dedup queue)"
  986. )
  987. elif await DBMessage.get_by_item_id(item.item_id, self.receiver) is not None:
  988. self.log.debug(
  989. f"Ignoring message {item.item_id} ({item.client_context}) by "
  990. f"{item.user_id} as it was already handled (message.id in database)"
  991. )
  992. else:
  993. self.log.debug(
  994. f"Starting handling of message {item.item_id} ({item.client_context}) "
  995. f"by {item.user_id}"
  996. )
  997. self._msgid_dedup.appendleft(item.item_id)
  998. if self.backfill_lock.locked and sender.need_backfill_invite(self):
  999. self.log.debug("Adding %s's default puppet to room for backfilling", sender.mxid)
  1000. if self.is_direct:
  1001. await self.main_intent.invite_user(self.mxid, sender.default_mxid)
  1002. intent = sender.default_mxid_intent
  1003. await intent.ensure_joined(self.mxid)
  1004. self._backfill_leave.add(intent)
  1005. else:
  1006. intent = sender.intent_for(self)
  1007. event_id = None
  1008. if item.media or item.animated_media or item.voice_media or item.visual_media:
  1009. event_id = await self._handle_instagram_media(source, intent, item)
  1010. elif item.location:
  1011. event_id = await self._handle_instagram_location(intent, item)
  1012. elif item.profile:
  1013. event_id = await self._handle_instagram_profile(intent, item)
  1014. elif item.reel_share:
  1015. event_id = await self._handle_instagram_reel_share(source, intent, item)
  1016. elif (
  1017. item.media_share
  1018. or item.direct_media_share
  1019. or item.story_share
  1020. or item.clip
  1021. or item.felix_share
  1022. ):
  1023. event_id = await self._handle_instagram_media_share(source, intent, item)
  1024. elif item.action_log:
  1025. # These probably don't need to be bridged
  1026. self.log.debug(f"Ignoring action log message {item.item_id}")
  1027. return
  1028. # TODO handle item.clip?
  1029. if item.text:
  1030. event_id = await self._handle_instagram_text(intent, item, item.text)
  1031. elif item.like:
  1032. # We handle likes as text because Matrix clients do big emoji on their own.
  1033. event_id = await self._handle_instagram_text(intent, item, item.like)
  1034. elif item.link:
  1035. event_id = await self._handle_instagram_text(intent, item, item.link.text)
  1036. handled = bool(event_id)
  1037. if not event_id:
  1038. self.log.debug(f"Unhandled Instagram message {item.item_id}")
  1039. event_id = await self._send_instagram_unhandled(intent, item)
  1040. msg = DBMessage(
  1041. mxid=event_id,
  1042. mx_room=self.mxid,
  1043. item_id=item.item_id,
  1044. client_context=item.client_context,
  1045. receiver=self.receiver,
  1046. sender=sender.pk,
  1047. )
  1048. await msg.insert()
  1049. await self._send_delivery_receipt(event_id)
  1050. if handled:
  1051. self.log.debug(f"Handled Instagram message {item.item_id} -> {event_id}")
  1052. else:
  1053. self.log.debug(
  1054. f"Unhandled Instagram message {item.item_id} "
  1055. f"(type {item.item_type} -> fallback error {event_id})"
  1056. )
  1057. if is_backfill and item.reactions:
  1058. await self._handle_instagram_reactions(msg, item.reactions.emojis)
  1059. async def handle_instagram_remove(self, item_id: str) -> None:
  1060. message = await DBMessage.get_by_item_id(item_id, self.receiver)
  1061. if message is None:
  1062. return
  1063. await message.delete()
  1064. sender = await p.Puppet.get_by_pk(message.sender)
  1065. try:
  1066. await sender.intent_for(self).redact(self.mxid, message.mxid)
  1067. except MForbidden:
  1068. await self.main_intent.redact(self.mxid, message.mxid)
  1069. self.log.debug(f"Redacted {message.mxid} after Instagram unsend")
  1070. async def _handle_instagram_reactions(
  1071. self, message: DBMessage, reactions: list[Reaction]
  1072. ) -> None:
  1073. old_reactions: dict[int, DBReaction]
  1074. old_reactions = {
  1075. reaction.ig_sender: reaction
  1076. for reaction in await DBReaction.get_all_by_item_id(message.item_id, self.receiver)
  1077. }
  1078. for new_reaction in reactions:
  1079. old_reaction = old_reactions.pop(new_reaction.sender_id, None)
  1080. if old_reaction and old_reaction.reaction == new_reaction.emoji:
  1081. continue
  1082. puppet = await p.Puppet.get_by_pk(new_reaction.sender_id)
  1083. intent = puppet.intent_for(self)
  1084. reaction_event_id = await intent.react(self.mxid, message.mxid, new_reaction.emoji)
  1085. await self._upsert_reaction(
  1086. old_reaction, intent, reaction_event_id, message, puppet, new_reaction.emoji
  1087. )
  1088. for old_reaction in old_reactions.values():
  1089. await old_reaction.delete()
  1090. puppet = await p.Puppet.get_by_pk(old_reaction.ig_sender)
  1091. await puppet.intent_for(self).redact(self.mxid, old_reaction.mxid)
  1092. async def handle_instagram_update(self, item: MessageSyncMessage) -> None:
  1093. message = await DBMessage.get_by_item_id(item.item_id, self.receiver)
  1094. if not message:
  1095. return
  1096. if item.has_seen:
  1097. puppet = await p.Puppet.get_by_pk(item.has_seen, create=False)
  1098. if puppet:
  1099. await puppet.intent_for(self).mark_read(self.mxid, message.mxid)
  1100. else:
  1101. async with self._reaction_lock:
  1102. await self._handle_instagram_reactions(
  1103. message, (item.reactions.emojis if item.reactions else [])
  1104. )
  1105. # endregion
  1106. # region Updating portal info
  1107. def _get_thread_name(self, thread: Thread) -> str:
  1108. if self.is_direct:
  1109. if self.other_user_pk == thread.viewer_id and len(thread.users) == 0:
  1110. return "Instagram chat with yourself"
  1111. elif len(thread.users) == 1:
  1112. tpl = self.config["bridge.private_chat_name_template"]
  1113. ui = thread.users[0]
  1114. return tpl.format(displayname=ui.full_name, id=ui.pk, username=ui.username)
  1115. pass
  1116. elif thread.thread_title:
  1117. return self.config["bridge.group_chat_name_template"].format(name=thread.thread_title)
  1118. else:
  1119. return ""
  1120. async def update_info(self, thread: Thread, source: u.User) -> None:
  1121. changed = await self._update_name(self._get_thread_name(thread))
  1122. changed = await self._update_participants(thread.users, source) or changed
  1123. if changed:
  1124. await self.update_bridge_info()
  1125. await self.update()
  1126. # TODO update power levels with thread.admin_user_ids
  1127. async def _update_name(self, name: str) -> bool:
  1128. if name and (self.name != name or not self.name_set):
  1129. self.name = name
  1130. if self.mxid:
  1131. try:
  1132. await self.main_intent.set_room_name(self.mxid, name)
  1133. self.name_set = True
  1134. except Exception:
  1135. self.log.exception("Failed to update name")
  1136. self.name_set = False
  1137. return True
  1138. return False
  1139. async def _update_photo_from_puppet(self, puppet: p.Puppet) -> bool:
  1140. if not self.private_chat_portal_meta and not self.encrypted:
  1141. return False
  1142. if self.avatar_set and self.avatar_url == puppet.photo_mxc:
  1143. return False
  1144. self.avatar_url = puppet.photo_mxc
  1145. if self.mxid:
  1146. try:
  1147. await self.main_intent.set_room_avatar(self.mxid, puppet.photo_mxc)
  1148. self.avatar_set = True
  1149. except Exception:
  1150. self.log.exception("Failed to set room avatar")
  1151. self.avatar_set = False
  1152. return True
  1153. async def _update_participants(self, users: list[ThreadUser], source: u.User) -> bool:
  1154. meta_changed = False
  1155. # Make sure puppets who should be here are here
  1156. for user in users:
  1157. puppet = await p.Puppet.get_by_pk(user.pk)
  1158. await puppet.update_info(user, source)
  1159. if self.mxid:
  1160. await puppet.intent_for(self).ensure_joined(self.mxid)
  1161. if puppet.pk == self.other_user_pk:
  1162. meta_changed = await self._update_photo_from_puppet(puppet)
  1163. if self.mxid:
  1164. # Kick puppets who shouldn't be here
  1165. current_members = {int(user.pk) for user in users}
  1166. for user_id in await self.main_intent.get_room_members(self.mxid):
  1167. pk = p.Puppet.get_id_from_mxid(user_id)
  1168. if pk and pk not in current_members and pk != self.other_user_pk:
  1169. await self.main_intent.kick_user(
  1170. self.mxid,
  1171. p.Puppet.get_mxid_from_id(pk),
  1172. reason="User had left this Instagram DM",
  1173. )
  1174. return meta_changed
  1175. async def _update_read_receipts(self, receipts: dict[int | str, ThreadUserLastSeenAt]) -> None:
  1176. for user_id, receipt in receipts.items():
  1177. message = await DBMessage.get_by_item_id(receipt.item_id, self.receiver)
  1178. if not message:
  1179. continue
  1180. puppet = await p.Puppet.get_by_pk(int(user_id), create=False)
  1181. if not puppet:
  1182. continue
  1183. try:
  1184. await puppet.intent_for(self).mark_read(message.mx_room, message.mxid)
  1185. except Exception:
  1186. self.log.warning(
  1187. f"Failed to mark {message.mxid} in {message.mx_room} "
  1188. f"as read by {puppet.intent.mxid}",
  1189. exc_info=True,
  1190. )
  1191. # endregion
  1192. # region Backfilling
  1193. async def backfill(self, source: u.User, is_initial: bool = False) -> None:
  1194. limit = (
  1195. self.config["bridge.backfill.initial_limit"]
  1196. if is_initial
  1197. else self.config["bridge.backfill.missed_limit"]
  1198. )
  1199. if limit == 0:
  1200. return
  1201. elif limit < 0:
  1202. limit = None
  1203. with self.backfill_lock:
  1204. await self._backfill(source, is_initial, limit)
  1205. async def _backfill(self, source: u.User, is_initial: bool, limit: int) -> None:
  1206. self.log.debug("Backfilling history through %s", source.mxid)
  1207. entries = await self._fetch_backfill_items(source, is_initial, limit)
  1208. if not entries:
  1209. self.log.debug("Didn't get any items to backfill from server")
  1210. return
  1211. self.log.debug("Got %d entries from server", len(entries))
  1212. self._backfill_leave = set()
  1213. async with NotificationDisabler(self.mxid, source):
  1214. for entry in reversed(entries):
  1215. sender = await p.Puppet.get_by_pk(int(entry.user_id))
  1216. await self.handle_instagram_item(source, sender, entry, is_backfill=True)
  1217. for intent in self._backfill_leave:
  1218. self.log.trace("Leaving room with %s post-backfill", intent.mxid)
  1219. await intent.leave_room(self.mxid)
  1220. self._backfill_leave = None
  1221. self.log.info("Backfilled %d messages through %s", len(entries), source.mxid)
  1222. async def _fetch_backfill_items(
  1223. self, source: u.User, is_initial: bool, limit: int
  1224. ) -> list[ThreadItem]:
  1225. items = []
  1226. self.log.debug("Fetching up to %d messages through %s", limit, source.igpk)
  1227. async for item in source.client.iter_thread(self.thread_id):
  1228. if len(items) >= limit:
  1229. self.log.debug(f"Fetched {len(items)} messages (the limit)")
  1230. break
  1231. elif not is_initial:
  1232. msg = await DBMessage.get_by_item_id(item.item_id, receiver=self.receiver)
  1233. if msg is not None:
  1234. self.log.debug(
  1235. f"Fetched {len(items)} messages and hit a message"
  1236. " that's already in the database."
  1237. )
  1238. break
  1239. items.append(item)
  1240. return items
  1241. # endregion
  1242. # region Bridge info state event
  1243. @property
  1244. def bridge_info_state_key(self) -> str:
  1245. return f"net.maunium.instagram://instagram/{self.thread_id}"
  1246. @property
  1247. def bridge_info(self) -> dict[str, Any]:
  1248. return {
  1249. "bridgebot": self.az.bot_mxid,
  1250. "creator": self.main_intent.mxid,
  1251. "protocol": {
  1252. "id": "instagram",
  1253. "displayname": "Instagram DM",
  1254. "avatar_url": self.config["appservice.bot_avatar"],
  1255. },
  1256. "channel": {
  1257. "id": self.thread_id,
  1258. "displayname": self.name,
  1259. "avatar_url": self.avatar_url,
  1260. },
  1261. }
  1262. async def update_bridge_info(self) -> None:
  1263. if not self.mxid:
  1264. self.log.debug("Not updating bridge info: no Matrix room created")
  1265. return
  1266. try:
  1267. self.log.debug("Updating bridge info...")
  1268. await self.main_intent.send_state_event(
  1269. self.mxid, StateBridge, self.bridge_info, self.bridge_info_state_key
  1270. )
  1271. # TODO remove this once https://github.com/matrix-org/matrix-doc/pull/2346 is in spec
  1272. await self.main_intent.send_state_event(
  1273. self.mxid, StateHalfShotBridge, self.bridge_info, self.bridge_info_state_key
  1274. )
  1275. except Exception:
  1276. self.log.warning("Failed to update bridge info", exc_info=True)
  1277. # endregion
  1278. # region Creating Matrix rooms
  1279. async def create_matrix_room(self, source: u.User, info: Thread) -> RoomID | None:
  1280. if self.mxid:
  1281. try:
  1282. await self.update_matrix_room(source, info)
  1283. except Exception:
  1284. self.log.exception("Failed to update portal")
  1285. return self.mxid
  1286. async with self._create_room_lock:
  1287. return await self._create_matrix_room(source, info)
  1288. def _get_invite_content(self, double_puppet: p.Puppet | None) -> dict[str, bool]:
  1289. invite_content = {}
  1290. if double_puppet:
  1291. invite_content["fi.mau.will_auto_accept"] = True
  1292. if self.is_direct:
  1293. invite_content["is_direct"] = True
  1294. return invite_content
  1295. async def update_matrix_room(
  1296. self, source: u.User, info: Thread, backfill: bool = False
  1297. ) -> None:
  1298. puppet = await p.Puppet.get_by_custom_mxid(source.mxid)
  1299. await self.main_intent.invite_user(
  1300. self.mxid,
  1301. source.mxid,
  1302. check_cache=True,
  1303. extra_content=self._get_invite_content(puppet),
  1304. )
  1305. if puppet:
  1306. did_join = await puppet.intent.ensure_joined(self.mxid)
  1307. if did_join and self.is_direct:
  1308. await source.update_direct_chats({self.main_intent.mxid: [self.mxid]})
  1309. await self.update_info(info, source)
  1310. if backfill:
  1311. last_msg = await DBMessage.get_by_item_id(
  1312. info.last_permanent_item.item_id, receiver=self.receiver
  1313. )
  1314. if last_msg is None:
  1315. self.log.debug(
  1316. f"Last permanent item ({info.last_permanent_item.item_id})"
  1317. " not found in database, starting backfilling"
  1318. )
  1319. await self.backfill(source, is_initial=False)
  1320. await self._update_read_receipts(info.last_seen_at)
  1321. async def _create_matrix_room(self, source: u.User, info: Thread) -> RoomID | None:
  1322. if self.mxid:
  1323. await self.update_matrix_room(source, info)
  1324. return self.mxid
  1325. await self.update_info(info, source)
  1326. self.log.debug("Creating Matrix room")
  1327. name: str | None = None
  1328. initial_state = [
  1329. {
  1330. "type": str(StateBridge),
  1331. "state_key": self.bridge_info_state_key,
  1332. "content": self.bridge_info,
  1333. },
  1334. # TODO remove this once https://github.com/matrix-org/matrix-doc/pull/2346 is in spec
  1335. {
  1336. "type": str(StateHalfShotBridge),
  1337. "state_key": self.bridge_info_state_key,
  1338. "content": self.bridge_info,
  1339. },
  1340. ]
  1341. invites = []
  1342. if self.config["bridge.encryption.default"] and self.matrix.e2ee:
  1343. self.encrypted = True
  1344. initial_state.append(
  1345. {
  1346. "type": "m.room.encryption",
  1347. "content": {"algorithm": "m.megolm.v1.aes-sha2"},
  1348. }
  1349. )
  1350. if self.is_direct:
  1351. invites.append(self.az.bot_mxid)
  1352. if self.encrypted or self.private_chat_portal_meta or not self.is_direct:
  1353. name = self.name
  1354. if self.config["appservice.community_id"]:
  1355. initial_state.append(
  1356. {
  1357. "type": "m.room.related_groups",
  1358. "content": {"groups": [self.config["appservice.community_id"]]},
  1359. }
  1360. )
  1361. # We lock backfill lock here so any messages that come between the room being created
  1362. # and the initial backfill finishing wouldn't be bridged before the backfill messages.
  1363. with self.backfill_lock:
  1364. creation_content = {}
  1365. if not self.config["bridge.federate_rooms"]:
  1366. creation_content["m.federate"] = False
  1367. self.mxid = await self.main_intent.create_room(
  1368. name=name,
  1369. is_direct=self.is_direct,
  1370. initial_state=initial_state,
  1371. invitees=invites,
  1372. creation_content=creation_content,
  1373. )
  1374. if not self.mxid:
  1375. raise Exception("Failed to create room: no mxid returned")
  1376. if self.encrypted and self.matrix.e2ee and self.is_direct:
  1377. try:
  1378. await self.az.intent.ensure_joined(self.mxid)
  1379. except Exception:
  1380. self.log.warning(f"Failed to add bridge bot to new private chat {self.mxid}")
  1381. await self.update()
  1382. self.log.debug(f"Matrix room created: {self.mxid}")
  1383. self.by_mxid[self.mxid] = self
  1384. puppet = await p.Puppet.get_by_custom_mxid(source.mxid)
  1385. await self.main_intent.invite_user(
  1386. self.mxid, source.mxid, extra_content=self._get_invite_content(puppet)
  1387. )
  1388. if puppet:
  1389. try:
  1390. if self.is_direct:
  1391. await source.update_direct_chats({self.main_intent.mxid: [self.mxid]})
  1392. await puppet.intent.join_room_by_id(self.mxid)
  1393. except MatrixError:
  1394. self.log.debug(
  1395. "Failed to join custom puppet into newly created portal", exc_info=True
  1396. )
  1397. await self._update_participants(info.users, source)
  1398. try:
  1399. await self.backfill(source, is_initial=True)
  1400. except Exception:
  1401. self.log.exception("Failed to backfill new portal")
  1402. await self._update_read_receipts(info.last_seen_at)
  1403. return self.mxid
  1404. # endregion
  1405. # region Database getters
  1406. async def postinit(self) -> None:
  1407. self.by_thread_id[(self.thread_id, self.receiver)] = self
  1408. if self.mxid:
  1409. self.by_mxid[self.mxid] = self
  1410. self._main_intent = (
  1411. (await p.Puppet.get_by_pk(self.other_user_pk)).default_mxid_intent
  1412. if self.other_user_pk
  1413. else self.az.intent
  1414. )
  1415. async def delete(self) -> None:
  1416. await DBMessage.delete_all(self.mxid)
  1417. self.by_mxid.pop(self.mxid, None)
  1418. self.mxid = None
  1419. self.encrypted = False
  1420. await self.update()
  1421. async def save(self) -> None:
  1422. await self.update()
  1423. @classmethod
  1424. def all_with_room(cls) -> AsyncGenerator[Portal, None]:
  1425. return cls._db_to_portals(super().all_with_room())
  1426. @classmethod
  1427. def find_private_chats_with(cls, other_user: int) -> AsyncGenerator[Portal, None]:
  1428. return cls._db_to_portals(super().find_private_chats_with(other_user))
  1429. @classmethod
  1430. async def _db_to_portals(cls, query: Awaitable[list[Portal]]) -> AsyncGenerator[Portal, None]:
  1431. portals = await query
  1432. for index, portal in enumerate(portals):
  1433. try:
  1434. yield cls.by_thread_id[(portal.thread_id, portal.receiver)]
  1435. except KeyError:
  1436. await portal.postinit()
  1437. yield portal
  1438. @classmethod
  1439. @async_getter_lock
  1440. async def get_by_mxid(cls, mxid: RoomID) -> Portal | None:
  1441. try:
  1442. return cls.by_mxid[mxid]
  1443. except KeyError:
  1444. pass
  1445. portal = cast(cls, await super().get_by_mxid(mxid))
  1446. if portal is not None:
  1447. await portal.postinit()
  1448. return portal
  1449. return None
  1450. @classmethod
  1451. @async_getter_lock
  1452. async def get_by_thread_id(
  1453. cls,
  1454. thread_id: str,
  1455. *,
  1456. receiver: int,
  1457. is_group: bool | None = None,
  1458. other_user_pk: int | None = None,
  1459. ) -> Portal | None:
  1460. if is_group and receiver != 0:
  1461. receiver = 0
  1462. try:
  1463. return cls.by_thread_id[(thread_id, receiver)]
  1464. except KeyError:
  1465. pass
  1466. if is_group is None and receiver != 0:
  1467. try:
  1468. return cls.by_thread_id[(thread_id, 0)]
  1469. except KeyError:
  1470. pass
  1471. portal = cast(
  1472. cls,
  1473. await super().get_by_thread_id(
  1474. thread_id, receiver=receiver, rec_must_match=is_group is not None
  1475. ),
  1476. )
  1477. if portal is not None:
  1478. await portal.postinit()
  1479. return portal
  1480. if is_group is not None:
  1481. portal = cls(thread_id, receiver, other_user_pk=other_user_pk)
  1482. await portal.insert()
  1483. await portal.postinit()
  1484. return portal
  1485. return None
  1486. @classmethod
  1487. async def get_by_thread(cls, thread: Thread, receiver: int) -> Portal | None:
  1488. if thread.is_group:
  1489. receiver = 0
  1490. other_user_pk = None
  1491. else:
  1492. if len(thread.users) == 0:
  1493. other_user_pk = receiver
  1494. else:
  1495. other_user_pk = thread.users[0].pk
  1496. return await cls.get_by_thread_id(
  1497. thread.thread_id,
  1498. receiver=receiver,
  1499. is_group=thread.is_group,
  1500. other_user_pk=other_user_pk,
  1501. )
  1502. # endregion