portal.py 71 KB

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