portal.py 95 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429
  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 html
  22. import json
  23. import mimetypes
  24. import re
  25. import sqlite3
  26. import time
  27. from yarl import URL
  28. import asyncpg
  29. import magic
  30. from mauigpapi.errors import IGRateLimitError
  31. from mauigpapi.types import (
  32. AnimatedMediaItem,
  33. CommandResponse,
  34. ExpiredMediaItem,
  35. MediaShareItem,
  36. MediaType,
  37. MessageSyncMessage,
  38. Reaction,
  39. ReactionStatus,
  40. ReelMediaShareItem,
  41. ReelShareType,
  42. RegularMediaItem,
  43. Thread,
  44. ThreadItem,
  45. ThreadItemType,
  46. ThreadUser,
  47. ThreadUserLastSeenAt,
  48. TypingStatus,
  49. VoiceMediaItem,
  50. XMAMediaShareItem,
  51. )
  52. from mautrix.appservice import DOUBLE_PUPPET_SOURCE_KEY, IntentAPI
  53. from mautrix.bridge import BasePortal, async_getter_lock
  54. from mautrix.errors import MatrixError, MForbidden, MNotFound, SessionNotFound
  55. from mautrix.types import (
  56. AudioInfo,
  57. BatchID,
  58. BatchSendEvent,
  59. BatchSendStateEvent,
  60. BeeperMessageStatusEventContent,
  61. ContentURI,
  62. EventID,
  63. EventType,
  64. Format,
  65. ImageInfo,
  66. LocationMessageEventContent,
  67. MediaMessageEventContent,
  68. Membership,
  69. MemberStateEventContent,
  70. MessageEventContent,
  71. MessageStatus,
  72. MessageStatusReason,
  73. MessageType,
  74. RelatesTo,
  75. RelationType,
  76. RoomID,
  77. TextMessageEventContent,
  78. UserID,
  79. VideoInfo,
  80. )
  81. from mautrix.util import ffmpeg
  82. from mautrix.util.message_send_checkpoint import MessageSendCheckpointStatus
  83. from . import matrix as m, puppet as p, user as u
  84. from .config import Config
  85. from .db import Backfill, Message as DBMessage, Portal as DBPortal, Reaction as DBReaction
  86. if TYPE_CHECKING:
  87. from .__main__ import InstagramBridge
  88. try:
  89. from mautrix.crypto.attachments import decrypt_attachment, encrypt_attachment
  90. except ImportError:
  91. encrypt_attachment = decrypt_attachment = None
  92. try:
  93. from PIL import Image
  94. except ImportError:
  95. Image = None
  96. StateBridge = EventType.find("m.bridge", EventType.Class.STATE)
  97. StateHalfShotBridge = EventType.find("uk.half-shot.bridge", EventType.Class.STATE)
  98. MediaData = Union[
  99. AnimatedMediaItem,
  100. ExpiredMediaItem,
  101. MediaShareItem,
  102. ReelMediaShareItem,
  103. RegularMediaItem,
  104. VoiceMediaItem,
  105. XMAMediaShareItem,
  106. ]
  107. MediaUploadFunc = Callable[["u.User", MediaData, IntentAPI], Awaitable[MediaMessageEventContent]]
  108. PortalCreateDummy = EventType.find("fi.mau.dummy.portal_created", EventType.Class.MESSAGE)
  109. HistorySyncMarkerMessage = EventType.find("org.matrix.msc2716.marker", EventType.Class.MESSAGE)
  110. ConvertedMessage = tuple[EventType, MessageEventContent]
  111. # This doesn't need to capture all valid URLs, it's enough to catch most of them.
  112. # False negatives simply mean the link won't be linkified on Instagram,
  113. # but false positives will cause the message to fail to send.
  114. SIMPLE_URL_REGEX = re.compile(
  115. r"(?P<url>https?://[\da-z.-]+\.[a-z]{2,}(?:/[^\s]*)?)", flags=re.IGNORECASE
  116. )
  117. class UnsupportedAttachmentError(NotImplementedError):
  118. pass
  119. class Portal(DBPortal, BasePortal):
  120. by_mxid: dict[RoomID, Portal] = {}
  121. by_thread_id: dict[tuple[str, int], Portal] = {}
  122. config: Config
  123. matrix: m.MatrixHandler
  124. private_chat_portal_meta: bool
  125. _main_intent: IntentAPI | None
  126. _create_room_lock: asyncio.Lock
  127. _msgid_dedup: deque[str]
  128. _reqid_dedup: set[str]
  129. _last_participant_update: set[int]
  130. _reaction_lock: asyncio.Lock
  131. _typing: set[UserID]
  132. def __init__(
  133. self,
  134. thread_id: str,
  135. receiver: int,
  136. other_user_pk: int | None,
  137. mxid: RoomID | None = None,
  138. name: str | None = None,
  139. avatar_url: ContentURI | None = None,
  140. encrypted: bool = False,
  141. name_set: bool = False,
  142. avatar_set: bool = False,
  143. relay_user_id: UserID | None = None,
  144. first_event_id: EventID | None = None,
  145. next_batch_id: BatchID | None = None,
  146. historical_base_insertion_event_id: EventID | None = None,
  147. cursor: str | None = None,
  148. ) -> None:
  149. super().__init__(
  150. thread_id,
  151. receiver,
  152. other_user_pk,
  153. mxid,
  154. name,
  155. avatar_url,
  156. encrypted,
  157. name_set,
  158. avatar_set,
  159. relay_user_id,
  160. first_event_id,
  161. next_batch_id,
  162. historical_base_insertion_event_id,
  163. cursor,
  164. )
  165. self._create_room_lock = asyncio.Lock()
  166. self.log = self.log.getChild(thread_id)
  167. self._msgid_dedup = deque(maxlen=100)
  168. self._reqid_dedup = set()
  169. self._last_participant_update = set()
  170. self._main_intent = None
  171. self._reaction_lock = asyncio.Lock()
  172. self._typing = set()
  173. self._relay_user = None
  174. @property
  175. def is_direct(self) -> bool:
  176. return self.other_user_pk is not None
  177. @property
  178. def main_intent(self) -> IntentAPI:
  179. if not self._main_intent:
  180. raise ValueError("Portal must be postinit()ed before main_intent can be used")
  181. return self._main_intent
  182. @classmethod
  183. def init_cls(cls, bridge: "InstagramBridge") -> None:
  184. cls.config = bridge.config
  185. cls.matrix = bridge.matrix
  186. cls.az = bridge.az
  187. cls.loop = bridge.loop
  188. cls.bridge = bridge
  189. cls.private_chat_portal_meta = cls.config["bridge.private_chat_portal_meta"]
  190. # region Misc
  191. async def _send_delivery_receipt(self, event_id: EventID) -> None:
  192. if event_id and self.config["bridge.delivery_receipts"]:
  193. try:
  194. await self.az.intent.mark_read(self.mxid, event_id)
  195. except Exception:
  196. self.log.exception("Failed to send delivery receipt for %s", event_id)
  197. async def _send_bridge_success(
  198. self,
  199. sender: u.User,
  200. event_id: EventID,
  201. event_type: EventType,
  202. msgtype: MessageType | None = None,
  203. ) -> None:
  204. sender.send_remote_checkpoint(
  205. status=MessageSendCheckpointStatus.SUCCESS,
  206. event_id=event_id,
  207. room_id=self.mxid,
  208. event_type=event_type,
  209. message_type=msgtype,
  210. )
  211. asyncio.create_task(self._send_message_status(event_id, err=None))
  212. await self._send_delivery_receipt(event_id)
  213. async def _send_bridge_error(
  214. self,
  215. sender: u.User,
  216. err: Exception,
  217. event_id: EventID,
  218. event_type: EventType,
  219. message_type: MessageType | None = None,
  220. confirmed: bool = False,
  221. ) -> None:
  222. sender.send_remote_checkpoint(
  223. self._status_from_exception(err),
  224. event_id,
  225. self.mxid,
  226. event_type,
  227. message_type=message_type,
  228. error=err,
  229. )
  230. if self.config["bridge.delivery_error_reports"]:
  231. event_type_str = {
  232. EventType.REACTION: "reaction",
  233. EventType.ROOM_REDACTION: "redaction",
  234. }.get(event_type, "message")
  235. error_type = "was not" if confirmed else "may not have been"
  236. await self._send_message(
  237. self.main_intent,
  238. TextMessageEventContent(
  239. msgtype=MessageType.NOTICE,
  240. body=f"\u26a0 Your {event_type_str} {error_type} bridged: {str(err)}",
  241. ),
  242. )
  243. asyncio.create_task(self._send_message_status(event_id, err))
  244. async def _send_message_status(self, event_id: EventID, err: Exception | None) -> None:
  245. if not self.config["bridge.message_status_events"]:
  246. return
  247. intent = self.az.intent if self.encrypted else self.main_intent
  248. status = BeeperMessageStatusEventContent(
  249. network=self.bridge_info_state_key,
  250. relates_to=RelatesTo(
  251. rel_type=RelationType.REFERENCE,
  252. event_id=event_id,
  253. ),
  254. )
  255. if err:
  256. status.error = str(err)
  257. if isinstance(err, NotImplementedError):
  258. if isinstance(err, UnsupportedAttachmentError):
  259. status.message = str(err)
  260. status.reason = MessageStatusReason.UNSUPPORTED
  261. status.status = MessageStatus.FAIL
  262. else:
  263. status.reason = MessageStatusReason.GENERIC_ERROR
  264. status.status = MessageStatus.RETRIABLE
  265. else:
  266. status.status = MessageStatus.SUCCESS
  267. status.fill_legacy_booleans()
  268. await intent.send_message_event(
  269. room_id=self.mxid,
  270. event_type=EventType.BEEPER_MESSAGE_STATUS,
  271. content=status,
  272. )
  273. async def _upsert_reaction(
  274. self,
  275. existing: DBReaction | None,
  276. intent: IntentAPI,
  277. mxid: EventID,
  278. message: DBMessage,
  279. sender: u.User | p.Puppet,
  280. reaction: str,
  281. mx_timestamp: int,
  282. ) -> None:
  283. if existing:
  284. self.log.debug(
  285. f"_upsert_reaction redacting {existing.mxid} and inserting {mxid}"
  286. f" (message: {message.mxid})"
  287. )
  288. await intent.redact(existing.mx_room, existing.mxid)
  289. await existing.edit(
  290. reaction=reaction, mxid=mxid, mx_room=message.mx_room, mx_timestamp=mx_timestamp
  291. )
  292. else:
  293. self.log.debug(f"_upsert_reaction inserting {mxid} (message: {message.mxid})")
  294. await DBReaction(
  295. mxid=mxid,
  296. mx_room=message.mx_room,
  297. ig_item_id=message.item_id,
  298. ig_receiver=self.receiver,
  299. ig_sender=sender.igpk,
  300. reaction=reaction,
  301. mx_timestamp=mx_timestamp,
  302. ).insert()
  303. # endregion
  304. # region Matrix event handling
  305. @staticmethod
  306. def _status_from_exception(e: Exception) -> MessageSendCheckpointStatus:
  307. if isinstance(e, NotImplementedError):
  308. return MessageSendCheckpointStatus.UNSUPPORTED
  309. elif isinstance(e, asyncio.TimeoutError):
  310. return MessageSendCheckpointStatus.TIMEOUT
  311. return MessageSendCheckpointStatus.PERM_FAILURE
  312. async def handle_matrix_message(
  313. self, sender: u.User, message: MessageEventContent, event_id: EventID
  314. ) -> None:
  315. try:
  316. await self._handle_matrix_message(sender, message, event_id)
  317. except Exception as e:
  318. self.log.exception(f"Error handling Matrix event {event_id}")
  319. await self._send_bridge_error(
  320. sender,
  321. e,
  322. event_id,
  323. EventType.ROOM_MESSAGE,
  324. message_type=message.msgtype,
  325. confirmed=True,
  326. )
  327. else:
  328. await self._send_bridge_success(
  329. sender, event_id, EventType.ROOM_MESSAGE, message.msgtype
  330. )
  331. async def _handle_matrix_giphy(
  332. self,
  333. sender: u.User,
  334. event_id: EventID,
  335. request_id: str,
  336. giphy_id: str,
  337. ) -> CommandResponse:
  338. self.log.trace(f"Broadcasting giphy from {event_id} with request ID {request_id}")
  339. return await sender.client.broadcast(
  340. self.thread_id,
  341. ThreadItemType.ANIMATED_MEDIA,
  342. client_context=request_id,
  343. id=giphy_id,
  344. )
  345. async def _handle_matrix_image(
  346. self,
  347. sender: u.User,
  348. event_id: EventID,
  349. request_id: str,
  350. data: bytes,
  351. mime_type: str,
  352. width: int | None = None,
  353. height: int | None = None,
  354. ) -> CommandResponse:
  355. if mime_type != "image/jpeg":
  356. if Image is None:
  357. raise UnsupportedAttachmentError(
  358. "Instagram does not allow non-JPEG images, and Pillow is not installed, "
  359. "so the bridge couldn't convert the image automatically"
  360. )
  361. with BytesIO(data) as inp, BytesIO() as out:
  362. img = Image.open(inp)
  363. img.convert("RGB").save(out, format="JPEG", quality=80)
  364. data = out.getvalue()
  365. mime_type = "image/jpeg"
  366. self.log.trace(f"Uploading photo from {event_id} (mime: {mime_type})")
  367. upload_resp = await sender.client.upload_photo(
  368. data, mime=mime_type, width=width, height=height
  369. )
  370. self.log.trace(f"Broadcasting uploaded photo with request ID {request_id}")
  371. return await sender.client.broadcast(
  372. self.thread_id,
  373. ThreadItemType.CONFIGURE_PHOTO,
  374. client_context=request_id,
  375. upload_id=upload_resp.upload_id,
  376. allow_full_aspect_ratio="true",
  377. )
  378. async def _handle_matrix_video(
  379. self,
  380. sender: u.User,
  381. event_id: EventID,
  382. request_id: str,
  383. data: bytes,
  384. mime_type: str,
  385. duration: int | None = None,
  386. width: int | None = None,
  387. height: int | None = None,
  388. ) -> CommandResponse:
  389. if mime_type != "video/mp4":
  390. data = await ffmpeg.convert_bytes(
  391. data,
  392. output_extension=".mp4",
  393. output_args=("-c:v", "libx264", "-c:a", "aac"),
  394. input_mime=mime_type,
  395. )
  396. self.log.trace(f"Uploading video from {event_id}")
  397. _, upload_id = await sender.client.upload_mp4(
  398. data, duration_ms=duration, width=width, height=height
  399. )
  400. self.log.trace(f"Broadcasting uploaded video with request ID {request_id}")
  401. return await sender.client.broadcast(
  402. self.thread_id,
  403. ThreadItemType.CONFIGURE_VIDEO,
  404. client_context=request_id,
  405. upload_id=upload_id,
  406. video_result="",
  407. )
  408. async def _handle_matrix_audio(
  409. self,
  410. sender: u.User,
  411. event_id: EventID,
  412. request_id: str,
  413. data: bytes,
  414. mime_type: str,
  415. waveform: list[int],
  416. duration: int | None = None,
  417. ) -> CommandResponse:
  418. if mime_type != "audio/mp4":
  419. data = await ffmpeg.convert_bytes(
  420. data, output_extension=".m4a", output_args=("-c:a", "aac"), input_mime=mime_type
  421. )
  422. self.log.trace(f"Uploading audio from {event_id}")
  423. _, upload_id = await sender.client.upload_mp4(data, audio=True, duration_ms=duration)
  424. self.log.trace(f"Broadcasting uploaded audio with request ID {request_id}")
  425. return await sender.client.broadcast(
  426. self.thread_id,
  427. ThreadItemType.SHARE_VOICE,
  428. client_context=request_id,
  429. upload_id=upload_id,
  430. waveform=json.dumps([(part or 0) / 1024 for part in waveform], separators=(",", ":")),
  431. waveform_sampling_frequency_hz="10",
  432. )
  433. async def _handle_matrix_message(
  434. self, orig_sender: u.User, message: MessageEventContent, event_id: EventID
  435. ) -> None:
  436. sender, is_relay = await self.get_relay_sender(orig_sender, f"message {event_id}")
  437. assert sender, "user is not logged in"
  438. assert sender.is_connected, "You're not connected to Instagram"
  439. if is_relay:
  440. await self.apply_relay_message_format(orig_sender, message)
  441. reply_to = {}
  442. if message.get_reply_to():
  443. msg = await DBMessage.get_by_mxid(message.get_reply_to(), self.mxid)
  444. if msg and msg.client_context:
  445. reply_to = {
  446. "replied_to_item_id": msg.item_id,
  447. "replied_to_client_context": msg.client_context,
  448. }
  449. request_id = sender.state.gen_client_context()
  450. self._reqid_dedup.add(request_id)
  451. self.log.debug(
  452. f"Handling Matrix message {event_id} from {sender.mxid}/{sender.igpk} "
  453. f"with request ID {request_id}"
  454. )
  455. if message.msgtype == MessageType.NOTICE and not self.config["bridge.bridge_notices"]:
  456. return
  457. if message.msgtype in (MessageType.EMOTE, MessageType.TEXT, MessageType.NOTICE):
  458. text = message.body
  459. if message.msgtype == MessageType.EMOTE:
  460. text = f"/me {text}"
  461. self.log.trace(f"Sending Matrix text from {event_id} with request ID {request_id}")
  462. urls = SIMPLE_URL_REGEX.findall(text) or None
  463. if not self.is_direct:
  464. # Instagram groups don't seem to support sending link previews,
  465. # and the client_context-based deduplication breaks when trying to send them.
  466. urls = None
  467. resp = await sender.mqtt.send_text(
  468. self.thread_id, text=text, urls=urls, client_context=request_id, **reply_to
  469. )
  470. elif message.msgtype.is_media and "fi.mau.instagram.giphy_id" in message:
  471. resp = await self._handle_matrix_giphy(
  472. sender, event_id, request_id, message["fi.mau.instagram.giphy_id"]
  473. )
  474. elif message.msgtype.is_media:
  475. if message.file and decrypt_attachment:
  476. data = await self.main_intent.download_media(message.file.url)
  477. data = decrypt_attachment(
  478. data, message.file.key.key, message.file.hashes.get("sha256"), message.file.iv
  479. )
  480. else:
  481. data = await self.main_intent.download_media(message.url)
  482. mime_type = message.info.mimetype or magic.from_buffer(data, mime=True)
  483. if message.msgtype == MessageType.IMAGE:
  484. resp = await self._handle_matrix_image(
  485. sender,
  486. event_id,
  487. request_id,
  488. data,
  489. mime_type,
  490. width=message.info.width,
  491. height=message.info.height,
  492. )
  493. elif message.msgtype == MessageType.AUDIO:
  494. waveform = message.get("org.matrix.msc1767.audio", {}).get("waveform", [0] * 30)
  495. resp = await self._handle_matrix_audio(
  496. sender,
  497. event_id,
  498. request_id,
  499. data,
  500. mime_type,
  501. waveform,
  502. duration=message.info.duration,
  503. )
  504. elif message.msgtype == MessageType.VIDEO:
  505. resp = await self._handle_matrix_video(
  506. sender,
  507. event_id,
  508. request_id,
  509. data,
  510. mime_type,
  511. duration=message.info.duration,
  512. width=message.info.width,
  513. height=message.info.height,
  514. )
  515. else:
  516. raise UnsupportedAttachmentError(
  517. "Non-image/video/audio files are currently not supported"
  518. )
  519. else:
  520. raise NotImplementedError(f"Unknown message type {message.msgtype}")
  521. self.log.trace(f"Got response to message send {request_id}: {resp}")
  522. if resp.status != "ok" or not resp.payload:
  523. self.log.warning(f"Failed to handle {event_id}: {resp}")
  524. raise Exception(f"Sending message failed: {resp.error_message}")
  525. else:
  526. self._msgid_dedup.appendleft(resp.payload.item_id)
  527. try:
  528. await DBMessage(
  529. mxid=event_id,
  530. mx_room=self.mxid,
  531. item_id=resp.payload.item_id,
  532. client_context=resp.payload.client_context,
  533. receiver=self.receiver,
  534. sender=sender.igpk,
  535. ig_timestamp=int(resp.payload.timestamp),
  536. ).insert()
  537. except (asyncpg.UniqueViolationError, sqlite3.IntegrityError) as e:
  538. self.log.warning(
  539. f"Error while persisting {event_id} ({resp.payload.client_context}) "
  540. f"-> {resp.payload.item_id}: {e}"
  541. )
  542. self._reqid_dedup.remove(request_id)
  543. self.log.debug(
  544. f"Handled Matrix message {event_id} ({resp.payload.client_context}) "
  545. f"-> {resp.payload.item_id}"
  546. )
  547. async def handle_matrix_reaction(
  548. self, sender: u.User, event_id: EventID, reacting_to: EventID, emoji: str, timestamp: int
  549. ) -> None:
  550. try:
  551. await self._handle_matrix_reaction(sender, event_id, reacting_to, emoji, timestamp)
  552. except Exception as e:
  553. self.log.exception(f"Error handling Matrix reaction {event_id}")
  554. await self._send_bridge_error(
  555. sender,
  556. e,
  557. event_id,
  558. EventType.REACTION,
  559. confirmed=True,
  560. )
  561. else:
  562. await self._send_bridge_success(sender, event_id, EventType.REACTION)
  563. async def _handle_matrix_reaction(
  564. self, sender: u.User, event_id: EventID, reacting_to: EventID, emoji: str, timestamp: int
  565. ) -> None:
  566. if not await sender.is_logged_in():
  567. self.log.debug(f"Ignoring reaction by non-logged-in user {sender.mxid}")
  568. raise NotImplementedError("User is not logged in")
  569. message = await DBMessage.get_by_mxid(reacting_to, self.mxid)
  570. if not message or message.is_internal:
  571. self.log.debug(f"Ignoring reaction to unknown event {reacting_to}")
  572. await self.main_intent.redact(self.mxid, event_id, reason="Unknown target message")
  573. raise NotImplementedError("Unknown target message")
  574. existing = await DBReaction.get_by_item_id(message.item_id, message.receiver, sender.igpk)
  575. if existing and existing.reaction == emoji:
  576. return
  577. async with self._reaction_lock:
  578. resp = await sender.mqtt.send_reaction(
  579. self.thread_id, item_id=message.item_id, emoji=emoji
  580. )
  581. if resp.status != "ok":
  582. if resp.payload and resp.payload.message == "invalid unicode emoji":
  583. # Instagram doesn't support this reaction. Notify the user, and redact it
  584. # so that it doesn't get confusing.
  585. await self.main_intent.redact(self.mxid, event_id, reason="Unsupported emoji")
  586. raise NotImplementedError(f"Instagram does not support the {emoji} emoji.")
  587. raise Exception(f"Unknown response error: {resp}")
  588. self.log.trace(f"{sender.mxid} reacted to {message.item_id} with {emoji}")
  589. await self._upsert_reaction(
  590. existing, self.main_intent, event_id, message, sender, emoji, timestamp
  591. )
  592. async def handle_matrix_redaction(
  593. self, orig_sender: u.User, event_id: EventID, redaction_event_id: EventID
  594. ) -> None:
  595. sender = None
  596. try:
  597. sender, _ = await self.get_relay_sender(orig_sender, f"redaction {event_id}")
  598. if not sender:
  599. raise Exception("User is not logged in")
  600. await self._handle_matrix_redaction(sender, event_id)
  601. except Exception as e:
  602. self.log.exception(f"Error handling Matrix redaction {event_id}")
  603. await self._send_bridge_error(
  604. sender or orig_sender,
  605. e,
  606. redaction_event_id,
  607. EventType.ROOM_REDACTION,
  608. confirmed=True,
  609. )
  610. else:
  611. await self._send_bridge_success(sender, redaction_event_id, EventType.ROOM_REDACTION)
  612. async def _handle_matrix_redaction(self, sender: u.User, event_id: EventID) -> None:
  613. if not sender.is_connected:
  614. raise Exception("You're not connected to Instagram")
  615. reaction = await DBReaction.get_by_mxid(event_id, self.mxid)
  616. if reaction:
  617. try:
  618. await reaction.delete()
  619. await sender.mqtt.send_reaction(
  620. self.thread_id,
  621. item_id=reaction.ig_item_id,
  622. reaction_status=ReactionStatus.DELETED,
  623. emoji="",
  624. )
  625. except Exception as e:
  626. raise Exception(f"Removing reaction failed: {e}")
  627. else:
  628. self.log.trace(f"Removed reaction to {reaction.ig_item_id} after Matrix redaction")
  629. return
  630. message = await DBMessage.get_by_mxid(event_id, self.mxid)
  631. if message and not message.is_internal:
  632. try:
  633. await message.delete()
  634. await sender.client.delete_item(self.thread_id, message.item_id)
  635. self.log.trace(f"Removed {message} after Matrix redaction")
  636. except Exception as e:
  637. raise Exception(f"Removing message failed: {e}")
  638. else:
  639. self.log.trace(f"Removed message {message.item_id} after Matrix redaction")
  640. return
  641. raise NotImplementedError("No message or reaction found for redaction")
  642. async def handle_matrix_typing(self, users: set[UserID]) -> None:
  643. if users == self._typing:
  644. return
  645. old_typing = self._typing
  646. self._typing = users
  647. await self._handle_matrix_typing(old_typing - users, TypingStatus.OFF)
  648. await self._handle_matrix_typing(users - old_typing, TypingStatus.TEXT)
  649. async def _handle_matrix_typing(self, users: set[UserID], status: TypingStatus) -> None:
  650. for mxid in users:
  651. user = await u.User.get_by_mxid(mxid, create=False)
  652. if (
  653. not user
  654. or not await user.is_logged_in()
  655. or user.remote_typing_status == status
  656. or not user.is_connected
  657. ):
  658. continue
  659. user.remote_typing_status = None
  660. await user.mqtt.indicate_activity(self.thread_id, status)
  661. async def handle_matrix_leave(self, user: u.User) -> None:
  662. if not await user.is_logged_in():
  663. return
  664. if self.is_direct:
  665. self.log.info(f"{user.mxid} left private chat portal with {self.other_user_pk}")
  666. if user.igpk == self.receiver:
  667. self.log.info(
  668. f"{user.mxid} was the recipient of this portal. Cleaning up and deleting..."
  669. )
  670. await self.cleanup_and_delete()
  671. else:
  672. self.log.debug(f"{user.mxid} left portal to {self.thread_id}")
  673. # TODO cleanup if empty
  674. # endregion
  675. # region Instagram event handling
  676. async def _reupload_instagram_media(
  677. self, source: u.User, media: RegularMediaItem, intent: IntentAPI
  678. ) -> MediaMessageEventContent:
  679. if media.media_type == MediaType.IMAGE:
  680. image = media.best_image
  681. if not image:
  682. raise ValueError("Attachment not available: didn't find photo URL")
  683. url = image.url
  684. msgtype = MessageType.IMAGE
  685. info = ImageInfo(height=image.height, width=image.width)
  686. elif media.media_type == MediaType.VIDEO:
  687. video = media.best_video
  688. if not video:
  689. raise ValueError("Attachment not available: didn't find video URL")
  690. url = video.url
  691. msgtype = MessageType.VIDEO
  692. info = VideoInfo(height=video.height, width=video.width)
  693. elif media.media_type == MediaType.CAROUSEL:
  694. raise ValueError(
  695. "Carousel media is not currently supported, "
  696. "please view the post on Instagram via the link below"
  697. )
  698. else:
  699. raise ValueError(
  700. f"Attachment not available: unsupported media type {media.media_type.human_name}"
  701. )
  702. return await self._reupload_instagram_file(source, url, msgtype, info, intent)
  703. async def _reupload_instagram_animated(
  704. self, source: u.User, media: AnimatedMediaItem, intent: IntentAPI
  705. ) -> MediaMessageEventContent:
  706. url = media.images.fixed_height.webp
  707. info = ImageInfo(
  708. height=int(media.images.fixed_height.height),
  709. width=int(media.images.fixed_height.width),
  710. )
  711. return await self._reupload_instagram_file(source, url, MessageType.IMAGE, info, intent)
  712. async def _reupload_instagram_xma(
  713. self, source: u.User, media: XMAMediaShareItem, intent: IntentAPI
  714. ) -> MediaMessageEventContent:
  715. url = media.preview_url
  716. info = ImageInfo(
  717. mimetype=media.preview_url_mime_type,
  718. )
  719. return await self._reupload_instagram_file(source, url, MessageType.IMAGE, info, intent)
  720. async def _reupload_instagram_voice(
  721. self, source: u.User, media: VoiceMediaItem, intent: IntentAPI
  722. ) -> MediaMessageEventContent:
  723. async def convert_to_ogg(data, mimetype):
  724. converted = await ffmpeg.convert_bytes(
  725. data, ".ogg", output_args=("-c:a", "libopus"), input_mime=mimetype
  726. )
  727. return converted, "audio/ogg"
  728. url = media.media.audio.audio_src
  729. info = AudioInfo(duration=media.media.audio.duration)
  730. waveform = [int(p * 1024) for p in media.media.audio.waveform_data]
  731. content = await self._reupload_instagram_file(
  732. source, url, MessageType.AUDIO, info, intent, convert_to_ogg
  733. )
  734. content["org.matrix.msc1767.audio"] = {
  735. "duration": media.media.audio.duration,
  736. "waveform": waveform,
  737. }
  738. content["org.matrix.msc3245.voice"] = {}
  739. return content
  740. async def _reupload_instagram_file(
  741. self,
  742. source: u.User,
  743. url: str,
  744. msgtype: MessageType | None,
  745. info: ImageInfo | VideoInfo | AudioInfo,
  746. intent: IntentAPI,
  747. convert_fn: Callable[[bytes, str], Awaitable[tuple[bytes, str]]] | None = None,
  748. allow_encrypt: bool = True,
  749. ) -> MediaMessageEventContent:
  750. data = None
  751. async with source.client.raw_http_get(url) as resp:
  752. try:
  753. length = int(resp.headers["Content-Length"])
  754. except KeyError:
  755. # TODO can the download be short-circuited if there's too much data?
  756. self.log.warning(
  757. "Got file download response with no Content-Length header,"
  758. "reading data dangerously"
  759. )
  760. length = 0
  761. if length > self.matrix.media_config.upload_size:
  762. self.log.debug(
  763. f"{url} was too large ({length} > {self.matrix.media_config.upload_size})"
  764. )
  765. raise ValueError("Attachment not available: too large")
  766. data = await resp.read()
  767. info.mimetype = resp.headers["Content-Type"] or magic.from_buffer(data, mime=True)
  768. assert data is not None
  769. # Run the conversion function on the data.
  770. if convert_fn is not None:
  771. data, info.mimetype = await convert_fn(data, info.mimetype)
  772. if info.mimetype.startswith("image/") and not info.width and not info.height:
  773. with BytesIO(data) as inp, Image.open(inp) as img:
  774. info.width, info.height = img.size
  775. info.size = len(data)
  776. extension = {
  777. "image/webp": ".webp",
  778. "image/jpeg": ".jpg",
  779. "video/mp4": ".mp4",
  780. "audio/mp4": ".m4a",
  781. "audio/ogg": ".ogg",
  782. }.get(info.mimetype)
  783. extension = extension or mimetypes.guess_extension(info.mimetype) or ""
  784. file_name = f"{msgtype.value[2:]}{extension}" if msgtype else None
  785. upload_mime_type = info.mimetype
  786. upload_file_name = file_name
  787. decryption_info = None
  788. if allow_encrypt and self.encrypted and encrypt_attachment:
  789. data, decryption_info = encrypt_attachment(data)
  790. upload_mime_type = "application/octet-stream"
  791. upload_file_name = None
  792. mxc = await intent.upload_media(
  793. data,
  794. mime_type=upload_mime_type,
  795. filename=upload_file_name,
  796. async_upload=self.config["homeserver.async_media"],
  797. )
  798. if decryption_info:
  799. decryption_info.url = mxc
  800. mxc = None
  801. return MediaMessageEventContent(
  802. body=file_name,
  803. external_url=url,
  804. url=mxc,
  805. file=decryption_info,
  806. info=info,
  807. msgtype=msgtype,
  808. )
  809. def _get_instagram_media_info(self, item: ThreadItem) -> tuple[MediaUploadFunc, MediaData]:
  810. # TODO maybe use a dict and item.item_type instead of a ton of ifs
  811. method = self._reupload_instagram_media
  812. if (
  813. item.xma_media_share
  814. or item.xma_story_share
  815. or item.xma_reel_share
  816. or item.xma_reel_mention
  817. or item.generic_xma
  818. ):
  819. media_data = (
  820. item.xma_media_share
  821. or item.xma_story_share
  822. or item.xma_reel_share
  823. or item.xma_reel_mention
  824. or item.generic_xma
  825. )[0]
  826. method = self._reupload_instagram_xma
  827. elif item.media:
  828. media_data = item.media
  829. elif item.visual_media:
  830. media_data = item.visual_media.media
  831. elif item.animated_media:
  832. media_data = item.animated_media
  833. method = self._reupload_instagram_animated
  834. elif item.voice_media:
  835. media_data = item.voice_media
  836. method = self._reupload_instagram_voice
  837. elif item.reel_share:
  838. media_data = item.reel_share.media
  839. elif item.story_share:
  840. media_data = item.story_share.media
  841. elif item.clip:
  842. media_data = item.clip.clip
  843. elif item.felix_share and item.felix_share.video:
  844. media_data = item.felix_share.video
  845. elif item.media_share:
  846. media_data = item.media_share
  847. elif item.direct_media_share:
  848. media_data = item.direct_media_share.media
  849. else:
  850. self.log.debug(f"Unknown media type in {item}")
  851. raise ValueError("Attachment not available: unsupported media type")
  852. if not media_data:
  853. self.log.debug(f"Didn't get media_data in {item}")
  854. raise ValueError("Attachment not available: unsupported media type")
  855. elif isinstance(media_data, ExpiredMediaItem):
  856. self.log.debug(f"Expired media in item {item}")
  857. raise ValueError("Attachment not available: media expired")
  858. return method, media_data
  859. async def _convert_instagram_media(
  860. self, source: u.User, intent: IntentAPI, item: ThreadItem
  861. ) -> ConvertedMessage:
  862. try:
  863. reupload_func, media_data = self._get_instagram_media_info(item)
  864. content = await reupload_func(source, media_data, intent)
  865. except ValueError as e:
  866. content = TextMessageEventContent(body=str(e), msgtype=MessageType.NOTICE)
  867. except Exception:
  868. self.log.warning("Failed to upload media", exc_info=True)
  869. content = TextMessageEventContent(
  870. body="Attachment not available: failed to copy file", msgtype=MessageType.NOTICE
  871. )
  872. await self._add_instagram_reply(content, item.replied_to_message)
  873. return EventType.ROOM_MESSAGE, content
  874. # TODO this might be unused
  875. async def _convert_instagram_media_share(
  876. self, source: u.User, intent: IntentAPI, item: ThreadItem
  877. ) -> list[ConvertedMessage]:
  878. item_type_name = None
  879. if item.media_share:
  880. share_item = item.media_share
  881. elif item.clip:
  882. share_item = item.clip.clip
  883. item_type_name = "clip"
  884. elif item.felix_share and item.felix_share.video:
  885. share_item = item.felix_share.video
  886. elif item.story_share:
  887. share_item = item.story_share.media
  888. item_type_name = "story"
  889. elif item.direct_media_share:
  890. share_item = item.direct_media_share.media
  891. else:
  892. self.log.debug("No media share to bridge")
  893. return []
  894. item_type_name = item_type_name or share_item.media_type.human_name
  895. user_text = f"@{share_item.user.username}"
  896. user_link = (
  897. f'<a href="https://www.instagram.com/{share_item.user.username}/">{user_text}</a>'
  898. )
  899. prefix = TextMessageEventContent(
  900. msgtype=MessageType.NOTICE,
  901. format=Format.HTML,
  902. body=f"Sent {user_text}'s {item_type_name}",
  903. formatted_body=f"Sent {user_link}'s {item_type_name}",
  904. )
  905. if item.direct_media_share and item.direct_media_share.media_share_type == "tag":
  906. tagged_user_id = item.direct_media_share.tagged_user_id
  907. if tagged_user_id == source.igpk and share_item.user.pk == self.other_user_pk:
  908. prefix.body = prefix.formatted_body = "Tagged you in their post"
  909. elif share_item.user.pk == source.igpk and tagged_user_id == self.other_user_pk:
  910. prefix.body = prefix.formatted_body = "Tagged them in your post"
  911. _, content = await self._convert_instagram_media(source, intent, item)
  912. external_url = f"https://www.instagram.com/p/{share_item.code}/"
  913. if share_item.caption:
  914. caption_body = (
  915. f"> {share_item.caption.user.username}: {share_item.caption.text}\n\n"
  916. f"{external_url}"
  917. )
  918. caption_formatted_body = (
  919. f"<blockquote><strong>{share_item.caption.user.username}</strong>"
  920. f" {html.escape(share_item.caption.text)}</blockquote>"
  921. f'<a href="{external_url}">instagram.com/p/{share_item.code}</a>'
  922. )
  923. else:
  924. caption_body = external_url
  925. caption_formatted_body = (
  926. f'<a href="{external_url}">instagram.com/p/{share_item.code}</a>'
  927. )
  928. caption = TextMessageEventContent(
  929. msgtype=MessageType.TEXT,
  930. body=caption_body,
  931. formatted_body=caption_formatted_body,
  932. format=Format.HTML,
  933. external_url=external_url,
  934. )
  935. if self.bridge.config["bridge.caption_in_message"]:
  936. if isinstance(content, TextMessageEventContent):
  937. content.ensure_has_html()
  938. prefix.ensure_has_html()
  939. caption.ensure_has_html()
  940. combined = TextMessageEventContent(
  941. msgtype=MessageType.TEXT,
  942. body="\n".join((content.body, prefix.body, caption.body)),
  943. formatted_body=(
  944. f"<p><b>{content.formatted_body}</b></p>"
  945. f"<p><i>{prefix.formatted_body}</p>"
  946. f"<p>{caption.formatted_body}</p>"
  947. ),
  948. format=Format.HTML,
  949. external_url=external_url,
  950. )
  951. else:
  952. prefix.ensure_has_html()
  953. caption.ensure_has_html()
  954. combined_body = "\n".join((prefix.body, caption.body))
  955. combined_formatted_body = (
  956. f"<p><i>{prefix.formatted_body}</i></p><p>{caption.formatted_body}</p>"
  957. )
  958. combined = content
  959. combined["filename"] = content.body
  960. combined.body = combined_body
  961. combined["format"] = str(Format.HTML)
  962. combined["org.matrix.msc1767.caption"] = {
  963. "org.matrix.msc1767.text": combined_body,
  964. "org.matrix.msc1767.html": combined_formatted_body,
  965. }
  966. combined["formatted_body"] = combined_formatted_body
  967. return [(EventType.ROOM_MESSAGE, combined)]
  968. else:
  969. return [
  970. (EventType.ROOM_MESSAGE, prefix),
  971. (EventType.ROOM_MESSAGE, content),
  972. (EventType.ROOM_MESSAGE, caption),
  973. ]
  974. async def _convert_instagram_xma_media_share(
  975. self, source: u.User, intent: IntentAPI, item: ThreadItem
  976. ) -> list[ConvertedMessage]:
  977. # N.B. _get_instagram_media_info also only supports downloading the first xma item
  978. xma_list = (
  979. item.xma_media_share
  980. or item.xma_story_share
  981. or item.xma_reel_share
  982. or item.xma_reel_mention
  983. or item.generic_xma
  984. )
  985. media = xma_list[0]
  986. if len(xma_list) != 1:
  987. self.log.warning(f"Item {item.item_id} has multiple xma media share parts")
  988. if media.xma_layout_type not in (0, 4):
  989. self.log.warning(f"Unrecognized xma layout type {media.xma_layout_type}")
  990. _, content = await self._convert_instagram_media(source, intent, item)
  991. # Post shares (layout type 0): media title text
  992. # Reel shares/replies/reactions (layout type 4): item text
  993. caption_text = media.title_text or item.text or ""
  994. if media.subtitle_text:
  995. caption_text = (
  996. f"{caption_text}\n{media.subtitle_text}" if caption_text else media.subtitle_text
  997. )
  998. if media.target_url:
  999. caption_body = (
  1000. f"> {caption_text}\n\n{media.target_url}" if caption_text else media.target_url
  1001. )
  1002. else:
  1003. caption_body = f"> {caption_text}"
  1004. escaped_caption_text = html.escape(caption_text).replace("\n", "<br>")
  1005. escaped_header_text = html.escape(media.header_title_text or "")
  1006. # For post shares, the media title starts with the username, which is also the header.
  1007. # That part should be bolded.
  1008. if (
  1009. escaped_header_text
  1010. and escaped_caption_text
  1011. and escaped_caption_text.startswith(escaped_header_text)
  1012. ):
  1013. escaped_caption_text = (
  1014. f"<strong>{escaped_header_text}</strong>"
  1015. f"{escaped_caption_text[len(escaped_header_text):]}"
  1016. )
  1017. if item.message_item_type == "animated_media":
  1018. anim = await self._reupload_instagram_file(
  1019. source,
  1020. url=item.animated_media.images.fixed_height.webp,
  1021. msgtype=MessageType.IMAGE,
  1022. info=ImageInfo(
  1023. width=int(item.animated_media.images.fixed_height.width),
  1024. height=int(item.animated_media.images.fixed_height.height),
  1025. ),
  1026. intent=intent,
  1027. )
  1028. inline_img = (
  1029. f'<img src="{anim.url}" width={anim.info.width} height={anim.info.height}/>'
  1030. )
  1031. escaped_caption_text = (
  1032. f"{escaped_caption_text}<br/>{inline_img}" if escaped_caption_text else inline_img
  1033. )
  1034. caption_formatted_body = (
  1035. f"<blockquote>{escaped_caption_text}</blockquote>" if escaped_caption_text else ""
  1036. )
  1037. if media.target_url:
  1038. target_url_pretty = str(URL(media.target_url).with_query(None)).replace(
  1039. "https://www.", ""
  1040. )
  1041. caption_formatted_body += (
  1042. f'<p><a href="{media.target_url}">{target_url_pretty}</a></p>'
  1043. )
  1044. # Add auxiliary text as prefix for caption
  1045. if item.auxiliary_text:
  1046. caption_formatted_body = (
  1047. f"<p>{html.escape(item.auxiliary_text)}</p>{caption_formatted_body}"
  1048. )
  1049. caption_body = f"{item.auxiliary_text}\n\n{caption_body}"
  1050. caption = TextMessageEventContent(
  1051. msgtype=MessageType.TEXT,
  1052. body=caption_body,
  1053. formatted_body=caption_formatted_body,
  1054. format=Format.HTML,
  1055. )
  1056. if media.target_url:
  1057. content.external_url = media.target_url
  1058. caption.external_url = media.target_url
  1059. if self.bridge.config["bridge.caption_in_message"]:
  1060. if isinstance(content, TextMessageEventContent):
  1061. content.ensure_has_html()
  1062. caption.ensure_has_html()
  1063. content.body += f"\n\n{caption.body}"
  1064. content.formatted_body = (
  1065. f"<p><b>{content.formatted_body}</b></p>{caption.formatted_body}"
  1066. )
  1067. else:
  1068. content["filename"] = content.body
  1069. content.body = caption.body
  1070. content["format"] = str(Format.HTML)
  1071. content["formatted_body"] = caption.formatted_body
  1072. content["org.matrix.msc1767.caption"] = {
  1073. "org.matrix.msc1767.text": content.body,
  1074. "org.matrix.msc1767.html": content["formatted_body"],
  1075. }
  1076. return [(EventType.ROOM_MESSAGE, content)]
  1077. else:
  1078. return [(EventType.ROOM_MESSAGE, content), (EventType.ROOM_MESSAGE, caption)]
  1079. # TODO this is probably unused
  1080. async def _convert_instagram_reel_share(
  1081. self, source: u.User, intent: IntentAPI, item: ThreadItem
  1082. ) -> list[ConvertedMessage]:
  1083. assert item.reel_share
  1084. media = item.reel_share.media
  1085. prefix_html = None
  1086. if item.reel_share.type == ReelShareType.REPLY:
  1087. if item.reel_share.reel_owner_id == source.igpk:
  1088. prefix = "Replied to your story"
  1089. else:
  1090. username = media.user.username
  1091. prefix = f"Sent @{username}'s story"
  1092. user_link = f'<a href="https://www.instagram.com/{username}/">@{username}</a>'
  1093. prefix_html = f"Sent {user_link}'s story"
  1094. elif item.reel_share.type == ReelShareType.REACTION:
  1095. if item.reel_share.reel_owner_id == source.igpk:
  1096. prefix = "Reacted to your story"
  1097. elif item.user_id == source.igpk:
  1098. prefix = "You reacted to their story"
  1099. else:
  1100. prefix = "Reacted to a story"
  1101. elif item.reel_share.type == ReelShareType.MENTION:
  1102. if item.reel_share.mentioned_user_id == source.igpk:
  1103. prefix = "Mentioned you in their story"
  1104. else:
  1105. prefix = "You mentioned them in your story"
  1106. else:
  1107. self.log.debug(f"Unsupported reel share type {item.reel_share.type}")
  1108. return []
  1109. prefix_content = TextMessageEventContent(msgtype=MessageType.NOTICE, body=prefix)
  1110. if prefix_html:
  1111. prefix_content.format = Format.HTML
  1112. prefix_content.formatted_body = prefix_html
  1113. caption_content = TextMessageEventContent(
  1114. msgtype=MessageType.TEXT, body=item.reel_share.text
  1115. )
  1116. if not caption_content.body and isinstance(media, MediaShareItem):
  1117. caption_content.body = media.caption.text if media.caption else ""
  1118. if not caption_content.body:
  1119. caption_content.body = "<no caption>"
  1120. media_content = None
  1121. fake_item_id = f"fi.mau.instagram.reel_share.{item.user_id}.{media.pk}"
  1122. if isinstance(media, ExpiredMediaItem):
  1123. media_content = TextMessageEventContent(
  1124. msgtype=MessageType.NOTICE, body="Story expired"
  1125. )
  1126. else:
  1127. existing = await DBMessage.get_by_item_id(fake_item_id, self.receiver)
  1128. if existing:
  1129. # If the user already reacted or replied to the same reel share item,
  1130. # use a Matrix reply instead of reposting the image.
  1131. caption_content.set_reply(existing.mxid)
  1132. else:
  1133. _, media_content = await self._convert_instagram_media(source, intent, item)
  1134. if self.bridge.config["bridge.caption_in_message"]:
  1135. if media_content:
  1136. if isinstance(media_content, TextMessageEventContent):
  1137. media_content.ensure_has_html()
  1138. prefix_content.ensure_has_html()
  1139. caption_content.ensure_has_html()
  1140. combined = TextMessageEventContent(
  1141. msgtype=MessageType.TEXT,
  1142. body="\n".join(
  1143. (media_content.body, prefix_content.body, caption_content.body)
  1144. ),
  1145. formatted_body=(
  1146. f"<p><b>{media_content.formatted_body}</b></p>"
  1147. f"<p><i>{prefix_content.formatted_body}</i></p>"
  1148. f"<p>{caption_content.formatted_body}</p>"
  1149. ),
  1150. format=Format.HTML,
  1151. )
  1152. else:
  1153. prefix_content.ensure_has_html()
  1154. caption_content.ensure_has_html()
  1155. combined_body = "\n".join((prefix_content.body, caption_content.body))
  1156. combined_formatted_body = (
  1157. f"<p><i>{prefix_content.formatted_body}</i></p>"
  1158. f"<p>{caption_content.formatted_body}</p>"
  1159. )
  1160. combined = media_content
  1161. combined["filename"] = combined.body
  1162. combined.body = combined_body
  1163. combined["format"] = str(Format.HTML)
  1164. combined["org.matrix.msc1767.caption"] = {
  1165. "org.matrix.msc1767.text": combined_body,
  1166. "org.matrix.msc1767.html": combined_formatted_body,
  1167. }
  1168. combined["formatted_body"] = combined_formatted_body
  1169. else:
  1170. combined = caption_content
  1171. return [(EventType.ROOM_MESSAGE, combined)]
  1172. else:
  1173. await self._send_message(intent, prefix_content, timestamp=item.timestamp_ms)
  1174. converted: list[ConvertedMessage] = []
  1175. if media_content:
  1176. converted.append((EventType.ROOM_MESSAGE, media_content))
  1177. converted.append((EventType.ROOM_MESSAGE, caption_content))
  1178. return converted
  1179. async def _convert_instagram_link(
  1180. self,
  1181. source: u.User,
  1182. intent: IntentAPI,
  1183. item: ThreadItem,
  1184. ) -> ConvertedMessage:
  1185. content = TextMessageEventContent(msgtype=MessageType.TEXT, body=item.link.text)
  1186. link = item.link.link_context
  1187. preview = {
  1188. "og:url": link.link_url,
  1189. "og:title": link.link_title,
  1190. "og:description": link.link_summary,
  1191. }
  1192. if link.link_image_url:
  1193. reuploaded = await self._reupload_instagram_file(
  1194. source, link.link_image_url, msgtype=None, info=ImageInfo(), intent=intent
  1195. )
  1196. preview["og:image"] = reuploaded.url
  1197. preview["og:image:type"] = reuploaded.info.mimetype
  1198. preview["og:image:width"] = reuploaded.info.width
  1199. preview["og:image:height"] = reuploaded.info.height
  1200. preview["matrix:image:size"] = reuploaded.info.size
  1201. if reuploaded.file:
  1202. preview["beeper:image:encryption"] = reuploaded.file.serialize()
  1203. preview = {k: v for k, v in preview.items() if v}
  1204. content["com.beeper.linkpreviews"] = [preview] if "og:title" in preview else []
  1205. await self._add_instagram_reply(content, item.replied_to_message)
  1206. return EventType.ROOM_MESSAGE, content
  1207. async def _convert_instagram_text(self, item: ThreadItem, text: str) -> ConvertedMessage:
  1208. content = TextMessageEventContent(msgtype=MessageType.TEXT, body=text)
  1209. content["com.beeper.linkpreviews"] = []
  1210. await self._add_instagram_reply(content, item.replied_to_message)
  1211. return EventType.ROOM_MESSAGE, content
  1212. async def _convert_instagram_unhandled(self, item: ThreadItem) -> ConvertedMessage:
  1213. content = TextMessageEventContent(
  1214. msgtype=MessageType.NOTICE, body=f"Unsupported message type {item.item_type.value}"
  1215. )
  1216. await self._add_instagram_reply(content, item.replied_to_message)
  1217. return EventType.ROOM_MESSAGE, content
  1218. async def _convert_instagram_location(self, item: ThreadItem) -> ConvertedMessage | None:
  1219. loc = item.location
  1220. if not loc or not loc.lng or not loc.lat:
  1221. # TODO handle somehow
  1222. return None
  1223. long_char = "E" if loc.lng > 0 else "W"
  1224. lat_char = "N" if loc.lat > 0 else "S"
  1225. body = (
  1226. f"{loc.name} - {round(abs(loc.lat), 4)}° {lat_char}, "
  1227. f"{round(abs(loc.lng), 4)}° {long_char}"
  1228. )
  1229. url = f"https://www.openstreetmap.org/#map=15/{loc.lat}/{loc.lng}"
  1230. external_url = None
  1231. if loc.external_source == "facebook_places":
  1232. external_url = f"https://www.facebook.com/{loc.short_name}-{loc.facebook_places_id}"
  1233. content = LocationMessageEventContent(
  1234. msgtype=MessageType.LOCATION,
  1235. geo_uri=f"geo:{loc.lat},{loc.lng}",
  1236. body=f"Location: {body}\n{url}",
  1237. external_url=external_url,
  1238. )
  1239. content["format"] = str(Format.HTML)
  1240. content["formatted_body"] = f"Location: <a href='{url}'>{body}</a>"
  1241. await self._add_instagram_reply(content, item.replied_to_message)
  1242. return EventType.ROOM_MESSAGE, content
  1243. async def _convert_instagram_profile(self, item: ThreadItem) -> ConvertedMessage:
  1244. username = item.profile.username
  1245. user_link = f'<a href="https://www.instagram.com/{username}/">@{username}</a>'
  1246. text = f"Shared @{username}'s profile"
  1247. html = f"Shared {user_link}'s profile"
  1248. content = TextMessageEventContent(
  1249. msgtype=MessageType.TEXT, format=Format.HTML, body=text, formatted_body=html
  1250. )
  1251. await self._add_instagram_reply(content, item.replied_to_message)
  1252. return EventType.ROOM_MESSAGE, content
  1253. async def _add_instagram_reply(
  1254. self, content: MessageEventContent, reply_to: ThreadItem | None
  1255. ) -> None:
  1256. if not reply_to:
  1257. return
  1258. message = await DBMessage.get_by_item_id(reply_to.item_id, self.receiver)
  1259. if not message:
  1260. return
  1261. content.set_reply(message.mxid)
  1262. if not isinstance(content, TextMessageEventContent):
  1263. return
  1264. try:
  1265. evt = await self.main_intent.get_event(message.mx_room, message.mxid)
  1266. except (MNotFound, MForbidden):
  1267. evt = None
  1268. if not evt:
  1269. return
  1270. if evt.type == EventType.ROOM_ENCRYPTED:
  1271. try:
  1272. evt = await self.matrix.e2ee.decrypt(evt, wait_session_timeout=0)
  1273. except SessionNotFound:
  1274. return
  1275. if isinstance(evt.content, TextMessageEventContent):
  1276. evt.content.trim_reply_fallback()
  1277. content.set_reply(evt)
  1278. async def handle_instagram_item(self, source: u.User, sender: p.Puppet, item: ThreadItem):
  1279. client_context = item.client_context
  1280. link_client_context = item.link.client_context if item.link else None
  1281. cc = client_context
  1282. if link_client_context:
  1283. if not client_context:
  1284. cc = f"link:{link_client_context}"
  1285. elif client_context != link_client_context:
  1286. cc = f"{client_context}/link:{link_client_context}"
  1287. if client_context and client_context in self._reqid_dedup:
  1288. self.log.debug(
  1289. f"Ignoring message {item.item_id} ({cc}) by {item.user_id}"
  1290. " as it was sent by us (client_context in dedup queue)"
  1291. )
  1292. return []
  1293. elif link_client_context and link_client_context in self._reqid_dedup:
  1294. self.log.debug(
  1295. f"Ignoring message {item.item_id} ({cc}) by {item.user_id}"
  1296. " as it was sent by us (link.client_context in dedup queue)"
  1297. )
  1298. return []
  1299. # Check in-memory queues for duplicates
  1300. if item.item_id in self._msgid_dedup:
  1301. self.log.debug(
  1302. f"Ignoring message {item.item_id} ({item.client_context}) by {item.user_id}"
  1303. " as it was already handled (message.id in dedup queue)"
  1304. )
  1305. return
  1306. self._msgid_dedup.appendleft(item.item_id)
  1307. # Check database for duplicates
  1308. if await DBMessage.get_by_item_id(item.item_id, self.receiver) is not None:
  1309. self.log.debug(
  1310. f"Ignoring message {item.item_id} ({item.client_context}) by {item.user_id}"
  1311. " as it was already handled (message.id in database)"
  1312. )
  1313. return
  1314. self.log.debug(
  1315. f"Handling Instagram message {item.item_id} ({item.client_context}) by {item.user_id}"
  1316. )
  1317. if not self.mxid:
  1318. # TODO figure out where to get the info from
  1319. mxid = await self.create_matrix_room(source)
  1320. if not mxid:
  1321. # Failed to create
  1322. return
  1323. if self.config["bridge.backfill.enable"]:
  1324. if self.config["bridge.backfill.msc2716"]:
  1325. await self.enqueue_immediate_backfill(source, 0)
  1326. intent = sender.intent_for(self)
  1327. asyncio.create_task(intent.set_typing(self.mxid, is_typing=False))
  1328. event_ids = []
  1329. for event_type, content in await self.convert_instagram_item(source, sender, item):
  1330. event_ids.append(
  1331. await self._send_message(
  1332. intent, content, event_type=event_type, timestamp=item.timestamp_ms
  1333. )
  1334. )
  1335. event_ids = [event_id for event_id in event_ids if event_id]
  1336. if not event_ids:
  1337. self.log.warning(f"Unhandled Instagram message {item.item_id}")
  1338. return
  1339. self.log.debug(f"Handled Instagram message {item.item_id} -> {event_ids}")
  1340. await DBMessage(
  1341. mxid=event_ids[-1],
  1342. mx_room=self.mxid,
  1343. item_id=item.item_id,
  1344. client_context=item.client_context,
  1345. receiver=self.receiver,
  1346. sender=sender.igpk,
  1347. ig_timestamp=item.timestamp,
  1348. ).insert()
  1349. await self._send_delivery_receipt(event_ids[-1])
  1350. # TODO handle reactions
  1351. return
  1352. if isinstance(message, graphql.Message) and message.message_reactions:
  1353. await self._handle_graphql_reactions(
  1354. source, created_msgs[0], message.message_reactions, timestamp
  1355. )
  1356. async def convert_instagram_item(
  1357. self, source: u.User, sender: p.Puppet, item: ThreadItem
  1358. ) -> list[ConvertedMessage]:
  1359. if not isinstance(item, ThreadItem):
  1360. # Parsing these items failed, they should have been logged already
  1361. return []
  1362. try:
  1363. return await self._convert_instagram_item(source, sender, item)
  1364. except Exception:
  1365. self.log.exception("Fatal error converting Instagram item")
  1366. self.log.trace("Item content: %s", item.serialize())
  1367. return []
  1368. async def _convert_instagram_item(
  1369. self, source: u.User, sender: p.Puppet, item: ThreadItem
  1370. ) -> list[ConvertedMessage]:
  1371. intent = sender.intent_for(self)
  1372. if (
  1373. item.xma_media_share
  1374. or item.xma_reel_share
  1375. or item.xma_reel_mention
  1376. or item.xma_story_share
  1377. or item.generic_xma
  1378. ):
  1379. return await self._convert_instagram_xma_media_share(source, intent, item)
  1380. converted: list[ConvertedMessage] = []
  1381. if item.media or item.animated_media or item.voice_media or item.visual_media:
  1382. converted.append(await self._convert_instagram_media(source, intent, item))
  1383. elif item.location:
  1384. if loc_content := await self._convert_instagram_location(item):
  1385. converted.append(loc_content)
  1386. elif item.profile:
  1387. converted.append(await self._convert_instagram_profile(item))
  1388. elif item.reel_share:
  1389. converted.extend(await self._convert_instagram_reel_share(source, intent, item))
  1390. elif (
  1391. item.media_share
  1392. or item.direct_media_share
  1393. or item.story_share
  1394. or item.clip
  1395. or item.felix_share
  1396. ):
  1397. converted.extend(await self._convert_instagram_media_share(source, intent, item))
  1398. elif item.action_log:
  1399. # These probably don't need to be bridged
  1400. self.log.debug(f"Ignoring action log message {item.item_id}")
  1401. return []
  1402. # TODO handle item.clip?
  1403. # TODO should these be put into a caption?
  1404. if item.text:
  1405. converted.append(await self._convert_instagram_text(item, item.text))
  1406. elif item.like:
  1407. # We handle likes as text because Matrix clients do big emoji on their own.
  1408. converted.append(await self._convert_instagram_text(item, item.like))
  1409. elif item.link:
  1410. converted.append(await self._convert_instagram_link(source, intent, item))
  1411. if len(converted) == 0:
  1412. self.log.debug(f"Unhandled Instagram message {item.item_id}")
  1413. converted.append(await self._convert_instagram_unhandled(item))
  1414. return converted
  1415. # TODO HANDLE REACTIONS
  1416. if is_backfill and item.reactions:
  1417. await self._handle_instagram_reactions(msg, item.reactions.emojis, is_backfill=True)
  1418. async def handle_instagram_remove(self, item_id: str) -> None:
  1419. message = await DBMessage.get_by_item_id(item_id, self.receiver)
  1420. if message is None:
  1421. return
  1422. await message.delete()
  1423. if message.mxid:
  1424. sender = await p.Puppet.get_by_pk(message.sender)
  1425. try:
  1426. await sender.intent_for(self).redact(self.mxid, message.mxid)
  1427. except MForbidden:
  1428. await self.main_intent.redact(self.mxid, message.mxid)
  1429. self.log.debug(f"Redacted {message.mxid} after Instagram unsend")
  1430. async def handle_instagram_reaction(self, item: ThreadItem, remove: bool) -> None:
  1431. sender = await p.Puppet.get_by_pk(item.new_reaction.sender_id)
  1432. message = await DBMessage.get_by_item_id(item.item_id, self.receiver)
  1433. if not message:
  1434. self.log.debug(f"Dropping reaction by {sender.pk} to unknown message {item.item_id}")
  1435. return
  1436. emoji = item.new_reaction.emoji
  1437. async with self._reaction_lock:
  1438. existing = await DBReaction.get_by_item_id(item.item_id, self.receiver, sender.pk)
  1439. if not existing and remove:
  1440. self.log.debug(
  1441. f"Ignoring duplicate reaction removal by {sender.pk} to {item.item_id}"
  1442. )
  1443. return
  1444. elif not remove and existing and existing.reaction == emoji:
  1445. self.log.debug(f"Ignoring duplicate reaction by {sender.pk} to {item.item_id}")
  1446. return
  1447. intent = sender.intent_for(self)
  1448. if remove:
  1449. await existing.delete()
  1450. await intent.redact(self.mxid, existing.mxid)
  1451. self.log.debug(
  1452. f"Removed {sender.pk}'s reaction to {item.item_id} (redacted {existing.mxid})"
  1453. )
  1454. else:
  1455. timestamp = item.new_reaction.timestamp_ms
  1456. reaction_event_id = await intent.react(
  1457. self.mxid, message.mxid, key=emoji, timestamp=timestamp
  1458. )
  1459. await self._upsert_reaction(
  1460. existing, intent, reaction_event_id, message, sender, emoji, timestamp
  1461. )
  1462. self.log.debug(
  1463. f"Handled {sender.pk}'s reaction to {item.item_id} -> {reaction_event_id}"
  1464. )
  1465. async def _handle_instagram_reactions(
  1466. self, message: DBMessage, reactions: list[Reaction], is_backfill: bool = False
  1467. ) -> None:
  1468. old_reactions: dict[int, DBReaction]
  1469. old_reactions = {
  1470. reaction.ig_sender: reaction
  1471. for reaction in await DBReaction.get_all_by_item_id(message.item_id, self.receiver)
  1472. }
  1473. timestamp_deduplicator = 1
  1474. for new_reaction in reactions:
  1475. old_reaction = old_reactions.pop(new_reaction.sender_id, None)
  1476. if old_reaction and old_reaction.reaction == new_reaction.emoji:
  1477. continue
  1478. puppet = await p.Puppet.get_by_pk(new_reaction.sender_id)
  1479. intent = puppet.intent_for(self)
  1480. timestamp = new_reaction.timestamp_ms if is_backfill else int(time.time() * 1000)
  1481. if is_backfill:
  1482. timestamp += timestamp_deduplicator
  1483. timestamp_deduplicator += 1
  1484. reaction_event_id = await intent.react(
  1485. self.mxid, message.mxid, new_reaction.emoji, timestamp=timestamp
  1486. )
  1487. await self._upsert_reaction(
  1488. old_reaction,
  1489. intent,
  1490. reaction_event_id,
  1491. message,
  1492. puppet,
  1493. new_reaction.emoji,
  1494. timestamp,
  1495. )
  1496. for old_reaction in old_reactions.values():
  1497. await old_reaction.delete()
  1498. puppet = await p.Puppet.get_by_pk(old_reaction.ig_sender)
  1499. await puppet.intent_for(self).redact(self.mxid, old_reaction.mxid)
  1500. async def handle_instagram_update(self, item: MessageSyncMessage) -> None:
  1501. message = await DBMessage.get_by_item_id(item.item_id, self.receiver)
  1502. if not message:
  1503. return
  1504. if item.has_seen:
  1505. puppet = await p.Puppet.get_by_pk(item.has_seen, create=False)
  1506. if puppet:
  1507. await puppet.intent_for(self).mark_read(self.mxid, message.mxid)
  1508. else:
  1509. async with self._reaction_lock:
  1510. await self._handle_instagram_reactions(
  1511. message, (item.reactions.emojis if item.reactions else [])
  1512. )
  1513. # endregion
  1514. # region Updating portal info
  1515. def _get_thread_name(self, thread: Thread) -> str:
  1516. if self.is_direct:
  1517. if self.other_user_pk == thread.viewer_id and len(thread.users) == 0:
  1518. return "Instagram chat with yourself"
  1519. elif len(thread.users) == 1:
  1520. tpl = self.config["bridge.private_chat_name_template"]
  1521. ui = thread.users[0]
  1522. return tpl.format(
  1523. displayname=ui.full_name or ui.username, id=ui.pk, username=ui.username
  1524. )
  1525. pass
  1526. elif thread.thread_title:
  1527. return self.config["bridge.group_chat_name_template"].format(name=thread.thread_title)
  1528. else:
  1529. return ""
  1530. async def update_info(self, thread: Thread, source: u.User) -> None:
  1531. changed = await self._update_name(self._get_thread_name(thread))
  1532. changed = await self._update_participants(thread.users, source) or changed
  1533. if changed:
  1534. await self.update_bridge_info()
  1535. await self.update()
  1536. # TODO update power levels with thread.admin_user_ids
  1537. async def update_info_from_puppet(self, puppet: p.Puppet | None = None) -> None:
  1538. if not self.is_direct:
  1539. return
  1540. if not puppet:
  1541. puppet = await self.get_dm_puppet()
  1542. await self._update_photo_from_puppet(puppet)
  1543. if self.name and not self.name_set:
  1544. await self._update_name(self.name)
  1545. async def _update_name(self, name: str) -> bool:
  1546. if name and (self.name != name or not self.name_set):
  1547. self.name = name
  1548. if self.mxid:
  1549. try:
  1550. await self.main_intent.set_room_name(self.mxid, name)
  1551. self.name_set = True
  1552. except Exception:
  1553. self.log.exception("Failed to update name")
  1554. self.name_set = False
  1555. return True
  1556. return False
  1557. async def _update_photo_from_puppet(self, puppet: p.Puppet) -> bool:
  1558. if not self.private_chat_portal_meta and not self.encrypted:
  1559. return False
  1560. if self.avatar_set and self.avatar_url == puppet.photo_mxc:
  1561. return False
  1562. self.avatar_url = puppet.photo_mxc
  1563. if self.mxid:
  1564. try:
  1565. await self.main_intent.set_room_avatar(self.mxid, puppet.photo_mxc)
  1566. self.avatar_set = True
  1567. except Exception:
  1568. self.log.exception("Failed to set room avatar")
  1569. self.avatar_set = False
  1570. return True
  1571. async def _update_participants(self, users: list[ThreadUser], source: u.User) -> bool:
  1572. meta_changed = False
  1573. # Make sure puppets who should be here are here
  1574. for user in users:
  1575. puppet = await p.Puppet.get_by_pk(user.pk)
  1576. await puppet.update_info(user, source)
  1577. if self.mxid:
  1578. await puppet.intent_for(self).ensure_joined(self.mxid)
  1579. if puppet.pk == self.other_user_pk:
  1580. meta_changed = await self._update_photo_from_puppet(puppet)
  1581. if self.mxid:
  1582. # Kick puppets who shouldn't be here
  1583. current_members = {int(user.pk) for user in users}
  1584. for user_id in await self.main_intent.get_room_members(self.mxid):
  1585. pk = p.Puppet.get_id_from_mxid(user_id)
  1586. if pk and pk not in current_members and pk != self.other_user_pk:
  1587. await self.main_intent.kick_user(
  1588. self.mxid,
  1589. p.Puppet.get_mxid_from_id(pk),
  1590. reason="User had left this Instagram DM",
  1591. )
  1592. return meta_changed
  1593. async def _update_read_receipts(self, receipts: dict[int | str, ThreadUserLastSeenAt]) -> None:
  1594. for user_id, receipt in receipts.items():
  1595. message: DBMessage | DBReaction
  1596. message = await DBMessage.get_by_item_id(receipt.item_id, self.receiver)
  1597. if not message:
  1598. reaction: DBReaction
  1599. message, reaction = await asyncio.gather(
  1600. DBMessage.get_closest(self.mxid, int(receipt.timestamp)),
  1601. DBReaction.get_closest(self.mxid, receipt.timestamp_ms),
  1602. )
  1603. if (not message or not message.mxid) and not reaction:
  1604. self.log.debug(
  1605. "Couldn't find message %s to mark as read by %s", receipt, user_id
  1606. )
  1607. continue
  1608. elif not message or (reaction and reaction.mx_timestamp > message.ig_timestamp_ms):
  1609. message = reaction
  1610. puppet = await p.Puppet.get_by_pk(int(user_id), create=False)
  1611. if not puppet:
  1612. continue
  1613. try:
  1614. await puppet.intent_for(self).mark_read(message.mx_room, message.mxid)
  1615. except Exception:
  1616. self.log.warning(
  1617. f"Failed to mark {message.mxid} in {message.mx_room} "
  1618. f"as read by {puppet.intent.mxid}",
  1619. exc_info=True,
  1620. )
  1621. async def get_dm_puppet(self) -> p.Puppet | None:
  1622. if not self.is_direct:
  1623. return None
  1624. return await p.Puppet.get_by_pk(self.other_user_pk)
  1625. # endregion
  1626. # region Backfill
  1627. async def enqueue_immediate_backfill(self, source: u.User, priority: int) -> None:
  1628. assert self.config["bridge.backfill.msc2716"]
  1629. if not await Backfill.get(source.mxid, self.thread_id, self.receiver):
  1630. await Backfill.new(
  1631. source.mxid,
  1632. priority,
  1633. self.thread_id,
  1634. self.receiver,
  1635. self.config["bridge.backfill.incremental.max_pages"],
  1636. self.config["bridge.backfill.incremental.page_delay"],
  1637. self.config["bridge.backfill.incremental.post_batch_delay"],
  1638. self.config["bridge.backfill.incremental.max_total_pages"],
  1639. ).insert()
  1640. async def backfill(self, source: u.User, backfill_request: Backfill) -> None:
  1641. try:
  1642. last_message_ig_timestamp = await self._backfill(source, backfill_request)
  1643. if last_message_ig_timestamp is not None:
  1644. await self.send_post_backfill_dummy(last_message_ig_timestamp)
  1645. finally:
  1646. # Always sleep after the backfill request is finished processing, even if it errors.
  1647. await asyncio.sleep(backfill_request.post_batch_delay)
  1648. async def _backfill(self, source: u.User, backfill_request: Backfill) -> int | None:
  1649. assert source.client
  1650. self.log.debug("Backfill request: %s", backfill_request)
  1651. num_pages = backfill_request.num_pages
  1652. self.log.debug(
  1653. "Backfilling up to %d pages of history in %s through %s",
  1654. num_pages,
  1655. self.mxid,
  1656. source.mxid,
  1657. )
  1658. try:
  1659. if self.cursor:
  1660. self.log.debug("There is a cursor for the chat, fetching messages before it")
  1661. resp = await source.client.get_thread(
  1662. self.thread_id, seq_id=source.seq_id, cursor=self.cursor
  1663. )
  1664. else:
  1665. self.log.debug(
  1666. "There is no first message in the chat, starting with the most recent messages"
  1667. )
  1668. resp = await source.client.get_thread(self.thread_id, seq_id=source.seq_id)
  1669. except IGRateLimitError as e:
  1670. backoff = self.config.get("bridge.backfill.backoff.message_history", 300)
  1671. self.log.warning(
  1672. f"Backfilling failed due to rate limit. Waiting for {backoff} seconds before "
  1673. f"resuming. Error: {e}"
  1674. )
  1675. await asyncio.sleep(backoff)
  1676. raise
  1677. messages = resp.thread.items
  1678. cursor = resp.thread.oldest_cursor
  1679. backfill_more = resp.thread.has_older
  1680. if len(messages) == 0:
  1681. self.log.debug("No messages to backfill.")
  1682. return None
  1683. last_message_timestamp = messages[-1].timestamp_ms
  1684. pages_to_backfill = backfill_request.num_pages
  1685. if backfill_request.max_total_pages > -1:
  1686. pages_to_backfill = min(pages_to_backfill, backfill_request.max_total_pages)
  1687. pages_backfilled = 0
  1688. for i in range(pages_to_backfill):
  1689. base_insertion_event_id = await self.backfill_message_page(
  1690. source, list(reversed(messages))
  1691. )
  1692. self.cursor = cursor
  1693. await self.save()
  1694. pages_backfilled += 1
  1695. if base_insertion_event_id:
  1696. self.historical_base_insertion_event_id = base_insertion_event_id
  1697. await self.save()
  1698. if backfill_more and i < pages_to_backfill - 1:
  1699. # Sleep before fetching another page of messages.
  1700. await asyncio.sleep(backfill_request.page_delay)
  1701. # Fetch more messages
  1702. try:
  1703. resp = await source.client.get_thread(
  1704. self.thread_id, seq_id=source.seq_id, cursor=self.cursor
  1705. )
  1706. messages = resp.thread.items
  1707. cursor = resp.thread.oldest_cursor
  1708. backfill_more &= resp.thread.has_older
  1709. except IGRateLimitError as e:
  1710. backoff = self.config.get("bridge.backfill.backoff.message_history", 300)
  1711. self.log.warning(
  1712. f"Backfilling failed due to rate limit. Waiting for {backoff} seconds "
  1713. "before resuming."
  1714. )
  1715. await asyncio.sleep(backoff)
  1716. # If we hit the rate limit, then we will want to give up for now, but enqueue
  1717. # additional backfill to do later.
  1718. break
  1719. if backfill_request.max_total_pages == -1:
  1720. new_max_total_pages = -1
  1721. else:
  1722. new_max_total_pages = backfill_request.max_total_pages - pages_backfilled
  1723. if new_max_total_pages <= 0:
  1724. backfill_more = False
  1725. if backfill_more:
  1726. self.log.debug("Enqueueing more backfill")
  1727. await Backfill.new(
  1728. source.mxid,
  1729. # Always enqueue subsequent backfills at the lowest priority
  1730. 2,
  1731. self.thread_id,
  1732. self.receiver,
  1733. backfill_request.num_pages,
  1734. backfill_request.page_delay,
  1735. backfill_request.post_batch_delay,
  1736. new_max_total_pages,
  1737. ).insert()
  1738. else:
  1739. self.log.debug("No more messages to backfill")
  1740. return last_message_timestamp
  1741. async def backfill_message_page(
  1742. self,
  1743. source: u.User,
  1744. message_page: list[ThreadItem],
  1745. forward: bool = False,
  1746. last_message: DBMessage | None = None,
  1747. mark_read: bool = False,
  1748. ) -> EventID | None:
  1749. """
  1750. Backfills a page of messages to Matrix. The messages should be in order from oldest to
  1751. newest.
  1752. Returns: a tuple containing the number of messages that were actually bridged, the
  1753. timestamp of the oldest bridged message and the base insertion event ID if it exists.
  1754. """
  1755. assert source.client
  1756. if len(message_page) == 0:
  1757. return None
  1758. if forward:
  1759. assert (last_message and last_message.mxid) or self.first_event_id
  1760. prev_event_id = last_message.mxid if last_message else self.first_event_id
  1761. else:
  1762. assert self.config["bridge.backfill.msc2716"]
  1763. assert self.first_event_id
  1764. prev_event_id = self.first_event_id
  1765. assert self.mxid
  1766. oldest_message_in_page = message_page[0]
  1767. oldest_msg_timestamp = oldest_message_in_page.timestamp_ms
  1768. batch_messages: list[BatchSendEvent] = []
  1769. state_events_at_start: list[BatchSendStateEvent] = []
  1770. added_members = set()
  1771. current_members = await self.main_intent.state_store.get_members(
  1772. self.mxid, memberships=(Membership.JOIN,)
  1773. )
  1774. def add_member(puppet: p.Puppet, mxid: UserID):
  1775. assert self.mxid
  1776. if mxid in added_members:
  1777. return
  1778. if (
  1779. self.bridge.homeserver_software.is_hungry
  1780. or not self.config["bridge.backfill.msc2716"]
  1781. ):
  1782. # Hungryserv doesn't expect or check state events at start.
  1783. added_members.add(mxid)
  1784. return
  1785. content_args = {"avatar_url": puppet.photo_mxc, "displayname": puppet.name}
  1786. state_events_at_start.extend(
  1787. [
  1788. BatchSendStateEvent(
  1789. content=MemberStateEventContent(Membership.INVITE, **content_args),
  1790. type=EventType.ROOM_MEMBER,
  1791. sender=self.main_intent.mxid,
  1792. state_key=mxid,
  1793. timestamp=oldest_msg_timestamp,
  1794. ),
  1795. BatchSendStateEvent(
  1796. content=MemberStateEventContent(Membership.JOIN, **content_args),
  1797. type=EventType.ROOM_MEMBER,
  1798. sender=mxid,
  1799. state_key=mxid,
  1800. timestamp=oldest_msg_timestamp,
  1801. ),
  1802. ]
  1803. )
  1804. added_members.add(mxid)
  1805. message_infos: list[tuple[ThreadItem, int]] = []
  1806. intents: list[IntentAPI] = []
  1807. last_message_timestamp = 0
  1808. for message in message_page:
  1809. last_message_timestamp = max(last_message_timestamp, message.timestamp_ms)
  1810. puppet: p.Puppet = await p.Puppet.get_by_pk(message.user_id)
  1811. if puppet:
  1812. intent = puppet.intent_for(self)
  1813. if not puppet.name:
  1814. # TODO where to get "info"
  1815. await puppet.update_info(info, source)
  1816. else:
  1817. intent = self.main_intent
  1818. if puppet.is_real_user and not self._can_double_puppet_backfill(intent.mxid):
  1819. intent = puppet.default_mxid_intent
  1820. # Convert the message
  1821. converted = await self.convert_instagram_item(source, puppet, message)
  1822. if not converted:
  1823. self.log.debug(f"Skipping unsupported message in backfill {message.item_id}")
  1824. continue
  1825. if intent.mxid not in current_members:
  1826. add_member(puppet, intent.mxid)
  1827. for index, (event_type, content) in enumerate(converted):
  1828. if self.encrypted and self.matrix.e2ee:
  1829. event_type, content = await self.matrix.e2ee.encrypt(
  1830. self.mxid, event_type, content
  1831. )
  1832. if intent.api.is_real_user and intent.api.bridge_name is not None:
  1833. content[DOUBLE_PUPPET_SOURCE_KEY] = intent.api.bridge_name
  1834. message_infos.append((message, index))
  1835. batch_messages.append(
  1836. BatchSendEvent(
  1837. content=content,
  1838. type=event_type,
  1839. sender=intent.mxid,
  1840. timestamp=message.timestamp,
  1841. )
  1842. )
  1843. intents.append(intent)
  1844. if not batch_messages:
  1845. return None
  1846. if not self.bridge.homeserver_software.is_hungry and (
  1847. forward or self.next_batch_id is None
  1848. ):
  1849. self.log.debug("Sending dummy event to avoid forward extremity errors")
  1850. await self.az.intent.send_message_event(
  1851. self.mxid, EventType("fi.mau.dummy.pre_backfill", EventType.Class.MESSAGE), {}
  1852. )
  1853. self.log.info(
  1854. "Sending %d %s messages to %s with batch ID %s and previous event ID %s",
  1855. len(batch_messages),
  1856. "new" if forward else "historical",
  1857. self.mxid,
  1858. self.next_batch_id,
  1859. prev_event_id,
  1860. )
  1861. base_insertion_event_id = None
  1862. if self.config["bridge.backfill.msc2716"]:
  1863. batch_send_resp = await self.main_intent.batch_send(
  1864. self.mxid,
  1865. prev_event_id,
  1866. batch_id=self.next_batch_id,
  1867. events=batch_messages,
  1868. state_events_at_start=state_events_at_start,
  1869. beeper_new_messages=forward,
  1870. beeper_mark_read_by=source.mxid if mark_read else None,
  1871. )
  1872. base_insertion_event_id = batch_send_resp.base_insertion_event_id
  1873. event_ids = batch_send_resp.event_ids
  1874. else:
  1875. batch_send_resp = None
  1876. event_ids = [
  1877. await intent.send_message_event(
  1878. self.mxid, evt.type, evt.content, timestamp=evt.timestamp
  1879. )
  1880. for evt, intent in zip(reversed(batch_messages), reversed(intents))
  1881. ]
  1882. await self._finish_batch(event_ids, message_infos)
  1883. if not forward:
  1884. assert batch_send_resp
  1885. self.log.debug("Got next batch ID %s for %s", batch_send_resp.next_batch_id, self.mxid)
  1886. self.next_batch_id = batch_send_resp.next_batch_id
  1887. await self.save()
  1888. return base_insertion_event_id
  1889. def _can_double_puppet_backfill(self, custom_mxid: UserID) -> bool:
  1890. return self.config["bridge.backfill.double_puppet_backfill"] and (
  1891. # Hungryserv can batch send any users
  1892. self.bridge.homeserver_software.is_hungry
  1893. # Non-MSC2716 backfill can use any double puppet
  1894. or not self.config["bridge.backfill.msc2716"]
  1895. # Local users can be double puppeted even with MSC2716
  1896. or (custom_mxid[custom_mxid.index(":") + 1 :] == self.config["homeserver.domain"])
  1897. )
  1898. async def _finish_batch(
  1899. self, event_ids: list[EventID], message_infos: list[tuple[ThreadItem, int]]
  1900. ):
  1901. # We have to do this slightly annoying processing of the event IDs and message infos so
  1902. # that we only map the last event ID to the message.
  1903. # When inline captions are enabled, this will have no effect since index will always be 0
  1904. # since there's only ever one event per message.
  1905. current_message = None
  1906. messages = []
  1907. for event_id, (message, index) in zip(event_ids, message_infos):
  1908. if index == 0 and current_message:
  1909. # This means that all of the events for the previous message have been processed,
  1910. # and the current_message is the most recent event for that message.
  1911. messages.append(current_message)
  1912. current_message = DBMessage(
  1913. mxid=event_id,
  1914. mx_room=self.mxid,
  1915. item_id=message.item_id,
  1916. client_context=message.client_context,
  1917. receiver=self.receiver,
  1918. sender=message.user_id,
  1919. ig_timestamp=message.timestamp,
  1920. )
  1921. if current_message:
  1922. messages.append(current_message)
  1923. try:
  1924. await DBMessage.bulk_insert(messages)
  1925. except Exception:
  1926. self.log.exception("Failed to store batch message IDs")
  1927. async def send_post_backfill_dummy(
  1928. self,
  1929. last_message_ig_timestamp: int,
  1930. base_insertion_event_id: EventID | None = None,
  1931. ):
  1932. assert self.mxid
  1933. if not base_insertion_event_id:
  1934. base_insertion_event_id = self.historical_base_insertion_event_id
  1935. if not base_insertion_event_id:
  1936. self.log.debug(
  1937. "No base insertion event ID in database or from batch send response. Not sending"
  1938. " dummy event."
  1939. )
  1940. return
  1941. event_id = await self.main_intent.send_message_event(
  1942. self.mxid,
  1943. event_type=HistorySyncMarkerMessage,
  1944. content={
  1945. "org.matrix.msc2716.marker.insertion": base_insertion_event_id,
  1946. "m.marker.insertion": base_insertion_event_id,
  1947. },
  1948. )
  1949. await DBMessage(
  1950. mxid=event_id,
  1951. mx_room=self.mxid,
  1952. item_id="",
  1953. client_context=None,
  1954. receiver=self.receiver,
  1955. sender=0,
  1956. ig_timestamp=last_message_ig_timestamp,
  1957. ).insert()
  1958. # endregion
  1959. # region Bridge info state event
  1960. @property
  1961. def bridge_info_state_key(self) -> str:
  1962. return f"net.maunium.instagram://instagram/{self.thread_id}"
  1963. @property
  1964. def bridge_info(self) -> dict[str, Any]:
  1965. return {
  1966. "bridgebot": self.az.bot_mxid,
  1967. "creator": self.main_intent.mxid,
  1968. "protocol": {
  1969. "id": "instagram",
  1970. "displayname": "Instagram DM",
  1971. "avatar_url": self.config["appservice.bot_avatar"],
  1972. },
  1973. "channel": {
  1974. "id": self.thread_id,
  1975. "displayname": self.name,
  1976. "avatar_url": self.avatar_url,
  1977. },
  1978. }
  1979. async def update_bridge_info(self) -> None:
  1980. if not self.mxid:
  1981. self.log.debug("Not updating bridge info: no Matrix room created")
  1982. return
  1983. try:
  1984. self.log.debug("Updating bridge info...")
  1985. await self.main_intent.send_state_event(
  1986. self.mxid, StateBridge, self.bridge_info, self.bridge_info_state_key
  1987. )
  1988. # TODO remove this once https://github.com/matrix-org/matrix-doc/pull/2346 is in spec
  1989. await self.main_intent.send_state_event(
  1990. self.mxid, StateHalfShotBridge, self.bridge_info, self.bridge_info_state_key
  1991. )
  1992. except Exception:
  1993. self.log.warning("Failed to update bridge info", exc_info=True)
  1994. # endregion
  1995. # region Creating Matrix rooms
  1996. async def create_matrix_room(self, source: u.User, info: Thread) -> RoomID | None:
  1997. if self.mxid:
  1998. try:
  1999. await self.update_matrix_room(source, info)
  2000. except Exception:
  2001. self.log.exception("Failed to update portal")
  2002. return self.mxid
  2003. async with self._create_room_lock:
  2004. try:
  2005. return await self._create_matrix_room(source, info)
  2006. except Exception:
  2007. self.log.exception("Failed to create portal")
  2008. return None
  2009. def _get_invite_content(self, double_puppet: p.Puppet | None) -> dict[str, bool]:
  2010. invite_content = {}
  2011. if double_puppet:
  2012. invite_content["fi.mau.will_auto_accept"] = True
  2013. if self.is_direct:
  2014. invite_content["is_direct"] = True
  2015. return invite_content
  2016. async def update_matrix_room(self, source: u.User, info: Thread) -> None:
  2017. puppet = await p.Puppet.get_by_custom_mxid(source.mxid)
  2018. await self.main_intent.invite_user(
  2019. self.mxid,
  2020. source.mxid,
  2021. check_cache=True,
  2022. extra_content=self._get_invite_content(puppet),
  2023. )
  2024. if puppet:
  2025. did_join = await puppet.intent.ensure_joined(self.mxid)
  2026. if did_join and self.is_direct:
  2027. await source.update_direct_chats({self.main_intent.mxid: [self.mxid]})
  2028. await self.update_info(info, source)
  2029. await self._update_read_receipts(info.last_seen_at)
  2030. async def _create_matrix_room(self, source: u.User, info: Thread) -> RoomID | None:
  2031. if self.mxid:
  2032. await self.update_matrix_room(source, info)
  2033. return self.mxid
  2034. await self.update_info(info, source)
  2035. self.log.debug("Creating Matrix room")
  2036. name: str | None = None
  2037. initial_state = [
  2038. {
  2039. "type": str(StateBridge),
  2040. "state_key": self.bridge_info_state_key,
  2041. "content": self.bridge_info,
  2042. },
  2043. # TODO remove this once https://github.com/matrix-org/matrix-doc/pull/2346 is in spec
  2044. {
  2045. "type": str(StateHalfShotBridge),
  2046. "state_key": self.bridge_info_state_key,
  2047. "content": self.bridge_info,
  2048. },
  2049. ]
  2050. invites = []
  2051. if self.config["bridge.encryption.default"] and self.matrix.e2ee:
  2052. self.encrypted = True
  2053. initial_state.append(
  2054. {
  2055. "type": "m.room.encryption",
  2056. "content": self.get_encryption_state_event_json(),
  2057. }
  2058. )
  2059. if self.is_direct:
  2060. invites.append(self.az.bot_mxid)
  2061. if self.encrypted or self.private_chat_portal_meta or not self.is_direct:
  2062. name = self.name
  2063. creation_content = {}
  2064. if not self.config["bridge.federate_rooms"]:
  2065. creation_content["m.federate"] = False
  2066. self.mxid = await self.main_intent.create_room(
  2067. name=name,
  2068. is_direct=self.is_direct,
  2069. initial_state=initial_state,
  2070. invitees=invites,
  2071. creation_content=creation_content,
  2072. )
  2073. if not self.mxid:
  2074. raise Exception("Failed to create room: no mxid returned")
  2075. if self.encrypted and self.matrix.e2ee and self.is_direct:
  2076. try:
  2077. await self.az.intent.ensure_joined(self.mxid)
  2078. except Exception:
  2079. self.log.warning(f"Failed to add bridge bot to new private chat {self.mxid}")
  2080. await self.update()
  2081. self.log.debug(f"Matrix room created: {self.mxid}")
  2082. self.by_mxid[self.mxid] = self
  2083. puppet = await p.Puppet.get_by_custom_mxid(source.mxid)
  2084. await self.main_intent.invite_user(
  2085. self.mxid, source.mxid, extra_content=self._get_invite_content(puppet)
  2086. )
  2087. if puppet:
  2088. try:
  2089. if self.is_direct:
  2090. await source.update_direct_chats({self.main_intent.mxid: [self.mxid]})
  2091. await puppet.intent.join_room_by_id(self.mxid)
  2092. except MatrixError:
  2093. self.log.debug(
  2094. "Failed to join custom puppet into newly created portal", exc_info=True
  2095. )
  2096. await self._update_participants(info.users, source)
  2097. self.log.trace("Sending portal post-create dummy event")
  2098. self.first_event_id = await self.az.intent.send_message_event(
  2099. self.mxid, PortalCreateDummy, {}
  2100. )
  2101. await self.update()
  2102. await self._update_read_receipts(info.last_seen_at)
  2103. return self.mxid
  2104. # endregion
  2105. # region Database getters
  2106. async def postinit(self) -> None:
  2107. self.by_thread_id[(self.thread_id, self.receiver)] = self
  2108. if self.mxid:
  2109. self.by_mxid[self.mxid] = self
  2110. self._main_intent = (
  2111. (await p.Puppet.get_by_pk(self.other_user_pk)).default_mxid_intent
  2112. if self.other_user_pk
  2113. else self.az.intent
  2114. )
  2115. async def delete(self) -> None:
  2116. await DBMessage.delete_all(self.mxid)
  2117. self.by_mxid.pop(self.mxid, None)
  2118. self.mxid = None
  2119. self.encrypted = False
  2120. await self.update()
  2121. async def save(self) -> None:
  2122. await self.update()
  2123. @classmethod
  2124. def all_with_room(cls) -> AsyncGenerator[Portal, None]:
  2125. return cls._db_to_portals(super().all_with_room())
  2126. @classmethod
  2127. def find_private_chats_with(cls, other_user: int) -> AsyncGenerator[Portal, None]:
  2128. return cls._db_to_portals(super().find_private_chats_with(other_user))
  2129. @classmethod
  2130. async def find_private_chat(cls, receiver: int, other_user: int) -> Portal | None:
  2131. thread_id = await super().find_private_chat_id(receiver, other_user)
  2132. if not thread_id:
  2133. return None
  2134. return await cls.get_by_thread_id(thread_id, receiver=receiver, is_group=False)
  2135. @classmethod
  2136. async def _db_to_portals(cls, query: Awaitable[list[Portal]]) -> AsyncGenerator[Portal, None]:
  2137. portals = await query
  2138. for index, portal in enumerate(portals):
  2139. try:
  2140. yield cls.by_thread_id[(portal.thread_id, portal.receiver)]
  2141. except KeyError:
  2142. await portal.postinit()
  2143. yield portal
  2144. @classmethod
  2145. @async_getter_lock
  2146. async def get_by_mxid(cls, mxid: RoomID) -> Portal | None:
  2147. try:
  2148. return cls.by_mxid[mxid]
  2149. except KeyError:
  2150. pass
  2151. portal = cast(cls, await super().get_by_mxid(mxid))
  2152. if portal is not None:
  2153. await portal.postinit()
  2154. return portal
  2155. return None
  2156. @classmethod
  2157. @async_getter_lock
  2158. async def get_by_thread_id(
  2159. cls,
  2160. thread_id: str,
  2161. *,
  2162. receiver: int,
  2163. is_group: bool | None = None,
  2164. other_user_pk: int | None = None,
  2165. ) -> Portal | None:
  2166. if is_group and receiver != 0:
  2167. receiver = 0
  2168. try:
  2169. return cls.by_thread_id[(thread_id, receiver)]
  2170. except KeyError:
  2171. pass
  2172. if is_group is None and receiver != 0:
  2173. try:
  2174. return cls.by_thread_id[(thread_id, 0)]
  2175. except KeyError:
  2176. pass
  2177. portal = cast(
  2178. cls,
  2179. await super().get_by_thread_id(
  2180. thread_id, receiver=receiver, rec_must_match=is_group is not None
  2181. ),
  2182. )
  2183. if portal is not None:
  2184. await portal.postinit()
  2185. return portal
  2186. if is_group is not None:
  2187. portal = cls(thread_id, receiver, other_user_pk=other_user_pk)
  2188. await portal.insert()
  2189. await portal.postinit()
  2190. return portal
  2191. return None
  2192. @classmethod
  2193. async def get_by_thread(cls, thread: Thread, receiver: int) -> Portal | None:
  2194. if thread.is_group:
  2195. receiver = 0
  2196. other_user_pk = None
  2197. else:
  2198. if len(thread.users) == 0:
  2199. other_user_pk = receiver
  2200. else:
  2201. other_user_pk = thread.users[0].pk
  2202. return await cls.get_by_thread_id(
  2203. thread.thread_id,
  2204. receiver=receiver,
  2205. is_group=thread.is_group,
  2206. other_user_pk=other_user_pk,
  2207. )
  2208. # endregion