portal.py 71 KB

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