portal.py 71 KB

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