portal.py 62 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602
  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 not in ("image/jpeg", "image/webp"):
  265. with BytesIO(data) as inp, BytesIO() as out:
  266. img = Image.open(inp)
  267. img.convert("RGBA").save(out, format="WEBP")
  268. data = out.getvalue()
  269. mime_type = "image/webp"
  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="1",
  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. request_id = sender.state.gen_client_context()
  346. self._reqid_dedup.add(request_id)
  347. self.log.debug(
  348. f"Handling Matrix message {event_id} from {sender.mxid}/{sender.igpk} "
  349. f"with request ID {request_id}"
  350. )
  351. if message.msgtype in (MessageType.EMOTE, MessageType.TEXT, MessageType.NOTICE):
  352. text = message.body
  353. if message.msgtype == MessageType.EMOTE:
  354. text = f"/me {text}"
  355. self.log.trace(f"Sending Matrix text from {event_id} with request ID {request_id}")
  356. resp = await sender.mqtt.send_text(
  357. self.thread_id, text=text, client_context=request_id
  358. )
  359. elif message.msgtype.is_media:
  360. if message.file and decrypt_attachment:
  361. data = await self.main_intent.download_media(message.file.url)
  362. data = decrypt_attachment(
  363. data, message.file.key.key, message.file.hashes.get("sha256"), message.file.iv
  364. )
  365. else:
  366. data = await self.main_intent.download_media(message.url)
  367. mime_type = message.info.mimetype or magic.from_buffer(data, mime=True)
  368. if message.msgtype == MessageType.IMAGE:
  369. resp = await self._handle_matrix_image(
  370. sender,
  371. event_id,
  372. request_id,
  373. data,
  374. mime_type,
  375. width=message.info.width,
  376. height=message.info.height,
  377. )
  378. elif message.msgtype == MessageType.AUDIO:
  379. waveform = message.get("org.matrix.msc1767.audio", {}).get("waveform", [0] * 30)
  380. resp = await self._handle_matrix_audio(
  381. sender,
  382. event_id,
  383. request_id,
  384. data,
  385. mime_type,
  386. waveform,
  387. duration=message.info.duration,
  388. )
  389. elif message.msgtype == MessageType.VIDEO:
  390. resp = await self._handle_matrix_video(
  391. sender,
  392. event_id,
  393. request_id,
  394. data,
  395. mime_type,
  396. duration=message.info.duration,
  397. width=message.info.width,
  398. height=message.info.height,
  399. )
  400. else:
  401. raise NotImplementedError(
  402. "Non-image/video/audio files are currently not supported"
  403. )
  404. else:
  405. raise NotImplementedError(f"Unknown message type {message.msgtype}")
  406. self.log.trace(f"Got response to message send {request_id}: {resp}")
  407. if resp.status != "ok":
  408. self.log.warning(f"Failed to handle {event_id}: {resp}")
  409. raise Exception(f"Failed to handle event. Error: {resp.payload.message}")
  410. else:
  411. sender.send_remote_checkpoint(
  412. status=MessageSendCheckpointStatus.SUCCESS,
  413. event_id=event_id,
  414. room_id=self.mxid,
  415. event_type=EventType.ROOM_MESSAGE,
  416. message_type=message.msgtype,
  417. )
  418. await self._send_delivery_receipt(event_id)
  419. self._msgid_dedup.appendleft(resp.payload.item_id)
  420. try:
  421. await DBMessage(
  422. mxid=event_id,
  423. mx_room=self.mxid,
  424. item_id=resp.payload.item_id,
  425. receiver=self.receiver,
  426. sender=sender.igpk,
  427. ).insert()
  428. except asyncpg.UniqueViolationError as e:
  429. self.log.warning(
  430. f"Error while persisting {event_id} ({resp.payload.client_context}) "
  431. f"-> {resp.payload.item_id}: {e}"
  432. )
  433. self._reqid_dedup.remove(request_id)
  434. self.log.debug(
  435. f"Handled Matrix message {event_id} ({resp.payload.client_context}) "
  436. f"-> {resp.payload.item_id}"
  437. )
  438. async def handle_matrix_reaction(
  439. self, sender: u.User, event_id: EventID, reacting_to: EventID, emoji: str
  440. ) -> None:
  441. try:
  442. await self._handle_matrix_reaction(sender, event_id, reacting_to, emoji)
  443. except Exception as e:
  444. self.log.exception(f"Fatal error handling Matrix event {event_id}: {e}")
  445. await self._send_bridge_error(
  446. sender,
  447. e,
  448. event_id,
  449. EventType.REACTION,
  450. status=self._status_from_exception(e),
  451. confirmed=True,
  452. msg="Fatal error handling reaction (see logs for more details)",
  453. )
  454. async def _handle_matrix_reaction(
  455. self, sender: u.User, event_id: EventID, reacting_to: EventID, emoji: str
  456. ) -> None:
  457. message = await DBMessage.get_by_mxid(reacting_to, self.mxid)
  458. if not message or message.is_internal:
  459. self.log.debug(f"Ignoring reaction to unknown event {reacting_to}")
  460. return
  461. if not await sender.is_logged_in():
  462. self.log.debug(f"Ignoring reaction by non-logged-in user {sender.mxid}")
  463. return
  464. existing = await DBReaction.get_by_item_id(message.item_id, message.receiver, sender.igpk)
  465. if existing and existing.reaction == emoji:
  466. sender.send_remote_checkpoint(
  467. status=MessageSendCheckpointStatus.SUCCESS,
  468. event_id=event_id,
  469. room_id=self.mxid,
  470. event_type=EventType.REACTION,
  471. )
  472. return
  473. dedup_id = (message.item_id, sender.igpk, emoji)
  474. self._reaction_dedup.appendleft(dedup_id)
  475. async with self._reaction_lock:
  476. try:
  477. resp = await sender.mqtt.send_reaction(
  478. self.thread_id, item_id=message.item_id, emoji=emoji
  479. )
  480. if resp.status != "ok":
  481. raise Exception(f"Failed to react to {event_id}: {resp}")
  482. except Exception as e:
  483. self.log.exception(f"Failed to handle {event_id}: {e}")
  484. raise
  485. else:
  486. sender.send_remote_checkpoint(
  487. status=MessageSendCheckpointStatus.SUCCESS,
  488. event_id=event_id,
  489. room_id=self.mxid,
  490. event_type=EventType.REACTION,
  491. )
  492. await self._send_delivery_receipt(event_id)
  493. self.log.trace(f"{sender.mxid} reacted to {message.item_id} with {emoji}")
  494. await self._upsert_reaction(
  495. existing, self.main_intent, event_id, message, sender, emoji
  496. )
  497. async def handle_matrix_redaction(
  498. self, orig_sender: u.User, event_id: EventID, redaction_event_id: EventID
  499. ) -> None:
  500. sender = None
  501. try:
  502. sender, _ = await self.get_relay_sender(orig_sender, f"redaction {event_id}")
  503. if not sender:
  504. raise Exception("User is not logged in")
  505. await self._handle_matrix_redaction(sender, event_id, redaction_event_id)
  506. except Exception as e:
  507. self.log.exception(f"Fatal error handling Matrix event {event_id}: {e}")
  508. await self._send_bridge_error(
  509. sender or orig_sender,
  510. e,
  511. redaction_event_id,
  512. EventType.ROOM_REDACTION,
  513. status=self._status_from_exception(e),
  514. confirmed=True,
  515. )
  516. async def _handle_matrix_redaction(
  517. self, sender: u.User, event_id: EventID, redaction_event_id: EventID
  518. ) -> None:
  519. if not sender.is_connected:
  520. raise Exception("You're not connected to Instagram")
  521. reaction = await DBReaction.get_by_mxid(event_id, self.mxid)
  522. if reaction:
  523. try:
  524. await reaction.delete()
  525. await sender.mqtt.send_reaction(
  526. self.thread_id,
  527. item_id=reaction.ig_item_id,
  528. reaction_status=ReactionStatus.DELETED,
  529. emoji="",
  530. )
  531. except Exception as e:
  532. raise Exception(f"Removing reaction failed: {e}")
  533. else:
  534. sender.send_remote_checkpoint(
  535. status=MessageSendCheckpointStatus.SUCCESS,
  536. event_id=redaction_event_id,
  537. room_id=self.mxid,
  538. event_type=EventType.ROOM_REDACTION,
  539. )
  540. await self._send_delivery_receipt(redaction_event_id)
  541. self.log.trace(f"Removed {reaction} after Matrix redaction")
  542. return
  543. message = await DBMessage.get_by_mxid(event_id, self.mxid)
  544. if message and not message.is_internal:
  545. try:
  546. await message.delete()
  547. await sender.client.delete_item(self.thread_id, message.item_id)
  548. self.log.trace(f"Removed {message} after Matrix redaction")
  549. except Exception as e:
  550. raise Exception(f"Removing message failed: {e}")
  551. else:
  552. sender.send_remote_checkpoint(
  553. status=MessageSendCheckpointStatus.SUCCESS,
  554. event_id=redaction_event_id,
  555. room_id=self.mxid,
  556. event_type=EventType.ROOM_REDACTION,
  557. )
  558. await self._send_delivery_receipt(redaction_event_id)
  559. self.log.trace(f"Removed {reaction} after Matrix redaction")
  560. return
  561. raise Exception("No message or reaction found for redaction")
  562. async def handle_matrix_typing(self, users: set[UserID]) -> None:
  563. if users == self._typing:
  564. return
  565. old_typing = self._typing
  566. self._typing = users
  567. await self._handle_matrix_typing(old_typing - users, TypingStatus.OFF)
  568. await self._handle_matrix_typing(users - old_typing, TypingStatus.TEXT)
  569. async def _handle_matrix_typing(self, users: set[UserID], status: TypingStatus) -> None:
  570. for mxid in users:
  571. user = await u.User.get_by_mxid(mxid, create=False)
  572. if (
  573. not user
  574. or not await user.is_logged_in()
  575. or user.remote_typing_status == status
  576. or not user.is_connected
  577. ):
  578. continue
  579. user.remote_typing_status = None
  580. await user.mqtt.indicate_activity(self.thread_id, status)
  581. async def handle_matrix_leave(self, user: u.User) -> None:
  582. if not await user.is_logged_in():
  583. return
  584. if self.is_direct:
  585. self.log.info(f"{user.mxid} left private chat portal with {self.other_user_pk}")
  586. if user.igpk == self.receiver:
  587. self.log.info(
  588. f"{user.mxid} was the recipient of this portal. Cleaning up and deleting..."
  589. )
  590. await self.cleanup_and_delete()
  591. else:
  592. self.log.debug(f"{user.mxid} left portal to {self.thread_id}")
  593. # TODO cleanup if empty
  594. # endregion
  595. # region Instagram event handling
  596. async def _reupload_instagram_media(
  597. self, source: u.User, media: RegularMediaItem, intent: IntentAPI
  598. ) -> MediaMessageEventContent:
  599. if media.media_type == MediaType.IMAGE:
  600. image = media.best_image
  601. if not image:
  602. raise ValueError("Attachment not available: didn't find photo URL")
  603. url = image.url
  604. msgtype = MessageType.IMAGE
  605. info = ImageInfo(height=image.height, width=image.width)
  606. elif media.media_type == MediaType.VIDEO:
  607. video = media.best_video
  608. if not video:
  609. raise ValueError("Attachment not available: didn't find video URL")
  610. url = video.url
  611. msgtype = MessageType.VIDEO
  612. info = VideoInfo(height=video.height, width=video.width)
  613. else:
  614. raise ValueError("Attachment not available: unsupported media type")
  615. return await self._reupload_instagram_file(source, url, msgtype, info, intent)
  616. async def _reupload_instagram_animated(
  617. self, source: u.User, media: AnimatedMediaItem, intent: IntentAPI
  618. ) -> MediaMessageEventContent:
  619. url = media.images.fixed_height.webp
  620. info = ImageInfo(
  621. height=int(media.images.fixed_height.height),
  622. width=int(media.images.fixed_height.width),
  623. )
  624. return await self._reupload_instagram_file(source, url, MessageType.IMAGE, info, intent)
  625. async def _reupload_instagram_voice(
  626. self, source: u.User, media: VoiceMediaItem, intent: IntentAPI
  627. ) -> MediaMessageEventContent:
  628. async def convert_to_ogg(data, mimetype):
  629. converted = await ffmpeg.convert_bytes(
  630. data, ".ogg", output_args=("-c:a", "libvorbis"), input_mime=mimetype
  631. )
  632. return converted, "audio/ogg"
  633. url = media.media.audio.audio_src
  634. info = AudioInfo(duration=media.media.audio.duration)
  635. waveform = [int(p * 1024) for p in media.media.audio.waveform_data]
  636. content = await self._reupload_instagram_file(
  637. source, url, MessageType.AUDIO, info, intent, convert_to_ogg
  638. )
  639. content["org.matrix.msc1767.audio"] = {
  640. "duration": media.media.audio.duration,
  641. "waveform": waveform,
  642. }
  643. content["org.matrix.msc3245.voice"] = {}
  644. return content
  645. async def _reupload_instagram_file(
  646. self,
  647. source: u.User,
  648. url: str,
  649. msgtype: MessageType,
  650. info: ImageInfo | VideoInfo | AudioInfo,
  651. intent: IntentAPI,
  652. convert_fn: Callable[[bytes, str], Awaitable[tuple[bytes, str]]] | None = None,
  653. ) -> MediaMessageEventContent:
  654. async with source.client.raw_http_get(url) as resp:
  655. try:
  656. length = int(resp.headers["Content-Length"])
  657. except KeyError:
  658. # TODO can the download be short-circuited if there's too much data?
  659. self.log.warning(
  660. "Got file download response with no Content-Length header,"
  661. "reading data dangerously"
  662. )
  663. length = 0
  664. if length > self.matrix.media_config.upload_size:
  665. self.log.debug(
  666. f"{url} was too large ({length} > {self.matrix.media_config.upload_size})"
  667. )
  668. raise ValueError("Attachment not available: too large")
  669. data = await resp.read()
  670. info.mimetype = resp.headers["Content-Type"] or magic.from_buffer(data, mime=True)
  671. # Run the conversion function on the data.
  672. if convert_fn is not None:
  673. data, info.mimetype = await convert_fn(data, info.mimetype)
  674. info.size = len(data)
  675. extension = {
  676. "image/webp": ".webp",
  677. "image/jpeg": ".jpg",
  678. "video/mp4": ".mp4",
  679. "audio/mp4": ".m4a",
  680. "audio/ogg": ".ogg",
  681. }.get(info.mimetype)
  682. extension = extension or mimetypes.guess_extension(info.mimetype) or ""
  683. file_name = f"{msgtype.value[2:]}{extension}"
  684. upload_mime_type = info.mimetype
  685. upload_file_name = file_name
  686. decryption_info = None
  687. if self.encrypted and encrypt_attachment:
  688. data, decryption_info = encrypt_attachment(data)
  689. upload_mime_type = "application/octet-stream"
  690. upload_file_name = None
  691. mxc = await intent.upload_media(
  692. data, mime_type=upload_mime_type, filename=upload_file_name
  693. )
  694. if decryption_info:
  695. decryption_info.url = mxc
  696. mxc = None
  697. return MediaMessageEventContent(
  698. body=file_name,
  699. external_url=url,
  700. url=mxc,
  701. file=decryption_info,
  702. info=info,
  703. msgtype=msgtype,
  704. )
  705. def _get_instagram_media_info(self, item: ThreadItem) -> tuple[MediaUploadFunc, MediaData]:
  706. # TODO maybe use a dict and item.item_type instead of a ton of ifs
  707. method = self._reupload_instagram_media
  708. if item.media:
  709. media_data = item.media
  710. elif item.visual_media:
  711. media_data = item.visual_media.media
  712. elif item.animated_media:
  713. media_data = item.animated_media
  714. method = self._reupload_instagram_animated
  715. elif item.voice_media:
  716. media_data = item.voice_media
  717. method = self._reupload_instagram_voice
  718. elif item.reel_share:
  719. media_data = item.reel_share.media
  720. elif item.story_share:
  721. media_data = item.story_share.media
  722. elif item.clip:
  723. media_data = item.clip.clip
  724. elif item.felix_share and item.felix_share.video:
  725. media_data = item.felix_share.video
  726. elif item.media_share:
  727. media_data = item.media_share
  728. else:
  729. self.log.debug(f"Unknown media type in {item}")
  730. raise ValueError("Attachment not available: unsupported media type")
  731. if not media_data:
  732. self.log.debug(f"Didn't get media_data in {item}")
  733. raise ValueError("Attachment not available: unsupported media type")
  734. elif isinstance(media_data, ExpiredMediaItem):
  735. self.log.debug(f"Expired media in item {item}")
  736. raise ValueError("Attachment not available: media expired")
  737. return method, media_data
  738. async def _handle_instagram_media(
  739. self, source: u.User, intent: IntentAPI, item: ThreadItem
  740. ) -> EventID | None:
  741. try:
  742. reupload_func, media_data = self._get_instagram_media_info(item)
  743. content = await reupload_func(source, media_data, intent)
  744. except ValueError as e:
  745. content = TextMessageEventContent(body=str(e), msgtype=MessageType.NOTICE)
  746. except Exception:
  747. self.log.warning("Failed to upload media", exc_info=True)
  748. content = TextMessageEventContent(
  749. body="Attachment not available: failed to copy file", msgtype=MessageType.NOTICE
  750. )
  751. await self._add_instagram_reply(content, item.replied_to_message)
  752. return await self._send_message(intent, content, timestamp=item.timestamp // 1000)
  753. async def _handle_instagram_media_share(
  754. self, source: u.User, intent: IntentAPI, item: ThreadItem
  755. ) -> EventID | None:
  756. if item.media_share:
  757. share_item = item.media_share
  758. item_type_name = share_item.media_type.human_name
  759. elif item.clip:
  760. share_item = item.clip.clip
  761. item_type_name = "clip"
  762. elif item.felix_share and item.felix_share.video:
  763. share_item = item.felix_share.video
  764. item_type_name = share_item.media_type.human_name
  765. elif item.story_share:
  766. share_item = item.story_share.media
  767. item_type_name = "story"
  768. else:
  769. return None
  770. user_text = f"@{share_item.user.username}"
  771. user_link = (
  772. f'<a href="https://www.instagram.com/{share_item.user.username}/">' f"{user_text}</a>"
  773. )
  774. prefix = TextMessageEventContent(
  775. msgtype=MessageType.NOTICE,
  776. format=Format.HTML,
  777. body=f"Sent {user_text}'s {item_type_name}",
  778. formatted_body=f"Sent {user_link}'s {item_type_name}",
  779. )
  780. await self._send_message(intent, prefix, timestamp=item.timestamp // 1000)
  781. event_id = await self._handle_instagram_media(source, intent, item)
  782. if share_item.caption:
  783. external_url = f"https://www.instagram.com/p/{share_item.code}/"
  784. body = (
  785. f"> {share_item.caption.user.username}: {share_item.caption.text}\n\n"
  786. f"{external_url}"
  787. )
  788. formatted_body = (
  789. f"<blockquote><strong>{share_item.caption.user.username}</strong>"
  790. f" {share_item.caption.text}</blockquote>"
  791. f'<a href="{external_url}">instagram.com/p/{share_item.code}</a>'
  792. )
  793. caption = TextMessageEventContent(
  794. msgtype=MessageType.TEXT,
  795. body=body,
  796. formatted_body=formatted_body,
  797. format=Format.HTML,
  798. external_url=external_url,
  799. )
  800. await self._send_message(intent, caption, timestamp=item.timestamp // 1000)
  801. return event_id
  802. async def _handle_instagram_reel_share(
  803. self, source: u.User, intent: IntentAPI, item: ThreadItem
  804. ) -> EventID | None:
  805. media = item.reel_share.media
  806. prefix_html = None
  807. if item.reel_share.type == ReelShareType.REPLY:
  808. if item.reel_share.reel_owner_id == source.igpk:
  809. prefix = "Replied to your story"
  810. else:
  811. username = media.user.username
  812. prefix = f"Sent @{username}'s story"
  813. user_link = f'<a href="https://www.instagram.com/{username}/">@{username}</a>'
  814. prefix_html = f"Sent {user_link}'s story"
  815. elif item.reel_share.type == ReelShareType.REACTION:
  816. prefix = "Reacted to your story"
  817. elif item.reel_share.type == ReelShareType.MENTION:
  818. if item.reel_share.mentioned_user_id == source.igpk:
  819. prefix = "Mentioned you in their story"
  820. else:
  821. prefix = "You mentioned them in your story"
  822. else:
  823. self.log.debug(f"Unsupported reel share type {item.reel_share.type}")
  824. return None
  825. prefix_content = TextMessageEventContent(msgtype=MessageType.NOTICE, body=prefix)
  826. if prefix_html:
  827. prefix_content.format = Format.HTML
  828. prefix_content.formatted_body = prefix_html
  829. content = TextMessageEventContent(msgtype=MessageType.TEXT, body=item.reel_share.text)
  830. if not content.body and isinstance(media, MediaShareItem):
  831. content.body = media.caption.text if media.caption else ""
  832. if not content.body:
  833. content.body = "<no caption>"
  834. await self._send_message(intent, prefix_content, timestamp=item.timestamp // 1000)
  835. if isinstance(media, ExpiredMediaItem):
  836. # TODO send message about expired story
  837. pass
  838. else:
  839. fake_item_id = f"fi.mau.instagram.reel_share.{item.user_id}.{media.pk}"
  840. existing = await DBMessage.get_by_item_id(fake_item_id, self.receiver)
  841. if existing:
  842. # If the user already reacted or replied to the same reel share item,
  843. # use a Matrix reply instead of reposting the image.
  844. content.set_reply(existing.mxid)
  845. else:
  846. media_event_id = await self._handle_instagram_media(source, intent, item)
  847. await DBMessage(
  848. mxid=media_event_id,
  849. mx_room=self.mxid,
  850. item_id=fake_item_id,
  851. receiver=self.receiver,
  852. sender=media.user.pk,
  853. ).insert()
  854. return await self._send_message(intent, content, timestamp=item.timestamp // 1000)
  855. async def _handle_instagram_text(
  856. self, intent: IntentAPI, item: ThreadItem, text: str
  857. ) -> EventID:
  858. content = TextMessageEventContent(msgtype=MessageType.TEXT, body=text)
  859. await self._add_instagram_reply(content, item.replied_to_message)
  860. return await self._send_message(intent, content, timestamp=item.timestamp // 1000)
  861. async def _send_instagram_unhandled(self, intent: IntentAPI, item: ThreadItem) -> EventID:
  862. content = TextMessageEventContent(
  863. msgtype=MessageType.NOTICE, body=f"Unsupported message type {item.item_type.value}"
  864. )
  865. await self._add_instagram_reply(content, item.replied_to_message)
  866. return await self._send_message(intent, content, timestamp=item.timestamp // 1000)
  867. async def _handle_instagram_location(
  868. self, intent: IntentAPI, item: ThreadItem
  869. ) -> EventID | None:
  870. loc = item.location
  871. if not loc.lng or not loc.lat:
  872. # TODO handle somehow
  873. return None
  874. long_char = "E" if loc.lng > 0 else "W"
  875. lat_char = "N" if loc.lat > 0 else "S"
  876. body = (
  877. f"{loc.name} - {round(abs(loc.lat), 4)}° {lat_char}, "
  878. f"{round(abs(loc.lng), 4)}° {long_char}"
  879. )
  880. url = f"https://www.openstreetmap.org/#map=15/{loc.lat}/{loc.lng}"
  881. external_url = None
  882. if loc.external_source == "facebook_places":
  883. external_url = f"https://www.facebook.com/{loc.short_name}-{loc.facebook_places_id}"
  884. content = LocationMessageEventContent(
  885. msgtype=MessageType.LOCATION,
  886. geo_uri=f"geo:{loc.lat},{loc.lng}",
  887. body=f"Location: {body}\n{url}",
  888. external_url=external_url,
  889. )
  890. content["format"] = str(Format.HTML)
  891. content["formatted_body"] = f"Location: <a href='{url}'>{body}</a>"
  892. await self._add_instagram_reply(content, item.replied_to_message)
  893. return await self._send_message(intent, content, timestamp=item.timestamp // 1000)
  894. async def _handle_instagram_profile(
  895. self, intent: IntentAPI, item: ThreadItem
  896. ) -> EventID | None:
  897. username = item.profile.username
  898. user_link = f'<a href="https://www.instagram.com/{username}/">@{username}</a>'
  899. text = f"Shared @{username}'s profile"
  900. html = f"Shared {user_link}'s profile"
  901. content = TextMessageEventContent(
  902. msgtype=MessageType.TEXT, format=Format.HTML, body=text, formatted_body=html
  903. )
  904. await self._add_instagram_reply(content, item.replied_to_message)
  905. return await self._send_message(intent, content, timestamp=item.timestamp // 1000)
  906. async def handle_instagram_item(
  907. self, source: u.User, sender: p.Puppet, item: ThreadItem, is_backfill: bool = False
  908. ) -> None:
  909. try:
  910. await self._handle_instagram_item(source, sender, item, is_backfill)
  911. except Exception:
  912. self.log.exception("Fatal error handling Instagram item")
  913. self.log.trace("Item content: %s", item.serialize())
  914. async def _add_instagram_reply(
  915. self, content: MessageEventContent, reply_to: ThreadItem | None
  916. ) -> None:
  917. if not reply_to:
  918. return
  919. message = await DBMessage.get_by_item_id(reply_to.item_id, self.receiver)
  920. if not message:
  921. return
  922. content.set_reply(message.mxid)
  923. if not isinstance(content, TextMessageEventContent):
  924. return
  925. try:
  926. evt = await self.main_intent.get_event(message.mx_room, message.mxid)
  927. except (MNotFound, MForbidden):
  928. evt = None
  929. if not evt:
  930. return
  931. if evt.type == EventType.ROOM_ENCRYPTED:
  932. try:
  933. evt = await self.matrix.e2ee.decrypt(evt, wait_session_timeout=0)
  934. except SessionNotFound:
  935. return
  936. if isinstance(evt.content, TextMessageEventContent):
  937. evt.content.trim_reply_fallback()
  938. content.set_reply(evt)
  939. async def _handle_instagram_item(
  940. self, source: u.User, sender: p.Puppet, item: ThreadItem, is_backfill: bool = False
  941. ) -> None:
  942. if not isinstance(item, ThreadItem):
  943. # Parsing these items failed, they should have been logged already
  944. return
  945. elif item.client_context in self._reqid_dedup:
  946. self.log.debug(
  947. f"Ignoring message {item.item_id} ({item.client_context}) by "
  948. f"{item.user_id} as it was sent by us (client_context in dedup queue)"
  949. )
  950. elif item.item_id in self._msgid_dedup:
  951. self.log.debug(
  952. f"Ignoring message {item.item_id} ({item.client_context}) by "
  953. f"{item.user_id} as it was already handled (message.id in dedup queue)"
  954. )
  955. elif await DBMessage.get_by_item_id(item.item_id, self.receiver) is not None:
  956. self.log.debug(
  957. f"Ignoring message {item.item_id} ({item.client_context}) by "
  958. f"{item.user_id} as it was already handled (message.id in database)"
  959. )
  960. else:
  961. self.log.debug(
  962. f"Starting handling of message {item.item_id} ({item.client_context}) "
  963. f"by {item.user_id}"
  964. )
  965. self._msgid_dedup.appendleft(item.item_id)
  966. if self.backfill_lock.locked and sender.need_backfill_invite(self):
  967. self.log.debug("Adding %s's default puppet to room for backfilling", sender.mxid)
  968. if self.is_direct:
  969. await self.main_intent.invite_user(self.mxid, sender.default_mxid)
  970. intent = sender.default_mxid_intent
  971. await intent.ensure_joined(self.mxid)
  972. self._backfill_leave.add(intent)
  973. else:
  974. intent = sender.intent_for(self)
  975. event_id = None
  976. if item.media or item.animated_media or item.voice_media or item.visual_media:
  977. event_id = await self._handle_instagram_media(source, intent, item)
  978. elif item.location:
  979. event_id = await self._handle_instagram_location(intent, item)
  980. elif item.profile:
  981. event_id = await self._handle_instagram_profile(intent, item)
  982. elif item.reel_share:
  983. event_id = await self._handle_instagram_reel_share(source, intent, item)
  984. elif item.media_share or item.story_share or item.clip or item.felix_share:
  985. event_id = await self._handle_instagram_media_share(source, intent, item)
  986. elif item.action_log:
  987. # These probably don't need to be bridged
  988. self.log.debug(f"Ignoring action log message {item.item_id}")
  989. return
  990. # TODO handle item.clip?
  991. if item.text:
  992. event_id = await self._handle_instagram_text(intent, item, item.text)
  993. elif item.like:
  994. # We handle likes as text because Matrix clients do big emoji on their own.
  995. event_id = await self._handle_instagram_text(intent, item, item.like)
  996. elif item.link:
  997. event_id = await self._handle_instagram_text(intent, item, item.link.text)
  998. handled = bool(event_id)
  999. if not event_id:
  1000. self.log.debug(f"Unhandled Instagram message {item.item_id}")
  1001. event_id = await self._send_instagram_unhandled(intent, item)
  1002. msg = DBMessage(
  1003. mxid=event_id,
  1004. mx_room=self.mxid,
  1005. item_id=item.item_id,
  1006. receiver=self.receiver,
  1007. sender=sender.pk,
  1008. )
  1009. await msg.insert()
  1010. await self._send_delivery_receipt(event_id)
  1011. if handled:
  1012. self.log.debug(f"Handled Instagram message {item.item_id} -> {event_id}")
  1013. else:
  1014. self.log.debug(
  1015. f"Unhandled Instagram message {item.item_id} "
  1016. f"(type {item.item_type} -> fallback error {event_id})"
  1017. )
  1018. if is_backfill and item.reactions:
  1019. await self._handle_instagram_reactions(msg, item.reactions.emojis)
  1020. async def handle_instagram_remove(self, item_id: str) -> None:
  1021. message = await DBMessage.get_by_item_id(item_id, self.receiver)
  1022. if message is None:
  1023. return
  1024. await message.delete()
  1025. sender = await p.Puppet.get_by_pk(message.sender)
  1026. try:
  1027. await sender.intent_for(self).redact(self.mxid, message.mxid)
  1028. except MForbidden:
  1029. await self.main_intent.redact(self.mxid, message.mxid)
  1030. self.log.debug(f"Redacted {message.mxid} after Instagram unsend")
  1031. async def _handle_instagram_reactions(
  1032. self, message: DBMessage, reactions: list[Reaction]
  1033. ) -> None:
  1034. old_reactions: dict[int, DBReaction]
  1035. old_reactions = {
  1036. reaction.ig_sender: reaction
  1037. for reaction in await DBReaction.get_all_by_item_id(message.item_id, self.receiver)
  1038. }
  1039. for new_reaction in reactions:
  1040. old_reaction = old_reactions.pop(new_reaction.sender_id, None)
  1041. if old_reaction and old_reaction.reaction == new_reaction.emoji:
  1042. continue
  1043. puppet = await p.Puppet.get_by_pk(new_reaction.sender_id)
  1044. intent = puppet.intent_for(self)
  1045. reaction_event_id = await intent.react(self.mxid, message.mxid, new_reaction.emoji)
  1046. await self._upsert_reaction(
  1047. old_reaction, intent, reaction_event_id, message, puppet, new_reaction.emoji
  1048. )
  1049. for old_reaction in old_reactions.values():
  1050. await old_reaction.delete()
  1051. puppet = await p.Puppet.get_by_pk(old_reaction.ig_sender)
  1052. await puppet.intent_for(self).redact(self.mxid, old_reaction.mxid)
  1053. async def handle_instagram_update(self, item: MessageSyncMessage) -> None:
  1054. message = await DBMessage.get_by_item_id(item.item_id, self.receiver)
  1055. if not message:
  1056. return
  1057. if item.has_seen:
  1058. puppet = await p.Puppet.get_by_pk(item.has_seen, create=False)
  1059. if puppet:
  1060. await puppet.intent_for(self).mark_read(self.mxid, message.mxid)
  1061. else:
  1062. async with self._reaction_lock:
  1063. await self._handle_instagram_reactions(
  1064. message, (item.reactions.emojis if item.reactions else [])
  1065. )
  1066. # endregion
  1067. # region Updating portal info
  1068. def _get_thread_name(self, thread: Thread) -> str:
  1069. if self.is_direct:
  1070. if self.other_user_pk == thread.viewer_id and len(thread.users) == 0:
  1071. return "Instagram chat with yourself"
  1072. elif len(thread.users) == 1:
  1073. tpl = self.config["bridge.private_chat_name_template"]
  1074. ui = thread.users[0]
  1075. return tpl.format(displayname=ui.full_name, id=ui.pk, username=ui.username)
  1076. pass
  1077. elif thread.thread_title:
  1078. return self.config["bridge.group_chat_name_template"].format(name=thread.thread_title)
  1079. else:
  1080. return ""
  1081. async def update_info(self, thread: Thread, source: u.User) -> None:
  1082. changed = await self._update_name(self._get_thread_name(thread))
  1083. changed = await self._update_participants(thread.users, source) or changed
  1084. if changed:
  1085. await self.update_bridge_info()
  1086. await self.update()
  1087. # TODO update power levels with thread.admin_user_ids
  1088. async def _update_name(self, name: str) -> bool:
  1089. if name and (self.name != name or not self.name_set):
  1090. self.name = name
  1091. if self.mxid:
  1092. try:
  1093. await self.main_intent.set_room_name(self.mxid, name)
  1094. self.name_set = True
  1095. except Exception:
  1096. self.log.exception("Failed to update name")
  1097. self.name_set = False
  1098. return True
  1099. return False
  1100. async def _update_photo_from_puppet(self, puppet: p.Puppet) -> bool:
  1101. if not self.private_chat_portal_meta and not self.encrypted:
  1102. return False
  1103. if self.avatar_set and self.avatar_url == puppet.photo_mxc:
  1104. return False
  1105. self.avatar_url = puppet.photo_mxc
  1106. if self.mxid:
  1107. try:
  1108. await self.main_intent.set_room_avatar(self.mxid, puppet.photo_mxc)
  1109. self.avatar_set = True
  1110. except Exception:
  1111. self.log.exception("Failed to set room avatar")
  1112. self.avatar_set = False
  1113. return True
  1114. async def _update_participants(self, users: list[ThreadUser], source: u.User) -> bool:
  1115. meta_changed = False
  1116. # Make sure puppets who should be here are here
  1117. for user in users:
  1118. puppet = await p.Puppet.get_by_pk(user.pk)
  1119. await puppet.update_info(user, source)
  1120. if self.mxid:
  1121. await puppet.intent_for(self).ensure_joined(self.mxid)
  1122. if puppet.pk == self.other_user_pk:
  1123. meta_changed = await self._update_photo_from_puppet(puppet)
  1124. if self.mxid:
  1125. # Kick puppets who shouldn't be here
  1126. current_members = {int(user.pk) for user in users}
  1127. for user_id in await self.main_intent.get_room_members(self.mxid):
  1128. pk = p.Puppet.get_id_from_mxid(user_id)
  1129. if pk and pk not in current_members and pk != self.other_user_pk:
  1130. await self.main_intent.kick_user(
  1131. self.mxid,
  1132. p.Puppet.get_mxid_from_id(pk),
  1133. reason="User had left this Instagram DM",
  1134. )
  1135. return meta_changed
  1136. async def _update_read_receipts(self, receipts: dict[int | str, ThreadUserLastSeenAt]) -> None:
  1137. for user_id, receipt in receipts.items():
  1138. message = await DBMessage.get_by_item_id(receipt.item_id, self.receiver)
  1139. if not message:
  1140. continue
  1141. puppet = await p.Puppet.get_by_pk(int(user_id), create=False)
  1142. if not puppet:
  1143. continue
  1144. try:
  1145. await puppet.intent_for(self).mark_read(message.mx_room, message.mxid)
  1146. except Exception:
  1147. self.log.warning(
  1148. f"Failed to mark {message.mxid} in {message.mx_room} "
  1149. f"as read by {puppet.intent.mxid}",
  1150. exc_info=True,
  1151. )
  1152. # endregion
  1153. # region Backfilling
  1154. async def backfill(self, source: u.User, is_initial: bool = False) -> None:
  1155. limit = (
  1156. self.config["bridge.backfill.initial_limit"]
  1157. if is_initial
  1158. else self.config["bridge.backfill.missed_limit"]
  1159. )
  1160. if limit == 0:
  1161. return
  1162. elif limit < 0:
  1163. limit = None
  1164. with self.backfill_lock:
  1165. await self._backfill(source, is_initial, limit)
  1166. async def _backfill(self, source: u.User, is_initial: bool, limit: int) -> None:
  1167. self.log.debug("Backfilling history through %s", source.mxid)
  1168. entries = await self._fetch_backfill_items(source, is_initial, limit)
  1169. if not entries:
  1170. self.log.debug("Didn't get any items to backfill from server")
  1171. return
  1172. self.log.debug("Got %d entries from server", len(entries))
  1173. self._backfill_leave = set()
  1174. async with NotificationDisabler(self.mxid, source):
  1175. for entry in reversed(entries):
  1176. sender = await p.Puppet.get_by_pk(int(entry.user_id))
  1177. await self.handle_instagram_item(source, sender, entry, is_backfill=True)
  1178. for intent in self._backfill_leave:
  1179. self.log.trace("Leaving room with %s post-backfill", intent.mxid)
  1180. await intent.leave_room(self.mxid)
  1181. self._backfill_leave = None
  1182. self.log.info("Backfilled %d messages through %s", len(entries), source.mxid)
  1183. async def _fetch_backfill_items(
  1184. self, source: u.User, is_initial: bool, limit: int
  1185. ) -> list[ThreadItem]:
  1186. items = []
  1187. self.log.debug("Fetching up to %d messages through %s", limit, source.igpk)
  1188. async for item in source.client.iter_thread(self.thread_id):
  1189. if len(items) >= limit:
  1190. self.log.debug(f"Fetched {len(items)} messages (the limit)")
  1191. break
  1192. elif not is_initial:
  1193. msg = await DBMessage.get_by_item_id(item.item_id, receiver=self.receiver)
  1194. if msg is not None:
  1195. self.log.debug(
  1196. f"Fetched {len(items)} messages and hit a message"
  1197. " that's already in the database."
  1198. )
  1199. break
  1200. items.append(item)
  1201. return items
  1202. # endregion
  1203. # region Bridge info state event
  1204. @property
  1205. def bridge_info_state_key(self) -> str:
  1206. return f"net.maunium.instagram://instagram/{self.thread_id}"
  1207. @property
  1208. def bridge_info(self) -> dict[str, Any]:
  1209. return {
  1210. "bridgebot": self.az.bot_mxid,
  1211. "creator": self.main_intent.mxid,
  1212. "protocol": {
  1213. "id": "instagram",
  1214. "displayname": "Instagram DM",
  1215. "avatar_url": self.config["appservice.bot_avatar"],
  1216. },
  1217. "channel": {
  1218. "id": self.thread_id,
  1219. "displayname": self.name,
  1220. "avatar_url": self.avatar_url,
  1221. },
  1222. }
  1223. async def update_bridge_info(self) -> None:
  1224. if not self.mxid:
  1225. self.log.debug("Not updating bridge info: no Matrix room created")
  1226. return
  1227. try:
  1228. self.log.debug("Updating bridge info...")
  1229. await self.main_intent.send_state_event(
  1230. self.mxid, StateBridge, self.bridge_info, self.bridge_info_state_key
  1231. )
  1232. # TODO remove this once https://github.com/matrix-org/matrix-doc/pull/2346 is in spec
  1233. await self.main_intent.send_state_event(
  1234. self.mxid, StateHalfShotBridge, self.bridge_info, self.bridge_info_state_key
  1235. )
  1236. except Exception:
  1237. self.log.warning("Failed to update bridge info", exc_info=True)
  1238. # endregion
  1239. # region Creating Matrix rooms
  1240. async def create_matrix_room(self, source: u.User, info: Thread) -> RoomID | None:
  1241. if self.mxid:
  1242. try:
  1243. await self.update_matrix_room(source, info)
  1244. except Exception:
  1245. self.log.exception("Failed to update portal")
  1246. return self.mxid
  1247. async with self._create_room_lock:
  1248. return await self._create_matrix_room(source, info)
  1249. def _get_invite_content(self, double_puppet: p.Puppet | None) -> dict[str, bool]:
  1250. invite_content = {}
  1251. if double_puppet:
  1252. invite_content["fi.mau.will_auto_accept"] = True
  1253. if self.is_direct:
  1254. invite_content["is_direct"] = True
  1255. return invite_content
  1256. async def update_matrix_room(
  1257. self, source: u.User, info: Thread, backfill: bool = False
  1258. ) -> None:
  1259. puppet = await p.Puppet.get_by_custom_mxid(source.mxid)
  1260. await self.main_intent.invite_user(
  1261. self.mxid,
  1262. source.mxid,
  1263. check_cache=True,
  1264. extra_content=self._get_invite_content(puppet),
  1265. )
  1266. if puppet:
  1267. did_join = await puppet.intent.ensure_joined(self.mxid)
  1268. if did_join and self.is_direct:
  1269. await source.update_direct_chats({self.main_intent.mxid: [self.mxid]})
  1270. await self.update_info(info, source)
  1271. if backfill:
  1272. last_msg = await DBMessage.get_by_item_id(
  1273. info.last_permanent_item.item_id, receiver=self.receiver
  1274. )
  1275. if last_msg is None:
  1276. self.log.debug(
  1277. f"Last permanent item ({info.last_permanent_item.item_id})"
  1278. " not found in database, starting backfilling"
  1279. )
  1280. await self.backfill(source, is_initial=False)
  1281. await self._update_read_receipts(info.last_seen_at)
  1282. async def _create_matrix_room(self, source: u.User, info: Thread) -> RoomID | None:
  1283. if self.mxid:
  1284. await self.update_matrix_room(source, info)
  1285. return self.mxid
  1286. await self.update_info(info, source)
  1287. self.log.debug("Creating Matrix room")
  1288. name: str | None = None
  1289. initial_state = [
  1290. {
  1291. "type": str(StateBridge),
  1292. "state_key": self.bridge_info_state_key,
  1293. "content": self.bridge_info,
  1294. },
  1295. # TODO remove this once https://github.com/matrix-org/matrix-doc/pull/2346 is in spec
  1296. {
  1297. "type": str(StateHalfShotBridge),
  1298. "state_key": self.bridge_info_state_key,
  1299. "content": self.bridge_info,
  1300. },
  1301. ]
  1302. invites = []
  1303. if self.config["bridge.encryption.default"] and self.matrix.e2ee:
  1304. self.encrypted = True
  1305. initial_state.append(
  1306. {
  1307. "type": "m.room.encryption",
  1308. "content": {"algorithm": "m.megolm.v1.aes-sha2"},
  1309. }
  1310. )
  1311. if self.is_direct:
  1312. invites.append(self.az.bot_mxid)
  1313. if self.encrypted or self.private_chat_portal_meta or not self.is_direct:
  1314. name = self.name
  1315. if self.config["appservice.community_id"]:
  1316. initial_state.append(
  1317. {
  1318. "type": "m.room.related_groups",
  1319. "content": {"groups": [self.config["appservice.community_id"]]},
  1320. }
  1321. )
  1322. # We lock backfill lock here so any messages that come between the room being created
  1323. # and the initial backfill finishing wouldn't be bridged before the backfill messages.
  1324. with self.backfill_lock:
  1325. creation_content = {}
  1326. if not self.config["bridge.federate_rooms"]:
  1327. creation_content["m.federate"] = False
  1328. self.mxid = await self.main_intent.create_room(
  1329. name=name,
  1330. is_direct=self.is_direct,
  1331. initial_state=initial_state,
  1332. invitees=invites,
  1333. creation_content=creation_content,
  1334. )
  1335. if not self.mxid:
  1336. raise Exception("Failed to create room: no mxid returned")
  1337. if self.encrypted and self.matrix.e2ee and self.is_direct:
  1338. try:
  1339. await self.az.intent.ensure_joined(self.mxid)
  1340. except Exception:
  1341. self.log.warning(f"Failed to add bridge bot to new private chat {self.mxid}")
  1342. await self.update()
  1343. self.log.debug(f"Matrix room created: {self.mxid}")
  1344. self.by_mxid[self.mxid] = self
  1345. puppet = await p.Puppet.get_by_custom_mxid(source.mxid)
  1346. await self.main_intent.invite_user(
  1347. self.mxid, source.mxid, extra_content=self._get_invite_content(puppet)
  1348. )
  1349. if puppet:
  1350. try:
  1351. if self.is_direct:
  1352. await source.update_direct_chats({self.main_intent.mxid: [self.mxid]})
  1353. await puppet.intent.join_room_by_id(self.mxid)
  1354. except MatrixError:
  1355. self.log.debug(
  1356. "Failed to join custom puppet into newly created portal", exc_info=True
  1357. )
  1358. await self._update_participants(info.users, source)
  1359. try:
  1360. await self.backfill(source, is_initial=True)
  1361. except Exception:
  1362. self.log.exception("Failed to backfill new portal")
  1363. await self._update_read_receipts(info.last_seen_at)
  1364. return self.mxid
  1365. # endregion
  1366. # region Database getters
  1367. async def postinit(self) -> None:
  1368. self.by_thread_id[(self.thread_id, self.receiver)] = self
  1369. if self.mxid:
  1370. self.by_mxid[self.mxid] = self
  1371. self._main_intent = (
  1372. (await p.Puppet.get_by_pk(self.other_user_pk)).default_mxid_intent
  1373. if self.other_user_pk
  1374. else self.az.intent
  1375. )
  1376. async def delete(self) -> None:
  1377. await DBMessage.delete_all(self.mxid)
  1378. self.by_mxid.pop(self.mxid, None)
  1379. self.mxid = None
  1380. self.encrypted = False
  1381. await self.update()
  1382. async def save(self) -> None:
  1383. await self.update()
  1384. @classmethod
  1385. def all_with_room(cls) -> AsyncGenerator[Portal, None]:
  1386. return cls._db_to_portals(super().all_with_room())
  1387. @classmethod
  1388. def find_private_chats_with(cls, other_user: int) -> AsyncGenerator[Portal, None]:
  1389. return cls._db_to_portals(super().find_private_chats_with(other_user))
  1390. @classmethod
  1391. async def _db_to_portals(cls, query: Awaitable[list[Portal]]) -> AsyncGenerator[Portal, None]:
  1392. portals = await query
  1393. for index, portal in enumerate(portals):
  1394. try:
  1395. yield cls.by_thread_id[(portal.thread_id, portal.receiver)]
  1396. except KeyError:
  1397. await portal.postinit()
  1398. yield portal
  1399. @classmethod
  1400. @async_getter_lock
  1401. async def get_by_mxid(cls, mxid: RoomID) -> Portal | None:
  1402. try:
  1403. return cls.by_mxid[mxid]
  1404. except KeyError:
  1405. pass
  1406. portal = cast(cls, await super().get_by_mxid(mxid))
  1407. if portal is not None:
  1408. await portal.postinit()
  1409. return portal
  1410. return None
  1411. @classmethod
  1412. @async_getter_lock
  1413. async def get_by_thread_id(
  1414. cls,
  1415. thread_id: str,
  1416. *,
  1417. receiver: int,
  1418. is_group: bool | None = None,
  1419. other_user_pk: int | None = None,
  1420. ) -> Portal | None:
  1421. if is_group and receiver != 0:
  1422. receiver = 0
  1423. try:
  1424. return cls.by_thread_id[(thread_id, receiver)]
  1425. except KeyError:
  1426. pass
  1427. if is_group is None and receiver != 0:
  1428. try:
  1429. return cls.by_thread_id[(thread_id, 0)]
  1430. except KeyError:
  1431. pass
  1432. portal = cast(
  1433. cls,
  1434. await super().get_by_thread_id(
  1435. thread_id, receiver=receiver, rec_must_match=is_group is not None
  1436. ),
  1437. )
  1438. if portal is not None:
  1439. await portal.postinit()
  1440. return portal
  1441. if is_group is not None:
  1442. portal = cls(thread_id, receiver, other_user_pk=other_user_pk)
  1443. await portal.insert()
  1444. await portal.postinit()
  1445. return portal
  1446. return None
  1447. @classmethod
  1448. async def get_by_thread(cls, thread: Thread, receiver: int) -> Portal | None:
  1449. if thread.is_group:
  1450. receiver = 0
  1451. other_user_pk = None
  1452. else:
  1453. if len(thread.users) == 0:
  1454. other_user_pk = receiver
  1455. else:
  1456. other_user_pk = thread.users[0].pk
  1457. return await cls.get_by_thread_id(
  1458. thread.thread_id,
  1459. receiver=receiver,
  1460. is_group=thread.is_group,
  1461. other_user_pk=other_user_pk,
  1462. )
  1463. # endregion