portal.py 71 KB

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