portal.py 71 KB

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