portal.py 98 KB

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